xref: /aosp_15_r20/external/icu/libicu/cts_headers/ucnvmbcs.h (revision 0e209d3975ff4a8c132096b14b0e9364a753506e)
1*0e209d39SAndroid Build Coastguard Worker // © 2016 and later: Unicode, Inc. and others.
2*0e209d39SAndroid Build Coastguard Worker // License & terms of use: http://www.unicode.org/copyright.html
3*0e209d39SAndroid Build Coastguard Worker /*
4*0e209d39SAndroid Build Coastguard Worker ******************************************************************************
5*0e209d39SAndroid Build Coastguard Worker *
6*0e209d39SAndroid Build Coastguard Worker *   Copyright (C) 2000-2013, International Business Machines
7*0e209d39SAndroid Build Coastguard Worker *   Corporation and others.  All Rights Reserved.
8*0e209d39SAndroid Build Coastguard Worker *
9*0e209d39SAndroid Build Coastguard Worker ******************************************************************************
10*0e209d39SAndroid Build Coastguard Worker *   file name:  ucnvmbcs.h
11*0e209d39SAndroid Build Coastguard Worker *   encoding:   UTF-8
12*0e209d39SAndroid Build Coastguard Worker *   tab size:   8 (not used)
13*0e209d39SAndroid Build Coastguard Worker *   indentation:4
14*0e209d39SAndroid Build Coastguard Worker *
15*0e209d39SAndroid Build Coastguard Worker *   created on: 2000jul07
16*0e209d39SAndroid Build Coastguard Worker *   created by: Markus W. Scherer
17*0e209d39SAndroid Build Coastguard Worker */
18*0e209d39SAndroid Build Coastguard Worker 
19*0e209d39SAndroid Build Coastguard Worker #ifndef __UCNVMBCS_H__
20*0e209d39SAndroid Build Coastguard Worker #define __UCNVMBCS_H__
21*0e209d39SAndroid Build Coastguard Worker 
22*0e209d39SAndroid Build Coastguard Worker #include "unicode/utypes.h"
23*0e209d39SAndroid Build Coastguard Worker 
24*0e209d39SAndroid Build Coastguard Worker #if !UCONFIG_NO_CONVERSION
25*0e209d39SAndroid Build Coastguard Worker 
26*0e209d39SAndroid Build Coastguard Worker #include "unicode/ucnv.h"
27*0e209d39SAndroid Build Coastguard Worker #include "ucnv_cnv.h"
28*0e209d39SAndroid Build Coastguard Worker #include "ucnv_ext.h"
29*0e209d39SAndroid Build Coastguard Worker 
30*0e209d39SAndroid Build Coastguard Worker /**
31*0e209d39SAndroid Build Coastguard Worker  * ICU conversion (.cnv) data file structure, following the usual UDataInfo
32*0e209d39SAndroid Build Coastguard Worker  * header.
33*0e209d39SAndroid Build Coastguard Worker  *
34*0e209d39SAndroid Build Coastguard Worker  * Format version: 6.2
35*0e209d39SAndroid Build Coastguard Worker  *
36*0e209d39SAndroid Build Coastguard Worker  * struct UConverterStaticData -- struct containing the converter name, IBM CCSID,
37*0e209d39SAndroid Build Coastguard Worker  *                                min/max bytes per character, etc.
38*0e209d39SAndroid Build Coastguard Worker  *                                see ucnv_bld.h
39*0e209d39SAndroid Build Coastguard Worker  *
40*0e209d39SAndroid Build Coastguard Worker  * --------------------
41*0e209d39SAndroid Build Coastguard Worker  *
42*0e209d39SAndroid Build Coastguard Worker  * The static data is followed by conversionType-specific data structures.
43*0e209d39SAndroid Build Coastguard Worker  * At the moment, there are only variations of MBCS converters. They all have
44*0e209d39SAndroid Build Coastguard Worker  * the same toUnicode structures, while the fromUnicode structures for SBCS
45*0e209d39SAndroid Build Coastguard Worker  * differ from those for other MBCS-style converters.
46*0e209d39SAndroid Build Coastguard Worker  *
47*0e209d39SAndroid Build Coastguard Worker  * _MBCSHeader.version 5 is optional and not backward-compatible
48*0e209d39SAndroid Build Coastguard Worker  * (as usual for changes in the major version field).
49*0e209d39SAndroid Build Coastguard Worker  *
50*0e209d39SAndroid Build Coastguard Worker  * Versions 5.m work like versions 4.m except:
51*0e209d39SAndroid Build Coastguard Worker  * - The _MBCSHeader has variable length (and is always longer than in version 4).
52*0e209d39SAndroid Build Coastguard Worker  *   See the struct _MBCSHeader further description below.
53*0e209d39SAndroid Build Coastguard Worker  * - There is a set of flags which indicate further incompatible changes.
54*0e209d39SAndroid Build Coastguard Worker  *   (Reader code must reject the file if it does not recognize them all.)
55*0e209d39SAndroid Build Coastguard Worker  * - In particular, one of these flags indicates that most of the fromUnicode
56*0e209d39SAndroid Build Coastguard Worker  *   data is missing and must be reconstituted from the toUnicode data
57*0e209d39SAndroid Build Coastguard Worker  *   and from the utf8Friendly mbcsIndex at load time.
58*0e209d39SAndroid Build Coastguard Worker  *   (This only works with a utf8Friendly table.)
59*0e209d39SAndroid Build Coastguard Worker  *   In this case, makeconv may increase maxFastUChar automatically to U+FFFF.
60*0e209d39SAndroid Build Coastguard Worker  *
61*0e209d39SAndroid Build Coastguard Worker  * The first of these versions is 5.3, which is like 4.3 except for the differences above.
62*0e209d39SAndroid Build Coastguard Worker  *
63*0e209d39SAndroid Build Coastguard Worker  * When possible, makeconv continues to generate version 4.m files.
64*0e209d39SAndroid Build Coastguard Worker  *
65*0e209d39SAndroid Build Coastguard Worker  * _MBCSHeader.version 5.4/4.4 supports "good one-way" mappings (|4)
66*0e209d39SAndroid Build Coastguard Worker  * in the extension tables (fromUTableValues bit 30). See ucnv_ext.h for details.
67*0e209d39SAndroid Build Coastguard Worker  *
68*0e209d39SAndroid Build Coastguard Worker  * _MBCSHeader.version 4.3 optionally modifies the fromUnicode data structures
69*0e209d39SAndroid Build Coastguard Worker  * slightly and optionally adds a table for conversion to MBCS (non-SBCS)
70*0e209d39SAndroid Build Coastguard Worker  * charsets.
71*0e209d39SAndroid Build Coastguard Worker  *
72*0e209d39SAndroid Build Coastguard Worker  * The modifications are to make the data utf8Friendly. Not every 4.3 file
73*0e209d39SAndroid Build Coastguard Worker  * file contains utf8Friendly data.
74*0e209d39SAndroid Build Coastguard Worker  * It is utf8Friendly if _MBCSHeader.version[2]!=0.
75*0e209d39SAndroid Build Coastguard Worker  * In this case, the data structures are utf8Friendly up to the code point
76*0e209d39SAndroid Build Coastguard Worker  *   maxFastUChar=((_MBCSHeader.version[2]<<8)|0xff)
77*0e209d39SAndroid Build Coastguard Worker  *
78*0e209d39SAndroid Build Coastguard Worker  * A utf8Friendly file has fromUnicode stage 3 entries for code points up to
79*0e209d39SAndroid Build Coastguard Worker  * maxFastUChar allocated in blocks of 64 for indexing with the 6 bits from
80*0e209d39SAndroid Build Coastguard Worker  * a UTF-8 trail byte. ASCII is allocated linearly with 128 contiguous entries.
81*0e209d39SAndroid Build Coastguard Worker  *
82*0e209d39SAndroid Build Coastguard Worker  * In addition, a utf8Friendly MBCS file contains an additional
83*0e209d39SAndroid Build Coastguard Worker  *   uint16_t mbcsIndex[(maxFastUChar+1)>>6];
84*0e209d39SAndroid Build Coastguard Worker  * which replaces the stage 1 and 2 tables for indexing with bits from the
85*0e209d39SAndroid Build Coastguard Worker  * UTF-8 lead byte and middle trail byte. Unlike the older MBCS stage 2 table,
86*0e209d39SAndroid Build Coastguard Worker  * the mbcsIndex does not contain roundtrip flags. Therefore, all fallbacks
87*0e209d39SAndroid Build Coastguard Worker  * from code points up to maxFastUChar (and roundtrips to 0x00) are moved to
88*0e209d39SAndroid Build Coastguard Worker  * the extension data structure. This also allows for faster roundtrip
89*0e209d39SAndroid Build Coastguard Worker  * conversion from UTF-16.
90*0e209d39SAndroid Build Coastguard Worker  *
91*0e209d39SAndroid Build Coastguard Worker  * SBCS files do not contain an additional sbcsIndex[] array because the
92*0e209d39SAndroid Build Coastguard Worker  * proportional size increase would be noticeable, but the runtime
93*0e209d39SAndroid Build Coastguard Worker  * code builds one for the code point range for which the runtime conversion
94*0e209d39SAndroid Build Coastguard Worker  * code is optimized.
95*0e209d39SAndroid Build Coastguard Worker  *
96*0e209d39SAndroid Build Coastguard Worker  * For SBCS, maxFastUChar should be at least U+0FFF. The initial makeconv
97*0e209d39SAndroid Build Coastguard Worker  * implementation sets it to U+1FFF. Because the sbcsIndex is not stored in
98*0e209d39SAndroid Build Coastguard Worker  * the file, a larger maxFastUChar only affects stage 3 block allocation size
99*0e209d39SAndroid Build Coastguard Worker  * and is free in empty blocks. (Larger blocks with sparse contents cause larger
100*0e209d39SAndroid Build Coastguard Worker  * files.) U+1FFF includes almost all of the small scripts.
101*0e209d39SAndroid Build Coastguard Worker  * U+0FFF covers UTF-8 two-byte sequences and three-byte sequences starting with
102*0e209d39SAndroid Build Coastguard Worker  * 0xe0. This includes most scripts with legacy SBCS charsets.
103*0e209d39SAndroid Build Coastguard Worker  * The initial runtime implementation using 4.3 files only builds an sbcsIndex
104*0e209d39SAndroid Build Coastguard Worker  * for code points up to U+0FFF.
105*0e209d39SAndroid Build Coastguard Worker  *
106*0e209d39SAndroid Build Coastguard Worker  * For MBCS, maxFastUChar should be at least U+D7FF (=initial value).
107*0e209d39SAndroid Build Coastguard Worker  * This boundary is convenient because practically all of the commonly used
108*0e209d39SAndroid Build Coastguard Worker  * characters are below it, and because it is the boundary to surrogate
109*0e209d39SAndroid Build Coastguard Worker  * code points, above which special handling is necessary anyway.
110*0e209d39SAndroid Build Coastguard Worker  * (Surrogate pair assembly for UTF-16, validity checking for UTF-8.)
111*0e209d39SAndroid Build Coastguard Worker  *
112*0e209d39SAndroid Build Coastguard Worker  * maxFastUChar could be up to U+FFFF to cover the whole BMP, which could be
113*0e209d39SAndroid Build Coastguard Worker  * useful especially for conversion from UTF-8 when the input can be assumed
114*0e209d39SAndroid Build Coastguard Worker  * to be valid, because the surrogate range would then not have to be
115*0e209d39SAndroid Build Coastguard Worker  * checked.
116*0e209d39SAndroid Build Coastguard Worker  * (With maxFastUChar=0xffff, makeconv would have to check for mbcsIndex value
117*0e209d39SAndroid Build Coastguard Worker  * overflow because with the all-unassigned block 0 and nearly full mappings
118*0e209d39SAndroid Build Coastguard Worker  * from the BMP it is theoretically possible that an index into stage 3
119*0e209d39SAndroid Build Coastguard Worker  * exceeds 16 bits.)
120*0e209d39SAndroid Build Coastguard Worker  *
121*0e209d39SAndroid Build Coastguard Worker  * _MBCSHeader.version 4.2 adds an optional conversion extension data structure.
122*0e209d39SAndroid Build Coastguard Worker  * If it is present, then an ICU version reading header versions 4.0 or 4.1
123*0e209d39SAndroid Build Coastguard Worker  * will be able to use the base table and ignore the extension.
124*0e209d39SAndroid Build Coastguard Worker  *
125*0e209d39SAndroid Build Coastguard Worker  * The unicodeMask in the static data is part of the base table data structure.
126*0e209d39SAndroid Build Coastguard Worker  * Especially, the UCNV_HAS_SUPPLEMENTARY flag determines the length of the
127*0e209d39SAndroid Build Coastguard Worker  * fromUnicode stage 1 array.
128*0e209d39SAndroid Build Coastguard Worker  * The static data unicodeMask refers only to the base table's properties if
129*0e209d39SAndroid Build Coastguard Worker  * a base table is included.
130*0e209d39SAndroid Build Coastguard Worker  * In an extension-only file, the static data unicodeMask is 0.
131*0e209d39SAndroid Build Coastguard Worker  * The extension data indexes have a separate field with the unicodeMask flags.
132*0e209d39SAndroid Build Coastguard Worker  *
133*0e209d39SAndroid Build Coastguard Worker  * MBCS-style data structure following the static data.
134*0e209d39SAndroid Build Coastguard Worker  * Offsets are counted in bytes from the beginning of the MBCS header structure.
135*0e209d39SAndroid Build Coastguard Worker  * Details about usage in comments in ucnvmbcs.c.
136*0e209d39SAndroid Build Coastguard Worker  *
137*0e209d39SAndroid Build Coastguard Worker  * struct _MBCSHeader (see the definition in this header file below)
138*0e209d39SAndroid Build Coastguard Worker  * contains 32-bit fields as follows:
139*0e209d39SAndroid Build Coastguard Worker  * 8 values:
140*0e209d39SAndroid Build Coastguard Worker  *  0   uint8_t[4]  MBCS version in UVersionInfo format (currently 4.3.x.0)
141*0e209d39SAndroid Build Coastguard Worker  *  1   uint32_t    countStates
142*0e209d39SAndroid Build Coastguard Worker  *  2   uint32_t    countToUFallbacks
143*0e209d39SAndroid Build Coastguard Worker  *  3   uint32_t    offsetToUCodeUnits
144*0e209d39SAndroid Build Coastguard Worker  *  4   uint32_t    offsetFromUTable
145*0e209d39SAndroid Build Coastguard Worker  *  5   uint32_t    offsetFromUBytes
146*0e209d39SAndroid Build Coastguard Worker  *  6   uint32_t    flags, bits:
147*0e209d39SAndroid Build Coastguard Worker  *                      31.. 8 offsetExtension -- _MBCSHeader.version 4.2 (ICU 2.8) and higher
148*0e209d39SAndroid Build Coastguard Worker  *                                                0 for older versions and if
149*0e209d39SAndroid Build Coastguard Worker  *                                                there is not extension structure
150*0e209d39SAndroid Build Coastguard Worker  *                       7.. 0 outputType
151*0e209d39SAndroid Build Coastguard Worker  *  7   uint32_t    fromUBytesLength -- _MBCSHeader.version 4.1 (ICU 2.4) and higher
152*0e209d39SAndroid Build Coastguard Worker  *                  counts bytes in fromUBytes[]
153*0e209d39SAndroid Build Coastguard Worker  *
154*0e209d39SAndroid Build Coastguard Worker  * New and required in version 5:
155*0e209d39SAndroid Build Coastguard Worker  *  8   uint32_t    options, bits:
156*0e209d39SAndroid Build Coastguard Worker  *                      31..16 reserved for flags that can be added without breaking
157*0e209d39SAndroid Build Coastguard Worker  *                                 backward compatibility
158*0e209d39SAndroid Build Coastguard Worker  *                      15.. 6 reserved for flags whose addition will break
159*0e209d39SAndroid Build Coastguard Worker  *                                 backward compatibility
160*0e209d39SAndroid Build Coastguard Worker  *                           6 MBCS_OPT_FROM_U -- if set,
161*0e209d39SAndroid Build Coastguard Worker  *                                 then most of the fromUnicode data is omitted;
162*0e209d39SAndroid Build Coastguard Worker  *                                 fullStage2Length is present and the missing
163*0e209d39SAndroid Build Coastguard Worker  *                                 bottom part of stage 2 must be reconstituted from
164*0e209d39SAndroid Build Coastguard Worker  *                                 the toUnicode data;
165*0e209d39SAndroid Build Coastguard Worker  *                                 stage 3 is missing completely as well;
166*0e209d39SAndroid Build Coastguard Worker  *                                 not used for SBCS tables
167*0e209d39SAndroid Build Coastguard Worker  *                       5.. 0 length of the _MBCSHeader (number of uint32_t)
168*0e209d39SAndroid Build Coastguard Worker  *
169*0e209d39SAndroid Build Coastguard Worker  * New and optional in version 5:
170*0e209d39SAndroid Build Coastguard Worker  *  9   uint32_t    fullStage2Length: used if MBCS_OPT_FROM_U is set
171*0e209d39SAndroid Build Coastguard Worker  *                                 specifies the full length of stage 2
172*0e209d39SAndroid Build Coastguard Worker  *                                 including the omitted part
173*0e209d39SAndroid Build Coastguard Worker  *
174*0e209d39SAndroid Build Coastguard Worker  * if(outputType==MBCS_OUTPUT_EXT_ONLY) {
175*0e209d39SAndroid Build Coastguard Worker  *     -- base table name for extension-only table
176*0e209d39SAndroid Build Coastguard Worker  *     char baseTableName[variable]; -- with NUL plus padding for 4-alignment
177*0e209d39SAndroid Build Coastguard Worker  *
178*0e209d39SAndroid Build Coastguard Worker  *     -- all _MBCSHeader fields except for version and flags are 0
179*0e209d39SAndroid Build Coastguard Worker  * } else {
180*0e209d39SAndroid Build Coastguard Worker  *     -- normal base table with optional extension
181*0e209d39SAndroid Build Coastguard Worker  *
182*0e209d39SAndroid Build Coastguard Worker  *     int32_t stateTable[countStates][256];
183*0e209d39SAndroid Build Coastguard Worker  *
184*0e209d39SAndroid Build Coastguard Worker  *     struct _MBCSToUFallback { (fallbacks are sorted by offset)
185*0e209d39SAndroid Build Coastguard Worker  *         uint32_t offset;
186*0e209d39SAndroid Build Coastguard Worker  *         UChar32 codePoint;
187*0e209d39SAndroid Build Coastguard Worker  *     } toUFallbacks[countToUFallbacks];
188*0e209d39SAndroid Build Coastguard Worker  *
189*0e209d39SAndroid Build Coastguard Worker  *     uint16_t unicodeCodeUnits[(offsetFromUTable-offsetToUCodeUnits)/2];
190*0e209d39SAndroid Build Coastguard Worker  *                  (padded to an even number of units)
191*0e209d39SAndroid Build Coastguard Worker  *
192*0e209d39SAndroid Build Coastguard Worker  *     -- stage 1 tables
193*0e209d39SAndroid Build Coastguard Worker  *     if(staticData.unicodeMask&UCNV_HAS_SUPPLEMENTARY) {
194*0e209d39SAndroid Build Coastguard Worker  *         -- stage 1 table for all of Unicode
195*0e209d39SAndroid Build Coastguard Worker  *         uint16_t fromUTable[0x440]; (32-bit-aligned)
196*0e209d39SAndroid Build Coastguard Worker  *     } else {
197*0e209d39SAndroid Build Coastguard Worker  *         -- BMP-only tables have a smaller stage 1 table
198*0e209d39SAndroid Build Coastguard Worker  *         uint16_t fromUTable[0x40]; (32-bit-aligned)
199*0e209d39SAndroid Build Coastguard Worker  *     }
200*0e209d39SAndroid Build Coastguard Worker  *
201*0e209d39SAndroid Build Coastguard Worker  *     -- stage 2 tables
202*0e209d39SAndroid Build Coastguard Worker  *        length determined by top of stage 1 and bottom of stage 3 tables
203*0e209d39SAndroid Build Coastguard Worker  *     if(outputType==MBCS_OUTPUT_1) {
204*0e209d39SAndroid Build Coastguard Worker  *         -- SBCS: pure indexes
205*0e209d39SAndroid Build Coastguard Worker  *         uint16_t stage 2 indexes[?];
206*0e209d39SAndroid Build Coastguard Worker  *     } else {
207*0e209d39SAndroid Build Coastguard Worker  *         -- DBCS, MBCS, EBCDIC_STATEFUL, ...: roundtrip flags and indexes
208*0e209d39SAndroid Build Coastguard Worker  *         uint32_t stage 2 flags and indexes[?];
209*0e209d39SAndroid Build Coastguard Worker  *         if(options&MBCS_OPT_NO_FROM_U) {
210*0e209d39SAndroid Build Coastguard Worker  *             stage 2 really has length fullStage2Length
211*0e209d39SAndroid Build Coastguard Worker  *             and the omitted lower part must be reconstituted from
212*0e209d39SAndroid Build Coastguard Worker  *             the toUnicode data
213*0e209d39SAndroid Build Coastguard Worker  *         }
214*0e209d39SAndroid Build Coastguard Worker  *     }
215*0e209d39SAndroid Build Coastguard Worker  *
216*0e209d39SAndroid Build Coastguard Worker  *     -- stage 3 tables with byte results
217*0e209d39SAndroid Build Coastguard Worker  *     if(outputType==MBCS_OUTPUT_1) {
218*0e209d39SAndroid Build Coastguard Worker  *         -- SBCS: each 16-bit result contains flags and the result byte, see ucnvmbcs.c
219*0e209d39SAndroid Build Coastguard Worker  *         uint16_t fromUBytes[fromUBytesLength/2];
220*0e209d39SAndroid Build Coastguard Worker  *     } else if(!(options&MBCS_OPT_NO_FROM_U)) {
221*0e209d39SAndroid Build Coastguard Worker  *         -- DBCS, MBCS, EBCDIC_STATEFUL, ... 2/3/4 bytes result, see ucnvmbcs.c
222*0e209d39SAndroid Build Coastguard Worker  *         uint8_t fromUBytes[fromUBytesLength]; or
223*0e209d39SAndroid Build Coastguard Worker  *         uint16_t fromUBytes[fromUBytesLength/2]; or
224*0e209d39SAndroid Build Coastguard Worker  *         uint32_t fromUBytes[fromUBytesLength/4];
225*0e209d39SAndroid Build Coastguard Worker  *     } else {
226*0e209d39SAndroid Build Coastguard Worker  *         fromUBytes[] must be reconstituted from the toUnicode data
227*0e209d39SAndroid Build Coastguard Worker  *     }
228*0e209d39SAndroid Build Coastguard Worker  *
229*0e209d39SAndroid Build Coastguard Worker  *     -- optional utf8Friendly mbcsIndex -- _MBCSHeader.version 4.3 (ICU 3.8) and higher
230*0e209d39SAndroid Build Coastguard Worker  *     if(outputType!=MBCS_OUTPUT_1 &&
231*0e209d39SAndroid Build Coastguard Worker  *        _MBCSHeader.version[1]>=3 &&
232*0e209d39SAndroid Build Coastguard Worker  *        (maxFastUChar=_MBCSHeader.version[2])!=0
233*0e209d39SAndroid Build Coastguard Worker  *     ) {
234*0e209d39SAndroid Build Coastguard Worker  *         maxFastUChar=(maxFastUChar<<8)|0xff;
235*0e209d39SAndroid Build Coastguard Worker  *         uint16_t mbcsIndex[(maxFastUChar+1)>>6];
236*0e209d39SAndroid Build Coastguard Worker  *     }
237*0e209d39SAndroid Build Coastguard Worker  * }
238*0e209d39SAndroid Build Coastguard Worker  *
239*0e209d39SAndroid Build Coastguard Worker  * -- extension table, details see ucnv_ext.h
240*0e209d39SAndroid Build Coastguard Worker  * int32_t indexes[>=32]; ...
241*0e209d39SAndroid Build Coastguard Worker  */
242*0e209d39SAndroid Build Coastguard Worker 
243*0e209d39SAndroid Build Coastguard Worker /* MBCS converter data and state -------------------------------------------- */
244*0e209d39SAndroid Build Coastguard Worker 
245*0e209d39SAndroid Build Coastguard Worker enum {
246*0e209d39SAndroid Build Coastguard Worker     MBCS_MAX_STATE_COUNT=128
247*0e209d39SAndroid Build Coastguard Worker };
248*0e209d39SAndroid Build Coastguard Worker 
249*0e209d39SAndroid Build Coastguard Worker /**
250*0e209d39SAndroid Build Coastguard Worker  * MBCS action codes for conversions to Unicode.
251*0e209d39SAndroid Build Coastguard Worker  * These values are in bits 23..20 of the state table entries.
252*0e209d39SAndroid Build Coastguard Worker  */
253*0e209d39SAndroid Build Coastguard Worker enum {
254*0e209d39SAndroid Build Coastguard Worker     MBCS_STATE_VALID_DIRECT_16,
255*0e209d39SAndroid Build Coastguard Worker     MBCS_STATE_VALID_DIRECT_20,
256*0e209d39SAndroid Build Coastguard Worker 
257*0e209d39SAndroid Build Coastguard Worker     MBCS_STATE_FALLBACK_DIRECT_16,
258*0e209d39SAndroid Build Coastguard Worker     MBCS_STATE_FALLBACK_DIRECT_20,
259*0e209d39SAndroid Build Coastguard Worker 
260*0e209d39SAndroid Build Coastguard Worker     MBCS_STATE_VALID_16,
261*0e209d39SAndroid Build Coastguard Worker     MBCS_STATE_VALID_16_PAIR,
262*0e209d39SAndroid Build Coastguard Worker 
263*0e209d39SAndroid Build Coastguard Worker     MBCS_STATE_UNASSIGNED,
264*0e209d39SAndroid Build Coastguard Worker     MBCS_STATE_ILLEGAL,
265*0e209d39SAndroid Build Coastguard Worker 
266*0e209d39SAndroid Build Coastguard Worker     MBCS_STATE_CHANGE_ONLY
267*0e209d39SAndroid Build Coastguard Worker };
268*0e209d39SAndroid Build Coastguard Worker 
269*0e209d39SAndroid Build Coastguard Worker /* Macros for state table entries */
270*0e209d39SAndroid Build Coastguard Worker #define MBCS_ENTRY_TRANSITION(state, offset) (int32_t)(((int32_t)(state)<<24L)|(offset))
271*0e209d39SAndroid Build Coastguard Worker #define MBCS_ENTRY_TRANSITION_SET_OFFSET(entry, offset) (int32_t)(((entry)&0xff000000)|(offset))
272*0e209d39SAndroid Build Coastguard Worker #define MBCS_ENTRY_TRANSITION_ADD_OFFSET(entry, offset) (int32_t)((entry)+(offset))
273*0e209d39SAndroid Build Coastguard Worker 
274*0e209d39SAndroid Build Coastguard Worker #define MBCS_ENTRY_FINAL(state, action, value) (int32_t)(0x80000000|((int32_t)(state)<<24L)|((action)<<20L)|(value))
275*0e209d39SAndroid Build Coastguard Worker #define MBCS_ENTRY_SET_FINAL(entry) (int32_t)((entry)|0x80000000)
276*0e209d39SAndroid Build Coastguard Worker #define MBCS_ENTRY_FINAL_SET_ACTION(entry, action) (int32_t)(((entry)&0xff0fffff)|((int32_t)(action)<<20L))
277*0e209d39SAndroid Build Coastguard Worker #define MBCS_ENTRY_FINAL_SET_VALUE(entry, value) (int32_t)(((entry)&0xfff00000)|(value))
278*0e209d39SAndroid Build Coastguard Worker #define MBCS_ENTRY_FINAL_SET_ACTION_VALUE(entry, action, value) (int32_t)(((entry)&0xff000000)|((int32_t)(action)<<20L)|(value))
279*0e209d39SAndroid Build Coastguard Worker 
280*0e209d39SAndroid Build Coastguard Worker #define MBCS_ENTRY_SET_STATE(entry, state) (int32_t)(((entry)&0x80ffffff)|((int32_t)(state)<<24L))
281*0e209d39SAndroid Build Coastguard Worker 
282*0e209d39SAndroid Build Coastguard Worker #define MBCS_ENTRY_STATE(entry) ((((uint32_t)entry)>>24)&0x7f)
283*0e209d39SAndroid Build Coastguard Worker 
284*0e209d39SAndroid Build Coastguard Worker #define MBCS_ENTRY_IS_TRANSITION(entry) ((entry)>=0)
285*0e209d39SAndroid Build Coastguard Worker #define MBCS_ENTRY_IS_FINAL(entry) ((entry)<0)
286*0e209d39SAndroid Build Coastguard Worker 
287*0e209d39SAndroid Build Coastguard Worker #define MBCS_ENTRY_TRANSITION_STATE(entry) (((uint32_t)entry)>>24)
288*0e209d39SAndroid Build Coastguard Worker #define MBCS_ENTRY_TRANSITION_OFFSET(entry) ((entry)&0xffffff)
289*0e209d39SAndroid Build Coastguard Worker 
290*0e209d39SAndroid Build Coastguard Worker #define MBCS_ENTRY_FINAL_STATE(entry) ((((uint32_t)entry)>>24)&0x7f)
291*0e209d39SAndroid Build Coastguard Worker #define MBCS_ENTRY_FINAL_IS_VALID_DIRECT_16(entry) ((entry)<(int32_t)0x80100000)
292*0e209d39SAndroid Build Coastguard Worker #define MBCS_ENTRY_FINAL_ACTION(entry) ((((uint32_t)entry)>>20)&0xf)
293*0e209d39SAndroid Build Coastguard Worker #define MBCS_ENTRY_FINAL_VALUE(entry) ((entry)&0xfffff)
294*0e209d39SAndroid Build Coastguard Worker #define MBCS_ENTRY_FINAL_VALUE_16(entry) (uint16_t)(entry)
295*0e209d39SAndroid Build Coastguard Worker 
296*0e209d39SAndroid Build Coastguard Worker #define IS_ASCII_ROUNDTRIP(b, asciiRoundtrips) (((asciiRoundtrips) & (1<<((b)>>2)))!=0)
297*0e209d39SAndroid Build Coastguard Worker 
298*0e209d39SAndroid Build Coastguard Worker /* single-byte fromUnicode: get the 16-bit result word */
299*0e209d39SAndroid Build Coastguard Worker #define MBCS_SINGLE_RESULT_FROM_U(table, results, c) (results)[ (table)[ (table)[(c)>>10] +(((c)>>4)&0x3f) ] +((c)&0xf) ]
300*0e209d39SAndroid Build Coastguard Worker 
301*0e209d39SAndroid Build Coastguard Worker /* single-byte fromUnicode using the sbcsIndex */
302*0e209d39SAndroid Build Coastguard Worker #define SBCS_RESULT_FROM_LOW_BMP(table, results, c) (results)[ (table)[(c)>>6] +((c)&0x3f) ]
303*0e209d39SAndroid Build Coastguard Worker 
304*0e209d39SAndroid Build Coastguard Worker /* single-byte fromUTF8 using the sbcsIndex; l and t must be masked externally; can be l=0 and t<=0x7f */
305*0e209d39SAndroid Build Coastguard Worker #define SBCS_RESULT_FROM_UTF8(table, results, l, t) (results)[ (table)[l] +(t) ]
306*0e209d39SAndroid Build Coastguard Worker 
307*0e209d39SAndroid Build Coastguard Worker /* multi-byte fromUnicode: get the 32-bit stage 2 entry */
308*0e209d39SAndroid Build Coastguard Worker #define MBCS_STAGE_2_FROM_U(table, c) ((const uint32_t *)(table))[ (table)[(c)>>10] +(((c)>>4)&0x3f) ]
309*0e209d39SAndroid Build Coastguard Worker #define MBCS_FROM_U_IS_ROUNDTRIP(stage2Entry, c) ( ((stage2Entry) & ((uint32_t)1<< (16+((c)&0xf)) )) !=0)
310*0e209d39SAndroid Build Coastguard Worker 
311*0e209d39SAndroid Build Coastguard Worker #define MBCS_VALUE_2_FROM_STAGE_2(bytes, stage2Entry, c) ((uint16_t *)(bytes))[16*(uint32_t)(uint16_t)(stage2Entry)+((c)&0xf)]
312*0e209d39SAndroid Build Coastguard Worker #define MBCS_VALUE_4_FROM_STAGE_2(bytes, stage2Entry, c) ((uint32_t *)(bytes))[16*(uint32_t)(uint16_t)(stage2Entry)+((c)&0xf)]
313*0e209d39SAndroid Build Coastguard Worker 
314*0e209d39SAndroid Build Coastguard Worker #define MBCS_POINTER_3_FROM_STAGE_2(bytes, stage2Entry, c) ((bytes)+(16*(uint32_t)(uint16_t)(stage2Entry)+((c)&0xf))*3)
315*0e209d39SAndroid Build Coastguard Worker 
316*0e209d39SAndroid Build Coastguard Worker /* double-byte fromUnicode using the mbcsIndex */
317*0e209d39SAndroid Build Coastguard Worker #define DBCS_RESULT_FROM_MOST_BMP(table, results, c) (results)[ (table)[(c)>>6] +((c)&0x3f) ]
318*0e209d39SAndroid Build Coastguard Worker 
319*0e209d39SAndroid Build Coastguard Worker /* double-byte fromUTF8 using the mbcsIndex; l and t1 combined into lt1; lt1 and t2 must be masked externally */
320*0e209d39SAndroid Build Coastguard Worker #define DBCS_RESULT_FROM_UTF8(table, results, lt1, t2) (results)[ (table)[lt1] +(t2) ]
321*0e209d39SAndroid Build Coastguard Worker 
322*0e209d39SAndroid Build Coastguard Worker 
323*0e209d39SAndroid Build Coastguard Worker /**
324*0e209d39SAndroid Build Coastguard Worker  * MBCS output types for conversions from Unicode.
325*0e209d39SAndroid Build Coastguard Worker  * These per-converter types determine the storage method in stage 3 of the lookup table,
326*0e209d39SAndroid Build Coastguard Worker  * mostly how many bytes are stored per entry.
327*0e209d39SAndroid Build Coastguard Worker  */
328*0e209d39SAndroid Build Coastguard Worker enum {
329*0e209d39SAndroid Build Coastguard Worker     MBCS_OUTPUT_1,          /* 0 */
330*0e209d39SAndroid Build Coastguard Worker     MBCS_OUTPUT_2,          /* 1 */
331*0e209d39SAndroid Build Coastguard Worker     MBCS_OUTPUT_3,          /* 2 */
332*0e209d39SAndroid Build Coastguard Worker     MBCS_OUTPUT_4,          /* 3 */
333*0e209d39SAndroid Build Coastguard Worker 
334*0e209d39SAndroid Build Coastguard Worker     MBCS_OUTPUT_3_EUC=8,    /* 8 */
335*0e209d39SAndroid Build Coastguard Worker     MBCS_OUTPUT_4_EUC,      /* 9 */
336*0e209d39SAndroid Build Coastguard Worker 
337*0e209d39SAndroid Build Coastguard Worker     MBCS_OUTPUT_2_SISO=12,  /* c */
338*0e209d39SAndroid Build Coastguard Worker     MBCS_OUTPUT_2_HZ,       /* d */
339*0e209d39SAndroid Build Coastguard Worker 
340*0e209d39SAndroid Build Coastguard Worker     MBCS_OUTPUT_EXT_ONLY,   /* e */
341*0e209d39SAndroid Build Coastguard Worker 
342*0e209d39SAndroid Build Coastguard Worker     MBCS_OUTPUT_COUNT,
343*0e209d39SAndroid Build Coastguard Worker 
344*0e209d39SAndroid Build Coastguard Worker     MBCS_OUTPUT_DBCS_ONLY=0xdb  /* runtime-only type for DBCS-only handling of SISO tables */
345*0e209d39SAndroid Build Coastguard Worker };
346*0e209d39SAndroid Build Coastguard Worker 
347*0e209d39SAndroid Build Coastguard Worker /**
348*0e209d39SAndroid Build Coastguard Worker  * Fallbacks to Unicode are stored outside the normal state table and code point structures
349*0e209d39SAndroid Build Coastguard Worker  * in a vector of items of this type. They are sorted by offset.
350*0e209d39SAndroid Build Coastguard Worker  */
351*0e209d39SAndroid Build Coastguard Worker typedef struct {
352*0e209d39SAndroid Build Coastguard Worker     uint32_t offset;
353*0e209d39SAndroid Build Coastguard Worker     UChar32 codePoint;
354*0e209d39SAndroid Build Coastguard Worker } _MBCSToUFallback;
355*0e209d39SAndroid Build Coastguard Worker 
356*0e209d39SAndroid Build Coastguard Worker /** Constants for fast and UTF-8-friendly conversion. */
357*0e209d39SAndroid Build Coastguard Worker enum {
358*0e209d39SAndroid Build Coastguard Worker     SBCS_FAST_MAX=0x0fff,               /* maximum code point with UTF-8-friendly SBCS runtime code, see makeconv SBCS_UTF8_MAX */
359*0e209d39SAndroid Build Coastguard Worker     SBCS_FAST_LIMIT=SBCS_FAST_MAX+1,    /* =0x1000 */
360*0e209d39SAndroid Build Coastguard Worker     MBCS_FAST_MAX=0xd7ff,               /* maximum code point with UTF-8-friendly MBCS runtime code, see makeconv MBCS_UTF8_MAX */
361*0e209d39SAndroid Build Coastguard Worker     MBCS_FAST_LIMIT=MBCS_FAST_MAX+1     /* =0xd800 */
362*0e209d39SAndroid Build Coastguard Worker };
363*0e209d39SAndroid Build Coastguard Worker 
364*0e209d39SAndroid Build Coastguard Worker /**
365*0e209d39SAndroid Build Coastguard Worker  * This is the MBCS part of the UConverterTable union (a runtime data structure).
366*0e209d39SAndroid Build Coastguard Worker  * It keeps all the per-converter data and points into the loaded mapping tables.
367*0e209d39SAndroid Build Coastguard Worker  *
368*0e209d39SAndroid Build Coastguard Worker  * utf8Friendly data structures added with _MBCSHeader.version 4.3
369*0e209d39SAndroid Build Coastguard Worker  */
370*0e209d39SAndroid Build Coastguard Worker typedef struct UConverterMBCSTable {
371*0e209d39SAndroid Build Coastguard Worker     /* toUnicode */
372*0e209d39SAndroid Build Coastguard Worker     uint8_t countStates, dbcsOnlyState, stateTableOwned;
373*0e209d39SAndroid Build Coastguard Worker     uint32_t countToUFallbacks;
374*0e209d39SAndroid Build Coastguard Worker 
375*0e209d39SAndroid Build Coastguard Worker     const int32_t (*stateTable)/*[countStates]*/[256];
376*0e209d39SAndroid Build Coastguard Worker     int32_t (*swapLFNLStateTable)/*[countStates]*/[256]; /* for swaplfnl */
377*0e209d39SAndroid Build Coastguard Worker     const uint16_t *unicodeCodeUnits/*[countUnicodeResults]*/;
378*0e209d39SAndroid Build Coastguard Worker     const _MBCSToUFallback *toUFallbacks;
379*0e209d39SAndroid Build Coastguard Worker 
380*0e209d39SAndroid Build Coastguard Worker     /* fromUnicode */
381*0e209d39SAndroid Build Coastguard Worker     const uint16_t *fromUnicodeTable;
382*0e209d39SAndroid Build Coastguard Worker     const uint16_t *mbcsIndex;              /* for fast conversion from most of BMP to MBCS (utf8Friendly data) */
383*0e209d39SAndroid Build Coastguard Worker     uint16_t sbcsIndex[SBCS_FAST_LIMIT>>6]; /* for fast conversion from low BMP to SBCS (utf8Friendly data) */
384*0e209d39SAndroid Build Coastguard Worker     const uint8_t *fromUnicodeBytes;
385*0e209d39SAndroid Build Coastguard Worker     uint8_t *swapLFNLFromUnicodeBytes;      /* for swaplfnl */
386*0e209d39SAndroid Build Coastguard Worker     uint32_t fromUBytesLength;
387*0e209d39SAndroid Build Coastguard Worker     uint8_t outputType, unicodeMask;
388*0e209d39SAndroid Build Coastguard Worker     UBool utf8Friendly;                     /* for utf8Friendly data */
389*0e209d39SAndroid Build Coastguard Worker     UChar maxFastUChar;                     /* for utf8Friendly data */
390*0e209d39SAndroid Build Coastguard Worker 
391*0e209d39SAndroid Build Coastguard Worker     /* roundtrips */
392*0e209d39SAndroid Build Coastguard Worker     uint32_t asciiRoundtrips;
393*0e209d39SAndroid Build Coastguard Worker 
394*0e209d39SAndroid Build Coastguard Worker     /* reconstituted data that was omitted from the .cnv file */
395*0e209d39SAndroid Build Coastguard Worker     uint8_t *reconstitutedData;
396*0e209d39SAndroid Build Coastguard Worker 
397*0e209d39SAndroid Build Coastguard Worker     /* converter name for swaplfnl */
398*0e209d39SAndroid Build Coastguard Worker     char *swapLFNLName;
399*0e209d39SAndroid Build Coastguard Worker 
400*0e209d39SAndroid Build Coastguard Worker     /* extension data */
401*0e209d39SAndroid Build Coastguard Worker     struct UConverterSharedData *baseSharedData;
402*0e209d39SAndroid Build Coastguard Worker     const int32_t *extIndexes;
403*0e209d39SAndroid Build Coastguard Worker } UConverterMBCSTable;
404*0e209d39SAndroid Build Coastguard Worker 
405*0e209d39SAndroid Build Coastguard Worker #define UCNV_MBCS_TABLE_INITIALIZER { \
406*0e209d39SAndroid Build Coastguard Worker     /* toUnicode */ \
407*0e209d39SAndroid Build Coastguard Worker     0, 0, 0, \
408*0e209d39SAndroid Build Coastguard Worker     0, \
409*0e209d39SAndroid Build Coastguard Worker      \
410*0e209d39SAndroid Build Coastguard Worker     NULL, \
411*0e209d39SAndroid Build Coastguard Worker     NULL, \
412*0e209d39SAndroid Build Coastguard Worker     NULL, \
413*0e209d39SAndroid Build Coastguard Worker     NULL, \
414*0e209d39SAndroid Build Coastguard Worker      \
415*0e209d39SAndroid Build Coastguard Worker     /* fromUnicode */ \
416*0e209d39SAndroid Build Coastguard Worker     NULL, \
417*0e209d39SAndroid Build Coastguard Worker     NULL, \
418*0e209d39SAndroid Build Coastguard Worker     { 0 }, \
419*0e209d39SAndroid Build Coastguard Worker     NULL, \
420*0e209d39SAndroid Build Coastguard Worker     NULL, \
421*0e209d39SAndroid Build Coastguard Worker     0, \
422*0e209d39SAndroid Build Coastguard Worker     0, 0, \
423*0e209d39SAndroid Build Coastguard Worker     false, \
424*0e209d39SAndroid Build Coastguard Worker     0, \
425*0e209d39SAndroid Build Coastguard Worker      \
426*0e209d39SAndroid Build Coastguard Worker     /* roundtrips */ \
427*0e209d39SAndroid Build Coastguard Worker     0, \
428*0e209d39SAndroid Build Coastguard Worker      \
429*0e209d39SAndroid Build Coastguard Worker     /* reconstituted data that was omitted from the .cnv file */ \
430*0e209d39SAndroid Build Coastguard Worker     NULL, \
431*0e209d39SAndroid Build Coastguard Worker      \
432*0e209d39SAndroid Build Coastguard Worker     /* converter name for swaplfnl */ \
433*0e209d39SAndroid Build Coastguard Worker     NULL, \
434*0e209d39SAndroid Build Coastguard Worker      \
435*0e209d39SAndroid Build Coastguard Worker     /* extension data */ \
436*0e209d39SAndroid Build Coastguard Worker     NULL, \
437*0e209d39SAndroid Build Coastguard Worker     NULL \
438*0e209d39SAndroid Build Coastguard Worker }
439*0e209d39SAndroid Build Coastguard Worker 
440*0e209d39SAndroid Build Coastguard Worker enum {
441*0e209d39SAndroid Build Coastguard Worker     MBCS_OPT_LENGTH_MASK=0x3f,
442*0e209d39SAndroid Build Coastguard Worker     MBCS_OPT_NO_FROM_U=0x40,
443*0e209d39SAndroid Build Coastguard Worker     /*
444*0e209d39SAndroid Build Coastguard Worker      * If any of the following options bits are set,
445*0e209d39SAndroid Build Coastguard Worker      * then the file must be rejected.
446*0e209d39SAndroid Build Coastguard Worker      */
447*0e209d39SAndroid Build Coastguard Worker     MBCS_OPT_INCOMPATIBLE_MASK=0xffc0,
448*0e209d39SAndroid Build Coastguard Worker     /*
449*0e209d39SAndroid Build Coastguard Worker      * Remove bits from this mask as more options are recognized
450*0e209d39SAndroid Build Coastguard Worker      * by all implementations that use this constant.
451*0e209d39SAndroid Build Coastguard Worker      */
452*0e209d39SAndroid Build Coastguard Worker     MBCS_OPT_UNKNOWN_INCOMPATIBLE_MASK=0xff80
453*0e209d39SAndroid Build Coastguard Worker };
454*0e209d39SAndroid Build Coastguard Worker 
455*0e209d39SAndroid Build Coastguard Worker enum {
456*0e209d39SAndroid Build Coastguard Worker     MBCS_HEADER_V4_LENGTH=8,
457*0e209d39SAndroid Build Coastguard Worker     MBCS_HEADER_V5_MIN_LENGTH=9
458*0e209d39SAndroid Build Coastguard Worker };
459*0e209d39SAndroid Build Coastguard Worker 
460*0e209d39SAndroid Build Coastguard Worker /**
461*0e209d39SAndroid Build Coastguard Worker  * MBCS data header. See data format description above.
462*0e209d39SAndroid Build Coastguard Worker  */
463*0e209d39SAndroid Build Coastguard Worker typedef struct {
464*0e209d39SAndroid Build Coastguard Worker     UVersionInfo version;
465*0e209d39SAndroid Build Coastguard Worker     uint32_t countStates,
466*0e209d39SAndroid Build Coastguard Worker              countToUFallbacks,
467*0e209d39SAndroid Build Coastguard Worker              offsetToUCodeUnits,
468*0e209d39SAndroid Build Coastguard Worker              offsetFromUTable,
469*0e209d39SAndroid Build Coastguard Worker              offsetFromUBytes,
470*0e209d39SAndroid Build Coastguard Worker              flags,
471*0e209d39SAndroid Build Coastguard Worker              fromUBytesLength;
472*0e209d39SAndroid Build Coastguard Worker 
473*0e209d39SAndroid Build Coastguard Worker     /* new and required in version 5 */
474*0e209d39SAndroid Build Coastguard Worker     uint32_t options;
475*0e209d39SAndroid Build Coastguard Worker 
476*0e209d39SAndroid Build Coastguard Worker     /* new and optional in version 5; used if options&MBCS_OPT_NO_FROM_U */
477*0e209d39SAndroid Build Coastguard Worker     uint32_t fullStage2Length;  /* number of 32-bit units */
478*0e209d39SAndroid Build Coastguard Worker } _MBCSHeader;
479*0e209d39SAndroid Build Coastguard Worker 
480*0e209d39SAndroid Build Coastguard Worker #define UCNV_MBCS_HEADER_INITIALIZER { { 0 },  0, 0, 0, 0, 0, 0, 0,  0,  0 }
481*0e209d39SAndroid Build Coastguard Worker 
482*0e209d39SAndroid Build Coastguard Worker /*
483*0e209d39SAndroid Build Coastguard Worker  * This is a simple version of _MBCSGetNextUChar() that is used
484*0e209d39SAndroid Build Coastguard Worker  * by other converter implementations.
485*0e209d39SAndroid Build Coastguard Worker  * It only returns an "assigned" result if it consumes the entire input.
486*0e209d39SAndroid Build Coastguard Worker  * It does not use state from the converter, nor error codes.
487*0e209d39SAndroid Build Coastguard Worker  * It does not handle the EBCDIC swaplfnl option (set in UConverter).
488*0e209d39SAndroid Build Coastguard Worker  * It handles conversion extensions but not GB 18030.
489*0e209d39SAndroid Build Coastguard Worker  *
490*0e209d39SAndroid Build Coastguard Worker  * Return value:
491*0e209d39SAndroid Build Coastguard Worker  * U+fffe   unassigned
492*0e209d39SAndroid Build Coastguard Worker  * U+ffff   illegal
493*0e209d39SAndroid Build Coastguard Worker  * otherwise the Unicode code point
494*0e209d39SAndroid Build Coastguard Worker  */
495*0e209d39SAndroid Build Coastguard Worker U_CFUNC UChar32
496*0e209d39SAndroid Build Coastguard Worker ucnv_MBCSSimpleGetNextUChar(UConverterSharedData *sharedData,
497*0e209d39SAndroid Build Coastguard Worker                         const char *source, int32_t length,
498*0e209d39SAndroid Build Coastguard Worker                         UBool useFallback);
499*0e209d39SAndroid Build Coastguard Worker 
500*0e209d39SAndroid Build Coastguard Worker /**
501*0e209d39SAndroid Build Coastguard Worker  * This version of _MBCSSimpleGetNextUChar() is optimized for single-byte, single-state codepages.
502*0e209d39SAndroid Build Coastguard Worker  * It does not handle the EBCDIC swaplfnl option (set in UConverter).
503*0e209d39SAndroid Build Coastguard Worker  * It does not handle conversion extensions (_extToU()).
504*0e209d39SAndroid Build Coastguard Worker  */
505*0e209d39SAndroid Build Coastguard Worker U_CFUNC UChar32
506*0e209d39SAndroid Build Coastguard Worker ucnv_MBCSSingleSimpleGetNextUChar(UConverterSharedData *sharedData,
507*0e209d39SAndroid Build Coastguard Worker                               uint8_t b, UBool useFallback);
508*0e209d39SAndroid Build Coastguard Worker 
509*0e209d39SAndroid Build Coastguard Worker /**
510*0e209d39SAndroid Build Coastguard Worker  * This macro version of _MBCSSingleSimpleGetNextUChar() gets a code point from a byte.
511*0e209d39SAndroid Build Coastguard Worker  * It works for single-byte, single-state codepages that only map
512*0e209d39SAndroid Build Coastguard Worker  * to and from BMP code points, and it always
513*0e209d39SAndroid Build Coastguard Worker  * returns fallback values.
514*0e209d39SAndroid Build Coastguard Worker  */
515*0e209d39SAndroid Build Coastguard Worker #define _MBCS_SINGLE_SIMPLE_GET_NEXT_BMP(sharedData, b) \
516*0e209d39SAndroid Build Coastguard Worker     (UChar)MBCS_ENTRY_FINAL_VALUE_16((sharedData)->mbcs.stateTable[0][(uint8_t)(b)])
517*0e209d39SAndroid Build Coastguard Worker 
518*0e209d39SAndroid Build Coastguard Worker /**
519*0e209d39SAndroid Build Coastguard Worker  * This is an internal function that allows other converter implementations
520*0e209d39SAndroid Build Coastguard Worker  * to check whether a byte is a lead byte.
521*0e209d39SAndroid Build Coastguard Worker  */
522*0e209d39SAndroid Build Coastguard Worker U_CFUNC UBool
523*0e209d39SAndroid Build Coastguard Worker ucnv_MBCSIsLeadByte(UConverterSharedData *sharedData, char byte);
524*0e209d39SAndroid Build Coastguard Worker 
525*0e209d39SAndroid Build Coastguard Worker /** This is a macro version of _MBCSIsLeadByte(). */
526*0e209d39SAndroid Build Coastguard Worker #define _MBCS_IS_LEAD_BYTE(sharedData, byte) \
527*0e209d39SAndroid Build Coastguard Worker     (UBool)MBCS_ENTRY_IS_TRANSITION((sharedData)->mbcs.stateTable[0][(uint8_t)(byte)])
528*0e209d39SAndroid Build Coastguard Worker 
529*0e209d39SAndroid Build Coastguard Worker /*
530*0e209d39SAndroid Build Coastguard Worker  * This is another simple conversion function for internal use by other
531*0e209d39SAndroid Build Coastguard Worker  * conversion implementations.
532*0e209d39SAndroid Build Coastguard Worker  * It does not use the converter state nor call callbacks.
533*0e209d39SAndroid Build Coastguard Worker  * It does not handle the EBCDIC swaplfnl option (set in UConverter).
534*0e209d39SAndroid Build Coastguard Worker  * It handles conversion extensions but not GB 18030.
535*0e209d39SAndroid Build Coastguard Worker  *
536*0e209d39SAndroid Build Coastguard Worker  * It converts one single Unicode code point into codepage bytes, encoded
537*0e209d39SAndroid Build Coastguard Worker  * as one 32-bit value. The function returns the number of bytes in *pValue:
538*0e209d39SAndroid Build Coastguard Worker  * 1..4 the number of bytes in *pValue
539*0e209d39SAndroid Build Coastguard Worker  * 0    unassigned (*pValue undefined)
540*0e209d39SAndroid Build Coastguard Worker  * -1   illegal (currently not used, *pValue undefined)
541*0e209d39SAndroid Build Coastguard Worker  *
542*0e209d39SAndroid Build Coastguard Worker  * *pValue will contain the resulting bytes with the last byte in bits 7..0,
543*0e209d39SAndroid Build Coastguard Worker  * the second to last byte in bits 15..8, etc.
544*0e209d39SAndroid Build Coastguard Worker  * Currently, the function assumes but does not check that 0<=c<=0x10ffff.
545*0e209d39SAndroid Build Coastguard Worker  */
546*0e209d39SAndroid Build Coastguard Worker U_CFUNC int32_t
547*0e209d39SAndroid Build Coastguard Worker ucnv_MBCSFromUChar32(UConverterSharedData *sharedData,
548*0e209d39SAndroid Build Coastguard Worker                  UChar32 c, uint32_t *pValue,
549*0e209d39SAndroid Build Coastguard Worker                  UBool useFallback);
550*0e209d39SAndroid Build Coastguard Worker 
551*0e209d39SAndroid Build Coastguard Worker /**
552*0e209d39SAndroid Build Coastguard Worker  * This version of _MBCSFromUChar32() is optimized for single-byte codepages.
553*0e209d39SAndroid Build Coastguard Worker  * It does not handle the EBCDIC swaplfnl option (set in UConverter).
554*0e209d39SAndroid Build Coastguard Worker  *
555*0e209d39SAndroid Build Coastguard Worker  * It returns the codepage byte for the code point, or -1 if it is unassigned.
556*0e209d39SAndroid Build Coastguard Worker  */
557*0e209d39SAndroid Build Coastguard Worker U_CFUNC int32_t
558*0e209d39SAndroid Build Coastguard Worker ucnv_MBCSSingleFromUChar32(UConverterSharedData *sharedData,
559*0e209d39SAndroid Build Coastguard Worker                        UChar32 c,
560*0e209d39SAndroid Build Coastguard Worker                        UBool useFallback);
561*0e209d39SAndroid Build Coastguard Worker 
562*0e209d39SAndroid Build Coastguard Worker /**
563*0e209d39SAndroid Build Coastguard Worker  * SBCS, DBCS, and EBCDIC_STATEFUL are replaced by MBCS, but
564*0e209d39SAndroid Build Coastguard Worker  * we cheat a little about the type, returning the old types if appropriate.
565*0e209d39SAndroid Build Coastguard Worker  */
566*0e209d39SAndroid Build Coastguard Worker U_CFUNC UConverterType
567*0e209d39SAndroid Build Coastguard Worker ucnv_MBCSGetType(const UConverter* converter);
568*0e209d39SAndroid Build Coastguard Worker 
569*0e209d39SAndroid Build Coastguard Worker U_CFUNC void
570*0e209d39SAndroid Build Coastguard Worker ucnv_MBCSFromUnicodeWithOffsets(UConverterFromUnicodeArgs *pArgs,
571*0e209d39SAndroid Build Coastguard Worker                             UErrorCode *pErrorCode);
572*0e209d39SAndroid Build Coastguard Worker U_CFUNC void
573*0e209d39SAndroid Build Coastguard Worker ucnv_MBCSToUnicodeWithOffsets(UConverterToUnicodeArgs *pArgs,
574*0e209d39SAndroid Build Coastguard Worker                           UErrorCode *pErrorCode);
575*0e209d39SAndroid Build Coastguard Worker 
576*0e209d39SAndroid Build Coastguard Worker /*
577*0e209d39SAndroid Build Coastguard Worker  * Internal function returning a UnicodeSet for toUnicode() conversion.
578*0e209d39SAndroid Build Coastguard Worker  * Currently only used for ISO-2022-CN, and only handles roundtrip mappings.
579*0e209d39SAndroid Build Coastguard Worker  * In the future, if we add support for fallback sets, this function
580*0e209d39SAndroid Build Coastguard Worker  * needs to be updated.
581*0e209d39SAndroid Build Coastguard Worker  * Handles extensions.
582*0e209d39SAndroid Build Coastguard Worker  * Does not empty the set first.
583*0e209d39SAndroid Build Coastguard Worker  */
584*0e209d39SAndroid Build Coastguard Worker U_CFUNC void
585*0e209d39SAndroid Build Coastguard Worker ucnv_MBCSGetUnicodeSetForUnicode(const UConverterSharedData *sharedData,
586*0e209d39SAndroid Build Coastguard Worker                                  const USetAdder *sa,
587*0e209d39SAndroid Build Coastguard Worker                                  UConverterUnicodeSet which,
588*0e209d39SAndroid Build Coastguard Worker                                  UErrorCode *pErrorCode);
589*0e209d39SAndroid Build Coastguard Worker 
590*0e209d39SAndroid Build Coastguard Worker /*
591*0e209d39SAndroid Build Coastguard Worker  * Same as ucnv_MBCSGetUnicodeSetForUnicode() but
592*0e209d39SAndroid Build Coastguard Worker  * the set can be filtered by encoding scheme.
593*0e209d39SAndroid Build Coastguard Worker  * Used by stateful converters which share regular conversion tables
594*0e209d39SAndroid Build Coastguard Worker  * but only use a subset of their mappings.
595*0e209d39SAndroid Build Coastguard Worker  */
596*0e209d39SAndroid Build Coastguard Worker U_CFUNC void
597*0e209d39SAndroid Build Coastguard Worker ucnv_MBCSGetFilteredUnicodeSetForUnicode(const UConverterSharedData *sharedData,
598*0e209d39SAndroid Build Coastguard Worker                                          const USetAdder *sa,
599*0e209d39SAndroid Build Coastguard Worker                                          UConverterUnicodeSet which,
600*0e209d39SAndroid Build Coastguard Worker                                          UConverterSetFilter filter,
601*0e209d39SAndroid Build Coastguard Worker                                          UErrorCode *pErrorCode);
602*0e209d39SAndroid Build Coastguard Worker 
603*0e209d39SAndroid Build Coastguard Worker #endif
604*0e209d39SAndroid Build Coastguard Worker 
605*0e209d39SAndroid Build Coastguard Worker #endif
606