Added exit return codes.

[pdclib] / internals / _PDCLIB_config.h

diff --git a/internals/_PDCLIB_config.h b/internals/_PDCLIB_config.h
index 74eb290286d8178ca66e6cbb5b0db8fc1af7e286..753080ba25cee8780f50c90f8d59f0cd9c0ac56d 100644 (file)
--- a/internals/_PDCLIB_config.h
+++ b/internals/_PDCLIB_config.h
@@ -16,6 +16,13 @@
 /* The character (sequence) your platform uses as newline.                    */
 #define _PDCLIB_endl "\n"
 
+/* exit() can signal success to the host environment by the value of zero or  */
+/* the constant EXIT_SUCCESS. Failure is signaled by EXIT_FAILURE. Note that  */
+/* any other return value is "implementation-defined", i.e. your environment  */
+/* is not required to handle it gracefully. Set your definitions here.        */
+#define _PDCLIB_SUCCESS 0
+#define _PDCLIB_FAILURE -1
+
 /* -------------------------------------------------------------------------- */
 /* Integers                                                                   */
 /* -------------------------------------------------------------------------- */
@@ -39,6 +46,30 @@
 #define _PDCLIB_LONG_BYTES  4
 #define _PDCLIB_LLONG_BYTES 8
 
+/* <stdlib.h> defines the div() function family that allows taking quotient   */
+/* and remainder of an integer division in one operation. Many platforms      */
+/* support this in hardware / opcode, and the standard permits ordering of    */
+/* the return structure in any way to fit the hardware. That is why those     */
+/* structs can be configured here.                                            */
+
+struct _PDCLIB_div_t
+{
+    int quot;
+    int rem;
+};
+
+struct _PDCLIB_ldiv_t
+{
+    long int quot;
+    long int rem;
+};
+
+struct _PDCLIB_lldiv_t
+{
+    long long int quot;
+    long long int rem;
+};
+
 /* -------------------------------------------------------------------------- */
 /* <stdint.h> defines a set of integer types that are of a minimum width, and */
 /* "usually fastest" on the system. (If, for example, accessing a single char */
@@ -98,6 +129,7 @@
 #define _PDCLIB_intptr int
 #define _PDCLIB_INTPTR INT
 
+/* Largest supported integer type. Implementation note: see _PDCLIB_atomax(). */
 #define _PDCLIB_intmax long long int
 #define _PDCLIB_INTMAX LLINT
 /* You are also required to state the literal suffix for the intmax type      */