pointer.h File Reference

#include "document.h"
#include "internal/itoa.h"

Include dependency graph for pointer.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	GenericPointer< ValueType, Allocator >
	Represents a JSON Pointer. Use Pointer for UTF8 encoding and default allocator. More...
struct	GenericPointer< ValueType, Allocator >::Token
	A token is the basic units of internal representation. More...
class	GenericPointer< ValueType, Allocator >::PercentDecodeStream
	A helper stream for decoding a percent-encoded sequence into code unit. More...
class	GenericPointer< ValueType, Allocator >::PercentEncodeStream< OutputStream >
	A helper stream to encode character (UTF-8 code unit) into percent-encoded sequence. More...

Typedefs
typedef GenericPointer< Value >	Pointer
	GenericPointer for Value (UTF-8, default allocator).

Enumerations
enum	PointerParseErrorCode {   kPointerParseErrorNone = 0 , kPointerParseErrorTokenMustBeginWithSolidus , kPointerParseErrorInvalidEscape , kPointerParseErrorInvalidPercentEncoding ,   kPointerParseErrorCharacterMustPercentEncode }
	Error code of parsing. More...

Variables
static RAPIDJSON_NAMESPACE_BEGIN const SizeType	kPointerInvalidIndex = ~SizeType(0)
	Represents an invalid index in GenericPointer::Token.

