1 /*
2 * Copyright (c) 1997, 2013, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation.
8 *
9 * This code is distributed in the hope that it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
12 * version 2 for more details (a copy is included in the LICENSE file that
13 * accompanied this code).
14 *
15 * You should have received a copy of the GNU General Public License version
16 * 2 along with this work; if not, write to the Free Software Foundation,
17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
18 *
19 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
20 * or visit www.oracle.com if you need additional information or have any
21 * questions.
22 *
23 */
24
25 #include "precompiled.hpp"
26 #include "utilities/utf8.hpp"
27
28 // Assume the utf8 string is in legal form and has been
29 // checked in the class file parser/format checker.
30 char* UTF8::next(const char* str, jchar* value) {
31 unsigned const char *ptr = (const unsigned char *)str;
32 unsigned char ch, ch2, ch3;
33 int length = -1; /* bad length */
34 jchar result;
35 switch ((ch = ptr[0]) >> 4) {
36 default:
37 result = ch;
38 length = 1;
39 break;
40
41 case 0x8: case 0x9: case 0xA: case 0xB: case 0xF:
42 /* Shouldn't happen. */
43 break;
44
45 case 0xC: case 0xD:
46 /* 110xxxxx 10xxxxxx */
47 if (((ch2 = ptr[1]) & 0xC0) == 0x80) {
48 unsigned char high_five = ch & 0x1F;
49 unsigned char low_six = ch2 & 0x3F;
50 result = (high_five << 6) + low_six;
51 length = 2;
52 break;
53 }
54 break;
55
56 case 0xE:
57 /* 1110xxxx 10xxxxxx 10xxxxxx */
58 if (((ch2 = ptr[1]) & 0xC0) == 0x80) {
59 if (((ch3 = ptr[2]) & 0xC0) == 0x80) {
60 unsigned char high_four = ch & 0x0f;
61 unsigned char mid_six = ch2 & 0x3f;
62 unsigned char low_six = ch3 & 0x3f;
63 result = (((high_four << 6) + mid_six) << 6) + low_six;
64 length = 3;
65 }
66 }
67 break;
68 } /* end of switch */
69
70 if (length <= 0) {
71 *value = ptr[0]; /* default bad result; */
72 return (char*)(ptr + 1); // make progress somehow
73 }
74
75 *value = result;
76
77 // The assert is correct but the .class file is wrong
78 // assert(UNICODE::utf8_size(result) == length, "checking reverse computation");
79 return (char *)(ptr + length);
80 }
81
82 char* UTF8::next_character(const char* str, jint* value) {
83 unsigned const char *ptr = (const unsigned char *)str;
84 /* See if it's legal supplementary character:
85 11101101 1010xxxx 10xxxxxx 11101101 1011xxxx 10xxxxxx */
86 if (is_supplementary_character(ptr)) {
87 *value = get_supplementary_character(ptr);
88 return (char *)(ptr + 6);
89 }
90 jchar result;
91 char* next_ch = next(str, &result);
92 *value = result;
93 return next_ch;
94 }
95
96 // Count bytes of the form 10xxxxxx and deduct this count
97 // from the total byte count. The utf8 string must be in
98 // legal form which has been verified in the format checker.
99 int UTF8::unicode_length(const char* str, int len) {
100 int num_chars = len;
101 for (int i = 0; i < len; i++) {
102 if ((str[i] & 0xC0) == 0x80) {
103 --num_chars;
104 }
105 }
106 return num_chars;
107 }
108
109 // Count bytes of the utf8 string except those in form
110 // 10xxxxxx which only appear in multibyte characters.
111 // The utf8 string must be in legal form and has been
112 // verified in the format checker.
113 int UTF8::unicode_length(const char* str) {
114 int num_chars = 0;
115 for (const char* p = str; *p; p++) {
116 if (((*p) & 0xC0) != 0x80) {
117 num_chars++;
118 }
119 }
120 return num_chars;
121 }
122
123 // Writes a jchar a utf8 and returns the end
124 static u_char* utf8_write(u_char* base, jchar ch) {
125 if ((ch != 0) && (ch <=0x7f)) {
126 base[0] = (u_char) ch;
127 return base + 1;
128 }
129
130 if (ch <= 0x7FF) {
131 /* 11 bits or less. */
132 unsigned char high_five = ch >> 6;
133 unsigned char low_six = ch & 0x3F;
134 base[0] = high_five | 0xC0; /* 110xxxxx */
135 base[1] = low_six | 0x80; /* 10xxxxxx */
136 return base + 2;
137 }
138 /* possibly full 16 bits. */
139 char high_four = ch >> 12;
140 char mid_six = (ch >> 6) & 0x3F;
141 char low_six = ch & 0x3f;
142 base[0] = high_four | 0xE0; /* 1110xxxx */
143 base[1] = mid_six | 0x80; /* 10xxxxxx */
144 base[2] = low_six | 0x80; /* 10xxxxxx */
145 return base + 3;
146 }
147
148 void UTF8::convert_to_unicode(const char* utf8_str, jchar* unicode_str, int unicode_length) {
149 unsigned char ch;
150 const char *ptr = utf8_str;
151 int index = 0;
152
153 /* ASCII case loop optimization */
154 for (; index < unicode_length; index++) {
155 if((ch = ptr[0]) > 0x7F) { break; }
156 unicode_str[index] = ch;
157 ptr = (const char *)(ptr + 1);
158 }
159
160 for (; index < unicode_length; index++) {
161 ptr = UTF8::next(ptr, &unicode_str[index]);
162 }
163 }
164
165 // returns the quoted ascii length of a 0-terminated utf8 string
166 int UTF8::quoted_ascii_length(const char* utf8_str, int utf8_length) {
167 const char *ptr = utf8_str;
168 const char* end = ptr + utf8_length;
169 int result = 0;
170 while (ptr < end) {
171 jchar c;
172 ptr = UTF8::next(ptr, &c);
173 if (c >= 32 && c < 127) {
174 result++;
175 } else {
176 result += 6;
177 }
178 }
179 return result;
180 }
181
182 // converts a utf8 string to quoted ascii
183 void UTF8::as_quoted_ascii(const char* utf8_str, int utf8_length, char* buf, int buflen) {
184 const char *ptr = utf8_str;
185 const char *utf8_end = ptr + utf8_length;
186 char* p = buf;
187 char* end = buf + buflen;
188 while (ptr < utf8_end) {
189 jchar c;
190 ptr = UTF8::next(ptr, &c);
191 if (c >= 32 && c < 127) {
192 if (p + 1 >= end) break; // string is truncated
193 *p++ = (char)c;
194 } else {
195 if (p + 6 >= end) break; // string is truncated
196 sprintf(p, "\\u%04x", c);
197 p += 6;
198 }
199 }
200 assert(p < end, "sanity");
201 *p = '\0';
202 }
203
204
205 const char* UTF8::from_quoted_ascii(const char* quoted_ascii_str) {
206 const char *ptr = quoted_ascii_str;
207 char* result = NULL;
208 while (*ptr != '\0') {
209 char c = *ptr;
210 if (c < 32 || c >= 127) break;
211 }
212 if (*ptr == '\0') {
213 // nothing to do so return original string
214 return quoted_ascii_str;
215 }
216 // everything up to this point was ok.
217 int length = ptr - quoted_ascii_str;
218 char* buffer = NULL;
219 for (int round = 0; round < 2; round++) {
220 while (*ptr != '\0') {
221 if (*ptr != '\\') {
222 if (buffer != NULL) {
223 buffer[length] = *ptr;
224 }
225 length++;
226 } else {
227 switch (ptr[1]) {
228 case 'u': {
229 ptr += 2;
230 jchar value=0;
231 for (int i=0; i<4; i++) {
232 char c = *ptr++;
233 switch (c) {
234 case '0': case '1': case '2': case '3': case '4':
235 case '5': case '6': case '7': case '8': case '9':
236 value = (value << 4) + c - '0';
237 break;
238 case 'a': case 'b': case 'c':
239 case 'd': case 'e': case 'f':
240 value = (value << 4) + 10 + c - 'a';
241 break;
242 case 'A': case 'B': case 'C':
243 case 'D': case 'E': case 'F':
244 value = (value << 4) + 10 + c - 'A';
245 break;
246 default:
247 ShouldNotReachHere();
248 }
249 }
250 if (buffer == NULL) {
251 char utf8_buffer[4];
252 char* next = (char*)utf8_write((u_char*)utf8_buffer, value);
253 length += next - utf8_buffer;
254 } else {
255 char* next = (char*)utf8_write((u_char*)&buffer[length], value);
256 length += next - &buffer[length];
257 }
258 break;
259 }
260 case 't': if (buffer != NULL) buffer[length] = '\t'; ptr += 2; length++; break;
261 case 'n': if (buffer != NULL) buffer[length] = '\n'; ptr += 2; length++; break;
262 case 'r': if (buffer != NULL) buffer[length] = '\r'; ptr += 2; length++; break;
263 case 'f': if (buffer != NULL) buffer[length] = '\f'; ptr += 2; length++; break;
264 default:
265 ShouldNotReachHere();
266 }
267 }
268 }
269 if (round == 0) {
270 buffer = NEW_RESOURCE_ARRAY(char, length + 1);
271 ptr = quoted_ascii_str;
272 } else {
273 buffer[length] = '\0';
274 }
275 }
276 return buffer;
277 }
278
279
280 // Returns NULL if 'c' it not found. This only works as long
281 // as 'c' is an ASCII character
282 const jbyte* UTF8::strrchr(const jbyte* base, int length, jbyte c) {
283 assert(length >= 0, "sanity check");
284 assert(c >= 0, "does not work for non-ASCII characters");
285 // Skip backwards in string until 'c' is found or end is reached
286 while(--length >= 0 && base[length] != c);
287 return (length < 0) ? NULL : &base[length];
288 }
289
290 bool UTF8::equal(const jbyte* base1, int length1, const jbyte* base2, int length2) {
291 // Length must be the same
292 if (length1 != length2) return false;
293 for (int i = 0; i < length1; i++) {
294 if (base1[i] != base2[i]) return false;
295 }
296 return true;
297 }
298
299 bool UTF8::is_supplementary_character(const unsigned char* str) {
300 return ((str[0] & 0xFF) == 0xED) && ((str[1] & 0xF0) == 0xA0) && ((str[2] & 0xC0) == 0x80)
301 && ((str[3] & 0xFF) == 0xED) && ((str[4] & 0xF0) == 0xB0) && ((str[5] & 0xC0) == 0x80);
302 }
303
304 jint UTF8::get_supplementary_character(const unsigned char* str) {
305 return 0x10000 + ((str[1] & 0x0f) << 16) + ((str[2] & 0x3f) << 10)
306 + ((str[4] & 0x0f) << 6) + (str[5] & 0x3f);
307 }
308
309
310 //-------------------------------------------------------------------------------------
311
312
313 int UNICODE::utf8_size(jchar c) {
314 if ((0x0001 <= c) && (c <= 0x007F)) return 1;
315 if (c <= 0x07FF) return 2;
316 return 3;
317 }
318
319 int UNICODE::utf8_length(jchar* base, int length) {
320 int result = 0;
321 for (int index = 0; index < length; index++) {
322 jchar c = base[index];
323 if ((0x0001 <= c) && (c <= 0x007F)) result += 1;
324 else if (c <= 0x07FF) result += 2;
325 else result += 3;
326 }
327 return result;
328 }
329
330 char* UNICODE::as_utf8(jchar* base, int length) {
331 int utf8_len = utf8_length(base, length);
332 u_char* buf = NEW_RESOURCE_ARRAY(u_char, utf8_len + 1);
333 char* result = as_utf8(base, length, (char*) buf, utf8_len + 1);
334 assert((int) strlen(result) == utf8_len, "length prediction must be correct");
335 return result;
336 }
337
338 char* UNICODE::as_utf8(jchar* base, int length, char* buf, int buflen) {
339 u_char* p = (u_char*)buf;
340 for (int index = 0; index < length; index++) {
341 jchar c = base[index];
342 buflen -= utf8_size(c);
343 if (buflen <= 0) break; // string is truncated
344 p = utf8_write(p, c);
345 }
346 *p = '\0';
347 return buf;
348 }
349
350 void UNICODE::convert_to_utf8(const jchar* base, int length, char* utf8_buffer) {
351 for(int index = 0; index < length; index++) {
352 utf8_buffer = (char*)utf8_write((u_char*)utf8_buffer, base[index]);
353 }
354 *utf8_buffer = '\0';
355 }
356
357 // returns the quoted ascii length of a unicode string
358 int UNICODE::quoted_ascii_length(jchar* base, int length) {
359 int result = 0;
360 for (int i = 0; i < length; i++) {
361 jchar c = base[i];
362 if (c >= 32 && c < 127) {
363 result++;
364 } else {
365 result += 6;
366 }
367 }
368 return result;
369 }
370
371 // converts a utf8 string to quoted ascii
372 void UNICODE::as_quoted_ascii(const jchar* base, int length, char* buf, int buflen) {
373 char* p = buf;
374 char* end = buf + buflen;
375 for (int index = 0; index < length; index++) {
376 jchar c = base[index];
377 if (c >= 32 && c < 127) {
378 if (p + 1 >= end) break; // string is truncated
379 *p++ = (char)c;
380 } else {
381 if (p + 6 >= end) break; // string is truncated
382 sprintf(p, "\\u%04x", c);
383 p += 6;
384 }
385 }
386 *p = '\0';
387 }
388
389 #ifndef PRODUCT
390 void TestAsUtf8() {
391 char res[60];
392 jchar str[20];
393
394 for (int i = 0; i < 20; i++) {
395 str[i] = 0x0800; // char that is 2B in UTF-16 but 3B in UTF-8
396 }
397 str[19] = (jchar)'\0';
398
399 // The resulting string in UTF-8 is 3*19 bytes long, but should be truncated
400 UNICODE::as_utf8(str, 19, res, 10);
401 assert(strlen(res) == 9, "string should be truncated here");
402
403 UNICODE::as_utf8(str, 19, res, 18);
404 assert(strlen(res) == 15, "string should be truncated here");
405
406 UNICODE::as_utf8(str, 19, res, 20);
407 assert(strlen(res) == 18, "string should be truncated here");
408
409 // Test with an "unbounded" buffer
410 UNICODE::as_utf8(str, 19, res, INT_MAX);
411 assert(strlen(res) == 3*19, "string should end here");
412 }
413 #endif