Represents a JSON value. More...

Collaboration diagram for Json::Value:

[legend]

Classes
class	CZString

union	ValueHolder

Public Types
using	Members = std::vector< std::string >

using	iterator = ValueIterator

using	const_iterator = ValueConstIterator

using	UInt = Json::UInt

using	Int = Json::Int

using	ArrayIndex = UInt

using	ObjectValues = std::map< CZString, Value >

Public Member Functions
	Value (ValueType type=nullValue)
	Create a default Value of the given type. More...

	Value (Int value)

	Value (UInt value)

	Value (double value)

	Value (const char *value)

	Value (const StaticString &value)
	Constructs a value from a static string. More...

	Value (std::string const &value)

	Value (bool value)

	Value (const Value &other)

	~Value ()

Value &	operator= (Value const &other)

Value &	operator= (Value &&other)

	Value (Value &&other) noexcept

void	swap (Value &other) noexcept
	Swap values. More...

ValueType	type () const

const char *	asCString () const

std::string	asString () const
	Returns the unquoted string value. More...

Int	asInt () const

UInt	asUInt () const

double	asDouble () const

bool	asBool () const

bool	isNull () const
	isNull() tests to see if this field is null. More...

bool	isBool () const

bool	isInt () const

bool	isUInt () const

bool	isIntegral () const

bool	isDouble () const

bool	isNumeric () const

bool	isString () const

bool	isArray () const

bool	isArrayOrNull () const

bool	isObject () const

bool	isObjectOrNull () const

bool	isConvertibleTo (ValueType other) const

UInt	size () const
	Number of values in array or object. More...

	operator bool () const
	Returns false if this is an empty array, empty object, empty string, or null. More...

void	clear ()
	Remove all object members and array elements. More...

Value &	operator[] (UInt index)
	Access an array element (zero based index ). More...

const Value &	operator[] (UInt index) const
	Access an array element (zero based index ) (You may need to say 'value[0u]' to get your compiler to distinguish this from the operator[] which takes a string.) More...

Value	get (UInt index, const Value &defaultValue) const
	If the array contains at least index+1 elements, returns the element value, otherwise returns defaultValue. More...

bool	isValidIndex (UInt index) const
	Return true if index < size(). More...

Value &	append (const Value &value)
	Append value to array at the end. More...

Value &	append (Value &&value)

Value &	operator[] (const char *key)
	Access an object value by name, create a null member if it does not exist. More...

const Value &	operator[] (const char *key) const
	Access an object value by name, returns null if there is no member with that name. More...

Value &	operator[] (std::string const &key)
	Access an object value by name, create a null member if it does not exist. More...

const Value &	operator[] (std::string const &key) const
	Access an object value by name, returns null if there is no member with that name. More...

Value &	operator[] (const StaticString &key)
	Access an object value by name, create a null member if it does not exist. More...

Value	get (const char *key, const Value &defaultValue) const
	Return the member named key if it exist, defaultValue otherwise. More...

Value	get (std::string const &key, const Value &defaultValue) const
	Return the member named key if it exist, defaultValue otherwise. More...

Value	removeMember (const char *key)
	Remove and return the named member. More...

Value	removeMember (std::string const &key)
	Same as removeMember(const char*) More...

bool	isMember (const char *key) const
	Return true if the object has a member named key. More...

bool	isMember (std::string const &key) const
	Return true if the object has a member named key. More...

Members	getMemberNames () const
	Return a list of the member names. More...

std::string	toStyledString () const

const_iterator	begin () const

const_iterator	end () const

iterator	begin ()

iterator	end ()

Static Public Attributes
static const Value	null

static const Int	minInt = Int(~(UInt(-1) / 2))

static const Int	maxInt = Int(UInt(-1) / 2)

static const UInt	maxUInt = UInt(-1)

Private Member Functions
Value &	resolveReference (const char *key, bool isStatic)

Private Attributes
union Json::Value::ValueHolder	value_

ValueType	type_: 8

int	allocated_: 1

Friends
class	ValueIteratorBase

bool	operator== (const Value &, const Value &)

bool	operator< (const Value &, const Value &)

Detailed Description

Represents a JSON value.

This class is a discriminated union wrapper that can represent a:

signed integer [range: Value::minInt - Value::maxInt]
unsigned integer (range: 0 - Value::maxUInt)
double
UTF-8 string
boolean
'null'
an ordered list of Value
collection of name/value pairs (javascript object)

The type of the held value is represented by a ValueType and can be obtained using type().

values of an objectValue or arrayValue can be accessed using operator[]() methods. Non const methods will automatically create the a nullValue element if it does not exist. The sequence of an arrayValue will be automatically resize and initialized with nullValue. resize() can be used to enlarge or truncate an arrayValue.

