/
physfs.h
1001 lines (886 loc) · 37.9 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
* PHYSFS_getBaseDir(), and PHYSFS_getUserDir() for info on what those
* are and how they can help you determine an optimal search path.
*
105
106
107
108
109
110
* PhysicsFS is mostly thread safe. The error messages returned by
* PHYSFS_getLastError are unique by thread, and library-state-setting
* functions are mutex'd. For efficiency, individual file accesses are
* not locked, so you can not safely read/write/seek/close/etc the same
* file from two threads at the same time. Other race conditions are bugs
* that should be reported/patched.
111
112
113
*
* 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
114
* filehandles with PhysicsFS and vice versa.
115
116
*
* Note that archives need not be named as such: if you have a ZIP file and
117
* rename it with a .PKG extension, the file will still be recognized as a
118
119
120
121
122
123
124
125
126
127
128
129
130
131
* 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_
132
133
134
135
#ifdef _WIN32
#include <windows.h>
#endif
136
137
138
139
#ifdef __cplusplus
extern "C" {
#endif
140
141
142
143
144
145
#if (defined _MSC_VER)
#define __EXPORT__ __declspec(dllexport)
#else
#define __EXPORT__
#endif
146
147
148
149
150
151
152
153
154
155
156
157
/* !!! FIXME: This is not universal. */
typedef unsigned char PHYSFS_uint8;
typedef signed char PHYSFS_sint8;
typedef unsigned short PHYSFS_uint16;
typedef signed short PHYSFS_sint16;
typedef unsigned int PHYSFS_uint32;
typedef signed int PHYSFS_sint32;
#ifdef PHYSFS_NO_64BIT_SUPPORT /* oh well. */
typedef PHYSFS_uint32 PHYSFS_uint64;
typedef PHYSFS_sint32 PHYSFS_sint64;
158
159
160
161
#elif _WIN32
/*!!! No 64-bit unsigned in Win32???? */
typedef LONGLONG PHYSFS_sint64;
typedef LONGLONG PHYSFS_uint64;
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
#else
typedef unsigned long long PHYSFS_uint64;
typedef signed long long PHYSFS_sint64;
#endif
/* Make sure the types really have the right sizes */
#define PHYSFS_COMPILE_TIME_ASSERT(name, x) \
typedef int PHYSFS_dummy_ ## name[(x) * 2 - 1]
PHYSFS_COMPILE_TIME_ASSERT(uint8, sizeof(PHYSFS_uint8) == 1);
PHYSFS_COMPILE_TIME_ASSERT(sint8, sizeof(PHYSFS_sint8) == 1);
PHYSFS_COMPILE_TIME_ASSERT(uint16, sizeof(PHYSFS_uint16) == 2);
PHYSFS_COMPILE_TIME_ASSERT(sint16, sizeof(PHYSFS_sint16) == 2);
PHYSFS_COMPILE_TIME_ASSERT(uint32, sizeof(PHYSFS_uint32) == 4);
PHYSFS_COMPILE_TIME_ASSERT(sint32, sizeof(PHYSFS_sint32) == 4);
#ifndef PHYSFS_NO_64BIT_SUPPORT
PHYSFS_COMPILE_TIME_ASSERT(uint64, sizeof(PHYSFS_uint64) == 8);
PHYSFS_COMPILE_TIME_ASSERT(sint64, sizeof(PHYSFS_sint64) == 8);
#endif
#undef PHYSFS_COMPILE_TIME_ASSERT
187
188
typedef struct __PHYSFS_FILE__
{
189
void *opaque;
190
191
192
193
194
195
} PHYSFS_file;
typedef struct __PHYSFS_ARCHIVEINFO__
{
const char *extension;
const char *description;
196
197
const char *author;
const char *url;
198
199
200
} PHYSFS_ArchiveInfo;
201
202
/* functions... */
203
204
typedef struct __PHYSFS_VERSION__
{
205
206
207
PHYSFS_uint8 major;
PHYSFS_uint8 minor;
PHYSFS_uint8 patch;
208
209
210
211
} PHYSFS_Version;
#define PHYSFS_VER_MAJOR 0
#define PHYSFS_VER_MINOR 1
212
#define PHYSFS_VER_PATCH 4
213
214
#define PHYSFS_VERSION(x) { \
215
216
217
(x)->major = PHYSFS_VER_MAJOR; \
(x)->minor = PHYSFS_VER_MINOR; \
(x)->patch = PHYSFS_VER_PATCH; \
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
}
/**
* 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().
*/
240
__EXPORT__ void PHYSFS_getLinkedVersion(PHYSFS_Version *ver);
241
242
243
244
/**
* Initialize PhysicsFS. This must be called before any other PhysicsFS
245
* function.
246
*
247
248
249
* This should be called prior to any attempts to change your process's
* current working directory.
*
250
251
252
253
* @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().
*/
254
__EXPORT__ int PHYSFS_init(const char *argv0);
255
256
257
258
/**
* Shutdown PhysicsFS. This closes any files opened via PhysicsFS, blanks the
259
* search/write paths, frees memory, and invalidates all of your handles.
260
*
261
262
263
264
265
266
* 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.
267
*
268
269
270
* Once successfully deinitialized, PHYSFS_init() can be called again to
* restart the subsystem. All defaults API states are restored at this
* point.
271
*
272
273
274
275
* @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.
*/
276
__EXPORT__ int PHYSFS_deinit(void);
277
278
279
280
281
282
283
284
285
/**
* 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.
*
286
287
* The returned value is an array of pointers to PHYSFS_ArchiveInfo structures,
* with a NULL entry to signify the end of the list:
288
289
290
291
292
293
294
295
296
297
298
299
300
301
*
* 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.
*/
302
__EXPORT__ const PHYSFS_ArchiveInfo **PHYSFS_supportedArchiveTypes(void);
303
304
305
306
307
308
309
310
/**
* 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.
*/
311
__EXPORT__ void PHYSFS_freeList(void *listVar);
312
313
314
315
316
/**
* 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
317
318
319
320
321
* 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().
322
323
324
*
* @return READ ONLY string of last error message.
*/
325
__EXPORT__ const char *PHYSFS_getLastError(void);
326
327
328
/**
329
* Get a platform-dependent dir separator. This is "\\" on win32, "/" on Unix,
330
331
332
* 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
333
* dirs always use '/' (platform-independent notation) to separate
334
335
* directories. This is also handy for getting platform-independent access
* when using stdio calls.
336
*
337
* @return READ ONLY null-terminated string of platform's dir separator.
338
*/
339
__EXPORT__ const char *PHYSFS_getDirSeparator(void);
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
/**
* 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.
*
358
359
360
361
* Symlinks are only explicitly checked when dealing with filenames
* in platform-independent notation. That is, when setting up your
* search and write paths, etc, symlinks are never checked for.
*
362
363
364
365
366
* 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.
*/
367
__EXPORT__ void PHYSFS_permitSymbolicLinks(int allow);
368
369
370
/**
371
* Get an array of dirs to available CD-ROM drives.
372
*
373
374
* 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
375
376
377
378
379
380
381
382
383
* 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:
*
384
* char **cds = PHYSFS_getCdRomDirs();
385
386
* char **i;
*
387
* for (i = cds; *i != NULL; i++)
388
* printf("cdrom dir [%s] is available.\n", *i);
389
*
390
391
* PHYSFS_freeList(cds);
*
392
393
* This call may block while drives spin up. Be forewarned.
*
394
395
396
397
* 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.
398
*/
399
__EXPORT__ char **PHYSFS_getCdRomDirs(void);
400
401
402
403
404
/**
* Helper function.
*
405
* Get the "base dir". This is the directory where the application was run
406
407
* from, which is probably the installation directory, and may or may not
* be the process's current working directory.
408
*
409
* You should probably use the base dir in your search path.
410
*
411
* @return READ ONLY string of base dir in platform-dependent notation.
412
*/
413
__EXPORT__ const char *PHYSFS_getBaseDir(void);
414
415
416
417
418
/**
* Helper function.
*
419
* Get the "user dir". This is meant to be a suggestion of where a specific
420
* user of the system can store files. On Unix, this is her home directory.
421
* On systems with no concept of multiple home directories (MacOS, win95),
422
* this will default to something like "C:\mybasedir\users\username"
423
424
* where "username" will either be the login name, or "default" if the
* platform doesn't support multiple users, either.
425
*
426
* You should probably use the user dir as the basis for your write dir, and
427
428
* also put it near the beginning of your search path.
*
429
* @return READ ONLY string of user dir in platform-dependent notation.
430
*/
431
__EXPORT__ const char *PHYSFS_getUserDir(void);
432
433
434
/**
435
* Get the current write dir. The default write dir is NULL.
436
*
437
* @return READ ONLY string of write dir in platform-dependent notation,
438
439
* OR NULL IF NO WRITE PATH IS CURRENTLY SET.
*/
440
__EXPORT__ const char *PHYSFS_getWriteDir(void);
441
442
443
/**
444
* Set a new write dir. This will override the previous setting. If the
445
446
447
* directory or a parent directory doesn't exist in the physical filesystem,
* PhysicsFS will attempt to create them as needed.
*
448
449
* This call will fail (and fail to change the write dir) if the current
* write dir still has files open in it.
450
*
451
* @param newDir The new directory to be the root of the write dir,
452
* specified in platform-dependent notation. Setting to NULL
453
* disables the write dir, so no files can be opened for
454
455
456
457
458
459
* 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().
*
*/
460
__EXPORT__ int PHYSFS_setWriteDir(const char *newDir);
461
462
463
464
465
466
/**
* 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.
*
467
* @param newDir directory or archive to add to the path, in
468
469
* platform-dependent notation.
* @param appendToPath nonzero to append to search path, zero to prepend.
470
* @return nonzero if added to path, zero on failure (bogus archive, dir
471
472
473
* missing, etc). Specifics of the error can be
* gleaned from PHYSFS_getLastError().
*/
474
__EXPORT__ int PHYSFS_addToSearchPath(const char *newDir, int appendToPath);
475
476
477
/**
478
* Remove a directory or archive from the search path.
479
480
481
482
483
484
485
*
* 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.
*
486
* @param oldDir dir/archive to remove.
487
488
489
* @return nonzero on success, zero on failure.
* Specifics of the error can be gleaned from PHYSFS_getLastError().
*/
490
__EXPORT__ int PHYSFS_removeFromSearchPath(const char *oldDir);
491
492
493
494
495
496
497
498
499
500
501
502
503
/**
* 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);
*
504
505
* When you are done with the returned information, you may dispose of the
* resources by calling PHYSFS_freeList() with the returned pointer.
506
*
507
508
* @return Null-terminated array of null-terminated strings. NULL if there
* was a problem (read: OUT OF MEMORY).
509
*/
510
__EXPORT__ char **PHYSFS_getSearchPath(void);
511
512
513
514
515
/**
* Helper function.
*
516
* Set up sane, default paths. The write dir will be set to
517
* "userdir/.organization/appName", which is created if it doesn't exist.
518
519
520
521
522
523
524
*
* 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:
*
525
526
527
* - The Write Dir (created if it doesn't exist)
* - The Base Dir (PHYSFS_getBaseDir())
* - All found CD-ROM dirs (optionally)
528
529
530
531
532
533
534
535
536
*
* 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
537
* all for you. Feel free to add more to the search path manually, too.
538
*
539
540
541
* @param organization Name of your company/group/etc to be used as a
* dirname, so keep it small, and no-frills.
*
542
543
544
545
546
547
* @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
548
549
550
* 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.
551
552
*
* @param includeCdRoms Non-zero to include CD-ROMs in the search path, and
553
554
555
556
557
558
559
* (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.
560
561
*
* @param archivesFirst Non-zero to prepend the archives to the search path.
562
* Zero to append them. Ignored if !(archiveExt).
563
*
564
565
* @return nonzero on success, zero on error. Specifics of the error can be
* gleaned from PHYSFS_getLastError().
566
*/
567
568
__EXPORT__ int PHYSFS_setSaneConfig(const char *organization,
const char *appName,
569
570
571
const char *archiveExt,
int includeCdRoms,
int archivesFirst);
572
573
574
575
/**
* Create a directory. This is specified in platform-independent notation in
576
* relation to the write dir. All missing parent directories are also
577
578
* created if they don't exist.
*
579
* So if you've got the write dir set to "C:\mygame\writedir" and call
580
* PHYSFS_mkdir("downloads/maps") then the directories
581
* "C:\mygame\writedir\downloads" and "C:\mygame\writedir\downloads\maps"
582
583
584
* 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.
585
*
586
* @param dirname New dir to create.
587
588
589
* @return nonzero on success, zero on error. Specifics of the error can be
* gleaned from PHYSFS_getLastError().
*/
590
__EXPORT__ int PHYSFS_mkdir(const char *dirName);
591
592
593
594
/**
* Delete a file or directory. This is specified in platform-independent
595
* notation in relation to the write dir.
596
*
597
* A directory must be empty before this call can delete it.
598
*
599
600
601
* Deleting a symlink will remove the link, not what it points to, regardless
* of whether you "permitSymLinks" or not.
*
602
* So if you've got the write dir set to "C:\mygame\writedir" and call
603
* PHYSFS_delete("downloads/maps/level1.map") then the file
604
* "C:\mygame\writedir\downloads\maps\level1.map" is removed from the
605
606
607
* physical filesystem, if it exists and the operating system permits the
* deletion.
*
608
609
610
611
* 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.
*
612
613
614
615
* Chances are, the bits that make up the file still exist, they are just
* made available to be written over at a later point. Don't consider this
* a security method or anything. :)
*
616
617
618
619
* @param filename Filename to delete.
* @return nonzero on success, zero on error. Specifics of the error can be
* gleaned from PHYSFS_getLastError().
*/
620
__EXPORT__ int PHYSFS_delete(const char *filename);
621
622
623
624
625
626
627
628
629
630
631
/**
* 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
632
* path and C:\mygame\maps\level1.map exists, then "C:\mygame" is returned.
633
*
634
635
636
* 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.
637
*
638
* @param filename file to look for.
639
640
641
* @return READ ONLY string of element of search path containing the
* the file in question. NULL if not found.
*/
642
__EXPORT__ const char *PHYSFS_getRealDir(const char *filename);
643
644
645
646
647
/**
* Get a file listing of a search path's directory. Matching directories are
648
* interpolated. That is, if "C:\mydir" is in the search path and contains a
649
* directory "savegames" that contains "x.sav", "y.sav", and "z.sav", and
650
* there is also a "C:\userdir" in the search path that has a "savegames"
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
* 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].
* ------------------------------------------------
*
672
673
674
* 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.
*
675
676
677
* Don't forget to call PHYSFS_freeList() with the return value from this
* function when you are done with it.
*
678
* @param dir directory in platform-independent notation to enumerate.
679
* @return Null-terminated array of null-terminated strings.
680
*/
681
__EXPORT__ char **PHYSFS_enumerateFiles(const char *dir);
682
683
684
685
686
687
688
689
690
691
692
693
694
/**
* 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.
*/
695
__EXPORT__ int PHYSFS_exists(const char *fname);
696
697
698
699
700
701
702
703
704
705
706
707
708
/**
* 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.
*/
709
__EXPORT__ int PHYSFS_isDirectory(const char *fname);
710
711
712
713
714
715
716
717
718
719
720
721
722
/**
* 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.
*/
723
__EXPORT__ int PHYSFS_isSymbolicLink(const char *fname);
724
725
726
727
/**
* Open a file for writing, in platform-independent notation and in relation
728
* to the write dir as the root of the writable filesystem. The specified
729
730
731
* 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.
*
732
733
734
735
* 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.
*
736
737
738
739
* @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().
*/
740
__EXPORT__ PHYSFS_file *PHYSFS_openWrite(const char *filename);
741
742
743
744
/**
* Open a file for writing, in platform-independent notation and in relation
745
* to the write dir as the root of the writable filesystem. The specified
746
747
748
749
* 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.
*
750
751
752
753
* 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.
*
754
755
756
757
* @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().
*/
758
__EXPORT__ PHYSFS_file *PHYSFS_openAppend(const char *filename);
759
760
761
762
763
764
765
766
/**
* 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.
*
767
768
769
770
* 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.
*
771
772
773
774
* @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().
*/
775
__EXPORT__ PHYSFS_file *PHYSFS_openRead(const char *filename);
776
777
778
779
780
781
782
783
784
785
786
787
788
789
/**
* 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().
*/
790
__EXPORT__ int PHYSFS_close(PHYSFS_file *handle);
791
792
793
794
795
796
797
798
799
800
/**
* 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
801
* the reason this might be < (objCount), as can PHYSFS_eof().
802
* -1 if complete failure.
803
*/
804
805
806
807
__EXPORT__ PHYSFS_sint64 PHYSFS_read(PHYSFS_file *handle,
void *buffer,
PHYSFS_uint32 objSize,
PHYSFS_uint32 objCount);
808
809
810
811
812
813
814
815
/**
* 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).
816
817
* @return number of objects written. PHYSFS_getLastError() can shed light on
* the reason this might be < (objCount). -1 if complete failure.
818
*/
819
820
821
822
__EXPORT__ PHYSFS_sint64 PHYSFS_write(PHYSFS_file *handle,
const void *buffer,
PHYSFS_uint32 objSize,
PHYSFS_uint32 objCount);
823
824
825
826
827
828
829
/**
* 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.
*/
830
__EXPORT__ int PHYSFS_eof(PHYSFS_file *handle);
831
832
833
834
835
836
837
838
839
/**
* 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().
*/
840
__EXPORT__ PHYSFS_sint64 PHYSFS_tell(PHYSFS_file *handle);
841
842
843
844
845
846
847
848
849
850
851
852
/**
* 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().
*/
853
__EXPORT__ int PHYSFS_seek(PHYSFS_file *handle, PHYSFS_uint64 pos);
854
855
856
857
858
/**
* 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
859
* will report (-1). Also note that if another process/thread is writing
860
861
862
863
864
865
866
* 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.
*/
867
__EXPORT__ PHYSFS_sint64 PHYSFS_fileLength(PHYSFS_file *handle);
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
/* Byteorder stuff... */
/**
* Take a 16-bit signed value in littleendian format and convert it to
* the platform's native byte order.
*
* @param val value to convert
* @return converted value.
*/
__EXPORT__ PHYSFS_sint16 PHYSFS_swapSLE16(PHYSFS_sint16 val);
/**
* Take a 16-bit unsigned value in littleendian format and convert it to
* the platform's native byte order.
*
* @param val value to convert
* @return converted value.
*/
__EXPORT__ PHYSFS_uint16 PHYSFS_swapULE16(PHYSFS_uint16 val);
/**
* Take a 32-bit signed value in littleendian format and convert it to
* the platform's native byte order.
*
* @param val value to convert
* @return converted value.
*/
__EXPORT__ PHYSFS_sint32 PHYSFS_swapSLE32(PHYSFS_sint32 val);
/**
* Take a 32-bit unsigned value in littleendian format and convert it to
* the platform's native byte order.
*
* @param val value to convert
* @return converted value.
*/
__EXPORT__ PHYSFS_uint32 PHYSFS_swapULE32(PHYSFS_uint32 val);
/**
* Take a 64-bit signed value in littleendian format and convert it to
* the platform's native byte order.
*
* @param val value to convert
* @return converted value.
*/
__EXPORT__ PHYSFS_sint64 PHYSFS_swapSLE64(PHYSFS_sint64 val);
/**
* Take a 64-bit unsigned value in littleendian format and convert it to
* the platform's native byte order.
*
* @param val value to convert
* @return converted value.
*/
__EXPORT__ PHYSFS_uint64 PHYSFS_swapULE64(PHYSFS_uint64 val);
/**
* Take a 16-bit signed value in bigendian format and convert it to
* the platform's native byte order.
*
* @param val value to convert
* @return converted value.
*/
__EXPORT__ PHYSFS_sint16 PHYSFS_swapSBE16(PHYSFS_sint16 val);
/**
* Take a 16-bit unsigned value in bigendian format and convert it to
* the platform's native byte order.
*
* @param val value to convert
* @return converted value.
*/
__EXPORT__ PHYSFS_uint16 PHYSFS_swapUBE16(PHYSFS_uint16 val);
/**
* Take a 32-bit signed value in bigendian format and convert it to
* the platform's native byte order.
*
* @param val value to convert
* @return converted value.
*/
__EXPORT__ PHYSFS_sint32 PHYSFS_swapSBE32(PHYSFS_sint32 val);
/**
* Take a 32-bit unsigned value in bigendian format and convert it to
* the platform's native byte order.
*
* @param val value to convert
* @return converted value.
*/
__EXPORT__ PHYSFS_uint32 PHYSFS_swapUBE32(PHYSFS_uint32 val);
/**
* Take a 64-bit signed value in bigendian format and convert it to
* the platform's native byte order.
*
* @param val value to convert
* @return converted value.
*/
__EXPORT__ PHYSFS_sint64 PHYSFS_swapSBE64(PHYSFS_sint64 val);
/**
* Take a 64-bit unsigned value in bigendian format and convert it to
* the platform's native byte order.
*
* @param val value to convert
* @return converted value.
*/
__EXPORT__ PHYSFS_uint64 PHYSFS_swapUBE64(PHYSFS_uint64 val);
990
991
992
993
#if 0 /* !!! FIXME: add this? */
#undef __EXPORT__
#endif
994
995
996
997
998
999
1000
#ifdef __cplusplus
}
#endif
#endif /* !defined _INCLUDE_PHYSFS_H_ */
/* end of physfs.h ... */