Parsnip::DictionarySchema Class Reference

Schema component for validating dictionaries. More...

#include <parsnip_schema.h>

Inheritance diagram for Parsnip::DictionarySchema:

Collaboration diagram for Parsnip::DictionarySchema:

Classes
class	DictionaryMember

Public Types
using	Dependencies = std::set< std::string >
using	size_type = unsigned int

Public Member Functions
	DictionarySchema ()=default
	DictionarySchema (const DictionarySchema &)=default
	DictionarySchema (DictionarySchema &&)=default
DictionarySchema &	operator= (const DictionarySchema &)=default
DictionarySchema &	operator= (DictionarySchema &&)=default
	DictionarySchema (const Parsnip::Data &schema_spec)
	Construct a dictionary (object) schema from a schema specificiation. More...
virtual DictionarySchema *	createCopy () const override
	Create an identical, deep copy of the schema. More...
void	addMember (const char *name, const SchemaBase &schema, bool mandatory=false, const Dependencies &dependencies=NoDependencies)
	Add a member to a dictionary schema. More...
void	replaceMember (const char *name, const SchemaBase &schema)
	Replace a member in the schema, retaining original mandatory status and dependencies. More...
void	removeMember (const char *name)
	Remove a member from the schema. More...
virtual void	validate (const Parsnip::Data &entry) const override
	Validate a dictionary: More...
virtual bool	operator== (const SchemaBase &other) const override
	Check if two schemas perform the same validation. More...
virtual void	mergeSchemas (const SchemaBase &from) override
	Merge elements into the current schema. More...
virtual std::ostream &	dump (std::ostream &target, int indent, bool suppress_ident=false) const override
	Render the schema in human-friendly text. More...
Public Member Functions inherited from Parsnip::SchemaBase
virtual	~SchemaBase ()=default
bool	operator!= (const SchemaBase &other) const

Static Public Attributes
static const Dependencies	NoDependencies

Protected Types
enum	AdditionalMemberNames { NONE , ANY , PATTERN }
Protected Types inherited from Parsnip::SchemaBase
using	StringType = Data::StringType
using	SchemaRegex = std::basic_regex< StringType::value_type >

Protected Attributes
std::map< std::string, DictionaryMember >	members
AdditionalMemberNames	tolerance = AdditionalMemberNames::NONE
	Allow unrecognized members in the dictionary? More...
SchemaRegex	additional_member_regex
SchemaBaseRef	additional_member_schema
Protected Attributes inherited from Parsnip::SchemaBase
bool	nullable = false
	If true, element may be null. More...

Private Attributes
size_type	minimum_members {0}
size_type	maximum_members = std::numeric_limits<size_type>::max()

Friends
class	ValueEvaluator
class	RemainingValuesEvaluator
class	KeywordEvaluator
class	OptionEvaluator

Additional Inherited Members
Protected Member Functions inherited from Parsnip::SchemaBase
	SchemaBase ()=default
	SchemaBase (const SchemaBase &)=default
	SchemaBase (SchemaBase &&)=default
SchemaBase &	operator= (const SchemaBase &)=default
SchemaBase &	operator= (SchemaBase &&)=default
	SchemaBase (const Parsnip::Data &schema_spec)
	Construct a schema from a JSON specification. More...
void	checkType (Data::Type expected, const Parsnip::Data &entry) const
	Check that Data item is an allowed type. More...
bool	isValidlyNull (const Parsnip::Data &entry) const
	Determine if the data is Null and if that is allowed. More...
bool	isType (Data::Type expected, const Parsnip::Data &entry) const
	Check if a data object is a particular type. More...

Detailed Description

Schema component for validating dictionaries.

Member Typedef Documentation

Dependencies

using Parsnip::DictionarySchema::Dependencies = std::set<std::string>

size_type

using Parsnip::DictionarySchema::size_type = unsigned int

Member Enumeration Documentation

AdditionalMemberNames

enum Parsnip::DictionarySchema::AdditionalMemberNames

protected

Enumerator
NONE
ANY
PATTERN

Constructor & Destructor Documentation

DictionarySchema() [1/4]

Parsnip::DictionarySchema::DictionarySchema ( )

default

Here is the caller graph for this function:

DictionarySchema() [2/4]

Parsnip::DictionarySchema::DictionarySchema ( const DictionarySchema &  )

default

DictionarySchema() [3/4]

Parsnip::DictionarySchema::DictionarySchema ( DictionarySchema &&  )

default

DictionarySchema() [4/4]

Parsnip::DictionarySchema::DictionarySchema

(

const Parsnip::Data &

schema_spec

)

