chenjunfu2-nbt-cpp v2.1.3
一个基于CPP20的NBT(Named Binary Tag)库
载入中...
搜索中...
未找到
NBT_Node.hpp
浏览该文件的文档.
1#pragma once
2
3#include <compare>
4
5#include "NBT_Type.hpp"
6
7#include "NBT_Array.hpp"
8#include "NBT_String.hpp"
9#include "NBT_List.hpp"
10#include "NBT_Compound.hpp"
11
14
15//在这里,所有依赖的定义都已完备,给出方便调用获取字符串字面量的的宏定义
16
21#define MU8STR(charLiteralString) (NBT_Type::String(U8TOMU8STR(u8##charLiteralString)))//从工具返回的std::string_view构造到nbt的string::view
22
28#define MU8STRV(charLiteralString) (NBT_Type::String::View(U8TOMU8STR(u8##charLiteralString)))//从工具返回的std::string_view构造到nbt的string::view
29
30template <bool bIsConst>
31class NBT_Node_View;
32
37{
38 template <bool bIsConst>
39 friend class NBT_Node_View;//视图类作为友元,互相访问数据
40
41private:
42 //类型列表展开,声明std::variant
43 template <typename T>
44 struct TypeListToVariant;
45
46 template <typename... Ts>
47 struct TypeListToVariant<NBT_Type::_TypeList<Ts...>>
48 {
49 using type = std::variant<Ts...>;
50 };
51
52 using VariantData = TypeListToVariant<NBT_Type::TypeList>::type;
53
54 //数据对象(要求必须持有数据)
55 VariantData data;
56public:
62 template <typename T, typename... Args>
63 requires(!std::is_same_v<std::decay_t<T>, NBT_Node> && NBT_Type::IsValidType_V<std::decay_t<T>> && std::is_constructible_v<VariantData, std::in_place_type_t<T>, Args&&...>)
64 explicit NBT_Node(std::in_place_type_t<T>, Args&&... args) : data(std::in_place_type<T>, std::forward<Args>(args)...)
65 {}
66
72 template <typename T, typename U>
73 requires(!std::is_same_v<std::decay_t<T>, NBT_Node> && NBT_Type::IsValidType_V<std::decay_t<T>> && std::is_constructible_v<VariantData, std::in_place_type_t<T>, std::initializer_list<U>>)
74 explicit NBT_Node(std::in_place_type_t<T>, std::initializer_list<U> init_list) : data(std::in_place_type<T>, init_list)
75 {}
76
81 template <typename T>
82 requires(!std::is_same_v<std::decay_t<T>, NBT_Node> && NBT_Type::IsValidType_V<std::decay_t<T>> && std::is_constructible_v<VariantData, T&&>)
83 NBT_Node(T &&value) noexcept : data(std::forward<T>(value))
84 {}
85
92 template <typename T, typename... Args>
93 requires(!std::is_same_v<std::decay_t<T>, NBT_Node> && NBT_Type::IsValidType_V<std::decay_t<T>> && std::is_constructible_v<T, Args&&...>)
94 T &Set(Args&&... args)
95 {
96 return data.emplace<T>(std::forward<Args>(args)...);
97 }
98
104 template<typename T>
105 requires(!std::is_same_v<std::decay_t<T>, NBT_Node> && NBT_Type::IsValidType_V <std::decay_t<T>> && std::is_constructible_v<VariantData, T&&>)
106 NBT_Node &operator=(T &&value) noexcept
107 {
108 data = std::forward<T>(value);
109 return *this;
110 }
111
113 NBT_Node() : data(NBT_Type::End{})
114 {}
115
117 ~NBT_Node() = default;
118
121 NBT_Node(const NBT_Node &_NBT_Node) : data(_NBT_Node.data)
122 {}
123
126 NBT_Node(NBT_Node &&_NBT_Node) noexcept : data(std::move(_NBT_Node.data))
127 {}
128
132 NBT_Node &operator=(const NBT_Node &_NBT_Node)
133 {
134 data = _NBT_Node.data;
135 return *this;
136 }
137
141 NBT_Node &operator=(NBT_Node &&_NBT_Node) noexcept
142 {
143 data = std::move(_NBT_Node.data);
144 return *this;
145 }
146
150 bool operator==(const NBT_Node &_Right) const noexcept
151 {
152 return data == _Right.data;
153 }
154
158 bool operator!=(const NBT_Node &_Right) const noexcept
159 {
160 return data != _Right.data;
161 }
162
166 std::partial_ordering operator<=>(const NBT_Node &_Right) const noexcept
167 {
168 return data <=> _Right.data;
169 }
170
172 void Clear(void)
173 {
174 data.emplace<NBT_Type::End>(NBT_Type::End{});
175 }
176
179 NBT_TAG GetTag() const noexcept
180 {
181 return (NBT_TAG)(NBT_TAG_RAW_TYPE)data.index();//返回当前存储类型的index(0基索引,与NBT_TAG enum一一对应)
182 }
183
184
189 template<typename T>
190 const T &Get() const
191 {
192 return std::get<T>(data);
193 }
194
199 template<typename T>
200 T &Get()
201 {
202 return std::get<T>(data);
203 }
204
208 template<typename T>
209 bool TypeHolds() const
210 {
211 return std::holds_alternative<T>(data);
212 }
213
214//针对每种类型生成一个方便的函数
215//通过宏定义批量生成
216
220#define TYPE_GET_FUNC(type)\
221\
226const NBT_Type::type &Get##type() const\
227{\
228 return std::get<NBT_Type::type>(data);\
229}\
230\
231\
236NBT_Type::type &Get##type()\
237{\
238 return std::get<NBT_Type::type>(data);\
239}\
240\
241\
245bool Is##type() const\
246{\
247 return std::holds_alternative<NBT_Type::type>(data);\
248}\
249\
250\
256friend NBT_Type::type &Get##type(NBT_Node & node)\
257{\
258 return node.Get##type();\
259}\
260\
261\
267friend const NBT_Type::type &Get##type(const NBT_Node & node)\
269 return node.Get##type();\
277friend bool Is##type(const NBT_Node &node)\
278{\
279 return node.Is##type();\
280}
281
284 /// - Get开头+类型名的函数:直接获取此类型,异常由std::get具体实现决定
285 /// - Is开头 + 类型名的函数:判断当前NBT_Node是否为此类型
286 /// @{
287
298 TYPE_GET_FUNC(String);
299 TYPE_GET_FUNC(List);
300 TYPE_GET_FUNC(Compound);
301
302
303
304#undef TYPE_GET_FUNC
305
309#define TYPE_SET_FUNC(type)\
315NBT_Type::type &Set##type(const NBT_Type::type &value)\
317 return Set<NBT_Type::type>(value);\
325NBT_Type::type &Set##type(NBT_Type::type &&value)\
326{\
327 return Set<NBT_Type::type>(std::move(value));\
328}\
329\
330\
334NBT_Type::type &Set##type(void)\
335{\
336 return Set<NBT_Type::type>();\
337}
338
343
354 TYPE_SET_FUNC(String);
355 TYPE_SET_FUNC(List);
356 TYPE_SET_FUNC(Compound);
357
359
360#undef TYPE_SET_FUNC
361};
362
363/*
364TODO:
365给NBTList与NBTCompound添加一个附加字段
366往里面插入数据的时候,会根据数据的大小计算
367出nbt的大小合并到自身,删除的时候去掉
368这样在写出的时候可以预分配,而不是被动的触发
369容器的扩容拷贝,增加写出性能
370*/
NBT数组基础类型
NBT集合基础类型
NBT列表类型
#define TYPE_SET_FUNC(type)
不同类型名接口生成宏
定义 NBT_Node.hpp:284
#define TYPE_GET_FUNC(type)
不同类型名获取接口生成宏
定义 NBT_Node.hpp:220
NBT字符串类型
uint8_t NBT_TAG_RAW_TYPE
NBT_TAG的原始类型,用于二进制读写或判断等
定义 NBT_TAG.hpp:12
NBT_TAG
枚举NBT类型对应的类型标签值
定义 NBT_TAG.hpp:17
@ Int
对应NBT_Type::Int
定义 NBT_TAG.hpp:21
@ Float
对应NBT_Type::Float
定义 NBT_TAG.hpp:23
@ ByteArray
对应NBT_Type::ByteArray
定义 NBT_TAG.hpp:25
@ Short
对应NBT_Type::Short
定义 NBT_TAG.hpp:20
@ Long
对应NBT_Type::Long
定义 NBT_TAG.hpp:22
@ End
对应NBT_Type::End
定义 NBT_TAG.hpp:18
@ LongArray
对应NBT_Type::LongArray
定义 NBT_TAG.hpp:30
@ Byte
对应NBT_Type::Byte
定义 NBT_TAG.hpp:19
@ IntArray
对应NBT_Type::IntArray
定义 NBT_TAG.hpp:29
@ Double
对应NBT_Type::Double
定义 NBT_TAG.hpp:24
NBT所有类型定义与类型处理工具集
NBT节点的视图,用于指向而不持有对象,类似于标准库的std::string与std::string_view的关系
定义 NBT_Node_View.hpp:24
NBT节点,用于存储NBT格式的各种数据类型
定义 NBT_Node.hpp:37
NBT_Node(const NBT_Node &_NBT_Node)
拷贝构造函数
定义 NBT_Node.hpp:121
T & Set(Args &&... args)
原位放置新对象并替换当前对象
定义 NBT_Node.hpp:94
T & Get()
通过指定类型获取当前存储的数据对象
定义 NBT_Node.hpp:200
NBT_Node(std::in_place_type_t< T >, std::initializer_list< U > init_list)
显式类型列表构造函数(通过in_place_type_t指定目标类型)
定义 NBT_Node.hpp:74
NBT_TAG GetTag() const noexcept
获取当前存储的NBT类型的枚举值
定义 NBT_Node.hpp:179
bool operator!=(const NBT_Node &_Right) const noexcept
不等比较运算符
定义 NBT_Node.hpp:158
NBT_Node()
默认构造函数(构造为TAG_End类型)
定义 NBT_Node.hpp:113
NBT_Node & operator=(const NBT_Node &_NBT_Node)
拷贝赋值运算符
定义 NBT_Node.hpp:132
~NBT_Node()=default
默认析构函数
NBT_Node(NBT_Node &&_NBT_Node) noexcept
移动构造函数
定义 NBT_Node.hpp:126
NBT_Node & operator=(NBT_Node &&_NBT_Node) noexcept
移动赋值运算符
定义 NBT_Node.hpp:141
bool TypeHolds() const
类型判断
定义 NBT_Node.hpp:209
NBT_Node(T &&value) noexcept
通用类型构造函数,可以拷贝或移动元素到对象内
定义 NBT_Node.hpp:83
std::partial_ordering operator<=>(const NBT_Node &_Right) const noexcept
三路比较运算符
定义 NBT_Node.hpp:166
const T & Get() const
通过指定类型获取当前存储的数据对象
定义 NBT_Node.hpp:190
bool operator==(const NBT_Node &_Right) const noexcept
相等比较运算符
定义 NBT_Node.hpp:150
NBT_Node(std::in_place_type_t< T >, Args &&... args)
显式类型构造函数(通过in_place_type_t指定目标类型)
定义 NBT_Node.hpp:64
void Clear(void)
清除所有数据,重置为TAG_End类型
定义 NBT_Node.hpp:172
提供NBT类型定义,包括NBT格式中的所有数据类型,以及部分辅助功能,比如静态类型与Tag映射,类型存在查询,类型列表大小,类型最大小值等
定义 NBT_Type.hpp:29
std::monostate End
结束标记类型,无数据
定义 NBT_Type.hpp:48
static constexpr bool IsValidType_V
类型存在检查:用于编译期检查一个给定类型是否为NBT中的类型
定义 NBT_Type.hpp:183