xref: /openbsd-src/include/wchar.h (revision f2da64fbbbf1b03f09f390ab01267c93dfd77c4c)
1 /*	$OpenBSD: wchar.h,v 1.30 2016/09/09 18:12:37 millert Exp $	*/
2 /*	$NetBSD: wchar.h,v 1.16 2003/03/07 07:11:35 tshiozak Exp $	*/
3 
4 /*-
5  * Copyright (c)1999 Citrus Project,
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27  * SUCH DAMAGE.
28  */
29 
30 /*-
31  * Copyright (c) 1999, 2000 The NetBSD Foundation, Inc.
32  * All rights reserved.
33  *
34  * This code is derived from software contributed to The NetBSD Foundation
35  * by Julian Coleman.
36  *
37  * Redistribution and use in source and binary forms, with or without
38  * modification, are permitted provided that the following conditions
39  * are met:
40  * 1. Redistributions of source code must retain the above copyright
41  *    notice, this list of conditions and the following disclaimer.
42  * 2. Redistributions in binary form must reproduce the above copyright
43  *    notice, this list of conditions and the following disclaimer in the
44  *    documentation and/or other materials provided with the distribution.
45  *
46  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
47  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
48  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
49  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
50  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
51  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
52  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
53  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
54  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
55  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
56  * POSSIBILITY OF SUCH DAMAGE.
57  */
58 
59 #ifndef _WCHAR_H_
60 #define _WCHAR_H_
61 
62 #include <sys/cdefs.h>
63 #include <sys/_null.h>
64 #include <sys/_types.h>
65 
66 #include <stdio.h> /* for FILE* */
67 
68 #if !defined(_WCHAR_T_DEFINED_) && !defined(__cplusplus)
69 #define _WCHAR_T_DEFINED_
70 typedef	__wchar_t	wchar_t;
71 #endif
72 
73 #ifndef	_MBSTATE_T_DEFINED_
74 #define	_MBSTATE_T_DEFINED_
75 typedef	__mbstate_t	mbstate_t;
76 #endif
77 
78 #ifndef	_WINT_T_DEFINED_
79 #define	_WINT_T_DEFINED_
80 typedef	__wint_t	wint_t;
81 #endif
82 
83 #ifndef	_SIZE_T_DEFINED_
84 #define	_SIZE_T_DEFINED_
85 typedef	__size_t	size_t;
86 #endif
87 
88 #ifndef	WEOF
89 #define	WEOF 	((wint_t)-1)
90 #endif
91 
92 #ifndef	WCHAR_MIN
93 #define	WCHAR_MIN	(-0x7fffffff - 1)
94 #endif
95 #ifndef	WCHAR_MAX
96 #define	WCHAR_MAX	0x7fffffff
97 #endif
98 
99 __BEGIN_DECLS
100 wint_t	btowc(int);
101 size_t	mbrlen(const char * __restrict, size_t, mbstate_t * __restrict);
102 size_t	mbrtowc(wchar_t * __restrict, const char * __restrict, size_t,
103 	    mbstate_t * __restrict);
104 int	mbsinit(const mbstate_t *);
105 size_t	mbsrtowcs(wchar_t * __restrict, const char ** __restrict, size_t,
106 	    mbstate_t * __restrict)
107 		__attribute__ ((__bounded__(__wcstring__,1,3)));
108 size_t	wcrtomb(char * __restrict, wchar_t, mbstate_t * __restrict);
109 wchar_t	*wcscat(wchar_t * __restrict, const wchar_t * __restrict);
110 wchar_t	*wcschr(const wchar_t *, wchar_t);
111 int	wcscmp(const wchar_t *, const wchar_t *);
112 int	wcscoll(const wchar_t *, const wchar_t *);
113 wchar_t	*wcscpy(wchar_t * __restrict, const wchar_t * __restrict);
114 size_t	wcscspn(const wchar_t *, const wchar_t *);
115 size_t	wcslen(const wchar_t *);
116 wchar_t	*wcsncat(wchar_t * __restrict, const wchar_t * __restrict,
117 	    size_t)
118 		__attribute__ ((__bounded__(__wcstring__,1,3)));
119 int	wcsncmp(const wchar_t *, const wchar_t *, size_t);
120 wchar_t	*wcsncpy(wchar_t * __restrict , const wchar_t * __restrict,
121 	    size_t)
122 		__attribute__ ((__bounded__(__wcstring__,1,3)));
123 wchar_t	*wcspbrk(const wchar_t *, const wchar_t *);
124 wchar_t	*wcsrchr(const wchar_t *, wchar_t);
125 size_t	wcsrtombs(char * __restrict, const wchar_t ** __restrict, size_t,
126 	    mbstate_t * __restrict)
127 		__attribute__ ((__bounded__(__wcstring__,1,3)));
128 size_t	wcsspn(const wchar_t *, const wchar_t *);
129 wchar_t	*wcsstr(const wchar_t *, const wchar_t *);
130 wchar_t *wcstok(wchar_t * __restrict, const wchar_t * __restrict,
131 		     wchar_t ** __restrict);
132 size_t	wcsxfrm(wchar_t *, const wchar_t *, size_t);
133 wchar_t	*wcswcs(const wchar_t *, const wchar_t *);
134 wchar_t	*wmemchr(const wchar_t *, wchar_t, size_t);
135 int	wmemcmp(const wchar_t *, const wchar_t *, size_t);
136 wchar_t	*wmemcpy(wchar_t * __restrict, const wchar_t * __restrict,
137 	    size_t)
138 		__attribute__ ((__bounded__(__wcstring__,1,3)))
139 		__attribute__ ((__bounded__(__wcstring__,2,3)));
140 wchar_t	*wmemmove(wchar_t *, const wchar_t *, size_t)
141 		__attribute__ ((__bounded__(__wcstring__,1,3)))
142 		__attribute__ ((__bounded__(__wcstring__,2,3)));
143 wchar_t	*wmemset(wchar_t *, wchar_t, size_t)
144 		__attribute__ ((__bounded__(__wcstring__,1,3)));
145 
146 int	wcswidth(const wchar_t *, size_t);
147 int	wctob(wint_t);
148 int	wcwidth(wchar_t);
149 
150 double wcstod(const wchar_t * __restrict, wchar_t ** __restrict);
151 long int wcstol(const wchar_t * __restrict, wchar_t ** __restrict, int base);
152 unsigned long int wcstoul(const wchar_t * __restrict, wchar_t ** __restrict,
153 		int base);
154 
155 #if __POSIX_VISIBLE >= 200809
156 FILE *open_wmemstream(wchar_t **, size_t *);
157 
158 wchar_t	*wcsdup(const wchar_t *);
159 int wcscasecmp(const wchar_t *, const wchar_t *);
160 int wcsncasecmp(const wchar_t *, const wchar_t *, size_t);
161 
162 size_t mbsnrtowcs(wchar_t * __restrict, const char ** __restrict, size_t,
163     size_t, mbstate_t * __restrict)
164 		__attribute__ ((__bounded__(__wcstring__,1,4)));
165 size_t wcsnrtombs(char * __restrict, const wchar_t ** __restrict, size_t,
166     size_t, mbstate_t * __restrict)
167 		__attribute__ ((__bounded__(__wcstring__,1,4)));
168 #endif
169 
170 #if __ISO_C_VISIBLE >= 1999
171 float	wcstof(const wchar_t * __restrict, wchar_t ** __restrict);
172 long double wcstold(const wchar_t * __restrict, wchar_t ** __restrict);
173 
174 struct tm;
175 size_t wcsftime(wchar_t * __restrict, size_t, const wchar_t *__restrict,
176 	const struct tm *__restrict);
177 #endif
178 
179 #if !defined(__STRICT_ANSI__) || __ISO_C_VISIBLE >= 1999
180 long long int wcstoll(const wchar_t * __restrict,
181 	wchar_t ** __restrict, int base);
182 unsigned long long int wcstoull(const wchar_t * __restrict,
183 	wchar_t ** __restrict, int base);
184 #endif
185 
186 wint_t ungetwc(wint_t, FILE *);
187 wint_t fgetwc(FILE *);
188 wchar_t *fgetws(wchar_t * __restrict, int, FILE * __restrict)
189 		__attribute__ ((__bounded__(__wcstring__,1,2)));
190 wint_t getwc(FILE *);
191 wint_t getwchar(void);
192 wint_t fputwc(wchar_t, FILE *);
193 int fputws(const wchar_t * __restrict, FILE * __restrict);
194 wint_t putwc(wchar_t, FILE *);
195 wint_t putwchar(wchar_t);
196 
197 int fwide(FILE *, int);
198 
199 int fwprintf(FILE * __restrict, const wchar_t * __restrict, ...);
200 int swprintf(wchar_t * __restrict, size_t, const wchar_t * __restrict, ...);
201 int vfwprintf(FILE * __restrict, const wchar_t * __restrict, __va_list);
202 int vswprintf(wchar_t * __restrict, size_t, const wchar_t * __restrict,
203 	__va_list);
204 int vwprintf(const wchar_t * __restrict, __va_list);
205 int wprintf(const wchar_t * __restrict, ...);
206 
207 int fwscanf(FILE * __restrict, const wchar_t * __restrict, ...);
208 int swscanf(const wchar_t * __restrict, const wchar_t * __restrict, ...);
209 int vfwscanf(FILE * __restrict, const wchar_t * __restrict, __va_list);
210 int vswscanf(const wchar_t * __restrict, const wchar_t * __restrict, __va_list);
211 int vwscanf(const wchar_t * __restrict, __va_list);
212 int wscanf(const wchar_t * __restrict, ...);
213 
214 #if __BSD_VISIBLE
215 wchar_t *fgetwln(FILE * __restrict, size_t * __restrict);
216 size_t	wcslcat(wchar_t *, const wchar_t *, size_t)
217 		__attribute__ ((__bounded__(__wcstring__,1,3)));
218 size_t	wcslcpy(wchar_t *, const wchar_t *, size_t)
219 		__attribute__ ((__bounded__(__wcstring__,1,3)));
220 #endif
221 
222 #define getwc(f) fgetwc(f)
223 #define getwchar() getwc(stdin)
224 #define putwc(wc, f) fputwc((wc), (f))
225 #define putwchar(wc) putwc((wc), stdout)
226 __END_DECLS
227 
228 #endif /* !_WCHAR_H_ */
229