SAX-style JSON parser. Use Reader for UTF8 encoding and default allocator. More...

#include <reader.h>

Collaboration diagram for GenericReader< SourceEncoding, TargetEncoding, StackAllocator >:

Classes
struct	ClearStackOnExit
class	StackStream
class	NumberStream
class	NumberStream< InputStream, false, false >
class	NumberStream< InputStream, true, false >
class	NumberStream< InputStream, true, true >

Public Types
typedef SourceEncoding::Ch	Ch
	SourceEncoding character type.

Public Member Functions
	GenericReader (StackAllocator *stackAllocator=0, size_t stackCapacity=kDefaultStackCapacity)
	Constructor.
template<unsigned parseFlags, typename InputStream, typename Handler>
ParseResult	Parse (InputStream &is, Handler &handler)
	Parse JSON text.
template<typename InputStream, typename Handler>
ParseResult	Parse (InputStream &is, Handler &handler)
	Parse JSON text (with kParseDefaultFlags).
void	IterativeParseInit ()
	Initialize JSON text token-by-token parsing.
template<unsigned parseFlags, typename InputStream, typename Handler>
bool	IterativeParseNext (InputStream &is, Handler &handler)
	Parse one token from JSON text.
RAPIDJSON_FORCEINLINE bool	IterativeParseComplete () const
	Check if token-by-token parsing JSON text is complete.
bool	HasParseError () const
	Whether a parse error has occurred in the last parsing.
ParseErrorCode	GetParseErrorCode () const
	Get the ParseErrorCode of last parsing.
size_t	GetErrorOffset () const
	Get the position of last parsing error in input, 0 otherwise.

Protected Member Functions
void	SetParseError (ParseErrorCode code, size_t offset)

Private Member Functions
	GenericReader (const GenericReader &)
GenericReader &	operator= (const GenericReader &)
void	ClearStack ()
template<unsigned parseFlags, typename InputStream>
void	SkipWhitespaceAndComments (InputStream &is)
template<unsigned parseFlags, typename InputStream, typename Handler>
void	ParseObject (InputStream &is, Handler &handler)
template<unsigned parseFlags, typename InputStream, typename Handler>
void	ParseArray (InputStream &is, Handler &handler)
template<unsigned parseFlags, typename InputStream, typename Handler>
void	ParseNull (InputStream &is, Handler &handler)
template<unsigned parseFlags, typename InputStream, typename Handler>
void	ParseTrue (InputStream &is, Handler &handler)
template<unsigned parseFlags, typename InputStream, typename Handler>
void	ParseFalse (InputStream &is, Handler &handler)
template<typename InputStream>
unsigned	ParseHex4 (InputStream &is, size_t escapeOffset)
template<unsigned parseFlags, typename InputStream, typename Handler>
void	ParseString (InputStream &is, Handler &handler, bool isKey=false)
template<unsigned parseFlags, typename SEncoding, typename TEncoding, typename InputStream, typename OutputStream>
RAPIDJSON_FORCEINLINE void	ParseStringToStream (InputStream &is, OutputStream &os)
template<unsigned parseFlags, typename InputStream, typename Handler>
void	ParseNumber (InputStream &is, Handler &handler)
template<unsigned parseFlags, typename InputStream, typename Handler>
void	ParseValue (InputStream &is, Handler &handler)
RAPIDJSON_FORCEINLINE Token	Tokenize (Ch c) const
RAPIDJSON_FORCEINLINE IterativeParsingState	Predict (IterativeParsingState state, Token token) const
template<unsigned parseFlags, typename InputStream, typename Handler>
RAPIDJSON_FORCEINLINE IterativeParsingState	Transit (IterativeParsingState src, Token token, IterativeParsingState dst, InputStream &is, Handler &handler)
template<typename InputStream>
void	HandleError (IterativeParsingState src, InputStream &is)
RAPIDJSON_FORCEINLINE bool	IsIterativeParsingDelimiterState (IterativeParsingState s) const
RAPIDJSON_FORCEINLINE bool	IsIterativeParsingCompleteState (IterativeParsingState s) const
template<unsigned parseFlags, typename InputStream, typename Handler>
ParseResult	IterativeParse (InputStream &is, Handler &handler)

Static Private Member Functions
template<typename InputStream>
static RAPIDJSON_FORCEINLINE bool	Consume (InputStream &is, typename InputStream::Ch expect)
template<typename InputStream, typename OutputStream>
static RAPIDJSON_FORCEINLINE void	ScanCopyUnescapedString (InputStream &, OutputStream &)

Private Attributes
internal::Stack< StackAllocator >	stack_
	A stack for storing decoded string temporarily during non-destructive parsing.
