physfs.h

Go to the documentation of this file.

#ifndef _INCLUDE_PHYSFS_H_
#define _INCLUDE_PHYSFS_H_

#ifdef __cplusplus
extern "C" {
#endif

#if defined(PHYSFS_DECL)
/* do nothing. */
#elif (defined _MSC_VER)
#define PHYSFS_DECL __declspec(dllexport)
#elif (defined __SUNPRO_C)
#define PHYSFS_DECL __global
#elif ((__GNUC__ >= 3) && (!__EMX__) && (!sun))
#define PHYSFS_DECL __attribute__((visibility("default")))
#else
#define PHYSFS_DECL
#endif

#if defined(PHYSFS_DEPRECATED)
/* do nothing. */
#elif (__GNUC__ >= 4)  /* technically, this arrived in gcc 3.1, but oh well. */
#define PHYSFS_DEPRECATED __attribute__((deprecated))
#else
#define PHYSFS_DEPRECATED
#endif

#if 0  /* !!! FIXME: look into this later. */
#if defined(PHYSFS_CALL)
/* do nothing. */
#elif defined(__WIN32__) && !defined(__GNUC__)
#define PHYSFS_CALL __cdecl
#elif defined(__OS2__) || defined(OS2) /* should work across all compilers. */
#define PHYSFS_CALL _System
#else
#define PHYSFS_CALL
#endif
#endif

typedef unsigned char         PHYSFS_uint8;

typedef signed char           PHYSFS_sint8;

typedef unsigned short        PHYSFS_uint16;

typedef signed short          PHYSFS_sint16;

typedef unsigned int          PHYSFS_uint32;

typedef signed int            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_compile_time_assert_##name[(x) * 2 - 1]

PHYSFS_COMPILE_TIME_ASSERT(uint8IsOneByte, sizeof(PHYSFS_uint8) == 1);
PHYSFS_COMPILE_TIME_ASSERT(sint8IsOneByte, sizeof(PHYSFS_sint8) == 1);
PHYSFS_COMPILE_TIME_ASSERT(uint16IsTwoBytes, sizeof(PHYSFS_uint16) == 2);
PHYSFS_COMPILE_TIME_ASSERT(sint16IsTwoBytes, sizeof(PHYSFS_sint16) == 2);
PHYSFS_COMPILE_TIME_ASSERT(uint32IsFourBytes, sizeof(PHYSFS_uint32) == 4);
PHYSFS_COMPILE_TIME_ASSERT(sint32IsFourBytes, sizeof(PHYSFS_sint32) == 4);

#ifndef PHYSFS_NO_64BIT_SUPPORT
PHYSFS_COMPILE_TIME_ASSERT(uint64IsEightBytes, sizeof(PHYSFS_uint64) == 8);
PHYSFS_COMPILE_TIME_ASSERT(sint64IsEightBytes, sizeof(PHYSFS_sint64) == 8);
#endif

#undef PHYSFS_COMPILE_TIME_ASSERT

#endif  /* DOXYGEN_SHOULD_IGNORE_THIS */


typedef struct PHYSFS_File
{
    void *opaque;  
} PHYSFS_File;


#define PHYSFS_file PHYSFS_File


typedef struct PHYSFS_ArchiveInfo
{
    const char *extension;   
    const char *description; 
    const char *author;      
    const char *url;         
    int supportsSymlinks;    
} PHYSFS_ArchiveInfo;


typedef struct PHYSFS_Version
{
    PHYSFS_uint8 major; 
    PHYSFS_uint8 minor; 
    PHYSFS_uint8 patch; 
} PHYSFS_Version;


#ifndef DOXYGEN_SHOULD_IGNORE_THIS
#define PHYSFS_VER_MAJOR 3
#define PHYSFS_VER_MINOR 0
#define PHYSFS_VER_PATCH 1
#endif  /* DOXYGEN_SHOULD_IGNORE_THIS */


/* PhysicsFS state stuff ... */

#define PHYSFS_VERSION(x) \
{ \
    (x)->major = PHYSFS_VER_MAJOR; \
    (x)->minor = PHYSFS_VER_MINOR; \
    (x)->patch = PHYSFS_VER_PATCH; \
}


PHYSFS_DECL void PHYSFS_getLinkedVersion(PHYSFS_Version *ver);


PHYSFS_DECL int PHYSFS_init(const char *argv0);


PHYSFS_DECL int PHYSFS_deinit(void);


PHYSFS_DECL const PHYSFS_ArchiveInfo **PHYSFS_supportedArchiveTypes(void);


PHYSFS_DECL void PHYSFS_freeList(void *listVar);


PHYSFS_DECL const char *PHYSFS_getLastError(void) PHYSFS_DEPRECATED;


PHYSFS_DECL const char *PHYSFS_getDirSeparator(void);


PHYSFS_DECL void PHYSFS_permitSymbolicLinks(int allow);


PHYSFS_DECL char **PHYSFS_getCdRomDirs(void);


PHYSFS_DECL const char *PHYSFS_getBaseDir(void);


PHYSFS_DECL const char *PHYSFS_getUserDir(void) PHYSFS_DEPRECATED;


PHYSFS_DECL const char *PHYSFS_getWriteDir(void);


PHYSFS_DECL int PHYSFS_setWriteDir(const char *newDir);


PHYSFS_DECL int PHYSFS_addToSearchPath(const char *newDir, int appendToPath)
                                        PHYSFS_DEPRECATED;

PHYSFS_DECL int PHYSFS_removeFromSearchPath(const char *oldDir)
                                            PHYSFS_DEPRECATED;


PHYSFS_DECL char **PHYSFS_getSearchPath(void);


PHYSFS_DECL int PHYSFS_setSaneConfig(const char *organization,
                                     const char *appName,
                                     const char *archiveExt,
                                     int includeCdRoms,
                                     int archivesFirst);


/* Directory management stuff ... */

PHYSFS_DECL int PHYSFS_mkdir(const char *dirName);


PHYSFS_DECL int PHYSFS_delete(const char *filename);


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


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


PHYSFS_DECL int PHYSFS_exists(const char *fname);


PHYSFS_DECL int PHYSFS_isDirectory(const char *fname) PHYSFS_DEPRECATED;


PHYSFS_DECL int PHYSFS_isSymbolicLink(const char *fname) PHYSFS_DEPRECATED;


PHYSFS_DECL PHYSFS_sint64 PHYSFS_getLastModTime(const char *filename)
                                                PHYSFS_DEPRECATED;


/* i/o stuff... */

PHYSFS_DECL PHYSFS_File *PHYSFS_openWrite(const char *filename);


PHYSFS_DECL PHYSFS_File *PHYSFS_openAppend(const char *filename);


PHYSFS_DECL PHYSFS_File *PHYSFS_openRead(const char *filename);


PHYSFS_DECL int PHYSFS_close(PHYSFS_File *handle);


PHYSFS_DECL PHYSFS_sint64 PHYSFS_read(PHYSFS_File *handle,
                                      void *buffer,
                                      PHYSFS_uint32 objSize,
                                      PHYSFS_uint32 objCount)
                                        PHYSFS_DEPRECATED;

PHYSFS_DECL PHYSFS_sint64 PHYSFS_write(PHYSFS_File *handle,
                                       const void *buffer,
                                       PHYSFS_uint32 objSize,
                                       PHYSFS_uint32 objCount)
                                        PHYSFS_DEPRECATED;


/* File position stuff... */

PHYSFS_DECL int PHYSFS_eof(PHYSFS_File *handle);


PHYSFS_DECL PHYSFS_sint64 PHYSFS_tell(PHYSFS_File *handle);


PHYSFS_DECL int PHYSFS_seek(PHYSFS_File *handle, PHYSFS_uint64 pos);


PHYSFS_DECL PHYSFS_sint64 PHYSFS_fileLength(PHYSFS_File *handle);


/* Buffering stuff... */

PHYSFS_DECL int PHYSFS_setBuffer(PHYSFS_File *handle, PHYSFS_uint64 bufsize);


PHYSFS_DECL int PHYSFS_flush(PHYSFS_File *handle);


/* Byteorder stuff... */

PHYSFS_DECL PHYSFS_sint16 PHYSFS_swapSLE16(PHYSFS_sint16 val);


PHYSFS_DECL PHYSFS_uint16 PHYSFS_swapULE16(PHYSFS_uint16 val);

PHYSFS_DECL PHYSFS_sint32 PHYSFS_swapSLE32(PHYSFS_sint32 val);


PHYSFS_DECL PHYSFS_uint32 PHYSFS_swapULE32(PHYSFS_uint32 val);

PHYSFS_DECL PHYSFS_sint64 PHYSFS_swapSLE64(PHYSFS_sint64 val);


PHYSFS_DECL PHYSFS_uint64 PHYSFS_swapULE64(PHYSFS_uint64 val);


PHYSFS_DECL PHYSFS_sint16 PHYSFS_swapSBE16(PHYSFS_sint16 val);


PHYSFS_DECL PHYSFS_uint16 PHYSFS_swapUBE16(PHYSFS_uint16 val);

PHYSFS_DECL PHYSFS_sint32 PHYSFS_swapSBE32(PHYSFS_sint32 val);


PHYSFS_DECL PHYSFS_uint32 PHYSFS_swapUBE32(PHYSFS_uint32 val);


PHYSFS_DECL PHYSFS_sint64 PHYSFS_swapSBE64(PHYSFS_sint64 val);


PHYSFS_DECL PHYSFS_uint64 PHYSFS_swapUBE64(PHYSFS_uint64 val);


PHYSFS_DECL int PHYSFS_readSLE16(PHYSFS_File *file, PHYSFS_sint16 *val);


PHYSFS_DECL int PHYSFS_readULE16(PHYSFS_File *file, PHYSFS_uint16 *val);


PHYSFS_DECL int PHYSFS_readSBE16(PHYSFS_File *file, PHYSFS_sint16 *val);


PHYSFS_DECL int PHYSFS_readUBE16(PHYSFS_File *file, PHYSFS_uint16 *val);


PHYSFS_DECL int PHYSFS_readSLE32(PHYSFS_File *file, PHYSFS_sint32 *val);


PHYSFS_DECL int PHYSFS_readULE32(PHYSFS_File *file, PHYSFS_uint32 *val);


PHYSFS_DECL int PHYSFS_readSBE32(PHYSFS_File *file, PHYSFS_sint32 *val);


PHYSFS_DECL int PHYSFS_readUBE32(PHYSFS_File *file, PHYSFS_uint32 *val);


PHYSFS_DECL int PHYSFS_readSLE64(PHYSFS_File *file, PHYSFS_sint64 *val);


PHYSFS_DECL int PHYSFS_readULE64(PHYSFS_File *file, PHYSFS_uint64 *val);


PHYSFS_DECL int PHYSFS_readSBE64(PHYSFS_File *file, PHYSFS_sint64 *val);


PHYSFS_DECL int PHYSFS_readUBE64(PHYSFS_File *file, PHYSFS_uint64 *val);


PHYSFS_DECL int PHYSFS_writeSLE16(PHYSFS_File *file, PHYSFS_sint16 val);


PHYSFS_DECL int PHYSFS_writeULE16(PHYSFS_File *file, PHYSFS_uint16 val);


PHYSFS_DECL int PHYSFS_writeSBE16(PHYSFS_File *file, PHYSFS_sint16 val);


PHYSFS_DECL int PHYSFS_writeUBE16(PHYSFS_File *file, PHYSFS_uint16 val);


PHYSFS_DECL int PHYSFS_writeSLE32(PHYSFS_File *file, PHYSFS_sint32 val);


PHYSFS_DECL int PHYSFS_writeULE32(PHYSFS_File *file, PHYSFS_uint32 val);


PHYSFS_DECL int PHYSFS_writeSBE32(PHYSFS_File *file, PHYSFS_sint32 val);


PHYSFS_DECL int PHYSFS_writeUBE32(PHYSFS_File *file, PHYSFS_uint32 val);


PHYSFS_DECL int PHYSFS_writeSLE64(PHYSFS_File *file, PHYSFS_sint64 val);


PHYSFS_DECL int PHYSFS_writeULE64(PHYSFS_File *file, PHYSFS_uint64 val);


PHYSFS_DECL int PHYSFS_writeSBE64(PHYSFS_File *file, PHYSFS_sint64 val);


PHYSFS_DECL int PHYSFS_writeUBE64(PHYSFS_File *file, PHYSFS_uint64 val);


/* Everything above this line is part of the PhysicsFS 1.0 API. */

PHYSFS_DECL int PHYSFS_isInit(void);


PHYSFS_DECL int PHYSFS_symbolicLinksPermitted(void);


typedef struct PHYSFS_Allocator
{
    int (*Init)(void);   
    void (*Deinit)(void);  
    void *(*Malloc)(PHYSFS_uint64);  
    void *(*Realloc)(void *, PHYSFS_uint64); 
    void (*Free)(void *); 
} PHYSFS_Allocator;


PHYSFS_DECL int PHYSFS_setAllocator(const PHYSFS_Allocator *allocator);


PHYSFS_DECL int PHYSFS_mount(const char *newDir,
                             const char *mountPoint,
                             int appendToPath);

PHYSFS_DECL const char *PHYSFS_getMountPoint(const char *dir);


typedef void (*PHYSFS_StringCallback)(void *data, const char *str);


typedef void (*PHYSFS_EnumFilesCallback)(void *data, const char *origdir,
                                         const char *fname);


PHYSFS_DECL void PHYSFS_getCdRomDirsCallback(PHYSFS_StringCallback c, void *d);


PHYSFS_DECL void PHYSFS_getSearchPathCallback(PHYSFS_StringCallback c, void *d);


PHYSFS_DECL void PHYSFS_enumerateFilesCallback(const char *dir,
                                               PHYSFS_EnumFilesCallback c,
                                               void *d) PHYSFS_DEPRECATED;

PHYSFS_DECL void PHYSFS_utf8FromUcs4(const PHYSFS_uint32 *src, char *dst,
                                     PHYSFS_uint64 len);

PHYSFS_DECL void PHYSFS_utf8ToUcs4(const char *src, PHYSFS_uint32 *dst,
                                   PHYSFS_uint64 len);

PHYSFS_DECL void PHYSFS_utf8FromUcs2(const PHYSFS_uint16 *src, char *dst,
                                     PHYSFS_uint64 len);

PHYSFS_DECL void PHYSFS_utf8ToUcs2(const char *src, PHYSFS_uint16 *dst,
                                   PHYSFS_uint64 len);

PHYSFS_DECL void PHYSFS_utf8FromLatin1(const char *src, char *dst,
                                       PHYSFS_uint64 len);

/* Everything above this line is part of the PhysicsFS 2.0 API. */

PHYSFS_DECL int PHYSFS_caseFold(const PHYSFS_uint32 from, PHYSFS_uint32 *to);


PHYSFS_DECL int PHYSFS_utf8stricmp(const char *str1, const char *str2);

PHYSFS_DECL int PHYSFS_utf16stricmp(const PHYSFS_uint16 *str1,
                                    const PHYSFS_uint16 *str2);

PHYSFS_DECL int PHYSFS_ucs4stricmp(const PHYSFS_uint32 *str1,
                                   const PHYSFS_uint32 *str2);


typedef enum PHYSFS_EnumerateCallbackResult
{
    PHYSFS_ENUM_ERROR = -1,   
    PHYSFS_ENUM_STOP = 0,     
    PHYSFS_ENUM_OK = 1        
} PHYSFS_EnumerateCallbackResult;

typedef PHYSFS_EnumerateCallbackResult (*PHYSFS_EnumerateCallback)(void *data,
                                       const char *origdir, const char *fname);

PHYSFS_DECL int PHYSFS_enumerate(const char *dir, PHYSFS_EnumerateCallback c,
                                 void *d);


PHYSFS_DECL int PHYSFS_unmount(const char *oldDir);


PHYSFS_DECL const PHYSFS_Allocator *PHYSFS_getAllocator(void);


typedef enum PHYSFS_FileType
{
    PHYSFS_FILETYPE_REGULAR, 
    PHYSFS_FILETYPE_DIRECTORY, 
    PHYSFS_FILETYPE_SYMLINK, 
    PHYSFS_FILETYPE_OTHER 
} PHYSFS_FileType;

typedef struct PHYSFS_Stat
{
    PHYSFS_sint64 filesize; 
    PHYSFS_sint64 modtime;  
    PHYSFS_sint64 createtime; 
    PHYSFS_sint64 accesstime; 
    PHYSFS_FileType filetype; 
    int readonly; 
} PHYSFS_Stat;

PHYSFS_DECL int PHYSFS_stat(const char *fname, PHYSFS_Stat *stat);


PHYSFS_DECL void PHYSFS_utf8FromUtf16(const PHYSFS_uint16 *src, char *dst,
                                      PHYSFS_uint64 len);

PHYSFS_DECL void PHYSFS_utf8ToUtf16(const char *src, PHYSFS_uint16 *dst,
                                    PHYSFS_uint64 len);


PHYSFS_DECL PHYSFS_sint64 PHYSFS_readBytes(PHYSFS_File *handle, void *buffer,
                                           PHYSFS_uint64 len);

PHYSFS_DECL PHYSFS_sint64 PHYSFS_writeBytes(PHYSFS_File *handle,
                                            const void *buffer,
                                            PHYSFS_uint64 len);


typedef struct PHYSFS_Io
{
    PHYSFS_uint32 version;

    void *opaque;

    PHYSFS_sint64 (*read)(struct PHYSFS_Io *io, void *buf, PHYSFS_uint64 len);

    PHYSFS_sint64 (*write)(struct PHYSFS_Io *io, const void *buffer,
                           PHYSFS_uint64 len);

    int (*seek)(struct PHYSFS_Io *io, PHYSFS_uint64 offset);

    PHYSFS_sint64 (*tell)(struct PHYSFS_Io *io);

    PHYSFS_sint64 (*length)(struct PHYSFS_Io *io);

    struct PHYSFS_Io *(*duplicate)(struct PHYSFS_Io *io);

    int (*flush)(struct PHYSFS_Io *io);

    void (*destroy)(struct PHYSFS_Io *io);
} PHYSFS_Io;


PHYSFS_DECL int PHYSFS_mountIo(PHYSFS_Io *io, const char *newDir,
                               const char *mountPoint, int appendToPath);


PHYSFS_DECL int PHYSFS_mountMemory(const void *buf, PHYSFS_uint64 len,
                                   void (*del)(void *), const char *newDir,
                                   const char *mountPoint, int appendToPath);


PHYSFS_DECL int PHYSFS_mountHandle(PHYSFS_File *file, const char *newDir,
                                   const char *mountPoint, int appendToPath);


typedef enum PHYSFS_ErrorCode
{
    PHYSFS_ERR_OK,               
    PHYSFS_ERR_OTHER_ERROR,      
    PHYSFS_ERR_OUT_OF_MEMORY,    
    PHYSFS_ERR_NOT_INITIALIZED,  
    PHYSFS_ERR_IS_INITIALIZED,   
    PHYSFS_ERR_ARGV0_IS_NULL,    
    PHYSFS_ERR_UNSUPPORTED,      
    PHYSFS_ERR_PAST_EOF,         
    PHYSFS_ERR_FILES_STILL_OPEN, 
    PHYSFS_ERR_INVALID_ARGUMENT, 
    PHYSFS_ERR_NOT_MOUNTED,      
    PHYSFS_ERR_NOT_FOUND,        
    PHYSFS_ERR_SYMLINK_FORBIDDEN,
    PHYSFS_ERR_NO_WRITE_DIR,     
    PHYSFS_ERR_OPEN_FOR_READING, 
    PHYSFS_ERR_OPEN_FOR_WRITING, 
    PHYSFS_ERR_NOT_A_FILE,       
    PHYSFS_ERR_READ_ONLY,        
    PHYSFS_ERR_CORRUPT,          
    PHYSFS_ERR_SYMLINK_LOOP,     
    PHYSFS_ERR_IO,               
    PHYSFS_ERR_PERMISSION,       
    PHYSFS_ERR_NO_SPACE,         
    PHYSFS_ERR_BAD_FILENAME,     
    PHYSFS_ERR_BUSY,             
    PHYSFS_ERR_DIR_NOT_EMPTY,    
    PHYSFS_ERR_OS_ERROR,         
    PHYSFS_ERR_DUPLICATE,        
    PHYSFS_ERR_BAD_PASSWORD,     
    PHYSFS_ERR_APP_CALLBACK      
} PHYSFS_ErrorCode;


PHYSFS_DECL PHYSFS_ErrorCode PHYSFS_getLastErrorCode(void);


PHYSFS_DECL const char *PHYSFS_getErrorByCode(PHYSFS_ErrorCode code);

PHYSFS_DECL void PHYSFS_setErrorCode(PHYSFS_ErrorCode code);


PHYSFS_DECL const char *PHYSFS_getPrefDir(const char *org, const char *app);


typedef struct PHYSFS_Archiver
{
    PHYSFS_uint32 version;

    PHYSFS_ArchiveInfo info;

    void *(*openArchive)(PHYSFS_Io *io, const char *name,
                         int forWrite, int *claimed);

    PHYSFS_EnumerateCallbackResult (*enumerate)(void *opaque,
                     const char *dirname, PHYSFS_EnumerateCallback cb,
                     const char *origdir, void *callbackdata);

    PHYSFS_Io *(*openRead)(void *opaque, const char *fnm);

    PHYSFS_Io *(*openWrite)(void *opaque, const char *filename);

    PHYSFS_Io *(*openAppend)(void *opaque, const char *filename);

    int (*remove)(void *opaque, const char *filename);

    int (*mkdir)(void *opaque, const char *filename);

    int (*stat)(void *opaque, const char *fn, PHYSFS_Stat *stat);

    void (*closeArchive)(void *opaque);
} PHYSFS_Archiver;

PHYSFS_DECL int PHYSFS_registerArchiver(const PHYSFS_Archiver *archiver);

PHYSFS_DECL int PHYSFS_deregisterArchiver(const char *ext);


/* Everything above this line is part of the PhysicsFS 2.1 API. */

#ifdef __cplusplus
}
#endif

#endif  /* !defined _INCLUDE_PHYSFS_H_ */

/* end of physfs.h ... */