chenjunfu2-nbt-cpp v2.1.0
一个基于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>>)
64 explicit NBT_Node(std::in_place_type_t<T>, Args&&... args) : data(std::in_place_type<T>, std::forward<Args>(args)...)
65 {
66 static_assert(std::is_constructible_v<VariantData, Args&&...>, "Invalid constructor arguments for NBT_Node");
67 }
68
74 template <typename T, typename U>
75 requires(!std::is_same_v<std::decay_t<T>, NBT_Node> && NBT_Type::IsValidType_V<std::decay_t<T>>)
76 explicit NBT_Node(std::in_place_type_t<T>, std::initializer_list<U> init_list) : data(std::in_place_type<T>, init_list)
77 {
78 static_assert(std::is_constructible_v<VariantData, std::initializer_list<U>>, "Invalid constructor arguments for NBT_Node");
79 }
80
85 template <typename T>
86 requires(!std::is_same_v<std::decay_t<T>, NBT_Node> && NBT_Type::IsValidType_V<std::decay_t<T>>)
87 NBT_Node(T &&value) noexcept : data(std::forward<T>(value))
88 {
89 static_assert(std::is_constructible_v<VariantData, decltype(value)>, "Invalid constructor arguments for NBT_Node");
90 }
91
98 template <typename T, typename... Args>
99 requires(!std::is_same_v<std::decay_t<T>, NBT_Node> && NBT_Type::IsValidType_V<std::decay_t<T>>)
100 T &Set(Args&&... args)
101 {
102 static_assert(std::is_constructible_v<VariantData, Args&&...>, "Invalid constructor arguments for NBT_Node");
103
104 return data.emplace<T>(std::forward<Args>(args)...);
105 }
106
112 template<typename T>
113 requires(!std::is_same_v<std::decay_t<T>, NBT_Node> && NBT_Type::IsValidType_V <std::decay_t<T>>)
114 NBT_Node &operator=(T &&value) noexcept
115 {
116 static_assert(std::is_constructible_v<VariantData, decltype(value)>, "Invalid constructor arguments for NBT_Node");
117
118 data = std::forward<T>(value);
119 return *this;
120 }
121
123 NBT_Node() : data(NBT_Type::End{})
124 {}
125
127 ~NBT_Node() = default;
128
131 NBT_Node(const NBT_Node &_NBT_Node) : data(_NBT_Node.data)
132 {}
133
136 NBT_Node(NBT_Node &&_NBT_Node) noexcept : data(std::move(_NBT_Node.data))
137 {}
138
142 NBT_Node &operator=(const NBT_Node &_NBT_Node)
143 {
144 data = _NBT_Node.data;
145 return *this;
146 }
147
151 NBT_Node &operator=(NBT_Node &&_NBT_Node) noexcept
152 {
153 data = std::move(_NBT_Node.data);
154 return *this;
155 }
156
160 bool operator==(const NBT_Node &_Right) const noexcept
161 {
162 return data == _Right.data;
163 }
164
168 bool operator!=(const NBT_Node &_Right) const noexcept
169 {
170 return data != _Right.data;
171 }
172
176 std::partial_ordering operator<=>(const NBT_Node &_Right) const noexcept
177 {
178 return data <=> _Right.data;
179 }
180
182 void Clear(void)
183 {
184 data.emplace<NBT_Type::End>(NBT_Type::End{});
185 }
186
189 NBT_TAG GetTag() const noexcept
190 {
191 return (NBT_TAG)(NBT_TAG_RAW_TYPE)data.index();//返回当前存储类型的index(0基索引,与NBT_TAG enum一一对应)
192 }
193
194
199 template<typename T>
200 const T &Get() const
201 {
202 return std::get<T>(data);
203 }
204
209 template<typename T>
210 T &Get()
211 {
212 return std::get<T>(data);
213 }
214
218 template<typename T>
219 bool TypeHolds() const
220 {
221 return std::holds_alternative<T>(data);
222 }
223
224//针对每种类型生成一个方便的函数
225//通过宏定义批量生成
226
230#define TYPE_GET_FUNC(type)\
231\
236const NBT_Type::type &Get##type() const\
237{\
238 return std::get<NBT_Type::type>(data);\
239}\
240\
241\
246NBT_Type::type &Get##type()\
247{\
248 return std::get<NBT_Type::type>(data);\
249}\
250\
251\
255bool Is##type() const\
256{\
257 return std::holds_alternative<NBT_Type::type>(data);\
258}\
259\
260\
266friend NBT_Type::type &Get##type(NBT_Node & node)\
267{\
268 return node.Get##type();\
269}\
270\
271\
277friend const NBT_Type::type &Get##type(const NBT_Node & node)\
279 return node.Get##type();\
287friend bool Is##type(const NBT_Node &node)\
288{\
289 return node.Is##type();\
290}
291
294 /// - Get开头+类型名的函数:直接获取此类型,异常由std::get具体实现决定
295 /// - Is开头 + 类型名的函数:判断当前NBT_Node是否为此类型
296 /// @{
297
308 TYPE_GET_FUNC(String);
309 TYPE_GET_FUNC(List);
310 TYPE_GET_FUNC(Compound);
311
312
313
314#undef TYPE_GET_FUNC
315
319#define TYPE_SET_FUNC(type)\
325NBT_Type::type &Set##type(const NBT_Type::type &value)\
327 return Set<NBT_Type::type>(value);\
335NBT_Type::type &Set##type(NBT_Type::type &&value)\
336{\
337 return Set<NBT_Type::type>(std::move(value));\
338}\
339\
340\
344NBT_Type::type &Set##type(void)\
345{\
346 return Set<NBT_Type::type>();\
347}
348
353
364 TYPE_SET_FUNC(String);
365 TYPE_SET_FUNC(List);
366 TYPE_SET_FUNC(Compound);
367
369
370#undef TYPE_SET_FUNC
371};
372
373/*
374TODO:
375给NBTList与NBTCompound添加一个附加字段
376往里面插入数据的时候,会根据数据的大小计算
377出nbt的大小合并到自身,删除的时候去掉
378这样在写出的时候可以预分配,而不是被动的触发
379容器的扩容拷贝,增加写出性能
380*/
NBT数组基础类型
NBT集合基础类型
NBT列表类型
#define TYPE_SET_FUNC(type)
不同类型名接口生成宏
定义 NBT_Node.hpp:294
#define TYPE_GET_FUNC(type)
不同类型名获取接口生成宏
定义 NBT_Node.hpp:230
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:131
T & Get()
通过指定类型获取当前存储的数据对象
定义 NBT_Node.hpp:210
NBT_TAG GetTag() const noexcept
获取当前存储的NBT类型的枚举值
定义 NBT_Node.hpp:189
NBT_Node(std::in_place_type_t< T >, Args &&... args)
显式类型构造函数(通过in_place_type_t指定目标类型)
定义 NBT_Node.hpp:64
bool operator!=(const NBT_Node &_Right) const noexcept
不等比较运算符
定义 NBT_Node.hpp:168
NBT_Node()
默认构造函数(构造为TAG_End类型)
定义 NBT_Node.hpp:123
NBT_Node & operator=(const NBT_Node &_NBT_Node)
拷贝赋值运算符
定义 NBT_Node.hpp:142
T & Set(Args &&... args)
原位放置新对象并替换当前对象
定义 NBT_Node.hpp:100
~NBT_Node()=default
默认析构函数
NBT_Node(NBT_Node &&_NBT_Node) noexcept
移动构造函数
定义 NBT_Node.hpp:136
NBT_Node(T &&value) noexcept
通用类型构造函数,可以拷贝或移动元素到对象内
定义 NBT_Node.hpp:87
NBT_Node(std::in_place_type_t< T >, std::initializer_list< U > init_list)
显式类型列表构造函数(通过in_place_type_t指定目标类型)
定义 NBT_Node.hpp:76
NBT_Node & operator=(NBT_Node &&_NBT_Node) noexcept
移动赋值运算符
定义 NBT_Node.hpp:151
bool TypeHolds() const
类型判断
定义 NBT_Node.hpp:219
std::partial_ordering operator<=>(const NBT_Node &_Right) const noexcept
三路比较运算符
定义 NBT_Node.hpp:176
const T & Get() const
通过指定类型获取当前存储的数据对象
定义 NBT_Node.hpp:200
bool operator==(const NBT_Node &_Right) const noexcept
相等比较运算符
定义 NBT_Node.hpp:160
void Clear(void)
清除所有数据,重置为TAG_End类型
定义 NBT_Node.hpp:182
提供NBT类型定义,包括NBT格式中的所有数据类型,以及部分辅助功能,比如静态类型与Tag映射,类型存在查询,类型列表大小,类型最大小值等
定义 NBT_Type.hpp:28
std::monostate End
结束标记类型,无数据
定义 NBT_Type.hpp:47
static constexpr bool IsValidType_V
类型存在检查:用于编译期检查一个给定类型是否为NBT中的类型
定义 NBT_Type.hpp:182