Unserialize a JSON document into a Value. More...

#include <json_reader.h>

Collaboration diagram for json::Reader:

[legend]

Classes
class	Token
class	ErrorInfo

Public Types
using	Char = char
using	Location = Char const*

Public Member Functions
	Reader ()=default
	Constructs a Reader allowing all features for parsing.
bool	parse (std::string const &document, Value &root)
	Read a Value from a JSON document.
bool	parse (char const beginDoc, char const endDoc, Value &root)
	Read a Value from a JSON document.
bool	parse (std::istream &is, Value &root)
	Parse from input stream.
template<class BufferSequence>
bool	parse (Value &root, BufferSequence const &bs)
	Read a Value from a JSON buffer sequence.
std::string	getFormattedErrorMessages () const
	Returns a user friendly string that list errors in the parsed document.

Static Public Attributes
static constexpr unsigned	kNestLimit {25}

Private Types
enum class	TokenType { EndOfStream = 0 , ObjectBegin , ObjectEnd , ArrayBegin , ArrayEnd , String , Integer , Double , True , False , Null , ArraySeparator , MemberSeparator , Comment , Error }
using	Errors = std::deque<ErrorInfo>
using	Nodes = std::stack<Value*>

Private Member Functions
bool	expectToken (TokenType type, Token &token, char const *message)
bool	readToken (Token &token)
void	skipSpaces ()
bool	match (Location pattern, int patternLength)
bool	readComment ()
bool	readCStyleComment ()
bool	readCppStyleComment ()
bool	readString ()
Reader::TokenType	readNumber ()
bool	readValue (unsigned depth)
bool	readObject (Token &token, unsigned depth)
bool	readArray (Token &token, unsigned depth)
bool	decodeNumber (Token &token)
bool	decodeString (Token &token)
bool	decodeString (Token &token, std::string &decoded)
bool	decodeDouble (Token &token)
bool	decodeUnicodeCodePoint (Token &token, Location &current, Location end, unsigned int &unicode)
bool	decodeUnicodeEscapeSequence (Token &token, Location &current, Location end, unsigned int &unicode)
bool	addError (std::string const &message, Token &token, Location extra=nullptr)
bool	recoverFromError (TokenType skipUntilToken)
bool	addErrorAndRecover (std::string const &message, Token &token, TokenType skipUntilToken)
void	skipUntilSpace ()
Value &	currentValue ()
Char	getNextChar ()
void	getLocationLineAndColumn (Location location, int &line, int &column) const
std::string	getLocationLineAndColumn (Location location) const
void	skipCommentTokens (Token &token)

Private Attributes
Nodes	nodes_
Errors	errors_
std::string	document_
Location	begin_ {}
Location	end_ {}
Location	current_ {}
Location	lastValueEnd_ {}
Value *	lastValue_ {}

Detailed Description

Unserialize a JSON document into a Value.

Definition at line 19 of file json_reader.h.

Member Typedef Documentation

◆ Char

using json::Reader::Char = char

Definition at line 22 of file json_reader.h.

◆ Location

using json::Reader::Location = Char const*

Definition at line 23 of file json_reader.h.

◆ Errors

using json::Reader::Errors = std::deque<ErrorInfo>

private

Definition at line 121 of file json_reader.h.

◆ Nodes

using json::Reader::Nodes = std::stack<Value*>

private

Definition at line 182 of file json_reader.h.

Member Enumeration Documentation

◆ TokenType

enum class json::Reader::TokenType

strongprivate

Enumerator
EndOfStream
ObjectBegin
ObjectEnd
ArrayBegin
ArrayEnd
String
Integer
Double
True
False
Null
ArraySeparator
MemberSeparator
Comment
Error

Definition at line 83 of file json_reader.h.

Constructor & Destructor Documentation

◆ Reader()

json::Reader::Reader ( )

default

Constructs a Reader allowing all features for parsing.

Member Function Documentation

◆ parse() [1/4]

bool json::Reader::parse	(	std::string const &	document,
		Value &	root )

Read a Value from a JSON document.

Parameters

