xref: /dragonfly/sys/sys/iconv.h (revision dc2f79cd)
1 /*-
2  * Copyright (c) 2000-2001 Boris Popov
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24  * SUCH DAMAGE.
25  *
26  * $FreeBSD: head/sys/sys/iconv.h 298981 2016-05-03 15:14:17Z pfg $
27  */
28 #ifndef _SYS_ICONV_H_
29 #define _SYS_ICONV_H_
30 
31 #define	ICONV_CSNMAXLEN		31	/* maximum length of charset name */
32 #define	ICONV_CNVNMAXLEN	31	/* maximum length of converter name */
33 /* maximum size of data associated with cs pair */
34 #define	ICONV_CSMAXDATALEN	(sizeof(caddr_t) * 0x200 + sizeof(uint32_t) * 0x200 * 0x80)
35 
36 #define	XLAT16_ACCEPT_NULL_OUT		0x01000000
37 #define	XLAT16_ACCEPT_NULL_IN		0x02000000
38 #define	XLAT16_HAS_LOWER_CASE		0x04000000
39 #define	XLAT16_HAS_UPPER_CASE		0x08000000
40 #define	XLAT16_HAS_FROM_LOWER_CASE	0x10000000
41 #define	XLAT16_HAS_FROM_UPPER_CASE	0x20000000
42 #define	XLAT16_IS_3BYTE_CHR		0x40000000
43 
44 #define	KICONV_LOWER		1	/* tolower converted character */
45 #define	KICONV_UPPER		2	/* toupper converted character */
46 #define	KICONV_FROM_LOWER	4	/* tolower source character, then convert */
47 #define	KICONV_FROM_UPPER	8	/* toupper source character, then convert */
48 #define	KICONV_WCTYPE		16	/* towlower/towupper characters */
49 
50 #define	ENCODING_UNICODE	"UTF-16BE"
51 #define	KICONV_WCTYPE_NAME	"_wctype"
52 
53 /*
54  * Entry for cslist sysctl
55  */
56 #define	ICONV_CSPAIR_INFO_VER	1
57 
58 struct iconv_cspair_info {
59 	int	cs_version;
60 	int	cs_id;
61 	int	cs_base;
62 	int	cs_refcount;
63 	char	cs_to[ICONV_CSNMAXLEN];
64 	char	cs_from[ICONV_CSNMAXLEN];
65 };
66 
67 /*
68  * Parameters for 'add' sysctl
69  */
70 #define	ICONV_ADD_VER	1
71 
72 struct iconv_add_in {
73 	int	ia_version;
74 	char	ia_converter[ICONV_CNVNMAXLEN];
75 	char	ia_to[ICONV_CSNMAXLEN];
76 	char	ia_from[ICONV_CSNMAXLEN];
77 	int	ia_datalen;
78 	const void *ia_data;
79 };
80 
81 struct iconv_add_out {
82 	int	ia_csid;
83 };
84 
85 #ifndef _KERNEL
86 
87 #include <sys/cdefs.h>
88 #include <sys/types.h>
89 
90 __BEGIN_DECLS
91 
92 #define	KICONV_VENDOR_MICSFT	1	/* Microsoft Vendor Code for quirk */
93 
94 int   kiconv_add_xlat_table(const char *, const char *, const u_char *);
95 int   kiconv_add_xlat16_cspair(const char *, const char *, int);
96 int   kiconv_add_xlat16_cspairs(const char *, const char *);
97 int   kiconv_add_xlat16_table(const char *, const char *, const void *, int);
98 int   kiconv_lookupconv(const char *drvname);
99 int   kiconv_lookupcs(const char *tocode, const char *fromcode);
100 const char *kiconv_quirkcs(const char *, int);
101 
102 __END_DECLS
103 
104 #else /* _KERNEL */
105 
106 #include <sys/kobj.h>
107 #include <sys/module.h>			/* can't avoid that */
108 #include <sys/queue.h>			/* can't avoid that */
109 #include <sys/sysctl.h>			/* can't avoid that */
110 
111 struct iconv_cspair;
112 struct iconv_cspairdata;
113 
114 /*
115  * iconv converter class definition
116  */
117 struct iconv_converter_class {
118 	KOBJ_CLASS_FIELDS;
119 	TAILQ_ENTRY(iconv_converter_class)	cc_link;
120 };
121 
122 struct iconv_cspair {
123 	int		cp_id;		/* unique id of charset pair */
124 	int		cp_refcount;	/* number of references from other pairs */
125 	const char *	cp_from;
126 	const char *	cp_to;
127 	void *		cp_data;
128 	struct iconv_converter_class * cp_dcp;
129 	struct iconv_cspair *cp_base;
130 	TAILQ_ENTRY(iconv_cspair)	cp_link;
131 };
132 
133 #define	KICONV_CONVERTER(name,size)			\
134     static struct iconv_converter_class iconv_ ## name ## _class = { \
135 	"iconv_"#name, iconv_ ## name ## _methods, size, NULL \
136     };							\
137     static moduledata_t iconv_ ## name ## _mod = {	\
138 	"iconv_"#name, iconv_converter_handler,		\
139 	(void*)&iconv_ ## name ## _class		\
140     };							\
141     DECLARE_MODULE(iconv_ ## name, iconv_ ## name ## _mod, SI_SUB_DRIVERS, SI_ORDER_ANY)
142 
143 #define	KICONV_CES(name,size)				\
144     static DEFINE_CLASS(iconv_ces_ ## name, iconv_ces_ ## name ## _methods, (size)); \
145     static moduledata_t iconv_ces_ ## name ## _mod = {	\
146 	"iconv_ces_"#name, iconv_cesmod_handler,	\
147 	(void*)&iconv_ces_ ## name ## _class		\
148     };							\
149     DECLARE_MODULE(iconv_ces_ ## name, iconv_ces_ ## name ## _mod, SI_SUB_DRIVERS, SI_ORDER_ANY)
150 
151 #ifdef MALLOC_DECLARE
152 MALLOC_DECLARE(M_ICONV);
153 #endif
154 
155 /*
156  * Basic conversion functions
157  */
158 int iconv_open(const char *to, const char *from, void **handle);
159 int iconv_close(void *handle);
160 int iconv_conv(void *handle, const char **inbuf,
161 	size_t *inbytesleft, char **outbuf, size_t *outbytesleft);
162 int iconv_conv_case(void *handle, const char **inbuf,
163 	size_t *inbytesleft, char **outbuf, size_t *outbytesleft, int casetype);
164 int iconv_convchr(void *handle, const char **inbuf,
165 	size_t *inbytesleft, char **outbuf, size_t *outbytesleft);
166 int iconv_convchr_case(void *handle, const char **inbuf,
167 	size_t *inbytesleft, char **outbuf, size_t *outbytesleft, int casetype);
168 int iconv_add(const char *converter, const char *to, const char *from);
169 char* iconv_convstr(void *handle, char *dst, const char *src);
170 void* iconv_convmem(void *handle, void *dst, const void *src, int size);
171 int iconv_vfs_refcount(const char *fsname);
172 
173 int towlower(int c, void *handle);
174 int towupper(int c, void *handle);
175 
176 /*
177  * Bridge struct of iconv functions
178  */
179 struct iconv_functions {
180 	int (*open)(const char *to, const char *from, void **handle);
181 	int (*close)(void *handle);
182 	int (*conv)(void *handle, const char **inbuf, size_t *inbytesleft,
183 		char **outbuf, size_t *outbytesleft);
184 	int (*conv_case)(void *handle, const char **inbuf, size_t *inbytesleft,
185 		char **outbuf, size_t *outbytesleft, int casetype);
186 	int (*convchr)(void *handle, const char **inbuf, size_t *inbytesleft,
187 		char **outbuf, size_t *outbytesleft);
188 	int (*convchr_case)(void *handle, const char **inbuf, size_t *inbytesleft,
189 		char **outbuf, size_t *outbytesleft, int casetype);
190 };
191 
192 #define VFS_DECLARE_ICONV(fsname)					\
193 	static struct iconv_functions fsname ## _iconv_core = {		\
194 		iconv_open,						\
195 		iconv_close,						\
196 		iconv_conv,						\
197 		iconv_conv_case,					\
198 		iconv_convchr,						\
199 		iconv_convchr_case					\
200 	};								\
201 	extern struct iconv_functions *fsname ## _iconv;		\
202 	static int fsname ## _iconv_mod_handler(module_t mod,		\
203 		int type, void *d);					\
204 	static int							\
205 	fsname ## _iconv_mod_handler(module_t mod, int type, void *d)	\
206 	{								\
207 		int error = 0;						\
208 		switch(type) {						\
209 		case MOD_LOAD:						\
210 			fsname ## _iconv = & fsname ## _iconv_core;	\
211 			break;						\
212 		case MOD_UNLOAD:					\
213 			error = iconv_vfs_refcount(#fsname);		\
214 			if (error)					\
215 				return (EBUSY);				\
216 			fsname ## _iconv = NULL;			\
217 			break;						\
218 		default:						\
219 			error = EINVAL;					\
220 			break;						\
221 		}							\
222 		return (error);						\
223 	}								\
224 	static moduledata_t fsname ## _iconv_mod = {			\
225 		#fsname"_iconv",					\
226 		fsname ## _iconv_mod_handler,				\
227 		NULL							\
228 	};								\
229 	DECLARE_MODULE(fsname ## _iconv, fsname ## _iconv_mod,		\
230 		       SI_SUB_DRIVERS, SI_ORDER_ANY);			\
231 	MODULE_DEPEND(fsname ## _iconv, fsname, 1, 1, 1);		\
232 	MODULE_DEPEND(fsname ## _iconv, libiconv, 2, 2, 2);		\
233 	MODULE_VERSION(fsname ## _iconv, 1)
234 
235 /*
236  * Internal functions
237  */
238 int iconv_lookupcp(char **cpp, const char *s);
239 
240 int iconv_converter_initstub(struct iconv_converter_class *dp);
241 int iconv_converter_donestub(struct iconv_converter_class *dp);
242 int iconv_converter_tolowerstub(int c, void *handle);
243 int iconv_converter_handler(module_t mod, int type, void *data);
244 
245 #ifdef ICONV_DEBUG
246 #define ICDEBUG(format, ...) printf("%s: "format, __func__ , ## __VA_ARGS__)
247 #else
248 #define ICDEBUG(format, ...)
249 #endif
250 
251 #endif /* !_KERNEL */
252 
253 #endif /* !_SYS_ICONV_H_ */
254