1277 lines
44 KiB
C++
1277 lines
44 KiB
C++
#pragma once
|
|
|
|
// Distributed under the 3-Clause BSD License. See accompanying
|
|
// file LICENSE or https://github.com/CLIUtils/CLI11 for details.
|
|
|
|
#include <algorithm>
|
|
#include <deque>
|
|
#include <functional>
|
|
#include <iostream>
|
|
#include <memory>
|
|
#include <numeric>
|
|
#include <set>
|
|
#include <sstream>
|
|
#include <string>
|
|
#include <utility>
|
|
#include <vector>
|
|
|
|
// CLI Library includes
|
|
#include "CLI/Error.hpp"
|
|
#include "CLI/Ini.hpp"
|
|
#include "CLI/Option.hpp"
|
|
#include "CLI/Split.hpp"
|
|
#include "CLI/StringTools.hpp"
|
|
#include "CLI/TypeTools.hpp"
|
|
|
|
namespace CLI {
|
|
|
|
namespace detail {
|
|
enum class Classifer { NONE, POSITIONAL_MARK, SHORT, LONG, SUBCOMMAND };
|
|
struct AppFriend;
|
|
} // namespace detail
|
|
|
|
class App;
|
|
|
|
using App_p = std::unique_ptr<App>;
|
|
|
|
/// Creates a command line program, with very few defaults.
|
|
/** To use, create a new `Program()` instance with `argc`, `argv`, and a help description. 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 {
|
|
friend Option;
|
|
friend detail::AppFriend;
|
|
|
|
protected:
|
|
// This library follows the Google style guide for member names ending in underscores
|
|
|
|
/// @name Basics
|
|
///@{
|
|
|
|
/// Subcommand name or program name (from parser)
|
|
std::string name_{"program"};
|
|
|
|
/// Description of the current program/subcommand
|
|
std::string description_;
|
|
|
|
/// If true, allow extra arguments (ie, don't throw an error).
|
|
bool allow_extras_{false};
|
|
|
|
/// If true, return immediatly on an unrecognised option (implies allow_extras)
|
|
bool prefix_command_{false};
|
|
|
|
/// This is a function that runs when complete. Great for subcommands. Can throw.
|
|
std::function<void()> callback_;
|
|
|
|
///@}
|
|
/// @name Options
|
|
///@{
|
|
|
|
/// The list of options, stored locally
|
|
std::vector<Option_p> options_;
|
|
|
|
/// A pointer to the help flag if there is one
|
|
Option *help_ptr_{nullptr};
|
|
|
|
///@}
|
|
/// @name Parsing
|
|
///@{
|
|
|
|
using missing_t = std::vector<std::pair<detail::Classifer, std::string>>;
|
|
|
|
/// Pair of classifier, string for missing options. (extra detail is removed on returning from parse)
|
|
///
|
|
/// This is faster and cleaner than storing just a list of strings and reparsing. This may contain the -- separator.
|
|
missing_t missing_;
|
|
|
|
/// This is a list of pointers to options with the orignal parse order
|
|
std::vector<Option *> parse_order_;
|
|
|
|
///@}
|
|
/// @name Subcommands
|
|
///@{
|
|
|
|
/// Storage for subcommand list
|
|
std::vector<App_p> subcommands_;
|
|
|
|
/// If true, the program name is not case sensitive
|
|
bool ignore_case_{false};
|
|
|
|
/// Allow subcommand fallthrough, so that parent commands can collect commands after subcommand.
|
|
bool fallthrough_{false};
|
|
|
|
/// A pointer to the parent if this is a subcommand
|
|
App *parent_{nullptr};
|
|
|
|
/// True if this command/subcommand was parsed
|
|
bool parsed_{false};
|
|
|
|
/// -1 for 1 or more, 0 for not required, # for exact number required
|
|
int require_subcommand_ = 0;
|
|
|
|
///@}
|
|
/// @name Config
|
|
///@{
|
|
|
|
/// The name of the connected config file
|
|
std::string config_name_;
|
|
|
|
/// True if ini is required (throws if not present), if false simply keep going.
|
|
bool config_required_{false};
|
|
|
|
/// Pointer to the config option
|
|
Option *config_ptr_{nullptr};
|
|
|
|
///@}
|
|
|
|
/// Special private constructor for subcommand
|
|
App(std::string description_, bool help, detail::enabler) : description_(std::move(description_)) {
|
|
|
|
if(help)
|
|
help_ptr_ = add_flag("-h,--help", "Print this help message and exit");
|
|
}
|
|
|
|
public:
|
|
/// @name Basic
|
|
///@{
|
|
|
|
/// Create a new program. Pass in the same arguments as main(), along with a help string.
|
|
App(std::string description_ = "", bool help = true) : App(description_, help, detail::dummy) {}
|
|
|
|
/// Set a callback for the end of parsing.
|
|
///
|
|
/// Due to a bug in c++11,
|
|
/// it is not possible to overload on std::function (fixed in c++14
|
|
/// and backported to c++11 on newer compilers). Use capture by reference
|
|
/// to get a pointer to App if needed.
|
|
App *set_callback(std::function<void()> callback) {
|
|
callback_ = callback;
|
|
return this;
|
|
}
|
|
|
|
/// Remove the error when extras are left over on the command line.
|
|
App *allow_extras(bool allow = true) {
|
|
allow_extras_ = allow;
|
|
return this;
|
|
}
|
|
|
|
/// Do not parse anything after the first unrecongnised option and return
|
|
App *prefix_command(bool allow = true) {
|
|
prefix_command_ = allow;
|
|
return this;
|
|
}
|
|
|
|
/// Ignore case. Subcommand inherit value.
|
|
App *ignore_case(bool value = true) {
|
|
ignore_case_ = value;
|
|
if(parent_ != nullptr) {
|
|
for(const auto &subc : parent_->subcommands_) {
|
|
if(subc.get() != this && (this->check_name(subc->name_) || subc->check_name(this->name_)))
|
|
throw OptionAlreadyAdded(subc->name_);
|
|
}
|
|
}
|
|
return this;
|
|
}
|
|
|
|
/// Check to see if this subcommand was parsed, true only if received on command line.
|
|
bool parsed() const { return parsed_; }
|
|
|
|
/// Check to see if this subcommand was parsed, true only if received on command line.
|
|
/// This allows the subcommand to be directly checked.
|
|
operator bool() const { return parsed_; }
|
|
|
|
/// Require a subcommand to be given (does not affect help call)
|
|
/// Does not return a pointer since it is supposed to be called on the main App.
|
|
App *require_subcommand(int value = -1) {
|
|
require_subcommand_ = value;
|
|
return this;
|
|
}
|
|
|
|
/// Stop subcommand fallthrough, so that parent commands cannot collect commands after subcommand.
|
|
/// Default from parent, usually set on parent.
|
|
App *fallthrough(bool value = true) {
|
|
fallthrough_ = value;
|
|
return this;
|
|
}
|
|
|
|
///@}
|
|
/// @name Adding options
|
|
///@{
|
|
|
|
/// 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. Numbers, vectors, and strings are supported.
|
|
///
|
|
/// ->required(), ->default, and the validators are options,
|
|
/// The positional options take an optional number of arguments.
|
|
///
|
|
/// For example,
|
|
///
|
|
/// std::string filename;
|
|
/// program.add_option("filename", filename, "description of filename");
|
|
///
|
|
Option *add_option(std::string name, callback_t callback, std::string description = "", bool defaulted = false) {
|
|
Option myopt{name, description, callback, defaulted, this};
|
|
|
|
if(std::find_if(std::begin(options_), std::end(options_), [&myopt](const Option_p &v) {
|
|
return *v == myopt;
|
|
}) == std::end(options_)) {
|
|
options_.emplace_back();
|
|
Option_p &option = options_.back();
|
|
option.reset(new Option(name, description, callback, defaulted, this));
|
|
return option.get();
|
|
} else
|
|
throw OptionAlreadyAdded(myopt.get_name());
|
|
}
|
|
|
|
/// Add option for non-vectors (duplicate copy needed without defaulted to avoid `iostream << value`)
|
|
template <typename T, enable_if_t<!is_vector<T>::value, detail::enabler> = detail::dummy>
|
|
Option *add_option(std::string name,
|
|
T &variable, ///< The variable to set
|
|
std::string description = "") {
|
|
|
|
CLI::callback_t fun = [&variable](CLI::results_t res) {
|
|
if(res.size() != 1)
|
|
return false;
|
|
return detail::lexical_cast(res[0], variable);
|
|
};
|
|
|
|
Option *opt = add_option(name, fun, description, false);
|
|
opt->set_custom_option(detail::type_name<T>());
|
|
return opt;
|
|
}
|
|
|
|
/// Add option for non-vectors with a default print
|
|
template <typename T, enable_if_t<!is_vector<T>::value, detail::enabler> = detail::dummy>
|
|
Option *add_option(std::string name,
|
|
T &variable, ///< The variable to set
|
|
std::string description,
|
|
bool defaulted) {
|
|
|
|
CLI::callback_t fun = [&variable](CLI::results_t res) {
|
|
if(res.size() != 1)
|
|
return false;
|
|
return detail::lexical_cast(res[0], variable);
|
|
};
|
|
|
|
Option *opt = add_option(name, fun, description, defaulted);
|
|
opt->set_custom_option(detail::type_name<T>());
|
|
if(defaulted) {
|
|
std::stringstream out;
|
|
out << variable;
|
|
opt->set_default_str(out.str());
|
|
}
|
|
return opt;
|
|
}
|
|
|
|
/// Add option for vectors (no default)
|
|
template <typename T>
|
|
Option *add_option(std::string name,
|
|
std::vector<T> &variable, ///< The variable vector to set
|
|
std::string description = "") {
|
|
|
|
CLI::callback_t fun = [&variable](CLI::results_t res) {
|
|
bool retval = true;
|
|
variable.clear();
|
|
for(const auto &a : res) {
|
|
variable.emplace_back();
|
|
retval &= detail::lexical_cast(a, variable.back());
|
|
}
|
|
return (!variable.empty()) && retval;
|
|
};
|
|
|
|
Option *opt = add_option(name, fun, description, false);
|
|
opt->set_custom_option(detail::type_name<T>(), -1, true);
|
|
return opt;
|
|
}
|
|
|
|
/// Add option for vectors
|
|
template <typename T>
|
|
Option *add_option(std::string name,
|
|
std::vector<T> &variable, ///< The variable vector to set
|
|
std::string description,
|
|
bool defaulted) {
|
|
|
|
CLI::callback_t fun = [&variable](CLI::results_t res) {
|
|
bool retval = true;
|
|
variable.clear();
|
|
for(const auto &a : res) {
|
|
variable.emplace_back();
|
|
retval &= detail::lexical_cast(a, variable.back());
|
|
}
|
|
return (!variable.empty()) && retval;
|
|
};
|
|
|
|
Option *opt = add_option(name, fun, description, defaulted);
|
|
opt->set_custom_option(detail::type_name<T>(), -1, true);
|
|
if(defaulted)
|
|
opt->set_default_str("[" + detail::join(variable) + "]");
|
|
return opt;
|
|
}
|
|
|
|
/// Add option for flag
|
|
Option *add_flag(std::string name, std::string description = "") {
|
|
CLI::callback_t fun = [](CLI::results_t) { return true; };
|
|
|
|
Option *opt = add_option(name, fun, description, false);
|
|
if(opt->get_positional())
|
|
throw IncorrectConstruction("Flags cannot be positional");
|
|
opt->set_custom_option("", 0);
|
|
return opt;
|
|
}
|
|
|
|
/// Add option for flag integer
|
|
template <typename T,
|
|
enable_if_t<std::is_integral<T>::value && !is_bool<T>::value, detail::enabler> = detail::dummy>
|
|
Option *add_flag(std::string name,
|
|
T &count, ///< A varaible holding the count
|
|
std::string description = "") {
|
|
|
|
count = 0;
|
|
CLI::callback_t fun = [&count](CLI::results_t res) {
|
|
count = static_cast<T>(res.size());
|
|
return true;
|
|
};
|
|
|
|
Option *opt = add_option(name, fun, description, false);
|
|
if(opt->get_positional())
|
|
throw IncorrectConstruction("Flags cannot be positional");
|
|
opt->set_custom_option("", 0);
|
|
return opt;
|
|
}
|
|
|
|
/// Bool version only allows the flag once
|
|
template <typename T, enable_if_t<is_bool<T>::value, detail::enabler> = detail::dummy>
|
|
Option *add_flag(std::string name,
|
|
T &count, ///< A varaible holding true if passed
|
|
std::string description = "") {
|
|
|
|
count = false;
|
|
CLI::callback_t fun = [&count](CLI::results_t res) {
|
|
count = true;
|
|
return res.size() == 1;
|
|
};
|
|
|
|
Option *opt = add_option(name, fun, description, false);
|
|
if(opt->get_positional())
|
|
throw IncorrectConstruction("Flags cannot be positional");
|
|
opt->set_custom_option("", 0);
|
|
return opt;
|
|
}
|
|
|
|
/// Add set of options (No default)
|
|
template <typename T>
|
|
Option *add_set(std::string name,
|
|
T &member, ///< The selected member of the set
|
|
std::set<T> options, ///< The set of posibilities
|
|
std::string description = "") {
|
|
|
|
CLI::callback_t fun = [&member, options](CLI::results_t res) {
|
|
if(res.size() != 1) {
|
|
return false;
|
|
}
|
|
bool retval = detail::lexical_cast(res[0], member);
|
|
if(!retval)
|
|
return false;
|
|
return std::find(std::begin(options), std::end(options), member) != std::end(options);
|
|
};
|
|
|
|
Option *opt = add_option(name, fun, description, false);
|
|
std::string typeval = detail::type_name<T>();
|
|
typeval += " in {" + detail::join(options) + "}";
|
|
opt->set_custom_option(typeval);
|
|
return opt;
|
|
}
|
|
|
|
/// Add set of options
|
|
template <typename T>
|
|
Option *add_set(std::string name,
|
|
T &member, ///< The selected member of the set
|
|
std::set<T> options, ///< The set of posibilities
|
|
std::string description,
|
|
bool defaulted) {
|
|
|
|
CLI::callback_t fun = [&member, options](CLI::results_t res) {
|
|
if(res.size() != 1) {
|
|
return false;
|
|
}
|
|
bool retval = detail::lexical_cast(res[0], member);
|
|
if(!retval)
|
|
return false;
|
|
return std::find(std::begin(options), std::end(options), member) != std::end(options);
|
|
};
|
|
|
|
Option *opt = add_option(name, fun, description, defaulted);
|
|
std::string typeval = detail::type_name<T>();
|
|
typeval += " in {" + detail::join(options) + "}";
|
|
opt->set_custom_option(typeval);
|
|
if(defaulted) {
|
|
std::stringstream out;
|
|
out << member;
|
|
opt->set_default_str(out.str());
|
|
}
|
|
return opt;
|
|
}
|
|
|
|
/// Add set of options, string only, ignore case (no default)
|
|
Option *add_set_ignore_case(std::string name,
|
|
std::string &member, ///< The selected member of the set
|
|
std::set<std::string> options, ///< The set of posibilities
|
|
std::string description = "") {
|
|
|
|
CLI::callback_t fun = [&member, options](CLI::results_t res) {
|
|
if(res.size() != 1) {
|
|
return false;
|
|
}
|
|
member = detail::to_lower(res[0]);
|
|
auto iter = std::find_if(std::begin(options), std::end(options), [&member](std::string val) {
|
|
return detail::to_lower(val) == member;
|
|
});
|
|
if(iter == std::end(options))
|
|
return false;
|
|
else {
|
|
member = *iter;
|
|
return true;
|
|
}
|
|
};
|
|
|
|
Option *opt = add_option(name, fun, description, false);
|
|
std::string typeval = detail::type_name<std::string>();
|
|
typeval += " in {" + detail::join(options) + "}";
|
|
opt->set_custom_option(typeval);
|
|
|
|
return opt;
|
|
}
|
|
|
|
/// Add set of options, string only, ignore case
|
|
Option *add_set_ignore_case(std::string name,
|
|
std::string &member, ///< The selected member of the set
|
|
std::set<std::string> options, ///< The set of posibilities
|
|
std::string description,
|
|
bool defaulted) {
|
|
|
|
CLI::callback_t fun = [&member, options](CLI::results_t res) {
|
|
if(res.size() != 1) {
|
|
return false;
|
|
}
|
|
member = detail::to_lower(res[0]);
|
|
auto iter = std::find_if(std::begin(options), std::end(options), [&member](std::string val) {
|
|
return detail::to_lower(val) == member;
|
|
});
|
|
if(iter == std::end(options))
|
|
return false;
|
|
else {
|
|
member = *iter;
|
|
return true;
|
|
}
|
|
};
|
|
|
|
Option *opt = add_option(name, fun, description, defaulted);
|
|
std::string typeval = detail::type_name<std::string>();
|
|
typeval += " in {" + detail::join(options) + "}";
|
|
opt->set_custom_option(typeval);
|
|
if(defaulted) {
|
|
opt->set_default_str(member);
|
|
}
|
|
return opt;
|
|
}
|
|
|
|
/// Add a complex number
|
|
template <typename T>
|
|
Option *add_complex(std::string name,
|
|
T &variable,
|
|
std::string description = "",
|
|
bool defaulted = false,
|
|
std::string label = "COMPLEX") {
|
|
CLI::callback_t fun = [&variable](results_t res) {
|
|
if(res.size() != 2)
|
|
return false;
|
|
double x, y;
|
|
bool worked = detail::lexical_cast(res[0], x) && detail::lexical_cast(res[1], y);
|
|
if(worked)
|
|
variable = T(x, y);
|
|
return worked;
|
|
};
|
|
|
|
CLI::Option *opt = add_option(name, fun, description, defaulted);
|
|
opt->set_custom_option(label, 2);
|
|
if(defaulted) {
|
|
std::stringstream out;
|
|
out << variable;
|
|
opt->set_default_str(out.str());
|
|
}
|
|
return opt;
|
|
}
|
|
|
|
/// Add a configuration ini file option
|
|
Option *add_config(std::string name = "--config",
|
|
std::string default_filename = "",
|
|
std::string help = "Read an ini file",
|
|
bool required = false) {
|
|
|
|
// Remove existing config if present
|
|
if(config_ptr_ != nullptr)
|
|
remove_option(config_ptr_);
|
|
config_name_ = default_filename;
|
|
config_required_ = required;
|
|
config_ptr_ = add_option(name, config_name_, help, default_filename != "");
|
|
return config_ptr_;
|
|
}
|
|
|
|
/// Removes an option from the App. Takes an option pointer. Returns true if found and removed.
|
|
bool remove_option(Option *opt) {
|
|
auto iterator =
|
|
std::find_if(std::begin(options_), std::end(options_), [opt](const Option_p &v) { return v.get() == opt; });
|
|
if(iterator != std::end(options_)) {
|
|
options_.erase(iterator);
|
|
return true;
|
|
}
|
|
return false;
|
|
}
|
|
|
|
///@}
|
|
/// @name Subcommmands
|
|
///@{
|
|
|
|
/// Add a subcommand. Like the constructor, you can override the help message addition by setting help=false
|
|
App *add_subcommand(std::string name, std::string description = "", bool help = true) {
|
|
subcommands_.emplace_back(new App(description, help, detail::dummy));
|
|
subcommands_.back()->name_ = name;
|
|
subcommands_.back()->allow_extras();
|
|
subcommands_.back()->parent_ = this;
|
|
subcommands_.back()->ignore_case_ = ignore_case_;
|
|
subcommands_.back()->fallthrough_ = fallthrough_;
|
|
for(const auto &subc : subcommands_)
|
|
if(subc.get() != subcommands_.back().get())
|
|
if(subc->check_name(subcommands_.back()->name_) || subcommands_.back()->check_name(subc->name_))
|
|
throw OptionAlreadyAdded(subc->name_);
|
|
return subcommands_.back().get();
|
|
}
|
|
|
|
/// Check to see if a subcommand is part of this command (doesn't have to be in command line)
|
|
App *get_subcommand(App *subcom) const {
|
|
for(const App_p &subcomptr : subcommands_)
|
|
if(subcomptr.get() == subcom)
|
|
return subcom;
|
|
throw CLI::OptionNotFound(subcom->get_name());
|
|
}
|
|
|
|
/// Check to see if a subcommand is part of this command (text version)
|
|
App *get_subcommand(std::string subcom) const {
|
|
for(const App_p &subcomptr : subcommands_)
|
|
if(subcomptr->check_name(subcom))
|
|
return subcomptr.get();
|
|
throw CLI::OptionNotFound(subcom);
|
|
}
|
|
|
|
///@}
|
|
/// @name Extras for subclassing
|
|
///@{
|
|
|
|
/// This allows subclasses to inject code before callbacks but after parse.
|
|
///
|
|
/// This does not run if any errors or help is thrown.
|
|
virtual void pre_callback() {}
|
|
|
|
///@}
|
|
/// @name Parsing
|
|
///@{
|
|
|
|
/// Parses the command line - throws errors
|
|
/// This must be called after the options are in but before the rest of the program.
|
|
std::vector<std::string> parse(int argc, char **argv) {
|
|
name_ = argv[0];
|
|
std::vector<std::string> args;
|
|
for(int i = argc - 1; i > 0; i--)
|
|
args.emplace_back(argv[i]);
|
|
return parse(args);
|
|
}
|
|
|
|
/// The real work is done here. Expects a reversed vector.
|
|
/// Changes the vector to the remaining options.
|
|
std::vector<std::string> &parse(std::vector<std::string> &args) {
|
|
_validate();
|
|
_parse(args);
|
|
run_callback();
|
|
return args;
|
|
}
|
|
|
|
/// Print a nice error message and return the exit code
|
|
int exit(const Error &e) const {
|
|
if(e.exit_code != static_cast<int>(ExitCodes::Success)) {
|
|
std::cerr << "ERROR: ";
|
|
std::cerr << e.what() << std::endl;
|
|
if(e.print_help)
|
|
std::cerr << help();
|
|
} else {
|
|
if(e.print_help)
|
|
std::cout << help();
|
|
}
|
|
return e.get_exit_code();
|
|
}
|
|
|
|
/// Reset the parsed data
|
|
void reset() {
|
|
|
|
parsed_ = false;
|
|
missing_.clear();
|
|
|
|
for(const Option_p &opt : options_) {
|
|
opt->clear();
|
|
}
|
|
for(const App_p &app : subcommands_) {
|
|
app->reset();
|
|
}
|
|
}
|
|
|
|
///@}
|
|
/// @name Post parsing
|
|
///@{
|
|
|
|
/// Counts the number of times the given option was passed.
|
|
size_t count(std::string name) const {
|
|
for(const Option_p &opt : options_) {
|
|
if(opt->check_name(name)) {
|
|
return opt->count();
|
|
}
|
|
}
|
|
throw OptionNotFound(name);
|
|
}
|
|
|
|
/// Get a subcommand pointer list to the currently selected subcommands (after parsing)
|
|
std::vector<App *> get_subcommands() const {
|
|
std::vector<App *> subcomms;
|
|
for(const App_p &subcomptr : subcommands_)
|
|
if(subcomptr->parsed_)
|
|
subcomms.push_back(subcomptr.get());
|
|
return subcomms;
|
|
}
|
|
|
|
/// Check to see if given subcommand was selected
|
|
bool got_subcommand(App *subcom) const {
|
|
// get subcom needed to verify that this was a real subcommand
|
|
return get_subcommand(subcom)->parsed_;
|
|
}
|
|
|
|
/// Check with name instead of pointer to see if subcommand was selected
|
|
bool got_subcommand(std::string name) const { return get_subcommand(name)->parsed_; }
|
|
|
|
///@}
|
|
/// @name Help
|
|
///@{
|
|
|
|
/// Produce a string that could be read in as a config of the current values of the App. Set default_also to include
|
|
/// default arguments. Prefix will add a string to the beginning of each option.
|
|
std::string config_to_str(bool default_also = false, std::string prefix = "") const {
|
|
std::stringstream out;
|
|
for(const Option_p &opt : options_) {
|
|
|
|
// Only process option with a long-name
|
|
if(!opt->lnames_.empty()) {
|
|
std::string name = prefix + opt->lnames_[0];
|
|
|
|
// Non-flags
|
|
if(opt->get_expected() != 0) {
|
|
|
|
// If the option was found on command line
|
|
if(opt->count() > 0)
|
|
out << name << "=" << detail::inijoin(opt->results()) << std::endl;
|
|
|
|
// If the option has a default and is requested by optional argument
|
|
else if(default_also && opt->defaultval_ != "")
|
|
out << name << "=" << opt->defaultval_ << std::endl;
|
|
// Flag, one passed
|
|
} else if(opt->count() == 1) {
|
|
out << name << "=true" << std::endl;
|
|
|
|
// Flag, multiple passed
|
|
} else if(opt->count() > 1) {
|
|
out << name << "=" << opt->count() << std::endl;
|
|
|
|
// Flag, not present
|
|
} else if(opt->count() == 0 && default_also && opt.get() != get_help_ptr()) {
|
|
out << name << "=false" << std::endl;
|
|
}
|
|
}
|
|
}
|
|
for(const App_p &subcom : subcommands_)
|
|
out << subcom->config_to_str(default_also, prefix + subcom->name_ + ".");
|
|
return out.str();
|
|
}
|
|
|
|
/// Makes a help message, with a column wid for column 1
|
|
std::string help(size_t wid = 30, std::string prev = "") const {
|
|
// Delegate to subcommand if needed
|
|
if(prev == "")
|
|
prev = name_;
|
|
else
|
|
prev += " " + name_;
|
|
|
|
auto selected_subcommands = get_subcommands();
|
|
if(!selected_subcommands.empty())
|
|
return selected_subcommands.at(0)->help(wid, prev);
|
|
|
|
std::stringstream out;
|
|
out << description_ << std::endl;
|
|
out << "Usage: " << prev;
|
|
|
|
// Check for options_
|
|
bool npos = false;
|
|
std::set<std::string> groups;
|
|
for(const Option_p &opt : options_) {
|
|
if(opt->nonpositional()) {
|
|
npos = true;
|
|
groups.insert(opt->get_group());
|
|
}
|
|
}
|
|
|
|
if(npos)
|
|
out << " [OPTIONS]";
|
|
|
|
// Positionals
|
|
bool pos = false;
|
|
for(const Option_p &opt : options_)
|
|
if(opt->get_positional()) {
|
|
// A hidden positional should still show up in the usage statement
|
|
// if(detail::to_lower(opt->get_group()) == "hidden")
|
|
// continue;
|
|
out << " " << opt->help_positional();
|
|
if(opt->_has_help_positional())
|
|
pos = true;
|
|
}
|
|
|
|
if(!subcommands_.empty()) {
|
|
if(require_subcommand_ != 0)
|
|
out << " SUBCOMMAND";
|
|
else
|
|
out << " [SUBCOMMAND]";
|
|
}
|
|
|
|
out << std::endl << std::endl;
|
|
|
|
// Positional descriptions
|
|
if(pos) {
|
|
out << "Positionals:" << std::endl;
|
|
for(const Option_p &opt : options_) {
|
|
if(detail::to_lower(opt->get_group()) == "hidden")
|
|
continue;
|
|
if(opt->_has_help_positional())
|
|
detail::format_help(out, opt->help_pname(), opt->get_description(), wid);
|
|
}
|
|
out << std::endl;
|
|
}
|
|
|
|
// Options
|
|
if(npos) {
|
|
for(const std::string &group : groups) {
|
|
if(detail::to_lower(group) == "hidden")
|
|
continue;
|
|
out << group << ":" << std::endl;
|
|
for(const Option_p &opt : options_) {
|
|
if(opt->nonpositional() && opt->get_group() == group)
|
|
detail::format_help(out, opt->help_name(), opt->get_description(), wid);
|
|
}
|
|
out << std::endl;
|
|
}
|
|
}
|
|
|
|
// Subcommands
|
|
if(!subcommands_.empty()) {
|
|
out << "Subcommands:" << std::endl;
|
|
for(const App_p &com : subcommands_)
|
|
detail::format_help(out, com->get_name(), com->description_, wid);
|
|
}
|
|
return out.str();
|
|
}
|
|
|
|
///@}
|
|
/// @name Getters
|
|
///@{
|
|
|
|
/// Get a pointer to the help flag.
|
|
Option *get_help_ptr() { return help_ptr_; }
|
|
|
|
/// Get a pointer to the help flag. (const)
|
|
const Option *get_help_ptr() const { return help_ptr_; }
|
|
|
|
/// Get a pointer to the config option.
|
|
Option *get_config_ptr() { return config_ptr_; }
|
|
|
|
/// Get a pointer to the config option. (const)
|
|
const Option *get_config_ptr() const { return config_ptr_; }
|
|
/// Get the name of the current app
|
|
std::string get_name() const { return name_; }
|
|
|
|
/// Check the name, case insensitive if set
|
|
bool check_name(std::string name_to_check) const {
|
|
std::string local_name = name_;
|
|
if(ignore_case_) {
|
|
local_name = detail::to_lower(name_);
|
|
name_to_check = detail::to_lower(name_to_check);
|
|
}
|
|
|
|
return local_name == name_to_check;
|
|
}
|
|
|
|
/// This gets a vector of pointers with the original parse order
|
|
const std::vector<Option *> &parse_order() const { return parse_order_; }
|
|
|
|
///@}
|
|
|
|
protected:
|
|
/// Check the options to make sure there are no conficts.
|
|
///
|
|
/// Currenly checks to see if mutiple positionals exist with -1 args
|
|
void _validate() const {
|
|
auto count = std::count_if(std::begin(options_), std::end(options_), [](const Option_p &opt) {
|
|
return opt->get_expected() == -1 && opt->get_positional();
|
|
});
|
|
if(count > 1)
|
|
throw InvalidError(name_ + ": Too many positional arguments with unlimited expected args");
|
|
for(const App_p &app : subcommands_)
|
|
app->_validate();
|
|
}
|
|
|
|
/// Return missing from the master
|
|
missing_t *missing() {
|
|
if(parent_ != nullptr)
|
|
return parent_->missing();
|
|
return &missing_;
|
|
}
|
|
|
|
/// Internal function to run (App) callback, top down
|
|
void run_callback() {
|
|
pre_callback();
|
|
if(callback_)
|
|
callback_();
|
|
for(App *subc : get_subcommands()) {
|
|
subc->run_callback();
|
|
}
|
|
}
|
|
|
|
bool _valid_subcommand(const std::string ¤t) const {
|
|
for(const App_p &com : subcommands_)
|
|
if(com->check_name(current) && !*com)
|
|
return true;
|
|
if(parent_ != nullptr)
|
|
return parent_->_valid_subcommand(current);
|
|
else
|
|
return false;
|
|
}
|
|
|
|
/// Selects a Classifer enum based on the type of the current argument
|
|
detail::Classifer _recognize(const std::string ¤t) const {
|
|
std::string dummy1, dummy2;
|
|
|
|
if(current == "--")
|
|
return detail::Classifer::POSITIONAL_MARK;
|
|
if(_valid_subcommand(current))
|
|
return detail::Classifer::SUBCOMMAND;
|
|
if(detail::split_long(current, dummy1, dummy2))
|
|
return detail::Classifer::LONG;
|
|
if(detail::split_short(current, dummy1, dummy2))
|
|
return detail::Classifer::SHORT;
|
|
return detail::Classifer::NONE;
|
|
}
|
|
|
|
/// Internal parse function
|
|
void _parse(std::vector<std::string> &args) {
|
|
parsed_ = true;
|
|
bool positional_only = false;
|
|
|
|
while(!args.empty()) {
|
|
_parse_single(args, positional_only);
|
|
}
|
|
|
|
if(help_ptr_ != nullptr && help_ptr_->count() > 0) {
|
|
throw CallForHelp();
|
|
}
|
|
|
|
// Process an INI file
|
|
if(config_ptr_ != nullptr && config_name_ != "") {
|
|
try {
|
|
std::vector<detail::ini_ret_t> values = detail::parse_ini(config_name_);
|
|
while(!values.empty()) {
|
|
if(!_parse_ini(values)) {
|
|
throw ExtrasINIError(values.back().fullname);
|
|
}
|
|
}
|
|
} catch(const FileError &) {
|
|
if(config_required_)
|
|
throw;
|
|
}
|
|
}
|
|
|
|
// Get envname options if not yet passed
|
|
for(const Option_p &opt : options_) {
|
|
if(opt->count() == 0 && opt->envname_ != "") {
|
|
char *buffer = nullptr;
|
|
std::string ename_string;
|
|
|
|
#ifdef _MSC_VER
|
|
// Windows version
|
|
size_t sz = 0;
|
|
if(_dupenv_s(&buffer, &sz, opt->envname_.c_str()) == 0 && buffer != nullptr) {
|
|
ename_string = std::string(buffer);
|
|
free(buffer);
|
|
}
|
|
#else
|
|
// This also works on Windows, but gives a warning
|
|
buffer = std::getenv(opt->envname_.c_str());
|
|
if(buffer != nullptr)
|
|
ename_string = std::string(buffer);
|
|
#endif
|
|
|
|
if(!ename_string.empty()) {
|
|
opt->add_result(ename_string);
|
|
}
|
|
}
|
|
}
|
|
|
|
// Process callbacks
|
|
for(const Option_p &opt : options_) {
|
|
if(opt->count() > 0 && !opt->get_callback_run()) {
|
|
opt->run_callback();
|
|
}
|
|
}
|
|
|
|
// Verify required options
|
|
for(const Option_p &opt : options_) {
|
|
// Required
|
|
if(opt->get_required() && (static_cast<int>(opt->count()) < opt->get_expected() || opt->count() == 0))
|
|
throw RequiredError(opt->get_name());
|
|
// Requires
|
|
for(const Option *opt_req : opt->requires_)
|
|
if(opt->count() > 0 && opt_req->count() == 0)
|
|
throw RequiresError(opt->get_name(), opt_req->get_name());
|
|
// Excludes
|
|
for(const Option *opt_ex : opt->excludes_)
|
|
if(opt->count() > 0 && opt_ex->count() != 0)
|
|
throw ExcludesError(opt->get_name(), opt_ex->get_name());
|
|
}
|
|
|
|
auto selected_subcommands = get_subcommands();
|
|
if(require_subcommand_ < 0 && selected_subcommands.empty())
|
|
throw RequiredError("Subcommand required");
|
|
else if(require_subcommand_ > 0 && static_cast<int>(selected_subcommands.size()) != require_subcommand_)
|
|
throw RequiredError(std::to_string(require_subcommand_) + " subcommand(s) required");
|
|
|
|
// Convert missing (pairs) to extras (string only)
|
|
if(parent_ == nullptr) {
|
|
args.resize(missing()->size());
|
|
std::transform(std::begin(*missing()),
|
|
std::end(*missing()),
|
|
std::begin(args),
|
|
[](const std::pair<detail::Classifer, std::string> &val) { return val.second; });
|
|
std::reverse(std::begin(args), std::end(args));
|
|
|
|
size_t num_left_over = std::count_if(
|
|
std::begin(*missing()), std::end(*missing()), [](std::pair<detail::Classifer, std::string> &val) {
|
|
return val.first != detail::Classifer::POSITIONAL_MARK;
|
|
});
|
|
|
|
if(num_left_over > 0 && !(allow_extras_ || prefix_command_))
|
|
throw ExtrasError("[" + detail::rjoin(args, " ") + "]");
|
|
}
|
|
}
|
|
|
|
/// Parse one ini param, return false if not found in any subcommand, remove if it is
|
|
///
|
|
/// If this has more than one dot.separated.name, go into the subcommand matching it
|
|
/// Returns true if it managed to find the option, if false you'll need to remove the arg manully.
|
|
bool _parse_ini(std::vector<detail::ini_ret_t> &args) {
|
|
detail::ini_ret_t ¤t = args.back();
|
|
std::string parent = current.parent(); // respects curent.level
|
|
std::string name = current.name();
|
|
|
|
// If a parent is listed, go to a subcommand
|
|
if(parent != "") {
|
|
current.level++;
|
|
for(const App_p &com : subcommands_)
|
|
if(com->check_name(parent))
|
|
return com->_parse_ini(args);
|
|
return false;
|
|
}
|
|
|
|
auto op_ptr = std::find_if(
|
|
std::begin(options_), std::end(options_), [name](const Option_p &v) { return v->check_lname(name); });
|
|
|
|
if(op_ptr == std::end(options_))
|
|
return false;
|
|
|
|
// Let's not go crazy with pointer syntax
|
|
Option_p &op = *op_ptr;
|
|
|
|
if(op->results_.empty()) {
|
|
// Flag parsing
|
|
if(op->get_expected() == 0) {
|
|
if(current.inputs.size() == 1) {
|
|
std::string val = current.inputs.at(0);
|
|
val = detail::to_lower(val);
|
|
if(val == "true" || val == "on" || val == "yes")
|
|
op->results_ = {""};
|
|
else if(val == "false" || val == "off" || val == "no")
|
|
;
|
|
else
|
|
try {
|
|
size_t ui = std::stoul(val);
|
|
for(size_t i = 0; i < ui; i++)
|
|
op->results_.emplace_back("");
|
|
} catch(const std::invalid_argument &) {
|
|
throw ConversionError(current.fullname + ": Should be true/false or a number");
|
|
}
|
|
} else
|
|
throw ConversionError(current.fullname + ": too many inputs for a flag");
|
|
} else {
|
|
op->results_ = current.inputs;
|
|
op->run_callback();
|
|
}
|
|
}
|
|
|
|
args.pop_back();
|
|
return true;
|
|
}
|
|
|
|
/// Parse "one" argument (some may eat more than one), delegate to parent if fails, add to missing if missing from
|
|
/// master
|
|
void _parse_single(std::vector<std::string> &args, bool &positional_only) {
|
|
|
|
detail::Classifer classifer = positional_only ? detail::Classifer::NONE : _recognize(args.back());
|
|
switch(classifer) {
|
|
case detail::Classifer::POSITIONAL_MARK:
|
|
missing()->emplace_back(classifer, args.back());
|
|
args.pop_back();
|
|
positional_only = true;
|
|
break;
|
|
case detail::Classifer::SUBCOMMAND:
|
|
_parse_subcommand(args);
|
|
break;
|
|
case detail::Classifer::LONG:
|
|
// If already parsed a subcommand, don't accept options_
|
|
_parse_long(args);
|
|
break;
|
|
case detail::Classifer::SHORT:
|
|
// If already parsed a subcommand, don't accept options_
|
|
_parse_short(args);
|
|
break;
|
|
case detail::Classifer::NONE:
|
|
// Probably a positional or something for a parent (sub)command
|
|
_parse_positional(args);
|
|
}
|
|
}
|
|
|
|
/// Count the required remaining positional arguments
|
|
size_t _count_remaining_required_positionals() const {
|
|
size_t retval = 0;
|
|
for(const Option_p &opt : options_)
|
|
if(opt->get_positional() && opt->get_required() && opt->get_expected() > 0 &&
|
|
static_cast<int>(opt->count()) < opt->get_expected())
|
|
retval = static_cast<size_t>(opt->get_expected()) - opt->count();
|
|
|
|
return retval;
|
|
}
|
|
|
|
/// Parse a positional, go up the tree to check
|
|
void _parse_positional(std::vector<std::string> &args) {
|
|
|
|
std::string positional = args.back();
|
|
for(const Option_p &opt : options_) {
|
|
// Eat options, one by one, until done
|
|
if(opt->get_positional() &&
|
|
(static_cast<int>(opt->count()) < opt->get_expected() || opt->get_expected() < 0)) {
|
|
|
|
opt->add_result(positional);
|
|
parse_order_.push_back(opt.get());
|
|
args.pop_back();
|
|
return;
|
|
}
|
|
}
|
|
|
|
if(parent_ != nullptr && fallthrough_)
|
|
return parent_->_parse_positional(args);
|
|
else {
|
|
args.pop_back();
|
|
missing()->emplace_back(detail::Classifer::NONE, positional);
|
|
|
|
if(prefix_command_) {
|
|
while(!args.empty()) {
|
|
missing()->emplace_back(detail::Classifer::NONE, args.back());
|
|
args.pop_back();
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
/// Parse a subcommand, modify args and continue
|
|
///
|
|
/// Unlike the others, this one will always allow fallthrough
|
|
void _parse_subcommand(std::vector<std::string> &args) {
|
|
if(_count_remaining_required_positionals() > 0)
|
|
return _parse_positional(args);
|
|
for(const App_p &com : subcommands_) {
|
|
if(com->check_name(args.back())) {
|
|
args.pop_back();
|
|
com->_parse(args);
|
|
return;
|
|
}
|
|
}
|
|
if(parent_ != nullptr)
|
|
return parent_->_parse_subcommand(args);
|
|
else
|
|
throw HorribleError("Subcommand " + args.back() + " missing");
|
|
}
|
|
|
|
/// Parse a short argument, must be at the top of the list
|
|
void _parse_short(std::vector<std::string> &args) {
|
|
std::string current = args.back();
|
|
|
|
std::string name;
|
|
std::string rest;
|
|
if(!detail::split_short(current, name, rest))
|
|
throw HorribleError("Short");
|
|
|
|
auto op_ptr = std::find_if(
|
|
std::begin(options_), std::end(options_), [name](const Option_p &opt) { return opt->check_sname(name); });
|
|
|
|
// Option not found
|
|
if(op_ptr == std::end(options_)) {
|
|
// If a subcommand, try the master command
|
|
if(parent_ != nullptr && fallthrough_)
|
|
return parent_->_parse_short(args);
|
|
// Otherwise, add to missing
|
|
else {
|
|
args.pop_back();
|
|
missing()->emplace_back(detail::Classifer::SHORT, current);
|
|
return;
|
|
}
|
|
}
|
|
|
|
args.pop_back();
|
|
|
|
// Get a reference to the pointer to make syntax bearable
|
|
Option_p &op = *op_ptr;
|
|
|
|
int num = op->get_expected();
|
|
|
|
if(num == 0) {
|
|
op->add_result("");
|
|
parse_order_.push_back(op.get());
|
|
} else if(rest != "") {
|
|
if(num > 0)
|
|
num--;
|
|
op->add_result(rest);
|
|
parse_order_.push_back(op.get());
|
|
rest = "";
|
|
}
|
|
|
|
if(num == -1) {
|
|
while(!args.empty() && _recognize(args.back()) == detail::Classifer::NONE) {
|
|
op->add_result(args.back());
|
|
parse_order_.push_back(op.get());
|
|
args.pop_back();
|
|
}
|
|
} else
|
|
while(num > 0 && !args.empty()) {
|
|
num--;
|
|
std::string current_ = args.back();
|
|
args.pop_back();
|
|
op->add_result(current_);
|
|
parse_order_.push_back(op.get());
|
|
}
|
|
|
|
if(rest != "") {
|
|
rest = "-" + rest;
|
|
args.push_back(rest);
|
|
}
|
|
}
|
|
|
|
/// Parse a long argument, must be at the top of the list
|
|
void _parse_long(std::vector<std::string> &args) {
|
|
std::string current = args.back();
|
|
|
|
std::string name;
|
|
std::string value;
|
|
if(!detail::split_long(current, name, value))
|
|
throw HorribleError("Long:" + args.back());
|
|
|
|
auto op_ptr = std::find_if(
|
|
std::begin(options_), std::end(options_), [name](const Option_p &v) { return v->check_lname(name); });
|
|
|
|
// Option not found
|
|
if(op_ptr == std::end(options_)) {
|
|
// If a subcommand, try the master command
|
|
if(parent_ != nullptr && fallthrough_)
|
|
return parent_->_parse_long(args);
|
|
// Otherwise, add to missing
|
|
else {
|
|
args.pop_back();
|
|
missing()->emplace_back(detail::Classifer::LONG, current);
|
|
return;
|
|
}
|
|
}
|
|
|
|
args.pop_back();
|
|
|
|
// Get a reference to the pointer to make syntax bearable
|
|
Option_p &op = *op_ptr;
|
|
|
|
int num = op->get_expected();
|
|
|
|
if(value != "") {
|
|
if(num != -1)
|
|
num--;
|
|
op->add_result(value);
|
|
parse_order_.push_back(op.get());
|
|
} else if(num == 0) {
|
|
op->add_result("");
|
|
parse_order_.push_back(op.get());
|
|
}
|
|
|
|
if(num == -1) {
|
|
while(!args.empty() && _recognize(args.back()) == detail::Classifer::NONE) {
|
|
op->add_result(args.back());
|
|
parse_order_.push_back(op.get());
|
|
args.pop_back();
|
|
}
|
|
} else
|
|
while(num > 0 && !args.empty()) {
|
|
num--;
|
|
op->add_result(args.back());
|
|
parse_order_.push_back(op.get());
|
|
args.pop_back();
|
|
}
|
|
return;
|
|
}
|
|
};
|
|
|
|
namespace detail {
|
|
/// This class is simply to allow tests access to App's protected functions
|
|
struct AppFriend {
|
|
|
|
/// Wrap _parse_short, perfectly forward arguments and return
|
|
template <typename... Args>
|
|
static auto parse_short(App *app, Args &&... args) ->
|
|
typename std::result_of<decltype (&App::_parse_short)(App, Args...)>::type {
|
|
return app->_parse_short(std::forward<Args>(args)...);
|
|
}
|
|
|
|
/// Wrap _parse_long, perfectly forward arguments and return
|
|
template <typename... Args>
|
|
static auto parse_long(App *app, Args &&... args) ->
|
|
typename std::result_of<decltype (&App::_parse_long)(App, Args...)>::type {
|
|
return app->_parse_long(std::forward<Args>(args)...);
|
|
}
|
|
|
|
/// Wrap _parse_subcommand, perfectly forward arguments and return
|
|
template <typename... Args>
|
|
static auto parse_subcommand(App *app, Args &&... args) ->
|
|
typename std::result_of<decltype (&App::_parse_subcommand)(App, Args...)>::type {
|
|
return app->_parse_subcommand(std::forward<Args>(args)...);
|
|
}
|
|
};
|
|
} // namespace detail
|
|
|
|
} // namespace CLI
|