18218449529efd5b6e9cd9b2dec26ad30b3a751e
[kopensolaris-gnu/glibc.git] / iconv / gconv.h
1 /* Copyright (C) 1997, 1998, 1999, 2000 Free Software Foundation, Inc.
2    This file is part of the GNU C Library.
3
4    The GNU C Library is free software; you can redistribute it and/or
5    modify it under the terms of the GNU Library General Public License as
6    published by the Free Software Foundation; either version 2 of the
7    License, or (at your option) any later version.
8
9    The GNU C Library is distributed in the hope that it will be useful,
10    but WITHOUT ANY WARRANTY; without even the implied warranty of
11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12    Library General Public License for more details.
13
14    You should have received a copy of the GNU Library General Public
15    License along with the GNU C Library; see the file COPYING.LIB.  If not,
16    write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17    Boston, MA 02111-1307, USA.  */
18
19 /* This header provides no interface for a user to the internals of
20    the gconv implementation in the libc.  Therefore there is no use
21    for these definitions beside for writing additional gconv modules.  */
22
23 #ifndef _GCONV_H
24 #define _GCONV_H        1
25
26 #include <features.h>
27 #define __need_mbstate_t
28 #include <wchar.h>
29 #define __need_size_t
30 #include <stddef.h>
31
32 /* ISO 10646 value used to signal invalid value.  */
33 #define __UNKNOWN_10646_CHAR    ((wchar_t) 0xfffd)
34
35 /* Error codes for gconv functions.  */
36 enum
37 {
38   __GCONV_OK = 0,
39   __GCONV_NOCONV,
40   __GCONV_NODB,
41   __GCONV_NOMEM,
42
43   __GCONV_EMPTY_INPUT,
44   __GCONV_FULL_OUTPUT,
45   __GCONV_ILLEGAL_INPUT,
46   __GCONV_INCOMPLETE_INPUT,
47
48   __GCONV_ILLEGAL_DESCRIPTOR,
49   __GCONV_INTERNAL_ERROR
50 };
51
52
53 /* Flags the `__gconv_open' function can set.  */
54 enum
55 {
56   __GCONV_IS_LAST = 0x0001,
57   __GCONV_IGNORE_ERRORS = 0x0002
58 };
59
60
61 /* Forward declarations.  */
62 struct __gconv_step;
63 struct __gconv_step_data;
64 struct __gconv_loaded_object;
65
66
67 /* Type of a conversion function.  */
68 typedef int (*__gconv_fct) (struct __gconv_step *, struct __gconv_step_data *,
69                             __const unsigned char **, __const unsigned char *,
70                             size_t *, int, int);
71
72 /* Constructor and destructor for local data for conversion step.  */
73 typedef int (*__gconv_init_fct) (struct __gconv_step *);
74 typedef void (*__gconv_end_fct) (struct __gconv_step *);
75
76
77 /* Description of a conversion step.  */
78 struct __gconv_step
79 {
80   struct __gconv_loaded_object *__shlib_handle;
81   __const char *__modname;
82
83   int __counter;
84
85   __const char *__from_name;
86   __const char *__to_name;
87
88   __gconv_fct __fct;
89   __gconv_init_fct __init_fct;
90   __gconv_end_fct __end_fct;
91
92   /* Information about the number of bytes needed or produced in this
93      step.  This helps optimizing the buffer sizes.  */
94   int __min_needed_from;
95   int __max_needed_from;
96   int __min_needed_to;
97   int __max_needed_to;
98
99   /* Flag whether this is a stateful encoding or not.  */
100   int __stateful;
101
102   void *__data;         /* Pointer to step-local data.  */
103 };
104
105 /* Additional data for steps in use of conversion descriptor.  This is
106    allocated by the `init' function.  */
107 struct __gconv_step_data
108 {
109   unsigned char *__outbuf;    /* Output buffer for this step.  */
110   unsigned char *__outbufend; /* Address of first byte after the output
111                                  buffer.  */
112
113   /* Is this the last module in the chain.  */
114   int __flags;
115
116   /* Counter for number of invocations of the module function for this
117      descriptor.  */
118   int __invocation_counter;
119
120   /* Flag whether this is an internal use of the module (in the mb*towc*
121      and wc*tomb* functions) or regular with iconv(3).  */
122   int __internal_use;
123
124   __mbstate_t *__statep;
125   __mbstate_t __state;  /* This element must not be used directly by
126                            any module; always use STATEP!  */
127 };
128
129
130 /* Combine conversion step description with data.  */
131 typedef struct __gconv_info
132 {
133   size_t __nsteps;
134   struct __gconv_step *__steps;
135   __extension__ struct __gconv_step_data __data[0];
136 } *__gconv_t;
137
138 #endif /* gconv.h */