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

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