mirror of
https://github.com/cuberite/TCLAP.git
synced 2025-08-04 10:16:41 -04:00
573 lines
17 KiB
C++
573 lines
17 KiB
C++
/******************************************************************************
|
|
*
|
|
* file: ValueArg.h
|
|
*
|
|
* Copyright (c) 2003, Michael E. Smoot .
|
|
* Copyright (c) 2004, Michael E. Smoot, Daniel Aarno.
|
|
* All rights reverved.
|
|
*
|
|
* See the file COPYING in the top directory of this distribution for
|
|
* more information.
|
|
*
|
|
* THE SOFTWARE IS PROVIDED _AS IS_, WITHOUT WARRANTY OF ANY KIND, EXPRESS
|
|
* OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
|
|
* THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
|
|
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
|
|
* DEALINGS IN THE SOFTWARE.
|
|
*
|
|
*****************************************************************************/
|
|
|
|
|
|
#ifndef TCLAP_VALUE_ARGUMENT_H
|
|
#define TCLAP_VALUE_ARGUMENT_H
|
|
|
|
#include <string>
|
|
#include <vector>
|
|
|
|
#include <tclap/Arg.h>
|
|
|
|
#ifdef HAVE_CONFIG_H
|
|
#include <config.h>
|
|
#else
|
|
#define HAVE_SSTREAM
|
|
#endif
|
|
|
|
#if defined(HAVE_SSTREAM)
|
|
#include <sstream>
|
|
#elif defined(HAVE_STRSTREAM)
|
|
#include <strstream>
|
|
#else
|
|
#error "Need a stringstream (sstream or strstream) to compile!"
|
|
#endif
|
|
|
|
namespace TCLAP {
|
|
|
|
template<class T> class ValueArg;
|
|
|
|
namespace VALUE_ARG_HELPER {
|
|
|
|
enum Error_e { EXTRACT_FAILURE = 1000, EXTRACT_TOO_MANY };
|
|
|
|
/**
|
|
* This class is used to extract a value from an argument.
|
|
* It is used because we need a special implementation to
|
|
* deal with std::string and making a specialiced function
|
|
* puts it in the T segment, thus generating link errors.
|
|
* Having a specialiced class makes the symbols weak.
|
|
* This is not pretty but I don't know how to make it
|
|
* work any other way.
|
|
*/
|
|
template<class T> class ValueExtractor
|
|
{
|
|
/**
|
|
*
|
|
*/
|
|
friend class ValueArg<T>;
|
|
|
|
private:
|
|
|
|
/**
|
|
* Reference to the value where the result of the extraction will
|
|
* be put.
|
|
*/
|
|
T &_value;
|
|
|
|
/**
|
|
* Constructor.
|
|
* \param value - Where the value extracted will be put.
|
|
*/
|
|
ValueExtractor(T &value) : _value(value) { }
|
|
|
|
/**
|
|
* Method that will attempt to parse the input stream for a value
|
|
* of type T.
|
|
* \param val - Where the value parsed will be put.
|
|
*/
|
|
int extractValue( const std::string& val )
|
|
{
|
|
|
|
#if defined(HAVE_SSTREAM)
|
|
std::istringstream is(val);
|
|
#elif defined(HAVE_STRSTREAM)
|
|
std::istrstream is(val.c_str());
|
|
#else
|
|
#error "Need a stringstream (sstream or strstream) to compile!"
|
|
#endif
|
|
|
|
int valuesRead = 0;
|
|
while ( is.good() )
|
|
{
|
|
if ( is.peek() != EOF )
|
|
is >> _value;
|
|
else
|
|
break;
|
|
|
|
valuesRead++;
|
|
}
|
|
|
|
if ( is.fail() )
|
|
return EXTRACT_FAILURE;
|
|
|
|
if ( valuesRead > 1 )
|
|
return EXTRACT_TOO_MANY;
|
|
|
|
return 0;
|
|
}
|
|
};
|
|
|
|
/**
|
|
* Specialization for string. This is necessary because istringstream
|
|
* operator>> is not able to ignore spaces... meaning -x "X Y" will only
|
|
* read 'X'... and thus the specialization.
|
|
*/
|
|
template<> class ValueExtractor<std::string>
|
|
{
|
|
/**
|
|
*
|
|
*/
|
|
friend class ValueArg<std::string>;
|
|
|
|
private:
|
|
|
|
/**
|
|
* Reference to the value where the result of the extraction will
|
|
* be put.
|
|
*/
|
|
std::string &_value;
|
|
|
|
/**
|
|
* Constructor.
|
|
* \param value - Where the value extracted will be put.
|
|
*/
|
|
ValueExtractor(std::string &value) : _value(value) {}
|
|
|
|
/**
|
|
* Method that will attempt to parse the input stream for a value
|
|
* of type std::string.
|
|
* \param val - Where the string parsed will be put.
|
|
*/
|
|
int extractValue( const std::string& val )
|
|
{
|
|
_value = val;
|
|
return 0;
|
|
}
|
|
};
|
|
|
|
} //namespace VALUE_ARG_HELPER
|
|
|
|
/**
|
|
* The basic labeled argument that parses a value.
|
|
* This is a template class, which means the type T defines the type
|
|
* that a given object will attempt to parse when the flag/name is matched
|
|
* on the command line. While there is nothing stopping you from creating
|
|
* an unflagged ValueArg, it is unwise and would cause significant problems.
|
|
* Instead use an UnlabeledValueArg.
|
|
*/
|
|
template<class T>
|
|
class ValueArg : public Arg
|
|
{
|
|
protected:
|
|
|
|
/**
|
|
* The value parsed from the command line.
|
|
* Can be of any type, as long as the >> operator for the type
|
|
* is defined.
|
|
*/
|
|
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.
|
|
* This is a hack, plain and simple. Ideally we would use RTTI to
|
|
* return the name of type T, but until there is some sort of
|
|
* consistent support for human readable names, we are left to our
|
|
* own devices.
|
|
*/
|
|
std::string _typeDesc;
|
|
|
|
/**
|
|
* Extracts the value from the string.
|
|
* Attempts to parse string as type T, if this fails an exception
|
|
* is thrown.
|
|
* \param val - value to be parsed.
|
|
*/
|
|
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:
|
|
|
|
/**
|
|
* Labeled ValueArg constructor.
|
|
* You could conceivably call this constructor with a blank flag,
|
|
* but that would make you a bad person. It would also cause
|
|
* an exception to be thrown. If you want an unlabeled argument,
|
|
* use the other constructor.
|
|
* \param flag - The one character flag that identifies this
|
|
* argument on the command line.
|
|
* \param name - A one word name for the argument. Can be
|
|
* used as a long flag on the command line.
|
|
* \param desc - A description of what the argument is for or
|
|
* does.
|
|
* \param req - Whether the argument is required on the command
|
|
* line.
|
|
* \param value - The default value assigned to this argument if it
|
|
* is not present on the command line.
|
|
* \param typeDesc - A short, human readable description of the
|
|
* type that this object expects. This is used in the generation
|
|
* of the USAGE statement. The goal is to be helpful to the end user
|
|
* of the program.
|
|
* \param v - An optional visitor. You probably should not
|
|
* use this unless you have a very good reason.
|
|
*/
|
|
ValueArg( const std::string& flag,
|
|
const std::string& name,
|
|
const std::string& desc,
|
|
bool req,
|
|
T value,
|
|
const std::string& typeDesc,
|
|
Visitor* v = NULL);
|
|
|
|
|
|
/**
|
|
* Labeled ValueArg constructor.
|
|
* You could conceivably call this constructor with a blank flag,
|
|
* but that would make you a bad person. It would also cause
|
|
* an exception to be thrown. If you want an unlabeled argument,
|
|
* use the other constructor.
|
|
* \param flag - The one character flag that identifies this
|
|
* argument on the command line.
|
|
* \param name - A one word name for the argument. Can be
|
|
* used as a long flag on the command line.
|
|
* \param desc - A description of what the argument is for or
|
|
* does.
|
|
* \param req - Whether the argument is required on the command
|
|
* line.
|
|
* \param value - The default value assigned to this argument if it
|
|
* is not present on the command line.
|
|
* \param typeDesc - A short, human readable description of the
|
|
* type that this object expects. This is used in the generation
|
|
* of the USAGE statement. The goal is to be helpful to the end user
|
|
* of the program.
|
|
* \param parser - A CmdLine parser object to add this Arg to
|
|
* \param v - An optional visitor. You probably should not
|
|
* use this unless you have a very good reason.
|
|
*/
|
|
ValueArg( const std::string& flag,
|
|
const std::string& name,
|
|
const std::string& desc,
|
|
bool req,
|
|
T value,
|
|
const std::string& typeDesc,
|
|
CmdLineInterface& parser,
|
|
Visitor* v = NULL );
|
|
|
|
/**
|
|
* Labeled ValueArg constructor.
|
|
* You could conceivably call this constructor with a blank flag,
|
|
* but that would make you a bad person. It would also cause
|
|
* an exception to be thrown. If you want an unlabeled argument,
|
|
* use the other constructor.
|
|
* \param flag - The one character flag that identifies this
|
|
* argument on the command line.
|
|
* \param name - A one word name for the argument. Can be
|
|
* used as a long flag on the command line.
|
|
* \param desc - A description of what the argument is for or
|
|
* does.
|
|
* \param req - Whether the argument is required on the command
|
|
* line.
|
|
* \param value - The default value assigned to this argument if it
|
|
* is not present on the command line.
|
|
* \param allowed - A vector of type T that where the values in the
|
|
* vector are the only values allowed for the arg.
|
|
* \param parser - A CmdLine parser object to add this Arg to.
|
|
* \param v - An optional visitor. You probably should not
|
|
* use this unless you have a very good reason.
|
|
*/
|
|
ValueArg( const std::string& flag,
|
|
const std::string& name,
|
|
const std::string& desc,
|
|
bool req,
|
|
T value,
|
|
const std::vector<T>& allowed,
|
|
CmdLineInterface& parser,
|
|
Visitor* v = NULL );
|
|
|
|
/**
|
|
* Labeled ValueArg constructor.
|
|
* You could conceivably call this constructor with a blank flag,
|
|
* but that would make you a bad person. It would also cause
|
|
* an exception to be thrown. If you want an unlabeled argument,
|
|
* use the other constructor.
|
|
* \param flag - The one character flag that identifies this
|
|
* argument on the command line.
|
|
* \param name - A one word name for the argument. Can be
|
|
* used as a long flag on the command line.
|
|
* \param desc - A description of what the argument is for or
|
|
* does.
|
|
* \param req - Whether the argument is required on the command
|
|
* line.
|
|
* \param value - The default value assigned to this argument if it
|
|
* is not present on the command line.
|
|
* \param allowed - A vector of type T that where the values in the
|
|
* vector are the only values allowed for the arg.
|
|
* \param v - An optional visitor. You probably should not
|
|
* use this unless you have a very good reason.
|
|
*/
|
|
ValueArg( const std::string& flag,
|
|
const std::string& name,
|
|
const std::string& desc,
|
|
bool req,
|
|
T value,
|
|
const std::vector<T>& allowed,
|
|
Visitor* v = NULL );
|
|
|
|
/**
|
|
* Handles the processing of the argument.
|
|
* This re-implements the Arg version of this method to set the
|
|
* _value of the argument appropriately. It knows the difference
|
|
* between labeled and unlabeled.
|
|
* \param i - Pointer the the current argument in the list.
|
|
* \param args - Mutable list of strings. Passed
|
|
* in from main().
|
|
*/
|
|
virtual bool processArg(int* i, std::vector<std::string>& args);
|
|
|
|
/**
|
|
* Returns the value of the argument.
|
|
*/
|
|
T& getValue() ;
|
|
|
|
/**
|
|
* Specialization of shortID.
|
|
* \param val - value to be used.
|
|
*/
|
|
virtual std::string shortID(const std::string& val = "val") const;
|
|
|
|
/**
|
|
* Specialization of longID.
|
|
* \param val - value to be used.
|
|
*/
|
|
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.
|
|
*/
|
|
template<class T>
|
|
ValueArg<T>::ValueArg(const std::string& flag,
|
|
const std::string& name,
|
|
const std::string& desc,
|
|
bool req,
|
|
T val,
|
|
const std::string& typeDesc,
|
|
Visitor* v)
|
|
: Arg(flag, name, desc, req, true, v),
|
|
_value( val ),
|
|
_typeDesc( typeDesc )
|
|
{ }
|
|
|
|
template<class T>
|
|
ValueArg<T>::ValueArg(const std::string& flag,
|
|
const std::string& name,
|
|
const std::string& desc,
|
|
bool req,
|
|
T val,
|
|
const std::string& typeDesc,
|
|
CmdLineInterface& parser,
|
|
Visitor* v)
|
|
: Arg(flag, name, desc, req, true, v),
|
|
_value( val ),
|
|
_typeDesc( typeDesc )
|
|
{
|
|
parser.add( this );
|
|
}
|
|
|
|
/**
|
|
* Constructor with allowed list.
|
|
*/
|
|
template<class T>
|
|
ValueArg<T>::ValueArg(const std::string& flag,
|
|
const std::string& name,
|
|
const std::string& desc,
|
|
bool req,
|
|
T val,
|
|
const std::vector<T>& allowed,
|
|
Visitor* v)
|
|
: Arg(flag, name, desc, req, true, v),
|
|
_value( val ),
|
|
_allowed( allowed )
|
|
{
|
|
allowedInit();
|
|
}
|
|
|
|
template<class T>
|
|
ValueArg<T>::ValueArg(const std::string& flag,
|
|
const std::string& name,
|
|
const std::string& desc,
|
|
bool req,
|
|
T val,
|
|
const std::vector<T>& allowed,
|
|
CmdLineInterface& parser,
|
|
Visitor* v)
|
|
: Arg(flag, name, desc, req, true, v),
|
|
_value( val ),
|
|
_allowed( allowed )
|
|
{
|
|
allowedInit();
|
|
parser.add( this );
|
|
}
|
|
|
|
|
|
/**
|
|
* Implementation of getValue().
|
|
*/
|
|
template<class T>
|
|
T& ValueArg<T>::getValue() { return _value; }
|
|
|
|
/**
|
|
* Implementation of processArg().
|
|
*/
|
|
template<class T>
|
|
bool ValueArg<T>::processArg(int *i, std::vector<std::string>& args)
|
|
{
|
|
if ( _ignoreable && Arg::ignoreRest() )
|
|
return false;
|
|
|
|
if ( _hasBlanks( args[*i] ) )
|
|
return false;
|
|
|
|
std::string flag = args[*i];
|
|
|
|
std::string value = "";
|
|
trimFlag( flag, value );
|
|
|
|
if ( argMatches( flag ) )
|
|
{
|
|
if ( _alreadySet )
|
|
throw( CmdLineParseException("Argument already set!", toString()) );
|
|
|
|
if ( Arg::delimiter() != ' ' && value == "" )
|
|
throw( ArgParseException(
|
|
"Couldn't find delimiter for this argument!",
|
|
toString() ) );
|
|
|
|
if ( value == "" )
|
|
{
|
|
(*i)++;
|
|
if ( (unsigned int)*i < args.size() )
|
|
_extractValue( args[*i] );
|
|
else
|
|
throw( ArgParseException("Missing a value for this argument!",
|
|
toString() ) );
|
|
}
|
|
else
|
|
_extractValue( value );
|
|
|
|
_alreadySet = true;
|
|
_checkWithVisitor();
|
|
return true;
|
|
}
|
|
else
|
|
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.
|
|
*/
|
|
template<class T>
|
|
std::string ValueArg<T>::shortID(const std::string& val) const
|
|
{
|
|
return Arg::shortID( _typeDesc );
|
|
}
|
|
|
|
/**
|
|
* Implementation of longID.
|
|
*/
|
|
template<class T>
|
|
std::string ValueArg<T>::longID(const std::string& val) const
|
|
{
|
|
return Arg::longID( _typeDesc );
|
|
}
|
|
|
|
template<class T>
|
|
void ValueArg<T>::_extractValue( const std::string& val )
|
|
{
|
|
VALUE_ARG_HELPER::ValueExtractor<T> ve(_value);
|
|
|
|
int err = ve.extractValue(val);
|
|
|
|
if ( err == VALUE_ARG_HELPER::EXTRACT_FAILURE )
|
|
throw( ArgParseException("Couldn't read argument value from string '" +
|
|
val + "'", toString() ) );
|
|
|
|
if ( err == VALUE_ARG_HELPER::EXTRACT_TOO_MANY )
|
|
throw( ArgParseException(
|
|
"More than one valid value parsed from string '" +
|
|
val + "'", toString() ) );
|
|
|
|
_checkAllowed( val );
|
|
}
|
|
|
|
} // namespace TCLAP
|
|
|
|
#endif
|