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