1 /**

     2  * \file physfs.h

     3  *

     4  * Main header file for PhysicsFS.

     5  */

     6 

     7 /**

     8  * \mainpage PhysicsFS

     9  *

    10  * The latest version of PhysicsFS can be found at:

    11  *     https://icculus.org/physfs/

    12  *

    13  * PhysicsFS; a portable, flexible file i/o abstraction.

    14  *

    15  * This API gives you access to a system file system in ways superior to the

    16  *  stdio or system i/o calls. The brief benefits:

    17  *

    18  *   - It's portable.

    19  *   - It's safe. No file access is permitted outside the specified dirs.

    20  *   - It's flexible. Archives (.ZIP files) can be used transparently as

    21  *      directory structures.

    22  *

    23  * With PhysicsFS, you have a single writing directory and multiple

    24  *  directories (the "search path") for reading. You can think of this as a

    25  *  filesystem within a filesystem. If (on Windows) you were to set the

    26  *  writing directory to "C:\MyGame\MyWritingDirectory", then no PHYSFS calls

    27  *  could touch anything above this directory, including the "C:\MyGame" and

    28  *  "C:\" directories. This prevents an application's internal scripting

    29  *  language from piddling over c:\\config.sys, for example. If you'd rather

    30  *  give PHYSFS full access to the system's REAL file system, set the writing

    31  *  dir to "C:\", but that's generally A Bad Thing for several reasons.

    32  *

    33  * Drive letters are hidden in PhysicsFS once you set up your initial paths.

    34  *  The search path creates a single, hierarchical directory structure.

    35  *  Not only does this lend itself well to general abstraction with archives,

    36  *  it also gives better support to operating systems like MacOS and Unix.

    37  *  Generally speaking, you shouldn't ever hardcode a drive letter; not only

    38  *  does this hurt portability to non-Microsoft OSes, but it limits your win32

    39  *  users to a single drive, too. Use the PhysicsFS abstraction functions and

    40  *  allow user-defined configuration options, too. When opening a file, you

    41  *  specify it like it was on a Unix filesystem: if you want to write to

    42  *  "C:\MyGame\MyConfigFiles\game.cfg", then you might set the write dir to

    43  *  "C:\MyGame" and then open "MyConfigFiles/game.cfg". This gives an

    44  *  abstraction across all platforms. Specifying a file in this way is termed

    45  *  "platform-independent notation" in this documentation. Specifying a

    46  *  a filename in a form such as "C:\mydir\myfile" or

    47  *  "MacOS hard drive:My Directory:My File" is termed "platform-dependent

    48  *  notation". The only time you use platform-dependent notation is when

    49  *  setting up your write directory and search path; after that, all file

    50  *  access into those directories are done with platform-independent notation.

    51  *

    52  * All files opened for writing are opened in relation to the write directory,

    53  *  which is the root of the writable filesystem. When opening a file for

    54  *  reading, PhysicsFS goes through the search path. This is NOT the

    55  *  same thing as the PATH environment variable. An application using

    56  *  PhysicsFS specifies directories to be searched which may be actual

    57  *  directories, or archive files that contain files and subdirectories of

    58  *  their own. See the end of these docs for currently supported archive

    59  *  formats.

    60  *

    61  * Once the search path is defined, you may open files for reading. If you've

    62  *  got the following search path defined (to use a win32 example again):

    63  *

    64  *  - C:\\mygame

    65  *  - C:\\mygame\\myuserfiles

    66  *  - D:\\mygamescdromdatafiles

    67  *  - C:\\mygame\\installeddatafiles.zip

    68  *

    69  * Then a call to PHYSFS_openRead("textfiles/myfile.txt") (note the directory

    70  *  separator, lack of drive letter, and lack of dir separator at the start of

    71  *  the string; this is platform-independent notation) will check for

    72  *  C:\\mygame\\textfiles\\myfile.txt, then

    73  *  C:\\mygame\\myuserfiles\\textfiles\\myfile.txt, then

    74  *  D:\\mygamescdromdatafiles\\textfiles\\myfile.txt, then, finally, for

    75  *  textfiles\\myfile.txt inside of C:\\mygame\\installeddatafiles.zip.

    76  *  Remember that most archive types and platform filesystems store their

    77  *  filenames in a case-sensitive manner, so you should be careful to specify

    78  *  it correctly.

    79  *

    80  * Files opened through PhysicsFS may NOT contain "." or ".." or ":" as dir

    81  *  elements. Not only are these meaningless on MacOS Classic and/or Unix,

    82  *  they are a security hole. Also, symbolic links (which can be found in

    83  *  some archive types and directly in the filesystem on Unix platforms) are

    84  *  NOT followed until you call PHYSFS_permitSymbolicLinks(). That's left to

    85  *  your own discretion, as following a symlink can allow for access outside

    86  *  the write dir and search paths. For portability, there is no mechanism for

    87  *  creating new symlinks in PhysicsFS.

    88  *

    89  * The write dir is not included in the search path unless you specifically

    90  *  add it. While you CAN change the write dir as many times as you like,

    91  *  you should probably set it once and stick to it. Remember that your

    92  *  program will not have permission to write in every directory on Unix and

    93  *  NT systems.

    94  *

    95  * All files are opened in binary mode; there is no endline conversion for

    96  *  textfiles. Other than that, PhysicsFS has some convenience functions for

    97  *  platform-independence. There is a function to tell you the current

    98  *  platform's dir separator ("\\" on windows, "/" on Unix, ":" on MacOS),

    99  *  which is needed only to set up your search/write paths. There is a

   100  *  function to tell you what CD-ROM drives contain accessible discs, and a

   101  *  function to recommend a good search path, etc.

   102  *

   103  * A recommended order for the search path is the write dir, then the base dir,

   104  *  then the cdrom dir, then any archives discovered. Quake 3 does something

   105  *  like this, but moves the archives to the start of the search path. Build

   106  *  Engine games, like Duke Nukem 3D and Blood, place the archives last, and

   107  *  use the base dir for both searching and writing. There is a helper

   108  *  function (PHYSFS_setSaneConfig()) that puts together a basic configuration

   109  *  for you, based on a few parameters. Also see the comments on

   110  *  PHYSFS_getBaseDir(), and PHYSFS_getPrefDir() for info on what those

   111  *  are and how they can help you determine an optimal search path.

   112  *

   113  * PhysicsFS 2.0 adds the concept of "mounting" archives to arbitrary points

   114  *  in the search path. If a zipfile contains "maps/level.map" and you mount

   115  *  that archive at "mods/mymod", then you would have to open

   116  *  "mods/mymod/maps/level.map" to access the file, even though "mods/mymod"

   117  *  isn't actually specified in the .zip file. Unlike the Unix mentality of

   118  *  mounting a filesystem, "mods/mymod" doesn't actually have to exist when

   119  *  mounting the zipfile. It's a "virtual" directory. The mounting mechanism

   120  *  allows the developer to seperate archives in the tree and avoid trampling

   121  *  over files when added new archives, such as including mod support in a

   122  *  game...keeping external content on a tight leash in this manner can be of

   123  *  utmost importance to some applications.

   124  *

   125  * PhysicsFS is mostly thread safe. The error messages returned by

   126  *  PHYSFS_getLastError() are unique by thread, and library-state-setting

   127  *  functions are mutex'd. For efficiency, individual file accesses are 

   128  *  not locked, so you can not safely read/write/seek/close/etc the same 

   129  *  file from two threads at the same time. Other race conditions are bugs 

   130  *  that should be reported/patched.

   131  *

   132  * While you CAN use stdio/syscall file access in a program that has PHYSFS_*

   133  *  calls, doing so is not recommended, and you can not use system

   134  *  filehandles with PhysicsFS and vice versa.

   135  *

   136  * Note that archives need not be named as such: if you have a ZIP file and

   137  *  rename it with a .PKG extension, the file will still be recognized as a

   138  *  ZIP archive by PhysicsFS; the file's contents are used to determine its

   139  *  type where possible.

   140  *

   141  * Currently supported archive types:

   142  *   - .ZIP (pkZip/WinZip/Info-ZIP compatible)

   143  *   - .7Z  (7zip archives)

   144  *   - .ISO (ISO9660 files, CD-ROM images)

   145  *   - .GRP (Build Engine groupfile archives)

   146  *   - .PAK (Quake I/II archive format)

   147  *   - .HOG (Descent I/II HOG file archives)

   148  *   - .MVL (Descent II movielib archives)

   149  *   - .WAD (DOOM engine archives)

   150  *

   151  *

   152  * String policy for PhysicsFS 2.0 and later:

   153  *

   154  * PhysicsFS 1.0 could only deal with null-terminated ASCII strings. All high

   155  *  ASCII chars resulted in undefined behaviour, and there was no Unicode

   156  *  support at all. PhysicsFS 2.0 supports Unicode without breaking binary

   157  *  compatibility with the 1.0 API by using UTF-8 encoding of all strings

   158  *  passed in and out of the library.

   159  *

   160  * All strings passed through PhysicsFS are in null-terminated UTF-8 format.

   161  *  This means that if all you care about is English (ASCII characters <= 127)

   162  *  then you just use regular C strings. If you care about Unicode (and you

   163  *  should!) then you need to figure out what your platform wants, needs, and

   164  *  offers. If you are on Windows before Win2000 and build with Unicode

   165  *  support, your TCHAR strings are two bytes per character (this is called

   166  *  "UCS-2 encoding"). Any modern Windows uses UTF-16, which is two bytes

   167  *  per character for most characters, but some characters are four. You

   168  *  should convert them to UTF-8 before handing them to PhysicsFS with

   169  *  PHYSFS_utf8FromUtf16(), which handles both UTF-16 and UCS-2. If you're

   170  *  using Unix or Mac OS X, your wchar_t strings are four bytes per character

   171  *  ("UCS-4 encoding"). Use PHYSFS_utf8FromUcs4(). Mac OS X can give you UTF-8

   172  *  directly from a CFString or NSString, and many Unixes generally give you C

   173  *  strings in UTF-8 format everywhere. If you have a single-byte high ASCII

   174  *  charset, like so-many European "codepages" you may be out of luck. We'll

   175  *  convert from "Latin1" to UTF-8 only, and never back to Latin1. If you're

   176  *  above ASCII 127, all bets are off: move to Unicode or use your platform's

   177  *  facilities. Passing a C string with high-ASCII data that isn't UTF-8

   178  *  encoded will NOT do what you expect!

   179  *

   180  * Naturally, there's also PHYSFS_utf8ToUcs2(), PHYSFS_utf8ToUtf16(), and

   181  *  PHYSFS_utf8ToUcs4() to get data back into a format you like. Behind the

   182  *  scenes, PhysicsFS will use Unicode where possible: the UTF-8 strings on

   183  *  Windows will be converted and used with the multibyte Windows APIs, for

   184  *  example.

   185  *

   186  * PhysicsFS offers basic encoding conversion support, but not a whole string

   187  *  library. Get your stuff into whatever format you can work with.

   188  *

   189  * All platforms supported by PhysicsFS 2.1 and later fully support Unicode.

   190  *  We have dropped platforms that don't (OS/2, Mac OS 9, Windows 95, etc), as

   191  *  even an OS that's over a decade old should be expected to handle this well.

   192  *  If you absolutely must support one of these platforms, you should use an

   193  *  older release of PhysicsFS.

   194  *

   195  * Many game-specific archivers are seriously unprepared for Unicode (the

   196  *  Descent HOG/MVL and Build Engine GRP archivers, for example, only offer a

   197  *  DOS 8.3 filename, for example). Nothing can be done for these, but they

   198  *  tend to be legacy formats for existing content that was all ASCII (and

   199  *  thus, valid UTF-8) anyhow. Other formats, like .ZIP, don't explicitly

   200  *  offer Unicode support, but unofficially expect filenames to be UTF-8

   201  *  encoded, and thus Just Work. Most everything does the right thing without

   202  *  bothering you, but it's good to be aware of these nuances in case they

   203  *  don't.

   204  *

   205  *

   206  * Other stuff:

   207  *

   208  * Please see the file LICENSE.txt in the source's root directory for

   209  *  licensing and redistribution rights.

   210  *

   211  * Please see the file CREDITS.txt in the source's "docs" directory for

   212  *  a more or less complete list of who's responsible for this.

   213  *

   214  *  \author Ryan C. Gordon.

   215  */

   216 

   217 #ifndef _INCLUDE_PHYSFS_H_

   218 #define _INCLUDE_PHYSFS_H_

   219 

   220 #ifdef __cplusplus

   221 extern "C" {

   222 #endif

   223 

   224 #if defined(PHYSFS_DECL)

   225 /* do nothing. */

   226 #elif (defined SWIG)

   227 #define PHYSFS_DECL extern

   228 #elif (defined _MSC_VER)

   229 #define PHYSFS_DECL __declspec(dllexport)

   230 #elif (defined __SUNPRO_C)

   231 #define PHYSFS_DECL __global

   232 #elif ((__GNUC__ >= 3) && (!__EMX__) && (!sun))

   233 #define PHYSFS_DECL __attribute__((visibility("default")))

   234 #else

   235 #define PHYSFS_DECL

   236 #endif

   237 

   238 #if defined(PHYSFS_DEPRECATED)

   239 /* do nothing. */

   240 #elif (defined SWIG)  /* ignore deprecated, since bindings use everything. */

   241 #define PHYSFS_DEPRECATED

   242 #elif (__GNUC__ >= 4)  /* technically, this arrived in gcc 3.1, but oh well. */

   243 #define PHYSFS_DEPRECATED __attribute__((deprecated))

   244 #else

   245 #define PHYSFS_DEPRECATED

   246 #endif

   247 

   248 #if 0  /* !!! FIXME: look into this later. */

   249 #if defined(PHYSFS_CALL)

   250 /* do nothing. */

   251 #elif defined(__WIN32__) && !defined(__GNUC__)

   252 #define PHYSFS_CALL __cdecl

   253 #else

   254 #define PHYSFS_CALL

   255 #endif

   256 #endif

   257 

   258 /**

   259  * \typedef PHYSFS_uint8

   260  * \brief An unsigned, 8-bit integer type.

   261  */

   262 typedef unsigned char         PHYSFS_uint8;

   263 

   264 /**

   265  * \typedef PHYSFS_sint8

   266  * \brief A signed, 8-bit integer type.

   267  */

   268 typedef signed char           PHYSFS_sint8;

   269 

   270 /**

   271  * \typedef PHYSFS_uint16

   272  * \brief An unsigned, 16-bit integer type.

   273  */

   274 typedef unsigned short        PHYSFS_uint16;

   275 

   276 /**

   277  * \typedef PHYSFS_sint16

   278  * \brief A signed, 16-bit integer type.

   279  */

   280 typedef signed short          PHYSFS_sint16;

   281 

   282 /**

   283  * \typedef PHYSFS_uint32

   284  * \brief An unsigned, 32-bit integer type.

   285  */

   286 typedef unsigned int          PHYSFS_uint32;

   287 

   288 /**

   289  * \typedef PHYSFS_sint32

   290  * \brief A signed, 32-bit integer type.

   291  */

   292 typedef signed int            PHYSFS_sint32;

   293 

   294 /**

   295  * \typedef PHYSFS_uint64

   296  * \brief An unsigned, 64-bit integer type.

   297  * \warning on platforms without any sort of 64-bit datatype, this is

   298  *           equivalent to PHYSFS_uint32!

   299  */

   300 

   301 /**

   302  * \typedef PHYSFS_sint64

   303  * \brief A signed, 64-bit integer type.

   304  * \warning on platforms without any sort of 64-bit datatype, this is

   305  *           equivalent to PHYSFS_sint32!

   306  */

   307 

   308 

   309 #if (defined PHYSFS_NO_64BIT_SUPPORT)  /* oh well. */

   310 typedef PHYSFS_uint32         PHYSFS_uint64;

   311 typedef PHYSFS_sint32         PHYSFS_sint64;

   312 #elif (defined _MSC_VER)

   313 typedef signed __int64        PHYSFS_sint64;

   314 typedef unsigned __int64      PHYSFS_uint64;

   315 #else

   316 typedef unsigned long long    PHYSFS_uint64;

   317 typedef signed long long      PHYSFS_sint64;

   318 #endif

   319 

   320 

   321 #ifndef SWIG

   322 #ifndef DOXYGEN_SHOULD_IGNORE_THIS

   323 /* Make sure the types really have the right sizes */

   324 #define PHYSFS_COMPILE_TIME_ASSERT(name, x)               \

   325        typedef int PHYSFS_dummy_ ## name[(x) * 2 - 1]

   326 

   327 PHYSFS_COMPILE_TIME_ASSERT(uint8, sizeof(PHYSFS_uint8) == 1);

   328 PHYSFS_COMPILE_TIME_ASSERT(sint8, sizeof(PHYSFS_sint8) == 1);

   329 PHYSFS_COMPILE_TIME_ASSERT(uint16, sizeof(PHYSFS_uint16) == 2);

   330 PHYSFS_COMPILE_TIME_ASSERT(sint16, sizeof(PHYSFS_sint16) == 2);

   331 PHYSFS_COMPILE_TIME_ASSERT(uint32, sizeof(PHYSFS_uint32) == 4);

   332 PHYSFS_COMPILE_TIME_ASSERT(sint32, sizeof(PHYSFS_sint32) == 4);

   333 

   334 #ifndef PHYSFS_NO_64BIT_SUPPORT

   335 PHYSFS_COMPILE_TIME_ASSERT(uint64, sizeof(PHYSFS_uint64) == 8);

   336 PHYSFS_COMPILE_TIME_ASSERT(sint64, sizeof(PHYSFS_sint64) == 8);

   337 #endif

   338 

   339 #undef PHYSFS_COMPILE_TIME_ASSERT

   340 

   341 #endif  /* DOXYGEN_SHOULD_IGNORE_THIS */

   342 #endif  /* SWIG */

   343 

   344 

   345 /**

   346  * \struct PHYSFS_File

   347  * \brief A PhysicsFS file handle.

   348  *

   349  * You get a pointer to one of these when you open a file for reading,

   350  *  writing, or appending via PhysicsFS.

   351  *

   352  * As you can see from the lack of meaningful fields, you should treat this

   353  *  as opaque data. Don't try to manipulate the file handle, just pass the

   354  *  pointer you got, unmolested, to various PhysicsFS APIs.

   355  *

   356  * \sa PHYSFS_openRead

   357  * \sa PHYSFS_openWrite

   358  * \sa PHYSFS_openAppend

   359  * \sa PHYSFS_close

   360  * \sa PHYSFS_read

   361  * \sa PHYSFS_write

   362  * \sa PHYSFS_seek

   363  * \sa PHYSFS_tell

   364  * \sa PHYSFS_eof

   365  * \sa PHYSFS_setBuffer

   366  * \sa PHYSFS_flush

   367  */

   368 typedef struct PHYSFS_File

   369 {

   370     void *opaque;  /**< That's all you get. Don't touch. */

   371 } PHYSFS_File;

   372 

   373 

   374 /**

   375  * \def PHYSFS_file

   376  * \brief 1.0 API compatibility define.

   377  *

   378  * PHYSFS_file is identical to PHYSFS_File. This #define is here for backwards

   379  *  compatibility with the 1.0 API, which had an inconsistent capitalization

   380  *  convention in this case. New code should use PHYSFS_File, as this #define

   381  *  may go away someday.

   382  *

   383  * \sa PHYSFS_File

   384  */

   385 #define PHYSFS_file PHYSFS_File

   386 

   387 

   388 /**

   389  * \struct PHYSFS_ArchiveInfo

   390  * \brief Information on various PhysicsFS-supported archives.

   391  *

   392  * This structure gives you details on what sort of archives are supported

   393  *  by this implementation of PhysicsFS. Archives tend to be things like

   394  *  ZIP files and such.

   395  *

   396  * \warning Not all binaries are created equal! PhysicsFS can be built with

   397  *          or without support for various archives. You can check with

   398  *          PHYSFS_supportedArchiveTypes() to see if your archive type is

   399  *          supported.

   400  *

   401  * \sa PHYSFS_supportedArchiveTypes

   402  * \sa PHYSFS_registerArchiver

   403  * \sa PHYSFS_deregisterArchiver

   404  */

   405 typedef struct PHYSFS_ArchiveInfo

   406 {

   407     const char *extension;   /**< Archive file extension: "ZIP", for example. */

   408     const char *description; /**< Human-readable archive description. */

   409     const char *author;      /**< Person who did support for this archive. */

   410     const char *url;         /**< URL related to this archive */

   411     int supportsSymlinks;    /**< non-zero if archive offers symbolic links. */

   412 } PHYSFS_ArchiveInfo;

   413 

   414 

   415 /**

   416  * \struct PHYSFS_Version

   417  * \brief Information the version of PhysicsFS in use.

   418  *

   419  * Represents the library's version as three levels: major revision

   420  *  (increments with massive changes, additions, and enhancements),

   421  *  minor revision (increments with backwards-compatible changes to the

   422  *  major revision), and patchlevel (increments with fixes to the minor

   423  *  revision).

   424  *

   425  * \sa PHYSFS_VERSION

   426  * \sa PHYSFS_getLinkedVersion

   427  */

   428 typedef struct PHYSFS_Version

   429 {

   430     PHYSFS_uint8 major; /**< major revision */

   431     PHYSFS_uint8 minor; /**< minor revision */

   432     PHYSFS_uint8 patch; /**< patchlevel */

   433 } PHYSFS_Version;

   434 

   435 

   436 #ifndef SWIG  /* not available from scripting languages. */

   437 

   438 #ifndef DOXYGEN_SHOULD_IGNORE_THIS

   439 #define PHYSFS_VER_MAJOR 2

   440 #define PHYSFS_VER_MINOR 1

   441 #define PHYSFS_VER_PATCH 0

   442 #endif  /* DOXYGEN_SHOULD_IGNORE_THIS */

   443 

   444 

   445 /* PhysicsFS state stuff ... */

   446 

   447 /**

   448  * \def PHYSFS_VERSION(x)

   449  * \brief Macro to determine PhysicsFS version program was compiled against.

   450  *

   451  * This macro fills in a PHYSFS_Version structure with the version of the

   452  *  library you compiled against. This is determined by what header the

   453  *  compiler uses. Note that if you dynamically linked the library, you might

   454  *  have a slightly newer or older version at runtime. That version can be

   455  *  determined with PHYSFS_getLinkedVersion(), which, unlike PHYSFS_VERSION,

   456  *  is not a macro.

   457  *

   458  * \param x A pointer to a PHYSFS_Version struct to initialize.

   459  *

   460  * \sa PHYSFS_Version

   461  * \sa PHYSFS_getLinkedVersion

   462  */

   463 #define PHYSFS_VERSION(x) \

   464 { \

   465     (x)->major = PHYSFS_VER_MAJOR; \

   466     (x)->minor = PHYSFS_VER_MINOR; \

   467     (x)->patch = PHYSFS_VER_PATCH; \

   468 }

   469 

   470 #endif  /* SWIG */

   471 

   472 

   473 /**

   474  * \fn void PHYSFS_getLinkedVersion(PHYSFS_Version *ver)

   475  * \brief Get the version of PhysicsFS that is linked against your program.

   476  *

   477  * If you are using a shared library (DLL) version of PhysFS, then it is

   478  *  possible that it will be different than the version you compiled against.

   479  *

   480  * This is a real function; the macro PHYSFS_VERSION tells you what version

   481  *  of PhysFS you compiled against:

   482  *

   483  * \code

   484  * PHYSFS_Version compiled;

   485  * PHYSFS_Version linked;

   486  *

   487  * PHYSFS_VERSION(&compiled);

   488  * PHYSFS_getLinkedVersion(&linked);

   489  * printf("We compiled against PhysFS version %d.%d.%d ...\n",

   490  *           compiled.major, compiled.minor, compiled.patch);

   491  * printf("But we linked against PhysFS version %d.%d.%d.\n",

   492  *           linked.major, linked.minor, linked.patch);

   493  * \endcode

   494  *

   495  * This function may be called safely at any time, even before PHYSFS_init().

   496  *

   497  * \sa PHYSFS_VERSION

   498  */

   499 PHYSFS_DECL void PHYSFS_getLinkedVersion(PHYSFS_Version *ver);

   500 

   501 

   502 /**

   503  * \fn int PHYSFS_init(const char *argv0)

   504  * \brief Initialize the PhysicsFS library.

   505  *

   506  * This must be called before any other PhysicsFS function.

   507  *

   508  * This should be called prior to any attempts to change your process's

   509  *  current working directory.

   510  *

   511  *   \param argv0 the argv[0] string passed to your program's mainline.

   512  *          This may be NULL on most platforms (such as ones without a

   513  *          standard main() function), but you should always try to pass

   514  *          something in here. Unix-like systems such as Linux _need_ to

   515  *          pass argv[0] from main() in here.

   516  *  \return nonzero on success, zero on error. Specifics of the error can be

   517  *          gleaned from PHYSFS_getLastError().

   518  *

   519  * \sa PHYSFS_deinit

   520  * \sa PHYSFS_isInit

   521  */

   522 PHYSFS_DECL int PHYSFS_init(const char *argv0);

   523 

   524 

   525 /**

   526  * \fn int PHYSFS_deinit(void)

   527  * \brief Deinitialize the PhysicsFS library.

   528  *

   529  * This closes any files opened via PhysicsFS, blanks the search/write paths,

   530  *  frees memory, and invalidates all of your file handles.

   531  *

   532  * Note that this call can FAIL if there's a file open for writing that

   533  *  refuses to close (for example, the underlying operating system was

   534  *  buffering writes to network filesystem, and the fileserver has crashed,

   535  *  or a hard drive has failed, etc). It is usually best to close all write

   536  *  handles yourself before calling this function, so that you can gracefully

   537  *  handle a specific failure.

   538  *

   539  * Once successfully deinitialized, PHYSFS_init() can be called again to

   540  *  restart the subsystem. All default API states are restored at this

   541  *  point, with the exception of any custom allocator you might have

   542  *  specified, which survives between initializations.

   543  *

   544  *  \return nonzero on success, zero on error. Specifics of the error can be

   545  *          gleaned from PHYSFS_getLastError(). If failure, state of PhysFS is

   546  *          undefined, and probably badly screwed up.

   547  *

   548  * \sa PHYSFS_init

   549  * \sa PHYSFS_isInit

   550  */

   551 PHYSFS_DECL int PHYSFS_deinit(void);

   552 

   553 

   554 /**

   555  * \fn const PHYSFS_ArchiveInfo **PHYSFS_supportedArchiveTypes(void)

   556  * \brief Get a list of supported archive types.

   557  *

   558  * Get a list of archive types supported by this implementation of PhysicFS.

   559  *  These are the file formats usable for search path entries. This is for

   560  *  informational purposes only. Note that the extension listed is merely

   561  *  convention: if we list "ZIP", you can open a PkZip-compatible archive

   562  *  with an extension of "XYZ", if you like.

   563  *

   564  * The returned value is an array of pointers to PHYSFS_ArchiveInfo structures,

   565  *  with a NULL entry to signify the end of the list:

   566  *

   567  * \code

   568  * PHYSFS_ArchiveInfo **i;

   569  *

   570  * for (i = PHYSFS_supportedArchiveTypes(); *i != NULL; i++)

   571  * {

   572  *     printf("Supported archive: [%s], which is [%s].\n",

   573  *              (*i)->extension, (*i)->description);

   574  * }

   575  * \endcode

   576  *

   577  * The return values are pointers to internal memory, and should

   578  *  be considered READ ONLY, and never freed. The returned values are

   579  *  valid until the next call to PHYSFS_deinit(), PHYSFS_registerArchiver(),

   580  *  or PHYSFS_deregisterArchiver().

   581  *

   582  *   \return READ ONLY Null-terminated array of READ ONLY structures.

   583  *

   584  * \sa PHYSFS_registerArchiver

   585  * \sa PHYSFS_deregisterArchiver

   586  */

   587 PHYSFS_DECL const PHYSFS_ArchiveInfo **PHYSFS_supportedArchiveTypes(void);

   588 

   589 

   590 /**

   591  * \fn void PHYSFS_freeList(void *listVar)

   592  * \brief Deallocate resources of lists returned by PhysicsFS.

   593  *

   594  * Certain PhysicsFS functions return lists of information that are

   595  *  dynamically allocated. Use this function to free those resources.

   596  *

   597  * It is safe to pass a NULL here, but doing so will cause a crash in versions

   598  *  before PhysicsFS 2.1.0.

   599  *

   600  *   \param listVar List of information specified as freeable by this function.

   601  *                  Passing NULL is safe; it is a valid no-op.

   602  *

   603  * \sa PHYSFS_getCdRomDirs

   604  * \sa PHYSFS_enumerateFiles

   605  * \sa PHYSFS_getSearchPath

   606  */

   607 PHYSFS_DECL void PHYSFS_freeList(void *listVar);

   608 

   609 

   610 /**

   611  * \fn const char *PHYSFS_getLastError(void)

   612  * \brief Get human-readable error information.

   613  *

   614  * \warning As of PhysicsFS 2.1, this function has been nerfed.

   615  *          Before PhysicsFS 2.1, this function was the only way to get

   616  *          error details beyond a given function's basic return value.

   617  *          This was meant to be a human-readable string in one of several

   618  *          languages, and was not useful for application parsing. This was

   619  *          a problem, because the developer and not the user chose the

   620  *          language at compile time, and the PhysicsFS maintainers had

   621  *          to (poorly) maintain a significant amount of localization work.

   622  *          The app couldn't parse the strings, even if they counted on a

   623  *          specific language, since some were dynamically generated.

   624  *          In 2.1 and later, this always returns a static string in

   625  *          English; you may use it as a key string for your own

   626  *          localizations if you like, as we'll promise not to change

   627  *          existing error strings. Also, if your application wants to

   628  *          look at specific errors, we now offer a better option:

   629  *          use PHYSFS_getLastErrorCode() instead.

   630  *

   631  * Get the last PhysicsFS error message as a human-readable, null-terminated

   632  *  string. This will return NULL if there's been no error since the last call

   633  *  to this function. The pointer returned by this call points to an internal

   634  *  buffer. Each thread has a unique error state associated with it, but each

   635  *  time a new error message is set, it will overwrite the previous one

   636  *  associated with that thread. It is safe to call this function at anytime,

   637  *  even before PHYSFS_init().

   638  *

   639  * PHYSFS_getLastError() and PHYSFS_getLastErrorCode() both reset the same

   640  *  thread-specific error state. Calling one will wipe out the other's

   641  *  data. If you need both, call PHYSFS_getLastErrorCode(), then pass that

   642  *  value to PHYSFS_getErrorByCode().

   643  *

   644  * As of PhysicsFS 2.1, this function only presents text in the English

   645  *  language, but the strings are static, so you can use them as keys into

   646  *  your own localization dictionary. These strings are meant to be passed on

   647  *  directly to the user.

   648  *

   649  * Generally, applications should only concern themselves with whether a

   650  *  given function failed; however, if your code require more specifics, you

   651  *  should use PHYSFS_getLastErrorCode() instead of this function.

   652  *

   653  *   \return READ ONLY string of last error message.

   654  *

   655  * \sa PHYSFS_getLastErrorCode

   656  * \sa PHYSFS_getErrorByCode

   657  */

   658 PHYSFS_DECL const char *PHYSFS_getLastError(void);

   659 

   660 

   661 /**

   662  * \fn const char *PHYSFS_getDirSeparator(void)

   663  * \brief Get platform-dependent dir separator string.

   664  *

   665  * This returns "\\" on win32, "/" on Unix, and ":" on MacOS. It may be more

   666  *  than one character, depending on the platform, and your code should take

   667  *  that into account. Note that this is only useful for setting up the

   668  *  search/write paths, since access into those dirs always use '/'

   669  *  (platform-independent notation) to separate directories. This is also

   670  *  handy for getting platform-independent access when using stdio calls.

   671  *

   672  *   \return READ ONLY null-terminated string of platform's dir separator.

   673  */

   674 PHYSFS_DECL const char *PHYSFS_getDirSeparator(void);

   675 

   676 

   677 /**

   678  * \fn void PHYSFS_permitSymbolicLinks(int allow)

   679  * \brief Enable or disable following of symbolic links.

   680  *

   681  * Some physical filesystems and archives contain files that are just pointers

   682  *  to other files. On the physical filesystem, opening such a link will

   683  *  (transparently) open the file that is pointed to.

   684  *

   685  * By default, PhysicsFS will check if a file is really a symlink during open

   686  *  calls and fail if it is. Otherwise, the link could take you outside the

   687  *  write and search paths, and compromise security.

   688  *

   689  * If you want to take that risk, call this function with a non-zero parameter.

   690  *  Note that this is more for sandboxing a program's scripting language, in

   691  *  case untrusted scripts try to compromise the system. Generally speaking,

   692  *  a user could very well have a legitimate reason to set up a symlink, so

   693  *  unless you feel there's a specific danger in allowing them, you should

   694  *  permit them.

   695  *

   696  * Symlinks are only explicitly checked when dealing with filenames

   697  *  in platform-independent notation. That is, when setting up your

   698  *  search and write paths, etc, symlinks are never checked for.

   699  *

   700  * Please note that PHYSFS_stat() will always check the path specified; if

   701  *  that path is a symlink, it will not be followed in any case. If symlinks

   702  *  aren't permitted through this function, PHYSFS_stat() ignores them, and

   703  *  would treat the query as if the path didn't exist at all.

   704  *

   705  * Symbolic link permission can be enabled or disabled at any time after

   706  *  you've called PHYSFS_init(), and is disabled by default.

   707  *

   708  *   \param allow nonzero to permit symlinks, zero to deny linking.

   709  *

   710  * \sa PHYSFS_symbolicLinksPermitted

   711  */

   712 PHYSFS_DECL void PHYSFS_permitSymbolicLinks(int allow);

   713 

   714 

   715 /* !!! FIXME: const this? */

   716 /**

   717  * \fn char **PHYSFS_getCdRomDirs(void)

   718  * \brief Get an array of paths to available CD-ROM drives.

   719  *

   720  * The dirs returned are platform-dependent ("D:\" on Win32, "/cdrom" or

   721  *  whatnot on Unix). Dirs are only returned if there is a disc ready and

   722  *  accessible in the drive. So if you've got two drives (D: and E:), and only

   723  *  E: has a disc in it, then that's all you get. If the user inserts a disc

   724  *  in D: and you call this function again, you get both drives. If, on a

   725  *  Unix box, the user unmounts a disc and remounts it elsewhere, the next

   726  *  call to this function will reflect that change.

   727  *

   728  * This function refers to "CD-ROM" media, but it really means "inserted disc

   729  *  media," such as DVD-ROM, HD-DVD, CDRW, and Blu-Ray discs. It looks for

   730  *  filesystems, and as such won't report an audio CD, unless there's a

   731  *  mounted filesystem track on it.

   732  *

   733  * The returned value is an array of strings, with a NULL entry to signify the

   734  *  end of the list:

   735  *

   736  * \code

   737  * char **cds = PHYSFS_getCdRomDirs();

   738  * char **i;

   739  *

   740  * for (i = cds; *i != NULL; i++)

   741  *     printf("cdrom dir [%s] is available.\n", *i);

   742  *

   743  * PHYSFS_freeList(cds);

   744  * \endcode

   745  *

   746  * This call may block while drives spin up. Be forewarned.

   747  *

   748  * When you are done with the returned information, you may dispose of the

   749  *  resources by calling PHYSFS_freeList() with the returned pointer.

   750  *

   751  *   \return Null-terminated array of null-terminated strings.

   752  *

   753  * \sa PHYSFS_getCdRomDirsCallback

   754  */

   755 PHYSFS_DECL char **PHYSFS_getCdRomDirs(void);

   756 

   757 

   758 /**

   759  * \fn const char *PHYSFS_getBaseDir(void)

   760  * \brief Get the path where the application resides.

   761  *

   762  * Helper function.

   763  *

   764  * Get the "base dir". This is the directory where the application was run

   765  *  from, which is probably the installation directory, and may or may not

   766  *  be the process's current working directory.

   767  *

   768  * You should probably use the base dir in your search path.

   769  *

   770  *  \return READ ONLY string of base dir in platform-dependent notation.

   771  *

   772  * \sa PHYSFS_getPrefDir

   773  */

   774 PHYSFS_DECL const char *PHYSFS_getBaseDir(void);

   775 

   776 

   777 /**

   778  * \fn const char *PHYSFS_getUserDir(void)

   779  * \brief Get the path where user's home directory resides.

   780  *

   781  * \deprecated As of PhysicsFS 2.1, you probably want PHYSFS_getPrefDir().

   782  *

   783  * Helper function.

   784  *

   785  * Get the "user dir". This is meant to be a suggestion of where a specific

   786  *  user of the system can store files. On Unix, this is her home directory.

   787  *  On systems with no concept of multiple home directories (MacOS, win95),

   788  *  this will default to something like "C:\mybasedir\users\username"

   789  *  where "username" will either be the login name, or "default" if the

   790  *  platform doesn't support multiple users, either.

   791  *

   792  *  \return READ ONLY string of user dir in platform-dependent notation.

   793  *

   794  * \sa PHYSFS_getBaseDir

   795  * \sa PHYSFS_getPrefDir

   796  */

   797 PHYSFS_DECL const char *PHYSFS_getUserDir(void) PHYSFS_DEPRECATED;

   798 

   799 

   800 /**

   801  * \fn const char *PHYSFS_getWriteDir(void)

   802  * \brief Get path where PhysicsFS will allow file writing.

   803  *

   804  * Get the current write dir. The default write dir is NULL.

   805  *

   806  *  \return READ ONLY string of write dir in platform-dependent notation,

   807  *           OR NULL IF NO WRITE PATH IS CURRENTLY SET.

   808  *

   809  * \sa PHYSFS_setWriteDir

   810  */

   811 PHYSFS_DECL const char *PHYSFS_getWriteDir(void);

   812 

   813 

   814 /**

   815  * \fn int PHYSFS_setWriteDir(const char *newDir)

   816  * \brief Tell PhysicsFS where it may write files.

   817  *

   818  * Set a new write dir. This will override the previous setting.

   819  *

   820  * This call will fail (and fail to change the write dir) if the current

   821  *  write dir still has files open in it.

   822  *

   823  *   \param newDir The new directory to be the root of the write dir,

   824  *                   specified in platform-dependent notation. Setting to NULL

   825  *                   disables the write dir, so no files can be opened for

   826  *                   writing via PhysicsFS.

   827  *  \return non-zero on success, zero on failure. All attempts to open a file

   828  *           for writing via PhysicsFS will fail until this call succeeds.

   829  *           Specifics of the error can be gleaned from PHYSFS_getLastError().

   830  *

   831  * \sa PHYSFS_getWriteDir

   832  */

   833 PHYSFS_DECL int PHYSFS_setWriteDir(const char *newDir);

   834 

   835 

   836 /**

   837  * \fn int PHYSFS_addToSearchPath(const char *newDir, int appendToPath)

   838  * \brief Add an archive or directory to the search path.

   839  *

   840  * \deprecated As of PhysicsFS 2.0, use PHYSFS_mount() instead. This

   841  *             function just wraps it anyhow.

   842  *

   843  * This function is equivalent to:

   844  *

   845  * \code

   846  *  PHYSFS_mount(newDir, NULL, appendToPath);

   847  * \endcode

   848  *

   849  * You must use this and not PHYSFS_mount if binary compatibility with

   850  *  PhysicsFS 1.0 is important (which it may not be for many people).

   851  *

   852  * \sa PHYSFS_mount

   853  * \sa PHYSFS_removeFromSearchPath

   854  * \sa PHYSFS_getSearchPath

   855  */

   856 PHYSFS_DECL int PHYSFS_addToSearchPath(const char *newDir, int appendToPath)

   857                                         PHYSFS_DEPRECATED;

   858 

   859 /**

   860  * \fn int PHYSFS_removeFromSearchPath(const char *oldDir)

   861  * \brief Remove a directory or archive from the search path.

   862  *

   863  * \deprecated As of PhysicsFS 2.1, use PHYSFS_unmount() instead. This

   864  *             function just wraps it anyhow. There's no functional difference

   865  *             except the vocabulary changed from "adding to the search path"

   866  *             to "mounting" when that functionality was extended, and thus

   867  *             the preferred way to accomplish this function's work is now

   868  *             called "unmounting."

   869  *

   870  * This function is equivalent to:

   871  *

   872  * \code

   873  *  PHYSFS_unmount(oldDir);

   874  * \endcode

   875  *

   876  * You must use this and not PHYSFS_unmount if binary compatibility with

   877  *  PhysicsFS 1.0 is important (which it may not be for many people).

   878  *

   879  * \sa PHYSFS_addToSearchPath

   880  * \sa PHYSFS_getSearchPath

   881  * \sa PHYSFS_unmount

   882  */

   883 PHYSFS_DECL int PHYSFS_removeFromSearchPath(const char *oldDir)

   884                                             PHYSFS_DEPRECATED;

   885 

   886 

   887 /**

   888  * \fn char **PHYSFS_getSearchPath(void)

   889  * \brief Get the current search path.

   890  *

   891  * The default search path is an empty list.

   892  *

   893  * The returned value is an array of strings, with a NULL entry to signify the

   894  *  end of the list:

   895  *

   896  * \code

   897  * char **i;

   898  *

   899  * for (i = PHYSFS_getSearchPath(); *i != NULL; i++)

   900  *     printf("[%s] is in the search path.\n", *i);

   901  * \endcode

   902  *

   903  * When you are done with the returned information, you may dispose of the

   904  *  resources by calling PHYSFS_freeList() with the returned pointer.

   905  *

   906  *   \return Null-terminated array of null-terminated strings. NULL if there

   907  *            was a problem (read: OUT OF MEMORY).

   908  *

   909  * \sa PHYSFS_getSearchPathCallback

   910  * \sa PHYSFS_addToSearchPath

   911  * \sa PHYSFS_removeFromSearchPath

   912  */

   913 PHYSFS_DECL char **PHYSFS_getSearchPath(void);

   914 

   915 

   916 /**

   917  * \fn int PHYSFS_setSaneConfig(const char *organization, const char *appName, const char *archiveExt, int includeCdRoms, int archivesFirst)

   918  * \brief Set up sane, default paths.

   919  *

   920  * Helper function.

   921  *

   922  * The write dir will be set to the pref dir returned by

   923  *  \code PHYSFS_getPrefDir(organization, appName) \endcode, which is

   924  *  created if it doesn't exist.

   925  *

   926  * The above is sufficient to make sure your program's configuration directory

   927  *  is separated from other clutter, and platform-independent.

   928  *

   929  *  The search path will be:

   930  *

   931  *    - The Write Dir (created if it doesn't exist)

   932  *    - The Base Dir (PHYSFS_getBaseDir())

   933  *    - All found CD-ROM dirs (optionally)

   934  *

   935  * These directories are then searched for files ending with the extension

   936  *  (archiveExt), which, if they are valid and supported archives, will also

   937  *  be added to the search path. If you specified "PKG" for (archiveExt), and

   938  *  there's a file named data.PKG in the base dir, it'll be checked. Archives

   939  *  can either be appended or prepended to the search path in alphabetical

   940  *  order, regardless of which directories they were found in. All archives

   941  *  are mounted in the root of the virtual file system ("/").

   942  *

   943  * All of this can be accomplished from the application, but this just does it

   944  *  all for you. Feel free to add more to the search path manually, too.

   945  *

   946  *    \param organization Name of your company/group/etc to be used as a

   947  *                         dirname, so keep it small, and no-frills.

   948  *

   949  *    \param appName Program-specific name of your program, to separate it

   950  *                   from other programs using PhysicsFS.

   951  *

   952  *    \param archiveExt File extension used by your program to specify an

   953  *                      archive. For example, Quake 3 uses "pk3", even though

   954  *                      they are just zipfiles. Specify NULL to not dig out

   955  *                      archives automatically. Do not specify the '.' char;

   956  *                      If you want to look for ZIP files, specify "ZIP" and

   957  *                      not ".ZIP" ... the archive search is case-insensitive.

   958  *

   959  *    \param includeCdRoms Non-zero to include CD-ROMs in the search path, and

   960  *                         (if (archiveExt) != NULL) search them for archives.

   961  *                         This may cause a significant amount of blocking

   962  *                         while discs are accessed, and if there are no discs

   963  *                         in the drive (or even not mounted on Unix systems),

   964  *                         then they may not be made available anyhow. You may

   965  *                         want to specify zero and handle the disc setup

   966  *                         yourself.

   967  *

   968  *    \param archivesFirst Non-zero to prepend the archives to the search path.

   969  *                          Zero to append them. Ignored if !(archiveExt).

   970  *

   971  *  \return nonzero on success, zero on error. Specifics of the error can be

   972  *          gleaned from PHYSFS_getLastError().

   973  */

   974 PHYSFS_DECL int PHYSFS_setSaneConfig(const char *organization,

   975                                      const char *appName,

   976                                      const char *archiveExt,

   977                                      int includeCdRoms,

   978                                      int archivesFirst);

   979 

   980 

   981 /* Directory management stuff ... */

   982 

   983 /**

   984  * \fn int PHYSFS_mkdir(const char *dirName)

   985  * \brief Create a directory.

   986  *

   987  * This is specified in platform-independent notation in relation to the

   988  *  write dir. All missing parent directories are also created if they

   989  *  don't exist.

   990  *

   991  * So if you've got the write dir set to "C:\mygame\writedir" and call

   992  *  PHYSFS_mkdir("downloads/maps") then the directories

   993  *  "C:\mygame\writedir\downloads" and "C:\mygame\writedir\downloads\maps"

   994  *  will be created if possible. If the creation of "maps" fails after we

   995  *  have successfully created "downloads", then the function leaves the

   996  *  created directory behind and reports failure.

   997  *

   998  *   \param dirName New dir to create.

   999  *  \return nonzero on success, zero on error. Specifics of the error can be

  1000  *          gleaned from PHYSFS_getLastError().

  1001  *

  1002  * \sa PHYSFS_delete

  1003  */

  1004 PHYSFS_DECL int PHYSFS_mkdir(const char *dirName);

  1005 

  1006 

  1007 /**

  1008  * \fn int PHYSFS_delete(const char *filename)

  1009  * \brief Delete a file or directory.

  1010  *

  1011  * (filename) is specified in platform-independent notation in relation to the

  1012  *  write dir.

  1013  *

  1014  * A directory must be empty before this call can delete it.

  1015  *

  1016  * Deleting a symlink will remove the link, not what it points to, regardless

  1017  *  of whether you "permitSymLinks" or not.

  1018  *

  1019  * So if you've got the write dir set to "C:\mygame\writedir" and call

  1020  *  PHYSFS_delete("downloads/maps/level1.map") then the file

  1021  *  "C:\mygame\writedir\downloads\maps\level1.map" is removed from the

  1022  *  physical filesystem, if it exists and the operating system permits the

  1023  *  deletion.

  1024  *

  1025  * Note that on Unix systems, deleting a file may be successful, but the

  1026  *  actual file won't be removed until all processes that have an open

  1027  *  filehandle to it (including your program) close their handles.

  1028  *

  1029  * Chances are, the bits that make up the file still exist, they are just

  1030  *  made available to be written over at a later point. Don't consider this

  1031  *  a security method or anything.  :)

  1032  *

  1033  *   \param filename Filename to delete.

  1034  *  \return nonzero on success, zero on error. Specifics of the error can be

  1035  *          gleaned from PHYSFS_getLastError().

  1036  */

  1037 PHYSFS_DECL int PHYSFS_delete(const char *filename);

  1038 

  1039 

  1040 /**

  1041  * \fn const char *PHYSFS_getRealDir(const char *filename)

  1042  * \brief Figure out where in the search path a file resides.

  1043  *

  1044  * The file is specified in platform-independent notation. The returned

  1045  *  filename will be the element of the search path where the file was found,

  1046  *  which may be a directory, or an archive. Even if there are multiple

  1047  *  matches in different parts of the search path, only the first one found

  1048  *  is used, just like when opening a file.

  1049  *

  1050  * So, if you look for "maps/level1.map", and C:\\mygame is in your search

  1051  *  path and C:\\mygame\\maps\\level1.map exists, then "C:\mygame" is returned.

  1052  *

  1053  * If a any part of a match is a symbolic link, and you've not explicitly

  1054  *  permitted symlinks, then it will be ignored, and the search for a match

  1055  *  will continue.

  1056  *

  1057  * If you specify a fake directory that only exists as a mount point, it'll

  1058  *  be associated with the first archive mounted there, even though that

  1059  *  directory isn't necessarily contained in a real archive.

  1060  *

  1061  * \warning This will return NULL if there is no real directory associated

  1062  *          with (filename). Specifically, PHYSFS_mountIo(),

  1063  *          PHYSFS_mountMemory(), and PHYSFS_mountHandle() will return NULL

  1064  *          even if the filename is found in the search path. Plan accordingly.

  1065  *

  1066  *     \param filename file to look for.

  1067  *    \return READ ONLY string of element of search path containing the

  1068  *             the file in question. NULL if not found.

  1069  */

  1070 PHYSFS_DECL const char *PHYSFS_getRealDir(const char *filename);

  1071 

  1072 

  1073 /**

  1074  * \fn char **PHYSFS_enumerateFiles(const char *dir)

  1075  * \brief Get a file listing of a search path's directory.

  1076  *

  1077  * Matching directories are interpolated. That is, if "C:\mydir" is in the

  1078  *  search path and contains a directory "savegames" that contains "x.sav",

  1079  *  "y.sav", and "z.sav", and there is also a "C:\userdir" in the search path

  1080  *  that has a "savegames" subdirectory with "w.sav", then the following code:

  1081  *

  1082  * \code

  1083  * char **rc = PHYSFS_enumerateFiles("savegames");

  1084  * char **i;

  1085  *

  1086  * for (i = rc; *i != NULL; i++)

  1087  *     printf(" * We've got [%s].\n", *i);

  1088  *

  1089  * PHYSFS_freeList(rc);

  1090  * \endcode

  1091  *

  1092  *  \...will print:

  1093  *

  1094  * \verbatim

  1095  * We've got [x.sav].

  1096  * We've got [y.sav].

  1097  * We've got [z.sav].

  1098  * We've got [w.sav].\endverbatim

  1099  *

  1100  * Feel free to sort the list however you like. However, the returned data

  1101  *  will always contain no duplicates, and will be always sorted in alphabetic

  1102  *  (rather: Unicode) order for you.

  1103  *

  1104  * Don't forget to call PHYSFS_freeList() with the return value from this

  1105  *  function when you are done with it.

  1106  *

  1107  *    \param dir directory in platform-independent notation to enumerate.

  1108  *   \return Null-terminated array of null-terminated strings.

  1109  *

  1110  * \sa PHYSFS_enumerateFilesCallback

  1111  */

  1112 PHYSFS_DECL char **PHYSFS_enumerateFiles(const char *dir);

  1113 

  1114 

  1115 /**

  1116  * \fn int PHYSFS_exists(const char *fname)

  1117  * \brief Determine if a file exists in the search path.

  1118  *

  1119  * Reports true if there is an entry anywhere in the search path by the

  1120  *  name of (fname).

  1121  *

  1122  * Note that entries that are symlinks are ignored if

  1123  *  PHYSFS_permitSymbolicLinks(1) hasn't been called, so you

  1124  *  might end up further down in the search path than expected.

  1125  *

  1126  *    \param fname filename in platform-independent notation.

  1127  *   \return non-zero if filename exists. zero otherwise.

  1128  */

  1129 PHYSFS_DECL int PHYSFS_exists(const char *fname);

  1130 

  1131 

  1132 /**

  1133  * \fn int PHYSFS_isDirectory(const char *fname)

  1134  * \brief Determine if a file in the search path is really a directory.