1/* Copyright (C) 1991-1993, 1995-2003, 2004 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__BEGIN_NAMESPACE_STD 37/* Copy N bytes of SRC to DEST. */ 38extern 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. */ 43extern void *memmove (void *__dest, __const void *__src, size_t __n) 44 __THROW __nonnull ((1, 2)); 45__END_NAMESPACE_STD 46 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 51extern void *memccpy (void *__restrict __dest, __const void *__restrict __src, 52 int __c, size_t __n) 53 __THROW __nonnull ((1, 2)); 54#endif /* SVID. */ 55 56 57__BEGIN_NAMESPACE_STD 58/* Set N bytes of S to C. */ 59extern void *memset (void *__s, int __c, size_t __n) __THROW __nonnull ((1)); 60 61/* Compare N bytes of S1 and S2. */ 62extern int memcmp (__const void *__s1, __const void *__s2, size_t __n) 63 __THROW __attribute_pure__ __nonnull ((1, 2)); 64 65/* Search N bytes of S for C. */ 66extern void *memchr (__const void *__s, int __c, size_t __n) 67 __THROW __attribute_pure__ __nonnull ((1)); 68__END_NAMESPACE_STD 69 70#ifdef __USE_GNU 71/* Search in S for C. This is similar to `memchr' but there is no 72 length limit. */ 73extern void *rawmemchr (__const void *__s, int __c) 74 __THROW __attribute_pure__ __nonnull ((1)); 75 76/* Search N bytes of S for the final occurrence of C. */ 77extern void *memrchr (__const void *__s, int __c, size_t __n) 78 __THROW __attribute_pure__ __nonnull ((1)); 79#endif 80 81 82__BEGIN_NAMESPACE_STD 83/* Copy SRC to DEST. */ 84extern 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. */ 87extern char *strncpy (char *__restrict __dest, 88 __const char *__restrict __src, size_t __n) 89 __THROW __nonnull ((1, 2)); 90 91/* Append SRC onto DEST. */ 92extern 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. */ 95extern char *strncat (char *__restrict __dest, __const char *__restrict __src, 96 size_t __n) __THROW __nonnull ((1, 2)); 97 98/* Compare S1 and S2. */ 99extern int strcmp (__const char *__s1, __const char *__s2) 100 __THROW __attribute_pure__ __nonnull ((1, 2)); 101/* Compare N characters of S1 and S2. */ 102extern int strncmp (__const char *__s1, __const char *__s2, size_t __n) 103 __THROW __attribute_pure__ __nonnull ((1, 2)); 104 105/* Compare the collated forms of S1 and S2. */ 106extern 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. */ 109extern size_t strxfrm (char *__restrict __dest, 110 __const char *__restrict __src, size_t __n) 111 __THROW __nonnull ((2)); 112__END_NAMESPACE_STD 113 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> 119 120/* Compare the collated forms of S1 and S2 using rules from L. */ 121extern 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. */ 124extern size_t strxfrm_l (char *__dest, __const char *__src, size_t __n, 125 __locale_t __l) __THROW __nonnull ((2, 4)); 126#endif 127 128#if defined __USE_SVID || defined __USE_BSD || defined __USE_XOPEN_EXTENDED 129/* Duplicate S, returning an identical malloc'd string. */ 130extern char *strdup (__const char *__s) 131 __THROW __attribute_malloc__ __nonnull ((1)); 132#endif 133 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 138extern char *strndup (__const char *__string, size_t __n) 139 __THROW __attribute_malloc__ __nonnull ((1)); 140#endif 141 142#if defined __USE_GNU && defined __GNUC__ 143/* Duplicate S, returning an identical alloca'd string. */ 144# define strdupa(s) \ 145 (__extension__ \ 146 ({ \ 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); \ 151 })) 152 153/* Return an alloca'd copy of at most N bytes of string. */ 154# define strndupa(s, n) \ 155 (__extension__ \ 156 ({ \ 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); \ 162 })) 163#endif 164 165__BEGIN_NAMESPACE_STD 166/* Find the first occurrence of C in S. */ 167extern char *strchr (__const char *__s, int __c) 168 __THROW __attribute_pure__ __nonnull ((1)); 169/* Find the last occurrence of C in S. */ 170extern char *strrchr (__const char *__s, int __c) 171 __THROW __attribute_pure__ __nonnull ((1)); 172__END_NAMESPACE_STD 173 174#ifdef __USE_GNU 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. */ 177extern char *strchrnul (__const char *__s, int __c) 178 __THROW __attribute_pure__ __nonnull ((1)); 179#endif 180 181__BEGIN_NAMESPACE_STD 182/* Return the length of the initial segment of S which 183 consists entirely of characters not in REJECT. */ 184extern 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. */ 188extern 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. */ 191extern char *strpbrk (__const char *__s, __const char *__accept) 192 __THROW __attribute_pure__ __nonnull ((1, 2)); 193/* Find the first occurrence of NEEDLE in HAYSTACK. */ 194extern char *strstr (__const char *__haystack, __const char *__needle) 195 __THROW __attribute_pure__ __nonnull ((1, 2)); 196 197 198/* Divide S into tokens separated by characters in DELIM. */ 199extern char *strtok (char *__restrict __s, __const char *__restrict __delim) 200 __THROW __nonnull ((2)); 201__END_NAMESPACE_STD 202 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 */ 206extern char *__strtok_r (char *__restrict __s, 207 __const char *__restrict __delim, 208 char **__restrict __save_ptr) 209 __THROW __nonnull ((2, 3)); 210#endif 211#if defined __USE_POSIX || defined __USE_MISC 212extern char *strtok_r (char *__restrict __s, __const char *__restrict __delim, 213 char **__restrict __save_ptr) 214 __THROW __nonnull ((2, 3)); 215#endif 216 217#ifdef __USE_GNU 218/* Similar to `strstr' but this function ignores the case of both strings. */ 219extern char *strcasestr (__const char *__haystack, __const char *__needle) 220 __THROW __attribute_pure__ __nonnull ((1, 2)); 221#endif 222 223#ifdef __USE_GNU 224/* Find the first occurrence of NEEDLE in HAYSTACK. 225 NEEDLE is NEEDLELEN bytes long; 226 HAYSTACK is HAYSTACKLEN bytes long. */ 227extern void *memmem (__const void *__haystack, size_t __haystacklen, 228 __const void *__needle, size_t __needlelen) 229 __THROW __attribute_pure__ __nonnull ((1, 3)); 230 231/* Copy N bytes of SRC to DEST, return pointer to bytes after the 232 last written byte. */ 233#if 0 /* uClibc: disabled */ 234extern void *__mempcpy (void *__restrict __dest, 235 __const void *__restrict __src, size_t __n) 236 __THROW __nonnull ((1, 2)); 237#endif 238extern void *mempcpy (void *__restrict __dest, 239 __const void *__restrict __src, size_t __n) 240 __THROW __nonnull ((1, 2)); 241#endif 242 243 244__BEGIN_NAMESPACE_STD 245/* Return the length of S. */ 246extern size_t strlen (__const char *__s) 247 __THROW __attribute_pure__ __nonnull ((1)); 248__END_NAMESPACE_STD 249 250#ifdef __USE_GNU 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. */ 253extern size_t strnlen (__const char *__string, size_t __maxlen) 254 __THROW __attribute_pure__ __nonnull ((1)); 255#endif 256 257 258__BEGIN_NAMESPACE_STD 259/* Return a string describing the meaning of the `errno' code in ERRNUM. */ 260extern char *strerror (int __errnum) __THROW; 261__END_NAMESPACE_STD 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 269 preferred. */ 270# if defined __USE_XOPEN2K && !defined __USE_GNU 271/* Fill BUF with a string describing the meaning of the `errno' code in 272 ERRNUM. */ 273extern int __xpg_strerror_r (int __errnum, char *__buf, size_t __buflen) 274 __THROW __nonnull ((2)); 275# ifdef __REDIRECT_NTH 276extern int __REDIRECT_NTH (strerror_r, 277 (int __errnum, char *__buf, size_t __buflen), 278 __xpg_strerror_r) __nonnull ((2)); 279# else 280# define strerror_r __xpg_strerror_r 281# endif 282# else 283/* If a temporary buffer is required, at most BUFLEN bytes of BUF will be 284 used. */ 285extern char *__glibc_strerror_r (int __errnum, char *__buf, size_t __buflen) 286 __THROW __nonnull ((2)); 287# ifdef __REDIRECT_NTH 288extern char * __REDIRECT_NTH (strerror_r, 289 (int __errnum, char *__buf, size_t __buflen), 290 __glibc_strerror_r) __nonnull ((2)); 291# else 292# define strerror_r __glibc_strerror_r 293# endif 294# endif 295#endif 296 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 */ 300extern void __bzero (void *__s, size_t __n) __THROW __nonnull ((1)); 301#endif 302 303#ifdef __USE_BSD 304# ifdef __UCLIBC_SUSV3_LEGACY__ 305/* Copy N bytes of SRC to DEST (like memmove, but args reversed). */ 306extern void bcopy (__const void *__src, void *__dest, size_t __n) 307 __THROW __nonnull ((1, 2)); 308 309/* Set N bytes of S to 0. */ 310extern void bzero (void *__s, size_t __n) __THROW __nonnull ((1)); 311 312/* Compare N bytes of S1 and S2 (same as memcmp). */ 313extern int bcmp (__const void *__s1, __const void *__s2, size_t __n) 314 __THROW __attribute_pure__ __nonnull ((1, 2)); 315 316/* Find the first occurrence of C in S (same as strchr). */ 317extern char *index (__const char *__s, int __c) 318 __THROW __attribute_pure__ __nonnull ((1)); 319 320/* Find the last occurrence of C in S (same as strrchr). */ 321extern char *rindex (__const char *__s, int __c) 322 __THROW __attribute_pure__ __nonnull ((1)); 323# else 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. */ 328 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)) 334# endif 335# endif 336 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. */ 339extern int ffs (int __i) __THROW __attribute__ ((__const__)); 340 341/* The following two functions are non-standard but necessary for non-32 bit 342 platforms. */ 343#ifdef __USE_GNU 344extern int ffsl (long int __l) __THROW __attribute__ ((__const__)); 345# ifdef __GNUC__ 346__extension__ extern int ffsll (long long int __ll) 347 __THROW __attribute__ ((__const__)); 348# endif 349# endif 350 351/* Compare S1 and S2, ignoring case. */ 352extern int strcasecmp (__const char *__s1, __const char *__s2) 353 __THROW __attribute_pure__ __nonnull ((1, 2)); 354 355/* Compare no more than N chars of S1 and S2, ignoring case. */ 356extern int strncasecmp (__const char *__s1, __const char *__s2, size_t __n) 357 __THROW __attribute_pure__ __nonnull ((1, 2)); 358#endif /* Use BSD. */ 359 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. */ 363extern int strcasecmp_l (__const char *__s1, __const char *__s2, 364 __locale_t __loc) 365 __THROW __attribute_pure__ __nonnull ((1, 2, 3)); 366 367extern int strncasecmp_l (__const char *__s1, __const char *__s2, 368 size_t __n, __locale_t __loc) 369 __THROW __attribute_pure__ __nonnull ((1, 2, 4)); 370#endif 371 372#ifdef __USE_BSD 373/* Return the next DELIM-delimited token from *STRINGP, 374 terminating it with a '\0', and update *STRINGP to point past it. */ 375extern char *strsep (char **__restrict __stringp, 376 __const char *__restrict __delim) 377 __THROW __nonnull ((1, 2)); 378#endif 379 380#ifdef __USE_GNU 381/* Compare S1 and S2 as strings holding name & indices/version numbers. */ 382extern int strverscmp (__const char *__s1, __const char *__s2) 383 __THROW __attribute_pure__ __nonnull ((1, 2)); 384 385/* Return a string describing the meaning of the signal number in SIG. */ 386extern char *strsignal (int __sig) __THROW; 387 388/* Copy SRC to DEST, returning the address of the terminating '\0' in DEST. */ 389# if 0 /* uClibc: disabled */ 390extern char *__stpcpy (char *__restrict __dest, __const char *__restrict __src) 391 __THROW __nonnull ((1, 2)); 392# endif 393extern char *stpcpy (char *__restrict __dest, __const char *__restrict __src) 394 __THROW __nonnull ((1, 2)); 395 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 */ 399extern char *__stpncpy (char *__restrict __dest, 400 __const char *__restrict __src, size_t __n) 401 __THROW __nonnull ((1, 2)); 402# endif 403extern char *stpncpy (char *__restrict __dest, 404 __const char *__restrict __src, size_t __n) 405 __THROW __nonnull ((1, 2)); 406 407# if 0 /* uClibc does not support strfry or memfrob. */ 408/* Sautee STRING briskly. */ 409extern char *strfry (char *__string) __THROW __nonnull ((1)); 410 411/* Frobnicate N bytes of S. */ 412extern void *memfrob (void *__s, size_t __n) __THROW __nonnull ((1)); 413# endif 414 415# ifndef basename 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 419 available. */ 420extern char *basename (__const char *__filename) __THROW __nonnull ((1)); 421# endif 422#endif /* __USE_GNU */ 423 424 425#ifdef __USE_BSD 426/* Two OpenBSD extension functions. */ 427extern size_t strlcat(char *__restrict dst, const char *__restrict src, 428 size_t n) __THROW __nonnull ((1, 2)); 429extern size_t strlcpy(char *__restrict dst, const char *__restrict src, 430 size_t n) __THROW __nonnull ((1, 2)); 431#endif 432 433__END_DECLS 434 435 436 437#endif /* string.h */ 438