/*

 * HOG support routines for PhysicsFS.

 *

 * This driver handles Descent I/II HOG archives.

 *

 * The format is very simple:

 *

 *   The file always starts with the 3-byte signature "DHF" (Descent

 *   HOG file). After that the files of a HOG are just attached after

 *   another, divided by a 17 bytes header, which specifies the name

 *   and length (in bytes) of the forthcoming file! So you just read

 *   the header with its information of how big the following file is,

 *   and then skip exact that number of bytes to get to the next file

 *   in that HOG.

 *

 *    char sig[3] = {'D', 'H', 'F'}; // "DHF"=Descent HOG File

 *

 *    struct {

 *     char file_name[13]; // Filename, padded to 13 bytes with 0s

 *     int file_size; // filesize in bytes

 *     char data[file_size]; // The file data

 *    } FILE_STRUCT; // Repeated until the end of the file.

 *

 * (That info is from http://www.descent2.com/ddn/specs/hog/)

 *

 * Please see the file LICENSE.txt in the source's root directory.

 *

 *  This file written by Bradley Bell.

 *  Based on grp.c by Ryan C. Gordon.

 */

#if (defined PHYSFS_SUPPORTS_HOG)

#include <stdio.h>

#include <stdlib.h>

#include <string.h>

#include "physfs.h"

#define __PHYSICSFS_INTERNAL__

#include "physfs_internal.h"

/*

 * One HOGentry is kept for each file in an open HOG archive.

 */

typedef struct

{

    char name[13];

    PHYSFS_uint32 startPos;

    PHYSFS_uint32 size;

} HOGentry;

/*

 * One HOGinfo is kept for each open HOG archive.

 */

typedef struct

{

    PHYSFS_uint32 entryCount;

    HOGentry *entries;

} HOGinfo;

/*

 * One HOGfileinfo is kept for each open file in a HOG archive.

 */

typedef struct

{

    HOGentry *entry;

    PHYSFS_uint32 curPos;

} HOGfileinfo;

{

} /* readAll */

static void HOG_dirClose(dvoid *opaque)

{

    HOGinfo *info = ((HOGinfo *) opaque);

    allocator.Free(info->entries);

    allocator.Free(info);

} /* HOG_dirClose */

{

    const HOGentry *entry = finfo->entry;

    const PHYSFS_uint64 bytesLeft = (PHYSFS_uint64)(entry->size-finfo->curPos);

    PHYSFS_sint64 rc;

    if (bytesLeft < len)

        len = bytesLeft;

    if (rc > 0)

        finfo->curPos += (PHYSFS_uint32) rc;

    return rc;

} /* HOG_read */

{

    BAIL_MACRO(ERR_NOT_SUPPORTED, -1);

} /* HOG_write */

{

} /* HOG_tell */

{

    int rc;

    BAIL_IF_MACRO(offset >= entry->size, ERR_PAST_EOF, 0);

    if (rc)

        finfo->curPos = (PHYSFS_uint32) offset;

    return rc;

} /* HOG_seek */

