]> pd.if.org Git - pdclib/blobdiff - internals/_PDCLIB_int.h
Started implementation of <time.h>
[pdclib] / internals / _PDCLIB_int.h
index b32b14ac4a880220dbd1d9e22117e29ce26b6745..d9e7f07508a5aac6b3cf2fe229149d360a1416ad 100644 (file)
@@ -1,25 +1,19 @@
-/* $Id$ */
-
 /* PDCLib internal integer logic <_PDCLIB_int.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
+
 /* -------------------------------------------------------------------------- */
 /* You should not have to edit anything in this file; if you DO have to, it   */
 /* would be considered a bug / missing feature: notify the author(s).         */
 /* -------------------------------------------------------------------------- */
 
-#ifndef _PDCLIB_CONFIG_H
-#define _PDCLIB_CONFIG_H _PDCLIB_CONFIG_H
-#include <_PDCLIB_config.h>
-#endif
-
-#ifndef _PDCLIB_AUX_H
-#define _PDCLIB_AUX_H _PDCLIB_AUX_H
-#include <_PDCLIB_aux.h>
-#endif
+#include "_PDCLIB_config.h"
+#include "_PDCLIB_aux.h"
 
 /* null pointer constant */
 #define _PDCLIB_NULL 0
 #elif _PDCLIB_LLONG_BYTES  == 16
 #define _PDCLIB_LLONG_MAX  0x7fffffffffffffffffffffffffffffffLL
 #define _PDCLIB_LLONG_MIN  (-0x7fffffffffffffffffffffffffffffffLL - 1LL)
-#define _PDCLIB_ULLONG_MAX 0xffffffffffffffffffffffffffffffffLL
+#define _PDCLIB_ULLONG_MAX 0xffffffffffffffffffffffffffffffffULL
 #else
 #error Unsupported width of 'long long' (neither 64 nor 128 bit).
 #endif
 /* -------------------------------------------------------------------------- */
 /* <stdint.h> exact-width types and their limits                              */
 /* -------------------------------------------------------------------------- */
+/* Note that, for the "standard" widths of 8, 16, 32 and 64 bit, the "LEAST"  */
+/* types are identical to the "exact-width" types, by definition.             */
 
-/* Setting 'int8_t', its limits, and its literal.                             */
+/* Setting 'int8_t', its limits, its literal, and conversion macros.          */
 #if     _PDCLIB_CHAR_BIT == 8
 typedef signed char        _PDCLIB_int8_t;
 typedef unsigned char      _PDCLIB_uint8_t;
 #define _PDCLIB_INT8_MAX   _PDCLIB_CHAR_MAX
 #define _PDCLIB_INT8_MIN   _PDCLIB_CHAR_MIN
 #define _PDCLIB_UINT8_MAX  _PDCLIB_UCHAR_MAX
-#define _PDCLIB_INT8_LITERAL
-#define _PDCLIB_UINT8_LITERAL
+#define _PDCLIB_8_CONV     hh
 #else
 #error Unsupported width of char (not 8 bits).
 #endif
 
-/* Setting 'int16_t', its limits, and its literal                             */
+/* Setting 'int16_t', its limits, its literal, and conversion macros.         */
 #if     _PDCLIB_INT_BYTES  == 2
 typedef signed int         _PDCLIB_int16_t;
 typedef unsigned int       _PDCLIB_uint16_t;
 #define _PDCLIB_INT16_MAX  _PDCLIB_INT_MAX
 #define _PDCLIB_INT16_MIN  _PDCLIB_INT_MIN
 #define _PDCLIB_UINT16_MAX _PDCLIB_UINT_MAX
-#define _PDCLIB_INT16_LITERAL
-#define _PDCLIB_UINT16_LITERAL
+#define _PDCLIB_16_CONV
 #elif   _PDCLIB_SHRT_BYTES == 2
 typedef signed short       _PDCLIB_int16_t;
 typedef unsigned short     _PDCLIB_uint16_t;
 #define _PDCLIB_INT16_MAX  _PDCLIB_SHRT_MAX
 #define _PDCLIB_INT16_MIN  _PDCLIB_SHRT_MIN
 #define _PDCLIB_UINT16_MAX _PDCLIB_USHRT_MAX
-#define _PDCLIB_INT16_LITERAL  s
-#define _PDCLIB_UINT16_LITERAL us
+#define _PDCLIB_16_CONV    h
 #else
 #error Neither 'short' nor 'int' are 16-bit.
 #endif
 
-/* Setting 'int32_t', its limits, and its literal                             */
+/* Setting 'int32_t', its limits, its literal, and conversion macros.         */
 #if     _PDCLIB_INT_BYTES  == 4
 typedef signed int         _PDCLIB_int32_t;
 typedef unsigned int       _PDCLIB_uint32_t;
