1/* Copyright (C) 1997-2019 Free Software Foundation, Inc.
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
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.
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
13 Lesser General Public License for more details.
14
15 You should have received a copy of the GNU Lesser General Public
16 License along with the GNU C Library; if not, see
17 <http://www.gnu.org/licenses/>. */
18
19#ifndef _GCONV_INT_H
20#define _GCONV_INT_H 1
21
22#include "gconv.h"
23#include <stdlib.h> /* For alloca used in macro below. */
24#include <ctype.h> /* For __toupper_l used in macro below. */
25#include <string.h> /* For strlen et al used in macro below. */
26#include <libc-lock.h>
27
28__BEGIN_DECLS
29
30
31/* Structure for alias definition. Simply two strings. */
32struct gconv_alias
33{
34 char *fromname;
35 char *toname;
36};
37
38
39/* Structure describing one loaded shared object. This normally are
40 objects to perform conversation but as a special case the db shared
41 object is also handled. */
42struct __gconv_loaded_object
43{
44 /* Name of the object. It must be the first structure element. */
45 const char *name;
46
47 /* Reference counter for the db functionality. If no conversion is
48 needed we unload the db library. */
49 int counter;
50
51 /* The handle for the shared object. */
52 void *handle;
53
54 /* Pointer to the functions the module defines. */
55 __gconv_fct fct;
56 __gconv_init_fct init_fct;
57 __gconv_end_fct end_fct;
58};
59
60
61/* Description for an available conversion module. */
62struct gconv_module
63{
64 const char *from_string;
65 const char *to_string;
66
67 int cost_hi;
68 int cost_lo;
69
70 const char *module_name;
71
72 struct gconv_module *left; /* Prefix smaller. */
73 struct gconv_module *same; /* List of entries with identical prefix. */
74 struct gconv_module *right; /* Prefix larger. */
75};
76
77
78/* Flags for `gconv_open'. */
79enum
80{
81 GCONV_AVOID_NOCONV = 1 << 0
82};
83
84/* When GCONV_AVOID_NOCONV is set and no conversion is needed,
85 __GCONV_NULCONV should be returned. */
86enum
87{
88 __GCONV_NULCONV = -1
89};
90
91/* Global variables. */
92
93/* Database of alias names. */
94extern void *__gconv_alias_db attribute_hidden;
95
96/* Array with available modules. */
97extern struct gconv_module *__gconv_modules_db attribute_hidden;
98
99/* Value of the GCONV_PATH environment variable. */
100extern const char *__gconv_path_envvar attribute_hidden;
101
102/* Lock for the conversion database content. */
103__libc_lock_define (extern, __gconv_lock attribute_hidden)
104
105
106/* The gconv functions expects the name to be in upper case and complete,
107 including the trailing slashes if necessary. */
108#define norm_add_slashes(str,suffix) \
109 ({ \
110 const char *cp = (str); \
111 char *result; \
112 char *tmp; \
113 size_t cnt = 0; \
114 const size_t suffix_len = strlen (suffix); \
115 \
116 while (*cp != '\0') \
117 if (*cp++ == '/') \
118 ++cnt; \
119 \
120 tmp = result = __alloca (cp - (str) + 3 + suffix_len); \
121 cp = (str); \
122 while (*cp != '\0') \
123 *tmp++ = __toupper_l (*cp++, _nl_C_locobj_ptr); \
124 if (cnt < 2) \
125 { \
126 *tmp++ = '/'; \
127 if (cnt < 1) \
128 { \
129 *tmp++ = '/'; \
130 if (suffix_len != 0) \
131 tmp = __mempcpy (tmp, suffix, suffix_len); \
132 } \
133 } \
134 *tmp = '\0'; \
135 result; \
136 })
137
138
139/* Return in *HANDLE decriptor for transformation from FROMSET to TOSET. */
140extern int __gconv_open (const char *toset, const char *fromset,
141 __gconv_t *handle, int flags)
142 attribute_hidden;
143
144/* Free resources associated with transformation descriptor CD. */
145extern int __gconv_close (__gconv_t cd)
146 attribute_hidden;
147
148/* Transform at most *INBYTESLEFT bytes from buffer starting at *INBUF
149 according to rules described by CD and place up to *OUTBYTESLEFT
150 bytes in buffer starting at *OUTBUF. Return number of non-identical
151 conversions in *IRREVERSIBLE if this pointer is not null. */
152extern int __gconv (__gconv_t cd, const unsigned char **inbuf,
153 const unsigned char *inbufend, unsigned char **outbuf,
154 unsigned char *outbufend, size_t *irreversible)
155 attribute_hidden;
156
157/* Return in *HANDLE a pointer to an array with *NSTEPS elements describing
158 the single steps necessary for transformation from FROMSET to TOSET. */
159extern int __gconv_find_transform (const char *toset, const char *fromset,
160 struct __gconv_step **handle,
161 size_t *nsteps, int flags)
162 attribute_hidden;
163
164/* Search for transformation in cache data. */
165extern int __gconv_lookup_cache (const char *toset, const char *fromset,
166 struct __gconv_step **handle, size_t *nsteps,
167 int flags)
168 attribute_hidden;
169
170/* Compare the two name for whether they are after alias expansion the
171 same. This function uses the cache and fails if none is
172 loaded. */
173extern int __gconv_compare_alias_cache (const char *name1, const char *name2,
174 int *result)
175 attribute_hidden;
176
177/* Free data associated with a step's structure. */
178extern void __gconv_release_step (struct __gconv_step *step)
179 attribute_hidden;
180
181/* Read all the configuration data and cache it if not done so already. */
182extern void __gconv_load_conf (void) attribute_hidden;
183
184/* Try to read module cache file. */
185extern int __gconv_load_cache (void) attribute_hidden;
186
187/* Retrieve pointer to internal cache. */
188extern void *__gconv_get_cache (void);
189
190/* Retrieve pointer to internal module database. */
191extern struct gconv_module *__gconv_get_modules_db (void);
192
193/* Retrieve pointer to internal alias database. */
194extern void *__gconv_get_alias_db (void);
195
196/* Comparison function to search alias. */
197extern int __gconv_alias_compare (const void *p1, const void *p2)
198 attribute_hidden;
199
200/* Clear reference to transformation step implementations which might
201 cause the code to be unloaded. */
202extern int __gconv_close_transform (struct __gconv_step *steps,
203 size_t nsteps)
204 attribute_hidden;
205
206/* Free all resources allocated for the transformation record when
207 using the cache. */
208extern void __gconv_release_cache (struct __gconv_step *steps, size_t nsteps)
209 attribute_hidden;
210
211/* Load shared object named by NAME. If already loaded increment reference
212 count. */
213extern struct __gconv_loaded_object *__gconv_find_shlib (const char *name)
214 attribute_hidden;
215
216/* Release shared object. If no further reference is available unload
217 the object. */
218extern void __gconv_release_shlib (struct __gconv_loaded_object *handle)
219 attribute_hidden;
220
221/* Fill STEP with information about builtin module with NAME. */
222extern void __gconv_get_builtin_trans (const char *name,
223 struct __gconv_step *step)
224 attribute_hidden;
225
226libc_hidden_proto (__gconv_transliterate)
227
228/* If NAME is an codeset alias expand it. */
229extern int __gconv_compare_alias (const char *name1, const char *name2)
230 attribute_hidden;
231
232
233/* Builtin transformations. */
234#ifdef _LIBC
235# define __BUILTIN_TRANSFORM(Name) \
236 extern int Name (struct __gconv_step *step, \
237 struct __gconv_step_data *data, \
238 const unsigned char **inbuf, \
239 const unsigned char *inbufend, \
240 unsigned char **outbufstart, size_t *irreversible, \
241 int do_flush, int consume_incomplete)
242
243__BUILTIN_TRANSFORM (__gconv_transform_ascii_internal);
244__BUILTIN_TRANSFORM (__gconv_transform_internal_ascii);
245__BUILTIN_TRANSFORM (__gconv_transform_utf8_internal);
246__BUILTIN_TRANSFORM (__gconv_transform_internal_utf8);
247__BUILTIN_TRANSFORM (__gconv_transform_ucs2_internal);
248__BUILTIN_TRANSFORM (__gconv_transform_internal_ucs2);
249__BUILTIN_TRANSFORM (__gconv_transform_ucs2reverse_internal);
250__BUILTIN_TRANSFORM (__gconv_transform_internal_ucs2reverse);
251__BUILTIN_TRANSFORM (__gconv_transform_internal_ucs4);
252__BUILTIN_TRANSFORM (__gconv_transform_ucs4_internal);
253__BUILTIN_TRANSFORM (__gconv_transform_internal_ucs4le);
254__BUILTIN_TRANSFORM (__gconv_transform_ucs4le_internal);
255__BUILTIN_TRANSFORM (__gconv_transform_internal_utf16);
256__BUILTIN_TRANSFORM (__gconv_transform_utf16_internal);
257# undef __BUITLIN_TRANSFORM
258
259/* Specialized conversion function for a single byte to INTERNAL, recognizing
260 only ASCII characters. */
261extern wint_t __gconv_btwoc_ascii (struct __gconv_step *step, unsigned char c);
262
263#endif
264
265__END_DECLS
266
267#endif /* gconv_int.h */
268