| 1 | /* $Id: kRdr.h 29 2009-07-01 20:30:29Z bird $ */
|
|---|
| 2 | /** @file
|
|---|
| 3 | * kRdr - The File Provider.
|
|---|
| 4 | */
|
|---|
| 5 |
|
|---|
| 6 | /*
|
|---|
| 7 | * Copyright (c) 2006-2007 Knut St. Osmundsen <bird-kStuff-spamix@anduin.net>
|
|---|
| 8 | *
|
|---|
| 9 | * Permission is hereby granted, free of charge, to any person
|
|---|
| 10 | * obtaining a copy of this software and associated documentation
|
|---|
| 11 | * files (the "Software"), to deal in the Software without
|
|---|
| 12 | * restriction, including without limitation the rights to use,
|
|---|
| 13 | * copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|---|
| 14 | * copies of the Software, and to permit persons to whom the
|
|---|
| 15 | * Software is furnished to do so, subject to the following
|
|---|
| 16 | * conditions:
|
|---|
| 17 | *
|
|---|
| 18 | * The above copyright notice and this permission notice shall be
|
|---|
| 19 | * included in all copies or substantial portions of the Software.
|
|---|
| 20 | *
|
|---|
| 21 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
|---|
| 22 | * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
|
|---|
| 23 | * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
|---|
| 24 | * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
|
|---|
| 25 | * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
|
|---|
| 26 | * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
|
|---|
| 27 | * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
|
|---|
| 28 | * OTHER DEALINGS IN THE SOFTWARE.
|
|---|
| 29 | */
|
|---|
| 30 |
|
|---|
| 31 | #ifndef ___kRdr_h___
|
|---|
| 32 | #define ___kRdr_h___
|
|---|
| 33 |
|
|---|
| 34 | #include <k/kDefs.h>
|
|---|
| 35 | #include <k/kTypes.h>
|
|---|
| 36 |
|
|---|
| 37 | /** @defgroup grp_kRdr kRdr - The File Provider
|
|---|
| 38 | * @{ */
|
|---|
| 39 |
|
|---|
| 40 | /** @def KRDR_DECL
|
|---|
| 41 | * Declares a kRdr function according to build context.
|
|---|
| 42 | * @param type The return type.
|
|---|
| 43 | */
|
|---|
| 44 | #if defined(KRDR_BUILDING_DYNAMIC)
|
|---|
| 45 | # define KRDR_DECL(type) K_DECL_EXPORT(type)
|
|---|
| 46 | #elif defined(KRDR_BUILT_DYNAMIC)
|
|---|
| 47 | # define KRDR_DECL(type) K_DECL_IMPORT(type)
|
|---|
| 48 | #else
|
|---|
| 49 | # define KRDR_DECL(type) type
|
|---|
| 50 | #endif
|
|---|
| 51 |
|
|---|
| 52 | #ifdef __cplusplus
|
|---|
| 53 | extern "C" {
|
|---|
| 54 | #endif
|
|---|
| 55 |
|
|---|
| 56 | KRDR_DECL(int) kRdrOpen( PPKRDR ppRdr, const char *pszFilename);
|
|---|
| 57 | KRDR_DECL(int) kRdrClose( PKRDR pRdr);
|
|---|
| 58 | KRDR_DECL(int) kRdrRead( PKRDR pRdr, void *pvBuf, KSIZE cb, KFOFF off);
|
|---|
| 59 | KRDR_DECL(int) kRdrAllMap( PKRDR pRdr, const void **ppvBits);
|
|---|
| 60 | KRDR_DECL(int) kRdrAllUnmap( PKRDR pRdr, const void *pvBits);
|
|---|
| 61 | KRDR_DECL(KFOFF) kRdrSize( PKRDR pRdr);
|
|---|
| 62 | KRDR_DECL(KFOFF) kRdrTell( PKRDR pRdr);
|
|---|
| 63 | KRDR_DECL(const char *) kRdrName( PKRDR pRdr);
|
|---|
| 64 | KRDR_DECL(KIPTR) kRdrNativeFH( PKRDR pRdr);
|
|---|
| 65 | KRDR_DECL(KSIZE) kRdrPageSize( PKRDR pRdr);
|
|---|
| 66 | KRDR_DECL(int) kRdrMap( PKRDR pRdr, void **ppvBase, KU32 cSegments, PCKLDRSEG paSegments, KBOOL fFixed);
|
|---|
| 67 | KRDR_DECL(int) kRdrRefresh( PKRDR pRdr, void *pvBase, KU32 cSegments, PCKLDRSEG paSegments);
|
|---|
| 68 | KRDR_DECL(int) kRdrProtect( PKRDR pRdr, void *pvBase, KU32 cSegments, PCKLDRSEG paSegments, KBOOL fUnprotectOrProtect);
|
|---|
| 69 | KRDR_DECL(int) kRdrUnmap( PKRDR pRdr, void *pvBase, KU32 cSegments, PCKLDRSEG paSegments);
|
|---|
| 70 | KRDR_DECL(void) kRdrDone( PKRDR pRdr);
|
|---|
| 71 |
|
|---|
| 72 | KRDR_DECL(int) kRdrBufOpen(PPKRDR ppRdr, const char *pszFilename);
|
|---|
| 73 | KRDR_DECL(int) kRdrBufWrap(PPKRDR ppRdr, PKRDR pRdr, KBOOL fCloseIt);
|
|---|
| 74 | KRDR_DECL(KBOOL) kRdrBufIsBuffered(PKRDR pRdr);
|
|---|
| 75 | KRDR_DECL(int) kRdrBufLine(PKRDR pRdr, char *pszLine, KSIZE cbLine);
|
|---|
| 76 | KRDR_DECL(int) kRdrBufLineEx(PKRDR pRdr, char *pszLine, KSIZE *pcbLine);
|
|---|
| 77 | KRDR_DECL(const char *) kRdrBufLineQ(PKRDR pRdr);
|
|---|
| 78 |
|
|---|
| 79 | #ifdef __cplusplus
|
|---|
| 80 | }
|
|---|
| 81 | #endif
|
|---|
| 82 |
|
|---|
| 83 | /** @} */
|
|---|
| 84 |
|
|---|
| 85 | #endif
|
|---|
| 86 |
|
|---|
