include/iconv.h

   1 /*      $FreeBSD: head/include/iconv.h 255297 2013-09-06 09:46:44Z theraven $   */
   2 /*      $NetBSD: iconv.h,v 1.6 2005/02/03 04:39:32 perry Exp $  */
   3
   4 /*-
   5  * Copyright (c) 2003 Citrus Project,
   6  * Copyright (c) 2009, 2010 Gabor Kovesdan <gabor@FreeBSD.org>
   7  * All rights reserved.
   8  *
   9  * Redistribution and use in source and binary forms, with or without
  10  * modification, are permitted provided that the following conditions
  11  * are met:
  12  * 1. Redistributions of source code must retain the above copyright
  13  *    notice, this list of conditions and the following disclaimer.
  14  * 2. Redistributions in binary form must reproduce the above copyright
  15  *    notice, this list of conditions and the following disclaimer in the
  16  *    documentation and/or other materials provided with the distribution.
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  19  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  21  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  22  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  23  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  24  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  25  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  26  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  27  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  28  * SUCH DAMAGE.
  29  *
  30  */
  31
  32 #ifndef _ICONV_H_
  33 #define _ICONV_H_
  34
  35 #include <sys/cdefs.h>
  36 #include <sys/types.h>
  37
  38 #include <wchar.h>
  39 #include <sys/types.h>
  40
  41 #ifdef __LIBICONV_COMPAT
  42 #define libiconv_open           iconv_open
  43 #define libiconv_close          iconv_close
  44 #define libiconv                iconv
  45 #define libiconv_t              iconv_t
  46 #endif
  47 #ifdef __cplusplus
  48 typedef bool    __iconv_bool;
  49 #elif __STDC_VERSION__ >= 199901L
  50 typedef _Bool   __iconv_bool;
  51 #else
  52 typedef int     __iconv_bool;
  53 #endif
  54
  55 struct __tag_iconv_t;
  56 typedef struct __tag_iconv_t    *iconv_t;
  57
  58 __BEGIN_DECLS
  59 iconv_t iconv_open(const char *, const char *);
  60 size_t  iconv(iconv_t, const char ** __restrict,
  61               size_t * __restrict, char ** __restrict,
  62               size_t * __restrict);
  63 int     iconv_close(iconv_t);
  64 /*
  65  * non-portable interfaces for iconv
  66  */
  67 int     __iconv_get_list(char ***, size_t *, __iconv_bool);
  68 void    __iconv_free_list(char **, size_t);
  69 size_t  __iconv(iconv_t, const char **, size_t *, char **,
  70                      size_t *, __uint32_t, size_t *);
  71 #define __ICONV_F_HIDE_INVALID  0x0001
  72
  73 /*
  74  * GNU interfaces for iconv
  75  */
  76 #ifdef __LIBICONV_COMPAT
  77 #define libiconv_open_into              iconv_open_into
  78 #define libiconvctl                     iconvctl
  79 #define libiconvlist                    iconvlist
  80 #define libiconv_set_relocation_prefix  iconv_set_relocation_prefix
  81 #endif
  82
  83 /* We have iconvctl() */
  84 #define _ICONV_VERSION  0x0108
  85 extern int _iconv_version;
  86
  87 #ifdef __LIBICONV_COMPAT
  88 #define _libiconv_version               _iconv_version
  89 #define _LIBICONV_VERSION               _ICONV_VERSION
  90 #endif
  91
  92 typedef struct {
  93         void    *spaceholder[64];
  94 } iconv_allocation_t;
  95
  96 int      iconv_open_into(const char *, const char *, iconv_allocation_t *);
  97 void     iconv_set_relocation_prefix(const char *orig_prefix,
  98              const char *curr_prefix);
  99
 100 /*
 101  * iconvctl() request macros
 102  */
 103 #define ICONV_TRIVIALP          0
 104 #define ICONV_GET_TRANSLITERATE 1
 105 #define ICONV_SET_TRANSLITERATE 2
 106 #define ICONV_GET_DISCARD_ILSEQ 3
 107 #define ICONV_SET_DISCARD_ILSEQ 4
 108 #define ICONV_SET_HOOKS         5
 109 #define ICONV_SET_FALLBACKS     6
 110
 111 typedef void (*iconv_unicode_char_hook) (unsigned int mbr, void *data);
 112 typedef void (*iconv_wide_char_hook) (wchar_t wc, void *data);
 113
 114 struct iconv_hooks {
 115         iconv_unicode_char_hook          uc_hook;
 116         iconv_wide_char_hook             wc_hook;
 117         void                            *data;
 118 };
 119
 120 /*
 121  * Fallbacks aren't supported but type definitions are provided for
 122  * source compatibility.
 123  */
 124 typedef void (*iconv_unicode_mb_to_uc_fallback) (const char*,
 125                 size_t, void (*write_replacement) (const unsigned int *,
 126                 size_t, void*), void*, void*);
 127 typedef void (*iconv_unicode_uc_to_mb_fallback) (unsigned int,
 128                 void (*write_replacement) (const char *, size_t, void*),
 129                 void*, void*);
 130 typedef void (*iconv_wchar_mb_to_wc_fallback) (const char*, size_t,
 131                 void (*write_replacement) (const wchar_t *, size_t, void*),
 132                 void*, void*);
 133 typedef void (*iconv_wchar_wc_to_mb_fallback) (wchar_t,
 134                 void (*write_replacement) (const char *, size_t, void*),
 135                 void*, void*);
 136
 137 struct iconv_fallbacks {
 138         iconv_unicode_mb_to_uc_fallback  mb_to_uc_fallback;
 139         iconv_unicode_uc_to_mb_fallback  uc_to_mb_fallback;
 140         iconv_wchar_mb_to_wc_fallback    mb_to_wc_fallback;
 141         iconv_wchar_wc_to_mb_fallback    wc_to_mb_fallback;
 142         void                            *data;
 143 };
 144
 145
 146 void             iconvlist(int (*do_one) (unsigned int, const char * const *,
 147                     void *), void *);
 148 const char      *iconv_canonicalize(const char *);
 149 int              iconvctl(iconv_t, int, void *);
 150 __END_DECLS
 151
 152 #endif /* !_ICONV_H_ */