Parsnip::OptionSchema Class Reference

Schema adapter component that allows use of schemas from option parsers. More...

#include <parsnip_schema.h>

Inheritance diagram for Parsnip::OptionSchema:

Collaboration diagram for Parsnip::OptionSchema:

Public Member Functions
	OptionSchema ()=default
	Validate a type schema: ensure the datatype is as expected. More...
	OptionSchema (const OptionSchema &)=default
	OptionSchema (OptionSchema &&)=default
OptionSchema &	operator= (const OptionSchema &)=default
OptionSchema &	operator= (OptionSchema &&)=default
	OptionSchema (const SchemaRef &option_schema)
	Construct a new option schema. More...
virtual OptionSchema *	createCopy () const override
	Create an identical, deep copy of the schema. More...
virtual void	validate (const Parsnip::Data &entry) const override
	Validate the option's schema by calling that scheme's validator. 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

Private Attributes
SchemaRef	schema

Additional Inherited Members
Protected Types inherited from Parsnip::SchemaBase
using	StringType = Data::StringType
using	SchemaRegex = std::basic_regex< StringType::value_type >
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...
Protected Attributes inherited from Parsnip::SchemaBase
bool	nullable = false
	If true, element may be null. More...

Detailed Description

Schema adapter component that allows use of schemas from option parsers.

Constructor & Destructor Documentation

OptionSchema() [1/4]

Parsnip::OptionSchema::OptionSchema ( )

default

Validate a type schema: ensure the datatype is as expected.

Here is the caller graph for this function:

OptionSchema() [2/4]

Parsnip::OptionSchema::OptionSchema ( const OptionSchema &  )

default

OptionSchema() [3/4]

Parsnip::OptionSchema::OptionSchema ( OptionSchema &&  )

default

OptionSchema() [4/4]

Parsnip::OptionSchema::OptionSchema

(

const SchemaRef &

option_schema

)

Construct a new option schema.

Member Function Documentation

createCopy()

OptionSchema * Parsnip::OptionSchema::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::OptionSchema::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.

mergeSchemas()

void Parsnip::OptionSchema::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]

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

default

operator=() [2/2]

OptionSchema& Parsnip::OptionSchema::operator= ( OptionSchema &&  )

default

operator==()

bool Parsnip::OptionSchema::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.

Here is the call graph for this function:

validate()

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

overridevirtual

Validate the option's schema by calling that scheme's validator.

Implements Parsnip::SchemaBase.

Member Data Documentation

schema

SchemaRef Parsnip::OptionSchema::schema

private

---

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

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