document	UTF-8 encoded string containing the document to read.
root	[out] Contains the root value of the document if it was successfully parsed.

Returns: true if the document was successfully parsed, false if an error occurred.

Definition at line 63 of file json_reader.cpp.

◆ parse() [2/4]

bool json::Reader::parse	(	char const *	beginDoc,
		char const *	endDoc,
		Value &	root )

Read a Value from a JSON document.

Parameters

document	UTF-8 encoded string containing the document to read.
root	[out] Contains the root value of the document if it was successfully parsed.

Returns: true if the document was successfully parsed, false if an error occurred.

Definition at line 87 of file json_reader.cpp.

◆ parse() [3/4]

bool json::Reader::parse	(	std::istream &	is,
		Value &	root )

Parse from input stream.

See also: json::operator>>(std::istream&, json::Value&).

Definition at line 72 of file json_reader.cpp.

◆ parse() [4/4]

template<class BufferSequence>

bool json::Reader::parse	(	Value &	root,
		BufferSequence const &	bs )

Read a Value from a JSON buffer sequence.

Parameters

root	[out] Contains the root value of the document if it was successfully parsed.
-	encoded buffer sequence.

Returns: true if the buffer was successfully parsed, false if an error occurred.

Definition at line 195 of file json_reader.h.

◆ getFormattedErrorMessages()

std::string json::Reader::getFormattedErrorMessages ( ) const

nodiscard

Returns a user friendly string that list errors in the parsed document.

Returns: Formatted error message with the list of errors with their location in the parsed document. An empty string is returned if no error occurred during parsing.

Definition at line 899 of file json_reader.cpp.

◆ expectToken()

bool json::Reader::expectToken	(	TokenType	type,
		Token &	token,
		char const *	message )

private

Definition at line 178 of file json_reader.cpp.

◆ readToken()

bool json::Reader::readToken ( Token & token )

private

Definition at line 189 of file json_reader.cpp.

◆ skipSpaces()

void json::Reader::skipSpaces ( )

private

Definition at line 278 of file json_reader.cpp.

◆ match()

bool json::Reader::match	(	Location	pattern,
		int	patternLength )

private

Definition at line 296 of file json_reader.cpp.

◆ readComment()

bool json::Reader::readComment ( )

private

Definition at line 314 of file json_reader.cpp.

◆ readCStyleComment()

bool json::Reader::readCStyleComment ( )

private

Definition at line 328 of file json_reader.cpp.

◆ readCppStyleComment()

bool json::Reader::readCppStyleComment ( )

private

Definition at line 342 of file json_reader.cpp.

◆ readString()

bool json::Reader::readString ( )

private

Definition at line 387 of file json_reader.cpp.

◆ readNumber()

Reader::TokenType json::Reader::readNumber ( )

private

Definition at line 356 of file json_reader.cpp.

◆ readValue()

bool json::Reader::readValue ( unsigned depth )

private

Definition at line 119 of file json_reader.cpp.

◆ readObject()

bool json::Reader::readObject	(	Token &	token,
		unsigned	depth )

private

Definition at line 409 of file json_reader.cpp.

◆ readArray()

bool json::Reader::readArray	(	Token &	token,
		unsigned	depth )

private

Definition at line 479 of file json_reader.cpp.

◆ decodeNumber()

bool json::Reader::decodeNumber ( Token & token )

private

Definition at line 529 of file json_reader.cpp.

◆ decodeString() [1/2]

bool json::Reader::decodeString ( Token & token )

private

Definition at line 633 of file json_reader.cpp.

◆ decodeString() [2/2]

bool json::Reader::decodeString	(	Token &	token,
		std::string &	decoded )

private

Definition at line 645 of file json_reader.cpp.

◆ decodeDouble()

bool json::Reader::decodeDouble ( Token & token )

private

Definition at line 608 of file json_reader.cpp.

◆ decodeUnicodeCodePoint()

bool json::Reader::decodeUnicodeCodePoint	(	Token &	token,
		Location &	current,
		Location	end,
		unsigned int &	unicode )

private

Definition at line 724 of file json_reader.cpp.

◆ decodeUnicodeEscapeSequence()

