[thirdparty/glibc.git] / iconv / gconv_int.h

/* Copyright (C) 1997-2002, 2003, 2004, 2005 Free Software Foundation, Inc.
   This file is part of the GNU C Library.
   Contributed by Ulrich Drepper <drepper@cygnus.com>, 1997.

   The GNU C Library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Lesser General Public
   License as published by the Free Software Foundation; either
   version 2.1 of the License, or (at your option) any later version.

   The GNU C Library is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
   Lesser General Public License for more details.

   You should have received a copy of the GNU Lesser General Public
   License along with the GNU C Library; if not, write to the Free
   Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
   02111-1307 USA.  */

#ifndef _GCONV_INT_H
#define _GCONV_INT_H	1

#include "gconv.h"
#include <stdlib.h>		/* For alloca used in macro below.  */
#include <ctype.h>		/* For __toupper_l used in macro below.  */
#include <string.h>		/* For strlen et al used in macro below.  */
#include <bits/libc-lock.h>

__BEGIN_DECLS


/* Type to represent search path.  */
struct path_elem
{
  const char *name;
  size_t len;
};

/* Variable with search path for `gconv' implementation.  */
extern struct path_elem *__gconv_path_elem attribute_hidden;
/* Maximum length of a single path element.  */
extern size_t __gconv_max_path_elem_len attribute_hidden;


/* Structure for alias definition.  Simply two strings.  */
struct gconv_alias
{
  char *fromname;
  char *toname;
};


/* How many character should be conveted in one call?  */
#define GCONV_NCHAR_GOAL	8160


/* Structure describing one loaded shared object.  This normally are
   objects to perform conversation but as a special case the db shared
   object is also handled.  */
struct __gconv_loaded_object
{
  /* Name of the object.  It must be the first structure element.  */
  const char *name;

  /* Reference counter for the db functionality.  If no conversion is
     needed we unload the db library.  */
  int counter;

  /* The handle for the shared object.  */
  void *handle;

  /* Pointer to the functions the module defines.  */
  __gconv_fct fct;
  __gconv_init_fct init_fct;
  __gconv_end_fct end_fct;
};


/* Description for an available conversion module.  */
struct gconv_module
{
  const char *from_string;
  const char *to_string;

  int cost_hi;
  int cost_lo;

  const char *module_name;

  struct gconv_module *left;	/* Prefix smaller.  */
  struct gconv_module *same;	/* List of entries with identical prefix.  */
  struct gconv_module *right;	/* Prefix larger.  */
};


/* Internal data structure to represent transliteration module.  */
struct trans_struct
{
  const char *name;
  struct trans_struct *next;

  const char **csnames;
  size_t ncsnames;
  __gconv_trans_fct trans_fct;
  __gconv_trans_context_fct trans_context_fct;
  __gconv_trans_init_fct trans_init_fct;
  __gconv_trans_end_fct trans_end_fct;
};


/* Flags for `gconv_open'.  */
enum
{
  GCONV_AVOID_NOCONV = 1 << 0
};


/* Global variables.  */

/* Database of alias names.  */
extern void *__gconv_alias_db attribute_hidden;

/* Array with available modules.  */
extern size_t __gconv_nmodules;
extern struct gconv_module *__gconv_modules_db attribute_hidden;

/* Value of the GCONV_PATH environment variable.  */
extern const char *__gconv_path_envvar attribute_hidden;

/* Lock for the conversion database content.  */
__libc_lock_define (extern, __gconv_lock);


/* The gconv functions expects the name to be in upper case and complete,
   including the trailing slashes if necessary.  */
#define norm_add_slashes(str,suffix) \
  ({									      \
    const char *cp = (str);						      \
    char *result;							      \
    char *tmp;								      \
    size_t cnt = 0;							      \
    const size_t suffix_len = strlen (suffix);				      \
									      \
    while (*cp != '\0')							      \
      if (*cp++ == '/')							      \
	++cnt;								      \
									      \
    tmp = result = __alloca (cp - (str) + 3 + suffix_len);		      \
    cp = (str);								      \
    while (*cp != '\0')							      \
      *tmp++ = __toupper_l (*cp++, _nl_C_locobj_ptr);			      \
    if (cnt < 2)							      \
      {									      \
	*tmp++ = '/';							      \
	if (cnt < 1)							      \
	  {								      \
	    *tmp++ = '/';						      \
	    if (suffix_len != 0)					      \
	      tmp = __mempcpy (tmp, suffix, suffix_len);		      \
	  }								      \
      }									      \
    *tmp = '\0';							      \
    result;								      \
  })


/* Return in *HANDLE decriptor for transformation from FROMSET to TOSET.  */
extern int __gconv_open (const char *toset, const char *fromset,
			 __gconv_t *handle, int flags)
     internal_function;

/* Free resources associated with transformation descriptor CD.  */
extern int __gconv_close (__gconv_t cd)
     internal_function;

/* Transform at most *INBYTESLEFT bytes from buffer starting at *INBUF
   according to rules described by CD and place up to *OUTBYTESLEFT
   bytes in buffer starting at *OUTBUF.  Return number of non-identical
   conversions in *IRREVERSIBLE if this pointer is not null.  */
