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

/*
Copyright (C) 2016-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 DK4STRMU_H_INCLUDED
/** Avoid multiple inclusions. */
#define DK4STRMU_H_INCLUDED 1


#line 8 "dk4strmu.ctr"

/**	@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



#endif