GenericValue< Encoding, Allocator > Class Template Reference

Represents a JSON value. Use Value for UTF8 encoding and default allocator. More...

#include <document.h>

Classes
struct	Array
union	Data
union	Number
struct	Object
struct	ShortString
struct	String

Public Types
enum	{   kBoolFlag = 0x100, kNumberFlag = 0x200, kIntFlag = 0x400, kUintFlag = 0x800,   kInt64Flag = 0x1000, kUint64Flag = 0x2000, kDoubleFlag = 0x4000, kStringFlag = 0x100000,   kCopyFlag = 0x200000, kInlineStrFlag = 0x400000, kNullFlag = kNullType, kTrueFlag = kTrueType | kBoolFlag,   kFalseFlag = kFalseType | kBoolFlag, kNumberIntFlag = kNumberType | kNumberFlag | kIntFlag | kInt64Flag, kNumberUintFlag = kNumberType | kNumberFlag | kUintFlag | kUint64Flag | kInt64Flag, kNumberInt64Flag = kNumberType | kNumberFlag | kInt64Flag,   kNumberUint64Flag = kNumberType | kNumberFlag | kUint64Flag, kNumberDoubleFlag = kNumberType | kNumberFlag | kDoubleFlag, kNumberAnyFlag = kNumberType | kNumberFlag | kIntFlag | kInt64Flag | kUintFlag | kUint64Flag | kDoubleFlag, kConstStringFlag = kStringType | kStringFlag,   kCopyStringFlag = kStringType | kStringFlag | kCopyFlag, kShortStringFlag = kStringType | kStringFlag | kCopyFlag | kInlineStrFlag, kObjectFlag = kObjectType, kArrayFlag = kArrayType,   kTypeMask = 0xFF }
typedef GenericMember < Encoding, Allocator >	Member
	Name-value pair in an object. More...
typedef Encoding	EncodingType
	Encoding type from template parameter. More...
typedef Allocator	AllocatorType
	Allocator type from template parameter. More...
typedef Encoding::Ch	Ch
	Character type derived from Encoding. More...
typedef GenericStringRef< Ch >	StringRefType
	Reference to a constant string. More...
typedef GenericMemberIterator < false, Encoding, Allocator > ::Iterator	MemberIterator
	Member iterator for iterating in object. More...
typedef GenericMemberIterator < true, Encoding, Allocator > ::Iterator	ConstMemberIterator
	Constant member iterator for iterating in object. More...
typedef GenericValue *	ValueIterator
	Value iterator for iterating in array. More...
typedef const GenericValue *	ConstValueIterator
	Constant value iterator for iterating in array. More...
typedef GenericValue< Encoding, Allocator >	ValueType
	Value type of itself. More...

Public Member Functions
template<typename T >
	RAPIDJSON_DISABLEIF_RETURN ((internal::IsPointer< T >),(GenericValue &)) operator
	Assignment with primitive types. More...
void	SetArrayRaw (GenericValue *values, SizeType count, Allocator &allocator)
void	SetObjectRaw (Member *members, SizeType count, Allocator &allocator)
	Initialize this value as object with initial data, without calling destructor. More...
void	SetStringRaw (StringRefType s) RAPIDJSON_NOEXCEPT
	Initialize this value as constant string, without calling destructor. More...
void	SetStringRaw (StringRefType s, Allocator &allocator)
	Initialize this value as copy string with initial data, without calling destructor. More...
void	RawAssign (GenericValue &rhs) RAPIDJSON_NOEXCEPT
	Assignment without calling destructor. More...
template<typename SourceAllocator >
bool	StringEqual (const GenericValue< Encoding, SourceAllocator > &rhs) const
Assignment operators
GenericValue &	operator= (GenericValue &rhs) RAPIDJSON_NOEXCEPT
	Assignment with move semantics. More...
GenericValue &	operator= (StringRefType str) RAPIDJSON_NOEXCEPT
	Assignment of constant string reference (no copy) More...

Public Attributes
Data	data_
unsigned	flags_

Static Public Attributes
static const SizeType	kDefaultArrayCapacity = 16
static const SizeType	kDefaultObjectCapacity = 16

Friends
template<typename , typename , typename >
class	GenericDocument

