third_party/CityFlow/src/utility/optionparser.h

//-----------------------------------------------------------------------------
//  optionparser.h -- A Header-Only commandline argument parser
//  Author: Luke de Oliveira <lukedeo@ldo.io>
//  License: MIT
//-----------------------------------------------------------------------------

#ifndef OPTIONPARSER_H_
#define OPTIONPARSER_H_

#include <stdlib.h>
#include <algorithm>
#include <iomanip>
#include <iostream>
#include <map>
#include <stdexcept>
#include <string>
#include <unordered_set>
#include <vector>

const std::string ARGS_END = "- ";

namespace optionparser {

    enum StorageMode { STORE_TRUE, STORE_VALUE, STORE_MULT_VALUES };

    enum OptionType { LONG_OPT = 0, SHORT_OPT, POSITIONAL_OPT, EMPTY_OPT };

    struct DictionaryEntry {
        unsigned int pos;
        std::string name;
    };

    struct Option {
        Option() {}
        void help_doc() {
            std::string h = "    ";
            if (m_long_flag != "") {
                h += m_long_flag;
                if (m_short_flag != "") {
                    h += ", ";
                }
            }
            if (m_short_flag != "") {
                h += m_short_flag;
            }

            printf("%-25s%s\n", h.c_str(), m_help.c_str());
        }

        bool &found() { return m_found; }

        Option &required(bool req) {
            m_required = req;
            return *this;
        }
        bool &required() { return m_required; }

        std::string &short_flag() { return m_short_flag; }

        std::string &long_flag() { return m_long_flag; }
        std::string &pos_flag() { return m_pos_flag; }
        std::string m_short_flag = "", m_long_flag = "", m_pos_flag = "";

        StorageMode &mode() { return m_mode; }

        Option &mode(const StorageMode &mode) {
            m_mode = mode;
            return *this;
        }

        std::string &help() { return m_help; }

        Option &help(const std::string &help) {
            m_help = help;
            return *this;
        }

        std::string &dest() { return m_dest; }

        Option &dest(const std::string &dest) {
            m_dest = dest;
            return *this;
        }

        std::string &default_value() { return m_default_value; }

        Option &default_value(const std::string &default_value) {
            m_default_value = default_value;
            return *this;
        }

        Option &default_value(const char *default_value) {
            m_default_value = std::string(default_value);
            return *this;
        }

        template <typename T>
        Option &default_value(const T &default_value) {
            m_default_value = std::to_string(default_value);
            return *this;
        }

        bool m_found = false;
        bool m_required = false;
        StorageMode m_mode = STORE_TRUE;
        std::string m_help = "";
        std::string m_dest = "";
        std::string m_default_value = "";

        static OptionType get_type(std::string opt);
        static std::string get_destination(std::string opt1, std::string opt2,
                                           OptionType ft, OptionType st);
    };
//----------------------------------------------------------------------------
    std::string remove_character(std::string str, const char c) {
        // dummy way to remove -- and - from args
        auto pos = str.find("--");

        if (pos == 0) {
            str.erase(0, 2);
        }

        pos = str.find('-');
        if (pos == 0) {
            str.erase(0, 1);
        }

        return str;
    }

    typedef std::map<std::string, std::vector<std::string>> Archive;
    typedef std::map<std::string, DictionaryEntry> Dictionary;

