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