llvm::cl Namespace Reference

cl Namespace - This namespace contains all of the command line option processing machinery. More...

Classes

class  Option
struct  desc
struct  value_desc
struct  initializer
struct  LocationClass
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 = 0x01, ZeroOrMore = 0x02, Required = 0x03, OneOrMore = 0x04,
  ConsumeAfter = 0x05, OccurrencesMask = 0x07
}
enum  ValueExpected { ValueOptional = 0x08, ValueRequired = 0x10, ValueDisallowed = 0x18, ValueMask = 0x18 }
enum  OptionHidden { NotHidden = 0x20, Hidden = 0x40, ReallyHidden = 0x60, HiddenMask = 0x60 }
enum  FormattingFlags {
  NormalFormatting = 0x000, Positional = 0x080, Prefix = 0x100, Grouping = 0x180,
  FormattingMask = 0x180
}
enum  MiscFlags { CommaSeparated = 0x200, PositionalEatsArgs = 0x400, Sink = 0x800, MiscMask = 0xE00 }
enum  boolOrDefault { BOU_UNSET, BOU_TRUE, BOU_FALSE }

Functions

 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 >)
void ParseCommandLineOptions (int argc, char **argv, const char *Overview=0)
void 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).
void 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.
void AddExtraVersionPrinter (void(*func)())
 ===---------------------------------------------------------------------===// AddExtraVersionPrinter - Add an extra printer to use in addition to the default one.
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 ()

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 
enum llvm::cl::FormattingFlags
Enumerator:
NormalFormatting 
Positional 
Prefix 
Grouping 
FormattingMask 
enum llvm::cl::MiscFlags
Enumerator:
CommaSeparated 
PositionalEatsArgs 
Sink 
MiscMask 
enum llvm::cl::NumOccurrencesFlag
Enumerator:
Optional 
ZeroOrMore 
Required 
OneOrMore 
ConsumeAfter 
OccurrencesMask 
enum llvm::cl::OptionHidden
Enumerator:
NotHidden 
Hidden 
ReallyHidden 
HiddenMask 
enum llvm::cl::ValueExpected
Enumerator:
ValueOptional 
ValueRequired 
ValueDisallowed 
ValueMask 

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.

template<class Mod , class Opt >
void llvm::cl::apply ( const Mod &  M,
Opt *  O 
) [inline]
llvm::cl::EXTERN_TEMPLATE_INSTANTIATION ( class opt< bool >   ) 
llvm::cl::EXTERN_TEMPLATE_INSTANTIATION ( class opt< char >   ) 
llvm::cl::EXTERN_TEMPLATE_INSTANTIATION ( class opt< std::string >   ) 
llvm::cl::EXTERN_TEMPLATE_INSTANTIATION ( class opt< int >   ) 
llvm::cl::EXTERN_TEMPLATE_INSTANTIATION ( class opt< unsigned >   ) 
llvm::cl::EXTERN_TEMPLATE_INSTANTIATION ( class basic_parser< char >   ) 
llvm::cl::EXTERN_TEMPLATE_INSTANTIATION ( class basic_parser< std::string >   ) 
llvm::cl::EXTERN_TEMPLATE_INSTANTIATION ( class basic_parser< float >   ) 
llvm::cl::EXTERN_TEMPLATE_INSTANTIATION ( class basic_parser< double >   ) 
llvm::cl::EXTERN_TEMPLATE_INSTANTIATION ( class basic_parser< unsigned long long >   ) 
llvm::cl::EXTERN_TEMPLATE_INSTANTIATION ( class basic_parser< unsigned >   ) 
llvm::cl::EXTERN_TEMPLATE_INSTANTIATION ( class basic_parser< int >   ) 
llvm::cl::EXTERN_TEMPLATE_INSTANTIATION ( class basic_parser< boolOrDefault >   ) 
llvm::cl::EXTERN_TEMPLATE_INSTANTIATION ( class basic_parser< bool >   ) 
template<class Ty >
initializer<Ty> llvm::cl::init ( const Ty &  Val  )  [inline]
template<class Ty >
LocationClass<Ty> llvm::cl::location ( Ty &  L  )  [inline]
void llvm::cl::MarkOptionsChanged (  ) 
void llvm::cl::ParseCommandLineOptions ( int  argc,
char **  argv,
const char *  Overview = 0 
)
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).

void llvm::cl::PrintHelpMessage (  ) 
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 
) [inline]
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 
) [inline]
void llvm::cl::PrintOptionValues (  ) 
void llvm::cl::PrintVersionMessage (  ) 

Utility function for printing version number.

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.

llvm::cl::TEMPLATE_INSTANTIATION ( class opt< bool >   ) 
llvm::cl::TEMPLATE_INSTANTIATION ( class opt< char >   ) 
llvm::cl::TEMPLATE_INSTANTIATION ( class opt< std::string >   ) 
llvm::cl::TEMPLATE_INSTANTIATION ( class opt< int >   ) 
llvm::cl::TEMPLATE_INSTANTIATION ( class opt< unsigned >   ) 
llvm::cl::TEMPLATE_INSTANTIATION ( class basic_parser< char >   ) 
llvm::cl::TEMPLATE_INSTANTIATION ( class basic_parser< std::string >   ) 
llvm::cl::TEMPLATE_INSTANTIATION ( class basic_parser< float >   ) 
llvm::cl::TEMPLATE_INSTANTIATION ( class basic_parser< double >   ) 
llvm::cl::TEMPLATE_INSTANTIATION ( class basic_parser< unsigned long long >   ) 
llvm::cl::TEMPLATE_INSTANTIATION ( class basic_parser< unsigned >   ) 
llvm::cl::TEMPLATE_INSTANTIATION ( class basic_parser< int >   ) 
llvm::cl::TEMPLATE_INSTANTIATION ( class basic_parser< boolOrDefault >   ) 
llvm::cl::TEMPLATE_INSTANTIATION ( class basic_parser< bool >   ) 
template<class DataType >
ValuesClass<DataType> END_WITH_NULL llvm::cl::values ( const char *  Arg,
DataType  Val,
const char *  Desc,
  ... 
) [inline]
Generated on 2 Nov 2013 for Galois by  doxygen 1.6.1