    OptionType Option::get_type(std::string opt) {
        if (opt == "") {
            return OptionType::EMPTY_OPT;
        }

        if (opt[0] == '-') {
            if (opt.size() == 2) {
                return OptionType::SHORT_OPT;
            }

            else {
                return OptionType::LONG_OPT;
            }
        }
        return OptionType::POSITIONAL_OPT;
    }
    std::string Option::get_destination(std::string first_option,
                                        std::string second_option,
                                        OptionType first_opt_type,
                                        OptionType second_opt_type) {
        std::string dest;

        if (first_opt_type == OptionType::LONG_OPT) {
            dest = remove_character(first_option, '-');
        } else if (second_opt_type == OptionType::LONG_OPT) {
            dest = remove_character(second_option, '-');
        } else {
            if (first_opt_type == OptionType::SHORT_OPT) {
                dest = remove_character(first_option, '-') + "_option";
            } else if (second_opt_type == OptionType::SHORT_OPT) {
                dest = remove_character(second_option, '-') + "_option";
            } else {
                if (first_opt_type == OptionType::POSITIONAL_OPT) {
                    dest = first_option;
                } else if (second_opt_type == OptionType::POSITIONAL_OPT) {
                    dest = second_option;
                }
            }
        }

        return dest;
    }
//-----------------------------------------------------------------------------
//  OptionParser Class
//-----------------------------------------------------------------------------
    class OptionParser {
    public:
        OptionParser(std::string description = "", bool create_help = true)
                : m_options(0), m_description(description) {
            if (create_help) {
                add_option("--help", "-h").help("Display this help message and exit.");
            }
        }

        ~OptionParser() = default;

        void eat_arguments(unsigned int argc, char const *argv[]);

        Option &add_option(std::string first_option, std::string second_option = "");

        template <class T = bool>
        T get_value(std::string key);

        void help();

    private:
        Option &add_option_internal(std::string longoption, std::string shortoption);

        void error(const std::string &e);

        Archive m_values;
        std::vector<Option> m_options;
        std::string m_prog_name, m_description;

        std::map<std::string, unsigned int> idx;

        bool get_value_arg(std::vector<std::string> &arguments, unsigned int &arg,
                           Option &opt, std::string &flag);

        bool try_to_get_opt(std::vector<std::string> &arguments, unsigned int &arg,
                            Option &option, std::string &flag);

        void check_for_missing_args();
    };

    Option &OptionParser::add_option(std::string first_option,
                                     std::string second_option) {
        return add_option_internal(first_option, second_option);
    }

    Option &OptionParser::add_option_internal(std::string first_option,
                                              std::string second_option) {
        m_options.resize(m_options.size() + 1);
        Option &opt = m_options.back();
        OptionType first_option_type = Option::get_type(first_option);
        OptionType second_option_type = Option::get_type(second_option);

        opt.m_dest = Option::get_destination(first_option, second_option,
                                             first_option_type, second_option_type);

        if (first_option_type == OptionType::LONG_OPT) {
            opt.long_flag() = first_option;
        } else if (second_option_type == OptionType::LONG_OPT) {
            opt.long_flag() = second_option;
        }

        if (first_option_type == OptionType::SHORT_OPT) {
            opt.short_flag() = first_option;
        } else if (second_option_type == OptionType::SHORT_OPT) {
            opt.short_flag() = second_option;
        }
        if (first_option_type == OptionType::POSITIONAL_OPT) {
            opt.pos_flag() = first_option;
        } else if (second_option_type == OptionType::POSITIONAL_OPT) {
            opt.pos_flag() = second_option;
        }
        return opt;
    }

    std::vector<std::string> split_str(std::string s, std::string delimiter = " ") {
        size_t pos = 0;
        std::string token;
        std::vector<std::string> vals;
        while ((pos = s.find(delimiter)) != std::string::npos) {
            token = s.substr(0, pos);
            vals.push_back(token);
            s.erase(0, pos + delimiter.length());
        }
        vals.push_back(s);
        return vals;
    }

