15#include "../Encoding.hpp"
37CLI11_INLINE
App::App(std::string app_description, std::string app_name,
App *parent)
41 if(
parent_->help_ptr_ !=
nullptr)
43 if(
parent_->help_all_ptr_ !=
nullptr)
72CLI11_INLINE
App::App(std::string app_description, std::string app_name) :
App(app_description, app_name, nullptr) {
73 set_help_flag(
"-h,--help",
"Print this help message and exit");
80 normalized_argv_ = detail::compute_win32_argv();
82 if(!normalized_argv_view_.empty()) {
83 normalized_argv_view_.clear();
86 normalized_argv_view_.reserve(normalized_argv_.size());
87 for(
auto &arg : normalized_argv_) {
89 normalized_argv_view_.push_back(
const_cast<char *
>(arg.data()));
92 return normalized_argv_view_.data();
110 std::string oname =
name_;
125 if(app_name.empty() || !detail::valid_alias_name_string(app_name)) {
133 throw(
OptionAlreadyAdded(
"alias already matches an existing subcommand: " + app_name));
189 throw OptionAlreadyAdded(
"ignore case would cause subcommand name conflicts: " + match);
203 throw OptionAlreadyAdded(
"ignore underscore would cause subcommand name conflicts: " + match);
211 callback_t option_callback,
212 std::string option_description,
214 std::function<std::string()> func) {
219 std::find_if(std::begin(
options_), std::end(
options_), [&myopt](
const Option_p &v) {
return *v == myopt; });
221 const auto &matchname = (*res)->matching_name(myopt);
225 const App *top_level_parent =
this;
226 while(top_level_parent->
name_.empty() && top_level_parent->
parent_ !=
nullptr) {
227 top_level_parent = top_level_parent->
parent_;
234 if(test_name.size() == 3) {
235 test_name.erase(0, 1);
239 if(op !=
nullptr && op->get_configurable()) {
240 throw(
OptionAlreadyAdded(
"added option positional name matches existing option: " + test_name));
245 if(op !=
nullptr && op->lnames_.empty() && op->snames_.empty()) {
246 throw(
OptionAlreadyAdded(
"unable to disambiguate with existing option: " + test_name));
248 }
else if(top_level_parent !=
this) {
249 for(
auto &ln : myopt.
lnames_) {
251 if(op !=
nullptr && op->get_configurable()) {
255 if(op !=
nullptr && op->get_configurable()) {
260 if(op !=
nullptr && op->get_configurable()) {
265 for(
auto &sn : myopt.
snames_) {
267 if(op !=
nullptr && op->get_configurable()) {
271 if(op !=
nullptr && op->get_configurable()) {
275 if(op !=
nullptr && op->get_configurable()) {
282 for(
auto &sname : myopt.
snames_) {
283 if(sname.length() > 1) {
284 std::string test_name;
285 test_name.push_back(
'-');
286 test_name.push_back(sname.front());
289 throw(
OptionAlreadyAdded(
"added option interferes with existing short option: " + sname));
294 for(
const auto &osn : opt->snames_) {
296 std::string test_name;
297 test_name.push_back(osn.front());
299 throw(
OptionAlreadyAdded(
"added option interferes with existing non standard option: " + osn));
310 option->default_function(func);
314 option->capture_default_str();
320 if(!defaulted && option->get_always_capture_default())
321 option->capture_default_str();
327 return add_option(option_name, CLI::callback_t{}, std::string{},
false);
338 if(!flag_name.empty()) {
340 help_ptr_->configurable(
false)->callback_priority(CallbackPriority::First);
354 if(!help_name.empty()) {
356 help_all_ptr_->configurable(
false)->callback_priority(CallbackPriority::First);
371 if(!flag_name.empty()) {
373 flag_name, [versionString]() {
throw(
CLI::CallForVersion(versionString, 0)); }, version_help);
374 version_ptr_->configurable(
false)->callback_priority(CallbackPriority::First);
388 if(!flag_name.empty()) {
391 version_ptr_->configurable(
false)->callback_priority(CallbackPriority::First);
397CLI11_INLINE
Option *App::_add_flag_internal(std::string flag_name, CLI::callback_t fun, std::string flag_description) {
399 if(detail::has_default_flag_values(flag_name)) {
401 auto flag_defaults = detail::get_default_flag_values(flag_name);
402 detail::remove_default_flag_values(flag_name);
403 opt =
add_option(std::move(flag_name), std::move(fun), std::move(flag_description),
false);
404 for(
const auto &fname : flag_defaults)
405 opt->
fnames_.push_back(fname.first);
408 opt =
add_option(std::move(flag_name), std::move(fun), std::move(flag_description),
false);
412 auto pos_name = opt->
get_name(
true);
414 throw IncorrectConstruction::PositionalFlag(pos_name);
423 return _add_flag_internal(flag_name, CLI::callback_t(), std::string{});
427 std::function<
void(
void)> function,
428 std::string flag_description) {
430 CLI::callback_t fun = [function](
const CLI::results_t &res) {
431 using CLI::detail::lexical_cast;
433 auto result = lexical_cast(res[0], trigger);
434 if(result && trigger) {
439 return _add_flag_internal(flag_name, std::move(fun), std::move(flag_description));
444 std::function<
void(std::int64_t)> function,
445 std::string flag_description) {
447 CLI::callback_t fun = [function](
const CLI::results_t &res) {
448 using CLI::detail::lexical_cast;
449 std::int64_t flag_count{0};
450 lexical_cast(res[0], flag_count);
451 function(flag_count);
454 return _add_flag_internal(flag_name, std::move(fun), std::move(flag_description))
459 std::string default_filename,
460 const std::string &help_message,
461 bool config_required) {
470 if(!option_name.empty()) {
472 if(config_required) {
475 if(!default_filename.empty()) {
476 config_ptr_->default_str(std::move(default_filename));
481 config_ptr_->multi_option_policy(MultiOptionPolicy::Reverse);
490 op->remove_needs(opt);
491 op->remove_excludes(opt);
502 std::find_if(std::begin(
options_), std::end(
options_), [opt](
const Option_p &v) {
return v.get() == opt; });
503 if(iterator != std::end(
options_)) {
511 if(!subcommand_name.empty() && !detail::valid_name_string(subcommand_name)) {
512 if(!detail::valid_first_char(subcommand_name[0])) {
514 "Subcommand name starts with invalid character, '!' and '-' and control characters");
516 for(
auto c : subcommand_name) {
517 if(!detail::valid_later_char(c)) {
519 "'), all characters are allowed except"
520 "'=',':','{','}', ' ', and control characters");
524 CLI::App_p subcom = std::shared_ptr<App>(
new App(std::move(subcommand_description), subcommand_name,
this));
534 throw(
OptionAlreadyAdded(
"subcommand name or alias matches existing subcommand: " + mstrg));
536 subcom->parent_ =
this;
544 sub->remove_excludes(subcom);
545 sub->remove_needs(subcom);
548 auto iterator = std::find_if(
558 if(subcom ==
nullptr)
561 if(subcomptr.get() == subcom)
562 return subcomptr.get();
579 auto uindex =
static_cast<unsigned>(index);
587 if(subcom ==
nullptr)
590 if(subcomptr.get() == subcom)
597 if(subcomptr->check_name(subcom))
604 auto uindex =
static_cast<unsigned>(index);
613 if(app->name_.empty() && app->group_ == group_name) {
626 cnt += sub->count_all();
642 for(
const Option_p &opt :
options_) {
650CLI11_INLINE
void App::parse(
int argc,
const char *
const *argv) { parse_char_t(argc, argv); }
651CLI11_INLINE
void App::parse(
int argc,
const wchar_t *
const *argv) { parse_char_t(argc, argv); }
656CLI11_INLINE
const char *maybe_narrow(
const char *str) {
return str; }
657CLI11_INLINE std::string maybe_narrow(
const wchar_t *str) {
return narrow(str); }
661template <
class CharT> CLI11_INLINE
void App::parse_char_t(
int argc,
const CharT *
const *argv) {
664 parse(std::vector<std::string>{});
671 name_ = detail::maybe_narrow(argv[0]);
674 std::vector<std::string> args;
675 args.reserve(
static_cast<std::size_t
>(argc) - 1U);
676 for(
auto i =
static_cast<std::size_t
>(argc) - 1U; i > 0U; --i)
677 args.emplace_back(detail::maybe_narrow(argv[i]));
679 parse(std::move(args));
682CLI11_INLINE
void App::parse(std::string commandline,
bool program_name_included) {
684 if(program_name_included) {
685 auto nstr = detail::split_program_name(commandline);
690 commandline = std::move(nstr.second);
692 detail::trim(commandline);
695 if(!commandline.empty()) {
696 commandline = detail::find_and_modify(commandline,
"=", detail::escape_detect);
698 commandline = detail::find_and_modify(commandline,
":", detail::escape_detect);
701 auto args = detail::split_up(std::move(commandline));
703 args.erase(std::remove(args.begin(), args.end(), std::string{}), args.end());
705 detail::remove_quotes(args);
706 }
catch(
const std::invalid_argument &arg) {
709 std::reverse(args.begin(), args.end());
710 parse(std::move(args));
713CLI11_INLINE
void App::parse(std::wstring commandline,
bool program_name_included) {
714 parse(narrow(commandline), program_name_included);
733CLI11_INLINE
void App::parse(std::vector<std::string> &args) {
739CLI11_INLINE
void App::parse(std::vector<std::string> &&args) {
745CLI11_INLINE
void App::parse_from_stream(std::istream &input) {
756CLI11_INLINE
int App::exit(
const Error &e, std::ostream &out, std::ostream &err)
const {
759 if(e.get_name() ==
"RuntimeError")
760 return e.get_exit_code();
762 if(e.get_name() ==
"CallForHelp") {
764 return e.get_exit_code();
767 if(e.get_name() ==
"CallForAllHelp") {
768 out <<
help(
"", AppFormatMode::All);
769 return e.get_exit_code();
772 if(e.get_name() ==
"CallForVersion") {
773 out << e.what() <<
'\n';
774 return e.get_exit_code();
777 if(e.get_exit_code() !=
static_cast<int>(ExitCodes::Success)) {
782 return e.get_exit_code();
787CLI11_INLINE
int App::exit(
const Error &e, std::ostream &out)
const {
return exit(e, out, std::cerr); }
795 subcomms.erase(std::remove_if(std::begin(subcomms),
797 [&filter](
const App *app) {
return !filter(app); }),
811 std::remove_if(std::begin(subcomms), std::end(subcomms), [&filter](
App *app) {
return !filter(app); }),
847 return (sub !=
nullptr) ? (sub->
parsed_ > 0) :
false;
873CLI11_INLINE
App *App::needs(
Option *opt) {
881CLI11_INLINE
App *App::needs(
App *app) {
883 throw OptionNotFound(
"nullptr passed");
886 throw OptionNotFound(
"cannot self reference in needs");
906 auto *other_app = *iterator;
908 other_app->remove_excludes(
this);
934CLI11_NODISCARD CLI11_INLINE std::string
App::config_to_str(ConfigOutputMode mode,
bool write_description)
const {
938CLI11_NODISCARD CLI11_INLINE std::string
App::config_to_str(
bool default_also,
bool write_description)
const {
939 return config_to_str(default_also ? ConfigOutputMode::AllDefaults : ConfigOutputMode::Active, write_description);
950CLI11_NODISCARD CLI11_INLINE std::string
App::help(std::string prev, AppFormatMode mode)
const {
958 if(!selected_subcommands.empty()) {
959 return selected_subcommands.back()->help(prev, mode);
961 return formatter_->make_help(
this, prev, mode);
982CLI11_INLINE std::vector<const Option *>
App::get_options(
const std::function<
bool(
const Option *)> filter)
const {
983 std::vector<const Option *> options(
options_.size());
985 std::begin(
options_), std::end(
options_), std::begin(options), [](
const Option_p &val) {
return val.get(); });
988 options.erase(std::remove_if(std::begin(options),
990 [&filter](
const Option *opt) {
return !filter(opt); }),
995 const App *subc = subcp.get();
997 std::vector<const Option *> subcopts = subc->
get_options(filter);
998 options.insert(options.end(), subcopts.begin(), subcopts.end());
1003 std::vector<const Option *> subcopts = fallthrough_parent->get_options(filter);
1004 for(
const auto *opt : subcopts) {
1005 if(std::find_if(options.begin(), options.end(), [opt](
const Option *opt2) {
1006 return opt->check_name(opt2->get_name());
1007 }) == options.end()) {
1008 options.push_back(opt);
1015CLI11_INLINE std::vector<Option *>
App::get_options(
const std::function<
bool(Option *)> filter) {
1016 std::vector<Option *> options(
options_.size());
1018 std::begin(
options_), std::end(
options_), std::begin(options), [](
const Option_p &val) {
return val.get(); });
1022 std::remove_if(std::begin(options), std::end(options), [&filter](Option *opt) {
return !filter(opt); }),
1028 if(subc->get_name().empty() || (!subc->get_group().empty() && subc->get_group().front() ==
'+')) {
1029 auto subcopts = subc->get_options(filter);
1030 options.insert(options.end(), subcopts.begin(), subcopts.end());
1035 std::vector<Option *> subcopts = fallthrough_parent->get_options(filter);
1036 for(
auto *opt : subcopts) {
1037 if(std::find_if(options.begin(), options.end(), [opt](Option *opt2) {
1038 return opt->check_name(opt2->get_name());
1039 }) == options.end()) {
1040 options.push_back(opt);
1048CLI11_NODISCARD CLI11_INLINE
const Option *
App::get_option(std::string option_name)
const {
1050 if(opt ==
nullptr) {
1065 if(opt ==
nullptr) {
1085 if(subc->get_name().empty()) {
1086 auto *opt = subc->get_option_no_throw(option_name);
1087 if(opt !=
nullptr) {
1101 for(
const Option_p &opt :
options_) {
1108 if(subc->get_name().empty()) {
1109 auto *opt = subc->get_option_no_throw(option_name);
1110 if(opt !=
nullptr) {
1123 return std::string(
"[Option Group: ") +
get_group() +
"]";
1125 if(
aliases_.empty() || !with_aliases) {
1128 std::string dispname =
name_;
1129 for(
const auto &lalias :
aliases_) {
1130 dispname.push_back(
',');
1131 dispname.push_back(
' ');
1132 dispname.append(lalias);
1139 return (result != NameMatch::none);
1143 std::string local_name =
name_;
1145 local_name = detail::remove_underscore(
name_);
1146 name_to_check = detail::remove_underscore(name_to_check);
1149 local_name = detail::to_lower(local_name);
1150 name_to_check = detail::to_lower(name_to_check);
1153 if(local_name == name_to_check) {
1154 return App::NameMatch::exact;
1157 if(local_name.compare(0, name_to_check.size(), name_to_check) == 0) {
1158 return App::NameMatch::prefix;
1163 les = detail::remove_underscore(les);
1166 les = detail::to_lower(les);
1168 if(les == name_to_check) {
1169 return App::NameMatch::exact;
1172 if(les.compare(0, name_to_check.size(), name_to_check) == 0) {
1173 return App::NameMatch::prefix;
1177 return App::NameMatch::none;
1181 std::vector<std::string> groups;
1183 for(
const Option_p &opt :
options_) {
1185 if(std::find(groups.begin(), groups.end(), opt->
get_group()) == groups.end()) {
1193CLI11_NODISCARD CLI11_INLINE std::vector<std::string>
App::remaining(
bool recurse)
const {
1194 std::vector<std::string> miss_list;
1195 for(
const std::pair<detail::Classifier, std::string> &miss :
missing_) {
1196 miss_list.push_back(std::get<1>(miss));
1202 if(sub->name_.empty() && !sub->missing_.empty()) {
1203 for(
const std::pair<detail::Classifier, std::string> &miss : sub->missing_) {
1204 miss_list.push_back(std::get<1>(miss));
1212 std::vector<std::string> output = sub->remaining(recurse);
1213 std::copy(std::begin(output), std::end(output), std::back_inserter(miss_list));
1220 std::vector<std::string> miss_list =
remaining(recurse);
1221 std::reverse(std::begin(miss_list), std::end(miss_list));
1226 auto remaining_options =
static_cast<std::size_t
>(std::count_if(
1227 std::begin(
missing_), std::end(
missing_), [](
const std::pair<detail::Classifier, std::string> &val) {
1228 return val.first != detail::Classifier::POSITIONAL_MARK;
1233 remaining_options += sub->remaining_size(recurse);
1236 return remaining_options;
1241 auto pcount = std::count_if(std::begin(
options_), std::end(
options_), [](
const Option_p &opt) {
1242 return opt->get_items_expected_max() >= detail::expected_max_vector_size && !opt->nonpositional();
1245 auto pcount_req = std::count_if(std::begin(
options_), std::end(
options_), [](
const Option_p &opt) {
1246 return opt->get_items_expected_max() >= detail::expected_max_vector_size && !opt->nonpositional() &&
1247 opt->get_required();
1249 if(pcount - pcount_req > 1) {
1254 std::size_t nameless_subs{0};
1257 if(app->get_name().empty())
1264 throw(
InvalidError(
"Required min options greater than required max options", ExitCodes::InvalidError));
1269 InvalidError(
"Required min options greater than number of available options", ExitCodes::InvalidError));
1281 if(app->has_automatic_name_) {
1284 if(app->name_.empty()) {
1285 app->fallthrough_ =
false;
1286 app->prefix_command_ = PrefixCommandMode::Off;
1289 app->parent_ =
this;
1302 if(subc->parent_ ==
this) {
1303 subc->run_callback(
true, suppress_final_callback);
1308 if(subc->name_.empty() && subc->count_all() > 0) {
1309 subc->run_callback(
true, suppress_final_callback);
1327 if(com !=
nullptr) {
1332 return parent_ !=
nullptr &&
parent_->_valid_subcommand(current, ignore_used);
1337CLI11_NODISCARD CLI11_INLINE detail::Classifier
App::_recognize(
const std::string ¤t,
1338 bool ignore_used_subcommands)
const {
1339 std::string dummy1, dummy2;
1342 return detail::Classifier::POSITIONAL_MARK;
1344 return detail::Classifier::SUBCOMMAND;
1345 if(detail::split_long(current, dummy1, dummy2))
1346 return detail::Classifier::LONG;
1347 if(detail::split_short(current, dummy1, dummy2)) {
1348 if((dummy1[0] >=
'0' && dummy1[0] <=
'9') ||
1349 (dummy1[0] ==
'.' && !dummy2.empty() && (dummy2[0] >=
'0' && dummy2[0] <=
'9'))) {
1352 return detail::Classifier::NONE;
1355 return detail::Classifier::SHORT;
1358 return detail::Classifier::WINDOWS_STYLE;
1359 if((current ==
"++") && !
name_.empty() &&
parent_ !=
nullptr)
1360 return detail::Classifier::SUBCOMMAND_TERMINATOR;
1361 auto dotloc = current.find_first_of(
'.');
1362 if(dotloc != std::string::npos) {
1363 auto *cm =
_find_subcommand(current.substr(0, dotloc),
true, ignore_used_subcommands);
1365 auto res = cm->_recognize(current.substr(dotloc + 1), ignore_used_subcommands);
1366 if(res == detail::Classifier::SUBCOMMAND) {
1371 return detail::Classifier::NONE;
1375 auto path_result = detail::check_path(config_file.c_str());
1376 if(path_result == detail::path_type::file) {
1387 }
else if(throw_error) {
1388 throw FileError::Missing(config_file);
1396 bool config_required =
config_ptr_->get_required();
1398 if(!(file_given ||
config_ptr_->envname_.empty())) {
1399 std::string ename_string = detail::get_environment_value(
config_ptr_->envname_);
1400 if(!ename_string.empty()) {
1406 auto config_files =
config_ptr_->as<std::vector<std::string>>();
1407 bool files_used{file_given};
1408 if(config_files.empty() || config_files.front().empty()) {
1409 if(config_required) {
1410 throw FileError(
"config file is required but none was given");
1414 for(
const auto &config_file : config_files) {
1431 for(
const Option_p &opt :
options_) {
1433 std::string ename_string = detail::get_environment_value(opt->
envname_);
1434 if(!ename_string.empty()) {
1435 std::string result = ename_string;
1436 result = opt->_validate(result, 0);
1437 if(result.empty()) {
1445 if(sub->get_name().empty() || (sub->count_all() > 0 && !sub->parse_complete_callback_)) {
1447 sub->_process_env();
1456 if(sub->get_name().empty() && sub->parse_complete_callback_) {
1457 if(sub->count_all() > 0) {
1458 sub->_process_callbacks(priority);
1459 if(priority == CallbackPriority::Normal) {
1461 sub->run_callback();
1467 for(
const Option_p &opt :
options_) {
1475 if(!sub->parse_complete_callback_) {
1476 sub->_process_callbacks(priority);
1486 trigger_help =
true;
1489 trigger_all_help =
true;
1495 sub->_process_help_flags(priority, trigger_help, trigger_all_help);
1499 }
else if(trigger_all_help) {
1501 }
else if(trigger_help) {
1508 bool excluded{
false};
1509 std::string excluder;
1511 if(opt->
count() > 0) {
1517 if(subc->count_all() > 0) {
1519 excluder = subc->get_display_name();
1531 bool missing_needed{
false};
1532 std::string missing_need;
1534 if(opt->
count() == 0) {
1535 missing_needed =
true;
1540 if(subc->count_all() == 0) {
1541 missing_needed =
true;
1542 missing_need = subc->get_display_name();
1545 if(missing_needed) {
1553 std::size_t used_options = 0;
1554 for(
const Option_p &opt :
options_) {
1556 if(opt->
count() != 0) {
1564 for(
const Option *opt_req : opt->
needs_)
1565 if(opt->
count() > 0 && opt_req->
count() == 0)
1568 for(
const Option *opt_ex : opt->
excludes_)
1586 if(sub->name_.empty() && sub->count_all() > 0) {
1592 auto option_list = detail::join(
options_, [
this](
const Option_p &ptr) {
1594 return std::string{};
1596 return ptr->get_name(
false,
true);
1600 if(!subc_list.empty()) {
1601 option_list +=
"," + detail::join(subc_list, [](
const App *app) {
return app->
get_display_name(); });
1610 if(sub->name_.empty() && sub->required_ ==
false) {
1611 if(sub->count_all() == 0) {
1624 if(sub->count() > 0 || sub->name_.empty()) {
1625 sub->_process_requirements();
1628 if(sub->required_ && sub->count_all() == 0) {
1641 std::exception_ptr config_exception;
1650 config_exception = std::current_exception();
1664 if(config_exception) {
1665 std::rethrow_exception(config_exception);
1682 if(rem.front() !=
"--") {
1688 if(sub->count() > 0)
1689 sub->_process_extras();
1696 if(sub->get_name().empty())
1697 sub->increment_parsed();
1703 if(with_help_flags) {
1707 if(with_help_flags) {
1711 if(with_help_flags) {
1717 if(with_help_flags) {
1722 if(with_help_flags) {
1732 bool positional_only =
false;
1734 while(!args.empty()) {
1757 bool positional_only =
false;
1759 while(!args.empty()) {
1784 throw ConfigError::Extras(item.fullname());
1790 if(item.
inputs.size() <= 1) {
1793 bool converted{
false};
1795 auto val = detail::to_flag_value(res);
1820 throw ConversionError::TooManyInputsFlag(item.
fullname());
1824 for(
const auto &res : inputs) {
1825 bool valid_value{
false};
1827 if(res ==
"true" || res ==
"false" || res ==
"1" || res ==
"0") {
1832 if(valid_res.second == res) {
1852 if(level < item.
parents.size()) {
1854 return (subcom !=
nullptr) ? subcom->_parse_single_config(item, level + 1) :
false;
1857 if(item.
name ==
"++") {
1862 parent_->parsed_subcommands_.push_back(
this);
1868 if(item.
name ==
"--") {
1876 if(item.
name.size() == 1) {
1883 if(item.
name.size() == 1) {
1885 if(testop !=
nullptr && testop->get_configurable()) {
1891 const std::string &iname = item.
name;
1896 if(!options.empty()) {
1905 for(
const auto &input : item.
inputs) {
1906 missing_.emplace_back(detail::Classifier::NONE, input);
1916 throw ConfigError::NotConfigurable(item.
fullname());
1919 std::vector<std::string> buffer;
1920 bool useBuffer{
false};
1924 buffer.erase(std::remove(buffer.begin(), buffer.end(),
"%%"), buffer.end());
1928 const std::vector<std::string> &inputs = (useBuffer) ? buffer : item.
inputs;
1943 detail::Classifier classifier = positional_only ? detail::Classifier::NONE :
_recognize(args.back());
1944 switch(classifier) {
1945 case detail::Classifier::POSITIONAL_MARK:
1947 positional_only =
true;
1950 missing_.emplace_back(classifier,
"--");
1951 while(!args.empty()) {
1952 missing_.emplace_back(detail::Classifier::NONE, args.back());
1961 case detail::Classifier::SUBCOMMAND_TERMINATOR:
1966 case detail::Classifier::SUBCOMMAND:
1969 case detail::Classifier::LONG:
1970 case detail::Classifier::SHORT:
1971 case detail::Classifier::WINDOWS_STYLE:
1973 retval =
_parse_arg(args, classifier,
false);
1975 case detail::Classifier::NONE:
1979 positional_only =
true;
1984 throw HorribleError(
"unrecognized classifier (you should not see this!)");
1991 std::size_t retval = 0;
1992 for(
const Option_p &opt :
options_) {
2003 for(
const Option_p &opt :
options_) {
2014 const std::string &positional = args.back();
2015 Option *posOpt{
nullptr};
2019 auto arg_rem = args.size();
2021 if(arg_rem <= remreq) {
2022 for(
const Option_p &opt :
options_) {
2026 std::string pos = positional;
2027 pos = opt->_validate(pos, 0);
2039 if(posOpt ==
nullptr) {
2040 for(
const Option_p &opt :
options_) {
2045 std::string pos = positional;
2046 pos = opt->_validate(pos, 0);
2056 if(posOpt !=
nullptr) {
2059 if(!posOpt->
results().empty() && !posOpt->
results().back().empty()) {
2071 item.
inputs.push_back(positional);
2079 if(!posOpt->
empty()) {
2093 if((subc->name_.empty()) && (!subc->disabled_)) {
2094 if(subc->_parse_positional(args,
false)) {
2095 if(!subc->pre_parse_called_) {
2096 subc->_trigger_pre_parse(args.size());
2109 if(haltOnSubcommand) {
2121 if(com !=
nullptr && (com->parent_->require_subcommand_max_ == 0 ||
2122 com->parent_->require_subcommand_max_ > com->parent_->parsed_subcommands_.size())) {
2127 std::vector<std::string> rargs(args.rbegin(), args.rend());
2138 while(!args.empty()) {
2139 missing_.emplace_back(detail::Classifier::NONE, args.back());
2147CLI11_NODISCARD CLI11_INLINE
App *
2151 if(com->disabled_ && ignore_disabled)
2153 if(com->get_name().empty()) {
2154 auto *subc = com->_find_subcommand(subc_name, ignore_disabled, ignore_used);
2155 if(subc !=
nullptr) {
2156 if(bcom !=
nullptr) {
2165 auto res = com->check_name_detail(subc_name);
2166 if(res != NameMatch::none) {
2167 if((!*com) || !ignore_used) {
2168 if(res == NameMatch::exact) {
2171 if(bcom !=
nullptr) {
2190 if(com ==
nullptr) {
2192 auto dotloc = args.back().find_first_of(
'.');
2193 if(dotloc != std::string::npos) {
2195 if(com !=
nullptr) {
2196 args.back() = args.back().substr(dotloc + 1);
2197 args.push_back(com->get_display_name());
2201 if(com !=
nullptr) {
2207 auto *parent_app = com->parent_;
2208 while(parent_app !=
this) {
2209 parent_app->_trigger_pre_parse(args.size());
2211 parent_app->parsed_subcommands_.push_back(com);
2213 parent_app = parent_app->parent_;
2219 throw HorribleError(
"Subcommand " + args.back() +
" missing");
2224App::_parse_arg(std::vector<std::string> &args, detail::Classifier current_type,
bool local_processing_only) {
2226 std::string current = args.back();
2228 std::string arg_name;
2232 switch(current_type) {
2233 case detail::Classifier::LONG:
2234 if(!detail::split_long(current, arg_name, value))
2235 throw HorribleError(
"Long parsed but missing (you should not see this):" + args.back());
2237 case detail::Classifier::SHORT:
2238 if(!detail::split_short(current, arg_name, rest))
2239 throw HorribleError(
"Short parsed but missing! You should not see this");
2241 case detail::Classifier::WINDOWS_STYLE:
2242 if(!detail::split_windows_style(current, arg_name, value))
2243 throw HorribleError(
"windows option parsed but missing! You should not see this");
2245 case detail::Classifier::SUBCOMMAND:
2246 case detail::Classifier::SUBCOMMAND_TERMINATOR:
2247 case detail::Classifier::POSITIONAL_MARK:
2248 case detail::Classifier::NONE:
2250 throw HorribleError(
"parsing got called with invalid option! You should not see this");
2254 std::find_if(std::begin(
options_), std::end(
options_), [&arg_name, current_type](
const Option_p &opt) {
2255 if(current_type == detail::Classifier::LONG)
2256 return opt->check_lname(arg_name);
2257 if(current_type == detail::Classifier::SHORT)
2258 return opt->check_sname(arg_name);
2260 return opt->check_lname(arg_name) || opt->check_sname(arg_name);
2264 while(op_ptr == std::end(
options_)) {
2267 if(subc->name_.empty() && !subc->disabled_) {
2268 if(subc->_parse_arg(args, current_type, local_processing_only)) {
2269 if(!subc->pre_parse_called_) {
2270 subc->_trigger_pre_parse(args.size());
2277 std::string narg_name;
2279 detail::split_long(std::string{
'-'} + current, narg_name, nvalue);
2280 op_ptr = std::find_if(std::begin(
options_), std::end(
options_), [narg_name](
const Option_p &opt) {
2281 return opt->check_sname(narg_name);
2284 arg_name = narg_name;
2297 auto dotloc = arg_name.find_first_of(
'.', 1);
2298 if(dotloc != std::string::npos && dotloc < arg_name.size() - 1) {
2307 if(sub !=
nullptr) {
2308 std::string v = args.back();
2309 auto saved_type = current_type;
2311 arg_name = arg_name.substr(dotloc + 1);
2314 std::size_t pushed = 1;
2315 if(arg_name.size() > 1) {
2316 args.push_back(
"--" + arg_name + (value.empty() ? std::string{} :
"=" + value));
2317 current_type = detail::Classifier::LONG;
2319 if(!value.empty()) {
2321 args.push_back(value);
2324 args.push_back(std::string{
'-'} + arg_name);
2325 current_type = detail::Classifier::SHORT;
2327 std::string dummy1, dummy2;
2329 if((current_type == detail::Classifier::SHORT && detail::valid_first_char(args.back()[1])) ||
2330 detail::split_long(args.back(), dummy1, dummy2)) {
2331 val = sub->_parse_arg(args, current_type,
true);
2342 if(sub->parse_complete_callback_) {
2343 sub->_process_completion_callbacks(
true);
2349 for(std::size_t i = 0; i < pushed; ++i) {
2353 current_type = saved_type;
2356 if(local_processing_only) {
2368 while(!args.empty()) {
2369 missing_.emplace_back(detail::Classifier::NONE, args.back());
2372 }
else if(
allow_extras_ == ExtrasMode::AssumeSingleArgument) {
2373 if(!args.empty() &&
_recognize(args.back(),
false) == detail::Classifier::NONE) {
2377 }
else if(
allow_extras_ == ExtrasMode::AssumeMultipleArguments) {
2378 while(!args.empty() &&
_recognize(args.back(),
false) == detail::Classifier::NONE) {
2389 Option_p &op = *op_ptr;
2391 if(op->get_inject_separator()) {
2392 if(!op->results().empty() && !op->results().back().empty()) {
2393 op->add_result(std::string{});
2399 int min_num = (std::min)(op->get_type_size_min(), op->get_items_expected_min());
2400 int max_num = op->get_items_expected_max();
2403 if(max_num >= detail::expected_max_vector_size / 16 && !op->get_allow_extra_args()) {
2404 auto tmax = op->get_type_size_max();
2405 max_num = detail::checked_multiply(tmax, op->get_expected_min()) ? tmax : detail::expected_max_vector_size;
2409 int result_count = 0;
2412 auto res = op->get_flag_value(arg_name, value);
2413 op->add_result(res);
2415 }
else if(!value.empty()) {
2416 op->add_result(value, result_count);
2418 collected += result_count;
2420 }
else if(!rest.empty()) {
2421 op->add_result(rest, result_count);
2424 collected += result_count;
2428 while(min_num > collected && !args.empty()) {
2429 std::string current_ = args.back();
2431 op->add_result(current_, result_count);
2433 collected += result_count;
2436 if(min_num > collected) {
2437 throw ArgumentMismatch::TypedAtLeast(op->get_name(), min_num, op->get_type_name());
2441 if(max_num > collected || op->get_allow_extra_args()) {
2444 while((collected < max_num || op->get_allow_extra_args()) && !args.empty() &&
2445 _recognize(args.back(),
false) == detail::Classifier::NONE) {
2447 if(remreqpos >= args.size()) {
2451 std::string arg = args.back();
2452 arg = op->_validate(arg, 0);
2457 op->add_result(args.back(), result_count);
2460 collected += result_count;
2464 if(!args.empty() &&
_recognize(args.back()) == detail::Classifier::POSITIONAL_MARK)
2467 if(min_num == 0 && max_num > 0 && collected == 0) {
2468 auto res = op->get_flag_value(arg_name, std::string{});
2469 op->add_result(res);
2474 if(min_num > 0 && (collected % op->get_type_size_max()) != 0) {
2475 if(op->get_type_size_max() != op->get_type_size_min()) {
2476 op->add_result(std::string{});
2478 throw ArgumentMismatch::PartialType(op->get_name(), op->get_type_size_min(), op->get_type_name());
2481 if(op->get_trigger_on_parse()) {
2486 args.push_back(rest);
2498 if(!
name_.empty()) {
2500 missing_t extras = std::move(
missing_);
2513 auto *fallthrough_parent =
parent_;
2514 while((fallthrough_parent->parent_ !=
nullptr) && (fallthrough_parent->get_name().empty())) {
2515 fallthrough_parent = fallthrough_parent->parent_;
2517 return fallthrough_parent;
2524 const auto *fallthrough_parent =
parent_;
2525 while((fallthrough_parent->parent_ !=
nullptr) && (fallthrough_parent->get_name().empty())) {
2526 fallthrough_parent = fallthrough_parent->parent_;
2528 return fallthrough_parent;
2532 const App &base)
const {
2533 static const std::string estring;
2538 if(subc.get() != &subcom) {
2539 if(subc->disabled_) {
2543 if(subc->check_name(subcom.
get_name())) {
2547 if(!subc->get_name().empty()) {
2549 return subc->get_name();
2552 for(
const auto &les : subcom.
aliases_) {
2553 if(subc->check_name(les)) {
2558 for(
const auto &les : subc->aliases_) {
2564 if(subc->get_name().empty()) {
2566 if(!cmpres.empty()) {
2573 if(!cmpres.empty()) {
2582CLI11_INLINE
bool capture_extras(ExtrasMode mode) {
2583 return mode == ExtrasMode::Capture || mode == ExtrasMode::AssumeSingleArgument ||
2584 mode == ExtrasMode::AssumeMultipleArguments;
2592 missing_.emplace_back(val_type, val);
2598 if(subc->name_.empty() && capture_extras(subc->allow_extras_)) {
2599 subc->missing_.emplace_back(val_type, val);
2605 missing_.emplace_back(val_type, val);
2610 if(opt ==
nullptr) {
2616 if(app == subc.get()) {
2631 std::find_if(std::begin(
options_), std::end(
options_), [opt](
const Option_p &v) {
return v.get() == opt; });
2632 if(iterator != std::end(
options_)) {
2633 const auto &opt_p = *iterator;
2634 if(std::find_if(std::begin(app->
options_), std::end(app->
options_), [&opt_p](
const Option_p &v) {
2635 return (*v == *opt_p);
2638 app->
options_.push_back(std::move(*iterator));
2648CLI11_INLINE Option_group::Option_group(std::string group_description, std::string group_name,
App *parent)
2649 :
App(std::move(group_description),
"", parent) {
2652 if(group_name.empty() || group_name.front() ==
'+') {
2671 subc->get_parent()->remove_subcommand(subcom);
2676CLI11_INLINE
void TriggerOn(
App *trigger_app,
App *app_to_enable) {
2682CLI11_INLINE
void TriggerOn(
App *trigger_app, std::vector<App *> apps_to_enable) {
2683 for(
auto &app : apps_to_enable) {
2684 app->enabled_by_default(
false);
2685 app->disabled_by_default();
2688 trigger_app->preparse_callback([apps_to_enable](std::size_t) {
2689 for(
const auto &app : apps_to_enable) {
2690 app->disabled(
false);
2695CLI11_INLINE
void TriggerOff(
App *trigger_app,
App *app_to_enable) {
2696 app_to_enable->disabled_by_default(
false);
2697 app_to_enable->enabled_by_default();
2698 trigger_app->preparse_callback([app_to_enable](std::size_t) { app_to_enable->disabled(); });
2701CLI11_INLINE
void TriggerOff(
App *trigger_app, std::vector<App *> apps_to_enable) {
2702 for(
auto &app : apps_to_enable) {
2703 app->disabled_by_default(
false);
2704 app->enabled_by_default();
2707 trigger_app->preparse_callback([apps_to_enable](std::size_t) {
2708 for(
const auto &app : apps_to_enable) {
2714CLI11_INLINE
void deprecate_option(
Option *opt,
const std::string &replacement) {
2715 Validator deprecate_warning{[opt, replacement](std::string &) {
2716 std::cout << opt->get_name() <<
" is deprecated please use '" << replacement
2718 return std::string();
2722 opt->check(deprecate_warning);
2723 if(!replacement.empty()) {
2724 opt->description(opt->get_description() +
" DEPRECATED: please use '" + replacement +
"' instead");
2728CLI11_INLINE
void deprecate_option(
App *app,
const std::string &option_name,
const std::string &replacement) {
2729 auto *opt = app->get_option(option_name);
2730 deprecate_option(opt, replacement);
2733CLI11_INLINE
void deprecate_option(
App &app,
const std::string &option_name,
const std::string &replacement) {
2734 auto *opt = app.get_option(option_name);
2735 deprecate_option(opt, replacement);
2738CLI11_INLINE
void retire_option(
App *app,
Option *opt) {
2740 auto *option_copy = temp.
add_option(opt->get_name(
false,
true))
2741 ->
type_size(opt->get_type_size_min(), opt->get_type_size_max())
2742 ->
expected(opt->get_expected_min(), opt->get_expected_max())
2745 app->remove_option(opt);
2746 auto *opt2 = app->add_option(option_copy->get_name(
false,
true),
"option has been retired and has no effect");
2749 ->
type_size(option_copy->get_type_size_min(), option_copy->get_type_size_max())
2750 ->
expected(option_copy->get_expected_min(), option_copy->get_expected_max())
2755 Validator retired_warning{[opt2](std::string &) {
2756 std::cout <<
"WARNING " << opt2->get_name() <<
" is retired and has no effect\n";
2757 return std::string();
2762 opt2->check(retired_warning);
2765CLI11_INLINE
void retire_option(
App &app,
Option *opt) { retire_option(&app, opt); }
2767CLI11_INLINE
void retire_option(
App *app,
const std::string &option_name) {
2769 auto *opt = app->get_option_no_throw(option_name);
2770 if(opt !=
nullptr) {
2771 retire_option(app, opt);
2774 auto *opt2 = app->add_option(option_name,
"option has been retired and has no effect")
2775 ->type_name(
"RETIRED")
2777 ->default_str(
"RETIRED");
2780 Validator retired_warning{[opt2](std::string &) {
2781 std::cout <<
"WARNING " << opt2->get_name() <<
" is retired and has no effect\n";
2782 return std::string();
2787 opt2->check(retired_warning);
2790CLI11_INLINE
void retire_option(
App &app,
const std::string &option_name) { retire_option(&app, option_name); }
2792namespace FailureMessage {
2794CLI11_INLINE std::string simple(
const App *app,
const Error &e) {
2795 std::string header = std::string(e.what()) +
"\n";
2796 std::vector<std::string> names;
2799 if(app->get_help_ptr() !=
nullptr)
2800 names.push_back(app->get_help_ptr()->get_name());
2802 if(app->get_help_all_ptr() !=
nullptr)
2803 names.push_back(app->get_help_all_ptr()->get_name());
2807 header +=
"Run with " + detail::join(names,
" or ") +
" for more information.\n";
2812CLI11_INLINE std::string help(
const App *app,
const Error &e) {
2813 std::string header = std::string(
"ERROR: ") + e.get_name() +
": " + e.what() +
"\n";
2814 header += app->help();
Creates a command line program, with very few defaults.
Definition App.hpp:115
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:1077
bool subcommand_fallthrough_
Allow subcommands to fallthrough, so that parent commands can trigger other subcommands after subcomm...
Definition App.hpp:257
CLI11_NODISCARD std::string help(std::string prev="", AppFormatMode mode=AppFormatMode::Normal) const
Definition App_inl.hpp:950
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:1225
CLI11_NODISCARD bool _has_remaining_positionals() const
Count the required remaining positional arguments.
Definition App_inl.hpp:2002
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:1337
App * immediate_callback(bool immediate=true)
Set the subcommand callback to be executed immediately on subcommand completion.
Definition App_inl.hpp:170
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:330
bool allow_non_standard_options_
indicator that the subcommand should allow non-standard option arguments, such as -single_dash_flag
Definition App.hpp:289
CLI11_NODISCARD std::string get_footer() const
Generate and return the footer.
Definition App_inl.hpp:946
Option * config_ptr_
Pointer to the config option.
Definition App.hpp:323
CLI11_NODISCARD bool get_allow_non_standard_option_names() const
Get the status of allowing non standard option names.
Definition App.hpp:1128
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_inl.hpp:2586
CLI11_NODISCARD App * _get_fallthrough_parent() noexcept
Get the appropriate parent to fallthrough to which is the first one that has a name or the main app.
Definition App_inl.hpp:2509
std::size_t require_option_min_
Minimum required options (not inheritable!).
Definition App.hpp:304
NameMatch
enumeration of matching possibilities
Definition App.hpp:1198
App * ignore_underscore(bool value=true)
Ignore underscore. Subcommands inherit value.
Definition App_inl.hpp:196
std::size_t require_subcommand_max_
Max number of subcommands allowed (parsing stops after this number). 0 is unlimited INHERITABLE.
Definition App.hpp:301
std::vector< App_p > subcommands_
Storage for subcommand list.
Definition App.hpp:244
CLI11_NODISCARD std::vector< std::string > remaining(bool recurse=false) const
This returns the missing options from the current subcommand.
Definition App_inl.hpp:1193
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:1219
std::uint32_t parsed_
Counts the number of times this command/subcommand was parsed.
Definition App.hpp:295
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:611
App * require_subcommand()
The argumentless form of require subcommand requires 1 or more subcommands.
Definition App.hpp:811
std::string usage_
Usage to put after program/subcommand description in the help output INHERITABLE.
Definition App.hpp:181
OptionDefaults option_defaults_
The default values for options, customizable and changeable INHERITABLE.
Definition App.hpp:171
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_inl.hpp:142
void _process_requirements()
Verify required options and cross requirements. Subcommands too (only if selected).
Definition App_inl.hpp:1506
CLI11_NODISCARD std::size_t count_all() const
Definition App_inl.hpp:620
void _parse_setup()
Definition App_inl.hpp:717
bool disabled_
If set to true the subcommand is disabled and cannot be used, ignored for main app.
Definition App.hpp:148
CLI11_NODISCARD bool get_prefix_command() const
Get the prefix command status.
Definition App.hpp:1107
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:363
bool remove_needs(Option *opt)
Removes an option from the needs list of this subcommand.
Definition App_inl.hpp:912
CLI11_NODISCARD std::string get_usage() const
Generate and return the usage.
Definition App_inl.hpp:942
Option * get_help_ptr()
Get a pointer to the help flag.
Definition App.hpp:1152
void _configure()
Definition App_inl.hpp:1274
CLI11_NODISCARD std::size_t _count_remaining_positionals(bool required_only=false) const
Count the required remaining positional arguments.
Definition App_inl.hpp:1990
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:443
void parse(int argc, const char *const *argv)
Definition App_inl.hpp:650
void _process_config_file()
Read and process a configuration file (main app only).
Definition App_inl.hpp:1394
std::string footer_
Footer to put after all options in the help output INHERITABLE.
Definition App.hpp:187
void increment_parsed()
Internal function to recursively increment the parsed counter on the current app as well unnamed subc...
Definition App_inl.hpp:1693
CLI11_NODISCARD bool check_name(std::string name_to_check) const
Definition App_inl.hpp:1137
CLI11_NODISCARD const Option * get_option(std::string option_name) const
Get an option by name.
Definition App_inl.hpp:1048
Option * version_ptr_
A pointer to a version flag if there is one.
Definition App.hpp:199
CLI11_NODISCARD const Option * get_help_all_ptr() const
Get a pointer to the help all flag. (const).
Definition App.hpp:1158
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:541
App * parent_
A pointer to the parent if this is a subcommand.
Definition App.hpp:310
std::set< Option * > exclude_options_
Definition App.hpp:229
void _trigger_pre_parse(std::size_t remaining_args)
Trigger the pre_parse callback if needed.
Definition App_inl.hpp:2491
App * group(std::string group_name)
Changes the group membership.
Definition App.hpp:805
App * enabled_by_default(bool enable=true)
Definition App_inl.hpp:151
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:586
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:190
ExtrasMode allow_extras_
If true, allow extra arguments (ie, don't throw an error). INHERITABLE.
Definition App.hpp:132
PrefixCommandMode prefix_command_
If true, cease processing on an unrecognized option (implies allow_extras) INHERITABLE.
Definition App.hpp:139
int exit(const Error &e, std::ostream &out, std::ostream &err) const
Print a nice error message and return the exit code.
Definition App_inl.hpp:756
std::function< void()> parse_complete_callback_
This is a function that runs when parsing has finished.
Definition App.hpp:161
virtual void pre_callback()
Definition App.hpp:874
App * get_parent()
Get the parent of this subcommand (or nullptr if main app).
Definition App.hpp:1173
void _validate() const
Definition App_inl.hpp:1239
std::string name_
Subcommand name or program name (from parser if name is empty).
Definition App.hpp:126
std::vector< App * > parsed_subcommands_
This is a list of the subcommands collected, in order.
Definition App.hpp:222
bool ignore_underscore_
If true, the program should ignore underscores INHERITABLE.
Definition App.hpp:250
missing_t missing_
Definition App.hpp:216
void run_callback(bool final_mode=false, bool suppress_final_callback=false)
Internal function to run (App) callback, bottom up.
Definition App_inl.hpp:1294
bool allow_prefix_matching_
indicator to allow subcommands to match with prefix matching
Definition App.hpp:292
std::size_t require_subcommand_min_
Minimum required subcommands (not inheritable!).
Definition App.hpp:298
CLI11_NODISCARD NameMatch check_name_detail(std::string name_to_check) const
Definition App_inl.hpp:1142
void _process_env()
Get envname options if not yet passed. Runs on all subcommands.
Definition App_inl.hpp:1430
std::function< std::string(const App *, const Error &e)> failure_message_
The error message printing function INHERITABLE.
Definition App.hpp:205
void _parse_stream(std::istream &input)
Internal function to parse a stream.
Definition App_inl.hpp:1770
CLI11_NODISCARD std::string get_display_name(bool with_aliases=false) const
Get a display name for an app.
Definition App_inl.hpp:1121
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:142
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:2531
void clear()
Reset the parsed data.
Definition App_inl.hpp:634
App * get_subcommand(const App *subcom) const
Definition App_inl.hpp:557
CLI11_NODISCARD std::string version() const
Displays a version string.
Definition App_inl.hpp:964
CLI11_NODISCARD App * get_subcommand_no_throw(std::string subcom) const noexcept
Definition App_inl.hpp:573
bool _add_flag_like_result(Option *op, const ConfigItem &item, const std::vector< std::string > &inputs)
store the results for a flag like option
Definition App_inl.hpp:1789
std::vector< Option_p > options_
The list of options, stored locally.
Definition App.hpp:174
Option * help_all_ptr_
A pointer to the help all flag if there is one INHERITABLE.
Definition App.hpp:196
bool validate_optional_arguments_
If set to true optional vector arguments are validated before assigning INHERITABLE.
Definition App.hpp:282
App * allow_config_extras(bool allow=true)
ignore extras in config files
Definition App_inl.hpp:160
std::function< void()> final_callback_
This is a function that runs when all processing has completed.
Definition App.hpp:164
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:487
App * require_option()
The argumentless form of require option requires 1 or more options be used.
Definition App.hpp:831
App(std::string app_description, std::string app_name, App *parent)
Special private constructor for subcommand.
Definition App_inl.hpp:37
std::function< std::string()> usage_callback_
This is a function that generates a usage to put after program/subcommand description in help output.
Definition App.hpp:184
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:510
App * preparse_callback(std::function< void(std::size_t)> pp_callback)
Definition App.hpp:381
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:426
bool positionals_at_end_
specify that positional arguments come at the end of the argument sequence not inheritable
Definition App.hpp:268
void _process()
Process callbacks and such.
Definition App_inl.hpp:1634
bool immediate_callback_
Definition App.hpp:155
bool _parse_single(std::vector< std::string > &args, bool &positional_only)
Definition App_inl.hpp:1941
App * name(std::string app_name="")
Set a name for the app (empty will use parser to set the name).
Definition App_inl.hpp:107
CLI11_NODISCARD std::string config_to_str() const
Definition App_inl.hpp:930
void _move_option(Option *opt, App *app)
function that could be used by subclasses of App to shift options around into subcommands
Definition App_inl.hpp:2609
void _process_extras()
Throw an error if anything is left over and should not be.
Definition App_inl.hpp:1673
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:1321
CLI11_NODISCARD PrefixCommandMode get_prefix_command_mode() const
Get the prefix command status.
Definition App.hpp:1110
bool configurable_
if set to true the subcommand can be triggered via configuration files INHERITABLE
Definition App.hpp:276
CLI11_NODISCARD std::vector< std::string > get_groups() const
Get the groups available directly from this option (in order).
Definition App_inl.hpp:1180
void _parse_config(const std::vector< ConfigItem > &args)
Definition App_inl.hpp:1781
std::string description_
Description of the current program/subcommand.
Definition App.hpp:129
bool got_subcommand(const App *subcom) const
Check to see if given subcommand was selected.
Definition App_inl.hpp:840
std::size_t require_option_max_
Max number of options allowed. 0 is unlimited (not inheritable).
Definition App.hpp:307
std::vector< std::string > aliases_
Alias names for the subcommand.
Definition App.hpp:316
std::set< App * > exclude_subcommands_
this is a list of subcommands that are exclusionary to this one
Definition App.hpp:225
void _process_completion_callbacks(bool with_help_flags)
Definition App_inl.hpp:1701
ConfigExtrasMode allow_config_extras_
Definition App.hpp:136
bool _parse_positional(std::vector< std::string > &args, bool haltOnSubcommand)
Definition App_inl.hpp:2012
bool ignore_case_
If true, the program name is not case-sensitive INHERITABLE.
Definition App.hpp:247
CLI11_NODISCARD const std::string & get_group() const
Get the group of this subcommand.
Definition App.hpp:1086
bool _parse_arg(std::vector< std::string > &args, detail::Classifier current_type, bool local_processing_only)
Definition App_inl.hpp:2224
std::function< void(std::size_t)> pre_parse_callback_
This is a function that runs prior to the start of parsing.
Definition App.hpp:158
App * callback(std::function< void()> app_callback)
Definition App_inl.hpp:98
std::string group_
The group membership INHERITABLE.
Definition App.hpp:313
App * alias(std::string app_name)
Set an alias for the app.
Definition App_inl.hpp:124
bool pre_parse_called_
Flag indicating that the pre_parse_callback has been triggered.
Definition App.hpp:151
Option * help_ptr_
A pointer to the help flag if there is one INHERITABLE.
Definition App.hpp:193
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:458
App * ignore_case(bool value=true)
Ignore case. Subcommands inherit value.
Definition App_inl.hpp:182
bool remove_excludes(Option *opt)
Removes an option from the excludes list of this subcommand.
Definition App_inl.hpp:892
CLI11_NODISCARD std::vector< App * > get_subcommands() const
Definition App.hpp:932
CLI11_NODISCARD config_extras_mode get_allow_config_extras() const
Get the status of allow extras.
Definition App.hpp:1147
bool _parse_subcommand(std::vector< std::string > &args)
Definition App_inl.hpp:2184
bool fallthrough_
Definition App.hpp:254
std::set< Option * > need_options_
Definition App.hpp:237
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:982
std::set< App * > need_subcommands_
Definition App.hpp:233
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:210
std::vector< Option * > parse_order_
This is a list of pointers to options with the original parse order.
Definition App.hpp:219
void _parse(std::vector< std::string > &args)
Internal parse function.
Definition App_inl.hpp:1729
bool validate_positionals_
If set to true positional options are validated before assigning INHERITABLE.
Definition App.hpp:279
bool _parse_single_config(const ConfigItem &item, std::size_t level=0)
Fill in a single config option.
Definition App_inl.hpp:1850
void _process_help_flags(CallbackPriority priority, bool trigger_help=false, bool trigger_all_help=false) const
Definition App_inl.hpp:1481
startup_mode default_startup
Definition App.hpp:273
void _process_callbacks(CallbackPriority priority)
Process callbacks. Runs on all subcommands.
Definition App_inl.hpp:1452
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:76
CLI11_NODISCARD App * _find_subcommand(const std::string &subc_name, bool ignore_disabled, bool ignore_used) const noexcept
Definition App_inl.hpp:2148
Option * add_flag(std::string flag_name)
Add a flag with no description or variable assignment.
Definition App_inl.hpp:422
CLI11_NODISCARD const std::string & get_name() const
Get the name of the current app.
Definition App.hpp:1179
App * disabled(bool disable=true)
Disable the subcommand or option group.
Definition App.hpp:411
std::shared_ptr< FormatterBase > formatter_
This is the formatter for help printing. Default provided. INHERITABLE (same pointer).
Definition App.hpp:202
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:346
bool allow_windows_style_options_
Allow '/' for options for Windows like options. Defaults to true on Windows, false otherwise....
Definition App.hpp:260
std::shared_ptr< Config > config_formatter_
This is the formatter for help printing. Default provided. INHERITABLE (same pointer).
Definition App.hpp:326
App * excludes(Option *opt)
Sets excluded options for the subcommand.
Definition App_inl.hpp:850
Usually something like –help-all on command line.
Definition Error.hpp:179
-h or –help on command line
Definition Error.hpp:173
-v or –version on command line
Definition Error.hpp:186
All errors derive from this one.
Definition Error.hpp:73
Thrown when an excludes option is present.
Definition Error.hpp:302
Thrown when parsing an INI file and it is missing.
Definition Error.hpp:199
Thrown when an option is set to conflicting values (non-vector and multi args, for example).
Definition Error.hpp:97
Thrown when validation fails before parsing.
Definition Error.hpp:335
void add_options(Option *opt)
Add an existing option to the Option_group.
Definition App_inl.hpp:2667
Option * add_option(Option *opt)
Add an existing option to the Option_group.
Definition App_inl.hpp:2659
App * add_subcommand(App *subcom)
Add an existing subcommand to be a member of an option_group.
Definition App_inl.hpp:2669
Thrown when an option already exists.
Definition Error.hpp:145
CLI11_NODISCARD CallbackPriority get_callback_priority() const
The priority of callback.
Definition Option.hpp:163
CLI11_NODISCARD bool get_required() const
True if this is a required option.
Definition Option.hpp:139
CLI11_NODISCARD MultiOptionPolicy get_multi_option_policy() const
The status of the multi option policy.
Definition Option.hpp:160
CLI11_NODISCARD bool get_configurable() const
The status of configurable.
Definition Option.hpp:148
bool required_
True if this is a required option.
Definition Option.hpp:78
CLI11_NODISCARD bool get_disable_flag_override() const
The status of configurable.
Definition Option.hpp:151
CLI11_NODISCARD const std::string & get_group() const
Get the group of this option.
Definition Option.hpp:136
CRTP * required(bool value=true)
Set the option as required.
Definition Option.hpp:120
Definition Option.hpp:261
Option * type_size(int option_type_size)
Set a custom option size.
Definition Option_inl.hpp:531
Option * expected(int value)
Set the number of expected arguments.
Definition Option_inl.hpp:56
CLI11_NODISCARD bool get_positional() const
True if the argument can be given directly.
Definition Option.hpp:611
CLI11_NODISCARD bool check_name(const std::string &name) const
Check a name. Requires "-" or "--" for short / long, supports positional name.
Definition Option_inl.hpp:418
@ callback_run
the callback has been executed
Definition Option.hpp:356
option_state current_option_state_
Whether the callback has run (needed for INI parsing).
Definition Option.hpp:359
void clear()
Clear the parsed results (mostly for testing).
Definition Option_inl.hpp:50
std::string pname_
A positional name.
Definition Option.hpp:283
std::set< Option * > needs_
A list of options that are required with this option.
Definition Option.hpp:328
void run_callback()
Process the callback.
Definition Option_inl.hpp:347
CLI11_NODISCARD std::string get_name(bool positional=false, bool all_options=false, bool disable_default_flag_values=false) const
Gets a comma separated list of names. Will include / prefer the positional name if positional is true...
Definition Option_inl.hpp:294
CLI11_NODISCARD bool check_sname(std::string name) const
Requires "-" to be removed from string.
Definition Option.hpp:666
std::set< Option * > excludes_
A list of options that are excluded with this option.
Definition Option.hpp:331
CLI11_NODISCARD bool get_callback_run() const
See if the callback has been run already.
Definition Option.hpp:751
std::vector< std::string > fnames_
a list of flag names with specified default values;
Definition Option.hpp:280
CLI11_NODISCARD int get_items_expected_min() const
The total min number of expected string values to be used.
Definition Option.hpp:600
CLI11_NODISCARD bool check_lname(std::string name) const
Requires "--" to be removed from string.
Definition Option.hpp:671
CLI11_NODISCARD const results_t & results() const
Get the current complete results set.
Definition Option.hpp:697
CLI11_NODISCARD int get_items_expected_max() const
Get the maximum number of items expected to be returned and used for the callback.
Definition Option.hpp:603
std::vector< std::string > snames_
A list of the short names (-a) without the leading dashes.
Definition Option.hpp:270
CLI11_NODISCARD std::size_t count() const
Count the total number of times an option was passed.
Definition Option.hpp:388
Option * allow_extra_args(bool value=true)
Definition Option.hpp:411
Option * multi_option_policy(MultiOptionPolicy value=MultiOptionPolicy::Throw)
Take the last argument if given multiple times (or another policy).
Definition Option_inl.hpp:280
CLI11_NODISCARD bool get_inject_separator() const
Return the inject_separator flag.
Definition Option.hpp:564
CLI11_NODISCARD const std::string & get_single_name() const
Get a single name for the option, first of lname, sname, pname, envname.
Definition Option_inl.hpp:574
CLI11_NODISCARD bool get_trigger_on_parse() const
The status of trigger on parse.
Definition Option.hpp:423
CLI11_NODISCARD std::string get_flag_value(const std::string &name, std::string input_value) const
Definition Option_inl.hpp:447
CLI11_NODISCARD bool empty() const
True if the option was not passed.
Definition Option.hpp:391
CLI11_NODISCARD int get_expected_min() const
The number of times the option expects to be included.
Definition Option.hpp:595
CLI11_NODISCARD int get_expected_max() const
The max number of times the option expects to be included.
Definition Option.hpp:597
Option * default_str(std::string val)
Set the default value string representation (does not change the contained value).
Definition Option.hpp:785
std::string envname_
If given, check the environment for this option.
Definition Option.hpp:286
CLI11_NODISCARD bool get_allow_extra_args() const
Get the current value of allow extra args.
Definition Option.hpp:416
std::vector< std::pair< std::string, std::string > > default_flag_values_
Definition Option.hpp:277
std::vector< std::string > lnames_
A list of the long names (--long) without the leading dashes.
Definition Option.hpp:273
Option * type_name(std::string typeval)
Set a custom option typestring.
Definition Option_inl.hpp:587
Option * add_result(std::string s)
Puts a result at the end.
Definition Option_inl.hpp:493
Thrown when counting a nonexistent option.
Definition Error.hpp:352
Anything that can error in Parse.
Definition Error.hpp:160
Thrown when a required option is missing.
Definition Error.hpp:229
Thrown when a requires option is missing.
Definition Error.hpp:295
Some validators that are provided.
Definition Validators.hpp:55
Validator & application_index(int app_index)
Specify the application index of a validator.
Definition Validators.hpp:128
Holds values to load into Options.
Definition ConfigFwd.hpp:29
CLI11_NODISCARD std::string fullname() const
The list of parents and name joined by ".".
Definition Config_inl.hpp:33
std::vector< std::string > inputs
Listing of inputs.
Definition ConfigFwd.hpp:36
std::string name
This is the name.
Definition ConfigFwd.hpp:34
bool multiline
indicator if a multiline vector separator was inserted
Definition ConfigFwd.hpp:38
std::vector< std::string > parents
This is the list of parents.
Definition ConfigFwd.hpp:31