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

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


#line 8 "dk4svbuf.ctr"

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

#ifndef	DK4CONF_H_INCLUDED
#include "dk4conf.h"
#endif

#ifndef	STDIO_H_INCLUDED
#include <stdio.h>
#define	STDIO_H_INCLUDED 1
#endif

#ifndef	DK4ERROR_H_INCLUDED
#include "dk4error.h"
#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.
*/
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