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