UnlabeledValueArg.h

Go to the documentation of this file.

/****************************************************************************** 
 * 
 *  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 <tclap/ValueArg.h>
#include <tclap/OptionalUnlabeledTracker.h>


namespace TCLAP {

template<class T>
class UnlabeledValueArg : public ValueArg<T>
{

        // 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;
        using ValueArg<T>::toString;

        public:

                UnlabeledValueArg( const std::string& name, 
                                       const std::string& desc, 
                                                   bool req,
                                           T value,
                                           const std::string& typeDesc,
                                                   bool ignoreable = false,
                                           Visitor* v = NULL); 

                UnlabeledValueArg( const std::string& name, 
                                       const std::string& desc, 
                                                   bool req,
                                           T value,
                                           const std::string& typeDesc,
                                                   CmdLineInterface& parser,
                                                   bool ignoreable = false,
                                           Visitor* v = NULL );                                         
                                                
                UnlabeledValueArg( const std::string& name, 
                                       const std::string& desc, 
                                                   bool req,
                                           T value,
                                           Constraint<T>* constraint,
                                                   bool ignoreable = false,
                                           Visitor* v = NULL ); 

                
                UnlabeledValueArg( const std::string& name, 
                                       const std::string& desc, 
                                                   bool req,
                                           T value,
                                           Constraint<T>* constraint,
                                                   CmdLineInterface& parser,
                                                   bool ignoreable = false,
                                           Visitor* v = NULL);
                                                
                virtual bool processArg(int* i, std::vector<std::string>& args); 

                virtual std::string shortID(const std::string& val="val") const;

                virtual std::string longID(const std::string& val="val") const;

                virtual bool operator==(const Arg& a ) const;

                virtual void addToList( std::list<Arg*>& argList ) const;

};

template<class T>
UnlabeledValueArg<T>::UnlabeledValueArg(const std::string& name, 
                                                            const std::string& desc, 
                                                                                bool req,
                                                            T val,
                                                            const std::string& typeDesc,
                                                            bool ignoreable,
                                                            Visitor* v)
: ValueArg<T>("", name, desc, req, val, typeDesc, v)
{ 
        _ignoreable = ignoreable;

        OptionalUnlabeledTracker::check(req, toString());

}

template<class T>
UnlabeledValueArg<T>::UnlabeledValueArg(const std::string& name, 
                                                            const std::string& desc, 
                                                                                bool req,
                                                            T val,
                                                            const std::string& typeDesc,
                                                            CmdLineInterface& parser,
                                                            bool ignoreable,
                                                            Visitor* v)
: ValueArg<T>("", name, desc, req, val, typeDesc, v)
{ 
        _ignoreable = ignoreable;
        OptionalUnlabeledTracker::check(req, toString());
        parser.add( this );
}

template<class T>
UnlabeledValueArg<T>::UnlabeledValueArg(const std::string& name, 
                                        const std::string& desc, 
                                                                                bool req,
                                        T val,
                                        Constraint<T>* constraint,
                                        bool ignoreable,
                                        Visitor* v)
: ValueArg<T>("", name, desc, req, val, constraint, v)
{ 
        _ignoreable = ignoreable;
        OptionalUnlabeledTracker::check(req, toString());
}

template<class T>
UnlabeledValueArg<T>::UnlabeledValueArg(const std::string& name, 
                                                            const std::string& desc, 
                                                                                bool req,
                                                            T val,
                                                            Constraint<T>* constraint,
                                                            CmdLineInterface& parser,
                                                            bool ignoreable,
                                                            Visitor* v)
: ValueArg<T>("", name, desc, req, val, constraint,  v)
{ 
        _ignoreable = ignoreable;
        OptionalUnlabeledTracker::check(req, toString());
        parser.add( this );
}

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;
}

template<class T>
std::string UnlabeledValueArg<T>::shortID(const std::string& val) const
{
        static_cast<void>(val); // Ignore input, don't warn
        return std::string("<") + _typeDesc + ">";
}

template<class T>
std::string UnlabeledValueArg<T>::longID(const std::string& val) const
{
        static_cast<void>(val); // Ignore input, don't warn

        // 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.  
        return std::string("<") + _typeDesc + ">";
}

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( const_cast<Arg*>(static_cast<const Arg* const>(this)) );
}

}
#endif