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