    bool OptionParser::get_value_arg(std::vector<std::string> &arguments,
                                     unsigned int &arg, Option &opt,
                                     std::string &flag) {
        std::string val = "";
        m_values[opt.dest()].clear();
        if (arguments[arg].size() > flag.size()) {
            auto search_pt = arguments[arg].find_first_of('=');

            if (search_pt == std::string::npos) {
                search_pt = arguments[arg].find_first_of(' ');

                if (search_pt == std::string::npos) {
                    error("Error, long options (" + flag +
                          ") require a '=' or space before a value.");
                    return false;
                }
                auto vals = split_str(arguments[arg].substr(search_pt + 1));
                for (auto v : vals) m_values[opt.dest()].push_back(v);
            }
        }

        else {
            if (arg + 1 >= arguments.size()) {
                if (opt.default_value() == "") {
                    error("error, flag '" + flag + "' requires an argument.");
                    return false;
                }
                if (m_values[opt.dest()].size() == 0) {
                    val = opt.default_value();
                }
            } else {
                if (arguments[arg + 1][0] == '-') {
                    if (opt.default_value() == "") {
                        error("error, flag '" + flag + "' requires an argument.");
                        return false;
                    }
                    if (m_values[opt.dest()].size() == 0) {
                        val = opt.default_value();
                    }
                }
            }
        }

        if (val != "") {
            m_values[opt.dest()].push_back(val);
            return true;
        }

        while (arguments[arg + 1][0] != '-') {
            arg++;
            m_values[opt.dest()].push_back(arguments[arg]);
            if (arg + 1 >= arguments.size()) {
                break;
            }
        }

        return true;
    }

    bool OptionParser::try_to_get_opt(std::vector<std::string> &arguments,
                                      unsigned int &arg, Option &option,
                                      std::string &flag) {
        if (flag == "") {
            return false;
        }

        if (arguments[arg].find(flag) != 0) {
            return false;
        }

        if (option.mode() == STORE_TRUE) {
            option.found() = true;
            return true;
        }

        if (((option.mode() == STORE_VALUE) ||
             (option.mode() == STORE_MULT_VALUES)) &&
            (option.found() == false)) {
            if (get_value_arg(arguments, arg, option, flag)) {
                option.found() = true;
                return true;
            }
        }

        return false;
    }

    void OptionParser::check_for_missing_args() {
        std::vector<std::string> missing;
        for (auto &opt : m_options) {
            if ((opt.required()) && (!opt.found())) {
                missing.push_back(opt.dest());
            } else if ((opt.default_value() != "") && (!opt.found())) {
                m_values[opt.dest()].push_back(opt.default_value());
                opt.found() = true;
            }
        }
        if (missing.size() > 0) {
            std::string e = "Missing required flags: " + missing.at(0);
            for (unsigned int i = 1; i < missing.size(); ++i) {
                e += ", " + missing.at(i);
            }
            error(e + ".");
        }
    }

    void OptionParser::eat_arguments(unsigned int argc, char const *argv[]) {
        unsigned int idx_ctr = 0;
        for (auto &opt : m_options) {
            idx[opt.m_dest] = idx_ctr;
            idx_ctr++;
        }

        m_prog_name = argv[0];
        std::vector<std::string> arguments;
        for (unsigned int i = 1; i < argc; ++i) {
            arguments.push_back(argv[i]);
        }
        arguments.push_back(ARGS_END);  // dummy way to solve problem with last arg of
        // type "arg val1 val2"

        // for each argument cluster
        for (unsigned int arg = 0; arg < arguments.size(); ++arg) {
            bool match_found = false;
            // for each option sets
            for (auto &option : m_options) {
                match_found = try_to_get_opt(arguments, arg, option, option.long_flag());
                if (match_found) {
                    break;
                }

                match_found = try_to_get_opt(arguments, arg, option, option.short_flag());
                if (match_found) {
                    break;
                }

                match_found = try_to_get_opt(arguments, arg, option, option.pos_flag());
                if (match_found) {
                    break;
                }
            }

            if (!match_found) {
                if (arguments[arg] != ARGS_END) {
                    error("Unrecognized flag/option '" + arguments[arg] + "'");
                }
            }
        }

        if (get_value("help")) {
            help();
        }
        check_for_missing_args();
    }
//----------------------------------------------------------------------------
    void OptionParser::error(const std::string &e) {
        std::cerr << "In excecutable \'";
        std::cerr << m_prog_name << "\':\n" << e << std::endl;
        exit(1);
    }

