New module 'iconv_open-utf': Enhance iconv_open to support UTF-{16,32}{BE,LE}.
[gnulib.git] / lib / iconv.in.h
1 /* A GNU-like <iconv.h>.
2
3    Copyright (C) 2007 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 /* The include_next requires a split double-inclusion guard.  */
22 #@INCLUDE_NEXT@ @NEXT_ICONV_H@
23
24 #ifndef _GL_ICONV_H
25 #define _GL_ICONV_H
26
27 #ifdef __cplusplus
28 extern "C" {
29 #endif
30
31
32 #if @REPLACE_ICONV_OPEN@
33 /* An iconv_open wrapper that supports the IANA standardized encoding names
34    ("ISO-8859-1" etc.) as far as possible.  */
35 # define iconv_open rpl_iconv_open
36 extern iconv_t iconv_open (const char *tocode, const char *fromcode);
37 #endif
38
39 #if @REPLACE_ICONV_UTF@
40 /* Special constants for supporting UTF-{16,32}{BE,LE} encodings.
41    Not public.  */
42 # define _ICONV_UTF8_UTF16BE (iconv_t)(-161)
43 # define _ICONV_UTF8_UTF16LE (iconv_t)(-162)
44 # define _ICONV_UTF8_UTF32BE (iconv_t)(-163)
45 # define _ICONV_UTF8_UTF32LE (iconv_t)(-164)
46 # define _ICONV_UTF16BE_UTF8 (iconv_t)(-165)
47 # define _ICONV_UTF16LE_UTF8 (iconv_t)(-166)
48 # define _ICONV_UTF32BE_UTF8 (iconv_t)(-167)
49 # define _ICONV_UTF32LE_UTF8 (iconv_t)(-168)
50 #endif
51
52 #if @REPLACE_ICONV@
53 # define iconv rpl_iconv
54 extern size_t iconv (iconv_t cd,
55                      @ICONV_CONST@ char **inbuf, size_t *inbytesleft,
56                      char **outbuf, size_t *outbytesleft);
57 # define iconv_close rpl_iconv_close
58 extern int iconv_close (iconv_t cd);
59 #endif
60
61
62 #ifdef __cplusplus
63 }
64 #endif
65
66 #endif /* _GL_ICONV_H */
67 #endif /* _GL_ICONV_H */