GenericDocument< Encoding, Allocator, StackAllocator >

A document for parsing JSON text as DOM. More...

#include <document.h>

Inheritance diagram for GenericDocument< Encoding, Allocator, StackAllocator >:

Collaboration diagram for GenericDocument< Encoding, Allocator, StackAllocator >:

Classes
struct	ClearStackOnExit

Public Types
typedef Encoding::Ch	Ch
	Character type derived from Encoding. More...
typedef GenericValue< Encoding, Allocator >	ValueType
	Value type of the document. More...
typedef Allocator	AllocatorType
	Allocator type from template parameter. More...
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 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 GenericArray< false, ValueType >	Array
typedef GenericArray< true, ValueType >	ConstArray
typedef GenericObject< false, ValueType >	Object
typedef GenericObject< true, ValueType >	ConstObject

Public Member Functions
	GenericDocument (Type type, Allocator *allocator=0, size_t stackCapacity=kDefaultStackCapacity, StackAllocator *stackAllocator=0)
	Constructor. More...
	GenericDocument (Allocator *allocator=0, size_t stackCapacity=kDefaultStackCapacity, StackAllocator *stackAllocator=0)
	Constructor. More...
	~GenericDocument ()
GenericDocument &	Swap (GenericDocument &rhs) RAPIDJSON_NOEXCEPT
	Exchange the contents of this document with those of another. More...
template<typename Generator >
GenericDocument &	Populate (Generator &g)
	Populate this document by a generator which produces SAX events. More...
Allocator &	GetAllocator ()
	Get the allocator of this document. More...
size_t	GetStackCapacity () const
	Get the capacity of stack in bytes. More...
bool	Null ()
bool	Bool (bool b)
bool	Int (int i)
bool	Uint (unsigned i)
bool	Int64 (int64_t i)
bool	Uint64 (uint64_t i)
bool	Double (double d)
bool	RawNumber (const Ch *str, SizeType length, bool copy)
bool	String (const Ch *str, SizeType length, bool copy)
bool	StartObject ()
bool	Key (const Ch *str, SizeType length, bool copy)
bool	EndObject (SizeType memberCount)
bool	StartArray ()
bool	EndArray (SizeType elementCount)
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
Parse from stream
template<unsigned parseFlags, typename SourceEncoding , typename InputStream >
GenericDocument &	ParseStream (InputStream &is)
	Parse JSON text from an input stream (with Encoding conversion) More...
template<unsigned parseFlags, typename InputStream >
GenericDocument &	ParseStream (InputStream &is)
	Parse JSON text from an input stream. More...
template<typename InputStream >
GenericDocument &	ParseStream (InputStream &is)
	Parse JSON text from an input stream (with kParseDefaultFlags) More...
Parse in-place from mutable string
template<unsigned parseFlags>
GenericDocument &	ParseInsitu (Ch *str)
	Parse JSON text from a mutable string. More...
GenericDocument &	ParseInsitu (Ch *str)
	Parse JSON text from a mutable string (with kParseDefaultFlags) More...
Parse from read-only string
template<unsigned parseFlags, typename SourceEncoding >
GenericDocument &	Parse (const typename SourceEncoding::Ch *str)
	Parse JSON text from a read-only string (with Encoding conversion) More...
template<unsigned parseFlags>
GenericDocument &	Parse (const Ch *str)
	Parse JSON text from a read-only string. More...
GenericDocument &	Parse (const Ch *str)
	Parse JSON text from a read-only string (with kParseDefaultFlags) More...
template<unsigned parseFlags, typename SourceEncoding >
GenericDocument &	Parse (const typename SourceEncoding::Ch *str, size_t length)
template<unsigned parseFlags>
GenericDocument &	Parse (const Ch *str, size_t length)
GenericDocument &	Parse (const Ch *str, size_t length)
Handling parse errors
bool	HasParseError () const
	Whether a parse error has occurred in the last parsing. More...
ParseErrorCode	GetParseError () const
	Get the ParseErrorCode of last parsing. More...
size_t	GetErrorOffset () const
	Get the position of last parsing error in input, 0 otherwise. More...
	operator ParseResult () const
	Implicit conversion to get the last parse result. More...

