Update.
[glibc.git] / string / string.h
blobdb9bc00e5cbff356ca0afba7bd864f883a04e2c1
1 /* Copyright (C) 1991-1993, 1995-2001, 2002 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 Lesser General Public
6 License as published by the Free Software Foundation; either
7 version 2.1 of the 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 Lesser General Public License for more details.
14 You should have received a copy of the GNU Lesser General Public
15 License along with the GNU C Library; if not, write to the Free
16 Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
17 02111-1307 USA. */
20 * ISO C99 Standard: 7.21 String handling <string.h>
23 #ifndef _STRING_H
24 #define _STRING_H 1
26 #include <features.h>
28 __BEGIN_DECLS
30 /* Get size_t and NULL from <stddef.h>. */
31 #define __need_size_t
32 #define __need_NULL
33 #include <stddef.h>
36 __BEGIN_NAMESPACE_STD
37 /* Copy N bytes of SRC to DEST. */
38 extern void *memcpy (void *__restrict __dest,
39 __const void *__restrict __src, size_t __n) __THROW;
40 /* Copy N bytes of SRC to DEST, guaranteeing
41 correct behavior for overlapping strings. */
42 extern void *memmove (void *__dest, __const void *__src, size_t __n)
43 __THROW;
44 __END_NAMESPACE_STD
46 /* Copy no more than N bytes of SRC to DEST, stopping when C is found.
47 Return the position in DEST one byte past where C was copied,
48 or NULL if C was not found in the first N bytes of SRC. */
49 #if defined __USE_SVID || defined __USE_BSD || defined __USE_XOPEN
50 extern void *memccpy (void *__restrict __dest, __const void *__restrict __src,
51 int __c, size_t __n)
52 __THROW;
53 #endif /* SVID. */
56 __BEGIN_NAMESPACE_STD
57 /* Set N bytes of S to C. */
58 extern void *memset (void *__s, int __c, size_t __n) __THROW;
60 /* Compare N bytes of S1 and S2. */
61 extern int memcmp (__const void *__s1, __const void *__s2, size_t __n)
62 __THROW __attribute_pure__;
64 /* Search N bytes of S for C. */
65 extern void *memchr (__const void *__s, int __c, size_t __n)
66 __THROW __attribute_pure__;
67 __END_NAMESPACE_STD
69 #ifdef __USE_GNU
70 /* Search in S for C. This is similar to `memchr' but there is no
71 length limit. */
72 extern void *rawmemchr (__const void *__s, int __c) __THROW __attribute_pure__;
74 /* Search N bytes of S for the final occurrence of C. */
75 extern void *memrchr (__const void *__s, int __c, size_t __n)
76 __THROW __attribute_pure__;
77 #endif
80 __BEGIN_NAMESPACE_STD
81 /* Copy SRC to DEST. */
82 extern char *strcpy (char *__restrict __dest, __const char *__restrict __src)
83 __THROW;
84 /* Copy no more than N characters of SRC to DEST. */
85 extern char *strncpy (char *__restrict __dest,
86 __const char *__restrict __src, size_t __n) __THROW;
88 /* Append SRC onto DEST. */
89 extern char *strcat (char *__restrict __dest, __const char *__restrict __src)
90 __THROW;
91 /* Append no more than N characters from SRC onto DEST. */
92 extern char *strncat (char *__restrict __dest, __const char *__restrict __src,
93 size_t __n) __THROW;
95 /* Compare S1 and S2. */
96 extern int strcmp (__const char *__s1, __const char *__s2)
97 __THROW __attribute_pure__;
98 /* Compare N characters of S1 and S2. */
99 extern int strncmp (__const char *__s1, __const char *__s2, size_t __n)
100 __THROW __attribute_pure__;
102 /* Compare the collated forms of S1 and S2. */
103 extern int strcoll (__const char *__s1, __const char *__s2)
104 __THROW __attribute_pure__;
105 /* Put a transformation of SRC into no more than N bytes of DEST. */
106 extern size_t strxfrm (char *__restrict __dest,
107 __const char *__restrict __src, size_t __n) __THROW;
108 __END_NAMESPACE_STD
110 #ifdef __USE_GNU
111 /* The following functions are equivalent to the both above but they
112 take the locale they use for the collation as an extra argument.
113 This is not standardsized but something like will come. */
114 # include <xlocale.h>
116 /* Compare the collated forms of S1 and S2 using rules from L. */
117 extern int strcoll_l (__const char *__s1, __const char *__s2, __locale_t __l)
118 __THROW __attribute_pure__;
119 /* Put a transformation of SRC into no more than N bytes of DEST. */
120 extern size_t strxfrm_l (char *__dest, __const char *__src, size_t __n,
121 __locale_t __l) __THROW;
122 #endif
124 #if defined __USE_SVID || defined __USE_BSD || defined __USE_XOPEN_EXTENDED
125 /* Duplicate S, returning an identical malloc'd string. */
126 extern char *strdup (__const char *__s) __THROW __attribute_malloc__;
127 #endif
129 /* Return a malloc'd copy of at most N bytes of STRING. The
130 resultant string is terminated even if no null terminator
131 appears before STRING[N]. */
132 #if defined __USE_GNU
133 extern char *strndup (__const char *__string, size_t __n)
134 __THROW __attribute_malloc__;
135 #endif
137 #if defined __USE_GNU && defined __GNUC__
138 /* Duplicate S, returning an identical alloca'd string. */
139 # define strdupa(s) \
140 (__extension__ \
141 ({ \
142 __const char *__old = (s); \
143 size_t __len = strlen (__old) + 1; \
144 char *__new = (char *) __builtin_alloca (__len); \
145 (char *) memcpy (__new, __old, __len); \
148 /* Return an alloca'd copy of at most N bytes of string. */
149 # define strndupa(s, n) \
150 (__extension__ \
151 ({ \
152 __const char *__old = (s); \
153 size_t __len = strnlen (__old, (n)); \
154 char *__new = (char *) __builtin_alloca (__len + 1); \
155 __new[__len] = '\0'; \
156 (char *) memcpy (__new, __old, __len); \
158 #endif
160 __BEGIN_NAMESPACE_STD
161 /* Find the first occurrence of C in S. */
162 extern char *strchr (__const char *__s, int __c) __THROW __attribute_pure__;
163 /* Find the last occurrence of C in S. */
164 extern char *strrchr (__const char *__s, int __c) __THROW __attribute_pure__;
165 __END_NAMESPACE_STD
167 #ifdef __USE_GNU
168 /* This function is similar to `strchr'. But it returns a pointer to
169 the closing NUL byte in case C is not found in S. */
170 extern char *strchrnul (__const char *__s, int __c) __THROW __attribute_pure__;
171 #endif
173 __BEGIN_NAMESPACE_STD
174 /* Return the length of the initial segment of S which
175 consists entirely of characters not in REJECT. */
176 extern size_t strcspn (__const char *__s, __const char *__reject)
177 __THROW __attribute_pure__;
178 /* Return the length of the initial segment of S which
179 consists entirely of characters in ACCEPT. */
180 extern size_t strspn (__const char *__s, __const char *__accept)
181 __THROW __attribute_pure__;
182 /* Find the first occurrence in S of any character in ACCEPT. */
183 extern char *strpbrk (__const char *__s, __const char *__accept)
184 __THROW __attribute_pure__;
185 /* Find the first occurrence of NEEDLE in HAYSTACK. */
186 extern char *strstr (__const char *__haystack, __const char *__needle)
187 __THROW __attribute_pure__;
190 /* Divide S into tokens separated by characters in DELIM. */
191 extern char *strtok (char *__restrict __s, __const char *__restrict __delim)
192 __THROW;
193 __END_NAMESPACE_STD
195 /* Divide S into tokens separated by characters in DELIM. Information
196 passed between calls are stored in SAVE_PTR. */
197 extern char *__strtok_r (char *__restrict __s,
198 __const char *__restrict __delim,
199 char **__restrict __save_ptr) __THROW;
200 #if defined __USE_POSIX || defined __USE_MISC
201 extern char *strtok_r (char *__restrict __s, __const char *__restrict __delim,
202 char **__restrict __save_ptr) __THROW;
203 #endif
205 #ifdef __USE_GNU
206 /* Similar to `strstr' but this function ignores the case of both strings. */
207 extern char *strcasestr (__const char *__haystack, __const char *__needle)
208 __THROW __attribute_pure__;
209 #endif
211 #ifdef __USE_GNU
212 /* Find the first occurrence of NEEDLE in HAYSTACK.
213 NEEDLE is NEEDLELEN bytes long;
214 HAYSTACK is HAYSTACKLEN bytes long. */
215 extern void *memmem (__const void *__haystack, size_t __haystacklen,
216 __const void *__needle, size_t __needlelen)
217 __THROW __attribute_pure__;
219 /* Copy N bytes of SRC to DEST, return pointer to bytes after the
220 last written byte. */
221 extern void *__mempcpy (void *__restrict __dest,
222 __const void *__restrict __src, size_t __n) __THROW;
223 extern void *mempcpy (void *__restrict __dest,
224 __const void *__restrict __src, size_t __n) __THROW;
225 #endif
228 __BEGIN_NAMESPACE_STD
229 /* Return the length of S. */
230 extern size_t strlen (__const char *__s) __THROW __attribute_pure__;
231 __END_NAMESPACE_STD
233 #ifdef __USE_GNU
234 /* Find the length of STRING, but scan at most MAXLEN characters.
235 If no '\0' terminator is found in that many characters, return MAXLEN. */
236 extern size_t strnlen (__const char *__string, size_t __maxlen)
237 __THROW __attribute_pure__;
238 #endif
241 __BEGIN_NAMESPACE_STD
242 /* Return a string describing the meaning of the `errno' code in ERRNUM. */
243 extern char *strerror (int __errnum) __THROW;
244 __END_NAMESPACE_STD
245 #if defined __USE_XOPEN2K || defined __USE_MISC
246 /* Reentrant version of `strerror'. If a temporary buffer is required, at
247 most BUFLEN bytes of BUF will be used. */
248 extern char *strerror_r (int __errnum, char *__buf, size_t __buflen) __THROW;
249 #endif
251 /* We define this function always since `bzero' is sometimes needed when
252 the namespace rules does not allow this. */
253 extern void __bzero (void *__s, size_t __n) __THROW;
255 #ifdef __USE_BSD
256 /* Copy N bytes of SRC to DEST (like memmove, but args reversed). */
257 extern void bcopy (__const void *__src, void *__dest, size_t __n) __THROW;
259 /* Set N bytes of S to 0. */
260 extern void bzero (void *__s, size_t __n) __THROW;
262 /* Compare N bytes of S1 and S2 (same as memcmp). */
263 extern int bcmp (__const void *__s1, __const void *__s2, size_t __n)
264 __THROW __attribute_pure__;
266 /* Find the first occurrence of C in S (same as strchr). */
267 extern char *index (__const char *__s, int __c) __THROW __attribute_pure__;
269 /* Find the last occurrence of C in S (same as strrchr). */
270 extern char *rindex (__const char *__s, int __c) __THROW __attribute_pure__;
272 /* Return the position of the first bit set in I, or 0 if none are set.
273 The least-significant bit is position 1, the most-significant 32. */
274 extern int ffs (int __i) __THROW __attribute__ ((__const__));
276 /* The following two functions are non-standard but necessary for non-32 bit
277 platforms. */
278 # ifdef __USE_GNU
279 extern int ffsl (long int __l) __THROW __attribute__ ((__const__));
280 # ifdef __GNUC__
281 __extension__ extern int ffsll (long long int __ll)
282 __THROW __attribute__ ((__const__));
283 # endif
284 # endif
286 /* Compare S1 and S2, ignoring case. */
287 extern int strcasecmp (__const char *__s1, __const char *__s2)
288 __THROW __attribute_pure__;
290 /* Compare no more than N chars of S1 and S2, ignoring case. */
291 extern int strncasecmp (__const char *__s1, __const char *__s2, size_t __n)
292 __THROW __attribute_pure__;
293 #endif /* Use BSD. */
295 #ifdef __USE_GNU
296 /* Again versions of a few functions which use the given locale instead
297 of the global one. */
298 extern int strcasecmp_l (__const char *__s1, __const char *__s2,
299 __locale_t __loc) __THROW __attribute_pure__;
301 extern int strncasecmp_l (__const char *__s1, __const char *__s2,
302 size_t __n, __locale_t __loc)
303 __THROW __attribute_pure__;
304 #endif
306 #ifdef __USE_BSD
307 /* Return the next DELIM-delimited token from *STRINGP,
308 terminating it with a '\0', and update *STRINGP to point past it. */
309 extern char *strsep (char **__restrict __stringp,
310 __const char *__restrict __delim) __THROW;
311 #endif
313 #ifdef __USE_GNU
314 /* Compare S1 and S2 as strings holding name & indices/version numbers. */
315 extern int strverscmp (__const char *__s1, __const char *__s2)
316 __THROW __attribute_pure__;
318 /* Return a string describing the meaning of the signal number in SIG. */
319 extern char *strsignal (int __sig) __THROW;
321 /* Copy SRC to DEST, returning the address of the terminating '\0' in DEST. */
322 extern char *__stpcpy (char *__restrict __dest, __const char *__restrict __src)
323 __THROW;
324 extern char *stpcpy (char *__restrict __dest, __const char *__restrict __src)
325 __THROW;
327 /* Copy no more than N characters of SRC to DEST, returning the address of
328 the last character written into DEST. */
329 extern char *__stpncpy (char *__restrict __dest,
330 __const char *__restrict __src, size_t __n) __THROW;
331 extern char *stpncpy (char *__restrict __dest,
332 __const char *__restrict __src, size_t __n) __THROW;
334 /* Sautee STRING briskly. */
335 extern char *strfry (char *__string) __THROW;
337 /* Frobnicate N bytes of S. */
338 extern void *memfrob (void *__s, size_t __n) __THROW;
340 # ifndef basename
341 /* Return the file name within directory of FILENAME. We don't
342 declare the function if the `basename' macro is available (defined
343 in <libgen.h>) which makes the XPG version of this function
344 available. */
345 extern char *basename (__const char *__filename) __THROW;
346 # endif
347 #endif
350 #if defined __GNUC__ && __GNUC__ >= 2
351 # if defined __OPTIMIZE__ && !defined __OPTIMIZE_SIZE__ \
352 && !defined __NO_INLINE__ && !defined __cplusplus
353 /* When using GNU CC we provide some optimized versions of selected
354 functions from this header. There are two kinds of optimizations:
356 - machine-dependent optimizations, most probably using inline
357 assembler code; these might be quite expensive since the code
358 size can increase significantly.
359 These optimizations are not used unless the symbol
360 __USE_STRING_INLINES
361 is defined before including this header.
363 - machine-independent optimizations which do not increase the
364 code size significantly and which optimize mainly situations
365 where one or more arguments are compile-time constants.
366 These optimizations are used always when the compiler is
367 taught to optimize.
369 One can inhibit all optimizations by defining __NO_STRING_INLINES. */
371 /* Get the machine-dependent optimizations (if any). */
372 # include <bits/string.h>
374 /* These are generic optimizations which do not add too much inline code. */
375 # include <bits/string2.h>
376 # endif
377 #endif
379 __END_DECLS
381 #endif /* string.h */