JSON reader class. More...

#include <json.hpp>

Inheritance diagram for join::JsonReader:

[legend]

Collaboration diagram for join::JsonReader:

[legend]

Public Member Functions
	JsonReader (Value &root)
	default constructor.

	JsonReader (const JsonReader &other)=delete
	copy constructor.

JsonReader &	operator= (const JsonReader &other)=delete
	copy assignment.

	JsonReader (JsonReader &&other)=delete
	move constructor.

JsonReader &	operator= (JsonReader &&other)=delete
	move assignment.

virtual	~JsonReader ()=default
	destroy instance.

template<JsonReadMode ReadMode = JsonReadMode::None>
int	deserialize (const char *document, size_t length)
	deserialize a document.

int	deserialize (const char *document, size_t length) override
	deserialize a document.

template<JsonReadMode ReadMode = JsonReadMode::None>
int	deserialize (const char first, const char last)
	deserialize a document.

int	deserialize (const char first, const char last) override
	deserialize a document.

template<JsonReadMode ReadMode = JsonReadMode::None>
int	deserialize (const std::string &document)
	deserialize a document.

int	deserialize (const std::string &document) override
	deserialize a document.

template<JsonReadMode ReadMode = JsonReadMode::None>
int	deserialize (std::stringstream &document)
	deserialize a document.

int	deserialize (std::stringstream &document) override
	deserialize a document.

template<JsonReadMode ReadMode = JsonReadMode::None>
int	deserialize (std::istringstream &document)
	deserialize a document.

int	deserialize (std::istringstream &document) override
	deserialize a document.

template<JsonReadMode ReadMode = JsonReadMode::None>
int	deserialize (std::fstream &document)
	deserialize a document.

int	deserialize (std::fstream &document) override
	deserialize a document.

template<JsonReadMode ReadMode = JsonReadMode::None>
int	deserialize (std::ifstream &document)
	deserialize a document.

int	deserialize (std::ifstream &document) override
	deserialize a document.

template<JsonReadMode ReadMode = JsonReadMode::None>
int	deserialize (std::iostream &document)
	deserialize a document.

int	deserialize (std::iostream &document) override
	deserialize a document.

template<JsonReadMode ReadMode = JsonReadMode::None>
int	deserialize (std::istream &document)
	deserialize a document.

int	deserialize (std::istream &document) override
	deserialize a document.

Public Member Functions inherited from join::StreamReader
	StreamReader (Value &root)
	default constructor.

	StreamReader (const StreamReader &other)=delete
	copy constructor.

StreamReader &	operator= (const StreamReader &other)=delete
	copy assignment.

	StreamReader (StreamReader &&other)=delete
	move constructor.

StreamReader &	operator= (StreamReader &&other)=delete
	move assignment.

virtual	~StreamReader ()=default
	destroy instance.

Protected Member Functions
template<JsonReadMode ReadMode, typename ViewType >
int	read (ViewType &document)
	parse a document.

template<JsonReadMode ReadMode, typename ViewType >
int	readValue (ViewType &document)
	parse a JSON value.

template<typename ViewType >
int	readNull (ViewType &document)
	parse a null value.

template<typename ViewType >
int	readTrue (ViewType &document)
	parse a true value.

template<typename ViewType >
int	readFalse (ViewType &document)
	parse a false value.

template<typename ViewType >
int	readInf (ViewType &document, bool negative)
	parse an infinity value.

template<typename ViewType >
int	readNan (ViewType &document, bool negative)
	parse a nan value.

void	umul192 (uint64_t hi, uint64_t lo, uint64_t significand, uint64_t &high, uint64_t &middle, uint64_t &low) noexcept
	multiply 192 bits unsigned integer by 64 bits unsigned integer.

bool	strtodFast (uint64_t significand, int64_t exponent, double &value)
	convert double using fast path.

bool	strtodSlow (const std::string &num, double &d)
	convert double using strtod.

template<typename ViewType >
int	readNumber (ViewType &document)
	parse a number value.

template<typename ViewType >
int	readHex (ViewType &document, uint32_t &u)
	parse a 4-digit hexadecimal sequence..

void	encodeUtf8 (uint32_t codepoint, std::string &output)
	encode a Unicode codepoint to UTF-8.

template<typename ViewType >
int	readUnicode (ViewType &document, std::string &output)
	parse unicode.

