Crate physfs_sys[−][src]
Structs
\struct PHYSFS_Allocator \brief PhysicsFS allocation function pointers.
\struct PHYSFS_ArchiveInfo \brief Information on various PhysicsFS-supported archives.
\struct PHYSFS_Archiver \brief Abstract interface to provide support for user-defined archives.
\struct PHYSFS_File \brief A PhysicsFS file handle.
\struct PHYSFS_Io \brief An abstract i/o interface.
\struct PHYSFS_Stat \brief Meta data for a file or directory
\struct PHYSFS_Version \brief Information the version of PhysicsFS in use.
Constants
< Stop enumerating, report error to app.
< Keep enumerating, no problems
< Stop enumerating, report success to app.
< Application callback reported error.
< Needed argv[0], but it is NULL.
< Filename is bogus/insecure.
< Bad password.
< Tried to modify a file the OS needs.
< Corrupted data encountered.
< Tried to delete dir with files in it.
< Duplicate entry.
< Files still open.
< Bad parameter passed to an function.
< i/o error (hardware failure, etc).
< PhysicsFS is already initialized.
< Needed a file, got a directory (etc).
< File (or whatever) not found.
< PhysicsFS is not initialized.
< Requested archive/dir not mounted.
< No space (disk full, over quota, etc)
< No write dir has been specified.
< Success; no error.
< Wrote to a file opened for reading.
< Read from a file opened for writing.
< Unspecified OS-level error.
< Error not otherwise covered here.
< Memory allocation failed.
< Attempted to access past end of file.
< Permission denied.
< Wrote to a read-only filesystem.
< Symlink seen when not permitted.
< Infinite symbolic link loop.
< Operation or feature unsupported.
< a directory
< something completely different like a device
< a normal file
< a symlink
Functions
\fn int PHYSFS_addToSearchPath(const char *newDir, int appendToPath) \brief Add an archive or directory to the search path.
\fn int PHYSFS_caseFold(const PHYSFS_uint32 from, PHYSFS_uint32 *to) \brief “Fold” a Unicode codepoint to a lowercase equivalent.
\fn int PHYSFS_close(PHYSFS_File *handle) \brief Close a PhysicsFS filehandle.
\fn int PHYSFS_deinit(void) \brief Deinitialize the PhysicsFS library.
\fn int PHYSFS_delete(const char *filename) \brief Delete a file or directory.
\fn int PHYSFS_deregisterArchiver(const char *ext) \brief Remove an archiver from the system.
\fn int PHYSFS_enumerate(const char *dir, PHYSFS_EnumerateCallback c, void *d) \brief Get a file listing of a search path’s directory, using an application-defined callback, with errors reported.
\fn char **PHYSFS_enumerateFiles(const char *dir) \brief Get a file listing of a search path’s directory.
\fn void PHYSFS_enumerateFilesCallback(const char *dir, PHYSFS_EnumFilesCallback c, void *d) \brief Get a file listing of a search path’s directory, using an application-defined callback.
\fn int PHYSFS_eof(PHYSFS_File *handle) \brief Check for end-of-file state on a PhysicsFS filehandle.
\fn int PHYSFS_exists(const char *fname) \brief Determine if a file exists in the search path.
\fn PHYSFS_sint64 PHYSFS_fileLength(PHYSFS_File *handle) \brief Get total length of a file in bytes.
\fn int PHYSFS_flush(PHYSFS_File *handle) \brief Flush a buffered PhysicsFS file handle.
\fn void PHYSFS_freeList(void *listVar) \brief Deallocate resources of lists returned by PhysicsFS.
\fn const PHYSFS_Allocator *PHYSFS_getAllocator(void) \brief Discover the current allocator.
\fn const char *PHYSFS_getBaseDir(void) \brief Get the path where the application resides.
\fn char **PHYSFS_getCdRomDirs(void) \brief Get an array of paths to available CD-ROM drives.
\fn void PHYSFS_getCdRomDirsCallback(PHYSFS_StringCallback c, void *d) \brief Enumerate CD-ROM directories, using an application-defined callback.
\fn const char *PHYSFS_getDirSeparator(void) \brief Get platform-dependent dir separator string.
\fn const char *PHYSFS_getErrorByCode(PHYSFS_ErrorCode code) \brief Get human-readable description string for a given error code.
\fn const char *PHYSFS_getLastError(void) \brief Get human-readable error information.
\fn PHYSFS_ErrorCode PHYSFS_getLastErrorCode(void) \brief Get machine-readable error information.
\fn PHYSFS_sint64 PHYSFS_getLastModTime(const char *filename) \brief Get the last modification time of a file.
\fn void PHYSFS_getLinkedVersion(PHYSFS_Version *ver) \brief Get the version of PhysicsFS that is linked against your program.
\fn int PHYSFS_getMountPoint(const char *dir) \brief Determine a mounted archive’s mountpoint.
\fn const char *PHYSFS_getPrefDir(const char *org, const char *app) \brief Get the user-and-app-specific path where files can be written.
\fn const char *PHYSFS_getRealDir(const char *filename) \brief Figure out where in the search path a file resides.
\fn char **PHYSFS_getSearchPath(void) \brief Get the current search path.
\fn void PHYSFS_getSearchPathCallback(PHYSFS_StringCallback c, void *d) \brief Enumerate the search path, using an application-defined callback.
\fn const char *PHYSFS_getUserDir(void) \brief Get the path where user’s home directory resides.
\fn const char *PHYSFS_getWriteDir(void) \brief Get path where PhysicsFS will allow file writing.
\fn int PHYSFS_init(const char *argv0) \brief Initialize the PhysicsFS library.
\fn int PHYSFS_isDirectory(const char *fname) \brief Determine if a file in the search path is really a directory.
\fn int PHYSFS_isInit(void) \brief Determine if the PhysicsFS library is initialized.
\fn int PHYSFS_isSymbolicLink(const char *fname) \brief Determine if a file in the search path is really a symbolic link.
\fn int PHYSFS_mkdir(const char *dirName) \brief Create a directory.
\fn int PHYSFS_mount(const char *newDir, const char *mountPoint, int appendToPath) \brief Add an archive or directory to the search path.
\fn int PHYSFS_mountHandle(PHYSFS_File *file, const char *newDir, const char *mountPoint, int appendToPath) \brief Add an archive, contained in a PHYSFS_File handle, to the search path.
\fn int PHYSFS_mountIo(PHYSFS_Io *io, const char *newDir, const char *mountPoint, int appendToPath) \brief Add an archive, built on a PHYSFS_Io, to the search path.
\fn int PHYSFS_mountMemory(const void *buf, PHYSFS_uint64 len, void (*del)(void *), const char *newDir, const char *mountPoint, int appendToPath) \brief Add an archive, contained in a memory buffer, to the search path.
\fn PHYSFS_File *PHYSFS_openAppend(const char *filename) \brief Open a file for appending.
\fn PHYSFS_File *PHYSFS_openRead(const char *filename) \brief Open a file for reading.
\fn PHYSFS_File *PHYSFS_openWrite(const char *filename) \brief Open a file for writing.
\fn void PHYSFS_permitSymbolicLinks(int allow) \brief Enable or disable following of symbolic links.
\fn PHYSFS_sint64 PHYSFS_read(PHYSFS_File *handle, void *buffer, PHYSFS_uint32 objSize, PHYSFS_uint32 objCount) \brief Read data from a PhysicsFS filehandle
\fn PHYSFS_sint64 PHYSFS_readBytes(PHYSFS_File *handle, void *buffer, PHYSFS_uint64 len) \brief Read bytes from a PhysicsFS filehandle
\fn int PHYSFS_readSBE16(PHYSFS_File *file, PHYSFS_sint16 *val) \brief Read and convert a signed 16-bit bigendian value.
\fn int PHYSFS_readSBE32(PHYSFS_File *file, PHYSFS_sint32 *val) \brief Read and convert a signed 32-bit bigendian value.
\fn int PHYSFS_readSBE64(PHYSFS_File *file, PHYSFS_sint64 *val) \brief Read and convert a signed 64-bit bigendian value.
\fn int PHYSFS_readSLE16(PHYSFS_File *file, PHYSFS_sint16 *val) \brief Read and convert a signed 16-bit littleendian value.
\fn int PHYSFS_readSLE32(PHYSFS_File *file, PHYSFS_sint32 *val) \brief Read and convert a signed 32-bit littleendian value.
\fn int PHYSFS_readSLE64(PHYSFS_File *file, PHYSFS_sint64 *val) \brief Read and convert a signed 64-bit littleendian value.
\fn int PHYSFS_readUBE16(PHYSFS_File *file, PHYSFS_uint16 *val) \brief Read and convert an unsigned 16-bit bigendian value.
\fn int PHYSFS_readUBE32(PHYSFS_File *file, PHYSFS_uint32 *val) \brief Read and convert an unsigned 32-bit bigendian value.
\fn int PHYSFS_readUBE64(PHYSFS_File *file, PHYSFS_uint64 *val) \brief Read and convert an unsigned 64-bit bigendian value.
\fn int PHYSFS_readULE16(PHYSFS_File *file, PHYSFS_uint16 *val) \brief Read and convert an unsigned 16-bit littleendian value.
\fn int PHYSFS_readULE32(PHYSFS_File *file, PHYSFS_uint32 *val) \brief Read and convert an unsigned 32-bit littleendian value.
\fn int PHYSFS_readULE64(PHYSFS_File *file, PHYSFS_uint64 *val) \brief Read and convert an unsigned 64-bit littleendian value.
\fn int PHYSFS_registerArchiver(const PHYSFS_Archiver *archiver) \brief Add a new archiver to the system.
\fn int PHYSFS_removeFromSearchPath(const char *oldDir) \brief Remove a directory or archive from the search path.
\fn int PHYSFS_seek(PHYSFS_File *handle, PHYSFS_uint64 pos) \brief Seek to a new position within a PhysicsFS filehandle.
\fn int PHYSFS_setAllocator(const PHYSFS_Allocator *allocator) \brief Hook your own allocation routines into PhysicsFS.
\fn int PHYSFS_setBuffer(PHYSFS_File *handle, PHYSFS_uint64 bufsize) \brief Set up buffering for a PhysicsFS file handle.
\fn void PHYSFS_setErrorCode(PHYSFS_ErrorCode code) \brief Set the current thread’s error code.
\fn int PHYSFS_setSaneConfig(const char *organization, const char *appName, const char *archiveExt, int includeCdRoms, int archivesFirst) \brief Set up sane, default paths.
\fn int PHYSFS_setWriteDir(const char *newDir) \brief Tell PhysicsFS where it may write files.
\fn int PHYSFS_stat(const char *fname, PHYSFS_Stat *stat) \brief Get various information about a directory or a file.
\fn const PHYSFS_ArchiveInfo **PHYSFS_supportedArchiveTypes(void) \brief Get a list of supported archive types.
\fn PHYSFS_sint16 PHYSFS_swapSBE16(PHYSFS_sint16 val) \brief Swap bigendian signed 16 to platform’s native byte order.
\fn PHYSFS_sint32 PHYSFS_swapSBE32(PHYSFS_sint32 val) \brief Swap bigendian signed 32 to platform’s native byte order.
\fn PHYSFS_sint64 PHYSFS_swapSBE64(PHYSFS_sint64 val) \brief Swap bigendian signed 64 to platform’s native byte order.
\fn PHYSFS_sint16 PHYSFS_swapSLE16(PHYSFS_sint16 val) \brief Swap littleendian signed 16 to platform’s native byte order.
\fn PHYSFS_sint32 PHYSFS_swapSLE32(PHYSFS_sint32 val) \brief Swap littleendian signed 32 to platform’s native byte order.
\fn PHYSFS_sint64 PHYSFS_swapSLE64(PHYSFS_sint64 val) \brief Swap littleendian signed 64 to platform’s native byte order.
\fn PHYSFS_uint16 PHYSFS_swapUBE16(PHYSFS_uint16 val) \brief Swap bigendian unsigned 16 to platform’s native byte order.
\fn PHYSFS_uint32 PHYSFS_swapUBE32(PHYSFS_uint32 val) \brief Swap bigendian unsigned 32 to platform’s native byte order.
\fn PHYSFS_uint64 PHYSFS_swapUBE64(PHYSFS_uint64 val) \brief Swap bigendian unsigned 64 to platform’s native byte order.
\fn PHYSFS_uint16 PHYSFS_swapULE16(PHYSFS_uint16 val) \brief Swap littleendian unsigned 16 to platform’s native byte order.
\fn PHYSFS_uint32 PHYSFS_swapULE32(PHYSFS_uint32 val) \brief Swap littleendian unsigned 32 to platform’s native byte order.
\fn PHYSFS_uint64 PHYSFS_swapULE64(PHYSFS_uint64 val) \brief Swap littleendian unsigned 64 to platform’s native byte order.
\fn int PHYSFS_symbolicLinksPermitted(void) \brief Determine if the symbolic links are permitted.
\fn PHYSFS_sint64 PHYSFS_tell(PHYSFS_File *handle) \brief Determine current position within a PhysicsFS filehandle.
\fn int PHYSFS_ucs4stricmp(const PHYSFS_uint32 *str1, const PHYSFS_uint32 *str2) \brief Case-insensitive compare of two UCS-4 strings.
\fn int PHYSFS_unmount(const char *oldDir) \brief Remove a directory or archive from the search path.
\fn void PHYSFS_utf8FromLatin1(const char *src, char *dst, PHYSFS_uint64 len) \brief Convert a UTF-8 string to a Latin1 string.
\fn void PHYSFS_utf8FromUcs2(const PHYSFS_uint16 *src, char *dst, PHYSFS_uint64 len) \brief Convert a UCS-2 string to a UTF-8 string.
\fn void PHYSFS_utf8FromUcs4(const PHYSFS_uint32 *src, char *dst, PHYSFS_uint64 len) \brief Convert a UCS-4 string to a UTF-8 string.
\fn void PHYSFS_utf8FromUtf16(const PHYSFS_uint16 *src, char *dst, PHYSFS_uint64 len) \brief Convert a UTF-16 string to a UTF-8 string.
\fn PHYSFS_utf8ToUcs2(const char *src, PHYSFS_uint16 *dst, PHYSFS_uint64 len) \brief Convert a UTF-8 string to a UCS-2 string.
\fn void PHYSFS_utf8ToUcs4(const char *src, PHYSFS_uint32 *dst, PHYSFS_uint64 len) \brief Convert a UTF-8 string to a UCS-4 string.
\fn PHYSFS_utf8ToUtf16(const char *src, PHYSFS_uint16 *dst, PHYSFS_uint64 len) \brief Convert a UTF-8 string to a UTF-16 string.
\fn int PHYSFS_utf8stricmp(const char *str1, const char *str2) \brief Case-insensitive compare of two UTF-8 strings.
\fn int PHYSFS_utf16stricmp(const PHYSFS_uint16 *str1, const PHYSFS_uint16 *str2) \brief Case-insensitive compare of two UTF-16 strings.
\fn PHYSFS_sint64 PHYSFS_write(PHYSFS_File *handle, const void *buffer, PHYSFS_uint32 objSize, PHYSFS_uint32 objCount) \brief Write data to a PhysicsFS filehandle
\fn PHYSFS_sint64 PHYSFS_writeBytes(PHYSFS_File *handle, const void *buffer, PHYSFS_uint64 len) \brief Write data to a PhysicsFS filehandle
\fn int PHYSFS_writeSBE16(PHYSFS_File *file, PHYSFS_sint16 val) \brief Convert and write a signed 16-bit bigendian value.
\fn int PHYSFS_writeSBE32(PHYSFS_File *file, PHYSFS_sint32 val) \brief Convert and write a signed 32-bit bigendian value.
\fn int PHYSFS_writeSBE64(PHYSFS_File *file, PHYSFS_sint64 val) \brief Convert and write a signed 64-bit bigending value.
\fn int PHYSFS_writeSLE16(PHYSFS_File *file, PHYSFS_sint16 val) \brief Convert and write a signed 16-bit littleendian value.
\fn int PHYSFS_writeSLE32(PHYSFS_File *file, PHYSFS_sint32 val) \brief Convert and write a signed 32-bit littleendian value.
\fn int PHYSFS_writeSLE64(PHYSFS_File *file, PHYSFS_sint64 val) \brief Convert and write a signed 64-bit littleendian value.
\fn int PHYSFS_writeUBE16(PHYSFS_File *file, PHYSFS_uint16 val) \brief Convert and write an unsigned 16-bit bigendian value.
\fn int PHYSFS_writeUBE32(PHYSFS_File *file, PHYSFS_uint32 val) \brief Convert and write an unsigned 32-bit bigendian value.
\fn int PHYSFS_writeUBE64(PHYSFS_File *file, PHYSFS_uint64 val) \brief Convert and write an unsigned 64-bit bigendian value.
\fn int PHYSFS_writeULE16(PHYSFS_File *file, PHYSFS_uint16 val) \brief Convert and write an unsigned 16-bit littleendian value.
\fn int PHYSFS_writeULE32(PHYSFS_File *file, PHYSFS_uint32 val) \brief Convert and write an unsigned 32-bit littleendian value.
\fn int PHYSFS_writeULE64(PHYSFS_File *file, PHYSFS_uint64 val) \brief Convert and write an unsigned 64-bit littleendian value.
Type Definitions
\typedef PHYSFS_EnumFilesCallback \brief Function signature for callbacks that enumerate files.
\typedef PHYSFS_EnumerateCallback \brief Function signature for callbacks that enumerate and return results.
\typedef PHYSFS_EnumerateCallback \brief Possible return values from PHYSFS_EnumerateCallback.
\enum PHYSFS_ErrorCode \brief Values that represent specific causes of failure.
\enum PHYSFS_FileType \brief Type of a File
\typedef PHYSFS_StringCallback \brief Function signature for callbacks that report strings.
\typedef PHYSFS_sint8 \brief A signed, 8-bit integer type.
\typedef PHYSFS_sint16 \brief A signed, 16-bit integer type.
\typedef PHYSFS_sint32 \brief A signed, 32-bit integer type.
\typedef PHYSFS_uint8 \brief An unsigned, 8-bit integer type.
\typedef PHYSFS_uint16 \brief An unsigned, 16-bit integer type.
\typedef PHYSFS_uint32 \brief An unsigned, 32-bit integer type.