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
|
/* ScummVM - Graphic Adventure Engine
*
* ScummVM is the legal property of its developers, whose names
* are too numerous to list here. Please refer to the COPYRIGHT
* file distributed with this source distribution.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program 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 General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*
*/
#ifndef COMMON_ENCODING_H
#define COMMON_ENCODING_H
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif // HAVE_CONFIG_H
#ifdef USE_ICONV
#include <iconv.h>
#else
typedef void* iconv_t;
#endif // USE_ICONV
#include "common/scummsys.h"
#include "common/str.h"
namespace Common {
/**
* A class, that allows conversion between different text encoding,
* the encodings available depend on the current backend and if the
* ScummVM is compiled with or without iconv.
*/
class Encoding {
public:
/**
* Constructs everything needed for the conversion between 2 encodings
* and saves the values for future use.
*
* @param to Name of the encoding the strings will be converted to
* @param from Name of the encoding the strings will be converted from
*/
Encoding(const String &to, const String &from);
~Encoding();
/**
* Converts string between encodings. The resulting string is ended by
* a character with value 0 (C-like ending for 1 byte per character
* encodings, 2 zero bytes for UTF-16, 4 zero bytes for UTF-32)
*
* The result has to be freed after use.
*
* @param string String that should be converted.
* @param length Length of the string to convert in bytes.
*
* @return Converted string (must be freed) or nullptr if the conversion failed
*/
char *convert(const char *string, size_t length);
/**
* Static version of the method above.
* Converts string between encodings. The resulting string is ended by
* a character with value 0 (C-like ending for 1 byte per character
* encodings, 2 zero bytes for UTF-16, 4 zero bytes for UTF-32)
*
* The result has to be freed after use.
*
* @param to Name of the encoding the strings will be converted to
* @param from Name of the encoding the strings will be converted from
* @param string String that should be converted.
* @param length Length of the string to convert in bytes.
*
* @return Converted string (must be freed) or nullptr if the conversion failed
*/
static char *convert(const String &to, const String &from, const char *string, size_t length);
/**
* @return The encoding, which is currently being converted from
*/
String getFrom() {return _from;};
/**
* @param from The encoding, to convert from
*/
void setFrom(const String &from);
/**
* @return The encoding, which is currently being converted to
*/
String getTo() {return _to;};
/**
* @param to The encoding, to convert to
*/
void setTo(const String &to);
private:
/** The encoding, which is currently being converted to */
String _to;
/** The encoding, which is currently being converted from */
String _from;
/**
* iconvHandle currently used for conversions (is void pointer to 0
* if the ScummVM isn't compiled with iconv)
*/
iconv_t _iconvHandle;
/**
* Takes care of transliteration and calls conversion
*
* The result has to be freed after use.
*
* @param iconvHandle Handle to use for the conversion
* @param to Name of the encoding the strings will be converted to
* @param from Name of the encoding the strings will be converted from
* @param string String that should be converted.
* @param length Length of the string to convert in bytes.
*
* @return Converted string (must be freed) or nullptr if the conversion failed
*/
static char *convertWithTransliteration(iconv_t iconvHandle, const String &to, const String &from, const char *string, size_t length);
/**
* Calls as many conversion functions as possible or until the conversion
* succeeds. It first tries to use iconv, then it tries to use platform
* specific functions and after that it tries to use TransMan mapping.
*
* The result has to be freed after use.
*
* @param iconvHandle Handle to use for the conversion
* @param to Name of the encoding the strings will be converted to
* @param from Name of the encoding the strings will be converted from
* @param string String that should be converted.
* @param length Length of the string to convert in bytes.
*
* @return Converted string (must be freed) or nullptr if the conversion failed
*/
static char *conversion(iconv_t iconvHandle, const String &to, const String &from, const char *string, size_t length);
/**
* Tries to convert the string using iconv.
*
* The result has to be freed after use.
*
* @param iconvHandle Handle to use for the conversion
* @param string String that should be converted.
* @param length Length of the string to convert in bytes.
*
* @return Converted string (must be freed) or nullptr if the conversion failed
*/
static char *convertIconv(iconv_t iconvHandle, const char *string, size_t length);
/**
* Tries to use the TransMan to convert the string. It can convert only
* between UTF-32 and the current GUI charset. It also tries to convert
* from the current GUI charset to UTF-32 and then it calls convert() again.
*
* The result has to be freed after use.
*
* @param to Name of the encoding the strings will be converted to
* @param from Name of the encoding the strings will be converted from
* @param string String that should be converted.
* @param length Length of the string to convert in bytes.
*
* @return Converted string (must be freed) or nullptr if the conversion failed
*/
static char *convertTransManMapping(const char *to, const char *from, const char *string, size_t length);
/**
* Transliterates cyrilic string in iso-8859-5 encoding and returns
* it's ASCII (latin) form.
*
* The result has to be freed after use.
*
* @param string String that should be converted
*
* @return Transliterated string in ASCII (must be freed) or nullptr on fail.
*/
static char *transliterateCyrilic(const char *string);
/**
* Transliterates cyrilic in UTF-32 string.
*
* The result has to be freed after use.
*
* @param string String that should be converted
* @param length Length of the string in bytes
*
* @return Transliterated string in UTF-32 (must be freed) or nullptr on fail.
*/
static uint32 *transliterateUTF32(const uint32 *string, size_t length);
/**
* Inits the iconv handle
*
* The result has to be freed after use.
*
* @param to Name of the encoding the strings will be converted to
* @param from Name of the encoding the strings will be converted from
*
* @return Opened iconv handle or 0 if ScummVM is compiled without iconv
*/
static iconv_t initIconv(const String &to, const String &from);
/**
* Deinits the iconv handle
*
* @param iconvHandle Handle that should be deinited
*/
static void deinitIconv(iconv_t iconvHandle);
/**
* If the string is "utf-16" or "utf-32", this adds either BE for big endian
* or LE for little endian to the end of the string. Otherwise this does
* nothing.
*
* @param str String to append the endianness to
*
* @return The same string with appended endianness if it is needed, or
* the same string.
*/
static String addUtfEndianness(const String &str);
};
}
#endif // COMMON_ENCODING_H
|