extern int __gconv (__gconv_t cd, const unsigned char **inbuf,
		    const unsigned char *inbufend, unsigned char **outbuf,
		    unsigned char *outbufend, size_t *irreversible)
     internal_function;

/* Return in *HANDLE a pointer to an array with *NSTEPS elements describing
   the single steps necessary for transformation from FROMSET to TOSET.  */
extern int __gconv_find_transform (const char *toset, const char *fromset,
				   struct __gconv_step **handle,
				   size_t *nsteps, int flags)
     internal_function;

/* Search for transformation in cache data.  */
extern int __gconv_lookup_cache (const char *toset, const char *fromset,
				 struct __gconv_step **handle, size_t *nsteps,
				 int flags)
     internal_function;

/* Compare the two name for whether they are after alias expansion the
   same.  This function uses the cache and fails if none is
   loaded.  */
extern int __gconv_compare_alias_cache (const char *name1, const char *name2,
					int *result) internal_function;

/* Free data associated with a step's structure.  */
extern void __gconv_release_step (struct __gconv_step *step)
     internal_function;

/* Read all the configuration data and cache it.  */
extern void __gconv_read_conf (void) attribute_hidden;

/* Try to read module cache file.  */
extern int __gconv_load_cache (void) internal_function;

/* Retrieve pointer to internal cache.  */
extern void *__gconv_get_cache (void);

/* Retrieve pointer to internal module database.  */
extern struct gconv_module *__gconv_get_modules_db (void);

/* Retrieve pointer to internal alias database.  */
extern void *__gconv_get_alias_db (void);

/* Determine the directories we are looking in.  */
extern void __gconv_get_path (void) internal_function;

/* Comparison function to search alias.  */
extern int __gconv_alias_compare (const void *p1, const void *p2)
     attribute_hidden;

/* Clear reference to transformation step implementations which might
   cause the code to be unloaded.  */
extern int __gconv_close_transform (struct __gconv_step *steps,
				    size_t nsteps)
     internal_function;

/* Free all resources allocated for the transformation record when
   using the cache.  */
extern void __gconv_release_cache (struct __gconv_step *steps, size_t nsteps)
     internal_function;

/* Load shared object named by NAME.  If already loaded increment reference
   count.  */
extern struct __gconv_loaded_object *__gconv_find_shlib (const char *name)
     internal_function;

/* Release shared object.  If no further reference is available unload
   the object.  */
extern void __gconv_release_shlib (struct __gconv_loaded_object *handle)
     internal_function;

/* Fill STEP with information about builtin module with NAME.  */
extern void __gconv_get_builtin_trans (const char *name,
				       struct __gconv_step *step)
     internal_function;

/* Try to load transliteration step module.  */
extern int __gconv_translit_find (struct trans_struct *trans)
     internal_function;

/* Transliteration using the locale's data.  */
extern int __gconv_transliterate (struct __gconv_step *step,
				  struct __gconv_step_data *step_data,
				  void *trans_data,
				  __const unsigned char *inbufstart,
				  __const unsigned char **inbufp,
				  __const unsigned char *inbufend,
				  unsigned char **outbufstart,
				  size_t *irreversible) attribute_hidden;


/* If NAME is an codeset alias expand it.  */
extern int __gconv_compare_alias (const char *name1, const char *name2)
     internal_function;


/* Builtin transformations.  */
#ifdef _LIBC
# define __BUILTIN_TRANSFORM(Name) \
  extern int Name (struct __gconv_step *step,				      \
		   struct __gconv_step_data *data,			      \
		   const unsigned char **inbuf,				      \
		   const unsigned char *inbufend,			      \
		   unsigned char **outbufstart, size_t *irreversible,	      \
		   int do_flush, int consume_incomplete)

__BUILTIN_TRANSFORM (__gconv_transform_ascii_internal);
__BUILTIN_TRANSFORM (__gconv_transform_internal_ascii);
__BUILTIN_TRANSFORM (__gconv_transform_utf8_internal);
__BUILTIN_TRANSFORM (__gconv_transform_internal_utf8);
__BUILTIN_TRANSFORM (__gconv_transform_ucs2_internal);
__BUILTIN_TRANSFORM (__gconv_transform_internal_ucs2);
__BUILTIN_TRANSFORM (__gconv_transform_ucs2reverse_internal);
__BUILTIN_TRANSFORM (__gconv_transform_internal_ucs2reverse);
__BUILTIN_TRANSFORM (__gconv_transform_internal_ucs4);
__BUILTIN_TRANSFORM (__gconv_transform_ucs4_internal);
__BUILTIN_TRANSFORM (__gconv_transform_internal_ucs4le);
__BUILTIN_TRANSFORM (__gconv_transform_ucs4le_internal);
__BUILTIN_TRANSFORM (__gconv_transform_internal_utf16);
__BUILTIN_TRANSFORM (__gconv_transform_utf16_internal);
# undef __BUITLIN_TRANSFORM

/* Specialized conversion function for a single byte to INTERNAL, recognizing
   only ASCII characters.  */
extern wint_t __gconv_btwoc_ascii (struct __gconv_step *step, unsigned char c);

#endif

__END_DECLS

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