Work around mbrtowc bugs on AIX, HP-UX, OSF/1, Solaris.
[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 !@HAVE_BTOWC@
88 extern wint_t btowc (int c);
89 # endif
90 #elif defined GNULIB_POSIXCHECK
91 # undef btowc
92 # define btowc(c) \
93     (GL_LINK_WARNING ("btowc is unportable - " \
94                       "use gnulib module btowc for portability"), \
95      btowc (c))
96 #endif
97
98
99 /* Convert a wide character to a single-byte character.  */
100 #if @GNULIB_WCTOB@
101 # if @REPLACE_WCTOB@
102 #  undef wctob
103 #  define wctob rpl_wctob
104 # endif
105 # if (!defined wctob && !@HAVE_DECL_WCTOB@) || @REPLACE_WCTOB@
106 /* wctob is provided by gnulib, or wctob exists but is not declared.  */
107 extern int wctob (wint_t wc);
108 # endif
109 #elif defined GNULIB_POSIXCHECK
110 # undef wctob
111 # define wctob(w) \
112     (GL_LINK_WARNING ("wctob is unportable - " \
113                       "use gnulib module wctob for portability"), \
114      wctob (w))
115 #endif
116
117
118 /* Test whether *PS is in the initial state.  */
119 #if @GNULIB_MBSINIT@
120 # if @REPLACE_MBSINIT@
121 #  undef mbsinit
122 #  define mbsinit rpl_mbsinit
123 # endif
124 # if !@HAVE_MBSINIT@ || @REPLACE_MBSINIT@
125 extern int mbsinit (const mbstate_t *ps);
126 # endif
127 #elif defined GNULIB_POSIXCHECK
128 # undef mbsinit
129 # define mbsinit(p) \
130     (GL_LINK_WARNING ("mbsinit is unportable - " \
131                       "use gnulib module mbsinit for portability"), \
132      mbsinit (p))
133 #endif
134
135
136 /* Convert a multibyte character to a wide character.  */
137 #if @GNULIB_MBRTOWC@
138 # if @REPLACE_MBRTOWC@
139 #  undef mbrtowc
140 #  define mbrtowc rpl_mbrtowc
141 # endif
142 # if !@HAVE_MBRTOWC@ || @REPLACE_MBRTOWC@
143 extern size_t mbrtowc (wchar_t *pwc, const char *s, size_t n, mbstate_t *ps);
144 # endif
145 #elif defined GNULIB_POSIXCHECK
146 # undef mbrtowc
147 # define mbrtowc(w,s,n,p) \
148     (GL_LINK_WARNING ("mbrtowc is unportable - " \
149                       "use gnulib module mbrtowc for portability"), \
150      mbrtowc (w, s, n, p))
151 #endif
152
153
154 /* Recognize a multibyte character.  */
155 #if @GNULIB_MBRLEN@
156 # if !@HAVE_MBRLEN@
157 extern size_t mbrlen (const char *s, size_t n, mbstate_t *ps);
158 # endif
159 #elif defined GNULIB_POSIXCHECK
160 # undef mbrlen
161 # define mbrlen(s,n,p) \
162     (GL_LINK_WARNING ("mbrlen is unportable - " \
163                       "use gnulib module mbrlen for portability"), \
164      mbrlen (s, n, p))
165 #endif
166
167
168 /* Convert a string to a wide string.  */
169 #if @GNULIB_MBSRTOWCS@
170 # if !@HAVE_MBSRTOWCS@
171 extern size_t mbsrtowcs (wchar_t *dest, const char **srcp, size_t len, mbstate_t *ps);
172 # endif
173 #elif defined GNULIB_POSIXCHECK
174 # undef mbsrtowcs
175 # define mbsrtowcs(d,s,l,p) \
176     (GL_LINK_WARNING ("mbsrtowcs is unportable - " \
177                       "use gnulib module mbsrtowcs for portability"), \
178      mbsrtowcs (d, s, l, p))
179 #endif
180
181
182 /* Return the number of screen columns needed for WC.  */
183 #if @GNULIB_WCWIDTH@
184 # if @REPLACE_WCWIDTH@
185 #  undef wcwidth
186 #  define wcwidth rpl_wcwidth
187 extern int wcwidth (wchar_t);
188 # else
189 #  if !defined wcwidth && !@HAVE_DECL_WCWIDTH@
190 /* wcwidth exists but is not declared.  */
191 extern int wcwidth (int /* actually wchar_t */);
192 #  endif
193 # endif
194 #elif defined GNULIB_POSIXCHECK
195 # undef wcwidth
196 # define wcwidth(w) \
197     (GL_LINK_WARNING ("wcwidth is unportable - " \
198                       "use gnulib module wcwidth for portability"), \
199      wcwidth (w))
200 #endif
201
202
203 #ifdef __cplusplus
204 }
205 #endif
206
207 #endif /* _GL_WCHAR_H */
208 #endif /* _GL_WCHAR_H */
209 #endif