]> pd.if.org Git - pdclib/blobdiff - platform/example/internals/_PDCLIB_config.h
Preliminary signal handling.
[pdclib] / platform / example / internals / _PDCLIB_config.h
index 150161f18373a92e262765a1774bd8d68c1aa96e..0f0c21c7e5fc5ea02dacbb43a3a74ebc5a6c7cb0 100644 (file)
@@ -1,7 +1,5 @@
 /* $Id$ */
 
-/* Release $Name$ */
-
 /* Internal PDCLib configuration <_PDCLIB_config.h>
    (Generic Template)
 
@@ -94,6 +92,8 @@ struct _PDCLIB_lldiv_t
 /* SHRT, INT, LONG, or LLONG (telling which values to use for the *_MIN and   */
 /* *_MAX limits); the lowercase define either short, int, long, or long long  */
 /* (telling the actual type to use).                                          */
+/* The third define is the length modifier used for the type in printf() and  */
+/* scanf() functions (used in <inttypes.h>).                                  */
 /* If you require a non-standard datatype to define the "usually fastest"     */
 /* types, PDCLib as-is doesn't support that. Please contact the author with   */
 /* details on your platform in that case, so support can be added.            */
@@ -101,15 +101,19 @@ struct _PDCLIB_lldiv_t
 
 #define _PDCLIB_FAST8 INT
 #define _PDCLIB_fast8 int
+#define _PDCLIB_FAST8_CONV
 
 #define _PDCLIB_FAST16 INT
 #define _PDCLIB_fast16 int
+#define _PDCLIB_FAST16_CONV
 
 #define _PDCLIB_FAST32 INT
 #define _PDCLIB_fast32 int
+#define _PDCLIB_FAST32_CONV
 
 #define _PDCLIB_FAST64 LLONG
 #define _PDCLIB_fast64 long long
+#define _PDCLIB_FAST64_CONV ll
 
 /* -------------------------------------------------------------------------- */
 /* What follows are a couple of "special" typedefs and their limits. Again,   */
@@ -120,11 +124,13 @@ struct _PDCLIB_lldiv_t
 /* The result type of substracting two pointers */
 #define _PDCLIB_ptrdiff int
 #define _PDCLIB_PTRDIFF INT
+#define _PDCLIB_PTR_CONV
 
 /* 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.)
 */
+#define _PDCLIB_sig_atomic int
 #define _PDCLIB_SIG_ATOMIC INT
 
 /* Result type of the 'sizeof' operator (must be unsigned) */
@@ -142,10 +148,20 @@ struct _PDCLIB_lldiv_t
 
 /* Largest supported integer type. Implementation note: see _PDCLIB_atomax(). */
 #define _PDCLIB_intmax long long int
-#define _PDCLIB_INTMAX LLINT
+#define _PDCLIB_INTMAX LLONG
+#define _PDCLIB_MAX_CONV ll
 /* You are also required to state the literal suffix for the intmax type      */
 #define _PDCLIB_INTMAX_LITERAL ll
 
+/* <inttypes.h> defines imaxdiv(), which is equivalent to the div() function  */
+/* family (see further above) with intmax_t as basis.                         */
+
+struct _PDCLIB_imaxdiv_t
+{
+    _PDCLIB_intmax quot;
+    _PDCLIB_intmax rem;
+};
+
 /* -------------------------------------------------------------------------- */
 /* Floating Point                                                             */
 /* -------------------------------------------------------------------------- */
@@ -213,37 +229,95 @@ typedef char * _PDCLIB_va_list;
 /* The actual *functions* of the OS interface are declared in _PDCLIB_glue.h. */
 /* -------------------------------------------------------------------------- */
 
-/* Memory management */
+/* Memory management -------------------------------------------------------- */
 
 /* Set this to the page size of your OS. If your OS does not support paging, set
    to an appropriate value. (Too small, and malloc() will call the kernel too
-   often. Too large, and you will waste memory.
+   often. Too large, and you will waste memory.)
 */
 #define _PDCLIB_PAGESIZE 4096
 
-/* Set this to the minimum memory node size. Any malloc() for a smaller siz
-   will be satisfied by a malloc() of this size instead.
+/* Set this to the minimum memory node size. Any malloc() for a smaller size
+   will be satisfied by a malloc() of this size instead (to avoid excessive
+   fragmentation).
 */
 #define _PDCLIB_MINALLOC 8
 
