llvm::cl::opt< DataType, ExternalStorage, ParserClass > Class Template Reference

#include "llvm/Support/CommandLine.h"

Inheritance diagram for llvm::cl::opt< DataType, ExternalStorage, ParserClass >:

Public Member Functions
	opt (const opt &)=delete
opt &	operator= (const opt &)=delete
void	setInitialValue (const DataType &V)
ParserClass &	getParser ()
template<class T>
DataType &	operator= (const T &Val)
template<class T>
DataType &	operator= (T &&Val)
template<class... Mods>
	opt (const Mods &... Ms)
void	setCallback (std::function< void(const typename ParserClass::parser_data_type &)> CB)
Public Member Functions inherited from llvm::cl::Option
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 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 ()
Public Member Functions inherited from llvm::cl::opt_storage< DataType, false, std::is_class_v< DataType > >
	opt_storage ()=default
bool	setLocation (Option &O, DataType &L)
void	setValue (const T &V, bool initial=false)
DataType &	getValue ()
	operator DataType () const
const OptionValue< DataType > &	getDefault () const

Public Attributes
std::function< void(const typename ParserClass::parser_data_type &)>	Callback
Public Attributes inherited from llvm::cl::Option
StringRef	ArgStr
StringRef	HelpStr
StringRef	ValueStr
SmallVector< OptionCategory *, 1 >	Categories
SmallPtrSet< SubCommand *, 1 >	Subs

Additional Inherited Members
Static Public Member Functions inherited from llvm::cl::Option
static void	printHelpStr (StringRef HelpStr, size_t Indent, size_t FirstLineIndentedBy)
static void	printEnumValHelpStr (StringRef HelpStr, size_t Indent, size_t FirstLineIndentedBy)
Protected Member Functions inherited from llvm::cl::Option
	Option (enum NumOccurrencesFlag OccurrencesFlag, enum OptionHidden Hidden)
void	setNumAdditionalVals (unsigned n)

Detailed Description

template<class DataType, bool ExternalStorage = false, class ParserClass = parser<DataType>>
class llvm::cl::opt< DataType, ExternalStorage, ParserClass >

Definition at line 1427 of file CommandLine.h.

Constructor & Destructor Documentation

opt() [1/2]

template<class DataType, bool ExternalStorage = false, class ParserClass = parser<DataType>>

llvm::cl::opt< DataType, ExternalStorage, ParserClass >::opt ( const opt< DataType, ExternalStorage, ParserClass > & )

delete

References opt().

Referenced by operator=(), and opt().

opt() [2/2]

template<class DataType, bool ExternalStorage = false, class ParserClass = parser<DataType>>

template<class... Mods>

llvm::cl::opt< DataType, ExternalStorage, ParserClass >::opt ( const Mods &... Ms )

inlineexplicit

Definition at line 1506 of file CommandLine.h.

References llvm::cl::apply(), llvm::cl::NotHidden, llvm::cl::Option::Option(), and llvm::cl::Optional.

Member Function Documentation

getParser()

template<class DataType, bool ExternalStorage = false, class ParserClass = parser<DataType>>

ParserClass & llvm::cl::opt< DataType, ExternalStorage, ParserClass >::getParser ( )

inline

Definition at line 1491 of file CommandLine.h.

operator=() [1/3]

template<class DataType, bool ExternalStorage = false, class ParserClass = parser<DataType>>

opt & llvm::cl::opt< DataType, ExternalStorage, ParserClass >::operator= ( const opt< DataType, ExternalStorage, ParserClass > & )

delete

References opt().

operator=() [2/3]

template<class DataType, bool ExternalStorage = false, class ParserClass = parser<DataType>>

template<class T>

DataType & llvm::cl::opt< DataType, ExternalStorage, ParserClass >::operator= ( const T & Val )

inline

Definition at line 1493 of file CommandLine.h.

References Callback, llvm::cl::opt_storage< DataType, false, std::is_class_v< DataType > >::getValue(), llvm::cl::opt_storage< DataType, false, std::is_class_v< DataType > >::setValue(), and T.

operator=() [3/3]

template<class DataType, bool ExternalStorage = false, class ParserClass = parser<DataType>>

template<class T>

DataType & llvm::cl::opt< DataType, ExternalStorage, ParserClass >::operator= ( T && Val )

inline

Definition at line 1499 of file CommandLine.h.

References Callback, llvm::cl::opt_storage< DataType, false, std::is_class_v< DataType > >::getValue(), and T.

setCallback()

template<class DataType, bool ExternalStorage = false, class ParserClass = parser<DataType>>

void llvm::cl::opt< DataType, ExternalStorage, ParserClass >::setCallback ( std::function< void(const typename ParserClass::parser_data_type &)> CB )

inline

Definition at line 1512 of file CommandLine.h.

References Callback.

setInitialValue()

template<class DataType, bool ExternalStorage = false, class ParserClass = parser<DataType>>

void llvm::cl::opt< DataType, ExternalStorage, ParserClass >::setInitialValue ( const DataType & V )

inline

Definition at line 1489 of file CommandLine.h.

References llvm::cl::opt_storage< DataType, false, std::is_class_v< DataType > >::setValue().

Member Data Documentation

Callback

template<class DataType, bool ExternalStorage = false, class ParserClass = parser<DataType>>

std::function<void(const typename ParserClass::parser_data_type &)> llvm::cl::opt< DataType, ExternalStorage, ParserClass >::Callback

Initial value:

=
      [](const typename ParserClass::parser_data_type &) {}

Definition at line 1517 of file CommandLine.h.

Referenced by operator=(), operator=(), and setCallback().

---

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

• include/llvm/Support/CommandLine.h