#include <validator_length.h>

Inheritance diagram for advgetopt::validator_length:

Collaboration diagram for advgetopt::validator_length:

Classes
struct	range_t

Public Types
typedef std::shared_ptr< validator >	pointer_t

typedef std::vector< pointer_t >	vector_t

Public Member Functions
	validator_length (string_list_t const &data)

std::string const &	get_error () const

virtual std::string	name () const override
	Return the name of this validator.

void	set_error (std::string const &msg) const

virtual bool	validate (std::string const &value) const override
	Check the value against a list of length ranges.

Static Public Member Functions
static pointer_t	create (std::string const &name, string_list_t const &data)

static pointer_t	create (std::string const &name_and_params)
	Set the validator for this option.

static void	register_validator (validator_factory const &factory)

Private Attributes
range_t::vector_t	f_allowed_lengths = range_t::vector_t()

std::string	f_error = std::string("<error undefined>")

Detailed Description

Definition at line 54 of file validator_length.h.

Member Typedef Documentation

◆ pointer_t

typedef std::shared_ptr<validator> advgetopt::validator::pointer_t

inherited

Definition at line 64 of file validator.h.

◆ vector_t

typedef std::vector<pointer_t> advgetopt::validator::vector_t

inherited

Definition at line 65 of file validator.h.

Constructor & Destructor Documentation

◆ validator_length()

advgetopt::validator_length::validator_length ( string_list_t const & data )

Definition at line 97 of file validator_length.cpp.

References advgetopt::validator_integer::convert_string(), f_allowed_lengths, and advgetopt::option_flags_merge().

Member Function Documentation

◆ create() [1/2]

validator::pointer_t advgetopt::validator::create	(	std::string const &	name,
		string_list_t const &	data
	)

staticinherited

Definition at line 605 of file validator.cpp.

References advgetopt::validator::name(), and advgetopt::option_flags_merge().

Referenced by advgetopt::validator::create(), and advgetopt::option_info::set_validator().

◆ create() [2/2]

validator::pointer_t advgetopt::validator::create ( std::string const & name_and_params )

staticinherited

This function parses the specified name and optional parameters and create a corresponding validator for this option.

The name_and_params string can be defined as:

<validator-name>(<param1>, <param2>, ...)

advgetopt::validator_length::name

virtual std::string name() const override

Return the name of this validator.

Definition validator_length.cpp:171

advgetopt::validator

Definition validator.h:62

advgetopt::option_flags_merge

constexpr flag_t option_flags_merge()

Definition flags.h:87

The list of parameters is optional. There may be an empty, just one, or any number of parameters. How the parameters are parsed is left to the validator to decide.

If the input string is empty, the current validator, if one is installed, gets removed.

The complete grammar of the name_and_params name and parameters can be written as a comma separated list of function calls, we have a special case for regex which do not require the function call. thing is pretty much anything other than the few special characters (comma, space, parenthesis, and quotes). To include a special character in thing either use a string or escape the character.

validator_list: name_and_params
              | name_and_params ',' validator_list
 
name_and_params: name '(' params ')'
               | '/' ... '/'              // regex special case
 
name: [a-zA-Z_][a-zA-Z_0-9]*
 
params: (thing - [,()'" ])
      | '\'' (thing - '\'') '\''
      | '"' (thing - '"') '"'
 
thing: [^ -~]*
     | '\\' [ -~]