Represents a JSON value. More...
#include <json.h>
Classes | |
struct | CommentInfo |
class | CZString |
union | ValueHolder |
Public Types | |
typedef Json::ArrayIndex | ArrayIndex |
typedef ValueConstIterator | const_iterator |
typedef Json::Int | Int |
typedef Json::Int64 | Int64 |
typedef ValueIterator | iterator |
typedef Json::LargestInt | LargestInt |
typedef Json::LargestUInt | LargestUInt |
typedef std::vector< std::string > | Members |
typedef std::map< CZString, Value > | ObjectValues |
typedef Json::UInt | UInt |
typedef Json::UInt64 | UInt64 |
Public Member Functions | |
Value & | append (const Value &value) |
Append value to array at the end. More... | |
bool | asBool () const |
const char * | asCString () const |
Embedded zeroes could cause you trouble! More... | |
double | asDouble () const |
float | asFloat () const |
Int | asInt () const |
Int64 | asInt64 () const |
LargestInt | asLargestInt () const |
LargestUInt | asLargestUInt () const |
std::string | asString () const |
Embedded zeroes are possible. More... | |
UInt | asUInt () const |
UInt64 | asUInt64 () const |
const_iterator | begin () const |
iterator | begin () |
void | clear () |
int | compare (const Value &other) const |
Value const * | demand (char const *key, char const *end) |
bool | empty () const |
Return true if empty array, empty object, or null; otherwise, false. More... | |
const_iterator | end () const |
iterator | end () |
Value const * | find (char const *key, char const *end) const |
Value | get (ArrayIndex index, const Value &defaultValue) const |
Value | get (const char *key, const Value &defaultValue) const |
Value | get (const char *key, const char *end, const Value &defaultValue) const |
Value | get (const std::string &key, const Value &defaultValue) const |
std::string | getComment (CommentPlacement placement) const |
Include delimiters and embedded newlines. More... | |
Members | getMemberNames () const |
Return a list of the member names. More... | |
size_t | getOffsetLimit () const |
size_t | getOffsetStart () const |
bool | getString (char const **str, char const **end) const |
bool | hasComment (CommentPlacement placement) const |
bool | isArray () const |
bool | isBool () const |
bool | isConvertibleTo (ValueType other) const |
bool | isDouble () const |
bool | isInt () const |
bool | isInt64 () const |
bool | isIntegral () const |
bool | isMember (const char *key) const |
bool | isMember (const std::string &key) const |
bool | isMember (const char *key, const char *end) const |
Same as isMember(std::string const& key)const. More... | |
bool | isNull () const |
bool | isNumeric () const |
bool | isObject () const |
bool | isString () const |
bool | isUInt () const |
bool | isUInt64 () const |
bool | isValidIndex (ArrayIndex index) const |
Return true if index < size(). More... | |
bool | operator! () const |
Return isNull() More... | |
bool | operator!= (const Value &other) const |
bool | operator< (const Value &other) const |
Compare payload only, not comments etc. More... | |
bool | operator<= (const Value &other) const |
Value & | operator= (Value other) |
bool | operator== (const Value &other) const |
bool | operator> (const Value &other) const |
bool | operator>= (const Value &other) const |
Value & | operator[] (ArrayIndex index) |
Value & | operator[] (int index) |
const Value & | operator[] (ArrayIndex index) const |
const Value & | operator[] (int index) const |
Value & | operator[] (const char *key) |
const Value & | operator[] (const char *key) const |
Value & | operator[] (const std::string &key) |
const Value & | operator[] (const std::string &key) const |
Value & | operator[] (const StaticString &key) |
Access an object value by name, create a null member if it does not exist. More... | |
bool | removeIndex (ArrayIndex i, Value *removed) |
Remove the indexed array element. More... | |
Value | removeMember (const char *key) |
Remove and return the named member. More... | |
Value | removeMember (const std::string &key) |
bool | removeMember (const char *key, Value *removed) |
bool | removeMember (std::string const &key, Value *removed) |
Remove the named map member. More... | |
bool | removeMember (const char *key, const char *end, Value *removed) |
Same as removeMember(std::string const& key, Value* removed) More... | |
void | resize (ArrayIndex size) |
void | setComment (const char *comment, CommentPlacement placement) |
void | setComment (const char *comment, size_t len, CommentPlacement placement) |
Comments must be //... or /* ... */. More... | |
void | setComment (const std::string &comment, CommentPlacement placement) |
Comments must be //... or /* ... */. More... | |
void | setOffsetLimit (size_t limit) |
void | setOffsetStart (size_t start) |
ArrayIndex | size () const |
Number of values in array or object. More... | |
void | swap (Value &other) |
Swap everything. More... | |
void | swapPayload (Value &other) |
Swap values but leave comments and source offsets in place. More... | |
std::string | toStyledString () const |
ValueType | type () const |
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 *beginValue, const char *endValue) | |
Copy all, incl zeroes. More... | |
Value (const StaticString &value) | |
Constructs a value from a static string. More... | |
Value (const std::string &value) | |
Copy data() til size(). Embedded zeroes too. More... | |
Value (bool value) | |
Value (const Value &other) | |
Deep copy. More... | |
~Value () | |
Static Public Attributes | |
static const Int | maxInt = Int(UInt(-1) / 2) |
Maximum signed int value that can be stored in a Json::Value. More... | |
static const Int64 | maxInt64 = Int64(UInt64(-1) / 2) |
Maximum signed 64 bits int value that can be stored in a Json::Value. More... | |
static const LargestInt | maxLargestInt = LargestInt(LargestUInt(-1) / 2) |
Maximum signed integer value that can be stored in a Json::Value. More... | |
static const LargestUInt | maxLargestUInt = LargestUInt(-1) |
Maximum unsigned integer value that can be stored in a Json::Value. More... | |
static const UInt | maxUInt = UInt(-1) |
Maximum unsigned int value that can be stored in a Json::Value. More... | |
static const UInt64 | maxUInt64 = UInt64(-1) |
Maximum unsigned 64 bits int value that can be stored in a Json::Value. More... | |
static const Int | minInt = Int(~(UInt(-1) / 2)) |
Minimum signed int value that can be stored in a Json::Value. More... | |
static const Int64 | minInt64 = Int64(~(UInt64(-1) / 2)) |
Minimum signed 64 bits int value that can be stored in a Json::Value. More... | |
static const LargestInt | minLargestInt = LargestInt(~(LargestUInt(-1) / 2)) |
Minimum signed integer value that can be stored in a Json::Value. More... | |
static const Value & | null = reinterpret_cast<const Value&>(kNullRef) |
We regret this reference to a global instance; prefer the simpler Value(). More... | |
static const Value & | nullRef = null |
Private Member Functions | |
void | initBasic (ValueType type, bool allocated=false) |
Value & | resolveReference (const char *key) |
Value & | resolveReference (const char *key, const char *end) |
Private Attributes | |
unsigned int | allocated_: 1 |
CommentInfo * | comments_ |
size_t | limit_ |
size_t | start_ |
ValueType | type_: 8 |
union Json::Value::ValueHolder | value_ |
Friends | |
class | ValueIteratorBase |
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 a objectValue values using the getMemberNames() method.
typedef Json::Int Json::Value::Int |
typedef Json::Int64 Json::Value::Int64 |
typedef ValueIterator Json::Value::iterator |
typedef std::vector<std::string> Json::Value::Members |
typedef std::map<CZString, Value> Json::Value::ObjectValues |
typedef Json::UInt Json::Value::UInt |
typedef Json::UInt64 Json::Value::UInt64 |
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:
Definition at line 2693 of file jsoncpp.cpp.
Json::Value::Value | ( | Int | value | ) |
Definition at line 2720 of file jsoncpp.cpp.
Json::Value::Value | ( | UInt | value | ) |
Definition at line 2725 of file jsoncpp.cpp.
Json::Value::Value | ( | Int64 | value | ) |
Definition at line 2730 of file jsoncpp.cpp.
Json::Value::Value | ( | UInt64 | value | ) |
Definition at line 2734 of file jsoncpp.cpp.
Json::Value::Value | ( | double | value | ) |
Definition at line 2740 of file jsoncpp.cpp.
Json::Value::Value | ( | const char * | value | ) |
Copy til first 0. (NULL causes to seg-fault.)
Definition at line 2745 of file jsoncpp.cpp.
Json::Value::Value | ( | const char * | beginValue, |
const char * | endValue | ||
) |
Copy all, incl zeroes.
Definition at line 2750 of file jsoncpp.cpp.
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:
Definition at line 2762 of file jsoncpp.cpp.
Json::Value::Value | ( | const std::string & | value | ) |
Copy data() til size(). Embedded zeroes too.
Definition at line 2756 of file jsoncpp.cpp.
Json::Value::Value | ( | bool | value | ) |
Definition at line 2774 of file jsoncpp.cpp.
Json::Value::Value | ( | const Value & | other | ) |
Deep copy.
Definition at line 2779 of file jsoncpp.cpp.
Json::Value::~Value | ( | ) |
Definition at line 2823 of file jsoncpp.cpp.
Append value to array at the end.
Equivalent to jsonvalue[jsonvalue.size()] = value;
Definition at line 3445 of file jsoncpp.cpp.
bool Json::Value::asBool | ( | ) | const |
Definition at line 3180 of file jsoncpp.cpp.
const char * Json::Value::asCString | ( | ) | const |
Embedded zeroes could cause you trouble!
Definition at line 2977 of file jsoncpp.cpp.
double Json::Value::asDouble | ( | ) | const |
Definition at line 3136 of file jsoncpp.cpp.
float Json::Value::asFloat | ( | ) | const |
Definition at line 3158 of file jsoncpp.cpp.
Value::Int Json::Value::asInt | ( | ) | const |
Definition at line 3031 of file jsoncpp.cpp.
Value::Int64 Json::Value::asInt64 | ( | ) | const |
Definition at line 3077 of file jsoncpp.cpp.
LargestInt Json::Value::asLargestInt | ( | ) | const |
Definition at line 3120 of file jsoncpp.cpp.
LargestUInt Json::Value::asLargestUInt | ( | ) | const |
Definition at line 3128 of file jsoncpp.cpp.
std::string Json::Value::asString | ( | ) | const |
Embedded zeroes are possible.
Definition at line 2996 of file jsoncpp.cpp.
Value::UInt Json::Value::asUInt | ( | ) | const |
Definition at line 3053 of file jsoncpp.cpp.
Value::UInt64 Json::Value::asUInt64 | ( | ) | const |
Definition at line 3098 of file jsoncpp.cpp.
Value::const_iterator Json::Value::begin | ( | ) | const |
Definition at line 3729 of file jsoncpp.cpp.
Value::iterator Json::Value::begin | ( | ) |
Definition at line 3755 of file jsoncpp.cpp.
void Json::Value::clear | ( | ) |
Remove all object members and array elements.
Definition at line 3264 of file jsoncpp.cpp.
int Json::Value::compare | ( | const Value & | other | ) | const |
Definition at line 2871 of file jsoncpp.cpp.
Value const* Json::Value::demand | ( | char const * | key, |
char const * | end | ||
) |
Most general and efficient version of object-mutators.
bool Json::Value::empty | ( | ) | const |
Return true if empty array, empty object, or null; otherwise, false.
Definition at line 3255 of file jsoncpp.cpp.
Value::const_iterator Json::Value::end | ( | ) | const |
Definition at line 3742 of file jsoncpp.cpp.
Value::iterator Json::Value::end | ( | ) |
Definition at line 3768 of file jsoncpp.cpp.
Value const * Json::Value::find | ( | char const * | key, |
char const * | end | ||
) | const |
Most general and efficient version of isMember()const, get()const, and operator[]const
Definition at line 3397 of file jsoncpp.cpp.
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 3390 of file jsoncpp.cpp.
Return the member named key if it exist, defaultValue otherwise.
Definition at line 3452 of file jsoncpp.cpp.
Return the member named key if it exist, defaultValue otherwise.
key | may contain embedded nulls. |
Definition at line 3447 of file jsoncpp.cpp.
Return the member named key if it exist, defaultValue otherwise.
key | may contain embedded nulls. |
Definition at line 3456 of file jsoncpp.cpp.
std::string Json::Value::getComment | ( | CommentPlacement | placement | ) | const |
Include delimiters and embedded newlines.
Definition at line 3710 of file jsoncpp.cpp.
Value::Members Json::Value::getMemberNames | ( | ) | const |
Return a list of the member names.
If null, return an empty list.
Definition at line 3549 of file jsoncpp.cpp.
size_t Json::Value::getOffsetLimit | ( | ) | const |
Definition at line 3722 of file jsoncpp.cpp.
size_t Json::Value::getOffsetStart | ( | ) | const |
Definition at line 3720 of file jsoncpp.cpp.
bool Json::Value::getString | ( | char const ** | str, |
char const ** | end | ||
) | const |
Get raw char* of string-value.
Definition at line 2987 of file jsoncpp.cpp.
bool Json::Value::hasComment | ( | CommentPlacement | placement | ) | const |
Definition at line 3706 of file jsoncpp.cpp.
|
private |
Definition at line 3341 of file jsoncpp.cpp.
bool Json::Value::isArray | ( | ) | const |
Definition at line 3684 of file jsoncpp.cpp.
bool Json::Value::isBool | ( | ) | const |
Definition at line 3598 of file jsoncpp.cpp.
bool Json::Value::isConvertibleTo | ( | ValueType | other | ) | const |
Definition at line 3198 of file jsoncpp.cpp.
bool Json::Value::isDouble | ( | ) | const |
Definition at line 3678 of file jsoncpp.cpp.
bool Json::Value::isInt | ( | ) | const |
Definition at line 3600 of file jsoncpp.cpp.
bool Json::Value::isInt64 | ( | ) | const |
Definition at line 3630 of file jsoncpp.cpp.
bool Json::Value::isIntegral | ( | ) | const |
Definition at line 3670 of file jsoncpp.cpp.
bool Json::Value::isMember | ( | const char * | key | ) | const |
Return true if the object has a member named key.
Definition at line 3534 of file jsoncpp.cpp.
bool Json::Value::isMember | ( | const std::string & | key | ) | const |
Return true if the object has a member named key.
key | may contain embedded nulls. |
Definition at line 3538 of file jsoncpp.cpp.
bool Json::Value::isMember | ( | const char * | key, |
const char * | end | ||
) | const |
Same as isMember(std::string const& key)const.
Definition at line 3529 of file jsoncpp.cpp.
bool Json::Value::isNull | ( | ) | const |
Definition at line 3596 of file jsoncpp.cpp.
bool Json::Value::isNumeric | ( | ) | const |
Definition at line 3680 of file jsoncpp.cpp.
bool Json::Value::isObject | ( | ) | const |
Definition at line 3686 of file jsoncpp.cpp.
bool Json::Value::isString | ( | ) | const |
Definition at line 3682 of file jsoncpp.cpp.
bool Json::Value::isUInt | ( | ) | const |
Definition at line 3615 of file jsoncpp.cpp.
bool Json::Value::isUInt64 | ( | ) | const |
Definition at line 3650 of file jsoncpp.cpp.
bool Json::Value::isValidIndex | ( | ArrayIndex | index | ) | const |
Return true if index < size().
Definition at line 3395 of file jsoncpp.cpp.
bool Json::Value::operator! | ( | ) | const |
Return isNull()
Definition at line 3262 of file jsoncpp.cpp.
bool Json::Value::operator!= | ( | const Value & | other | ) | const |
Definition at line 2975 of file jsoncpp.cpp.
bool Json::Value::operator< | ( | const Value & | other | ) | const |
Compare payload only, not comments etc.
Definition at line 2879 of file jsoncpp.cpp.
bool Json::Value::operator<= | ( | const Value & | other | ) | const |
Definition at line 2925 of file jsoncpp.cpp.
Deep copy, then swap(other).
Definition at line 2847 of file jsoncpp.cpp.
bool Json::Value::operator== | ( | const Value & | other | ) | const |
Definition at line 2931 of file jsoncpp.cpp.
bool Json::Value::operator> | ( | const Value & | other | ) | const |
Definition at line 2929 of file jsoncpp.cpp.
bool Json::Value::operator>= | ( | const Value & | other | ) | const |
Definition at line 2927 of file jsoncpp.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 3298 of file jsoncpp.cpp.
Value & Json::Value::operator[] | ( | int | 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 3314 of file jsoncpp.cpp.
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 3321 of file jsoncpp.cpp.
const Value & Json::Value::operator[] | ( | int | 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 3334 of file jsoncpp.cpp.
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 3421 of file jsoncpp.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 3408 of file jsoncpp.cpp.
Value & Json::Value::operator[] | ( | const std::string & | key | ) |
Access an object value by name, create a null member if it does not exist.
key | may contain embedded nulls. |
Definition at line 3425 of file jsoncpp.cpp.
Value const & Json::Value::operator[] | ( | const std::string & | key | ) | const |
Access an object value by name, returns null if there is no member with that name.
key | may contain embedded nulls. |
Definition at line 3414 of file jsoncpp.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:
Definition at line 3429 of file jsoncpp.cpp.
bool Json::Value::removeIndex | ( | ArrayIndex | i, |
Value * | removed | ||
) |
Remove the indexed array element.
O(n) expensive operations. Update 'removed' iff removed.
Definition at line 3499 of file jsoncpp.cpp.
Value Json::Value::removeMember | ( | const char * | key | ) |
Remove and return the named member.
Do nothing if it did not exist.
Definition at line 3483 of file jsoncpp.cpp.
Value Json::Value::removeMember | ( | const std::string & | key | ) |
Same as removeMember(const char*)
key | may contain embedded nulls. |
Definition at line 3494 of file jsoncpp.cpp.
bool Json::Value::removeMember | ( | const char * | key, |
Value * | removed | ||
) |
Same as removeMember(const char* key, const char* end, Value* removed), but 'key' is null-terminated.
Definition at line 3475 of file jsoncpp.cpp.
bool Json::Value::removeMember | ( | std::string const & | key, |
Value * | removed | ||
) |
Remove the named map member.
Update 'removed' iff removed.
key | may contain embedded nulls. |
Definition at line 3479 of file jsoncpp.cpp.
bool Json::Value::removeMember | ( | const char * | key, |
const char * | end, | ||
Value * | removed | ||
) |
Same as removeMember(std::string const& key, Value* removed)
Definition at line 3462 of file jsoncpp.cpp.
void Json::Value::resize | ( | ArrayIndex | size | ) |
Resize the array to size elements. New elements are initialized to null. May only be called on nullValue or arrayValue.
Definition at line 3280 of file jsoncpp.cpp.
|
private |
Definition at line 3352 of file jsoncpp.cpp.
|
private |
Definition at line 3371 of file jsoncpp.cpp.
void Json::Value::setComment | ( | const char * | comment, |
CommentPlacement | placement | ||
) |
Definition at line 3698 of file jsoncpp.cpp.
void Json::Value::setComment | ( | const char * | comment, |
size_t | len, | ||
CommentPlacement | placement | ||
) |
Comments must be //... or /* ... */.
Definition at line 3688 of file jsoncpp.cpp.
void Json::Value::setComment | ( | const std::string & | comment, |
CommentPlacement | placement | ||
) |
Comments must be //... or /* ... */.
Definition at line 3702 of file jsoncpp.cpp.
void Json::Value::setOffsetLimit | ( | size_t | limit | ) |
Definition at line 3718 of file jsoncpp.cpp.
void Json::Value::setOffsetStart | ( | size_t | start | ) |
Definition at line 3716 of file jsoncpp.cpp.
ArrayIndex Json::Value::size | ( | ) | const |
Number of values in array or object.
Definition at line 3232 of file jsoncpp.cpp.
void Json::Value::swap | ( | Value & | other | ) |
Swap everything.
Definition at line 2862 of file jsoncpp.cpp.
void Json::Value::swapPayload | ( | Value & | other | ) |
Swap values but leave comments and source offsets in place.
Definition at line 2852 of file jsoncpp.cpp.
std::string Json::Value::toStyledString | ( | ) | const |
Definition at line 3724 of file jsoncpp.cpp.
ValueType Json::Value::type | ( | ) | const |
Definition at line 2869 of file jsoncpp.cpp.
|
friend |
|
private |
Maximum signed int value that can be stored in a Json::Value.
Maximum signed 64 bits int value that can be stored in a Json::Value.
|
static |
Maximum signed integer value that can be stored in a Json::Value.
|
static |
Maximum unsigned integer value that can be stored in a Json::Value.
Maximum unsigned int value that can be stored in a Json::Value.
Maximum unsigned 64 bits int value that can be stored in a Json::Value.
Minimum signed int value that can be stored in a Json::Value.
Minimum signed 64 bits int value that can be stored in a Json::Value.
|
static |
Minimum signed integer value that can be stored in a Json::Value.
|
private |