Constructors and destructor.
	GenericValue () RAPIDJSON_NOEXCEPT
	Default constructor creates a null value. More...
	GenericValue (Type type) RAPIDJSON_NOEXCEPT
	Constructor with JSON value type. More...
template<typename SourceAllocator >
	GenericValue (const GenericValue< Encoding, SourceAllocator > &rhs, Allocator &allocator)
	Explicit copy constructor (with allocator) More...
template<typename T >
	GenericValue (T b, RAPIDJSON_ENABLEIF((internal::IsSame< T, bool >))) RAPIDJSON_NOEXCEPT
	Constructor for boolean value. More...
	GenericValue (int i) RAPIDJSON_NOEXCEPT
	Constructor for int value. More...
	GenericValue (unsigned u) RAPIDJSON_NOEXCEPT
	Constructor for unsigned value. More...
	GenericValue (int64_t i64) RAPIDJSON_NOEXCEPT
	Constructor for int64_t value. More...
	GenericValue (uint64_t u64) RAPIDJSON_NOEXCEPT
	Constructor for uint64_t value. More...
	GenericValue (double d) RAPIDJSON_NOEXCEPT
	Constructor for double value. More...
	GenericValue (const Ch *s, SizeType length) RAPIDJSON_NOEXCEPT
	Constructor for constant string (i.e. do not make a copy of string) More...
	GenericValue (StringRefType s) RAPIDJSON_NOEXCEPT
	Constructor for constant string (i.e. do not make a copy of string) More...
	GenericValue (const Ch *s, SizeType length, Allocator &allocator)
	Constructor for copy-string (i.e. do make a copy of string) More...
	GenericValue (const Ch *s, Allocator &allocator)
	Constructor for copy-string (i.e. do make a copy of string) More...
	~GenericValue ()
	Destructor. More...
	GenericValue (const GenericValue &rhs)
	Copy constructor is not permitted. More...

Detailed Description

template<typename Encoding, typename Allocator = MemoryPoolAllocator<>>
class GenericValue< Encoding, Allocator >

Represents a JSON value. Use Value for UTF8 encoding and default allocator.

A JSON value can be one of 7 types. This class is a variant type supporting these types.

Use the Value if UTF8 and default allocator

Template Parameters

Encoding	Encoding of the value. (Even non-string values need to have the same encoding in a document)
Allocator	Allocator type for allocating memory of object, array and string.

Member Typedef Documentation

template<typename Encoding, typename Allocator = MemoryPoolAllocator<>>

typedef Allocator GenericValue< Encoding, Allocator >::AllocatorType

Allocator type from template parameter.

template<typename Encoding, typename Allocator = MemoryPoolAllocator<>>

typedef Encoding::Ch GenericValue< Encoding, Allocator >::Ch

Character type derived from Encoding.

template<typename Encoding, typename Allocator = MemoryPoolAllocator<>>

typedef GenericMemberIterator<true,Encoding,Allocator>::Iterator GenericValue< Encoding, Allocator >::ConstMemberIterator

Constant member iterator for iterating in object.

template<typename Encoding, typename Allocator = MemoryPoolAllocator<>>

typedef const GenericValue* GenericValue< Encoding, Allocator >::ConstValueIterator

Constant value iterator for iterating in array.

template<typename Encoding, typename Allocator = MemoryPoolAllocator<>>

typedef Encoding GenericValue< Encoding, Allocator >::EncodingType

Encoding type from template parameter.

template<typename Encoding, typename Allocator = MemoryPoolAllocator<>>

typedef GenericMember<Encoding, Allocator> GenericValue< Encoding, Allocator >::Member

Name-value pair in an object.

template<typename Encoding, typename Allocator = MemoryPoolAllocator<>>

typedef GenericMemberIterator<false,Encoding,Allocator>::Iterator GenericValue< Encoding, Allocator >::MemberIterator

Member iterator for iterating in object.

template<typename Encoding, typename Allocator = MemoryPoolAllocator<>>

typedef GenericStringRef<Ch> GenericValue< Encoding, Allocator >::StringRefType

Reference to a constant string.

template<typename Encoding, typename Allocator = MemoryPoolAllocator<>>

typedef GenericValue* GenericValue< Encoding, Allocator >::ValueIterator

Value iterator for iterating in array.

template<typename Encoding, typename Allocator = MemoryPoolAllocator<>>

