summaryrefslogtreecommitdiff
path: root/support/dktools/dk4utf8.ctr
blob: e487d239fe5e53791f8066e33b4f1ff8439b19cc (plain)
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
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
%%	options

copyright owner	=	Dirk Krause
copyright year	=	2015-xxxx
license		=	bsd



%%	header

/**	@file
	UTF-8 decoding and encoding.

To decode an UTF-8 encoded data stream, use a dk4_utf8_decoder_t object.
Use dk4utf8_init() to initialize the object before you start decoding.
For each byte from the data stream use dk4utf8_add(). Possible
return values are DK4_EDSTM_ACCEPT, DK4_EDSTM_FINISHED,
and DK4_EDSTM_ERROR.
DK4_EDSTM_ACCEPT indicates the byte was processed successfully,
but more bytes are required to complete the UNICODE character.
DK4_EDSTM_FINISHED indicates an UNICODE character was completed,
use dk4utf8_get() to retrieve it.
DK4_EDSTM_ERROR indicates an error, invalid input.

The older RFC2279 allows a wider range of UNICODE characters,
RFC3629 restricts the UNICODE character range to 0x0010FFFF.
Routines in this module use the range defined by RFC2279.
To be RFC3629 compliant, check UNICODE values and make sure
to use the range 0...0x0010FFFF only.

CRT on Windows: Not used.
*/


#ifndef DK4CONF_H_INCLUDED
#include "dk4conf.h"
#endif

#ifndef DK4TYPES_H_INCLUDED
#include "dk4types.h"
#endif

#ifndef DK4ERROR_H_INCLUDED
#include "dk4error.h"
#endif

#ifndef DK4DEC_H_INCLUDED
#include "dk4edstm.h"
#endif


/**	State machine to decode UTF-8 encoded data byte by byte.
*/
typedef struct {
  dk4_c32_t	uc;	/**< Unicode character to produce. */
  int		bfc;	/**< Bytes needed for character. */
  int		bfn;	/**< Bytes already found. */
} dk4_utf8_decoder_t;



#ifdef __cplusplus
extern "C" {
#endif

/**	Initialize the UTF-8 decoder.
	@param	ptr	Decoder to initialize.
*/
void
dk4utf8_init(dk4_utf8_decoder_t *ptr);

/**	Add one byte to the decoder.
	@param	ptr	Decoder to use.
	@param	byte	Byte to add.
	@return Operation result, one from:
	DK4_EDSTM_ACCEPT if the byte was added to the next output
	without completing output,
	DK4_EDSTM_FINISHED  if the byte was added to the next output
	completing the output, or
	DK4_EDSTM_ERROR on error.
*/
int
dk4utf8_add(dk4_utf8_decoder_t *ptr, unsigned char byte);

/**	Retrieve a completed Unicode character from the decoder.
	@param	ptr	Decoder to obtain character from.
*/
dk4_c32_t
dk4utf8_get(dk4_utf8_decoder_t *ptr);

/**	Check whether the decoder is empty.
	@param	ptr	Decoder to check.
	@return	1 on success, 0 on error.
*/
int
dk4utf8_is_empty(dk4_utf8_decoder_t *ptr);

/**	UTF-8 encode UNICODE character.
	@param	rb	Result buffer, at least 7 bytes.
	@param	pszrb	Size of result buffer, in: available, out: used.
	@param	c	Character to encode.
	@param	erp	Error report, may be NULL.
	@return	1 on success, 0 on error.
	
	Error codes:
	- DK4_E_INVALID_ARGUMENTS<br>
	  if rb or pszrb is NULL,
	- DK4_E_BUFFER_TOO_SMALL<br>
	  if the size specified in pszrb is less than 7.
*/
int
dk4utf8_encode(unsigned char *rb, size_t *pszrb, dk4_c32_t c, dk4_er_t *erp);

#ifdef __cplusplus
}
#endif



%%	module

#include "dk4conf.h"
#include "dk4types.h"
#include "dk4error.h"
#include "dk4utf8.h"



