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