blob: f11a7269c89ebc43a09b5e1d3e809a07e9b1e504 [file] [log] [blame]
yuezonghe824eb0c2024-06-27 02:32:26 -07001/* Copyright (C) 1991-1993, 1995-2003, 2004 Free Software Foundation, Inc.
2 This file is part of the GNU C Library.
3
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.
8
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.
13
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. */
18
19/*
20 * ISO C99 Standard: 7.21 String handling <string.h>
21 */
22
23#ifndef _STRING_H
24#define _STRING_H 1
25
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__BEGIN_NAMESPACE_STD
37/* Copy N bytes of SRC to DEST. */
38extern void *memcpy (void *__restrict __dest,
39 __const void *__restrict __src, size_t __n)
40 __THROW __nonnull ((1, 2));
41libc_hidden_proto(memcpy)
42/* Copy N bytes of SRC to DEST, guaranteeing
43 correct behavior for overlapping strings. */
44extern void *memmove (void *__dest, __const void *__src, size_t __n)
45 __THROW __nonnull ((1, 2));
46libc_hidden_proto(memmove)
47__END_NAMESPACE_STD
48
49/* Copy no more than N bytes of SRC to DEST, stopping when C is found.
50 Return the position in DEST one byte past where C was copied,
51 or NULL if C was not found in the first N bytes of SRC. */
52#if defined __USE_SVID || defined __USE_BSD || defined __USE_XOPEN
53extern void *memccpy (void *__restrict __dest, __const void *__restrict __src,
54 int __c, size_t __n)
55 __THROW __nonnull ((1, 2));
56libc_hidden_proto(memccpy)
57#endif /* SVID. */
58
59
60__BEGIN_NAMESPACE_STD
61/* Set N bytes of S to C. */
62extern void *memset (void *__s, int __c, size_t __n) __THROW __nonnull ((1));
63libc_hidden_proto(memset)
64
65/* Compare N bytes of S1 and S2. */
66extern int memcmp (__const void *__s1, __const void *__s2, size_t __n)
67 __THROW __attribute_pure__ __nonnull ((1, 2));
68libc_hidden_proto(memcmp)
69
70/* Search N bytes of S for C. */
71extern void *memchr (__const void *__s, int __c, size_t __n)
72 __THROW __attribute_pure__ __nonnull ((1));
73libc_hidden_proto(memchr)
74__END_NAMESPACE_STD
75
76#ifdef __USE_GNU
77/* Search in S for C. This is similar to `memchr' but there is no
78 length limit. */
79extern void *rawmemchr (__const void *__s, int __c)
80 __THROW __attribute_pure__ __nonnull ((1));
81libc_hidden_proto(rawmemchr)
82
83/* Search N bytes of S for the final occurrence of C. */
84extern void *memrchr (__const void *__s, int __c, size_t __n)
85 __THROW __attribute_pure__ __nonnull ((1));
86libc_hidden_proto(memrchr)
87#endif
88
89
90__BEGIN_NAMESPACE_STD
91/* Copy SRC to DEST. */
92extern char *strcpy (char *__restrict __dest, __const char *__restrict __src)
93 __THROW __nonnull ((1, 2));
94libc_hidden_proto(strcpy)
95/* Copy no more than N characters of SRC to DEST. */
96extern char *strncpy (char *__restrict __dest,
97 __const char *__restrict __src, size_t __n)
98 __THROW __nonnull ((1, 2));
99libc_hidden_proto(strncpy)
100
101/* Append SRC onto DEST. */
102extern char *strcat (char *__restrict __dest, __const char *__restrict __src)
103 __THROW __nonnull ((1, 2));
104libc_hidden_proto(strcat)
105/* Append no more than N characters from SRC onto DEST. */
106extern char *strncat (char *__restrict __dest, __const char *__restrict __src,
107 size_t __n) __THROW __nonnull ((1, 2));
108libc_hidden_proto(strncat)
109
110/* Compare S1 and S2. */
111extern int strcmp (__const char *__s1, __const char *__s2)
112 __THROW __attribute_pure__ __nonnull ((1, 2));
113libc_hidden_proto(strcmp)
114/* Compare N characters of S1 and S2. */
115extern int strncmp (__const char *__s1, __const char *__s2, size_t __n)
116 __THROW __attribute_pure__ __nonnull ((1, 2));
117libc_hidden_proto(strncmp)
118
119/* Compare the collated forms of S1 and S2. */
120extern int strcoll (__const char *__s1, __const char *__s2)
121 __THROW __attribute_pure__ __nonnull ((1, 2));
122libc_hidden_proto(strcoll)
123/* Put a transformation of SRC into no more than N bytes of DEST. */
124extern size_t strxfrm (char *__restrict __dest,
125 __const char *__restrict __src, size_t __n)
126 __THROW __nonnull ((2));
127__END_NAMESPACE_STD
128
129#if defined __USE_GNU && defined __UCLIBC_HAS_XLOCALE__
130/* The following functions are equivalent to the both above but they
131 take the locale they use for the collation as an extra argument.
132 This is not standardsized but something like will come. */
133# include <xlocale.h>
134
135/* Compare the collated forms of S1 and S2 using rules from L. */
136extern int strcoll_l (__const char *__s1, __const char *__s2, __locale_t __l)
137 __THROW __attribute_pure__ __nonnull ((1, 2, 3));
138libc_hidden_proto(strcoll_l)
139/* Put a transformation of SRC into no more than N bytes of DEST. */
140extern size_t strxfrm_l (char *__dest, __const char *__src, size_t __n,
141 __locale_t __l) __THROW __nonnull ((2, 4));
142libc_hidden_proto(strxfrm_l)
143#endif
144
145#if defined __USE_SVID || defined __USE_BSD || defined __USE_XOPEN_EXTENDED
146/* Duplicate S, returning an identical malloc'd string. */
147extern char *strdup (__const char *__s)
148 __THROW __attribute_malloc__ __nonnull ((1));
149libc_hidden_proto(strdup)
150#endif
151
152/* Return a malloc'd copy of at most N bytes of STRING. The
153 resultant string is terminated even if no null terminator
154 appears before STRING[N]. */
155#if defined __USE_GNU
156extern char *strndup (__const char *__string, size_t __n)
157 __THROW __attribute_malloc__ __nonnull ((1));
158libc_hidden_proto(strndup)
159#endif
160
161#if defined __USE_GNU && defined __GNUC__
162/* Duplicate S, returning an identical alloca'd string. */
163# define strdupa(s) \
164 (__extension__ \
165 ({ \
166 __const char *__old = (s); \
167 size_t __len = strlen (__old) + 1; \
168 char *__new = (char *) __builtin_alloca (__len); \
169 (char *) memcpy (__new, __old, __len); \
170 }))
171
172/* Return an alloca'd copy of at most N bytes of string. */
173# define strndupa(s, n) \
174 (__extension__ \
175 ({ \
176 __const char *__old = (s); \
177 size_t __len = strnlen (__old, (n)); \
178 char *__new = (char *) __builtin_alloca (__len + 1); \
179 __new[__len] = '\0'; \
180 (char *) memcpy (__new, __old, __len); \
181 }))
182#endif
183
184__BEGIN_NAMESPACE_STD
185/* Find the first occurrence of C in S. */
186extern char *strchr (__const char *__s, int __c)
187 __THROW __attribute_pure__ __nonnull ((1));
188libc_hidden_proto(strchr)
189/* Find the last occurrence of C in S. */
190extern char *strrchr (__const char *__s, int __c)
191 __THROW __attribute_pure__ __nonnull ((1));
192libc_hidden_proto(strrchr)
193__END_NAMESPACE_STD
194
195#ifdef __USE_GNU
196/* This function is similar to `strchr'. But it returns a pointer to
197 the closing NUL byte in case C is not found in S. */
198extern char *strchrnul (__const char *__s, int __c)
199 __THROW __attribute_pure__ __nonnull ((1));
200libc_hidden_proto(strchrnul)
201#endif
202
203__BEGIN_NAMESPACE_STD
204/* Return the length of the initial segment of S which
205 consists entirely of characters not in REJECT. */
206extern size_t strcspn (__const char *__s, __const char *__reject)
207 __THROW __attribute_pure__ __nonnull ((1, 2));
208libc_hidden_proto(strcspn)
209/* Return the length of the initial segment of S which
210 consists entirely of characters in ACCEPT. */
211extern size_t strspn (__const char *__s, __const char *__accept)
212 __THROW __attribute_pure__ __nonnull ((1, 2));
213libc_hidden_proto(strspn)
214/* Find the first occurrence in S of any character in ACCEPT. */
215extern char *strpbrk (__const char *__s, __const char *__accept)
216 __THROW __attribute_pure__ __nonnull ((1, 2));
217libc_hidden_proto(strpbrk)
218/* Find the first occurrence of NEEDLE in HAYSTACK. */
219extern char *strstr (__const char *__haystack, __const char *__needle)
220 __THROW __attribute_pure__ __nonnull ((1, 2));
221libc_hidden_proto(strstr)
222
223
224/* Divide S into tokens separated by characters in DELIM. */
225extern char *strtok (char *__restrict __s, __const char *__restrict __delim)
226 __THROW __nonnull ((2));
227libc_hidden_proto(strtok)
228__END_NAMESPACE_STD
229
230/* Divide S into tokens separated by characters in DELIM. Information
231 passed between calls are stored in SAVE_PTR. */
232#if 0 /* uClibc: disabled */
233extern char *__strtok_r (char *__restrict __s,
234 __const char *__restrict __delim,
235 char **__restrict __save_ptr)
236 __THROW __nonnull ((2, 3));
237#endif
238#if defined __USE_POSIX || defined __USE_MISC
239extern char *strtok_r (char *__restrict __s, __const char *__restrict __delim,
240 char **__restrict __save_ptr)
241 __THROW __nonnull ((2, 3));
242libc_hidden_proto(strtok_r)
243#endif
244
245#ifdef __USE_GNU
246/* Similar to `strstr' but this function ignores the case of both strings. */
247extern char *strcasestr (__const char *__haystack, __const char *__needle)
248 __THROW __attribute_pure__ __nonnull ((1, 2));
249libc_hidden_proto(strcasestr)
250#endif
251
252#ifdef __USE_GNU
253/* Find the first occurrence of NEEDLE in HAYSTACK.
254 NEEDLE is NEEDLELEN bytes long;
255 HAYSTACK is HAYSTACKLEN bytes long. */
256extern void *memmem (__const void *__haystack, size_t __haystacklen,
257 __const void *__needle, size_t __needlelen)
258 __THROW __attribute_pure__ __nonnull ((1, 3));
259
260/* Copy N bytes of SRC to DEST, return pointer to bytes after the
261 last written byte. */
262#if 0 /* uClibc: disabled */
263extern void *__mempcpy (void *__restrict __dest,
264 __const void *__restrict __src, size_t __n)
265 __THROW __nonnull ((1, 2));
266#endif
267extern void *mempcpy (void *__restrict __dest,
268 __const void *__restrict __src, size_t __n)
269 __THROW __nonnull ((1, 2));
270libc_hidden_proto(mempcpy)
271#endif
272
273
274__BEGIN_NAMESPACE_STD
275/* Return the length of S. */
276extern size_t strlen (__const char *__s)
277 __THROW __attribute_pure__ __nonnull ((1));
278libc_hidden_proto(strlen)
279__END_NAMESPACE_STD
280
281#ifdef __USE_GNU
282/* Find the length of STRING, but scan at most MAXLEN characters.
283 If no '\0' terminator is found in that many characters, return MAXLEN. */
284extern size_t strnlen (__const char *__string, size_t __maxlen)
285 __THROW __attribute_pure__ __nonnull ((1));
286libc_hidden_proto(strnlen)
287#endif
288
289
290__BEGIN_NAMESPACE_STD
291/* Return a string describing the meaning of the `errno' code in ERRNUM. */
292extern char *strerror (int __errnum) __THROW;
293libc_hidden_proto(strerror)
294__END_NAMESPACE_STD
295#if defined __USE_XOPEN2K || defined __USE_MISC
296/* Reentrant version of `strerror'.
297 There are 2 flavors of `strerror_r', GNU which returns the string
298 and may or may not use the supplied temporary buffer and POSIX one
299 which fills the string into the buffer.
300 To use the POSIX version, -D_XOPEN_SOURCE=600 or -D_POSIX_C_SOURCE=200112L
301 without -D_GNU_SOURCE is needed, otherwise the GNU version is
302 preferred. */
303# if defined __USE_XOPEN2K && !defined __USE_GNU
304/* Fill BUF with a string describing the meaning of the `errno' code in
305 ERRNUM. */
306extern int __xpg_strerror_r (int __errnum, char *__buf, size_t __buflen)
307 __THROW __nonnull ((2));
308libc_hidden_proto(__xpg_strerror_r)
309# ifdef __REDIRECT_NTH
310extern int __REDIRECT_NTH (strerror_r,
311 (int __errnum, char *__buf, size_t __buflen),
312 __xpg_strerror_r) __nonnull ((2));
313# else
314# define strerror_r __xpg_strerror_r
315# endif
316# else
317/* If a temporary buffer is required, at most BUFLEN bytes of BUF will be
318 used. */
319extern char *__glibc_strerror_r (int __errnum, char *__buf, size_t __buflen)
320 __THROW __nonnull ((2));
321libc_hidden_proto(__glibc_strerror_r)
322# ifdef __REDIRECT_NTH
323extern char * __REDIRECT_NTH (strerror_r,
324 (int __errnum, char *__buf, size_t __buflen),
325 __glibc_strerror_r) __nonnull ((2));
326# else
327# define strerror_r __glibc_strerror_r
328# endif
329# endif
330#endif
331
332/* We define this function always since `bzero' is sometimes needed when
333 the namespace rules does not allow this. */
334#if 0 /* uClibc: disabled */
335extern void __bzero (void *__s, size_t __n) __THROW __nonnull ((1));
336#endif
337
338#ifdef __USE_BSD
339# ifdef __UCLIBC_SUSV3_LEGACY__
340/* Copy N bytes of SRC to DEST (like memmove, but args reversed). */
341extern void bcopy (__const void *__src, void *__dest, size_t __n)
342 __THROW __nonnull ((1, 2));
343
344/* Set N bytes of S to 0. */
345extern void bzero (void *__s, size_t __n) __THROW __nonnull ((1));
346
347/* Compare N bytes of S1 and S2 (same as memcmp). */
348extern int bcmp (__const void *__s1, __const void *__s2, size_t __n)
349 __THROW __attribute_pure__ __nonnull ((1, 2));
350
351/* Find the first occurrence of C in S (same as strchr). */
352extern char *index (__const char *__s, int __c)
353 __THROW __attribute_pure__ __nonnull ((1));
354
355/* Find the last occurrence of C in S (same as strrchr). */
356extern char *rindex (__const char *__s, int __c)
357 __THROW __attribute_pure__ __nonnull ((1));
358# else
359# ifdef __UCLIBC_SUSV3_LEGACY_MACROS__
360/* bcopy/bzero/bcmp/index/rindex are marked LEGACY in SuSv3.
361 * They are replaced as proposed by SuSv3. Don't sync this part
362 * with glibc and keep it in sync with strings.h. */
363
364# define bcopy(src,dest,n) (memmove((dest), (src), (n)), (void) 0)
365# define bzero(s,n) (memset((s), '\0', (n)), (void) 0)
366# define bcmp(s1,s2,n) memcmp((s1), (s2), (size_t)(n))
367# define index(s,c) strchr((s), (c))
368# define rindex(s,c) strrchr((s), (c))
369# endif
370# endif
371
372/* Return the position of the first bit set in I, or 0 if none are set.
373 The least-significant bit is position 1, the most-significant 32. */
374extern int ffs (int __i) __THROW __attribute__ ((__const__));
375libc_hidden_proto(ffs)
376
377/* The following two functions are non-standard but necessary for non-32 bit
378 platforms. */
379#ifdef __USE_GNU
380extern int ffsl (long int __l) __THROW __attribute__ ((__const__));
381# ifdef __GNUC__
382__extension__ extern int ffsll (long long int __ll)
383 __THROW __attribute__ ((__const__));
384# endif
385# endif
386
387/* Compare S1 and S2, ignoring case. */
388extern int strcasecmp (__const char *__s1, __const char *__s2)
389 __THROW __attribute_pure__ __nonnull ((1, 2));
390libc_hidden_proto(strcasecmp)
391
392/* Compare no more than N chars of S1 and S2, ignoring case. */
393extern int strncasecmp (__const char *__s1, __const char *__s2, size_t __n)
394 __THROW __attribute_pure__ __nonnull ((1, 2));
395libc_hidden_proto(strncasecmp)
396#endif /* Use BSD. */
397
398#if defined __USE_GNU && defined __UCLIBC_HAS_XLOCALE__
399/* Again versions of a few functions which use the given locale instead
400 of the global one. */
401extern int strcasecmp_l (__const char *__s1, __const char *__s2,
402 __locale_t __loc)
403 __THROW __attribute_pure__ __nonnull ((1, 2, 3));
404libc_hidden_proto(strcasecmp_l)
405
406extern int strncasecmp_l (__const char *__s1, __const char *__s2,
407 size_t __n, __locale_t __loc)
408 __THROW __attribute_pure__ __nonnull ((1, 2, 4));
409libc_hidden_proto(strncasecmp_l)
410#endif
411
412#ifdef __USE_BSD
413/* Return the next DELIM-delimited token from *STRINGP,
414 terminating it with a '\0', and update *STRINGP to point past it. */
415extern char *strsep (char **__restrict __stringp,
416 __const char *__restrict __delim)
417 __THROW __nonnull ((1, 2));
418libc_hidden_proto(strsep)
419#endif
420
421#ifdef __USE_GNU
422/* Compare S1 and S2 as strings holding name & indices/version numbers. */
423extern int strverscmp (__const char *__s1, __const char *__s2)
424 __THROW __attribute_pure__ __nonnull ((1, 2));
425libc_hidden_proto(strverscmp)
426
427/* Return a string describing the meaning of the signal number in SIG. */
428extern char *strsignal (int __sig) __THROW;
429libc_hidden_proto(strsignal)
430
431/* Copy SRC to DEST, returning the address of the terminating '\0' in DEST. */
432# if 0 /* uClibc: disabled */
433extern char *__stpcpy (char *__restrict __dest, __const char *__restrict __src)
434 __THROW __nonnull ((1, 2));
435# endif
436extern char *stpcpy (char *__restrict __dest, __const char *__restrict __src)
437 __THROW __nonnull ((1, 2));
438libc_hidden_proto(stpcpy)
439
440/* Copy no more than N characters of SRC to DEST, returning the address of
441 the last character written into DEST. */
442# if 0 /* uClibc: disabled */
443extern char *__stpncpy (char *__restrict __dest,
444 __const char *__restrict __src, size_t __n)
445 __THROW __nonnull ((1, 2));
446# endif
447extern char *stpncpy (char *__restrict __dest,
448 __const char *__restrict __src, size_t __n)
449 __THROW __nonnull ((1, 2));
450
451# if 0 /* uClibc does not support strfry or memfrob. */
452/* Sautee STRING briskly. */
453extern char *strfry (char *__string) __THROW __nonnull ((1));
454
455/* Frobnicate N bytes of S. */
456extern void *memfrob (void *__s, size_t __n) __THROW __nonnull ((1));
457# endif
458
459# ifndef basename
460/* Return the file name within directory of FILENAME. We don't
461 declare the function if the `basename' macro is available (defined
462 in <libgen.h>) which makes the XPG version of this function
463 available. */
464extern char *basename (__const char *__filename) __THROW __nonnull ((1));
465libc_hidden_proto(basename)
466# endif
467#endif /* __USE_GNU */
468
469
470#ifdef __USE_BSD
471/* Two OpenBSD extension functions. */
472extern size_t strlcat(char *__restrict dst, const char *__restrict src,
473 size_t n) __THROW __nonnull ((1, 2));
474libc_hidden_proto(strlcat)
475extern size_t strlcpy(char *__restrict dst, const char *__restrict src,
476 size_t n) __THROW __nonnull ((1, 2));
477libc_hidden_proto(strlcpy)
478#endif
479
480__END_DECLS
481
482
483#if defined(_LIBC) && defined(__UCLIBC_HAS_STRING_ARCH_OPT__)
484# if defined __i386__
485# include <../libc/string/i386/string.h>
486# endif
487#endif
488
489#endif /* string.h */