JsonCpp project page Classes Namespace JsonCpp home page

Classes | Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Friends | List of all members
Json::Value Class Reference

Represents a JSON value. More...

#include <json/value.h>

Public Types

using Members = std::vector< String >
 
using iterator = ValueIterator
 
using const_iterator = ValueConstIterator
 
using UInt = Json::UInt
 
using Int = Json::Int
 
using UInt64 = Json::UInt64
 
using Int64 = Json::Int64
 
using LargestInt = Json::LargestInt
 
using LargestUInt = Json::LargestUInt
 
using ArrayIndex = Json::ArrayIndex
 
using value_type = std::string
 

Public Member Functions

 Value (ValueType type=nullValue)
 Create a default Value of the given type. More...
 
 Value (Int value)
 
 Value (UInt value)
 
 Value (Int64 value)
 
 Value (UInt64 value)
 
 Value (double value)
 
 Value (const char *value)
 Copy til first 0. (NULL causes to seg-fault.) More...
 
 Value (const char *begin, const char *end)
 Copy all, incl zeroes. More...
 
 Value (const StaticString &value)
 Constructs a value from a static string. More...
 
 Value (const String &value)
 
 Value (bool value)
 
 Value (std::nullptr_t ptr)=delete
 
 Value (const Value &other)
 
 Value (Value &&other) noexcept
 
 ~Value ()
 
Valueoperator= (const Value &other)
 
Valueoperator= (Value &&other) noexcept
 
void swap (Value &other)
 Swap everything. More...
 
void swapPayload (Value &other)
 Swap values but leave comments and source offsets in place. More...
 
void copy (const Value &other)
 copy everything. More...
 
void copyPayload (const Value &other)
 copy values but leave comments and source offsets in place. More...
 
ValueType type () const
 
bool operator< (const Value &other) const
 Compare payload only, not comments etc. More...
 
bool operator<= (const Value &other) const
 
bool operator>= (const Value &other) const
 
bool operator> (const Value &other) const
 
bool operator== (const Value &other) const
 
bool operator!= (const Value &other) const
 
int compare (const Value &other) const
 
const char * asCString () const
 Embedded zeroes could cause you trouble! More...
 
String asString () const
 Embedded zeroes are possible. More...
 
bool getString (char const **begin, char const **end) const
 Get raw char* of string-value. More...
 
Int asInt () const
 
UInt asUInt () const
 
Int64 asInt64 () const
 
UInt64 asUInt64 () const
 
LargestInt asLargestInt () const
 
LargestUInt asLargestUInt () const
 
float asFloat () const
 
double asDouble () const
 
bool asBool () const
 
bool isNull () const
 
bool isBool () const
 
bool isInt () const
 
bool isInt64 () const
 
bool isUInt () const
 
bool isUInt64 () const
 
bool isIntegral () const
 
bool isDouble () const
 
bool isNumeric () const
 
bool isString () const
 
bool isArray () const
 
bool isObject () const
 
template<typename T >
as () const =delete
 The as<T> and is<T> member function templates and specializations. More...
 
template<typename T >
bool is () const =delete
 
bool isConvertibleTo (ValueType other) const
 
ArrayIndex size () const
 Number of values in array or object. More...
 
bool empty () const
 Return true if empty array, empty object, or null; otherwise, false. More...
 
 operator bool () const
 Return !isNull() More...
 
void clear ()
 Remove all object members and array elements. More...
 
void resize (ArrayIndex newSize)
 Resize the array to newSize elements. More...
 
Value get (ArrayIndex index, const Value &defaultValue) const
 If the array contains at least index+1 elements, returns the element value, otherwise returns defaultValue. More...
 
bool isValidIndex (ArrayIndex index) const
 Return true if index < size(). More...
 
Valueappend (const Value &value)
 Append value to array at the end. More...
 
Valueappend (Value &&value)
 
bool insert (ArrayIndex index, const Value &newValue)
 Insert value in array at specific index. More...
 
bool insert (ArrayIndex index, Value &&newValue)
 
Valueoperator[] (const char *key)
 Access an object value by name, create a null member if it does not exist. More...
 
const Valueoperator[] (const char *key) const
 Access an object value by name, returns null if there is no member with that name. More...
 