Construct a dictionary (object) schema from a schema specificiation.

Parameters

schema_spec

The specification.

Here is the call graph for this function:

Member Function Documentation

addMember()

void Parsnip::DictionarySchema::addMember	(	const char *	name,
		const SchemaBase &	schema,
		bool	mandatory = false,
		const Dependencies &	dependencies = NoDependencies
	)

Add a member to a dictionary schema.

Parameters

name	The name of the member to add.
schema	The schema for the new member.
mandatory	If true, the member must be present for the dictionary to be valid.
dependencies	Any members that must be present when the new member is present.

Here is the call graph for this function:

Here is the caller graph for this function:

createCopy()

DictionarySchema * Parsnip::DictionarySchema::createCopy ( ) const

overridevirtual

Create an identical, deep copy of the schema.

Caller is responsible for deleting it.

Implements Parsnip::SchemaBase.

Here is the call graph for this function:

dump()

std::ostream & Parsnip::DictionarySchema::dump ( std::ostream &  target, int  indent, bool  suppress_indent = false  ) const

overridevirtual

Render the schema in human-friendly text.

Parameters

target	Where to write the schema.
indent	Amount of indent to use.
suppress_indent	Flag indicating indent was already performed.

Implements Parsnip::SchemaBase.

Here is the call graph for this function:

mergeSchemas()

void Parsnip::DictionarySchema::mergeSchemas ( const SchemaBase &  from )

overridevirtual

Merge elements into the current schema.

Merge elements managed by this class.

• Elements seen every time are mandatory.
• Elements seen only sometime are optional.
• Elements always seen together are codependent.
• Elements must always expect similar types, except they may vary as element and list-of-same-element.

  Parameters

  from	A schema for a valid command command line.

  Exceptions

  Various

  exceptions.

Reimplemented from Parsnip::SchemaBase.

Here is the call graph for this function:

operator=() [1/2]

DictionarySchema& Parsnip::DictionarySchema::operator= ( const DictionarySchema &  )

default

operator=() [2/2]

DictionarySchema& Parsnip::DictionarySchema::operator= ( DictionarySchema &&  )

default

operator==()

bool Parsnip::DictionarySchema::operator== ( const SchemaBase &  other ) const

overridevirtual

Check if two schemas perform the same validation.

Compare two schemas to see if they determine validity in the same manner.

Parameters

other

The schema to compare to.

Returns

True if the schemas match, false otherwise.

Reimplemented from Parsnip::SchemaBase.

removeMember()

void Parsnip::DictionarySchema::removeMember

(

const char *

name

)

Remove a member from the schema.

Parameters

name	The member to remove.

Here is the caller graph for this function:

replaceMember()

void Parsnip::DictionarySchema::replaceMember	(	const char *	name,
		const SchemaBase &	schema
	)

Replace a member in the schema, retaining original mandatory status and dependencies.

Parameters

name	The member to revise.
schema	The replacement schema for the member.

Here is the call graph for this function:

Here is the caller graph for this function:

validate()

void Parsnip::DictionarySchema::validate ( const Parsnip::Data &  entry ) const

overridevirtual

Validate a dictionary:

• Check all elements conform to their respected schema.
• Ensure all mandatory elements are present.
• Ensure there are no unknown elements present.
• Make sure any co-dependent keys are present.

Implements Parsnip::SchemaBase.

Here is the call graph for this function:

Friends And Related Function Documentation

KeywordEvaluator

friend class KeywordEvaluator

friend

OptionEvaluator

friend class OptionEvaluator

friend

RemainingValuesEvaluator

friend class RemainingValuesEvaluator

friend

ValueEvaluator

friend class ValueEvaluator

friend

Member Data Documentation

additional_member_regex

SchemaRegex Parsnip::DictionarySchema::additional_member_regex

protected

additional_member_schema

SchemaBaseRef Parsnip::DictionarySchema::additional_member_schema

protected

maximum_members

size_type Parsnip::DictionarySchema::maximum_members = std::numeric_limits<size_type>::max()

private

members

std::map<std::string, DictionaryMember> Parsnip::DictionarySchema::members

protected

minimum_members

size_type Parsnip::DictionarySchema::minimum_members {0}

private

NoDependencies

const Dependencies Parsnip::DictionarySchema::NoDependencies

static

tolerance

AdditionalMemberNames Parsnip::DictionarySchema::tolerance = AdditionalMemberNames::NONE

protected

Allow unrecognized members in the dictionary?

---

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

• parsnip/parsnip_schema.h
• parsnip/parsnip_schema.cpp