Classes
class	OptionCategory
class	Option
struct	desc
struct	value_desc
struct	initializer
struct	LocationClass
struct	cat
struct	GenericOptionValue
struct	OptionValueBase
class	OptionValueCopy
struct	OptionValueBase< DataType, false >
struct	OptionValue
struct	OptionValue< cl::boolOrDefault >
struct	OptionValue< std::string >
class	ValuesClass
class	generic_parser_base
class	parser
class	basic_parser_impl
class	basic_parser
class	parser< bool >
class	parser< boolOrDefault >
class	parser< int >
class	parser< unsigned >
class	parser< unsigned long long >
class	parser< double >
class	parser< float >
class	parser< std::string >
class	parser< char >
struct	OptionDiffPrinter
struct	OptionDiffPrinter< DT, DT >
struct	applicator
struct	applicator< char[n]>
struct	applicator< const char[n]>
struct	applicator< const char * >
struct	applicator< NumOccurrencesFlag >
struct	applicator< ValueExpected >
struct	applicator< OptionHidden >
struct	applicator< FormattingFlags >
struct	applicator< MiscFlags >
class	opt_storage
class	opt_storage< DataType, false, true >
class	opt_storage< DataType, false, false >
class	opt
class	list_storage
class	list_storage< DataType, bool >
class	list
struct	multi_val
class	bits_storage
class	bits_storage< DataType, bool >
class	bits
class	alias
struct	aliasopt
struct	extrahelp
Enumerations
enum	NumOccurrencesFlag { Optional = 0x00, ZeroOrMore = 0x01, Required = 0x02, OneOrMore = 0x03, ConsumeAfter = 0x04 }
enum	ValueExpected { ValueOptional = 0x01, ValueRequired = 0x02, ValueDisallowed = 0x03 }
enum	OptionHidden { NotHidden = 0x00, Hidden = 0x01, ReallyHidden = 0x02 }
enum	FormattingFlags { NormalFormatting = 0x00, Positional = 0x01, Prefix = 0x02, Grouping = 0x03 }
enum	MiscFlags { CommaSeparated = 0x01, PositionalEatsArgs = 0x02, Sink = 0x04 }
enum	boolOrDefault { BOU_UNSET, BOU_TRUE, BOU_FALSE }
Functions
void	ParseCommandLineOptions (int argc, const char const argv, const char *Overview=0)
void	ParseEnvironmentOptions (const char progName, const char envvar, const char *Overview=0)
void	SetVersionPrinter (void(*func)())
void	AddExtraVersionPrinter (void(*func)())
void	PrintOptionValues ()
void	MarkOptionsChanged ()
template<class Ty >
initializer< Ty >	init (const Ty &Val)
template<class Ty >
LocationClass< Ty >	location (Ty &L)
template<class DataType >
ValuesClass< DataType > END_WITH_NULL	values (const char Arg, DataType Val, const char Desc,...)
	EXTERN_TEMPLATE_INSTANTIATION (class basic_parser< bool >)
	EXTERN_TEMPLATE_INSTANTIATION (class basic_parser< boolOrDefault >)
	EXTERN_TEMPLATE_INSTANTIATION (class basic_parser< int >)
	EXTERN_TEMPLATE_INSTANTIATION (class basic_parser< unsigned >)
	EXTERN_TEMPLATE_INSTANTIATION (class basic_parser< unsigned long long >)
	EXTERN_TEMPLATE_INSTANTIATION (class basic_parser< double >)
	EXTERN_TEMPLATE_INSTANTIATION (class basic_parser< float >)
	EXTERN_TEMPLATE_INSTANTIATION (class basic_parser< std::string >)
	EXTERN_TEMPLATE_INSTANTIATION (class basic_parser< char >)
template<class ParserClass , class DT >
void	printOptionDiff (const Option &O, const generic_parser_base &P, const DT &V, const OptionValue< DT > &Default, size_t GlobalWidth)
template<class ParserClass , class ValDT >
void	printOptionDiff (const Option &O, const basic_parser< typename ParserClass::parser_data_type > &P, const ValDT &V, const OptionValue< ValDT > &Default, size_t GlobalWidth)
template<class Mod , class Opt >
void	apply (const Mod &M, Opt *O)
	EXTERN_TEMPLATE_INSTANTIATION (class opt< unsigned >)
	EXTERN_TEMPLATE_INSTANTIATION (class opt< int >)
	EXTERN_TEMPLATE_INSTANTIATION (class opt< std::string >)
	EXTERN_TEMPLATE_INSTANTIATION (class opt< char >)
	EXTERN_TEMPLATE_INSTANTIATION (class opt< bool >)