Valueoperator[] (const String &key)
 Access an object value by name, create a null member if it does not exist. More...
 
const Valueoperator[] (const String &key) const
 Access an object value by name, returns null if there is no member with that name. More...
 
Valueoperator[] (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 (const String &key, const Value &defaultValue) const
 Return the member named key if it exist, defaultValue otherwise. More...
 
Value get (const char *begin, const char *end, const Value &defaultValue) const
 Return the member named key if it exist, defaultValue otherwise. More...
 
Value const * find (char const *begin, char const *end) const
 Most general and efficient version of isMember()const, get()const, and operator[]const. More...
 
Value const * find (const String &key) const
 Most general and efficient version of isMember()const, get()const, and operator[]const. More...
 
template<typename T , bool(T::*)() const TMemFn>
Value const * findValue (const String &key) const
 Calls find and only returns a valid pointer if the type is found. More...
 
Value const * findNull (const String &key) const
 
Value const * findBool (const String &key) const
 
Value const * findInt (const String &key) const
 
Value const * findInt64 (const String &key) const
 
Value const * findUInt (const String &key) const
 
Value const * findUInt64 (const String &key) const
 
Value const * findIntegral (const String &key) const
 
Value const * findDouble (const String &key) const
 
Value const * findNumeric (const String &key) const
 
Value const * findString (const String &key) const
 
Value const * findArray (const String &key) const
 
Value const * findObject (const String &key) const
 
Valuedemand (char const *begin, char const *end)
 Most general and efficient version of object-mutators. More...
 
void removeMember (const char *key)
 Remove and return the named member. More...
 
void removeMember (const String &key)
 Same as removeMember(const char*) More...
 
bool removeMember (String const &key, Value *removed)
 Remove the named map member. More...
 
bool removeMember (const char *key, Value *removed)
 Same as removeMember(const char* begin, const char* end, Value* removed), but 'key' is null-terminated. More...
 
bool removeMember (const char *begin, const char *end, Value *removed)
 Same as removeMember(String const& key, Value* removed) More...
 
bool removeIndex (ArrayIndex index, Value *removed)
 Remove the indexed array element. More...
 
bool isMember (const char *key) const
 Return true if the object has a member named key. More...
 
bool isMember (const String &key) const
 Return true if the object has a member named key. More...
 
bool isMember (const char *begin, const char *end) const
 Same as isMember(String const& key)const. More...
 
Members getMemberNames () const
 Return a list of the member names. More...
 
 __declspec (deprecated("Use setComment(String const&) instead.")) void setComment(const char *comment
 
void setComment (const char *comment, size_t len, CommentPlacement placement)
 Comments must be //... or /* ... */. More...
 
void setComment (String comment, CommentPlacement placement)
 Comments must be //... or /* ... */. More...
 
bool hasComment (CommentPlacement placement) const
 
String getComment (CommentPlacement placement) const
 Include delimiters and embedded newlines. More...
 
String toStyledString () const
 
const_iterator begin () const
 
const_iterator end () const
 
iterator begin ()
 
iterator end ()
 
ValueMembersView members ()
 
ValueConstMembersView members () const
 
const Valuefront () const
 Returns a reference to the first element in the Value. More...
 
Valuefront ()
 Returns a reference to the first element in the Value. More...
 
const Valueback () const
 Returns a reference to the last element in the Value. More...
 
Valueback ()
 Returns a reference to the last element in the Value. More...
 
void setOffsetStart (ptrdiff_t start)
 
void setOffsetLimit (ptrdiff_t limit)
 
ptrdiff_t getOffsetStart () const
 
ptrdiff_t getOffsetLimit () const
 
template<>
bool as () const
 
template<>
bool is () const
 
template<>
Int as () const
 
template<>
bool is () const
 
template<>
UInt as () const
 
template<>
bool is () const
 
template<>
Int64 as () const
 
template<>
bool is () const
 
template<>
UInt64 as () const
 
template<>
bool is () const
 
template<>
double as () const
 
template<>
bool is () const
 
template<>
String as () const
 
template<>
bool is () const
 
template<>
float as () const
 These as specializations are type conversions, and do not have a corresponding is. More...
 
template<>
const char * as () const
 
Valueoperator[] (ArrayIndex index)
 
Valueoperator[] (int index)
 
const Valueoperator[] (ArrayIndex index) const
 
const Valueoperator[] (int index) const
 

Static Public Member Functions

static Value const & nullSingleton ()
 

Public Attributes

CommentPlacement placement
 
unsigned int value_type_: 8
 
unsigned int allocated_: 1
 

Static Public Attributes

static const Valuenull = Value::nullSingleton()
 
static const ValuenullRef = Value::nullSingleton()
 
static constexpr LargestInt minLargestInt
 Minimum signed integer value that can be stored in a Json::Value. More...
 
static constexpr LargestInt maxLargestInt = LargestInt(LargestUInt(-1) / 2)
 Maximum signed integer value that can be stored in a Json::Value. More...
 
static constexpr LargestUInt maxLargestUInt = LargestUInt(-1)
 Maximum unsigned integer value that can be stored in a Json::Value. More...
 
static constexpr Int minInt = Int(~(UInt(-1) / 2))
 Minimum signed int value that can be stored in a Json::Value. More...
 
static constexpr Int maxInt = Int(UInt(-1) / 2)
 Maximum signed int value that can be stored in a Json::Value. More...
 
static constexpr UInt maxUInt = UInt(-1)
 Maximum unsigned int value that can be stored in a Json::Value. More...
 
static constexpr Int64 minInt64 = Int64(~(UInt64(-1) / 2))
 Minimum signed 64 bits int value that can be stored in a Json::Value. More...
 
static constexpr Int64 maxInt64 = Int64(UInt64(-1) / 2)
 Maximum signed 64 bits int value that can be stored in a Json::Value. More...
 
static constexpr UInt64 maxUInt64 = UInt64(-1)
 Maximum unsigned 64 bits int value that can be stored in a Json::Value. More...
 
static constexpr UInt defaultRealPrecision = 17
 Default precision for real value for string representation. More...
 
static constexpr double maxUInt64AsDouble = 18446744073709551615.0
 

Friends

class ValueIteratorBase
 
struct ::ValueTest
 

Detailed Description

Represents a JSON value.

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

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 resized and initialized with nullValue. resize() can be used to enlarge or truncate an arrayValue.

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

It is possible to iterate over the list of member keys of an object using the getMemberNames() method.

Note
Value string-length fit in size_t, but keys must be < 2^30. (The reason is an implementation detail.) A #CharReader will raise an exception if a bound is exceeded to avoid security holes in your app, but the Value API does not check bounds. That is the responsibility of the caller.

Definition at line 207 of file value.h.

Member Typedef Documentation

Definition at line 223 of file value.h.

Definition at line 214 of file value.h.

Definition at line 216 of file value.h.

Definition at line 219 of file value.h.

Definition at line 213 of file value.h.

Definition at line 221 of file value.h.

Definition at line 222 of file value.h.

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

Definition at line 212 of file value.h.

Definition at line 215 of file value.h.

Definition at line 218 of file value.h.

using Json::Value::value_type = std::string

Definition at line 226 of file value.h.

Constructor & Destructor Documentation

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); // {}

Default constructor initialization must be equivalent to: memset( this, 0, sizeof(Value) ) This optimization is used in ValueInternalMap fast allocator.

Definition at line 392 of file json_value.cpp.

References Json::arrayValue, Json::booleanValue, Json::intValue, JSON_ASSERT_UNREACHABLE, Json::nullValue, Json::objectValue, Json::realValue, Json::stringValue, and Json::uintValue.

Json::Value::Value ( Int  value)

Definition at line 421 of file json_value.cpp.

References Json::intValue.

Json::Value::Value ( UInt  value)

Definition at line 426 of file json_value.cpp.

References Json::uintValue.

Json::Value::Value ( Int64  value)

Definition at line 431 of file json_value.cpp.

References Json::intValue.

Json::Value::Value ( UInt64  value)

Definition at line 435 of file json_value.cpp.

References Json::uintValue.

Json::Value::Value ( double  value)

Definition at line 441 of file json_value.cpp.

References Json::realValue.

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

Copy til first 0. (NULL causes to seg-fault.)

Definition at line 446 of file json_value.cpp.

References Json::duplicateAndPrefixStringValue(), JSON_ASSERT_MESSAGE, and Json::stringValue.

Json::Value::Value ( const char *  begin,
const char *  end 
)

Copy all, incl zeroes.

Definition at line 454 of file json_value.cpp.

References Json::duplicateAndPrefixStringValue(), and Json::stringValue.

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.

Note
This works only for null-terminated strings. (We cannot change the size of this class, so we have nowhere to store the length, which might be computed later for various operations.)

Example of usage:

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

Definition at line 466 of file json_value.cpp.

References Json::StaticString::c_str(), and Json::stringValue.

Json::Value::Value ( const String value)

Definition at line 460 of file json_value.cpp.

References Json::duplicateAndPrefixStringValue(), and Json::stringValue.

Json::Value::Value ( bool  value)

Definition at line 471 of file json_value.cpp.

References Json::booleanValue.

Json::Value::Value ( std::nullptr_t  ptr)
delete
Json::Value::Value ( const Value other)

Definition at line 476 of file json_value.cpp.

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

Definition at line 481 of file json_value.cpp.

References Json::nullValue, and Json::swap().

Json::Value::~Value ( )

Definition at line 486 of file json_value.cpp.

Member Function Documentation

Json::Value::__declspec ( deprecated("Use setComment(String const&) instead.")  ) const
Deprecated:
Always pass len.
Value & Json::Value::append ( const Value value)

Append value to array at the end.

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

Definition at line 1221 of file json_value.cpp.

Value & Json::Value::append ( Value &&  value)
template<typename T >
T Json::Value::as ( ) const
delete

The as<T> and is<T> member function templates and specializations.

template<>
bool Json::Value::as ( ) const
inline

Definition at line 780 of file value.h.

template<>
Int Json::Value::as ( ) const
inline

Definition at line 783 of file value.h.

template<>
UInt Json::Value::as ( ) const
inline

Definition at line 786 of file value.h.

template<>
Int64 Json::Value::as ( ) const
inline

Definition at line 790 of file value.h.

template<>
UInt64 Json::Value::as ( ) const
inline

Definition at line 793 of file value.h.

template<>
double Json::Value::as ( ) const
inline

Definition at line 797 of file value.h.

template<>
String Json::Value::as ( ) const
inline

Definition at line 800 of file value.h.

template<>
float Json::Value::as ( ) const
inline

These as specializations are type conversions, and do not have a corresponding is.

Definition at line 805 of file value.h.

template<>
const char* Json::Value::as ( ) const
inline

Definition at line 806 of file value.h.

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

Embedded zeroes could cause you trouble!

Definition at line 635 of file json_value.cpp.

References Json::decodePrefixedString(), JSON_ASSERT_MESSAGE, and Json::stringValue.

double Json::Value::asDouble ( ) const
float Json::Value::asFloat ( ) const
Value::Int Json::Value::asInt ( ) const
Value::Int64 Json::Value::asInt64 ( ) const
LargestInt Json::Value::asLargestInt ( ) const

Definition at line 793 of file json_value.cpp.

LargestUInt Json::Value::asLargestUInt ( ) const

Definition at line 801 of file json_value.cpp.

String Json::Value::asString ( ) const
Value::UInt Json::Value::asUInt ( ) const
Value::UInt64 Json::Value::asUInt64 ( ) const
const Value & Json::Value::back ( ) const
inline

Returns a reference to the last element in the Value.

Requires that value holds an array or json object, with at least one element.

Definition at line 1179 of file value.h.

References end().

Value & Json::Value::back ( )
inline

Returns a reference to the last element in the Value.

Requires that this value holds an array or json object, with at least one element.

Definition at line 1181 of file value.h.

References end().

Value::const_iterator Json::Value::begin ( ) const

Definition at line 1552 of file json_value.cpp.

References Json::arrayValue, Json::objectValue, and type().

Referenced by front(), members(), and Json::StreamWriterBuilder::validate().

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

Definition at line 1578 of file json_value.cpp.

References Json::arrayValue, Json::objectValue, and type().

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 940 of file json_value.cpp.

References Json::arrayValue, JSON_ASSERT_MESSAGE, Json::nullValue, and Json::objectValue.

int Json::Value::compare ( const Value other) const

Definition at line 527 of file json_value.cpp.

void Json::Value::copy ( const Value other)

copy everything.

Definition at line 518 of file json_value.cpp.

void Json::Value::copyPayload ( const Value other)

copy values but leave comments and source offsets in place.

Definition at line 506 of file json_value.cpp.

Value * Json::Value::demand ( char const *  begin,
char const *  end 
)

Most general and efficient version of object-mutators.

Note
As stated elsewhere, behavior is undefined if (end-begin) >= 2^30
Returns
non-zero, but JSON_ASSERT if this is neither object nor nullValue.

Definition at line 1190 of file json_value.cpp.

References JSON_ASSERT_MESSAGE, Json::nullValue, and Json::objectValue.

bool Json::Value::empty ( ) const

Return true if empty array, empty object, or null; otherwise, false.

Definition at line 932 of file json_value.cpp.

Referenced by Json::StreamWriterBuilder::validate(), and Json::CharReaderBuilder::validate().

Value::const_iterator Json::Value::end ( ) const

Definition at line 1565 of file json_value.cpp.

References Json::arrayValue, Json::objectValue, and type().

Referenced by back(), members(), and Json::StreamWriterBuilder::validate().

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

Definition at line 1591 of file json_value.cpp.

References Json::arrayValue, Json::objectValue, and type().

Value const * Json::Value::find ( char const *  begin,
char const *  end 
) const

Most general and efficient version of isMember()const, get()const, and operator[]const.

Note
As stated elsewhere, behavior is undefined if (end-begin) >= 2^30

Definition at line 1136 of file json_value.cpp.

References JSON_ASSERT_MESSAGE, Json::nullValue, and Json::objectValue.

Value const * Json::Value::find ( const String key) const

Most general and efficient version of isMember()const, get()const, and operator[]const.

Definition at line 1149 of file json_value.cpp.

Value const * Json::Value::findArray ( const String key) const

Definition at line 1183 of file json_value.cpp.

Value const * Json::Value::findBool ( const String key) const

Definition at line 1156 of file json_value.cpp.

Value const * Json::Value::findDouble ( const String key) const

Definition at line 1174 of file json_value.cpp.

Value const * Json::Value::findInt ( const String key) const

Definition at line 1159 of file json_value.cpp.

Value const * Json::Value::findInt64 ( const String key) const

Definition at line 1162 of file json_value.cpp.

Value const * Json::Value::findIntegral ( const String key) const

Definition at line 1171 of file json_value.cpp.

Value const * Json::Value::findNull ( const String key) const

Definition at line 1153 of file json_value.cpp.

Value const * Json::Value::findNumeric ( const String key) const

Definition at line 1177 of file json_value.cpp.

Value const * Json::Value::findObject ( const String key) const

Definition at line 1186 of file json_value.cpp.

Value const * Json::Value::findString ( const String key) const

Definition at line 1180 of file json_value.cpp.

Value const * Json::Value::findUInt ( const String key) const

Definition at line 1165 of file json_value.cpp.

Value const * Json::Value::findUInt64 ( const String key) const

Definition at line 1168 of file json_value.cpp.

template<typename T , bool(T::*)() const TMemFn>
Value const* Json::Value::findValue ( const String key) const
inline

Calls find and only returns a valid pointer if the type is found.

Definition at line 576 of file value.h.

const Value & Json::Value::front ( ) const
inline

Returns a reference to the first element in the Value.

Requires that this value holds an array or json object, with at least one element.

Definition at line 1175 of file value.h.

References begin().

Value & Json::Value::front ( )
inline

Returns a reference to the first element in the Value.

Requires that this value holds an array or json object, with at least one element.

Definition at line 1177 of file value.h.

References begin().

Value Json::Value::get ( ArrayIndex  index,
const Value defaultValue 
) const

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

Definition at line 1129 of file json_value.cpp.

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

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

Note
deep copy
Value Json::Value::get ( const String key,
const Value defaultValue 
) const

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

Note
deep copy
Parameters
keymay contain embedded nulls.
Value Json::Value::get ( const char *  begin,
const char *  end,
const Value defaultValue 
) const

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

Note
deep copy
key may contain embedded nulls.
String Json::Value::getComment ( CommentPlacement  placement) const

Include delimiters and embedded newlines.

Definition at line 1530 of file json_value.cpp.

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 1332 of file json_value.cpp.

References JSON_ASSERT_MESSAGE, Json::nullValue, and Json::objectValue.

ptrdiff_t Json::Value::getOffsetLimit ( ) const

Definition at line 1540 of file json_value.cpp.

Referenced by Json::Reader::pushError().

ptrdiff_t Json::Value::getOffsetStart ( ) const

Definition at line 1538 of file json_value.cpp.

Referenced by Json::Reader::pushError().

bool Json::Value::getString ( char const **  begin,
char const **  end 
) const

Get raw char* of string-value.

Returns
false if !string. (Seg-fault if str or end are NULL.)

Definition at line 661 of file json_value.cpp.

References Json::decodePrefixedString(), and Json::stringValue.

bool Json::Value::hasComment ( CommentPlacement  placement) const

Definition at line 1526 of file json_value.cpp.

Referenced by toStyledString().

bool Json::Value::insert ( ArrayIndex  index,
const Value newValue 
)

Insert value in array at specific index.

Definition at line 1233 of file json_value.cpp.

bool Json::Value::insert ( ArrayIndex  index,
Value &&  newValue 
)

Definition at line 1237 of file json_value.cpp.

References Json::arrayValue, JSON_ASSERT_MESSAGE, and Json::nullValue.

template<typename T >
bool Json::Value::is ( ) const
delete
template<>
bool Json::Value::is ( ) const
inline

Definition at line 781 of file value.h.

template<>
bool Json::Value::is ( ) const
inline

Definition at line 784 of file value.h.

template<>
bool Json::Value::is ( ) const
inline

Definition at line 787 of file value.h.

template<>
bool Json::Value::is ( ) const
inline

Definition at line 791 of file value.h.

template<>
bool Json::Value::is ( ) const
inline

Definition at line 794 of file value.h.

template<>
bool Json::Value::is ( ) const
inline

Definition at line 798 of file value.h.

template<>
bool Json::Value::is ( ) const
inline

Definition at line 801 of file value.h.

bool Json::Value::isArray ( ) const

Definition at line 1477 of file json_value.cpp.

References Json::arrayValue.

Referenced by Json::Path::make(), Json::Reader::parse(), and Json::Path::resolve().

bool Json::Value::isBool ( ) const

Definition at line 1355 of file json_value.cpp.

References Json::booleanValue.

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

Definition at line 1469 of file json_value.cpp.

References Json::intValue, Json::realValue, and Json::uintValue.

bool Json::Value::isInt ( ) const

Definition at line 1357 of file json_value.cpp.

References Json::intValue, Json::IsIntegral(), Json::realValue, and Json::uintValue.

bool Json::Value::isInt64 ( ) const

Definition at line 1399 of file json_value.cpp.

References Json::intValue, Json::IsIntegral(), Json::realValue, and Json::uintValue.

bool Json::Value::isIntegral ( ) const

Definition at line 1443 of file json_value.cpp.

References Json::intValue, Json::IsIntegral(), Json::realValue, and Json::uintValue.

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

Return true if the object has a member named key.

Note
'key' must be null-terminated.
bool Json::Value::isMember ( const String key) const

Return true if the object has a member named key.

Parameters
keymay contain embedded nulls.
bool Json::Value::isMember ( const char *  begin,
const char *  end 
) const

Same as isMember(String const& key)const.

bool Json::Value::isNull ( ) const

Definition at line 1353 of file json_value.cpp.

References Json::nullValue.

bool Json::Value::isNumeric ( ) const

Definition at line 1473 of file json_value.cpp.

bool Json::Value::isObject ( ) const

Definition at line 1479 of file json_value.cpp.

References Json::objectValue.

Referenced by Json::Path::make(), Json::Reader::parse(), and Json::Path::resolve().

bool Json::Value::isString ( ) const

Definition at line 1475 of file json_value.cpp.

References Json::stringValue.

bool Json::Value::isUInt ( ) const

Definition at line 1376 of file json_value.cpp.

References Json::intValue, Json::IsIntegral(), Json::realValue, and Json::uintValue.

bool Json::Value::isUInt64 ( ) const

Definition at line 1423 of file json_value.cpp.

References Json::intValue, Json::IsIntegral(), Json::realValue, and Json::uintValue.

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

Return true if index < size().

Definition at line 1134 of file json_value.cpp.

Referenced by Json::Path::resolve().

ValueMembersView Json::Value::members ( )
inline

Definition at line 1166 of file value.h.

References begin(), and end().

ValueConstMembersView Json::Value::members ( ) const
inline

Definition at line 1169 of file value.h.

References begin(), and end().

Value const & Json::Value::nullSingleton ( )
static

Definition at line 70 of file json_value.cpp.

Referenced by Json::Path::resolve().

Json::Value::operator bool ( ) const
explicit

Return !isNull()

Definition at line 938 of file json_value.cpp.

bool Json::Value::operator!= ( const Value other) const

Definition at line 633 of file json_value.cpp.

bool Json::Value::operator< ( const Value other) const
bool Json::Value::operator<= ( const Value other) const

Definition at line 585 of file json_value.cpp.

Value & Json::Value::operator= ( const Value other)
Note
Overwrite existing comments. To preserve comments, use swapPayload().

Definition at line 491 of file json_value.cpp.

References swap().

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

Definition at line 496 of file json_value.cpp.

References swap().

bool Json::Value::operator== ( const Value other) const
bool Json::Value::operator> ( const Value other) const

Definition at line 589 of file json_value.cpp.

bool Json::Value::operator>= ( const Value other) const

Definition at line 587 of file json_value.cpp.

Value & Json::Value::operator[] ( ArrayIndex  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 977 of file json_value.cpp.

References Json::arrayValue, JSON_ASSERT_MESSAGE, and Json::nullValue.

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

Definition at line 993 of file json_value.cpp.

References JSON_ASSERT_MESSAGE.

const Value & Json::Value::operator[] ( ArrayIndex  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 1000 of file json_value.cpp.

References Json::arrayValue, JSON_ASSERT_MESSAGE, and Json::nullValue.

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

Definition at line 1013 of file json_value.cpp.

References JSON_ASSERT_MESSAGE.

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

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

Note
Because of our implementation, keys are limited to 2^30 -1 chars. Exceeding that will cause an exception.

Definition at line 1209 of file json_value.cpp.

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 1196 of file json_value.cpp.

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

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

Parameters
keymay contain embedded nulls.

Definition at line 1213 of file json_value.cpp.

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

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

Parameters
keymay contain embedded nulls.

Definition at line 1202 of file json_value.cpp.

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 has 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 1217 of file json_value.cpp.

References Json::StaticString::c_str().

bool Json::Value::removeIndex ( ArrayIndex  index,
Value removed 
)

Remove the indexed array element.

O(n) expensive operations. Update 'removed' iff removed.

Returns
true if removed (no exceptions)

Definition at line 1297 of file json_value.cpp.

References Json::arrayValue.

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

Remove and return the named member.

Do nothing if it did not exist.

Precondition
type() is objectValue or nullValue
Postcondition
type() is unchanged

Definition at line 1284 of file json_value.cpp.

References JSON_ASSERT_MESSAGE, Json::nullValue, Json::objectValue, and Json::valueTypeToString().

void Json::Value::removeMember ( const String key)

Same as removeMember(const char*)

Parameters
keymay contain embedded nulls.

Definition at line 1295 of file json_value.cpp.

bool Json::Value::removeMember ( String const &  key,
Value removed 
)

Remove the named map member.

Update 'removed' iff removed.

Parameters
keymay contain embedded nulls.
Returns
true iff removed (no exceptions)

Definition at line 1280 of file json_value.cpp.

bool Json::Value::removeMember ( const char *  key,
Value removed 
)

Same as removeMember(const char* begin, const char* end, Value* removed), but 'key' is null-terminated.

Definition at line 1277 of file json_value.cpp.

bool Json::Value::removeMember ( const char *  begin,
const char *  end,
Value removed 
)
void Json::Value::resize ( ArrayIndex  newSize)

Resize the array to newSize elements.

New elements are initialized to null. May only be called on nullValue or arrayValue.

Precondition
type() is arrayValue or nullValue
Postcondition
type() is arrayValue

Definition at line 956 of file json_value.cpp.

References Json::arrayValue, JSON_ASSERT, JSON_ASSERT_MESSAGE, Json::nullValue, and Json::valueTypeToString().

void Json::Value::setComment ( const char *  comment,
size_t  len,
CommentPlacement  placement 
)
inline

Comments must be //... or /* ... */.

Definition at line 668 of file value.h.

Referenced by Json::Reader::parse().

void Json::Value::setComment ( String  comment,
CommentPlacement  placement 
)

Comments must be //... or /* ... */.

Definition at line 1515 of file json_value.cpp.

References JSON_ASSERT_MESSAGE.

void Json::Value::setOffsetLimit ( ptrdiff_t  limit)

Definition at line 1536 of file json_value.cpp.

void Json::Value::setOffsetStart ( ptrdiff_t  start)

Definition at line 1534 of file json_value.cpp.

ArrayIndex Json::Value::size ( ) const
void Json::Value::swap ( Value other)

Swap everything.

Definition at line 511 of file json_value.cpp.

References Json::swap().

Referenced by operator=(), and Json::swap().

void Json::Value::swapPayload ( Value other)

Swap values but leave comments and source offsets in place.

Definition at line 501 of file json_value.cpp.

References Json::swap().

String Json::Value::toStyledString ( ) const

Definition at line 1542 of file json_value.cpp.

References Json::commentBefore, hasComment(), and Json::writeString().

ValueType Json::Value::type ( ) const

Definition at line 523 of file json_value.cpp.

Referenced by begin(), end(), operator<(), and operator==().

Friends And Related Function Documentation

friend struct ::ValueTest
friend

Definition at line 209 of file value.h.

friend class ValueIteratorBase
friend

Definition at line 208 of file value.h.

Member Data Documentation

unsigned int Json::Value::allocated_

Definition at line 754 of file value.h.

constexpr UInt Json::Value::defaultRealPrecision = 17
static

Default precision for real value for string representation.

Definition at line 261 of file value.h.

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

Maximum signed int value that can be stored in a Json::Value.

Definition at line 248 of file value.h.

Referenced by Json::duplicateAndPrefixStringValue(), and Json::duplicateStringValue().

constexpr Int64 Json::Value::maxInt64 = Int64(UInt64(-1) / 2)
static

Maximum signed 64 bits int value that can be stored in a Json::Value.

Definition at line 256 of file value.h.

constexpr LargestInt Json::Value::maxLargestInt = LargestInt(LargestUInt(-1) / 2)
static

Maximum signed integer value that can be stored in a Json::Value.

Definition at line 241 of file value.h.

Referenced by Json::valueToString().

constexpr LargestUInt Json::Value::maxLargestUInt = LargestUInt(-1)
static

Maximum unsigned integer value that can be stored in a Json::Value.

Definition at line 243 of file value.h.

constexpr UInt Json::Value::maxUInt = UInt(-1)
static

Maximum unsigned int value that can be stored in a Json::Value.

Definition at line 250 of file value.h.

constexpr UInt64 Json::Value::maxUInt64 = UInt64(-1)
static

Maximum unsigned 64 bits int value that can be stored in a Json::Value.

Definition at line 258 of file value.h.

constexpr double Json::Value::maxUInt64AsDouble = 18446744073709551615.0
static

Definition at line 265 of file value.h.

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

Minimum signed int value that can be stored in a Json::Value.

Definition at line 246 of file value.h.

constexpr Int64 Json::Value::minInt64 = Int64(~(UInt64(-1) / 2))
static

Minimum signed 64 bits int value that can be stored in a Json::Value.

Definition at line 254 of file value.h.

constexpr LargestInt Json::Value::minLargestInt
static
Initial value:
=
LargestInt(~(LargestUInt(-1) / 2))

Minimum signed integer value that can be stored in a Json::Value.

Definition at line 238 of file value.h.

Referenced by Json::valueToString().

Value const & Json::Value::null = Value::nullSingleton()
static

Definition at line 230 of file value.h.

Value const & Json::Value::nullRef = Value::nullSingleton()
static

Definition at line 231 of file value.h.

CommentPlacement Json::Value::placement
Initial value:
{
setComment(String(comment, strlen(comment)), placement)

Definition at line 664 of file value.h.

unsigned int Json::Value::value_type_

Definition at line 752 of file value.h.


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