summaryrefslogtreecommitdiff
path: root/support/dktools/dk4strmu.ctr
blob: 8b2d38ec1ed3392f472ecdd0a97f9129fe682c2e (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
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
%%	options

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

%%	header

/**	@file	dk4strmu.h	Unserialize data from stream.
*/

#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	DK4STRM_H_INCLUDED
#include <dk4strm.h>
#endif


#ifdef	__cplusplus
extern "C" {
#endif


/**	Retrieve 32 bit unsigned value from stream.
	@param	ptr		Address of result variable.
	@param	strm	Data stream to read from.
	@param	erp		Error report, may be NULL.
	@return	1 on success, 0 on error.

	Error codes:
	- DK4_E_INVALID_ARGUMENTS<br>
	  if ptr is NULL or strm is NULL or not opened for reading,
	- DK4_E_SYNTAX<br>
	  if the end of data stream was reached before reading 4 bytes,
	- DK4_E_NOT_FOUND<br>
	  if not further data was found (EOF reached),
	- DK4_E_READ_FAILED<br>
	  if a read attempt failed for other reasons.
*/

int
dk4stream_unser_u32(uint32_t *ptr, dk4_stream_t *strm, dk4_er_t *erp);


/**	Retrieve 32 bit signed value from stream.
	@param	ptr		Address of result variable.
	@param	strm	Data stream to read from.
	@param	erp		Error report, may be NULL.
	@return	1 on success, 0 on error.

	Error codes:
	- DK4_E_INVALID_ARGUMENTS<br>
	  if ptr is NULL or strm is NULL or not opened for reading,
	- DK4_E_SYNTAX<br>
	  if the end of data stream was reached before reading 4 bytes,
	- DK4_E_NOT_FOUND<br>
	  if not further data was found (EOF reached),
	- DK4_E_READ_FAILED<br>
	  if a read attempt failed for other reasons.
*/

int
dk4stream_unser_i32(int32_t *ptr, dk4_stream_t *strm, dk4_er_t *erp);


/**	Retrieve 16 bit unsigned value from stream.
	@param	ptr		Address of result variable.
	@param	strm	Data stream to read from.
	@param	erp		Error report, may be NULL.
	@return	1 on success, 0 on error.

	Error codes:
	- DK4_E_INVALID_ARGUMENTS<br>
	  if ptr is NULL or strm is NULL or not opened for reading,
	- DK4_E_SYNTAX<br>
	  if the end of data stream was reached before reading 2 bytes,
	- DK4_E_NOT_FOUND<br>
	  if not further data was found (EOF reached),
	- DK4_E_READ_FAILED<br>
	  if a read attempt failed for other reasons.
*/

int
dk4stream_unser_u16(uint16_t *ptr, dk4_stream_t *strm, dk4_er_t *erp);


/**	Retrieve 16 bit signed value from stream.
	@param	ptr		Address of result variable.
	@param	strm	Data stream to read from.
	@param	erp		Error report, may be NULL.
	@return	1 on success, 0 on error.

	Error codes:
	- DK4_E_INVALID_ARGUMENTS<br>
	  if ptr is NULL or strm is NULL or not opened for reading,
	- DK4_E_SYNTAX<br>
	  if the end of data stream was reached before reading 2 bytes,
	- DK4_E_NOT_FOUND<br>
	  if not further data was found (EOF reached),
	- DK4_E_READ_FAILED<br>
	  if a read attempt failed for other reasons.
*/

int
dk4stream_unser_i16(int16_t *ptr, dk4_stream_t *strm, dk4_er_t *erp);


/**	Retrieve 8 bit unsigned value from stream.
	@param	ptr		Address of result variable.
	@param	strm	Data stream to read from.
	@param	erp		Error report, may be NULL.
	@return	1 on success, 0 on error.

	Error codes:
	- DK4_E_INVALID_ARGUMENTS<br>
	  if ptr is NULL or strm is NULL or not opened for reading,
	- DK4_E_SYNTAX<br>
	  if the end of data stream was reached before reading 1 byte,
	- DK4_E_NOT_FOUND<br>
	  if not further data was found (EOF reached),
	- DK4_E_READ_FAILED<br>
	  if a read attempt failed for other reasons.
*/

int
dk4stream_unser_u8(uint8_t *ptr, dk4_stream_t *strm, dk4_er_t *erp);


/**	Retrieve 8 bit signed value from stream.
	@param	ptr		Address of result variable.
	@param	strm	Data stream to read from.
	@param	erp		Error report, may be NULL.
	@return	1 on success, 0 on error.

	Error codes:
	- DK4_E_INVALID_ARGUMENTS<br>
	  if ptr is NULL or strm is NULL or not opened for reading,
	- DK4_E_SYNTAX<br>
	  if the end of data stream was reached before reading 1 byte,
	- DK4_E_NOT_FOUND<br>
	  if not further data was found (EOF reached),
	- DK4_E_READ_FAILED<br>
	  if a read attempt failed for other reasons.
*/

int
dk4stream_unser_i8(int8_t *ptr, dk4_stream_t *strm, dk4_er_t *erp);


/**	Retrieve string from stream.
	The variable strptr points to should be initialized to NULL.
	On success (string found) this variable is set to dynamically allocated
	memory. Use dk4mem_release() or dk4mem_free() to release that
	memory after use.
	The function sets the destination pointer variable to NULL and reports
	success if a leading string length 0 was found.
	@param	strptr	Address of pointer variable.
	@param	strm	Data stream to read from.
	@param	erp		Error report, may be NULL.
	@return	1 on success, 0 on error.

	Error codes:
	- DK4_E_INVALID_ARGUMENTS<br>
	  if strptr is NULL or strm is NULL or not opened for reading,
	- DK4_E_SYNTAX<br>
	  on unexpected end of data stream or when missing the finalizing
	  0x00 byte on end of string,
	- DK4_E_NOT_FOUND<br>
	  if EOF was reached,
	- DK4_E_MEMORY_ALLOCATION_FAILED<br>
	  with mem.elsize and mem.nelem
	  set if there is not enough memory available.
	- DK4_E_READ_FAILED<br>
	  if a read attempt failed for other reasons.
*/

int
dk4stream_unser_string(char **strptr, dk4_stream_t *strm, dk4_er_t *erp);


/**	Retrieve double value from stream.
	@param	ptr		Address of result variable.
	@param	strm	Data stream to read from.
	@param	erp		Error report, may be NULL.
	@return	1 on success, 0 on error.

	Error codes:
	- DK4_E_INVALID_ARGUMENTS<br>
	  if ptr is NULL or strm is NULL or not opened for reading,
	- DK4_E_SYNTAX<br>
	  on
	  	- unexpected end of data stream
		- or when missing the finalizing 0x00 byte on end of string
		- or when the string is too long
		- or when the string does not contain a double number,
	- DK4_E_NOT_FOUND<br>
	  if not further data was found (EOF reached),
	- DK4_E_READ_FAILED<br>
	  if a read attempt failed for other reasons.
*/

int
dk4stream_unser_double(double *ptr, dk4_stream_t *strm, dk4_er_t *erp);


#ifdef	__cplusplus
}
#endif


%%	module

#include "dk4conf.h"
#include "dk4strmu.h"
#include "dk4mai8dbl.h"
#include "dk4mem.h"


int
dk4stream_unser_u32(uint32_t *ptr, dk4_stream_t *strm, dk4_er_t *erp)
{
	unsigned char	buf[8];
	size_t			sz		= 4;
	unsigned long	res		= 0UL;
	int				back	= 0;

	if ((NULL != ptr) && (NULL != strm)) {
		if (0 < dk4stream_read(buf, &sz, strm, erp)) {
			if (4 == sz) {
				res =
				(
					( (unsigned long)(buf[0]))        & 0x000000FFUL
				)
				| (
					(((unsigned long)(buf[1])) <<  8) & 0x0000FF00UL
				)
				| (
					(((unsigned long)(buf[2])) << 16) & 0x00FF0000UL
				)
				| (
					(((unsigned long)(buf[3])) << 24) & 0xFF000000UL
				);
				*ptr = (uint32_t)res;
				back = 1;
			}
			else {
				dk4error_set_simple_error_code(erp, DK4_E_SYNTAX);
			}
		}
		else {
			/* ERROR: Read failed, already reported */
		}
	}
	else {
		dk4error_set_simple_error_code(erp, DK4_E_INVALID_ARGUMENTS);
	}
	return back;
}



int
dk4stream_unser_i32(int32_t *ptr, dk4_stream_t *strm, dk4_er_t *erp)
{
	uint32_t		res	= 0UL;
	int				back	= 0;

	if (NULL != ptr) {
		back = dk4stream_unser_u32(&res, strm, erp);
		if (0 < back) {
			*ptr = (int32_t)res;
		}
	}
	else {
		dk4error_set_simple_error_code(erp, DK4_E_INVALID_ARGUMENTS);
	}
	return back;
}




int
dk4stream_unser_u16(uint16_t *ptr, dk4_stream_t *strm, dk4_er_t *erp)
{
	unsigned char	buf[8];
	size_t			sz		= 2;
	unsigned 		res		= 0U;
	int				back	= 0;

	if ((NULL != ptr) && (NULL != strm)) {
		if (0 < dk4stream_read(buf, &sz, strm, erp)) {
			if (2 == sz) {
				res =
				(
					( (unsigned)(buf[0]))        & 0x00FFU
				)
				| (
					(((unsigned)(buf[1])) <<  8) & 0xFF00U
				);
				*ptr = (uint16_t)res;
				back = 1;
			}
			else {
				dk4error_set_simple_error_code(erp, DK4_E_SYNTAX);
			}
		}
		else {
			/* ERROR: Read failed, already reported */
		}
	}
	else {
		dk4error_set_simple_error_code(erp, DK4_E_INVALID_ARGUMENTS);
	}
	return back;
}



int
dk4stream_unser_i16(int16_t *ptr, dk4_stream_t *strm, dk4_er_t *erp)
{
	uint16_t		res	= 0UL;
	int				back	= 0;

	if (NULL != ptr) {
		back = dk4stream_unser_u16(&res, strm, erp);
		if (0 < back) {
			*ptr = (int16_t)res;
		}
	}
	else {
		dk4error_set_simple_error_code(erp, DK4_E_INVALID_ARGUMENTS);
	}
	return back;
}



int
dk4stream_unser_u8(uint8_t *ptr, dk4_stream_t *strm, dk4_er_t *erp)
{
	unsigned char	buf[8];
	size_t			sz		= 1;
	int				back	= 0;

	if ((NULL != ptr) && (NULL != strm)) {
		if (0 < dk4stream_read(buf, &sz, strm, erp)) {
			if (1 == sz) {
				*ptr = (uint8_t)(buf[0]);
				back = 1;
			}
			else {
				dk4error_set_simple_error_code(erp, DK4_E_SYNTAX);
			}
		}
		else {
			/* ERROR: Read failed, already reported */
		}
	}
	else {
		dk4error_set_simple_error_code(erp, DK4_E_INVALID_ARGUMENTS);
	}
	return back;
}



int
dk4stream_unser_i8(int8_t *ptr, dk4_stream_t *strm, dk4_er_t *erp)
{
	uint8_t		res	= 0UL;
	int			back	= 0;

	if (NULL != ptr) {
		back = dk4stream_unser_u8(&res, strm, erp);
		if (0 < back) {
			*ptr = (int8_t)res;
		}
	}
	else {
		dk4error_set_simple_error_code(erp, DK4_E_INVALID_ARGUMENTS);
	}
	return back;
}



int
dk4stream_unser_string(char **strptr, dk4_stream_t *strm, dk4_er_t *erp)
{
	char		*np		= NULL;
	size_t		 sz		= 0;
	int			 back	= 0;
	int			 res	= 0;
	uint16_t	 sl		= 0;

	if ((NULL != strptr) && (NULL != strm)) {
		res = dk4stream_unser_u16(&sl, strm, erp);
		if (0 < res) {
			if (0U < sl) {
				np = dk4mem_new(char, (size_t)sl, erp);
				if (NULL != np) {
					sz = (size_t)sl;
					back = dk4stream_read(np, &sz, strm, erp);
					if (0 < back) {
						back = 0;
						if (sz == (size_t)sl) {
							if ('\0' == np[sz - 1]) {
								back = 1;
							}
							else {
								/* ERROR: Missing delimiter */
								dk4error_set_simple_error_code(
									erp, DK4_E_SYNTAX
								);
								dk4mem_free(np);
								np = NULL;
							}
						}
						else {
							/* ERROR: Wrong number of bytes */
							dk4error_set_simple_error_code(erp, DK4_E_SYNTAX);
							dk4mem_free(np);
							np = NULL;
						}
					}
					else {
						/* ERROR: Read attempt failed */
						dk4error_set_simple_error_code(erp, DK4_E_SYNTAX);
						dk4mem_free(np);
						np = NULL;
					}
				}
				else {
					/* ERROR: Memory, already reported */
				}
			}
			else {
				/* ERROR: Length is zero */
				back = 1;
#if 0
				dk4error_set_simple_error_code(erp, DK4_E_NOT_FOUND);
#endif
			}
		}
		else {
			/* ERROR: Failed to read string length, already reported */
		}
	}
	else {
		dk4error_set_simple_error_code(erp, DK4_E_INVALID_ARGUMENTS);
	}
	if (NULL != strptr) {
		*strptr = np;
	}
	return back;
}



int
dk4stream_unser_double(double *ptr, dk4_stream_t *strm, dk4_er_t *erp)
{
	char		 buf[16*sizeof(double)];
	const char	*ep		= NULL;
	double		 d		= 0.0;
	size_t		 szb	= sizeof(buf);
	size_t		 sz		= 0;
	int			 back	= 0;
	uint16_t	 sl		= 0;

	if ((NULL != ptr) && (NULL != strm)) {
		if (0 < dk4stream_unser_u16(&sl, strm, erp)) {
			if (0U == sl) {
				/* Easy variant for 0.0 */
				*ptr = 0.0;
				back = 1;
			}
			else {
				if (szb >= (size_t)sl) {
					sz = (size_t)sl;
					if (0 < dk4stream_read(buf, &sz, strm, erp)) {
						if (sz == (size_t)sl) {
							if ('\0' == buf[sz - 1]) {
								back = dk4ma_input_c8_double(
									&d, buf, &ep, 0, erp
								);
								if (0 < back) {
									*ptr = d;
								}
								else {
									/* ERROR: Conversion failed, reported */
								}
							}
							else {
								/* ERROR: Not 0x00-terminated */
								dk4error_set_simple_error_code(
									erp, DK4_E_SYNTAX
								);
							}
						}
						else {
							/* ERROR: Too few bytes */
							dk4error_set_simple_error_code(erp, DK4_E_SYNTAX);
						}
					}
					else {
						/* ERROR: Failed to read */
						dk4error_set_simple_error_code(erp, DK4_E_SYNTAX);
					}
				}
				else {
					/* ERROR: String too long */
					dk4error_set_simple_error_code(erp, DK4_E_SYNTAX);
				}
			}
		}
		else {
			/* ERROR: Failed to read length, already reported */
		}
	}
	else {
		dk4error_set_simple_error_code(erp, DK4_E_INVALID_ARGUMENTS);
	}
	return back;
}



/* vim: set ai sw=4 ts=4 : */