allow .alpha to fade out water/refraction/reflection surfaces (only tested on refract...
[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 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 // list of active game directories (empty if not running a mod)
48 #define MAX_GAMEDIRS 16
49 extern int fs_numgamedirs;
50 extern char fs_gamedirs[MAX_GAMEDIRS][MAX_QPATH];
51
52
53 // ------ Main functions ------ //
54
55 // IMPORTANT: the file path is automatically prefixed by the current game directory for
56 // each file created by FS_WriteFile, or opened in "write" or "append" mode by FS_OpenRealFile
57
58 qboolean FS_AddPack(const char *pakfile, qboolean *already_loaded, qboolean keep_plain_dirs); // already_loaded may be NULL if caller does not care
59 const char *FS_WhichPack(const char *filename);
60 int FS_SysOpenFD(const char *filepath, const char *mode, qboolean nonblocking);
61 qfile_t* FS_OpenRealFile (const char* filepath, const char* mode, qboolean quiet);
62 qfile_t* FS_OpenVirtualFile (const char* filepath, qboolean quiet);
63 qfile_t* FS_FileFromData (const unsigned char *data, const size_t size, qboolean quiet);
64 int FS_Close (qfile_t* file);
65 void FS_RemoveOnClose(qfile_t* file);
66 fs_offset_t FS_Write (qfile_t* file, const void* data, size_t datasize);
67 fs_offset_t FS_Read (qfile_t* file, void* buffer, size_t buffersize);
68 int FS_Print(qfile_t* file, const char *msg);
69 int FS_Printf(qfile_t* file, const char* format, ...) DP_FUNC_PRINTF(2);
70 int FS_VPrintf(qfile_t* file, const char* format, va_list ap);
71 int FS_Getc (qfile_t* file);
72 int FS_UnGetc (qfile_t* file, unsigned char c);
73 int FS_Seek (qfile_t* file, fs_offset_t offset, int whence);
74 fs_offset_t FS_Tell (qfile_t* file);
75 fs_offset_t FS_FileSize (qfile_t* file);
76 void FS_Purge (qfile_t* file);
77 const char *FS_FileWithoutPath (const char *in);
78 const char *FS_FileExtension (const char *in);
79 int FS_CheckNastyPath (const char *path, qboolean isgamedir);
80
81 extern const char *const fs_checkgamedir_missing; // "(missing)"
82 const char *FS_CheckGameDir(const char *gamedir); // returns NULL if nasty, fs_checkgamedir_missing (exact pointer) if missing
83
84 typedef struct
85 {
86         char name[MAX_OSPATH];
87         char description[8192];
88 }
89 gamedir_t;
90 extern gamedir_t *fs_all_gamedirs; // terminated by entry with empty name
91 extern int fs_all_gamedirs_count;
92
93 qboolean FS_ChangeGameDirs(int numgamedirs, char gamedirs[][MAX_QPATH], qboolean complain, qboolean failmissing);
94 qboolean FS_IsRegisteredQuakePack(const char *name);
95 int FS_CRCFile(const char *filename, size_t *filesizepointer);
96 void FS_Rescan(void);
97
98 typedef struct fssearch_s
99 {
100         int numfilenames;
101         char **filenames;
102         // array of filenames
103         char *filenamesbuffer;
104 }
105 fssearch_t;
106
107 fssearch_t *FS_Search(const char *pattern, int caseinsensitive, int quiet);
108 void FS_FreeSearch(fssearch_t *search);
109
110 unsigned char *FS_LoadFile (const char *path, mempool_t *pool, qboolean quiet, fs_offset_t *filesizepointer);
111 qboolean FS_WriteFileInBlocks (const char *filename, const void *const *data, const fs_offset_t *len, size_t count);
112 qboolean FS_WriteFile (const char *filename, const void *data, fs_offset_t len);
113
114
115 // ------ Other functions ------ //
116
117 void FS_StripExtension (const char *in, char *out, size_t size_out);
118 void FS_DefaultExtension (char *path, const char *extension, size_t size_path);
119
120 #define FS_FILETYPE_NONE 0
121 #define FS_FILETYPE_FILE 1
122 #define FS_FILETYPE_DIRECTORY 2
123 int FS_FileType (const char *filename);         // the file can be into a package
124 int FS_SysFileType (const char *filename);              // only look for files outside of packages
125
126 qboolean FS_FileExists (const char *filename);          // the file can be into a package
127 qboolean FS_SysFileExists (const char *filename);       // only look for files outside of packages
128
129 void FS_mkdir (const char *path);
130
131 unsigned char *FS_Deflate(const unsigned char *data, size_t size, size_t *deflated_size, int level, mempool_t *mempool);
132 unsigned char *FS_Inflate(const unsigned char *data, size_t size, size_t *inflated_size, mempool_t *mempool);
133
134 qboolean FS_HasZlib(void);
135
136 #endif