NIM 跨平台 C++ SDK
|
Represents a JSON value. 更多...
#include <value.h>
类 | |
class | Comments |
class | CZString |
union | ValueHolder |
Public 类型 | |
using | Members = std::vector< String > |
using | iterator = ValueIterator |
using | const_iterator = ValueConstIterator |
using | UInt = nim_cpp_wrapper_util::Json::UInt |
using | Int = nim_cpp_wrapper_util::Json::Int |
using | UInt64 = nim_cpp_wrapper_util::Json::UInt64 |
using | Int64 = nim_cpp_wrapper_util::Json::Int64 |
using | LargestInt = nim_cpp_wrapper_util::Json::LargestInt |
using | LargestUInt = nim_cpp_wrapper_util::Json::LargestUInt |
using | ArrayIndex = nim_cpp_wrapper_util::Json::ArrayIndex |
using | value_type = std::string |
typedef std::map< CZString, Value > | ObjectValues |
Public 成员函数 | |
Value (ValueType type=nullValue) | |
Create a default Value of the given type. | |
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.) | |
Value (const char *begin, const char *end) | |
Copy all, incl zeroes. | |
Value (const StaticString &value) | |
Constructs a value from a static string. | |
Value (const String &value) | |
Value (bool value) | |
Value (std::nullptr_t ptr)=delete | |
Value (const Value &other) | |
Value (Value &&other) | |
~Value () | |
Value & | operator= (const Value &other) |
Value & | operator= (Value &&other) |
void | swap (Value &other) |
Swap everything. | |
void | swapPayload (Value &other) |
Swap values but leave comments and source offsets in place. | |
void | copy (const Value &other) |
copy everything. | |
void | copyPayload (const Value &other) |
copy values but leave comments and source offsets in place. | |
ValueType | type () const |
bool | operator< (const Value &other) const |
Compare payload only, not comments etc. | |
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! | |
String | asString () const |
Embedded zeroes are possible. | |
bool | getString (char const **begin, char const **end) 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 | 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 > | |
T | as () const JSONCPP_TEMPLATE_DELETE |
The as<T> and is<T> member function templates and specializations. | |
template<typename T > | |
bool | is () const JSONCPP_TEMPLATE_DELETE |
bool | isConvertibleTo (ValueType other) const |
ArrayIndex | size () const |
Number of values in array or object | |
bool | empty () const |
Return true if empty array, empty object, or null; otherwise, false. | |
operator bool () const | |
Return !isNull() | |
void | clear () |
void | resize (ArrayIndex newSize) |
Value & | operator[] (ArrayIndex index) |
Value & | operator[] (int index) |
const Value & | operator[] (ArrayIndex index) const |
const Value & | operator[] (int index) const |
Value | get (ArrayIndex index, const Value &defaultValue) const |
bool | isValidIndex (ArrayIndex index) const |
Return true if index < size(). | |
Value & | append (const Value &value) |
Append value to array at the end. | |
Value & | append (Value &&value) |
bool | insert (ArrayIndex index, const Value &newValue) |
Insert value in array at specific index | |
bool | insert (ArrayIndex index, Value &&newValue) |
Value & | operator[] (const char *key) |
const Value & | operator[] (const char *key) const |
Value & | operator[] (const String &key) |
const Value & | operator[] (const String &key) const |
Value & | operator[] (const StaticString &key) |
Access an object value by name, create a null member if it does not exist. | |
Value | get (const char *key, const Value &defaultValue) const |
Value | get (const char *begin, const char *end, const Value &defaultValue) const |
Value | get (const String &key, const Value &defaultValue) const |
Value const * | find (char const *begin, char const *end) const |
Value * | demand (char const *begin, char const *end) |
void | removeMember (const char *key) |
Remove and return the named member. | |
void | removeMember (const String &key) |
bool | removeMember (const char *key, Value *removed) |
bool | removeMember (String const &key, Value *removed) |
Remove the named map member. | |
bool | removeMember (const char *begin, const char *end, Value *removed) |
Same as removeMember(String const& key, Value* removed) | |
bool | removeIndex (ArrayIndex index, Value *removed) |
Remove the indexed array element. | |
bool | isMember (const char *key) const |
bool | isMember (const String &key) const |
bool | isMember (const char *begin, const char *end) const |
Same as isMember(String const& key)const | |
Members | getMemberNames () const |
Return a list of the member names. | |
void | setComment (const char *comment, CommentPlacement placement) |
void | setComment (const char *comment, size_t len, CommentPlacement placement) |
Comments must be //... or /* ... */ | |
void | setComment (String comment, CommentPlacement placement) |
Comments must be //... or /* ... */ | |
bool | hasComment (CommentPlacement placement) const |
String | getComment (CommentPlacement placement) const |
Include delimiters and embedded newlines. | |
String | toStyledString () const |
const_iterator | begin () const |
const_iterator | end () const |
iterator | begin () |
iterator | end () |
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 |
template<> | |
const char * | as () const |
静态 Public 成员函数 | |
static Value const & | nullSingleton () |
静态 Public 属性 | |
static const Value & | null |
static const Value & | nullRef |
static constexpr LargestInt | minLargestInt = LargestInt(~(LargestUInt(-1) / 2)) |
Minimum signed integer value that can be stored in a nim_cpp_wrapper_util::Json::Value. | |
static constexpr LargestInt | maxLargestInt = LargestInt(LargestUInt(-1) / 2) |
Maximum signed integer value that can be stored in a nim_cpp_wrapper_util::Json::Value. | |
static constexpr LargestUInt | maxLargestUInt = LargestUInt(-1) |
Maximum unsigned integer value that can be stored in a nim_cpp_wrapper_util::Json::Value. | |
static constexpr Int | minInt = Int(~(UInt(-1) / 2)) |
Minimum signed int value that can be stored in a nim_cpp_wrapper_util::Json::Value. | |
static constexpr Int | maxInt = Int(UInt(-1) / 2) |
Maximum signed int value that can be stored in a nim_cpp_wrapper_util::Json::Value. | |
static constexpr UInt | maxUInt = UInt(-1) |
Maximum unsigned int value that can be stored in a nim_cpp_wrapper_util::Json::Value. | |
static constexpr Int64 | minInt64 = Int64(~(UInt64(-1) / 2)) |
Minimum signed 64 bits int value that can be stored in a nim_cpp_wrapper_util::Json::Value. | |
static constexpr Int64 | maxInt64 = Int64(UInt64(-1) / 2) |
Maximum signed 64 bits int value that can be stored in a nim_cpp_wrapper_util::Json::Value. | |
static constexpr UInt64 | maxUInt64 = UInt64(-1) |
Maximum unsigned 64 bits int value that can be stored in a nim_cpp_wrapper_util::Json::Value. | |
static constexpr UInt | defaultRealPrecision = 17 |
Default precision for real value for string representation. | |
static constexpr double | maxUInt64AsDouble = 18446744073709551615.0 |
Private 成员函数 | |
void | setType (ValueType v) |
bool | isAllocated () const |
void | setIsAllocated (bool v) |
void | initBasic (ValueType type, bool allocated=false) |
void | dupPayload (const Value &other) |
void | releasePayload () |
void | dupMeta (const Value &other) |
Value & | resolveReference (const char *key) |
Value & | resolveReference (const char *key, const char *end) |
Private 属性 | |
union nim_cpp_wrapper_util::Json::Value::ValueHolder | value_ |
struct { | |
unsigned int value_type_: 8 | |
unsigned int allocated_: 1 | |
} | bits_ |
Comments | comments_ |
ptrdiff_t | start_ |
ptrdiff_t | limit_ |
友元 | |
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 member keys of an object using the getMemberNames() method.
using nim_cpp_wrapper_util::Json::Value::Members = std::vector<String> |
typedef std::map<CZString, Value> nim_cpp_wrapper_util::Json::Value::ObjectValues |
using nim_cpp_wrapper_util::Json::Value::value_type = std::string |
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:
nim_cpp_wrapper_util::Json::Value::Value | ( | Int | value | ) |
nim_cpp_wrapper_util::Json::Value::Value | ( | UInt | value | ) |
nim_cpp_wrapper_util::Json::Value::Value | ( | Int64 | value | ) |
nim_cpp_wrapper_util::Json::Value::Value | ( | UInt64 | value | ) |
nim_cpp_wrapper_util::Json::Value::Value | ( | double | value | ) |
nim_cpp_wrapper_util::Json::Value::Value | ( | const char * | value | ) |
Copy til first 0. (NULL causes to seg-fault.)
nim_cpp_wrapper_util::Json::Value::Value | ( | const char * | begin, |
const char * | end | ||
) |
Copy all, incl zeroes.
nim_cpp_wrapper_util::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:
nim_cpp_wrapper_util::Json::Value::Value | ( | const String & | value | ) |
nim_cpp_wrapper_util::Json::Value::Value | ( | bool | value | ) |
|
delete |
nim_cpp_wrapper_util::Json::Value::Value | ( | const Value & | other | ) |
nim_cpp_wrapper_util::Json::Value::Value | ( | Value && | other | ) |
nim_cpp_wrapper_util::Json::Value::~Value | ( | ) |
Append value to array at the end.
Equivalent to jsonvalue[jsonvalue.size()] = value;
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
These as
specializations are type conversions, and do not have a corresponding is
.
|
inline |
T nim_cpp_wrapper_util::Json::Value::as | ( | ) | const |
The as<T>
and is<T>
member function templates and specializations.
bool nim_cpp_wrapper_util::Json::Value::asBool | ( | ) | const |
const char * nim_cpp_wrapper_util::Json::Value::asCString | ( | ) | const |
Embedded zeroes could cause you trouble!
double nim_cpp_wrapper_util::Json::Value::asDouble | ( | ) | const |
float nim_cpp_wrapper_util::Json::Value::asFloat | ( | ) | const |
Value::Int nim_cpp_wrapper_util::Json::Value::asInt | ( | ) | const |
Int64 nim_cpp_wrapper_util::Json::Value::asInt64 | ( | ) | const |
LargestInt nim_cpp_wrapper_util::Json::Value::asLargestInt | ( | ) | const |
LargestUInt nim_cpp_wrapper_util::Json::Value::asLargestUInt | ( | ) | const |
String nim_cpp_wrapper_util::Json::Value::asString | ( | ) | const |
Embedded zeroes are possible.
Value::UInt nim_cpp_wrapper_util::Json::Value::asUInt | ( | ) | const |
UInt64 nim_cpp_wrapper_util::Json::Value::asUInt64 | ( | ) | const |
Value::iterator nim_cpp_wrapper_util::Json::Value::begin | ( | ) |
Value::const_iterator nim_cpp_wrapper_util::Json::Value::begin | ( | ) | const |
void nim_cpp_wrapper_util::Json::Value::clear | ( | ) |
int nim_cpp_wrapper_util::Json::Value::compare | ( | const Value & | other | ) | const |
void nim_cpp_wrapper_util::Json::Value::copy | ( | const Value & | other | ) |
copy everything.
void nim_cpp_wrapper_util::Json::Value::copyPayload | ( | const Value & | other | ) |
copy values but leave comments and source offsets in place.
Value * nim_cpp_wrapper_util::Json::Value::demand | ( | char const * | begin, |
char const * | end | ||
) |
Most general and efficient version of object-mutators.
|
private |
|
private |
bool nim_cpp_wrapper_util::Json::Value::empty | ( | ) | const |
Return true if empty array, empty object, or null; otherwise, false.
Value::iterator nim_cpp_wrapper_util::Json::Value::end | ( | ) |
Value::const_iterator nim_cpp_wrapper_util::Json::Value::end | ( | ) | const |
Value const * nim_cpp_wrapper_util::Json::Value::find | ( | char const * | begin, |
char const * | end | ||
) | const |
Most general and efficient version of isMember()const, get()const, and operator[]const
Value nim_cpp_wrapper_util::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.
Value nim_cpp_wrapper_util::Json::Value::get | ( | const char * | begin, |
const char * | end, | ||
const Value & | defaultValue | ||
) | const |
Return the member named key if it exist, defaultValue otherwise.
Return the member named key if it exist, defaultValue otherwise.
Value nim_cpp_wrapper_util::Json::Value::get | ( | const String & | key, |
const Value & | defaultValue | ||
) | const |
Return the member named key if it exist, defaultValue otherwise.
key | may contain embedded nulls. |
String nim_cpp_wrapper_util::Json::Value::getComment | ( | CommentPlacement | placement | ) | const |
Include delimiters and embedded newlines.
Value::Members nim_cpp_wrapper_util::Json::Value::getMemberNames | ( | ) | const |
ptrdiff_t nim_cpp_wrapper_util::Json::Value::getOffsetLimit | ( | ) | const |
ptrdiff_t nim_cpp_wrapper_util::Json::Value::getOffsetStart | ( | ) | const |
bool nim_cpp_wrapper_util::Json::Value::getString | ( | char const ** | begin, |
char const ** | end | ||
) | const |
Get raw char* of string-value.
bool nim_cpp_wrapper_util::Json::Value::hasComment | ( | CommentPlacement | placement | ) | const |
|
private |
bool nim_cpp_wrapper_util::Json::Value::insert | ( | ArrayIndex | index, |
const Value & | newValue | ||
) |
Insert value in array at specific index
bool nim_cpp_wrapper_util::Json::Value::insert | ( | ArrayIndex | index, |
Value && | newValue | ||
) |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
bool nim_cpp_wrapper_util::Json::Value::is | ( | ) | const |
|
inlineprivate |
bool nim_cpp_wrapper_util::Json::Value::isArray | ( | ) | const |
bool nim_cpp_wrapper_util::Json::Value::isBool | ( | ) | const |
bool nim_cpp_wrapper_util::Json::Value::isDouble | ( | ) | const |
bool nim_cpp_wrapper_util::Json::Value::isInt | ( | ) | const |
bool nim_cpp_wrapper_util::Json::Value::isInt64 | ( | ) | const |
bool nim_cpp_wrapper_util::Json::Value::isIntegral | ( | ) | const |
bool nim_cpp_wrapper_util::Json::Value::isMember | ( | const char * | begin, |
const char * | end | ||
) | const |
Same as isMember(String const& key)const
bool nim_cpp_wrapper_util::Json::Value::isMember | ( | const char * | key | ) | const |
Return true if the object has a member named key.
Return true if the object has a member named key.
key | may contain embedded nulls. |
bool nim_cpp_wrapper_util::Json::Value::isNull | ( | ) | const |
bool nim_cpp_wrapper_util::Json::Value::isNumeric | ( | ) | const |
bool nim_cpp_wrapper_util::Json::Value::isObject | ( | ) | const |
bool nim_cpp_wrapper_util::Json::Value::isString | ( | ) | const |
bool nim_cpp_wrapper_util::Json::Value::isUInt | ( | ) | const |
bool nim_cpp_wrapper_util::Json::Value::isUInt64 | ( | ) | const |
bool nim_cpp_wrapper_util::Json::Value::isValidIndex | ( | ArrayIndex | index | ) | const |
Return true if index < size().
|
static |
|
explicit |
Return !isNull()
Compare payload only, not comments etc.
Value & nim_cpp_wrapper_util::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.)
const Value & nim_cpp_wrapper_util::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.)
Value & nim_cpp_wrapper_util::Json::Value::operator[] | ( | const char * | key | ) |
Access an object value by name, create a null member if it does not exist.
const Value & nim_cpp_wrapper_util::Json::Value::operator[] | ( | const char * | key | ) | const |
Access an object value by name, returns null if there is no member with that name.
Value & nim_cpp_wrapper_util::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:
Access an object value by name, create a null member if it does not exist.
key | may contain embedded nulls. |
Access an object value by name, returns null if there is no member with that name.
key | may contain embedded nulls. |
Value & nim_cpp_wrapper_util::Json::Value::operator[] | ( | int | index | ) |
const Value & nim_cpp_wrapper_util::Json::Value::operator[] | ( | int | index | ) | const |
|
private |
bool nim_cpp_wrapper_util::Json::Value::removeIndex | ( | ArrayIndex | index, |
Value * | removed | ||
) |
Remove the indexed array element.
O(n) expensive operations. Update 'removed' iff removed.
void nim_cpp_wrapper_util::Json::Value::removeMember | ( | const char * | key | ) |
Same as removeMember(const char* begin, const char* end, Value* removed), but 'key' is null-terminated.
void nim_cpp_wrapper_util::Json::Value::removeMember | ( | const String & | key | ) |
Same as removeMember(const char*)
key | may contain embedded nulls. |
Remove the named map member.
Update 'removed' iff removed.
key | may contain embedded nulls. |
void nim_cpp_wrapper_util::Json::Value::resize | ( | ArrayIndex | newSize | ) |
|
private |
|
private |
|
inline |
|
inline |
Comments must be //... or /* ... */
void nim_cpp_wrapper_util::Json::Value::setComment | ( | String | comment, |
CommentPlacement | placement | ||
) |
Comments must be //... or /* ... */
|
inlineprivate |
void nim_cpp_wrapper_util::Json::Value::setOffsetLimit | ( | ptrdiff_t | limit | ) |
void nim_cpp_wrapper_util::Json::Value::setOffsetStart | ( | ptrdiff_t | start | ) |
|
inlineprivate |
ArrayIndex nim_cpp_wrapper_util::Json::Value::size | ( | ) | const |
Number of values in array or object
void nim_cpp_wrapper_util::Json::Value::swap | ( | Value & | other | ) |
Swap everything.
void nim_cpp_wrapper_util::Json::Value::swapPayload | ( | Value & | other | ) |
Swap values but leave comments and source offsets in place.
String nim_cpp_wrapper_util::Json::Value::toStyledString | ( | ) | const |
ValueType nim_cpp_wrapper_util::Json::Value::type | ( | ) | const |
|
friend |
unsigned int nim_cpp_wrapper_util::Json::Value::allocated_ |
struct { ... } nim_cpp_wrapper_util::Json::Value::bits_ |
|
private |
|
staticconstexpr |
Default precision for real value for string representation.
|
private |
Maximum signed int value that can be stored in a nim_cpp_wrapper_util::Json::Value.
Maximum signed 64 bits int value that can be stored in a nim_cpp_wrapper_util::Json::Value.
|
staticconstexpr |
Maximum signed integer value that can be stored in a nim_cpp_wrapper_util::Json::Value.
|
staticconstexpr |
Maximum unsigned integer value that can be stored in a nim_cpp_wrapper_util::Json::Value.
Maximum unsigned int value that can be stored in a nim_cpp_wrapper_util::Json::Value.
Maximum unsigned 64 bits int value that can be stored in a nim_cpp_wrapper_util::Json::Value.
|
staticconstexpr |
Minimum signed int value that can be stored in a nim_cpp_wrapper_util::Json::Value.
|
staticconstexpr |
Minimum signed 64 bits int value that can be stored in a nim_cpp_wrapper_util::Json::Value.
|
staticconstexpr |
Minimum signed integer value that can be stored in a nim_cpp_wrapper_util::Json::Value.
|
static |
|
static |
|
private |
|
private |
unsigned int nim_cpp_wrapper_util::Json::Value::value_type_ |