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

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


#line 8 "dk4c8dbl.ctr"

/**	@file	dk4c8dbl.h	Write double value to file or stream
	without scientific notation.
*/

#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	STDIO_H_INCLUDED
#include <stdio.h>
#define	STDIO_H_INCLUDED 1
#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

/**	Write double value to stream, avoid scientific notation.
	@param	strm	Stream to write to.
	@param	v		Value to write.
	@param	exact	Flag: Exact representation.
	@param	minim	Flag: Minimize an exact representation.
	@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,
	- DK4_E_BUFFER_TOO_SMALL<br>
	  if the internal destination buffer is too small to store the string,
	- DK4_E_WRITE_FAILED<br>
	  if writing one ore multiple bytes to the stream failed,
	- DK4_E_FLUSH_FAILED<br>
	  if flushing data downwards failed.
*/

int
dk4c8dbl_double_to_stream(
	dk4_stream_t	*strm,
	double			 v,
	int				 exact,
	int				 minim,
	dk4_er_t		*erp
);


/**	Write double value to stream, avoid scientific notation.
	@param	fipo	File to write to.
	@param	v		Value to write.
	@param	exact	Flag: Exact representation.
	@param	minim	Flag: Minimize an exact representation.
	@param	erp		Error report, may be NULL.
	@return	1 on success, 0 on error.

	Error codes:
	- DK4_E_INVALID_ARGUMENTS<br>
	  if dptr is NULL,
	- DK4_E_BUFFER_TOO_SMALL<br>
	  if the internal destination buffer is too small to store the string,
	- DK4_E_WRITE_FAILED<br>
	  if writing one ore multiple bytes to the stream failed,
	- DK4_E_FLUSH_FAILED<br>
	  if flushing data downwards failed.
*/

int
dk4c8dbl_double_to_file(
	FILE			*fipo,
	double			 v,
	int				 exact,
	int				 minim,
	dk4_er_t		*erp
);


/**	Write double string to stream, avoid scientific notation.
	@param	fipo	File to write to.
	@param	str		String containing the value.
	@param	erp		Error report, may be NULL.
	@return	1 on success, 0 on error.

	Error codes:
	- DK4_E_INVALID_ARGUMENTS<br>
	  if fipo or str is NULL,
	- DK4_E_SYNTAX<br>
	  if the string str is empty,
	- DK4_E_BUFFER_TOO_SMALL<br>
	  if an internal buffer is too small to store the string,
	- DK4_E_WRITE_FAILED<br>
	  if writing one ore multiple bytes to the stream failed,
	- DK4_E_FLUSH_FAILED<br>
	  if flushing data downwards failed.
*/

int
dk4c8dbl_str_double_to_file(
	FILE			*fipo,
	const char		*str,
	dk4_er_t		*erp
);


#ifdef	__cplusplus
}
#endif


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

#endif