Public Attributes
Data	data_

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

Private Member Functions
	GenericDocument (const GenericDocument &)
	Prohibit copying. More...
GenericDocument &	operator= (const GenericDocument &)
	Prohibit assignment. More...
void	ClearStack ()
void	Destroy ()

Private Attributes
Allocator *	allocator_
Allocator *	ownAllocator_
internal::Stack< StackAllocator >	stack_
ParseResult	parseResult_

Static Private Attributes
static const size_t	kDefaultStackCapacity = 1024

Friends
template<typename , typename >
class	GenericValue
void	swap (GenericDocument &a, GenericDocument &b) RAPIDJSON_NOEXCEPT
	free-standing swap function helper More...

Detailed Description

template<typename Encoding, typename Allocator = MemoryPoolAllocator<>, typename StackAllocator = CrtAllocator>
class GenericDocument< Encoding, Allocator, StackAllocator >

A document for parsing JSON text as DOM.

Note

implements Handler concept

Template Parameters

Encoding	Encoding for both parsing and string storage.
Allocator	Allocator for allocating memory for the DOM
StackAllocator	Allocator for allocating memory for stack during parsing.

Warning

Although GenericDocument inherits from GenericValue, the API does not provide any virtual functions, especially no virtual destructor. To avoid memory leaks, do not delete a GenericDocument object via a pointer to a GenericValue.

Definition at line 57 of file document.h.

Member Typedef Documentation

AllocatorType

typedef Allocator AllocatorType

Allocator type from template parameter.

Definition at line 2128 of file document.h.

Array

typedef GenericArray<false, ValueType> Array

inherited

Definition at line 591 of file document.h.

Ch

typedef Encoding::Ch Ch

Character type derived from Encoding.

Definition at line 2126 of file document.h.

ConstArray

typedef GenericArray<true, ValueType> ConstArray

inherited

Definition at line 592 of file document.h.

ConstMemberIterator

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

inherited

Constant member iterator for iterating in object.

Definition at line 587 of file document.h.

ConstObject

typedef GenericObject<true, ValueType> ConstObject

inherited

Definition at line 594 of file document.h.

ConstValueIterator

typedef const GenericValue* ConstValueIterator

inherited

Constant value iterator for iterating in array.

Definition at line 589 of file document.h.

EncodingType

typedef Encoding EncodingType

inherited

Encoding type from template parameter.

Definition at line 582 of file document.h.

Member

typedef GenericMember<Encoding, Allocator> Member

inherited

Name-value pair in an object.

Definition at line 581 of file document.h.

MemberIterator

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

inherited

Member iterator for iterating in object.

Definition at line 586 of file document.h.

Object

typedef GenericObject<false, ValueType> Object

inherited

Definition at line 593 of file document.h.

StringRefType

typedef GenericStringRef<Ch> StringRefType

inherited

Reference to a constant string.

Definition at line 585 of file document.h.

ValueIterator

typedef GenericValue* ValueIterator

inherited

Value iterator for iterating in array.

Definition at line 588 of file document.h.

ValueType

typedef GenericValue<Encoding, Allocator> ValueType

Value type of the document.

Definition at line 2127 of file document.h.

Member Enumeration Documentation

anonymous enum

anonymous enum

inherited

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 1911 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

GenericDocument() [1/3]

GenericDocument ( Type  type, Allocator *  allocator = 0, size_t  stackCapacity = kDefaultStackCapacity, StackAllocator *  stackAllocator = 0  )

inlineexplicit

Constructor.

Creates an empty document of specified type.

Parameters

type	Mandatory type of object to create.
allocator	Optional allocator for allocating memory.
stackCapacity	Optional initial capacity of stack in bytes.
stackAllocator	Optional allocator for allocating memory for stack.

Definition at line 2137 of file document.h.

                                                                                                                                                    :
        GenericValue<Encoding, Allocator>(type),  allocator_(allocator), ownAllocator_(0), stack_(stackAllocator, stackCapacity), parseResult_()
    {
        if (!allocator_)
            ownAllocator_ = allocator_ = RAPIDJSON_NEW(Allocator)();
    }

