/
physfs_internal.h
629 lines (542 loc) · 22.7 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
18
19
20
21
22
#include "physfs.h"
#ifdef __cplusplus
extern "C" {
#endif
23
struct __PHYSFS_DIRHANDLE__;
24
struct __PHYSFS_FILEFUNCTIONS__;
25
26
27
28
29
30
31
32
33
typedef struct __PHYSFS_LINKEDSTRINGLIST__
{
char *str;
struct __PHYSFS_LINKEDSTRINGLIST__ *next;
} LinkedStringList;
34
35
36
37
38
39
40
41
typedef struct __PHYSFS_FILEHANDLE__
{
/*
* This is reserved for the driver to store information.
*/
void *opaque;
/*
42
* This should be the DirHandle that created this FileHandle.
43
*/
44
const struct __PHYSFS_DIRHANDLE__ *dirHandle;
45
46
47
48
49
50
51
52
53
54
/*
* Pointer to the file i/o functions for this filehandle.
*/
const struct __PHYSFS_FILEFUNCTIONS__ *funcs;
} FileHandle;
typedef struct __PHYSFS_FILEFUNCTIONS__
{
55
56
/*
* Read more from the file.
57
58
59
* Returns number of objects of (objSize) bytes read from file, -1
* if complete failure.
* On failure, call __PHYSFS_setError().
60
*/
61
62
PHYSFS_sint64 (*read)(FileHandle *handle, void *buffer,
PHYSFS_uint32 objSize, PHYSFS_uint32 objCount);
63
64
65
66
/*
* Write more to the file. Archives don't have to implement this.
* (Set it to NULL if not implemented).
67
68
69
* Returns number of objects of (objSize) bytes written to file, -1
* if complete failure.
* On failure, call __PHYSFS_setError().
70
*/
71
72
PHYSFS_sint64 (*write)(FileHandle *handle, const void *buffer,
PHYSFS_uint32 objSize, PHYSFS_uint32 objCount);
73
74
75
76
/*
* Returns non-zero if at end of file.
*/
77
int (*eof)(FileHandle *handle);
78
79
80
81
/*
* Returns byte offset from start of file.
*/
82
PHYSFS_sint64 (*tell)(FileHandle *handle);
83
84
85
86
/*
* Move read/write pointer to byte offset from start of file.
* Returns non-zero on success, zero on error.
87
* On failure, call __PHYSFS_setError().
88
*/
89
int (*seek)(FileHandle *handle, PHYSFS_uint64 offset);
90
91
92
93
94
95
/*
* Return number of bytes available in the file, or -1 if you
* aren't able to determine.
* On failure, call __PHYSFS_setError().
*/
96
PHYSFS_sint64 (*fileLength)(FileHandle *handle);
97
98
/*
99
* Close the file, and free the FileHandle structure (including "opaque").
100
101
* returns non-zero on success, zero if can't close file.
* On failure, call __PHYSFS_setError().
102
*/
103
int (*fileClose)(FileHandle *handle);
104
} FileFunctions;
105
106
107
typedef struct __PHYSFS_DIRHANDLE__
108
109
110
111
112
113
{
/*
* This is reserved for the driver to store information.
*/
void *opaque;
114
/*
115
* Pointer to the directory i/o functions for this handle.
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
*/
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
131
132
133
* 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.
134
*/
135
int (*isArchive)(const char *filename, int forWriting);
136
137
138
139
/*
* Return a DirHandle for dir/archive (name).
* This filename is in platform-dependent notation.
140
141
142
143
* 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().
144
*/
145
DirHandle *(*openArchive)(const char *name, int forWriting);
146
147
/*
148
149
150
* 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
151
* chunk. Omit symlinks if (omitSymLinks) is non-zero.
152
* If you have a memory failure, return as much as you can.
153
* This dirname is in platform-independent notation.
154
*/
155
156
157
158
LinkedStringList *(*enumerateFiles)(DirHandle *r,
const char *dirname,
int omitSymLinks);
159
160
/*
161
* Returns non-zero if filename can be opened for reading.
162
* This filename is in platform-independent notation.
163
*/
164
int (*exists)(DirHandle *r, const char *name);
165
166
/*
167
* Returns non-zero if filename is really a directory.
168
* This filename is in platform-independent notation.
169
*/
170
int (*isDirectory)(DirHandle *r, const char *name);
171
172
/*
173
* Returns non-zero if filename is really a symlink.
174
* This filename is in platform-independent notation.
175
*/
176
int (*isSymLink)(DirHandle *r, const char *name);
177
178
179
/*
* Open file for reading, and return a FileHandle.
180
* This filename is in platform-independent notation.
181
182
* If you can't handle multiple opens of the same file,
* you can opt to fail for the second call.
183
* Fail if the file does not exist.
184
* Returns NULL on failure, and calls __PHYSFS_setError().
185
186
187
188
189
*/
FileHandle *(*openRead)(DirHandle *r, const char *filename);
/*
* Open file for writing, and return a FileHandle.
190
191
192
193
* 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.
194
* This method may be NULL.
195
196
197
* 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().
198
199
200
201
202
*/
FileHandle *(*openWrite)(DirHandle *r, const char *filename);
/*
* Open file for appending, and return a FileHandle.
203
204
205
* 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.
206
* This method may be NULL.
207
208
209
* 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().
210
*/
211
FileHandle *(*openAppend)(DirHandle *r, const char *filename);
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
/*
* 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);
234
/*
235
* Close directories/archives, and free the handle, including
236
* the "opaque" entry. This should assume that it won't be called if
237
* there are still files open from this DirHandle.
238
*/
239
void (*dirClose)(DirHandle *r);
240
} DirFunctions;
241
242
243
244
245
246
/* error messages... */
#define ERR_IS_INITIALIZED "Already initialized"
#define ERR_NOT_INITIALIZED "Not initialized"
#define ERR_INVALID_ARGUMENT "Invalid argument"
247
#define ERR_FILES_STILL_OPEN "Files still open"
248
249
250
251
#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"
252
#define ERR_UNSUPPORTED_ARCHIVE "Archive type unsupported"
253
254
255
256
#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"
257
#define ERR_NO_SUCH_FILE "No such file"
258
#define ERR_PAST_EOF "Past end of file"
259
#define ERR_ARC_IS_READ_ONLY "Archive is read-only"
260
#define ERR_IO_ERROR "I/O error"
261
262
#define ERR_CANT_SET_WRITE_DIR "Can't set write directory"
#define ERR_TOO_MANY_SYMLINKS "Too many symbolic links"
263
#define ERR_COMPRESSION "(De)compression error"
264
265
266
267
268
/*
* 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.
269
270
*
* Calling this with a NULL argument is a safe no-op.
271
272
273
274
*/
void __PHYSFS_setError(const char *err);
275
276
277
278
279
/*
* Convert (dirName) to platform-dependent notation, then prepend (prepend)
* and append (append) to the converted string.
*
* So, on Win32, calling:
280
* __PHYSFS_convertToDependent("C:\", "my/files", NULL);
281
282
283
284
285
286
287
* ...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.
*/
288
289
290
char *__PHYSFS_convertToDependent(const char *prepend,
const char *dirName,
const char *append);
291
292
293
294
295
296
297
298
299
300
301
302
303
/*
* 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);
304
305
/* These get used all over for lessening code clutter. */
#define BAIL_MACRO(e, r) { __PHYSFS_setError(e); return r; }
306
#define BAIL_IF_MACRO(c, e, r) if (c) { __PHYSFS_setError(e); return r; }
307
308
309
310
311
312
313
314
315
/*--------------------------------------------------------------------------*/
/*--------------------------------------------------------------------------*/
/*------------ ----------------*/
/*------------ You MUST implement the following functions ----------------*/
/*------------ if porting to a new platform. ----------------*/
316
/*------------ (see platform/unix.c for an example) ----------------*/
317
318
319
320
321
322
323
324
325
/*------------ ----------------*/
/*--------------------------------------------------------------------------*/
/*--------------------------------------------------------------------------*/
/*
* The dir separator; "/" on unix, "\\" on win32, ":" on MacOS, etc...
* Obviously, this isn't a function, but it IS a null-terminated string.
*/
326
extern const char *__PHYSFS_platformDirSeparator;
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
/*
* Initialize the platform. This is called when PHYSFS_init() is called from
* the application. You can use this to (for example) determine what version
* of Windows you're running.
*
* Return zero if there was a catastrophic failure (which prevents you from
* functioning at all), and non-zero otherwise.
*/
int __PHYSFS_platformInit(void);
/*
* Deinitialize the platform. This is called when PHYSFS_deinit() is called
* from the application. You can use this to clean up anything you've
* allocated in your platform driver.
*
* Return zero if there was a catastrophic failure (which prevents you from
* functioning at all), and non-zero otherwise.
*/
int __PHYSFS_platformDeinit(void);
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
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
415
416
417
418
419
420
/*
* Open a file for reading. (filename) is in platform-dependent notation. The
* file pointer should be positioned on the first byte of the file.
*
* The return value will be some platform-specific datatype that is opaque to
* the caller; it could be a (FILE *) under Unix, or a (HANDLE *) under win32.
*
* The same file can be opened for read multiple times, and each should have
* a unique file handle; this is frequently employed to prevent race
* conditions in the archivers.
*
* Call __PHYSFS_setError() and return (NULL) if the file can't be opened.
*/
void *__PHYSFS_platformOpenRead(const char *filename);
/*
* Open a file for writing. (filename) is in platform-dependent notation. If
* the file exists, it should be truncated to zero bytes, and if it doesn't
* exist, it should be created as a zero-byte file. The file pointer should
* be positioned on the first byte of the file.
*
* The return value will be some platform-specific datatype that is opaque to
* the caller; it could be a (FILE *) under Unix, or a (HANDLE *) under win32,
* etc.
*
* Opening a file for write multiple times has undefined results.
*
* Call __PHYSFS_setError() and return (NULL) if the file can't be opened.
*/
void *__PHYSFS_platformOpenWrite(const char *filename);
/*
* Open a file for appending. (filename) is in platform-dependent notation. If
* the file exists, the file pointer should be place just past the end of the
* file, so that the first write will be one byte after the current end of
* the file. If the file doesn't exist, it should be created as a zero-byte
* file. The file pointer should be positioned on the first byte of the file.
*
* The return value will be some platform-specific datatype that is opaque to
* the caller; it could be a (FILE *) under Unix, or a (HANDLE *) under win32,
* etc.
*
* Opening a file for append multiple times has undefined results.
*
* Call __PHYSFS_setError() and return (NULL) if the file can't be opened.
*/
void *__PHYSFS_platformOpenAppend(const char *filename);
/*
* Read more data from a platform-specific file handle. (opaque) should be
* cast to whatever data type your platform uses. Read a maximum of (count)
* objects of (size) 8-bit bytes to the area pointed to by (buffer). If there
* isn't enough data available, return the number of full objects read, and
* position the file pointer at the start of the first incomplete object.
* On success, return (count) and position the file pointer one byte past
* the end of the last read object. Return (-1) if there is a catastrophic
* error, and call __PHYSFS_setError() to describe the problem; the file
* pointer should not move in such a case.
*/
PHYSFS_sint64 __PHYSFS_platformRead(void *opaque, void *buffer,
PHYSFS_uint32 size, PHYSFS_uint32 count);
/*
* Write more data to a platform-specific file handle. (opaque) should be
* cast to whatever data type your platform uses. Write a maximum of (count)
* objects of (size) 8-bit bytes from the area pointed to by (buffer). If
* there isn't enough data available, return the number of full objects
* written, and position the file pointer at the start of the first
* incomplete object. Return (-1) if there is a catastrophic error, and call
* __PHYSFS_setError() to describe the problem; the file pointer should not
* move in such a case.
*/
421
PHYSFS_sint64 __PHYSFS_platformWrite(void *opaque, const void *buffer,
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
PHYSFS_uint32 size, PHYSFS_uint32 count);
/*
* Set the file pointer to a new position. (opaque) should be cast to
* whatever data type your platform uses. (pos) specifies the number
* of 8-bit bytes to seek to from the start of the file. Seeking past the
* end of the file is an error condition, and you should check for it.
*
* Not all file types can seek; this is to be expected by the caller.
*
* On error, call __PHYSFS_setError() and return zero. On success, return
* a non-zero value.
*/
int __PHYSFS_platformSeek(void *opaque, PHYSFS_uint64 pos);
/*
* Get the file pointer's position, in an 8-bit byte offset from the start of
* the file. (opaque) should be cast to whatever data type your platform
* uses.
*
* Not all file types can "tell"; this is to be expected by the caller.
*
* On error, call __PHYSFS_setError() and return zero. On success, return
* a non-zero value.
*/
PHYSFS_sint64 __PHYSFS_platformTell(void *opaque);
/*
* Determine the current size of a file, in 8-bit bytes, from an open file.
*
* The caller expects that this information may not be available for all
* file types on all platforms.
*
* Return -1 if you can't do it, and call __PHYSFS_setError(). Otherwise,
* return the file length in 8-bit bytes.
*/
PHYSFS_sint64 __PHYSFS_platformFileLength(void *handle);
/*
* Determine if a file is at EOF. (opaque) should be cast to whatever data
* type your platform uses.
*
* The caller expects that there was a short read before calling this.
*
* Return non-zero if EOF, zero if it is _not_ EOF.
*/
int __PHYSFS_platformEOF(void *opaque);
/*
* Flush any pending writes to disk. (opaque) should be cast to whatever data
* type your platform uses. Be sure to check for errors; the caller expects
* that this function can fail if there was a flushing error, etc.
*
* Return zero on failure, non-zero on success.
*/
int __PHYSFS_platformFlush(void *opaque);
/*
* Flush and close a file. (opaque) should be cast to whatever data type
* your platform uses. Be sure to check for errors when closing; the
* caller expects that this function can fail if there was a flushing
* error, etc.
*
* You should clean up all resources associated with (opaque).
*
* Return zero on failure, non-zero on success.
*/
int __PHYSFS_platformClose(void *opaque);
491
492
493
494
495
496
497
498
499
500
501
502
/*
* 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.
*/
503
char *__PHYSFS_platformCalcBaseDir(const char *argv0);
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
/*
* 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.
*/
525
PHYSFS_uint64 __PHYSFS_platformGetThreadID(void);
526
527
528
529
530
531
/*
* This is a pass-through to whatever stricmp() is called on your platform.
*/
int __PHYSFS_platformStricmp(const char *str1, const char *str2);
532
533
534
535
536
537
538
/*
* 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);
539
540
541
/*
* Return non-zero if filename (in platform-dependent notation) is a symlink.
*/
542
int __PHYSFS_platformIsSymLink(const char *fname);
543
544
545
/*
* Return non-zero if filename (in platform-dependent notation) is a symlink.
546
547
* Symlinks should be followed; if what the symlink points to is missing,
* or isn't a directory, then the retval is false.
548
549
550
*/
int __PHYSFS_platformIsDirectory(const char *fname);
551
552
553
554
555
556
557
558
559
560
561
562
563
/*
* 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
564
565
* __PHYSFS_convertToDependent() as a passthrough, which may fit the bill
* already.
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
*
* 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
585
586
* uses platform-independent notation. Note that ".", "..", and other
* metaentries should always be ignored.
587
*/
588
589
LinkedStringList *__PHYSFS_platformEnumerateFiles(const char *dirname,
int omitSymLinks);
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
/*
* 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);
615
616
617
618
619
620
621
/*
* 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);
622
#ifdef __cplusplus
623
}
624
625
626
627
628
#endif
#endif
/* end of physfs_internal.h ... */