xref: /freebsd/include/iconv.h (revision 8d20be1e22095c27faf8fe8b2f0d089739cc742e)
1 /*	$FreeBSD$	*/
2 /*	$NetBSD: iconv.h,v 1.6 2005/02/03 04:39:32 perry Exp $	*/
3 
4 /*-
5  * Copyright (c) 2003 Citrus Project,
6  * Copyright (c) 2009, 2010 Gabor Kovesdan <gabor@FreeBSD.org>
7  * All rights reserved.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  * 1. Redistributions of source code must retain the above copyright
13  *    notice, this list of conditions and the following disclaimer.
14  * 2. Redistributions in binary form must reproduce the above copyright
15  *    notice, this list of conditions and the following disclaimer in the
16  *    documentation and/or other materials provided with the distribution.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
19  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
22  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28  * SUCH DAMAGE.
29  *
30  */
31 
32 #ifndef _ICONV_H_
33 #define _ICONV_H_
34 
35 #include <sys/cdefs.h>
36 #include <sys/types.h>
37 
38 #include <wchar.h>
39 
40 #include <sys/cdefs.h>
41 #include <sys/types.h>
42 
43 #include <_libiconv_compat.h>
44 #ifdef __LIBICONV_COMPAT
45 #define libiconv_open		iconv_open
46 #define libiconv_close		iconv_close
47 #define libiconv		iconv
48 #define libiconv_t		iconv_t
49 #endif
50 #ifdef __cplusplus
51 typedef	bool	__iconv_bool;
52 #elif __STDC_VERSION__ >= 199901L
53 typedef	_Bool	__iconv_bool;
54 #else
55 typedef	int	__iconv_bool;
56 #endif
57 
58 struct __tag_iconv_t;
59 typedef	struct __tag_iconv_t	*iconv_t;
60 
61 __BEGIN_DECLS
62 iconv_t	iconv_open(const char *, const char *);
63 size_t	iconv(iconv_t, const char ** __restrict,
64 	      size_t * __restrict, char ** __restrict,
65 	      size_t * __restrict);
66 int	iconv_close(iconv_t);
67 /*
68  * non-portable interfaces for iconv
69  */
70 int	__iconv_get_list(char ***, size_t *, __iconv_bool);
71 void	__iconv_free_list(char **, size_t);
72 size_t	__iconv(iconv_t, const char **, size_t *, char **,
73 		     size_t *, __uint32_t, size_t *);
74 #define __ICONV_F_HIDE_INVALID	0x0001
75 
76 /*
77  * GNU interfaces for iconv
78  */
79 #ifdef __LIBICONV_COMPAT
80 #define libiconv_open_into		iconv_open_into
81 #define libiconvctl			iconvctl
82 #define libiconvlist			iconvlist
83 #define libiconv_set_relocation_prefix	iconv_set_relocation_prefix
84 #endif
85 
86 /* We have iconvctl() */
87 #define _ICONV_VERSION	0x0108
88 extern int _iconv_version;
89 
90 #ifdef __LIBICONV_COMPAT
91 #define _libiconv_version		_iconv_version
92 #define _LIBICONV_VERSION		_ICONV_VERSION
93 #endif
94 
95 typedef struct {
96 	void	*spaceholder[64];
97 } iconv_allocation_t;
98 
99 int	 iconv_open_into(const char *, const char *, iconv_allocation_t *);
100 void	 iconv_set_relocation_prefix(const char *orig_prefix,
101 	     const char *curr_prefix);
102 
103 /*
104  * iconvctl() request macros
105  */
106 #define ICONV_TRIVIALP		0
107 #define	ICONV_GET_TRANSLITERATE	1
108 #define	ICONV_SET_TRANSLITERATE	2
109 #define ICONV_GET_DISCARD_ILSEQ	3
110 #define ICONV_SET_DISCARD_ILSEQ	4
111 #define ICONV_SET_HOOKS		5
112 #define ICONV_SET_FALLBACKS	6
113 
114 typedef void (*iconv_unicode_char_hook) (unsigned int mbr, void *data);
115 typedef void (*iconv_wide_char_hook) (wchar_t wc, void *data);
116 
117 struct iconv_hooks {
118 	iconv_unicode_char_hook		 uc_hook;
119 	iconv_wide_char_hook		 wc_hook;
120 	void				*data;
121 };
122 
123 /*
124  * Fallbacks aren't supported but type definitions are provided for
125  * source compatibility.
126  */
127 typedef void (*iconv_unicode_mb_to_uc_fallback) (const char*,
128 		size_t, void (*write_replacement) (const unsigned int *,
129 		size_t, void*),	void*, void*);
130 typedef void (*iconv_unicode_uc_to_mb_fallback) (unsigned int,
131 		void (*write_replacement) (const char *, size_t, void*),
132 		void*, void*);
133 typedef void (*iconv_wchar_mb_to_wc_fallback) (const char*, size_t,
134 		void (*write_replacement) (const wchar_t *, size_t, void*),
135 		void*, void*);
136 typedef void (*iconv_wchar_wc_to_mb_fallback) (wchar_t,
137 		void (*write_replacement) (const char *, size_t, void*),
138 		void*, void*);
139 
140 struct iconv_fallbacks {
141 	iconv_unicode_mb_to_uc_fallback	 mb_to_uc_fallback;
142 	iconv_unicode_uc_to_mb_fallback  uc_to_mb_fallback;
143 	iconv_wchar_mb_to_wc_fallback	 mb_to_wc_fallback;
144 	iconv_wchar_wc_to_mb_fallback	 wc_to_mb_fallback;
145 	void				*data;
146 };
147 
148 
149 void		 iconvlist(int (*do_one) (unsigned int, const char * const *,
150 		    void *), void *);
151 const char	*iconv_canonicalize(const char *);
152 int		 iconvctl(iconv_t, int, void *);
153 __END_DECLS
154 
155 #endif /* !_ICONV_H_ */
156