New module 'mbrtowc'.
[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@)
78 typedef int rpl_mbstate_t;
79 # undef mbstate_t
80 # define mbstate_t rpl_mbstate_t
81 #endif
82
83
84 /* Convert a single-byte character to a wide character.  */
85 #if @GNULIB_BTOWC@
86 # if !@HAVE_BTOWC@
87 extern wint_t btowc (int c);
88 # endif
89 #elif defined GNULIB_POSIXCHECK
90 # undef btowc
91 # define btowc(c) \
92     (GL_LINK_WARNING ("btowc is unportable - " \
93                       "use gnulib module btowc for portability"), \
94      btowc (c))
95 #endif
96
97
98 /* Convert a wide character to a single-byte character.  */
99 #if @GNULIB_WCTOB@
100 # if !@HAVE_WCTOB@
101 extern int wctob (wint_t wc);
102 # endif
103 #elif defined GNULIB_POSIXCHECK
104 # undef wctob
105 # define wctob(w) \
106     (GL_LINK_WARNING ("wctob is unportable - " \
107                       "use gnulib module wctob for portability"), \
108      wctob (w))
109 #endif
110
111
112 /* Test whether *PS is in the initial state.  */
113 #if @GNULIB_MBSINIT@
114 # if !@HAVE_MBSINIT@
115 extern int mbsinit (const mbstate_t *ps);
116 # endif
117 #elif defined GNULIB_POSIXCHECK
118 # undef mbsinit
119 # define mbsinit(p) \
120     (GL_LINK_WARNING ("mbsinit is unportable - " \
121                       "use gnulib module mbsinit for portability"), \
122      mbsinit (p))
123 #endif
124
125
126 /* Convert a multibyte character to a wide character.  */
127 #if @GNULIB_MBRTOWC@
128 # if !@HAVE_MBRTOWC@
129 extern size_t mbrtowc (wchar_t *pwc, const char *s, size_t n, mbstate_t *ps);
130 # endif
131 #elif defined GNULIB_POSIXCHECK
132 # undef mbrtowc
133 # define mbrtowc(w,s,n,p) \
134     (GL_LINK_WARNING ("mbrtowc is unportable - " \
135                       "use gnulib module mbrtowc for portability"), \
136      mbrtowc (w, s, n, p))
137 #endif
138
139
140 /* Return the number of screen columns needed for WC.  */
141 #if @GNULIB_WCWIDTH@
142 # if @REPLACE_WCWIDTH@
143 #  undef wcwidth
144 #  define wcwidth rpl_wcwidth
145 extern int wcwidth (wchar_t);
146 # else
147 #  if !defined wcwidth && !@HAVE_DECL_WCWIDTH@
148 /* wcwidth exists but is not declared.  */
149 extern int wcwidth (int /* actually wchar_t */);
150 #  endif
151 # endif
152 #elif defined GNULIB_POSIXCHECK
153 # undef wcwidth
154 # define wcwidth(w) \
155     (GL_LINK_WARNING ("wcwidth is unportable - " \
156                       "use gnulib module wcwidth for portability"), \
157      wcwidth (w))
158 #endif
159
160
161 #ifdef __cplusplus
162 }
163 #endif
164
165 #endif /* _GL_WCHAR_H */
166 #endif /* _GL_WCHAR_H */
167 #endif