advgetopt::validator_keywords Class Reference

#include <validator_keywords.h>

Inheritance diagram for advgetopt::validator_keywords:

Collaboration diagram for advgetopt::validator_keywords:

Public Types
typedef std::shared_ptr< validator >	pointer_t
typedef std::vector< pointer_t >	vector_t

Public Member Functions
	validator_keywords (string_list_t const &data)
virtual std::string	name () const override
	Return the name of this validator.
virtual bool	validate (std::string const &value) const override
	Check the value against a list of keywords.

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
string_set_t	f_keywords = string_set_t()

Detailed Description

Definition at line 46 of file validator_keywords.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_keywords()

advgetopt::validator_keywords::validator_keywords

(

string_list_t const &

data

)

Definition at line 85 of file validator_keywords.cpp.

References f_keywords, 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 589 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>, ...)

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.

Parameters

[in]

name_and_params

The validator name and parameters.

Definition at line 626 of file validator.cpp.

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

name()

std::string advgetopt::validator_keywords::name ( ) const

overridevirtual

This function returns "keywords".

Returns

"keywords".

Implements advgetopt::validator.

Definition at line 108 of file validator_keywords.cpp.

register_validator()

void advgetopt::validator::register_validator ( validator_factory const &  factory )

staticinherited

Definition at line 571 of file validator.cpp.

References advgetopt::option_flags_merge().

validate()

bool advgetopt::validator_keywords::validate ( std::string const &  value ) const

overridevirtual

This function is used to match the value of an argument against a list of keywords. It returns true when it does match.

Parameters

[in]

value

The value to be validated.

Returns

true on a match.

Implements advgetopt::validator.

Definition at line 123 of file validator_keywords.cpp.

References f_keywords.

Member Data Documentation

f_keywords

string_set_t advgetopt::validator_keywords::f_keywords = string_set_t()

private

Definition at line 58 of file validator_keywords.h.

Referenced by validator_keywords(), and validate().

---

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

• advgetopt/validator_keywords.h
• advgetopt/validator_keywords.cpp