GenericValue< Encoding, Allocator > Class Template Reference

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

#include <document.h>

Inheritance diagram for GenericValue< Encoding, Allocator >:

Classes
struct	ArrayData
union	Data
struct	Flag
union	Number
struct	ObjectData
struct	ShortString
struct	String

Public Types
enum	{   kBoolFlag = 0x0008, kNumberFlag = 0x0010, kIntFlag = 0x0020, kUintFlag = 0x0040,   kInt64Flag = 0x0080, kUint64Flag = 0x0100, kDoubleFlag = 0x0200, kStringFlag = 0x0400,   kCopyFlag = 0x0800, kInlineStrFlag = 0x1000, 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 = 0x07 }
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...
typedef GenericArray< false, ValueType >	Array
typedef GenericArray< true, ValueType >	ConstArray
typedef GenericObject< false, ValueType >	Object
typedef GenericObject< true, ValueType >	ConstObject

Public Member Functions
template<typename T >
	RAPIDJSON_DISABLEIF_RETURN ((internal::IsPointer< T >),(GenericValue &)) operator
	Assignment with primitive types. More...
RAPIDJSON_FORCEINLINE const Ch *	GetStringPointer () const
RAPIDJSON_FORCEINLINE const Ch *	SetStringPointer (const Ch *str)
RAPIDJSON_FORCEINLINE GenericValue *	GetElementsPointer () const
RAPIDJSON_FORCEINLINE GenericValue *	SetElementsPointer (GenericValue *elements)
RAPIDJSON_FORCEINLINE Member *	GetMembersPointer () const
RAPIDJSON_FORCEINLINE Member *	SetMembersPointer (Member *members)
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_

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, bool copyConstStrings=false)
	Explicit copy constructor (with allocator) More...
template<typename T >
	GenericValue (T b, RAPIDJSON_ENABLEIF((internal::IsSame< bool, T >))) 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 (float f) RAPIDJSON_NOEXCEPT
	Constructor for float 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 (Array a) RAPIDJSON_NOEXCEPT
	Constructor for Array. More...
	GenericValue (Object o) RAPIDJSON_NOEXCEPT
	Constructor for Object. 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.

Definition at line 57 of file document.h.

Member Typedef Documentation

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

typedef Allocator GenericValue< Encoding, Allocator >::AllocatorType

Allocator type from template parameter.

Definition at line 580 of file document.h.

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

typedef GenericArray<false, ValueType> GenericValue< Encoding, Allocator >::Array

Definition at line 588 of file document.h.

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

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

Character type derived from Encoding.

Definition at line 581 of file document.h.

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

typedef GenericArray<true, ValueType> GenericValue< Encoding, Allocator >::ConstArray

Definition at line 589 of file document.h.

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

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

Constant member iterator for iterating in object.

Definition at line 584 of file document.h.

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

typedef GenericObject<true, ValueType> GenericValue< Encoding, Allocator >::ConstObject

Definition at line 591 of file document.h.

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

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

Constant value iterator for iterating in array.

Definition at line 586 of file document.h.

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

typedef Encoding GenericValue< Encoding, Allocator >::EncodingType

Encoding type from template parameter.

Definition at line 579 of file document.h.

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

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

Name-value pair in an object.

Definition at line 578 of file document.h.

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

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

Member iterator for iterating in object.

Definition at line 583 of file document.h.

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

typedef GenericObject<false, ValueType> GenericValue< Encoding, Allocator >::Object

Definition at line 590 of file document.h.

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

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

Reference to a constant string.

Definition at line 582 of file document.h.

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

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

Value iterator for iterating in array.

Definition at line 585 of file document.h.

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

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

Value type of itself.

Definition at line 587 of file document.h.

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

Definition at line 1907 of file document.h.

         {
        kBoolFlag       = 0x0008,
        kNumberFlag     = 0x0010,
        kIntFlag        = 0x0020,
        kUintFlag       = 0x0040,
        kInt64Flag      = 0x0080,
        kUint64Flag     = 0x0100,
        kDoubleFlag     = 0x0200,
        kStringFlag     = 0x0400,
        kCopyFlag       = 0x0800,
        kInlineStrFlag  = 0x1000,

        // 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 = 0x07
    };

Constructor & Destructor Documentation

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

GenericValue< Encoding, Allocator >::GenericValue ( )

inline

Default constructor creates a null value.

Definition at line 597 of file document.h.

