JSON schema document. Plus de détails...

#include <arcane/utils/internal/json/rapidjson/schema.h>

Graphe de collaboration de GenericSchemaDocument< ValueT, Allocator >:

Classes
struct	SchemaEntry

Types publics
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, AllocatorType >	GValue

typedef GenericUri< ValueType, Allocator >	UriType

typedef GenericStringRef< Ch >	StringRefType

Fonctions membres publiques
	GenericSchemaDocument (const ValueType &document, const Ch uri=0, SizeType uriLength=0, IRemoteSchemaDocumentProviderType remoteProvider=0, Allocator *allocator=0, const PointerType &pointer=PointerType(), const Specification &spec=Specification(kDraft04))
	Constructor.

	~GenericSchemaDocument ()
	Destructor.

const GValue &	GetURI () const

const Specification &	GetSpecification () const

bool	IsSupportedSpecification () const

const SchemaType &	GetRoot () const
	Get the root schema.

GValue &	GetError ()
	Gets the error object.

const GValue &	GetError () const

void	SchemaError (const SchemaErrorCode code, const PointerType &location)
	Default error method.

void	SchemaErrorValue (const SchemaErrorCode code, const PointerType &location, const Ch *value, SizeType length)
	Method for error with single string value insert.

void	SchemaErrorPointer (const SchemaErrorCode code, const PointerType &location, const Ch *value, SizeType length, const PointerType &pointer)
	Method for error with invalid pointer.

Fonctions membres publiques statiques
static const Specification	GetSpecification (const ValueType &document)
	Static method to get the specification of any schema document.

static const StringRefType &	GetSchemaErrorKeyword (SchemaErrorCode schemaErrorCode)

Types privés
typedef const PointerType *	SchemaRefPtr

Fonctions membres privées
	GenericSchemaDocument (const GenericSchemaDocument &)
	Prohibit copying.

GenericSchemaDocument &	operator= (const GenericSchemaDocument &)
	Prohibit assignment.

void	AddErrorInstanceLocation (GValue &result, const PointerType &location)

void	AddError (GValue &keyword, GValue &error)

