Represents a JSON Pointer. Use Pointer for UTF8 encoding and default allocator. More...
#include <pointer.h>
Classes | |
struct | Token |
A token is the basic units of internal representation. More... | |
Public Types | |
typedef ValueType::EncodingType | EncodingType |
Encoding type from Value. | |
typedef ValueType::Ch | Ch |
Character type from Value. | |
Public Member Functions | |
Append token | |
GenericPointer | Append (const Token &token, Allocator *allocator=0) const |
Append a token and return a new Pointer. More... | |
GenericPointer | Append (const Ch *name, SizeType length, Allocator *allocator=0) const |
Append a name token with length, and return a new Pointer. More... | |
template<typename T > | |
GenericPointer | Append (T *name, Allocator *allocator=0) const |
Append a name token without length, and return a new Pointer. More... | |
GenericPointer | Append (const std::basic_string< Ch > &name, Allocator *allocator=0) const |
Append a name token, and return a new Pointer. More... | |
GenericPointer | Append (SizeType index, Allocator *allocator=0) const |
Append a index token, and return a new Pointer. More... | |
GenericPointer | Append (const ValueType &token, Allocator *allocator=0) const |
Append a token by value, and return a new Pointer. More... | |
Handling Parse Error | |
bool | IsValid () const |
Check whether this is a valid pointer. | |
size_t | GetParseErrorOffset () const |
Get the parsing error offset in code unit. | |
PointerParseErrorCode | GetParseErrorCode () const |
Get the parsing error code. | |
Allocator & | GetAllocator () |
Get the allocator of this pointer. | |
Tokens | |
const Token * | GetTokens () const |
Get the token array (const version only). | |
size_t | GetTokenCount () const |
Get the number of tokens. | |
Equality/inequality operators | |
bool | operator== (const GenericPointer &rhs) const |
Equality operator. More... | |
bool | operator!= (const GenericPointer &rhs) const |
Inequality operator. More... | |
bool | operator< (const GenericPointer &rhs) const |
Less than operator. More... | |
Stringify | |
template<typename OutputStream > | |
bool | Stringify (OutputStream &os) const |
Stringify the pointer into string representation. More... | |
template<typename OutputStream > | |
bool | StringifyUriFragment (OutputStream &os) const |
Stringify the pointer into URI fragment representation. More... | |
Create value | |
ValueType & | Create (ValueType &root, typename ValueType::AllocatorType &allocator, bool *alreadyExist=0) const |
Create a value in a subtree. More... | |
template<typename stackAllocator > | |
ValueType & | Create (GenericDocument< EncodingType, typename ValueType::AllocatorType, stackAllocator > &document, bool *alreadyExist=0) const |
Creates a value in a document. More... | |
Query value | |
ValueType * | Get (ValueType &root, size_t *unresolvedTokenIndex=0) const |
Query a value in a subtree. More... | |
const ValueType * | Get (const ValueType &root, size_t *unresolvedTokenIndex=0) const |
Query a const value in a const subtree. More... | |
Query a value with default | |
ValueType & | GetWithDefault (ValueType &root, const ValueType &defaultValue, typename ValueType::AllocatorType &allocator) const |
Query a value in a subtree with default value. More... | |
ValueType & | GetWithDefault (ValueType &root, const Ch *defaultValue, typename ValueType::AllocatorType &allocator) const |
Query a value in a subtree with default null-terminated string. | |
ValueType & | GetWithDefault (ValueType &root, const std::basic_string< Ch > &defaultValue, typename ValueType::AllocatorType &allocator) const |
Query a value in a subtree with default std::basic_string. | |
template<typename T > | |
ValueType & | GetWithDefault (ValueType &root, T defaultValue, typename ValueType::AllocatorType &allocator) const |
Query a value in a subtree with default primitive value. More... | |
template<typename stackAllocator > | |
ValueType & | GetWithDefault (GenericDocument< EncodingType, typename ValueType::AllocatorType, stackAllocator > &document, const ValueType &defaultValue) const |
Query a value in a document with default value. | |
template<typename stackAllocator > | |
ValueType & | GetWithDefault (GenericDocument< EncodingType, typename ValueType::AllocatorType, stackAllocator > &document, const Ch *defaultValue) const |
Query a value in a document with default null-terminated string. | |
template<typename stackAllocator > | |
ValueType & | GetWithDefault (GenericDocument< EncodingType, typename ValueType::AllocatorType, stackAllocator > &document, const std::basic_string< Ch > &defaultValue) const |
Query a value in a document with default std::basic_string. | |
template<typename T , typename stackAllocator > | |
ValueType & | GetWithDefault (GenericDocument< EncodingType, typename ValueType::AllocatorType, stackAllocator > &document, T defaultValue) const |
Query a value in a document with default primitive value. More... | |
Set a value | |
ValueType & | Set (ValueType &root, ValueType &value, typename ValueType::AllocatorType &allocator) const |
Set a value in a subtree, with move semantics. More... | |
ValueType & | Set (ValueType &root, const ValueType &value, typename ValueType::AllocatorType &allocator) const |
Set a value in a subtree, with copy semantics. | |
ValueType & | Set (ValueType &root, const Ch *value, typename ValueType::AllocatorType &allocator) const |
Set a null-terminated string in a subtree. | |
ValueType & | Set (ValueType &root, const std::basic_string< Ch > &value, typename ValueType::AllocatorType &allocator) const |
Set a std::basic_string in a subtree. | |
template<typename T > | |
ValueType & | Set (ValueType &root, T value, typename ValueType::AllocatorType &allocator) const |
Set a primitive value in a subtree. More... | |
template<typename stackAllocator > | |
ValueType & | Set (GenericDocument< EncodingType, typename ValueType::AllocatorType, stackAllocator > &document, ValueType &value) const |
Set a value in a document, with move semantics. | |
template<typename stackAllocator > | |
ValueType & | Set (GenericDocument< EncodingType, typename ValueType::AllocatorType, stackAllocator > &document, const ValueType &value) const |
Set a value in a document, with copy semantics. | |
template<typename stackAllocator > | |
ValueType & | Set (GenericDocument< EncodingType, typename ValueType::AllocatorType, stackAllocator > &document, const Ch *value) const |
Set a null-terminated string in a document. | |
template<typename stackAllocator > | |
ValueType & | Set (GenericDocument< EncodingType, typename ValueType::AllocatorType, stackAllocator > &document, const std::basic_string< Ch > &value) const |
Sets a std::basic_string in a document. | |
template<typename T , typename stackAllocator > | |
ValueType & | Set (GenericDocument< EncodingType, typename ValueType::AllocatorType, stackAllocator > &document, T value) const |
Set a primitive value in a document. More... | |
Constructors and destructor. | |
GenericPointer (Allocator *allocator=0) | |
Default constructor. | |
GenericPointer (const Ch *source, Allocator *allocator=0) | |
Constructor that parses a string or URI fragment representation. More... | |
GenericPointer (const std::basic_string< Ch > &source, Allocator *allocator=0) | |
Constructor that parses a string or URI fragment representation. More... | |
GenericPointer (const Ch *source, size_t length, Allocator *allocator=0) | |
Constructor that parses a string or URI fragment representation, with length of the source string. More... | |
GenericPointer (const Token *tokens, size_t tokenCount) | |
Constructor with user-supplied tokens. More... | |
GenericPointer (const GenericPointer &rhs) | |
Copy constructor. | |
GenericPointer (const GenericPointer &rhs, Allocator *allocator) | |
Copy constructor. | |
~GenericPointer () | |
Destructor. | |
GenericPointer & | operator= (const GenericPointer &rhs) |
Assignment operator. | |
GenericPointer & | Swap (GenericPointer &other) RAPIDJSON_NOEXCEPT |
Swap the content of this pointer with an other. More... | |
void | swap (GenericPointer &a, GenericPointer &b) RAPIDJSON_NOEXCEPT |
free-standing swap function helper More... | |
Swap a value | |
ValueType & | Swap (ValueType &root, ValueType &value, typename ValueType::AllocatorType &allocator) const |
Swap a value with a value in a subtree. More... | |
template<typename stackAllocator > | |
ValueType & | Swap (GenericDocument< EncodingType, typename ValueType::AllocatorType, stackAllocator > &document, ValueType &value) const |
Swap a value with a value in a document. | |
bool | Erase (ValueType &root) const |
Erase a value in a subtree. More... | |
Represents a JSON Pointer. Use Pointer for UTF8 encoding and default allocator.
This class implements RFC 6901 "JavaScript Object Notation (JSON) Pointer" (https://tools.ietf.org/html/rfc6901).
A JSON pointer is for identifying a specific value in a JSON document (GenericDocument). It can simplify coding of DOM tree manipulation, because it can access multiple-level depth of DOM tree with single API call.
After it parses a string representation (e.g. "/foo/0" or URI fragment representation (e.g. "#/foo/0") into its internal representation (tokens), it can be used to resolve a specific value in multiple documents, or sub-tree of documents.
Contrary to GenericValue, Pointer can be copy constructed and copy assigned. Apart from assignment, a Pointer cannot be modified after construction.
Although Pointer is very convenient, please aware that constructing Pointer involves parsing and dynamic memory allocation. A special constructor with user- supplied tokens eliminates these.
GenericPointer depends on GenericDocument and GenericValue.
ValueType | The value type of the DOM tree. E.g. GenericValue<UTF8<> > |
Allocator | The allocator type for allocating memory for internal representation. |
|
inlineexplicit |
Constructor that parses a string or URI fragment representation.
source | A null-terminated, string or URI fragment representation of JSON pointer. |
allocator | User supplied allocator for this pointer. If no allocator is provided, it creates a self-owned one. |
|
inlineexplicit |
Constructor that parses a string or URI fragment representation.
source | A string or URI fragment representation of JSON pointer. |
allocator | User supplied allocator for this pointer. If no allocator is provided, it creates a self-owned one. |
|
inline |
Constructor that parses a string or URI fragment representation, with length of the source string.
source | A string or URI fragment representation of JSON pointer. |
length | Length of source. |
allocator | User supplied allocator for this pointer. If no allocator is provided, it creates a self-owned one. |
|
inline |
Constructor with user-supplied tokens.
This constructor let user supplies const array of tokens. This prevents the parsing process and eliminates allocation. This is preferred for memory constrained environments.
tokens | An constant array of tokens representing the JSON pointer. |
tokenCount | Number of tokens. |
Example
|
inline |
Append a name token with length, and return a new Pointer.
name | Name to be appended. |
length | Length of name. |
allocator | Allocator for the newly return Pointer. |
|
inline |
Append a name token, and return a new Pointer.
name | Name to be appended. |
allocator | Allocator for the newly return Pointer. |
|
inline |
|
inline |
Append a token by value, and return a new Pointer.
token | token to be appended. |
allocator | Allocator for the newly return Pointer. |
|
inline |
Append a index token, and return a new Pointer.
index | Index to be appended. |
allocator | Allocator for the newly return Pointer. |
|
inline |
Append a name token without length, and return a new Pointer.
name | Name (const Ch*) to be appended. |
allocator | Allocator for the newly return Pointer. |
|
inline |
Creates a value in a document.
document | A document to be resolved. |
alreadyExist | If non-null, it stores whether the resolved value is already exist. |
|
inline |
Create a value in a subtree.
If the value is not exist, it creates all parent values and a JSON Null value. So it always succeed and return the newly created or existing value.
Remind that it may change types of parents according to tokens, so it potentially removes previously stored values. For example, if a document was an array, and "/foo" is used to create a value, then the document will be changed to an object, and all existing array elements are lost.
root | Root value of a DOM subtree to be resolved. It can be any value other than document root. |
allocator | Allocator for creating the values if the specified value or its parents are not exist. |
alreadyExist | If non-null, it stores whether the resolved value is already exist. |
|
inline |
Erase a value in a subtree.
root | Root value of a DOM sub-tree to be resolved. It can be any value other than document root. |
Pointer
(""), i.e. the root, always fail and return false.
|
inline |
Query a const value in a const subtree.
root | Root value of a DOM sub-tree to be resolved. It can be any value other than document root. |
|
inline |
Query a value in a subtree.
root | Root value of a DOM sub-tree to be resolved. It can be any value other than document root. |
unresolvedTokenIndex | If the pointer cannot resolve a token in the pointer, this parameter can obtain the index of unresolved token. |
Use unresolvedTokenIndex to retrieve the token index.
|
inline |
Query a value in a document with default primitive value.
T | Either Type, int , unsigned , int64_t , uint64_t , bool |
|
inline |
Query a value in a subtree with default value.
Similar to Get(), but if the specified value do not exists, it creates all parents and clone the default value. So that this function always succeed.
root | Root value of a DOM sub-tree to be resolved. It can be any value other than document root. |
defaultValue | Default value to be cloned if the value was not exists. |
allocator | Allocator for creating the values if the specified value or its parents are not exist. |
|
inline |
Query a value in a subtree with default primitive value.
T | Either Type, int , unsigned , int64_t , uint64_t , bool |
|
inline |
Inequality operator.
|
inline |
Less than operator.
|
inline |
Equality operator.
|
inline |
Set a primitive value in a document.
T | Either Type, int , unsigned , int64_t , uint64_t , bool |
|
inline |
Set a primitive value in a subtree.
T | Either Type, int , unsigned , int64_t , uint64_t , bool |
|
inline |
Set a value in a subtree, with move semantics.
It creates all parents if they are not exist or types are different to the tokens. So this function always succeeds but potentially remove existing values.
root | Root value of a DOM sub-tree to be resolved. It can be any value other than document root. |
value | Value to be set. |
allocator | Allocator for creating the values if the specified value or its parents are not exist. |
|
inline |
Stringify the pointer into string representation.
OutputStream | Type of output stream. |
os | The output stream. |
|
inline |
Stringify the pointer into URI fragment representation.
OutputStream | Type of output stream. |
os | The output stream. |
|
inline |
Swap the content of this pointer with an other.
other | The pointer to swap with. |
|
inline |
Swap a value with a value in a subtree.
It creates all parents if they are not exist or types are different to the tokens. So this function always succeeds but potentially remove existing values.
root | Root value of a DOM sub-tree to be resolved. It can be any value other than document root. |
value | Value to be swapped. |
allocator | Allocator for creating the values if the specified value or its parents are not exist. |
|
friend |
free-standing swap function helper
Helper function to enable support for common swap implementation pattern based on std::swap: