]>
Commit | Line | Data |
---|---|---|
d4697bc9 | 1 | /* Copyright (C) 1997-2014 Free Software Foundation, Inc. |
e62c19f1 UD |
2 | This file is part of the GNU C Library. |
3 | Contributed by Ulrich Drepper <drepper@cygnus.com>, 1997. | |
4 | ||
5 | The GNU C Library is free software; you can redistribute it and/or | |
41bdb6e2 AJ |
6 | modify it under the terms of the GNU Lesser General Public |
7 | License as published by the Free Software Foundation; either | |
8 | version 2.1 of the License, or (at your option) any later version. | |
e62c19f1 UD |
9 | |
10 | The GNU C Library is distributed in the hope that it will be useful, | |
11 | but WITHOUT ANY WARRANTY; without even the implied warranty of | |
12 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
41bdb6e2 | 13 | Lesser General Public License for more details. |
e62c19f1 | 14 | |
41bdb6e2 | 15 | You should have received a copy of the GNU Lesser General Public |
59ba27a6 PE |
16 | License along with the GNU C Library; if not, see |
17 | <http://www.gnu.org/licenses/>. */ | |
e62c19f1 UD |
18 | |
19 | #ifndef _GCONV_INT_H | |
20 | #define _GCONV_INT_H 1 | |
21 | ||
22 | #include "gconv.h" | |
c5738211 | 23 | #include <stdlib.h> /* For alloca used in macro below. */ |
6111babe RM |
24 | #include <ctype.h> /* For __toupper_l used in macro below. */ |
25 | #include <string.h> /* For strlen et al used in macro below. */ | |
9e26f129 | 26 | #include <bits/libc-lock.h> |
e62c19f1 UD |
27 | |
28 | __BEGIN_DECLS | |
29 | ||
30 | ||
d6204268 UD |
31 | /* Type to represent search path. */ |
32 | struct path_elem | |
33 | { | |
34 | const char *name; | |
35 | size_t len; | |
36 | }; | |
37 | ||
38 | /* Variable with search path for `gconv' implementation. */ | |
aa32f798 | 39 | extern struct path_elem *__gconv_path_elem attribute_hidden; |
d6204268 | 40 | /* Maximum length of a single path element. */ |
aa32f798 | 41 | extern size_t __gconv_max_path_elem_len attribute_hidden; |
d6204268 UD |
42 | |
43 | ||
9a321276 | 44 | /* Structure for alias definition. Simply two strings. */ |
e62c19f1 UD |
45 | struct gconv_alias |
46 | { | |
17427edd UD |
47 | char *fromname; |
48 | char *toname; | |
e62c19f1 UD |
49 | }; |
50 | ||
51 | ||
382466e0 | 52 | /* How many character should be converted in one call? */ |
8619129f | 53 | #define GCONV_NCHAR_GOAL 8160 |
e62c19f1 UD |
54 | |
55 | ||
0d9f6793 UD |
56 | /* Structure describing one loaded shared object. This normally are |
57 | objects to perform conversation but as a special case the db shared | |
58 | object is also handled. */ | |
d64b6ad0 | 59 | struct __gconv_loaded_object |
0d9f6793 | 60 | { |
b79f74cd | 61 | /* Name of the object. It must be the first structure element. */ |
0d9f6793 UD |
62 | const char *name; |
63 | ||
64 | /* Reference counter for the db functionality. If no conversion is | |
65 | needed we unload the db library. */ | |
66 | int counter; | |
67 | ||
68 | /* The handle for the shared object. */ | |
b3fc5f84 | 69 | void *handle; |
0d9f6793 UD |
70 | |
71 | /* Pointer to the functions the module defines. */ | |
d64b6ad0 UD |
72 | __gconv_fct fct; |
73 | __gconv_init_fct init_fct; | |
74 | __gconv_end_fct end_fct; | |
0d9f6793 UD |
75 | }; |
76 | ||
77 | ||
e62c19f1 UD |
78 | /* Description for an available conversion module. */ |
79 | struct gconv_module | |
80 | { | |
d2dfc5de | 81 | const char *from_string; |
0d9f6793 | 82 | const char *to_string; |
e62c19f1 | 83 | |
fab6d621 UD |
84 | int cost_hi; |
85 | int cost_lo; | |
e62c19f1 | 86 | |
0d9f6793 | 87 | const char *module_name; |
2bd60880 UD |
88 | |
89 | struct gconv_module *left; /* Prefix smaller. */ | |
90 | struct gconv_module *same; /* List of entries with identical prefix. */ | |
2bd60880 | 91 | struct gconv_module *right; /* Prefix larger. */ |
e62c19f1 UD |
92 | }; |
93 | ||
94 | ||
d6204268 UD |
95 | /* Internal data structure to represent transliteration module. */ |
96 | struct trans_struct | |
97 | { | |
98 | const char *name; | |
99 | struct trans_struct *next; | |
100 | ||
101 | const char **csnames; | |
102 | size_t ncsnames; | |
103 | __gconv_trans_fct trans_fct; | |
104 | __gconv_trans_context_fct trans_context_fct; | |
105 | __gconv_trans_init_fct trans_init_fct; | |
106 | __gconv_trans_end_fct trans_end_fct; | |
107 | }; | |
108 | ||
109 | ||
c90a2db6 UD |
110 | /* Flags for `gconv_open'. */ |
111 | enum | |
112 | { | |
113 | GCONV_AVOID_NOCONV = 1 << 0 | |
114 | }; | |
115 | ||
7b503bcc UD |
116 | /* When GCONV_AVOID_NOCONV is set and no conversion is needed, |
117 | __GCONV_NULCONV should be returned. */ | |
118 | enum | |
119 | { | |
120 | __GCONV_NULCONV = -1 | |
121 | }; | |
c90a2db6 | 122 | |
e62c19f1 UD |
123 | /* Global variables. */ |
124 | ||
125 | /* Database of alias names. */ | |
230491f0 | 126 | extern void *__gconv_alias_db attribute_hidden; |
e62c19f1 UD |
127 | |
128 | /* Array with available modules. */ | |
129 | extern size_t __gconv_nmodules; | |
230491f0 | 130 | extern struct gconv_module *__gconv_modules_db attribute_hidden; |
e62c19f1 | 131 | |
6b98979f | 132 | /* Value of the GCONV_PATH environment variable. */ |
aa32f798 | 133 | extern const char *__gconv_path_envvar attribute_hidden; |
6b98979f | 134 | |
9e26f129 | 135 | /* Lock for the conversion database content. */ |
6f8a7dff | 136 | __libc_lock_define (extern, __gconv_lock attribute_hidden) |
9e26f129 | 137 | |
e62c19f1 | 138 | |
17c389fc UD |
139 | /* The gconv functions expects the name to be in upper case and complete, |
140 | including the trailing slashes if necessary. */ | |
323fb88d | 141 | #define norm_add_slashes(str,suffix) \ |
17c389fc UD |
142 | ({ \ |
143 | const char *cp = (str); \ | |
144 | char *result; \ | |
145 | char *tmp; \ | |
146 | size_t cnt = 0; \ | |
db2f05ba | 147 | const size_t suffix_len = strlen (suffix); \ |
17c389fc UD |
148 | \ |
149 | while (*cp != '\0') \ | |
150 | if (*cp++ == '/') \ | |
151 | ++cnt; \ | |
152 | \ | |
c5738211 | 153 | tmp = result = __alloca (cp - (str) + 3 + suffix_len); \ |
17c389fc UD |
154 | cp = (str); \ |
155 | while (*cp != '\0') \ | |
4b5b009c | 156 | *tmp++ = __toupper_l (*cp++, _nl_C_locobj_ptr); \ |
17c389fc UD |
157 | if (cnt < 2) \ |
158 | { \ | |
159 | *tmp++ = '/'; \ | |
160 | if (cnt < 1) \ | |
323fb88d UD |
161 | { \ |
162 | *tmp++ = '/'; \ | |
db2f05ba | 163 | if (suffix_len != 0) \ |
323fb88d UD |
164 | tmp = __mempcpy (tmp, suffix, suffix_len); \ |
165 | } \ | |
17c389fc UD |
166 | } \ |
167 | *tmp = '\0'; \ | |
168 | result; \ | |
169 | }) | |
170 | ||
171 | ||
e62c19f1 | 172 | /* Return in *HANDLE decriptor for transformation from FROMSET to TOSET. */ |
55985355 UD |
173 | extern int __gconv_open (const char *toset, const char *fromset, |
174 | __gconv_t *handle, int flags) | |
e62c19f1 UD |
175 | internal_function; |
176 | ||
177 | /* Free resources associated with transformation descriptor CD. */ | |
d64b6ad0 | 178 | extern int __gconv_close (__gconv_t cd) |
e62c19f1 UD |
179 | internal_function; |
180 | ||
181 | /* Transform at most *INBYTESLEFT bytes from buffer starting at *INBUF | |
182 | according to rules described by CD and place up to *OUTBYTESLEFT | |
63e04088 | 183 | bytes in buffer starting at *OUTBUF. Return number of non-identical |
38677ace | 184 | conversions in *IRREVERSIBLE if this pointer is not null. */ |
55985355 UD |
185 | extern int __gconv (__gconv_t cd, const unsigned char **inbuf, |
186 | const unsigned char *inbufend, unsigned char **outbuf, | |
38677ace | 187 | unsigned char *outbufend, size_t *irreversible) |
e62c19f1 UD |
188 | internal_function; |
189 | ||
190 | /* Return in *HANDLE a pointer to an array with *NSTEPS elements describing | |
191 | the single steps necessary for transformation from FROMSET to TOSET. */ | |
55985355 UD |
192 | extern int __gconv_find_transform (const char *toset, const char *fromset, |
193 | struct __gconv_step **handle, | |
194 | size_t *nsteps, int flags) | |
e62c19f1 UD |
195 | internal_function; |
196 | ||
6b98979f UD |
197 | /* Search for transformation in cache data. */ |
198 | extern int __gconv_lookup_cache (const char *toset, const char *fromset, | |
199 | struct __gconv_step **handle, size_t *nsteps, | |
200 | int flags) | |
201 | internal_function; | |
202 | ||
9a018f6c UD |
203 | /* Compare the two name for whether they are after alias expansion the |
204 | same. This function uses the cache and fails if none is | |
205 | loaded. */ | |
206 | extern int __gconv_compare_alias_cache (const char *name1, const char *name2, | |
207 | int *result) internal_function; | |
208 | ||
6b98979f UD |
209 | /* Free data associated with a step's structure. */ |
210 | extern void __gconv_release_step (struct __gconv_step *step) | |
211 | internal_function; | |
212 | ||
e62c19f1 | 213 | /* Read all the configuration data and cache it. */ |
dff07c4b | 214 | extern void __gconv_read_conf (void) attribute_hidden; |
e62c19f1 | 215 | |
6b98979f UD |
216 | /* Try to read module cache file. */ |
217 | extern int __gconv_load_cache (void) internal_function; | |
218 | ||
230491f0 UD |
219 | /* Retrieve pointer to internal cache. */ |
220 | extern void *__gconv_get_cache (void); | |
221 | ||
222 | /* Retrieve pointer to internal module database. */ | |
223 | extern struct gconv_module *__gconv_get_modules_db (void); | |
224 | ||
225 | /* Retrieve pointer to internal alias database. */ | |
226 | extern void *__gconv_get_alias_db (void); | |
227 | ||
d6204268 | 228 | /* Determine the directories we are looking in. */ |
dff07c4b | 229 | extern void __gconv_get_path (void) internal_function; |
d6204268 | 230 | |
e62c19f1 | 231 | /* Comparison function to search alias. */ |
dff07c4b UD |
232 | extern int __gconv_alias_compare (const void *p1, const void *p2) |
233 | attribute_hidden; | |
e62c19f1 UD |
234 | |
235 | /* Clear reference to transformation step implementations which might | |
236 | cause the code to be unloaded. */ | |
55985355 UD |
237 | extern int __gconv_close_transform (struct __gconv_step *steps, |
238 | size_t nsteps) | |
e62c19f1 UD |
239 | internal_function; |
240 | ||
0db59742 UD |
241 | /* Free all resources allocated for the transformation record when |
242 | using the cache. */ | |
243 | extern void __gconv_release_cache (struct __gconv_step *steps, size_t nsteps) | |
244 | internal_function; | |
245 | ||
e62c19f1 UD |
246 | /* Load shared object named by NAME. If already loaded increment reference |
247 | count. */ | |
55985355 | 248 | extern struct __gconv_loaded_object *__gconv_find_shlib (const char *name) |
e62c19f1 UD |
249 | internal_function; |
250 | ||
251 | /* Release shared object. If no further reference is available unload | |
252 | the object. */ | |
b79f74cd | 253 | extern void __gconv_release_shlib (struct __gconv_loaded_object *handle) |
e62c19f1 UD |
254 | internal_function; |
255 | ||
256 | /* Fill STEP with information about builtin module with NAME. */ | |
55985355 UD |
257 | extern void __gconv_get_builtin_trans (const char *name, |
258 | struct __gconv_step *step) | |
e62c19f1 UD |
259 | internal_function; |
260 | ||
d6204268 UD |
261 | /* Try to load transliteration step module. */ |
262 | extern int __gconv_translit_find (struct trans_struct *trans) | |
263 | internal_function; | |
264 | ||
55985355 | 265 | /* Transliteration using the locale's data. */ |
f1d5c60d UD |
266 | extern int __gconv_transliterate (struct __gconv_step *step, |
267 | struct __gconv_step_data *step_data, | |
d6204268 | 268 | void *trans_data, |
a784e502 UD |
269 | const unsigned char *inbufstart, |
270 | const unsigned char **inbufp, | |
271 | const unsigned char *inbufend, | |
f1d5c60d | 272 | unsigned char **outbufstart, |
dff07c4b | 273 | size_t *irreversible) attribute_hidden; |
e62c19f1 UD |
274 | |
275 | ||
dd9423a6 UD |
276 | /* If NAME is an codeset alias expand it. */ |
277 | extern int __gconv_compare_alias (const char *name1, const char *name2) | |
278 | internal_function; | |
279 | ||
280 | ||
e62c19f1 UD |
281 | /* Builtin transformations. */ |
282 | #ifdef _LIBC | |
f9ad060c | 283 | # define __BUILTIN_TRANSFORM(Name) \ |
55985355 UD |
284 | extern int Name (struct __gconv_step *step, \ |
285 | struct __gconv_step_data *data, \ | |
286 | const unsigned char **inbuf, \ | |
f1d5c60d UD |
287 | const unsigned char *inbufend, \ |
288 | unsigned char **outbufstart, size_t *irreversible, \ | |
289 | int do_flush, int consume_incomplete) | |
e62c19f1 | 290 | |
f9ad060c UD |
291 | __BUILTIN_TRANSFORM (__gconv_transform_ascii_internal); |
292 | __BUILTIN_TRANSFORM (__gconv_transform_internal_ascii); | |
293 | __BUILTIN_TRANSFORM (__gconv_transform_utf8_internal); | |
294 | __BUILTIN_TRANSFORM (__gconv_transform_internal_utf8); | |
295 | __BUILTIN_TRANSFORM (__gconv_transform_ucs2_internal); | |
296 | __BUILTIN_TRANSFORM (__gconv_transform_internal_ucs2); | |
297 | __BUILTIN_TRANSFORM (__gconv_transform_ucs2reverse_internal); | |
298 | __BUILTIN_TRANSFORM (__gconv_transform_internal_ucs2reverse); | |
299 | __BUILTIN_TRANSFORM (__gconv_transform_internal_ucs4); | |
300 | __BUILTIN_TRANSFORM (__gconv_transform_ucs4_internal); | |
301 | __BUILTIN_TRANSFORM (__gconv_transform_internal_ucs4le); | |
302 | __BUILTIN_TRANSFORM (__gconv_transform_ucs4le_internal); | |
303 | __BUILTIN_TRANSFORM (__gconv_transform_internal_utf16); | |
304 | __BUILTIN_TRANSFORM (__gconv_transform_utf16_internal); | |
305 | # undef __BUITLIN_TRANSFORM | |
306 | ||
307 | /* Specialized conversion function for a single byte to INTERNAL, recognizing | |
308 | only ASCII characters. */ | |
309 | extern wint_t __gconv_btwoc_ascii (struct __gconv_step *step, unsigned char c); | |
e62c19f1 | 310 | |
e62c19f1 UD |
311 | #endif |
312 | ||
313 | __END_DECLS | |
314 | ||
315 | #endif /* gconv_int.h */ |