]> pd.if.org Git - pdclib/blobdiff - internals/_PDCLIB_int.h
Ad-hoc solutions for perror() and strerror().
[pdclib] / internals / _PDCLIB_int.h
index d4d0d9a00eb99e0e3762c554b9f7810b51bbe02c..c6283b9aee74acba2d350d749495e7ed58075d3c 100644 (file)
@@ -259,23 +259,33 @@ typedef unsigned _PDCLIB_intmax _PDCLIB_uintmax_t;
 
 /* Internal flags, made to fit the same status field as the flags above. */
 #define _PDCLIB_LIBBUFFER    512u
-#define _PDCLIB_VIRGINSTR   1024u
-#define _PDCLIB_ERRORFLAG   2048u
-#define _PDCLIB_EOFFLAG     4096u
-#define _PDCLIB_WIDESTREAM  8192u
-#define _PDCLIB_BYTESTREAM 16384u
+#define _PDCLIB_ERRORFLAG   1024u
+#define _PDCLIB_EOFFLAG     2048u
+#define _PDCLIB_WIDESTREAM  4096u
+#define _PDCLIB_BYTESTREAM  8192u
 
+/* Position / status structure for getpos() / fsetpos(). */
+struct _PDCLIB_fpos_t
+{
+    _PDCLIB_uint64_t offset; /* File position offset */
+    int              status; /* Multibyte parsing state (unused, reserved) */
+};
+
+/* FILE structure */
 struct _PDCLIB_file_t
 {
-    _PDCLIB_fd_t            handle;   /* OS-specific file descriptor */
-    _PDCLIB_fpos_t          position; /* file position indicator */
-    char *                  buffer;   /* file buffer */
-    _PDCLIB_size_t          bufsize;  /* size of buffer */
-    _PDCLIB_size_t          bufidx;   /* index to point of action in buffer */
-    _PDCLIB_size_t          bufend;   /* index to end of pre-read buffer */
-    unsigned int            status;   /* misc. status bits */
-    char *                  filename; /* name used in fopen() / freopen() */
-    struct _PDCLIB_file_t * next;     /* provisions for linked list handling */
+    _PDCLIB_fd_t            handle;   /* OS file handle */
+    char *                  buffer;   /* Pointer to buffer memory */
+    _PDCLIB_size_t          bufsize;  /* Size of buffer */
+    _PDCLIB_size_t          bufidx;   /* Index of current position in buffer */
+    _PDCLIB_size_t          bufend;   /* Index of last pre-read character in buffer */
+    struct _PDCLIB_fpos_t   pos;      /* Offset and multibyte parsing state */
+    _PDCLIB_size_t          ungetidx; /* Number of ungetc()'ed characters */
+    unsigned char *         ungetbuf; /* ungetc() buffer */
+    unsigned int            status;   /* Status flags; see above */
+    /* multibyte parsing status to be added later */
+    char *                  filename; /* Name the current stream has been opened with */
+    struct _PDCLIB_file_t * next;     /* Pointer to next struct (internal) */
 };
 
 /* -------------------------------------------------------------------------- */
@@ -305,16 +315,18 @@ struct _PDCLIB_memnode_t
 /* Status structure required by _PDCLIB_print(). */
 struct _PDCLIB_status_t
 {
-    int              base;  /* base to which the value shall be converted    */
+    int              base;   /* base to which the value shall be converted   */
     _PDCLIB_int_fast32_t flags; /* flags and length modifiers                */
-    _PDCLIB_size_t   n;     /* maximum number of characters to be written    */
-    _PDCLIB_size_t   i;     /* number of characters already written          */
-    _PDCLIB_size_t   this;  /* output chars in the current conversion        */
-    char *           s;     /* target buffer                                 */
-    _PDCLIB_size_t   width; /* width of current field                        */
-    _PDCLIB_size_t   prec;  /* precision of current field                    */
-    struct _PDCLIB_file_t * stream;/* for to-stream output                   */
-    _PDCLIB_va_list  arg;   /* argument stack passed to the printf function  */
+    _PDCLIB_size_t   n;      /* print: maximum characters to be written      */
+                             /* scan:  number matched conversion specifiers  */
+    _PDCLIB_size_t   i;      /* number of characters read/written            */
+    _PDCLIB_size_t   current;/* chars read/written in the CURRENT conversion */
+    char *           s;      /* *sprintf(): target buffer                    */
+                             /* *sscanf():  source string                    */
+    _PDCLIB_size_t   width;  /* specified field width                        */
+    _PDCLIB_size_t   prec;   /* specified field precision                    */
+    struct _PDCLIB_file_t * stream; /* *fprintf() / *fscanf() stream         */
+    _PDCLIB_va_list  arg;    /* argument stack                               */
 };
 
 /* -------------------------------------------------------------------------- */
