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