CLI.hpp 21.7 KB
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751
#pragma once

#include <string>
#include <regex>
#include <iostream>
#include <functional>
#include <tuple>
#include <exception>
#include <algorithm>
#include <sstream>
#include <type_traits>
#include <unordered_set>
#include <iomanip>
#include <numeric>

// This is unreachable outside this file; you should not use Combiner directly
namespace {

void logit(std::string) {
    //std::cout << "\033[1;31m" << output << "\033[0m" << std::endl;
}

template <typename T>
std::string join(const T& v, std::string delim = ",") {
    std::ostringstream s;
    for (const auto& i : v) {
        if (&i != &v[0]) {
            s << delim;
        }
        s << i;
    }
    return s.str();
}


struct Combiner {
    int num;
    bool positional;
    bool required;
    bool defaulted;

    /// Can be or-ed together
    Combiner operator | (Combiner b) const {
        Combiner self;
        self.num = std::min(num, b.num) == -1 ? -1 : std::max(num, b.num);
        self.positional = positional || b.positional;
        self.required = required || b.required;
        self.defaulted = defaulted || b.defaulted;
        return self;
    }

    /// Call to give the number of arguments expected on cli
    Combiner operator() (int n) const {
        return Combiner{n, positional, required, defaulted};
    }
    Combiner operator, (Combiner b) const {
        return *this | b;
    }
};
}


namespace CLI {

struct Error : public std::runtime_error {
    Error(std::string parent, std::string name) : runtime_error(parent + ": " + name) {}
};

struct BadNameString : public Error {
    BadNameString(std::string name) : Error("BadNameString", name) {}
};

struct CallForHelp : public Error {
    CallForHelp() : Error("CallForHelp","") {}
};

struct ParseError : public Error {
    ParseError(std::string name) : Error("ParseError", name) {}
};

struct OptionAlreadyAdded : public Error {
    OptionAlreadyAdded(std::string name) : Error("OptionAlreadyAdded", name) {}
};

struct OptionNotFound : public Error {
    OptionNotFound(std::string name) : Error("OptionNotFound", name) {}
};

struct RequiredError : public Error {
    RequiredError(std::string name) : Error("RequiredError", name) {}
};

struct ExtraPositionalsError : public Error {
    ExtraPositionalsError(std::string name) : Error("ExtraPositionalsError", name) {}
};

struct HorribleError : public Error {
    HorribleError(std::string name) : Error("HorribleError", "(You should never see this error) " + name) {}
};
struct IncorrectConstruction : public Error {
    IncorrectConstruction(std::string name) : Error("IncorrectConstruction", name) {}
};

const std::regex reg_split{R"regex((?:([a-zA-Z0-9]?)(?:,|$)|^)([a-zA-Z0-9][a-zA-Z0-9_\-]*)?)regex"};
const std::regex reg_short{R"regex(-([^-])(.*))regex"};
const std::regex reg_long{R"regex(--([^-^=][^=]*)=?(.*))regex"};


std::tuple<std::string, std::string> split(std::string fullname) {

    std::smatch match;
    if (std::regex_match(fullname, match, reg_split)) {
        std::string sname = match[1];
        std::string lname = match[2];
        if(sname == "" and lname == "")
            throw BadNameString("EMPTY");
        return std::tuple<std::string, std::string>(sname, lname);
    } else throw BadNameString(fullname);
}

const Combiner NOTHING   {0, false,false,false};
const Combiner REQUIRED  {1, false,true, false};
const Combiner DEFAULT   {1, false,false,true};
const Combiner POSITIONAL{1, true, false,false};
const Combiner ARGS      {1, false,false,false};
const Combiner UNLIMITED {-1,false,false,false};

typedef std::vector<std::vector<std::string>> results_t;
typedef std::function<bool(results_t)> callback_t;

class Option {
public:
protected:
    // Config
    std::string sname;
    std::string lname;
    Combiner opts;
    std::string discription;
    callback_t callback;

