Minecraft NBT (Named Binary Tag): Go parsing library

// Code generated by kaitai-struct-compiler from a .ksy source file. DO NOT EDIT.

import (
	"github.com/kaitai-io/kaitai_struct_go_runtime/kaitai"
	"io"
)


/**
 * A structured binary format native to Minecraft for saving game data and transferring
 * it over the network (in multiplayer), such as player data
 * ([`<player>.dat`](https://minecraft.wiki/w/Player.dat_format); contains
 * e.g. player's inventory and location), saved worlds
 * ([`level.dat`](
 *   https://minecraft.wiki/w/Java_Edition_level_format#level.dat_format
 * ) and [Chunk format](https://minecraft.wiki/w/Chunk_format#NBT_structure)),
 * list of saved multiplayer servers
 * ([`servers.dat`](https://minecraft.wiki/w/Servers.dat_format)) and so on -
 * see <https://minecraft.wiki/w/NBT_format#Uses>.
 * 
 * The entire file should be _gzip_-compressed (in accordance with the original
 * specification [NBT.txt](
 *   https://web.archive.org/web/20110723210920/https://www.minecraft.net/docs/NBT.txt
 * ) by Notch), but can also be compressed with _zlib_ or uncompressed.
 * 
 * This spec can only handle uncompressed NBT data, so be sure to first detect
 * what type of data you are dealing with. You can use the Unix `file` command
 * to do this (`file-5.20` or later is required; older versions do not recognize
 * _zlib_-compressed data and return `application/octet-stream` instead):
 * 
 * ```shell
 * file --brief --mime-type input-unknown.nbt
 * ```
 * 
 * If it says:
 * 
 *   * `application/x-gzip` or `application/gzip` (since `file-5.37`), you can decompress it by
 *     * `gunzip -c input-gzip.nbt > output.nbt` or
 *     * `python3 -c "import sys, gzip; sys.stdout.buffer.write(
 *       gzip.decompress(sys.stdin.buffer.read()) )" < input-gzip.nbt > output.nbt`
 *   * `application/zlib`, you can use
 *     * `openssl zlib -d -in input-zlib.nbt -out output.nbt` (does not work on most systems)
 *     * `python3 -c "import sys, zlib; sys.stdout.buffer.write(
 *       zlib.decompress(sys.stdin.buffer.read()) )" < input-zlib.nbt > output.nbt`
 *   * something else (especially `image/x-pcx` and `application/octet-stream`),
 *     it is most likely already uncompressed.
 * 
 * The file `output.nbt` generated by one of the above commands can already be
 * processed with this Kaitai Struct specification.
 * 
 * This spec **only** implements the Java edition format. There is also
 * a [Bedrock edition](https://wiki.vg/NBT#Bedrock_edition) NBT format,
 * which uses little-endian encoding and has a few other differences, but it isn't
 * as popular as the Java edition format.
 * 
 * **Implementation note:** strings in `TAG_String` are incorrectly decoded with
 * standard UTF-8, while they are encoded in [**Modified UTF-8**](
 *   https://docs.oracle.com/javase/8/docs/api/java/io/DataInput.html#modified-utf-8
 * ) (MUTF-8). That's because MUTF-8 is not supported natively by most target
 * languages, and thus one must use external libraries to achieve a fully-compliant
 * decoder. But decoding in standard UTF-8 is still better than nothing, and
 * it usually works fine.
 * 
 * All Unicode code points with incompatible representations in MUTF-8 and UTF-8 are
 * U+0000 (_NUL_), U+D800-U+DFFF (_High_ and _Low Surrogates_) and U+10000-U+10FFFF
 * (all _Supplementary_ Planes; includes e.g. emoticons, pictograms).
 * A _MUTF-8_-encoded string containing these code points cannot be successfully
 * decoded as UTF-8. The behavior in this case depends on the target language -
 * usually an exception is thrown, or the bytes that are not valid UTF-8
 * are replaced or ignored.
 * 
 * **Sample files:**
 * 
 *   * <https://wiki.vg/NBT#Download>
 *   * <https://github.com/twoolie/NBT/blob/f9e892e/tests/world_test/data/scoreboard.dat>
 *   * <https://github.com/chmod222/cNBT/tree/3f74b69/testdata>
 *   * <https://github.com/PistonDevelopers/hematite_nbt/tree/0b85f89/tests>
 * @see <a href="https://wiki.vg/NBT">Source</a>
 * @see <a href="https://web.archive.org/web/20110723210920/https://www.minecraft.net/docs/NBT.txt">Source</a>
 * @see <a href="https://minecraft.wiki/w/NBT_format">Source</a>
 */

