LLVM API Documentation

Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages

llvm::cl Namespace Reference


Classes

class  Option
struct  desc
struct  value_desc
struct  initializer
struct  LocationClass
class  ValuesClass
struct  generic_parser_base
class  parser
struct  basic_parser_impl
struct  basic_parser
class  parser< bool >
class  parser< int >
class  parser< unsigned >
class  parser< double >
class  parser< float >
struct  applicator
struct  applicator< char[n]>
struct  applicator< const char[n]>
struct  applicator< const char * >
struct  applicator< NumOccurrences >
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
class  alias
struct  aliasopt
struct  extrahelp
class  parser< std::string >

Enumerations

enum  NumOccurrences {
  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, MiscMask = 0x600 }

Functions

void ParseCommandLineOptions (int &argc, char **argv, const char *Overview=0)
void ParseEnvironmentOptions (const char *progName, const char *envvar, const char *Overview=0)
template<class Ty>
initializer< Ty > init (const Ty &Val)
template<class Ty>
LocationClass< Ty > location (Ty &L)
template<class DataType>
ValuesClass< DataType > values (const char *Arg, DataType Val, const char *Desc,...)
template<class Mod, class Opt>
void apply (const Mod &M, Opt *O)
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::FormattingFlags
 

Enumerator:
NormalFormatting 
Positional 
Prefix 
Grouping 
FormattingMask 

Definition at line 101 of file CommandLine.h.

enum llvm::cl::MiscFlags
 

Enumerator:
CommaSeparated 
PositionalEatsArgs 
MiscMask 

Definition at line 109 of file CommandLine.h.

enum llvm::cl::NumOccurrences
 

Enumerator:
Optional 
ZeroOrMore 
Required 
OneOrMore 
ConsumeAfter 
OccurrencesMask 

Definition at line 54 of file CommandLine.h.

enum llvm::cl::OptionHidden
 

Enumerator:
NotHidden 
Hidden 
ReallyHidden 
HiddenMask 

Definition at line 79 of file CommandLine.h.

enum llvm::cl::ValueExpected
 

Enumerator:
ValueOptional 
ValueRequired 
ValueDisallowed 
ValueMask 

Definition at line 72 of file CommandLine.h.


Function Documentation

template<class Mod, class Opt>
void llvm::cl::apply const Mod &  M,
Opt *  O
 

Definition at line 646 of file CommandLine.h.

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

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

Definition at line 272 of file CommandLine.h.

Referenced by llvm::AllocationInst::AllocationInst(), llvm::CallInst::CallInst(), llvm::FreeInst::FreeInst(), llvm::GetElementPtrInst::GetElementPtrInst(), llvm::Instruction::Instruction(), llvm::InvokeInst::InvokeInst(), llvm::LoadInst::LoadInst(), and llvm::StoreInst::StoreInst().

template<class Ty>
LocationClass<Ty> llvm::cl::location Ty &  L  ) 
 

Definition at line 291 of file CommandLine.h.

void llvm::cl::ParseCommandLineOptions int &  argc,
char **  argv,
const char *  Overview = 0
 

Definition at line 286 of file CommandLine.cpp.

References CommaSeparated, ConsumeAfter, E, EatsUnboundedNumberOfValues(), first, getOptionPred(), getOpts(), getPositionalOpts(), I, isGrouping(), isPrefixedOrGrouping(), LookupOption(), MoreHelp(), OneOrMore, Optional, Positional, PositionalEatsArgs, Prefix, ProgramName, ProgramOverview, ProvideOption(), ProvidePositionalOption(), Required, RequiresValue(), second, ValueRequired, and ZeroOrMore.

Referenced by cl::ParseEnvironmentOptions().

void llvm::cl::ParseEnvironmentOptions const char *  progName,
const char *  envVar,
const char *  Overview
 

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 234 of file CommandLine.cpp.

References cl::ParseCommandLineOptions(), ParseCStringVector(), and strdup.

void llvm::cl::PrintHelpMessage  ) 
 

Definition at line 962 of file CommandLine.cpp.

References NormalPrinter().

template<class DataType>
ValuesClass<DataType> llvm::cl::values const char *  Arg,
DataType  Val,
const char *  Desc,
  ...
 

Definition at line 337 of file CommandLine.h.