LLVM  8.0.1
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
[legend]
Collaboration diagram for llvm::cl::Option:
Collaboration graph
[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
 
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
 
OptionCategory * Category
 
SmallPtrSet< SubCommand *, 4 > Subs
 
bool FullyInitialized = false
 

Protected Member Functions

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

Friends

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 
)
inlineexplicitprotected

Definition at line 336 of file CommandLine.h.

◆ ~Option()

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

Member Function Documentation

◆ addArgument()

void Option::addArgument ( )

Definition at line 356 of file CommandLine.cpp.

◆ addOccurrence()

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

Definition at line 1450 of file CommandLine.cpp.

References llvm::cl::ConsumeAfter, error, LLVM_FALLTHROUGH, llvm::cl::OneOrMore, llvm::cl::Optional, llvm::cl::Required, and llvm::cl::ZeroOrMore.

Referenced by CommaSeparateAndAddOccurrence().

◆ addSubCommand()

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

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() 
)

Definition at line 1438 of file CommandLine.cpp.

References llvm::StringRef::data(), and llvm::StringRef::empty().

Referenced by llvm::cl::basic_parser_impl::anchor(), llvm::cl::parser< const PassInfo *>::parse(), parseDouble(), llvm::cl::basic_parser_impl::printOptionName(), ProvideOption(), llvm::cl::ResetAllOptionOccurrences(), llvm::cl::opt_storage< DataType, ExternalStorage, std::is_class< DataType >::value >::setLocation(), llvm::cl::list_storage< DataType, StorageClass >::setLocation(), and llvm::cl::bits_storage< DataType, Storage >::setLocation().

◆ error() [2/2]

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

Definition at line 380 of file CommandLine.h.

References error.

◆ getExtraOptionNames()

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

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
inline

Definition at line 297 of file CommandLine.h.

Referenced by llvm::cl::basic_parser_impl::anchor(), HandlePrefixedOrGroupedOption(), isGrouping(), isPrefixedOrGrouping(), ProvideOption(), and llvm::cl::ResetAllOptionOccurrences().

◆ getMiscFlags()

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

Definition at line 301 of file CommandLine.h.

Referenced by llvm::cl::basic_parser_impl::anchor(), CommaSeparateAndAddOccurrence(), llvm::cl::basic_parser_impl::getOptionWidth(), llvm::cl::basic_parser_impl::printOptionInfo(), and llvm::cl::ResetAllOptionOccurrences().

◆ getNumAdditionalVals()

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

Definition at line 303 of file CommandLine.h.

Referenced by ProvideOption().

◆ getNumOccurrences()

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

Definition at line 384 of file CommandLine.h.

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

◆ getNumOccurrencesFlag()

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

Definition at line 285 of file CommandLine.h.

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

◆ getOptionHiddenFlag()

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

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
inline

Definition at line 302 of file CommandLine.h.

◆ getValueExpectedFlag()

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

Definition at line 289 of file CommandLine.h.

Referenced by HandlePrefixedOrGroupedOption(), LookupNearestOption(), and ProvideOption().

◆ hasArgStr()

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

Definition at line 306 of file CommandLine.h.

References llvm::StringRef::empty().

Referenced by llvm::cl::basic_parser_impl::anchor(), llvm::cl::generic_parser_base::getOptionWidth(), LookupNearestOption(), llvm::cl::generic_parser_base::printOptionInfo(), and llvm::cl::ResetAllOptionOccurrences().

◆ isConsumeAfter()

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

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
inline

Definition at line 314 of file CommandLine.h.

References llvm::cl::AllSubCommands, llvm::any_of(), and llvm::PPCISD::SC.

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

◆ isPositional()

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

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
inline

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 
)
static

Definition at line 1489 of file CommandLine.cpp.

References llvm::raw_ostream::indent(), llvm::outs(), Split(), and llvm::StringRef::split().

Referenced by llvm::cl::generic_parser_base::printOptionInfo(), and llvm::cl::basic_parser_impl::printOptionInfo().

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

◆ reset()

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

Definition at line 385 of file CommandLine.h.

◆ setArgStr()

void Option::setArgStr ( StringRef  S)

Definition at line 363 of file CommandLine.cpp.

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

◆ setCategory()

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

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)
inline

Definition at line 324 of file CommandLine.h.

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

◆ setFormattingFlag()

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

Definition at line 329 of file CommandLine.h.

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

◆ setHiddenFlag()

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

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)
inline

Definition at line 330 of file CommandLine.h.

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

◆ setNumAdditionalVals()

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

Definition at line 341 of file CommandLine.h.

References Indent.

Referenced by llvm::cl::list< DataType, StorageClass, ParserClass >::setNumAdditionalVals().

◆ setNumOccurrencesFlag()

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

Definition at line 326 of file CommandLine.h.

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

◆ setPosition()

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

Definition at line 331 of file CommandLine.h.

◆ setValueExpectedFlag()

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

Definition at line 327 of file CommandLine.h.

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

◆ setValueStr()

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

Definition at line 325 of file CommandLine.h.

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

Friends And Related Function Documentation

◆ alias

friend class alias
friend

Definition at line 248 of file CommandLine.h.

Member Data Documentation

◆ ArgStr

StringRef llvm::cl::Option::ArgStr

Definition at line 278 of file CommandLine.h.

Referenced by llvm::cl::basic_parser_impl::anchor(), llvm::cl::generic_parser_base::getOptionWidth(), llvm::cl::basic_parser_impl::getOptionWidth(), LookupNearestOption(), llvm::cl::generic_parser_base::printGenericOptionDiff(), llvm::cl::generic_parser_base::printOptionInfo(), llvm::cl::basic_parser_impl::printOptionInfo(), llvm::cl::basic_parser_impl::printOptionName(), ProvidePositionalOption(), and llvm::cl::ResetAllOptionOccurrences().

◆ 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

Definition at line 279 of file CommandLine.h.

Referenced by llvm::cl::generic_parser_base::printOptionInfo(), and llvm::cl::basic_parser_impl::printOptionInfo().

◆ 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:
Generated on Sun Dec 20 2020 14:14:44 for LLVM by   doxygen 1.8.13