#include <CommandLine.h>

Inheritance diagram for llvm::cl::Option:

Collaboration diagram for llvm::cl::Option:

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 ()
Option *	getNextRegisteredOption () const
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
OptionCategory *	Category
Protected Member Functions
	Option (enum NumOccurrencesFlag OccurrencesFlag, enum OptionHidden Hidden)
void	setNumAdditionalVals (unsigned n)
Friends
class	alias

Detailed Description

Definition at line 162 of file CommandLine.h.

Constructor & Destructor Documentation

llvm::cl::Option::Option	(	enum NumOccurrencesFlag	OccurrencesFlag,
		enum OptionHidden	Hidden
	)		`[inline, explicit, protected]`

Definition at line 237 of file CommandLine.h.

virtual llvm::cl::Option::~Option ( ) [inline, virtual]

Definition at line 281 of file CommandLine.h.

Member Function Documentation

void Option::addArgument ( )

Definition at line 107 of file CommandLine.cpp.

References llvm::cl::MarkOptionsChanged(), and RegisteredOptionList.

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

Definition at line 1096 of file CommandLine.cpp.

References llvm::cl::ConsumeAfter, error(), getNumOccurrencesFlag(), llvm::cl::OneOrMore, llvm::cl::Required, and llvm::cl::ZeroOrMore.

Referenced by CommaSeparateAndAddOccurrence().

bool Option::error	(	const Twine &	Message,
		StringRef	ArgName = `StringRef()`
	)

Definition at line 1085 of file CommandLine.cpp.

References ArgStr, llvm::StringRef::data(), llvm::StringRef::empty(), llvm::errs(), HelpStr, and ProgramName.

Referenced by addOccurrence(), llvm::cl::parser< const PassInfo * >::parse(), llvm::cl::ParseCommandLineOptions(), parseDouble(), ProvideOption(), llvm::cl::alias::setAliasFor(), llvm::cl::opt_storage< DataType, ExternalStorage, std::is_class< DataType >::value >::setLocation(), llvm::cl::list_storage< DataType, Storage >::setLocation(), and llvm::cl::bits_storage< DataType, Storage >::setLocation().

virtual void llvm::cl::Option::getExtraOptionNames ( SmallVectorImpl< const char * > & ) [inline, virtual]

Definition at line 269 of file CommandLine.h.

Referenced by GetOptionInfo(), and LookupNearestOption().

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

Definition at line 209 of file CommandLine.h.

Referenced by HandlePrefixedOrGroupedOption(), isGrouping(), isPrefixedOrGrouping(), and llvm::cl::ParseCommandLineOptions().

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

Definition at line 212 of file CommandLine.h.

Referenced by CommaSeparateAndAddOccurrence(), and llvm::cl::ParseCommandLineOptions().

Option* llvm::cl::Option::getNextRegisteredOption ( ) const [inline]

Definition at line 257 of file CommandLine.h.

Referenced by GetOptionInfo().

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

Definition at line 216 of file CommandLine.h.

Referenced by ProvideOption().

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

Definition at line 280 of file CommandLine.h.

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

Definition at line 199 of file CommandLine.h.

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

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

Definition at line 206 of file CommandLine.h.

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

unsigned llvm::cl::Option::getPosition ( ) const [inline]

Definition at line 215 of file CommandLine.h.

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

Definition at line 202 of file CommandLine.h.

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

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

Definition at line 219 of file CommandLine.h.

References ArgStr.

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

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

References llvm::cl::MarkOptionsChanged(), and RegisteredOptionList.

void llvm::cl::Option::setArgStr ( const char * S ) [inline]

Definition at line 224 of file CommandLine.h.

References ArgStr.

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

Definition at line 235 of file CommandLine.h.

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

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

Definition at line 225 of file CommandLine.h.

References HelpStr.

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

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

Definition at line 232 of file CommandLine.h.

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

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

Definition at line 231 of file CommandLine.h.

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

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

Definition at line 233 of file CommandLine.h.

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

void llvm::cl::Option::setNumAdditionalVals ( unsigned n ) [inline, protected]

Reimplemented in llvm::cl::list< DataType, Storage, ParserClass >.

Definition at line 245 of file CommandLine.h.

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

Definition at line 227 of file CommandLine.h.

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

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

Definition at line 234 of file CommandLine.h.

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

Definition at line 230 of file CommandLine.h.

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

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

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

Member Data Documentation

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

Definition at line 194 of file CommandLine.h.

Referenced by error(), llvm::cl::generic_parser_base::getOptionWidth(), llvm::cl::basic_parser_impl::getOptionWidth(), hasArgStr(), LookupNearestOption(), llvm::cl::ParseCommandLineOptions(), 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 setArgStr().

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

Definition at line 197 of file CommandLine.h.

Referenced by setCategory().

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

Definition at line 195 of file CommandLine.h.

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

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

Definition at line 196 of file CommandLine.h.

Referenced by getValueStr(), and setValueStr().

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

Public Member Functions

Public Attributes

Protected Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation