XML input archive. More...

#include <Urho3D/Resource/XMLArchive.h>

Inheritance diagram for Urho3D::XMLInputArchive:

Public Member Functions
	XMLInputArchive (Context context, XMLElement element, const XMLFile xmlFile=nullptr, bool serializeRootName=false)
	Construct from element.

	XMLInputArchive (const XMLFile *xmlFile)
	Construct from file.

Archive implementation
void	BeginBlock (const char *name, unsigned &sizeHint, bool safe, ArchiveBlockType type) final

void	Serialize (const char *name, bool &value) final

void	Serialize (const char *name, signed char &value) final

void	Serialize (const char *name, unsigned char &value) final

void	Serialize (const char *name, short &value) final

void	Serialize (const char *name, unsigned short &value) final

void	Serialize (const char *name, int &value) final

void	Serialize (const char *name, unsigned int &value) final

void	Serialize (const char *name, long long &value) final

void	Serialize (const char *name, unsigned long long &value) final

void	Serialize (const char *name, float &value) final

void	Serialize (const char *name, double &value) final

void	Serialize (const char *name, ea::string &value) final

void	SerializeBytes (const char name, void bytes, unsigned size) final
	Serialize bytes. Size is not encoded and should be provided externally!

void	SerializeVLE (const char *name, unsigned &value) final
	Serialize Variable Length Encoded unsigned integer, up to 29 significant bits.

Public Member Functions inherited from Urho3D::XMLArchiveBase< XMLInputArchiveBlock, true >
ea::string_view	GetName () const
	Return name of the archive if applicable.

Public Member Functions inherited from Urho3D::ArchiveBaseT< BlockType, IsInputBool, IsHumanReadableBool >
bool	IsInput () const final

bool	IsHumanReadable () const final

bool	IsUnorderedAccessSupportedInCurrentBlock () const final

bool	HasElementOrBlock (const char *name) const final

ea::string	GetCurrentBlockPath () const final
	Return current string stack.

void	EndBlock () noexcept override
	End archive block. May postpone ArchiveException until later.

Public Member Functions inherited from Urho3D::ArchiveBase
Context *	GetContext () final
	Get context.

unsigned	GetChecksum () override
	Return a checksum if applicable.

bool	IsEOF () const final
	Whether the archive can no longer be serialized.

void	Flush () final
	Flush all pending events. Should be called at least once before destructor.

unsigned	SerializeVersion (unsigned version) final
	Serialize version number. 0 is invalid version.

ArchiveException	IOFailureException (ea::string_view elementName) const

ArchiveException	DuplicateElementException (ea::string_view elementName) const

ArchiveException	ElementNotFoundException (ea::string_view elementName) const

ArchiveException	ElementNotFoundException (ea::string_view elementName, unsigned elementIndex) const

ArchiveException	UnexpectedElementValueException (ea::string_view elementName) const

ArchiveException	UnexpectedEOFException (ea::string_view elementName) const

Public Member Functions inherited from Urho3D::Archive
ArchiveBlock	OpenBlock (const char *name, unsigned sizeHint, bool safe, ArchiveBlockType type)

ArchiveBlock	OpenSequentialBlock (const char *name)
	Open Sequential block. Will be automatically closed when returned object is destroyed.

ArchiveBlock	OpenUnorderedBlock (const char *name)
	Open Unordered block. Will be automatically closed when returned object is destroyed.

ArchiveBlock	OpenArrayBlock (const char *name, unsigned sizeHint=0)
	Open Array block. Will be automatically closed when returned object is destroyed.

ArchiveBlock	OpenSafeSequentialBlock (const char *name)
	Open safe Sequential block. Will be automatically closed when returned object is destroyed.

ArchiveBlock	OpenSafeUnorderedBlock (const char *name)
	Open safe Unordered block. Will be automatically closed when returned object is destroyed.

Private Member Functions
XMLAttributeReference	ReadElementOrAttribute (const char *name)

Additional Inherited Members
Static Public Member Functions inherited from Urho3D::Archive
static bool	ValidateName (ea::string_view name)
	Validate element or block name.

Protected Types inherited from Urho3D::ArchiveBaseT< BlockType, IsInputBool, IsHumanReadableBool >
using	Block = BlockType

Protected Member Functions inherited from Urho3D::XMLArchiveBase< XMLInputArchiveBlock, true >
	XMLArchiveBase (Context context, XMLElement element, const XMLFile xmlFile, bool serializeRootName)

Protected Member Functions inherited from Urho3D::ArchiveBaseT< BlockType, IsInputBool, IsHumanReadableBool >
Block &	GetCurrentBlock ()

const Block &	GetCurrentBlock () const

void	CheckIfRootBlockOpen () const

void	CheckBeforeBlock (const char *elementName)

void	CheckBeforeElement (const char *elementName)

	ArchiveBase (Context *context)

Protected Member Functions inherited from Urho3D::ArchiveBase
	ArchiveBase (Context *context)

void	SetDelayedException (std::exception_ptr ptr)

void	FlushDelayedException ()