Helper functions for GenericPointer
const GenericPointer< typename T::ValueType > &	pointer
const GenericPointer< typename T::ValueType > T2	defaultValue
const GenericPointer< typename T::ValueType > T2 T::AllocatorType &	a
const CharType(&	source )[N]
const GenericPointer< typename T::ValueType > T2	value
template<typename T>
T::ValueType &	CreateValueByPointer (T &root, const GenericPointer< typename T::ValueType > &pointer, typename T::AllocatorType &a)
template<typename T, typename CharType, size_t N>
T::ValueType &	CreateValueByPointer (T &root, const CharType(&source)[N], typename T::AllocatorType &a)
template<typename DocumentType>
DocumentType::ValueType &	CreateValueByPointer (DocumentType &document, const GenericPointer< typename DocumentType::ValueType > &pointer)
template<typename DocumentType, typename CharType, size_t N>
DocumentType::ValueType &	CreateValueByPointer (DocumentType &document, const CharType(&source)[N])
template<typename T>
T::ValueType *	GetValueByPointer (T &root, const GenericPointer< typename T::ValueType > &pointer, size_t *unresolvedTokenIndex=0)
template<typename T>
const T::ValueType *	GetValueByPointer (const T &root, const GenericPointer< typename T::ValueType > &pointer, size_t *unresolvedTokenIndex=0)
template<typename T, typename CharType, size_t N>
T::ValueType *	GetValueByPointer (T &root, const CharType(&source)[N], size_t *unresolvedTokenIndex=0)
template<typename T, typename CharType, size_t N>
const T::ValueType *	GetValueByPointer (const T &root, const CharType(&source)[N], size_t *unresolvedTokenIndex=0)
template<typename T>
T::ValueType &	GetValueByPointerWithDefault (T &root, const GenericPointer< typename T::ValueType > &pointer, const typename T::ValueType &defaultValue, typename T::AllocatorType &a)
template<typename T>
T::ValueType &	GetValueByPointerWithDefault (T &root, const GenericPointer< typename T::ValueType > &pointer, const typename T::Ch *defaultValue, typename T::AllocatorType &a)
template<typename T, typename T2>
	RAPIDJSON_DISABLEIF_RETURN ((internal::OrExpr< internal::IsPointer< T2 >, internal::IsGenericValue< T2 > >),(typename T::ValueType &)) GetValueByPointerWithDefault(T &root
template<typename T, typename CharType, size_t N>
T::ValueType &	GetValueByPointerWithDefault (T &root, const CharType(&source)[N], const typename T::ValueType &defaultValue, typename T::AllocatorType &a)
template<typename T, typename CharType, size_t N>
T::ValueType &	GetValueByPointerWithDefault (T &root, const CharType(&source)[N], const typename T::Ch *defaultValue, typename T::AllocatorType &a)
template<typename T, typename CharType, size_t N, typename T2>
	RAPIDJSON_DISABLEIF_RETURN ((internal::OrExpr< internal::IsPointer< T2 >, internal::IsGenericValue< T2 > >),(typename T::ValueType &)) GetValueByPointerWithDefault(T &root
template<typename DocumentType>
DocumentType::ValueType &	GetValueByPointerWithDefault (DocumentType &document, const GenericPointer< typename DocumentType::ValueType > &pointer, const typename DocumentType::ValueType &defaultValue)
template<typename DocumentType>
DocumentType::ValueType &	GetValueByPointerWithDefault (DocumentType &document, const GenericPointer< typename DocumentType::ValueType > &pointer, const typename DocumentType::Ch *defaultValue)
template<typename DocumentType, typename T2>
	RAPIDJSON_DISABLEIF_RETURN ((internal::OrExpr< internal::IsPointer< T2 >, internal::IsGenericValue< T2 > >),(typename DocumentType::ValueType &)) GetValueByPointerWithDefault(DocumentType &document
template<typename DocumentType, typename CharType, size_t N>
DocumentType::ValueType &	GetValueByPointerWithDefault (DocumentType &document, const CharType(&source)[N], const typename DocumentType::ValueType &defaultValue)
template<typename DocumentType, typename CharType, size_t N>
DocumentType::ValueType &	GetValueByPointerWithDefault (DocumentType &document, const CharType(&source)[N], const typename DocumentType::Ch *defaultValue)
template<typename DocumentType, typename CharType, size_t N, typename T2>
	RAPIDJSON_DISABLEIF_RETURN ((internal::OrExpr< internal::IsPointer< T2 >, internal::IsGenericValue< T2 > >),(typename DocumentType::ValueType &)) GetValueByPointerWithDefault(DocumentType &document
template<typename T>
T::ValueType &	SetValueByPointer (T &root, const GenericPointer< typename T::ValueType > &pointer, typename T::ValueType &value, typename T::AllocatorType &a)
template<typename T>
T::ValueType &	SetValueByPointer (T &root, const GenericPointer< typename T::ValueType > &pointer, const typename T::ValueType &value, typename T::AllocatorType &a)
template<typename T>
T::ValueType &	SetValueByPointer (T &root, const GenericPointer< typename T::ValueType > &pointer, const typename T::Ch *value, typename T::AllocatorType &a)
template<typename T, typename CharType, size_t N>
T::ValueType &	SetValueByPointer (T &root, const CharType(&source)[N], typename T::ValueType &value, typename T::AllocatorType &a)
template<typename T, typename CharType, size_t N>
T::ValueType &	SetValueByPointer (T &root, const CharType(&source)[N], const typename T::ValueType &value, typename T::AllocatorType &a)
template<typename T, typename CharType, size_t N>
T::ValueType &	SetValueByPointer (T &root, const CharType(&source)[N], const typename T::Ch *value, typename T::AllocatorType &a)
template<typename DocumentType>
DocumentType::ValueType &	SetValueByPointer (DocumentType &document, const GenericPointer< typename DocumentType::ValueType > &pointer, typename DocumentType::ValueType &value)
template<typename DocumentType>
DocumentType::ValueType &	SetValueByPointer (DocumentType &document, const GenericPointer< typename DocumentType::ValueType > &pointer, const typename DocumentType::ValueType &value)
template<typename DocumentType>
DocumentType::ValueType &	SetValueByPointer (DocumentType &document, const GenericPointer< typename DocumentType::ValueType > &pointer, const typename DocumentType::Ch *value)
template<typename DocumentType, typename CharType, size_t N>
DocumentType::ValueType &	SetValueByPointer (DocumentType &document, const CharType(&source)[N], typename DocumentType::ValueType &value)
template<typename DocumentType, typename CharType, size_t N>
DocumentType::ValueType &	SetValueByPointer (DocumentType &document, const CharType(&source)[N], const typename DocumentType::ValueType &value)
template<typename DocumentType, typename CharType, size_t N>
DocumentType::ValueType &	SetValueByPointer (DocumentType &document, const CharType(&source)[N], const typename DocumentType::Ch *value)
template<typename T>
T::ValueType &	SwapValueByPointer (T &root, const GenericPointer< typename T::ValueType > &pointer, typename T::ValueType &value, typename T::AllocatorType &a)
template<typename T, typename CharType, size_t N>
T::ValueType &	SwapValueByPointer (T &root, const CharType(&source)[N], typename T::ValueType &value, typename T::AllocatorType &a)
template<typename DocumentType>
DocumentType::ValueType &	SwapValueByPointer (DocumentType &document, const GenericPointer< typename DocumentType::ValueType > &pointer, typename DocumentType::ValueType &value)
template<typename DocumentType, typename CharType, size_t N>
DocumentType::ValueType &	SwapValueByPointer (DocumentType &document, const CharType(&source)[N], typename DocumentType::ValueType &value)
template<typename T>
bool	EraseValueByPointer (T &root, const GenericPointer< typename T::ValueType > &pointer)
template<typename T, typename CharType, size_t N>
bool	EraseValueByPointer (T &root, const CharType(&source)[N])

Typedef Documentation

Pointer

typedef GenericPointer<Value> Pointer

GenericPointer for Value (UTF-8, default allocator).

Function Documentation

CreateValueByPointer() [1/4]

template<typename DocumentType, typename CharType, size_t N>

DocumentType::ValueType & CreateValueByPointer	(	DocumentType &	document,
		const CharType(&)	source[N] )

CreateValueByPointer() [2/4]

template<typename DocumentType>

DocumentType::ValueType & CreateValueByPointer	(	DocumentType &	document,
		const GenericPointer< typename DocumentType::ValueType > &	pointer )

CreateValueByPointer() [3/4]

template<typename T, typename CharType, size_t N>

T::ValueType & CreateValueByPointer	(	T &	root,
		const CharType(&)	source[N],
		typename T::AllocatorType &	a )

CreateValueByPointer() [4/4]

template<typename T>

T::ValueType & CreateValueByPointer	(	T &	root,
		const GenericPointer< typename T::ValueType > &	pointer,
		typename T::AllocatorType &	a )

EraseValueByPointer() [1/2]

template<typename T, typename CharType, size_t N>

bool EraseValueByPointer	(	T &	root,
		const CharType(&)	source[N] )

EraseValueByPointer() [2/2]

template<typename T>

bool EraseValueByPointer	(	T &	root,
		const GenericPointer< typename T::ValueType > &	pointer )

GetValueByPointer() [1/4]

template<typename T, typename CharType, size_t N>

const T::ValueType * GetValueByPointer	(	const T &	root,
		const CharType(&)	source[N],
		size_t *	unresolvedTokenIndex = 0 )

GetValueByPointer() [2/4]

template<typename T>

const T::ValueType * GetValueByPointer	(	const T &	root,
		const GenericPointer< typename T::ValueType > &	pointer,
		size_t *	unresolvedTokenIndex = 0 )

GetValueByPointer() [3/4]

template<typename T, typename CharType, size_t N>

T::ValueType * GetValueByPointer	(	T &	root,
		const CharType(&)	source[N],
		size_t *	unresolvedTokenIndex = 0 )

GetValueByPointer() [4/4]

template<typename T>

T::ValueType * GetValueByPointer	(	T &	root,
		const GenericPointer< typename T::ValueType > &	pointer,
		size_t *	unresolvedTokenIndex = 0 )

GetValueByPointerWithDefault() [1/8]

template<typename DocumentType, typename CharType, size_t N>

DocumentType::ValueType & GetValueByPointerWithDefault	(	DocumentType &	document,
		const CharType(&)	source[N],
		const typename DocumentType::Ch *	defaultValue )

GetValueByPointerWithDefault() [2/8]

template<typename DocumentType, typename CharType, size_t N>

DocumentType::ValueType & GetValueByPointerWithDefault	(	DocumentType &	document,
		const CharType(&)	source[N],
		const typename DocumentType::ValueType &	defaultValue )

GetValueByPointerWithDefault() [3/8]

template<typename DocumentType>

DocumentType::ValueType & GetValueByPointerWithDefault	(	DocumentType &	document,
		const GenericPointer< typename DocumentType::ValueType > &	pointer,
		const typename DocumentType::Ch *	defaultValue )

GetValueByPointerWithDefault() [4/8]

template<typename DocumentType>

DocumentType::ValueType & GetValueByPointerWithDefault	(	DocumentType &	document,
		const GenericPointer< typename DocumentType::ValueType > &	pointer,
		const typename DocumentType::ValueType &	defaultValue )

GetValueByPointerWithDefault() [5/8]

template<typename T, typename CharType, size_t N>

T::ValueType & GetValueByPointerWithDefault	(	T &	root,
		const CharType(&)	source[N],
		const typename T::Ch *	defaultValue,
		typename T::AllocatorType &	a )

GetValueByPointerWithDefault() [6/8]

template<typename T, typename CharType, size_t N>

T::ValueType & GetValueByPointerWithDefault	(	T &	root,
		const CharType(&)	source[N],
		const typename T::ValueType &	defaultValue,
		typename T::AllocatorType &	a )

GetValueByPointerWithDefault() [7/8]

template<typename T>

T::ValueType & GetValueByPointerWithDefault	(	T &	root,
		const GenericPointer< typename T::ValueType > &	pointer,
		const typename T::Ch *	defaultValue,
		typename T::AllocatorType &	a )

GetValueByPointerWithDefault() [8/8]

template<typename T>

T::ValueType & GetValueByPointerWithDefault	(	T &	root,
		const GenericPointer< typename T::ValueType > &	pointer,
		const typename T::ValueType &	defaultValue,
		typename T::AllocatorType &	a )

RAPIDJSON_DISABLEIF_RETURN() [1/4]

template<typename DocumentType, typename CharType, size_t N, typename T2>

RAPIDJSON_DISABLEIF_RETURN	(	(internal::OrExpr< internal::IsPointer< T2 >, internal::IsGenericValue< T2 > >)	,
		(typename DocumentType::ValueType &)	) &

RAPIDJSON_DISABLEIF_RETURN() [2/4]

template<typename DocumentType, typename T2>

RAPIDJSON_DISABLEIF_RETURN	(	(internal::OrExpr< internal::IsPointer< T2 >, internal::IsGenericValue< T2 > >)	,
		(typename DocumentType::ValueType &)	) &

RAPIDJSON_DISABLEIF_RETURN() [3/4]

template<typename T, typename CharType, size_t N, typename T2>

RAPIDJSON_DISABLEIF_RETURN	(	(internal::OrExpr< internal::IsPointer< T2 >, internal::IsGenericValue< T2 > >)	,
		(typename T::ValueType &)	) &

RAPIDJSON_DISABLEIF_RETURN() [4/4]

template<typename T, typename T2>

RAPIDJSON_DISABLEIF_RETURN	(	(internal::OrExpr< internal::IsPointer< T2 >, internal::IsGenericValue< T2 > >)	,
		(typename T::ValueType &)	) &

SetValueByPointer() [1/12]

template<typename DocumentType, typename CharType, size_t N>

DocumentType::ValueType & SetValueByPointer	(	DocumentType &	document,
		const CharType(&)	source[N],
		const typename DocumentType::Ch *	value )

SetValueByPointer() [2/12]

template<typename DocumentType, typename CharType, size_t N>

DocumentType::ValueType & SetValueByPointer	(	DocumentType &	document,
		const CharType(&)	source[N],
		const typename DocumentType::ValueType &	value )

SetValueByPointer() [3/12]

template<typename DocumentType, typename CharType, size_t N>

DocumentType::ValueType & SetValueByPointer	(	DocumentType &	document,
		const CharType(&)	source[N],
		typename DocumentType::ValueType &	value )

SetValueByPointer() [4/12]

template<typename DocumentType>

DocumentType::ValueType & SetValueByPointer	(	DocumentType &	document,
		const GenericPointer< typename DocumentType::ValueType > &	pointer,
		const typename DocumentType::Ch *	value )

SetValueByPointer() [5/12]

template<typename DocumentType>

DocumentType::ValueType & SetValueByPointer	(	DocumentType &	document,
		const GenericPointer< typename DocumentType::ValueType > &	pointer,
		const typename DocumentType::ValueType &	value )

SetValueByPointer() [6/12]

template<typename DocumentType>

DocumentType::ValueType & SetValueByPointer	(	DocumentType &	document,
		const GenericPointer< typename DocumentType::ValueType > &	pointer,
		typename DocumentType::ValueType &	value )

SetValueByPointer() [7/12]

template<typename T, typename CharType, size_t N>

T::ValueType & SetValueByPointer	(	T &	root,
		const CharType(&)	source[N],
		const typename T::Ch *	value,
		typename T::AllocatorType &	a )

SetValueByPointer() [8/12]

template<typename T, typename CharType, size_t N>

T::ValueType & SetValueByPointer	(	T &	root,
		const CharType(&)	source[N],
		const typename T::ValueType &	value,
		typename T::AllocatorType &	a )

SetValueByPointer() [9/12]

template<typename T, typename CharType, size_t N>

T::ValueType & SetValueByPointer	(	T &	root,
		const CharType(&)	source[N],
		typename T::ValueType &	value,
		typename T::AllocatorType &	a )

SetValueByPointer() [10/12]

template<typename T>

T::ValueType & SetValueByPointer	(	T &	root,
		const GenericPointer< typename T::ValueType > &	pointer,
		const typename T::Ch *	value,
		typename T::AllocatorType &	a )

SetValueByPointer() [11/12]

template<typename T>

T::ValueType & SetValueByPointer	(	T &	root,
		const GenericPointer< typename T::ValueType > &	pointer,
		const typename T::ValueType &	value,
		typename T::AllocatorType &	a )

SetValueByPointer() [12/12]

template<typename T>

T::ValueType & SetValueByPointer	(	T &	root,
		const GenericPointer< typename T::ValueType > &	pointer,
		typename T::ValueType &	value,
		typename T::AllocatorType &	a )

SwapValueByPointer() [1/4]

template<typename DocumentType, typename CharType, size_t N>

DocumentType::ValueType & SwapValueByPointer	(	DocumentType &	document,
		const CharType(&)	source[N],
		typename DocumentType::ValueType &	value )

SwapValueByPointer() [2/4]

template<typename DocumentType>

DocumentType::ValueType & SwapValueByPointer	(	DocumentType &	document,
		const GenericPointer< typename DocumentType::ValueType > &	pointer,
		typename DocumentType::ValueType &	value )

SwapValueByPointer() [3/4]

template<typename T, typename CharType, size_t N>

T::ValueType & SwapValueByPointer	(	T &	root,
		const CharType(&)	source[N],
		typename T::ValueType &	value,
		typename T::AllocatorType &	a )

SwapValueByPointer() [4/4]

template<typename T>

T::ValueType & SwapValueByPointer	(	T &	root,
		const GenericPointer< typename T::ValueType > &	pointer,
		typename T::ValueType &	value,
		typename T::AllocatorType &	a )

Variable Documentation

a

const GenericPointer< typename T::ValueType > T2 T::AllocatorType & a

Initial value:

{
    return pointer.GetWithDefault(root, defaultValue, a)

defaultValue

const GenericPointer< typename DocumentType::ValueType > T2 defaultValue

Initial value:

{
    return pointer.GetWithDefault(document, defaultValue)

kPointerInvalidIndex

RAPIDJSON_NAMESPACE_BEGIN const SizeType kPointerInvalidIndex = ~SizeType(0)

static

Represents an invalid index in GenericPointer::Token.

pointer

const GenericPointer< typename DocumentType::ValueType > & pointer

source

const CharType(& source

value

const GenericPointer< typename DocumentType::ValueType > T2 value

Initial value:

{
    return pointer.Set(document, value)