void	PrintVersionMessage ()
	Utility function for printing version number.
void	PrintHelpMessage (bool Hidden=false, bool Categorized=false)
void	getRegisteredOptions (StringMap< Option * > &Map)
	Use this to get a StringMap to all registered named options (e.g. -help). Note `Map` Should be an empty StringMap.
	TEMPLATE_INSTANTIATION (class basic_parser< bool >)
	TEMPLATE_INSTANTIATION (class basic_parser< boolOrDefault >)
	TEMPLATE_INSTANTIATION (class basic_parser< int >)
	TEMPLATE_INSTANTIATION (class basic_parser< unsigned >)
	TEMPLATE_INSTANTIATION (class basic_parser< unsigned long long >)
	TEMPLATE_INSTANTIATION (class basic_parser< double >)
	TEMPLATE_INSTANTIATION (class basic_parser< float >)
	TEMPLATE_INSTANTIATION (class basic_parser< std::string >)
	TEMPLATE_INSTANTIATION (class basic_parser< char >)
	TEMPLATE_INSTANTIATION (class opt< unsigned >)
	TEMPLATE_INSTANTIATION (class opt< int >)
	TEMPLATE_INSTANTIATION (class opt< std::string >)
	TEMPLATE_INSTANTIATION (class opt< char >)
	TEMPLATE_INSTANTIATION (class opt< bool >)
Variables
OptionCategory	GeneralCategory

Detailed Description

cl Namespace - This namespace contains all of the command line option processing machinery. It is intentionally a short name to make qualified usage concise.

Enumeration Type Documentation

enum llvm::cl::boolOrDefault

Enumerator:

BOU_UNSET
BOU_TRUE
BOU_FALSE

Definition at line 429 of file CommandLine.h.

enum llvm::cl::FormattingFlags

Enumerator:

NormalFormatting
Positional
Prefix
Grouping

Definition at line 128 of file CommandLine.h.

enum llvm::cl::MiscFlags

Enumerator:

CommaSeparated
PositionalEatsArgs
Sink

Definition at line 135 of file CommandLine.h.

enum llvm::cl::NumOccurrencesFlag

Enumerator:

Optional
ZeroOrMore
Required
OneOrMore
ConsumeAfter

Definition at line 84 of file CommandLine.h.

enum llvm::cl::OptionHidden

Enumerator:

NotHidden
Hidden
ReallyHidden

Definition at line 107 of file CommandLine.h.

enum llvm::cl::ValueExpected

Enumerator:

ValueOptional
ValueRequired
ValueDisallowed

Definition at line 100 of file CommandLine.h.

Function Documentation

void llvm::cl::AddExtraVersionPrinter ( void(*)() func )

===---------------------------------------------------------------------===// 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 1589 of file CommandLine.cpp.

References ExtraVersionPrinters.

template<class Mod , class Opt >

void llvm::cl::apply	(	const Mod &	M,
		Opt *	O
	)

Definition at line 1039 of file CommandLine.h.

References llvm::cl::applicator< Mod >::opt().

Referenced by llvm::cl::alias::alias(), llvm::cl::bits< DataType, Storage, ParserClass >::bits(), llvm::cl::list< DataType, Storage, ParserClass >::list(), and llvm::cl::opt< DataType, ExternalStorage, ParserClass >::opt().

llvm::cl::EXTERN_TEMPLATE_INSTANTIATION ( class basic_parser< bool > )

llvm::cl::EXTERN_TEMPLATE_INSTANTIATION ( class basic_parser< boolOrDefault > )

llvm::cl::EXTERN_TEMPLATE_INSTANTIATION ( class basic_parser< int > )

llvm::cl::EXTERN_TEMPLATE_INSTANTIATION ( class basic_parser< unsigned > )

