summaryrefslogtreecommitdiff
path: root/sal/textenc/tenchelp.h
blob: 2a5c2c85a23ec16560d0306dad52a805d52e8497 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
/*************************************************************************
 *
 *  $RCSfile: tenchelp.h,v $
 *
 *  $Revision: 1.4 $
 *
 *  last change: $Author: th $ $Date: 2001-05-18 13:53:18 $
 *
 *  The Contents of this file are made available subject to the terms of
 *  either of the following licenses
 *
 *         - GNU Lesser General Public License Version 2.1
 *         - Sun Industry Standards Source License Version 1.1
 *
 *  Sun Microsystems Inc., October, 2000
 *
 *  GNU Lesser General Public License Version 2.1
 *  =============================================
 *  Copyright 2000 by Sun Microsystems, Inc.
 *  901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License version 2.1, as published by the Free Software Foundation.
 *
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *  MA  02111-1307  USA
 *
 *
 *  Sun Industry Standards Source License Version 1.1
 *  =================================================
 *  The contents of this file are subject to the Sun Industry Standards
 *  Source License Version 1.1 (the "License"); You may not use this file
 *  except in compliance with the License. You may obtain a copy of the
 *  License at http://www.openoffice.org/license.html.
 *
 *  Software provided under this License is provided on an "AS IS" basis,
 *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
 *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
 *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
 *  See the License for the specific provisions governing your rights and
 *  obligations concerning the Software.
 *
 *  The Initial Developer of the Original Code is: Sun Microsystems, Inc.
 *
 *  Copyright: 2000 by Sun Microsystems, Inc.
 *
 *  All Rights Reserved.
 *
 *  Contributor(s): _______________________________________
 *
 *
 ************************************************************************/

#ifndef _RTL_TENCHELP_H
#define _RTL_TENCHELP_H

#ifndef _RTL_TEXTENC_H
#include <rtl/textenc.h>
#endif
#ifndef _RTL_TENCINFO_H
#include <rtl/tencinfo.h>
#endif

/* ----------- */
/* - Scripts - */
/* ----------- */

typedef sal_uInt16 rtl_Script;
#define SCRIPT_DONTKNOW             ((rtl_Script)0)
#define SCRIPT_UNICODE              ((rtl_Script)1)
#define SCRIPT_SYMBOL               ((rtl_Script)2)
#define SCRIPT_LATIN                ((rtl_Script)3)
#define SCRIPT_EASTEUROPE           ((rtl_Script)4)
#define SCRIPT_CYRILLIC             ((rtl_Script)5)
#define SCRIPT_BALTIC               ((rtl_Script)6)
#define SCRIPT_TURKISH              ((rtl_Script)7)
#define SCRIPT_GREEK                ((rtl_Script)8)
#define SCRIPT_JAPANESE             ((rtl_Script)9)
#define SCRIPT_CHINESE_SIMPLIFIED   ((rtl_Script)10)
#define SCRIPT_CHINESE_TRADITIONAL  ((rtl_Script)11)
#define SCRIPT_KOREAN               ((rtl_Script)12)
#define SCRIPT_ARABIC               ((rtl_Script)13)
#define SCRIPT_HEBREW               ((rtl_Script)14)
#define SCRIPT_ARMENIAN             ((rtl_Script)15)
#define SCRIPT_DEVANAGARI           ((rtl_Script)16)
#define SCRIPT_BENGALI              ((rtl_Script)17)
#define SCRIPT_GURMUKHI             ((rtl_Script)18)
#define SCRIPT_GUJARATI             ((rtl_Script)19)
#define SCRIPT_ORIYA                ((rtl_Script)20)
#define SCRIPT_TAMIL                ((rtl_Script)21)
#define SCRIPT_TELUGU               ((rtl_Script)22)
#define SCRIPT_KANNADA              ((rtl_Script)23)
#define SCRIPT_MALAYALAM            ((rtl_Script)24)
#define SCRIPT_THAI                 ((rtl_Script)25)
#define SCRIPT_VIETNAMESE           ((rtl_Script)26)
#define SCRIPT_LAO                  ((rtl_Script)27)
#define SCRIPT_GEORGIEN             ((rtl_Script)28)

/* -------- */
/* - Help - */
/* -------- */

#ifndef NULL
#define NULL    ((void*)0)
#endif

#define RTL_UNICODE_START_HIGH_SURROGATES                   0xD800
#define RTL_UNICODE_END_HIGH_SURROGATES                     0xDBFF
#define RTL_UNICODE_START_LOW_SURROGATES                    0xDC00
#define RTL_UNICODE_END_LOW_SURROGATES                      0xDFFF

#define RTL_UNICODE_SURROGATES_HALFMASK                     0x03FFUL
#define RTL_UNICODE_SURROGATES_HALFBASE                     0x0010000UL
#define RTL_UNICODE_SURROGATES_HALFSHIFT                    10

