option value to configure one or more characters (e.g., -m=",;") More...

#include <CharacterSetOption.h>

Inheritance diagram for Acl::CharacterSetOption:
Collaboration diagram for Acl::CharacterSetOption:

Public Types

typedef TypedOption< CharacterSetOptionValueParent
 
enum  ValueExpectation {
  valueNone,
  valueOptional,
  valueRequired
}
 

Public Member Functions

 CharacterSetOption (const char *name)
 
void linkWith (CharacterSetOptionValue *recipient) const
 who to tell when this option is enabled More...
 
virtual bool configured () const override
 
virtual bool configured () const =0
 
virtual bool disabled () const override
 whether disable() has been called More...
 
virtual bool disabled () const =0
 whether disable() has been called More...
 
virtual bool valued () const override
 
virtual bool valued () const =0
 
virtual void unconfigure () const override
 clear enable(), configureWith(), or disable() effects More...
 
virtual void unconfigure () const =0
 clear enable(), configureWith(), or disable() effects More...
 
virtual void enable () const override
 called after parsing onName without a value (e.g., -x or –enable-x) More...
 
virtual void enable () const =0
 called after parsing onName without a value (e.g., -x or –enable-x) More...
 
virtual void configureWith (const SBuf &rawValue) const override
 called after parsing onName and a value (e.g., -x=v or –enable-x=v) More...
 
virtual void disable () const override
 called after parsing offName (e.g., +i or –disable-x) More...
 
virtual void disable () const =0
 called after parsing offName (e.g., +i or –disable-x) More...
 
virtual void print (std::ostream &os) const override
 prints a configuration snippet (as an admin could have typed) More...
 
void print (std::ostream &os) const
 prints a configuration snippet (as an admin could have typed) More...
 

Public Attributes

const char *const onName = nullptr
 A name that must be used to explicitly enable this Option (required). More...
 
const char *const offName = nullptr
 
ValueExpectation valueExpectation = valueNone
 expect "=value" part? More...
 

Private Member Functions

void import (const SBuf &rawValue) const
 
void import (const SBuf &rawValue) const
 

Private Attributes

CharacterSetOptionValuerecipient_
 parsing results storage More...
 

Detailed Description

Definition at line 40 of file CharacterSetOption.h.

Member Typedef Documentation

◆ Parent

Member Enumeration Documentation

◆ ValueExpectation

Enumerator
valueNone 
valueOptional 
valueRequired 

Definition at line 59 of file Options.h.

Constructor & Destructor Documentation

◆ CharacterSetOption()

Acl::CharacterSetOption::CharacterSetOption ( const char *  name)
inlineexplicit

Definition at line 44 of file CharacterSetOption.h.

Member Function Documentation

◆ configured() [1/2]

virtual bool Acl::Option::configured ( ) const
pure virtualinherited

whether the admin explicitly specified this option (i.e., whether enable(), configureWith(), or disable() has been called)

Implemented in Acl::TypedOption< Recipient >.

◆ configured() [2/2]

virtual bool Acl::TypedOption< CharacterSetOptionValue >::configured
inlineoverridevirtualinherited

whether the admin explicitly specified this option (i.e., whether enable(), configureWith(), or disable() has been called)

Definition at line 145 of file Options.h.

◆ configureWith()

virtual void Acl::TypedOption< CharacterSetOptionValue >::configureWith ( const SBuf rawValue) const
inlineoverridevirtualinherited

Implements Acl::Option.

Definition at line 163 of file Options.h.

◆ disable() [1/2]

virtual void Acl::Option::disable ( ) const
pure virtualinherited

◆ disable() [2/2]

virtual void Acl::TypedOption< CharacterSetOptionValue >::disable
inlineoverridevirtualinherited

Definition at line 172 of file Options.h.

◆ disabled() [1/2]

virtual bool Acl::Option::disabled ( ) const
pure virtualinherited

◆ disabled() [2/2]

virtual bool Acl::TypedOption< CharacterSetOptionValue >::disabled
inlineoverridevirtualinherited

Definition at line 146 of file Options.h.

◆ enable() [1/2]

virtual void Acl::Option::enable ( ) const
pure virtualinherited

◆ enable() [2/2]

virtual void Acl::TypedOption< CharacterSetOptionValue >::enable
inlineoverridevirtualinherited

Definition at line 154 of file Options.h.

◆ import() [1/2]

void Acl::TypedOption< CharacterSetOptionValue >::import ( const SBuf rawValue) const
inlineprivateinherited

Definition at line 25 of file CharacterSetOption.h.

◆ import() [2/2]

void Acl::BooleanOption::import ( const SBuf rawValue) const
inlineprivateinherited

Definition at line 192 of file Options.h.

◆ linkWith()

void Acl::TypedOption< CharacterSetOptionValue >::linkWith ( CharacterSetOptionValue recipient) const
inlineinherited

Definition at line 137 of file Options.h.

◆ print() [1/2]

void Acl::TypedOption< CharacterSetOptionValue >::print ( std::ostream &  os) const
inlinevirtualinherited

Implements Acl::Option.

Definition at line 34 of file CharacterSetOption.h.

◆ print() [2/2]

virtual void Acl::TypedOption< CharacterSetOptionValue >::print ( std::ostream &  os) const
inlineoverridevirtualinherited

Implements Acl::Option.

Definition at line 181 of file Options.h.

◆ unconfigure() [1/2]

virtual void Acl::Option::unconfigure ( ) const
pure virtualinherited

◆ unconfigure() [2/2]

virtual void Acl::TypedOption< CharacterSetOptionValue >::unconfigure
inlineoverridevirtualinherited

Definition at line 149 of file Options.h.

◆ valued() [1/2]

virtual bool Acl::Option::valued ( ) const
pure virtualinherited

◆ valued() [2/2]

virtual bool Acl::TypedOption< CharacterSetOptionValue >::valued
inlineoverridevirtualinherited

Definition at line 147 of file Options.h.

Member Data Documentation

◆ offName

const char* const Acl::Option::offName = nullptr
inherited

A name that must be used to explicitly disable this Option (optional). Nil for (and only for) options that cannot be disabled().

Definition at line 92 of file Options.h.

Referenced by Acl::TypedOption< CharacterSetOptionValue >::disabled(), and Acl::TypedOption< CharacterSetOptionValue >::print().

◆ onName

const char* const Acl::Option::onName = nullptr
inherited

◆ recipient_

CharacterSetOptionValue * Acl::TypedOption< CharacterSetOptionValue >::recipient_
mutableprivateinherited

Definition at line 196 of file Options.h.

◆ valueExpectation

ValueExpectation Acl::Option::valueExpectation = valueNone
inherited

Definition at line 94 of file Options.h.


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

 

Introduction

Documentation

Support

Miscellaneous

Web Site Translations

Mirrors