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  *     http://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  * 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  *  familiar to you.

    26  *

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

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

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

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

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

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

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

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

    35  *  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  *  Not only does this lend itself well to general abstraction with archives,

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

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

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

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

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

    45  *  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  *  "platform-independent notation" in this documentation. Specifying a

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

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

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

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

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

    55  *

    56  * 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  *  same thing as the PATH environment variable. An application using

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

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

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

    63  *  formats.

    64  *

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

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

    67  *

    68  *  - C:\\mygame

    69  *  - C:\\mygame\\myuserfiles

    70  *  - D:\\mygamescdromdatafiles

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

    72  *

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

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

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

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

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

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

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

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

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

    82  *  it correctly.

    83  *

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

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

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

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

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

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

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

    91  *  creating new symlinks in PhysicsFS.

    92  *

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

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

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

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

    97  *  NT systems.

    98  *

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

   100  *  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  *  which is needed only to set up your search/write paths. There is a

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

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

   106  *

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

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

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

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

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

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

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

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

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

   116  *

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

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

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

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

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

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

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

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

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

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

   127  *  utmost importance to some applications.

   128  *

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

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

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

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

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

   134  *  that should be reported/patched.

   135  *

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

   137  *  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  * Currently supported archive types:

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

   147  *   - .7Z  (7zip archives)

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

   149  *   - .GRP (Build Engine groupfile archives)

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

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

   152  *   - .MVL (Descent II movielib archives)

   153  *   - .WAD (DOOM engine archives)

   154  *

   155  *

   156  * String policy for PhysicsFS 2.0 and later:

   157  *

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

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

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

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

   162  *  passed in and out of the library.

   163  *

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

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

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

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

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

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

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

   171  *  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  *  PHYSFS_utf8FromUtf16(), which handles both UTF-16 and UCS-2. If you're

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

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

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

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

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

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

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

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

   182  *  encoded will NOT do what you expect!

   183  *

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

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

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

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

   188  *  example.

   189  *

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

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

   192  *

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

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

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

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

   197  *  older release of PhysicsFS.

   198  *

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

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

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

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

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

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

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

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

   207  *  don't.

   208  *

   209  *

   210  * Other stuff:

   211  *

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

   213  *  licensing and redistribution rights.

   214  *

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

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

   217  *

   218  *  \author Ryan C. Gordon.

   219  */

   220 

   221 #ifndef _INCLUDE_PHYSFS_H_

   222 #define _INCLUDE_PHYSFS_H_

   223 

   224 #ifdef __cplusplus

   225 extern "C" {

   226 #endif

   227 

   228 #if defined(PHYSFS_DECL)

   229 /* do nothing. */

   230 #elif (defined SWIG)

   231 #define PHYSFS_DECL extern

   232 #elif (defined _MSC_VER)

   233 #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")))

   238 #else

   239 #define PHYSFS_DECL

   240 #endif

   241 

   242 #if defined(PHYSFS_DEPRECATED)

   243 /* do nothing. */

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

   245 #define PHYSFS_DEPRECATED

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

   247 #define PHYSFS_DEPRECATED __attribute__((deprecated))

   248 #else

   249 #define PHYSFS_DEPRECATED

   250 #endif

   251 

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

   253 #if defined(PHYSFS_CALL)

   254 /* do nothing. */

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

   256 #define PHYSFS_CALL __cdecl

   257 #else

   258 #define PHYSFS_CALL

   259 #endif

   260 #endif

   261 

   262 /**

   263  * \typedef PHYSFS_uint8

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

   265  */

   266 typedef unsigned char         PHYSFS_uint8;

   267 

   268 /**

   269  * \typedef PHYSFS_sint8

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

   271  */

   272 typedef signed char           PHYSFS_sint8;

   273 

   274 /**

   275  * \typedef PHYSFS_uint16

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

   277  */

   278 typedef unsigned short        PHYSFS_uint16;

   279 

   280 /**

   281  * \typedef PHYSFS_sint16

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

   283  */

   284 typedef signed short          PHYSFS_sint16;

   285 

   286 /**

   287  * \typedef PHYSFS_uint32

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

   289  */

   290 typedef unsigned int          PHYSFS_uint32;

   291 

   292 /**

   293  * \typedef PHYSFS_sint32

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

   295  */

   296 typedef signed int            PHYSFS_sint32;

   297 

   298 /**

   299  * \typedef PHYSFS_uint64

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

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

   302  *           equivalent to PHYSFS_uint32!

   303  */

   304 

   305 /**

   306  * \typedef PHYSFS_sint64

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

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

   309  *           equivalent to PHYSFS_sint32!

   310  */

   311 

   312 

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

   314 typedef PHYSFS_uint32         PHYSFS_uint64;

   315 typedef PHYSFS_sint32         PHYSFS_sint64;

   316 #elif (defined _MSC_VER)

   317 typedef signed __int64        PHYSFS_sint64;

   318 typedef unsigned __int64      PHYSFS_uint64;

   319 #else

   320 typedef unsigned long long    PHYSFS_uint64;

   321 typedef signed long long      PHYSFS_sint64;

   322 #endif

   323 

   324 

   325 #ifndef SWIG

   326 #ifndef DOXYGEN_SHOULD_IGNORE_THIS

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

   328 #define PHYSFS_COMPILE_TIME_ASSERT(name, x)               \

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

   330 

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

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

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

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

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

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

   337 

   338 #ifndef PHYSFS_NO_64BIT_SUPPORT

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

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

   341 #endif

   342 

   343 #undef PHYSFS_COMPILE_TIME_ASSERT

   344 

   345 #endif  /* DOXYGEN_SHOULD_IGNORE_THIS */

   346 #endif  /* SWIG */

   347 

   348 

   349 /**

   350  * \struct PHYSFS_File

   351  * \brief A PhysicsFS file handle.

   352  *

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

   354  *  writing, or appending via PhysicsFS.

   355  *

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

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

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

   359  *

   360  * \sa PHYSFS_openRead

   361  * \sa PHYSFS_openWrite

   362  * \sa PHYSFS_openAppend

   363  * \sa PHYSFS_close

   364  * \sa PHYSFS_read

   365  * \sa PHYSFS_write

   366  * \sa PHYSFS_seek

   367  * \sa PHYSFS_tell

   368  * \sa PHYSFS_eof

   369  * \sa PHYSFS_setBuffer

   370  * \sa PHYSFS_flush

   371  */

   372 typedef struct PHYSFS_File

   373 {

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

   375 } PHYSFS_File;

   376 

   377 

   378 /**

   379  * \def PHYSFS_file

   380  * \brief 1.0 API compatibility define.

   381  *

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

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

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

   385  *  may go away someday.

   386  *

   387  * \sa PHYSFS_File

   388  */

   389 #define PHYSFS_file PHYSFS_File

   390 

   391 

   392 /**

   393  * \struct PHYSFS_ArchiveInfo

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

   395  *

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

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

   398  *  ZIP files and such.

   399  *

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

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

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

   403  *          supported.

   404  *

   405  * \sa PHYSFS_supportedArchiveTypes

   406  */

   407 typedef struct PHYSFS_ArchiveInfo

   408 {

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

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

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

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

   413 } PHYSFS_ArchiveInfo;

   414 

   415 

   416 /**

   417  * \struct PHYSFS_Version

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

   419  *

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

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

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

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

   424  *  revision).

   425  *

   426  * \sa PHYSFS_VERSION

   427  * \sa PHYSFS_getLinkedVersion

   428  */

   429 typedef struct PHYSFS_Version

   430 {

   431     PHYSFS_uint8 major; /**< major revision */

   432     PHYSFS_uint8 minor; /**< minor revision */

   433     PHYSFS_uint8 patch; /**< patchlevel */

   434 } PHYSFS_Version;

   435 

   436 

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

   438 

   439 #ifndef DOXYGEN_SHOULD_IGNORE_THIS

   440 #define PHYSFS_VER_MAJOR 2

   441 #define PHYSFS_VER_MINOR 1

   442 #define PHYSFS_VER_PATCH 0

   443 #endif  /* DOXYGEN_SHOULD_IGNORE_THIS */

   444 

   445 

   446 /* PhysicsFS state stuff ... */

   447 

   448 /**

   449  * \def PHYSFS_VERSION(x)

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

   451  *

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

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

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

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

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

   457  *  is not a macro.

   458  *

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

   460  *

   461  * \sa PHYSFS_Version

   462  * \sa PHYSFS_getLinkedVersion

   463  */

   464 #define PHYSFS_VERSION(x) \

   465 { \

   466     (x)->major = PHYSFS_VER_MAJOR; \

   467     (x)->minor = PHYSFS_VER_MINOR; \

   468     (x)->patch = PHYSFS_VER_PATCH; \

   469 }

   470 

   471 #endif  /* SWIG */

   472 

   473 

   474 /**

   475  * \fn void PHYSFS_getLinkedVersion(PHYSFS_Version *ver)

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

   477  *

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

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

   480  *

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

   482  *  of PhysFS you compiled against:

   483  *

   484  * \code

   485  * PHYSFS_Version compiled;

   486  * PHYSFS_Version linked;

   487  *

   488  * PHYSFS_VERSION(&compiled);

   489  * PHYSFS_getLinkedVersion(&linked);

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

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

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

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

   494  * \endcode

   495  *

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

   497  *

   498  * \sa PHYSFS_VERSION

   499  */

   500 PHYSFS_DECL void PHYSFS_getLinkedVersion(PHYSFS_Version *ver);

   501 

   502 

   503 /**

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

   505  * \brief Initialize the PhysicsFS library.

   506  *

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

   508  *

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

   510  *  current working directory.

   511  *

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

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

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

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

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

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

   518  *          gleaned from PHYSFS_getLastError().

   519  *

   520  * \sa PHYSFS_deinit

   521  * \sa PHYSFS_isInit

   522  */

   523 PHYSFS_DECL int PHYSFS_init(const char *argv0);

   524 

   525 

   526 /**

   527  * \fn int PHYSFS_deinit(void)

   528  * \brief Deinitialize the PhysicsFS library.

   529  *

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

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

   532  *

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

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

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

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

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

   538  *  handle a specific failure.

   539  *

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

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

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

   543  *  specified, which survives between initializations.

   544  *

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

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

   547  *          undefined, and probably badly screwed up.

   548  *

   549  * \sa PHYSFS_init

   550  * \sa PHYSFS_isInit

   551  */

   552 PHYSFS_DECL int PHYSFS_deinit(void);

   553 

   554 

   555 /**

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

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

   558  *

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

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

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

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

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

   564  *

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

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

   567  *

   568  * \code

   569  * PHYSFS_ArchiveInfo **i;

   570  *

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

   572  * {

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

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

   575  * }

   576  * \endcode

   577  *

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

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

   580  *  valid until the next call to PHYSFS_deinit().

   581  *

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

   583  */

   584 PHYSFS_DECL const PHYSFS_ArchiveInfo **PHYSFS_supportedArchiveTypes(void);

   585 

   586 

   587 /**

   588  * \fn void PHYSFS_freeList(void *listVar)

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

   590  *

   591  * Certain PhysicsFS functions return lists of information that are

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

   593  *

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

   595  *  before PhysicsFS 2.1.0.

   596  *

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

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

   599  *

   600  * \sa PHYSFS_getCdRomDirs

   601  * \sa PHYSFS_enumerateFiles

   602  * \sa PHYSFS_getSearchPath

   603  */

   604 PHYSFS_DECL void PHYSFS_freeList(void *listVar);

   605 

   606 

   607 /**

   608  * \fn const char *PHYSFS_getLastError(void)

   609  * \brief Get human-readable error information.

   610  *

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

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

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

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

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

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

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

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

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

   620  *          specific language, since some were dynamically generated.

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

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

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

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

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

   626  *          use PHYSFS_getLastErrorCode() instead.

   627  *

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

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

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

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

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

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

   634  *  even before PHYSFS_init().

   635  *

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

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

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

   639  *  value to PHYSFS_getErrorByCode().

   640  *

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

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

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

   644  *  directly to the user.

   645  *

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

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

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

   649  *

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

   651  *

   652  * \sa PHYSFS_getLastErrorCode

   653  * \sa PHYSFS_getErrorByCode

   654  */

   655 PHYSFS_DECL const char *PHYSFS_getLastError(void);

   656 

   657 

   658 /**

   659  * \fn const char *PHYSFS_getDirSeparator(void)

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

   661  *

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

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

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

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

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

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

   668  *

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

   670  */

   671 PHYSFS_DECL const char *PHYSFS_getDirSeparator(void);

   672 

   673 

   674 /**

   675  * \fn void PHYSFS_permitSymbolicLinks(int allow)

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

   677  *

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

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

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

   681  *

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

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

   684  *  write and search paths, and compromise security.

   685  *

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

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

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

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

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

   691  *  permit them.

   692  *

   693  * Symlinks are only explicitly checked when dealing with filenames

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

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

   696  *

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

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

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

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

   701  *

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

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

   704  *

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

   706  *

   707  * \sa PHYSFS_symbolicLinksPermitted

   708  */

   709 PHYSFS_DECL void PHYSFS_permitSymbolicLinks(int allow);

   710 

   711 

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

   713 /**

   714  * \fn char **PHYSFS_getCdRomDirs(void)

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

   716  *

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

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

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

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

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

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

   723  *  call to this function will reflect that change.

   724  *

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

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

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

   728  *  mounted filesystem track on it.

   729  *

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

   731  *  end of the list:

   732  *

   733  * \code

   734  * char **cds = PHYSFS_getCdRomDirs();

   735  * char **i;

   736  *

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

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

   739  *

   740  * PHYSFS_freeList(cds);

   741  * \endcode

   742  *

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

   744  *

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

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

   747  *

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

   749  *

   750  * \sa PHYSFS_getCdRomDirsCallback

   751  */

   752 PHYSFS_DECL char **PHYSFS_getCdRomDirs(void);

   753 

   754 

   755 /**

   756  * \fn const char *PHYSFS_getBaseDir(void)

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

   758  *

   759  * Helper function.

   760  *

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

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

   763  *  be the process's current working directory.

   764  *

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

   766  *

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

   768  *

   769  * \sa PHYSFS_getPrefDir

   770  */

   771 PHYSFS_DECL const char *PHYSFS_getBaseDir(void);

   772 

   773 

   774 /**

   775  * \fn const char *PHYSFS_getUserDir(void)

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

   777  *

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

   779  *

   780  * Helper function.

   781  *

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

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

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

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

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

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

   788  *

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

   790  *

   791  * \sa PHYSFS_getBaseDir

   792  * \sa PHYSFS_getPrefDir

   793  */

   794 PHYSFS_DECL const char *PHYSFS_getUserDir(void) PHYSFS_DEPRECATED;

   795 

   796 

   797 /**

   798  * \fn const char *PHYSFS_getWriteDir(void)

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

   800  *

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

   802  *

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

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

   805  *

   806  * \sa PHYSFS_setWriteDir

   807  */

   808 PHYSFS_DECL const char *PHYSFS_getWriteDir(void);

   809 

   810 

   811 /**

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

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

   814  *

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

   816  *

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

   818  *  write dir still has files open in it.

   819  *

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

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

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

   823  *                   writing via PhysicsFS.

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

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

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

   827  *

   828  * \sa PHYSFS_getWriteDir

   829  */

   830 PHYSFS_DECL int PHYSFS_setWriteDir(const char *newDir);

   831 

   832 

   833 /**

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

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

   836  *

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

   838  *             function just wraps it anyhow.

   839  *

   840  * This function is equivalent to:

   841  *

   842  * \code

   843  *  PHYSFS_mount(newDir, NULL, appendToPath);

   844  * \endcode

   845  *

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

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

   848  *

   849  * \sa PHYSFS_mount

   850  * \sa PHYSFS_removeFromSearchPath

   851  * \sa PHYSFS_getSearchPath

   852  */

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

   854                                         PHYSFS_DEPRECATED;

   855 

   856 /**

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

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

   859  *

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

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

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

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

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

   865  *             called "unmounting."

   866  *

   867  * This function is equivalent to:

   868  *

   869  * \code

   870  *  PHYSFS_unmount(oldDir);

   871  * \endcode

   872  *

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

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

   875  *

   876  * \sa PHYSFS_addToSearchPath

   877  * \sa PHYSFS_getSearchPath

   878  * \sa PHYSFS_unmount

   879  */

   880 PHYSFS_DECL int PHYSFS_removeFromSearchPath(const char *oldDir)

   881                                             PHYSFS_DEPRECATED;

   882 

   883 

   884 /**

   885  * \fn char **PHYSFS_getSearchPath(void)

   886  * \brief Get the current search path.

   887  *

   888  * The default search path is an empty list.

   889  *

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

   891  *  end of the list:

   892  *

   893  * \code

   894  * char **i;

   895  *

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

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

   898  * \endcode

   899  *

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

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

   902  *

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

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

   905  *

   906  * \sa PHYSFS_getSearchPathCallback

   907  * \sa PHYSFS_addToSearchPath

   908  * \sa PHYSFS_removeFromSearchPath

   909  */

   910 PHYSFS_DECL char **PHYSFS_getSearchPath(void);

   911 

   912 

   913 /**

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

   915  * \brief Set up sane, default paths.

   916  *

   917  * Helper function.

   918  *

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

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

   921  *  created if it doesn't exist.

   922  *

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

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

   925  *

   926  *  The search path will be:

   927  *

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

   929  *    - The Base Dir (PHYSFS_getBaseDir())

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

   931  *

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

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

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

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

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

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

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

   939  *

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

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

   942  *

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

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

   945  *

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

   947  *                   from other programs using PhysicsFS.

   948  *

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

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

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

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

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

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

   955  *

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

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

   958  *                         This may cause a significant amount of blocking

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

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

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

   962  *                         want to specify zero and handle the disc setup

   963  *                         yourself.

   964  *

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

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

   967  *

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

   969  *          gleaned from PHYSFS_getLastError().

   970  */

   971 PHYSFS_DECL int PHYSFS_setSaneConfig(const char *organization,

   972                                      const char *appName,

   973                                      const char *archiveExt,

   974                                      int includeCdRoms,

   975                                      int archivesFirst);

   976 

   977 

   978 /* Directory management stuff ... */

   979 

   980 /**

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

   982  * \brief Create a directory.

   983  *

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

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

   986  *  don't exist.

   987  *

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

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

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

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

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

   993  *  created directory behind and reports failure.

   994  *

   995  *   \param dirName New dir to create.

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

   997  *          gleaned from PHYSFS_getLastError().

   998  *

   999  * \sa PHYSFS_delete

  1000  */

  1001 PHYSFS_DECL int PHYSFS_mkdir(const char *dirName);

  1002 

  1003 

  1004 /**

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

  1006  * \brief Delete a file or directory.

  1007  *

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

  1009  *  write dir.

  1010  *

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

  1012  *

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

  1014  *  of whether you "permitSymLinks" or not.

  1015  *

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

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

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

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

  1020  *  deletion.

  1021  *

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

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

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

  1025  *

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

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

  1028  *  a security method or anything.  :)

  1029  *

  1030  *   \param filename Filename to delete.

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

  1032  *          gleaned from PHYSFS_getLastError().

  1033  */

  1034 PHYSFS_DECL int PHYSFS_delete(const char *filename);

  1035 

  1036 

  1037 /**

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

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

  1040  *

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

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

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

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

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

  1046  *

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

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

  1049  *

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

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

  1052  *  will continue.

  1053  *

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

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

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

  1057  *

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

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

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

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

  1062  *

  1063  *     \param filename file to look for.

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

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

  1066  */

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

  1068 

  1069 

  1070 /**

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

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

  1073  *

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

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

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

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

  1078  *

  1079  * \code

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

  1081  * char **i;

  1082  *

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

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

  1085  *

  1086  * PHYSFS_freeList(rc);

  1087  * \endcode

  1088  *

  1089  *  \...will print:

  1090  *

  1091  * \verbatim

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

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

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

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

  1096  *

  1097  * Feel free to sort the list however you like. We only promise there will

  1098  *  be no duplicates, but not what order the final list will come back in.

  1099  *

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

  1101  *  function when you are done with it.

  1102  *

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

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

  1105  *

  1106  * \sa PHYSFS_enumerateFilesCallback

  1107  */

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

  1109 

  1110 

  1111 /**

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

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

  1114  *

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

  1116  *  name of (fname).

  1117  *

  1118  * Note that entries that are symlinks are ignored if

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

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

  1121  *

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

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

  1124  */

  1125 PHYSFS_DECL int PHYSFS_exists(const char *fname);

  1126 

  1127 

  1128 /**

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

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

  1131  *

  1132  * \deprecated As of PhysicsFS 2.1, use PHYSFS_stat() instead. This

  1133  *             function just wraps it anyhow.

  1134  *