1 /* $NetBSD: utf8.c,v 1.1.1.2 2014/04/24 12:45:56 pettai Exp $ */
4 * Copyright (c) 2004, 2006, 2007, 2008 Kungliga Tekniska Högskolan
5 * (Royal Institute of Technology, Stockholm, Sweden).
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
19 * 3. Neither the name of the Institute nor the names of its contributors
20 * may be used to endorse or promote products derived from this software
21 * without specific prior written permission.
23 * THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
24 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26 * ARE DISCLAIMED. IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
27 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
40 utf8toutf32(const unsigned char **pp
, uint32_t *out
)
42 const unsigned char *p
= *pp
;
46 if ((c
& 0xE0) == 0xC0) {
47 const unsigned c2
= *++p
;
48 if ((c2
& 0xC0) == 0x80) {
49 *out
= ((c
& 0x1F) << 6)
52 return WIND_ERR_INVALID_UTF8
;
54 } else if ((c
& 0xF0) == 0xE0) {
55 const unsigned c2
= *++p
;
56 if ((c2
& 0xC0) == 0x80) {
57 const unsigned c3
= *++p
;
58 if ((c3
& 0xC0) == 0x80) {
59 *out
= ((c
& 0x0F) << 12)
63 return WIND_ERR_INVALID_UTF8
;
66 return WIND_ERR_INVALID_UTF8
;
68 } else if ((c
& 0xF8) == 0xF0) {
69 const unsigned c2
= *++p
;
70 if ((c2
& 0xC0) == 0x80) {
71 const unsigned c3
= *++p
;
72 if ((c3
& 0xC0) == 0x80) {
73 const unsigned c4
= *++p
;
74 if ((c4
& 0xC0) == 0x80) {
75 *out
= ((c
& 0x07) << 18)
80 return WIND_ERR_INVALID_UTF8
;
83 return WIND_ERR_INVALID_UTF8
;
86 return WIND_ERR_INVALID_UTF8
;
89 return WIND_ERR_INVALID_UTF8
;
101 * Convert an UTF-8 string to an UCS4 string.
103 * @param in an UTF-8 string to convert.
104 * @param out the resulting UCS4 strint, must be at least
105 * wind_utf8ucs4_length() long. If out is NULL, the function will
106 * calculate the needed space for the out variable (just like
107 * wind_utf8ucs4_length()).
108 * @param out_len before processing out_len should be the length of
109 * the out variable, after processing it will be the length of the out
112 * @return returns 0 on success, an wind error code otherwise
117 wind_utf8ucs4(const char *in
, uint32_t *out
, size_t *out_len
)
119 const unsigned char *p
;
123 for (p
= (const unsigned char *)in
; *p
!= '\0'; ++p
) {
126 ret
= utf8toutf32(&p
, &u
);
132 return WIND_ERR_OVERRUN
;
142 * Calculate the length of from converting a UTF-8 string to a UCS4
145 * @param in an UTF-8 string to convert.
146 * @param out_len the length of the resulting UCS4 string.
148 * @return returns 0 on success, an wind error code otherwise
153 wind_utf8ucs4_length(const char *in
, size_t *out_len
)
155 return wind_utf8ucs4(in
, NULL
, out_len
);
158 static const char first_char
[4] =
159 { 0x00, 0xC0, 0xE0, 0xF0 };
162 * Convert an UCS4 string to a UTF-8 string.
164 * @param in an UCS4 string to convert.
165 * @param in_len the length input array.
167 * @param out the resulting UTF-8 strint, must be at least
168 * wind_ucs4utf8_length() + 1 long (the extra char for the NUL). If
169 * out is NULL, the function will calculate the needed space for the
170 * out variable (just like wind_ucs4utf8_length()).
172 * @param out_len before processing out_len should be the length of
173 * the out variable, after processing it will be the length of the out
176 * @return returns 0 on success, an wind error code otherwise
181 wind_ucs4utf8(const uint32_t *in
, size_t in_len
, char *out
, size_t *out_len
)
186 for (o
= 0, i
= 0; i
< in_len
; i
++) {
191 } else if (ch
< 0x800) {
193 } else if (ch
< 0x10000) {
195 } else if (ch
<= 0x10FFFF) {
198 return WIND_ERR_INVALID_UTF32
;
204 return WIND_ERR_OVERRUN
;
208 out
[3] = (ch
| 0x80) & 0xbf;
211 out
[2] = (ch
| 0x80) & 0xbf;
214 out
[1] = (ch
| 0x80) & 0xbf;
217 out
[0] = ch
| first_char
[len
- 1];
223 if (o
+ 1 >= *out_len
)
224 return WIND_ERR_OVERRUN
;
232 * Calculate the length of from converting a UCS4 string to an UTF-8 string.
234 * @param in an UCS4 string to convert.
235 * @param in_len the length of UCS4 string to convert.
236 * @param out_len the length of the resulting UTF-8 string.
238 * @return returns 0 on success, an wind error code otherwise
243 wind_ucs4utf8_length(const uint32_t *in
, size_t in_len
, size_t *out_len
)
245 return wind_ucs4utf8(in
, in_len
, NULL
, out_len
);
249 * Read in an UCS2 from a buffer.
251 * @param ptr The input buffer to read from.
252 * @param len the length of the input buffer.
253 * @param flags Flags to control the behavior of the function.
254 * @param out the output UCS2, the array must be at least out/2 long.
255 * @param out_len the output length
257 * @return returns 0 on success, an wind error code otherwise.
262 wind_ucs2read(const void *ptr
, size_t len
, unsigned int *flags
,
263 uint16_t *out
, size_t *out_len
)
265 const unsigned char *p
= ptr
;
266 int little
= ((*flags
) & WIND_RW_LE
);
267 size_t olen
= *out_len
;
269 /** if len is zero, flags are unchanged */
275 /** if len is odd, WIND_ERR_LENGTH_NOT_MOD2 is returned */
277 return WIND_ERR_LENGTH_NOT_MOD2
;
280 * If the flags WIND_RW_BOM is set, check for BOM. If not BOM is
281 * found, check is LE/BE flag is already and use that otherwise
282 * fail with WIND_ERR_NO_BOM. When done, clear WIND_RW_BOM and
283 * the LE/BE flag and set the resulting LE/BE flag.
285 if ((*flags
) & WIND_RW_BOM
) {
286 uint16_t bom
= (p
[0] << 8) + p
[1];
287 if (bom
== 0xfffe || bom
== 0xfeff) {
288 little
= (bom
== 0xfffe);
291 } else if (((*flags
) & (WIND_RW_LE
|WIND_RW_BE
)) != 0) {
292 /* little already set */
294 return WIND_ERR_NO_BOM
;
295 *flags
= ((*flags
) & ~(WIND_RW_BOM
|WIND_RW_LE
|WIND_RW_BE
));
296 *flags
|= little
? WIND_RW_LE
: WIND_RW_BE
;
301 return WIND_ERR_OVERRUN
;
303 *out
= (p
[1] << 8) + p
[0];
305 *out
= (p
[0] << 8) + p
[1];
306 out
++; p
+= 2; len
-= 2; olen
--;
313 * Write an UCS2 string to a buffer.
315 * @param in The input UCS2 string.
316 * @param in_len the length of the input buffer.
317 * @param flags Flags to control the behavior of the function.
318 * @param ptr The input buffer to write to, the array must be at least
319 * (in + 1) * 2 bytes long.
320 * @param out_len the output length
322 * @return returns 0 on success, an wind error code otherwise.
327 wind_ucs2write(const uint16_t *in
, size_t in_len
, unsigned int *flags
,
328 void *ptr
, size_t *out_len
)
330 unsigned char *p
= ptr
;
331 size_t len
= *out_len
;
333 /** If in buffer is not of length be mod 2, WIND_ERR_LENGTH_NOT_MOD2 is returned*/
335 return WIND_ERR_LENGTH_NOT_MOD2
;
337 /** On zero input length, flags are preserved */
342 /** If flags have WIND_RW_BOM set, the byte order mark is written
343 * first to the output data */
344 if ((*flags
) & WIND_RW_BOM
) {
345 uint16_t bom
= 0xfffe;
348 return WIND_ERR_OVERRUN
;
350 if ((*flags
) & WIND_RW_LE
) {
351 p
[0] = (bom
) & 0xff;
352 p
[1] = (bom
>> 8) & 0xff;
354 p
[1] = (bom
) & 0xff;
355 p
[0] = (bom
>> 8) & 0xff;
361 /** If the output wont fit into out_len, WIND_ERR_OVERRUN is returned */
363 return WIND_ERR_OVERRUN
;
364 if ((*flags
) & WIND_RW_LE
) {
365 p
[0] = (in
[0] ) & 0xff;
366 p
[1] = (in
[0] >> 8) & 0xff;
368 p
[1] = (in
[0] ) & 0xff;
369 p
[0] = (in
[0] >> 8) & 0xff;
382 * Convert an UTF-8 string to an UCS2 string.
384 * @param in an UTF-8 string to convert.
385 * @param out the resulting UCS2 strint, must be at least
386 * wind_utf8ucs2_length() long. If out is NULL, the function will
387 * calculate the needed space for the out variable (just like
388 * wind_utf8ucs2_length()).
389 * @param out_len before processing out_len should be the length of
390 * the out variable, after processing it will be the length of the out
393 * @return returns 0 on success, an wind error code otherwise
398 wind_utf8ucs2(const char *in
, uint16_t *out
, size_t *out_len
)
400 const unsigned char *p
;
404 for (p
= (const unsigned char *)in
; *p
!= '\0'; ++p
) {
407 ret
= utf8toutf32(&p
, &u
);
412 return WIND_ERR_NOT_UTF16
;
416 return WIND_ERR_OVERRUN
;
426 * Calculate the length of from converting a UTF-8 string to a UCS2
429 * @param in an UTF-8 string to convert.
430 * @param out_len the length of the resulting UCS4 string.
432 * @return returns 0 on success, an wind error code otherwise
437 wind_utf8ucs2_length(const char *in
, size_t *out_len
)
439 return wind_utf8ucs2(in
, NULL
, out_len
);
443 * Convert an UCS2 string to a UTF-8 string.
445 * @param in an UCS2 string to convert.
446 * @param in_len the length of the in UCS2 string.
447 * @param out the resulting UTF-8 strint, must be at least
448 * wind_ucs2utf8_length() long. If out is NULL, the function will
449 * calculate the needed space for the out variable (just like
450 * wind_ucs2utf8_length()).
451 * @param out_len before processing out_len should be the length of
452 * the out variable, after processing it will be the length of the out
455 * @return returns 0 on success, an wind error code otherwise
460 wind_ucs2utf8(const uint16_t *in
, size_t in_len
, char *out
, size_t *out_len
)
465 for (o
= 0, i
= 0; i
< in_len
; i
++) {
470 } else if (ch
< 0x800) {
479 return WIND_ERR_OVERRUN
;
483 out
[2] = (ch
| 0x80) & 0xbf;
486 out
[1] = (ch
| 0x80) & 0xbf;
489 out
[0] = ch
| first_char
[len
- 1];
496 return WIND_ERR_OVERRUN
;
504 * Calculate the length of from converting a UCS2 string to an UTF-8 string.
506 * @param in an UCS2 string to convert.
507 * @param in_len an UCS2 string length to convert.
508 * @param out_len the length of the resulting UTF-8 string.
510 * @return returns 0 on success, an wind error code otherwise
515 wind_ucs2utf8_length(const uint16_t *in
, size_t in_len
, size_t *out_len
)
517 return wind_ucs2utf8(in
, in_len
, NULL
, out_len
);