Wed Jun 26 01:58:49 1996 Roland McGrath <roland@delasyd.gnu.ai.mit.edu>
[kopensolaris-gnu/glibc.git] / string / string.h
1 /* Copyright (C) 1991, 92, 93, 95, 96 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
16 not, write to the Free Software Foundation, Inc., 675 Mass Ave,
17 Cambridge, MA 02139, USA.  */
18
19 /*
20  *      ANSI Standard: 4.11 STRING HANDLING     <string.h>
21  */
22
23 #ifndef _STRING_H
24
25 #define _STRING_H       1
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 __dest, __const __ptr_t __src,
38                             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 extern __ptr_t __memccpy __P ((__ptr_t __dest, __const __ptr_t __src,
48                                int __c, size_t __n));
49 #if defined (__USE_SVID) || defined (__USE_BSD)
50 extern __ptr_t memccpy __P ((__ptr_t __dest, __const __ptr_t __src,
51                              int __c, size_t __n));
52 #ifdef  __OPTIMIZE__
53 #define memccpy(dest, src, c, n) __memccpy((dest), (src), (c), (n))
54 #endif /* Optimizing.  */
55 #endif /* SVID.  */
56
57
58 /* Set N bytes of S to C.  */
59 extern __ptr_t memset __P ((__ptr_t __s, int __c, size_t __n));
60
61 /* Compare N bytes of S1 and S2.  */
62 extern int memcmp __P ((__const __ptr_t __s1, __const __ptr_t __s2,
63                         size_t __n));
64
65 /* Search N bytes of S for C.  */
66 extern __ptr_t memchr __P ((__const __ptr_t __s, int __c, size_t __n));
67
68
69 /* Copy SRC to DEST.  */
70 extern char *strcpy __P ((char *__dest, __const char *__src));
71 /* Copy no more than N characters of SRC to DEST.  */
72 extern char *strncpy __P ((char *__dest, __const char *__src, size_t __n));
73
74 /* Append SRC onto DEST.  */
75 extern char *strcat __P ((char *__dest, __const char *__src));
76 /* Append no more than N characters from SRC onto DEST.  */
77 extern char *strncat __P ((char *__dest, __const char *__src, size_t __n));
78
79 /* Compare S1 and S2.  */
80 extern int strcmp __P ((__const char *__s1, __const char *__s2));
81 /* Compare N characters of S1 and S2.  */
82 extern int strncmp __P ((__const char *__s1, __const char *__s2, size_t __n));
83
84 /* Compare the collated forms of S1 and S2.  */
85 extern int strcoll __P ((__const char *__s1, __const char *__s2));
86 /* Put a transformation of SRC into no more than N bytes of DEST.  */
87 extern size_t strxfrm __P ((char *__dest, __const char *__src, size_t __n));
88
89 #if defined (__USE_SVID) || defined (__USE_BSD)
90 /* Duplicate S, returning an identical malloc'd string.  */
91 extern char *strdup __P ((__const char *__s));
92 #endif
93
94 #if defined (__USE_GNU) && defined (__GNUC__)
95 /* Duplicate S, returning an identical alloca'd string.  */
96 #define strdupa(s)                                                            \
97 ({                                                                            \
98     const char *__old = (s);                                                  \
99     size_t __len = strlen (__old) + 1;                                        \
100     memcpy (__builtin_alloca (__len), __old, __len);                          \
101 })
102 #endif
103
104 /* Find the first occurrence of C in S.  */
105 extern char *strchr __P ((__const char *__s, int __c));
106 /* Find the last occurrence of C in S.  */
107 extern char *strrchr __P ((__const char *__s, int __c));
108
109 /* Return the length of the initial segment of S which
110    consists entirely of characters not in REJECT.  */
111 extern size_t strcspn __P ((__const char *__s, __const char *__reject));
112 /* Return the length of the initial segment of S which
113    consists entirely of characters in ACCEPT.  */
114 extern size_t strspn __P ((__const char *__s, __const char *__accept));
115 /* Find the first occurence in S of any character in ACCEPT.  */
116 extern char *strpbrk __P ((__const char *__s, __const char *__accept));
117 /* Find the first occurence of NEEDLE in HAYSTACK.  */
118 extern char *strstr __P ((__const char *__haystack, __const char *__needle));
119 /* Divide S into tokens separated by characters in DELIM.  */
120 extern char *strtok __P ((char *__s, __const char *__delim));
121
122 #ifdef  __USE_GNU
123 /* Divide S into tokens separated by characters in DELIM.  Information
124    passed between calls are stored in SAVE_PTR.  */
125 extern char *strtok_r __P ((char *__s, __const char *__delim,
126                             char **__save_ptr));
127
128 /* Find the first occurence of NEEDLE in HAYSTACK.
129    NEEDLE is NEEDLELEN bytes long;
130    HAYSTACK is HAYSTACKLEN bytes long.  */
131 extern __ptr_t memmem __P ((__const __ptr_t __haystack, size_t __haystacklen,
132                             __const __ptr_t __needle, size_t __needlelen));
133 #endif
134
135
136 /* Return the length of S.  */
137 extern size_t strlen __P ((__const char *__s));
138
139 #ifdef  __USE_GNU
140 /* Find the length of STRING, but scan at most MAXLEN characters.
141    If no '\0' terminator is found in that many characters, return MAXLEN.  */
142 extern size_t strnlen __P ((__const char *__string, size_t __maxlen));
143
144 #ifdef  __OPTIMIZE__
145 extern __inline size_t
146 strnlen (__const char *__string, size_t __maxlen)
147 {
148   __const char *__end = memchr (__string, '\0', __maxlen);
149   return __end ? __end - __string : __maxlen;
150 }
151 #endif
152 #endif
153
154
155 /* Return a string describing the meaning of the `errno' code in ERRNUM.  */
156 extern char *strerror __P ((int __errnum));
157 #ifdef  __USE_REENTRANT
158 /* Reentrant version of `strerror'.  If a temporary buffer is required, at
159    most BUFLEN bytes of BUF will be used.  */
160 extern char *strerror_r __P ((int __errnum, char *__buf, size_t __buflen));
161 #endif
162
163 #ifdef  __USE_BSD
164 /* Find the first occurrence of C in S (same as strchr).  */
165 extern char *index __P ((__const char *__s, int __c));
166
167 /* Find the last occurrence of C in S (same as strrchr).  */
168 extern char *rindex __P ((__const char *__s, int __c));
169
170 /* Copy N bytes of SRC to DEST (like memmove, but args reversed).  */
171 extern void bcopy __P ((__const __ptr_t __src, __ptr_t __dest, size_t __n));
172
173 /* Set N bytes of S to 0.  */
174 extern void bzero __P ((__ptr_t __s, size_t __n));
175
176 /* Compare N bytes of S1 and S2 (same as memcmp).  */
177 extern int bcmp __P ((__const __ptr_t __s1, __const __ptr_t __s2, size_t __n));
178
179 /* Return the position of the first bit set in I, or 0 if none are set.
180    The least-significant bit is position 1, the most-significant 32.  */
181 extern int ffs __P ((int __i));
182
183 /* Compare S1 and S2, ignoring case.  */
184 extern int __strcasecmp __P ((__const char *__s1, __const char *__s2));
185 extern int strcasecmp __P ((__const char *__s1, __const char *__s2));
186
187 /* Compare no more than N chars of S1 and S2, ignoring case.  */
188 extern int __strncasecmp __P ((__const char *__s1, __const char *__s2,
189                                size_t __n));
190 extern int strncasecmp __P ((__const char *__s1, __const char *__s2,
191                              size_t __n));
192
193 /* Return the next DELIM-delimited token from *STRINGP,
194    terminating it with a '\0', and update *STRINGP to point past it.  */
195 extern char *strsep __P ((char **__stringp, __const char *__delim));
196 #endif
197
198 #ifdef  __USE_GNU
199 /* Return a string describing the meaning of the signal number in SIG.  */
200 extern char *strsignal __P ((int __sig));
201
202 /* Copy SRC to DEST, returning the address of the terminating '\0' in DEST.  */
203 extern char *__stpcpy __P ((char *__dest, __const char *__src));
204 extern char *stpcpy __P ((char *__dest, __const char *__src));
205
206 /* Copy no more than N characters of SRC to DEST, returning the address of
207    the last character written into DEST.  */
208 extern char *__stpncpy __P ((char *__dest, __const char *__src, size_t __n));
209 extern char *stpncpy __P ((char *__dest, __const char *__src, size_t __n));
210
211 /* Sautee STRING briskly.  */
212 extern char *strfry __P ((char *__string));
213
214 /* Frobnicate N bytes of S.  */
215 extern __ptr_t memfrob __P ((__ptr_t __s, size_t __n));
216 #endif
217
218 #ifdef  __USE_MISC
219 /* Return the file name within directory of FILENAME.  */
220 extern char *basename __P ((__const char *filename));
221 #endif
222
223 __END_DECLS
224
225 #endif /* string.h  */