    // Results
    results_t results {};


public:
    Option(std::string name, std::string discription = "", Combiner opts=NOTHING, std::function<bool(results_t)> callback=[](results_t){return true;}) :
      opts(opts), discription(discription), callback(callback){
        std::tie(sname, lname) = split(name);
    }

    void clear() {
        results.clear();
    }

    bool required() const {
        return opts.required;
    }

    int expected() const {
        return opts.num;
    }

    bool positional() const {
        return opts.positional;
    }

    bool defaulted() const {
        return opts.defaulted;
    }

    /// Process the callback
    bool run_callback() const {
        return callback(results);
    }

    /// Indistinguishible options are equal
    bool operator== (const Option& other) const {
        if(sname=="" && other.sname=="") 
            return lname==other.lname;
        else if(lname=="" && other.lname=="")
            return sname==other.sname;
        else
            return sname==other.sname || lname==other.lname;
    }

    std::string get_name() const {
        if(sname=="")
            return "--" + lname;
        else if (lname=="")
            return "-" + sname;
        else
            return "-" + sname + ", --" + lname;
    }

    bool check_name(const std::string& name) const {
        return name == sname || name == lname || name == sname + "," + lname;
    }

    bool check_sname(const std::string& name) const {
        return name == sname;
    }

    bool check_lname(const std::string& name) const {
        return name == lname;
    }

    std::string get_sname() const {
        return sname;
    }

    std::string get_lname() const {
        return lname;
    }

    void add_result(int r, std::string s) {
        logit("Adding result: " + s);
        results.at(r).push_back(s);
    }
    int get_new() {
        results.emplace_back();
        return results.size() - 1;
    }
    int count() const {
        int out = 0;
        for(const std::vector<std::string>& v : results)
            out += v.size();
        return out;
    }

    std::string string() const {
        std::string val = "Option: " + get_name() + "\n"
             + "  " + discription + "\n"
             + "  [";
        for(const auto& item : results) {
            if(&item!=&results[0])
                val+="],[";
            val += join(item);
        }
        val += "]";
        return val;
    }

    int help_len() const {
        return std::min((int) get_name().length(), 40);
    }

    std::string help(int len = 0) const {
        std::stringstream out;
        out << std::setw(len) << std::left << get_name() << discription;
        return out.str();
    }

};


template<typename T>
typename std::enable_if<std::is_integral<T>::value, bool>::type
lexical_cast(std::string input, T& output) {
    logit("Int lexical cast " + input);
    try{
        output = (T) std::stoll(input);
        return true;
    } catch (std::invalid_argument) {
        return false;
    } catch (std::out_of_range) {
        return false;
    }
}
    
template<typename T>
typename std::enable_if<std::is_floating_point<T>::value, bool>::type
lexical_cast(std::string input, T& output) {
    logit("Floating lexical cast " + input);
    try{
        output = (T) std::stold(input);
        return true;
    } catch (std::invalid_argument) {
        return false;
    } catch (std::out_of_range) {
        return false;
    }
}

// String and similar
template<typename T>
typename std::enable_if<
  !std::is_floating_point<T>::value
  && !std::is_integral<T>::value, bool>::type
lexical_cast(std::string input, T& output) {
    logit("Direct lexical cast: " + input);
    output = input;
    return true;
}

enum class Classifer {NONE, POSITIONAL_MARK, SHORT, LONG, SUBCOMMAND};

class App;

/// Creates a command line program, with very few defaults.
/** To use, create a new Program() instance with argc, argv, and a help discription. The templated
*  add_option methods make it easy to prepare options. Remember to call `.start` before starting your
* program, so that the options can be evaluated and the help option doesn't accidentally run your program. */
class App {
protected:
    
    std::string name;
    std::string prog_discription;
    std::vector<Option> options;
    std::vector<std::string> missing_options;
    std::vector<std::string> positionals;
    std::vector<App*> subcommands;
    bool parsed{false};
    App* subcommand = nullptr;

public:


