65932e3d171e98d3fac003392beefd1a470c1fcd
[kopensolaris-gnu/glibc.git] / stdlib / stdlib.h
1 /* Copyright (C) 1991, 92, 93, 94, 95, 96 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, 1992 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 /* Get size_t, wchar_t and NULL from <stddef.h>.  */
29 #define __need_size_t
30 #define __need_wchar_t
31 #define __need_NULL
32 #include <stddef.h>
33
34 #define __need_Emath
35 #include <errno.h>
36
37 __BEGIN_DECLS
38
39 /* Returned by `div'.  */
40 typedef struct
41   {
42     int quot;                   /* Quotient.  */
43     int rem;                    /* Remainder.  */
44   } div_t;
45
46 /* Returned by `ldiv'.  */
47 typedef struct
48   {
49     long int quot;              /* Quotient.  */
50     long int rem;               /* Remainder.  */
51   } ldiv_t;
52
53
54 /* The largest number rand will return (same as INT_MAX).  */
55 #define RAND_MAX        2147483647
56
57
58 /* We define these the same for all machines.
59    Changes from this to the outside world should be done in `_exit'.  */
60 #define EXIT_FAILURE    1       /* Failing exit status.  */
61 #define EXIT_SUCCESS    0       /* Successful exit status.  */
62
63
64 /* Maximum length of a multibyte character in the current locale.
65    This is just one until the fancy locale support is finished.  */
66 #define MB_CUR_MAX      1
67
68
69 /* Convert a string to a floating-point number.  */
70 extern double atof __P ((__const char *__nptr));
71 /* Convert a string to an integer.  */
72 extern int atoi __P ((__const char *__nptr));
73 /* Convert a string to a long integer.  */
74 extern long int atol __P ((__const char *__nptr));
75
76 /* Convert a string to a floating-point number.  */
77 extern double strtod __P ((__const char *__nptr, char **__endptr));
78
79 #ifdef  __USE_GNU
80 /* Likewise for `float' and `long double' sizes of floating-point numbers.  */
81 extern float strtof __P ((__const char *__nptr, char **__endptr));
82 extern __long_double_t strtold __P ((__const char *__nptr, char **__endptr));
83 #endif
84
85 /* Convert a string to a long integer.  */
86 extern long int strtol __P ((__const char *__nptr, char **__endptr,
87                              int __base));
88 /* Convert a string to an unsigned long integer.  */
89 extern unsigned long int strtoul __P ((__const char *__nptr,
90                                        char **__endptr, int __base));
91
92 #if defined (__GNUC__) && defined (__USE_BSD)
93 /* Convert a string to a quadword integer.  */
94 extern long long int strtoq __P ((__const char *__nptr, char **__endptr,
95                                   int __base));
96 /* Convert a string to an unsigned quadword integer.  */
97 extern unsigned long long int strtouq __P ((__const char *__nptr,
98                                             char **__endptr, int __base));
99 #endif /* GCC and use BSD.  */
100
101
102 /* The internal entry points for `strtoX' take an extra flag argument
103    saying whether or not to parse locale-dependent number grouping.  */
104
105 extern double __strtod_internal (__const char *__nptr,
106                                  char **__endptr, int __group);
107 extern float __strtof_internal (__const char *__nptr, char **__endptr,
108                                 int __group);
109 extern __long_double_t __strtold_internal (__const char *__nptr,
110                                            char **__endptr, int __group);
111 extern long int __strtol_internal (__const char *__nptr, char **__endptr,
112                                    int __base, int __group);
113 extern unsigned long int __strtoul_internal (__const char *__nptr,
114                                              char **__endptr, int __base,
115                                              int __group);
116 extern long long int __strtoq_internal (__const char *__nptr, char **__endptr,
117                                         int __base, int __group);
118 extern unsigned long long int __strtouq_internal (__const char *__nptr,
119                                                   char **__endptr, int __base,
120                                                   int __group);
121
122 #if defined (__OPTIMIZE__) && __GNUC__ >= 2
123 /* Define inline functions which call the internal entry points.  */
124
125 extern __inline double strtod (__const char *__nptr, char **__endptr)
126 { return __strtod_internal (__nptr, __endptr, 0); }
127 extern __inline long int strtol (__const char *__nptr,
128                                  char **__endptr, int __base)
129 { return __strtol_internal (__nptr, __endptr, __base, 0); }
130 extern __inline unsigned long int strtoul (__const char *__nptr,
131                                            char **__endptr, int __base)
132 { return __strtoul_internal (__nptr, __endptr, __base, 0); }
133
134 #ifdef __USE_GNU
135 extern __inline float strtof (__const char *__nptr, char **__endptr)
136 { return __strtof_internal (__nptr, __endptr, 0); }
137 extern __inline __long_double_t strtold (__const char *__nptr, char **__endptr)
138 { return __strtold_internal (__nptr, __endptr, 0); }
139 #endif
140
141 #ifdef __USE_BSD
142 extern __inline long long int strtoq (__const char *__nptr, char **__endptr,
143                                       int __base)
144 { return __strtoq_internal (__nptr, __endptr, __base, 0); }
145 extern __inline unsigned long long int strtouq (__const char *__nptr,
146                                             char **__endptr, int __base)
147 { return __strtouq_internal (__nptr, __endptr, __base, 0); }
148 #endif
149
150 extern __inline double atof (__const char *__nptr)
151 { return strtod (__nptr, (char **) NULL); }
152 extern __inline int atoi (__const char *__nptr)
153 { return (int) strtol (__nptr, (char **) NULL, 10); }
154 extern __inline long int atol (__const char *__nptr)
155 { return strtol (__nptr, (char **) NULL, 10); }
156 #endif /* Optimizing GCC >=2.  */
157
158
159 #ifdef __USE_SVID
160 /* Convert N to base 64 using the digits "./0-9A-Za-z", least-significant
161    digit first.  Returns a pointer to static storage overwritten by the
162    next call.  */
163 extern char *l64a __P ((long int __n));
164
165 /* Read a number from a string in base 64 as above.  */
166 extern long int a64l __P ((const char *));
167 #endif
168
169
170 /* Return a random integer between 0 and RAND_MAX inclusive.  */
171 extern int rand __P ((void));
172 /* Seed the random number generator with the given number.  */
173 extern void srand __P ((unsigned int __seed));
174
175 #ifdef  __USE_BSD
176
177 #include <sys/types.h>  /* we need int32_t... */
178
179 /* These are the functions that actually do things.  The `random', `srandom',
180    `initstate' and `setstate' functions are those from BSD Unices.
181    The `rand' and `srand' functions are required by the ANSI standard.
182    We provide both interfaces to the same random number generator.  */
183 /* Return a random long integer between 0 and RAND_MAX inclusive.  */
184 extern int32_t __random __P ((void));
185 /* Seed the random number generator with the given number.  */
186 extern void __srandom __P ((unsigned int __seed));
187
188 /* Initialize the random number generator to use state buffer STATEBUF,
189    of length STATELEN, and seed it with SEED.  Optimal lengths are 8, 16,
190    32, 64, 128 and 256, the bigger the better; values less than 8 will
191    cause an error and values greater than 256 will be rounded down.  */
192 extern __ptr_t __initstate __P ((unsigned int __seed, __ptr_t __statebuf,
193                                  size_t __statelen));
194 /* Switch the random number generator to state buffer STATEBUF,
195    which should have been previously initialized by `initstate'.  */
196 extern __ptr_t __setstate __P ((__ptr_t __statebuf));
197
198 extern long int random __P ((void));
199 extern void srandom __P ((unsigned int __seed));
200 extern __ptr_t initstate __P ((unsigned int __seed, __ptr_t __statebuf,
201                                size_t __statelen));
202 extern __ptr_t setstate __P ((__ptr_t __statebuf));
203
204 #if defined (__OPTIMIZE__) && __GNUC__ >= 2
205 extern __inline long int random (void)
206 { return __random(); }
207 extern __inline void srandom (unsigned int __seed)
208 { __srandom(__seed); }
209 extern __inline __ptr_t initstate (unsigned int __seed,
210                                    __ptr_t __statebuf, size_t __statelen)
211 { return __initstate (__seed, __statebuf, __statelen); }
212 extern __inline __ptr_t setstate (__ptr_t __statebuf)
213 { return __setstate (__statebuf); }
214 #endif /* Optimizing GCC >=2.  */
215
216 #ifdef __USE_REENTRANT
217 /* Reentrant versions of the `random' family of functions.
218    These functions all use the following data structure to contain
219    state, rather than global state variables.  */
220
221 struct random_data
222   {
223     int32_t *fptr;              /* Front pointer.  */
224     int32_t *rptr;              /* Rear pointer.  */
225     int32_t *state;             /* Array of state values.  */
226     int rand_type;              /* Type of random number generator.  */
227     int rand_deg;               /* Degree of random number generator.  */
228     int rand_sep;               /* Distance between front and rear.  */
229     int32_t *end_ptr;           /* Pointer behind state table.  */
230   };
231
232 extern int __random_r __P ((struct random_data *__buf, int32_t *__result));
233 extern int random_r __P ((struct random_data *__buf, int32_t *__result));
234 extern int __srandom_r __P ((unsigned int __seed, struct random_data *__buf));
235 extern int __initstate_r __P ((unsigned int __seed, __ptr_t __statebuf,
236                                size_t __statelen, struct random_data *__buf));
237 extern int __setstate_r __P ((__ptr_t __statebuf, struct random_data *__buf));
238
239 extern int srandom_r __P ((unsigned int __seed, struct random_data *__buf));
240 extern int initstate_r __P ((unsigned int __seed, __ptr_t __statebuf,
241                              size_t __statelen, struct random_data *__buf));
242 extern int setstate_r __P ((__ptr_t __statebuf, struct random_data *__buf));
243 #endif  /* __USE_REENTRANT.  */
244 #endif  /* Use BSD.  */
245
246
247 #ifdef  __USE_SVID
248 /* System V style 48-bit random number generator functions.  */
249
250 /* Data structure for communication with thread safe versions.  */
251 struct drand48_data
252   {
253     unsigned short int X[3];    /* Current state.  */
254     unsigned short int a[3];    /* Factor in congruential formula.  */
255     unsigned short int c;       /* Additive const. in congruential formula.  */
256     unsigned short int old_X[3]; /* Old state.  */
257     int init;                   /* Flag for initializing.  */
258   };
259
260 /* Return non-negative, double-precision floating-point value in [0.0,1.0).  */
261 extern double drand48 __P ((void));
262 extern int drand48_r __P ((struct drand48_data *__buffer, double *__result));
263 extern double erand48 __P ((unsigned short int __xsubi[3]));
264 extern int erand48_r __P ((unsigned short int __xsubi[3],
265                            struct drand48_data *__buffer, double *__result));
266 /* Return non-negative, long integer in [0,2^31).  */
267 extern long lrand48 __P ((void));
268 extern int lrand48_r __P ((struct drand48_data *__buffer, long *__result));
269 extern long nrand48 __P ((unsigned short int __xsubi[3]));
270 extern int nrand48_r __P ((unsigned short int __xsubi[3],
271                            struct drand48_data *__buffer, long *__result));
272 /* Return signed, long integers in [-2^31,2^31).  */
273 extern long mrand48 __P ((void));
274 extern int mrand48_r __P ((struct drand48_data *__buffer, long *__result));
275 extern long jrand48 __P ((unsigned short int __xsubi[3]));
276 extern int jrand48_r __P ((unsigned short int __xsubi[3],
277                            struct drand48_data *__buffer, long *__result));
278 /* Seed random number generator.  */
279 extern void srand48 __P ((long __seedval));
280 extern int srand48_r __P ((long __seedval, struct drand48_data *__buffer));
281 extern unsigned short int *seed48 __P ((unsigned short int __seed16v[3]));
282 extern int seed48_r __P ((unsigned short int __seed16v[3],
283                           struct drand48_data *__buffer));
284 extern void lcong48 __P ((unsigned short int __param[7]));
285 extern int lcong48_r __P ((unsigned short int __param[7],
286                            struct drand48_data *__buffer));
287
288 /* Internal function to compute next state of the generator.  */
289 extern int __drand48_iterate __P ((unsigned short int __xsubi[3],
290                                    struct drand48_data *__buffer));
291 #endif  /* __USE_SVID.  */
292
293
294 /* Allocate SIZE bytes of memory.  */
295 extern __ptr_t malloc __P ((size_t __size));
296 /* Re-allocate the previously allocated block
297    in __ptr_t, making the new block SIZE bytes long.  */
298 extern __ptr_t realloc __P ((__ptr_t __ptr, size_t __size));
299 /* Allocate NMEMB elements of SIZE bytes each, all initialized to 0.  */
300 extern __ptr_t calloc __P ((size_t __nmemb, size_t __size));
301 /* Free a block allocated by `malloc', `realloc' or `calloc'.  */
302 extern void free __P ((__ptr_t __ptr));
303
304 #ifdef  __USE_MISC
305 /* Free a block.  An alias for `free'.  (Sun Unices).  */
306 extern void cfree __P ((__ptr_t __ptr));
307 #endif /* Use misc.  */
308
309 #if defined(__USE_GNU) || defined(__USE_BSD) || defined(__USE_MISC)
310 #include <alloca.h>
311 #endif /* Use GNU, BSD, or misc.  */
312
313 #ifdef  __USE_BSD
314 /* Allocate SIZE bytes on a page boundary.  The storage cannot be freed.  */
315 extern __ptr_t valloc __P ((size_t __size));
316 #endif
317
318
319 /* Abort execution and generate a core-dump.  */
320 extern void abort __P ((void)) __attribute__ ((__noreturn__));
321
322
323 /* Register a function to be called when `exit' is called.  */
324 extern int atexit __P ((void (*__func) (void)));
325
326 #ifdef  __USE_MISC
327 /* Register a function to be called with the status
328    given to `exit' and the given argument.  */
329 extern int on_exit __P ((void (*__func) (int __status, __ptr_t __arg),
330                          __ptr_t __arg));
331 #endif
332
333 /* Call all functions registered with `atexit' and `on_exit',
334    in the reverse of the order in which they were registered
335    perform stdio cleanup, and terminate program execution with STATUS.  */
336 extern void exit __P ((int __status)) __attribute__ ((__noreturn__));
337
338
339 /* Return the value of envariable NAME, or NULL if it doesn't exist.  */
340 extern char *getenv __P ((__const char *__name));
341
342 #ifdef  __USE_SVID
343 /* The SVID says this is in <stdio.h>, but this seems a better place.   */
344 /* Put STRING, which is of the form "NAME=VALUE", in the environment.
345    If there is no `=', remove NAME from the environment.  */
346 extern int putenv __P ((__const char *__string));
347 #endif
348
349 #ifdef  __USE_BSD
350 /* Set NAME to VALUE in the environment.
351    If REPLACE is nonzero, overwrite an existing value.  */
352 extern int setenv __P ((__const char *__name, __const char *__value,
353                         int __replace));
354
355 /* Remove the variable NAME from the environment.  */
356 extern void unsetenv __P ((__const char *__name));
357 #endif
358
359 /* Execute the given line as a shell command.  */
360 extern int system __P ((__const char *__command));
361
362
363 /* Shorthand for type of comparison functions.  */
364 #ifndef __COMPAR_FN_T
365 #define __COMPAR_FN_T
366 typedef int (*__compar_fn_t) __P ((__const __ptr_t, __const __ptr_t));
367 #endif
368
369 #ifdef  __USE_GNU
370 typedef __compar_fn_t comparison_fn_t;
371 #endif
372
373 /* Do a binary search for KEY in BASE, which consists of NMEMB elements
374    of SIZE bytes each, using COMPAR to perform the comparisons.  */
375 extern __ptr_t bsearch __P ((__const __ptr_t __key, __const __ptr_t __base,
376                              size_t __nmemb, size_t __size,
377                              __compar_fn_t __compar));
378
379 /* Sort NMEMB elements of BASE, of SIZE bytes each,
380    using COMPAR to perform the comparisons.  */
381 extern void qsort __P ((__ptr_t __base, size_t __nmemb, size_t __size,
382                         __compar_fn_t __compar));
383
384
385 /* Return the absolute value of X.  */
386 extern int abs __P ((int __x)) __attribute__ ((__const__));
387 extern long int labs __P ((long int __x)) __attribute__ ((__const__));
388
389
390 /* Return the `div_t' or `ldiv_t' representation
391    of the value of NUMER over DENOM. */
392 /* GCC may have built-ins for these someday.  */
393 extern div_t div __P ((int __numer, int __denom)) __attribute__ ((__const__));
394 extern ldiv_t ldiv __P ((long int __numer, long int __denom)) __attribute__ ((__const__));
395
396
397 #ifdef __USE_SVID
398 /* Convert floating point numbers to strings.  The returned values are
399    valid only until another call to the same function.  */
400
401 /* Convert VALUE to a string with NDIGIT digits and return a pointer to
402    this.  Set *DECPT with the position of the decimal character and *SIGN
403    with the sign of the number.  */
404 char *ecvt __P ((double __value, int __ndigit, int *__decpt, int *sign));
405
406 /* Convert VALUE to a string rounded to NDIGIT decimal digits.  Set *DECPT
407    with the position of the decimal character and *SIGN with the sign of
408    the number.  */
409 char *fcvt __P ((double __value, int __ndigit, int *__decpt, int *sign));
410
411 /* If possible convert VALUE to a string with NDIGIT significant digits.
412    Otherwise use exponential representation.  The resulting string will
413    be written to BUF.  */
414 char *gcvt __P ((double __value, int __ndigit, char *__buf));
415
416 /* Reentrant version of the functions above which provide their own
417    buffers.  */
418 int ecvt_r __P ((double __value, int __ndigit, int *__decpt, int *sign,
419                  char *__buf, size_t __len));
420 int fcvt_r __P ((double __value, int __ndigit, int *__decpt, int *sign,
421                  char *__buf, size_t __len));
422 #endif
423
424
425 /* Return the length of the multibyte character
426    in S, which is no longer than N.  */
427 extern int mblen __P ((__const char *__s, size_t __n));
428 /* Return the length of the given multibyte character,
429    putting its `wchar_t' representation in *PWC.  */
430 extern int mbtowc __P ((wchar_t * __pwc, __const char *__s, size_t __n));
431 /* Put the multibyte character represented
432    by WCHAR in S, returning its length.  */
433 extern int wctomb __P ((char *__s, wchar_t __wchar));
434
435 #if defined (__OPTIMIZE__) && __GNUC__ >= 2
436 extern __inline int mblen (__const char *__s, size_t __n)
437 { return mbtowc ((wchar_t *) NULL, __s, __n); }
438 #endif /* Optimizing GCC >=2.  */
439
440
441 /* Convert a multibyte string to a wide char string.  */
442 extern size_t mbstowcs __P ((wchar_t * __pwcs, __const char *__s, size_t __n));
443 /* Convert a wide char string to multibyte string.  */
444 extern size_t wcstombs __P ((char *__s, __const wchar_t * __pwcs, size_t __n));
445
446
447 __END_DECLS
448
449 #endif /* stdlib.h  */