/** \file physfs.h */

/**

 * \mainpage PhysicsFS

 *

 * The latest version of PhysicsFS can be found at:

 *     http://icculus.org/physfs/

 *

 * 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.

 *

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

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

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

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

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

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

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

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

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

 *

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

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

 *  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\MyConfigFiles\game.cfg", then you might set the write dir to

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

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

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

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

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

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

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

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

 *

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

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

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

 *  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.

 *

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

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

 *

 *    C:\mygame

 *    C:\mygame\myuserfiles

 *    D:\mygamescdromdatafiles

 *    C:\mygame\installeddatafiles.zip

 *

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

 *  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.

 *

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

 *  elements. Not only are these meaningless on MacOS and/or Unix, they are a

 *  security hole. Also, symbolic links (which can be found in some archive

 *  types and directly in the filesystem on Unix platforms) are NOT followed

 *  until you call PHYSFS_permitSymbolicLinks(). That's left to your own

 *  discretion, as following a symlink can allow for access outside the write

 *  dir and search paths. There is no mechanism for creating new symlinks in

 *  PhysicsFS.

 *

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

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

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

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

 *  NT systems.

 *

 * 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

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

 *  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.

 *

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

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

 *  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

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

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

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

 *  PHYSFS_getBaseDir(), and PHYSFS_getUserDir() for info on what those

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

 *

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

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

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

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

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

 *  that should be reported/patched.

 *

 * 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 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)

 *   - .GRP (Build Engine groupfile archives)

 *

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

 *  and redistribution rights.

 *

 * Please see the file CREDITS in the source's root directory for a complete

 *  list of who's responsible for this.

 *

 *  \author Ryan C. Gordon.

 */

#ifndef _INCLUDE_PHYSFS_H_

#define _INCLUDE_PHYSFS_H_

#ifdef __cplusplus

