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) {
68 normalized_argv_ = detail::compute_win32_argv();
70 if(!normalized_argv_view_.empty()) {
71 normalized_argv_view_.clear();
74 normalized_argv_view_.reserve(normalized_argv_.size());
75 for(
auto &arg : normalized_argv_) {
77 normalized_argv_view_.push_back(
const_cast<char *
>(arg.data()));
80 return normalized_argv_view_.data();
89 std::string oname =
name_;
104 if(app_name.empty() || !detail::valid_alias_name_string(app_name)) {
112 throw(
OptionAlreadyAdded(
"alias already matches an existing subcommand: " + app_name));
140 throw OptionAlreadyAdded(
"ignore case would cause subcommand name conflicts: " + match);
154 throw OptionAlreadyAdded(
"ignore underscore would cause subcommand name conflicts: " + match);
162 callback_t option_callback,
163 std::string option_description,
165 std::function<std::string()> func) {
168 if(std::find_if(std::begin(
options_), std::end(
options_), [&myopt](
const Option_p &v) {
return *v == myopt; }) ==
170 if(myopt.lnames_.empty() && myopt.snames_.empty()) {
173 std::string test_name =
"--" + myopt.get_single_name();
174 if(test_name.size() == 3) {
175 test_name.erase(0, 1);
179 if(op !=
nullptr && op->get_configurable()) {
180 throw(
OptionAlreadyAdded(
"added option positional name matches existing option: " + test_name));
185 if(op !=
nullptr && op->lnames_.empty() && op->snames_.empty()) {
186 throw(
OptionAlreadyAdded(
"unable to disambiguate with existing option: " + test_name));
188 }
else if(
parent_ !=
nullptr) {
189 for(
auto &ln : myopt.lnames_) {
191 if(op !=
nullptr && op->get_configurable()) {
195 for(
auto &sn : myopt.snames_) {
197 if(op !=
nullptr && op->get_configurable()) {
203 for(
auto &sname : myopt.snames_) {
204 if(sname.length() > 1) {
205 std::string test_name;
206 test_name.push_back(
'-');
207 test_name.push_back(sname.front());
210 throw(
OptionAlreadyAdded(
"added option interferes with existing short option: " + sname));
215 for(
const auto &osn : opt->snames_) {
217 std::string test_name;
218 test_name.push_back(osn.front());
219 if(myopt.check_sname(test_name)) {
220 throw(
OptionAlreadyAdded(
"added option interferes with existing non standard option: " +
232 option->default_function(func);
236 option->capture_default_str();
242 if(!defaulted && option->get_always_capture_default())
243 option->capture_default_str();
249 const auto &matchname = opt->matching_name(myopt);
250 if(!matchname.empty()) {
266 if(!flag_name.empty()) {
282 if(!help_name.empty()) {
299 if(!flag_name.empty()) {
301 flag_name, [versionString]() {
throw(
CLI::CallForVersion(versionString, 0)); }, version_help);
316 if(!flag_name.empty()) {
325CLI11_INLINE
Option *App::_add_flag_internal(std::string flag_name, CLI::callback_t fun, std::string flag_description) {
327 if(detail::has_default_flag_values(flag_name)) {
329 auto flag_defaults = detail::get_default_flag_values(flag_name);
330 detail::remove_default_flag_values(flag_name);
331 opt =
add_option(std::move(flag_name), std::move(fun), std::move(flag_description),
false);
332 for(
const auto &fname : flag_defaults)
333 opt->
fnames_.push_back(fname.first);
336 opt =
add_option(std::move(flag_name), std::move(fun), std::move(flag_description),
false);
340 auto pos_name = opt->
get_name(
true);
342 throw IncorrectConstruction::PositionalFlag(pos_name);
351 std::function<
void(
void)> function,
352 std::string flag_description) {
354 CLI::callback_t fun = [function](
const CLI::results_t &res) {
355 using CLI::detail::lexical_cast;
357 auto result = lexical_cast(res[0], trigger);
358 if(result && trigger) {
363 return _add_flag_internal(flag_name, std::move(fun), std::move(flag_description));
368 std::function<
void(std::int64_t)> function,
369 std::string flag_description) {
371 CLI::callback_t fun = [function](
const CLI::results_t &res) {
372 using CLI::detail::lexical_cast;
373 std::int64_t flag_count{0};
374 lexical_cast(res[0], flag_count);
375 function(flag_count);
378 return _add_flag_internal(flag_name, std::move(fun), std::move(flag_description))
383 std::string default_filename,
384 const std::string &help_message,
385 bool config_required) {
394 if(!option_name.empty()) {
396 if(config_required) {
399 if(!default_filename.empty()) {
414 op->remove_needs(opt);
415 op->remove_excludes(opt);
426 std::find_if(std::begin(
options_), std::end(
options_), [opt](
const Option_p &v) {
return v.get() == opt; });
427 if(iterator != std::end(
options_)) {
435 if(!subcommand_name.empty() && !detail::valid_name_string(subcommand_name)) {
436 if(!detail::valid_first_char(subcommand_name[0])) {
438 "Subcommand name starts with invalid character, '!' and '-' and control characters");
440 for(
auto c : subcommand_name) {
441 if(!detail::valid_later_char(c)) {
443 "'), all characters are allowed except"
444 "'=',':','{','}', ' ', and control characters");
448 CLI::App_p subcom = std::shared_ptr<App>(
new App(std::move(subcommand_description), subcommand_name,
this));
458 throw(
OptionAlreadyAdded(
"subcommand name or alias matches existing subcommand: " + mstrg));
460 subcom->parent_ =
this;
468 sub->remove_excludes(subcom);
469 sub->remove_needs(subcom);
472 auto iterator = std::find_if(
482 if(subcom ==
nullptr)
485 if(subcomptr.get() == subcom)
486 return subcomptr.get();
498 return _find_subcommand(subcom,
false,
false);
503 auto uindex =
static_cast<unsigned>(index);
511 if(subcom ==
nullptr)
514 if(subcomptr.get() == subcom)
521 if(subcomptr->check_name(subcom))
528 auto uindex =
static_cast<unsigned>(index);
537 if(app->name_.empty() && app->group_ == group_name) {
550 cnt += sub->count_all();
565 for(
const Option_p &opt :
options_) {
573CLI11_INLINE
void App::parse(
int argc,
const char *
const *argv) { parse_char_t(argc, argv); }
574CLI11_INLINE
void App::parse(
int argc,
const wchar_t *
const *argv) { parse_char_t(argc, argv); }
579CLI11_INLINE
const char *maybe_narrow(
const char *str) {
return str; }
580CLI11_INLINE std::string maybe_narrow(
const wchar_t *str) {
return narrow(str); }
584template <
class CharT> CLI11_INLINE
void App::parse_char_t(
int argc,
const CharT *
const *argv) {
588 name_ = detail::maybe_narrow(argv[0]);
591 std::vector<std::string> args;
592 args.reserve(
static_cast<std::size_t
>(argc) - 1U);
593 for(
auto i =
static_cast<std::size_t
>(argc) - 1U; i > 0U; --i)
594 args.emplace_back(detail::maybe_narrow(argv[i]));
596 parse(std::move(args));
599CLI11_INLINE
void App::parse(std::string commandline,
bool program_name_included) {
601 if(program_name_included) {
602 auto nstr = detail::split_program_name(commandline);
607 commandline = std::move(nstr.second);
609 detail::trim(commandline);
612 if(!commandline.empty()) {
613 commandline = detail::find_and_modify(commandline,
"=", detail::escape_detect);
615 commandline = detail::find_and_modify(commandline,
":", detail::escape_detect);
618 auto args = detail::split_up(std::move(commandline));
620 args.erase(std::remove(args.begin(), args.end(), std::string{}), args.end());
622 detail::remove_quotes(args);
623 }
catch(
const std::invalid_argument &arg) {
626 std::reverse(args.begin(), args.end());
627 parse(std::move(args));
630CLI11_INLINE
void App::parse(std::wstring commandline,
bool program_name_included) {
631 parse(narrow(commandline), program_name_included);
634CLI11_INLINE
void App::parse(std::vector<std::string> &args) {
653CLI11_INLINE
void App::parse(std::vector<std::string> &&args) {
672CLI11_INLINE
void App::parse_from_stream(std::istream &input) {
683CLI11_INLINE
int App::exit(
const Error &e, std::ostream &out, std::ostream &err)
const {
686 if(e.get_name() ==
"RuntimeError")
687 return e.get_exit_code();
689 if(e.get_name() ==
"CallForHelp") {
691 return e.get_exit_code();
694 if(e.get_name() ==
"CallForAllHelp") {
695 out <<
help(
"", AppFormatMode::All);
696 return e.get_exit_code();
699 if(e.get_name() ==
"CallForVersion") {
700 out << e.what() <<
'\n';
701 return e.get_exit_code();
704 if(e.get_exit_code() !=
static_cast<int>(ExitCodes::Success)) {
709 return e.get_exit_code();
718 subcomms.erase(std::remove_if(std::begin(subcomms),
720 [&filter](
const App *app) {
return !filter(app); }),
734 std::remove_if(std::begin(subcomms), std::end(subcomms), [&filter](
App *app) {
return !filter(app); }),
755 auto *other_app = *iterator;
757 other_app->remove_excludes(
this);
779CLI11_NODISCARD CLI11_INLINE std::string
App::help(std::string prev, AppFormatMode mode)
const {
787 if(!selected_subcommands.empty()) {
788 return selected_subcommands.back()->help(prev, mode);
790 return formatter_->make_help(
this, prev, mode);
812 std::vector<const Option *> options(
options_.size());
814 std::begin(
options_), std::end(
options_), std::begin(options), [](
const Option_p &val) {
return val.get(); });
817 options.erase(std::remove_if(std::begin(options),
819 [&filter](
const Option *opt) {
return !filter(opt); }),
824 const App *subc = subcp.get();
826 std::vector<const Option *> subcopts = subc->
get_options(filter);
827 options.insert(options.end(), subcopts.begin(), subcopts.end());
834 std::vector<Option *> options(
options_.size());
836 std::begin(
options_), std::end(
options_), std::begin(options), [](
const Option_p &val) {
return val.get(); });
840 std::remove_if(std::begin(options), std::end(options), [&filter](
Option *opt) {
return !filter(opt); }),
845 if(subc->get_name().empty() && !subc->get_group().empty() && subc->get_group().front() ==
'+') {
846 auto subcopts = subc->get_options(filter);
847 options.insert(options.end(), subcopts.begin(), subcopts.end());
854 for(Option_p &opt : options_) {
859 for(
auto &subc : subcommands_) {
861 if(subc->get_name().empty()) {
862 auto *opt = subc->get_option_no_throw(option_name);
872 for(
const Option_p &opt : options_) {
877 for(
const auto &subc : subcommands_) {
879 if(subc->get_name().empty()) {
880 auto *opt = subc->get_option_no_throw(option_name);
891 return std::string(
"[Option Group: ") +
get_group() +
"]";
893 if(
aliases_.empty() || !with_aliases) {
896 std::string dispname =
name_;
897 for(
const auto &lalias :
aliases_) {
898 dispname.push_back(
',');
899 dispname.push_back(
' ');
900 dispname.append(lalias);
907 return (result != NameMatch::none);
911 std::string local_name =
name_;
913 local_name = detail::remove_underscore(
name_);
914 name_to_check = detail::remove_underscore(name_to_check);
917 local_name = detail::to_lower(
name_);
918 name_to_check = detail::to_lower(name_to_check);
921 if(local_name == name_to_check) {
922 return App::NameMatch::exact;
925 if(local_name.compare(0, name_to_check.size(), name_to_check) == 0) {
926 return App::NameMatch::prefix;
931 les = detail::remove_underscore(les);
934 les = detail::to_lower(les);
936 if(les == name_to_check) {
937 return App::NameMatch::exact;
940 if(les.compare(0, name_to_check.size(), name_to_check) == 0) {
941 return App::NameMatch::prefix;
945 return App::NameMatch::none;
949 std::vector<std::string> groups;
951 for(
const Option_p &opt :
options_) {
953 if(std::find(groups.begin(), groups.end(), opt->
get_group()) == groups.end()) {
961CLI11_NODISCARD CLI11_INLINE std::vector<std::string>
App::remaining(
bool recurse)
const {
962 std::vector<std::string> miss_list;
963 for(
const std::pair<detail::Classifier, std::string> &miss :
missing_) {
964 miss_list.push_back(std::get<1>(miss));
970 if(sub->name_.empty() && !sub->missing_.empty()) {
971 for(
const std::pair<detail::Classifier, std::string> &miss : sub->missing_) {
972 miss_list.push_back(std::get<1>(miss));
980 std::vector<std::string> output = sub->remaining(recurse);
981 std::copy(std::begin(output), std::end(output), std::back_inserter(miss_list));
988 std::vector<std::string> miss_list =
remaining(recurse);
989 std::reverse(std::begin(miss_list), std::end(miss_list));
994 auto remaining_options =
static_cast<std::size_t
>(std::count_if(
995 std::begin(
missing_), std::end(
missing_), [](
const std::pair<detail::Classifier, std::string> &val) {
996 return val.first != detail::Classifier::POSITIONAL_MARK;
1001 remaining_options += sub->remaining_size(recurse);
1004 return remaining_options;
1009 auto pcount = std::count_if(std::begin(
options_), std::end(
options_), [](
const Option_p &opt) {
1010 return opt->get_items_expected_max() >= detail::expected_max_vector_size && !opt->nonpositional();
1013 auto pcount_req = std::count_if(std::begin(
options_), std::end(
options_), [](
const Option_p &opt) {
1014 return opt->get_items_expected_max() >= detail::expected_max_vector_size && !opt->nonpositional() &&
1015 opt->get_required();
1017 if(pcount - pcount_req > 1) {
1022 std::size_t nameless_subs{0};
1032 throw(
InvalidError(
"Required min options greater than required max options", ExitCodes::InvalidError));
1037 InvalidError(
"Required min options greater than number of available options", ExitCodes::InvalidError));
1052 if(app->
name_.empty()) {
1070 if(subc->parent_ ==
this) {
1071 subc->run_callback(
true, suppress_final_callback);
1076 if(subc->name_.empty() && subc->count_all() > 0) {
1077 subc->run_callback(
true, suppress_final_callback);
1096 if(com !=
nullptr) {
1106CLI11_NODISCARD CLI11_INLINE detail::Classifier
App::_recognize(
const std::string ¤t,
1107 bool ignore_used_subcommands)
const {
1108 std::string dummy1, dummy2;
1111 return detail::Classifier::POSITIONAL_MARK;
1113 return detail::Classifier::SUBCOMMAND;
1114 if(detail::split_long(current, dummy1, dummy2))
1115 return detail::Classifier::LONG;
1116 if(detail::split_short(current, dummy1, dummy2)) {
1117 if((dummy1[0] >=
'0' && dummy1[0] <=
'9') ||
1118 (dummy1[0] ==
'.' && !dummy2.empty() && (dummy2[0] >=
'0' && dummy2[0] <=
'9'))) {
1121 return detail::Classifier::NONE;
1124 return detail::Classifier::SHORT;
1127 return detail::Classifier::WINDOWS_STYLE;
1128 if((current ==
"++") && !
name_.empty() &&
parent_ !=
nullptr)
1129 return detail::Classifier::SUBCOMMAND_TERMINATOR;
1130 auto dotloc = current.find_first_of(
'.');
1131 if(dotloc != std::string::npos) {
1132 auto *cm =
_find_subcommand(current.substr(0, dotloc),
true, ignore_used_subcommands);
1134 auto res = cm->_recognize(current.substr(dotloc + 1), ignore_used_subcommands);
1135 if(res == detail::Classifier::SUBCOMMAND) {
1140 return detail::Classifier::NONE;
1144 auto path_result = detail::check_path(config_file.c_str());
1145 if(path_result == detail::path_type::file) {
1156 }
else if(throw_error) {
1157 throw FileError::Missing(config_file);
1169 if(!ename_string.empty()) {
1175 auto config_files =
config_ptr_->
as<std::vector<std::string>>();
1176 bool files_used{file_given};
1177 if(config_files.empty() || config_files.front().empty()) {
1178 if(config_required) {
1179 throw FileError(
"config file is required but none was given");
1183 for(
const auto &config_file : config_files) {
1200 for(
const Option_p &opt :
options_) {
1202 std::string ename_string = detail::get_environment_value(opt->
envname_);
1203 if(!ename_string.empty()) {
1204 std::string result = ename_string;
1205 result = opt->_validate(result, 0);
1206 if(result.empty()) {
1214 if(sub->get_name().empty() || (sub->count_all() > 0 && !sub->parse_complete_callback_)) {
1216 sub->_process_env();
1225 if(sub->get_name().empty() && sub->parse_complete_callback_) {
1226 if(sub->count_all() > 0) {
1227 sub->_process_callbacks();
1228 sub->run_callback();
1233 for(
const Option_p &opt :
options_) {
1239 if(!sub->parse_complete_callback_) {
1240 sub->_process_callbacks();
1249 if(help_ptr !=
nullptr && help_ptr->
count() > 0)
1250 trigger_help =
true;
1251 if(help_all_ptr !=
nullptr && help_all_ptr->
count() > 0)
1252 trigger_all_help =
true;
1257 sub->_process_help_flags(trigger_help, trigger_all_help);
1260 }
else if(trigger_all_help) {
1262 }
else if(trigger_help) {
1269 bool excluded{
false};
1270 std::string excluder;
1272 if(opt->
count() > 0) {
1278 if(subc->count_all() > 0) {
1280 excluder = subc->get_display_name();
1292 bool missing_needed{
false};
1293 std::string missing_need;
1295 if(opt->
count() == 0) {
1296 missing_needed =
true;
1301 if(subc->count_all() == 0) {
1302 missing_needed =
true;
1303 missing_need = subc->get_display_name();
1306 if(missing_needed) {
1314 std::size_t used_options = 0;
1315 for(
const Option_p &opt :
options_) {
1317 if(opt->
count() != 0) {
1326 if(opt->
count() > 0 && opt_req->
count() == 0)
1347 if(sub->name_.empty() && sub->count_all() > 0) {
1353 auto option_list = detail::join(
options_, [
this](
const Option_p &ptr) {
1355 return std::string{};
1357 return ptr->get_name(
false,
true);
1361 if(!subc_list.empty()) {
1362 option_list +=
"," + detail::join(subc_list, [](
const App *app) {
return app->
get_display_name(); });
1371 if(sub->name_.empty() && sub->required_ ==
false) {
1372 if(sub->count_all() == 0) {
1385 if(sub->count() > 0 || sub->name_.empty()) {
1386 sub->_process_requirements();
1389 if(sub->required_ && sub->count_all() == 0) {
1421 if(num_left_over > 0) {
1427 if(sub->count() > 0)
1428 sub->_process_extras();
1435 if(num_left_over > 0) {
1442 if(sub->count() > 0)
1443 sub->_process_extras(args);
1450 if(sub->get_name().empty())
1451 sub->increment_parsed();
1458 bool positional_only =
false;
1460 while(!args.empty()) {
1488 bool positional_only =
false;
1490 while(!args.empty()) {
1513 throw ConfigError::Extras(item.fullname());
1519 if(item.
inputs.size() <= 1) {
1522 bool converted{
false};
1524 auto val = detail::to_flag_value(res);
1548 throw ConversionError::TooManyInputsFlag(item.
fullname());
1552 for(
const auto &res : inputs) {
1553 bool valid_value{
false};
1555 if(res ==
"true" || res ==
"false" || res ==
"1" || res ==
"0") {
1560 if(valid_res.second == res) {
1580 if(level < item.
parents.size()) {
1582 return (subcom !=
nullptr) ? subcom->_parse_single_config(item, level + 1) :
false;
1585 if(item.
name ==
"++") {
1596 if(item.
name ==
"--") {
1606 if(item.
name.size() == 1) {
1613 if(testop !=
nullptr && testop->get_configurable()) {
1618 if(item.
name.size() == 1) {
1620 if(testop !=
nullptr && testop->get_configurable()) {
1626 if(testop !=
nullptr && testop->get_configurable()) {
1637 for(
const auto &input : item.
inputs) {
1638 missing_.emplace_back(detail::Classifier::NONE, input);
1648 throw ConfigError::NotConfigurable(item.
fullname());
1651 std::vector<std::string> buffer;
1652 bool useBuffer{
false};
1656 buffer.erase(std::remove(buffer.begin(), buffer.end(),
"%%"), buffer.end());
1660 const std::vector<std::string> &inputs = (useBuffer) ? buffer : item.
inputs;
1675 detail::Classifier classifier = positional_only ? detail::Classifier::NONE :
_recognize(args.back());
1676 switch(classifier) {
1677 case detail::Classifier::POSITIONAL_MARK:
1679 positional_only =
true;
1686 case detail::Classifier::SUBCOMMAND_TERMINATOR:
1691 case detail::Classifier::SUBCOMMAND:
1694 case detail::Classifier::LONG:
1695 case detail::Classifier::SHORT:
1696 case detail::Classifier::WINDOWS_STYLE:
1698 retval =
_parse_arg(args, classifier,
false);
1700 case detail::Classifier::NONE:
1704 positional_only =
true;
1709 throw HorribleError(
"unrecognized classifier (you should not see this!)");
1716 std::size_t retval = 0;
1717 for(
const Option_p &opt :
options_) {
1728 for(
const Option_p &opt :
options_) {
1739 const std::string &positional = args.back();
1744 auto arg_rem = args.size();
1746 if(arg_rem <= remreq) {
1747 for(
const Option_p &opt :
options_) {
1751 std::string pos = positional;
1752 pos = opt->_validate(pos, 0);
1764 if(posOpt ==
nullptr) {
1765 for(
const Option_p &opt :
options_) {
1770 std::string pos = positional;
1771 pos = opt->_validate(pos, 0);
1781 if(posOpt !=
nullptr) {
1783 if(posOpt->get_inject_separator()) {
1784 if(!posOpt->results().empty() && !posOpt->results().back().empty()) {
1785 posOpt->add_result(std::string{});
1791 if(posOpt->get_expected_min() == 0) {
1793 item.
name = posOpt->pname_;
1794 item.
inputs.push_back(positional);
1798 posOpt->add_result(positional);
1801 if(posOpt->get_trigger_on_parse()) {
1802 if(!posOpt->empty()) {
1803 posOpt->run_callback();
1812 if((subc->name_.empty()) && (!subc->disabled_)) {
1813 if(subc->_parse_positional(args,
false)) {
1814 if(!subc->pre_parse_called_) {
1815 subc->_trigger_pre_parse(args.size());
1828 if(haltOnSubcommand) {
1840 if(com !=
nullptr && (com->parent_->require_subcommand_max_ == 0 ||
1841 com->parent_->require_subcommand_max_ > com->parent_->parsed_subcommands_.size())) {
1846 std::vector<std::string> rargs;
1847 rargs.resize(args.size());
1848 std::reverse_copy(args.begin(), args.end(), rargs.begin());
1859 while(!args.empty()) {
1868CLI11_NODISCARD CLI11_INLINE
App *
1871 for(
const App_p &com : subcommands_) {
1872 if(com->disabled_ && ignore_disabled)
1874 if(com->get_name().empty()) {
1875 auto *subc = com->_find_subcommand(subc_name, ignore_disabled, ignore_used);
1876 if(subc !=
nullptr) {
1877 if(bcom !=
nullptr) {
1881 if(!allow_prefix_matching_) {
1886 auto res = com->check_name_detail(subc_name);
1887 if(res != NameMatch::none) {
1888 if((!*com) || !ignore_used) {
1889 if(res == NameMatch::exact) {
1892 if(bcom !=
nullptr) {
1896 if(!allow_prefix_matching_) {
1911 if(com ==
nullptr) {
1913 auto dotloc = args.back().find_first_of(
'.');
1914 if(dotloc != std::string::npos) {
1916 if(com !=
nullptr) {
1917 args.back() = args.back().substr(dotloc + 1);
1918 args.push_back(com->get_display_name());
1922 if(com !=
nullptr) {
1928 auto *parent_app = com->parent_;
1929 while(parent_app !=
this) {
1930 parent_app->_trigger_pre_parse(args.size());
1932 parent_app->parsed_subcommands_.push_back(com);
1934 parent_app = parent_app->parent_;
1940 throw HorribleError(
"Subcommand " + args.back() +
" missing");
1945App::_parse_arg(std::vector<std::string> &args, detail::Classifier current_type,
bool local_processing_only) {
1947 std::string current = args.back();
1949 std::string arg_name;
1953 switch(current_type) {
1954 case detail::Classifier::LONG:
1955 if(!detail::split_long(current, arg_name, value))
1956 throw HorribleError(
"Long parsed but missing (you should not see this):" + args.back());
1958 case detail::Classifier::SHORT:
1959 if(!detail::split_short(current, arg_name, rest))
1960 throw HorribleError(
"Short parsed but missing! You should not see this");
1962 case detail::Classifier::WINDOWS_STYLE:
1963 if(!detail::split_windows_style(current, arg_name, value))
1964 throw HorribleError(
"windows option parsed but missing! You should not see this");
1966 case detail::Classifier::SUBCOMMAND:
1967 case detail::Classifier::SUBCOMMAND_TERMINATOR:
1968 case detail::Classifier::POSITIONAL_MARK:
1969 case detail::Classifier::NONE:
1971 throw HorribleError(
"parsing got called with invalid option! You should not see this");
1974 auto op_ptr = std::find_if(std::begin(
options_), std::end(
options_), [arg_name, current_type](
const Option_p &opt) {
1975 if(current_type == detail::Classifier::LONG)
1976 return opt->check_lname(arg_name);
1977 if(current_type == detail::Classifier::SHORT)
1978 return opt->check_sname(arg_name);
1980 return opt->check_lname(arg_name) || opt->check_sname(arg_name);
1984 while(op_ptr == std::end(
options_)) {
1987 if(subc->name_.empty() && !subc->disabled_) {
1988 if(subc->_parse_arg(args, current_type, local_processing_only)) {
1989 if(!subc->pre_parse_called_) {
1990 subc->_trigger_pre_parse(args.size());
1997 std::string narg_name;
1999 detail::split_long(std::string{
'-'} + current, narg_name, nvalue);
2000 op_ptr = std::find_if(std::begin(
options_), std::end(
options_), [narg_name](
const Option_p &opt) {
2001 return opt->check_sname(narg_name);
2004 arg_name = narg_name;
2017 auto dotloc = arg_name.find_first_of(
'.', 1);
2018 if(dotloc != std::string::npos && dotloc < arg_name.size() - 1) {
2021 if(sub !=
nullptr) {
2022 std::string v = args.back();
2024 arg_name = arg_name.substr(dotloc + 1);
2025 if(arg_name.size() > 1) {
2026 args.push_back(std::string(
"--") + v.substr(dotloc + 3));
2027 current_type = detail::Classifier::LONG;
2029 auto nval = v.substr(dotloc + 2);
2031 if(nval.size() > 2) {
2033 args.push_back(nval.substr(3));
2036 args.push_back(nval);
2037 current_type = detail::Classifier::SHORT;
2039 std::string dummy1, dummy2;
2041 if((current_type == detail::Classifier::SHORT && detail::valid_first_char(args.back()[1])) ||
2042 detail::split_long(args.back(), dummy1, dummy2)) {
2043 val = sub->_parse_arg(args, current_type,
true);
2054 if(sub->parse_complete_callback_) {
2055 sub->_process_env();
2056 sub->_process_callbacks();
2057 sub->_process_help_flags();
2058 sub->_process_requirements();
2059 sub->run_callback(
false,
true);
2067 if(local_processing_only) {
2083 Option_p &op = *op_ptr;
2085 if(op->get_inject_separator()) {
2086 if(!op->results().empty() && !op->results().back().empty()) {
2087 op->add_result(std::string{});
2093 int min_num = (std::min)(op->get_type_size_min(), op->get_items_expected_min());
2094 int max_num = op->get_items_expected_max();
2097 if(max_num >= detail::expected_max_vector_size / 16 && !op->get_allow_extra_args()) {
2098 auto tmax = op->get_type_size_max();
2099 max_num = detail::checked_multiply(tmax, op->get_expected_min()) ? tmax : detail::expected_max_vector_size;
2103 int result_count = 0;
2106 auto res = op->get_flag_value(arg_name, value);
2107 op->add_result(res);
2109 }
else if(!value.empty()) {
2110 op->add_result(value, result_count);
2112 collected += result_count;
2114 }
else if(!rest.empty()) {
2115 op->add_result(rest, result_count);
2118 collected += result_count;
2122 while(min_num > collected && !args.empty()) {
2123 std::string current_ = args.back();
2125 op->add_result(current_, result_count);
2127 collected += result_count;
2130 if(min_num > collected) {
2131 throw ArgumentMismatch::TypedAtLeast(op->get_name(), min_num, op->get_type_name());
2135 if(max_num > collected || op->get_allow_extra_args()) {
2138 while((collected < max_num || op->get_allow_extra_args()) && !args.empty() &&
2139 _recognize(args.back(),
false) == detail::Classifier::NONE) {
2141 if(remreqpos >= args.size()) {
2145 std::string arg = args.back();
2146 arg = op->_validate(arg, 0);
2151 op->add_result(args.back(), result_count);
2154 collected += result_count;
2158 if(!args.empty() &&
_recognize(args.back()) == detail::Classifier::POSITIONAL_MARK)
2161 if(min_num == 0 && max_num > 0 && collected == 0) {
2162 auto res = op->get_flag_value(arg_name, std::string{});
2163 op->add_result(res);
2168 if(min_num > 0 && (collected % op->get_type_size_max()) != 0) {
2169 if(op->get_type_size_max() != op->get_type_size_min()) {
2170 op->add_result(std::string{});
2172 throw ArgumentMismatch::PartialType(op->get_name(), op->get_type_size_min(), op->get_type_name());
2175 if(op->get_trigger_on_parse()) {
2180 args.push_back(rest);
2192 if(!
name_.empty()) {
2194 missing_t extras = std::move(
missing_);
2207 auto *fallthrough_parent =
parent_;
2208 while((fallthrough_parent->parent_ !=
nullptr) && (fallthrough_parent->get_name().empty())) {
2209 fallthrough_parent = fallthrough_parent->parent_;
2211 return fallthrough_parent;
2215 const App &base)
const {
2216 static const std::string estring;
2221 if(subc.get() != &subcom) {
2222 if(subc->disabled_) {
2226 if(subc->check_name(subcom.
get_name())) {
2230 if(!subc->get_name().empty()) {
2232 return subc->get_name();
2235 for(
const auto &les : subcom.
aliases_) {
2236 if(subc->check_name(les)) {
2241 for(
const auto &les : subc->aliases_) {
2247 if(subc->get_name().empty()) {
2249 if(!cmpres.empty()) {
2256 if(!cmpres.empty()) {
2267 missing_.emplace_back(val_type, val);
2272 if(subc->name_.empty() && subc->allow_extras_) {
2273 subc->missing_.emplace_back(val_type, val);
2278 missing_.emplace_back(val_type, val);
2282 if(opt ==
nullptr) {
2288 if(app == subc.get()) {
2303 std::find_if(std::begin(
options_), std::end(
options_), [opt](
const Option_p &v) {
return v.get() == opt; });
2304 if(iterator != std::end(
options_)) {
2305 const auto &opt_p = *iterator;
2306 if(std::find_if(std::begin(app->
options_), std::end(app->
options_), [&opt_p](
const Option_p &v) {
2307 return (*v == *opt_p);
2310 app->
options_.push_back(std::move(*iterator));
2320CLI11_INLINE
void TriggerOn(
App *trigger_app,
App *app_to_enable) {
2326CLI11_INLINE
void TriggerOn(App *trigger_app, std::vector<App *> apps_to_enable) {
2327 for(
auto &app : apps_to_enable) {
2332 trigger_app->preparse_callback([apps_to_enable](std::size_t) {
2333 for(
const auto &app : apps_to_enable) {
2339CLI11_INLINE
void TriggerOff(App *trigger_app, App *app_to_enable) {
2340 app_to_enable->disabled_by_default(
false);
2341 app_to_enable->enabled_by_default();
2342 trigger_app->preparse_callback([app_to_enable](std::size_t) { app_to_enable->disabled(); });
2345CLI11_INLINE
void TriggerOff(App *trigger_app, std::vector<App *> apps_to_enable) {
2346 for(
auto &app : apps_to_enable) {
2351 trigger_app->preparse_callback([apps_to_enable](std::size_t) {
2352 for(
const auto &app : apps_to_enable) {
2358CLI11_INLINE
void deprecate_option(Option *opt,
const std::string &replacement) {
2359 Validator deprecate_warning{[opt, replacement](std::string &) {
2360 std::cout << opt->get_name() <<
" is deprecated please use '" << replacement
2362 return std::string();
2365 deprecate_warning.application_index(0);
2366 opt->check(deprecate_warning);
2367 if(!replacement.empty()) {
2368 opt->description(opt->get_description() +
" DEPRECATED: please use '" + replacement +
"' instead");
2372CLI11_INLINE
void retire_option(App *app, Option *opt) {
2374 auto *option_copy = temp.add_option(opt->get_name(
false,
true))
2375 ->type_size(opt->get_type_size_min(), opt->get_type_size_max())
2376 ->expected(opt->get_expected_min(), opt->get_expected_max())
2377 ->allow_extra_args(opt->get_allow_extra_args());
2379 app->remove_option(opt);
2380 auto *opt2 = app->add_option(option_copy->get_name(
false,
true),
"option has been retired and has no effect");
2381 opt2->type_name(
"RETIRED")
2382 ->default_str(
"RETIRED")
2383 ->type_size(option_copy->get_type_size_min(), option_copy->get_type_size_max())
2384 ->expected(option_copy->get_expected_min(), option_copy->get_expected_max())
2385 ->allow_extra_args(option_copy->get_allow_extra_args());
2389 Validator retired_warning{[opt2](std::string &) {
2390 std::cout <<
"WARNING " << opt2->get_name() <<
" is retired and has no effect\n";
2391 return std::string();
2395 retired_warning.application_index(0);
2396 opt2->check(retired_warning);
2399CLI11_INLINE
void retire_option(App &app, Option *opt) { retire_option(&app, opt); }
2401CLI11_INLINE
void retire_option(App *app,
const std::string &option_name) {
2403 auto *opt = app->get_option_no_throw(option_name);
2404 if(opt !=
nullptr) {
2405 retire_option(app, opt);
2408 auto *opt2 = app->add_option(option_name,
"option has been retired and has no effect")
2409 ->type_name(
"RETIRED")
2411 ->default_str(
"RETIRED");
2414 Validator retired_warning{[opt2](std::string &) {
2415 std::cout <<
"WARNING " << opt2->get_name() <<
" is retired and has no effect\n";
2416 return std::string();
2420 retired_warning.application_index(0);
2421 opt2->check(retired_warning);
2424CLI11_INLINE
void retire_option(App &app,
const std::string &option_name) { retire_option(&app, option_name); }
2426namespace FailureMessage {
2428CLI11_INLINE std::string simple(
const App *app,
const Error &e) {
2429 std::string header = std::string(e.what()) +
"\n";
2430 std::vector<std::string> names;
2433 if(app->get_help_ptr() !=
nullptr)
2434 names.push_back(app->get_help_ptr()->get_name());
2436 if(app->get_help_all_ptr() !=
nullptr)
2437 names.push_back(app->get_help_all_ptr()->get_name());
2441 header +=
"Run with " + detail::join(names,
" or ") +
" for more information.\n";
2446CLI11_INLINE std::string help(
const App *app,
const Error &e) {
2447 std::string header = std::string(
"ERROR: ") + e.get_name() +
": " + e.what() +
"\n";
2448 header += app->help();
Creates a command line program, with very few defaults.
Definition App.hpp:98
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:853
bool subcommand_fallthrough_
Allow subcommands to fallthrough, so that parent commands can trigger other subcommands after subcomm...
Definition App.hpp:240
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:683
CLI11_NODISCARD std::string help(std::string prev="", AppFormatMode mode=AppFormatMode::Normal) const
Definition App_inl.hpp:779
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:993
CLI11_NODISCARD bool _has_remaining_positionals() const
Count the required remaining positional arguments.
Definition App_inl.hpp:1727
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:1106
App * immediate_callback(bool immediate=true)
Set the subcommand callback to be executed immediately on subcommand completion.
Definition App_inl.hpp:121
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:258
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:2203
bool allow_non_standard_options_
indicator that the subcommand should allow non-standard option arguments, such as -single_dash_flag
Definition App.hpp:272
Option * config_ptr_
Pointer to the config option.
Definition App.hpp:306
App * disabled_by_default(bool disable=true)
Set the subcommand to be disabled by default, so on clear(), at the start of each parse it is disable...
Definition App.hpp:421
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:2265
std::size_t require_option_min_
Minimum required options (not inheritable!)
Definition App.hpp:287
NameMatch
enumeration of matching possibilities
Definition App.hpp:1246
App * ignore_underscore(bool value=true)
Ignore underscore. Subcommands inherit value.
Definition App_inl.hpp:147
std::size_t require_subcommand_max_
Max number of subcommands allowed (parsing stops after this number). 0 is unlimited INHERITABLE.
Definition App.hpp:284
std::vector< App_p > subcommands_
Storage for subcommand list.
Definition App.hpp:227
CLI11_NODISCARD std::vector< std::string > remaining(bool recurse=false) const
This returns the missing options from the current subcommand.
Definition App_inl.hpp:961
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:987
std::uint32_t parsed_
Counts the number of times this command/subcommand was parsed.
Definition App.hpp:278
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:535
std::string usage_
Usage to put after program/subcommand description in the help output INHERITABLE.
Definition App.hpp:164
OptionDefaults option_defaults_
The default values for options, customizable and changeable INHERITABLE.
Definition App.hpp:154
void _process_help_flags(bool trigger_help=false, bool trigger_all_help=false) const
Definition App_inl.hpp:1245
void _process_requirements()
Verify required options and cross requirements. Subcommands too (only if selected).
Definition App_inl.hpp:1267
CLI11_NODISCARD std::size_t count_all() const
Definition App_inl.hpp:544
bool disabled_
If set to true the subcommand is disabled and cannot be used, ignored for main app.
Definition App.hpp:131
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:291
bool remove_needs(Option *opt)
Removes an option from the needs list of this subcommand.
Definition App_inl.hpp:761
Option * get_help_ptr()
Get a pointer to the help flag.
Definition App.hpp:1200
void _configure()
Definition App_inl.hpp:1042
CLI11_NODISCARD std::size_t _count_remaining_positionals(bool required_only=false) const
Count the required remaining positional arguments.
Definition App_inl.hpp:1715
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:367
void parse(int argc, const char *const *argv)
Definition App_inl.hpp:573
void _process_config_file()
Read and process a configuration file (main app only)
Definition App_inl.hpp:1163
std::string footer_
Footer to put after all options in the help output INHERITABLE.
Definition App.hpp:170
void increment_parsed()
Internal function to recursively increment the parsed counter on the current app as well unnamed subc...
Definition App_inl.hpp:1447
config_extras_mode allow_config_extras_
Definition App.hpp:119
CLI11_NODISCARD bool check_name(std::string name_to_check) const
Definition App_inl.hpp:905
Option * version_ptr_
A pointer to a version flag if there is one.
Definition App.hpp:182
CLI11_NODISCARD const Option * get_help_all_ptr() const
Get a pointer to the help all flag. (const)
Definition App.hpp:1206
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:465
App * parent_
A pointer to the parent if this is a subcommand.
Definition App.hpp:293
std::set< Option * > exclude_options_
Definition App.hpp:212
void _trigger_pre_parse(std::size_t remaining_args)
Trigger the pre_parse callback if needed.
Definition App_inl.hpp:2185
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:510
std::function< void()> parse_complete_callback_
This is a function that runs when parsing has finished.
Definition App.hpp:144
virtual void pre_callback()
Definition App.hpp:887
Option * add_flag(std::string flag_name)
Add a flag with no description or variable assignment.
Definition App.hpp:655
void _validate() const
Definition App_inl.hpp:1007
std::string name_
Subcommand name or program name (from parser if name is empty)
Definition App.hpp:109
std::vector< App * > parsed_subcommands_
This is a list of the subcommands collected, in order.
Definition App.hpp:205
bool ignore_underscore_
If true, the program should ignore underscores INHERITABLE.
Definition App.hpp:233
missing_t missing_
Definition App.hpp:199
void run_callback(bool final_mode=false, bool suppress_final_callback=false)
Internal function to run (App) callback, bottom up.
Definition App_inl.hpp:1062
bool allow_prefix_matching_
indicator to allow subcommands to match with prefix matching
Definition App.hpp:275
std::size_t require_subcommand_min_
Minimum required subcommands (not inheritable!)
Definition App.hpp:281
CLI11_NODISCARD NameMatch check_name_detail(std::string name_to_check) const
Definition App_inl.hpp:910
void _process_env()
Get envname options if not yet passed. Runs on all subcommands.
Definition App_inl.hpp:1199
std::function< std::string(const App *, const Error &e)> failure_message_
The error message printing function INHERITABLE.
Definition App.hpp:188
void _parse_stream(std::istream &input)
Internal function to parse a stream.
Definition App_inl.hpp:1499
CLI11_NODISCARD std::string get_display_name(bool with_aliases=false) const
Get a display name for an app.
Definition App_inl.hpp:889
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:125
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:2214
void clear()
Reset the parsed data.
Definition App_inl.hpp:558
App * enabled_by_default(bool enable=true)
Definition App.hpp:432
App * get_subcommand(const App *subcom) const
Definition App_inl.hpp:481
CLI11_NODISCARD std::string version() const
Displays a version string.
Definition App_inl.hpp:793
CLI11_NODISCARD App * get_subcommand_no_throw(std::string subcom) const noexcept
Definition App_inl.hpp:497
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:1518
std::vector< Option_p > options_
The list of options, stored locally.
Definition App.hpp:157
Option * help_all_ptr_
A pointer to the help all flag if there is one INHERITABLE.
Definition App.hpp:179
bool validate_optional_arguments_
If set to true optional vector arguments are validated before assigning INHERITABLE.
Definition App.hpp:265
std::function< void()> final_callback_
This is a function that runs when all processing has completed.
Definition App.hpp:147
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:411
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:434
App * preparse_callback(std::function< void(std::size_t)> pp_callback)
Definition App.hpp:374
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:350
bool positionals_at_end_
specify that positional arguments come at the end of the argument sequence not inheritable
Definition App.hpp:251
void _process()
Process callbacks and such.
Definition App_inl.hpp:1395
bool immediate_callback_
Definition App.hpp:138
bool _parse_single(std::vector< std::string > &args, bool &positional_only)
Definition App_inl.hpp:1673
App * name(std::string app_name="")
Set a name for the app (empty will use parser to set the name)
Definition App_inl.hpp:86
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:2281
void _process_extras()
Throw an error if anything is left over and should not be.
Definition App_inl.hpp:1418
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:1089
bool configurable_
if set to true the subcommand can be triggered via configuration files INHERITABLE
Definition App.hpp:259
CLI11_NODISCARD std::vector< std::string > get_groups() const
Get the groups available directly from this option (in order)
Definition App_inl.hpp:948
void _parse_config(const std::vector< ConfigItem > &args)
Definition App_inl.hpp:1510
std::size_t require_option_max_
Max number of options allowed. 0 is unlimited (not inheritable)
Definition App.hpp:290
std::vector< std::string > aliases_
Alias names for the subcommand.
Definition App.hpp:299
std::set< App * > exclude_subcommands_
this is a list of subcommands that are exclusionary to this one
Definition App.hpp:208
bool _parse_positional(std::vector< std::string > &args, bool haltOnSubcommand)
Definition App_inl.hpp:1737
bool ignore_case_
If true, the program name is not case-sensitive INHERITABLE.
Definition App.hpp:230
CLI11_NODISCARD const std::string & get_group() const
Get the group of this subcommand.
Definition App.hpp:1138
bool _parse_arg(std::vector< std::string > &args, detail::Classifier current_type, bool local_processing_only)
Definition App_inl.hpp:1945
std::function< void(std::size_t)> pre_parse_callback_
This is a function that runs prior to the start of parsing.
Definition App.hpp:141
std::string group_
The group membership INHERITABLE.
Definition App.hpp:296
App * alias(std::string app_name)
Set an alias for the app.
Definition App_inl.hpp:103
bool pre_parse_called_
Flag indicating that the pre_parse_callback has been triggered.
Definition App.hpp:134
void _process_callbacks()
Process callbacks. Runs on all subcommands.
Definition App_inl.hpp:1221
Option * help_ptr_
A pointer to the help flag if there is one INHERITABLE.
Definition App.hpp:176
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:382
App * ignore_case(bool value=true)
Ignore case. Subcommands inherit value.
Definition App_inl.hpp:133
bool remove_excludes(Option *opt)
Removes an option from the excludes list of this subcommand.
Definition App_inl.hpp:741
CLI11_NODISCARD std::vector< App * > get_subcommands() const
Definition App.hpp:938
CLI11_NODISCARD config_extras_mode get_allow_config_extras() const
Get the status of allow extras.
Definition App.hpp:1197
bool _parse_subcommand(std::vector< std::string > &args)
Definition App_inl.hpp:1905
bool fallthrough_
Definition App.hpp:237
std::set< Option * > need_options_
Definition App.hpp:220
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:811
std::set< App * > need_subcommands_
Definition App.hpp:216
bool prefix_command_
If true, cease processing on an unrecognized option (implies allow_extras) INHERITABLE.
Definition App.hpp:122
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:161
std::vector< Option * > parse_order_
This is a list of pointers to options with the original parse order.
Definition App.hpp:202
void _parse(std::vector< std::string > &args)
Internal parse function.
Definition App_inl.hpp:1455
bool validate_positionals_
If set to true positional options are validated before assigning INHERITABLE.
Definition App.hpp:262
bool _parse_single_config(const ConfigItem &item, std::size_t level=0)
Fill in a single config option.
Definition App_inl.hpp:1578
startup_mode default_startup
Definition App.hpp:256
bool allow_extras_
If true, allow extra arguments (ie, don't throw an error). INHERITABLE.
Definition App.hpp:115
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:64
CLI11_NODISCARD App * _find_subcommand(const std::string &subc_name, bool ignore_disabled, bool ignore_used) const noexcept
Definition App_inl.hpp:1869
CLI11_NODISCARD const std::string & get_name() const
Get the name of the current app.
Definition App.hpp:1227
App * disabled(bool disable=true)
Disable the subcommand or option group.
Definition App.hpp:398
std::shared_ptr< FormatterBase > formatter_
This is the formatter for help printing. Default provided. INHERITABLE (same pointer)
Definition App.hpp:185
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:274
bool allow_windows_style_options_
Allow '/' for options for Windows like options. Defaults to true on Windows, false otherwise....
Definition App.hpp:243
std::shared_ptr< Config > config_formatter_
This is the formatter for help printing. Default provided. INHERITABLE (same pointer)
Definition App.hpp:309
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
CLI11_NODISCARD MultiOptionPolicy get_multi_option_policy() const
The status of the multi option policy.
Definition Option.hpp:139
CLI11_NODISCARD bool get_configurable() const
The status of configurable.
Definition Option.hpp:127
bool required_
True if this is a required option.
Definition Option.hpp:60
CLI11_NODISCARD bool get_disable_flag_override() const
The status of configurable.
Definition Option.hpp:130
CLI11_NODISCARD const std::string & get_group() const
Get the group of this option.
Definition Option.hpp:115
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
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:354
@ callback_run
the callback has been executed
std::set< Option * > needs_
A list of options that are required with this option.
Definition Option.hpp:297
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
std::set< Option * > excludes_
A list of options that are excluded with this option.
Definition Option.hpp:300
bool force_callback_
flag indicating that the option should force the callback regardless if any results present
Definition Option.hpp:340
CLI11_NODISCARD bool get_callback_run() const
See if the callback has been run already.
Definition Option.hpp:715
std::vector< std::string > fnames_
a list of flag names with specified default values;
Definition Option.hpp:249
CLI11_NODISCARD int get_items_expected_min() const
The total min number of expected string values to be used.
Definition Option.hpp:576
CLI11_NODISCARD const results_t & results() const
Get the current complete results set.
Definition Option.hpp:671
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:579
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 bool get_inject_separator() const
Return the inject_separator flag.
Definition Option.hpp:529
CLI11_NODISCARD std::string get_flag_value(const std::string &name, std::string input_value) const
Definition Option_inl.hpp:383
CLI11_NODISCARD const std::string & get_description() const
Get the description.
Definition Option.hpp:596
CLI11_NODISCARD bool empty() const
True if the option was not passed.
Definition Option.hpp:364
CLI11_NODISCARD int get_expected_min() const
The number of times the option expects to be included.
Definition Option.hpp:571
void clear()
Clear the parsed results (mostly for testing)
Definition Option.hpp:370
CLI11_NODISCARD int get_expected_max() const
The max number of times the option expects to be included.
Definition Option.hpp:573
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
CLI11_NODISCARD bool get_allow_extra_args() const
Get the current value of allow extra args.
Definition Option.hpp:392
std::vector< std::pair< std::string, std::string > > default_flag_values_
Definition Option.hpp:246
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
std::vector< std::string > inputs
Listing of inputs.
Definition ConfigFwd.hpp:36
std::string name
This is the name.
Definition ConfigFwd.hpp:34
CLI11_NODISCARD std::string fullname() const
The list of parents and name joined by ".".
Definition ConfigFwd.hpp:40
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