/
physfs_internal.h
720 lines (612 loc) · 26.8 KB
1
2
3
4
/*
* Internal function/structure declaration. Do NOT include in your
* application.
*
5
* Please see the file LICENSE.txt in the source's root directory.
6
7
8
9
10
11
12
13
14
15
16
*
* 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
/* Turn off MSVC warnings that are aggressively anti-portability. */
18
#if defined(_MSC_VER) && !defined(_CRT_SECURE_NO_WARNINGS)
19
20
21
#define _CRT_SECURE_NO_WARNINGS 1
#endif
22
23
#include "physfs.h"
24
25
26
27
/* The holy trinity. */
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
28
29
30
#include "physfs_platforms.h"
31
32
#include <assert.h>
33
34
35
#define __PHYSFS_COMPILE_TIME_ASSERT(name, x) \
typedef int __PHYSFS_compile_time_assert_##name[(x) * 2 - 1]
36
/* !!! FIXME: remove this when revamping stack allocation code... */
37
#if defined(_MSC_VER) || defined(__MINGW32__) || defined(__WATCOMC__)
38
39
40
#include <malloc.h>
#endif
41
#ifdef PHYSFS_PLATFORM_SOLARIS
42
43
44
#include <alloca.h>
#endif
45
46
47
48
#ifdef __cplusplus
extern "C" {
#endif
49
#ifdef __GNUC__
50
#define PHYSFS_MINIMUM_GCC_VERSION(major, minor) \
51
52
( ((__GNUC__ << 16) + __GNUC_MINOR__) >= (((major) << 16) + (minor)) )
#else
53
#define PHYSFS_MINIMUM_GCC_VERSION(major, minor) (0)
54
55
#endif
56
57
58
59
60
61
62
63
#ifdef __cplusplus
/* C++ always has a real inline keyword. */
#elif (defined macintosh) && !(defined __MWERKS__)
# define inline
#elif (defined _MSC_VER)
# define inline __inline
#endif
64
#if defined(PHYSFS_PLATFORM_LINUX) && !defined(_FILE_OFFSET_BITS)
65
66
#define _FILE_OFFSET_BITS 64
#endif
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
/* All public APIs need to be in physfs.h with a PHYSFS_DECL.
All file-private symbols need to be marked "static".
Everything shared between PhysicsFS sources needs to be in this
file between the visibility pragma blocks. */
#if PHYSFS_MINIMUM_GCC_VERSION(4,0) || defined(__clang__)
#define PHYSFS_HAVE_PRAGMA_VISIBILITY 1
#endif
#if PHYSFS_HAVE_PRAGMA_VISIBILITY
#pragma GCC visibility push(hidden)
#endif
/* These are the build-in archivers. We list them all as "extern" here without
#ifdefs to keep it tidy, but obviously you need to make sure these are
wrapped in PHYSFS_SUPPORTS_* checks before actually referencing them. */
extern const PHYSFS_Archiver __PHYSFS_Archiver_DIR;
extern const PHYSFS_Archiver __PHYSFS_Archiver_ZIP;
85
extern const PHYSFS_Archiver __PHYSFS_Archiver_7Z;
86
87
88
89
90
91
92
93
94
extern const PHYSFS_Archiver __PHYSFS_Archiver_GRP;
extern const PHYSFS_Archiver __PHYSFS_Archiver_QPAK;
extern const PHYSFS_Archiver __PHYSFS_Archiver_HOG;
extern const PHYSFS_Archiver __PHYSFS_Archiver_MVL;
extern const PHYSFS_Archiver __PHYSFS_Archiver_WAD;
extern const PHYSFS_Archiver __PHYSFS_Archiver_SLB;
extern const PHYSFS_Archiver __PHYSFS_Archiver_ISO9660;
extern const PHYSFS_Archiver __PHYSFS_Archiver_VDF;
95
96
97
98
99
100
101
102
/* a real C99-compliant snprintf() is in Visual Studio 2015,
but just use this everywhere for binary compatibility. */
#if defined(_MSC_VER)
int __PHYSFS_msvc_vsnprintf(char *outBuf, size_t size, const char *format, va_list ap);
int __PHYSFS_msvc_snprintf(char *outBuf, size_t size, const char *format, ...);
#define vsnprintf __PHYSFS_msvc_vsnprintf
#define snprintf __PHYSFS_msvc_snprintf
#endif
103
104
105
106
107
108
109
/* Some simple wrappers around WinRT C++ interfaces we can call from C. */
#ifdef PHYSFS_PLATFORM_WINRT
const void *__PHYSFS_winrtCalcBaseDir(void);
const void *__PHYSFS_winrtCalcPrefDir(void);
#endif
110
111
112
/* atomic operations. */
#if defined(_MSC_VER) && (_MSC_VER >= 1500)
#include <intrin.h>
113
__PHYSFS_COMPILE_TIME_ASSERT(LongEqualsInt, sizeof (int) == sizeof (long));
114
#define __PHYSFS_ATOMIC_INCR(ptrval) _InterlockedIncrement((long*)(ptrval))
115
#define __PHYSFS_ATOMIC_DECR(ptrval) _InterlockedDecrement((long*)(ptrval))
116
117
118
119
120
121
122
123
124
125
#elif defined(__clang__) || (defined(__GNUC__) && (((__GNUC__ * 10000) + (__GNUC_MINOR__ * 100)) >= 40100))
#define __PHYSFS_ATOMIC_INCR(ptrval) __sync_fetch_and_add(ptrval, 1)
#define __PHYSFS_ATOMIC_DECR(ptrval) __sync_fetch_and_add(ptrval, -1)
#else
#define PHYSFS_NEED_ATOMIC_OP_FALLBACK 1
int __PHYSFS_ATOMIC_INCR(int *ptrval);
int __PHYSFS_ATOMIC_DECR(int *ptrval);
#endif
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
/*
* Interface for small allocations. If you need a little scratch space for
* a throwaway buffer or string, use this. It will make small allocations
* on the stack if possible, and use allocator.Malloc() if they are too
* large. This helps reduce malloc pressure.
* There are some rules, though:
* NEVER return a pointer from this, as stack-allocated buffers go away
* when your function returns.
* NEVER allocate in a loop, as stack-allocated pointers will pile up. Call
* a function that uses smallAlloc from your loop, so the allocation can
* free each time.
* NEVER call smallAlloc with any complex expression (it's a macro that WILL
* have side effects...it references the argument multiple times). Use a
* variable or a literal.
* NEVER free a pointer from this with anything but smallFree. It will not
* be a valid pointer to the allocator, regardless of where the memory came
* from.
* NEVER realloc a pointer from this.
* NEVER forget to use smallFree: it may not be a pointer from the stack.
* NEVER forget to check for NULL...allocation can fail here, of course!
*/
147
#define __PHYSFS_SMALLALLOCTHRESHOLD 256
148
void *__PHYSFS_initSmallAlloc(void *ptr, const size_t len);
149
150
#define __PHYSFS_smallAlloc(bytes) ( \
151
152
153
__PHYSFS_initSmallAlloc( \
(((bytes) < __PHYSFS_SMALLALLOCTHRESHOLD) ? \
alloca((size_t)((bytes)+sizeof(void*))) : NULL), (bytes)) \
154
155
156
157
158
)
void __PHYSFS_smallFree(void *ptr);
159
160
161
162
/* Use the allocation hooks. */
#define malloc(x) Do not use malloc() directly.
#define realloc(x, y) Do not use realloc() directly.
#define free(x) Do not use free() directly.
163
/* !!! FIXME: add alloca check here. */
164
165
166
167
168
#ifndef PHYSFS_SUPPORTS_ZIP
#define PHYSFS_SUPPORTS_ZIP 1
#endif
#ifndef PHYSFS_SUPPORTS_7Z
169
#define PHYSFS_SUPPORTS_7Z 1
170
171
#endif
#ifndef PHYSFS_SUPPORTS_GRP
172
#define PHYSFS_SUPPORTS_GRP 1
173
174
#endif
#ifndef PHYSFS_SUPPORTS_HOG
175
#define PHYSFS_SUPPORTS_HOG 1
176
177
#endif
#ifndef PHYSFS_SUPPORTS_MVL
178
#define PHYSFS_SUPPORTS_MVL 1
179
180
#endif
#ifndef PHYSFS_SUPPORTS_WAD
181
#define PHYSFS_SUPPORTS_WAD 1
182
#endif
183
184
185
#ifndef PHYSFS_SUPPORTS_QPAK
#define PHYSFS_SUPPORTS_QPAK 1
#endif
186
#ifndef PHYSFS_SUPPORTS_SLB
187
#define PHYSFS_SUPPORTS_SLB 1
188
#endif
189
#ifndef PHYSFS_SUPPORTS_ISO9660
190
#define PHYSFS_SUPPORTS_ISO9660 1
191
#endif
192
#ifndef PHYSFS_SUPPORTS_VDF
193
#define PHYSFS_SUPPORTS_VDF 1
194
#endif
195
196
197
198
199
200
#if PHYSFS_SUPPORTS_7Z
/* 7zip support needs a global init function called at startup (no deinit). */
extern void SZIP_global_init(void);
#endif
201
202
/* The latest supported PHYSFS_Io::version value. */
#define CURRENT_PHYSFS_IO_API_VERSION 0
203
204
205
/* The latest supported PHYSFS_Archiver::version value. */
#define CURRENT_PHYSFS_ARCHIVER_API_VERSION 0
206
207
/* This byteorder stuff was lifted from SDL. https://www.libsdl.org/ */
208
209
210
#define PHYSFS_LIL_ENDIAN 1234
#define PHYSFS_BIG_ENDIAN 4321
211
212
213
214
215
216
217
218
219
220
#ifdef __linux__
#include <endian.h>
#define PHYSFS_BYTEORDER __BYTE_ORDER
#else /* __linux__ */
#if defined(__hppa__) || \
defined(__m68k__) || defined(mc68000) || defined(_M_M68K) || \
(defined(__MIPS__) && defined(__MISPEB__)) || \
defined(__ppc__) || defined(__POWERPC__) || defined(_M_PPC) || \
defined(__sparc__)
#define PHYSFS_BYTEORDER PHYSFS_BIG_ENDIAN
221
#else
222
#define PHYSFS_BYTEORDER PHYSFS_LIL_ENDIAN
223
#endif
224
#endif /* __linux__ */
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
/*
* When sorting the entries in an archive, we use a modified QuickSort.
* When there are less then PHYSFS_QUICKSORT_THRESHOLD entries left to sort,
* we switch over to a BubbleSort for the remainder. Tweak to taste.
*
* You can override this setting by defining PHYSFS_QUICKSORT_THRESHOLD
* before #including "physfs_internal.h".
*/
#ifndef PHYSFS_QUICKSORT_THRESHOLD
#define PHYSFS_QUICKSORT_THRESHOLD 4
#endif
/*
* Sort an array (or whatever) of (max) elements. This uses a mixture of
* a QuickSort and BubbleSort internally.
* (cmpfn) is used to determine ordering, and (swapfn) does the actual
* swapping of elements in the list.
*/
245
246
247
void __PHYSFS_sort(void *entries, size_t max,
int (*cmpfn)(void *, size_t, size_t),
void (*swapfn)(void *, size_t, size_t));
248
249
/* These get used all over for lessening code clutter. */
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
/* "ERRPASS" means "something else just set the error state for us" and is
just to make it clear where the responsibility for the error state lays. */
#define BAIL(e, r) do { if (e) PHYSFS_setErrorCode(e); return r; } while (0)
#define BAIL_ERRPASS(r) do { return r; } while (0)
#define BAIL_IF(c, e, r) do { if (c) { if (e) PHYSFS_setErrorCode(e); return r; } } while (0)
#define BAIL_IF_ERRPASS(c, r) do { if (c) { return r; } } while (0)
#define BAIL_MUTEX(e, m, r) do { if (e) PHYSFS_setErrorCode(e); __PHYSFS_platformReleaseMutex(m); return r; } while (0)
#define BAIL_MUTEX_ERRPASS(m, r) do { __PHYSFS_platformReleaseMutex(m); return r; } while (0)
#define BAIL_IF_MUTEX(c, e, m, r) do { if (c) { if (e) PHYSFS_setErrorCode(e); __PHYSFS_platformReleaseMutex(m); return r; } } while (0)
#define BAIL_IF_MUTEX_ERRPASS(c, m, r) do { if (c) { __PHYSFS_platformReleaseMutex(m); return r; } } while (0)
#define GOTO(e, g) do { if (e) PHYSFS_setErrorCode(e); goto g; } while (0)
#define GOTO_ERRPASS(g) do { goto g; } while (0)
#define GOTO_IF(c, e, g) do { if (c) { if (e) PHYSFS_setErrorCode(e); goto g; } } while (0)
#define GOTO_IF_ERRPASS(c, g) do { if (c) { goto g; } } while (0)
#define GOTO_MUTEX(e, m, g) do { if (e) PHYSFS_setErrorCode(e); __PHYSFS_platformReleaseMutex(m); goto g; } while (0)
#define GOTO_MUTEX_ERRPASS(m, g) do { __PHYSFS_platformReleaseMutex(m); goto g; } while (0)
#define GOTO_IF_MUTEX(c, e, m, g) do { if (c) { if (e) PHYSFS_setErrorCode(e); __PHYSFS_platformReleaseMutex(m); goto g; } } while (0)
#define GOTO_IF_MUTEX_ERRPASS(c, m, g) do { if (c) { __PHYSFS_platformReleaseMutex(m); goto g; } } while (0)
268
269
270
#define __PHYSFS_ARRAYLEN(x) ( (sizeof (x)) / (sizeof (x[0])) )
271
272
273
274
#ifdef PHYSFS_NO_64BIT_SUPPORT
#define __PHYSFS_SI64(x) ((PHYSFS_sint64) (x))
#define __PHYSFS_UI64(x) ((PHYSFS_uint64) (x))
#elif (defined __GNUC__)
275
276
#define __PHYSFS_SI64(x) x##LL
#define __PHYSFS_UI64(x) x##ULL
277
278
279
#elif (defined _MSC_VER)
#define __PHYSFS_SI64(x) x##i64
#define __PHYSFS_UI64(x) x##ui64
280
#else
281
282
#define __PHYSFS_SI64(x) ((PHYSFS_sint64) (x))
#define __PHYSFS_UI64(x) ((PHYSFS_uint64) (x))
283
284
#endif
285
286
287
288
289
290
291
292
293
/*
* Check if a ui64 will fit in the platform's address space.
* The initial sizeof check will optimize this macro out entirely on
* 64-bit (and larger?!) platforms, and the other condition will
* return zero or non-zero if the variable will fit in the platform's
* size_t, suitable to pass to malloc. This is kinda messy, but effective.
*/
#define __PHYSFS_ui64FitsAddressSpace(s) ( \
294
295
(sizeof (PHYSFS_uint64) <= sizeof (size_t)) || \
((s) < (__PHYSFS_UI64(0xFFFFFFFFFFFFFFFF) >> (64-(sizeof(size_t)*8)))) \
296
)
297
298
299
300
301
302
/*
* Like strdup(), but uses the current PhysicsFS allocator.
*/
char *__PHYSFS_strdup(const char *str);
303
304
305
306
307
/*
* Give a hash value for a C string (uses djb's xor hashing algorithm).
*/
PHYSFS_uint32 __PHYSFS_hashString(const char *str, size_t len);
308
309
/*
310
* The current allocator. Not valid before PHYSFS_init is called!
311
*/
312
extern PHYSFS_Allocator __PHYSFS_AllocatorHooks;
313
314
315
/* convenience macro to make this less cumbersome internally... */
#define allocator __PHYSFS_AllocatorHooks
316
317
318
319
320
321
322
323
/*
* Create a PHYSFS_Io for a file in the physical filesystem.
* This path is in platform-dependent notation. (mode) must be 'r', 'w', or
* 'a' for Read, Write, or Append.
*/
PHYSFS_Io *__PHYSFS_createNativeIo(const char *path, const int mode);
324
325
326
327
328
329
330
331
/*
* Create a PHYSFS_Io for a buffer of memory (READ-ONLY). If you already
* have one of these, just use its duplicate() method, and it'll increment
* its refcount without allocating a copy of the buffer.
*/
PHYSFS_Io *__PHYSFS_createMemoryIo(const void *buf, PHYSFS_uint64 len,
void (*destruct)(void *));
332
333
334
335
336
/*
* Read (len) bytes from (io) into (buf). Returns non-zero on success,
* zero on i/o error. Literally: "return (io->read(io, buf, len) == len);"
*/
337
int __PHYSFS_readAll(PHYSFS_Io *io, void *buf, const size_t len);
338
339
340
341
/* These are shared between some archivers. */
342
void UNPK_abandonArchive(void *opaque);
343
void UNPK_closeArchive(void *opaque);
344
void *UNPK_openArchive(PHYSFS_Io *io);
345
void *UNPK_addEntry(void *opaque, char *name, const int isdir,
346
const PHYSFS_sint64 ctime, const PHYSFS_sint64 mtime,
347
const PHYSFS_uint64 pos, const PHYSFS_uint64 len);
348
PHYSFS_Io *UNPK_openRead(void *opaque, const char *name);
349
350
351
352
PHYSFS_Io *UNPK_openWrite(void *opaque, const char *name);
PHYSFS_Io *UNPK_openAppend(void *opaque, const char *name);
int UNPK_remove(void *opaque, const char *name);
int UNPK_mkdir(void *opaque, const char *name);
353
int UNPK_stat(void *opaque, const char *fn, PHYSFS_Stat *st);
354
#define UNPK_enumerate __PHYSFS_DirTreeEnumerate
355
356
357
358
/* Optional API many archivers use this to manage their directory tree. */
359
/* !!! FIXME: document this better. */
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
typedef struct __PHYSFS_DirTreeEntry
{
char *name; /* Full path in archive. */
struct __PHYSFS_DirTreeEntry *hashnext; /* next item in hash bucket. */
struct __PHYSFS_DirTreeEntry *children; /* linked list of kids, if dir. */
struct __PHYSFS_DirTreeEntry *sibling; /* next item in same dir. */
int isdir;
} __PHYSFS_DirTreeEntry;
typedef struct __PHYSFS_DirTree
{
__PHYSFS_DirTreeEntry *root; /* root of directory tree. */
__PHYSFS_DirTreeEntry **hash; /* all entries hashed for fast lookup. */
size_t hashBuckets; /* number of buckets in hash. */
size_t entrylen; /* size in bytes of entries (including subclass). */
} __PHYSFS_DirTree;
379
int __PHYSFS_DirTreeInit(__PHYSFS_DirTree *dt, const size_t entrylen);
380
381
void *__PHYSFS_DirTreeAdd(__PHYSFS_DirTree *dt, char *name, const int isdir);
void *__PHYSFS_DirTreeFind(__PHYSFS_DirTree *dt, const char *path);
382
383
PHYSFS_EnumerateCallbackResult __PHYSFS_DirTreeEnumerate(void *opaque,
const char *dname, PHYSFS_EnumerateCallback cb,
384
const char *origdir, void *callbackdata);
385
386
387
388
void __PHYSFS_DirTreeDeinit(__PHYSFS_DirTree *dt);
389
390
391
392
393
/*--------------------------------------------------------------------------*/
/*--------------------------------------------------------------------------*/
/*------------ ----------------*/
/*------------ You MUST implement the following functions ----------------*/
/*------------ if porting to a new platform. ----------------*/
394
/*------------ (see platform/unix.c for an example) ----------------*/
395
396
397
398
399
400
/*------------ ----------------*/
/*--------------------------------------------------------------------------*/
/*--------------------------------------------------------------------------*/
/*
401
402
403
* The dir separator; '/' on unix, '\\' on win32, ":" on MacOS, etc...
* Obviously, this isn't a function. If you need more than one char for this,
* you'll need to pull some old pieces of PhysicsFS out of revision control.
404
*/
405
#if defined(PHYSFS_PLATFORM_WINDOWS) || defined(PHYSFS_PLATFORM_OS2)
406
407
#define __PHYSFS_platformDirSeparator '\\'
#else
408
#define __PHYSFS_STANDARD_DIRSEP 1
409
410
#define __PHYSFS_platformDirSeparator '/'
#endif
411
412
413
/*
* Initialize the platform. This is called when PHYSFS_init() is called from
414
* the application.
415
416
417
418
419
420
*
* Return zero if there was a catastrophic failure (which prevents you from
* functioning at all), and non-zero otherwise.
*/
int __PHYSFS_platformInit(void);
421
422
423
424
425
426
/*
* 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.
*/
427
void __PHYSFS_platformDeinit(void);
428
429
430
431
432
433
434
435
436
437
438
439
440
/*
* 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.
*
441
* Call PHYSFS_setErrorCode() and return (NULL) if the file can't be opened.
442
443
444
*/
void *__PHYSFS_platformOpenRead(const char *filename);
445
446
447
448
449
450
451
452
453
454
455
456
457
/*
* 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.
*
458
* Call PHYSFS_setErrorCode() and return (NULL) if the file can't be opened.
459
460
461
*/
void *__PHYSFS_platformOpenWrite(const char *filename);
462
463
464
465
466
467
468
469
470
471
472
473
474
475
/*
* 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.
*
476
* Call PHYSFS_setErrorCode() and return (NULL) if the file can't be opened.
477
478
479
480
481
*/
void *__PHYSFS_platformOpenAppend(const char *filename);
/*
* Read more data from a platform-specific file handle. (opaque) should be
482
483
484
485
486
487
* cast to whatever data type your platform uses. Read a maximum of (len)
* 8-bit bytes to the area pointed to by (buf). If there isn't enough data
* available, return the number of bytes read, and position the file pointer
* immediately after those bytes.
* On success, return (len) and position the file pointer immediately past
* the end of the last read byte. Return (-1) if there is a catastrophic
488
* error, and call PHYSFS_setErrorCode() to describe the problem; the file
489
490
491
* pointer should not move in such a case. A partial read is success; only
* return (-1) on total failure; presumably, the next read call after a
* partial read will fail as such.
492
*/
493
PHYSFS_sint64 __PHYSFS_platformRead(void *opaque, void *buf, PHYSFS_uint64 len);
494
495
496
/*
* Write more data to a platform-specific file handle. (opaque) should be
497
498
499
500
* cast to whatever data type your platform uses. Write a maximum of (len)
* 8-bit bytes from the area pointed to by (buffer). If there is a problem,
* return the number of bytes written, and position the file pointer
* immediately after those bytes. Return (-1) if there is a catastrophic
501
* error, and call PHYSFS_setErrorCode() to describe the problem; the file
502
503
504
* pointer should not move in such a case. A partial write is success; only
* return (-1) on total failure; presumably, the next write call after a
* partial write will fail as such.
505
*/
506
PHYSFS_sint64 __PHYSFS_platformWrite(void *opaque, const void *buffer,
507
PHYSFS_uint64 len);
508
509
510
511
512
513
514
515
516
/*
* 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.
*
517
* On error, call PHYSFS_setErrorCode() and return zero. On success, return
518
519
520
521
* a non-zero value.
*/
int __PHYSFS_platformSeek(void *opaque, PHYSFS_uint64 pos);
522
523
524
525
526
527
528
529
/*
* 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.
*
530
* On error, call PHYSFS_setErrorCode() and return -1. On success, return >= 0.
531
532
533
*/
PHYSFS_sint64 __PHYSFS_platformTell(void *opaque);
534
535
536
537
538
539
540
/*
* 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.
*
541
* Return -1 if you can't do it, and call PHYSFS_setErrorCode(). Otherwise,
542
543
544
545
* return the file length in 8-bit bytes.
*/
PHYSFS_sint64 __PHYSFS_platformFileLength(void *handle);
546
547
/*
548
549
550
551
* Read filesystem metadata for a specific path.
*
* This needs to fill in all the fields of (stat). For fields that might not
* mean anything on a platform (access time, perhaps), choose a reasonable
552
553
* default. if (follow), we want to follow symlinks and stat what they
* link to and not the link itself.
554
555
*
* Return zero on failure, non-zero on success.
556
*/
557
int __PHYSFS_platformStat(const char *fn, PHYSFS_Stat *stat, const int follow);
558
559
560
561
562
563
564
565
566
567
568
/*
* 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);
/*
569
570
571
* Close file and deallocate resources. (opaque) should be cast to whatever
* data type your platform uses. This should close the file in any scenario:
* flushing is a separate function call, and this function should never fail.
572
*
573
574
* You should clean up all resources associated with (opaque); the pointer
* will be considered invalid after this call.
575
*/
576
void __PHYSFS_platformClose(void *opaque);
577
578
/*
579
580
581
582
583
* Platform implementation of PHYSFS_getCdRomDirsCallback()...
* CD directories are discovered and reported to the callback one at a time.
* Pointers passed to the callback are assumed to be invalid to the
* application after the callback returns, so you can free them or whatever.
* Callback does not assume results will be sorted in any meaningful way.
584
*/
585
void __PHYSFS_platformDetectAvailableCDs(PHYSFS_StringCallback cb, void *data);
586
587
588
589
590
/*
* Calculate the base dir, if your platform needs special consideration.
* Just return NULL if the standard routines will suffice. (see
* calculateBaseDir() in physfs.c ...)
591
* Your string must end with a dir separator if you don't return NULL.
592
* Caller will allocator.Free() the retval if it's not NULL.
593
*/
594
char *__PHYSFS_platformCalcBaseDir(const char *argv0);
595
596
/*
597
* Get the platform-specific user dir.
598
599
600
* As of PhysicsFS 2.1, returning NULL means fatal error.
* Your string must end with a dir separator if you don't return NULL.
* Caller will allocator.Free() the retval if it's not NULL.
601
*/
602
char *__PHYSFS_platformCalcUserDir(void);
603
604
605
606
607
/* This is the cached version from PHYSFS_init(). This is a fast call. */
const char *__PHYSFS_getUserDir(void); /* not deprecated internal version. */
608
609
/*
610
611
612
613
614
615
* Get the platform-specific pref dir.
* Returning NULL means fatal error.
* Your string must end with a dir separator if you don't return NULL.
* Caller will allocator.Free() the retval if it's not NULL.
* Caller will make missing directories if necessary; this just reports
* the final path.
616
617
618
619
*/
char *__PHYSFS_platformCalcPrefDir(const char *org, const char *app);
620
/*
621
622
* Return a pointer that uniquely identifies the current thread.
* On a platform without threading, (0x1) will suffice. These numbers are
623
* arbitrary; the only requirement is that no two threads have the same
624
* pointer.
625
*/
626
void *__PHYSFS_platformGetThreadID(void);
627
628
629
630
/*
* Enumerate a directory of files. This follows the rules for the
631
632
633
634
635
636
* PHYSFS_Archiver::enumerate() method, except that the (dirName) that is
* passed to this function is converted to platform-DEPENDENT notation by
* the caller. The PHYSFS_Archiver version uses platform-independent
* notation. Note that ".", "..", and other meta-entries should always
* be ignored.
*/
637
PHYSFS_EnumerateCallbackResult __PHYSFS_platformEnumerate(const char *dirname,
638
639
PHYSFS_EnumerateCallback callback,
const char *origdir, void *callbackdata);
640
641
642
643
644
645
646
647
/*
* 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);
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
/*
* Remove a file or directory entry in the actual filesystem. (path) is
* specified in platform-dependent notation. Note that this deletes files
* _and_ directories, so you might need to do some determination.
* Non-empty directories should report an error and not delete themselves
* or their contents.
*
* Deleting a symlink should remove the link, not what it points to.
*
* On error, return zero and set the error message. Return non-zero on success.
*/
int __PHYSFS_platformDelete(const char *path);
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
/*
* Create a platform-specific mutex. This can be whatever datatype your
* platform uses for mutexes, but it is cast to a (void *) for abstractness.
*
* Return (NULL) if you couldn't create one. Systems without threads can
* return any arbitrary non-NULL value.
*/
void *__PHYSFS_platformCreateMutex(void);
/*
* Destroy a platform-specific mutex, and clean up any resources associated
* with it. (mutex) is a value previously returned by
* __PHYSFS_platformCreateMutex(). This can be a no-op on single-threaded
* platforms.
*/
void __PHYSFS_platformDestroyMutex(void *mutex);
/*
* Grab possession of a platform-specific mutex. Mutexes should be recursive;
* that is, the same thread should be able to call this function multiple
* times in a row without causing a deadlock. This function should block
* until a thread can gain possession of the mutex.
*
* Return non-zero if the mutex was grabbed, zero if there was an
* unrecoverable problem grabbing it (this should not be a matter of
* timing out! We're talking major system errors; block until the mutex
* is available otherwise.)
690
*
691
* _DO NOT_ call PHYSFS_setErrorCode() in here! Since setErrorCode calls this
692
693
* function, you'll cause an infinite recursion. This means you can't
* use the BAIL_*MACRO* macros, either.
694
695
696
697
698
699
700
701
*/
int __PHYSFS_platformGrabMutex(void *mutex);
/*
* Relinquish possession of the mutex when this method has been called
* once for each time that platformGrabMutex was called. Once possession has
* been released, the next thread in line to grab the mutex (if any) may
* proceed.
702
*
703
* _DO NOT_ call PHYSFS_setErrorCode() in here! Since setErrorCode calls this
704
705
* function, you'll cause an infinite recursion. This means you can't
* use the BAIL_*MACRO* macros, either.
706
707
708
*/
void __PHYSFS_platformReleaseMutex(void *mutex);
709
710
711
712
#if PHYSFS_HAVE_PRAGMA_VISIBILITY
#pragma GCC visibility pop
#endif
713
#ifdef __cplusplus
714
}
715
716
717
718
719
#endif
#endif
/* end of physfs_internal.h ... */