JSON namespace. More...

Classes
class	Factory
	JSON mapper factory. More...
class	GenericMapper
	Generic mapper. More...
class	JSONItem
class	JSONMapper
	JSON mapper with mapping options. More...
class	MappingError
	Mapping error. More...
struct	MappingOptions
	JSON mapping options. More...
class	ObjectMapper
	JSON complex object mapper. More...
class	PrimitiveMapper
	JSON primitive types mapper. More...
class	Reader
	JSON reader based on events. More...
class	ReaderContext
	JSON reader context. More...
class	WriterContext
	JSON writer context. More...

Typedefs
using	LexFunc = std::function<bool(anch::json::ReaderContext&)>
using	AddItem = std::function<bool(anch::json::ReaderContext&)>
using	PushItem = std::function<void(const std::string&, anch::json::ReaderContext&)>
using	jint = int64_t
using	juint = uint64_t
using	jfloat = long double
template<typename T>
using	SerializeFn = std::function<void(const T&, std::ostream&, const anch::json::MappingOptions&)>
template<typename T>
using	DeserializeFn = std::function<bool(T&, anch::json::ReaderContext&)>

Enumerations
enum class	ErrorCode { INVALID_FORMAT = 0 , UNEXPECTED_FIELD , POTENTIAL_OVERFLOW , UNKNOWN = 9999 }
enum class	EventType { VNULL = 0 , TRUE , FALSE , FIELD , NUMBER , STRING , BEGIN_OBJECT , END_OBJECT , BEGIN_ARRAY , END_ARRAY }

Functions
template<typename T>
constexpr bool	isPrimitive ()
	Check if type is a primitive JSON type.
template<typename T>
void	registerObject (anch::json::ObjectMapper< T > &mapper)
template<typename T>
void	serialize (const T &value, std::ostream &out, const anch::json::MappingOptions &options=anch::json::DEFAULT_MAPPING_OPTIONS)
template<template< typename > typename C, typename T>
void	serialize (const C< T > &value, std::ostream &out, const anch::json::MappingOptions &options=anch::json::DEFAULT_MAPPING_OPTIONS)
template<typename T>
void	serialize (anch::Flux< T > &value, std::ostream &out, const anch::json::MappingOptions &options=anch::json::DEFAULT_MAPPING_OPTIONS)
template<typename T>
void	serialize (const std::map< std::string, T > &value, std::ostream &out, const anch::json::MappingOptions &options=anch::json::DEFAULT_MAPPING_OPTIONS)
template<typename T>
std::string	serialize (const T &value, const anch::json::MappingOptions &options=anch::json::DEFAULT_MAPPING_OPTIONS)
template<template< typename > typename C, typename T>
std::string	serialize (const C< T > &value, const anch::json::MappingOptions &options=anch::json::DEFAULT_MAPPING_OPTIONS)
template<typename T>
std::string	serialize (const std::map< std::string, T > &value, const anch::json::MappingOptions &options=anch::json::DEFAULT_MAPPING_OPTIONS)
template<typename T>
void	deserialize (T &value, std::istream &input, const anch::json::MappingOptions &options=anch::json::DEFAULT_MAPPING_OPTIONS)
template<typename T>
T	deserialize (std::istream &input, const anch::json::MappingOptions &options=anch::json::DEFAULT_MAPPING_OPTIONS)
template<template< typename > typename C, typename T>
void	deserialize (C< T > &values, std::istream &input, const anch::json::MappingOptions &options=anch::json::DEFAULT_MAPPING_OPTIONS)
template<typename T>
void	deserialize (std::map< std::string, T > &values, std::istream &input, const anch::json::MappingOptions &options=anch::json::DEFAULT_MAPPING_OPTIONS)
void	lexTrue (anch::json::ReaderContext &context)
void	lexFalse (anch::json::ReaderContext &context)
bool	lexBoolean (bool &value, anch::json::ReaderContext &context)
void	parseDecimal (anch::json::ReaderContext &context)
bool	lexInteger (anch::json::jint &value, anch::json::ReaderContext &context)
bool	lexUInteger (anch::json::juint &value, anch::json::ReaderContext &context)
void	parseNumber (anch::json::ReaderContext &context)
bool	lexNumber (double &value, anch::json::ReaderContext &context)
void	lexStringContent (anch::json::ReaderContext &context)
bool	lexString (std::string &value, anch::json::ReaderContext &context)
bool	lexField (std::string &field, anch::json::ReaderContext &context)
char	discardFail (anch::json::ReaderContext &context)
char	lexDiscard (anch::json::ReaderContext &context)
void	lexNull (anch::json::ReaderContext &context)
bool	objectHasValueLex (anch::json::ReaderContext &context)
void	lexObject (const std::map< std::string, anch::json::LexFunc > &readers, std::set< std::string > &fields, anch::json::ReaderContext &context)
void	lexArray (anch::json::AddItem addFunc, anch::json::ReaderContext &context)
void	lexMap (anch::json::PushItem pushFunc, anch::json::ReaderContext &context)
void	lexUnknown (anch::json::ReaderContext &context)
void	lexUnknownFail (anch::json::ReaderContext &context)

