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  llvm::cl::Option
struct  llvm::cl::desc
struct  llvm::cl::value_desc
struct  llvm::cl::initializer< Ty >
struct  llvm::cl::LocationClass< Ty >
class  llvm::cl::ValuesClass< DataType >
struct  llvm::cl::generic_parser_base
class  llvm::cl::parser< DataType >
struct  llvm::cl::basic_parser_impl
struct  llvm::cl::basic_parser< DataType >
class  llvm::cl::parser< bool >
class  llvm::cl::parser< boolOrDefault >
class  llvm::cl::parser< int >
class  llvm::cl::parser< unsigned >
class  llvm::cl::parser< double >
class  llvm::cl::parser< float >
class  llvm::cl::parser< std::string >
struct  llvm::cl::applicator< Mod >
struct  llvm::cl::applicator< char[n]>
struct  llvm::cl::applicator< const char[n]>
struct  llvm::cl::applicator< const char * >
struct  llvm::cl::applicator< NumOccurrences >
struct  llvm::cl::applicator< ValueExpected >
struct  llvm::cl::applicator< OptionHidden >
struct  llvm::cl::applicator< FormattingFlags >
struct  llvm::cl::applicator< MiscFlags >
class  llvm::cl::opt_storage< DataType, ExternalStorage, isClass >
class  llvm::cl::opt_storage< DataType, false, true >
class  llvm::cl::opt_storage< DataType, false, false >
class  llvm::cl::opt< DataType, ExternalStorage, ParserClass >
class  llvm::cl::list_storage< DataType, StorageClass >
class  llvm::cl::list_storage< DataType, bool >
class  llvm::cl::list< DataType, Storage, ParserClass >
class  llvm::cl::bits_storage< DataType, StorageClass >
class  llvm::cl::bits_storage< DataType, bool >
class  llvm::cl::bits< DataType, Storage, ParserClass >
class  llvm::cl::alias
struct  llvm::cl::aliasopt
struct  llvm::cl::extrahelp

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, Sink = 0x800, MiscMask = 0xE00 }
enum  boolOrDefault { BOU_UNSET, BOU_TRUE, BOU_FALSE }

Functions

void ParseCommandLineOptions (int argc, char **argv, const char *Overview=0, bool ReadResponseFiles=false)
void ParseEnvironmentOptions (const char *progName, const char *envvar, const char *Overview=0, bool ReadResponseFiles=false)
void SetVersionPrinter (void(*func)())
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< double >)
 EXTERN_TEMPLATE_INSTANTIATION (class basic_parser< float >)
 EXTERN_TEMPLATE_INSTANTIATION (class basic_parser< std::string >)
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< bool >)
void PrintVersionMessage ()
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 boolOrDefault
 

Enumeration values:
BOU_UNSET 
BOU_TRUE 
BOU_FALSE 

Definition at line 553 of file CommandLine.h.

enum FormattingFlags
 

Enumeration values:
NormalFormatting 
Positional 
Prefix 
Grouping 
FormattingMask 

Definition at line 117 of file CommandLine.h.

Referenced by llvm::cl::Option::getFormattingFlag().

enum MiscFlags
 

Enumeration values:
CommaSeparated 
PositionalEatsArgs 
Sink 
MiscMask 

Definition at line 125 of file CommandLine.h.

enum NumOccurrences
 

Enumeration values:
Optional 
ZeroOrMore 
Required 
OneOrMore 
ConsumeAfter 
OccurrencesMask 

Definition at line 70 of file CommandLine.h.

Referenced by llvm::cl::Option::getNumOccurrencesFlag(), and llvm::cl::Option::Option().

enum OptionHidden
 

Enumeration values:
NotHidden 
Hidden 
ReallyHidden 
HiddenMask 

Definition at line 95 of file CommandLine.h.

Referenced by llvm::cl::Option::getOptionHiddenFlag().

enum ValueExpected
 

