ValueArg.h

Go to the documentation of this file.

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

template<class T> class ValueExtractor 
{
     friend class ValueArg<T>;

     private:

        T &_value;

        ValueExtractor(T &value) : _value(value) { }

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

template<> class ValueExtractor<std::string> 
{
    friend class ValueArg<std::string>;

    private:
     
        std::string &_value;

        ValueExtractor(std::string &value) : _value(value) {}

        int extractValue( const std::string& val ) 
          {
            _value = val;
            return 0;
        }
};

} //namespace VALUE_ARG_HELPER 

template<class T>
class ValueArg : public Arg 
{
    protected:

        T _value;

        std::vector<T> _allowed;

        std::string _typeDesc;

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

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

     public:

        ValueArg( const std::string& flag, 
                  const std::string& name, 
                  const std::string& desc, 
                  bool req, 
                  T value,
                  const std::string& typeDesc,
                  Visitor* v = NULL);
                     
                     
        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 );
 
        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 );
       
        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 );

        virtual bool processArg(int* i, std::vector<std::string>& args); 

        T& getValue() ;

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

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

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

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

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


template<class T>
T& ValueArg<T>::getValue() { return _value; }

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

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

template<class T>
std::string ValueArg<T>::shortID(const std::string& val) const
{
    return Arg::shortID( _typeDesc );   
}

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

---