template<typename ViewType >
int	readEscaped (ViewType &document, std::string &output)
	parse escaped sequence.

template<typename ViewType >
int	readString (ViewType &document, bool isKey=false)
	parse UTF8.

template<JsonReadMode ReadMode, typename ViewType >
int	readArray (ViewType &document)
	parse an array value.

template<JsonReadMode ReadMode, typename ViewType >
int	readObject (ViewType &document)
	parse an object value.

template<JsonReadMode ReadMode, typename ViewType >
std::enable_if<!(ReadMode &JsonReadMode::ParseComments), int >::type	skipWhitespaces (ViewType &document)
	skip whitespaces.

template<JsonReadMode ReadMode, typename ViewType >
std::enable_if<(ReadMode &JsonReadMode::ParseComments), int >::type	skipWhitespaces (ViewType &document)
	skip whitespaces with comment parsing.

constexpr bool	isUpperAlpha (char c) noexcept
	check if upper case alphanumeric character.

constexpr bool	isLowerAlpha (char c) noexcept
	check if lower case alphanumeric character.

constexpr bool	isDigit (char c) noexcept
	check if digit.

constexpr bool	isSign (char c) noexcept
	check if sign.

Protected Member Functions inherited from join::StreamReader
virtual int	setNull () override
	set null value.

virtual int	setBool (bool value) override
	set boolean value.

virtual int	setInt (int32_t value) override
	set integer value.

virtual int	setUint (uint32_t value) override
	set unsigned integer value.

virtual int	setInt64 (int64_t value) override
	set 64 bits integer value.

virtual int	setUint64 (uint64_t value) override
	set unsigned 64 bits integer value.

virtual int	setDouble (double value) override
	set real value.

virtual int	setString (const std::string &value) override
	set string value.

virtual int	startArray (uint32_t size=0) override
	start array.

virtual int	stopArray () override
	stop array.

virtual int	startObject (uint32_t size=0) override
	start object.

virtual int	setKey (const std::string &key) override
	set key.

virtual int	stopObject () override
	stop object.

virtual int	setValue (Value &&value)
	set value.

Protected Member Functions inherited from join::SaxHandler
	SaxHandler ()=default
	default constructor.

	SaxHandler (const SaxHandler &other)=default
	copy constructor.

SaxHandler &	operator= (const SaxHandler &other)=default
	copy assignment.

	SaxHandler (SaxHandler &&other)=default
	move constructor.

SaxHandler &	operator= (SaxHandler &&other)=default
	move assignment.

virtual	~SaxHandler ()=default
	destroy instance.

Additional Inherited Members
Protected Attributes inherited from join::StreamReader
std::stack< Value * >	_stack
	stack.

std::string	_curkey
	current key.

Value &	_root
	root.

Static Protected Attributes inherited from join::StreamReader
static constexpr size_t	_maxdepth = 19
	max stack depth.

Detailed Description

JSON reader class.

Constructor & Destructor Documentation

◆ JsonReader() [1/3]

join::JsonReader::JsonReader ( Value & root )

inline

default constructor.

Parameters

root	Value to write.

◆ JsonReader() [2/3]

join::JsonReader::JsonReader ( const JsonReader & other )

delete

copy constructor.

Parameters

other object to copy.

◆ JsonReader() [3/3]

join::JsonReader::JsonReader ( JsonReader && other )

delete

move constructor.

Parameters

other object to move.

◆ ~JsonReader()

virtual join::JsonReader::~JsonReader ( )

virtualdefault

destroy instance.

Member Function Documentation

◆ deserialize() [1/18]

template<JsonReadMode ReadMode = JsonReadMode::None>

int join::JsonReader::deserialize	(	const char *	document,
		size_t	length )

inlinevirtual

deserialize a document.

Parameters

document	document to parse.
length	The length of the document to parse.

Returns: 0 on success, -1 otherwise.

Implements join::StreamReader.

◆ deserialize() [2/18]

int join::JsonReader::deserialize	(	const char *	document,
		size_t	length )

inlineoverridevirtual

deserialize a document.

Parameters

document	document to parse.
length	The length of the document to parse.

Returns: 0 on success, -1 otherwise.

Implements join::StreamReader.

◆ deserialize() [3/18]

template<JsonReadMode ReadMode = JsonReadMode::None>

int join::JsonReader::deserialize	(	const char *	first,
		const char *	last )

