From ab920a114bb8aa9b5ca1ea88dade6b58d0144684 Mon Sep 17 00:00:00 2001 From: BodgeMaster <> Date: Tue, 28 Jun 2022 14:25:32 +0200 Subject: [PATCH] comply with code style guidelines, also minor fix to them --- code_style.md | 3 ++- src/lib/nbt.cpp | 4 ++-- src/lib/nbt.h++ | 8 ++++---- 3 files changed, 8 insertions(+), 7 deletions(-) diff --git a/code_style.md b/code_style.md index 3fb7125..55addec 100644 --- a/code_style.md +++ b/code_style.md @@ -42,7 +42,8 @@ all uppercase letters and underscores for their names. Variables and functions start with a lowercase letter, classes and structs with an uppercase letter. -Avoid abbreviations unless they are well known and universally used acronyms. +Avoid abbreviations unless they are well known acronyms and/or +universally used. Use explicitly sized data types where possible. For example, use `int32_t` instead of `int`. diff --git a/src/lib/nbt.cpp b/src/lib/nbt.cpp index b2596c1..3935af6 100644 --- a/src/lib/nbt.cpp +++ b/src/lib/nbt.cpp @@ -43,7 +43,7 @@ int endianness_example() { namespace NBT { namespace helpers { - ErrorOr readByte(uint8_t* data[], uint64_t dataSize, uint64_t currentPosition) { + ErrorOr readInt8(uint8_t* data[], uint64_t dataSize, uint64_t currentPosition) { //TODO: implement return ErrorOr(0); } @@ -81,7 +81,7 @@ namespace NBT { return ErrorOr(0.0); } - ErrorOr> readByteArray(uint8_t* data[], uint64_t dataSize, uint64_t currentPosition) { + ErrorOr> readInt8Array(uint8_t* data[], uint64_t dataSize, uint64_t currentPosition) { //TODO: implement return ErrorOr>({0}); } diff --git a/src/lib/nbt.h++ b/src/lib/nbt.h++ index 9c21abe..2c9d175 100644 --- a/src/lib/nbt.h++ +++ b/src/lib/nbt.h++ @@ -19,16 +19,16 @@ // NBT tags have a type, optionally a name which consists of the name size and the name string, optionally content type, and optionally a payload which can consist of optionally content type, optionally a content size, // and the stored content. The format in which they are stored is as follows: . All numbers are stored in big endian representation. // All tag types: -// generic representation: Tag(Byte:tag_type, String:name, uint16:name_size, byte[]:content, int32:size) +// generic representation: Tag(uint8:tag_type, String:name, uint16:name_size, byte[]:content, int32:size) // None (compound end): Tag( 0, "", 0, None, 0) => used to determine the end of a compound tag, only the type gets stored -// byte: Tag( 1, String:name, uint16:name_size, byte:content, 1) => a single signed byte, size not stored +// int8: Tag( 1, String:name, uint16:name_size, int8:content, 1) => a single signed byte, size not stored // int16: Tag( 2, String:name, uint16:name_size, int16:content, 2) => 16 bit signed integer, size not stored // int32: Tag( 3, String:name, uint16:name_size, int32:content, 4) => 32 bit signed integer, size not stored // int64: Tag( 4, String:name, uint16:name_size, int64:content, 8) => 64 bit signed integer, size not stored // float32: Tag( 5, String:name, uint16:name_size, float32:content,4) => 32 bit IEEE754 floating point number, size not stored // float64: Tag( 6, String:name, uint16:name_size, float64:content,8) => 64 bit IEEE754 floating point number, size not stored -// byte[]: Tag( 7, String:name, uint16:name_size, byte[]:content, int32:size) => content stored prefixed with size -// String: Tag( 8, String:name, uint16:name_size, byte[]:content, uint16:size) => Java style modified UTF-8 string, content stored prefixed with size +// int8[]: Tag( 7, String:name, uint16:name_size, int8[]:content, int32:size) => content stored prefixed with size +// String: Tag( 8, String:name, uint16:name_size, String:content, uint16:size) => Java style modified UTF-8 string, content stored prefixed with size // Tag[] (list): Tag( 9, String:name, uint16:name_size, Tag[]:content, int32:size) => list of tags of the same type with tag type and name information omitted prefixed by (in order) content type and size // Tag[] (compound): Tag(10, String:name, uint16:name_size, Tag[]:content, int32:size) => list of tags, last tag is always an end tag, size not stored // int32[]: Tag(11, String:name, uint16:name_size, int32[]:content,int32:size) => list of 32 bit signed integers prefixed with its size, endianness not verified at this point