: data_() { data_.f.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.

Definition at line 627 of file document.h.

                                                        : data_() {
        static const uint16_t defaultFlags[7] = {
            kNullFlag, kFalseFlag, kTrueFlag, kObjectFlag, kArrayFlag, kShortStringFlag,
            kNumberAnyFlag
        };
        RAPIDJSON_ASSERT(type >= kNullType && type <= kNumberType);
        data_.f.flags = defaultFlags[type];

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

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

template<typename SourceAllocator >

GenericValue< Encoding, Allocator >::GenericValue ( const GenericValue< Encoding, SourceAllocator > &  rhs, Allocator &  allocator, bool  copyConstStrings = false  )

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().
copyConstStrings	Force copying of constant strings (e.g. referencing an in-situ buffer)

See also

CopyFrom()

Definition at line 649 of file document.h.

                                                                                                                         {
        switch (rhs.GetType()) {
        case kObjectType: {
                SizeType count = rhs.data_.o.size;
                Member* lm = reinterpret_cast<Member*>(allocator.Malloc(count * sizeof(Member)));
                const typename GenericValue<Encoding,SourceAllocator>::Member* rm = rhs.GetMembersPointer();
                for (SizeType i = 0; i < count; i++) {
                    new (&lm[i].name) GenericValue(rm[i].name, allocator, copyConstStrings);
                    new (&lm[i].value) GenericValue(rm[i].value, allocator, copyConstStrings);
                }
                data_.f.flags = kObjectFlag;
                data_.o.size = data_.o.capacity = count;
                SetMembersPointer(lm);
            }
            break;
        case kArrayType: {
                SizeType count = rhs.data_.a.size;
                GenericValue* le = reinterpret_cast<GenericValue*>(allocator.Malloc(count * sizeof(GenericValue)));
                const GenericValue<Encoding,SourceAllocator>* re = rhs.GetElementsPointer();
                for (SizeType i = 0; i < count; i++)
                    new (&le[i]) GenericValue(re[i], allocator, copyConstStrings);
                data_.f.flags = kArrayFlag;
                data_.a.size = data_.a.capacity = count;
                SetElementsPointer(le);
            }
            break;
        case kStringType:
            if (rhs.data_.f.flags == kConstStringFlag && !copyConstStrings) {
                data_.f.flags = rhs.data_.f.flags;
                data_  = *reinterpret_cast<const Data*>(&rhs.data_);
            }
            else
                SetStringRaw(StringRef(rhs.GetString(), rhs.GetStringLength()), allocator);
            break;
        default:
            data_.f.flags = rhs.data_.f.flags;
            data_  = *reinterpret_cast<const Data*>(&rhs.data_);
            break;
        }
    }

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

template<typename T >

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

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.

Definition at line 698 of file document.h.

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

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

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

inlineexplicit

Constructor for int value.

Definition at line 709 of file document.h.

                                                    : data_() {
        data_.n.i64 = i;
        data_.f.flags = (i >= 0) ? (kNumberIntFlag | kUintFlag | kUint64Flag) : kNumberIntFlag;
    }

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

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

inlineexplicit

Constructor for unsigned value.

Definition at line 715 of file document.h.

                                                         : data_() {
        data_.n.u64 = u; 
        data_.f.flags = (u & 0x80000000) ? kNumberUintFlag : (kNumberUintFlag | kIntFlag | kInt64Flag);
    }

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

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

inlineexplicit

Constructor for int64_t value.

Definition at line 721 of file document.h.

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

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

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

inlineexplicit

Constructor for uint64_t value.

Definition at line 736 of file document.h.

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

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

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

inlineexplicit

Constructor for double value.

Definition at line 748 of file document.h.

: data_() { data_.n.d = d; data_.f.flags = kNumberDoubleFlag; }

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

GenericValue< Encoding, Allocator >::GenericValue ( float  f )

inlineexplicit

Constructor for float value.

Definition at line 751 of file document.h.

: data_() { data_.n.d = static_cast<double>(f); data_.f.flags = kNumberDoubleFlag; }

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)

Definition at line 754 of file document.h.

: data_() { 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)

Definition at line 757 of file document.h.

: data_() { 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)

Definition at line 760 of file document.h.

: data_() { 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)

Definition at line 763 of file document.h.

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

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

GenericValue< Encoding, Allocator >::GenericValue ( Array  a )

inline

Constructor for Array.

Parameters

a	An array obtained by GetArray().

Note

Array is always pass-by-value.

the source array is moved into this value and the sourec array becomes empty.

Definition at line 778 of file document.h.

                                             : data_(a.value_.data_) {
        a.value_.data_ = Data();
        a.value_.data_.f.flags = kArrayFlag;
    }

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

GenericValue< Encoding, Allocator >::GenericValue ( Object  o )

inline

Constructor for Object.

Parameters

o	An object obtained by GetObject().

Note

Object is always pass-by-value.

the source object is moved into this value and the sourec object becomes empty.

Definition at line 789 of file document.h.

                                              : data_(o.value_.data_) {
        o.value_.data_ = Data();
        o.value_.data_.f.flags = kObjectFlag;
    }

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

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

inline

Destructor.

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

Definition at line 797 of file document.h.

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

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

            case kCopyStringFlag:
                Allocator::Free(const_cast<Ch*>(GetStringPointer()));
                break;

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

Member Function Documentation

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

RAPIDJSON_FORCEINLINE GenericValue* GenericValue< Encoding, Allocator >::GetElementsPointer ( ) const

inline

Definition at line 2024 of file document.h.

{ return RAPIDJSON_GETPOINTER(GenericValue, data_.a.elements); }

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

RAPIDJSON_FORCEINLINE Member* GenericValue< Encoding, Allocator >::GetMembersPointer ( ) const

inline

Definition at line 2026 of file document.h.

{ return RAPIDJSON_GETPOINTER(Member, data_.o.members); }

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

RAPIDJSON_FORCEINLINE const Ch* GenericValue< Encoding, Allocator >::GetStringPointer ( ) const

inline

Definition at line 2022 of file document.h.

{ return RAPIDJSON_GETPOINTER(Ch, data_.s.str); }

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.

Definition at line 833 of file document.h.

                                                                  {
        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)

Definition at line 852 of file document.h.

                                                                  {
        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.

Definition at line 2080 of file document.h.

                                                         {
        data_ = rhs.data_;
        // data_.f.flags = rhs.data_.f.flags;
        rhs.data_.f.flags = kNullFlag;
    }

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

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

inline

Definition at line 2030 of file document.h.

                                                                                 {
        data_.f.flags = kArrayFlag;
        if (count) {
            GenericValue* e = static_cast<GenericValue*>(allocator.Malloc(count * sizeof(GenericValue)));
            SetElementsPointer(e);
            std::memcpy(static_cast<void*>(e), values, count * sizeof(GenericValue));
        }
        else
            SetElementsPointer(0);
        data_.a.size = data_.a.capacity = count;
    }

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

RAPIDJSON_FORCEINLINE GenericValue* GenericValue< Encoding, Allocator >::SetElementsPointer ( GenericValue< Encoding, Allocator > *  elements )

inline

Definition at line 2025 of file document.h.

{ return RAPIDJSON_SETPOINTER(GenericValue, data_.a.elements, elements); }

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

RAPIDJSON_FORCEINLINE Member* GenericValue< Encoding, Allocator >::SetMembersPointer ( Member *  members )

inline

Definition at line 2027 of file document.h.

{ return RAPIDJSON_SETPOINTER(Member, data_.o.members, members); }

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.

Definition at line 2043 of file document.h.

                                                                             {
        data_.f.flags = kObjectFlag;
        if (count) {
            Member* m = static_cast<Member*>(allocator.Malloc(count * sizeof(Member)));
            SetMembersPointer(m);
            std::memcpy(static_cast<void*>(m), members, count * sizeof(Member));
        }
        else
            SetMembersPointer(0);
        data_.o.size = data_.o.capacity = count;
    }

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

RAPIDJSON_FORCEINLINE const Ch* GenericValue< Encoding, Allocator >::SetStringPointer ( const Ch *  str )

inline

Definition at line 2023 of file document.h.

{ return RAPIDJSON_SETPOINTER(Ch, data_.s.str, str); }

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

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

inline

Initialize this value as constant string, without calling destructor.

Definition at line 2056 of file document.h.

                                                          {
        data_.f.flags = kConstStringFlag;
        SetStringPointer(s);
        data_.s.length = s.length;
    }

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.

Definition at line 2063 of file document.h.

                                                             {
        Ch* str = 0;
        if (ShortString::Usable(s.length)) {
            data_.f.flags = kShortStringFlag;
            data_.ss.SetLength(s.length);
            str = data_.ss.str;
        } else {
            data_.f.flags = kCopyStringFlag;
            data_.s.length = s.length;
            str = static_cast<Ch *>(allocator.Malloc((s.length + 1) * sizeof(Ch)));
            SetStringPointer(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

Definition at line 2087 of file document.h.

                                                                               {
        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

Definition at line 1905 of file document.h.

Member Data Documentation

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

Data GenericValue< Encoding, Allocator >::data_

Definition at line 2102 of file document.h.

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

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

static

Definition at line 1938 of file document.h.

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

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

static

Definition at line 1939 of file document.h.

---

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

• art/rapidjson/document.h