Represents a JSON value. More...
#include <value.h>
Public Types | |
typedef std::vector< std::string > | Members |
typedef ValueIterator | iterator |
typedef ValueConstIterator | const_iterator |
typedef CSJson::UInt | UInt |
typedef CSJson::Int | Int |
typedef CSJson::UInt64 | UInt64 |
typedef CSJson::Int64 | Int64 |
typedef CSJson::LargestInt | LargestInt |
typedef CSJson::LargestUInt | LargestUInt |
typedef CSJson::ArrayIndex | ArrayIndex |
typedef std::map< CZString, Value > | ObjectValues |
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) | |
Value (const char *beginValue, const char *endValue) | |
Value (const StaticString &value) | |
Constructs a value from a static string. More... | |
Value (const std::string &value) | |
Value (bool value) | |
Value (const Value &other) | |
~Value () | |
Value & | operator= (const Value &other) |
void | swap (Value &other) |
Swap values. More... | |
ValueType | type () 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 |
bool | operator== (const Value &other) const |
bool | operator!= (const Value &other) const |
int | compare (const Value &other) const |
const char * | asCString () const |
std::string | asString () const |
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 | isUInt () const |
bool | isIntegral () const |
bool | isDouble () const |
bool | isNumeric () const |
bool | isString () const |
bool | isArray () const |
bool | isObject () const |
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... | |
bool | operator! () const |
Return isNull() More... | |
void | clear () |
Remove all object members and array elements. More... | |
void | resize (ArrayIndex size) |
Resize the array to size elements. More... | |
Value & | operator[] (ArrayIndex index) |
Access an array element (zero based index ). More... | |
Value & | operator[] (int index) |
Access an array element (zero based index ). More... | |
const 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.) More... | |
const 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.) 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... | |
Value & | append (const Value &value) |
Append value to array at the end. More... | |
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[] (const std::string &key) |
Access an object value by name, create a null member if it does not exist. More... | |
const Value & | operator[] (const std::string &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 (const std::string &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 (const std::string &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 (const std::string &key) const |
Return true if the object has a member named key. More... | |
Members | getMemberNames () const |
Return a list of the member names. More... | |
void | setComment (const char *comment, CommentPlacement placement) |
Comments must be //... or /* ... */. More... | |
void | setComment (const std::string &comment, CommentPlacement placement) |
Comments must be //... or /* ... */. More... | |
bool | hasComment (CommentPlacement placement) const |
std::string | getComment (CommentPlacement placement) const |
Include delimiters and embedded newlines. More... | |
std::string | toStyledString () const |
const_iterator | begin () const |
const_iterator | end () const |
iterator | begin () |
iterator | end () |
Static Public Attributes | |
static const Value | jsonNull |
static const LargestInt | minLargestInt |
Minimum signed integer value that can be stored in a CSJson::Value. More... | |
static const LargestInt | maxLargestInt |
Maximum signed integer value that can be stored in a CSJson::Value. More... | |
static const LargestUInt | maxLargestUInt |
Maximum unsigned integer value that can be stored in a CSJson::Value. More... | |
static const Int | minInt |
Minimum signed int value that can be stored in a CSJson::Value. More... | |
static const Int | maxInt |
Maximum signed int value that can be stored in a CSJson::Value. More... | |
static const UInt | maxUInt |
Maximum unsigned int value that can be stored in a CSJson::Value. More... | |
static const Int64 | minInt64 |
Minimum signed 64 bits int value that can be stored in a CSJson::Value. More... | |
static const Int64 | maxInt64 |
Maximum signed 64 bits int value that can be stored in a CSJson::Value. More... | |
static const UInt64 | maxUInt64 |
Maximum unsigned 64 bits int value that can be stored in a CSJson::Value. More... | |
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 resize and initialized with nullValue. resize() can be used to enlarge or truncate an arrayValue.
The get() methods can be used to obtanis 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 CSJson::ArrayIndex ArrayIndex |
typedef ValueConstIterator const_iterator |
typedef CSJson::Int Int |
typedef CSJson::Int64 Int64 |
typedef ValueIterator iterator |
typedef CSJson::LargestInt LargestInt |
typedef CSJson::LargestUInt LargestUInt |
typedef std::vector <std::string> Members |
typedef std::map<CZString, Value> ObjectValues |
typedef CSJson::UInt UInt |
typedef CSJson::UInt64 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:
Value | ( | double | value) |
Value | ( | const char * | value) |
Value | ( | const char * | beginValue, |
const char * | endValue | ||
) |
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:
Value | ( | const std::string & | value) |
Value | ( | bool | value) |
~Value | ( | ) |
Append value to array at the end.
Equivalent to jsonvalue[jsonvalue.size()] = value;
bool asBool | ( | ) | const |
const char* asCString | ( | ) | const |
double asDouble | ( | ) | const |
float asFloat | ( | ) | const |
Int asInt | ( | ) | const |
Int64 asInt64 | ( | ) | const |
LargestInt asLargestInt | ( | ) | const |
LargestUInt asLargestUInt | ( | ) | const |
std::string asString | ( | ) | const |
UInt asUInt | ( | ) | const |
UInt64 asUInt64 | ( | ) | const |
const_iterator begin | ( | ) | const |
iterator begin | ( | ) |
void clear | ( | ) |
int compare | ( | const Value & | other) | const |
bool empty | ( | ) | const |
Return true if empty array, empty object, or null; otherwise, false.
const_iterator end | ( | ) | const |
iterator end | ( | ) |
Value get | ( | ArrayIndex | index, |
const Value & | defaultValue | ||
) | const |
If the array contains at least index+1 elements, returns the element value, otherwise returns defaultValue.
Return the member named key if it exist, defaultValue otherwise.
Return the member named key if it exist, defaultValue otherwise.
std::string getComment | ( | CommentPlacement | placement) | const |
Include delimiters and embedded newlines.
Members getMemberNames | ( | ) | const |
bool hasComment | ( | CommentPlacement | placement) | const |
bool isArray | ( | ) | const |
bool isBool | ( | ) | const |
bool isConvertibleTo | ( | ValueType | other) | const |
bool isDouble | ( | ) | const |
bool isInt | ( | ) | const |
bool isIntegral | ( | ) | const |
bool isMember | ( | const char * | key) | const |
Return true if the object has a member named key.
bool isMember | ( | const std::string & | key) | const |
Return true if the object has a member named key.
bool isNull | ( | ) | const |
bool isNumeric | ( | ) | const |
bool isObject | ( | ) | const |
bool isString | ( | ) | const |
bool isUInt | ( | ) | const |
bool isValidIndex | ( | ArrayIndex | index) | const |
Return true if index < size().
bool operator! | ( | ) | const |
Return isNull()
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 |
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.)
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.)
const 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.)
const 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.)
Value& operator[] | ( | const char * | key) |
Access an object value by name, create a null member if it does not exist.
const Value& operator[] | ( | const char * | key) | const |
Access an object value by name, returns null if there is no member with that name.
Value& operator[] | ( | const std::string & | key) |
Access an object value by name, create a null member if it does not exist.
const Value& operator[] | ( | const std::string & | key) | const |
Access an object value by name, returns null if there is no member with that name.
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:
Value removeMember | ( | const char * | key) |
Value removeMember | ( | const std::string & | key) |
Same as removeMember(const char*)
void resize | ( | ArrayIndex | size) |
void setComment | ( | const char * | comment, |
CommentPlacement | placement | ||
) |
Comments must be //... or /* ... */.
void setComment | ( | const std::string & | comment, |
CommentPlacement | placement | ||
) |
Comments must be //... or /* ... */.
ArrayIndex size | ( | ) | const |
Number of values in array or object.
void swap | ( | Value & | other) |
Swap values.
std::string toStyledString | ( | ) | const |
ValueType type | ( | ) | const |
|
friend |
|
static |
|
static |
Maximum signed int value that can be stored in a CSJson::Value.
|
static |
Maximum signed 64 bits int value that can be stored in a CSJson::Value.
|
static |
Maximum signed integer value that can be stored in a CSJson::Value.
|
static |
Maximum unsigned integer value that can be stored in a CSJson::Value.
|
static |
Maximum unsigned int value that can be stored in a CSJson::Value.
|
static |
Maximum unsigned 64 bits int value that can be stored in a CSJson::Value.
|
static |
Minimum signed int value that can be stored in a CSJson::Value.
|
static |
Minimum signed 64 bits int value that can be stored in a CSJson::Value.
|
static |
Minimum signed integer value that can be stored in a CSJson::Value.