$!trace-include



void
dk4utf8_init(dk4_utf8_decoder_t *ptr)
{
  if (NULL != ptr) {
    ptr->uc  = dkC32(0);
    ptr->bfc = 0;
    ptr->bfn = 0;
  }
}



int
dk4utf8_add(dk4_utf8_decoder_t *ptr, unsigned char byte)
{
  int		back	=	DK4_EDSTM_ERROR;

  if (NULL != ptr) {
    switch (ptr->bfc) {
      case 0: {
        if (0x7F < byte) {				/* more than 1 byte */
          if ((0xE0 & byte) == 0xC0) {			/* 2 bytes */
	    ptr->uc = (((dk4_c32_t)byte) << 6) & dkC32(0x000007C0);
	    ptr->bfc = 2;
	    ptr->bfn = 1;
	    back = DK4_EDSTM_ACCEPT;
	  } else {
	    if ((0xF0 & byte) == 0xE0) {			/* 3 bytes */
	      ptr->uc = (((dk4_c32_t)byte) << 12) & dkC32(0x0000F000);
	      ptr->bfc = 3;
	      ptr->bfn = 1;
	      back = DK4_EDSTM_ACCEPT;
	    } else {
	      if ((0xF8 & byte) == 0xF0) {		/* 4 bytes */
	        ptr->uc = (((dk4_c32_t)byte) << 18) & dkC32(0x001C0000);
	        ptr->bfc = 4;
	        ptr->bfn = 1;
	        back = DK4_EDSTM_ACCEPT;
	      } else {
	        if ((0xFC & byte) == 0xF8) {		/* 5 bytes */
	          ptr->uc = ((((dk4_c32_t)byte) << 24) & dkC32(0x03000000));
		  ptr->bfc = 5;
		  ptr->bfn = 1;
		  back = DK4_EDSTM_ACCEPT;
	        } else {
	          if ((0xFE & byte) == 0xFC) {		/* 6 bytes */
		    ptr->uc = dkC32(0x40000000);
		    ptr->bfc = 6;
		    ptr->bfn = 1;
		    back = DK4_EDSTM_ACCEPT;
		  } else {
		    /* ERROR: Illegal input! */
		  }
	        }
	      }
	    }
	  }
        } else {			/* just one byte */
          ptr->uc = (dk4_c32_t)byte;
	  ptr->uc &= dkC32(0xFF);
	  back = DK4_EDSTM_FINISHED;
	  ptr->bfn = 0;
        }
      } break;
      case 2: {
        switch (ptr->bfn) {
          case 1: {
	    if ((0xC0 & byte) == 0x80) {
	      back = DK4_EDSTM_FINISHED;
	      ptr->uc |= (((dk4_c32_t)byte) & dkC32(0x0000003F));
	    }
	    ptr->bfc = 0;
	    ptr->bfn = 0;
	  } break;
        }
      } break;
      case 3: {
        switch (ptr->bfn) {
          case 1: {
	    if ((0xC0 & byte) == 0x80) {
	      back = DK4_EDSTM_ACCEPT;
	      ptr->uc |= ((((dk4_c32_t)byte) << 6) & dkC32(0x00000FC0));
	    }
	    ptr->bfn = 2;
	  } break;
	  case 2: {
	    if ((0xC0 & byte) == 0x80) {
	      back = DK4_EDSTM_FINISHED;
	      ptr->uc |= (((dk4_c32_t)byte) & dkC32(0x0000003F));
	    }
	    ptr->bfc = 0;
	    ptr->bfn = 0;
	  } break;
        }
      } break;
      case 4: {
        switch (ptr->bfn) {
          case 1: {
	    if ((0xC0 & byte) == 0x80) {
	      back = DK4_EDSTM_ACCEPT;
	      ptr->uc |= ((((dk4_c32_t)byte) << 12) & dkC32(0x0003F000));
	    }
	    ptr->bfn = 2;
	  } break;
	  case 2: {
	    if ((0xC0 & byte) == 0x80) {
	      back = DK4_EDSTM_ACCEPT;
	      ptr->uc |= ((((dk4_c32_t)byte) << 6) & dkC32(0x00000FC0));
	    }
	    ptr->bfn = 3;
	  } break;
	  case 3: {
	    if ((0xC0 & byte) == 0x80) {
	      back = DK4_EDSTM_FINISHED;
	      ptr->uc |= (((dk4_c32_t)byte) & dkC32(0x0000003F));
	    }
	    ptr->bfc = 0;
	    ptr->bfn = 0;
	  } break;
        }
      } break;
      case 5: {
        switch (ptr->bfn) {
          case 1: {
	    if ((0xC0 & byte) == 0x80) {
	      back = DK4_EDSTM_ACCEPT;
	      ptr->uc |= ((((dk4_c32_t)byte) << 18) & dkC32(0x00FC0000));
	    }
	    ptr->bfn = 2;
	  } break;
	  case 2: {
	    if ((0xC0 & byte) == 0x80) {
	      back = DK4_EDSTM_ACCEPT;
	      ptr->uc |= ((((dk4_c32_t)byte) << 12) & dkC32(0x0003F000));
	    }
	    ptr->bfn = 3;
	  } break;
	  case 3: {
	    if ((0xC0 & byte) == 0x80) {
	      back = DK4_EDSTM_ACCEPT;
	      ptr->uc |= ((((dk4_c32_t)byte) << 6) & dkC32(0x00000FC0));
	    }
	    ptr->bfn = 4;
	  } break;
	  case 4: {
	    if ((0xC0 & byte) == 0x80) {
	      back = DK4_EDSTM_FINISHED;
	      ptr->uc |= (((dk4_c32_t)byte) & dkC32(0x0000003F));
	    }
	    ptr->bfc = 0;
	    ptr->bfn = 0;
	  } break;
        }
      } break;
      case 6: {
        switch (ptr->bfn) {
          case 1: {
	    if ((0xC0 & byte) == 0x80) {
	      back = DK4_EDSTM_ACCEPT;
	      ptr->uc |= ((((dk4_c32_t)byte) << 24) & dkC32(0x3F000000));
	    }
	    ptr->bfn = 2;
	  } break;
	  case 2: {
	    if ((0xC0 & byte) == 0x80) {
	      back = DK4_EDSTM_ACCEPT;
	      ptr->uc |= ((((dk4_c32_t)byte) << 18) & dkC32(0x00FC0000));
	    }
	    ptr->bfn = 3;
	  } break;
	  case 3: {
	    if ((0xC0 & byte) == 0x80) {
	      back = DK4_EDSTM_ACCEPT;
	      ptr->uc |= ((((dk4_c32_t)byte) << 12) & dkC32(0x0003F000));
	    }
	    ptr->bfn = 4;
	  } break;
	  case 4: {
	    if ((0xC0 & byte) == 0x80) {
	      back = DK4_EDSTM_ACCEPT;
	      ptr->uc |= ((((dk4_c32_t)byte) << 6) & dkC32(0x00000FC0));
	    }
	    ptr->bfn = 5;
	  } break;
	  case 5: {
	    if ((0xC0 & byte) == 0x80) {
	      back = DK4_EDSTM_FINISHED;
	      ptr->uc |= (((dk4_c32_t)byte) & dkC32(0x0000003F));
	    }
	    ptr->bfc = 0;
	    ptr->bfn = 0;
	  } break;
        }
      } break;
    }
  }
  return back;
}