ParseResult	parseResult_
IterativeParsingState	state_

Static Private Attributes
static const size_t	kDefaultStackCapacity = 256
	Default stack capacity in bytes for storing a single decoded string.

Detailed Description

template<typename SourceEncoding, typename TargetEncoding, typename StackAllocator = CrtAllocator>
class GenericReader< SourceEncoding, TargetEncoding, StackAllocator >

SAX-style JSON parser. Use Reader for UTF8 encoding and default allocator.

GenericReader parses JSON text from a stream, and send events synchronously to an object implementing Handler concept.

It needs to allocate a stack for storing a single decoded string during non-destructive parsing.

For in-situ parsing, the decoded string is directly written to the source text string, no temporary buffer is required.

A GenericReader object can be reused for parsing multiple JSON text.

Template Parameters

SourceEncoding	Encoding of the input stream.
TargetEncoding	Encoding of the parse output.
StackAllocator	Allocator type for stack.

Member Typedef Documentation

◆ Ch

template<typename SourceEncoding, typename TargetEncoding, typename StackAllocator = CrtAllocator>

typedef SourceEncoding::Ch GenericReader< SourceEncoding, TargetEncoding, StackAllocator >::Ch

SourceEncoding character type.

Member Enumeration Documentation

◆ IterativeParsingState

template<typename SourceEncoding, typename TargetEncoding, typename StackAllocator = CrtAllocator>

enum GenericReader::IterativeParsingState

private

Enumerator
IterativeParsingFinishState
IterativeParsingErrorState
IterativeParsingStartState
IterativeParsingObjectInitialState
IterativeParsingMemberKeyState
IterativeParsingMemberValueState
IterativeParsingObjectFinishState
IterativeParsingArrayInitialState
IterativeParsingElementState
IterativeParsingArrayFinishState
IterativeParsingValueState
IterativeParsingElementDelimiterState
IterativeParsingMemberDelimiterState
IterativeParsingKeyValueDelimiterState
cIterativeParsingStateCount

◆ Token

template<typename SourceEncoding, typename TargetEncoding, typename StackAllocator = CrtAllocator>

enum GenericReader::Token

private

Enumerator
LeftBracketToken
RightBracketToken
LeftCurlyBracketToken
RightCurlyBracketToken
CommaToken
ColonToken
StringToken
FalseToken
TrueToken
NullToken
NumberToken
kTokenCount

Constructor & Destructor Documentation

◆ GenericReader() [1/2]

template<typename SourceEncoding, typename TargetEncoding, typename StackAllocator = CrtAllocator>

GenericReader< SourceEncoding, TargetEncoding, StackAllocator >::GenericReader	(	StackAllocator *	stackAllocator = 0,
		size_t	stackCapacity = kDefaultStackCapacity )

inline

Constructor.

Parameters

stackAllocator	Optional allocator for allocating stack memory. (Only use for non-destructive parsing)
stackCapacity	stack capacity in bytes for storing a single decoded string. (Only use for non-destructive parsing)

◆ GenericReader() [2/2]

template<typename SourceEncoding, typename TargetEncoding, typename StackAllocator = CrtAllocator>

GenericReader< SourceEncoding, TargetEncoding, StackAllocator >::GenericReader ( const GenericReader< SourceEncoding, TargetEncoding, StackAllocator > & )

private

Member Function Documentation

◆ ClearStack()

template<typename SourceEncoding, typename TargetEncoding, typename StackAllocator = CrtAllocator>

void GenericReader< SourceEncoding, TargetEncoding, StackAllocator >::ClearStack ( )

inlineprivate

◆ Consume()

template<typename SourceEncoding, typename TargetEncoding, typename StackAllocator = CrtAllocator>

template<typename InputStream>

RAPIDJSON_FORCEINLINE bool GenericReader< SourceEncoding, TargetEncoding, StackAllocator >::Consume	(	InputStream &	is,
		typename InputStream::Ch	expect )

inlinestaticprivate

◆ GetErrorOffset()

template<typename SourceEncoding, typename TargetEncoding, typename StackAllocator = CrtAllocator>

size_t GenericReader< SourceEncoding, TargetEncoding, StackAllocator >::GetErrorOffset ( ) const

inline

Get the position of last parsing error in input, 0 otherwise.

◆ GetParseErrorCode()

template<typename SourceEncoding, typename TargetEncoding, typename StackAllocator = CrtAllocator>

ParseErrorCode GenericReader< SourceEncoding, TargetEncoding, StackAllocator >::GetParseErrorCode ( ) const

inline

Get the ParseErrorCode of last parsing.

