/*

 * Internal function/structure declaration. Do NOT include in your

 *  application.

 *

 * Please see the file LICENSE.txt 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

#include "physfs.h"

/* The holy trinity. */

#include <stdio.h>

#include <stdlib.h>

#include <string.h>

#include "physfs_platforms.h"

#include <assert.h>

/* !!! FIXME: remove this when revamping stack allocation code... */

#if defined(_MSC_VER) || defined(__MINGW32__)

#include <malloc.h>

#endif

#if PHYSFS_PLATFORM_SOLARIS

#include <alloca.h>

#endif

#ifdef __cplusplus

extern "C" {

#endif

#ifdef __GNUC__

#define PHYSFS_MINIMUM_GCC_VERSION(major, minor) \

    ( ((__GNUC__ << 16) + __GNUC_MINOR__) >= (((major) << 16) + (minor)) )

#else

#define PHYSFS_MINIMUM_GCC_VERSION(major, minor) (0)

#endif

#ifdef __cplusplus

    /* C++ always has a real inline keyword. */

#elif (defined macintosh) && !(defined __MWERKS__)

#   define inline

#elif (defined _MSC_VER)

#   define inline __inline

#endif

#if PHYSFS_PLATFORM_LINUX && !defined(_FILE_OFFSET_BITS)

#define _FILE_OFFSET_BITS 64

#endif

/*

 * 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!

 */

#define __PHYSFS_SMALLALLOCTHRESHOLD 256

void *__PHYSFS_initSmallAlloc(void *ptr, PHYSFS_uint64 len);

#define __PHYSFS_smallAlloc(bytes) ( \

    __PHYSFS_initSmallAlloc( \

        (((bytes) < __PHYSFS_SMALLALLOCTHRESHOLD) ? \

            alloca((size_t)((bytes)+sizeof(void*))) : NULL), (bytes)) \

)

void __PHYSFS_smallFree(void *ptr);

/* 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.

/* !!! FIXME: add alloca check here. */

#ifndef PHYSFS_SUPPORTS_ZIP

#define PHYSFS_SUPPORTS_ZIP 1

#endif

#ifndef PHYSFS_SUPPORTS_7Z

#define PHYSFS_SUPPORTS_7Z 0

#endif

#ifndef PHYSFS_SUPPORTS_GRP

#define PHYSFS_SUPPORTS_GRP 0

#endif

#ifndef PHYSFS_SUPPORTS_HOG

#define PHYSFS_SUPPORTS_HOG 0

#endif

#ifndef PHYSFS_SUPPORTS_MVL

#define PHYSFS_SUPPORTS_MVL 0

#endif

#ifndef PHYSFS_SUPPORTS_WAD

#define PHYSFS_SUPPORTS_WAD 0

#endif

#ifndef PHYSFS_SUPPORTS_ISO9660

#define PHYSFS_SUPPORTS_ISO9660 0

#endif

/* The latest supported PHYSFS_Io::version value. */

#define CURRENT_PHYSFS_IO_API_VERSION 0

#define PHYSFS_LIL_ENDIAN  1234

#define PHYSFS_BIG_ENDIAN  4321

#else

#endif

/*

 * 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.

 */

void __PHYSFS_sort(void *entries, size_t max,

                   int (*cmpfn)(void *, size_t, size_t),

                   void (*swapfn)(void *, size_t, size_t));

/*

 * This isn't a formal error code, it's just for BAIL_MACRO.

 *  It means: there was an error, but someone else already set it for us.

 */

#define ERRPASS PHYSFS_ERR_OK

/* These get used all over for lessening code clutter. */

#define __PHYSFS_ARRAYLEN(x) ( (sizeof (x)) / (sizeof (x[0])) )

#ifdef PHYSFS_NO_64BIT_SUPPORT

#define __PHYSFS_SI64(x) ((PHYSFS_sint64) (x))

#define __PHYSFS_UI64(x) ((PHYSFS_uint64) (x))

#elif (defined __GNUC__)

#define __PHYSFS_SI64(x) x##LL

#define __PHYSFS_UI64(x) x##ULL

#elif (defined _MSC_VER)

#define __PHYSFS_SI64(x) x##i64

#define __PHYSFS_UI64(x) x##ui64

#else

#define __PHYSFS_SI64(x) ((PHYSFS_sint64) (x))

#define __PHYSFS_UI64(x) ((PHYSFS_uint64) (x))

#endif

/*

 * 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) ( \

    (sizeof (PHYSFS_uint64) <= sizeof (size_t)) || \

    ((s) < (__PHYSFS_UI64(0xFFFFFFFFFFFFFFFF) >> (64-(sizeof(size_t)*8)))) \

)

/*

 * This is a strcasecmp() or stricmp() replacement that expects both strings

 *  to be in UTF-8 encoding. It will do "case folding" to decide if the

 *  Unicode codepoints in the strings match.

 *

 * It will report which string is "greater than" the other, but be aware that

 *  this doesn't necessarily mean anything: 'a' may be "less than" 'b', but

 *  a random Kanji codepoint has no meaningful alphabetically relationship to

 *  a Greek Lambda, but being able to assign a reliable "value" makes sorting

 *  algorithms possible, if not entirely sane. Most cases should treat the

 *  return value as "equal" or "not equal".

 */

int __PHYSFS_utf8stricmp(const char *s1, const char *s2);

/*

 * This works like __PHYSFS_utf8stricmp(), but takes a character (NOT BYTE

 *  COUNT) argument, like strcasencmp().

 */

int __PHYSFS_utf8strnicmp(const char *s1, const char *s2, PHYSFS_uint32 l);

/*

 * stricmp() that guarantees to only work with low ASCII. The C runtime

 *  stricmp() might try to apply a locale/codepage/etc, which we don't want.

 */

