summaryrefslogtreecommitdiff
path: root/support/dktools/dk4strmh.h
blob: f107ae4fd832ce2b030daebfffa8b612d5877034 (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
/*
	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: dk4strmh.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 DK4STRMH_H_INCLUDED
/** Avoid multiple inclusions. */
#define DK4STRMH_H_INCLUDED 1


#line 10 "dk4strmh.ctr"

/**	@file
	Generic dk4_stream_t API for input
				from Windows file handle.
*/

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

#if DK4_ON_WINDOWS

#ifndef DK4TYPES_H_INCLUDED
#include "dk4types.h"
#endif

#ifndef WINDOWS_H_INCLUDED
#include <windows.h>
#define	WINDOWS_H_INCLUDED 1
#endif

#ifndef DK4ERROR_H_INCLUDED
#include "dk4error.h"
#endif

#ifndef DK4STRM_H_INCLUDED
#include "dk4strm.h"
#endif

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

/**	Structure for keeping a HANDLE.
*/
typedef struct {
  HANDLE		ha;	/**< Windows file handle. */
  int			feof;	/**< Flag: Found EOF while reading. */
} dk4_stream_handle_t;

#ifdef __cplusplus
extern "C" {
#endif

/**	Low level function to access a Windows handle.
	@param	api	The stream API structure for arguments and results.
*/
void
dk4stream_windows_handle_function(dk4_stream_api_t *api);

/**	Low level function to access a Windows handle and close it on
	dk4stream_close().
	@param	api	The stream API structure for arguments and results.
*/
void
dk4stream_windows_handle_with_close_function(dk4_stream_api_t *api);

/**	Open a stream for an existing handle.
	@param	ha	Existing file handle, not closed on dk4stream_close().
	@param	fl	Access flag: DK4_STREAM_READ,, DK4_STREAM_WRITE
			or (DK4_STREAM_READ | DK4_STREAM_WRITE).
	@param	ibs	Input buffer size (0 for default).
	@param	obs	Output buffer size (0 for default).
	@param	erp	Error report, may be NULL.
	@return	Pointer to new stream on success, NULL on error.
*/
dk4_stream_t *
dk4stream_open_for_windows_handle(
  HANDLE		 ha,
  int			 fl,
  size_t		 ibs,
  size_t		 obs,
  dk4_er_t		*erp
);

/**	Open a stream for an existing handle.
	@param	ha	Existing file handle, closed on dk4stream_close().
	@param	fl	Access flag: DK4_STREAM_READ,, DK4_STREAM_WRITE
			or (DK4_STREAM_READ | DK4_STREAM_WRITE).
	@param	ibs	Input buffer size (0 for default).
	@param	obs	Output buffer size (0 for default).
	@param	erp	Error report, may be NULL.
	@return	Pointer to new stream on success, NULL on error.
*/
dk4_stream_t *
dk4stream_open_for_windows_handle_with_close(
  HANDLE		 ha,
  int			 fl,
  size_t		 ibs,
  size_t		 obs,
  dk4_er_t		*erp
);

#ifdef __cplusplus
}
#endif


#endif


#endif