summaryrefslogtreecommitdiff
path: root/support/dktools/dk4strmo32.h
blob: 487878678fc00ec8248a317197e76e90f66eeaac (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
/*
Copyright (C) 2015-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: dk4strmo32.ctr
*/

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


#line 9 "dk4strmo32.ctr"

/**	@file
	String output over dk4_stream_t API,
	32 bit character strings.

	CRT on Windows: Not used.
*/

#ifndef	DK4CONF_H_INCLUDED
#if DK4_BUILDING_DKTOOLS4
#include "dk4conf.h"
#else
#include <dktools-4/dk4conf.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

/**	Set output encoding for 32 bit character output.
	@param	strm	Stream to modify.
	@param	oe	New output encoding.
*/
void
dk4stream_set_output_encoding(dk4_stream_t *strm, int oe);

/**	Write one 32 bit character to stream.
	@param	strm	Stream to write to.
	@param	c32	Character to write.
	@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 set up for writing,
	- DK4_E_ENCODING_FAILED<br>
	  if it is not possible to encode c32 to the output encoding for the
	  stream,
	- 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
dk4stream_c32_putc(dk4_stream_t *strm, dk4_c32_t c32, dk4_er_t *erp);

/**	Write one 32 bit character string to stream.
	@param	strm	Stream to write to.
	@param	txt	Text string to write.
	@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 set up for writing,
	- DK4_E_ENCODING_FAILED<br>
	  if it is not possible to encode c32 to the output encoding for the
	  stream,
	- 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
dk4stream_c32_puts(dk4_stream_t *strm, const dk4_c32_t *txt, dk4_er_t *erp);

/**	Write byte order marker for those output encodings
	supporting a BOM.
	@param	strm	Stream to write the BOM to.
	@param	erp	Error report, may be NULL.
	@return	1 on success (BOM written or not required), 0 on error.
	
	Error codes:
	- DK4_E_INVALID_ARGUMENTS<br>
	  if strm is null or not set up for writing,
	- DK4_E_ENCODING_FAILED<br>
	  if it is not possible to encode c32 to the output encoding for the
	  stream,
	- 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
dk4stream_write_bom_if_necessary(dk4_stream_t *strm, dk4_er_t *erp);

#ifdef __cplusplus
}
#endif


#endif