228b75b6ac137a54dd4727ae70577a20c5d076b5
[xonotic/darkplaces.git] / fs.h
1 /*
2         DarkPlaces file system
3
4         Copyright (C) 2003 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
34 // ------ Variables ------ //
35
36 extern char fs_gamedir [MAX_OSPATH];
37 extern char fs_basedir [MAX_OSPATH];
38
39 extern int fs_filesize;  // set by FS_Open (in "read" mode) and FS_LoadFile
40
41
42 // ------ Main functions ------ //
43
44 // IMPORTANT: the file path is automatically prefixed by the current game directory for
45 // each file created by FS_WriteFile, or opened in "write" or "append" mode by FS_Open
46
47 qfile_t *FS_Open (const char* filepath, const char* mode, qboolean quiet);
48 int FS_Close (qfile_t* file);
49 size_t FS_Write (qfile_t* file, const void* data, size_t datasize);
50 size_t FS_Read (qfile_t* file, void* buffer, size_t buffersize);
51 int FS_Flush (qfile_t* file);
52 int FS_Print(qfile_t* file, const char *msg);
53 int FS_Printf(qfile_t* file, const char* format, ...);
54 int FS_Getc (qfile_t* file);
55 int FS_Seek (qfile_t* file, long offset, int whence);
56 long FS_Tell (qfile_t* file);
57 char *FS_Gets (qfile_t* file, char* buffer, int buffersize);
58 char *FS_Getline (qfile_t *file);  // DO NOT FREE the returned buffer
59 int FS_Eof (qfile_t* file);
60
61 typedef struct fssearch_s
62 {
63         int numfilenames;
64         char **filenames;
65         // array of filenames
66         char *filenamesbuffer;
67 }
68 fssearch_t;
69
70 fssearch_t *FS_Search(const char *pattern, int caseinsensitive, int quiet);
71 void FS_FreeSearch(fssearch_t *search);
72
73 qbyte *FS_LoadFile (const char *path, mempool_t *pool, qboolean quiet);
74 qboolean FS_WriteFile (const char *filename, void *data, int len);
75
76
77 // ------ Other functions ------ //
78
79 void FS_StripExtension (const char *in, char *out, size_t size_out);
80 void FS_DefaultExtension (char *path, const char *extension, size_t size_path);
81
82 qboolean FS_FileExists (const char *filename);          // the file can be into a package
83 qboolean FS_SysFileExists (const char *filename);       // only look for files outside of packages
84
85 void FS_mkdir (const char *path);
86
87
88 #endif