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

Public Types
typedef Allocator	AllocatorType
	Allocator type from template parameter. More...

typedef Encoding::Ch	Ch
	Character type derived from Encoding. More...

typedef GenericValue< Encoding, Allocator >	ValueType
	Value type of the document. More...

Public Member Functions
	GenericDocument (Allocator allocator=0, size_t stackCapacity=kDefaultStackCapacity, StackAllocator stackAllocator=0)
	Constructor. More...

	GenericDocument (Type type, Allocator allocator=0, size_t stackCapacity=kDefaultStackCapacity, StackAllocator stackAllocator=0)
	Constructor. More...

Allocator &	GetAllocator ()
	Get the allocator of this document. More...

size_t	GetStackCapacity () const
	Get the capacity of stack in bytes. More...

GenericDocument &	Swap (GenericDocument &rhs) RAPIDJSON_NOEXCEPT
	Exchange the contents of this document with those of another. More...

	~GenericDocument ()

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

Handling parse errors
bool	HasParseError () const
	Whether a parse error has occured 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...

Friends
template<typename , typename , typename >
class	GenericReader

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.

Member Typedef Documentation

◆ AllocatorType

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

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

Allocator type from template parameter.

◆ Ch

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

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

Character type derived from Encoding.

◆ ValueType

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

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

Value type of the document.

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

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.

◆ 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

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.

◆ ~GenericDocument()

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

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

inline

Member Function Documentation

◆ GetAllocator()

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

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

inline

Get the allocator of this document.

◆ GetErrorOffset()

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

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

inline

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

◆ GetParseError()

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

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

inline

Get the ParseErrorCode of last parsing.

◆ GetStackCapacity()

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

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

inline

Get the capacity of stack in bytes.

◆ HasParseError()

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

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

inline

Whether a parse error has occured in the last parsing.

◆ Parse() [1/3]

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

template<unsigned parseFlags, typename SourceEncoding >

GenericDocument& GenericDocument< Encoding, Allocator, StackAllocator >::Parse ( const 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.

◆ Parse() [2/3]

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

template<unsigned parseFlags>

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

◆ Parse() [3/3]

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

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

◆ ParseInsitu() [1/2]

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

template<unsigned parseFlags>

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

◆ ParseInsitu() [2/2]

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

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

◆ 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

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.

◆ 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

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.

◆ ParseStream() [3/3]

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

template<typename InputStream >

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

◆ Swap()

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

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

inline

Exchange the contents of this document with those of another.

Parameters

Friends And Related Function Documentation

◆ GenericReader

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

template<typename , typename , typename >

friend class GenericReader

friend

◆ GenericValue

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

template<typename , typename >

friend class GenericValue

friend

◆ swap

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

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

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

document.h

Public Types

Public Member Functions

Friends

Detailed Description

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

Member Typedef Documentation

◆ AllocatorType

◆ Ch

◆ ValueType

Constructor & Destructor Documentation

◆ GenericDocument() [1/2]

◆ GenericDocument() [2/2]

◆ ~GenericDocument()

Member Function Documentation

◆ GetAllocator()

◆ GetErrorOffset()

◆ GetParseError()

◆ GetStackCapacity()

◆ HasParseError()

◆ Parse() [1/3]

◆ Parse() [2/3]

◆ Parse() [3/3]

◆ ParseInsitu() [1/2]

◆ ParseInsitu() [2/2]

◆ ParseStream() [1/3]

◆ ParseStream() [2/3]

◆ ParseStream() [3/3]

◆ Swap()

Friends And Related Function Documentation

◆ GenericReader

◆ GenericValue

◆ swap

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