(atof, atoi, atol, random, srandom, setstate, initstate, mblen): Never
[kopensolaris-gnu/glibc.git] / stdlib / stdlib.h
1 /* Copyright (C) 1991, 1992, 1993, 1994 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 /* Convert a string to a long integer.  */
79 extern long int strtol __P ((__const char *__nptr, char **__endptr,
80                              int __base));
81 /* Convert a string to an unsigned long integer.  */
82 extern unsigned long int strtoul __P ((__const char *__nptr,
83                                        char **__endptr, int __base));
84
85 #if defined (__OPTIMIZE__) && __GNUC__ >= 2
86 extern __inline double atof (__const char *__nptr)
87 { return strtod(__nptr, (char **) NULL); }
88 extern __inline int atoi (__const char *__nptr)
89 { return (int) strtol (__nptr, (char **) NULL, 10); }
90 extern __inline long int atol (__const char *__nptr)
91 { return strtol (__nptr, (char **) NULL, 10); }
92 #endif /* Optimizing GCC >=2.  */
93
94
95 /* Return a random integer between 0 and RAND_MAX inclusive.  */
96 extern int rand __P ((void));
97 /* Seed the random number generator with the given number.  */
98 extern void srand __P ((unsigned int __seed));
99
100 /* These are the functions that actually do things.  The `random', `srandom',
101    `initstate' and `setstate' functions are those from BSD Unices.
102    The `rand' and `srand' functions are required by the ANSI standard.
103    We provide both interfaces to the same random number generator.  */
104 /* Return a random long integer between 0 and RAND_MAX inclusive.  */
105 extern long int __random __P ((void));
106 /* Seed the random number generator with the given number.  */
107 extern void __srandom __P ((unsigned int __seed));
108
109 /* Initialize the random number generator to use state buffer STATEBUF,
110    of length STATELEN, and seed it with SEED.  Optimal lengths are 8, 16,
111    32, 64, 128 and 256, the bigger the better; values less than 8 will
112    cause an error and values greater than 256 will be rounded down.  */
113 extern __ptr_t __initstate __P ((unsigned int __seed, __ptr_t __statebuf,
114                                  size_t __statelen));
115 /* Switch the random number generator to state buffer STATEBUF,
116    which should have been previously initialized by `initstate'.  */
117 extern __ptr_t __setstate __P ((__ptr_t __statebuf));
118
119 #ifdef  __USE_BSD
120 extern long int random __P ((void));
121 extern void srandom __P ((unsigned int __seed));
122 extern __ptr_t initstate __P ((unsigned int __seed, __ptr_t __statebuf,
123                                size_t __statelen));
124 extern __ptr_t setstate __P ((__ptr_t __statebuf));
125
126 #if defined (__OPTIMIZE__) && __GNUC__ >= 2
127 extern __inline long int random (void)
128 { return __random(); }
129 extern __inline void srandom (unsigned int __seed)
130 { __srandom(__seed); }
131 extern __inline __ptr_t initstate (unsigned int __seed,
132                                    __ptr_t __statebuf, size_t __statelen)
133 { return __initstate (__seed, __statebuf, __statelen); }
134 extern __inline __ptr_t setstate (__ptr_t __statebuf)
135 { return __setstate (__statebuf); }
136 #endif /* Optimizing GCC >=2.  */
137 #endif /* Use BSD.  */
138
139
140 /* Allocate SIZE bytes of memory.  */
141 extern __ptr_t malloc __P ((size_t __size));
142 /* Re-allocate the previously allocated block
143    in __ptr_t, making the new block SIZE bytes long.  */
144 extern __ptr_t realloc __P ((__ptr_t __ptr, size_t __size));
145 /* Allocate NMEMB elements of SIZE bytes each, all initialized to 0.  */
146 extern __ptr_t calloc __P ((size_t __nmemb, size_t __size));
147 /* Free a block allocated by `malloc', `realloc' or `calloc'.  */
148 extern void free __P ((__ptr_t __ptr));
149
150 #ifdef  __USE_MISC
151 /* Free a block.  An alias for `free'.  (Sun Unices).  */
152 extern void cfree __P ((__ptr_t __ptr));
153 #endif /* Use misc.  */
154
155 #if defined(__USE_GNU) || defined(__USE_BSD) || defined(__USE_MISC)
156 #include <alloca.h>
157 #endif /* Use GNU, BSD, or misc.  */
158
159 #ifdef  __USE_BSD
160 /* Allocate SIZE bytes on a page boundary.  The storage cannot be freed.  */
161 extern __ptr_t valloc __P ((size_t __size));
162 #endif
163
164
165 /* Abort execution and generate a core-dump.  */
166 extern __NORETURN void abort __P ((void));
167
168
169 /* Register a function to be called when `exit' is called.  */
170 extern int atexit __P ((void (*__func) (void)));
171
172 #ifdef  __USE_MISC
173 /* Register a function to be called with the status
174    given to `exit' and the given argument.  */
175 extern int on_exit __P ((void (*__func) (int __status, __ptr_t __arg),
176                          __ptr_t __arg));
177 #endif
178
179 /* Call all functions registered with `atexit' and `on_exit',
180    in the reverse of the order in which they were registered
181    perform stdio cleanup, and terminate program execution with STATUS.  */
182 extern __NORETURN void exit __P ((int __status));
183
184
185 /* Return the value of envariable NAME, or NULL if it doesn't exist.  */
186 extern char *getenv __P ((__const char *__name));
187
188 #ifdef  __USE_SVID
189 /* The SVID says this is in <stdio.h>, but this seems a better place.   */
190 /* Put STRING, which is of the form "NAME=VALUE", in the environment.
191    If there is no `=', remove NAME from the environment.  */
192 extern int putenv __P ((__const char *__string));
193 #endif
194
195 #ifdef  __USE_BSD
196 /* Set NAME to VALUE in the environment.
197    If REPLACE is nonzero, overwrite an existing value.  */
198 extern int setenv __P ((__const char *__name, __const char *__value,
199                         int __replace));
200 #endif
201
202 /* Execute the given line as a shell command.  */
203 extern int system __P ((__const char *__command));
204
205
206 /* Shorthand for type of comparison functions.  */
207 typedef int (*__compar_fn_t) __P ((__const __ptr_t, __const __ptr_t));
208
209 #ifdef  __USE_GNU
210 typedef __compar_fn_t comparison_fn_t;
211 #endif
212
213 /* Do a binary search for KEY in BASE, which consists of NMEMB elements
214    of SIZE bytes each, using COMPAR to perform the comparisons.  */
215 extern __ptr_t bsearch __P ((__const __ptr_t __key, __const __ptr_t __base,
216                              size_t __nmemb, size_t __size,
217                              __compar_fn_t __compar));
218
219 /* Sort NMEMB elements of BASE, of SIZE bytes each,
220    using COMPAR to perform the comparisons.  */
221 extern void qsort __P ((__ptr_t __base, size_t __nmemb, size_t __size,
222                         __compar_fn_t __compar));
223
224
225 #ifndef __CONSTVALUE
226 #ifdef  __GNUC__
227 /* The `const' keyword tells GCC that a function's return value is
228    based solely on its arguments, and there are no side-effects.  */
229 #define __CONSTVALUE    __const
230 #else
231 #define __CONSTVALUE
232 #endif /* GCC.  */
233 #endif /* __CONSTVALUE not defined.  */
234
235 /* Return the absolute value of X.  */
236 extern __CONSTVALUE int abs __P ((int __x));
237 extern __CONSTVALUE long int labs __P ((long int __x));
238
239
240 /* Return the `div_t' or `ldiv_t' representation
241    of the value of NUMER over DENOM. */
242 /* GCC may have built-ins for these someday.  */
243 extern __CONSTVALUE div_t div __P ((int __numer, int __denom));
244 extern __CONSTVALUE ldiv_t ldiv __P ((long int __numer, long int __denom));
245
246
247 /* Return the length of the multibyte character
248    in S, which is no longer than N.  */
249 extern int mblen __P ((__const char *__s, size_t __n));
250 /* Return the length of the given multibyte character,
251    putting its `wchar_t' representation in *PWC.  */
252 extern int mbtowc __P ((wchar_t * __pwc, __const char *__s, size_t __n));
253 /* Put the multibyte character represented
254    by WCHAR in S, returning its length.  */
255 extern int wctomb __P ((char *__s, wchar_t __wchar));
256
257 #if defined (__OPTIMIZE__) && __GNUC__ >= 2
258 extern __inline int mblen (__const char *__s, size_t __n)
259 { return mbtowc ((wchar_t *) NULL, __s, __n); }
260 #endif /* Optimizing GCC >=2.  */
261
262
263 /* Convert a multibyte string to a wide char string.  */
264 extern size_t mbstowcs __P ((wchar_t * __pwcs, __const char *__s, size_t __n));
265 /* Convert a wide char string to multibyte string.  */
266 extern size_t wcstombs __P ((char *__s, __const wchar_t * __pwcs, size_t __n));
267
268
269 __END_DECLS
270
271 #endif /* stdlib.h  */