typedef GenericValue<Encoding, Allocator> GenericValue< Encoding, Allocator >::ValueType

Value type of itself.

Member Enumeration Documentation

template<typename Encoding, typename Allocator = MemoryPoolAllocator<>>

anonymous enum

Enumerator
kBoolFlag
kNumberFlag
kIntFlag
kUintFlag
kInt64Flag
kUint64Flag
kDoubleFlag
kStringFlag
kCopyFlag
kInlineStrFlag
kNullFlag
kTrueFlag
kFalseFlag
kNumberIntFlag
kNumberUintFlag
kNumberInt64Flag
kNumberUint64Flag
kNumberDoubleFlag
kNumberAnyFlag
kConstStringFlag
kCopyStringFlag
kShortStringFlag
kObjectFlag
kArrayFlag
kTypeMask

 {
 kBoolFlag = 0x100,
 kNumberFlag = 0x200,
 kIntFlag = 0x400,
 kUintFlag = 0x800,
 kInt64Flag = 0x1000,
 kUint64Flag = 0x2000,
 kDoubleFlag = 0x4000,
 kStringFlag = 0x100000,
 kCopyFlag = 0x200000,
 kInlineStrFlag = 0x400000,

 // Initial flags of different types.
 kNullFlag = kNullType,
 kTrueFlag = kTrueType | kBoolFlag,
 kFalseFlag = kFalseType | kBoolFlag,
 kNumberIntFlag = kNumberType | kNumberFlag | kIntFlag | kInt64Flag,
 kNumberUintFlag = kNumberType | kNumberFlag | kUintFlag | kUint64Flag | kInt64Flag,
 kNumberInt64Flag = kNumberType | kNumberFlag | kInt64Flag,
 kNumberUint64Flag = kNumberType | kNumberFlag | kUint64Flag,
 kNumberDoubleFlag = kNumberType | kNumberFlag | kDoubleFlag,
 kNumberAnyFlag = kNumberType | kNumberFlag | kIntFlag | kInt64Flag | kUintFlag | kUint64Flag | kDoubleFlag,
 kConstStringFlag = kStringType | kStringFlag,
 kCopyStringFlag = kStringType | kStringFlag | kCopyFlag,
 kShortStringFlag = kStringType | kStringFlag | kCopyFlag | kInlineStrFlag,
 kObjectFlag = kObjectType,
 kArrayFlag = kArrayType,

 kTypeMask = 0xFF // bitwise-and with mask of 0xFF can be optimized by compiler
 };

Constructor & Destructor Documentation

template<typename Encoding, typename Allocator = MemoryPoolAllocator<>>

GenericValue< Encoding, Allocator >::GenericValue ( )

inline

Default constructor creates a null value.

: data_(), flags_(kNullFlag) {}

template<typename Encoding, typename Allocator = MemoryPoolAllocator<>>

GenericValue< Encoding, Allocator >::GenericValue ( const GenericValue< Encoding, Allocator > &  rhs )

private

Copy constructor is not permitted.

template<typename Encoding, typename Allocator = MemoryPoolAllocator<>>

GenericValue< Encoding, Allocator >::GenericValue ( Type  type )

inlineexplicit

Constructor with JSON value type.

This creates a Value of specified type with default content.

Parameters

type	Type of the value.

Note

Default content for number is zero.

 : data_(), flags_() {
 static const unsigned defaultFlags[7] = {
 kNullFlag, kFalseFlag, kTrueFlag, kObjectFlag, kArrayFlag, kShortStringFlag,
 kNumberAnyFlag
 };
 RAPIDJSON_ASSERT(type <= kNumberType);
 flags_ = defaultFlags[type];

 // Use ShortString to store empty string.
 if (type == kStringType)
 data_.ss.SetLength(0);
 }

template<typename Encoding, typename Allocator >

template<typename SourceAllocator >

GenericValue< Encoding, Allocator >::GenericValue ( const GenericValue< Encoding, SourceAllocator > &  rhs, Allocator &  allocator  )

inline

Explicit copy constructor (with allocator)

Creates a copy of a Value by using the given Allocator

Template Parameters

SourceAllocator

allocator of rhs

Parameters

rhs	Value to copy from (read-only)
allocator	Allocator for allocating copied elements and buffers. Commonly use GenericDocument::GetAllocator().

