]> pd.if.org Git - pdclib/blob - internals/_PDCLIB_config.h
Cosmetic comment fixes.
[pdclib] / 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 /* -------------------------------------------------------------------------- */
11 /* Misc                                                                       */
12 /* -------------------------------------------------------------------------- */
13
14 /* The character (sequence) your platform uses as newline.                    */
15 #define _PDCLIB_endl "\n"
16
17 /* exit() can signal success to the host environment by the value of zero or  */
18 /* the constant EXIT_SUCCESS. Failure is signaled by EXIT_FAILURE. Note that  */
19 /* any other return value is "implementation-defined", i.e. your environment  */
20 /* is not required to handle it gracefully. Set your definitions here.        */
21 #define _PDCLIB_SUCCESS 0
22 #define _PDCLIB_FAILURE -1
23
24 /* qsort() in <stdlib.h> requires a function that swaps two memory areas.     */
25 /* Below is a naive implementation that can be improved significantly for     */
26 /* specific platforms, e.g. by swapping int instead of char.                  */
27 #define _PDCLIB_memswp( i, j, size ) char tmp; do { tmp = *i; *i++ = *j; *j++ = tmp; } while ( --size );
28
29 /* Define this to some compiler directive that can be written after the       */
30 /* parameter list of a function declaration to indicate the function does     */
31 /* never return. If your compiler does not support such a directive, define   */
32 /* to nothing. (This is to avoid warnings with the exit functions under GCC.) */
33 #define _PDCLIB_NORETURN __attribute__(( noreturn ))
34
35 /* The maximum value that errno can be set to. This is used to set the size   */
36 /* of the array in struct lconv (<locale.h>) holding error messages for the   */
37 /* strerror() and perror() functions. (If you change this value because you   */
38 /* are using additional errno values, you *HAVE* to provide appropriate error */
39 /* messages for *ALL* locales.)                                               */
40 /* Default is 4 (0, ERANGE, EDOM, EILSEQ).                                    */
41 #define _PDCLIB_ERRNO_MAX 4
42
43 /* -------------------------------------------------------------------------- */
44 /* Integers                                                                   */
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 /* -------------------------------------------------------------------------- */
54
55 /* Comment out (or delete) the line below if your 'char' type is unsigned.    */
56 #define _PDCLIB_CHAR_SIGNED 1
57
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
65
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.                                            */
71
72 struct _PDCLIB_div_t
73 {
74     int quot;
75     int rem;
76 };
77
78 struct _PDCLIB_ldiv_t
79 {
80     long int quot;
81     long int rem;
82 };
83
84 struct _PDCLIB_lldiv_t
85 {
86     long long int quot;
87     long long int rem;
88 };
89
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 /* The third define is the length modifier used for the type in printf() and  */
104 /* scanf() functions (used in <inttypes.h>).                                  */
105 /* If you require a non-standard datatype to define the "usually fastest"     */
106 /* types, PDCLib as-is doesn't support that. Please contact the author with   */
107 /* details on your platform in that case, so support can be added.            */
108 /* -------------------------------------------------------------------------- */
109
110 #define _PDCLIB_FAST8 INT
111 #define _PDCLIB_fast8 int
112 #define _PDCLIB_FAST8_CONV
113
114 #define _PDCLIB_FAST16 INT
115 #define _PDCLIB_fast16 int
116 #define _PDCLIB_FAST16_CONV
117
118 #define _PDCLIB_FAST32 INT
119 #define _PDCLIB_fast32 int
120 #define _PDCLIB_FAST32_CONV
121
122 #define _PDCLIB_FAST64 LLONG
123 #define _PDCLIB_fast64 long long
124 #define _PDCLIB_FAST64_CONV ll
125
126 /* -------------------------------------------------------------------------- */
127 /* What follows are a couple of "special" typedefs and their limits. Again,   */
128 /* the actual definition of the limits is done in <_PDCLIB_int.h>, and the    */
129 /* defines here are merely "configuration". See above for details.            */
130 /* -------------------------------------------------------------------------- */
131
132 /* The result type of substracting two pointers */
133 #define _PDCLIB_ptrdiff int
134 #define _PDCLIB_PTRDIFF INT
135 #define _PDCLIB_PTR_CONV
136
137 /* An integer type that can be accessed as atomic entity (think asynchronous
138    interrupts). The type itself is not defined in a freestanding environment,
139    but its limits are. (Don't ask.)
140 */
141 #define _PDCLIB_sig_atomic int
142 #define _PDCLIB_SIG_ATOMIC INT
143
144 /* Result type of the 'sizeof' operator (must be unsigned) */
145 #define _PDCLIB_size unsigned int
146 #define _PDCLIB_SIZE UINT
147
148 /* Large enough an integer to hold all character codes of the largest supported
149    locale.
150 */
151 #define _PDCLIB_wchar unsigned short 
152 #define _PDCLIB_WCHAR USHRT
153
154 #define _PDCLIB_intptr int
155 #define _PDCLIB_INTPTR INT
156
157 /* Largest supported integer type. Implementation note: see _PDCLIB_atomax(). */
158 #define _PDCLIB_intmax long long int
159 #define _PDCLIB_INTMAX LLONG
160 #define _PDCLIB_MAX_CONV ll
161 /* You are also required to state the literal suffix for the intmax type      */
162 #define _PDCLIB_INTMAX_LITERAL ll
163
164 /* <inttypes.h> defines imaxdiv(), which is equivalent to the div() function  */
165 /* family (see further above) with intmax_t as basis.                         */
166
167 struct _PDCLIB_imaxdiv_t
168 {
169     _PDCLIB_intmax quot;
170     _PDCLIB_intmax rem;
171 };
172
173 /* -------------------------------------------------------------------------- */
174 /* Floating Point                                                             */
175 /* -------------------------------------------------------------------------- */
176
177 /* Whether the implementation rounds toward zero (0), to nearest (1), toward
178    positive infinity (2), or toward negative infinity (3). (-1) signifies
179    indeterminable rounding, any other value implementation-specific rounding.
180 */
181 #define _PDCLIB_FLT_ROUNDS -1
182
183 /* Whether the implementation uses exact-width precision (0), promotes float
184    to double (1), or promotes float and double to long double (2). (-1)
185    signifies indeterminable behaviour, any other value implementation-specific
186    behaviour.
187 */
188 #define _PDCLIB_FLT_EVAL_METHOD -1
189
190 /* "Number of the decimal digits (n), such that any floating-point number in the
191    widest supported floating type with p(max) radix (b) digits can be rounded to
192    a floating-point number with (n) decimal digits and back again without change
193    to the value p(max) log(10)b if (b) is a power of 10, [1 + p(max) log(10)b]
194    otherwise."
195    64bit IEC 60559 double format (53bit mantissa) is DECIMAL_DIG 17.
196    80bit IEC 60559 double-extended format (64bit mantissa) is DECIMAL_DIG 21.
197 */
198 #define _PDCLIB_DECIMAL_DIG 17
199
200 /* -------------------------------------------------------------------------- */
201 /* Platform-dependent macros defined by the standard headers.                 */
202 /* -------------------------------------------------------------------------- */
203
204 /* The offsetof macro
205    Contract: Expand to an integer constant expression of type size_t, which
206    represents the offset in bytes to the structure member from the beginning
207    of the structure. If the specified member is a bitfield, behaviour is
208    undefined.
209    There is no standard-compliant way to do this.
210    This implementation casts an integer zero to 'pointer to type', and then
211    takes the address of member. This is undefined behaviour but should work on
212    most compilers.
213 */
214 #define _PDCLIB_offsetof( type, member ) ( (size_t) &( ( (type *) 0 )->member ) )
215
216 /* Variable Length Parameter List Handling (<stdarg.h>)
217    The macros defined by <stdarg.h> are highly dependent on the calling
218    conventions used, and you probably have to replace them with builtins of
219    your compiler. The following generic implementation works only for pure
220    stack-based architectures, and only if arguments are aligned to pointer
221    type. Credits to Michael Moody, who contributed this to the Public Domain.
222 */
223
224 /* Internal helper macro. va_round is not part of <stdarg.h>. */
225 #define _PDCLIB_va_round( type ) ( (sizeof(type) + sizeof(void *) - 1) & ~(sizeof(void *) - 1) )
226
227 typedef char * _PDCLIB_va_list;
228 #define _PDCLIB_va_arg( ap, type ) ( (ap) += (_PDCLIB_va_round(type)), ( *(type*) ( (ap) - (_PDCLIB_va_round(type)) ) ) )
229 #define _PDCLIB_va_copy( dest, src ) ( (dest) = (src), (void)0 )
230 #define _PDCLIB_va_end( ap ) ( (ap) = (void *)0, (void)0 )
231 #define _PDCLIB_va_start( ap, parmN ) ( (ap) = (char *) &parmN + ( _PDCLIB_va_round(parmN) ), (void)0 )
232
233 /* -------------------------------------------------------------------------- */
234 /* OS "glue", part 1                                                          */
235 /* These are values and data type definitions that you would have to adapt to */
236 /* the capabilities and requirements of your OS.                              */
237 /* The actual *functions* of the OS interface are declared in _PDCLIB_glue.h. */
238 /* -------------------------------------------------------------------------- */
239
240 /* Memory management -------------------------------------------------------- */
241
242 /* Set this to the page size of your OS. If your OS does not support paging, set
243    to an appropriate value. (Too small, and malloc() will call the kernel too
244    often. Too large, and you will waste memory.)
245 */
246 #define _PDCLIB_PAGESIZE 4096
247
248 /* Set this to the minimum memory node size. Any malloc() for a smaller size
249    will be satisfied by a malloc() of this size instead (to avoid excessive
250    fragmentation).
251 */
252 #define _PDCLIB_MINALLOC 8
253
254 /* I/O ---------------------------------------------------------------------- */
255
256 /* The type of the file descriptor returned by _PDCLIB_open(). */
257 typedef int _PDCLIB_fd_t;
258
259 /* The value (of type _PDCLIB_fd_t) returned by _PDCLIB_open() if the operation
260    failed.
261 */
262 #define _PDCLIB_NOHANDLE ( (_PDCLIB_fd_t) -1 )
263
264 /* The default size for file buffers. Must be at least 256. */
265 #define _PDCLIB_BUFSIZ 1024
266
267 /* The minimum number of files the implementation can open simultaneously. Must
268    be at least 8. Depends largely on how the bookkeeping is done by fopen() /
269    freopen() / fclose(). The example implementation limits the number of open
270    files only by available memory.
271 */
272 #define _PDCLIB_FOPEN_MAX 8
273
274 /* Length of the longest filename the implementation guarantees to support. */
275 #define _PDCLIB_FILENAME_MAX 128
276
277 /* Maximum length of filenames generated by tmpnam(). (See tmpfile.c.) */
278 #define _PDCLIB_L_tmpnam 46
279
280 /* Number of distinct file names that can be generated by tmpnam(). */
281 #define _PDCLIB_TMP_MAX 50
282
283 /* The values of SEEK_SET, SEEK_CUR and SEEK_END, used by fseek().
284    Since at least one platform (POSIX) uses the same symbols for its own "seek"
285    function, we use whatever the host defines (if it does define them).
286 */
287 #define _PDCLIB_SEEK_SET 0
288 #define _PDCLIB_SEEK_CUR 1
289 #define _PDCLIB_SEEK_END 2
290
291 /* The number of characters that can be buffered with ungetc(). The standard
292    guarantees only one (1); anything larger would make applications relying on
293    this capability dependent on implementation-defined behaviour (not good).
294 */
295 #define _PDCLIB_UNGETCBUFSIZE 1
296
297 /* errno -------------------------------------------------------------------- */
298
299 /* These are the values that _PDCLIB_errno can be set to by the library.
300
301    By keeping PDCLib's errno in the _PDCLIB_* namespace, the library is capable
302    to "translate" between errno values used by the hosting operating system and
303    those used and passed out by the library.
304
305    Example: In the example platform, the remove() function uses the unlink()
306    system call as backend. Linux sets its errno to EISDIR if you try to unlink()
307    a directory, but POSIX demands EPERM. Within the remove() function, you can
308    catch the 'errno == EISDIR', and set '_PDCLIB_errno = _PDCLIB_EPERM'. Anyone
309    using PDCLib's <errno.h> will "see" EPERM instead of EISDIR (the _PDCLIB_*
310    prefix removed by <errno.h> mechanics).
311
312    If you do not want that kind of translation, you might want to "match" the
313    values used by PDCLib with those used by the host OS, as to avoid confusion.
314
315    The standard only defines three distinct errno values: ERANGE, EDOM, and
316    EILSEQ. The standard leaves it up to "the implementation" whether there are
317    any more beyond those three. There is some controversy as to whether errno is
318    such a good idea at all, so you might want to come up with a different error
319    reporting facility for your platform. Since errno values beyond the three
320    defined by the standard are not portable anyway (unless you look at POSIX),
321    having your own error reporting facility would not hurt anybody either.
322 */
323 #define _PDCLIB_ERANGE 1
324 #define _PDCLIB_EDOM   2
325 #define _PDCLIB_EILSEQ 3
326
327 /* The following is not strictly "configuration", but there is no better place
328    to explain it than here.
329
330    PDCLib strives to be as generic as possible, so by default it does NOT define
331    any values beyond the three standard ones above, even where it would have
332    been prudent and convenient to do so. Any errno "caught" from the host OS,
333    and some internal error conditions as well, are all lumped together into the
334    value of '_PDCLIB_ERROR'.
335
336    '_PDCLIB_ERROR' is STRICLY meant as a PLACEHOLDER only.
337
338    You should NEVER ship an adaption of PDCLib still using that particular
339    value. You should NEVER write code that *tests* for that value. Indeed it is
340    not even conforming, since errno values should be defined as beginning with
341    an uppercase 'E', and there is no mechanics in <errno.h> to unmask that
342    particular value (for exactly that reason).
343
344    There also is no error message available for this value through either the
345    strerror() or perror() functions. It is being reported as "unknown" error.
346
347    The idea is that you scan the source of PDCLib for occurrences of this macro
348    and replace _PDCLIB_ERROR with whatever additional errno value you came up
349    with for your platform.
350
351    If you cannot find it within you to do that, tell your clients to check for
352    an errno value larger than zero. That, at least, would be standard compliant
353    (and fully portable).
354 */
355 #define _PDCLIB_ERROR  4
356