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 /* Search in S for C.  This is similar to `memchr' but there is no
  67    length limit.  */
  68 extern void *rawmemchr (__const void *__s, int __c) __THROW __attribute_pure__;
  69
  70 #endif
  71 /* Search N bytes of S for the final occurrence of C.  */
  72 extern void *memrchr (__const void *__s, int __c, size_t __n)
  73       __THROW __attribute_pure__;
  74
  75
  76 /* Copy SRC to DEST.  */
  77 extern char *strcpy (char *__restrict __dest, __const char *__restrict __src)
  78      __THROW;
  79 /* Copy no more than N characters of SRC to DEST.  */
  80 extern char *strncpy (char *__restrict __dest,
  81                       __const char *__restrict __src, size_t __n) __THROW;
  82
  83 /* Append SRC onto DEST.  */
  84 extern char *strcat (char *__restrict __dest, __const char *__restrict __src)
  85      __THROW;
  86 /* Append no more than N characters from SRC onto DEST.  */
  87 extern char *strncat (char *__restrict __dest, __const char *__restrict __src,
  88                       size_t __n) __THROW;
  89
  90 /* Compare S1 and S2.  */
  91 extern int strcmp (__const char *__s1, __const char *__s2)
  92      __THROW __attribute_pure__;
  93 /* Compare N characters of S1 and S2.  */
  94 extern int strncmp (__const char *__s1, __const char *__s2, size_t __n)
  95      __THROW __attribute_pure__;
  96
  97 /* Compare the collated forms of S1 and S2.  */
  98 extern int strcoll (__const char *__s1, __const char *__s2)
  99      __THROW __attribute_pure__;
 100 /* Put a transformation of SRC into no more than N bytes of DEST.  */
 101 extern size_t strxfrm (char *__restrict __dest,
 102                        __const char *__restrict __src, size_t __n) __THROW;
 103
 104 #if 0
 105 /*#ifdef __USE_GNU*/
 106 /* The following functions are equivalent to the both above but they
 107    take the locale they use for the collation as an extra argument.
 108    This is not standardsized but something like will come.  */
 109 # include <xlocale.h>
 110
 111 /* Compare the collated forms of S1 and S2 using rules from L.  */
 112 extern int __strcoll_l (__const char *__s1, __const char *__s2, __locale_t __l)
 113      __THROW __attribute_pure__;
 114 /* Put a transformation of SRC into no more than N bytes of DEST.  */
 115 extern size_t __strxfrm_l (char *__dest, __const char *__src, size_t __n,
 116                            __locale_t __l) __THROW;
 117 #endif
 118
 119 #if defined __USE_SVID || defined __USE_BSD || defined __USE_XOPEN_EXTENDED
 120 /* Duplicate S, returning an identical malloc'd string.  */
 121 extern char *strdup (__const char *__s) __THROW __attribute_malloc__;
 122 #endif
 123
 124 /* Return a malloc'd copy of at most N bytes of STRING.  The
 125    resultant string is terminated even if no null terminator
 126    appears before STRING[N].  */
 127 #if defined __USE_GNU
 128 extern char *strndup (__const char *__string, size_t __n)
 129      __THROW __attribute_malloc__;
 130 #endif
 131
 132 #if defined __USE_GNU && defined __GNUC__
 133 /* Duplicate S, returning an identical alloca'd string.  */
 134 # define strdupa(s)                                                           \
 135   (__extension__                                                              \
 136     ({                                                                        \
 137       __const char *__old = (s);                                              \
 138       size_t __len = strlen (__old) + 1;                                      \
 139       char *__new = (char *) __builtin_alloca (__len);                        \
 140       (char *) memcpy (__new, __old, __len);                                  \
 141     }))
 142
 143 /* Return an alloca'd copy of at most N bytes of string.  */
 144 # define strndupa(s, n)                                                       \
 145   (__extension__                                                              \
 146     ({                                                                        \
 147       __const char *__old = (s);                                              \
 148       size_t __len = strnlen (__old, (n));                                    \
 149       char *__new = (char *) __builtin_alloca (__len + 1);                    \
 150       __new[__len] = '\0';                                                    \
 151       (char *) memcpy (__new, __old, __len);                                  \
 152     }))
 153 #endif
 154
 155 /* Find the first occurrence of C in S.  */
 156 extern char *strchr (__const char *__s, int __c) __THROW __attribute_pure__;
 157 /* Find the last occurrence of C in S.  */
 158 extern char *strrchr (__const char *__s, int __c) __THROW __attribute_pure__;
 159
 160 #ifdef __USE_GNU
 161 /* This funciton is similar to `strchr'.  But it returns a pointer to
 162    the closing NUL byte in case C is not found in S.  */
 163 extern char *strchrnul (__const char *__s, int __c) __THROW __attribute_pure__;
 164 #endif
 165
 166 /* Return the length of the initial segment of S which
 167    consists entirely of characters not in REJECT.  */
 168 extern size_t strcspn (__const char *__s, __const char *__reject)
 169      __THROW __attribute_pure__;
 170 /* Return the length of the initial segment of S which
 171    consists entirely of characters in ACCEPT.  */
 172 extern size_t strspn (__const char *__s, __const char *__accept)
 173      __THROW __attribute_pure__;
 174 /* Find the first occurrence in S of any character in ACCEPT.  */
 175 extern char *strpbrk (__const char *__s, __const char *__accept)
 176      __THROW __attribute_pure__;
 177 /* Find the first occurrence of NEEDLE in HAYSTACK.  */
 178 extern char *strstr (__const char *__haystack, __const char *__needle)
 179      __THROW __attribute_pure__;
 180
 181 #ifdef __USE_GNU
 182 /* Similar to `strstr' but this function ignores the case of both strings.  */
 183 extern char *strcasestr (__const char *__haystack, __const char *__needle)
 184      __THROW __attribute_pure__;
 185 #endif
 186
 187 /* Divide S into tokens separated by characters in DELIM.  */
 188 extern char *strtok (char *__restrict __s, __const char *__restrict __delim)
 189      __THROW;
 190
 191 /* Divide S into tokens separated by characters in DELIM.  Information
 192    passed between calls are stored in SAVE_PTR.  */
 193 extern char *__strtok_r (char *__restrict __s,
 194                          __const char *__restrict __delim,
 195                          char **__restrict __save_ptr) __THROW;
 196 #if defined __USE_POSIX || defined __USE_MISC
 197 extern char *strtok_r (char *__restrict __s, __const char *__restrict __delim,
 198                        char **__restrict __save_ptr) __THROW;
 199 #endif
 200
 201 #ifdef __USE_GNU
 202 /* Find the first occurrence of NEEDLE in HAYSTACK.
 203    NEEDLE is NEEDLELEN bytes long;
 204    HAYSTACK is HAYSTACKLEN bytes long.  */
 205 extern void *memmem (__const void *__haystack, size_t __haystacklen,
 206                      __const void *__needle, size_t __needlelen)
 207      __THROW __attribute_pure__;
 208
 209 /* Copy N bytes of SRC to DEST, return pointer to bytes after the
 210    last written byte.  */
 211 extern void *__mempcpy (void *__restrict __dest,
 212                         __const void *__restrict __src, size_t __n) __THROW;
 213 extern void *mempcpy (void *__restrict __dest,
 214                       __const void *__restrict __src, size_t __n) __THROW;
 215 #endif
 216
 217
 218 /* Return the length of S.  */
 219 extern size_t strlen (__const char *__s) __THROW __attribute_pure__;
 220
 221 #ifdef  __USE_GNU
 222 /* Find the length of STRING, but scan at most MAXLEN characters.
 223    If no '\0' terminator is found in that many characters, return MAXLEN.  */
 224 extern size_t strnlen (__const char *__string, size_t __maxlen)
 225      __THROW __attribute_pure__;
 226 #endif
 227
 228
 229 /* Return a string describing the meaning of the `errno' code in ERRNUM.  */
 230 extern char *strerror (int __errnum) __THROW;
 231
 232 /* Reentrant versions of `strerror'.  If a temporary buffer is required,
 233    at most BUFLEN bytes of BUF will be used.  These symbols are _NOT_ intended
 234    to be applications, and can change at any time. */
 235 extern char *_glibc_strerror_r (int __errnum, char *__buf, size_t __buflen) __THROW;
 236 extern int _susv3_strerror_r (int __errnum, char *__buf, size_t buflen) __THROW;
 237
 238 #if defined(__USE_XOPEN2K) && !defined(__USE_GNU)
 239 # ifdef __REDIRECT
 240 extern int __REDIRECT (strerror_r,
 241                        (int __errnum, char *__buf, size_t buflen) __THROW,
 242                        _susv3_strerror_r);
 243 # else
 244 #  define strerror_r _susv3_strerror_r
 245 # endif
 246 #elif defined(__USE_MISC)
 247 # ifdef __REDIRECT
 248 extern char *__REDIRECT (strerror_r,
 249                          (int __errnum, char *__buf, size_t buflen) __THROW,
 250                          _glibc_strerror_r);
 251 # else
 252 #  define strerror_r _glibc_strerror_r
 253 # endif
 254 #endif
 255
 256 /* We define this function always since `bzero' is sometimes needed when
 257    the namespace rules does not allow this.  */
 258 extern void __bzero (void *__s, size_t __n) __THROW;
 259
 260 #if defined __USE_BSD
 261 /* Copy N bytes of SRC to DEST (like memmove, but args reversed).  */
 262 extern void bcopy (__const void *__src, void *__dest, size_t __n) __THROW;
 263
 264 /* Set N bytes of S to 0.  */
 265 extern void bzero (void *__s, size_t __n) __THROW;
 266
 267 /* Compare N bytes of S1 and S2 (same as memcmp).  */
 268 extern int bcmp (__const void *__s1, __const void *__s2, size_t __n)
 269      __THROW __attribute_pure__;
 270
 271 /* Find the first occurrence of C in S (same as strchr).  */
 272 extern char *index (__const char *__s, int __c) __THROW __attribute_pure__;
 273
 274 /* Find the last occurrence of C in S (same as strrchr).  */
 275 extern char *rindex (__const char *__s, int __c) __THROW __attribute_pure__;
 276
 277 /* Return the position of the first bit set in I, or 0 if none are set.
 278    The least-significant bit is position 1, the most-significant 32.  */
 279 extern int ffs (int __i) __THROW __attribute__ ((__const__));
 280
 281 /* The following two functions are non-standard but necessary for non-32 bit
 282    platforms.  */
 283 # if 0
 284 /*# ifdef       __USE_GNU*/
 285 extern int ffsl (long int __l) __THROW __attribute__ ((__const__));
 286 #  ifdef __GNUC__
 287 __extension__ extern int ffsll (long long int __ll)
 288      __THROW __attribute__ ((__const__));
 289 #  endif
 290 # endif
 291
 292 /* Compare S1 and S2, ignoring case.  */
 293 extern int strcasecmp (__const char *__s1, __const char *__s2)
 294      __THROW __attribute_pure__;
 295
 296 /* Compare no more than N chars of S1 and S2, ignoring case.  */
 297 extern int strncasecmp (__const char *__s1, __const char *__s2, size_t __n)
 298      __THROW __attribute_pure__;
 299 #endif /* Use BSD.  */
 300
 301 #if 0
 302 /*#ifdef        __USE_GNU*/
 303 /* Again versions of a few functions which use the given locale instead
 304    of the global one.  */
 305 extern int __strcasecmp_l (__const char *__s1, __const char *__s2,
 306                            __locale_t __loc) __THROW __attribute_pure__;
 307
 308 extern int __strncasecmp_l (__const char *__s1, __const char *__s2,
 309                             size_t __n, __locale_t __loc)
 310      __THROW __attribute_pure__;
 311 #endif
 312
 313 #ifdef  __USE_BSD
 314 /* Return the next DELIM-delimited token from *STRINGP,
 315    terminating it with a '\0', and update *STRINGP to point past it.  */
 316 extern char *strsep (char **__restrict __stringp,
 317                      __const char *__restrict __delim) __THROW;
 318 #endif
 319
 320 #ifdef  __USE_GNU
 321 #if 0
 322 /* Compare S1 and S2 as strings holding name & indices/version numbers.  */
 323 extern int strverscmp (__const char *__s1, __const char *__s2)
 324      __THROW __attribute_pure__;
 325 #endif
 326
 327 /* Return a string describing the meaning of the signal number in SIG.  */
 328 extern char *strsignal (int __sig) __THROW;
 329
 330 /* Copy SRC to DEST, returning the address of the terminating '\0' in DEST.  */
 331 extern char *__stpcpy (char *__restrict __dest, __const char *__restrict __src)
 332      __THROW;
 333 extern char *stpcpy (char *__restrict __dest, __const char *__restrict __src)
 334      __THROW;
 335
 336 /* Copy no more than N characters of SRC to DEST, returning the address of
 337    the last character written into DEST.  */
 338 extern char *__stpncpy (char *__restrict __dest,
 339                         __const char *__restrict __src, size_t __n) __THROW;
 340 extern char *stpncpy (char *__restrict __dest,
 341                       __const char *__restrict __src, size_t __n) __THROW;
 342
 343 #if 0
 344 /* Sautee STRING briskly.  */
 345 extern char *strfry (char *__string) __THROW;
 346
 347 /* Frobnicate N bytes of S.  */
 348 extern void *memfrob (void *__s, size_t __n) __THROW;
 349 #endif
 350
 351 # ifndef basename
 352 /* Return the file name within directory of FILENAME.  We don't
 353    declare the function if the `basename' macro is available (defined
 354    in <libgen.h>) which makes the XPG version of this function
 355    available.  */
 356 extern char *basename (__const char *__filename) __THROW;
 357 # endif
 358 #endif
 359
 360 #if 0
 361 #if defined __GNUC__ && __GNUC__ >= 2
 362 # if defined __OPTIMIZE__ && !defined __OPTIMIZE_SIZE__ \
 363      && !defined __NO_INLINE__ && !defined __cplusplus
 364 /* When using GNU CC we provide some optimized versions of selected
 365    functions from this header.  There are two kinds of optimizations:
 366
 367    - machine-dependent optimizations, most probably using inline
 368      assembler code; these might be quite expensive since the code
 369      size can increase significantly.
 370      These optimizations are not used unless the symbol
 371         __USE_STRING_INLINES
 372      is defined before including this header.
 373
 374    - machine-independent optimizations which do not increase the
 375      code size significantly and which optimize mainly situations
 376      where one or more arguments are compile-time constants.
 377      These optimizations are used always when the compiler is
 378      taught to optimize.
 379
 380    One can inhibit all optimizations by defining __NO_STRING_INLINES.  */
 381
 382 /* Get the machine-dependent optimizations (if any).  */
 383 #  include <bits/string.h>
 384
 385 /* These are generic optimizations which do not add too much inline code.  */
 386 #  include <bits/string2.h>
 387 # endif
 388 #endif
 389 #endif
 390
 391 #ifdef  __USE_BSD
 392 /* Two OpenBSD extension functions. */
 393 extern size_t strlcat(char *__restrict dst, const char *__restrict src,
 394                       size_t n) __THROW;
 395 extern size_t strlcpy(char *__restrict dst, const char *__restrict src,
 396                       size_t n) __THROW;
 397 #endif
 398
 399 __END_DECLS
 400
 401 #endif /* string.h  */