LLVM API Documentation

Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages

llvm::cl::Option Class Reference

#include <CommandLine.h>

Inheritance diagram for llvm::cl::Option:

Inheritance graph
[legend]
Collaboration diagram for llvm::cl::Option:

Collaboration graph
[legend]
List of all members.

Public Member Functions

enum NumOccurrences getNumOccurrencesFlag () const
enum ValueExpected getValueExpectedFlag () const
enum OptionHidden getOptionHiddenFlag () const
enum FormattingFlags getFormattingFlag () const
unsigned getMiscFlags () const
unsigned getPosition () const
bool hasArgStr () const
void setArgStr (const char *S)
void setDescription (const char *S)
void setValueStr (const char *S)
void setFlag (unsigned Flag, unsigned FlagMask)
void setNumOccurrencesFlag (enum NumOccurrences Val)
void setValueExpectedFlag (enum ValueExpected Val)
void setHiddenFlag (enum OptionHidden Val)
void setFormattingFlag (enum FormattingFlags V)
void setMiscFlag (enum MiscFlags M)
void setPosition (unsigned pos)
void addArgument (const char *ArgStr)
void removeArgument (const char *ArgStr)
virtual unsigned getOptionWidth () const =0
virtual void printOptionInfo (unsigned GlobalWidth) const =0
bool addOccurrence (unsigned pos, const char *ArgName, const std::string &Value)
bool error (std::string Message, const char *ArgName=0)
int getNumOccurrences () const
virtual ~Option ()

Public Attributes

const char * ArgStr
const char * HelpStr
const char * ValueStr

Protected Member Functions

 Option ()

Friends

class alias
void ParseCommandLineOptions (int &, char **, const char *)

Detailed Description

Definition at line 121 of file CommandLine.h.


Constructor & Destructor Documentation

llvm::cl::Option::Option  )  [inline, protected]
 

Definition at line 206 of file CommandLine.h.

virtual llvm::cl::Option::~Option  )  [inline, virtual]
 

Definition at line 234 of file CommandLine.h.


Member Function Documentation

void llvm::cl::Option::addArgument const char *  ArgStr  ) 
 

Referenced by llvm::cl::generic_parser_base::initialize(), and llvm::PassNameParser::passRegistered().

bool llvm::cl::Option::addOccurrence unsigned  pos,
const char *  ArgName,
const std::string &  Value
 

bool llvm::cl::Option::error std::string  Message,
const char *  ArgName = 0
 

Referenced by llvm::cl::parser< const PassInfo * >::parse(), llvm::cl::alias::setAliasFor(), setFlag(), llvm::cl::list_storage< DataType, Storage >::setLocation(), and llvm::cl::opt_storage< DataType, ExternalStorage, is_class< DataType >::value >::setLocation().

enum FormattingFlags llvm::cl::Option::getFormattingFlag  )  const [inline]
 

Definition at line 168 of file CommandLine.h.

References llvm::cl::FormattingMask.

unsigned llvm::cl::Option::getMiscFlags  )  const [inline]
 

Definition at line 173 of file CommandLine.h.

References llvm::cl::MiscMask.

int llvm::cl::Option::getNumOccurrences  )  const [inline]
 

Definition at line 233 of file CommandLine.h.

enum NumOccurrences llvm::cl::Option::getNumOccurrencesFlag  )  const [inline]
 

Definition at line 153 of file CommandLine.h.

References llvm::cl::OccurrencesMask.

enum OptionHidden llvm::cl::Option::getOptionHiddenFlag  )  const [inline]
 

Definition at line 163 of file CommandLine.h.

References llvm::cl::HiddenMask.

virtual unsigned llvm::cl::Option::getOptionWidth  )  const [pure virtual]
 

unsigned llvm::cl::Option::getPosition  )  const [inline]
 

Definition at line 176 of file CommandLine.h.

enum ValueExpected llvm::cl::Option::getValueExpectedFlag  )  const [inline]
 

Definition at line 158 of file CommandLine.h.

References llvm::cl::ValueMask.

bool llvm::cl::Option::hasArgStr  )  const [inline]
 

Definition at line 179 of file CommandLine.h.

References ArgStr.

Referenced by llvm::cl::generic_parser_base::initialize().

virtual void llvm::cl::Option::printOptionInfo unsigned  GlobalWidth  )  const [pure virtual]
 

void llvm::cl::Option::removeArgument const char *  ArgStr  ) 
 

Referenced by llvm::PassNameParser::passUnregistered().

void llvm::cl::Option::setArgStr const char *  S  )  [inline]
 

Definition at line 184 of file CommandLine.h.

References ArgStr.

void llvm::cl::Option::setDescription const char *  S  )  [inline]
 

Definition at line 185 of file CommandLine.h.

References HelpStr.

Referenced by llvm::cl::desc::apply().

void llvm::cl::Option::setFlag unsigned  Flag,
unsigned  FlagMask
[inline]
 

Definition at line 188 of file CommandLine.h.

References error().

Referenced by setFormattingFlag(), setHiddenFlag(), setMiscFlag(), setNumOccurrencesFlag(), and setValueExpectedFlag().

void llvm::cl::Option::setFormattingFlag enum FormattingFlags  V  )  [inline]
 

Definition at line 202 of file CommandLine.h.

References llvm::cl::FormattingMask, and setFlag().

Referenced by llvm::cl::applicator< FormattingFlags >::opt().

void llvm::cl::Option::setHiddenFlag enum OptionHidden  Val  )  [inline]
 

Definition at line 201 of file CommandLine.h.

References llvm::cl::HiddenMask, and setFlag().

Referenced by llvm::cl::applicator< OptionHidden >::opt().

void llvm::cl::Option::setMiscFlag enum MiscFlags  M  )  [inline]
 

Definition at line 203 of file CommandLine.h.

References setFlag().

Referenced by llvm::cl::applicator< MiscFlags >::opt().

void llvm::cl::Option::setNumOccurrencesFlag enum NumOccurrences  Val  )  [inline]
 

Definition at line 197 of file CommandLine.h.

References llvm::cl::OccurrencesMask, and setFlag().

Referenced by llvm::cl::applicator< NumOccurrences >::opt().

void llvm::cl::Option::setPosition unsigned  pos  )  [inline]
 

Definition at line 204 of file CommandLine.h.

void llvm::cl::Option::setValueExpectedFlag enum ValueExpected  Val  )  [inline]
 

Definition at line 200 of file CommandLine.h.

References setFlag(), and llvm::cl::ValueMask.

Referenced by llvm::cl::applicator< ValueExpected >::opt().

void llvm::cl::Option::setValueStr const char *  S  )  [inline]
 

Definition at line 186 of file CommandLine.h.

References ValueStr.

Referenced by llvm::cl::value_desc::apply().


Friends And Related Function Documentation

friend class alias [friend]
 

Definition at line 123 of file CommandLine.h.

void ParseCommandLineOptions int &  argc,
char **  argv,
const char *  Overview = 0
[friend]
 

Definition at line 286 of file CommandLine.cpp.


Member Data Documentation

const char* llvm::cl::Option::ArgStr
 

Definition at line 149 of file CommandLine.h.

Referenced by hasArgStr(), and setArgStr().

const char* llvm::cl::Option::HelpStr
 

Definition at line 150 of file CommandLine.h.

Referenced by setDescription().

const char* llvm::cl::Option::ValueStr
 

Definition at line 151 of file CommandLine.h.

Referenced by setValueStr().


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