tclap  1.2.0
Public Member Functions | Protected Member Functions | Protected Attributes
TCLAP::ZshCompletionOutput Class Reference

A class that generates a Zsh completion function as output from the usage() method for the given CmdLine and its Args. More...

#include <ZshCompletionOutput.h>

Inheritance diagram for TCLAP::ZshCompletionOutput:
Inheritance graph
[legend]
Collaboration diagram for TCLAP::ZshCompletionOutput:
Collaboration graph
[legend]

List of all members.

Public Member Functions

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

Protected Member Functions

void basename (std::string &s)
void quoteSpecialChars (std::string &s)
std::string getMutexList (CmdLineInterface &_cmd, Arg *a)
void printOption (Arg *it, std::string mutex)
void printArg (Arg *it)

Protected Attributes

std::map< std::string,
std::string > 
common
char theDelimiter

Detailed Description

A class that generates a Zsh completion function as output from the usage() method for the given CmdLine and its Args.


Constructor & Destructor Documentation

TCLAP::ZshCompletionOutput::ZshCompletionOutput ( )

Definition at line 86 of file ZshCompletionOutput.h.

References common.


Member Function Documentation

void TCLAP::ZshCompletionOutput::basename ( std::string &  s) [inline, protected]

Definition at line 153 of file ZshCompletionOutput.h.

Referenced by usage().

void TCLAP::ZshCompletionOutput::failure ( CmdLineInterface c,
ArgException e 
) [inline, virtual]

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 127 of file ZshCompletionOutput.h.

References TCLAP::ArgException::what().

Here is the call graph for this function:

std::string TCLAP::ZshCompletionOutput::getMutexList ( CmdLineInterface _cmd,
Arg a 
) [inline, protected]
void TCLAP::ZshCompletionOutput::printArg ( Arg it) [inline, protected]

Definition at line 162 of file ZshCompletionOutput.h.

References TCLAP::Arg::acceptsMultipleValues(), TCLAP::Arg::isRequired(), TCLAP::Arg::getName(), and common.

Referenced by usage().

Here is the call graph for this function:

void TCLAP::ZshCompletionOutput::printOption ( Arg it,
std::string  mutex 
) [inline, protected]
void TCLAP::ZshCompletionOutput::quoteSpecialChars ( std::string &  s) [inline, protected]

Definition at line 134 of file ZshCompletionOutput.h.

Referenced by printOption().

void TCLAP::ZshCompletionOutput::usage ( CmdLineInterface c) [inline, virtual]

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 104 of file ZshCompletionOutput.h.

References TCLAP::CmdLineInterface::getArgList(), TCLAP::CmdLineInterface::getProgramName(), version(), TCLAP::CmdLineInterface::getVersion(), theDelimiter, TCLAP::CmdLineInterface::getDelimiter(), basename(), printArg(), printOption(), and getMutexList().

Here is the call graph for this function:

void TCLAP::ZshCompletionOutput::version ( CmdLineInterface c) [inline, virtual]

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 99 of file ZshCompletionOutput.h.

References TCLAP::CmdLineInterface::getVersion().

Referenced by usage().

Here is the call graph for this function:


Member Data Documentation

std::map<std::string, std::string> TCLAP::ZshCompletionOutput::common [protected]

Definition at line 82 of file ZshCompletionOutput.h.

Referenced by ZshCompletionOutput(), printArg(), and printOption().

Definition at line 83 of file ZshCompletionOutput.h.

Referenced by usage(), and printOption().


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