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

/* Copyright (C) 1997-2019 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


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


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

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

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

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

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

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

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

/* Read all the configuration data and cache it if not done so already.  */
extern void __gconv_load_conf (void) attribute_hidden;

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

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

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

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

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

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

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

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

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


/* 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
04277e02	1	/* Copyright (C) 1997-2019 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
9a321276	31	/* Structure for alias definition. Simply two strings. */
e62c19f1 UD	32	struct gconv_alias
e62c19f1 UD	33	{
17427edd UD	34	char *fromname;
17427edd UD	35	char *toname;
e62c19f1 UD	36	};
	37
	38
0d9f6793 UD	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. */
d64b6ad0	42	struct __gconv_loaded_object
0d9f6793	43	{
b79f74cd	44	/* Name of the object. It must be the first structure element. */
0d9f6793 UD	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. */
b3fc5f84	52	void *handle;
0d9f6793 UD	53
0d9f6793 UD	54	/* Pointer to the functions the module defines. */
d64b6ad0 UD	55	__gconv_fct fct;
	56	__gconv_init_fct init_fct;
	57	__gconv_end_fct end_fct;
0d9f6793 UD	58	};
	59
	60
e62c19f1 UD	61	/* Description for an available conversion module. */
	62	struct gconv_module
	63	{
d2dfc5de	64	const char *from_string;
0d9f6793	65	const char *to_string;
e62c19f1	66
fab6d621 UD	67	int cost_hi;
fab6d621 UD	68	int cost_lo;
e62c19f1	69
0d9f6793	70	const char *module_name;
2bd60880 UD	71
	72	struct gconv_module left; / Prefix smaller. */
	73	struct gconv_module same; / List of entries with identical prefix. */
2bd60880	74	struct gconv_module right; / Prefix larger. */
e62c19f1 UD	75	};
	76
	77
c90a2db6 UD	78	/* Flags for `gconv_open'. */
	79	enum
	80	{
	81	GCONV_AVOID_NOCONV = 1 << 0
	82	};
	83
7b503bcc UD	84	/* When GCONV_AVOID_NOCONV is set and no conversion is needed,
	85	__GCONV_NULCONV should be returned. */
	86	enum
	87	{
	88	__GCONV_NULCONV = -1
	89	};
c90a2db6	90
e62c19f1 UD	91	/* Global variables. */
	92
	93	/* Database of alias names. */
230491f0	94	extern void *__gconv_alias_db attribute_hidden;
e62c19f1 UD	95
e62c19f1 UD	96	/* Array with available modules. */
230491f0	97	extern struct gconv_module *__gconv_modules_db attribute_hidden;
e62c19f1	98
6b98979f	99	/* Value of the GCONV_PATH environment variable. */
aa32f798	100	extern const char *__gconv_path_envvar attribute_hidden;
6b98979f	101
9e26f129	102	/* Lock for the conversion database content. */
6f8a7dff	103	__libc_lock_define (extern, __gconv_lock attribute_hidden)
9e26f129	104
e62c19f1	105
17c389fc UD	106	/* The gconv functions expects the name to be in upper case and complete,
17c389fc UD	107	including the trailing slashes if necessary. */
323fb88d	108	#define norm_add_slashes(str,suffix) \
17c389fc UD	109	({ \
	110	const char *cp = (str); \
	111	char *result; \
	112	char *tmp; \
	113	size_t cnt = 0; \
db2f05ba	114	const size_t suffix_len = strlen (suffix); \
17c389fc UD	115	\
	116	while (*cp != '\0') \
	117	if (*cp++ == '/') \
	118	++cnt; \
	119	\
c5738211	120	tmp = result = __alloca (cp - (str) + 3 + suffix_len); \
17c389fc UD	121	cp = (str); \
17c389fc UD	122	while (*cp != '\0') \
4b5b009c	123	tmp++ = __toupper_l (cp++, _nl_C_locobj_ptr); \
17c389fc UD	124	if (cnt < 2) \
	125	{ \
	126	*tmp++ = '/'; \
	127	if (cnt < 1) \
323fb88d UD	128	{ \
323fb88d UD	129	*tmp++ = '/'; \
db2f05ba	130	if (suffix_len != 0) \
323fb88d UD	131	tmp = __mempcpy (tmp, suffix, suffix_len); \
323fb88d UD	132	} \
17c389fc UD	133	} \
	134	*tmp = '\0'; \
	135	result; \
	136	})
	137
	138
