]> git.ipfire.org Git - thirdparty/glibc.git/blame - string/string.h
Update.
[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));
67#endif
68
28f540f4
RM
69
70/* Copy SRC to DEST. */
2f6d1f1b
UD
71extern char *strcpy __P ((char *__restrict __dest,
72 __const char *__restrict __src));
28f540f4 73/* Copy no more than N characters of SRC to DEST. */
2f6d1f1b
UD
74extern char *strncpy __P ((char *__restrict __dest,
75 __const char *__restrict __src, size_t __n));
28f540f4
RM
76
77/* Append SRC onto DEST. */
2f6d1f1b
UD
78extern char *strcat __P ((char *__restrict __dest,
79 __const char *__restrict __src));
28f540f4 80/* Append no more than N characters from SRC onto DEST. */
2f6d1f1b
UD
81extern char *strncat __P ((char *__restrict __dest,
82 __const char *__restrict __src, size_t __n));
28f540f4
RM
83
84/* Compare S1 and S2. */
85extern int strcmp __P ((__const char *__s1, __const char *__s2));
86/* Compare N characters of S1 and S2. */
87extern int strncmp __P ((__const char *__s1, __const char *__s2, size_t __n));
88
89/* Compare the collated forms of S1 and S2. */
90extern int strcoll __P ((__const char *__s1, __const char *__s2));
91/* Put a transformation of SRC into no more than N bytes of DEST. */
2f6d1f1b
UD
92extern size_t strxfrm __P ((char *__restrict __dest,
93 __const char *__restrict __src, size_t __n));
28f540f4 94
c84142e8
UD
95#ifdef __USE_GNU
96/* The following functions are equivalent to the both above but they
97 take the locale they use for the collation as an extra argument.
98 This is not standardsized but something like will come. */
99# include <xlocale.h>
100
101/* Compare the collated forms of S1 and S2 using rules from L. */
102extern int __strcoll_l __P ((__const char *__s1, __const char *__s2,
103 __locale_t __l));
104/* Put a transformation of SRC into no more than N bytes of DEST. */
105extern size_t __strxfrm_l __P ((char *__dest, __const char *__src, size_t __n,
106 __locale_t __l));
107#endif
108
377a515b 109#if defined __USE_SVID || defined __USE_BSD || defined __USE_XOPEN_EXTENDED
28f540f4 110/* Duplicate S, returning an identical malloc'd string. */
6dbe2837 111extern char *__strdup __P ((__const char *__s));
28f540f4
RM
112extern char *strdup __P ((__const char *__s));
113#endif
114
6dbe2837
RM
115/* Return a malloc'd copy of at most N bytes of STRING. The
116 resultant string is terminated even if no null terminator
117 appears before STRING[N]. */
377a515b 118#if defined __USE_GNU
6dbe2837 119extern char *strndup __P ((__const char *__string, size_t __n));
6d52618b 120#endif
6dbe2837 121
377a515b 122#if defined __USE_GNU && defined __GNUC__
036cc82f 123/* Duplicate S, returning an identical alloca'd string. */
3996f34b 124# define strdupa(s) \
036cc82f
RM
125 (__extension__ \
126 ({ \
127 __const char *__old = (s); \
128 size_t __len = strlen (__old) + 1; \
129 char *__new = __builtin_alloca (__len); \
3996f34b 130 (char *) memcpy (__new, __old, __len); \
036cc82f
RM
131 }))
132
6dbe2837 133/* Return an alloca'd copy of at most N bytes of string. */
3996f34b 134# define strndupa(s, n) \
036cc82f
RM
135 (__extension__ \
136 ({ \
137 __const char *__old = (s); \
138 size_t __len = strnlen (__old, (n)); \
139 char *__new = __builtin_alloca (__len + 1); \
140 __new[__len] = '\0'; \
3996f34b 141 (char *) memcpy (__new, __old, __len); \
036cc82f 142 }))
02ac66c5
RM
143#endif
144
28f540f4
RM
145/* Find the first occurrence of C in S. */
146extern char *strchr __P ((__const char *__s, int __c));
147/* Find the last occurrence of C in S. */
148extern char *strrchr __P ((__const char *__s, int __c));
149
150/* Return the length of the initial segment of S which
151 consists entirely of characters not in REJECT. */
152extern size_t strcspn __P ((__const char *__s, __const char *__reject));
153/* Return the length of the initial segment of S which
154 consists entirely of characters in ACCEPT. */
155extern size_t strspn __P ((__const char *__s, __const char *__accept));
6d52618b 156/* Find the first occurrence in S of any character in ACCEPT. */
28f540f4 157extern char *strpbrk __P ((__const char *__s, __const char *__accept));
6d52618b 158/* Find the first occurrence of NEEDLE in HAYSTACK. */
28f540f4 159extern char *strstr __P ((__const char *__haystack, __const char *__needle));
f4017d20
UD
160
161#ifdef __USE_GNU
162/* Similar to `strstr' but this function ignores the case of both strings. */
163extern char *__strcasestr __P ((__const char *__haystack,
164 __const char *__needle));
165extern char *strcasestr __P ((__const char *__haystack,
166 __const char *__needle));
167#endif
168
28f540f4 169/* Divide S into tokens separated by characters in DELIM. */
2f6d1f1b
UD
170extern char *strtok __P ((char *__restrict __s,
171 __const char *__restrict __delim));
28f540f4 172
59dd8641
RM
173/* Divide S into tokens separated by characters in DELIM. Information
174 passed between calls are stored in SAVE_PTR. */
a6ff34d7
UD
175extern char *__strtok_r __P ((char *__restrict __s,
176 __const char *__restrict __delim,
177 char **__restrict __save_ptr));
89a9e37b 178#if defined __USE_POSIX || defined __USE_MISC
a6ff34d7
UD
179extern char *strtok_r __P ((char *__restrict __s,
180 __const char *__restrict __delim,
181 char **__restrict __save_ptr));
9d187dd4 182#endif
59dd8641 183
9d187dd4 184#ifdef __USE_GNU
6d52618b 185/* Find the first occurrence of NEEDLE in HAYSTACK.
28f540f4
RM
186 NEEDLE is NEEDLELEN bytes long;
187 HAYSTACK is HAYSTACKLEN bytes long. */
188extern __ptr_t memmem __P ((__const __ptr_t __haystack, size_t __haystacklen,
189 __const __ptr_t __needle, size_t __needlelen));
9a0a462c
UD
190
191/* Copy N bytes of SRC to DEST, return pointer to bytes after the
192 last written byte. */
193extern __ptr_t __mempcpy __P ((__ptr_t __restrict __dest,
194 __const __ptr_t __restrict __src, size_t __n));
195extern __ptr_t mempcpy __P ((__ptr_t __restrict __dest,
196 __const __ptr_t __restrict __src, size_t __n));
28f540f4
RM
197#endif
198
8d71c7b0 199
28f540f4
RM
200/* Return the length of S. */
201extern size_t strlen __P ((__const char *__s));
202
8d71c7b0
RM
203#ifdef __USE_GNU
204/* Find the length of STRING, but scan at most MAXLEN characters.
205 If no '\0' terminator is found in that many characters, return MAXLEN. */
206extern size_t strnlen __P ((__const char *__string, size_t __maxlen));
8d71c7b0
RM
207#endif
208
209
60478656 210/* Return a string describing the meaning of the `errno' code in ERRNUM. */
28f540f4 211extern char *strerror __P ((int __errnum));
19361cb7 212#ifdef __USE_MISC
60478656
RM
213/* Reentrant version of `strerror'. If a temporary buffer is required, at
214 most BUFLEN bytes of BUF will be used. */
47707456 215extern char *__strerror_r __P ((int __errnum, char *__buf, size_t __buflen));
9f447fb3 216extern char *strerror_r __P ((int __errnum, char *__buf, size_t __buflen));
60478656 217#endif
28f540f4 218
61eb22d3
UD
219/* We define this function always since `bzero' is sometimes needed when
220 the namespace rules does not allow this. */
221extern void __bzero __P ((__ptr_t __s, size_t __n));
222
4b8f94d3 223#if defined __USE_BSD || defined __USE_XOPEN_EXTENDED
28f540f4
RM
224/* Copy N bytes of SRC to DEST (like memmove, but args reversed). */
225extern void bcopy __P ((__const __ptr_t __src, __ptr_t __dest, size_t __n));
226
227/* Set N bytes of S to 0. */
228extern void bzero __P ((__ptr_t __s, size_t __n));
229
230/* Compare N bytes of S1 and S2 (same as memcmp). */
231extern int bcmp __P ((__const __ptr_t __s1, __const __ptr_t __s2, size_t __n));
232
2c6fe0bd
UD
233/* Find the first occurrence of C in S (same as strchr). */
234extern char *index __P ((__const char *__s, int __c));
235
236/* Find the last occurrence of C in S (same as strrchr). */
237extern char *rindex __P ((__const char *__s, int __c));
238
28f540f4
RM
239/* Return the position of the first bit set in I, or 0 if none are set.
240 The least-significant bit is position 1, the most-significant 32. */
bdd421cc
UD
241extern int __ffs __P ((int __i)) __attribute__ ((const));
242extern int ffs __P ((int __i)) __attribute__ ((const));
243
244/* The following two functions are non-standard but necessary for non-32 bit
245 platforms. */
246# ifdef __USE_GNU
247extern int ffsl __P ((long int __l)) __attribute__ ((const));
248# ifdef __GNUC__
7782d0bf
UD
249__extension__ extern int ffsll __P ((long long int __ll))
250 __attribute__ ((const));
bdd421cc
UD
251# endif
252# endif
28f540f4
RM
253
254/* Compare S1 and S2, ignoring case. */
3ec41e03 255extern int __strcasecmp __P ((__const char *__s1, __const char *__s2));
28f540f4
RM
256extern int strcasecmp __P ((__const char *__s1, __const char *__s2));
257
6e86a7c2
RM
258/* Compare no more than N chars of S1 and S2, ignoring case. */
259extern int strncasecmp __P ((__const char *__s1, __const char *__s2,
260 size_t __n));
2c6fe0bd 261#endif /* Use BSD or X/Open Unix. */
6e86a7c2 262
0501d603
UD
263#ifdef __USE_GNU
264/* Again versions of a few functions which use the given locale instead
265 of the global one. */
266extern int __strcasecmp_l __P ((__const char *__s1, __const char *__s2,
267 __locale_t __loc));
268
269extern int __strncasecmp_l __P ((__const char *__s1, __const char *__s2,
270 size_t __n, __locale_t __loc));
271#endif
272
2c6fe0bd 273#ifdef __USE_BSD
28f540f4
RM
274/* Return the next DELIM-delimited token from *STRINGP,
275 terminating it with a '\0', and update *STRINGP to point past it. */
a6ff34d7
UD
276extern char *strsep __P ((char **__restrict __stringp,
277 __const char *__restrict __delim));
28f540f4
RM
278#endif
279
28f540f4 280#ifdef __USE_GNU
1f205a47
UD
281/* Compare S1 and S2 as strings holding name & indices/version numbers. */
282extern int strverscmp __P ((__const char *__s1, __const char *__s2));
283
28f540f4
RM
284/* Return a string describing the meaning of the signal number in SIG. */
285extern char *strsignal __P ((int __sig));
286
287/* Copy SRC to DEST, returning the address of the terminating '\0' in DEST. */
a6ff34d7
UD
288extern char *__stpcpy __P ((char *__restrict __dest,
289 __const char *__restrict __src));
290extern char *stpcpy __P ((char *__restrict __dest,
291 __const char *__restrict __src));
28f540f4
RM
292
293/* Copy no more than N characters of SRC to DEST, returning the address of
294 the last character written into DEST. */
a6ff34d7
UD
295extern char *__stpncpy __P ((char *__restrict __dest,
296 __const char *__restrict __src, size_t __n));
297extern char *stpncpy __P ((char *__restrict __dest,
298 __const char *__restrict __src, size_t __n));
28f540f4 299
28f540f4
RM
300/* Sautee STRING briskly. */
301extern char *strfry __P ((char *__string));
302
303/* Frobnicate N bytes of S. */
304extern __ptr_t memfrob __P ((__ptr_t __s, size_t __n));
28f540f4 305
92f1da4d 306# ifndef basename
dd33e89f
UD
307/* Return the file name within directory of FILENAME. We don't
308 declare the function if the `basename' macro is available (defined
309 in <libgen.h>) which makes the XPG version of this function
310 available. */
036cc82f 311extern char *basename __P ((__const char *__filename));
92f1da4d 312# endif
84724245
RM
313#endif
314
55c14926 315
847a35a0 316#if defined __GNUC__ && __GNUC__ >= 2
cc60175e 317# if defined __OPTIMIZE__ && !defined __OPTIMIZE_SIZE__ && !defined __cplusplus
9a0a462c
UD
318/* When using GNU CC we provide some optimized versions of selected
319 functions from this header. There are two kinds of optimizations:
320
61952351
UD
321 - machine-dependent optimizations, most probably using inline
322 assembler code; these might be quite expensive since the code
323 size can increase significantly.
9a0a462c
UD
324 These optimizations are not used unless the symbol
325 __USE_STRING_INLINES
61952351 326 is defined before including this header.
9a0a462c
UD
327
328 - machine-independent optimizations which do not increase the
329 code size significantly and which optimize mainly situations
330 where one or more arguments are compile-time constants.
331 These optimizations are used always when the compiler is
61952351 332 taught to optimize.
9a0a462c 333
61eb22d3
UD
334 One can inhibit all optimizations by defining __NO_STRING_INLINES. */
335
336/* Get the machine-dependent optimizations (if any). */
847a35a0 337# include <bits/string.h>
9a0a462c
UD
338
339/* These are generic optimizations which do not add too much inline code. */
847a35a0
UD
340# include <bits/string2.h>
341# endif
92f1da4d
UD
342#endif
343
28f540f4
RM
344__END_DECLS
345
346#endif /* string.h */