DerivedArgList - An ordered collection of driver arguments, whose storage may be in another argument list. More...

#include "llvm/Option/ArgList.h"

Inheritance diagram for llvm::opt::DerivedArgList:

Collaboration diagram for llvm::opt::DerivedArgList:

Public Member Functions
	DerivedArgList (const InputArgList &BaseArgs)
	Construct a new derived arg list from `BaseArgs`. More...

const char *	getArgString (unsigned Index) const override
	getArgString - Return the input argument string at `Index`. More...

unsigned	getNumInputArgStrings () const override
	getNumInputArgStrings - Return the number of original argument strings, which are guaranteed to be the first strings in the argument string list. More...

const InputArgList &	getBaseArgs () const

Arg Synthesis
void	AddSynthesizedArg (Arg *A)
	AddSynthesizedArg - Add a argument to the list of synthesized arguments (to be freed). More...

const char *	MakeArgStringRef (StringRef Str) const override
	Construct a constant string pointer whose lifetime will match that of the ArgList. More...

void	AddFlagArg (const Arg *BaseArg, const Option Opt)
	AddFlagArg - Construct a new FlagArg for the given option `Id` and append it to the argument list. More...

void	AddPositionalArg (const Arg *BaseArg, const Option Opt, StringRef Value)
	AddPositionalArg - Construct a new Positional arg for the given option `Id`, with the provided `Value` and append it to the argument list. More...

void	AddSeparateArg (const Arg *BaseArg, const Option Opt, StringRef Value)
	AddSeparateArg - Construct a new Positional arg for the given option `Id`, with the provided `Value` and append it to the argument list. More...

void	AddJoinedArg (const Arg *BaseArg, const Option Opt, StringRef Value)
	AddJoinedArg - Construct a new Positional arg for the given option `Id`, with the provided `Value` and append it to the argument list. More...

Arg *	MakeFlagArg (const Arg *BaseArg, const Option Opt) const
	MakeFlagArg - Construct a new FlagArg for the given option `Id`. More...

Arg *	MakePositionalArg (const Arg *BaseArg, const Option Opt, StringRef Value) const
	MakePositionalArg - Construct a new Positional arg for the given option `Id`, with the provided `Value`. More...

Arg *	MakeSeparateArg (const Arg *BaseArg, const Option Opt, StringRef Value) const
	MakeSeparateArg - Construct a new Positional arg for the given option `Id`, with the provided `Value`. More...

Arg *	MakeJoinedArg (const Arg *BaseArg, const Option Opt, StringRef Value) const
	MakeJoinedArg - Construct a new Positional arg for the given option `Id`, with the provided `Value`. More...

Public Member Functions inherited from llvm::opt::ArgList
void	append (Arg *A)
	append - Append `A` to the arg list. More...

const arglist_type &	getArgs () const

unsigned	size () const

template<typename ... OptSpecifiers>
bool	hasArgNoClaim (OptSpecifiers ...Ids) const
	hasArg - Does the arg list contain any option matching `Id`. More...

template<typename ... OptSpecifiers>
bool	hasArg (OptSpecifiers ...Ids) const

template<typename ... OptSpecifiers>
Arg *	getLastArg (OptSpecifiers ...Ids) const
	Return the last argument matching `Id`, or null. More...

template<typename ... OptSpecifiers>
Arg *	getLastArgNoClaim (OptSpecifiers ...Ids) const
	Return the last argument matching `Id`, or null. More...

iterator	begin ()

iterator	end ()

reverse_iterator	rbegin ()

reverse_iterator	rend ()

const_iterator	begin () const

const_iterator	end () const

const_reverse_iterator	rbegin () const

const_reverse_iterator	rend () const

template<typename ... OptSpecifiers>
iterator_range< filtered_iterator< sizeof...(OptSpecifiers)> >	filtered (OptSpecifiers ...Ids) const

template<typename ... OptSpecifiers>
iterator_range< filtered_reverse_iterator< sizeof...(OptSpecifiers)> >	filtered_reverse (OptSpecifiers ...Ids) const

void	eraseArg (OptSpecifier Id)
	eraseArg - Remove any option matching `Id`. More...

StringRef	getLastArgValue (OptSpecifier Id, StringRef Default="") const
	getLastArgValue - Return the value of the last argument, or a default. More...

std::vector< std::string >	getAllArgValues (OptSpecifier Id) const
	getAllArgValues - Get the values of all instances of the given argument as strings. More...

bool	hasFlag (OptSpecifier Pos, OptSpecifier Neg, bool Default=true) const
	hasFlag - Given an option `Pos` and its negative form `Neg`, return true if the option is present, false if the negation is present, and `Default` if neither option is given. More...

bool	hasFlag (OptSpecifier Pos, OptSpecifier PosAlias, OptSpecifier Neg, bool Default=true) const
	hasFlag - Given an option `Pos`, an alias `PosAlias` and its negative form `Neg`, return true if the option or its alias is present, false if the negation is present, and `Default` if none of the options are given. More...

void	AddLastArg (ArgStringList &Output, OptSpecifier Id0) const
	AddLastArg - Render only the last argument match `Id0`, if present. More...

void	AddLastArg (ArgStringList &Output, OptSpecifier Id0, OptSpecifier Id1) const

void	AddAllArgsExcept (ArgStringList &Output, ArrayRef< OptSpecifier > Ids, ArrayRef< OptSpecifier > ExcludeIds) const
	AddAllArgsExcept - Render all arguments matching any of the given ids and not matching any of the excluded ids. More...

void	AddAllArgs (ArgStringList &Output, ArrayRef< OptSpecifier > Ids) const
	AddAllArgs - Render all arguments matching any of the given ids. More...

void	AddAllArgs (ArgStringList &Output, OptSpecifier Id0, OptSpecifier Id1=0U, OptSpecifier Id2=0U) const
	AddAllArgs - Render all arguments matching the given ids. More...

void	AddAllArgValues (ArgStringList &Output, OptSpecifier Id0, OptSpecifier Id1=0U, OptSpecifier Id2=0U) const
	AddAllArgValues - Render the argument values of all arguments matching the given ids. More...

void	AddAllArgsTranslated (ArgStringList &Output, OptSpecifier Id0, const char *Translation, bool Joined=false) const
	AddAllArgsTranslated - Render all the arguments matching the given ids, but forced to separate args and using the provided name instead of the first option value. More...

void	ClaimAllArgs (OptSpecifier Id0) const
	ClaimAllArgs - Claim all arguments which match the given option id. More...

void	ClaimAllArgs () const
	ClaimAllArgs - Claim all arguments. More...

const char *	MakeArgString (const Twine &Str) const

const char *	GetOrMakeJoinedArgString (unsigned Index, StringRef LHS, StringRef RHS) const
	Create an arg string for (`LHS` + `RHS`), reusing the string at `Index` if possible. More...

void	print (raw_ostream &O) const

void	dump () const

Additional Inherited Members
Public Types inherited from llvm::opt::ArgList
using	arglist_type = SmallVector< Arg *, 16 >

using	iterator = arg_iterator< arglist_type::iterator >

using	const_iterator = arg_iterator< arglist_type::const_iterator >

using	reverse_iterator = arg_iterator< arglist_type::reverse_iterator >

using	const_reverse_iterator = arg_iterator< arglist_type::const_reverse_iterator >

template<unsigned N>
using	filtered_iterator = arg_iterator< arglist_type::const_iterator, N >

template<unsigned N>
using	filtered_reverse_iterator = arg_iterator< arglist_type::const_reverse_iterator, N >

Protected Member Functions inherited from llvm::opt::ArgList
	ArgList ()=default

	ArgList (ArgList &&RHS)

ArgList &	operator= (ArgList &&RHS)

	~ArgList ()=default

Static Protected Member Functions inherited from llvm::opt::ArgList
static OptSpecifier	toOptSpecifier (OptSpecifier S)

Detailed Description

DerivedArgList - An ordered collection of driver arguments, whose storage may be in another argument list.

Definition at line 434 of file ArgList.h.

Constructor & Destructor Documentation

◆ DerivedArgList()

DerivedArgList::DerivedArgList ( const InputArgList & BaseArgs )

Construct a new derived arg list from BaseArgs.

Definition at line 247 of file ArgList.cpp.

Member Function Documentation

◆ AddFlagArg()

void llvm::opt::DerivedArgList::AddFlagArg	(	const Arg *	BaseArg,
		const Option	Opt
	)

inline

AddFlagArg - Construct a new FlagArg for the given option Id and append it to the argument list.

Definition at line 468 of file ArgList.h.

References llvm::sys::path::append().

◆ AddJoinedArg()

void llvm::opt::DerivedArgList::AddJoinedArg	(	const Arg *	BaseArg,
		const Option	Opt,
		StringRef	Value
	)

inline

AddJoinedArg - Construct a new Positional arg for the given option Id, with the provided Value and append it to the argument list.

Definition at line 490 of file ArgList.h.

References llvm::sys::path::append().

◆ AddPositionalArg()

void llvm::opt::DerivedArgList::AddPositionalArg	(	const Arg *	BaseArg,
		const Option	Opt,
		StringRef	Value
	)

inline

AddPositionalArg - Construct a new Positional arg for the given option Id, with the provided Value and append it to the argument list.