dk4_c32_t
dk4utf8_get(dk4_utf8_decoder_t *ptr)
{
  dk4_c32_t	back	=	dkC32(0);
  if (NULL != ptr) {
    back = ptr->uc;
  }
  return back;
}



int
dk4utf8_is_empty(dk4_utf8_decoder_t *ptr)
{
  int	back	=	0;
  if (NULL != ptr) {
    if (0 == ptr->bfc) {
      back = 1;
    }
  }
  return back;
}



int
dk4utf8_encode(unsigned char *rb, size_t *pszrb, dk4_c32_t c, dk4_er_t *erp)
{
  int		back	=	0;
  $? "+ dk4utf8_encode %08lx", (unsigned long)c
  if ((NULL != rb) && (NULL != pszrb)) {
    if (6 < *pszrb) {
      if (dkC32(0x7F) < c) {
	if (dkC32(0x000007FF) < c) {
	  if (dkC32(0x001FFFFF) < c) {
	    if (dkC32(0x03FFFFFF) < c) {
	      if (dkC32(0x80000000) < c) {		/* 6 bytes */
		back = 1;
		*pszrb = 6;
		rb[0] = ((unsigned char)((c >> 30) & dkC32(0x00000001))) | 0xFC;
		rb[1] = ((unsigned char)((c >> 24) & dkC32(0x0000003F))) | 0x80;
		rb[2] = ((unsigned char)((c >> 18) & dkC32(0x0000003F))) | 0x80;
		rb[3] = ((unsigned char)((c >> 12) & dkC32(0x0000003F))) | 0x80;
		rb[4] = ((unsigned char)((c >>  6) & dkC32(0x0000003F))) | 0x80;
		rb[5] = ((unsigned char)( c        & dkC32(0x0000003F))) | 0x80;
		rb[6] = '\0';
	      } else {					/* 5 bytes */
		back = 1;
		*pszrb = 5;
		rb[0] = ((unsigned char)((c >> 24) & dkC32(0x00000003))) | 0xF8;
		rb[1] = ((unsigned char)((c >> 18) & dkC32(0x0000003F))) | 0x80;
		rb[2] = ((unsigned char)((c >> 12) & dkC32(0x0000003F))) | 0x80;
		rb[3] = ((unsigned char)((c >>  6) & dkC32(0x0000003F))) | 0x80;
		rb[4] = ((unsigned char)( c        & dkC32(0x0000003F))) | 0x80;
		rb[5] = '\0';
	      }
	    } else {					/* 4 bytes */
	      back = 1;
	      *pszrb = 4;
	      rb[0] = ((unsigned char)((c >> 18) & dkC32(0x00000007))) | 0xF0;
	      rb[1] = ((unsigned char)((c >> 12) & dkC32(0x0000003F))) | 0x80;
	      rb[2] = ((unsigned char)((c >>  6) & dkC32(0x0000003F))) | 0x80;
	      rb[3] = ((unsigned char)( c        & dkC32(0x0000003F))) | 0x80;
	      rb[4] = '\0';
	    }
	  } else {					/* 3 bytes */
	    back = 1;
	    *pszrb = 3;
	    rb[0] = ((unsigned char)((c >> 12) & dkC32(0x0000000F))) | 0xE0;
	    rb[1] = ((unsigned char)((c >>  6) & dkC32(0x0000003F))) | 0x80;
	    rb[2] = ((unsigned char)( c        & dkC32(0x0000003F))) | 0x80;
	    rb[3] = '\0';
	  }
	} else {					/* 2 bytes */
	  back = 1;
	  *pszrb = 2;
	  rb[0] = ((unsigned char)((c >>  6) & dkC32(0x0000001F))) | 0xC0;
	  rb[1] = ((unsigned char)( c        & dkC32(0x0000003F))) | 0x80;
	  rb[2] = '\0';
	}
      } else {						/* 1 byte */
	back = 1;
	*pszrb = 1;
	rb[0] = (unsigned char)(c & dkC32(0x0000007F));
	rb[1] = '\0';
      }
    } else {
      dk4error_set_simple_error_code(erp, DK4_E_BUFFER_TOO_SMALL);
    }
  } else {
    dk4error_set_simple_error_code(erp, DK4_E_INVALID_ARGUMENTS);
  } $? "- dk4utf8_encode %d", back
  return back;
}