@@ -154,6 +147,7 @@ typedef unsigned int       _PDCLIB_uint32_t;
 #define _PDCLIB_UINT32_MAX _PDCLIB_UINT_MAX
 #define _PDCLIB_INT32_LITERAL
 #define _PDCLIB_UINT32_LITERAL
+#define _PDCLIB_32_CONV
 #elif   _PDCLIB_LONG_BYTES == 4
 typedef signed long        _PDCLIB_int32_t;
 typedef unsigned long      _PDCLIB_uint32_t;
@@ -162,10 +156,12 @@ typedef unsigned long      _PDCLIB_uint32_t;
 #define _PDCLIB_UINT32_MAX _PDCLIB_LONG_MAX
 #define _PDCLIB_INT32_LITERAL  l
 #define _PDCLIB_UINT32_LITERAL ul
+#define _PDCLIB_32_CONV        l
 #else
 #error Neither 'int' nor 'long' are 32-bit.
 #endif
 
+/* Setting 'int64_t', its limits, its literal, and conversion macros.         */
 #if     _PDCLIB_LONG_BYTES == 8
 typedef signed long        _PDCLIB_int64_t;
 typedef unsigned long      _PDCLIB_uint64_t;
@@ -174,6 +170,7 @@ typedef unsigned long      _PDCLIB_uint64_t;
 #define _PDCLIB_UINT64_MAX  _PDCLIB_ULONG_MAX
 #define _PDCLIB_INT64_LITERAL  l
 #define _PDCLIB_UINT64_LITERAL ul
+#define _PDCLIB_64_CONV        l
 #elif _PDCLIB_LLONG_BYTES  == 8
 typedef signed long long   _PDCLIB_int64_t;
 typedef unsigned long long _PDCLIB_uint64_t;
@@ -182,6 +179,7 @@ typedef unsigned long long _PDCLIB_uint64_t;
 #define _PDCLIB_UINT64_MAX  _PDCLIB_ULLONG_MAX
 #define _PDCLIB_INT64_LITERAL  ll
 #define _PDCLIB_UINT64_LITERAL ull
+#define _PDCLIB_64_CONV        ll
 #else
 #error Neither 'long' nor 'long long' are 64-bit.
 #endif
@@ -254,24 +252,62 @@ typedef unsigned _PDCLIB_intmax _PDCLIB_uintmax_t;
 /* Various <stdio.h> internals                                                */
 /* -------------------------------------------------------------------------- */
 
-/* Flags for representing mode (see fopen()). */
-#define _PDCLIB_FREAD    1
-#define _PDCLIB_FWRITE   2
-#define _PDCLIB_FAPPEND  4
-#define _PDCLIB_FRW      8
-#define _PDCLIB_FBIN    16
+/* Flags for representing mode (see fopen()). Note these must fit the same
+   status field as the _IO?BF flags in <stdio.h> and the internal flags below.
+*/
+#define _PDCLIB_FREAD     8u
+#define _PDCLIB_FWRITE   16u
+#define _PDCLIB_FAPPEND  32u
+#define _PDCLIB_FRW      64u
+#define _PDCLIB_FBIN    128u
+
+/* Internal flags, made to fit the same status field as the flags above. */
+/* -------------------------------------------------------------------------- */
+/* free() the buffer memory on closing (false for user-supplied buffer) */
+#define _PDCLIB_FREEBUFFER   512u
+/* stream has encountered error / EOF */
+#define _PDCLIB_ERRORFLAG   1024u
+#define _PDCLIB_EOFFLAG     2048u
+/* stream is wide-oriented */
+#define _PDCLIB_WIDESTREAM  4096u
+/* stream is byte-oriented */
+#define _PDCLIB_BYTESTREAM  8192u
+/* file associated with stream should be remove()d on closing (tmpfile()) */
+#define _PDCLIB_DELONCLOSE 16384u
+/* stream handle should not be free()d on close (stdin, stdout, stderr) */
+#define _PDCLIB_STATIC     32768u
+
+/* 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 */
-    void *                  buffer;   /* file buffer */
-    _PDCLIB_size_t          bufsize;  /* size of buffer */
-    unsigned int            status;   /* misc. status bits */
-  /*mbstate_t               mbstate;    multibyte parse state - TODO: Unmask. */
-    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) */
 };
 
+/* -------------------------------------------------------------------------- */
+/* Various <time.h> internals                                                 */
+/* -------------------------------------------------------------------------- */
+
+typedef _PDCLIB_time            _PDCLIB_time_t;
+typedef _PDCLIB_clock           _PDCLIB_clock_t;
+
 /* -------------------------------------------------------------------------- */
 /* Internal data types                                                        */
 /* -------------------------------------------------------------------------- */