e62c19f1	139	/* Return in HANDLE decriptor for transformation from FROMSET to TOSET. /
55985355	140	extern int __gconv_open (const char toset, const char fromset,
8bcdb7e0 L	141	__gconv_t *handle, int flags)
8bcdb7e0 L	142	attribute_hidden;
e62c19f1 UD	143
e62c19f1 UD	144	/* Free resources associated with transformation descriptor CD. */
8bcdb7e0 L	145	extern int __gconv_close (__gconv_t cd)
8bcdb7e0 L	146	attribute_hidden;
e62c19f1 UD	147
	148	/* Transform at most INBYTESLEFT bytes from buffer starting at INBUF
	149	according to rules described by CD and place up to *OUTBYTESLEFT
63e04088	150	bytes in buffer starting at *OUTBUF. Return number of non-identical
38677ace	151	conversions in IRREVERSIBLE if this pointer is not null. /
55985355 UD	152	extern int __gconv (__gconv_t cd, const unsigned char **inbuf,
55985355 UD	153	const unsigned char inbufend, unsigned char *outbuf,
8bcdb7e0 L	154	unsigned char outbufend, size_t irreversible)
8bcdb7e0 L	155	attribute_hidden;
e62c19f1 UD	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. */
55985355 UD	159	extern int __gconv_find_transform (const char toset, const char fromset,
55985355 UD	160	struct __gconv_step **handle,
8bcdb7e0 L	161	size_t *nsteps, int flags)
8bcdb7e0 L	162	attribute_hidden;
e62c19f1	163
6b98979f UD	164	/* Search for transformation in cache data. */
	165	extern int __gconv_lookup_cache (const char toset, const char fromset,
	166	struct __gconv_step *handle, size_t nsteps,
8bcdb7e0 L	167	int flags)
8bcdb7e0 L	168	attribute_hidden;
6b98979f	169
9a018f6c UD	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. */
	173	extern int __gconv_compare_alias_cache (const char name1, const char name2,
8bcdb7e0 L	174	int *result)
8bcdb7e0 L	175	attribute_hidden;
9a018f6c	176
6b98979f	177	/* Free data associated with a step's structure. */
8bcdb7e0 L	178	extern void __gconv_release_step (struct __gconv_step *step)
8bcdb7e0 L	179	attribute_hidden;
6b98979f	180
c5288d37 AS	181	/* Read all the configuration data and cache it if not done so already. */
c5288d37 AS	182	extern void __gconv_load_conf (void) attribute_hidden;
e62c19f1	183
6b98979f	184	/* Try to read module cache file. */
8bcdb7e0	185	extern int __gconv_load_cache (void) attribute_hidden;
6b98979f	186
230491f0 UD	187	/* Retrieve pointer to internal cache. */
	188	extern void *__gconv_get_cache (void);
	189
	190	/* Retrieve pointer to internal module database. */
	191	extern struct gconv_module *__gconv_get_modules_db (void);
	192
	193	/* Retrieve pointer to internal alias database. */
	194	extern void *__gconv_get_alias_db (void);
	195
e62c19f1	196	/* Comparison function to search alias. */
dff07c4b UD	197	extern int __gconv_alias_compare (const void p1, const void p2)
dff07c4b UD	198	attribute_hidden;
e62c19f1 UD	199
	200	/* Clear reference to transformation step implementations which might
	201	cause the code to be unloaded. */