#define RTL_UNICODE_CHAR_DEFAULT                            0xFFFD

#define RTL_TEXTCVT_BYTE_PRIVATE_START                      0xF100
#define RTL_TEXTCVT_BYTE_PRIVATE_END                        0xF1FF

/* ----------------- */
/* - TextConverter - */
/* ----------------- */

typedef struct _ImplTextConverterData
{
    const void*                     mpConvertTables;
    sal_Char*                       mpTextDefChar;
    sal_Unicode                     mcUnicodeDefChar;
} ImplTextConverterData;

typedef sal_Size (*ImplConvertToUnicodeProc)( const ImplTextConverterData* pData,
                                              void* pContext,
                                              const sal_Char* pSrcBuf, sal_Size nSrcBytes,
                                              sal_Unicode* pDestBuf, sal_Size nDestChars,
                                              sal_uInt32 nFlags, sal_uInt32* pInfo,
                                              sal_Size* pSrcCvtBytes );
typedef sal_Size (*ImplConvertToTextProc)( const ImplTextConverterData* pData,
                                           void* pContext,
                                           const sal_Unicode* pSrcBuf, sal_Size nSrcChars,
                                           sal_Char* pDestBuf, sal_Size nDestBytes,
                                           sal_uInt32 nFlags, sal_uInt32* pInfo,
                                           sal_Size* pSrcCvtChars );
typedef void* (*ImplCreateTextContextProc)( void );
typedef void  (*ImplDestroyTextContextProc)( void* pContext );
typedef void  (*ImplResetTextContextProc)( void* pContext );
typedef void* (*ImplCreateUnicodeContextProc)( void );
typedef void  (*ImplDestroyUnicodeContextProc)( void* pContext );
typedef void  (*ImplResetUnicodeContextProc)( void* pContext );

typedef struct _ImplTextConverter
{
    const ImplTextConverterData*    mpConvertData;
    ImplConvertToUnicodeProc        mpConvertTextToUnicodeProc;
    ImplConvertToTextProc           mpConvertUnicodeToTextProc;
    ImplCreateTextContextProc       mpCreateTextToUnicodeContext;
    ImplDestroyTextContextProc      mpDestroyTextToUnicodeContext;
    ImplResetTextContextProc        mpResetTextToUnicodeContext;
    ImplCreateUnicodeContextProc    mpCreateUnicodeToTextContext;
    ImplDestroyUnicodeContextProc   mpDestroyUnicodeToTextContext;
    ImplResetUnicodeContextProc     mpResetUnicodeToTextContext;
} ImplTextConverter;

#define RTL_TEXTTOUNICODECONTEXT_NOTUSED    ((rtl_TextToUnicodeContext)1)
#define RTL_UNICODETOTEXTCONTEXT_NOTUSED    ((rtl_UnicodeToTextContext)1)

/* ---------------------------- */
/* - TextEncoding - InfoFlags - */
/* ---------------------------- */

#define RTL_TEXTENCODING_INFO_WIN       ((sal_uInt32)0x0100)
#define RTL_TEXTENCODING_INFO_DOS_OS2   ((sal_uInt32)0x0200)
#define RTL_TEXTENCODING_INFO_MAC       ((sal_uInt32)0x0400)

/* ----------------------------- */
/* - TextEncoding - Structures - */
/* ----------------------------- */

typedef struct _ImplTextEncodingData
{
    const ImplTextConverter*        mpConverter;
    rtl_TextEncoding                meTextEncoding;
    sal_uInt8                       mnMinCharSize;
    sal_uInt8                       mnMaxCharSize;
    sal_uInt8                       mnAveCharSize;
    sal_uInt8                       mnBestWindowsCharset;
    sal_uInt32                      mnBestPCCodePage;
    sal_uInt32                      mnBestMacTextEncoding;
    const sal_Char*                 mpBestUnixCharset;
    const sal_Char*                 mpBestMimeCharset;
    sal_uInt32                      mnInfoFlags;
    rtl_Script                      mnScript;
} ImplTextEncodingData;


/* ----------------------------------- */
/* - TextConverter - Byte-Structures - */
/* ----------------------------------- */

typedef struct _ImplUniCharTabData
{
    sal_uInt16                      mnUniChar;
    sal_uChar                       mnChar;
} ImplUniCharTabData;

typedef struct _ImplByteConvertData
{
    const sal_uInt16*               mpToUniTab1;
    const sal_uInt16*               mpToUniTab2;
    sal_uChar                       mnToUniStart1;
    sal_uChar                       mnToUniEnd1;
    sal_uChar                       mnToUniStart2;
    sal_uChar                       mnToUniEnd2;
    const sal_uChar*                mpToCharTab1;
    const sal_uChar*                mpToCharTab2;
    const ImplUniCharTabData*       mpToCharExTab;
    sal_uInt16                      mnToCharStart1;
    sal_uInt16                      mnToCharEnd1;
    sal_uInt16                      mnToCharStart2;
    sal_uInt16                      mnToCharEnd2;
    sal_uInt16                      mnToCharExCount;
} ImplByteConvertData;

