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

#include "llvm/Support/CommandLine.h"

Inheritance diagram for llvm::cl::Option:
Inheritance graph
Collaboration diagram for llvm::cl::Option:
Collaboration graph

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
bool isPositional () const
bool isSink () const
bool isConsumeAfter () const
bool isInAllSubCommands () const
void setArgStr (StringRef S)
void setDescription (StringRef S)
void setValueStr (StringRef 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 addSubCommand (SubCommand &S)
virtual ~Option ()=default
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 setDefault ()=0
virtual void getExtraOptionNames (SmallVectorImpl< StringRef > &)
virtual bool addOccurrence (unsigned pos, StringRef ArgName, StringRef Value, bool MultiArg=false)
bool error (const Twine &Message, StringRef ArgName=StringRef(), raw_ostream &Errs=llvm::errs())
bool error (const Twine &Message, raw_ostream &Errs)
int getNumOccurrences () const
void reset ()

Static Public Member Functions

static void printHelpStr (StringRef HelpStr, size_t Indent, size_t FirstLineIndentedBy)

Public Attributes

StringRef ArgStr
StringRef HelpStr
StringRef ValueStr
SmallPtrSet< SubCommand *, 4 > Subs
bool FullyInitialized = false

Protected Member Functions

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


class alias

Detailed Description

Definition at line 247 of file CommandLine.h.

Constructor & Destructor Documentation

◆ Option()

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

Definition at line 336 of file CommandLine.h.

◆ ~Option()

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

Member Function Documentation

◆ addArgument()

void Option::addArgument ( )

Definition at line 355 of file CommandLine.cpp.

◆ addOccurrence()

bool Option::addOccurrence ( unsigned  pos,
StringRef  ArgName,
StringRef  Value,
bool  MultiArg = false 

◆ addSubCommand()

void llvm::cl::Option::addSubCommand ( SubCommand S)

Definition at line 333 of file CommandLine.h.

References llvm::SmallPtrSetImpl< PtrType >::insert().

◆ error() [1/2]

bool Option::error ( const Twine Message,
StringRef  ArgName = StringRef(),
raw_ostream Errs = llvm::errs() 

◆ error() [2/2]

bool llvm::cl::Option::error ( const Twine Message,
raw_ostream Errs 

Definition at line 380 of file CommandLine.h.

References error.

◆ getExtraOptionNames()

virtual void llvm::cl::Option::getExtraOptionNames ( SmallVectorImpl< StringRef > &  )

Definition at line 371 of file CommandLine.h.

References error, and llvm::errs().

Referenced by llvm::cl::basic_parser_impl::anchor(), and LookupNearestOption().

◆ getFormattingFlag()

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

◆ getMiscFlags()

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

◆ getNumAdditionalVals()

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

Definition at line 303 of file CommandLine.h.

Referenced by ProvideOption().

◆ getNumOccurrences()

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

Definition at line 384 of file CommandLine.h.

Referenced by getSchedRegions(), and llvm::TargetPassConfig::TargetPassConfig().

◆ getNumOccurrencesFlag()

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

◆ getOptionHiddenFlag()

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

Definition at line 293 of file CommandLine.h.

◆ getOptionWidth()

virtual size_t llvm::cl::Option::getOptionWidth ( ) const
pure virtual

◆ getPosition()

unsigned llvm::cl::Option::getPosition ( ) const

Definition at line 302 of file CommandLine.h.

◆ getValueExpectedFlag()

enum ValueExpected llvm::cl::Option::getValueExpectedFlag ( ) const

◆ hasArgStr()

bool llvm::cl::Option::hasArgStr ( ) const

◆ isConsumeAfter()

bool llvm::cl::Option::isConsumeAfter ( ) const

Definition at line 310 of file CommandLine.h.

References llvm::cl::ConsumeAfter.

Referenced by llvm::cl::basic_parser_impl::anchor().

◆ isInAllSubCommands()

bool llvm::cl::Option::isInAllSubCommands ( ) const

◆ isPositional()

bool llvm::cl::Option::isPositional ( ) const

Definition at line 307 of file CommandLine.h.

References llvm::cl::Positional.

Referenced by llvm::cl::basic_parser_impl::anchor().

◆ isSink()

bool llvm::cl::Option::isSink ( ) const

Definition at line 308 of file CommandLine.h.

References llvm::cl::Sink.

Referenced by llvm::cl::basic_parser_impl::anchor().

◆ printHelpStr()

void Option::printHelpStr ( StringRef  HelpStr,
size_t  Indent,
size_t  FirstLineIndentedBy 

◆ printOptionInfo()

virtual void llvm::cl::Option::printOptionInfo ( size_t  GlobalWidth) const
pure virtual

◆ printOptionValue()

virtual void llvm::cl::Option::printOptionValue ( size_t  GlobalWidth,
bool  Force 
) const
pure virtual

◆ removeArgument()

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 360 of file CommandLine.cpp.

◆ reset()

void llvm::cl::Option::reset ( )

Definition at line 385 of file CommandLine.h.

◆ setArgStr()

void Option::setArgStr ( StringRef  S)

Definition at line 362 of file CommandLine.cpp.

References assert(), llvm::StringRef::empty(), and llvm::cl::GeneralCategory.

◆ setCategory()

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

Definition at line 332 of file CommandLine.h.

References C.

◆ setDefault()

virtual void llvm::cl::Option::setDefault ( )
pure virtual

◆ setDescription()

void llvm::cl::Option::setDescription ( StringRef  S)

Definition at line 324 of file CommandLine.h.

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

◆ setFormattingFlag()

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

Definition at line 329 of file CommandLine.h.

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

◆ setHiddenFlag()

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

Definition at line 328 of file CommandLine.h.

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

◆ setMiscFlag()

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

Definition at line 330 of file CommandLine.h.

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

◆ setNumAdditionalVals()

void llvm::cl::Option::setNumAdditionalVals ( unsigned  n)

◆ setNumOccurrencesFlag()

void llvm::cl::Option::setNumOccurrencesFlag ( enum NumOccurrencesFlag  Val)

Definition at line 326 of file CommandLine.h.

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

◆ setPosition()

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

Definition at line 331 of file CommandLine.h.

◆ setValueExpectedFlag()

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

Definition at line 327 of file CommandLine.h.

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

◆ setValueStr()

void llvm::cl::Option::setValueStr ( StringRef  S)

Definition at line 325 of file CommandLine.h.

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

Friends And Related Function Documentation

◆ alias

friend class alias

Definition at line 248 of file CommandLine.h.

Member Data Documentation

◆ ArgStr

StringRef llvm::cl::Option::ArgStr

◆ Category

OptionCategory* llvm::cl::Option::Category

Definition at line 281 of file CommandLine.h.

Referenced by sortSubCommands().

◆ FullyInitialized

bool llvm::cl::Option::FullyInitialized = false

Definition at line 283 of file CommandLine.h.

◆ HelpStr

StringRef llvm::cl::Option::HelpStr

◆ Subs

SmallPtrSet<SubCommand *, 4> llvm::cl::Option::Subs

Definition at line 282 of file CommandLine.h.

Referenced by llvm::cl::basic_parser_impl::anchor().

◆ ValueStr

StringRef llvm::cl::Option::ValueStr

Definition at line 280 of file CommandLine.h.

Referenced by getValueStr().

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