LLVM: llvm::opt::OptTable Class Reference (original) (raw)

Provide access to the Option info table. More...

#include "[llvm/Option/OptTable.h](OptTable%5F8h%5Fsource.html)"

Classes
struct Info
Entry for a single option instance in the option data table. More...
struct SubCommand
Represents a subcommand and its options in the option table. More...
Public Member Functions
bool isValidForSubCommand (const Info *CandidateInfo, StringRef SubCommand) const
virtual ~OptTable ()
const StringTable & getStrTable () const
Return the string table used for option names.
ArrayRef< SubCommand > getSubCommands () const
ArrayRef< StringTable::Offset > getPrefixesTable () const
Return the prefixes table used for option names.
unsigned getNumOptions () const
Return the total number of option classes.
const Option getOption (OptSpecifier Opt) const
Get the given Opt's Option instance, lazily creating it if necessary.
StringRef getOptionName (OptSpecifier id) const
Lookup the name of the given option.
StringRef getOptionPrefix (OptSpecifier id) const
Lookup the prefix of the given option.
void appendOptionPrefixes (OptSpecifier id, SmallVectorImpl< StringRef > &Prefixes) const
StringRef getOptionPrefixedName (OptSpecifier id) const
Lookup the prefixed name of the given option.
unsigned getOptionKind (OptSpecifier id) const
Get the kind of the given option.
unsigned getOptionGroupID (OptSpecifier id) const
Get the group id for the given option.
const char * getOptionHelpText (OptSpecifier id) const
Get the help text to use to describe this option.
const char * getOptionHelpText (OptSpecifier id, Visibility VisibilityMask) const
const char * getOptionMetaVar (OptSpecifier id) const
Get the meta-variable name to use when describing this options values in the help text.
void setInitialOptionsFromEnvironment (const char *E)
Specify the environment variable where initial options should be read.
void setGroupedShortOptions (bool Value)
Support grouped short options. e.g. -ab represents -a -b.
void setDashDashParsing (bool Value)
Set whether "--" stops option parsing and treats all subsequent arguments as positional.
std::vector< std::string > suggestValueCompletions (StringRef Option, StringRef Arg) const
Find possible value for given flags.
std::vector< std::string > findByPrefix (StringRef Cur, Visibility VisibilityMask, unsigned int DisableFlags) const
Find flags from OptTable which starts with Cur.
unsigned findNearest (StringRef Option, std::string &NearestString, Visibility VisibilityMask=Visibility(), unsigned MinimumLength=4, unsigned MaximumDistance=UINT_MAX) const
Find the OptTable option that most closely matches the given string.
unsigned findNearest (StringRef Option, std::string &NearestString, unsigned FlagsToInclude, unsigned FlagsToExclude=0, unsigned MinimumLength=4, unsigned MaximumDistance=UINT_MAX) const
bool findExact (StringRef Option, std::string &ExactString, Visibility VisibilityMask=Visibility()) const
bool findExact (StringRef Option, std::string &ExactString, unsigned FlagsToInclude, unsigned FlagsToExclude=0) const
std::unique_ptr< Arg > ParseOneArg (const ArgList &Args, unsigned &Index, Visibility VisibilityMask=Visibility()) const
Parse a single argument; returning the new argument and updating Index.
std::unique_ptr< Arg > ParseOneArg (const ArgList &Args, unsigned &Index, unsigned FlagsToInclude, unsigned FlagsToExclude) const
InputArgList ParseArgs (ArrayRef< const char * > Args, unsigned &MissingArgIndex, unsigned &MissingArgCount, Visibility VisibilityMask=Visibility()) const
Parse an list of arguments into an InputArgList.
InputArgList ParseArgs (ArrayRef< const char * > Args, unsigned &MissingArgIndex, unsigned &MissingArgCount, unsigned FlagsToInclude, unsigned FlagsToExclude=0) const
InputArgList parseArgs (int Argc, char *const *Argv, OptSpecifier Unknown, StringSaver &Saver, std::function< void(StringRef)> ErrorFn) const
A convenience helper which handles optional initial options populated from an environment variable, expands response files recursively and parses options.
void printHelp (raw_ostream &OS, const char *Usage, const char *Title, bool ShowHidden=false, bool ShowAllAliases=false, Visibility VisibilityMask=Visibility(), StringRef SubCommand={}) const
Render the help text for an option table.
void printHelp (raw_ostream &OS, const char *Usage, const char *Title, unsigned FlagsToInclude, unsigned FlagsToExclude, bool ShowAllAliases) const
Protected Attributes
unsigned FirstSearchableIndex = 0
The index of the first option which can be parsed (i.e., is not a special option like 'input' or 'unknown', and is not an option group).
SmallVector< StringRef > PrefixesUnion
The union of all option prefixes.
SmallString< 8 > PrefixChars
The union of the first element of all option prefixes.

Provide access to the Option info table.

The OptTable class provides a layer of indirection which allows Option instance to be created lazily. In the common case, only a few options will be needed at runtime; the OptTable class maintains enough information to parse command lines without instantiating Options, while letting other parts of the driver still use Option instances where convenient.

Definition at line 54 of file OptTable.h.

◆ ~OptTable()

OptTable::~OptTable ( ) virtualdefault

◆ appendOptionPrefixes()

