1 /* Copyright (C) 1991,92,93,95,96,97,98,99,2000,2001 Free Software Foundation, Inc.
2 This file is part of the GNU C Library.
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.
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.
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
20 * ISO C99 Standard: 7.21 String handling <string.h>
30 /* Get size_t and NULL from <stddef.h>. */
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)
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,
54 /* Set N bytes of S to C. */
55 extern void *memset (void *__s, int __c, size_t __n) __THROW;
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__;
61 /* Search N bytes of S for C. */
62 extern void *memchr (__const void *__s, int __c, size_t __n)
63 __THROW __attribute_pure__;
67 /* Search in S for C. This is similar to `memchr' but there is no
69 extern void *rawmemchr (__const void *__s, int __c) __THROW __attribute_pure__;
72 /* Search N bytes of S for the final occurrence of C. */
73 extern void *memrchr (__const void *__s, int __c, size_t __n)
74 __THROW __attribute_pure__;
77 /* Copy SRC to DEST. */
78 extern char *strcpy (char *__restrict __dest, __const char *__restrict __src)
80 /* Copy no more than N characters of SRC to DEST. */
81 extern char *strncpy (char *__restrict __dest,
82 __const char *__restrict __src, size_t __n) __THROW;
84 /* Append SRC onto DEST. */
85 extern char *strcat (char *__restrict __dest, __const char *__restrict __src)
87 /* Append no more than N characters from SRC onto DEST. */
88 extern char *strncat (char *__restrict __dest, __const char *__restrict __src,
91 /* Compare S1 and S2. */
92 extern int strcmp (__const char *__s1, __const char *__s2)
93 __THROW __attribute_pure__;
94 /* Compare N characters of S1 and S2. */
95 extern int strncmp (__const char *__s1, __const char *__s2, size_t __n)
96 __THROW __attribute_pure__;
98 /* Compare the collated forms of S1 and S2. */
99 extern int strcoll (__const char *__s1, __const char *__s2)
100 __THROW __attribute_pure__;
101 /* Put a transformation of SRC into no more than N bytes of DEST. */
102 extern size_t strxfrm (char *__restrict __dest,
103 __const char *__restrict __src, size_t __n) __THROW;
107 /* The following functions are equivalent to the both above but they
108 take the locale they use for the collation as an extra argument.
109 This is not standardsized but something like will come. */
110 # include <xlocale.h>
112 /* Compare the collated forms of S1 and S2 using rules from L. */
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;
120 #if defined __USE_SVID || defined __USE_BSD || defined __USE_XOPEN_EXTENDED
121 /* Duplicate S, returning an identical malloc'd string. */
122 extern char *strdup (__const char *__s) __THROW __attribute_malloc__;
125 /* Return a malloc'd copy of at most N bytes of STRING. The
126 resultant string is terminated even if no null terminator
127 appears before STRING[N]. */
128 #if defined __USE_GNU
129 extern char *strndup (__const char *__string, size_t __n)
130 __THROW __attribute_malloc__;
133 #if defined __USE_GNU && defined __GNUC__
134 /* Duplicate S, returning an identical alloca'd string. */
135 # define strdupa(s) \
138 __const char *__old = (s); \
139 size_t __len = strlen (__old) + 1; \
140 char *__new = (char *) __builtin_alloca (__len); \
141 (char *) memcpy (__new, __old, __len); \
144 /* Return an alloca'd copy of at most N bytes of string. */
145 # define strndupa(s, n) \
148 __const char *__old = (s); \
149 size_t __len = strnlen (__old, (n)); \
150 char *__new = (char *) __builtin_alloca (__len + 1); \
151 __new[__len] = '\0'; \
152 (char *) memcpy (__new, __old, __len); \
156 /* Find the first occurrence of C in S. */
157 extern char *strchr (__const char *__s, int __c) __THROW __attribute_pure__;
158 /* Find the last occurrence of C in S. */
159 extern char *strrchr (__const char *__s, int __c) __THROW __attribute_pure__;
163 /* This funciton is similar to `strchr'. But it returns a pointer to
164 the closing NUL byte in case C is not found in S. */
165 extern char *strchrnul (__const char *__s, int __c) __THROW __attribute_pure__;
168 /* Return the length of the initial segment of S which
169 consists entirely of characters not in REJECT. */
170 extern size_t strcspn (__const char *__s, __const char *__reject)
171 __THROW __attribute_pure__;
172 /* Return the length of the initial segment of S which
173 consists entirely of characters in ACCEPT. */
174 extern size_t strspn (__const char *__s, __const char *__accept)
175 __THROW __attribute_pure__;
176 /* Find the first occurrence in S of any character in ACCEPT. */
177 extern char *strpbrk (__const char *__s, __const char *__accept)
178 __THROW __attribute_pure__;
179 /* Find the first occurrence of NEEDLE in HAYSTACK. */
180 extern char *strstr (__const char *__haystack, __const char *__needle)
181 __THROW __attribute_pure__;
184 /* Similar to `strstr' but this function ignores the case of both strings. */
185 extern char *strcasestr (__const char *__haystack, __const char *__needle)
186 __THROW __attribute_pure__;
189 /* Divide S into tokens separated by characters in DELIM. */
190 extern char *strtok (char *__restrict __s, __const char *__restrict __delim)
193 /* Divide S into tokens separated by characters in DELIM. Information
194 passed between calls are stored in SAVE_PTR. */
195 extern char *__strtok_r (char *__restrict __s,
196 __const char *__restrict __delim,
197 char **__restrict __save_ptr) __THROW;
198 #if defined __USE_POSIX || defined __USE_MISC
199 extern char *strtok_r (char *__restrict __s, __const char *__restrict __delim,
200 char **__restrict __save_ptr) __THROW;
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__;
213 /* Copy N bytes of SRC to DEST, return pointer to bytes after the
214 last written byte. */
215 extern void *__mempcpy (void *__restrict __dest,
216 __const void *__restrict __src, size_t __n) __THROW;
217 extern void *mempcpy (void *__restrict __dest,
218 __const void *__restrict __src, size_t __n) __THROW;
222 /* Return the length of S. */
223 extern size_t strlen (__const char *__s) __THROW __attribute_pure__;
226 /* Find the length of STRING, but scan at most MAXLEN characters.
227 If no '\0' terminator is found in that many characters, return MAXLEN. */
228 extern size_t strnlen (__const char *__string, size_t __maxlen)
229 __THROW __attribute_pure__;
233 /* Return a string describing the meaning of the `errno' code in ERRNUM. */
234 extern char *strerror (int __errnum) __THROW;
236 /* Reentrant version of `strerror'. If a temporary buffer is required, at
237 most BUFLEN bytes of BUF will be used. */
238 extern int strerror_r (int __errnum, char *__buf, size_t buflen) __THROW;
241 /* We define this function always since `bzero' is sometimes needed when
242 the namespace rules does not allow this. */
243 extern void __bzero (void *__s, size_t __n) __THROW;
245 #if defined __USE_BSD
246 /* Copy N bytes of SRC to DEST (like memmove, but args reversed). */
247 extern void bcopy (__const void *__src, void *__dest, size_t __n) __THROW;
249 /* Set N bytes of S to 0. */
250 extern void bzero (void *__s, size_t __n) __THROW;
252 /* Compare N bytes of S1 and S2 (same as memcmp). */
253 extern int bcmp (__const void *__s1, __const void *__s2, size_t __n)
254 __THROW __attribute_pure__;
256 /* Find the first occurrence of C in S (same as strchr). */
257 extern char *index (__const char *__s, int __c) __THROW __attribute_pure__;
259 /* Find the last occurrence of C in S (same as strrchr). */
260 extern char *rindex (__const char *__s, int __c) __THROW __attribute_pure__;
262 /* Return the position of the first bit set in I, or 0 if none are set.
263 The least-significant bit is position 1, the most-significant 32. */
264 extern int ffs (int __i) __THROW __attribute__ ((__const__));
266 /* The following two functions are non-standard but necessary for non-32 bit
269 /*# ifdef __USE_GNU*/
270 extern int ffsl (long int __l) __THROW __attribute__ ((__const__));
272 __extension__ extern int ffsll (long long int __ll)
273 __THROW __attribute__ ((__const__));
277 /* Compare S1 and S2, ignoring case. */
278 extern int strcasecmp (__const char *__s1, __const char *__s2)
279 __THROW __attribute_pure__;
281 /* Compare no more than N chars of S1 and S2, ignoring case. */
282 extern int strncasecmp (__const char *__s1, __const char *__s2, size_t __n)
283 __THROW __attribute_pure__;
284 #endif /* Use BSD. */
288 /* Again versions of a few functions which use the given locale instead
289 of the global one. */
290 extern int __strcasecmp_l (__const char *__s1, __const char *__s2,
291 __locale_t __loc) __THROW __attribute_pure__;
293 extern int __strncasecmp_l (__const char *__s1, __const char *__s2,
294 size_t __n, __locale_t __loc)
295 __THROW __attribute_pure__;
299 /* Return the next DELIM-delimited token from *STRINGP,
300 terminating it with a '\0', and update *STRINGP to point past it. */
301 extern char *strsep (char **__restrict __stringp,
302 __const char *__restrict __delim) __THROW;
307 /* Compare S1 and S2 as strings holding name & indices/version numbers. */
308 extern int strverscmp (__const char *__s1, __const char *__s2)
309 __THROW __attribute_pure__;
312 /* Return a string describing the meaning of the signal number in SIG. */
313 extern char *strsignal (int __sig) __THROW;
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)
318 extern char *stpcpy (char *__restrict __dest, __const char *__restrict __src)
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;
329 /* Sautee STRING briskly. */
330 extern char *strfry (char *__string) __THROW;
332 /* Frobnicate N bytes of S. */
333 extern void *memfrob (void *__s, size_t __n) __THROW;
337 /* Return the file name within directory of FILENAME. We don't
338 declare the function if the `basename' macro is available (defined
339 in <libgen.h>) which makes the XPG version of this function
341 extern char *basename (__const char *__filename) __THROW;
346 #if defined __GNUC__ && __GNUC__ >= 2
347 # if defined __OPTIMIZE__ && !defined __OPTIMIZE_SIZE__ \
348 && !defined __NO_INLINE__ && !defined __cplusplus
349 /* When using GNU CC we provide some optimized versions of selected
350 functions from this header. There are two kinds of optimizations:
352 - machine-dependent optimizations, most probably using inline
353 assembler code; these might be quite expensive since the code
354 size can increase significantly.
355 These optimizations are not used unless the symbol
357 is defined before including this header.
359 - machine-independent optimizations which do not increase the
360 code size significantly and which optimize mainly situations
361 where one or more arguments are compile-time constants.
362 These optimizations are used always when the compiler is
365 One can inhibit all optimizations by defining __NO_STRING_INLINES. */
367 /* Get the machine-dependent optimizations (if any). */
368 # include <bits/string.h>
370 /* These are generic optimizations which do not add too much inline code. */
371 # include <bits/string2.h>
378 #endif /* string.h */