A low level parser for the OpenDDL format. It can incrementally parse the structure, individual blocks can be skipped. More...

#include <OpenDdlParser.h>

Inheritance diagram for ezOpenDdlParser:

[legend]

Public Member Functions
bool	HadFatalParsingError () const
	Whether an error occurred during parsing that resulted in cancellation of further parsing.

Protected Member Functions
void	SetLogInterface (ezLogInterface *pLog)
	Sets an ezLogInterface through which errors and warnings are reported.

void	SetCacheSize (ezUInt32 uiSizeInKB)
	Data is returned in larger chunks, to reduce the number of function calls. The cache size determines the maximum chunk size per primitive type. More...

void	SetInputStream (ezStreamReader &stream, ezUInt32 uiFirstLineOffset=0)
	Configures the parser to read from the given stream. This can only be called once on a parser instance.

bool	ContinueParsing ()
	Call this to parse the next piece of the document. This may trigger a callback through which data is returned. More...

ezResult	ParseAll ()
	Calls ContinueParsing() in a loop until that returns false.

void	SkipRestOfObject ()
	Skips the rest of the currently open object. No OnEndObject() call will be done for this object either.

void	StopParsing ()
	Can be used to prevent parsing the rest of the document.

void	ParsingError (ezStringView sMessage, bool bFatal)
	Outputs that a parsing error was detected (via OnParsingError) and stops further parsing, if bFatal is set to true.

virtual void	OnParsingError (ezStringView sMessage, bool bFatal, ezUInt32 uiLine, ezUInt32 uiColumn)
	Called when something unexpected is encountered in the document. More...

virtual void	OnBeginObject (ezStringView sType, ezStringView sName, bool bGlobalName)=0
	Called when a new object is encountered.

virtual void	OnEndObject ()=0
	Called when the end of an object is encountered.

virtual void	OnBeginPrimitiveList (ezOpenDdlPrimitiveType type, ezStringView sName, bool bGlobalName)=0
	Called when a new primitive object is encountered.

virtual void	OnEndPrimitiveList ()=0
	Called when the end of a primitive object is encountered.

virtual void	OnPrimitiveBool (ezUInt32 count, const bool *pData, bool bThisIsAll)=0
	Called when data for a primitive type is available. More than one value may be reported at a time. More...

virtual void	OnPrimitiveInt8 (ezUInt32 count, const ezInt8 *pData, bool bThisIsAll)=0
	Called when data for a primitive type is available. More than one value may be reported at a time.

virtual void	OnPrimitiveInt16 (ezUInt32 count, const ezInt16 *pData, bool bThisIsAll)=0
	Called when data for a primitive type is available. More than one value may be reported at a time.

virtual void	OnPrimitiveInt32 (ezUInt32 count, const ezInt32 *pData, bool bThisIsAll)=0
	Called when data for a primitive type is available. More than one value may be reported at a time.

virtual void	OnPrimitiveInt64 (ezUInt32 count, const ezInt64 *pData, bool bThisIsAll)=0
	Called when data for a primitive type is available. More than one value may be reported at a time.

virtual void	OnPrimitiveUInt8 (ezUInt32 count, const ezUInt8 *pData, bool bThisIsAll)=0
	Called when data for a primitive type is available. More than one value may be reported at a time.

virtual void	OnPrimitiveUInt16 (ezUInt32 count, const ezUInt16 *pData, bool bThisIsAll)=0
	Called when data for a primitive type is available. More than one value may be reported at a time.

virtual void	OnPrimitiveUInt32 (ezUInt32 count, const ezUInt32 *pData, bool bThisIsAll)=0
	Called when data for a primitive type is available. More than one value may be reported at a time.

virtual void	OnPrimitiveUInt64 (ezUInt32 count, const ezUInt64 *pData, bool bThisIsAll)=0
	Called when data for a primitive type is available. More than one value may be reported at a time.

virtual void	OnPrimitiveFloat (ezUInt32 count, const float *pData, bool bThisIsAll)=0
	Called when data for a primitive type is available. More than one value may be reported at a time.

virtual void	OnPrimitiveDouble (ezUInt32 count, const double *pData, bool bThisIsAll)=0
	Called when data for a primitive type is available. More than one value may be reported at a time.

virtual void	OnPrimitiveString (ezUInt32 count, const ezStringView *pData, bool bThisIsAll)=0
	Called when data for a primitive type is available. More than one value may be reported at a time.

Protected Attributes
ezLogInterface *	m_pLogInterface

Detailed Description

A low level parser for the OpenDDL format. It can incrementally parse the structure, individual blocks can be skipped.

The document structure is returned through virtual functions that need to be overridden.

Member Function Documentation

◆ ContinueParsing()

bool ezOpenDdlParser::ContinueParsing ( )

protected

Call this to parse the next piece of the document. This may trigger a callback through which data is returned.

This function returns false when the end of the document has been reached, or a fatal parsing error has been reported.

◆ OnParsingError()

virtual void ezOpenDdlParser::OnParsingError	(	ezStringView	sMessage,
		bool	bFatal,
		ezUInt32	uiLine,
		ezUInt32	uiColumn
	)

inlineprotectedvirtual

Called when something unexpected is encountered in the document.

The error message describes what was expected and what was encountered. If bFatal is true, the error has left the parser in an unrecoverable state and thus it will not continue parsing. In that case client code will need to clean up it's open state, as no further callbacks will be called. If bFatal is false, the document is not entirely valid, but the parser is still able to continue.

Reimplemented in ezOpenDdlReader.

◆ OnPrimitiveBool()

virtual void ezOpenDdlParser::OnPrimitiveBool	(	ezUInt32	count,
		const bool *	pData,
		bool	bThisIsAll
	)

protectedpure virtual

Called when data for a primitive type is available. More than one value may be reported at a time.

Todo:: Currently not supported

Implemented in ezOpenDdlReader.

◆ SetCacheSize()

void ezOpenDdlParser::SetCacheSize ( ezUInt32 uiSizeInKB )

protected

Data is returned in larger chunks, to reduce the number of function calls. The cache size determines the maximum chunk size per primitive type.

Default cache size is 4 KB. That means up to 1000 integers may be returned in one chunk (or 500 doubles). It does not help to increase the chunk size, when the input data doesn't use such large data lists.

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

/home/runner/work/ezEngine/ezEngine/Code/Engine/Foundation/IO/OpenDdlParser.h
/home/runner/work/ezEngine/ezEngine/Code/Engine/Foundation/IO/Implementation/OpenDdlParser.cpp

Public Member Functions