1 /* A GNU-like <string.h>.
3 Copyright (C) 1995-1996, 2001-2020 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 3, 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, see <https://www.gnu.org/licenses/>. */
19 @PRAGMA_SYSTEM_HEADER@
23 #if defined _GL_ALREADY_INCLUDING_STRING_H
24 /* Special invocation convention:
25 - On OS X/NetBSD we have a sequence of nested includes
26 <string.h> -> <strings.h> -> "string.h"
27 In this situation system _chk variants due to -D_FORTIFY_SOURCE
28 might be used after any replacements defined here. */
30 #@INCLUDE_NEXT@ @NEXT_STRING_H@
33 /* Normal invocation convention. */
35 #ifndef _@GUARD_PREFIX@_STRING_H
37 #define _GL_ALREADY_INCLUDING_STRING_H
39 /* The include_next requires a split double-inclusion guard. */
40 #@INCLUDE_NEXT@ @NEXT_STRING_H@
42 #undef _GL_ALREADY_INCLUDING_STRING_H
44 #ifndef _@GUARD_PREFIX@_STRING_H
45 #define _@GUARD_PREFIX@_STRING_H
47 /* NetBSD 5.0 mis-defines NULL. */
50 /* MirBSD defines mbslen as a macro. */
51 #if @GNULIB_MBSLEN@ && defined __MirBSD__
55 /* The __attribute__ feature is available in gcc versions 2.5 and later.
56 The attribute __pure__ was added in gcc 2.96. */
57 #if __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 96)
58 # define _GL_ATTRIBUTE_PURE __attribute__ ((__pure__))
60 # define _GL_ATTRIBUTE_PURE /* empty */
63 /* NetBSD 5.0 declares strsignal in <unistd.h>, not in <string.h>. */
64 /* But in any case avoid namespace pollution on glibc systems. */
65 #if (@GNULIB_STRSIGNAL@ || defined GNULIB_POSIXCHECK) && defined __NetBSD__ \
66 && ! defined __GLIBC__
70 /* The definitions of _GL_FUNCDECL_RPL etc. are copied here. */
72 /* The definition of _GL_ARG_NONNULL is copied here. */
74 /* The definition of _GL_WARN_ON_USE is copied here. */
77 /* Clear a block of memory. The compiler will not delete a call to
78 this function, even if the block is dead after the call. */
79 #if @GNULIB_EXPLICIT_BZERO@
80 # if ! @HAVE_EXPLICIT_BZERO@
81 _GL_FUNCDECL_SYS (explicit_bzero
, void,
82 (void *__dest
, size_t __n
) _GL_ARG_NONNULL ((1)));
84 _GL_CXXALIAS_SYS (explicit_bzero
, void, (void *__dest
, size_t __n
));
85 _GL_CXXALIASWARN (explicit_bzero
);
86 #elif defined GNULIB_POSIXCHECK
87 # undef explicit_bzero
88 # if HAVE_RAW_DECL_EXPLICIT_BZERO
89 _GL_WARN_ON_USE (explicit_bzero
, "explicit_bzero is unportable - "
90 "use gnulib module explicit_bzero for portability");
94 /* Find the index of the least-significant set bit. */
97 _GL_FUNCDECL_SYS (ffsl
, int, (long int i
));
99 _GL_CXXALIAS_SYS (ffsl
, int, (long int i
));
100 _GL_CXXALIASWARN (ffsl
);
101 #elif defined GNULIB_POSIXCHECK
103 # if HAVE_RAW_DECL_FFSL
104 _GL_WARN_ON_USE (ffsl
, "ffsl is not portable - use the ffsl module");
109 /* Find the index of the least-significant set bit. */
112 _GL_FUNCDECL_SYS (ffsll
, int, (long long int i
));
114 _GL_CXXALIAS_SYS (ffsll
, int, (long long int i
));
115 _GL_CXXALIASWARN (ffsll
);
116 #elif defined GNULIB_POSIXCHECK
118 # if HAVE_RAW_DECL_FFSLL
119 _GL_WARN_ON_USE (ffsll
, "ffsll is not portable - use the ffsll module");
124 /* Return the first instance of C within N bytes of S, or NULL. */
126 # if @REPLACE_MEMCHR@
127 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
128 # define memchr rpl_memchr
130 _GL_FUNCDECL_RPL (memchr
, void *, (void const *__s
, int __c
, size_t __n
)
132 _GL_ARG_NONNULL ((1)));
133 _GL_CXXALIAS_RPL (memchr
, void *, (void const *__s
, int __c
, size_t __n
));
136 _GL_FUNCDECL_SYS (memchr
, void *, (void const *__s
, int __c
, size_t __n
)
138 _GL_ARG_NONNULL ((1)));
140 /* On some systems, this function is defined as an overloaded function:
141 extern "C" { const void * std::memchr (const void *, int, size_t); }
142 extern "C++" { void * std::memchr (void *, int, size_t); } */
143 _GL_CXXALIAS_SYS_CAST2 (memchr
,
144 void *, (void const *__s
, int __c
, size_t __n
),
145 void const *, (void const *__s
, int __c
, size_t __n
));
147 # if ((__GLIBC__ == 2 && __GLIBC_MINOR__ >= 10) && !defined __UCLIBC__) \
148 && (__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 4))
149 _GL_CXXALIASWARN1 (memchr
, void *, (void *__s
, int __c
, size_t __n
));
150 _GL_CXXALIASWARN1 (memchr
, void const *,
151 (void const *__s
, int __c
, size_t __n
));
152 # elif __GLIBC__ >= 2
153 _GL_CXXALIASWARN (memchr
);
155 #elif defined GNULIB_POSIXCHECK
157 /* Assume memchr is always declared. */
158 _GL_WARN_ON_USE (memchr
, "memchr has platform-specific bugs - "
159 "use gnulib module memchr for portability" );
162 /* Return the first occurrence of NEEDLE in HAYSTACK. */
164 # if @REPLACE_MEMMEM@
165 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
166 # define memmem rpl_memmem
168 _GL_FUNCDECL_RPL (memmem
, void *,
169 (void const *__haystack
, size_t __haystack_len
,
170 void const *__needle
, size_t __needle_len
)
172 _GL_ARG_NONNULL ((1, 3)));
173 _GL_CXXALIAS_RPL (memmem
, void *,
174 (void const *__haystack
, size_t __haystack_len
,
175 void const *__needle
, size_t __needle_len
));
177 # if ! @HAVE_DECL_MEMMEM@
178 _GL_FUNCDECL_SYS (memmem
, void *,
179 (void const *__haystack
, size_t __haystack_len
,
180 void const *__needle
, size_t __needle_len
)
182 _GL_ARG_NONNULL ((1, 3)));
184 _GL_CXXALIAS_SYS (memmem
, void *,
185 (void const *__haystack
, size_t __haystack_len
,
186 void const *__needle
, size_t __needle_len
));
188 _GL_CXXALIASWARN (memmem
);
189 #elif defined GNULIB_POSIXCHECK
191 # if HAVE_RAW_DECL_MEMMEM
192 _GL_WARN_ON_USE (memmem
, "memmem is unportable and often quadratic - "
193 "use gnulib module memmem-simple for portability, "
194 "and module memmem for speed" );
198 /* Copy N bytes of SRC to DEST, return pointer to bytes after the
199 last written byte. */
201 # if ! @HAVE_MEMPCPY@
202 _GL_FUNCDECL_SYS (mempcpy
, void *,
203 (void *restrict __dest
, void const *restrict __src
,
205 _GL_ARG_NONNULL ((1, 2)));
207 _GL_CXXALIAS_SYS (mempcpy
, void *,
208 (void *restrict __dest
, void const *restrict __src
,
210 _GL_CXXALIASWARN (mempcpy
);
211 #elif defined GNULIB_POSIXCHECK
213 # if HAVE_RAW_DECL_MEMPCPY
214 _GL_WARN_ON_USE (mempcpy
, "mempcpy is unportable - "
215 "use gnulib module mempcpy for portability");
219 /* Search backwards through a block for a byte (specified as an int). */
221 # if ! @HAVE_DECL_MEMRCHR@
222 _GL_FUNCDECL_SYS (memrchr
, void *, (void const *, int, size_t)
224 _GL_ARG_NONNULL ((1)));
226 /* On some systems, this function is defined as an overloaded function:
227 extern "C++" { const void * std::memrchr (const void *, int, size_t); }
228 extern "C++" { void * std::memrchr (void *, int, size_t); } */
229 _GL_CXXALIAS_SYS_CAST2 (memrchr
,
230 void *, (void const *, int, size_t),
231 void const *, (void const *, int, size_t));
232 # if ((__GLIBC__ == 2 && __GLIBC_MINOR__ >= 10) && !defined __UCLIBC__) \
233 && (__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 4))
234 _GL_CXXALIASWARN1 (memrchr
, void *, (void *, int, size_t));
235 _GL_CXXALIASWARN1 (memrchr
, void const *, (void const *, int, size_t));
237 _GL_CXXALIASWARN (memrchr
);
239 #elif defined GNULIB_POSIXCHECK
241 # if HAVE_RAW_DECL_MEMRCHR
242 _GL_WARN_ON_USE (memrchr
, "memrchr is unportable - "
243 "use gnulib module memrchr for portability");
247 /* Find the first occurrence of C in S. More efficient than
248 memchr(S,C,N), at the expense of undefined behavior if C does not
249 occur within N bytes. */
250 #if @GNULIB_RAWMEMCHR@
251 # if ! @HAVE_RAWMEMCHR@
252 _GL_FUNCDECL_SYS (rawmemchr
, void *, (void const *__s
, int __c_in
)
254 _GL_ARG_NONNULL ((1)));
256 /* On some systems, this function is defined as an overloaded function:
257 extern "C++" { const void * std::rawmemchr (const void *, int); }
258 extern "C++" { void * std::rawmemchr (void *, int); } */
259 _GL_CXXALIAS_SYS_CAST2 (rawmemchr
,
260 void *, (void const *__s
, int __c_in
),
261 void const *, (void const *__s
, int __c_in
));
262 # if ((__GLIBC__ == 2 && __GLIBC_MINOR__ >= 10) && !defined __UCLIBC__) \
263 && (__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 4))
264 _GL_CXXALIASWARN1 (rawmemchr
, void *, (void *__s
, int __c_in
));
265 _GL_CXXALIASWARN1 (rawmemchr
, void const *, (void const *__s
, int __c_in
));
267 _GL_CXXALIASWARN (rawmemchr
);
269 #elif defined GNULIB_POSIXCHECK
271 # if HAVE_RAW_DECL_RAWMEMCHR
272 _GL_WARN_ON_USE (rawmemchr
, "rawmemchr is unportable - "
273 "use gnulib module rawmemchr for portability");
277 /* Copy SRC to DST, returning the address of the terminating '\0' in DST. */
280 _GL_FUNCDECL_SYS (stpcpy
, char *,
281 (char *restrict __dst
, char const *restrict __src
)
282 _GL_ARG_NONNULL ((1, 2)));
284 _GL_CXXALIAS_SYS (stpcpy
, char *,
285 (char *restrict __dst
, char const *restrict __src
));
286 _GL_CXXALIASWARN (stpcpy
);
287 #elif defined GNULIB_POSIXCHECK
289 # if HAVE_RAW_DECL_STPCPY
290 _GL_WARN_ON_USE (stpcpy
, "stpcpy is unportable - "
291 "use gnulib module stpcpy for portability");
295 /* Copy no more than N bytes of SRC to DST, returning a pointer past the
296 last non-NUL byte written into DST. */
298 # if @REPLACE_STPNCPY@
299 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
301 # define stpncpy rpl_stpncpy
303 _GL_FUNCDECL_RPL (stpncpy
, char *,
304 (char *restrict __dst
, char const *restrict __src
,
306 _GL_ARG_NONNULL ((1, 2)));
307 _GL_CXXALIAS_RPL (stpncpy
, char *,
308 (char *restrict __dst
, char const *restrict __src
,
311 # if ! @HAVE_STPNCPY@
312 _GL_FUNCDECL_SYS (stpncpy
, char *,
313 (char *restrict __dst
, char const *restrict __src
,
315 _GL_ARG_NONNULL ((1, 2)));
317 _GL_CXXALIAS_SYS (stpncpy
, char *,
318 (char *restrict __dst
, char const *restrict __src
,
321 _GL_CXXALIASWARN (stpncpy
);
322 #elif defined GNULIB_POSIXCHECK
324 # if HAVE_RAW_DECL_STPNCPY
325 _GL_WARN_ON_USE (stpncpy
, "stpncpy is unportable - "
326 "use gnulib module stpncpy for portability");
330 #if defined GNULIB_POSIXCHECK
331 /* strchr() does not work with multibyte strings if the locale encoding is
332 GB18030 and the character to be searched is a digit. */
334 /* Assume strchr is always declared. */
335 _GL_WARN_ON_USE (strchr
, "strchr cannot work correctly on character strings "
336 "in some multibyte locales - "
337 "use mbschr if you care about internationalization");
340 /* Find the first occurrence of C in S or the final NUL byte. */
341 #if @GNULIB_STRCHRNUL@
342 # if @REPLACE_STRCHRNUL@
343 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
344 # define strchrnul rpl_strchrnul
346 _GL_FUNCDECL_RPL (strchrnul
, char *, (const char *__s
, int __c_in
)
348 _GL_ARG_NONNULL ((1)));
349 _GL_CXXALIAS_RPL (strchrnul
, char *,
350 (const char *str
, int ch
));
352 # if ! @HAVE_STRCHRNUL@
353 _GL_FUNCDECL_SYS (strchrnul
, char *, (char const *__s
, int __c_in
)
355 _GL_ARG_NONNULL ((1)));
357 /* On some systems, this function is defined as an overloaded function:
358 extern "C++" { const char * std::strchrnul (const char *, int); }
359 extern "C++" { char * std::strchrnul (char *, int); } */
360 _GL_CXXALIAS_SYS_CAST2 (strchrnul
,
361 char *, (char const *__s
, int __c_in
),
362 char const *, (char const *__s
, int __c_in
));
364 # if ((__GLIBC__ == 2 && __GLIBC_MINOR__ >= 10) && !defined __UCLIBC__) \
365 && (__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 4))
366 _GL_CXXALIASWARN1 (strchrnul
, char *, (char *__s
, int __c_in
));
367 _GL_CXXALIASWARN1 (strchrnul
, char const *, (char const *__s
, int __c_in
));
369 _GL_CXXALIASWARN (strchrnul
);
371 #elif defined GNULIB_POSIXCHECK
373 # if HAVE_RAW_DECL_STRCHRNUL
374 _GL_WARN_ON_USE (strchrnul
, "strchrnul is unportable - "
375 "use gnulib module strchrnul for portability");
379 /* Duplicate S, returning an identical malloc'd string. */
381 # if @REPLACE_STRDUP@
382 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
384 # define strdup rpl_strdup
386 _GL_FUNCDECL_RPL (strdup
, char *, (char const *__s
) _GL_ARG_NONNULL ((1)));
387 _GL_CXXALIAS_RPL (strdup
, char *, (char const *__s
));
389 # if defined __cplusplus && defined GNULIB_NAMESPACE && defined strdup
390 /* strdup exists as a function and as a macro. Get rid of the macro. */
393 # if !(@HAVE_DECL_STRDUP@ || defined strdup)
394 _GL_FUNCDECL_SYS (strdup
, char *, (char const *__s
) _GL_ARG_NONNULL ((1)));
396 _GL_CXXALIAS_SYS (strdup
, char *, (char const *__s
));
398 _GL_CXXALIASWARN (strdup
);
399 #elif defined GNULIB_POSIXCHECK
401 # if HAVE_RAW_DECL_STRDUP
402 _GL_WARN_ON_USE (strdup
, "strdup is unportable - "
403 "use gnulib module strdup for portability");
407 /* Append no more than N characters from SRC onto DEST. */
409 # if @REPLACE_STRNCAT@
410 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
412 # define strncat rpl_strncat
414 _GL_FUNCDECL_RPL (strncat
, char *, (char *dest
, const char *src
, size_t n
)
415 _GL_ARG_NONNULL ((1, 2)));
416 _GL_CXXALIAS_RPL (strncat
, char *, (char *dest
, const char *src
, size_t n
));
418 _GL_CXXALIAS_SYS (strncat
, char *, (char *dest
, const char *src
, size_t n
));
421 _GL_CXXALIASWARN (strncat
);
423 #elif defined GNULIB_POSIXCHECK
425 # if HAVE_RAW_DECL_STRNCAT
426 _GL_WARN_ON_USE (strncat
, "strncat is unportable - "
427 "use gnulib module strncat for portability");
431 /* Return a newly allocated copy of at most N bytes of STRING. */
433 # if @REPLACE_STRNDUP@
434 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
436 # define strndup rpl_strndup
438 _GL_FUNCDECL_RPL (strndup
, char *, (char const *__s
, size_t __n
)
439 _GL_ARG_NONNULL ((1)));
440 _GL_CXXALIAS_RPL (strndup
, char *, (char const *__s
, size_t __n
));
442 # if ! @HAVE_DECL_STRNDUP@
443 _GL_FUNCDECL_SYS (strndup
, char *, (char const *__s
, size_t __n
)
444 _GL_ARG_NONNULL ((1)));
446 _GL_CXXALIAS_SYS (strndup
, char *, (char const *__s
, size_t __n
));
448 _GL_CXXALIASWARN (strndup
);
449 #elif defined GNULIB_POSIXCHECK
451 # if HAVE_RAW_DECL_STRNDUP
452 _GL_WARN_ON_USE (strndup
, "strndup is unportable - "
453 "use gnulib module strndup for portability");
457 /* Find the length (number of bytes) of STRING, but scan at most
458 MAXLEN bytes. If no '\0' terminator is found in that many bytes,
461 # if @REPLACE_STRNLEN@
462 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
464 # define strnlen rpl_strnlen
466 _GL_FUNCDECL_RPL (strnlen
, size_t, (char const *__s
, size_t __maxlen
)
468 _GL_ARG_NONNULL ((1)));
469 _GL_CXXALIAS_RPL (strnlen
, size_t, (char const *__s
, size_t __maxlen
));
471 # if ! @HAVE_DECL_STRNLEN@
472 _GL_FUNCDECL_SYS (strnlen
, size_t, (char const *__s
, size_t __maxlen
)
474 _GL_ARG_NONNULL ((1)));
476 _GL_CXXALIAS_SYS (strnlen
, size_t, (char const *__s
, size_t __maxlen
));
478 _GL_CXXALIASWARN (strnlen
);
479 #elif defined GNULIB_POSIXCHECK
481 # if HAVE_RAW_DECL_STRNLEN
482 _GL_WARN_ON_USE (strnlen
, "strnlen is unportable - "
483 "use gnulib module strnlen for portability");
487 #if defined GNULIB_POSIXCHECK
488 /* strcspn() assumes the second argument is a list of single-byte characters.
489 Even in this simple case, it does not work with multibyte strings if the
490 locale encoding is GB18030 and one of the characters to be searched is a
493 /* Assume strcspn is always declared. */
494 _GL_WARN_ON_USE (strcspn
, "strcspn cannot work correctly on character strings "
495 "in multibyte locales - "
496 "use mbscspn if you care about internationalization");
499 /* Find the first occurrence in S of any character in ACCEPT. */
501 # if ! @HAVE_STRPBRK@
502 _GL_FUNCDECL_SYS (strpbrk
, char *, (char const *__s
, char const *__accept
)
504 _GL_ARG_NONNULL ((1, 2)));
506 /* On some systems, this function is defined as an overloaded function:
507 extern "C" { const char * strpbrk (const char *, const char *); }
508 extern "C++" { char * strpbrk (char *, const char *); } */
509 _GL_CXXALIAS_SYS_CAST2 (strpbrk
,
510 char *, (char const *__s
, char const *__accept
),
511 const char *, (char const *__s
, char const *__accept
));
512 # if ((__GLIBC__ == 2 && __GLIBC_MINOR__ >= 10) && !defined __UCLIBC__) \
513 && (__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 4))
514 _GL_CXXALIASWARN1 (strpbrk
, char *, (char *__s
, char const *__accept
));
515 _GL_CXXALIASWARN1 (strpbrk
, char const *,
516 (char const *__s
, char const *__accept
));
517 # elif __GLIBC__ >= 2
518 _GL_CXXALIASWARN (strpbrk
);
520 # if defined GNULIB_POSIXCHECK
521 /* strpbrk() assumes the second argument is a list of single-byte characters.
522 Even in this simple case, it does not work with multibyte strings if the
523 locale encoding is GB18030 and one of the characters to be searched is a
526 _GL_WARN_ON_USE (strpbrk
, "strpbrk cannot work correctly on character strings "
527 "in multibyte locales - "
528 "use mbspbrk if you care about internationalization");
530 #elif defined GNULIB_POSIXCHECK
532 # if HAVE_RAW_DECL_STRPBRK
533 _GL_WARN_ON_USE (strpbrk
, "strpbrk is unportable - "
534 "use gnulib module strpbrk for portability");
538 #if defined GNULIB_POSIXCHECK
539 /* strspn() assumes the second argument is a list of single-byte characters.
540 Even in this simple case, it cannot work with multibyte strings. */
542 /* Assume strspn is always declared. */
543 _GL_WARN_ON_USE (strspn
, "strspn cannot work correctly on character strings "
544 "in multibyte locales - "
545 "use mbsspn if you care about internationalization");
548 #if defined GNULIB_POSIXCHECK
549 /* strrchr() does not work with multibyte strings if the locale encoding is
550 GB18030 and the character to be searched is a digit. */
552 /* Assume strrchr is always declared. */
553 _GL_WARN_ON_USE (strrchr
, "strrchr cannot work correctly on character strings "
554 "in some multibyte locales - "
555 "use mbsrchr if you care about internationalization");
558 /* Search the next delimiter (char listed in DELIM) starting at *STRINGP.
559 If one is found, overwrite it with a NUL, and advance *STRINGP
560 to point to the next char after it. Otherwise, set *STRINGP to NULL.
561 If *STRINGP was already NULL, nothing happens.
562 Return the old value of *STRINGP.
564 This is a variant of strtok() that is multithread-safe and supports
567 Caveat: It modifies the original string.
568 Caveat: These functions cannot be used on constant strings.
569 Caveat: The identity of the delimiting character is lost.
570 Caveat: It doesn't work with multibyte strings unless all of the delimiter
571 characters are ASCII characters < 0x30.
573 See also strtok_r(). */
576 _GL_FUNCDECL_SYS (strsep
, char *,
577 (char **restrict __stringp
, char const *restrict __delim
)
578 _GL_ARG_NONNULL ((1, 2)));
580 _GL_CXXALIAS_SYS (strsep
, char *,
581 (char **restrict __stringp
, char const *restrict __delim
));
582 _GL_CXXALIASWARN (strsep
);
583 # if defined GNULIB_POSIXCHECK
585 _GL_WARN_ON_USE (strsep
, "strsep cannot work correctly on character strings "
586 "in multibyte locales - "
587 "use mbssep if you care about internationalization");
589 #elif defined GNULIB_POSIXCHECK
591 # if HAVE_RAW_DECL_STRSEP
592 _GL_WARN_ON_USE (strsep
, "strsep is unportable - "
593 "use gnulib module strsep for portability");
598 # if @REPLACE_STRSTR@
599 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
600 # define strstr rpl_strstr
602 _GL_FUNCDECL_RPL (strstr
, char *, (const char *haystack
, const char *needle
)
604 _GL_ARG_NONNULL ((1, 2)));
605 _GL_CXXALIAS_RPL (strstr
, char *, (const char *haystack
, const char *needle
));
607 /* On some systems, this function is defined as an overloaded function:
608 extern "C++" { const char * strstr (const char *, const char *); }
609 extern "C++" { char * strstr (char *, const char *); } */
610 _GL_CXXALIAS_SYS_CAST2 (strstr
,
611 char *, (const char *haystack
, const char *needle
),
612 const char *, (const char *haystack
, const char *needle
));
614 # if ((__GLIBC__ == 2 && __GLIBC_MINOR__ >= 10) && !defined __UCLIBC__) \
615 && (__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 4))
616 _GL_CXXALIASWARN1 (strstr
, char *, (char *haystack
, const char *needle
));
617 _GL_CXXALIASWARN1 (strstr
, const char *,
618 (const char *haystack
, const char *needle
));
619 # elif __GLIBC__ >= 2
620 _GL_CXXALIASWARN (strstr
);
622 #elif defined GNULIB_POSIXCHECK
623 /* strstr() does not work with multibyte strings if the locale encoding is
624 different from UTF-8:
625 POSIX says that it operates on "strings", and "string" in POSIX is defined
626 as a sequence of bytes, not of characters. */
628 /* Assume strstr is always declared. */
629 _GL_WARN_ON_USE (strstr
, "strstr is quadratic on many systems, and cannot "
630 "work correctly on character strings in most "
631 "multibyte locales - "
632 "use mbsstr if you care about internationalization, "
633 "or use strstr if you care about speed");
636 /* Find the first occurrence of NEEDLE in HAYSTACK, using case-insensitive
638 #if @GNULIB_STRCASESTR@
639 # if @REPLACE_STRCASESTR@
640 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
641 # define strcasestr rpl_strcasestr
643 _GL_FUNCDECL_RPL (strcasestr
, char *,
644 (const char *haystack
, const char *needle
)
646 _GL_ARG_NONNULL ((1, 2)));
647 _GL_CXXALIAS_RPL (strcasestr
, char *,
648 (const char *haystack
, const char *needle
));
650 # if ! @HAVE_STRCASESTR@
651 _GL_FUNCDECL_SYS (strcasestr
, char *,
652 (const char *haystack
, const char *needle
)
654 _GL_ARG_NONNULL ((1, 2)));
656 /* On some systems, this function is defined as an overloaded function:
657 extern "C++" { const char * strcasestr (const char *, const char *); }
658 extern "C++" { char * strcasestr (char *, const char *); } */
659 _GL_CXXALIAS_SYS_CAST2 (strcasestr
,
660 char *, (const char *haystack
, const char *needle
),
661 const char *, (const char *haystack
, const char *needle
));
663 # if ((__GLIBC__ == 2 && __GLIBC_MINOR__ >= 10) && !defined __UCLIBC__) \
664 && (__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 4))
665 _GL_CXXALIASWARN1 (strcasestr
, char *, (char *haystack
, const char *needle
));
666 _GL_CXXALIASWARN1 (strcasestr
, const char *,
667 (const char *haystack
, const char *needle
));
669 _GL_CXXALIASWARN (strcasestr
);
671 #elif defined GNULIB_POSIXCHECK
672 /* strcasestr() does not work with multibyte strings:
673 It is a glibc extension, and glibc implements it only for unibyte
676 # if HAVE_RAW_DECL_STRCASESTR
677 _GL_WARN_ON_USE (strcasestr
, "strcasestr does work correctly on character "
678 "strings in multibyte locales - "
679 "use mbscasestr if you care about "
680 "internationalization, or use c-strcasestr if you want "
681 "a locale independent function");
685 /* Parse S into tokens separated by characters in DELIM.
686 If S is NULL, the saved pointer in SAVE_PTR is used as
687 the next starting point. For example:
688 char s[] = "-abc-=-def";
690 x = strtok_r(s, "-", &sp); // x = "abc", sp = "=-def"
691 x = strtok_r(NULL, "-=", &sp); // x = "def", sp = NULL
692 x = strtok_r(NULL, "=", &sp); // x = NULL
695 This is a variant of strtok() that is multithread-safe.
697 For the POSIX documentation for this function, see:
698 https://pubs.opengroup.org/onlinepubs/9699919799/functions/strtok.html
700 Caveat: It modifies the original string.
701 Caveat: These functions cannot be used on constant strings.
702 Caveat: The identity of the delimiting character is lost.
703 Caveat: It doesn't work with multibyte strings unless all of the delimiter
704 characters are ASCII characters < 0x30.
706 See also strsep(). */
707 #if @GNULIB_STRTOK_R@
708 # if @REPLACE_STRTOK_R@
709 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
711 # define strtok_r rpl_strtok_r
713 _GL_FUNCDECL_RPL (strtok_r
, char *,
714 (char *restrict s
, char const *restrict delim
,
715 char **restrict save_ptr
)
716 _GL_ARG_NONNULL ((2, 3)));
717 _GL_CXXALIAS_RPL (strtok_r
, char *,
718 (char *restrict s
, char const *restrict delim
,
719 char **restrict save_ptr
));
721 # if @UNDEFINE_STRTOK_R@ || defined GNULIB_POSIXCHECK
724 # if ! @HAVE_DECL_STRTOK_R@
725 _GL_FUNCDECL_SYS (strtok_r
, char *,
726 (char *restrict s
, char const *restrict delim
,
727 char **restrict save_ptr
)
728 _GL_ARG_NONNULL ((2, 3)));
730 _GL_CXXALIAS_SYS (strtok_r
, char *,
731 (char *restrict s
, char const *restrict delim
,
732 char **restrict save_ptr
));
734 _GL_CXXALIASWARN (strtok_r
);
735 # if defined GNULIB_POSIXCHECK
736 _GL_WARN_ON_USE (strtok_r
, "strtok_r cannot work correctly on character "
737 "strings in multibyte locales - "
738 "use mbstok_r if you care about internationalization");
740 #elif defined GNULIB_POSIXCHECK
742 # if HAVE_RAW_DECL_STRTOK_R
743 _GL_WARN_ON_USE (strtok_r
, "strtok_r is unportable - "
744 "use gnulib module strtok_r for portability");
749 /* The following functions are not specified by POSIX. They are gnulib
753 /* Return the number of multibyte characters in the character string STRING.
754 This considers multibyte characters, unlike strlen, which counts bytes. */
755 # ifdef __MirBSD__ /* MirBSD defines mbslen as a macro. Override it. */
758 # if @HAVE_MBSLEN@ /* AIX, OSF/1, MirBSD define mbslen already in libc. */
759 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
760 # define mbslen rpl_mbslen
762 _GL_FUNCDECL_RPL (mbslen
, size_t, (const char *string
)
764 _GL_ARG_NONNULL ((1)));
765 _GL_CXXALIAS_RPL (mbslen
, size_t, (const char *string
));
767 _GL_FUNCDECL_SYS (mbslen
, size_t, (const char *string
)
769 _GL_ARG_NONNULL ((1)));
770 _GL_CXXALIAS_SYS (mbslen
, size_t, (const char *string
));
772 _GL_CXXALIASWARN (mbslen
);
776 /* Return the number of multibyte characters in the character string starting
777 at STRING and ending at STRING + LEN. */
778 _GL_EXTERN_C
size_t mbsnlen (const char *string
, size_t len
)
780 _GL_ARG_NONNULL ((1));
784 /* Locate the first single-byte character C in the character string STRING,
785 and return a pointer to it. Return NULL if C is not found in STRING.
786 Unlike strchr(), this function works correctly in multibyte locales with
787 encodings such as GB18030. */
789 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
790 # define mbschr rpl_mbschr /* avoid collision with HP-UX function */
792 _GL_FUNCDECL_RPL (mbschr
, char *, (const char *string
, int c
)
794 _GL_ARG_NONNULL ((1)));
795 _GL_CXXALIAS_RPL (mbschr
, char *, (const char *string
, int c
));
797 _GL_FUNCDECL_SYS (mbschr
, char *, (const char *string
, int c
)
799 _GL_ARG_NONNULL ((1)));
800 _GL_CXXALIAS_SYS (mbschr
, char *, (const char *string
, int c
));
802 _GL_CXXALIASWARN (mbschr
);
806 /* Locate the last single-byte character C in the character string STRING,
807 and return a pointer to it. Return NULL if C is not found in STRING.
808 Unlike strrchr(), this function works correctly in multibyte locales with
809 encodings such as GB18030. */
810 # if defined __hpux || defined __INTERIX
811 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
812 # define mbsrchr rpl_mbsrchr /* avoid collision with system function */
814 _GL_FUNCDECL_RPL (mbsrchr
, char *, (const char *string
, int c
)
816 _GL_ARG_NONNULL ((1)));
817 _GL_CXXALIAS_RPL (mbsrchr
, char *, (const char *string
, int c
));
819 _GL_FUNCDECL_SYS (mbsrchr
, char *, (const char *string
, int c
)
821 _GL_ARG_NONNULL ((1)));
822 _GL_CXXALIAS_SYS (mbsrchr
, char *, (const char *string
, int c
));
824 _GL_CXXALIASWARN (mbsrchr
);
828 /* Find the first occurrence of the character string NEEDLE in the character
829 string HAYSTACK. Return NULL if NEEDLE is not found in HAYSTACK.
830 Unlike strstr(), this function works correctly in multibyte locales with
831 encodings different from UTF-8. */
832 _GL_EXTERN_C
char * mbsstr (const char *haystack
, const char *needle
)
834 _GL_ARG_NONNULL ((1, 2));
837 #if @GNULIB_MBSCASECMP@
838 /* Compare the character strings S1 and S2, ignoring case, returning less than,
839 equal to or greater than zero if S1 is lexicographically less than, equal to
841 Note: This function may, in multibyte locales, return 0 for strings of
843 Unlike strcasecmp(), this function works correctly in multibyte locales. */
844 _GL_EXTERN_C
int mbscasecmp (const char *s1
, const char *s2
)
846 _GL_ARG_NONNULL ((1, 2));
849 #if @GNULIB_MBSNCASECMP@
850 /* Compare the initial segment of the character string S1 consisting of at most
851 N characters with the initial segment of the character string S2 consisting
852 of at most N characters, ignoring case, returning less than, equal to or
853 greater than zero if the initial segment of S1 is lexicographically less
854 than, equal to or greater than the initial segment of S2.
855 Note: This function may, in multibyte locales, return 0 for initial segments
856 of different lengths!
857 Unlike strncasecmp(), this function works correctly in multibyte locales.
858 But beware that N is not a byte count but a character count! */
859 _GL_EXTERN_C
int mbsncasecmp (const char *s1
, const char *s2
, size_t n
)
861 _GL_ARG_NONNULL ((1, 2));
864 #if @GNULIB_MBSPCASECMP@
865 /* Compare the initial segment of the character string STRING consisting of
866 at most mbslen (PREFIX) characters with the character string PREFIX,
867 ignoring case. If the two match, return a pointer to the first byte
868 after this prefix in STRING. Otherwise, return NULL.
869 Note: This function may, in multibyte locales, return non-NULL if STRING
870 is of smaller length than PREFIX!
871 Unlike strncasecmp(), this function works correctly in multibyte
873 _GL_EXTERN_C
char * mbspcasecmp (const char *string
, const char *prefix
)
875 _GL_ARG_NONNULL ((1, 2));
878 #if @GNULIB_MBSCASESTR@
879 /* Find the first occurrence of the character string NEEDLE in the character
880 string HAYSTACK, using case-insensitive comparison.
881 Note: This function may, in multibyte locales, return success even if
882 strlen (haystack) < strlen (needle) !
883 Unlike strcasestr(), this function works correctly in multibyte locales. */
884 _GL_EXTERN_C
char * mbscasestr (const char *haystack
, const char *needle
)
886 _GL_ARG_NONNULL ((1, 2));
890 /* Find the first occurrence in the character string STRING of any character
891 in the character string ACCEPT. Return the number of bytes from the
892 beginning of the string to this occurrence, or to the end of the string
894 Unlike strcspn(), this function works correctly in multibyte locales. */
895 _GL_EXTERN_C
size_t mbscspn (const char *string
, const char *accept
)
897 _GL_ARG_NONNULL ((1, 2));
901 /* Find the first occurrence in the character string STRING of any character
902 in the character string ACCEPT. Return the pointer to it, or NULL if none
904 Unlike strpbrk(), this function works correctly in multibyte locales. */
906 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
907 # define mbspbrk rpl_mbspbrk /* avoid collision with HP-UX function */
909 _GL_FUNCDECL_RPL (mbspbrk
, char *, (const char *string
, const char *accept
)
911 _GL_ARG_NONNULL ((1, 2)));
912 _GL_CXXALIAS_RPL (mbspbrk
, char *, (const char *string
, const char *accept
));
914 _GL_FUNCDECL_SYS (mbspbrk
, char *, (const char *string
, const char *accept
)
916 _GL_ARG_NONNULL ((1, 2)));
917 _GL_CXXALIAS_SYS (mbspbrk
, char *, (const char *string
, const char *accept
));
919 _GL_CXXALIASWARN (mbspbrk
);
923 /* Find the first occurrence in the character string STRING of any character
924 not in the character string REJECT. Return the number of bytes from the
925 beginning of the string to this occurrence, or to the end of the string
927 Unlike strspn(), this function works correctly in multibyte locales. */
928 _GL_EXTERN_C
size_t mbsspn (const char *string
, const char *reject
)
930 _GL_ARG_NONNULL ((1, 2));
934 /* Search the next delimiter (multibyte character listed in the character
935 string DELIM) starting at the character string *STRINGP.
936 If one is found, overwrite it with a NUL, and advance *STRINGP to point
937 to the next multibyte character after it. Otherwise, set *STRINGP to NULL.
938 If *STRINGP was already NULL, nothing happens.
939 Return the old value of *STRINGP.
941 This is a variant of mbstok_r() that supports empty fields.
943 Caveat: It modifies the original string.
944 Caveat: These functions cannot be used on constant strings.
945 Caveat: The identity of the delimiting character is lost.
947 See also mbstok_r(). */
948 _GL_EXTERN_C
char * mbssep (char **stringp
, const char *delim
)
949 _GL_ARG_NONNULL ((1, 2));
952 #if @GNULIB_MBSTOK_R@
953 /* Parse the character string STRING into tokens separated by characters in
954 the character string DELIM.
955 If STRING is NULL, the saved pointer in SAVE_PTR is used as
956 the next starting point. For example:
957 char s[] = "-abc-=-def";
959 x = mbstok_r(s, "-", &sp); // x = "abc", sp = "=-def"
960 x = mbstok_r(NULL, "-=", &sp); // x = "def", sp = NULL
961 x = mbstok_r(NULL, "=", &sp); // x = NULL
964 Caveat: It modifies the original string.
965 Caveat: These functions cannot be used on constant strings.
966 Caveat: The identity of the delimiting character is lost.
968 See also mbssep(). */
969 _GL_EXTERN_C
char * mbstok_r (char *string
, const char *delim
, char **save_ptr
)
970 _GL_ARG_NONNULL ((2, 3));
973 /* Map any int, typically from errno, into an error message. */
974 #if @GNULIB_STRERROR@
975 # if @REPLACE_STRERROR@
976 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
978 # define strerror rpl_strerror
980 _GL_FUNCDECL_RPL (strerror
, char *, (int));
981 _GL_CXXALIAS_RPL (strerror
, char *, (int));
983 _GL_CXXALIAS_SYS (strerror
, char *, (int));
986 _GL_CXXALIASWARN (strerror
);
988 #elif defined GNULIB_POSIXCHECK
990 /* Assume strerror is always declared. */
991 _GL_WARN_ON_USE (strerror
, "strerror is unportable - "
992 "use gnulib module strerror to guarantee non-NULL result");
995 /* Map any int, typically from errno, into an error message. Multithread-safe.
996 Uses the POSIX declaration, not the glibc declaration. */
997 #if @GNULIB_STRERROR_R@
998 # if @REPLACE_STRERROR_R@
999 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
1001 # define strerror_r rpl_strerror_r
1003 _GL_FUNCDECL_RPL (strerror_r
, int, (int errnum
, char *buf
, size_t buflen
)
1004 _GL_ARG_NONNULL ((2)));
1005 _GL_CXXALIAS_RPL (strerror_r
, int, (int errnum
, char *buf
, size_t buflen
));
1007 # if !@HAVE_DECL_STRERROR_R@
1008 _GL_FUNCDECL_SYS (strerror_r
, int, (int errnum
, char *buf
, size_t buflen
)
1009 _GL_ARG_NONNULL ((2)));
1011 _GL_CXXALIAS_SYS (strerror_r
, int, (int errnum
, char *buf
, size_t buflen
));
1013 # if @HAVE_DECL_STRERROR_R@
1014 _GL_CXXALIASWARN (strerror_r
);
1016 #elif defined GNULIB_POSIXCHECK
1018 # if HAVE_RAW_DECL_STRERROR_R
1019 _GL_WARN_ON_USE (strerror_r
, "strerror_r is unportable - "
1020 "use gnulib module strerror_r-posix for portability");
1024 #if @GNULIB_STRSIGNAL@
1025 # if @REPLACE_STRSIGNAL@
1026 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
1027 # define strsignal rpl_strsignal
1029 _GL_FUNCDECL_RPL (strsignal
, char *, (int __sig
));
1030 _GL_CXXALIAS_RPL (strsignal
, char *, (int __sig
));
1032 # if ! @HAVE_DECL_STRSIGNAL@
1033 _GL_FUNCDECL_SYS (strsignal
, char *, (int __sig
));
1035 /* Need to cast, because on Cygwin 1.5.x systems, the return type is
1037 _GL_CXXALIAS_SYS_CAST (strsignal
, char *, (int __sig
));
1039 _GL_CXXALIASWARN (strsignal
);
1040 #elif defined GNULIB_POSIXCHECK
1042 # if HAVE_RAW_DECL_STRSIGNAL
1043 _GL_WARN_ON_USE (strsignal
, "strsignal is unportable - "
1044 "use gnulib module strsignal for portability");
1048 #if @GNULIB_STRVERSCMP@
1049 # if !@HAVE_STRVERSCMP@
1050 _GL_FUNCDECL_SYS (strverscmp
, int, (const char *, const char *)
1052 _GL_ARG_NONNULL ((1, 2)));
1054 _GL_CXXALIAS_SYS (strverscmp
, int, (const char *, const char *));
1055 _GL_CXXALIASWARN (strverscmp
);
1056 #elif defined GNULIB_POSIXCHECK
1058 # if HAVE_RAW_DECL_STRVERSCMP
1059 _GL_WARN_ON_USE (strverscmp
, "strverscmp is unportable - "
1060 "use gnulib module strverscmp for portability");
1065 #endif /* _@GUARD_PREFIX@_STRING_H */
1066 #endif /* _@GUARD_PREFIX@_STRING_H */
This page took 0.06504 seconds and 5 git commands to generate.