55985355	202	extern int __gconv_close_transform (struct __gconv_step *steps,
8bcdb7e0 L	203	size_t nsteps)
8bcdb7e0 L	204	attribute_hidden;
e62c19f1	205
0db59742 UD	206	/* Free all resources allocated for the transformation record when
0db59742 UD	207	using the cache. */
8bcdb7e0 L	208	extern void __gconv_release_cache (struct __gconv_step *steps, size_t nsteps)
8bcdb7e0 L	209	attribute_hidden;
0db59742	210
e62c19f1 UD	211	/* Load shared object named by NAME. If already loaded increment reference
e62c19f1 UD	212	count. */
8bcdb7e0 L	213	extern struct __gconv_loaded_object __gconv_find_shlib (const char name)
8bcdb7e0 L	214	attribute_hidden;
e62c19f1 UD	215
	216	/* Release shared object. If no further reference is available unload
	217	the object. */
8bcdb7e0 L	218	extern void __gconv_release_shlib (struct __gconv_loaded_object *handle)
8bcdb7e0 L	219	attribute_hidden;
e62c19f1 UD	220
e62c19f1 UD	221	/* Fill STEP with information about builtin module with NAME. */
55985355	222	extern void __gconv_get_builtin_trans (const char *name,
8bcdb7e0 L	223	struct __gconv_step *step)
8bcdb7e0 L	224	attribute_hidden;
e62c19f1	225
7ac6fad9 FW	226	/* Transliteration using the locale's data. */
	227	extern int __gconv_transliterate (struct __gconv_step *step,
	228	struct __gconv_step_data *step_data,
	229	const unsigned char *inbufstart,
	230	const unsigned char **inbufp,
	231	const unsigned char *inbufend,
	232	unsigned char **outbufstart,
	233	size_t *irreversible);
ba7b4d29	234	libc_hidden_proto (__gconv_transliterate)
e62c19f1	235
dd9423a6	236	/* If NAME is an codeset alias expand it. */
8bcdb7e0 L	237	extern int __gconv_compare_alias (const char name1, const char name2)
8bcdb7e0 L	238	attribute_hidden;
dd9423a6 UD	239
dd9423a6 UD	240
e62c19f1 UD	241	/* Builtin transformations. */
e62c19f1 UD	242	#ifdef _LIBC
f9ad060c	243	# define __BUILTIN_TRANSFORM(Name) \
55985355 UD	244	extern int Name (struct __gconv_step *step, \
	245	struct __gconv_step_data *data, \
	246	const unsigned char **inbuf, \
f1d5c60d UD	247	const unsigned char *inbufend, \
	248	unsigned char *outbufstart, size_t irreversible, \
	249	int do_flush, int consume_incomplete)
e62c19f1	250
f9ad060c UD	251	__BUILTIN_TRANSFORM (__gconv_transform_ascii_internal);
	252	__BUILTIN_TRANSFORM (__gconv_transform_internal_ascii);
	253	__BUILTIN_TRANSFORM (__gconv_transform_utf8_internal);
	254	__BUILTIN_TRANSFORM (__gconv_transform_internal_utf8);
	255	__BUILTIN_TRANSFORM (__gconv_transform_ucs2_internal);
	256	__BUILTIN_TRANSFORM (__gconv_transform_internal_ucs2);
	257	__BUILTIN_TRANSFORM (__gconv_transform_ucs2reverse_internal);
	258	__BUILTIN_TRANSFORM (__gconv_transform_internal_ucs2reverse);
	259	__BUILTIN_TRANSFORM (__gconv_transform_internal_ucs4);
	260	__BUILTIN_TRANSFORM (__gconv_transform_ucs4_internal);
	261	__BUILTIN_TRANSFORM (__gconv_transform_internal_ucs4le);
	262	__BUILTIN_TRANSFORM (__gconv_transform_ucs4le_internal);
	263	__BUILTIN_TRANSFORM (__gconv_transform_internal_utf16);
	264	__BUILTIN_TRANSFORM (__gconv_transform_utf16_internal);
	265	# undef __BUITLIN_TRANSFORM
	266
	267	/* Specialized conversion function for a single byte to INTERNAL, recognizing
	268	only ASCII characters. */
	269	extern wint_t __gconv_btwoc_ascii (struct __gconv_step *step, unsigned char c);
e62c19f1	270
e62c19f1 UD	271	#endif
	272
	273	__END_DECLS
	274
	275	#endif /* gconv_int.h */