LLVM: llvm::cl Namespace Reference (original) (raw)

This namespace contains all of the command line option processing machinery. More...

This namespace contains all of the command line option processing machinery.

It is intentionally a short name to make qualified usage concise.

◆ TokenizerCallback

Initial value:

bool MarkEOLs)

This class consists of common code factored out of the SmallVector class to reduce code duplication b...

StringRef - Represent a constant reference to a string, i.e.

Saves strings in the provided stable storage and returns a StringRef with a stable character pointer.

String tokenization function type.

Should be compatible with either Windows or Unix command line tokenizers.

Definition at line 2171 of file CommandLine.h.

◆ VersionPrinterTy

◆ boolOrDefault

Definition at line 639 of file CommandLine.h.

◆ FormattingFlags

Definition at line 157 of file CommandLine.h.

◆ MiscFlags

Definition at line 164 of file CommandLine.h.

◆ NumOccurrencesFlag

Definition at line 114 of file CommandLine.h.

◆ OptionHidden

Definition at line 137 of file CommandLine.h.

◆ ValueExpected

Definition at line 130 of file CommandLine.h.

◆ AddExtraVersionPrinter()

===------------------------------------------------------------------—===// Add an extra printer to use in addition to the default one.

This can be called multiple times, and each time it adds a new function to the list which will be called after the basic LLVM version printing is complete. Each can then add additional information specific to the tool.

Definition at line 2818 of file CommandLine.cpp.

References CommonOptions.

◆ AddLiteralOption()

◆ apply() [1/2]

template<class Opt, class Mod>

◆ apply() [2/2]

template<class Opt, class Mod, class... Mods>

Definition at line 1341 of file CommandLine.h.

References apply(), llvm::Mod, and llvm:🆑:applicator< Mod >::opt().

Referenced by llvm:🆑:alias::alias(), apply(), llvm:🆑:bits< DataType, Storage, ParserClass >::bits(), llvm:🆑:list< std::string, DebugCounter >::list(), and llvm:🆑:opt< DataType, ExternalStorage, ParserClass >::opt().

◆ callback()

◆ ExpandResponseFiles()

◆ expandResponseFiles() [1/2]

◆ expandResponseFiles() [2/2]

◆ getCompilerBuildConfig()

◆ getGeneralCategory()

◆ getRegisteredOptions()

Use this to get a [StringMap](classllvm%5F1%5F1StringMap.html "StringMap - This is an unconventional map that is specialized for handling keys that are "strings",...") to all registered named options (e.g.

-help).

Returns

A reference to the [StringMap](classllvm%5F1%5F1StringMap.html "StringMap - This is an unconventional map that is specialized for handling keys that are "strings",...") used by the cl APIs to parse options.

Access to unnamed arguments (i.e. positional) are not provided because it is expected that the client already has access to these.

Typical usage:

main(int argc,char* argv[]) {

opts["help"]->setDescription("Show alphabetical help information")

}

assert(UImm &&(UImm !=~static_cast< T >(0)) &&"Invalid immediate!")

StringMap - This is an unconventional map that is specialized for handling keys that are "strings",...

size_type count(StringRef Key) const

count - Return 1 if the element is in the map, 0 otherwise.

This namespace contains all of the command line option processing machinery.

LLVM_ABI StringMap< Option * > & getRegisteredOptions(SubCommand &Sub=SubCommand::getTopLevel())

