LLVM: llvm:🆑:Option Class Reference (original) (raw)

#include "[llvm/Support/CommandLine.h](CommandLine%5F8h%5Fsource.html)"

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	isDefaultOption () const
bool	isConsumeAfter () 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	addCategory (OptionCategory &C)
void	addSubCommand (SubCommand &S)
virtual	~Option ()=default
void	addArgument ()
void	removeArgument ()
	Unregisters this option from the CommandLine system.
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)
static void	printEnumValHelpStr (StringRef HelpStr, size_t Indent, size_t FirstLineIndentedBy)

Public Attributes
StringRef	ArgStr
StringRef	HelpStr
StringRef	ValueStr
SmallVector< OptionCategory *, 1 >	Categories
SmallPtrSet< SubCommand *, 1 >	Subs

Definition at line 252 of file CommandLine.h.

Definition at line 337 of file CommandLine.h.

References Categories, llvm:🆑:getGeneralCategory(), llvm:🆑:Hidden, and llvm:🆑:NormalFormatting.

Referenced by llvm:🆑:alias::alias(), llvm:🆑:bits< DataType, Storage, ParserClass >::bits(), llvm:🆑:list< std::string, DebugCounter >::list(), llvm:🆑:opt< DataType, ExternalStorage, ParserClass >::opt(), and llvm:🆑:alias::setAliasFor().

◆ ~Option()

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

◆ addArgument()

void Option::addArgument	(	)

◆ addCategory()

◆ addOccurrence()

◆ addSubCommand()

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

◆ error() [1/2]

◆ error() [2/2]

◆ getExtraOptionNames()

◆ getFormattingFlag()

◆ getMiscFlags()

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

◆ getNumAdditionalVals()

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

◆ getNumOccurrences()

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

◆ getNumOccurrencesFlag()

◆ getOptionHiddenFlag()

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

◆ getOptionWidth()

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

◆ getPosition()

unsigned llvm:🆑:Option::getPosition ( ) const	inline

◆ getValueExpectedFlag()

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

◆ hasArgStr()

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

◆ isConsumeAfter()

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

◆ isDefaultOption()

bool llvm:🆑:Option::isDefaultOption ( ) const	inline

◆ isPositional()

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

◆ isSink()

bool llvm:🆑:Option::isSink ( ) const	inline

◆ printEnumValHelpStr()

void Option::printEnumValHelpStr ( StringRef HelpStr, size_t Indent, size_t FirstLineIndentedBy )	static

◆ printHelpStr()

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

◆ printOptionInfo()

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

◆ printOptionValue()

virtual void llvm:🆑: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 456 of file CommandLine.cpp.

References GlobalParser.

Referenced by reset(), and ~Option().

◆ reset()

◆ setArgStr()

◆ setDefault()

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

◆ setDescription()

void llvm:🆑:Option::setDescription ( StringRef S)	inline

◆ setFormattingFlag()

◆ setHiddenFlag()

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

◆ setMiscFlag()

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

◆ setNumAdditionalVals()

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

◆ setNumOccurrencesFlag()

◆ setPosition()

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

◆ setValueExpectedFlag()

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

◆ setValueStr()

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