Variables
const char	STRING_DELIMITER = '"'
const char	FIELD_SEPARATOR = ','
const char	FIELD_VALUE_SEPARATOR = ':'
const char	OBJECT_BEGIN = '{'
const char	OBJECT_END = '}'
const char	ARRAY_BEGIN = '['
const char	ARRAY_END =']'
const std::optional< std::string >	EMPTY_FIELD
MappingOptions	DEFAULT_MAPPING_OPTIONS

Detailed Description

JSON namespace.

Provides serialization and deserialization functions for JSON format.

Typedef Documentation

◆ AddItem

using anch::json::AddItem = std::function<bool(anch::json::ReaderContext&)>

Parse and add item to array function (return true when ']' has been found, false otherwise)

◆ DeserializeFn

template<typename T>

using anch::json::DeserializeFn = std::function<bool(T&, anch::json::ReaderContext&)>

Deserialization function definition

◆ jfloat

using anch::json::jfloat = long double

Maximum float precision declaration

◆ jint

using anch::json::jint = int64_t

Maximum signed integer precision declaration

◆ juint

using anch::json::juint = uint64_t

Maximum unsigned integer precision declaration

◆ LexFunc

using anch::json::LexFunc = std::function<bool(anch::json::ReaderContext&)>

Object lexer function

◆ PushItem

using anch::json::PushItem = std::function<void(const std::string&, anch::json::ReaderContext&)>

Parse and insert item to map

◆ SerializeFn

template<typename T>

using anch::json::SerializeFn = std::function<void(const T&, std::ostream&, const anch::json::MappingOptions&)>

Serialization function definition

Enumeration Type Documentation

◆ ErrorCode

enum class anch::json::ErrorCode

strong

JSON mapping error code

Author: Vincent Lachenal

Since: 0.1

Enumerator
INVALID_FORMAT	Invalid format
UNEXPECTED_FIELD	Found unexpected field (and parsing options disallow it)
POTENTIAL_OVERFLOW	Found too many space characters or charcters in field name (according to parsing option)
UNKNOWN	Unexpected error code

◆ EventType

enum class anch::json::EventType

strong

Reader found element type

Author: Vincent Lachenal

Since: 0.1

Enumerator
VNULL	'null' value (no value)
TRUE	Boolean 'true' value (no value)
FALSE	Boolean 'false' value (no value)
FIELD	Field value (value stored as std::string)
NUMBER	Number value (value stored as `double`)
STRING	String value (value as stored std::string)
BEGIN_OBJECT	Begin object (no value)
END_OBJECT	End object (no value)
BEGIN_ARRAY	Begin array (no value)
END_ARRAY	End array (no value)

Function Documentation

◆ deserialize() [1/4]

template<template< typename > typename C, typename T>

void anch::json::deserialize	(	C< T > &	values,
		std::istream &	input,
		const anch::json::MappingOptions &	options = anch::json::DEFAULT_MAPPING_OPTIONS )

Deserialize objects (it can also work with std::optional, std::shared_ptr, ...)

Template Parameters

T	the object's type
C	the container's type

Parameters

values	the values to fill
input	the input stream to parse
options	the options to use

◆ deserialize() [2/4]

template<typename T>

T anch::json::deserialize	(	std::istream &	input,
		const anch::json::MappingOptions &	options = anch::json::DEFAULT_MAPPING_OPTIONS )

Deserialize object

Template Parameters

T	the object type

Parameters

input	the input stream to parse
options	the options to use

