ValueArg.h

Go to the documentation of this file.

// -*- Mode: c++; c-basic-offset: 4; tab-width: 4; -*-

/******************************************************************************
 *
 *  file:  ValueArg.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_VALUE_ARG_H
#define TCLAP_VALUE_ARG_H

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

#include <string>
#include <vector>

namespace TCLAP {

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

    T _default;

    std::string _typeDesc;

    Constraint<T> *_constraint;

    void _extractValue(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, ArgContainer &parser,
             Visitor *v = NULL);

    ValueArg(const std::string &flag, const std::string &name,
             const std::string &desc, bool req, T value,
             Constraint<T> *constraint, ArgContainer &parser,
             Visitor *v = NULL);

    ValueArg(const std::string &flag, const std::string &name,
             const std::string &desc, bool req, T value,
             Constraint<T> *constraint, Visitor *v = NULL);

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

    const T &getValue() const { return _value; }

    operator const T &() const { return getValue(); }

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

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

    virtual void reset();

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

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),
      _default(val),
      _typeDesc(typeDesc),
      _constraint(NULL) {}

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, ArgContainer &parser,
                      Visitor *v)
    : Arg(flag, name, desc, req, true, v),
      _value(val),
      _default(val),
      _typeDesc(typeDesc),
      _constraint(NULL) {
    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,
                      Constraint<T> *constraint, Visitor *v)
    : Arg(flag, name, desc, req, true, v),
      _value(val),
      _default(val),
      _typeDesc(Constraint<T>::shortID(constraint)),
      _constraint(constraint) {}

template <class T>
ValueArg<T>::ValueArg(const std::string &flag, const std::string &name,
                      const std::string &desc, bool req, T val,
                      Constraint<T> *constraint, ArgContainer &parser,
                      Visitor *v)
    : Arg(flag, name, desc, req, true, v),
      _value(val),
      _default(val),
      _typeDesc(Constraint<T>::shortID(constraint)),
      _constraint(constraint) {
    parser.add(this);
}

template <class T>
bool ValueArg<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);

    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 (static_cast<unsigned int>(*i) < args.size())
                _extractValue(args[*i]);
            else
                throw(ArgParseException("Missing a value for this argument!",
                                        toString()));
        } else {
            _extractValue(value);
        }

        _alreadySet = true;
        _setBy = flag;
        _checkWithVisitor();
        return true;
    } else {
        return false;
    }
}

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

template <class T>
std::string ValueArg<T>::longID(const std::string &) const {
    return Arg::longID("<" + _typeDesc + ">");
}

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

    if (_constraint != NULL)
        if (!_constraint->check(_value))
            throw(CmdLineParseException("Value '" + val +
                                            +"' does not meet constraint: " +
                                            _constraint->description(),
                                        toString()));
}

template <class T>
void ValueArg<T>::reset() {
    Arg::reset();
    _value = _default;
}

}  // namespace TCLAP

#endif  // TCLAP_VALUE_ARG_H