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