(ecvt_r, fcvt_r): Fix type of last arg: make it size_t.
[kopensolaris-gnu/glibc.git] / stdlib / stdlib.h
1 /* Copyright (C) 1991, 1992, 1993, 1994, 1995 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 /* Return a random integer between 0 and RAND_MAX inclusive.  */
160 extern int rand __P ((void));
161 /* Seed the random number generator with the given number.  */
162 extern void srand __P ((unsigned int __seed));
163
164 /* These are the functions that actually do things.  The `random', `srandom',
165    `initstate' and `setstate' functions are those from BSD Unices.
166    The `rand' and `srand' functions are required by the ANSI standard.
167    We provide both interfaces to the same random number generator.  */
168 /* Return a random long integer between 0 and RAND_MAX inclusive.  */
169 extern long int __random __P ((void));
170 /* Seed the random number generator with the given number.  */
171 extern void __srandom __P ((unsigned int __seed));
172
173 /* Initialize the random number generator to use state buffer STATEBUF,
174    of length STATELEN, and seed it with SEED.  Optimal lengths are 8, 16,
175    32, 64, 128 and 256, the bigger the better; values less than 8 will
176    cause an error and values greater than 256 will be rounded down.  */
177 extern __ptr_t __initstate __P ((unsigned int __seed, __ptr_t __statebuf,
178                                  size_t __statelen));
179 /* Switch the random number generator to state buffer STATEBUF,
180    which should have been previously initialized by `initstate'.  */
181 extern __ptr_t __setstate __P ((__ptr_t __statebuf));
182
183 #ifdef  __USE_BSD
184 extern long int random __P ((void));
185 extern void srandom __P ((unsigned int __seed));
186 extern __ptr_t initstate __P ((unsigned int __seed, __ptr_t __statebuf,
187                                size_t __statelen));
188 extern __ptr_t setstate __P ((__ptr_t __statebuf));
189
190 #if defined (__OPTIMIZE__) && __GNUC__ >= 2
191 extern __inline long int random (void)
192 { return __random(); }
193 extern __inline void srandom (unsigned int __seed)
194 { __srandom(__seed); }
195 extern __inline __ptr_t initstate (unsigned int __seed,
196                                    __ptr_t __statebuf, size_t __statelen)
197 { return __initstate (__seed, __statebuf, __statelen); }
198 extern __inline __ptr_t setstate (__ptr_t __statebuf)
199 { return __setstate (__statebuf); }
200 #endif /* Optimizing GCC >=2.  */
201
202 #ifdef __USE_REENTRANT
203 /* Reentrant versions of the `random' family of functions.
204    These functions all use the following data structure to contain
205    state, rather than global state variables.  */
206
207 struct random_data
208   {
209     long int *fptr;             /* Front pointer.  */
210     long int *rptr;             /* Rear pointer.  */
211     long int *state;            /* Array of state values.  */
212     int rand_type;              /* Type of random number generator.  */
213     int rand_deg;               /* Degree of random number generator.  */
214     int rand_sep;               /* Distance between front and rear.  */
215     long int *end_ptr;          /* Pointer behind state table.  */
216   };
217
218 extern int __random_r __P ((struct random_data *__buf, long int *__result));
219 extern int __srandom_r __P ((unsigned int __seed, struct random_data *__buf));
220 extern int __initstate_r __P ((unsigned int __seed, __ptr_t __statebuf,
221                                size_t __statelen, struct random_data *__buf));
222 extern int __setstate_r __P ((__ptr_t __statebuf, struct random_data *__buf));
223
224 extern int random_r __P ((struct random_data *__buf, long int *__result));
225 extern int srandom_r __P ((unsigned int __seed, struct random_data *__buf));
226 extern int initstate_r __P ((unsigned int __seed, __ptr_t __statebuf,
227                              size_t __statelen, struct random_data *__buf));
228 extern int setstate_r __P ((__ptr_t __statebuf, struct random_data *__buf));
229 #endif  /* __USE_REENTRANT.  */
230 #endif  /* Use BSD.  */
231
232
233 #ifdef  __USE_SVID
234 /* System V style 48-bit random number generator functions.  */
235
236 /* Data structure for communication with thread safe versions.  */
237 struct drand48_data
238   {
239     unsigned short int X[3];    /* Current state.  */
240     unsigned short int a[3];    /* Factor in congruential formula.  */
241     unsigned short int c;       /* Additive const. in congruential formula.  */
242     unsigned short int old_X[3]; /* Old state.  */
243     int init;                   /* Flag for initializing.  */
244   };
245
246 /* Return non-negative, double-precision floating-point value in [0.0,1.0).  */
247 extern double drand48 __P ((void));
248 extern int drand48_r __P ((struct drand48_data *__buffer, double *__result));
249 extern double erand48 __P ((unsigned short int __xsubi[3]));
250 extern int erand48_r __P ((unsigned short int __xsubi[3],
251                            struct drand48_data *__buffer, double *__result));
252 /* Return non-negative, long integer in [0,2^31).  */
253 extern long lrand48 __P ((void));
254 extern int lrand48_r __P ((struct drand48_data *__buffer, long *__result));
255 extern long nrand48 __P ((unsigned short int __xsubi[3]));
256 extern int nrand48_r __P ((unsigned short int __xsubi[3],
257                            struct drand48_data *__buffer, long *__result));
258 /* Return signed, long integers in [-2^31,2^31).  */
259 extern long mrand48 __P ((void));
260 extern int mrand48_r __P ((struct drand48_data *__buffer, long *__result));
261 extern long jrand48 __P ((unsigned short int __xsubi[3]));
262 extern int jrand48_r __P ((unsigned short int __xsubi[3],
263                            struct drand48_data *__buffer, long *__result));
264 /* Seed random number generator.  */
265 extern void srand48 __P ((long __seedval));
266 extern int srand48_r __P ((long __seedval, struct drand48_data *__buffer));
267 extern unsigned short int *seed48 __P ((unsigned short int __seed16v[3]));
268 extern int seed48_r __P ((unsigned short int __seed16v[3],
269                           struct drand48_data *__buffer));
270 extern void lcong48 __P ((unsigned short int __param[7]));
271 extern int lcong48_r __P ((unsigned short int __param[7],
272                            struct drand48_data *__buffer));
273
274 /* Internal function to compute next state of the generator.  */
275 extern int __drand48_iterate __P ((unsigned short int __xsubi[3],
276                                    struct drand48_data *__buffer));
277 #endif  /* __USE_SVID.  */
278
279
280 /* Allocate SIZE bytes of memory.  */
281 extern __ptr_t malloc __P ((size_t __size));
282 /* Re-allocate the previously allocated block
283    in __ptr_t, making the new block SIZE bytes long.  */
284 extern __ptr_t realloc __P ((__ptr_t __ptr, size_t __size));
285 /* Allocate NMEMB elements of SIZE bytes each, all initialized to 0.  */
286 extern __ptr_t calloc __P ((size_t __nmemb, size_t __size));
287 /* Free a block allocated by `malloc', `realloc' or `calloc'.  */
288 extern void free __P ((__ptr_t __ptr));
289
290 #ifdef  __USE_MISC
291 /* Free a block.  An alias for `free'.  (Sun Unices).  */
292 extern void cfree __P ((__ptr_t __ptr));
293 #endif /* Use misc.  */
294
295 #if defined(__USE_GNU) || defined(__USE_BSD) || defined(__USE_MISC)
296 #include <alloca.h>
297 #endif /* Use GNU, BSD, or misc.  */
298
299 #ifdef  __USE_BSD
300 /* Allocate SIZE bytes on a page boundary.  The storage cannot be freed.  */
301 extern __ptr_t valloc __P ((size_t __size));
302 #endif
303
304
305 /* Abort execution and generate a core-dump.  */
306 extern void abort __P ((void)) __attribute__ ((__noreturn__));
307
308
309 /* Register a function to be called when `exit' is called.  */
310 extern int atexit __P ((void (*__func) (void)));
311
312 #ifdef  __USE_MISC
313 /* Register a function to be called with the status
314    given to `exit' and the given argument.  */
315 extern int on_exit __P ((void (*__func) (int __status, __ptr_t __arg),
316                          __ptr_t __arg));
317 #endif
318
319 /* Call all functions registered with `atexit' and `on_exit',
320    in the reverse of the order in which they were registered
321    perform stdio cleanup, and terminate program execution with STATUS.  */
322 extern void exit __P ((int __status)) __attribute__ ((__noreturn__));
323
324
325 /* Return the value of envariable NAME, or NULL if it doesn't exist.  */
326 extern char *getenv __P ((__const char *__name));
327
328 #ifdef  __USE_SVID
329 /* The SVID says this is in <stdio.h>, but this seems a better place.   */
330 /* Put STRING, which is of the form "NAME=VALUE", in the environment.
331    If there is no `=', remove NAME from the environment.  */
332 extern int putenv __P ((__const char *__string));
333 #endif
334
335 #ifdef  __USE_BSD
336 /* Set NAME to VALUE in the environment.
337    If REPLACE is nonzero, overwrite an existing value.  */
338 extern int setenv __P ((__const char *__name, __const char *__value,
339                         int __replace));
340 #endif
341
342 /* Execute the given line as a shell command.  */
343 extern int system __P ((__const char *__command));
344
345
346 /* Shorthand for type of comparison functions.  */
347 #ifndef __COMPAR_FN_T
348 #define __COMPAR_FN_T
349 typedef int (*__compar_fn_t) __P ((__const __ptr_t, __const __ptr_t));
350 #endif
351
352 #ifdef  __USE_GNU
353 typedef __compar_fn_t comparison_fn_t;
354 #endif
355
356 /* Do a binary search for KEY in BASE, which consists of NMEMB elements
357    of SIZE bytes each, using COMPAR to perform the comparisons.  */
358 extern __ptr_t bsearch __P ((__const __ptr_t __key, __const __ptr_t __base,
359                              size_t __nmemb, size_t __size,
360                              __compar_fn_t __compar));
361
362 /* Sort NMEMB elements of BASE, of SIZE bytes each,
363    using COMPAR to perform the comparisons.  */
364 extern void qsort __P ((__ptr_t __base, size_t __nmemb, size_t __size,
365                         __compar_fn_t __compar));
366
367
368 #ifndef __CONSTVALUE
369 #ifdef  __GNUC__
370 /* The `const' keyword tells GCC that a function's return value is
371    based solely on its arguments, and there are no side-effects.  */
372 #define __CONSTVALUE    __const
373 #else
374 #define __CONSTVALUE
375 #endif /* GCC.  */
376 #endif /* __CONSTVALUE not defined.  */
377
378 /* Return the absolute value of X.  */
379 extern __CONSTVALUE int abs __P ((int __x));
380 extern __CONSTVALUE long int labs __P ((long int __x));
381
382
383 /* Return the `div_t' or `ldiv_t' representation
384    of the value of NUMER over DENOM. */
385 /* GCC may have built-ins for these someday.  */
386 extern __CONSTVALUE div_t div __P ((int __numer, int __denom));
387 extern __CONSTVALUE ldiv_t ldiv __P ((long int __numer, long int __denom));
388
389
390 #ifdef __USE_SVID
391 /* Convert floating point numbers to strings.  The returned values are
392    valid only until another call to the same function.  */
393
394 /* Convert VALUE to a string with NDIGIT digits and return a pointer to
395    this.  Set *DECPT with the position of the decimal character and *SIGN
396    with the sign of the number.  */
397 char *ecvt __P ((double __value, int __ndigit, int *__decpt, int *sign));
398
399 /* Convert VALUE to a string rounded to NDIGIT decimal digits.  Set *DECPT
400    with the position of the decimal character and *SIGN with the sign of
401    the number.  */
402 char *fcvt __P ((double __value, int __ndigit, int *__decpt, int *sign));
403
404 /* If possible convert VALUE to a string with NDIGIT significant digits.
405    Otherwise use exponential representation.  The resulting string will
406    be written to BUF.  */
407 char *gcvt __P ((double __value, int __ndigit, char *__buf));
408
409 /* Reentrant version of the functions above which provide their own
410    buffers.  */
411 int ecvt_r __P ((double __value, int __ndigit, int *__decpt, int *sign,
412                  char *__buf, size_t __len));
413 int fcvt_r __P ((double __value, int __ndigit, int *__decpt, int *sign,
414                  char *__buf, size_t __len));
415 #endif
416
417
418 /* Return the length of the multibyte character
419    in S, which is no longer than N.  */
420 extern int mblen __P ((__const char *__s, size_t __n));
421 /* Return the length of the given multibyte character,
422    putting its `wchar_t' representation in *PWC.  */
423 extern int mbtowc __P ((wchar_t * __pwc, __const char *__s, size_t __n));
424 /* Put the multibyte character represented
425    by WCHAR in S, returning its length.  */
426 extern int wctomb __P ((char *__s, wchar_t __wchar));
427
428 #if defined (__OPTIMIZE__) && __GNUC__ >= 2
429 extern __inline int mblen (__const char *__s, size_t __n)
430 { return mbtowc ((wchar_t *) NULL, __s, __n); }
431 #endif /* Optimizing GCC >=2.  */
432
433
434 /* Convert a multibyte string to a wide char string.  */
435 extern size_t mbstowcs __P ((wchar_t * __pwcs, __const char *__s, size_t __n));
436 /* Convert a wide char string to multibyte string.  */
437 extern size_t wcstombs __P ((char *__s, __const wchar_t * __pwcs, size_t __n));
438
439
440 __END_DECLS
441
442 #endif /* stdlib.h  */