pd.if.org Git - pdclib/blob - includes/stdlib.h

   1 /* General utilities <stdlib.h>
   2
   3    This file is part of the Public Domain C Library (PDCLib).
   4    Permission is granted to use, modify, and / or redistribute at will.
   5 */
   6
   7 #ifndef _PDCLIB_STDLIB_H
   8 #define _PDCLIB_STDLIB_H _PDCLIB_STDLIB_H
   9 #include <_PDCLIB_int.h>
  10
  11 #ifdef __cplusplus
  12 extern "C" {
  13 #endif
  14
  15 #ifndef _PDCLIB_SIZE_T_DEFINED
  16 #define _PDCLIB_SIZE_T_DEFINED _PDCLIB_SIZE_T_DEFINED
  17 typedef _PDCLIB_size_t size_t;
  18 #endif
  19
  20 #ifndef _PDCLIB_NULL_DEFINED
  21 #define _PDCLIB_NULL_DEFINED _PDCLIB_NULL_DEFINED
  22 #define NULL _PDCLIB_NULL
  23 #endif
  24
  25 #ifndef _PDCLIB_MB_CUR_MAX_DEFINED
  26 #define _PDCLIB_MB_CUR_MAX_DEFINED
  27 #define MB_CUR_MAX (_PDCLIB_mb_cur_max())
  28 #endif
  29
  30 /* Numeric conversion functions */
  31
  32 /* TODO: atof(), strtof(), strtod(), strtold() */
  33
  34 double atof( const char * nptr ) _PDCLIB_nothrow;
  35 double strtod( const char * _PDCLIB_restrict nptr, char * * _PDCLIB_restrict endptr ) _PDCLIB_nothrow;
  36 float strtof( const char * _PDCLIB_restrict nptr, char * * _PDCLIB_restrict endptr ) _PDCLIB_nothrow;
  37 long double strtold( const char * _PDCLIB_restrict nptr, char * * _PDCLIB_restrict endptr ) _PDCLIB_nothrow;
  38
  39 /* Seperate the character array nptr into three parts: A (possibly empty)
  40    sequence of whitespace characters, a character representation of an integer
  41    to the given base, and trailing invalid characters (including the terminating
  42    null character). If base is 0, assume it to be 10, unless the integer
  43    representation starts with 0x / 0X (setting base to 16) or 0 (setting base to
  44    8). If given, base can be anything from 0 to 36, using the 26 letters of the
  45    base alphabet (both lowercase and uppercase) as digits 10 through 35.
  46    The integer representation is then converted into the return type of the
  47    function. It can start with a '+' or '-' sign. If the sign is '-', the result
  48    of the conversion is negated.
  49    If the conversion is successful, the converted value is returned. If endptr
  50    is not a NULL pointer, a pointer to the first trailing invalid character is
  51    returned in *endptr.
  52    If no conversion could be performed, zero is returned (and nptr in *endptr,
  53    if endptr is not a NULL pointer). If the converted value does not fit into
  54    the return type, the functions return LONG_MIN, LONG_MAX, ULONG_MAX,
  55    LLONG_MIN, LLONG_MAX, or ULLONG_MAX respectively, depending on the sign of
  56    the integer representation and the return type, and errno is set to ERANGE.
  57 */
  58 /* There is strtoimax() and strtoumax() in <inttypes.h> operating on intmax_t /
  59    uintmax_t, if the long long versions do not suit your needs.
  60 */
  61 long int strtol( const char * _PDCLIB_restrict nptr, char * * _PDCLIB_restrict endptr, int base ) _PDCLIB_nothrow;
  62 long long int strtoll( const char * _PDCLIB_restrict nptr, char * * _PDCLIB_restrict endptr, int base ) _PDCLIB_nothrow;
  63 unsigned long int strtoul( const char * _PDCLIB_restrict nptr, char * * _PDCLIB_restrict endptr, int base ) _PDCLIB_nothrow;
  64 unsigned long long int strtoull( const char * _PDCLIB_restrict nptr, char * * _PDCLIB_restrict endptr, int base ) _PDCLIB_nothrow;
  65
  66 /* These functions are the equivalent of (int)strtol( nptr, NULL, 10 ),
  67    strtol( nptr, NULL, 10 ) and strtoll(nptr, NULL, 10 ) respectively, with the
  68    exception that they do not have to handle overflow situations in any defined
  69    way.
  70    (PDCLib does not simply forward these to their strtox() equivalents, but
  71    provides a simpler atox() function that saves a couple of tests and simply
  72    continues with the conversion in case of overflow.)
  73 */
  74 int atoi( const char * nptr ) _PDCLIB_nothrow;
  75 long int atol( const char * nptr ) _PDCLIB_nothrow;
  76 long long int atoll( const char * nptr ) _PDCLIB_nothrow;
  77
  78 /* Pseudo-random sequence generation functions */
  79
  80 extern unsigned long int _PDCLIB_seed;
  81
  82 #define RAND_MAX 32767
  83
  84 /* Returns the next number in a pseudo-random sequence, which is between 0 and
  85    RAND_MAX.
  86    (PDCLib uses the implementation suggested by the standard document, which is
  87    next = next * 1103515245 + 12345; return (unsigned int)(next/65536) % 32768;)
  88 */
  89 int rand( void ) _PDCLIB_nothrow;
  90
  91 /* Initialize a new pseudo-random sequence with the starting seed. Same seeds
  92    result in the same pseudo-random sequence. The default seed is 1.
  93 */
  94 void srand( unsigned int seed ) _PDCLIB_nothrow;
  95
  96 /* Memory management functions */
  97
  98 /* Allocate a chunk of heap memory of given size. If request could not be
  99    satisfied, return NULL. Otherwise, return a pointer to the allocated
 100    memory. Memory contents are undefined.
 101 */
 102 void * malloc( size_t size ) _PDCLIB_nothrow;
 103
 104 /* Allocate a chunk of heap memory that is large enough to hold nmemb elements
 105    of the given size, and zero-initialize that memory. If request could not be
 106    satisfied, return NULL. Otherwise, return a pointer to the allocated
 107    memory.
 108 */
 109 void * calloc( size_t nmemb, size_t size ) _PDCLIB_nothrow;
 110
 111 /* De-allocate a chunk of heap memory previously allocated using malloc(),
 112    calloc(), or realloc(), and pointed to by ptr. If ptr does not match a
 113    pointer previously returned by the mentioned allocation functions, or
 114    free() has already been called for this ptr, behaviour is undefined.
 115 */
 116 void free( void * ptr ) _PDCLIB_nothrow;
 117
 118 /* Resize a chunk of memory previously allocated with malloc() and pointed to
 119    by ptr to the given size (which might be larger or smaller than the original
 120    size). Returns a pointer to the reallocated memory, or NULL if the request
 121    could not be satisfied. Note that the resizing might include a memcpy()
 122    from the original location to a different one, so the return value might or
 123    might not equal ptr. If size is larger than the original size, the value of
 124    memory beyond the original size is undefined. If ptr is NULL, realloc()
 125    behaves like malloc().
 126 */
 127 void * realloc( void * ptr, size_t size ) _PDCLIB_nothrow;
 128
 129 /* Communication with the environment */
 130
 131 /* These two can be passed to exit() or _Exit() as status values, to signal
 132    successful and unsuccessful program termination, respectively. EXIT_SUCCESS
 133    can be replaced by 0. How successful or unsuccessful program termination are
 134    signaled to the environment, and what happens if exit() or _Exit() are being
 135    called with a value that is neither of the three, is defined by the hosting
 136    OS and its glue function.
 137 */
 138 #define EXIT_SUCCESS _PDCLIB_SUCCESS
 139 #define EXIT_FAILURE _PDCLIB_FAILURE
 140
 141 /* Initiate abnormal process termination, unless programm catches SIGABRT and
 142    does not return from the signal handler.
 143    This implementantion flushes all streams, closes all files, and removes any
 144    temporary files before exiting with EXIT_FAILURE.
 145    abort() does not return.
 146 */
 147 _PDCLIB_noreturn void abort( void ) _PDCLIB_nothrow;
 148
 149 /* Register a function that will be called on exit(), or when main() returns.
 150    At least 32 functions can be registered this way, and will be called in
 151    reverse order of registration (last-in, first-out).
 152    Returns zero if registration is successfull, nonzero if it failed.
 153 */
 154 int atexit( void (*func)( void ) ) _PDCLIB_nothrow;
 155
 156 /* Normal process termination. Functions registered by atexit() (see above) are
 157    called, streams flushed, files closed and temporary files removed before the
 158    program is terminated with the given status. (See comment for EXIT_SUCCESS
 159    and EXIT_FAILURE above.)
 160    exit() does not return.
 161 */
 162 _PDCLIB_noreturn void exit( int status ) _PDCLIB_nothrow;
 163
 164 /* Normal process termination. Functions registered by atexit() (see above) are
 165    NOT CALLED. This implementation DOES flush streams, close files and removes
 166    temporary files before the program is teminated with the given status. (See
 167    comment for EXIT_SUCCESS and EXIT_FAILURE above.)
 168    _Exit() does not return.
 169 */
 170 _PDCLIB_noreturn void _Exit( int status ) _PDCLIB_nothrow;
 171
 172 /* Search an environment-provided key-value map for the given key name, and
 173    return a pointer to the associated value string (or NULL if key name cannot
 174    be found). The value string pointed to might be overwritten by a subsequent
 175    call to getenv(). The library never calls getenv() itself.
 176    Details on the provided keys and how to set / change them are determined by
 177    the hosting OS and its glue function.
 178 */
 179 char * getenv( const char * name ) _PDCLIB_nothrow;
 180
 181 /* If string is a NULL pointer, system() returns nonzero if a command processor
 182    is available, and zero otherwise. If string is not a NULL pointer, it is
 183    passed to the command processor. If system() returns, it does so with a
 184    value that is determined by the hosting OS and its glue function.
 185 */
 186 int system( const char * string ) _PDCLIB_nothrow;
 187
 188 /* Searching and sorting */
 189
 190 /* Do a binary search for a given key in the array with a given base pointer,
 191    which consists of nmemb elements that are of the given size each. To compare
 192    the given key with an element from the array, the given function compar is
 193    called (with key as first parameter and a pointer to the array member as
 194    second parameter); the function should return a value less than, equal to,
 195    or greater than 0 if the key is considered to be less than, equal to, or
 196    greater than the array element, respectively.
 197    The function returns a pointer to the first matching element found, or NULL
 198    if no match is found.
 199
 200    ** May throw **
 201 */
 202 void * bsearch( const void * key, const void * base, size_t nmemb, size_t size, int (*compar)( const void *, const void * ) );
 203
 204 /* Do a quicksort on an array with a given base pointer, which consists of
 205    nmemb elements that are of the given size each. To compare two elements from
 206    the array, the given function compar is called, which should return a value
 207    less than, equal to, or greater than 0 if the first argument is considered
 208    to be less than, equal to, or greater than the second argument, respectively.
 209    If two elements are compared equal, their order in the sorted array is not
 210    specified.
 211
 212    ** May throw **
 213 */
 214 void qsort( void * base, size_t nmemb, size_t size, int (*compar)( const void *, const void * ) );
 215
 216 /* Integer arithmetic functions */
 217
 218 /* Return the absolute value of the argument. Note that on machines using two-
 219    complement's notation (most modern CPUs), the largest negative value cannot
 220    be represented as positive value. In this case, behaviour is unspecified.
 221 */
 222 int abs( int j ) _PDCLIB_nothrow;
 223 long int labs( long int j ) _PDCLIB_nothrow;
 224 long long int llabs( long long int j ) _PDCLIB_nothrow;
 225
 226 /* These structures each have a member quot and a member rem, of type int (for
 227    div_t), long int (for ldiv_t) and long long it (for lldiv_t) respectively.
 228    The order of the members is platform-defined to allow the div() functions
 229    below to be implemented efficiently.
 230 */
 231 typedef struct _PDCLIB_div_t     div_t;
 232 typedef struct _PDCLIB_ldiv_t   ldiv_t;
 233 typedef struct _PDCLIB_lldiv_t lldiv_t;
 234
 235 /* Return quotient (quot) and remainder (rem) of an integer division in one of
 236    the structs above.
 237 */
 238 div_t div( int numer, int denom ) _PDCLIB_nothrow;
 239 ldiv_t ldiv( long int numer, long int denom ) _PDCLIB_nothrow;
 240 lldiv_t lldiv( long long int numer, long long int denom ) _PDCLIB_nothrow;
 241
 242 /* TODO: Multibyte / wide character conversion functions */
 243
 244 /* TODO: Macro MB_CUR_MAX */
 245
 246 /*
 247 int mblen( const char * s, size_t n );
 248 int mbtowc( wchar_t * _PDCLIB_restrict pwc, const char * _PDCLIB_restrict s, size_t n );
 249 int wctomb( char * s, wchar_t wc );
 250 size_t mbstowcs( wchar_t * _PDCLIB_restrict pwcs, const char * _PDCLIB_restrict s, size_t n );
 251 size_t wcstombs( char * _PDCLIB_restrict s, const wchar_t * _PDCLIB_restrict pwcs, size_t n );
 252 */
 253
 254 #ifdef __cplusplus
 255 }
 256 #endif
 257
 258 #endif