summaryrefslogtreecommitdiff
path: root/support/dktools/dk4svbuf.ctr
blob: 7abd3768fd299364e8e34e21d6024d930980f727 (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
%%	options

copyright owner	=	Dirk Krause
copyright year	=	2016-xxxx
SPDX-License-Identifier:	BSD-3-Clause

%%	header

/**	@file	dk4svbuf.h	File buffering.
*/

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

/**	How to buffer a file.
*/
typedef enum {
	DK4_FILE_NO_BUFFERING	= 0 ,	/**< Do not use buffers. */
	DK4_FILE_LINE_BUFFERING ,		/**< Buffer lines. */
	DK4_FILE_FULL_BUFFERING			/**< Full buffering. */
} dk4_file_buffering_t;

#ifdef	__cplusplus
extern "C" {
#endif

/**	Set up buffering for a file.
	@param	fipo	File to modify.
	@param	tp		Buffering type.
	@param	pbuf	Start address of buffer to use, may be NULL.
	@param	szbuf	Size of buffer, may be 0.
	@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,
	- DK4_E_NOT_SUPPORTED<br>
	  if neither the setbuffer function nor the setvbuf() function
	  is available on the system.
	- DK4_E_SYSTEM<br>
	  if setvbuf() indicated an error.
*/
int
dk4setvbuf(
	FILE					*fipo,
	dk4_file_buffering_t	 tp,
	char					*pbuf,
	size_t					 szbuf,
	dk4_er_t				*erp
);

#ifdef	__cplusplus
}
#endif

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


#include "dk4conf.h"
#include "dk4svbuf.h"

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

#if DK4_HAVE_ASSERT_H
#ifndef	ASSERT_H_INCLUDED
#include <assert.h>
#define	ASSERT_H_INCLUDED 1
#endif
#endif

$!trace-include



/**	Buffering type constants.
*/
static int buffering_types[] = {
	_IONBF, _IOLBF, _IOFBF
};


int
dk4setvbuf(
	FILE					*fipo,
	dk4_file_buffering_t	 tp,
	char					*pbuf,
	size_t					 szbuf,
	dk4_er_t				*erp
)
{
	int		 back	= 0;
#if	DK4_HAVE_SETVBUF
	int		 svbres	= 0;
#endif
	int		 btp;

#if	DK4_USE_ASSERT
  assert(NULL != fipo);
#endif
	if (NULL != fipo) {
		btp = (
			((0 <= (int)tp) && (3 > (int)tp))
			? (buffering_types[(int)tp])
			: (buffering_types[2])
		);
#if DK4_HAVE_SETVBUF
		errno = 0;
		svbres = setvbuf(
			fipo,
			((0 < szbuf) ? (pbuf) : (NULL)),
			(((NULL != pbuf) && (0 < szbuf)) ? (btp) : (buffering_types[0])),
			szbuf
		);
		if (0 == svbres) {
			back = 1;
		}
		else {
			dk4error_set_idetails(erp, DK4_E_SYSTEM, errno);
		}
#else
#if	DK4_HAVE_SETBUFFER
		setbuffer(fipo, pbuf, szbuf);
		back = 1;
#else
		back = 1;
		dk4error_set_simple_error_code(erp, DK4_E_NOT_SUPPORTED);
#endif
#endif
	}
	else {
		dk4error_set_simple_error_code(erp, DK4_E_INVALID_ARGUMENTS);
	}
	return back;
}

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