]> pd.if.org Git - pdclib.old/blob - platform/example/internals/_PDCLIB_config.h
Add newline translationwq
[pdclib.old] / platform / example / internals / _PDCLIB_config.h
1 #ifndef _PDCLIB_CONFIG_H
2 #define _PDCLIB_CONFIG_H
3
4 /* Internal PDCLib configuration <_PDCLIB_config.h>
5    (Generic Template)
6
7    This file is part of the Public Domain C Library (PDCLib).
8    Permission is granted to use, modify, and / or redistribute at will.
9 */
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 /* The maximum value that errno can be set to. This is used to set the size   */
31 /* of the array in struct lconv (<locale.h>) holding error messages for the   */
32 /* strerror() and perror() functions. (If you change this value because you   */
33 /* are using additional errno values, you *HAVE* to provide appropriate error */
34 /* messages for *ALL* locales.)                                               */
35 /* Default is 4 (0, ERANGE, EDOM, EILSEQ).                                    */
36 #define _PDCLIB_ERRNO_MAX 4
37
38 /* -------------------------------------------------------------------------- */
39 /* Integers                                                                   */
40 /* -------------------------------------------------------------------------- */
41 /* Assuming 8-bit char, two's-complement architecture here. 'short' being     */
42 /* 16 bit, 'int' being either 16, 32 or 64 bit, 'long' being either 32 or 64  */
43 /* bit (but 64 bit only if 'int' is 32 bit), and 'long long' being 64 bit if  */
44 /* 'long' is not, 64 or 128 bit otherwise.                                    */
45 /* Author is quite willing to support other systems but would like to hear of */
46 /* interest in such support and details on the to-be-supported architecture   */
47 /* first, before going to lengths about it.                                   */
48 /* -------------------------------------------------------------------------- */
49
50 /* Comment out (or delete) the line below if your 'char' type is unsigned.    */
51 #define _PDCLIB_CHAR_SIGNED 1
52
53 /* Width of the integer types short, int, long, and long long, in bytes.      */
54 /* SHRT == 2, INT >= SHRT, LONG >= INT >= 4, LLONG >= LONG - check your       */
55 /* compiler manuals.                                                          */
56 #define _PDCLIB_SHRT_BYTES  2
57 #define _PDCLIB_INT_BYTES   4
58 #if defined(__LP64__) || defined(_LP64)
59 #  define _PDCLIB_LONG_BYTES 8
60 #else
61 #  define _PDCLIB_LONG_BYTES  4
62 #endif
63 #define _PDCLIB_LLONG_BYTES 8
64
65 /* <stdlib.h> defines the div() function family that allows taking quotient   */
66 /* and remainder of an integer division in one operation. Many platforms      */
67 /* support this in hardware / opcode, and the standard permits ordering of    */
68 /* the return structure in any way to fit the hardware. That is why those     */
69 /* structs can be configured here.                                            */
70
71 struct _PDCLIB_div_t
72 {
73     int quot;
74     int rem;
75 };
76
77 struct _PDCLIB_ldiv_t
78 {
79     long int quot;
80     long int rem;
81 };
82
83 struct _PDCLIB_lldiv_t
84 {
85     long long int quot;
86     long long int rem;
87 };
88
89 /* -------------------------------------------------------------------------- */
90 /* <stdint.h> defines a set of integer types that are of a minimum width, and */
91 /* "usually fastest" on the system. (If, for example, accessing a single char */
92 /* requires the CPU to access a complete int and then mask out the char, the  */
93 /* "usually fastest" type of at least 8 bits would be int, not char.)         */
94 /* If you do not have information on the relative performance of the types,   */
95 /* the standard allows you to define any type that meets minimum width and    */
96 /* signedness requirements.                                                   */
97 /* The defines below are just configuration for the real typedefs and limit   */
98 /* definitions done in <_PDCLIB_int.h>. The uppercase define shall be either  */
99 /* SHRT, INT, LONG, or LLONG (telling which values to use for the *_MIN and   */
100 /* *_MAX limits); the lowercase define either short, int, long, or long long  */
101 /* (telling the actual type to use).                                          */
102 /* The third define is the length modifier used for the type in printf() and  */
103 /* scanf() functions (used in <inttypes.h>).                                  */
104 /* If you require a non-standard datatype to define the "usually fastest"     */
105 /* types, PDCLib as-is doesn't support that. Please contact the author with   */
106 /* details on your platform in that case, so support can be added.            */
107 /* -------------------------------------------------------------------------- */
108
109 #define _PDCLIB_FAST8 INT
110 #define _PDCLIB_fast8 int
111 #define _PDCLIB_FAST8_CONV
112
113 #define _PDCLIB_FAST16 INT
114 #define _PDCLIB_fast16 int
115 #define _PDCLIB_FAST16_CONV
116
117 #define _PDCLIB_FAST32 INT
118 #define _PDCLIB_fast32 int
119 #define _PDCLIB_FAST32_CONV
120
121 #define _PDCLIB_FAST64 LLONG
122 #define _PDCLIB_fast64 long long
123 #define _PDCLIB_FAST64_CONV ll
124
125 /* -------------------------------------------------------------------------- */
126 /* What follows are a couple of "special" typedefs and their limits. Again,   */
127 /* the actual definition of the limits is done in <_PDCLIB_int.h>, and the    */
128 /* defines here are merely "configuration". See above for details.            */
129 /* -------------------------------------------------------------------------- */
130
131 /* The result type of substracting two pointers */
132 #define _PDCLIB_ptrdiff long
133 #define _PDCLIB_PTRDIFF LONG
134 #define _PDCLIB_PTR_CONV
135
136 /* An integer type that can be accessed as atomic entity (think asynchronous
137    interrupts). The type itself is not defined in a freestanding environment,
138    but its limits are. (Don't ask.)
139 */
140 #define _PDCLIB_sig_atomic int
141 #define _PDCLIB_SIG_ATOMIC INT
142
143 /* Result type of the 'sizeof' operator (must be unsigned) */
144 #define _PDCLIB_size unsigned long
145 #define _PDCLIB_SIZE ULONG
146
147 /* Large enough an integer to hold all character codes of the largest supported
148    locale.
149 */
150 #define _PDCLIB_wint  signed int
151 #define _PDCLIB_wchar unsigned int
152 #define _PDCLIB_WCHAR UINT
153
154 #define _PDCLIB_intptr long
155 #define _PDCLIB_INTPTR LONG
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 /* <time.h>: time_t 
174  * The C standard doesn't define what representation of time is stored in 
175  * time_t when returned by time() , but POSIX defines it to be seconds since the
176  * UNIX epoch and most appplications expect that. 
177  *
178  * time_t is also used as the tv_sec member of struct timespec, which *is* 
179  * defined as a linear count of seconds.
180  *
181  * time_t is defined as a "real type", so may be a floating point type, but with
182  * the presence of the nanosecond accurate struct timespec, and with the lack of
183  * any functions for manipulating more accurate values of time_t, this is 
184  * probably not useful.
185  */
186 #define _PDCLIB_time  unsigned long long
187
188 /* <time.h>: clock_t
189  *
190  * A count of "clock ticks", where the length of a clock tick is unspecified by
191  * the standard. The implementation is required to provide a macro, 
192  * CLOCKS_PER_SEC, which is the number of "clock ticks" which corresponds to one
193  * second.
194  *
195  * clock_t may be any real type (i.e. integral or floating), and its type on
196  * various systems differs. 
197  *
198  * On XSI systems, CLOCKS_PER_SEC must be defined to 1000000
199  */
200 #define _PDCLIB_clock double
201 #define _PDCLIB_CLOCKS_PER_SEC 1000000
202
203 /* <time.h>: TIME_UTC
204  *
205  * The TIME_UTC parameter is passed to the timespec_get function in order to get
206  * the system time in UTC since an implementation defined epoch (not necessarily
207  * the same as that used for time_t). That said, on POSIX the obvious 
208  * implementation of timespec_get for TIME_UTC is to wrap 
209  * clock_gettime(CLOCK_REALTIME, ...), which is defined as time in UTC since the
210  * same epoch.
211  *
212  * This may be any non-zero integer value.
213  */
214 #define _PDCLIB_TIME_UTC 1
215
216 /* -------------------------------------------------------------------------- */
217 /* Floating Point                                                             */
218 /* -------------------------------------------------------------------------- */
219
220 /* Whether the implementation rounds toward zero (0), to nearest (1), toward
221    positive infinity (2), or toward negative infinity (3). (-1) signifies
222    indeterminable rounding, any other value implementation-specific rounding.
223 */
224 #define _PDCLIB_FLT_ROUNDS -1
225
226 /* Whether the implementation uses exact-width precision (0), promotes float
227    to double (1), or promotes float and double to long double (2). (-1)
228    signifies indeterminable behaviour, any other value implementation-specific
229    behaviour.
230 */
231 #define _PDCLIB_FLT_EVAL_METHOD -1
232
233 /* "Number of the decimal digits (n), such that any floating-point number in the
234    widest supported floating type with p(max) radix (b) digits can be rounded to
235    a floating-point number with (n) decimal digits and back again without change
236    to the value p(max) log(10)b if (b) is a power of 10, [1 + p(max) log(10)b]
237    otherwise."
238    64bit IEC 60559 double format (53bit mantissa) is DECIMAL_DIG 17.
239    80bit IEC 60559 double-extended format (64bit mantissa) is DECIMAL_DIG 21.
240 */
241 #define _PDCLIB_DECIMAL_DIG 17
242
243 /* Floating point types
244  *
245  * PDCLib (at present) assumes IEEE 754 floating point formats
246  * The following names are used:
247  *    SINGLE:   IEEE 754 single precision (32-bit)
248  *    DOUBLE:   IEEE 754 double precision (64-bit)
249  *    EXTENDED: IEEE 754 extended precision (80-bit, as x87)
250  */
251 #define _PDCLIB_FLOAT_TYPE   SINGLE
252 #define _PDCLIB_DOUBLE_TYPE  DOUBLE
253 #if defined(__i386__) || defined(__amd64__)
254   #define _PDCLIB_LDOUBLE_TYPE EXTENDED
255 #else
256   #define _PDCLIB_LDOUBLE_TYPE DOUBLE
257 #endif
258
259 /* -------------------------------------------------------------------------- */
260 /* Platform-dependent macros defined by the standard headers.                 */
261 /* -------------------------------------------------------------------------- */
262
263 /* The offsetof macro
264    Contract: Expand to an integer constant expression of type size_t, which
265    represents the offset in bytes to the structure member from the beginning
266    of the structure. If the specified member is a bitfield, behaviour is
267    undefined.
268    There is no standard-compliant way to do this.
269    This implementation casts an integer zero to 'pointer to type', and then
270    takes the address of member. This is undefined behaviour but should work on
271    most compilers.
272 */
273 #define _PDCLIB_offsetof( type, member ) ( (size_t) &( ( (type *) 0 )->member ) )
274
275 /* Variable Length Parameter List Handling (<stdarg.h>)
276    The macros defined by <stdarg.h> are highly dependent on the calling
277    conventions used, and you probably have to replace them with builtins of
278    your compiler. The following generic implementation works only for pure
279    stack-based architectures, and only if arguments are aligned to pointer
280    type. Credits to Michael Moody, who contributed this to the Public Domain.
281 */
282
283 /* Internal helper macro. va_round is not part of <stdarg.h>. */
284 #define _PDCLIB_va_round( type ) ( (sizeof(type) + sizeof(void *) - 1) & ~(sizeof(void *) - 1) )
285
286 typedef char * _PDCLIB_va_list;
287 #define _PDCLIB_va_arg( ap, type ) ( (ap) += (_PDCLIB_va_round(type)), ( *(type*) ( (ap) - (_PDCLIB_va_round(type)) ) ) )
288 #define _PDCLIB_va_copy( dest, src ) ( (dest) = (src), (void)0 )
289 #define _PDCLIB_va_end( ap ) ( (ap) = (void *)0, (void)0 )
290 #define _PDCLIB_va_start( ap, parmN ) ( (ap) = (char *) &parmN + ( _PDCLIB_va_round(parmN) ), (void)0 )
291
292 /* -------------------------------------------------------------------------- */
293 /* OS "glue", part 1                                                          */
294 /* These are values and data type definitions that you would have to adapt to */
295 /* the capabilities and requirements of your OS.                              */
296 /* The actual *functions* of the OS interface are declared in _PDCLIB_glue.h. */
297 /* -------------------------------------------------------------------------- */
298
299 /* Memory management -------------------------------------------------------- */
300
301 /* Set this to the page size of your OS. If your OS does not support paging, set
302    to an appropriate value. (Too small, and malloc() will call the kernel too
303    often. Too large, and you will waste memory.)
304 */
305 #define _PDCLIB_MALLOC_PAGESIZE 4096
306 #define _PDCLIB_MALLOC_ALIGN 16
307 #define _PDCLIB_MALLOC_GRANULARITY 64*1024
308 #define _PDCLIB_MALLOC_TRIM_THRESHOLD 2*1024*1024
309 #define _PDCLIB_MALLOC_MMAP_THRESHOLD 256*1024
310 #define _PDCLIB_MALLOC_RELEASE_CHECK_RATE 4095
311
312 /* TODO: Better document these */
313
314 /* Locale --------------------------------------------------------------------*/
315
316 /* Locale method. See _PDCLIB_locale.h */
317 /* #define _PDCLIB_LOCALE_METHOD _PDCLIB_LOCALE_METHOD_TSS */
318
319 /* wchar_t encoding */
320 #define _PDCLIB_WCHAR_ENCODING _PDCLIB_WCHAR_ENCODING_UCS4
321
322 /* I/O ---------------------------------------------------------------------- */
323
324 /* The default size for file buffers. Must be at least 256. */
325 #define _PDCLIB_BUFSIZ 1024
326
327 /* The minimum number of files the implementation can open simultaneously. Must
328    be at least 8. Depends largely on how the bookkeeping is done by fopen() /
329    freopen() / fclose(). The example implementation limits the number of open
330    files only by available memory.
331 */
332 #define _PDCLIB_FOPEN_MAX 8
333
334 /* Length of the longest filename the implementation guarantees to support. */
335 #define _PDCLIB_FILENAME_MAX 128
336
337 /* Maximum length of filenames generated by tmpnam(). (See tmpfile.c.) */
338 #define _PDCLIB_L_tmpnam 46
339
340 /* Number of distinct file names that can be generated by tmpnam(). */
341 #define _PDCLIB_TMP_MAX 50
342
343 /* The values of SEEK_SET, SEEK_CUR and SEEK_END, used by fseek().
344    Since at least one platform (POSIX) uses the same symbols for its own "seek"
345    function, we use whatever the host defines (if it does define them).
346 */
347 #define _PDCLIB_SEEK_SET 0
348 #define _PDCLIB_SEEK_CUR 1
349 #define _PDCLIB_SEEK_END 2
350
351 /* The number of characters that can be buffered with ungetc(). The standard
352    guarantees only one (1); anything larger would make applications relying on
353    this capability dependent on implementation-defined behaviour (not good).
354 */
355 #define _PDCLIB_UNGETCBUFSIZE 1
356
357 /* errno -------------------------------------------------------------------- */
358
359 /* These are the values that _PDCLIB_errno can be set to by the library.
360
361    By keeping PDCLib's errno in the _PDCLIB_* namespace, the library is capable
362    to "translate" between errno values used by the hosting operating system and
363    those used and passed out by the library.
364
365    Example: In the example platform, the remove() function uses the unlink()
366    system call as backend. Linux sets its errno to EISDIR if you try to unlink()
367    a directory, but POSIX demands EPERM. Within the remove() function, you can
368    catch the 'errno == EISDIR', and set '_PDCLIB_errno = _PDCLIB_EPERM'. Anyone
369    using PDCLib's <errno.h> will "see" EPERM instead of EISDIR (the _PDCLIB_*
370    prefix removed by <errno.h> mechanics).
371
372    If you do not want that kind of translation, you might want to "match" the
373    values used by PDCLib with those used by the host OS, as to avoid confusion.
374
375    The C standard only defines three distinct errno values: ERANGE, EDOM, and
376    EILSEQ. The standard leaves it up to "the implementation" whether there are
377    any more beyond those three. There is some controversy as to whether errno is
378    such a good idea at all, so you might want to come up with a different error
379    reporting facility for your platform. 
380
381    Things used to say "Since errno values beyond the three defined by the 
382    standard are not portable anyway (unless you look at POSIX), having your own
383    error reporting facility would not hurt anybody either." at this point. 
384    However, then somebody birthed C++11 into the world, which copied POSIX's 
385    errno values into C++. Yes, even EINTR. Therefore, this library defines 
386    them. That said, thats nothing stopping you from using your own error 
387    reporting facility for things outside the C library.
388
389    Sometimes the standard says to set errno to indicate an error, but does not 
390    prescribe a value. We will use a value from the following list. If POSIX 
391    defines a value, we use that; otherwise, we use as seems suitable.
392
393    If porting to a system which uses an errno-like reporting system (e.g. a 
394    UNIX), you'll probably want to define them to match what the OS uses
395 */
396 /* C errno values */
397 #define _PDCLIB_ERANGE 1
398 #define _PDCLIB_EDOM   2
399 #define _PDCLIB_EILSEQ 3
400
401 /* C++11/POSIX errno values */
402 #define _PDCLIB_E2BIG 4
403 #define _PDCLIB_ECONNRESET 5
404 #define _PDCLIB_EISCONN 6
405 #define _PDCLIB_ENOENT 7
406 #define _PDCLIB_ENOTRECOVERABLE 8
407 #define _PDCLIB_EROFS 9
408 #define _PDCLIB_EACCES 10
409 #define _PDCLIB_EDEADLK 11
410 #define _PDCLIB_EISDIR 12
411 #define _PDCLIB_ENOEXEC 13
412 #define _PDCLIB_ENOTSOCK 14
413 #define _PDCLIB_ESPIPE 15
414 #define _PDCLIB_EADDRINUSE 16
415 #define _PDCLIB_EDESTADDRREQ 17
416 #define _PDCLIB_ELOOP 18
417 #define _PDCLIB_ENOLCK 19
418 #define _PDCLIB_ENOTSUPP 20
419 #define _PDCLIB_ESRCH 21
420 #define _PDCLIB_EADDRNOTAVAIL 22
421 #define _PDCLIB_EMFILE 23
422 #define _PDCLIB_ENOLINK 24
423 #define _PDCLIB_ENOTTY 25
424 #define _PDCLIB_ETIME 26
425 #define _PDCLIB_EAFNOSUPPORT 27
426 #define _PDCLIB_EEXIST 28
427 #define _PDCLIB_EMLINK 29
428 #define _PDCLIB_ENOMEM 30
429 #define _PDCLIB_ENXIO 31
430 #define _PDCLIB_ETIMEDOUT 32
431 #define _PDCLIB_EAGAIN 33
432 #define _PDCLIB_EFAULT 34
433 #define _PDCLIB_EMSGSIZE 35
434 #define _PDCLIB_ENOMSG 36
435 #define _PDCLIB_EOPNOTSUPP 37
436 #define _PDCLIB_ETXTBSY 38
437 #define _PDCLIB_EALREADY 39
438 #define _PDCLIB_EFBIG 40
439 #define _PDCLIB_ENAMETOOLONG 41
440 #define _PDCLIB_ENOPROTOOPT 42
441 #define _PDCLIB_EOVERFLOW 43
442 #define _PDCLIB_EWOULDBLOCK _PDCLIB_EAGAIN
443 #define _PDCLIB_EBADF 44
444 #define _PDCLIB_EHOSTUNREACH 45
445 #define _PDCLIB_ENETDOWN 46
446 #define _PDCLIB_ENOSPC 47
447 #define _PDCLIB_EOWNERDEAD 48
448 #define _PDCLIB_EXDEV 49
449 #define _PDCLIB_EBADMSG 50
450 #define _PDCLIB_EIDRM 51
451 #define _PDCLIB_ENETRESET 52
452 #define _PDCLIB_ENOSR 53
453 #define _PDCLIB_EPERM 54
454 #define _PDCLIB_EBUSY 55
455 #define _PDCLIB_ENETUNREACH 56
456 #define _PDCLIB_ENOSTR 57
457 #define _PDCLIB_EPIPE 58
458 #define _PDCLIB_ECANCELED 59
459 #define _PDCLIB_EINPROGRESS 60
460 #define _PDCLIB_ENFILE 61
461 #define _PDCLIB_ENOSYS 62
462 #define _PDCLIB_EPROTO 63
463 #define _PDCLIB_ECHILD 64
464 #define _PDCLIB_EINTR 65
465 #define _PDCLIB_ENOBUFS 66
466 #define _PDCLIB_ENOTCONN 67
467 #define _PDCLIB_EPROTONOSUPPORT 68
468 #define _PDCLIB_ECONNABORTED 69
469 #define _PDCLIB_EINVAL 70
470 #define _PDCLIB_ENODATA 71
471 #define _PDCLIB_ENOTDIR 72
472 #define _PDCLIB_EPROTOTYPE 73
473
474 #endif