$search

TCLAP::ZshCompletionOutput Class Reference

#include <ZshCompletionOutput.h>

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

List of all members.

Public Member Functions

virtual void failure (CmdLineInterface &c, ArgException &e)
virtual void usage (CmdLineInterface &c)
virtual void version (CmdLineInterface &c)
 ZshCompletionOutput ()

Protected Member Functions

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

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.

Definition at line 43 of file ZshCompletionOutput.h.


Constructor & Destructor Documentation

TCLAP::ZshCompletionOutput::ZshCompletionOutput (  ) 

Definition at line 86 of file ZshCompletionOutput.h.


Member Function Documentation

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

Definition at line 155 of file ZshCompletionOutput.h.

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

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

Definition at line 271 of file ZshCompletionOutput.h.

void TCLAP::ZshCompletionOutput::printArg ( Arg it  )  [inline, protected]

Definition at line 164 of file ZshCompletionOutput.h.

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

Definition at line 190 of file ZshCompletionOutput.h.

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

Definition at line 136 of file ZshCompletionOutput.h.

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

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


Member Data Documentation

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

Definition at line 82 of file ZshCompletionOutput.h.

Definition at line 83 of file ZshCompletionOutput.h.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Properties Friends Defines


mapstitch
Author(s): Philipp M. Scholl
autogenerated on Tue Mar 5 13:42:15 2013