source: trunk/kStuff/include/k/kRdr.h@ 3542

/* $Id: kRdr.h 3542 2007-08-25 04:40:45Z bird $ */
/** @file
 * kRdr - The File Provider.
 */

/*
 * Copyright (c) 2006-2007 knut st. osmundsen <bird-src-spam@anduin.net>
 *
 * This file is part of kStuff.
 *
 * kStuff is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published
 * by the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * kStuff is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with kStuff; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 */

#ifndef ___kRdr_h___
#define ___kRdr_h___

#include <k/kDefs.h>
#ifndef ___k_kLdr___
/* avoid dragging in kLdr.h */
typedef enum KLDRPROT { KLDRPROT_32BIT_HACK = 0x7fffffff } KLDRPROT;
typedef const struct KLDRSEG *PCKLDRSEG;
#endif

#ifdef __cplusplus
extern "C" {
#endif


/** @defgroup grp_kRdr      kRdr - The File Provider
 * @{ */

/** Pointer to a file provider instance core. */
typedef struct KRDR *PKRDR;
/** Pointer to a file provider instance core pointer. */
typedef struct KRDR **PPKRDR;

/**
 * File provider instance operations.
 */
typedef struct KRDROPS
{
    /** The name of this file provider. */
    const char *pszName;
    /** Pointer to the next file provider. */
    const struct KRDROPS *pNext;

    /** Try create a new file provider instance.
     *
     * @returns 0 on success, OS specific error code on failure.
     * @param   ppRdr       Where to store the file provider instance.
     * @param   pszFilename The filename to open.
     */
    int     (* pfnCreate)(  PPKRDR ppRdr, const char *pszFilename);
    /** Destroy the file provider instance.
     *
     * @returns 0 on success, OS specific error code on failure.
     *          On failure, the file provider instance will be in an indeterminate state - don't touch it!
     * @param   pRdr        The file provider instance.
     */
    int     (* pfnDestroy)( PKRDR pRdr);
    /** @copydoc kRdrRead */
    int     (* pfnRead)(    PKRDR pRdr, void *pvBuf, size_t cb, KLDRFOFF off);
    /** @copydoc kRdrAllMap */
    int     (* pfnAllMap)(  PKRDR pRdr, const void **ppvBits);
    /** @copydoc kRdrAllUnmap */
    int     (* pfnAllUnmap)(PKRDR pRdr, const void *pvBits);
    /** @copydoc kRdrSize */
    KFOFF   (* pfnSize)(    PKRDR pRdr);
    /** @copydoc kRdrTell */
    KFOFF   (* pfnTell)(    PKRDR pRdr);
    /** @copydoc kRdrName */
    const char * (* pfnName)(PKRDR pRdr);
    /** @copydoc kRdrPageSize */
    KSIZE   (* pfnPageSize)(PKRDR pRdr);
    /** @copydoc kRdrMap */
    int     (* pfnMap)(     PKRDR pRdr, void **ppvBase, KU32 cSegments, PCKLDRSEG paSegments, unsigned fFixed);
    /** @copydoc kRdrRefresh */
    int     (* pfnRefresh)( PKRDR pRdr, void *pvBase, KU32 cSegments, PCKLDRSEG paSegments);
    /** @copydoc kRdrProtect */
    int     (* pfnProtect)( PKRDR pRdr, void *pvBase, KU32 cSegments, PCKLDRSEG paSegments, unsigned fUnprotectOrProtect);
    /** @copydoc kRdrUnmap */
    int     (* pfnUnmap)(   PKRDR pRdr, void *pvBase, KU32 cSegments, PCKLDRSEG paSegments);
    /** @copydoc kRdrDone */
    void    (* pfnDone)(    PKRDR pRdr);
    /** The usual non-zero dummy that makes sure we've initialized all members. */
    KU32    u32Dummy;
} KRDROPS;
/** Pointer to file provider operations. */
typedef KRDROPS *PKRDROPS;
/** Pointer to const file provider operations. */
typedef const KRDROPS *PCKRDROPS;


/**
 * File provider instance core.
 */
typedef struct KRDR
{
    /** Magic number (KLDRRDR_MAGIC). */
    KU32        u32Magic;
    /** Pointer to the file provider operations. */
    PCKRDROPS   pOps;
} KRDR;

/** The magic for KRDR::u32Magic. (Katsu Aki (Katsuaki Nakamura)) */
#define KRDR_MAGIC   0x19610919

void    kRdrAddProvider(PKRDROPS pAdd);

int     kRdrOpen(PPKRDR ppRdr, const char *pszFilename);
int     kRdrOpenBuffered(PPKRDR ppRdr, const char *pszFilename);

int     kRdrClose(   PKRDR pRdr);
int     kRdrRead(    PKRDR pRdr, void *pvBuf, size_t cb, KLDRFOFF off);
int     kRdrAllMap(  PKRDR pRdr, const void **ppvBits);
int     kRdrAllUnmap(PKRDR pRdr, const void *pvBits);
KFOFF   kRdrSize(    PKRDR pRdr);
KFOFF   kRdrTell(    PKRDR pRdr);
const char *kRdrName(PKRDR pRdr);
KIPTR   kRdrNativeFH(PKRDR pRdr);

KSIZE   kRdrPageSize(PKRDR pRdr);
int     kRdrMap(     PKRDR pRdr, void **ppvBase, KU32 cSegments, PCKLDRSEG paSegments, unsigned fFixed);
int     kRdrRefresh( PKRDR pRdr, void *pvBase, KU32 cSegments, PCKLDRSEG paSegments);
int     kRdrProtect( PKRDR pRdr, void *pvBase, KU32 cSegments, PCKLDRSEG paSegments, unsigned fUnprotectOrProtect);
int     kRdrUnmap(   PKRDR pRdr, void *pvBase, KU32 cSegments, PCKLDRSEG paSegments);
void    kRdrDone(    PKRDR pRdr);

/** @} */

#ifdef __cplusplus
}
#endif

#endif