argumentparser.cpp

Go to the documentation of this file.

#include "argumentparser.h"
#include "failure.h"
#include "../conversion/stringconversion.h"

#include <algorithm>
#include <vector>
#include <iostream>
#include <sstream>
#include <stdexcept>

using namespace std;

namespace ApplicationUtilities {

Argument::Argument(const std::string &name, const std::string abbreviation, const std::string &description) :
    m_required(false),
    m_combinable(false),
    m_requiredValueCount(0),
    m_present(false),
    m_isMainArg(false)
{
    setName(name);
    setAbbreviation(abbreviation);
    setDescription(description);
}

Argument::Argument(const char *name, const char *abbreviation, const char *description) :
    m_required(false),
    m_combinable(false),
    m_requiredValueCount(0),
    m_present(false),
    m_isMainArg(false)
{
    setName(name);
    setAbbreviation(abbreviation);
    setDescription(description);
}

Argument::~Argument()
{}

void Argument::printInfo(ostream &os) const
{
    if(!name().empty())
        os << "--" << name();
    if(!name().empty() && !abbreviation().empty())
        os << ", ";
    if(!abbreviation().empty())
        os << "-" << abbreviation();
    if(requiredValueCount() > 0) {
        int valueNamesPrint = 0;
        for(auto i = valueNames().cbegin(), end = valueNames().cend(); i != end && valueNamesPrint < requiredValueCount(); ++i) {
            os << " [" << *i << "]";
            ++valueNamesPrint;
        }
        for(; valueNamesPrint < requiredValueCount(); ++valueNamesPrint) {
            os << " [value " << (valueNamesPrint + 1) << "]";
        }
    } else if(requiredValueCount() < 0) {
        for(auto i = valueNames().cbegin(), end = valueNames().cend(); i != end; ++i) {
            os << " [" << *i << "]";
        }
        os << " ...";
    }

    if(!description().empty()) {
    os << endl << description();
    }
    if(isRequired()) {
        os << endl << "This argument is required.";
    }
    os << endl << endl;
}

Argument *firstPresentUncombinableArg(const ArgumentVector &args, const Argument *except)
{
    for(Argument *arg : args) {
        if(arg != except && arg->isPresent() && !arg->isCombinable()) {
            return arg;
        }
    }
    return nullptr;
}

void Argument::setSecondaryArguments(const ArgumentInitializerList &secondaryArguments)
{
    // remove this argument from the parents list of the previous secondary arguments
    for(Argument *arg : m_secondaryArgs) {
        m_parents.erase(remove(arg->m_parents.begin(), arg->m_parents.end(), this), m_parents.end());
    }
    // assign secondary arguments
    m_secondaryArgs.assign(secondaryArguments);
    // add this argument to the parents list of the assigned secondary arguments
    // and set the parser
    for(Argument *arg : m_secondaryArgs) {
        if(find(arg->m_parents.cbegin(), arg->m_parents.cend(), this) == arg->m_parents.cend()) {
            arg->m_parents.push_back(this);
        }
    }
}

string Argument::parentNames() const
{
    string res;
    if(m_parents.size()) {
        vector<string> names;
        names.reserve(m_parents.size());
        for(const Argument *parent : m_parents) {
            names.push_back(parent->name());
        }
        res.assign(ConversionUtilities::concateStrings(names, ", "));
    }
    return res;
}

bool Argument::isParentPresent() const
{
    for(Argument *parent : m_parents) {
        if(parent->isPresent()) {
            return true;
        }
    }
    return false;
}

Argument *Argument::conflictsWithArgument() const
{
    if(!isCombinable() && isPresent()) {
        for(Argument *parent : m_parents) {
            for(Argument *sibling : parent->secondaryArguments()) {
                if(sibling != this && sibling->isPresent() && !sibling->isCombinable()) {
                    return sibling;
                }
            }
        }
    }
    return nullptr;
}

ArgumentParser::ArgumentParser() :
    m_actualArgc(0),
    m_ignoreUnknownArgs(true)
{}

void ArgumentParser::setMainArguments(const ArgumentInitializerList &mainArguments)
{
    for(Argument *arg : mainArguments) {
        arg->m_isMainArg = true;
    }
    m_mainArgs.assign(mainArguments);
}

void ArgumentParser::printHelp(ostream &os) const
{
    if(!m_mainArgs.size())
        return;
    os << "Available parameters:\n\n";
    for(const Argument *arg : m_mainArgs) {
        arg->printInfo(os);
    }
}

Argument *ArgumentParser::findArg(const ArgumentPredicate &predicate) const
{
    return findArg(m_mainArgs, predicate);
}

Argument *ArgumentParser::findArg(const ArgumentVector &arguments, const ArgumentPredicate &predicate) const
{
    for(Argument *arg : arguments) {
        if(predicate(arg)) {
            return arg; // argument matches
        } else if(Argument *subarg = findArg(arg->secondaryArguments(), predicate)) {
            return subarg; // a secondary argument matches
        }
    }
    return nullptr; // no argument matches
}

void ArgumentParser::verifySetup() const
{
    vector<Argument *> verifiedArgs;
    vector<string> abbreviations;
    vector<string> names;
    function<void (const ArgumentVector &args)> checkArguments;
    checkArguments = [&verifiedArgs, &abbreviations, &names, &checkArguments] (const ArgumentVector &args) {
        for(Argument *arg : args) {
            if(find(verifiedArgs.cbegin(), verifiedArgs.cend(), arg) != verifiedArgs.cend())
                continue; // do not verify the same argument twice
            if(arg->isMainArgument() && arg->parents().size())
                throw invalid_argument("Argument \"" + arg->name() + "\" can not be used as main argument and sub argument at the same time.");
            if(!arg->abbreviation().empty() && find(abbreviations.cbegin(), abbreviations.cend(), arg->abbreviation()) != abbreviations.cend())
                throw invalid_argument("Abbreviation \"" + arg->abbreviation() + "\" has been used more then once.");
            if(find(names.cbegin(), names.cend(), arg->name()) != names.cend())
                throw invalid_argument("Name \"" + arg->name() + "\" has been used more then once.");
            abbreviations.push_back(arg->abbreviation());
            names.push_back(arg->name());
            verifiedArgs.push_back(arg);
        }
    };
    checkArguments(m_mainArgs);
}

void ArgumentParser::parseArgs(int argc, char *argv[])
{
    // initiate parser
    verifySetup();
    m_actualArgc = 0; // reset actual agument count
    unsigned int actualArgc = 0;
    int valuesToRead = 0;
    // read current directory
    if(argc >= 1) {
        m_currentDirectory = string(*argv);
    } else {
        m_currentDirectory.clear();
    }
    // parse given arguments
    if(argc >= 2) {
        Argument *currentArg = nullptr;
        // iterate through given arguments
        for(char **i = argv + 1, ** end = argv + argc; i != end; ++i) {
            string givenArg(*i); // convert argument to string
            if(!givenArg.empty()) { // skip empty entries
                if(valuesToRead <= 0 && givenArg.size() > 1 && givenArg.at(0) == '-') {
                    // we have no values left to read and the given arguments starts with '-'
                    // -> the next "value" is a main argument or a sub argument
                    ArgumentPredicate pred;
                    size_t equationPos = givenArg.find('=');
                    if(givenArg.size() > 2 && givenArg.at(1) == '-') {
                        // the argument starts with '--'
                        // -> the full argument name has been provided
                        pred = [&givenArg, equationPos] (Argument *arg) {
                            return arg->name() == givenArg.substr(2, equationPos);
                        };
                    } else {
                        // the argument starts with a single '-'
                        // -> the abbreviation has been provided
                        pred = [&givenArg, equationPos] (Argument *arg) {
                            return arg->abbreviation() == givenArg.substr(1, equationPos);
                        };
                    }

                    // find the corresponding instande of the Argument class
                    currentArg = findArg(pred);

                    if(currentArg) {
                        // the corresponding instance of Argument class has been found
                        if(currentArg->m_present) {
                            // the argument has been provided more then once
                            throw Failure("The argument \"" + currentArg->name() + "\" has been given more then one time.");
                        } else {
                            // set present flag of argument
                            currentArg->m_present = true;
                            ++actualArgc; // we actually found an argument
                            // now we might need to read values tied to that argument
                            valuesToRead = currentArg->requiredValueCount();
                            if(equationPos != string::npos) {
                                // a value has been specified using the --argument=value syntax
                                string value = givenArg.substr(equationPos + 1);
                                if(valuesToRead != 0) {
                                    currentArg->m_values.push_back(value);
                                    if(valuesToRead > 0) {
                                        --valuesToRead;
                                    }
                                } else {
                                    throw Failure("Invalid extra information \"" + value + "\" (specified using \"--argument=value\" syntax) for the argument \"" + currentArg->name() + "\" given.");
                                }
                            }
                        }
                    } else {
                        // the given argument seems to be unknown
                        if(valuesToRead < 0) {
                            // we have a variable number of values to expect -> treat "unknown argument" as value
                            goto readValue;
                        } else {
                            // we have no more values to expect so we need to complain about the unknown argument
                            goto invalidArg;
                        }
                    }
                } else if(currentArg) {
                    readValue:
                    // check if the given value is tied to the most recently parsed argument
                    if(valuesToRead == 0) {
                        throw Failure("Invalid extra information \"" + givenArg + "\" for the argument \"" + currentArg->name() + "\" given.");
                    } else if(valuesToRead < 0) {
                        currentArg->m_values.push_back(givenArg);
                    } else {
                        currentArg->m_values.push_back(givenArg);
                        --valuesToRead; // one value less to be read
                    }
                } else {
                    // we have not parsed an argument before -> the "value" has to be an argument
                    // but does not start with '-' or '--'
                    invalidArg:
                    string msg("The given argument \"" + givenArg + "\" is unknown.");
                    if(m_ignoreUnknownArgs) {
                        cout << msg << " It will be ignored." << endl;
                    } else {
                        throw Failure(msg);
                    }
                }
            }
        }
    }
    // function for iterating through all arguments
    function<void(Argument *, const ArgumentVector &, const function<void (Argument *, Argument *)> &)> foreachArg;
    foreachArg = [&foreachArg] (Argument *parent, const ArgumentVector &args, const function<void (Argument *, Argument *)> &proc) {
        for(Argument *arg : args) {
            proc(parent, arg);
            foreachArg(arg, arg->secondaryArguments(), proc);
        }
    };
    // iterate actually through all arguments using previously defined function to check gathered arguments
    foreachArg(nullptr, m_mainArgs, [this] (Argument *parent, Argument *arg) {
        if(arg->isPresent()) {
            if(!arg->isMainArgument() && arg->parents().size() && !arg->isParentPresent()) {
                if(arg->parents().size() > 1) {
                    throw Failure("The argument \"" + arg->name() + "\" needs to be used together with one the following arguments: " + arg->parentNames());
                } else {
                    throw Failure("The argument \"" + arg->name() + "\" needs to be used together with the argument \"" + arg->parents().at(0)->name() + "\".");
                }
            }
            Argument *conflictingArgument = nullptr;
            if(arg->isMainArgument()) {
                conflictingArgument = firstPresentUncombinableArg(m_mainArgs, arg);
            } else {
                conflictingArgument = arg->conflictsWithArgument();
            }
            if(conflictingArgument) {
                throw Failure("The argument \"" + conflictingArgument->name() + "\" can not be combined with \"" + arg->name() + "\".");
            }
            if(!arg->allRequiredValuesPresent()) {
                stringstream ss(stringstream::in | stringstream::out);
                ss << "Not all required information for the given argument \"" << arg->name() << "\" provided. You have to give the following information:";
                int valueNamesPrint = 0;
                for(auto i = arg->m_valueNames.cbegin(), end = arg->m_valueNames.cend(); i != end; ++i) {
                    ss << "\n" << *i;
                    ++valueNamesPrint;
                }
                for(; valueNamesPrint < arg->m_requiredValueCount; ++valueNamesPrint) {
                    ss << "\nvalue " << (valueNamesPrint + 1);
                }
                throw Failure(ss.str());
            }
        } else if(arg->isRequired() && (arg->isMainArgument() || (parent && parent->isPresent()))) {
            throw Failure("The argument \"" + arg->name() + "\" is required but not given.");
        }
    });
    // set actual argument count
    m_actualArgc = actualArgc;
    // interate through all arguments again to invoke callback functions
    foreachArg(nullptr, m_mainArgs, [] (Argument *, Argument *arg) {
        if(arg->isPresent() && arg->m_callbackFunction) {
            arg->m_callbackFunction(arg->values());
        }
    });
}

}