See also

CopyFrom()

{
 switch (rhs.GetType()) {
 case kObjectType:
 case kArrayType: { // perform deep copy via SAX Handler
 GenericDocument<Encoding,Allocator> d(&allocator);
 rhs.Accept(d);
 RawAssign(*d.stack_.template Pop<GenericValue>(1));
 }
 break;
 case kStringType:
 if (rhs.flags_ == kConstStringFlag) {
 flags_ = rhs.flags_;
 data_ = *reinterpret_cast<const Data*>(&rhs.data_);
 } else {
 SetStringRaw(StringRef(rhs.GetString(), rhs.GetStringLength()), allocator);
 }
 break;
 default: // kNumberType, kTrueType, kFalseType, kNullType
 flags_ = rhs.flags_;
 data_ = *reinterpret_cast<const Data*>(&rhs.data_);
 }
}

Here is the call graph for this function:

template<typename Encoding, typename Allocator = MemoryPoolAllocator<>>

template<typename T >

GenericValue< Encoding, Allocator >::GenericValue ( T  b, RAPIDJSON_ENABLEIF((internal::IsSame< T, bool >))    )

inlineexplicit

Constructor for boolean value.

Parameters

b	Boolean value

Note

This constructor is limited to real boolean values and rejects implicitly converted types like arbitrary pointers. Use an explicit cast to bool, if you want to construct a boolean JSON value in such cases.

 : data_(), flags_(b ? kTrueFlag : kFalseFlag) {
 // safe-guard against failing SFINAE
 RAPIDJSON_STATIC_ASSERT((internal::IsSame<bool,T>::Value));
 }

template<typename Encoding, typename Allocator = MemoryPoolAllocator<>>

GenericValue< Encoding, Allocator >::GenericValue ( int  i )

inlineexplicit

Constructor for int value.

 : data_(), flags_(kNumberIntFlag) {
 data_.n.i64 = i;
 if (i >= 0)
 flags_ |= kUintFlag | kUint64Flag;
 }

template<typename Encoding, typename Allocator = MemoryPoolAllocator<>>

GenericValue< Encoding, Allocator >::GenericValue ( unsigned  u )

inlineexplicit

Constructor for unsigned value.

 : data_(), flags_(kNumberUintFlag) {
 data_.n.u64 = u; 
 if (!(u & 0x80000000))
 flags_ |= kIntFlag | kInt64Flag;
 }

template<typename Encoding, typename Allocator = MemoryPoolAllocator<>>

GenericValue< Encoding, Allocator >::GenericValue ( int64_t  i64 )

inlineexplicit

Constructor for int64_t value.

 : data_(), flags_(kNumberInt64Flag) {
 data_.n.i64 = i64;
 if (i64 >= 0) {
 flags_ |= kNumberUint64Flag;
 if (!(static_cast<uint64_t>(i64) & RAPIDJSON_UINT64_C2(0xFFFFFFFF, 0x00000000)))
 flags_ |= kUintFlag;
 if (!(static_cast<uint64_t>(i64) & RAPIDJSON_UINT64_C2(0xFFFFFFFF, 0x80000000)))
 flags_ |= kIntFlag;
 }
 else if (i64 >= static_cast<int64_t>(RAPIDJSON_UINT64_C2(0xFFFFFFFF, 0x80000000)))
 flags_ |= kIntFlag;
 }

template<typename Encoding, typename Allocator = MemoryPoolAllocator<>>

GenericValue< Encoding, Allocator >::GenericValue ( uint64_t  u64 )

inlineexplicit

Constructor for uint64_t value.

 : data_(), flags_(kNumberUint64Flag) {
 data_.n.u64 = u64;
 if (!(u64 & RAPIDJSON_UINT64_C2(0x80000000, 0x00000000)))
 flags_ |= kInt64Flag;
 if (!(u64 & RAPIDJSON_UINT64_C2(0xFFFFFFFF, 0x00000000)))
 flags_ |= kUintFlag;
 if (!(u64 & RAPIDJSON_UINT64_C2(0xFFFFFFFF, 0x80000000)))
 flags_ |= kIntFlag;
 }

template<typename Encoding, typename Allocator = MemoryPoolAllocator<>>

GenericValue< Encoding, Allocator >::GenericValue ( double  d )

inlineexplicit

