A concrete instance of a particular driver option. More...

#include "llvm/Option/Arg.h"

Public Member Functions
LLVM_ABI	Arg (const Option Opt, StringRef Spelling, unsigned Index, const Arg *BaseArg=nullptr)

LLVM_ABI	Arg (const Option Opt, StringRef Spelling, unsigned Index, const char Value0, const Arg BaseArg=nullptr)

LLVM_ABI	Arg (const Option Opt, StringRef Spelling, unsigned Index, const char Value0, const char Value1, const Arg *BaseArg=nullptr)

	Arg (const Arg &)=delete

Arg &	operator= (const Arg &)=delete

LLVM_ABI	~Arg ()

const Option &	getOption () const

StringRef	getSpelling () const
	Returns the used prefix and name of the option: For `--foo=bar`, returns `--foo=`.

unsigned	getIndex () const

const Arg &	getBaseArg () const
	Return the base argument which generated this arg.

Arg &	getBaseArg ()

void	setBaseArg (const Arg *BaseArg)

const Arg *	getAlias () const
	Args are converted to their unaliased form.

void	setAlias (std::unique_ptr< Arg > Alias)

bool	getOwnsValues () const

void	setOwnsValues (bool Value) const

bool	isClaimed () const

void	claim () const

bool	isIgnoredTargetSpecific () const

void	ignoreTargetSpecific ()

unsigned	getNumValues () const

const char *	getValue (unsigned N=0) const

SmallVectorImpl< const char * > &	getValues ()

const SmallVectorImpl< const char * > &	getValues () const

bool	containsValue (StringRef Value) const

LLVM_ABI void	render (const ArgList &Args, ArgStringList &Output) const
	Append the argument onto the given array as strings.

LLVM_ABI void	renderAsInput (const ArgList &Args, ArgStringList &Output) const
	Append the argument, render as an input, onto the given array as strings.

LLVM_ABI void	print (raw_ostream &O) const

LLVM_ABI void	dump () const

LLVM_ABI std::string	getAsString (const ArgList &Args) const
	Return a formatted version of the argument and its values, for diagnostics.

Detailed Description

A concrete instance of a particular driver option.

The Arg class encodes just enough information to be able to derive the argument values efficiently.

Definition at line 35 of file Arg.h.

Constructor & Destructor Documentation

◆ Arg() [1/4]

Arg::Arg	(	const Option	Opt,
		StringRef	Spelling,
		unsigned	Index,
		const Arg *	BaseArg = `nullptr`
	)

Definition at line 22 of file Arg.cpp.

◆ Arg() [2/4]

Arg::Arg	(	const Option	Opt,
		StringRef	Spelling,
		unsigned	Index,
		const char *	Value0,
		const Arg *	BaseArg = `nullptr`
	)

Definition at line 26 of file Arg.cpp.

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

◆ Arg() [3/4]

Arg::Arg	(	const Option	Opt,
		StringRef	Spelling,
		unsigned	Index,
		const char *	Value0,
		const char *	Value1,
		const Arg *	BaseArg = `nullptr`
	)

Definition at line 33 of file Arg.cpp.

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

◆ Arg() [4/4]

llvm::opt::Arg::Arg ( const Arg & )

delete

◆ ~Arg()

Arg::~Arg ( )

Definition at line 41 of file Arg.cpp.

Member Function Documentation

◆ claim()

void llvm::opt::Arg::claim ( ) const

inline

Definition at line 116 of file Arg.h.

References getBaseArg().

Referenced by llvm::opt::ArgList::AddAllArgs(), llvm::opt::ArgList::AddAllArgsExcept(), llvm::opt::ArgList::AddAllArgsTranslated(), llvm::opt::ArgList::AddAllArgValues(), llvm::opt::ArgList::ClaimAllArgs(), and llvm::opt::ArgList::getLastArg().

◆ containsValue()

bool llvm::opt::Arg::containsValue ( StringRef Value ) const

inline

Definition at line 134 of file Arg.h.

References llvm::is_contained().

◆ dump()

LLVM_DUMP_METHOD void Arg::dump ( ) const

Definition at line 64 of file Arg.cpp.

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

◆ getAlias()

const Arg * llvm::opt::Arg::getAlias ( ) const

inline

Args are converted to their unaliased form.

For args that originally came from an alias, this returns the alias the arg was produced from.

Definition at line 109 of file Arg.h.

◆ getAsString()

std::string Arg::getAsString ( const ArgList & Args ) const

Return a formatted version of the argument and its values, for diagnostics.

Since this is for diagnostics, if this Arg was produced through an alias, this returns the string representation of the alias that the user wrote.

Definition at line 67 of file Arg.cpp.

References llvm::interleaved(), OS, and render().

Referenced by llvm::dlltoolDriverMain(), and llvm::libDriverMain().

◆ getBaseArg() [1/2]

Arg & llvm::opt::Arg::getBaseArg ( )

inline

Definition at line 104 of file Arg.h.

◆ getBaseArg() [2/2]

const Arg & llvm::opt::Arg::getBaseArg ( ) const

inline

Return the base argument which generated this arg.

This is either the argument itself or the argument it was derived from during tool chain specific argument translation.

Definition at line 101 of file Arg.h.

Referenced by claim(), ignoreTargetSpecific(), isClaimed(), and isIgnoredTargetSpecific().

◆ getIndex()

unsigned llvm::opt::Arg::getIndex ( ) const

inline

Definition at line 95 of file Arg.h.

