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 2, 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 definitions of _GL_FUNCDECL_RPL etc. are copied here. */
80 /* The definition of _GL_ARG_NONNULL is copied here. */
82 /* The definition of _GL_WARN_ON_USE is copied here. */
85 /* Define wint_t. (Also done in wctype.in.h.) */
86 #if !@HAVE_WINT_T@ && !defined wint_t
94 /* Override mbstate_t if it is too small.
95 On IRIX 6.5, sizeof (mbstate_t) == 1, which is not sufficient for
96 implementing mbrtowc for encodings like UTF-8. */
97 #if !(@HAVE_MBSINIT@ && @HAVE_MBRTOWC@) || @REPLACE_MBSTATE_T@
98 typedef int rpl_mbstate_t;
100 # define mbstate_t rpl_mbstate_t
101 # define GNULIB_defined_mbstate_t 1
105 /* Convert a single-byte character to a wide character. */
108 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
110 # define btowc rpl_btowc
112 _GL_FUNCDECL_RPL (btowc, wint_t, (int c));
113 _GL_CXXALIAS_RPL (btowc, wint_t, (int c));
116 _GL_FUNCDECL_SYS (btowc, wint_t, (int c));
118 _GL_CXXALIAS_SYS (btowc, wint_t, (int c));
120 _GL_CXXALIASWARN (btowc);
121 #elif defined GNULIB_POSIXCHECK
123 # if HAVE_RAW_DECL_BTOWC
124 _GL_WARN_ON_USE (btowc, "btowc is unportable - "
125 "use gnulib module btowc for portability");
130 /* Convert a wide character to a single-byte character. */
133 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
135 # define wctob rpl_wctob
137 _GL_FUNCDECL_RPL (wctob, int, (wint_t wc));
138 _GL_CXXALIAS_RPL (wctob, int, (wint_t wc));
140 # if !defined wctob && !@HAVE_DECL_WCTOB@
141 /* wctob is provided by gnulib, or wctob exists but is not declared. */
142 _GL_FUNCDECL_SYS (wctob, int, (wint_t wc));
144 _GL_CXXALIAS_SYS (wctob, int, (wint_t wc));
146 _GL_CXXALIASWARN (wctob);
147 #elif defined GNULIB_POSIXCHECK
149 # if HAVE_RAW_DECL_WCTOB
150 _GL_WARN_ON_USE (wctob, "wctob is unportable - "
151 "use gnulib module wctob for portability");
156 /* Test whether *PS is in the initial state. */
158 # if @REPLACE_MBSINIT@
159 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
161 # define mbsinit rpl_mbsinit
163 _GL_FUNCDECL_RPL (mbsinit, int, (const mbstate_t *ps));
164 _GL_CXXALIAS_RPL (mbsinit, int, (const mbstate_t *ps));
167 _GL_FUNCDECL_SYS (mbsinit, int, (const mbstate_t *ps));
169 _GL_CXXALIAS_SYS (mbsinit, int, (const mbstate_t *ps));
171 _GL_CXXALIASWARN (mbsinit);
172 #elif defined GNULIB_POSIXCHECK
174 # if HAVE_RAW_DECL_MBSINIT
175 _GL_WARN_ON_USE (mbsinit, "mbsinit is unportable - "
176 "use gnulib module mbsinit for portability");
181 /* Convert a multibyte character to a wide character. */
183 # if @REPLACE_MBRTOWC@
184 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
186 # define mbrtowc rpl_mbrtowc
188 _GL_FUNCDECL_RPL (mbrtowc, size_t,
189 (wchar_t *pwc, const char *s, size_t n, mbstate_t *ps));
190 _GL_CXXALIAS_RPL (mbrtowc, size_t,
191 (wchar_t *pwc, const char *s, size_t n, mbstate_t *ps));
194 _GL_FUNCDECL_SYS (mbrtowc, size_t,
195 (wchar_t *pwc, const char *s, size_t n, mbstate_t *ps));
197 _GL_CXXALIAS_SYS (mbrtowc, size_t,
198 (wchar_t *pwc, const char *s, size_t n, mbstate_t *ps));
200 _GL_CXXALIASWARN (mbrtowc);
201 #elif defined GNULIB_POSIXCHECK
203 # if HAVE_RAW_DECL_MBRTOWC
204 _GL_WARN_ON_USE (mbrtowc, "mbrtowc is unportable - "
205 "use gnulib module mbrtowc for portability");
210 /* Recognize a multibyte character. */
212 # if @REPLACE_MBRLEN@
213 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
215 # define mbrlen rpl_mbrlen
217 _GL_FUNCDECL_RPL (mbrlen, size_t, (const char *s, size_t n, mbstate_t *ps));
218 _GL_CXXALIAS_RPL (mbrlen, size_t, (const char *s, size_t n, mbstate_t *ps));
221 _GL_FUNCDECL_SYS (mbrlen, size_t, (const char *s, size_t n, mbstate_t *ps));
223 _GL_CXXALIAS_SYS (mbrlen, size_t, (const char *s, size_t n, mbstate_t *ps));
225 _GL_CXXALIASWARN (mbrlen);
226 #elif defined GNULIB_POSIXCHECK
228 # if HAVE_RAW_DECL_MBRLEN
229 _GL_WARN_ON_USE (mbrlen, "mbrlen is unportable - "
230 "use gnulib module mbrlen for portability");
235 /* Convert a string to a wide string. */
236 #if @GNULIB_MBSRTOWCS@
237 # if @REPLACE_MBSRTOWCS@
238 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
240 # define mbsrtowcs rpl_mbsrtowcs
242 _GL_FUNCDECL_RPL (mbsrtowcs, size_t,
243 (wchar_t *dest, const char **srcp, size_t len, mbstate_t *ps)
244 _GL_ARG_NONNULL ((2)));
245 _GL_CXXALIAS_RPL (mbsrtowcs, size_t,
246 (wchar_t *dest, const char **srcp, size_t len,
249 # if !@HAVE_MBSRTOWCS@
250 _GL_FUNCDECL_SYS (mbsrtowcs, size_t,
251 (wchar_t *dest, const char **srcp, size_t len, mbstate_t *ps)
252 _GL_ARG_NONNULL ((2)));
254 _GL_CXXALIAS_SYS (mbsrtowcs, size_t,
255 (wchar_t *dest, const char **srcp, size_t len,
258 _GL_CXXALIASWARN (mbsrtowcs);
259 #elif defined GNULIB_POSIXCHECK
261 # if HAVE_RAW_DECL_MBSRTOWCS
262 _GL_WARN_ON_USE (mbsrtowcs, "mbsrtowcs is unportable - "
263 "use gnulib module mbsrtowcs for portability");
268 /* Convert a string to a wide string. */
269 #if @GNULIB_MBSNRTOWCS@
270 # if @REPLACE_MBSNRTOWCS@
271 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
273 # define mbsnrtowcs rpl_mbsnrtowcs
275 _GL_FUNCDECL_RPL (mbsnrtowcs, size_t,
276 (wchar_t *dest, const char **srcp, size_t srclen, size_t len,
278 _GL_ARG_NONNULL ((2)));
279 _GL_CXXALIAS_RPL (mbsnrtowcs, size_t,
280 (wchar_t *dest, const char **srcp, size_t srclen, size_t len,
283 # if !@HAVE_MBSNRTOWCS@
284 _GL_FUNCDECL_SYS (mbsnrtowcs, size_t,
285 (wchar_t *dest, const char **srcp, size_t srclen, size_t len,
287 _GL_ARG_NONNULL ((2)));
289 _GL_CXXALIAS_SYS (mbsnrtowcs, size_t,
290 (wchar_t *dest, const char **srcp, size_t srclen, size_t len,
293 _GL_CXXALIASWARN (mbsnrtowcs);
294 #elif defined GNULIB_POSIXCHECK
296 # if HAVE_RAW_DECL_MBSNRTOWCS
297 _GL_WARN_ON_USE (mbsnrtowcs, "mbsnrtowcs is unportable - "
298 "use gnulib module mbsnrtowcs for portability");
303 /* Convert a wide character to a multibyte character. */
305 # if @REPLACE_WCRTOMB@
306 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
308 # define wcrtomb rpl_wcrtomb
310 _GL_FUNCDECL_RPL (wcrtomb, size_t, (char *s, wchar_t wc, mbstate_t *ps));
311 _GL_CXXALIAS_RPL (wcrtomb, size_t, (char *s, wchar_t wc, mbstate_t *ps));
314 _GL_FUNCDECL_SYS (wcrtomb, size_t, (char *s, wchar_t wc, mbstate_t *ps));
316 _GL_CXXALIAS_SYS (wcrtomb, size_t, (char *s, wchar_t wc, mbstate_t *ps));
318 _GL_CXXALIASWARN (wcrtomb);
319 #elif defined GNULIB_POSIXCHECK
321 # if HAVE_RAW_DECL_WCRTOMB
322 _GL_WARN_ON_USE (wcrtomb, "wcrtomb is unportable - "
323 "use gnulib module wcrtomb for portability");
328 /* Convert a wide string to a string. */
329 #if @GNULIB_WCSRTOMBS@
330 # if @REPLACE_WCSRTOMBS@
331 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
333 # define wcsrtombs rpl_wcsrtombs
335 _GL_FUNCDECL_RPL (wcsrtombs, size_t,
336 (char *dest, const wchar_t **srcp, size_t len, mbstate_t *ps)
337 _GL_ARG_NONNULL ((2)));
338 _GL_CXXALIAS_RPL (wcsrtombs, size_t,
339 (char *dest, const wchar_t **srcp, size_t len,
342 # if !@HAVE_WCSRTOMBS@
343 _GL_FUNCDECL_SYS (wcsrtombs, size_t,
344 (char *dest, const wchar_t **srcp, size_t len, mbstate_t *ps)
345 _GL_ARG_NONNULL ((2)));
347 _GL_CXXALIAS_SYS (wcsrtombs, size_t,
348 (char *dest, const wchar_t **srcp, size_t len,
351 _GL_CXXALIASWARN (wcsrtombs);
352 #elif defined GNULIB_POSIXCHECK
354 # if HAVE_RAW_DECL_WCSRTOMBS
355 _GL_WARN_ON_USE (wcsrtombs, "wcsrtombs is unportable - "
356 "use gnulib module wcsrtombs for portability");
361 /* Convert a wide string to a string. */
362 #if @GNULIB_WCSNRTOMBS@
363 # if @REPLACE_WCSNRTOMBS@
364 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
366 # define wcsnrtombs rpl_wcsnrtombs
368 _GL_FUNCDECL_RPL (wcsnrtombs, size_t,
369 (char *dest, const wchar_t **srcp, size_t srclen, size_t len,
371 _GL_ARG_NONNULL ((2)));
372 _GL_CXXALIAS_RPL (wcsnrtombs, size_t,
373 (char *dest, const wchar_t **srcp, size_t srclen, size_t len,
376 # if !@HAVE_WCSNRTOMBS@
377 _GL_FUNCDECL_SYS (wcsnrtombs, size_t,
378 (char *dest, const wchar_t **srcp, size_t srclen, size_t len,
380 _GL_ARG_NONNULL ((2)));
382 _GL_CXXALIAS_SYS (wcsnrtombs, size_t,
383 (char *dest, const wchar_t **srcp, size_t srclen, size_t len,
386 _GL_CXXALIASWARN (wcsnrtombs);
387 #elif defined GNULIB_POSIXCHECK
389 # if HAVE_RAW_DECL_WCSNRTOMBS
390 _GL_WARN_ON_USE (wcsnrtombs, "wcsnrtombs is unportable - "
391 "use gnulib module wcsnrtombs for portability");
396 /* Return the number of screen columns needed for WC. */
398 # if @REPLACE_WCWIDTH@
399 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
401 # define wcwidth rpl_wcwidth
403 _GL_FUNCDECL_RPL (wcwidth, int, (wchar_t));
404 _GL_CXXALIAS_RPL (wcwidth, int, (wchar_t));
406 # if !defined wcwidth && !@HAVE_DECL_WCWIDTH@
407 /* wcwidth exists but is not declared. */
408 _GL_FUNCDECL_SYS (wcwidth, int, (wchar_t));
410 _GL_CXXALIAS_SYS (wcwidth, int, (wchar_t));
412 _GL_CXXALIASWARN (wcwidth);
413 #elif defined GNULIB_POSIXCHECK
415 # if HAVE_RAW_DECL_WCWIDTH
416 _GL_WARN_ON_USE (wcwidth, "wcwidth is unportable - "
417 "use gnulib module wcwidth for portability");
422 #endif /* _GL_WCHAR_H */
423 #endif /* _GL_WCHAR_H */