summaryrefslogtreecommitdiff
path: root/support/dktools/dk4strms.h
blob: 8abd2d428210e93b54ac88e557ae955b48808ba7 (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
/*
Copyright (C) 2016-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: dk4strms.ctr
*/

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


#line 8 "dk4strms.ctr"

/**	@file	dk4strms.h	Serialize data to a stream.

The functions to serialize integers write the least significant byte
first.

When serializing a string, the string length is serialized first as
16 bit unsigned number, string contents follows.
The finalizing 0x00 byte is both counted in the string length and written
to the stream.
So a reader application can retrieve the length first, allocate a memory
block of exact size and read the string. Reader applications should
check/ensure the finalizing byte after reading string contents.

When serializing a double, the double is converted to a string and the
string is serialized to the stream. For 0.0 and values nearby
(absolute value is below a given limit) a string length 0 is serialized
to the stream instead, no string is written.

*/


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


#ifdef	__cplusplus
extern "C" {
#endif



/**	Serialize unsigned 32 bit integer to stream.
	@param	strm	Destination stream.
	@param	u32	Value to serialize.
	@param	erp	Error report, may be NULL.
	@return	1 on success, 0 on error.

	Error codes:
	- DK4_E_INVALID_ARGUMENTS<br>
	  if strm is NULL or not opened for writing,
	- DK4_E_WRITE_FAILED<br>
	  if writing one ore multiple bytes to the stream failed,
	- DK4_E_FLUSH_FAILED<br>
	  if flusing data downwards failed.
*/

int
dk4stream_serialize_u32(dk4_stream_t *strm, uint32_t u32, dk4_er_t *erp);


/**	Serialize signed 32 bit integer to stream.
	@param	strm	Destination stream.
	@param	i32	Value to serialize.
	@param	erp	Error report, may be NULL.
	@return	1 on success, 0 on error.

	Error codes:
	- DK4_E_INVALID_ARGUMENTS<br>
	  if strm is NULL or not opened for writing,
	- DK4_E_WRITE_FAILED<br>
	  if writing one ore multiple bytes to the stream failed,
	- DK4_E_FLUSH_FAILED<br>
	  if flusing data downwards failed.
*/

int
dk4stream_serialize_i32(dk4_stream_t *strm, int32_t i32, dk4_er_t *erp);


/**	Serialize unsigned 16 bit integer to stream.
	@param	strm	Destination stream.
	@param	u16	Value to serialize.
	@param	erp	Error report, may be NULL.
	@return	1 on success, 0 on error.

	Error codes:
	- DK4_E_INVALID_ARGUMENTS<br>
	  if strm is NULL or not opened for writing,
	- DK4_E_WRITE_FAILED<br>
	  if writing one ore multiple bytes to the stream failed,
	- DK4_E_FLUSH_FAILED<br>
	  if flusing data downwards failed.
*/

int
dk4stream_serialize_u16(dk4_stream_t *strm, uint16_t u16, dk4_er_t *erp);


/**	Serialize signed 16 bit integer to stream.
	@param	strm	Destination stream.
	@param	i16	Value to serialize.
	@param	erp	Error report, may be NULL.
	@return	1 on success, 0 on error.

	Error codes:
	- DK4_E_INVALID_ARGUMENTS<br>
	  if strm is NULL or not opened for writing,
	- DK4_E_WRITE_FAILED<br>
	  if writing one ore multiple bytes to the stream failed,
	- DK4_E_FLUSH_FAILED<br>
	  if flusing data downwards failed.
*/

int
dk4stream_serialize_i16(dk4_stream_t *strm, int16_t i16, dk4_er_t *erp);


/**	Serialize unsigned 8 bit integer to stream.
	@param	strm	Destination stream.
	@param	u8	Value to serialize.
	@param	erp	Error report, may be NULL.
	@return	1 on success, 0 on error.

	Error codes:
	- DK4_E_INVALID_ARGUMENTS<br>
	  if strm is NULL or not opened for writing,
	- DK4_E_WRITE_FAILED<br>
	  if writing one ore multiple bytes to the stream failed,
	- DK4_E_FLUSH_FAILED<br>
	  if flusing data downwards failed.
*/

int
dk4stream_serialize_u8(dk4_stream_t *strm, uint8_t u8, dk4_er_t *erp);


/**	Serialize signed 8 bit integer to stream.
	@param	strm	Destination stream.
	@param	i8	Value to serialize.
	@param	erp	Error report, may be NULL.
	@return	1 on success, 0 on error.

	Error codes:
	- DK4_E_INVALID_ARGUMENTS<br>
	  if strm is NULL or not opened for writing,
	- DK4_E_WRITE_FAILED<br>
	  if writing one ore multiple bytes to the stream failed,
	- DK4_E_FLUSH_FAILED<br>
	  if flusing data downwards failed.
*/

int
dk4stream_serialize_i8(dk4_stream_t *strm, int8_t i8, dk4_er_t *erp);


/**	Serialize string to stream.
	First the string length including the 0x00 finalizer byte
	is written as 16 bit unsigned integer, the string including the
	finalizer byte follows.
	By reading the length first, a reader application can allocate
	a memory block of exact size before reading the string contents.
	@param	strm	Destination stream.
	@param	str	String to serialize, max 65534 characters long.
	@param	erp	Error report, may be NULL.
	@return	1 on success, 0 on error.

	Error codes:
	- DK4_E_INVALID_ARGUMENTS<br>
	  if strm is NULL or not opened for writing,
	- DK4_E_BUFFER_TOO_SMALL<br>
	  if the str string is too long,
	- DK4_E_WRITE_FAILED<br>
	  if writing one ore multiple bytes to the stream failed,
	- DK4_E_FLUSH_FAILED<br>
	  if flusing data downwards failed.
*/

int
dk4stream_serialize_string(dk4_stream_t *strm, const char *str, dk4_er_t *erp);


/**	Serialize floating point value to stream.
	For non-0.0 values the value is converted to a string, the string
	is serialized to the stream. For 0.0 and values near enough
	(absolute value is below a given limit) a string length 0 is written
	indicating the 0.0 value to reader applications.
	@param	strm	Destination stream.
	@param	d	Value to serialize.
	@param	e	Epsilon for check whether d is 0.
	@param	erp	Error report, may be NULL.
	@return	1 on success, 0 on error.
*/

int
dk4stream_serialize_double(dk4_stream_t *strm,double d,double e,dk4_er_t *erp);


/**	Serialize floating point value 0 in short form.
	@param	strm	Stream to write to.
	@param	erp		Error report, may be NULL.
*/

int
dk4stream_serialize_double_0(dk4_stream_t *strm, dk4_er_t *erp);


#ifdef	__cplusplus
}
#endif


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


#endif