◆ HandleError()

template<typename SourceEncoding, typename TargetEncoding, typename StackAllocator = CrtAllocator>

template<typename InputStream>

void GenericReader< SourceEncoding, TargetEncoding, StackAllocator >::HandleError	(	IterativeParsingState	src,
		InputStream &	is )

inlineprivate

◆ HasParseError()

template<typename SourceEncoding, typename TargetEncoding, typename StackAllocator = CrtAllocator>

bool GenericReader< SourceEncoding, TargetEncoding, StackAllocator >::HasParseError ( ) const

inline

Whether a parse error has occurred in the last parsing.

◆ IsIterativeParsingCompleteState()

template<typename SourceEncoding, typename TargetEncoding, typename StackAllocator = CrtAllocator>

RAPIDJSON_FORCEINLINE bool GenericReader< SourceEncoding, TargetEncoding, StackAllocator >::IsIterativeParsingCompleteState ( IterativeParsingState s ) const

inlineprivate

◆ IsIterativeParsingDelimiterState()

template<typename SourceEncoding, typename TargetEncoding, typename StackAllocator = CrtAllocator>

RAPIDJSON_FORCEINLINE bool GenericReader< SourceEncoding, TargetEncoding, StackAllocator >::IsIterativeParsingDelimiterState ( IterativeParsingState s ) const

inlineprivate

◆ IterativeParse()

template<typename SourceEncoding, typename TargetEncoding, typename StackAllocator = CrtAllocator>

template<unsigned parseFlags, typename InputStream, typename Handler>

ParseResult GenericReader< SourceEncoding, TargetEncoding, StackAllocator >::IterativeParse	(	InputStream &	is,
		Handler &	handler )

inlineprivate

◆ IterativeParseComplete()

template<typename SourceEncoding, typename TargetEncoding, typename StackAllocator = CrtAllocator>

RAPIDJSON_FORCEINLINE bool GenericReader< SourceEncoding, TargetEncoding, StackAllocator >::IterativeParseComplete ( ) const

inline

Check if token-by-token parsing JSON text is complete.

Returns: Whether the JSON has been fully decoded.

◆ IterativeParseInit()

template<typename SourceEncoding, typename TargetEncoding, typename StackAllocator = CrtAllocator>

void GenericReader< SourceEncoding, TargetEncoding, StackAllocator >::IterativeParseInit ( )

inline

Initialize JSON text token-by-token parsing.

◆ IterativeParseNext()

template<typename SourceEncoding, typename TargetEncoding, typename StackAllocator = CrtAllocator>

template<unsigned parseFlags, typename InputStream, typename Handler>

bool GenericReader< SourceEncoding, TargetEncoding, StackAllocator >::IterativeParseNext	(	InputStream &	is,
		Handler &	handler )

inline

Parse one token from JSON text.

Template Parameters

InputStream	Type of input stream, implementing Stream concept
Handler	Type of handler, implementing Handler concept.

Parameters

is	Input stream to be parsed.
handler	The handler to receive events.

Returns: Whether the parsing is successful.

◆ operator=()

template<typename SourceEncoding, typename TargetEncoding, typename StackAllocator = CrtAllocator>

GenericReader & GenericReader< SourceEncoding, TargetEncoding, StackAllocator >::operator= ( const GenericReader< SourceEncoding, TargetEncoding, StackAllocator > & )

private

◆ Parse() [1/2]

template<typename SourceEncoding, typename TargetEncoding, typename StackAllocator = CrtAllocator>

template<typename InputStream, typename Handler>

ParseResult GenericReader< SourceEncoding, TargetEncoding, StackAllocator >::Parse	(	InputStream &	is,
		Handler &	handler )

inline

Parse JSON text (with kParseDefaultFlags).

Template Parameters

InputStream	Type of input stream, implementing Stream concept
Handler	Type of handler, implementing Handler concept.

Parameters

is	Input stream to be parsed.
handler	The handler to receive events.

Returns: Whether the parsing is successful.

◆ Parse() [2/2]

template<typename SourceEncoding, typename TargetEncoding, typename StackAllocator = CrtAllocator>

template<unsigned parseFlags, typename InputStream, typename Handler>

ParseResult GenericReader< SourceEncoding, TargetEncoding, StackAllocator >::Parse	(	InputStream &	is,
		Handler &	handler )

inline

Parse JSON text.

Template Parameters

parseFlags	Combination of ParseFlag.
InputStream	Type of input stream, implementing Stream concept.
Handler	Type of handler, implementing Handler concept.

Parameters

is	Input stream to be parsed.
handler	The handler to receive events.

Returns: Whether the parsing is successful.

