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
|
/*
* 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 STREAM_READER_H_INCLUDED
#define STREAM_READER_H_INCLUDED
#include "endian_str.h"
#include "tag.h"
#include "tag_compound.h"
#include <iosfwd>
#include <memory>
#include <stdexcept>
#include <utility>
#include "nbt++_export.h"
namespace nbt
{
namespace io
{
///Exception that gets thrown when reading is not successful
class NBT___EXPORT input_error : public std::runtime_error
{
using std::runtime_error::runtime_error;
};
/**
* @brief Reads a named tag from the stream, making sure that it is a compound
* @param is the stream to read from
* @param e the byte order of the source data. The Java edition
* of Minecraft uses Big Endian, the Pocket edition uses Little Endian
* @throw input_error on failure, or if the tag in the stream is not a compound
*/
NBT___EXPORT std::pair<std::string, std::unique_ptr<tag_compound>> read_compound(std::istream& is, endian::endian e = endian::big);
/**
* @brief Reads a named tag from the stream
* @param is the stream to read from
* @param e the byte order of the source data. The Java edition
* of Minecraft uses Big Endian, the Pocket edition uses Little Endian
* @throw input_error on failure
*/
NBT___EXPORT std::pair<std::string, std::unique_ptr<tag>> read_tag(std::istream& is, endian::endian e = endian::big);
/**
* @brief Helper class for reading NBT tags from input streams
*
* Can be reused to read multiple tags
*/
class NBT___EXPORT stream_reader
{
public:
/**
* @param is the stream to read from
* @param e the byte order of the source data. The Java edition
* of Minecraft uses Big Endian, the Pocket edition uses Little Endian
*/
explicit stream_reader(std::istream& is, endian::endian e = endian::big) noexcept;
///Returns the stream
std::istream& get_istr() const;
///Returns the byte order
endian::endian get_endian() const;
/**
* @brief Reads a named tag from the stream, making sure that it is a compound
* @throw input_error on failure, or if the tag in the stream is not a compound
*/
std::pair<std::string, std::unique_ptr<tag_compound>> read_compound();
/**
* @brief Reads a named tag from the stream
* @throw input_error on failure
*/
std::pair<std::string, std::unique_ptr<tag>> read_tag();
/**
* @brief Reads a tag of the given type without name from the stream
* @throw input_error on failure
*/
std::unique_ptr<tag> read_payload(tag_type type);
/**
* @brief Reads a tag type from the stream
* @param allow_end whether to consider tag_type::End valid
* @throw input_error on failure
*/
tag_type read_type(bool allow_end = false);
/**
* @brief Reads a binary number from the stream
*
* On failure, will set the failbit on the stream.
*/
template<class T>
void read_num(T& x);
/**
* @brief Reads an NBT string from the stream
*
* An NBT string consists of two bytes indicating the length, followed by
* the characters encoded in modified UTF-8.
* @throw input_error on failure
*/
std::string read_string();
private:
std::istream& is;
const endian::endian endian;
};
template<class T>
void stream_reader::read_num(T& x)
{
endian::read(is, x, endian);
}
}
}
#endif // STREAM_READER_H_INCLUDED
|
