/*

 * Internal function/structure declaration. Do NOT include in your

 *  application.

 *

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

 *

 *  This file written by Ryan C. Gordon.

 */

#ifndef _INCLUDE_PHYSFS_INTERNAL_H_

#define _INCLUDE_PHYSFS_INTERNAL_H_

#ifndef __PHYSICSFS_INTERNAL__

#error Do not include this header from your applications.

#endif

#include "physfs.h"

#ifdef __cplusplus

extern "C" {

#endif

/* The LANG section. */

/*  please send questions/translations to Ryan: icculus@clutteredmind.org. */

#if (!defined PHYSFS_LANG)

#  define PHYSFS_LANG PHYSFS_LANG_ENGLISH

#endif

#define PHYSFS_LANG_RUSSIAN_KOI8_R 2  /* Russian text by Ed Sinjiashvili */

#if (PHYSFS_LANG == PHYSFS_LANG_ENGLISH)

 #define DIR_ARCHIVE_DESCRIPTION  "Non-archive, direct filesystem I/O"

 #define GRP_ARCHIVE_DESCRIPTION  "Build engine Groupfile format"

 #define ZIP_ARCHIVE_DESCRIPTION  "PkZip/WinZip/Info-Zip compatible"

 #define ERR_IS_INITIALIZED       "Already initialized"

 #define ERR_NOT_INITIALIZED      "Not initialized"

 #define ERR_INVALID_ARGUMENT     "Invalid argument"

 #define ERR_FILES_STILL_OPEN     "Files still open"

 #define ERR_NO_DIR_CREATE        "Failed to create directories"

 #define ERR_OUT_OF_MEMORY        "Out of memory"

 #define ERR_NOT_IN_SEARCH_PATH   "No such entry in search path"

 #define ERR_NOT_SUPPORTED        "Operation not supported"

 #define ERR_UNSUPPORTED_ARCHIVE  "Archive type unsupported"

 #define ERR_NOT_A_HANDLE         "Not a file handle"

 #define ERR_INSECURE_FNAME       "Insecure filename"

 #define ERR_SYMLINK_DISALLOWED   "Symbolic links are disabled"

 #define ERR_NO_WRITE_DIR         "Write directory is not set"

 #define ERR_NO_SUCH_FILE         "File not found"

 #define ERR_NO_SUCH_PATH         "Path not found"

 #define ERR_NO_SUCH_VOLUME       "Volume not found"

 #define ERR_PAST_EOF             "Past end of file"

 #define ERR_ARC_IS_READ_ONLY     "Archive is read-only"

 #define ERR_IO_ERROR             "I/O error"

 #define ERR_CANT_SET_WRITE_DIR   "Can't set write directory"

 #define ERR_SYMLINK_LOOP         "Infinite symbolic link loop"

 #define ERR_COMPRESSION          "(De)compression error"

 #define ERR_NOT_IMPLEMENTED      "Not implemented"

 #define ERR_OS_ERROR             "Operating system reported error"

 #define ERR_FILE_EXISTS          "File already exists"

 #define ERR_NOT_A_FILE           "Not a file"

 #define ERR_NOT_A_DIR            "Not a directory"

 #define ERR_NOT_AN_ARCHIVE       "Not an archive"

 #define ERR_CORRUPTED            "Corrupted archive"

 #define ERR_SEEK_OUT_OF_RANGE    "Seek out of range"

 #define ERR_BAD_FILENAME         "Bad filename"

 #define ERR_PHYSFS_BAD_OS_CALL   "(BUG) PhysicsFS made a bad system call"

 #define ERR_ARGV0_IS_NULL        "argv0 is NULL"

 #define ERR_ZLIB_NEED_DICT       "zlib: need dictionary"

 #define ERR_ZLIB_DATA_ERROR      "zlib: data error"

 #define ERR_ZLIB_MEMORY_ERROR    "zlib: memory error"

 #define ERR_ZLIB_BUFFER_ERROR    "zlib: buffer error"

 #define ERR_ZLIB_VERSION_ERROR   "zlib: version error"

 #define ERR_ZLIB_UNKNOWN_ERROR   "zlib: unknown error"

 #define ERR_SEARCHPATH_TRUNC     "Search path was truncated"

 #define ERR_GETMODFN_TRUNC       "GetModuleFileName() was truncated"

 #define ERR_GETMODFN_NO_DIR      "GetModuleFileName() had no dir"

 #define ERR_DISK_FULL            "Disk is full"

 #define ERR_DIRECTORY_FULL       "Directory full"

 #define ERR_MACOS_GENERIC        "MacOS reported error (%d)"

 #define ERR_OS2_GENERIC          "OS/2 reported error (%d)"

 #define ERR_VOL_LOCKED_HW        "Volume is locked through hardware"

 #define ERR_VOL_LOCKED_SW        "Volume is locked through software"

 #define ERR_FILE_LOCKED          "File is locked"

 #define ERR_FILE_OR_DIR_BUSY     "File/directory is busy"

 #define ERR_FILE_ALREADY_OPEN_W  "File already open for writing"

 #define ERR_FILE_ALREADY_OPEN_R  "File already open for reading"

 #define ERR_INVALID_REFNUM       "Invalid reference number"

 #define ERR_GETTING_FILE_POS     "Error getting file position"

 #define ERR_VOLUME_OFFLINE       "Volume is offline"

 #define ERR_PERMISSION_DENIED    "Permission denied"

 #define ERR_VOL_ALREADY_ONLINE   "Volume already online"

 #define ERR_NO_SUCH_DRIVE        "No such drive"

 #define ERR_NOT_MAC_DISK         "Not a Macintosh disk"

 #define ERR_VOL_EXTERNAL_FS      "Volume belongs to an external filesystem"

 #define ERR_PROBLEM_RENAME       "Problem during rename"

 #define ERR_BAD_MASTER_BLOCK     "Bad master directory block"

 #define ERR_CANT_MOVE_FORBIDDEN  "Attempt to move forbidden"

 #define ERR_WRONG_VOL_TYPE       "Wrong volume type"

 #define ERR_SERVER_VOL_LOST      "Server volume has been disconnected"

 #define ERR_FILE_ID_NOT_FOUND    "File ID not found"

 #define ERR_FILE_ID_EXISTS       "File ID already exists"

 #define ERR_SERVER_NO_RESPOND    "Server not responding"

 #define ERR_USER_AUTH_FAILED     "User authentication failed"

 #define ERR_PWORD_EXPIRED        "Password has expired on server"

 #define ERR_ACCESS_DENIED        "Access denied"

 #define ERR_NOT_A_DOS_DISK       "Not a DOS disk"

 #define ERR_SHARING_VIOLATION    "Sharing violation"

 #define ERR_CANNOT_MAKE          "Cannot make"

 #define ERR_DEV_IN_USE           "Device already in use"

 #define ERR_OPEN_FAILED          "Open failed"

 #define ERR_PIPE_BUSY            "Pipe is busy"

 #define ERR_SHARING_BUF_EXCEEDED "Sharing buffer exceeded"

 #define ERR_TOO_MANY_HANDLES     "Too many open handles"

 #define ERR_SEEK_ERROR           "Seek error"

 #define ERR_DEL_CWD              "Trying to delete current working directory"

 #define ERR_WRITE_PROTECT_ERROR  "Write protect error"

 #define ERR_WRITE_FAULT          "Write fault"

 #define ERR_LOCK_VIOLATION       "Lock violation"

 #define ERR_GEN_FAILURE          "General failure"

 #define ERR_UNCERTAIN_MEDIA      "Uncertain media"

 #define ERR_PROT_VIOLATION       "Protection violation"

 #define ERR_BROKEN_PIPE          "Broken pipe"

#elif (PHYSFS_LANG == PHYSFS_LANG_RUSSIAN_KOI8_R)

 #define DIR_ARCHIVE_DESCRIPTION  "îÅ ÁÒÈÉ×, ÎÅÐÏÓÒÅÄÓÔ×ÅÎÎÙÊ ××ÏÄ/×Ù×ÏÄ ÆÁÊÌÏ×ÏÊ ÓÉÓÔÅÍÙ"

 #define GRP_ARCHIVE_DESCRIPTION  "æÏÒÍÁÔ ÇÒÕÐÐÏ×ÏÇÏ ÆÁÊÌÁ Build engine"

 #define ZIP_ARCHIVE_DESCRIPTION  "PkZip/WinZip/Info-Zip ÓÏ×ÍÅÓÔÉÍÙÊ"

 #define ERR_IS_INITIALIZED       "õÖÅ ÉÎÉÃÉÁÌÉÚÉÒÏ×ÁÎ"

 #define ERR_NOT_INITIALIZED      "îÅ ÉÎÉÃÉÁÌÉÚÉÒÏ×ÁÎ"

 #define ERR_INVALID_ARGUMENT     "îÅ×ÅÒÎÙÊ ÁÒÇÕÍÅÎÔ"

 #define ERR_FILES_STILL_OPEN     "æÁÊÌÙ ÅÝÅ ÏÔËÒÙÔÙ"

 #define ERR_NO_DIR_CREATE        "îÅ ÍÏÇÕ ÓÏÚÄÁÔØ ËÁÔÁÌÏÇÉ"

 #define ERR_OUT_OF_MEMORY        "ëÏÎÞÉÌÁÓØ ÐÁÍÑÔØ"

 #define ERR_NOT_IN_SEARCH_PATH   "îÅÔ ÔÁËÏÇÏ ÜÌÅÍÅÎÔÁ × ÐÕÔÉ ÐÏÉÓËÁ"

 #define ERR_NOT_SUPPORTED        "ïÐÅÒÁÃÉÑ ÎÅ ÐÏÄÄÅÒÖÉ×ÁÅÔÓÑ"

 #define ERR_UNSUPPORTED_ARCHIVE  "áÒÈÉ×Ù ÔÁËÏÇÏ ÔÉÐÁ ÎÅ ÐÏÄÄÅÒÖÉ×ÁÀÔÓÑ"

 #define ERR_NOT_A_HANDLE         "îÅ ÆÁÊÌÏ×ÙÊ ÄÅÓËÒÉÐÔÏÒ"

 #define ERR_INSECURE_FNAME       "îÅÂÅÚÏÐÁÓÎÏÅ ÉÍÑ ÆÁÊÌÁ"

 #define ERR_SYMLINK_DISALLOWED   "óÉÍ×ÏÌØÎÙÅ ÓÓÙÌËÉ ÏÔËÌÀÞÅÎÙ"

 #define ERR_NO_WRITE_DIR         "ëÁÔÁÌÏÇ ÄÌÑ ÚÁÐÉÓÉ ÎÅ ÕÓÔÁÎÏ×ÌÅÎ"

 #define ERR_NO_SUCH_FILE         "æÁÊÌ ÎÅ ÎÁÊÄÅÎ"

 #define ERR_NO_SUCH_PATH         "ðÕÔØ ÎÅ ÎÁÊÄÅÎ"

 #define ERR_NO_SUCH_VOLUME       "ôÏÍ ÎÅ ÎÁÊÄÅÎ"

 #define ERR_PAST_EOF             "úÁ ËÏÎÃÏÍ ÆÁÊÌÁ"

 #define ERR_ARC_IS_READ_ONLY     "áÒÈÉ× ÔÏÌØËÏ ÄÌÑ ÞÔÅÎÉÑ"

 #define ERR_IO_ERROR             "ïÛÉÂËÁ ××ÏÄÁ/×Ù×ÏÄÁ"

 #define ERR_CANT_SET_WRITE_DIR   "îÅ ÍÏÇÕ ÕÓÔÁÎÏ×ÉÔØ ËÁÔÁÌÏÇ ÄÌÑ ÚÁÐÉÓÉ"

 #define ERR_SYMLINK_LOOP         "âÅÓËÏÎÅÞÎÙÊ ÃÉËÌ ÓÉÍ×ÏÌØÎÏÊ ÓÓÙÌËÉ"

 #define ERR_COMPRESSION          "ïÛÉÂËÁ (òÁÓ)ÐÁËÏ×ËÉ"

 #define ERR_NOT_IMPLEMENTED      "îÅ ÒÅÁÌÉÚÏ×ÁÎÏ"

 #define ERR_OS_ERROR             "ïÐÅÒÁÃÉÏÎÎÁÑ ÓÉÓÔÅÍÁ ÓÏÏÂÝÉÌÁ ÏÛÉÂËÕ"

 #define ERR_FILE_EXISTS          "æÁÊÌ ÕÖÅ ÓÕÝÅÓÔ×ÕÅÔ"

 #define ERR_NOT_A_FILE           "îÅ ÆÁÊÌ"

 #define ERR_NOT_A_DIR            "îÅ ËÁÔÁÌÏÇ"

 #define ERR_NOT_AN_ARCHIVE       "îÅ ÁÒÈÉ×"

 #define ERR_CORRUPTED            "ðÏ×ÒÅÖÄÅÎÎÙÊ ÁÒÈÉ×"

 #define ERR_SEEK_OUT_OF_RANGE    "ðÏÚÉÃÉÏÎÉÒÏ×ÁÎÉÅ ÚÁ ÐÒÅÄÅÌÙ"

 #define ERR_BAD_FILENAME         "îÅ×ÅÒÎÏÅ ÉÍÑ ÆÁÊÌÁ"

 #define ERR_PHYSFS_BAD_OS_CALL   "(BUG) PhysicsFS ×ÙÐÏÌÎÉÌÁ ÎÅ×ÅÒÎÙÊ ÓÉÓÔÅÍÎÙÊ ×ÙÚÏ×"

 #define ERR_ARGV0_IS_NULL        "argv0 is NULL"

 #define ERR_ZLIB_NEED_DICT       "zlib: ÎÕÖÅÎ ÓÌÏ×ÁÒØ"

 #define ERR_ZLIB_DATA_ERROR      "zlib: ÏÛÉÂËÁ ÄÁÎÎÙÈ"

 #define ERR_ZLIB_MEMORY_ERROR    "zlib: ÏÛÉÂËÁ ÐÁÍÑÔÉ"

 #define ERR_ZLIB_BUFFER_ERROR    "zlib: ÏÛÉÂËÁ ÂÕÆÅÒÁ"

 #define ERR_ZLIB_VERSION_ERROR   "zlib: ÏÛÉÂËÁ ×ÅÒÓÉÉ"

 #define ERR_ZLIB_UNKNOWN_ERROR   "zlib: ÎÅÉÚ×ÅÓÔÎÁÑ ÏÛÉÂËÁ"

 #define ERR_SEARCHPATH_TRUNC     "ðÕÔØ ÐÏÉÓËÁ ÏÂÒÅÚÁÎ"

 #define ERR_GETMODFN_TRUNC       "GetModuleFileName() ÏÂÒÅÚÁÎ"

 #define ERR_GETMODFN_NO_DIR      "GetModuleFileName() ÎÅ ÐÏÌÕÞÉÌ ËÁÔÁÌÏÇ"

 #define ERR_DISK_FULL            "äÉÓË ÐÏÌÏÎ"

 #define ERR_DIRECTORY_FULL       "ëÁÔÁÌÏÇ ÐÏÌÏÎ"

 #define ERR_MACOS_GENERIC        "MacOS ÓÏÏÂÝÉÌÁ ÏÛÉÂËÕ (%d)"

 #define ERR_OS2_GENERIC          "OS/2 ÓÏÏÂÝÉÌÁ ÏÛÉÂËÕ (%d)"

 #define ERR_VOL_LOCKED_HW        "ôÏÍ ÂÌÏËÉÒÏ×ÁÎ ÁÐÐÁÒÁÔÎÏ"

 #define ERR_VOL_LOCKED_SW        "ôÏÍ ÂÌÏËÉÒÏ×ÁÎ ÐÒÏÇÒÁÍÍÎÏ"

 #define ERR_FILE_LOCKED          "æÁÊÌ ÚÁÂÌÏËÉÒÏ×ÁÎ"

 #define ERR_FILE_OR_DIR_BUSY     "æÁÊÌ/ËÁÔÁÌÏÇ ÚÁÎÑÔ"

 #define ERR_FILE_ALREADY_OPEN_W  "æÁÊÌ ÕÖÅ ÏÔËÒÙÔ ÎÁ ÚÁÐÉÓØ"

 #define ERR_FILE_ALREADY_OPEN_R  "æÁÊÌ ÕÖÅ ÏÔËÒÙÔ ÎÁ ÞÔÅÎÉÅ"

 #define ERR_INVALID_REFNUM       "îÅ×ÅÒÎÏÅ ËÏÌÉÞÅÓÔ×Ï ÓÓÙÌÏË"

 #define ERR_GETTING_FILE_POS     "ïÛÉÂËÁ ÐÒÉ ÐÏÌÕÞÅÎÉÉ ÐÏÚÉÃÉÉ ÆÁÊÌÁ"

 #define ERR_VOLUME_OFFLINE       "ôÏÍ ÏÔÓÏÅÄÉÎÅÎ"

 #define ERR_PERMISSION_DENIED    "ïÔËÁÚÁÎÏ × ÒÁÚÒÅÛÅÎÉÉ"

 #define ERR_VOL_ALREADY_ONLINE   "ôÏÍ ÕÖÅ ÐÏÄÓÏÅÄÉÎÅÎ"

 #define ERR_NO_SUCH_DRIVE        "îÅÔ ÔÁËÏÇÏ ÄÉÓËÁ"

 #define ERR_NOT_MAC_DISK         "îÅ ÄÉÓË Macintosh"

 #define ERR_VOL_EXTERNAL_FS      "ôÏÍ ÐÒÉÎÁÄÌÅÖÉÔ ×ÎÅÛÎÅÊ ÆÁÊÌÏ×ÏÊ ÓÉÓÔÅÍÅ"

 #define ERR_PROBLEM_RENAME       "ðÒÏÂÌÅÍÁ ÐÒÉ ÐÅÒÅÉÍÅÎÏ×ÁÎÉÉ"

 #define ERR_BAD_MASTER_BLOCK     "ðÌÏÈÏÊ ÇÌÁ×ÎÙÊ ÂÌÏË ËÁÔÁÌÏÇÁ"

 #define ERR_CANT_MOVE_FORBIDDEN  "ðÏÐÙÔËÁ ÐÅÒÅÍÅÓÔÉÔØ ÚÁÐÒÅÝÅÎÁ"

 #define ERR_WRONG_VOL_TYPE       "îÅ×ÅÒÎÙÊ ÔÉÐ ÔÏÍÁ"

 #define ERR_SERVER_VOL_LOST      "óÅÒ×ÅÒÎÙÊ ÔÏÍ ÂÙÌ ÏÔÓÏÅÄÉÎÅÎ"

 #define ERR_FILE_ID_NOT_FOUND    "éÄÅÎÔÉÆÉËÁÔÏÒ ÆÁÊÌÁ ÎÅ ÎÁÊÄÅÎ"

 #define ERR_FILE_ID_EXISTS       "éÄÅÎÔÉÆÉËÁÔÏÒ ÆÁÊÌÁ ÕÖÅ ÓÕÝÅÓÔ×ÕÅÔ"

 #define ERR_SERVER_NO_RESPOND    "óÅÒ×ÅÒ ÎÅ ÏÔ×ÅÞÁÅÔ"

 #define ERR_USER_AUTH_FAILED     "éÄÅÎÔÉÆÉËÁÃÉÑ ÐÏÌØÚÏ×ÁÔÅÌÑ ÎÅ ÕÄÁÌÁÓØ"

 #define ERR_PWORD_EXPIRED        "ðÁÒÏÌØ ÎÁ ÓÅÒ×ÅÒÅ ÕÓÔÁÒÅÌ"

 #define ERR_ACCESS_DENIED        "ïÔËÁÚÁÎÏ × ÄÏÓÔÕÐÅ"

 #define ERR_NOT_A_DOS_DISK       "îÅ ÄÉÓË DOS"

 #define ERR_SHARING_VIOLATION    "îÁÒÕÛÅÎÉÅ ÓÏ×ÍÅÓÔÎÏÇÏ ÄÏÓÔÕÐÁ"

 #define ERR_CANNOT_MAKE          "îÅ ÍÏÇÕ ÓÏÂÒÁÔØ"

 #define ERR_DEV_IN_USE           "õÓÔÒÏÊÓÔ×Ï ÕÖÅ ÉÓÐÏÌØÚÕÅÔÓÑ"

 #define ERR_OPEN_FAILED          "ïÔËÒÙÔÉÅ ÎÅ ÕÄÁÌÏÓØ"

 #define ERR_PIPE_BUSY            "ëÏÎ×ÅÊÅÒ ÚÁÎÑÔ"

 #define ERR_SHARING_BUF_EXCEEDED "òÁÚÄÅÌÑÅÍÙÊ ÂÕÆÅÒ ÐÅÒÅÐÏÌÎÅÎ"

 #define ERR_TOO_MANY_HANDLES     "óÌÉÛËÏÍ ÍÎÏÇÏ ÏÔËÒÙÔÙÈ ÄÅÓËÒÉÐÔÏÒÏ×"

 #define ERR_SEEK_ERROR           "ïÛÉÂËÁ ÐÏÚÉÃÉÏÎÉÒÏ×ÁÎÉÑ"

 #define ERR_DEL_CWD              "ðÏÐÙÔËÁ ÕÄÁÌÉÔØ ÔÅËÕÝÉÊ ÒÁÂÏÞÉÊ ËÁÔÁÌÏÇ"

 #define ERR_WRITE_PROTECT_ERROR  "ïÛÉÂËÁ ÚÁÝÉÔÙ ÚÁÐÉÓÉ"

 #define ERR_WRITE_FAULT          "ïÛÉÂËÁ ÚÁÐÉÓÉ"

 #define ERR_LOCK_VIOLATION       "îÁÒÕÛÅÎÉÅ ÂÌÏËÉÒÏ×ËÉ"

 #define ERR_GEN_FAILURE          "ïÂÝÉÊ ÓÂÏÊ"

 #define ERR_UNCERTAIN_MEDIA      "îÅÏÐÒÅÄÅÌÅÎÎÙÊ ÎÏÓÉÔÅÌØ"

 #define ERR_PROT_VIOLATION       "îÁÒÕÛÅÎÉÅ ÚÁÝÉÔÙ"

 #define ERR_BROKEN_PIPE          "óÌÏÍÁÎÎÙÊ ËÏÎ×ÅÊÅÒ"

#else

 #error Please define PHYSFS_LANG.

#endif

/* end LANG section. */

struct __PHYSFS_DIRHANDLE__;

struct __PHYSFS_FILEFUNCTIONS__;

typedef struct __PHYSFS_LINKEDSTRINGLIST__

{

    char *str;

    struct __PHYSFS_LINKEDSTRINGLIST__ *next;

} LinkedStringList;

typedef struct __PHYSFS_FILEHANDLE__

{

        /*

         * This is reserved for the driver to store information.

         */

    void *opaque;

        /*

         * This should be the DirHandle that created this FileHandle.

         */

    const struct __PHYSFS_DIRHANDLE__ *dirHandle;

        /*

         * Pointer to the file i/o functions for this filehandle.

         */

    const struct __PHYSFS_FILEFUNCTIONS__ *funcs;

} FileHandle;

typedef struct __PHYSFS_FILEFUNCTIONS__

{

        /*

         * Read more from the file.

         * Returns number of objects of (objSize) bytes read from file, -1

         *  if complete failure.

         * On failure, call __PHYSFS_setError().

         */

    PHYSFS_sint64 (*read)(FileHandle *handle, void *buffer,

                          PHYSFS_uint32 objSize, PHYSFS_uint32 objCount);

        /*

         * Write more to the file. Archives don't have to implement this.

         *  (Set it to NULL if not implemented).

         * Returns number of objects of (objSize) bytes written to file, -1

         *  if complete failure.

         * On failure, call __PHYSFS_setError().

         */

    PHYSFS_sint64 (*write)(FileHandle *handle, const void *buffer,

                 PHYSFS_uint32 objSize, PHYSFS_uint32 objCount);

        /*

         * Returns non-zero if at end of file.

         */

    int (*eof)(FileHandle *handle);

        /*

         * Returns byte offset from start of file.

         */

    PHYSFS_sint64 (*tell)(FileHandle *handle);

        /*

         * Move read/write pointer to byte offset from start of file.

         *  Returns non-zero on success, zero on error.

         * On failure, call __PHYSFS_setError().

         */

    int (*seek)(FileHandle *handle, PHYSFS_uint64 offset);

        /*

         * Return number of bytes available in the file, or -1 if you

         *  aren't able to determine.

         * On failure, call __PHYSFS_setError().

         */

    PHYSFS_sint64 (*fileLength)(FileHandle *handle);

        /*

         * Close the file, and free the FileHandle structure (including "opaque").

         *  returns non-zero on success, zero if can't close file.

         * On failure, call __PHYSFS_setError().

         */

    int (*fileClose)(FileHandle *handle);

} FileFunctions;

typedef struct __PHYSFS_DIRHANDLE__

{

        /*

         * This is reserved for the driver to store information.

         */

    void *opaque;

        /*

         * Pointer to the directory i/o functions for this handle.

         */

    const struct __PHYSFS_DIRFUNCTIONS__ *funcs;

} DirHandle;

/*

 * Symlinks should always be followed; PhysicsFS will use

 *  DirFunctions->isSymLink() and make a judgement on whether to

 *  continue to call other methods based on that.

 */

typedef struct __PHYSFS_DIRFUNCTIONS__

{

    const PHYSFS_ArchiveInfo *info;

        /*

         * Returns non-zero if (filename) is a valid archive that this

         *  driver can handle. This filename is in platform-dependent

         *  notation. forWriting is non-zero if this is to be used for

         *  the write directory, and zero if this is to be used for an

         *  element of the search path.

         */

    int (*isArchive)(const char *filename, int forWriting);

        /*

         * Return a DirHandle for dir/archive (name).

         *  This filename is in platform-dependent notation.

         *  forWriting is non-zero if this is to be used for

         *  the write directory, and zero if this is to be used for an

         *  element of the search path.

         * Returns NULL on failure, and calls __PHYSFS_setError().

         */

    DirHandle *(*openArchive)(const char *name, int forWriting);

        /*

         * Returns a list of all files in dirname. Each element of this list

         *  (and its "str" field) will be deallocated with the system's free()

         *  function by the caller, so be sure to explicitly malloc() each

         *  chunk. Omit symlinks if (omitSymLinks) is non-zero.

         * If you have a memory failure, return as much as you can.

         *  This dirname is in platform-independent notation.

         */

    LinkedStringList *(*enumerateFiles)(DirHandle *r,

                                        const char *dirname,

                                        int omitSymLinks);

        /*

         * Returns non-zero if filename can be opened for reading.

         *  This filename is in platform-independent notation.

         */

    int (*exists)(DirHandle *r, const char *name);

        /*

         * Returns non-zero if filename is really a directory.

         *  This filename is in platform-independent notation.

         *  Symlinks should be followed; if what the symlink points

         *  to is missing, or isn't a directory, then the retval is zero.

         */

    int (*isDirectory)(DirHandle *r, const char *name);

        /*

         * Returns non-zero if filename is really a symlink.

         *  This filename is in platform-independent notation.

         */

    int (*isSymLink)(DirHandle *r, const char *name);

        /*

	     * Retrieve the last modification time (mtime) of a file.

    	 *  Returns -1 on failure, or the file's mtime in seconds since

    	 *  the epoch (Jan 1, 1970) on success.

         *  This filename is in platform-independent notation.

    	 */

    PHYSFS_sint64 (*getLastModTime)(DirHandle *r, const char *filename);

        /*

         * Open file for reading, and return a FileHandle.

         *  This filename is in platform-independent notation.