(__GCONV_IS_LAST, __GCONV_IGNORE_ERRORS): Define.
[kopensolaris-gnu/glibc.git] / iconv / gconv.h
index 2c42f99..1821844 100644 (file)
@@ -1,6 +1,5 @@
-/* Copyright (C) 1997 Free Software Foundation, Inc.
+/* Copyright (C) 1997, 1998, 1999, 2000 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 Library General Public License as
    write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
    Boston, MA 02111-1307, USA.  */
 
+/* This header provides no interface for a user to the internals of
+   the gconv implementation in the libc.  Therefore there is no use
+   for these definitions beside for writing additional gconv modules.  */
+
 #ifndef _GCONV_H
 #define _GCONV_H       1
 
 #include <features.h>
-#include <sys/types.h>
-#include <regex.h>
+#define __need_mbstate_t
+#include <wchar.h>
+#define __need_size_t
+#include <stddef.h>
 
-__BEGIN_DECLS
+/* ISO 10646 value used to signal invalid value.  */
+#define __UNKNOWN_10646_CHAR   ((wchar_t) 0xfffd)
 
 /* Error codes for gconv functions.  */
 enum
 {
-  GCONV_OK = 0,
-  GCONV_NOCONV,
-  GCONV_NODB,
-  GCONV_NOMEM,
-
-  GCONV_EMPTY_INPUT,
-  GCONV_FULL_OUTPUT,
-  GCONV_ILLEGAL_INPUT,
-
-  GCONV_ILLEGAL_DESCRIPTOR,
-  GCONV_INTERNAL_ERROR
+  __GCONV_OK = 0,
+  __GCONV_NOCONV,
+  __GCONV_NODB,
+  __GCONV_NOMEM,
+
+  __GCONV_EMPTY_INPUT,
+  __GCONV_FULL_OUTPUT,
+  __GCONV_ILLEGAL_INPUT,
+  __GCONV_INCOMPLETE_INPUT,
+
+  __GCONV_ILLEGAL_DESCRIPTOR,
+  __GCONV_INTERNAL_ERROR
 };
 
 
-/* Structure for alias definition.  Simply to strings.  */
-struct gconv_alias
+/* Flags the `__gconv_open' function can set.  */
+enum
 {
-  __const char *fromname;
-  __const char *toname;
+  __GCONV_IS_LAST = 0x0001,
+  __GCONV_IGNORE_ERRORS = 0x0002
 };
 
 
-/* Default size of intermediate buffers.  */
-#define GCONV_DEFAULT_BUFSIZE  8160
-
-
 /* Forward declarations.  */
-struct gconv_step;
-struct gconv_step_data;
+struct __gconv_step;
+struct __gconv_step_data;
+struct __gconv_loaded_object;
 
 
 /* Type of a conversion function.  */
-typedef int (*gconv_fct) __P ((struct gconv_step *,
-                              struct gconv_step_data *,
-                              __const char *, size_t *, size_t *, int));
+typedef int (*__gconv_fct) (struct __gconv_step *, struct __gconv_step_data *,
+                           __const unsigned char **, __const unsigned char *,
+                           size_t *, int, int);
 
 /* Constructor and destructor for local data for conversion step.  */
-typedef int (*gconv_init_fct) __P ((struct gconv_step *,
-                                   struct gconv_step_data *));
-typedef void (*gconv_end_fct) __P ((struct gconv_step_data *));
+typedef int (*__gconv_init_fct) (struct __gconv_step *);
+typedef void (*__gconv_end_fct) (struct __gconv_step *);
 
 
 /* Description of a conversion step.  */
-struct gconv_step
+struct __gconv_step
 {
-  void *shlib_handle;
+  struct __gconv_loaded_object *__shlib_handle;
+  __const char *__modname;
 
-  __const char *from_name;
-  __const char *to_name;
+  int __counter;
 
-  gconv_fct fct;
-  gconv_init_fct init_fct;
-  gconv_end_fct end_fct;
-};
+  __const char *__from_name;
+  __const char *__to_name;
 
-/* Additional data for steps in use of conversion descriptor.  This is
-   allocated by the `init' function.  */
-struct gconv_step_data
-{
-  char *outbuf;                /* Output buffer for this step.  */
-  size_t outbufavail;  /* Bytes already available in output buffer.  */
-  size_t outbufsize;   /* Size of output buffer.  */
+  __gconv_fct __fct;
+  __gconv_init_fct __init_fct;
+  __gconv_end_fct __end_fct;
 
-  int is_last;
+  /* Information about the number of bytes needed or produced in this
+     step.  This helps optimizing the buffer sizes.  */
+  int __min_needed_from;
+  int __max_needed_from;
+  int __min_needed_to;
+  int __max_needed_to;
 
-  void *data;          /* Pointer to step-local data.  */
+  /* Flag whether this is a stateful encoding or not.  */
+  int __stateful;
+
+  void *__data;                /* Pointer to step-local data.  */
 };
 
