]> pd.if.org Git - pdclib/blobdiff - internals/_PDCLIB_glue.h
Enable building PDCLib with Watcom. This was surprisingly painless: their C99 mode...
[pdclib] / internals / _PDCLIB_glue.h
index db29f1ede847e6a5aa4e61887284f578b9ab8dbb..d49cc114338273c0c4c9ce6681ea9334660029c6 100644 (file)
@@ -1,3 +1,5 @@
+#ifndef _PDCLIB_GLUE_H
+#define _PDCLIB_GLUE_H
 /* $Id$ */
 
 /* OS glue functions declaration <_PDCLIB_glue.h>
@@ -6,29 +8,46 @@
    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 <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 which allocates n pages of memory and returns a pointer to 
+   them. On failure, returns NULL
+*/
+void * _PDCLIB_allocpages( size_t n );
+
+/* A system call which frees the n pages of memory pointed to by p */
+void _PDCLIB_freepages( void * p, size_t 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 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.
+   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)
 */
-void * _PDCLIB_allocpages( int n );
+void * _PDCLIB_reallocpages( void* p, size_t on, size_t nn, bool mayMove);
+#endif
+
+/* stdio.h */
 
 /* A system call that opens a file identified by name in a given mode. Return 
    a file descriptor uniquely identifying that file.
@@ -36,17 +55,22 @@ void * _PDCLIB_allocpages( int n );
 */
 _PDCLIB_fd_t _PDCLIB_open( char const * const filename, unsigned int mode );
 
-/* 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.
+/* A system call that writes a stream's buffer.
+   Returns 0 on success, EOF on write error.
+   Sets stream error flags and errno appropriately on error.
+*/
+int _PDCLIB_flushbuffer( struct _PDCLIB_file_t * stream );
+
+/* A system call that fills a stream's buffer.
+   Returns 0 on success, EOF on read error / EOF.
+   Sets stream EOF / error flags and errno appropriately on error.
 */
-int _PDCLIB_write( struct _PDCLIB_file_t * stream, char const * buffer, int n );
+int _PDCLIB_fillbuffer( struct _PDCLIB_file_t * stream );
 
-/* A system call that reads n characters into a buffer, from a file identified
-   by given file descriptor. Return the number of characters read.
+/* A system call that repositions within a file. Returns new offset on success,
+   -1 / errno on error.
 */
-_PDCLIB_size_t _PDCLIB_read( _PDCLIB_fd_t fd, char * buffer, _PDCLIB_size_t n );
+_PDCLIB_int64_t _PDCLIB_seek( struct _PDCLIB_file_t * stream, _PDCLIB_int64_t offset, int whence );
 
 /* A system call that closes a file identified by given file descriptor. Return
    zero on success, non-zero otherwise.
@@ -60,12 +84,10 @@ int _PDCLIB_remove( const char * filename );
 
 /* 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_interactive_stream( _PDCLIB_fd_t fd );
+int _PDCLIB_rename( const char * old, const char * newn);
 
+_PDCLIB_END_EXTERN_C
+#endif