]> git.ipfire.org Git - thirdparty/glibc.git/blame - string/string.h
Pretty print.
[thirdparty/glibc.git] / string / string.h
CommitLineData
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. */
2f6d1f1b
UD
37extern __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. */
41extern __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. */
377a515b 47#if defined __USE_SVID || defined __USE_BSD || defined __USE_XOPEN
28f540f4
RM
48extern __ptr_t memccpy __P ((__ptr_t __dest, __const __ptr_t __src,
49 int __c, size_t __n));
28f540f4
RM
50#endif /* SVID. */
51
52
53/* Set N bytes of S to C. */
54extern __ptr_t memset __P ((__ptr_t __s, int __c, size_t __n));
55
56/* Compare N bytes of S1 and S2. */
57extern int memcmp __P ((__const __ptr_t __s1, __const __ptr_t __s2,
58 size_t __n));
59
60/* Search N bytes of S for C. */
61extern __ptr_t memchr __P ((__const __ptr_t __s, int __c, size_t __n));
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. */
66extern __ptr_t rawmemchr __P ((__const __ptr_t __s, int __c));
ca747856
RM
67
68/* Search N bytes of S for the final occurrence of C. */
ca747856 69extern __ptr_t memrchr __P ((__const __ptr_t __s, int __c, size_t __n));
482eec0d
UD
70#endif
71
28f540f4
RM
72
73/* Copy SRC to DEST. */
2f6d1f1b
UD
74extern char *strcpy __P ((char *__restrict __dest,
75 __const char *__restrict __src));
28f540f4 76/* Copy no more than N characters of SRC to DEST. */
2f6d1f1b
UD
77extern char *strncpy __P ((char *__restrict __dest,
78 __const char *__restrict __src, size_t __n));
28f540f4
RM
79
80/* Append SRC onto DEST. */
2f6d1f1b
UD
81extern char *strcat __P ((char *__restrict __dest,
82 __const char *__restrict __src));
28f540f4 83/* Append no more than N characters from SRC onto DEST. */
2f6d1f1b
UD
84extern char *strncat __P ((char *__restrict __dest,
85 __const char *__restrict __src, size_t __n));
28f540f4
RM
86
87/* Compare S1 and S2. */
88extern int strcmp __P ((__const char *__s1, __const char *__s2));
89/* Compare N characters of S1 and S2. */
90extern int strncmp __P ((__const char *__s1, __const char *__s2, size_t __n));
91
92/* Compare the collated forms of S1 and S2. */
93extern int strcoll __P ((__const char *__s1, __const char *__s2));
94/* Put a transformation of SRC into no more than N bytes of DEST. */
2f6d1f1b
UD
95extern size_t strxfrm __P ((char *__restrict __dest,
96 __const char *__restrict __src, size_t __n));
28f540f4 97
c84142e8
UD
98#ifdef __USE_GNU
99/* The following functions are equivalent to the both above but they
100 take the locale they use for the collation as an extra argument.
101 This is not standardsized but something like will come. */
102# include <xlocale.h>
103
104/* Compare the collated forms of S1 and S2 using rules from L. */
105extern int __strcoll_l __P ((__const char *__s1, __const char *__s2,
106 __locale_t __l));
107/* Put a transformation of SRC into no more than N bytes of DEST. */
108extern size_t __strxfrm_l __P ((char *__dest, __const char *__src, size_t __n,
109 __locale_t __l));
110#endif
111
377a515b 112#if defined __USE_SVID || defined __USE_BSD || defined __USE_XOPEN_EXTENDED
28f540f4 113/* Duplicate S, returning an identical malloc'd string. */
6dbe2837 114extern char *__strdup __P ((__const char *__s));
28f540f4
RM
115extern char *strdup __P ((__const char *__s));
116#endif
117
6dbe2837
RM
118/* Return a malloc'd copy of at most N bytes of STRING. The
119 resultant string is terminated even if no null terminator
120 appears before STRING[N]. */
377a515b 121#if defined __USE_GNU
6dbe2837 122extern char *strndup __P ((__const char *__string, size_t __n));
6d52618b 123#endif
6dbe2837 124
377a515b 125#if defined __USE_GNU && defined __GNUC__
036cc82f 126/* Duplicate S, returning an identical alloca'd string. */
3996f34b 127# define strdupa(s) \
036cc82f
RM
128 (__extension__ \
129 ({ \
130 __const char *__old = (s); \
131 size_t __len = strlen (__old) + 1; \
132 char *__new = __builtin_alloca (__len); \
3996f34b 133 (char *) memcpy (__new, __old, __len); \
036cc82f
RM
134 }))
135
6dbe2837 136/* Return an alloca'd copy of at most N bytes of string. */
3996f34b 137# define strndupa(s, n) \
036cc82f
RM
138 (__extension__ \
139 ({ \
140 __const char *__old = (s); \
141 size_t __len = strnlen (__old, (n)); \
142 char *__new = __builtin_alloca (__len + 1); \
143 __new[__len] = '\0'; \
3996f34b 144 (char *) memcpy (__new, __old, __len); \
036cc82f 145 }))
02ac66c5
RM
146#endif
147
28f540f4
RM
148/* Find the first occurrence of C in S. */
149extern char *strchr __P ((__const char *__s, int __c));
150/* Find the last occurrence of C in S. */
151extern char *strrchr __P ((__const char *__s, int __c));
152
c4563d2d
UD
153#ifdef __USE_GNU
154/* This funciton is similar to `strchr'. But it returns a pointer to
155 the closing NUL byte in case C is not found in S. */
156extern char *strchrnul __P ((__const char *__s, int __c));
157#endif
158
28f540f4
RM
159/* Return the length of the initial segment of S which
160 consists entirely of characters not in REJECT. */
161extern size_t strcspn __P ((__const char *__s, __const char *__reject));
162/* Return the length of the initial segment of S which
163 consists entirely of characters in ACCEPT. */
164extern size_t strspn __P ((__const char *__s, __const char *__accept));
6d52618b 165/* Find the first occurrence in S of any character in ACCEPT. */
28f540f4 166extern char *strpbrk __P ((__const char *__s, __const char *__accept));
6d52618b 167/* Find the first occurrence of NEEDLE in HAYSTACK. */
28f540f4 168extern char *strstr __P ((__const char *__haystack, __const char *__needle));
f4017d20
UD
169
170#ifdef __USE_GNU
171/* Similar to `strstr' but this function ignores the case of both strings. */
172extern char *__strcasestr __P ((__const char *__haystack,
173 __const char *__needle));
174extern char *strcasestr __P ((__const char *__haystack,
175 __const char *__needle));
176#endif
177
28f540f4 178/* Divide S into tokens separated by characters in DELIM. */
2f6d1f1b
UD
179extern char *strtok __P ((char *__restrict __s,
180 __const char *__restrict __delim));
28f540f4 181
59dd8641
RM
182/* Divide S into tokens separated by characters in DELIM. Information
183 passed between calls are stored in SAVE_PTR. */
a6ff34d7
UD
184extern char *__strtok_r __P ((char *__restrict __s,
185 __const char *__restrict __delim,
186 char **__restrict __save_ptr));
89a9e37b 187#if defined __USE_POSIX || defined __USE_MISC
a6ff34d7
UD
188extern char *strtok_r __P ((char *__restrict __s,
189 __const char *__restrict __delim,
190 char **__restrict __save_ptr));
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. */
197extern __ptr_t memmem __P ((__const __ptr_t __haystack, size_t __haystacklen,
198 __const __ptr_t __needle, size_t __needlelen));
9a0a462c
UD
199
200/* Copy N bytes of SRC to DEST, return pointer to bytes after the
201 last written byte. */
202extern __ptr_t __mempcpy __P ((__ptr_t __restrict __dest,
203 __const __ptr_t __restrict __src, size_t __n));
204extern __ptr_t mempcpy __P ((__ptr_t __restrict __dest,
205 __const __ptr_t __restrict __src, size_t __n));
28f540f4
RM
206#endif
207
8d71c7b0 208
28f540f4
RM
209/* Return the length of S. */
210extern size_t strlen __P ((__const char *__s));
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. */
215extern size_t strnlen __P ((__const char *__string, size_t __maxlen));
8d71c7b0
RM
216#endif
217
218
60478656 219/* Return a string describing the meaning of the `errno' code in ERRNUM. */
28f540f4 220extern char *strerror __P ((int __errnum));
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. */
47707456 224extern char *__strerror_r __P ((int __errnum, char *__buf, size_t __buflen));
9f447fb3 225extern char *strerror_r __P ((int __errnum, char *__buf, size_t __buflen));
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. */
230extern void __bzero __P ((__ptr_t __s, size_t __n));
231
4b8f94d3 232#if defined __USE_BSD || defined __USE_XOPEN_EXTENDED
28f540f4
RM
233/* Copy N bytes of SRC to DEST (like memmove, but args reversed). */
234extern void bcopy __P ((__const __ptr_t __src, __ptr_t __dest, size_t __n));
235
236/* Set N bytes of S to 0. */
237extern void bzero __P ((__ptr_t __s, size_t __n));
238
239/* Compare N bytes of S1 and S2 (same as memcmp). */
240extern int bcmp __P ((__const __ptr_t __s1, __const __ptr_t __s2, size_t __n));
241
2c6fe0bd
UD
242/* Find the first occurrence of C in S (same as strchr). */
243extern char *index __P ((__const char *__s, int __c));
244
245/* Find the last occurrence of C in S (same as strrchr). */
246extern char *rindex __P ((__const char *__s, int __c));
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. */
bdd421cc
UD
250extern int __ffs __P ((int __i)) __attribute__ ((const));
251extern int ffs __P ((int __i)) __attribute__ ((const));
252
253/* The following two functions are non-standard but necessary for non-32 bit
254 platforms. */
255# ifdef __USE_GNU
256extern int ffsl __P ((long int __l)) __attribute__ ((const));
257# ifdef __GNUC__
7782d0bf
UD
258__extension__ extern int ffsll __P ((long long int __ll))
259 __attribute__ ((const));
bdd421cc
UD
260# endif
261# endif
28f540f4
RM
262
263/* Compare S1 and S2, ignoring case. */
3ec41e03 264extern int __strcasecmp __P ((__const char *__s1, __const char *__s2));
28f540f4
RM
265extern int strcasecmp __P ((__const char *__s1, __const char *__s2));
266
6e86a7c2
RM
267/* Compare no more than N chars of S1 and S2, ignoring case. */
268extern int strncasecmp __P ((__const char *__s1, __const char *__s2,
269 size_t __n));
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. */
275extern int __strcasecmp_l __P ((__const char *__s1, __const char *__s2,
276 __locale_t __loc));
277
278extern int __strncasecmp_l __P ((__const char *__s1, __const char *__s2,
279 size_t __n, __locale_t __loc));
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. */
a6ff34d7
UD
285extern char *strsep __P ((char **__restrict __stringp,
286 __const char *__restrict __delim));
28f540f4
RM
287#endif
288
28f540f4 289#ifdef __USE_GNU
1f205a47
UD
290/* Compare S1 and S2 as strings holding name & indices/version numbers. */
291extern int strverscmp __P ((__const char *__s1, __const char *__s2));
292
28f540f4
RM
293/* Return a string describing the meaning of the signal number in SIG. */
294extern char *strsignal __P ((int __sig));
295
296/* Copy SRC to DEST, returning the address of the terminating '\0' in DEST. */
a6ff34d7
UD
297extern char *__stpcpy __P ((char *__restrict __dest,
298 __const char *__restrict __src));
299extern char *stpcpy __P ((char *__restrict __dest,
300 __const char *__restrict __src));
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. */
a6ff34d7
UD
304extern char *__stpncpy __P ((char *__restrict __dest,
305 __const char *__restrict __src, size_t __n));
306extern char *stpncpy __P ((char *__restrict __dest,
307 __const char *__restrict __src, size_t __n));
28f540f4 308
28f540f4
RM
309/* Sautee STRING briskly. */
310extern char *strfry __P ((char *__string));
311
312/* Frobnicate N bytes of S. */
313extern __ptr_t memfrob __P ((__ptr_t __s, size_t __n));
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. */
036cc82f 320extern char *basename __P ((__const char *__filename));
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 */