inlinevirtual

deserialize a document.

Parameters

first	The first character of the document to parse.
last	The last character of the document to parse.

Returns: 0 on success, -1 otherwise.

Implements join::StreamReader.

◆ deserialize() [4/18]

int join::JsonReader::deserialize	(	const char *	first,
		const char *	last )

inlineoverridevirtual

deserialize a document.

Parameters

first	The first character of the document to parse.
last	The last character of the document to parse.

Returns: 0 on success, -1 otherwise.

Implements join::StreamReader.

◆ deserialize() [5/18]

template<JsonReadMode ReadMode = JsonReadMode::None>

int join::JsonReader::deserialize ( const std::string & document )

inlinevirtual

deserialize a document.

Parameters

document document to deserialize.

Returns: 0 on success, -1 otherwise.

Implements join::StreamReader.

◆ deserialize() [6/18]

int join::JsonReader::deserialize ( const std::string & document )

inlineoverridevirtual

deserialize a document.

Parameters

document document to deserialize.

Returns: 0 on success, -1 otherwise.

Implements join::StreamReader.

◆ deserialize() [7/18]

template<JsonReadMode ReadMode = JsonReadMode::None>

int join::JsonReader::deserialize ( std::fstream & document )

inlinevirtual

deserialize a document.

Parameters

document document to deserialize.

Returns: 0 on success, -1 otherwise.

Implements join::StreamReader.

◆ deserialize() [8/18]

int join::JsonReader::deserialize ( std::fstream & document )

inlineoverridevirtual

deserialize a document.

Parameters

document document to deserialize.

Returns: 0 on success, -1 otherwise.

Implements join::StreamReader.

◆ deserialize() [9/18]

template<JsonReadMode ReadMode = JsonReadMode::None>

int join::JsonReader::deserialize ( std::ifstream & document )

inlinevirtual

deserialize a document.

Parameters

document document to deserialize.

Returns: 0 on success, -1 otherwise.

Implements join::StreamReader.

◆ deserialize() [10/18]

int join::JsonReader::deserialize ( std::ifstream & document )

inlineoverridevirtual

deserialize a document.

Parameters

document document to deserialize.

Returns: 0 on success, -1 otherwise.

Implements join::StreamReader.

◆ deserialize() [11/18]

template<JsonReadMode ReadMode = JsonReadMode::None>

int join::JsonReader::deserialize ( std::iostream & document )

inlinevirtual

deserialize a document.

Parameters

document document to deserialize.

Returns: 0 on success, -1 otherwise.

Implements join::StreamReader.

◆ deserialize() [12/18]

int join::JsonReader::deserialize ( std::iostream & document )

inlineoverridevirtual

deserialize a document.

Parameters

document document to deserialize.

Returns: 0 on success, -1 otherwise.

Implements join::StreamReader.

◆ deserialize() [13/18]

template<JsonReadMode ReadMode = JsonReadMode::None>

int join::JsonReader::deserialize ( std::istream & document )

inlinevirtual

deserialize a document.

Parameters

document document to deserialize.

Returns: 0 on success, -1 otherwise.

Implements join::StreamReader.

◆ deserialize() [14/18]

int join::JsonReader::deserialize ( std::istream & document )

inlineoverridevirtual

deserialize a document.

Parameters

document document to deserialize.

Returns: 0 on success, -1 otherwise.

Implements join::StreamReader.

◆ deserialize() [15/18]

template<JsonReadMode ReadMode = JsonReadMode::None>

int join::JsonReader::deserialize ( std::istringstream & document )

inlinevirtual

deserialize a document.

Parameters

document document to deserialize.

Returns: 0 on success, -1 otherwise.

Implements join::StreamReader.

◆ deserialize() [16/18]

int join::JsonReader::deserialize ( std::istringstream & document )

inlineoverridevirtual

deserialize a document.

Parameters

document document to deserialize.

Returns: 0 on success, -1 otherwise.

Implements join::StreamReader.

◆ deserialize() [17/18]

template<JsonReadMode ReadMode = JsonReadMode::None>

int join::JsonReader::deserialize ( std::stringstream & document )

inlinevirtual

deserialize a document.

Parameters

document document to deserialize.

Returns: 0 on success, -1 otherwise.

Implements join::StreamReader.

◆ deserialize() [18/18]

int join::JsonReader::deserialize ( std::stringstream & document )

