pd.if.org Git - pdclib/blob - internals/_PDCLIB_config.h

   1 /* $Id$ */
   2
   3 /* Release $Name$ */
   4
   5 /* Internal PDCLib configuration <_PDCLIB_config.h>
   6    (Generic Template)
   7
   8    This file is part of the Public Domain C Library (PDCLib).
   9    Permission is granted to use, modify, and / or redistribute at will.
  10 */
  11
  12 /* -------------------------------------------------------------------------- */
  13 /* Misc                                                                       */
  14 /* -------------------------------------------------------------------------- */
  15
  16 /* The character (sequence) your platform uses as newline.                    */
  17 #define _PDCLIB_endl "\n"
  18
  19 /* exit() can signal success to the host environment by the value of zero or  */
  20 /* the constant EXIT_SUCCESS. Failure is signaled by EXIT_FAILURE. Note that  */
  21 /* any other return value is "implementation-defined", i.e. your environment  */
  22 /* is not required to handle it gracefully. Set your definitions here.        */
  23 #define _PDCLIB_SUCCESS 0
  24 #define _PDCLIB_FAILURE -1
  25
  26 /* -------------------------------------------------------------------------- */
  27 /* Integers                                                                   */
  28 /* -------------------------------------------------------------------------- */
  29 /* Assuming 8-bit char, two's-complement architecture here. 'short' being     */
  30 /* 16 bit, 'int' being either 16, 32 or 64 bit, 'long' being either 32 or 64  */
  31 /* bit (but 64 bit only if 'int' is 32 bit), and 'long long' being 64 bit if  */
  32 /* 'long' is not, 64 or 128 bit otherwise.                                    */
  33 /* Author is quite willing to support other systems but would like to hear of */
  34 /* interest in such support and details on the to-be-supported architecture   */
  35 /* first, before going to lengths about it.                                   */
  36 /* -------------------------------------------------------------------------- */
  37
  38 /* Comment out (or delete) the line below if your 'char' type is unsigned.    */
  39 #define _PDCLIB_CHAR_SIGNED 1
  40
  41 /* Width of the integer types short, int, long, and long long, in bytes.      */
  42 /* SHRT == 2, INT >= SHRT, LONG >= INT >= 4, LLONG >= LONG - check your       */
  43 /* compiler manuals.                                                          */
  44 #define _PDCLIB_SHRT_BYTES  2
  45 #define _PDCLIB_INT_BYTES   4
  46 #define _PDCLIB_LONG_BYTES  4
  47 #define _PDCLIB_LLONG_BYTES 8
  48
  49 /* <stdlib.h> defines the div() function family that allows taking quotient   */
  50 /* and remainder of an integer division in one operation. Many platforms      */
  51 /* support this in hardware / opcode, and the standard permits ordering of    */
  52 /* the return structure in any way to fit the hardware. That is why those     */
  53 /* structs can be configured here.                                            */
  54
  55 struct _PDCLIB_div_t
  56 {
  57     int quot;
  58     int rem;
  59 };
  60
  61 struct _PDCLIB_ldiv_t
  62 {
  63     long int quot;
  64     long int rem;
  65 };
  66
  67 struct _PDCLIB_lldiv_t
  68 {
  69     long long int quot;
  70     long long int rem;
  71 };
  72
  73 /* -------------------------------------------------------------------------- */
  74 /* <stdint.h> defines a set of integer types that are of a minimum width, and */
  75 /* "usually fastest" on the system. (If, for example, accessing a single char */
  76 /* requires the CPU to access a complete int and then mask out the char, the  */
  77 /* "usually fastest" type of at least 8 bits would be int, not char.)         */
  78 /* If you do not have information on the relative performance of the types,   */
  79 /* the standard allows you to define any type that meets minimum width and    */
  80 /* signedness requirements.                                                   */
  81 /* The defines below are just configuration for the real typedefs and limit   */
  82 /* definitions done in <_PDCLIB_int.h>. The uppercase define shall be either  */
  83 /* SHRT, INT, LONG, or LLONG (telling which values to use for the *_MIN and   */
  84 /* *_MAX limits); the lowercase define either short, int, long, or long long  */
  85 /* (telling the actual type to use).                                          */
  86 /* If you require a non-standard datatype to define the "usually fastest"     */
  87 /* types, PDCLib as-is doesn't support that. Please contact the author with   */
  88 /* details on your platform in that case, so support can be added.            */
  89 /* -------------------------------------------------------------------------- */
  90
  91 #define _PDCLIB_FAST8 INT
  92 #define _PDCLIB_fast8 int
  93
  94 #define _PDCLIB_FAST16 INT
  95 #define _PDCLIB_fast16 int
  96
  97 #define _PDCLIB_FAST32 INT
  98 #define _PDCLIB_fast32 int
  99
 100 #define _PDCLIB_FAST64 LLONG
 101 #define _PDCLIB_fast64 long long
 102
 103 /* -------------------------------------------------------------------------- */
 104 /* What follows are a couple of "special" typedefs and their limits. Again,   */
 105 /* the actual definition of the limits is done in <_PDCLIB_int.h>, and the    */
 106 /* defines here are merely "configuration". See above for details.            */
 107 /* -------------------------------------------------------------------------- */
 108
 109 /* The result type of substracting two pointers */
 110 #define _PDCLIB_ptrdiff int
 111 #define _PDCLIB_PTRDIFF INT
 112
 113 /* An integer type that can be accessed as atomic entity (think asynchronous
 114    interrupts). The type itself is not defined in a freestanding environment,
 115    but its limits are. (Don't ask.)
 116 */
 117 #define _PDCLIB_SIG_ATOMIC INT
 118
 119 /* Result type of the 'sizeof' operator */
 120 #define _PDCLIB_size unsigned int
 121 #define _PDCLIB_SIZE UINT
 122
 123 /* Large enough an integer to hold all character codes of the largest supported
 124    locale.
 125 */
 126 #define _PDCLIB_wchar unsigned short
 127 #define _PDCLIB_WCHAR USHRT
 128
 129 #define _PDCLIB_intptr int
 130 #define _PDCLIB_INTPTR INT
 131
 132 /* Largest supported integer type. Implementation note: see _PDCLIB_atomax(). */
 133 #define _PDCLIB_intmax long long int
 134 #define _PDCLIB_INTMAX LLINT
 135 /* You are also required to state the literal suffix for the intmax type      */
 136 #define _PDCLIB_INTMAX_LITERAL ll
 137
 138 /* -------------------------------------------------------------------------- */
 139 /* Floating Point                                                             */
 140 /* -------------------------------------------------------------------------- */
 141
 142 /* Whether the implementation rounds toward zero (0), to nearest (1), toward
 143    positive infinity (2), or toward negative infinity (3). (-1) signifies
 144    indeterminable rounding, any other value implementation-specific rounding.
 145 */
 146 #define _PDCLIB_FLT_ROUNDS -1
 147
 148 /* Whether the implementation uses exact-width precision (0), promotes float
 149    to double (1), or promotes float and double to long double (2). (-1)
 150    signifies indeterminable behaviour, any other value implementation-specific
 151    behaviour.
 152 */
 153 #define _PDCLIB_FLT_EVAL_METHOD -1
 154
 155 /* "Number of the decimal digits (n), such that any floating-point number in the
 156    widest supported floating type with p(max) radix (b) digits can be rounded to
 157    a floating-point number with (n) decimal digits and back again without change
 158    to the value p(max) log(10)b if (b) is a power of 10, [1 + p(max) log(10)b]
 159    otherwise."
 160    64bit IEC 60559 double format (53bit mantissa) is DECIMAL_DIG 17.
 161    80bit IEC 60559 double-extended format (64bit mantissa) is DECIMAL_DIG 21.
 162 */
 163 #define _PDCLIB_DECIMAL_DIG 17
 164
 165 /* -------------------------------------------------------------------------- */
 166 /* Platform-dependent macros defined by the standard headers.                 */
 167 /* -------------------------------------------------------------------------- */
 168
 169 /* The offsetof macro
 170    Contract: Expand to an integer constant expression of type size_t, which
 171    represents the offset in bytes to the structure member from the beginning
 172    of the structure. If the specified member is a bitfield, behaviour is
 173    undefined.
 174    There is no standard-compliant way to do this.
 175    This implementation casts an integer zero to 'pointer to type', and then
 176    takes the address of member. This is undefined behaviour but should work on
 177    most compilers.
 178 */
 179 #define _PDCLIB_offsetof( type, member ) ( (size_t) &( ( (type *) 0 )->member ) )
 180
 181 /* Variable Length Parameter List Handling (<stdarg.h>)
 182    The macros defined by <stdarg.h> are highly dependent on the calling
 183    conventions used, and you probably have to replace them with builtins of
 184    your compiler. The following generic implementation works only for pure
 185    stack-based architectures, and only if arguments are aligned to pointer
 186    type. Credits to Michael Moody, who contributed this to the Public Domain.
 187 */
 188
 189 /* Internal helper macro. va_round is not part of <stdarg.h>. */
 190 #define _PDCLIB_va_round( type ) ( (sizeof(type) + sizeof(void *) - 1) & ~(sizeof(void *) - 1) )
 191
 192 typedef char * _PDCLIB_va_list;
 193 #define _PDCLIB_va_arg( ap, type ) ( (ap) += (_PDCLIB_va_round(type)), ( *(type*) ( (ap) - (_PDCLIB_va_round(type)) ) ) )
 194 #define _PDCLIB_va_copy( dest, src ) ( (dest) = (src), (void)0 )
 195 #define _PDCLIB_va_end( ap ) ( (ap) = (void *)0, (void)0 )
 196 #define _PDCLIB_va_start( ap, parmN ) ( (ap) = (char *) &parmN + ( _PDCLIB_va_round(parmN) ), (void)0 )