GenericDocument() [2/3]

GenericDocument ( Allocator *  allocator = 0, size_t  stackCapacity = kDefaultStackCapacity, StackAllocator *  stackAllocator = 0  )

inline

Constructor.

Creates an empty document which type is Null.

Parameters

allocator	Optional allocator for allocating memory.
stackCapacity	Optional initial capacity of stack in bytes.
stackAllocator	Optional allocator for allocating memory for stack.

Definition at line 2150 of file document.h.

                                                                                                                                : 
        allocator_(allocator), ownAllocator_(0), stack_(stackAllocator, stackCapacity), parseResult_()
    {
        if (!allocator_)
            ownAllocator_ = allocator_ = RAPIDJSON_NEW(Allocator)();
    }

~GenericDocument()

~GenericDocument ( )

inline

Definition at line 2172 of file document.h.

                       {
        Destroy();
    }

GenericDocument() [3/3]

GenericDocument ( const GenericDocument< Encoding, Allocator, StackAllocator > &  )

private

Prohibit copying.

Member Function Documentation

Bool()

bool Bool ( bool  b )

inline

Definition at line 2438 of file document.h.

{ new (stack_.template Push<ValueType>()) ValueType(b); return true; }

ClearStack()

void ClearStack ( )

inlineprivate

Definition at line 2485 of file document.h.

                      {
        if (Allocator::kNeedFree)
            while (stack_.GetSize() > 0)    // Here assumes all elements in stack array are GenericValue (Member is actually 2 GenericValue objects)
                (stack_.template Pop<ValueType>(1))->~ValueType();
        else
            stack_.Clear();
        stack_.ShrinkToFit();
    }

Destroy()

void Destroy ( )

inlineprivate

Definition at line 2494 of file document.h.

                   {
        RAPIDJSON_DELETE(ownAllocator_);
    }

Double()

bool Double ( double  d )

inline

Definition at line 2443 of file document.h.

{ new (stack_.template Push<ValueType>()) ValueType(d); return true; }

EndArray()

bool EndArray ( SizeType  elementCount )

inline

Definition at line 2473 of file document.h.

                                         {
        ValueType* elements = stack_.template Pop<ValueType>(elementCount);
        stack_.template Top<ValueType>()->SetArrayRaw(elements, elementCount, GetAllocator());
        return true;
    }

Here is the call graph for this function:

EndObject()

bool EndObject ( SizeType  memberCount )

inline

Definition at line 2465 of file document.h.

                                         {
        typename ValueType::Member* members = stack_.template Pop<typename ValueType::Member>(memberCount);
        stack_.template Top<ValueType>()->SetObjectRaw(members, memberCount, GetAllocator());
        return true;
    }

Here is the call graph for this function:

GetAllocator()

Allocator& GetAllocator ( )

inline

Get the allocator of this document.

Definition at line 2412 of file document.h.

                              {
        RAPIDJSON_ASSERT(allocator_);
        return *allocator_;
    }

GetElementsPointer()

RAPIDJSON_FORCEINLINE GenericValue* GetElementsPointer ( ) const

inlineinherited

Definition at line 2028 of file document.h.

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

Here is the caller graph for this function:

GetErrorOffset()

size_t GetErrorOffset ( ) const

inline

Get the position of last parsing error in input, 0 otherwise.

Definition at line 2394 of file document.h.

{ return parseResult_.Offset(); }

GetMembersPointer()

RAPIDJSON_FORCEINLINE Member* GetMembersPointer ( ) const

inlineinherited

Definition at line 2030 of file document.h.

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

Here is the caller graph for this function:

GetParseError()

ParseErrorCode GetParseError ( ) const

inline

Get the ParseErrorCode of last parsing.

Definition at line 2391 of file document.h.

{ return parseResult_.Code(); }

GetStackCapacity()

size_t GetStackCapacity ( ) const

inline

Get the capacity of stack in bytes.

Definition at line 2418 of file document.h.

{ return stack_.GetCapacity(); }

GetStringPointer()

RAPIDJSON_FORCEINLINE const Ch* GetStringPointer ( ) const

inlineinherited

