oahHandler Class Reference

Inheritance diagram for oahHandler:

Public Member Functions
string	getHandlerHeader () const
string	getOptionsHandlerValuesHeader () const
string	getHandlerSummaryShortName () const
string	getHandlerSummaryLongName () const
string	getHandlerPreamble () const
string	getHandlerUsage () const
string	getExecutableName () const
ostream &	getHandlerLogOstream ()
oahOptionalValuesStyleKind &	getHandlerOptionalValuesStyleKind ()
const list< S_oahElement > &	getHandlerRegisteredElementsList () const
const list< S_oahElement > &	getHandlerCommandLineElementsList () const
const multiset< S_oahElement, compareOahElements > &	getHandlerCommandLineElementsMultiset () const
int	getMaximumShortNameWidth () const
int	getMaximumLongNameWidth () const
int	getMaximumSubGroupsHeadersSize () const
virtual void	checkOptionsConsistency ()
void	appendPrefixToHandler (S_oahPrefix prefix)
S_oahPrefix	fetchPrefixInMapByItsName (string prefixName)
void	appendGroupToHandler (S_oahGroup oahGroup)
void	prependGroupToHandler (S_oahGroup oahGroup)
void	registerElementInHandler (S_oahElement element)
void	registerHandlerInItself ()
S_oahPrefix	fetchPrefixFromMap (string name) const
S_oahElement	fetchElementFromMap (string name) const
void	handlePrefixName (string prefixName, size_t equalsSignPosition, string stringAfterEqualsSign)
bool	optionNameIsASingleCharacterOptionsCluster (string optionName)
const vector< string >	decipherOptionsAndArguments (int argc, char *argv[])
string	decipherOption (string currentString)
void	decipherOptionContainingEqualSign (string currentOptionName, size_t equalsSignPosition)
virtual void	acceptIn (basevisitor *v)
virtual void	acceptOut (basevisitor *v)
virtual void	browseData (basevisitor *v)
string	commandLineAsSuppliedAsString () const
string	commandLineWithShortNamesAsString () const
string	commandLineWithLongNamesAsString () const
void	print (ostream &os) const
void	printHelp (ostream &os)
void	printOptionsSummary (ostream &os) const
void	printOptionsSummary () const
void	printHandlerAndGroupAndSubGroupSpecificHelp (ostream &os, S_oahSubGroup subGroup) const
void	printOptionNameIntrospectiveHelp (ostream &os, string name) const
void	printAllOahCommandLineValues (ostream &os) const
void	setOptionsHandlerFoundAHelpOption ()
bool	getOptionsHandlerFoundAHelpOption () const
Public Member Functions inherited from oahElement
void	setHandlerUpLink (S_oahHandler handlerUpLink)
S_oahHandler	getHandlerUpLink () const
string	getShortName () const
string	getLongName () const
string	getDescription () const
oahElementVisibilityKind	getElementVisibilityKind () const
void	setIsHidden ()
bool	getIsHidden () const
void	setMultipleOccurrencesAllowed ()
bool	getMultipleOccurrencesAllowed () const
string	fetchNames () const
string	fetchNamesInColumns (int subGroupsShortNameFieldWidth) const
string	fetchNamesBetweenParentheses () const
string	fetchNamesInColumnsBetweenParentheses (int subGroupsShortNameFieldWidth) const
virtual int	fetchVariableNameLength () const
S_oahElement	fetchOptionByName (string name)
virtual S_oahValuedAtom	handleOptionUnderName (string optionName, ostream &os)
virtual void	acceptIn (basevisitor *v)
virtual void	acceptOut (basevisitor *v)
virtual void	browseData (basevisitor *v)
virtual string	asShortNamedOptionString () const
virtual string	asActualLongNamedOptionString () const
string	asLongNamedOptionString () const
string	asString () const
virtual void	printOptionHeader (ostream &os) const
virtual void	printOptionEssentials (ostream &os, int fieldWidth) const
virtual void	print (ostream &os) const
virtual void	printHelp (ostream &os)
Public Member Functions inherited from smartable
unsigned	refs () const
	gives the reference count of the object
void	addReference ()
	addReference increments the ref count and checks for refCount overflow
void	removeReference ()
	removeReference delete the object when refCount is zero

Protected Member Functions
	oahHandler (string handlerHeader, string handlerValuesHeader, string handlerShortName, string handlerLongName, string handlerSummaryShortName, string handlerSummaryLongName, string handlerPreamble, string handlerUsage, string handlerDescription, indentedOstream &handlerLogOstream)
Protected Member Functions inherited from oahElement
	oahElement (string shortName, string longName, string description, oahElementVisibilityKind optionVisibilityKind)
Protected Member Functions inherited from smartable
	smartable (const smartable &)
virtual	~smartable ()
	destructor checks for non-zero refCount
smartable &	operator= (const smartable &)

Protected Attributes
string	fCommandLineAsSupplied
string	fHandlerHeader
string	fHandlerValuesHeader
string	fHandlerSummaryShortName
string	fHandlerSummaryLongName
string	fHandlerPreamble
string	fHandlerUsage
map< string, S_oahPrefix >	fHandlerPrefixesMap
set< string >	fSingleCharacterShortNamesSet
list< S_oahGroup >	fHandlerGroupsList
map< string, S_oahElement >	fHandlerElementsMap
vector< string >	fHandlerArgumentsVector
string	fHandlerExecutableName
oahOptionalValuesStyleKind	fHandlerOptionalValuesStyleKind
ostream &	fHandlerLogOstream
bool	fHandlerFoundAHelpOption
Protected Attributes inherited from oahElement
S_oahHandler	fHandlerUpLink
string	fShortName
string	fLongName
string	fDescription
oahElementVisibilityKind	fElementVisibilityKind
bool	fIsHidden
bool	fMultipleOccurrencesAllowed

Additional Inherited Members
Static Public Member Functions inherited from oahElement
static SMARTP< oahElement >	create (string shortName, string longName, string description, oahElementVisibilityKind optionVisibilityKind)

Member Function Documentation

acceptIn()

virtual void acceptIn ( basevisitor *  v )

virtual

Reimplemented from oahElement.

acceptOut()

virtual void acceptOut ( basevisitor *  v )

virtual

Reimplemented from oahElement.

browseData()

virtual void browseData ( basevisitor *  v )

virtual

Reimplemented from oahElement.

print()

void print ( ostream &  os ) const

virtual

Reimplemented from oahElement.

printHelp()

void printHelp ( ostream &  os )

virtual

Reimplemented from oahElement.