libiconv/lib/converters.h

   1 /*
   2  * Copyright (C) 1999-2002 Free Software Foundation, Inc.
   3  * This file is part of the GNU LIBICONV Library.
   4  *
   5  * The GNU LIBICONV Library is free software; you can redistribute it
   6  * and/or modify it under the terms of the GNU Library General Public
   7  * License as published by the Free Software Foundation; either version 2
   8  * of the License, or (at your option) any later version.
   9  *
  10  * The GNU LIBICONV Library is distributed in the hope that it will be
  11  * useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * Library General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU Library General Public
  16  * License along with the GNU LIBICONV Library; see the file COPYING.LIB.
  17  * If not, write to the Free Software Foundation, Inc., 59 Temple Place -
  18  * Suite 330, Boston, MA 02111-1307, USA.
  19  */
  20
  21 /* This file defines all the converters. */
  22
  23
  24 /* Our own notion of wide character, as UCS-4, according to ISO-10646-1. */
  25 typedef unsigned int ucs4_t;
  26
  27 /* State used by a conversion. 0 denotes the initial state. */
  28 typedef unsigned int state_t;
  29
  30 /* iconv_t is an opaque type. This is the real iconv_t type. */
  31 typedef struct conv_struct * conv_t;
  32
  33 /*
  34  * Data type for conversion multibyte -> unicode
  35  */
  36 struct mbtowc_funcs {
  37   int (*xxx_mbtowc) (conv_t conv, ucs4_t *pwc, unsigned char const *s, int n);
  38   /*
  39    * int xxx_mbtowc (conv_t conv, ucs4_t *pwc, unsigned char const *s, int n)
  40    * converts the byte sequence starting at s to a wide character. Up to n bytes
  41    * are available at s. n is >= 1.
  42    * Result is number of bytes consumed (if a wide character was read),
  43    * or -1 if invalid, or -2 if n too small, or -2-(number of bytes consumed)
  44    * if only a shift sequence was read.
  45    */
  46   int (*xxx_flushwc) (conv_t conv, ucs4_t *pwc);
  47   /*
  48    * int xxx_flushwc (conv_t conv, ucs4_t *pwc)
  49    * returns to the initial state and stores the pending wide character, if any.
  50    * Result is 1 (if a wide character was read) or 0 if none was pending.
  51    */
  52 };
  53
  54 /* Return code if invalid. (xxx_mbtowc) */
  55 #define RET_ILSEQ      -1
  56 /* Return code if only a shift sequence of n bytes was read. (xxx_mbtowc) */
  57 #define RET_TOOFEW(n)  (-2-(n))
  58
  59 /*
  60  * Data type for conversion unicode -> multibyte
  61  */
  62 struct wctomb_funcs {
  63   int (*xxx_wctomb) (conv_t conv, unsigned char *r, ucs4_t wc, int n);
  64   /*
  65    * int xxx_wctomb (conv_t conv, unsigned char *r, ucs4_t wc, int n)
  66    * converts the wide character wc to the character set xxx, and stores the
  67    * result beginning at r. Up to n bytes may be written at r. n is >= 1.
  68    * Result is number of bytes written, or -1 if invalid, or -2 if n too small.
  69    */
  70   int (*xxx_reset) (conv_t conv, unsigned char *r, int n);
  71   /*
  72    * int xxx_reset (conv_t conv, unsigned char *r, int n)
  73    * stores a shift sequences returning to the initial state beginning at r.
  74    * Up to n bytes may be written at r. n is >= 0.
  75    * Result is number of bytes written, or -2 if n too small.
  76    */
  77 };
  78
  79 /* Return code if invalid. (xxx_wctomb) */
  80 #define RET_ILUNI      -1
  81 /* Return code if output buffer is too small. (xxx_wctomb, xxx_reset) */
  82 #define RET_TOOSMALL   -2
  83
  84 /*
  85  * Contents of a conversion descriptor.
  86  */
  87 struct conv_struct {
  88   struct loop_funcs lfuncs;
  89   /* Input (conversion multibyte -> unicode) */
  90   int iindex;
  91   struct mbtowc_funcs ifuncs;
  92   state_t istate;
  93   /* Output (conversion unicode -> multibyte) */
  94   int oindex;
  95   struct wctomb_funcs ofuncs;
  96   int oflags;
  97   state_t ostate;
  98   /* Operation flags */
  99   int transliterate;
 100   int discard_ilseq;
 101 };
 102
 103 /*
 104  * Include all the converters.
 105  */
 106
 107 #include "ascii.h"
 108
 109 /* General multi-byte encodings */
 110 #include "utf8.h"
 111 #include "ucs2.h"
 112 #include "ucs2be.h"
 113 #include "ucs2le.h"
 114 #include "ucs4.h"
 115 #include "ucs4be.h"
 116 #include "ucs4le.h"
 117 #include "utf16.h"
 118 #include "utf16be.h"
 119 #include "utf16le.h"
 120 #include "utf32.h"
 121 #include "utf32be.h"
 122 #include "utf32le.h"
 123 #include "utf7.h"
 124 #include "ucs2internal.h"
 125 #include "ucs2swapped.h"
 126 #include "ucs4internal.h"
 127 #include "ucs4swapped.h"
 128 #include "c99.h"
 129 #include "java.h"
 130
 131 /* 8-bit encodings */
 132 #include "iso8859_1.h"
 133 #include "iso8859_2.h"
 134 #include "iso8859_3.h"
 135 #include "iso8859_4.h"
 136 #include "iso8859_5.h"
 137 #include "iso8859_6.h"
 138 #include "iso8859_7.h"
 139 #include "iso8859_8.h"
 140 #include "iso8859_9.h"
 141 #include "iso8859_10.h"
 142 #include "iso8859_13.h"
 143 #include "iso8859_14.h"
 144 #include "iso8859_15.h"
 145 #include "iso8859_16.h"
 146 #include "koi8_r.h"
 147 #include "koi8_u.h"
 148 #include "koi8_ru.h"
 149 #include "cp1250.h"
 150 #include "cp1251.h"
 151 #include "cp1252.h"
 152 #include "cp1253.h"
 153 #include "cp1254.h"
 154 #include "cp1255.h"
 155 #include "cp1256.h"
 156 #include "cp1257.h"
 157 #include "cp1258.h"
 158 #include "cp850.h"
 159 #include "cp862.h"
 160 #include "cp866.h"
 161 #include "mac_roman.h"
 162 #include "mac_centraleurope.h"
 163 #include "mac_iceland.h"
 164 #include "mac_croatian.h"
 165 #include "mac_romania.h"
 166 #include "mac_cyrillic.h"
 167 #include "mac_ukraine.h"
 168 #include "mac_greek.h"
 169 #include "mac_turkish.h"
 170 #include "mac_hebrew.h"
 171 #include "mac_arabic.h"
 172 #include "mac_thai.h"
 173 #include "hp_roman8.h"
 174 #include "nextstep.h"
 175 #include "armscii_8.h"
 176 #include "georgian_academy.h"
 177 #include "georgian_ps.h"
 178 #include "koi8_t.h"
 179 #include "mulelao.h"
 180 #include "cp1133.h"
 181 #include "tis620.h"
 182 #include "cp874.h"
 183 #include "viscii.h"
 184 #include "tcvn.h"
 185
 186 /* CJK character sets [CCS = coded character set] [CJKV.INF chapter 3] */
 187
 188 typedef struct {
 189   unsigned short indx; /* index into big table */
 190   unsigned short used; /* bitmask of used entries */
 191 } Summary16;
 192
 193 #include "iso646_jp.h"
 194 #include "jisx0201.h"
 195 #include "jisx0208.h"
 196 #include "jisx0212.h"
 197
 198 #include "iso646_cn.h"
 199 #include "gb2312.h"
 200 #include "isoir165.h"
 201 /*#include "gb12345.h"*/
 202 #include "gbk.h"
 203 #include "cns11643.h"
 204 #include "big5.h"
 205
 206 #include "ksc5601.h"
 207 #include "johab_hangul.h"
 208
 209 /* CJK encodings [CES = character encoding scheme] [CJKV.INF chapter 4] */
 210
 211 #include "euc_jp.h"
 212 #include "sjis.h"
 213 #include "cp932.h"
 214 #include "iso2022_jp.h"
 215 #include "iso2022_jp1.h"
 216 #include "iso2022_jp2.h"
 217
 218 #include "euc_cn.h"
 219 #include "ces_gbk.h"
 220 #include "gb18030.h"
 221 #include "iso2022_cn.h"
 222 #include "iso2022_cnext.h"
 223 #include "hz.h"
 224 #include "euc_tw.h"
 225 #include "ces_big5.h"
 226 #include "cp950.h"
 227 #include "big5hkscs.h"
 228
 229 #include "euc_kr.h"
 230 #include "cp949.h"
 231 #include "johab.h"
 232 #include "iso2022_kr.h"
 233
 234 /* Encodings used by system dependent locales. */
 235
 236 #ifdef USE_AIX
 237 #include "cp856.h"
 238 #include "cp922.h"
 239 #include "cp943.h"
 240 #include "cp1046.h"
 241 #include "cp1124.h"
 242 #include "cp1129.h"
 243 #include "cp1161.h"
 244 #include "cp1162.h"
 245 #include "cp1163.h"
 246 #endif
 247
 248 #ifdef USE_OSF1
 249 #include "dec_kanji.h"
 250 #include "dec_hanyu.h"
 251 #endif
 252
 253 #ifdef USE_DOS
 254 #include "cp437.h"
 255 #include "cp737.h"
 256 #include "cp775.h"
 257 #include "cp852.h"
 258 #include "cp853.h"
 259 #include "cp855.h"
 260 #include "cp857.h"
 261 #include "cp858.h"
 262 #include "cp860.h"
 263 #include "cp861.h"
 264 #include "cp863.h"
 265 #include "cp864.h"
 266 #include "cp865.h"
 267 #include "cp869.h"
 268 #include "cp1125.h"
 269 #endif
 270
 271 #ifdef USE_EXTRA
 272 #include "euc_jisx0213.h"
 273 #include "shift_jisx0213.h"
 274 #include "iso2022_jp3.h"
 275 #include "tds565.h"
 276 #include "riscos1.h"
 277 #endif
 278