(__strtof, __strtold): Declarations removed.
[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 #endif /* Use BSD.  */
202
203
204 /* Allocate SIZE bytes of memory.  */
205 extern __ptr_t malloc __P ((size_t __size));
206 /* Re-allocate the previously allocated block
207    in __ptr_t, making the new block SIZE bytes long.  */
208 extern __ptr_t realloc __P ((__ptr_t __ptr, size_t __size));
209 /* Allocate NMEMB elements of SIZE bytes each, all initialized to 0.  */
210 extern __ptr_t calloc __P ((size_t __nmemb, size_t __size));
211 /* Free a block allocated by `malloc', `realloc' or `calloc'.  */
212 extern void free __P ((__ptr_t __ptr));
213
214 #ifdef  __USE_MISC
215 /* Free a block.  An alias for `free'.  (Sun Unices).  */
216 extern void cfree __P ((__ptr_t __ptr));
217 #endif /* Use misc.  */
218
219 #if defined(__USE_GNU) || defined(__USE_BSD) || defined(__USE_MISC)
220 #include <alloca.h>
221 #endif /* Use GNU, BSD, or misc.  */
222
223 #ifdef  __USE_BSD
224 /* Allocate SIZE bytes on a page boundary.  The storage cannot be freed.  */
225 extern __ptr_t valloc __P ((size_t __size));
226 #endif
227
228
229 /* Abort execution and generate a core-dump.  */
230 extern void abort __P ((void)) __attribute__ ((__noreturn__));
231
232
233 /* Register a function to be called when `exit' is called.  */
234 extern int atexit __P ((void (*__func) (void)));
235
236 #ifdef  __USE_MISC
237 /* Register a function to be called with the status
238    given to `exit' and the given argument.  */
239 extern int on_exit __P ((void (*__func) (int __status, __ptr_t __arg),
240                          __ptr_t __arg));
241 #endif
242
243 /* Call all functions registered with `atexit' and `on_exit',
244    in the reverse of the order in which they were registered
245    perform stdio cleanup, and terminate program execution with STATUS.  */
246 extern void exit __P ((int __status)) __attribute__ ((__noreturn__));
247
248
249 /* Return the value of envariable NAME, or NULL if it doesn't exist.  */
250 extern char *getenv __P ((__const char *__name));
251
252 #ifdef  __USE_SVID
253 /* The SVID says this is in <stdio.h>, but this seems a better place.   */
254 /* Put STRING, which is of the form "NAME=VALUE", in the environment.
255    If there is no `=', remove NAME from the environment.  */
256 extern int putenv __P ((__const char *__string));
257 #endif
258
259 #ifdef  __USE_BSD
260 /* Set NAME to VALUE in the environment.
261    If REPLACE is nonzero, overwrite an existing value.  */
262 extern int setenv __P ((__const char *__name, __const char *__value,
263                         int __replace));
264 #endif
265
266 /* Execute the given line as a shell command.  */
267 extern int system __P ((__const char *__command));
268
269
270 /* Shorthand for type of comparison functions.  */
271 typedef int (*__compar_fn_t) __P ((__const __ptr_t, __const __ptr_t));
272
273 #ifdef  __USE_GNU
274 typedef __compar_fn_t comparison_fn_t;
275 #endif
276
277 /* Do a binary search for KEY in BASE, which consists of NMEMB elements
278    of SIZE bytes each, using COMPAR to perform the comparisons.  */
279 extern __ptr_t bsearch __P ((__const __ptr_t __key, __const __ptr_t __base,
280                              size_t __nmemb, size_t __size,
281                              __compar_fn_t __compar));
282
283 /* Sort NMEMB elements of BASE, of SIZE bytes each,
284    using COMPAR to perform the comparisons.  */
285 extern void qsort __P ((__ptr_t __base, size_t __nmemb, size_t __size,
286                         __compar_fn_t __compar));
287
288
289 #ifndef __CONSTVALUE
290 #ifdef  __GNUC__
291 /* The `const' keyword tells GCC that a function's return value is
292    based solely on its arguments, and there are no side-effects.  */
293 #define __CONSTVALUE    __const
294 #else
295 #define __CONSTVALUE
296 #endif /* GCC.  */
297 #endif /* __CONSTVALUE not defined.  */
298
299 /* Return the absolute value of X.  */
300 extern __CONSTVALUE int abs __P ((int __x));
301 extern __CONSTVALUE long int labs __P ((long int __x));
302
303
304 /* Return the `div_t' or `ldiv_t' representation
305    of the value of NUMER over DENOM. */
306 /* GCC may have built-ins for these someday.  */
307 extern __CONSTVALUE div_t div __P ((int __numer, int __denom));
308 extern __CONSTVALUE ldiv_t ldiv __P ((long int __numer, long int __denom));
309
310
311 /* Return the length of the multibyte character
312    in S, which is no longer than N.  */
313 extern int mblen __P ((__const char *__s, size_t __n));
314 /* Return the length of the given multibyte character,
315    putting its `wchar_t' representation in *PWC.  */
316 extern int mbtowc __P ((wchar_t * __pwc, __const char *__s, size_t __n));
317 /* Put the multibyte character represented
318    by WCHAR in S, returning its length.  */
319 extern int wctomb __P ((char *__s, wchar_t __wchar));
320
321 #if defined (__OPTIMIZE__) && __GNUC__ >= 2
322 extern __inline int mblen (__const char *__s, size_t __n)
323 { return mbtowc ((wchar_t *) NULL, __s, __n); }
324 #endif /* Optimizing GCC >=2.  */
325
326
327 /* Convert a multibyte string to a wide char string.  */
328 extern size_t mbstowcs __P ((wchar_t * __pwcs, __const char *__s, size_t __n));
329 /* Convert a wide char string to multibyte string.  */
330 extern size_t wcstombs __P ((char *__s, __const wchar_t * __pwcs, size_t __n));
331
332
333 __END_DECLS
334
335 #endif /* stdlib.h  */