GenericSchemaDocument< ValueT, Allocator > Class Template Reference

JSON schema document. More...

#include <schema.h>

Public Types
typedef ValueT	ValueType
typedef IGenericRemoteSchemaDocumentProvider< GenericSchemaDocument >	IRemoteSchemaDocumentProviderType
typedef Allocator	AllocatorType
typedef ValueType::EncodingType	EncodingType
typedef EncodingType::Ch	Ch
typedef internal::Schema< GenericSchemaDocument >	SchemaType
typedef GenericPointer< ValueType, Allocator >	PointerType
typedef GenericValue< EncodingType, Allocator >	URIType

Public Member Functions
	GenericSchemaDocument (const ValueType &document, const Ch *uri=0, SizeType uriLength=0, IRemoteSchemaDocumentProviderType *remoteProvider=0, Allocator *allocator=0)
	Constructor.
	~GenericSchemaDocument ()
	Destructor.
const URIType &	GetURI () const
const SchemaType &	GetRoot () const
	Get the root schema.

Friends
class	internal::Schema< GenericSchemaDocument >
template<typename , typename , typename >
class	GenericSchemaValidator

Detailed Description

template<typename ValueT, typename Allocator = CrtAllocator>
class GenericSchemaDocument< ValueT, Allocator >

A JSON schema document is a compiled version of a JSON schema. It is basically a tree of internal::Schema.

Note

This is an immutable class (i.e. its instance cannot be modified after construction).

Template Parameters

ValueT	Type of JSON value (e.g. Value ), which also determine the encoding.
Allocator	Allocator type for allocating memory of this document.

Definition at line 1501 of file schema.h.

Member Typedef Documentation

AllocatorType

template<typename ValueT , typename Allocator = CrtAllocator>

Allocator GenericSchemaDocument< ValueT, Allocator >::AllocatorType

Definition at line 1505 of file schema.h.

Ch

template<typename ValueT , typename Allocator = CrtAllocator>

EncodingType::Ch GenericSchemaDocument< ValueT, Allocator >::Ch

Definition at line 1507 of file schema.h.

EncodingType

template<typename ValueT , typename Allocator = CrtAllocator>

ValueType::EncodingType GenericSchemaDocument< ValueT, Allocator >::EncodingType

Definition at line 1506 of file schema.h.

IRemoteSchemaDocumentProviderType

template<typename ValueT , typename Allocator = CrtAllocator>

IGenericRemoteSchemaDocumentProvider<GenericSchemaDocument> GenericSchemaDocument< ValueT, Allocator >::IRemoteSchemaDocumentProviderType

Definition at line 1504 of file schema.h.

PointerType

template<typename ValueT , typename Allocator = CrtAllocator>

GenericPointer<ValueType, Allocator> GenericSchemaDocument< ValueT, Allocator >::PointerType

Definition at line 1509 of file schema.h.

SchemaType

template<typename ValueT , typename Allocator = CrtAllocator>

internal::Schema<GenericSchemaDocument> GenericSchemaDocument< ValueT, Allocator >::SchemaType

Definition at line 1508 of file schema.h.

URIType

template<typename ValueT , typename Allocator = CrtAllocator>

GenericValue<EncodingType, Allocator> GenericSchemaDocument< ValueT, Allocator >::URIType

Definition at line 1510 of file schema.h.

ValueType

template<typename ValueT , typename Allocator = CrtAllocator>

ValueT GenericSchemaDocument< ValueT, Allocator >::ValueType

Definition at line 1503 of file schema.h.

Constructor & Destructor Documentation

GenericSchemaDocument()

template<typename ValueT , typename Allocator = CrtAllocator>

GenericSchemaDocument< ValueT, Allocator >::GenericSchemaDocument ( const ValueType & document, const Ch * uri = 0, SizeType uriLength = 0, IRemoteSchemaDocumentProviderType * remoteProvider = 0, Allocator * allocator = 0 )

inlineexplicit

