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

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


#line 10 "dk4userf.ctr"

/**	@file	dk4userf.h	Unserialize (read) data from binary file.
*/

#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

#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


/**	Unserialize (read) a 16 bit unsigned number from binary file.
	@param	dptr	Address of destination variable.
	@param	fipo	Input file (opened for binary read access).
	@param	erp	Error report, may be NULL.
	@return	1 on success, 0 on error.
*/

int
dk4unserialize_file_uint16_t(uint16_t *dptr, FILE *fipo, dk4_er_t *erp);


/**	Unserialize (read) a 16 bit signed number from binary file.
	@param	dptr	Address of destination variable.
	@param	fipo	Input file (opened for binary read access).
	@param	erp	Error report, may be NULL.
	@return	1 on success, 0 on error.
*/

int
dk4unserialize_file_int16_t(int16_t *dptr, FILE *fipo, dk4_er_t *erp);


/**	Unserialize (read) a 32 bit unsigned number from binary file.
	@param	dptr	Address of destination variable.
	@param	fipo	Input file (opened for binary read access).
	@param	erp	Error report, may be NULL.
	@return	1 on success, 0 on error.
*/

int
dk4unserialize_file_uint32_t(uint32_t *dptr, FILE *fipo, dk4_er_t *erp);


/**	Unserialize (read) a 32 bit signed number from binary file.
	@param	dptr	Address of destination variable.
	@param	fipo	Input file (opened for binary read access).
	@param	erp	Error report, may be NULL.
	@return	1 on success, 0 on error.
*/

int
dk4unserialize_file_int32_t(int32_t *dptr, FILE *fipo, dk4_er_t *erp);


/**	Unserialize (read) an UTF-8 encoded text string from binary file.
	On success the function dynamically allocates memory for the string
	and sets the pointer to this memory. Use dk4mem_free() to release
	the memory after use.
	@param	dptr	Address of destination pointer variable, initialize
	the pointer to NULL before calling this function.
	@param	fipo	Input file (opened for binary read access).
	@param	erp	Error report, may be NULL.
	@return	1 on success, 0 on error.
*/

int
dk4unserialize_file_utf8_string(char **dptr, FILE *fipo, dk4_er_t *erp);


/**	Unserialize (read) a text string in the system default encoding
	from binary file.
	On success the function dynamically allocates memory for the string
	and sets the pointer to this memory. Use dk4mem_free() to release
	the memory after use.
	@param	dptr	Address of destination pointer variable, initialize
	the pointer to NULL before calling this function.
	@param	de	Encoding for dkChar.
	@param	fipo	Input file (opened for binary read access).
	@param	erp	Error report, may be NULL.
	@return	1 on success, 0 on error.
*/

int
dk4unserialize_file_dk_string(dkChar **dptr, int de, FILE *fipo, dk4_er_t *erp);


/**	Unserialize (read) a double number from binary file.
	@param	dptr	Address of destination variable.
	@param	fipo	Input file (opened for binary read access).
	@param	erp	Error report, may be NULL.
	@return	1 on success, 0 on error.
*/

int
dk4unserialize_file_double(double *dptr, FILE *fipo, dk4_er_t *erp);


#ifdef	__cplusplus
}
#endif



#endif