LLVM  3.7.0
Public Member Functions | Public Attributes | Protected Member Functions | Friends | List of all members
llvm::cl::Option Class Referenceabstract

#include <CommandLine.h>

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

Public Member Functions

enum NumOccurrencesFlag getNumOccurrencesFlag () const
 
enum ValueExpected getValueExpectedFlag () const
 
enum OptionHidden getOptionHiddenFlag () const
 
enum FormattingFlags getFormattingFlag () const
 
unsigned getMiscFlags () const
 
unsigned getPosition () const
 
unsigned getNumAdditionalVals () const
 
bool hasArgStr () const
 
void setArgStr (const char *S)
 
void setDescription (const char *S)
 
void setValueStr (const char *S)
 
void setNumOccurrencesFlag (enum NumOccurrencesFlag 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 setCategory (OptionCategory &C)
 
void addArgument ()
 
void removeArgument ()
 Unregisters this option from the CommandLine system. More...
 
virtual size_t getOptionWidth () const =0
 
virtual void printOptionInfo (size_t GlobalWidth) const =0
 
virtual void printOptionValue (size_t GlobalWidth, bool Force) const =0
 
virtual void getExtraOptionNames (SmallVectorImpl< const char * > &)
 
virtual bool addOccurrence (unsigned pos, StringRef ArgName, StringRef Value, bool MultiArg=false)
 
bool error (const Twine &Message, StringRef ArgName=StringRef())
 
int getNumOccurrences () const
 
virtual ~Option ()
 

Public Attributes

const char * ArgStr
 
const char * HelpStr
 
const char * ValueStr
 
OptionCategoryCategory
 
bool FullyInitialized
 

Protected Member Functions

 Option (enum NumOccurrencesFlag OccurrencesFlag, enum OptionHidden Hidden)
 
void setNumAdditionalVals (unsigned n)
 

Friends

class alias
 

Detailed Description

Definition at line 178 of file CommandLine.h.

Constructor & Destructor Documentation

llvm::cl::Option::Option ( enum NumOccurrencesFlag  OccurrencesFlag,
enum OptionHidden  Hidden 
)
inlineexplicitprotected

Definition at line 249 of file CommandLine.h.

virtual llvm::cl::Option::~Option ( )
inlinevirtual

Definition at line 291 of file CommandLine.h.

Member Function Documentation

void Option::addArgument ( )

Definition at line 223 of file CommandLine.cpp.

References FullyInitialized, and GlobalParser.

bool Option::addOccurrence ( unsigned  pos,
StringRef  ArgName,
StringRef  Value,
bool  MultiArg = false 
)
virtual
bool Option::error ( const Twine Message,
StringRef  ArgName = StringRef() 
)
virtual void llvm::cl::Option::getExtraOptionNames ( SmallVectorImpl< const char * > &  )
inlinevirtual

Definition at line 279 of file CommandLine.h.

Referenced by LookupNearestOption().

enum FormattingFlags llvm::cl::Option::getFormattingFlag ( ) const
inline

Definition at line 224 of file CommandLine.h.

Referenced by HandlePrefixedOrGroupedOption(), isGrouping(), and isPrefixedOrGrouping().

unsigned llvm::cl::Option::getMiscFlags ( ) const
inline

Definition at line 227 of file CommandLine.h.

Referenced by CommaSeparateAndAddOccurrence().

unsigned llvm::cl::Option::getNumAdditionalVals ( ) const
inline

Definition at line 229 of file CommandLine.h.

Referenced by ProvideOption().

int llvm::cl::Option::getNumOccurrences ( ) const
inline

Definition at line 290 of file CommandLine.h.

enum NumOccurrencesFlag llvm::cl::Option::getNumOccurrencesFlag ( ) const
inline

Definition at line 215 of file CommandLine.h.

Referenced by addOccurrence(), EatsUnboundedNumberOfValues(), and RequiresValue().

enum OptionHidden llvm::cl::Option::getOptionHiddenFlag ( ) const
inline

Definition at line 221 of file CommandLine.h.

virtual size_t llvm::cl::Option::getOptionWidth ( ) const
pure virtual
unsigned llvm::cl::Option::getPosition ( ) const
inline

Definition at line 228 of file CommandLine.h.

enum ValueExpected llvm::cl::Option::getValueExpectedFlag ( ) const
inline
bool llvm::cl::Option::hasArgStr ( ) const
inline
virtual void llvm::cl::Option::printOptionInfo ( size_t  GlobalWidth) const
pure virtual
virtual void llvm::cl::Option::printOptionValue ( size_t  GlobalWidth,
bool  Force 
) const
pure virtual
void Option::removeArgument ( )

Unregisters this option from the CommandLine system.

This option must have been the last option registered. For testing purposes only.

Definition at line 228 of file CommandLine.cpp.

References GlobalParser.

void Option::setArgStr ( const char *  S)

Definition at line 230 of file CommandLine.cpp.

References ArgStr, FullyInitialized, and GlobalParser.

void llvm::cl::Option::setCategory ( OptionCategory C)
inline

Definition at line 246 of file CommandLine.h.

References llvm::CallingConv::C, and Category.

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

Definition at line 238 of file CommandLine.h.

References HelpStr.

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

void llvm::cl::Option::setFormattingFlag ( enum FormattingFlags  V)
inline

Definition at line 243 of file CommandLine.h.

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

void llvm::cl::Option::setHiddenFlag ( enum OptionHidden  Val)
inline

Definition at line 242 of file CommandLine.h.

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

void llvm::cl::Option::setMiscFlag ( enum MiscFlags  M)
inline

Definition at line 244 of file CommandLine.h.

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

void llvm::cl::Option::setNumAdditionalVals ( unsigned  n)
inlineprotected
void llvm::cl::Option::setNumOccurrencesFlag ( enum NumOccurrencesFlag  Val)
inline

Definition at line 240 of file CommandLine.h.

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

void llvm::cl::Option::setPosition ( unsigned  pos)
inline

Definition at line 245 of file CommandLine.h.

void llvm::cl::Option::setValueExpectedFlag ( enum ValueExpected  Val)
inline

Definition at line 241 of file CommandLine.h.

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

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

Definition at line 239 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 179 of file CommandLine.h.

Member Data Documentation

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

Definition at line 212 of file CommandLine.h.

Referenced by setCategory().

bool llvm::cl::Option::FullyInitialized

Definition at line 213 of file CommandLine.h.

Referenced by addArgument(), and setArgStr().

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

Definition at line 211 of file CommandLine.h.

Referenced by getValueStr(), and setValueStr().


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