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