summaryrefslogtreecommitdiff
path: root/libnbtplusplus/include/io/izlibstream.h
blob: c2a8e59b04f638ab11e8e79a7cf77b4d58854388 (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
/*
 * SPDX-FileCopyrightText: 2013, 2015 ljfa-ag <ljfa-ag@web.de>
 *
 * SPDX-License-Identifier: LGPL-3.0-or-later
 */

/*
 * libnbt++ - A library for the Minecraft Named Binary Tag format.
 * Copyright (C) 2013, 2015  ljfa-ag
 *
 * This file is part of libnbt++.
 *
 * libnbt++ is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * libnbt++ is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with libnbt++.  If not, see <http://www.gnu.org/licenses/>.
 */
#ifndef IZLIBSTREAM_H_INCLUDED
#define IZLIBSTREAM_H_INCLUDED

#include "io/zlib_streambuf.h"
#include <istream>
#include <zlib.h>

namespace zlib
{

	/**
	 * @brief Stream buffer used by zlib::izlibstream
	 * @sa izlibstream
	 */
	class NBT_EXPORT inflate_streambuf : public zlib_streambuf
	{
	  public:
		/**
		 * @param input the istream to wrap
		 * @param bufsize the size of the internal buffers
		 * @param window_bits the base two logarithm of the maximum window size
		 * that zlib will use. This parameter also determines which type of
		 * input to expect. The default argument will autodetect between zlib
		 * and gzip data. Refer to the zlib documentation of inflateInit2 for
		 * more details.
		 *
		 * @throw zlib_error if zlib encounters a problem during initialization
		 */
		explicit inflate_streambuf(std::istream& input, size_t bufsize = 32768,
								   int window_bits = 32 + 15);
		~inflate_streambuf() noexcept;

		///@return the wrapped istream
		std::istream& get_istr() const
		{
			return is;
		}

	  private:
		std::istream& is;
		bool stream_end;

		int_type underflow() override;
	};

	/**
	 * @brief An istream adapter that decompresses data using zlib
	 *
	 * This istream wraps another istream. The izlibstream will read compressed
	 * data from the wrapped istream and inflate (decompress) it with zlib.
	 *
	 * @note If you want to read more data from the wrapped istream after the
	 * end of the compressed data, then it must allow seeking. It is unavoidable
	 * for the izlibstream to consume more data after the compressed data. It
	 * will automatically attempt to seek the wrapped istream back to the point
	 * after the end of the compressed data.
	 * @sa inflate_streambuf
	 */
	class NBT_EXPORT izlibstream : public std::istream
	{
	  public:
		/**
		 * @param input the istream to wrap
		 * @param bufsize the size of the internal buffers
		 */
		explicit izlibstream(std::istream& input, size_t bufsize = 32768)
			: std::istream(&buf), buf(input, bufsize)
		{
		}
		///@return the wrapped istream
		std::istream& get_istr() const
		{
			return buf.get_istr();
		}

	  private:
		inflate_streambuf buf;
	};

} // namespace zlib

#endif // IZLIBSTREAM_H_INCLUDED