Work around a btowc() bug on IRIX 6.5.
[gnulib.git] / lib / wchar.in.h
1 /* A substitute for ISO C99 <wchar.h>, for platforms that have issues.
2
3    Copyright (C) 2007-2008 Free Software Foundation, Inc.
4
5    This program is free software; you can redistribute it and/or modify
6    it under the terms of the GNU General Public License as published by
7    the Free Software Foundation; either version 2, or (at your option)
8    any later version.
9
10    This program is distributed in the hope that it will be useful,
11    but WITHOUT ANY WARRANTY; without even the implied warranty of
12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13    GNU General Public License for more details.
14
15    You should have received a copy of the GNU General Public License
16    along with this program; if not, write to the Free Software Foundation,
17    Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.  */
18
19 /* Written by Eric Blake.  */
20
21 /*
22  * ISO C 99 <wchar.h> for platforms that have issues.
23  * <http://www.opengroup.org/susv3xbd/wchar.h.html>
24  *
25  * For now, this just ensures proper prerequisite inclusion order and
26  * the declaration of wcwidth().
27  */
28
29 #if __GNUC__ >= 3
30 @PRAGMA_SYSTEM_HEADER@
31 #endif
32
33 #ifdef __need_mbstate_t
34 /* Special invocation convention inside uClibc header files.  */
35
36 #@INCLUDE_NEXT@ @NEXT_WCHAR_H@
37
38 #else
39 /* Normal invocation convention.  */
40
41 #ifndef _GL_WCHAR_H
42
43 /* Tru64 with Desktop Toolkit C has a bug: <stdio.h> must be included before
44    <wchar.h>.
45    BSD/OS 4.0.1 has a bug: <stddef.h>, <stdio.h> and <time.h> must be
46    included before <wchar.h>.  */
47 #include <stddef.h>
48 #include <stdio.h>
49 #include <time.h>
50
51 /* Include the original <wchar.h> if it exists.
52    Some builds of uClibc lack it.  */
53 /* The include_next requires a split double-inclusion guard.  */
54 #if @HAVE_WCHAR_H@
55 # @INCLUDE_NEXT@ @NEXT_WCHAR_H@
56 #endif
57
58 #ifndef _GL_WCHAR_H
59 #define _GL_WCHAR_H
60
61 /* The definition of GL_LINK_WARNING is copied here.  */
62
63 #ifdef __cplusplus
64 extern "C" {
65 #endif
66
67
68 /* Define wint_t.  (Also done in wctype.in.h.)  */
69 #if !@HAVE_WINT_T@ && !defined wint_t
70 # define wint_t int
71 #endif
72
73
74 /* Override mbstate_t if it is too small.
75    On IRIX 6.5, sizeof (mbstate_t) == 1, which is not sufficient for
76    implementing mbrtowc for encodings like UTF-8.  */
77 #if !(@HAVE_MBSINIT@ && @HAVE_MBRTOWC@) || @REPLACE_MBSTATE_T@
78 typedef int rpl_mbstate_t;
79 # undef mbstate_t
80 # define mbstate_t rpl_mbstate_t
81 # define GNULIB_defined_mbstate_t 1
82 #endif
83
84
85 /* Convert a single-byte character to a wide character.  */
86 #if @GNULIB_BTOWC@
87 # if @REPLACE_BTOWC@
88 #  undef btowc
89 #  define btowc rpl_btowc
90 # endif
91 # if !@HAVE_BTOWC@ || @REPLACE_BTOWC@
92 extern wint_t btowc (int c);
93 # endif
94 #elif defined GNULIB_POSIXCHECK
95 # undef btowc
96 # define btowc(c) \
97     (GL_LINK_WARNING ("btowc is unportable - " \
98                       "use gnulib module btowc for portability"), \
99      btowc (c))
100 #endif
101
102
103 /* Convert a wide character to a single-byte character.  */
104 #if @GNULIB_WCTOB@
105 # if @REPLACE_WCTOB@
106 #  undef wctob
107 #  define wctob rpl_wctob
108 # endif
109 # if (!defined wctob && !@HAVE_DECL_WCTOB@) || @REPLACE_WCTOB@
110 /* wctob is provided by gnulib, or wctob exists but is not declared.  */
111 extern int wctob (wint_t wc);
112 # endif
113 #elif defined GNULIB_POSIXCHECK
114 # undef wctob
115 # define wctob(w) \
116     (GL_LINK_WARNING ("wctob is unportable - " \
117                       "use gnulib module wctob for portability"), \
118      wctob (w))
119 #endif
120
121
122 /* Test whether *PS is in the initial state.  */
123 #if @GNULIB_MBSINIT@
124 # if @REPLACE_MBSINIT@
125 #  undef mbsinit
126 #  define mbsinit rpl_mbsinit
127 # endif
128 # if !@HAVE_MBSINIT@ || @REPLACE_MBSINIT@
129 extern int mbsinit (const mbstate_t *ps);
130 # endif
131 #elif defined GNULIB_POSIXCHECK
132 # undef mbsinit
133 # define mbsinit(p) \
134     (GL_LINK_WARNING ("mbsinit is unportable - " \
135                       "use gnulib module mbsinit for portability"), \
136      mbsinit (p))
137 #endif
138
139
140 /* Convert a multibyte character to a wide character.  */
141 #if @GNULIB_MBRTOWC@
142 # if @REPLACE_MBRTOWC@
143 #  undef mbrtowc
144 #  define mbrtowc rpl_mbrtowc
145 # endif
146 # if !@HAVE_MBRTOWC@ || @REPLACE_MBRTOWC@
147 extern size_t mbrtowc (wchar_t *pwc, const char *s, size_t n, mbstate_t *ps);
148 # endif
149 #elif defined GNULIB_POSIXCHECK
150 # undef mbrtowc
151 # define mbrtowc(w,s,n,p) \
152     (GL_LINK_WARNING ("mbrtowc is unportable - " \
153                       "use gnulib module mbrtowc for portability"), \
154      mbrtowc (w, s, n, p))
155 #endif
156
157
158 /* Recognize a multibyte character.  */
159 #if @GNULIB_MBRLEN@
160 # if !@HAVE_MBRLEN@
161 extern size_t mbrlen (const char *s, size_t n, mbstate_t *ps);
162 # endif
163 #elif defined GNULIB_POSIXCHECK
164 # undef mbrlen
165 # define mbrlen(s,n,p) \
166     (GL_LINK_WARNING ("mbrlen is unportable - " \
167                       "use gnulib module mbrlen for portability"), \
168      mbrlen (s, n, p))
169 #endif
170
171
172 /* Convert a string to a wide string.  */
173 #if @GNULIB_MBSRTOWCS@
174 # if @REPLACE_MBSRTOWCS@
175 #  undef mbsrtowcs
176 #  define mbsrtowcs rpl_mbsrtowcs
177 # endif
178 # if !@HAVE_MBSRTOWCS@ || @REPLACE_MBSRTOWCS@
179 extern size_t mbsrtowcs (wchar_t *dest, const char **srcp, size_t len, mbstate_t *ps);
180 # endif
181 #elif defined GNULIB_POSIXCHECK
182 # undef mbsrtowcs
183 # define mbsrtowcs(d,s,l,p) \
184     (GL_LINK_WARNING ("mbsrtowcs is unportable - " \
185                       "use gnulib module mbsrtowcs for portability"), \
186      mbsrtowcs (d, s, l, p))
187 #endif
188
189
190 /* Convert a string to a wide string.  */
191 #if @GNULIB_MBSNRTOWCS@
192 # if @REPLACE_MBSNRTOWCS@
193 #  undef mbsnrtowcs
194 #  define mbsnrtowcs rpl_mbsnrtowcs
195 # endif
196 # if !@HAVE_MBSNRTOWCS@ || @REPLACE_MBSNRTOWCS@
197 extern size_t mbsnrtowcs (wchar_t *dest, const char **srcp, size_t srclen, size_t len, mbstate_t *ps);
198 # endif
199 #elif defined GNULIB_POSIXCHECK
200 # undef mbsnrtowcs
201 # define mbsnrtowcs(d,s,n,l,p) \
202     (GL_LINK_WARNING ("mbsnrtowcs is unportable - " \
203                       "use gnulib module mbsnrtowcs for portability"), \
204      mbsnrtowcs (d, s, n, l, p))
205 #endif
206
207
208 /* Convert a wide character to a multibyte character.  */
209 #if @GNULIB_WCRTOMB@
210 # if !@HAVE_WCRTOMB@
211 extern size_t wcrtomb (char *s, wchar_t wc, mbstate_t *ps);
212 # endif
213 #elif defined GNULIB_POSIXCHECK
214 # undef wcrtomb
215 # define wcrtomb(s,w,p) \
216     (GL_LINK_WARNING ("wcrtomb is unportable - " \
217                       "use gnulib module wcrtomb for portability"), \
218      wcrtomb (s, w, p))
219 #endif
220
221
222 /* Return the number of screen columns needed for WC.  */
223 #if @GNULIB_WCWIDTH@
224 # if @REPLACE_WCWIDTH@
225 #  undef wcwidth
226 #  define wcwidth rpl_wcwidth
227 extern int wcwidth (wchar_t);
228 # else
229 #  if !defined wcwidth && !@HAVE_DECL_WCWIDTH@
230 /* wcwidth exists but is not declared.  */
231 extern int wcwidth (int /* actually wchar_t */);
232 #  endif
233 # endif
234 #elif defined GNULIB_POSIXCHECK
235 # undef wcwidth
236 # define wcwidth(w) \
237     (GL_LINK_WARNING ("wcwidth is unportable - " \
238                       "use gnulib module wcwidth for portability"), \
239      wcwidth (w))
240 #endif
241
242
243 #ifdef __cplusplus
244 }
245 #endif
246
247 #endif /* _GL_WCHAR_H */
248 #endif /* _GL_WCHAR_H */
249 #endif