]> pd.if.org Git - pdclib.old/blobdiff - includes/stdio.h
Moving platform specifics from stdio.h to _PDCLIB_config.h. More docs.
[pdclib.old] / includes / stdio.h
index 62b5af18dd6a5deae86bfc2280ee482e23ff7038..9e877b9215cd77751ceec7cdb867211648483da4 100644 (file)
-// ----------------------------------------------------------------------------
-// $Id$
-// ----------------------------------------------------------------------------
-// Public Domain C Library - http://pdclib.sourceforge.net
-// This code is Public Domain. Use, modify, and redistribute at will.
-// ----------------------------------------------------------------------------
-// TODO
-// ----------------------------------------------------------------------------
+/* $Id$ */
 
-#ifndef __STDIO_H
-#define __STDIO_H __STDIO_H
+/* Input/output <stdio.h>
 
-// TODO
+   This file is part of the Public Domain C Library (PDCLib).
+   Permission is granted to use, modify, and / or redistribute at will.
+*/
 
-#endif // __STDIO_H
+#ifndef _PDCLIB_STDIO_H
+#define _PDCLIB_STDIO_H _PDCLIB_STDIO_H
+
+#ifndef _PDCLIB_INT_H
+#define _PDCLIB_INT_H _PDCLIB_INT_H
+#include <_PDCLIB_int.h>
+#endif
+
+#ifndef _PDCLIB_SIZE_T_DEFINED
+#define _PDCLIB_SIZE_T_DEFINED _PDCLIB_SIZE_T_DEFINED
+typedef _PDCLIB_size_t size_t;
+#endif
+
+#ifndef _PDCLIB_NULL_DEFINED
+#define _PDCLIB_NULL_DEFINED _PDCLIB_NULL_DEFINED
+#define NULL _PDCLIB_NULL
+#endif
+
+/* See setvbuf(), third argument */
+/* Fully buffered - transmit block-wise */
+#define _IOFBF 2
+/* Line buffered - transmit line-wise */
+#define _IOLBF 1
+/* Not buffered - transmit immediately */
+#define _IONBF 0
+
+/* The following are platform-dependant, and defined in _PDCLIB_config.h. */
+typedef _PDCLIB_fpos_t        fpos_t;
+typedef struct _PDCLIB_file_t FILE;
+#define EOF -1
+#define BUFSIZ _PDCLIB_BUFSIZ
+#define FOPEN_MAX _PDCLIB_FOPEN_MAX
+#define FILENAME_MAX _PDCLIB_FILENAME_MAX
+#define L_tmpnam _PDCLIB_L_tmpnam
+#define TMP_MAX _PDCLIB_TMP_MAX
+
+/* See fseek(), third argument */
+#define SEEK_CUR 1
+#define SEEK_END 2
+#define SEEK_SET 4
+
+/* Text-mode I/O is at liberty to skip non-printing characters and trailing spaces.
+   Binary I/O is at liberty to add trailing zero bytes.
+   First operation decides "orientation" of the stream (wide / byte).
+   freopen() removes orientation; see also fwide().
+   Binary wide-oriented streams have the file-positioning restrictions ascribed to both text and binary streams.
+   For wide-oriented streams, after a successful call to a file-positioning function that leaves the file position indicator prior to the end-of-file, a wide character output function can overwrite a partial multibyte character; any file contents beyond the byte(s) written are henceforth indeterminate.
+   Whether a file of zero length (unwritten-to) actually exists is implementation-defined.
+   Wide text input from file: fgetwc() / mbrtowc()
+   Wide text output to file: wcrtomb() / fputwc()
+   Multibyte encoding in file may contain embedded null bytes
+   Multibyte encoding in file need not begin / end in initial shift state.
+   Conversion may trigger EILSEQ.
+*/
+
+/* Operations on files */
+
+/* Remove the given file. Returns zero if successful, non-zero otherwise. If
+   the file is open, this implementation does flush its buffer and closes the
+   file before removing it. (It might be still accessible by another hard link
+   etc.
+*/
+int remove( const char * filename );
+
+/* Rename the given old file to the given new name. Returns zero if successful,
+   non-zero otherwise. If successful, the file can no longer be accessed under
+   its old name. If the file is open, this implementation does flush its buffer
+   and closes the file before renaming it.
+*/
+int rename( const char * old, const char * new );
+
+/* Opens a temporary file with mode "wb+", i.e. binary, update. The file will
+   be removed when it is closed or the process exits normally. Returns a pointer
+   to a FILE handle for this file. This implementation does not remove temporary
+   files if the process aborts abnormally (e.g. abort()).
+*/
+FILE * tmpfile( void );
+
+/* Generates a file name that is not equal to any existing filename AT THE TIME
+   OF GENERATION. It generates a different name each time it is called. If s is
+   a NULL pointer, the name is stored in an internal static array, and a pointer
+   to that array is returned. (This is not thread-safe!) If s is not a NULL
+   pointer, it is assumed to point to an array of at least L_tmpnam characters.
+   The generated name is then stored in s, and s is returned. If tmpnam() is
+   unable to generate a suitable name (because all possible variations do exist
+   already or the function has been called TMP_MAX times already), NULL is
+   returned.
+   Note that this implementation cannot guarantee a file of this name is not
+   generated between the call to tmpnam() and a subsequent fopen().
+*/
+char * tmpnam( char * s );
+
+/* File access functions */
+int fclose( FILE * stream );
+int fflush( FILE * stream );
+FILE * fopen( const char * _PDCLIB_restrict filename, const char * _PDCLIB_restrict mode );
+FILE * freopen( const char * _PDCLIB_restrict filename, const char * _PDCLIB_restrict mode, FILE * _PDCLIB_restrict stream );
+void setbuf( FILE * _PDCLIB_restrict stream, char * _PDCLIB_restrict buf );
+int setvbuf( FILE * _PDCLIB_restrict stream, char * _PDCLIB_restrict buf, int mode, size_t size );
+
+/* Formatted input/output functions */
+int fprintf( FILE * _PDCLIB_restrict stream, const char * _PDCLIB_restrict format, ... );
+int fscanf( FILE * _PDCLIB_restrict stream, const char * _PDCLIB_restrict format, ... );
+int printf( const char * _PDCLIB_restrict format, ... );
+int scanf( const char * _PDCLIB_restrict format, ... );
+int snprintf( char * _PDCLIB_restrict s, size_t n, const char * _PDCLIB_restrict format, ... );
+int sprintf( char * _PDCLIB_restrict s, const char * _PDCLIB_restrict format, ... );
+int sscanf( const char * _PDCLIB_restrict s, const char * _PDCLIB_restrict format, ... );
+int vfprintf( FILE * _PDCLIB_restrict stream, const char * _PDCLIB_restrict format, _PDCLIB_va_list arg );
+int vfscanf( FILE * _PDCLIB_restrict stream, const char * _PDCLIB_restrict format, _PDCLIB_va_list arg );
+int vprintf( const char * _PDCLIB_restrict format, _PDCLIB_va_list arg );
+int vscanf( const char * _PDCLIB_restrict format, _PDCLIB_va_list arg );
+int vsnprintf( char * _PDCLIB_restrict s, size_t n, const char * _PDCLIB_restrict format, _PDCLIB_va_list arg );
+int vsprintf( char * _PDCLIB_restrict s, const char * _PDCLIB_restrict format, _PDCLIB_va_list arg );
+int vsscanf( const char * _PDCLIB_restrict s, const char * _PDCLIB_restrict format, _PDCLIB_va_list arg );
+
+/* Character input/output functions */
+int fgetc( FILE * stream );
+char * fgets( char * _PDCLIB_restrict s, int n, FILE * _PDCLIB_restrict stream );
+int fputc( int c, FILE * stream );
+int fputs( const char * _PDCLIB_restrict s, FILE * _PDCLIB_restrict stream );
+int getc( FILE * stream );
+int getchar( void );
+char * gets( char * s );
+int putc( int c, FILE * stream );
+int putchar( int c );
+int puts( const char * s );
+int ungetc( int c, FILE * stream );
+
+/* Direct input/output functions */
+size_t fread( void * _PDCLIB_restrict ptr, size_t size, size_t nmemb, FILE * _PDCLIB_restrict stream );
+size_t fwrite( const void * _PDCLIB_restrict ptr, size_t size, size_t nmemb, FILE * _PDCLIB_restrict stream );
+
+/* File positioning functions */
+int fgetpos( FILE * _PDCLIB_restrict stream, fpos_t * _PDCLIB_restrict pos );
+int fseek( FILE * stream, long int offset, int whence );
+int fsetpos( FILE * stream, const fpos_t * pos );
+long int ftell( FILE * stream );
+void rewind( FILE * stream );
+
+/* Error-handling functions */
+void clearerr( FILE * stream );
+int feof( FILE * stream );
+int ferror( FILE * stream );
+void perror( const char * s );
+
+#endif