Movatterモバイル変換

[0]ホーム
URL:

LLVM 20.0.0git
Public Member Functions |Static Public Member Functions |Public Attributes |Protected Member Functions |Friends |List of all members
llvm::cl::Option Class Referenceabstract

#include "llvm/Support/CommandLine.h"

Inheritance diagram for llvm::cl::Option:
Inheritance graph
[legend]

Public Member Functions

enumNumOccurrencesFlag getNumOccurrencesFlag ()const
 
enumValueExpected getValueExpectedFlag ()const
 
enumOptionHidden getOptionHiddenFlag ()const
 
enumFormattingFlags getFormattingFlag ()const
 
unsigned getMiscFlags ()const
 
unsigned getPosition ()const
 
unsigned getNumAdditionalVals ()const
 
bool hasArgStr ()const
 
bool isPositional ()const
 
bool isSink ()const
 
bool isDefaultOption ()const
 
bool isConsumeAfter ()const
 
void setArgStr (StringRef S)
 
void setDescription (StringRef S)
 
void setValueStr (StringRef S)
 
void setNumOccurrencesFlag (enumNumOccurrencesFlag Val)
 
void setValueExpectedFlag (enumValueExpected Val)
 
void setHiddenFlag (enumOptionHidden Val)
 
void setFormattingFlag (enumFormattingFlags V)
 
void setMiscFlag (enumMiscFlags M)
 
void setPosition (unsigned pos)
 
void addCategory (OptionCategory &C)
 
void addSubCommand (SubCommand &S)
 
virtual ~Option ()=default
 
void addArgument ()
 
void removeArgument ()
 Unregisters this option from the CommandLine system.
 
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 setDefault ()=0
 
virtual void getExtraOptionNames (SmallVectorImpl<StringRef > &)
 
virtualbool addOccurrence (unsigned pos,StringRef ArgName,StringRefValue,bool MultiArg=false)
 
bool error (constTwine &Message,StringRef ArgName=StringRef(),raw_ostream &Errs=llvm::errs())
 
bool error (constTwine &Message,raw_ostream &Errs)
 
int getNumOccurrences ()const
 
void reset ()
 

Static Public Member Functions

static void printHelpStr (StringRefHelpStr, size_t Indent, size_t FirstLineIndentedBy)
 
static void printEnumValHelpStr (StringRefHelpStr, size_t Indent, size_t FirstLineIndentedBy)
 

Public Attributes

StringRef ArgStr
 
StringRef HelpStr
 
StringRef ValueStr
 
SmallVector<OptionCategory *, 1 > Categories
 
SmallPtrSet<SubCommand *, 1 > Subs
 

Protected Member Functions

 Option (enumNumOccurrencesFlag OccurrencesFlag, enumOptionHiddenHidden)
 
void setNumAdditionalVals (unsigned n)
 

Friends

class alias
 

Detailed Description

Definition at line250 of fileCommandLine.h.

Constructor & Destructor Documentation

◆ Option()

llvm::cl::Option::Option(enumNumOccurrencesFlag OccurrencesFlag,
enumOptionHidden Hidden 
)
inlineexplicitprotected

Definition at line335 of fileCommandLine.h.

ReferencesCategories, andllvm::cl::getGeneralCategory().

◆ ~Option()

virtual llvm::cl::Option::~Option()
virtualdefault

Member Function Documentation

◆ addArgument()

void Option::addArgument()

Definition at line431 of fileCommandLine.cpp.

ReferencesGlobalParser.

◆ addCategory()

void Option::addCategory(OptionCategory & C)

Definition at line447 of fileCommandLine.cpp.

Referencesassert(),llvm::CallingConv::C,Categories,llvm::cl::getGeneralCategory(), andllvm::is_contained().

◆ addOccurrence()

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

Definition at line1863 of fileCommandLine.cpp.

Referenced byCommaSeparateAndAddOccurrence().

◆ addSubCommand()

void llvm::cl::Option::addSubCommand(SubCommand & S)
inline

Definition at line332 of fileCommandLine.h.

ReferencesSubs.

◆ error()[1/2]

bool llvm::cl::Option::error(constTwine & Message,
raw_ostream & Errs 
)
inline

Definition at line395 of fileCommandLine.h.

Referenceserror.

◆ error()[2/2]

bool Option::error(constTwine & Message,
StringRef ArgName =StringRef(),
raw_ostream & Errs =llvm::errs() 
)

Definition at line1851 of fileCommandLine.cpp.

ReferencesArgStr,llvm::StringRef::data(),llvm::StringRef::empty(),GlobalParser, andHelpStr.