    void OptionParser::help() {
        auto split = m_prog_name.find_last_of('/');
        std::string stripped_name = m_prog_name.substr(split + 1);
        std::cout << "usage: " << stripped_name << " [-h] ";
        for (auto &option : m_options) {
            if (option.required()) {
                if (option.short_flag() != "") {
                    std::cout << option.short_flag();
                } else {
                    std::cout << option.long_flag();
                }

                if (option.mode() == STORE_VALUE) {
                    std::cout << " ARG ";
                }
                if (option.mode() == STORE_MULT_VALUES) {
                    std::cout << " ARG1 [ARG2 ...] ";
                }
            }
        }
        std::cout << "[options]\n";

        if (m_description != "") {
            std::cout << "\n" << m_description << "\n" << std::endl;
        }
        for (auto &option : m_options) {
            option.help_doc();
        }
        exit(0);
    }

//----------------------------------------------------------------------------
    template <class T>
    T OptionParser::get_value(std::string key) {
        try {
            return m_options[idx.at(key)].found();
        } catch (std::out_of_range &err) {
            std::string e("Tried to access value for field '");
            e += key;
            e += "' which is not a valid field.";
            throw std::out_of_range(e);
        }
    }
//----------------------------------------------------------------------------
    template <>
    std::string OptionParser::get_value<std::string>(std::string key) {
        try {
            return m_values[key][0];
        } catch (std::out_of_range &err) {
            std::string e("Tried to access value for field '");
            e += key;
            e += "' which is not a valid field.";
            throw std::out_of_range(e);
        }
    }
//----------------------------------------------------------------------------
    template <>
    double OptionParser::get_value<double>(std::string key) {
        try {
            return std::stod(m_values[key][0]);
        } catch (std::out_of_range &err) {
            std::string e("Tried to access value for field '");
            e += key;
            e += "' which is not a valid field.";
            throw std::out_of_range(e);
        }
    }
//----------------------------------------------------------------------------
    template <>
    float OptionParser::get_value<float>(std::string key) {
        try {
            return std::stof(m_values[key][0]);
        } catch (std::out_of_range &err) {
            std::string e("Tried to access value for field '");
            e += key;
            e += "' which is not a valid field.";
            throw std::out_of_range(e);
        }
    }
//----------------------------------------------------------------------------
    template <>
    int OptionParser::get_value<int>(std::string key) {
        try {
            return std::stoi(m_values[key][0]);
        } catch (std::out_of_range &err) {
            std::string e("Tried to access value for field '");
            e += key;
            e += "' which is not a valid field.";
            throw std::out_of_range(e);
        }
    }
//----------------------------------------------------------------------------
    template <>
    unsigned int OptionParser::get_value<unsigned int>(std::string key) {
        try {
            return std::stoul(m_values[key][0]);
        } catch (std::out_of_range &err) {
            std::string e("Tried to access value for field '");
            e += key;
            e += "' which is not a valid field.";
            throw std::out_of_range(e);
        }
    }
//----------------------------------------------------------------------------
    template <>
    std::vector<std::string> OptionParser::get_value<std::vector<std::string>>(
            std::string key) {
        try {
            return m_values[key];
        } catch (std::out_of_range &err) {
            std::string e("Tried to access value for field '");
            e += key;
            e += "' which is not a valid field.";
            throw std::out_of_range(e);
        }
    }
//----------------------------------------------------------------------------
    template <>
    std::vector<int> OptionParser::get_value<std::vector<int>>(std::string key) {
        try {
            std::vector<int> v;
            for (auto &entry : m_values[key]) {
                v.push_back(std::stoi(entry));
            }
            return v;
        } catch (std::out_of_range &err) {
            std::string e("Tried to access value for field '");
            e += key;
            e += "' which is not a valid field.";
            throw std::out_of_range(e);
        }
    }

}  // namespace optionparser

#endif