void	CheckIfNotEOF (ea::string_view elementName) const

void	CheckBlockOrElementName (ea::string_view elementName) const

void	CloseArchive ()

void	ReadBytesFromHexString (ea::string_view elementName, const ea::string &string, void *bytes, unsigned size)

Protected Member Functions inherited from Urho3D::MovableNonCopyable
	MovableNonCopyable (MovableNonCopyable &&other)=default

MovableNonCopyable &	operator= (MovableNonCopyable &&other)=default

	MovableNonCopyable (const MovableNonCopyable &other)=delete

MovableNonCopyable &	operator= (const MovableNonCopyable &other)=delete

Protected Attributes inherited from Urho3D::XMLArchiveBase< XMLInputArchiveBlock, true >
XMLElement	rootElement_

const bool	serializeRootName_

Protected Attributes inherited from Urho3D::ArchiveBaseT< BlockType, IsInputBool, IsHumanReadableBool >
ea::vector< Block >	stack_

Static Protected Attributes inherited from Urho3D::ArchiveBase
static constexpr const char *	rootBlockName = "Root"

static constexpr const char *	versionElementName = "Version"

Detailed Description

XML input archive.

Member Function Documentation

◆ BeginBlock()

void Urho3D::XMLInputArchive::BeginBlock	(	const char *	name,
		unsigned &	sizeHint,
		bool	safe,
		ArchiveBlockType	type
	)

finalvirtual

Begin archive block. Size is required for Array blocks. It is guaranteed that errors occurred during serialization of the safe block don't affect data outside of the block.

Implements Urho3D::Archive.

◆ Serialize() [1/12]

void Urho3D::XMLInputArchive::Serialize	(	const char *	name,
		bool &	value
	)

finalvirtual

Implements Urho3D::Archive.

◆ Serialize() [2/12]

void Urho3D::XMLInputArchive::Serialize	(	const char *	name,
		double &	value
	)

finalvirtual

Implements Urho3D::Archive.

◆ Serialize() [3/12]

void Urho3D::XMLInputArchive::Serialize	(	const char *	name,
		ea::string &	value
	)

finalvirtual

Implements Urho3D::Archive.

◆ Serialize() [4/12]

void Urho3D::XMLInputArchive::Serialize	(	const char *	name,
		float &	value
	)

finalvirtual

Implements Urho3D::Archive.

◆ Serialize() [5/12]

void Urho3D::XMLInputArchive::Serialize	(	const char *	name,
		int &	value
	)

finalvirtual

Implements Urho3D::Archive.

◆ Serialize() [6/12]

void Urho3D::XMLInputArchive::Serialize	(	const char *	name,
		long long &	value
	)

finalvirtual

Implements Urho3D::Archive.

◆ Serialize() [7/12]

void Urho3D::XMLInputArchive::Serialize	(	const char *	name,
		short &	value
	)

finalvirtual

Implements Urho3D::Archive.

◆ Serialize() [8/12]

void Urho3D::XMLInputArchive::Serialize	(	const char *	name,
		signed char &	value
	)

finalvirtual

Implements Urho3D::Archive.

◆ Serialize() [9/12]

void Urho3D::XMLInputArchive::Serialize	(	const char *	name,
		unsigned char &	value
	)

finalvirtual

Implements Urho3D::Archive.

◆ Serialize() [10/12]

void Urho3D::XMLInputArchive::Serialize	(	const char *	name,
		unsigned int &	value
	)

finalvirtual

Implements Urho3D::Archive.

◆ Serialize() [11/12]

void Urho3D::XMLInputArchive::Serialize	(	const char *	name,
		unsigned long long &	value
	)

finalvirtual

Implements Urho3D::Archive.

◆ Serialize() [12/12]

void Urho3D::XMLInputArchive::Serialize	(	const char *	name,
		unsigned short &	value
	)

finalvirtual

Implements Urho3D::Archive.

◆ SerializeBytes()

void Urho3D::XMLInputArchive::SerializeBytes	(	const char *	name,
		void *	bytes,
		unsigned	size
	)

finalvirtual

Serialize bytes. Size is not encoded and should be provided externally!

Implements Urho3D::Archive.

◆ SerializeVLE()

void Urho3D::XMLInputArchive::SerializeVLE	(	const char *	name,
		unsigned &	value
	)

finalvirtual

Serialize Variable Length Encoded unsigned integer, up to 29 significant bits.

Implements Urho3D::Archive.

The documentation for this class was generated from the following files:

Urho3D/Resource/XMLArchive.h
Urho3D/Resource/XMLArchive.cpp

Public Member Functions

Private Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ BeginBlock()

◆ Serialize() [1/12]

◆ Serialize() [2/12]

◆ Serialize() [3/12]

◆ Serialize() [4/12]

◆ Serialize() [5/12]

◆ Serialize() [6/12]

◆ Serialize() [7/12]

◆ Serialize() [8/12]

◆ Serialize() [9/12]

◆ Serialize() [10/12]

◆ Serialize() [11/12]

◆ Serialize() [12/12]

◆ SerializeBytes()

◆ SerializeVLE()