]> pd.if.org Git - pdclib.old/blobdiff - internals/_PDCLIB_io.h
Minimize the amount of internal definitions which get exposed via the user-visible...
[pdclib.old] / internals / _PDCLIB_io.h
index 0dfdad258fc6356a107597cfc830080cd1ccf82a..e4fd94ef3fce28d3d21a6e7c73ecfda57b1d8fd0 100644 (file)
@@ -1,9 +1,9 @@
-#ifndef _PDCLIB_IO_H\r
-#define _PDCLIB_IO_H\r
+#ifndef __PDCLIB_IO_H\r
+#define __PDCLIB_IO_H __PDCLIB_IO_H\r
 #include "_PDCLIB_int.h"\r
 #include "_PDCLIB_threadconfig.h"\r
 \r
-/* PDCLib internal I/O logic <_PDCLIB_int.h>\r
+/* PDCLib internal I/O logic <_PDCLIB_io.h>\r
 \r
    This file is part of the Public Domain C Library (PDCLib).\r
    Permission is granted to use, modify, and / or redistribute at will.\r
 /* stream handle should not be free()d on close (stdin, stdout, stderr) */\r
 #define _PDCLIB_STATIC     32768u\r
 \r
-/* Position / status structure for getpos() / fsetpos(). */\r
-struct _PDCLIB_fpos_t\r
+union _PDCLIB_fd\r
 {\r
-    _PDCLIB_uint64_t offset; /* File position offset */\r
-    int              status; /* Multibyte parsing state (unused, reserved) */\r
+#if defined(_PDCLIB_OSFD_T)\r
+    _PDCLIB_OSFD_T      osfd;\r
+#endif\r
+    void *              pointer;\r
+    _PDCLIB_uintptr_t   uval;\r
+    _PDCLIB_intptr_t    sval;     \r
+};\r
+\r
+/******************************************************************************/\r
+/* Internal functions                                                         */\r
+/******************************************************************************/\r
+\r
+/* The worker for all printf() type of functions. The pointer spec should point\r
+   to the introducing '%' of a conversion specifier. The status structure is to\r
+   be that of the current printf() function, of which the members n, s, stream\r
+   and arg will be preserved; i will be updated; and all others will be trashed\r
+   by the function.\r
+   Returns a pointer to the first character not parsed as conversion specifier.\r
+*/\r
+const char * _PDCLIB_print( const char * spec, struct _PDCLIB_status_t * status );\r
+\r
+/* The worker for all scanf() type of functions. The pointer spec should point\r
+   to the introducing '%' of a conversion specifier. The status structure is to\r
+   be that of the current scanf() function, of which the member stream will be\r
+   preserved; n, i, and s will be updated; and all others will be trashed by\r
+   the function.\r
+   Returns a pointer to the first character not parsed as conversion specifier,\r
+   or NULL in case of error.\r
+   FIXME: Should distinguish between matching and input error\r
+*/\r
+const char * _PDCLIB_scan( const char * spec, struct _PDCLIB_status_t * status );\r
+\r
+/* Parsing any fopen() style filemode string into a number of flags. */\r
+unsigned int _PDCLIB_filemode( const char * mode );\r
+\r
+/* Sanity checking and preparing of read buffer, should be called first thing \r
+   by any stdio read-data function.\r
+   Returns 0 on success, EOF on error.\r
+   On error, EOF / error flags and errno are set appropriately.\r
+*/\r
+int _PDCLIB_prepread( _PDCLIB_file_t * stream );\r
+\r
+/* Sanity checking, should be called first thing by any stdio write-data\r
+   function.\r
+   Returns 0 on success, EOF on error.\r
+   On error, error flags and errno are set appropriately.\r
+*/\r
+int _PDCLIB_prepwrite( _PDCLIB_file_t * stream );\r
+\r
+/* Closing all streams on program exit */\r
+void _PDCLIB_closeall( void );\r
+\r
+/* Writes a stream's buffer.\r
+   Returns 0 on success, EOF on write error.\r
+   Sets stream error flags and errno appropriately on error.\r
+*/\r
+int _PDCLIB_flushbuffer( _PDCLIB_file_t * stream );\r
+\r
+/* Fills a stream's buffer.\r
+   Returns 0 on success, EOF on read error / EOF.\r
+   Sets stream EOF / error flags and errno appropriately on error.\r
+*/\r
+int _PDCLIB_fillbuffer( _PDCLIB_file_t * stream );\r
+\r
+/* Repositions within a file. Returns new offset on success,\r
+   -1 / errno on error.\r
+*/\r
+_PDCLIB_int_fast64_t _PDCLIB_seek( _PDCLIB_file_t * stream, \r
+                                  _PDCLIB_int_fast64_t offset, int whence );\r
+\r
+/* File backend I/O operations\r
+ *\r
+ * PDCLib will call through to these methods as needed to implement the stdio\r
+ * functions.\r
+ */\r
+struct _PDCLIB_fileops\r
+{\r
+    /*! Read length bytes from the file into buf; returning the number of bytes\r
+     *  actually read in *numBytesRead.\r
+     *\r
+     *  Returns true if bytes were read successfully; on end of file, returns\r
+     *  true with *numBytesRead == 0.\r
+     *\r
+     *  On error, returns false and sets errno appropriately. *numBytesRead is\r
+     *  ignored in this situation.\r
+     */\r
+    _PDCLIB_bool (*read)( _PDCLIB_fd_t self, \r
+                          void * buf, \r
+                          _PDCLIB_size_t length, \r
+                          _PDCLIB_size_t * numBytesRead );\r
+\r
+    /*! Write length bytes to the file from buf; returning the number of bytes\r
+     *  actually written in *numBytesWritten\r
+     *\r
+     *  Returns true if bytes were written successfully. On error, returns false\r
+     *  and setss errno appropriately (as with read, *numBytesWritten is \r
+     *  ignored)\r
+     */\r
+    _PDCLIB_bool (*write)( _PDCLIB_fd_t self, const void * buf, \r
+                   _PDCLIB_size_t length, _PDCLIB_size_t * numBytesWritten );\r
+\r
+    /* Seek to the file offset specified by offset, from location whence, which\r
+     * may be one of the standard constants SEEK_SET/SEEK_CUR/SEEK_END\r
+     */\r
+    _PDCLIB_bool (*seek)( _PDCLIB_fd_t self, _PDCLIB_int_fast64_t offset, \r
+                          int whence, _PDCLIB_int_fast64_t *newPos );\r
+\r
+    void (*close)( _PDCLIB_fd_t self );\r
+\r
+    /*! Behaves as read does, except for wide characters. Both length and \r
+     *  *numCharsRead represent counts of characters, not bytes.\r
+     *\r
+     *  This function is optional; if missing, PDCLib will buffer the character\r
+     *  data as bytes and perform translation directly into the user's buffers.\r
+     *  It is useful if your backend can directly take wide characters (for \r
+     *  example, the Windows console)\r
+     */\r
+    _PDCLIB_bool (*wread)( _PDCLIB_fd_t self, _PDCLIB_wchar_t * buf, \r
+                     _PDCLIB_size_t length, _PDCLIB_size_t * numCharsRead );\r
+\r
+    /* Behaves as write does, except for wide characters. As with wread, both\r
+     * length and *numCharsWritten are character counts.\r
+     *\r
+     * This function is also optional; if missing, PDCLib will buffer the \r
+     * character data as bytes and do translation directly from the user's \r
+     * buffers. You only need to implement this if your backend can directly \r
+     * take wide characters (for example, the Windows console)\r
+     */\r
+    _PDCLIB_bool (*wwrite)( _PDCLIB_fd_t self, const _PDCLIB_wchar_t * buf, \r
+                     _PDCLIB_size_t length, _PDCLIB_size_t * numCharsWritten );\r
 };\r
 \r
 /* FILE structure */\r
