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 devlib/README 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.3  2004/06/06 15:11:38  bernie
  19  * Doxygenize.
  20  *
  21  * Revision 1.2  2004/06/03 11:27:09  bernie
  22  * Add dual-license information.
  23  *
  24  * Revision 1.1  2004/05/23 17:27:00  bernie
  25  * Import kern/ subdirectory.
  26  */
  27 #ifndef KERN_KFILE_H
  28 #define KERN_KFILE_H
  29
  30 #ifndef COMPILER_H
  31 #include <compiler.h>
  32 #endif
  33
  34 struct _KFile;
  35
  36 typedef size_t  (*ReadFunc_t)   (struct _KFile *fd, char *buf, size_t size);
  37 typedef size_t  (*WriteFunc_t)  (struct _KFile *fd, const char *buf, size_t size);
  38 typedef bool    (*SeekFunc_t)   (struct _KFile *fd, int32_t offset);
  39 typedef bool    (*CloseFunc_t)  (struct _KFile *fd);
  40 typedef bool    (*OpenFunc_t)   (struct _KFile *fd, const char *name, int mode);
  41
  42
  43 /*!
  44  * Context data for callback functions which operate on
  45  * pseudo files.
  46  */
  47 typedef struct _KFile
  48 {
  49         ReadFunc_t              Read;
  50         WriteFunc_t             Write;
  51         SeekFunc_t              Seek;
  52 /*      OpenFunc_t              Open;   unused */
  53         CloseFunc_t             Close;
  54
  55         /* NOTE: these must _NOT_ be size_t on 16bit CPUs! */
  56         uint32_t                SeekPos;
  57         uint32_t                Size;
  58 } KFile;
  59
  60
  61 #endif /* KERN_KFILE_H */