Merge commit 'stable/20110609'
[gnulib.git] / lib / iconv.in.h
1 /* A GNU-like <iconv.h>.
2
3    Copyright (C) 2007-2011 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 @GNULIB_ICONV@
40 # if @REPLACE_ICONV_OPEN@
41 /* An iconv_open wrapper that supports the IANA standardized encoding names
42    ("ISO-8859-1" etc.) as far as possible.  */
43 #  if !(defined __cplusplus && defined GNULIB_NAMESPACE)
44 #   define iconv_open rpl_iconv_open
45 #  endif
46 _GL_FUNCDECL_RPL (iconv_open, iconv_t,
47                   (const char *tocode, const char *fromcode)
48                   _GL_ARG_NONNULL ((1, 2)));
49 _GL_CXXALIAS_RPL (iconv_open, iconv_t,
50                   (const char *tocode, const char *fromcode));
51 # else
52 _GL_CXXALIAS_SYS (iconv_open, iconv_t,
53                   (const char *tocode, const char *fromcode));
54 # endif
55 _GL_CXXALIASWARN (iconv_open);
56 #endif
57
58 #if @REPLACE_ICONV_UTF@
59 /* Special constants for supporting UTF-{16,32}{BE,LE} encodings.
60    Not public.  */
61 # define _ICONV_UTF8_UTF16BE (iconv_t)(-161)
62 # define _ICONV_UTF8_UTF16LE (iconv_t)(-162)
63 # define _ICONV_UTF8_UTF32BE (iconv_t)(-163)
64 # define _ICONV_UTF8_UTF32LE (iconv_t)(-164)
65 # define _ICONV_UTF16BE_UTF8 (iconv_t)(-165)
66 # define _ICONV_UTF16LE_UTF8 (iconv_t)(-166)
67 # define _ICONV_UTF32BE_UTF8 (iconv_t)(-167)
68 # define _ICONV_UTF32LE_UTF8 (iconv_t)(-168)
69 #endif
70
71 #if @GNULIB_ICONV@
72 # if @REPLACE_ICONV@
73 #  if !(defined __cplusplus && defined GNULIB_NAMESPACE)
74 #   define iconv rpl_iconv
75 #  endif
76 _GL_FUNCDECL_RPL (iconv, size_t,
77                   (iconv_t cd,
78                    @ICONV_CONST@ char **inbuf, size_t *inbytesleft,
79                    char **outbuf, size_t *outbytesleft));
80 _GL_CXXALIAS_RPL (iconv, size_t,
81                   (iconv_t cd,
82                    @ICONV_CONST@ char **inbuf, size_t *inbytesleft,
83                    char **outbuf, size_t *outbytesleft));
84 # else
85 _GL_CXXALIAS_SYS (iconv, size_t,
86                   (iconv_t cd,
87                    @ICONV_CONST@ char **inbuf, size_t *inbytesleft,
88                    char **outbuf, size_t *outbytesleft));
89 # endif
90 _GL_CXXALIASWARN (iconv);
91 # ifndef ICONV_CONST
92 #  define ICONV_CONST @ICONV_CONST@
93 # endif
94 #endif
95
96 #if @GNULIB_ICONV@
97 # if @REPLACE_ICONV@
98 #  if !(defined __cplusplus && defined GNULIB_NAMESPACE)
99 #   define iconv_close rpl_iconv_close
100 #  endif
101 _GL_FUNCDECL_RPL (iconv_close, int, (iconv_t cd));
102 _GL_CXXALIAS_RPL (iconv_close, int, (iconv_t cd));
103 # else
104 _GL_CXXALIAS_SYS (iconv_close, int, (iconv_t cd));
105 # endif
106 _GL_CXXALIASWARN (iconv_close);
107 #endif
108
109
110 #endif /* _GL_ICONV_H */
111 #endif /* _GL_ICONV_H */