type MinecraftNbt_Tag int
const (
	MinecraftNbt_Tag__End MinecraftNbt_Tag = 0
	MinecraftNbt_Tag__Byte MinecraftNbt_Tag = 1
	MinecraftNbt_Tag__Short MinecraftNbt_Tag = 2
	MinecraftNbt_Tag__Int MinecraftNbt_Tag = 3
	MinecraftNbt_Tag__Long MinecraftNbt_Tag = 4
	MinecraftNbt_Tag__Float MinecraftNbt_Tag = 5
	MinecraftNbt_Tag__Double MinecraftNbt_Tag = 6
	MinecraftNbt_Tag__ByteArray MinecraftNbt_Tag = 7
	MinecraftNbt_Tag__String MinecraftNbt_Tag = 8
	MinecraftNbt_Tag__List MinecraftNbt_Tag = 9
	MinecraftNbt_Tag__Compound MinecraftNbt_Tag = 10
	MinecraftNbt_Tag__IntArray MinecraftNbt_Tag = 11
	MinecraftNbt_Tag__LongArray MinecraftNbt_Tag = 12
)
var values_MinecraftNbt_Tag = map[MinecraftNbt_Tag]struct{}{0: {}, 1: {}, 2: {}, 3: {}, 4: {}, 5: {}, 6: {}, 7: {}, 8: {}, 9: {}, 10: {}, 11: {}, 12: {}}
func (v MinecraftNbt_Tag) isDefined() bool {
	_, ok := values_MinecraftNbt_Tag[v]
	return ok
}
type MinecraftNbt struct {
	RootCheck []byte
	Root *MinecraftNbt_NamedTag
	_io *kaitai.Stream
	_root *MinecraftNbt
	_parent kaitai.Struct
	_f_rootType bool
	rootType MinecraftNbt_Tag
}
func NewMinecraftNbt() *MinecraftNbt {
	return &MinecraftNbt{
	}
}

func (this MinecraftNbt) IO_() *kaitai.Stream {
	return this._io
}

func (this *MinecraftNbt) Read(io *kaitai.Stream, parent kaitai.Struct, root *MinecraftNbt) (err error) {
	this._io = io
	this._parent = parent
	this._root = root

	tmp1, err := this.RootType()
	if err != nil {
		return err
	}
	if ( ((tmp1 == MinecraftNbt_Tag__End) && (false)) ) {
		tmp2, err := this._io.ReadBytes(int(0))
		if err != nil {
			return err
		}
		tmp2 = tmp2
		this.RootCheck = tmp2
	}
	tmp3 := NewMinecraftNbt_NamedTag()
	err = tmp3.Read(this._io, this, this._root)
	if err != nil {
		return err
	}
	this.Root = tmp3
	return err
}
func (this *MinecraftNbt) RootType() (v MinecraftNbt_Tag, err error) {
	if (this._f_rootType) {
		return this.rootType, nil
	}
	this._f_rootType = true
	_pos, err := this._io.Pos()
	if err != nil {
		return nil, err
	}
	_, err = this._io.Seek(int64(0), io.SeekStart)
	if err != nil {
		return nil, err
	}
	tmp4, err := this._io.ReadU1()
	if err != nil {
		return nil, err
	}
	this.rootType = MinecraftNbt_Tag(tmp4)
	if !(this.rootType == MinecraftNbt_Tag__Compound) {
		return nil, kaitai.NewValidationNotEqualError(MinecraftNbt_Tag__Compound, this.rootType, this._io, "/instances/root_type")
	}
	_, err = this._io.Seek(_pos, io.SeekStart)
	if err != nil {
		return nil, err
	}
	return this.rootType, nil
}
type MinecraftNbt_NamedTag struct {
	Type MinecraftNbt_Tag
	Name *MinecraftNbt_TagString
	Payload interface{}
	_io *kaitai.Stream
	_root *MinecraftNbt
	_parent kaitai.Struct
	_f_isTagEnd bool
	isTagEnd bool
}
func NewMinecraftNbt_NamedTag() *MinecraftNbt_NamedTag {
	return &MinecraftNbt_NamedTag{
	}
}

func (this MinecraftNbt_NamedTag) IO_() *kaitai.Stream {
	return this._io
}

