]>
jfr.im git - irc/quakenet/snircd.git/blob - include/fileio.h
2 * @brief ANSI FILE* clone API declarations.
3 * @version $Id: fileio.h,v 1.4 2004/10/05 01:45:24 entrope Exp $
5 #ifndef INCLUDED_fileio_h
6 #define INCLUDED_fileio_h
8 #ifndef INCLUDED_sys_types_h
9 #include <sys/types.h> /* size_t */
10 #define INCLUDED_sys_types_h
15 /** A mirror of the ANSI FILE struct, but it works for any
16 * file descriptor. FileBufs are allocated when a file is opened with
17 * fbopen, and they are freed when the file is closed using fbclose.
18 * (Some OSes limit the range of file descriptors in a FILE*, for
19 * example to fit in "char".)
21 typedef struct FileBuf FBFILE
;
24 * open a file and return a FBFILE*, see fopen(3)
26 extern FBFILE
*fbopen(const char *filename
, const char *mode
);
28 * associate a file descriptor with a FBFILE*
29 * if a FBFILE* is associated here it MUST be closed using fbclose
32 extern FBFILE
*fdbopen(int fd
, const char *mode
);
34 * close a file opened with fbopen, see fclose(3)
36 extern void fbclose(FBFILE
* fb
);
38 * return the next character from the file, EOF on end of file
41 extern int fbgetc(FBFILE
* fb
);
43 * return next string in a file up to and including the newline character
46 extern char *fbgets(char *buf
, size_t len
, FBFILE
* fb
);
48 * write a null terminated string to a file, see fputs(3)
50 extern int fbputs(const char *str
, FBFILE
* fb
);
52 * return the status of the file associated with fb, see fstat(3)
54 extern int fbstat(struct stat
*sb
, FBFILE
* fb
);
56 #endif /* INCLUDED_fileio_h */