1/* Copyright (C) 1999-2003, 2005 Free Software Foundation, Inc. 2 This file is part of the GNU LIBICONV Library. 3 4 The GNU LIBICONV Library is free software; you can redistribute it 5 and/or modify it under the terms of the GNU Library General Public 6 License as published by the Free Software Foundation; either version 2 7 of the License, or (at your option) any later version. 8 9 The GNU LIBICONV Library is distributed in the hope that it will be 10 useful, but WITHOUT ANY WARRANTY; without even the implied warranty of 11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 12 Library General Public License for more details. 13 14 You should have received a copy of the GNU Library General Public 15 License along with the GNU LIBICONV Library; see the file COPYING.LIB. 16 If not, write to the Free Software Foundation, Inc., 51 Franklin Street, 17 Fifth Floor, Boston, MA 02110-1301, USA. */ 18 19/* When installed, this file is called "iconv.h". */ 20 21#ifndef _LIBICONV_H 22#define _LIBICONV_H 23 24#define _LIBICONV_VERSION 0x010A /* version number: (major<<8) + minor */ 25 26#ifdef BUILDING_LIBICONV 27#define LIBICONV_DLL_EXPORTED __declspec(dllexport) 28#else 29#define LIBICONV_DLL_EXPORTED __declspec(dllimport) 30#endif 31extern LIBICONV_DLL_EXPORTED int _libiconv_version; /* Likewise */ 32 33/* We would like to #include any system header file which could define 34 iconv_t, 1. in order to eliminate the risk that the user gets compilation 35 errors because some other system header file includes /usr/include/iconv.h 36 which defines iconv_t or declares iconv after this file, 2. when compiling 37 for LIBICONV_PLUG, we need the proper iconv_t type in order to produce 38 binary compatible code. 39 But gcc's #include_next is not portable. Thus, once libiconv's iconv.h 40 has been installed in /usr/local/include, there is no way any more to 41 include the original /usr/include/iconv.h. We simply have to get away 42 without it. 43 Ad 1. The risk that a system header file does 44 #include "iconv.h" or #include_next "iconv.h" 45 is small. They all do #include <iconv.h>. 46 Ad 2. The iconv_t type is a pointer type in all cases I have seen. (It 47 has to be a scalar type because (iconv_t)(-1) is a possible return value 48 from iconv_open().) */ 49 50/* Define iconv_t ourselves. */ 51#undef iconv_t 52#define iconv_t libiconv_t 53typedef void* iconv_t; 54 55/* Get size_t declaration. */ 56#include <stddef.h> 57 58/* Get errno declaration and values. */ 59#include <errno.h> 60/* Some systems, like SunOS 4, don't have EILSEQ. Some systems, like BSD/OS, 61 have EILSEQ in a different header. On these systems, define EILSEQ 62 ourselves. */ 63#ifndef EILSEQ 64#define EILSEQ @EILSEQ@ 65#endif 66 67 68#ifdef __cplusplus 69extern "C" { 70#endif 71 72 73/* Allocates descriptor for code conversion from encoding `fromcode' to 74 encoding `tocode'. */ 75#ifndef LIBICONV_PLUG 76#define iconv_open libiconv_open 77#endif 78extern LIBICONV_DLL_EXPORTED iconv_t iconv_open (const char* tocode, const char* fromcode); 79 80/* Converts, using conversion descriptor `cd', at most `*inbytesleft' bytes 81 starting at `*inbuf', writing at most `*outbytesleft' bytes starting at 82 `*outbuf'. 83 Decrements `*inbytesleft' and increments `*inbuf' by the same amount. 84 Decrements `*outbytesleft' and increments `*outbuf' by the same amount. */ 85#ifndef LIBICONV_PLUG 86#define iconv libiconv 87#endif 88extern LIBICONV_DLL_EXPORTED size_t iconv (iconv_t cd, const char* * inbuf, size_t *inbytesleft, char* * outbuf, size_t *outbytesleft); 89 90/* Frees resources allocated for conversion descriptor `cd'. */ 91#ifndef LIBICONV_PLUG 92#define iconv_close libiconv_close 93#endif 94extern LIBICONV_DLL_EXPORTED int iconv_close (iconv_t cd); 95 96 97#ifndef LIBICONV_PLUG 98 99/* Nonstandard extensions. */ 100 101/* Control of attributes. */ 102#define iconvctl libiconvctl 103extern LIBICONV_DLL_EXPORTED int iconvctl (iconv_t cd, int request, void* argument); 104 105/* Hook performed after every successful conversion of a Unicode character. */ 106typedef void (*iconv_unicode_char_hook) (unsigned int uc, void* data); 107/* Hook performed after every successful conversion of a wide character. */ 108typedef void (*iconv_wide_char_hook) (wchar_t wc, void* data); 109/* Set of hooks. */ 110struct iconv_hooks { 111 iconv_unicode_char_hook uc_hook; 112 iconv_wide_char_hook wc_hook; 113 void* data; 114}; 115 116/* Requests for iconvctl. */ 117#define ICONV_TRIVIALP 0 /* int *argument */ 118#define ICONV_GET_TRANSLITERATE 1 /* int *argument */ 119#define ICONV_SET_TRANSLITERATE 2 /* const int *argument */ 120#define ICONV_GET_DISCARD_ILSEQ 3 /* int *argument */ 121#define ICONV_SET_DISCARD_ILSEQ 4 /* const int *argument */ 122#define ICONV_SET_HOOKS 5 /* const struct iconv_hooks *argument */ 123 124/* Listing of locale independent encodings. */ 125#define iconvlist libiconvlist 126extern LIBICONV_DLL_EXPORTED void iconvlist (int (*do_one) (unsigned int namescount, 127 const char * const * names, 128 void* data), 129 void* data); 130 131/* Canonicalize an encoding name. 132 The result is either a canonical encoding name, or name itself. */ 133extern LIBICONV_DLL_EXPORTED const char * iconv_canonicalize (const char * name); 134 135/* Support for relocatable packages. */ 136 137/* Sets the original and the current installation prefix of the package. 138 Relocation simply replaces a pathname starting with the original prefix 139 by the corresponding pathname with the current prefix instead. Both 140 prefixes should be directory names without trailing slash (i.e. use "" 141 instead of "/"). */ 142extern LIBICONV_DLL_EXPORTED void libiconv_set_relocation_prefix (const char *orig_prefix, 143 const char *curr_prefix); 144 145#endif 146 147 148#ifdef __cplusplus 149} 150#endif 151 152 153#endif /* _LIBICONV_H */ 154