string/string.h

   1 /* Copyright (C) 1991, 92, 93, 95, 96 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
  16 not, write to the Free Software Foundation, Inc., 675 Mass Ave,
  17 Cambridge, MA 02139, USA.  */
  18
  19 /*
  20  *      ANSI Standard: 4.11 STRING HANDLING     <string.h>
  21  */
  22
  23 #ifndef _STRING_H
  24
  25 #define _STRING_H       1
  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 __ptr_t memcpy __P ((__ptr_t __dest, __const __ptr_t __src,
  38                             size_t __n));
  39 /* Copy N bytes of SRC to DEST, guaranteeing
  40    correct behavior for overlapping strings.  */
  41 extern __ptr_t memmove __P ((__ptr_t __dest, __const __ptr_t __src,
  42                              size_t __n));
  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 extern __ptr_t __memccpy __P ((__ptr_t __dest, __const __ptr_t __src,
  48                                int __c, size_t __n));
  49 #if defined (__USE_SVID) || defined (__USE_BSD)
  50 extern __ptr_t memccpy __P ((__ptr_t __dest, __const __ptr_t __src,
  51                              int __c, size_t __n));
  52 #endif /* SVID.  */
  53
  54
  55 /* Set N bytes of S to C.  */
  56 extern __ptr_t memset __P ((__ptr_t __s, int __c, size_t __n));
  57
  58 /* Compare N bytes of S1 and S2.  */
  59 extern int memcmp __P ((__const __ptr_t __s1, __const __ptr_t __s2,
  60                         size_t __n));
  61
  62 /* Search N bytes of S for C.  */
  63 extern __ptr_t memchr __P ((__const __ptr_t __s, int __c, size_t __n));
  64
  65
  66 /* Copy SRC to DEST.  */
  67 extern char *strcpy __P ((char *__dest, __const char *__src));
  68 /* Copy no more than N characters of SRC to DEST.  */
  69 extern char *strncpy __P ((char *__dest, __const char *__src, size_t __n));
  70
  71 /* Append SRC onto DEST.  */
  72 extern char *strcat __P ((char *__dest, __const char *__src));
  73 /* Append no more than N characters from SRC onto DEST.  */
  74 extern char *strncat __P ((char *__dest, __const char *__src, size_t __n));
  75
  76 /* Compare S1 and S2.  */
  77 extern int strcmp __P ((__const char *__s1, __const char *__s2));
  78 /* Compare N characters of S1 and S2.  */
  79 extern int strncmp __P ((__const char *__s1, __const char *__s2, size_t __n));
  80
  81 /* Compare the collated forms of S1 and S2.  */
  82 extern int strcoll __P ((__const char *__s1, __const char *__s2));
  83 /* Put a transformation of SRC into no more than N bytes of DEST.  */
  84 extern size_t strxfrm __P ((char *__dest, __const char *__src, size_t __n));
  85
  86 #if defined (__USE_SVID) || defined (__USE_BSD)
  87 /* Duplicate S, returning an identical malloc'd string.  */
  88 extern char *__strdup __P ((__const char *__s));
  89 extern char *strdup __P ((__const char *__s));
  90 #endif
  91
  92 #if defined (__USE_GNU) && defined (__GNUC__)
  93 /* Duplicate S, returning an identical alloca'd string.  */
  94 #define strdupa(s)                                                            \
  95 ({                                                                            \
  96   __const char *__old = (s);                                                  \
  97   size_t __len = strlen (__old) + 1;                                          \
  98   memcpy (__builtin_alloca (__len), __old, __len);                            \
  99 })
 100
 101 /* Return a malloc'd copy of at most N bytes of STRING.  The
 102    resultant string is terminated even if no null terminator
 103    appears before STRING[N].  */
 104 extern char *strndup __P ((__const char *__string, size_t __n));
 105
 106 /* Return an alloca'd copy of at most N bytes of string.  */
 107 #define strndupa(s, n)                                                        \
 108 ({                                                                            \
 109   __const char *__old = (s);                                                  \
 110   char *__new;                                                                \
 111   size_t __len = strnlen (__old);                                             \
 112   __new = memcpy (__builtin_alloca (__len + 1), __old, __len);                \
 113   __new[__len] = '\0';                                                        \
 114   __new;                                                                      \
 115 })
 116 #endif
 117
 118 /* Find the first occurrence of C in S.  */
 119 extern char *strchr __P ((__const char *__s, int __c));
 120 /* Find the last occurrence of C in S.  */
 121 extern char *strrchr __P ((__const char *__s, int __c));
 122
 123 /* Return the length of the initial segment of S which
 124    consists entirely of characters not in REJECT.  */
 125 extern size_t strcspn __P ((__const char *__s, __const char *__reject));
 126 /* Return the length of the initial segment of S which
 127    consists entirely of characters in ACCEPT.  */
 128 extern size_t strspn __P ((__const char *__s, __const char *__accept));
 129 /* Find the first occurence in S of any character in ACCEPT.  */
 130 extern char *strpbrk __P ((__const char *__s, __const char *__accept));
 131 /* Find the first occurence of NEEDLE in HAYSTACK.  */
 132 extern char *strstr __P ((__const char *__haystack, __const char *__needle));
 133 /* Divide S into tokens separated by characters in DELIM.  */
 134 extern char *strtok __P ((char *__s, __const char *__delim));
 135
 136 #ifdef  __USE_GNU
 137 /* Divide S into tokens separated by characters in DELIM.  Information
 138    passed between calls are stored in SAVE_PTR.  */
 139 extern char *strtok_r __P ((char *__s, __const char *__delim,
 140                             char **__save_ptr));
 141
 142 /* Find the first occurence of NEEDLE in HAYSTACK.
 143    NEEDLE is NEEDLELEN bytes long;
 144    HAYSTACK is HAYSTACKLEN bytes long.  */
 145 extern __ptr_t memmem __P ((__const __ptr_t __haystack, size_t __haystacklen,
 146                             __const __ptr_t __needle, size_t __needlelen));
 147 #endif
 148
 149
 150 /* Return the length of S.  */
 151 extern size_t strlen __P ((__const char *__s));
 152
 153 #ifdef  __USE_GNU
 154 /* Find the length of STRING, but scan at most MAXLEN characters.
 155    If no '\0' terminator is found in that many characters, return MAXLEN.  */
 156 extern size_t strnlen __P ((__const char *__string, size_t __maxlen));
 157
 158 #ifdef  __OPTIMIZE__
 159 extern __inline size_t
 160 strnlen (__const char *__string, size_t __maxlen)
 161 {
 162   __const char *__end = memchr (__string, '\0', __maxlen);
 163   return __end ? __end - __string : __maxlen;
 164 }
 165 #endif
 166 #endif
 167
 168
 169 /* Return a string describing the meaning of the `errno' code in ERRNUM.  */
 170 extern char *strerror __P ((int __errnum));
 171 #ifdef  __USE_REENTRANT
 172 /* Reentrant version of `strerror'.  If a temporary buffer is required, at
 173    most BUFLEN bytes of BUF will be used.  */
 174 extern char *strerror_r __P ((int __errnum, char *__buf, size_t __buflen));
 175 #endif
 176
 177 #ifdef  __USE_BSD
 178 /* Find the first occurrence of C in S (same as strchr).  */
 179 extern char *index __P ((__const char *__s, int __c));
 180
 181 /* Find the last occurrence of C in S (same as strrchr).  */
 182 extern char *rindex __P ((__const char *__s, int __c));
 183
 184 /* Copy N bytes of SRC to DEST (like memmove, but args reversed).  */
 185 extern void bcopy __P ((__const __ptr_t __src, __ptr_t __dest, size_t __n));
 186
 187 /* Set N bytes of S to 0.  */
 188 extern void bzero __P ((__ptr_t __s, size_t __n));
 189
 190 /* Compare N bytes of S1 and S2 (same as memcmp).  */
 191 extern int bcmp __P ((__const __ptr_t __s1, __const __ptr_t __s2, size_t __n));
 192
 193 /* Return the position of the first bit set in I, or 0 if none are set.
 194    The least-significant bit is position 1, the most-significant 32.  */
 195 extern int ffs __P ((int __i));
 196
 197 /* Compare S1 and S2, ignoring case.  */
 198 extern int __strcasecmp __P ((__const char *__s1, __const char *__s2));
 199 extern int strcasecmp __P ((__const char *__s1, __const char *__s2));
 200
 201 /* Compare no more than N chars of S1 and S2, ignoring case.  */
 202 extern int __strncasecmp __P ((__const char *__s1, __const char *__s2,
 203                                size_t __n));
 204 extern int strncasecmp __P ((__const char *__s1, __const char *__s2,
 205                              size_t __n));
 206
 207 /* Return the next DELIM-delimited token from *STRINGP,
 208    terminating it with a '\0', and update *STRINGP to point past it.  */
 209 extern char *strsep __P ((char **__stringp, __const char *__delim));
 210 #endif
 211
 212 #ifdef  __USE_GNU
 213 /* Return a string describing the meaning of the signal number in SIG.  */
 214 extern char *strsignal __P ((int __sig));
 215
 216 /* Copy SRC to DEST, returning the address of the terminating '\0' in DEST.  */
 217 extern char *__stpcpy __P ((char *__dest, __const char *__src));
 218 extern char *stpcpy __P ((char *__dest, __const char *__src));
 219
 220 /* Copy no more than N characters of SRC to DEST, returning the address of
 221    the last character written into DEST.  */
 222 extern char *__stpncpy __P ((char *__dest, __const char *__src, size_t __n));
 223 extern char *stpncpy __P ((char *__dest, __const char *__src, size_t __n));
 224
 225 /* Sautee STRING briskly.  */
 226 extern char *strfry __P ((char *__string));
 227
 228 /* Frobnicate N bytes of S.  */
 229 extern __ptr_t memfrob __P ((__ptr_t __s, size_t __n));
 230 #endif
 231
 232 #ifdef  __USE_MISC
 233 /* Return the file name within directory of FILENAME.  */
 234 extern char *basename __P ((__const char *filename));
 235 #endif
 236
 237 __END_DECLS
 238
 239 #endif /* string.h  */