update from main archive 970225
[kopensolaris-gnu/glibc.git] / wcsmbs / wchar.h
1 /* Copyright (C) 1995, 1996, 1997 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, Amendment 1, 7.16.4
21  *      General wide-string utilities   <wchar.h>
22  */
23
24 #ifndef _WCHAR_H
25
26 #define _WCHAR_H 1
27 #include <features.h>
28
29 __BEGIN_DECLS
30
31 /* Get size_t, wchar_t, wint_t and NULL from <stddef.h>.  */
32 #define __need_size_t
33 #define __need_wchar_t
34 #define __need_wint_t
35 #define __need_NULL
36 #include <stddef.h>
37
38
39 /* We try to get wint_t from <stddef.h>, but not all GCC versions define it
40    there.  So define it ourselves if it remains undefined.  */
41 #ifndef _WINT_T
42 /* Integral type unchanged by default argument promotions that can
43    hold any value corresponding to members of the extended character
44    set, as well as at least one value that does not correspond to any
45    member of the extended character set.  */
46 #define _WINT_T
47 typedef unsigned int wint_t;
48 #endif
49
50
51 /* Conversion state information.  */
52 typedef struct
53 {
54   int count;            /* Number of bytes needed for the current character. */
55   wint_t value;         /* Value so far.  */
56 } mbstate_t;
57
58 #define WCHAR_MIN ((wchar_t) 0)
59 #define WCHAR_MAX (~WCHAR_MIN)
60
61 #ifndef WEOF
62 # define WEOF (0xffffffffu)
63 #endif
64
65
66 /* Copy SRC to DEST.  */
67 extern wchar_t *wcscpy __P ((wchar_t *__restrict __dest,
68                              __const wchar_t *__restrict __src));
69 /* Copy no more than N wide-characters of SRC to DEST.  */
70 extern wchar_t *wcsncpy __P ((wchar_t *__restrict __dest,
71                               __const wchar_t *__restrict __src, size_t __n));
72
73 /* Append SRC onto DEST.  */
74 extern wchar_t *wcscat __P ((wchar_t *__restrict __dest,
75                              __const wchar_t *__restrict __src));
76 /* Append no more than N wide-characters of SRC onto DEST.  */
77 extern wchar_t *wcsncat __P ((wchar_t *__restrict __dest,
78                               __const wchar_t *__restrict __src, size_t __n));
79
80 /* Compare S1 and S2.  */
81 extern int wcscmp __P ((__const wchar_t *__s1, __const wchar_t *__s2));
82 /* Compare N wide-characters of S1 and S2.  */
83 extern int wcsncmp __P ((__const wchar_t *__s1, __const wchar_t *__s2,
84                          size_t __n));
85
86 #ifdef __USE_GNU
87 /* Compare S1 and S2, ignoring case.  */
88 extern int __wcscasecmp __P ((__const wchar_t *__s1, __const wchar_t *__s2));
89 extern int wcscasecmp __P ((__const wchar_t *__s1, __const wchar_t *__s2));
90
91 /* Compare no more than N chars of S1 and S2, ignoring case.  */
92 extern int __wcsncasecmp __P ((__const wchar_t *__s1, __const wchar_t *__s2,
93                                size_t __n));
94 extern int wcsncasecmp __P ((__const wchar_t *__s1, __const wchar_t *__s2,
95                              size_t __n));
96 #endif
97
98 /* Compare S1 and S2, both interpreted as appropriate to the
99    LC_COLLATE category of the current locale.  */
100 extern int wcscoll __P ((__const wchar_t *__s1, __const wchar_t *__s2));
101 /* Transform S2 into array pointed to by S1 such that if wcscmp is
102    applied to two transformed strings the result is the as applying
103    `wcscoll' to the original strings.  */
104 extern size_t wcsxfrm __P ((wchar_t *__restrict __s1,
105                             __const wchar_t *__restrict __s2, size_t __n));
106
107 #ifdef __USE_GNU
108 /* Similar to the two functions above but take the information from
109    the provided locale and not the global locale.  */
110 # include <xlocale.h>
111
112 /* Compare S1 and S2, both interpreted as appropriate to the
113    LC_COLLATE category of the given locale.  */
114 extern int __wcscoll_l __P ((__const wchar_t *__s1, __const wchar_t *__s2,
115                              __locale_t __loc));
116 /* Transform S2 into array pointed to by S1 such that if wcscmp is
117    applied to two transformed strings the result is the as applying
118    `wcscoll' to the original strings.  */
119 extern size_t __wcsxfrm_l __P ((wchar_t *__s1, __const wchar_t *__s2,
120                                 size_t __n, __locale_t __loc));
121 #endif
122
123 /* Duplicate S, returning an identical malloc'd string.  */
124 extern wchar_t *wcsdup __P ((__const wchar_t *__s));
125
126 /* Find the first occurrence of WC in WCS.  */
127 extern wchar_t *wcschr __P ((__const wchar_t *__wcs, wchar_t __wc));
128 /* Find the last occurrence of WC in WCS.  */
129 extern wchar_t *wcsrchr __P ((__const wchar_t *__wcs, wchar_t __wc));
130
131 /* Return the length of the initial segmet of WCS which
132    consists entirely of wide-characters not in REJECT.  */
133 extern size_t wcscspn __P ((__const wchar_t *__wcs,
134                             __const wchar_t *__reject));
135 /* Return the length of the initial segmet of WCS which
136    consists entirely of wide-characters in  ACCEPT.  */
137 extern size_t wcsspn __P ((__const wchar_t *__wcs, __const wchar_t *__accept));
138 /* Find the first occurrence in WCS of any character in ACCEPT.  */
139 extern wchar_t *wcspbrk __P ((__const wchar_t *__wcs,
140                               __const wchar_t *__accept));
141 /* Find the first occurrence of NEEDLE in HAYSTACK.  */
142 extern wchar_t *wcsstr __P ((__const wchar_t *__haystack,
143                              __const wchar_t *__needle));
144 /* Divide WCS into tokens separated by characters in DELIM.  */
145 extern wchar_t *wcstok __P ((wchar_t *__restrict __s,
146                              __const wchar_t *__restrict __delim,
147                              wchar_t **__restrict __ptr));
148
149 /* Return the number of wide-characters in S.  */
150 extern size_t wcslen __P ((__const wchar_t *__s));
151
152
153 /* Search N bytes of S for C.  */
154 extern wchar_t *wmemchr __P ((__const wchar_t *__s, wchar_t __c, size_t __n));
155
156 /* Compare N bytes of S1 and S2.  */
157 extern int wmemcmp __P ((__const wchar_t *__restrict __s1,
158                          __const wchar_t *__restrict __s2, size_t __n));
159
160 /* Copy N bytes of SRC to DEST.  */
161 extern wchar_t *wmemcpy __P ((wchar_t *__restrict __s1,
162                               __const wchar_t *__restrict __s2, size_t __n));
163
164 /* Copy N bytes of SRC to DEST, guaranteeing
165    correct behavior for overlapping strings.  */
166 extern wchar_t *wmemmove __P ((wchar_t *__s1, __const wchar_t *__s2,
167                                size_t __n));
168
169 /* Set N bytes of S to C.  */
170 extern wchar_t *wmemset __P ((wchar_t *__s, wchar_t __c, size_t __n));
171
172
173 /* Determine whether C constitutes a valid (one-byte) multibyte
174    character.  */
175 extern wint_t btowc __P ((int __c));
176
177 /* Determine whether C corresponds to a member of the extended
178    character set whose multibyte representation is a single byte.  */
179 extern int wctob __P ((wint_t __c));
180
181 /* Determine whether PS points to an object representing the initial
182    state.  */
183 extern int mbsinit __P ((__const mbstate_t *__ps));
184
185 /* Write wide character representation of multibyte character pointed
186    to by S to PWC.  */
187 extern size_t __mbrtowc __P ((wchar_t *__restrict __pwc,
188                               __const char *__restrict __s, size_t __n,
189                               mbstate_t *__restrict __p));
190 extern size_t mbrtowc __P ((wchar_t *__restrict __pwc,
191                             __const char *__restrict __s, size_t __n,
192                             mbstate_t *__p));
193
194 /* Write multibyte representation of wide character WC to S.  */
195 extern size_t __wcrtomb __P ((char *__restrict __s, wchar_t __wc,
196                               mbstate_t *__restrict __ps));
197 extern size_t wcrtomb __P ((char *__restrict __s, wchar_t __wc,
198                             mbstate_t *__restrict __ps));
199
200 /* Return number of bytes in multibyte character pointed to by S.  */
201 extern size_t __mbrlen __P ((__const char *__restrict __s, size_t __n,
202                              mbstate_t *__restrict __ps));
203 extern size_t mbrlen __P ((__const char *__restrict __s, size_t __n,
204                            mbstate_t *__restrict __ps));
205
206 #if defined (__OPTIMIZE__) \
207     && (__GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 7))
208 /* Define inline function as optimization.  */
209 extern __inline size_t mbrlen (__const char *__restrict __s, size_t __n,
210                                mbstate_t *__restrict __ps)
211 { return (__ps != NULL
212           ? __mbrtowc (NULL, __s, __n, __ps) : __mbrlen (__s, __n, NULL)); }
213 #endif
214
215 /* Write wide character representation of multibyte character string
216    SRC to DST.  */
217 extern size_t __mbsrtowcs __P ((wchar_t *__restrict __dst,
218                                 __const char **__restrict __src,
219                                 size_t __len, mbstate_t *__restrict __ps));
220 extern size_t mbsrtowcs __P ((wchar_t *__restrict __dst,
221                               __const char **__restrict __src,
222                               size_t __len, mbstate_t *__restrict __ps));
223
224 /* Write multibyte character representation of wide character string
225    SRC to DST.  */
226 extern size_t __wcsrtombs __P ((char *__restrict __dst,
227                                 __const wchar_t **__restrict __src,
228                                 size_t __len, mbstate_t *__restrict __ps));
229 extern size_t wcsrtombs __P ((char *__restrict __dst,
230                               __const wchar_t **__restrict __src,
231                               size_t __len, mbstate_t *__restrict __ps));
232
233
234 #ifdef  __USE_GNU
235 /* Write wide character representation of at most NMC bytes of the
236    multibyte character string SRC to DST.  */
237 extern size_t __mbsnrtowcs __P ((wchar_t *__restrict __dst,
238                                  __const char **__restrict __src, size_t __nmc,
239                                  size_t __len, mbstate_t *__restrict __ps));
240 extern size_t mbsnrtowcs __P ((wchar_t *__restrict __dst,
241                                __const char **__restrict __src, size_t __nmc,
242                                size_t __len, mbstate_t *__restrict __ps));
243
244 /* Write multibyte character representation of at most NWC characters
245    from the wide character string SRC to DST.  */
246 extern size_t __wcsnrtombs __P ((char *__restrict __dst,
247                                  __const wchar_t **__restrict __src,
248                                  size_t __nwc, size_t __len,
249                                  mbstate_t *__restrict __ps));
250 extern size_t wcsnrtombs __P ((char *__restrict __dst,
251                                __const wchar_t **__restrict __src,
252                                size_t __nwc, size_t __len,
253                                mbstate_t *__restrict __ps));
254
255
256 /* The following functions are extensions found in X/Open CAE.  */
257
258 /* Determine number of column positions required for C.  */
259 extern int wcwidth __P ((wint_t __c));
260
261 /* Determine number of column positions required for first N wide
262    characters (or fewer if S ends before this) in S.  */
263 extern int wcswidth __P ((__const wchar_t *__s, size_t __n));
264 #endif  /* use GNU */
265
266
267 /* Convert initial portion of the wide string NPTR to `double'
268    representation.  */
269 extern double wcstod __P ((__const wchar_t *__restrict __nptr,
270                            wchar_t **__restrict __endptr));
271
272 #ifdef __USE_GNU
273 /* Likewise for `float' and `long double' sizes of floating-point numbers.  */
274 extern float wcstof __P ((__const wchar_t *__restrict __nptr,
275                           wchar_t **__restrict __endptr));
276 extern __long_double_t wcstold __P ((__const wchar_t *__restrict __nptr,
277                                      wchar_t **__restrict __endptr));
278 #endif /* GNU */
279
280
281 /* Convert initial portion of wide string NPTR to `long int'
282    representation.  */
283 extern long int wcstol __P ((__const wchar_t *__restrict __nptr,
284                              wchar_t **__restrict __endptr, int __base));
285
286 /* Convert initial portion of wide string NPTR to `unsigned long int'
287    representation.  */
288 extern unsigned long int wcstoul __P ((__const wchar_t *__restrict __nptr,
289                                        wchar_t **__restrict __endptr,
290                                        int __base));
291
292 #if defined __GNUC__ && defined __USE_GNU
293 /* Convert initial portion of wide string NPTR to `long int'
294    representation.  */
295 extern long long int wcstoq __P ((__const wchar_t *__restrict __nptr,
296                                   wchar_t **__restrict __endptr, int __base));
297
298 /* Convert initial portion of wide string NPTR to `unsigned long long int'
299    representation.  */
300 extern unsigned long long int wcstouq __P ((__const wchar_t *__restrict __nptr,
301                                             wchar_t **__restrict __endptr,
302                                             int __base));
303 #endif /* GCC and use GNU.  */
304
305 #if defined __USE_ISOC9X || (defined __GNUC__ && defined __USE_GNU)
306 /* Convert initial portion of wide string NPTR to `long int'
307    representation.  */
308 extern long long int wcstoll __P ((__const wchar_t *__restrict __nptr,
309                                    wchar_t **__restrict __endptr, int __base));
310
311 /* Convert initial portion of wide string NPTR to `unsigned long long int'
312    representation.  */
313 extern unsigned long long int wcstoull __P ((__const wchar_t *
314                                              __restrict __nptr,
315                                              wchar_t **__restrict __endptr,
316                                              int __base));
317 #endif /* ISO C 9X or GCC and GNU.  */
318
319
320 /* The internal entry points for `wcstoX' take an extra flag argument
321    saying whether or not to parse locale-dependent number grouping.  */
322 extern double __wcstod_internal __P ((__const wchar_t *__restrict __nptr,
323                                       wchar_t **__restrict __endptr,
324                                       int __group));
325 extern float __wcstof_internal __P ((__const wchar_t *__restrict __nptr,
326                                      wchar_t **__restrict __endptr,
327                                      int __group));
328 extern __long_double_t __wcstold_internal __P ((__const wchar_t *
329                                                 __restrict __nptr,
330                                                 wchar_t **__restrict __endptr,
331                                                 int __group));
332
333 extern long int __wcstol_internal __P ((__const wchar_t *__restrict __nptr,
334                                         wchar_t **__restrict __endptr,
335                                         int __base, int __group));
336 extern unsigned long int __wcstoul_internal __P ((__const wchar_t *
337                                                   __restrict __nptr,
338                                                   wchar_t **
339                                                   __restrict __endptr,
340                                                   int __base, int __group));
341 #if defined __GNUC__ && defined __USE_GNU
342 extern long long int __wcstoll_internal __P ((__const wchar_t *
343                                               __restrict __nptr,
344                                               wchar_t **__restrict __endptr,
345                                               int __base, int __group));
346 extern unsigned long long int __wcstoull_internal __P ((__const wchar_t *
347                                                         __restrict __nptr,
348                                                         wchar_t **
349                                                         __restrict __endptr,
350                                                         int __base,
351                                                         int __group));
352 #endif /* GCC and use GNU.  */
353
354
355 #if defined (__OPTIMIZE__) && __GNUC__ >= 2
356 /* Define inline functions which call the internal entry points.  */
357
358 extern __inline double wcstod (__const wchar_t *__restrict __nptr,
359                                wchar_t **__restrict __endptr)
360 { return __wcstod_internal (__nptr, __endptr, 0); }
361 extern __inline long int wcstol (__const wchar_t *__restrict __nptr,
362                                  wchar_t **__restrict __endptr, int __base)
363 { return __wcstol_internal (__nptr, __endptr, __base, 0); }
364 extern __inline unsigned long int wcstoul (__const wchar_t *__restrict __nptr,
365                                            wchar_t **__restrict __endptr,
366                                            int __base)
367 { return __wcstoul_internal (__nptr, __endptr, __base, 0); }
368
369 #ifdef __USE_GNU
370 extern __inline float wcstof (__const wchar_t *__restrict __nptr,
371                               wchar_t **__restrict __endptr)
372 { return __wcstof_internal (__nptr, __endptr, 0); }
373 extern __inline __long_double_t wcstold (__const wchar_t *__restrict __nptr,
374                                          wchar_t **__restrict __endptr)
375 { return __wcstold_internal (__nptr, __endptr, 0); }
376
377
378 extern __inline long long int wcstoq (__const wchar_t *__restrict __nptr,
379                                       wchar_t **__restrict __endptr,
380                                       int __base)
381 { return __wcstoll_internal (__nptr, __endptr, __base, 0); }
382 extern __inline unsigned long long int wcstouq (__const wchar_t *
383                                                 __restrict __nptr,
384                                                 wchar_t **__restrict __endptr,
385                                                 int __base)
386 { return __wcstoull_internal (__nptr, __endptr, __base, 0); }
387 #endif /* Use GNU.  */
388 #endif /* Optimizing GCC >=2.  */
389
390
391 #ifdef  __USE_GNU
392 /* Copy SRC to DEST, returning the address of the terminating L'\0' in
393    DEST.  */
394 extern wchar_t *__wcpcpy __P ((wchar_t *__dest, __const wchar_t *__src));
395 extern wchar_t *wcpcpy __P ((wchar_t *__dest, __const wchar_t *__src));
396
397 /* Copy no more than N characters of SRC to DEST, returning the address of
398    the last character written into DEST.  */
399 extern wchar_t *__wcpncpy __P ((wchar_t *__dest, __const wchar_t *__src,
400                                 size_t __n));
401 extern wchar_t *wcpncpy __P ((wchar_t *__dest, __const wchar_t *__src,
402                               size_t __n));
403 #endif  /* use GNU */
404
405
406 __END_DECLS
407
408 #endif /* wchar.h  */