Option - Abstract representation for a single form of driver argument. More...

#include "llvm/Option/Option.h"

Public Types
enum	OptionClass { GroupClass = 0 , InputClass , UnknownClass , FlagClass , JoinedClass , ValuesClass , SeparateClass , RemainingArgsClass , RemainingArgsJoinedClass , CommaJoinedClass , MultiArgClass , JoinedOrSeparateClass , JoinedAndSeparateClass }

enum	RenderStyleKind { RenderCommaJoinedStyle , RenderJoinedStyle , RenderSeparateStyle , RenderValuesStyle }

Public Member Functions
	Option (const OptTable::Info Info, const OptTable Owner)

bool	isValid () const

unsigned	getID () const

OptionClass	getKind () const

StringRef	getName () const
	Get the name of this option without any prefix.

const Option	getGroup () const

const Option	getAlias () const

const char *	getAliasArgs () const
	Get the alias arguments as a \0 separated list.

StringRef	getPrefix () const
	Get the default prefix for this option.

StringRef	getPrefixedName () const
	Get the name of this option with the default prefix.

StringRef	getHelpText () const
	Get the help text for this option.

StringRef	getMetaVar () const
	Get the meta-variable list for this option.

unsigned	getNumArgs () const

bool	hasNoOptAsInput () const

RenderStyleKind	getRenderStyle () const

bool	hasFlag (unsigned Val) const
	Test if this option has the flag Val.

bool	hasVisibilityFlag (unsigned Val) const
	Test if this option has the visibility flag Val.

const Option	getUnaliasedOption () const
	getUnaliasedOption - Return the final option this option aliases (itself, if the option has no alias).

StringRef	getRenderName () const
	getRenderName - Return the name to use when rendering this option.

bool	matches (OptSpecifier ID) const
	matches - Predicate for whether this option is part of the given option (which may be a group).

std::unique_ptr< Arg >	accept (const ArgList &Args, StringRef CurArg, bool GroupedShortOption, unsigned &Index) const
	Potentially accept the current argument, returning a new Arg instance, or 0 if the option does not accept this argument (or the argument is missing values).

void	print (raw_ostream &O, bool AddNewLine=true) const

void	dump () const

Protected Attributes
const OptTable::Info *	Info

const OptTable *	Owner

Detailed Description

Option - Abstract representation for a single form of driver argument.

An Option class represents a form of option that the driver takes, for example how many arguments the option has and how they can be provided. Individual option instances store additional information about what group the option is a member of (if any), if the option is an alias, and a number of flags. At runtime the driver parses the command line into concrete Arg instances, each of which corresponds to a particular Option instance.

Definition at line 54 of file Option.h.

Member Enumeration Documentation

◆ OptionClass

enum llvm::opt::Option::OptionClass

Enumerator
GroupClass
InputClass
UnknownClass
FlagClass
JoinedClass
ValuesClass
SeparateClass
RemainingArgsClass
RemainingArgsJoinedClass
CommaJoinedClass
MultiArgClass
JoinedOrSeparateClass
JoinedAndSeparateClass

Definition at line 56 of file Option.h.

◆ RenderStyleKind

enum llvm::opt::Option::RenderStyleKind

Enumerator
RenderCommaJoinedStyle
RenderJoinedStyle
RenderSeparateStyle
RenderValuesStyle

Definition at line 72 of file Option.h.

Constructor & Destructor Documentation

◆ Option()

Option::Option	(	const OptTable::Info *	Info,
		const OptTable *	Owner
	)

Definition at line 25 of file Option.cpp.

References assert(), FlagClass, getAlias(), getAliasArgs(), getKind(), Info, Info, and isValid().

Member Function Documentation

◆ accept()

std::unique_ptr< Arg > Option::accept	(	const ArgList &	Args,
		StringRef	CurArg,
		bool	GroupedShortOption,
		unsigned &	Index
	)		const

Potentially accept the current argument, returning a new Arg instance, or 0 if the option does not accept this argument (or the argument is missing values).

If the option accepts the current argument, accept() sets Index to the position where argument parsing should resume (even if the argument is missing values).

CurArg The argument to be matched. It may be shorter than the underlying storage to represent a Joined argument. GroupedShortOption If true, we are handling the fallback case of parsing a prefix of the current argument as a short option.

Definition at line 236 of file Option.cpp.

