]> pd.if.org Git - pdclib/blobdiff - platform/posix/internals/_PDCLIB_config.h
Corrected _PDCLIB_CHAR_SIGNED comment.
[pdclib] / platform / posix / internals / _PDCLIB_config.h
index 273f2d2f5997f55382880556406fa8a791bed0a3..3744a59b4decbd61144c822c366e5f8a4cba9cfe 100644 (file)
 /* specific platforms, e.g. by swapping int instead of char.                  */
 #define _PDCLIB_memswp( i, j, size ) char tmp; do { tmp = *i; *i++ = *j; *j++ = tmp; } while ( --size );
 
-/* The maximum value that errno can be set to. This is used to set the size   */
-/* of the array in struct lconv (<locale.h>) holding error messages for the   */
-/* strerror() and perror() functions. (If you change this value because you   */
-/* are using additional errno values, you *HAVE* to provide appropriate error */
-/* messages for *ALL* locales.)                                               */
-/* Default is 4 (0, ERANGE, EDOM, EILSEQ).                                    */
-#define _PDCLIB_ERRNO_MAX 4
-
 /* -------------------------------------------------------------------------- */
 /* Integers                                                                   */
 /* -------------------------------------------------------------------------- */
@@ -47,7 +39,7 @@
 /* first, before going to lengths about it.                                   */
 /* -------------------------------------------------------------------------- */
 
-/* Comment out (or delete) the line below if your 'char' type is unsigned.    */
+/* Set to 0 if your 'char' type is unsigned.                                  */
 #define _PDCLIB_CHAR_SIGNED 1
 
 /* Width of the integer types short, int, long, and long long, in bytes.      */
@@ -56,9 +48,9 @@
 #define _PDCLIB_SHRT_BYTES  2
 #define _PDCLIB_INT_BYTES   4
 #if defined(_LP64) || defined(__ILP64__)
-    #define _PDCLIB_LONG_BYTES 8
+#define _PDCLIB_LONG_BYTES 8
 #else
-    #define _PDCLIB_LONG_BYTES 4
+#define _PDCLIB_LONG_BYTES 4
 #endif
 #define _PDCLIB_LLONG_BYTES 8
 
@@ -121,9 +113,15 @@ struct _PDCLIB_lldiv_t
 #define _PDCLIB_fast32 int
 #define _PDCLIB_FAST32_CONV
 
+#ifdef __LP64__
+#define _PDCLIB_FAST64 LONG
+#define _PDCLIB_fast64 long
+#define _PDCLIB_FAST64_CONV l
+#else
 #define _PDCLIB_FAST64 LLONG
 #define _PDCLIB_fast64 long long
 #define _PDCLIB_FAST64_CONV ll
+#endif
 
 /* -------------------------------------------------------------------------- */
 /* What follows are a couple of "special" typedefs and their limits. Again,   */
@@ -131,11 +129,20 @@ struct _PDCLIB_lldiv_t
 /* defines here are merely "configuration". See above for details.            */
 /* -------------------------------------------------------------------------- */
 
-/* The result type of substracting two pointers */
+/* The types used for size_t and ptrdiff_t should not have an integer conversion
+   rank greater than that of signed long int unless the implementation supports
+   objects large enough to make this necessary.
+*/
+
+/* Result type of substracting two pointers (must be signed) */
 #define _PDCLIB_ptrdiff long
 #define _PDCLIB_PTRDIFF LONG
 #define _PDCLIB_PTR_CONV l
 
+/* Result type of the 'sizeof' operator (must be unsigned) */
+#define _PDCLIB_size unsigned long
+#define _PDCLIB_SIZE ULONG
+
 /* An integer type that can be accessed as atomic entity (think asynchronous
    interrupts). The type itself is not defined in a freestanding environment,
    but its limits are. (Don't ask.)
@@ -143,16 +150,37 @@ struct _PDCLIB_lldiv_t
 #define _PDCLIB_sig_atomic int
 #define _PDCLIB_SIG_ATOMIC INT
 
-/* Result type of the 'sizeof' operator (must be unsigned) */
-#define _PDCLIB_size unsigned long
-#define _PDCLIB_SIZE ULONG
+/* Object type whose alignment is as great as supported by implementation
+   in all contexts.
+*/
+#define _PDCLIB_max_align long double
 
-/* Large enough an integer to hold all character codes of the largest supported
-   locale.
+/* Integer type whose range of values can represent distinct codes for
+   all members of the largest extended character set specified among the
+   supported locales.
+   Note that the definition of this type must agree with the type used
+   by the compiler for L"" string and L'' character literals.
 */