@@ -299,16 +335,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                               */
 };
 
 /* -------------------------------------------------------------------------- */
@@ -320,17 +358,107 @@ _PDCLIB_intmax_t _PDCLIB_atomax( const char * s );
 
 /* Two helper functions used by strtol(), strtoul() and long long variants.   */
 const char * _PDCLIB_strtox_prelim( const char * p, char * sign, int * base );
-_PDCLIB_uintmax_t _PDCLIB_strtox_main( const char ** p, unsigned int base, _PDCLIB_uintmax_t error, _PDCLIB_uintmax_t limval, _PDCLIB_uintmax_t limdigit, char * sign );
+_PDCLIB_uintmax_t _PDCLIB_strtox_main( const char ** p, unsigned int base, _PDCLIB_uintmax_t error, _PDCLIB_uintmax_t limval, int limdigit, char * sign );
 
 /* Digits arrays used by various integer conversion functions */
-extern char _PDCLIB_digits[];
-extern char _PDCLIB_Xdigits[];
+extern const char _PDCLIB_digits[];
+extern const 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 );
+
+/* 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 );
+
+/* 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.
+*/
+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 );
+
+/* Closing all streams on program exit */
+void _PDCLIB_closeall( void );
+
+/* -------------------------------------------------------------------------- */
+/* errno                                                                      */
+/* -------------------------------------------------------------------------- */
+
+/* If PDCLib would call its error number "errno" directly, there would be no way
+   to catch its value from underlying system calls that also use it (i.e., POSIX
+   operating systems). That is why we use an internal name, providing a means to
+   access it through <errno.h>.
+*/
+extern int _PDCLIB_errno;
+
+/* A mechanism for delayed evaluation. (Not sure if this is really necessary, so
+   no detailed documentation on the "why".)
+*/
+int * _PDCLIB_errno_func( void );
+
+/* -------------------------------------------------------------------------- */
+/* <ctype.h> lookup tables                                                    */
+/* -------------------------------------------------------------------------- */
+
+#define _PDCLIB_CTYPE_ALPHA   1
+#define _PDCLIB_CTYPE_BLANK   2
+#define _PDCLIB_CTYPE_CNTRL   4
+#define _PDCLIB_CTYPE_GRAPH   8
+#define _PDCLIB_CTYPE_PUNCT  16
+#define _PDCLIB_CTYPE_SPACE  32
+#define _PDCLIB_CTYPE_LOWER  64
+#define _PDCLIB_CTYPE_UPPER 128
+#define _PDCLIB_CTYPE_DIGIT 256
+#define _PDCLIB_CTYPE_XDIGT 512
+
+struct _PDCLIB_ctype_t
+{
+    _PDCLIB_uint16_t flags;
+    unsigned char upper;
+    unsigned char lower;
+    unsigned char collation;
+};
+
+/* -------------------------------------------------------------------------- */
+/* Sanity checks                                                              */
+/* -------------------------------------------------------------------------- */
+
+_PDCLIB_static_assert( sizeof( short ) == _PDCLIB_SHRT_BYTES, "Compiler disagrees on _PDCLIB_SHRT_BYTES." );
+_PDCLIB_static_assert( sizeof( int ) == _PDCLIB_INT_BYTES, "Compiler disagrees on _PDCLIB_INT_BYTES." );
+_PDCLIB_static_assert( sizeof( long ) == _PDCLIB_LONG_BYTES, "Compiler disagrees on _PDCLIB_LONG_BYTES." );
+_PDCLIB_static_assert( sizeof( long long ) == _PDCLIB_LLONG_BYTES, "Compiler disagrees on _PDCLIB_LLONG_BYTES." );
+
+_PDCLIB_static_assert( ( (char)-1 < 0 ) == _PDCLIB_CHAR_SIGNED, "Compiler disagrees on _PDCLIB_CHAR_SIGNED." );
+_PDCLIB_static_assert( sizeof( sizeof( int ) ) == sizeof( _PDCLIB_size ), "Compiler disagrees on _PDCLIB_size." );
+
+_PDCLIB_static_assert( sizeof( _PDCLIB_wchar ) == sizeof( L'x' ), "Compiler disagrees on _PDCLIB_wchar." );
+
+_PDCLIB_static_assert( sizeof( void * ) == sizeof( _PDCLIB_intptr ), "Compiler disagrees on _PDCLIB_intptr." );
+
+_PDCLIB_static_assert( sizeof( &_PDCLIB_digits[1] - &_PDCLIB_digits[0] ) == sizeof( _PDCLIB_ptrdiff ), "Compiler disagrees on _PDCLIB_ptrdiff." );
+
+#endif