/* ----------------------------------- */
/* - TextConverter - DBCS-Structures - */
/* ----------------------------------- */

typedef struct _ImplDBCSEUDCData
{
    sal_uChar                       mnLeadStart;
    sal_uChar                       mnLeadEnd;
    sal_uChar                       mnTrail1Start;
    sal_uChar                       mnTrail1End;
    sal_uChar                       mnTrail2Start;
    sal_uChar                       mnTrail2End;
    sal_uChar                       mnTrail3Start;
    sal_uChar                       mnTrail3End;
    sal_uChar                       mnTrailCount;
    sal_uInt16                      mnTrailRangeCount;
    sal_uInt16                      mnUniStart;
    sal_uInt16                      mnUniEnd;
} ImplDBCSEUDCData;

typedef struct _ImplDBCSToUniLeadTab
{
    sal_uInt16                      mnUniChar;
    sal_uInt8                       mnTrailStart;
    sal_uInt8                       mnTrailEnd;
    const sal_uInt16*               mpToUniTrailTab;
} ImplDBCSToUniLeadTab;

typedef struct _ImplUniToDBCSHighTab
{
    sal_uInt8                       mnLowStart;
    sal_uInt8                       mnLowEnd;
    const sal_uInt16*               mpToUniTrailTab;
} ImplUniToDBCSHighTab;

typedef struct _ImplDBCSConvertData
{
    const ImplDBCSToUniLeadTab*     mpToUniLeadTab;
    const ImplUniToDBCSHighTab*     mpToDBCSHighTab;
    sal_uChar                       mnTrailStart;
    sal_uChar                       mnTrailEnd;
    const ImplDBCSEUDCData*         mpEUDCTab;
    sal_uInt16                      mnEUDCCount;
} ImplDBCSConvertData;

/* ---------------------------------- */
/* - TextConverter - EUC-Structures - */
/* ---------------------------------- */

typedef struct _ImplEUCJPConvertData
{
    const ImplDBCSToUniLeadTab*     mpJIS0208ToUniLeadTab;
    const ImplDBCSToUniLeadTab*     mpJIS0212ToUniLeadTab;
    const ImplUniToDBCSHighTab*     mpUniToJIS0208HighTab;
    const ImplUniToDBCSHighTab*     mpUniToJIS0212HighTab;
} ImplEUCJPConvertData;

/* -------------------------------------- */
/* - TextConverter - ISO2022-Structures - */
/* -------------------------------------- */

/* ---------------------------- */
/* - TextEncoding - Functions - */
/* ---------------------------- */

const ImplTextEncodingData* Impl_getTextEncodingData( rtl_TextEncoding eTextEncoding );

/* --------------------------------- */
/* - TextConverter - HelpFunctions - */
/* --------------------------------- */

sal_Unicode ImplGetUndefinedUnicodeChar( sal_uChar c, sal_uInt32 nFlags, const ImplTextConverterData* pData );
sal_Size ImplGetUndefinedAsciiMultiByte( sal_uInt32 nFlags, const ImplTextConverterData* pData, sal_Char* pBuf, sal_Size nMaxLen );
sal_Size ImplGetInvalidAsciiMultiByte( sal_uInt32 nFlags, const ImplTextConverterData* pData, sal_Char* pBuf, sal_Size nMaxLen );

#define IMPL_TEXTCVT_BREAK          1
#define IMPL_TEXTCVT_CONTINUE       2
int ImplHandleUndefinedUnicodeToTextChar( const ImplTextConverterData* pData,
                                          const sal_Unicode** ppSrcBuf, const sal_Unicode* pEndSrcBuf,
                                          sal_Char** ppDestBuf, const sal_Char* pEndDestBuf,
                                          sal_uInt32 nFlags, sal_uInt32* pInfo );

int ImplIsUnicodeIgnoreChar( sal_Unicode c, sal_uInt32 nFlags );

/* ----------------------------- */
/* - TextConverter - Functions - */
/* ----------------------------- */

sal_Size ImplSymbolToUnicode( const ImplTextConverterData* pData, void* pContext,
                              const sal_Char* pSrcBuf, sal_Size nSrcBytes,
                              sal_Unicode* pDestBuf, sal_Size nDestChars,
                              sal_uInt32 nFlags, sal_uInt32* pInfo, sal_Size* pSrcCvtBytes );
