summaryrefslogtreecommitdiff
path: root/support/dktools/dk4tsp08.h
blob: ce0fd15868d3c3cc98fb84f04de4ec0746562b80 (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
/*
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: dk4tsp08.ctr
*/

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


#line 10 "dk4tsp08.ctr"

/**	@file	dk4tsp08.h	Text stream processing for 8 bit characters.

	CRT on Windows: Optional.
*/

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

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

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

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

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

/**	Handler function for single characters.
	@param	obj	Object to modify while processing the character.
	@param	c	Character to process.
	@param	pos	Current position in file or data stream.
	@param	erp	Error report, may be NULL.
	@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.
*/
typedef int	dk4_c8_handler_t(
  void				*obj,
  char	 			 c,
  dk4_text_stream_position_t	*pos,
  dk4_er_t			*erp
);

/**	Handler function for text lines.
	@param	obj	Object to modify while processing the character.
	@param	line	Text line to process.
	@param	lineno	Current line number.
	@param	erp	Error report, may be NULL.
	@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.
*/
typedef int	dk4_c8_line_handler_t(
  void		*obj,
  char		*line,
  dk4_um_t	 lineno,
  dk4_er_t	*erp
);

/**	Structure for 8 bit character processing.
*/
typedef struct {
  union {
    dk4_utf8_decoder_t		 u08;	/**< UTF-8 decoder. */
    dk4_utf16_byte_decoder_t	 u16;	/**< UTF-16 decoder. */
    dk4_c32_byte_decoder_t	 c32;	/**< 32 bit char decoder. */
  } dec;				/**< Input decoder. */
  dk4_bom_detector_t		 bomd;	/**< BOM detector. */
  dk4_text_stream_position_t	 pos;	/**< Current position. */
  dk4_er_t			 er_en;	/**< Errors in input decoding. */
  dk4_er_t			 er_pr;	/**< Errors in processing. */
  union {
    dk4_c8_line_handler_t	*lh;	/**< Handler function for lines. */
    dk4_c8_handler_t		*ch;	/**< Handler function for char. */
  } fct;				/**< Handler function. */
  char				*inbuf;	/**< Buffer for input line. */
  void				*obj;	/**< Object to modify in processing. */
  size_t			 in_sz;	/**< Size of input line buffer. */
  size_t			 in_us;	/**< Used bytes in input line buffer. */
  int				 upt;	/**< Flag: Enable UTF-8 pass through. */
  int				 ief;	/**< Input encoding found. */
  int				 iee;	/**< Input encoding expected. */
  int				 pen;	/**< Encoding for processing. */
  int				 pst;	/**< Processing stage. */
  int				 pth;	/**< Flag: Pass through. */
} dk4_tsp08_t;



#ifdef __cplusplus
extern "C" {
#endif

/**	Set up processor for byte by byte 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.

	Error codes:
	- DK4_E_INVALID_ARGUMENTS<br>
	  if tsp or fct is NULL or pre is not an encoding for 8-bit characters.
*/
int
dk4tsp08_setup_char(
  dk4_tsp08_t		*tsp,
  void			*obj,
  dk4_c8_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.

	Error codes:
	- DK4_E_INVALID_ARGUMENTS<br>
	  if tsp, fct or inbuf is NULL, szin is 0 or pre is not a
	  valid encoding for 8-bit characters.
*/
int
dk4tsp08_setup_line(
  dk4_tsp08_t		*tsp,
  void			*obj,
  dk4_c8_line_handler_t	*fct,
  char			*inbuf,
  size_t		 szin,
  int			 pre,
  int			 eie,
  dk4_er_t		*erp
);

/**	Enable or disable pass-through of UTF-8 encoded data.
	Use this function after dk4tsp08_setup_line() or
	dk4tsp08_setup_char() but before adding the first byte.
	@param	tsp	Text stream processor to configure.
	@param	fl	Flag: Enabled.
*/
void
dk4tsp08_enable_utf8_pass_through(dk4_tsp08_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
dk4tsp08_add_one_byte(
  dk4_tsp08_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
dk4tsp08_add_bytes(
  dk4_tsp08_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
dk4tsp08_finish(dk4_tsp08_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.

	Error codes er_en:
	- DK4_E_BUFFER_TOO_SMALL<br>
	  if the input buffer provided in dk4tsp08_setup_line() is too
	  small,
	- DK4_E_INVALID_ARGUMENTS<br>
	  if no character processing function was provided,
	- DK4_E_DECODING_FAILED<br>
	  if there were decoding errors,
	- DK4_E_ENCODING_FAILED<br>
	  if there were encoding errors.

	Error codes er_pr:
	- The error codes returned in er_pr depend on the processing
	  function.
*/
void
dk4tsp08_get_errors(dk4_er_t *er_en, dk4_er_t *er_pr, dk4_tsp08_t const *tsp);

#ifdef __cplusplus
}
#endif




#endif