Referenced byHandlePrefixedOrGroupedOption(), andProvideOption().

◆ getExtraOptionNames()

virtual void llvm::cl::Option::getExtraOptionNames(SmallVectorImpl<StringRef > & )
inlinevirtual

Definition at line386 of fileCommandLine.h.

◆ getFormattingFlag()

enumFormattingFlags llvm::cl::Option::getFormattingFlag() const
inline

Definition at line301 of fileCommandLine.h.

Referenced byHandlePrefixedOrGroupedOption(),isPositional(), andProvideOption().

◆ getMiscFlags()

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

Definition at line305 of fileCommandLine.h.

Referenced byCommaSeparateAndAddOccurrence(),isDefaultOption(), andisSink().

◆ getNumAdditionalVals()

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

Definition at line307 of fileCommandLine.h.

Referenced byProvideOption().

◆ getNumOccurrences()

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

Definition at line399 of fileCommandLine.h.

Referenced byannotateAllFunctions(),applyCommandLineOverridesToOptions(),llvm::ScheduleDAGInstrs::buildSchedGraph(),canProfitablyRuntimeUnrollMultiExitLoop(),llvm::SampleProfileSummaryBuilder::computeSummaryForProfiles(),llvm::createGlobalMergePass(),llvm::HexagonSubtarget::enableMachineScheduler(),llvm::gatherPeelingPreferences(),llvm::gatherUnrollingPreferences(),llvm::Attributor::isClosedWorldModule(),llvm::AMDGPUPassConfig::isPassEnabled(),llvm::LibCallSimplifier::optimizeCall(),llvm::AArch64TTIImpl::preferFixedOverScalableIfEqualCost(),llvm::LoopVectorizePass::processLoop(),llvm::IRTranslator::runOnMachineFunction(),llvm::Legalizer::runOnMachineFunction(),llvm::RAGreedy::runOnMachineFunction(),llvm::TargetLoweringBase::setJumpIsExpensive(),llvm::TargetPassConfig::TargetPassConfig(),tryToUnrollAndJamLoop(),llvm::UnrollLoop(),useMaskedInterleavedAccesses(),llvm::NVPTXTargetLowering::usePrecSqrtF32(), andllvm::AArch64Subtarget::useScalarIncVL().

◆ getNumOccurrencesFlag()

enumNumOccurrencesFlag llvm::cl::Option::getNumOccurrencesFlag() const
inline

Definition at line289 of fileCommandLine.h.

Referenced byisConsumeAfter().

◆ getOptionHiddenFlag()

enumOptionHidden llvm::cl::Option::getOptionHiddenFlag() const
inline

Definition at line297 of fileCommandLine.h.

◆ getOptionWidth()

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

◆ getPosition()

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

Definition at line306 of fileCommandLine.h.

Referenced byenablePostRAScheduler(),llvm::HexagonSubtarget::initializeSubtargetDependencies(), andllvm::MachinePipeliner::runOnMachineFunction().

◆ getValueExpectedFlag()

enumValueExpected llvm::cl::Option::getValueExpectedFlag() const
inline

Definition at line293 of fileCommandLine.h.

Referenced byHandlePrefixedOrGroupedOption(), andProvideOption().

◆ hasArgStr()

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

Definition at line310 of fileCommandLine.h.

ReferencesArgStr, andllvm::StringRef::empty().

Referenced byllvm::cl::generic_parser_base::getExtraOptionNames(),llvm::cl::generic_parser_base::getValueExpectedFlagDefault(), andllvm::cl::parser< DataType >::parse().

◆ isConsumeAfter()

bool llvm::cl::Option::isConsumeAfter() const
inline

Definition at line315 of fileCommandLine.h.

Referencesllvm::cl::ConsumeAfter, andgetNumOccurrencesFlag().

◆ isDefaultOption()

bool llvm::cl::Option::isDefaultOption() const
inline

Definition at line313 of fileCommandLine.h.

Referencesllvm::cl::DefaultOption, andgetMiscFlags().

Referenced byreset().

◆ isPositional()

bool llvm::cl::Option::isPositional() const
inline

Definition at line311 of fileCommandLine.h.

ReferencesgetFormattingFlag(), andllvm::cl::Positional.

◆ isSink()

bool llvm::cl::Option::isSink() const
inline

Definition at line312 of fileCommandLine.h.

ReferencesgetMiscFlags(), andllvm::cl::Sink.

◆ printEnumValHelpStr()

void Option::printEnumValHelpStr(StringRef HelpStr,
size_t Indent,
size_t FirstLineIndentedBy 
)
static

