include/iconv.h

   1 /*      $FreeBSD: head/include/iconv.h 281550 2015-04-15 09:09:20Z tijl $       */
   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
  40 #ifdef __cplusplus
  41 typedef bool    __iconv_bool;
  42 #elif __STDC_VERSION__ >= 199901L
  43 typedef _Bool   __iconv_bool;
  44 #else
  45 typedef int     __iconv_bool;
  46 #endif
  47
  48 struct __tag_iconv_t;
  49 typedef struct __tag_iconv_t    *iconv_t;
  50
  51 __BEGIN_DECLS
  52 iconv_t iconv_open(const char *, const char *);
  53 size_t  iconv(iconv_t, char ** __restrict,
  54               size_t * __restrict, char ** __restrict,
  55               size_t * __restrict);
  56 int     iconv_close(iconv_t);
  57 /*
  58  * non-portable interfaces for iconv
  59  */
  60 int     __iconv_get_list(char ***, size_t *, __iconv_bool);
  61 void    __iconv_free_list(char **, size_t);
  62 size_t  __iconv(iconv_t, char **, size_t *, char **,
  63                      size_t *, __uint32_t, size_t *);
  64 #define __ICONV_F_HIDE_INVALID  0x0001
  65
  66 /*
  67  * GNU interfaces for iconv
  68  */
  69 /* We have iconvctl() */
  70 #define _ICONV_VERSION  0x0108
  71 extern int _iconv_version;
  72
  73 typedef struct {
  74         void    *spaceholder[64];
  75 } iconv_allocation_t;
  76
  77 int      iconv_open_into(const char *, const char *, iconv_allocation_t *);
  78 void     iconv_set_relocation_prefix(const char *, const char *);
  79
  80 /*
  81  * iconvctl() request macros
  82  */
  83 #define ICONV_TRIVIALP          0
  84 #define ICONV_GET_TRANSLITERATE 1
  85 #define ICONV_SET_TRANSLITERATE 2
  86 #define ICONV_GET_DISCARD_ILSEQ 3
  87 #define ICONV_SET_DISCARD_ILSEQ 4
  88 #define ICONV_SET_HOOKS         5
  89 #define ICONV_SET_FALLBACKS     6
  90 #define ICONV_GET_ILSEQ_INVALID 128
  91 #define ICONV_SET_ILSEQ_INVALID 129
  92
  93 typedef void (*iconv_unicode_char_hook) (unsigned int mbr, void *data);
  94 typedef void (*iconv_wide_char_hook) (wchar_t wc, void *data);
  95
  96 struct iconv_hooks {
  97         iconv_unicode_char_hook          uc_hook;
  98         iconv_wide_char_hook             wc_hook;
  99         void                            *data;
 100 };
 101
 102 /*
 103  * Fallbacks aren't supported but type definitions are provided for
 104  * source compatibility.
 105  */
 106 typedef void (*iconv_unicode_mb_to_uc_fallback) (const char*,
 107                 size_t, void (*write_replacement) (const unsigned int *,
 108                 size_t, void*), void*, void*);
 109 typedef void (*iconv_unicode_uc_to_mb_fallback) (unsigned int,
 110                 void (*write_replacement) (const char *, size_t, void*),
 111                 void*, void*);
 112 typedef void (*iconv_wchar_mb_to_wc_fallback) (const char*, size_t,
 113                 void (*write_replacement) (const wchar_t *, size_t, void*),
 114                 void*, void*);
 115 typedef void (*iconv_wchar_wc_to_mb_fallback) (wchar_t,
 116                 void (*write_replacement) (const char *, size_t, void*),
 117                 void*, void*);
 118
 119 struct iconv_fallbacks {
 120         iconv_unicode_mb_to_uc_fallback  mb_to_uc_fallback;
 121         iconv_unicode_uc_to_mb_fallback  uc_to_mb_fallback;
 122         iconv_wchar_mb_to_wc_fallback    mb_to_wc_fallback;
 123         iconv_wchar_wc_to_mb_fallback    wc_to_mb_fallback;
 124         void                            *data;
 125 };
 126
 127
 128 void             iconvlist(int (*do_one) (unsigned int, const char * const *,
 129                     void *), void *);
 130 const char      *iconv_canonicalize(const char *);
 131 int              iconvctl(iconv_t, int, void *);
 132 __END_DECLS
 133
 134 #endif /* !_ICONV_H_ */