kern/file.h

   1 /*!
   2  * \file
   3  * <!--
   4  * Copyright 2003,2004 Develer S.r.l. (http://www.develer.com/)
   5  * Copyright 1999,2001,2003 Bernardo Innocenti <bernie@develer.com>
   6  * This file is part of DevLib - See README.devlib for information.
   7  * -->
   8  *
   9  * \brief Interface to KFile virtual class
  10  *
  11  * \version $Id$
  12  *
  13  * \author Bernardo Innocenti <bernie@develer.com>
  14  */
  15
  16 /*#*
  17  *#* $Log$
  18  *#* Revision 1.6  2005/11/04 16:20:02  bernie
  19  *#* Fix reference to README.devlib in header.
  20  *#*
  21  *#* Revision 1.5  2005/04/11 19:10:28  bernie
  22  *#* Include top-level headers from cfg/ subdir.
  23  *#*
  24  *#* Revision 1.4  2004/08/25 14:12:09  rasky
  25  *#* Aggiornato il comment block dei log RCS
  26  *#*
  27  *#* Revision 1.3  2004/06/06 15:11:38  bernie
  28  *#* Doxygenize.
  29  *#*
  30  *#* Revision 1.2  2004/06/03 11:27:09  bernie
  31  *#* Add dual-license information.
  32  *#*
  33  *#* Revision 1.1  2004/05/23 17:27:00  bernie
  34  *#* Import kern/ subdirectory.
  35  *#*/
  36 #ifndef KERN_KFILE_H
  37 #define KERN_KFILE_H
  38
  39 #ifndef COMPILER_H
  40 #include <cfg/compiler.h>
  41 #endif
  42
  43 struct _KFile;
  44
  45 typedef size_t  (*ReadFunc_t)   (struct _KFile *fd, char *buf, size_t size);
  46 typedef size_t  (*WriteFunc_t)  (struct _KFile *fd, const char *buf, size_t size);
  47 typedef bool    (*SeekFunc_t)   (struct _KFile *fd, int32_t offset);
  48 typedef bool    (*CloseFunc_t)  (struct _KFile *fd);
  49 typedef bool    (*OpenFunc_t)   (struct _KFile *fd, const char *name, int mode);
  50
  51
  52 /*!
  53  * Context data for callback functions which operate on
  54  * pseudo files.
  55  */
  56 typedef struct _KFile
  57 {
  58         ReadFunc_t              Read;
  59         WriteFunc_t             Write;
  60         SeekFunc_t              Seek;
  61 /*      OpenFunc_t              Open;   unused */
  62         CloseFunc_t             Close;
  63
  64         /* NOTE: these must _NOT_ be size_t on 16bit CPUs! */
  65         uint32_t                SeekPos;
  66         uint32_t                Size;
  67 } KFile;
  68
  69
  70 #endif /* KERN_KFILE_H */