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