/**

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

 *

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

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

 *

 *   - It's portable.

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

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

 *      directory structures.

 *

 * This system is largely inspired by Quake 3's PK3 files and the related

 *  fs_* cvars. If you've ever tinkered with these, then this API will be

 *  familiar to you.

 *

 *

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

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

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

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

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

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

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

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

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

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

 *

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

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

 *  PhysicsFS specifies directories to be searched which may be actual

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

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

 *  formats.

 *

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

 *

 *    C:\mygame

 *    C:\mygame\myuserfiles

 *    D:\mygamescdromdatafiles

 *    C:\mygame\installeddatafiles.zip

 *

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

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

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

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

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

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

 *  that most archive types and platform filesystems store their filenames in

 *  a case-sensitive manner, so you should be careful to specify it correctly.

 *

 *

 *

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

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

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

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

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

 *  function to recommend a good search path, etc.

 *

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

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

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

 *

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

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

 *  filehandles with PhysicsFS filehandles and vice versa.

 *

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

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

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

 *  type.

 *

 * Currently supported archive types:

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

 *

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

 *

 *  This file written by Ryan C. Gordon.

 */

#ifndef _INCLUDE_PHYSFS_H_

#define _INCLUDE_PHYSFS_H_

#ifdef __cplusplus

extern "C" {

#endif

typedef struct __PHYSFS_FILE__

{

} PHYSFS_file;

typedef struct __PHYSFS_ARCHIVEINFO__

{

    const char *extension;

    const char *description;

} PHYSFS_ArchiveInfo;

/* functions... */

/**

 * Initialize PhysicsFS. This must be called before any other PhysicsFS

 *  function.

 *

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

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

 *          gleaned from PHYSFS_getLastError().

 */

int PHYSFS_init(const char *argv0);

/**

 * Shutdown PhysicsFS. This closes any files opened via PhysicsFS, blanks the

 *  search/write paths, frees memory, and invalidates all of your handles.

 *

 * Once deinitialized, PHYSFS_init() can be called again to restart the

 *  subsystem.

 *

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

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

 *          undefined, and probably badly screwed up.

 */

void PHYSFS_deinit(void);

/**

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

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

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

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

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

 *

 *

 * PHYSFS_ArchiveInfo **i;

 *

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

 * {

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

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

 * }

 *

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

 *  be considered READ ONLY, and never freed.

 *

 *   @return READ ONLY Null-terminated array of READ ONLY structures.

 */

/**

 * Certain PhysicsFS functions return lists of information that are

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

 *

 *   @param list List of information specified as freeable by this function.

 */

void PHYSFS_freeList(void *list);

/**

 * Get the last PhysicsFS error message as a null-terminated string.

 *  This will be NULL if there's been no error since the last call to this

 *

 *   @return READ ONLY string of last error message.

 */

const char *PHYSFS_getLastError(void);

/**

 *  and ":" on MacOS. It may be more than one character, depending on the

 *  platform, and your code should take that into account. Note that this is

 *  only useful for setting up the search/write paths, since access into those

 *  directories. This is also handy for getting platform-independent access

 *  when using stdio calls.

 *

 */

/**

 *

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

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

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

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

 *  call to this function will reflect that change. Fun.

 *

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

 *  end of the list:

 *

 * char **i;

 *

 *

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

 *

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

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

 *

 *   @return Null-terminated array of null-terminated strings.

 */

/**

 * Helper function.

 *

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

 *  be the process's current working directory.

 *

 *

 */

/**

 * Helper function.

 *

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

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

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

 *  platform doesn't support multiple users, either.

 *

 *  also put it near the beginning of your search path.

 *

 */

/**

 *

 *           OR NULL IF NO WRITE PATH IS CURRENTLY SET.

 */

/**

 *  directory or a parent directory doesn't exist in the physical filesystem,

 *  PhysicsFS will attempt to create them as needed.

 *

 *

 *                   specified in platform-dependent notation. Setting to NULL

 *                   writing via PhysicsFS.

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

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

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

 *

 */

/**

 * Add a directory or archive to the search path. If this is a duplicate, the

 *  entry is not added again, even though the function succeeds.

 *

 *                   platform-dependent notation.

 *   @param appendToPath nonzero to append to search path, zero to prepend.

 *                   missing, etc). Specifics of the error can be

 *                   gleaned from PHYSFS_getLastError().

 */

/**

 * Remove a directory or archive from the search path.

 *

 * This must be a (case-sensitive) match to a dir or archive already in the

 *  search path, specified in platform-dependent notation.

 *

 * This call will fail (and fail to remove from the path) if the element still

 *  has files open in it.

 *

 *   @return nonzero on success, zero on failure.

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

 */

/**

 * Get the current search path. The default search path is an empty list.

 *

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

 *  end of the list:

 *

 * char **i;

 *

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

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

 *

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

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

 *

 */

char **PHYSFS_getSearchPath(void);

/**

 * Helper function.

 *

 *

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

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

 *  before "mygame" even hides the directory on Unix systems.

 *

 *  The search path will be:

 *

 *

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

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

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

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

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

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

 *

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

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

 *

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

 *                   from other programs using PhysicsFS.

 *

 *    @param archiveExt File extention used by your program to specify an

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

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

 *                      archives automatically.

 *

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

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

 *                         This may cause a significant amount of blocking

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

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

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

 *                         want to specify zero and handle the disc setup

 *                         yourself.

 *

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

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

 */

/**

 * Create a directory. This is specified in platform-independent notation in

 *  created if they don't exist.

 *

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

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

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

 *  created directory behind and reports failure.

 *

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

 *          gleaned from PHYSFS_getLastError().

 */

int PHYSFS_mkdir(const char *dirName);