summaryrefslogtreecommitdiff
path: root/support/dktools/dk4utf8.h
blob: fd25dba758bbb3b7ddcb533c3a5289813f8bf386 (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
/*
Copyright (C) 2015-2020, Dirk Krause
SPDX-License-Identifier: BSD-3-Clause
*/

/*
	WARNING: This file was generated by the dkct program (see
	http://dktools.sourceforge.net/ for details).
	Changes you make here will be lost if dkct is run again!
	You should modify the original source and run dkct on it.
	Original source: dk4utf8.ctr
*/

#ifndef DK4UTF8_H_INCLUDED
/** Avoid multiple inclusions. */
#define DK4UTF8_H_INCLUDED 1


#line 10 "dk4utf8.ctr"

/**	@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
#if DK4_BUILDING_DKTOOLS4
#include "dk4conf.h"
#else
#include <dktools-4/dk4conf.h>
#endif
#endif

#ifndef DK4TYPES_H_INCLUDED
#if DK4_BUILDING_DKTOOLS4
#include "dk4types.h"
#else
#include <dktools-4/dk4types.h>
#endif
#endif

#ifndef DK4ERROR_H_INCLUDED
#if DK4_BUILDING_DKTOOLS4
#include "dk4error.h"
#else
#include <dktools-4/dk4error.h>
#endif
#endif

#ifndef DK4DEC_H_INCLUDED
#if DK4_BUILDING_DKTOOLS4
#include "dk4edstm.h"
#else
#include <dktools-4/dk4edstm.h>
#endif
#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 const *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 const *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




#endif