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