@@ -335,22 +347,60 @@ extern char _PDCLIB_Xdigits[];
 /* The worker for all printf() type of functions. The pointer spec should point
    to the introducing '%' of a conversion specifier. The status structure is to
    be that of the current printf() function, of which the members n, s, stream
-   and arg will be preserved, i will be updated, and all others will be trashed
+   and arg will be preserved; i will be updated; and all others will be trashed
    by the function.
    Returns a pointer to the first character not parsed as conversion specifier.
 */
 const char * _PDCLIB_print( const char * spec, struct _PDCLIB_status_t * status );
 
-/* Common denominator of puts() and fputs() */
-int _PDCLIB_puts( const char * s, const char * endl, struct _PDCLIB_file_t * stream );
+/* The worker for all scanf() type of functions. The pointer spec should point
+   to the introducing '%' of a conversion specifier. The status structure is to
+   be that of the current scanf() function, of which the member stream will be
+   preserved; n, i, and s will be updated; and all others will be trashed by
+   the function.
+   Returns a pointer to the first character not parsed as conversion specifier,
+   or NULL in case of error.
+   FIXME: Should distinguish between matching and input error
+*/
+const char * _PDCLIB_scan( const char * spec, struct _PDCLIB_status_t * status );
 
 /* Parsing any fopen() style filemode string into a number of flags. */
 unsigned int _PDCLIB_filemode( const char * mode );
 
-/* Writing out unwritten buffers of a specific stream. A NULL parameter (as is
-   possible with standard fflush()) is not supported.
-   Return 0 if successful, EOF if error occured. Set error flag of stream and
-   errno as appropriate in case of error.
+/* Sanity checking and preparing of read buffer, should be called first thing 
+   by any stdio read-data function.
+   Returns 0 on success, EOF on error.
+   On error, EOF / error flags and errno are set appropriately.
 */
-_PDCLIB_size_t _PDCLIB_flushbuffer( struct _PDCLIB_file_t * stream, _PDCLIB_size_t written, int retries );
+int _PDCLIB_prepread( struct _PDCLIB_file_t * stream );
+
+/* Sanity checking, should be called first thing by any stdio write-data
+   function.
+   Returns 0 on success, EOF on error.
+   On error, error flags and errno are set appropriately.
+*/
+int _PDCLIB_prepwrite( struct _PDCLIB_file_t * stream );
+
+/* -------------------------------------------------------------------------- */
+/* errno                                                                      */
+/* -------------------------------------------------------------------------- */
 
+extern int _PDCLIB_errno;
+int * _PDCLIB_errno_func( void );
+
+/* ERANGE and EDOM are specified by the standard. */
+#define _PDCLIB_ERANGE 1
+#define _PDCLIB_EDOM 2
+/* Used in the example implementation for any kind of I/O error. */
+#define _PDCLIB_EIO 3
+/* Used in the example implementation for "unknown error". */
+#define _PDCLIB_EUNKNOWN 4
+/* Used in the example implementation for "invalid parameter value". */
+#define _PDCLIB_EINVAL 5
+/* Used in the example implementation for "I/O retries exceeded". */
+#define _PDCLIB_ERETRY 6
+/* One larger than the largest used errno */
+#define _PDCLIB_EMAX 7
+
+/* TODO: Doing this via a static array is not the way to do it. */
+char const * _PDCLIB_errno_texts[ _PDCLIB_EMAX ];