Files
Descent3/cfile/CFILE.cpp
Kevin Bentley df209742fc Initial import
2024-04-15 21:43:29 -06:00

1414 lines
36 KiB
C++

#ifdef MACINTOSH
#include "ddio_mac.h"
#endif
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <stdarg.h>
#include <errno.h>
#include <ctype.h>
#ifndef __LINUX__
//Non-Linux Build Includes
#include <io.h>
#else
//Linux Build Includes
#include "linux/linux_fix.h"
#endif
#include "BYTESWAP.H"
#include "pserror.h"
#include "ddio.h"
#include "psglob.h"
#include "CFILE.H"
#include "hogfile.h" //info about library file
#include "mem.h"
//Library structures
typedef struct {
char name[PSFILENAME_LEN+1]; //just the filename part
int offset; //offset into library file
int length; //length of this file
ulong timestamp; //time and date of file
int flags; //misc flags
} library_entry;
typedef struct library {
char name[_MAX_PATH]; //includes path + filename
int nfiles;
library_entry *entries;
struct library *next;
int handle; //indentifier for this lib
FILE *file; //pointer to file for this lib, if no one using it
} library;
//entry in extension->path table
typedef struct {
char ext[_MAX_EXT];
ubyte pathnum;
} ext_entry;
//entry in list of paths
typedef struct {
char path[_MAX_PATH];
ubyte specific; //if non-zero, only for specific extensions
} path_entry;
#define MAX_PATHS 100
path_entry paths[MAX_PATHS];
int N_paths=0;
#define MAX_EXTENSIONS 100
ext_entry extensions[MAX_EXTENSIONS];
int N_extensions;
library *Libraries=NULL;
int lib_handle=0;
void cf_Close();
//Structure thrown on disk error
cfile_error cfe;
//The message for unexpected end of file
char *eof_error = "Unexpected end of file";
//Generates a cfile error
void ThrowCFileError(int type,CFILE *file,char *msg)
{
cfe.read_write = type;
cfe.msg = msg;
cfe.file = file;
throw &cfe;
}
//Opens a HOG file. Future calls to cfopen(), etc. will look in this HOG.
//Parameters: libname - the path & filename of the HOG file
//NOTE: libname must be valid for the entire execution of the program. Therefore, it should either
// be a fully-specified path name, or the current directory must not change.
//Returns: 0 if error, else library handle that can be used to close the library
int cf_OpenLibrary(const char *libname)
{
FILE * fp;
char id[4];
int i, offset;
library *lib;
static int first_time=1;
tHogHeader header;
tHogFileEntry entry;
fp = fopen( libname, "rb" );
if ( fp == NULL )
return 0; //CF_NO_FILE;
fread( id, strlen(HOG_TAG_STR), 1, fp );
if ( strncmp( id, HOG_TAG_STR, strlen(HOG_TAG_STR))) {
fclose(fp);
return 0; //CF_BAD_FILE;
}
//check if this if first library opened
if (first_time) {
atexit(cf_Close);
first_time = 0;
}
//allocation library stucture
lib = (library *) mem_malloc(sizeof(*lib));
if (!lib) { //malloc error
fclose(fp);
return 0;
}
strcpy(lib->name, libname);
// read HOG header
if (!ReadHogHeader(fp, &header)) {
fclose(fp);
mem_free(lib);
return 0; //CF_BAD_LIB;
}
//DAJ lib->nfiles = INTEL_INT(header.nfiles);
lib->nfiles = header.nfiles;
// allocate CFILE hog info.
lib->entries = (library_entry *) mem_malloc(sizeof(library_entry) * lib->nfiles);
if (!lib->entries) { //malloc error
fclose(fp);
mem_free(lib);
return 0;
}
lib->next = Libraries;
Libraries = lib;
//set data offset of first file
//DAJ offset = INTEL_INT(header.file_data_offset);
offset = header.file_data_offset;
//Go to index start
fseek(fp, strlen(HOG_TAG_STR) + HOG_HDR_SIZE, SEEK_SET);
//read in index table
for (i = 0; i < lib->nfiles; i++)
{
if (!ReadHogEntry(fp, &entry)) {
fclose(fp);
return 0;
}
//Make sure files are in order
ASSERT((i==0) || (stricmp(entry.name,lib->entries[i-1].name) >= 0));
//Copy into table
strcpy(lib->entries[i].name, entry.name);
lib->entries[i].flags = entry.flags;
lib->entries[i].length = entry.len;
lib->entries[i].offset = offset;
lib->entries[i].timestamp = entry.timestamp;
offset += lib->entries[i].length;
}
//assign a handle
lib->handle = ++lib_handle;
//Save the file pointer
lib->file = fp;
//Sucess. Return the handle
return lib->handle;
}
//Closes a library file.
//Parameters: handle: the handle returned by cf_OpenLibrary()
void cf_CloseLibrary(int handle)
{
library *lib,*prev=NULL;
for (lib=Libraries;lib;prev=lib,lib=lib->next) {
if (lib->handle == handle) {
if (prev)
prev->next = lib->next;
else
Libraries = lib->next;
if (lib->file)
fclose(lib->file);
mem_free(lib->entries);
mem_free(lib);
return; //sucessful close
}
}
}
//Closes down the CFILE system, freeing up all data, etc.
void cf_Close()
{
library *next;
while (Libraries) {
next = Libraries->next;
mem_free(Libraries->entries);
mem_free(Libraries);
Libraries = next;
}
}
//Specify a directory to look in for files
//Parameters: path - the directory path. Can be relative to the current cur (the full path will be stored)
// ext - if NULL, look in this dir for all files. If non-null, it is a NULL-terminated list of
// file extensions, & the dir will only be searched for files with a matching extension
//Returns: true if directory added, else false
int cf_SetSearchPath(const char *path,char *ext,...)
{
if (strlen(path) >= _MAX_PATH)
return 0;
if (N_paths >= MAX_PATHS)
return 0;
//Get & store full path
ddio_GetFullPath(paths[N_paths].path,path);
//Set extenstions for this path
if (ext == NULL)
paths[N_paths].specific = 0;
else {
char **ep = &ext;
paths[N_paths].specific = 1;
while (*ep != NULL) {
if (N_extensions >= MAX_EXTENSIONS)
return 0;
strncpy(extensions[N_extensions].ext,*ep,_MAX_EXT);
extensions[N_extensions].pathnum = N_paths;
N_extensions++;
ep++;
}
}
//This path successfully set
N_paths++;
return 1;
}
//Removes all search paths that have been added by cf_SetSearchPath
void cf_ClearAllSearchPaths(void)
{
N_paths = 0;
N_extensions = 0;
}
// Opens a file for reading in a library, given the library id
CFILE *cf_OpenFileInLibrary(const char *filename,int libhandle)
{
if(libhandle<=0)
return NULL;
library *lib;
CFILE *cfile;
lib = Libraries;
// find the library that we want to use
while (lib)
{
if(lib->handle==libhandle)
break;
lib = lib->next;
}
if(NULL==lib)
{
// couldn't find the library handle
return NULL;
}
// now do a binary search for the file entry
int i;
int first = 0,last = lib->nfiles-1,c,found=0;
do {
i = (first + last) / 2;
c = stricmp(filename,lib->entries[i].name); //compare to current
if (c == 0) { //found it
found = 1;
break;
}
if (first >= last) //exhausted search
break;
if (c > 0) //search key after check key
first = i+1;
else //search key before check key
last = i-1;
} while (1);
if(!found)
return NULL; // file not in library
// open the file for reading
FILE *fp;
int r;
//See if there's an available FILE
if (lib->file) {
fp = lib->file;
lib->file = NULL;
}
else {
fp = fopen(lib->name,"rb");
if (!fp) {
mprintf((1,"Error opening library <%s> when opening file <%s>; errno=%d.",lib->name,filename,errno));
Int3();
return NULL;
}
}
cfile = (CFILE *) mem_malloc(sizeof(*cfile));
if (!cfile)
Error("Out of memory in open_file_in_lib()");
cfile->name = lib->entries[i].name;
cfile->file = fp;
cfile->lib_handle = lib->handle;
cfile->size = lib->entries[i].length;
cfile->lib_offset = lib->entries[i].offset;
cfile->position = 0;
cfile->flags = 0;
r = fseek(fp,cfile->lib_offset,SEEK_SET);
ASSERT(r == 0);
return cfile;
}
//searches through the open HOG files, and opens a file if it finds it in any of the libs
CFILE *open_file_in_lib(const char *filename)
{
library *lib;
CFILE *cfile;
lib = Libraries;
while (lib) {
int i;
//Do binary search for the file
int first = 0,
last = lib->nfiles-1,
c,found=0;
do {
i = (first + last) / 2;
c = stricmp(filename,lib->entries[i].name); //compare to current
if (c == 0) { //found it
found = 1;
break;
}
if (first >= last) //exhausted search
break;
if (c > 0) //search key after check key
first = i+1;
else //search key before check key
last = i-1;
} while (1);
if (found) {
FILE *fp;
int r;
//See if there's an available FILE
if (lib->file) {
fp = lib->file;
lib->file = NULL;
}
else {
fp = fopen(lib->name,"rb");
if (!fp) {
mprintf((1,"Error opening library <%s> when opening file <%s>; errno=%d.",lib->name,filename,errno));
Int3();
return NULL;
}
}
cfile = (CFILE *) mem_malloc(sizeof(*cfile));
if (!cfile)
Error("Out of memory in open_file_in_lib()");
cfile->name = lib->entries[i].name;
cfile->file = fp;
cfile->lib_handle = lib->handle;
cfile->size = lib->entries[i].length;
cfile->lib_offset = lib->entries[i].offset;
cfile->position = 0;
cfile->flags = 0;
r = fseek(fp,cfile->lib_offset,SEEK_SET);
ASSERT(r == 0);
return cfile;
}
lib = lib->next;
}
return NULL;
}
#ifdef __LINUX__
#include <glob.h>
static int globerrfn(const char *path,int err)
{
mprintf((0,"Error accessing %s: %s .... \n",path,strerror(err)));
return 0;
}
class CFindFiles
{
public:
CFindFiles()
{
globindex = -1;
}
bool Start(const char *wildcard, char *namebuf);
bool Next(char *namebuf);
void Close(void);
private:
int globindex;
glob_t ffres;
};
bool CFindFiles::Start(const char *wildcard, char *namebuf)
{
ASSERT(wildcard);
ASSERT(namebuf);
if(globindex!=-1)
Close();
int rc,flags;
flags = GLOB_MARK;
rc = glob(wildcard,flags,globerrfn,&ffres);
if(rc==GLOB_NOSPACE){
mprintf((0,"Out of space during glob\n"));
globindex = -1;
return false;
}
if(!ffres.gl_pathc){
globindex = -1;
return false;
}
globindex = 0;
char ext[256];
ddio_SplitPath(ffres.gl_pathv[0],NULL,namebuf,ext);
strcat(namebuf,ext);
return true;
}
bool CFindFiles::Next(char *namebuf)
{
ASSERT(namebuf);
if(globindex==-1)
return false;
globindex++;
if(globindex>=ffres.gl_pathc)
return false;
char ext[256];
ddio_SplitPath(ffres.gl_pathv[globindex],NULL,namebuf,ext);
strcat(namebuf,ext);
return true;
}
void CFindFiles::Close(void)
{
if(globindex==-1)
return;
globindex = -1;
globfree(&ffres);
}
bool cf_FindRealFileNameCaseInsenstive(const char *directory,const char *fname,char *new_filename)
{
bool use_dir = false;
char dir_to_use[_MAX_PATH];
char file_to_use[_MAX_PATH];
char *real_dir,*real_file;
if(directory)
{
// there is a directory for this path
use_dir = true;
real_dir = (char *)directory;
real_file = (char *)fname;
}else
{
// there may be a directory in the path (*sigh*)
char t_ext[256];
char t_dir[_MAX_PATH];
char t_filename[_MAX_PATH];
ddio_SplitPath(fname,t_dir,t_filename,t_ext);
if(strlen(t_dir)>0)
{
use_dir = true;
strcpy(dir_to_use,t_dir);
real_dir = (char *)dir_to_use;
strcpy(file_to_use,t_filename);
strcat(file_to_use,t_ext);
real_file = (char *)file_to_use;
mprintf((1,"CFILE: Found directory \"%s\" in filename, new filename is \"%s\"\n",real_dir,real_file));
}else
{
use_dir = false;
real_dir = NULL;
real_file = (char *)fname;
}
}
// build up a list of filenames in the current directory that begin with the lowercase and
// upper case first letter of the filename
// do the case of the first letter to start
int case_val;
char wildcard_pattern[_MAX_PATH];
int iterations = 1;
bool found_match = false;
if( (real_file[0]>='a' && real_file[0] <= 'z') ||
(real_file[0]>='A' && real_file[0] <= 'Z') )
{
// alpha first letter...we need to do 2 iterations
iterations = 2;
}
for(case_val=0;case_val<iterations;case_val++)
{
if(case_val)
{
// do the opposite case of the first letter
char first_letter;
first_letter = real_file[0];
if(first_letter >= 'a' && first_letter <= 'z')
{
// we need to uppercase the letter
first_letter = toupper(first_letter);
}else
{
// we need to lowercase the letter
first_letter = tolower(first_letter);
}
// create a wildcard patter full of ? replacing letters (except the first one)
char *wptr = wildcard_pattern;
char *fptr = &real_file[1];
*wptr = first_letter;
wptr++;
while(*fptr)
{
if(isalpha(*fptr))
{
*wptr = '?';
}else
{
*wptr = *fptr;
}
fptr++;
wptr++;
}
*wptr = '\0';
}else
{
// use the case of the first letter
// create a wildcard patter full of ? replacing letters (except the first one)
char *wptr = wildcard_pattern;
char *fptr = &real_file[1];
*wptr = real_file[0];
wptr++;
while(*fptr)
{
if(isalpha(*fptr))
{
*wptr = '?';
}else
{
*wptr = *fptr;
}
fptr++;
wptr++;
}
*wptr = '\0';
}
// now tack on a directory if we are to use a directory
char *wpattern;
char fullpath[_MAX_PATH];
if(use_dir)
{
ddio_MakePath(fullpath,real_dir,wildcard_pattern,NULL);
wpattern = fullpath;
}else
{
wpattern = wildcard_pattern;
}
// ok, we have our wildcard pattern, get all the files that match it
// and search them looking for a match (case insensitive)
char namebuffer[_MAX_PATH];
bool gotfile;
CFindFiles ff;
for(gotfile = ff.Start(wpattern,namebuffer); gotfile ; gotfile = ff.Next(namebuffer) )
{
if(!stricmp(namebuffer,real_file))
{
// we found a match!
found_match = true;
break;
}
}
ff.Close();
if(found_match)
{
strcpy(new_filename,namebuffer);
mprintf((1,"CFILE: Using \"%s\" instead of \"%s\"\n",new_filename,real_file));
break;
}
}
return found_match;
}
FILE *open_file_in_directory_case_sensitive(const char *directory,const char *filename,const char *mode,char *new_filename)
{
if(cf_FindRealFileNameCaseInsenstive(directory,filename,new_filename))
{
// we have a file, open it open and use it
char full_path[_MAX_PATH*2];
if(directory!=NULL)
{
ddio_MakePath(full_path,directory,new_filename,NULL);
}else
{
strcpy(full_path,new_filename);
}
return fopen(full_path,mode);
}
return NULL;
}
#endif
//look for the file in the specified directory
CFILE *open_file_in_directory(const char *filename,const char *mode,const char *directory)
{
FILE *fp;
CFILE *cfile;
char path[_MAX_PATH*2];
char tmode[3] = "rb";
if (directory != NULL)
{
// Make a full path
ddio_MakePath(path, directory, filename, NULL);
}
else //no directory specified, so just use filename passed
strcpy(path, filename);
//set read or write mode
tmode[0] = mode[0];
//if mode is "w", then open in text or binary as requested. If "r", alsway open in "rb"
tmode[1] = (mode[0] == 'w') ? mode[1] : 'b';
//try to open file
#ifdef MACINTOSH
fp = mac_fopen(path,tmode);
#else
fp = fopen( path, tmode );
#endif
#ifdef __LINUX__
// for Filesystems with case sensitive files we'll check for different versions of the filename
// with different case's.
if(fp)
{
// found the file, open it
cfile = (CFILE *) mem_malloc(sizeof(*cfile));
if (!cfile)
Error("Out of memory in open_file_in_directory()");
cfile->name = (char *) mem_malloc(sizeof(char) * (strlen(filename)+1));
if (!cfile->name)
Error("Out of memory in open_file_in_directory()");
strcpy(cfile->name, filename);
cfile->file = fp;
cfile->lib_handle = -1;
cfile->size = ddio_GetFileLength(fp);
cfile->lib_offset = 0; //0 means on disk, not in HOG
cfile->position = 0;
cfile->flags=0;
return cfile;
}else
{
// try different cases of the filename
char using_filename[_MAX_PATH];
fp = open_file_in_directory_case_sensitive(directory,filename,tmode,using_filename);
if(!fp)
{
// no dice
return NULL;
}else
{
// found a version of the file!
mprintf((0,"CFILE: Unable to find %s, but using %s instead\n",filename,using_filename));
cfile = (CFILE *) mem_malloc(sizeof(*cfile));
if (!cfile)
Error("Out of memory in open_file_in_directory()");
cfile->name = (char *) mem_malloc(sizeof(char) * (strlen(using_filename)+1));
if (!cfile->name)
Error("Out of memory in open_file_in_directory()");
strcpy(cfile->name, using_filename);
cfile->file = fp;
cfile->lib_handle = -1;
cfile->size = ddio_GetFileLength(fp);
cfile->lib_offset = 0; //0 means on disk, not in HOG
cfile->position = 0;
cfile->flags=0;
return cfile;
}
}
#else
if (!fp) //didn't get file
return NULL;
else { //got file
cfile = (CFILE *) mem_malloc(sizeof(*cfile));
if (!cfile)
Error("Out of memory in open_file_in_directory()");
cfile->name = (char *) mem_malloc(sizeof(char) * (strlen(filename)+1));
if (!cfile->name)
Error("Out of memory in open_file_in_directory()");
strcpy(cfile->name, filename);
cfile->file = fp;
cfile->lib_handle = -1;
cfile->size = ddio_GetFileLength(fp);
cfile->lib_offset = 0; //0 means on disk, not in HOG
cfile->position = 0;
cfile->flags=0;
return cfile;
}
#endif
}
//Opens a file for reading or writing
//If a path is specified, will try to open the file only in that path.
//If no path is specified, will look through search directories and library files.
//Parameters: filename - the name if the file, with or without a path
// mode - the standard C mode string
//Returns: the CFile handle, or NULL if file not opened
CFILE *cfopen(const char * filename, const char * mode)
{
CFILE *cfile;
char path[_MAX_PATH*2], fname[_MAX_PATH*2], ext[_MAX_EXT];
int i;
//Check for valid mode
ASSERT((mode[0] == 'r') || (mode[0] == 'w'));
ASSERT((mode[1] == 'b') || (mode[1] == 't'));
//get the parts of the pathname
ddio_SplitPath(filename, path, fname, ext);
//if there is a path specified, use it instead of the libraries, search dirs, etc.
//if the file is writable, just open it, instead of looking in libs, etc.
if (strlen(path) || (mode[0]=='w')) { //found a path
cfile = open_file_in_directory(filename,mode,NULL); //use path specified with file
goto got_file; //don't look in libs, etc.
}
//@@ Don't look in current dir. mt, 3-12-97
//@@ //first look in current directory
//@@ cfile = open_file_in_directory(filename,mode,"."); //current dir
//@@ if (cfile || (mode[0] == 'w'))
//@@ goto got_file;
//First look in the directories for this file's extension
for (i=0;i<N_extensions;i++) {
if (! strnicmp(extensions[i].ext,ext+1,_MAX_EXT)) { //found ext
cfile = open_file_in_directory(filename,mode,paths[extensions[i].pathnum].path);
if (cfile)// || (errno != ENOENT)) //Tempoary fix so Kevin can run the game!
goto got_file;
}
}
//Next look in the general directories
for (i=0;i<N_paths;i++) {
if (!paths[i].specific) {
cfile = open_file_in_directory(filename,mode,paths[i].path);
if (cfile)// || (errno != ENOENT)) //Tempoary fix so Kevin can run the game!
goto got_file;
}
}
//Lastly, try the hog files
cfile = open_file_in_lib(filename);
got_file:;
if (cfile) {
if (mode[0] == 'w')
cfile->flags |= CF_WRITING;
if (mode[1] == 't')
cfile->flags |= CF_TEXT;
}
return cfile;
}
//Returns the length of the specified file
//Parameters: cfp - the file pointer returned by cfopen()
int cfilelength( CFILE *cfp )
{
return cfp->size;
}
//Closes an open CFILE.
//Parameters: cfile - the file pointer returned by cfopen()
void cfclose( CFILE * cfp )
{
//Either give the file back to the library, or close it
if (cfp->lib_handle != -1) {
library *lib;
for (lib=Libraries;lib;lib=lib->next) {
if (lib->handle == cfp->lib_handle) { //found the library
//if library doesn't already have a file, give it this one
if (lib->file == NULL) {
lib->file = cfp->file;
cfp->file = NULL;
}
break;
}
}
}
//If the file handle wasn't given back to library, close the file
if (cfp->file)
fclose(cfp->file);
//free the name, if allocated
if (!cfp->lib_offset)
mem_free(cfp->name);
//free the cfile struct
mem_free(cfp);
}
//Just like stdio fgetc(), except works on a CFILE
//Returns a char or EOF
int cfgetc( CFILE * cfp )
{
int c;
static unsigned char ch[3] = "\0\0";
if (cfp->position >= cfp->size ) return EOF;
fread(ch,sizeof(char),1,cfp->file);
c = ch[0];
//c = getc( cfp->file );
if(cfeof(cfp))
c = EOF;
if (c != EOF) {
cfp->position++;
//do special newline handling for text files:
// if CR or LF by itself, return as newline
// if CR/LF pair, return as newline
if (cfp->flags & CF_TEXT) {
if (c == 10) //return LF as newline
c = '\n';
else if (c == 13) { //check for CR/LF pair
fread(ch,sizeof(char),1,cfp->file);
int cc = ch[0];//getc(cfp->file);
//if (cc != EOF) {
if (!cfeof(cfp)) {
if (cc == 10) //line feed?
cfp->position++; //..yes, so swallow it
else
{
//ungetc(cc,cfp->file); //..no, so put it back
fseek(cfp->file,-1,SEEK_CUR);
}
}
c = '\n'; //return CR or CR/LF pair as newline
}
}
}
return c;
}
//Just like stdio fseek(), except works on a CFILE
int cfseek( CFILE *cfp, long int offset, int where )
{
int c, goal_position;
switch( where ) {
case SEEK_SET:
goal_position = offset;
break;
case SEEK_CUR:
goal_position = cfp->position+offset;
break;
case SEEK_END:
goal_position = cfp->size+offset;
break;
default:
return 1;
}
c = fseek( cfp->file, cfp->lib_offset + goal_position, SEEK_SET );
cfp->position = ftell(cfp->file) - cfp->lib_offset;
return c;
}
//Just like stdio ftell(), except works on a CFILE
int cftell( CFILE * cfp )
{
return cfp->position;
}
//Returns true if at EOF
int cfeof(CFILE *cfp)
{
return (cfp->position >= cfp->size );
}
// Tells if the file exists
// Returns non-zero if file exists. Also tells if the file is on disk
// or in a hog - See return values in cfile.h
int cfexist( const char * filename )
{
CFILE *cfp;
int ret;
cfp = cfopen(filename,"rb");
if (!cfp) { //Didn't get file. Why?
if (errno == EACCES) //File exists, but couldn't open it
return CF_ON_DISK; //..so say it exists on the disk
//DAJ if (errno != ENOENT) //Check if error is "file not found"
//DAJ Int3(); //..warn if not
return CF_NOT_FOUND; //Say we didn't find the file
}
ret = cfp->lib_offset ? CF_IN_LIBRARY : CF_ON_DISK;
cfclose(cfp);
return ret;
}
//Reads the specified number of bytes from a file into the buffer
//DO NOT USE THIS TO READ STRUCTURES. This function is for byte
//data, such as a string or a bitmap of 8-bit pixels.
//Returns the number of bytes read.
//Throws an exception of type (cfile_error *) if the OS returns an error on read
int cf_ReadBytes(ubyte *buf, int count, CFILE *cfp)
{
int i;
char *error_msg = eof_error; //default error
ASSERT(! (cfp->flags & CF_TEXT));
if (cfp->position + count <= cfp->size) {
i = fread ( buf, 1, count, cfp->file );
if (i == count) {
cfp->position += i;
return i;
}
//if not EOF, then get the error message
if (! feof(cfp->file))
error_msg = strerror(errno);
}
mprintf((1,"Error reading %d bytes from position %d of file <%s>; errno=%d.",count,cfp->position,cfp->name,errno));
ThrowCFileError(CFE_READING,cfp,error_msg);
return 0;
}
// The following functions read numeric vales from a CFILE. All values are
// stored in the file in Intel (little-endian) format. These functions
// will convert to big-endian if required.
// These funtions will exit the program with an error if the value
// cannot be read, so do not call these if you don't require the data
// to be present.
//Read and return an integer (32 bits)
//Throws an exception of type (cfile_error *) if the OS returns an error on read
int cf_ReadInt(CFILE *cfp)
{
int i;
cf_ReadBytes( (ubyte *) &i, sizeof(i), cfp);
return INTEL_INT(i);
}
//Read and return a short (16 bits)
//Throws an exception of type (cfile_error *) if the OS returns an error on read
short cf_ReadShort(CFILE *cfp)
{
short i;
cf_ReadBytes( (ubyte *) &i, sizeof(i), cfp);
return INTEL_SHORT(i);
}
//Read and return a byte (8 bits)
//Throws an exception of type (cfile_error *) if the OS returns an error on read
sbyte cf_ReadByte(CFILE *cfp)
{
int i;
i = cfgetc(cfp);
if (i == EOF)
ThrowCFileError(CFE_READING,cfp,cfeof(cfp)?eof_error:strerror(errno));
return (sbyte) i;
}
//Read and return a float (32 bits)
//Throws an exception of type (cfile_error *) if the OS returns an error on read
float cf_ReadFloat(CFILE *cfp)
{
float f;
cf_ReadBytes( (ubyte *) &f, sizeof(f), cfp);
#ifdef MACINTOSH
float e = INTEL_FLOAT(f); //DAJ bash to zero if reads a NaN
if(isnan(e))
e = 0.0;
return e;
#else
return INTEL_FLOAT(f);
#endif
}
//Read and return a double (64 bits)
//Throws an exception of type (cfile_error *) if the OS returns an error on read
double cf_ReadDouble(CFILE *cfp)
{
double f;
cf_ReadBytes( (ubyte *) &f, sizeof(f), cfp);
#ifdef BIG_ENDIAN
{
double t;
int *sp = (int *) &f;
int *dp = (int *) &t;
dp[0] = SWAPINT(sp[1]);
dp[1] = SWAPINT(sp[0]);
f = t;
}
#endif
return f;
}
//Reads a string from a CFILE. If the file is type binary, this
//function reads until a NULL or EOF is found. If the file is text,
//the function reads until a newline or EOF is found. The string is always
//written to the destination buffer null-terminated, without the newline.
//Parameters: buf - where the string is written
// n - the maximum string length, including the terminating 0
// cfp - the CFILE pointer
//Returns the number of bytes in the string, before the terminator
//Does not generate an exception on EOF
int cf_ReadString(char * buf, size_t n, CFILE * cfp )
{
int c;
uint count;
char *bp;
if (n==0)
return -1;
bp = buf;
for (count=0;;count++) {
c = cfgetc(cfp);
if (c == EOF) {
if (! cfeof(cfp)) //not actually at EOF, so must be error
ThrowCFileError(CFE_READING,cfp,strerror(errno));
break;
}
if ((!(cfp->flags & CF_TEXT) && (c == 0)) || ((cfp->flags & CF_TEXT) && (c == '\n')))
break; //end-of-string
if (count < n-1) //store char if room in buffer
*bp++ = c;
}
*bp = 0; //write terminator
return count;
}
//Writes the specified number of bytes from a file into the buffer
//DO NOT USE THIS TO WRITE STRUCTURES. This function is for byte
//data, such as a string or a bitmap of 8-bit pixels.
//Returns the number of bytes written.
//Throws an exception of type (cfile_error *) if the OS returns an error on write
int cf_WriteBytes(const ubyte *buf, int count, CFILE *cfp)
{
int i;
if (! (cfp->flags & CF_WRITING))
return 0;
ASSERT (count>0);
i = fwrite( buf, 1, count, cfp->file );
cfp->position += i;
if (i != count)
ThrowCFileError(CFE_WRITING,cfp,strerror(errno));
return i;
}
//Writes a null-terminated string to a file. If the file is type binary,
//the string is terminated in the file with a null. If the file is type
//text, the string is terminated with a newline.
//Parameters: buf - pointer to the string
// cfp = the CFILE pointer
//Returns the number of bytes written
//Throws an exception of type (cfile_error *) if the OS returns an error on write
int cf_WriteString(CFILE *cfp, const char *buf)
{
int len;
len = strlen(buf);
if (len != 0) //write string
cf_WriteBytes((ubyte *) buf, len, cfp);
//Terminate with newline (text file) or NULL (binary file)
cf_WriteByte(cfp,(cfp->flags & CF_TEXT)?'\n':0);
return len+1;
}
//Just like stdio fprintf(), except works on a CFILE
int cfprintf( CFILE *cfp, const char *format, ... )
{
#ifndef MACINTOSH
va_list args;
int count;
va_start(args, format );
count = vfprintf(cfp->file,format,args);
cfp->position += count+1; //count doesn't include terminator
return count;
#endif
}
// The following functions write numeric vales to a CFILE. All values are
// stored to the file in Intel (little-endian) format.
// All these throw an exception if there's an error on write.
//Write an integer (32 bits)
//Throws an exception of type (cfile_error *) if the OS returns an error on write
void cf_WriteInt(CFILE *cfp,int i)
{
int t = INTEL_INT(i);
cf_WriteBytes( (ubyte *) &t, sizeof(t), cfp);
}
//Write a short (16 bits)
//Throws an exception of type (cfile_error *) if the OS returns an error on write
void cf_WriteShort(CFILE *cfp,short s)
{
short t = INTEL_SHORT(s);
cf_WriteBytes( (ubyte *) &t, sizeof(t), cfp);
}
//Write a byte (8 bits).
//Throws an exception of type (cfile_error *) if the OS returns an error on write
void cf_WriteByte(CFILE *cfp,sbyte b)
{
if (fputc(b,cfp->file) == EOF)
ThrowCFileError(CFE_WRITING,cfp,strerror(errno));
cfp->position++;
//If text file & writing newline, increment again for LF
if ((cfp->flags & CF_TEXT) && (b == '\n')) //check for text mode newline
cfp->position++;
}
//Write a float (32 bits)
//Throws an exception of type (cfile_error *) if the OS returns an error on write
void cf_WriteFloat(CFILE *cfp,float f)
{
float t = INTEL_FLOAT(f);
cf_WriteBytes( (ubyte *) &t, sizeof(t), cfp);
}
//Write a double (64 bits)
//Throws an exception of type (cfile_error *) if the OS returns an error on write
void cf_WriteDouble(CFILE *cfp,double d)
{
#ifdef BIG_ENDIAN
{
double t;
int *sp = (int *) &d;
int *dp = (int *) &t;
dp[0] = SWAPINT(sp[1]);
dp[1] = SWAPINT(sp[0]);
d = t;
}
#endif
cf_WriteBytes( (ubyte *) &d, sizeof(d), cfp);
}
//Copies a file. Returns TRUE if copied ok. Returns FALSE if error opening either file.
//Throws an exception of type (cfile_error *) if the OS returns an error on read or write
bool cf_CopyFile (char *dest,const char *src,int copytime)
{
CFILE *infile,*outfile;
if (!stricmp(dest,src))
return 1; // don't copy files if they are the same
infile=(CFILE *)cfopen (src,"rb");
if (!infile)
return 0;
outfile=(CFILE *)cfopen (dest,"wb");
if (!outfile)
{
cfclose (infile);
return 0;
}
int progress = 0;
int readcount = 0;
#define COPY_CHUNK_SIZE 5000
ubyte copybuf[COPY_CHUNK_SIZE];
while (!cfeof(infile))
{
//ubyte c;
if(progress+COPY_CHUNK_SIZE<=infile->size)
{
readcount = COPY_CHUNK_SIZE;
}
else
{
readcount = infile->size - progress;
}
cf_ReadBytes(copybuf,readcount,infile);
cf_WriteBytes(copybuf,readcount,outfile);
progress+=readcount;
//c=cf_ReadByte (infile);
//cf_WriteByte (outfile,c);
}
int infile_lib_offset = infile->lib_offset;
cfclose (infile);
cfclose (outfile);
if(!infile_lib_offset && copytime)
{
cf_CopyFileTime(dest,src);
}
return 1;
}
//Checks to see if two files are different.
//Returns TRUE if the files are different, or FALSE if they are the same.
bool cf_Diff (const char *a,const char *b)
{
return (ddio_FileDiff(a, b));
}
//Copies the file time from one file to another
void cf_CopyFileTime (char *dest,const char *src)
{
ddio_CopyFileTime (dest,src);
}
// Changes a files attributes (ie read/write only)
void cf_ChangeFileAttributes (const char *name,int attr)
{
#ifdef MACINTOSH
DebugStr("\pERROR in cf_ChangeFileAttributes: not supported");
#else
if( _chmod( name, attr ) == -1 )
Int3(); // Get Jason or Matt, file not found!
#endif
}
// rewinds cfile position
void cf_Rewind(CFILE *fp)
{
if (fp->lib_offset) {
int r = fseek(fp->file,fp->lib_offset,SEEK_SET);
ASSERT(r==0);
}
else {
rewind(fp->file);
}
fp->position = 0;
}
//Calculates a 32 bit CRC for the specified file. a return code of -1 means file note found
#define CRC32_POLYNOMIAL 0xEDB88320L
#define CRC_BUFFER_SIZE 5000
unsigned int cf_CalculateFileCRC (CFILE *infile)
{
int i,j;
ubyte crcbuf[CRC_BUFFER_SIZE];
static bool Cfile_crc_calculated = false;
static unsigned int CRCTable[256];
unsigned int crc;
unsigned int temp1;
unsigned int temp2;
unsigned int readlen;
// Only make the lookup table once
if(!Cfile_crc_calculated)
{
Cfile_crc_calculated = true;
for( i=0;i<=255;i++)
{
crc=i;
for(j=8;j>0;j--)
{
if(crc&1)
crc=(crc>>1)^CRC32_POLYNOMIAL;
else
crc>>=1;
}
CRCTable[i]=crc;
}
}
crc = 0xffffffffl;
while (!cfeof(infile))
{
if((infile->size - infile->position)<CRC_BUFFER_SIZE)
readlen = infile->size - infile->position;
else
readlen = CRC_BUFFER_SIZE;
if(!cf_ReadBytes (crcbuf,readlen,infile))
{
//Doh, error time!
Int3();
return 0xFFFFFFFF;
}
for(unsigned int a=0;a<readlen;a++)
{
temp1=(crc>>8)&0x00FFFFFFL;
temp2=CRCTable[((int)crc^crcbuf[a])&0xff];
crc=temp1^temp2;
}
}
return crc^0xffffffffl;
}
unsigned int cf_GetfileCRC (char *src)
{
CFILE *infile;
infile=(CFILE *)cfopen (src,"rb");
if (!infile)
return 0xFFFFFFFF;
unsigned int crc = cf_CalculateFileCRC(infile);
cfclose(infile);
return crc;
}
char cfile_search_wildcard[256];
library *cfile_search_library = NULL;
int cfile_search_curr_index = 0;
bool cfile_search_ispattern = false;
// the following cf_LibraryFind function are similar to the ddio_Find functions as they look
// for files that match the wildcard passed in, however, this is to be used for hog files.
bool cf_LibraryFindFirst(int handle,const char *wildcard,char *buffer)
{
ASSERT (wildcard);
ASSERT (buffer);
if( !wildcard || !buffer )
return false;
*buffer = '\0';
if(cfile_search_library)
cf_LibraryFindClose();
//find the library
cfile_search_library = Libraries;
while( cfile_search_library && cfile_search_library->handle!=handle){
cfile_search_library = cfile_search_library->next;
}
if(!cfile_search_library)
return false;
//now find the first matching file
strncpy(cfile_search_wildcard,wildcard,255);
cfile_search_wildcard[255] = '\0';
cfile_search_ispattern = (bool)(PSGlobHasPattern(cfile_search_wildcard)!=0);
cfile_search_curr_index = 0;
while(cfile_search_curr_index<cfile_search_library->nfiles){
if(cfile_search_ispattern){
if(PSGlobMatch(cfile_search_wildcard,cfile_search_library->entries[cfile_search_curr_index].name,0,0)){
//it's a match
strcpy(buffer,cfile_search_library->entries[cfile_search_curr_index].name);
cfile_search_curr_index++;
return true;
}
}else{
if(!stricmp(cfile_search_library->entries[cfile_search_curr_index].name,cfile_search_wildcard)){
strcpy(buffer,cfile_search_library->entries[cfile_search_curr_index].name);
cfile_search_curr_index++;
return true;
}
}
cfile_search_curr_index++;
}
//we didn't find a match
return false;
}
bool cf_LibraryFindNext(char *buffer)
{
while(cfile_search_curr_index<cfile_search_library->nfiles){
if(cfile_search_ispattern){
if(PSGlobMatch(cfile_search_wildcard,cfile_search_library->entries[cfile_search_curr_index].name,0,0)){
//it's a match
strcpy(buffer,cfile_search_library->entries[cfile_search_curr_index].name);
cfile_search_curr_index++;
return true;
}
}else{
if(!stricmp(cfile_search_library->entries[cfile_search_curr_index].name,cfile_search_wildcard)){
strcpy(buffer,cfile_search_library->entries[cfile_search_curr_index].name);
cfile_search_curr_index++;
return true;
}
}
cfile_search_curr_index++;
}
return false;
}
void cf_LibraryFindClose(void)
{
cfile_search_library = NULL;
cfile_search_curr_index = 0;
cfile_search_ispattern = false;
}
// returns hog cfile info, using a library handle opened via cf_OpenLibrary.
bool cf_ReadHogFileEntry(int libr, const char *filename, tHogFileEntry *entry, int *fileoffset)
{
//searches through the open HOG files, and opens a file if it finds it in any of the libs
library *lib;
lib = Libraries;
while (lib)
{
int i;
if (lib->handle == libr || libr == -1) {
//Do binary search for the file
int first = 0, last = lib->nfiles-1, c,found=0;
do {
i = (first + last) / 2;
c = stricmp(filename,lib->entries[i].name); //compare to current
if (c == 0) { //found it
found = 1;
break;
}
if (first >= last) //exhausted search
break;
if (c > 0) //search key after check key
first = i+1;
else //search key before check key
last = i-1;
} while (1);
if (found) {
strcpy(entry->name, lib->entries[i].name);
entry->len = lib->entries[i].length;
entry->flags = lib->entries[i].flags;
entry->timestamp = lib->entries[i].timestamp;
*fileoffset = lib->entries[i].offset;
return true;
}
else if (lib->handle == libr) {
break;
}
}
lib = lib->next;
}
return false;
}
bool cf_IsFileInHog(char *filename, char *hogname)
{
library *lib = Libraries;
while(lib)
{
if(stricmp(lib->name,hogname)==0)
{
//Now look for filename
CFILE *cf;
cf = cf_OpenFileInLibrary(filename,lib->handle);
if(cf)
{
cfclose(cf);
return true;
}
}
lib = lib->next;
}
return false;
}