Definition at line 2026 of file document.h.

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

HasParseError()

bool HasParseError ( ) const

inline

Whether a parse error has occurred in the last parsing.

Definition at line 2388 of file document.h.

{ return parseResult_.IsError(); }

Int()

bool Int ( int  i )

inline

Definition at line 2439 of file document.h.

{ new (stack_.template Push<ValueType>()) ValueType(i); return true; }

Int64()

bool Int64 ( int64_t  i )

inline

Definition at line 2441 of file document.h.

{ new (stack_.template Push<ValueType>()) ValueType(i); return true; }

Key()

bool Key ( const Ch *  str, SizeType  length, bool  copy  )

inline

Definition at line 2463 of file document.h.

{ return String(str, length, copy); }

Null()

bool Null ( )

inline

Definition at line 2437 of file document.h.

{ new (stack_.template Push<ValueType>()) ValueType(); return true; }

operator ParseResult()

operator ParseResult ( ) const

inline

Implicit conversion to get the last parse result.

Returns

ParseResult of the last parse operation

Document doc;
ParseResult ok = doc.Parse(json);
if (!ok)
  printf( "JSON parse error: %s (%u)\n", GetParseError_En(ok.Code()), ok.Offset());

Definition at line 2408 of file document.h.

{ return parseResult_; }

operator=()

GenericDocument& operator= ( const GenericDocument< Encoding, Allocator, StackAllocator > &  )

private

Prohibit assignment.

Parse() [1/6]

GenericDocument& Parse ( const typename SourceEncoding::Ch *  str )

inline

Parse JSON text from a read-only string (with Encoding conversion)

Template Parameters

parseFlags	Combination of ParseFlag (must not contain kParseInsituFlag).
SourceEncoding	Transcoding from input Encoding

Parameters

str	Read-only zero-terminated string to be parsed.

Definition at line 2325 of file document.h.

                                                                 {
        RAPIDJSON_ASSERT(!(parseFlags & kParseInsituFlag));
        GenericStringStream<SourceEncoding> s(str);
        return ParseStream<parseFlags, SourceEncoding>(s);
    }

Parse() [2/6]

GenericDocument& Parse ( const Ch *  str )

inline

Parse JSON text from a read-only string.

Template Parameters

parseFlags

Combination of ParseFlag (must not contain kParseInsituFlag).

Parameters

str	Read-only zero-terminated string to be parsed.

Definition at line 2336 of file document.h.

                                          {
        return Parse<parseFlags, Encoding>(str);
    }

Parse() [3/6]

GenericDocument& Parse ( const Ch *  str )

inline

Parse JSON text from a read-only string (with kParseDefaultFlags)

Parameters

str	Read-only zero-terminated string to be parsed.

Definition at line 2343 of file document.h.

                                          {
        return Parse<kParseDefaultFlags>(str);
    }

Parse() [4/6]

GenericDocument& Parse ( const typename SourceEncoding::Ch *  str, size_t  length  )

inline

Definition at line 2348 of file document.h.

                                                                                {
        RAPIDJSON_ASSERT(!(parseFlags & kParseInsituFlag));
        MemoryStream ms(reinterpret_cast<const char*>(str), length * sizeof(typename SourceEncoding::Ch));
        EncodedInputStream<SourceEncoding, MemoryStream> is(ms);
        ParseStream<parseFlags, SourceEncoding>(is);
        return *this;
    }

Parse() [5/6]

GenericDocument& Parse ( const Ch *  str, size_t  length  )

inline

Definition at line 2357 of file document.h.

                                                         {
        return Parse<parseFlags, Encoding>(str, length);
    }

Parse() [6/6]

GenericDocument& Parse ( const Ch *  str, size_t  length  )

inline

Definition at line 2361 of file document.h.

                                                         {
        return Parse<kParseDefaultFlags>(str, length);
    }

ParseInsitu() [1/2]

GenericDocument& ParseInsitu ( Ch *  str )

inline

Parse JSON text from a mutable string.

Template Parameters

parseFlags

Combination of ParseFlag.

Parameters

str	Mutable zero-terminated string to be parsed.

Returns

The document itself for fluent API.

