Go to the documentation of this file.
35 #define CLI11_PARSE(app, argc, argv) \
37 (app).parse((argc), (argv)); \
38 } catch(const CLI::ParseError &e) { \
39 return (app).exit(e); \
48 namespace FailureMessage {
59 using App_p = std::shared_ptr<App>;
152 using missing_t = std::vector<std::pair<detail::Classifier, std::string>>;
255 App(std::string app_description, std::string app_name,
App *parent)
293 explicit App(std::string app_description =
"", std::string app_name =
"")
294 :
App(app_description, app_name, nullptr) {
295 set_help_flag(
"-h,--help",
"Print this help message and exit");
298 App(
const App &) =
delete;
302 virtual ~App() =
default;
369 throw(
OptionAlreadyAdded(
"alias already matches an existing subcommand: " + app_name));
468 throw OptionAlreadyAdded(
"ignore case would cause subcommand name conflicts: " + match);
502 throw OptionAlreadyAdded(
"ignore underscore would cause subcommand name conflicts: " + match);
517 formatter_ = std::make_shared<FormatterLambda>(fmt);
553 std::string option_description =
"",
554 bool defaulted =
false,
555 std::function<std::string()> func = {}) {
556 Option myopt{option_name, option_description, option_callback,
this};
563 option.reset(
new Option(option_name, option_description, option_callback,
this));
566 option->default_function(func);
570 option->capture_default_str();
576 if(!defaulted && option->get_always_capture_default())
577 option->capture_default_str();
583 auto &matchname = opt->matching_name(myopt);
584 if(!matchname.empty()) {
593 template <
typename AssignTo,
594 typename ConvertTo = AssignTo,
598 std::string option_description =
"",
599 bool defaulted =
false) {
602 return detail::lexical_conversion<AssignTo, ConvertTo>(res, variable);
605 Option *opt =
add_option(option_name, fun, option_description, defaulted, [&variable]() {
606 return CLI::detail::checked_to_string<AssignTo, ConvertTo>(variable);
608 opt->
type_name(detail::type_name<ConvertTo>());
613 opt->
type_size((std::max)(Tcount, XCcount));
620 template <
typename T>
622 const std::function<
void(
const T &)> &func,
623 std::string option_description =
"") {
627 bool result = detail::lexical_conversion<T, T>(res, variable);
634 Option *opt =
add_option(option_name, std::move(fun), option_description,
false);
647 template <
typename T,
663 if(!flag_name.empty()) {
680 if(!help_name.empty()) {
690 Option *_add_flag_internal(std::string flag_name,
CLI::callback_t fun, std::string flag_description) {
696 opt =
add_option(std::move(flag_name), std::move(fun), std::move(flag_description),
false);
697 for(
const auto &fname : flag_defaults)
698 opt->
fnames_.push_back(fname.first);
701 opt =
add_option(std::move(flag_name), std::move(fun), std::move(flag_description),
false);
705 auto pos_name = opt->
get_name(
true);
707 throw IncorrectConstruction::PositionalFlag(pos_name);
722 template <
typename T,
726 return _add_flag_internal(flag_name,
CLI::callback_t(), flag_description);
731 template <
typename T,
735 std::string flag_description =
"") {
739 detail::sum_flag_vector(res, flag_count);
740 }
catch(
const std::invalid_argument &) {
745 return _add_flag_internal(flag_name, std::move(fun), std::move(flag_description))
751 template <
typename T,
754 !std::is_constructible<std::function<
void(
int)>, T>::value,
758 std::string flag_description =
"") {
771 std::vector<T> &flag_results,
772 std::string flag_description =
"") {
775 for(
const auto &elem : res) {
776 flag_results.emplace_back();
781 return _add_flag_internal(flag_name, std::move(fun), std::move(flag_description))
788 std::function<
void(
void)>
function,
789 std::string flag_description =
"") {
794 if(result && trigger) {
799 return _add_flag_internal(flag_name, std::move(fun), std::move(flag_description));
804 std::function<
void(std::int64_t)>
function,
805 std::string flag_description =
"") {
808 std::int64_t flag_count = 0;
809 detail::sum_flag_vector(res, flag_count);
810 function(flag_count);
813 return _add_flag_internal(flag_name, std::move(fun), std::move(flag_description))
820 std::function<
void(std::int64_t)>
function,
821 std::string flag_description =
"") {
822 return add_flag_function(std::move(flag_name), std::move(
function), std::move(flag_description));
827 template <
typename T>
831 std::string option_description =
"") {
833 Option *opt =
add_option(option_name, member, std::move(option_description));
839 template <
typename T>
842 const std::set<T> &options,
843 std::string option_description =
"") {
845 Option *opt =
add_option(option_name, member, std::move(option_description));
851 template <
typename T>
855 std::string option_description,
858 Option *opt =
add_option(option_name, member, std::move(option_description), defaulted);
864 template <
typename T>
867 const std::set<T> &options,
868 std::string option_description,
871 Option *opt =
add_option(option_name, member, std::move(option_description), defaulted);
877 template <
typename T,
typename XC =
double>
880 std::string option_description =
"",
881 bool defaulted =
false,
882 std::string label =
"COMPLEX") {
887 if(res.size() >= 2 && !res[1].empty()) {
889 if(str1.back() ==
'i' || str1.back() ==
'j')
893 auto str1 = res.front();
894 auto nloc = str1.find_last_of(
'-');
895 if(nloc != std::string::npos && nloc > 0) {
897 str1 = str1.substr(nloc);
898 if(str1.back() ==
'i' || str1.back() ==
'j')
902 if(str1.back() ==
'i' || str1.back() ==
'j') {
917 auto default_function = [&variable]() {
return CLI::detail::checked_to_string<T, T>(variable); };
920 add_option(option_name, std::move(fun), std::move(option_description), defaulted, default_function);
928 std::string default_filename =
"",
929 const std::string &help_message =
"Read an ini file",
930 bool config_required =
false) {
939 if(!option_name.empty()) {
941 if(config_required) {
944 if(!default_filename.empty()) {
957 op->remove_needs(opt);
958 op->remove_excludes(opt);
968 if(iterator != std::end(
options_)) {
976 template <
typename T = Option_group>
978 auto option_group = std::make_shared<T>(std::move(group_description), group_name,
this);
979 auto ptr = option_group.get();
981 App_p app_ptr = std::dynamic_pointer_cast<App>(option_group);
991 App *
add_subcommand(std::string subcommand_name =
"", std::string subcommand_description =
"") {
995 CLI::App_p subcom = std::shared_ptr<App>(
new App(std::move(subcommand_description), subcommand_name,
this));
1005 if(!mstrg.empty()) {
1006 throw(
OptionAlreadyAdded(
"subcommand name or alias matches existing subcommand: " + mstrg));
1008 subcom->parent_ =
this;
1017 sub->remove_excludes(subcom);
1018 sub->remove_needs(subcom);
1021 auto iterator = std::find_if(
1032 if(subcom ==
nullptr)
1035 if(subcomptr.get() == subcom)
1036 return subcomptr.get();
1050 auto uindex =
static_cast<unsigned>(index);
1059 if(subcom ==
nullptr)
1062 if(subcomptr.get() == subcom)
1070 if(subcomptr->check_name(subcom))
1078 auto uindex =
static_cast<unsigned>(index);
1088 if(app->name_.empty() && app->group_ == group_name) {
1105 cnt += opt->
count();
1108 cnt += sub->count_all();
1189 explicit operator bool()
const {
return parsed_ > 0; }
1222 void parse(
int argc,
const char *
const *argv) {
1229 std::vector<std::string> args;
1230 args.reserve(
static_cast<std::size_t
>(argc) - 1);
1231 for(
int i = argc - 1; i > 0; i--)
1232 args.emplace_back(argv[i]);
1233 parse(std::move(args));
1240 void parse(std::string commandline,
bool program_name_included =
false) {
1242 if(program_name_included) {
1248 commandline = std::move(nstr.second);
1253 if(!commandline.empty()) {
1261 args.erase(std::remove(args.begin(), args.end(), std::string{}), args.end());
1262 std::reverse(args.begin(), args.end());
1264 parse(std::move(args));
1269 void parse(std::vector<std::string> &args) {
1289 void parse(std::vector<std::string> &&args) {
1314 int exit(
const Error &e, std::ostream &out = std::cout, std::ostream &err = std::cerr)
const {
1320 if(e.
get_name() ==
"CallForHelp") {
1325 if(e.
get_name() ==
"CallForAllHelp") {
1352 std::vector<const App *> subcomms(
subcommands_.size());
1358 subcomms.erase(std::remove_if(std::begin(subcomms),
1360 [&filter](
const App *app) {
return !filter(app); }),
1361 std::end(subcomms));
1377 std::remove_if(std::begin(subcomms), std::end(subcomms), [&filter](
App *app) {
return !filter(app); }),
1378 std::end(subcomms));
1395 if(opt ==
nullptr) {
1404 if(app ==
nullptr) {
1419 if(opt ==
nullptr) {
1427 if(app ==
nullptr) {
1453 auto other_app = *iterator;
1455 other_app->remove_excludes(
this);
1485 footer_ = std::move(footer_string);
1495 std::string
config_to_str(
bool default_also =
false,
bool write_description =
false)
const {
1509 if(!selected_subcommands.empty()) {
1510 return selected_subcommands.at(0)->help(prev, mode);
1512 return formatter_->make_help(
this, prev, mode);
1528 #if defined(__cpp_rtti) || (defined(__GXX_RTTI) && __GXX_RTTI) || (defined(_HAS_STATIC_RTTI) && (_HAS_STATIC_RTTI == 0))
1545 std::vector<const Option *>
get_options(
const std::function<
bool(
const Option *)> filter = {})
const {
1546 std::vector<const Option *> options(
options_.size());
1552 options.erase(std::remove_if(std::begin(options),
1554 [&filter](
const Option *opt) {
return !filter(opt); }),
1563 std::vector<Option *> options(
options_.size());
1570 std::remove_if(std::begin(options), std::end(options), [&filter](Option *opt) {
return !filter(opt); }),
1586 if(subc->get_name().empty()) {
1587 auto opt = subc->get_option_no_throw(option_name);
1588 if(opt !=
nullptr) {
1605 if(subc->get_name().empty()) {
1606 auto opt = subc->get_option_no_throw(option_name);
1607 if(opt !=
nullptr) {
1618 if(opt ==
nullptr) {
1627 if(opt ==
nullptr) {
1739 std::string local_name =
name_;
1749 if(local_name == name_to_check) {
1759 if(les == name_to_check) {
1768 std::vector<std::string> groups;
1772 if(std::find(groups.begin(), groups.end(), opt->
get_group()) == groups.end()) {
1784 std::vector<std::string>
remaining(
bool recurse =
false)
const {
1785 std::vector<std::string> miss_list;
1786 for(
const std::pair<detail::Classifier, std::string> &miss :
missing_) {
1787 miss_list.push_back(std::get<1>(miss));
1793 if(sub->name_.empty() && !sub->missing_.empty()) {
1794 for(
const std::pair<detail::Classifier, std::string> &miss : sub->missing_) {
1795 miss_list.push_back(std::get<1>(miss));
1803 std::vector<std::string> output = sub->remaining(recurse);
1804 std::copy(std::begin(output), std::end(output), std::back_inserter(miss_list));
1812 std::vector<std::string> miss_list =
remaining(recurse);
1813 std::reverse(std::begin(miss_list), std::end(miss_list));
1819 auto remaining_options =
static_cast<std::size_t
>(std::count_if(
1820 std::begin(
missing_), std::end(
missing_), [](
const std::pair<detail::Classifier, std::string> &val) {
1826 remaining_options += sub->remaining_size(recurse);
1829 return remaining_options;
1847 opt->get_required();
1849 if(pcount - pcount_req > 1) {
1854 std::size_t nameless_subs{0};
1857 if(app->get_name().empty())
1864 throw(
InvalidError(
"Required min options greater than required max options",
1869 throw(
InvalidError(
"Required min options greater than number of available options",
1885 if(app->has_automatic_name_) {
1888 if(app->name_.empty()) {
1889 app->fallthrough_ =
false;
1890 app->prefix_command_ =
false;
1893 app->parent_ =
this;
1906 subc->run_callback(
true);
1910 if(subc->name_.empty() && subc->count_all() > 0) {
1911 subc->run_callback(
true);
1930 if(com !=
nullptr) {
1939 std::string dummy1, dummy2;
1948 if(dummy1[0] >=
'0' && dummy1[0] <=
'9') {
1957 if((current ==
"++") && !
name_.empty() &&
parent_ !=
nullptr)
1970 if(config_file.empty()) {
1971 if(config_required) {
1972 throw FileError::Missing(
"no specified config file");
1986 if(config_required || file_given)
1989 }
else if(config_required || file_given) {
1990 throw FileError::Missing(config_file);
1999 char *buffer =
nullptr;
2000 std::string ename_string;
2005 if(_dupenv_s(&buffer, &sz, opt->
envname_.c_str()) == 0 && buffer !=
nullptr) {
2006 ename_string = std::string(buffer);
2011 buffer = std::getenv(opt->
envname_.c_str());
2012 if(buffer !=
nullptr)
2013 ename_string = std::string(buffer);
2016 if(!ename_string.empty()) {
2023 if(sub->get_name().empty() || !sub->parse_complete_callback_)
2024 sub->_process_env();
2033 if(sub->get_name().empty() && sub->parse_complete_callback_) {
2034 if(sub->count_all() > 0) {
2035 sub->_process_callbacks();
2036 sub->run_callback();
2047 if(!sub->parse_complete_callback_) {
2048 sub->_process_callbacks();
2060 if(help_ptr !=
nullptr && help_ptr->
count() > 0)
2061 trigger_help =
true;
2062 if(help_all_ptr !=
nullptr && help_all_ptr->
count() > 0)
2063 trigger_all_help =
true;
2068 sub->_process_help_flags(trigger_help, trigger_all_help);
2071 }
else if(trigger_all_help) {
2073 }
else if(trigger_help) {
2081 bool excluded{
false};
2082 std::string excluder;
2084 if(opt->
count() > 0) {
2090 if(subc->count_all() > 0) {
2092 excluder = subc->get_display_name();
2104 bool missing_needed{
false};
2105 std::string missing_need;
2107 if(opt->
count() == 0) {
2108 missing_needed =
true;
2113 if(subc->count_all() == 0) {
2114 missing_needed =
true;
2115 missing_need = subc->get_display_name();
2118 if(missing_needed) {
2126 std::size_t used_options = 0;
2129 if(opt->
count() != 0) {
2138 if(opt->
count() > 0 && opt_req->
count() == 0)
2159 if(sub->name_.empty() && sub->count_all() > 0) {
2166 if(option_list.compare(0, 10,
"-h,--help,") == 0) {
2167 option_list.erase(0, 10);
2170 if(!subc_list.empty()) {
2180 if(sub->name_.empty() && sub->required_ ==
false) {
2181 if(sub->count_all() == 0) {
2194 if(sub->count() > 0 || sub->name_.empty()) {
2195 sub->_process_requirements();
2198 if(sub->required_ && sub->count_all() == 0) {
2217 if(num_left_over > 0) {
2223 if(sub->count() > 0)
2224 sub->_process_extras();
2233 if(num_left_over > 0) {
2240 if(sub->count() > 0)
2241 sub->_process_extras(args);
2249 if(sub->get_name().empty())
2250 sub->increment_parsed();
2254 void _parse(std::vector<std::string> &args) {
2257 bool positional_only =
false;
2259 while(!args.empty()) {
2283 void _parse(std::vector<std::string> &&args) {
2288 bool positional_only =
false;
2290 while(!args.empty()) {
2306 throw ConfigError::Extras(item.fullname());
2312 if(level < item.
parents.size()) {
2315 auto result = subcom->_parse_single_config(item, level + 1);
2323 if(item.
name ==
"++") {
2334 if(item.
name ==
"--") {
2352 throw ConfigError::NotConfigurable(item.
fullname());
2376 switch(classifier) {
2379 positional_only =
true;
2404 positional_only =
true;
2409 throw HorribleError(
"unrecognized classifier (you should not see this!)");
2417 std::size_t retval = 0;
2445 const std::string &positional = args.back();
2449 auto arg_rem = args.size();
2451 if(arg_rem <= remreq) {
2456 std::string pos = positional;
2457 pos = opt->_validate(pos, 0);
2476 std::string pos = positional;
2477 pos = opt->_validate(pos, 0);
2490 if((subc->name_.empty()) && (!subc->disabled_)) {
2491 if(subc->_parse_positional(args,
false)) {
2492 if(!subc->pre_parse_called_) {
2493 subc->_trigger_pre_parse(args.size());
2506 if(haltOnSubcommand) {
2517 if(com !=
nullptr && (com->parent_->require_subcommand_max_ == 0 ||
2518 com->parent_->require_subcommand_max_ > com->parent_->parsed_subcommands_.size())) {
2533 while(!args.empty()) {
2546 if(com->disabled_ && ignore_disabled)
2548 if(com->get_name().empty()) {
2549 auto subc = com->
_find_subcommand(subc_name, ignore_disabled, ignore_used);
2550 if(subc !=
nullptr) {
2554 if(com->check_name(subc_name)) {
2555 if((!*com) || !ignore_used)
2572 if(com !=
nullptr) {
2576 auto parent_app = com->parent_;
2577 while(parent_app !=
this) {
2578 parent_app->_trigger_pre_parse(args.size());
2579 parent_app->parsed_subcommands_.push_back(com);
2580 parent_app = parent_app->parent_;
2586 throw HorribleError(
"Subcommand " + args.back() +
" missing");
2594 std::string current = args.back();
2596 std::string arg_name;
2600 switch(current_type) {
2603 throw HorribleError(
"Long parsed but missing (you should not see this):" + args.back());
2607 throw HorribleError(
"Short parsed but missing! You should not see this");
2611 throw HorribleError(
"windows option parsed but missing! You should not see this");
2618 throw HorribleError(
"parsing got called with invalid option! You should not see this");
2624 return opt->check_lname(arg_name);
2626 return opt->check_sname(arg_name);
2628 return opt->check_lname(arg_name) || opt->check_sname(arg_name);
2634 if(subc->name_.empty() && !subc->disabled_) {
2635 if(subc->_parse_arg(args, current_type)) {
2636 if(!subc->pre_parse_called_) {
2637 subc->_trigger_pre_parse(args.size());
2661 int min_num = (std::min)(op->get_type_size_min(), op->get_items_expected_min());
2662 int max_num = op->get_items_expected_max();
2666 int result_count = 0;
2669 auto res = op->get_flag_value(arg_name, value);
2670 op->add_result(res);
2672 }
else if(!value.empty()) {
2673 op->add_result(value, result_count);
2675 collected += result_count;
2677 }
else if(!rest.empty()) {
2678 op->add_result(rest, result_count);
2681 collected += result_count;
2685 while(min_num > collected && !args.empty()) {
2686 std::string current_ = args.back();
2688 op->add_result(current_, result_count);
2690 collected += result_count;
2693 if(min_num > collected) {
2694 throw ArgumentMismatch::TypedAtLeast(op->get_name(), min_num, op->get_type_name());
2697 if(max_num > collected || op->get_allow_extra_args()) {
2700 while((collected < max_num || op->get_allow_extra_args()) && !args.empty() &&
2703 if(remreqpos >= args.size()) {
2707 op->add_result(args.back(), result_count);
2710 collected += result_count;
2717 if(min_num == 0 && max_num > 0 && collected == 0) {
2718 auto res = op->get_flag_value(arg_name, std::string{});
2719 op->add_result(res);
2725 if(min_num > 0 && op->get_type_size_max() != min_num && collected % op->get_type_size_max() != 0) {
2726 op->add_result(std::string{});
2731 args.push_back(rest);
2744 if(!
name_.empty()) {
2760 auto fallthrough_parent =
parent_;
2761 while((fallthrough_parent->parent_ !=
nullptr) && (fallthrough_parent->get_name().empty())) {
2762 fallthrough_parent = fallthrough_parent->
parent_;
2764 return fallthrough_parent;
2769 static const std::string estring;
2774 if(subc.get() != &subcom) {
2775 if(subc->disabled_) {
2779 if(subc->check_name(subcom.
get_name())) {
2783 if(!subc->get_name().empty()) {
2785 return subc->get_name();
2788 for(
const auto &les : subcom.
aliases_) {
2789 if(subc->check_name(les)) {
2794 for(
const auto &les : subc->aliases_) {
2800 if(subc->get_name().empty()) {
2802 if(!cmpres.empty()) {
2809 if(!cmpres.empty()) {
2820 missing_.emplace_back(val_type, val);
2825 if(subc->name_.empty() && subc->allow_extras_) {
2826 subc->missing_.emplace_back(val_type, val);
2831 missing_.emplace_back(val_type, val);
2837 if(opt ==
nullptr) {
2843 if(app == subc.get()) {
2859 if(iterator != std::end(
options_)) {
2860 const auto &opt_p = *iterator;
2862 return (*v == *opt_p);
2865 app->
options_.push_back(std::move(*iterator));
2880 :
App(std::move(group_description),
"", parent) {
2904 subc->get_parent()->remove_subcommand(subcom);
2917 inline void TriggerOn(
App *trigger_app, std::vector<App *> apps_to_enable) {
2918 for(
auto &app : apps_to_enable) {
2919 app->enabled_by_default(
false);
2920 app->disabled_by_default();
2924 for(
auto &app : apps_to_enable) {
2925 app->disabled(
false);
2939 for(
auto &app : apps_to_enable) {
2940 app->disabled_by_default(
false);
2941 app->enabled_by_default();
2945 for(
auto &app : apps_to_enable) {
2953 Validator deprecate_warning{[opt, replacement](std::string &) {
2954 std::cout << opt->
get_name() <<
" is deprecated please use '" << replacement
2956 return std::string();
2959 deprecate_warning.application_index(0);
2960 opt->
check(deprecate_warning);
2961 if(!replacement.empty()) {
2987 auto opt2 = app->
add_option(option_copy->get_name(
false,
true),
"option has been retired and has no effect")
2990 ->
type_size(option_copy->get_type_size_min(), option_copy->get_type_size_max())
2991 ->
expected(option_copy->get_expected_min(), option_copy->get_expected_max())
2994 Validator retired_warning{[opt2](std::string &) {
2995 std::cout <<
"WARNING " << opt2->
get_name() <<
" is retired and has no effect\n";
2996 return std::string();
2999 retired_warning.application_index(0);
3000 opt2->check(retired_warning);
3010 if(opt !=
nullptr) {
3014 auto opt2 = app->
add_option(option_name,
"option has been retired and has no effect")
3018 Validator retired_warning{[opt2](std::string &) {
3019 std::cout <<
"WARNING " << opt2->
get_name() <<
" is retired and has no effect\n";
3020 return std::string();
3023 retired_warning.application_index(0);
3024 opt2->check(retired_warning);
3030 namespace FailureMessage {
3034 std::string header = std::string(e.what()) +
"\n";
3035 std::vector<std::string> names;
3046 header +=
"Run with " +
detail::join(names,
" or ") +
" for more information.\n";
3053 std::string header = std::string(
"ERROR: ") + e.
get_name() +
": " + e.what() +
"\n";
3054 header += app->
help();
3066 template <
typename... Args>
static decltype(
auto)
parse_arg(
App *app, Args &&... args) {
3067 return app->
_parse_arg(std::forward<Args>(args)...);
3071 template <
typename... Args>
static decltype(
auto)
parse_subcommand(
App *app, Args &&... args) {
3075 template <
typename... Args>
3079 return app->
_parse_arg(std::forward<Args>(args)...);
3083 template <
typename... Args>
const std::string & _compare_subcommand_names(const App &subcom, const App &base) const
Helper function to run through all possible comparisons of subcommand names to check there is no over...
Definition: App.hpp:2768
App * allow_windows_style_options(bool value=true)
Definition: App.hpp:477
std::shared_ptr< App > App_p
Definition: App.hpp:59
App * add_subcommand(App *subcom)
Add an existing subcommand to be a member of an option_group.
Definition: App.hpp:2902
bool get_disabled() const
Get the status of disabled.
Definition: App.hpp:1685
bool fallthrough_
Allow subcommand fallthrough, so that parent commands can collect commands after subcommand....
Definition: App.hpp:194
void _process_config_file()
Read and process a configuration file (main app only)
Definition: App.hpp:1965
bool allow_windows_style_options_
Allow '/' for options for Windows like options. Defaults to true on Windows, false otherwise....
Definition: App.hpp:197
bool check_name(std::string name) const
Check a name. Requires "-" or "--" for short / long, supports positional name.
Definition: Option.hpp:839
App * required(bool require=true)
Remove the error when extras are left over on the command line.
Definition: App.hpp:385
std::shared_ptr< Config > config_formatter_
This is the formatter for help printing. Default provided. INHERITABLE (same pointer)
Definition: App.hpp:250
std::string help(const App *app, const Error &e)
Printout the full help string on error (if this fn is set, the old default for CLI11)
Definition: App.hpp:3052
std::string name
This is the name.
Definition: ConfigFwd.hpp:28
App * alias(std::string app_name)
Set an alias for the app.
Definition: App.hpp:359
Thrown when parsing an INI file and it is missing.
Definition: Error.hpp:179
const Option * get_option_no_throw(std::string option_name) const noexcept
Get an option by name (noexcept const version)
Definition: App.hpp:1597
void add_options(Option *opt)
Add an existing option to the Option_group.
Definition: App.hpp:2894
std::string name_
Subcommand name or program name (from parser if name is empty)
Definition: App.hpp:77
OptionDefaults option_defaults_
The default values for options, customizable and changeable INHERITABLE.
Definition: App.hpp:121
bool get_required() const
True if this is a required option.
Definition: Option.hpp:118
App & operator=(const App &)=delete
bool remove_excludes(App *app)
Removes a subcommand from the excludes list of this subcommand.
Definition: App.hpp:1448
This class is simply to allow tests access to App's protected functions.
Definition: App.hpp:3062
enabler
Simple empty scoped class.
Definition: TypeTools.hpp:26
bool prefix_command_
If true, return immediately on an unrecognized option (implies allow_extras) INHERITABLE.
Definition: App.hpp:90
constexpr int expected_max_vector_size
Definition: StringTools.hpp:39
Option * get_help_ptr()
Get a pointer to the help flag.
Definition: App.hpp:1702
missing_t missing_
Definition: App.hpp:157
void _configure()
Definition: App.hpp:1878
App * allow_config_extras(bool allow=true)
ignore extras in config files
Definition: App.hpp:438
std::vector< const Option * > get_options(const std::function< bool(const Option *)> filter={}) const
Get the list of options (user facing function, so returns raw pointers), has optional filter function...
Definition: App.hpp:1545
std::set< App * > need_subcommands_
Definition: App.hpp:174
Thrown when an excludes option is present.
Definition: Error.hpp:280
std::vector< std::string > remaining_for_passthrough(bool recurse=false) const
This returns the missing options in a form ready for processing by another command line program.
Definition: App.hpp:1811
App * add_subcommand(CLI::App_p subcom)
Add a previously created app as a subcommand.
Definition: App.hpp:1000
Some validators that are provided.
Definition: Validators.hpp:74
bool ignore_underscore_
If true, the program should ignore underscores INHERITABLE.
Definition: App.hpp:191
App * get_subcommand(std::string subcom) const
Check to see if a subcommand is part of this command (text version)
Definition: App.hpp:1041
@ Normal
The normal, detailed help.
App * add_subcommand(std::string subcommand_name="", std::string subcommand_description="")
Add a subcommand. Inherits INHERITABLE and OptionDefaults, and help flag.
Definition: App.hpp:991
-h or –help on command line
Definition: Error.hpp:160
App * formatter_fn(std::function< std::string(const App *, std::string, AppFormatMode)> fmt)
Set the help formatter.
Definition: App.hpp:516
std::vector< std::pair< std::string, std::string > > default_flag_values_
Definition: Option.hpp:246
bool get_immediate_callback() const
Get the status of disabled.
Definition: App.hpp:1688
const Option * get_option(std::string option_name) const
Get an option by name.
Definition: App.hpp:1616
bool remove_needs(App *app)
Removes a subcommand from the needs list of this subcommand.
Definition: App.hpp:1470
Option * set_config(std::string option_name="", std::string default_filename="", const std::string &help_message="Read an ini file", bool config_required=false)
Set a configuration ini file option, or clear it if no name passed.
Definition: App.hpp:927
Option * add_option(std::string option_name, callback_t option_callback, std::string option_description="", bool defaulted=false, std::function< std::string()> func={})
Definition: App.hpp:551
detail::Classifier _recognize(const std::string ¤t, bool ignore_used_subcommands=true) const
Selects a Classifier enum based on the type of the current argument.
Definition: App.hpp:1938
App * immediate_callback(bool immediate=true)
Set the subcommand callback to be executed immediately on subcommand completion.
Definition: App.hpp:419
std::size_t require_subcommand_max_
Max number of subcommands allowed (parsing stops after this number). 0 is unlimited INHERITABLE.
Definition: App.hpp:228
void add_options(Option *opt, Args... args)
Add a bunch of options to the group.
Definition: App.hpp:2896
int exit(const Error &e, std::ostream &out=std::cout, std::ostream &err=std::cerr) const
Print a nice error message and return the exit code.
Definition: App.hpp:1314
config_extras_mode get_allow_config_extras() const
Get the status of allow extras.
Definition: App.hpp:1699
App * footer(std::string footer_string)
Set footer.
Definition: App.hpp:1484
Option * description(std::string option_description)
Set the description.
Definition: Option.hpp:717
App * require_subcommand(int value)
Definition: App.hpp:1132
Option * add_option_function(std::string option_name, const std::function< void(const T &)> &func, std::string option_description="")
Add option for a callback of a specific type.
Definition: App.hpp:621
Option * config_ptr_
Pointer to the config option.
Definition: App.hpp:247
void retire_option(App *app, Option *opt)
Helper function to mark an option as retired.
Definition: App.hpp:2979
App * excludes(App *app)
Sets excluded subcommands for the subcommand.
Definition: App.hpp:1403
App * validate_positionals(bool validate=true)
Set the subcommand to validate positional arguments before assigning.
Definition: App.hpp:432
bool got_subcommand(const App *subcom) const
Check to see if given subcommand was selected.
Definition: App.hpp:1385
void parse(int argc, const char *const *argv)
Definition: App.hpp:1222
std::size_t count() const
Definition: App.hpp:1098
const std::vector< std::string > & get_aliases() const
Get the aliases of the current app.
Definition: App.hpp:1726
std::vector< std::string > fnames_
a list of flag names with specified default values;
Definition: Option.hpp:249
bool get_enabled_by_default() const
Get the status of disabled by default.
Definition: App.hpp:1694
bool get_ignore_underscore() const
Check the status of ignore_underscore.
Definition: App.hpp:1643
const std::string & get_name() const
Get the name of the current app.
Definition: App.hpp:1723
Option * add_set(std::string option_name, T &member, std::set< T > options, std::string option_description="")
Add set of options (No default, temp reference, such as an inline set) DEPRECATED.
Definition: App.hpp:828
App * ignore_underscore(bool value=true)
Ignore underscore. Subcommands inherit value.
Definition: App.hpp:495
config_extras_mode
enumeration of modes of how to deal with extras in config files
Definition: App.hpp:55
bool remove_option(Option *opt)
Removes an option from the App. Takes an option pointer. Returns true if found and removed.
Definition: App.hpp:954
int get_type_size_max() const
The maximum number of arguments the option expects.
Definition: Option.hpp:659
App * positionals_at_end(bool value=true)
Specify that the positional arguments are only at the end of the sequence.
Definition: App.hpp:483
std::string get_display_name() const
Get a display name for an app.
Definition: App.hpp:1735
App * final_callback(std::function< void()> app_callback)
Definition: App.hpp:321
void increment_parsed()
Internal function to recursively increment the parsed counter on the current app as well unnamed subc...
Definition: App.hpp:2246
int get_type_size_min() const
The minimum number of arguments the option expects.
Definition: Option.hpp:657
const Option * get_config_ptr() const
Get a pointer to the config option. (const)
Definition: App.hpp:1714
static auto parse_arg(App *app, Args &&... args) -> typename std::result_of< decltype(&App::_parse_arg)(App, Args...)>::type
Wrap _parse_short, perfectly forward arguments and return.
Definition: App.hpp:3077
App * needs(Option *opt)
Definition: App.hpp:1418
const std::string & get_group() const
Get the group of this subcommand.
Definition: App.hpp:1658
App * name(std::string app_name="")
Set a name for the app (empty will use parser to set the name)
Definition: App.hpp:341
bool get_positional() const
True if the argument can be given directly.
Definition: Option.hpp:705
App * require_option(int value)
Definition: App.hpp:1161
bool get_configurable() const
The status of configurable.
Definition: Option.hpp:127
void _process_requirements()
Verify required options and cross requirements. Subcommands too (only if selected).
Definition: App.hpp:2079
App * get_subcommand(int index=0) const
Get a pointer to subcommand by index.
Definition: App.hpp:1048
std::size_t parsed_
Counts the number of times this command/subcommand was parsed.
Definition: App.hpp:222
void _parse_config(std::vector< ConfigItem > &args)
Definition: App.hpp:2303
std::function< void(std::size_t)> pre_parse_callback_
This is a function that runs prior to the start of parsing.
Definition: App.hpp:109
@ TakeLast
take only the last Expected number of arguments
std::vector< std::pair< detail::Classifier, std::string > > missing_t
Definition: App.hpp:152
std::size_t count() const
Count the total number of times an option was passed.
Definition: Option.hpp:348
startup_mode
Definition: App.hpp:207
typename std::enable_if< B, T >::type enable_if_t
Definition: TypeTools.hpp:37
Option * add_option(std::string option_name, AssignTo &variable, std::string option_description="", bool defaulted=false)
Add option for assigning to a variable.
Definition: App.hpp:596
CLI::App_p get_subcommand_ptr(std::string subcom) const
Check to see if a subcommand is part of this command (text version)
Definition: App.hpp:1068
bool get_disabled_by_default() const
Get the status of disabled by default.
Definition: App.hpp:1691
std::vector< std::pair< std::string, std::string > > get_default_flag_values(const std::string &str)
extract default flag values either {def} or starting with a !
Definition: Split.hpp:75
std::set< Option * > needs_
A list of options that are required with this option.
Definition: Option.hpp:294
void TriggerOff(App *trigger_app, App *app_to_enable)
Helper function to disable one option group/subcommand when another is used.
Definition: App.hpp:2931
void _validate() const
Definition: App.hpp:1839
Option * type_size(int option_type_size)
Set a custom option size.
Definition: Option.hpp:1025
App * excludes(Option *opt)
Sets excluded options for the subcommand.
Definition: App.hpp:1394
Extension of App to better manage groups of options.
Definition: App.hpp:2877
bool required_
If set to true the subcommand is required to be processed and used, ignored for main app.
Definition: App.hpp:96
void parse(std::vector< std::string > &&args)
The real work is done here. Expects a reversed vector.
Definition: App.hpp:1289
App * footer(std::function< std::string()> footer_function)
Set footer.
Definition: App.hpp:1489
Option * add_flag(std::string flag_name, T &flag_result, std::string flag_description="")
Definition: App.hpp:756
Option * get_option_no_throw(std::string option_name) noexcept
Get an option by name (noexcept non-const version)
Definition: App.hpp:1578
std::string get_name(bool positional=false, bool all_options=false) const
Gets a comma separated list of names. Will include / prefer the positional name if positional is true...
Definition: Option.hpp:730
Option * expected(int value)
Set the number of expected arguments.
Definition: Option.hpp:367
bool check_name(std::string name_to_check) const
Check the name, case insensitive and underscore insensitive if set.
Definition: App.hpp:1738
Option * add_mutable_set(std::string option_name, T &member, const std::set< T > &options, std::string option_description, bool defaulted)
Add set of options (with default, set can be changed afterwards - do not destroy the set) DEPRECATED.
Definition: App.hpp:865
virtual ~App()=default
virtual destructor
Option * add_flag(std::string flag_name, std::vector< T > &flag_results, std::string flag_description="")
Vector version to capture multiple flags.
Definition: App.hpp:770
std::vector< App * > get_subcommands(const std::function< bool(App *)> &filter)
Definition: App.hpp:1369
App * require_subcommand(std::size_t min, std::size_t max)
Definition: App.hpp:1145
Option * set_help_flag(std::string flag_name="", const std::string &help_description="")
Set a help flag, replace the existing one if present.
Definition: App.hpp:655
int get_expected_max() const
The max number of times the option expects to be included.
Definition: Option.hpp:691
static App * get_fallthrough_parent(App *app)
Wrap the fallthrough parent function to make sure that is working correctly.
Definition: App.hpp:3090
std::string join(const T &v, std::string delim=",")
Simple function to join a string.
Definition: StringTools.hpp:59
std::size_t count(std::string option_name) const
Counts the number of times the given option was passed.
Definition: App.hpp:1343
bool _valid_subcommand(const std::string ¤t, bool ignore_used=true) const
Check to see if a subcommand is valid. Give up immediately if subcommand max has been reached.
Definition: App.hpp:1924
config_extras_mode allow_config_extras_
Definition: App.hpp:87
const std::string & get_name() const
Get the name of the Validator.
Definition: Validators.hpp:156
bool get_allow_windows_style_options() const
Check the status of the allow windows style options.
Definition: App.hpp:1649
std::set< Option * > excludes_
A list of options that are excluded with this option.
Definition: Option.hpp:297
void run_callback(bool final_mode=false)
Internal function to run (App) callback, bottom up.
Definition: App.hpp:1898
std::string fullname() const
The list of parents and name joined by ".".
Definition: ConfigFwd.hpp:34
std::vector< App * > parsed_subcommands_
This is a list of the subcommands collected, in order.
Definition: App.hpp:163
path_type check_path(const char *file) noexcept
get the type of the path from a file name
Definition: Validators.hpp:321
std::shared_ptr< FormatterBase > get_formatter() const
Access the formatter.
Definition: App.hpp:1520
App * parse_complete_callback(std::function< void()> pc_callback)
Definition: App.hpp:328
App * _get_fallthrough_parent()
Get the appropriate parent to fallthrough to which is the first one that has a name or the main app.
Definition: App.hpp:2756
std::shared_ptr< FormatterBase > formatter_
This is the formatter for help printing. Default provided. INHERITABLE (same pointer)
Definition: App.hpp:143
auto to_string(T &&value) -> decltype(std::forward< T >(value))
Convert an object to a string (directly forward if this can become a string)
Definition: TypeTools.hpp:226
int get_exit_code() const
Definition: Error.hpp:72
std::string envname_
If given, check the environment for this option.
Definition: Option.hpp:255
bool ignore_case_
If true, the program name is not case sensitive INHERITABLE.
Definition: App.hpp:188
bool lexical_cast(const std::string &input, T &output)
Signed integers.
Definition: TypeTools.hpp:609
@ TakeAll
just get all the passed argument regardless
void parse(std::string commandline, bool program_name_included=false)
Definition: App.hpp:1240
App * disabled_by_default(bool disable=true)
Set the subcommand to be disabled by default, so on clear(), at the start of each parse it is disable...
Definition: App.hpp:397
bool get_configurable() const
Check the status of the allow windows style options.
Definition: App.hpp:1655
bool get_required() const
Get the status of required.
Definition: App.hpp:1682
std::function< std::string(const App *, const Error &e)> failure_message_
The error message printing function INHERITABLE.
Definition: App.hpp:146
App * group(std::string group_name)
Changes the group membership.
Definition: App.hpp:1117
bool configurable_
if set to true the subcommand can be triggered via configuration files INHERITABLE
Definition: App.hpp:213
bool valid_name_string(const std::string &str)
Verify an option name.
Definition: StringTools.hpp:184
const Option * get_help_all_ptr() const
Get a pointer to the help all flag. (const)
Definition: App.hpp:1708
void _process()
Process callbacks and such.
Definition: App.hpp:2205
std::size_t require_option_max_
Max number of options allowed. 0 is unlimited (not inheritable)
Definition: App.hpp:234
bool got_subcommand(std::string subcommand_name) const
Check with name instead of pointer to see if subcommand was selected.
Definition: App.hpp:1391
std::size_t get_require_subcommand_min() const
Get the required min subcommand value.
Definition: App.hpp:1664
std::vector< std::string > split_up(std::string str, char delimiter='\0')
Definition: StringTools.hpp:286
App * clear_aliases()
clear all the aliases of the current App
Definition: App.hpp:1729
void _process_help_flags(bool trigger_help=false, bool trigger_all_help=false) const
Definition: App.hpp:2056
bool get_allow_extras() const
Get the status of allow extras.
Definition: App.hpp:1679
std::pair< std::string, std::string > split_program_name(std::string commandline)
Definition: Validators.hpp:1112
std::function< void()> final_callback_
This is a function that runs when all processing has completed.
Definition: App.hpp:114
bool immediate_callback_
Definition: App.hpp:106
App * get_option_group(std::string group_name) const
Check to see if an option group is part of this App.
Definition: App.hpp:1086
void _move_option(Option *opt, App *app)
function that could be used by subclasses of App to shift options around into subcommands
Definition: App.hpp:2836
void copy_to(T *other) const
Copy the contents to another similar class (one based on OptionBase)
Definition: Option.hpp:77
constexpr enabler dummy
An instance to use in EnableIf.
Definition: TypeTools.hpp:29
std::string simple(const App *app, const Error &e)
Printout a clean, simple message on error (the default in CLI11 1.5+)
Definition: App.hpp:3033
std::set< App * > exclude_subcommands_
this is a list of subcommands that are exclusionary to this one
Definition: App.hpp:166
App * prefix_command(bool allow=true)
Do not parse anything after the first unrecognized option and return.
Definition: App.hpp:455
bool get_prefix_command() const
Get the prefix command status.
Definition: App.hpp:1676
std::string get_name() const
Definition: Error.hpp:74
std::size_t require_subcommand_min_
Minimum required subcommands (not inheritable!)
Definition: App.hpp:225
App * _find_subcommand(const std::string &subc_name, bool ignore_disabled, bool ignore_used) const noexcept
Definition: App.hpp:2544
bool positionals_at_end_
specify that positional arguments come at the end of the argument sequence not inheritable
Definition: App.hpp:205
std::vector< std::string > inputs
Listing of inputs.
Definition: ConfigFwd.hpp:31
CRTP * delimiter(char value='\0')
Allow in a configuration file.
Definition: Option.hpp:186
bool split_short(const std::string ¤t, std::string &name, std::string &rest)
Definition: Split.hpp:21
bool has_automatic_name_
If set to true the name was automatically generated from the command line vs a user set name.
Definition: App.hpp:93
Option * check(Validator validator, const std::string &validator_name="")
Adds a Validator with a built in type name.
Definition: Option.hpp:426
App * get_subcommand(const App *subcom) const
Definition: App.hpp:1031
std::vector< std::string > get_groups() const
Get the groups available directly from this option (in order)
Definition: App.hpp:1767
App * config_formatter(std::shared_ptr< Config > fmt)
Set the config formatter.
Definition: App.hpp:522
std::shared_ptr< ConfigBase > get_config_formatter_base() const
Access the config formatter as a configBase pointer.
Definition: App.hpp:1526
App * fallthrough(bool value=true)
Definition: App.hpp:1182
App * require_option()
The argumentless form of require option requires 1 or more options be used.
Definition: App.hpp:1152
App * require_option(std::size_t min, std::size_t max)
Definition: App.hpp:1174
Option * set_help_all_flag(std::string help_name="", const std::string &help_description="")
Set a help all flag, replaced the existing one if present.
Definition: App.hpp:672
std::string find_and_modify(std::string str, std::string trigger, Callable modify)
Definition: StringTools.hpp:276
virtual void pre_callback()
Definition: App.hpp:1198
void failure_message(std::function< std::string(const App *, const Error &e)> function)
Provide a function to print a help message. The function gets access to the App pointer and error.
Definition: App.hpp:1309
std::shared_ptr< Config > get_config_formatter() const
Access the config formatter.
Definition: App.hpp:1523
std::size_t get_require_subcommand_max() const
Get the required max subcommand value.
Definition: App.hpp:1667
std::vector< std::string > remaining(bool recurse=false) const
This returns the missing options from the current subcommand.
Definition: App.hpp:1784
All errors derive from this one.
Definition: Error.hpp:67
Thrown when an option already exists.
Definition: Error.hpp:132
std::vector< std::string > aliases_
Alias names for the subcommand.
Definition: App.hpp:240
void remove_default_flag_values(std::string &flags)
Definition: StringTools.hpp:230
Option * add_option(std::string option_name, T &option_description)
Add option with description but with no variable assignment or callback.
Definition: App.hpp:650
void clear()
Reset the parsed data.
Definition: App.hpp:1205
std::string get_flag_value(const std::string &name, std::string input_value) const
Definition: Option.hpp:878
std::string get_description() const
Get the app or subcommand description.
Definition: App.hpp:1536
std::size_t get_require_option_min() const
Get the required min option value.
Definition: App.hpp:1670
std::vector< App_p > subcommands_
Storage for subcommand list.
Definition: App.hpp:185
std::function< bool(const results_t &)> callback_t
callback function definition
Definition: Option.hpp:28
bool remove_excludes(Option *opt)
Removes an option from the excludes list of this subcommand.
Definition: App.hpp:1438
std::size_t _count_remaining_positionals(bool required_only=false) const
Count the required remaining positional arguments.
Definition: App.hpp:2416
bool disabled_
If set to true the subcommand is disabled and cannot be used, ignored for main app.
Definition: App.hpp:99
bool _parse_subcommand(std::vector< std::string > &args)
Definition: App.hpp:2566
Definition: Option.hpp:231
App * allow_extras(bool allow=true)
Remove the error when extras are left over on the command line.
Definition: App.hpp:379
std::string get_footer() const
Generate and return the footer.
Definition: App.hpp:1661
std::size_t get_require_option_max() const
Get the required max option value.
Definition: App.hpp:1673
std::string to_lower(std::string str)
Return a lower case version of a string.
Definition: StringTools.hpp:199
App(std::string app_description="", std::string app_name="")
Create a new program. Pass in the same arguments as main(), along with a help string.
Definition: App.hpp:293
std::string config_to_str(bool default_also=false, bool write_description=false) const
Definition: App.hpp:1495
Option * type_name(std::string typeval)
Set a custom option typestring.
Definition: Option.hpp:1019
const Option * operator[](const char *option_name) const
Shortcut bracket operator for getting a pointer to an option.
Definition: App.hpp:1637
bool split_windows_style(const std::string ¤t, std::string &name, std::string &value)
Definition: Split.hpp:47
const App * get_parent() const
Get the parent of this subcommand (or nullptr if master app) (const version)
Definition: App.hpp:1720
Option * add_option(std::string option_name)
Add option with no description or variable assignment.
Definition: App.hpp:642
Option * add_flag(std::string flag_name, T &flag_count, std::string flag_description="")
Definition: App.hpp:733
startup_mode default_startup
Definition: App.hpp:210
App * needs(App *app)
Definition: App.hpp:1426
Option * multi_option_policy(MultiOptionPolicy value=MultiOptionPolicy::Throw)
Take the last argument if given multiple times (or another policy)
Definition: Option.hpp:631
Check to see if something is bool (fail check by default)
Definition: TypeTools.hpp:58
ConfigBase ConfigINI
the default Config is the INI file format
Definition: ConfigFwd.hpp:117
std::string remove_underscore(std::string str)
remove underscores from a string
Definition: StringTools.hpp:207
Verify items are in a set.
Definition: Validators.hpp:697
bool get_ignore_case() const
Check the status of ignore_case.
Definition: App.hpp:1640
void parse(std::vector< std::string > &args)
Definition: App.hpp:1269
std::size_t require_option_min_
Minimum required options (not inheritable!)
Definition: App.hpp:231
App * preparse_callback(std::function< void(std::size_t)> pp_callback)
Definition: App.hpp:335
Option * run_callback_for_default(bool value=true)
Definition: Option.hpp:418
bool remove_needs(Option *opt)
Removes an option from the needs list of this subcommand.
Definition: App.hpp:1460
App * parent_
A pointer to the parent if this is a subcommand.
Definition: App.hpp:219
AppFormatMode
Definition: FormatterFwd.hpp:26
const std::string & get_description() const
Get the description.
Definition: Option.hpp:714
std::vector< Option * > parse_order_
This is a list of pointers to options with the original parse order.
Definition: App.hpp:160
bool get_callback_run() const
See if the callback has been run already.
Definition: Option.hpp:1006
std::vector< App * > get_subcommands() const
Definition: App.hpp:1347
Option * add_option(Option *opt)
Add an existing option to the Option_group.
Definition: App.hpp:2886
std::string & trim(std::string &str)
Trim whitespace from string.
Definition: StringTools.hpp:130
std::string footer_
Footer to put after all options in the help output INHERITABLE.
Definition: App.hpp:131
std::string description_
Description of the current program/subcommand.
Definition: App.hpp:80
std::vector< Option_p > options_
The list of options, stored locally.
Definition: App.hpp:124
std::set< Option * > need_options_
Definition: App.hpp:178
std::vector< std::string > results_t
Definition: Option.hpp:26
Option * get_config_ptr()
Get a pointer to the config option.
Definition: App.hpp:1711
Creates a command line program, with very few defaults.
Definition: App.hpp:66
std::set< Option * > exclude_options_
Definition: App.hpp:170
void _parse(std::vector< std::string > &&args)
Internal parse function.
Definition: App.hpp:2283
@ All
A fully expanded help.
Thrown when validation fails before parsing.
Definition: Error.hpp:313
bool _parse_single_config(const ConfigItem &item, std::size_t level=0)
Fill in a single config option.
Definition: App.hpp:2311
App * formatter(std::shared_ptr< FormatterBase > fmt)
Set the help formatter.
Definition: App.hpp:510
bool required_
True if this is a required option.
Definition: Option.hpp:53
void _trigger_pre_parse(std::size_t remaining_args)
Trigger the pre_parse callback if needed.
Definition: App.hpp:2737
T as() const
Return the results as the specified type.
Definition: Option.hpp:999
bool parsed() const
Check to see if this subcommand was parsed, true only if received on command line.
Definition: App.hpp:528
bool _parse_single(std::vector< std::string > &args, bool &positional_only)
Definition: App.hpp:2373
Definition: Option.hpp:194
const Option * operator[](const std::string &option_name) const
Shortcut bracket operator for getting a pointer to an option.
Definition: App.hpp:1634
const std::string & get_group() const
Get the group of this option.
Definition: Option.hpp:115
void deprecate_option(Option *opt, const std::string &replacement="")
Helper function to mark an option as deprecated.
Definition: App.hpp:2952
const std::vector< Option * > & parse_order() const
This gets a vector of pointers with the original parse order.
Definition: App.hpp:1781
CRTP * configurable(bool value=true)
Allow in a configuration file.
Definition: Option.hpp:180
void _process_extras()
Throw an error if anything is left over and should not be.
Definition: App.hpp:2214
Option * default_str(std::string val)
Set the default value string representation (does not change the contained value)
Definition: Option.hpp:1078
std::unique_ptr< Option > Option_p
Definition: Option.hpp:33
T * add_option_group(std::string group_name, std::string group_description="")
creates an option group as part of the given app
Definition: App.hpp:977
void _process_callbacks()
Process callbacks. Runs on all subcommands.
Definition: App.hpp:2029
bool _parse_positional(std::vector< std::string > &args, bool haltOnSubcommand)
Definition: App.hpp:2443
bool _parse_arg(std::vector< std::string > &args, detail::Classifier current_type)
Definition: App.hpp:2592
bool get_validate_positionals() const
Get the status of validating positionals.
Definition: App.hpp:1696
bool remove_subcommand(App *subcom)
Removes a subcommand from the App. Takes a subcommand pointer. Returns true if found and removed.
Definition: App.hpp:1014
App * ignore_case(bool value=true)
Ignore case. Subcommands inherit value.
Definition: App.hpp:461
Option * add_complex(std::string option_name, T &variable, std::string option_description="", bool defaulted=false, std::string label="COMPLEX")
Add a complex number.
Definition: App.hpp:878
bool empty() const
True if the option was not passed.
Definition: Option.hpp:351
int get_items_expected_min() const
The total min number of expected string values to be used.
Definition: Option.hpp:694
This will only trigger for actual void type.
Definition: TypeTools.hpp:331
std::vector< const App * > get_subcommands(const std::function< bool(const App *)> &filter) const
Definition: App.hpp:1351
void _move_to_missing(detail::Classifier val_type, const std::string &val)
Helper function to place extra values in the most appropriate position.
Definition: App.hpp:2818
Option * add_flag(std::string flag_name, T &flag_description)
Definition: App.hpp:725
Option * add_flag_callback(std::string flag_name, std::function< void(void)> function, std::string flag_description="")
Add option for callback that is triggered with a true flag and takes no arguments.
Definition: App.hpp:787
Usually something like –help-all on command line.
Definition: Error.hpp:166
const Option * get_help_ptr() const
Get a pointer to the help flag. (const)
Definition: App.hpp:1705
void TriggerOn(App *trigger_app, App *app_to_enable)
Helper function to enable one option group/subcommand when another is used.
Definition: App.hpp:2910
void _process_env()
Get envname options if not yet passed. Runs on all subcommands.
Definition: App.hpp:1996
App(std::string app_description, std::string app_name, App *parent)
Special private constructor for subcommand.
Definition: App.hpp:255
Definition: Error.hpp:322
bool allow_extras_
If true, allow extra arguments (ie, don't throw an error). INHERITABLE.
Definition: App.hpp:83
Thrown when a required option is missing.
Definition: Error.hpp:209
std::size_t escape_detect(std::string &str, std::size_t offset)
Definition: StringTools.hpp:353
Option_group(std::string group_description, std::string group_name, App *parent)
Definition: App.hpp:2879
bool get_allow_extra_args() const
Get the current value of allow extra args.
Definition: Option.hpp:414
This will only trigger for actual void type.
Definition: TypeTools.hpp:310
bool get_fallthrough() const
Check the status of fallthrough.
Definition: App.hpp:1646
App * callback(std::function< void()> app_callback)
Definition: App.hpp:310
bool pre_parse_called_
Flag indicating that the pre_parse_callback has been triggered.
Definition: App.hpp:102
bool get_positionals_at_end() const
Check the status of the allow windows style options.
Definition: App.hpp:1652
Thrown when counting a non-existent option.
Definition: Error.hpp:330
std::size_t count_all() const
Definition: App.hpp:1102
static auto parse_subcommand(App *app, Args &&... args) -> typename std::result_of< decltype(&App::_parse_subcommand)(App, Args...)>::type
Wrap _parse_subcommand, perfectly forward arguments and return.
Definition: App.hpp:3084
App * disabled(bool disable=true)
Disable the subcommand or option group.
Definition: App.hpp:391
std::function< void()> parse_complete_callback_
This is a function that runs when parsing has finished.
Definition: App.hpp:112
Option * add_flag(std::string flag_name)
Add a flag with no description or variable assignment.
Definition: App.hpp:717
int get_expected_min() const
The number of times the option expects to be included.
Definition: Option.hpp:689
CRTP * required(bool value=true)
Set the option as required.
Definition: Option.hpp:99
Option * add_mutable_set(std::string option_name, T &member, const std::set< T > &options, std::string option_description="")
Add set of options (No default, set can be changed afterwards - do not destroy the set) DEPRECATED.
Definition: App.hpp:840
void clear()
Clear the parsed results (mostly for testing)
Definition: Option.hpp:357
App * allow_config_extras(config_extras_mode mode)
ignore extras in config files
Definition: App.hpp:449
void _process_extras(std::vector< std::string > &args)
Definition: App.hpp:2230
Option * help_all_ptr_
A pointer to the help all flag if there is one INHERITABLE.
Definition: App.hpp:140
void _parse(std::vector< std::string > &args)
Internal parse function.
Definition: App.hpp:2254
bool split_long(const std::string ¤t, std::string &name, std::string &value)
Definition: Split.hpp:31
App * get_parent()
Get the parent of this subcommand (or nullptr if master app)
Definition: App.hpp:1717
Option * add_result(std::string s)
Puts a result at the end.
Definition: Option.hpp:922
Option * help_ptr_
A pointer to the help flag if there is one INHERITABLE.
Definition: App.hpp:137
App * configurable(bool value=true)
Specify that the subcommand can be triggered by a config file.
Definition: App.hpp:489
Holds values to load into Options.
Definition: ConfigFwd.hpp:23
Classifier
Definition: App.hpp:44
App * description(std::string app_description)
Set the description of the app.
Definition: App.hpp:1539
std::string group_
The group membership INHERITABLE.
Definition: App.hpp:237
std::function< std::string()> footer_callback_
This is a function that generates a footer to put after all other options in help output.
Definition: App.hpp:134
Option * get_option(std::string option_name)
Get an option by name (non-const version)
Definition: App.hpp:1625
std::string help(std::string prev="", AppFormatMode mode=AppFormatMode::Normal) const
Definition: App.hpp:1501
std::vector< Option * > get_options(const std::function< bool(Option *)> filter={})
Non-const version of the above.
Definition: App.hpp:1562
std::vector< std::string > parents
This is the list of parents.
Definition: ConfigFwd.hpp:25
void run_callback()
Process the callback.
Definition: Option.hpp:790
App * enabled_by_default(bool enable=true)
Definition: App.hpp:408
App * require_subcommand()
The argumentless form of require subcommand requires 1 or more subcommands.
Definition: App.hpp:1123
CLI::App_p get_subcommand_ptr(int index=0) const
Get an owning pointer to subcommand by index.
Definition: App.hpp:1076
CLI::App_p get_subcommand_ptr(App *subcom) const
Check to see if a subcommand is part of this command and get a shared_ptr to it.
Definition: App.hpp:1058
Thrown when an option is set to conflicting values (non-vector and multi args, for example)
Definition: Error.hpp:90
bool validate_positionals_
If set to true positional options are validated before assigning INHERITABLE.
Definition: App.hpp:216
OptionDefaults * option_defaults()
Get the OptionDefault object, to set option defaults.
Definition: App.hpp:531
Thrown when a requires option is missing.
Definition: Error.hpp:273
Option * add_flag_function(std::string flag_name, std::function< void(std::int64_t)> function, std::string flag_description="")
Add option for callback with an integer value.
Definition: App.hpp:803
bool has_default_flag_values(const std::string &flags)
check if the flag definitions has possible false flags
Definition: StringTools.hpp:226
Option * allow_extra_args(bool value=true)
Definition: Option.hpp:409
std::size_t remaining_size(bool recurse=false) const
This returns the number of remaining options, minus the – separator.
Definition: App.hpp:1818
bool _has_remaining_positionals() const
Count the required remaining positional arguments.
Definition: App.hpp:2430
Option * add_set(std::string option_name, T &member, std::set< T > options, std::string option_description, bool defaulted)
Add set of options (with default, static set, such as an inline set) DEPRECATED.
Definition: App.hpp:852