3 /* Internal PDCLib configuration <_PDCLIB_config.h>
6 This file is part of the Public Domain C Library (PDCLib).
7 Permission is granted to use, modify, and / or redistribute at will.
10 /* -------------------------------------------------------------------------- */
12 /* -------------------------------------------------------------------------- */
14 /* By default, PDCLib does some rather strict checking of function usage, */
15 /* especially in <stdio.h>. Things that are undefined by the standard - for */
16 /* example, mixing byte / wide operations or read / write operations without */
17 /* resetting the stream beforehand - are caught and handled graciously. This */
18 /* adds some complexity, and eats a couple of clock cycles. If you want to */
19 /* disable these checks, define _PDCLIB_STRICT to zero. */
20 #define _PDCLIB_STRICT 1
22 /* The character (sequence) your platform uses as newline. */
23 #define _PDCLIB_endl "\n"
25 /* exit() can signal success to the host environment by the value of zero or */
26 /* the constant EXIT_SUCCESS. Failure is signaled by EXIT_FAILURE. Note that */
27 /* any other return value is "implementation-defined", i.e. your environment */
28 /* is not required to handle it gracefully. Set your definitions here. */
29 #define _PDCLIB_SUCCESS 0
30 #define _PDCLIB_FAILURE -1
32 /* qsort() in <stdlib.h> requires a function that swaps two memory areas. */
33 /* Below is a naive implementation that can be improved significantly for */
34 /* specific platforms, e.g. by swapping int instead of char. */
35 #define _PDCLIB_memswp( i, j, size ) char tmp; do { tmp = *i; *i++ = *j; *j++ = tmp; } while ( --size );
37 /* Define this to some compiler directive that can be written after the */
38 /* parameter list of a function declaration to indicate the function does */
39 /* never return. If your compiler does not support such a directive, define */
40 /* to nothing. (This is to avoid warnings with the exit functions under GCC.) */
41 #define _PDCLIB_NORETURN __attribute__(( noreturn ))
43 /* -------------------------------------------------------------------------- */
45 /* -------------------------------------------------------------------------- */
46 /* Assuming 8-bit char, two's-complement architecture here. 'short' being */
47 /* 16 bit, 'int' being either 16, 32 or 64 bit, 'long' being either 32 or 64 */
48 /* bit (but 64 bit only if 'int' is 32 bit), and 'long long' being 64 bit if */
49 /* 'long' is not, 64 or 128 bit otherwise. */
50 /* Author is quite willing to support other systems but would like to hear of */
51 /* interest in such support and details on the to-be-supported architecture */
52 /* first, before going to lengths about it. */
53 /* -------------------------------------------------------------------------- */
55 /* Comment out (or delete) the line below if your 'char' type is unsigned. */
56 #define _PDCLIB_CHAR_SIGNED 1
58 /* Width of the integer types short, int, long, and long long, in bytes. */
59 /* SHRT == 2, INT >= SHRT, LONG >= INT >= 4, LLONG >= LONG - check your */
60 /* compiler manuals. */
61 #define _PDCLIB_SHRT_BYTES 2
62 #define _PDCLIB_INT_BYTES 4
63 #define _PDCLIB_LONG_BYTES 4
64 #define _PDCLIB_LLONG_BYTES 8
66 /* <stdlib.h> defines the div() function family that allows taking quotient */
67 /* and remainder of an integer division in one operation. Many platforms */
68 /* support this in hardware / opcode, and the standard permits ordering of */
69 /* the return structure in any way to fit the hardware. That is why those */
70 /* structs can be configured here. */
84 struct _PDCLIB_lldiv_t
90 /* -------------------------------------------------------------------------- */
91 /* <stdint.h> defines a set of integer types that are of a minimum width, and */
92 /* "usually fastest" on the system. (If, for example, accessing a single char */
93 /* requires the CPU to access a complete int and then mask out the char, the */
94 /* "usually fastest" type of at least 8 bits would be int, not char.) */
95 /* If you do not have information on the relative performance of the types, */
96 /* the standard allows you to define any type that meets minimum width and */
97 /* signedness requirements. */
98 /* The defines below are just configuration for the real typedefs and limit */
99 /* definitions done in <_PDCLIB_int.h>. The uppercase define shall be either */
100 /* SHRT, INT, LONG, or LLONG (telling which values to use for the *_MIN and */
101 /* *_MAX limits); the lowercase define either short, int, long, or long long */
102 /* (telling the actual type to use). */
103 /* If you require a non-standard datatype to define the "usually fastest" */
104 /* types, PDCLib as-is doesn't support that. Please contact the author with */
105 /* details on your platform in that case, so support can be added. */
106 /* -------------------------------------------------------------------------- */
108 #define _PDCLIB_FAST8 INT
109 #define _PDCLIB_fast8 int
111 #define _PDCLIB_FAST16 INT
112 #define _PDCLIB_fast16 int
114 #define _PDCLIB_FAST32 INT
115 #define _PDCLIB_fast32 int
117 #define _PDCLIB_FAST64 LLONG
118 #define _PDCLIB_fast64 long long
120 /* -------------------------------------------------------------------------- */
121 /* What follows are a couple of "special" typedefs and their limits. Again, */
122 /* the actual definition of the limits is done in <_PDCLIB_int.h>, and the */
123 /* defines here are merely "configuration". See above for details. */
124 /* -------------------------------------------------------------------------- */
126 /* The result type of substracting two pointers */
127 #define _PDCLIB_ptrdiff int
128 #define _PDCLIB_PTRDIFF INT
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.)
134 #define _PDCLIB_sig_atomic int
135 #define _PDCLIB_SIG_ATOMIC INT
137 /* Result type of the 'sizeof' operator (must be unsigned) */
138 #define _PDCLIB_size unsigned int
139 #define _PDCLIB_SIZE UINT
141 /* Large enough an integer to hold all character codes of the largest supported
144 #define _PDCLIB_wchar unsigned short
145 #define _PDCLIB_WCHAR USHRT
147 #define _PDCLIB_intptr int
148 #define _PDCLIB_INTPTR INT
150 /* Largest supported integer type. Implementation note: see _PDCLIB_atomax(). */
151 #define _PDCLIB_intmax long long int
152 #define _PDCLIB_INTMAX LLINT
153 /* You are also required to state the literal suffix for the intmax type */
154 #define _PDCLIB_INTMAX_LITERAL ll
156 /* -------------------------------------------------------------------------- */
158 /* -------------------------------------------------------------------------- */
160 /* Whether the implementation rounds toward zero (0), to nearest (1), toward
161 positive infinity (2), or toward negative infinity (3). (-1) signifies
162 indeterminable rounding, any other value implementation-specific rounding.
164 #define _PDCLIB_FLT_ROUNDS -1
166 /* Whether the implementation uses exact-width precision (0), promotes float
167 to double (1), or promotes float and double to long double (2). (-1)
168 signifies indeterminable behaviour, any other value implementation-specific
171 #define _PDCLIB_FLT_EVAL_METHOD -1
173 /* "Number of the decimal digits (n), such that any floating-point number in the
174 widest supported floating type with p(max) radix (b) digits can be rounded to
175 a floating-point number with (n) decimal digits and back again without change
176 to the value p(max) log(10)b if (b) is a power of 10, [1 + p(max) log(10)b]
178 64bit IEC 60559 double format (53bit mantissa) is DECIMAL_DIG 17.
179 80bit IEC 60559 double-extended format (64bit mantissa) is DECIMAL_DIG 21.
181 #define _PDCLIB_DECIMAL_DIG 17
183 /* -------------------------------------------------------------------------- */
184 /* Platform-dependent macros defined by the standard headers. */
185 /* -------------------------------------------------------------------------- */
187 /* The offsetof macro
188 Contract: Expand to an integer constant expression of type size_t, which
189 represents the offset in bytes to the structure member from the beginning
190 of the structure. If the specified member is a bitfield, behaviour is
192 There is no standard-compliant way to do this.
193 This implementation casts an integer zero to 'pointer to type', and then
194 takes the address of member. This is undefined behaviour but should work on
197 #define _PDCLIB_offsetof( type, member ) ( (size_t) &( ( (type *) 0 )->member ) )
199 /* Variable Length Parameter List Handling (<stdarg.h>)
200 The macros defined by <stdarg.h> are highly dependent on the calling
201 conventions used, and you probably have to replace them with builtins of
202 your compiler. The following generic implementation works only for pure
203 stack-based architectures, and only if arguments are aligned to pointer
204 type. Credits to Michael Moody, who contributed this to the Public Domain.
207 /* Internal helper macro. va_round is not part of <stdarg.h>. */
208 #define _PDCLIB_va_round( type ) ( (sizeof(type) + sizeof(void *) - 1) & ~(sizeof(void *) - 1) )
210 typedef char * _PDCLIB_va_list;
211 #define _PDCLIB_va_arg( ap, type ) ( (ap) += (_PDCLIB_va_round(type)), ( *(type*) ( (ap) - (_PDCLIB_va_round(type)) ) ) )
212 #define _PDCLIB_va_copy( dest, src ) ( (dest) = (src), (void)0 )
213 #define _PDCLIB_va_end( ap ) ( (ap) = (void *)0, (void)0 )
214 #define _PDCLIB_va_start( ap, parmN ) ( (ap) = (char *) &parmN + ( _PDCLIB_va_round(parmN) ), (void)0 )
216 /* -------------------------------------------------------------------------- */
217 /* OS "glue", part 1 */
218 /* These are values and data type definitions that you would have to adapt to */
219 /* the capabilities and requirements of your OS. */
220 /* The actual *functions* of the OS interface are declared in _PDCLIB_glue.h. */
221 /* -------------------------------------------------------------------------- */
223 /* Memory management -------------------------------------------------------- */
225 /* Set this to the page size of your OS. If your OS does not support paging, set
226 to an appropriate value. (Too small, and malloc() will call the kernel too
227 often. Too large, and you will waste memory.)
229 #define _PDCLIB_PAGESIZE 4096
231 /* Set this to the minimum memory node size. Any malloc() for a smaller size
232 will be satisfied by a malloc() of this size instead (to avoid excessive
235 #define _PDCLIB_MINALLOC 8
237 /* I/O ---------------------------------------------------------------------- */
239 /* The type of the file descriptor returned by _PDCLIB_open(). */
240 typedef int _PDCLIB_fd_t;
242 /* The value (of type _PDCLIB_fd_t) returned by _PDCLIB_open() if the operation
245 #define _PDCLIB_NOHANDLE ( (_PDCLIB_fd_t) -1 )
247 /* A type in which to store file offsets. See fgetpos() / fsetpos(). */
248 /* FIXME: The 'int' types here are placeholders. When changed, check out
256 /* The default size for file buffers. Must be at least 256. */
257 #define _PDCLIB_BUFSIZ 1024
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().
263 #define _PDCLIB_FOPEN_MAX 8
265 /* Length of the longest filename the implementation guarantees to support. */
266 #define _PDCLIB_FILENAME_MAX 128
268 /* Buffer size for tmpnam(). */
269 #define _PDCLIB_L_tmpnam 100
271 /* Number of distinct file names that can be generated by tmpnam(). */
272 #define _PDCLIB_TMP_MAX 50
274 /* The number of times fflush() tries to write a file buffer before giving up
275 if no characters can be written.
277 #define _PDCLIB_FLUSH_RETRIES 3
278 /* This macro is executed after each try to write characters that results in
279 no characters being written. You can define this to be empty, wait a short
280 period of time, or whatever suits your environment.
282 #define _PDCLIB_FLUSH_RETRY_PREP