llvm::cl::EXTERN_TEMPLATE_INSTANTIATION ( class basic_parser< unsigned long long > )

llvm::cl::EXTERN_TEMPLATE_INSTANTIATION ( class basic_parser< double > )

llvm::cl::EXTERN_TEMPLATE_INSTANTIATION ( class basic_parser< float > )

llvm::cl::EXTERN_TEMPLATE_INSTANTIATION ( class basic_parser< std::string > )

llvm::cl::EXTERN_TEMPLATE_INSTANTIATION ( class basic_parser< char > )

llvm::cl::EXTERN_TEMPLATE_INSTANTIATION ( class opt< unsigned > )

llvm::cl::EXTERN_TEMPLATE_INSTANTIATION ( class opt< int > )

llvm::cl::EXTERN_TEMPLATE_INSTANTIATION ( class opt< std::string > )

llvm::cl::EXTERN_TEMPLATE_INSTANTIATION ( class opt< char > )

llvm::cl::EXTERN_TEMPLATE_INSTANTIATION ( class opt< bool > )

void llvm::cl::getRegisteredOptions ( StringMap< Option * > & Map )

Use this to get a StringMap to all registered named options (e.g. -help). Note Map Should be an empty StringMap.

Parameters:

[out] Map will be filled with mappings where the key is the Option argument string (e.g. "help") and value is the corresponding Option*.

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[]) {
 StringMap<llvm::cl::Option*> opts;
 llvm::cl::getRegisteredOptions(opts);
 assert(opts.count("help") == 1)
 opts["help"]->setDescription("Show alphabetical help information")
 // More code
 llvm::cl::ParseCommandLineOptions(argc,argv);
 //More code
 }

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::cl::ParseCommandLineOptions().

Definition at line 1596 of file CommandLine.cpp.

References GetOptionInfo(), and llvm::StringMapImpl::size().

template<class Ty >

initializer<Ty> llvm::cl::init ( const Ty & Val )

Definition at line 314 of file CommandLine.h.

Referenced by llvm::StringMapImpl::LookupBucketFor(), and llvm::StringMapImpl::StringMapImpl().

template<class Ty >

LocationClass<Ty> llvm::cl::location ( Ty & L )

Definition at line 333 of file CommandLine.h.

Referenced by setPrefixPresent().

void llvm::cl::MarkOptionsChanged ( )

Definition at line 93 of file CommandLine.cpp.

References OptionListChanged.

Referenced by llvm::cl::Option::addArgument(), and llvm::cl::parser< const PassInfo * >::addLiteralOption().

void llvm::cl::ParseCommandLineOptions	(	int	argc,
		const char const	argv,
		const char *	Overview = `0`
	)

Definition at line 531 of file CommandLine.cpp.

References llvm::cl::Option::ArgStr, llvm::SmallVectorTemplateCommon< T >::begin(), llvm::StringMap< ValueTy, AllocatorTy >::begin(), llvm::StringMap< ValueTy, AllocatorTy >::clear(), llvm::SmallVectorImpl< T >::clear(), ConsumeAfter, llvm::dbgs(), DEBUG, EatsUnboundedNumberOfValues(), llvm::SmallVectorBase::empty(), llvm::StringMapImpl::empty(), llvm::StringRef::empty(), llvm::SmallVectorTemplateCommon< T >::end(), llvm::StringMap< ValueTy, AllocatorTy >::end(), llvm::cl::Option::error(), llvm::errs(), ExpandResponseFiles(), llvm::sys::path::filename(), llvm::LibFunc::free, llvm::cl::Option::getFormattingFlag(), llvm::cl::Option::getMiscFlags(), GetOptionInfo(), HandlePrefixedOrGroupedOption(), I, llvm_unreachable, LookupNearestOption(), LookupOption(), llvm::LibFunc::memcpy, MoreHelp, OneOrMore, Optional, OptionListChanged, Positional, PositionalEatsArgs, ProgramName, ProgramOverview, ProvideOption(), ProvidePositionalOption(), llvm::SmallVectorTemplateBase< T, isPodLike< T >::value >::push_back(), Required, RequiresValue(), llvm::SmallVectorTemplateCommon< T >::size(), llvm::LibFunc::strdup, llvm::StringRef::substr(), and ZeroOrMore.

