cuberite/TCLAP
1
0
Fork 0
mirror of https://github.com/cuberite/TCLAP.git synced 2025-09-17 16:15:07 -04:00
Code Issues Packages Projects Releases Wiki Activity

Changed allowedList to Constraint

Browse Source
This commit is contained in:
mes5k 2005-01-07 02:55:52 +00:00
parent 756eb9e6ed
commit 6471476a4d
4 changed files with 72 additions and 184 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

113
include/tclap/MultiArg.h
View File

@ -27,6 +27,7 @@
#include <vector> #include <vector>
#include <tclap/Arg.h> #include <tclap/Arg.h>
#include <tclap/Constraint.h>
#ifdef HAVE_CONFIG_H #ifdef HAVE_CONFIG_H
#include <config.h> #include <config.h>
@ -172,19 +173,16 @@ class MultiArg : public Arg
*/ */
std::vector<T> _values; std::vector<T> _values;
/**
* A list of allowed values.
* A list of values allowed for this argument. If the value parsed
* for this arg is not found in this list, then an exception is
* thrown. If the list is empty, then any value is allowed.
*/
std::vector<T> _allowed;
/** /**
* The description of type T to be used in the usage. * The description of type T to be used in the usage.
*/ */
std::string _typeDesc; std::string _typeDesc;
/**
* A list of constraint on this Arg.
*/
Constraint<T>* _constraint;
/** /**
* Extracts the value from the string. * Extracts the value from the string.
* Attempts to parse string as type T, if this fails an exception * Attempts to parse string as type T, if this fails an exception
@ -193,12 +191,6 @@ class MultiArg : public Arg
*/ */
void _extractValue( const std::string& val ); void _extractValue( const std::string& val );
/**
* Checks to see if parsed value is in allowed list.
* \param val - value parsed (only used in output).
*/
void _checkAllowed( const std::string& val );
public: public:
/** /**
@ -261,8 +253,8 @@ class MultiArg : public Arg
* does. * does.
* \param req - Whether the argument is required on the command * \param req - Whether the argument is required on the command
* line. * line.
* \param allowed - A vector of type T that where the values in the * \param constraint - A pointer to a Constraint object used
* vector are the only values allowed for the arg. * to constrain this Arg.
* \param v - An optional visitor. You probably should not * \param v - An optional visitor. You probably should not
* use this unless you have a very good reason. * use this unless you have a very good reason.
*/ */
@ -270,7 +262,7 @@ class MultiArg : public Arg
const std::string& name, const std::string& name,
const std::string& desc, const std::string& desc,
bool req, bool req,
const std::vector<T>& allowed, Constraint<T>* constraint,
Visitor* v = NULL ); Visitor* v = NULL );
/** /**
@ -283,8 +275,8 @@ class MultiArg : public Arg
* does. * does.
* \param req - Whether the argument is required on the command * \param req - Whether the argument is required on the command
* line. * line.
* \param allowed - A vector of type T that where the values in the * \param constraint - A pointer to a Constraint object used
* vector are the only values allowed for the arg. * to constrain this Arg.
* \param parser - A CmdLine parser object to add this Arg to * \param parser - A CmdLine parser object to add this Arg to
* \param v - An optional visitor. You probably should not * \param v - An optional visitor. You probably should not
* use this unless you have a very good reason. * use this unless you have a very good reason.
@ -293,7 +285,7 @@ class MultiArg : public Arg
const std::string& name, const std::string& name,
const std::string& desc, const std::string& desc,
bool req, bool req,
const std::vector<T>& allowed, Constraint<T>* constraint,
CmdLineInterface& parser, CmdLineInterface& parser,
Visitor* v = NULL ); Visitor* v = NULL );
@ -331,45 +323,8 @@ class MultiArg : public Arg
*/ */
virtual bool isRequired() const; virtual bool isRequired() const;
private:
/**
* Common initialization code for constructors with allowed vectors.
*/
void allowedInit();
}; };
/**
*
*/
template<class T>
void MultiArg<T>::allowedInit()
{
for ( unsigned int i = 0; i < _allowed.size(); i++ )
{
#if defined(HAVE_SSTREAM)
std::ostringstream os;
#elif defined(HAVE_STRSTREAM)
std::ostrstream os;
#else
#error "Need a stringstream (sstream or strstream) to compile!"
#endif
os << _allowed[i];
std::string temp( os.str() );
if ( i > 0 )
_typeDesc += "|";
_typeDesc += temp;
}
}
/**
*
*/
template<class T> template<class T>
MultiArg<T>::MultiArg(const std::string& flag, MultiArg<T>::MultiArg(const std::string& flag,
const std::string& name, const std::string& name,
@ -378,7 +333,8 @@ MultiArg<T>::MultiArg(const std::string& flag,
const std::string& typeDesc, const std::string& typeDesc,
Visitor* v) Visitor* v)
: Arg( flag, name, desc, req, true, v ), : Arg( flag, name, desc, req, true, v ),
_typeDesc( typeDesc ) _typeDesc( typeDesc ),
_constraint( NULL )
{ } { }
template<class T> template<class T>
@ -390,7 +346,8 @@ MultiArg<T>::MultiArg(const std::string& flag,
CmdLineInterface& parser, CmdLineInterface& parser,
Visitor* v) Visitor* v)
: Arg( flag, name, desc, req, true, v ), : Arg( flag, name, desc, req, true, v ),
_typeDesc( typeDesc ) _typeDesc( typeDesc ),
_constraint( NULL )
{ {
parser.add( this ); parser.add( this );
} }
@ -403,38 +360,29 @@ MultiArg<T>::MultiArg(const std::string& flag,
const std::string& name, const std::string& name,
const std::string& desc, const std::string& desc,
bool req, bool req,
const std::vector<T>& allowed, Constraint<T>* constraint,
Visitor* v) Visitor* v)
: Arg( flag, name, desc, req, true, v ), : Arg( flag, name, desc, req, true, v ),
_allowed( allowed ) _constraint( constraint )
{ { }
allowedInit();
}
template<class T> template<class T>
MultiArg<T>::MultiArg(const std::string& flag, MultiArg<T>::MultiArg(const std::string& flag,
const std::string& name, const std::string& name,
const std::string& desc, const std::string& desc,
bool req, bool req,
const std::vector<T>& allowed, Constraint<T>* constraint,
CmdLineInterface& parser, CmdLineInterface& parser,
Visitor* v) Visitor* v)
: Arg( flag, name, desc, req, true, v ), : Arg( flag, name, desc, req, true, v ),
_allowed( allowed ) _constraint( constraint )
{ {
allowedInit();
parser.add( this ); parser.add( this );
} }
/**
*
*/
template<class T> template<class T>
const std::vector<T>& MultiArg<T>::getValue() { return _values; } const std::vector<T>& MultiArg<T>::getValue() { return _values; }
/**
*
*/
template<class T> template<class T>
bool MultiArg<T>::processArg(int *i, std::vector<std::string>& args) bool MultiArg<T>::processArg(int *i, std::vector<std::string>& args)
{ {
@ -476,19 +424,6 @@ bool MultiArg<T>::processArg(int *i, std::vector<std::string>& args)
return false; return false;
} }
/**
* Checks to see if the value parsed is in the allowed list.
*/
template<class T>
void MultiArg<T>::_checkAllowed( const std::string& val )
{
if ( _allowed.size() > 0 )
if ( find(_allowed.begin(),_allowed.end(),_values.back())
== _allowed.end() )
throw( CmdLineParseException( "Couldn't find '" + val +
"' in allowed list.", toString() ) );
}
/** /**
* *
*/ */
@ -545,7 +480,11 @@ void MultiArg<T>::_extractValue( const std::string& val )
throw( ArgParseException("More than one valid value " throw( ArgParseException("More than one valid value "
"parsed from string '" + val + "'", "parsed from string '" + val + "'",
toString() ) ); toString() ) );
_checkAllowed( val ); if ( _constraint != NULL )
if ( ! _constraint->check( _values.back() ) )
throw( CmdLineParseException( "Value '" + val +
"' does not meet constraint: " +
_constraint->description() ) );
} }