-/* Combine conversion step description with data.  */
-typedef struct gconv_info
+/* Additional data for steps in use of conversion descriptor.  This is
+   allocated by the `init' function.  */
+struct __gconv_step_data
 {
-  size_t nsteps;
-  struct gconv_step *steps;
-  struct gconv_step_data *data;
-} *gconv_t;
-
+  unsigned char *__outbuf;    /* Output buffer for this step.  */
+  unsigned char *__outbufend; /* Address of first byte after the output
+                                buffer.  */
 
-/* Description for an available conversion module.  */
-struct gconv_module
-{
-  __const char *from_pattern;
-  __const char *from_constpfx;
-  size_t from_constpfx_len;
-  __const regex_t *from_regex;
+  /* Is this the last module in the chain.  */
+  int __flags;
 
-  __const char *to_string;
+  /* Counter for number of invocations of the module function for this
+     descriptor.  */
+  int __invocation_counter;
 
-  int cost;
+  /* Flag whether this is an internal use of the module (in the mb*towc*
+     and wc*tomb* functions) or regular with iconv(3).  */
+  int __internal_use;
 
-  __const char *module_name;
+  __mbstate_t *__statep;
+  __mbstate_t __state; /* This element must not be used directly by
+                          any module; always use STATEP!  */
 };
 
 
-/* Global variables.  */
-
-/* Database of alias names.  */
-extern void *__gconv_alias_db;
-
-/* Array with available modules.  */
-extern size_t __gconv_nmodules;
-extern struct gconv_module **__gconv_modules_db;
-
-
-/* Return in *HANDLE decriptor for transformation from FROMSET to TOSET.  */
-extern int __gconv_open __P ((__const char *__toset, __const char *__fromset,
-                             gconv_t *__handle));
-
-/* Free resources associated with transformation descriptor CD.  */
-extern int __gconv_close __P ((gconv_t cd));
-
-/* 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 written
-   characters in *CONVERTED if this pointer is not null.  */
-extern int __gconv __P ((gconv_t __cd,
-                        __const char **__inbuf, size_t *__inbytesleft,
-                        char **__outbuf, size_t *__outbytesleft,
-                        size_t *__converted));
-
-/* 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 __P ((__const char *__toset,
-                                       __const char *__fromset,
-                                       struct gconv_step **__handle,
-                                       size_t *__nsteps));
-
-/* Read all the configuration data and cache it.  */
-extern void __gconv_read_conf __P ((void));
-
-/* Comparison function to search alias.  */
-extern int __gconv_alias_compare __P ((__const void *__p1,
-                                      __const void *__p2));
-
-/* Clear reference to transformation step implementations which might
-   cause the code to be unloaded.  */
-extern int __gconv_close_transform __P ((struct gconv_step *__steps,
-                                        size_t __nsteps));
-
-
-/* Find in the shared object associated with HANDLE for a function with
-   name NAME.  Return function pointer or NULL.  */
-extern void *__gconv_find_func __P ((void *__handle, __const char *__name));
-
-/* Load shared object named by NAME.  If already loaded increment reference
-   count.  */
-extern void *__gconv_find_shlib __P ((__const char *__name));
-
-/* Release shared object.  If no further reference is available unload
-   the object.  */
-extern int __gconv_release_shlib __P ((void *__handle));
-
-/* Fill STEP with information about builtin module with NAME.  */
-extern void __gconv_get_builtin_trans __P ((__const char *__name,
-                                           struct gconv_step *__step));
-
-
-
-/* Builtin transformations.  */
-#ifdef _LIBC
-# define __BUILTIN_TRANS(Name) \
-  extern int Name __P ((struct gconv_step *__step,                           \
-                       struct gconv_step_data *__data, __const char *__inbuf,\
-                       size_t *__inlen, size_t *__written, int __do_flush))
-
-__BUILTIN_TRANS (__gconv_transform_dummy);
-__BUILTIN_TRANS (__gconv_transform_ucs4_utf8);
-__BUILTIN_TRANS (__gconv_transform_utf8_ucs4);
-# undef __BUITLIN_TRANS
-
-extern int __gconv_transform_init_rstate __P ((struct gconv_step *__step,
-                                             struct gconv_step_data *__data));
-extern void __gconv_transform_end_rstate __P ((struct gconv_step_data *__data));
-
-#endif
-
-__END_DECLS
+/* Combine conversion step description with data.  */
+typedef struct __gconv_info
+{
+  size_t __nsteps;
+  struct __gconv_step *__steps;
+  __extension__ struct __gconv_step_data __data[0];
+} *__gconv_t;
 
 #endif /* gconv.h */