◆ buildPrefixChars()

void OptTable::buildPrefixChars ( ) protected

◆ findByPrefix()

◆ findExact() [1/2]

bool llvm::opt::OptTable::findExact ( StringRef Option, std::string & ExactString, unsigned FlagsToInclude, unsigned FlagsToExclude = 0 ) const inline

◆ findExact() [2/2]

◆ findNearest() [1/2]

◆ findNearest() [2/2]

Find the OptTable option that most closely matches the given string.

Parameters

[in] Option - A string, such as "-stdlibs=l", that represents user input of an option that may not exist in the OptTable. Note that the string includes prefix dashes "-" as well as values "=l".
[out] NearestString - The nearest option string found in the OptTable.
[in] VisibilityMask - Only include options with any of these visibility flags set.
[in] MinimumLength - Don't find options shorter than this length. For example, a minimum length of 3 prevents "-x" from being considered near to "-S".
[in] MaximumDistance - Don't find options whose distance is greater than this value.

Returns

The edit distance of the nearest string found.

Definition at line 237 of file OptTable.cpp.

References llvm::opt::OptTable::Info::Visibility.

Referenced by findExact(), findExact(), and parseArgs().

◆ getNumOptions()

unsigned llvm::opt::OptTable::getNumOptions ( ) const inline

◆ getOption()

◆ getOptionGroupID()

◆ getOptionHelpText() [1/2]

◆ getOptionHelpText() [2/2]

◆ getOptionKind()

Get the kind of the given option.

Definition at line 269 of file OptTable.h.

◆ getOptionMetaVar()

Get the meta-variable name to use when describing this options values in the help text.

Definition at line 298 of file OptTable.h.

Referenced by getOptionHelpName().

◆ getOptionName()

Lookup the name of the given option.

Definition at line 246 of file OptTable.h.

◆ getOptionPrefix()

Lookup the prefix of the given option.

Definition at line 251 of file OptTable.h.

References I.

◆ getOptionPrefixedName()

Lookup the prefixed name of the given option.

Definition at line 264 of file OptTable.h.

◆ getPrefixesTable()

Return the prefixes table used for option names.

Definition at line 232 of file OptTable.h.

◆ getStrTable()

Return the string table used for option names.

Definition at line 227 of file OptTable.h.

◆ getSubCommands()

◆ isValidForSubCommand()

◆ ParseArgs() [1/2]

◆ ParseArgs() [2/2]

Parse an list of arguments into an InputArgList.

The resulting InputArgList will reference the strings in [ArgBegin, ArgEnd), and their lifetime should extend past that of the returned InputArgList.

The only error that can occur in this routine is if an argument is missing values; in this case MissingArgCount will be non-zero.

Parameters

MissingArgIndex - On error, the index of the option which could not be parsed.
MissingArgCount - On error, the number of missing options.
VisibilityMask - Only include options with any of these visibility flags set.

Returns

An InputArgList; on error this will contain all the options which could be parsed.

Definition at line 502 of file OptTable.cpp.

References llvm::opt::Option::hasVisibilityFlag().

Referenced by parseArgs().

◆ parseArgs()

◆ ParseOneArg() [1/2]

◆ ParseOneArg() [2/2]

Parse a single argument; returning the new argument and updating Index.

Parameters

[in,out] Index - The current parsing position in the argument string list; on return this will be the index of the next argument string to parse.
[in] VisibilityMask - Only include options with any of these visibility flags set.

Returns

The parsed argument, or 0 if the argument is missing values (in which case Index still points at the conceptual next argument string to parse).

Definition at line 418 of file OptTable.cpp.

References llvm::opt::Option::hasVisibilityFlag().

◆ printHelp() [1/2]

Render the help text for an option table.

Parameters

OS - The stream to write the help text to.
Usage - USAGE: Usage
Title - OVERVIEW: Title
VisibilityMask - Only in Visibility VisibilityMask,clude options with any of these visibility flags set.
ShowHidden - If true, display options marked as HelpHidden
ShowAllAliases - If true, display all options including aliases that don't have help texts. By default, we display only options that are not hidden and have help texts.

Definition at line 718 of file OptTable.cpp.

References llvm::opt::OptTable::Info::Visibility.

◆ printHelp() [2/2]

◆ setDashDashParsing()

void llvm::opt::OptTable::setDashDashParsing ( bool Value) inline

Set whether "--" stops option parsing and treats all subsequent arguments as positional.

E.g. – -a -b gives two positional inputs.

Definition at line 310 of file OptTable.h.

◆ setGroupedShortOptions()

void llvm::opt::OptTable::setGroupedShortOptions ( bool Value) inline

Support grouped short options. e.g. -ab represents -a -b.

Definition at line 306 of file OptTable.h.

◆ setInitialOptionsFromEnvironment()

void llvm::opt::OptTable::setInitialOptionsFromEnvironment ( const char * E) inline

Specify the environment variable where initial options should be read.

Definition at line 303 of file OptTable.h.

References E().

◆ suggestValueCompletions()

std::vector< std::string > OptTable::suggestValueCompletions ( StringRef Option,
StringRef Arg ) const

◆ FirstSearchableIndex

unsigned llvm::opt::OptTable::FirstSearchableIndex = 0 protected

◆ PrefixChars

◆ PrefixesUnion

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