Sun May 26 15:15:08 1996 Roland McGrath <roland@delasyd.gnu.ai.mit.edu>
[kopensolaris-gnu/glibc.git] / wcsmbs / wchar.h
1 /* Copyright (C) 1995, 1996 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  *      ISO Standard: 7.16.4 General wide-string utilities      <wchar.h>
21  */
22
23 #ifndef _WCHAR_H
24
25 #define _WCHAR_H 1
26 #include <features.h>
27
28 __BEGIN_DECLS
29
30 /* Get size_t, wchar_t, wint_t and NULL from <stddef.h>.  */
31 #define __need_size_t
32 #define __need_wchar_t
33 #define __need_wint_t
34 #define __need_NULL
35 #include <stddef.h>
36
37
38 /* We try to get wint_t from <stddef.h>, but not all GCC versions define it
39    there.  So define it ourselves if it remains undefined.  */
40 #ifndef _WINT_T
41 /* Integral type unchanged by default argument promotions that can
42    hold any value corresponding to members of the extended character
43    set, as well as at least one value that does not correspond to any
44    member of the extended character set.  */
45 #define _WINT_T
46 typedef unsigned int wint_t;
47 #endif
48
49
50 /* Conversion state information.  */
51 typedef int mbstate_t; /* FIXME */
52
53 #define WCHAR_MIN ((wchar_t) 0)
54 #define WCHAR_MAX (~WCHAR_MIN)
55
56 #ifndef WEOF
57 # define WEOF (0xffffffffu)
58 #endif
59
60
61 /* Copy SRC to DEST.  */
62 extern wchar_t *wcscpy __P ((wchar_t *__dest, __const wchar_t *__src));
63 /* Copy no more than N wide-characters of SRC to DEST.  */
64 extern wchar_t *wcsncpy __P ((wchar_t *__dest, __const wchar_t *__src,
65                               size_t __n));
66
67 /* Append SRC onto DEST.  */
68 extern wchar_t *wcscat __P ((wchar_t *__dest, __const wchar_t *__src));
69 /* Append no more than N wide-characters of SRC onto DEST.  */
70 extern wchar_t *wcsncat __P ((wchar_t *__dest, __const wchar_t *__src,
71                               size_t __n));
72
73 /* Compare S1 and S2.  */
74 extern int wcscmp __P ((__const wchar_t *__s1, __const wchar_t *__s2));
75 /* Compare N wide-characters of S1 and S2.  */
76 extern int wcsncmp __P ((__const wchar_t *__s1, __const wchar_t *__s2,
77                          size_t __n));
78
79 /* Compare S1 and S2, both interpreted as appropriate to the
80    LC_COLLATE category of the current locale.  */
81 extern int wcscoll __P ((__const wchar_t *__s1, __const wchar_t *__s2));
82 /* Transform S2 into array pointed to by S1 such that if wcscmp is
83    applied to two transformed strings the result is the as applying
84    `wcscoll' to the original strings.  */
85 extern size_t wcsxfrm __P ((wchar_t *__s1, __const wchar_t *__s2, size_t __n));
86
87 /* Duplicate S, returning an identical malloc'd string.  */
88 extern wchar_t *wcsdup __P ((__const wchar_t *__s));
89
90 /* Find the first occurence of WC in WCS.  */
91 extern wchar_t *wcschr __P ((__const wchar_t *__wcs, wchar_t __wc));
92 /* Find the last occurence of WC in WCS.  */
93 extern wchar_t *wcsrchr __P ((__const wchar_t *__wcs, wchar_t __wc));
94
95 /* Return the length of the initial segmet of WCS which
96    consists entirely of wide-characters not in REJECT.  */
97 extern size_t wcscspn __P ((__const wchar_t *__wcs,
98                             __const wchar_t *__reject));
99 /* Return the length of the initial segmet of WCS which
100    consists entirely of wide-characters in  ACCEPT.  */
101 extern size_t wcsspn __P ((__const wchar_t *__wcs, __const wchar_t *__accept));
102 /* Find the first occurence in WCS of any character in ACCEPT.  */
103 extern wchar_t *wcspbrk __P ((__const wchar_t *__wcs,
104                               __const wchar_t *__accept));
105 /* Find the first occurence of NEEDLE in HAYSTACK.  */
106 extern wchar_t *wcsstr __P ((__const wchar_t *__haystack,
107                              __const wchar_t *__needle));
108 /* Divide WCS into tokens separated by characters in DELIM.  */
109 extern wchar_t *wcstok __P ((wchar_t *__s, __const wchar_t *__delim,
110                              wchar_t **ptr));
111
112 /* Return the number of wide-characters in S.  */
113 extern size_t wcslen __P ((__const wchar_t *__s));
114
115
116 /* Search N bytes of S for C.  */
117 extern wchar_t *wmemchr __P ((__const wchar_t *__s, wchar_t __c, size_t __n));
118
119 /* Compare N bytes of S1 and S2.  */
120 extern int wmemcmp __P ((__const wchar_t *__s1, __const wchar_t *__s2,
121                          size_t __n));
122
123 /* Copy N bytes of SRC to DEST.  */
124 extern wchar_t *wmemcpy __P ((wchar_t *__s1, __const wchar_t *__s2,
125                               size_t __n));
126
127 /* Copy N bytes of SRC to DEST, guaranteeing
128    correct behavior for overlapping strings.  */
129 extern wchar_t *wmemmove __P ((wchar_t *__s1, __const wchar_t *__s2,
130                                size_t __N));
131
132 /* Set N bytes of S to C.  */
133 extern wchar_t *wmemset __P ((wchar_t *__s, wchar_t __c, size_t __n));
134
135
136 /* Determine whether C constitutes a valid (one-byte) multibyte
137    character.  */
138 extern wint_t btowc __P ((int __c));
139
140 /* Determine whether C corresponds to a member of the extended
141    character set whose multibyte representation is a single byte.  */
142 extern int wctob __P ((wint_t __c));
143
144 /* Determine whether PS points to an object representing the initial
145    state.  */
146 extern int mbsinit __P ((__const mbstate_t *__ps));
147
148 /* Return number of bytes in multibyte character pointed to by S.  */
149 extern size_t mbrlen __P ((__const char *__s, size_t __n, mbstate_t *ps));
150
151 /* Write wide character representation of multibyte character pointed
152    to by S to PWC.  */
153 extern size_t mbrtowc __P ((wchar_t *__pwc, __const char *__s, size_t __n,
154                             mbstate_t *__p));
155
156 /* Write multibyte representation of wide character WC to S.  */
157 extern size_t wcrtomb __P ((char *__s, wchar_t __wc, mbstate_t *__ps));
158
159 /* Write wide character representation of multibyte chracter string SRC
160    to DST.  */
161 extern size_t mbsrtowcs __P ((wchar_t *__dst, __const char **__src,
162                               size_t __len, mbstate_t *__ps));
163
164 /* Write multibyte character representation of wide character string
165    SRC to DST.  */
166 extern size_t wcsrtombs __P ((char *__dst, __const wchar_t **__src,
167                               size_t __len, mbstate_t *__ps));
168
169
170 #ifdef  __USE_GNU
171 /* The following functions are extensions found in X/Open CAE.  */
172
173 /* Determine number of column positions required for C.  */
174 extern int wcwidth __P ((wint_t __c));
175
176 /* Determine number of column positions required for first N wide
177    characters (or fewer if S ends before this) in S.  */
178 extern int wcswidth __P ((__const wchar_t *__s, size_t __n));
179 #endif  /* use GNU */
180
181
182 /* Convert initial portion of the wide string NPTR to `double'
183    representation.  */
184 extern double wcstod __P ((__const wchar_t *__nptr, wchar_t **__endptr));
185
186 #ifdef __USE_GNU
187 /* Likewise for `float' and `long double' sizes of floating-point numbers.  */
188 extern float wcstof __P ((__const wchar_t *__nptr, wchar_t **__endptr));
189 extern __long_double_t wcstold __P ((__const wchar_t *__nptr,
190                                      wchar_t **__endptr));
191 #endif /* GNU */
192
193
194 /* Convert initial portion of wide string NPTR to `long int'
195    representation.  */
196 extern long int wcstol __P ((__const wchar_t *__nptr, wchar_t **__endptr,
197                              int __base));
198
199 /* Convert initial portion of wide string NPTR to `unsigned long int'
200    representation.  */
201 extern unsigned long int wcstoul __P ((__const wchar_t *__nptr,
202                                        wchar_t **__endptr, int __base));
203
204 #if defined (__GNUC__) && defined (__USE_GNU)
205 /* Convert initial portion of wide string NPTR to `long int'
206    representation.  */
207 extern long long int wcstoq __P ((__const wchar_t *__nptr, wchar_t **__endptr,
208                                   int __base));
209
210 /* Convert initial portion of wide string NPTR to `unsigned long long int'
211    representation.  */
212 extern unsigned long long int wcstouq __P ((__const wchar_t *__nptr,
213                                             wchar_t **__endptr, int __base));
214 #endif /* GCC and use GNU.  */
215
216
217 /* The internal entry points for `wcstoX' take an extra flag argument
218    saying whether or not to parse locale-dependent number grouping.  */
219 extern double __wcstod_internal __P ((__const wchar_t *__nptr,
220                                       wchar_t **_endptr, int __group));
221 extern float __wcstof_internal __P ((__const wchar_t *__nptr,
222                                      wchar_t **_endptr, int __group));
223 extern __long_double_t __wcstold_internal __P ((__const wchar_t *__nptr,
224                                                 wchar_t **_endptr,
225                                                 int __group));
226
227 extern long int __wcstol_internal __P ((__const wchar_t *__nptr,
228                                         wchar_t **__endptr, int __base,
229                                         int __group));
230 extern unsigned long int __wcstoul_internal __P ((__const wchar_t *__nptr,
231                                                   wchar_t **__endptr,
232                                                   int __base, int __group));
233 #ifdef __GNUC__
234 extern long long int __wcstoq_internal __P ((__const wchar_t *__nptr,
235                                              wchar_t **__endptr, int __base,
236                                              int __group));
237 extern unsigned long long int __wcstouq_internal __P ((__const wchar_t *__nptr,
238                                                        wchar_t **__endptr,
239                                                        int __base,
240                                                        int __group));
241 #endif /* GCC */
242
243
244 #if defined (__OPTIMIZE__) && __GNUC__ >= 2
245 /* Define inline functions which call the internal entry points.  */
246
247 extern __inline double wcstod (__const wchar_t *__nptr, wchar_t **__endptr)
248 { return __wcstod_internal (__nptr, __endptr, 0); }
249 extern __inline long int wcstol (__const wchar_t *__nptr,
250                                  wchar_t **__endptr, int __base)
251 { return __wcstol_internal (__nptr, __endptr, __base, 0); }
252 extern __inline unsigned long int wcstoul (__const wchar_t *__nptr,
253                                            wchar_t **__endptr, int __base)
254 { return __wcstoul_internal (__nptr, __endptr, __base, 0); }
255
256 #ifdef __USE_GNU
257 extern __inline float wcstof (__const wchar_t *__nptr, wchar_t **__endptr)
258 { return __wcstof_internal (__nptr, __endptr, 0); }
259 extern __inline __long_double_t wcstold (__const wchar_t *__nptr,
260                                          wchar_t **__endptr)
261 { return __wcstold_internal (__nptr, __endptr, 0); }
262 #endif
263
264 #ifdef __USE_BSD
265 extern __inline long long int wcstoq (__const wchar_t *__nptr,
266                                       wchar_t **__endptr, int __base)
267 { return __wcstoq_internal (__nptr, __endptr, __base, 0); }
268 extern __inline unsigned long long int wcstouq (__const wchar_t *__nptr,
269                                                 wchar_t **__endptr, int __base)
270 { return __wcstouq_internal (__nptr, __endptr, __base, 0); }
271 #endif
272 #endif /* Optimizing GCC >=2.  */
273
274
275 #ifdef  __USE_GNU
276 /* Copy SRC to DEST, returning the address of the terminating L'\0' in
277    DEST.  */
278 extern wchar_t *__wcpcpy __P ((wchar_t *__dest, __const wchar_t *__src));
279 extern wchar_t *wcpcpy __P ((wchar_t *__dest, __const wchar_t *__src));
280
281 /* Copy no more than N characters of SRC to DEST, returning the address of
282    the last character written into DEST.  */
283 extern wchar_t *__wcpncpy __P ((wchar_t *__dest, __const wchar_t *__src,
284                                 size_t __n));
285 extern wchar_t *wcpncpy __P ((wchar_t *__dest, __const wchar_t *__src,
286                               size_t __n));
287 #endif  /* use GNU */
288
289
290 __END_DECLS
291
292 #endif /* wchar.h  */