◆ ParseArray()

template<typename SourceEncoding, typename TargetEncoding, typename StackAllocator = CrtAllocator>

template<unsigned parseFlags, typename InputStream, typename Handler>

void GenericReader< SourceEncoding, TargetEncoding, StackAllocator >::ParseArray	(	InputStream &	is,
		Handler &	handler )

inlineprivate

◆ ParseFalse()

template<typename SourceEncoding, typename TargetEncoding, typename StackAllocator = CrtAllocator>

template<unsigned parseFlags, typename InputStream, typename Handler>

void GenericReader< SourceEncoding, TargetEncoding, StackAllocator >::ParseFalse	(	InputStream &	is,
		Handler &	handler )

inlineprivate

◆ ParseHex4()

template<typename SourceEncoding, typename TargetEncoding, typename StackAllocator = CrtAllocator>

template<typename InputStream>

unsigned GenericReader< SourceEncoding, TargetEncoding, StackAllocator >::ParseHex4	(	InputStream &	is,
		size_t	escapeOffset )

inlineprivate

◆ ParseNull()

template<typename SourceEncoding, typename TargetEncoding, typename StackAllocator = CrtAllocator>

template<unsigned parseFlags, typename InputStream, typename Handler>

void GenericReader< SourceEncoding, TargetEncoding, StackAllocator >::ParseNull	(	InputStream &	is,
		Handler &	handler )

inlineprivate

◆ ParseNumber()

template<typename SourceEncoding, typename TargetEncoding, typename StackAllocator = CrtAllocator>

template<unsigned parseFlags, typename InputStream, typename Handler>

void GenericReader< SourceEncoding, TargetEncoding, StackAllocator >::ParseNumber	(	InputStream &	is,
		Handler &	handler )

inlineprivate

◆ ParseObject()

template<typename SourceEncoding, typename TargetEncoding, typename StackAllocator = CrtAllocator>

template<unsigned parseFlags, typename InputStream, typename Handler>

void GenericReader< SourceEncoding, TargetEncoding, StackAllocator >::ParseObject	(	InputStream &	is,
		Handler &	handler )

inlineprivate

◆ ParseString()

template<typename SourceEncoding, typename TargetEncoding, typename StackAllocator = CrtAllocator>

template<unsigned parseFlags, typename InputStream, typename Handler>

void GenericReader< SourceEncoding, TargetEncoding, StackAllocator >::ParseString	(	InputStream &	is,
		Handler &	handler,
		bool	isKey = false )

inlineprivate

◆ ParseStringToStream()

template<typename SourceEncoding, typename TargetEncoding, typename StackAllocator = CrtAllocator>

template<unsigned parseFlags, typename SEncoding, typename TEncoding, typename InputStream, typename OutputStream>

RAPIDJSON_FORCEINLINE void GenericReader< SourceEncoding, TargetEncoding, StackAllocator >::ParseStringToStream	(	InputStream &	is,
		OutputStream &	os )

inlineprivate

◆ ParseTrue()

template<typename SourceEncoding, typename TargetEncoding, typename StackAllocator = CrtAllocator>

template<unsigned parseFlags, typename InputStream, typename Handler>

void GenericReader< SourceEncoding, TargetEncoding, StackAllocator >::ParseTrue	(	InputStream &	is,
		Handler &	handler )

inlineprivate

◆ ParseValue()

template<typename SourceEncoding, typename TargetEncoding, typename StackAllocator = CrtAllocator>

template<unsigned parseFlags, typename InputStream, typename Handler>

void GenericReader< SourceEncoding, TargetEncoding, StackAllocator >::ParseValue	(	InputStream &	is,
		Handler &	handler )

inlineprivate

◆ Predict()

template<typename SourceEncoding, typename TargetEncoding, typename StackAllocator = CrtAllocator>

RAPIDJSON_FORCEINLINE IterativeParsingState GenericReader< SourceEncoding, TargetEncoding, StackAllocator >::Predict	(	IterativeParsingState	state,
		Token	token ) const

inlineprivate

◆ ScanCopyUnescapedString()

template<typename SourceEncoding, typename TargetEncoding, typename StackAllocator = CrtAllocator>

template<typename InputStream, typename OutputStream>

RAPIDJSON_FORCEINLINE void GenericReader< SourceEncoding, TargetEncoding, StackAllocator >::ScanCopyUnescapedString	(	InputStream &	,
		OutputStream &	)

inlinestaticprivate

◆ SetParseError()

template<typename SourceEncoding, typename TargetEncoding, typename StackAllocator = CrtAllocator>

