summaryrefslogtreecommitdiff
path: root/support/dktools/dk4serf.h
blob: 6ba897037d62eb3e2ba5f22e239d3c07fef84d38 (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
/*
	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: dk4serf.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 DK4SERF_H_INCLUDED
/** Avoid multiple inclusions. */
#define DK4SERF_H_INCLUDED 1


#line 9 "dk4serf.ctr"

/**	@file	dk4serf.h	Serialize data to binary file.
*/

#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_HAVE_STDLIB_H
#ifndef	DK4_STDLIB_H_INCLUDED
#include <stdlib.h>
#define	DK4_STDLIB_H_INCLUDED 1
#endif
#endif

#if DK4_HAVE_SYS_TYPES_H
#ifndef	DK4_SYS_TYPES_H_INCLUDED
#include <sys/types.h>
#define	DK4_SYS_TYPES_H_INCLUDED 1
#endif
#endif

#if DK4_HAVE_STDINT_H
#ifndef	DK4_STDINT_H_INCLUDED
#include <stdint.h>
#define	DK4_STDINT_H_INCLUDED 1
#endif
#endif

#include <stdio.h>

#ifdef	__cplusplus
extern "C" {
#endif

/**	Serialize 16 bit unsigned int to file.
	@param	fipo	Output file.
	@param	u	Number to write.
	@param	erp	Error report, may be NULL.
	@return	1 on success, 0 on error.

	Error codes:
	- DK4_E_INVALID_ARGUMENTS<br>
	  if fipo is NULL or u is out of range,
	- DK4_E_WRITE_FAILED<br>
	  if fwrite() failed.
*/
int
dk4serialize_file_uint16_t(FILE *fipo, uint16_t u, dk4_er_t *erp);

/**	Serialize 16 bit signed int to file.
	@param	fipo	Output file.
	@param	i	Number to write.
	@param	erp	Error report, may be NULL.
	@return	1 on success, 0 on error.

	Error codes:
	- DK4_E_INVALID_ARGUMENTS<br>
	  if fipo is NULL or i is out of range,
	- DK4_E_WRITE_FAILED<br>
	  if fwrite() failed.
*/
int
dk4serialize_file_int16_t(FILE *fipo, int16_t i, dk4_er_t *erp);

/**	Serialize 32 bit unsigned int to file.
	@param	fipo	Output file.
	@param	u	Number to write.
	@param	erp	Error report, may be NULL.
	@return	1 on success, 0 on error.

	Error codes:
	- DK4_E_INVALID_ARGUMENTS<br>
	  if fipo is NULL or u is out of range,
	- DK4_E_WRITE_FAILED<br>
	  if fwrite() failed.
*/
int
dk4serialize_file_uint32_t(FILE *fipo, uint32_t u, dk4_er_t *erp);

/**	Serialize 32 bit signed int to file.
	@param	fipo	Output file.
	@param	i	Number to write.
	@param	erp	Error report, may be NULL.
	@return	1 on success, 0 on error.

	Error codes:
	- DK4_E_INVALID_ARGUMENTS<br>
	  if fipo is NULL or i is out of range,
	- DK4_E_WRITE_FAILED<br>
	  if fwrite() failed.
*/
int
dk4serialize_file_int32_t(FILE *fipo, int32_t i, dk4_er_t *erp);

/**	Serialize UTF-8 encoded string to file.
	@param	fipo	Output file.
	@param	str	String to write.
	@param	erp	Error report, may be NULL.
	@return	1 on success, 0 on error.
*/
int
dk4serialize_file_utf8_string(FILE *fipo, const char *str, dk4_er_t *erp);

/**	Serialize dkChar string to file (convert to UTF-8).
	@param	fipo	Output file.
	@param	str	String to write.
	@param	de	Encoding for dkChar strings.
	@param	erp	Error report, may be NULL.
	@return	1 on success, 0 on error.
*/
int
dk4serialize_file_dk_string(FILE *fipo,const dkChar *str,int de,dk4_er_t *erp);

/**	Serialize double value to file.
	The value is converted to string and saved as string, so you
	may loose information.
	@param	fipo	Output file.
	@param	d	Value to write.
	@param	erp	Error report, may be NULL.
	@return	1 on success, 0 on error.
*/
int
dk4serialize_file_double(FILE *fipo, double d, dk4_er_t *erp);

#ifdef	__cplusplus
}
#endif


#endif