Constructor for double value.

: data_(), flags_(kNumberDoubleFlag) { data_.n.d = d; }

template<typename Encoding, typename Allocator = MemoryPoolAllocator<>>

GenericValue< Encoding, Allocator >::GenericValue ( const Ch *  s, SizeType  length  )

inline

Constructor for constant string (i.e. do not make a copy of string)

: data_(), flags_() { SetStringRaw(StringRef(s, length)); }

template<typename Encoding, typename Allocator = MemoryPoolAllocator<>>

GenericValue< Encoding, Allocator >::GenericValue ( StringRefType  s )

inlineexplicit

Constructor for constant string (i.e. do not make a copy of string)

: data_(), flags_() { SetStringRaw(s); }

template<typename Encoding, typename Allocator = MemoryPoolAllocator<>>

GenericValue< Encoding, Allocator >::GenericValue ( const Ch *  s, SizeType  length, Allocator &  allocator  )

inline

Constructor for copy-string (i.e. do make a copy of string)

: data_(), flags_() { SetStringRaw(StringRef(s, length), allocator); }

template<typename Encoding, typename Allocator = MemoryPoolAllocator<>>

GenericValue< Encoding, Allocator >::GenericValue ( const Ch *  s, Allocator &  allocator  )

inline

Constructor for copy-string (i.e. do make a copy of string)

: data_(), flags_() { SetStringRaw(StringRef(s), allocator); }

template<typename Encoding, typename Allocator = MemoryPoolAllocator<>>

GenericValue< Encoding, Allocator >::~GenericValue ( )

inline

Destructor.

Need to destruct elements of array, members of object, or copy-string.

 {
 if (Allocator::kNeedFree) { // Shortcut by Allocator's trait
 switch(flags_) {
 case kArrayFlag:
 for (GenericValue* v = data_.a.elements; v != data_.a.elements + data_.a.size; ++v)
 v->~GenericValue();
 Allocator::Free(data_.a.elements);
 break;

 case kObjectFlag:
 for (MemberIterator m = MemberBegin(); m != MemberEnd(); ++m)
 m->~Member();
 Allocator::Free(data_.o.members);
 break;

 case kCopyStringFlag:
 Allocator::Free(const_cast<Ch*>(data_.s.str));
 break;

 default:
 break; // Do nothing for other types.
 }
 }
 }

Here is the caller graph for this function:

Member Function Documentation

template<typename Encoding, typename Allocator = MemoryPoolAllocator<>>

GenericValue& GenericValue< Encoding, Allocator >::operator= ( GenericValue< Encoding, Allocator > &  rhs )

inline

Assignment with move semantics.

Parameters

rhs	Source of the assignment. It will become a null value after assignment.

 {
 RAPIDJSON_ASSERT(this != &rhs);
 this->~GenericValue();
 RawAssign(rhs);
 return *this;
 }

template<typename Encoding, typename Allocator = MemoryPoolAllocator<>>

GenericValue& GenericValue< Encoding, Allocator >::operator= ( StringRefType  str )

inline

Assignment of constant string reference (no copy)

Parameters

str	Constant string reference to be assigned

Note

This overload is needed to avoid clashes with the generic primitive type assignment overload below.

See also

GenericStringRef, operator=(T)

 {
 GenericValue s(str);
 return *this = s;
 }

template<typename Encoding, typename Allocator = MemoryPoolAllocator<>>

template<typename T >

GenericValue< Encoding, Allocator >::RAPIDJSON_DISABLEIF_RETURN	(	(internal::IsPointer< T >)	,
		(GenericValue< Encoding, Allocator > &)
	)

Assignment with primitive types.

Template Parameters

T	Either Type, int, unsigned, int64_t, uint64_t

Parameters

value

The value to be assigned.

Note

The source type T explicitly disallows all pointer types, especially (const) Ch*. This helps avoiding implicitly referencing character strings with insufficient lifetime, use SetString(const Ch*, Allocator&) (for copying) or StringRef() (to explicitly mark the pointer as constant) instead. All other pointer types would implicitly convert to bool, use SetBool() instead.Set boolean value

template<typename Encoding, typename Allocator = MemoryPoolAllocator<>>

void GenericValue< Encoding, Allocator >::RawAssign ( GenericValue< Encoding, Allocator > &  rhs )

