llvm::cl::Option Class Reference

#include <CommandLine.h>

Inheritance diagram for llvm::cl::Option:

List of all members.

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	setFlag (unsigned Flag, unsigned FlagMask)
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	addArgument ()
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 * > &)
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
Protected Member Functions
	Option (unsigned DefaultFlags)
void	setNumAdditionalVals (unsigned n)
Private Member Functions
virtual bool	handleOccurrence (unsigned pos, StringRef ArgName, StringRef Arg)=0
virtual enum ValueExpected	getValueExpectedFlagDefault () const
virtual void	anchor ()
Private Attributes
int	NumOccurrences
int	Flags
unsigned	Position
unsigned	AdditionalVals
Option *	NextRegistered
Friends
class	alias

---

Constructor & Destructor Documentation

llvm::cl::Option::Option

(

unsigned

DefaultFlags

)

[inline, explicit, protected]

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

(

)

[inline, virtual]

---

Member Function Documentation

void Option::addArgument

(

)

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

void Option::anchor

(

)

[private, virtual]

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

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

(

SmallVectorImpl< const char * > &

)

[inline, virtual]

Reimplemented in llvm::cl::opt< DataType, ExternalStorage, ParserClass >, llvm::cl::list< DataType, Storage, ParserClass >, and llvm::cl::bits< DataType, Storage, ParserClass >.

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

(

)

const [inline]

unsigned llvm::cl::Option::getMiscFlags

(

)

const [inline]

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

(

)

const [inline]

unsigned llvm::cl::Option::getNumAdditionalVals

(

)

const [inline]

int llvm::cl::Option::getNumOccurrences

(

)

const [inline]

enum NumOccurrencesFlag llvm::cl::Option::getNumOccurrencesFlag

(

)

const [inline]

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

(

)

const [inline]

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

(

)

const [pure virtual]

Implemented in llvm::cl::opt< DataType, ExternalStorage, ParserClass >, llvm::cl::list< DataType, Storage, ParserClass >, llvm::cl::bits< DataType, Storage, ParserClass >, and llvm::cl::alias.

unsigned llvm::cl::Option::getPosition

(

)

const [inline]

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

(

)

const [inline]

virtual enum ValueExpected llvm::cl::Option::getValueExpectedFlagDefault

(

)

const [inline, private, virtual]

Reimplemented in llvm::cl::opt< DataType, ExternalStorage, ParserClass >, llvm::cl::list< DataType, Storage, ParserClass >, and llvm::cl::bits< DataType, Storage, ParserClass >.

virtual bool llvm::cl::Option::handleOccurrence	(	unsigned	pos,
		StringRef	ArgName,
		StringRef	Arg
	)			[private, pure virtual]

Implemented in llvm::cl::opt< DataType, ExternalStorage, ParserClass >, llvm::cl::list< DataType, Storage, ParserClass >, llvm::cl::bits< DataType, Storage, ParserClass >, and llvm::cl::alias.

bool llvm::cl::Option::hasArgStr

(

)

const [inline]

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

(

size_t

GlobalWidth

)

const [pure virtual]

Implemented in llvm::cl::opt< DataType, ExternalStorage, ParserClass >, llvm::cl::list< DataType, Storage, ParserClass >, llvm::cl::bits< DataType, Storage, ParserClass >, and llvm::cl::alias.

virtual void llvm::cl::Option::printOptionValue	(	size_t	GlobalWidth,
		bool	Force
	)			const [pure virtual]

Implemented in llvm::cl::opt< DataType, ExternalStorage, ParserClass >, llvm::cl::list< DataType, Storage, ParserClass >, llvm::cl::bits< DataType, Storage, ParserClass >, and llvm::cl::alias.

void llvm::cl::Option::setArgStr

(

const char *

S

)

[inline]

void llvm::cl::Option::setDescription

(

const char *

S

)

[inline]

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

void llvm::cl::Option::setFormattingFlag

(

enum FormattingFlags

V

)

[inline]

void llvm::cl::Option::setHiddenFlag

(

enum OptionHidden

Val

)

[inline]

void llvm::cl::Option::setMiscFlag

(

enum MiscFlags

M

)

[inline]

void llvm::cl::Option::setNumAdditionalVals

(

unsigned

n

)

[inline, protected]

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

void llvm::cl::Option::setNumOccurrencesFlag

(

enum NumOccurrencesFlag

Val

)

[inline]

void llvm::cl::Option::setPosition

(

unsigned

pos

)

[inline]

void llvm::cl::Option::setValueExpectedFlag

(

enum ValueExpected

Val

)

[inline]

void llvm::cl::Option::setValueStr

(

const char *

S

)

[inline]

---

Friends And Related Function Documentation

friend class alias [friend]

---

Member Data Documentation

unsigned llvm::cl::Option::AdditionalVals [private]

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

int llvm::cl::Option::Flags [private]

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

Option* llvm::cl::Option::NextRegistered [private]

int llvm::cl::Option::NumOccurrences [private]

unsigned llvm::cl::Option::Position [private]

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

---

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

• CommandLine.h
• CommandLine.cpp