The get() methods can be used to obtain a default value in the case the required element does not exist.

It is possible to iterate over the list of a objectValue values using the getMemberNames() method.

Definition at line 145 of file json_value.h.

Member Typedef Documentation

◆ Members

using Json::Value::Members = std::vector<std::string>

Definition at line 150 of file json_value.h.

◆ iterator

using Json::Value::iterator = ValueIterator

Definition at line 151 of file json_value.h.

◆ const_iterator

using Json::Value::const_iterator = ValueConstIterator

Definition at line 152 of file json_value.h.

◆ UInt

using Json::Value::UInt = Json::UInt

Definition at line 153 of file json_value.h.

◆ Int

using Json::Value::Int = Json::Int

Definition at line 154 of file json_value.h.

◆ ArrayIndex

using Json::Value::ArrayIndex = UInt

Definition at line 155 of file json_value.h.

◆ ObjectValues

using Json::Value::ObjectValues = std::map<CZString, Value>

Definition at line 194 of file json_value.h.

Constructor & Destructor Documentation

◆ Value() [1/10]

Json::Value::Value ( ValueType type = nullValue )

Create a default Value of the given type.

This is a very useful constructor. To create an empty array, pass arrayValue. To create an empty object, pass objectValue. Another Value can then be set to this one by assignment. This is useful since clear() and resize() will not alter types.

   Examples:

Json::Value null_value; // null
Json::Value arr_value(Json::arrayValue); // []
Json::Value obj_value(Json::objectValue); // {}

Definition at line 180 of file json_value.cpp.

◆ Value() [2/10]

Json::Value::Value ( Int value )

Definition at line 214 of file json_value.cpp.

◆ Value() [3/10]

Json::Value::Value ( UInt value )

Definition at line 219 of file json_value.cpp.

◆ Value() [4/10]

Json::Value::Value ( double value )

Definition at line 224 of file json_value.cpp.

◆ Value() [5/10]

Json::Value::Value ( const char * value )

Definition at line 229 of file json_value.cpp.

◆ Value() [6/10]

Json::Value::Value ( const StaticString & value )

Constructs a value from a static string.

Like other value string constructor but do not duplicate the string for internal storage. The given string must remain alive after the call to this constructor. Example of usage:

Json::Value aValue( StaticString("some text") );

Definition at line 240 of file json_value.cpp.

◆ Value() [7/10]

Json::Value::Value ( std::string const & value )

Definition at line 234 of file json_value.cpp.

◆ Value() [8/10]

Json::Value::Value ( bool value )

Definition at line 245 of file json_value.cpp.

◆ Value() [9/10]

Json::Value::Value ( const Value & other )

Definition at line 250 of file json_value.cpp.

◆ ~Value()

Json::Value::~Value ( )

Definition at line 284 of file json_value.cpp.

◆ Value() [10/10]

Json::Value::Value ( Value && other )

noexcept

Definition at line 320 of file json_value.cpp.

Member Function Documentation

◆ operator=() [1/2]

Value & Json::Value::operator= ( Value const & other )

Definition at line 313 of file json_value.cpp.

◆ operator=() [2/2]

Value & Json::Value::operator= ( Value && other )

Definition at line 328 of file json_value.cpp.

◆ swap()

void Json::Value::swap ( Value & other )

noexcept

Swap values.

Definition at line 336 of file json_value.cpp.

◆ type()

ValueType Json::Value::type ( ) const

Definition at line 350 of file json_value.cpp.

◆ asCString()

const char * Json::Value::asCString ( ) const

Definition at line 462 of file json_value.cpp.

◆ asString()

std::string Json::Value::asString ( ) const

Returns the unquoted string value.

Definition at line 469 of file json_value.cpp.

◆ asInt()

Value::Int Json::Value::asInt ( ) const

Definition at line 503 of file json_value.cpp.

◆ asUInt()

Value::UInt Json::Value::asUInt ( ) const

Definition at line 545 of file json_value.cpp.

◆ asDouble()

double Json::Value::asDouble ( ) const

Definition at line 587 of file json_value.cpp.

◆ asBool()

bool Json::Value::asBool ( ) const

Definition at line 619 of file json_value.cpp.

◆ isNull()

bool Json::Value::isNull ( ) const

isNull() tests to see if this field is null.

Don't use this method to test for emptiness: use empty().

Definition at line 967 of file json_value.cpp.

◆ isBool()

bool Json::Value::isBool ( ) const

Definition at line 973 of file json_value.cpp.

◆ isInt()

bool Json::Value::isInt ( ) const

Definition at line 979 of file json_value.cpp.

◆ isUInt()

bool Json::Value::isUInt ( ) const

Definition at line 985 of file json_value.cpp.

◆ isIntegral()

