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

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


#line 10 "dk4fput.ctr"

/**	@file
	File functions for dkChar characters
	and strings.

	CRT on Windows: Required.
*/

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

#if DK4_HAVE_ERRNO_H
#ifndef ERRNO_H_INCLUDED
#include <errno.h>
#define	ERRNO_H_INCLUDED 1
#endif
#endif

#ifdef __cplusplus
extern "C" {
#endif

/**	On Windows, initialize stdout to write dkChar and write a BOM.
*/
void
dk4fput_initialize_stdout(void);

/**	On Windows, initialize stdout to write dkChar.
*/
void
dk4fput_initialize_stdout_no_bom(void);

/**	On Windows, initialize stderr to write dkChar and write a BOM.
*/
void
dk4fput_initialize_stderr(void);

/**	On Windows, initialize stderr to write dkChar.
*/
void
dk4fput_initialize_stderr_no_bom(void);

/**	On Windows, initialize file to write dkChar and write a BOM.
	@param	fipo	File to set up.
*/
void
dk4fput_initialize_file(FILE *fipo);

/**	On Windows, initialize file to write dkChar.
	@param	fipo	File to set up.
*/
void
dk4fput_initialize_file_no_bom(FILE *fipo);

/**	On Windows, return to the default file encoding for stdout.
*/
void
dk4fput_cleanup_stdout(void);

/**	On Windows, return to the default file encoding for stderr.
*/
void
dk4fput_cleanup_stderr(void);

/**	Write one character to file.
	@param	c	Character to write.
	@param	fipo	File to write to.
	@param	erp	Error report, may be NULL.
	@return	1 on success, 0 on error.

	Error codes:
	- DK4_E_NOT_SUPPORTED<br>
	  if writing wide characters is not supported on the system,
	- DK4_E_INVALID_ARGUMENTS<br>
	  if fipo is NULL,
	- DK4_E_WRITE_FAILED<br>
	  with errno value in iDetails1 if the write attempt failed.
*/
int
dk4fputc(dkChar c, FILE *fipo, dk4_er_t *erp);

/**	Write one string to file.
	@param	s	String to write.
	@param	fipo	File to write to.
	@param	erp	Error report, may be NULL.
	@return	1 on success, 0 on error.

	Error codes:
	- DK4_E_NOT_SUPPORTED<br>
	  if writing wide character strings is not supported on the system,
	- DK4_E_INVALID_ARGUMENTS<br>
	  if fipo is NULL,
	- DK4_E_WRITE_FAILED<br>
	  with errno in iDetails1 if the write attempt failed.
*/
int
dk4fputs(const dkChar *s, FILE *fipo, dk4_er_t *erp);

#ifdef __cplusplus
}
#endif




#endif