-/* I/O */
+/* I/O ---------------------------------------------------------------------- */
 
-/* The unique file descriptor returned by _PDCLIB_open(). */
+/* The type of the file descriptor returned by _PDCLIB_open(). */
 typedef int _PDCLIB_fd_t;
 
-/* A type in which to store file offsets. See fgetpos() / fsetpos(). */
-typedef struct
-{
-    int position;
-    int parse_state;
-} _PDCLIB_fpos_t;
+/* The value (of type _PDCLIB_fd_t) returned by _PDCLIB_open() if the operation
+   failed.
+*/
+#define _PDCLIB_NOHANDLE ( (_PDCLIB_fd_t) -1 )
+
+/* The default size for file buffers. Must be at least 256. */
+#define _PDCLIB_BUFSIZ 1024
+
+/* The minimum number of files the implementation can open simultaneously. Must
+   be at least 8. Depends largely on how the bookkeeping is done by fopen() /
+   freopen() / fclose(). The example implementation limits the number of open
+   files only by available memory.
+*/
+#define _PDCLIB_FOPEN_MAX 8
+
+/* Length of the longest filename the implementation guarantees to support. */
+#define _PDCLIB_FILENAME_MAX 128
+
+/* Maximum length of filenames generated by tmpnam(). (See tmpfile.c.) */
+#define _PDCLIB_L_tmpnam 46
+
+/* Number of distinct file names that can be generated by tmpnam(). */
+#define _PDCLIB_TMP_MAX 50
+
+/* The values of SEEK_SET, SEEK_CUR and SEEK_END, used by fseek().
+   Since at least one platform (POSIX) uses the same symbols for its own "seek"
+   function, we use whatever the host defines (if it does define them).
+*/
+#define _PDCLIB_SEEK_SET 0
+#define _PDCLIB_SEEK_CUR 1
+#define _PDCLIB_SEEK_END 2
+
+/* The number of characters that can be buffered with ungetc(). The standard
+   guarantees only one (1); anything larger would make applications relying on
+   this capability dependent on implementation-defined behaviour (not good).
+*/
+#define _PDCLIB_UNGETCBUFSIZE 1
+
+/* Signals ------------------------------------------------------------------ */
+
+/* A word on signals, to the people using PDCLib in their OS projects.
+
+   The way they are defined by the C standard severely limits their usefulness,
+   to the point where a library implementation need not interface with the OS'
+   signals at all (which is what the PDCLib example implementation does).
+   (Other issues include, for example, that signal handlers are not re-entrant.)
+
+   Thus, it is strongly discouraged to try bolting on a signal handling infra-
+   structure onto <signal.h>. Since C's signal handling is so limited to begin
+   with, and code using it is pretty much non-portable anyway, it would be
+   smarter to keep <signal.h> in the barely functional state it is in, and
+   instead create a better, OS-specific API.
+
+   That being said, the below signals require to be defined to a positive int
+   value. I took what my Linux box defined them to; if you have to change them,
+   and what value to change them *to*, depends heavily on your environment and
+   what you are expecting <signal.h> to accomplish (see above).
+*/
+#define _PDCLIB_SIGABRT 6
+#define _PDCLIB_SIGFPE  8
+#define _PDCLIB_SIGILL  4
+#define _PDCLIB_SIGINT  2
+#define _PDCLIB_SIGSEGV 11
+#define _PDCLIB_SIGTERM 15
+
+/* The following should be defined to pointer values that could NEVER point to
+   a valid function. (They are used as special arguments to signal().) Again, I
+   took the values of my Linux box, which should be as good as any other value.
+*/
+#define _PDCLIB_SIG_DFL (void (*)( int ))0
+#define _PDCLIB_SIG_ERR (void (*)( int ))-1
+#define _PDCLIB_SIG_IGN (void (*)( int ))1
 
-/* The mode flags used in calls to _PDCLIB_open(). */
-enum _PDCLIB_iomode_e
-{
-    _PDCLIB_io_read     = 1,
-    _PDCLIB_io_write    = 2,
-    _PDCLIB_io_append   = 4,
-    _PDCLIB_io_create   = 8,
-    _PDCLIB_io_truncate = 16,
-};