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