Annotation of embedaddon/libiconv/include/iconv.h.in, revision 1.1.1.1
1.1 misho 1: /* Copyright (C) 1999-2003, 2005-2006, 2008-2009 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 0x010D /* version number: (major<<8) + minor */
25: extern @DLL_VARIABLE@ int _libiconv_version; /* Likewise */
26:
27: /* We would like to #include any system header file which could define
28: iconv_t, 1. in order to eliminate the risk that the user gets compilation
29: errors because some other system header file includes /usr/include/iconv.h
30: which defines iconv_t or declares iconv after this file, 2. when compiling
31: for LIBICONV_PLUG, we need the proper iconv_t type in order to produce
32: binary compatible code.
33: But gcc's #include_next is not portable. Thus, once libiconv's iconv.h
34: has been installed in /usr/local/include, there is no way any more to
35: include the original /usr/include/iconv.h. We simply have to get away
36: without it.
37: Ad 1. The risk that a system header file does
38: #include "iconv.h" or #include_next "iconv.h"
39: is small. They all do #include <iconv.h>.
40: Ad 2. The iconv_t type is a pointer type in all cases I have seen. (It
41: has to be a scalar type because (iconv_t)(-1) is a possible return value
42: from iconv_open().) */
43:
44: /* Define iconv_t ourselves. */
45: #undef iconv_t
46: #define iconv_t libiconv_t
47: typedef void* iconv_t;
48:
49: /* Get size_t declaration.
50: Get wchar_t declaration if it exists. */
51: #include <stddef.h>
52:
53: /* Get errno declaration and values. */
54: #include <errno.h>
55: /* Some systems, like SunOS 4, don't have EILSEQ. Some systems, like BSD/OS,
56: have EILSEQ in a different header. On these systems, define EILSEQ
57: ourselves. */
58: #ifndef EILSEQ
59: #define EILSEQ @EILSEQ@
60: #endif
61:
62:
63: #ifdef __cplusplus
64: extern "C" {
65: #endif
66:
67:
68: /* Allocates descriptor for code conversion from encoding ‘fromcode’ to
69: encoding ‘tocode’. */
70: #ifndef LIBICONV_PLUG
71: #define iconv_open libiconv_open
72: #endif
73: extern iconv_t iconv_open (const char* tocode, const char* fromcode);
74:
75: /* Converts, using conversion descriptor ‘cd’, at most ‘*inbytesleft’ bytes
76: starting at ‘*inbuf’, writing at most ‘*outbytesleft’ bytes starting at
77: ‘*outbuf’.
78: Decrements ‘*inbytesleft’ and increments ‘*inbuf’ by the same amount.
79: Decrements ‘*outbytesleft’ and increments ‘*outbuf’ by the same amount. */
80: #ifndef LIBICONV_PLUG
81: #define iconv libiconv
82: #endif
83: extern size_t iconv (iconv_t cd, @ICONV_CONST@ char* * inbuf, size_t *inbytesleft, char* * outbuf, size_t *outbytesleft);
84:
85: /* Frees resources allocated for conversion descriptor ‘cd’. */
86: #ifndef LIBICONV_PLUG
87: #define iconv_close libiconv_close
88: #endif
89: extern int iconv_close (iconv_t cd);
90:
91:
92: #ifndef LIBICONV_PLUG
93:
94: /* Nonstandard extensions. */
95:
96: #if @USE_MBSTATE_T@
97: #if @BROKEN_WCHAR_H@
98: /* Tru64 with Desktop Toolkit C has a bug: <stdio.h> must be included before
99: <wchar.h>.
100: BSD/OS 4.0.1 has a bug: <stddef.h>, <stdio.h> and <time.h> must be
101: included before <wchar.h>. */
102: #include <stddef.h>
103: #include <stdio.h>
104: #include <time.h>
105: #endif
106: #include <wchar.h>
107: #endif
108:
109: /* A type that holds all memory needed by a conversion descriptor.
110: A pointer to such an object can be used as an iconv_t. */
111: typedef struct {
112: void* dummy1[28];
113: #if @USE_MBSTATE_T@
114: mbstate_t dummy2;
115: #endif
116: } iconv_allocation_t;
117:
118: /* Allocates descriptor for code conversion from encoding ‘fromcode’ to
119: encoding ‘tocode’ into preallocated memory. Returns an error indicator
120: (0 or -1 with errno set). */
121: #define iconv_open_into libiconv_open_into
122: extern int iconv_open_into (const char* tocode, const char* fromcode,
123: iconv_allocation_t* resultp);
124:
125: /* Control of attributes. */
126: #define iconvctl libiconvctl
127: extern int iconvctl (iconv_t cd, int request, void* argument);
128:
129: /* Hook performed after every successful conversion of a Unicode character. */
130: typedef void (*iconv_unicode_char_hook) (unsigned int uc, void* data);
131: /* Hook performed after every successful conversion of a wide character. */
132: typedef void (*iconv_wide_char_hook) (wchar_t wc, void* data);
133: /* Set of hooks. */
134: struct iconv_hooks {
135: iconv_unicode_char_hook uc_hook;
136: iconv_wide_char_hook wc_hook;
137: void* data;
138: };
139:
140: /* Fallback function. Invoked when a small number of bytes could not be
141: converted to a Unicode character. This function should process all
142: bytes from inbuf and may produce replacement Unicode characters by calling
143: the write_replacement callback repeatedly. */
144: typedef void (*iconv_unicode_mb_to_uc_fallback)
145: (const char* inbuf, size_t inbufsize,
146: void (*write_replacement) (const unsigned int *buf, size_t buflen,
147: void* callback_arg),
148: void* callback_arg,
149: void* data);
150: /* Fallback function. Invoked when a Unicode character could not be converted
151: to the target encoding. This function should process the character and
152: may produce replacement bytes (in the target encoding) by calling the
153: write_replacement callback repeatedly. */
154: typedef void (*iconv_unicode_uc_to_mb_fallback)
155: (unsigned int code,
156: void (*write_replacement) (const char *buf, size_t buflen,
157: void* callback_arg),
158: void* callback_arg,
159: void* data);
160: #if @HAVE_WCHAR_T@
161: /* Fallback function. Invoked when a number of bytes could not be converted to
162: a wide character. This function should process all bytes from inbuf and may
163: produce replacement wide characters by calling the write_replacement
164: callback repeatedly. */
165: typedef void (*iconv_wchar_mb_to_wc_fallback)
166: (const char* inbuf, size_t inbufsize,
167: void (*write_replacement) (const wchar_t *buf, size_t buflen,
168: void* callback_arg),
169: void* callback_arg,
170: void* data);
171: /* Fallback function. Invoked when a wide character could not be converted to
172: the target encoding. This function should process the character and may
173: produce replacement bytes (in the target encoding) by calling the
174: write_replacement callback repeatedly. */
175: typedef void (*iconv_wchar_wc_to_mb_fallback)
176: (wchar_t code,
177: void (*write_replacement) (const char *buf, size_t buflen,
178: void* callback_arg),
179: void* callback_arg,
180: void* data);
181: #else
182: /* If the wchar_t type does not exist, these two fallback functions are never
183: invoked. Their argument list therefore does not matter. */
184: typedef void (*iconv_wchar_mb_to_wc_fallback) ();
185: typedef void (*iconv_wchar_wc_to_mb_fallback) ();
186: #endif
187: /* Set of fallbacks. */
188: struct iconv_fallbacks {
189: iconv_unicode_mb_to_uc_fallback mb_to_uc_fallback;
190: iconv_unicode_uc_to_mb_fallback uc_to_mb_fallback;
191: iconv_wchar_mb_to_wc_fallback mb_to_wc_fallback;
192: iconv_wchar_wc_to_mb_fallback wc_to_mb_fallback;
193: void* data;
194: };
195:
196: /* Requests for iconvctl. */
197: #define ICONV_TRIVIALP 0 /* int *argument */
198: #define ICONV_GET_TRANSLITERATE 1 /* int *argument */
199: #define ICONV_SET_TRANSLITERATE 2 /* const int *argument */
200: #define ICONV_GET_DISCARD_ILSEQ 3 /* int *argument */
201: #define ICONV_SET_DISCARD_ILSEQ 4 /* const int *argument */
202: #define ICONV_SET_HOOKS 5 /* const struct iconv_hooks *argument */
203: #define ICONV_SET_FALLBACKS 6 /* const struct iconv_fallbacks *argument */
204:
205: /* Listing of locale independent encodings. */
206: #define iconvlist libiconvlist
207: extern void iconvlist (int (*do_one) (unsigned int namescount,
208: const char * const * names,
209: void* data),
210: void* data);
211:
212: /* Canonicalize an encoding name.
213: The result is either a canonical encoding name, or name itself. */
214: extern const char * iconv_canonicalize (const char * name);
215:
216: /* Support for relocatable packages. */
217:
218: /* Sets the original and the current installation prefix of the package.
219: Relocation simply replaces a pathname starting with the original prefix
220: by the corresponding pathname with the current prefix instead. Both
221: prefixes should be directory names without trailing slash (i.e. use ""
222: instead of "/"). */
223: extern void libiconv_set_relocation_prefix (const char *orig_prefix,
224: const char *curr_prefix);
225:
226: #endif
227:
228:
229: #ifdef __cplusplus
230: }
231: #endif
232:
233:
234: #endif /* _LIBICONV_H */
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>
![[BACK]](/icons/cvsweb/back.gif){kind=icon}
Return to iconv.h.in CVS log ![[TXT]](/icons/cvsweb/text.gif){kind=icon}
![[DIR]](/icons/cvsweb/dir.gif){kind=icon}
Up to [ELWIX - Embedded LightWeight unIX -] / embedaddon / libiconv / include