Simple implementation of archive writing to own ACF format binary file. More...

#include <CFileWriteArchive.h>

Inheritance diagram for ifile::CFileWriteArchive:

Classes
struct	TagStackElement

Public Types
typedef iser::CBinaryWriteArchiveBase	BaseClass

typedef CFileArchiveInfo	BaseClass2

Public Types inherited from iser::CBinaryWriteArchiveBase
typedef CWriteArchiveBase	BaseClass

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

Public Member Functions
	CFileWriteArchive (const QString &filePath, const iser::IVersionInfo *versionInfoPtr=NULL, bool supportTagSkipping=true, bool serializeHeader=true)
	Contructor.

bool	IsArchiveValid () const
	Return `true` if the archive is valid (e.g.

void	Flush ()
	Force internal stream object to flush.

virtual bool	IsTagSkippingSupported () const override
	Checks if skipping to the end of a tag on EndTag() is supported.

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

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

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

Public Member Functions inherited from iser::CBinaryWriteArchiveBase
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	Process (QString &value) override
	Process primitive type.

Public Member Functions inherited from iser::CWriteArchiveBase
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	BeginMultiTag (const CArchiveTag &tag, const CArchiveTag &subTag, int &count) override
	Begins a tagged section containing multiple elements of the same type.

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 ()

Public Member Functions inherited from ifile::CFileArchiveInfo
	CFileArchiveInfo (const QString &filePath)

virtual const QString &	GetCurrentFilePath () const override

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

Protected Member Functions inherited from iser::CBinaryWriteArchiveBase
	CBinaryWriteArchiveBase (const IVersionInfo *versionInfoPtr)

Protected Member Functions inherited from iser::CWriteArchiveBase
	CWriteArchiveBase (const IVersionInfo *versionInfoPtr)
	Constructor.

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 inherited from ifile::CFileArchiveInfo
QString	m_filePath

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

Detailed Description

Simple implementation of archive writing to own ACF format binary file.

This imlementation is very fast and efficient and should be used if any standarized file format is needed.

Definition at line 24 of file CFileWriteArchive.h.

Member Typedef Documentation

◆ BaseClass

typedef iser::CBinaryWriteArchiveBase ifile::CFileWriteArchive::BaseClass

Definition at line 29 of file CFileWriteArchive.h.

◆ BaseClass2

typedef CFileArchiveInfo ifile::CFileWriteArchive::BaseClass2

Definition at line 30 of file CFileWriteArchive.h.

Constructor & Destructor Documentation

◆ CFileWriteArchive()

ifile::CFileWriteArchive::CFileWriteArchive	(	const QString &	filePath,
		const iser::IVersionInfo *	versionInfoPtr = `NULL`,
		bool	supportTagSkipping = `true`,
		bool	serializeHeader = `true`
	)

Contructor.

Parameters

filePath	name of file.
supportTagSkipping	if it is true skipping of tags on EndTag is supported. Please note that supporting of tag skipping store additional data in file and it is not compatible with files created without tag skipping.

See also: EndTag and IsTagSkippingSupported.

Parameters

serializeHeader if it is true (default) archive header will be serialized.

Member Function Documentation

◆ BeginTag()

virtual bool ifile::CFileWriteArchive::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

Reimplemented from iser::CBinaryWriteArchiveBase.

◆ EndTag()

virtual bool ifile::CFileWriteArchive::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()

Reimplemented from iser::CBinaryWriteArchiveBase.

◆ Flush()

void ifile::CFileWriteArchive::Flush ( )

Force internal stream object to flush.

◆ IsArchiveValid()

bool ifile::CFileWriteArchive::IsArchiveValid ( ) const

inline

Return true if the archive is valid (e.g.

the file medium can be accessed)

Definition at line 85 of file CFileWriteArchive.h.

◆ IsTagSkippingSupported()

virtual bool ifile::CFileWriteArchive::IsTagSkippingSupported ( ) const

overridevirtual

Checks if skipping to the end of a tag on EndTag() is supported.

Some archive types (like XML) support skipping unread content within a tag, allowing forward compatibility. When reading an archive created by a newer version that added fields, this feature lets you skip unknown data.

Returns: true if the archive supports tag skipping, false otherwise

Note: Binary archives typically don't support skipping, requiring all data to be read sequentially.; XML and JSON archives usually support skipping.

if (archive.IsTagSkippingSupported()) {
       // Can safely skip new fields added in future versions
} else {
       // Must read all data in exact order
}

See also: EndTag()

Reimplemented from iser::CArchiveBase.

◆ ProcessData()

virtual bool ifile::CFileWriteArchive::ProcessData	(	void *	dataPtr,
		int	size
	)

overridevirtual

Process binary data block.

Parameters

dataPtr	pointer to memory block.
size	size of memory block in bytes.

Implements iser::IArchive.

Reimplemented in ifile::CFileWriteSecureArchive.

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

Acf/Include/ifile/CFileWriteArchive.h

Classes

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ BaseClass

◆ BaseClass2

Constructor & Destructor Documentation

◆ CFileWriteArchive()

Member Function Documentation

◆ BeginTag()

◆ EndTag()

◆ Flush()

◆ IsArchiveValid()

◆ IsTagSkippingSupported()

◆ ProcessData()