physfs_internal.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
/*
* 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
struct __PHYSFS_DIRREADER__;
18
struct __PHYSFS_FILEFUNCTIONS__;
19
20
21
22
23
24
25
26
27
typedef struct __PHYSFS_FILEHANDLE__
{
/*
* This is reserved for the driver to store information.
*/
void *opaque;
/*
28
* This should be the DirHandle that created this FileHandle.
30
const struct __PHYSFS_DIRREADER__ *dirReader;
32
33
34
35
36
37
38
39
40
/*
* Pointer to the file i/o functions for this filehandle.
*/
const struct __PHYSFS_FILEFUNCTIONS__ *funcs;
} FileHandle;
typedef struct __PHYSFS_FILEFUNCTIONS__
{
41
42
43
/*
* Read more from the file.
*/
44
int (*read)(FileHandle *handle, void *buffer,
45
46
47
48
49
50
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).
*/
51
int (*write)(FileHandle *handle, void *buffer,
52
53
54
55
56
unsigned int objSize, unsigned int objCount);
/*
* Returns non-zero if at end of file.
*/
57
int (*eof)(FileHandle *handle);
58
59
60
61
/*
* Returns byte offset from start of file.
*/
62
int (*tell)(FileHandle *handle);
63
64
65
66
67
/*
* Move read/write pointer to byte offset from start of file.
* Returns non-zero on success, zero on error.
*/
68
int (*seek)(FileHandle *handle, int offset);
69
70
/*
71
* Close the file, and free the FileHandle structure (including "opaque").
73
74
int (*close)(FileHandle *handle);
} FileFunctions;
75
76
77
78
79
80
81
82
83
typedef struct __PHYSFS_DIRREADER__
{
/*
* This is reserved for the driver to store information.
*/
void *opaque;
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
/*
* Pointer to the directory i/o functions for this reader.
*/
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
* notation.
*/
int (*isArchive)(const char *filename);
/*
* Return a DirHandle for dir/archive (name).
* This filename is in platform-dependent notation.
* return (NULL) on error.
*/
DirHandle *(*openArchive)(const char *name);
112
113
114
/*
* Returns a list (freeable via PHYSFS_freeList()) of
* all files in dirname.
115
* This dirname is in platform-independent notation.
116
*/
117
char **(*enumerateFiles)(DirHandle *r, const char *dirname);
118
119
120
/*
* Returns non-zero if filename is really a directory.
121
* This filename is in platform-independent notation.
122
*/
123
int (*isDirectory)(DirHandle *r, const char *name);
124
125
126
/*
* Returns non-zero if filename is really a symlink.
127
* This filename is in platform-independent notation.
128
*/
129
int (*isSymLink)(DirHandle *r, const char *name);
130
131
132
/*
* Returns non-zero if filename can be opened for reading.
133
* This filename is in platform-independent notation.
134
*/
135
int (*isOpenable)(DirHandle *r, const char *name);
136
137
138
/*
* Open file for reading, and return a FileHandle.
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
* This filename is in platform-independent notation.
*/
FileHandle *(*openRead)(DirHandle *r, const char *filename);
/*
* Open file for writing, and return a FileHandle.
* This filename is in platform-independent notation.
* This method may be NULL.
*/
FileHandle *(*openWrite)(DirHandle *r, const char *filename);
/*
* Open file for appending, and return a FileHandle.
* This filename is in platform-independent notation.
* This method may be NULL.
154
*/
155
FileHandle *(*openAppend)(DirHandle *r, const char *filename);
156
157
/*
158
* Close directories/archives, and free the handle, including
159
* the "opaque" entry. This should assume that it won't be called if
160
* there are still files open from this DirHandle.
161
*/
162
163
void (*close)(DirHandle *r);
} DirFunctions;
164
165
166
167
168
169
/* error messages... */
#define ERR_IS_INITIALIZED "Already initialized"
#define ERR_NOT_INITIALIZED "Not initialized"
#define ERR_INVALID_ARGUMENT "Invalid argument"
170
#define ERR_FILES_OPEN_READ "Files still open for reading"
171
172
173
174
175
#define ERR_FILES_OPEN_WRITE "Files still open for writing"
#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"
176
#define ERR_UNSUPPORTED_ARCHIVE "Archive type unsupported"
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
/*
* 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.
*/
void __PHYSFS_setError(const char *err);
/* This gets used all over for lessening code clutter. */
#define BAIL_IF_MACRO(c, e, r) if (c) { __PHYSFS_setError(e); return(r); }
/*--------------------------------------------------------------------------*/
/*--------------------------------------------------------------------------*/
/*------------ ----------------*/
/*------------ You MUST implement the following functions ----------------*/
/*------------ if porting to a new platform. ----------------*/
/*------------ (see unix.c for an example) ----------------*/
/*------------ ----------------*/
/*--------------------------------------------------------------------------*/
/*--------------------------------------------------------------------------*/
/*
* The dir separator; "/" on unix, "\\" on win32, ":" on MacOS, etc...
* Obviously, this isn't a function, but it IS a null-terminated string.
*/
extern const char *__PHYSFS_PlatformDirSeparator;
/*
* Platform implementation of PHYSFS_getCdRomDirs()...
* See physfs.h. The retval should be freeable via PHYSFS_freeList().
*/
char **__PHYSFS_platformDetectAvailableCDs(void);
/*
* Calculate the base dir, if your platform needs special consideration.
* Just return NULL if the standard routines will suffice. (see
* calculateBaseDir() in physfs.c ...)
* Caller will free() the retval if it's not NULL.
*/
char *__PHYSFS_platformCalcBaseDir(char *argv0);
/*
* Get the platform-specific user name.
* Caller will free() the retval if it's not NULL. If it's NULL, the username
* will default to "default".
*/
char *__PHYSFS_platformGetUserName(void);
/*
* Get the platform-specific user dir.
* Caller will free() the retval if it's not NULL. If it's NULL, the userdir
* will default to basedir/username.
*/
char *__PHYSFS_platformGetUserDir(void);
/*
* Return a number that uniquely identifies the current thread.
* On a platform without threading, (1) will suffice. These numbers are
* arbitrary; the only requirement is that no two threads have the same
* number.
*/
int __PHYSFS_platformGetThreadID(void);
/*
* This is a pass-through to whatever stricmp() is called on your platform.
*/
int __PHYSFS_platformStricmp(const char *str1, const char *str2);
251
252
253
254
255
/*
* Return non-zero if filename (in platform-dependent notation) is a symlink.
*/
int __PHYSFS_platformIsSymlink(const char *fname);
256
257
258
259
260
261
262
263
#ifdef __cplusplus
extern "C" {
#endif
#endif
/* end of physfs_internal.h ... */