Fix possibly uninitilized variable handling.
[glibc.git] / iconv / gconv_int.h
blobfd112204bc30df9e541a0d0c812115a8007a63e8
1 /* Copyright (C) 1997-2005, 2006, 2007 Free Software Foundation, Inc.
2 This file is part of the GNU C Library.
3 Contributed by Ulrich Drepper <drepper@cygnus.com>, 1997.
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.
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.
15 You should have received a copy of the GNU Lesser General Public
16 License along with the GNU C Library; if not, write to the Free
17 Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
18 02111-1307 USA. */
20 #ifndef _GCONV_INT_H
21 #define _GCONV_INT_H 1
23 #include "gconv.h"
24 #include <stdlib.h> /* For alloca used in macro below. */
25 #include <ctype.h> /* For __toupper_l used in macro below. */
26 #include <string.h> /* For strlen et al used in macro below. */
27 #include <bits/libc-lock.h>
29 __BEGIN_DECLS
32 /* Type to represent search path. */
33 struct path_elem
35 const char *name;
36 size_t len;
39 /* Variable with search path for `gconv' implementation. */
40 extern struct path_elem *__gconv_path_elem attribute_hidden;
41 /* Maximum length of a single path element. */
42 extern size_t __gconv_max_path_elem_len attribute_hidden;
45 /* Structure for alias definition. Simply two strings. */
46 struct gconv_alias
48 char *fromname;
49 char *toname;
53 /* How many character should be conveted in one call? */
54 #define GCONV_NCHAR_GOAL 8160
57 /* Structure describing one loaded shared object. This normally are
58 objects to perform conversation but as a special case the db shared
59 object is also handled. */
60 struct __gconv_loaded_object
62 /* Name of the object. It must be the first structure element. */
63 const char *name;
65 /* Reference counter for the db functionality. If no conversion is
66 needed we unload the db library. */
67 int counter;
69 /* The handle for the shared object. */
70 void *handle;
72 /* Pointer to the functions the module defines. */
73 __gconv_fct fct;
74 __gconv_init_fct init_fct;
75 __gconv_end_fct end_fct;
79 /* Description for an available conversion module. */
80 struct gconv_module
82 const char *from_string;
83 const char *to_string;
85 int cost_hi;
86 int cost_lo;
88 const char *module_name;
90 struct gconv_module *left; /* Prefix smaller. */
91 struct gconv_module *same; /* List of entries with identical prefix. */
92 struct gconv_module *right; /* Prefix larger. */
96 /* Internal data structure to represent transliteration module. */
97 struct trans_struct
99 const char *name;
100 struct trans_struct *next;
102 const char **csnames;
103 size_t ncsnames;
104 __gconv_trans_fct trans_fct;
105 __gconv_trans_context_fct trans_context_fct;
106 __gconv_trans_init_fct trans_init_fct;
107 __gconv_trans_end_fct trans_end_fct;
111 /* Flags for `gconv_open'. */
112 enum
114 GCONV_AVOID_NOCONV = 1 << 0
117 /* When GCONV_AVOID_NOCONV is set and no conversion is needed,
118 __GCONV_NULCONV should be returned. */
119 enum
121 __GCONV_NULCONV = -1
124 /* Global variables. */
126 /* Database of alias names. */
127 extern void *__gconv_alias_db attribute_hidden;
129 /* Array with available modules. */
130 extern size_t __gconv_nmodules;
131 extern struct gconv_module *__gconv_modules_db attribute_hidden;
133 /* Value of the GCONV_PATH environment variable. */
134 extern const char *__gconv_path_envvar attribute_hidden;
136 /* Lock for the conversion database content. */
137 __libc_lock_define (extern, __gconv_lock attribute_hidden)
140 /* The gconv functions expects the name to be in upper case and complete,
141 including the trailing slashes if necessary. */
142 #define norm_add_slashes(str,suffix) \
143 ({ \
144 const char *cp = (str); \
145 char *result; \
146 char *tmp; \
147 size_t cnt = 0; \
148 const size_t suffix_len = strlen (suffix); \
150 while (*cp != '\0') \
151 if (*cp++ == '/') \
152 ++cnt; \
154 tmp = result = __alloca (cp - (str) + 3 + suffix_len); \
155 cp = (str); \
156 while (*cp != '\0') \
157 *tmp++ = __toupper_l (*cp++, _nl_C_locobj_ptr); \
158 if (cnt < 2) \
160 *tmp++ = '/'; \
161 if (cnt < 1) \
163 *tmp++ = '/'; \
164 if (suffix_len != 0) \
165 tmp = __mempcpy (tmp, suffix, suffix_len); \
168 *tmp = '\0'; \
169 result; \
173 /* Return in *HANDLE decriptor for transformation from FROMSET to TOSET. */
174 extern int __gconv_open (const char *toset, const char *fromset,
175 __gconv_t *handle, int flags)
176 internal_function;
178 /* Free resources associated with transformation descriptor CD. */
179 extern int __gconv_close (__gconv_t cd)
180 internal_function;
182 /* Transform at most *INBYTESLEFT bytes from buffer starting at *INBUF
183 according to rules described by CD and place up to *OUTBYTESLEFT
184 bytes in buffer starting at *OUTBUF. Return number of non-identical
185 conversions in *IRREVERSIBLE if this pointer is not null. */
186 extern int __gconv (__gconv_t cd, const unsigned char **inbuf,
187 const unsigned char *inbufend, unsigned char **outbuf,
188 unsigned char *outbufend, size_t *irreversible)
189 internal_function;
191 /* Return in *HANDLE a pointer to an array with *NSTEPS elements describing
192 the single steps necessary for transformation from FROMSET to TOSET. */
193 extern int __gconv_find_transform (const char *toset, const char *fromset,
194 struct __gconv_step **handle,
195 size_t *nsteps, int flags)
196 internal_function;
198 /* Search for transformation in cache data. */
199 extern int __gconv_lookup_cache (const char *toset, const char *fromset,
200 struct __gconv_step **handle, size_t *nsteps,
201 int flags)
202 internal_function;
204 /* Compare the two name for whether they are after alias expansion the
205 same. This function uses the cache and fails if none is
206 loaded. */
207 extern int __gconv_compare_alias_cache (const char *name1, const char *name2,
208 int *result) internal_function;
210 /* Free data associated with a step's structure. */
211 extern void __gconv_release_step (struct __gconv_step *step)
212 internal_function;
214 /* Read all the configuration data and cache it. */
215 extern void __gconv_read_conf (void) attribute_hidden;
217 /* Try to read module cache file. */
218 extern int __gconv_load_cache (void) internal_function;
220 /* Retrieve pointer to internal cache. */
221 extern void *__gconv_get_cache (void);
223 /* Retrieve pointer to internal module database. */
224 extern struct gconv_module *__gconv_get_modules_db (void);
226 /* Retrieve pointer to internal alias database. */
227 extern void *__gconv_get_alias_db (void);
229 /* Determine the directories we are looking in. */
230 extern void __gconv_get_path (void) internal_function;
232 /* Comparison function to search alias. */
233 extern int __gconv_alias_compare (const void *p1, const void *p2)
234 attribute_hidden;
236 /* Clear reference to transformation step implementations which might
237 cause the code to be unloaded. */
238 extern int __gconv_close_transform (struct __gconv_step *steps,
239 size_t nsteps)
240 internal_function;
242 /* Free all resources allocated for the transformation record when
243 using the cache. */
244 extern void __gconv_release_cache (struct __gconv_step *steps, size_t nsteps)
245 internal_function;
247 /* Load shared object named by NAME. If already loaded increment reference
248 count. */
249 extern struct __gconv_loaded_object *__gconv_find_shlib (const char *name)
250 internal_function;
252 /* Release shared object. If no further reference is available unload
253 the object. */
254 extern void __gconv_release_shlib (struct __gconv_loaded_object *handle)
255 internal_function;
257 /* Fill STEP with information about builtin module with NAME. */
258 extern void __gconv_get_builtin_trans (const char *name,
259 struct __gconv_step *step)
260 internal_function;
262 /* Try to load transliteration step module. */
263 extern int __gconv_translit_find (struct trans_struct *trans)
264 internal_function;
266 /* Transliteration using the locale's data. */
267 extern int __gconv_transliterate (struct __gconv_step *step,
268 struct __gconv_step_data *step_data,
269 void *trans_data,
270 __const unsigned char *inbufstart,
271 __const unsigned char **inbufp,
272 __const unsigned char *inbufend,
273 unsigned char **outbufstart,
274 size_t *irreversible) attribute_hidden;
277 /* If NAME is an codeset alias expand it. */
278 extern int __gconv_compare_alias (const char *name1, const char *name2)
279 internal_function;
282 /* Builtin transformations. */
283 #ifdef _LIBC
284 # define __BUILTIN_TRANSFORM(Name) \
285 extern int Name (struct __gconv_step *step, \
286 struct __gconv_step_data *data, \
287 const unsigned char **inbuf, \
288 const unsigned char *inbufend, \
289 unsigned char **outbufstart, size_t *irreversible, \
290 int do_flush, int consume_incomplete)
292 __BUILTIN_TRANSFORM (__gconv_transform_ascii_internal);
293 __BUILTIN_TRANSFORM (__gconv_transform_internal_ascii);
294 __BUILTIN_TRANSFORM (__gconv_transform_utf8_internal);
295 __BUILTIN_TRANSFORM (__gconv_transform_internal_utf8);
296 __BUILTIN_TRANSFORM (__gconv_transform_ucs2_internal);
297 __BUILTIN_TRANSFORM (__gconv_transform_internal_ucs2);
298 __BUILTIN_TRANSFORM (__gconv_transform_ucs2reverse_internal);
299 __BUILTIN_TRANSFORM (__gconv_transform_internal_ucs2reverse);
300 __BUILTIN_TRANSFORM (__gconv_transform_internal_ucs4);
301 __BUILTIN_TRANSFORM (__gconv_transform_ucs4_internal);
302 __BUILTIN_TRANSFORM (__gconv_transform_internal_ucs4le);
303 __BUILTIN_TRANSFORM (__gconv_transform_ucs4le_internal);
304 __BUILTIN_TRANSFORM (__gconv_transform_internal_utf16);
305 __BUILTIN_TRANSFORM (__gconv_transform_utf16_internal);
306 # undef __BUITLIN_TRANSFORM
308 /* Specialized conversion function for a single byte to INTERNAL, recognizing
309 only ASCII characters. */
310 extern wint_t __gconv_btwoc_ascii (struct __gconv_step *step, unsigned char c);
312 #endif
314 __END_DECLS
316 #endif /* gconv_int.h */