summaryrefslogtreecommitdiff
path: root/src/files.h
blob: e597e9e251ea0d3acd1a2c30f439345400944c63 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
/*
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    2048
#define MAX_LISTED_DEPTH    8

typedef struct file_info_s {
    size_t  size;
    time_t  ctime;
    time_t  mtime;
    char    name[1];
} file_info_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

/* 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 - 11, flag */
#define FS_SEARCH_BYFILTER      0x00000080
#define FS_SEARCH_SAVEPATH      0x00000100
#define FS_SEARCH_EXTRAINFO     0x00000200
#define FS_SEARCH_STRIPEXT      0x00000400
#define FS_SEARCH_DIRSONLY      0x00000800

/* bits 7 - 8, flag */
#define FS_FLAG_GZIP            0x00000080
#define FS_FLAG_EXCL            0x00000100

// protection from malicious paks causing memory exhaustion
// no loadable Q2 resource should ever exceed this limit
#define MAX_LOADFILE    0x400000 // 64 MiB

// macros for dealing portably with files at OS level
#ifdef _WIN32
#define FS_strcmp   Q_strcasecmp
#define FS_strncmp  Q_strncasecmp
#else
#define FS_strcmp   strcmp
#define FS_strncmp  strncmp
#endif

#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( void );
void    FS_Restart( qboolean total );

#if USE_CLIENT
qerror_t FS_RenameFile( const char *from, const char *to );
#endif

qerror_t FS_CreatePath( char *path );

char    *FS_CopyExtraInfo( const char *name, const file_info_t *info );

ssize_t FS_FOpenFile( const char *filename, qhandle_t *f, unsigned mode );
void    FS_FCloseFile( qhandle_t f );
qhandle_t FS_EasyOpenFile( char *buf, size_t size, unsigned mode,
    const char *dir, const char *name, const char *ext );

qerror_t FS_FilterFile( qhandle_t f );

#define FS_FileExistsEx( path, flags ) \
    ( FS_LoadFileEx( path, NULL, flags ) != Q_ERR_NOENT )
#define FS_FileExists( path ) \
    FS_FileExistsEx( path, 0 )

ssize_t FS_LoadFile( const char *path, void **buffer );
ssize_t FS_LoadFileEx( const char *path, void **buffer, unsigned flags );
void    *FS_AllocTempMem( size_t len );
void    FS_FreeFile( void *buf );
// a null buffer will just return the file length without loading
// a -1 length is not present

qerror_t FS_WriteFile( const char *path, const void *data, size_t len );

ssize_t FS_Read( void *buffer, size_t len, qhandle_t f );
ssize_t FS_Write( const void *buffer, size_t len, qhandle_t f );
// properly handles partial reads

ssize_t FS_FPrintf( qhandle_t f, const char *format, ... ) q_printf( 2, 3 );
ssize_t FS_ReadLine( qhandle_t f, char *buffer, size_t size );

void    FS_Flush( qhandle_t f );

ssize_t FS_Tell( qhandle_t f );
qerror_t FS_Seek( qhandle_t f, size_t offset );

ssize_t  FS_GetFileLength( qhandle_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 *filter, unsigned flags, int *count_p );
void    **FS_CopyList( void **list, int count );
file_info_t *FS_CopyInfo( const char *name, size_t size, time_t ctime, time_t mtime );
void    FS_FreeList( void **list );

unsigned FS_HashPath( const char *s, unsigned size );
#if USE_REF
unsigned FS_HashPathLen( const char *s, size_t len, unsigned size );
#endif

#ifdef _WIN32
char *FS_ReplaceSeparators( char *s, int separator );
#endif

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, unsigned flags, genctx_t *ctx );

extern cvar_t   *fs_game;

extern char     fs_gamedir[];