Implementation of an ACF archive deserializing from a JSON string. More...

#include <CJsonReadArchiveBase.h>

Inheritance diagram for iser::CJsonReadArchiveBase:

Classes
class	HelperIterator

Public Types
typedef CTextReadArchiveBase	BaseClass

Public Types inherited from iser::CTextReadArchiveBase
typedef CReadArchiveBase	BaseClass

Public Types inherited from iser::IArchive
enum	MessageId { MI_TAG_ERROR = 0x3f320a0 , MI_TAG_SKIPPED }

Public Member Functions
	CJsonReadArchiveBase (bool serializeHeader=true, const iser::CArchiveTag &rootTag=s_acfRootTag)

virtual bool	BeginTag (const iser::CArchiveTag &tag) override
	Begins a tagged section in the archive.

virtual bool	BeginMultiTag (const iser::CArchiveTag &tag, const iser::CArchiveTag &subTag, int &count) override
	Begins a tagged section containing multiple elements of the same type.

virtual bool	EndTag (const iser::CArchiveTag &tag) override
	Ends a tagged section in the archive.

virtual bool	Process (QString &value) override
	Process primitive type.

Public Member Functions inherited from iser::CTextReadArchiveBase
virtual bool	Process (bool &value) override
	Processes (reads or writes) a boolean value.

virtual bool	Process (char &value) override
	Process primitive type.

virtual bool	Process (quint8 &value) override
	Process primitive type.

virtual bool	Process (qint8 &value) override
	Process primitive type.

virtual bool	Process (quint16 &value) override
	Process primitive type.

virtual bool	Process (qint16 &value) override
	Process primitive type.

virtual bool	Process (quint32 &value) override
	Process primitive type.

virtual bool	Process (qint32 &value) override
	Process primitive type.

virtual bool	Process (quint64 &value) override
	Process primitive type.

virtual bool	Process (qint64 &value) override
	Process primitive type.

virtual bool	Process (float &value) override
	Process primitive type.

virtual bool	Process (double &value) override
	Process primitive type.

virtual bool	Process (QByteArray &value) override
	Process primitive type.

virtual bool	ProcessData (void *dataPtr, int size) override
	Process binary data block.

Public Member Functions inherited from iser::CReadArchiveBase
virtual bool	IsStoring () const override
	Checks if this archive is in storing (writing) or loading (reading) mode.

virtual const IVersionInfo &	GetVersionInfo () const override
	Gets version information for the archived stream.

virtual bool	ProcessBits (void *dataPtr, int bitsCount, int bytesCount) override
	Process binary data block.

Public Member Functions inherited from iser::CArchiveBase
virtual bool	IsTagSkippingSupported () const override
	Checks if skipping to the end of a tag on EndTag() is supported.

Public Member Functions inherited from iser::IArchive
template<typename Primitive >
bool	TagAndProcess (const CArchiveTag &tag, Primitive &value)

Public Member Functions inherited from istd::IPolymorphic
virtual	~IPolymorphic ()

Protected Member Functions
bool	SetContent (QIODevice *devicePtr)

bool	ReadStringNode (QString &text)

virtual bool	ReadTextNode (QByteArray &text) override
	Read single unformatted text node.

Protected Member Functions inherited from iser::CReadArchiveBase
bool	SerializeAcfHeader ()
	Serialize standard header.

Protected Member Functions inherited from iser::CArchiveBase
	CArchiveBase ()

Protected Member Functions inherited from istd::ILogger
virtual void	DecorateMessage (IInformationProvider::InformationCategory category, int id, int flags, QString &message, QString &messageSource) const
	Decorate message parts before outputting.

virtual bool	IsLogConsumed (const IInformationProvider::InformationCategory categoryPtr=NULL, const int flagsPtr=NULL) const
	Check if any log message is consumed.

virtual bool	SendLogMessage (IInformationProvider::InformationCategory category, int id, const QString &message, const QString &messageSource, int flags=0) const
	Send any message to log.

Protected Attributes
QJsonDocument	m_document

QList< HelperIterator >	m_iterators

QList< const iser::CArchiveTag * >	m_tags

iser::CArchiveTag	m_rootTag

bool	m_rootTagEnabled

bool	m_serializeHeader

Additional Inherited Members
Static Public Member Functions inherited from iser::CArchiveBase
static const CArchiveTag &	GetAcfRootTag ()

Static Protected Attributes inherited from iser::CArchiveBase
static CArchiveTag	s_acfRootTag

Detailed Description

Implementation of an ACF archive deserializing from a JSON string.

Note: As to simplify decoding of some more complicated data structures support for special annotation tags was added. They are used for guiding the deserialization algorithm in some special cases.

Definition at line 27 of file CJsonReadArchiveBase.h.

Member Typedef Documentation

◆ BaseClass

typedef CTextReadArchiveBase iser::CJsonReadArchiveBase::BaseClass

Definition at line 30 of file CJsonReadArchiveBase.h.

Constructor & Destructor Documentation

◆ CJsonReadArchiveBase()

iser::CJsonReadArchiveBase::CJsonReadArchiveBase	(	bool	serializeHeader = `true`,
		const iser::CArchiveTag &	rootTag = `s_acfRootTag`
	)

Member Function Documentation

◆ BeginMultiTag()

virtual bool iser::CJsonReadArchiveBase::BeginMultiTag	(	const iser::CArchiveTag &	tag,
		const iser::CArchiveTag &	subTag,
		int &	count
	)

overridevirtual

