GenericDocument< Encoding, Allocator, StackAllocator > Class Template Reference

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

Public Types
typedef Encoding::Ch	Ch
	Character type derived from Encoding.
typedef GenericValue< Encoding, Allocator >	ValueType
	Value type of the document.
typedef Allocator	AllocatorType
	Allocator type from template parameter.
Public Types inherited from GenericValue< Encoding, MemoryPoolAllocator<> >
typedef GenericMember< Encoding, MemoryPoolAllocator<> >	Member
	Name-value pair in an object.
typedef Encoding	EncodingType
	Encoding type from template parameter.
typedef MemoryPoolAllocator<>	AllocatorType
	Allocator type from template parameter.
typedef Encoding::Ch	Ch
	Character type derived from Encoding.
typedef GenericStringRef< Ch >	StringRefType
	Reference to a constant string.
typedef GenericMemberIterator< false, Encoding, MemoryPoolAllocator<> >::Iterator	MemberIterator
	Member iterator for iterating in object.
typedef GenericMemberIterator< true, Encoding, MemoryPoolAllocator<> >::Iterator	ConstMemberIterator
	Constant member iterator for iterating in object.
typedef GenericValue *	ValueIterator
	Value iterator for iterating in array.
typedef const GenericValue *	ConstValueIterator
	Constant value iterator for iterating in array.
typedef GenericValue< Encoding, MemoryPoolAllocator<> >	ValueType
	Value type of itself.
typedef GenericArray< false, ValueType >	Array
typedef GenericArray< true, ValueType >	ConstArray
typedef GenericObject< false, ValueType >	Object
typedef GenericObject< true, ValueType >	ConstObject
enum

Public Member Functions
	GenericDocument (Type type, Allocator *allocator=0, size_t stackCapacity=kDefaultStackCapacity, StackAllocator *stackAllocator=0)
	Constructor.
	GenericDocument (Allocator *allocator=0, size_t stackCapacity=kDefaultStackCapacity, StackAllocator *stackAllocator=0)
	Constructor.
	~GenericDocument ()
GenericDocument &	Swap (GenericDocument &rhs) RAPIDJSON_NOEXCEPT
	Exchange the contents of this document with those of another.
template<typename Generator >
GenericDocument &	Populate (Generator &g)
	Populate this document by a generator which produces SAX events.
Allocator &	GetAllocator ()
	Get the allocator of this document.
size_t	GetStackCapacity () const
	Get the capacity of stack in bytes.
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)
Parse from stream
template<unsigned parseFlags, typename SourceEncoding , typename InputStream >
GenericDocument &	ParseStream (InputStream &is)
	Parse JSON text from an input stream (with Encoding conversion)
template<unsigned parseFlags, typename InputStream >
GenericDocument &	ParseStream (InputStream &is)
	Parse JSON text from an input stream.
template<typename InputStream >
GenericDocument &	ParseStream (InputStream &is)
	Parse JSON text from an input stream (with kParseDefaultFlags)
Parse in-place from mutable string
template<unsigned parseFlags>
GenericDocument &	ParseInsitu (Ch *str)
	Parse JSON text from a mutable string.
GenericDocument &	ParseInsitu (Ch *str)
	Parse JSON text from a mutable string (with kParseDefaultFlags)
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)
template<unsigned parseFlags>
GenericDocument &	Parse (const Ch *str)
	Parse JSON text from a read-only string.
GenericDocument &	Parse (const Ch *str)
	Parse JSON text from a read-only string (with kParseDefaultFlags)
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.
ParseErrorCode	GetParseError () const
	Get the ParseErrorCode of last parsing.
size_t	GetErrorOffset () const
	Get the position of last parsing error in input, 0 otherwise.
	operator ParseResult () const
	Implicit conversion to get the last parse result.
Public Member Functions inherited from GenericValue< Encoding, MemoryPoolAllocator<> >
GenericValue &	operator= (GenericValue &rhs) RAPIDJSON_NOEXCEPT
	Assignment with move semantics.
GenericValue &	operator= (StringRefType str) RAPIDJSON_NOEXCEPT
	Assignment of constant string reference (no copy)
	RAPIDJSON_DISABLEIF_RETURN ((internal::IsPointer< T >),(GenericValue &)) operator
	Assignment with primitive types.
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, MemoryPoolAllocator<> &allocator)
void	SetObjectRaw (Member *members, SizeType count, MemoryPoolAllocator<> &allocator)
	Initialize this value as object with initial data, without calling destructor.
void	SetStringRaw (StringRefType s) RAPIDJSON_NOEXCEPT
	Initialize this value as constant string, without calling destructor.
void	SetStringRaw (StringRefType s, MemoryPoolAllocator<> &allocator)
	Initialize this value as copy string with initial data, without calling destructor.
void	RawAssign (GenericValue &rhs) RAPIDJSON_NOEXCEPT
	Assignment without calling destructor.