-#define _PDCLIB_wint  int
+#if defined(_LP64) || defined(__ILP64__)
 #define _PDCLIB_wchar int
 #define _PDCLIB_WCHAR INT
+#else
+#define _PDCLIB_wchar long
+#define _PDCLIB_WCHAR LONG
+#endif
+
+/* Each member of the basic character set shall have a code value equal
+   to its value when used as the lone character in an integer character
+   constant. If that is not the case, uncomment the following line.
+#define __STDC_MB_MIGHT_NEQ_WC__
+*/
+
+/* Integer type unchanged by default argument promotions that can hold any
+   value corresponding to characters of the extended character set, as well
+   as at least one value that does not correspond to any member of the
+   extended character set (WEOF).
+*/
+#define _PDCLIB_wint  int
 
 #define _PDCLIB_intptr long
 #define _PDCLIB_INTPTR LONG
@@ -173,30 +201,30 @@ struct _PDCLIB_imaxdiv_t
     _PDCLIB_intmax rem;
 };
 
-/* <time.h>: time_t 
- * The C standard doesn't define what representation of time is stored in 
+/* <time.h>: time_t
+ * The C standard doesn't define what representation of time is stored in
  * time_t when returned by time() , but POSIX defines it to be seconds since the
- * UNIX epoch and most appplications expect that. 
+ * UNIX epoch and most appplications expect that.
  *
- * time_t is also used as the tv_sec member of struct timespec, which *is* 
+ * time_t is also used as the tv_sec member of struct timespec, which *is*
  * defined as a linear count of seconds.
  *
  * time_t is defined as a "real type", so may be a floating point type, but with
  * the presence of the nanosecond accurate struct timespec, and with the lack of
- * any functions for manipulating more accurate values of time_t, this is 
+ * any functions for manipulating more accurate values of time_t, this is
  * probably not useful.
  */
-#define _PDCLIB_time  long
+#define _PDCLIB_time long
 
 /* <time.h>: clock_t
  *
  * A count of "clock ticks", where the length of a clock tick is unspecified by
- * the standard. The implementation is required to provide a macro, 
+ * the standard. The implementation is required to provide a macro,
  * CLOCKS_PER_SEC, which is the number of "clock ticks" which corresponds to one
  * second.
  *
  * clock_t may be any real type (i.e. integral or floating), and its type on
- * various systems differs. 
+ * various systems differs.
  *
  * On XSI systems, CLOCKS_PER_SEC must be defined to 1000000
  */
@@ -207,8 +235,8 @@ struct _PDCLIB_imaxdiv_t
  *
  * The TIME_UTC parameter is passed to the timespec_get function in order to get
  * the system time in UTC since an implementation defined epoch (not necessarily
- * the same as that used for time_t). That said, on POSIX the obvious 
- * implementation of timespec_get for TIME_UTC is to wrap 
+ * the same as that used for time_t). That said, on POSIX the obvious
+ * implementation of timespec_get for TIME_UTC is to wrap
  * clock_gettime(CLOCK_REALTIME, ...), which is defined as time in UTC since the
  * same epoch.
  *
@@ -270,9 +298,9 @@ struct _PDCLIB_imaxdiv_t
    most compilers.
 */
 #ifdef __GNUC__
-  #define _PDCLIB_offsetof( type, member ) __builtin_offsetof( type, member )
+#define _PDCLIB_offsetof( type, member ) __builtin_offsetof( type, member )
 #else
-  #define _PDCLIB_offsetof( type, member ) ( (size_t) &( ( (type *) 0 )->member ) )
+#define _PDCLIB_offsetof( type, member ) ( (size_t) &( ( (type *) 0 )->member ) )
 #endif
 
 /* Variable Length Parameter List Handling (<stdarg.h>)
@@ -282,22 +310,21 @@ struct _PDCLIB_imaxdiv_t
 */
 
 #ifdef __GNUC__
-  typedef __builtin_va_list _PDCLIB_va_list;
-  #define _PDCLIB_va_arg( ap, type ) (__builtin_va_arg( (ap), type ))
-  #define _PDCLIB_va_copy( dest, src ) (__builtin_va_copy( (dest), (src) ))
-  #define _PDCLIB_va_end( ap ) (__builtin_va_end( ap ) )
-  #define _PDCLIB_va_start( ap, parmN ) (__builtin_va_start( (ap), (parmN) ))
+typedef __builtin_va_list _PDCLIB_va_list;
+#define _PDCLIB_va_arg( ap, type ) (__builtin_va_arg( (ap), type ))
+#define _PDCLIB_va_copy( dest, src ) (__builtin_va_copy( (dest), (src) ))
+#define _PDCLIB_va_end( ap ) (__builtin_va_end( ap ) )
+#define _PDCLIB_va_start( ap, parmN ) (__builtin_va_start( (ap), (parmN) ))
 #elif (defined(__i386__) || defined(__i386) || defined(_M_IX86)) && !(defined(__amd64__) || defined(__x86_64__) || defined(_M_AMD64))
