5589af7a75652a4b6f2cd8cd07a76578f744ee4e
[divverent/darkplaces.git] / fs.h
1 /*
2         DarkPlaces file system
3
4         Copyright (C) 2003-2005 Mathieu Olivier
5
6         This program is free software; you can redistribute it and/or
7         modify it under the terms of the GNU General Public License
8         as published by the Free Software Foundation; either version 2
9         of the License, or (at your option) any later version.
10
11         This program is distributed in the hope that it will be useful,
12         but WITHOUT ANY WARRANTY; without even the implied warranty of
13         MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
14
15         See the GNU General Public License for more details.
16
17         You should have received a copy of the GNU General Public License
18         along with this program; if not, write to:
19
20                 Free Software Foundation, Inc.
21                 59 Temple Place - Suite 330
22                 Boston, MA  02111-1307, USA
23 */
24
25 #ifndef FS_H
26 #define FS_H
27
28
29 // ------ Types ------ //
30
31 typedef struct qfile_s qfile_t;
32
33 #ifdef WIN32
34 typedef long fs_offset_t; // 32bit
35 //typedef _int64 fs_offset_t; // 64bit (lots of warnings, and lseek/read/write still don't take 64bit on win64)
36 #else
37 typedef long long fs_offset_t;
38 #endif
39
40
41
42 // ------ Variables ------ //
43
44 extern char fs_gamedir [MAX_OSPATH];
45 extern char fs_basedir [MAX_OSPATH];
46
47
48
49 // ------ Main functions ------ //
50
51 // IMPORTANT: the file path is automatically prefixed by the current game directory for
52 // each file created by FS_WriteFile, or opened in "write" or "append" mode by FS_Open
53
54 qboolean FS_AddPack(const char *pakfile, qboolean *already_loaded, qboolean keep_plain_dirs); // already_loaded may be NULL if caller does not care
55 const char *FS_WhichPack(const char *filename);
56 qfile_t *FS_Open (const char* filepath, const char* mode, qboolean quiet, qboolean nonblocking);
57 int FS_Close (qfile_t* file);
58 fs_offset_t FS_Write (qfile_t* file, const void* data, size_t datasize);
59 fs_offset_t FS_Read (qfile_t* file, void* buffer, size_t buffersize);
60 int FS_Print(qfile_t* file, const char *msg);
61 int FS_Printf(qfile_t* file, const char* format, ...) DP_FUNC_PRINTF(2);
62 int FS_VPrintf(qfile_t* file, const char* format, va_list ap);
63 int FS_Getc (qfile_t* file);
64 int FS_UnGetc (qfile_t* file, unsigned char c);
65 int FS_Seek (qfile_t* file, fs_offset_t offset, int whence);
66 fs_offset_t FS_Tell (qfile_t* file);
67 void FS_Purge (qfile_t* file);
68 int FS_CheckNastyPath (const char *path, qboolean isgamedir);
69 qboolean FS_ChangeGameDir(const char *string);
70
71 typedef struct fssearch_s
72 {
73         int numfilenames;
74         char **filenames;
75         // array of filenames
76         char *filenamesbuffer;
77 }
78 fssearch_t;
79
80 fssearch_t *FS_Search(const char *pattern, int caseinsensitive, int quiet);
81 void FS_FreeSearch(fssearch_t *search);
82
83 unsigned char *FS_LoadFile (const char *path, mempool_t *pool, qboolean quiet, fs_offset_t *filesizepointer);
84 qboolean FS_WriteFile (const char *filename, void *data, fs_offset_t len);
85
86
87 // ------ Other functions ------ //
88
89 void FS_StripExtension (const char *in, char *out, size_t size_out);
90 void FS_DefaultExtension (char *path, const char *extension, size_t size_path);
91
92 qboolean FS_FileExists (const char *filename);          // the file can be into a package
93 qboolean FS_SysFileExists (const char *filename);       // only look for files outside of packages
94
95 void FS_mkdir (const char *path);
96
97
98 #endif