include/string.h

   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.
   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 /* 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)
  42      __THROW;
  43
  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,
  49                       int __c, size_t __n)
  50      __THROW;
  51 #endif /* SVID.  */
  52
  53
  54 /* Set N bytes of S to C.  */
  55 extern void *memset (void *__s, int __c, size_t __n) __THROW;
  56
  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__;
  60
  61 /* Search N bytes of S for C.  */
  62 extern void *memchr (__const void *__s, int __c, size_t __n)
  63       __THROW __attribute_pure__;
  64
  65 /*#ifdef __USE_GNU*/
  66 #if 0
  67 /* Search in S for C.  This is similar to `memchr' but there is no
  68    length limit.  */
  69 extern void *rawmemchr (__const void *__s, int __c) __THROW __attribute_pure__;
  70
  71 #endif
  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__;
  75
  76
  77 /* Copy SRC to DEST.  */
  78 extern char *strcpy (char *__restrict __dest, __const char *__restrict __src)
  79      __THROW;
  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;
  83
  84 /* Append SRC onto DEST.  */
  85 extern char *strcat (char *__restrict __dest, __const char *__restrict __src)
  86      __THROW;
  87 /* Append no more than N characters from SRC onto DEST.  */
  88 extern char *strncat (char *__restrict __dest, __const char *__restrict __src,
  89                       size_t __n) __THROW;
  90
  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__;
  97
  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;
 104
 105 #if 0
 106 /*#ifdef __USE_GNU*/
 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>
 111
 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;
 118 #endif
 119
 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__;
 123 #endif
 124
 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__;
 131 #endif
 132
 133 #if defined __USE_GNU && defined __GNUC__
 134 /* Duplicate S, returning an identical alloca'd string.  */
 135 # define strdupa(s)                                                           \
 136   (__extension__                                                              \
 137     ({                                                                        \
 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);                                  \
 142     }))
 143
 144 /* Return an alloca'd copy of at most N bytes of string.  */
 145 # define strndupa(s, n)                                                       \
 146   (__extension__                                                              \
 147     ({                                                                        \
 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);                                  \
 153     }))
 154 #endif
 155
 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__;
 160
 161 #if 0
 162 /*#ifdef __USE_GNU*/
 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__;
 166 #endif
 167
 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__;
 182
 183 #ifdef __USE_GNU
 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__;
 187 #endif
 188
 189 /* Divide S into tokens separated by characters in DELIM.  */
 190 extern char *strtok (char *__restrict __s, __const char *__restrict __delim)
 191      __THROW;
 192
 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;
 201 #endif
 202
 203 #ifdef __USE_GNU
 204 #if 0
 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__;
 211 #endif
 212
 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;
 219 #endif
 220
 221
 222 /* Return the length of S.  */
 223 extern size_t strlen (__const char *__s) __THROW __attribute_pure__;
 224
 225 #ifdef  __USE_GNU
 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__;
 230 #endif
 231
 232
 233 /* Return a string describing the meaning of the `errno' code in ERRNUM.  */
 234 extern char *strerror (int __errnum) __THROW;
 235
 236 /* Reentrant versions of `strerror'.  If a temporary buffer is required,
 237    at most BUFLEN bytes of BUF will be used.  These symbols are _NOT_ intended
 238    to be applications, and can change at any time. */
 239 extern char *_glibc_strerror_r (int __errnum, char *__buf, size_t __buflen) __THROW;
 240 extern int _susv3_strerror_r (int __errnum, char *__buf, size_t buflen) __THROW;
 241
 242 #if defined(__USE_XOPEN2K) && !defined(__USE_GNU)
 243 # ifdef __REDIRECT
 244 extern int __REDIRECT (strerror_r,
 245                        (int __errnum, char *__buf, size_t buflen) __THROW,
 246                        _susv3_strerror_r);
 247 # else
 248 #  define strerror_r _susv3_strerror_r
 249 # endif
 250 #elif defined(__USE_MISC)
 251 # ifdef __REDIRECT
 252 extern char *__REDIRECT (strerror_r,
 253                          (int __errnum, char *__buf, size_t buflen) __THROW,
 254                          _glibc_strerror_r);
 255 # else
 256 #  define strerror_r _glibc_strerror_r
 257 # endif
 258 #endif
 259
 260 /* We define this function always since `bzero' is sometimes needed when
 261    the namespace rules does not allow this.  */
 262 extern void __bzero (void *__s, size_t __n) __THROW;
 263
 264 #if defined __USE_BSD
 265 /* Copy N bytes of SRC to DEST (like memmove, but args reversed).  */
 266 extern void bcopy (__const void *__src, void *__dest, size_t __n) __THROW;
 267
 268 /* Set N bytes of S to 0.  */
 269 extern void bzero (void *__s, size_t __n) __THROW;
 270
 271 /* Compare N bytes of S1 and S2 (same as memcmp).  */
 272 extern int bcmp (__const void *__s1, __const void *__s2, size_t __n)
 273      __THROW __attribute_pure__;
 274
 275 /* Find the first occurrence of C in S (same as strchr).  */
 276 extern char *index (__const char *__s, int __c) __THROW __attribute_pure__;
 277
 278 /* Find the last occurrence of C in S (same as strrchr).  */
 279 extern char *rindex (__const char *__s, int __c) __THROW __attribute_pure__;
 280
 281 /* Return the position of the first bit set in I, or 0 if none are set.
 282    The least-significant bit is position 1, the most-significant 32.  */
 283 extern int ffs (int __i) __THROW __attribute__ ((__const__));
 284
 285 /* The following two functions are non-standard but necessary for non-32 bit
 286    platforms.  */
 287 # if 0
 288 /*# ifdef       __USE_GNU*/
 289 extern int ffsl (long int __l) __THROW __attribute__ ((__const__));
 290 #  ifdef __GNUC__
 291 __extension__ extern int ffsll (long long int __ll)
 292      __THROW __attribute__ ((__const__));
 293 #  endif
 294 # endif
 295
 296 /* Compare S1 and S2, ignoring case.  */
 297 extern int strcasecmp (__const char *__s1, __const char *__s2)
 298      __THROW __attribute_pure__;
 299
 300 /* Compare no more than N chars of S1 and S2, ignoring case.  */
 301 extern int strncasecmp (__const char *__s1, __const char *__s2, size_t __n)
 302      __THROW __attribute_pure__;
 303 #endif /* Use BSD.  */
 304
 305 #if 0
 306 /*#ifdef        __USE_GNU*/
 307 /* Again versions of a few functions which use the given locale instead
 308    of the global one.  */
 309 extern int __strcasecmp_l (__const char *__s1, __const char *__s2,
 310                            __locale_t __loc) __THROW __attribute_pure__;
 311
 312 extern int __strncasecmp_l (__const char *__s1, __const char *__s2,
 313                             size_t __n, __locale_t __loc)
 314      __THROW __attribute_pure__;
 315 #endif
 316
 317 #ifdef  __USE_BSD
 318 /* Return the next DELIM-delimited token from *STRINGP,
 319    terminating it with a '\0', and update *STRINGP to point past it.  */
 320 extern char *strsep (char **__restrict __stringp,
 321                      __const char *__restrict __delim) __THROW;
 322 #endif
 323
 324 #ifdef  __USE_GNU
 325 #if 0
 326 /* Compare S1 and S2 as strings holding name & indices/version numbers.  */
 327 extern int strverscmp (__const char *__s1, __const char *__s2)
 328      __THROW __attribute_pure__;
 329 #endif
 330
 331 /* Return a string describing the meaning of the signal number in SIG.  */
 332 extern char *strsignal (int __sig) __THROW;
 333
 334 /* Copy SRC to DEST, returning the address of the terminating '\0' in DEST.  */
 335 extern char *__stpcpy (char *__restrict __dest, __const char *__restrict __src)
 336      __THROW;
 337 extern char *stpcpy (char *__restrict __dest, __const char *__restrict __src)
 338      __THROW;
 339
 340 /* Copy no more than N characters of SRC to DEST, returning the address of
 341    the last character written into DEST.  */
 342 extern char *__stpncpy (char *__restrict __dest,
 343                         __const char *__restrict __src, size_t __n) __THROW;
 344 extern char *stpncpy (char *__restrict __dest,
 345                       __const char *__restrict __src, size_t __n) __THROW;
 346
 347 #if 0
 348 /* Sautee STRING briskly.  */
 349 extern char *strfry (char *__string) __THROW;
 350
 351 /* Frobnicate N bytes of S.  */
 352 extern void *memfrob (void *__s, size_t __n) __THROW;
 353 #endif
 354
 355 # ifndef basename
 356 /* Return the file name within directory of FILENAME.  We don't
 357    declare the function if the `basename' macro is available (defined
 358    in <libgen.h>) which makes the XPG version of this function
 359    available.  */
 360 extern char *basename (__const char *__filename) __THROW;
 361 # endif
 362 #endif
 363
 364 #if 0
 365 #if defined __GNUC__ && __GNUC__ >= 2
 366 # if defined __OPTIMIZE__ && !defined __OPTIMIZE_SIZE__ \
 367      && !defined __NO_INLINE__ && !defined __cplusplus
 368 /* When using GNU CC we provide some optimized versions of selected
 369    functions from this header.  There are two kinds of optimizations:
 370
 371    - machine-dependent optimizations, most probably using inline
 372      assembler code; these might be quite expensive since the code
 373      size can increase significantly.
 374      These optimizations are not used unless the symbol
 375         __USE_STRING_INLINES
 376      is defined before including this header.
 377
 378    - machine-independent optimizations which do not increase the
 379      code size significantly and which optimize mainly situations
 380      where one or more arguments are compile-time constants.
 381      These optimizations are used always when the compiler is
 382      taught to optimize.
 383
 384    One can inhibit all optimizations by defining __NO_STRING_INLINES.  */
 385
 386 /* Get the machine-dependent optimizations (if any).  */
 387 #  include <bits/string.h>
 388
 389 /* These are generic optimizations which do not add too much inline code.  */
 390 #  include <bits/string2.h>
 391 # endif
 392 #endif
 393 #endif
 394
 395 #ifdef  __USE_BSD
 396 /* Two OpenBSD extension functions. */
 397 extern size_t strlcat(char *__restrict dst, const char *__restrict src,
 398                       size_t n) __THROW;
 399 extern size_t strlcpy(char *__restrict dst, const char *__restrict src,
 400                       size_t n) __THROW;
 401 #endif
 402
 403 __END_DECLS
 404
 405 #endif /* string.h  */