Enumeration values:
ValueOptional 
ValueRequired 
ValueDisallowed 
ValueMask 

Definition at line 88 of file CommandLine.h.

Referenced by llvm::cl::Option::getValueExpectedFlag(), llvm::cl::parser< boolOrDefault >::getValueExpectedFlagDefault(), llvm::cl::parser< bool >::getValueExpectedFlagDefault(), llvm::cl::basic_parser_impl::getValueExpectedFlagDefault(), and llvm::cl::generic_parser_base::getValueExpectedFlagDefault().

Function Documentation

template<class Mod, class Opt>
void apply (  const Mod &  M,
Opt *  O
) 
 

Definition at line 712 of file CommandLine.h.

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().

EXTERN_TEMPLATE_INSTANTIATION (  class opt< bool >   ) 
 

EXTERN_TEMPLATE_INSTANTIATION (  class opt< std::string >   ) 
 

EXTERN_TEMPLATE_INSTANTIATION (  class opt< int >   ) 
 

EXTERN_TEMPLATE_INSTANTIATION (  class opt< unsigned >   ) 
 

EXTERN_TEMPLATE_INSTANTIATION (  class basic_parser< std::string >   ) 
 

EXTERN_TEMPLATE_INSTANTIATION (  class basic_parser< float >   ) 
 

EXTERN_TEMPLATE_INSTANTIATION (  class basic_parser< double >   ) 
 

EXTERN_TEMPLATE_INSTANTIATION (  class basic_parser< unsigned >   ) 
 

EXTERN_TEMPLATE_INSTANTIATION (  class basic_parser< int >   ) 
 

EXTERN_TEMPLATE_INSTANTIATION (  class basic_parser< boolOrDefault >   ) 
 

EXTERN_TEMPLATE_INSTANTIATION (  class basic_parser< bool >   ) 
 

template<class Ty>
initializer<Ty> init (  const Ty &  Val  ) 
 

Definition at line 279 of file CommandLine.h.

Referenced by llvm::BitstreamReader::BitstreamReader(), llvm::DenseMap< Value *, SmallPtrSet< Instruction *, 4 > >::DenseMap(), llvm::Registry< T, U >::Parser::initialize(), llvm::StringMapImpl::LookupBucketFor(), MemoryBufferMem::MemoryBufferMem(), MemoryBufferMMapFile::MemoryBufferMMapFile(), llvm::Statistic::operator *=(), llvm::Statistic::operator++(), llvm::Statistic::operator+=(), llvm::Statistic::operator--(), llvm::Statistic::operator-=(), llvm::Statistic::operator/=(), llvm::Statistic::operator=(), llvm::StringMapImpl::StringMapImpl(), and llvm::TargetData::TargetData().

template<class Ty>
LocationClass<Ty> location (  Ty &  L  ) 
 

Definition at line 298 of file CommandLine.h.

void MarkOptionsChanged (   ) 
 

Referenced by llvm::cl::parser< const PassInfo * >::addLiteralOption().

void ParseCommandLineOptions (  int  argc,
char **  argv,
const char *  Overview = 0,
bool  ReadResponseFiles = false
) 
 

void ParseEnvironmentOptions (  const char *  progName,
const char *  envvar,
const char *  Overview = 0,
bool  ReadResponseFiles = false
) 
 

void PrintHelpMessage (   ) 
 

void PrintVersionMessage (   ) 
 

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. This allows other systems using the CommandLine utilities to print their own version string.

template<class DataType>
ValuesClass<DataType> END_WITH_NULL values (  const char *  Arg,
DataType  Val,
const char *  Desc,
  ...
) 
 

Definition at line 345 of file CommandLine.h.

References END_WITH_NULL.

Generated on Thu Aug 21 02:59:14 2008 for LLVM by Doxygen1.3.9.1
Copyright © 2003-2007 University of Illinois at Urbana-Champaign. All Rights Reserved.

This web site is hosted by the Computer Science Department at the University of Illinois at Urbana-Champaign.