Remove definition which are now in gconv_int.h.
[kopensolaris-gnu/glibc.git] / iconv / gconv.h
1 /* Copyright (C) 1997, 1998 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_size_t
28 #include <stddef.h>
29
30 /* ISO 10646 value used to signal invalid value.  */
31 #define UNKNOWN_10646_CHAR      ((wchar_t) 0xfffd)
32
33 /* Error codes for gconv functions.  */
34 enum
35 {
36   GCONV_OK = 0,
37   GCONV_NOCONV,
38   GCONV_NODB,
39   GCONV_NOMEM,
40
41   GCONV_EMPTY_INPUT,
42   GCONV_FULL_OUTPUT,
43   GCONV_ILLEGAL_INPUT,
44   GCONV_INCOMPLETE_INPUT,
45
46   GCONV_ILLEGAL_DESCRIPTOR,
47   GCONV_INTERNAL_ERROR
48 };
49
50
51 /* Forward declarations.  */
52 struct gconv_step;
53 struct gconv_step_data;
54
55
56 /* Type of a conversion function.  */
57 typedef int (*gconv_fct) __P ((struct gconv_step *,
58                                struct gconv_step_data *,
59                                __const char *, size_t *, size_t *, int));
60
61 /* Constructor and destructor for local data for conversion step.  */
62 typedef int (*gconv_init_fct) __P ((struct gconv_step *,
63                                     struct gconv_step_data *));
64 typedef void (*gconv_end_fct) __P ((struct gconv_step_data *));
65
66
67 /* Description of a conversion step.  */
68 struct gconv_step
69 {
70   void *shlib_handle;
71
72   __const char *from_name;
73   __const char *to_name;
74
75   gconv_fct fct;
76   gconv_init_fct init_fct;
77   gconv_end_fct end_fct;
78 };
79
80 /* Additional data for steps in use of conversion descriptor.  This is
81    allocated by the `init' function.  */
82 struct gconv_step_data
83 {
84   char *outbuf;         /* Output buffer for this step.  */
85   size_t outbufavail;   /* Bytes already available in output buffer.  */
86   size_t outbufsize;    /* Size of output buffer.  */
87
88   int is_last;
89
90   void *data;           /* Pointer to step-local data.  */
91 };
92
93
94 /* Combine conversion step description with data.  */
95 typedef struct gconv_info
96 {
97   size_t nsteps;
98   struct gconv_step *steps;
99   struct gconv_step_data *data;
100 } *gconv_t;
101
102 #endif /* gconv.h */