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

   1 /* $Id$ */
   2
   3 /* Internal PDCLib configuration <_PDCLIB_config.h>
   4    (Generic Template)
   5
   6    This file is part of the Public Domain C Library (PDCLib).
   7    Permission is granted to use, modify, and / or redistribute at will.
   8 */
   9
  10 /* -------------------------------------------------------------------------- */
  11 /* Misc                                                                       */
  12 /* -------------------------------------------------------------------------- */
  13
  14 /* The character (sequence) your platform uses as newline.                    */
  15 #define _PDCLIB_endl "\n"
  16
  17 /* exit() can signal success to the host environment by the value of zero or  */
  18 /* the constant EXIT_SUCCESS. Failure is signaled by EXIT_FAILURE. Note that  */
  19 /* any other return value is "implementation-defined", i.e. your environment  */
  20 /* is not required to handle it gracefully. Set your definitions here.        */
  21 #define _PDCLIB_SUCCESS 0
  22 #define _PDCLIB_FAILURE -1
  23
  24 /* qsort() in <stdlib.h> requires a function that swaps two memory areas.     */
  25 /* Below is a naive implementation that can be improved significantly for     */
  26 /* specific platforms, e.g. by swapping int instead of char.                  */
  27 #define _PDCLIB_memswp( i, j, size ) char tmp; do { tmp = *i; *i++ = *j; *j++ = tmp; } while ( --size );
  28
  29 /* Define this to some compiler directive that can be written after the       */
  30 /* parameter list of a function declaration to indicate the function does     */
  31 /* never return. If your compiler does not support such a directive, define   */
  32 /* to nothing. (This is to avoid warnings with the exit functions under GCC.) */
  33 #define _PDCLIB_NORETURN __attribute__(( noreturn ))
  34
  35 /* -------------------------------------------------------------------------- */
  36 /* Integers                                                                   */
  37 /* -------------------------------------------------------------------------- */
  38 /* Assuming 8-bit char, two's-complement architecture here. 'short' being     */
  39 /* 16 bit, 'int' being either 16, 32 or 64 bit, 'long' being either 32 or 64  */
  40 /* bit (but 64 bit only if 'int' is 32 bit), and 'long long' being 64 bit if  */
  41 /* 'long' is not, 64 or 128 bit otherwise.                                    */
  42 /* Author is quite willing to support other systems but would like to hear of */
  43 /* interest in such support and details on the to-be-supported architecture   */
  44 /* first, before going to lengths about it.                                   */
  45 /* -------------------------------------------------------------------------- */
  46
  47 /* Comment out (or delete) the line below if your 'char' type is unsigned.    */
  48 #define _PDCLIB_CHAR_SIGNED 1
  49
  50 /* Width of the integer types short, int, long, and long long, in bytes.      */
  51 /* SHRT == 2, INT >= SHRT, LONG >= INT >= 4, LLONG >= LONG - check your       */
  52 /* compiler manuals.                                                          */
  53 #define _PDCLIB_SHRT_BYTES  2
  54 #define _PDCLIB_INT_BYTES   4
  55 #define _PDCLIB_LONG_BYTES  4
  56 #define _PDCLIB_LLONG_BYTES 8
  57
  58 /* <stdlib.h> defines the div() function family that allows taking quotient   */
  59 /* and remainder of an integer division in one operation. Many platforms      */
  60 /* support this in hardware / opcode, and the standard permits ordering of    */
  61 /* the return structure in any way to fit the hardware. That is why those     */
  62 /* structs can be configured here.                                            */
  63
  64 struct _PDCLIB_div_t
  65 {
  66     int quot;
  67     int rem;
  68 };
  69
  70 struct _PDCLIB_ldiv_t
  71 {
  72     long int quot;
  73     long int rem;
  74 };
  75
  76 struct _PDCLIB_lldiv_t
  77 {
  78     long long int quot;
  79     long long int rem;
  80 };
  81
  82 /* -------------------------------------------------------------------------- */
  83 /* <stdint.h> defines a set of integer types that are of a minimum width, and */
  84 /* "usually fastest" on the system. (If, for example, accessing a single char */
  85 /* requires the CPU to access a complete int and then mask out the char, the  */
  86 /* "usually fastest" type of at least 8 bits would be int, not char.)         */
  87 /* If you do not have information on the relative performance of the types,   */
  88 /* the standard allows you to define any type that meets minimum width and    */
  89 /* signedness requirements.                                                   */
  90 /* The defines below are just configuration for the real typedefs and limit   */
  91 /* definitions done in <_PDCLIB_int.h>. The uppercase define shall be either  */
  92 /* SHRT, INT, LONG, or LLONG (telling which values to use for the *_MIN and   */
  93 /* *_MAX limits); the lowercase define either short, int, long, or long long  */
  94 /* (telling the actual type to use).                                          */
  95 /* The third define is the length modifier used for the type in printf() and  */
  96 /* scanf() functions (used in <inttypes.h>).                                  */
  97 /* If you require a non-standard datatype to define the "usually fastest"     */
  98 /* types, PDCLib as-is doesn't support that. Please contact the author with   */
  99 /* details on your platform in that case, so support can be added.            */
 100 /* -------------------------------------------------------------------------- */
 101
 102 #define _PDCLIB_FAST8 INT
 103 #define _PDCLIB_fast8 int
 104 #define _PDCLIB_FAST8_CONV
 105
 106 #define _PDCLIB_FAST16 INT
 107 #define _PDCLIB_fast16 int
 108 #define _PDCLIB_FAST16_CONV
 109
 110 #define _PDCLIB_FAST32 INT
 111 #define _PDCLIB_fast32 int
 112 #define _PDCLIB_FAST32_CONV
 113
 114 #define _PDCLIB_FAST64 LLONG
 115 #define _PDCLIB_fast64 long long
 116 #define _PDCLIB_FAST64_CONV ll
 117
 118 /* -------------------------------------------------------------------------- */
 119 /* What follows are a couple of "special" typedefs and their limits. Again,   */
 120 /* the actual definition of the limits is done in <_PDCLIB_int.h>, and the    */
 121 /* defines here are merely "configuration". See above for details.            */
 122 /* -------------------------------------------------------------------------- */
 123
 124 /* The result type of substracting two pointers */
 125 #define _PDCLIB_ptrdiff int
 126 #define _PDCLIB_PTRDIFF INT
 127 #define _PDCLIB_PTR_CONV
 128
 129 /* An integer type that can be accessed as atomic entity (think asynchronous
 130    interrupts). The type itself is not defined in a freestanding environment,
 131    but its limits are. (Don't ask.)
 132 */
 133 #define _PDCLIB_sig_atomic int
 134 #define _PDCLIB_SIG_ATOMIC INT
 135
 136 /* Result type of the 'sizeof' operator (must be unsigned) */
 137 #define _PDCLIB_size unsigned int
 138 #define _PDCLIB_SIZE UINT
 139
 140 /* Large enough an integer to hold all character codes of the largest supported
 141    locale.
 142 */
 143 #define _PDCLIB_wchar unsigned short
 144 #define _PDCLIB_WCHAR USHRT
 145
 146 #define _PDCLIB_intptr int
 147 #define _PDCLIB_INTPTR INT
 148
 149 /* Largest supported integer type. Implementation note: see _PDCLIB_atomax(). */
 150 #define _PDCLIB_intmax long long int
 151 #define _PDCLIB_INTMAX LLONG
 152 #define _PDCLIB_MAX_CONV ll
 153 /* You are also required to state the literal suffix for the intmax type      */
 154 #define _PDCLIB_INTMAX_LITERAL ll
 155
 156 /* <inttypes.h> defines imaxdiv(), which is equivalent to the div() function  */
 157 /* family (see further above) with intmax_t as basis.                         */
 158
 159 struct _PDCLIB_imaxdiv_t
 160 {
 161     _PDCLIB_intmax quot;
 162     _PDCLIB_intmax rem;
 163 };
 164
 165 /* -------------------------------------------------------------------------- */
 166 /* Floating Point                                                             */
 167 /* -------------------------------------------------------------------------- */
 168
 169 /* Whether the implementation rounds toward zero (0), to nearest (1), toward
 170    positive infinity (2), or toward negative infinity (3). (-1) signifies
 171    indeterminable rounding, any other value implementation-specific rounding.
 172 */
 173 #define _PDCLIB_FLT_ROUNDS -1
 174
 175 /* Whether the implementation uses exact-width precision (0), promotes float
 176    to double (1), or promotes float and double to long double (2). (-1)
 177    signifies indeterminable behaviour, any other value implementation-specific
 178    behaviour.
 179 */
 180 #define _PDCLIB_FLT_EVAL_METHOD -1
 181
 182 /* "Number of the decimal digits (n), such that any floating-point number in the
 183    widest supported floating type with p(max) radix (b) digits can be rounded to
 184    a floating-point number with (n) decimal digits and back again without change
 185    to the value p(max) log(10)b if (b) is a power of 10, [1 + p(max) log(10)b]
 186    otherwise."
 187    64bit IEC 60559 double format (53bit mantissa) is DECIMAL_DIG 17.
 188    80bit IEC 60559 double-extended format (64bit mantissa) is DECIMAL_DIG 21.
 189 */
 190 #define _PDCLIB_DECIMAL_DIG 17
 191
 192 /* -------------------------------------------------------------------------- */
 193 /* Platform-dependent macros defined by the standard headers.                 */
 194 /* -------------------------------------------------------------------------- */
 195
 196 /* The offsetof macro
 197    Contract: Expand to an integer constant expression of type size_t, which
 198    represents the offset in bytes to the structure member from the beginning
 199    of the structure. If the specified member is a bitfield, behaviour is
 200    undefined.
 201    There is no standard-compliant way to do this.
 202    This implementation casts an integer zero to 'pointer to type', and then
 203    takes the address of member. This is undefined behaviour but should work on
 204    most compilers.
 205 */
 206 #define _PDCLIB_offsetof( type, member ) ( (size_t) &( ( (type *) 0 )->member ) )
 207
 208 /* Variable Length Parameter List Handling (<stdarg.h>)
 209    The macros defined by <stdarg.h> are highly dependent on the calling
 210    conventions used, and you probably have to replace them with builtins of
 211    your compiler. The following generic implementation works only for pure
 212    stack-based architectures, and only if arguments are aligned to pointer
 213    type. Credits to Michael Moody, who contributed this to the Public Domain.
 214 */
 215
 216 /* Internal helper macro. va_round is not part of <stdarg.h>. */
 217 #define _PDCLIB_va_round( type ) ( (sizeof(type) + sizeof(void *) - 1) & ~(sizeof(void *) - 1) )
 218
 219 typedef char * _PDCLIB_va_list;
 220 #define _PDCLIB_va_arg( ap, type ) ( (ap) += (_PDCLIB_va_round(type)), ( *(type*) ( (ap) - (_PDCLIB_va_round(type)) ) ) )
 221 #define _PDCLIB_va_copy( dest, src ) ( (dest) = (src), (void)0 )
 222 #define _PDCLIB_va_end( ap ) ( (ap) = (void *)0, (void)0 )
 223 #define _PDCLIB_va_start( ap, parmN ) ( (ap) = (char *) &parmN + ( _PDCLIB_va_round(parmN) ), (void)0 )
 224
 225 /* -------------------------------------------------------------------------- */
 226 /* OS "glue", part 1                                                          */
 227 /* These are values and data type definitions that you would have to adapt to */
 228 /* the capabilities and requirements of your OS.                              */
 229 /* The actual *functions* of the OS interface are declared in _PDCLIB_glue.h. */
 230 /* -------------------------------------------------------------------------- */
 231
 232 /* Memory management -------------------------------------------------------- */
 233
 234 /* Set this to the page size of your OS. If your OS does not support paging, set
 235    to an appropriate value. (Too small, and malloc() will call the kernel too
 236    often. Too large, and you will waste memory.)
 237 */
 238 #define _PDCLIB_PAGESIZE 4096
 239
 240 /* Set this to the minimum memory node size. Any malloc() for a smaller size
 241    will be satisfied by a malloc() of this size instead (to avoid excessive
 242    fragmentation).
 243 */
 244 #define _PDCLIB_MINALLOC 8
 245
 246 /* I/O ---------------------------------------------------------------------- */
 247
 248 /* The type of the file descriptor returned by _PDCLIB_open(). */
 249 typedef int _PDCLIB_fd_t;
 250
 251 /* The value (of type _PDCLIB_fd_t) returned by _PDCLIB_open() if the operation
 252    failed.
 253 */
 254 #define _PDCLIB_NOHANDLE ( (_PDCLIB_fd_t) -1 )
 255
 256 /* The default size for file buffers. Must be at least 256. */
 257 #define _PDCLIB_BUFSIZ 1024
 258
 259 /* The minimum number of files the implementation can open simultaneously. Must
 260    be at least 8. Depends largely on how the bookkeeping is done by fopen() /
 261    freopen() / fclose(). The example implementation limits the number of open
 262    files only by available memory.
 263 */
 264 #define _PDCLIB_FOPEN_MAX 8
 265
 266 /* Length of the longest filename the implementation guarantees to support. */
 267 #define _PDCLIB_FILENAME_MAX 128
 268
 269 /* Maximum length of filenames generated by tmpnam(). (See tmpfile.c.) */
 270 #define _PDCLIB_L_tmpnam 46
 271
 272 /* Number of distinct file names that can be generated by tmpnam(). */
 273 #define _PDCLIB_TMP_MAX 50
 274
 275 /* The values of SEEK_SET, SEEK_CUR and SEEK_END, used by fseek().
 276    Since at least one platform (POSIX) uses the same symbols for its own "seek"
 277    function, we use whatever the host defines (if it does define them).
 278 */
 279 #define _PDCLIB_SEEK_SET 0
 280 #define _PDCLIB_SEEK_CUR 1
 281 #define _PDCLIB_SEEK_END 2
 282
 283 /* The number of characters that can be buffered with ungetc(). The standard
 284    guarantees only one (1); anything larger would make applications relying on
 285    this capability dependent on implementation-defined behaviour (not good).
 286 */
 287 #define _PDCLIB_UNGETCBUFSIZE 1