38#define CLI11_PARSE(app, argc, argv) \
40 (app).parse((argc), (argv)); \
41 } catch(const CLI::ParseError &e) { \
42 return (app).exit(e); \
51namespace FailureMessage {
62using App_p = std::shared_ptr<App>;
175 using missing_t = std::vector<std::pair<detail::Classifier, std::string>>;
285 App(std::string app_description, std::string app_name,
App *parent)
324 explicit App(std::string app_description =
"", std::string app_name =
"")
325 :
App(app_description, app_name, nullptr) {
326 set_help_flag(
"-h,--help",
"Print this help message and exit");
399 throw(
OptionAlreadyAdded(
"alias already matches an existing subcommand: " + app_name));
510 throw OptionAlreadyAdded(
"ignore case would cause subcommand name conflicts: " + match);
544 throw OptionAlreadyAdded(
"ignore underscore would cause subcommand name conflicts: " + match);
559 formatter_ = std::make_shared<FormatterLambda>(fmt);
595 std::string option_description =
"",
596 bool defaulted =
false,
597 std::function<std::string()> func = {}) {
598 Option myopt{option_name, option_description, option_callback,
this};
605 option.reset(
new Option(option_name, option_description, option_callback,
this));
608 option->default_function(func);
612 option->capture_default_str();
618 if(!defaulted && option->get_always_capture_default())
619 option->capture_default_str();
626 if(!matchname.empty()) {
635 template <
typename AssignTo,
636 typename ConvertTo = AssignTo,
640 std::string option_description =
"") {
643 return detail::lexical_conversion<AssignTo, ConvertTo>(res, variable);
646 Option *opt =
add_option(option_name, fun, option_description,
false, [&variable]() {
649 opt->
type_name(detail::type_name<ConvertTo>());
654 opt->
type_size(detail::type_count_min<ConvertTo>::value, (std::max)(Tcount, XCcount));
655 opt->
expected(detail::expected_count<ConvertTo>::value);
664 std::string option_description =
"") {
667 return detail::lexical_conversion<AssignTo, AssignTo>(res, variable);
670 Option *opt =
add_option(option_name, fun, option_description,
false, []() {
return std::string{}; });
671 opt->
type_name(detail::type_name<AssignTo>());
673 opt->
expected(detail::expected_count<AssignTo>::value);
679 template <
typename ArgType>
681 const std::function<
void(
const ArgType &)> &func,
682 std::string option_description =
"") {
686 bool result = detail::lexical_conversion<ArgType, ArgType>(res, variable);
693 Option *opt =
add_option(option_name, std::move(fun), option_description,
false);
694 opt->
type_name(detail::type_name<ArgType>());
696 opt->
expected(detail::expected_count<ArgType>::value);
706 template <
typename T,
722 if(!flag_name.empty()) {
739 if(!help_name.empty()) {
749 const std::string &versionString =
"",
750 const std::string &version_help =
"Display program version information and exit") {
758 if(!flag_name.empty()) {
760 flag_name, [versionString]() {
throw(
CLI::CallForVersion(versionString, 0)); }, version_help);
768 std::function<std::string()> vfunc,
769 const std::string &version_help =
"Display program version information and exit") {
776 if(!flag_name.empty()) {
787 Option *_add_flag_internal(std::string flag_name,
CLI::callback_t fun, std::string flag_description) {
793 opt =
add_option(std::move(flag_name), std::move(fun), std::move(flag_description),
false);
794 for(
const auto &fname : flag_defaults)
795 opt->
fnames_.push_back(fname.first);
798 opt =
add_option(std::move(flag_name), std::move(fun), std::move(flag_description),
false);
802 auto pos_name = opt->
get_name(
true);
804 throw IncorrectConstruction::PositionalFlag(pos_name);
819 template <
typename T,
823 return _add_flag_internal(flag_name,
CLI::callback_t(), flag_description);
828 template <
typename T,
830 !std::is_constructible<std::function<void(
int)>, T>::value,
834 std::string flag_description =
"") {
839 auto *opt = _add_flag_internal(flag_name, std::move(fun), std::move(flag_description));
844 template <
typename T,
848 std::vector<T> &flag_results,
849 std::string flag_description =
"") {
852 for(
const auto &elem : res) {
853 flag_results.emplace_back();
858 return _add_flag_internal(flag_name, std::move(fun), std::move(flag_description))
865 std::function<
void(
void)> function,
866 std::string flag_description =
"") {
871 if(result && trigger) {
876 return _add_flag_internal(flag_name, std::move(fun), std::move(flag_description));
881 std::function<
void(std::int64_t)> function,
882 std::string flag_description =
"") {
885 std::int64_t flag_count{0};
887 function(flag_count);
890 return _add_flag_internal(flag_name, std::move(fun), std::move(flag_description))
897 std::function<
void(std::int64_t)> function,
898 std::string flag_description =
"") {
899 return add_flag_function(std::move(flag_name), std::move(function), std::move(flag_description));
905 std::string default_filename =
"",
906 const std::string &help_message =
"Read an ini file",
907 bool config_required =
false) {
916 if(!option_name.empty()) {
918 if(config_required) {
921 if(!default_filename.empty()) {
934 op->remove_needs(opt);
935 op->remove_excludes(opt);
945 if(iterator != std::end(
options_)) {
953 template <
typename T = Option_group>
958 auto option_group = std::make_shared<T>(std::move(group_description), group_name,
this);
959 auto ptr = option_group.get();
961 App_p app_ptr = std::dynamic_pointer_cast<App>(option_group);
971 App *
add_subcommand(std::string subcommand_name =
"", std::string subcommand_description =
"") {
975 "Subcommand name starts with invalid character, '!' and '-' are not allowed");
977 for(
auto c : subcommand_name) {
980 "'), all characters are allowed except"
981 "'=',':','{','}', and ' '");
985 CLI::App_p subcom = std::shared_ptr<App>(
new App(std::move(subcommand_description), subcommand_name,
this));
996 throw(
OptionAlreadyAdded(
"subcommand name or alias matches existing subcommand: " + mstrg));
998 subcom->parent_ =
this;
1007 sub->remove_excludes(subcom);
1008 sub->remove_needs(subcom);
1011 auto iterator = std::find_if(
1022 if(subcom ==
nullptr)
1025 if(subcomptr.get() == subcom)
1026 return subcomptr.get();
1040 auto uindex =
static_cast<unsigned>(index);
1049 if(subcom ==
nullptr)
1052 if(subcomptr.get() == subcom)
1060 if(subcomptr->check_name(subcom))
1068 auto uindex =
static_cast<unsigned>(index);
1078 if(app->name_.empty() && app->group_ == group_name) {
1095 cnt += opt->
count();
1098 cnt += sub->count_all();
1179 explicit operator bool()
const {
return parsed_ > 0; }
1212 void parse(
int argc,
const char *
const *argv) {
1219 std::vector<std::string> args;
1220 args.reserve(
static_cast<std::size_t
>(argc) - 1U);
1221 for(
auto i =
static_cast<std::size_t
>(argc) - 1U; i > 0U; --i)
1222 args.emplace_back(argv[i]);
1223 parse(std::move(args));
1230 void parse(std::string commandline,
bool program_name_included =
false) {
1232 if(program_name_included) {
1238 commandline = std::move(nstr.second);
1243 if(!commandline.empty()) {
1249 auto args = detail::split_up(std::move(commandline));
1251 args.erase(std::remove(args.begin(), args.end(), std::string{}), args.end());
1252 std::reverse(args.begin(), args.end());
1254 parse(std::move(args));
1259 void parse(std::vector<std::string> &args) {
1279 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") {
1330 if(e.
get_name() ==
"CallForVersion") {
1331 out << e.what() << std::endl;
1357 std::vector<const App *> subcomms(
subcommands_.size());
1363 subcomms.erase(std::remove_if(std::begin(subcomms),
1365 [&filter](
const App *app) {
return !filter(app); }),
1366 std::end(subcomms));
1382 std::remove_if(std::begin(subcomms), std::end(subcomms), [&filter](
App *app) {
return !filter(app); }),
1383 std::end(subcomms));
1400 if(opt ==
nullptr) {
1409 if(app ==
nullptr) {
1424 if(opt ==
nullptr) {
1432 if(app ==
nullptr) {
1458 auto other_app = *iterator;
1460 other_app->remove_excludes(
this);
1490 footer_ = std::move(footer_string);
1500 std::string
config_to_str(
bool default_also =
false,
bool write_description =
false)
const {
1514 if(!selected_subcommands.empty()) {
1515 return selected_subcommands.at(0)->help(prev, mode);
1517 return formatter_->make_help(
this, prev, mode);
1550#if CLI11_USE_STATIC_RTTI == 0
1567 std::vector<const Option *>
get_options(
const std::function<
bool(
const Option *)> filter = {})
const {
1568 std::vector<const Option *> options(
options_.size());
1574 options.erase(std::remove_if(std::begin(options),
1576 [&filter](
const Option *opt) {
return !filter(opt); }),
1585 std::vector<Option *> options(
options_.size());
1592 std::remove_if(std::begin(options), std::end(options), [&filter](Option *opt) {
return !filter(opt); }),
1608 if(subc->get_name().empty()) {
1609 auto opt = subc->get_option_no_throw(option_name);
1610 if(opt !=
nullptr) {
1627 if(subc->get_name().empty()) {
1628 auto opt = subc->get_option_no_throw(option_name);
1629 if(opt !=
nullptr) {
1640 if(opt ==
nullptr) {
1649 if(opt ==
nullptr) {
1770 return std::string(
"[Option Group: ") +
get_group() +
"]";
1772 if(
aliases_.empty() || !with_aliases) {
1775 std::string dispname =
name_;
1776 for(
const auto &lalias :
aliases_) {
1777 dispname.push_back(
',');
1778 dispname.push_back(
' ');
1779 dispname.append(lalias);
1786 std::string local_name =
name_;
1796 if(local_name == name_to_check) {
1806 if(les == name_to_check) {
1815 std::vector<std::string> groups;
1819 if(std::find(groups.begin(), groups.end(), opt->
get_group()) == groups.end()) {
1831 std::vector<std::string>
remaining(
bool recurse =
false)
const {
1832 std::vector<std::string> miss_list;
1833 for(
const std::pair<detail::Classifier, std::string> &miss :
missing_) {
1834 miss_list.push_back(std::get<1>(miss));
1840 if(sub->name_.empty() && !sub->missing_.empty()) {
1841 for(
const std::pair<detail::Classifier, std::string> &miss : sub->missing_) {
1842 miss_list.push_back(std::get<1>(miss));
1850 std::vector<std::string> output = sub->remaining(recurse);
1851 std::copy(std::begin(output), std::end(output), std::back_inserter(miss_list));
1859 std::vector<std::string> miss_list =
remaining(recurse);
1860 std::reverse(std::begin(miss_list), std::end(miss_list));
1866 auto remaining_options =
static_cast<std::size_t
>(std::count_if(
1867 std::begin(
missing_), std::end(
missing_), [](
const std::pair<detail::Classifier, std::string> &val) {
1873 remaining_options += sub->remaining_size(recurse);
1876 return remaining_options;
1894 opt->get_required();
1896 if(pcount - pcount_req > 1) {
1901 std::size_t nameless_subs{0};
1904 if(app->get_name().empty())
1911 throw(
InvalidError(
"Required min options greater than required max options",
1916 throw(
InvalidError(
"Required min options greater than number of available options",
1932 if(app->has_automatic_name_) {
1935 if(app->name_.empty()) {
1936 app->fallthrough_ =
false;
1937 app->prefix_command_ =
false;
1940 app->parent_ =
this;
1946 void run_callback(
bool final_mode =
false,
bool suppress_final_callback =
false) {
1954 if(subc->parent_ ==
this) {
1955 subc->run_callback(
true, suppress_final_callback);
1960 if(subc->name_.empty() && subc->count_all() > 0) {
1961 subc->run_callback(
true, suppress_final_callback);
1980 if(com !=
nullptr) {
1989 std::string dummy1, dummy2;
1998 if(dummy1[0] >=
'0' && dummy1[0] <=
'9') {
2007 if((current ==
"++") && !
name_.empty() &&
parent_ !=
nullptr)
2019 auto config_files =
config_ptr_->
as<std::vector<std::string>>();
2020 if(config_files.empty() || config_files.front().empty()) {
2021 if(config_required) {
2022 throw FileError::Missing(
"no specified config file");
2026 for(
auto rit = config_files.rbegin(); rit != config_files.rend(); ++rit) {
2027 const auto &config_file = *rit;
2037 if(config_required || file_given)
2040 }
else if(config_required || file_given) {
2041 throw FileError::Missing(config_file);
2051 char *buffer =
nullptr;
2052 std::string ename_string;
2057 if(_dupenv_s(&buffer, &sz, opt->
envname_.c_str()) == 0 && buffer !=
nullptr) {
2058 ename_string = std::string(buffer);
2063 buffer = std::getenv(opt->
envname_.c_str());
2064 if(buffer !=
nullptr)
2065 ename_string = std::string(buffer);
2068 if(!ename_string.empty()) {
2075 if(sub->get_name().empty() || !sub->parse_complete_callback_)
2076 sub->_process_env();
2085 if(sub->get_name().empty() && sub->parse_complete_callback_) {
2086 if(sub->count_all() > 0) {
2087 sub->_process_callbacks();
2088 sub->run_callback();
2099 if(!sub->parse_complete_callback_) {
2100 sub->_process_callbacks();
2112 if(help_ptr !=
nullptr && help_ptr->
count() > 0)
2113 trigger_help =
true;
2114 if(help_all_ptr !=
nullptr && help_all_ptr->
count() > 0)
2115 trigger_all_help =
true;
2120 sub->_process_help_flags(trigger_help, trigger_all_help);
2123 }
else if(trigger_all_help) {
2125 }
else if(trigger_help) {
2133 bool excluded{
false};
2134 std::string excluder;
2136 if(opt->
count() > 0) {
2142 if(subc->count_all() > 0) {
2144 excluder = subc->get_display_name();
2156 bool missing_needed{
false};
2157 std::string missing_need;
2159 if(opt->
count() == 0) {
2160 missing_needed =
true;
2165 if(subc->count_all() == 0) {
2166 missing_needed =
true;
2167 missing_need = subc->get_display_name();
2170 if(missing_needed) {
2178 std::size_t used_options = 0;
2181 if(opt->
count() != 0) {
2190 if(opt->
count() > 0 && opt_req->
count() == 0)
2211 if(sub->name_.empty() && sub->count_all() > 0) {
2219 return std::string{};
2221 return ptr->get_name(
false,
true);
2225 if(!subc_list.empty()) {
2235 if(sub->name_.empty() && sub->required_ ==
false) {
2236 if(sub->count_all() == 0) {
2249 if(sub->count() > 0 || sub->name_.empty()) {
2250 sub->_process_requirements();
2253 if(sub->required_ && sub->count_all() == 0) {
2286 if(num_left_over > 0) {
2292 if(sub->count() > 0)
2293 sub->_process_extras();
2302 if(num_left_over > 0) {
2309 if(sub->count() > 0)
2310 sub->_process_extras(args);
2318 if(sub->get_name().empty())
2319 sub->increment_parsed();
2323 void _parse(std::vector<std::string> &args) {
2326 bool positional_only =
false;
2328 while(!args.empty()) {
2352 void _parse(std::vector<std::string> &&args) {
2357 bool positional_only =
false;
2359 while(!args.empty()) {
2387 throw ConfigError::Extras(item.fullname());
2393 if(level < item.
parents.size()) {
2396 auto result = subcom->_parse_single_config(item, level + 1);
2404 if(item.
name ==
"++") {
2415 if(item.
name ==
"--") {
2425 if(item.
name.size() == 1) {
2444 throw ConfigError::NotConfigurable(item.
fullname());
2470 switch(classifier) {
2473 positional_only =
true;
2498 positional_only =
true;
2503 throw HorribleError(
"unrecognized classifier (you should not see this!)");
2511 std::size_t retval = 0;
2539 const std::string &positional = args.back();
2543 auto arg_rem = args.size();
2545 if(arg_rem <= remreq) {
2550 std::string pos = positional;
2551 pos = opt->_validate(pos, 0);
2584 std::string pos = positional;
2585 pos = opt->_validate(pos, 0);
2609 if((subc->name_.empty()) && (!subc->disabled_)) {
2610 if(subc->_parse_positional(args,
false)) {
2611 if(!subc->pre_parse_called_) {
2612 subc->_trigger_pre_parse(args.size());
2625 if(haltOnSubcommand) {
2636 if(com !=
nullptr && (com->parent_->require_subcommand_max_ == 0 ||
2637 com->parent_->require_subcommand_max_ > com->parent_->parsed_subcommands_.size())) {
2652 while(!args.empty()) {
2665 if(com->disabled_ && ignore_disabled)
2667 if(com->get_name().empty()) {
2668 auto subc = com->_find_subcommand(subc_name, ignore_disabled, ignore_used);
2669 if(subc !=
nullptr) {
2673 if(com->check_name(subc_name)) {
2674 if((!*com) || !ignore_used)
2691 if(com !=
nullptr) {
2697 auto parent_app = com->parent_;
2698 while(parent_app !=
this) {
2699 parent_app->_trigger_pre_parse(args.size());
2701 parent_app->parsed_subcommands_.push_back(com);
2703 parent_app = parent_app->parent_;
2709 throw HorribleError(
"Subcommand " + args.back() +
" missing");
2717 std::string current = args.back();
2719 std::string arg_name;
2723 switch(current_type) {
2726 throw HorribleError(
"Long parsed but missing (you should not see this):" + args.back());
2730 throw HorribleError(
"Short parsed but missing! You should not see this");
2734 throw HorribleError(
"windows option parsed but missing! You should not see this");
2741 throw HorribleError(
"parsing got called with invalid option! You should not see this");
2747 return opt->check_lname(arg_name);
2749 return opt->check_sname(arg_name);
2751 return opt->check_lname(arg_name) || opt->check_sname(arg_name);
2757 if(subc->name_.empty() && !subc->disabled_) {
2758 if(subc->_parse_arg(args, current_type)) {
2759 if(!subc->pre_parse_called_) {
2760 subc->_trigger_pre_parse(args.size());
2787 if(op->get_inject_separator()) {
2788 if(!op->results().empty() && !op->results().back().empty()) {
2789 op->add_result(std::string{});
2795 int min_num = (std::min)(op->get_type_size_min(), op->get_items_expected_min());
2796 int max_num = op->get_items_expected_max();
2800 auto tmax = op->get_type_size_max();
2805 int result_count = 0;
2808 auto res = op->get_flag_value(arg_name, value);
2809 op->add_result(res);
2811 }
else if(!value.empty()) {
2812 op->add_result(value, result_count);
2814 collected += result_count;
2816 }
else if(!rest.empty()) {
2817 op->add_result(rest, result_count);
2820 collected += result_count;
2824 while(min_num > collected && !args.empty()) {
2825 std::string current_ = args.back();
2827 op->add_result(current_, result_count);
2829 collected += result_count;
2832 if(min_num > collected) {
2833 throw ArgumentMismatch::TypedAtLeast(op->get_name(), min_num, op->get_type_name());
2837 if(max_num > collected || op->get_allow_extra_args()) {
2840 while((collected < max_num || op->get_allow_extra_args()) && !args.empty() &&
2843 if(remreqpos >= args.size()) {
2847 std::string optarg = args.back();
2848 optarg = op->_validate(optarg, 0);
2849 if(!optarg.empty()) {
2853 op->add_result(args.back(), result_count);
2856 collected += result_count;
2863 if(min_num == 0 && max_num > 0 && collected == 0) {
2864 auto res = op->get_flag_value(arg_name, std::string{});
2865 op->add_result(res);
2870 if(min_num > 0 && (collected % op->get_type_size_max()) != 0) {
2871 if(op->get_type_size_max() != op->get_type_size_min()) {
2872 op->add_result(std::string{});
2874 throw ArgumentMismatch::PartialType(op->get_name(), op->get_type_size_min(), op->get_type_name());
2877 if(op->get_trigger_on_parse()) {
2882 args.push_back(rest);
2895 if(!
name_.empty()) {
2911 auto fallthrough_parent =
parent_;
2912 while((fallthrough_parent->parent_ !=
nullptr) && (fallthrough_parent->get_name().empty())) {
2913 fallthrough_parent = fallthrough_parent->parent_;
2915 return fallthrough_parent;
2920 static const std::string estring;
2925 if(subc.get() != &subcom) {
2926 if(subc->disabled_) {
2930 if(subc->check_name(subcom.
get_name())) {
2934 if(!subc->get_name().empty()) {
2936 return subc->get_name();
2939 for(
const auto &les : subcom.
aliases_) {
2940 if(subc->check_name(les)) {
2945 for(
const auto &les : subc->aliases_) {
2951 if(subc->get_name().empty()) {
2953 if(!cmpres.empty()) {
2960 if(!cmpres.empty()) {
2971 missing_.emplace_back(val_type, val);
2976 if(subc->name_.empty() && subc->allow_extras_) {
2977 subc->missing_.emplace_back(val_type, val);
2982 missing_.emplace_back(val_type, val);
2988 if(opt ==
nullptr) {
2994 if(app == subc.get()) {
3010 if(iterator != std::end(
options_)) {
3011 const auto &opt_p = *iterator;
3013 return (*v == *opt_p);
3016 app->
options_.push_back(std::move(*iterator));
3031 :
App(std::move(group_description),
"", parent) {
3055 subc->get_parent()->remove_subcommand(subcom);
3068inline void TriggerOn(
App *trigger_app, std::vector<App *> apps_to_enable) {
3069 for(
auto &app : apps_to_enable) {
3070 app->enabled_by_default(
false);
3071 app->disabled_by_default();
3075 for(
auto &app : apps_to_enable) {
3076 app->disabled(
false);
3090 for(
auto &app : apps_to_enable) {
3091 app->disabled_by_default(
false);
3092 app->enabled_by_default();
3096 for(
auto &app : apps_to_enable) {
3104 Validator deprecate_warning{[opt, replacement](std::string &) {
3105 std::cout << opt->
get_name() <<
" is deprecated please use '" << replacement
3107 return std::string();
3111 opt->
check(deprecate_warning);
3112 if(!replacement.empty()) {
3138 auto opt2 = app->
add_option(option_copy->get_name(
false,
true),
"option has been retired and has no effect")
3141 ->
type_size(option_copy->get_type_size_min(), option_copy->get_type_size_max())
3142 ->
expected(option_copy->get_expected_min(), option_copy->get_expected_max())
3145 Validator retired_warning{[opt2](std::string &) {
3146 std::cout <<
"WARNING " << opt2->get_name() <<
" is retired and has no effect\n";
3147 return std::string();
3151 opt2->check(retired_warning);
3161 if(opt !=
nullptr) {
3165 auto opt2 = app->
add_option(option_name,
"option has been retired and has no effect")
3169 Validator retired_warning{[opt2](std::string &) {
3170 std::cout <<
"WARNING " << opt2->get_name() <<
" is retired and has no effect\n";
3171 return std::string();
3175 opt2->check(retired_warning);
3181namespace FailureMessage {
3185 std::string header = std::string(e.what()) +
"\n";
3186 std::vector<std::string> names;
3197 header +=
"Run with " +
detail::join(names,
" or ") +
" for more information.\n";
3204 std::string header = std::string(
"ERROR: ") + e.
get_name() +
": " + e.what() +
"\n";
3205 header += app->
help();
3217 template <
typename... Args>
static decltype(
auto)
parse_arg(
App *app, Args &&...args) {
3218 return app->
_parse_arg(std::forward<Args>(args)...);
3222 template <
typename... Args>
static decltype(
auto)
parse_subcommand(
App *app, Args &&...args) {
3227 template <
typename... Args>
3230 return app->
_parse_arg(std::forward<Args>(args)...);
3234 template <
typename... Args>
Creates a command line program, with very few defaults.
Definition App.hpp:85
bool _parse_single(std::vector< std::string > &args, bool &positional_only)
Definition App.hpp:2467
bool get_disabled_by_default() const
Get the status of disabled by default.
Definition App.hpp:1716
const Option * operator[](const std::string &option_name) const
Shortcut bracket operator for getting a pointer to an option.
Definition App.hpp:1656
App * configurable(bool value=true)
Specify that the subcommand can be triggered by a config file.
Definition App.hpp:531
void _process_env()
Get envname options if not yet passed. Runs on all subcommands.
Definition App.hpp:2048
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:2907
void _process()
Process callbacks and such.
Definition App.hpp:2260
Option * config_ptr_
Pointer to the config option.
Definition App.hpp:277
Option * set_version_flag(std::string flag_name, std::function< std::string()> vfunc, const std::string &version_help="Display program version information and exit")
Generate the version string through a callback function.
Definition App.hpp:767
void parse(std::string commandline, bool program_name_included=false)
Definition App.hpp:1230
Option * add_option_no_stream(std::string option_name, AssignTo &variable, std::string option_description="")
Add option for assigning to a variable.
Definition App.hpp:662
Option * add_option(std::string option_name)
Add option with no description or variable assignment.
Definition App.hpp:701
App * get_option_group(std::string group_name) const
Check to see if an option group is part of this App.
Definition App.hpp:1076
App * config_formatter(std::shared_ptr< Config > fmt)
Set the config formatter.
Definition App.hpp:564
bool remove_excludes(App *app)
Removes a subcommand from the excludes list of this subcommand.
Definition App.hpp:1453
App * allow_config_extras(bool allow=true)
ignore extras in config files
Definition App.hpp:480
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:433
App * ignore_case(bool value=true)
Ignore case. Subcommands inherit value.
Definition App.hpp:503
bool _parse_single_config(const ConfigItem &item, std::size_t level=0)
Fill in a single config option.
Definition App.hpp:2392
Option * set_version_flag(std::string flag_name="", const std::string &versionString="", const std::string &version_help="Display program version information and exit")
Set a version flag and version display string, replace the existing one if present.
Definition App.hpp:748
std::size_t require_option_min_
Minimum required options (not inheritable!)
Definition App.hpp:258
void _parse(std::vector< std::string > &args)
Internal parse function.
Definition App.hpp:2323
std::size_t get_require_option_min() const
Get the required min option value.
Definition App.hpp:1692
void _parse(std::vector< std::string > &&args)
Internal parse function.
Definition App.hpp:2352
App * silent(bool silence=true)
silence the subcommand from showing up in the processed list
Definition App.hpp:427
bool get_configurable() const
Check the status of the allow windows style options.
Definition App.hpp:1677
App * clear_aliases()
clear all the aliases of the current App
Definition App.hpp:1762
App * allow_extras(bool allow=true)
Remove the error when extras are left over on the command line.
Definition App.hpp:409
App * fallthrough(bool value=true)
Definition App.hpp:1172
std::size_t require_subcommand_max_
Max number of subcommands allowed (parsing stops after this number). 0 is unlimited INHERITABLE.
Definition App.hpp:255
Option * get_config_ptr()
Get a pointer to the config option.
Definition App.hpp:1738
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:1974
std::vector< App_p > subcommands_
Storage for subcommand list.
Definition App.hpp:208
std::string help(std::string prev="", AppFormatMode mode=AppFormatMode::Normal) const
Definition App.hpp:1506
bool remove_option(Option *opt)
Removes an option from the App. Takes an option pointer. Returns true if found and removed.
Definition App.hpp:931
std::uint32_t parsed_
Counts the number of times this command/subcommand was parsed.
Definition App.hpp:249
bool parsed() const
Check to see if this subcommand was parsed, true only if received on command line.
Definition App.hpp:570
App * require_subcommand()
The argumentless form of require subcommand requires 1 or more subcommands.
Definition App.hpp:1113
Option * get_option(std::string option_name)
Get an option by name (non-const version)
Definition App.hpp:1647
OptionDefaults option_defaults_
The default values for options, customizable and changeable INHERITABLE.
Definition App.hpp:141
bool get_allow_windows_style_options() const
Check the status of the allow windows style options.
Definition App.hpp:1671
const Option * get_help_all_ptr() const
Get a pointer to the help all flag. (const)
Definition App.hpp:1735
bool _parse_positional(std::vector< std::string > &args, bool haltOnSubcommand)
Definition App.hpp:2537
bool check_name(std::string name_to_check) const
Check the name, case insensitive and underscore insensitive if set.
Definition App.hpp:1785
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:714
void _process_help_flags(bool trigger_help=false, bool trigger_all_help=false) const
Definition App.hpp:2108
bool disabled_
If set to true the subcommand is disabled and cannot be used, ignored for main app.
Definition App.hpp:118
Option * add_option(std::string option_name, AssignTo &variable, std::string option_description="")
Add option for assigning to a variable.
Definition App.hpp:638
bool required_
If set to true the subcommand is required to be processed and used, ignored for main app.
Definition App.hpp:115
startup_mode
Definition App.hpp:230
const Option * operator[](const char *option_name) const
Shortcut bracket operator for getting a pointer to an option.
Definition App.hpp:1659
Option * get_help_ptr()
Get a pointer to the help flag.
Definition App.hpp:1729
App * require_subcommand(int value)
Definition App.hpp:1122
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:1058
std::size_t count_all() const
Definition App.hpp:1092
CLI::App_p get_subcommand_ptr(int index=0) const
Get an owning pointer to subcommand by index.
Definition App.hpp:1066
OptionDefaults * option_defaults()
Get the OptionDefault object, to set option defaults.
Definition App.hpp:573
void _process_extras()
Throw an error if anything is left over and should not be.
Definition App.hpp:2283
void _process_requirements()
Verify required options and cross requirements. Subcommands too (only if selected).
Definition App.hpp:2131
App * get_subcommand(std::string subcom) const
Check to see if a subcommand is part of this command (text version)
Definition App.hpp:1031
std::string footer_
Footer to put after all options in the help output INHERITABLE.
Definition App.hpp:151
config_extras_mode allow_config_extras_
Definition App.hpp:106
Option * get_option_no_throw(std::string option_name) noexcept
Get an option by name (noexcept non-const version)
Definition App.hpp:1600
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:1858
App * required(bool require=true)
Remove the error when extras are left over on the command line.
Definition App.hpp:415
Option * version_ptr_
A pointer to a version flag if there is one.
Definition App.hpp:163
App * parent_
A pointer to the parent if this is a subcommand.
Definition App.hpp:264
std::set< Option * > exclude_options_
Definition App.hpp:193
App * prefix_command(bool allow=true)
Do not parse anything after the first unrecognized option and return.
Definition App.hpp:497
App * group(std::string group_name)
Changes the group membership.
Definition App.hpp:1107
void run_callback(bool final_mode=false, bool suppress_final_callback=false)
Internal function to run (App) callback, bottom up.
Definition App.hpp:1946
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:154
bool get_ignore_case() const
Check the status of ignore_case.
Definition App.hpp:1662
bool got_subcommand(std::string subcommand_name) const
Check with name instead of pointer to see if subcommand was selected.
Definition App.hpp:1396
std::function< void()> parse_complete_callback_
This is a function that runs when parsing has finished.
Definition App.hpp:131
virtual void pre_callback()
Definition App.hpp:1188
void parse(int argc, const char *const *argv)
Definition App.hpp:1212
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:954
App * get_parent()
Get the parent of this subcommand (or nullptr if main app)
Definition App.hpp:1750
Option * add_flag(std::string flag_name)
Add a flag with no description or variable assignment.
Definition App.hpp:814
bool get_prefix_command() const
Get the prefix command status.
Definition App.hpp:1698
const std::vector< Option * > & parse_order() const
This gets a vector of pointers with the original parse order.
Definition App.hpp:1828
std::string name_
Subcommand name or program name (from parser if name is empty)
Definition App.hpp:96
std::vector< App * > parsed_subcommands_
This is a list of the subcommands collected, in order.
Definition App.hpp:186
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:324
const std::vector< std::string > & get_aliases() const
Get the aliases of the current app.
Definition App.hpp:1759
const Option * get_config_ptr() const
Get a pointer to the config option. (const)
Definition App.hpp:1741
bool ignore_underscore_
If true, the program should ignore underscores INHERITABLE.
Definition App.hpp:214
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:1048
App * allow_windows_style_options(bool value=true)
Definition App.hpp:519
missing_t missing_
Definition App.hpp:180
Option * add_option_function(std::string option_name, const std::function< void(const ArgType &)> &func, std::string option_description="")
Add option for a callback of a specific type.
Definition App.hpp:680
std::size_t require_subcommand_min_
Minimum required subcommands (not inheritable!)
Definition App.hpp:252
std::vector< App * > get_subcommands() const
Definition App.hpp:1352
void clear()
Reset the parsed data.
Definition App.hpp:1195
std::size_t _count_remaining_positionals(bool required_only=false) const
Count the required remaining positional arguments.
Definition App.hpp:2510
App * _find_subcommand(const std::string &subc_name, bool ignore_disabled, bool ignore_used) const noexcept
Definition App.hpp:2663
std::function< std::string(const App *, const Error &e)> failure_message_
The error message printing function INHERITABLE.
Definition App.hpp:169
const std::string & get_group() const
Get the group of this subcommand.
Definition App.hpp:1680
bool remove_needs(App *app)
Removes a subcommand from the needs list of this subcommand.
Definition App.hpp:1475
bool _parse_arg(std::vector< std::string > &args, detail::Classifier current_type)
Definition App.hpp:2715
bool get_required() const
Get the status of required.
Definition App.hpp:1704
bool get_validate_positionals() const
Get the status of validating positionals.
Definition App.hpp:1721
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
const Option * get_version_ptr() const
Get a pointer to the version option. (const)
Definition App.hpp:1747
App * name(std::string app_name="")
Set a name for the app (empty will use parser to set the name)
Definition App.hpp:372
std::size_t get_require_subcommand_max() const
Get the required max subcommand value.
Definition App.hpp:1689
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:112
bool get_disabled() const
Get the status of disabled.
Definition App.hpp:1707
void _process_config_file()
Read and process a configuration file (main app only)
Definition App.hpp:2015
std::size_t remaining_size(bool recurse=false) const
This returns the number of remaining options, minus the – separator.
Definition App.hpp:1865
App * enabled_by_default(bool enable=true)
Definition App.hpp:444
void _process_extras(std::vector< std::string > &args)
Definition App.hpp:2299
App * footer(std::string footer_string)
Set footer.
Definition App.hpp:1489
App * needs(Option *opt)
Definition App.hpp:1423
App * require_option(int value)
Definition App.hpp:1151
std::vector< App * > get_subcommands(const std::function< bool(App *)> &filter)
Definition App.hpp:1374
virtual ~App()=default
virtual destructor
bool get_allow_extras() const
Get the status of allow extras.
Definition App.hpp:1701
std::vector< Option_p > options_
The list of options, stored locally.
Definition App.hpp:144
Option * help_all_ptr_
A pointer to the help all flag if there is one INHERITABLE.
Definition App.hpp:160
bool validate_optional_arguments_
If set to true optional vector arguments are validated before assigning INHERITABLE.
Definition App.hpp:242
void parse(std::vector< std::string > &args)
Definition App.hpp:1259
std::shared_ptr< FormatterBase > get_formatter() const
Access the formatter.
Definition App.hpp:1542
std::size_t count(std::string option_name) const
Counts the number of times the given option was passed.
Definition App.hpp:1348
App * add_subcommand(std::string subcommand_name="", std::string subcommand_description="")
Add a subcommand. Inherits INHERITABLE and OptionDefaults, and help flag.
Definition App.hpp:971
App * get_subcommand(int index=0) const
Get a pointer to subcommand by index.
Definition App.hpp:1038
std::function< void()> final_callback_
This is a function that runs when all processing has completed.
Definition App.hpp:134
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:593
App * require_option()
The argumentless form of require option requires 1 or more options be used.
Definition App.hpp:1142
void parse(std::vector< std::string > &&args)
The real work is done here. Expects a reversed vector.
Definition App.hpp:1279
App * preparse_callback(std::function< void(std::size_t)> pp_callback)
Definition App.hpp:366
bool positionals_at_end_
specify that positional arguments come at the end of the argument sequence not inheritable
Definition App.hpp:228
bool immediate_callback_
Definition App.hpp:125
App * add_subcommand(CLI::App_p subcom)
Add a previously created app as a subcommand.
Definition App.hpp:990
Option * add_flag(std::string flag_name, T &flag_description)
Definition App.hpp:822
bool remove_excludes(Option *opt)
Removes an option from the excludes list of this subcommand.
Definition App.hpp:1443
void parse_from_stream(std::istream &input)
Definition App.hpp:1298
App * parse_complete_callback(std::function< void()> pc_callback)
Definition App.hpp:359
bool configurable_
if set to true the subcommand can be triggered via configuration files INHERITABLE
Definition App.hpp:236
App * formatter_fn(std::function< std::string(const App *, std::string, AppFormatMode)> fmt)
Set the help formatter.
Definition App.hpp:558
App * description(std::string app_description)
Set the description of the app.
Definition App.hpp:1561
const Option * get_option_no_throw(std::string option_name) const noexcept
Get an option by name (noexcept const version)
Definition App.hpp:1619
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:731
std::string description_
Description of the current program/subcommand.
Definition App.hpp:99
std::string get_display_name(bool with_aliases=false) const
Get a display name for an app.
Definition App.hpp:1768
App * excludes(App *app)
Sets excluded subcommands for the subcommand.
Definition App.hpp:1408
App(std::string app_description, std::string app_name, App *parent)
Special private constructor for subcommand.
Definition App.hpp:285
bool remove_needs(Option *opt)
Removes an option from the needs list of this subcommand.
Definition App.hpp:1465
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:2987
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
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:2919
std::vector< const App * > get_subcommands(const std::function< bool(const App *)> &filter) const
Definition App.hpp:1356
Option * get_version_ptr()
Get a pointer to the version option.
Definition App.hpp:1744
const Option * get_help_ptr() const
Get a pointer to the help flag. (const)
Definition App.hpp:1732
std::size_t require_option_max_
Max number of options allowed. 0 is unlimited (not inheritable)
Definition App.hpp:261
std::vector< std::pair< detail::Classifier, std::string > > missing_t
Definition App.hpp:175
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:864
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:1567
bool get_silent() const
Get the status of silence.
Definition App.hpp:1710
std::vector< std::string > aliases_
Alias names for the subcommand.
Definition App.hpp:270
void _parse_stream(std::istream &input)
Internal function to parse a stream.
Definition App.hpp:2369
std::string get_description() const
Get the app or subcommand description.
Definition App.hpp:1558
bool get_fallthrough() const
Check the status of fallthrough.
Definition App.hpp:1668
std::set< App * > exclude_subcommands_
this is a list of subcommands that are exclusionary to this one
Definition App.hpp:189
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:847
std::shared_ptr< Config > get_config_formatter() const
Access the config formatter.
Definition App.hpp:1545
std::size_t get_require_option_max() const
Get the required max option value.
Definition App.hpp:1695
bool ignore_case_
If true, the program name is not case sensitive INHERITABLE.
Definition App.hpp:211
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:904
bool silent_
Definition App.hpp:246
std::function< void(std::size_t)> pre_parse_callback_
This is a function that runs prior to the start of parsing.
Definition App.hpp:128
App * final_callback(std::function< void()> app_callback)
Definition App.hpp:352
std::string group_
The group membership INHERITABLE.
Definition App.hpp:267
bool pre_parse_called_
Flag indicating that the pre_parse_callback has been triggered.
Definition App.hpp:121
App * validate_positionals(bool validate=true)
Set the subcommand to validate positional arguments before assigning.
Definition App.hpp:468
Option * help_ptr_
A pointer to the help flag if there is one INHERITABLE.
Definition App.hpp:157
std::size_t count() const
Definition App.hpp:1088
App * footer(std::function< std::string()> footer_function)
Set footer.
Definition App.hpp:1494
App * excludes(Option *opt)
Sets excluded options for the subcommand.
Definition App.hpp:1399
App * ignore_underscore(bool value=true)
Ignore underscore. Subcommands inherit value.
Definition App.hpp:537
std::string config_to_str(bool default_also=false, bool write_description=false) const
Definition App.hpp:1500
std::string version() const
Displays a version string.
Definition App.hpp:1521
void _configure()
Definition App.hpp:1925
const App * get_parent() const
Get the parent of this subcommand (or nullptr if main app) (const version)
Definition App.hpp:1753
bool remove_subcommand(App *subcom)
Removes a subcommand from the App. Takes a subcommand pointer. Returns true if found and removed.
Definition App.hpp:1004
App * get_subcommand(const App *subcom) const
Definition App.hpp:1021
std::shared_ptr< ConfigBase > get_config_formatter_base() const
Access the config formatter as a configBase pointer.
Definition App.hpp:1548
bool got_subcommand(const App *subcom) const
Check to see if given subcommand was selected.
Definition App.hpp:1390
const Option * get_option(std::string option_name) const
Get an option by name.
Definition App.hpp:1638
std::string get_footer() const
Generate and return the footer.
Definition App.hpp:1683
App * positionals_at_end(bool value=true)
Specify that the positional arguments are only at the end of the sequence.
Definition App.hpp:525
bool fallthrough_
Allow subcommand fallthrough, so that parent commands can collect commands after subcommand....
Definition App.hpp:217
std::set< Option * > need_options_
Definition App.hpp:201
App * alias(std::string app_name)
Set an alias for the app.
Definition App.hpp:390
bool get_ignore_underscore() const
Check the status of ignore_underscore.
Definition App.hpp:1665
std::set< App * > need_subcommands_
Definition App.hpp:197
std::vector< std::string > remaining(bool recurse=false) const
This returns the missing options from the current subcommand.
Definition App.hpp:1831
App * validate_optional_arguments(bool validate=true)
Set the subcommand to validate optional vector arguments before assigning.
Definition App.hpp:474
bool prefix_command_
If true, return immediately on an unrecognized option (implies allow_extras) INHERITABLE.
Definition App.hpp:109
void _process_callbacks()
Process callbacks. Runs on all subcommands.
Definition App.hpp:2081
App * formatter(std::shared_ptr< FormatterBase > fmt)
Set the help formatter.
Definition App.hpp:552
bool get_validate_optional_arguments() const
Get the status of validating optional vector arguments.
Definition App.hpp:1723
std::vector< Option * > parse_order_
This is a list of pointers to options with the original parse order.
Definition App.hpp:183
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:1988
Option * add_option(std::string option_name, T &option_description)
Add option with description but with no variable assignment or callback.
Definition App.hpp:709
const std::string & get_name() const
Get the name of the current app.
Definition App.hpp:1756
void _trigger_pre_parse(std::size_t remaining_args)
Trigger the pre_parse callback if needed.
Definition App.hpp:2888
bool validate_positionals_
If set to true positional options are validated before assigning INHERITABLE.
Definition App.hpp:239
void _validate() const
Definition App.hpp:1886
startup_mode default_startup
Definition App.hpp:233
App * allow_config_extras(config_extras_mode mode)
ignore extras in config files
Definition App.hpp:491
Option * add_flag(std::string flag_name, T &flag_result, std::string flag_description="")
Definition App.hpp:832
void increment_parsed()
Internal function to recursively increment the parsed counter on the current app as well unnamed subc...
Definition App.hpp:2315
bool allow_extras_
If true, allow extra arguments (ie, don't throw an error). INHERITABLE.
Definition App.hpp:102
config_extras_mode get_allow_config_extras() const
Get the status of allow extras.
Definition App.hpp:1726
App & operator=(const App &)=delete
App * require_option(std::size_t min, std::size_t max)
Definition App.hpp:1164
App * immediate_callback(bool immediate=true)
Set the subcommand callback to be executed immediately on subcommand completion.
Definition App.hpp:455
std::vector< Option * > get_options(const std::function< bool(Option *)> filter={})
Non-const version of the above.
Definition App.hpp:1584
std::vector< std::string > get_groups() const
Get the groups available directly from this option (in order)
Definition App.hpp:1814
bool _has_remaining_positionals() const
Count the required remaining positional arguments.
Definition App.hpp:2524
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:880
bool _parse_subcommand(std::vector< std::string > &args)
Definition App.hpp:2685
bool get_enabled_by_default() const
Get the status of disabled by default.
Definition App.hpp:1719
void _parse_config(const std::vector< ConfigItem > &args)
Definition App.hpp:2384
App * disabled(bool disable=true)
Disable the subcommand or option group.
Definition App.hpp:421
App * callback(std::function< void()> app_callback)
Definition App.hpp:341
std::shared_ptr< FormatterBase > formatter_
This is the formatter for help printing. Default provided. INHERITABLE (same pointer)
Definition App.hpp:166
bool get_positionals_at_end() const
Check the status of the allow windows style options.
Definition App.hpp:1674
std::size_t get_require_subcommand_min() const
Get the required min subcommand value.
Definition App.hpp:1686
App * needs(App *app)
Definition App.hpp:1431
App * require_subcommand(std::size_t min, std::size_t max)
Definition App.hpp:1135
bool allow_windows_style_options_
Allow '/' for options for Windows like options. Defaults to true on Windows, false otherwise....
Definition App.hpp:220
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:2969
std::shared_ptr< Config > config_formatter_
This is the formatter for help printing. Default provided. INHERITABLE (same pointer)
Definition App.hpp:280
bool get_immediate_callback() const
Get the status of disabled.
Definition App.hpp:1713
Usually something like –help-all on command line.
Definition Error.hpp:169
-h or –help on command line
Definition Error.hpp:163
-v or –version on command line
Definition Error.hpp:176
All errors derive from this one.
Definition Error.hpp:70
int get_exit_code() const
Definition Error.hpp:75
std::string get_name() const
Definition Error.hpp:77
Thrown when parsing an INI file and it is missing.
Definition Error.hpp:189
bool get_configurable() const
The status of configurable.
Definition Option.hpp:134
CRTP * configurable(bool value=true)
Allow in a configuration file.
Definition Option.hpp:187
bool get_required() const
True if this is a required option.
Definition Option.hpp:125
bool required_
True if this is a required option.
Definition Option.hpp:57
CRTP * always_capture_default(bool value=true)
Definition Option.hpp:114
const std::string & get_group() const
Get the group of this option.
Definition Option.hpp:122
void copy_to(T *other) const
Copy the contents to another similar class (one based on OptionBase)
Definition Option.hpp:81
CRTP * required(bool value=true)
Set the option as required.
Definition Option.hpp:106
Definition Option.hpp:201
Thrown when counting a non-existent option.
Definition Error.hpp:344
Extension of App to better manage groups of options.
Definition App.hpp:3028
App * add_subcommand(App *subcom)
Add an existing subcommand to be a member of an option_group.
Definition App.hpp:3053
Option * add_option(Option *opt)
Add an existing option to the Option_group.
Definition App.hpp:3037
Option_group(std::string group_description, std::string group_name, App *parent)
Definition App.hpp:3030
void add_options(Option *opt, Args... args)
Add a bunch of options to the group.
Definition App.hpp:3047
void add_options(Option *opt)
Add an existing option to the Option_group.
Definition App.hpp:3045
Definition Option.hpp:238
int get_type_size_max() const
The maximum number of arguments the option expects.
Definition Option.hpp:690
std::size_t count() const
Count the total number of times an option was passed.
Definition Option.hpp:364
int get_expected_min() const
The number of times the option expects to be included.
Definition Option.hpp:735
Option * type_name(std::string typeval)
Set a custom option typestring.
Definition Option.hpp:1083
int get_expected_max() const
The max number of times the option expects to be included.
Definition Option.hpp:737
@ callback_run
the callback has been executed
option_state current_option_state_
Whether the callback has run (needed for INI parsing)
Definition Option.hpp:335
bool get_trigger_on_parse() const
The status of trigger on parse.
Definition Option.hpp:437
const results_t & results() const
Get the current complete results set.
Definition Option.hpp:1010
int get_type_size_min() const
The minimum number of arguments the option expects.
Definition Option.hpp:688
std::set< Option * > needs_
A list of options that are required with this option.
Definition Option.hpp:304
Option * multi_option_policy(MultiOptionPolicy value=MultiOptionPolicy::Throw)
Take the last argument if given multiple times (or another policy)
Definition Option.hpp:662
Option * add_result(std::string s)
Puts a result at the end.
Definition Option.hpp:987
std::set< Option * > excludes_
A list of options that are excluded with this option.
Definition Option.hpp:307
std::string get_flag_value(const std::string &name, std::string input_value) const
Definition Option.hpp:943
std::vector< std::string > fnames_
a list of flag names with specified default values;
Definition Option.hpp:256
const std::string & get_description() const
Get the description.
Definition Option.hpp:760
Option * expected(int value)
Set the number of expected arguments.
Definition Option.hpp:383
bool check_name(const std::string &name) const
Check a name. Requires "-" or "--" for short / long, supports positional name.
Definition Option.hpp:894
bool get_allow_extra_args() const
Get the current value of allow extra args.
Definition Option.hpp:430
Option * run_callback_for_default(bool value=true)
Definition Option.hpp:449
Option * allow_extra_args(bool value=true)
Definition Option.hpp:425
Option * type_size(int option_type_size)
Set a custom option size.
Definition Option.hpp:1089
int get_inject_separator() const
Return the inject_separator flag.
Definition Option.hpp:693
bool get_callback_run() const
See if the callback has been run already.
Definition Option.hpp:1070
T as() const
Return the results as the specified type.
Definition Option.hpp:1063
void run_callback()
Process the callback.
Definition Option.hpp:843
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:783
void clear()
Clear the parsed results (mostly for testing)
Definition Option.hpp:373
Option * default_str(std::string val)
Set the default value string representation (does not change the contained value)
Definition Option.hpp:1150
bool get_positional() const
True if the argument can be given directly.
Definition Option.hpp:751
std::string envname_
If given, check the environment for this option.
Definition Option.hpp:262
std::vector< std::pair< std::string, std::string > > default_flag_values_
Definition Option.hpp:253
const std::string & matching_name(const Option &other) const
If options share any of the same names, find it.
Definition Option.hpp:870
Option * description(std::string option_description)
Set the description.
Definition Option.hpp:763
Option * force_callback(bool value=true)
Set the value of force_callback.
Definition Option.hpp:440
Option * check(Validator validator, const std::string &validator_name="")
Adds a Validator with a built in type name.
Definition Option.hpp:457
bool empty() const
True if the option was not passed.
Definition Option.hpp:367
int get_items_expected_min() const
The total min number of expected string values to be used.
Definition Option.hpp:740
Thrown when a required option is missing.
Definition Error.hpp:219
Some validators that are provided.
Definition Validators.hpp:80
Validator & application_index(int app_index)
Specify the application index of a validator.
Definition Validators.hpp:181
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:3203
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:3184
constexpr enabler dummy
An instance to use in EnableIf.
Definition TypeTools.hpp:34
bool split_long(const std::string ¤t, std::string &name, std::string &value)
Definition Split.hpp:35
path_type check_path(const char *file) noexcept
get the type of the path from a file name
Definition Validators.hpp:327
auto checked_to_string(T &&value) -> decltype(to_string(std::forward< T >(value)))
special template overload
Definition TypeTools.hpp:326
bool split_short(const std::string ¤t, std::string &name, std::string &rest)
Definition Split.hpp:25
bool valid_first_char(T c)
Definition StringTools.hpp:219
bool valid_name_string(const std::string &str)
Verify an option/subcommand name.
Definition StringTools.hpp:230
std::string remove_underscore(std::string str)
remove underscores from a string
Definition StringTools.hpp:267
std::enable_if< std::is_integral< T >::value, bool >::type checked_multiply(T &a, T b)
Performs a *= b; if it doesn't cause integer overflow. Returns false otherwise.
Definition Validators.hpp:678
std::string find_and_modify(std::string str, std::string trigger, Callable modify)
Definition StringTools.hpp:336
std::string & trim(std::string &str)
Trim whitespace from string.
Definition StringTools.hpp:138
void remove_default_flag_values(std::string &flags)
Definition StringTools.hpp:290
bool valid_later_char(T c)
Verify following characters of an option.
Definition StringTools.hpp:222
std::pair< std::string, std::string > split_program_name(std::string commandline)
Definition Validators.hpp:1126
constexpr int expected_max_vector_size
Definition StringTools.hpp:43
Option * default_flag_modifiers(Option *opt)
helper functions for adding in appropriate flag modifiers for add_flag
Definition App.hpp:68
bool split_windows_style(const std::string ¤t, std::string &name, std::string &value)
Definition Split.hpp:51
std::string join(const T &v, std::string delim=",")
Simple function to join a string.
Definition StringTools.hpp:63
Classifier
Definition App.hpp:47
bool valid_alias_name_string(const std::string &str)
Verify an app name.
Definition StringTools.hpp:242
std::string to_lower(std::string str)
Return a lower case version of a string.
Definition StringTools.hpp:259
bool has_default_flag_values(const std::string &flags)
check if the flag definitions has possible false flags
Definition StringTools.hpp:286
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:79
enabler
Simple empty scoped class.
Definition TypeTools.hpp:31
bool lexical_cast(const std::string &input, T &output)
Integer conversion.
Definition TypeTools.hpp:883
std::shared_ptr< App > App_p
Definition App.hpp:62
ConfigBase ConfigTOML
the default Config is the TOML file format
Definition ConfigFwd.hpp:170
void retire_option(App *app, Option *opt)
Helper function to mark an option as retired.
Definition App.hpp:3130
config_extras_mode
enumeration of modes of how to deal with extras in config files
Definition App.hpp:58
typename std::enable_if< B, T >::type enable_if_t
Definition TypeTools.hpp:42
void TriggerOn(App *trigger_app, App *app_to_enable)
Helper function to enable one option group/subcommand when another is used.
Definition App.hpp:3061
void deprecate_option(Option *opt, const std::string &replacement="")
Helper function to mark an option as deprecated.
Definition App.hpp:3103
AppFormatMode
Definition FormatterFwd.hpp:29
@ Normal
The normal, detailed help.
@ All
A fully expanded help.
@ TakeAll
just get all the passed argument regardless
@ TakeLast
take only the last Expected number of arguments
@ Sum
sum all the arguments together if numerical or concatenate directly without delimiter
void TriggerOff(App *trigger_app, App *app_to_enable)
Helper function to disable one option group/subcommand when another is used.
Definition App.hpp:3082
std::function< bool(const results_t &)> callback_t
callback function definition
Definition Option.hpp:31
std::vector< std::string > results_t
Definition Option.hpp:29
std::unique_ptr< Option > Option_p
Definition Option.hpp:36
Holds values to load into Options.
Definition ConfigFwd.hpp:26
std::vector< std::string > inputs
Listing of inputs.
Definition ConfigFwd.hpp:34
std::string name
This is the name.
Definition ConfigFwd.hpp:31
std::vector< std::string > parents
This is the list of parents.
Definition ConfigFwd.hpp:28
std::string fullname() const
The list of parents and name joined by ".".
Definition ConfigFwd.hpp:37
This class is simply to allow tests access to App's protected functions.
Definition App.hpp:3213
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:3235
static App * get_fallthrough_parent(App *app)
Wrap the fallthrough parent function to make sure that is working correctly.
Definition App.hpp:3241
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:3228
This will only trigger for actual void type.
Definition TypeTools.hpp:394