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