MultiArg.h

Go to the documentation of this file.

/****************************************************************************** 
 * 
 *  file:  MultiArg.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_MULTIPLE_ARGUMENT_H
#define TCLAP_MULTIPLE_ARGUMENT_H

#include <string>
#include <vector>

#include <tclap/Arg.h>
#include <tclap/Constraint.h>

namespace TCLAP {
template<class T>
class MultiArg : public Arg
{
public:
        typedef std::vector<T> container_type;  
        typedef typename container_type::iterator iterator;
        typedef typename container_type::const_iterator const_iterator;

protected:

        std::vector<T> _values;

        std::string _typeDesc;

        Constraint<T>* _constraint;

        void _extractValue( const std::string& val );

        bool _allowMore;

public:

        MultiArg( const std::string& flag,
                  const std::string& name,
                  const std::string& desc,
                  bool req,
                  const std::string& typeDesc,
                  Visitor* v = NULL);

        MultiArg( const std::string& flag, 
                  const std::string& name,
                  const std::string& desc,
                  bool req,
                  const std::string& typeDesc,
                  CmdLineInterface& parser,
                  Visitor* v = NULL );

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

        const std::vector<T>& getValue();

        const_iterator begin() const { return _values.begin(); }

        const_iterator end() const { return _values.end(); }

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

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

        virtual bool isRequired() const;

        virtual bool allowMore();
        
        virtual void reset();

private:
        MultiArg<T>(const MultiArg<T>& rhs);
        MultiArg<T>& operator=(const MultiArg<T>& rhs);

};

template<class T>
MultiArg<T>::MultiArg(const std::string& flag, 
                      const std::string& name,
                      const std::string& desc,
                      bool req,
                      const std::string& typeDesc,
                      Visitor* v) :
   Arg( flag, name, desc, req, true, v ),
  _values(std::vector<T>()),
  _typeDesc( typeDesc ),
  _constraint( NULL ),
  _allowMore(false)
{ 
        _acceptsMultipleValues = true;
}

template<class T>
MultiArg<T>::MultiArg(const std::string& flag, 
                      const std::string& name,
                      const std::string& desc,
                      bool req,
                      const std::string& typeDesc,
                      CmdLineInterface& parser,
                      Visitor* v)
: Arg( flag, name, desc, req, true, v ),
  _values(std::vector<T>()),
  _typeDesc( typeDesc ),
  _constraint( NULL ),
  _allowMore(false)
{ 
        parser.add( this );
        _acceptsMultipleValues = true;
}

template<class T>
MultiArg<T>::MultiArg(const std::string& flag, 
                      const std::string& name,
                      const std::string& desc,
                      bool req,
                      Constraint<T>* constraint,
                      Visitor* v)
: Arg( flag, name, desc, req, true, v ),
  _values(std::vector<T>()),
  _typeDesc( constraint->shortID() ),
  _constraint( constraint ),
  _allowMore(false)
{ 
        _acceptsMultipleValues = true;
}

template<class T>
MultiArg<T>::MultiArg(const std::string& flag, 
                      const std::string& name,
                      const std::string& desc,
                      bool req,
                      Constraint<T>* constraint,
                      CmdLineInterface& parser,
                      Visitor* v)
: Arg( flag, name, desc, req, true, v ),
  _values(std::vector<T>()),
  _typeDesc( constraint->shortID() ),
  _constraint( constraint ),
  _allowMore(false)
{ 
        parser.add( this );
        _acceptsMultipleValues = true;
}

template<class T>
const std::vector<T>& MultiArg<T>::getValue() { return _values; }

template<class T>
bool MultiArg<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 ( Arg::delimiter() != ' ' && value == "" )
                        throw( ArgParseException( 
                                   "Couldn't find delimiter for this argument!",
                                           toString() ) );

                // always take the first one, regardless of start string
                if ( value == "" )
                {
                        (*i)++;
                        if ( static_cast<unsigned int>(*i) < args.size() )
                                _extractValue( args[*i] );
                        else
                                throw( ArgParseException("Missing a value for this argument!",
                                         toString() ) );
                } 
                else
                        _extractValue( value );

                /*
                // continuing taking the args until we hit one with a start string 
                while ( (unsigned int)(*i)+1 < args.size() &&
                                args[(*i)+1].find_first_of( Arg::flagStartString() ) != 0 &&
                        args[(*i)+1].find_first_of( Arg::nameStartString() ) != 0 ) 
                                _extractValue( args[++(*i)] );
                */

                _alreadySet = true;
                _checkWithVisitor();

                return true;
        }
        else
                return false;
}

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

template<class T>
std::string MultiArg<T>::longID(const std::string& val) const
{
        static_cast<void>(val); // Ignore input, don't warn
        return Arg::longID(_typeDesc) + "  (accepted multiple times)";
}

template<class T>
bool MultiArg<T>::isRequired() const
{
        if ( _required )
        {
                if ( _values.size() > 1 )
                        return false;
                else
                        return true;
        }
        else
                return false;

}

template<class T>
void MultiArg<T>::_extractValue( const std::string& val ) 
{
    try {
        T tmp;
        ExtractValue(tmp, val, typename ArgTraits<T>::ValueCategory());
        _values.push_back(tmp);
    } catch( ArgParseException &e) {
        throw ArgParseException(e.error(), toString());
    }

    if ( _constraint != NULL )
        if ( ! _constraint->check( _values.back() ) )
            throw( CmdLineParseException( "Value '" + val +
                                          "' does not meet constraint: " +
                                          _constraint->description(), 
                                          toString() ) );
}
                
template<class T>
bool MultiArg<T>::allowMore()
{
        bool am = _allowMore;
        _allowMore = true;
        return am;
}

template<class T>
void MultiArg<T>::reset()
{
        Arg::reset();
        _values.clear();
}

} // namespace TCLAP

#endif