/
physfs.h
817 lines (735 loc) · 32.7 KB
1
2
3
4
5
6
7
8
9
10
11
12
/**
* PhysicsFS; a portable, flexible file i/o abstraction.
*
* This API gives you access to a system file system in ways superior to the
* stdio or system i/o calls. The brief benefits:
*
* - It's portable.
* - It's safe. No file access is permitted outside the specified dirs.
* - It's flexible. Archives (.ZIP files) can be used transparently as
* directory structures.
*
* This system is largely inspired by Quake 3's PK3 files and the related
13
* fs_* cvars. If you've ever tinkered with these, then this API will be
14
15
* familiar to you.
*
16
17
18
19
20
21
22
23
24
* With PhysicsFS, you have a single writing directory and multiple
* directories (the "search path") for reading. You can think of this as a
* filesystem within a filesystem. If (on Windows) you were to set the
* writing directory to "C:\MyGame\MyWritingDirectory", then no PHYSFS calls
* could touch anything above this directory, including the "C:\MyGame" and
* "C:\" directories. This prevents an application's internal scripting
* language from piddling over c:\config.sys, for example. If you'd rather
* give PHYSFS full access to the system's REAL file system, set the writing
* dir to "C:\", but that's generally A Bad Thing for several reasons.
25
26
*
* Drive letters are hidden in PhysicsFS once you set up your initial paths.
27
* The search path creates a single, hierarchical directory structure.
28
29
30
31
32
33
34
* Not only does this lend itself well to general abstraction with archives,
* it also gives better support to operating systems like MacOS and Unix.
* Generally speaking, you shouldn't ever hardcode a drive letter; not only
* does this hurt portability to non-Microsoft OSes, but it limits your win32
* users to a single drive, too. Use the PhysicsFS abstraction functions and
* allow user-defined configuration options, too. When opening a file, you
* specify it like it was on a Unix filesystem: if you want to write to
35
* "C:\MyGame\MyConfigFiles\game.cfg", then you might set the write dir to
36
* "C:\MyGame" and then open "MyConfigFiles/game.cfg". This gives an
37
* abstraction across all platforms. Specifying a file in this way is termed
38
39
40
41
42
43
44
45
* "platform-independent notation" in this documentation. Specifying a
* a filename in a form such as "C:\mydir\myfile" or
* "MacOS hard drive:My Directory:My File" is termed "platform-dependent
* notation". The only time you use platform-dependent notation is when
* setting up your write directory and search path; after that, all file
* access into those directories are done with platform-independent notation.
*
* All files opened for writing are opened in relation to the write directory,
46
* which is the root of the writable filesystem. When opening a file for
47
* reading, PhysicsFS goes through the search path. This is NOT the
48
49
50
51
52
53
* same thing as the PATH environment variable. An application using
* PhysicsFS specifies directories to be searched which may be actual
* directories, or archive files that contain files and subdirectories of
* their own. See the end of these docs for currently supported archive
* formats.
*
54
* Once the search path is defined, you may open files for reading. If you've
55
56
57
58
59
60
61
* got the following search path defined (to use a win32 example again):
*
* C:\mygame
* C:\mygame\myuserfiles
* D:\mygamescdromdatafiles
* C:\mygame\installeddatafiles.zip
*
62
* Then a call to PHYSFS_openRead("textfiles/myfile.txt") (note the directory
63
64
65
* separator, lack of drive letter, and lack of dir separator at the start of
* the string; this is platform-independent notation) will check for
* C:\mygame\textfiles\myfile.txt, then
66
67
68
69
* C:\mygame\myuserfiles\textfiles\myfile.txt, then
* D:\mygamescdromdatafiles\textfiles\myfile.txt, then, finally, for
* textfiles\myfile.txt inside of C:\mygame\installeddatafiles.zip. Remember
* that most archive types and platform filesystems store their filenames in
70
* a case-sensitive manner, so you should be careful to specify it correctly.
71
*
72
73
74
75
76
77
78
79
80
81
82
83
84
85
* Files opened through PhysicsFS may NOT contain "." or ".." or ":" as dir
* elements. Not only are these meaningless on MacOS and/or Unix, they are a
* security hole. Also, symbolic links (which can be found in some archive
* types and directly in the filesystem on Unix platforms) are NOT followed
* until you call PHYSFS_permitSymbolicLinks(). That's left to your own
* discretion, as following a symlink can allow for access outside the write
* dir and search paths. There is no mechanism for creating new symlinks in
* PhysicsFS.
*
* The write dir is not included in the search path unless you specifically
* add it. While you CAN change the write dir as many times as you like,
* you should probably set it once and stick to it. Remember that your
* program will not have permission to write in every directory on Unix and
* NT systems.
86
87
88
*
* All files are opened in binary mode; there is no endline conversion for
* textfiles. Other than that, PhysicsFS has some convenience functions for
89
* platform-independence. There is a function to tell you the current
90
* platform's dir separator ("\\" on windows, "/" on Unix, ":" on MacOS),
91
92
93
* which is needed only to set up your search/write paths. There is a
* function to tell you what CD-ROM drives contain accessible discs, and a
* function to recommend a good search path, etc.
94
*
95
96
* A recommended order for the search path is the write dir, then the base dir,
* then the cdrom dir, then any archives discovered. Quake 3 does something
97
98
* like this, but moves the archives to the start of the search path. Build
* Engine games, like Duke Nukem 3D and Blood, place the archives last, and
99
100
* use the base dir for both searching and writing. There is a helper
* function (PHYSFS_setSaneConfig()) that puts together a basic configuration
101
* for you, based on a few parameters. Also see the comments on
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
* PHYSFS_getBaseDir(), and PHYSFS_getUserDir() for info on what those
* are and how they can help you determine an optimal search path.
*
* PhysicsFS is (sort of) NOT thread safe! The error messages returned by
* PHYSFS_getLastError are unique by thread, but that's it. Generally
* speaking, we'd have to request a mutex at the start of each function,
* and release it before returning. Not only is this REALLY slow, it requires
* a thread lock portability layer to be written. All that work is only
* necessary as a safety if the calling application is poorly written.
* Generally speaking, it is safe to call most functions that don't set state
* simultaneously; you can read and write and open and close different files
* at the same time in different threads, but trying to set the write path in
* one thread while opening a file for writing in another will, at best,
* cause a polite error, but depending on the race condition results, you may
* get a segfault and crash, too. Use your head, and implement you own thread
* locks where needed. Also, consider if you REALLY need a multithreaded
* solution in the first place.
119
120
121
*
* While you CAN use stdio/syscall file access in a program that has PHYSFS_*
* calls, doing so is not recommended, and you can not use system
122
123
124
* filehandles with PhysicsFS filehandles and vice versa.
*
* Note that archives need not be named as such: if you have a ZIP file and
125
* rename it with a .PKG extension, the file will still be recognized as a
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
* ZIP archive by PhysicsFS; the file's contents are used to determine its
* type.
*
* Currently supported archive types:
* - .ZIP (pkZip/WinZip/Info-ZIP compatible)
*
* Please see the file LICENSE in the source's root directory.
*
* This file written by Ryan C. Gordon.
*/
#ifndef _INCLUDE_PHYSFS_H_
#define _INCLUDE_PHYSFS_H_
#ifdef __cplusplus
extern "C" {
#endif
145
146
typedef struct __PHYSFS_FILE__
{
147
void *opaque;
148
149
150
151
152
153
} PHYSFS_file;
typedef struct __PHYSFS_ARCHIVEINFO__
{
const char *extension;
const char *description;
154
155
const char *author;
const char *url;
156
157
158
} PHYSFS_ArchiveInfo;
159
160
/* functions... */
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
typedef struct __PHYSFS_VERSION__
{
int major;
int minor;
int patch;
} PHYSFS_Version;
#define PHYSFS_VER_MAJOR 0
#define PHYSFS_VER_MINOR 1
#define PHYSFS_VER_PATCH 0
#define PHYSFS_VERSION(x) { \
x->major = PHYSFS_VER_MAJOR; \
x->minor = PHYSFS_VER_MINOR; \
x->patch = PHYSFS_VER_PATCH; \
}
/**
* Get the version of PhysicsFS that is linked against your program. If you
* are using a shared library (DLL) version of PhysFS, then it is possible
* that it will be different than the version you compiled against.
*
* This is a real function; the macro PHYSFS_VERSION tells you what version
* of PhysFS you compiled against:
*
* PHYSFS_Version compiled;
* PHYSFS_Version linked;
*
* PHYSFS_VERSION(&compiled);
* PHYSFS_getLinkedVersion(&linked);
* printf("We compiled against PhysFS version %d.%d.%d ...\n",
* compiled.major, compiled.minor, compiled.patch);
* printf("But we linked against PhysFS version %d.%d.%d.\n",
* linked.major, linked.minor, linked.patch);
*
* This function may be called safely at any time, even before PHYSFS_init().
*/
void PHYSFS_getLinkedVersion(PHYSFS_Version *ver);
201
202
/**
* Initialize PhysicsFS. This must be called before any other PhysicsFS
203
* function.
204
*
205
206
207
* This should be called prior to any attempts to change your process's
* current working directory.
*
208
209
210
211
212
213
214
215
216
* @param argv0 the argv[0] string passed to your program's mainline.
* @return nonzero on success, zero on error. Specifics of the error can be
* gleaned from PHYSFS_getLastError().
*/
int PHYSFS_init(const char *argv0);
/**
* Shutdown PhysicsFS. This closes any files opened via PhysicsFS, blanks the
217
* search/write paths, frees memory, and invalidates all of your handles.
218
*
219
220
221
222
223
224
* Note that this call can FAIL if there's a file open for writing that
* refuses to close (for example, the underlying operating system was
* buffering writes to network filesystem, and the fileserver has crashed,
* or a hard drive has failed, etc). It is usually best to close all write
* handles yourself before calling this function, so that you can gracefully
* handle a specific failure.
225
*
226
227
228
* Once successfully deinitialized, PHYSFS_init() can be called again to
* restart the subsystem. All defaults API states are restored at this
* point.
229
*
230
231
232
233
* @return nonzero on success, zero on error. Specifics of the error can be
* gleaned from PHYSFS_getLastError(). If failure, state of PhysFS is
* undefined, and probably badly screwed up.
*/
234
int PHYSFS_deinit(void);
235
236
237
238
239
240
241
242
243
/**
* Get a list of archive types supported by this implementation of PhysicFS.
* These are the file formats usable for search path entries. This is for
* informational purposes only. Note that the extension listed is merely
* convention: if we list "ZIP", you can open a PkZip-compatible archive
* with an extension of "XYZ", if you like.
*
244
245
* The returned value is an array of pointers to PHYSFS_ArchiveInfo structures,
* with a NULL entry to signify the end of the list:
246
247
248
249
250
251
252
253
254
255
256
257
258
259
*
* PHYSFS_ArchiveInfo **i;
*
* for (i = PHYSFS_supportedArchiveTypes(); *i != NULL; i++)
* {
* printf("Supported archive: [%s], which is [%s].\n",
* i->extension, i->description);
* }
*
* The return values are pointers to static internal memory, and should
* be considered READ ONLY, and never freed.
*
* @return READ ONLY Null-terminated array of READ ONLY structures.
*/
260
const PHYSFS_ArchiveInfo **PHYSFS_supportedArchiveTypes(void);
261
262
263
264
265
266
267
268
269
270
271
/**
* Certain PhysicsFS functions return lists of information that are
* dynamically allocated. Use this function to free those resources.
*
* @param list List of information specified as freeable by this function.
*/
void PHYSFS_freeList(void *list);
272
273
274
/**
* Get the last PhysicsFS error message as a null-terminated string.
* This will be NULL if there's been no error since the last call to this
275
276
277
278
279
* function. The pointer returned by this call points to an internal buffer.
* Each thread has a unique error state associated with it, but each time
* a new error message is set, it will overwrite the previous one associated
* with that thread. It is safe to call this function at anytime, even
* before PHYSFS_init().
280
281
282
283
284
285
286
*
* @return READ ONLY string of last error message.
*/
const char *PHYSFS_getLastError(void);
/**
287
* Get a platform-dependent dir separator. This is "\\" on win32, "/" on Unix,
288
289
290
* and ":" on MacOS. It may be more than one character, depending on the
* platform, and your code should take that into account. Note that this is
* only useful for setting up the search/write paths, since access into those
291
* dirs always use '/' (platform-independent notation) to separate
292
293
* directories. This is also handy for getting platform-independent access
* when using stdio calls.
294
*
295
* @return READ ONLY null-terminated string of platform's dir separator.
296
*/
297
const char *PHYSFS_getDirSeparator(void);
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
/**
* Enable symbolic links. Some physical filesystems and archives contain
* files that are just pointers to other files. On the physical filesystem,
* opening such a link will (transparently) open the file that is pointed to.
*
* By default, PhysicsFS will check if a file is really a symlink during open
* calls and fail if it is. Otherwise, the link could take you outside the
* write and search paths, and compromise security.
*
* If you want to take that risk, call this function with a non-zero parameter.
* Note that this is more for sandboxing a program's scripting language, in
* case untrusted scripts try to compromise the system. Generally speaking,
* a user could very well have a legitimate reason to set up a symlink, so
* unless you feel there's a specific danger in allowing them, you should
* permit them.
*
* Symbolic link permission can be enabled or disabled at any time, and is
* disabled by default.
*
* @param allow nonzero to permit symlinks, zero to deny linking.
*/
void PHYSFS_permitSymbolicLinks(int allow);
324
/**
325
* Get an array of dirs to available CD-ROM drives.
326
*
327
328
* The dirs returned are platform-dependent ("D:\" on Win32, "/cdrom" or
* whatnot on Unix). Dirs are only returned if there is a disc ready and
329
330
331
332
333
334
335
336
337
* accessible in the drive. So if you've got two drives (D: and E:), and only
* E: has a disc in it, then that's all you get. If the user inserts a disc
* in D: and you call this function again, you get both drives. If, on a
* Unix box, the user unmounts a disc and remounts it elsewhere, the next
* call to this function will reflect that change. Fun.
*
* The returned value is an array of strings, with a NULL entry to signify the
* end of the list:
*
338
* char **cds = PHYSFS_getCdRomDirs();
339
340
* char **i;
*
341
* for (i = cds; *i != NULL; i++)
342
* printf("cdrom dir [%s] is available.\n", *i);
343
*
344
345
* PHYSFS_freeList(cds);
*
346
347
* This call may block while drives spin up. Be forewarned.
*
348
349
350
351
* When you are done with the returned information, you may dispose of the
* resources by calling PHYSFS_freeList() with the returned pointer.
*
* @return Null-terminated array of null-terminated strings.
352
*/
353
char **PHYSFS_getCdRomDirs(void);
354
355
356
357
358
/**
* Helper function.
*
359
* Get the "base dir". This is the directory where the application was run
360
361
* from, which is probably the installation directory, and may or may not
* be the process's current working directory.
362
*
363
* You should probably use the base dir in your search path.
364
*
365
* @return READ ONLY string of base dir in platform-dependent notation.
366
*/
367
const char *PHYSFS_getBaseDir(void);
368
369
370
371
372
/**
* Helper function.
*
373
* Get the "user dir". This is meant to be a suggestion of where a specific
374
* user of the system can store files. On Unix, this is her home directory.
375
* On systems with no concept of multiple home directories (MacOS, win95),
376
* this will default to something like "C:\mybasedir\users\username"
377
378
* where "username" will either be the login name, or "default" if the
* platform doesn't support multiple users, either.
379
*
380
* You should probably use the user dir as the basis for your write dir, and
381
382
* also put it near the beginning of your search path.
*
383
* @return READ ONLY string of user dir in platform-dependent notation.
384
*/
385
const char *PHYSFS_getUserDir(void);
386
387
388
/**
389
* Get the current write dir. The default write dir is NULL.
390
*
391
* @return READ ONLY string of write dir in platform-dependent notation,
392
393
* OR NULL IF NO WRITE PATH IS CURRENTLY SET.
*/
394
const char *PHYSFS_getWriteDir(void);
395
396
397
/**
398
* Set a new write dir. This will override the previous setting. If the
399
400
401
* directory or a parent directory doesn't exist in the physical filesystem,
* PhysicsFS will attempt to create them as needed.
*
402
403
* This call will fail (and fail to change the write dir) if the current
* write dir still has files open in it.
404
*
405
* @param newDir The new directory to be the root of the write dir,
406
* specified in platform-dependent notation. Setting to NULL
407
* disables the write dir, so no files can be opened for
408
409
410
411
412
413
* writing via PhysicsFS.
* @return non-zero on success, zero on failure. All attempts to open a file
* for writing via PhysicsFS will fail until this call succeeds.
* Specifics of the error can be gleaned from PHYSFS_getLastError().
*
*/
414
int PHYSFS_setWriteDir(const char *newDir);
415
416
417
418
419
420
/**
* Add a directory or archive to the search path. If this is a duplicate, the
* entry is not added again, even though the function succeeds.
*
421
* @param newDir directory or archive to add to the path, in
422
423
* platform-dependent notation.
* @param appendToPath nonzero to append to search path, zero to prepend.
424
* @return nonzero if added to path, zero on failure (bogus archive, dir
425
426
427
* missing, etc). Specifics of the error can be
* gleaned from PHYSFS_getLastError().
*/
428
int PHYSFS_addToSearchPath(const char *newDir, int appendToPath);
429
430
431
/**
432
* Remove a directory or archive from the search path.
433
434
435
436
437
438
439
*
* This must be a (case-sensitive) match to a dir or archive already in the
* search path, specified in platform-dependent notation.
*
* This call will fail (and fail to remove from the path) if the element still
* has files open in it.
*
440
* @param oldDir dir/archive to remove.
441
442
443
* @return nonzero on success, zero on failure.
* Specifics of the error can be gleaned from PHYSFS_getLastError().
*/
444
int PHYSFS_removeFromSearchPath(const char *oldDir);
445
446
447
448
449
450
451
452
453
454
455
456
457
/**
* Get the current search path. The default search path is an empty list.
*
* The returned value is an array of strings, with a NULL entry to signify the
* end of the list:
*
* char **i;
*
* for (i = PHYSFS_getSearchPath(); *i != NULL; i++)
* printf("[%s] is in the search path.\n", *i);
*
458
459
* When you are done with the returned information, you may dispose of the
* resources by calling PHYSFS_freeList() with the returned pointer.
460
*
461
462
* @return Null-terminated array of null-terminated strings. NULL if there
* was a problem (read: OUT OF MEMORY).
463
*/
464
char **PHYSFS_getSearchPath(void);
465
466
467
468
469
/**
* Helper function.
*
470
471
* Set up sane, default paths. The write dir will be set to
* "userdir/.appName", which is created if it doesn't exist.
472
473
474
475
476
477
478
*
* The above is sufficient to make sure your program's configuration directory
* is separated from other clutter, and platform-independent. The period
* before "mygame" even hides the directory on Unix systems.
*
* The search path will be:
*
479
480
481
482
483
484
* - The Write Dir (created if it doesn't exist)
* - The Write Dir/appName (created if it doesn't exist)
* - The Base Dir (PHYSFS_getBaseDir())
* - The Base Dir/appName (if it exists)
* - All found CD-ROM dirs (optionally)
* - All found CD-ROM dirs/appName (optionally, and if they exist)
485
486
487
488
489
490
491
492
493
*
* These directories are then searched for files ending with the extension
* (archiveExt), which, if they are valid and supported archives, will also
* be added to the search path. If you specified "PKG" for (archiveExt), and
* there's a file named data.PKG in the base dir, it'll be checked. Archives
* can either be appended or prepended to the search path in alphabetical
* order, regardless of which directories they were found in.
*
* All of this can be accomplished from the application, but this just does it
494
* all for you. Feel free to add more to the search path manually, too.
495
496
497
498
499
500
501
*
* @param appName Program-specific name of your program, to separate it
* from other programs using PhysicsFS.
*
* @param archiveExt File extention used by your program to specify an
* archive. For example, Quake 3 uses "pk3", even though
* they are just zipfiles. Specify NULL to not dig out
502
503
504
* archives automatically. Do not specify the '.' char;
* If you want to look for ZIP files, specify "ZIP" and
* not ".ZIP" ... the archive search is case-insensitive.
505
506
*
* @param includeCdRoms Non-zero to include CD-ROMs in the search path, and
507
508
509
510
511
512
513
* (if (archiveExt) != NULL) search them for archives.
* This may cause a significant amount of blocking
* while discs are accessed, and if there are no discs
* in the drive (or even not mounted on Unix systems),
* then they may not be made available anyhow. You may
* want to specify zero and handle the disc setup
* yourself.
514
515
*
* @param archivesFirst Non-zero to prepend the archives to the search path.
516
* Zero to append them. Ignored if !(archiveExt).
517
518
* @return nonzero on success, zero on error. Specifics of the error can be
* gleaned from PHYSFS_getLastError().
519
*/
520
int PHYSFS_setSaneConfig(const char *appName, const char *archiveExt,
521
int includeCdRoms, int archivesFirst);
522
523
524
525
/**
* Create a directory. This is specified in platform-independent notation in
526
* relation to the write dir. All missing parent directories are also
527
528
* created if they don't exist.
*
529
* So if you've got the write dir set to "C:\mygame\writedir" and call
530
* PHYSFS_mkdir("downloads/maps") then the directories
531
* "C:\mygame\writedir\downloads" and "C:\mygame\writedir\downloads\maps"
532
533
534
* will be created if possible. If the creation of "maps" fails after we
* have successfully created "downloads", then the function leaves the
* created directory behind and reports failure.
535
*
536
* @param dirname New dir to create.
537
538
539
540
541
542
543
544
* @return nonzero on success, zero on error. Specifics of the error can be
* gleaned from PHYSFS_getLastError().
*/
int PHYSFS_mkdir(const char *dirName);
/**
* Delete a file or directory. This is specified in platform-independent
545
* notation in relation to the write dir.
546
*
547
* A directory must be empty before this call can delete it.
548
*
549
* So if you've got the write dir set to "C:\mygame\writedir" and call
550
* PHYSFS_delete("downloads/maps/level1.map") then the file
551
* "C:\mygame\writedir\downloads\maps\level1.map" is removed from the
552
553
554
* physical filesystem, if it exists and the operating system permits the
* deletion.
*
555
556
557
558
* Note that on Unix systems, deleting a file may be successful, but the
* actual file won't be removed until all processes that have an open
* filehandle to it (including your program) close their handles.
*
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
* @param filename Filename to delete.
* @return nonzero on success, zero on error. Specifics of the error can be
* gleaned from PHYSFS_getLastError().
*/
int PHYSFS_delete(const char *filename);
/**
* Figure out where in the search path a file resides. The file is specified
* in platform-independent notation. The returned filename will be the
* element of the search path where the file was found, which may be a
* directory, or an archive. Even if there are multiple matches in different
* parts of the search path, only the first one found is used, just like
* when opening a file.
*
* So, if you look for "maps/level1.map", and C:\mygame is in your search
575
* path and C:\mygame\maps\level1.map exists, then "C:\mygame" is returned.
576
*
577
578
579
* If a any part of a match is a symbolic link, and you've not explicitly
* permitted symlinks, then it will be ignored, and the search for a match
* will continue.
580
*
581
* @param filename file to look for.
582
583
584
* @return READ ONLY string of element of search path containing the
* the file in question. NULL if not found.
*/
585
const char *PHYSFS_getRealDir(const char *filename);
586
587
588
589
590
/**
* Get a file listing of a search path's directory. Matching directories are
591
* interpolated. That is, if "C:\mydir" is in the search path and contains a
592
* directory "savegames" that contains "x.sav", "y.sav", and "z.sav", and
593
* there is also a "C:\userdir" in the search path that has a "savegames"
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
* subdirectory with "w.sav", then the following code:
*
* ------------------------------------------------
* char **rc = PHYSFS_enumerateFiles("savegames");
* char **i;
*
* for (i = rc; *i != NULL; i++)
* printf("We've got [%s].\n", *i);
*
* PHYSFS_freeList(rc);
* ------------------------------------------------
*
* ...will print:
*
* ------------------------------------------------
* We've got [x.sav].
* We've got [y.sav].
* We've got [z.sav].
* We've got [w.sav].
* ------------------------------------------------
*
615
616
617
* Feel free to sort the list however you like. We only promise there will
* be no duplicates, but not what order the final list will come back in.
*
618
619
620
* Don't forget to call PHYSFS_freeList() with the return value from this
* function when you are done with it.
*
621
* @param dir directory in platform-independent notation to enumerate.
622
* @return Null-terminated array of null-terminated strings.
623
*/
624
char **PHYSFS_enumerateFiles(const char *dir);
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
/**
* Determine if there is an entry anywhere in the search path by the
* name of (fname).
*
* Note that entries that are symlinks are ignored if
* PHYSFS_permitSymbolicLinks(1) hasn't been called, so you
* might end up further down in the search path than expected.
*
* @param fname filename in platform-independent notation.
* @return non-zero if filename exists. zero otherwise.
*/
int PHYSFS_exists(const char *fname);
/**
* Determine if the first occurence of (fname) in the search path is
* really a directory entry.
*
* Note that entries that are symlinks are ignored if
* PHYSFS_permitSymbolicLinks(1) hasn't been called, so you
* might end up further down in the search path than expected.
*
* @param fname filename in platform-independent notation.
* @return non-zero if filename exists and is a directory. zero otherwise.
*/
int PHYSFS_isDirectory(const char *fname);
/**
* Determine if the first occurence of (fname) in the search path is
* really a symbolic link.
*
* Note that entries that are symlinks are ignored if
* PHYSFS_permitSymbolicLinks(1) hasn't been called, and as such,
* this function will always return 0 in that case.
*
* @param fname filename in platform-independent notation.
* @return non-zero if filename exists and is a symlink. zero otherwise.
*/
int PHYSFS_isSymbolicLink(const char *fname);
669
670
/**
* Open a file for writing, in platform-independent notation and in relation
671
* to the write dir as the root of the writable filesystem. The specified
672
673
674
* file is created if it doesn't exist. If it does exist, it is truncated to
* zero bytes, and the writing offset is set to the start.
*
675
676
677
678
* Note that entries that are symlinks are ignored if
* PHYSFS_permitSymbolicLinks(1) hasn't been called, and opening a
* symlink with this function will fail in such a case.
*
679
680
681
682
* @param filename File to open.
* @return A valid PhysicsFS filehandle on success, NULL on error. Specifics
* of the error can be gleaned from PHYSFS_getLastError().
*/
683
PHYSFS_file *PHYSFS_openWrite(const char *filename);
684
685
686
687
/**
* Open a file for writing, in platform-independent notation and in relation
688
* to the write dir as the root of the writable filesystem. The specified
689
690
691
692
* file is created if it doesn't exist. If it does exist, the writing offset
* is set to the end of the file, so the first write will be the byte after
* the end.
*
693
694
695
696
* Note that entries that are symlinks are ignored if
* PHYSFS_permitSymbolicLinks(1) hasn't been called, and opening a
* symlink with this function will fail in such a case.
*
697
698
699
700
* @param filename File to open.
* @return A valid PhysicsFS filehandle on success, NULL on error. Specifics
* of the error can be gleaned from PHYSFS_getLastError().
*/
701
PHYSFS_file *PHYSFS_openAppend(const char *filename);
702
703
704
705
706
707
708
709
/**
* Open a file for reading, in platform-independent notation. The search path
* is checked one at a time until a matching file is found, in which case an
* abstract filehandle is associated with it, and reading may be done.
* The reading offset is set to the first byte of the file.
*
710
711
712
713
* Note that entries that are symlinks are ignored if
* PHYSFS_permitSymbolicLinks(1) hasn't been called, and opening a
* symlink with this function will fail in such a case.
*
714
715
716
717
* @param filename File to open.
* @return A valid PhysicsFS filehandle on success, NULL on error. Specifics
* of the error can be gleaned from PHYSFS_getLastError().
*/
718
PHYSFS_file *PHYSFS_openRead(const char *filename);
719
720
721
722
723
724
725
726
727
728
729
730
731
732
/**
* Close a PhysicsFS filehandle. This call is capable of failing if the
* operating system was buffering writes to this file, and (now forced to
* write those changes to physical media) can not store the data for any
* reason. In such a case, the filehandle stays open. A well-written program
* should ALWAYS check the return value from the close call in addition to
* every writing call!
*
* @param handle handle returned from PHYSFS_open*().
* @return nonzero on success, zero on error. Specifics of the error can be
* gleaned from PHYSFS_getLastError().
*/
733
int PHYSFS_close(PHYSFS_file *handle);
734
735
736
737
738
739
740
741
742
743
/**
* Read data from a PhysicsFS filehandle. The file must be opened for reading.
*
* @param handle handle returned from PHYSFS_openRead().
* @param buffer buffer to store read data into.
* @param objSize size in bytes of objects being read from (handle).
* @param objCount number of (objSize) objects to read from (handle).
* @return number of objects read. PHYSFS_getLastError() can shed light on
744
* the reason this might be < (objCount), as can PHYSFS_eof().
745
* -1 if complete failure.
746
*/
747
748
int PHYSFS_read(PHYSFS_file *handle, void *buffer,
unsigned int objSize, unsigned int objCount);
749
750
751
752
753
754
755
756
757
/**
* Write data to a PhysicsFS filehandle. The file must be opened for writing.
*
* @param handle retval from PHYSFS_openWrite() or PHYSFS_openAppend().
* @param buffer buffer to store read data into.
* @param objSize size in bytes of objects being read from (handle).
* @param objCount number of (objSize) objects to read from (handle).
758
759
* @return number of objects written. PHYSFS_getLastError() can shed light on
* the reason this might be < (objCount). -1 if complete failure.
760
*/
761
762
int PHYSFS_write(PHYSFS_file *handle, void *buffer,
unsigned int objSize, unsigned int objCount);
763
764
765
766
767
768
769
770
/**
* Determine if the end of file has been reached in a PhysicsFS filehandle.
*
* @param handle handle returned from PHYSFS_openRead().
* @return nonzero if EOF, zero if not.
*/
771
int PHYSFS_eof(PHYSFS_file *handle);
772
773
774
775
776
777
778
779
780
/**
* Determine current position within a PhysicsFS filehandle.
*
* @param handle handle returned from PHYSFS_open*().
* @return offset in bytes from start of file. -1 if error occurred.
* Specifics of the error can be gleaned from PHYSFS_getLastError().
*/
781
int PHYSFS_tell(PHYSFS_file *handle);
782
783
784
785
786
787
788
789
790
791
792
793
/**
* Seek to a new position within a PhysicsFS filehandle. The next read or write
* will occur at that place. Seeking past the beginning or end of the file is
* not allowed.
*
* @param handle handle returned from PHYSFS_open*().
* @param pos number of bytes from start of file to seek to.
* @return nonzero on success, zero on error. Specifics of the error can be
* gleaned from PHYSFS_getLastError().
*/
794
int PHYSFS_seek(PHYSFS_file *handle, int pos);
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
/**
* Get total length of a file in bytes. Note that if the file size can't
* be determined (since the archive is "streamed" or whatnot) than this
* with report (-1). Also note that if another process/thread is writing
* to this file at the same time, then the information this function
* supplies could be incorrect before you get it. Use with caution, or
* better yet, don't use at all.
*
* @param handle handle returned from PHYSFS_open*().
* @return size in bytes of the file. -1 if can't be determined.
*/
int PHYSFS_fileLength(PHYSFS_file *handle);
810
811
812
813
814
815
816
#ifdef __cplusplus
}
#endif
#endif /* !defined _INCLUDE_PHYSFS_H_ */
/* end of physfs.h ... */