    /// Reset the parsed data
    void reset() {

        parsed = false;
        subcommand = nullptr;

        for(Option& opt : options) {
            opt.clear();
        }
        for(App* app : subcommands) {
            app->reset();
        }
    }
    
    /// Create a new program. Pass in the same arguments as main(), along with a help string.
    App(std::string prog_discription="")
        : prog_discription(prog_discription) {

            add_flag("h,help", "Print this help message and exit");

    }

    ~App() {
        for(App* app : subcommands)
            delete app;
    }

    App* add_subcommand(std::string name, std::string discription="") {
        subcommands.push_back(new App(discription));
        subcommands.back()->name = name;
        logit(subcommands.back()->name);
        return subcommands.back();
    }
    /// Add an option, will automatically understand the type for common types.
    /** To use, create a variable with the expected type, and pass it in after the name.
     * After start is called, you can use count to see if the value was passed, and
     * the value will be initialized properly. 
     *
     * Program::REQUIRED, Program::DEFAULT, and Program::POSITIONAL are options, and can be `|`
     * together. The positional options take an optional number of arguments.
     *
     * For example,
     *
     *     std::string filename
     *     program.add_option("filename", filename, "discription of filename");
     */
    void add_option(
            std::string name,           ///< The name, long,short
            callback_t callback,        ///< The callback
            std::string discription="", ///< Discription string
            Combiner opts=ARGS          ///< The options (REQUIRED, DEFAULT, POSITIONAL, ARGS())
            ) {
        Option myopt{name, discription, opts, callback};
        if(std::find(std::begin(options), std::end(options), myopt) == std::end(options))
            options.push_back(myopt);
        else
            throw OptionAlreadyAdded(myopt.get_name());

    }

    /// Add option for string
    template<typename T>
    typename std::enable_if<!std::is_array<T>::value, void>::type
    add_option(
            std::string name,           ///< The name, long,short
            T &variable,                ///< The variable to set
            std::string discription="", ///< Discription string
            Combiner opts=ARGS          ///< The options (REQUIRED, DEFAULT, POSITIONAL, ARGS())
            ) {

        
        if(opts.num!=1)
            throw IncorrectConstruction("Must have ARGS(1) or be a vector.");
        CLI::callback_t fun = [&variable](CLI::results_t res){
            if(res.size()!=1) {
                return false;
            }
            if(res[0].size()!=1) {
                return false;
            }
            return lexical_cast(res[0][0], variable);
        };

        add_option(name, fun, discription, opts);
    }

    /// Add option for vector of results
    template<typename T>
    void add_option(
            std::string name,           ///< The name, long,short
            std::vector<T> &variable,   ///< The variable to set
            std::string discription="", ///< Discription string
            Combiner opts=ARGS          ///< The options (REQUIRED, DEFAULT, POSITIONAL, ARGS())
            ) {

        if(opts.num==0)
            throw IncorrectConstruction("Must have ARGS(1) or be a vector.");
        CLI::callback_t fun = [&variable](CLI::results_t res){
            bool retval = true;
            int count = 0;
            variable.clear();
            for(const auto &a : res)
                for(const auto &b : a) {
                    variable.emplace_back();
                    retval &= lexical_cast(b, variable.back());
                }
            return count != 0 && retval;
        };

        add_option(name, fun, discription, opts);
    }


    /// Add option for flag
    void add_flag(
            std::string name,           ///< The name, short,long
            std::string discription=""  ///< Discription string
            ) {
        CLI::callback_t fun = [](CLI::results_t){
            return true;
        };
        
        add_option(name, fun, discription, NOTHING);
    }

