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