Definition at line 2302 of file document.h.

                                          {
        GenericInsituStringStream<Encoding> s(str);
        return ParseStream<parseFlags | kParseInsituFlag>(s);
    }

ParseInsitu() [2/2]

GenericDocument& ParseInsitu ( Ch *  str )

inline

Parse JSON text from a mutable string (with kParseDefaultFlags)

Parameters

str	Mutable zero-terminated string to be parsed.

Returns

The document itself for fluent API.

Definition at line 2311 of file document.h.

                                          {
        return ParseInsitu<kParseDefaultFlags>(str);
    }

ParseStream() [1/3]

GenericDocument& ParseStream ( InputStream &  is )

inline

Parse JSON text from an input stream (with Encoding conversion)

Template Parameters

parseFlags	Combination of ParseFlag.
SourceEncoding	Encoding of input stream
InputStream	Type of input stream, implementing Stream concept

Parameters

is	Input stream to be parsed.

Returns

The document itself for fluent API.

Definition at line 2259 of file document.h.

                                                  {
        GenericReader<SourceEncoding, Encoding, StackAllocator> reader(
            stack_.HasAllocator() ? &stack_.GetAllocator() : 0);
        ClearStackOnExit scope(*this);
        parseResult_ = reader.template Parse<parseFlags>(is, *this);
        if (parseResult_) {
            RAPIDJSON_ASSERT(stack_.GetSize() == sizeof(ValueType)); // Got one and only one root object
            ValueType::operator=(*stack_.template Pop<ValueType>(1));// Move value from stack to document
        }
        return *this;
    }

Here is the caller graph for this function:

ParseStream() [2/3]

GenericDocument& ParseStream ( InputStream &  is )

inline

Parse JSON text from an input stream.

Template Parameters

parseFlags	Combination of ParseFlag.
InputStream	Type of input stream, implementing Stream concept

Parameters

is	Input stream to be parsed.

Returns

The document itself for fluent API.

Definition at line 2278 of file document.h.

                                                  {
        return ParseStream<parseFlags, Encoding, InputStream>(is);
    }

ParseStream() [3/3]

GenericDocument& ParseStream ( InputStream &  is )

inline

Parse JSON text from an input stream (with kParseDefaultFlags)

Template Parameters

InputStream

Type of input stream, implementing Stream concept

Parameters

is	Input stream to be parsed.

Returns

The document itself for fluent API.

Definition at line 2288 of file document.h.

                                                  {
        return ParseStream<kParseDefaultFlags, Encoding, InputStream>(is);
    }

Populate()

GenericDocument& Populate ( Generator &  g )

inline

Populate this document by a generator which produces SAX events.

Template Parameters

Generator

A functor with bool f(Handler) prototype.

Parameters

g	Generator functor which sends SAX events to the parameter.

Returns

The document itself for fluent API.

Definition at line 2239 of file document.h.

                                            {
        ClearStackOnExit scope(*this);
        if (g(*this)) {
            RAPIDJSON_ASSERT(stack_.GetSize() == sizeof(ValueType)); // Got one and only one root object
            ValueType::operator=(*stack_.template Pop<ValueType>(1));// Move value from stack to document
        }
        return *this;
    }

RAPIDJSON_DISABLEIF_RETURN()

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

inherited

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

RawAssign()

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

inlineinherited

Assignment without calling destructor.

Definition at line 2084 of file document.h.

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

Here is the caller graph for this function:

RawNumber()

bool RawNumber ( const Ch *  str, SizeType  length, bool  copy  )

inline

Definition at line 2445 of file document.h.

                                                              { 
        if (copy) 
            new (stack_.template Push<ValueType>()) ValueType(str, length, GetAllocator());
        else
            new (stack_.template Push<ValueType>()) ValueType(str, length);
        return true;
    }

SetArrayRaw()

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

inlineinherited

Definition at line 2034 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;
    }

Here is the caller graph for this function:

SetElementsPointer()

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

inlineinherited

Definition at line 2029 of file document.h.

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

SetMembersPointer()

RAPIDJSON_FORCEINLINE Member* SetMembersPointer ( Member *  members )

inlineinherited

