citrus_utf8.c revision 252583 
1/* $FreeBSD: head/lib/libiconv_modules/UTF8/citrus_utf8.c 252583 2013-07-03 18:27:45Z peter $ */
2/*	$NetBSD: citrus_utf8.c,v 1.17 2008/06/14 16:01:08 tnozaki Exp $	*/
3
4/*-
5 * Copyright (c)2002 Citrus Project,
6 * All rights reserved.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
10 * are met:
11 * 1. Redistributions of source code must retain the above copyright
12 *    notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 *    notice, this list of conditions and the following disclaimer in the
15 *    documentation and/or other materials provided with the distribution.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 * SUCH DAMAGE.
28 */
29
30/*-
31 * Copyright (c) 1993
32 *	The Regents of the University of California.  All rights reserved.
33 *
34 * This code is derived from software contributed to Berkeley by
35 * Paul Borman at Krystal Technologies.
36 *
37 * Redistribution and use in source and binary forms, with or without
38 * modification, are permitted provided that the following conditions
39 * are met:
40 * 1. Redistributions of source code must retain the above copyright
41 *    notice, this list of conditions and the following disclaimer.
42 * 2. Redistributions in binary form must reproduce the above copyright
43 *    notice, this list of conditions and the following disclaimer in the
44 *    documentation and/or other materials provided with the distribution.
45 * 3. Neither the name of the University nor the names of its contributors
46 *    may be used to endorse or promote products derived from this software
47 *    without specific prior written permission.
48 *
49 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
50 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
51 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
52 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
53 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
54 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
55 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
56 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
57 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
58 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
59 * SUCH DAMAGE.
60 */
61
62#include <sys/cdefs.h>
63#include <sys/types.h>
64
65#include <assert.h>
66#include <errno.h>
67#include <limits.h>
68#include <stdbool.h>
69#include <stddef.h>
70#include <stdio.h>
71#include <stdlib.h>
72#include <string.h>
73#include <wchar.h>
74
75#include "citrus_namespace.h"
76#include "citrus_types.h"
77#include "citrus_module.h"
78#include "citrus_stdenc.h"
79#include "citrus_utf8.h"
80
81
82/* ----------------------------------------------------------------------
83 * private stuffs used by templates
84 */
85
86static uint8_t _UTF8_count_array[256] = {
87	1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,	/* 00 - 0F */
88	1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,	/* 10 - 1F */
89	1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,	/* 20 - 2F */
90	1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,	/* 30 - 3F */
91	1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,	/* 40 - 4F */
92	1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,	/* 50 - 5F */
93	1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,	/* 60 - 6F */
94	1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,	/* 70 - 7F */
95	0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,	/* 80 - 8F */
96	0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,	/* 90 - 9F */
97	0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,	/* A0 - AF */
98	0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,	/* B0 - BF */
99	2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2,	/* C0 - CF */
100	2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2,	/* D0 - DF */
101	3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3,	/* E0 - EF */
102	4, 4, 4, 4, 4, 4, 4, 4, 5, 5, 5, 5, 6, 6, 0, 0	/* F0 - FF */
103};
104
105static uint8_t const *_UTF8_count = _UTF8_count_array;
106
107static const uint32_t _UTF8_range[] = {
108	0,	/*dummy*/
109	0x00000000, 0x00000080, 0x00000800, 0x00010000,
110	0x00200000, 0x04000000, 0x80000000,
111};
112
113typedef struct {
114	int	 chlen;
115	char	 ch[6];
116} _UTF8State;
117
118typedef void *_UTF8EncodingInfo;
119
120#define _CEI_TO_EI(_cei_)		(&(_cei_)->ei)
121#define _CEI_TO_STATE(_ei_, _func_)	(_ei_)->states.s_##_func_
122
123#define _FUNCNAME(m)			_citrus_UTF8_##m
124#define _ENCODING_INFO			_UTF8EncodingInfo
125#define _ENCODING_STATE			_UTF8State
126#define _ENCODING_MB_CUR_MAX(_ei_)	6
127#define _ENCODING_IS_STATE_DEPENDENT	0
128#define _STATE_NEEDS_EXPLICIT_INIT(_ps_)	0
129
130static size_t
131_UTF8_findlen(wchar_t v)
132{
133	size_t i;
134	uint32_t c;
135
136	c = (uint32_t)v;	/*XXX*/
137	for (i = 1; i < sizeof(_UTF8_range) / sizeof(_UTF8_range[0]) - 1; i++)
138		if (c >= _UTF8_range[i] && c < _UTF8_range[i + 1])
139			return (i);
140
141	return (-1);	/*out of range*/
142}
143
144static __inline bool
145_UTF8_surrogate(wchar_t wc)
146{
147
148	return (wc >= 0xd800 && wc <= 0xdfff);
149}
150
151static __inline void
152/*ARGSUSED*/
153_citrus_UTF8_init_state(_UTF8EncodingInfo *ei __unused, _UTF8State *s)
154{
155
156	s->chlen = 0;
157}
158
159static __inline void
160/*ARGSUSED*/
161_citrus_UTF8_pack_state(_UTF8EncodingInfo *ei __unused, void *pspriv,
162    const _UTF8State *s)
163{
164
165	memcpy(pspriv, (const void *)s, sizeof(*s));
166}
167
168static __inline void
169/*ARGSUSED*/
170_citrus_UTF8_unpack_state(_UTF8EncodingInfo *ei __unused, _UTF8State *s,
171    const void *pspriv)
172{
173
174	memcpy((void *)s, pspriv, sizeof(*s));
175}
176
177static int
178_citrus_UTF8_mbrtowc_priv(_UTF8EncodingInfo *ei, wchar_t *pwc, const char **s,
179    size_t n, _UTF8State *psenc, size_t *nresult)
180{
181	const char *s0;
182	wchar_t wchar;
183	int i;
184	uint8_t c;
185
186	s0 = *s;
187
188	if (s0 == NULL) {
189		_citrus_UTF8_init_state(ei, psenc);
190		*nresult = 0; /* state independent */
191		return (0);
192	}
193
194	/* make sure we have the first byte in the buffer */
195	if (psenc->chlen == 0) {
196		if (n-- < 1)
197			goto restart;
198		psenc->ch[psenc->chlen++] = *s0++;
199	}
200
201	c = _UTF8_count[psenc->ch[0] & 0xff];
202	if (c < 1 || c < psenc->chlen)
203		goto ilseq;
204
205	if (c == 1)
206		wchar = psenc->ch[0] & 0xff;
207	else {
208		while (psenc->chlen < c) {
209			if (n-- < 1)
210				goto restart;
211			psenc->ch[psenc->chlen++] = *s0++;
212		}
213		wchar = psenc->ch[0] & (0x7f >> c);
214		for (i = 1; i < c; i++) {
215			if ((psenc->ch[i] & 0xc0) != 0x80)
216				goto ilseq;
217			wchar <<= 6;
218			wchar |= (psenc->ch[i] & 0x3f);
219		}
220		if (_UTF8_surrogate(wchar) || _UTF8_findlen(wchar) != c)
221			goto ilseq;
222	}
223	if (pwc != NULL)
224		*pwc = wchar;
225	*nresult = (wchar == 0) ? 0 : s0 - *s;
226	*s = s0;
227	psenc->chlen = 0;
228
229	return (0);
230
231ilseq:
232	*nresult = (size_t)-1;
233	return (EILSEQ);
234
235restart:
236	*s = s0;
237	*nresult = (size_t)-2;
238	return (0);
239}
240
241static int
242_citrus_UTF8_wcrtomb_priv(_UTF8EncodingInfo *ei __unused, char *s, size_t n,
243    wchar_t wc, _UTF8State *psenc __unused, size_t *nresult)
244{
245	wchar_t c;
246	size_t cnt;
247	int i, ret;
248
249	if (_UTF8_surrogate(wc)) {
250		ret = EILSEQ;
251		goto err;
252	}
253	cnt = _UTF8_findlen(wc);
254	if (cnt <= 0 || cnt > 6) {
255		/* invalid UCS4 value */
256		ret = EILSEQ;
257		goto err;
258	}
259	if (n < cnt) {
260		/* bound check failure */
261		ret = E2BIG;
262		goto err;
263	}
264
265	c = wc;
266	if (s) {
267		for (i = cnt - 1; i > 0; i--) {
268			s[i] = 0x80 | (c & 0x3f);
269			c >>= 6;
270		}
271		s[0] = c;
272		if (cnt == 1)
273			s[0] &= 0x7f;
274		else {
275			s[0] &= (0x7f >> cnt);
276			s[0] |= ((0xff00 >> cnt) & 0xff);
277		}
278	}
279
280	*nresult = (size_t)cnt;
281	return (0);
282
283err:
284	*nresult = (size_t)-1;
285	return (ret);
286}
287
288static __inline int
289/*ARGSUSED*/
290_citrus_UTF8_stdenc_wctocs(_UTF8EncodingInfo * __restrict ei __unused,
291    _csid_t * __restrict csid, _index_t * __restrict idx,
292    wchar_t wc)
293{
294
295	*csid = 0;
296	*idx = (_citrus_index_t)wc;
297
298	return (0);
299}
300
301static __inline int
302/*ARGSUSED*/
303_citrus_UTF8_stdenc_cstowc(_UTF8EncodingInfo * __restrict ei __unused,
304    wchar_t * __restrict wc, _csid_t csid, _index_t idx)
305{
306
307	if (csid != 0)
308		return (EILSEQ);
309
310	*wc = (wchar_t)idx;
311
312	return (0);
313}
314
315static __inline int
316/*ARGSUSED*/
317_citrus_UTF8_stdenc_get_state_desc_generic(_UTF8EncodingInfo * __restrict ei __unused,
318    _UTF8State * __restrict psenc, int * __restrict rstate)
319{
320
321	*rstate = (psenc->chlen == 0) ? _STDENC_SDGEN_INITIAL :
322	    _STDENC_SDGEN_INCOMPLETE_CHAR;
323	return (0);
324}
325
326static int
327/*ARGSUSED*/
328_citrus_UTF8_encoding_module_init(_UTF8EncodingInfo * __restrict ei __unused,
329    const void * __restrict var __unused, size_t lenvar __unused)
330{
331
332	return (0);
333}
334
335static void
336/*ARGSUSED*/
337_citrus_UTF8_encoding_module_uninit(_UTF8EncodingInfo *ei __unused)
338{
339
340}
341
342/* ----------------------------------------------------------------------
343 * public interface for stdenc
344 */
345
346_CITRUS_STDENC_DECLS(UTF8);
347_CITRUS_STDENC_DEF_OPS(UTF8);
348
349#include "citrus_stdenc_template.h"
350