20
include/tclap/UnlabeledMultiArg.h
View File

@ -99,8 +99,8 @@ class UnlabeledMultiArg : public MultiArg<T>
* identification, not as a long flag. * identification, not as a long flag.
* \param desc - A description of what the argument is for or * \param desc - A description of what the argument is for or
* does. * does.
* \param allowed - A vector of type T that where the values in the * \param constraint - A pointer to a Constraint object used
* vector are the only values allowed for the arg. * to constrain this Arg.
* \param ignoreable - Whether or not this argument can be ignored * \param ignoreable - Whether or not this argument can be ignored
* using the "--" flag. * using the "--" flag.
* \param v - An optional visitor. You probably should not * \param v - An optional visitor. You probably should not
@ -108,7 +108,7 @@ class UnlabeledMultiArg : public MultiArg<T>
*/ */
UnlabeledMultiArg( const std::string& name, UnlabeledMultiArg( const std::string& name,
const std::string& desc, const std::string& desc,
const std::vector<T>& allowed, Constraint<T>* constraint,
bool ignoreable = false, bool ignoreable = false,
Visitor* v = NULL ); Visitor* v = NULL );
@ -118,8 +118,8 @@ class UnlabeledMultiArg : public MultiArg<T>
* identification, not as a long flag. * identification, not as a long flag.
* \param desc - A description of what the argument is for or * \param desc - A description of what the argument is for or
* does. * does.
* \param allowed - A vector of type T that where the values in the * \param constraint - A pointer to a Constraint object used
* vector are the only values allowed for the arg. * to constrain this Arg.
* \param parser - A CmdLine parser object to add this Arg to * \param parser - A CmdLine parser object to add this Arg to
* \param ignoreable - Whether or not this argument can be ignored * \param ignoreable - Whether or not this argument can be ignored
* using the "--" flag. * using the "--" flag.
@ -128,7 +128,7 @@ class UnlabeledMultiArg : public MultiArg<T>
*/ */
UnlabeledMultiArg( const std::string& name, UnlabeledMultiArg( const std::string& name,
const std::string& desc, const std::string& desc,
const std::vector<T>& allowed, Constraint<T>* constraint,
CmdLineInterface& parser, CmdLineInterface& parser,
bool ignoreable = false, bool ignoreable = false,
Visitor* v = NULL ); Visitor* v = NULL );
@ -196,10 +196,10 @@ UnlabeledMultiArg<T>::UnlabeledMultiArg(const std::string& name,
template<class T> template<class T>
UnlabeledMultiArg<T>::UnlabeledMultiArg(const std::string& name, UnlabeledMultiArg<T>::UnlabeledMultiArg(const std::string& name,
const std::string& desc, const std::string& desc,
const std::vector<T>& allowed, Constraint<T>* constraint,
bool ignoreable, bool ignoreable,
Visitor* v) Visitor* v)
: MultiArg<T>("", name, desc, false, allowed, v) : MultiArg<T>("", name, desc, false, constraint, v)
{ {
_ignoreable = ignoreable; _ignoreable = ignoreable;
} }
@ -207,11 +207,11 @@ UnlabeledMultiArg<T>::UnlabeledMultiArg(const std::string& name,
template<class T> template<class T>
UnlabeledMultiArg<T>::UnlabeledMultiArg(const std::string& name, UnlabeledMultiArg<T>::UnlabeledMultiArg(const std::string& name,
const std::string& desc, const std::string& desc,
const std::vector<T>& allowed, Constraint<T>* constraint,
CmdLineInterface& parser, CmdLineInterface& parser,
bool ignoreable, bool ignoreable,
Visitor* v) Visitor* v)
: MultiArg<T>("", name, desc, false, allowed, v) : MultiArg<T>("", name, desc, false, constraint, v)
{ {
_ignoreable = ignoreable; _ignoreable = ignoreable;
parser.add( this ); parser.add( this );

20
include/tclap/UnlabeledValueArg.h
View File

@ -127,8 +127,8 @@ class UnlabeledValueArg : public ValueArg<T>
* does. * does.
* \param value - The default value assigned to this argument if it * \param value - The default value assigned to this argument if it
* is not present on the command line. * is not present on the command line.
* \param allowed - A vector of type T that where the values in the * \param constraint - A pointer to a Constraint object used
* vector are the only values allowed for the arg. * to constrain this Arg.
* \param ignoreable - Allows you to specify that this argument can be * \param ignoreable - Allows you to specify that this argument can be
* ignored if the '--' flag is set. This defaults to false (cannot * ignored if the '--' flag is set. This defaults to false (cannot
* be ignored) and should generally stay that way unless you have * be ignored) and should generally stay that way unless you have
@ -139,7 +139,7 @@ class UnlabeledValueArg : public ValueArg<T>
UnlabeledValueArg( const std::string& name, UnlabeledValueArg( const std::string& name,
const std::string& desc, const std::string& desc,
T value, T value,
const std::vector<T>& allowed, Constraint<T>* constraint,
bool ignoreable = false, bool ignoreable = false,
Visitor* v = NULL ); Visitor* v = NULL );
@ -156,8 +156,8 @@ class UnlabeledValueArg : public ValueArg<T>
* does. * does.
* \param value - The default value assigned to this argument if it * \param value - The default value assigned to this argument if it
* is not present on the command line. * is not present on the command line.
* \param allowed - A vector of type T that where the values in the * \param constraint - A pointer to a Constraint object used
* vector are the only values allowed for the arg. * to constrain this Arg.
* \param parser - A CmdLine parser object to add this Arg to * \param parser - A CmdLine parser object to add this Arg to
* \param ignoreable - Allows you to specify that this argument can be * \param ignoreable - Allows you to specify that this argument can be
* ignored if the '--' flag is set. This defaults to false (cannot * ignored if the '--' flag is set. This defaults to false (cannot
@ -169,7 +169,7 @@ class UnlabeledValueArg : public ValueArg<T>
UnlabeledValueArg( const std::string& name, UnlabeledValueArg( const std::string& name,
const std::string& desc, const std::string& desc,
T value, T value,
const std::vector<T>& allowed, Constraint<T>* constraint,
CmdLineInterface& parser, CmdLineInterface& parser,
bool ignoreable = false, bool ignoreable = false,
Visitor* v = NULL); Visitor* v = NULL);
@ -242,10 +242,10 @@ template<class T>
UnlabeledValueArg<T>::UnlabeledValueArg(const std::string& name, UnlabeledValueArg<T>::UnlabeledValueArg(const std::string& name,
const std::string& desc, const std::string& desc,
T val, T val,
const std::vector<T>& allowed, Constraint<T>* constraint,
bool ignoreable, bool ignoreable,
Visitor* v) Visitor* v)
: ValueArg<T>("", name, desc, true, val, allowed, v) : ValueArg<T>("", name, desc, true, val, constraint, v)
{ {
_ignoreable = ignoreable; _ignoreable = ignoreable;
} }
@ -254,11 +254,11 @@ template<class T>
UnlabeledValueArg<T>::UnlabeledValueArg(const std::string& name, UnlabeledValueArg<T>::UnlabeledValueArg(const std::string& name,
const std::string& desc, const std::string& desc,
T val, T val,
const std::vector<T>& allowed, Constraint<T>* constraint,
CmdLineInterface& parser, CmdLineInterface& parser,
bool ignoreable, bool ignoreable,
Visitor* v) Visitor* v)
: ValueArg<T>("", name, desc, true, val, allowed, v) : ValueArg<T>("", name, desc, true, val, constraint, v)
{ {
_ignoreable = ignoreable; _ignoreable = ignoreable;
parser.add( this ); parser.add( this );

103
include/tclap/ValueArg.h
View File

@ -27,6 +27,7 @@
#include <vector> #include <vector>
#include <tclap/Arg.h> #include <tclap/Arg.h>
#include <tclap/Constraint.h>
#ifdef HAVE_CONFIG_H #ifdef HAVE_CONFIG_H
#include <config.h> #include <config.h>
@ -177,14 +178,6 @@ class ValueArg : public Arg
*/ */
T _value; T _value;
/**
* A list of allowed values.
* A list of values allowed for this argument. If the value parsed
* for this arg is not found in this list, then an exception is
* thrown. If the list is empty, then any value is allowed.
*/
std::vector<T> _allowed;
/** /**
* A human readable description of the type to be parsed. * A human readable description of the type to be parsed.
* This is a hack, plain and simple. Ideally we would use RTTI to * This is a hack, plain and simple. Ideally we would use RTTI to
@ -194,6 +187,11 @@ class ValueArg : public Arg
*/ */
std::string _typeDesc; std::string _typeDesc;
/**
* A Constraint this Arg must conform to.
*/
Constraint<T>* _constraint;
/** /**
* Extracts the value from the string. * Extracts the value from the string.
* Attempts to parse string as type T, if this fails an exception * Attempts to parse string as type T, if this fails an exception
@ -202,12 +200,6 @@ class ValueArg : public Arg
*/ */
void _extractValue( const std::string& val ); void _extractValue( const std::string& val );
/**
* Checks to see if parsed value is in allowed list.
* \param val - value parsed (only used in output).
*/
void _checkAllowed( const std::string& val );
public: public:
/** /**
@ -291,8 +283,8 @@ class ValueArg : public Arg
* line. * line.
* \param value - The default value assigned to this argument if it * \param value - The default value assigned to this argument if it
* is not present on the command line. * is not present on the command line.
* \param allowed - A vector of type T that where the values in the * \param constraint - A pointer to a Constraint object used
* vector are the only values allowed for the arg. * to constrain this Arg.
* \param parser - A CmdLine parser object to add this Arg to. * \param parser - A CmdLine parser object to add this Arg to.
* \param v - An optional visitor. You probably should not * \param v - An optional visitor. You probably should not
* use this unless you have a very good reason. * use this unless you have a very good reason.
@ -302,7 +294,7 @@ class ValueArg : public Arg
const std::string& desc, const std::string& desc,
bool req, bool req,
T value, T value,
const std::vector<T>& allowed, Constraint<T>* constraint,
CmdLineInterface& parser, CmdLineInterface& parser,
Visitor* v = NULL ); Visitor* v = NULL );
@ -322,8 +314,8 @@ class ValueArg : public Arg
* line. * line.
* \param value - The default value assigned to this argument if it * \param value - The default value assigned to this argument if it
* is not present on the command line. * is not present on the command line.
* \param allowed - A vector of type T that where the values in the * \param constraint - A pointer to a Constraint object used
* vector are the only values allowed for the arg. * to constrain this Arg.
* \param v - An optional visitor. You probably should not * \param v - An optional visitor. You probably should not
* use this unless you have a very good reason. * use this unless you have a very good reason.
*/ */
@ -332,7 +324,7 @@ class ValueArg : public Arg
const std::string& desc, const std::string& desc,
bool req, bool req,
T value, T value,
const std::vector<T>& allowed, Constraint<T>* constraint,
Visitor* v = NULL ); Visitor* v = NULL );
/** /**
@ -363,40 +355,9 @@ class ValueArg : public Arg
*/ */
virtual std::string longID(const std::string& val = "val") const; virtual std::string longID(const std::string& val = "val") const;
private:
/**
* Common initialization code for constructors with allowed vectors.
*/
void allowedInit();
}; };
template<class T>
void ValueArg<T>::allowedInit()
{
for ( unsigned int i = 0; i < _allowed.size(); i++ )
{
#if defined(HAVE_SSTREAM)
std::ostringstream os;
#elif defined(HAVE_STRSTREAM)
std::ostrstream os;
#else
#error "Need a stringstream (sstream or strstream) to compile!"
#endif
os << _allowed[i];
std::string temp( os.str() );
if ( i > 0 )
_typeDesc += "|";
_typeDesc += temp;
}
}
/** /**
* Constructor implementation. * Constructor implementation.
*/ */
@ -410,7 +371,8 @@ ValueArg<T>::ValueArg(const std::string& flag,
Visitor* v) Visitor* v)
: Arg(flag, name, desc, req, true, v), : Arg(flag, name, desc, req, true, v),
_value( val ), _value( val ),
_typeDesc( typeDesc ) _typeDesc( typeDesc ),
_constraint( NULL )
{ } { }
template<class T> template<class T>
@ -424,28 +386,24 @@ ValueArg<T>::ValueArg(const std::string& flag,
Visitor* v) Visitor* v)
: Arg(flag, name, desc, req, true, v), : Arg(flag, name, desc, req, true, v),
_value( val ), _value( val ),
_typeDesc( typeDesc ) _typeDesc( typeDesc ),
_constraint( NULL )
{ {
parser.add( this ); parser.add( this );
} }
/**
* Constructor with allowed list.
*/
template<class T> template<class T>
ValueArg<T>::ValueArg(const std::string& flag, ValueArg<T>::ValueArg(const std::string& flag,
const std::string& name, const std::string& name,
const std::string& desc, const std::string& desc,
bool req, bool req,
T val, T val,
const std::vector<T>& allowed, Constraint<T>* constraint,
Visitor* v) Visitor* v)
: Arg(flag, name, desc, req, true, v), : Arg(flag, name, desc, req, true, v),
_value( val ), _value( val ),
_allowed( allowed ) _constraint( constraint )
{ { }
allowedInit();
}
template<class T> template<class T>
ValueArg<T>::ValueArg(const std::string& flag, ValueArg<T>::ValueArg(const std::string& flag,
@ -453,14 +411,13 @@ ValueArg<T>::ValueArg(const std::string& flag,
const std::string& desc, const std::string& desc,
bool req, bool req,
T val, T val,
const std::vector<T>& allowed, Constraint<T>* constraint,
CmdLineInterface& parser, CmdLineInterface& parser,
Visitor* v) Visitor* v)
: Arg(flag, name, desc, req, true, v), : Arg(flag, name, desc, req, true, v),
_value( val ), _value( val ),
_allowed( allowed ) _constraint( constraint )
{ {
allowedInit();
parser.add( this ); parser.add( this );
} }
@ -518,18 +475,6 @@ bool ValueArg<T>::processArg(int *i, std::vector<std::string>& args)
return false; return false;
} }
/**
* Checks to see if the value parsed is in the allowed list.
*/
template<class T>
void ValueArg<T>::_checkAllowed( const std::string& val )
{
if ( _allowed.size() > 0 )
if ( find(_allowed.begin(),_allowed.end(),_value) == _allowed.end() )
throw( CmdLineParseException( "Couldn't find '" + val +
"' in allowed list.", toString() ) );
}
/** /**
* Implementation of shortID. * Implementation of shortID.
*/ */
@ -564,7 +509,11 @@ void ValueArg<T>::_extractValue( const std::string& val )
"More than one valid value parsed from string '" + "More than one valid value parsed from string '" +
val + "'", toString() ) ); val + "'", toString() ) );
_checkAllowed( val ); if ( _constraint != NULL )
if ( ! _constraint->check( _value ) )
throw( CmdLineParseException( "Value '" + val +
"' does not meet constraint: " +
_constraint->description() ) );
} }
} // namespace TCLAP } // namespace TCLAP