string/string.h

   1 /* Copyright (C) 1991, 92, 93, 95, 96, 97 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
  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) || defined (__USE_XOPEN)
  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) || defined(__USE_XOPEN_EXTENDED)
  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 /* Return a malloc'd copy of at most N bytes of STRING.  The
  93    resultant string is terminated even if no null terminator
  94    appears before STRING[N].  */
  95 extern char *__strndup __P ((__const char *__string, size_t __n));
  96 #if defined(__USE_GNU)
  97 extern char *strndup __P ((__const char *__string, size_t __n));
  98 #endif
  99
 100 #if defined (__USE_GNU) && defined (__GNUC__)
 101 /* Duplicate S, returning an identical alloca'd string.  */
 102 #define strdupa(s)                                                            \
 103   (__extension__                                                              \
 104     ({                                                                        \
 105       __const char *__old = (s);                                              \
 106       size_t __len = strlen (__old) + 1;                                      \
 107       char *__new = __builtin_alloca (__len);                                 \
 108       memcpy (__new, __old, __len);                                           \
 109     }))
 110
 111 /* Return an alloca'd copy of at most N bytes of string.  */
 112 #define strndupa(s, n)                                                        \
 113   (__extension__                                                              \
 114     ({                                                                        \
 115       __const char *__old = (s);                                              \
 116       size_t __len = strnlen (__old, (n));                                    \
 117       char *__new = __builtin_alloca (__len + 1);                             \
 118       __new[__len] = '\0';                                                    \
 119       memcpy (__new, __old, __len);                                           \
 120     }))
 121 #endif
 122
 123 /* Find the first occurrence of C in S.  */
 124 extern char *strchr __P ((__const char *__s, int __c));
 125 /* Find the last occurrence of C in S.  */
 126 extern char *strrchr __P ((__const char *__s, int __c));
 127
 128 /* Return the length of the initial segment of S which
 129    consists entirely of characters not in REJECT.  */
 130 extern size_t strcspn __P ((__const char *__s, __const char *__reject));
 131 /* Return the length of the initial segment of S which
 132    consists entirely of characters in ACCEPT.  */
 133 extern size_t strspn __P ((__const char *__s, __const char *__accept));
 134 /* Find the first occurrence in S of any character in ACCEPT.  */
 135 extern char *strpbrk __P ((__const char *__s, __const char *__accept));
 136 /* Find the first occurrence of NEEDLE in HAYSTACK.  */
 137 extern char *strstr __P ((__const char *__haystack, __const char *__needle));
 138 /* Divide S into tokens separated by characters in DELIM.  */
 139 extern char *strtok __P ((char *__s, __const char *__delim));
 140
 141 #ifdef  __USE_GNU
 142 /* Divide S into tokens separated by characters in DELIM.  Information
 143    passed between calls are stored in SAVE_PTR.  */
 144 extern char *strtok_r __P ((char *__s, __const char *__delim,
 145                             char **__save_ptr));
 146
 147 /* Find the first occurrence of NEEDLE in HAYSTACK.
 148    NEEDLE is NEEDLELEN bytes long;
 149    HAYSTACK is HAYSTACKLEN bytes long.  */
 150 extern __ptr_t memmem __P ((__const __ptr_t __haystack, size_t __haystacklen,
 151                             __const __ptr_t __needle, size_t __needlelen));
 152 #endif
 153
 154
 155 /* Return the length of S.  */
 156 extern size_t strlen __P ((__const char *__s));
 157
 158 #ifdef  __USE_GNU
 159 /* Find the length of STRING, but scan at most MAXLEN characters.
 160    If no '\0' terminator is found in that many characters, return MAXLEN.  */
 161 extern size_t strnlen __P ((__const char *__string, size_t __maxlen));
 162
 163 #ifdef  __OPTIMIZE__
 164 extern __inline size_t
 165 strnlen (__const char *__string, size_t __maxlen)
 166 {
 167   __const char *__end = (__const char *) memchr (__string, '\0', __maxlen);
 168   return __end ? __end - __string : __maxlen;
 169 }
 170 #endif
 171 #endif
 172
 173
 174 /* Return a string describing the meaning of the `errno' code in ERRNUM.  */
 175 extern char *strerror __P ((int __errnum));
 176 #ifdef  __USE_REENTRANT
 177 /* Reentrant version of `strerror'.  If a temporary buffer is required, at
 178    most BUFLEN bytes of BUF will be used.  */
 179 extern char *__strerror_r __P ((int __errnum, char *__buf, size_t __buflen));
 180 extern char *strerror_r __P ((int __errnum, char *__buf, size_t __buflen));
 181 #endif
 182
 183 #if defined(__USE_BSD) || defined(__USE_XOPEN_EXTENDED)
 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 /* Find the first occurrence of C in S (same as strchr).  */
 194 extern char *index __P ((__const char *__s, int __c));
 195
 196 /* Find the last occurrence of C in S (same as strrchr).  */
 197 extern char *rindex __P ((__const char *__s, int __c));
 198
 199 /* Return the position of the first bit set in I, or 0 if none are set.
 200    The least-significant bit is position 1, the most-significant 32.  */
 201 extern int ffs __P ((int __i));
 202
 203 /* Compare S1 and S2, ignoring case.  */
 204 extern int __strcasecmp __P ((__const char *__s1, __const char *__s2));
 205 extern int strcasecmp __P ((__const char *__s1, __const char *__s2));
 206
 207 /* Compare no more than N chars of S1 and S2, ignoring case.  */
 208 extern int __strncasecmp __P ((__const char *__s1, __const char *__s2,
 209                                size_t __n));
 210 extern int strncasecmp __P ((__const char *__s1, __const char *__s2,
 211                              size_t __n));
 212 #endif /* Use BSD or X/Open Unix.  */
 213
 214 #ifdef  __USE_BSD
 215 /* Return the next DELIM-delimited token from *STRINGP,
 216    terminating it with a '\0', and update *STRINGP to point past it.  */
 217 extern char *__strsep __P ((char **__stringp, __const char *__delim));
 218 extern char *strsep __P ((char **__stringp, __const char *__delim));
 219 #endif
 220
 221 #ifdef  __USE_GNU
 222 /* Return a string describing the meaning of the signal number in SIG.  */
 223 extern char *strsignal __P ((int __sig));
 224
 225 /* Copy SRC to DEST, returning the address of the terminating '\0' in DEST.  */
 226 extern char *__stpcpy __P ((char *__dest, __const char *__src));
 227 extern char *stpcpy __P ((char *__dest, __const char *__src));
 228
 229 /* Copy no more than N characters of SRC to DEST, returning the address of
 230    the last character written into DEST.  */
 231 extern char *__stpncpy __P ((char *__dest, __const char *__src, size_t __n));
 232 extern char *stpncpy __P ((char *__dest, __const char *__src, size_t __n));
 233
 234 /* Sautee STRING briskly.  */
 235 extern char *strfry __P ((char *__string));
 236
 237 /* Frobnicate N bytes of S.  */
 238 extern __ptr_t memfrob __P ((__ptr_t __s, size_t __n));
 239 #endif
 240
 241 #ifdef  __USE_MISC
 242 /* Return the file name within directory of FILENAME.  */
 243 extern char *basename __P ((__const char *__filename));
 244 #endif
 245
 246 __END_DECLS
 247
 248 #endif /* string.h  */