Merge branch 'upstream' into stable
[gnulib.git] / lib / iconv.in.h
1 /* A GNU-like <iconv.h>.
2
3    Copyright (C) 2007-2010 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 #ifndef _GL_ICONV_H
20
21 #if __GNUC__ >= 3
22 @PRAGMA_SYSTEM_HEADER@
23 #endif
24 @PRAGMA_COLUMNS@
25
26 /* The include_next requires a split double-inclusion guard.  */
27 #@INCLUDE_NEXT@ @NEXT_ICONV_H@
28
29 #ifndef _GL_ICONV_H
30 #define _GL_ICONV_H
31
32 /* The definitions of _GL_FUNCDECL_RPL etc. are copied here.  */
33
34 /* The definition of _GL_ARG_NONNULL is copied here.  */
35
36 /* The definition of _GL_WARN_ON_USE is copied here.  */
37
38
39 #if @REPLACE_ICONV_OPEN@
40 /* An iconv_open wrapper that supports the IANA standardized encoding names
41    ("ISO-8859-1" etc.) as far as possible.  */
42 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
43 #  define iconv_open rpl_iconv_open
44 # endif
45 _GL_FUNCDECL_RPL (iconv_open, iconv_t,
46                   (const char *tocode, const char *fromcode)
47                   _GL_ARG_NONNULL ((1, 2)));
48 _GL_CXXALIAS_RPL (iconv_open, iconv_t,
49                   (const char *tocode, const char *fromcode));
50 #else
51 _GL_CXXALIAS_SYS (iconv_open, iconv_t,
52                   (const char *tocode, const char *fromcode));
53 #endif
54 _GL_CXXALIASWARN (iconv_open);
55
56 #if @REPLACE_ICONV_UTF@
57 /* Special constants for supporting UTF-{16,32}{BE,LE} encodings.
58    Not public.  */
59 # define _ICONV_UTF8_UTF16BE (iconv_t)(-161)
60 # define _ICONV_UTF8_UTF16LE (iconv_t)(-162)
61 # define _ICONV_UTF8_UTF32BE (iconv_t)(-163)
62 # define _ICONV_UTF8_UTF32LE (iconv_t)(-164)
63 # define _ICONV_UTF16BE_UTF8 (iconv_t)(-165)
64 # define _ICONV_UTF16LE_UTF8 (iconv_t)(-166)
65 # define _ICONV_UTF32BE_UTF8 (iconv_t)(-167)
66 # define _ICONV_UTF32LE_UTF8 (iconv_t)(-168)
67 #endif
68
69 #if @REPLACE_ICONV@
70 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
71 #  define iconv rpl_iconv
72 # endif
73 _GL_FUNCDECL_RPL (iconv, size_t,
74                   (iconv_t cd,
75                    @ICONV_CONST@ char **inbuf, size_t *inbytesleft,
76                    char **outbuf, size_t *outbytesleft));
77 _GL_CXXALIAS_RPL (iconv, size_t,
78                   (iconv_t cd,
79                    @ICONV_CONST@ char **inbuf, size_t *inbytesleft,
80                    char **outbuf, size_t *outbytesleft));
81 #else
82 _GL_CXXALIAS_SYS (iconv, size_t,
83                   (iconv_t cd,
84                    @ICONV_CONST@ char **inbuf, size_t *inbytesleft,
85                    char **outbuf, size_t *outbytesleft));
86 #endif
87 _GL_CXXALIASWARN (iconv);
88
89 #if @REPLACE_ICONV@
90 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
91 #  define iconv_close rpl_iconv_close
92 # endif
93 _GL_FUNCDECL_RPL (iconv_close, int, (iconv_t cd));
94 _GL_CXXALIAS_RPL (iconv_close, int, (iconv_t cd));
95 #else
96 _GL_CXXALIAS_SYS (iconv_close, int, (iconv_t cd));
97 #endif
98 _GL_CXXALIASWARN (iconv_close);
99
100
101 #endif /* _GL_ICONV_H */
102 #endif /* _GL_ICONV_H */