15#include "../Encoding.hpp"
29CLI11_INLINE
App::App(std::string app_description, std::string app_name,
App *parent)
30 : name_(std::move(app_name)), description_(std::move(app_description)), parent_(parent) {
67 normalized_argv_ = detail::compute_win32_argv();
69 if(!normalized_argv_view_.empty()) {
70 normalized_argv_view_.clear();
73 normalized_argv_view_.reserve(normalized_argv_.size());
74 for(
auto &arg : normalized_argv_) {
76 normalized_argv_view_.push_back(
const_cast<char *
>(arg.data()));
79 return normalized_argv_view_.data();
88 std::string oname =
name_;
103 if(app_name.empty() || !detail::valid_alias_name_string(app_name)) {
111 throw(
OptionAlreadyAdded(
"alias already matches an existing subcommand: " + app_name));
139 throw OptionAlreadyAdded(
"ignore case would cause subcommand name conflicts: " + match);
153 throw OptionAlreadyAdded(
"ignore underscore would cause subcommand name conflicts: " + match);
161 callback_t option_callback,
162 std::string option_description,
164 std::function<std::string()> func) {
167 if(std::find_if(std::begin(
options_), std::end(
options_), [&myopt](
const Option_p &v) {
return *v == myopt; }) ==
169 if(myopt.lnames_.empty() && myopt.snames_.empty()) {
173 if(test_name.size() == 3) {
174 test_name.erase(0, 1);
178 if(op !=
nullptr && op->get_configurable()) {
179 throw(
OptionAlreadyAdded(
"added option positional name matches existing option: " + test_name));
181 }
else if(
parent_ !=
nullptr) {
182 for(
auto &ln : myopt.lnames_) {
184 if(op !=
nullptr && op->get_configurable()) {
188 for(
auto &sn : myopt.snames_) {
190 if(op !=
nullptr && op->get_configurable()) {
196 for(
auto &sname : myopt.snames_) {
197 if(sname.length() > 1) {
198 std::string test_name;
199 test_name.push_back(
'-');
200 test_name.push_back(sname.front());
203 throw(
OptionAlreadyAdded(
"added option interferes with existing short option: " + sname));
208 for(
const auto &osn : opt->snames_) {
210 std::string test_name;
211 test_name.push_back(osn.front());
212 if(myopt.check_sname(test_name)) {
213 throw(
OptionAlreadyAdded(
"added option interferes with existing non standard option: " +
225 option->default_function(func);
229 option->capture_default_str();
235 if(!defaulted && option->get_always_capture_default())
236 option->capture_default_str();
242 const auto &matchname = opt->matching_name(myopt);
243 if(!matchname.empty()) {
259 if(!flag_name.empty()) {
275 if(!help_name.empty()) {
292 if(!flag_name.empty()) {
294 flag_name, [versionString]() {
throw(
CLI::CallForVersion(versionString, 0)); }, version_help);
309 if(!flag_name.empty()) {
318CLI11_INLINE
Option *App::_add_flag_internal(std::string flag_name, CLI::callback_t fun, std::string flag_description) {
320 if(detail::has_default_flag_values(flag_name)) {
322 auto flag_defaults = detail::get_default_flag_values(flag_name);
323 detail::remove_default_flag_values(flag_name);
324 opt =
add_option(std::move(flag_name), std::move(fun), std::move(flag_description),
false);
325 for(
const auto &fname : flag_defaults)
326 opt->fnames_.push_back(fname.first);
327 opt->default_flag_values_ = std::move(flag_defaults);
329 opt =
add_option(std::move(flag_name), std::move(fun), std::move(flag_description),
false);
333 auto pos_name = opt->
get_name(
true);
335 throw IncorrectConstruction::PositionalFlag(pos_name);
344 std::function<
void(
void)> function,
345 std::string flag_description) {
347 CLI::callback_t fun = [function](
const CLI::results_t &res) {
348 using CLI::detail::lexical_cast;
350 auto result = lexical_cast(res[0], trigger);
351 if(result && trigger) {
356 return _add_flag_internal(flag_name, std::move(fun), std::move(flag_description));
361 std::function<
void(std::int64_t)> function,
362 std::string flag_description) {
364 CLI::callback_t fun = [function](
const CLI::results_t &res) {
365 using CLI::detail::lexical_cast;
366 std::int64_t flag_count{0};
367 lexical_cast(res[0], flag_count);
368 function(flag_count);
371 return _add_flag_internal(flag_name, std::move(fun), std::move(flag_description))
376 std::string default_filename,
377 const std::string &help_message,
378 bool config_required) {
387 if(!option_name.empty()) {
389 if(config_required) {
392 if(!default_filename.empty()) {
407 op->remove_needs(opt);
408 op->remove_excludes(opt);
417 std::find_if(std::begin(
options_), std::end(
options_), [opt](
const Option_p &v) {
return v.get() == opt; });
418 if(iterator != std::end(
options_)) {
426 if(!subcommand_name.empty() && !detail::valid_name_string(subcommand_name)) {
427 if(!detail::valid_first_char(subcommand_name[0])) {
429 "Subcommand name starts with invalid character, '!' and '-' and control characters");
431 for(
auto c : subcommand_name) {
432 if(!detail::valid_later_char(c)) {
434 "'), all characters are allowed except"
435 "'=',':','{','}', ' ', and control characters");
439 CLI::App_p subcom = std::shared_ptr<App>(
new App(std::move(subcommand_description), subcommand_name,
this));
449 throw(
OptionAlreadyAdded(
"subcommand name or alias matches existing subcommand: " + mstrg));
451 subcom->parent_ =
this;
459 sub->remove_excludes(subcom);
460 sub->remove_needs(subcom);
463 auto iterator = std::find_if(
473 if(subcom ==
nullptr)
476 if(subcomptr.get() == subcom)
477 return subcomptr.get();
489 return _find_subcommand(subcom,
false,
false);
494 auto uindex =
static_cast<unsigned>(index);
502 if(subcom ==
nullptr)
505 if(subcomptr.get() == subcom)
512 if(subcomptr->check_name(subcom))
519 auto uindex =
static_cast<unsigned>(index);
528 if(app->name_.empty() && app->group_ == group_name) {
541 cnt += sub->count_all();
556 for(
const Option_p &opt :
options_) {
564CLI11_INLINE
void App::parse(
int argc,
const char *
const *argv) { parse_char_t(argc, argv); }
565CLI11_INLINE
void App::parse(
int argc,
const wchar_t *
const *argv) { parse_char_t(argc, argv); }
570CLI11_INLINE
const char *maybe_narrow(
const char *str) {
return str; }
571CLI11_INLINE std::string maybe_narrow(
const wchar_t *str) {
return narrow(str); }
575template <
class CharT> CLI11_INLINE
void App::parse_char_t(
int argc,
const CharT *
const *argv) {
579 name_ = detail::maybe_narrow(argv[0]);
582 std::vector<std::string> args;
583 args.reserve(
static_cast<std::size_t
>(argc) - 1U);
584 for(
auto i =
static_cast<std::size_t
>(argc) - 1U; i > 0U; --i)
585 args.emplace_back(detail::maybe_narrow(argv[i]));
587 parse(std::move(args));
590CLI11_INLINE
void App::parse(std::string commandline,
bool program_name_included) {
592 if(program_name_included) {
593 auto nstr = detail::split_program_name(commandline);
598 commandline = std::move(nstr.second);
600 detail::trim(commandline);
603 if(!commandline.empty()) {
604 commandline = detail::find_and_modify(commandline,
"=", detail::escape_detect);
606 commandline = detail::find_and_modify(commandline,
":", detail::escape_detect);
609 auto args = detail::split_up(std::move(commandline));
611 args.erase(std::remove(args.begin(), args.end(), std::string{}), args.end());
613 detail::remove_quotes(args);
614 }
catch(
const std::invalid_argument &arg) {
617 std::reverse(args.begin(), args.end());
618 parse(std::move(args));
621CLI11_INLINE
void App::parse(std::wstring commandline,
bool program_name_included) {
622 parse(narrow(commandline), program_name_included);
625CLI11_INLINE
void App::parse(std::vector<std::string> &args) {
644CLI11_INLINE
void App::parse(std::vector<std::string> &&args) {
663CLI11_INLINE
void App::parse_from_stream(std::istream &input) {
674CLI11_INLINE
int App::exit(
const Error &e, std::ostream &out, std::ostream &err)
const {
677 if(e.get_name() ==
"RuntimeError")
678 return e.get_exit_code();
680 if(e.get_name() ==
"CallForHelp") {
682 return e.get_exit_code();
685 if(e.get_name() ==
"CallForAllHelp") {
686 out <<
help(
"", AppFormatMode::All);
687 return e.get_exit_code();
690 if(e.get_name() ==
"CallForVersion") {
691 out << e.what() <<
'\n';
692 return e.get_exit_code();
695 if(e.get_exit_code() !=
static_cast<int>(ExitCodes::Success)) {
700 return e.get_exit_code();
709 subcomms.erase(std::remove_if(std::begin(subcomms),
711 [&filter](
const App *app) {
return !filter(app); }),
725 std::remove_if(std::begin(subcomms), std::end(subcomms), [&filter](
App *app) {
return !filter(app); }),
746 auto *other_app = *iterator;
748 other_app->remove_excludes(
this);
770CLI11_NODISCARD CLI11_INLINE std::string
App::help(std::string prev, AppFormatMode mode)
const {
778 if(!selected_subcommands.empty()) {
779 return selected_subcommands.back()->help(prev, mode);
781 return formatter_->make_help(
this, prev, mode);
803 std::vector<const Option *> options(
options_.size());
805 std::begin(
options_), std::end(
options_), std::begin(options), [](
const Option_p &val) {
return val.get(); });
808 options.erase(std::remove_if(std::begin(options),
810 [&filter](
const Option *opt) {
return !filter(opt); }),
815 const App *subc = subcp.get();
816 if(subc->get_name().empty() && !subc->get_group().empty() && subc->get_group().front() ==
'+') {
817 std::vector<const Option *> subcopts = subc->
get_options(filter);
818 options.insert(options.end(), subcopts.begin(), subcopts.end());
825 std::vector<Option *> options(
options_.size());
827 std::begin(
options_), std::end(
options_), std::begin(options), [](
const Option_p &val) {
return val.get(); });
831 std::remove_if(std::begin(options), std::end(options), [&filter](
Option *opt) {
return !filter(opt); }),
836 if(subc->get_name().empty() && !subc->get_group().empty() && subc->get_group().front() ==
'+') {
837 auto subcopts = subc->get_options(filter);
838 options.insert(options.end(), subcopts.begin(), subcopts.end());
845 for(Option_p &opt : options_) {
846 if(opt->check_name(option_name)) {
850 for(
auto &subc : subcommands_) {
852 if(subc->get_name().empty()) {
853 auto *opt = subc->get_option_no_throw(option_name);
863 for(
const Option_p &opt : options_) {
864 if(opt->check_name(option_name)) {
868 for(
const auto &subc : subcommands_) {
870 if(subc->get_name().empty()) {
871 auto *opt = subc->get_option_no_throw(option_name);
882 return std::string(
"[Option Group: ") +
get_group() +
"]";
884 if(
aliases_.empty() || !with_aliases) {
887 std::string dispname =
name_;
888 for(
const auto &lalias :
aliases_) {
889 dispname.push_back(
',');
890 dispname.push_back(
' ');
891 dispname.append(lalias);
897 std::string local_name =
name_;
899 local_name = detail::remove_underscore(
name_);
900 name_to_check = detail::remove_underscore(name_to_check);
903 local_name = detail::to_lower(
name_);
904 name_to_check = detail::to_lower(name_to_check);
907 if(local_name == name_to_check) {
912 les = detail::remove_underscore(les);
915 les = detail::to_lower(les);
917 if(les == name_to_check) {
925 std::vector<std::string> groups;
927 for(
const Option_p &opt :
options_) {
929 if(std::find(groups.begin(), groups.end(), opt->get_group()) == groups.end()) {
930 groups.push_back(opt->get_group());
937CLI11_NODISCARD CLI11_INLINE std::vector<std::string>
App::remaining(
bool recurse)
const {
938 std::vector<std::string> miss_list;
939 for(
const std::pair<detail::Classifier, std::string> &miss :
missing_) {
940 miss_list.push_back(std::get<1>(miss));
946 if(sub->name_.empty() && !sub->missing_.empty()) {
947 for(
const std::pair<detail::Classifier, std::string> &miss : sub->missing_) {
948 miss_list.push_back(std::get<1>(miss));
956 std::vector<std::string> output = sub->remaining(recurse);
957 std::copy(std::begin(output), std::end(output), std::back_inserter(miss_list));
964 std::vector<std::string> miss_list =
remaining(recurse);
965 std::reverse(std::begin(miss_list), std::end(miss_list));
970 auto remaining_options =
static_cast<std::size_t
>(std::count_if(
971 std::begin(
missing_), std::end(
missing_), [](
const std::pair<detail::Classifier, std::string> &val) {
972 return val.first != detail::Classifier::POSITIONAL_MARK;
977 remaining_options += sub->remaining_size(recurse);
980 return remaining_options;
985 auto pcount = std::count_if(std::begin(
options_), std::end(
options_), [](
const Option_p &opt) {
986 return opt->get_items_expected_max() >= detail::expected_max_vector_size && !opt->nonpositional();
989 auto pcount_req = std::count_if(std::begin(
options_), std::end(
options_), [](
const Option_p &opt) {
990 return opt->get_items_expected_max() >= detail::expected_max_vector_size && !opt->nonpositional() &&
993 if(pcount - pcount_req > 1) {
998 std::size_t nameless_subs{0};
1001 if(app->get_name().empty())
1008 throw(
InvalidError(
"Required min options greater than required max options", ExitCodes::InvalidError));
1013 InvalidError(
"Required min options greater than number of available options", ExitCodes::InvalidError));
1025 if(app->has_automatic_name_) {
1028 if(app->name_.empty()) {
1029 app->fallthrough_ =
false;
1030 app->prefix_command_ =
false;
1033 app->parent_ =
this;
1046 if(subc->parent_ ==
this) {
1047 subc->run_callback(
true, suppress_final_callback);
1052 if(subc->name_.empty() && subc->count_all() > 0) {
1053 subc->run_callback(
true, suppress_final_callback);
1072 if(com !=
nullptr) {
1082CLI11_NODISCARD CLI11_INLINE detail::Classifier
App::_recognize(
const std::string ¤t,
1083 bool ignore_used_subcommands)
const {
1084 std::string dummy1, dummy2;
1087 return detail::Classifier::POSITIONAL_MARK;
1089 return detail::Classifier::SUBCOMMAND;
1090 if(detail::split_long(current, dummy1, dummy2))
1091 return detail::Classifier::LONG;
1092 if(detail::split_short(current, dummy1, dummy2)) {
1093 if(dummy1[0] >=
'0' && dummy1[0] <=
'9') {
1095 return detail::Classifier::NONE;
1098 return detail::Classifier::SHORT;
1101 return detail::Classifier::WINDOWS_STYLE;
1102 if((current ==
"++") && !
name_.empty() &&
parent_ !=
nullptr)
1103 return detail::Classifier::SUBCOMMAND_TERMINATOR;
1104 auto dotloc = current.find_first_of(
'.');
1105 if(dotloc != std::string::npos) {
1106 auto *cm =
_find_subcommand(current.substr(0, dotloc),
true, ignore_used_subcommands);
1108 auto res = cm->_recognize(current.substr(dotloc + 1), ignore_used_subcommands);
1109 if(res == detail::Classifier::SUBCOMMAND) {
1114 return detail::Classifier::NONE;
1118 auto path_result = detail::check_path(config_file.c_str());
1119 if(path_result == detail::path_type::file) {
1130 }
else if(throw_error) {
1131 throw FileError::Missing(config_file);
1143 if(!ename_string.empty()) {
1149 auto config_files =
config_ptr_->
as<std::vector<std::string>>();
1150 bool files_used{file_given};
1151 if(config_files.empty() || config_files.front().empty()) {
1152 if(config_required) {
1153 throw FileError(
"config file is required but none was given");
1157 for(
const auto &config_file : config_files) {
1174 for(
const Option_p &opt :
options_) {
1175 if(opt->count() == 0 && !opt->envname_.empty()) {
1176 std::string ename_string = detail::get_environment_value(opt->envname_);
1177 if(!ename_string.empty()) {
1178 std::string result = ename_string;
1179 result = opt->_validate(result, 0);
1180 if(result.empty()) {
1181 opt->add_result(ename_string);
1188 if(sub->get_name().empty() || (sub->count_all() > 0 && !sub->parse_complete_callback_)) {
1190 sub->_process_env();
1199 if(sub->get_name().empty() && sub->parse_complete_callback_) {
1200 if(sub->count_all() > 0) {
1201 sub->_process_callbacks();
1202 sub->run_callback();
1207 for(
const Option_p &opt :
options_) {
1208 if((*opt) && !opt->get_callback_run()) {
1209 opt->run_callback();
1213 if(!sub->parse_complete_callback_) {
1214 sub->_process_callbacks();
1223 if(help_ptr !=
nullptr && help_ptr->count() > 0)
1224 trigger_help =
true;
1225 if(help_all_ptr !=
nullptr && help_all_ptr->count() > 0)
1226 trigger_all_help =
true;
1231 sub->_process_help_flags(trigger_help, trigger_all_help);
1234 }
else if(trigger_all_help) {
1236 }
else if(trigger_help) {
1243 bool excluded{
false};
1244 std::string excluder;
1246 if(opt->count() > 0) {
1248 excluder = opt->get_name();
1252 if(subc->count_all() > 0) {
1254 excluder = subc->get_display_name();
1266 bool missing_needed{
false};
1267 std::string missing_need;
1269 if(opt->count() == 0) {
1270 missing_needed =
true;
1271 missing_need = opt->get_name();
1275 if(subc->count_all() == 0) {
1276 missing_needed =
true;
1277 missing_need = subc->get_display_name();
1280 if(missing_needed) {
1288 std::size_t used_options = 0;
1289 for(
const Option_p &opt :
options_) {
1291 if(opt->count() != 0) {
1295 if(opt->get_required() && opt->count() == 0) {
1299 for(
const Option *opt_req : opt->needs_)
1300 if(opt->count() > 0 && opt_req->count() == 0)
1303 for(
const Option *opt_ex : opt->excludes_)
1304 if(opt->count() > 0 && opt_ex->count() != 0)
1321 if(sub->name_.empty() && sub->count_all() > 0) {
1327 auto option_list = detail::join(
options_, [
this](
const Option_p &ptr) {
1329 return std::string{};
1331 return ptr->get_name(
false,
true);
1334 auto subc_list =
get_subcommands([](
App *app) {
return ((app->get_name().empty()) && (!app->disabled_)); });
1335 if(!subc_list.empty()) {
1336 option_list +=
"," + detail::join(subc_list, [](
const App *app) {
return app->get_display_name(); });
1342 for(App_p &sub : subcommands_) {
1345 if(sub->name_.empty() && sub->required_ ==
false) {
1346 if(sub->count_all() == 0) {
1347 if(require_option_min_ > 0 && require_option_min_ <= used_options) {
1352 if(require_option_max_ > 0 && used_options >= require_option_min_) {
1359 if(sub->count() > 0 || sub->name_.empty()) {
1360 sub->_process_requirements();
1363 if(sub->required_ && sub->count_all() == 0) {
1369CLI11_INLINE
void App::_process() {
1372 _process_help_flags();
1376 _process_config_file();
1383 _process_callbacks();
1387 _process_callbacks();
1389 _process_requirements();
1392CLI11_INLINE
void App::_process_extras() {
1393 if(!(allow_extras_ || prefix_command_)) {
1394 std::size_t num_left_over = remaining_size();
1395 if(num_left_over > 0) {
1400 for(App_p &sub : subcommands_) {
1401 if(sub->count() > 0)
1402 sub->_process_extras();
1406CLI11_INLINE
void App::_process_extras(std::vector<std::string> &args) {
1407 if(!(allow_extras_ || prefix_command_)) {
1408 std::size_t num_left_over = remaining_size();
1409 if(num_left_over > 0) {
1410 args = remaining(
false);
1415 for(App_p &sub : subcommands_) {
1416 if(sub->count() > 0)
1417 sub->_process_extras(args);
1421CLI11_INLINE
void App::increment_parsed() {
1423 for(App_p &sub : subcommands_) {
1424 if(sub->get_name().empty())
1425 sub->increment_parsed();
1429CLI11_INLINE
void App::_parse(std::vector<std::string> &args) {
1431 _trigger_pre_parse(args.size());
1432 bool positional_only =
false;
1434 while(!args.empty()) {
1435 if(!_parse_single(args, positional_only)) {
1440 if(parent_ ==
nullptr) {
1444 _process_extras(args);
1447 args = remaining_for_passthrough(
false);
1448 }
else if(parse_complete_callback_) {
1450 _process_callbacks();
1451 _process_help_flags();
1452 _process_requirements();
1453 run_callback(
false,
true);
1457CLI11_INLINE
void App::_parse(std::vector<std::string> &&args) {
1461 _trigger_pre_parse(args.size());
1462 bool positional_only =
false;
1464 while(!args.empty()) {
1465 _parse_single(args, positional_only);
1473CLI11_INLINE
void App::_parse_stream(std::istream &input) {
1474 auto values = config_formatter_->from_config(input);
1475 _parse_config(values);
1477 _trigger_pre_parse(values.size());
1484CLI11_INLINE
void App::_parse_config(
const std::vector<ConfigItem> &args) {
1486 if(!_parse_single_config(item) && allow_config_extras_ == config_extras_mode::error)
1487 throw ConfigError::Extras(item.fullname());
1491CLI11_INLINE
bool App::_parse_single_config(
const ConfigItem &item, std::size_t level) {
1493 if(level < item.parents.size()) {
1494 auto *subcom = get_subcommand_no_throw(item.parents.at(level));
1495 return (subcom !=
nullptr) ? subcom->_parse_single_config(item, level + 1) :
false;
1498 if(item.name ==
"++") {
1501 _trigger_pre_parse(2);
1502 if(parent_ !=
nullptr) {
1503 parent_->parsed_subcommands_.push_back(
this);
1509 if(item.name ==
"--") {
1510 if(configurable_ && parse_complete_callback_) {
1511 _process_callbacks();
1512 _process_requirements();
1517 Option *op = get_option_no_throw(
"--" + item.name);
1519 if(item.name.size() == 1) {
1520 op = get_option_no_throw(
"-" + item.name);
1523 op = get_option_no_throw(item.name);
1524 }
else if(!op->get_configurable()) {
1525 auto *testop = get_option_no_throw(item.name);
1526 if(testop !=
nullptr && testop->get_configurable()) {
1530 }
else if(!op->get_configurable()) {
1531 if(item.name.size() == 1) {
1532 auto *testop = get_option_no_throw(
"-" + item.name);
1533 if(testop !=
nullptr && testop->get_configurable()) {
1537 if(!op->get_configurable()) {
1538 auto *testop = get_option_no_throw(item.name);
1539 if(testop !=
nullptr && testop->get_configurable()) {
1547 if(get_allow_config_extras() == config_extras_mode::capture) {
1549 missing_.emplace_back(detail::Classifier::NONE, item.fullname());
1550 for(
const auto &input : item.inputs) {
1551 missing_.emplace_back(detail::Classifier::NONE, input);
1557 if(!op->get_configurable()) {
1558 if(get_allow_config_extras() == config_extras_mode::ignore_all) {
1561 throw ConfigError::NotConfigurable(item.fullname());
1564 std::vector<std::string> buffer;
1565 bool useBuffer{
false};
1566 if(item.multiline) {
1567 if(!op->get_inject_separator()) {
1568 buffer = item.inputs;
1569 buffer.erase(std::remove(buffer.begin(), buffer.end(),
"%%"), buffer.end());
1573 const std::vector<std::string> &inputs = (useBuffer) ? buffer : item.inputs;
1574 if(op->get_expected_min() == 0) {
1575 if(item.inputs.size() <= 1) {
1577 auto res = config_formatter_->to_flag(item);
1578 bool converted{
false};
1579 if(op->get_disable_flag_override()) {
1580 auto val = detail::to_flag_value(res);
1582 res = op->get_flag_value(item.name,
"{}");
1589 if(res !=
"{}" || op->get_expected_max() <= 1) {
1590 res = op->get_flag_value(item.name, res);
1594 op->add_result(res);
1597 if(
static_cast<int>(inputs.size()) > op->get_items_expected_max() &&
1598 op->get_multi_option_policy() != MultiOptionPolicy::TakeAll) {
1599 if(op->get_items_expected_max() > 1) {
1600 throw ArgumentMismatch::AtMost(item.fullname(), op->get_items_expected_max(), inputs.size());
1603 if(!op->get_disable_flag_override()) {
1604 throw ConversionError::TooManyInputsFlag(item.fullname());
1608 for(
const auto &res : inputs) {
1609 bool valid_value{
false};
1610 if(op->default_flag_values_.empty()) {
1611 if(res ==
"true" || res ==
"false" || res ==
"1" || res ==
"0") {
1615 for(
const auto &valid_res : op->default_flag_values_) {
1616 if(valid_res.second == res) {
1624 op->add_result(res);
1632 op->add_result(inputs);
1639CLI11_INLINE
bool App::_parse_single(std::vector<std::string> &args,
bool &positional_only) {
1641 detail::Classifier classifier = positional_only ? detail::Classifier::NONE : _recognize(args.back());
1642 switch(classifier) {
1643 case detail::Classifier::POSITIONAL_MARK:
1645 positional_only =
true;
1646 if((!_has_remaining_positionals()) && (parent_ !=
nullptr)) {
1649 _move_to_missing(classifier,
"--");
1652 case detail::Classifier::SUBCOMMAND_TERMINATOR:
1657 case detail::Classifier::SUBCOMMAND:
1658 retval = _parse_subcommand(args);
1660 case detail::Classifier::LONG:
1661 case detail::Classifier::SHORT:
1662 case detail::Classifier::WINDOWS_STYLE:
1664 retval = _parse_arg(args, classifier,
false);
1666 case detail::Classifier::NONE:
1668 retval = _parse_positional(args,
false);
1669 if(retval && positionals_at_end_) {
1670 positional_only =
true;
1675 throw HorribleError(
"unrecognized classifier (you should not see this!)");
1681CLI11_NODISCARD CLI11_INLINE std::size_t App::_count_remaining_positionals(
bool required_only)
const {
1682 std::size_t retval = 0;
1683 for(
const Option_p &opt : options_) {
1684 if(opt->get_positional() && (!required_only || opt->get_required())) {
1685 if(opt->get_items_expected_min() > 0 &&
static_cast<int>(opt->count()) < opt->get_items_expected_min()) {
1686 retval +=
static_cast<std::size_t
>(opt->get_items_expected_min()) - opt->count();
1693CLI11_NODISCARD CLI11_INLINE
bool App::_has_remaining_positionals()
const {
1694 for(
const Option_p &opt : options_) {
1695 if(opt->get_positional() && ((
static_cast<int>(opt->count()) < opt->get_items_expected_min()))) {
1703CLI11_INLINE
bool App::_parse_positional(std::vector<std::string> &args,
bool haltOnSubcommand) {
1705 const std::string &positional = args.back();
1708 if(positionals_at_end_) {
1710 auto arg_rem = args.size();
1711 auto remreq = _count_remaining_positionals(
true);
1712 if(arg_rem <= remreq) {
1713 for(
const Option_p &opt : options_) {
1714 if(opt->get_positional() && opt->required_) {
1715 if(
static_cast<int>(opt->count()) < opt->get_items_expected_min()) {
1716 if(validate_positionals_) {
1717 std::string pos = positional;
1718 pos = opt->_validate(pos, 0);
1730 if(posOpt ==
nullptr) {
1731 for(
const Option_p &opt : options_) {
1733 if(opt->get_positional() &&
1734 (
static_cast<int>(opt->count()) < opt->get_items_expected_max() || opt->get_allow_extra_args())) {
1735 if(validate_positionals_) {
1736 std::string pos = positional;
1737 pos = opt->_validate(pos, 0);
1747 if(posOpt !=
nullptr) {
1748 parse_order_.push_back(posOpt);
1749 if(posOpt->get_inject_separator()) {
1750 if(!posOpt->results().empty() && !posOpt->results().back().empty()) {
1751 posOpt->add_result(std::string{});
1754 if(posOpt->get_trigger_on_parse() && posOpt->current_option_state_ == Option::option_state::callback_run) {
1757 posOpt->add_result(positional);
1758 if(posOpt->get_trigger_on_parse()) {
1759 posOpt->run_callback();
1766 for(
auto &subc : subcommands_) {
1767 if((subc->name_.empty()) && (!subc->disabled_)) {
1768 if(subc->_parse_positional(args,
false)) {
1769 if(!subc->pre_parse_called_) {
1770 subc->_trigger_pre_parse(args.size());
1777 if(parent_ !=
nullptr && fallthrough_) {
1778 return _get_fallthrough_parent()->_parse_positional(args,
static_cast<bool>(parse_complete_callback_));
1781 auto *com = _find_subcommand(args.back(),
true,
false);
1782 if(com !=
nullptr && (require_subcommand_max_ == 0 || require_subcommand_max_ > parsed_subcommands_.size())) {
1783 if(haltOnSubcommand) {
1790 if(subcommand_fallthrough_) {
1793 auto *parent_app = (parent_ !=
nullptr) ? _get_fallthrough_parent() :
this;
1794 com = parent_app->_find_subcommand(args.back(),
true,
false);
1795 if(com !=
nullptr && (com->parent_->require_subcommand_max_ == 0 ||
1796 com->parent_->require_subcommand_max_ > com->parent_->parsed_subcommands_.size())) {
1800 if(positionals_at_end_) {
1804 if(parent_ !=
nullptr && name_.empty()) {
1808 _move_to_missing(detail::Classifier::NONE, positional);
1810 if(prefix_command_) {
1811 while(!args.empty()) {
1812 _move_to_missing(detail::Classifier::NONE, args.back());
1820CLI11_NODISCARD CLI11_INLINE
App *
1821App::_find_subcommand(
const std::string &subc_name,
bool ignore_disabled,
bool ignore_used)
const noexcept {
1822 for(
const App_p &com : subcommands_) {
1823 if(com->disabled_ && ignore_disabled)
1825 if(com->get_name().empty()) {
1826 auto *subc = com->
_find_subcommand(subc_name, ignore_disabled, ignore_used);
1827 if(subc !=
nullptr) {
1831 if(com->check_name(subc_name)) {
1832 if((!*com) || !ignore_used)
1839CLI11_INLINE
bool App::_parse_subcommand(std::vector<std::string> &args) {
1840 if(_count_remaining_positionals(
true) > 0) {
1841 _parse_positional(args,
false);
1844 auto *com = _find_subcommand(args.back(),
true,
true);
1845 if(com ==
nullptr) {
1847 auto dotloc = args.back().find_first_of(
'.');
1848 if(dotloc != std::string::npos) {
1849 com = _find_subcommand(args.back().substr(0, dotloc),
true,
true);
1850 if(com !=
nullptr) {
1851 args.back() = args.back().substr(dotloc + 1);
1852 args.push_back(com->get_display_name());
1856 if(com !=
nullptr) {
1859 parsed_subcommands_.push_back(com);
1862 auto *parent_app = com->parent_;
1863 while(parent_app !=
this) {
1864 parent_app->_trigger_pre_parse(args.size());
1866 parent_app->parsed_subcommands_.push_back(com);
1868 parent_app = parent_app->parent_;
1873 if(parent_ ==
nullptr)
1874 throw HorribleError(
"Subcommand " + args.back() +
" missing");
1879App::_parse_arg(std::vector<std::string> &args, detail::Classifier current_type,
bool local_processing_only) {
1881 std::string current = args.back();
1883 std::string arg_name;
1887 switch(current_type) {
1888 case detail::Classifier::LONG:
1889 if(!detail::split_long(current, arg_name, value))
1890 throw HorribleError(
"Long parsed but missing (you should not see this):" + args.back());
1892 case detail::Classifier::SHORT:
1893 if(!detail::split_short(current, arg_name, rest))
1894 throw HorribleError(
"Short parsed but missing! You should not see this");
1896 case detail::Classifier::WINDOWS_STYLE:
1897 if(!detail::split_windows_style(current, arg_name, value))
1898 throw HorribleError(
"windows option parsed but missing! You should not see this");
1900 case detail::Classifier::SUBCOMMAND:
1901 case detail::Classifier::SUBCOMMAND_TERMINATOR:
1902 case detail::Classifier::POSITIONAL_MARK:
1903 case detail::Classifier::NONE:
1905 throw HorribleError(
"parsing got called with invalid option! You should not see this");
1908 auto op_ptr = std::find_if(std::begin(options_), std::end(options_), [arg_name, current_type](
const Option_p &opt) {
1909 if(current_type == detail::Classifier::LONG)
1910 return opt->check_lname(arg_name);
1911 if(current_type == detail::Classifier::SHORT)
1912 return opt->check_sname(arg_name);
1914 return opt->check_lname(arg_name) || opt->check_sname(arg_name);
1918 while(op_ptr == std::end(options_)) {
1920 for(
auto &subc : subcommands_) {
1921 if(subc->name_.empty() && !subc->disabled_) {
1922 if(subc->_parse_arg(args, current_type, local_processing_only)) {
1923 if(!subc->pre_parse_called_) {
1924 subc->_trigger_pre_parse(args.size());
1930 if(allow_non_standard_options_ && current_type == detail::Classifier::SHORT && current.size() > 2) {
1931 std::string narg_name;
1933 detail::split_long(std::string{
'-'} + current, narg_name, nvalue);
1934 op_ptr = std::find_if(std::begin(options_), std::end(options_), [narg_name](
const Option_p &opt) {
1935 return opt->check_sname(narg_name);
1937 if(op_ptr != std::end(options_)) {
1938 arg_name = narg_name;
1946 if(parent_ !=
nullptr && name_.empty()) {
1951 auto dotloc = arg_name.find_first_of(
'.', 1);
1952 if(dotloc != std::string::npos) {
1954 auto *sub = _find_subcommand(arg_name.substr(0, dotloc),
true,
false);
1955 if(sub !=
nullptr) {
1956 std::string v = args.back();
1958 arg_name = arg_name.substr(dotloc + 1);
1959 if(arg_name.size() > 1) {
1960 args.push_back(std::string(
"--") + v.substr(dotloc + 3));
1961 current_type = detail::Classifier::LONG;
1963 auto nval = v.substr(dotloc + 2);
1965 if(nval.size() > 2) {
1967 args.push_back(nval.substr(3));
1970 args.push_back(nval);
1971 current_type = detail::Classifier::SHORT;
1973 auto val = sub->_parse_arg(args, current_type,
true);
1976 parsed_subcommands_.push_back(sub);
1980 _trigger_pre_parse(args.size());
1982 if(sub->parse_complete_callback_) {
1983 sub->_process_env();
1984 sub->_process_callbacks();
1985 sub->_process_help_flags();
1986 sub->_process_requirements();
1987 sub->run_callback(
false,
true);
1995 if(local_processing_only) {
1999 if(parent_ !=
nullptr && fallthrough_)
2000 return _get_fallthrough_parent()->_parse_arg(args, current_type,
false);
2004 _move_to_missing(current_type, current);
2011 Option_p &op = *op_ptr;
2013 if(op->get_inject_separator()) {
2014 if(!op->results().empty() && !op->results().back().empty()) {
2015 op->add_result(std::string{});
2018 if(op->get_trigger_on_parse() && op->current_option_state_ == Option::option_state::callback_run) {
2021 int min_num = (std::min)(op->get_type_size_min(), op->get_items_expected_min());
2022 int max_num = op->get_items_expected_max();
2025 if(max_num >= detail::expected_max_vector_size / 16 && !op->get_allow_extra_args()) {
2026 auto tmax = op->get_type_size_max();
2027 max_num = detail::checked_multiply(tmax, op->get_expected_min()) ? tmax : detail::expected_max_vector_size;
2031 int result_count = 0;
2034 auto res = op->get_flag_value(arg_name, value);
2035 op->add_result(res);
2036 parse_order_.push_back(op.get());
2037 }
else if(!value.empty()) {
2038 op->add_result(value, result_count);
2039 parse_order_.push_back(op.get());
2040 collected += result_count;
2042 }
else if(!rest.empty()) {
2043 op->add_result(rest, result_count);
2044 parse_order_.push_back(op.get());
2046 collected += result_count;
2050 while(min_num > collected && !args.empty()) {
2051 std::string current_ = args.back();
2053 op->add_result(current_, result_count);
2054 parse_order_.push_back(op.get());
2055 collected += result_count;
2058 if(min_num > collected) {
2059 throw ArgumentMismatch::TypedAtLeast(op->get_name(), min_num, op->get_type_name());
2063 if(max_num > collected || op->get_allow_extra_args()) {
2064 auto remreqpos = _count_remaining_positionals(
true);
2066 while((collected < max_num || op->get_allow_extra_args()) && !args.empty() &&
2067 _recognize(args.back(),
false) == detail::Classifier::NONE) {
2069 if(remreqpos >= args.size()) {
2072 if(validate_optional_arguments_) {
2073 std::string arg = args.back();
2074 arg = op->_validate(arg, 0);
2079 op->add_result(args.back(), result_count);
2080 parse_order_.push_back(op.get());
2082 collected += result_count;
2086 if(!args.empty() && _recognize(args.back()) == detail::Classifier::POSITIONAL_MARK)
2089 if(min_num == 0 && max_num > 0 && collected == 0) {
2090 auto res = op->get_flag_value(arg_name, std::string{});
2091 op->add_result(res);
2092 parse_order_.push_back(op.get());
2096 if(min_num > 0 && (collected % op->get_type_size_max()) != 0) {
2097 if(op->get_type_size_max() != op->get_type_size_min()) {
2098 op->add_result(std::string{});
2100 throw ArgumentMismatch::PartialType(op->get_name(), op->get_type_size_min(), op->get_type_name());
2103 if(op->get_trigger_on_parse()) {
2108 args.push_back(rest);
2113CLI11_INLINE
void App::_trigger_pre_parse(std::size_t remaining_args) {
2114 if(!pre_parse_called_) {
2115 pre_parse_called_ =
true;
2116 if(pre_parse_callback_) {
2117 pre_parse_callback_(remaining_args);
2119 }
else if(immediate_callback_) {
2120 if(!name_.empty()) {
2121 auto pcnt = parsed_;
2122 missing_t extras = std::move(missing_);
2125 pre_parse_called_ =
true;
2126 missing_ = std::move(extras);
2131CLI11_INLINE
App *App::_get_fallthrough_parent() {
2132 if(parent_ ==
nullptr) {
2135 auto *fallthrough_parent = parent_;
2136 while((fallthrough_parent->parent_ !=
nullptr) && (fallthrough_parent->get_name().empty())) {
2137 fallthrough_parent = fallthrough_parent->
parent_;
2139 return fallthrough_parent;
2142CLI11_NODISCARD CLI11_INLINE
const std::string &App::_compare_subcommand_names(
const App &subcom,
2143 const App &base)
const {
2144 static const std::string estring;
2145 if(subcom.disabled_) {
2148 for(
const auto &subc : base.subcommands_) {
2149 if(subc.get() != &subcom) {
2150 if(subc->disabled_) {
2153 if(!subcom.get_name().empty()) {
2154 if(subc->check_name(subcom.get_name())) {
2155 return subcom.get_name();
2158 if(!subc->get_name().empty()) {
2159 if(subcom.check_name(subc->get_name())) {
2160 return subc->get_name();
2163 for(
const auto &les : subcom.aliases_) {
2164 if(subc->check_name(les)) {
2169 for(
const auto &les : subc->aliases_) {
2170 if(subcom.check_name(les)) {
2175 if(subc->get_name().empty()) {
2176 const auto &cmpres = _compare_subcommand_names(subcom, *subc);
2177 if(!cmpres.empty()) {
2182 if(subcom.get_name().empty()) {
2183 const auto &cmpres = _compare_subcommand_names(*subc, subcom);
2184 if(!cmpres.empty()) {
2193CLI11_INLINE
void App::_move_to_missing(detail::Classifier val_type,
const std::string &val) {
2194 if(allow_extras_ || subcommands_.empty()) {
2195 missing_.emplace_back(val_type, val);
2199 for(
auto &subc : subcommands_) {
2200 if(subc->name_.empty() && subc->allow_extras_) {
2201 subc->missing_.emplace_back(val_type, val);
2206 missing_.emplace_back(val_type, val);
2210 if(opt ==
nullptr) {
2215 for(
auto &subc : subcommands_) {
2216 if(app == subc.get()) {
2224 if((help_ptr_ == opt) || (help_all_ptr_ == opt))
2227 if(config_ptr_ == opt)
2231 std::find_if(std::begin(options_), std::end(options_), [opt](
const Option_p &v) {
return v.get() == opt; });
2232 if(iterator != std::end(options_)) {
2233 const auto &opt_p = *iterator;
2234 if(std::find_if(std::begin(app->options_), std::end(app->options_), [&opt_p](
const Option_p &v) {
2235 return (*v == *opt_p);
2236 }) == std::end(app->options_)) {
2238 app->options_.push_back(std::move(*iterator));
2239 options_.erase(iterator);
2248CLI11_INLINE
void TriggerOn(
App *trigger_app,
App *app_to_enable) {
2249 app_to_enable->enabled_by_default(
false);
2250 app_to_enable->disabled_by_default();
2251 trigger_app->preparse_callback([app_to_enable](std::size_t) { app_to_enable->disabled(
false); });
2254CLI11_INLINE
void TriggerOn(App *trigger_app, std::vector<App *> apps_to_enable) {
2255 for(
auto &app : apps_to_enable) {
2256 app->enabled_by_default(
false);
2257 app->disabled_by_default();
2260 trigger_app->preparse_callback([apps_to_enable](std::size_t) {
2261 for(
const auto &app : apps_to_enable) {
2262 app->disabled(
false);
2267CLI11_INLINE
void TriggerOff(App *trigger_app, App *app_to_enable) {
2268 app_to_enable->disabled_by_default(
false);
2269 app_to_enable->enabled_by_default();
2270 trigger_app->preparse_callback([app_to_enable](std::size_t) { app_to_enable->disabled(); });
2273CLI11_INLINE
void TriggerOff(App *trigger_app, std::vector<App *> apps_to_enable) {
2274 for(
auto &app : apps_to_enable) {
2275 app->disabled_by_default(
false);
2276 app->enabled_by_default();
2279 trigger_app->preparse_callback([apps_to_enable](std::size_t) {
2280 for(
const auto &app : apps_to_enable) {
2286CLI11_INLINE
void deprecate_option(Option *opt,
const std::string &replacement) {
2287 Validator deprecate_warning{[opt, replacement](std::string &) {
2288 std::cout << opt->get_name() <<
" is deprecated please use '" << replacement
2290 return std::string();
2293 deprecate_warning.application_index(0);
2294 opt->check(deprecate_warning);
2295 if(!replacement.empty()) {
2296 opt->description(opt->get_description() +
" DEPRECATED: please use '" + replacement +
"' instead");
2300CLI11_INLINE
void retire_option(App *app, Option *opt) {
2302 auto *option_copy = temp.add_option(opt->get_name(
false,
true))
2303 ->type_size(opt->get_type_size_min(), opt->get_type_size_max())
2304 ->expected(opt->get_expected_min(), opt->get_expected_max())
2305 ->allow_extra_args(opt->get_allow_extra_args());
2307 app->remove_option(opt);
2308 auto *opt2 = app->add_option(option_copy->get_name(
false,
true),
"option has been retired and has no effect");
2309 opt2->type_name(
"RETIRED")
2310 ->default_str(
"RETIRED")
2311 ->type_size(option_copy->get_type_size_min(), option_copy->get_type_size_max())
2312 ->expected(option_copy->get_expected_min(), option_copy->get_expected_max())
2313 ->allow_extra_args(option_copy->get_allow_extra_args());
2317 Validator retired_warning{[opt2](std::string &) {
2318 std::cout <<
"WARNING " << opt2->get_name() <<
" is retired and has no effect\n";
2319 return std::string();
2323 retired_warning.application_index(0);
2324 opt2->check(retired_warning);
2327CLI11_INLINE
void retire_option(App &app, Option *opt) { retire_option(&app, opt); }
2329CLI11_INLINE
void retire_option(App *app,
const std::string &option_name) {
2331 auto *opt = app->get_option_no_throw(option_name);
2332 if(opt !=
nullptr) {
2333 retire_option(app, opt);
2336 auto *opt2 = app->add_option(option_name,
"option has been retired and has no effect")
2337 ->type_name(
"RETIRED")
2339 ->default_str(
"RETIRED");
2342 Validator retired_warning{[opt2](std::string &) {
2343 std::cout <<
"WARNING " << opt2->get_name() <<
" is retired and has no effect\n";
2344 return std::string();
2348 retired_warning.application_index(0);
2349 opt2->check(retired_warning);
2352CLI11_INLINE
void retire_option(App &app,
const std::string &option_name) { retire_option(&app, option_name); }
2354namespace FailureMessage {
2356CLI11_INLINE std::string simple(
const App *app,
const Error &e) {
2357 std::string header = std::string(e.what()) +
"\n";
2358 std::vector<std::string> names;
2361 if(app->get_help_ptr() !=
nullptr)
2362 names.push_back(app->get_help_ptr()->get_name());
2364 if(app->get_help_all_ptr() !=
nullptr)
2365 names.push_back(app->get_help_all_ptr()->get_name());
2369 header +=
"Run with " + detail::join(names,
" or ") +
" for more information.\n";
2374CLI11_INLINE std::string help(
const App *app,
const Error &e) {
2375 std::string header = std::string(
"ERROR: ") + e.get_name() +
": " + e.what() +
"\n";
2376 header += app->help();
Creates a command line program, with very few defaults.
Definition App.hpp:90
CLI11_NODISCARD Option * get_option_no_throw(std::string option_name) noexcept
Get an option by name (noexcept non-const version)
Definition App_inl.hpp:844
bool subcommand_fallthrough_
Allow subcommands to fallthrough, so that parent commands can trigger other subcommands after subcomm...
Definition App.hpp:232
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_inl.hpp:674
CLI11_NODISCARD std::string help(std::string prev="", AppFormatMode mode=AppFormatMode::Normal) const
Definition App_inl.hpp:770
CLI11_NODISCARD std::size_t remaining_size(bool recurse=false) const
This returns the number of remaining options, minus the – separator.
Definition App_inl.hpp:969
CLI11_NODISCARD 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_inl.hpp:1082
App * immediate_callback(bool immediate=true)
Set the subcommand callback to be executed immediately on subcommand completion.
Definition App_inl.hpp:120
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_inl.hpp:251
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_inl.hpp:2131
bool allow_non_standard_options_
indicator that the subcommand should allow non-standard option arguments, such as -single_dash_flag
Definition App.hpp:264
Option * config_ptr_
Pointer to the config option.
Definition App.hpp:295
std::size_t require_option_min_
Minimum required options (not inheritable!)
Definition App.hpp:276
App * ignore_underscore(bool value=true)
Ignore underscore. Subcommands inherit value.
Definition App_inl.hpp:146
std::size_t require_subcommand_max_
Max number of subcommands allowed (parsing stops after this number). 0 is unlimited INHERITABLE.
Definition App.hpp:273
std::vector< App_p > subcommands_
Storage for subcommand list.
Definition App.hpp:219
CLI11_NODISCARD std::vector< std::string > remaining(bool recurse=false) const
This returns the missing options from the current subcommand.
Definition App_inl.hpp:937
CLI11_NODISCARD 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_inl.hpp:963
std::uint32_t parsed_
Counts the number of times this command/subcommand was parsed.
Definition App.hpp:267
CLI11_NODISCARD App * get_option_group(std::string group_name) const
Check to see if an option group is part of this App.
Definition App_inl.hpp:526
std::string usage_
Usage to put after program/subcommand description in the help output INHERITABLE.
Definition App.hpp:156
OptionDefaults option_defaults_
The default values for options, customizable and changeable INHERITABLE.
Definition App.hpp:146
void _process_help_flags(bool trigger_help=false, bool trigger_all_help=false) const
Definition App_inl.hpp:1219
void _process_requirements()
Verify required options and cross requirements. Subcommands too (only if selected).
Definition App_inl.hpp:1241
CLI11_NODISCARD std::size_t count_all() const
Definition App_inl.hpp:535
bool disabled_
If set to true the subcommand is disabled and cannot be used, ignored for main app.
Definition App.hpp:123
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_inl.hpp:284
bool remove_needs(Option *opt)
Removes an option from the needs list of this subcommand.
Definition App_inl.hpp:752
Option * get_help_ptr()
Get a pointer to the help flag.
Definition App.hpp:1178
void _configure()
Definition App_inl.hpp:1018
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_inl.hpp:360
void parse(int argc, const char *const *argv)
Definition App_inl.hpp:564
void _process_config_file()
Read and process a configuration file (main app only)
Definition App_inl.hpp:1137
std::string footer_
Footer to put after all options in the help output INHERITABLE.
Definition App.hpp:162
config_extras_mode allow_config_extras_
Definition App.hpp:111
CLI11_NODISCARD bool check_name(std::string name_to_check) const
Check the name, case-insensitive and underscore insensitive if set.
Definition App_inl.hpp:896
Option * version_ptr_
A pointer to a version flag if there is one.
Definition App.hpp:174
CLI11_NODISCARD const Option * get_help_all_ptr() const
Get a pointer to the help all flag. (const)
Definition App.hpp:1184
bool remove_subcommand(App *subcom)
Removes a subcommand from the App. Takes a subcommand pointer. Returns true if found and removed.
Definition App_inl.hpp:456
App * parent_
A pointer to the parent if this is a subcommand.
Definition App.hpp:282
std::set< Option * > exclude_options_
Definition App.hpp:204
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_inl.hpp:501
std::function< void()> parse_complete_callback_
This is a function that runs when parsing has finished.
Definition App.hpp:136
virtual void pre_callback()
Definition App.hpp:868
Option * add_flag(std::string flag_name)
Add a flag with no description or variable assignment.
Definition App.hpp:639
void _validate() const
Definition App_inl.hpp:983
std::string name_
Subcommand name or program name (from parser if name is empty)
Definition App.hpp:101
std::vector< App * > parsed_subcommands_
This is a list of the subcommands collected, in order.
Definition App.hpp:197
bool ignore_underscore_
If true, the program should ignore underscores INHERITABLE.
Definition App.hpp:225
missing_t missing_
Definition App.hpp:191
void run_callback(bool final_mode=false, bool suppress_final_callback=false)
Internal function to run (App) callback, bottom up.
Definition App_inl.hpp:1038
std::size_t require_subcommand_min_
Minimum required subcommands (not inheritable!)
Definition App.hpp:270
void _process_env()
Get envname options if not yet passed. Runs on all subcommands.
Definition App_inl.hpp:1173
std::function< std::string(const App *, const Error &e)> failure_message_
The error message printing function INHERITABLE.
Definition App.hpp:180
void _parse_stream(std::istream &input)
Internal function to parse a stream.
Definition App_inl.hpp:1473
CLI11_NODISCARD std::string get_display_name(bool with_aliases=false) const
Get a display name for an app.
Definition App_inl.hpp:880
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:117
CLI11_NODISCARD 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_inl.hpp:2142
void clear()
Reset the parsed data.
Definition App_inl.hpp:549
App * get_subcommand(const App *subcom) const
Definition App_inl.hpp:472
CLI11_NODISCARD std::string version() const
Displays a version string.
Definition App_inl.hpp:784
CLI11_NODISCARD App * get_subcommand_no_throw(std::string subcom) const noexcept
Definition App_inl.hpp:488
std::vector< Option_p > options_
The list of options, stored locally.
Definition App.hpp:149
Option * help_all_ptr_
A pointer to the help all flag if there is one INHERITABLE.
Definition App.hpp:171
bool validate_optional_arguments_
If set to true optional vector arguments are validated before assigning INHERITABLE.
Definition App.hpp:257
std::function< void()> final_callback_
This is a function that runs when all processing has completed.
Definition App.hpp:139
bool remove_option(Option *opt)
Removes an option from the App. Takes an option pointer. Returns true if found and removed.
Definition App_inl.hpp:404
App(std::string app_description, std::string app_name, App *parent)
Special private constructor for subcommand.
Definition App_inl.hpp:29
App * add_subcommand(std::string subcommand_name="", std::string subcommand_description="")
Add a subcommand. Inherits INHERITABLE and OptionDefaults, and help flag.
Definition App_inl.hpp:425
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_inl.hpp:343
bool immediate_callback_
Definition App.hpp:130
App * name(std::string app_name="")
Set a name for the app (empty will use parser to set the name)
Definition App_inl.hpp:85
CLI11_NODISCARD 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_inl.hpp:1065
bool configurable_
if set to true the subcommand can be triggered via configuration files INHERITABLE
Definition App.hpp:251
CLI11_NODISCARD std::vector< std::string > get_groups() const
Get the groups available directly from this option (in order)
Definition App_inl.hpp:924
void _parse_config(const std::vector< ConfigItem > &args)
Definition App_inl.hpp:1484
std::size_t require_option_max_
Max number of options allowed. 0 is unlimited (not inheritable)
Definition App.hpp:279
std::vector< std::string > aliases_
Alias names for the subcommand.
Definition App.hpp:288
std::set< App * > exclude_subcommands_
this is a list of subcommands that are exclusionary to this one
Definition App.hpp:200
bool ignore_case_
If true, the program name is not case-sensitive INHERITABLE.
Definition App.hpp:222
CLI11_NODISCARD const std::string & get_group() const
Get the group of this subcommand.
Definition App.hpp:1119
std::string group_
The group membership INHERITABLE.
Definition App.hpp:285
App * alias(std::string app_name)
Set an alias for the app.
Definition App_inl.hpp:102
bool pre_parse_called_
Flag indicating that the pre_parse_callback has been triggered.
Definition App.hpp:126
void _process_callbacks()
Process callbacks. Runs on all subcommands.
Definition App_inl.hpp:1195
Option * help_ptr_
A pointer to the help flag if there is one INHERITABLE.
Definition App.hpp:168
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_inl.hpp:375
App * ignore_case(bool value=true)
Ignore case. Subcommands inherit value.
Definition App_inl.hpp:132
bool remove_excludes(Option *opt)
Removes an option from the excludes list of this subcommand.
Definition App_inl.hpp:732
CLI11_NODISCARD std::vector< App * > get_subcommands() const
Definition App.hpp:919
bool fallthrough_
Definition App.hpp:229
std::set< Option * > need_options_
Definition App.hpp:212
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_inl.hpp:802
std::set< App * > need_subcommands_
Definition App.hpp:208
bool prefix_command_
If true, cease processing on an unrecognized option (implies allow_extras) INHERITABLE.
Definition App.hpp:114
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_inl.hpp:160
void _parse(std::vector< std::string > &args)
Internal parse function.
Definition App_inl.hpp:1429
bool validate_positionals_
If set to true positional options are validated before assigning INHERITABLE.
Definition App.hpp:254
startup_mode default_startup
Definition App.hpp:248
bool allow_extras_
If true, allow extra arguments (ie, don't throw an error). INHERITABLE.
Definition App.hpp:107
CLI11_NODISCARD char ** ensure_utf8(char **argv)
Convert the contents of argv to UTF-8. Only does something on Windows, does nothing elsewhere.
Definition App_inl.hpp:63
CLI11_NODISCARD App * _find_subcommand(const std::string &subc_name, bool ignore_disabled, bool ignore_used) const noexcept
Definition App_inl.hpp:1821
CLI11_NODISCARD const std::string & get_name() const
Get the name of the current app.
Definition App.hpp:1205
std::shared_ptr< FormatterBase > formatter_
This is the formatter for help printing. Default provided. INHERITABLE (same pointer)
Definition App.hpp:177
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_inl.hpp:267
bool allow_windows_style_options_
Allow '/' for options for Windows like options. Defaults to true on Windows, false otherwise....
Definition App.hpp:235
std::shared_ptr< Config > config_formatter_
This is the formatter for help printing. Default provided. INHERITABLE (same pointer)
Definition App.hpp:298
Usually something like –help-all on command line.
Definition Error.hpp:178
-h or –help on command line
Definition Error.hpp:172
-v or –version on command line
Definition Error.hpp:185
All errors derive from this one.
Definition Error.hpp:73
Thrown when an excludes option is present.
Definition Error.hpp:301
Thrown when parsing an INI file and it is missing.
Definition Error.hpp:198
Thrown when an option is set to conflicting values (non-vector and multi args, for example)
Definition Error.hpp:96
Thrown when validation fails before parsing.
Definition Error.hpp:334
Thrown when an option already exists.
Definition Error.hpp:144
CLI11_NODISCARD bool get_required() const
True if this is a required option.
Definition Option.hpp:118
CRTP * configurable(bool value=true)
Allow in a configuration file.
Definition Option.hpp:180
void copy_to(T *other) const
Copy the contents to another similar class (one based on OptionBase)
Definition Option_inl.hpp:24
CRTP * required(bool value=true)
Set the option as required.
Definition Option.hpp:99
Definition Option.hpp:231
Option * expected(int value)
Set the number of expected arguments.
Definition Option_inl.hpp:36
CLI11_NODISCARD bool get_positional() const
True if the argument can be given directly.
Definition Option.hpp:587
void run_callback()
Process the callback.
Definition Option_inl.hpp:286
CLI11_NODISCARD 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_inl.hpp:233
bool force_callback_
flag indicating that the option should force the callback regardless if any results present
Definition Option.hpp:340
CLI11_NODISCARD const results_t & results() const
Get the current complete results set.
Definition Option.hpp:671
CLI11_NODISCARD std::size_t count() const
Count the total number of times an option was passed.
Definition Option.hpp:361
Option * multi_option_policy(MultiOptionPolicy value=MultiOptionPolicy::Throw)
Take the last argument if given multiple times (or another policy)
Definition Option_inl.hpp:220
CLI11_NODISCARD const std::string & get_description() const
Get the description.
Definition Option.hpp:596
CLI11_NODISCARD const std::string & get_single_name() const
Get a single name for the option, first of lname, sname, pname, envname.
Definition Option.hpp:555
void clear()
Clear the parsed results (mostly for testing)
Definition Option.hpp:370
Option * default_str(std::string val)
Set the default value string representation (does not change the contained value)
Definition Option.hpp:757
std::string envname_
If given, check the environment for this option.
Definition Option.hpp:255
Option * add_result(std::string s)
Puts a result at the end.
Definition Option_inl.hpp:429
CLI11_NODISCARD T as() const
Return the results as the specified type.
Definition Option.hpp:708
Thrown when counting a nonexistent option.
Definition Error.hpp:351
Anything that can error in Parse.
Definition Error.hpp:159
Thrown when a required option is missing.
Definition Error.hpp:228
Thrown when a requires option is missing.
Definition Error.hpp:294
Holds values to load into Options.
Definition ConfigFwd.hpp:29