TClap class used for generating docbook output. More...
#include <docbook_output.hpp>
Public Member Functions | |
virtual void | failure (CmdLineInterface &c, ArgException &e) |
virtual void | usage (CmdLineInterface &c) |
virtual void | version (CmdLineInterface &c) |
Protected Member Functions | |
void | printLongArg (Arg *it) |
void | printShortArg (Arg *it) |
void | removeChar (std::string &s, char r) |
void | substituteSpecialChars (std::string &s, char r, std::string &x) |
TClap class used for generating docbook output.
A class that generates DocBook output for usage() method for the given CmdLine and its Args.
Definition at line 37 of file docbook_output.hpp.
void ecl::DocBookOutput::failure | ( | CmdLineInterface & | c, |
ArgException & | e | ||
) | [inline, virtual] |
Prints (to stderr) an error message, short usage Can be overridden to produce alternative behavior.
c | - The CmdLine object the output is generated for. |
e | - The ArgException that caused the failure. |
Implements ecl::CmdLineOutput.
Definition at line 186 of file docbook_output.hpp.
void ecl::DocBookOutput::printLongArg | ( | Arg * | it | ) | [inline, protected] |
Definition at line 240 of file docbook_output.hpp.
void ecl::DocBookOutput::printShortArg | ( | Arg * | it | ) | [inline, protected] |
Definition at line 213 of file docbook_output.hpp.
void ecl::DocBookOutput::removeChar | ( | std::string & | s, |
char | r | ||
) | [inline, protected] |
Definition at line 204 of file docbook_output.hpp.
void ecl::DocBookOutput::substituteSpecialChars | ( | std::string & | s, |
char | r, | ||
std::string & | x | ||
) | [inline, protected] |
Substitutes the char r for string x in string s.
s | - The string to operate on. |
r | - The char to replace. |
x | - What to replace r with. |
Definition at line 192 of file docbook_output.hpp.
void ecl::DocBookOutput::usage | ( | CmdLineInterface & | c | ) | [inline, virtual] |
Prints the usage to stdout. Can be overridden to produce alternative behavior.
c | - The CmdLine object the output is generated for. |
Implements ecl::CmdLineOutput.
Definition at line 86 of file docbook_output.hpp.
void ecl::DocBookOutput::version | ( | CmdLineInterface & | c | ) | [inline, virtual] |
Prints the version to stdout. Can be overridden to produce alternative behavior.
c | - The CmdLine object the output is generated for. |
Implements ecl::CmdLineOutput.
Definition at line 81 of file docbook_output.hpp.