-  /* Internal helper macro. va_round is not part of <stdarg.h>. */
-  #define _PDCLIB_va_round( type ) ( (sizeof(type) + sizeof(void *) - 1) & ~(sizeof(void *) - 1) )
-
-  typedef char * _PDCLIB_va_list;
-  #define _PDCLIB_va_arg( ap, type ) ( (ap) += (_PDCLIB_va_round(type)), ( *(type*) ( (ap) - (_PDCLIB_va_round(type)) ) ) )
-  #define _PDCLIB_va_copy( dest, src ) ( (dest) = (src), (void)0 )
-  #define _PDCLIB_va_end( ap ) ( (ap) = (void *)0, (void)0 )
-  #define _PDCLIB_va_start( ap, parmN ) ( (ap) = (char *) &parmN + ( _PDCLIB_va_round(parmN) ), (void)0 )
+/* Internal helper macro. va_round is not part of <stdarg.h>. */
+#define _PDCLIB_va_round( type ) ( (sizeof(type) + sizeof(void *) - 1) & ~(sizeof(void *) - 1) )
+typedef char * _PDCLIB_va_list;
+#define _PDCLIB_va_arg( ap, type ) ( (ap) += (_PDCLIB_va_round(type)), ( *(type*) ( (ap) - (_PDCLIB_va_round(type)) ) ) )
+#define _PDCLIB_va_copy( dest, src ) ( (dest) = (src), (void)0 )
+#define _PDCLIB_va_end( ap ) ( (ap) = (void *)0, (void)0 )
+#define _PDCLIB_va_start( ap, parmN ) ( (ap) = (char *) &parmN + ( _PDCLIB_va_round(parmN) ), (void)0 )
 #else
-  #error Compiler/Architecture support please
+#error Compiler/Architecture support please
 #endif
 
 /* -------------------------------------------------------------------------- */
@@ -324,9 +351,14 @@ struct _PDCLIB_imaxdiv_t
 
 /* Locale --------------------------------------------------------------------*/
 
-/* Locale method. See _PDCLIB_locale.h */
+/* Locale method. See _PDCLIB_locale.h. If undefined, POSIX per-thread locales
+   will be disabled.
+*/
 #define _PDCLIB_LOCALE_METHOD _PDCLIB_LOCALE_METHOD_TSS
 
+/* wchar_t encoding */
+#define _PDCLIB_WCHAR_ENCODING _PDCLIB_WCHAR_ENCODING_UCS4
+
 /* I/O ---------------------------------------------------------------------- */
 
 /* The default size for file buffers. Must be at least 256. */
@@ -362,4 +394,121 @@ struct _PDCLIB_imaxdiv_t
 */
 #define _PDCLIB_UNGETCBUFSIZE 1
 