References A, FlagClass, getAliasArgs(), getID(), getKind(), getName(), llvm::opt::Arg::getOwnsValues(), getPrefix(), getUnaliasedOption(), llvm::opt::Arg::getValues(), JoinedClass, and llvm::opt::Arg::setOwnsValues().

◆ dump()

LLVM_DUMP_METHOD void Option::dump ( ) const

Definition at line 93 of file Option.cpp.

References llvm::dbgs(), and print().

Referenced by llvm::opt::OptTable::OptTable().

◆ getAlias()

const Option llvm::opt::Option::getAlias ( ) const

inline

Definition at line 113 of file Option.h.

References llvm::opt::OptTable::Info::AliasID, assert(), llvm::opt::OptTable::getOption(), Info, and Owner.

Referenced by getUnaliasedOption(), matches(), Option(), and print().

◆ getAliasArgs()

const char * llvm::opt::Option::getAliasArgs ( ) const

inline

Get the alias arguments as a \0 separated list.

E.g. ["foo", "bar"] would be returned as "foo\0bar\0".

Definition at line 121 of file Option.h.

References llvm::opt::OptTable::Info::AliasArgs, assert(), and Info.

Referenced by accept(), and Option().

◆ getGroup()

const Option llvm::opt::Option::getGroup ( ) const

inline

Definition at line 107 of file Option.h.

References assert(), llvm::opt::OptTable::getOption(), llvm::opt::OptTable::Info::GroupID, Info, and Owner.

Referenced by matches(), and print().

◆ getHelpText()

StringRef llvm::opt::Option::getHelpText ( ) const

inline

Get the help text for this option.

Definition at line 144 of file Option.h.

References assert(), llvm::opt::OptTable::Info::HelpText, and Info.

◆ getID()

unsigned llvm::opt::Option::getID ( ) const

inline

Definition at line 90 of file Option.h.

References assert(), llvm::opt::OptTable::Info::ID, and Info.

Referenced by accept(), and matches().

◆ getKind()

OptionClass llvm::opt::Option::getKind ( ) const

inline

Definition at line 95 of file Option.h.

References assert(), Info, and llvm::opt::OptTable::Info::Kind.

Referenced by accept(), getRenderStyle(), Option(), and print().

◆ getMetaVar()

StringRef llvm::opt::Option::getMetaVar ( ) const

inline

Get the meta-variable list for this option.

Definition at line 150 of file Option.h.

References assert(), Info, and llvm::opt::OptTable::Info::MetaVar.

◆ getName()

StringRef llvm::opt::Option::getName ( ) const

inline

Get the name of this option without any prefix.

Definition at line 101 of file Option.h.

References assert(), llvm::opt::OptTable::getOptionName(), llvm::opt::OptTable::Info::ID, Info, and Owner.

Referenced by accept(), getRenderName(), llvm::opt::DerivedArgList::MakeFlagArg(), llvm::opt::DerivedArgList::MakeJoinedArg(), llvm::opt::DerivedArgList::MakePositionalArg(), llvm::opt::DerivedArgList::MakeSeparateArg(), and print().

◆ getNumArgs()

unsigned llvm::opt::Option::getNumArgs ( ) const

inline

Definition at line 155 of file Option.h.

References Info, and llvm::opt::OptTable::Info::Param.

Referenced by print().

◆ getPrefix()

StringRef llvm::opt::Option::getPrefix ( ) const

inline

Get the default prefix for this option.

Definition at line 130 of file Option.h.

References assert(), llvm::opt::OptTable::getOptionPrefix(), llvm::opt::OptTable::Info::ID, Info, and Owner.

Referenced by accept(), llvm::opt::DerivedArgList::MakeFlagArg(), llvm::opt::DerivedArgList::MakeJoinedArg(), llvm::opt::DerivedArgList::MakePositionalArg(), and llvm::opt::DerivedArgList::MakeSeparateArg().

◆ getPrefixedName()

StringRef llvm::opt::Option::getPrefixedName ( ) const

inline

Get the name of this option with the default prefix.

Definition at line 137 of file Option.h.

References assert(), llvm::opt::OptTable::getOptionPrefixedName(), llvm::opt::OptTable::Info::ID, Info, and Owner.

◆ getRenderName()

StringRef llvm::opt::Option::getRenderName ( ) const

inline

getRenderName - Return the name to use when rendering this option.

Definition at line 206 of file Option.h.

References getName(), and getUnaliasedOption().

◆ getRenderStyle()

RenderStyleKind llvm::opt::Option::getRenderStyle ( ) const

inline