func (this *MinecraftNbt_NamedTag) Read(io *kaitai.Stream, parent kaitai.Struct, root *MinecraftNbt) (err error) {
	this._io = io
	this._parent = parent
	this._root = root

	tmp5, err := this._io.ReadU1()
	if err != nil {
		return err
	}
	this.Type = MinecraftNbt_Tag(tmp5)
	tmp6, err := this.IsTagEnd()
	if err != nil {
		return err
	}
	if (!(tmp6)) {
		tmp7 := NewMinecraftNbt_TagString()
		err = tmp7.Read(this._io, this, this._root)
		if err != nil {
			return err
		}
		this.Name = tmp7
	}
	tmp8, err := this.IsTagEnd()
	if err != nil {
		return err
	}
	if (!(tmp8)) {
		switch (this.Type) {
		case MinecraftNbt_Tag__Byte:
			tmp9, err := this._io.ReadS1()
			if err != nil {
				return err
			}
			this.Payload = tmp9
		case MinecraftNbt_Tag__ByteArray:
			tmp10 := NewMinecraftNbt_TagByteArray()
			err = tmp10.Read(this._io, this, this._root)
			if err != nil {
				return err
			}
			this.Payload = tmp10
		case MinecraftNbt_Tag__Compound:
			tmp11 := NewMinecraftNbt_TagCompound()
			err = tmp11.Read(this._io, this, this._root)
			if err != nil {
				return err
			}
			this.Payload = tmp11
		case MinecraftNbt_Tag__Double:
			tmp12, err := this._io.ReadF8be()
			if err != nil {
				return err
			}
			this.Payload = tmp12
		case MinecraftNbt_Tag__Float:
			tmp13, err := this._io.ReadF4be()
			if err != nil {
				return err
			}
			this.Payload = tmp13
		case MinecraftNbt_Tag__Int:
			tmp14, err := this._io.ReadS4be()
			if err != nil {
				return err
			}
			this.Payload = tmp14
		case MinecraftNbt_Tag__IntArray:
			tmp15 := NewMinecraftNbt_TagIntArray()
			err = tmp15.Read(this._io, this, this._root)
			if err != nil {
				return err
			}
			this.Payload = tmp15
		case MinecraftNbt_Tag__List:
			tmp16 := NewMinecraftNbt_TagList()
			err = tmp16.Read(this._io, this, this._root)
			if err != nil {
				return err
			}
			this.Payload = tmp16
		case MinecraftNbt_Tag__Long:
			tmp17, err := this._io.ReadS8be()
			if err != nil {
				return err
			}
			this.Payload = tmp17
		case MinecraftNbt_Tag__LongArray:
			tmp18 := NewMinecraftNbt_TagLongArray()
			err = tmp18.Read(this._io, this, this._root)
			if err != nil {
				return err
			}
			this.Payload = tmp18
		case MinecraftNbt_Tag__Short:
			tmp19, err := this._io.ReadS2be()
			if err != nil {
				return err
			}
			this.Payload = tmp19
		case MinecraftNbt_Tag__String:
			tmp20 := NewMinecraftNbt_TagString()
			err = tmp20.Read(this._io, this, this._root)
			if err != nil {
				return err
			}
			this.Payload = tmp20
		}
	}
	return err
}
func (this *MinecraftNbt_NamedTag) IsTagEnd() (v bool, err error) {
	if (this._f_isTagEnd) {
		return this.isTagEnd, nil
	}
	this._f_isTagEnd = true
	this.isTagEnd = bool(this.Type == MinecraftNbt_Tag__End)
	return this.isTagEnd, nil
}
type MinecraftNbt_TagByteArray struct {
	LenData int32
	Data []byte
	_io *kaitai.Stream
	_root *MinecraftNbt
	_parent kaitai.Struct
}
func NewMinecraftNbt_TagByteArray() *MinecraftNbt_TagByteArray {
	return &MinecraftNbt_TagByteArray{
	}
}

func (this MinecraftNbt_TagByteArray) IO_() *kaitai.Stream {
	return this._io
}

func (this *MinecraftNbt_TagByteArray) Read(io *kaitai.Stream, parent kaitai.Struct, root *MinecraftNbt) (err error) {
	this._io = io
	this._parent = parent
	this._root = root

	tmp21, err := this._io.ReadS4be()
	if err != nil {
		return err
	}
	this.LenData = int32(tmp21)
	tmp22, err := this._io.ReadBytes(int(this.LenData))
	if err != nil {
		return err
	}
	tmp22 = tmp22
	this.Data = tmp22
	return err
}
type MinecraftNbt_TagCompound struct {
	Tags []*MinecraftNbt_NamedTag
	_io *kaitai.Stream
	_root *MinecraftNbt
	_parent kaitai.Struct
	_f_dumpNumTags bool
	dumpNumTags int
}
func NewMinecraftNbt_TagCompound() *MinecraftNbt_TagCompound {
	return &MinecraftNbt_TagCompound{
	}
}

