summaryrefslogtreecommitdiff
path: root/source/files.h
diff options
context:
space:
mode:
Diffstat (limited to 'source/files.h')
-rw-r--r--source/files.h138
1 files changed, 138 insertions, 0 deletions
diff --git a/source/files.h b/source/files.h
new file mode 100644
index 0000000..252499a
--- /dev/null
+++ b/source/files.h
@@ -0,0 +1,138 @@
+/*
+Copyright (C) 1997-2001 Id Software, Inc.
+
+This program is free software; you can redistribute it and/or
+modify it under the terms of the GNU General Public License
+as published by the Free Software Foundation; either version 2
+of the License, or (at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+
+See the GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program; if not, write to the Free Software
+Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+
+*/
+
+#define MAX_LISTED_FILES 4096
+
+typedef struct fsFileInfo_s {
+ size_t size;
+ time_t ctime;
+ time_t mtime;
+ char name[1];
+} fsFileInfo_t;
+
+/* bits 0 - 1, enum */
+#define FS_MODE_APPEND 0x00000000
+#define FS_MODE_READ 0x00000001
+#define FS_MODE_WRITE 0x00000002
+#define FS_MODE_RDWR 0x00000003
+#define FS_MODE_MASK 0x00000003
+
+/* bits 0 - 1, enum */
+#define FS_SEARCHDIRS_NO 0x00000000
+#define FS_SEARCHDIRS_YES 0x00000001
+#define FS_SEARCHDIRS_ONLY 0x00000002
+#define FS_SEARCHDIRS_RESERVED 0x00000003
+#define FS_SEARCHDIRS_MASK 0x00000003
+
+/* bit 2, enum */
+#define FS_FLUSH_NONE 0x00000000
+#define FS_FLUSH_SYNC 0x00000004
+#define FS_FLUSH_MASK 0x00000004
+
+/* bits 3 - 4, enum */
+#define FS_TYPE_ANY 0x00000000
+#define FS_TYPE_REAL 0x00000008
+#define FS_TYPE_PAK 0x00000010
+#define FS_TYPE_RESERVED 0x00000018
+#define FS_TYPE_MASK 0x00000018
+
+/* bits 5 - 6, flag */
+#define FS_PATH_ANY 0x00000000
+#define FS_PATH_BASE 0x00000020
+#define FS_PATH_GAME 0x00000040
+#define FS_PATH_MASK 0x00000060
+
+/* bits 7 - 10, flag */
+#define FS_SEARCH_BYFILTER 0x00000080
+#define FS_SEARCH_SAVEPATH 0x00000100
+#define FS_SEARCH_EXTRAINFO 0x00000200
+#define FS_SEARCH_NOSORT 0x00000400
+
+/* bits 7 - 8, flag */
+#define FS_FLAG_RESERVED1 0x00000080
+#define FS_FLAG_RESERVED2 0x00000100
+
+#define INVALID_LENGTH ((size_t)-1)
+
+#define FS_Malloc( size ) Z_TagMalloc( size, TAG_FILESYSTEM )
+#define FS_Mallocz( size ) Z_TagMallocz( size, TAG_FILESYSTEM )
+#define FS_CopyString( string ) Z_TagCopyString( string, TAG_FILESYSTEM )
+
+void FS_Init( void );
+void FS_Shutdown( qboolean total );
+qboolean FS_NeedRestart( void );
+void FS_Restart( void );
+qboolean FS_SafeToRestart( void );
+
+qboolean FS_CopyFile( const char *src, const char *dst );
+qboolean FS_RemoveFile( const char *path );
+qboolean FS_RenameFile( const char *from, const char *to );
+
+char *FS_CopyExtraInfo( const char *name, const fsFileInfo_t *info );
+
+size_t FS_FOpenFile( const char *filename, fileHandle_t *f, int mode );
+void FS_FCloseFile( fileHandle_t hFile );
+qboolean FS_FilterFile( fileHandle_t f );
+
+size_t FS_LoadFile( const char *path, void **buffer );
+size_t FS_LoadFileEx( const char *path, void **buffer, int flags, memtag_t tag );
+void *FS_AllocTempMem( size_t length );
+void FS_FreeFile( void *buffer );
+// a null buffer will just return the file length without loading
+// a -1 length is not present
+
+size_t FS_Read( void *buffer, size_t len, fileHandle_t hFile );
+size_t FS_Write( const void *buffer, size_t len, fileHandle_t hFile );
+// properly handles partial reads
+
+void FS_FPrintf( fileHandle_t f, const char *format, ... ) q_printf( 2, 3 );
+size_t FS_ReadLine( fileHandle_t f, char *buffer, int size );
+
+void FS_Flush( fileHandle_t f );
+
+int FS_Tell( fileHandle_t f );
+int FS_RawTell( fileHandle_t f );
+
+size_t FS_GetFileLength( fileHandle_t f );
+
+qboolean FS_WildCmp( const char *filter, const char *string );
+qboolean FS_ExtCmp( const char *extension, const char *string );
+
+void **FS_ListFiles( const char *path, const char *extension, int flags, int *numFiles );
+void **FS_CopyList( void **list, int count );
+fsFileInfo_t *FS_CopyInfo( const char *name, size_t size, time_t ctime, time_t mtime );
+void FS_FreeList( void **list );
+
+qboolean FS_LastFileFromPak( void );
+
+void FS_CreatePath( const char *path );
+
+//const char *FS_GetFileName( fileHandle_t f );
+const char *FS_GetFileFullPath( fileHandle_t f );
+
+char *FS_ReplaceSeparators( char *s, int separator );
+
+int FS_pathcmp( const char *s1, const char *s2 );
+int FS_pathcmpn( const char *s1, const char *s2, size_t n );
+
+void FS_File_g( const char *path, const char *ext, int flags, genctx_t *ctx );
+
+extern cvar_t *fs_game;
+