Referenced by render().

◆ getNumValues()

unsigned llvm::opt::Arg::getNumValues ( ) const

inline

Definition at line 125 of file Arg.h.

References llvm::SmallVectorBase< Size_T >::size().

◆ getOption()

const Option & llvm::opt::Arg::getOption ( ) const

inline

Definition at line 85 of file Arg.h.

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

◆ getOwnsValues()

bool llvm::opt::Arg::getOwnsValues ( ) const

inline

Definition at line 112 of file Arg.h.

Referenced by llvm::opt::Option::accept().

◆ getSpelling()

StringRef llvm::opt::Arg::getSpelling ( ) const

inline

Returns the used prefix and name of the option: For --foo=bar, returns --foo=.

This is often the wrong function to call:

Use getValue() to get bar.
Use getAsString() to get a string suitable for printing an Arg in a diagnostic.

Definition at line 93 of file Arg.h.

Referenced by render().

◆ getValue()

const char * llvm::opt::Arg::getValue ( unsigned N = 0 ) const

inline

Definition at line 127 of file Arg.h.

References N.

Referenced by llvm::opt::ArgList::AddAllArgsTranslated(), llvm::dlltoolDriverMain(), doList(), getSearchPaths(), llvm::libDriverMain(), and render().

◆ getValues() [1/2]

SmallVectorImpl< const char * > & llvm::opt::Arg::getValues ( )

inline

Definition at line 131 of file Arg.h.

Referenced by llvm::opt::Option::accept(), llvm::opt::ArgList::AddAllArgValues(), and render().

◆ getValues() [2/2]

const SmallVectorImpl< const char * > & llvm::opt::Arg::getValues ( ) const

inline

Definition at line 132 of file Arg.h.

◆ ignoreTargetSpecific()

void llvm::opt::Arg::ignoreTargetSpecific ( )

inline

Definition at line 121 of file Arg.h.

References getBaseArg().

◆ isClaimed()

bool llvm::opt::Arg::isClaimed ( ) const

inline

Definition at line 115 of file Arg.h.

References getBaseArg().

Referenced by llvm::opt::ArgList::ClaimAllArgs().

◆ isIgnoredTargetSpecific()

bool llvm::opt::Arg::isIgnoredTargetSpecific ( ) const

inline

Definition at line 118 of file Arg.h.

References getBaseArg().

◆ operator=()

Arg & llvm::opt::Arg::operator= ( const Arg & )

delete

◆ print()

void Arg::print ( raw_ostream & O ) const

Definition at line 48 of file Arg.cpp.

References llvm::opt::Option::print(), and llvm::SmallVectorBase< Size_T >::size().

Referenced by dump().

◆ render()

void Arg::render	(	const ArgList &	Args,
		ArgStringList &	Output
	)		const

Append the argument onto the given array as strings.

Definition at line 89 of file Arg.cpp.

References llvm::SmallVectorImpl< T >::append(), llvm::SmallVectorTemplateCommon< T, typename >::begin(), llvm::SmallVectorTemplateCommon< T, typename >::end(), getIndex(), getOption(), getSpelling(), getValue(), getValues(), llvm::interleaved(), OS, llvm::SmallVectorTemplateBase< T, bool >::push_back(), llvm::opt::Option::RenderCommaJoinedStyle, llvm::opt::Option::RenderJoinedStyle, llvm::opt::Option::RenderSeparateStyle, and llvm::opt::Option::RenderValuesStyle.

Referenced by llvm::opt::ArgList::AddAllArgs(), llvm::opt::ArgList::AddAllArgsExcept(), getAsString(), and renderAsInput().

◆ renderAsInput()

void Arg::renderAsInput	(	const ArgList &	Args,
		ArgStringList &	Output
	)		const

Append the argument, render as an input, onto the given array as strings.

The distinction is that some options only render their values when rendered as a input (e.g., Xlinker).

Definition at line 80 of file Arg.cpp.

References llvm::SmallVectorImpl< T >::append(), llvm::SmallVectorTemplateCommon< T, typename >::begin(), llvm::SmallVectorTemplateCommon< T, typename >::end(), getOption(), and render().

◆ setAlias()

void llvm::opt::Arg::setAlias ( std::unique_ptr< Arg > Alias )

inline

Definition at line 110 of file Arg.h.

◆ setBaseArg()

void llvm::opt::Arg::setBaseArg ( const Arg * BaseArg )

inline

Definition at line 105 of file Arg.h.

◆ setOwnsValues()

void llvm::opt::Arg::setOwnsValues ( bool Value ) const

inline

Definition at line 113 of file Arg.h.

Referenced by llvm::opt::Option::accept().

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

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

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ Arg() [1/4]

◆ Arg() [2/4]

◆ Arg() [3/4]

◆ Arg() [4/4]

◆ ~Arg()

Member Function Documentation

◆ claim()

◆ containsValue()

◆ dump()

◆ getAlias()

◆ getAsString()

◆ getBaseArg() [1/2]

◆ getBaseArg() [2/2]

◆ getIndex()

◆ getNumValues()

◆ getOption()

◆ getOwnsValues()

◆ getSpelling()

◆ getValue()

◆ getValues() [1/2]

◆ getValues() [2/2]

◆ ignoreTargetSpecific()

◆ isClaimed()

◆ isIgnoredTargetSpecific()

◆ operator=()

◆ print()

◆ render()

◆ renderAsInput()

◆ setAlias()

◆ setBaseArg()

◆ setOwnsValues()