    /// Add option for flag
    template<typename T>
    typename std::enable_if<std::is_integral<T>::value, void>::type
    add_flag(
            std::string name,           ///< The name, short,long
                    T  &count,              ///< A varaible holding the count
            std::string discription=""  ///< Discription string
            ) {

        count = 0;
        CLI::callback_t fun = [&count](CLI::results_t res){
            count = (T) res.size();
            return true;
        };
        
        add_option(name, fun, discription, NOTHING);
    }

    /// Add set of options
    template<typename T>
    void add_set(
            std::string name,              ///< The name, short,long
            T &member,                     ///< The selected member of the set
            std::unordered_set<T> options, ///< The set of posibilities
            std::string discription="",    ///< Discription string
            Combiner opts=ARGS             ///< The options (REQUIRED, DEFAULT, POSITIONAL, ARGS())
            ) {

        CLI::callback_t fun = [&member, options](CLI::results_t res){
            if(res.size()!=1) {
                return false;
            }
            if(res[0].size()!=1) {
                return false;
            }
            bool retval = lexical_cast(res[0][0], member);
            if(!retval)
                return false;
            return std::find(std::begin(options), std::end(options), retval) != std::end(options);
        };

        add_option(name, fun, discription, opts);
    }

    

    /// Parses the command line - throws errors
    void parse(int argc, char **argv) {
        std::vector<std::string> args;
        for(int i=argc-1; i>0; i--)
            args.push_back(argv[i]);
        parse(args);
    }

    void parse(std::vector<std::string> & args) {
        parsed = true;

        bool positional_only = false;
        
        while(args.size()>0) {

            logit("Parse: ["+join(args)+"]");

            Classifer classifer = positional_only ? Classifer::NONE : _recognize(args.back());
            switch(classifer) {
            case Classifer::POSITIONAL_MARK:
                args.pop_back();
                positional_only = true;
                break;
            case Classifer::SUBCOMMAND:
                _parse_subcommand(args);
                break;
            case Classifer::LONG:
                _parse_long(args);
                break;
            case Classifer::SHORT:
                _parse_short(args);
                break;
            case Classifer::NONE:
                logit("Positional: "+args.back());
                positionals.push_back(args.back());
                args.pop_back();
            }
        }

        if (count("help") > 0) {
            throw CallForHelp();
        }

        for(Option& opt : options) {
            while (opt.positional() && opt.count() < opt.expected() && positionals.size() > 0) {
                opt.get_new();
                opt.add_result(0, positionals.back());
                positionals.pop_back();
            }
            if (opt.required() && opt.count() < opt.expected())
                throw RequiredError(opt.get_name());
            if (opt.count() > 0) {
                if(!opt.run_callback())
                    throw ParseError(opt.get_name());
            }

        }
        if(positionals.size()>0)
            throw ExtraPositionalsError("[" + join(positionals) + "]");
    }

    void _parse_subcommand(std::vector<std::string> &args) {
        for(App *com : subcommands) {
            if(com->name == args.back()){ 
                args.pop_back();
                com->parse(args);
                subcommand = com;
                return;
            }
        }
        throw HorribleError("Subcommand");
    }
 
    void _parse_short(std::vector<std::string> &args) {
        std::string current = args.back();
        std::smatch match;

        if(!std::regex_match(current, match, reg_short))
            throw HorribleError("Short");
        
        args.pop_back();
        std::string name = match[1];
        std::string rest = match[2];

        logit("Working on short: " + name + " (" + rest + ")");

        auto op = std::find_if(std::begin(options), std::end(options), [name](const Option &v){return v.check_sname(name);});

        if(op == std::end(options)) {
            missing_options.push_back("-" + op->get_sname());
            return;
        }

        int vnum = op->get_new();
        int num = op->expected();
       
        if(num == 0)
            op->add_result(vnum, "");
        else if(rest!="") {
            if (num > 0)
                num--;
            op->add_result(vnum, rest);
            rest = "";
        }


        if(num == -1) {
            std::string current = args.back();
            while(_recognize(current) == Classifer::NONE) {
                std::string current = args.back();
                args.pop_back();
                op->add_result(vnum,current);
                if(args.size()==0)
                    return;

            }
        } else while(num>0) {
            num--;
            std::string current = args.back();
            logit("Adding: "+current);
            args.pop_back();
            op->add_result(vnum,current);
            if(args.size()==0)
                return;
        }

        if(rest != "") {
            rest = "-" + rest;
            args.push_back(rest);
        }
    }

