]> pd.if.org Git - pdclib/blobdiff - platform/example/internals/_PDCLIB_config.h
Intermediate work, checked in for safekeeping as I pick up working on this again.
[pdclib] / platform / example / internals / _PDCLIB_config.h
index 41fe02cb3f62711e2ee40b482ef3adc66f3137f7..0df16791cd26f98afbd8f5c53343585d73a2295a 100644 (file)
@@ -1,7 +1,5 @@
 /* $Id$ */
 
-/* Release $Name$ */
-
 /* Internal PDCLib configuration <_PDCLIB_config.h>
    (Generic Template)
 
 /* Misc                                                                       */
 /* -------------------------------------------------------------------------- */
 
+/* By default, PDCLib does some rather strict checking of function usage,     */
+/* especially in <stdio.h>. Things that are undefined by the standard - for   */
+/* example, mixing byte / wide operations or read / write operations without  */
+/* resetting the stream beforehand - are caught and handled graciously. This  */
+/* adds some complexity, and eats a couple of clock cycles. If you want to    */
+/* disable these checks, define _PDCLIB_STRICT to zero.                       */
+#define _PDCLIB_STRICT 1
+
 /* The character (sequence) your platform uses as newline.                    */
 #define _PDCLIB_endl "\n"
 
 /* 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 );
 
+/* Define this to some compiler directive that can be written after the       */
+/* parameter list of a function declaration to indicate the function does     */
+/* never return. If your compiler does not support such a directive, define   */
+/* to nothing. (This is to avoid warnings with the exit functions under GCC.) */
+#define _PDCLIB_NORETURN __attribute__(( noreturn ))
+
 /* -------------------------------------------------------------------------- */
 /* Integers                                                                   */
 /* -------------------------------------------------------------------------- */
@@ -119,6 +131,7 @@ struct _PDCLIB_lldiv_t
    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) */
@@ -201,31 +214,70 @@ typedef char * _PDCLIB_va_list;
 #define _PDCLIB_va_start( ap, parmN ) ( (ap) = (char *) &parmN + ( _PDCLIB_va_round(parmN) ), (void)0 )
 
 /* -------------------------------------------------------------------------- */
-/* OS "glue"                                                                  */
-/* This is where PDCLib interfaces with the operating system. The examples    */
-/* below are POSIX calls; provide your OS' equivalents.                       */
+/* OS "glue", part 1                                                          */
+/* These are values and data type definitions that you would have to adapt to */
+/* the capabilities and requirements of your OS.                              */
+/* The actual *functions* of the OS interface are declared in _PDCLIB_glue.h. */
 /* -------------------------------------------------------------------------- */
 
-/* A system call that terminates the calling process */
-void _exit( int status ) __attribute__(( noreturn ));
-#define _PDCLIB_Exit( x ) _exit( x )
-
-/* 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
 
-/* Request another x pages (of size _PDCLIB_PAGESIZE) of memory from the kernel,
-   or release them back to the kernel if n is negative.
-   Return a (void *) pointing to the former end-of-heap if successful, NULL
-   otherwise.
+/* I/O ---------------------------------------------------------------------- */
+
+/* The type of the file descriptor returned by _PDCLIB_open(). */
+typedef int _PDCLIB_fd_t;
+
+/* The value (of type _PDCLIB_fd_t) returned by _PDCLIB_open() if the operation
+   failed.
+*/
+#define _PDCLIB_NOHANDLE ( (_PDCLIB_fd_t) -1 )
+
+/* A type in which to store file offsets. See fgetpos() / fsetpos(). */
+/* FIXME: The 'int' types here are placeholders. When changed, check out
+   stdinit.c, too. */
+typedef struct
+{
+    int position;
+    int mbstate;
+} _PDCLIB_fpos_t;
+
+/* 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().
 */
-void * _PDCLIB_allocpages( int n );
+#define _PDCLIB_FOPEN_MAX 8
+
+/* Length of the longest filename the implementation guarantees to support. */
+#define _PDCLIB_FILENAME_MAX 128
+
+/* Buffer size for tmpnam(). */
+#define _PDCLIB_L_tmpnam 100
+
+/* Number of distinct file names that can be generated by tmpnam(). */
+#define _PDCLIB_TMP_MAX 50
+
+/* The number of times fflush() tries to write a file buffer before giving up
+   if no characters can be written.
+*/
+#define _PDCLIB_FLUSH_RETRIES 3
+/* This macro is executed after each try to write characters that results in
+   no characters being written. You can define this to be empty, wait a short
+   period of time, or whatever suits your environment.
+*/
+#define _PDCLIB_FLUSH_RETRY_PREP
+