1 /* $Id: cfile.c,v 1.23 2003-11-27 00:36:14 btb Exp $ */
3 THE COMPUTER CODE CONTAINED HEREIN IS THE SOLE PROPERTY OF PARALLAX
4 SOFTWARE CORPORATION ("PARALLAX"). PARALLAX, IN DISTRIBUTING THE CODE TO
5 END-USERS, AND SUBJECT TO ALL OF THE TERMS AND CONDITIONS HEREIN, GRANTS A
6 ROYALTY-FREE, PERPETUAL LICENSE TO SUCH END-USERS FOR USE BY SUCH END-USERS
7 IN USING, DISPLAYING, AND CREATING DERIVATIVE WORKS THEREOF, SO LONG AS
8 SUCH USE, DISPLAY OR CREATION IS FOR NON-COMMERCIAL, ROYALTY OR REVENUE
9 FREE PURPOSES. IN NO EVENT SHALL THE END-USER USE THE COMPUTER CODE
10 CONTAINED HEREIN FOR REVENUE-BEARING PURPOSES. THE END-USER UNDERSTANDS
11 AND AGREES TO THE TERMS HEREIN AND ACCEPTS THE SAME BY USE OF THIS FILE.
12 COPYRIGHT 1993-1999 PARALLAX SOFTWARE CORPORATION. ALL RIGHTS RESERVED.
17 * Functions for accessing compressed files.
20 * Revision 1.7 1995/10/27 15:18:20 allender
21 * get back to descent directory before trying to read a hog file
23 * Revision 1.6 1995/10/21 23:48:24 allender
24 * hogfile(s) are now in :Data: folder
26 * Revision 1.5 1995/08/14 09:27:31 allender
27 * added byteswap header
29 * Revision 1.4 1995/05/12 11:54:33 allender
30 * changed memory stuff again
32 * Revision 1.3 1995/05/04 20:03:38 allender
33 * added code that was missing...use NewPtr instead of malloc
35 * Revision 1.2 1995/04/03 09:59:49 allender
36 * *** empty log message ***
38 * Revision 1.1 1995/03/30 10:25:02 allender
42 * --- PC RCS Information ---
43 * Revision 1.24 1995/03/15 14:20:27 john
44 * Added critical error checker.
46 * Revision 1.23 1995/03/13 15:16:53 john
47 * Added alternate directory stuff.
49 * Revision 1.22 1995/02/09 23:08:47 matt
50 * Increased the max number of files in hogfile to 250
52 * Revision 1.21 1995/02/01 20:56:47 john
53 * Added cfexist function
55 * Revision 1.20 1995/01/21 17:53:48 john
56 * Added alternate pig file thing.
58 * Revision 1.19 1994/12/29 15:10:02 john
59 * Increased hogfile max files to 200.
61 * Revision 1.18 1994/12/12 13:20:57 john
62 * Made cfile work with fiellentth.
64 * Revision 1.17 1994/12/12 13:14:25 john
65 * Made cfiles prefer non-hog files.
67 * Revision 1.16 1994/12/09 18:53:26 john
68 * *** empty log message ***
70 * Revision 1.15 1994/12/09 18:52:56 john
71 * Took out mem, error checking.
73 * Revision 1.14 1994/12/09 18:10:31 john
74 * Speed up cfgets, which was slowing down the reading of
75 * bitmaps.tbl, which was making POF loading look slow.
77 * Revision 1.13 1994/12/09 17:53:51 john
78 * Added error checking to number of hogfiles..
80 * Revision 1.12 1994/12/08 19:02:55 john
83 * Revision 1.11 1994/12/07 21:57:48 john
86 * Revision 1.10 1994/12/07 21:38:02 john
87 * Made cfile not return error..
89 * Revision 1.9 1994/12/07 21:35:34 john
90 * Made it read from data directory.
92 * Revision 1.8 1994/12/07 21:33:55 john
93 * Stripped out compression stuff...
95 * Revision 1.7 1994/04/13 23:44:59 matt
96 * When file cannot be opened, free up the buffer for that file.
98 * Revision 1.6 1994/02/18 12:38:20 john
101 * Revision 1.5 1994/02/15 18:13:20 john
104 * Revision 1.4 1994/02/15 13:27:58 john
107 * Revision 1.3 1994/02/15 12:51:57 john
108 * Crappy inbetween version
110 * Revision 1.2 1994/02/14 20:12:29 john
111 * First version working with new cfile stuff.
113 * Revision 1.1 1994/02/14 15:51:33 john
116 * Revision 1.1 1994/02/10 15:45:12 john
129 #include <sys/stat.h>
131 # include <windows.h>
140 #include "byteswap.h"
149 typedef struct hogfile {
155 #define MAX_HOGFILES 300
157 hogfile HogFiles[MAX_HOGFILES];
158 char Hogfile_initialized = 0;
159 int Num_hogfiles = 0;
160 char HogFilename[64];
162 hogfile D1HogFiles[MAX_HOGFILES];
163 char D1Hogfile_initialized = 0;
164 int D1Num_hogfiles = 0;
165 char D1HogFilename[64];
167 hogfile AltHogFiles[MAX_HOGFILES];
168 char AltHogfile_initialized = 0;
169 int AltNum_hogfiles = 0;
170 char AltHogFilename[64];
173 char AltHogdir_initialized = 0;
175 // routine to take a DOS path and turn it into a macintosh
176 // pathname. This routine is based on the fact that we should
177 // see a \ character in the dos path. The sequence .\ a tthe
178 // beginning of a path is turned into a :
181 void macify_dospath(char *dos_path, char *mac_path)
185 if (!strncmp(dos_path, ".\\", 2)) {
186 strcpy(mac_path, ":");
187 strcat(mac_path, &(dos_path[2]) );
189 strcpy(mac_path, dos_path);
191 while ( (p = strchr(mac_path, '\\')) != NULL)
197 void cfile_use_alternate_hogdir( char * path )
200 strcpy( AltHogDir, path );
201 AltHogdir_initialized = 1;
203 AltHogdir_initialized = 0;
207 //in case no one installs one
208 int default_error_counter=0;
210 //ptr to counter of how many critical errors
211 int *critical_error_counter_ptr=&default_error_counter;
213 //tell cfile about your critical error counter
214 void cfile_set_critical_error_counter_ptr(int *ptr)
216 critical_error_counter_ptr = ptr;
221 FILE * cfile_get_filehandle( char * filename, char * mode )
226 *critical_error_counter_ptr = 0;
227 fp = fopen( filename, mode );
228 if ( fp && *critical_error_counter_ptr ) {
232 if ( (fp==NULL) && (AltHogdir_initialized) ) {
233 strcpy( temp, AltHogDir );
235 strcat( temp, filename );
236 *critical_error_counter_ptr = 0;
237 fp = fopen( temp, mode );
238 if ( fp && *critical_error_counter_ptr ) {
246 //returns 1 if file loaded with no errors
247 int cfile_init_hogfile(char *fname, hogfile * hog_files, int * nfiles )
255 fp = cfile_get_filehandle( fname, "rb" );
256 if ( fp == NULL ) return 0;
258 fread( id, 3, 1, fp );
259 if ( strncmp( id, "DHF", 3 ) ) {
266 if ( *nfiles >= MAX_HOGFILES ) {
268 Error( "HOGFILE is limited to %d files.\n", MAX_HOGFILES );
270 i = fread( hog_files[*nfiles].name, 13, 1, fp );
271 if ( i != 1 ) { //eof here is ok
275 i = fread( &len, 4, 1, fp );
280 hog_files[*nfiles].length = INTEL_INT(len);
281 hog_files[*nfiles].offset = ftell( fp );
282 *nfiles = (*nfiles) + 1;
284 i = fseek( fp, INTEL_INT(len), SEEK_CUR );
288 //Specify the name of the hogfile. Returns 1 if hogfile found & had files
289 int cfile_init(char *hogname)
294 macify_dospath(hogname, mac_path);
297 Assert(Hogfile_initialized == 0);
300 if (cfile_init_hogfile(hogname, HogFiles, &Num_hogfiles )) {
301 strcpy( HogFilename, hogname );
303 if (cfile_init_hogfile(mac_path, HogFiles, &Num_hogfiles )) {
304 strcpy( HogFilename, mac_path );
306 Hogfile_initialized = 1;
310 return 0; //not loaded!
314 int cfile_size(char *hogname)
320 fp = cfopen(hogname, "rb");
323 fstat(fileno(fp->file), &statbuf);
325 return statbuf.st_size;
330 fp = cfopen(hogname, "rb");
333 size = GetFileSize(fileno(fp->file), NULL);
340 * return handle for file called "name", embedded in one of the hogfiles
342 FILE * cfile_find_libfile(char * name, int * length)
347 if ( AltHogfile_initialized ) {
348 for (i=0; i<AltNum_hogfiles; i++ ) {
349 if ( !stricmp( AltHogFiles[i].name, name )) {
350 fp = cfile_get_filehandle( AltHogFilename, "rb" );
351 if ( fp == NULL ) return NULL;
352 fseek( fp, AltHogFiles[i].offset, SEEK_SET );
353 *length = AltHogFiles[i].length;
359 if ( !Hogfile_initialized ) {
360 //@@cfile_init_hogfile( "DESCENT2.HOG", HogFiles, &Num_hogfiles );
361 //@@Hogfile_initialized = 1;
363 //Int3(); //hogfile ought to be initialized
366 for (i=0; i<Num_hogfiles; i++ ) {
367 if ( !stricmp( HogFiles[i].name, name )) {
368 fp = cfile_get_filehandle( HogFilename, "rb" );
369 if ( fp == NULL ) return NULL;
370 fseek( fp, HogFiles[i].offset, SEEK_SET );
371 *length = HogFiles[i].length;
376 if (D1Hogfile_initialized) {
377 for (i = 0; i < D1Num_hogfiles; i++) {
378 if (!stricmp(D1HogFiles[i].name, name)) {
379 fp = cfile_get_filehandle(D1HogFilename, "rb");
380 if (fp == NULL) return NULL;
381 fseek(fp, D1HogFiles[i].offset, SEEK_SET);
382 *length = D1HogFiles[i].length;
391 int cfile_use_alternate_hogfile( char * name )
397 macify_dospath(name, mac_path);
398 strcpy( AltHogFilename, mac_path);
400 strcpy( AltHogFilename, name );
402 cfile_init_hogfile( AltHogFilename, AltHogFiles, &AltNum_hogfiles );
403 AltHogfile_initialized = 1;
404 return (AltNum_hogfiles > 0);
406 AltHogfile_initialized = 0;
411 int cfile_use_descent1_hogfile( char * name )
417 macify_dospath(name, mac_path);
418 strcpy(D1HogFilename, mac_path);
420 strcpy(D1HogFilename, name);
422 cfile_init_hogfile(D1HogFilename, D1HogFiles, &D1Num_hogfiles);
423 D1Hogfile_initialized = 1;
424 return (D1Num_hogfiles > 0);
426 D1Hogfile_initialized = 0;
432 // cfeof() Tests for end-of-file on a stream
434 // returns a nonzero value after the first read operation that attempts to read
435 // past the end of the file. It returns 0 if the current position is not end of file.
436 // There is no error return.
438 int cfeof(CFILE *cfile)
440 Assert(cfile != NULL);
442 Assert(cfile->file != NULL);
444 return (cfile->raw_position >= cfile->size);
448 int cferror(CFILE *cfile)
450 return ferror(cfile->file);
454 int cfexist( char * filename )
460 if (filename[0] != '\x01')
461 fp = cfile_get_filehandle( filename, "rb" ); // Check for non-hog file first...
463 fp = NULL; //don't look in dir, only in hogfile
472 fp = cfile_find_libfile(filename, &length );
475 return 2; // file found in hog
478 return 0; // Couldn't find it.
483 int cfile_delete(char *filename)
486 return remove(filename);
488 return !DeleteFile(filename);
494 int cfile_rename(char *oldname, char *newname)
497 return rename(oldname, newname);
499 return !MoveFile(oldname, newname);
505 int cfile_mkdir(char *pathname)
509 return !CreateDirectory(pathname, NULL);
511 return _mkdir(pathname);
514 return mkdir(pathname, 0755);
519 CFILE * cfopen(char * filename, char * mode )
525 if (filename[0] != '\x01') {
529 macify_dospath(filename, mac_path);
530 fp = cfile_get_filehandle( mac_path, mode);
532 fp = cfile_get_filehandle( filename, mode ); // Check for non-hog file first...
535 fp = NULL; //don't look in dir, only in hogfile
540 fp = cfile_find_libfile(filename, &length );
542 return NULL; // No file found
543 if (stricmp(mode, "rb"))
544 Error("mode must be rb for files in hog.\n");
545 cfile = d_malloc ( sizeof(CFILE) );
546 if ( cfile == NULL ) {
551 cfile->size = length;
552 cfile->lib_offset = ftell( fp );
553 cfile->raw_position = 0;
556 cfile = d_malloc ( sizeof(CFILE) );
557 if ( cfile == NULL ) {
562 cfile->size = ffilelength(fp);
563 cfile->lib_offset = 0;
564 cfile->raw_position = 0;
569 int cfilelength( CFILE *fp )
575 // cfwrite() writes to the file
577 // returns: number of full elements actually written
580 int cfwrite(void *buf, int elsize, int nelem, CFILE *cfile)
584 Assert(cfile != NULL);
588 Assert(cfile->file != NULL);
589 Assert(cfile->lib_offset == 0);
591 items_written = fwrite(buf, elsize, nelem, cfile->file);
592 cfile->raw_position = ftell(cfile->file);
594 return items_written;
598 // cfputc() writes a character to a file
600 // returns: success ==> returns character written
603 int cfputc(int c, CFILE *cfile)
607 Assert(cfile != NULL);
609 Assert(cfile->file != NULL);
610 Assert(cfile->lib_offset == 0);
612 char_written = fputc(c, cfile->file);
613 cfile->raw_position = ftell(cfile->file);
619 int cfgetc( CFILE * fp )
623 if (fp->raw_position >= fp->size ) return EOF;
625 c = getc( fp->file );
627 fp->raw_position = ftell(fp->file)-fp->lib_offset;
633 // cfputs() writes a string to a file
635 // returns: success ==> non-negative value
638 int cfputs(char *str, CFILE *cfile)
642 Assert(cfile != NULL);
645 Assert(cfile->file != NULL);
647 ret = fputs(str, cfile->file);
648 cfile->raw_position = ftell(cfile->file);
654 char * cfgets( char * buf, size_t n, CFILE * fp )
660 #if 0 // don't use the standard fgets, because it will only handle the native line-ending style
661 if (fp->lib_offset == 0) // This is not an archived file
663 t = fgets(buf, n, fp->file);
664 fp->raw_position = ftell(fp->file);
669 for (i=0; i<n-1; i++ ) {
671 if (fp->raw_position >= fp->size ) {
676 if (c == 0 || c == 10) // Unix line ending
678 if (c == 13) { // Mac or DOS line ending
682 cfseek(fp, -1, SEEK_CUR);
683 if ( c1 == 10 ) // DOS line ending
685 else // Mac line ending
689 if ( c == 13 ) // because cr-lf is a bad thing on the mac
690 c = '\n'; // and anyway -- 0xod is CR on mac, not 0x0a
692 if ( c=='\n' ) break;
698 size_t cfread( void * buf, size_t elsize, size_t nelem, CFILE * fp )
700 unsigned int i, size;
702 size = elsize * nelem;
703 if ( size < 1 ) return 0;
705 i = fread ( buf, 1, size, fp->file );
706 fp->raw_position += i;
711 int cftell( CFILE *fp )
713 return fp->raw_position;
716 int cfseek( CFILE *fp, long int offset, int where )
718 int c, goal_position;
722 goal_position = offset;
725 goal_position = fp->raw_position+offset;
728 goal_position = fp->size+offset;
733 c = fseek( fp->file, fp->lib_offset + goal_position, SEEK_SET );
734 fp->raw_position = ftell(fp->file)-fp->lib_offset;
738 int cfclose(CFILE *fp)
742 result = fclose(fp->file);
748 // routines to read basic data types from CFILE's. Put here to
749 // simplify mac/pc reading from cfiles.
751 int cfile_read_int(CFILE *file)
755 if (cfread( &i, sizeof(i), 1, file) != 1)
756 Error( "Error reading int in cfile_read_int()" );
762 short cfile_read_short(CFILE *file)
766 if (cfread( &s, sizeof(s), 1, file) != 1)
767 Error( "Error reading short in cfile_read_short()" );
773 sbyte cfile_read_byte(CFILE *file)
777 if (cfread( &b, sizeof(b), 1, file) != 1)
778 Error( "Error reading byte in cfile_read_byte()" );
783 fix cfile_read_fix(CFILE *file)
787 if (cfread( &f, sizeof(f), 1, file) != 1)
788 Error( "Error reading fix in cfile_read_fix()" );
790 f = (fix)INTEL_INT((int)f);
794 fixang cfile_read_fixang(CFILE *file)
798 if (cfread(&f, 2, 1, file) != 1)
799 Error("Error reading fixang in cfile_read_fixang()");
801 f = (fixang) INTEL_SHORT((int) f);
805 void cfile_read_vector(vms_vector *v, CFILE *file)
807 v->x = cfile_read_fix(file);
808 v->y = cfile_read_fix(file);
809 v->z = cfile_read_fix(file);
812 void cfile_read_angvec(vms_angvec *v, CFILE *file)
814 v->p = cfile_read_fixang(file);
815 v->b = cfile_read_fixang(file);
816 v->h = cfile_read_fixang(file);
819 void cfile_read_matrix(vms_matrix *m,CFILE *file)
821 cfile_read_vector(&m->rvec,file);
822 cfile_read_vector(&m->uvec,file);
823 cfile_read_vector(&m->fvec,file);
827 void cfile_read_string(char *buf, int n, CFILE *file)
832 c = (char)cfile_read_byte(file);
842 // equivalent write functions of above read functions follow
844 int cfile_write_int(int i, CFILE *file)
847 return cfwrite(&i, sizeof(i), 1, file);
851 int cfile_write_short(short s, CFILE *file)
854 return cfwrite(&s, sizeof(s), 1, file);
858 int cfile_write_byte(sbyte b, CFILE *file)
860 return cfwrite(&b, sizeof(b), 1, file);
864 int cfile_write_string(char *buf, CFILE *file)
868 if ((!buf) || (buf && !buf[0]))
869 return cfile_write_byte(0, file);
872 if (!cfwrite(buf, len, 1, file))
875 return cfile_write_byte(0, file); // write out NULL termination