extern "C" {

#endif

#ifndef DOXYGEN_SHOULD_IGNORE_THIS

#if (defined _MSC_VER)

#define __EXPORT__ __declspec(dllexport)

#else

#define __EXPORT__

#endif

#endif  /* DOXYGEN_SHOULD_IGNORE_THIS */

/**

 * \typedef PHYSFS_uint8

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

 */

typedef unsigned char         PHYSFS_uint8;

/**

 * \typedef PHYSFS_sint8

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

 */

typedef signed char           PHYSFS_sint8;

/**

 * \typedef PHYSFS_uint16

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

 */

typedef unsigned short        PHYSFS_uint16;

/**

 * \typedef PHYSFS_sint16

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

 */

typedef signed short          PHYSFS_sint16;

/**

 * \typedef PHYSFS_uint32

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

 */

typedef unsigned int          PHYSFS_uint32;

/**

 * \typedef PHYSFS_sint32

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

 */

typedef signed int            PHYSFS_sint32;

/**

 * \typedef PHYSFS_uint64

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

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

 *           equivalent to PHYSFS_uint32!

 */

/**

 * \typedef PHYSFS_sint64

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

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

 *           equivalent to PHYSFS_sint32!

 */

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

typedef PHYSFS_uint32         PHYSFS_uint64;

typedef PHYSFS_sint32         PHYSFS_sint64;

#elif (defined _MSC_VER)

typedef signed __int64        PHYSFS_sint64;

typedef unsigned __int64      PHYSFS_uint64;

#else

typedef unsigned long long    PHYSFS_uint64;

typedef signed long long      PHYSFS_sint64;

#endif

#ifndef DOXYGEN_SHOULD_IGNORE_THIS

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

#define PHYSFS_COMPILE_TIME_ASSERT(name, x)               \

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

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

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

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

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

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

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

#ifndef PHYSFS_NO_64BIT_SUPPORT

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

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

#endif

#undef PHYSFS_COMPILE_TIME_ASSERT

#endif  /* DOXYGEN_SHOULD_IGNORE_THIS */

/**

 * \struct PHYSFS_file

 * \brief A PhysicsFS file handle.

 *

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

 *  writing, or appending via PhysicsFS.

 *

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

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

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

 *

 * \sa PHYSFS_openRead

 * \sa PHYSFS_openWrite

 * \sa PHYSFS_openAppend

 * \sa PHYSFS_close

 * \sa PHYSFS_read

 * \sa PHYSFS_write

 * \sa PHYSFS_seek

 * \sa PHYSFS_tell

 * \sa PHYSFS_eof

 */

typedef struct

{

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

} PHYSFS_file;

/**

 * \struct PHYSFS_ArchiveInfo

 * \brief Information on various PhysicsFS-supported archives.

 *

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

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

 *  ZIP files and such.

 *

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

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

 *          PHYSFS_supportedArchiveTypes() to see if your archive type is

 *          supported.

 *

 * \sa PHYSFS_supportedArchiveTypes

 */

typedef struct

{

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

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

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

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

} PHYSFS_ArchiveInfo;

/**

 * \struct PHYSFS_Version

 * \brief Information the version of PhysicsFS in use.

 *

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

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

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

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

 *  revision).

 *

 * \sa PHYSFS_VERSION

 * \sa PHYFS_getLinkedVersion

 */

typedef struct

{

    PHYSFS_uint8 major; /**< major revision */

    PHYSFS_uint8 minor; /**< minor revision */

    PHYSFS_uint8 patch; /**< patchlevel */

} PHYSFS_Version;

#ifndef DOXYGEN_SHOULD_IGNORE_THIS

#define PHYSFS_VER_MAJOR 0

#define PHYSFS_VER_MINOR 1

#define PHYSFS_VER_PATCH 7

#endif  /* DOXYGEN_SHOULD_IGNORE_THIS */

/**

 * \def PHYSFS_VERSION(x)

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

 *

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

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

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

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

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

 *  is not a macro.

 *

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

 *

 * \sa PHYSFS_Version

 * \sa PHYSFS_getLinkedVersion

 */

#define PHYSFS_VERSION(x) \

{ \

    (x)->major = PHYSFS_VER_MAJOR; \

    (x)->minor = PHYSFS_VER_MINOR; \

    (x)->patch = PHYSFS_VER_PATCH; \

}

/**

 * \fn void PHYSFS_getLinkedVersion(PHYSFS_Version *ver)

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

 *

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

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

 *

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

 *  of PhysFS you compiled against:

 *

 * \code

 * PHYSFS_Version compiled;

 * PHYSFS_Version linked;

 *

 * PHYSFS_VERSION(&compiled);

 * PHYSFS_getLinkedVersion(&linked);

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

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

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

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

 * \endcode

 *

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

 *

 * \sa PHYSFS_VERSION

 */

__EXPORT__ void PHYSFS_getLinkedVersion(PHYSFS_Version *ver);

/**

 * \fn int PHYSFS_init(const char *argv0)

 * \brief Initialize the PhysicsFS library.

 *

 * This must be called before any other PhysicsFS function.

 *

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

 *  current working directory.

 *

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

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

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

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

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

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

 *          gleaned from PHYSFS_getLastError().

 *

 * \sa PHYSFS_deinit

 */

__EXPORT__ int PHYSFS_init(const char *argv0);

/**

 * \fn int PHYSFS_deinit(void)

 * \brief Deinitialize the PhysicsFS library.

 *

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

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

 *

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

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

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

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

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

 *  handle a specific failure.

 *

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

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

 *  point.

 *

 *  \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.

 *

 * \sa PHYSFS_init

 */

__EXPORT__ int PHYSFS_deinit(void);

/**

 * \fn const PHYSFS_ArchiveInfo **PHYSFS_supportedArchiveTypes(void)

 * \brief Get a list of supported archive types.

 *

 * 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.

 *

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

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

 *

 * \code

 * PHYSFS_ArchiveInfo **i;

 *

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

 * {

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

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

 * }

 * \endcode

 *

 * 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.

 */

__EXPORT__ const PHYSFS_ArchiveInfo **PHYSFS_supportedArchiveTypes(void);

/**

 * \fn void PHYSFS_freeList(void *listVar)

 * \brief Deallocate resources of lists returned by PhysicsFS.

 *

 * Certain PhysicsFS functions return lists of information that are

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

 *

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

 *

 * \sa PHYSFS_getCdRomDirs

 * \sa PHYSFS_enumerateFiles

 * \sa PHYSFS_getSearchPath

 */

__EXPORT__ void PHYSFS_freeList(void *listVar);

/**

 * \fn const char *PHYSFS_getLastError(void)

 * \brief Get human-readable error information.

 *

 * 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

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

 *  Each thread has a unique error state associated with it, but each time

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

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

 *  before PHYSFS_init().

 *

 *   \return READ ONLY string of last error message.

 */

__EXPORT__ const char *PHYSFS_getLastError(void);

/**