sal_Size ImplUnicodeToSymbol( const ImplTextConverterData* pData, void* pContext,
                              const sal_Unicode* pSrcBuf, sal_Size nSrcChars,
                              sal_Char* pDestBuf, sal_Size nDestBytes,
                              sal_uInt32 nFlags, sal_uInt32* pInfo, sal_Size* pSrcCvtChars );
sal_Size ImplCharToUnicode( const ImplTextConverterData* pData, void* pContext,
                            const sal_Char* pSrcBuf, sal_Size nSrcBytes,
                            sal_Unicode* pDestBuf, sal_Size nDestChars,
                            sal_uInt32 nFlags, sal_uInt32* pInfo, sal_Size* pSrcCvtBytes );
sal_Size ImplUnicodeToChar( const ImplTextConverterData* pData, void* pContext,
                            const sal_Unicode* pSrcBuf, sal_Size nSrcChars,
                            sal_Char* pDestBuf, sal_Size nDestBytes,
                            sal_uInt32 nFlags, sal_uInt32* pInfo, sal_Size* pSrcCvtChars );
sal_Size ImplDBCSToUnicode( const ImplTextConverterData* pData, void* pContext,
                            const sal_Char* pSrcBuf, sal_Size nSrcBytes,
                            sal_Unicode* pDestBuf, sal_Size nDestChars,
                            sal_uInt32 nFlags, sal_uInt32* pInfo,
                            sal_Size* pSrcCvtBytes );
sal_Size ImplUnicodeToDBCS( const ImplTextConverterData* pData, void* pContext,
                            const sal_Unicode* pSrcBuf, sal_Size nSrcChars,
                            sal_Char* pDestBuf, sal_Size nDestBytes,
                            sal_uInt32 nFlags, sal_uInt32* pInfo,
                            sal_Size* pSrcCvtChars );
sal_Size ImplEUCJPToUnicode( const ImplTextConverterData* pData,
                             void* pContext,
                             const sal_Char* pSrcBuf, sal_Size nSrcBytes,
                             sal_Unicode* pDestBuf, sal_Size nDestChars,
                             sal_uInt32 nFlags, sal_uInt32* pInfo,
                             sal_Size* pSrcCvtBytes );
sal_Size ImplUnicodeToEUCJP( const ImplTextConverterData* pData,
                             void* pContext,
                             const sal_Unicode* pSrcBuf, sal_Size nSrcChars,
                             sal_Char* pDestBuf, sal_Size nDestBytes,
                             sal_uInt32 nFlags, sal_uInt32* pInfo,
                             sal_Size* pSrcCvtChars );
void* ImplUTF7CreateUTF7TextToUnicodeContext( void );
void ImplUTF7DestroyTextToUnicodeContext( void* pContext );
void ImplUTF7ResetTextToUnicodeContext( void* pContext );
sal_Size ImplUTF7ToUnicode( const ImplTextConverterData* pData, void* pContext,
                            const sal_Char* pSrcBuf, sal_Size nSrcBytes,
                            sal_Unicode* pDestBuf, sal_Size nDestChars,
                            sal_uInt32 nFlags, sal_uInt32* pInfo,
                            sal_Size* pSrcCvtBytes );
void* ImplUTF7CreateUnicodeToTextContext( void );
void ImplUTF7DestroyUnicodeToTextContext( void* pContext );
void ImplUTF7ResetUnicodeToTextContext( void* pContext );
sal_Size ImplUnicodeToUTF7( const ImplTextConverterData* pData, void* pContext,
                            const sal_Unicode* pSrcBuf, sal_Size nSrcChars,
                            sal_Char* pDestBuf, sal_Size nDestBytes,
                            sal_uInt32 nFlags, sal_uInt32* pInfo,
                            sal_Size* pSrcCvtChars );
sal_Size ImplUTF8ToUnicode( const ImplTextConverterData* pData, void* pContext,
                            const sal_Char* pSrcBuf, sal_Size nSrcBytes,
                            sal_Unicode* pDestBuf, sal_Size nDestChars,
                            sal_uInt32 nFlags, sal_uInt32* pInfo,
                            sal_Size* pSrcCvtBytes );
sal_Size ImplUnicodeToUTF8( const ImplTextConverterData* pData, void* pContext,
                            const sal_Unicode* pSrcBuf, sal_Size nSrcChars,
                            sal_Char* pDestBuf, sal_Size nDestBytes,
                            sal_uInt32 nFlags, sal_uInt32* pInfo,
                            sal_Size* pSrcCvtChars );

/* ------------------------------------ */
/* - TextConverter - ReplaceFunctions - */
/* ------------------------------------ */

#define IMPL_MAX_REPLACECHAR            5
sal_uInt16 ImplGetReplaceChar( sal_Unicode c );
const sal_uInt16* ImplGetReplaceString( sal_Unicode c );

#endif /* _RTL_CCVTHELP_HXX */