Use this to get a StringMap to all registered named options (e.g.

LLVM_ABI bool ParseCommandLineOptions(int argc, const char *const *argv, StringRef Overview="", raw_ostream *Errs=nullptr, vfs::FileSystem *VFS=nullptr, const char *EnvVar=nullptr, bool LongOptionsUseDoubleDash=false)

This is an optimization pass for GlobalISel generic memory operations.

This interface is useful for modifying options in libraries that are out of the control of the client. The options should be modified before calling llvm:🆑:ParseCommandLineOptions().

Hopefully this API can be deprecated soon. Any situation where options need to be modified by tools or libraries should be handled by sane APIs rather than just handing around a global list.

Definition at line 2822 of file CommandLine.cpp.

References assert(), GlobalParser, initCommonOptions(), and llvm::Sub.

◆ getRegisteredSubcommands()

Use this to get all registered SubCommands from the provided parser.

Returns

A range of all SubCommand pointers registered with the parser.

Typical usage:

main(int argc, char* argv[]) {

llvm:🆑:ParseCommandLineOptions(argc, argv);

for (auto* S : llvm:🆑:getRegisteredSubcommands()) {

if (*S) {

std::cout << "Executing subcommand: " << S->getName() << std::endl;

}

}

}

LLVM_ABI iterator_range< SmallPtrSet< SubCommand *, 4 >::iterator > getRegisteredSubcommands()

Use this to get all registered SubCommands from the provided parser.

This interface is useful for defining subcommands in libraries and the dispatch from a single point (like in the main function).

Definition at line 2831 of file CommandLine.cpp.

References GlobalParser.

◆ HideUnrelatedOptions() [1/2]

◆ HideUnrelatedOptions() [2/2]

Mark all options not part of this category as cl::ReallyHidden.

Parameters

Some tools (like clang-format) like to be able to hide all options that are not specific to the tool. This function allows a tool to specify a single option category to display in the -help output.

Definition at line 2835 of file CommandLine.cpp.

References CommonOptions, I, initCommonOptions(), ReallyHidden, and llvm::Sub.

◆ init()

Definition at line 445 of file CommandLine.h.

Referenced by llvm::ApplyExtTspWithoutProfile(), llvm::ir2vec::ArgWeight(), llvm::AsmMacroMaxNestingDepth(), llvm::CheapRematWeight(), llvm::CheckBFIUnknownBlockQueries(), llvm::mir2vec::CommonOperandWeight(), llvm::CopyWeight(), DEBUG_COUNTER(), llvm::DoInstrProfNameCompression(), llvm::EnableDetailedFunctionProperties(), llvm::EnableExtTspBlockPlacement(), llvm::EnableKnowledgeRetention(), llvm::EnableLTOInternalization(), llvm::EnableMemProfContextDisambiguation(), llvm::EvictInterferenceCutoff(), llvm::ExpensiveRematWeight(), llvm::ForceImportAll(), INITIALIZE_PASS(), llvm::ir2vec::IR2VecEmbeddingKind(), llvm::IterativeBFIMaxIterationsPerBlock(), llvm::IterativeBFIPrecision(), llvm::LoadWeight(), llvm::MemProfAveLifetimeColdThreshold(), llvm::MemProfKeepAllNotColdContexts(), llvm::MemProfLifetimeAccessDensityColdThreshold(), llvm::MemProfMinAveLifetimeAccessDensityHotThreshold(), llvm::MemProfUseAmbiguousAttributes(), llvm::MemProfUseHotHints(), llvm::NoPGOWarnMismatch(), llvm::NoPGOWarnMismatchComdatWeak(), llvm::NoWarnSampleUnused(), llvm::ir2vec::OpcWeight(), llvm::mir2vec::OpcWeight(), llvm::PGOInstrumentColdFunctionOnly(), llvm::PGOWarnMissing(), llvm::PickMergedSourceLocations(), llvm::ProfileCorrelate(), llvm::ProfileInlineGrowthLimit(), llvm::ProfileInlineLimitMax(), llvm::ProfileInlineLimitMin(), llvm::ProfileSummaryCutoffCold(), llvm::ProfileSummaryCutoffHot(), llvm::ProfileSummaryHugeWorkingSetSizeThreshold(), llvm::ProfileSummaryLargeWorkingSetSizeThreshold(), llvm::codegen::RegisterCodeGenFlags::RegisterCodeGenFlags(), llvm::mc::RegisterMCTargetOptionsFlags::RegisterMCTargetOptionsFlags(), llvm::codegen::RegisterSaveStatsFlag::RegisterSaveStatsFlag(), llvm::mir2vec::RegOperandWeight(), llvm::SampleColdCallSiteThreshold(), llvm::SampleHotCallSiteThreshold(), llvm::SampleProfileMaxPropagateIterations(), llvm::SampleProfileRecordCoverage(), llvm::SampleProfileSampleCoverage(), llvm::ScalePartialSampleProfileWorkingSetSize(), llvm::ShouldPreserveAllAttributes(), llvm::SortProfiledSCC(), STATISTIC(), llvm::StoreWeight(), llvm::SupportsHotColdNew(), llvm::ir2vec::TypeWeight(), and llvm::HexagonVLIWResourceModel::VLIWResourceModel().

◆ list_init()

◆ location()

template

◆ ParseCommandLineOptions()

Definition at line 1462 of file CommandLine.cpp.

References A(), llvm::sys::Process::GetEnv(), GlobalParser, I, initCommonOptions(), llvm::SmallVectorTemplateBase< T, bool >::push_back(), llvm::SmallVectorTemplateCommon< T, typename >::size(), and TokenizeGNUCommandLine().

Referenced by llvm::handleExecNameEncodedBEOpts(), llvm::handleExecNameEncodedOptimizerOpts(), LLVMParseCommandLineOptions(), llvm::parseCommandLineOptions(), and llvm::parseFuzzerCLOpts().

◆ printBuildConfig()

◆ PrintHelpMessage()

This function just prints the help message, exactly the same way as if the -help or -help-hidden option had been given on the command line.

Parameters

Definition at line 2752 of file CommandLine.cpp.

References CommonOptions, and Hidden.

◆ printOptionDiff() [1/2]

◆ printOptionDiff() [2/2]

◆ PrintOptionValues()

◆ PrintVersionMessage()

◆ ProvidePositionalOption()

◆ ResetAllOptionOccurrences()

◆ ResetCommandLineParser()

Reset the command line parser back to its initial state.

This removes all options, categories, and subcommands and returns the parser to a state where no options are supported.

Definition at line 2863 of file CommandLine.cpp.

References GlobalParser.

◆ SetVersionPrinter()

===------------------------------------------------------------------—===// Override the default (LLVM specific) version printer used to print out the version when –version is given on the command line.

This allows other systems using the CommandLine utilities to print their own version string.

Definition at line 2814 of file CommandLine.cpp.

References CommonOptions.

◆ tokenizeConfigFile()

Tokenizes content of configuration file.

Parameters

It works like TokenizeGNUCommandLine with ability to skip comment lines.

Definition at line 1090 of file CommandLine.cpp.

References isWhitespace(), and TokenizeGNUCommandLine().

◆ TokenizeGNUCommandLine()

Tokenizes a command line that can contain escapes and quotes.

The quoting rules match those used by GCC and other tools that use libiberty's buildargv() or expandargv() utilities, and do not match bash. They differ from buildargv() on treatment of backslashes that do not escape a special character to make it possible to accept most Windows file paths.

Parameters

Definition at line 838 of file CommandLine.cpp.

References llvm::CallingConv::C, llvm::SmallVectorImpl< T >::clear(), llvm::StringRef::data(), llvm::SmallVectorTemplateCommon< T, typename >::empty(), I, isQuote(), isWhitespace(), llvm::SmallVectorTemplateBase< T, bool >::push_back(), llvm::StringSaver::save(), and llvm::SmallString< InternalLen >::str().

Referenced by expandResponseFiles(), ParseCommandLineOptions(), and tokenizeConfigFile().

◆ TokenizeWindowsCommandLine()

◆ TokenizeWindowsCommandLineFull()

Tokenizes a Windows full command line, including command name at the start.

This uses the same syntax rules as TokenizeWindowsCommandLine for all but the first token. But the first token is expected to be parsed as the executable file name in the way CreateProcess would do it, rather than the way the C library startup code would do it: CreateProcess does not consider that \ is ever an escape character (because " is not a valid filename char, hence there's never a need to escape it to be used literally).

Parameters are the same as for TokenizeWindowsCommandLine. In particular, if you set MarkEOLs = true, then the first word of every line will be parsed using the special rules for command names, making this function suitable for parsing a file full of commands to execute.

Definition at line 1078 of file CommandLine.cpp.

References llvm::SmallVectorTemplateBase< T, bool >::push_back(), and tokenizeWindowsCommandLineImpl().

◆ TokenizeWindowsCommandLineNoCopy()

◆ values()

template<typename... OptsTy>

◆ basic_parser< bool >

◆ basic_parser< boolOrDefault >

◆ basic_parser< char >

◆ basic_parser< double >

◆ basic_parser< float >

◆ basic_parser< int >

◆ basic_parser< long >

◆ basic_parser< long long >

◆ basic_parser< std::string >

◆ basic_parser< unsigned >

◆ basic_parser< unsigned long >

◆ basic_parser< unsigned long long >

◆ opt< bool >

◆ opt< char >

◆ opt< int >

◆ opt< std::string >

◆ opt< unsigned >