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