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