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

/* Copyright (C) 1997-2016 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, see
   <http://www.gnu.org/licenses/>.  */

#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 <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 converted 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.  */
};


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

/* When GCONV_AVOID_NOCONV is set and no conversion is needed,
   __GCONV_NULCONV should be returned.  */
enum
{
  __GCONV_NULCONV = -1
};

/* 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 attribute_hidden)


/* 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;

libc_hidden_proto (__gconv_transliterate)

/* 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
f7a9f785	1	/* Copyright (C) 1997-2016 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
59ba27a6 PE	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. */
6111babe RM	25	#include <string.h> /* For strlen et al used in macro below. */
ec999b8e	26	#include <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
d6204268 UD	43
9a321276	44	/* Structure for alias definition. Simply two strings. */
e62c19f1 UD	45	struct gconv_alias
e62c19f1 UD	46	{
17427edd UD	47	char *fromname;
17427edd UD	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
e62c19f1 UD	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
0d9f6793 UD	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;
fab6d621 UD	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
c90a2db6 UD	95	/* Flags for `gconv_open'. */
	96	enum
	97	{
	98	GCONV_AVOID_NOCONV = 1 << 0
	99	};
	100
7b503bcc UD	101	/* When GCONV_AVOID_NOCONV is set and no conversion is needed,
	102	__GCONV_NULCONV should be returned. */
	103	enum
	104	{
	105	__GCONV_NULCONV = -1
	106	};
c90a2db6	107
e62c19f1 UD	108	/* Global variables. */
	109
	110	/* Database of alias names. */
230491f0	111	extern void *__gconv_alias_db attribute_hidden;
e62c19f1 UD	112
	113	/* Array with available modules. */
	114	extern size_t __gconv_nmodules;
230491f0	115	extern struct gconv_module *__gconv_modules_db attribute_hidden;
e62c19f1	116
6b98979f	117	/* Value of the GCONV_PATH environment variable. */
aa32f798	118	extern const char *__gconv_path_envvar attribute_hidden;
6b98979f	119
9e26f129	120	/* Lock for the conversion database content. */
6f8a7dff	121	__libc_lock_define (extern, __gconv_lock attribute_hidden)
9e26f129	122
e62c19f1	123
17c389fc UD	124	/* The gconv functions expects the name to be in upper case and complete,
17c389fc UD	125	including the trailing slashes if necessary. */
323fb88d	126	#define norm_add_slashes(str,suffix) \
17c389fc UD	127	({ \
	128	const char *cp = (str); \
	129	char *result; \
	130	char *tmp; \
	131	size_t cnt = 0; \
db2f05ba	132	const size_t suffix_len = strlen (suffix); \
17c389fc UD	133	\
	134	while (*cp != '\0') \
	135	if (*cp++ == '/') \
	136	++cnt; \
	137	\
c5738211	138	tmp = result = __alloca (cp - (str) + 3 + suffix_len); \
17c389fc UD	139	cp = (str); \
17c389fc UD	140	while (*cp != '\0') \
4b5b009c	141	tmp++ = __toupper_l (cp++, _nl_C_locobj_ptr); \
17c389fc UD	142	if (cnt < 2) \
	143	{ \
	144	*tmp++ = '/'; \
	145	if (cnt < 1) \
323fb88d UD	146	{ \
323fb88d UD	147	*tmp++ = '/'; \
db2f05ba	148	if (suffix_len != 0) \
323fb88d UD	149	tmp = __mempcpy (tmp, suffix, suffix_len); \
323fb88d UD	150	} \
17c389fc UD	151	} \
	152	*tmp = '\0'; \
	153	result; \
	154	})
	155
	156
e62c19f1	157	/* Return in HANDLE decriptor for transformation from FROMSET to TOSET. /
55985355 UD	158	extern int __gconv_open (const char toset, const char fromset,
55985355 UD	159	__gconv_t *handle, int flags)
e62c19f1 UD	160	internal_function;
	161
	162	/* Free resources associated with transformation descriptor CD. */
d64b6ad0	163	extern int __gconv_close (__gconv_t cd)
e62c19f1 UD	164	internal_function;
	165
	166	/* Transform at most INBYTESLEFT bytes from buffer starting at INBUF
	167	according to rules described by CD and place up to *OUTBYTESLEFT
63e04088	168	bytes in buffer starting at *OUTBUF. Return number of non-identical
38677ace	169	conversions in IRREVERSIBLE if this pointer is not null. /
55985355 UD	170	extern int __gconv (__gconv_t cd, const unsigned char **inbuf,
55985355 UD	171	const unsigned char inbufend, unsigned char *outbuf,
38677ace	172	unsigned char outbufend, size_t irreversible)
e62c19f1 UD	173	internal_function;
	174
	175	/* Return in HANDLE a pointer to an array with NSTEPS elements describing
	176	the single steps necessary for transformation from FROMSET to TOSET. */
55985355 UD	177	extern int __gconv_find_transform (const char toset, const char fromset,
	178	struct __gconv_step **handle,
	179	size_t *nsteps, int flags)
e62c19f1 UD	180	internal_function;
e62c19f1 UD	181
6b98979f UD	182	/* Search for transformation in cache data. */
	183	extern int __gconv_lookup_cache (const char toset, const char fromset,
	184	struct __gconv_step *handle, size_t nsteps,
	185	int flags)
	186	internal_function;
	187
9a018f6c UD	188	/* Compare the two name for whether they are after alias expansion the
	189	same. This function uses the cache and fails if none is
	190	loaded. */
	191	extern int __gconv_compare_alias_cache (const char name1, const char name2,
	192	int *result) internal_function;
	193
6b98979f UD	194	/* Free data associated with a step's structure. */
	195	extern void __gconv_release_step (struct __gconv_step *step)
	196	internal_function;
	197
e62c19f1	198	/* Read all the configuration data and cache it. */
dff07c4b	199	extern void __gconv_read_conf (void) attribute_hidden;
e62c19f1	200
6b98979f UD	201	/* Try to read module cache file. */
	202	extern int __gconv_load_cache (void) internal_function;
	203
230491f0 UD	204	/* Retrieve pointer to internal cache. */
	205	extern void *__gconv_get_cache (void);
	206
	207	/* Retrieve pointer to internal module database. */
	208	extern struct gconv_module *__gconv_get_modules_db (void);
	209
	210	/* Retrieve pointer to internal alias database. */
	211	extern void *__gconv_get_alias_db (void);
	212
d6204268	213	/* Determine the directories we are looking in. */
dff07c4b	214	extern void __gconv_get_path (void) internal_function;
d6204268	215
e62c19f1	216	/* Comparison function to search alias. */
dff07c4b UD	217	extern int __gconv_alias_compare (const void p1, const void p2)
dff07c4b UD	218	attribute_hidden;
e62c19f1 UD	219
	220	/* Clear reference to transformation step implementations which might
	221	cause the code to be unloaded. */
55985355 UD	222	extern int __gconv_close_transform (struct __gconv_step *steps,
55985355 UD	223	size_t nsteps)
e62c19f1 UD	224	internal_function;
e62c19f1 UD	225
0db59742 UD	226	/* Free all resources allocated for the transformation record when
	227	using the cache. */
	228	extern void __gconv_release_cache (struct __gconv_step *steps, size_t nsteps)
	229	internal_function;
	230
e62c19f1 UD	231	/* Load shared object named by NAME. If already loaded increment reference
e62c19f1 UD	232	count. */
55985355	233	extern struct __gconv_loaded_object __gconv_find_shlib (const char name)
e62c19f1 UD	234	internal_function;
	235
	236	/* Release shared object. If no further reference is available unload
	237	the object. */
b79f74cd	238	extern void __gconv_release_shlib (struct __gconv_loaded_object *handle)
e62c19f1 UD	239	internal_function;
	240
	241	/* Fill STEP with information about builtin module with NAME. */
55985355 UD	242	extern void __gconv_get_builtin_trans (const char *name,
55985355 UD	243	struct __gconv_step *step)
e62c19f1 UD	244	internal_function;
e62c19f1 UD	245
ba7b4d29	246	libc_hidden_proto (__gconv_transliterate)
e62c19f1	247
dd9423a6 UD	248	/* If NAME is an codeset alias expand it. */
	249	extern int __gconv_compare_alias (const char name1, const char name2)
	250	internal_function;
	251
	252
e62c19f1 UD	253	/* Builtin transformations. */
e62c19f1 UD	254	#ifdef _LIBC
f9ad060c	255	# define __BUILTIN_TRANSFORM(Name) \
55985355 UD	256	extern int Name (struct __gconv_step *step, \
	257	struct __gconv_step_data *data, \
	258	const unsigned char **inbuf, \
f1d5c60d UD	259	const unsigned char *inbufend, \
	260	unsigned char *outbufstart, size_t irreversible, \
	261	int do_flush, int consume_incomplete)
e62c19f1	262
f9ad060c UD	263	__BUILTIN_TRANSFORM (__gconv_transform_ascii_internal);
	264	__BUILTIN_TRANSFORM (__gconv_transform_internal_ascii);
	265	__BUILTIN_TRANSFORM (__gconv_transform_utf8_internal);
	266	__BUILTIN_TRANSFORM (__gconv_transform_internal_utf8);
	267	__BUILTIN_TRANSFORM (__gconv_transform_ucs2_internal);
	268	__BUILTIN_TRANSFORM (__gconv_transform_internal_ucs2);
	269	__BUILTIN_TRANSFORM (__gconv_transform_ucs2reverse_internal);
	270	__BUILTIN_TRANSFORM (__gconv_transform_internal_ucs2reverse);
	271	__BUILTIN_TRANSFORM (__gconv_transform_internal_ucs4);
	272	__BUILTIN_TRANSFORM (__gconv_transform_ucs4_internal);
	273	__BUILTIN_TRANSFORM (__gconv_transform_internal_ucs4le);
	274	__BUILTIN_TRANSFORM (__gconv_transform_ucs4le_internal);
	275	__BUILTIN_TRANSFORM (__gconv_transform_internal_utf16);
	276	__BUILTIN_TRANSFORM (__gconv_transform_utf16_internal);
	277	# undef __BUITLIN_TRANSFORM
	278
	279	/* Specialized conversion function for a single byte to INTERNAL, recognizing
	280	only ASCII characters. */
	281	extern wint_t __gconv_btwoc_ascii (struct __gconv_step *step, unsigned char c);
e62c19f1	282
e62c19f1 UD	283	#endif
	284
	285	__END_DECLS
	286
	287	#endif /* gconv_int.h */