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