summaryrefslogtreecommitdiff
path: root/support/dktools/dk4tspdk.h
blob: 50a98ccf69a98017921b215dc681024ab4cd99b6 (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
/*
	WARNING: This file was generated by dkct.
	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: dk4tspdk.ctr
*/

/*
Copyright (C) 2015-2017, Dirk Krause

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

* Redistributions of source code must retain the above copyright notice,
  this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above opyright notice,
  this list of conditions and the following disclaimer in the documentation
  and/or other materials provided with the distribution.
* Neither the name of the author nor the names of contributors may be used
  to endorse or promote products derived from this software without specific
  prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS IS''
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED.
IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY
DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/

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


#line 10 "dk4tspdk.ctr"

/**	@file
	Text stream processing for dkChar characters.

	CRT on Windows: Optional.
*/

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

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

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

#if DK4_CHAR_SIZE > 1
#if DK4_CHAR_SIZE > 2
/* +++++ dkChar 4 bytes */

#ifndef DK4TSP32_H_INCLUDED
#include "dk4tsp32.h"
#endif

/**	Handler function to process a single character.
*/
typedef	dk4_c32_handler_t	dk4_dk_handler_t;

/**	Handler function to process an input line.
*/
typedef	dk4_c32_line_handler_t	dk4_dk_line_handler_t;

/**	Text stream processor.
*/
typedef	dk4_tsp32_t		dk4_tspdk_t;

/* ----- dkChar 4 bytes */
#else
/* +++++ dkChar 2 bytes */

#ifndef DK4TSP16_H_INCLUDED
#include "dk4tsp16.h"
#endif

/**	Handler function to process a single character.
*/
typedef	dk4_c16_handler_t	dk4_dk_handler_t;

/**	Handler function to process an input line.
*/
typedef	dk4_c16_line_handler_t	dk4_dk_line_handler_t;

/**	Text stream processor.
*/
typedef	dk4_tsp16_t		dk4_tspdk_t;

/* ----- dkChar 2 bytes */
#endif
#else
/* +++++ dkChar 1 byte */

#ifndef DK4TSP08_H_INCLUDED
#include "dk4tsp08.h"
#endif

/**	Handler function to process a single character.
*/
typedef	dk4_c8_handler_t	dk4_dk_handler_t;

/**	Handler function to process an input line.
*/
typedef	dk4_c8_line_handler_t	dk4_dk_line_handler_t;

/**	Text stream processor.
*/
typedef	dk4_tsp08_t		dk4_tspdk_t;

/* ----- dkChar 1 byte */
#endif



#ifdef __cplusplus
extern "C" {
#endif

/**	Set up processor for char by char processing.
	@param	tsp	Processor to set up.
	@param	obj	Object to modify when processing input, may be NULL.
	@param	fct	Handler function to call for each character.
	@param	pre	Encoding required for processing.
	@param	eie	Expected input encoding.
	@param	erp	Error report, may be NULL.
	@return	1 on success, 0 on error.
*/
int
dk4tspdk_setup_char(
  dk4_tspdk_t		*tsp,
  void			*obj,
  dk4_dk_handler_t	*fct,
  int			 pre,
  int			 eie,
  dk4_er_t		*erp
);

/**	Set up processor for line processing.
	@param	tsp	Processor to set up.
	@param	obj	Object to modify when processing input, may be NULL.
	@param	fct	Handler function to invoke for each line.
	@param	inbuf	Input line buffer.
	@param	szin	Size of input line buffer.
	@param	pre	Encoding required for processing.
	@param	eie	Expected input encoding.
	@param	erp	Error report, may be NULL.
	@return	1 on success, 0 on error.
*/
int
dk4tspdk_setup_line(
  dk4_tspdk_t		*tsp,
  void			*obj,
  dk4_dk_line_handler_t	*fct,
  dkChar		*inbuf,
  size_t		 szin,
  int			 pre,
  int			 eie,
  dk4_er_t		*erp
);

/**	Allow pass-through of UTF-8 encoded data.
	@param	tsp	Text stream processor to set up.
	@param	fl	Flag: Enable pass-through of UTF-8 encoded data.
*/
void
dk4tspdk_enable_utf8_pass_through(dk4_tspdk_t *tsp, int fl);

/**	Add one single byte.
	@param	tsp	Text stream processor.
	@param	inbyte	Byte to process.
	@return	DK4_TSP_RES_OK		if the character was processed
					successfully,
		DK4_TSP_RES_ERROR	if there was an error but we can
					continue,
		DK4_TSP_RES_FATAL	if there was a fatal error so we
					should abort processing.
*/
int
dk4tspdk_add_one_byte(
  dk4_tspdk_t	*tsp,
  unsigned char	 inbyte
);

/**	Add multiple bytes.
	@param	tsp	Text stream processor.
	@param	buffer	Buffer start address.
	@param	sz	Number of bytes in buffer.
	@return	DK4_TSP_RES_OK		if the character was processed
					successfully,
		DK4_TSP_RES_ERROR	if there was an error but we can
					continue,
		DK4_TSP_RES_FATAL	if there was a fatal error so we
					should abort processing.
*/
int
dk4tspdk_add_bytes(
  dk4_tspdk_t		*tsp,
  const unsigned char	*buffer,
  size_t		 sz
);

/**	Finish processing.
	@param	tsp	Text stream processor.
	@return	DK4_TSP_RES_OK		if processing was finished
					successfully,
		DK4_TSP_RES_ERROR	if there was an error,
		DK4_TSP_RES_FATAL	if there was a fatal error.
*/
int
dk4tspdk_finish(dk4_tspdk_t *tsp);

/**	Retrieve error reports for encoding/decoding and processing.
	@param	er_en	Destination error report buffer for encoding/decoding.
	@param	er_pr	Destination error report buffer for processing.
	@param	tsp	Text stream processor to retrieve errors from.
*/
void
dk4tspdk_get_errors(dk4_er_t *er_en, dk4_er_t *er_pr, dk4_tspdk_t *tsp);

#ifdef __cplusplus
}
#endif


#endif