/****************************************************************************** 
 * 
 *  file:  MultiArg.h
 * 
 *  Copyright (c) 2003, Michael E. Smoot .
 *  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 __MULTIPLE_ARGUMENT_HH__
#define __MULTIPLE_ARGUMENT_HH__

#include <string>
#include <vector>
#include <sstream>
#include <tclap/Visitor.h>

using namespace std;

namespace TCLAP {

/**
 * An argument that allows multiple values of type T to be specified.  Very
 * similar to a ValueArg, except a vector of values will be returned
 * instead of just one.
 */
template<class T>
class MultiArg : public Arg
{
	protected:

		/**
		 * The list of values parsed from the CmdLine.
		 */
		vector<T> _values;

        /**
		 * 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.
		 */
		vector<T> _allowed;

		/**
		 * The description of type T to be used in the usage.
		 */
		string _typeDesc;

		/**
		 * Extracts the value from the string.
		 * Attempts to parse string as type T, if this fails an exception
		 * is thrown.
		 * \param val - The string to be read.
		 */

		void _extractValue( const string& val ); 

        /**
		 * Checks to see if parsed value is in allowed list.
		 * \param val - value parsed (only used in output).
		 */
		void _checkAllowed( const string& val );

	public:

		/**
		 * 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 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.
		 */
		MultiArg( const string& flag,
				  const string& name,
				  const string& desc,
				  bool req,
				  const string& typeDesc,
				  Visitor* v = NULL);

		/**
		 * 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 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.
		 */
		MultiArg( const string& flag,
				  const string& name,
				  const string& desc,
				  bool req,
				  const vector<T>& allowed,
				  Visitor* v = NULL);

		/**
		 * Destructor.
		 */
		~MultiArg();

		/**
		 * 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 from main().
		 */
		virtual bool processArg(int* i, vector<string>& args); 

		/**
		 * Returns a vector of type T containing the values parsed from
		 * the command line.
		 */
		const vector<T>& getValue() ;

		/**
		 * Returns the a short id string.  Used in the usage. 
		 * \param val - value to be used.
		 */
		virtual string shortID(const string& val="val") const;

		/**
		 * Returns the a long id string.  Used in the usage. 
		 * \param val - value to be used.
		 */
		virtual string longID(const string& val="val") const;

		/**
		 * Once we've matched the first value, then the arg is no longer
		 * required.
		 */
		virtual bool isRequired() const;

};

/**
 *
 */
template<class T>
MultiArg<T>::MultiArg(const string& flag, 
				      const string& name,
				      const string& desc,
					  bool req,
					  const string& typeDesc,
				      Visitor* v)
: Arg( flag, name, desc, req, true, v ),
  _typeDesc( typeDesc )
{ };


/**
 *
 */
template<class T>
MultiArg<T>::MultiArg(const string& flag, 
				      const string& name,
				      const string& desc,
					  bool req,
					  const vector<T>& allowed,
				      Visitor* v)
: Arg( flag, name, desc, req, true, v ),
  _allowed( allowed )
{ 
	for ( unsigned int i = 0; i < _allowed.size(); i++ )
	{
		ostringstream os;
		os << _allowed[i];

		string temp( os.str() );

		if ( i > 0 )
			_typeDesc += "|";
		_typeDesc += temp;
	}
};


/**
 *
 */
template<class T>
MultiArg<T>::~MultiArg() { };

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

/**
 *
 */
template<class T>
bool MultiArg<T>::processArg(int *i, vector<string>& args) 
{
	if ( _ignoreable && Arg::ignoreRest() )
		return false;

	if ( _hasBlanks( args[*i] ) )
		return false;

	string flag = args[*i];
	string value = "";

	trimFlag( flag, value );

	if ( argMatches( flag ) )
	{
		if ( Arg::_delimiter != ' ' && value == "" )
			throw( ArgException( "Couldn't find delimiter for this argument!",
           	                          toString() ) );

		if ( value == "" )
		{
			(*i)++;
			if ( (unsigned int)*i < args.size() )
				_extractValue( args[*i] );
			else
				throw( ArgException("Missing a value for this argument!",
           	                          toString() ) );
		}
		else
			_extractValue( value );

		_checkWithVisitor();
		return true;
	}
	else
		return false;
}

/**
 *
 */
template<class T>
void MultiArg<T>::_extractValue( const string& val )
{
	T temp;
	istringstream is(val);

	int valuesRead = 0;
	while ( is.good() )
	{
		if ( is.peek() != EOF )
			is >> temp; 
		else
			break;

		valuesRead++;
	}		

    if ( is.fail() )
       throw( ArgException("Couldn't read argument value from string '" +
                            val + "'", toString() ) );

    if ( valuesRead > 1 )
       throw( ArgException("More than one valid value parsed from string '" +
                            val + "'", toString() ) );


	_values.push_back(temp);

	_checkAllowed( val );

}

/**
 * Specialization to handle strings with spaces in them. This is needed
 * because there is no way to tell operator>> to ignore spaces.
 */
template<>
void MultiArg<string>::_extractValue( const string& val )
{
	_values.push_back( val );

	_checkAllowed( val );
}

/**
 * Checks to see if the value parsed is in the allowed list.
 */
template<class T>
void MultiArg<T>::_checkAllowed( const string& val )
{
	if ( _allowed.size() > 0 )
		if ( find(_allowed.begin(),_allowed.end(),_values.back()) 
						== _allowed.end() )
			throw( ArgException( "Couldn't find '" + val +
                                 "' in allowed list.", toString() ) );
}

/**
 *
 */
template<class T>
string MultiArg<T>::shortID(const string& val) const
{
	string id = Arg::shortID(_typeDesc) + " ... ";

	return id;
}

/**
 *
 */
template<class T>
string MultiArg<T>::longID(const string& val) const
{
	string id = Arg::longID(_typeDesc) + "  (accepted multiple times)";

	return id;
}

/**
 * Once we've matched the first value, then the arg is no longer
 * required.
 */
template<class T>
bool MultiArg<T>::isRequired() const
{
	if ( _required )
	{
		if ( _values.size() > 1 )
			return false;
		else
			return true;
	}
	else
		return false;

}

}

#endif