llvm::cl::Option Class Reference

#include <CommandLine.h>

Inheritance diagram for llvm::cl::Option:

[legend]

Collaboration diagram for llvm::cl::Option:

[legend]

List of all members.

Public Member Functions
enum NumOccurrences	getNumOccurrencesFlag () const
enum ValueExpected	getValueExpectedFlag () const
enum OptionHidden	getOptionHiddenFlag () const
enum FormattingFlags	getFormattingFlag () const
unsigned	getMiscFlags () const
unsigned	getPosition () const
bool	hasArgStr () const
void	setArgStr (const char *S)
void	setDescription (const char *S)
void	setValueStr (const char *S)
void	setFlag (unsigned Flag, unsigned FlagMask)
void	setNumOccurrencesFlag (enum NumOccurrences 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	addArgument ()
Option *	getNextRegisteredOption () const
virtual size_t	getOptionWidth () const =0
virtual void	printOptionInfo (size_t GlobalWidth) const =0
virtual void	getExtraOptionNames (std::vector< const char * > &)
bool	addOccurrence (unsigned pos, const char *ArgName, const std::string &Value)
bool	error (std::string Message, const char *ArgName=0)
int	getNumOccurrences () const
virtual	~Option ()
Public Attributes
const char *	ArgStr
const char *	HelpStr
const char *	ValueStr
Protected Member Functions
	Option (unsigned DefaultFlags)
Friends
class	alias

---

Detailed Description

Definition at line 138 of file CommandLine.h.

---

Constructor & Destructor Documentation

llvm::cl::Option::Option

(

unsigned

DefaultFlags

)

[inline, explicit, protected]

Definition at line 207 of file CommandLine.h.

References getNumOccurrencesFlag(), and getOptionHiddenFlag().

virtual llvm::cl::Option::~Option

(

)

[inline, virtual]

Definition at line 241 of file CommandLine.h.

---

Member Function Documentation

enum NumOccurrences llvm::cl::Option::getNumOccurrencesFlag

(

)

const [inline]

Definition at line 164 of file CommandLine.h.

References llvm::cl::OccurrencesMask.

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

enum ValueExpected llvm::cl::Option::getValueExpectedFlag

(

)

const [inline]

Definition at line 167 of file CommandLine.h.

References llvm::cl::ValueMask, and VE.

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

enum OptionHidden llvm::cl::Option::getOptionHiddenFlag

(

)

const [inline]

Definition at line 172 of file CommandLine.h.

References llvm::cl::HiddenMask.

Referenced by Option().

enum FormattingFlags llvm::cl::Option::getFormattingFlag

(

)

const [inline]

Definition at line 175 of file CommandLine.h.

References llvm::cl::FormattingMask.

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

unsigned llvm::cl::Option::getMiscFlags

(

)

const [inline]

Definition at line 178 of file CommandLine.h.

References llvm::cl::MiscMask.

Referenced by llvm::cl::ParseCommandLineOptions().

unsigned llvm::cl::Option::getPosition

(

)

const [inline]

Definition at line 181 of file CommandLine.h.

References Position.

bool llvm::cl::Option::hasArgStr

(

)

const [inline]

Definition at line 184 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().

void llvm::cl::Option::setArgStr

(

const char *

S

)

[inline]

Definition at line 189 of file CommandLine.h.

References ArgStr.

void llvm::cl::Option::setDescription

(

const char *

S

)

[inline]

Definition at line 190 of file CommandLine.h.

References HelpStr.

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

void llvm::cl::Option::setValueStr

(

const char *

S

)

[inline]

Definition at line 191 of file CommandLine.h.

References ValueStr.

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

void llvm::cl::Option::setFlag	(	unsigned	Flag,
		unsigned	FlagMask
	)			[inline]

Definition at line 193 of file CommandLine.h.

Referenced by setFormattingFlag(), setHiddenFlag(), setMiscFlag(), setNumOccurrencesFlag(), and setValueExpectedFlag().

void llvm::cl::Option::setNumOccurrencesFlag

(

enum NumOccurrences

Val

)

[inline]

Definition at line 198 of file CommandLine.h.

References llvm::cl::OccurrencesMask, and setFlag().

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

void llvm::cl::Option::setValueExpectedFlag

(

enum ValueExpected

Val

)

[inline]

Definition at line 201 of file CommandLine.h.

References setFlag(), and llvm::cl::ValueMask.

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

void llvm::cl::Option::setHiddenFlag

(

enum OptionHidden

Val

)

[inline]

Definition at line 202 of file CommandLine.h.

References llvm::cl::HiddenMask, and setFlag().

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

void llvm::cl::Option::setFormattingFlag

(

enum FormattingFlags

V

)

[inline]

Definition at line 203 of file CommandLine.h.

References llvm::cl::FormattingMask, and setFlag().

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

void llvm::cl::Option::setMiscFlag

(

enum MiscFlags

M

)

[inline]

Definition at line 204 of file CommandLine.h.

References setFlag().

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

void llvm::cl::Option::setPosition

(

unsigned

pos

)

[inline]

Definition at line 205 of file CommandLine.h.

References Position.

void Option::addArgument

(

)

Definition at line 90 of file CommandLine.cpp.

References llvm::cl::MarkOptionsChanged().

Option* llvm::cl::Option::getNextRegisteredOption

(

)

const [inline]

Definition at line 219 of file CommandLine.h.

Referenced by GetOptionInfo().

virtual size_t llvm::cl::Option::getOptionWidth

(

)

const [pure virtual]

virtual void llvm::cl::Option::printOptionInfo

(

size_t

GlobalWidth

)

const [pure virtual]

virtual void llvm::cl::Option::getExtraOptionNames

(

std::vector< const char * > &

)

[inline, virtual]

Definition at line 229 of file CommandLine.h.

bool Option::addOccurrence	(	unsigned	pos,
		const char *	ArgName,
		const std::string &	Value
	)

Definition at line 740 of file CommandLine.cpp.

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

Referenced by ProvideOption().

bool Option::error	(	std::string	Message,
		const char *	ArgName = 0
	)

Definition at line 729 of file CommandLine.cpp.

References ArgStr, llvm::cerr(), HelpStr, and ProgramName.

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

int llvm::cl::Option::getNumOccurrences

(

)

const [inline]

Definition at line 240 of file CommandLine.h.

---

Friends And Related Function Documentation

friend class alias [friend]

Definition at line 139 of file CommandLine.h.

---

Member Data Documentation

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

Definition at line 160 of file CommandLine.h.

Referenced by error(), llvm::cl::generic_parser_base::getOptionWidth(), llvm::cl::basic_parser_impl::getOptionWidth(), hasArgStr(), llvm::cl::ParseCommandLineOptions(), llvm::cl::generic_parser_base::printOptionInfo(), llvm::cl::basic_parser_impl::printOptionInfo(), ProvidePositionalOption(), and setArgStr().

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

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

Referenced by getValueStr(), and setValueStr().

---

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

• CommandLine.h
• CommandLine.cpp