/
physfs_internal.h
729 lines (618 loc) · 27.3 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
169
170
171
172
173
/* by default, enable things, so builds can opt out of a few things they
want to avoid. But you can build with this #defined to 0 if you would
like to turn off everything except a handful of things you opt into. */
#ifndef PHYSFS_SUPPORTS_DEFAULT
#define PHYSFS_SUPPORTS_DEFAULT 1
#endif
174
#ifndef PHYSFS_SUPPORTS_ZIP
175
#define PHYSFS_SUPPORTS_ZIP PHYSFS_SUPPORTS_DEFAULT
176
177
#endif
#ifndef PHYSFS_SUPPORTS_7Z
178
#define PHYSFS_SUPPORTS_7Z PHYSFS_SUPPORTS_DEFAULT
179
180
#endif
#ifndef PHYSFS_SUPPORTS_GRP
181
#define PHYSFS_SUPPORTS_GRP PHYSFS_SUPPORTS_DEFAULT
182
183
#endif
#ifndef PHYSFS_SUPPORTS_HOG
184
#define PHYSFS_SUPPORTS_HOG PHYSFS_SUPPORTS_DEFAULT
185
186
#endif
#ifndef PHYSFS_SUPPORTS_MVL
187
#define PHYSFS_SUPPORTS_MVL PHYSFS_SUPPORTS_DEFAULT
188
189
#endif
#ifndef PHYSFS_SUPPORTS_WAD
190
#define PHYSFS_SUPPORTS_WAD PHYSFS_SUPPORTS_DEFAULT
191
#endif
192
#ifndef PHYSFS_SUPPORTS_QPAK
193
#define PHYSFS_SUPPORTS_QPAK PHYSFS_SUPPORTS_DEFAULT
194
#endif
195
#ifndef PHYSFS_SUPPORTS_SLB
196
#define PHYSFS_SUPPORTS_SLB PHYSFS_SUPPORTS_DEFAULT
197
#endif
198
#ifndef PHYSFS_SUPPORTS_ISO9660
199
#define PHYSFS_SUPPORTS_ISO9660 PHYSFS_SUPPORTS_DEFAULT
200
#endif
201
#ifndef PHYSFS_SUPPORTS_VDF
202
#define PHYSFS_SUPPORTS_VDF PHYSFS_SUPPORTS_DEFAULT
203
#endif
204
205
206
207
208
209
#if PHYSFS_SUPPORTS_7Z
/* 7zip support needs a global init function called at startup (no deinit). */
extern void SZIP_global_init(void);
#endif
210
211
/* The latest supported PHYSFS_Io::version value. */
#define CURRENT_PHYSFS_IO_API_VERSION 0
212
213
214
/* The latest supported PHYSFS_Archiver::version value. */
#define CURRENT_PHYSFS_ARCHIVER_API_VERSION 0
215
216
/* This byteorder stuff was lifted from SDL. https://www.libsdl.org/ */
217
218
219
#define PHYSFS_LIL_ENDIAN 1234
#define PHYSFS_BIG_ENDIAN 4321
220
221
222
223
224
225
226
227
228
229
#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
230
#else
231
#define PHYSFS_BYTEORDER PHYSFS_LIL_ENDIAN
232
#endif
233
#endif /* __linux__ */
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
/*
* 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.
*/
254
255
256
void __PHYSFS_sort(void *entries, size_t max,
int (*cmpfn)(void *, size_t, size_t),
void (*swapfn)(void *, size_t, size_t));
257
258
/* These get used all over for lessening code clutter. */
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
/* "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)
277
278
279
#define __PHYSFS_ARRAYLEN(x) ( (sizeof (x)) / (sizeof (x[0])) )
280
281
282
283
#ifdef PHYSFS_NO_64BIT_SUPPORT
#define __PHYSFS_SI64(x) ((PHYSFS_sint64) (x))
#define __PHYSFS_UI64(x) ((PHYSFS_uint64) (x))
#elif (defined __GNUC__)
284
285
#define __PHYSFS_SI64(x) x##LL
#define __PHYSFS_UI64(x) x##ULL
286
287
288
#elif (defined _MSC_VER)
#define __PHYSFS_SI64(x) x##i64
#define __PHYSFS_UI64(x) x##ui64
289
#else
290
291
#define __PHYSFS_SI64(x) ((PHYSFS_sint64) (x))
#define __PHYSFS_UI64(x) ((PHYSFS_uint64) (x))
292
293
#endif
294
295
296
297
298
299
300
301
302
/*
* 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) ( \
303
304
(sizeof (PHYSFS_uint64) <= sizeof (size_t)) || \
((s) < (__PHYSFS_UI64(0xFFFFFFFFFFFFFFFF) >> (64-(sizeof(size_t)*8)))) \
305
)
306
307
308
309
310
311
/*
* Like strdup(), but uses the current PhysicsFS allocator.
*/
char *__PHYSFS_strdup(const char *str);
312
313
314
315
316
/*
* Give a hash value for a C string (uses djb's xor hashing algorithm).
*/
PHYSFS_uint32 __PHYSFS_hashString(const char *str, size_t len);
317
318
/*
319
* The current allocator. Not valid before PHYSFS_init is called!
320
*/
321
extern PHYSFS_Allocator __PHYSFS_AllocatorHooks;
322
323
324
/* convenience macro to make this less cumbersome internally... */
#define allocator __PHYSFS_AllocatorHooks
325
326
327
328
329
330
331
332
/*
* 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);
333
334
335
336
337
338
339
340
/*
* 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 *));
341
342
343
344
345
/*
* 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);"
*/
346
int __PHYSFS_readAll(PHYSFS_Io *io, void *buf, const size_t len);
347
348
349
350
/* These are shared between some archivers. */
351
void UNPK_abandonArchive(void *opaque);
352
void UNPK_closeArchive(void *opaque);
353
void *UNPK_openArchive(PHYSFS_Io *io);
354
void *UNPK_addEntry(void *opaque, char *name, const int isdir,
355
const PHYSFS_sint64 ctime, const PHYSFS_sint64 mtime,
356
const PHYSFS_uint64 pos, const PHYSFS_uint64 len);
357
PHYSFS_Io *UNPK_openRead(void *opaque, const char *name);
358
359
360
361
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);
362
int UNPK_stat(void *opaque, const char *fn, PHYSFS_Stat *st);
363
#define UNPK_enumerate __PHYSFS_DirTreeEnumerate
364
365
366
367
/* Optional API many archivers use this to manage their directory tree. */
368
/* !!! FIXME: document this better. */
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
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;
388
int __PHYSFS_DirTreeInit(__PHYSFS_DirTree *dt, const size_t entrylen);
389
390
void *__PHYSFS_DirTreeAdd(__PHYSFS_DirTree *dt, char *name, const int isdir);
void *__PHYSFS_DirTreeFind(__PHYSFS_DirTree *dt, const char *path);
391
392
PHYSFS_EnumerateCallbackResult __PHYSFS_DirTreeEnumerate(void *opaque,
const char *dname, PHYSFS_EnumerateCallback cb,
393
const char *origdir, void *callbackdata);
394
395
396
397
void __PHYSFS_DirTreeDeinit(__PHYSFS_DirTree *dt);
398
399
400
401
402
/*--------------------------------------------------------------------------*/
/*--------------------------------------------------------------------------*/
/*------------ ----------------*/
/*------------ You MUST implement the following functions ----------------*/
/*------------ if porting to a new platform. ----------------*/
403
/*------------ (see platform/unix.c for an example) ----------------*/
404
405
406
407
408
409
/*------------ ----------------*/
/*--------------------------------------------------------------------------*/
/*--------------------------------------------------------------------------*/
/*
410
411
412
* 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.
413
*/
414
#if defined(PHYSFS_PLATFORM_WINDOWS) || defined(PHYSFS_PLATFORM_OS2)
415
416
#define __PHYSFS_platformDirSeparator '\\'
#else
417
#define __PHYSFS_STANDARD_DIRSEP 1
418
419
#define __PHYSFS_platformDirSeparator '/'
#endif
420
421
422
/*
* Initialize the platform. This is called when PHYSFS_init() is called from
423
* the application.
424
425
426
427
428
429
*
* Return zero if there was a catastrophic failure (which prevents you from
* functioning at all), and non-zero otherwise.
*/
int __PHYSFS_platformInit(void);
430
431
432
433
434
435
/*
* 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.
*/
436
void __PHYSFS_platformDeinit(void);
437
438
439
440
441
442
443
444
445
446
447
448
449
/*
* 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.
*
450
* Call PHYSFS_setErrorCode() and return (NULL) if the file can't be opened.
451
452
453
*/
void *__PHYSFS_platformOpenRead(const char *filename);
454
455
456
457
458
459
460
461
462
463
464
465
466
/*
* 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.
*
467
* Call PHYSFS_setErrorCode() and return (NULL) if the file can't be opened.
468
469
470
*/
void *__PHYSFS_platformOpenWrite(const char *filename);
471
472
473
474
475
476
477
478
479
480
481
482
483
484
/*
* 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.
*
485
* Call PHYSFS_setErrorCode() and return (NULL) if the file can't be opened.
486
487
488
489
490
*/
void *__PHYSFS_platformOpenAppend(const char *filename);
/*
* Read more data from a platform-specific file handle. (opaque) should be
491
492
493
494
495
496
* 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
497
* error, and call PHYSFS_setErrorCode() to describe the problem; the file
498
499
500
* 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.
501
*/
502
PHYSFS_sint64 __PHYSFS_platformRead(void *opaque, void *buf, PHYSFS_uint64 len);
503
504
505
/*
* Write more data to a platform-specific file handle. (opaque) should be
506
507
508
509
* 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
510
* error, and call PHYSFS_setErrorCode() to describe the problem; the file
511
512
513
* 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.
514
*/
515
PHYSFS_sint64 __PHYSFS_platformWrite(void *opaque, const void *buffer,
516
PHYSFS_uint64 len);
517
518
519
520
521
522
523
524
525
/*
* 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.
*
526
* On error, call PHYSFS_setErrorCode() and return zero. On success, return
527
528
529
530
* a non-zero value.
*/
int __PHYSFS_platformSeek(void *opaque, PHYSFS_uint64 pos);
531
532
533
534
535
536
537
538
/*
* 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.
*
539
* On error, call PHYSFS_setErrorCode() and return -1. On success, return >= 0.
540
541
542
*/
PHYSFS_sint64 __PHYSFS_platformTell(void *opaque);
543
544
545
546
547
548
549
/*
* 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.
*
550
* Return -1 if you can't do it, and call PHYSFS_setErrorCode(). Otherwise,
551
552
553
554
* return the file length in 8-bit bytes.
*/
PHYSFS_sint64 __PHYSFS_platformFileLength(void *handle);
555
556
/*
557
558
559
560
* 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
561
562
* default. if (follow), we want to follow symlinks and stat what they
* link to and not the link itself.
563
564
*
* Return zero on failure, non-zero on success.
565
*/
566
int __PHYSFS_platformStat(const char *fn, PHYSFS_Stat *stat, const int follow);
567
568
569
570
571
572
573
574
575
576
577
/*
* 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);
/*
578
579
580
* 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.
581
*
582
583
* You should clean up all resources associated with (opaque); the pointer
* will be considered invalid after this call.
584
*/
585
void __PHYSFS_platformClose(void *opaque);
586
587
/*
588
589
590
591
592
* 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.
593
*/
594
void __PHYSFS_platformDetectAvailableCDs(PHYSFS_StringCallback cb, void *data);
595
596
597
598
599
/*
* Calculate the base dir, if your platform needs special consideration.
* Just return NULL if the standard routines will suffice. (see
* calculateBaseDir() in physfs.c ...)
600
* Your string must end with a dir separator if you don't return NULL.
601
* Caller will allocator.Free() the retval if it's not NULL.
602
*/
603
char *__PHYSFS_platformCalcBaseDir(const char *argv0);
604
605
/*
606
* Get the platform-specific user dir.
607
608
609
* 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.
610
*/
611
char *__PHYSFS_platformCalcUserDir(void);
612
613
614
615
616
/* This is the cached version from PHYSFS_init(). This is a fast call. */
const char *__PHYSFS_getUserDir(void); /* not deprecated internal version. */
617
618
/*
619
620
621
622
623
624
* 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.
625
626
627
628
*/
char *__PHYSFS_platformCalcPrefDir(const char *org, const char *app);
629
/*
630
631
* Return a pointer that uniquely identifies the current thread.
* On a platform without threading, (0x1) will suffice. These numbers are
632
* arbitrary; the only requirement is that no two threads have the same
633
* pointer.
634
*/
635
void *__PHYSFS_platformGetThreadID(void);
636
637
638
639
/*
* Enumerate a directory of files. This follows the rules for the
640
641
642
643
644
645
* 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.
*/
646
PHYSFS_EnumerateCallbackResult __PHYSFS_platformEnumerate(const char *dirname,
647
648
PHYSFS_EnumerateCallback callback,
const char *origdir, void *callbackdata);
649
650
651
652
653
654
655
656
/*
* 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);
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
/*
* 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);
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
/*
* 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.)
699
*
700
* _DO NOT_ call PHYSFS_setErrorCode() in here! Since setErrorCode calls this
701
702
* function, you'll cause an infinite recursion. This means you can't
* use the BAIL_*MACRO* macros, either.
703
704
705
706
707
708
709
710
*/
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.
711
*
712
* _DO NOT_ call PHYSFS_setErrorCode() in here! Since setErrorCode calls this
713
714
* function, you'll cause an infinite recursion. This means you can't
* use the BAIL_*MACRO* macros, either.
715
716
717
*/
void __PHYSFS_platformReleaseMutex(void *mutex);
718
719
720
721
#if PHYSFS_HAVE_PRAGMA_VISIBILITY
#pragma GCC visibility pop
#endif
722
#ifdef __cplusplus
723
}
724
725
726
727
728
#endif
#endif
/* end of physfs_internal.h ... */