inline

Assignment without calling destructor.

 {
 data_ = rhs.data_;
 flags_ = rhs.flags_;
 rhs.flags_ = kNullFlag;
 }

Here is the caller graph for this function:

template<typename Encoding, typename Allocator = MemoryPoolAllocator<>>

void GenericValue< Encoding, Allocator >::SetArrayRaw ( GenericValue< Encoding, Allocator > *  values, SizeType  count, Allocator &  allocator  )

inline

 {
 flags_ = kArrayFlag;
 if (count) {
 data_.a.elements = (GenericValue*)allocator.Malloc(count * sizeof(GenericValue));
 std::memcpy(data_.a.elements, values, count * sizeof(GenericValue));
 }
 else
 data_.a.elements = NULL;
 data_.a.size = data_.a.capacity = count;
 }

Here is the caller graph for this function:

template<typename Encoding, typename Allocator = MemoryPoolAllocator<>>

void GenericValue< Encoding, Allocator >::SetObjectRaw ( Member *  members, SizeType  count, Allocator &  allocator  )

inline

Initialize this value as object with initial data, without calling destructor.

 {
 flags_ = kObjectFlag;
 if (count) {
 data_.o.members = (Member*)allocator.Malloc(count * sizeof(Member));
 std::memcpy(data_.o.members, members, count * sizeof(Member));
 }
 else
 data_.o.members = NULL;
 data_.o.size = data_.o.capacity = count;
 }

Here is the caller graph for this function:

template<typename Encoding, typename Allocator = MemoryPoolAllocator<>>

void GenericValue< Encoding, Allocator >::SetStringRaw ( StringRefType  s )

inline

Initialize this value as constant string, without calling destructor.

 {
 flags_ = kConstStringFlag;
 data_.s.str = s;
 data_.s.length = s.length;
 }

Here is the caller graph for this function:

template<typename Encoding, typename Allocator = MemoryPoolAllocator<>>

void GenericValue< Encoding, Allocator >::SetStringRaw ( StringRefType  s, Allocator &  allocator  )

inline

Initialize this value as copy string with initial data, without calling destructor.

 {
 Ch* str = NULL;
 if(ShortString::Usable(s.length)) {
 flags_ = kShortStringFlag;
 data_.ss.SetLength(s.length);
 str = data_.ss.str;
 } else {
 flags_ = kCopyStringFlag;
 data_.s.length = s.length;
 str = (Ch *)allocator.Malloc((s.length + 1) * sizeof(Ch));
 data_.s.str = str;
 }
 std::memcpy(str, s, s.length * sizeof(Ch));
 str[s.length] = '\0';
 }

template<typename Encoding, typename Allocator = MemoryPoolAllocator<>>

template<typename SourceAllocator >

bool GenericValue< Encoding, Allocator >::StringEqual ( const GenericValue< Encoding, SourceAllocator > &  rhs ) const

inline

 {
 RAPIDJSON_ASSERT(IsString());
 RAPIDJSON_ASSERT(rhs.IsString());

 const SizeType len1 = GetStringLength();
 const SizeType len2 = rhs.GetStringLength();
 if(len1 != len2) { return false; }

 const Ch* const str1 = GetString();
 const Ch* const str2 = rhs.GetString();
 if(str1 == str2) { return true; } // fast path for constant string

 return (std::memcmp(str1, str2, sizeof(Ch) * len1) == 0);
 }

Friends And Related Function Documentation

template<typename Encoding, typename Allocator = MemoryPoolAllocator<>>

template<typename , typename , typename >

friend class GenericDocument

friend

Member Data Documentation

template<typename Encoding, typename Allocator = MemoryPoolAllocator<>>

Data GenericValue< Encoding, Allocator >::data_

template<typename Encoding, typename Allocator = MemoryPoolAllocator<>>

unsigned GenericValue< Encoding, Allocator >::flags_

template<typename Encoding, typename Allocator = MemoryPoolAllocator<>>

const SizeType GenericValue< Encoding, Allocator >::kDefaultArrayCapacity = 16

static

template<typename Encoding, typename Allocator = MemoryPoolAllocator<>>

const SizeType GenericValue< Encoding, Allocator >::kDefaultObjectCapacity = 16

static

---

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

• dep/rapidjson/rapidjson/document.h