X-Git-Url: https://pd.if.org/git/?a=blobdiff_plain;f=internals%2F_PDCLIB_glue.h;h=f4363c40925c1db3d7be94d9efc96d882151cd35;hb=b1fc26afebd4d557ff89a44bc21767a8704c3809;hp=db29f1ede847e6a5aa4e61887284f578b9ab8dbb;hpb=f93d55176e4db9edfb1840054169003bcca4d1fb;p=pdclib diff --git a/internals/_PDCLIB_glue.h b/internals/_PDCLIB_glue.h index db29f1e..f4363c4 100644 --- a/internals/_PDCLIB_glue.h +++ b/internals/_PDCLIB_glue.h @@ -1,23 +1,23 @@ -/* $Id$ */ - /* 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 +#ifndef _PDCLIB_GLUE_H +#define _PDCLIB_GLUE_H _PDCLIB_GLUE_H + #include <_PDCLIB_int.h> -#endif /* -------------------------------------------------------------------------- */ /* 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. */ @@ -30,23 +30,31 @@ void _PDCLIB_Exit( int status ) _PDCLIB_NORETURN; */ void * _PDCLIB_allocpages( int n ); + +/* stdio.h */ + /* 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 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 +68,9 @@ 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 ); - +#endif