+/* errno -------------------------------------------------------------------- */
+
+/* These are the values that _PDCLIB_errno can be set to by the library.
+
+   By keeping PDCLib's errno in the _PDCLIB_* namespace, the library is capable
+   to "translate" between errno values used by the hosting operating system and
+   those used and passed out by the library.
+
+   Example: In the example platform, the remove() function uses the unlink()
+   system call as backend. Linux sets its errno to EISDIR if you try to unlink()
+   a directory, but POSIX demands EPERM. Within the remove() function, you can
+   catch the 'errno == EISDIR', and set '_PDCLIB_errno = _PDCLIB_EPERM'. Anyone
+   using PDCLib's <errno.h> will "see" EPERM instead of EISDIR (the _PDCLIB_*
+   prefix removed by <errno.h> mechanics).
+
+   If you do not want that kind of translation, you might want to "match" the
+   values used by PDCLib with those used by the host OS, as to avoid confusion.
+
+   The C standard only defines three distinct errno values: ERANGE, EDOM, and
+   EILSEQ. The standard leaves it up to "the implementation" whether there are
+   any more beyond those three.
+
+   However, C++11 introduced the whole list of POSIX errno values into the
+   standard, so PDCLib might as well define those as well.
+
+   Sometimes the standard says to set errno to indicate an error, but does not
+   prescribe a value. We will use a value from the following list. If POSIX
+   defines a value, we use that; otherwise, we use as seems suitable.
+*/
+
+/* These values were taken from Linux, gcc 4.8. */
+#define _PDCLIB_E2BIG              7
+#define _PDCLIB_EACCES            13
+#define _PDCLIB_EADDRINUSE        98
+#define _PDCLIB_EADDRNOTAVAIL     99
+#define _PDCLIB_EAFNOSUPPORT      97
+#define _PDCLIB_EAGAIN            11
+#define _PDCLIB_EALREADY         114
+#define _PDCLIB_EBADF              9
+#define _PDCLIB_EBADMSG           74
+#define _PDCLIB_EBUSY             16
+#define _PDCLIB_ECANCELED        125
+#define _PDCLIB_ECHILD            10
+#define _PDCLIB_ECONNABORTED     103
+#define _PDCLIB_ECONNREFUSED     111
+#define _PDCLIB_ECONNRESET       104
+#define _PDCLIB_EDEADLK           35
+#define _PDCLIB_EDESTADDRREQ      89
+#define _PDCLIB_EDOM              33
+#define _PDCLIB_EEXIST            17
+#define _PDCLIB_EFAULT            14
+#define _PDCLIB_EFBIG             27
+#define _PDCLIB_EHOSTUNREACH     113
+#define _PDCLIB_EIDRM             43
+#define _PDCLIB_EILSEQ            84
+#define _PDCLIB_EINPROGRESS      115
+#define _PDCLIB_EINTR              4
+#define _PDCLIB_EINVAL            22
+#define _PDCLIB_EIO                5
+#define _PDCLIB_EISCONN          106
+#define _PDCLIB_EISDIR            21
+#define _PDCLIB_ELOOP             40
+#define _PDCLIB_EMFILE            24
+#define _PDCLIB_EMLINK            31
+#define _PDCLIB_EMSGSIZE          90
+#define _PDCLIB_ENAMETOOLONG      36
+#define _PDCLIB_ENETDOWN         100
+#define _PDCLIB_ENETRESET        102
+#define _PDCLIB_ENETUNREACH      101
+#define _PDCLIB_ENFILE            23
+#define _PDCLIB_ENOBUFS          105
+#define _PDCLIB_ENODATA           61
+#define _PDCLIB_ENODEV            19
+#define _PDCLIB_ENOENT             2
+#define _PDCLIB_ENOEXEC            8
+#define _PDCLIB_ENOLCK            37
+#define _PDCLIB_ENOLINK           67
+#define _PDCLIB_ENOMEM            12
+#define _PDCLIB_ENOMSG            42
+#define _PDCLIB_ENOPROTOOPT       92
+#define _PDCLIB_ENOSPC            28
+#define _PDCLIB_ENOSR             63
+#define _PDCLIB_ENOSTR            60
+#define _PDCLIB_ENOSYS            38
+#define _PDCLIB_ENOTCONN         107
+#define _PDCLIB_ENOTDIR           20
+#define _PDCLIB_ENOTEMPTY         39
+#define _PDCLIB_ENOTRECOVERABLE  131
+#define _PDCLIB_ENOTSOCK          88
+#define _PDCLIB_ENOTSUP           95
+#define _PDCLIB_ENOTTY            25
+#define _PDCLIB_ENXIO              6
+#define _PDCLIB_EOPNOTSUPP        95
+#define _PDCLIB_EOVERFLOW         75
+#define _PDCLIB_EOWNERDEAD       130
+#define _PDCLIB_EPERM              1
+#define _PDCLIB_EPIPE             32
+#define _PDCLIB_EPROTO            71
+#define _PDCLIB_EPROTONOSUPPORT   93
+#define _PDCLIB_EPROTOTYPE        91
+#define _PDCLIB_ERANGE            34
+#define _PDCLIB_EROFS             30
+#define _PDCLIB_ESPIPE            29
+#define _PDCLIB_ESRCH              3
+#define _PDCLIB_ETIME             62
+#define _PDCLIB_ETIMEDOUT        110
+#define _PDCLIB_ETXTBSY           26
+#define _PDCLIB_EWOULDBLOCK       11
+#define _PDCLIB_EXDEV             18
+
+/* This is used to set the size of the array in struct lconv (<locale.h>)     */
+/* holding the error messages for the strerror() and perror() fuctions. If    */
+/* you change this value because you are using additional errno values, you   */
+/* *HAVE* to provide appropriate error messages for *ALL* locales.            */
+/* Needs to be one higher than the highest errno value above.                 */
+#define _PDCLIB_ERRNO_MAX 132
+
 #endif