/
physfs_internal.h
356 lines (298 loc) · 12 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
/*
* Internal function/structure declaration. Do NOT include in your
* application.
*
* Please see the file LICENSE in the source's root directory.
*
* This file written by Ryan C. Gordon.
*/
#ifndef _INCLUDE_PHYSFS_INTERNAL_H_
#define _INCLUDE_PHYSFS_INTERNAL_H_
#ifndef __PHYSICSFS_INTERNAL__
#error Do not include this header from your applications.
#endif
17
struct __PHYSFS_DIRHANDLE__;
18
struct __PHYSFS_FILEFUNCTIONS__;
19
20
21
22
23
24
25
26
27
typedef struct __PHYSFS_FILEHANDLE__
{
/*
* This is reserved for the driver to store information.
*/
void *opaque;
/*
28
* This should be the DirHandle that created this FileHandle.
29
*/
30
const struct __PHYSFS_DIRHANDLE__ *dirHandle;
31
32
33
34
35
36
37
38
39
40
/*
* Pointer to the file i/o functions for this filehandle.
*/
const struct __PHYSFS_FILEFUNCTIONS__ *funcs;
} FileHandle;
typedef struct __PHYSFS_FILEFUNCTIONS__
{
41
42
/*
* Read more from the file.
43
44
45
* Returns number of objects of (objSize) bytes read from file, -1
* if complete failure.
* On failure, call __PHYSFS_setError().
46
*/
47
int (*read)(FileHandle *handle, void *buffer,
48
49
50
51
52
unsigned int objSize, unsigned int objCount);
/*
* Write more to the file. Archives don't have to implement this.
* (Set it to NULL if not implemented).
53
54
55
* Returns number of objects of (objSize) bytes written to file, -1
* if complete failure.
* On failure, call __PHYSFS_setError().
56
*/
57
int (*write)(FileHandle *handle, void *buffer,
58
59
60
61
62
unsigned int objSize, unsigned int objCount);
/*
* Returns non-zero if at end of file.
*/
63
int (*eof)(FileHandle *handle);
64
65
66
67
/*
* Returns byte offset from start of file.
*/
68
int (*tell)(FileHandle *handle);
69
70
71
72
/*
* Move read/write pointer to byte offset from start of file.
* Returns non-zero on success, zero on error.
73
* On failure, call __PHYSFS_setError().
74
*/
75
int (*seek)(FileHandle *handle, int offset);
76
77
/*
78
* Close the file, and free the FileHandle structure (including "opaque").
79
80
* returns non-zero on success, zero if can't close file.
* On failure, call __PHYSFS_setError().
81
*/
82
83
int (*close)(FileHandle *handle);
} FileFunctions;
84
85
86
typedef struct __PHYSFS_DIRHANDLE__
87
88
89
90
91
92
{
/*
* This is reserved for the driver to store information.
*/
void *opaque;
93
/*
94
* Pointer to the directory i/o functions for this handle.
95
96
97
98
99
*/
const struct __PHYSFS_DIRFUNCTIONS__ *funcs;
} DirHandle;
100
101
102
103
104
105
typedef struct __PHYSFS_LINKEDSTRINGLIST__
{
char *str;
struct __PHYSFS_LINKEDSTRINGLIST__ *next;
} LinkedStringList;
106
107
108
109
110
111
112
113
114
115
/*
* Symlinks should always be followed; PhysicsFS will use
* DirFunctions->isSymLink() and make a judgement on whether to
* continue to call other methods based on that.
*/
typedef struct __PHYSFS_DIRFUNCTIONS__
{
/*
* Returns non-zero if (filename) is a valid archive that this
* driver can handle. This filename is in platform-dependent
116
117
118
* notation. forWriting is non-zero if this is to be used for
* the write directory, and zero if this is to be used for an
* element of the search path.
119
*/
120
int (*isArchive)(const char *filename, int forWriting);
121
122
123
124
/*
* Return a DirHandle for dir/archive (name).
* This filename is in platform-dependent notation.
125
126
127
128
* forWriting is non-zero if this is to be used for
* the write directory, and zero if this is to be used for an
* element of the search path.
* Returns NULL on failure, and calls __PHYSFS_setError().
129
*/
130
DirHandle *(*openArchive)(const char *name, int forWriting);
131
132
/*
133
134
135
136
137
* Returns a list of all files in dirname. Each element of this list
* (and its "str" field) will be deallocated with the system's free()
* function by the caller, so be sure to explicitly malloc() each
* chunk.
* If you have a memory failure, return as much as you can.
138
* This dirname is in platform-independent notation.
139
*/
140
LinkedStringList *(*enumerateFiles)(DirHandle *r, const char *dirname);
141
142
/*
143
* Returns non-zero if filename can be opened for reading.
144
* This filename is in platform-independent notation.
145
*/
146
int (*exists)(DirHandle *r, const char *name);
147
148
/*
149
* Returns non-zero if filename is really a directory.
150
* This filename is in platform-independent notation.
151
*/
152
int (*isDirectory)(DirHandle *r, const char *name);
153
154
/*
155
* Returns non-zero if filename is really a symlink.
156
* This filename is in platform-independent notation.
157
*/
158
int (*isSymLink)(DirHandle *r, const char *name);
159
160
161
/*
* Open file for reading, and return a FileHandle.
162
* This filename is in platform-independent notation.
163
164
165
* If you can't handle multiple opens of the same file,
* you can opt to fail for the second call.
* Returns NULL on failure, and calls __PHYSFS_setError().
166
167
168
169
170
171
172
*/
FileHandle *(*openRead)(DirHandle *r, const char *filename);
/*
* Open file for writing, and return a FileHandle.
* This filename is in platform-independent notation.
* This method may be NULL.
173
174
175
* If you can't handle multiple opens of the same file,
* you can opt to fail for the second call.
* Returns NULL on failure, and calls __PHYSFS_setError().
176
177
178
179
180
181
182
*/
FileHandle *(*openWrite)(DirHandle *r, const char *filename);
/*
* Open file for appending, and return a FileHandle.
* This filename is in platform-independent notation.
* This method may be NULL.
183
184
185
* If you can't handle multiple opens of the same file,
* you can opt to fail for the second call.
* Returns NULL on failure, and calls __PHYSFS_setError().
186
*/
187
FileHandle *(*openAppend)(DirHandle *r, const char *filename);
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
/*
* Delete a file in the archive/directory.
* Return non-zero on success, zero on failure.
* This filename is in platform-independent notation.
* This method may be NULL.
* On failure, call __PHYSFS_setError().
*/
int (*remove)(DirHandle *r, const char *filename);
/*
* Create a directory in the archive/directory.
* If the application is trying to make multiple dirs, PhysicsFS
* will split them up into multiple calls before passing them to
* your driver.
* Return non-zero on success, zero on failure.
* This filename is in platform-independent notation.
* This method may be NULL.
* On failure, call __PHYSFS_setError().
*/
int (*mkdir)(DirHandle *r, const char *filename);
210
/*
211
* Close directories/archives, and free the handle, including
212
* the "opaque" entry. This should assume that it won't be called if
213
* there are still files open from this DirHandle.
214
*/
215
216
void (*close)(DirHandle *r);
} DirFunctions;
217
218
219
220
221
222
/* error messages... */
#define ERR_IS_INITIALIZED "Already initialized"
#define ERR_NOT_INITIALIZED "Not initialized"
#define ERR_INVALID_ARGUMENT "Invalid argument"
223
#define ERR_FILES_STILL_OPEN "Files still open"
224
225
226
227
#define ERR_NO_DIR_CREATE "Failed to create directories"
#define ERR_OUT_OF_MEMORY "Out of memory"
#define ERR_NOT_IN_SEARCH_PATH "No such entry in search path"
#define ERR_NOT_SUPPORTED "Operation not supported"
228
#define ERR_UNSUPPORTED_ARCHIVE "Archive type unsupported"
229
230
231
232
#define ERR_NOT_A_HANDLE "Not a file handle"
#define ERR_INSECURE_FNAME "Insecure filename"
#define ERR_SYMLINK_DISALLOWED "Symbolic links are disabled"
#define ERR_NO_WRITE_DIR "Write directory is not set"
233
234
235
236
237
238
/*
* Call this to set the message returned by PHYSFS_getLastError().
* Please only use the ERR_* constants above, or add new constants to the
* above group, but I want these all in one place.
239
240
*
* Calling this with a NULL argument is a safe no-op.
241
242
243
244
*/
void __PHYSFS_setError(const char *err);
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
/*
* Convert (dirName) to platform-dependent notation, then prepend (prepend)
* and append (append) to the converted string.
*
* So, on Win32, calling:
* __PHYSFS_convertToDependentNotation("C:\", "my/files", NULL);
* ...will return the string "C:\my\files".
*
* This is a convenience function; you might want to hack something out that
* is less generic (and therefore more efficient).
*
* Be sure to free() the return value when done with it.
*/
char *__PHYSFS_convertToDependentNotation(const char *prepend,
const char *dirName,
const char *append);
/*
* Verify that (fname) (in platform-independent notation), in relation
* to (h) is secure. That means that each element of fname is checked
* for symlinks (if they aren't permitted). Also, elements such as
* ".", "..", or ":" are flagged.
*
* Returns non-zero if string is safe, zero if there's a security issue.
* PHYSFS_getLastError() will specify what was wrong.
*/
int __PHYSFS_verifySecurity(DirHandle *h, const char *fname);
274
/* This gets used all over for lessening code clutter. */
275
#define BAIL_IF_MACRO(c, e, r) if (c) { __PHYSFS_setError(e); return r; }
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
/*--------------------------------------------------------------------------*/
/*--------------------------------------------------------------------------*/
/*------------ ----------------*/
/*------------ You MUST implement the following functions ----------------*/
/*------------ if porting to a new platform. ----------------*/
/*------------ (see unix.c for an example) ----------------*/
/*------------ ----------------*/
/*--------------------------------------------------------------------------*/
/*--------------------------------------------------------------------------*/
/*
* The dir separator; "/" on unix, "\\" on win32, ":" on MacOS, etc...
* Obviously, this isn't a function, but it IS a null-terminated string.
*/
295
extern const char *__PHYSFS_platformDirSeparator;
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
/*
* Platform implementation of PHYSFS_getCdRomDirs()...
* See physfs.h. The retval should be freeable via PHYSFS_freeList().
*/
char **__PHYSFS_platformDetectAvailableCDs(void);
/*
* Calculate the base dir, if your platform needs special consideration.
* Just return NULL if the standard routines will suffice. (see
* calculateBaseDir() in physfs.c ...)
* Caller will free() the retval if it's not NULL.
*/
char *__PHYSFS_platformCalcBaseDir(char *argv0);
/*
* Get the platform-specific user name.
* Caller will free() the retval if it's not NULL. If it's NULL, the username
* will default to "default".
*/
char *__PHYSFS_platformGetUserName(void);
/*
* Get the platform-specific user dir.
* Caller will free() the retval if it's not NULL. If it's NULL, the userdir
* will default to basedir/username.
*/
char *__PHYSFS_platformGetUserDir(void);
/*
* Return a number that uniquely identifies the current thread.
* On a platform without threading, (1) will suffice. These numbers are
* arbitrary; the only requirement is that no two threads have the same
* number.
*/
int __PHYSFS_platformGetThreadID(void);
/*
* This is a pass-through to whatever stricmp() is called on your platform.
*/
int __PHYSFS_platformStricmp(const char *str1, const char *str2);
338
339
340
341
342
/*
* Return non-zero if filename (in platform-dependent notation) is a symlink.
*/
int __PHYSFS_platformIsSymlink(const char *fname);
343
344
345
346
347
/*
* Return non-zero if filename (in platform-dependent notation) is a symlink.
*/
int __PHYSFS_platformIsDirectory(const char *fname);
348
349
350
351
352
353
354
355
#ifdef __cplusplus
extern "C" {
#endif
#endif
/* end of physfs_internal.h ... */