]>
Commit | Line | Data |
---|---|---|
df4ef2ab | 1 | /* Copyright (C) 1991, 92, 93, 95, 96, 97 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. */ | |
2f6d1f1b UD |
37 | extern __ptr_t memcpy __P ((__ptr_t __restrict __dest, |
38 | __const __ptr_t __restrict __src, size_t __n)); | |
28f540f4 RM |
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)); | |
377a515b | 49 | #if defined __USE_SVID || defined __USE_BSD || defined __USE_XOPEN |
28f540f4 RM |
50 | extern __ptr_t memccpy __P ((__ptr_t __dest, __const __ptr_t __src, |
51 | int __c, size_t __n)); | |
28f540f4 RM |
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. */ | |
2f6d1f1b UD |
67 | extern char *strcpy __P ((char *__restrict __dest, |
68 | __const char *__restrict __src)); | |
28f540f4 | 69 | /* Copy no more than N characters of SRC to DEST. */ |
2f6d1f1b UD |
70 | extern char *strncpy __P ((char *__restrict __dest, |
71 | __const char *__restrict __src, size_t __n)); | |
28f540f4 RM |
72 | |
73 | /* Append SRC onto DEST. */ | |
2f6d1f1b UD |
74 | extern char *strcat __P ((char *__restrict __dest, |
75 | __const char *__restrict __src)); | |
28f540f4 | 76 | /* Append no more than N characters from SRC onto DEST. */ |
2f6d1f1b UD |
77 | extern char *strncat __P ((char *__restrict __dest, |
78 | __const char *__restrict __src, size_t __n)); | |
28f540f4 RM |
79 | |
80 | /* Compare S1 and S2. */ | |
81 | extern int strcmp __P ((__const char *__s1, __const char *__s2)); | |
82 | /* Compare N characters of S1 and S2. */ | |
83 | extern int strncmp __P ((__const char *__s1, __const char *__s2, size_t __n)); | |
84 | ||
85 | /* Compare the collated forms of S1 and S2. */ | |
86 | extern int strcoll __P ((__const char *__s1, __const char *__s2)); | |
87 | /* Put a transformation of SRC into no more than N bytes of DEST. */ | |
2f6d1f1b UD |
88 | extern size_t strxfrm __P ((char *__restrict __dest, |
89 | __const char *__restrict __src, size_t __n)); | |
28f540f4 | 90 | |
c84142e8 UD |
91 | #ifdef __USE_GNU |
92 | /* The following functions are equivalent to the both above but they | |
93 | take the locale they use for the collation as an extra argument. | |
94 | This is not standardsized but something like will come. */ | |
95 | # include <xlocale.h> | |
96 | ||
97 | /* Compare the collated forms of S1 and S2 using rules from L. */ | |
98 | extern int __strcoll_l __P ((__const char *__s1, __const char *__s2, | |
99 | __locale_t __l)); | |
100 | /* Put a transformation of SRC into no more than N bytes of DEST. */ | |
101 | extern size_t __strxfrm_l __P ((char *__dest, __const char *__src, size_t __n, | |
102 | __locale_t __l)); | |
103 | #endif | |
104 | ||
377a515b | 105 | #if defined __USE_SVID || defined __USE_BSD || defined __USE_XOPEN_EXTENDED |
28f540f4 | 106 | /* Duplicate S, returning an identical malloc'd string. */ |
6dbe2837 | 107 | extern char *__strdup __P ((__const char *__s)); |
28f540f4 RM |
108 | extern char *strdup __P ((__const char *__s)); |
109 | #endif | |
110 | ||
6dbe2837 RM |
111 | /* Return a malloc'd copy of at most N bytes of STRING. The |
112 | resultant string is terminated even if no null terminator | |
113 | appears before STRING[N]. */ | |
ce7a5ef4 | 114 | extern char *__strndup __P ((__const char *__string, size_t __n)); |
377a515b | 115 | #if defined __USE_GNU |
6dbe2837 | 116 | extern char *strndup __P ((__const char *__string, size_t __n)); |
6d52618b | 117 | #endif |
6dbe2837 | 118 | |
377a515b | 119 | #if defined __USE_GNU && defined __GNUC__ |
036cc82f | 120 | /* Duplicate S, returning an identical alloca'd string. */ |
3996f34b | 121 | # define strdupa(s) \ |
036cc82f RM |
122 | (__extension__ \ |
123 | ({ \ | |
124 | __const char *__old = (s); \ | |
125 | size_t __len = strlen (__old) + 1; \ | |
126 | char *__new = __builtin_alloca (__len); \ | |
3996f34b | 127 | (char *) memcpy (__new, __old, __len); \ |
036cc82f RM |
128 | })) |
129 | ||
6dbe2837 | 130 | /* Return an alloca'd copy of at most N bytes of string. */ |
3996f34b | 131 | # define strndupa(s, n) \ |
036cc82f RM |
132 | (__extension__ \ |
133 | ({ \ | |
134 | __const char *__old = (s); \ | |
135 | size_t __len = strnlen (__old, (n)); \ | |
136 | char *__new = __builtin_alloca (__len + 1); \ | |
137 | __new[__len] = '\0'; \ | |
3996f34b | 138 | (char *) memcpy (__new, __old, __len); \ |
036cc82f | 139 | })) |
02ac66c5 RM |
140 | #endif |
141 | ||
28f540f4 RM |
142 | /* Find the first occurrence of C in S. */ |
143 | extern char *strchr __P ((__const char *__s, int __c)); | |
144 | /* Find the last occurrence of C in S. */ | |
145 | extern char *strrchr __P ((__const char *__s, int __c)); | |
146 | ||
147 | /* Return the length of the initial segment of S which | |
148 | consists entirely of characters not in REJECT. */ | |
149 | extern size_t strcspn __P ((__const char *__s, __const char *__reject)); | |
150 | /* Return the length of the initial segment of S which | |
151 | consists entirely of characters in ACCEPT. */ | |
152 | extern size_t strspn __P ((__const char *__s, __const char *__accept)); | |
6d52618b | 153 | /* Find the first occurrence in S of any character in ACCEPT. */ |
28f540f4 | 154 | extern char *strpbrk __P ((__const char *__s, __const char *__accept)); |
6d52618b | 155 | /* Find the first occurrence of NEEDLE in HAYSTACK. */ |
28f540f4 RM |
156 | extern char *strstr __P ((__const char *__haystack, __const char *__needle)); |
157 | /* Divide S into tokens separated by characters in DELIM. */ | |
2f6d1f1b UD |
158 | extern char *strtok __P ((char *__restrict __s, |
159 | __const char *__restrict __delim)); | |
28f540f4 | 160 | |
19361cb7 | 161 | #if defined __USE_POSIX || defined __USE_MISC |
59dd8641 RM |
162 | /* Divide S into tokens separated by characters in DELIM. Information |
163 | passed between calls are stored in SAVE_PTR. */ | |
164 | extern char *strtok_r __P ((char *__s, __const char *__delim, | |
165 | char **__save_ptr)); | |
9d187dd4 | 166 | #endif |
59dd8641 | 167 | |
9d187dd4 | 168 | #ifdef __USE_GNU |
6d52618b | 169 | /* Find the first occurrence of NEEDLE in HAYSTACK. |
28f540f4 RM |
170 | NEEDLE is NEEDLELEN bytes long; |
171 | HAYSTACK is HAYSTACKLEN bytes long. */ | |
172 | extern __ptr_t memmem __P ((__const __ptr_t __haystack, size_t __haystacklen, | |
173 | __const __ptr_t __needle, size_t __needlelen)); | |
174 | #endif | |
175 | ||
8d71c7b0 | 176 | |
28f540f4 RM |
177 | /* Return the length of S. */ |
178 | extern size_t strlen __P ((__const char *__s)); | |
179 | ||
8d71c7b0 RM |
180 | #ifdef __USE_GNU |
181 | /* Find the length of STRING, but scan at most MAXLEN characters. | |
182 | If no '\0' terminator is found in that many characters, return MAXLEN. */ | |
183 | extern size_t strnlen __P ((__const char *__string, size_t __maxlen)); | |
8d71c7b0 RM |
184 | #endif |
185 | ||
186 | ||
60478656 | 187 | /* Return a string describing the meaning of the `errno' code in ERRNUM. */ |
28f540f4 | 188 | extern char *strerror __P ((int __errnum)); |
19361cb7 | 189 | #ifdef __USE_MISC |
60478656 RM |
190 | /* Reentrant version of `strerror'. If a temporary buffer is required, at |
191 | most BUFLEN bytes of BUF will be used. */ | |
47707456 | 192 | extern char *__strerror_r __P ((int __errnum, char *__buf, size_t __buflen)); |
9f447fb3 | 193 | extern char *strerror_r __P ((int __errnum, char *__buf, size_t __buflen)); |
60478656 | 194 | #endif |
28f540f4 | 195 | |
377a515b | 196 | #if defined __USE_BSD || defined __USE_XOPEN_EXTENDED |
28f540f4 RM |
197 | /* Copy N bytes of SRC to DEST (like memmove, but args reversed). */ |
198 | extern void bcopy __P ((__const __ptr_t __src, __ptr_t __dest, size_t __n)); | |
199 | ||
200 | /* Set N bytes of S to 0. */ | |
3996f34b | 201 | extern void __bzero __P ((__ptr_t __s, size_t __n)); |
28f540f4 RM |
202 | extern void bzero __P ((__ptr_t __s, size_t __n)); |
203 | ||
204 | /* Compare N bytes of S1 and S2 (same as memcmp). */ | |
205 | extern int bcmp __P ((__const __ptr_t __s1, __const __ptr_t __s2, size_t __n)); | |
206 | ||
2c6fe0bd UD |
207 | /* Find the first occurrence of C in S (same as strchr). */ |
208 | extern char *index __P ((__const char *__s, int __c)); | |
209 | ||
210 | /* Find the last occurrence of C in S (same as strrchr). */ | |
211 | extern char *rindex __P ((__const char *__s, int __c)); | |
212 | ||
28f540f4 RM |
213 | /* Return the position of the first bit set in I, or 0 if none are set. |
214 | The least-significant bit is position 1, the most-significant 32. */ | |
215 | extern int ffs __P ((int __i)); | |
216 | ||
217 | /* Compare S1 and S2, ignoring case. */ | |
3ec41e03 | 218 | extern int __strcasecmp __P ((__const char *__s1, __const char *__s2)); |
28f540f4 RM |
219 | extern int strcasecmp __P ((__const char *__s1, __const char *__s2)); |
220 | ||
6e86a7c2 | 221 | /* Compare no more than N chars of S1 and S2, ignoring case. */ |
bba7bb78 RM |
222 | extern int __strncasecmp __P ((__const char *__s1, __const char *__s2, |
223 | size_t __n)); | |
6e86a7c2 RM |
224 | extern int strncasecmp __P ((__const char *__s1, __const char *__s2, |
225 | size_t __n)); | |
2c6fe0bd | 226 | #endif /* Use BSD or X/Open Unix. */ |
6e86a7c2 | 227 | |
0501d603 UD |
228 | #ifdef __USE_GNU |
229 | /* Again versions of a few functions which use the given locale instead | |
230 | of the global one. */ | |
231 | extern int __strcasecmp_l __P ((__const char *__s1, __const char *__s2, | |
232 | __locale_t __loc)); | |
233 | ||
234 | extern int __strncasecmp_l __P ((__const char *__s1, __const char *__s2, | |
235 | size_t __n, __locale_t __loc)); | |
236 | #endif | |
237 | ||
2c6fe0bd | 238 | #ifdef __USE_BSD |
28f540f4 RM |
239 | /* Return the next DELIM-delimited token from *STRINGP, |
240 | terminating it with a '\0', and update *STRINGP to point past it. */ | |
d68171ed | 241 | extern char *__strsep __P ((char **__stringp, __const char *__delim)); |
28f540f4 RM |
242 | extern char *strsep __P ((char **__stringp, __const char *__delim)); |
243 | #endif | |
244 | ||
28f540f4 | 245 | #ifdef __USE_GNU |
1f205a47 UD |
246 | /* Compare S1 and S2 as strings holding name & indices/version numbers. */ |
247 | extern int strverscmp __P ((__const char *__s1, __const char *__s2)); | |
248 | ||
28f540f4 RM |
249 | /* Return a string describing the meaning of the signal number in SIG. */ |
250 | extern char *strsignal __P ((int __sig)); | |
251 | ||
252 | /* Copy SRC to DEST, returning the address of the terminating '\0' in DEST. */ | |
3ec41e03 | 253 | extern char *__stpcpy __P ((char *__dest, __const char *__src)); |
28f540f4 RM |
254 | extern char *stpcpy __P ((char *__dest, __const char *__src)); |
255 | ||
256 | /* Copy no more than N characters of SRC to DEST, returning the address of | |
257 | the last character written into DEST. */ | |
3ec41e03 | 258 | extern char *__stpncpy __P ((char *__dest, __const char *__src, size_t __n)); |
28f540f4 RM |
259 | extern char *stpncpy __P ((char *__dest, __const char *__src, size_t __n)); |
260 | ||
28f540f4 RM |
261 | /* Sautee STRING briskly. */ |
262 | extern char *strfry __P ((char *__string)); | |
263 | ||
264 | /* Frobnicate N bytes of S. */ | |
265 | extern __ptr_t memfrob __P ((__ptr_t __s, size_t __n)); | |
28f540f4 | 266 | |
92f1da4d | 267 | # ifndef basename |
dd33e89f UD |
268 | /* Return the file name within directory of FILENAME. We don't |
269 | declare the function if the `basename' macro is available (defined | |
270 | in <libgen.h>) which makes the XPG version of this function | |
271 | available. */ | |
036cc82f | 272 | extern char *basename __P ((__const char *__filename)); |
92f1da4d | 273 | # endif |
84724245 RM |
274 | #endif |
275 | ||
55c14926 UD |
276 | |
277 | /* Some functions might be implemented as optimized inline assembler | |
92f1da4d UD |
278 | functions. Only include this file if we really want them. */ |
279 | #if defined __USE_STRING_INLINES && defined __OPTIMIZE__ | |
55c14926 UD |
280 | # include <bits/string.h> |
281 | #endif | |
282 | ||
92f1da4d UD |
283 | |
284 | /* Now provide some generic optimizations. */ | |
285 | #if defined __GNUC__ && __GNUC__ >= 2 && defined __OPTIMIZE__ | |
286 | extern __inline size_t | |
287 | strnlen (__const char *__string, size_t __maxlen) | |
288 | { | |
289 | __const char *__end = (__const char *) memchr (__string, '\0', __maxlen); | |
290 | return __end ? __end - __string : __maxlen; | |
291 | } | |
292 | #endif | |
293 | ||
28f540f4 RM |
294 | __END_DECLS |
295 | ||
296 | #endif /* string.h */ |