1 /* A substitute for ISO C99 <wchar.h>, for platforms that have issues.
3 Copyright (C) 2007-2010 Free Software Foundation, Inc.
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 3, or (at your option)
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.
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. */
19 /* Written by Eric Blake. */
22 * ISO C 99 <wchar.h> for platforms that have issues.
23 * <http://www.opengroup.org/susv3xbd/wchar.h.html>
25 * For now, this just ensures proper prerequisite inclusion order and
26 * the declaration of wcwidth().
30 @PRAGMA_SYSTEM_HEADER@
33 #if defined __need_mbstate_t || defined __need_wint_t || (defined __hpux && ((defined _INTTYPES_INCLUDED && !defined strtoimax) || defined _GL_JUST_INCLUDE_SYSTEM_WCHAR_H)) || defined _GL_ALREADY_INCLUDING_WCHAR_H
34 /* Special invocation convention:
35 - Inside glibc and uClibc header files.
36 - On HP-UX 11.00 we have a sequence of nested includes
37 <wchar.h> -> <stdlib.h> -> <stdint.h>, and the latter includes <wchar.h>,
38 once indirectly <stdint.h> -> <sys/types.h> -> <inttypes.h> -> <wchar.h>
39 and once directly. In both situations 'wint_t' is not yet defined,
40 therefore we cannot provide the function overrides; instead include only
41 the system's <wchar.h>.
42 - On IRIX 6.5, similarly, we have an include <wchar.h> -> <wctype.h>, and
43 the latter includes <wchar.h>. But here, we have no way to detect whether
44 <wctype.h> is completely included or is still being included. */
46 #@INCLUDE_NEXT@ @NEXT_WCHAR_H@
49 /* Normal invocation convention. */
53 #define _GL_ALREADY_INCLUDING_WCHAR_H
55 /* Tru64 with Desktop Toolkit C has a bug: <stdio.h> must be included before
57 BSD/OS 4.0.1 has a bug: <stddef.h>, <stdio.h> and <time.h> must be
58 included before <wchar.h>.
59 But avoid namespace pollution on glibc systems. */
66 /* Include the original <wchar.h> if it exists.
67 Some builds of uClibc lack it. */
68 /* The include_next requires a split double-inclusion guard. */
70 # @INCLUDE_NEXT@ @NEXT_WCHAR_H@
73 #undef _GL_ALREADY_INCLUDING_WCHAR_H
78 /* The definition of _GL_ARG_NONNULL is copied here. */
80 /* The definition of _GL_WARN_ON_USE is copied here. */
87 /* Define wint_t. (Also done in wctype.in.h.) */
88 #if !@HAVE_WINT_T@ && !defined wint_t
96 /* Override mbstate_t if it is too small.
97 On IRIX 6.5, sizeof (mbstate_t) == 1, which is not sufficient for
98 implementing mbrtowc for encodings like UTF-8. */
99 #if !(@HAVE_MBSINIT@ && @HAVE_MBRTOWC@) || @REPLACE_MBSTATE_T@
100 typedef int rpl_mbstate_t
;
102 # define mbstate_t rpl_mbstate_t
103 # define GNULIB_defined_mbstate_t 1
107 /* Convert a single-byte character to a wide character. */
111 # define btowc rpl_btowc
113 # if !@HAVE_BTOWC@ || @REPLACE_BTOWC@
114 extern wint_t btowc (int c
);
116 #elif defined GNULIB_POSIXCHECK
118 # if HAVE_RAW_DECL_BTOWC
119 _GL_WARN_ON_USE (btowc
, "btowc is unportable - "
120 "use gnulib module btowc for portability");
125 /* Convert a wide character to a single-byte character. */
129 # define wctob rpl_wctob
131 # if (!defined wctob && !@HAVE_DECL_WCTOB@) || @REPLACE_WCTOB@
132 /* wctob is provided by gnulib, or wctob exists but is not declared. */
133 extern int wctob (wint_t wc
);
135 #elif defined GNULIB_POSIXCHECK
137 # if HAVE_RAW_DECL_WCTOB
138 _GL_WARN_ON_USE (wctob
, "wctob is unportable - "
139 "use gnulib module wctob for portability");
144 /* Test whether *PS is in the initial state. */
146 # if @REPLACE_MBSINIT@
148 # define mbsinit rpl_mbsinit
150 # if !@HAVE_MBSINIT@ || @REPLACE_MBSINIT@
151 extern int mbsinit (const mbstate_t *ps
);
153 #elif defined GNULIB_POSIXCHECK
155 # if HAVE_RAW_DECL_MBSINIT
156 _GL_WARN_ON_USE (mbsinit
, "mbsinit is unportable - "
157 "use gnulib module mbsinit for portability");
162 /* Convert a multibyte character to a wide character. */
164 # if @REPLACE_MBRTOWC@
166 # define mbrtowc rpl_mbrtowc
168 # if !@HAVE_MBRTOWC@ || @REPLACE_MBRTOWC@
169 extern size_t mbrtowc (wchar_t *pwc
, const char *s
, size_t n
, mbstate_t *ps
);
171 #elif defined GNULIB_POSIXCHECK
173 # if HAVE_RAW_DECL_MBRTOWC
174 _GL_WARN_ON_USE (mbrtowc
, "mbrtowc is unportable - "
175 "use gnulib module mbrtowc for portability");
180 /* Recognize a multibyte character. */
182 # if @REPLACE_MBRLEN@
184 # define mbrlen rpl_mbrlen
186 # if !@HAVE_MBRLEN@ || @REPLACE_MBRLEN@
187 extern size_t mbrlen (const char *s
, size_t n
, mbstate_t *ps
);
189 #elif defined GNULIB_POSIXCHECK
191 # if HAVE_RAW_DECL_MBRLEN
192 _GL_WARN_ON_USE (mbrlen
, "mbrlen is unportable - "
193 "use gnulib module mbrlen for portability");
198 /* Convert a string to a wide string. */
199 #if @GNULIB_MBSRTOWCS@
200 # if @REPLACE_MBSRTOWCS@
202 # define mbsrtowcs rpl_mbsrtowcs
204 # if !@HAVE_MBSRTOWCS@ || @REPLACE_MBSRTOWCS@
205 extern size_t mbsrtowcs (wchar_t *dest
, const char **srcp
, size_t len
, mbstate_t *ps
)
206 _GL_ARG_NONNULL ((2));
208 #elif defined GNULIB_POSIXCHECK
210 # if HAVE_RAW_DECL_MBSRTOWCS
211 _GL_WARN_ON_USE (mbsrtowcs
, "mbsrtowcs is unportable - "
212 "use gnulib module mbsrtowcs for portability");
217 /* Convert a string to a wide string. */
218 #if @GNULIB_MBSNRTOWCS@
219 # if @REPLACE_MBSNRTOWCS@
221 # define mbsnrtowcs rpl_mbsnrtowcs
223 # if !@HAVE_MBSNRTOWCS@ || @REPLACE_MBSNRTOWCS@
224 extern size_t mbsnrtowcs (wchar_t *dest
, const char **srcp
, size_t srclen
, size_t len
, mbstate_t *ps
)
225 _GL_ARG_NONNULL ((2));
227 #elif defined GNULIB_POSIXCHECK
229 # if HAVE_RAW_DECL_MBSNRTOWCS
230 _GL_WARN_ON_USE (mbsnrtowcs
, "mbsnrtowcs is unportable - "
231 "use gnulib module mbsnrtowcs for portability");
236 /* Convert a wide character to a multibyte character. */
238 # if @REPLACE_WCRTOMB@
240 # define wcrtomb rpl_wcrtomb
242 # if !@HAVE_WCRTOMB@ || @REPLACE_WCRTOMB@
243 extern size_t wcrtomb (char *s
, wchar_t wc
, mbstate_t *ps
);
245 #elif defined GNULIB_POSIXCHECK
247 # if HAVE_RAW_DECL_WCRTOMB
248 _GL_WARN_ON_USE (wcrtomb
, "wcrtomb is unportable - "
249 "use gnulib module wcrtomb for portability");
254 /* Convert a wide string to a string. */
255 #if @GNULIB_WCSRTOMBS@
256 # if @REPLACE_WCSRTOMBS@
258 # define wcsrtombs rpl_wcsrtombs
260 # if !@HAVE_WCSRTOMBS@ || @REPLACE_WCSRTOMBS@
261 extern size_t wcsrtombs (char *dest
, const wchar_t **srcp
, size_t len
, mbstate_t *ps
)
262 _GL_ARG_NONNULL ((2));
264 #elif defined GNULIB_POSIXCHECK
266 # if HAVE_RAW_DECL_WCSRTOMBS
267 _GL_WARN_ON_USE (wcsrtombs
, "wcsrtombs is unportable - "
268 "use gnulib module wcsrtombs for portability");
273 /* Convert a wide string to a string. */
274 #if @GNULIB_WCSNRTOMBS@
275 # if @REPLACE_WCSNRTOMBS@
277 # define wcsnrtombs rpl_wcsnrtombs
279 # if !@HAVE_WCSNRTOMBS@ || @REPLACE_WCSNRTOMBS@
280 extern size_t wcsnrtombs (char *dest
, const wchar_t **srcp
, size_t srclen
, size_t len
, mbstate_t *ps
)
281 _GL_ARG_NONNULL ((2));
283 #elif defined GNULIB_POSIXCHECK
285 # if HAVE_RAW_DECL_WCSNRTOMBS
286 _GL_WARN_ON_USE (wcsnrtombs
, "wcsnrtombs is unportable - "
287 "use gnulib module wcsnrtombs for portability");
292 /* Return the number of screen columns needed for WC. */
294 # if @REPLACE_WCWIDTH@
296 # define wcwidth rpl_wcwidth
297 extern int wcwidth (wchar_t);
299 # if !defined wcwidth && !@HAVE_DECL_WCWIDTH@
300 /* wcwidth exists but is not declared. */
301 extern int wcwidth (int /* actually wchar_t */);
304 #elif defined GNULIB_POSIXCHECK
306 # if HAVE_RAW_DECL_WCWIDTH
307 _GL_WARN_ON_USE (wcwidth
, "wcwidth is unportable - "
308 "use gnulib module wcwidth for portability");
317 #endif /* _GL_WCHAR_H */
318 #endif /* _GL_WCHAR_H */