Begins a tagged section containing multiple elements of the same type.

BeginMultiTag is used for serializing collections, arrays, or lists where you have multiple items of the same structure. The count parameter works differently for reading vs. writing:

Writing: Pass the number of elements you will serialize
Reading: The archive sets count to the number of elements stored

Parameters

tag	Main container tag for the entire collection
subTag	Tag type for each individual element in the collection
count	[in/out] For writing: number of elements to serialize For reading: set by archive to number of stored elements

Returns: true if successful, false on error

// Writing a list
if (archive.IsStoring()) {
       int count = m_items.count();
       archive.BeginMultiTag(listTag, itemTag, count);
       for (const Item& item : m_items) {
              archive.BeginTag(itemTag);
              item.Serialize(archive);
              archive.EndTag(itemTag);
       }
       archive.EndTag(listTag);
}
// Reading a list
else {
       int count;
       archive.BeginMultiTag(listTag, itemTag, count);
       m_items.clear();
       for (int i = 0; i < count; ++i) {
              archive.BeginTag(itemTag);
              Item item;
              item.Serialize(archive);
              m_items.append(item);
              archive.EndTag(itemTag);
       }
       archive.EndTag(listTag);
}

See also: BeginTag(), EndTag()

Reimplemented from iser::CArchiveBase.

◆ BeginTag()

virtual bool iser::CJsonReadArchiveBase::BeginTag ( const iser::CArchiveTag & tag )

overridevirtual

Begins a tagged section in the archive.

Tags organize data into logical units with names and descriptions. Every BeginTag() must be matched with an EndTag() call. Tags can be nested to create hierarchical data structures.

Parameters

tag	The tag object describing this section. Use static CArchiveTag instances to avoid repeated construction overhead.

Returns: true if the tag was successfully opened, false on error

Note: Always match BeginTag() with EndTag(); Check the return value and propagate errors; For collections, use BeginMultiTag() instead

static iser::CArchiveTag personTag("Person", "Person data");
if (archive.BeginTag(personTag)) {
       archive.Process(name);
       archive.Process(age);
       archive.EndTag(personTag);
}

See also: EndTag(), BeginMultiTag(), CArchiveTag

Implements iser::IArchive.

◆ EndTag()

virtual bool iser::CJsonReadArchiveBase::EndTag ( const iser::CArchiveTag & tag )

overridevirtual

Ends a tagged section in the archive.

Must be called after BeginTag() or BeginMultiTag() to close the section. If tag skipping is supported and not all data was read, this will skip to the end of the tag section, enabling forward compatibility.

Parameters

tag	The same tag object passed to BeginTag() or BeginMultiTag()

Returns: true if successful, false on error

Note: Always call EndTag() even if errors occurred within the tag; The tag parameter must match the one used in BeginTag(); If IsTagSkippingSupported() returns false, you must read all data before calling EndTag()

static iser::CArchiveTag dataTag("Data", "My data");
if (archive.BeginTag(dataTag)) {
       bool success = archive.Process(myData);
       archive.EndTag(dataTag);  // Always call, even if Process failed
       if (!success) return false;
}

See also: BeginTag(), BeginMultiTag(), IsTagSkippingSupported()

Implements iser::IArchive.

◆ Process()

virtual bool iser::CJsonReadArchiveBase::Process ( QString & value )

overridevirtual

Process primitive type.

Implements iser::IArchive.

◆ ReadStringNode()

bool iser::CJsonReadArchiveBase::ReadStringNode ( QString & text )

protected

◆ ReadTextNode()

virtual bool iser::CJsonReadArchiveBase::ReadTextNode ( QByteArray & text )

overrideprotectedvirtual

Read single unformatted text node.

Implements iser::CTextReadArchiveBase.

◆ SetContent()

bool iser::CJsonReadArchiveBase::SetContent ( QIODevice * devicePtr )

protected

Member Data Documentation

◆ m_document

QJsonDocument iser::CJsonReadArchiveBase::m_document

protected

Definition at line 51 of file CJsonReadArchiveBase.h.

◆ m_iterators

QList<HelperIterator> iser::CJsonReadArchiveBase::m_iterators

protected

Definition at line 75 of file CJsonReadArchiveBase.h.

◆ m_rootTag

iser::CArchiveTag iser::CJsonReadArchiveBase::m_rootTag

protected

Definition at line 77 of file CJsonReadArchiveBase.h.

◆ m_rootTagEnabled

bool iser::CJsonReadArchiveBase::m_rootTagEnabled

protected

Definition at line 78 of file CJsonReadArchiveBase.h.

◆ m_serializeHeader

bool iser::CJsonReadArchiveBase::m_serializeHeader

protected

Definition at line 79 of file CJsonReadArchiveBase.h.

◆ m_tags

QList<const iser::CArchiveTag*> iser::CJsonReadArchiveBase::m_tags

protected

Definition at line 76 of file CJsonReadArchiveBase.h.

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

Acf/Include/iser/CJsonReadArchiveBase.h

Classes

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ BaseClass

Constructor & Destructor Documentation

◆ CJsonReadArchiveBase()

Member Function Documentation

◆ BeginMultiTag()

◆ BeginTag()

◆ EndTag()

◆ Process()

◆ ReadStringNode()

◆ ReadTextNode()

◆ SetContent()

Member Data Documentation

◆ m_document

◆ m_iterators

◆ m_rootTag

◆ m_rootTagEnabled

◆ m_serializeHeader

◆ m_tags