]> pd.if.org Git - pdclib/blob - internals/_PDCLIB_glue.h
02ba7f9e40af87b38b7a8dc0b60ffab8a51c648e
[pdclib] / internals / _PDCLIB_glue.h
1 /* $Id$ */
2
3 /* OS glue functions declaration <_PDCLIB_glue.h>
4
5    This file is part of the Public Domain C Library (PDCLib).
6    Permission is granted to use, modify, and / or redistribute at will.
7 */
8
9 #ifndef _PDCLIB_INT_H
10 #define _PDCLIB_INT_H _PDCLIB_INT_H
11 #include <_PDCLIB_int.h>
12 #endif
13
14 /* -------------------------------------------------------------------------- */
15 /* OS "glue", part 2                                                          */
16 /* These are the functions you will have to touch, as they are where PDCLib   */
17 /* interfaces with the operating system.                                      */
18 /* They operate on data types partially defined by _PDCLIB_config.h.          */
19 /* -------------------------------------------------------------------------- */
20
21 /* A system call that terminates the calling process, returning a given status
22    to the environment.
23 */
24 void _PDCLIB_Exit( int status ) _PDCLIB_NORETURN;
25
26 /* A system call that adds n pages of memory to the process heap (if n is
27    positive), or releases n pages from the process heap (if n is negative).
28    Return a (void *) pointing to the *former* end-of-heap if successful, NULL
29    otherwise.
30 */
31 void * _PDCLIB_allocpages( int n );
32
33 /* A system call that opens a file identified by name in a given mode, and
34    returns a file descriptor uniquely identifying that file.
35 */
36 _PDCLIB_fd_t _PDCLIB_open( char const * const filename, unsigned int mode );
37
38 /* A system call that writes n characters to a file identified by given file
39    descriptor. Return the number of characters actually written, or zero if
40    an error occured.
41 */
42 _PDCLIB_size_t _PDCLIB_write( _PDCLIB_fd_t fd, char const * buffer, _PDCLIB_size_t n );
43
44 /* A system call that reads n characters into a buffer, from a file identified
45    by given file descriptor. Return the number of characters read.
46 */
47 _PDCLIB_size_t _PDCLIB_read( _PDCLIB_fd_t fd, char * buffer, _PDCLIB_size_t n );
48
49 /* A system call that closes a file identified by given file descriptor. Return
50    zero on success, non-zero otherwise.
51 */
52 int _PDCLIB_close( _PDCLIB_fd_t fd );
53
54 /* A system call that removes a file identified by name. Return zero on success,
55    non-zero otherwise.
56 */
57 int _PDCLIB_remove( const char * filename );
58
59 /* A system call that renames a file from given old name to given new name.
60    Return zero on success, non-zero otherwise. In case of failure, the file
61    must still be accessible by old name.
62 */
63 int _PDCLIB_rename( const char * old, const char * new );
64
65 /* A system call that returns one if the given file descriptor refers to an
66    interactive device, and zero otherwise.
67  */
68 int _PDCLIB_isinteractive( _PDCLIB_fd_t fd );
69