Returns: the deserialized object by copy

◆ deserialize() [3/4]

template<typename T>

void anch::json::deserialize	(	std::map< std::string, T > &	values,
		std::istream &	input,
		const anch::json::MappingOptions &	options = anch::json::DEFAULT_MAPPING_OPTIONS )

Deserialize objects

Template Parameters

T	the object type

Parameters

values	the values to fill
input	the input stream to parse
options	the options to use

◆ deserialize() [4/4]

template<typename T>

void anch::json::deserialize	(	T &	value,
		std::istream &	input,
		const anch::json::MappingOptions &	options = anch::json::DEFAULT_MAPPING_OPTIONS )

Deserialize object

Template Parameters

T	the object type

Parameters

value	the value to fill
input	the input stream to parse
options	the options to use

◆ discardFail()

char anch::json::discardFail ( anch::json::ReaderContext & context )

Fail on any discardable character

Parameters

context the parser context

Returns: the not discardable character

Exceptions

anch::json::MappingError discardable charater has been found

◆ isPrimitive()

template<typename T>

bool anch::json::isPrimitive ( )

constexpr

Check if type is a primitive JSON type.

When not specialzed, the function always return false .
Every C basic types are defined as primitive. std::string and std::string_view are also defined as primitive.

You can declare any type as primitive with template function specialization.

Template Parameters

T	the type to check

Returns: true if type is a JSON primitive type, false otherwise

◆ lexArray()

void anch::json::lexArray	(	anch::json::AddItem	addFunc,
		anch::json::ReaderContext &	context )

Parse array

Parameters

addFunc	parse and add elem to array function
context	the context

Exceptions

anch::json::MappingError parsing error

◆ lexBoolean()

bool anch::json::lexBoolean	(	bool &	value,
		anch::json::ReaderContext &	context )

Boolean value lexer.
Possible values are: null, true and false

Parameters

value	the boolean value to store in (not set when `null` has been found)
context	the parser context

Returns: false when null , true otherwise

Exceptions

anch::json::MappingError parsing error

◆ lexDiscard()

char anch::json::lexDiscard ( anch::json::ReaderContext & context )

Consume stream until unescapable character

Parameters

context the parser context

Returns: the not discardable character

Exceptions

anch::json::MappingError maximum number of discardable charater has been reached

◆ lexFalse()

void anch::json::lexFalse ( anch::json::ReaderContext & context )

'false' value lexer.

Parameters

context the parser context

Exceptions

anch::json::MappingError parsing error

◆ lexField()

bool anch::json::lexField	(	std::string &	field,
		anch::json::ReaderContext &	context )

Field lexer function.
This lexer will look for " character to begin and end with ".
If begin character is not found, field will be empty.
If " end character is not found (according to options and stream), it will raised exception

Parameters

field	the field to fill when found
context	the parser context

Returns: true when found, false otherwise

Exceptions

anch::json::MappingError parsing error

◆ lexInteger()

bool anch::json::lexInteger	(	anch::json::jint &	value,
		anch::json::ReaderContext &	context )

Signed integer value lexer.
Possible values are: null and signed integer

Parameters

value	the signed value to store in (not set when `null` has been found)
context	the parser context

Returns: false when null , true otherwise

Exceptions

anch::json::MappingError parsing error

◆ lexMap()

void anch::json::lexMap	(	anch::json::PushItem	pushFunc,
		anch::json::ReaderContext &	context )

Parse map

Parameters

pushFunc	parse and add elem to map function
context	the context

Exceptions

anch::json::MappingError parsing error

◆ lexNull()

void anch::json::lexNull ( anch::json::ReaderContext & context )

'null' value lexer.

Parameters

context the parser context

Exceptions

anch::json::MappingError parsing error

◆ lexNumber()

bool anch::json::lexNumber	(	double &	value,
		anch::json::ReaderContext &	context )

Floating integer (double) value lexer.
Possible values are: null and floating integer value (can parse exponential representation).

Parameters

value	the value to write in (not set when `null` has been found)
context	the parser context

Returns: false when null , true otherwise

Exceptions

anch::json::MappingError parsing error

◆ lexObject()

void anch::json::lexObject	(	const std::map< std::string, anch::json::LexFunc > &	readers,
		std::set< std::string > &	fields,
		anch::json::ReaderContext &	context )

