include/string.h

   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.  */
  38 extern void *memcpy (void *__restrict __dest,
  39                      __const void *__restrict __src, size_t __n)
  40      __THROW __nonnull ((1, 2));
  41 libc_hidden_proto(memcpy)
  42 /* Copy N bytes of SRC to DEST, guaranteeing
  43    correct behavior for overlapping strings.  */
  44 extern void *memmove (void *__dest, __const void *__src, size_t __n)
  45      __THROW __nonnull ((1, 2));
  46 libc_hidden_proto(memmove)
  47 __END_NAMESPACE_STD
  48
  49 /* Copy no more than N bytes of SRC to DEST, stopping when C is found.
  50    Return the position in DEST one byte past where C was copied,
  51    or NULL if C was not found in the first N bytes of SRC.  */
  52 #if defined __USE_SVID || defined __USE_BSD || defined __USE_XOPEN
  53 extern void *memccpy (void *__restrict __dest, __const void *__restrict __src,
  54                       int __c, size_t __n)
  55      __THROW __nonnull ((1, 2));
  56 libc_hidden_proto(memccpy)
  57 #endif /* SVID.  */
  58
  59
  60 __BEGIN_NAMESPACE_STD
  61 /* Set N bytes of S to C.  */
  62 extern void *memset (void *__s, int __c, size_t __n) __THROW __nonnull ((1));
  63 libc_hidden_proto(memset)
  64
  65 /* Compare N bytes of S1 and S2.  */
  66 extern int memcmp (__const void *__s1, __const void *__s2, size_t __n)
  67      __THROW __attribute_pure__ __nonnull ((1, 2));
  68 libc_hidden_proto(memcmp)
  69
  70 /* Search N bytes of S for C.  */
  71 extern void *memchr (__const void *__s, int __c, size_t __n)
  72       __THROW __attribute_pure__ __nonnull ((1));
  73 libc_hidden_proto(memchr)
  74 __END_NAMESPACE_STD
  75
  76 #ifdef __USE_GNU
  77 /* Search in S for C.  This is similar to `memchr' but there is no
  78    length limit.  */
  79 extern void *rawmemchr (__const void *__s, int __c)
  80      __THROW __attribute_pure__ __nonnull ((1));
  81 libc_hidden_proto(rawmemchr)
  82
  83 /* Search N bytes of S for the final occurrence of C.  */
  84 extern void *memrchr (__const void *__s, int __c, size_t __n)
  85       __THROW __attribute_pure__ __nonnull ((1));
  86 libc_hidden_proto(memrchr)
  87 #endif
  88
  89
  90 __BEGIN_NAMESPACE_STD
  91 /* Copy SRC to DEST.  */
  92 extern char *strcpy (char *__restrict __dest, __const char *__restrict __src)
  93      __THROW __nonnull ((1, 2));
  94 libc_hidden_proto(strcpy)
  95 /* Copy no more than N characters of SRC to DEST.  */
  96 extern char *strncpy (char *__restrict __dest,
  97                       __const char *__restrict __src, size_t __n)
  98      __THROW __nonnull ((1, 2));
  99 libc_hidden_proto(strncpy)
 100
 101 /* Append SRC onto DEST.  */
 102 extern char *strcat (char *__restrict __dest, __const char *__restrict __src)
 103      __THROW __nonnull ((1, 2));
 104 libc_hidden_proto(strcat)
 105 /* Append no more than N characters from SRC onto DEST.  */
 106 extern char *strncat (char *__restrict __dest, __const char *__restrict __src,
 107                       size_t __n) __THROW __nonnull ((1, 2));
 108 libc_hidden_proto(strncat)
 109
 110 /* Compare S1 and S2.  */
 111 extern int strcmp (__const char *__s1, __const char *__s2)
 112      __THROW __attribute_pure__ __nonnull ((1, 2));
 113 libc_hidden_proto(strcmp)
 114 /* Compare N characters of S1 and S2.  */
 115 extern int strncmp (__const char *__s1, __const char *__s2, size_t __n)
 116      __THROW __attribute_pure__ __nonnull ((1, 2));
 117 libc_hidden_proto(strncmp)
 118
 119 /* Compare the collated forms of S1 and S2.  */
 120 extern int strcoll (__const char *__s1, __const char *__s2)
 121      __THROW __attribute_pure__ __nonnull ((1, 2));
 122 libc_hidden_proto(strcoll)
 123 /* Put a transformation of SRC into no more than N bytes of DEST.  */
 124 extern size_t strxfrm (char *__restrict __dest,
 125                        __const char *__restrict __src, size_t __n)
 126      __THROW __nonnull ((2));
 127 libc_hidden_proto(strxfrm)
 128 __END_NAMESPACE_STD
 129
 130 #if defined __USE_GNU && defined __UCLIBC_HAS_XLOCALE__
 131 /* The following functions are equivalent to the both above but they
 132    take the locale they use for the collation as an extra argument.
 133    This is not standardsized but something like will come.  */
 134 # include <xlocale.h>
 135
 136 /* Compare the collated forms of S1 and S2 using rules from L.  */
 137 extern int strcoll_l (__const char *__s1, __const char *__s2, __locale_t __l)
 138      __THROW __attribute_pure__ __nonnull ((1, 2, 3));
 139 libc_hidden_proto(strcoll_l)
 140 /* Put a transformation of SRC into no more than N bytes of DEST.  */
 141 extern size_t strxfrm_l (char *__dest, __const char *__src, size_t __n,
 142                          __locale_t __l) __THROW __nonnull ((2, 4));
 143 libc_hidden_proto(strxfrm_l)
 144 #endif
 145
 146 #if defined __USE_SVID || defined __USE_BSD || defined __USE_XOPEN_EXTENDED
 147 /* Duplicate S, returning an identical malloc'd string.  */
 148 extern char *strdup (__const char *__s)
 149      __THROW __attribute_malloc__ __nonnull ((1));
 150 libc_hidden_proto(strdup)
 151 #endif
 152
 153 /* Return a malloc'd copy of at most N bytes of STRING.  The
 154    resultant string is terminated even if no null terminator
 155    appears before STRING[N].  */
 156 #if defined __USE_GNU
 157 extern char *strndup (__const char *__string, size_t __n)
 158      __THROW __attribute_malloc__ __nonnull ((1));
 159 libc_hidden_proto(strndup)
 160 #endif
 161
 162 #if defined __USE_GNU && defined __GNUC__
 163 /* Duplicate S, returning an identical alloca'd string.  */
 164 # define strdupa(s)                                                           \
 165   (__extension__                                                              \
 166     ({                                                                        \
 167       __const char *__old = (s);                                              \
 168       size_t __len = strlen (__old) + 1;                                      \
 169       char *__new = (char *) __builtin_alloca (__len);                        \
 170       (char *) memcpy (__new, __old, __len);                                  \
 171     }))
 172
 173 /* Return an alloca'd copy of at most N bytes of string.  */
 174 # define strndupa(s, n)                                                       \
 175   (__extension__                                                              \
 176     ({                                                                        \
 177       __const char *__old = (s);                                              \
 178       size_t __len = strnlen (__old, (n));                                    \
 179       char *__new = (char *) __builtin_alloca (__len + 1);                    \
 180       __new[__len] = '\0';                                                    \
 181       (char *) memcpy (__new, __old, __len);                                  \
 182     }))
 183 #endif
 184
 185 __BEGIN_NAMESPACE_STD
 186 /* Find the first occurrence of C in S.  */
 187 extern char *strchr (__const char *__s, int __c)
 188      __THROW __attribute_pure__ __nonnull ((1));
 189 libc_hidden_proto(strchr)
 190 /* Find the last occurrence of C in S.  */
 191 extern char *strrchr (__const char *__s, int __c)
 192      __THROW __attribute_pure__ __nonnull ((1));
 193 libc_hidden_proto(strrchr)
 194 __END_NAMESPACE_STD
 195
 196 #ifdef __USE_GNU
 197 /* This function is similar to `strchr'.  But it returns a pointer to
 198    the closing NUL byte in case C is not found in S.  */
 199 extern char *strchrnul (__const char *__s, int __c)
 200      __THROW __attribute_pure__ __nonnull ((1));
 201 libc_hidden_proto(strchrnul)
 202 #endif
 203
 204 __BEGIN_NAMESPACE_STD
 205 /* Return the length of the initial segment of S which
 206    consists entirely of characters not in REJECT.  */
 207 extern size_t strcspn (__const char *__s, __const char *__reject)
 208      __THROW __attribute_pure__ __nonnull ((1, 2));
 209 libc_hidden_proto(strcspn)
 210 /* Return the length of the initial segment of S which
 211    consists entirely of characters in ACCEPT.  */
 212 extern size_t strspn (__const char *__s, __const char *__accept)
 213      __THROW __attribute_pure__ __nonnull ((1, 2));
 214 libc_hidden_proto(strspn)
 215 /* Find the first occurrence in S of any character in ACCEPT.  */
 216 extern char *strpbrk (__const char *__s, __const char *__accept)
 217      __THROW __attribute_pure__ __nonnull ((1, 2));
 218 libc_hidden_proto(strpbrk)
 219 /* Find the first occurrence of NEEDLE in HAYSTACK.  */
 220 extern char *strstr (__const char *__haystack, __const char *__needle)
 221      __THROW __attribute_pure__ __nonnull ((1, 2));
 222 libc_hidden_proto(strstr)
 223
 224
 225 /* Divide S into tokens separated by characters in DELIM.  */
 226 extern char *strtok (char *__restrict __s, __const char *__restrict __delim)
 227      __THROW __nonnull ((2));
 228 libc_hidden_proto(strtok)
 229 __END_NAMESPACE_STD
 230
 231 /* Divide S into tokens separated by characters in DELIM.  Information
 232    passed between calls are stored in SAVE_PTR.  */
 233 #if 0 /* uClibc: disabled */
 234 extern char *__strtok_r (char *__restrict __s,
 235                          __const char *__restrict __delim,
 236                          char **__restrict __save_ptr)
 237      __THROW __nonnull ((2, 3));
 238 #endif
 239 #if defined __USE_POSIX || defined __USE_MISC
 240 extern char *strtok_r (char *__restrict __s, __const char *__restrict __delim,
 241                        char **__restrict __save_ptr)
 242      __THROW __nonnull ((2, 3));
 243 libc_hidden_proto(strtok_r)
 244 #endif
 245
 246 #ifdef __USE_GNU
 247 /* Similar to `strstr' but this function ignores the case of both strings.  */
 248 extern char *strcasestr (__const char *__haystack, __const char *__needle)
 249      __THROW __attribute_pure__ __nonnull ((1, 2));
 250 libc_hidden_proto(strcasestr)
 251 #endif
 252
 253 #ifdef __USE_GNU
 254 /* Find the first occurrence of NEEDLE in HAYSTACK.
 255    NEEDLE is NEEDLELEN bytes long;
 256    HAYSTACK is HAYSTACKLEN bytes long.  */
 257 extern void *memmem (__const void *__haystack, size_t __haystacklen,
 258                      __const void *__needle, size_t __needlelen)
 259      __THROW __attribute_pure__ __nonnull ((1, 3));
 260 libc_hidden_proto(memmem)
 261
 262 /* Copy N bytes of SRC to DEST, return pointer to bytes after the
 263    last written byte.  */
 264 #if 0 /* uClibc: disabled */
 265 extern void *__mempcpy (void *__restrict __dest,
 266                         __const void *__restrict __src, size_t __n)
 267      __THROW __nonnull ((1, 2));
 268 #endif
 269 extern void *mempcpy (void *__restrict __dest,
 270                       __const void *__restrict __src, size_t __n)
 271      __THROW __nonnull ((1, 2));
 272 libc_hidden_proto(mempcpy)
 273 #endif
 274
 275
 276 __BEGIN_NAMESPACE_STD
 277 /* Return the length of S.  */
 278 extern size_t strlen (__const char *__s)
 279      __THROW __attribute_pure__ __nonnull ((1));
 280 libc_hidden_proto(strlen)
 281 __END_NAMESPACE_STD
 282
 283 #ifdef  __USE_GNU
 284 /* Find the length of STRING, but scan at most MAXLEN characters.
 285    If no '\0' terminator is found in that many characters, return MAXLEN.  */
 286 extern size_t strnlen (__const char *__string, size_t __maxlen)
 287      __THROW __attribute_pure__ __nonnull ((1));
 288 libc_hidden_proto(strnlen)
 289 #endif
 290
 291
 292 __BEGIN_NAMESPACE_STD
 293 /* Return a string describing the meaning of the `errno' code in ERRNUM.  */
 294 extern char *strerror (int __errnum) __THROW;
 295 libc_hidden_proto(strerror)
 296 __END_NAMESPACE_STD
 297 #if defined __USE_XOPEN2K || defined __USE_MISC
 298 /* Reentrant version of `strerror'.
 299    There are 2 flavors of `strerror_r', GNU which returns the string
 300    and may or may not use the supplied temporary buffer and POSIX one
 301    which fills the string into the buffer.
 302    To use the POSIX version, -D_XOPEN_SOURCE=600 or -D_POSIX_C_SOURCE=200112L
 303    without -D_GNU_SOURCE is needed, otherwise the GNU version is
 304    preferred.  */
 305 # if defined __USE_XOPEN2K && !defined __USE_GNU
 306 /* Fill BUF with a string describing the meaning of the `errno' code in
 307    ERRNUM.  */
 308 extern int __xpg_strerror_r (int __errnum, char *__buf, size_t __buflen)
 309      __THROW __nonnull ((2));
 310 libc_hidden_proto(__xpg_strerror_r)
 311 #  ifdef __REDIRECT_NTH
 312 extern int __REDIRECT_NTH (strerror_r,
 313                            (int __errnum, char *__buf, size_t __buflen),
 314                            __xpg_strerror_r) __nonnull ((2));
 315 #  else
 316 #   define strerror_r __xpg_strerror_r
 317 #  endif
 318 # else
 319 /* If a temporary buffer is required, at most BUFLEN bytes of BUF will be
 320    used.  */
 321 extern char *__glibc_strerror_r (int __errnum, char *__buf, size_t __buflen)
 322      __THROW __nonnull ((2));
 323 libc_hidden_proto(__glibc_strerror_r)
 324 #  ifdef __REDIRECT_NTH
 325 extern char * __REDIRECT_NTH (strerror_r,
 326                            (int __errnum, char *__buf, size_t __buflen),
 327                            __glibc_strerror_r) __nonnull ((2));
 328 #  else
 329 #   define strerror_r __glibc_strerror_r
 330 #  endif
 331 # endif
 332 #endif
 333
 334 /* We define this function always since `bzero' is sometimes needed when
 335    the namespace rules does not allow this.  */
 336 #if 0 /* uClibc: disabled */
 337 extern void __bzero (void *__s, size_t __n) __THROW __nonnull ((1));
 338 #endif
 339
 340 #ifdef __USE_BSD
 341 # ifdef __UCLIBC_SUSV3_LEGACY__
 342 /* Copy N bytes of SRC to DEST (like memmove, but args reversed).  */
 343 extern void bcopy (__const void *__src, void *__dest, size_t __n)
 344      __THROW __nonnull ((1, 2));
 345
 346 /* Set N bytes of S to 0.  */
 347 extern void bzero (void *__s, size_t __n) __THROW __nonnull ((1));
 348
 349 /* Compare N bytes of S1 and S2 (same as memcmp).  */
 350 extern int bcmp (__const void *__s1, __const void *__s2, size_t __n)
 351      __THROW __attribute_pure__ __nonnull ((1, 2));
 352
 353 /* Find the first occurrence of C in S (same as strchr).  */
 354 extern char *index (__const char *__s, int __c)
 355      __THROW __attribute_pure__ __nonnull ((1));
 356
 357 /* Find the last occurrence of C in S (same as strrchr).  */
 358 extern char *rindex (__const char *__s, int __c)
 359      __THROW __attribute_pure__ __nonnull ((1));
 360 # else
 361 #  ifdef __UCLIBC_SUSV3_LEGACY_MACROS__
 362 /* bcopy/bzero/bcmp/index/rindex are marked LEGACY in SuSv3.
 363  * They are replaced as proposed by SuSv3. Don't sync this part
 364  * with glibc and keep it in sync with strings.h.  */
 365
 366 #  define bcopy(src,dest,n) (memmove((dest), (src), (n)), (void) 0)
 367 #  define bzero(s,n) (memset((s), '\0', (n)), (void) 0)
 368 #  define bcmp(s1,s2,n) memcmp((s1), (s2), (size_t)(n))
 369 #  define index(s,c) strchr((s), (c))
 370 #  define rindex(s,c) strrchr((s), (c))
 371 #  endif
 372 # endif
 373
 374 /* Return the position of the first bit set in I, or 0 if none are set.
 375    The least-significant bit is position 1, the most-significant 32.  */
 376 extern int ffs (int __i) __THROW __attribute__ ((__const__));
 377 libc_hidden_proto(ffs)
 378
 379 /* The following two functions are non-standard but necessary for non-32 bit
 380    platforms.  */
 381 # if 0 /*#ifdef __USE_GNU*/
 382 extern int ffsl (long int __l) __THROW __attribute__ ((__const__));
 383 #  ifdef __GNUC__
 384 __extension__ extern int ffsll (long long int __ll)
 385      __THROW __attribute__ ((__const__));
 386 #  endif
 387 # endif
 388
 389 /* Compare S1 and S2, ignoring case.  */
 390 extern int strcasecmp (__const char *__s1, __const char *__s2)
 391      __THROW __attribute_pure__ __nonnull ((1, 2));
 392 libc_hidden_proto(strcasecmp)
 393
 394 /* Compare no more than N chars of S1 and S2, ignoring case.  */
 395 extern int strncasecmp (__const char *__s1, __const char *__s2, size_t __n)
 396      __THROW __attribute_pure__ __nonnull ((1, 2));
 397 libc_hidden_proto(strncasecmp)
 398 #endif /* Use BSD.  */
 399
 400 #if defined __USE_GNU && defined __UCLIBC_HAS_XLOCALE__
 401 /* Again versions of a few functions which use the given locale instead
 402    of the global one.  */
 403 extern int strcasecmp_l (__const char *__s1, __const char *__s2,
 404                          __locale_t __loc)
 405      __THROW __attribute_pure__ __nonnull ((1, 2, 3));
 406 libc_hidden_proto(strcasecmp_l)
 407
 408 extern int strncasecmp_l (__const char *__s1, __const char *__s2,
 409                           size_t __n, __locale_t __loc)
 410      __THROW __attribute_pure__ __nonnull ((1, 2, 4));
 411 libc_hidden_proto(strncasecmp_l)
 412 #endif
 413
 414 #ifdef  __USE_BSD
 415 /* Return the next DELIM-delimited token from *STRINGP,
 416    terminating it with a '\0', and update *STRINGP to point past it.  */
 417 extern char *strsep (char **__restrict __stringp,
 418                      __const char *__restrict __delim)
 419      __THROW __nonnull ((1, 2));
 420 libc_hidden_proto(strsep)
 421 #endif
 422
 423 #ifdef  __USE_GNU
 424 /* Compare S1 and S2 as strings holding name & indices/version numbers.  */
 425 extern int strverscmp (__const char *__s1, __const char *__s2)
 426      __THROW __attribute_pure__ __nonnull ((1, 2));
 427 libc_hidden_proto(strverscmp)
 428
 429 /* Return a string describing the meaning of the signal number in SIG.  */
 430 extern char *strsignal (int __sig) __THROW;
 431 libc_hidden_proto(strsignal)
 432
 433 /* Copy SRC to DEST, returning the address of the terminating '\0' in DEST.  */
 434 # if 0 /* uClibc: disabled */
 435 extern char *__stpcpy (char *__restrict __dest, __const char *__restrict __src)
 436      __THROW __nonnull ((1, 2));
 437 # endif
 438 extern char *stpcpy (char *__restrict __dest, __const char *__restrict __src)
 439      __THROW __nonnull ((1, 2));
 440 libc_hidden_proto(stpcpy)
 441
 442 /* Copy no more than N characters of SRC to DEST, returning the address of
 443    the last character written into DEST.  */
 444 # if 0 /* uClibc: disabled */
 445 extern char *__stpncpy (char *__restrict __dest,
 446                         __const char *__restrict __src, size_t __n)
 447      __THROW __nonnull ((1, 2));
 448 # endif
 449 extern char *stpncpy (char *__restrict __dest,
 450                       __const char *__restrict __src, size_t __n)
 451      __THROW __nonnull ((1, 2));
 452 libc_hidden_proto(stpncpy)
 453
 454 # if 0                  /* uClibc does not support strfry or memfrob. */
 455 /* Sautee STRING briskly.  */
 456 extern char *strfry (char *__string) __THROW __nonnull ((1));
 457
 458 /* Frobnicate N bytes of S.  */
 459 extern void *memfrob (void *__s, size_t __n) __THROW __nonnull ((1));
 460 # endif
 461
 462 # ifndef basename
 463 /* Return the file name within directory of FILENAME.  We don't
 464    declare the function if the `basename' macro is available (defined
 465    in <libgen.h>) which makes the XPG version of this function
 466    available.  */
 467 extern char *basename (__const char *__filename) __THROW __nonnull ((1));
 468 libc_hidden_proto(basename)
 469 # endif
 470 #endif /* __USE_GNU */
 471
 472
 473 #ifdef  __USE_BSD
 474 /* Two OpenBSD extension functions. */
 475 extern size_t strlcat(char *__restrict dst, const char *__restrict src,
 476                       size_t n) __THROW __nonnull ((1, 2));
 477 libc_hidden_proto(strlcat)
 478 extern size_t strlcpy(char *__restrict dst, const char *__restrict src,
 479                       size_t n) __THROW __nonnull ((1, 2));
 480 libc_hidden_proto(strlcpy)
 481 #endif
 482
 483 __END_DECLS
 484
 485
 486 #if defined(_LIBC) && defined(__UCLIBC_HAS_STRING_ARCH_OPT__)
 487 # if defined __i386__
 488 #  include <../libc/string/i386/string.h>
 489 # endif
 490 #endif
 491
 492 #endif /* string.h */