1 /* Copyright (C) 1991-1993, 1995-2003, 2004 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>. */
37 /* Copy N bytes of SRC to DEST. */
38 extern void *memcpy (void *__restrict __dest
,
39 __const
void *__restrict __src
, size_t __n
)
40 __THROW
__nonnull ((1, 2));
41 /* Copy N bytes of SRC to DEST, guaranteeing
42 correct behavior for overlapping strings. */
43 extern void *memmove (void *__dest
, __const
void *__src
, size_t __n
)
44 __THROW
__nonnull ((1, 2));
47 /* Copy no more than N bytes of SRC to DEST, stopping when C is found.
48 Return the position in DEST one byte past where C was copied,
49 or NULL if C was not found in the first N bytes of SRC. */
50 #if defined __USE_SVID || defined __USE_BSD || defined __USE_XOPEN
51 extern void *memccpy (void *__restrict __dest
, __const
void *__restrict __src
,
53 __THROW
__nonnull ((1, 2));
58 /* Set N bytes of S to C. */
59 extern void *memset (void *__s
, int __c
, size_t __n
) __THROW
__nonnull ((1));
61 /* Compare N bytes of S1 and S2. */
62 extern int memcmp (__const
void *__s1
, __const
void *__s2
, size_t __n
)
63 __THROW __attribute_pure__
__nonnull ((1, 2));
65 /* Search N bytes of S for C. */
66 extern void *memchr (__const
void *__s
, int __c
, size_t __n
)
67 __THROW __attribute_pure__
__nonnull ((1));
71 /* Search in S for C. This is similar to `memchr' but there is no
73 extern void *rawmemchr (__const
void *__s
, int __c
)
74 __THROW __attribute_pure__
__nonnull ((1));
76 /* Search N bytes of S for the final occurrence of C. */
77 extern void *memrchr (__const
void *__s
, int __c
, size_t __n
)
78 __THROW __attribute_pure__
__nonnull ((1));
83 /* Copy SRC to DEST. */
84 extern char *strcpy (char *__restrict __dest
, __const
char *__restrict __src
)
85 __THROW
__nonnull ((1, 2));
86 /* Copy no more than N characters of SRC to DEST. */
87 extern char *strncpy (char *__restrict __dest
,
88 __const
char *__restrict __src
, size_t __n
)
89 __THROW
__nonnull ((1, 2));
91 /* Append SRC onto DEST. */
92 extern char *strcat (char *__restrict __dest
, __const
char *__restrict __src
)
93 __THROW
__nonnull ((1, 2));
94 /* Append no more than N characters from SRC onto DEST. */
95 extern char *strncat (char *__restrict __dest
, __const
char *__restrict __src
,
96 size_t __n
) __THROW
__nonnull ((1, 2));
98 /* Compare S1 and S2. */
99 extern int strcmp (__const
char *__s1
, __const
char *__s2
)
100 __THROW __attribute_pure__
__nonnull ((1, 2));
101 /* Compare N characters of S1 and S2. */
102 extern int strncmp (__const
char *__s1
, __const
char *__s2
, size_t __n
)
103 __THROW __attribute_pure__
__nonnull ((1, 2));
105 /* Compare the collated forms of S1 and S2. */
106 extern int strcoll (__const
char *__s1
, __const
char *__s2
)
107 __THROW __attribute_pure__
__nonnull ((1, 2));
108 /* Put a transformation of SRC into no more than N bytes of DEST. */
109 extern size_t strxfrm (char *__restrict __dest
,
110 __const
char *__restrict __src
, size_t __n
)
111 __THROW
__nonnull ((2));
114 #if defined __USE_GNU && defined __UCLIBC_HAS_XLOCALE__
115 /* The following functions are equivalent to the both above but they
116 take the locale they use for the collation as an extra argument.
117 This is not standardsized but something like will come. */
118 # include <xlocale.h>
120 /* Compare the collated forms of S1 and S2 using rules from L. */
121 extern int strcoll_l (__const
char *__s1
, __const
char *__s2
, __locale_t __l
)
122 __THROW __attribute_pure__
__nonnull ((1, 2, 3));
123 /* Put a transformation of SRC into no more than N bytes of DEST. */
124 extern size_t strxfrm_l (char *__dest
, __const
char *__src
, size_t __n
,
125 __locale_t __l
) __THROW
__nonnull ((2, 4));
128 #if defined __USE_SVID || defined __USE_BSD || defined __USE_XOPEN_EXTENDED
129 /* Duplicate S, returning an identical malloc'd string. */
130 extern char *strdup (__const
char *__s
)
131 __THROW __attribute_malloc__
__nonnull ((1));
134 /* Return a malloc'd copy of at most N bytes of STRING. The
135 resultant string is terminated even if no null terminator
136 appears before STRING[N]. */
137 #if defined __USE_GNU
138 extern char *strndup (__const
char *__string
, size_t __n
)
139 __THROW __attribute_malloc__
__nonnull ((1));
142 #if defined __USE_GNU && defined __GNUC__
143 /* Duplicate S, returning an identical alloca'd string. */
144 # define strdupa(s) \
147 __const char *__old = (s); \
148 size_t __len = strlen (__old) + 1; \
149 char *__new = (char *) __builtin_alloca (__len); \
150 (char *) memcpy (__new, __old, __len); \
153 /* Return an alloca'd copy of at most N bytes of string. */
154 # define strndupa(s, n) \
157 __const char *__old = (s); \
158 size_t __len = strnlen (__old, (n)); \
159 char *__new = (char *) __builtin_alloca (__len + 1); \
160 __new[__len] = '\0'; \
161 (char *) memcpy (__new, __old, __len); \
165 __BEGIN_NAMESPACE_STD
166 /* Find the first occurrence of C in S. */
167 extern char *strchr (__const
char *__s
, int __c
)
168 __THROW __attribute_pure__
__nonnull ((1));
169 /* Find the last occurrence of C in S. */
170 extern char *strrchr (__const
char *__s
, int __c
)
171 __THROW __attribute_pure__
__nonnull ((1));
175 /* This function is similar to `strchr'. But it returns a pointer to
176 the closing NUL byte in case C is not found in S. */
177 extern char *strchrnul (__const
char *__s
, int __c
)
178 __THROW __attribute_pure__
__nonnull ((1));
181 __BEGIN_NAMESPACE_STD
182 /* Return the length of the initial segment of S which
183 consists entirely of characters not in REJECT. */
184 extern size_t strcspn (__const
char *__s
, __const
char *__reject
)
185 __THROW __attribute_pure__
__nonnull ((1, 2));
186 /* Return the length of the initial segment of S which
187 consists entirely of characters in ACCEPT. */
188 extern size_t strspn (__const
char *__s
, __const
char *__accept
)
189 __THROW __attribute_pure__
__nonnull ((1, 2));
190 /* Find the first occurrence in S of any character in ACCEPT. */
191 extern char *strpbrk (__const
char *__s
, __const
char *__accept
)
192 __THROW __attribute_pure__
__nonnull ((1, 2));
193 /* Find the first occurrence of NEEDLE in HAYSTACK. */
194 extern char *strstr (__const
char *__haystack
, __const
char *__needle
)
195 __THROW __attribute_pure__
__nonnull ((1, 2));
198 /* Divide S into tokens separated by characters in DELIM. */
199 extern char *strtok (char *__restrict __s
, __const
char *__restrict __delim
)
200 __THROW
__nonnull ((2));
203 /* Divide S into tokens separated by characters in DELIM. Information
204 passed between calls are stored in SAVE_PTR. */
205 #if 0 /* uClibc: disabled */
206 extern char *__strtok_r (char *__restrict __s
,
207 __const
char *__restrict __delim
,
208 char **__restrict __save_ptr
)
209 __THROW
__nonnull ((2, 3));
211 #if defined __USE_POSIX || defined __USE_MISC
212 extern char *strtok_r (char *__restrict __s
, __const
char *__restrict __delim
,
213 char **__restrict __save_ptr
)
214 __THROW
__nonnull ((2, 3));
218 /* Similar to `strstr' but this function ignores the case of both strings. */
219 extern char *strcasestr (__const
char *__haystack
, __const
char *__needle
)
220 __THROW __attribute_pure__
__nonnull ((1, 2));
224 /* Find the first occurrence of NEEDLE in HAYSTACK.
225 NEEDLE is NEEDLELEN bytes long;
226 HAYSTACK is HAYSTACKLEN bytes long. */
227 extern void *memmem (__const
void *__haystack
, size_t __haystacklen
,
228 __const
void *__needle
, size_t __needlelen
)
229 __THROW __attribute_pure__
__nonnull ((1, 3));
231 /* Copy N bytes of SRC to DEST, return pointer to bytes after the
232 last written byte. */
233 #if 0 /* uClibc: disabled */
234 extern void *__mempcpy (void *__restrict __dest
,
235 __const
void *__restrict __src
, size_t __n
)
236 __THROW
__nonnull ((1, 2));
238 extern void *mempcpy (void *__restrict __dest
,
239 __const
void *__restrict __src
, size_t __n
)
240 __THROW
__nonnull ((1, 2));
244 __BEGIN_NAMESPACE_STD
245 /* Return the length of S. */
246 extern size_t strlen (__const
char *__s
)
247 __THROW __attribute_pure__
__nonnull ((1));
251 /* Find the length of STRING, but scan at most MAXLEN characters.
252 If no '\0' terminator is found in that many characters, return MAXLEN. */
253 extern size_t strnlen (__const
char *__string
, size_t __maxlen
)
254 __THROW __attribute_pure__
__nonnull ((1));
258 __BEGIN_NAMESPACE_STD
259 /* Return a string describing the meaning of the `errno' code in ERRNUM. */
260 extern char *strerror (int __errnum
) __THROW
;
262 #if defined __USE_XOPEN2K || defined __USE_MISC
263 /* Reentrant version of `strerror'.
264 There are 2 flavors of `strerror_r', GNU which returns the string
265 and may or may not use the supplied temporary buffer and POSIX one
266 which fills the string into the buffer.
267 To use the POSIX version, -D_XOPEN_SOURCE=600 or -D_POSIX_C_SOURCE=200112L
268 without -D_GNU_SOURCE is needed, otherwise the GNU version is
270 # if defined __USE_XOPEN2K && !defined __USE_GNU
271 /* Fill BUF with a string describing the meaning of the `errno' code in
273 extern int __xpg_strerror_r (int __errnum
, char *__buf
, size_t __buflen
)
274 __THROW
__nonnull ((2));
275 # ifdef __REDIRECT_NTH
276 extern int __REDIRECT_NTH (strerror_r
,
277 (int __errnum
, char *__buf
, size_t __buflen
),
278 __xpg_strerror_r
) __nonnull ((2));
280 # define strerror_r __xpg_strerror_r
283 /* If a temporary buffer is required, at most BUFLEN bytes of BUF will be
285 extern char *__glibc_strerror_r (int __errnum
, char *__buf
, size_t __buflen
)
286 __THROW
__nonnull ((2));
287 # ifdef __REDIRECT_NTH
288 extern char * __REDIRECT_NTH (strerror_r
,
289 (int __errnum
, char *__buf
, size_t __buflen
),
290 __glibc_strerror_r
) __nonnull ((2));
292 # define strerror_r __glibc_strerror_r
297 /* We define this function always since `bzero' is sometimes needed when
298 the namespace rules does not allow this. */
299 #if 0 /* uClibc: disabled */
300 extern void __bzero (void *__s
, size_t __n
) __THROW
__nonnull ((1));
304 # ifdef __UCLIBC_SUSV3_LEGACY__
305 /* Copy N bytes of SRC to DEST (like memmove, but args reversed). */
306 extern void bcopy (__const
void *__src
, void *__dest
, size_t __n
)
307 __THROW
__nonnull ((1, 2));
309 /* Set N bytes of S to 0. */
310 extern void bzero (void *__s
, size_t __n
) __THROW
__nonnull ((1));
312 /* Compare N bytes of S1 and S2 (same as memcmp). */
313 extern int bcmp (__const
void *__s1
, __const
void *__s2
, size_t __n
)
314 __THROW __attribute_pure__
__nonnull ((1, 2));
316 /* Find the first occurrence of C in S (same as strchr). */
317 extern char *index (__const
char *__s
, int __c
)
318 __THROW __attribute_pure__
__nonnull ((1));
320 /* Find the last occurrence of C in S (same as strrchr). */
321 extern char *rindex (__const
char *__s
, int __c
)
322 __THROW __attribute_pure__
__nonnull ((1));
324 # ifdef __UCLIBC_SUSV3_LEGACY_MACROS__
325 /* bcopy/bzero/bcmp/index/rindex are marked LEGACY in SuSv3.
326 * They are replaced as proposed by SuSv3. Don't sync this part
327 * with glibc and keep it in sync with strings.h. */
329 # define bcopy(src,dest,n) (memmove((dest), (src), (n)), (void) 0)
330 # define bzero(s,n) (memset((s), '\0', (n)), (void) 0)
331 # define bcmp(s1,s2,n) memcmp((s1), (s2), (size_t)(n))
332 # define index(s,c) strchr((s), (c))
333 # define rindex(s,c) strrchr((s), (c))
337 /* Return the position of the first bit set in I, or 0 if none are set.
338 The least-significant bit is position 1, the most-significant 32. */
339 extern int ffs (int __i
) __THROW
__attribute__ ((__const__
));
341 /* The following two functions are non-standard but necessary for non-32 bit
344 extern int ffsl (long int __l
) __THROW
__attribute__ ((__const__
));
346 __extension__
extern int ffsll (long long int __ll
)
347 __THROW
__attribute__ ((__const__
));
351 /* Compare S1 and S2, ignoring case. */
352 extern int strcasecmp (__const
char *__s1
, __const
char *__s2
)
353 __THROW __attribute_pure__
__nonnull ((1, 2));
355 /* Compare no more than N chars of S1 and S2, ignoring case. */
356 extern int strncasecmp (__const
char *__s1
, __const
char *__s2
, size_t __n
)
357 __THROW __attribute_pure__
__nonnull ((1, 2));
358 #endif /* Use BSD. */
360 #if defined __USE_GNU && defined __UCLIBC_HAS_XLOCALE__
361 /* Again versions of a few functions which use the given locale instead
362 of the global one. */
363 extern int strcasecmp_l (__const
char *__s1
, __const
char *__s2
,
365 __THROW __attribute_pure__
__nonnull ((1, 2, 3));
367 extern int strncasecmp_l (__const
char *__s1
, __const
char *__s2
,
368 size_t __n
, __locale_t __loc
)
369 __THROW __attribute_pure__
__nonnull ((1, 2, 4));
373 /* Return the next DELIM-delimited token from *STRINGP,
374 terminating it with a '\0', and update *STRINGP to point past it. */
375 extern char *strsep (char **__restrict __stringp
,
376 __const
char *__restrict __delim
)
377 __THROW
__nonnull ((1, 2));
381 /* Compare S1 and S2 as strings holding name & indices/version numbers. */
382 extern int strverscmp (__const
char *__s1
, __const
char *__s2
)
383 __THROW __attribute_pure__
__nonnull ((1, 2));
385 /* Return a string describing the meaning of the signal number in SIG. */
386 extern char *strsignal (int __sig
) __THROW
;
388 /* Copy SRC to DEST, returning the address of the terminating '\0' in DEST. */
389 # if 0 /* uClibc: disabled */
390 extern char *__stpcpy (char *__restrict __dest
, __const
char *__restrict __src
)
391 __THROW
__nonnull ((1, 2));
393 extern char *stpcpy (char *__restrict __dest
, __const
char *__restrict __src
)
394 __THROW
__nonnull ((1, 2));
396 /* Copy no more than N characters of SRC to DEST, returning the address of
397 the last character written into DEST. */
398 # if 0 /* uClibc: disabled */
399 extern char *__stpncpy (char *__restrict __dest
,
400 __const
char *__restrict __src
, size_t __n
)
401 __THROW
__nonnull ((1, 2));
403 extern char *stpncpy (char *__restrict __dest
,
404 __const
char *__restrict __src
, size_t __n
)
405 __THROW
__nonnull ((1, 2));
407 # if 0 /* uClibc does not support strfry or memfrob. */
408 /* Sautee STRING briskly. */
409 extern char *strfry (char *__string
) __THROW
__nonnull ((1));
411 /* Frobnicate N bytes of S. */
412 extern void *memfrob (void *__s
, size_t __n
) __THROW
__nonnull ((1));
416 /* Return the file name within directory of FILENAME. We don't
417 declare the function if the `basename' macro is available (defined
418 in <libgen.h>) which makes the XPG version of this function
420 extern char *basename (__const
char *__filename
) __THROW
__nonnull ((1));
422 #endif /* __USE_GNU */
426 /* Two OpenBSD extension functions. */
427 extern size_t strlcat(char *__restrict dst
, const char *__restrict src
,
428 size_t n
) __THROW
__nonnull ((1, 2));
429 extern size_t strlcpy(char *__restrict dst
, const char *__restrict src
,
430 size_t n
) __THROW
__nonnull ((1, 2));
437 #endif /* string.h */