Use _IO_FILE_complete, not _IO_file_plus.
[kopensolaris-gnu/glibc.git] / string / string.h
1 /* Copyright (C) 1991, 92, 93, 95, 96, 97 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 not,
16    write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17    Boston, MA 02111-1307, USA.  */
18
19 /*
20  *      ISO C Standard: 4.11 STRING HANDLING    <string.h>
21  */
22
23 #ifndef _STRING_H
24 #define _STRING_H       1
25
26 #include <features.h>
27
28 __BEGIN_DECLS
29
30 /* Get size_t and NULL from <stddef.h>.  */
31 #define __need_size_t
32 #define __need_NULL
33 #include <stddef.h>
34
35
36 /* Copy N bytes of SRC to DEST.  */
37 extern __ptr_t memcpy __P ((__ptr_t __restrict __dest,
38                             __const __ptr_t __restrict __src, size_t __n));
39 /* Copy N bytes of SRC to DEST, guaranteeing
40    correct behavior for overlapping strings.  */
41 extern __ptr_t memmove __P ((__ptr_t __dest, __const __ptr_t __src,
42                              size_t __n));
43
44 /* Copy no more than N bytes of SRC to DEST, stopping when C is found.
45    Return the position in DEST one byte past where C was copied,
46    or NULL if C was not found in the first N bytes of SRC.  */
47 extern __ptr_t __memccpy __P ((__ptr_t __dest, __const __ptr_t __src,
48                                int __c, size_t __n));
49 #if defined __USE_SVID || defined __USE_BSD || defined __USE_XOPEN
50 extern __ptr_t memccpy __P ((__ptr_t __dest, __const __ptr_t __src,
51                              int __c, size_t __n));
52 #endif /* SVID.  */
53
54
55 /* Set N bytes of S to C.  */
56 extern __ptr_t memset __P ((__ptr_t __s, int __c, size_t __n));
57
58 /* Compare N bytes of S1 and S2.  */
59 extern int memcmp __P ((__const __ptr_t __s1, __const __ptr_t __s2,
60                         size_t __n));
61
62 /* Search N bytes of S for C.  */
63 extern __ptr_t memchr __P ((__const __ptr_t __s, int __c, size_t __n));
64
65
66 /* Copy SRC to DEST.  */
67 extern char *strcpy __P ((char *__restrict __dest,
68                           __const char *__restrict __src));
69 /* Copy no more than N characters of SRC to DEST.  */
70 extern char *strncpy __P ((char *__restrict __dest,
71                            __const char *__restrict __src, size_t __n));
72
73 /* Append SRC onto DEST.  */
74 extern char *strcat __P ((char *__restrict __dest,
75                           __const char *__restrict __src));
76 /* Append no more than N characters from SRC onto DEST.  */
77 extern char *strncat __P ((char *__restrict __dest,
78                            __const char *__restrict __src, size_t __n));
79
80 /* Compare S1 and S2.  */
81 extern int strcmp __P ((__const char *__s1, __const char *__s2));
82 /* Compare N characters of S1 and S2.  */
83 extern int strncmp __P ((__const char *__s1, __const char *__s2, size_t __n));
84
85 /* Compare the collated forms of S1 and S2.  */
86 extern int strcoll __P ((__const char *__s1, __const char *__s2));
87 /* Put a transformation of SRC into no more than N bytes of DEST.  */
88 extern size_t strxfrm __P ((char *__restrict __dest,
89                             __const char *__restrict __src, size_t __n));
90
91 #ifdef __USE_GNU
92 /* The following functions are equivalent to the both above but they
93    take the locale they use for the collation as an extra argument.
94    This is not standardsized but something like will come.  */
95 # include <xlocale.h>
96
97 /* Compare the collated forms of S1 and S2 using rules from L.  */
98 extern int __strcoll_l __P ((__const char *__s1, __const char *__s2,
99                              __locale_t __l));
100 /* Put a transformation of SRC into no more than N bytes of DEST.  */
101 extern size_t __strxfrm_l __P ((char *__dest, __const char *__src, size_t __n,
102                                 __locale_t __l));
103 #endif
104
105 #if defined __USE_SVID || defined __USE_BSD || defined __USE_XOPEN_EXTENDED
106 /* Duplicate S, returning an identical malloc'd string.  */
107 extern char *__strdup __P ((__const char *__s));
108 extern char *strdup __P ((__const char *__s));
109 #endif
110
111 /* Return a malloc'd copy of at most N bytes of STRING.  The
112    resultant string is terminated even if no null terminator
113    appears before STRING[N].  */
114 extern char *__strndup __P ((__const char *__string, size_t __n));
115 #if defined __USE_GNU
116 extern char *strndup __P ((__const char *__string, size_t __n));
117 #endif
118
119 #if defined __USE_GNU && defined __GNUC__
120 /* Duplicate S, returning an identical alloca'd string.  */
121 # define strdupa(s)                                                           \
122   (__extension__                                                              \
123     ({                                                                        \
124       __const char *__old = (s);                                              \
125       size_t __len = strlen (__old) + 1;                                      \
126       char *__new = __builtin_alloca (__len);                                 \
127       (char *) memcpy (__new, __old, __len);                                  \
128     }))
129
130 /* Return an alloca'd copy of at most N bytes of string.  */
131 # define strndupa(s, n)                                                       \
132   (__extension__                                                              \
133     ({                                                                        \
134       __const char *__old = (s);                                              \
135       size_t __len = strnlen (__old, (n));                                    \
136       char *__new = __builtin_alloca (__len + 1);                             \
137       __new[__len] = '\0';                                                    \
138       (char *) memcpy (__new, __old, __len);                                  \
139     }))
140 #endif
141
142 /* Find the first occurrence of C in S.  */
143 extern char *strchr __P ((__const char *__s, int __c));
144 /* Find the last occurrence of C in S.  */
145 extern char *strrchr __P ((__const char *__s, int __c));
146
147 /* Return the length of the initial segment of S which
148    consists entirely of characters not in REJECT.  */
149 extern size_t strcspn __P ((__const char *__s, __const char *__reject));
150 /* Return the length of the initial segment of S which
151    consists entirely of characters in ACCEPT.  */
152 extern size_t strspn __P ((__const char *__s, __const char *__accept));
153 /* Find the first occurrence in S of any character in ACCEPT.  */
154 extern char *strpbrk __P ((__const char *__s, __const char *__accept));
155 /* Find the first occurrence of NEEDLE in HAYSTACK.  */
156 extern char *strstr __P ((__const char *__haystack, __const char *__needle));
157 /* Divide S into tokens separated by characters in DELIM.  */
158 extern char *strtok __P ((char *__restrict __s,
159                           __const char *__restrict __delim));
160
161 #if defined __USE_POSIX || defined __USE_MISC
162 /* Divide S into tokens separated by characters in DELIM.  Information
163    passed between calls are stored in SAVE_PTR.  */
164 extern char *strtok_r __P ((char *__s, __const char *__delim,
165                             char **__save_ptr));
166 #endif
167
168 #ifdef __USE_GNU
169 /* Find the first occurrence of NEEDLE in HAYSTACK.
170    NEEDLE is NEEDLELEN bytes long;
171    HAYSTACK is HAYSTACKLEN bytes long.  */
172 extern __ptr_t memmem __P ((__const __ptr_t __haystack, size_t __haystacklen,
173                             __const __ptr_t __needle, size_t __needlelen));
174
175 /* Copy N bytes of SRC to DEST, return pointer to bytes after the
176    last written byte.  */
177 extern __ptr_t __mempcpy __P ((__ptr_t __restrict __dest,
178                                __const __ptr_t __restrict __src, size_t __n));
179 extern __ptr_t mempcpy __P ((__ptr_t __restrict __dest,
180                              __const __ptr_t __restrict __src, size_t __n));
181 #endif
182
183
184 /* Return the length of S.  */
185 extern size_t strlen __P ((__const char *__s));
186
187 #ifdef  __USE_GNU
188 /* Find the length of STRING, but scan at most MAXLEN characters.
189    If no '\0' terminator is found in that many characters, return MAXLEN.  */
190 extern size_t strnlen __P ((__const char *__string, size_t __maxlen));
191 #endif
192
193
194 /* Return a string describing the meaning of the `errno' code in ERRNUM.  */
195 extern char *strerror __P ((int __errnum));
196 #ifdef  __USE_MISC
197 /* Reentrant version of `strerror'.  If a temporary buffer is required, at
198    most BUFLEN bytes of BUF will be used.  */
199 extern char *__strerror_r __P ((int __errnum, char *__buf, size_t __buflen));
200 extern char *strerror_r __P ((int __errnum, char *__buf, size_t __buflen));
201 #endif
202
203 /* We define this function always since `bzero' is sometimes needed when
204    the namespace rules does not allow this.  */
205 extern void __bzero __P ((__ptr_t __s, size_t __n));
206
207 #if defined __USE_BSD || defined __USE_XOPEN_EXTENDED
208 /* Copy N bytes of SRC to DEST (like memmove, but args reversed).  */
209 extern void bcopy __P ((__const __ptr_t __src, __ptr_t __dest, size_t __n));
210
211 /* Set N bytes of S to 0.  */
212 extern void bzero __P ((__ptr_t __s, size_t __n));
213
214 /* Compare N bytes of S1 and S2 (same as memcmp).  */
215 extern int bcmp __P ((__const __ptr_t __s1, __const __ptr_t __s2, size_t __n));
216
217 /* Find the first occurrence of C in S (same as strchr).  */
218 extern char *index __P ((__const char *__s, int __c));
219
220 /* Find the last occurrence of C in S (same as strrchr).  */
221 extern char *rindex __P ((__const char *__s, int __c));
222
223 /* Return the position of the first bit set in I, or 0 if none are set.
224    The least-significant bit is position 1, the most-significant 32.  */
225 extern int ffs __P ((int __i));
226
227 /* Compare S1 and S2, ignoring case.  */
228 extern int __strcasecmp __P ((__const char *__s1, __const char *__s2));
229 extern int strcasecmp __P ((__const char *__s1, __const char *__s2));
230
231 /* Compare no more than N chars of S1 and S2, ignoring case.  */
232 extern int __strncasecmp __P ((__const char *__s1, __const char *__s2,
233                                size_t __n));
234 extern int strncasecmp __P ((__const char *__s1, __const char *__s2,
235                              size_t __n));
236 #endif /* Use BSD or X/Open Unix.  */
237
238 #ifdef  __USE_GNU
239 /* Again versions of a few functions which use the given locale instead
240    of the global one.  */
241 extern int __strcasecmp_l __P ((__const char *__s1, __const char *__s2,
242                                 __locale_t __loc));
243
244 extern int __strncasecmp_l __P ((__const char *__s1, __const char *__s2,
245                                  size_t __n, __locale_t __loc));
246 #endif
247
248 #ifdef  __USE_BSD
249 /* Return the next DELIM-delimited token from *STRINGP,
250    terminating it with a '\0', and update *STRINGP to point past it.  */
251 extern char *__strsep __P ((char **__stringp, __const char *__delim));
252 extern char *strsep __P ((char **__stringp, __const char *__delim));
253 #endif
254
255 #ifdef  __USE_GNU
256 /* Compare S1 and S2 as strings holding name & indices/version numbers.  */
257 extern int strverscmp __P ((__const char *__s1, __const char *__s2));
258
259 /* Return a string describing the meaning of the signal number in SIG.  */
260 extern char *strsignal __P ((int __sig));
261
262 /* Copy SRC to DEST, returning the address of the terminating '\0' in DEST.  */
263 extern char *__stpcpy __P ((char *__dest, __const char *__src));
264 extern char *stpcpy __P ((char *__dest, __const char *__src));
265
266 /* Copy no more than N characters of SRC to DEST, returning the address of
267    the last character written into DEST.  */
268 extern char *__stpncpy __P ((char *__dest, __const char *__src, size_t __n));
269 extern char *stpncpy __P ((char *__dest, __const char *__src, size_t __n));
270
271 /* Sautee STRING briskly.  */
272 extern char *strfry __P ((char *__string));
273
274 /* Frobnicate N bytes of S.  */
275 extern __ptr_t memfrob __P ((__ptr_t __s, size_t __n));
276
277 # ifndef basename
278 /* Return the file name within directory of FILENAME.  We don't
279    declare the function if the `basename' macro is available (defined
280    in <libgen.h>) which makes the XPG version of this function
281    available.  */
282 extern char *basename __P ((__const char *__filename));
283 # endif
284 #endif
285
286
287 #if defined __GNUC__ && __GNUC__ >= 2 && defined __OPTIMIZE__
288 /* When using GNU CC we provide some optimized versions of selected
289    functions from this header.  There are two kinds of optimizations:
290
291    - machine-dependent optmizations, most probably using inline
292      assembler code; these could be quite expensive since the code
293      size could increase significantly.
294      These optimizations are not used unless the symbol
295         __USE_STRING_INLINES
296      is defined before including this header
297
298    - machine-independent optimizations which do not increase the
299      code size significantly and which optimize mainly situations
300      where one or more arguments are compile-time constants.
301      These optimizations are used always when the compiler is
302      taught to optimized.
303
304    One can inhibit all optimizations by defining __NO_STRING_INLINES.  */
305
306 /* Get the machine-dependent optimizations (if any).  */
307 # include <bits/string.h>
308
309 /* These are generic optimizations which do not add too much inline code.  */
310 # include <bits/string2.h>
311 #endif
312
313 __END_DECLS
314
315 #endif /* string.h  */