physfs_internal.h 26 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727
  1. /*
  2. * Internal function/structure declaration. Do NOT include in your
  3. * application.
  4. *
  5. * Please see the file LICENSE in the source's root directory.
  6. *
  7. * This file written by Ryan C. Gordon.
  8. */
  9. #ifndef _INCLUDE_PHYSFS_INTERNAL_H_
  10. #define _INCLUDE_PHYSFS_INTERNAL_H_
  11. #ifndef __PHYSICSFS_INTERNAL__
  12. #error Do not include this header from your applications.
  13. #endif
  14. #include "physfs.h"
  15. #ifdef __cplusplus
  16. extern "C" {
  17. #endif
  18. struct __PHYSFS_DIRHANDLE__;
  19. struct __PHYSFS_FILEFUNCTIONS__;
  20. typedef struct __PHYSFS_LINKEDSTRINGLIST__
  21. {
  22. char *str;
  23. struct __PHYSFS_LINKEDSTRINGLIST__ *next;
  24. } LinkedStringList;
  25. typedef struct __PHYSFS_FILEHANDLE__
  26. {
  27. /*
  28. * This is reserved for the driver to store information.
  29. */
  30. void *opaque;
  31. /*
  32. * This should be the DirHandle that created this FileHandle.
  33. */
  34. const struct __PHYSFS_DIRHANDLE__ *dirHandle;
  35. /*
  36. * Pointer to the file i/o functions for this filehandle.
  37. */
  38. const struct __PHYSFS_FILEFUNCTIONS__ *funcs;
  39. } FileHandle;
  40. typedef struct __PHYSFS_FILEFUNCTIONS__
  41. {
  42. /*
  43. * Read more from the file.
  44. * Returns number of objects of (objSize) bytes read from file, -1
  45. * if complete failure.
  46. * On failure, call __PHYSFS_setError().
  47. */
  48. PHYSFS_sint64 (*read)(FileHandle *handle, void *buffer,
  49. PHYSFS_uint32 objSize, PHYSFS_uint32 objCount);
  50. /*
  51. * Write more to the file. Archives don't have to implement this.
  52. * (Set it to NULL if not implemented).
  53. * Returns number of objects of (objSize) bytes written to file, -1
  54. * if complete failure.
  55. * On failure, call __PHYSFS_setError().
  56. */
  57. PHYSFS_sint64 (*write)(FileHandle *handle, const void *buffer,
  58. PHYSFS_uint32 objSize, PHYSFS_uint32 objCount);
  59. /*
  60. * Returns non-zero if at end of file.
  61. */
  62. int (*eof)(FileHandle *handle);
  63. /*
  64. * Returns byte offset from start of file.
  65. */
  66. PHYSFS_sint64 (*tell)(FileHandle *handle);
  67. /*
  68. * Move read/write pointer to byte offset from start of file.
  69. * Returns non-zero on success, zero on error.
  70. * On failure, call __PHYSFS_setError().
  71. */
  72. int (*seek)(FileHandle *handle, PHYSFS_uint64 offset);
  73. /*
  74. * Return number of bytes available in the file, or -1 if you
  75. * aren't able to determine.
  76. * On failure, call __PHYSFS_setError().
  77. */
  78. PHYSFS_sint64 (*fileLength)(FileHandle *handle);
  79. /*
  80. * Close the file, and free the FileHandle structure (including "opaque").
  81. * returns non-zero on success, zero if can't close file.
  82. * On failure, call __PHYSFS_setError().
  83. */
  84. int (*fileClose)(FileHandle *handle);
  85. } FileFunctions;
  86. typedef struct __PHYSFS_DIRHANDLE__
  87. {
  88. /*
  89. * This is reserved for the driver to store information.
  90. */
  91. void *opaque;
  92. /*
  93. * Pointer to the directory i/o functions for this handle.
  94. */
  95. const struct __PHYSFS_DIRFUNCTIONS__ *funcs;
  96. } DirHandle;
  97. /*
  98. * Symlinks should always be followed; PhysicsFS will use
  99. * DirFunctions->isSymLink() and make a judgement on whether to
  100. * continue to call other methods based on that.
  101. */
  102. typedef struct __PHYSFS_DIRFUNCTIONS__
  103. {
  104. /*
  105. * Returns non-zero if (filename) is a valid archive that this
  106. * driver can handle. This filename is in platform-dependent
  107. * notation. forWriting is non-zero if this is to be used for
  108. * the write directory, and zero if this is to be used for an
  109. * element of the search path.
  110. */
  111. int (*isArchive)(const char *filename, int forWriting);
  112. /*
  113. * Return a DirHandle for dir/archive (name).
  114. * This filename is in platform-dependent notation.
  115. * forWriting is non-zero if this is to be used for
  116. * the write directory, and zero if this is to be used for an
  117. * element of the search path.
  118. * Returns NULL on failure, and calls __PHYSFS_setError().
  119. */
  120. DirHandle *(*openArchive)(const char *name, int forWriting);
  121. /*
  122. * Returns a list of all files in dirname. Each element of this list
  123. * (and its "str" field) will be deallocated with the system's free()
  124. * function by the caller, so be sure to explicitly malloc() each
  125. * chunk. Omit symlinks if (omitSymLinks) is non-zero.
  126. * If you have a memory failure, return as much as you can.
  127. * This dirname is in platform-independent notation.
  128. */
  129. LinkedStringList *(*enumerateFiles)(DirHandle *r,
  130. const char *dirname,
  131. int omitSymLinks);
  132. /*
  133. * Returns non-zero if filename can be opened for reading.
  134. * This filename is in platform-independent notation.
  135. */
  136. int (*exists)(DirHandle *r, const char *name);
  137. /*
  138. * Returns non-zero if filename is really a directory.
  139. * This filename is in platform-independent notation.
  140. */
  141. int (*isDirectory)(DirHandle *r, const char *name);
  142. /*
  143. * Returns non-zero if filename is really a symlink.
  144. * This filename is in platform-independent notation.
  145. */
  146. int (*isSymLink)(DirHandle *r, const char *name);
  147. /*
  148. * Retrieve the last modification time (mtime) of a file.
  149. * Returns -1 on failure, or the file's mtime in seconds since
  150. * the epoch (Jan 1, 1970) on success.
  151. * This filename is in platform-independent notation.
  152. */
  153. PHYSFS_sint64 (*getLastModTime)(DirHandle *r, const char *filename);
  154. /*
  155. * Open file for reading, and return a FileHandle.
  156. * This filename is in platform-independent notation.
  157. * If you can't handle multiple opens of the same file,
  158. * you can opt to fail for the second call.
  159. * Fail if the file does not exist.
  160. * Returns NULL on failure, and calls __PHYSFS_setError().
  161. */
  162. FileHandle *(*openRead)(DirHandle *r, const char *filename);
  163. /*
  164. * Open file for writing, and return a FileHandle.
  165. * If the file does not exist, it should be created. If it exists,
  166. * it should be truncated to zero bytes. The writing
  167. * offset should be the start of the file.
  168. * This filename is in platform-independent notation.
  169. * This method may be NULL.
  170. * If you can't handle multiple opens of the same file,
  171. * you can opt to fail for the second call.
  172. * Returns NULL on failure, and calls __PHYSFS_setError().
  173. */
  174. FileHandle *(*openWrite)(DirHandle *r, const char *filename);
  175. /*
  176. * Open file for appending, and return a FileHandle.
  177. * If the file does not exist, it should be created. The writing
  178. * offset should be the end of the file.
  179. * This filename is in platform-independent notation.
  180. * This method may be NULL.
  181. * If you can't handle multiple opens of the same file,
  182. * you can opt to fail for the second call.
  183. * Returns NULL on failure, and calls __PHYSFS_setError().
  184. */
  185. FileHandle *(*openAppend)(DirHandle *r, const char *filename);
  186. /*
  187. * Delete a file in the archive/directory.
  188. * Return non-zero on success, zero on failure.
  189. * This filename is in platform-independent notation.
  190. * This method may be NULL.
  191. * On failure, call __PHYSFS_setError().
  192. */
  193. int (*remove)(DirHandle *r, const char *filename);
  194. /*
  195. * Create a directory in the archive/directory.
  196. * If the application is trying to make multiple dirs, PhysicsFS
  197. * will split them up into multiple calls before passing them to
  198. * your driver.
  199. * Return non-zero on success, zero on failure.
  200. * This filename is in platform-independent notation.
  201. * This method may be NULL.
  202. * On failure, call __PHYSFS_setError().
  203. */
  204. int (*mkdir)(DirHandle *r, const char *filename);
  205. /*
  206. * Close directories/archives, and free the handle, including
  207. * the "opaque" entry. This should assume that it won't be called if
  208. * there are still files open from this DirHandle.
  209. */
  210. void (*dirClose)(DirHandle *r);
  211. } DirFunctions;
  212. /* error messages... */
  213. #define ERR_IS_INITIALIZED "Already initialized"
  214. #define ERR_NOT_INITIALIZED "Not initialized"
  215. #define ERR_INVALID_ARGUMENT "Invalid argument"
  216. #define ERR_FILES_STILL_OPEN "Files still open"
  217. #define ERR_NO_DIR_CREATE "Failed to create directories"
  218. #define ERR_OUT_OF_MEMORY "Out of memory"
  219. #define ERR_NOT_IN_SEARCH_PATH "No such entry in search path"
  220. #define ERR_NOT_SUPPORTED "Operation not supported"
  221. #define ERR_UNSUPPORTED_ARCHIVE "Archive type unsupported"
  222. #define ERR_NOT_A_HANDLE "Not a file handle"
  223. #define ERR_INSECURE_FNAME "Insecure filename"
  224. #define ERR_SYMLINK_DISALLOWED "Symbolic links are disabled"
  225. #define ERR_NO_WRITE_DIR "Write directory is not set"
  226. #define ERR_NO_SUCH_FILE "No such file"
  227. #define ERR_PAST_EOF "Past end of file"
  228. #define ERR_ARC_IS_READ_ONLY "Archive is read-only"
  229. #define ERR_IO_ERROR "I/O error"
  230. #define ERR_CANT_SET_WRITE_DIR "Can't set write directory"
  231. #define ERR_SYMLINK_LOOP "Infinite symbolic link loop"
  232. #define ERR_COMPRESSION "(De)compression error"
  233. #define ERR_NOT_IMPLEMENTED "Not implemented"
  234. #define ERR_OS_ERROR "Operating system reported error"
  235. #define ERR_FILE_EXISTS "File already exists"
  236. #define ERR_NOT_A_DIR "Not a directory"
  237. #define ERR_FILE_NOT_FOUND "File not found"
  238. #define ERR_NOT_AN_ARCHIVE "Not an archive"
  239. #define ERR_CORRUPTED "Corrupted archive"
  240. /*
  241. * Call this to set the message returned by PHYSFS_getLastError().
  242. * Please only use the ERR_* constants above, or add new constants to the
  243. * above group, but I want these all in one place.
  244. *
  245. * Calling this with a NULL argument is a safe no-op.
  246. */
  247. void __PHYSFS_setError(const char *err);
  248. /*
  249. * Convert (dirName) to platform-dependent notation, then prepend (prepend)
  250. * and append (append) to the converted string.
  251. *
  252. * So, on Win32, calling:
  253. * __PHYSFS_convertToDependent("C:\", "my/files", NULL);
  254. * ...will return the string "C:\my\files".
  255. *
  256. * This is a convenience function; you might want to hack something out that
  257. * is less generic (and therefore more efficient).
  258. *
  259. * Be sure to free() the return value when done with it.
  260. */
  261. char *__PHYSFS_convertToDependent(const char *prepend,
  262. const char *dirName,
  263. const char *append);
  264. /*
  265. * Verify that (fname) (in platform-independent notation), in relation
  266. * to (h) is secure. That means that each element of fname is checked
  267. * for symlinks (if they aren't permitted). Also, elements such as
  268. * ".", "..", or ":" are flagged.
  269. *
  270. * Returns non-zero if string is safe, zero if there's a security issue.
  271. * PHYSFS_getLastError() will specify what was wrong.
  272. */
  273. int __PHYSFS_verifySecurity(DirHandle *h, const char *fname);
  274. /* These get used all over for lessening code clutter. */
  275. #define BAIL_MACRO(e, r) { __PHYSFS_setError(e); return r; }
  276. #define BAIL_IF_MACRO(c, e, r) if (c) { __PHYSFS_setError(e); return r; }
  277. #define BAIL_MACRO_MUTEX(e, m, r) { __PHYSFS_setError(e); __PHYSFS_platformReleaseMutex(m); return r; }
  278. #define BAIL_IF_MACRO_MUTEX(c, e, m, r) if (c) { __PHYSFS_setError(e); __PHYSFS_platformReleaseMutex(m); return r; }
  279. /*--------------------------------------------------------------------------*/
  280. /*--------------------------------------------------------------------------*/
  281. /*------------ ----------------*/
  282. /*------------ You MUST implement the following functions ----------------*/
  283. /*------------ if porting to a new platform. ----------------*/
  284. /*------------ (see platform/unix.c for an example) ----------------*/
  285. /*------------ ----------------*/
  286. /*--------------------------------------------------------------------------*/
  287. /*--------------------------------------------------------------------------*/
  288. /*
  289. * The dir separator; "/" on unix, "\\" on win32, ":" on MacOS, etc...
  290. * Obviously, this isn't a function, but it IS a null-terminated string.
  291. */
  292. extern const char *__PHYSFS_platformDirSeparator;
  293. /*
  294. * Initialize the platform. This is called when PHYSFS_init() is called from
  295. * the application. You can use this to (for example) determine what version
  296. * of Windows you're running.
  297. *
  298. * Return zero if there was a catastrophic failure (which prevents you from
  299. * functioning at all), and non-zero otherwise.
  300. */
  301. int __PHYSFS_platformInit(void);
  302. /*
  303. * Deinitialize the platform. This is called when PHYSFS_deinit() is called
  304. * from the application. You can use this to clean up anything you've
  305. * allocated in your platform driver.
  306. *
  307. * Return zero if there was a catastrophic failure (which prevents you from
  308. * functioning at all), and non-zero otherwise.
  309. */
  310. int __PHYSFS_platformDeinit(void);
  311. /*
  312. * Open a file for reading. (filename) is in platform-dependent notation. The
  313. * file pointer should be positioned on the first byte of the file.
  314. *
  315. * The return value will be some platform-specific datatype that is opaque to
  316. * the caller; it could be a (FILE *) under Unix, or a (HANDLE *) under win32.
  317. *
  318. * The same file can be opened for read multiple times, and each should have
  319. * a unique file handle; this is frequently employed to prevent race
  320. * conditions in the archivers.
  321. *
  322. * Call __PHYSFS_setError() and return (NULL) if the file can't be opened.
  323. */
  324. void *__PHYSFS_platformOpenRead(const char *filename);
  325. /*
  326. * Open a file for writing. (filename) is in platform-dependent notation. If
  327. * the file exists, it should be truncated to zero bytes, and if it doesn't
  328. * exist, it should be created as a zero-byte file. The file pointer should
  329. * be positioned on the first byte of the file.
  330. *
  331. * The return value will be some platform-specific datatype that is opaque to
  332. * the caller; it could be a (FILE *) under Unix, or a (HANDLE *) under win32,
  333. * etc.
  334. *
  335. * Opening a file for write multiple times has undefined results.
  336. *
  337. * Call __PHYSFS_setError() and return (NULL) if the file can't be opened.
  338. */
  339. void *__PHYSFS_platformOpenWrite(const char *filename);
  340. /*
  341. * Open a file for appending. (filename) is in platform-dependent notation. If
  342. * the file exists, the file pointer should be place just past the end of the
  343. * file, so that the first write will be one byte after the current end of
  344. * the file. If the file doesn't exist, it should be created as a zero-byte
  345. * file. The file pointer should be positioned on the first byte of the file.
  346. *
  347. * The return value will be some platform-specific datatype that is opaque to
  348. * the caller; it could be a (FILE *) under Unix, or a (HANDLE *) under win32,
  349. * etc.
  350. *
  351. * Opening a file for append multiple times has undefined results.
  352. *
  353. * Call __PHYSFS_setError() and return (NULL) if the file can't be opened.
  354. */
  355. void *__PHYSFS_platformOpenAppend(const char *filename);
  356. /*
  357. * Read more data from a platform-specific file handle. (opaque) should be
  358. * cast to whatever data type your platform uses. Read a maximum of (count)
  359. * objects of (size) 8-bit bytes to the area pointed to by (buffer). If there
  360. * isn't enough data available, return the number of full objects read, and
  361. * position the file pointer at the start of the first incomplete object.
  362. * On success, return (count) and position the file pointer one byte past
  363. * the end of the last read object. Return (-1) if there is a catastrophic
  364. * error, and call __PHYSFS_setError() to describe the problem; the file
  365. * pointer should not move in such a case.
  366. */
  367. PHYSFS_sint64 __PHYSFS_platformRead(void *opaque, void *buffer,
  368. PHYSFS_uint32 size, PHYSFS_uint32 count);
  369. /*
  370. * Write more data to a platform-specific file handle. (opaque) should be
  371. * cast to whatever data type your platform uses. Write a maximum of (count)
  372. * objects of (size) 8-bit bytes from the area pointed to by (buffer). If
  373. * there isn't enough data available, return the number of full objects
  374. * written, and position the file pointer at the start of the first
  375. * incomplete object. Return (-1) if there is a catastrophic error, and call
  376. * __PHYSFS_setError() to describe the problem; the file pointer should not
  377. * move in such a case.
  378. */
  379. PHYSFS_sint64 __PHYSFS_platformWrite(void *opaque, const void *buffer,
  380. PHYSFS_uint32 size, PHYSFS_uint32 count);
  381. /*
  382. * Set the file pointer to a new position. (opaque) should be cast to
  383. * whatever data type your platform uses. (pos) specifies the number
  384. * of 8-bit bytes to seek to from the start of the file. Seeking past the
  385. * end of the file is an error condition, and you should check for it.
  386. *
  387. * Not all file types can seek; this is to be expected by the caller.
  388. *
  389. * On error, call __PHYSFS_setError() and return zero. On success, return
  390. * a non-zero value.
  391. */
  392. int __PHYSFS_platformSeek(void *opaque, PHYSFS_uint64 pos);
  393. /*
  394. * Get the file pointer's position, in an 8-bit byte offset from the start of
  395. * the file. (opaque) should be cast to whatever data type your platform
  396. * uses.
  397. *
  398. * Not all file types can "tell"; this is to be expected by the caller.
  399. *
  400. * On error, call __PHYSFS_setError() and return zero. On success, return
  401. * a non-zero value.
  402. */
  403. PHYSFS_sint64 __PHYSFS_platformTell(void *opaque);
  404. /*
  405. * Determine the current size of a file, in 8-bit bytes, from an open file.
  406. *
  407. * The caller expects that this information may not be available for all
  408. * file types on all platforms.
  409. *
  410. * Return -1 if you can't do it, and call __PHYSFS_setError(). Otherwise,
  411. * return the file length in 8-bit bytes.
  412. */
  413. PHYSFS_sint64 __PHYSFS_platformFileLength(void *handle);
  414. /*
  415. * Determine if a file is at EOF. (opaque) should be cast to whatever data
  416. * type your platform uses.
  417. *
  418. * The caller expects that there was a short read before calling this.
  419. *
  420. * Return non-zero if EOF, zero if it is _not_ EOF.
  421. */
  422. int __PHYSFS_platformEOF(void *opaque);
  423. /*
  424. * Flush any pending writes to disk. (opaque) should be cast to whatever data
  425. * type your platform uses. Be sure to check for errors; the caller expects
  426. * that this function can fail if there was a flushing error, etc.
  427. *
  428. * Return zero on failure, non-zero on success.
  429. */
  430. int __PHYSFS_platformFlush(void *opaque);
  431. /*
  432. * Flush and close a file. (opaque) should be cast to whatever data type
  433. * your platform uses. Be sure to check for errors when closing; the
  434. * caller expects that this function can fail if there was a flushing
  435. * error, etc.
  436. *
  437. * You should clean up all resources associated with (opaque).
  438. *
  439. * Return zero on failure, non-zero on success.
  440. */
  441. int __PHYSFS_platformClose(void *opaque);
  442. /*
  443. * Platform implementation of PHYSFS_getCdRomDirs()...
  444. * See physfs.h. The retval should be freeable via PHYSFS_freeList().
  445. */
  446. char **__PHYSFS_platformDetectAvailableCDs(void);
  447. /*
  448. * Calculate the base dir, if your platform needs special consideration.
  449. * Just return NULL if the standard routines will suffice. (see
  450. * calculateBaseDir() in physfs.c ...)
  451. * Caller will free() the retval if it's not NULL.
  452. */
  453. char *__PHYSFS_platformCalcBaseDir(const char *argv0);
  454. /*
  455. * Get the platform-specific user name.
  456. * Caller will free() the retval if it's not NULL. If it's NULL, the username
  457. * will default to "default".
  458. */
  459. char *__PHYSFS_platformGetUserName(void);
  460. /*
  461. * Get the platform-specific user dir.
  462. * Caller will free() the retval if it's not NULL. If it's NULL, the userdir
  463. * will default to basedir/username.
  464. */
  465. char *__PHYSFS_platformGetUserDir(void);
  466. /*
  467. * Return a number that uniquely identifies the current thread.
  468. * On a platform without threading, (1) will suffice. These numbers are
  469. * arbitrary; the only requirement is that no two threads have the same
  470. * number.
  471. */
  472. PHYSFS_uint64 __PHYSFS_platformGetThreadID(void);
  473. /*
  474. * This is a pass-through to whatever stricmp() is called on your platform.
  475. */
  476. int __PHYSFS_platformStricmp(const char *str1, const char *str2);
  477. /*
  478. * Return non-zero if filename (in platform-dependent notation) exists.
  479. * Symlinks should be followed; if what the symlink points to is missing,
  480. * then the retval is false.
  481. */
  482. int __PHYSFS_platformExists(const char *fname);
  483. /*
  484. * Return the last modified time (in seconds since the epoch) of a file.
  485. * Returns -1 on failure. (fname) is in platform-dependent notation.
  486. * Symlinks should be followed; if what the symlink points to is missing,
  487. * then the retval is -1.
  488. */
  489. PHYSFS_sint64 __PHYSFS_platformGetLastModTime(const char *fname);
  490. /*
  491. * Return non-zero if filename (in platform-dependent notation) is a symlink.
  492. */
  493. int __PHYSFS_platformIsSymLink(const char *fname);
  494. /*
  495. * Return non-zero if filename (in platform-dependent notation) is a symlink.
  496. * Symlinks should be followed; if what the symlink points to is missing,
  497. * or isn't a directory, then the retval is false.
  498. */
  499. int __PHYSFS_platformIsDirectory(const char *fname);
  500. /*
  501. * Convert (dirName) to platform-dependent notation, then prepend (prepend)
  502. * and append (append) to the converted string.
  503. *
  504. * So, on Win32, calling:
  505. * __PHYSFS_platformCvtToDependent("C:\", "my/files", NULL);
  506. * ...will return the string "C:\my\files".
  507. *
  508. * This can be implemented in a platform-specific manner, so you can get
  509. * get a speed boost that the default implementation can't, since
  510. * you can make assumptions about the size of strings, etc..
  511. *
  512. * Platforms that choose not to implement this may just call
  513. * __PHYSFS_convertToDependent() as a passthrough, which may fit the bill
  514. * already.
  515. *
  516. * Be sure to free() the return value when done with it.
  517. */
  518. char *__PHYSFS_platformCvtToDependent(const char *prepend,
  519. const char *dirName,
  520. const char *append);
  521. /*
  522. * Make the current thread give up a timeslice. This is called in a loop
  523. * while waiting for various external forces to get back to us.
  524. */
  525. void __PHYSFS_platformTimeslice(void);
  526. /*
  527. * Enumerate a directory of files. This follows the rules for the
  528. * DirFunctions->enumerateFiles() method (see above), except that the
  529. * (dirName) that is passed to this function is converted to
  530. * platform-DEPENDENT notation by the caller. The DirFunctions version
  531. * uses platform-independent notation. Note that ".", "..", and other
  532. * metaentries should always be ignored.
  533. */
  534. LinkedStringList *__PHYSFS_platformEnumerateFiles(const char *dirname,
  535. int omitSymLinks);
  536. /*
  537. * Get the current working directory. The return value should be an
  538. * absolute path in platform-dependent notation. The caller will deallocate
  539. * the return value with the standard C runtime free() function when it
  540. * is done with it.
  541. * On error, return NULL and set the error message.
  542. */
  543. char *__PHYSFS_platformCurrentDir(void);
  544. /*
  545. * Get the real physical path to a file. (path) is specified in
  546. * platform-dependent notation, as should your return value be.
  547. * All relative paths should be removed, leaving you with an absolute
  548. * path. Symlinks should be resolved, too, so that the returned value is
  549. * the most direct path to a file.
  550. * The return value will be deallocated with the standard C runtime free()
  551. * function when the caller is done with it.
  552. * On error, return NULL and set the error message.
  553. */
  554. char *__PHYSFS_platformRealPath(const char *path);
  555. /*
  556. * Make a directory in the actual filesystem. (path) is specified in
  557. * platform-dependent notation. On error, return zero and set the error
  558. * message. Return non-zero on success.
  559. */
  560. int __PHYSFS_platformMkDir(const char *path);
  561. /*
  562. * Remove a file or directory entry in the actual filesystem. (path) is
  563. * specified in platform-dependent notation. Note that this deletes files
  564. * _and_ directories, so you might need to do some determination.
  565. * Non-empty directories should report an error and not delete themselves
  566. * or their contents.
  567. *
  568. * Deleting a symlink should remove the link, not what it points to.
  569. *
  570. * On error, return zero and set the error message. Return non-zero on success.
  571. */
  572. int __PHYSFS_platformDelete(const char *path);
  573. /*
  574. * Create a platform-specific mutex. This can be whatever datatype your
  575. * platform uses for mutexes, but it is cast to a (void *) for abstractness.
  576. *
  577. * Return (NULL) if you couldn't create one. Systems without threads can
  578. * return any arbitrary non-NULL value.
  579. */
  580. void *__PHYSFS_platformCreateMutex(void);
  581. /*
  582. * Destroy a platform-specific mutex, and clean up any resources associated
  583. * with it. (mutex) is a value previously returned by
  584. * __PHYSFS_platformCreateMutex(). This can be a no-op on single-threaded
  585. * platforms.
  586. */
  587. void __PHYSFS_platformDestroyMutex(void *mutex);
  588. /*
  589. * Grab possession of a platform-specific mutex. Mutexes should be recursive;
  590. * that is, the same thread should be able to call this function multiple
  591. * times in a row without causing a deadlock. This function should block
  592. * until a thread can gain possession of the mutex.
  593. *
  594. * Return non-zero if the mutex was grabbed, zero if there was an
  595. * unrecoverable problem grabbing it (this should not be a matter of
  596. * timing out! We're talking major system errors; block until the mutex
  597. * is available otherwise.)
  598. *
  599. * _DO NOT_ call __PHYSFS_setError() in here! Since setError calls this
  600. * function, you'll cause an infinite recursion. This means you can't
  601. * use the BAIL_*MACRO* macros, either.
  602. */
  603. int __PHYSFS_platformGrabMutex(void *mutex);
  604. /*
  605. * Relinquish possession of the mutex when this method has been called
  606. * once for each time that platformGrabMutex was called. Once possession has
  607. * been released, the next thread in line to grab the mutex (if any) may
  608. * proceed.
  609. *
  610. * _DO NOT_ call __PHYSFS_setError() in here! Since setError calls this
  611. * function, you'll cause an infinite recursion. This means you can't
  612. * use the BAIL_*MACRO* macros, either.
  613. */
  614. void __PHYSFS_platformReleaseMutex(void *mutex);
  615. #ifdef __cplusplus
  616. }
  617. #endif
  618. #endif
  619. /* end of physfs_internal.h ... */