bool json::Reader::decodeUnicodeEscapeSequence	(	Token &	token,
		Location &	current,
		Location	end,
		unsigned int &	unicode )

private

Definition at line 763 of file json_reader.cpp.

◆ addError()

bool json::Reader::addError	(	std::string const &	message,
		Token &	token,
		Location	extra = nullptr )

private

Definition at line 808 of file json_reader.cpp.

◆ recoverFromError()

bool json::Reader::recoverFromError ( TokenType skipUntilToken )

private

Definition at line 819 of file json_reader.cpp.

◆ addErrorAndRecover()

bool json::Reader::addErrorAndRecover	(	std::string const &	message,
		Token &	token,
		TokenType	skipUntilToken )

private

Definition at line 838 of file json_reader.cpp.

◆ skipUntilSpace()

void json::Reader::skipUntilSpace ( )

private

◆ currentValue()

Value & json::Reader::currentValue ( )

private

Definition at line 845 of file json_reader.cpp.

◆ getNextChar()

Reader::Char json::Reader::getNextChar ( )

private

Definition at line 851 of file json_reader.cpp.

◆ getLocationLineAndColumn() [1/2]

void json::Reader::getLocationLineAndColumn	(	Location	location,
		int &	line,
		int &	column ) const

private

Definition at line 860 of file json_reader.cpp.

◆ getLocationLineAndColumn() [2/2]

std::string json::Reader::getLocationLineAndColumn ( Location location ) const

private

Definition at line 891 of file json_reader.cpp.

◆ skipCommentTokens()

void json::Reader::skipCommentTokens ( Token & token )

private

Definition at line 169 of file json_reader.cpp.

Member Data Documentation

◆ kNestLimit

unsigned json::Reader::kNestLimit {25}

staticconstexpr

Definition at line 80 of file json_reader.h.

◆ nodes_

Nodes json::Reader::nodes_

private

Definition at line 183 of file json_reader.h.

◆ errors_

Errors json::Reader::errors_

private

Definition at line 184 of file json_reader.h.

◆ document_

std::string json::Reader::document_

private

Definition at line 185 of file json_reader.h.

◆ begin_

Location json::Reader::begin_ {}

private

Definition at line 186 of file json_reader.h.

◆ end_

Location json::Reader::end_ {}

private

Definition at line 187 of file json_reader.h.

◆ current_

Location json::Reader::current_ {}

private

Definition at line 188 of file json_reader.h.

◆ lastValueEnd_

Location json::Reader::lastValueEnd_ {}

private

Definition at line 189 of file json_reader.h.

◆ lastValue_

Value* json::Reader::lastValue_ {}

private

Definition at line 190 of file json_reader.h.

Classes

Public Types

Public Member Functions

Static Public Attributes

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ Char

◆ Location

◆ Errors

◆ Nodes

Member Enumeration Documentation

◆ TokenType

Constructor & Destructor Documentation

◆ Reader()

Member Function Documentation

◆ parse() [1/4]

◆ parse() [2/4]

◆ parse() [3/4]

◆ parse() [4/4]

◆ getFormattedErrorMessages()

◆ expectToken()

◆ readToken()

◆ skipSpaces()

◆ match()

◆ readComment()

◆ readCStyleComment()

◆ readCppStyleComment()

◆ readString()

◆ readNumber()

◆ readValue()

◆ readObject()

◆ readArray()

◆ decodeNumber()

◆ decodeString() [1/2]

◆ decodeString() [2/2]

◆ decodeDouble()

◆ decodeUnicodeCodePoint()

◆ decodeUnicodeEscapeSequence()

◆ addError()

◆ recoverFromError()

◆ addErrorAndRecover()

◆ skipUntilSpace()

◆ currentValue()

◆ getNextChar()

◆ getLocationLineAndColumn() [1/2]

◆ getLocationLineAndColumn() [2/2]

◆ skipCommentTokens()

Member Data Documentation

◆ kNestLimit

◆ nodes_

◆ errors_

◆ document_

◆ begin_

◆ end_

◆ current_

◆ lastValueEnd_

◆ lastValue_