/
physfs_internal.h
467 lines (393 loc) · 16.3 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_LINKEDSTRINGLIST__
{
char *str;
struct __PHYSFS_LINKEDSTRINGLIST__ *next;
} LinkedStringList;
28
29
30
31
32
33
34
35
typedef struct __PHYSFS_FILEHANDLE__
{
/*
* This is reserved for the driver to store information.
*/
void *opaque;
/*
36
* This should be the DirHandle that created this FileHandle.
37
*/
38
const struct __PHYSFS_DIRHANDLE__ *dirHandle;
39
40
41
42
43
44
45
46
47
48
/*
* Pointer to the file i/o functions for this filehandle.
*/
const struct __PHYSFS_FILEFUNCTIONS__ *funcs;
} FileHandle;
typedef struct __PHYSFS_FILEFUNCTIONS__
{
49
50
/*
* Read more from the file.
51
52
53
* Returns number of objects of (objSize) bytes read from file, -1
* if complete failure.
* On failure, call __PHYSFS_setError().
54
*/
55
int (*read)(FileHandle *handle, void *buffer,
56
57
58
59
60
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).
61
62
63
* Returns number of objects of (objSize) bytes written to file, -1
* if complete failure.
* On failure, call __PHYSFS_setError().
64
*/
65
int (*write)(FileHandle *handle, void *buffer,
66
67
68
69
70
unsigned int objSize, unsigned int objCount);
/*
* Returns non-zero if at end of file.
*/
71
int (*eof)(FileHandle *handle);
72
73
74
75
/*
* Returns byte offset from start of file.
*/
76
int (*tell)(FileHandle *handle);
77
78
79
80
/*
* Move read/write pointer to byte offset from start of file.
* Returns non-zero on success, zero on error.
81
* On failure, call __PHYSFS_setError().
82
*/
83
int (*seek)(FileHandle *handle, int offset);
84
85
86
87
88
89
90
91
/*
* Return number of bytes available in the file, or -1 if you
* aren't able to determine.
* On failure, call __PHYSFS_setError().
*/
int (*fileLength)(FileHandle *handle);
92
/*
93
* Close the file, and free the FileHandle structure (including "opaque").
94
95
* returns non-zero on success, zero if can't close file.
* On failure, call __PHYSFS_setError().
96
*/
97
int (*fileClose)(FileHandle *handle);
98
} FileFunctions;
99
100
101
typedef struct __PHYSFS_DIRHANDLE__
102
103
104
105
106
107
{
/*
* This is reserved for the driver to store information.
*/
void *opaque;
108
/*
109
* Pointer to the directory i/o functions for this handle.
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
*/
const struct __PHYSFS_DIRFUNCTIONS__ *funcs;
} DirHandle;
/*
* 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
125
126
127
* 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.
128
*/
129
int (*isArchive)(const char *filename, int forWriting);
130
131
132
133
/*
* Return a DirHandle for dir/archive (name).
* This filename is in platform-dependent notation.
134
135
136
137
* 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().
138
*/
139
DirHandle *(*openArchive)(const char *name, int forWriting);
140
141
/*
142
143
144
* 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
145
* chunk. Omit symlinks if (omitSymLinks) is non-zero.
146
* If you have a memory failure, return as much as you can.
147
* This dirname is in platform-independent notation.
148
*/
149
150
151
152
LinkedStringList *(*enumerateFiles)(DirHandle *r,
const char *dirname,
int omitSymLinks);
153
154
/*
155
* Returns non-zero if filename can be opened for reading.
156
* This filename is in platform-independent notation.
157
*/
158
int (*exists)(DirHandle *r, const char *name);
159
160
/*
161
* Returns non-zero if filename is really a directory.
162
* This filename is in platform-independent notation.
163
*/
164
int (*isDirectory)(DirHandle *r, const char *name);
165
166
/*
167
* Returns non-zero if filename is really a symlink.
168
* This filename is in platform-independent notation.
169
*/
170
int (*isSymLink)(DirHandle *r, const char *name);
171
172
173
/*
* Open file for reading, and return a FileHandle.
174
* This filename is in platform-independent notation.
175
176
* If you can't handle multiple opens of the same file,
* you can opt to fail for the second call.
177
* Fail if the file does not exist.
178
* Returns NULL on failure, and calls __PHYSFS_setError().
179
180
181
182
183
*/
FileHandle *(*openRead)(DirHandle *r, const char *filename);
/*
* Open file for writing, and return a FileHandle.
184
185
186
187
* If the file does not exist, it should be created. If it exists,
* it should be truncated to zero bytes. The writing
* offset should be the start of the file.
* This filename is in platform-independent notation.
188
* This method may be NULL.
189
190
191
* 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().
192
193
194
195
196
*/
FileHandle *(*openWrite)(DirHandle *r, const char *filename);
/*
* Open file for appending, and return a FileHandle.
197
198
199
* If the file does not exist, it should be created. The writing
* offset should be the end of the file.
* This filename is in platform-independent notation.
200
* This method may be NULL.
201
202
203
* 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().
204
*/
205
FileHandle *(*openAppend)(DirHandle *r, const char *filename);
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
/*
* 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);
228
/*
229
* Close directories/archives, and free the handle, including
230
* the "opaque" entry. This should assume that it won't be called if
231
* there are still files open from this DirHandle.
232
*/
233
void (*dirClose)(DirHandle *r);
234
} DirFunctions;
235
236
237
238
239
240
/* error messages... */
#define ERR_IS_INITIALIZED "Already initialized"
#define ERR_NOT_INITIALIZED "Not initialized"
#define ERR_INVALID_ARGUMENT "Invalid argument"
241
#define ERR_FILES_STILL_OPEN "Files still open"
242
243
244
245
#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"
246
#define ERR_UNSUPPORTED_ARCHIVE "Archive type unsupported"
247
248
249
250
#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"
251
#define ERR_NO_SUCH_FILE "No such file"
252
#define ERR_PAST_EOF "Past end of file"
253
#define ERR_ARC_IS_READ_ONLY "Archive is read-only"
254
#define ERR_IO_ERROR "I/O error"
255
256
#define ERR_CANT_SET_WRITE_DIR "Can't set write directory"
#define ERR_TOO_MANY_SYMLINKS "Too many symbolic links"
257
#define ERR_COMPRESSION "(De)compression error"
258
259
260
261
262
/*
* 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.
263
264
*
* Calling this with a NULL argument is a safe no-op.
265
266
267
268
*/
void __PHYSFS_setError(const char *err);
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:
274
* __PHYSFS_convertToDependent("C:\", "my/files", NULL);
275
276
277
278
279
280
281
* ...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.
*/
282
283
284
char *__PHYSFS_convertToDependent(const char *prepend,
const char *dirName,
const char *append);
285
286
287
288
289
290
291
292
293
294
295
296
297
/*
* 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);
298
299
/* These get used all over for lessening code clutter. */
#define BAIL_MACRO(e, r) { __PHYSFS_setError(e); return r; }
300
#define BAIL_IF_MACRO(c, e, r) if (c) { __PHYSFS_setError(e); return r; }
301
302
303
304
305
306
307
308
309
/*--------------------------------------------------------------------------*/
/*--------------------------------------------------------------------------*/
/*------------ ----------------*/
/*------------ You MUST implement the following functions ----------------*/
/*------------ if porting to a new platform. ----------------*/
310
/*------------ (see platform/unix.c for an example) ----------------*/
311
312
313
314
315
316
317
318
319
/*------------ ----------------*/
/*--------------------------------------------------------------------------*/
/*--------------------------------------------------------------------------*/
/*
* The dir separator; "/" on unix, "\\" on win32, ":" on MacOS, etc...
* Obviously, this isn't a function, but it IS a null-terminated string.
*/
320
extern const char *__PHYSFS_platformDirSeparator;
321
322
323
324
325
326
327
328
329
330
331
332
333
/*
* 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.
*/
334
char *__PHYSFS_platformCalcBaseDir(const char *argv0);
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
/*
* 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);
363
364
365
366
367
368
369
/*
* Return non-zero if filename (in platform-dependent notation) exists.
* Symlinks should be followed; if what the symlink points to is missing,
* then the retval is false.
*/
int __PHYSFS_platformExists(const char *fname);
370
371
372
/*
* Return non-zero if filename (in platform-dependent notation) is a symlink.
*/
373
int __PHYSFS_platformIsSymLink(const char *fname);
374
375
376
/*
* Return non-zero if filename (in platform-dependent notation) is a symlink.
377
378
* Symlinks should be followed; if what the symlink points to is missing,
* or isn't a directory, then the retval is false.
379
380
381
*/
int __PHYSFS_platformIsDirectory(const char *fname);
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
/*
* Convert (dirName) to platform-dependent notation, then prepend (prepend)
* and append (append) to the converted string.
*
* So, on Win32, calling:
* __PHYSFS_platformCvtToDependent("C:\", "my/files", NULL);
* ...will return the string "C:\my\files".
*
* This can be implemented in a platform-specific manner, so you can get
* get a speed boost that the default implementation can't, since
* you can make assumptions about the size of strings, etc..
*
* Platforms that choose not to implement this may just call
* __PHYSFS_convertToDependent() as a passthrough.
*
* Be sure to free() the return value when done with it.
*/
char *__PHYSFS_platformCvtToDependent(const char *prepend,
const char *dirName,
const char *append);
/*
* Make the current thread give up a timeslice. This is called in a loop
* while waiting for various external forces to get back to us.
*/
void __PHYSFS_platformTimeslice(void);
/*
* Enumerate a directory of files. This follows the rules for the
* DirFunctions->enumerateFiles() method (see above), except that the
* (dirName) that is passed to this function is converted to
* platform-DEPENDENT notation by the caller. The DirFunctions version
415
416
* uses platform-independent notation. Note that ".", "..", and other
* metaentries should always be ignored.
417
*/
418
419
LinkedStringList *__PHYSFS_platformEnumerateFiles(const char *dirname,
int omitSymLinks);
420
421
422
423
424
425
426
427
428
/*
* Determine the current size of a file, in bytes, from a stdio FILE *.
* Return -1 if you can't do it, and call __PHYSFS_setError().
*/
int __PHYSFS_platformFileLength(FILE *handle);
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
/*
* Get the current working directory. The return value should be an
* absolute path in platform-dependent notation. The caller will deallocate
* the return value with the standard C runtime free() function when it
* is done with it.
* On error, return NULL and set the error message.
*/
char *__PHYSFS_platformCurrentDir(void);
/*
* Get the real physical path to a file. (path) is specified in
* platform-dependent notation, as should your return value be.
* All relative paths should be removed, leaving you with an absolute
* path. Symlinks should be resolved, too, so that the returned value is
* the most direct path to a file.
* The return value will be deallocated with the standard C runtime free()
* function when the caller is done with it.
* On error, return NULL and set the error message.
*/
char *__PHYSFS_platformRealPath(const char *path);
452
453
454
455
456
457
458
459
/*
* Make a directory in the actual filesystem. (path) is specified in
* platform-dependent notation. On error, return zero and set the error
* message. Return non-zero on success.
*/
int __PHYSFS_platformMkDir(const char *path);
460
461
462
463
464
465
466
#ifdef __cplusplus
extern "C" {
#endif
#endif
/* end of physfs_internal.h ... */