1 /* A GNU-like <string.h>.
3 Copyright (C) 1995-1996, 2001-2007 Free Software Foundation, Inc.
5 This program is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published by
7 the Free Software Foundation; either version 2, or (at your option)
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with this program; if not, write to the Free Software Foundation,
17 Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */
22 #include @ABSOLUTE_STRING_H@
25 /* GL_LINK_WARNING("literal string") arranges to emit the literal string as
26 a linker warning on most glibc systems.
27 We use a linker warning rather than a preprocessor warning, because
28 #warning cannot be used inside macros. */
29 #ifndef GL_LINK_WARNING
30 /* This works on platforms with GNU ld and ELF object format.
31 Testing __GLIBC__ is sufficient for asserting that GNU ld is in use.
32 Testing __ELF__ guarantees the ELF object format.
33 Testing __GNUC__ is necessary for the compound expression syntax. */
34 # if defined __GLIBC__ && defined __ELF__ && defined __GNUC__
35 # define GL_LINK_WARNING(message) \
36 GL_LINK_WARNING1 (__FILE__, __LINE__, message)
37 # define GL_LINK_WARNING1(file, line, message) \
38 GL_LINK_WARNING2 (file, line, message) /* macroexpand file and line */
39 # define GL_LINK_WARNING2(file, line, message) \
40 GL_LINK_WARNING3 (file ":" #line ": warning: " message)
41 # define GL_LINK_WARNING3(message) \
42 ({ static const char warning[sizeof (message)] \
43 __attribute__ ((__unused__, \
44 __section__ (".gnu.warning"), \
50 # define GL_LINK_WARNING(message) ((void) 0)
59 /* Return the first occurrence of NEEDLE in HAYSTACK. */
61 # if ! @HAVE_DECL_MEMMEM@
62 extern void *memmem (void const *__haystack, size_t __haystack_len,
63 void const *__needle, size_t __needle_len);
65 #elif defined GNULIB_POSIXCHECK
67 # define memmem memmem_is_unportable__use_gnulib_module_memmem_for_portability
70 /* Copy N bytes of SRC to DEST, return pointer to bytes after the
74 extern void *mempcpy (void *restrict __dest, void const *restrict __src,
77 #elif defined GNULIB_POSIXCHECK
79 # define mempcpy mempcpy_is_unportable__use_gnulib_module_mempcpy_for_portability
82 /* Search backwards through a block for a byte (specified as an int). */
84 # if ! @HAVE_DECL_MEMRCHR@
85 extern void *memrchr (void const *, int, size_t);
87 #elif defined GNULIB_POSIXCHECK
89 # define memrchr memrchr_is_unportable__use_gnulib_module_memrchr_for_portability
92 /* Copy SRC to DST, returning the address of the terminating '\0' in DST. */
95 extern char *stpcpy (char *restrict __dst, char const *restrict __src);
97 #elif defined GNULIB_POSIXCHECK
99 # define stpcpy stpcpy_is_unportable__use_gnulib_module_stpcpy_for_portability
102 /* Copy no more than N bytes of SRC to DST, returning a pointer past the
103 last non-NUL byte written into DST. */
105 # if ! @HAVE_STPNCPY@
106 # define stpncpy gnu_stpncpy
107 extern char *stpncpy (char *restrict __dst, char const *restrict __src,
110 #elif defined GNULIB_POSIXCHECK
112 # define stpncpy stpncpy_is_unportable__use_gnulib_module_stpncpy_for_portability
115 /* Compare strings S1 and S2, ignoring case, returning less than, equal to or
116 greater than zero if S1 is lexicographically less than, equal to or greater
118 Note: This function does not work in multibyte locales. */
119 #if ! @HAVE_STRCASECMP@
120 extern int strcasecmp (char const *s1, char const *s2);
122 #if defined GNULIB_POSIXCHECK
123 /* strcasecmp() does not work with multibyte strings:
124 POSIX says that it operates on "strings", and "string" in POSIX is defined
125 as a sequence of bytes, not of characters. */
127 # define strcasecmp(a,b) \
128 (GL_LINK_WARNING ("strcasecmp cannot work correctly on character strings in multibyte locales - use mbscasecmp if you care about internationalization, or use c_strcasecmp (from gnulib module c-strcase) if you want a locale independent function"), \
132 /* Compare no more than N bytes of strings S1 and S2, ignoring case,
133 returning less than, equal to or greater than zero if S1 is
134 lexicographically less than, equal to or greater than S2.
135 Note: This function cannot work correctly in multibyte locales. */
136 #if ! @HAVE_DECL_STRNCASECMP@
137 extern int strncasecmp (char const *s1, char const *s2, size_t n);
139 #if defined GNULIB_POSIXCHECK
140 /* strncasecmp() does not work with multibyte strings:
141 POSIX says that it operates on "strings", and "string" in POSIX is defined
142 as a sequence of bytes, not of characters. */
144 # define strncasecmp(a,b,n) \
145 (GL_LINK_WARNING ("strncasecmp cannot work correctly on character strings in multibyte locales - don't use it if you care about internationalization; use c_strncasecmp (from gnulib module c-strcase) if you want a locale independent function"), \
146 strncasecmp (a, b, n))
149 #if defined GNULIB_POSIXCHECK
150 /* strchr() does not work with multibyte strings if the locale encoding is
151 GB18030 and the character to be searched is a digit. */
153 # define strchr(s,c) \
154 (GL_LINK_WARNING ("strchr cannot work correctly on character strings in some multibyte locales - use mbschr if you care about internationalization"), \
158 /* Find the first occurrence of C in S or the final NUL byte. */
159 #if @GNULIB_STRCHRNUL@
160 # if ! @HAVE_STRCHRNUL@
161 extern char *strchrnul (char const *__s, int __c_in);
163 #elif defined GNULIB_POSIXCHECK
165 # define strchrnul strchrnul_is_unportable__use_gnulib_module_strchrnul_for_portability
168 /* Duplicate S, returning an identical malloc'd string. */
170 # if ! @HAVE_DECL_STRDUP@ && ! defined strdup
171 extern char *strdup (char const *__s);
173 #elif defined GNULIB_POSIXCHECK
175 # define strdup strdup_is_unportable__use_gnulib_module_strdup_for_portability
178 /* Return a newly allocated copy of at most N bytes of STRING. */
180 # if ! @HAVE_STRNDUP@
182 # define strndup rpl_strndup
183 # if ! @HAVE_DECL_STRNDUP@
184 extern char *strndup (char const *__string, size_t __n);
187 #elif defined GNULIB_POSIXCHECK
189 # define strndup strndup_is_unportable__use_gnulib_module_strndup_for_portability
192 /* Find the length (number of bytes) of STRING, but scan at most
193 MAXLEN bytes. If no '\0' terminator is found in that many bytes,
196 # if ! @HAVE_DECL_STRNLEN@
197 extern size_t strnlen (char const *__string, size_t __maxlen);
199 #elif defined GNULIB_POSIXCHECK
201 # define strnlen strnlen_is_unportable__use_gnulib_module_strnlen_for_portability
204 #if defined GNULIB_POSIXCHECK
205 /* strcspn() assumes the second argument is a list of single-byte characters.
206 Even in this simple case, it does not work with multibyte strings if the
207 locale encoding is GB18030 and one of the characters to be searched is a
210 # define strcspn(s,a) \
211 (GL_LINK_WARNING ("strcspn cannot work correctly on character strings in multibyte locales - use mbscspn if you care about internationalization"), \
215 /* Find the first occurrence in S of any character in ACCEPT. */
217 # if ! @HAVE_STRPBRK@
218 extern char *strpbrk (char const *__s, char const *__accept);
220 # if defined GNULIB_POSIXCHECK
221 /* strpbrk() assumes the second argument is a list of single-byte characters.
222 Even in this simple case, it does not work with multibyte strings if the
223 locale encoding is GB18030 and one of the characters to be searched is a
226 # define strpbrk(s,a) \
227 (GL_LINK_WARNING ("strpbrk cannot work correctly on character strings in multibyte locales - use mbspbrk if you care about internationalization"), \
230 #elif defined GNULIB_POSIXCHECK
232 # define strpbrk strpbrk_is_unportable__use_gnulib_module_strpbrk_for_portability
235 #if defined GNULIB_POSIXCHECK
236 /* strspn() assumes the second argument is a list of single-byte characters.
237 Even in this simple case, it cannot work with multibyte strings. */
239 # define strspn(s,a) \
240 (GL_LINK_WARNING ("strspn cannot work correctly on character strings in multibyte locales - use mbsspn if you care about internationalization"), \
244 #if defined GNULIB_POSIXCHECK
245 /* strrchr() does not work with multibyte strings if the locale encoding is
246 GB18030 and the character to be searched is a digit. */
248 # define strrchr(s,c) \
249 (GL_LINK_WARNING ("strrchr cannot work correctly on character strings in some multibyte locales - use mbsrchr if you care about internationalization"), \
253 /* Search the next delimiter (char listed in DELIM) starting at *STRINGP.
254 If one is found, overwrite it with a NUL, and advance *STRINGP
255 to point to the next char after it. Otherwise, set *STRINGP to NULL.
256 If *STRINGP was already NULL, nothing happens.
257 Return the old value of *STRINGP.
259 This is a variant of strtok() that is multithread-safe and supports
262 Caveat: It modifies the original string.
263 Caveat: These functions cannot be used on constant strings.
264 Caveat: The identity of the delimiting character is lost.
265 Caveat: It doesn't work with multibyte strings unless all of the delimiter
266 characters are ASCII characters < 0x30.
268 See also strtok_r(). */
271 extern char *strsep (char **restrict __stringp, char const *restrict __delim);
273 # if defined GNULIB_POSIXCHECK
275 # define strsep(s,d) \
276 (GL_LINK_WARNING ("strsep cannot work correctly on character strings in multibyte locales - use mbssep if you care about internationalization"), \
279 #elif defined GNULIB_POSIXCHECK
281 # define strsep strsep_is_unportable__use_gnulib_module_strsep_for_portability
284 #if defined GNULIB_POSIXCHECK
285 /* strstr() does not work with multibyte strings if the locale encoding is
286 different from UTF-8:
287 POSIX says that it operates on "strings", and "string" in POSIX is defined
288 as a sequence of bytes, not of characters. */
290 # define strstr(a,b) \
291 (GL_LINK_WARNING ("strstr cannot work correctly on character strings in most multibyte locales - use mbsstr if you care about internationalization"), \
295 /* Find the first occurrence of NEEDLE in HAYSTACK, using case-insensitive
297 #if ! @HAVE_STRCASESTR@
298 extern char *strcasestr (const char *haystack, const char *needle);
300 #if defined GNULIB_POSIXCHECK
301 /* strcasestr() does not work with multibyte strings:
302 It is a glibc extension, and glibc implements it only for unibyte
305 # define strcasestr(a,b) \
306 (GL_LINK_WARNING ("strcasestr does work correctly on character strings in multibyte locales - use mbscasestr if you care about internationalization, or use c-strcasestr if you want a locale independent function"), \
310 /* Parse S into tokens separated by characters in DELIM.
311 If S is NULL, the saved pointer in SAVE_PTR is used as
312 the next starting point. For example:
313 char s[] = "-abc-=-def";
315 x = strtok_r(s, "-", &sp); // x = "abc", sp = "=-def"
316 x = strtok_r(NULL, "-=", &sp); // x = "def", sp = NULL
317 x = strtok_r(NULL, "=", &sp); // x = NULL
320 This is a variant of strtok() that is multithread-safe.
322 For the POSIX documentation for this function, see:
323 http://www.opengroup.org/susv3xsh/strtok.html
325 Caveat: It modifies the original string.
326 Caveat: These functions cannot be used on constant strings.
327 Caveat: The identity of the delimiting character is lost.
328 Caveat: It doesn't work with multibyte strings unless all of the delimiter
329 characters are ASCII characters < 0x30.
331 See also strsep(). */
332 #if @GNULIB_STRTOK_R@
333 # if ! @HAVE_DECL_STRTOK_R@
334 extern char *strtok_r (char *restrict s, char const *restrict delim,
335 char **restrict save_ptr);
337 # if defined GNULIB_POSIXCHECK
339 # define strtok_r(s,d,p) \
340 (GL_LINK_WARNING ("strtok_r cannot work correctly on character strings in multibyte locales - use mbstok_r if you care about internationalization"), \
343 #elif defined GNULIB_POSIXCHECK
345 # define strtok_r strtok_r_is_unportable__use_gnulib_module_strtok_r_for_portability
349 /* The following functions are not specified by POSIX. They are gnulib
353 /* Return the number of multibyte characters in the character string STRING.
354 This considers multibyte characters, unlike strlen, which counts bytes. */
355 extern size_t mbslen (const char *string);
359 /* Locate the first single-byte character C in the character string STRING,
360 and return a pointer to it. Return NULL if C is not found in STRING.
361 Unlike strchr(), this function works correctly in multibyte locales with
362 encodings such as GB18030. */
363 # define mbschr rpl_mbschr /* avoid collision with HP-UX function */
364 extern char * mbschr (const char *string, int c);
368 /* Locate the last single-byte character C in the character string STRING,
369 and return a pointer to it. Return NULL if C is not found in STRING.
370 Unlike strrchr(), this function works correctly in multibyte locales with
371 encodings such as GB18030. */
372 # define mbsrchr rpl_mbsrchr /* avoid collision with HP-UX function */
373 extern char * mbsrchr (const char *string, int c);
377 /* Find the first occurrence of the character string NEEDLE in the character
378 string HAYSTACK. Return NULL if NEEDLE is not found in HAYSTACK.
379 Unlike strstr(), this function works correctly in multibyte locales with
380 encodings different from UTF-8. */
381 extern char * mbsstr (const char *haystack, const char *needle);
384 #if @GNULIB_MBSCASECMP@
385 /* Compare the character strings S1 and S2, ignoring case, returning less than,
386 equal to or greater than zero if S1 is lexicographically less than, equal to
388 Note: This function may, in multibyte locales, return 0 for strings of
390 Unlike strcasecmp(), this function works correctly in multibyte locales. */
391 extern int mbscasecmp (const char *s1, const char *s2);
394 #if @GNULIB_MBSCASESTR@
395 /* Find the first occurrence of the character string NEEDLE in the character
396 string HAYSTACK, using case-insensitive comparison.
397 Note: This function may, in multibyte locales, return success even if
398 strlen (haystack) < strlen (needle) !
399 Unlike strcasestr(), this function works correctly in multibyte locales. */
400 extern char * mbscasestr (const char *haystack, const char *needle);
404 /* Find the first occurrence in the character string STRING of any character
405 in the character string ACCEPT. Return the number of bytes from the
406 beginning of the string to this occurrence, or to the end of the string
408 Unlike strcspn(), this function works correctly in multibyte locales. */
409 extern size_t mbscspn (const char *string, const char *accept);
413 /* Find the first occurrence in the character string STRING of any character
414 in the character string ACCEPT. Return the pointer to it, or NULL if none
416 Unlike strpbrk(), this function works correctly in multibyte locales. */
417 # define mbspbrk rpl_mbspbrk /* avoid collision with HP-UX function */
418 extern char * mbspbrk (const char *string, const char *accept);
422 /* Find the first occurrence in the character string STRING of any character
423 not in the character string REJECT. Return the number of bytes from the
424 beginning of the string to this occurrence, or to the end of the string
426 Unlike strspn(), this function works correctly in multibyte locales. */
427 extern size_t mbsspn (const char *string, const char *reject);
431 /* Search the next delimiter (multibyte character listed in the character
432 string DELIM) starting at the character string *STRINGP.
433 If one is found, overwrite it with a NUL, and advance *STRINGP to point
434 to the next multibyte character after it. Otherwise, set *STRINGP to NULL.
435 If *STRINGP was already NULL, nothing happens.
436 Return the old value of *STRINGP.
438 This is a variant of mbstok_r() that supports empty fields.
440 Caveat: It modifies the original string.
441 Caveat: These functions cannot be used on constant strings.
442 Caveat: The identity of the delimiting character is lost.
444 See also mbstok_r(). */
445 extern char * mbssep (char **stringp, const char *delim);
448 #if @GNULIB_MBSTOK_R@
449 /* Parse the character string STRING into tokens separated by characters in
450 the character string DELIM.
451 If STRING is NULL, the saved pointer in SAVE_PTR is used as
452 the next starting point. For example:
453 char s[] = "-abc-=-def";
455 x = mbstok_r(s, "-", &sp); // x = "abc", sp = "=-def"
456 x = mbstok_r(NULL, "-=", &sp); // x = "def", sp = NULL
457 x = mbstok_r(NULL, "=", &sp); // x = NULL
460 Caveat: It modifies the original string.
461 Caveat: These functions cannot be used on constant strings.
462 Caveat: The identity of the delimiting character is lost.
464 See also mbssep(). */
465 extern char * mbstok_r (char *string, const char *delim, char **save_ptr);