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