Formerly ../stdlib/msort.c.~4~
[kopensolaris-gnu/glibc.git] / stdlib / stdlib.h
1 /* Copyright (C) 1991, 1992 Free Software Foundation, Inc.
2 This file is part of the GNU C Library.
3
4 The GNU C Library is free software; you can redistribute it and/or
5 modify it under the terms of the GNU Library General Public License as
6 published by the Free Software Foundation; either version 2 of the
7 License, or (at your option) any later version.
8
9 The GNU C Library is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12 Library General Public License for more details.
13
14 You should have received a copy of the GNU Library General Public
15 License along with the GNU C Library; see the file COPYING.LIB.  If
16 not, write to the Free Software Foundation, Inc., 675 Mass Ave,
17 Cambridge, MA 02139, USA.  */
18
19 /*
20  *      ANSI Standard: 4.10 GENERAL UTILITIES   <stdlib.h>
21  */
22
23 #ifndef _STDLIB_H
24
25 #define _STDLIB_H       1
26 #include <features.h>
27
28 #ifdef  __cplusplus
29 extern "C" {
30 #endif
31
32 /* Get size_t, wchar_t and NULL from <stddef.h>.  */
33 #define __need_size_t
34 #define __need_wchar_t
35 #define __need_NULL
36 #include <stddef.h>
37
38 #define __need_Emath
39 #include <errno.h>
40
41 /* Get machine-dependent HUGE_VAL value (returned on overflow).  */
42 #include <huge_val.h>
43
44
45 /* Returned by `div'.  */
46 typedef struct
47   {
48     int quot;   /* Quotient.  */
49     int rem;    /* Remainder.  */
50   } div_t;
51
52 /* Returned by `ldiv'.  */
53 typedef struct
54   {
55     long int quot;      /* Quotient.  */
56     long int rem;       /* Remainder.  */
57   } ldiv_t;
58
59
60 /* The largest number rand will return (same as INT_MAX).  */
61 #define RAND_MAX        2147483647
62
63
64 /* We define these the same for all machines.
65    Changes from this to the outside world should be done in `_exit'.  */
66 #define EXIT_FAILURE    1       /* Failing exit status.  */
67 #define EXIT_SUCCESS    0       /* Successful exit status.  */
68
69
70 /* Maximum length of a multibyte character in the current locale.
71    This is just one until the fancy locale support is finished.  */
72 #define MB_CUR_MAX      1
73
74
75 /* Convert a string to a floating-point number.  */
76 extern double EXFUN(atof, (CONST char *__nptr));
77 /* Convert a string to an integer.  */
78 extern int EXFUN(atoi, (CONST char *__nptr));
79 /* Convert a string to a long integer.  */
80 extern long int EXFUN(atol, (CONST char *__nptr));
81
82 /* Convert a string to a floating-point number.  */
83 extern double EXFUN(strtod, (CONST char *__nptr, char **__endptr));
84 /* Convert a string to a long integer.  */
85 extern long int EXFUN(strtol, (CONST char *__nptr, char **__endptr,
86                                int __base));
87 /* Convert a string to an unsigned long integer.  */
88 extern unsigned long int EXFUN(strtoul, (CONST char *__nptr,
89                                          char **__endptr, int __base));
90
91 #ifdef  __OPTIMIZE__
92 #define atof(nptr)      strtod((nptr), (char **) NULL)
93 #define atoi(nptr)      ((int) atol(nptr))
94 #define atol(nptr)      strtol((nptr), (char **) NULL, 10)
95 #endif  /* Optimizing.  */
96
97
98 /* Return a random integer between 0 and RAND_MAX inclusive.  */
99 extern int EXFUN(rand, (NOARGS));
100 /* Seed the random number generator with the given number.  */
101 extern void EXFUN(srand, (unsigned int __seed));
102
103 /* These are the functions that actually do things.  The `random', `srandom',
104    `initstate' and `setstate' functions are those from BSD Unices.
105    The `rand' and `srand' functions are required by the ANSI standard.
106    We provide both interfaces to the same random number generator.  */
107 /* Return a random long integer between 0 and RAND_MAX inclusive.  */
108 extern long int EXFUN(__random, (NOARGS));
109 /* Seed the random number generator with the given number.  */
110 extern void EXFUN(__srandom, (unsigned int __seed));
111
112 /* Initialize the random number generator to use state buffer STATEBUF,
113    of length STATELEN, and seed it with SEED.  Optimal lengths are 8, 16,
114    32, 64, 128 and 256, the bigger the better; values less than 8 will
115    cause an error and values greater than 256 will be rounded down.  */
116 extern PTR EXFUN(__initstate, (unsigned int __seed, PTR __statebuf,
117                                size_t __statelen));
118 /* Switch the random number generator to state buffer STATEBUF,
119    which should have been previously initialized by `initstate'.  */
120 extern PTR EXFUN(__setstate, (PTR __statebuf));
121
122 #ifdef  __USE_BSD
123 extern long int EXFUN(random, (NOARGS));
124 extern void EXFUN(srandom, (unsigned int __seed));
125 extern PTR EXFUN(initstate, (unsigned int __seed, PTR __statebuf,
126                              size_t __statelen));
127 extern PTR EXFUN(setstate, (PTR __statebuf));
128
129 #ifdef  __OPTIMIZE__
130 #define random()                __random()
131 #define srandom(seed)           __srandom(seed)
132 #define initstate(s, b, n)      __initstate((s), (b), (n))
133 #define setstate(state)         __setstate(state)
134 #endif  /* Optimizing.  */
135 #endif  /* Use BSD.  */
136
137 #ifdef  __OPTIMIZE__
138 #define rand()          ((int) __random())
139 #define srand(seed)     __srandom(seed)
140 #endif  /* Optimizing.  */
141
142
143 /* Allocate SIZE bytes of memory.  */
144 extern PTR EXFUN(malloc, (size_t __size));
145 /* Re-allocate the previously allocated block
146    in PTR, making the new block SIZE bytes long.  */
147 extern PTR EXFUN(realloc, (PTR __ptr, size_t __size));
148 /* Allocate NMEMB elements of SIZE bytes each, all initialized to 0.  */
149 extern PTR EXFUN(calloc, (size_t __nmemb, size_t __size));
150 /* Free a block allocated by `malloc', `realloc' or `calloc'.  */
151 extern void EXFUN(free, (PTR __ptr));   
152
153 #ifdef  __USE_MISC
154 /* Free a block.  An alias for `free'.  (Sun Unices).  */
155 extern void EXFUN(cfree, (PTR __ptr));
156
157 #ifdef  __OPTIMIZE__
158 #define cfree(ptr)      free(ptr)
159 #endif  /* Optimizing.  */
160 #endif  /* Use misc.  */
161
162 #if defined(__USE_GNU) || defined(__USE_BSD) || defined(__USE_MISC)
163 #include <alloca.h>
164 #endif  /* Use GNU, BSD, or misc.  */
165
166 #ifdef  __USE_BSD
167 /* Allocate SIZE bytes on a page boundary.  The storage cannot be freed.  */
168 extern PTR EXFUN(valloc, (size_t __size));
169 #endif
170
171
172 #ifndef __NORETURN
173 #ifdef  __GNUC__
174 /* The `volatile' keyword tells GCC that a function never returns.  */
175 #define __NORETURN      __volatile
176 #else   /* Not GCC.  */
177 #define __NORETURN
178 #endif  /* GCC.  */
179 #endif  /* __NORETURN not defined.  */
180
181 /* Abort execution and generate a core-dump.  */
182 extern __NORETURN void EXFUN(abort, (NOARGS));
183
184
185 /* Register a function to be called when `exit' is called.  */
186 extern int EXFUN(atexit, (void (*__func)(NOARGS)));
187
188 #ifdef  __USE_MISC
189 /* Register a function to be called with the status
190    given to `exit' and the given argument.  */
191 extern int EXFUN(on_exit, (void (*__func)(int __status, PTR __arg),
192                            PTR __arg));
193 #endif
194
195 /* Call all functions registered with `atexit' and `on_exit',
196    in the reverse of the order in which they were registered
197    perform stdio cleanup, and terminate program execution with STATUS.  */
198 extern __NORETURN void EXFUN(exit, (int __status));
199
200
201 /* Return the value of envariable NAME, or NULL if it doesn't exist.  */
202 extern char *EXFUN(getenv, (CONST char *__name));
203
204 #ifdef  __USE_SVID
205 /* The SVID says this is in <stdio.h>, but this seems a better place.   */
206 /* Put STRING, which is of the form "NAME=VALUE", in the environment.
207    If there is no `=', remove NAME from the environment.  */
208 extern int EXFUN(putenv, (CONST char *__string));
209 #endif
210
211 /* Execute the given line as a shell command.  */
212 extern int EXFUN(system, (CONST char *__command));
213
214
215 /* Shorthand for type of comparison functions.  */
216 typedef int (*__compar_fn_t) (CONST PTR, CONST PTR);
217
218 #ifdef  __GNUC__
219 #define comparison_fn_t __compar_fn_t
220 #endif
221
222 /* Do a binary search for KEY in BASE, which consists of NMEMB elements
223    of SIZE bytes each, using COMPAR to perform the comparisons.  */
224 extern PTR EXFUN(bsearch, (CONST PTR __key, CONST PTR __base,
225                            size_t __nmemb, size_t __size,
226                            __compar_fn_t __compar));
227
228 /* Sort NMEMB elements of BASE, of SIZE bytes each,
229    using COMPAR to perform the comparisons.  */
230 extern void EXFUN(qsort, (PTR __base, size_t __nmemb, size_t __size,
231                           __compar_fn_t __compar));
232
233
234 #ifndef __CONSTVALUE
235 #ifdef  __GNUC__
236 /* The `const' keyword tells GCC that a function's return value is
237    based solely on its arguments, and there are no side-effects.  */
238 #define __CONSTVALUE    __const
239 #else
240 #define __CONSTVALUE
241 #endif  /* GCC.  */
242 #endif  /* __CONSTVALUE not defined.  */
243
244 /* Return the absolute value of X.  */
245 extern __CONSTVALUE int EXFUN(abs, (int __x));
246 extern __CONSTVALUE long int EXFUN(labs, (long int __x));
247
248 #if     defined(__GNUC__) && defined(__OPTIMIZE__)
249 #define abs(x)  __builtin_abs(x)
250 #define labs(x) __builtin_labs(x)
251 #endif  /* GCC and optimizing.  */
252
253
254 /* Return the `div_t' or `ldiv_t' representation
255    of the value of NUMER over DENOM. */
256 /* GCC may have built-ins for these someday.  */
257 extern __CONSTVALUE div_t EXFUN(div, (int __numer, int __denom));
258 extern __CONSTVALUE ldiv_t EXFUN(ldiv, (long int __numer, long int __denom));
259
260
261 /* Return the length of the multibyte character
262    in S, which is no longer than N.  */
263 extern int EXFUN(mblen, (CONST char *__s, size_t __n));
264 /* Return the length of the given multibyte character,
265    putting its `wchar_t' representation in *PWC.  */
266 extern int EXFUN(mbtowc, (wchar_t *__pwc, CONST char *__s, size_t __n));
267 /* Put the multibyte character represented
268    by WCHAR in S, returning its length.  */
269 extern int EXFUN(wctomb, (char *__s, wchar_t __wchar));
270
271 #ifdef  __OPTIMIZE__
272 #define mblen(s, n)     mbtowc((wchar_t *) NULL, (s), (n))
273 #endif  /* Optimizing.  */
274
275
276 /* Convert a multibyte string to a wide char string.  */
277 extern size_t EXFUN(mbstowcs, (wchar_t *__pwcs, CONST char *__s, size_t __n));
278 /* Convert a wide char string to multibyte string.  */
279 extern size_t EXFUN(wcstombs, (char *__s, CONST wchar_t *__pwcs, size_t __n));
280
281
282 #ifdef  __cplusplus
283 }
284 #endif
285
286 #endif  /* stdlib.h  */