typo.
[glibc.git] / stdlib / stdlib.h
blob085130cafa6f8efed047071148de6ef8fed5e2c6
1 /* Copyright (C) 1991-2003, 2004, 2005 Free Software Foundation, Inc.
2 This file is part of the GNU C Library.
4 The GNU C Library is free software; you can redistribute it and/or
5 modify it under the terms of the GNU Lesser General Public
6 License as published by the Free Software Foundation; either
7 version 2.1 of the License, or (at your option) any later version.
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 Lesser General Public License for more details.
14 You should have received a copy of the GNU Lesser General Public
15 License along with the GNU C Library; if not, write to the Free
16 Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
17 02111-1307 USA. */
20 * ISO C99 Standard: 7.20 General utilities <stdlib.h>
23 #ifndef _STDLIB_H
25 #include <features.h>
27 /* Get size_t, wchar_t and NULL from <stddef.h>. */
28 #define __need_size_t
29 #ifndef __need_malloc_and_calloc
30 # define __need_wchar_t
31 # define __need_NULL
32 #endif
33 #include <stddef.h>
35 __BEGIN_DECLS
37 #ifndef __need_malloc_and_calloc
38 #define _STDLIB_H 1
40 #if defined __USE_XOPEN && !defined _SYS_WAIT_H
41 /* XPG requires a few symbols from <sys/wait.h> being defined. */
42 # include <bits/waitflags.h>
43 # include <bits/waitstatus.h>
45 # ifdef __USE_BSD
47 /* Lots of hair to allow traditional BSD use of `union wait'
48 as well as POSIX.1 use of `int' for the status word. */
50 # if defined __GNUC__ && !defined __cplusplus
51 # define __WAIT_INT(status) \
52 (__extension__ ({ union { __typeof(status) __in; int __i; } __u; \
53 __u.__in = (status); __u.__i; }))
54 # else
55 # define __WAIT_INT(status) (*(int *) &(status))
56 # endif
58 /* This is the type of the argument to `wait'. The funky union
59 causes redeclarations with ether `int *' or `union wait *' to be
60 allowed without complaint. __WAIT_STATUS_DEFN is the type used in
61 the actual function definitions. */
63 # if !defined __GNUC__ || __GNUC__ < 2 || defined __cplusplus
64 # define __WAIT_STATUS void *
65 # define __WAIT_STATUS_DEFN void *
66 # else
67 /* This works in GCC 2.6.1 and later. */
68 typedef union
70 union wait *__uptr;
71 int *__iptr;
72 } __WAIT_STATUS __attribute__ ((__transparent_union__));
73 # define __WAIT_STATUS_DEFN int *
74 # endif
76 # else /* Don't use BSD. */
78 # define __WAIT_INT(status) (status)
79 # define __WAIT_STATUS int *
80 # define __WAIT_STATUS_DEFN int *
82 # endif /* Use BSD. */
84 /* Define the macros <sys/wait.h> also would define this way. */
85 # define WEXITSTATUS(status) __WEXITSTATUS(__WAIT_INT(status))
86 # define WTERMSIG(status) __WTERMSIG(__WAIT_INT(status))
87 # define WSTOPSIG(status) __WSTOPSIG(__WAIT_INT(status))
88 # define WIFEXITED(status) __WIFEXITED(__WAIT_INT(status))
89 # define WIFSIGNALED(status) __WIFSIGNALED(__WAIT_INT(status))
90 # define WIFSTOPPED(status) __WIFSTOPPED(__WAIT_INT(status))
91 # ifdef __WIFCONTINUED
92 # define WIFCONTINUED(status) __WIFCONTINUED(__WAIT_INT(status))
93 # endif
94 #endif /* X/Open and <sys/wait.h> not included. */
96 __BEGIN_NAMESPACE_STD
97 /* Returned by `div'. */
98 typedef struct
100 int quot; /* Quotient. */
101 int rem; /* Remainder. */
102 } div_t;
104 /* Returned by `ldiv'. */
105 #ifndef __ldiv_t_defined
106 typedef struct
108 long int quot; /* Quotient. */
109 long int rem; /* Remainder. */
110 } ldiv_t;
111 # define __ldiv_t_defined 1
112 #endif
113 __END_NAMESPACE_STD
115 #if defined __USE_ISOC99 && !defined __lldiv_t_defined
116 __BEGIN_NAMESPACE_C99
117 /* Returned by `lldiv'. */
118 __extension__ typedef struct
120 long long int quot; /* Quotient. */
121 long long int rem; /* Remainder. */
122 } lldiv_t;
123 # define __lldiv_t_defined 1
124 __END_NAMESPACE_C99
125 #endif
128 /* The largest number rand will return (same as INT_MAX). */
129 #define RAND_MAX 2147483647
132 /* We define these the same for all machines.
133 Changes from this to the outside world should be done in `_exit'. */
134 #define EXIT_FAILURE 1 /* Failing exit status. */
135 #define EXIT_SUCCESS 0 /* Successful exit status. */
138 /* Maximum length of a multibyte character in the current locale. */
139 #define MB_CUR_MAX (__ctype_get_mb_cur_max ())
140 extern size_t __ctype_get_mb_cur_max (void) __THROW __wur;
143 __BEGIN_NAMESPACE_STD
144 /* Convert a string to a floating-point number. */
145 extern double atof (__const char *__nptr)
146 __THROW __attribute_pure__ __nonnull ((1)) __wur;
147 /* Convert a string to an integer. */
148 extern int atoi (__const char *__nptr)
149 __THROW __attribute_pure__ __nonnull ((1)) __wur;
150 /* Convert a string to a long integer. */
151 extern long int atol (__const char *__nptr)
152 __THROW __attribute_pure__ __nonnull ((1)) __wur;
153 __END_NAMESPACE_STD
155 #if defined __USE_ISOC99 || (defined __GLIBC_HAVE_LONG_LONG && defined __USE_MISC)
156 __BEGIN_NAMESPACE_C99
157 /* Convert a string to a long long integer. */
158 __extension__ extern long long int atoll (__const char *__nptr)
159 __THROW __attribute_pure__ __nonnull ((1)) __wur;
160 __END_NAMESPACE_C99
161 #endif
163 __BEGIN_NAMESPACE_STD
164 /* Convert a string to a floating-point number. */
165 extern double strtod (__const char *__restrict __nptr,
166 char **__restrict __endptr)
167 __THROW __nonnull ((1)) __wur;
168 __END_NAMESPACE_STD
170 #ifdef __USE_ISOC99
171 __BEGIN_NAMESPACE_C99
172 /* Likewise for `float' and `long double' sizes of floating-point numbers. */
173 extern float strtof (__const char *__restrict __nptr,
174 char **__restrict __endptr) __THROW __nonnull ((1)) __wur;
176 extern long double strtold (__const char *__restrict __nptr,
177 char **__restrict __endptr)
178 __THROW __nonnull ((1)) __wur;
179 __END_NAMESPACE_C99
180 #endif
182 __BEGIN_NAMESPACE_STD
183 /* Convert a string to a long integer. */
184 extern long int strtol (__const char *__restrict __nptr,
185 char **__restrict __endptr, int __base)
186 __THROW __nonnull ((1)) __wur;
187 /* Convert a string to an unsigned long integer. */
188 extern unsigned long int strtoul (__const char *__restrict __nptr,
189 char **__restrict __endptr, int __base)
190 __THROW __nonnull ((1)) __wur;
191 __END_NAMESPACE_STD
193 #if defined __GLIBC_HAVE_LONG_LONG && defined __USE_BSD
194 /* Convert a string to a quadword integer. */
195 __extension__
196 extern long long int strtoq (__const char *__restrict __nptr,
197 char **__restrict __endptr, int __base)
198 __THROW __nonnull ((1)) __wur;
199 /* Convert a string to an unsigned quadword integer. */
200 __extension__
201 extern unsigned long long int strtouq (__const char *__restrict __nptr,
202 char **__restrict __endptr, int __base)
203 __THROW __nonnull ((1)) __wur;
204 #endif /* GCC and use BSD. */
206 #if defined __USE_ISOC99 || (defined __GLIBC_HAVE_LONG_LONG && defined __USE_MISC)
207 __BEGIN_NAMESPACE_C99
208 /* Convert a string to a quadword integer. */
209 __extension__
210 extern long long int strtoll (__const char *__restrict __nptr,
211 char **__restrict __endptr, int __base)
212 __THROW __nonnull ((1)) __wur;
213 /* Convert a string to an unsigned quadword integer. */
214 __extension__
215 extern unsigned long long int strtoull (__const char *__restrict __nptr,
216 char **__restrict __endptr, int __base)
217 __THROW __nonnull ((1)) __wur;
218 __END_NAMESPACE_C99
219 #endif /* ISO C99 or GCC and use MISC. */
222 #ifdef __USE_GNU
223 /* The concept of one static locale per category is not very well
224 thought out. Many applications will need to process its data using
225 information from several different locales. Another application is
226 the implementation of the internationalization handling in the
227 upcoming ISO C++ standard library. To support this another set of
228 the functions using locale data exist which have an additional
229 argument.
231 Attention: all these functions are *not* standardized in any form.
232 This is a proof-of-concept implementation. */
234 /* Structure for reentrant locale using functions. This is an
235 (almost) opaque type for the user level programs. */
236 # include <xlocale.h>
238 /* Special versions of the functions above which take the locale to
239 use as an additional parameter. */
240 extern long int strtol_l (__const char *__restrict __nptr,
241 char **__restrict __endptr, int __base,
242 __locale_t __loc) __THROW __nonnull ((1, 4)) __wur;
244 extern unsigned long int strtoul_l (__const char *__restrict __nptr,
245 char **__restrict __endptr,
246 int __base, __locale_t __loc)
247 __THROW __nonnull ((1, 4)) __wur;
249 __extension__
250 extern long long int strtoll_l (__const char *__restrict __nptr,
251 char **__restrict __endptr, int __base,
252 __locale_t __loc)
253 __THROW __nonnull ((1, 4)) __wur;
255 __extension__
256 extern unsigned long long int strtoull_l (__const char *__restrict __nptr,
257 char **__restrict __endptr,
258 int __base, __locale_t __loc)
259 __THROW __nonnull ((1, 4)) __wur;
261 extern double strtod_l (__const char *__restrict __nptr,
262 char **__restrict __endptr, __locale_t __loc)
263 __THROW __nonnull ((1, 3)) __wur;
265 extern float strtof_l (__const char *__restrict __nptr,
266 char **__restrict __endptr, __locale_t __loc)
267 __THROW __nonnull ((1, 3)) __wur;
269 extern long double strtold_l (__const char *__restrict __nptr,
270 char **__restrict __endptr,
271 __locale_t __loc)
272 __THROW __nonnull ((1, 3)) __wur;
273 #endif /* GNU */
276 /* The internal entry points for `strtoX' take an extra flag argument
277 saying whether or not to parse locale-dependent number grouping. */
279 extern double __strtod_internal (__const char *__restrict __nptr,
280 char **__restrict __endptr, int __group)
281 __THROW __nonnull ((1)) __wur;
282 extern float __strtof_internal (__const char *__restrict __nptr,
283 char **__restrict __endptr, int __group)
284 __THROW __nonnull ((1)) __wur;
285 extern long double __strtold_internal (__const char *__restrict __nptr,
286 char **__restrict __endptr,
287 int __group)
288 __THROW __nonnull ((1)) __wur;
289 #ifndef __strtol_internal_defined
290 extern long int __strtol_internal (__const char *__restrict __nptr,
291 char **__restrict __endptr,
292 int __base, int __group)
293 __THROW __nonnull ((1)) __wur;
294 # define __strtol_internal_defined 1
295 #endif
296 #ifndef __strtoul_internal_defined
297 extern unsigned long int __strtoul_internal (__const char *__restrict __nptr,
298 char **__restrict __endptr,
299 int __base, int __group)
300 __THROW __nonnull ((1)) __wur;
301 # define __strtoul_internal_defined 1
302 #endif
303 #if defined __GNUC__ || defined __USE_ISOC99
304 # ifndef __strtoll_internal_defined
305 __extension__
306 extern long long int __strtoll_internal (__const char *__restrict __nptr,
307 char **__restrict __endptr,
308 int __base, int __group)
309 __THROW __nonnull ((1)) __wur;
310 # define __strtoll_internal_defined 1
311 # endif
312 # ifndef __strtoull_internal_defined
313 __extension__
314 extern unsigned long long int __strtoull_internal (__const char *
315 __restrict __nptr,
316 char **__restrict __endptr,
317 int __base, int __group)
318 __THROW __nonnull ((1)) __wur;
319 # define __strtoull_internal_defined 1
320 # endif
321 #endif /* GCC */
323 #ifdef __USE_EXTERN_INLINES
324 /* Define inline functions which call the internal entry points. */
326 __BEGIN_NAMESPACE_STD
327 extern __inline double
328 __NTH (strtod (__const char *__restrict __nptr, char **__restrict __endptr))
330 return __strtod_internal (__nptr, __endptr, 0);
332 extern __inline long int
333 __NTH (strtol (__const char *__restrict __nptr, char **__restrict __endptr,
334 int __base))
336 return __strtol_internal (__nptr, __endptr, __base, 0);
338 extern __inline unsigned long int
339 __NTH (strtoul (__const char *__restrict __nptr, char **__restrict __endptr,
340 int __base))
342 return __strtoul_internal (__nptr, __endptr, __base, 0);
344 __END_NAMESPACE_STD
346 # ifdef __USE_ISOC99
347 __BEGIN_NAMESPACE_C99
348 extern __inline float
349 __NTH (strtof (__const char *__restrict __nptr, char **__restrict __endptr))
351 return __strtof_internal (__nptr, __endptr, 0);
353 extern __inline long double
354 __NTH (strtold (__const char *__restrict __nptr, char **__restrict __endptr))
356 return __strtold_internal (__nptr, __endptr, 0);
358 __END_NAMESPACE_C99
359 # endif
361 # ifdef __USE_BSD
362 __extension__ extern __inline long long int
363 __NTH (strtoq (__const char *__restrict __nptr, char **__restrict __endptr,
364 int __base))
366 return __strtoll_internal (__nptr, __endptr, __base, 0);
368 __extension__ extern __inline unsigned long long int
369 __NTH (strtouq (__const char *__restrict __nptr, char **__restrict __endptr,
370 int __base))
372 return __strtoull_internal (__nptr, __endptr, __base, 0);
374 # endif
376 # if defined __USE_MISC || defined __USE_ISOC99
377 __BEGIN_NAMESPACE_C99
378 __extension__ extern __inline long long int
379 __NTH (strtoll (__const char *__restrict __nptr, char **__restrict __endptr,
380 int __base))
382 return __strtoll_internal (__nptr, __endptr, __base, 0);
384 __extension__ extern __inline unsigned long long int
385 __NTH (strtoull (__const char * __restrict __nptr, char **__restrict __endptr,
386 int __base))
388 return __strtoull_internal (__nptr, __endptr, __base, 0);
390 __END_NAMESPACE_C99
391 # endif
393 __BEGIN_NAMESPACE_STD
394 extern __inline double
395 __NTH (atof (__const char *__nptr))
397 return strtod (__nptr, (char **) NULL);
399 extern __inline int
400 __NTH (atoi (__const char *__nptr))
402 return (int) strtol (__nptr, (char **) NULL, 10);
404 extern __inline long int
405 __NTH (atol (__const char *__nptr))
407 return strtol (__nptr, (char **) NULL, 10);
409 __END_NAMESPACE_STD
411 # if defined __USE_MISC || defined __USE_ISOC99
412 __BEGIN_NAMESPACE_C99
413 __extension__ extern __inline long long int
414 __NTH (atoll (__const char *__nptr))
416 return strtoll (__nptr, (char **) NULL, 10);
418 __END_NAMESPACE_C99
419 # endif
420 #endif /* Optimizing and Inlining. */
423 #if defined __USE_SVID || defined __USE_XOPEN_EXTENDED
424 /* Convert N to base 64 using the digits "./0-9A-Za-z", least-significant
425 digit first. Returns a pointer to static storage overwritten by the
426 next call. */
427 extern char *l64a (long int __n) __THROW __wur;
429 /* Read a number from a string S in base 64 as above. */
430 extern long int a64l (__const char *__s)
431 __THROW __attribute_pure__ __nonnull ((1)) __wur;
433 #endif /* Use SVID || extended X/Open. */
435 #if defined __USE_SVID || defined __USE_XOPEN_EXTENDED || defined __USE_BSD
436 # include <sys/types.h> /* we need int32_t... */
438 /* These are the functions that actually do things. The `random', `srandom',
439 `initstate' and `setstate' functions are those from BSD Unices.
440 The `rand' and `srand' functions are required by the ANSI standard.
441 We provide both interfaces to the same random number generator. */
442 /* Return a random long integer between 0 and RAND_MAX inclusive. */
443 extern long int random (void) __THROW;
445 /* Seed the random number generator with the given number. */
446 extern void srandom (unsigned int __seed) __THROW;
448 /* Initialize the random number generator to use state buffer STATEBUF,
449 of length STATELEN, and seed it with SEED. Optimal lengths are 8, 16,
450 32, 64, 128 and 256, the bigger the better; values less than 8 will
451 cause an error and values greater than 256 will be rounded down. */
452 extern char *initstate (unsigned int __seed, char *__statebuf,
453 size_t __statelen) __THROW __nonnull ((2));
455 /* Switch the random number generator to state buffer STATEBUF,
456 which should have been previously initialized by `initstate'. */
457 extern char *setstate (char *__statebuf) __THROW __nonnull ((1));
460 # ifdef __USE_MISC
461 /* Reentrant versions of the `random' family of functions.
462 These functions all use the following data structure to contain
463 state, rather than global state variables. */
465 struct random_data
467 int32_t *fptr; /* Front pointer. */
468 int32_t *rptr; /* Rear pointer. */
469 int32_t *state; /* Array of state values. */
470 int rand_type; /* Type of random number generator. */
471 int rand_deg; /* Degree of random number generator. */
472 int rand_sep; /* Distance between front and rear. */
473 int32_t *end_ptr; /* Pointer behind state table. */
476 extern int random_r (struct random_data *__restrict __buf,
477 int32_t *__restrict __result) __THROW __nonnull ((1, 2));
479 extern int srandom_r (unsigned int __seed, struct random_data *__buf)
480 __THROW __nonnull ((2));
482 extern int initstate_r (unsigned int __seed, char *__restrict __statebuf,
483 size_t __statelen,
484 struct random_data *__restrict __buf)
485 __THROW __nonnull ((2, 4));
487 extern int setstate_r (char *__restrict __statebuf,
488 struct random_data *__restrict __buf)
489 __THROW __nonnull ((1, 2));
490 # endif /* Use misc. */
491 #endif /* Use SVID || extended X/Open || BSD. */
494 __BEGIN_NAMESPACE_STD
495 /* Return a random integer between 0 and RAND_MAX inclusive. */
496 extern int rand (void) __THROW;
497 /* Seed the random number generator with the given number. */
498 extern void srand (unsigned int __seed) __THROW;
499 __END_NAMESPACE_STD
501 #ifdef __USE_POSIX
502 /* Reentrant interface according to POSIX.1. */
503 extern int rand_r (unsigned int *__seed) __THROW;
504 #endif
507 #if defined __USE_SVID || defined __USE_XOPEN
508 /* System V style 48-bit random number generator functions. */
510 /* Return non-negative, double-precision floating-point value in [0.0,1.0). */
511 extern double drand48 (void) __THROW;
512 extern double erand48 (unsigned short int __xsubi[3]) __THROW __nonnull ((1));
514 /* Return non-negative, long integer in [0,2^31). */
515 extern long int lrand48 (void) __THROW;
516 extern long int nrand48 (unsigned short int __xsubi[3])
517 __THROW __nonnull ((1));
519 /* Return signed, long integers in [-2^31,2^31). */
520 extern long int mrand48 (void) __THROW;
521 extern long int jrand48 (unsigned short int __xsubi[3])
522 __THROW __nonnull ((1));
524 /* Seed random number generator. */
525 extern void srand48 (long int __seedval) __THROW;
526 extern unsigned short int *seed48 (unsigned short int __seed16v[3])
527 __THROW __nonnull ((1));
528 extern void lcong48 (unsigned short int __param[7]) __THROW __nonnull ((1));
530 # ifdef __USE_MISC
531 /* Data structure for communication with thread safe versions. This
532 type is to be regarded as opaque. It's only exported because users
533 have to allocate objects of this type. */
534 struct drand48_data
536 unsigned short int __x[3]; /* Current state. */
537 unsigned short int __old_x[3]; /* Old state. */
538 unsigned short int __c; /* Additive const. in congruential formula. */
539 unsigned short int __init; /* Flag for initializing. */
540 unsigned long long int __a; /* Factor in congruential formula. */
543 /* Return non-negative, double-precision floating-point value in [0.0,1.0). */
544 extern int drand48_r (struct drand48_data *__restrict __buffer,
545 double *__restrict __result) __THROW __nonnull ((1, 2));
546 extern int erand48_r (unsigned short int __xsubi[3],
547 struct drand48_data *__restrict __buffer,
548 double *__restrict __result) __THROW __nonnull ((1, 2));
550 /* Return non-negative, long integer in [0,2^31). */
551 extern int lrand48_r (struct drand48_data *__restrict __buffer,
552 long int *__restrict __result)
553 __THROW __nonnull ((1, 2));
554 extern int nrand48_r (unsigned short int __xsubi[3],
555 struct drand48_data *__restrict __buffer,
556 long int *__restrict __result)
557 __THROW __nonnull ((1, 2));
559 /* Return signed, long integers in [-2^31,2^31). */
560 extern int mrand48_r (struct drand48_data *__restrict __buffer,
561 long int *__restrict __result)
562 __THROW __nonnull ((1, 2));
563 extern int jrand48_r (unsigned short int __xsubi[3],
564 struct drand48_data *__restrict __buffer,
565 long int *__restrict __result)
566 __THROW __nonnull ((1, 2));
568 /* Seed random number generator. */
569 extern int srand48_r (long int __seedval, struct drand48_data *__buffer)
570 __THROW __nonnull ((2));
572 extern int seed48_r (unsigned short int __seed16v[3],
573 struct drand48_data *__buffer) __THROW __nonnull ((1, 2));
575 extern int lcong48_r (unsigned short int __param[7],
576 struct drand48_data *__buffer)
577 __THROW __nonnull ((1, 2));
578 # endif /* Use misc. */
579 #endif /* Use SVID or X/Open. */
581 #endif /* don't just need malloc and calloc */
583 #ifndef __malloc_and_calloc_defined
584 # define __malloc_and_calloc_defined
585 __BEGIN_NAMESPACE_STD
586 /* Allocate SIZE bytes of memory. */
587 extern void *malloc (size_t __size) __THROW __attribute_malloc__ __wur;
588 /* Allocate NMEMB elements of SIZE bytes each, all initialized to 0. */
589 extern void *calloc (size_t __nmemb, size_t __size)
590 __THROW __attribute_malloc__ __wur;
591 __END_NAMESPACE_STD
592 #endif
594 #ifndef __need_malloc_and_calloc
595 __BEGIN_NAMESPACE_STD
596 /* Re-allocate the previously allocated block
597 in PTR, making the new block SIZE bytes long. */
598 extern void *realloc (void *__ptr, size_t __size)
599 __THROW __attribute_malloc__ __attribute_warn_unused_result__;
600 /* Free a block allocated by `malloc', `realloc' or `calloc'. */
601 extern void free (void *__ptr) __THROW;
602 __END_NAMESPACE_STD
604 #ifdef __USE_MISC
605 /* Free a block. An alias for `free'. (Sun Unices). */
606 extern void cfree (void *__ptr) __THROW;
607 #endif /* Use misc. */
609 #if defined __USE_GNU || defined __USE_BSD || defined __USE_MISC
610 # include <alloca.h>
611 #endif /* Use GNU, BSD, or misc. */
613 #if defined __USE_BSD || defined __USE_XOPEN_EXTENDED
614 /* Allocate SIZE bytes on a page boundary. The storage cannot be freed. */
615 extern void *valloc (size_t __size) __THROW __attribute_malloc__ __wur;
616 #endif
618 #ifdef __USE_XOPEN2K
619 /* Allocate memory of SIZE bytes with an alignment of ALIGNMENT. */
620 extern int posix_memalign (void **__memptr, size_t __alignment, size_t __size)
621 __THROW __nonnull ((1)) __wur;
622 #endif
624 __BEGIN_NAMESPACE_STD
625 /* Abort execution and generate a core-dump. */
626 extern void abort (void) __THROW __attribute__ ((__noreturn__));
629 /* Register a function to be called when `exit' is called. */
630 extern int atexit (void (*__func) (void)) __THROW __nonnull ((1));
631 __END_NAMESPACE_STD
633 #ifdef __USE_MISC
634 /* Register a function to be called with the status
635 given to `exit' and the given argument. */
636 extern int on_exit (void (*__func) (int __status, void *__arg), void *__arg)
637 __THROW __nonnull ((1));
638 #endif
640 __BEGIN_NAMESPACE_STD
641 /* Call all functions registered with `atexit' and `on_exit',
642 in the reverse of the order in which they were registered
643 perform stdio cleanup, and terminate program execution with STATUS. */
644 extern void exit (int __status) __THROW __attribute__ ((__noreturn__));
645 __END_NAMESPACE_STD
647 #ifdef __USE_ISOC99
648 __BEGIN_NAMESPACE_C99
649 /* Terminate the program with STATUS without calling any of the
650 functions registered with `atexit' or `on_exit'. */
651 extern void _Exit (int __status) __THROW __attribute__ ((__noreturn__));
652 __END_NAMESPACE_C99
653 #endif
656 __BEGIN_NAMESPACE_STD
657 /* Return the value of envariable NAME, or NULL if it doesn't exist. */
658 extern char *getenv (__const char *__name) __THROW __nonnull ((1)) __wur;
659 __END_NAMESPACE_STD
661 /* This function is similar to the above but returns NULL if the
662 programs is running with SUID or SGID enabled. */
663 extern char *__secure_getenv (__const char *__name)
664 __THROW __nonnull ((1)) __wur;
666 #if defined __USE_SVID || defined __USE_XOPEN
667 /* The SVID says this is in <stdio.h>, but this seems a better place. */
668 /* Put STRING, which is of the form "NAME=VALUE", in the environment.
669 If there is no `=', remove NAME from the environment. */
670 extern int putenv (char *__string) __THROW __nonnull ((1));
671 #endif
673 #if defined __USE_BSD || defined __USE_XOPEN2K
674 /* Set NAME to VALUE in the environment.
675 If REPLACE is nonzero, overwrite an existing value. */
676 extern int setenv (__const char *__name, __const char *__value, int __replace)
677 __THROW __nonnull ((2));
679 /* Remove the variable NAME from the environment. */
680 extern int unsetenv (__const char *__name) __THROW;
681 #endif
683 #ifdef __USE_MISC
684 /* The `clearenv' was planned to be added to POSIX.1 but probably
685 never made it. Nevertheless the POSIX.9 standard (POSIX bindings
686 for Fortran 77) requires this function. */
687 extern int clearenv (void) __THROW;
688 #endif
691 #if defined __USE_MISC || defined __USE_XOPEN_EXTENDED
692 /* Generate a unique temporary file name from TEMPLATE.
693 The last six characters of TEMPLATE must be "XXXXXX";
694 they are replaced with a string that makes the file name unique.
695 Returns TEMPLATE, or a null pointer if it cannot get a unique file name. */
696 extern char *mktemp (char *__template) __THROW __nonnull ((1)) __wur;
698 /* Generate a unique temporary file name from TEMPLATE.
699 The last six characters of TEMPLATE must be "XXXXXX";
700 they are replaced with a string that makes the filename unique.
701 Returns a file descriptor open on the file for reading and writing,
702 or -1 if it cannot create a uniquely-named file.
704 This function is a possible cancellation points and therefore not
705 marked with __THROW. */
706 # ifndef __USE_FILE_OFFSET64
707 extern int mkstemp (char *__template) __nonnull ((1)) __wur;
708 # else
709 # ifdef __REDIRECT
710 extern int __REDIRECT (mkstemp, (char *__template), mkstemp64)
711 __nonnull ((1)) __wur;
712 # else
713 # define mkstemp mkstemp64
714 # endif
715 # endif
716 # ifdef __USE_LARGEFILE64
717 extern int mkstemp64 (char *__template) __nonnull ((1)) __wur;
718 # endif
719 #endif
721 #ifdef __USE_BSD
722 /* Create a unique temporary directory from TEMPLATE.
723 The last six characters of TEMPLATE must be "XXXXXX";
724 they are replaced with a string that makes the directory name unique.
725 Returns TEMPLATE, or a null pointer if it cannot get a unique name.
726 The directory is created mode 700. */
727 extern char *mkdtemp (char *__template) __THROW __nonnull ((1)) __wur;
728 #endif
731 __BEGIN_NAMESPACE_STD
732 /* Execute the given line as a shell command.
734 This function is a cancellation point and therefore not marked with
735 __THROW. */
736 extern int system (__const char *__command) __wur;
737 __END_NAMESPACE_STD
740 #ifdef __USE_GNU
741 /* Return a malloc'd string containing the canonical absolute name of the
742 named file. The last file name component need not exist, and may be a
743 symlink to a nonexistent file. */
744 extern char *canonicalize_file_name (__const char *__name)
745 __THROW __nonnull ((1)) __wur;
746 #endif
748 #if defined __USE_BSD || defined __USE_XOPEN_EXTENDED
749 /* Return the canonical absolute name of file NAME. The last file name
750 component need not exist, and may be a symlink to a nonexistent file.
751 If RESOLVED is null, the result is malloc'd; otherwise, if the canonical
752 name is PATH_MAX chars or more, returns null with `errno' set to
753 ENAMETOOLONG; if the name fits in fewer than PATH_MAX chars, returns the
754 name in RESOLVED. */
755 extern char *realpath (__const char *__restrict __name,
756 char *__restrict __resolved) __THROW __wur;
757 #endif
760 /* Shorthand for type of comparison functions. */
761 #ifndef __COMPAR_FN_T
762 # define __COMPAR_FN_T
763 typedef int (*__compar_fn_t) (__const void *, __const void *);
765 # ifdef __USE_GNU
766 typedef __compar_fn_t comparison_fn_t;
767 # endif
768 #endif
770 __BEGIN_NAMESPACE_STD
771 /* Do a binary search for KEY in BASE, which consists of NMEMB elements
772 of SIZE bytes each, using COMPAR to perform the comparisons. */
773 extern void *bsearch (__const void *__key, __const void *__base,
774 size_t __nmemb, size_t __size, __compar_fn_t __compar)
775 __nonnull ((1, 2, 5)) __wur;
777 /* Sort NMEMB elements of BASE, of SIZE bytes each,
778 using COMPAR to perform the comparisons. */
779 extern void qsort (void *__base, size_t __nmemb, size_t __size,
780 __compar_fn_t __compar) __nonnull ((1, 4));
783 /* Return the absolute value of X. */
784 extern int abs (int __x) __THROW __attribute__ ((__const__)) __wur;
785 extern long int labs (long int __x) __THROW __attribute__ ((__const__)) __wur;
786 __END_NAMESPACE_STD
788 #ifdef __USE_ISOC99
789 __extension__ extern long long int llabs (long long int __x)
790 __THROW __attribute__ ((__const__)) __wur;
791 #endif
794 __BEGIN_NAMESPACE_STD
795 /* Return the `div_t', `ldiv_t' or `lldiv_t' representation
796 of the value of NUMER over DENOM. */
797 /* GCC may have built-ins for these someday. */
798 extern div_t div (int __numer, int __denom)
799 __THROW __attribute__ ((__const__)) __wur;
800 extern ldiv_t ldiv (long int __numer, long int __denom)
801 __THROW __attribute__ ((__const__)) __wur;
802 __END_NAMESPACE_STD
804 #ifdef __USE_ISOC99
805 __BEGIN_NAMESPACE_C99
806 __extension__ extern lldiv_t lldiv (long long int __numer,
807 long long int __denom)
808 __THROW __attribute__ ((__const__)) __wur;
809 __END_NAMESPACE_C99
810 #endif
813 #if defined __USE_SVID || defined __USE_XOPEN_EXTENDED
814 /* Convert floating point numbers to strings. The returned values are
815 valid only until another call to the same function. */
817 /* Convert VALUE to a string with NDIGIT digits and return a pointer to
818 this. Set *DECPT with the position of the decimal character and *SIGN
819 with the sign of the number. */
820 extern char *ecvt (double __value, int __ndigit, int *__restrict __decpt,
821 int *__restrict __sign) __THROW __nonnull ((3, 4)) __wur;
823 /* Convert VALUE to a string rounded to NDIGIT decimal digits. Set *DECPT
824 with the position of the decimal character and *SIGN with the sign of
825 the number. */
826 extern char *fcvt (double __value, int __ndigit, int *__restrict __decpt,
827 int *__restrict __sign) __THROW __nonnull ((3, 4)) __wur;
829 /* If possible convert VALUE to a string with NDIGIT significant digits.
830 Otherwise use exponential representation. The resulting string will
831 be written to BUF. */
832 extern char *gcvt (double __value, int __ndigit, char *__buf)
833 __THROW __nonnull ((3)) __wur;
836 # ifdef __USE_MISC
837 /* Long double versions of above functions. */
838 extern char *qecvt (long double __value, int __ndigit,
839 int *__restrict __decpt, int *__restrict __sign)
840 __THROW __nonnull ((3, 4)) __wur;
841 extern char *qfcvt (long double __value, int __ndigit,
842 int *__restrict __decpt, int *__restrict __sign)
843 __THROW __nonnull ((3, 4)) __wur;
844 extern char *qgcvt (long double __value, int __ndigit, char *__buf)
845 __THROW __nonnull ((3)) __wur;
848 /* Reentrant version of the functions above which provide their own
849 buffers. */
850 extern int ecvt_r (double __value, int __ndigit, int *__restrict __decpt,
851 int *__restrict __sign, char *__restrict __buf,
852 size_t __len) __THROW __nonnull ((3, 4, 5));
853 extern int fcvt_r (double __value, int __ndigit, int *__restrict __decpt,
854 int *__restrict __sign, char *__restrict __buf,
855 size_t __len) __THROW __nonnull ((3, 4, 5));
857 extern int qecvt_r (long double __value, int __ndigit,
858 int *__restrict __decpt, int *__restrict __sign,
859 char *__restrict __buf, size_t __len)
860 __THROW __nonnull ((3, 4, 5));
861 extern int qfcvt_r (long double __value, int __ndigit,
862 int *__restrict __decpt, int *__restrict __sign,
863 char *__restrict __buf, size_t __len)
864 __THROW __nonnull ((3, 4, 5));
865 # endif /* misc */
866 #endif /* use MISC || use X/Open Unix */
869 __BEGIN_NAMESPACE_STD
870 /* Return the length of the multibyte character
871 in S, which is no longer than N. */
872 extern int mblen (__const char *__s, size_t __n) __THROW __wur;
873 /* Return the length of the given multibyte character,
874 putting its `wchar_t' representation in *PWC. */
875 extern int mbtowc (wchar_t *__restrict __pwc,
876 __const char *__restrict __s, size_t __n) __THROW __wur;
877 /* Put the multibyte character represented
878 by WCHAR in S, returning its length. */
879 extern int wctomb (char *__s, wchar_t __wchar) __THROW __wur;
882 /* Convert a multibyte string to a wide char string. */
883 extern size_t mbstowcs (wchar_t *__restrict __pwcs,
884 __const char *__restrict __s, size_t __n) __THROW;
885 /* Convert a wide char string to multibyte string. */
886 extern size_t wcstombs (char *__restrict __s,
887 __const wchar_t *__restrict __pwcs, size_t __n)
888 __THROW;
889 __END_NAMESPACE_STD
892 #ifdef __USE_SVID
893 /* Determine whether the string value of RESPONSE matches the affirmation
894 or negative response expression as specified by the LC_MESSAGES category
895 in the program's current locale. Returns 1 if affirmative, 0 if
896 negative, and -1 if not matching. */
897 extern int rpmatch (__const char *__response) __THROW __nonnull ((1)) __wur;
898 #endif
901 #ifdef __USE_XOPEN_EXTENDED
902 /* Parse comma separated suboption from *OPTIONP and match against
903 strings in TOKENS. If found return index and set *VALUEP to
904 optional value introduced by an equal sign. If the suboption is
905 not part of TOKENS return in *VALUEP beginning of unknown
906 suboption. On exit *OPTIONP is set to the beginning of the next
907 token or at the terminating NUL character. */
908 extern int getsubopt (char **__restrict __optionp,
909 char *__const *__restrict __tokens,
910 char **__restrict __valuep)
911 __THROW __nonnull ((1, 2, 3)) __wur;
912 #endif
915 #ifdef __USE_XOPEN
916 /* Setup DES tables according KEY. */
917 extern void setkey (__const char *__key) __THROW __nonnull ((1));
918 #endif
921 /* X/Open pseudo terminal handling. */
923 #ifdef __USE_XOPEN2K
924 /* Return a master pseudo-terminal handle. */
925 extern int posix_openpt (int __oflag) __wur;
926 #endif
928 #ifdef __USE_XOPEN
929 /* The next four functions all take a master pseudo-tty fd and
930 perform an operation on the associated slave: */
932 /* Chown the slave to the calling user. */
933 extern int grantpt (int __fd) __THROW;
935 /* Release an internal lock so the slave can be opened.
936 Call after grantpt(). */
937 extern int unlockpt (int __fd) __THROW;
939 /* Return the pathname of the pseudo terminal slave assoicated with
940 the master FD is open on, or NULL on errors.
941 The returned storage is good until the next call to this function. */
942 extern char *ptsname (int __fd) __THROW __wur;
943 #endif
945 #ifdef __USE_GNU
946 /* Store at most BUFLEN characters of the pathname of the slave pseudo
947 terminal associated with the master FD is open on in BUF.
948 Return 0 on success, otherwise an error number. */
949 extern int ptsname_r (int __fd, char *__buf, size_t __buflen)
950 __THROW __nonnull ((2));
952 /* Open a master pseudo terminal and return its file descriptor. */
953 extern int getpt (void);
954 #endif
956 #ifdef __USE_BSD
957 /* Put the 1 minute, 5 minute and 15 minute load averages into the first
958 NELEM elements of LOADAVG. Return the number written (never more than
959 three, but may be less than NELEM), or -1 if an error occurred. */
960 extern int getloadavg (double __loadavg[], int __nelem)
961 __THROW __nonnull ((1));
962 #endif
965 /* Define some macros helping to catch buffer overflows. */
966 #if __USE_FORTIFY_LEVEL > 0 && !defined __cplusplus
967 # include <bits/stdlib.h>
968 #endif
970 #endif /* don't just need malloc and calloc */
971 #undef __need_malloc_and_calloc
973 __END_DECLS
975 #endif /* stdlib.h */