MultiArg.h

Go to the documentation of this file.

// -*- Mode: c++; c-basic-offset: 4; tab-width: 4; -*-
 
/******************************************************************************
 *
 *  file:  MultiArg.h
 *
 *  Copyright (c) 2003, Michael E. Smoot .
 *  Copyright (c) 2004, Michael E. Smoot, Daniel Aarno.
 *  Copyright (c) 2017, Google LLC
 *  All rights reserved.
 *
 *  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_MULTI_ARG_H
#define TCLAP_MULTI_ARG_H
 
#include <tclap/Arg.h>
#include <tclap/Constraint.h>
 
#include <string>
#include <vector>
 
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;
 
    const 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,
             ArgContainer &parser, Visitor *v = NULL);
 
    MultiArg(const std::string &flag, const std::string &name,
             const std::string &desc, bool req, const Constraint<T> *constraint,
             Visitor *v = NULL);
 
    MultiArg(const std::string &flag, const std::string &name,
             const std::string &desc, bool req, const Constraint<T> *constraint,
             ArgContainer &parser, Visitor *v = NULL);
 
    virtual bool processArg(int *i, std::vector<std::string> &args);
 
    const std::vector<T> &getValue() const { return _values; }
 
    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 allowMore();
 
    virtual void reset();
 
private:
    void _extractNextValue(int *index, std::vector<std::string> &args);
 
    MultiArg(const MultiArg<T>& rhs);
    MultiArg& 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, ArgContainer &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,
                      const Constraint<T> *constraint, Visitor *v)
    : Arg(flag, name, desc, req, true, v),
      _values(std::vector<T>()),
      _typeDesc(Constraint<T>::shortID(constraint)),
      _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,
                      const Constraint<T> *constraint, ArgContainer &parser,
                      Visitor *v)
    : Arg(flag, name, desc, req, true, v),
      _values(std::vector<T>()),
      _typeDesc(Constraint<T>::shortID(constraint)),
      _constraint(constraint),
      _allowMore(false) {
    parser.add(this);
    _acceptsMultipleValues = true;
}
 
template <class T>
bool MultiArg<T>::processArg(int *i, std::vector<std::string> &args) {
    if (_hasBlanks(args[*i])) return false;
 
    std::string flag = args[*i];
    std::string value = "";
 
    trimFlag(flag, value);
    const bool hasAttachedValue = flag != args[*i];
 
    if (!argMatches(flag)) return false;
 
    if (this->getDelimiter() != ' ' && !hasAttachedValue)
        throw(ArgParseException(
            "Couldn't find delimiter for this argument!", toString()));
 
    if (!hasAttachedValue) {
        _extractNextValue(i, args);
    } else {
        _extractValue(value);
    }
 
    _alreadySet = true;
    _setBy = flag;
    _checkWithVisitor();
 
    return true;
}
 
template <class T>
void MultiArg<T>::_extractNextValue(int *index,
                                     std::vector<std::string> &args) {
    (*index)++;
    if (static_cast<unsigned int>(*index) < args.size())
        _extractValue(args[*index]);
    else
        throw(ArgParseException("Missing a value for this argument!",
                                toString()));
}
 
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>
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 && !_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  // TCLAP_MULTI_ARG_H