bool Json::Value::isIntegral ( ) const

Definition at line 991 of file json_value.cpp.

◆ isDouble()

bool Json::Value::isDouble ( ) const

Definition at line 997 of file json_value.cpp.

◆ isNumeric()

bool Json::Value::isNumeric ( ) const

Definition at line 1003 of file json_value.cpp.

◆ isString()

bool Json::Value::isString ( ) const

Definition at line 1009 of file json_value.cpp.

◆ isArray()

bool Json::Value::isArray ( ) const

Definition at line 1015 of file json_value.cpp.

◆ isArrayOrNull()

bool Json::Value::isArrayOrNull ( ) const

Definition at line 1021 of file json_value.cpp.

◆ isObject()

bool Json::Value::isObject ( ) const

Definition at line 1027 of file json_value.cpp.

◆ isObjectOrNull()

bool Json::Value::isObjectOrNull ( ) const

Definition at line 1033 of file json_value.cpp.

◆ isConvertibleTo()

bool Json::Value::isConvertibleTo ( ValueType other ) const

Definition at line 651 of file json_value.cpp.

◆ size()

Value::UInt Json::Value::size ( ) const

Number of values in array or object.

Definition at line 706 of file json_value.cpp.

◆ operator bool()

Json::Value::operator bool ( ) const

explicit

Returns false if this is an empty array, empty object, empty string, or null.

Definition at line 738 of file json_value.cpp.

◆ clear()

void Json::Value::clear ( )

Remove all object members and array elements.

Precondition: type() is arrayValue, objectValue, or nullValue

Postcondition: type() is unchanged

Definition at line 753 of file json_value.cpp.

◆ operator[]() [1/7]

Value & Json::Value::operator[] ( UInt index )

Access an array element (zero based index ).

If the array contains less than index element, then null value are inserted in the array so that its size is index+1. (You may need to say 'value[0u]' to get your compiler to distinguish this from the operator[] which takes a string.)

Definition at line 771 of file json_value.cpp.

◆ operator[]() [2/7]

const Value & Json::Value::operator[] ( UInt index ) const

Access an array element (zero based index ) (You may need to say 'value[0u]' to get your compiler to distinguish this from the operator[] which takes a string.)

Definition at line 790 of file json_value.cpp.

◆ get() [1/3]

Value Json::Value::get	(	UInt	index,
		const Value &	defaultValue
	)		const

If the array contains at least index+1 elements, returns the element value, otherwise returns defaultValue.

Definition at line 834 of file json_value.cpp.

◆ isValidIndex()

bool Json::Value::isValidIndex ( UInt index ) const

Return true if index < size().

Definition at line 841 of file json_value.cpp.

◆ append() [1/2]

Value & Json::Value::append ( const Value & value )

Append value to array at the end.

Equivalent to jsonvalue[jsonvalue.size()] = value;

Definition at line 882 of file json_value.cpp.

◆ append() [2/2]

Value & Json::Value::append ( Value && value )

Definition at line 888 of file json_value.cpp.

◆ operator[]() [3/7]

Value & Json::Value::operator[] ( const char * key )

Access an object value by name, create a null member if it does not exist.

Definition at line 807 of file json_value.cpp.

◆ operator[]() [4/7]

const Value & Json::Value::operator[] ( const char * key ) const

Access an object value by name, returns null if there is no member with that name.

Definition at line 847 of file json_value.cpp.

◆ operator[]() [5/7]

Value & Json::Value::operator[] ( std::string const & key )

Access an object value by name, create a null member if it does not exist.

Definition at line 864 of file json_value.cpp.

◆ operator[]() [6/7]

const Value & Json::Value::operator[] ( std::string const & key ) const

Access an object value by name, returns null if there is no member with that name.

Definition at line 870 of file json_value.cpp.

◆ operator[]() [7/7]

Value & Json::Value::operator[] ( const StaticString & key )

Access an object value by name, create a null member if it does not exist.

If the object as no entry for that name, then the member name used to store the new entry is not duplicated. Example of use:

Json::Value object;
static const StaticString code("code");
object[code] = 1234;

Definition at line 876 of file json_value.cpp.

◆ get() [2/3]

Value Json::Value::get	(	const char *	key,
		const Value &	defaultValue
	)		const

Return the member named key if it exist, defaultValue otherwise.

Definition at line 894 of file json_value.cpp.

◆ get() [3/3]

Value Json::Value::get	(	std::string const &	key,
		const Value &	defaultValue
	)		const

Return the member named key if it exist, defaultValue otherwise.

Definition at line 901 of file json_value.cpp.

◆ removeMember() [1/2]

Value Json::Value::removeMember ( const char * key )

Remove and return the named member.

Do nothing if it did not exist.

