1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2 /*
3  * This file is part of the LibreOffice project.
4  *
5  * This Source Code Form is subject to the terms of the Mozilla Public
6  * License, v. 2.0. If a copy of the MPL was not distributed with this
7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8  *
9  * This file incorporates work covered by the following license notice:
10  *
11  *   Licensed to the Apache Software Foundation (ASF) under one or more
12  *   contributor license agreements. See the NOTICE file distributed
13  *   with this work for additional information regarding copyright
14  *   ownership. The ASF licenses this file to you under the Apache
15  *   License, Version 2.0 (the "License"); you may not use this file
16  *   except in compliance with the License. You may obtain a copy of
17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
18  */
19 
20 /*
21  * This file is part of LibreOffice published API.
22  */
23 
24 #ifndef INCLUDED_RTL_TEXTENC_H
25 #define INCLUDED_RTL_TEXTENC_H
26 
27 #include "sal/types.h"
28 
29 /** The various supported text encodings.
30 
31     Possible values include a wide range of single- and multi-byte encodings
32     (ranging from RTL_TEXTENCODING_MS_1252 to RTL_TEXTENCODING_GB_18030),
33     the ISO 10646 (Unicode) specific encodings RTL_TEXTENCODING_UCS4 and
34     RTL_TEXTENCODING_UCS2 (aka RTL_TEXTENCODING_UNICODE), and
35     RTL_TEXTENCODING_DONTKNOW to indicate an unknown or missing encoding.
36  */
37 typedef sal_uInt16 rtl_TextEncoding;
38 
39 #define RTL_TEXTENC_CAST( val ) ((rtl_TextEncoding) val)
40 
41 #define RTL_TEXTENCODING_DONTKNOW               (RTL_TEXTENC_CAST( 0 ))
42 #define RTL_TEXTENCODING_MS_1252                (RTL_TEXTENC_CAST( 1 ))
43 #define RTL_TEXTENCODING_APPLE_ROMAN            (RTL_TEXTENC_CAST( 2 ))
44 #define RTL_TEXTENCODING_IBM_437                (RTL_TEXTENC_CAST( 3 ))
45 #define RTL_TEXTENCODING_IBM_850                (RTL_TEXTENC_CAST( 4 ))
46 #define RTL_TEXTENCODING_IBM_860                (RTL_TEXTENC_CAST( 5 ))
47 #define RTL_TEXTENCODING_IBM_861                (RTL_TEXTENC_CAST( 6 ))
48 #define RTL_TEXTENCODING_IBM_863                (RTL_TEXTENC_CAST( 7 ))
49 #define RTL_TEXTENCODING_IBM_865                (RTL_TEXTENC_CAST( 8 ))
50 /* Reserved: RTL_TEXTENCODING_SYSTEM            (RTL_TEXTENC_CAST( 9 )) */
51 #define RTL_TEXTENCODING_SYMBOL                 (RTL_TEXTENC_CAST( 10 ))
52 #define RTL_TEXTENCODING_ASCII_US               (RTL_TEXTENC_CAST( 11 ))
53 #define RTL_TEXTENCODING_ISO_8859_1             (RTL_TEXTENC_CAST( 12 ))
54 #define RTL_TEXTENCODING_ISO_8859_2             (RTL_TEXTENC_CAST( 13 ))
55 #define RTL_TEXTENCODING_ISO_8859_3             (RTL_TEXTENC_CAST( 14 ))
56 #define RTL_TEXTENCODING_ISO_8859_4             (RTL_TEXTENC_CAST( 15 ))
57 #define RTL_TEXTENCODING_ISO_8859_5             (RTL_TEXTENC_CAST( 16 ))
58 #define RTL_TEXTENCODING_ISO_8859_6             (RTL_TEXTENC_CAST( 17 ))
59 #define RTL_TEXTENCODING_ISO_8859_7             (RTL_TEXTENC_CAST( 18 ))
60 #define RTL_TEXTENCODING_ISO_8859_8             (RTL_TEXTENC_CAST( 19 ))
61 #define RTL_TEXTENCODING_ISO_8859_9             (RTL_TEXTENC_CAST( 20 ))
62 #define RTL_TEXTENCODING_ISO_8859_14            (RTL_TEXTENC_CAST( 21 ))
63 #define RTL_TEXTENCODING_ISO_8859_15            (RTL_TEXTENC_CAST( 22 ))
64 #define RTL_TEXTENCODING_IBM_737                (RTL_TEXTENC_CAST( 23 ))
65 #define RTL_TEXTENCODING_IBM_775                (RTL_TEXTENC_CAST( 24 ))
66 #define RTL_TEXTENCODING_IBM_852                (RTL_TEXTENC_CAST( 25 ))
67 #define RTL_TEXTENCODING_IBM_855                (RTL_TEXTENC_CAST( 26 ))
68 #define RTL_TEXTENCODING_IBM_857                (RTL_TEXTENC_CAST( 27 ))
69 #define RTL_TEXTENCODING_IBM_862                (RTL_TEXTENC_CAST( 28 ))
70 #define RTL_TEXTENCODING_IBM_864                (RTL_TEXTENC_CAST( 29 ))
71 #define RTL_TEXTENCODING_IBM_866                (RTL_TEXTENC_CAST( 30 ))
72 #define RTL_TEXTENCODING_IBM_869                (RTL_TEXTENC_CAST( 31 ))
73 #define RTL_TEXTENCODING_MS_874                 (RTL_TEXTENC_CAST( 32 ))
74 #define RTL_TEXTENCODING_MS_1250                (RTL_TEXTENC_CAST( 33 ))
75 #define RTL_TEXTENCODING_MS_1251                (RTL_TEXTENC_CAST( 34 ))
76 #define RTL_TEXTENCODING_MS_1253                (RTL_TEXTENC_CAST( 35 ))
77 #define RTL_TEXTENCODING_MS_1254                (RTL_TEXTENC_CAST( 36 ))
78 #define RTL_TEXTENCODING_MS_1255                (RTL_TEXTENC_CAST( 37 ))
79 #define RTL_TEXTENCODING_MS_1256                (RTL_TEXTENC_CAST( 38 ))
80 #define RTL_TEXTENCODING_MS_1257                (RTL_TEXTENC_CAST( 39 ))
81 #define RTL_TEXTENCODING_MS_1258                (RTL_TEXTENC_CAST( 40 ))
82 #define RTL_TEXTENCODING_APPLE_ARABIC           (RTL_TEXTENC_CAST( 41 ))
83 #define RTL_TEXTENCODING_APPLE_CENTEURO         (RTL_TEXTENC_CAST( 42 ))
84 #define RTL_TEXTENCODING_APPLE_CROATIAN         (RTL_TEXTENC_CAST( 43 ))
85 #define RTL_TEXTENCODING_APPLE_CYRILLIC         (RTL_TEXTENC_CAST( 44 ))
86 #define RTL_TEXTENCODING_APPLE_DEVANAGARI       (RTL_TEXTENC_CAST( 45 ))
87 #define RTL_TEXTENCODING_APPLE_FARSI            (RTL_TEXTENC_CAST( 46 ))
88 #define RTL_TEXTENCODING_APPLE_GREEK            (RTL_TEXTENC_CAST( 47 ))
89 #define RTL_TEXTENCODING_APPLE_GUJARATI         (RTL_TEXTENC_CAST( 48 ))
90 #define RTL_TEXTENCODING_APPLE_GURMUKHI         (RTL_TEXTENC_CAST( 49 ))
91 #define RTL_TEXTENCODING_APPLE_HEBREW           (RTL_TEXTENC_CAST( 50 ))
92 #define RTL_TEXTENCODING_APPLE_ICELAND          (RTL_TEXTENC_CAST( 51 ))
93 #define RTL_TEXTENCODING_APPLE_ROMANIAN         (RTL_TEXTENC_CAST( 52 ))
94 #define RTL_TEXTENCODING_APPLE_THAI             (RTL_TEXTENC_CAST( 53 ))
95 #define RTL_TEXTENCODING_APPLE_TURKISH          (RTL_TEXTENC_CAST( 54 ))
96 #define RTL_TEXTENCODING_APPLE_UKRAINIAN        (RTL_TEXTENC_CAST( 55 ))
97 #define RTL_TEXTENCODING_APPLE_CHINSIMP         (RTL_TEXTENC_CAST( 56 ))
98 #define RTL_TEXTENCODING_APPLE_CHINTRAD         (RTL_TEXTENC_CAST( 57 ))
99 #define RTL_TEXTENCODING_APPLE_JAPANESE         (RTL_TEXTENC_CAST( 58 ))
100 #define RTL_TEXTENCODING_APPLE_KOREAN           (RTL_TEXTENC_CAST( 59 ))
101 #define RTL_TEXTENCODING_MS_932                 (RTL_TEXTENC_CAST( 60 ))
102 #define RTL_TEXTENCODING_MS_936                 (RTL_TEXTENC_CAST( 61 ))
103 #define RTL_TEXTENCODING_MS_949                 (RTL_TEXTENC_CAST( 62 ))
104 #define RTL_TEXTENCODING_MS_950                 (RTL_TEXTENC_CAST( 63 ))
105 #define RTL_TEXTENCODING_SHIFT_JIS              (RTL_TEXTENC_CAST( 64 ))
106 #define RTL_TEXTENCODING_GB_2312                (RTL_TEXTENC_CAST( 65 ))
107 #define RTL_TEXTENCODING_GBT_12345              (RTL_TEXTENC_CAST( 66 ))
108 #define RTL_TEXTENCODING_GBK                    (RTL_TEXTENC_CAST( 67 ))
109 #define RTL_TEXTENCODING_BIG5                   (RTL_TEXTENC_CAST( 68 ))
110 #define RTL_TEXTENCODING_EUC_JP                 (RTL_TEXTENC_CAST( 69 ))
111 #define RTL_TEXTENCODING_EUC_CN                 (RTL_TEXTENC_CAST( 70 ))
112 #define RTL_TEXTENCODING_EUC_TW                 (RTL_TEXTENC_CAST( 71 ))
113 #define RTL_TEXTENCODING_ISO_2022_JP            (RTL_TEXTENC_CAST( 72 ))
114 #define RTL_TEXTENCODING_ISO_2022_CN            (RTL_TEXTENC_CAST( 73 ))
115 #define RTL_TEXTENCODING_KOI8_R                 (RTL_TEXTENC_CAST( 74 ))
116 #define RTL_TEXTENCODING_UTF7                   (RTL_TEXTENC_CAST( 75 ))
117 #define RTL_TEXTENCODING_UTF8                   (RTL_TEXTENC_CAST( 76 ))
118 #define RTL_TEXTENCODING_ISO_8859_10            (RTL_TEXTENC_CAST( 77 ))
119 #define RTL_TEXTENCODING_ISO_8859_13            (RTL_TEXTENC_CAST( 78 ))
120 #define RTL_TEXTENCODING_EUC_KR                 (RTL_TEXTENC_CAST( 79 ))
121 #define RTL_TEXTENCODING_ISO_2022_KR            (RTL_TEXTENC_CAST( 80 ))
122 #define RTL_TEXTENCODING_JIS_X_0201             (RTL_TEXTENC_CAST( 81 ))
123 #define RTL_TEXTENCODING_JIS_X_0208             (RTL_TEXTENC_CAST( 82 ))
124 #define RTL_TEXTENCODING_JIS_X_0212             (RTL_TEXTENC_CAST( 83 ))
125 #define RTL_TEXTENCODING_MS_1361                (RTL_TEXTENC_CAST( 84 ))
126 #define RTL_TEXTENCODING_GB_18030               (RTL_TEXTENC_CAST( 85 ))
127 #define RTL_TEXTENCODING_BIG5_HKSCS             (RTL_TEXTENC_CAST( 86 ))
128 #define RTL_TEXTENCODING_TIS_620                (RTL_TEXTENC_CAST( 87 ))
129 #define RTL_TEXTENCODING_KOI8_U                 (RTL_TEXTENC_CAST( 88 ))
130 #define RTL_TEXTENCODING_ISCII_DEVANAGARI       (RTL_TEXTENC_CAST( 89 ))
131 #define RTL_TEXTENCODING_JAVA_UTF8              (RTL_TEXTENC_CAST( 90 ))
132 #define RTL_TEXTENCODING_ADOBE_STANDARD         (RTL_TEXTENC_CAST( 91 ))
133 #define RTL_TEXTENCODING_ADOBE_SYMBOL           (RTL_TEXTENC_CAST( 92 ))
134 #define RTL_TEXTENCODING_PT154                  (RTL_TEXTENC_CAST( 93 ))
135 #define RTL_TEXTENCODING_ADOBE_DINGBATS         (RTL_TEXTENC_CAST( 94 ))
136 /* ATTENTION!  Whenever some encoding is added here, make sure to update
137  * rtl_isOctetTextEncoding in tencinfo.c.
138  */
139 
140 #define RTL_TEXTENCODING_USER_START             (RTL_TEXTENC_CAST( 0x8000 ))
141 #define RTL_TEXTENCODING_USER_END               (RTL_TEXTENC_CAST( 0xEFFF ))
142 
143 #define RTL_TEXTENCODING_UCS4                   (RTL_TEXTENC_CAST( 0xFFFE ))
144 #define RTL_TEXTENCODING_UCS2                   (RTL_TEXTENC_CAST( 0xFFFF ))
145 #define RTL_TEXTENCODING_UNICODE                RTL_TEXTENCODING_UCS2
146 
147 /****** Overview over the TextEncodings *****
148 # Arabic (Apple Macintosh)                        RTL_TEXTENCODING_APPLE_ARABIC
149 Arabic (DOS/OS2-864)                            RTL_TEXTENCODING_IBM_864
150 Arabic (ISO-8859-6)                             RTL_TEXTENCODING_ISO_8859_6
151 Arabic (Windows-1256)                           RTL_TEXTENCODING_MS_1256
152 
153 Baltic (DOS/OS2-775)                            RTL_TEXTENCODING_IBM_775
154 Baltic (ISO-8859-4)                             RTL_TEXTENCODING_ISO_8859_4
155 Baltic (Windows-1257)                           RTL_TEXTENCODING_MS_1257
156 
157 Central European (Apple Macintosh)              RTL_TEXTENCODING_APPLE_CENTEURO
158 Central European (Apple Macintosh/Croatian)     RTL_TEXTENCODING_APPLE_CROATIAN
159 Central European (Apple Macintosh/Romanian)     RTL_TEXTENCODING_APPLE_ROMANIAN
160 Central European (DOS/OS2-852)                  RTL_TEXTENCODING_IBM_852
161 Central European (ISO-8859-2)                   RTL_TEXTENCODING_ISO_8859_2
162 Central European (ISO-8859-10)                  RTL_TEXTENCODING_ISO_8859_10
163 Central European (ISO-8859-13)                  RTL_TEXTENCODING_ISO_8859_13
164 Central European (Windows-1250/WinLatin 2)      RTL_TEXTENCODING_MS_1250
165 
166 Chinese Simplified (Apple Macintosh)            RTL_TEXTENCODING_APPLE_CHINSIMP
167 Chinese Simplified (EUC-CN)                     RTL_TEXTENCODING_EUC_CN
168 Chinese Simplified (GB-2312)                    RTL_TEXTENCODING_GB_2312
169 Chinese Simplified (GBK/GB-2312-80)             RTL_TEXTENCODING_GBK
170 # Chinese Simplified (ISO-2022-CN)                RTL_TEXTENCODING_ISO_2022_CN
171 Chinese Simplified (Windows-936)                RTL_TEXTENCODING_MS_936
172 # Chinese Simplified (GB-18030)                   RTL_TEXTENCODING_GB_18030
173 
174 Chinese Traditional (Apple Macintosh)           RTL_TEXTENCODING_APPLE_CHINTRAD
175 Chinese Traditional (BIG5)                      RTL_TEXTENCODING_BIG5
176 # Chinese Traditional (EUC-TW)                    RTL_TEXTENCODING_EUC_TW
177 Chinese Traditional (GBT-12345)                 RTL_TEXTENCODING_GBT_12345
178 Chinese Traditional (Windows-950)               RTL_TEXTENCODING_MS_950
179 Chinese Traditional (BIG5-HKSCS)                RTL_TEXTENCODING_BIG5_HKSCS
180 
181 Cyrillic (Apple Macintosh)                      RTL_TEXTENCODING_APPLE_CYRILLIC
182 Cyrillic (Apple Macintosh/Ukrainian)            RTL_TEXTENCODING_APPLE_UKRAINIAN
183 Cyrillic (DOS/OS2-855)                          RTL_TEXTENCODING_IBM_855
184 Cyrillic (DOS/OS2-866/Russian)                  RTL_TEXTENCODING_IBM_866
185 Cyrillic (ISO-8859-5)                           RTL_TEXTENCODING_ISO_8859_5
186 Cyrillic (KOI8-R)                               RTL_TEXTENCODING_KOI8_R
187 Cyrillic (KOI8-U)                               RTL_TEXTENCODING_KOI8_U
188 Cyrillic (Windows-1251)                         RTL_TEXTENCODING_MS_1251
189 
190 Greek (Apple Macintosh)                         RTL_TEXTENCODING_APPLE_GREEK
191 Greek (DOS/OS2-737)                             RTL_TEXTENCODING_IBM_737
192 Greek (DOS/OS2-869/Modern)                      RTL_TEXTENCODING_IBM_869
193 Greek (ISO-8859-7)                              RTL_TEXTENCODING_ISO_8859_7
194 Greek (Windows-1253)                            RTL_TEXTENCODING_MS_1253
195 
196 # Hebrew (Apple Macintosh)                        RTL_TEXTENCODING_APPLE_HEBREW
197 Hebrew (DOS/OS2-862)                            RTL_TEXTENCODING_IBM_862
198 Hebrew (ISO-8859-8)                             RTL_TEXTENCODING_ISO_8859_8
199 Hebrew (Windows-1255)                           RTL_TEXTENCODING_MS_1255
200 
201 Korean (Apple Macintosh)                        RTL_TEXTENCODING_APPLE_KOREAN
202 Korean (EUC-KR)                                 RTL_TEXTENCODING_EUC_KR
203 # Korean (ISO-2022-KR)                            RTL_TEXTENCODING_ISO_2022_KR
204 Korean (Windows-Wansung-949)                    RTL_TEXTENCODING_MS_949
205 Korean (Windows-Johab-1361)                     RTL_TEXTENCODING_MS_1361
206 
207 Latin 3 (ISO-8859-3)                            RTL_TEXTENCODING_ISO_8859_3
208 
209 Indian (ISCII Devanagari)                      RTL_TEXTENCODING_ISCII_DEVANAGARI
210 
211 Japanese (Apple Macintosh)                      RTL_TEXTENCODING_APPLE_JAPANESE
212 Japanese (EUC-JP)                               RTL_TEXTENCODING_EUC_JP
213 # Japanese (ISO-2022-JP)                          RTL_TEXTENCODING_ISO_2022_JP
214 Japanese (Shift-JIS)                            RTL_TEXTENCODING_SHIFT_JIS
215 Japanese (Windows-932)                          RTL_TEXTENCODING_MS_932
216 
217 Symbol                                          RTL_TEXTENCODING_SYMBOL
218 
219 # Thai (Apple Macintosh)                          RTL_TEXTENCODING_APPLE_THAI
220 Thai (Dos/Windows-874)                          RTL_TEXTENCODING_MS_874
221 Thai (TIS 620)                                  RTL_TEXTENCODING_TIS_620
222 
223 Turkish (Apple Macintosh)                       RTL_TEXTENCODING_APPLE_TURKISH
224 Turkish (DOS/OS2-857)                           RTL_TEXTENCODING_IBM_857
225 Turkish (ISO-8859-9)                            RTL_TEXTENCODING_ISO_8859_9
226 Turkish (Windows-1254)                          RTL_TEXTENCODING_MS_1254
227 
228 Unicode (UTF-7)                                 RTL_TEXTENCODING_UTF7
229 Unicode (UTF-8)                                 RTL_TEXTENCODING_UTF8
230 Unicode (Java's modified UTF-8)                 RTL_TEXTENCODING_JAVA_UTF8
231 
232 Vietnamese (Windows-1258)                       RTL_TEXTENCODING_MS_1258
233 
234 Western (Apple Macintosh)                       RTL_TEXTENCODING_APPLE_ROMAN
235 Western (Apple Macintosh/Icelandic)             RTL_TEXTENCODING_APPLE_ICELAND
236 Western (ASCII/US)                              RTL_TEXTENCODING_ASCII_US
237 Western (DOS/OS2-437/US)                        RTL_TEXTENCODING_IBM_437
238 Western (DOS/OS2-850/International)             RTL_TEXTENCODING_IBM_850
239 Western (DOS/OS2-860/Portuguese)                RTL_TEXTENCODING_IBM_860
240 Western (DOS/OS2-861/Icelandic)                 RTL_TEXTENCODING_IBM_861
241 Western (DOS/OS2-863/Canadian-French)           RTL_TEXTENCODING_IBM_863
242 Western (DOS/OS2-865/Nordic)                    RTL_TEXTENCODING_IBM_865
243 Western (ISO-8859-1)                            RTL_TEXTENCODING_ISO_8859_1
244 Western (ISO-8859-14)                           RTL_TEXTENCODING_ISO_8859_14
245 Western (ISO-8859-15/EURO)                      RTL_TEXTENCODING_ISO_8859_15
246 Western (Window-1252/WinLatin 1)                RTL_TEXTENCODING_MS_1252
247 
248 Not known and currently not supported
249 # RTL_TEXTENCODING_APPLE_DEVANAGARI
250 # RTL_TEXTENCODING_APPLE_FARSI
251 # RTL_TEXTENCODING_APPLE_GUJARATI
252 # RTL_TEXTENCODING_APPLE_GURMUKHI
253 
254 Only for internal implementations and not useful for user interface.
255 These encodings are not used for text encodings, only used for
256 font-/textoutput encodings.
257 Japanese (JIS 0201)                             RTL_TEXTENCODING_JISX_0201
258 Japanese (JIS 0208)                             RTL_TEXTENCODING_JISX_0208
259 Japanese (JIS 0212)                             RTL_TEXTENCODING_JISX_0212
260 
261 # Currently not implemented
262 */
263 
264 #endif // INCLUDED_RTL_TEXTENC_H
265 
266 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
267