void GenericReader< SourceEncoding, TargetEncoding, StackAllocator >::SetParseError	(	ParseErrorCode	code,
		size_t	offset )

inlineprotected

◆ SkipWhitespaceAndComments()

template<typename SourceEncoding, typename TargetEncoding, typename StackAllocator = CrtAllocator>

template<unsigned parseFlags, typename InputStream>

void GenericReader< SourceEncoding, TargetEncoding, StackAllocator >::SkipWhitespaceAndComments ( InputStream & is )

inlineprivate

◆ Tokenize()

template<typename SourceEncoding, typename TargetEncoding, typename StackAllocator = CrtAllocator>

RAPIDJSON_FORCEINLINE Token GenericReader< SourceEncoding, TargetEncoding, StackAllocator >::Tokenize ( Ch c ) const

inlineprivate

◆ Transit()

template<typename SourceEncoding, typename TargetEncoding, typename StackAllocator = CrtAllocator>

template<unsigned parseFlags, typename InputStream, typename Handler>

RAPIDJSON_FORCEINLINE IterativeParsingState GenericReader< SourceEncoding, TargetEncoding, StackAllocator >::Transit	(	IterativeParsingState	src,
		Token	token,
		IterativeParsingState	dst,
		InputStream &	is,
		Handler &	handler )

inlineprivate

Member Data Documentation

◆ kDefaultStackCapacity

template<typename SourceEncoding, typename TargetEncoding, typename StackAllocator = CrtAllocator>

const size_t GenericReader< SourceEncoding, TargetEncoding, StackAllocator >::kDefaultStackCapacity = 256

staticprivate

Default stack capacity in bytes for storing a single decoded string.

◆ parseResult_

template<typename SourceEncoding, typename TargetEncoding, typename StackAllocator = CrtAllocator>

ParseResult GenericReader< SourceEncoding, TargetEncoding, StackAllocator >::parseResult_

private

◆ stack_

template<typename SourceEncoding, typename TargetEncoding, typename StackAllocator = CrtAllocator>

internal::Stack<StackAllocator> GenericReader< SourceEncoding, TargetEncoding, StackAllocator >::stack_

private

A stack for storing decoded string temporarily during non-destructive parsing.

◆ state_

template<typename SourceEncoding, typename TargetEncoding, typename StackAllocator = CrtAllocator>

IterativeParsingState GenericReader< SourceEncoding, TargetEncoding, StackAllocator >::state_

private

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

external/rapidjson/include/rapidjson/fwd.h
external/rapidjson/include/rapidjson/reader.h

Private Types
enum	IterativeParsingState { IterativeParsingFinishState = 0 , IterativeParsingErrorState , IterativeParsingStartState , IterativeParsingObjectInitialState , IterativeParsingMemberKeyState , IterativeParsingMemberValueState , IterativeParsingObjectFinishState , IterativeParsingArrayInitialState , IterativeParsingElementState , IterativeParsingArrayFinishState , IterativeParsingValueState , IterativeParsingElementDelimiterState , IterativeParsingMemberDelimiterState , IterativeParsingKeyValueDelimiterState , cIterativeParsingStateCount }
enum	Token { LeftBracketToken = 0 , RightBracketToken , LeftCurlyBracketToken , RightCurlyBracketToken , CommaToken , ColonToken , StringToken , FalseToken , TrueToken , NullToken , NumberToken , kTokenCount }

Classes

Public Types

Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Static Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Member Typedef Documentation

◆ Ch

Member Enumeration Documentation

◆ IterativeParsingState

◆ Token

Constructor & Destructor Documentation

◆ GenericReader() [1/2]

◆ GenericReader() [2/2]

Member Function Documentation

◆ ClearStack()

◆ Consume()

◆ GetErrorOffset()

◆ GetParseErrorCode()

◆ HandleError()

◆ HasParseError()

◆ IsIterativeParsingCompleteState()

◆ IsIterativeParsingDelimiterState()

◆ IterativeParse()

◆ IterativeParseComplete()

◆ IterativeParseInit()

◆ IterativeParseNext()

◆ operator=()

◆ Parse() [1/2]

◆ Parse() [2/2]

◆ ParseArray()

◆ ParseFalse()

◆ ParseHex4()

◆ ParseNull()

◆ ParseNumber()

◆ ParseObject()

◆ ParseString()

◆ ParseStringToStream()

◆ ParseTrue()

◆ ParseValue()

◆ Predict()

◆ ScanCopyUnescapedString()

◆ SetParseError()

◆ SkipWhitespaceAndComments()

◆ Tokenize()

◆ Transit()

Member Data Documentation

◆ kDefaultStackCapacity

◆ parseResult_

◆ stack_

◆ state_