func (this MinecraftNbt_TagCompound) IO_() *kaitai.Stream {
	return this._io
}

func (this *MinecraftNbt_TagCompound) Read(io *kaitai.Stream, parent kaitai.Struct, root *MinecraftNbt) (err error) {
	this._io = io
	this._parent = parent
	this._root = root

	for i := 1;; i++ {
		tmp23 := NewMinecraftNbt_NamedTag()
		err = tmp23.Read(this._io, this, this._root)
		if err != nil {
			return err
		}
		_it := tmp23
		this.Tags = append(this.Tags, _it)
		tmp24, err := _it.IsTagEnd()
		if err != nil {
			return err
		}
		if tmp24 {
			break
		}
	}
	return err
}
func (this *MinecraftNbt_TagCompound) DumpNumTags() (v int, err error) {
	if (this._f_dumpNumTags) {
		return this.dumpNumTags, nil
	}
	this._f_dumpNumTags = true
	var tmp25 int8;
	tmp26 := this.Tags
	tmp27, err := tmp26[len(tmp26) - 1].IsTagEnd()
	if err != nil {
		return 0, err
	}
	if ( ((len(this.Tags) >= 1) && (tmp27)) ) {
		tmp25 = 1
	} else {
		tmp25 = 0
	}
	this.dumpNumTags = int(len(this.Tags) - tmp25)
	return this.dumpNumTags, nil
}
type MinecraftNbt_TagIntArray struct {
	NumTags int32
	Tags []int32
	_io *kaitai.Stream
	_root *MinecraftNbt
	_parent kaitai.Struct
	_f_tagsType bool
	tagsType MinecraftNbt_Tag
}
func NewMinecraftNbt_TagIntArray() *MinecraftNbt_TagIntArray {
	return &MinecraftNbt_TagIntArray{
	}
}

func (this MinecraftNbt_TagIntArray) IO_() *kaitai.Stream {
	return this._io
}

func (this *MinecraftNbt_TagIntArray) Read(io *kaitai.Stream, parent kaitai.Struct, root *MinecraftNbt) (err error) {
	this._io = io
	this._parent = parent
	this._root = root

	tmp28, err := this._io.ReadS4be()
	if err != nil {
		return err
	}
	this.NumTags = int32(tmp28)
	for i := 0; i < int(this.NumTags); i++ {
		_ = i
		tmp29, err := this._io.ReadS4be()
		if err != nil {
			return err
		}
		this.Tags = append(this.Tags, tmp29)
	}
	return err
}
func (this *MinecraftNbt_TagIntArray) TagsType() (v MinecraftNbt_Tag, err error) {
	if (this._f_tagsType) {
		return this.tagsType, nil
	}
	this._f_tagsType = true
	this.tagsType = MinecraftNbt_Tag(MinecraftNbt_Tag__Int)
	return this.tagsType, nil
}
type MinecraftNbt_TagList struct {
	TagsType MinecraftNbt_Tag
	NumTags int32
	Tags []interface{}
	_io *kaitai.Stream
	_root *MinecraftNbt
	_parent kaitai.Struct
}
func NewMinecraftNbt_TagList() *MinecraftNbt_TagList {
	return &MinecraftNbt_TagList{
	}
}

func (this MinecraftNbt_TagList) IO_() *kaitai.Stream {
	return this._io
}

