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