string/string.h

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