GNU CommonC++
Public Types | Public Member Functions | Public Attributes | List of all members
ost::CommandOption Class Reference

CommandOption is the base class for all command line options. More...

#include <cmdoptns.h>

Inheritance diagram for ost::CommandOption:
ost::CommandOptionNoArg ost::CommandOptionWithArg ost::CommandOptionArg ost::CommandOptionCollect ost::CommandOptionRest

Public Types

enum  OptionType { hasArg , noArg , trailing , collect }
 OptionType is for denoting what type of option this is, with an arg, without an arg or the trailing args. More...
 

Public Member Functions

virtual ~CommandOption ()
 A virtual destructor just in case.
 
 CommandOption (const char *inOptionName, const char *inOptionLetter, const char *inDescription, OptionType inOptionType, bool inRequired=false, CommandOption **ppNext=&defaultCommandOptionList)
 CommandOption contructor.
 
virtual void foundOption (CommandOptionParse *cop, const char *value=0)
 foundOption is called by the CommandOptionParse object during the parsing of the command line options.
 
virtual void foundOption (CommandOptionParse *cop, const char **value, int num)
 foundOption is called by the CommandOptionParse object during the parsing of the command line options.
 
virtual void parseDone (CommandOptionParse *cop)
 Once parsing of command line options is complete, this method is called.
 
virtual void performTask (CommandOptionParse *cop)
 Once CommandOption objects have completed parsing and there are no errors they may have some specific tasks to perform.
 
virtual bool hasValue ()
 For fields with the required flag set, this method is used to determine if the Option has satisfied it's required status.
 

Public Attributes

const char * optionName
 Long option name, these will be preceded with "--" on the command line.
 
const char * optionLetter
 option letter, these will be preceded with "-" on the command line.
 
const char * description
 A short description of the option for Usage messages.
 
OptionType optionType
 This command option's OptionType.
 
bool required
 True if this parameter is required.
 
CommandOptionnext
 This next CommandOption in this list of options or nil if no more options exist.
 

Detailed Description

CommandOption is the base class for all command line options.

Command line options can be defined statically and used when constructing a command line parser onject using makeCommandOptionParse. This serves only as a base class to CommandOptionWithArg, CommandOptionRest or CommandOptionNoArg which can also be used to derive more complex classes or even entire applications.

Author
Gianni Mariani giann.nosp@m.i@ma.nosp@m.riani.nosp@m..ws
Examples
cmdlineopt.cpp.

Member Enumeration Documentation

◆ OptionType

OptionType is for denoting what type of option this is, with an arg, without an arg or the trailing args.

Option type

Enumerator
hasArg 

This option is associated with a value.

noArg 

This option is a flag only.

trailing 

Remaining of the command line arguments.

collect 

Collect values that are not a value to an option.

Constructor & Destructor Documentation

◆ ~CommandOption()

virtual ost::CommandOption::~CommandOption ( )
virtual

A virtual destructor just in case.

◆ CommandOption()

ost::CommandOption::CommandOption ( const char *  inOptionName,
const char *  inOptionLetter,
const char *  inDescription,
OptionType  inOptionType,
bool  inRequired = false,
CommandOption **  ppNext = &defaultCommandOptionList 
)

CommandOption contructor.

Note the default values for required and ppNext.

Parameters
inOptionNamelong option name
inOptionLettershort letter name
inDescriptionshort description of the option
inOptionTypethe type of this option
inRequiredtrue if option is required
ppNextthe linked list header

Member Function Documentation

◆ foundOption() [1/2]

virtual void ost::CommandOption::foundOption ( CommandOptionParse cop,
const char **  value,
int  num 
)
virtual

foundOption is called by the CommandOptionParse object during the parsing of the command line options.

Parameters
coppointer to the command option parser
valuean array of values of this option
numnumber of values in the array

Reimplemented in ost::CommandOptionWithArg.

◆ foundOption() [2/2]

virtual void ost::CommandOption::foundOption ( CommandOptionParse cop,
const char *  value = 0 
)
virtual

foundOption is called by the CommandOptionParse object during the parsing of the command line options.

Parameters
coppointer to the command option parser
valuethe value of this option

Reimplemented in ost::CommandOptionWithArg, and ost::CommandOptionNoArg.

◆ hasValue()

virtual bool ost::CommandOption::hasValue ( )
virtual

For fields with the required flag set, this method is used to determine if the Option has satisfied it's required status.

The default methods simply returns true if any values have been found. This could be specialized to return true based on some other criteria.

Reimplemented in ost::CommandOptionWithArg.

◆ parseDone()

virtual void ost::CommandOption::parseDone ( CommandOptionParse cop)
virtual

Once parsing of command line options is complete, this method is called.

This can be used to perform last minute checks on the options collected.

Parameters
coppointer to the command option parser

◆ performTask()

virtual void ost::CommandOption::performTask ( CommandOptionParse cop)
virtual

Once CommandOption objects have completed parsing and there are no errors they may have some specific tasks to perform.

PerformTask must return.

Parameters
coppointer to the command option parser

Member Data Documentation

◆ description

const char* ost::CommandOption::description

A short description of the option for Usage messages.

e.g. Usage: mycommand : blah -f, –file <DESCRIPTION here>

◆ next

CommandOption* ost::CommandOption::next

This next CommandOption in this list of options or nil if no more options exist.

◆ optionLetter

const char* ost::CommandOption::optionLetter

option letter, these will be preceded with "-" on the command line.

e.g. -f foo.x

◆ optionName

const char* ost::CommandOption::optionName

Long option name, these will be preceded with "--" on the command line.

e.g. –file foo.x

◆ optionType

OptionType ost::CommandOption::optionType

This command option's OptionType.

◆ required

bool ost::CommandOption::required

True if this parameter is required.

If the parameter is not supplied and required is true, an error will be flagged in the option processor.


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