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

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


#line 8 "dk4svbuf.ctr"

/**	@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 : */

#endif