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