-struct _PDCLIB_file_t\r
+struct _PDCLIB_file\r
 {\r
-    _PDCLIB_fd_t            handle;   /* OS file handle */\r
-    _PDCLIB_MTX_T           lock;     /* file lock */\r
-    char *                  buffer;   /* Pointer to buffer memory */\r
-    _PDCLIB_size_t          bufsize;  /* Size of buffer */\r
-    _PDCLIB_size_t          bufidx;   /* Index of current position in buffer */\r
-    _PDCLIB_size_t          bufend;   /* Index of last pre-read character in buffer */\r
-    struct _PDCLIB_fpos_t   pos;      /* Offset and multibyte parsing state */\r
-    _PDCLIB_size_t          ungetidx; /* Number of ungetc()'ed characters */\r
-    unsigned char *         ungetbuf; /* ungetc() buffer */\r
-    unsigned int            status;   /* Status flags; see above */\r
+    const _PDCLIB_fileops_t * ops;\r
+    _PDCLIB_fd_t              handle;   /* OS file handle */\r
+    _PDCLIB_MTX_T             lock;     /* file lock */\r
+    char *                    buffer;   /* Pointer to buffer memory */\r
+    _PDCLIB_size_t            bufsize;  /* Size of buffer */\r
+    _PDCLIB_size_t            bufidx;   /* Index of current position in buffer */\r
+    _PDCLIB_size_t            bufend;   /* Index of last pre-read character in buffer */\r
+    _PDCLIB_size_t            ungetidx; /* Number of ungetc()'ed characters */\r
+    unsigned char *           ungetbuf; /* ungetc() buffer */\r
+    unsigned int              status;   /* Status flags; see above */\r
     /* multibyte parsing status to be added later */\r
-    char *                  filename; /* Name the current stream has been opened with */\r
-    struct _PDCLIB_file_t * next;     /* Pointer to next struct (internal) */\r
+    _PDCLIB_fpos_t            pos;      /* Offset and multibyte parsing state */\r
+    char *                    filename; /* Name the current stream has been opened with */\r
+    _PDCLIB_file_t *          next;     /* Pointer to next struct (internal) */\r
 };\r
 \r
+static inline _PDCLIB_size_t _PDCLIB_getchars( char * out, _PDCLIB_size_t n,\r
+                                               int stopchar,\r
+                                               _PDCLIB_file_t * stream )\r
+{\r
+    _PDCLIB_size_t i = 0;\r
+    int c;\r
+    while ( stream->ungetidx > 0 && i != n )\r
+    {\r
+        c = (unsigned char) \r
+                ( out[ i++ ] = stream->ungetbuf[ --(stream->ungetidx) ] );\r
+        if( c == stopchar )\r
+            return i;\r
+    }\r
+\r
+    while ( i != n )\r
+    {\r
+        while ( stream->bufidx != stream->bufend && i != n) \r
+        {\r
+            c = (unsigned char) \r
+                ( out[ i++ ] = stream->buffer[ stream->bufidx++ ] );\r
+            if( c == stopchar )\r
+                return i;\r
+        }\r
+\r
+        if ( stream->bufidx == stream->bufend )\r
+        {\r
+            if( _PDCLIB_fillbuffer( stream ) == -1 )\r
+            {\r
+                return i;\r
+            }\r
+        }\r
+    }\r
+\r
+    return i;\r
+}\r
 \r
 #endif\r