inlineoverridevirtual

deserialize a document.

Parameters

document document to deserialize.

Returns: 0 on success, -1 otherwise.

Implements join::StreamReader.

◆ encodeUtf8()

void join::JsonReader::encodeUtf8	(	uint32_t	codepoint,
		std::string &	output )

inlineprotected

encode a Unicode codepoint to UTF-8.

Parameters

codepoint	unicode codepoint to encode.
output	parse output string.

◆ isDigit()

bool join::JsonReader::isDigit ( char c )

inlineconstexprprotectednoexcept

check if digit.

Parameters

c	character to check.

Returns: true if digit, false otherwise.

◆ isLowerAlpha()

bool join::JsonReader::isLowerAlpha ( char c )

inlineconstexprprotectednoexcept

check if lower case alphanumeric character.

Parameters

c	character to check.

Returns: true if lower case alphanumeric character, false otherwise.

◆ isSign()

bool join::JsonReader::isSign ( char c )

inlineconstexprprotectednoexcept

check if sign.

Parameters

c	character to check.

Returns: true if sign, false otherwise.

◆ isUpperAlpha()

bool join::JsonReader::isUpperAlpha ( char c )

inlineconstexprprotectednoexcept

check if upper case alphanumeric character.

Parameters

c	character to check.

Returns: true if upper case alphanumeric character, false otherwise.

◆ operator=() [1/2]

JsonReader & join::JsonReader::operator= ( const JsonReader & other )

delete

copy assignment.

Parameters

other object to copy.

Returns: a reference of the current object.

◆ operator=() [2/2]

JsonReader & join::JsonReader::operator= ( JsonReader && other )

delete

move assignment.

Parameters

other object to move.

Returns: a reference of the current object.

◆ read()

template<JsonReadMode ReadMode, typename ViewType >

int join::JsonReader::read ( ViewType & document )

inlineprotected

parse a document.

Parameters

document document to parse.

Returns: 0 on success, -1 otherwise.

◆ readArray()

template<JsonReadMode ReadMode, typename ViewType >

int join::JsonReader::readArray ( ViewType & document )

inlineprotected

parse an array value.

Parameters

document document to parse.

Returns: 0 on success, -1 otherwise.

◆ readEscaped()

template<typename ViewType >

int join::JsonReader::readEscaped	(	ViewType &	document,
		std::string &	output )

inlineprotected

parse escaped sequence.

Parameters

document	document to parse.
output	parse output string.

Returns: 0 on success, -1 otherwise.

◆ readFalse()

template<typename ViewType >

int join::JsonReader::readFalse ( ViewType & document )

inlineprotected

parse a false value.

Parameters

document document to parse.

Returns: 0 on success, -1 otherwise.

◆ readHex()

template<typename ViewType >

int join::JsonReader::readHex	(	ViewType &	document,
		uint32_t &	u )

inlineprotected

parse a 4-digit hexadecimal sequence..

Parameters

document	document to parse.
u	output variable to store the parsed hexadecimal value.

Returns: 0 on success, -1 otherwise.

◆ readInf()

template<typename ViewType >

int join::JsonReader::readInf	(	ViewType &	document,
		bool	negative )

inlineprotected

parse an infinity value.

Parameters

document document to parse.

Returns: 0 on success, -1 otherwise.

◆ readNan()

template<typename ViewType >

int join::JsonReader::readNan	(	ViewType &	document,
		bool	negative )

inlineprotected

parse a nan value.

Parameters

document document to parse.

Returns: 0 on success, -1 otherwise.

◆ readNull()

template<typename ViewType >

int join::JsonReader::readNull ( ViewType & document )

inlineprotected

parse a null value.

Parameters

document document to parse.

Returns: 0 on success, -1 otherwise.

◆ readNumber()

template<typename ViewType >

int join::JsonReader::readNumber ( ViewType & document )

inlineprotected

parse a number value.

Parameters

document document to parse.

Returns: 0 on success, -1 otherwise.

◆ readObject()

template<JsonReadMode ReadMode, typename ViewType >

int join::JsonReader::readObject ( ViewType & document )

inlineprotected

parse an object value.

Parameters

document document to parse.

Returns: 0 on success, -1 otherwise.

◆ readString()

template<typename ViewType >

int join::JsonReader::readString	(	ViewType &	document,
		bool	isKey = false )

inlineprotected

