]> pd.if.org Git - pdclib/blob - _PDCLIB_config.h
Added note about v0.1 not being much tested.
[pdclib] / _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 /* Integers                                                                   */
14 /* -------------------------------------------------------------------------- */
15 /* Assuming 8-bit char, two's-complement architecture here. 'short' being     */
16 /* 16 bit, 'int' being either 16, 32 or 64 bit, 'long' being either 32 or 64  */
17 /* bit (but 64 bit only if 'int' is 32 bit), and 'long long' being 64 bit if  */
18 /* 'long' is not, 64 or 128 bit otherwise.                                    */
19 /* Author is quite willing to support other systems but would like to hear of */
20 /* interest in such support and details on the to-be-supported architecture   */
21 /* first, before going to lengths about it.                                   */
22 /* -------------------------------------------------------------------------- */
23
24 /* Comment out (or delete) the line below if your 'char' type is unsigned.    */
25 #define _PDCLIB_CHAR_SIGNED 1
26
27 /* Width of the integer types short, int, long, and long long, in bytes.      */
28 /* SHRT == 2, INT >= SHRT, LONG >= INT >= 4, LLONG >= LONG - check your       */
29 /* compiler manuals.                                                          */
30 #define _PDCLIB_SHRT_BYTES  2
31 #define _PDCLIB_INT_BYTES   4
32 #define _PDCLIB_LONG_BYTES  4
33 #define _PDCLIB_LLONG_BYTES 8
34
35 /* -------------------------------------------------------------------------- */
36 /* <stdint.h> defines a set of integer types that are of a minimum width, and */
37 /* "usually fastest" on the system. (If, for example, accessing a single char */
38 /* requires the CPU to access a complete int and then mask out the char, the  */
39 /* "usually fastest" type of at least 8 bits would be int, not char.)         */
40 /* If you do not have information on the relative performance of the types,   */
41 /* the standard allows you to define any type that meets minimum width and    */
42 /* signedness requirements.                                                   */
43 /* The defines below are just configuration for the real typedefs and limit   */
44 /* definitions done in <_PDCLIB_int.h>. The uppercase define shall be either  */
45 /* SHRT, INT, LONG, or LLONG (telling which values to use for the *_MIN and   */
46 /* *_MAX limits); the lowercase define either short, int, long, or long long  */
47 /* (telling the actual type to use).                                          */
48 /* If you require a non-standard datatype to define the "usually fastest"     */
49 /* types, PDCLib as-is doesn't support that. Please contact the author with   */
50 /* details on your platform in that case, so support can be added.            */
51 /* -------------------------------------------------------------------------- */
52
53 #define _PDCLIB_FAST8 INT
54 #define _PDCLIB_fast8 int
55
56 #define _PDCLIB_FAST16 INT
57 #define _PDCLIB_fast16 int
58
59 #define _PDCLIB_FAST32 INT
60 #define _PDCLIB_fast32 int
61
62 #define _PDCLIB_FAST64 LLONG
63 #define _PDCLIB_fast64 long long
64
65 /* -------------------------------------------------------------------------- */
66 /* What follows are a couple of "special" typedefs and their limits. Again,   */
67 /* the actual definition of the limits is done in <_PDCLIB_int.h>, and the    */
68 /* defines here are merely "configuration". See above for details.            */
69 /* -------------------------------------------------------------------------- */
70
71 /* The result type of substracting two pointers */
72 #define _PDCLIB_ptrdiff int
73 #define _PDCLIB_PTRDIFF INT
74
75 /* An integer type that can be accessed as atomic entity (think asynchronous
76    interrupts). The type itself is not defined in a freestanding environment,
77    but its limits are. (Don't ask.)
78 */
79 #define _PDCLIB_SIG_ATOMIC INT
80
81 /* Result type of the 'sizeof' operator */
82 #define _PDCLIB_size unsigned int
83 #define _PDCLIB_SIZE UINT
84
85 /* Large enough an integer to hold all character codes of the largest supported
86    locale.
87 */
88 #define _PDCLIB_wchar unsigned short 
89 #define _PDCLIB_WCHAR USHRT
90
91 #define _PDCLIB_intptr int
92 #define _PDCLIB_INTPTR INT
93
94 #define _PDCLIB_intmax long long int
95 #define _PDCLIB_INTMAX LLINT
96
97 /* -------------------------------------------------------------------------- */
98 /* Floating Point                                                             */
99 /* -------------------------------------------------------------------------- */
100
101 /* Whether the implementation rounds toward zero (0), to nearest (1), toward
102    positive infinity (2), or toward negative infinity (3). (-1) signifies
103    indeterminable rounding, any other value implementation-specific rounding.
104 */
105 #define _PDCLIB_FLT_ROUNDS -1
106
107 /* Whether the implementation uses exact-width precision (0), promotes float
108    to double (1), or promotes float and double to long double (2). (-1)
109    signifies indeterminable behaviour, any other value implementation-specific
110    behaviour.
111 */
112 #define _PDCLIB_FLT_EVAL_METHOD -1
113
114 /* "Number of the decimal digits (n), such that any floating-point number in the
115    widest supported floating type with p(max) radix (b) digits can be rounded to
116    a floating-point number with (n) decimal digits and back again without change
117    to the value p(max) log(10)b if (b) is a power of 10, [1 + p(max) log(10)b]
118    otherwise."
119    64bit IEC 60559 double format (53bit mantissa) is DECIMAL_DIG 17.
120    80bit IEC 60559 double-extended format (64bit mantissa) is DECIMAL_DIG 21.
121 */
122 #define _PDCLIB_DECIMAL_DIG 17
123
124 /* -------------------------------------------------------------------------- */
125 /* Platform-dependent macros defined by the standard headers.                 */
126 /* -------------------------------------------------------------------------- */
127
128 /* The offsetof macro
129    Contract: Expand to an integer constant expression of type size_t, which
130    represents the offset in bytes to the structure member from the beginning
131    of the structure. If the specified member is a bitfield, behaviour is
132    undefined.
133    There is no standard-compliant way to do this.
134    This implementation casts an integer zero to 'pointer to type', and then
135    takes the address of member. This is undefined behaviour but should work on
136    most compilers.
137 */
138 #define _PDCLIB_offsetof( type, member ) ( (size_t) &( ( (type *) 0 )->member ) )
139
140 /* Variable Length Parameter List Handling (<stdarg.h>)
141    The macros defined by <stdarg.h> are highly dependent on the calling
142    conventions used, and you probably have to replace them with builtins of
143    your compiler. The following generic implementation works only for pure
144    stack-based architectures, and only if arguments are aligned to pointer
145    type. Credits to Michael Moody, who contributed this to the Public Domain.
146 */
147
148 /* Internal helper macro. va_round is not part of <stdarg.h>. */
149 #define _PDCLIB_va_round( type ) ( (sizeof(type) + sizeof(void *) - 1) & ~(sizeof(void *) - 1) )
150
151 typedef char * _PDCLIB_va_list;
152 #define _PDCLIB_va_arg( ap, type ) ( (ap) += (_PDCLIB_va_round(type)), ( *(type*) ( (ap) - (_PDCLIB_va_round(type)) ) ) )
153 #define _PDCLIB_va_copy( dest, src ) ( (dest) = (src), (void)0 )
154 #define _PDCLIB_va_end( ap ) ( (ap) = (void *)0, (void)0 )
155 #define _PDCLIB_va_start( ap, parmN ) ( (ap) = (char *) &parmN + ( _PDCLIB_va_round(parmN) ), (void)0 )
156