    Classifer _recognize(std::string current) const {
        if(current == "--")
            return Classifer::POSITIONAL_MARK;
        for(const App* com : subcommands) {
            if(com->name == current)
                return Classifer::SUBCOMMAND;
        }
        if(std::regex_match(current, reg_long))
            return Classifer::LONG;
        if(std::regex_match(current, reg_short))
            return Classifer::SHORT;
        return Classifer::NONE;
            

    }

    void _parse_long(std::vector<std::string> &args) {
        std::string current = args.back();
        std::smatch match;

        if(!std::regex_match(current, match, reg_long))
            throw HorribleError("Long");

        args.pop_back();
        std::string name = match[1];
        std::string value = match[2];


        logit("Working on long: " + name + " (" + value + ")");

        auto op = std::find_if(std::begin(options), std::end(options), [name](const Option &v){return v.check_lname(name);});

        if(op == std::end(options)) {
            missing_options.push_back("--" + op->get_lname());
            return;
        }


        int vnum = op->get_new();
        int num = op->expected();
        

        if(value != "") {
            if(num!=-1) num--;
            op->add_result(vnum, value);
        } else if (num == 0) {
            op->add_result(vnum, "");
        }

        if(num == -1) {
            std::string current = args.back();
            while(_recognize(current) == Classifer::NONE) {
                std::string current = args.back();
                args.pop_back();
                op->add_result(vnum,current);
                if(args.size()==0)
                    return;

            }
        } else while(num>0) {
            num--;
            std::string current = args.back();
            args.pop_back();
            op->add_result(vnum,current);
            if(args.size()==0)
                return;
        }
        return;
    }

    /// This must be called after the options are in but before the rest of the program.
    /** Instead of throwing erros, causes the program to exit
     * if -h or an invalid option is passed. */
    void start(int argc, char** argv) {
        try {
            parse(argc, argv);
        } catch(const CallForHelp &e) {
            std::cout << help() << std::endl;
            exit(0);
        } catch(const Error &e) {
            std::cerr << "ERROR: ";
            std::cerr << e.what() << std::endl;
            std::cerr << help() << std::endl;
            exit(1);
        }

    }

    /// Counts the number of times the given option was passed.
    int count(std::string name) const {
        for(const Option &opt : options) {
            logit("Computing: " + opt.get_name());
            if(opt.check_name(name)) {
                logit("Counting: " + opt.get_name() + std::to_string(opt.count()));
                return opt.count();
            }
        }
        throw OptionNotFound(name);
    }

    std::string help() const {
        std::stringstream out;
        if(name != "")
            out << "Subcommand: " << name << " ";
        out << prog_discription << std::endl;
        int len = std::accumulate(std::begin(options), std::end(options), 0,
                [](int val, const Option &opt){
                    return std::max(opt.help_len()+1, val);});
        for(const Option &opt : options) {
            out << opt.help(len) << std::endl;
        }
        if(subcommands.size()> 0) {
            out << "Subcommands:" << std::endl;
            int max = std::accumulate(std::begin(subcommands), std::end(subcommands), 0,
                    [](int i, const App* j){return std::max(i, (int) j->get_name().length()+1);});
            for(const App* com : subcommands) {
                out << std::setw(max) << std::left << com->get_name() << " " << com->prog_discription << std::endl;
            }
        }
        return out.str();
    }
    
    App* get_subcommand() {
        return subcommand;
    }
    
    std::string get_name() const {
        return name;
    }
};
}