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


#line 10 "dk4strmg.ctr"

/**	@file
	Generic dk4_stream_t API for input
	and output, implementation for gzfile.

	CRT on Windows: Required.
*/

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

#if DK4_HAVE_ZLIB_H

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

#ifndef ZLIB_H_INCLUDED
#include <zlib.h>
#define	ZLIB_H_INCLUDED 1
#endif

#ifdef __cplusplus
extern "C" {
#endif

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

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

/**	Open a stream for an existing gzFile.
	@param	fipo	Existing gzFile, 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 stream on success, NULL on error.
*/
dk4_stream_t *
dk4stream_open_for_gzfile(
  gzFile	 fipo,
  int		 fl,
  size_t	 ibs,
  size_t	 obs,
  dk4_er_t	*erp
);

/**	Open a stream for an existing gzFile.
	@param	fipo	Existing gzFile, 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 stream on success, NULL on error.
*/
dk4_stream_t *
dk4stream_open_for_gzfile_with_close(
  gzFile	 fipo,
  int		 fl,
  size_t	 ibs,
  size_t	 obs,
  dk4_er_t	*erp
);

#ifdef __cplusplus
}
#endif

#endif


#endif