Object lexer function.

Parameters

readers	the declared fields and their reader function
fields	the found fields to register in
context	the parser context

Exceptions

anch::json::MappingError parsing error

◆ lexString()

bool anch::json::lexString	(	std::string &	value,
		anch::json::ReaderContext &	context )

String lexer function.
This lexer will look for " character to begin and end with ".
If begin character is not found, field will be empty.
If " end character is not found (according to options and stream), it will raised exception

Parameters

value	the string value to fill when found
context	the parser context

Returns: false when null has been found, true otherwise

Exceptions

anch::json::MappingError parsing error

◆ lexStringContent()

void anch::json::lexStringContent ( anch::json::ReaderContext & context )

Lex string content (between the '"').
The result will be stored in the context buffer.

Parameters

context the JSON context

◆ lexTrue()

void anch::json::lexTrue ( anch::json::ReaderContext & context )

'true' value lexer.

Parameters

context the parser context

Exceptions

anch::json::MappingError parsing error

◆ lexUInteger()

bool anch::json::lexUInteger	(	anch::json::juint &	value,
		anch::json::ReaderContext &	context )

Unsigned integer value lexer.
Possible values are: null and unsigned integer (min value is always 0)

Parameters

value	the unsigned value to store in (not set when `null` has been found)
context	the parser context

Returns: false when null , true otherwise

Exceptions

anch::json::MappingError parsing error

◆ lexUnknown()

void anch::json::lexUnknown ( anch::json::ReaderContext & context )

Parse unknown field value

Parameters

context the context

Exceptions

anch::json::MappingError parsing error

◆ lexUnknownFail()

void anch::json::lexUnknownFail ( anch::json::ReaderContext & context )

Raise anch::json::MappingError

Parameters

context the context

Exceptions

anch::json::MappingError parsing error

◆ objectHasValueLex()

bool anch::json::objectHasValueLex ( anch::json::ReaderContext & context )

Check if object has value (start with '{') or is null

Parameters

context the parser context

Returns: object has value

Exceptions

anch::json::MappingError parsing error

◆ parseDecimal()

void anch::json::parseDecimal ( anch::json::ReaderContext & context )

Parse decimale digits and store them to context value's buffer

Parameters

context the context

◆ parseNumber()

void anch::json::parseNumber ( anch::json::ReaderContext & context )

Parse float.
End parsing at first unrecognized character.

Parameters

context the parser context

◆ registerObject()

template<typename T>

void anch::json::registerObject ( anch::json::ObjectMapper< T > & mapper )

Fields registry function
This function has to be specialized for each class/structure which has to be serialized/deserialized.

Template Parameters

T	the object type

Parameters

mapper the ObjectMapper to use

◆ serialize() [1/7]

template<typename T>

void anch::json::serialize	(	anch::Flux< T > &	value,
		std::ostream &	out,
		const anch::json::MappingOptions &	options = anch::json::DEFAULT_MAPPING_OPTIONS )

Serialize object's flux.
Error handler has to be set before this method call when needed. Consumer and finalize functions are set in this method.
This method will lock the processing until anch::Flux::finalize method has not be called (or error happened and throw itself).
This function is implemented in header imkplementation instead uses GenericMapper implementation.

Template Parameters

T	the object type

Parameters

value	the objects to serialize
out	the output stream to write in
options	the options to use

◆ serialize() [2/7]

template<template< typename > typename C, typename T>

std::string anch::json::serialize	(	const C< T > &	value,
		const anch::json::MappingOptions &	options = anch::json::DEFAULT_MAPPING_OPTIONS )

Serialize objects (it can also work with std::optional, std::shared_ptr, ...)

Template Parameters

T	the object type
C	the container's type

Parameters

value	the object to serialize
options	the options to use

Returns: the serialized objects as std::string

◆ serialize() [3/7]

template<template< typename > typename C, typename T>

void anch::json::serialize	(	const C< T > &	value,
		std::ostream &	out,
		const anch::json::MappingOptions &	options = anch::json::DEFAULT_MAPPING_OPTIONS )

Serialize objects (it can also work with std::optional, std::shared_ptr, ...)

Template Parameters

T	the object type
C	the container's type

Parameters

value	the objects to serialize
out	the output stream to write in
options	the options to use

◆ serialize() [4/7]

template<typename T>

