mirror of
https://github.com/cuberite/TCLAP.git
synced 2025-08-04 02:06:29 -04:00
35aa53232d
major problems. 1) There where static functions and variables that could cause link errors if tclap where used in different files (e.g. file1.cc and file2.cc included tclap then compiling both files would give hard symbols for some variables which would produce multiple definition when linking) 2) The dependencies of tclap was a bit strange (CmdLine depends on Args and Args depends on CmdLine for instance) The first problem I solved by removing all static variables putting them in static member functions (which are weak-symbols). So for instance every where there previously was something like x = _delimiter there now is x = delimiter() or in case of write acces delimiterRef() = x instead of _delimiter = x (I had to append the Ref because there where already functions with the same name as the variables). To solve the problem with static functions I simply inlined them. This causes the compiler to produce a weak symbol or inline if appropriate. We can put the functions inside the class declaration later to make the code look better. This worked fine in all but two cases. In the ValueArg and MultiArg classes I had to do a "hack" to work around the specialization template for extractValue<std::string>. The code for this is very simple but it might look strange an stupid at first but it is only to resolve the specialisation to a weak symbol. What I did was I put the implementations of extractValue in a helper class and I could then create a specialized class instead of function and everything worked out. I think now in retrospect there might be better solutions to this but I'll think a bit more on it (maybe some type of inlining on the specialized version would suffice but I'm not sure). To handle the dependencies I had to do some rewriting. The first step was to introduce a new class CmdLineInterface that is a purely abstract base of CmdLine that specifies the functions needed by Arg and friends. Thus Arg classes now takes an CmdLineInterface object as input instead (however only CmdLine can ever be instantiated of-course). With this extra class cleaning up the dependencies was quite simple, I've attached a dependency graph to the mail (depgraph.png). I also cleaned up the #includes so now only what actually needs inclusion is included. A nice side effect of this is that the impl. of CmdLine is now put back into CmdLine.h (where I guess you wanted it) which (recursivly) includes everything else needed. Just to make things clear for myself regarding the class dependencies I made a class TCLAP::Exception that inherits from std::exception and is a base of ArgException (Exception does nothing currently). If we don't want the Exception class it can be removed, however I think it could be a nice logic to have a base Exception class that every exception inherits from, but we can discuss that when we decide how to handle exceptions.
335 lines
11 KiB
C++
335 lines
11 KiB
C++
|
|
/******************************************************************************
|
|
*
|
|
* file: UnlabeledValueArg.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_UNLABELED_VALUE_ARGUMENT_H
|
|
#define TCLAP_UNLABELED_VALUE_ARGUMENT_H
|
|
|
|
#include <string>
|
|
#include <vector>
|
|
#include <sstream>
|
|
|
|
#include <tclap/ValueArg.h>
|
|
|
|
namespace TCLAP {
|
|
|
|
/**
|
|
* The basic unlabeled 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 an UnlabeledValueArg
|
|
* is reached in the list of args that the CmdLine iterates over.
|
|
*/
|
|
template<class T>
|
|
class UnlabeledValueArg : public ValueArg<T>
|
|
{
|
|
|
|
#ifdef TWO_STAGE_NAME_LOOKUP
|
|
//If compiler has two stage name lookup (as gcc >= 3.4 does)
|
|
//this is requried to prevent undef. symbols
|
|
using ValueArg<T>::_ignoreable;
|
|
using ValueArg<T>::_hasBlanks;
|
|
using ValueArg<T>::_extractValue;
|
|
using ValueArg<T>::_typeDesc;
|
|
using ValueArg<T>::_name;
|
|
using ValueArg<T>::_description;
|
|
using ValueArg<T>::_alreadySet;
|
|
#endif
|
|
|
|
public:
|
|
|
|
/**
|
|
* UnlabeledValueArg constructor.
|
|
* Note that this constructor does not have a required flag. Any
|
|
* unlabeled argument added to the CmdLine is by default required.
|
|
* If you want optional, unlabeled arguments then use an
|
|
* UnlabeledMultiArg.
|
|
* \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 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 ignoreable - Allows you to specify that this argument can be
|
|
* ignored if the '--' flag is set. This defaults to false (cannot
|
|
* be ignored) and should generally stay that way unless you have
|
|
* some special need for certain arguments to be ignored.
|
|
* \param v - Optional Vistor. You should leave this blank unless
|
|
* you have a very good reason.
|
|
*/
|
|
UnlabeledValueArg( const std::string& name,
|
|
const std::string& desc,
|
|
T value,
|
|
const std::string& typeDesc,
|
|
bool ignoreable = false,
|
|
Visitor* v = NULL);
|
|
|
|
/**
|
|
* UnlabeledValueArg constructor.
|
|
* Note that this constructor does not have a required flag. Any
|
|
* unlabeled argument added to the CmdLine is by default required.
|
|
* If you want optional, unlabeled arguments then use an
|
|
* UnlabeledMultiArg.
|
|
* \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 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 ignoreable - Allows you to specify that this argument can be
|
|
* ignored if the '--' flag is set. This defaults to false (cannot
|
|
* be ignored) and should generally stay that way unless you have
|
|
* some special need for certain arguments to be ignored.
|
|
* \param v - Optional Vistor. You should leave this blank unless
|
|
* you have a very good reason.
|
|
*/
|
|
UnlabeledValueArg( const std::string& name,
|
|
const std::string& desc,
|
|
T value,
|
|
const std::string& typeDesc,
|
|
CmdLineInterface& parser,
|
|
bool ignoreable = false,
|
|
Visitor* v = NULL );
|
|
|
|
/**
|
|
* UnlabeledValueArg constructor.
|
|
* Note that this constructor does not have a required flag. Any
|
|
* unlabeled argument added to the CmdLine is by default required.
|
|
* If you want optional, unlabeled arguments then use an
|
|
* UnlabeledMultiArg.
|
|
* \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 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 ignoreable - Allows you to specify that this argument can be
|
|
* ignored if the '--' flag is set. This defaults to false (cannot
|
|
* be ignored) and should generally stay that way unless you have
|
|
* some special need for certain arguments to be ignored.
|
|
* \param v - Optional Vistor. You should leave this blank unless
|
|
* you have a very good reason.
|
|
*/
|
|
UnlabeledValueArg( const std::string& name,
|
|
const std::string& desc,
|
|
T value,
|
|
const std::vector<T>& allowed,
|
|
bool ignoreable = false,
|
|
Visitor* v = NULL );
|
|
|
|
|
|
/**
|
|
* UnlabeledValueArg constructor.
|
|
* Note that this constructor does not have a required flag. Any
|
|
* unlabeled argument added to the CmdLine is by default required.
|
|
* If you want optional, unlabeled arguments then use an
|
|
* UnlabeledMultiArg.
|
|
* \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 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 ignoreable - Allows you to specify that this argument can be
|
|
* ignored if the '--' flag is set. This defaults to false (cannot
|
|
* be ignored) and should generally stay that way unless you have
|
|
* some special need for certain arguments to be ignored.
|
|
* \param v - Optional Vistor. You should leave this blank unless
|
|
* you have a very good reason.
|
|
*/
|
|
UnlabeledValueArg( const std::string& name,
|
|
const std::string& desc,
|
|
T value,
|
|
const std::vector<T>& allowed,
|
|
CmdLineInterface& parser,
|
|
bool ignoreable = false,
|
|
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. Handling specific to
|
|
* unlabled arguments.
|
|
* \param i - Pointer the the current argument in the list.
|
|
* \param args - Mutable list of strings.
|
|
*/
|
|
virtual bool processArg(int* i, std::vector<std::string>& args);
|
|
|
|
/**
|
|
* Overrides shortID for specific behavior.
|
|
*/
|
|
virtual std::string shortID(const std::string& val="val") const;
|
|
|
|
/**
|
|
* Overrides longID for specific behavior.
|
|
*/
|
|
virtual std::string longID(const std::string& val="val") const;
|
|
|
|
/**
|
|
* Overrides operator== for specific behavior.
|
|
*/
|
|
virtual bool operator==(const Arg& a ) const;
|
|
|
|
/**
|
|
* Instead of pushing to the front of list, push to the back.
|
|
* \param argList - The list to add this to.
|
|
*/
|
|
virtual void addToList( std::list<Arg*>& argList ) const;
|
|
};
|
|
|
|
/**
|
|
* Constructor implemenation.
|
|
*/
|
|
template<class T>
|
|
UnlabeledValueArg<T>::UnlabeledValueArg(const std::string& name,
|
|
const std::string& desc,
|
|
T val,
|
|
const std::string& typeDesc,
|
|
bool ignoreable,
|
|
Visitor* v)
|
|
: ValueArg<T>("", name, desc, true, val, typeDesc, v)
|
|
{
|
|
_ignoreable = ignoreable;
|
|
}
|
|
|
|
template<class T>
|
|
UnlabeledValueArg<T>::UnlabeledValueArg(const std::string& name,
|
|
const std::string& desc,
|
|
T val,
|
|
const std::string& typeDesc,
|
|
CmdLineInterface& parser,
|
|
bool ignoreable,
|
|
Visitor* v)
|
|
: ValueArg<T>("", name, desc, true, val, typeDesc, v)
|
|
{
|
|
_ignoreable = ignoreable;
|
|
parser.add( this );
|
|
}
|
|
|
|
/**
|
|
* Constructor implemenation.
|
|
*/
|
|
template<class T>
|
|
UnlabeledValueArg<T>::UnlabeledValueArg(const std::string& name,
|
|
const std::string& desc,
|
|
T val,
|
|
const std::vector<T>& allowed,
|
|
bool ignoreable,
|
|
Visitor* v)
|
|
: ValueArg<T>("", name, desc, true, val, allowed, v)
|
|
{
|
|
_ignoreable = ignoreable;
|
|
}
|
|
|
|
template<class T>
|
|
UnlabeledValueArg<T>::UnlabeledValueArg(const std::string& name,
|
|
const std::string& desc,
|
|
T val,
|
|
const std::vector<T>& allowed,
|
|
CmdLineInterface& parser,
|
|
bool ignoreable,
|
|
Visitor* v)
|
|
: ValueArg<T>("", name, desc, true, val, allowed, v)
|
|
{
|
|
_ignoreable = ignoreable;
|
|
parser.add( this );
|
|
}
|
|
|
|
/**
|
|
* Implementation of processArg().
|
|
*/
|
|
template<class T>
|
|
bool UnlabeledValueArg<T>::processArg(int *i, std::vector<std::string>& args)
|
|
{
|
|
|
|
if ( _alreadySet )
|
|
return false;
|
|
|
|
if ( _hasBlanks( args[*i] ) )
|
|
return false;
|
|
|
|
// never ignore an unlabeled arg
|
|
|
|
_extractValue( args[*i] );
|
|
_alreadySet = true;
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Overriding shortID for specific output.
|
|
*/
|
|
template<class T>
|
|
std::string UnlabeledValueArg<T>::shortID(const std::string& val) const
|
|
{
|
|
std::string id = "<" + _typeDesc + ">";
|
|
|
|
return id;
|
|
}
|
|
|
|
/**
|
|
* Overriding longID for specific output.
|
|
*/
|
|
template<class T>
|
|
std::string UnlabeledValueArg<T>::longID(const std::string& val) const
|
|
{
|
|
// Ideally we would like to be able to use RTTI to return the name
|
|
// of the type required for this argument. However, g++ at least,
|
|
// doesn't appear to return terribly useful "names" of the types.
|
|
std::string id = "<" + _typeDesc + ">";
|
|
|
|
return id;
|
|
}
|
|
|
|
/**
|
|
* Overriding operator== for specific behavior.
|
|
*/
|
|
template<class T>
|
|
bool UnlabeledValueArg<T>::operator==(const Arg& a ) const
|
|
{
|
|
if ( _name == a.getName() || _description == a.getDescription() )
|
|
return true;
|
|
else
|
|
return false;
|
|
}
|
|
|
|
template<class T>
|
|
void UnlabeledValueArg<T>::addToList( std::list<Arg*>& argList ) const
|
|
{
|
|
argList.push_back( (Arg*)this );
|
|
}
|
|
|
|
}
|
|
#endif
|