pointer.h File Reference

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

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

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

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

typedef GenericPointer<Value> Pointer

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

Definition at line 1052 of file pointer.h.

Function Documentation

template<typename T >

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

Definition at line 1060 of file pointer.h.

                                                                                                                                   {
    return pointer.Create(root, a);
}

template<typename T , typename CharType , size_t N>

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

Definition at line 1065 of file pointer.h.

                                                                                                           {
    return GenericPointer<typename T::ValueType>(source, N - 1).Create(root, a);
}

template<typename DocumentType >

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

Definition at line 1072 of file pointer.h.

                                                                                                                                            {
    return pointer.Create(document);
}

template<typename DocumentType , typename CharType , size_t N>

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

Definition at line 1077 of file pointer.h.

                                                                                                         {
    return GenericPointer<typename DocumentType::ValueType>(source, N - 1).Create(document);
}

template<typename T >

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

Definition at line 1340 of file pointer.h.

                                                                                      {
    return pointer.Erase(root);
}

template<typename T , typename CharType , size_t N>

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

Definition at line 1345 of file pointer.h.

                                                              {
    return GenericPointer<typename T::ValueType>(source, N - 1).Erase(root);
}

template<typename T >

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

Definition at line 1084 of file pointer.h.

                                                                                                                                      {
    return pointer.Get(root, unresolvedTokenIndex);
}

template<typename T >

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

Definition at line 1089 of file pointer.h.

                                                                                                                                                  {
    return pointer.Get(root, unresolvedTokenIndex);
}

template<typename T , typename CharType , size_t N>

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

Definition at line 1094 of file pointer.h.

                                                                                                               {
    return GenericPointer<typename T::ValueType>(source, N - 1).Get(root, unresolvedTokenIndex);
}

template<typename T , typename CharType , size_t N>

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

Definition at line 1099 of file pointer.h.

                                                                                                                          {
    return GenericPointer<typename T::ValueType>(source, N - 1).Get(root, unresolvedTokenIndex);
}

template<typename T >

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

Definition at line 1106 of file pointer.h.

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

template<typename T >

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

Definition at line 1111 of file pointer.h.

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

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
	)

Definition at line 1129 of file pointer.h.

                                                                                                                                                            {
    return GenericPointer<typename T::ValueType>(source, N - 1).GetWithDefault(root, defaultValue, 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
	)

Definition at line 1134 of file pointer.h.

                                                                                                                                                     {
    return GenericPointer<typename T::ValueType>(source, N - 1).GetWithDefault(root, defaultValue, a);
}

template<typename DocumentType >

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

Definition at line 1154 of file pointer.h.

                                                                                                                                                                                                        {
    return pointer.GetWithDefault(document, defaultValue);
}

template<typename DocumentType >

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

Definition at line 1159 of file pointer.h.

                                                                                                                                                                                                 {
    return pointer.GetWithDefault(document, defaultValue);
}

template<typename DocumentType , typename CharType , size_t N>

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

Definition at line 1177 of file pointer.h.

                                                                                                                                                                     {
    return GenericPointer<typename DocumentType::ValueType>(source, N - 1).GetWithDefault(document, defaultValue);
}

template<typename DocumentType , typename CharType , size_t N>

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

Definition at line 1182 of file pointer.h.

                                                                                                                                                              {
    return GenericPointer<typename DocumentType::ValueType>(source, N - 1).GetWithDefault(document, defaultValue);
}

template<typename T , typename T2 >

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

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

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

template<typename DocumentType , typename T2 >

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

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

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

template<typename T >

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

Definition at line 1202 of file pointer.h.

                                                                                                                                                            {
    return pointer.Set(root, value, a);
}

template<typename T >

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

Definition at line 1207 of file pointer.h.

                                                                                                                                                                  {
    return pointer.Set(root, value, a);
}

template<typename T >

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

Definition at line 1212 of file pointer.h.

                                                                                                                                                           {
    return pointer.Set(root, value, 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
	)

Definition at line 1230 of file pointer.h.

                                                                                                                                    {
    return GenericPointer<typename T::ValueType>(source, N - 1).Set(root, value, 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
	)

Definition at line 1235 of file pointer.h.

                                                                                                                                          {
    return GenericPointer<typename T::ValueType>(source, N - 1).Set(root, value, 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
	)

Definition at line 1240 of file pointer.h.

                                                                                                                                   {
    return GenericPointer<typename T::ValueType>(source, N - 1).Set(root, value, a);
}

template<typename DocumentType >

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

Definition at line 1260 of file pointer.h.

                                                                                                                                                                                {
    return pointer.Set(document, value);
}

template<typename DocumentType >

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

Definition at line 1265 of file pointer.h.

                                                                                                                                                                                      {
    return pointer.Set(document, value);
}

template<typename DocumentType >

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

Definition at line 1270 of file pointer.h.

                                                                                                                                                                               {
    return pointer.Set(document, value);
}

template<typename DocumentType , typename CharType , size_t N>

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

Definition at line 1288 of file pointer.h.

                                                                                                                                             {
    return GenericPointer<typename DocumentType::ValueType>(source, N - 1).Set(document, value);
}

template<typename DocumentType , typename CharType , size_t N>

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

Definition at line 1293 of file pointer.h.

                                                                                                                                                   {
    return GenericPointer<typename DocumentType::ValueType>(source, N - 1).Set(document, value);
}

template<typename DocumentType , typename CharType , size_t N>

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

Definition at line 1298 of file pointer.h.

                                                                                                                                            {
    return GenericPointer<typename DocumentType::ValueType>(source, N - 1).Set(document, value);
}

template<typename T >

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

Definition at line 1318 of file pointer.h.

                                                                                                                                                             {
    return pointer.Swap(root, value, 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
	)

Definition at line 1323 of file pointer.h.

                                                                                                                                     {
    return GenericPointer<typename T::ValueType>(source, N - 1).Swap(root, value, a);
}

template<typename DocumentType >

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

Definition at line 1328 of file pointer.h.

                                                                                                                                                                                 {
    return pointer.Swap(document, value);
}

template<typename DocumentType , typename CharType , size_t N>

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

Definition at line 1333 of file pointer.h.

                                                                                                                                              {
    return GenericPointer<typename DocumentType::ValueType>(source, N - 1).Swap(document, value);
}

Variable Documentation

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

Initial value:

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

Definition at line 1124 of file pointer.h.

const GenericPointer< typename DocumentType::ValueType > T2 defaultValue

Initial value:

{
    return pointer.GetWithDefault(document, defaultValue)

Definition at line 1124 of file pointer.h.

RAPIDJSON_NAMESPACE_BEGIN const SizeType kPointerInvalidIndex = ~SizeType(0)

static

Represents an invalid index in GenericPointer::Token.

Definition at line 31 of file pointer.h.

const GenericPointer< typename DocumentType::ValueType > & pointer

Definition at line 1124 of file pointer.h.

const CharType(& source

Definition at line 1147 of file pointer.h.

const GenericPointer< typename DocumentType::ValueType > T2 value

Initial value:

{
    return pointer.Set(document, value)

Definition at line 1225 of file pointer.h.