Definition at line 475 of file ArgList.h.

References llvm::sys::path::append().

◆ AddSeparateArg()

void llvm::opt::DerivedArgList::AddSeparateArg	(	const Arg *	BaseArg,
		const Option	Opt,
		StringRef	Value
	)

inline

AddSeparateArg - Construct a new Positional arg for the given option Id, with the provided Value and append it to the argument list.

Definition at line 483 of file ArgList.h.

References llvm::sys::path::append().

◆ AddSynthesizedArg()

void DerivedArgList::AddSynthesizedArg ( Arg * A )

AddSynthesizedArg - Add a argument to the list of synthesized arguments (to be freed).

Definition at line 254 of file ArgList.cpp.

◆ getArgString()

const char* llvm::opt::DerivedArgList::getArgString ( unsigned Index ) const

inlineoverridevirtual

getArgString - Return the input argument string at Index.

Implements llvm::opt::ArgList.

Definition at line 444 of file ArgList.h.

References llvm::opt::InputArgList::getArgString().

◆ getBaseArgs()

const InputArgList& llvm::opt::DerivedArgList::getBaseArgs ( ) const

inline

Definition at line 452 of file ArgList.h.

References llvm::opt::ArgList::MakeArgString().

◆ getNumInputArgStrings()

unsigned llvm::opt::DerivedArgList::getNumInputArgStrings ( ) const

inlineoverridevirtual

getNumInputArgStrings - Return the number of original argument strings, which are guaranteed to be the first strings in the argument string list.

Implements llvm::opt::ArgList.

Definition at line 448 of file ArgList.h.

References llvm::opt::InputArgList::getNumInputArgStrings().

◆ MakeArgStringRef()

const char * DerivedArgList::MakeArgStringRef ( StringRef Str ) const

overridevirtual

Construct a constant string pointer whose lifetime will match that of the ArgList.

Implements llvm::opt::ArgList.

Definition at line 250 of file ArgList.cpp.

References llvm::opt::ArgList::MakeArgString().

◆ MakeFlagArg()

Arg * DerivedArgList::MakeFlagArg	(	const Arg *	BaseArg,
		const Option	Opt
	)		const

MakeFlagArg - Construct a new FlagArg for the given option Id.

Definition at line 258 of file ArgList.cpp.

References llvm::opt::Option::getName(), llvm::opt::Option::getPrefix(), llvm::opt::ArgList::MakeArgString(), and llvm::opt::InputArgList::MakeIndex().

◆ MakeJoinedArg()

Arg * DerivedArgList::MakeJoinedArg	(	const Arg *	BaseArg,
		const Option	Opt,
		StringRef	Value
	)		const

MakeJoinedArg - Construct a new Positional arg for the given option Id, with the provided Value.

Definition at line 283 of file ArgList.cpp.

References llvm::opt::InputArgList::getArgString(), llvm::opt::Option::getName(), llvm::opt::Option::getPrefix(), llvm::opt::ArgList::MakeArgString(), llvm::opt::InputArgList::MakeIndex(), and llvm::StringRef::size().

◆ MakePositionalArg()

Arg * DerivedArgList::MakePositionalArg	(	const Arg *	BaseArg,
		const Option	Opt,
		StringRef	Value
	)		const

MakePositionalArg - Construct a new Positional arg for the given option Id, with the provided Value.

Definition at line 265 of file ArgList.cpp.

References llvm::opt::InputArgList::getArgString(), llvm::opt::Option::getName(), llvm::opt::Option::getPrefix(), llvm::opt::ArgList::MakeArgString(), and llvm::opt::InputArgList::MakeIndex().

◆ MakeSeparateArg()

Arg * DerivedArgList::MakeSeparateArg	(	const Arg *	BaseArg,
		const Option	Opt,
		StringRef	Value
	)		const

MakeSeparateArg - Construct a new Positional arg for the given option Id, with the provided Value.

Definition at line 274 of file ArgList.cpp.

References llvm::opt::InputArgList::getArgString(), llvm::opt::Option::getName(), llvm::opt::Option::getPrefix(), llvm::opt::ArgList::MakeArgString(), and llvm::opt::InputArgList::MakeIndex().

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

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

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ DerivedArgList()

Member Function Documentation

◆ AddFlagArg()

◆ AddJoinedArg()

◆ AddPositionalArg()

◆ AddSeparateArg()

◆ AddSynthesizedArg()

◆ getArgString()

◆ getBaseArgs()

◆ getNumInputArgStrings()

◆ MakeArgStringRef()

◆ MakeFlagArg()

◆ MakeJoinedArg()

◆ MakePositionalArg()

◆ MakeSeparateArg()