class Option
Declaration
class Option { /* full declaration omitted */ };
Declared at: llvm/include/llvm/Support/CommandLine.h:242
Member Variables
- private uint16_t NumOccurrences
- private uint16_t Occurrences
- private uint16_t Value
- private uint16_t HiddenFlag
- private uint16_t Formatting
- private uint16_t Misc
- private uint16_t FullyInitialized
- private uint16_t Position
- private uint16_t AdditionalVals
- public llvm::StringRef ArgStr
- public llvm::StringRef HelpStr
- public llvm::StringRef ValueStr
- public SmallVector<llvm::cl::OptionCategory*, 1> Categories
- public SmallPtrSet<llvm::cl::SubCommand*, 1> Subs
Method Overview
- protected Option(enum NumOccurrencesFlag OccurrencesFlag, enum OptionHidden Hidden)
- public void addArgument()
- public void addCategory(llvm::cl::OptionCategory & C)
- public virtual bool addOccurrence(unsigned int pos, llvm::StringRef ArgName, llvm::StringRef Value, bool MultiArg = false)
- public void addSubCommand(llvm::cl::SubCommand & S)
- private virtual void anchor()
- public bool error(const llvm::Twine & Message, llvm::StringRef ArgName = llvm::StringRef(), llvm::raw_ostream & Errs = llvm::errs())
- public bool error(const llvm::Twine & Message, llvm::raw_ostream & Errs)
- public virtual void getExtraOptionNames(SmallVectorImpl<llvm::StringRef> &)
- public inline enum FormattingFlags getFormattingFlag() const
- public inline unsigned int getMiscFlags() const
- public inline unsigned int getNumAdditionalVals() const
- public inline int getNumOccurrences() const
- public inline enum NumOccurrencesFlag getNumOccurrencesFlag() const
- public inline enum OptionHidden getOptionHiddenFlag() const
- public virtual size_t getOptionWidth() const
- public inline unsigned int getPosition() const
- public inline enum ValueExpected getValueExpectedFlag() const
- private virtual enum ValueExpected getValueExpectedFlagDefault() const
- private virtual bool handleOccurrence(unsigned int pos, llvm::StringRef ArgName, llvm::StringRef Arg)
- public bool hasArgStr() const
- public bool isConsumeAfter() const
- public bool isDefaultOption() const
- public bool isInAllSubCommands() const
- public bool isPositional() const
- public bool isSink() const
- public static void printEnumValHelpStr(llvm::StringRef HelpStr, size_t Indent, size_t FirstLineIndentedBy)
- public static void printHelpStr(llvm::StringRef HelpStr, size_t Indent, size_t FirstLineIndentedBy)
- public virtual void printOptionInfo(size_t GlobalWidth) const
- public virtual void printOptionValue(size_t GlobalWidth, bool Force) const
- public void removeArgument()
- public void reset()
- public void setArgStr(llvm::StringRef S)
- public virtual void setDefault()
- public void setDescription(llvm::StringRef S)
- public void setFormattingFlag(enum FormattingFlags V)
- public void setHiddenFlag(enum OptionHidden Val)
- public void setMiscFlag(enum MiscFlags M)
- protected inline void setNumAdditionalVals(unsigned int n)
- public void setNumOccurrencesFlag(enum NumOccurrencesFlag Val)
- public void setPosition(unsigned int pos)
- public void setValueExpectedFlag(enum ValueExpected Val)
- public void setValueStr(llvm::StringRef S)
- public virtual ~Option()
Methods
¶Option(enum NumOccurrencesFlag OccurrencesFlag,
enum OptionHidden Hidden)
Option(enum NumOccurrencesFlag OccurrencesFlag,
enum OptionHidden Hidden)
Declared at: llvm/include/llvm/Support/CommandLine.h:331
Parameters
- enum NumOccurrencesFlag OccurrencesFlag
- enum OptionHidden Hidden
¶void addArgument()
void addArgument()
Declared at: llvm/include/llvm/Support/CommandLine.h:346
¶void addCategory(llvm::cl::OptionCategory& C)
void addCategory(llvm::cl::OptionCategory& C)
Declared at: llvm/include/llvm/Support/CommandLine.h:327
Parameters
¶virtual bool addOccurrence(
unsigned int pos,
llvm::StringRef ArgName,
llvm::StringRef Value,
bool MultiArg = false)
virtual bool addOccurrence(
unsigned int pos,
llvm::StringRef ArgName,
llvm::StringRef Value,
bool MultiArg = false)
Declared at: llvm/include/llvm/Support/CommandLine.h:386
Parameters
- unsigned int pos
- llvm::StringRef ArgName
- llvm::StringRef Value
- bool MultiArg = false
¶void addSubCommand(llvm::cl::SubCommand& S)
void addSubCommand(llvm::cl::SubCommand& S)
Declared at: llvm/include/llvm/Support/CommandLine.h:328
Parameters
¶virtual void anchor()
virtual void anchor()
Declared at: llvm/include/llvm/Support/CommandLine.h:257
¶bool error(
const llvm::Twine& Message,
llvm::StringRef ArgName = llvm::StringRef(),
llvm::raw_ostream& Errs = llvm::errs())
bool error(
const llvm::Twine& Message,
llvm::StringRef ArgName = llvm::StringRef(),
llvm::raw_ostream& Errs = llvm::errs())
Declared at: llvm/include/llvm/Support/CommandLine.h:390
Parameters
- const llvm::Twine& Message
- llvm::StringRef ArgName = llvm::StringRef()
- llvm::raw_ostream& Errs = llvm::errs()
¶bool error(const llvm::Twine& Message,
llvm::raw_ostream& Errs)
bool error(const llvm::Twine& Message,
llvm::raw_ostream& Errs)
Declared at: llvm/include/llvm/Support/CommandLine.h:391
Parameters
- const llvm::Twine& Message
- llvm::raw_ostream& Errs
¶virtual void getExtraOptionNames(
SmallVectorImpl<llvm::StringRef>&)
virtual void getExtraOptionNames(
SmallVectorImpl<llvm::StringRef>&)
Declared at: llvm/include/llvm/Support/CommandLine.h:382
Parameters
- SmallVectorImpl<llvm::StringRef>&
¶inline enum FormattingFlags getFormattingFlag()
const
inline enum FormattingFlags getFormattingFlag()
const
Declared at: llvm/include/llvm/Support/CommandLine.h:293
¶inline unsigned int getMiscFlags() const
inline unsigned int getMiscFlags() const
Declared at: llvm/include/llvm/Support/CommandLine.h:297
¶inline unsigned int getNumAdditionalVals() const
inline unsigned int getNumAdditionalVals() const
Declared at: llvm/include/llvm/Support/CommandLine.h:299
¶inline int getNumOccurrences() const
inline int getNumOccurrences() const
Declared at: llvm/include/llvm/Support/CommandLine.h:395
¶inline enum NumOccurrencesFlag
getNumOccurrencesFlag() const
inline enum NumOccurrencesFlag
getNumOccurrencesFlag() const
Declared at: llvm/include/llvm/Support/CommandLine.h:281
¶inline enum OptionHidden getOptionHiddenFlag()
const
inline enum OptionHidden getOptionHiddenFlag()
const
Declared at: llvm/include/llvm/Support/CommandLine.h:289
¶virtual size_t getOptionWidth() const
virtual size_t getOptionWidth() const
Declared at: llvm/include/llvm/Support/CommandLine.h:355
¶inline unsigned int getPosition() const
inline unsigned int getPosition() const
Declared at: llvm/include/llvm/Support/CommandLine.h:298
¶inline enum ValueExpected getValueExpectedFlag()
const
inline enum ValueExpected getValueExpectedFlag()
const
Declared at: llvm/include/llvm/Support/CommandLine.h:285
¶virtual enum ValueExpected
getValueExpectedFlagDefault() const
virtual enum ValueExpected
getValueExpectedFlagDefault() const
Declared at: llvm/include/llvm/Support/CommandLine.h:252
¶virtual bool handleOccurrence(
unsigned int pos,
llvm::StringRef ArgName,
llvm::StringRef Arg)
virtual bool handleOccurrence(
unsigned int pos,
llvm::StringRef ArgName,
llvm::StringRef Arg)
Declared at: llvm/include/llvm/Support/CommandLine.h:249
Parameters
- unsigned int pos
- llvm::StringRef ArgName
- llvm::StringRef Arg
¶bool hasArgStr() const
bool hasArgStr() const
Declared at: llvm/include/llvm/Support/CommandLine.h:302
¶bool isConsumeAfter() const
bool isConsumeAfter() const
Declared at: llvm/include/llvm/Support/CommandLine.h:307
¶bool isDefaultOption() const
bool isDefaultOption() const
Declared at: llvm/include/llvm/Support/CommandLine.h:305
¶bool isInAllSubCommands() const
bool isInAllSubCommands() const
Declared at: llvm/include/llvm/Support/CommandLine.h:311
¶bool isPositional() const
bool isPositional() const
Declared at: llvm/include/llvm/Support/CommandLine.h:303
¶bool isSink() const
bool isSink() const
Declared at: llvm/include/llvm/Support/CommandLine.h:304
¶static void printEnumValHelpStr(
llvm::StringRef HelpStr,
size_t Indent,
size_t FirstLineIndentedBy)
static void printEnumValHelpStr(
llvm::StringRef HelpStr,
size_t Indent,
size_t FirstLineIndentedBy)
Declared at: llvm/include/llvm/Support/CommandLine.h:379
Parameters
- llvm::StringRef HelpStr
- size_t Indent
- size_t FirstLineIndentedBy
¶static void printHelpStr(
llvm::StringRef HelpStr,
size_t Indent,
size_t FirstLineIndentedBy)
static void printHelpStr(
llvm::StringRef HelpStr,
size_t Indent,
size_t FirstLineIndentedBy)
Declared at: llvm/include/llvm/Support/CommandLine.h:371
Parameters
- llvm::StringRef HelpStr
- size_t Indent
- size_t FirstLineIndentedBy
¶virtual void printOptionInfo(
size_t GlobalWidth) const
virtual void printOptionInfo(
size_t GlobalWidth) const
Declared at: llvm/include/llvm/Support/CommandLine.h:360
Parameters
- size_t GlobalWidth
¶virtual void printOptionValue(size_t GlobalWidth,
bool Force) const
virtual void printOptionValue(size_t GlobalWidth,
bool Force) const
Declared at: llvm/include/llvm/Support/CommandLine.h:362
Parameters
- size_t GlobalWidth
- bool Force
¶void removeArgument()
void removeArgument()
Description
Unregisters this option from the CommandLine system. This option must have been the last option registered. For testing purposes only.
Declared at: llvm/include/llvm/Support/CommandLine.h:352
¶void reset()
void reset()
Declared at: llvm/include/llvm/Support/CommandLine.h:396
¶void setArgStr(llvm::StringRef S)
void setArgStr(llvm::StringRef S)
Declared at: llvm/include/llvm/Support/CommandLine.h:318
Parameters
¶virtual void setDefault()
virtual void setDefault()
Declared at: llvm/include/llvm/Support/CommandLine.h:364
¶void setDescription(llvm::StringRef S)
void setDescription(llvm::StringRef S)
Declared at: llvm/include/llvm/Support/CommandLine.h:319
Parameters
¶void setFormattingFlag(enum FormattingFlags V)
void setFormattingFlag(enum FormattingFlags V)
Declared at: llvm/include/llvm/Support/CommandLine.h:324
Parameters
- enum FormattingFlags V
¶void setHiddenFlag(enum OptionHidden Val)
void setHiddenFlag(enum OptionHidden Val)
Declared at: llvm/include/llvm/Support/CommandLine.h:323
Parameters
- enum OptionHidden Val
¶void setMiscFlag(enum MiscFlags M)
void setMiscFlag(enum MiscFlags M)
Declared at: llvm/include/llvm/Support/CommandLine.h:325
Parameters
- enum MiscFlags M
¶inline void setNumAdditionalVals(unsigned int n)
inline void setNumAdditionalVals(unsigned int n)
Declared at: llvm/include/llvm/Support/CommandLine.h:339
Parameters
- unsigned int n
¶void setNumOccurrencesFlag(
enum NumOccurrencesFlag Val)
void setNumOccurrencesFlag(
enum NumOccurrencesFlag Val)
Declared at: llvm/include/llvm/Support/CommandLine.h:321
Parameters
- enum NumOccurrencesFlag Val
¶void setPosition(unsigned int pos)
void setPosition(unsigned int pos)
Declared at: llvm/include/llvm/Support/CommandLine.h:326
Parameters
- unsigned int pos
¶void setValueExpectedFlag(enum ValueExpected Val)
void setValueExpectedFlag(enum ValueExpected Val)
Declared at: llvm/include/llvm/Support/CommandLine.h:322
Parameters
- enum ValueExpected Val
¶void setValueStr(llvm::StringRef S)
void setValueStr(llvm::StringRef S)
Declared at: llvm/include/llvm/Support/CommandLine.h:320
Parameters
¶virtual ~Option()
virtual ~Option()
Declared at: llvm/include/llvm/Support/CommandLine.h:342