TCLAP::DocBookOutput Class Reference

Detailed Description

A class that generates DocBook output for usage() method for the given CmdLine and its Args.

Definition at line 50 of file DocBookOutput.h.

#include <mrpt/otherlibs/tclap/DocBookOutput.h>

Inheritance diagram for TCLAP::DocBookOutput:

Public Member Functions
virtual void	usage (CmdLineInterface &c)
	Prints the usage to stdout. More...
virtual void	version (CmdLineInterface &c)
	Prints the version to stdout. More...
virtual void	failure (CmdLineInterface &c, ArgException &e)
	Prints (to stderr) an error message, short usage Can be overridden to produce alternative behavior. More...

Protected Member Functions
void	substituteSpecialChars (std::string &s, char r, std::string &x)
	Substitutes the char r for string x in string s. More...
void	removeChar (std::string &s, char r)
void	printShortArg (Arg *it)
void	printLongArg (Arg *it)

Member Function Documentation

void TCLAP::DocBookOutput::failure ( CmdLineInterface &  c, ArgException &  e  )

inlinevirtual

Prints (to stderr) an error message, short usage Can be overridden to produce alternative behavior.

Parameters

c	- The CmdLine object the output is generated for.
e	- The ArgException that caused the failure.

Implements TCLAP::CmdLineOutput.

Definition at line 199 of file DocBookOutput.h.

References TCLAP::ArgException::what().

void TCLAP::DocBookOutput::printLongArg ( Arg *  it )

inlineprotected

Definition at line 253 of file DocBookOutput.h.

References TCLAP::Arg::getDescription(), TCLAP::Arg::longID(), removeChar(), and substituteSpecialChars().

Referenced by usage().

void TCLAP::DocBookOutput::printShortArg ( Arg *  it )

inlineprotected

Definition at line 226 of file DocBookOutput.h.

References TCLAP::Arg::acceptsMultipleValues(), TCLAP::Arg::isRequired(), removeChar(), TCLAP::Arg::shortID(), and substituteSpecialChars().

Referenced by usage().

void TCLAP::DocBookOutput::removeChar ( std::string &  s, char  r  )

inlineprotected

Definition at line 217 of file DocBookOutput.h.

Referenced by printLongArg(), and printShortArg().

void TCLAP::DocBookOutput::substituteSpecialChars ( std::string &  s, char  r, std::string &  x  )

inlineprotected

Substitutes the char r for string x in string s.

Parameters

s	- The string to operate on.
r	- The char to replace.
x	- What to replace r with.

Definition at line 205 of file DocBookOutput.h.

Referenced by printLongArg(), and printShortArg().

void TCLAP::DocBookOutput::usage ( CmdLineInterface &  c )

inlinevirtual

Prints the usage to stdout.

Can be overridden to produce alternative behavior.

Parameters

c	- The CmdLine object the output is generated for.

Implements TCLAP::CmdLineOutput.

Definition at line 99 of file DocBookOutput.h.

References begin(), TCLAP::XorHandler::contains(), TCLAP::CmdLineInterface::getArgList(), TCLAP::CmdLineInterface::getMessage(), TCLAP::CmdLineInterface::getProgramName(), TCLAP::CmdLineInterface::getVersion(), TCLAP::CmdLineInterface::getXorHandler(), TCLAP::XorHandler::getXorList(), printLongArg(), printShortArg(), and version().

void TCLAP::DocBookOutput::version ( CmdLineInterface &  c )

inlinevirtual

Prints the version to stdout.

Can be overridden to produce alternative behavior.

Parameters

c	- The CmdLine object the output is generated for.

Implements TCLAP::CmdLineOutput.

Definition at line 94 of file DocBookOutput.h.

References TCLAP::CmdLineInterface::getVersion().

Referenced by usage().