// ----------------------------------------------------------------------------
// MACROS
+// personality: FILENAME_MAX, FOPEN_MAX, L_tmpnam, TMP_MAX, stderr, stdin,
+// stdout
+
#include "__NULL.h"
-#define _IOFBF // integer constant suitable as 3rd argument to setvbuf()
-#define _IOLBF // integer constant suitable as 3rd argument to setvbuf()
-#define _IONBF // integer constant suitable as 3rd argument to setvbuf()
-#define BUFSIZ // integer constant, size of the buffer used by setbuf(),
- // >= 256
-#define EOF // TODO
-#define FILENAME_MAX // length of filenames supported
-#define FOPEN_MAX // number of simultaneous open files supported, >= 8
-#define L_tmpnam // length of filenames generated by tmpnam()
-#define SEEK_CUR // integer constant suitable as 3rd argument to fseek()
-#define SEEK_END // integer constant suitable as 3rd argument to fseek()
-#define SEEK_SET // integer constant suitable as 3rd argument to fseek()
-#define TMP_MAX // number of unique filenames generateable by tmpnam(),
- // >= 25
-
-#define stderr // FILE*, not fully buffered
-#define stdin // FILE*, fully buffered only when not interactive device
-#define stdout // FILE*, fully buffered only when not interactive device
+#define _IOFBF 0 // @see setvbuf()
+#define _IOLBF 1 // @see setvbuf()
+#define _IONBF 2 // @see setvbuf()
+
+#define SEEK_SET 0 // @see fseek()
+#define SEEK_CUR 1 // @see fseek()
+#define SEEK_END 2 // @see fseek()
+
+#define EOF -1
// ----------------------------------------------------------------------------
// TYPEDEFS
// ----------------------------------------------------------------------------
// FUNCTIONS
-/** CLEAR ERRor. Clears EOF and error indicator of a FILE handle.
- @param fh The file handle.
- */
-void clearerr( FILE * fh );
-
-/** File CLOSE. Flush output buffers (if any) and closes the FILE handle.
- @param stream The file handle.
- @return 0 if successful, non-zero if failed. (In any case, the FILE handle
- is invalid afterwards.)
- */
-int fclose( FILE * fh );
-
-int feof( FILE * stream );
-int ferror( FILE * stream );
-
-/** File FLUSH. Flushes output buffers (if any) for given file handle. If
- parameter is NULL, flushes output buffers for all file handles.
- @param fh The file handle.
- @return 0 if successful, EOF if failed (setting error indicators).
- */
-int fflush( FILE * fh );
+/* TABLE OF CONTENTS (in order of appearance)
+ *
+ * General File Handling
+ * * fopen()
+ * * freopen()
+ * * fflush()
+ * * feof()
+ * * ferror()
+ * * clearerr()
+ * * fclose()
+ *
+ * Rename / Remove
+ * * rename()
+ * * remove()
+ *
+ * Temporary Files
+ * * tmpfile()
+ * * tmpnam()
+ *
+ * File Positioning
+ * * fseek()
+ * * rewind()
+ * * ftell()
+ * * fgetpos()
+ * * fsetpos()
+ *
+ * Reading
+ * * fgetc()
+ * * getc()
+ * * getchar()
+ * * ungetc()
+ * * fgets()
+ * * gets()
+ *
+ * Writing
+ * * fputc()
+ * * putc()
+ * * putchar()
+ * * fputs()
+ * * puts()
+ *
+ * Formatted Reading
+ * * fscanf()
+ * * scanf()
+ * * sscanf()
+ * * vfscanf()
+ * * vscanf()
+ * * vsscanf()
+ *
+ * Formatted Writing
+ * * fprintf()
+ * * printf()
+ * * sprintf()
+ * * snprintf()
+ * * vfprintf()
+ * * vprintf()
+ * * vsprintf()
+ * * vsnprintf()
+ *
+ * Special
+ * * perror()
+ *
+ * Binary Read / Write
+ * * fread()
+ * * fwrite()
+ *
+ * Buffer Handling
+ * * setvbuf()
+ * * setbuf()
+ *
+ */
/** File OPEN. Opens the file specified by the given name.
@param filename Name of the file to be opened.
*/
FILE * freopen( const char * restrict filename, const char * restrict mode, FILE * fh );
-/** REMOVE file. Causes a file to be no longer accessible under a given name.
- If the file is currently open, this implementation of remove() fails,
- returning INT_MAX.
- @param filename Name of the file to be removed.
- @return 0 if successful, non-zero if failed. (Implementation defined:
- INT_MAX if the file is currently open.)
+/** File FLUSH. Flushes output buffers (if any) for given file handle. If
+ parameter is NULL, flushes output buffers for all file handles.
+ @param fh The file handle.
+ @return 0 if successful, EOF if failed (setting error indicators).
*/
-int remove( const char * filename );
+int fflush( FILE * fh );
+
+/** File EOF. Tests whether EOF is set for a given file.
+ @param fh The file handle.
+ @return 0 if EOF is not set, non-zero if EOF is set.
+ */
+int feof( FILE * stream );
+
+/** File ERROR. Tests whether error indicators are set for a given file.
+ @param fh The file handle.
+ @return 0 if no error indicators are set, non-zero otherwise.
+ */
+int ferror( FILE * stream );
+
+/** CLEAR ERRor. Clears EOF and error indicator of a FILE handle.
+ @param fh The file handle.
+ */
+void clearerr( FILE * fh );
+
+/** File CLOSE. Flush output buffers (if any) and closes the FILE handle.
+ @param stream The file handle.
+ @return 0 if successful, non-zero if failed. (In any case, the FILE handle
+ is invalid afterwards.)
+ */
+int fclose( FILE * fh );
+
+// ----------------------------------------------------------------------------
/** RENAME file. Causes a file to be no longer accessible under a given name,
but a new name instead. If a file with the intended new name already
*/
int rename( const char * old, const char * new );
-void rewind( FILE * stream );
-
-/** SET Virtual BUFfer. Sets buffering mode and (optionally) the memory used
- for buffering, for a given file handle.
- This function must only be called immediately after associating the file
- handle with a file, before any operations are called on the file handle.
- @param fh The file handle.
- @param buf A pointer to the memory area to use for buffering, or NULL to
- use internally assigned buffer memory.
- @param mode One of _IOFBF, _IOLBF, _IONBF.
- @param size Size of the memory area to be used for buffering.
+/** REMOVE file. Causes a file to be no longer accessible under a given name.
+ If the file is currently open, this implementation of remove() fails,
+ returning INT_MAX.
+ @param filename Name of the file to be removed.
+ @return 0 if successful, non-zero if failed. (Implementation defined:
+ INT_MAX if the file is currently open.)
*/
-int setvbuf( FILE * restrict fh, char * restrict buf, int mode, size_t size );
+int remove( const char * filename );
-/** SET BUFfer. Equivalent to (void) setvbuf( fh, buf, _IOFBF, BUFSIZ ), or
- (void) setvbuf( fh, NULL, _IONBF, BUFSIZ ) if buf == NULL.
- @param fh The file handle to be passed to setvbuf().
- @param buf The buffer pointer to be passed to setvbuf().
- */
-void setbuf( FILE * restrict fh, char * restrict buf );
+// ----------------------------------------------------------------------------
/** TeMPorary FILE. Opens a file in "wb+" mode that will be automatically
deleted when closed, or when the program terminates.
*/
char * tmpnam( char * dest );
-int fseek( FILE * stream, long offset, int mode );
+// ----------------------------------------------------------------------------
+
+/** File SEEK. Sets the current position in a file to the values specified by
+ start and offset.
+ @param fh The file handle.
+ @param offset The offset from 'start' to position to.
+ @param start The starting point from which to calculate the offset. May be
+ one of SEEK_SET, SEEK_CUR, SEEK_END.
+ @return 0 if successful, non-zero if error encountered.
+ */
+int fseek( FILE * fh, long offset, int start );
+
+/** REWIND file. Equivalent to (void) fseek( fh, 0, SEEK_SET ).
+ @param fh The file handle.
+ */
+void rewind( FILE * stream );
+
+/** File TELL position. Tells the current offset into a given file.
+ @param fh The file handle.
+ @return The offset into the file.
+ */
+long ftell( FILE * fh );
+
+/** File GET POSition. Stores the current state and position in a file.
+ @param fh The file handle.
+ @param pos The object to store the current state in.
+ @return 0 if successful, non-zero if error encountered.
+ */
+int fgetpos( FILE * restrict fh, fpos_t * restrict pos );
+
+/** File SET POSition. Sets the current file position to the value stored in a
+ given fpos_t object.
+ @param fh The file handle.
+ @param pos The fpos_t object.
+ @return 0 if successful, non-zero if error encountered.
+ */
int fsetpos( FILE * stream, const fpos_t * pos );
-int fgetpos( FILE * restrict stream, fpos_t * restrict pos );
-long ftell( FILE * stream );
-int fgetc( FILE * stream );
-char *fgets( char * restrict s, int n, FILE * restrict stream );
-size_t fread( void * restrict ptr, size_t size, size_t nelem, FILE * restrict stream );
-int getc( FILE * stream );
+// ----------------------------------------------------------------------------
+
+/** File GET Character. Reads a character from file.
+ @param fh The file handle.
+ @return The next character in the file, as unsigned char converted to int,
+ or EOF if end of file is reached.
+ */
+int fgetc( FILE * fh );
+
+/** GET Character. Equivalent to fgetc(), but may be implemented as macro, and
+ is allowed to evaluate its parameter more than once.
+ @param fh The file handle.
+ @return The character read, or EOF if end of file / error encountered.
+ */
+int getc( FILE * fh );
+
+/** GET CHARacter. Equivalent to getc( stdin ).
+ @return The character read, or EOF if end of file / error encountered.
+ */
int getchar( void );
-char * gets( char * s );
-int ungetc( int c, FILE * stream );
+/** UN-GET Character. Puts a character back into an input stream.
+ @param c The character to put back.
+ @param fh The file handle.
+ @return The character put back, EOF if error encountered.
+ */
+int ungetc( int c, FILE * fh );
+
+/** File GET String. Reads a line (terminated by newline character) from file,
+ but reading no more than n characters.
+ @param dest The char array to write into.
+ @param n The maximum number of characters to read.
+ @param fh The file handle.
+ @return 'dest', or NULL if an error occurred.
+ */
+char * fgets( char * restrict dest, int n, FILE * restrict fh );
+
+/** GET String. Equivalent to fgets( dest, stdin ).
+ @param dest The character array to write to.
+ @return 'dest', or NULL if an error occurred.
+ */
+char * gets( char * dest );
+
+// ----------------------------------------------------------------------------
+
+/** File PUT Character. Writes a character to file.
+ @param c The character (when converted to unsigned char) to write.
+ @param fh The file handle.
+ @return 'c', or EOF if an error occurred.
+ */
int fputc( int c, FILE * stream );
-int fputs( const char * restrict s, FILE * restrict stream );
-size_t fwrite( const void * restrict ptr, size_t size, size_t nelem, FILE * restrict stream );
-void perror( const char * s );
-int putc( int c, FILE * stream );
+
+/** PUT Character. Equivalent to fputc( c, stdout ), but may be implemented as
+ a macro, and may evaluate the file handle more than once.
+ @param c The character to write.
+ @param fh The file handle.
+ @return The character written, or EOF if error encountered.
+ */
+int putc( int c, FILE * fh );
+
+/** PUT CHARacter. Equivalent to putc( c, stdout ).
+ @param c The character to write.
+ @return The character written, or EOF if error encountered.
+ */
int putchar( int c );
-int puts( const char * s );
+
+/** File PUT String. Writes a C string to file.
+ @param src The string to write.
+ @param fh The file handle.
+ @return >= 0 if successful, or EOF if an error occurred.
+ */
+int fputs( const char * restrict s, FILE * restrict stream );
+
+/** PUT String. Write a C string to stdout.
+ @param src The C string to write.
+ @return >= 0 if successful, EOF if error encountered.
+ */
+int puts( const char * src );
+
+// ----------------------------------------------------------------------------
/** File SCAN Formatted. Reads from given file handle, under control of a
formatting string, the values of variables pointed to by 0..n pointers.
*/
int vsscanf( const char * restrict src, const char * restrict format, va_list ap );
+// ----------------------------------------------------------------------------
+
/** File PRINT Formatted. Prints to given file handle, under control of a
formatting string, the values of 0..n variables.
@param fh The file handle.
*/
int printf( const char * restrict format, ... );
-/** String N PRINT Formatted. Equivalent to sprintf( dest, format, ... ), but
- will not write more than n characters.
+/** String PRINT Formatted. Equivalent to printf( format, ... ), but writing
+ to a char array instead of stdout.
@param dest The char array to write to.
- @param n The maximum number of characters to write.
@param format The formatting string.
@param ... A list of 0..n variables corresponding to placeholders in
'format'.
@return Number of characters printed.
*/
-int snprintf( char * restrict s, size_t n, const char * restrict format, ... );
+int sprintf( char * restrict dest, const char * restrict format, ... );
-/** String PRINT Formatted. Equivalent to printf( format, ... ), but writing
- to a char array instead of stdout.
+/** String N PRINT Formatted. Equivalent to sprintf( dest, format, ... ), but
+ will not write more than n characters.
@param dest The char array to write to.
+ @param n The maximum number of characters to write.
@param format The formatting string.
@param ... A list of 0..n variables corresponding to placeholders in
'format'.
@return Number of characters printed.
*/
-int sprintf( char * restrict dest, const char * restrict format, ... );
+int snprintf( char * restrict s, size_t n, const char * restrict format, ... );
/** Variable File PRINT Formatted. Equivalent to fprintf( fh, format, ... ),
with the variable-length parameter list replaced by a va_list, created by
*/
int vprintf( const char * restrict format, va_list args );
-/** Variable String N PRINT Formatted. Equivalent to vsprintf( dest, format,
- args ), but will not write more than n characters.
+/** Variable String PRINT Formatted. Equivalent to vprintf( format, args ), but
+ writing to a char array instead to stdout.
@param dest The char array to write to.
- @param n Maximum number of characters to write.
@param format The formatting string.
@param args The argument list created by the va_start macro.
@return Number of characters printed.
*/
-int vsnprintf( char * restrict dest, size_t n, const char * restrict format, va_list ap );
+int vsprintf( char * restrict s, const char * restrict format, va_list ap);
-/** Variable String PRINT Formatted. Equivalent to vprintf( format, args ), but
- writing to a char array instead to stdout.
+/** Variable String N PRINT Formatted. Equivalent to vsprintf( dest, format,
+ args ), but will not write more than n characters.
@param dest The char array to write to.
+ @param n Maximum number of characters to write.
@param format The formatting string.
@param args The argument list created by the va_start macro.
@return Number of characters printed.
*/
-int vsprintf( char * restrict s, const char * restrict format, va_list ap);
+int vsnprintf( char * restrict dest, size_t n, const char * restrict format, va_list ap );
+
+// ----------------------------------------------------------------------------
+
+/** Print ERROR.
+ Equivalent to fprintf( stderr, "%s: %s\n", text, strerror( errno ) ).
+ @param test Text to prepend the error message with.
+ */
+void perror( const char * text );
+
+// ----------------------------------------------------------------------------
+
+/** File READ. Reads a number of objects of a given size from file, and into
+ a memory area.
+ @param dest The memory area to write into.
+ @param size The size of one object.
+ @param n The number of objects to read.
+ @param fh The file handle.
+ @return The number of objects successfully read.
+ */
+size_t fread( void * restrict dest, size_t size, size_t n, FILE * restrict fh );
+
+/** File WRITE. Writes a number of objects from a memory area to file.
+ @param src The memory area to write from.
+ @param size The size of a single object.
+ @param n The number of objects to write.
+ @param fh The file handle.
+ @return The number of objects successfully written.
+ */
+size_t fwrite( const void * restrict src, size_t size, size_t n, FILE * restrict fh );
+
+// ----------------------------------------------------------------------------
+
+/** SET Virtual BUFfer. Sets buffering mode and (optionally) the memory used
+ for buffering, for a given file handle.
+ This function must only be called immediately after associating the file
+ handle with a file, before any operations are called on the file handle.
+ @param fh The file handle.
+ @param buf A pointer to the memory area to use for buffering, or NULL to
+ use internally assigned buffer memory.
+ @param mode One of _IOFBF, _IOLBF, _IONBF.
+ @param size Size of the memory area to be used for buffering.
+ */
+int setvbuf( FILE * restrict fh, char * restrict buf, int mode, size_t size );
+
+/** SET BUFfer. Equivalent to (void) setvbuf( fh, buf, _IOFBF, BUFSIZ ), or
+ (void) setvbuf( fh, NULL, _IONBF, BUFSIZ ) if buf == NULL.
+ @param fh The file handle to be passed to setvbuf().
+ @param buf The buffer pointer to be passed to setvbuf().
+ */
+void setbuf( FILE * restrict fh, char * restrict buf );
+
+// ----------------------------------------------------------------------------
/* PDPC code - unreviewed
/*
projects / pdclib.old / commitdiff