void	AddCurrentError (const SchemaErrorCode code, const PointerType &location)

	RAPIDJSON_STRING_ (InstanceRef, 'i', 'n', 's', 't', 'a', 'n', 'c', 'e', 'R', 'e', 'f') RAPIDJSON_STRING_(ErrorCode

e	RAPIDJSON_STRING_ (Value, 'v', 'a', 'l', 'u', 'e') RAPIDJSON_STRING_(Offset

e t	RAPIDJSON_STRING_ (Null, 'n', 'u', 'l', 'l') RAPIDJSON_STRING_(SpecUnknown

e t n	RAPIDJSON_STRING_ (SpecUnsupported, 'S', 'p', 'e', 'c', 'U', 'n', 's', 'u', 'p', 'p', 'o', 'r', 't', 'e', 'd') RAPIDJSON_STRING_(SpecIllegal

e t n l	RAPIDJSON_STRING_ (StartUnknown, 'S', 't', 'a', 'r', 't', 'U', 'n', 'k', 'n', 'o', 'w', 'n') RAPIDJSON_STRING_(RefPlainName

e t n l e	RAPIDJSON_STRING_ (RefInvalid, 'R', 'e', 'f', 'I', 'n', 'v', 'a', 'l', 'i', 'd') RAPIDJSON_STRING_(RefPointerInvalid

e t n l e d	RAPIDJSON_STRING_ (RefUnknown, 'R', 'e', 'f', 'U', 'n', 'k', 'n', 'o', 'w', 'n') RAPIDJSON_STRING_(RefCyclical

e t n l e d l	RAPIDJSON_STRING_ (RefNoRemoteProvider, 'R', 'e', 'f', 'N', 'o', 'R', 'e', 'm', 'o', 't', 'e', 'P', 'r', 'o', 'v', 'i', 'd', 'e', 'r') RAPIDJSON_STRING_(RefNoRemoteSchema

e t n l e d l a	RAPIDJSON_STRING_ (ReadOnlyAndWriteOnly, 'R', 'e', 'a', 'd', 'O', 'n', 'l', 'y', 'A', 'n', 'd', 'W', 'r', 'i', 't', 'e', 'O', 'n', 'l', 'y') RAPIDJSON_STRING_(RegexInvalid

void	SetSchemaSpecification (const ValueType &document)

void	CreateSchemaRecursive (const SchemaType **schema, const PointerType &pointer, const ValueType &v, const ValueType &document, const UriType &id)

const UriType &	CreateSchema (const SchemaType **schema, const PointerType &pointer, const ValueType &v, const ValueType &document, const UriType &id)

bool	HandleRefSchema (const PointerType &source, const SchemaType **schema, const ValueType &v, const ValueType &document, const UriType &id)

ValueType *	FindId (const ValueType &doc, const UriType &finduri, PointerType &resptr, const UriType &baseuri, bool full, const PointerType &here=PointerType()) const
	Find the first subschema with a resolved 'id' that matches the specified URI.

void	AddSchemaRefs (SchemaType *schema)

bool	IsCyclicRef (const PointerType &pointer) const

const SchemaType *	GetSchema (const PointerType &pointer) const

PointerType	GetPointer (const SchemaType *schema) const

const SchemaType *	GetTypeless () const

Fonctions membres privées statiques
e t n l e d l a static d SchemaDraft	GetSchemaDraft (const ValueType &document)

static OpenApiVersion	GetOpenApiVersion (const ValueType &document)

Attributs privés
	e

	r

	o

	C

	d

e	o

e	f

e	s

e	e

e t	S

e t	p

e t	e

e t	c

e t	U

e t	n

e t	k

e t	o

e t	w

e t n	S

e t n	p

e t n	e

e t n	c

e t n	I

e t n	l

e t n	g

e t n	a

e t n l	R

e t n l	e

e t n l	f

e t n l	P

e t n l	l

e t n l	a

e t n l	i

e t n l	n

e t n l	N

e t n l	m

e t n l e	R

e t n l e	e

e t n l e	f

e t n l e	P

e t n l e	o

e t n l e	i

e t n l e	n

e t n l e	t

e t n l e	r

e t n l e	I

e t n l e	v

e t n l e	a

e t n l e	l

e t n l e d	R

e t n l e d	e

e t n l e d	f

e t n l e d	C

e t n l e d	y

e t n l e d	c

e t n l e d	l

e t n l e d	i

e t n l e d	a

e t n l e d l	R

e t n l e d l	e

e t n l e d l	f

e t n l e d l	N

e t n l e d l	o

e t n l e d l	m

e t n l e d l	t

e t n l e d l	S

e t n l e d l	c

e t n l e d l	h

e t n l e d l a	R

e t n l e d l a	e

e t n l e d l a	g

e t n l e d l a	x

e t n l e d l a	I

e t n l e d l a	n

e t n l e d l a	v

e t n l e d l a	a

e t n l e d l a	l

e t n l e d l a	i

IRemoteSchemaDocumentProviderType *	remoteProvider_

Allocator *	allocator_

Allocator *	ownAllocator_

const SchemaType *	root_
	Root schema.

SchemaType *	typeless_

internal::Stack< Allocator >	schemaMap_

internal::Stack< Allocator >	schemaRef_

GValue	uri_

UriType	docId_

Specification	spec_

GValue	error_

GValue	currentError_

Attributs privés statiques
static const size_t	kInitialSchemaMapSize = 64

static const size_t	kInitialSchemaRefSize = 64

Amis
class	internal::Schema< GenericSchemaDocument >

template<typename, typename, typename>
class	GenericSchemaValidator

Description détaillée

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

JSON schema document.

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

Paramètres du template

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

Définition à la ligne 1816 du fichier schema.h.

Documentation des définitions de type membres

◆ AllocatorType

template<typename ValueT, typename Allocator = CrtAllocator>

typedef Allocator GenericSchemaDocument< ValueT, Allocator >::AllocatorType

Définition à la ligne 1820 du fichier schema.h.

◆ Ch

template<typename ValueT, typename Allocator = CrtAllocator>

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

Définition à la ligne 1822 du fichier schema.h.

◆ EncodingType

template<typename ValueT, typename Allocator = CrtAllocator>

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

Définition à la ligne 1821 du fichier schema.h.

◆ GValue

template<typename ValueT, typename Allocator = CrtAllocator>

typedef GenericValue<EncodingType, AllocatorType> GenericSchemaDocument< ValueT, Allocator >::GValue

Définition à la ligne 1825 du fichier schema.h.

◆ IRemoteSchemaDocumentProviderType

template<typename ValueT, typename Allocator = CrtAllocator>

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

Définition à la ligne 1819 du fichier schema.h.

◆ PointerType

template<typename ValueT, typename Allocator = CrtAllocator>

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

Définition à la ligne 1824 du fichier schema.h.

◆ SchemaRefPtr

template<typename ValueT, typename Allocator = CrtAllocator>

typedef const PointerType* GenericSchemaDocument< ValueT, Allocator >::SchemaRefPtr

private

Définition à la ligne 2008 du fichier schema.h.

◆ SchemaType

template<typename ValueT, typename Allocator = CrtAllocator>

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

Définition à la ligne 1823 du fichier schema.h.

◆ StringRefType

template<typename ValueT, typename Allocator = CrtAllocator>

typedef GenericStringRef<Ch> GenericSchemaDocument< ValueT, Allocator >::StringRefType

Définition à la ligne 1827 du fichier schema.h.

◆ UriType

template<typename ValueT, typename Allocator = CrtAllocator>

typedef GenericUri<ValueType, Allocator> GenericSchemaDocument< ValueT, Allocator >::UriType

Définition à la ligne 1826 du fichier schema.h.

◆ ValueType

template<typename ValueT, typename Allocator = CrtAllocator>

typedef ValueT GenericSchemaDocument< ValueT, Allocator >::ValueType

Définition à la ligne 1818 du fichier schema.h.

Documentation des constructeurs et destructeur

◆ 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,
		const PointerType &	pointer = PointerType(),
		const Specification &	spec = Specification(kDraft04) )

inlineexplicit

Constructor.

Compile a JSON document into schema document.

Paramètres

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.
pointer	An optional JSON pointer to the start of the schema document
spec	Optional schema draft or OpenAPI version. Used if no specification in document. Defaults to draft-04.

Définition à la ligne 1844 du fichier schema.h.

◆ ~GenericSchemaDocument()

template<typename ValueT, typename Allocator = CrtAllocator>

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

inline

Destructor.

Définition à la ligne 1919 du fichier schema.h.

Documentation des fonctions membres

◆ AddCurrentError()

template<typename ValueT, typename Allocator = CrtAllocator>

void GenericSchemaDocument< ValueT, Allocator >::AddCurrentError	(	const SchemaErrorCode	code,
		const PointerType &	location )

inlineprivate

Définition à la ligne 2044 du fichier schema.h.

◆ AddError()

template<typename ValueT, typename Allocator = CrtAllocator>

void GenericSchemaDocument< ValueT, Allocator >::AddError	(	GValue &	keyword,
		GValue &	error )

inlineprivate

Définition à la ligne 2030 du fichier schema.h.

◆ AddErrorInstanceLocation()

template<typename ValueT, typename Allocator = CrtAllocator>

void GenericSchemaDocument< ValueT, Allocator >::AddErrorInstanceLocation	(	GValue &	result,
		const PointerType &	location )

inlineprivate

Définition à la ligne 2023 du fichier schema.h.

◆ AddSchemaRefs()

template<typename ValueT, typename Allocator = CrtAllocator>

void GenericSchemaDocument< ValueT, Allocator >::AddSchemaRefs ( SchemaType * schema )

inlineprivate

Définition à la ligne 2364 du fichier schema.h.

◆ CreateSchema()

template<typename ValueT, typename Allocator = CrtAllocator>

const UriType & GenericSchemaDocument< ValueT, Allocator >::CreateSchema	(	const SchemaType **	schema,
		const PointerType &	pointer,
		const ValueType &	v,
		const ValueType &	document,
		const UriType &	id )

inlineprivate

Définition à la ligne 2177 du fichier schema.h.

◆ CreateSchemaRecursive()

template<typename ValueT, typename Allocator = CrtAllocator>

void GenericSchemaDocument< ValueT, Allocator >::CreateSchemaRecursive	(	const SchemaType **	schema,
		const PointerType &	pointer,
		const ValueType &	v,
		const ValueType &	document,
		const UriType &	id )

inlineprivate

Définition à la ligne 2164 du fichier schema.h.

◆ FindId()

template<typename ValueT, typename Allocator = CrtAllocator>

ValueType * GenericSchemaDocument< ValueT, Allocator >::FindId	(	const ValueType &	doc,
		const UriType &	finduri,
		PointerType &	resptr,
		const UriType &	baseuri,
		bool	full,
		const PointerType &	here = PointerType() ) const

inlineprivate

Find the first subschema with a resolved 'id' that matches the specified URI.

Définition à la ligne 2325 du fichier schema.h.

Référencé par GenericSchemaDocument< Value, CrtAllocator >::FindId().

Voici le graphe des appelants de cette fonction :

◆ GetError() [1/2]

template<typename ValueT, typename Allocator = CrtAllocator>

GValue & GenericSchemaDocument< ValueT, Allocator >::GetError ( )

inline

Gets the error object.

Définition à la ligne 1959 du fichier schema.h.

◆ GetError() [2/2]

template<typename ValueT, typename Allocator = CrtAllocator>

const GValue & GenericSchemaDocument< ValueT, Allocator >::GetError ( ) const

inline

Définition à la ligne 1960 du fichier schema.h.

◆ GetOpenApiVersion()

template<typename ValueT, typename Allocator = CrtAllocator>

static OpenApiVersion GenericSchemaDocument< ValueT, Allocator >::GetOpenApiVersion ( const ValueType & document )

inlinestaticprivate

Définition à la ligne 2115 du fichier schema.h.

◆ GetPointer()

template<typename ValueT, typename Allocator = CrtAllocator>

PointerType GenericSchemaDocument< ValueT, Allocator >::GetPointer ( const SchemaType * schema ) const

inlineprivate

Définition à la ligne 2388 du fichier schema.h.

◆ GetRoot()

template<typename ValueT, typename Allocator = CrtAllocator>

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

inline

Get the root schema.

Définition à la ligne 1956 du fichier schema.h.

◆ GetSchema()

template<typename ValueT, typename Allocator = CrtAllocator>

const SchemaType * GenericSchemaDocument< ValueT, Allocator >::GetSchema ( const PointerType & pointer ) const

inlineprivate

Définition à la ligne 2381 du fichier schema.h.

◆ GetSchemaDraft()

template<typename ValueT, typename Allocator = CrtAllocator>

e t n l e d l a static d SchemaDraft GenericSchemaDocument< ValueT, Allocator >::GetSchemaDraft ( const ValueType & document )

inlinestaticprivate

Définition à la ligne 2081 du fichier schema.h.

◆ GetSchemaErrorKeyword()

template<typename ValueT, typename Allocator = CrtAllocator>

static const StringRefType & GenericSchemaDocument< ValueT, Allocator >::GetSchemaErrorKeyword ( SchemaErrorCode schemaErrorCode )

inlinestatic

Définition à la ligne 1962 du fichier schema.h.

◆ GetSpecification() [1/2]

template<typename ValueT, typename Allocator = CrtAllocator>

const Specification & GenericSchemaDocument< ValueT, Allocator >::GetSpecification ( ) const

inline

Définition à la ligne 1938 du fichier schema.h.

◆ GetSpecification() [2/2]

template<typename ValueT, typename Allocator = CrtAllocator>

static const Specification GenericSchemaDocument< ValueT, Allocator >::GetSpecification ( const ValueType & document )

inlinestatic

Static method to get the specification of any schema document.

Définition à la ligne 1943 du fichier schema.h.

◆ GetTypeless()

template<typename ValueT, typename Allocator = CrtAllocator>

const SchemaType * GenericSchemaDocument< ValueT, Allocator >::GetTypeless ( ) const

inlineprivate

Définition à la ligne 2395 du fichier schema.h.

◆ GetURI()

template<typename ValueT, typename Allocator = CrtAllocator>

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

inline

Définition à la ligne 1936 du fichier schema.h.

◆ HandleRefSchema()

template<typename ValueT, typename Allocator = CrtAllocator>

bool GenericSchemaDocument< ValueT, Allocator >::HandleRefSchema	(	const PointerType &	source,
		const SchemaType **	schema,
		const ValueType &	v,
		const ValueType &	document,
		const UriType &	id )

inlineprivate

Définition à la ligne 2206 du fichier schema.h.

◆ IsCyclicRef()

template<typename ValueT, typename Allocator = CrtAllocator>

bool GenericSchemaDocument< ValueT, Allocator >::IsCyclicRef ( const PointerType & pointer ) const

inlineprivate

Définition à la ligne 2374 du fichier schema.h.

◆ IsSupportedSpecification()

template<typename ValueT, typename Allocator = CrtAllocator>

bool GenericSchemaDocument< ValueT, Allocator >::IsSupportedSpecification ( ) const

inline

Définition à la ligne 1939 du fichier schema.h.

◆ SchemaError()

template<typename ValueT, typename Allocator = CrtAllocator>

void GenericSchemaDocument< ValueT, Allocator >::SchemaError	(	const SchemaErrorCode	code,
		const PointerType &	location )

inline

Default error method.

Définition à la ligne 1982 du fichier schema.h.

◆ SchemaErrorPointer()

template<typename ValueT, typename Allocator = CrtAllocator>

void GenericSchemaDocument< ValueT, Allocator >::SchemaErrorPointer	(	const SchemaErrorCode	code,
		const PointerType &	location,
		const Ch *	value,
		SizeType	length,
		const PointerType &	pointer )

inline

Method for error with invalid pointer.

Définition à la ligne 1995 du fichier schema.h.

◆ SchemaErrorValue()

template<typename ValueT, typename Allocator = CrtAllocator>

void GenericSchemaDocument< ValueT, Allocator >::SchemaErrorValue	(	const SchemaErrorCode	code,
		const PointerType &	location,
		const Ch *	value,
		SizeType	length )