#include <command_line_flags.h>
Class CLFlag (for Command Line Flag)
Author: Sergey Berezin
Date: Fri May 30 14:10:48 2003
This class implements a data structure to hold a value of a single command line flag.
Definition at line 51 of file command_line_flags.h.
CVC3::CLFlag::CLFlag | ( | bool | b, | |
const std::string & | help, | |||
bool | display = true | |||
) | [inline] |
Constructor for a boolean flag.
Definition at line 70 of file command_line_flags.h.
CVC3::CLFlag::CLFlag | ( | int | i, | |
const std::string & | help, | |||
bool | display = true | |||
) | [inline] |
Constructor for an integer flag.
Definition at line 74 of file command_line_flags.h.
References d_data.
CVC3::CLFlag::CLFlag | ( | const std::string & | s, | |
const std::string & | help, | |||
bool | display = true | |||
) | [inline] |
Constructor for a string flag.
Definition at line 78 of file command_line_flags.h.
References d_data.
CVC3::CLFlag::CLFlag | ( | const char * | s, | |
const std::string & | help, | |||
bool | display = true | |||
) | [inline] |
Constructor for a string flag from char*.
Definition at line 83 of file command_line_flags.h.
CVC3::CLFlag::CLFlag | ( | const std::vector< std::pair< std::string, bool > > & | sv, | |
const std::string & | help, | |||
bool | display = true | |||
) | [inline] |
Constructor for a vector flag.
Definition at line 88 of file command_line_flags.h.
CVC3::CLFlag::CLFlag | ( | ) | [inline] |
Default constructor.
Definition at line 94 of file command_line_flags.h.
CVC3::CLFlag::CLFlag | ( | const CLFlag & | f | ) | [inline] |
Copy constructor.
Definition at line 96 of file command_line_flags.h.
CVC3::CLFlag::~CLFlag | ( | ) | [inline] |
Destructor.
Definition at line 107 of file command_line_flags.h.
Assignment from another flag.
Definition at line 115 of file command_line_flags.h.
CLFlag& CVC3::CLFlag::operator= | ( | bool | b | ) | [inline] |
Assignment of a boolean value.
The flag must already have the right type
Definition at line 146 of file command_line_flags.h.
References CVC3::CLFLAG_BOOL, d_data, d_modified, d_tp, and DebugAssert.
CLFlag& CVC3::CLFlag::operator= | ( | int | i | ) | [inline] |
Assignment of an integer value.
The flag must already have the right type
Definition at line 154 of file command_line_flags.h.
References CVC3::CLFLAG_INT, d_data, d_modified, d_tp, and DebugAssert.
CLFlag& CVC3::CLFlag::operator= | ( | const std::string & | s | ) | [inline] |
Assignment of a string value.
The flag must already have a string type.
Definition at line 162 of file command_line_flags.h.
References CVC3::CLFLAG_STRING, d_data, d_modified, d_tp, and DebugAssert.
CLFlag& CVC3::CLFlag::operator= | ( | const char * | s | ) | [inline] |
Assignment of an string value from char*.
The flag must already have a string type.
Definition at line 170 of file command_line_flags.h.
References CVC3::CLFLAG_STRING, d_data, d_modified, d_tp, and DebugAssert.
CLFlag& CVC3::CLFlag::operator= | ( | const std::pair< std::string, bool > & | p | ) | [inline] |
Assignment of a string value with a boolean tag to a vector flag.
The flag must already have a vector type. The pair of <string,bool> will be appended to the vector.
Definition at line 179 of file command_line_flags.h.
References CVC3::CLFLAG_STRVEC, d_data, d_modified, d_tp, and DebugAssert.
CLFlag& CVC3::CLFlag::operator= | ( | const std::vector< std::pair< std::string, bool > > & | sv | ) | [inline] |
Assignment of a vector value.
The flag must already have a vector type.
Definition at line 187 of file command_line_flags.h.
References CVC3::CLFLAG_STRVEC, d_data, d_modified, d_tp, DebugAssert, and sv.
CLFlagType CVC3::CLFlag::getType | ( | ) | const [inline] |
Return the type of the flag.
Definition at line 195 of file command_line_flags.h.
References d_tp.
Referenced by CVC3::VCCmd::evaluateCommand(), printUsage(), and CVC3::CLFlags::setFlag().
bool CVC3::CLFlag::modified | ( | ) | const [inline] |
Return true if the flag was modified from the default value (e.g. set on the command line).
Definition at line 198 of file command_line_flags.h.
Referenced by CVC3::VCCmd::evaluateCommand().
bool CVC3::CLFlag::display | ( | ) | const [inline] |
Return true if flag should be displayed in regular help.
Definition at line 200 of file command_line_flags.h.
References d_modified.
Referenced by printUsage().
const bool& CVC3::CLFlag::getBool | ( | ) | const [inline] |
Definition at line 207 of file command_line_flags.h.
References CVC3::CLFLAG_BOOL, d_data, d_tp, and DebugAssert.
Referenced by printUsage().
const int& CVC3::CLFlag::getInt | ( | ) | const [inline] |
Definition at line 212 of file command_line_flags.h.
Referenced by printUsage().
const std::string& CVC3::CLFlag::getString | ( | ) | const [inline] |
Definition at line 217 of file command_line_flags.h.
Referenced by printUsage().
const std::vector<std::pair<std::string,bool> >& CVC3::CLFlag::getStrVec | ( | ) | const [inline] |
Definition at line 223 of file command_line_flags.h.
const std::string& CVC3::CLFlag::getHelp | ( | ) | const [inline] |
Definition at line 229 of file command_line_flags.h.
Referenced by printUsage().
CLFlagType CVC3::CLFlag::d_tp [private] |
Type of the argument.
Definition at line 54 of file command_line_flags.h.
Referenced by getBool(), getType(), and operator=().
bool CVC3::CLFlag::b |
Definition at line 57 of file command_line_flags.h.
int CVC3::CLFlag::i |
Definition at line 58 of file command_line_flags.h.
std::string* CVC3::CLFlag::s |
Definition at line 59 of file command_line_flags.h.
std::vector<std::pair<std::string,bool> >* CVC3::CLFlag::sv |
Definition at line 60 of file command_line_flags.h.
Referenced by operator=().
union { ... } CVC3::CLFlag::d_data [private] |
The argument.
Referenced by CLFlag(), getBool(), and operator=().
bool CVC3::CLFlag::d_modified [private] |
This tag is set to true when the flag is assigned a new value.
Definition at line 63 of file command_line_flags.h.
Referenced by display(), and operator=().
std::string CVC3::CLFlag::d_help [private] |
Help string.
Definition at line 65 of file command_line_flags.h.
bool CVC3::CLFlag::d_display [private] |
Whether to display this flag when user invokes cvc3 -h.
Definition at line 67 of file command_line_flags.h.