xref: /netbsd-src/include/wchar.h (revision 0e03e9aa32bfe10a387a6b8519ad3ec2bc3017c5)
1 /*	$NetBSD: wchar.h,v 1.46 2024/11/01 16:36:58 nia Exp $	*/
2 
3 /*-
4  * Copyright (c)1999 Citrus Project,
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26  * SUCH DAMAGE.
27  */
28 
29 /*-
30  * Copyright (c) 1999, 2000 The NetBSD Foundation, Inc.
31  * All rights reserved.
32  *
33  * This code is derived from software contributed to The NetBSD Foundation
34  * by Julian Coleman.
35  *
36  * Redistribution and use in source and binary forms, with or without
37  * modification, are permitted provided that the following conditions
38  * are met:
39  * 1. Redistributions of source code must retain the above copyright
40  *    notice, this list of conditions and the following disclaimer.
41  * 2. Redistributions in binary form must reproduce the above copyright
42  *    notice, this list of conditions and the following disclaimer in the
43  *    documentation and/or other materials provided with the distribution.
44  *
45  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
46  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
47  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
48  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
49  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
50  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
51  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
52  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
53  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
54  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
55  * POSSIBILITY OF SUCH DAMAGE.
56  */
57 
58 #ifndef _WCHAR_H_
59 #define _WCHAR_H_
60 
61 #include <sys/cdefs.h>
62 #include <sys/featuretest.h>
63 #include <machine/wchar_limits.h>
64 #include <sys/ansi.h>
65 #include <sys/null.h>
66 
67 #include <stdio.h> /* for FILE* */
68 
69 #if defined(_BSD_WCHAR_T_) && !defined(__cplusplus)
70 typedef	_BSD_WCHAR_T_	wchar_t;
71 #undef	_BSD_WCHAR_T_
72 #endif
73 
74 #ifdef	_BSD_MBSTATE_T_
75 typedef	_BSD_MBSTATE_T_	mbstate_t;
76 #undef	_BSD_MBSTATE_T_
77 #endif
78 
79 #ifdef	_BSD_WINT_T_
80 typedef	_BSD_WINT_T_	wint_t;
81 #undef	_BSD_WINT_T_
82 #endif
83 
84 #ifdef	_BSD_SIZE_T_
85 typedef	_BSD_SIZE_T_	size_t;
86 #undef	_BSD_SIZE_T_
87 #endif
88 
89 #if defined(_POSIX_C_SOURCE)
90 #ifndef __VA_LIST_DECLARED
91 typedef __va_list va_list;
92 #define __VA_LIST_DECLARED
93 #endif
94 #endif
95 
96 struct tm;
97 
98 __BEGIN_DECLS
99 wint_t	btowc(int);
100 size_t	mbrlen(const char * __restrict, size_t, mbstate_t * __restrict);
101 size_t	mbrtowc(wchar_t * __restrict, const char * __restrict, size_t,
102 	    mbstate_t * __restrict);
103 int	mbsinit(const mbstate_t *);
104 size_t	mbsrtowcs(wchar_t * __restrict, const char ** __restrict, size_t,
105 	    mbstate_t * __restrict);
106 size_t	wcrtomb(char * __restrict, wchar_t, mbstate_t * __restrict);
107 wchar_t	*wcscat(wchar_t * __restrict, const wchar_t * __restrict);
108 wchar_t	*wcschr(const wchar_t *, wchar_t);
109 int	wcscmp(const wchar_t *, const wchar_t *);
110 int	wcscoll(const wchar_t *, const wchar_t *);
111 wchar_t	*wcscpy(wchar_t * __restrict, const wchar_t * __restrict);
112 size_t	wcscspn(const wchar_t *, const wchar_t *);
113 size_t	wcsftime(wchar_t * __restrict, size_t, const wchar_t * __restrict,
114 	    const struct tm * __restrict);
115 size_t	wcslen(const wchar_t *);
116 wchar_t	*wcsncat(wchar_t * __restrict, const wchar_t * __restrict, size_t);
117 int	wcsncmp(const wchar_t *, const wchar_t *, size_t);
118 wchar_t	*wcsncpy(wchar_t * __restrict , const wchar_t * __restrict, size_t);
119 size_t	wcsnlen(const wchar_t *, size_t);
120 wchar_t	*wcspbrk(const wchar_t *, const wchar_t *);
121 wchar_t	*wcsrchr(const wchar_t *, wchar_t);
122 size_t	wcsrtombs(char * __restrict, const wchar_t ** __restrict, size_t,
123 	    mbstate_t * __restrict);
124 size_t	wcsspn(const wchar_t *, const wchar_t *);
125 wchar_t	*wcsstr(const wchar_t *, const wchar_t *);
126 wchar_t *wcstok(wchar_t * __restrict, const wchar_t * __restrict,
127 		     wchar_t ** __restrict);
128 size_t	wcsxfrm(wchar_t *, const wchar_t *, size_t);
129 wchar_t	*wcswcs(const wchar_t *, const wchar_t *);
130 wchar_t	*wmemchr(const wchar_t *, wchar_t, size_t);
131 int	wmemcmp(const wchar_t *, const wchar_t *, size_t);
132 wchar_t	*wmemcpy(wchar_t * __restrict, const wchar_t * __restrict, size_t);
133 wchar_t	*wmempcpy(wchar_t * __restrict, const wchar_t * __restrict, size_t);
134 wchar_t	*wmemmove(wchar_t *, const wchar_t *, size_t);
135 wchar_t	*wmemset(wchar_t *, wchar_t, size_t);
136 
137 /*
138  * IEEE Std 1003.1-2024 (POSIX.1-2024)
139  */
140 #if (_POSIX_C_SOURCE - 0) >= 202405L || (_XOPEN_SOURCE - 0 >= 800) || \
141     defined(_NETBSD_SOURCE)
142 size_t	wcslcat(wchar_t *, const wchar_t *, size_t);
143 size_t	wcslcpy(wchar_t *, const wchar_t *, size_t);
144 #endif
145 
146 #if defined(_NETBSD_SOURCE) || \
147     (_POSIX_C_SOURCE - 0 >= 200112L) || (_XOPEN_SOURCE - 0) >= 600
148 int	wcswidth(const wchar_t *, size_t);
149 int	wcwidth(wchar_t);
150 #endif
151 
152 int	wctob(wint_t);
153 unsigned long int wcstoul(const wchar_t * __restrict,
154 	wchar_t ** __restrict, int);
155 long int wcstol(const wchar_t * __restrict,
156 	wchar_t ** __restrict, int);
157 double wcstod(const wchar_t * __restrict, wchar_t ** __restrict);
158 
159 #if defined(_ISOC99_SOURCE) || (__STDC_VERSION__ - 0) >= 199901L || \
160     (__cplusplus - 0) >= 201103L || defined(_NETBSD_SOURCE) || \
161     (_POSIX_C_SOURCE - 0) >= 200112L || (_XOPEN_SOURCE - 0) >= 600
162 float wcstof(const wchar_t * __restrict, wchar_t ** __restrict);
163 long double wcstold(const wchar_t * __restrict, wchar_t ** __restrict);
164 
165 /* LONGLONG */
166 long long int wcstoll(const wchar_t * __restrict,
167 	wchar_t ** __restrict, int);
168 /* LONGLONG */
169 unsigned long long int wcstoull(const wchar_t * __restrict,
170 	wchar_t ** __restrict, int);
171 #endif
172 
173 #if (_POSIX_C_SOURCE - 0) >= 200809L || (_XOPEN_SOURCE - 0) >= 700 || \
174     defined(_NETBSD_SOURCE)
175 FILE	*open_wmemstream(wchar_t **, size_t *);
176 #endif
177 
178 wint_t ungetwc(wint_t, FILE *);
179 wint_t fgetwc(FILE *);
180 wchar_t *fgetws(wchar_t * __restrict, int, FILE * __restrict);
181 wint_t getwc(FILE *);
182 wint_t getwchar(void);
183 wint_t fputwc(wchar_t, FILE *);
184 int fputws(const wchar_t * __restrict, FILE * __restrict);
185 wint_t putwc(wchar_t, FILE *);
186 wint_t putwchar(wchar_t);
187 
188 int fwide(FILE *, int);
189 
190 wchar_t	*fgetwln(FILE * __restrict, size_t * __restrict);
191 int fwprintf(FILE * __restrict, const wchar_t * __restrict, ...);
192 int fwscanf(FILE * __restrict, const wchar_t * __restrict, ...);
193 int swprintf(wchar_t * __restrict, size_t n, const wchar_t * __restrict, ...);
194 int swscanf(const wchar_t * __restrict, const wchar_t * __restrict, ...);
195 int vfwprintf(FILE * __restrict, const wchar_t * __restrict, __va_list);
196 int vswprintf(wchar_t * __restrict, size_t, const wchar_t * __restrict,
197     __va_list);
198 int vwprintf(const wchar_t * __restrict, __va_list);
199 int wprintf(const wchar_t * __restrict, ...);
200 int wscanf(const wchar_t * __restrict, ...);
201 #if defined(_ISOC99_SOURCE) || (__STDC_VERSION__ - 0) > 199901L || \
202     (__cplusplus - 0) >= 201103L || defined(_NETBSD_SOURCE) || \
203     (_POSIX_C_SOURCE - 0) >= 200112L || (_XOPEN_SOURCE - 0) >= 600
204 int vfwscanf(FILE * __restrict, const wchar_t * __restrict, __va_list);
205 int vswscanf(const wchar_t * __restrict, const wchar_t * __restrict,
206     __va_list);
207 int vwscanf(const wchar_t * __restrict, __va_list);
208 #endif
209 #if defined(_NETBSD_SOURCE)
210 struct tinfo;
211 int t_putws(struct tinfo *, const wchar_t *, int, void (*)(wchar_t, void *),
212     void *);
213 wchar_t *wcsdup (const wchar_t *);
214 int wcsncasecmp (const wchar_t *, const wchar_t *, size_t);
215 int wcscasecmp(const wchar_t *, const wchar_t *);
216 #endif
217 __END_DECLS
218 
219 #ifndef WEOF
220 #define	WEOF 	((wint_t)-1)
221 #endif
222 
223 #define getwc(f) fgetwc(f)
224 #define getwchar() getwc(stdin)
225 #define putwc(wc, f) fputwc((wc), (f))
226 #define putwchar(wc) putwc((wc), stdout)
227 
228 #if (_POSIX_C_SOURCE - 0) >= 200809L || defined(_NETBSD_SOURCE)
229 #  ifndef __LOCALE_T_DECLARED
230 typedef struct _locale		*locale_t;
231 #  define __LOCALE_T_DECLARED
232 #  endif
233 __BEGIN_DECLS
234 size_t	mbsnrtowcs(wchar_t * __restrict, const char ** __restrict, size_t,
235 	    size_t, mbstate_t * __restrict);
236 size_t	wcsnrtombs(char * __restrict, const wchar_t ** __restrict, size_t,
237 	    size_t, mbstate_t * __restrict);
238 
239 int	wcscoll_l(const wchar_t *, const wchar_t *, locale_t);
240 size_t	wcsxfrm_l(wchar_t *, const wchar_t *, size_t, locale_t);
241 int wcsncasecmp_l(const wchar_t *, const wchar_t *, size_t, locale_t);
242 int wcscasecmp_l(const wchar_t *, const wchar_t *, locale_t);
243 
244 size_t	wcsftime_l(wchar_t * __restrict, size_t, const wchar_t * __restrict,
245 	    const struct tm * __restrict, locale_t);
246 
247 float wcstof_l(const wchar_t * __restrict, wchar_t ** __restrict, locale_t);
248 double wcstod_l(const wchar_t * __restrict, wchar_t ** __restrict, locale_t);
249 long double wcstold_l(const wchar_t * __restrict, wchar_t ** __restrict,
250     locale_t);
251 long int wcstol_l(const wchar_t * __restrict, wchar_t ** __restrict, int,
252 		  locale_t);
253 unsigned long int wcstoul_l(const wchar_t * __restrict,
254 	wchar_t ** __restrict, int, locale_t);
255 /* LONGLONG */
256 long long int wcstoll_l(const wchar_t * __restrict, wchar_t ** __restrict, int,
257 			locale_t);
258 /* LONGLONG */
259 unsigned long long int wcstoull_l(const wchar_t * __restrict,
260 				  wchar_t ** __restrict, int, locale_t);
261 int	wcwidth_l(wchar_t, locale_t);
262 int	wcswidth_l(const wchar_t *, size_t, locale_t);
263 __END_DECLS
264 #endif /* _POSIX_C_SOURCE || _NETBSD_SOURCE */
265 
266 #if defined(_NETBSD_SOURCE)
267 __BEGIN_DECLS
268 wint_t	btowc_l(int, locale_t);
269 size_t	mbrlen_l(const char * __restrict, size_t, mbstate_t * __restrict,
270 		locale_t);
271 size_t	mbrtowc_l(wchar_t * __restrict, const char * __restrict, size_t,
272 	    mbstate_t * __restrict, locale_t);
273 int	mbsinit_l(const mbstate_t *, locale_t);
274 size_t	mbsrtowcs_l(wchar_t * __restrict, const char ** __restrict, size_t,
275 	    mbstate_t * __restrict, locale_t);
276 size_t	mbsnrtowcs_l(wchar_t * __restrict, const char ** __restrict, size_t,
277 	    size_t, mbstate_t * __restrict, locale_t);
278 size_t	wcrtomb_l(char * __restrict, wchar_t, mbstate_t * __restrict, locale_t);
279 size_t	wcsrtombs_l(char * __restrict, const wchar_t ** __restrict, size_t,
280 	    mbstate_t * __restrict, locale_t);
281 size_t	wcsnrtombs_l(char * __restrict, const wchar_t ** __restrict, size_t,
282 	    size_t, mbstate_t * __restrict, locale_t);
283 int	wctob_l(wint_t, locale_t);
284 
285 int fwprintf_l(FILE * __restrict, locale_t, const wchar_t * __restrict, ...);
286 int swprintf_l(wchar_t * __restrict, size_t n, locale_t,
287     const wchar_t * __restrict, ...);
288 int vfwprintf_l(FILE * __restrict, locale_t,
289     const wchar_t * __restrict, __va_list);
290 int vswprintf_l(wchar_t * __restrict, size_t, locale_t,
291     const wchar_t * __restrict, __va_list);
292 int vwprintf_l(locale_t, const wchar_t * __restrict, __va_list);
293 int wprintf_l(locale_t, const wchar_t * __restrict, ...);
294 
295 int fwscanf_l(FILE * __restrict, locale_t, const wchar_t * __restrict, ...);
296 int swscanf_l(const wchar_t * __restrict, locale_t, const wchar_t *
297     __restrict, ...);
298 int wscanf_l(locale_t, const wchar_t * __restrict, ...);
299 int vfwscanf_l(FILE * __restrict, locale_t, const wchar_t * __restrict,
300     __va_list);
301 int vswscanf_l(const wchar_t * __restrict, locale_t, const wchar_t * __restrict,
302     __va_list);
303 int vwscanf_l(locale_t, const wchar_t * __restrict, __va_list);
304 __END_DECLS
305 #endif /* _NETBSD_SOURCE */
306 
307 #endif /* !_WCHAR_H_ */
308