ezEngine  Milestone 7
ezJSONReader Class Reference

This JSON reader will read an entire JSON document into a hierarchical structure of ezVariants. More...

#include <JSONReader.h>

Inheritance diagram for ezJSONReader:

Classes

struct  Element
 

Public Member Functions

ezResult Parse (ezStreamReaderBase &pInput, ezUInt32 uiFirstLineOffset=0)
 Reads the entire stream and creates the internal data structure that represents the JSON document. Returns EZ_FAILURE if any parsing error occurred.
 
const ezVariantDictionaryGetTopLevelObject () const
 Returns the top-level object of the JSON document.
 
- Public Member Functions inherited from ezJSONParser
 ezJSONParser ()
 Constructor.
 
void SetLogInterface (ezLogInterface *pLog)
 Allows to specify an ezLogInterface through which errors and warnings are reported.
 

Protected Types

enum  ElementMode : ezInt8 { Array, Dictionary }
 

Protected Attributes

ezHybridArray< Element, 32 > m_Stack
 
bool m_bParsingError
 
ezString m_sLastName
 
- Protected Attributes inherited from ezJSONParser
ezLogInterfacem_pLogInterface
 

Private Member Functions

virtual bool OnVariable (const char *szVarName) override
 This function can be overridden to skip certain variables, however the overriding function must still call this.
 
virtual void OnReadValue (const char *szValue) override
 [internal] Do not override further.
 
virtual void OnReadValue (double fValue) override
 [internal] Do not override further.
 
virtual void OnReadValue (bool bValue) override
 [internal] Do not override further.
 
virtual void OnReadValueNULL () override
 [internal] Do not override further.
 
virtual void OnBeginObject () override
 [internal] Do not override further.
 
virtual void OnEndObject () override
 [internal] Do not override further.
 
virtual void OnBeginArray () override
 [internal] Do not override further.
 
virtual void OnEndArray () override
 [internal] Do not override further.
 
virtual void OnParsingError (const char *szMessage, bool bFatal, ezUInt32 uiLine, ezUInt32 uiColumn) override
 Called when something unexpected is encountered in the JSON document. More...
 

Additional Inherited Members

- Protected Member Functions inherited from ezJSONParser
void SetInputStream (ezStreamReaderBase &stream, ezUInt32 uiFirstLineOffset=0)
 Resets the parser to the start state and configures it to read from the given stream.
 
bool ContinueParsing ()
 Does one parsing step. More...
 
void ParseAll ()
 Calls ContinueParsing() in a loop until that returns false.
 
void SkipObject ()
 Skips the rest of the currently open object. No OnEndArray() and OnEndObject() calls will be done for this object, cleanup must be done manually.
 
void SkipArray ()
 Skips the rest of the currently open array. No OnEndArray() and OnEndObject() calls will be done for this object, cleanup must be done manually.
 
void ParsingError (const char *szMessage, bool bFatal)
 Outputs that a parsing error was detected (via OnParsingError) and stops further parsing, if bFatal is set to true.
 

Detailed Description

This JSON reader will read an entire JSON document into a hierarchical structure of ezVariants.

The reader will parse the entire document and create a data structure of ezVariants, which can then be traversed easily. Note that this class is much less efficient at reading large JSON documents, as it will dynamically allocate and copy objects around quite a bit. For small to medium sized documents that might be good enough, for large files one should prefer to write a dedicated class derived from ezJSONParser.


Class Documentation

struct ezJSONReader::Element
Class Members
ezVariantArray m_Array
ezVariantDictionary m_Dictionary
ElementMode m_Mode
ezString m_sName

Member Function Documentation

virtual void ezJSONReader::OnParsingError ( const char *  szMessage,
bool  bFatal,
ezUInt32  uiLine,
ezUInt32  uiColumn 
)
inlineoverrideprivatevirtual

Called when something unexpected is encountered in the JSON 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 not continue parsing. In that case client code will need to clean up it's open state, as no further OnEndObject() / OnEndArray() will be called. If bFatal is false, the document does not contain valid JSON, but the parser is able to continue still.

Reimplemented from ezJSONParser.


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