func (this *MinecraftNbt_TagList) Read(io *kaitai.Stream, parent kaitai.Struct, root *MinecraftNbt) (err error) {
	this._io = io
	this._parent = parent
	this._root = root

	tmp30, err := this._io.ReadU1()
	if err != nil {
		return err
	}
	this.TagsType = MinecraftNbt_Tag(tmp30)
	tmp31, err := this._io.ReadS4be()
	if err != nil {
		return err
	}
	this.NumTags = int32(tmp31)
	for i := 0; i < int(this.NumTags); i++ {
		_ = i
		switch (this.TagsType) {
		case MinecraftNbt_Tag__Byte:
			tmp32, err := this._io.ReadS1()
			if err != nil {
				return err
			}
			this.Tags = append(this.Tags, tmp32)
		case MinecraftNbt_Tag__ByteArray:
			tmp33 := NewMinecraftNbt_TagByteArray()
			err = tmp33.Read(this._io, this, this._root)
			if err != nil {
				return err
			}
			this.Tags = append(this.Tags, tmp33)
		case MinecraftNbt_Tag__Compound:
			tmp34 := NewMinecraftNbt_TagCompound()
			err = tmp34.Read(this._io, this, this._root)
			if err != nil {
				return err
			}
			this.Tags = append(this.Tags, tmp34)
		case MinecraftNbt_Tag__Double:
			tmp35, err := this._io.ReadF8be()
			if err != nil {
				return err
			}
			this.Tags = append(this.Tags, tmp35)
		case MinecraftNbt_Tag__Float:
			tmp36, err := this._io.ReadF4be()
			if err != nil {
				return err
			}
			this.Tags = append(this.Tags, tmp36)
		case MinecraftNbt_Tag__Int:
			tmp37, err := this._io.ReadS4be()
			if err != nil {
				return err
			}
			this.Tags = append(this.Tags, tmp37)
		case MinecraftNbt_Tag__IntArray:
			tmp38 := NewMinecraftNbt_TagIntArray()
			err = tmp38.Read(this._io, this, this._root)
			if err != nil {
				return err
			}
			this.Tags = append(this.Tags, tmp38)
		case MinecraftNbt_Tag__List:
			tmp39 := NewMinecraftNbt_TagList()
			err = tmp39.Read(this._io, this, this._root)
			if err != nil {
				return err
			}
			this.Tags = append(this.Tags, tmp39)
		case MinecraftNbt_Tag__Long:
			tmp40, err := this._io.ReadS8be()
			if err != nil {
				return err
			}
			this.Tags = append(this.Tags, tmp40)
		case MinecraftNbt_Tag__LongArray:
			tmp41 := NewMinecraftNbt_TagLongArray()
			err = tmp41.Read(this._io, this, this._root)
			if err != nil {
				return err
			}
			this.Tags = append(this.Tags, tmp41)
		case MinecraftNbt_Tag__Short:
			tmp42, err := this._io.ReadS2be()
			if err != nil {
				return err
			}
			this.Tags = append(this.Tags, tmp42)
		case MinecraftNbt_Tag__String:
			tmp43 := NewMinecraftNbt_TagString()
			err = tmp43.Read(this._io, this, this._root)
			if err != nil {
				return err
			}
			this.Tags = append(this.Tags, tmp43)
		}
	}
	return err
}
type MinecraftNbt_TagLongArray struct {
	NumTags int32
	Tags []int64
	_io *kaitai.Stream
	_root *MinecraftNbt
	_parent kaitai.Struct
	_f_tagsType bool
	tagsType MinecraftNbt_Tag
}
func NewMinecraftNbt_TagLongArray() *MinecraftNbt_TagLongArray {
	return &MinecraftNbt_TagLongArray{
	}
}

func (this MinecraftNbt_TagLongArray) IO_() *kaitai.Stream {
	return this._io
}

func (this *MinecraftNbt_TagLongArray) Read(io *kaitai.Stream, parent kaitai.Struct, root *MinecraftNbt) (err error) {
	this._io = io
	this._parent = parent
	this._root = root

	tmp44, err := this._io.ReadS4be()
	if err != nil {
		return err
	}
	this.NumTags = int32(tmp44)
	for i := 0; i < int(this.NumTags); i++ {
		_ = i
		tmp45, err := this._io.ReadS8be()
		if err != nil {
			return err
		}
		this.Tags = append(this.Tags, tmp45)
	}
	return err
}
func (this *MinecraftNbt_TagLongArray) TagsType() (v MinecraftNbt_Tag, err error) {
	if (this._f_tagsType) {
		return this.tagsType, nil
	}
	this._f_tagsType = true
	this.tagsType = MinecraftNbt_Tag(MinecraftNbt_Tag__Long)
	return this.tagsType, nil
}
type MinecraftNbt_TagString struct {
	LenData uint16
	Data string
	_io *kaitai.Stream
	_root *MinecraftNbt
	_parent kaitai.Struct
}
func NewMinecraftNbt_TagString() *MinecraftNbt_TagString {
	return &MinecraftNbt_TagString{
	}
}

func (this MinecraftNbt_TagString) IO_() *kaitai.Stream {
	return this._io
}

func (this *MinecraftNbt_TagString) Read(io *kaitai.Stream, parent kaitai.Struct, root *MinecraftNbt) (err error) {
	this._io = io
	this._parent = parent
	this._root = root

	tmp46, err := this._io.ReadU2be()
	if err != nil {
		return err
	}
	this.LenData = uint16(tmp46)
	tmp47, err := this._io.ReadBytes(int(this.LenData))
	if err != nil {
		return err
	}
	tmp47 = tmp47
	this.Data = string(tmp47)
	return err
}

/**
 * unsigned according to <https://wiki.vg/NBT#Specification>
 */