Returns: the removed Value, or null.

Precondition: type() is objectValue or nullValue

Postcondition: type() is unchanged

Definition at line 907 of file json_value.cpp.

◆ removeMember() [2/2]

Value Json::Value::removeMember ( std::string const & key )

Same as removeMember(const char*)

Definition at line 926 of file json_value.cpp.

◆ isMember() [1/2]

bool Json::Value::isMember ( const char * key ) const

Return true if the object has a member named key.

Definition at line 932 of file json_value.cpp.

◆ isMember() [2/2]

bool Json::Value::isMember ( std::string const & key ) const

Return true if the object has a member named key.

Definition at line 942 of file json_value.cpp.

◆ getMemberNames()

Value::Members Json::Value::getMemberNames ( ) const

Return a list of the member names.

If null, return an empty list.

Precondition: type() is objectValue or nullValue

Postcondition: if type() was nullValue, it remains nullValue

Definition at line 948 of file json_value.cpp.

◆ toStyledString()

std::string Json::Value::toStyledString ( ) const

Definition at line 1039 of file json_value.cpp.

◆ begin() [1/2]

Value::iterator Json::Value::begin ( ) const

Definition at line 1046 of file json_value.cpp.

◆ end() [1/2]

Value::iterator Json::Value::end ( ) const

Definition at line 1064 of file json_value.cpp.

◆ begin() [2/2]

iterator Json::Value::begin ( )

◆ end() [2/2]

iterator Json::Value::end ( )

◆ resolveReference()

Value & Json::Value::resolveReference	(	const char *	key,
		bool	isStatic
	)

private

Definition at line 813 of file json_value.cpp.

Friends And Related Function Documentation

◆ ValueIteratorBase

friend class ValueIteratorBase

friend

Definition at line 147 of file json_value.h.

◆ operator==

bool operator==	(	const Value &	,
		const Value &
	)

friend

Definition at line 416 of file json_value.cpp.

◆ operator<

bool operator<	(	const Value &	,
		const Value &
	)

friend

Definition at line 367 of file json_value.cpp.

Member Data Documentation

◆ null

const Value Json::Value::null

static

Definition at line 157 of file json_value.h.

◆ minInt

const Int Json::Value::minInt = Int(~(UInt(-1) / 2))

static

Definition at line 158 of file json_value.h.

◆ maxInt

const Int Json::Value::maxInt = Int(UInt(-1) / 2)

static

Definition at line 159 of file json_value.h.

◆ maxUInt

const UInt Json::Value::maxUInt = UInt(-1)

static

Definition at line 160 of file json_value.h.

◆ value_

union Json::Value::ValueHolder Json::Value::value_

private

◆ type_

ValueType Json::Value::type_

private

Definition at line 432 of file json_value.h.

◆ allocated_

int Json::Value::allocated_

private

Definition at line 433 of file json_value.h.

Classes

Public Types

Public Member Functions

Static Public Attributes

Private Member Functions

Private Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ Members

◆ iterator

◆ const_iterator

◆ UInt

◆ Int

◆ ArrayIndex

◆ ObjectValues

Constructor & Destructor Documentation

◆ Value() [1/10]

◆ Value() [2/10]

◆ Value() [3/10]

◆ Value() [4/10]

◆ Value() [5/10]

◆ Value() [6/10]

◆ Value() [7/10]

◆ Value() [8/10]

◆ Value() [9/10]

◆ ~Value()

◆ Value() [10/10]

Member Function Documentation

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ swap()

◆ type()

◆ asCString()

◆ asString()

◆ asInt()

◆ asUInt()

◆ asDouble()

◆ asBool()

◆ isNull()

◆ isBool()

◆ isInt()

◆ isUInt()

◆ isIntegral()

◆ isDouble()

◆ isNumeric()

◆ isString()

◆ isArray()

◆ isArrayOrNull()

◆ isObject()

◆ isObjectOrNull()

◆ isConvertibleTo()

◆ size()

◆ operator bool()

◆ clear()

◆ operator[]() [1/7]

◆ operator[]() [2/7]

◆ get() [1/3]

◆ isValidIndex()

◆ append() [1/2]

◆ append() [2/2]

◆ operator[]() [3/7]

◆ operator[]() [4/7]

◆ operator[]() [5/7]

◆ operator[]() [6/7]

◆ operator[]() [7/7]

◆ get() [2/3]

◆ get() [3/3]

◆ removeMember() [1/2]

◆ removeMember() [2/2]

◆ isMember() [1/2]

◆ isMember() [2/2]

◆ getMemberNames()

◆ toStyledString()

◆ begin() [1/2]

◆ end() [1/2]

◆ begin() [2/2]

◆ end() [2/2]

◆ resolveReference()

Friends And Related Function Documentation