bool	StringEqual (const GenericValue< Encoding, SourceAllocator > &rhs) const
	GenericValue () RAPIDJSON_NOEXCEPT
	Default constructor creates a null value.
	GenericValue (Type type) RAPIDJSON_NOEXCEPT
	Constructor with JSON value type.
	GenericValue (const GenericValue< Encoding, SourceAllocator > &rhs, MemoryPoolAllocator<> &allocator, bool copyConstStrings=false)
	Explicit copy constructor (with allocator)
	GenericValue (T b, RAPIDJSON_ENABLEIF((internal::IsSame< bool, T >))) RAPIDJSON_NOEXCEPT
	Constructor for boolean value.
	GenericValue (int i) RAPIDJSON_NOEXCEPT
	Constructor for int value.
	GenericValue (unsigned u) RAPIDJSON_NOEXCEPT
	Constructor for unsigned value.
	GenericValue (int64_t i64) RAPIDJSON_NOEXCEPT
	Constructor for int64_t value.
	GenericValue (uint64_t u64) RAPIDJSON_NOEXCEPT
	Constructor for uint64_t value.
	GenericValue (double d) RAPIDJSON_NOEXCEPT
	Constructor for double value.
	GenericValue (float f) RAPIDJSON_NOEXCEPT
	Constructor for float value.
	GenericValue (const Ch *s, SizeType length) RAPIDJSON_NOEXCEPT
	Constructor for constant string (i.e. do not make a copy of string)
	GenericValue (StringRefType s) RAPIDJSON_NOEXCEPT
	Constructor for constant string (i.e. do not make a copy of string)
	GenericValue (const Ch *s, SizeType length, MemoryPoolAllocator<> &allocator)
	Constructor for copy-string (i.e. do make a copy of string)
	GenericValue (const Ch *s, MemoryPoolAllocator<> &allocator)
	Constructor for copy-string (i.e. do make a copy of string)
	GenericValue (Array a) RAPIDJSON_NOEXCEPT
	Constructor for Array.
	GenericValue (Object o) RAPIDJSON_NOEXCEPT
	Constructor for Object.
	~GenericValue ()
	Destructor.

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

Additional Inherited Members
Public Attributes inherited from GenericValue< Encoding, MemoryPoolAllocator<> >
Data	data_
Static Public Attributes inherited from GenericValue< Encoding, MemoryPoolAllocator<> >
static const SizeType	kDefaultArrayCapacity
static const SizeType	kDefaultObjectCapacity

Detailed Description

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

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 2124 of file document.h.

Member Typedef Documentation

AllocatorType

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

Allocator GenericDocument< Encoding, Allocator, StackAllocator >::AllocatorType

Definition at line 2128 of file document.h.

Ch

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

Encoding::Ch GenericDocument< Encoding, Allocator, StackAllocator >::Ch

Definition at line 2126 of file document.h.

ValueType

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

GenericValue<Encoding, Allocator> GenericDocument< Encoding, Allocator, StackAllocator >::ValueType

Definition at line 2127 of file document.h.

Constructor & Destructor Documentation

GenericDocument() [1/2]

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

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

inlineexplicit

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/2]

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

GenericDocument< Encoding, Allocator, StackAllocator >::GenericDocument ( Allocator * allocator = 0, size_t stackCapacity = kDefaultStackCapacity, StackAllocator * stackAllocator = 0 )

inline

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

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

GenericDocument< Encoding, Allocator, StackAllocator >::~GenericDocument ( )

inline

Definition at line 2172 of file document.h.

                       {
        Destroy();
    }

Member Function Documentation

Bool()

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

bool GenericDocument< Encoding, Allocator, StackAllocator >::Bool ( bool b )

inline

Definition at line 2438 of file document.h.

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

Double()

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

bool GenericDocument< Encoding, Allocator, StackAllocator >::Double ( double d )

inline

Definition at line 2443 of file document.h.

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

EndArray()

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

bool GenericDocument< Encoding, Allocator, StackAllocator >::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()

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

bool GenericDocument< Encoding, Allocator, StackAllocator >::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()

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

Allocator & GenericDocument< Encoding, Allocator, StackAllocator >::GetAllocator ( )

inline

Definition at line 2412 of file document.h.

                              {
        RAPIDJSON_ASSERT(allocator_);
        return *allocator_;
    }

Here is the caller graph for this function:

GetErrorOffset()

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

size_t GenericDocument< Encoding, Allocator, StackAllocator >::GetErrorOffset ( ) const

inline

Definition at line 2394 of file document.h.

{ return parseResult_.Offset(); }

Here is the call graph for this function:

Here is the caller graph for this function:

GetParseError()

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

ParseErrorCode GenericDocument< Encoding, Allocator, StackAllocator >::GetParseError ( ) const

inline

Definition at line 2391 of file document.h.

{ return parseResult_.Code(); }

Here is the call graph for this function:

Here is the caller graph for this function:

GetStackCapacity()

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

size_t GenericDocument< Encoding, Allocator, StackAllocator >::GetStackCapacity ( ) const

inline

Definition at line 2418 of file document.h.

{ return stack_.GetCapacity(); }

Here is the call graph for this function:

HasParseError()

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

bool GenericDocument< Encoding, Allocator, StackAllocator >::HasParseError ( ) const

