toeplitz: Add comment.
[dragonfly.git] / include / wchar.h
blob550a5ca1cc1699056ee77476e4a38beb80511fd8
1 /*-
2 * Copyright (c)1999 Citrus Project,
3 * All rights reserved.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24 * SUCH DAMAGE.
26 * $FreeBSD: head/include/wchar.h 247411 2013-02-27 19:50:46Z jhb $
29 /*-
30 * Copyright (c) 1999, 2000 The NetBSD Foundation, Inc.
31 * All rights reserved.
33 * This code is derived from software contributed to The NetBSD Foundation
34 * by Julian Coleman.
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.
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.
57 * $NetBSD: wchar.h,v 1.8 2000/12/22 05:31:42 itojun Exp $
60 #ifndef _WCHAR_H_
61 #define _WCHAR_H_
63 #include <sys/cdefs.h>
64 #include <sys/_null.h>
65 #include <sys/types.h>
66 #include <machine/limits.h>
67 #include <machine/stdarg.h> /* for __va_list */
68 #include <ctype.h>
70 #if __POSIX_VISIBLE >= 200809 || __XSI_VISIBLE
71 #ifndef _VA_LIST_DECLARED
72 #define _VA_LIST_DECLARED
73 #ifdef va_start
74 /* prevent gcc from fixing this header */
75 #endif
76 typedef __va_list va_list;
77 #endif
78 #endif
80 #ifndef __cplusplus
81 #ifndef _WCHAR_T_DECLARED
82 #define _WCHAR_T_DECLARED
83 typedef __wchar_t wchar_t;
84 #endif
85 #endif
87 #ifndef WCHAR_MIN
88 #define WCHAR_MIN INT_MIN
89 #endif
91 #ifndef WCHAR_MAX
92 #define WCHAR_MAX INT_MAX
93 #endif
95 #ifndef _WINT_T_DECLARED
96 #define _WINT_T_DECLARED
97 typedef __wint_t wint_t;
98 #endif
100 #ifndef _MBSTATE_T_DECLARED
101 #define _MBSTATE_T_DECLARED
102 typedef __mbstate_t mbstate_t;
103 #endif
105 #ifndef _SIZE_T_DECLARED
106 #define _SIZE_T_DECLARED
107 typedef __size_t size_t;
108 #endif
110 #ifndef WEOF
111 #define WEOF ((wint_t)(-1))
112 #endif
114 #if __BSD_VISIBLE
115 #define WCSBIN_EOF 0x01 /* indicate input buffer EOF */
116 #define WCSBIN_SURRO 0x02 /* allow surrogates */
117 #define WCSBIN_LONGCODES 0x04 /* allow up to 31-bit WCs */
118 #define WCSBIN_STRICT 0x08 /* no escaping, else escapes happen */
119 #endif
121 #ifndef _STDFILE_DECLARED
122 #define _STDFILE_DECLARED
123 typedef struct __FILE FILE;
124 #endif
126 struct tm;
128 __BEGIN_DECLS
129 wint_t btowc(int);
130 wint_t fgetwc(FILE *);
131 wchar_t *
132 fgetws(wchar_t * __restrict, int, FILE * __restrict);
133 wint_t fputwc(wchar_t, FILE *);
134 int fputws(const wchar_t * __restrict, FILE * __restrict);
135 int fwide(FILE *, int);
136 int fwprintf(FILE * __restrict, const wchar_t * __restrict, ...);
137 int fwscanf(FILE * __restrict, const wchar_t * __restrict, ...);
138 wint_t getwc(FILE *);
139 wint_t getwchar(void);
140 size_t mbrlen(const char * __restrict, size_t, mbstate_t * __restrict);
141 size_t mbrtowc(wchar_t * __restrict, const char * __restrict, size_t,
142 mbstate_t * __restrict);
143 int mbsinit(const mbstate_t *);
144 size_t mbsrtowcs(wchar_t * __restrict, const char ** __restrict, size_t,
145 mbstate_t * __restrict);
146 #if __BSD_VISIBLE
147 size_t mbintowcr(wchar_t * __restrict dst, const char * __restrict src,
148 size_t dlen, size_t *slen, int flags);
149 #endif
150 wint_t putwc(wchar_t, FILE *);
151 wint_t putwchar(wchar_t);
152 int swprintf(wchar_t * __restrict, size_t n, const wchar_t * __restrict,
153 ...);
154 int swscanf(const wchar_t * __restrict, const wchar_t * __restrict, ...);
155 wint_t ungetwc(wint_t, FILE *);
156 int vfwprintf(FILE * __restrict, const wchar_t * __restrict,
157 __va_list);
158 int vswprintf(wchar_t * __restrict, size_t n, const wchar_t * __restrict,
159 __va_list);
160 int vwprintf(const wchar_t * __restrict, __va_list);
161 size_t wcrtomb(char * __restrict, wchar_t, mbstate_t * __restrict);
162 #if __BSD_VISIBLE
163 size_t wcrtombin(char * __restrict dst, const wchar_t * __restrict src,
164 size_t dlen, size_t *slen, int flags);
165 #endif
166 wchar_t *wcscat(wchar_t * __restrict, const wchar_t * __restrict);
167 wchar_t *wcschr(const wchar_t *, wchar_t) __pure;
168 int wcscmp(const wchar_t *, const wchar_t *) __pure;
169 int wcscoll(const wchar_t *, const wchar_t *);
170 wchar_t *wcscpy(wchar_t * __restrict, const wchar_t * __restrict);
171 size_t wcscspn(const wchar_t *, const wchar_t *) __pure;
172 size_t wcsftime(wchar_t * __restrict, size_t, const wchar_t * __restrict,
173 const struct tm * __restrict);
174 size_t wcslen(const wchar_t *) __pure;
175 wchar_t *wcsncat(wchar_t * __restrict, const wchar_t * __restrict,
176 size_t);
177 int wcsncmp(const wchar_t *, const wchar_t *, size_t) __pure;
178 wchar_t *wcsncpy(wchar_t * __restrict , const wchar_t * __restrict, size_t);
179 wchar_t *wcspbrk(const wchar_t *, const wchar_t *) __pure;
180 wchar_t *wcsrchr(const wchar_t *, wchar_t) __pure;
181 size_t wcsrtombs(char * __restrict, const wchar_t ** __restrict, size_t,
182 mbstate_t * __restrict);
183 size_t wcsspn(const wchar_t *, const wchar_t *) __pure;
184 wchar_t *wcsstr(const wchar_t * __restrict, const wchar_t * __restrict)
185 __pure;
186 size_t wcsxfrm(wchar_t * __restrict, const wchar_t * __restrict, size_t);
187 int wctob(wint_t);
188 double wcstod(const wchar_t * __restrict, wchar_t ** __restrict);
189 wchar_t *wcstok(wchar_t * __restrict, const wchar_t * __restrict,
190 wchar_t ** __restrict);
191 long wcstol(const wchar_t * __restrict, wchar_t ** __restrict, int);
192 unsigned long
193 wcstoul(const wchar_t * __restrict, wchar_t ** __restrict, int);
194 wchar_t *wmemchr(const wchar_t *, wchar_t, size_t) __pure;
195 int wmemcmp(const wchar_t *, const wchar_t *, size_t) __pure;
196 wchar_t *wmemcpy(wchar_t * __restrict, const wchar_t * __restrict, size_t);
197 wchar_t *wmemmove(wchar_t *, const wchar_t *, size_t);
198 wchar_t *wmemset(wchar_t *, wchar_t, size_t);
199 int wprintf(const wchar_t * __restrict, ...);
200 int wscanf(const wchar_t * __restrict, ...);
202 #if __BSD_VISIBLE
203 size_t utf8towcr(wchar_t * __restrict dst, const char * __restrict src,
204 size_t dlen, size_t *slen, int flags);
205 size_t wcrtoutf8(char * __restrict dst, const wchar_t * __restrict src,
206 size_t dlen, size_t *slen, int flags);
207 #endif
209 #ifndef _STDSTREAM_DECLARED
210 extern FILE *__stdinp;
211 extern FILE *__stdoutp;
212 extern FILE *__stderrp;
213 #define _STDSTREAM_DECLARED
214 #endif
216 #define getwc(fp) fgetwc(fp)
217 #define getwchar() fgetwc(__stdinp)
218 #define putwc(wc, fp) fputwc(wc, fp)
219 #define putwchar(wc) fputwc(wc, __stdoutp)
221 #if __ISO_C_VISIBLE >= 1999
222 int vfwscanf(FILE * __restrict, const wchar_t * __restrict,
223 __va_list);
224 int vswscanf(const wchar_t * __restrict, const wchar_t * __restrict,
225 __va_list);
226 int vwscanf(const wchar_t * __restrict, __va_list);
227 float wcstof(const wchar_t * __restrict, wchar_t ** __restrict);
228 long double
229 wcstold(const wchar_t * __restrict, wchar_t ** __restrict);
230 #ifdef __LONG_LONG_SUPPORTED
231 /* LONGLONG */
232 long long
233 wcstoll(const wchar_t * __restrict, wchar_t ** __restrict, int);
234 /* LONGLONG */
235 unsigned long long
236 wcstoull(const wchar_t * __restrict, wchar_t ** __restrict, int);
237 #endif
238 #endif /* __ISO_C_VISIBLE >= 1999 */
240 #if __XSI_VISIBLE
241 int wcswidth(const wchar_t *, size_t);
242 int wcwidth(wchar_t);
243 #define wcwidth(_c) __wcwidth(_c)
244 #endif
246 #if __POSIX_VISIBLE >= 200809
247 size_t mbsnrtowcs(wchar_t * __restrict, const char ** __restrict, size_t,
248 size_t, mbstate_t * __restrict);
249 FILE *open_wmemstream(wchar_t **, size_t *);
250 wchar_t *wcpcpy(wchar_t * __restrict, const wchar_t * __restrict);
251 wchar_t *wcpncpy(wchar_t * __restrict, const wchar_t * __restrict, size_t);
252 wchar_t *wcsdup(const wchar_t *) __malloclike;
253 int wcscasecmp(const wchar_t *, const wchar_t *);
254 int wcsncasecmp(const wchar_t *, const wchar_t *, size_t n);
255 size_t wcsnlen(const wchar_t *, size_t) __pure;
256 size_t wcsnrtombs(char * __restrict, const wchar_t ** __restrict, size_t,
257 size_t, mbstate_t * __restrict);
258 #endif
260 #if __BSD_VISIBLE
261 wchar_t *fgetwln(FILE * __restrict, size_t * __restrict);
262 size_t wcslcat(wchar_t *, const wchar_t *, size_t);
263 size_t wcslcpy(wchar_t *, const wchar_t *, size_t);
264 #endif
266 #if __POSIX_VISIBLE >= 200809 || defined(_XLOCALE_H_)
267 #include <xlocale/_wchar.h>
268 #endif
269 __END_DECLS
271 #endif /* !_WCHAR_H_ */