2 * Copyright (C) Volition, Inc. 1999. All rights reserved.
4 * All source code herein is the property of Volition, Inc. You may not sell
5 * or otherwise commercially exploit the source or things you created based on
10 * $Logfile: /Freespace2/code/CFile/cfile.h $
15 * <insert description of file here>
18 * Revision 1.3 2003/02/20 17:41:07 theoddone33
19 * Userdir patch from Taylor Richards
21 * Revision 1.2 2002/06/09 04:41:12 relnev
22 * added copyright header
24 * Revision 1.1.1.1 2002/05/03 03:28:11 root
28 * 11 9/08/99 12:03a Dave
29 * Make squad logos render properly in D3D all the time. Added intel anim
32 * 10 8/31/99 9:46a Dave
33 * Support for new cfile cbanims directory.
35 * 9 5/19/99 4:07p Dave
36 * Moved versioning code into a nice isolated common place. Fixed up
37 * updating code on the pxo screen. Fixed several stub problems.
39 * 8 3/28/99 5:58p Dave
40 * Added early demo code. Make objects move. Nice and framerate
41 * independant, but not much else. Don't use yet unless you're me :)
43 * 7 3/24/99 4:05p Dave
44 * Put in support for assigning the player to a specific squadron with a
45 * specific logo. Preliminary work for doing pos/orient checksumming in
46 * multiplayer to reduce bandwidth.
48 * 6 1/12/99 3:15a Dave
49 * Barracks screen support for selecting squad logos. We need real artwork
52 * 5 10/29/98 10:41a Dave
53 * Change the way cfile initializes exe directory.
55 * 4 10/13/98 9:19a Andsager
56 * Add localization support to cfile. Optional parameter with cfopen that
57 * looks for localized files.
59 * 3 10/12/98 9:54a Dave
60 * Fixed a few file organization things.
62 * 2 10/07/98 10:52a Dave
65 * 1 10/07/98 10:48a Dave
67 * 84 9/09/98 5:53p Dave
68 * Put in new tracker packets in API. Change cfile to be able to checksum
71 * 83 8/12/98 4:53p Dave
72 * Put in 32 bit checksumming for PXO missions. No validation on the
73 * actual tracker yet, though.
75 * 82 5/19/98 1:19p Allender
76 * new low level reliable socket reading code. Make all missions/campaign
77 * load/save to data missions folder (i.e. we are rid of the player
80 * 81 5/13/98 10:22p John
81 * Added cfile functions to read/write rle compressed blocks of data.
82 * Made palman use it for .clr files. Made alphacolors calculate on the
83 * fly rather than caching to/from disk.
85 * 80 5/01/98 10:21a John
86 * Added code to find all pack files in all trees. Added code to create
87 * any directories that we write to.
89 * 79 4/30/98 10:29p John
90 * Added code to refresh filelist if cd-rom changed or packfiles created
93 * 78 4/30/98 10:06p John
94 * Started adding code for splitting the maps data tree for hardware
97 * 77 4/30/98 9:43p John
98 * Restructured some stuff.
100 * 76 4/30/98 8:23p John
101 * Fixed some bugs with Fred caused by my new cfile code.
103 * 75 4/30/98 4:53p John
104 * Restructured and cleaned up cfile code. Added capability to read off
105 * of CD-ROM drive and out of multiple pack files.
107 * 74 4/20/98 6:04p Dave
108 * Implement multidata cache flushing and xferring mission files to
109 * multidata. Make sure observers can't change hud config. Fix pilot image
110 * viewing in popup. Put in game status field. Tweaked multi options.
112 * 73 4/01/98 6:06p Hoffoss
113 * Added a command briefing directory for those voice files.
115 * 72 3/31/98 4:51p Dave
116 * Removed medals screen and multiplayer buttons from demo version. Put in
117 * new pilot popup screen. Make ships in mp team vs. team have proper team
118 * ids. Make mp respawns a permanent option saved in the player file.
120 * 71 3/26/98 6:01p Dave
121 * Put in file checksumming routine in cfile. Made pilot pic xferring more
122 * robust. Cut header size of voice data packets in half. Put in
123 * restricted game host query system.
125 * 70 3/10/98 2:27p Hoffoss
126 * Added change directory with history stack functions, so you can switch
127 * to a new directory, do something, and restore to what it was. useful
130 * 69 3/07/98 3:48p Lawrance
131 * get save game working, allow restore from main menu
133 * 68 2/26/98 10:07p Hoffoss
134 * Rewrote state saving and restoring to fix bugs and simplify the code.
136 * 67 2/20/98 4:43p Dave
137 * Finished support for multiplayer player data files. Split off
138 * multiplayer campaign functionality.
140 * 66 2/19/98 6:26p Dave
141 * Fixed a few file xfer bugs. Tweaked mp team select screen. Put in
142 * initial support for player data uploading.
144 * 65 2/06/98 3:47p Allender
145 * subtitling for movies
147 * 64 2/05/98 10:15p Lawrance
148 * Add support for .svg filenames.
150 * 63 1/12/98 10:07p Hoffoss
151 * Made tab cycle properly in debriefing screen and put in aux. pilot
154 * 62 1/11/98 2:45p John
155 * Changed .lst to .clt
157 * 61 1/11/98 2:14p John
158 * Changed a lot of stuff that had to do with bitmap loading. Made cfile
159 * not do callbacks, I put that in global code. Made only bitmaps that
160 * need to load for a level load.
162 * 60 1/02/98 4:41p Allender
163 * added new mission folder for "player" missions
165 * 59 12/28/97 12:42p John
166 * Put in support for reading archive files; Made missionload use the
167 * cf_get_file_list function. Moved demos directory out of data tree.
169 * 58 12/17/97 10:16p Allender
170 * implemented a "no callback" flag to tell the cfile code not to use the
171 * cf_callback on files which specify this flag
173 * 57 12/08/97 6:23p Lawrance
176 * 56 12/07/97 4:30p John
177 * Fixed bug with cfile versioning if two files use it at once. Added
178 * code to cfile so I could display a loading box while loading.
180 * 55 11/24/97 9:28a Hoffoss
181 * Moved define of CF_TYPE_MULTI_PLAYERS so it's in order. I started to
182 * add it because I couldn't find it, so that's indication enough it
185 * 54 11/20/97 1:07a Lawrance
186 * add support for voice/debriefings directory
188 * 53 11/19/97 7:27p Hoffoss
189 * Added version checking read functions.
191 * 52 11/18/97 10:53a Hoffoss
193 * 51 11/17/97 6:07p Hoffoss
194 * Make get_file_list() allow filtering via a callback function.
196 * 50 11/16/97 2:29p John
197 * added versioning to nebulas; put nebula code into freespace.
199 * 49 11/15/97 6:10p Lawrance
200 * add in support for new voice directories
202 * 48 11/11/97 4:54p Dave
203 * Put in support for single vs. multiplayer pilots. Put in initial player
204 * selection screen (no command line option yet). Started work on
205 * multiplayer campaign file save gaming.
207 * 47 11/07/97 4:00p Hoffoss
208 * Capitalized directory names, changed the player/image directory to work
209 * like the rest, and forced the player/images directory to be created.
211 * 46 11/06/97 5:38p Hoffoss
212 * Added a new player image directory and added support for it.
214 * 45 11/04/97 7:46p Lawrance
215 * Add support for data\interface\HUD directory
217 * 44 10/29/97 6:22p Hoffoss
218 * Added some new file listing functions.
220 * 43 10/28/97 10:54a Lawrance
221 * support for 8b22k and 16b11k directories under the sound directory
223 * 42 10/14/97 11:34p Lawrance
224 * add function to get full path for a given filename
226 * 41 9/24/97 5:30p Lawrance
227 * add directory for voices
229 * 40 9/20/97 8:16a John
230 * Made .clr files go into the Cache directory. Replaced cfopen(name,NULL)
231 * to delete a file with cf_delete.
233 * 39 9/09/97 6:50p Hoffoss
234 * Fixed bug with mission saving.
236 * 38 9/05/97 4:52p Lawrance
237 * fix prototype for cfread_angles() and cfwrite_angles()
239 * 37 8/29/97 4:47p Dave
240 * Added an extension for state transfer status files.
242 * 36 8/21/97 12:14p Dave
243 * Changed demo file extension from .keg to .fsd
245 * 35 8/19/97 5:51p Hoffoss
246 * Fixes to cfopen to not check the default directory first, but check it
247 * last. Also tracks info as to where a file is located when opened.
249 * 34 8/17/97 10:22p Hoffoss
250 * Fixed several bugs in Fred with Undo feature. In the process, recoded
251 * a lot of CFile.cpp.
253 * 33 8/17/97 12:47p Hoffoss
254 * Changed code so I can force missions to load from the missions
255 * directory regardless of it's extension.
257 * 32 8/13/97 1:39p Adam
258 * make .ani files available in the data/effects directory
260 * 31 8/13/97 12:24p Lawrance
261 * Add support for effects directory
263 * 30 7/30/97 5:23p Dave
264 * Added file extensions for demo stuff
266 * 29 7/28/97 10:42p Lawrance
267 * added ctmpfile(), analog to tmpfile()
269 * 28 7/16/97 5:29p John
270 * added palette table caching and made scaler and liner no light tmapper
271 * do alpha blending in 8 bpp mode.
273 * 27 6/05/97 4:53p John
274 * First rev of new antialiased font stuff.
276 * 26 6/05/97 1:22p Allender
277 * added .ntl as an extension for nettest program
279 * 25 4/25/97 11:31a Allender
280 * Campaign state now saved in campaign save file in player directory.
281 * Made some global variables follow naming convention. Solidified
282 * continuing campaigns based on new structure
284 * 24 4/17/97 9:01p Allender
285 * start of campaign stuff. Campaigns now stored in external file (no
286 * filenames in code). Continuing campaign won't work at this point
288 * 23 4/03/97 4:26p Lawrance
289 * adding .wav search to music directory
291 * 22 4/01/97 9:26a Allender
292 * added support for descent style fonts although they are not used in the
295 * 21 3/04/97 8:17a John
296 * Fixed movie code to not require a file handle. Used CFILE instead.
297 * Took cfile_get_handle or whatever out.
299 * 20 3/03/97 8:57a Lawrance
300 * took out cf_returnfp()
302 * 19 3/01/97 2:09p Lawrance
303 * supporting memory mapped files, moved cfile implementation details into
306 * 18 2/17/97 3:00p Lawrance
307 * added .ani type to MAPS_EXT and INTERFACE_EXT
309 * 17 2/07/97 9:00a Lawrance
310 * added cfread_uint() and cwrite_uint()
312 * 16 2/04/97 9:29a Allender
313 * added cfwrite* functions
315 * 15 1/22/97 10:48a Lawrance
316 * supporting AVI playback
318 * 14 12/23/96 10:56a John
319 * Totally restructured the POF stuff to support multiple
320 * detail levels in one POF file.
323 * 13 11/20/96 10:00a Hoffoss
324 * Added cfile_chdir() function.
326 * 12 11/13/96 10:14a Allender
327 * added small routines to read basic data types. Also changed code to
328 * try to find extensions in more than 1 directory.
330 * 11 11/11/96 3:21p Allender
331 * added extension for movies
344 #define CF_SEEK_SET (0)
345 #define CF_SEEK_CUR (1)
346 #define CF_SEEK_END (2)
348 typedef struct CFILE {
349 int id; // Index into cfile.cpp specific structure
350 int version; // version of this file
353 // extra info that can be returned when getting a file listing
359 #define CF_MAX_FILENAME_LENGTH 32 // Includes null terminater, so real length is 31
360 #define CF_MAX_PATHNAME_LENGTH 256 // Includes null terminater, so real length is 255
362 #define CF_TYPE_ANY -1 // Used to check in any directory
364 #define CF_TYPE_INVALID 0
365 #define CF_TYPE_ROOT 1 // Root must be 1!!
366 #define CF_TYPE_DATA 2
367 #define CF_TYPE_MAPS 3
368 #define CF_TYPE_TEXT 4
369 #define CF_TYPE_MISSIONS 5
370 #define CF_TYPE_MODELS 6
371 #define CF_TYPE_TABLES 7
372 #define CF_TYPE_SOUNDS 8
373 #define CF_TYPE_SOUNDS_8B22K 9
374 #define CF_TYPE_SOUNDS_16B11K 10
375 #define CF_TYPE_VOICE 11
376 #define CF_TYPE_VOICE_BRIEFINGS 12
377 #define CF_TYPE_VOICE_CMD_BRIEF 13
378 #define CF_TYPE_VOICE_DEBRIEFINGS 14
379 #define CF_TYPE_VOICE_PERSONAS 15
380 #define CF_TYPE_VOICE_SPECIAL 16
381 #define CF_TYPE_VOICE_TRAINING 17
382 #define CF_TYPE_MUSIC 18
383 #define CF_TYPE_MOVIES 19
384 #define CF_TYPE_INTERFACE 20
385 #define CF_TYPE_FONT 21
386 #define CF_TYPE_EFFECTS 22
387 #define CF_TYPE_HUD 23
388 #define CF_TYPE_PLAYER_MAIN 24
389 #define CF_TYPE_PLAYER_IMAGES_MAIN 25
390 #define CF_TYPE_CACHE 26
391 #define CF_TYPE_PLAYERS 27
392 #define CF_TYPE_SINGLE_PLAYERS 28
393 #define CF_TYPE_MULTI_PLAYERS 29
394 #define CF_TYPE_MULTI_CACHE 30
395 #define CF_TYPE_CONFIG 31
396 #define CF_TYPE_SQUAD_IMAGES_MAIN 32
397 #define CF_TYPE_DEMOS 33
398 #define CF_TYPE_CBANIMS 34
399 #define CF_TYPE_INTEL_ANIMS 35
401 #define CF_MAX_PATH_TYPES 36 // Can be as high as you'd like
403 // TRUE if type is specified and valid
404 #define CF_TYPE_SPECIFIED(path_type) (((path_type)>CF_TYPE_INVALID) && ((path_type)<CF_MAX_PATH_TYPES))
406 // #define's for the type parameter in cfopen.
407 #define CFILE_NORMAL 0 // open file normally
408 #define CFILE_MEMORY_MAPPED (1<<0) // open file as a memory-mapped file
410 #define CF_SORT_NONE 0
411 #define CF_SORT_NAME 1
412 #define CF_SORT_TIME 2
414 #define cfread_fix(file) (fix)cfread_int(file)
415 #define cfwrite_fix(i,file) cfwrite_int(i,file)
417 // callback function used for get_file_list() to filter files to be added to list. Return 1
418 // to add file to list, or 0 to not add it.
419 extern int (*Get_file_list_filter)(char *filename);
421 // cfile directory. valid after cfile_init() returns successfully
422 #define CFILE_ROOT_DIRECTORY_LEN 256
423 extern char Cfile_root_dir[CFILE_ROOT_DIRECTORY_LEN];
425 extern char Cfile_user_dir[CFILE_ROOT_DIRECTORY_LEN];
428 //================= LOW-LEVEL FUNCTIONS ==================
429 // Call this once at the beginning of the program
430 int cfile_init(char *exe_dir,char *cdrom_dir=NULL);
432 // Call this if pack files got added or removed or the
433 // cdrom changed. This will refresh the list of filenames
434 // stored in packfiles and on the cdrom.
435 void cfile_refresh();
437 // add an extension to a filename if it doesn't already have it
438 char *cf_add_ext(char *filename, char *ext);
440 // return CF_TYPE (directory location type) of a CFILE you called cfopen() successfully on.
441 int cf_get_dir_type(CFILE *cfile);
443 // Opens the file. If no path is given, use the extension to look into the
444 // default path. If mode is NULL, delete the file.
445 CFILE *cfopen(char *filename, char *mode, int type = CFILE_NORMAL, int dir_type = CF_TYPE_ANY, bool localize = false);
447 // Flush the open file buffer
448 int cflush(CFILE *cfile);
450 // version number of opened file. Will be 0 unless you put something else here after you
451 // open a file. Once set, you can use minimum version numbers with the read functions.
452 void cf_set_version( CFILE * cfile, int version );
455 void cf_delete( char *filename, int dir_type );
457 // Same as _access function to read a file's access bits
458 int cf_access( char *filename, int dir_type, int mode );
460 // Returns 1 if file exists, 0 if not.
461 int cf_exist( char *filename, int dir_type );
463 // ctmpfile() opens a temporary file stream. File is deleted automatically when closed
467 int cfclose(CFILE *cfile);
469 // Returns size of file...
470 int cfilelength(CFILE *fp);
473 int cfread(void *buf, int elsize, int nelem, CFILE *fp);
475 // cfwrite() writes to the file
476 int cfwrite(void *buf, int elsize, int nelem, CFILE *cfile);
478 // Reads/writes RLE compressed data.
479 int cfread_compressed(void *buf, int elsize, int nelem, CFILE *cfile);
480 int cfwrite_compressed(void *param_buf, int param_elsize, int param_nelem, CFILE *cfile);
482 // Moves the file pointer
483 int cfseek(CFILE *fp, int offset, int where);
485 // Returns current position of file.
486 int cftell(CFILE *fp);
488 // cfputc() writes a character to a file
489 int cfputc(int c, CFILE *cfile);
491 // cfputs() writes a string to a file
492 int cfputs(char *str, CFILE *cfile);
494 // cfgetc() reads a character to a file
495 int cfgetc(CFILE *cfile);
497 // cfgets() reads a string from a file
498 char *cfgets(char *buf, int n, CFILE *cfile);
500 // cfeof() Tests for end-of-file on a stream
501 int cfeof(CFILE *cfile);
503 // Return the data pointer associated with the CFILE structure (for memory mapped files)
504 void *cf_returndata(CFILE *cfile);
506 // get the 2 byte checksum of the passed filename - return 0 if operation failed, 1 if succeeded
507 int cf_chksum_short(char *filename, ushort *chksum, int max_size = -1, int cf_type = CF_TYPE_ANY );
509 // get the 2 byte checksum of the passed file - return 0 if operation failed, 1 if succeeded
510 // NOTE : preserves current file position
511 int cf_chksum_short(CFILE *file, ushort *chksum, int max_size = -1);
513 // get the 32 bit CRC checksum of the passed filename - return 0 if operation failed, 1 if succeeded
514 int cf_chksum_long(char *filename, uint *chksum, int max_size = -1, int cf_type = CF_TYPE_ANY );
516 // get the 32 bit CRC checksum of the passed file - return 0 if operation failed, 1 if succeeded
517 // NOTE : preserves current file position
518 int cf_chksum_long(CFILE *file, uint *chksum, int max_size = -1);
520 // convenient for misc checksumming purposes ------------------------------------------
522 // update cur_chksum with the chksum of the new_data of size new_data_size
523 ushort cf_add_chksum_short(ushort seed, char *buffer, int size);
525 // update cur_chksum with the chksum of the new_data of size new_data_size
526 unsigned long cf_add_chksum_long(unsigned long seed, char *buffer, int size);
528 // convenient for misc checksumming purposes ------------------------------------------
530 //================= HIGH LEVEL FUNCTIONS ==================
531 int cfexist(char *filename); // Returns true if file exists on disk (1) or in hog (2).
533 // rename a file, utilizing the extension to determine where file is.
534 #define CF_RENAME_SUCCESS 0 // successfully renamed the file
535 #define CF_RENAME_FAIL_ACCESS 1 // new name could not be created
536 #define CF_RENAME_FAIL_EXIST 2 // old name does not exist
537 int cf_rename(char *old_name, char *name, int type = CF_TYPE_ANY );
539 // changes the attributes of a file
540 void cf_attrib(char *name, int set, int clear, int type);
542 // flush (delete all files in) the passed directory (by type), return the # of files deleted
543 // NOTE : WILL NOT DELETE READ-ONLY FILES
544 int cfile_flush_dir(int type);
546 // functions for reading from cfile
547 // These are all high level, built up from
549 int cfgetc(CFILE *fp);
550 char *cfgets(char *buf, size_t n, CFILE *fp);
551 char cfread_char(CFILE *file, int ver = 0, char deflt = 0);
552 ubyte cfread_ubyte(CFILE *file, int ver = 0, ubyte deflt = 0);
553 short cfread_short(CFILE *file, int ver = 0, short deflt = 0);
554 ushort cfread_ushort(CFILE *file, int ver = 0, ushort deflt = 0);
555 int cfread_int(CFILE *file, int ver = 0, int deflt = 0);
556 uint cfread_uint(CFILE *file, int ver = 0, uint deflt = 0);
557 float cfread_float(CFILE *file, int ver = 0, float deflt = 0.0f);
558 void cfread_vector(vector *vec, CFILE *file, int ver = 0, vector *deflt = NULL);
559 void cfread_angles(angles *ang, CFILE *file, int ver = 0, angles *deflt = NULL);
561 // Reads variable length, null-termined string. Will only read up
563 void cfread_string(char *buf,int n, CFILE *file);
564 // Read a fixed length that is null-terminatedm, and has the length
566 void cfread_string_len(char *buf,int n, CFILE *file);
568 // functions for writing cfiles
569 int cfwrite_char(char c, CFILE *file);
570 int cfwrite_float(float f, CFILE *file);
571 int cfwrite_int(int i, CFILE *file);
572 int cfwrite_uint(uint i, CFILE *file);
573 int cfwrite_short(short s, CFILE *file);
574 int cfwrite_ushort(ushort s, CFILE *file);
575 int cfwrite_ubyte(ubyte u, CFILE *file);
576 int cfwrite_vector(vector *vec, CFILE *file);
577 int cfwrite_angles(angles *ang, CFILE *file);
579 // writes variable length, null-termined string.
580 int cfwrite_string(char *buf, CFILE *file);
582 // write a fixed length that is null-terminatedm, and has the length
584 int cfwrite_string_len(char *buf, CFILE *file);
586 int cf_get_file_list( int max, char **list, int type, char *filter, int sort = CF_SORT_NONE, file_list_info *info = NULL );
587 int cf_get_file_list_preallocated( int max, char arr[][MAX_FILENAME_LEN], char **list, int type, char *filter, int sort = CF_SORT_NONE, file_list_info *info = NULL );
588 void cf_sort_filenames( int n, char **list, int sort, file_list_info *info = NULL );
590 // Searches for a file. Follows all rules and precedence and searches
591 // CD's and pack files.
592 // Input: filespace - Filename & extension
593 // pathtype - See CF_TYPE_ defines in CFILE.H
594 // Output: pack_filename - Absolute path and filename of this file. Could be a packfile or the actual file.
596 // offset - Offset into pack file. 0 if not a packfile.
597 // Returns: If not found returns 0.
598 int cf_find_file_location( char *filespec, int pathtype, char *pack_filename, int *size, int *offset, bool localize = false);
600 // Functions to change directories
601 int cfile_chdir(char *dir);
602 int cfile_chdrive(int DriveNum, int flag);
604 // push current directory on a 'stack' (so we can restore it) and change the directory
605 int cfile_push_chdir(int type);
607 // restore directory on top of the stack
611 #endif /* __CFILE_H__ */