mware/kfile.h

   1 /*!
   2  * \file
   3  * <!--
   4  * Copyright 2004 Develer S.r.l. (http://www.develer.com/)
   5  * Copyright 1999, 2000, 2001, 2003 Bernardo Innocenti <bernie@develer.com>
   6  * This file is part of DevLib - See devlib/README for information.
   7  * -->
   8  *
   9  * \brief Virtual KFile I/O interface.
  10  *
  11  * \version $Id$
  12  * \author Bernardo Innocenti <bernie@develer.com>
  13  */
  14
  15 /*#*
  16  *#* $Log$
  17  *#* Revision 1.4  2005/04/11 19:10:28  bernie
  18  *#* Include top-level headers from cfg/ subdir.
  19  *#*
  20  *#* Revision 1.3  2004/12/31 16:43:23  bernie
  21  *#* Move seek function last in VT.
  22  *#*
  23  *#* Revision 1.2  2004/08/25 14:12:09  rasky
  24  *#* Aggiornato il comment block dei log RCS
  25  *#*
  26  *#* Revision 1.1  2004/08/04 02:40:25  bernie
  27  *#* Add virtual file I/O interface.
  28  *#*
  29  *#*/
  30 #ifndef MWARE_KFILE_H
  31 #define MWARE_KFILE_H
  32
  33 #include <cfg/compiler.h>
  34
  35 /* fwd decl */
  36 struct _KFile;
  37
  38 typedef size_t  (*ReadFunc_t)   (struct _KFile *fd, char *buf, size_t size);
  39 typedef size_t  (*WriteFunc_t)  (struct _KFile *fd, const char *buf, size_t size);
  40 typedef bool    (*SeekFunc_t)   (struct _KFile *fd, int32_t offset);
  41 typedef bool    (*OpenFunc_t)   (struct _KFile *fd, const char *name, int mode);
  42 typedef bool    (*CloseFunc_t)  (struct _KFile *fd);
  43
  44
  45 /* Context data for callback functions which operate on
  46  * pseudo files.
  47  */
  48 typedef struct _KFile
  49 {
  50         ReadFunc_t              read;
  51         WriteFunc_t             write;
  52         OpenFunc_t              open;
  53         CloseFunc_t             close;
  54         SeekFunc_t              seek;
  55
  56         /* NOTE: these must _NOT_ be size_t on 16bit CPUs! */
  57         uint32_t                SeekPos;
  58         uint32_t                Size;
  59 } KFile;
  60
  61 #endif /* MWARE_KFILE_H */