On altos, the primitive input function is ao_getchar, not getchar
[fw/pdclib] / internals / _PDCLIB_int.h
index 2420c790e7dc3071ae088bb9ff84c1386f2fedc8..b510c52eb2d391d88ae1a4139bebefb8eb937c90 100644 (file)
 /* -------------------------------------------------------------------------- */
 /* <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_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_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_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;
@@ -148,6 +153,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;
@@ -156,10 +162,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;
@@ -168,6 +176,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;
@@ -176,6 +185,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
@@ -258,12 +268,20 @@ typedef unsigned _PDCLIB_intmax _PDCLIB_uintmax_t;
 #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
@@ -342,8 +360,8 @@ 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, 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
@@ -389,22 +407,38 @@ 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 );
 
-/* 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 ];
+/* -------------------------------------------------------------------------- */
+/* <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;
+};
+