◆ getUnaliasedOption()

const Option llvm::opt::Option::getUnaliasedOption ( ) const

inline

getUnaliasedOption - Return the final option this option aliases (itself, if the option has no alias).

Definition at line 198 of file Option.h.

References getAlias(), getUnaliasedOption(), and isValid().

Referenced by accept(), getRenderName(), and getUnaliasedOption().

◆ hasFlag()

bool llvm::opt::Option::hasFlag ( unsigned Val ) const

inline

Test if this option has the flag Val.

Definition at line 187 of file Option.h.

References llvm::opt::OptTable::Info::Flags, and Info.

Referenced by llvm::opt::OptTable::ParseArgs(), and llvm::opt::OptTable::ParseOneArg().

◆ hasNoOptAsInput()

bool llvm::opt::Option::hasNoOptAsInput ( ) const

inline

Definition at line 157 of file Option.h.

References llvm::opt::OptTable::Info::Flags, Info, and llvm::opt::RenderAsInput.

◆ hasVisibilityFlag()

bool llvm::opt::Option::hasVisibilityFlag ( unsigned Val ) const

inline

Test if this option has the visibility flag Val.

Definition at line 192 of file Option.h.

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

Referenced by llvm::opt::OptTable::ParseArgs(), and llvm::opt::OptTable::ParseOneArg().

◆ isValid()

bool llvm::opt::Option::isValid ( ) const

inline

Definition at line 86 of file Option.h.

References Info.

Referenced by getUnaliasedOption(), matches(), Option(), and print().

◆ matches()

bool Option::matches ( OptSpecifier ID ) const

matches - Predicate for whether this option is part of the given option (which may be a group).

Note that matches against options which are an alias should never be done – aliases do not participate in matching and so such a query will always be false.

Definition at line 96 of file Option.cpp.

References getAlias(), getGroup(), getID(), llvm::opt::OptSpecifier::getID(), isValid(), and matches().

Referenced by llvm::opt::ArgList::AddAllArgsExcept(), and matches().

◆ print()

void Option::print	(	raw_ostream &	O,
		bool	AddNewLine = `true`
	)		const

Definition at line 40 of file Option.cpp.

References CommaJoinedClass, FlagClass, getAlias(), getGroup(), getKind(), getName(), getNumArgs(), llvm::opt::OptTable::Info::getNumPrefixes(), llvm::opt::OptTable::Info::getPrefix(), llvm::opt::OptTable::getPrefixesTable(), llvm::opt::OptTable::getStrTable(), GroupClass, llvm::opt::OptTable::Info::hasNoPrefix(), I, Info, InputClass, isValid(), JoinedAndSeparateClass, JoinedClass, JoinedOrSeparateClass, MultiArgClass, N, Owner, P, print(), RemainingArgsClass, RemainingArgsJoinedClass, SeparateClass, UnknownClass, and ValuesClass.

Referenced by dump(), llvm::opt::Arg::print(), and print().

Member Data Documentation

◆ Info

const OptTable::Info* llvm::opt::Option::Info

protected

Definition at line 80 of file Option.h.

Referenced by getAlias(), getAliasArgs(), getGroup(), getHelpText(), getID(), getKind(), getMetaVar(), getName(), getNumArgs(), getPrefix(), getPrefixedName(), getRenderStyle(), hasFlag(), hasNoOptAsInput(), hasVisibilityFlag(), isValid(), Option(), and print().

◆ Owner

const OptTable* llvm::opt::Option::Owner

protected

Definition at line 81 of file Option.h.

Referenced by getAlias(), getGroup(), getName(), getPrefix(), getPrefixedName(), and print().

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

include/llvm/Option/Option.h
lib/Option/Option.cpp

Public Types

Public Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ OptionClass

◆ RenderStyleKind

Constructor & Destructor Documentation

◆ Option()

Member Function Documentation

◆ accept()

◆ dump()

◆ getAlias()

◆ getAliasArgs()

◆ getGroup()

◆ getHelpText()

◆ getID()

◆ getKind()

◆ getMetaVar()

◆ getName()

◆ getNumArgs()

◆ getPrefix()

◆ getPrefixedName()

◆ getRenderName()

◆ getRenderStyle()

◆ getUnaliasedOption()

◆ hasFlag()

◆ hasNoOptAsInput()

◆ hasVisibilityFlag()

◆ isValid()

◆ matches()

◆ print()

Member Data Documentation

◆ Info

◆ Owner