{

    return ((PHYSFS_sint64) finfo->entry->size);

{

{

    if (one != two)

    {

        const HOGentry *a = (const HOGentry *) _a;

        return __PHYSFS_stricmpASCII(a[one].name, a[two].name);

    } /* if */

    return 0;

{

    if (one != two)

    {

        HOGentry tmp;

        HOGentry *first = &(((HOGentry *) _a)[one]);

        HOGentry *second = &(((HOGentry *) _a)[two]);

        memcpy(&tmp, first, sizeof (HOGentry));

        memcpy(first, second, sizeof (HOGentry));

        memcpy(second, &tmp, sizeof (HOGentry));

    } /* if */

{

    {

    } /* for */

    return 1;

} /* hog_load_entries */

{

    memset(info, '\0', sizeof (HOGinfo));

    return info;

HOG_openArchive_failed:

    if (info != NULL)

    {

        if (info->entries != NULL)

            allocator.Free(info->entries);

        allocator.Free(info);

    } /* if */

    return NULL;

} /* HOG_openArchive */

static void HOG_enumerateFiles(dvoid *opaque, const char *dname,

                               int omitSymLinks, PHYSFS_EnumFilesCallback cb,

                               const char *origdir, void *callbackdata)

{

    /* no directories in HOG files. */

    if (*dname == '\0')

    {

        HOGinfo *info = (HOGinfo *) opaque;

        HOGentry *entry = info->entries;

        PHYSFS_uint32 max = info->entryCount;

        PHYSFS_uint32 i;

        for (i = 0; i < max; i++, entry++)

            cb(callbackdata, origdir, entry->name);

    } /* if */

} /* HOG_enumerateFiles */

static HOGentry *hog_find_entry(const HOGinfo *info, const char *name)

{

    char *ptr = strchr(name, '.');

    HOGentry *a = info->entries;

    PHYSFS_sint32 lo = 0;

    PHYSFS_sint32 hi = (PHYSFS_sint32) (info->entryCount - 1);

    PHYSFS_sint32 middle;

    int rc;

    /*

     * Rule out filenames to avoid unneeded processing...no dirs,

     *   big filenames, or extensions > 3 chars.

     */

    BAIL_IF_MACRO((ptr) && (strlen(ptr) > 4), ERR_NO_SUCH_FILE, NULL);

    BAIL_IF_MACRO(strlen(name) > 12, ERR_NO_SUCH_FILE, NULL);

    BAIL_IF_MACRO(strchr(name, '/') != NULL, ERR_NO_SUCH_FILE, NULL);

    while (lo <= hi)

    {

        middle = lo + ((hi - lo) / 2);

        rc = __PHYSFS_stricmpASCII(name, a[middle].name);

        if (rc == 0)  /* found it! */

            return &a[middle];

        else if (rc > 0)

            lo = middle + 1;

        else

            hi = middle - 1;

    } /* while */

    BAIL_MACRO(ERR_NO_SUCH_FILE, NULL);

} /* hog_find_entry */

static int HOG_exists(dvoid *opaque, const char *name)

{

} /* HOG_exists */

static int HOG_isDirectory(dvoid *opaque, const char *name, int *fileExists)

{

    *fileExists = HOG_exists(opaque, name);

    return 0;  /* never directories in a groupfile. */

} /* HOG_isDirectory */

static int HOG_isSymLink(dvoid *opaque, const char *name, int *fileExists)

{

    *fileExists = HOG_exists(opaque, name);

    return 0;  /* never symlinks in a groupfile. */

} /* HOG_isSymLink */

{

    HOGfileinfo *finfo;

    HOGentry *entry;

    entry = hog_find_entry(info, fnm);

    *fileExists = (entry != NULL);

    finfo = (HOGfileinfo *) allocator.Malloc(sizeof (HOGfileinfo));

    finfo->curPos = 0;

    finfo->entry = entry;

} /* HOG_openRead */

{

    BAIL_MACRO(ERR_NOT_SUPPORTED, NULL);

} /* HOG_openWrite */

{

    BAIL_MACRO(ERR_NOT_SUPPORTED, NULL);

} /* HOG_openAppend */

static int HOG_remove(dvoid *opaque, const char *name)

{

    BAIL_MACRO(ERR_NOT_SUPPORTED, 0);

} /* HOG_remove */

static int HOG_mkdir(dvoid *opaque, const char *name)

{

    BAIL_MACRO(ERR_NOT_SUPPORTED, 0);

} /* HOG_mkdir */

static int HOG_stat(dvoid *opaque, const char *filename, int *exists,

                    PHYSFS_Stat *stat)

{

    const HOGinfo *info = (const HOGinfo *) opaque;

    const HOGentry *entry = hog_find_entry(info, filename);

    *exists = (entry != 0);

    if (!entry)

        return 0;

    stat->filesize = entry->size;

    stat->filetype = PHYSFS_FILETYPE_REGULAR;

    stat->modtime = -1;

    stat->createtime = -1;

    stat->accesstime = -1;

    stat->readonly = 1;

    return 1;

} /* HOG_stat */

const PHYSFS_ArchiveInfo __PHYSFS_ArchiveInfo_HOG =

{

    "HOG",

    HOG_ARCHIVE_DESCRIPTION,

    "Bradley Bell <btb@icculus.org>",

    "http://icculus.org/physfs/",

};

const PHYSFS_Archiver __PHYSFS_Archiver_HOG =

{

    &__PHYSFS_ArchiveInfo_HOG,

    HOG_openArchive,        /* openArchive() method    */

    HOG_enumerateFiles,     /* enumerateFiles() method */

    HOG_exists,             /* exists() method         */

    HOG_isDirectory,        /* isDirectory() method    */

    HOG_isSymLink,          /* isSymLink() method      */

    HOG_openRead,           /* openRead() method       */

    HOG_openWrite,          /* openWrite() method      */

    HOG_openAppend,         /* openAppend() method     */

    HOG_remove,             /* remove() method         */

    HOG_mkdir,              /* mkdir() method          */

    HOG_dirClose,           /* dirClose() method       */

};

#endif  /* defined PHYSFS_SUPPORTS_HOG */

/* end of hog.c ... */