Compile a JSON document into schema document.

Parameters

document	A JSON document as source.
uri	The base URI of this schema document for purposes of violation reporting.
uriLength	Length of name, in code points.
remoteProvider	An optional remote schema document provider for resolving remote reference. Can be null.
allocator	An optional allocator instance for allocating memory. Can be null.

Definition at line 1525 of file schema.h.

                                                                                         :
        remoteProvider_(remoteProvider),
        allocator_(allocator),
        ownAllocator_(),
        root_(),
        typeless_(),
        schemaMap_(allocator, kInitialSchemaMapSize),
        schemaRef_(allocator, kInitialSchemaRefSize)
    {
        if (!allocator_)
            ownAllocator_ = allocator_ = RAPIDJSON_NEW(Allocator)();
 
        Ch noUri[1] = {0};
        uri_.SetString(uri ? uri : noUri, uriLength, *allocator_);
 
        typeless_ = static_cast<SchemaType*>(allocator_->Malloc(sizeof(SchemaType)));
        new (typeless_) SchemaType(this, PointerType(), ValueType(kObjectType).Move(), ValueType(kObjectType).Move(), allocator_);
 
        // Generate root schema, it will call CreateSchema() to create sub-schemas,
        // And call AddRefSchema() if there are $ref.
        CreateSchemaRecursive(&root_, PointerType(), document, document);
 
        // Resolve $ref
        while (!schemaRef_.Empty()) {
            SchemaRefEntry* refEntry = schemaRef_.template Pop<SchemaRefEntry>(1);
            if (const SchemaType* s = GetSchema(refEntry->target)) {
                if (refEntry->schema)
                    *refEntry->schema = s;
 
                // Create entry in map if not exist
                if (!GetSchema(refEntry->source)) {
                    new (schemaMap_.template Push<SchemaEntry>()) SchemaEntry(refEntry->source, const_cast<SchemaType*>(s), false, allocator_);
                }
            }
            else if (refEntry->schema)
                *refEntry->schema = typeless_;
 
            refEntry->~SchemaRefEntry();
        }
 
        RAPIDJSON_ASSERT(root_ != 0);
 
        schemaRef_.ShrinkToFit(); // Deallocate all memory for ref
    }

~GenericSchemaDocument()

template<typename ValueT , typename Allocator = CrtAllocator>

GenericSchemaDocument< ValueT, Allocator >::~GenericSchemaDocument ( )

inline

Definition at line 1591 of file schema.h.

                             {
        while (!schemaMap_.Empty())
            schemaMap_.template Pop<SchemaEntry>(1)->~SchemaEntry();
 
        if (typeless_) {
            typeless_->~SchemaType();
            Allocator::Free(typeless_);
        }
 
        RAPIDJSON_DELETE(ownAllocator_);
    }

Member Function Documentation

GetRoot()

template<typename ValueT , typename Allocator = CrtAllocator>

const SchemaType & GenericSchemaDocument< ValueT, Allocator >::GetRoot ( ) const

inline

Definition at line 1606 of file schema.h.

{ return *root_; }

GetURI()

template<typename ValueT , typename Allocator = CrtAllocator>

const URIType & GenericSchemaDocument< ValueT, Allocator >::GetURI ( ) const

inline

Definition at line 1603 of file schema.h.

{ return uri_; }

Friends And Related Symbol Documentation

GenericSchemaValidator

template<typename ValueT , typename Allocator = CrtAllocator>

template<typename , typename , typename >

friend class GenericSchemaValidator

friend

Definition at line 1513 of file schema.h.

internal::Schema< GenericSchemaDocument >

template<typename ValueT , typename Allocator = CrtAllocator>

friend class internal::Schema< GenericSchemaDocument >

friend

Definition at line 1510 of file schema.h.

---

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

• libraries/fc/include/fc/crypto/webauthn_json/include/rapidjson/fwd.h
• libraries/fc/include/fc/crypto/webauthn_json/include/rapidjson/schema.h