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