string/string.h

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