tools/brcm/K26/hndtools-mipsel-uclibc-4.2.4/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 /* 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));
  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
  51 extern 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.  */
  59 extern void *memset (void *__s, int __c, size_t __n) __THROW __nonnull ((1));
  60
  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));
  64
  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));
  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.  */
  73 extern 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.  */
  77 extern 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.  */
  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));
  90
  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));
  97
  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));
 104
 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));
 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.  */
 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));
 126 #endif
 127
 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));
 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
 138 extern 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.  */
 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));
 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.  */
 177 extern 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.  */
 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));
 196
 197
 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));
 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 */
 206 extern 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
 212 extern 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.  */
 219 extern 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.  */
 227 extern 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 __GNUC_PREREQ (3, 4)
 234 # define __mempcpy(dest, src, n) __builtin_mempcpy(dest, src, n)
 235 #else /* uClibc: disabled */
 236 extern void *__mempcpy (void *__restrict __dest,
 237                         __const void *__restrict __src, size_t __n)
 238      __THROW __nonnull ((1, 2));
 239 #endif
 240 extern void *mempcpy (void *__restrict __dest,
 241                       __const void *__restrict __src, size_t __n)
 242      __THROW __nonnull ((1, 2));
 243 #endif
 244
 245
 246 __BEGIN_NAMESPACE_STD
 247 /* Return the length of S.  */
 248 extern size_t strlen (__const char *__s)
 249      __THROW __attribute_pure__ __nonnull ((1));
 250 __END_NAMESPACE_STD
 251
 252 #ifdef  __USE_GNU
 253 /* Find the length of STRING, but scan at most MAXLEN characters.
 254    If no '\0' terminator is found in that many characters, return MAXLEN.  */
 255 extern size_t strnlen (__const char *__string, size_t __maxlen)
 256      __THROW __attribute_pure__ __nonnull ((1));
 257 #endif
 258
 259
 260 __BEGIN_NAMESPACE_STD
 261 /* Return a string describing the meaning of the `errno' code in ERRNUM.  */
 262 extern char *strerror (int __errnum) __THROW;
 263 __END_NAMESPACE_STD
 264 #if defined __USE_XOPEN2K || defined __USE_MISC
 265 /* Reentrant version of `strerror'.
 266    There are 2 flavors of `strerror_r', GNU which returns the string
 267    and may or may not use the supplied temporary buffer and POSIX one
 268    which fills the string into the buffer.
 269    To use the POSIX version, -D_XOPEN_SOURCE=600 or -D_POSIX_C_SOURCE=200112L
 270    without -D_GNU_SOURCE is needed, otherwise the GNU version is
 271    preferred.  */
 272 # if defined __USE_XOPEN2K && !defined __USE_GNU
 273 /* Fill BUF with a string describing the meaning of the `errno' code in
 274    ERRNUM.  */
 275 extern int __xpg_strerror_r (int __errnum, char *__buf, size_t __buflen)
 276      __THROW __nonnull ((2));
 277 #  ifdef __REDIRECT_NTH
 278 extern int __REDIRECT_NTH (strerror_r,
 279                            (int __errnum, char *__buf, size_t __buflen),
 280                            __xpg_strerror_r) __nonnull ((2));
 281 #  else
 282 #   define strerror_r __xpg_strerror_r
 283 #  endif
 284 # else
 285 /* If a temporary buffer is required, at most BUFLEN bytes of BUF will be
 286    used.  */
 287 extern char *__glibc_strerror_r (int __errnum, char *__buf, size_t __buflen)
 288      __THROW __nonnull ((2));
 289 #  ifdef __REDIRECT_NTH
 290 extern char * __REDIRECT_NTH (strerror_r,
 291                            (int __errnum, char *__buf, size_t __buflen),
 292                            __glibc_strerror_r) __nonnull ((2));
 293 #  else
 294 #   define strerror_r __glibc_strerror_r
 295 #  endif
 296 # endif
 297 #endif
 298
 299 /* We define this function always since `bzero' is sometimes needed when
 300    the namespace rules does not allow this.  */
 301 #if 0 /* uClibc: disabled */
 302 extern void __bzero (void *__s, size_t __n) __THROW __nonnull ((1));
 303 #endif
 304
 305 #ifdef __USE_BSD
 306 # ifdef __UCLIBC_SUSV3_LEGACY__
 307 /* Copy N bytes of SRC to DEST (like memmove, but args reversed).  */
 308 extern void bcopy (__const void *__src, void *__dest, size_t __n)
 309      __THROW __nonnull ((1, 2));
 310
 311 /* Set N bytes of S to 0.  */
 312 extern void bzero (void *__s, size_t __n) __THROW __nonnull ((1));
 313
 314 /* Compare N bytes of S1 and S2 (same as memcmp).  */
 315 extern int bcmp (__const void *__s1, __const void *__s2, size_t __n)
 316      __THROW __attribute_pure__ __nonnull ((1, 2));
 317
 318 /* Find the first occurrence of C in S (same as strchr).  */
 319 extern char *index (__const char *__s, int __c)
 320      __THROW __attribute_pure__ __nonnull ((1));
 321
 322 /* Find the last occurrence of C in S (same as strrchr).  */
 323 extern char *rindex (__const char *__s, int __c)
 324      __THROW __attribute_pure__ __nonnull ((1));
 325 # elif defined(__UCLIBC_SUSV3_LEGACY_MACROS__) && !defined(_STRINGS_H)
 326 /* bcopy/bzero/bcmp/index/rindex are marked LEGACY in SuSv3.
 327  * They are replaced as proposed by SuSv3. Don't sync this part
 328  * with glibc and keep it in sync with strings.h.  */
 329
 330 /* Copy N bytes of SRC to DEST (like memmove, but args reversed).  */
 331 static __inline__ void bcopy (__const void *__src, void *__dest, size_t __n)
 332 {
 333         memmove(__dest, __src, __n);
 334 }
 335
 336 /* Set N bytes of S to 0.  */
 337 static __inline__ void bzero (void *__s, size_t __n)
 338 {
 339         memset(__s, 0, __n);
 340 }
 341
 342 /* Compare N bytes of S1 and S2 (same as memcmp).  */
 343 static __inline__ int bcmp (__const void *__s1, __const void *__s2, size_t __n)
 344 {
 345         return memcmp(__s1, __s2, __n);
 346 }
 347
 348 /* Find the first occurrence of C in S (same as strchr).  */
 349 static __inline__ char *index (__const char *__s, int __c)
 350 {
 351         return strchr(__s, __c);
 352 }
 353
 354 /* Find the last occurrence of C in S (same as strrchr).  */
 355 static __inline__ char *rindex (__const char *__s, int __c)
 356 {
 357         return strrchr(__s, __c);
 358 }
 359 # endif
 360
 361 /* Return the position of the first bit set in I, or 0 if none are set.
 362    The least-significant bit is position 1, the most-significant 32.  */
 363 extern int ffs (int __i) __THROW __attribute__ ((__const__));
 364
 365 /* The following two functions are non-standard but necessary for non-32 bit
 366    platforms.  */
 367 #if 0 /*def     __USE_GNU*/
 368 extern int ffsl (long int __l) __THROW __attribute__ ((__const__));
 369 #  ifdef __GNUC__
 370 __extension__ extern int ffsll (long long int __ll)
 371      __THROW __attribute__ ((__const__));
 372 #  endif
 373 # endif
 374
 375 /* Compare S1 and S2, ignoring case.  */
 376 extern int strcasecmp (__const char *__s1, __const char *__s2)
 377      __THROW __attribute_pure__ __nonnull ((1, 2));
 378
 379 /* Compare no more than N chars of S1 and S2, ignoring case.  */
 380 extern int strncasecmp (__const char *__s1, __const char *__s2, size_t __n)
 381      __THROW __attribute_pure__ __nonnull ((1, 2));
 382 #endif /* Use BSD.  */
 383
 384 #if defined __USE_GNU && defined __UCLIBC_HAS_XLOCALE__
 385 /* Again versions of a few functions which use the given locale instead
 386    of the global one.  */
 387 extern int strcasecmp_l (__const char *__s1, __const char *__s2,
 388                          __locale_t __loc)
 389      __THROW __attribute_pure__ __nonnull ((1, 2, 3));
 390
 391 extern int strncasecmp_l (__const char *__s1, __const char *__s2,
 392                           size_t __n, __locale_t __loc)
 393      __THROW __attribute_pure__ __nonnull ((1, 2, 4));
 394 #endif
 395
 396 #ifdef  __USE_BSD
 397 /* Return the next DELIM-delimited token from *STRINGP,
 398    terminating it with a '\0', and update *STRINGP to point past it.  */
 399 extern char *strsep (char **__restrict __stringp,
 400                      __const char *__restrict __delim)
 401      __THROW __nonnull ((1, 2));
 402 #endif
 403
 404 #ifdef  __USE_GNU
 405 /* Compare S1 and S2 as strings holding name & indices/version numbers.  */
 406 extern int strverscmp (__const char *__s1, __const char *__s2)
 407      __THROW __attribute_pure__ __nonnull ((1, 2));
 408
 409 /* Return a string describing the meaning of the signal number in SIG.  */
 410 extern char *strsignal (int __sig) __THROW;
 411
 412 /* Copy SRC to DEST, returning the address of the terminating '\0' in DEST.  */
 413 #if 0 /* uClibc: disabled */
 414 extern char *__stpcpy (char *__restrict __dest, __const char *__restrict __src)
 415      __THROW __nonnull ((1, 2));
 416 #endif
 417 extern char *stpcpy (char *__restrict __dest, __const char *__restrict __src)
 418      __THROW __nonnull ((1, 2));
 419
 420 /* Copy no more than N characters of SRC to DEST, returning the address of
 421    the last character written into DEST.  */
 422 #if 0 /* uClibc: disabled */
 423 extern char *__stpncpy (char *__restrict __dest,
 424                         __const char *__restrict __src, size_t __n)
 425      __THROW __nonnull ((1, 2));
 426 #endif
 427 extern char *stpncpy (char *__restrict __dest,
 428                       __const char *__restrict __src, size_t __n)
 429      __THROW __nonnull ((1, 2));
 430
 431 #if 0                                                   /* uClibc does not support strfry or memfrob. */
 432 /* Sautee STRING briskly.  */
 433 extern char *strfry (char *__string) __THROW __nonnull ((1));
 434
 435 /* Frobnicate N bytes of S.  */
 436 extern void *memfrob (void *__s, size_t __n) __THROW __nonnull ((1));
 437 #endif
 438
 439 # ifndef basename
 440 /* Return the file name within directory of FILENAME.  We don't
 441    declare the function if the `basename' macro is available (defined
 442    in <libgen.h>) which makes the XPG version of this function
 443    available.  */
 444 extern char *basename (__const char *__filename) __THROW __nonnull ((1));
 445 # endif
 446 #endif
 447
 448
 449 #ifdef  __USE_BSD
 450 /* Two OpenBSD extension functions. */
 451 extern size_t strlcat(char *__restrict dst, const char *__restrict src,
 452                       size_t n) __THROW __nonnull ((1, 2));
 453 extern size_t strlcpy(char *__restrict dst, const char *__restrict src,
 454                       size_t n) __THROW __nonnull ((1, 2));
 455 #endif
 456
 457 __END_DECLS
 458
 459 #endif /* string.h  */