parse UTF8.

Parameters

document	document to parse.
output	parse output string.

Returns: 0 on success, -1 otherwise.

parse a string value.

Parameters

document	document to parse.
isKey	indicate whether the string to parse is a key or not.

Returns: 0 on success, -1 otherwise.

◆ readTrue()

template<typename ViewType >

int join::JsonReader::readTrue ( ViewType & document )

inlineprotected

parse a true value.

Parameters

document document to parse.

Returns: 0 on success, -1 otherwise.

◆ readUnicode()

template<typename ViewType >

int join::JsonReader::readUnicode	(	ViewType &	document,
		std::string &	output )

inlineprotected

parse unicode.

Parameters

document	document to parse.
output	parse output string.

Returns: 0 on success, -1 otherwise.

◆ readValue()

template<JsonReadMode ReadMode, typename ViewType >

int join::JsonReader::readValue ( ViewType & document )

inlineprotected

parse a JSON value.

Parameters

document document to parse.

Returns: 0 on success, -1 otherwise.

◆ skipWhitespaces() [1/2]

template<JsonReadMode ReadMode, typename ViewType >

std::enable_if<!(ReadMode &JsonReadMode::ParseComments), int >::type join::JsonReader::skipWhitespaces ( ViewType & document )

inlineprotected

skip whitespaces.

Parameters

document document to parse.

Returns: 0 on success, -1 otherwise.

◆ skipWhitespaces() [2/2]

template<JsonReadMode ReadMode, typename ViewType >

std::enable_if<(ReadMode &JsonReadMode::ParseComments), int >::type join::JsonReader::skipWhitespaces ( ViewType & document )

inlineprotected

skip whitespaces with comment parsing.

Parameters

document document to parse.

Returns: 0 on success, -1 otherwise.

◆ strtodFast()

bool join::JsonReader::strtodFast	(	uint64_t	significand,
		int64_t	exponent,
		double &	value )

inlineprotected

convert double using fast path.

Parameters

significand	significand digits.
exponent	exponent.
value	converted value.

Returns: true on success, false otherwise.

◆ strtodSlow()

bool join::JsonReader::strtodSlow	(	const std::string &	num,
		double &	d )

inlineprotected

convert double using strtod.

Parameters

num	number to convert.
value	converted value.

Returns: true on success, false otherwise.

◆ umul192()

void join::JsonReader::umul192	(	uint64_t	hi,
		uint64_t	lo,
		uint64_t	significand,
		uint64_t &	high,
		uint64_t &	middle,
		uint64_t &	low )

inlineprotectednoexcept

multiply 192 bits unsigned integer by 64 bits unsigned integer.

Parameters

hi	high 64 bits of the 128-bit multiplicand.
lo	low 64 bits of the 128-bit multiplicand.
significand	64-bit multiplier.
high	high 64 bits of the 192-bit result.
middle	middle 64 bits of the 192-bit result.
low	low 64 bits of the 192-bit result.

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

data/include/join/json.hpp

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ JsonReader() [1/3]

◆ JsonReader() [2/3]

◆ JsonReader() [3/3]

◆ ~JsonReader()

Member Function Documentation

◆ deserialize() [1/18]

◆ deserialize() [2/18]

◆ deserialize() [3/18]

◆ deserialize() [4/18]

◆ deserialize() [5/18]

◆ deserialize() [6/18]

◆ deserialize() [7/18]

◆ deserialize() [8/18]

◆ deserialize() [9/18]

◆ deserialize() [10/18]

◆ deserialize() [11/18]

◆ deserialize() [12/18]

◆ deserialize() [13/18]

◆ deserialize() [14/18]

◆ deserialize() [15/18]

◆ deserialize() [16/18]

◆ deserialize() [17/18]

◆ deserialize() [18/18]

◆ encodeUtf8()

◆ isDigit()

◆ isLowerAlpha()

◆ isSign()

◆ isUpperAlpha()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ read()

◆ readArray()

◆ readEscaped()

◆ readFalse()

◆ readHex()

◆ readInf()

◆ readNan()

◆ readNull()

◆ readNumber()

◆ readObject()

◆ readString()

◆ readTrue()

◆ readUnicode()

◆ readValue()

◆ skipWhitespaces() [1/2]

◆ skipWhitespaces() [2/2]

◆ strtodFast()

◆ strtodSlow()

◆ umul192()