-/* $Id$ */
-
+#ifndef __PDCLIB_GLUE_H
+#define __PDCLIB_GLUE_H __PDCLIB_GLUE_H
/* OS glue functions declaration <_PDCLIB_glue.h>
This file is part of the Public Domain C Library (PDCLib).
Permission is granted to use, modify, and / or redistribute at will.
*/
-#ifndef _PDCLIB_INT_H
-#define _PDCLIB_INT_H _PDCLIB_INT_H
#include <_PDCLIB_int.h>
-#endif
+#include <_PDCLIB_io.h>
+#include <stdbool.h>
+#include <stddef.h>
+_PDCLIB_BEGIN_EXTERN_C
/* -------------------------------------------------------------------------- */
/* OS "glue", part 2 */
/* These are the functions you will have to touch, as they are where PDCLib */
/* interfaces with the operating system. */
-/* Some operate on data types defined by _PDCLIB_config.h. */
+/* They operate on data types partially defined by _PDCLIB_config.h. */
/* -------------------------------------------------------------------------- */
+/* stdlib.h */
+
/* A system call that terminates the calling process, returning a given status
to the environment.
*/
-void _PDCLIB_Exit( int status ) _PDCLIB_NORETURN;
+_PDCLIB_noreturn void _PDCLIB_Exit( int status );
-/* A system call that adds n pages of memory to the process heap (if n is
- positive), or releases n pages from the process heap (if n is negative).
- Return a (void *) pointing to the *former* end-of-heap if successful, NULL
- otherwise.
+/* A system call which allocates n pages of memory and returns a pointer to
+ them. On failure, returns NULL
*/
-void * _PDCLIB_allocpages( int n );
+void * _PDCLIB_allocpages( size_t n );
-/* A system call that opens a file identified by name in a given mode. Return
- a file descriptor uniquely identifying that file.
- (The mode is the return value of the _PDCLIB_filemode() function.)
-*/
-_PDCLIB_fd_t _PDCLIB_open( char const * const filename, unsigned int mode );
+/* A system call which frees the n pages of memory pointed to by p */
+void _PDCLIB_freepages( void * p, size_t n );
-/* A system call that writes up to n characters to a file identified by given
- file descriptor. Return the number of characters actually written, or -1
- if an error occured. Note that the number of characters may well be lower
- than n without an error having occured.
-*/
-int _PDCLIB_write( struct _PDCLIB_file_t * stream, char const * buffer, int n );
+#ifdef _PDCLIB_HAVE_REALLOCPAGES
+/* A system call which attempts to reallocate the group of \p on pages starting
+ at \p p, resizing the chunk to be \p nn pages long. If \p mayMove is true,
+ then then the group of pages may move; otherwise, if the group cannot be
+ resized in its current position, failure must be reported.
-/* A system call that reads n characters into a buffer, from a file identified
- by given file descriptor. Return the number of characters read.
+ On failure, returns NULL; on success, returns the address of the group of
+ pages (if mayMove == false, then this must be equal to \p p)
*/
-_PDCLIB_size_t _PDCLIB_read( _PDCLIB_fd_t fd, char * buffer, _PDCLIB_size_t n );
+void * _PDCLIB_reallocpages( void* p, size_t on, size_t nn, bool mayMove);
+#endif
-/* A system call that closes a file identified by given file descriptor. Return
- zero on success, non-zero otherwise.
-*/
-int _PDCLIB_close( _PDCLIB_fd_t fd );
+/* stdio.h */
+
+/* Open the file with the given name and mode. Return the file descriptor in
+ * *fd and a pointer to the operations structure in **ops on success.
+ *
+ * Return true on success and false on failure.
+ */
+bool _PDCLIB_open(
+ _PDCLIB_fd_t* fd, const _PDCLIB_fileops_t** ops,
+ char const * filename, unsigned int mode );
/* A system call that removes a file identified by name. Return zero on success,
non-zero otherwise.
/* A system call that renames a file from given old name to given new name.
Return zero on success, non-zero otherwise. In case of failure, the file
- must still be accessible by old name.
+ must still be accessible by old name. Any handling of open files etc. is
+ done by standard rename() already.
*/
-int _PDCLIB_rename( const char * old, const char * new );
-
-/* A system call that returns one if the given file descriptor refers to an
- interactive device, and zero otherwise.
- */
-int _PDCLIB_isinteractive( _PDCLIB_fd_t fd );
+int _PDCLIB_rename( const char * old, const char * newn);
+_PDCLIB_END_EXTERN_C
+#endif