Definition at line1901 of fileCommandLine.cpp.

ReferencesArgHelpPrefix,assert(),HelpStr,llvm::raw_ostream::indent(),llvm::outs(),llvm::StringRef::size(), andllvm::StringRef::split().

Referenced byllvm::cl::generic_parser_base::printOptionInfo().

◆ printHelpStr()

void Option::printHelpStr(StringRef HelpStr,
size_t Indent,
size_t FirstLineIndentedBy 
)
static

Definition at line1889 of fileCommandLine.cpp.

ReferencesArgHelpPrefix,assert(),HelpStr,llvm::raw_ostream::indent(),llvm::outs(), andllvm::StringRef::split().

Referenced byllvm::cl::generic_parser_base::printOptionInfo(), andllvm::cl::basic_parser_impl::printOptionInfo().

◆ printOptionInfo()

virtual void llvm::cl::Option::printOptionInfo(size_t GlobalWidth) const
pure virtual

◆ printOptionValue()

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

◆ removeArgument()

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 line436 of fileCommandLine.cpp.

ReferencesGlobalParser.

Referenced byreset().

◆ reset()

void Option::reset()

Definition at line458 of fileCommandLine.cpp.

ReferencesisDefaultOption(),removeArgument(), andsetDefault().

◆ setArgStr()

void Option::setArgStr(StringRef S)

Definition at line438 of fileCommandLine.cpp.

ReferencesArgStr,assert(),GlobalParser,llvm::cl::Grouping,setMiscFlag(),llvm::StringRef::size(), andllvm::StringRef::starts_with().

◆ setDefault()

virtual void llvm::cl::Option::setDefault()
pure virtual

Referenced byreset().

◆ setDescription()

void llvm::cl::Option::setDescription(StringRef S)
inline

Definition at line323 of fileCommandLine.h.

ReferencesHelpStr.

◆ setFormattingFlag()

void llvm::cl::Option::setFormattingFlag(enumFormattingFlags V)
inline

Definition at line328 of fileCommandLine.h.

◆ setHiddenFlag()

void llvm::cl::Option::setHiddenFlag(enumOptionHidden Val)
inline

Definition at line327 of fileCommandLine.h.

◆ setMiscFlag()

void llvm::cl::Option::setMiscFlag(enumMiscFlags M)
inline

Definition at line329 of fileCommandLine.h.

Referenced bysetArgStr().

◆ setNumAdditionalVals()

void llvm::cl::Option::setNumAdditionalVals(unsigned n)
inlineprotected

Definition at line343 of fileCommandLine.h.

Referenced byllvm::cl::list< DataType, StorageClass, ParserClass >::setNumAdditionalVals().

◆ setNumOccurrencesFlag()

void llvm::cl::Option::setNumOccurrencesFlag(enumNumOccurrencesFlag Val)
inline

Definition at line325 of fileCommandLine.h.

◆ setPosition()

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

Definition at line330 of fileCommandLine.h.

◆ setValueExpectedFlag()

void llvm::cl::Option::setValueExpectedFlag(enumValueExpected Val)
inline

Definition at line326 of fileCommandLine.h.

◆ setValueStr()

void llvm::cl::Option::setValueStr(StringRef S)
inline

Definition at line324 of fileCommandLine.h.

ReferencesValueStr.

Friends And Related Function Documentation

◆ alias

friend classalias
friend

Definition at line251 of fileCommandLine.h.

Member Data Documentation

◆ ArgStr

StringRef llvm::cl::Option::ArgStr

Definition at line282 of fileCommandLine.h.

Referenced byerror(),hasArgStr(),llvm::cl::ProvidePositionalOption(), andsetArgStr().

◆ Categories

SmallVector<OptionCategory *, 1> llvm::cl::Option::Categories

Definition at line286 of fileCommandLine.h.

Referenced byaddCategory(), andOption().

◆ HelpStr

StringRef llvm::cl::Option::HelpStr

Definition at line283 of fileCommandLine.h.

Referenced byerror(),printEnumValHelpStr(),printHelpStr(), andsetDescription().

◆ Subs

SmallPtrSet<SubCommand *, 1> llvm::cl::Option::Subs

Definition at line287 of fileCommandLine.h.

Referenced byaddSubCommand().

◆ ValueStr

StringRef llvm::cl::Option::ValueStr

Definition at line284 of fileCommandLine.h.

Referenced bysetValueStr().

The documentation for this class was generated from the following files:
Generated on Sun Jul 20 2025 20:19:22 for LLVM by doxygen 1.9.6
[8]ページ先頭
©2009-2025 Movatter.jp