LLVM API Documentation

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 (const char *ArgStr)
void	removeArgument (const char *ArgStr)
virtual unsigned	getOptionWidth () const =0
virtual void	printOptionInfo (unsigned GlobalWidth) const =0
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 ()
Friends
class	alias
void	cl::ParseCommandLineOptions (int &, char **, const char *)

---

Detailed Description

Definition at line 122 of file CommandLine.h.

---

Constructor & Destructor Documentation

llvm::cl::Option::Option

(

)

[inline, protected]

Definition at line 207 of file CommandLine.h.

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

(

)

[inline, virtual]

Definition at line 235 of file CommandLine.h.

---

Member Function Documentation

void Option::addArgument

(

const char *

ArgStr

)

Definition at line 645 of file CommandLine.cpp.

References AddArgument(), llvm::cl::ConsumeAfter, error(), getFormattingFlag(), getNumOccurrencesFlag(), getPositionalOpts(), and llvm::cl::Positional.

Referenced by llvm::PassNameParser::passRegistered().

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

Definition at line 620 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 610 of file CommandLine.cpp.

References ArgStr, HelpStr, and ProgramName.

Referenced by addArgument(), addOccurrence(), llvm::cl::ParseCommandLineOptions(), ProvideOption(), llvm::cl::alias::setAliasFor(), and setFlag().

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

(

)

const [inline]

Definition at line 169 of file CommandLine.h.

References llvm::cl::FormattingMask.

Referenced by addArgument(), llvm::cl::ParseCommandLineOptions(), and removeArgument().

unsigned llvm::cl::Option::getMiscFlags

(

)

const [inline]

Definition at line 174 of file CommandLine.h.

References llvm::cl::MiscMask.

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

int llvm::cl::Option::getNumOccurrences

(

)

const [inline]

Definition at line 234 of file CommandLine.h.

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

(

)

const [inline]

Definition at line 154 of file CommandLine.h.

References llvm::cl::OccurrencesMask.

Referenced by addArgument(), addOccurrence(), and removeArgument().

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

(

)

const [inline]

Definition at line 164 of file CommandLine.h.

References llvm::cl::HiddenMask.

virtual unsigned llvm::cl::Option::getOptionWidth

(

)

const [pure virtual]

unsigned llvm::cl::Option::getPosition

(

)

const [inline]

Definition at line 177 of file CommandLine.h.

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

(

)

const [inline]

Definition at line 159 of file CommandLine.h.

References llvm::cl::ValueMask.

Referenced by ProvideOption().

bool llvm::cl::Option::hasArgStr

(

)

const [inline]

Definition at line 180 of file CommandLine.h.

References ArgStr.

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

(

unsigned

GlobalWidth

)

const [pure virtual]

void Option::removeArgument

(

const char *

ArgStr

)

Definition at line 659 of file CommandLine.cpp.

References llvm::cl::ConsumeAfter, getFormattingFlag(), getNumOccurrencesFlag(), getPositionalOpts(), I, llvm::cl::Positional, and RemoveArgument().

Referenced by llvm::PassNameParser::passUnregistered().

void llvm::cl::Option::setArgStr

(

const char *

S

)

[inline]

Definition at line 185 of file CommandLine.h.

References ArgStr.

void llvm::cl::Option::setDescription

(

const char *

S

)

[inline]

Definition at line 186 of file CommandLine.h.

References HelpStr.

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

Definition at line 189 of file CommandLine.h.

References error().

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

void llvm::cl::Option::setFormattingFlag

(

enum FormattingFlags

V

)

[inline]

Definition at line 203 of file CommandLine.h.

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

void llvm::cl::Option::setHiddenFlag

(

enum OptionHidden

Val

)

[inline]

Definition at line 202 of file CommandLine.h.

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

void llvm::cl::Option::setMiscFlag

(

enum MiscFlags

M

)

[inline]

Definition at line 204 of file CommandLine.h.

References setFlag().

void llvm::cl::Option::setNumOccurrencesFlag

(

enum NumOccurrences

Val

)

[inline]

Definition at line 198 of file CommandLine.h.

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

void llvm::cl::Option::setPosition

(

unsigned

pos

)

[inline]

Definition at line 205 of file CommandLine.h.

void llvm::cl::Option::setValueExpectedFlag

(

enum ValueExpected

Val

)

[inline]

Definition at line 201 of file CommandLine.h.

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

void llvm::cl::Option::setValueStr

(

const char *

S

)

[inline]

Definition at line 187 of file CommandLine.h.

References ValueStr.

---

Friends And Related Function Documentation

friend class alias [friend]

Definition at line 124 of file CommandLine.h.

void cl::ParseCommandLineOptions	(	int &	,
		char **	,
		const char *
	)			[friend]

---

Member Data Documentation

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

Definition at line 150 of file CommandLine.h.

Referenced by error(), hasArgStr(), ProvidePositionalOption(), and setArgStr().

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

Definition at line 151 of file CommandLine.h.

Referenced by error(), and setDescription().

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

Definition at line 152 of file CommandLine.h.

Referenced by setValueStr().

---

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

• CommandLine.h
• CommandLine.cpp

---

Generated on Mon Aug 14 11:42:11 2006 for LLVM by doxygen 1.4.7
Copyright © 2003,2004 University of Illinois at Urbana-Champaign. All Rights Reserved.