physfs.h
1
2
3
4
5
/**
* \file physfs.h
*
* Main header file for PhysicsFS.
*/
7
/**
8
9
10
11
12
* \mainpage PhysicsFS
*
* The latest version of PhysicsFS can be found at:
* http://icculus.org/physfs/
*
13
14
15
16
17
18
19
20
21
22
23
* 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
24
* fs_* cvars. If you've ever tinkered with these, then this API will be
25
26
* familiar to you.
*
27
28
29
30
31
32
* 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
33
* language from piddling over c:\\config.sys, for example. If you'd rather
34
35
* 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.
36
37
*
* Drive letters are hidden in PhysicsFS once you set up your initial paths.
38
* The search path creates a single, hierarchical directory structure.
39
40
41
42
43
44
45
* 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
46
* "C:\MyGame\MyConfigFiles\game.cfg", then you might set the write dir to
47
* "C:\MyGame" and then open "MyConfigFiles/game.cfg". This gives an
48
* abstraction across all platforms. Specifying a file in this way is termed
49
50
51
52
53
54
55
56
* "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,
57
* which is the root of the writable filesystem. When opening a file for
58
* reading, PhysicsFS goes through the search path. This is NOT the
59
60
61
62
63
64
* 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.
*
65
* Once the search path is defined, you may open files for reading. If you've
66
67
* got the following search path defined (to use a win32 example again):
*
68
69
70
71
* - C:\\mygame
* - C:\\mygame\\myuserfiles
* - D:\\mygamescdromdatafiles
* - C:\\mygame\\installeddatafiles.zip
72
*
73
* Then a call to PHYSFS_openRead("textfiles/myfile.txt") (note the directory
74
75
* separator, lack of drive letter, and lack of dir separator at the start of
* the string; this is platform-independent notation) will check for
76
77
78
79
80
81
82
* C:\\mygame\\textfiles\\myfile.txt, then
* 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 a case-sensitive manner, so you should be careful to specify
* it correctly.
83
*
84
* Files opened through PhysicsFS may NOT contain "." or ".." or ":" as dir
85
86
87
88
89
90
91
* elements. Not only are these meaningless on MacOS Classic 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. For portability, there is no mechanism for
* creating new symlinks in PhysicsFS.
92
93
94
95
96
97
*
* 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.
98
99
100
*
* All files are opened in binary mode; there is no endline conversion for
* textfiles. Other than that, PhysicsFS has some convenience functions for
101
* platform-independence. There is a function to tell you the current
102
* platform's dir separator ("\\" on windows, "/" on Unix, ":" on MacOS),
103
104
105
* 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.
106
*
107
108
* 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
109
110
* 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
111
112
* use the base dir for both searching and writing. There is a helper
* function (PHYSFS_setSaneConfig()) that puts together a basic configuration
113
* for you, based on a few parameters. Also see the comments on
114
115
116
* PHYSFS_getBaseDir(), and PHYSFS_getUserDir() for info on what those
* are and how they can help you determine an optimal search path.
*
117
118
119
120
121
122
123
124
125
126
127
128
* PhysicsFS 2.0 adds the concept of "mounting" archives to arbitrary points
* in the search path. If a zipfile contains "maps/level.map" and you mount
* that archive at "mods/mymod", then you would have to open
* "mods/mymod/maps/level.map" to access the file, even though "mods/mymod"
* isn't actually specified in the .zip file. Unlike the Unix mentality of
* mounting a filesystem, "mods/mymod" doesn't actually have to exist when
* mounting the zipfile. It's a "virtual" directory. The mounting mechanism
* allows the developer to seperate archives in the tree and avoid trampling
* over files when added new archives, such as including mod support in a
* game...keeping external content on a tight leash in this manner can be of
* utmost importance to some applications.
*
129
130
131
132
133
134
* 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.
135
136
137
*
* 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
138
* filehandles with PhysicsFS and vice versa.
139
140
*
* Note that archives need not be named as such: if you have a ZIP file and
141
* rename it with a .PKG extension, the file will still be recognized as a
142
* ZIP archive by PhysicsFS; the file's contents are used to determine its
143
* type where possible.
144
145
146
*
* Currently supported archive types:
* - .ZIP (pkZip/WinZip/Info-ZIP compatible)
147
148
* - .7Z (7zip archives)
* - .ISO (ISO9660 files, CD-ROM images)
149
* - .GRP (Build Engine groupfile archives)
150
* - .PAK (Quake I/II archive format)
151
152
* - .HOG (Descent I/II HOG file archives)
* - .MVL (Descent II movielib archives)
153
* - .WAD (DOOM engine archives)
155
156
157
*
* String policy for PhysicsFS 2.0 and later:
*
158
159
160
161
162
* PhysicsFS 1.0 could only deal with null-terminated ASCII strings. All high
* ASCII chars resulted in undefined behaviour, and there was no Unicode
* support at all. PhysicsFS 2.0 supports Unicode without breaking binary
* compatibility with the 1.0 API by using UTF-8 encoding of all strings
* passed in and out of the library.
163
164
165
166
167
*
* All strings passed through PhysicsFS are in null-terminated UTF-8 format.
* This means that if all you care about is English (ASCII characters <= 127)
* then you just use regular C strings. If you care about Unicode (and you
* should!) then you need to figure out what your platform wants, needs, and
168
169
170
171
* offers. If you are on Windows before Win2000 and build with Unicode
* support, your TCHAR strings are two bytes per character (this is called
* "UCS-2 encoding"). Any modern Windows uses UTF-16, which is two bytes
* per character for most characters, but some characters are four. You
172
* should convert them to UTF-8 before handing them to PhysicsFS with
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
* PHYSFS_utf8FromUcs2() or PHYSFS_utf8FromUtf16(). If you're using Unix or
* Mac OS X, your wchar_t strings are four bytes per character ("UCS-4
* encoding"). Use PHYSFS_utf8FromUcs4(). Mac OS X can give you UTF-8
* directly from a CFString or NSString, and many Unixes generally give you C
* strings in UTF-8 format everywhere. If you have a single-byte high ASCII
* charset, like so-many European "codepages" you may be out of luck. We'll
* convert from "Latin1" to UTF-8 only, and never back to Latin1. If you're
* above ASCII 127, all bets are off: move to Unicode or use your platform's
* facilities. Passing a C string with high-ASCII data that isn't UTF-8
* encoded will NOT do what you expect!
*
* Naturally, there's also PHYSFS_utf8ToUcs2(), PHYSFS_utf8ToUtf16(), and
* PHYSFS_utf8ToUcs4() to get data back into a format you like. Behind the
* scenes, PhysicsFS will use Unicode where possible: the UTF-8 strings on
* Windows will be converted and used with the multibyte Windows APIs, for
* example.
189
190
191
192
*
* PhysicsFS offers basic encoding conversion support, but not a whole string
* library. Get your stuff into whatever format you can work with.
*
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
* Some platforms and archivers don't offer full Unicode support behind the
* scenes. For example, OS/2 only offers "codepages" and the filesystem
* itself doesn't support multibyte encodings. We make an earnest effort to
* convert to/from the current locale here, but all bets are off if
* you want to hand an arbitrary Japanese character through to these systems.
* Modern OSes (Mac OS X, Linux, Windows, PocketPC, etc) should all be fine.
* Many game-specific archivers are seriously unprepared for Unicode (the
* Descent HOG/MVL and Build Engine GRP archivers, for example, only offer a
* DOS 8.3 filename, for example). Nothing can be done for these, but they
* tend to be legacy formats for existing content that was all ASCII (and
* thus, valid UTF-8) anyhow. Other formats, like .ZIP, don't explicitly
* offer Unicode support, but unofficially expect filenames to be UTF-8
* encoded, and thus Just Work. Most everything does the right thing without
* bothering you, but it's good to be aware of these nuances in case they
* don't.
*
209
210
211
*
* Other stuff:
*
212
* Please see the file LICENSE.txt in the source's root directory for licensing
213
* and redistribution rights.
214
*
215
* Please see the file CREDITS.txt in the source's root directory for a more or
216
* less complete list of who's responsible for this.
217
*
218
* \author Ryan C. Gordon.
219
220
221
222
223
224
225
226
227
*/
#ifndef _INCLUDE_PHYSFS_H_
#define _INCLUDE_PHYSFS_H_
#ifdef __cplusplus
extern "C" {
#endif
228
229
#if defined(PHYSFS_DECL)
/* do nothing. */
230
231
#elif (defined SWIG)
#define PHYSFS_DECL extern
232
233
#elif (defined _MSC_VER)
#define PHYSFS_DECL __declspec(dllexport)
234
#elif (defined __SUNPRO_C)
235
#define PHYSFS_DECL __global
236
#elif ((__GNUC__ >= 3) && (!__EMX__) && (!sun))
237
#define PHYSFS_DECL __attribute__((visibility("default")))
239
#define PHYSFS_DECL
242
243
244
245
246
247
248
249
250
251
#if defined(PHYSFS_DEPRECATED)
/* do nothing. */
#elif (defined SWIG) /* ignore deprecated, since bindings use everything. */
#define PHYSFS_DEPRECATED
#elif (__GNUC__ >= 4) /* technically, this arrived in gcc 3.1, but oh well. */
#define PHYSFS_DEPRECATED __attribute__((deprecated))
#else
#define PHYSFS_DEPRECATED
#endif
252
253
254
255
256
257
258
259
260
261
262
263
#if 0 /* !!! FIXME: look into this later. */
#if defined(PHYSFS_CALL)
/* do nothing. */
#elif defined(__WIN32__) && !defined(__GNUC__)
#define PHYSFS_CALL __cdecl
#elif defined(__OS2__) /* use _System, so it works across all compilers. */
#define PHYSFS_CALL _System
#else
#define PHYSFS_CALL
#endif
#endif
264
265
266
267
/**
* \typedef PHYSFS_uint8
* \brief An unsigned, 8-bit integer type.
*/
268
typedef unsigned char PHYSFS_uint8;
269
270
271
272
273
/**
* \typedef PHYSFS_sint8
* \brief A signed, 8-bit integer type.
*/
274
typedef signed char PHYSFS_sint8;
275
276
277
278
279
/**
* \typedef PHYSFS_uint16
* \brief An unsigned, 16-bit integer type.
*/
280
typedef unsigned short PHYSFS_uint16;
281
282
283
284
285
/**
* \typedef PHYSFS_sint16
* \brief A signed, 16-bit integer type.
*/
286
typedef signed short PHYSFS_sint16;
287
288
289
290
291
/**
* \typedef PHYSFS_uint32
* \brief An unsigned, 32-bit integer type.
*/
292
typedef unsigned int PHYSFS_uint32;
293
294
295
296
297
/**
* \typedef PHYSFS_sint32
* \brief A signed, 32-bit integer type.
*/
298
299
typedef signed int PHYSFS_sint32;
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
/**
* \typedef PHYSFS_uint64
* \brief An unsigned, 64-bit integer type.
* \warning on platforms without any sort of 64-bit datatype, this is
* equivalent to PHYSFS_uint32!
*/
/**
* \typedef PHYSFS_sint64
* \brief A signed, 64-bit integer type.
* \warning on platforms without any sort of 64-bit datatype, this is
* equivalent to PHYSFS_sint32!
*/
315
#if (defined PHYSFS_NO_64BIT_SUPPORT) /* oh well. */
316
317
typedef PHYSFS_uint32 PHYSFS_uint64;
typedef PHYSFS_sint32 PHYSFS_sint64;
318
319
320
#elif (defined _MSC_VER)
typedef signed __int64 PHYSFS_sint64;
typedef unsigned __int64 PHYSFS_uint64;
321
322
323
324
325
#else
typedef unsigned long long PHYSFS_uint64;
typedef signed long long PHYSFS_sint64;
#endif
327
#ifndef SWIG
328
#ifndef DOXYGEN_SHOULD_IGNORE_THIS
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
/* 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
347
#endif /* DOXYGEN_SHOULD_IGNORE_THIS */
348
#endif /* SWIG */
352
* \struct PHYSFS_File
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
* \brief A PhysicsFS file handle.
*
* You get a pointer to one of these when you open a file for reading,
* writing, or appending via PhysicsFS.
*
* As you can see from the lack of meaningful fields, you should treat this
* as opaque data. Don't try to manipulate the file handle, just pass the
* pointer you got, unmolested, to various PhysicsFS APIs.
*
* \sa PHYSFS_openRead
* \sa PHYSFS_openWrite
* \sa PHYSFS_openAppend
* \sa PHYSFS_close
* \sa PHYSFS_read
* \sa PHYSFS_write
* \sa PHYSFS_seek
* \sa PHYSFS_tell
* \sa PHYSFS_eof
371
372
* \sa PHYSFS_setBuffer
* \sa PHYSFS_flush
374
typedef struct PHYSFS_File
376
void *opaque; /**< That's all you get. Don't touch. */
377
} PHYSFS_File;
379
380
381
382
383
384
385
386
387
388
389
390
391
/**
* \def PHYSFS_file
* \brief 1.0 API compatibility define.
*
* PHYSFS_file is identical to PHYSFS_File. This #define is here for backwards
* compatibility with the 1.0 API, which had an inconsistent capitalization
* convention in this case. New code should use PHYSFS_File, as this #define
* may go away someday.
*
* \sa PHYSFS_File
*/
#define PHYSFS_file PHYSFS_File
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
/**
* \struct PHYSFS_ArchiveInfo
* \brief Information on various PhysicsFS-supported archives.
*
* This structure gives you details on what sort of archives are supported
* by this implementation of PhysicsFS. Archives tend to be things like
* ZIP files and such.
*
* \warning Not all binaries are created equal! PhysicsFS can be built with
* or without support for various archives. You can check with
* PHYSFS_supportedArchiveTypes() to see if your archive type is
* supported.
*
* \sa PHYSFS_supportedArchiveTypes
*/
409
typedef struct PHYSFS_ArchiveInfo
410
411
412
413
414
415
{
const char *extension; /**< Archive file extension: "ZIP", for example. */
const char *description; /**< Human-readable archive description. */
const char *author; /**< Person who did support for this archive. */
const char *url; /**< URL related to this archive */
} PHYSFS_ArchiveInfo;
418
419
420
421
422
423
424
425
426
427
428
/**
* \struct PHYSFS_Version
* \brief Information the version of PhysicsFS in use.
*
* Represents the library's version as three levels: major revision
* (increments with massive changes, additions, and enhancements),
* minor revision (increments with backwards-compatible changes to the
* major revision), and patchlevel (increments with fixes to the minor
* revision).
*
* \sa PHYSFS_VERSION
429
* \sa PHYSFS_getLinkedVersion
431
typedef struct PHYSFS_Version
433
434
435
PHYSFS_uint8 major; /**< major revision */
PHYSFS_uint8 minor; /**< minor revision */
PHYSFS_uint8 patch; /**< patchlevel */
436
437
} PHYSFS_Version;
438
439
440
#ifndef SWIG /* not available from scripting languages. */
441
#ifndef DOXYGEN_SHOULD_IGNORE_THIS
442
#define PHYSFS_VER_MAJOR 2
443
#define PHYSFS_VER_MINOR 1
444
#define PHYSFS_VER_PATCH 0
445
446
#endif /* DOXYGEN_SHOULD_IGNORE_THIS */
447
448
449
/* PhysicsFS state stuff ... */
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
/**
* \def PHYSFS_VERSION(x)
* \brief Macro to determine PhysicsFS version program was compiled against.
*
* This macro fills in a PHYSFS_Version structure with the version of the
* library you compiled against. This is determined by what header the
* compiler uses. Note that if you dynamically linked the library, you might
* have a slightly newer or older version at runtime. That version can be
* determined with PHYSFS_getLinkedVersion(), which, unlike PHYSFS_VERSION,
* is not a macro.
*
* \param x A pointer to a PHYSFS_Version struct to initialize.
*
* \sa PHYSFS_Version
* \sa PHYSFS_getLinkedVersion
*/
#define PHYSFS_VERSION(x) \
{ \
(x)->major = PHYSFS_VER_MAJOR; \
(x)->minor = PHYSFS_VER_MINOR; \
(x)->patch = PHYSFS_VER_PATCH; \
}
473
474
#endif /* SWIG */
477
478
479
480
481
* \fn void PHYSFS_getLinkedVersion(PHYSFS_Version *ver)
* \brief 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.
482
483
484
485
*
* This is a real function; the macro PHYSFS_VERSION tells you what version
* of PhysFS you compiled against:
*
487
488
489
490
491
492
493
494
495
* 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);
496
* \endcode
497
498
*
* This function may be called safely at any time, even before PHYSFS_init().
499
500
*
* \sa PHYSFS_VERSION
502
PHYSFS_DECL void PHYSFS_getLinkedVersion(PHYSFS_Version *ver);
506
507
508
509
* \fn int PHYSFS_init(const char *argv0)
* \brief Initialize the PhysicsFS library.
*
* This must be called before any other PhysicsFS function.
511
512
513
* This should be called prior to any attempts to change your process's
* current working directory.
*
514
515
516
517
518
519
* \param argv0 the argv[0] string passed to your program's mainline.
* This may be NULL on most platforms (such as ones without a
* standard main() function), but you should always try to pass
* something in here. Unix-like systems such as Linux _need_ to
* pass argv[0] from main() in here.
* \return nonzero on success, zero on error. Specifics of the error can be
520
* gleaned from PHYSFS_getLastError().
521
522
*
* \sa PHYSFS_deinit
523
* \sa PHYSFS_isInit
525
PHYSFS_DECL int PHYSFS_init(const char *argv0);
529
530
531
532
533
* \fn int PHYSFS_deinit(void)
* \brief Deinitialize the PhysicsFS library.
*
* This closes any files opened via PhysicsFS, blanks the search/write paths,
* frees memory, and invalidates all of your file handles.
535
536
537
538
539
540
* 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.
542
* Once successfully deinitialized, PHYSFS_init() can be called again to
543
544
545
* restart the subsystem. All default API states are restored at this
* point, with the exception of any custom allocator you might have
* specified, which survives between initializations.
547
* \return nonzero on success, zero on error. Specifics of the error can be
548
549
* gleaned from PHYSFS_getLastError(). If failure, state of PhysFS is
* undefined, and probably badly screwed up.
550
551
*
* \sa PHYSFS_init
552
* \sa PHYSFS_isInit
554
PHYSFS_DECL int PHYSFS_deinit(void);
558
559
560
* \fn const PHYSFS_ArchiveInfo **PHYSFS_supportedArchiveTypes(void)
* \brief Get a list of supported archive types.
*
561
562
563
564
565
566
* 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.
*
567
568
* The returned value is an array of pointers to PHYSFS_ArchiveInfo structures,
* with a NULL entry to signify the end of the list:
571
572
573
574
575
* PHYSFS_ArchiveInfo **i;
*
* for (i = PHYSFS_supportedArchiveTypes(); *i != NULL; i++)
* {
* printf("Supported archive: [%s], which is [%s].\n",
576
* (*i)->extension, (*i)->description);
578
* \endcode
579
580
581
582
*
* The return values are pointers to static internal memory, and should
* be considered READ ONLY, and never freed.
*
583
* \return READ ONLY Null-terminated array of READ ONLY structures.
585
PHYSFS_DECL const PHYSFS_ArchiveInfo **PHYSFS_supportedArchiveTypes(void);
586
587
588
/**
589
590
591
* \fn void PHYSFS_freeList(void *listVar)
* \brief Deallocate resources of lists returned by PhysicsFS.
*
592
593
594
* Certain PhysicsFS functions return lists of information that are
* dynamically allocated. Use this function to free those resources.
*
595
596
597
* It is safe to pass a NULL here, but doing so will cause a crash in versions
* before PhysicsFS 2.1.0.
*
598
* \param listVar List of information specified as freeable by this function.
599
* Passing NULL is safe; it is a valid no-op.
600
601
602
603
*
* \sa PHYSFS_getCdRomDirs
* \sa PHYSFS_enumerateFiles
* \sa PHYSFS_getSearchPath
605
PHYSFS_DECL void PHYSFS_freeList(void *listVar);
608
/**
609
610
611
* \fn const char *PHYSFS_getLastError(void)
* \brief Get human-readable error information.
*
612
613
614
615
616
617
618
619
620
621
622
* Get the last PhysicsFS error message as a human-readable, null-terminated
* string. This will be NULL if there's been no error since the last call to
* this 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().
*
* It is not wise to expect a specific string of characters here, since the
* error message may be localized into an unfamiliar language. These strings
* are meant to be passed on directly to the user.
623
*
624
* \return READ ONLY string of last error message.
625
*/
626
PHYSFS_DECL const char *PHYSFS_getLastError(void);
627
628
629
/**
630
631
* \fn const char *PHYSFS_getDirSeparator(void)
* \brief Get platform-dependent dir separator string.
632
*
633
* This returns "\\" on win32, "/" on Unix, and ":" on MacOS. It may be more
634
635
636
637
638
639
640
* 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 dirs always use '/'
* (platform-independent notation) to separate directories. This is also
* handy for getting platform-independent access when using stdio calls.
*
* \return READ ONLY null-terminated string of platform's dir separator.
641
*/
642
PHYSFS_DECL const char *PHYSFS_getDirSeparator(void);
643
644
646
647
648
649
650
651
* \fn void PHYSFS_permitSymbolicLinks(int allow)
* \brief Enable or disable following of 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.
652
653
654
655
656
657
658
659
660
661
662
663
*
* 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.
*
664
665
666
667
* 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.
*
668
669
* Symbolic link permission can be enabled or disabled at any time after
* you've called PHYSFS_init(), and is disabled by default.
671
* \param allow nonzero to permit symlinks, zero to deny linking.
672
673
*
* \sa PHYSFS_symbolicLinksPermitted
675
PHYSFS_DECL void PHYSFS_permitSymbolicLinks(int allow);
678
/* !!! FIXME: const this? */
679
/**
680
681
* \fn char **PHYSFS_getCdRomDirs(void)
* \brief Get an array of paths to available CD-ROM drives.
682
*
683
684
* 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
685
686
687
688
* 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
689
690
691
692
693
694
* call to this function will reflect that change.
*
* This function refers to "CD-ROM" media, but it really means "inserted disc
* media," such as DVD-ROM, HD-DVD, CDRW, and Blu-Ray discs. It looks for
* filesystems, and as such won't report an audio CD, unless there's a
* mounted filesystem track on it.
695
696
697
698
*
* The returned value is an array of strings, with a NULL entry to signify the
* end of the list:
*
700
* char **cds = PHYSFS_getCdRomDirs();
701
702
* char **i;
*
703
* for (i = cds; *i != NULL; i++)
704
* printf("cdrom dir [%s] is available.\n", *i);
705
*
706
* PHYSFS_freeList(cds);
707
* \endcode
709
710
* This call may block while drives spin up. Be forewarned.
*
711
712
713
* When you are done with the returned information, you may dispose of the
* resources by calling PHYSFS_freeList() with the returned pointer.
*
714
* \return Null-terminated array of null-terminated strings.
715
716
*
* \sa PHYSFS_getCdRomDirsCallback
717
*/
718
PHYSFS_DECL char **PHYSFS_getCdRomDirs(void);
719
720
721
/**
722
723
724
* \fn const char *PHYSFS_getBaseDir(void)
* \brief Get the path where the application resides.
*
725
726
* Helper function.
*
727
* Get the "base dir". This is the directory where the application was run
728
729
* from, which is probably the installation directory, and may or may not
* be the process's current working directory.
730
*
731
* You should probably use the base dir in your search path.
732
*
733
734
735
* \return READ ONLY string of base dir in platform-dependent notation.
*
* \sa PHYSFS_getUserDir
736
*/
737
PHYSFS_DECL const char *PHYSFS_getBaseDir(void);
738
739
740
/**
741
742
743
* \fn const char *PHYSFS_getUserDir(void)
* \brief Get the path where user's home directory resides.
*
744
745
* Helper function.
*
746
* Get the "user dir". This is meant to be a suggestion of where a specific
747
* user of the system can store files. On Unix, this is her home directory.
748
* On systems with no concept of multiple home directories (MacOS, win95),
749
* this will default to something like "C:\mybasedir\users\username"
750
751
* where "username" will either be the login name, or "default" if the
* platform doesn't support multiple users, either.
752
*
753
* You should probably use the user dir as the basis for your write dir, and
754
755
* also put it near the beginning of your search path.
*
756
757
758
* \return READ ONLY string of user dir in platform-dependent notation.
*
* \sa PHYSFS_getBaseDir
759
*/
760
PHYSFS_DECL const char *PHYSFS_getUserDir(void);
761
762
763
/**
764
765
766
* \fn const char *PHYSFS_getWriteDir(void)
* \brief Get path where PhysicsFS will allow file writing.
*
767
* Get the current write dir. The default write dir is NULL.
768
*
769
* \return READ ONLY string of write dir in platform-dependent notation,
770
* OR NULL IF NO WRITE PATH IS CURRENTLY SET.
771
772
*
* \sa PHYSFS_setWriteDir
773
*/
774
PHYSFS_DECL const char *PHYSFS_getWriteDir(void);
775
776
777
/**
778
779
780
* \fn int PHYSFS_setWriteDir(const char *newDir)
* \brief Tell PhysicsFS where it may write files.
*
781
* Set a new write dir. This will override the previous setting.
782
*
783
784
* This call will fail (and fail to change the write dir) if the current
* write dir still has files open in it.
785
*
786
* \param newDir The new directory to be the root of the write dir,
787
* specified in platform-dependent notation. Setting to NULL
788
* disables the write dir, so no files can be opened for
789
* writing via PhysicsFS.
790
* \return non-zero on success, zero on failure. All attempts to open a file
791
792
793
* for writing via PhysicsFS will fail until this call succeeds.
* Specifics of the error can be gleaned from PHYSFS_getLastError().
*
794
* \sa PHYSFS_getWriteDir
795
*/
796
PHYSFS_DECL int PHYSFS_setWriteDir(const char *newDir);
797
798
799
800
801
802
/**
* \fn int PHYSFS_addToSearchPath(const char *newDir, int appendToPath)
* \brief Add an archive or directory to the search path.
*
803
804
805
806
807
808
809
810
* \deprecated As of PhysicsFS 2.0, use PHYSFS_mount() instead. This
* function just wraps it anyhow.
*
* This function is equivalent to:
*
* \code
* PHYSFS_mount(newDir, NULL, appendToPath);
* \endcode
812
813
814
* You must use this and not PHYSFS_mount if binary compatibility with
* PhysicsFS 1.0 is important (which it may not be for many people).
*
815
* \sa PHYSFS_mount
816
817
* \sa PHYSFS_removeFromSearchPath
* \sa PHYSFS_getSearchPath
818
*/
819
820
PHYSFS_DECL int PHYSFS_addToSearchPath(const char *newDir, int appendToPath)
PHYSFS_DEPRECATED;
821
822
/**
823
824
* \fn int PHYSFS_removeFromSearchPath(const char *oldDir)
* \brief Remove a directory or archive from the search path.
825
*
826
827
828
829
830
831
* \deprecated As of PhysicsFS 2.1, use PHYSFS_unmount() instead. This
* function just wraps it anyhow. There's no functional difference
* except the vocabulary changed from "adding to the search path"
* to "mounting" when that functionality was extended, and thus
* the preferred way to accomplish this function's work is now
* called "unmounting."
832
*
833
* This function is equivalent to:
834
*
835
836
837
838
839
840
* \code
* PHYSFS_unmount(oldDir);
* \endcode
*
* You must use this and not PHYSFS_unmount if binary compatibility with
* PhysicsFS 1.0 is important (which it may not be for many people).
841
842
843
*
* \sa PHYSFS_addToSearchPath
* \sa PHYSFS_getSearchPath
844
* \sa PHYSFS_unmount
845
*/
846
847
PHYSFS_DECL int PHYSFS_removeFromSearchPath(const char *oldDir)
PHYSFS_DEPRECATED;
848
849
850
/**
851
852
853
854
* \fn char **PHYSFS_getSearchPath(void)
* \brief Get the current search path.
*
* The default search path is an empty list.
855
856
857
858
*
* The returned value is an array of strings, with a NULL entry to signify the
* end of the list:
*
860
861
862
863
* char **i;
*
* for (i = PHYSFS_getSearchPath(); *i != NULL; i++)
* printf("[%s] is in the search path.\n", *i);
864
* \endcode
865
*
866
867
* When you are done with the returned information, you may dispose of the
* resources by calling PHYSFS_freeList() with the returned pointer.
868
*
869
* \return Null-terminated array of null-terminated strings. NULL if there
870
* was a problem (read: OUT OF MEMORY).
872
* \sa PHYSFS_getSearchPathCallback
873
874
* \sa PHYSFS_addToSearchPath
* \sa PHYSFS_removeFromSearchPath
875
*/
876
PHYSFS_DECL char **PHYSFS_getSearchPath(void);
877
878
879
/**
880
881
882
* \fn int PHYSFS_setSaneConfig(const char *organization, const char *appName, const char *archiveExt, int includeCdRoms, int archivesFirst)
* \brief Set up sane, default paths.
*
883
884
* Helper function.
*
885
886
* The write dir will be set to "userdir/.organization/appName", which is
* created if it doesn't exist.
887
888
889
890
891
892
893
*
* 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:
*
894
895
896
* - The Write Dir (created if it doesn't exist)
* - The Base Dir (PHYSFS_getBaseDir())
* - All found CD-ROM dirs (optionally)
897
898
899
900
901
902
903
904
905
*
* 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
906
* all for you. Feel free to add more to the search path manually, too.
907
*
908
* \param organization Name of your company/group/etc to be used as a
909
910
* dirname, so keep it small, and no-frills.
*
911
* \param appName Program-specific name of your program, to separate it
912
913
* from other programs using PhysicsFS.
*
914
* \param archiveExt File extension used by your program to specify an
915
916
* archive. For example, Quake 3 uses "pk3", even though
* they are just zipfiles. Specify NULL to not dig out
917
918
919
* 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.
920
*
921
* \param includeCdRoms Non-zero to include CD-ROMs in the search path, and
922
923
924
925
926
927
928
* (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.
929
*
930
* \param archivesFirst Non-zero to prepend the archives to the search path.
931
* Zero to append them. Ignored if !(archiveExt).
933
* \return nonzero on success, zero on error. Specifics of the error can be
934
* gleaned from PHYSFS_getLastError().
935
*/
936
937
938
939
940
PHYSFS_DECL int PHYSFS_setSaneConfig(const char *organization,
const char *appName,
const char *archiveExt,
int includeCdRoms,
int archivesFirst);
941
942
943
944
/* Directory management stuff ... */
945
/**
946
947
948
949
950
951
* \fn int PHYSFS_mkdir(const char *dirName)
* \brief Create a directory.
*
* This is specified in platform-independent notation in relation to the
* write dir. All missing parent directories are also created if they
* don't exist.
952
*
953
* So if you've got the write dir set to "C:\mygame\writedir" and call
954
* PHYSFS_mkdir("downloads/maps") then the directories
955
* "C:\mygame\writedir\downloads" and "C:\mygame\writedir\downloads\maps"
956
957
958
* 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.
959
*
960
961
* \param dirName New dir to create.
* \return nonzero on success, zero on error. Specifics of the error can be
962
* gleaned from PHYSFS_getLastError().
963
964
*
* \sa PHYSFS_delete
965
*/
966
PHYSFS_DECL int PHYSFS_mkdir(const char *dirName);
967
968
969
/**
970
971
972
973
974
* \fn int PHYSFS_delete(const char *filename)
* \brief Delete a file or directory.
*
* (filename) is specified in platform-independent notation in relation to the
* write dir.
975
*
976
* A directory must be empty before this call can delete it.
977
*
978
979
980
* Deleting a symlink will remove the link, not what it points to, regardless
* of whether you "permitSymLinks" or not.
*
981
* So if you've got the write dir set to "C:\mygame\writedir" and call
982
* PHYSFS_delete("downloads/maps/level1.map") then the file
983
* "C:\mygame\writedir\downloads\maps\level1.map" is removed from the
984
985
986
* physical filesystem, if it exists and the operating system permits the
* deletion.
*
987
988
989
990
* 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.
*
991
992
993
994
* 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. :)
*
995
996
* \param filename Filename to delete.
* \return nonzero on success, zero on error. Specifics of the error can be
997
998
* gleaned from PHYSFS_getLastError().
*/
999
PHYSFS_DECL int PHYSFS_delete(const char *filename);
1000