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