int __PHYSFS_stricmpASCII(const char *s1, const char *s2);

/*

 * strnicmp() that guarantees to only work with low ASCII. The C runtime

 *  strnicmp() might try to apply a locale/codepage/etc, which we don't want.

 */

int __PHYSFS_strnicmpASCII(const char *s1, const char *s2, PHYSFS_uint32 l);

/*

 * The current allocator. Not valid before PHYSFS_init is called!

 */

extern PHYSFS_Allocator __PHYSFS_AllocatorHooks;

/* convenience macro to make this less cumbersome internally... */

#define allocator __PHYSFS_AllocatorHooks

/*

 * 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);

/*

 * 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 *));

/*

 * 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);"

 */

int __PHYSFS_readAll(PHYSFS_Io *io, void *buf, const PHYSFS_uint64 len);

/* These are shared between some archivers. */

typedef struct

{

    PHYSFS_uint32 startPos;

    PHYSFS_uint32 size;

} UNPKentry;

                         const char *origdir, void *callbackdata);

/*--------------------------------------------------------------------------*/

/*--------------------------------------------------------------------------*/

/*------------                                              ----------------*/

/*------------  You MUST implement the following functions  ----------------*/

/*------------        if porting to a new platform.         ----------------*/

/*------------     (see platform/unix.c for an example)     ----------------*/

/*------------                                              ----------------*/

/*--------------------------------------------------------------------------*/

/*--------------------------------------------------------------------------*/

/*

 * 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.

 */

#if PHYSFS_PLATFORM_WINDOWS

#define __PHYSFS_platformDirSeparator '\\'

#else

#define __PHYSFS_platformDirSeparator '/'

#endif

/*

 * Initialize the platform. This is called when PHYSFS_init() is called from

 *  the application.

 *

 * Return zero if there was a catastrophic failure (which prevents you from

 *  functioning at all), and non-zero otherwise.

 */

int __PHYSFS_platformInit(void);

/*

 * Deinitialize the platform. This is called when PHYSFS_deinit() is called

 *  from the application. You can use this to clean up anything you've

 *  allocated in your platform driver.

 *

 * Return zero if there was a catastrophic failure (which prevents you from

 *  functioning at all), and non-zero otherwise.

 */

int __PHYSFS_platformDeinit(void);

/*

 * 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.

 *

 */

void *__PHYSFS_platformOpenRead(const char *filename);

/*

 * Open a file for writing. (filename) is in platform-dependent notation. If

 *  the file exists, it should be truncated to zero bytes, and if it doesn't

 *  exist, it should be created as a zero-byte file. The file pointer should

 *  be positioned on the first byte of the file.

 *

 * The return value will be some platform-specific datatype that is opaque to

 *  the caller; it could be a (FILE *) under Unix, or a (HANDLE *) under win32,

 *  etc.

 *

 * Opening a file for write multiple times has undefined results.

 *

 */

void *__PHYSFS_platformOpenWrite(const char *filename);

/*

 * Open a file for appending. (filename) is in platform-dependent notation. If

 *  the file exists, the file pointer should be place just past the end of the

 *  file, so that the first write will be one byte after the current end of

 *  the file. If the file doesn't exist, it should be created as a zero-byte

 *  file. The file pointer should be positioned on the first byte of the file.

 *

 * The return value will be some platform-specific datatype that is opaque to

 *  the caller; it could be a (FILE *) under Unix, or a (HANDLE *) under win32,

 *  etc.

 *

 * Opening a file for append multiple times has undefined results.

 *

 */

void *__PHYSFS_platformOpenAppend(const char *filename);

/*

 * Read more data from a platform-specific file handle. (opaque) should be

 *  cast to whatever data type your platform uses. Read a maximum of (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

 *  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.

 */

PHYSFS_sint64 __PHYSFS_platformRead(void *opaque, void *buf, PHYSFS_uint64 len);

/*

 * Write more data to a platform-specific file handle. (opaque) should be

 *  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

 *  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.

 */

PHYSFS_sint64 __PHYSFS_platformWrite(void *opaque, const void *buffer,

                                     PHYSFS_uint64 len);

/*

 * 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.

 *

 *  a non-zero value.

 */

int __PHYSFS_platformSeek(void *opaque, PHYSFS_uint64 pos);

/*

 * Get the file pointer's position, in an 8-bit byte offset from the start of

 *  the file. (opaque) should be cast to whatever data type your platform

 *  uses.

 *

 * Not all file types can "tell"; this is to be expected by the caller.

 *

 */

PHYSFS_sint64 __PHYSFS_platformTell(void *opaque);

/*

 * Determine the current size of a file, in 8-bit bytes, from an open file.

 *

 * The caller expects that this information may not be available for all

 *  file types on all platforms.

 *

 *  return the file length in 8-bit bytes.

 */

PHYSFS_sint64 __PHYSFS_platformFileLength(void *handle);

/*

 * !!! FIXME: comment me.

 */

/*

 * 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);

/*

 * 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.

 *

 * You should clean up all resources associated with (opaque); the pointer

 *  will be considered invalid after this call.

 */

void __PHYSFS_platformClose(void *opaque);

/*

 * 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.

 */

void __PHYSFS_platformDetectAvailableCDs(PHYSFS_StringCallback cb, void *data);

/*

 * Calculate the base dir, if your platform needs special consideration.

 *  Just return NULL if the standard routines will suffice. (see

 *  calculateBaseDir() in physfs.c ...)

 * 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.

 */

char *__PHYSFS_platformCalcBaseDir(const char *argv0);

/*

 * Get the platform-specific user dir.

 * 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.

 */

char *__PHYSFS_platformCalcUserDir(void);