std::string anch::json::serialize	(	const std::map< std::string, T > &	value,
		const anch::json::MappingOptions &	options = anch::json::DEFAULT_MAPPING_OPTIONS )

Serialize objects

Template Parameters

T	the object type

Parameters

value	the object to serialize
options	the options to use

Returns: the serialized objects as std::string

◆ serialize() [5/7]

template<typename T>

void anch::json::serialize	(	const std::map< std::string, T > &	value,
		std::ostream &	out,
		const anch::json::MappingOptions &	options = anch::json::DEFAULT_MAPPING_OPTIONS )

Serialize objects

Template Parameters

T	the object type

Parameters

value	the objects to serialize
out	the output stream to write in
options	the options to use

◆ serialize() [6/7]

template<typename T>

std::string anch::json::serialize	(	const T &	value,
		const anch::json::MappingOptions &	options = anch::json::DEFAULT_MAPPING_OPTIONS )

Serialize object

Template Parameters

T	the object type

Parameters

value	the object to serialize
options	the options to use

Returns: the serialized object as std::string

◆ serialize() [7/7]

template<typename T>

void anch::json::serialize	(	const T &	value,
		std::ostream &	out,
		const anch::json::MappingOptions &	options = anch::json::DEFAULT_MAPPING_OPTIONS )

Serialize object

Template Parameters

T	the object type

Parameters

value	the object to serialize
out	the output stream to write in
options	the options to use

Variable Documentation

◆ ARRAY_BEGIN

const char anch::json::ARRAY_BEGIN = '['

JSON start array ('[')

◆ ARRAY_END

const char anch::json::ARRAY_END =']'

JSON start array (']')

◆ DEFAULT_MAPPING_OPTIONS

MappingOptions anch::json::DEFAULT_MAPPING_OPTIONS

extern

Default mapping options. It is not a constant so it can be changed in your application initialization.

◆ EMPTY_FIELD

const std::optional<std::string> anch::json::EMPTY_FIELD

extern

No field name constant value

◆ FIELD_SEPARATOR

const char anch::json::FIELD_SEPARATOR = ','

JSON fields delimiter (',')

◆ FIELD_VALUE_SEPARATOR

const char anch::json::FIELD_VALUE_SEPARATOR = ':'

JSON fiel/value delimiter (':')

◆ OBJECT_BEGIN

const char anch::json::OBJECT_BEGIN = '{'

JSON start object ('{')

◆ OBJECT_END

const char anch::json::OBJECT_END = '}'

JSON end object ('}')

◆ STRING_DELIMITER

const char anch::json::STRING_DELIMITER = '"'

JSON caracters string delimiter ('"')

Classes

Typedefs

Enumerations

Functions

Variables

Detailed Description

Typedef Documentation

◆ AddItem

◆ DeserializeFn

◆ jfloat

◆ jint

◆ juint

◆ LexFunc

◆ PushItem

◆ SerializeFn

Enumeration Type Documentation

◆ ErrorCode

◆ EventType

Function Documentation

◆ deserialize() [1/4]

◆ deserialize() [2/4]

◆ deserialize() [3/4]

◆ deserialize() [4/4]

◆ discardFail()

◆ isPrimitive()

◆ lexArray()

◆ lexBoolean()

◆ lexDiscard()

◆ lexFalse()

◆ lexField()

◆ lexInteger()

◆ lexMap()

◆ lexNull()

◆ lexNumber()

◆ lexObject()

◆ lexString()

◆ lexStringContent()

◆ lexTrue()

◆ lexUInteger()

◆ lexUnknown()

◆ lexUnknownFail()

◆ objectHasValueLex()

◆ parseDecimal()

◆ parseNumber()

◆ registerObject()

◆ serialize() [1/7]

◆ serialize() [2/7]

◆ serialize() [3/7]

◆ serialize() [4/7]

◆ serialize() [5/7]

◆ serialize() [6/7]

◆ serialize() [7/7]

Variable Documentation

◆ ARRAY_BEGIN

◆ ARRAY_END

◆ DEFAULT_MAPPING_OPTIONS

◆ EMPTY_FIELD

◆ FIELD_SEPARATOR

◆ FIELD_VALUE_SEPARATOR

◆ OBJECT_BEGIN

◆ OBJECT_END

◆ STRING_DELIMITER