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

#include <document.h>

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

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)

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

	operator ParseResult () const
	Implicit conversion to get the last parse result. More...

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

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.

Definition at line 2028 of file document.h.

◆ Ch

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

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

Character type derived from Encoding.

Definition at line 2026 of file document.h.

◆ ValueType

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

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

Value type of the document.

Definition at line 2027 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

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

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

Definition at line 2050 of file document.h.

◆ ~GenericDocument()

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

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

inline

Definition at line 2072 of file document.h.

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

◆ Double()

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

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

inline

Definition at line 2339 of file document.h.

◆ EndArray()

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

bool GenericDocument< Encoding, Allocator, StackAllocator >::EndArray ( SizeType elementCount )

inline

Definition at line 2369 of file document.h.

◆ EndObject()

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

bool GenericDocument< Encoding, Allocator, StackAllocator >::EndObject ( SizeType memberCount )

inline

Definition at line 2361 of file document.h.

◆ GetAllocator()

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

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

inline

Get the allocator of this document.

Definition at line 2308 of file document.h.

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

Definition at line 2290 of file document.h.

◆ GetParseError()

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

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

inline

Get the ParseErrorCode of last parsing.

Definition at line 2287 of file document.h.

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

Definition at line 2314 of file document.h.

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

Definition at line 2284 of file document.h.

◆ Int()

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

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

inline

Definition at line 2335 of file document.h.

◆ Int64()

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

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

inline

Definition at line 2337 of file document.h.

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

◆ Null()

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

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

inline

Definition at line 2333 of file document.h.

◆ operator ParseResult()

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

GenericDocument< Encoding, Allocator, StackAllocator >::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 2304 of file document.h.

◆ 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

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

◆ Parse() [2/6]

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.

Definition at line 2239 of file document.h.

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

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

◆ 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

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

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

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

Definition at line 2198 of file document.h.

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

Definition at line 2207 of file document.h.

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

Definition at line 2155 of file document.h.

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

Definition at line 2174 of file document.h.

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

Definition at line 2184 of file document.h.

◆ Populate()

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

template<typename Generator >

GenericDocument& GenericDocument< Encoding, Allocator, StackAllocator >::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 2135 of file document.h.

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

◆ StartArray()

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

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

inline

Definition at line 2367 of file document.h.

◆ StartObject()

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

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

inline

Definition at line 2357 of file document.h.

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

◆ 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

rhs	Another document.

Note: Constant complexity.

See also: GenericValue::Swap

Definition at line 2106 of file document.h.

◆ Uint()

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

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

inline

Definition at line 2336 of file document.h.

◆ Uint64()

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

bool GenericDocument< Encoding, Allocator, StackAllocator >::Uint64 ( uint64_t i )

inline

Definition at line 2338 of file document.h.

Friends And Related Function Documentation

◆ GenericValue

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

template<typename , typename >

friend class GenericValue

friend

Definition at line 2329 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

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

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

/home/runner/work/cphot/cphot/include/rapidjson/document.h

cphot 0.1 A C++ tool for computing photometry from spectra.

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

◆ Bool()

◆ Double()

◆ EndArray()

◆ EndObject()

◆ GetAllocator()

◆ GetErrorOffset()

◆ GetParseError()

◆ GetStackCapacity()

◆ HasParseError()

◆ Int()

◆ Int64()

◆ Key()

◆ Null()

◆ operator ParseResult()

◆ Parse() [1/6]

◆ Parse() [2/6]

◆ Parse() [3/6]

◆ Parse() [4/6]

◆ Parse() [5/6]

◆ Parse() [6/6]

◆ ParseInsitu() [1/2]

◆ ParseInsitu() [2/2]

◆ ParseStream() [1/3]

◆ ParseStream() [2/3]

◆ ParseStream() [3/3]

◆ Populate()

◆ RawNumber()

◆ StartArray()

◆ StartObject()

◆ String()

◆ Swap()

◆ Uint()

◆ Uint64()

Friends And Related Function Documentation

◆ GenericValue

◆ swap

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