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