<stdio.h>/<wchar.h>: Reduce namespace pollution in <wchar.h>.
[dragonfly.git] / include / wchar.h
1 /*-
2  * Copyright (c)1999 Citrus Project,
3  * All rights reserved.
4  *
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.
13  *
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.
25  *
26  * $FreeBSD: head/include/wchar.h 247411 2013-02-27 19:50:46Z jhb $
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  *      $NetBSD: wchar.h,v 1.8 2000/12/22 05:31:42 itojun Exp $
58  */
59
60 #ifndef _WCHAR_H_
61 #define _WCHAR_H_
62
63 #include <sys/_null.h>
64 #include <sys/types.h>
65 #include <machine/limits.h>
66 #include <ctype.h>
67
68 #ifndef __cplusplus
69 #ifndef _WCHAR_T_DECLARED
70 #define _WCHAR_T_DECLARED
71 typedef __wchar_t       wchar_t;
72 #endif
73 #endif
74
75 #ifndef WCHAR_MIN
76 #define WCHAR_MIN       INT_MIN
77 #endif
78
79 #ifndef WCHAR_MAX
80 #define WCHAR_MAX       INT_MAX
81 #endif
82
83 #ifndef _WINT_T_DECLARED
84 #define _WINT_T_DECLARED
85 typedef __wint_t        wint_t;
86 #endif
87
88 #ifndef _MBSTATE_T_DECLARED
89 #define _MBSTATE_T_DECLARED
90 typedef __mbstate_t     mbstate_t;
91 #endif
92
93 #ifndef _SIZE_T_DECLARED
94 #define _SIZE_T_DECLARED
95 typedef __size_t        size_t;
96 #endif
97
98 #ifndef _STDFILE_DECLARED
99 #define _STDFILE_DECLARED
100 typedef struct __FILE FILE;
101 #endif
102
103 #ifndef WEOF
104 #define WEOF    ((wint_t)(-1))
105 #endif
106
107 #define WCSBIN_EOF              0x01    /* indicate input buffer EOF */
108 #define WCSBIN_SURRO            0x02    /* allow surrogates */
109 #define WCSBIN_LONGCODES        0x04    /* allow up to 31-bit WCs */
110 #define WCSBIN_STRICT           0x08    /* no escaping, else escapes happen */
111
112 struct tm;
113
114 __BEGIN_DECLS
115 wint_t  btowc(int);
116 wint_t  fgetwc(FILE *);
117 wchar_t *
118         fgetws(wchar_t * __restrict, int, FILE * __restrict);
119 wint_t  fputwc(wchar_t, FILE *);
120 int     fputws(const wchar_t * __restrict, FILE * __restrict);
121 int     fwide(FILE *, int);
122 int     fwprintf(FILE * __restrict, const wchar_t * __restrict, ...);
123 int     fwscanf(FILE * __restrict, const wchar_t * __restrict, ...);
124 wint_t  getwc(FILE *);
125 wint_t  getwchar(void);
126 size_t  mbrlen(const char * __restrict, size_t, mbstate_t * __restrict);
127 size_t  mbrtowc(wchar_t * __restrict, const char * __restrict, size_t,
128             mbstate_t * __restrict);
129 int     mbsinit(const mbstate_t *);
130 size_t  mbsrtowcs(wchar_t * __restrict, const char ** __restrict, size_t,
131             mbstate_t * __restrict);
132 size_t  mbintowcr(wchar_t * __restrict dst, const char * __restrict src,
133             size_t dlen, size_t *slen, int flags);
134 wint_t  putwc(wchar_t, FILE *);
135 wint_t  putwchar(wchar_t);
136 int     swprintf(wchar_t * __restrict, size_t n, const wchar_t * __restrict,
137             ...);
138 int     swscanf(const wchar_t * __restrict, const wchar_t * __restrict, ...);
139 wint_t  ungetwc(wint_t, FILE *);
140 int     vfwprintf(FILE * __restrict, const wchar_t * __restrict,
141             __va_list);
142 int     vswprintf(wchar_t * __restrict, size_t n, const wchar_t * __restrict,
143             __va_list);
144 int     vwprintf(const wchar_t * __restrict, __va_list);
145 size_t  wcrtomb(char * __restrict, wchar_t, mbstate_t * __restrict);
146 size_t  wcrtombin(char * __restrict dst, const wchar_t * __restrict src,
147             size_t dlen, size_t *slen, int flags);
148 wchar_t *wcscat(wchar_t * __restrict, const wchar_t * __restrict);
149 wchar_t *wcschr(const wchar_t *, wchar_t) __pure;
150 int     wcscmp(const wchar_t *, const wchar_t *) __pure;
151 int     wcscoll(const wchar_t *, const wchar_t *);
152 wchar_t *wcscpy(wchar_t * __restrict, const wchar_t * __restrict);
153 size_t  wcscspn(const wchar_t *, const wchar_t *) __pure;
154 size_t  wcsftime(wchar_t * __restrict, size_t, const wchar_t * __restrict,
155             const struct tm * __restrict);
156 size_t  wcslen(const wchar_t *) __pure;
157 wchar_t *wcsncat(wchar_t * __restrict, const wchar_t * __restrict,
158             size_t);
159 int     wcsncmp(const wchar_t *, const wchar_t *, size_t) __pure;
160 wchar_t *wcsncpy(wchar_t * __restrict , const wchar_t * __restrict, size_t);
161 wchar_t *wcspbrk(const wchar_t *, const wchar_t *) __pure;
162 wchar_t *wcsrchr(const wchar_t *, wchar_t) __pure;
163 size_t  wcsrtombs(char * __restrict, const wchar_t ** __restrict, size_t,
164             mbstate_t * __restrict);
165 size_t  wcsspn(const wchar_t *, const wchar_t *) __pure;
166 wchar_t *wcsstr(const wchar_t * __restrict, const wchar_t * __restrict)
167             __pure;
168 size_t  wcsxfrm(wchar_t * __restrict, const wchar_t * __restrict, size_t);
169 int     wctob(wint_t);
170 double  wcstod(const wchar_t * __restrict, wchar_t ** __restrict);
171 wchar_t *wcstok(wchar_t * __restrict, const wchar_t * __restrict,
172             wchar_t ** __restrict);
173 long     wcstol(const wchar_t * __restrict, wchar_t ** __restrict, int);
174 unsigned long
175          wcstoul(const wchar_t * __restrict, wchar_t ** __restrict, int);
176 wchar_t *wmemchr(const wchar_t *, wchar_t, size_t) __pure;
177 int     wmemcmp(const wchar_t *, const wchar_t *, size_t) __pure;
178 wchar_t *wmemcpy(wchar_t * __restrict, const wchar_t * __restrict, size_t);
179 wchar_t *wmemmove(wchar_t *, const wchar_t *, size_t);
180 wchar_t *wmemset(wchar_t *, wchar_t, size_t);
181 int     wprintf(const wchar_t * __restrict, ...);
182 int     wscanf(const wchar_t * __restrict, ...);
183
184 size_t  utf8towcr(wchar_t * __restrict dst, const char * __restrict src,
185             size_t dlen, size_t *slen, int flags);
186 size_t  wcrtoutf8(char * __restrict dst, const wchar_t * __restrict src,
187             size_t dlen, size_t *slen, int flags);
188
189 #ifndef _STDSTREAM_DECLARED
190 extern FILE *__stdinp;
191 extern FILE *__stdoutp;
192 extern FILE *__stderrp;
193 #define _STDSTREAM_DECLARED
194 #endif
195
196 #define getwc(fp)       fgetwc(fp)
197 #define getwchar()      fgetwc(__stdinp)
198 #define putwc(wc, fp)   fputwc(wc, fp)
199 #define putwchar(wc)    fputwc(wc, __stdoutp)
200
201 #if __ISO_C_VISIBLE >= 1999
202 int     vfwscanf(FILE * __restrict, const wchar_t * __restrict,
203             __va_list);
204 int     vswscanf(const wchar_t * __restrict, const wchar_t * __restrict,
205             __va_list);
206 int     vwscanf(const wchar_t * __restrict, __va_list);
207 float   wcstof(const wchar_t * __restrict, wchar_t ** __restrict);
208 long double
209         wcstold(const wchar_t * __restrict, wchar_t ** __restrict);
210 #ifdef __LONG_LONG_SUPPORTED
211 /* LONGLONG */
212 long long
213         wcstoll(const wchar_t * __restrict, wchar_t ** __restrict, int);
214 /* LONGLONG */
215 unsigned long long
216          wcstoull(const wchar_t * __restrict, wchar_t ** __restrict, int);
217 #endif
218 #endif  /* __ISO_C_VISIBLE >= 1999 */
219
220 #if __XSI_VISIBLE
221 int     wcswidth(const wchar_t *, size_t);
222 int     wcwidth(wchar_t);
223 #define wcwidth(_c)     __wcwidth(_c)
224 #endif
225
226 #if __POSIX_VISIBLE >= 200809
227 size_t  mbsnrtowcs(wchar_t * __restrict, const char ** __restrict, size_t,
228             size_t, mbstate_t * __restrict);
229 FILE    *open_wmemstream(wchar_t **, size_t *);
230 wchar_t *wcpcpy(wchar_t * __restrict, const wchar_t * __restrict);
231 wchar_t *wcpncpy(wchar_t * __restrict, const wchar_t * __restrict, size_t);
232 wchar_t *wcsdup(const wchar_t *);
233 int     wcscasecmp(const wchar_t *, const wchar_t *);
234 int     wcsncasecmp(const wchar_t *, const wchar_t *, size_t n);
235 size_t  wcsnlen(const wchar_t *, size_t) __pure;
236 size_t  wcsnrtombs(char * __restrict, const wchar_t ** __restrict, size_t,
237             size_t, mbstate_t * __restrict);
238 #endif
239
240 #if __BSD_VISIBLE
241 wchar_t *fgetwln(FILE * __restrict, size_t * __restrict);
242 size_t  wcslcat(wchar_t *, const wchar_t *, size_t);
243 size_t  wcslcpy(wchar_t *, const wchar_t *, size_t);
244 #endif
245
246 #if __POSIX_VISIBLE >= 200809 || defined(_XLOCALE_H_)
247 #include <xlocale/_wchar.h>
248 #endif
249 __END_DECLS
250
251 #endif /* !_WCHAR_H_ */