Definition at line 2031 of file document.h.

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

SetObjectRaw()

void SetObjectRaw ( Member *  members, SizeType  count, Allocator &  allocator  )

inlineinherited

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

Definition at line 2047 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;
    }

Here is the caller graph for this function:

SetStringPointer()

RAPIDJSON_FORCEINLINE const Ch* SetStringPointer ( const Ch *  str )

inlineinherited

Definition at line 2027 of file document.h.

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

SetStringRaw() [1/2]

void SetStringRaw ( StringRefType  s )

inlineinherited

Initialize this value as constant string, without calling destructor.

Definition at line 2060 of file document.h.

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

SetStringRaw() [2/2]

void SetStringRaw ( StringRefType  s, Allocator &  allocator  )

inlineinherited

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

Definition at line 2067 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';
    }

StartArray()

bool StartArray ( )

inline

Definition at line 2471 of file document.h.

{ new (stack_.template Push<ValueType>()) ValueType(kArrayType); return true; }

StartObject()

bool StartObject ( )

inline

Definition at line 2461 of file document.h.

{ new (stack_.template Push<ValueType>()) ValueType(kObjectType); return true; }

String()

bool String ( const Ch *  str, SizeType  length, bool  copy  )

inline

Definition at line 2453 of file document.h.

                                                           { 
        if (copy) 
            new (stack_.template Push<ValueType>()) ValueType(str, length, GetAllocator());
        else
            new (stack_.template Push<ValueType>()) ValueType(str, length);
        return true;
    }

StringEqual()

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

inlineinherited

Definition at line 2091 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);
    }

Here is the caller graph for this function:

Swap()

GenericDocument& Swap ( GenericDocument< Encoding, Allocator, StackAllocator > &  rhs )

inline

Exchange the contents of this document with those of another.

Parameters

rhs	Another document.

Note

Constant complexity.

See also

GenericValue::Swap

Definition at line 2206 of file document.h.

                                                                   {
        ValueType::Swap(rhs);
        stack_.Swap(rhs.stack_);
        internal::Swap(allocator_, rhs.allocator_);
        internal::Swap(ownAllocator_, rhs.ownAllocator_);
        internal::Swap(parseResult_, rhs.parseResult_);
        return *this;
    }

Here is the call graph for this function:

Uint()

bool Uint ( unsigned  i )

inline

Definition at line 2440 of file document.h.

{ new (stack_.template Push<ValueType>()) ValueType(i); return true; }

Uint64()

bool Uint64 ( uint64_t  i )

inline

Definition at line 2442 of file document.h.

{ new (stack_.template Push<ValueType>()) ValueType(i); return true; }

Friends And Related Function Documentation

GenericValue

friend class GenericValue

friend

Definition at line 2433 of file document.h.

swap

void swap ( GenericDocument< Encoding, Allocator, StackAllocator > &  a, GenericDocument< Encoding, Allocator, StackAllocator > &  b  )

friend

free-standing swap function helper

Helper function to enable support for common swap implementation pattern based on std::swap:

void swap(MyClass& a, MyClass& b) {
    using std::swap;
    swap(a.doc, b.doc);
    // ...
}

See also

Swap()

Definition at line 2231 of file document.h.

{ a.Swap(b); }

Member Data Documentation

allocator_

Allocator* allocator_

private

Definition at line 2499 of file document.h.

data_

Data data_

inherited

Definition at line 2106 of file document.h.

kDefaultArrayCapacity

const SizeType kDefaultArrayCapacity = 16

staticinherited

Definition at line 1942 of file document.h.

kDefaultObjectCapacity

const SizeType kDefaultObjectCapacity = 16

staticinherited

Definition at line 1943 of file document.h.

kDefaultStackCapacity

const size_t kDefaultStackCapacity = 1024

staticprivate

Definition at line 2498 of file document.h.

ownAllocator_

Allocator* ownAllocator_

private

Definition at line 2500 of file document.h.

parseResult_

ParseResult parseResult_

private

Definition at line 2502 of file document.h.

stack_

internal::Stack<StackAllocator> stack_

private

Definition at line 2501 of file document.h.

---

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

• rapidjson/document.h