Referenced by ParseEnvironmentOptions().

void llvm::cl::ParseEnvironmentOptions	(	const char *	progName,
		const char *	envVar,
		const char *	Overview = `0`
	)

ParseEnvironmentOptions - An alternative entry point to the CommandLine library, which allows you to read the program's name from the caller (as PROGNAME) and its command-line arguments from an environment variable (whose name is given in ENVVAR).

Definition at line 477 of file CommandLine.cpp.

References llvm::LibFunc::free, llvm::LibFunc::getenv, ParseCommandLineOptions(), ParseCStringVector(), and llvm::LibFunc::strdup.

void llvm::cl::PrintHelpMessage	(	bool	Hidden = `false`,
		bool	Categorized = `false`
	)

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.

NOTE: THIS FUNCTION TERMINATES THE PROGRAM!

Parameters:

Hidden	if true will print hidden options
Categorized	if true print options in categories

Definition at line 1562 of file CommandLine.cpp.

References CategorizedHiddenPrinter(), CategorizedNormalPrinter(), UncategorizedHiddenPrinter(), and UncategorizedNormalPrinter().

template<class ParserClass , class DT >

void llvm::cl::printOptionDiff	(	const Option &	O,
		const generic_parser_base &	P,
		const DT &	V,
		const OptionValue< DT > &	Default,
		size_t	GlobalWidth
	)

Definition at line 954 of file CommandLine.h.

References llvm::cl::generic_parser_base::printOptionDiff().

template<class ParserClass , class ValDT >

void llvm::cl::printOptionDiff	(	const Option &	O,
		const basic_parser< typename ParserClass::parser_data_type > &	P,
		const ValDT &	V,
		const OptionValue< ValDT > &	Default,
		size_t	GlobalWidth
	)

Definition at line 983 of file CommandLine.h.

References llvm::cl::OptionDiffPrinter< ParserDT, ValDT >::print().

void llvm::cl::PrintOptionValues ( )

Definition at line 1476 of file CommandLine.cpp.

References GetOptionInfo(), PrintAllOptions, PrintOptions, llvm::SmallVectorTemplateCommon< T >::size(), and sortOpts().

void llvm::cl::PrintVersionMessage ( )

Utility function for printing version number.

Definition at line 1581 of file CommandLine.cpp.

References VersionPrinterInstance.

void llvm::cl::SetVersionPrinter ( void(*)() func )

===---------------------------------------------------------------------===// 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 1585 of file CommandLine.cpp.

References OverrideVersionPrinter.

llvm::cl::TEMPLATE_INSTANTIATION ( class basic_parser< bool > )

llvm::cl::TEMPLATE_INSTANTIATION ( class basic_parser< boolOrDefault > )

llvm::cl::TEMPLATE_INSTANTIATION ( class basic_parser< int > )

llvm::cl::TEMPLATE_INSTANTIATION ( class basic_parser< unsigned > )

llvm::cl::TEMPLATE_INSTANTIATION ( class basic_parser< unsigned long long > )

llvm::cl::TEMPLATE_INSTANTIATION ( class basic_parser< double > )

llvm::cl::TEMPLATE_INSTANTIATION ( class basic_parser< float > )

llvm::cl::TEMPLATE_INSTANTIATION ( class basic_parser< std::string > )

llvm::cl::TEMPLATE_INSTANTIATION ( class basic_parser< char > )

llvm::cl::TEMPLATE_INSTANTIATION ( class opt< unsigned > )

llvm::cl::TEMPLATE_INSTANTIATION ( class opt< int > )

llvm::cl::TEMPLATE_INSTANTIATION ( class opt< std::string > )

llvm::cl::TEMPLATE_INSTANTIATION ( class opt< char > )

llvm::cl::TEMPLATE_INSTANTIATION ( class opt< bool > )

template<class DataType >

ValuesClass<DataType> END_WITH_NULL llvm::cl::values	(	const char *	Arg,
		DataType	Val,
		const char *	Desc,
			...
	)

Definition at line 507 of file CommandLine.h.

Variable Documentation

OptionCategory llvm::cl::GeneralCategory

Classes

Enumerations

Functions

Variables

Detailed Description

Enumeration Type Documentation

Function Documentation

Variable Documentation