inline

Definition at line 2388 of file document.h.

{ return parseResult_.IsError(); }

Here is the call graph for this function:

Here is the caller graph for this function:

Int()

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

bool GenericDocument< Encoding, Allocator, StackAllocator >::Int ( int i )

inline

Definition at line 2439 of file document.h.

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

Int64()

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

bool GenericDocument< Encoding, Allocator, StackAllocator >::Int64 ( int64_t i )

inline

Definition at line 2441 of file document.h.

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

Key()

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

bool GenericDocument< Encoding, Allocator, StackAllocator >::Key ( const Ch * str, SizeType length, bool copy )

inline

Definition at line 2463 of file document.h.

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

Here is the call graph for this function:

Null()

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

bool GenericDocument< Encoding, Allocator, StackAllocator >::Null ( )

inline

Definition at line 2437 of file document.h.

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

operator ParseResult()

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

GenericDocument< Encoding, Allocator, StackAllocator >::operator ParseResult ( ) const

inline

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_; }

Parse() [1/6]

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

template<unsigned parseFlags>

GenericDocument & GenericDocument< Encoding, Allocator, StackAllocator >::Parse ( const Ch * str )

inline

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);
    }

Here is the call graph for this function:

Parse() [2/6]

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

GenericDocument & GenericDocument< Encoding, Allocator, StackAllocator >::Parse ( const Ch * str )

inline

Parameters

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

Definition at line 2343 of file document.h.

                                          {
        return Parse<kParseDefaultFlags>(str);
    }

Here is the call graph for this function:

Parse() [3/6]

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

template<unsigned parseFlags>

GenericDocument & GenericDocument< Encoding, Allocator, StackAllocator >::Parse ( const Ch * str, size_t length )

inline

Definition at line 2357 of file document.h.

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

Here is the call graph for this function:

Parse() [4/6]

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

GenericDocument & GenericDocument< Encoding, Allocator, StackAllocator >::Parse ( const Ch * str, size_t length )

inline

Definition at line 2361 of file document.h.

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

Here is the call graph for this function:

Parse() [5/6]

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

template<unsigned parseFlags, typename SourceEncoding >

GenericDocument & GenericDocument< Encoding, Allocator, StackAllocator >::Parse ( const typename SourceEncoding::Ch * str )

inline

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);
    }

Here is the call graph for this function:

Parse() [6/6]

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

template<unsigned parseFlags, typename SourceEncoding >

GenericDocument & GenericDocument< Encoding, Allocator, StackAllocator >::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;
    }

Here is the call graph for this function:

ParseInsitu() [1/2]

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

template<unsigned parseFlags>

GenericDocument & GenericDocument< Encoding, Allocator, StackAllocator >::ParseInsitu ( Ch * str )

inline

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);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

ParseInsitu() [2/2]

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

GenericDocument & GenericDocument< Encoding, Allocator, StackAllocator >::ParseInsitu ( Ch * str )

inline

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);
    }

Here is the call graph for this function:

ParseStream() [1/3]

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

template<unsigned parseFlags, typename SourceEncoding , typename InputStream >

GenericDocument & GenericDocument< Encoding, Allocator, StackAllocator >::ParseStream ( InputStream & is )

inline

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 call graph for this function:

Here is the caller graph for this function:

ParseStream() [2/3]

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

template<unsigned parseFlags, typename InputStream >

GenericDocument & GenericDocument< Encoding, Allocator, StackAllocator >::ParseStream ( InputStream & is )

inline

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);
    }

Here is the call graph for this function:

ParseStream() [3/3]

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

template<typename InputStream >

GenericDocument & GenericDocument< Encoding, Allocator, StackAllocator >::ParseStream ( InputStream & is )

inline

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);
    }

Here is the call graph for this function:

Populate()

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

template<typename Generator >

GenericDocument & GenericDocument< Encoding, Allocator, StackAllocator >::Populate ( Generator & g )

inline

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;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

RawNumber()

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

bool GenericDocument< Encoding, Allocator, StackAllocator >::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;
    }

Here is the call graph for this function:

StartArray()

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

bool GenericDocument< Encoding, Allocator, StackAllocator >::StartArray ( )

inline

Definition at line 2471 of file document.h.

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

StartObject()

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

bool GenericDocument< Encoding, Allocator, StackAllocator >::StartObject ( )

inline

Definition at line 2461 of file document.h.

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

String()

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

bool GenericDocument< Encoding, Allocator, StackAllocator >::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;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Swap()

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

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

inline

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:

Here is the caller graph for this function:

Uint()

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

bool GenericDocument< Encoding, Allocator, StackAllocator >::Uint ( unsigned i )

inline

Definition at line 2440 of file document.h.

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

Uint64()

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

bool GenericDocument< Encoding, Allocator, StackAllocator >::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 Symbol Documentation

GenericValue

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

template<typename , typename >

friend class GenericValue

friend

Definition at line 2433 of file document.h.

swap

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

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

friend

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); }

---

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

• libraries/fc/include/fc/crypto/webauthn_json/include/rapidjson/document.h