CLI11
C++11 Command Line Interface Parser
Loading...
Searching...
No Matches
App_inl.hpp
1// Copyright (c) 2017-2026, University of Cincinnati, developed by Henry Schreiner
2// under NSF AWARD 1414736 and by the respective contributors.
3// All rights reserved.
4//
5// SPDX-License-Identifier: BSD-3-Clause
6
7#pragma once
8
9// IWYU pragma: private, include "CLI/CLI.hpp"
10
11// This include is only needed for IDEs to discover symbols
12#include "../App.hpp"
13
14#include "../Argv.hpp"
15#include "../Encoding.hpp"
16
17// [CLI11:public_includes:set]
18#include <algorithm>
19#include <exception>
20#include <iostream>
21#include <memory>
22#include <string>
23#include <utility>
24#include <vector>
25// [CLI11:public_includes:end]
26
27namespace CLI {
28// [CLI11:app_inl_hpp:verbatim]
29
30CLI11_INLINE App::App(std::string app_description, std::string app_name, App *parent)
31 : name_(std::move(app_name)), description_(std::move(app_description)), parent_(parent) {
32 // Inherit if not from a nullptr
33 if(parent_ != nullptr) {
34 if(parent_->help_ptr_ != nullptr)
36 if(parent_->help_all_ptr_ != nullptr)
38
41
42 // INHERITABLE
62 }
63}
64
65CLI11_NODISCARD CLI11_INLINE char **App::ensure_utf8(char **argv) {
66#ifdef _WIN32
67 (void)argv;
68
69 normalized_argv_ = detail::compute_win32_argv();
70
71 if(!normalized_argv_view_.empty()) {
72 normalized_argv_view_.clear();
73 }
74
75 normalized_argv_view_.reserve(normalized_argv_.size());
76 for(auto &arg : normalized_argv_) {
77 // using const_cast is well-defined, string is known to not be const.
78 normalized_argv_view_.push_back(const_cast<char *>(arg.data()));
79 }
80
81 return normalized_argv_view_.data();
82#else
83 return argv;
84#endif
85}
86
87CLI11_INLINE App *App::name(std::string app_name) {
88
89 if(parent_ != nullptr) {
90 std::string oname = name_;
91 name_ = app_name;
92 const auto &res = _compare_subcommand_names(*this, *_get_fallthrough_parent());
93 if(!res.empty()) {
94 name_ = oname;
95 throw(OptionAlreadyAdded(app_name + " conflicts with existing subcommand names"));
96 }
97 } else {
98 name_ = app_name;
99 }
100 has_automatic_name_ = false;
101 return this;
102}
103
104CLI11_INLINE App *App::alias(std::string app_name) {
105 if(app_name.empty() || !detail::valid_alias_name_string(app_name)) {
106 throw IncorrectConstruction("Aliases may not be empty or contain newlines or null characters");
107 }
108 if(parent_ != nullptr) {
109 aliases_.push_back(app_name);
110 const auto &res = _compare_subcommand_names(*this, *_get_fallthrough_parent());
111 if(!res.empty()) {
112 aliases_.pop_back();
113 throw(OptionAlreadyAdded("alias already matches an existing subcommand: " + app_name));
114 }
115 } else {
116 aliases_.push_back(app_name);
117 }
118
119 return this;
120}
121
122CLI11_INLINE App *App::immediate_callback(bool immediate) {
123 immediate_callback_ = immediate;
127 }
130 }
131 return this;
132}
133
134CLI11_INLINE App *App::ignore_case(bool value) {
135 if(value && !ignore_case_) {
136 ignore_case_ = true;
137 auto *p = (parent_ != nullptr) ? _get_fallthrough_parent() : this;
138 const auto &match = _compare_subcommand_names(*this, *p);
139 if(!match.empty()) {
140 ignore_case_ = false; // we are throwing so need to be exception invariant
141 throw OptionAlreadyAdded("ignore case would cause subcommand name conflicts: " + match);
142 }
143 }
144 ignore_case_ = value;
145 return this;
146}
147
148CLI11_INLINE App *App::ignore_underscore(bool value) {
149 if(value && !ignore_underscore_) {
150 ignore_underscore_ = true;
151 auto *p = (parent_ != nullptr) ? _get_fallthrough_parent() : this;
152 const auto &match = _compare_subcommand_names(*this, *p);
153 if(!match.empty()) {
154 ignore_underscore_ = false;
155 throw OptionAlreadyAdded("ignore underscore would cause subcommand name conflicts: " + match);
156 }
157 }
158 ignore_underscore_ = value;
159 return this;
160}
161
162CLI11_INLINE Option *App::add_option(std::string option_name,
163 callback_t option_callback,
164 std::string option_description,
165 bool defaulted,
166 std::function<std::string()> func) {
167 Option myopt{option_name, option_description, option_callback, this, allow_non_standard_options_};
168
169 // do a quick search in current subcommand for options
170 auto res =
171 std::find_if(std::begin(options_), std::end(options_), [&myopt](const Option_p &v) { return *v == myopt; });
172 if(res != options_.end()) {
173 const auto &matchname = (*res)->matching_name(myopt);
174 throw(OptionAlreadyAdded("added option matched existing option name: " + matchname));
175 }
177 const App *top_level_parent = this;
178 while(top_level_parent->name_.empty() && top_level_parent->parent_ != nullptr) {
179 top_level_parent = top_level_parent->parent_;
180 }
181
182 if(myopt.lnames_.empty() && myopt.snames_.empty()) {
183 // if the option is positional only there is additional potential for ambiguities in config files and needs
184 // to be checked
185 std::string test_name = "--" + myopt.get_single_name();
186 if(test_name.size() == 3) {
187 test_name.erase(0, 1);
188 }
189 // if we are in option group
190 const auto *op = top_level_parent->get_option_no_throw(test_name);
191 if(op != nullptr && op->get_configurable()) {
192 throw(OptionAlreadyAdded("added option positional name matches existing option: " + test_name));
193 }
194 // need to check if there is another positional with the same name that also doesn't have any long or
195 // short names
196 op = top_level_parent->get_option_no_throw(myopt.get_single_name());
197 if(op != nullptr && op->lnames_.empty() && op->snames_.empty()) {
198 throw(OptionAlreadyAdded("unable to disambiguate with existing option: " + test_name));
199 }
200 } else if(top_level_parent != this) {
201 for(auto &ln : myopt.lnames_) {
202 const auto *op = top_level_parent->get_option_no_throw(ln);
203 if(op != nullptr && op->get_configurable()) {
204 throw(OptionAlreadyAdded("added option matches existing positional option: " + ln));
205 }
206 op = top_level_parent->get_option_no_throw("--" + ln);
207 if(op != nullptr && op->get_configurable()) {
208 throw(OptionAlreadyAdded("added option matches existing option: --" + ln));
209 }
210 if(ln.size() == 1 || top_level_parent->get_allow_non_standard_option_names()) {
211 op = top_level_parent->get_option_no_throw("-" + ln);
212 if(op != nullptr && op->get_configurable()) {
213 throw(OptionAlreadyAdded("added option matches existing option: -" + ln));
214 }
215 }
216 }
217 for(auto &sn : myopt.snames_) {
218 const auto *op = top_level_parent->get_option_no_throw(sn);
219 if(op != nullptr && op->get_configurable()) {
220 throw(OptionAlreadyAdded("added option matches existing positional option: " + sn));
221 }
222 op = top_level_parent->get_option_no_throw("-" + sn);
223 if(op != nullptr && op->get_configurable()) {
224 throw(OptionAlreadyAdded("added option matches existing option: -" + sn));
225 }
226 op = top_level_parent->get_option_no_throw("--" + sn);
227 if(op != nullptr && op->get_configurable()) {
228 throw(OptionAlreadyAdded("added option matches existing option: --" + sn));
229 }
230 }
231 }
232 if(allow_non_standard_options_ && !myopt.snames_.empty()) {
233
234 for(auto &sname : myopt.snames_) {
235 if(sname.length() > 1) {
236 std::string test_name;
237 test_name.push_back('-');
238 test_name.push_back(sname.front());
239 const auto *op = top_level_parent->get_option_no_throw(test_name);
240 if(op != nullptr) {
241 throw(OptionAlreadyAdded("added option interferes with existing short option: " + sname));
242 }
243 }
244 }
245 for(auto &opt : top_level_parent->get_options()) {
246 for(const auto &osn : opt->snames_) {
247 if(osn.size() > 1) {
248 std::string test_name;
249 test_name.push_back(osn.front());
250 if(myopt.check_sname(test_name)) {
251 throw(OptionAlreadyAdded("added option interferes with existing non standard option: " + osn));
252 }
253 }
254 }
255 }
256 }
257 options_.emplace_back();
258 Option_p &option = options_.back();
259 option.reset(new Option(option_name, option_description, option_callback, this, allow_non_standard_options_));
260
261 // Set the default string capture function
262 option->default_function(func);
263
264 // For compatibility with CLI11 1.7 and before, capture the default string here
265 if(defaulted)
266 option->capture_default_str();
267
268 // Transfer defaults to the new option
269 option_defaults_.copy_to(option.get());
270
271 // Don't bother to capture if we already did
272 if(!defaulted && option->get_always_capture_default())
273 option->capture_default_str();
274
275 return option.get();
276}
277
278CLI11_INLINE Option *App::set_help_flag(std::string flag_name, const std::string &help_description) {
279 // take flag_description by const reference otherwise add_flag tries to assign to help_description
280 if(help_ptr_ != nullptr) {
282 help_ptr_ = nullptr;
283 }
284
285 // Empty name will simply remove the help flag
286 if(!flag_name.empty()) {
287 help_ptr_ = add_flag(flag_name, help_description);
288 help_ptr_->configurable(false)->callback_priority(CallbackPriority::First);
289 }
290
291 return help_ptr_;
292}
293
294CLI11_INLINE Option *App::set_help_all_flag(std::string help_name, const std::string &help_description) {
295 // take flag_description by const reference otherwise add_flag tries to assign to flag_description
296 if(help_all_ptr_ != nullptr) {
298 help_all_ptr_ = nullptr;
299 }
300
301 // Empty name will simply remove the help all flag
302 if(!help_name.empty()) {
303 help_all_ptr_ = add_flag(help_name, help_description);
304 help_all_ptr_->configurable(false)->callback_priority(CallbackPriority::First);
305 }
306
307 return help_all_ptr_;
308}
309
310CLI11_INLINE Option *
311App::set_version_flag(std::string flag_name, const std::string &versionString, const std::string &version_help) {
312 // take flag_description by const reference otherwise add_flag tries to assign to version_description
313 if(version_ptr_ != nullptr) {
315 version_ptr_ = nullptr;
316 }
317
318 // Empty name will simply remove the version flag
319 if(!flag_name.empty()) {
321 flag_name, [versionString]() { throw(CLI::CallForVersion(versionString, 0)); }, version_help);
322 version_ptr_->configurable(false)->callback_priority(CallbackPriority::First);
323 }
324
325 return version_ptr_;
326}
327
328CLI11_INLINE Option *
329App::set_version_flag(std::string flag_name, std::function<std::string()> vfunc, const std::string &version_help) {
330 if(version_ptr_ != nullptr) {
332 version_ptr_ = nullptr;
333 }
334
335 // Empty name will simply remove the version flag
336 if(!flag_name.empty()) {
338 add_flag_callback(flag_name, [vfunc]() { throw(CLI::CallForVersion(vfunc(), 0)); }, version_help);
339 version_ptr_->configurable(false)->callback_priority(CallbackPriority::First);
340 }
341
342 return version_ptr_;
343}
344
345CLI11_INLINE Option *App::_add_flag_internal(std::string flag_name, CLI::callback_t fun, std::string flag_description) {
346 Option *opt = nullptr;
347 if(detail::has_default_flag_values(flag_name)) {
348 // check for default values and if it has them
349 auto flag_defaults = detail::get_default_flag_values(flag_name);
350 detail::remove_default_flag_values(flag_name);
351 opt = add_option(std::move(flag_name), std::move(fun), std::move(flag_description), false);
352 for(const auto &fname : flag_defaults)
353 opt->fnames_.push_back(fname.first);
354 opt->default_flag_values_ = std::move(flag_defaults);
355 } else {
356 opt = add_option(std::move(flag_name), std::move(fun), std::move(flag_description), false);
357 }
358 // flags cannot have positional values
359 if(opt->get_positional()) {
360 auto pos_name = opt->get_name(true);
361 remove_option(opt);
362 throw IncorrectConstruction::PositionalFlag(pos_name);
363 }
364 opt->multi_option_policy(MultiOptionPolicy::TakeLast);
365 opt->expected(0);
366 opt->required(false);
367 return opt;
368}
369
370CLI11_INLINE Option *App::add_flag_callback(std::string flag_name,
371 std::function<void(void)> function,
372 std::string flag_description) {
373
374 CLI::callback_t fun = [function](const CLI::results_t &res) {
375 using CLI::detail::lexical_cast;
376 bool trigger{false};
377 auto result = lexical_cast(res[0], trigger);
378 if(result && trigger) {
379 function();
380 }
381 return result;
382 };
383 return _add_flag_internal(flag_name, std::move(fun), std::move(flag_description));
384}
385
386CLI11_INLINE Option *
387App::add_flag_function(std::string flag_name,
388 std::function<void(std::int64_t)> function,
389 std::string flag_description) {
390
391 CLI::callback_t fun = [function](const CLI::results_t &res) {
392 using CLI::detail::lexical_cast;
393 std::int64_t flag_count{0};
394 lexical_cast(res[0], flag_count);
395 function(flag_count);
396 return true;
397 };
398 return _add_flag_internal(flag_name, std::move(fun), std::move(flag_description))
399 ->multi_option_policy(MultiOptionPolicy::Sum);
400}
401
402CLI11_INLINE Option *App::set_config(std::string option_name,
403 std::string default_filename,
404 const std::string &help_message,
405 bool config_required) {
406
407 // Remove existing config if present
408 if(config_ptr_ != nullptr) {
410 config_ptr_ = nullptr; // need to remove the config_ptr completely
411 }
412
413 // Only add config if option passed
414 if(!option_name.empty()) {
415 config_ptr_ = add_option(option_name, help_message);
416 if(config_required) {
418 }
419 if(!default_filename.empty()) {
420 config_ptr_->default_str(std::move(default_filename));
422 }
424 // set the option to take the last value and reverse given by default
425 config_ptr_->multi_option_policy(MultiOptionPolicy::Reverse);
426 }
427
428 return config_ptr_;
429}
430
431CLI11_INLINE bool App::remove_option(Option *opt) {
432 // Make sure no links exist
433 for(Option_p &op : options_) {
434 op->remove_needs(opt);
435 op->remove_excludes(opt);
436 }
437
438 if(help_ptr_ == opt)
439 help_ptr_ = nullptr;
440 if(help_all_ptr_ == opt)
441 help_all_ptr_ = nullptr;
442 if(config_ptr_ == opt)
443 config_ptr_ = nullptr;
444
445 auto iterator =
446 std::find_if(std::begin(options_), std::end(options_), [opt](const Option_p &v) { return v.get() == opt; });
447 if(iterator != std::end(options_)) {
448 options_.erase(iterator);
449 return true;
450 }
451 return false;
452}
453
454CLI11_INLINE App *App::add_subcommand(std::string subcommand_name, std::string subcommand_description) {
455 if(!subcommand_name.empty() && !detail::valid_name_string(subcommand_name)) {
456 if(!detail::valid_first_char(subcommand_name[0])) {
458 "Subcommand name starts with invalid character, '!' and '-' and control characters");
459 }
460 for(auto c : subcommand_name) {
461 if(!detail::valid_later_char(c)) {
462 throw IncorrectConstruction(std::string("Subcommand name contains invalid character ('") + c +
463 "'), all characters are allowed except"
464 "'=',':','{','}', ' ', and control characters");
465 }
466 }
467 }
468 CLI::App_p subcom = std::shared_ptr<App>(new App(std::move(subcommand_description), subcommand_name, this));
469 return add_subcommand(std::move(subcom));
470}
471
472CLI11_INLINE App *App::add_subcommand(CLI::App_p subcom) {
473 if(!subcom)
474 throw IncorrectConstruction("passed App is not valid");
475 auto *ckapp = (name_.empty() && parent_ != nullptr) ? _get_fallthrough_parent() : this;
476 const auto &mstrg = _compare_subcommand_names(*subcom, *ckapp);
477 if(!mstrg.empty()) {
478 throw(OptionAlreadyAdded("subcommand name or alias matches existing subcommand: " + mstrg));
479 }
480 subcom->parent_ = this;
481 subcommands_.push_back(std::move(subcom));
482 return subcommands_.back().get();
483}
484
485CLI11_INLINE bool App::remove_subcommand(App *subcom) {
486 // Make sure no links exist
487 for(App_p &sub : subcommands_) {
488 sub->remove_excludes(subcom);
489 sub->remove_needs(subcom);
490 }
491
492 auto iterator = std::find_if(
493 std::begin(subcommands_), std::end(subcommands_), [subcom](const App_p &v) { return v.get() == subcom; });
494 if(iterator != std::end(subcommands_)) {
495 subcommands_.erase(iterator);
496 return true;
497 }
498 return false;
499}
500
501CLI11_INLINE App *App::get_subcommand(const App *subcom) const {
502 if(subcom == nullptr)
503 throw OptionNotFound("nullptr passed");
504 for(const App_p &subcomptr : subcommands_)
505 if(subcomptr.get() == subcom)
506 return subcomptr.get();
507 throw OptionNotFound(subcom->get_name());
508}
509
510CLI11_NODISCARD CLI11_INLINE App *App::get_subcommand(std::string subcom) const {
511 auto *subc = _find_subcommand(subcom, false, false);
512 if(subc == nullptr)
513 throw OptionNotFound(subcom);
514 return subc;
515}
516
517CLI11_NODISCARD CLI11_INLINE App *App::get_subcommand_no_throw(std::string subcom) const noexcept {
518 return _find_subcommand(subcom, false, false);
519}
520
521CLI11_NODISCARD CLI11_INLINE App *App::get_subcommand(int index) const {
522 if(index >= 0) {
523 auto uindex = static_cast<unsigned>(index);
524 if(uindex < subcommands_.size())
525 return subcommands_[uindex].get();
526 }
527 throw OptionNotFound(std::to_string(index));
528}
529
530CLI11_INLINE CLI::App_p App::get_subcommand_ptr(App *subcom) const {
531 if(subcom == nullptr)
532 throw OptionNotFound("nullptr passed");
533 for(const App_p &subcomptr : subcommands_)
534 if(subcomptr.get() == subcom)
535 return subcomptr;
536 throw OptionNotFound(subcom->get_name());
537}
538
539CLI11_NODISCARD CLI11_INLINE CLI::App_p App::get_subcommand_ptr(std::string subcom) const {
540 for(const App_p &subcomptr : subcommands_)
541 if(subcomptr->check_name(subcom))
542 return subcomptr;
543 throw OptionNotFound(subcom);
544}
545
546CLI11_NODISCARD CLI11_INLINE CLI::App_p App::get_subcommand_ptr(int index) const {
547 if(index >= 0) {
548 auto uindex = static_cast<unsigned>(index);
549 if(uindex < subcommands_.size())
550 return subcommands_[uindex];
551 }
552 throw OptionNotFound(std::to_string(index));
553}
554
555CLI11_NODISCARD CLI11_INLINE CLI::App *App::get_option_group(std::string group_name) const {
556 for(const App_p &app : subcommands_) {
557 if(app->name_.empty() && app->group_ == group_name) {
558 return app.get();
559 }
560 }
561 throw OptionNotFound(group_name);
562}
563
564CLI11_NODISCARD CLI11_INLINE std::size_t App::count_all() const {
565 std::size_t cnt{0};
566 for(const auto &opt : options_) {
567 cnt += opt->count();
568 }
569 for(const auto &sub : subcommands_) {
570 cnt += sub->count_all();
571 }
572 if(!get_name().empty()) { // for named subcommands add the number of times the subcommand was called
573 cnt += parsed_;
574 }
575 return cnt;
576}
577
578CLI11_INLINE void App::clear() {
579
580 parsed_ = 0;
581 pre_parse_called_ = false;
582
583 missing_.clear();
585 parse_order_.clear();
586 for(const Option_p &opt : options_) {
587 opt->clear();
588 }
589 for(const App_p &subc : subcommands_) {
590 subc->clear();
591 }
592}
593
594CLI11_INLINE void App::parse(int argc, const char *const *argv) { parse_char_t(argc, argv); }
595CLI11_INLINE void App::parse(int argc, const wchar_t *const *argv) { parse_char_t(argc, argv); }
596
597namespace detail {
598
599// Do nothing or perform narrowing
600CLI11_INLINE const char *maybe_narrow(const char *str) { return str; }
601CLI11_INLINE std::string maybe_narrow(const wchar_t *str) { return narrow(str); }
602
603} // namespace detail
604
605template <class CharT> CLI11_INLINE void App::parse_char_t(int argc, const CharT *const *argv) {
606 // If the name is not set, read from command line
607 if(name_.empty() || has_automatic_name_) {
608 has_automatic_name_ = true;
609 name_ = detail::maybe_narrow(argv[0]);
610 }
611
612 std::vector<std::string> args;
613 args.reserve(static_cast<std::size_t>(argc) - 1U);
614 for(auto i = static_cast<std::size_t>(argc) - 1U; i > 0U; --i)
615 args.emplace_back(detail::maybe_narrow(argv[i]));
616
617 parse(std::move(args));
618}
619
620CLI11_INLINE void App::parse(std::string commandline, bool program_name_included) {
621
622 if(program_name_included) {
623 auto nstr = detail::split_program_name(commandline);
624 if((name_.empty()) || (has_automatic_name_)) {
625 has_automatic_name_ = true;
626 name_ = nstr.first;
627 }
628 commandline = std::move(nstr.second);
629 } else {
630 detail::trim(commandline);
631 }
632 // the next section of code is to deal with quoted arguments after an '=' or ':' for windows like operations
633 if(!commandline.empty()) {
634 commandline = detail::find_and_modify(commandline, "=", detail::escape_detect);
636 commandline = detail::find_and_modify(commandline, ":", detail::escape_detect);
637 }
638
639 auto args = detail::split_up(std::move(commandline));
640 // remove all empty strings
641 args.erase(std::remove(args.begin(), args.end(), std::string{}), args.end());
642 try {
643 detail::remove_quotes(args);
644 } catch(const std::invalid_argument &arg) {
645 throw CLI::ParseError(arg.what(), CLI::ExitCodes::InvalidError);
646 }
647 std::reverse(args.begin(), args.end());
648 parse(std::move(args));
649}
650
651CLI11_INLINE void App::parse(std::wstring commandline, bool program_name_included) {
652 parse(narrow(commandline), program_name_included);
653}
654
655CLI11_INLINE void App::parse(std::vector<std::string> &args) {
656 // Clear if parsed
657 if(parsed_ > 0)
658 clear();
659
660 // parsed_ is incremented in commands/subcommands,
661 // but placed here to make sure this is cleared when
662 // running parse after an error is thrown, even by _validate or _configure.
663 parsed_ = 1;
664 _validate();
665 _configure();
666 // set the parent as nullptr as this object should be the top now
667 parent_ = nullptr;
668 parsed_ = 0;
669
670 _parse(args);
671 run_callback();
672}
673
674CLI11_INLINE void App::parse(std::vector<std::string> &&args) {
675 // Clear if parsed
676 if(parsed_ > 0)
677 clear();
678
679 // parsed_ is incremented in commands/subcommands,
680 // but placed here to make sure this is cleared when
681 // running parse after an error is thrown, even by _validate or _configure.
682 parsed_ = 1;
683 _validate();
684 _configure();
685 // set the parent as nullptr as this object should be the top now
686 parent_ = nullptr;
687 parsed_ = 0;
688
689 _parse(std::move(args));
690 run_callback();
691}
692
693CLI11_INLINE void App::parse_from_stream(std::istream &input) {
694 if(parsed_ == 0) {
695 _validate();
696 _configure();
697 // set the parent as nullptr as this object should be the top now
698 }
699
700 _parse_stream(input);
701 run_callback();
702}
703
704CLI11_INLINE int App::exit(const Error &e, std::ostream &out, std::ostream &err) const {
705
707 if(e.get_name() == "RuntimeError")
708 return e.get_exit_code();
709
710 if(e.get_name() == "CallForHelp") {
711 out << help();
712 return e.get_exit_code();
713 }
714
715 if(e.get_name() == "CallForAllHelp") {
716 out << help("", AppFormatMode::All);
717 return e.get_exit_code();
718 }
719
720 if(e.get_name() == "CallForVersion") {
721 out << e.what() << '\n';
722 return e.get_exit_code();
723 }
724
725 if(e.get_exit_code() != static_cast<int>(ExitCodes::Success)) {
727 err << failure_message_(this, e) << std::flush;
728 }
729
730 return e.get_exit_code();
731}
732
733CLI11_INLINE std::vector<const App *> App::get_subcommands(const std::function<bool(const App *)> &filter) const {
734 std::vector<const App *> subcomms(subcommands_.size());
735 std::transform(
736 std::begin(subcommands_), std::end(subcommands_), std::begin(subcomms), [](const App_p &v) { return v.get(); });
737
738 if(filter) {
739 subcomms.erase(std::remove_if(std::begin(subcomms),
740 std::end(subcomms),
741 [&filter](const App *app) { return !filter(app); }),
742 std::end(subcomms));
743 }
744
745 return subcomms;
746}
747
748CLI11_INLINE std::vector<App *> App::get_subcommands(const std::function<bool(App *)> &filter) {
749 std::vector<App *> subcomms(subcommands_.size());
750 std::transform(
751 std::begin(subcommands_), std::end(subcommands_), std::begin(subcomms), [](const App_p &v) { return v.get(); });
752
753 if(filter) {
754 subcomms.erase(
755 std::remove_if(std::begin(subcomms), std::end(subcomms), [&filter](App *app) { return !filter(app); }),
756 std::end(subcomms));
757 }
758
759 return subcomms;
760}
761
762CLI11_INLINE bool App::remove_excludes(Option *opt) {
763 auto iterator = std::find(std::begin(exclude_options_), std::end(exclude_options_), opt);
764 if(iterator == std::end(exclude_options_)) {
765 return false;
766 }
767 exclude_options_.erase(iterator);
768 return true;
769}
770
771CLI11_INLINE bool App::remove_excludes(App *app) {
772 auto iterator = std::find(std::begin(exclude_subcommands_), std::end(exclude_subcommands_), app);
773 if(iterator == std::end(exclude_subcommands_)) {
774 return false;
775 }
776 auto *other_app = *iterator;
777 exclude_subcommands_.erase(iterator);
778 other_app->remove_excludes(this);
779 return true;
780}
781
782CLI11_INLINE bool App::remove_needs(Option *opt) {
783 auto iterator = std::find(std::begin(need_options_), std::end(need_options_), opt);
784 if(iterator == std::end(need_options_)) {
785 return false;
786 }
787 need_options_.erase(iterator);
788 return true;
789}
790
791CLI11_INLINE bool App::remove_needs(App *app) {
792 auto iterator = std::find(std::begin(need_subcommands_), std::end(need_subcommands_), app);
793 if(iterator == std::end(need_subcommands_)) {
794 return false;
796 need_subcommands_.erase(iterator);
797 return true;
799
800CLI11_NODISCARD CLI11_INLINE std::string App::help(std::string prev, AppFormatMode mode) const {
801 if(prev.empty())
802 prev = get_name();
803 else
804 prev += " " + get_name();
805
806 // Delegate to subcommand if needed
807 auto selected_subcommands = get_subcommands();
808 if(!selected_subcommands.empty()) {
809 return selected_subcommands.back()->help(prev, mode);
810 }
811 return formatter_->make_help(this, prev, mode);
812}
813
814CLI11_NODISCARD CLI11_INLINE std::string App::version() const {
815 std::string val;
816 if(version_ptr_ != nullptr) {
817 // copy the results for reuse later
818 results_t rv = version_ptr_->results();
820 version_ptr_->add_result("true");
821 try {
823 } catch(const CLI::CallForVersion &cfv) {
824 val = cfv.what();
825 }
828 }
829 return val;
830}
831
832CLI11_INLINE std::vector<const Option *> App::get_options(const std::function<bool(const Option *)> filter) const {
833 std::vector<const Option *> options(options_.size());
834 std::transform(
835 std::begin(options_), std::end(options_), std::begin(options), [](const Option_p &val) { return val.get(); });
836
837 if(filter) {
838 options.erase(std::remove_if(std::begin(options),
839 std::end(options),
840 [&filter](const Option *opt) { return !filter(opt); }),
841 std::end(options));
842 }
843 for(const auto &subcp : subcommands_) {
844 // also check down into nameless subcommands
845 const App *subc = subcp.get();
846 if(subc->get_name().empty() && !subc->get_group().empty() && subc->get_group().front() == '+') {
847 std::vector<const Option *> subcopts = subc->get_options(filter);
848 options.insert(options.end(), subcopts.begin(), subcopts.end());
849 }
850 }
851 if(fallthrough_ && parent_ != nullptr && !name_.empty()) {
852 const auto *fallthrough_parent = _get_fallthrough_parent();
853 std::vector<const Option *> subcopts = fallthrough_parent->get_options(filter);
854 for(const auto *opt : subcopts) {
855 if(std::find_if(options.begin(), options.end(), [opt](const Option *opt2) {
856 return opt->check_name(opt2->get_name());
857 }) == options.end()) {
858 options.push_back(opt);
859 }
860 }
861 }
862 return options;
863}
864
865CLI11_INLINE std::vector<Option *> App::get_options(const std::function<bool(Option *)> filter) {
866 std::vector<Option *> options(options_.size());
867 std::transform(
868 std::begin(options_), std::end(options_), std::begin(options), [](const Option_p &val) { return val.get(); });
869
870 if(filter) {
871 options.erase(
872 std::remove_if(std::begin(options), std::end(options), [&filter](Option *opt) { return !filter(opt); }),
873 std::end(options));
874 }
875 for(auto &subc : subcommands_) {
876 // also check down into nameless subcommands and specific groups
877 if(subc->get_name().empty() || (!subc->get_group().empty() && subc->get_group().front() == '+')) {
878 auto subcopts = subc->get_options(filter);
879 options.insert(options.end(), subcopts.begin(), subcopts.end());
880 }
881 }
882 if(fallthrough_ && parent_ != nullptr && !name_.empty()) {
883 auto *fallthrough_parent = _get_fallthrough_parent();
884 std::vector<Option *> subcopts = fallthrough_parent->get_options(filter);
885 for(auto *opt : subcopts) {
886 if(std::find_if(options.begin(), options.end(), [opt](Option *opt2) {
887 return opt->check_name(opt2->get_name());
888 }) == options.end()) {
889 options.push_back(opt);
890 }
891 }
892 }
893 return options;
894}
895
897CLI11_NODISCARD CLI11_INLINE const Option *App::get_option(std::string option_name) const {
898 const auto *opt = get_option_no_throw(option_name);
899 if(opt == nullptr) {
900 if(fallthrough_ && parent_ != nullptr && name_.empty()) {
901 // as a special case option groups with fallthrough enabled can also check the parent for options if the
902 // option is not found in the group this will not recurse as the internal call is to the no_throw version
903 // which will not check the parent again for option groups even with fallthrough enabled
904 return _get_fallthrough_parent()->get_option(option_name);
905 }
906 throw OptionNotFound(option_name);
907 }
908 return opt;
909}
910
912CLI11_NODISCARD CLI11_INLINE Option *App::get_option(std::string option_name) {
913 auto *opt = get_option_no_throw(option_name);
914 if(opt == nullptr) {
915 if(fallthrough_ && parent_ != nullptr && name_.empty()) {
916 // as a special case option groups with fallthrough enabled can also check the parent for options if the
917 // option is not found in the group this will not recurse as the internal call is to the no_throw version
918 // which will not check the parent again for option groups even with fallthrough enabled
919 return _get_fallthrough_parent()->get_option(option_name);
920 }
921 throw OptionNotFound(option_name);
922 }
923 return opt;
924}
925
926CLI11_NODISCARD CLI11_INLINE Option *App::get_option_no_throw(std::string option_name) noexcept {
927 for(Option_p &opt : options_) {
928 if(opt->check_name(option_name)) {
929 return opt.get();
930 }
931 }
932 for(auto &subc : subcommands_) {
933 // also check down into nameless subcommands
934 if(subc->get_name().empty()) {
935 auto *opt = subc->get_option_no_throw(option_name);
936 if(opt != nullptr) {
937 return opt;
938 }
939 }
940 }
941 if(fallthrough_ && parent_ != nullptr && !name_.empty()) {
942 // if there is fallthrough and a parent and this is not an option_group then also check the parent for the
943 // option
944 return _get_fallthrough_parent()->get_option_no_throw(option_name);
945 }
946 return nullptr;
947}
948
949CLI11_NODISCARD CLI11_INLINE const Option *App::get_option_no_throw(std::string option_name) const noexcept {
950 for(const Option_p &opt : options_) {
951 if(opt->check_name(option_name)) {
952 return opt.get();
953 }
954 }
955 for(const auto &subc : subcommands_) {
956 // also check down into nameless subcommands
957 if(subc->get_name().empty()) {
958 auto *opt = subc->get_option_no_throw(option_name);
959 if(opt != nullptr) {
960 return opt;
961 }
962 }
963 }
964 if(fallthrough_ && parent_ != nullptr && !name_.empty()) {
965 return _get_fallthrough_parent()->get_option_no_throw(option_name);
966 }
967 return nullptr;
968}
969
970CLI11_NODISCARD CLI11_INLINE std::string App::get_display_name(bool with_aliases) const {
971 if(name_.empty()) {
972 return std::string("[Option Group: ") + get_group() + "]";
973 }
974 if(aliases_.empty() || !with_aliases) {
975 return name_;
976 }
977 std::string dispname = name_;
978 for(const auto &lalias : aliases_) {
979 dispname.push_back(',');
980 dispname.push_back(' ');
981 dispname.append(lalias);
982 }
983 return dispname;
984}
985
986CLI11_NODISCARD CLI11_INLINE bool App::check_name(std::string name_to_check) const {
987 auto result = check_name_detail(std::move(name_to_check));
988 return (result != NameMatch::none);
989}
990
991CLI11_NODISCARD CLI11_INLINE App::NameMatch App::check_name_detail(std::string name_to_check) const {
992 std::string local_name = name_;
994 local_name = detail::remove_underscore(name_);
995 name_to_check = detail::remove_underscore(name_to_check);
996 }
997 if(ignore_case_) {
998 local_name = detail::to_lower(name_);
999 name_to_check = detail::to_lower(name_to_check);
1000 }
1001
1002 if(local_name == name_to_check) {
1003 return App::NameMatch::exact;
1004 }
1005 if(allow_prefix_matching_ && name_to_check.size() < local_name.size()) {
1006 if(local_name.compare(0, name_to_check.size(), name_to_check) == 0) {
1007 return App::NameMatch::prefix;
1008 }
1009 }
1010 for(std::string les : aliases_) { // NOLINT(performance-for-range-copy)
1011 if(ignore_underscore_) {
1012 les = detail::remove_underscore(les);
1013 }
1014 if(ignore_case_) {
1015 les = detail::to_lower(les);
1016 }
1017 if(les == name_to_check) {
1018 return App::NameMatch::exact;
1019 }
1020 if(allow_prefix_matching_ && name_to_check.size() < les.size()) {
1021 if(les.compare(0, name_to_check.size(), name_to_check) == 0) {
1022 return App::NameMatch::prefix;
1023 }
1024 }
1025 }
1026 return App::NameMatch::none;
1027}
1028
1029CLI11_NODISCARD CLI11_INLINE std::vector<std::string> App::get_groups() const {
1030 std::vector<std::string> groups;
1031
1032 for(const Option_p &opt : options_) {
1033 // Add group if it is not already in there
1034 if(std::find(groups.begin(), groups.end(), opt->get_group()) == groups.end()) {
1035 groups.push_back(opt->get_group());
1036 }
1037 }
1038
1039 return groups;
1040}
1041
1042CLI11_NODISCARD CLI11_INLINE std::vector<std::string> App::remaining(bool recurse) const {
1043 std::vector<std::string> miss_list;
1044 for(const std::pair<detail::Classifier, std::string> &miss : missing_) {
1045 miss_list.push_back(std::get<1>(miss));
1046 }
1047 // Get from a subcommand that may allow extras
1048 if(recurse) {
1049 if(allow_extras_ == ExtrasMode::Error || allow_extras_ == ExtrasMode::Ignore) {
1050 for(const auto &sub : subcommands_) {
1051 if(sub->name_.empty() && !sub->missing_.empty()) {
1052 for(const std::pair<detail::Classifier, std::string> &miss : sub->missing_) {
1053 miss_list.push_back(std::get<1>(miss));
1054 }
1055 }
1056 }
1057 }
1058 // Recurse into subcommands
1059
1060 for(const App *sub : parsed_subcommands_) {
1061 std::vector<std::string> output = sub->remaining(recurse);
1062 std::copy(std::begin(output), std::end(output), std::back_inserter(miss_list));
1063 }
1064 }
1065 return miss_list;
1066}
1067
1068CLI11_NODISCARD CLI11_INLINE std::vector<std::string> App::remaining_for_passthrough(bool recurse) const {
1069 std::vector<std::string> miss_list = remaining(recurse);
1070 std::reverse(std::begin(miss_list), std::end(miss_list));
1071 return miss_list;
1072}
1073
1074CLI11_NODISCARD CLI11_INLINE std::size_t App::remaining_size(bool recurse) const {
1075 auto remaining_options = static_cast<std::size_t>(std::count_if(
1076 std::begin(missing_), std::end(missing_), [](const std::pair<detail::Classifier, std::string> &val) {
1077 return val.first != detail::Classifier::POSITIONAL_MARK;
1078 }));
1079
1080 if(recurse) {
1081 for(const App_p &sub : subcommands_) {
1082 remaining_options += sub->remaining_size(recurse);
1083 }
1084 }
1085 return remaining_options;
1086}
1087
1088CLI11_INLINE void App::_validate() const {
1089 // count the number of positional only args
1090 auto pcount = std::count_if(std::begin(options_), std::end(options_), [](const Option_p &opt) {
1091 return opt->get_items_expected_max() >= detail::expected_max_vector_size && !opt->nonpositional();
1092 });
1093 if(pcount > 1) {
1094 auto pcount_req = std::count_if(std::begin(options_), std::end(options_), [](const Option_p &opt) {
1095 return opt->get_items_expected_max() >= detail::expected_max_vector_size && !opt->nonpositional() &&
1096 opt->get_required();
1097 });
1098 if(pcount - pcount_req > 1) {
1099 throw InvalidError(name_);
1100 }
1101 }
1102
1103 std::size_t nameless_subs{0};
1104 for(const App_p &app : subcommands_) {
1105 app->_validate();
1106 if(app->get_name().empty())
1107 ++nameless_subs;
1108 }
1109
1110 if(require_option_min_ > 0) {
1111 if(require_option_max_ > 0) {
1113 throw(InvalidError("Required min options greater than required max options", ExitCodes::InvalidError));
1114 }
1115 }
1116 if(require_option_min_ > (options_.size() + nameless_subs)) {
1117 throw(
1118 InvalidError("Required min options greater than number of available options", ExitCodes::InvalidError));
1119 }
1120 }
1121}
1122
1123CLI11_INLINE void App::_configure() {
1124 if(default_startup == startup_mode::enabled) {
1125 disabled_ = false;
1126 } else if(default_startup == startup_mode::disabled) {
1127 disabled_ = true;
1128 }
1129 for(const App_p &app : subcommands_) {
1130 if(app->has_automatic_name_) {
1131 app->name_.clear();
1132 }
1133 if(app->name_.empty()) {
1134 app->fallthrough_ = false; // make sure fallthrough_ is false to prevent infinite loop
1135 app->prefix_command_ = PrefixCommandMode::Off;
1136 }
1137 // make sure the parent is set to be this object in preparation for parse
1138 app->parent_ = this;
1139 app->_configure();
1140 }
1141}
1142
1143CLI11_INLINE void App::run_callback(bool final_mode, bool suppress_final_callback) {
1144 pre_callback();
1145 // in the main app if immediate_callback_ is set it runs the main callback before the used subcommands
1146 if(!final_mode && parse_complete_callback_) {
1148 }
1149 // run the callbacks for the received subcommands
1150 for(App *subc : get_subcommands()) {
1151 if(subc->parent_ == this) {
1152 subc->run_callback(true, suppress_final_callback);
1153 }
1154 }
1155 // now run callbacks for option_groups
1156 for(auto &subc : subcommands_) {
1157 if(subc->name_.empty() && subc->count_all() > 0) {
1158 subc->run_callback(true, suppress_final_callback);
1159 }
1160 }
1161
1162 // finally run the main callback
1163 if(final_callback_ && (parsed_ > 0) && (!suppress_final_callback)) {
1164 if(!name_.empty() || count_all() > 0 || parent_ == nullptr) {
1166 }
1167 }
1168}
1169
1170CLI11_NODISCARD CLI11_INLINE bool App::_valid_subcommand(const std::string &current, bool ignore_used) const {
1171 // Don't match if max has been reached - but still check parents
1174 return parent_ != nullptr && parent_->_valid_subcommand(current, ignore_used);
1175 }
1176 auto *com = _find_subcommand(current, true, ignore_used);
1177 if(com != nullptr) {
1178 return true;
1179 }
1180 // Check parent if exists, else return false
1182 return parent_ != nullptr && parent_->_valid_subcommand(current, ignore_used);
1183 }
1184 return false;
1185}
1186
1187CLI11_NODISCARD CLI11_INLINE detail::Classifier App::_recognize(const std::string &current,
1188 bool ignore_used_subcommands) const {
1189 std::string dummy1, dummy2;
1190
1191 if(current == "--")
1192 return detail::Classifier::POSITIONAL_MARK;
1193 if(_valid_subcommand(current, ignore_used_subcommands))
1194 return detail::Classifier::SUBCOMMAND;
1195 if(detail::split_long(current, dummy1, dummy2))
1196 return detail::Classifier::LONG;
1197 if(detail::split_short(current, dummy1, dummy2)) {
1198 if((dummy1[0] >= '0' && dummy1[0] <= '9') ||
1199 (dummy1[0] == '.' && !dummy2.empty() && (dummy2[0] >= '0' && dummy2[0] <= '9'))) {
1200 // it looks like a number but check if it could be an option
1201 if(get_option_no_throw(std::string{'-', dummy1[0]}) == nullptr) {
1202 return detail::Classifier::NONE;
1203 }
1204 }
1205 return detail::Classifier::SHORT;
1206 }
1207 if((allow_windows_style_options_) && (detail::split_windows_style(current, dummy1, dummy2)))
1208 return detail::Classifier::WINDOWS_STYLE;
1209 if((current == "++") && !name_.empty() && parent_ != nullptr)
1210 return detail::Classifier::SUBCOMMAND_TERMINATOR;
1211 auto dotloc = current.find_first_of('.');
1212 if(dotloc != std::string::npos) {
1213 auto *cm = _find_subcommand(current.substr(0, dotloc), true, ignore_used_subcommands);
1214 if(cm != nullptr) {
1215 auto res = cm->_recognize(current.substr(dotloc + 1), ignore_used_subcommands);
1216 if(res == detail::Classifier::SUBCOMMAND) {
1217 return res;
1218 }
1219 }
1220 }
1221 return detail::Classifier::NONE;
1222}
1223
1224CLI11_INLINE bool App::_process_config_file(const std::string &config_file, bool throw_error) {
1225 auto path_result = detail::check_path(config_file.c_str());
1226 if(path_result == detail::path_type::file) {
1227 try {
1228 std::vector<ConfigItem> values = config_formatter_->from_file(config_file);
1229 _parse_config(values);
1230 return true;
1231 } catch(const FileError &) {
1232 if(throw_error) {
1233 throw;
1234 }
1235 return false;
1236 }
1237 } else if(throw_error) {
1238 throw FileError::Missing(config_file);
1239 } else {
1240 return false;
1241 }
1242}
1243
1244CLI11_INLINE void App::_process_config_file() {
1245 if(config_ptr_ != nullptr) {
1246 bool config_required = config_ptr_->get_required();
1247 auto file_given = config_ptr_->count() > 0;
1248 if(!(file_given || config_ptr_->envname_.empty())) {
1249 std::string ename_string = detail::get_environment_value(config_ptr_->envname_);
1250 if(!ename_string.empty()) {
1251 config_ptr_->add_result(ename_string);
1252 }
1253 }
1255
1256 auto config_files = config_ptr_->as<std::vector<std::string>>();
1257 bool files_used{file_given};
1258 if(config_files.empty() || config_files.front().empty()) {
1259 if(config_required) {
1260 throw FileError("config file is required but none was given");
1261 }
1262 return;
1263 }
1264 for(const auto &config_file : config_files) {
1265 if(_process_config_file(config_file, config_required || file_given)) {
1266 files_used = true;
1267 }
1268 }
1269 if(!files_used) {
1270 // this is done so the count shows as 0 if no callbacks were processed
1271 config_ptr_->clear();
1272 bool force = config_ptr_->force_callback_;
1276 }
1277 }
1278}
1279
1280CLI11_INLINE void App::_process_env() {
1281 for(const Option_p &opt : options_) {
1282 if(opt->count() == 0 && !opt->envname_.empty()) {
1283 std::string ename_string = detail::get_environment_value(opt->envname_);
1284 if(!ename_string.empty()) {
1285 std::string result = ename_string;
1286 result = opt->_validate(result, 0);
1287 if(result.empty()) {
1288 opt->add_result(ename_string);
1289 }
1290 }
1291 }
1292 }
1293
1294 for(App_p &sub : subcommands_) {
1295 if(sub->get_name().empty() || (sub->count_all() > 0 && !sub->parse_complete_callback_)) {
1296 // only process environment variables if the callback has actually been triggered already
1297 sub->_process_env();
1298 }
1299 }
1300}
1301
1302CLI11_INLINE void App::_process_callbacks(CallbackPriority priority) {
1303
1304 for(App_p &sub : subcommands_) {
1305 // process the priority option_groups first
1306 if(sub->get_name().empty() && sub->parse_complete_callback_) {
1307 if(sub->count_all() > 0) {
1308 sub->_process_callbacks(priority);
1309 if(priority == CallbackPriority::Normal) {
1310 // only run the subcommand callback at normal priority
1311 sub->run_callback();
1312 }
1313 }
1314 }
1315 }
1316
1317 for(const Option_p &opt : options_) {
1318 if(opt->get_callback_priority() == priority) {
1319 if((*opt) && !opt->get_callback_run()) {
1320 opt->run_callback();
1321 }
1322 }
1323 }
1324 for(App_p &sub : subcommands_) {
1325 if(!sub->parse_complete_callback_) {
1326 sub->_process_callbacks(priority);
1327 }
1328 }
1329}
1330
1331CLI11_INLINE void App::_process_help_flags(CallbackPriority priority, bool trigger_help, bool trigger_all_help) const {
1332 const Option *help_ptr = get_help_ptr();
1333 const Option *help_all_ptr = get_help_all_ptr();
1334
1335 if(help_ptr != nullptr && help_ptr->count() > 0 && help_ptr->get_callback_priority() == priority) {
1336 trigger_help = true;
1337 }
1338 if(help_all_ptr != nullptr && help_all_ptr->count() > 0 && help_all_ptr->get_callback_priority() == priority) {
1339 trigger_all_help = true;
1340 }
1341
1342 // If there were parsed subcommands, call those. First subcommand wins if there are multiple ones.
1343 if(!parsed_subcommands_.empty()) {
1344 for(const App *sub : parsed_subcommands_) {
1345 sub->_process_help_flags(priority, trigger_help, trigger_all_help);
1346 }
1347
1348 // Only the final subcommand should call for help. All help wins over help.
1349 } else if(trigger_all_help) {
1350 throw CallForAllHelp();
1351 } else if(trigger_help) {
1352 throw CallForHelp();
1353 }
1354}
1355
1356CLI11_INLINE void App::_process_requirements() {
1357 // check excludes
1358 bool excluded{false};
1359 std::string excluder;
1360 for(const auto &opt : exclude_options_) {
1361 if(opt->count() > 0) {
1362 excluded = true;
1363 excluder = opt->get_name();
1364 }
1365 }
1366 for(const auto &subc : exclude_subcommands_) {
1367 if(subc->count_all() > 0) {
1368 excluded = true;
1369 excluder = subc->get_display_name();
1370 }
1371 }
1372 if(excluded) {
1373 if(count_all() > 0) {
1374 throw ExcludesError(get_display_name(), excluder);
1375 }
1376 // if we are excluded but didn't receive anything, just return
1377 return;
1378 }
1379
1380 // check excludes
1381 bool missing_needed{false};
1382 std::string missing_need;
1383 for(const auto &opt : need_options_) {
1384 if(opt->count() == 0) {
1385 missing_needed = true;
1386 missing_need = opt->get_name();
1387 }
1388 }
1389 for(const auto &subc : need_subcommands_) {
1390 if(subc->count_all() == 0) {
1391 missing_needed = true;
1392 missing_need = subc->get_display_name();
1393 }
1394 }
1395 if(missing_needed) {
1396 if(count_all() > 0) {
1397 throw RequiresError(get_display_name(), missing_need);
1398 }
1399 // if we missing something but didn't have any options, just return
1400 return;
1401 }
1402
1403 std::size_t used_options = 0;
1404 for(const Option_p &opt : options_) {
1405
1406 if(opt->count() != 0) {
1407 ++used_options;
1408 }
1409 // Required but empty
1410 if(opt->get_required() && opt->count() == 0) {
1411 throw RequiredError(opt->get_name());
1412 }
1413 // Requires
1414 for(const Option *opt_req : opt->needs_)
1415 if(opt->count() > 0 && opt_req->count() == 0)
1416 throw RequiresError(opt->get_name(), opt_req->get_name());
1417 // Excludes
1418 for(const Option *opt_ex : opt->excludes_)
1419 if(opt->count() > 0 && opt_ex->count() != 0)
1420 throw ExcludesError(opt->get_name(), opt_ex->get_name());
1421 }
1422 // check for the required number of subcommands
1423 if(require_subcommand_min_ > 0) {
1424 auto selected_subcommands = get_subcommands();
1425 if(require_subcommand_min_ > selected_subcommands.size())
1426 throw RequiredError::Subcommand(require_subcommand_min_);
1427 }
1428
1429 // Max error cannot occur, the extra subcommand will parse as an ExtrasError or a remaining item.
1430
1431 // run this loop to check how many unnamed subcommands were actually used since they are considered options
1432 // from the perspective of an App
1433 for(App_p &sub : subcommands_) {
1434 if(sub->disabled_)
1435 continue;
1436 if(sub->name_.empty() && sub->count_all() > 0) {
1437 ++used_options;
1438 }
1439 }
1440
1441 if(require_option_min_ > used_options || (require_option_max_ > 0 && require_option_max_ < used_options)) {
1442 auto option_list = detail::join(options_, [this](const Option_p &ptr) {
1443 if(ptr.get() == help_ptr_ || ptr.get() == help_all_ptr_) {
1444 return std::string{};
1445 }
1446 return ptr->get_name(false, true);
1447 });
1448
1449 auto subc_list = get_subcommands([](App *app) { return ((app->get_name().empty()) && (!app->disabled_)); });
1450 if(!subc_list.empty()) {
1451 option_list += "," + detail::join(subc_list, [](const App *app) { return app->get_display_name(); });
1452 }
1453 throw RequiredError::Option(require_option_min_, require_option_max_, used_options, option_list);
1454 }
1455
1456 // now process the requirements for subcommands if needed
1457 for(App_p &sub : subcommands_) {
1458 if(sub->disabled_)
1459 continue;
1460 if(sub->name_.empty() && sub->required_ == false) {
1461 if(sub->count_all() == 0) {
1462 if(require_option_min_ > 0 && require_option_min_ <= used_options) {
1463 continue;
1464 // if we have met the requirement and there is nothing in this option group skip checking
1465 // requirements
1466 }
1467 if(require_option_max_ > 0 && used_options >= require_option_min_) {
1468 continue;
1469 // if we have met the requirement and there is nothing in this option group skip checking
1470 // requirements
1471 }
1472 }
1473 }
1474 if(sub->count() > 0 || sub->name_.empty()) {
1475 sub->_process_requirements();
1476 }
1477
1478 if(sub->required_ && sub->count_all() == 0) {
1479 throw(CLI::RequiredError(sub->get_display_name()));
1480 }
1481 }
1482}
1483
1484CLI11_INLINE void App::_process() {
1485 // help takes precedence over other potential errors and config and environment shouldn't be processed if help
1486 // throws
1487 _process_callbacks(CallbackPriority::FirstPreHelp);
1488 _process_help_flags(CallbackPriority::First);
1489 _process_callbacks(CallbackPriority::First);
1490
1491 std::exception_ptr config_exception;
1492 try {
1493 // the config file might generate a FileError but that should not be processed until later in the process
1494 // to allow for help, version and other errors to generate first.
1496
1497 // process env shouldn't throw but no reason to process it if config generated an error
1498 _process_env();
1499 } catch(const CLI::FileError &) {
1500 config_exception = std::current_exception();
1501 }
1502 // callbacks and requirements processing can generate exceptions which should take priority
1503 // over the config file error if one exists.
1504 _process_callbacks(CallbackPriority::PreRequirementsCheckPreHelp);
1505 _process_help_flags(CallbackPriority::PreRequirementsCheck);
1506 _process_callbacks(CallbackPriority::PreRequirementsCheck);
1507
1509
1510 _process_callbacks(CallbackPriority::NormalPreHelp);
1511 _process_help_flags(CallbackPriority::Normal);
1512 _process_callbacks(CallbackPriority::Normal);
1513
1514 if(config_exception) {
1515 std::rethrow_exception(config_exception);
1516 }
1517
1518 _process_callbacks(CallbackPriority::LastPreHelp);
1519 _process_help_flags(CallbackPriority::Last);
1520 _process_callbacks(CallbackPriority::Last);
1521}
1522
1523CLI11_INLINE void App::_process_extras() {
1524 if(allow_extras_ == ExtrasMode::Error && prefix_command_ == PrefixCommandMode::Off) {
1525 std::size_t num_left_over = remaining_size();
1526 if(num_left_over > 0) {
1527 throw ExtrasError(name_, remaining(false));
1528 }
1529 }
1530 if(allow_extras_ == ExtrasMode::Error && prefix_command_ == PrefixCommandMode::SeparatorOnly) {
1531 std::size_t num_left_over = remaining_size();
1532 if(num_left_over > 0) {
1533 if(remaining(false).front() != "--") {
1534 throw ExtrasError(name_, remaining(false));
1535 }
1536 }
1537 }
1538 for(App_p &sub : subcommands_) {
1539 if(sub->count() > 0)
1540 sub->_process_extras();
1541 }
1542}
1543
1544CLI11_INLINE void App::increment_parsed() {
1545 ++parsed_;
1546 for(App_p &sub : subcommands_) {
1547 if(sub->get_name().empty())
1548 sub->increment_parsed();
1549 }
1550}
1551
1552CLI11_INLINE void App::_parse(std::vector<std::string> &args) {
1554 _trigger_pre_parse(args.size());
1555 bool positional_only = false;
1556
1557 while(!args.empty()) {
1558 if(!_parse_single(args, positional_only)) {
1559 break;
1560 }
1561 }
1562
1563 if(parent_ == nullptr) {
1564 _process();
1565
1566 // Throw error if any items are left over (depending on settings)
1568 // Convert missing (pairs) to extras (string only) ready for processing in another app
1569 args = remaining_for_passthrough(false);
1570 } else if(parse_complete_callback_) {
1571 _process_callbacks(CallbackPriority::FirstPreHelp);
1572 _process_help_flags(CallbackPriority::First);
1573 _process_callbacks(CallbackPriority::First);
1574 _process_env();
1575 _process_callbacks(CallbackPriority::PreRequirementsCheckPreHelp);
1576 _process_help_flags(CallbackPriority::PreRequirementsCheck);
1577 _process_callbacks(CallbackPriority::PreRequirementsCheck);
1579 _process_callbacks(CallbackPriority::NormalPreHelp);
1580 _process_help_flags(CallbackPriority::Normal);
1581 _process_callbacks(CallbackPriority::Normal);
1582 _process_callbacks(CallbackPriority::LastPreHelp);
1583 _process_help_flags(CallbackPriority::Last);
1584 _process_callbacks(CallbackPriority::Last);
1585 run_callback(false, true);
1586 }
1587}
1588
1589CLI11_INLINE void App::_parse(std::vector<std::string> &&args) {
1590 // this can only be called by the top level in which case parent == nullptr by definition
1591 // operation is simplified
1593 _trigger_pre_parse(args.size());
1594 bool positional_only = false;
1595
1596 while(!args.empty()) {
1597 _parse_single(args, positional_only);
1598 }
1599 _process();
1600
1601 // Throw error if any items are left over (depending on settings)
1603}
1604
1605CLI11_INLINE void App::_parse_stream(std::istream &input) {
1606 auto values = config_formatter_->from_config(input);
1607 _parse_config(values);
1609 _trigger_pre_parse(values.size());
1610 _process();
1611
1612 // Throw error if any items are left over (depending on settings)
1614}
1615
1616CLI11_INLINE void App::_parse_config(const std::vector<ConfigItem> &args) {
1617 for(const ConfigItem &item : args) {
1618 if(!_parse_single_config(item) && allow_config_extras_ == ConfigExtrasMode::Error)
1619 throw ConfigError::Extras(item.fullname());
1620 }
1621}
1622
1623CLI11_INLINE bool
1624App::_add_flag_like_result(Option *op, const ConfigItem &item, const std::vector<std::string> &inputs) {
1625 if(item.inputs.size() <= 1) {
1626 // Flag parsing
1627 auto res = config_formatter_->to_flag(item);
1628 bool converted{false};
1629 if(op->get_disable_flag_override()) {
1630 auto val = detail::to_flag_value(res);
1631 if(val == 1) {
1632 res = op->get_flag_value(item.name, "{}");
1633 converted = true;
1634 }
1635 }
1636
1637 if(!converted) {
1638 errno = 0;
1639 if(res != "{}" || op->get_expected_max() <= 1) {
1640 res = op->get_flag_value(item.name, res);
1641 }
1642 }
1643
1644 op->add_result(res);
1645 return true;
1646 }
1647 if(static_cast<int>(inputs.size()) > op->get_items_expected_max() &&
1648 op->get_multi_option_policy() != MultiOptionPolicy::TakeAll &&
1649 op->get_multi_option_policy() != MultiOptionPolicy::Join) {
1650 if(op->get_items_expected_max() > 1) {
1651 throw ArgumentMismatch::AtMost(item.fullname(), op->get_items_expected_max(), inputs.size());
1652 }
1653
1654 if(!op->get_disable_flag_override()) {
1655 throw ConversionError::TooManyInputsFlag(item.fullname());
1656 }
1657 // if the disable flag override is set then we must have the flag values match a known flag value
1658 // this is true regardless of the output value, so an array input is possible and must be accounted for
1659 for(const auto &res : inputs) {
1660 bool valid_value{false};
1661 if(op->default_flag_values_.empty()) {
1662 if(res == "true" || res == "false" || res == "1" || res == "0") {
1663 valid_value = true;
1664 }
1665 } else {
1666 for(const auto &valid_res : op->default_flag_values_) {
1667 if(valid_res.second == res) {
1668 valid_value = true;
1669 break;
1670 }
1671 }
1672 }
1673
1674 if(valid_value) {
1675 op->add_result(res);
1676 } else {
1677 throw InvalidError("invalid flag argument given");
1678 }
1679 }
1680 return true;
1681 }
1682 return false;
1683}
1684
1685CLI11_INLINE bool App::_parse_single_config(const ConfigItem &item, std::size_t level) {
1686
1687 if(level < item.parents.size()) {
1688 auto *subcom = get_subcommand_no_throw(item.parents.at(level));
1689 return (subcom != nullptr) ? subcom->_parse_single_config(item, level + 1) : false;
1690 }
1691 // check for section open
1692 if(item.name == "++") {
1693 if(configurable_) {
1696 if(parent_ != nullptr) {
1697 parent_->parsed_subcommands_.push_back(this);
1698 }
1699 }
1700 return true;
1701 }
1702 // check for section close
1703 if(item.name == "--") {
1705 _process_callbacks(CallbackPriority::FirstPreHelp);
1706 _process_callbacks(CallbackPriority::First);
1707 _process_callbacks(CallbackPriority::PreRequirementsCheckPreHelp);
1708 _process_callbacks(CallbackPriority::PreRequirementsCheck);
1710 _process_callbacks(CallbackPriority::NormalPreHelp);
1711 _process_callbacks(CallbackPriority::Normal);
1712 _process_callbacks(CallbackPriority::LastPreHelp);
1713 _process_callbacks(CallbackPriority::Last);
1714 run_callback();
1715 }
1716 return true;
1717 }
1718 Option *op = get_option_no_throw("--" + item.name);
1719 if(op == nullptr) {
1720 if(item.name.size() == 1) {
1721 op = get_option_no_throw("-" + item.name);
1722 }
1723 if(op == nullptr) {
1724 op = get_option_no_throw(item.name);
1725 }
1726 } else if(!op->get_configurable()) {
1727 if(item.name.size() == 1) {
1728 auto *testop = get_option_no_throw("-" + item.name);
1729 if(testop != nullptr && testop->get_configurable()) {
1730 op = testop;
1731 }
1732 }
1733 }
1734 if(op == nullptr || !op->get_configurable()) {
1735 std::string iname = item.name;
1736 auto options = get_options([iname](const CLI::Option *opt) {
1737 return (opt->get_configurable() &&
1738 (opt->check_name(iname) || opt->check_lname(iname) || opt->check_sname(iname)));
1739 });
1740 if(!options.empty()) {
1741 op = options[0];
1742 }
1743 }
1744 if(op == nullptr) {
1745 // If the option was not present
1746 if(get_allow_config_extras() == config_extras_mode::capture) {
1747 // Should we worry about classifying the extras properly?
1748 missing_.emplace_back(detail::Classifier::NONE, item.fullname());
1749 for(const auto &input : item.inputs) {
1750 missing_.emplace_back(detail::Classifier::NONE, input);
1751 }
1752 }
1753 return false;
1754 }
1755
1756 if(!op->get_configurable()) {
1757 if(get_allow_config_extras() == config_extras_mode::ignore_all) {
1758 return false;
1759 }
1760 throw ConfigError::NotConfigurable(item.fullname());
1761 }
1762 if(op->empty()) {
1763 std::vector<std::string> buffer; // a buffer to use for copying and modifying inputs in a few cases
1764 bool useBuffer{false};
1765 if(item.multiline) {
1766 if(!op->get_inject_separator()) {
1767 buffer = item.inputs;
1768 buffer.erase(std::remove(buffer.begin(), buffer.end(), "%%"), buffer.end());
1769 useBuffer = true;
1770 }
1771 }
1772 const std::vector<std::string> &inputs = (useBuffer) ? buffer : item.inputs;
1773 if(op->get_expected_min() == 0) {
1774 if(_add_flag_like_result(op, item, inputs)) {
1775 return true;
1776 }
1777 }
1778 op->add_result(inputs);
1779 op->run_callback();
1780 }
1781
1782 return true;
1783}
1784
1785CLI11_INLINE bool App::_parse_single(std::vector<std::string> &args, bool &positional_only) {
1786 bool retval = true;
1787 detail::Classifier classifier = positional_only ? detail::Classifier::NONE : _recognize(args.back());
1788 switch(classifier) {
1789 case detail::Classifier::POSITIONAL_MARK:
1790 args.pop_back();
1791 positional_only = true;
1792 if(get_prefix_command()) {
1793 // don't care about extras mode here
1794 missing_.emplace_back(classifier, "--");
1795 while(!args.empty()) {
1796 missing_.emplace_back(detail::Classifier::NONE, args.back());
1797 args.pop_back();
1798 }
1799 } else if((!_has_remaining_positionals()) && (parent_ != nullptr)) {
1800 retval = false;
1801 } else {
1802 _move_to_missing(classifier, "--");
1803 }
1804 break;
1805 case detail::Classifier::SUBCOMMAND_TERMINATOR:
1806 // treat this like a positional mark if in the parent app
1807 args.pop_back();
1808 retval = false;
1809 break;
1810 case detail::Classifier::SUBCOMMAND:
1811 retval = _parse_subcommand(args);
1812 break;
1813 case detail::Classifier::LONG:
1814 case detail::Classifier::SHORT:
1815 case detail::Classifier::WINDOWS_STYLE:
1816 // If already parsed a subcommand, don't accept options_
1817 retval = _parse_arg(args, classifier, false);
1818 break;
1819 case detail::Classifier::NONE:
1820 // Probably a positional or something for a parent (sub)command
1821 retval = _parse_positional(args, false);
1822 if(retval && positionals_at_end_) {
1823 positional_only = true;
1824 }
1825 break;
1826 // LCOV_EXCL_START
1827 default:
1828 throw HorribleError("unrecognized classifier (you should not see this!)");
1829 // LCOV_EXCL_STOP
1830 }
1831 return retval;
1832}
1833
1834CLI11_NODISCARD CLI11_INLINE std::size_t App::_count_remaining_positionals(bool required_only) const {
1835 std::size_t retval = 0;
1836 for(const Option_p &opt : options_) {
1837 if(opt->get_positional() && (!required_only || opt->get_required())) {
1838 if(opt->get_items_expected_min() > 0 && static_cast<int>(opt->count()) < opt->get_items_expected_min()) {
1839 retval += static_cast<std::size_t>(opt->get_items_expected_min()) - opt->count();
1840 }
1841 }
1842 }
1843 return retval;
1844}
1845
1846CLI11_NODISCARD CLI11_INLINE bool App::_has_remaining_positionals() const {
1847 for(const Option_p &opt : options_) {
1848 if(opt->get_positional() && ((static_cast<int>(opt->count()) < opt->get_items_expected_min()))) {
1849 return true;
1850 }
1851 }
1852
1853 return false;
1854}
1855
1856CLI11_INLINE bool App::_parse_positional(std::vector<std::string> &args, bool haltOnSubcommand) {
1857
1858 const std::string &positional = args.back();
1859 Option *posOpt{nullptr};
1860
1862 // deal with the case of required arguments at the end which should take precedence over other arguments
1863 auto arg_rem = args.size();
1864 auto remreq = _count_remaining_positionals(true);
1865 if(arg_rem <= remreq) {
1866 for(const Option_p &opt : options_) {
1867 if(opt->get_positional() && opt->required_) {
1868 if(static_cast<int>(opt->count()) < opt->get_items_expected_min()) {
1870 std::string pos = positional;
1871 pos = opt->_validate(pos, 0);
1872 if(!pos.empty()) {
1873 continue;
1874 }
1875 }
1876 posOpt = opt.get();
1877 break;
1878 }
1879 }
1880 }
1881 }
1882 }
1883 if(posOpt == nullptr) {
1884 for(const Option_p &opt : options_) {
1885 // Eat options, one by one, until done
1886 if(opt->get_positional() &&
1887 (static_cast<int>(opt->count()) < opt->get_items_expected_max() || opt->get_allow_extra_args())) {
1889 std::string pos = positional;
1890 pos = opt->_validate(pos, 0);
1891 if(!pos.empty()) {
1892 continue;
1893 }
1894 }
1895 posOpt = opt.get();
1896 break;
1897 }
1898 }
1899 }
1900 if(posOpt != nullptr) {
1901 parse_order_.push_back(posOpt);
1902 if(posOpt->get_inject_separator()) {
1903 if(!posOpt->results().empty() && !posOpt->results().back().empty()) {
1904 posOpt->add_result(std::string{});
1905 }
1906 }
1907 results_t prev;
1908 if(posOpt->get_trigger_on_parse() && posOpt->current_option_state_ == Option::option_state::callback_run) {
1909 prev = posOpt->results();
1910 posOpt->clear();
1911 }
1912 if(posOpt->get_expected_min() == 0) {
1913 ConfigItem item;
1914 item.name = posOpt->pname_;
1915 item.inputs.push_back(positional);
1916 // input is singular guaranteed to return true in that case
1917 _add_flag_like_result(posOpt, item, item.inputs);
1918 } else {
1919 posOpt->add_result(positional);
1920 }
1921
1922 if(posOpt->get_trigger_on_parse()) {
1923 if(!posOpt->empty()) {
1924 posOpt->run_callback();
1925 } else {
1926 if(!prev.empty()) {
1927 posOpt->add_result(prev);
1928 }
1929 }
1930 }
1931
1932 args.pop_back();
1933 return true;
1934 }
1935
1936 for(auto &subc : subcommands_) {
1937 if((subc->name_.empty()) && (!subc->disabled_)) {
1938 if(subc->_parse_positional(args, false)) {
1939 if(!subc->pre_parse_called_) {
1940 subc->_trigger_pre_parse(args.size());
1941 }
1942 return true;
1943 }
1944 }
1945 }
1946 // let the parent deal with it if possible
1947 if(parent_ != nullptr && fallthrough_) {
1948 return _get_fallthrough_parent()->_parse_positional(args, static_cast<bool>(parse_complete_callback_));
1949 }
1951 auto *com = _find_subcommand(args.back(), true, false);
1952 if(com != nullptr && (require_subcommand_max_ == 0 || require_subcommand_max_ > parsed_subcommands_.size())) {
1953 if(haltOnSubcommand) {
1954 return false;
1955 }
1956 args.pop_back();
1957 com->_parse(args);
1958 return true;
1959 }
1963 auto *parent_app = (parent_ != nullptr) ? _get_fallthrough_parent() : this;
1964 com = parent_app->_find_subcommand(args.back(), true, false);
1965 if(com != nullptr && (com->parent_->require_subcommand_max_ == 0 ||
1966 com->parent_->require_subcommand_max_ > com->parent_->parsed_subcommands_.size())) {
1967 return false;
1968 }
1969 }
1971 std::vector<std::string> rargs;
1972 rargs.resize(args.size());
1973 std::reverse_copy(args.begin(), args.end(), rargs.begin());
1974 throw CLI::ExtrasError(name_, rargs);
1975 }
1977 if(parent_ != nullptr && name_.empty()) {
1978 return false;
1979 }
1981 _move_to_missing(detail::Classifier::NONE, positional);
1982 args.pop_back();
1983 if(get_prefix_command()) {
1984 while(!args.empty()) {
1985 missing_.emplace_back(detail::Classifier::NONE, args.back());
1986 args.pop_back();
1987 }
1988 }
1989
1990 return true;
1991}
1992
1993CLI11_NODISCARD CLI11_INLINE App *
1994App::_find_subcommand(const std::string &subc_name, bool ignore_disabled, bool ignore_used) const noexcept {
1995 App *bcom{nullptr};
1996 for(const App_p &com : subcommands_) {
1997 if(com->disabled_ && ignore_disabled)
1998 continue;
1999 if(com->get_name().empty()) {
2000 auto *subc = com->_find_subcommand(subc_name, ignore_disabled, ignore_used);
2001 if(subc != nullptr) {
2002 if(bcom != nullptr) {
2003 return nullptr;
2004 }
2005 bcom = subc;
2006 if(!allow_prefix_matching_) {
2007 return bcom;
2008 }
2009 }
2010 }
2011 auto res = com->check_name_detail(subc_name);
2012 if(res != NameMatch::none) {
2013 if((!*com) || !ignore_used) {
2014 if(res == NameMatch::exact) {
2015 return com.get();
2016 }
2017 if(bcom != nullptr) {
2018 return nullptr;
2019 }
2020 bcom = com.get();
2021 if(!allow_prefix_matching_) {
2022 return bcom;
2023 }
2024 }
2025 }
2026 }
2027 return bcom;
2028}
2029
2030CLI11_INLINE bool App::_parse_subcommand(std::vector<std::string> &args) {
2031 if(_count_remaining_positionals(/* required */ true) > 0) {
2032 _parse_positional(args, false);
2033 return true;
2034 }
2035 auto *com = _find_subcommand(args.back(), true, true);
2036 if(com == nullptr) {
2037 // the main way to get here is using .notation
2038 auto dotloc = args.back().find_first_of('.');
2039 if(dotloc != std::string::npos) {
2040 com = _find_subcommand(args.back().substr(0, dotloc), true, true);
2041 if(com != nullptr) {
2042 args.back() = args.back().substr(dotloc + 1);
2043 args.push_back(com->get_display_name());
2044 }
2045 }
2046 }
2047 if(com != nullptr) {
2048 args.pop_back();
2049 if(!com->silent_) {
2050 parsed_subcommands_.push_back(com);
2051 }
2052 com->_parse(args);
2053 auto *parent_app = com->parent_;
2054 while(parent_app != this) {
2055 parent_app->_trigger_pre_parse(args.size());
2056 if(!com->silent_) {
2057 parent_app->parsed_subcommands_.push_back(com);
2058 }
2059 parent_app = parent_app->parent_;
2060 }
2061 return true;
2062 }
2063
2064 if(parent_ == nullptr)
2065 throw HorribleError("Subcommand " + args.back() + " missing");
2066 return false;
2067}
2068
2069CLI11_INLINE bool
2070App::_parse_arg(std::vector<std::string> &args, detail::Classifier current_type, bool local_processing_only) {
2071
2072 std::string current = args.back();
2073
2074 std::string arg_name;
2075 std::string value;
2076 std::string rest;
2077
2078 switch(current_type) {
2079 case detail::Classifier::LONG:
2080 if(!detail::split_long(current, arg_name, value))
2081 throw HorribleError("Long parsed but missing (you should not see this):" + args.back());
2082 break;
2083 case detail::Classifier::SHORT:
2084 if(!detail::split_short(current, arg_name, rest))
2085 throw HorribleError("Short parsed but missing! You should not see this");
2086 break;
2087 case detail::Classifier::WINDOWS_STYLE:
2088 if(!detail::split_windows_style(current, arg_name, value))
2089 throw HorribleError("windows option parsed but missing! You should not see this");
2090 break;
2091 case detail::Classifier::SUBCOMMAND:
2092 case detail::Classifier::SUBCOMMAND_TERMINATOR:
2093 case detail::Classifier::POSITIONAL_MARK:
2094 case detail::Classifier::NONE:
2095 default:
2096 throw HorribleError("parsing got called with invalid option! You should not see this");
2097 }
2098
2099 auto op_ptr = std::find_if(std::begin(options_), std::end(options_), [arg_name, current_type](const Option_p &opt) {
2100 if(current_type == detail::Classifier::LONG)
2101 return opt->check_lname(arg_name);
2102 if(current_type == detail::Classifier::SHORT)
2103 return opt->check_sname(arg_name);
2104 // this will only get called for detail::Classifier::WINDOWS_STYLE
2105 return opt->check_lname(arg_name) || opt->check_sname(arg_name);
2106 });
2107
2108 // Option not found
2109 while(op_ptr == std::end(options_)) {
2110 // using while so we can break
2111 for(auto &subc : subcommands_) {
2112 if(subc->name_.empty() && !subc->disabled_) {
2113 if(subc->_parse_arg(args, current_type, local_processing_only)) {
2114 if(!subc->pre_parse_called_) {
2115 subc->_trigger_pre_parse(args.size());
2116 }
2117 return true;
2118 }
2119 }
2120 }
2121 if(allow_non_standard_options_ && current_type == detail::Classifier::SHORT && current.size() > 2) {
2122 std::string narg_name;
2123 std::string nvalue;
2124 detail::split_long(std::string{'-'} + current, narg_name, nvalue);
2125 op_ptr = std::find_if(std::begin(options_), std::end(options_), [narg_name](const Option_p &opt) {
2126 return opt->check_sname(narg_name);
2127 });
2128 if(op_ptr != std::end(options_)) {
2129 arg_name = narg_name;
2130 value = nvalue;
2131 rest.clear();
2132 break;
2133 }
2134 }
2135
2136 // don't capture missing if this is a nameless subcommand and nameless subcommands can't fallthrough
2137 if(parent_ != nullptr && name_.empty()) {
2138 return false;
2139 }
2140
2141 // now check for '.' notation of subcommands
2142 auto dotloc = arg_name.find_first_of('.', 1);
2143 if(dotloc != std::string::npos && dotloc < arg_name.size() - 1) {
2144 // using dot notation is equivalent to single argument subcommand
2145 auto *sub = _find_subcommand(arg_name.substr(0, dotloc), true, false);
2146 if(sub != nullptr) {
2147 std::string v = args.back();
2148 args.pop_back();
2149 arg_name = arg_name.substr(dotloc + 1);
2150 if(arg_name.size() > 1) {
2151 args.push_back(std::string("--") + v.substr(dotloc + 3));
2152 current_type = detail::Classifier::LONG;
2153 } else {
2154 auto nval = v.substr(dotloc + 2);
2155 nval.front() = '-';
2156 if(nval.size() > 2) {
2157 // '=' not allowed in short form arguments
2158 args.push_back(nval.substr(3));
2159 nval.resize(2);
2160 }
2161 args.push_back(nval);
2162 current_type = detail::Classifier::SHORT;
2163 }
2164 std::string dummy1, dummy2;
2165 bool val = false;
2166 if((current_type == detail::Classifier::SHORT && detail::valid_first_char(args.back()[1])) ||
2167 detail::split_long(args.back(), dummy1, dummy2)) {
2168 val = sub->_parse_arg(args, current_type, true);
2169 }
2170
2171 if(val) {
2172 if(!sub->silent_) {
2173 parsed_subcommands_.push_back(sub);
2174 }
2175 // deal with preparsing
2177 _trigger_pre_parse(args.size());
2178 // run the parse complete callback since the subcommand processing is now complete
2179 if(sub->parse_complete_callback_) {
2180 sub->_process_callbacks(CallbackPriority::FirstPreHelp);
2181 sub->_process_help_flags(CallbackPriority::First);
2182 sub->_process_callbacks(CallbackPriority::First);
2183 sub->_process_env();
2184 sub->_process_callbacks(CallbackPriority::PreRequirementsCheckPreHelp);
2185 sub->_process_help_flags(CallbackPriority::PreRequirementsCheck);
2186 sub->_process_callbacks(CallbackPriority::PreRequirementsCheck);
2187 sub->_process_requirements();
2188 sub->_process_callbacks(CallbackPriority::NormalPreHelp);
2189 sub->_process_help_flags(CallbackPriority::Normal);
2190 sub->_process_callbacks(CallbackPriority::Normal);
2191 sub->_process_callbacks(CallbackPriority::LastPreHelp);
2192 sub->_process_help_flags(CallbackPriority::Last);
2193 sub->_process_callbacks(CallbackPriority::Last);
2194 sub->run_callback(false, true);
2195 }
2196 return true;
2197 }
2198 args.pop_back();
2199 args.push_back(v);
2200 }
2201 }
2202 if(local_processing_only) {
2203 return false;
2204 }
2205 // If a subcommand, try the main command
2206 if(parent_ != nullptr && fallthrough_)
2207 return _get_fallthrough_parent()->_parse_arg(args, current_type, false);
2208
2209 // Otherwise, add to missing
2210 args.pop_back();
2211 _move_to_missing(current_type, current);
2212 if(get_prefix_command_mode() == PrefixCommandMode::On) {
2213 while(!args.empty()) {
2214 missing_.emplace_back(detail::Classifier::NONE, args.back());
2215 args.pop_back();
2216 }
2217 } else if(allow_extras_ == ExtrasMode::AssumeSingleArgument) {
2218 if(!args.empty() && _recognize(args.back(), false) == detail::Classifier::NONE) {
2219 _move_to_missing(detail::Classifier::NONE, args.back());
2220 args.pop_back();
2221 }
2222 } else if(allow_extras_ == ExtrasMode::AssumeMultipleArguments) {
2223 while(!args.empty() && _recognize(args.back(), false) == detail::Classifier::NONE) {
2224 _move_to_missing(detail::Classifier::NONE, args.back());
2225 args.pop_back();
2226 }
2227 }
2228 return true;
2229 }
2230
2231 args.pop_back();
2232
2233 // Get a reference to the pointer to make syntax bearable
2234 Option_p &op = *op_ptr;
2236 if(op->get_inject_separator()) {
2237 if(!op->results().empty() && !op->results().back().empty()) {
2238 op->add_result(std::string{});
2239 }
2240 }
2241 if(op->get_trigger_on_parse() && op->current_option_state_ == Option::option_state::callback_run) {
2242 op->clear();
2243 }
2244 int min_num = (std::min)(op->get_type_size_min(), op->get_items_expected_min());
2245 int max_num = op->get_items_expected_max();
2246 // check container like options to limit the argument size to a single type if the allow_extra_flags argument is
2247 // set. 16 is somewhat arbitrary (needs to be at least 4)
2248 if(max_num >= detail::expected_max_vector_size / 16 && !op->get_allow_extra_args()) {
2249 auto tmax = op->get_type_size_max();
2250 max_num = detail::checked_multiply(tmax, op->get_expected_min()) ? tmax : detail::expected_max_vector_size;
2251 }
2252 // Make sure we always eat the minimum for unlimited vectors
2253 int collected = 0; // total number of arguments collected
2254 int result_count = 0; // local variable for number of results in a single arg string
2255 // deal with purely flag like things
2256 if(max_num == 0) {
2257 auto res = op->get_flag_value(arg_name, value);
2258 op->add_result(res);
2259 parse_order_.push_back(op.get());
2260 } else if(!value.empty()) { // --this=value
2261 op->add_result(value, result_count);
2262 parse_order_.push_back(op.get());
2263 collected += result_count;
2264 // -Trest
2265 } else if(!rest.empty()) {
2266 op->add_result(rest, result_count);
2267 parse_order_.push_back(op.get());
2268 rest = "";
2269 collected += result_count;
2270 }
2271
2272 // gather the minimum number of arguments
2273 while(min_num > collected && !args.empty()) {
2274 std::string current_ = args.back();
2275 args.pop_back();
2276 op->add_result(current_, result_count);
2277 parse_order_.push_back(op.get());
2278 collected += result_count;
2279 }
2280
2281 if(min_num > collected) { // if we have run out of arguments and the minimum was not met
2282 throw ArgumentMismatch::TypedAtLeast(op->get_name(), min_num, op->get_type_name());
2283 }
2284
2285 // now check for optional arguments
2286 if(max_num > collected || op->get_allow_extra_args()) { // we allow optional arguments
2287 auto remreqpos = _count_remaining_positionals(true);
2288 // we have met the minimum now optionally check up to the maximum
2289 while((collected < max_num || op->get_allow_extra_args()) && !args.empty() &&
2290 _recognize(args.back(), false) == detail::Classifier::NONE) {
2291 // If any required positionals remain, don't keep eating
2292 if(remreqpos >= args.size()) {
2293 break;
2294 }
2296 std::string arg = args.back();
2297 arg = op->_validate(arg, 0);
2298 if(!arg.empty()) {
2299 break;
2300 }
2301 }
2302 op->add_result(args.back(), result_count);
2303 parse_order_.push_back(op.get());
2304 args.pop_back();
2305 collected += result_count;
2306 }
2307
2308 // Allow -- to end an unlimited list and "eat" it
2309 if(!args.empty() && _recognize(args.back()) == detail::Classifier::POSITIONAL_MARK)
2310 args.pop_back();
2311 // optional flag that didn't receive anything now get the default value
2312 if(min_num == 0 && max_num > 0 && collected == 0) {
2313 auto res = op->get_flag_value(arg_name, std::string{});
2314 op->add_result(res);
2315 parse_order_.push_back(op.get());
2316 }
2317 }
2318 // if we only partially completed a type then add an empty string if allowed for later processing
2319 if(min_num > 0 && (collected % op->get_type_size_max()) != 0) {
2320 if(op->get_type_size_max() != op->get_type_size_min()) {
2321 op->add_result(std::string{});
2322 } else {
2323 throw ArgumentMismatch::PartialType(op->get_name(), op->get_type_size_min(), op->get_type_name());
2324 }
2325 }
2326 if(op->get_trigger_on_parse()) {
2327 op->run_callback();
2328 }
2329 if(!rest.empty()) {
2330 rest = "-" + rest;
2331 args.push_back(rest);
2332 }
2333 return true;
2334}
2335
2336CLI11_INLINE void App::_trigger_pre_parse(std::size_t remaining_args) {
2337 if(!pre_parse_called_) {
2338 pre_parse_called_ = true;
2340 pre_parse_callback_(remaining_args);
2341 }
2342 } else if(immediate_callback_) {
2343 if(!name_.empty()) {
2344 auto pcnt = parsed_;
2345 missing_t extras = std::move(missing_);
2346 clear();
2347 parsed_ = pcnt;
2348 pre_parse_called_ = true;
2349 missing_ = std::move(extras);
2350 }
2351 }
2352}
2353
2354CLI11_INLINE App *App::_get_fallthrough_parent() noexcept {
2355 if(parent_ == nullptr) {
2356 return nullptr;
2357 }
2358 auto *fallthrough_parent = parent_;
2359 while((fallthrough_parent->parent_ != nullptr) && (fallthrough_parent->get_name().empty())) {
2360 fallthrough_parent = fallthrough_parent->parent_;
2361 }
2362 return fallthrough_parent;
2363}
2364
2365CLI11_INLINE const App *App::_get_fallthrough_parent() const noexcept {
2366 if(parent_ == nullptr) {
2367 return nullptr;
2368 }
2369 const auto *fallthrough_parent = parent_;
2370 while((fallthrough_parent->parent_ != nullptr) && (fallthrough_parent->get_name().empty())) {
2371 fallthrough_parent = fallthrough_parent->parent_;
2372 }
2373 return fallthrough_parent;
2374}
2375
2376CLI11_NODISCARD CLI11_INLINE const std::string &App::_compare_subcommand_names(const App &subcom,
2377 const App &base) const {
2378 static const std::string estring;
2379 if(subcom.disabled_) {
2380 return estring;
2381 }
2382 for(const auto &subc : base.subcommands_) {
2383 if(subc.get() != &subcom) {
2384 if(subc->disabled_) {
2385 continue;
2386 }
2387 if(!subcom.get_name().empty()) {
2388 if(subc->check_name(subcom.get_name())) {
2389 return subcom.get_name();
2390 }
2391 }
2392 if(!subc->get_name().empty()) {
2393 if(subcom.check_name(subc->get_name())) {
2394 return subc->get_name();
2395 }
2396 }
2397 for(const auto &les : subcom.aliases_) {
2398 if(subc->check_name(les)) {
2399 return les;
2400 }
2401 }
2402 // this loop is needed in case of ignore_underscore or ignore_case on one but not the other
2403 for(const auto &les : subc->aliases_) {
2404 if(subcom.check_name(les)) {
2405 return les;
2406 }
2407 }
2408 // if the subcommand is an option group we need to check deeper
2409 if(subc->get_name().empty()) {
2410 const auto &cmpres = _compare_subcommand_names(subcom, *subc);
2411 if(!cmpres.empty()) {
2412 return cmpres;
2413 }
2414 }
2415 // if the test subcommand is an option group we need to check deeper
2416 if(subcom.get_name().empty()) {
2417 const auto &cmpres = _compare_subcommand_names(*subc, subcom);
2418 if(!cmpres.empty()) {
2419 return cmpres;
2420 }
2421 }
2422 }
2423 }
2424 return estring;
2425}
2426
2427inline bool capture_extras(ExtrasMode mode) {
2428 return mode == ExtrasMode::Capture || mode == ExtrasMode::AssumeSingleArgument ||
2429 mode == ExtrasMode::AssumeMultipleArguments;
2430}
2431CLI11_INLINE void App::_move_to_missing(detail::Classifier val_type, const std::string &val) {
2432 if(allow_extras_ == ExtrasMode::ErrorImmediately) {
2433 throw ExtrasError(name_, std::vector<std::string>{val});
2434 }
2435 if(capture_extras(allow_extras_) || subcommands_.empty() || get_prefix_command()) {
2436 if(allow_extras_ != ExtrasMode::Ignore) {
2437 missing_.emplace_back(val_type, val);
2438 }
2439 return;
2440 }
2441 // allow extra arguments to be placed in an option group if it is allowed there
2442 for(auto &subc : subcommands_) {
2443 if(subc->name_.empty() && capture_extras(subc->allow_extras_)) {
2444 subc->missing_.emplace_back(val_type, val);
2445 return;
2446 }
2447 }
2448 if(allow_extras_ != ExtrasMode::Ignore) {
2449 // if we haven't found any place to put them yet put them in missing
2450 missing_.emplace_back(val_type, val);
2451 }
2452}
2453
2454CLI11_INLINE void App::_move_option(Option *opt, App *app) {
2455 if(opt == nullptr) {
2456 throw OptionNotFound("the option is NULL");
2457 }
2458 // verify that the give app is actually a subcommand
2459 bool found = false;
2460 for(auto &subc : subcommands_) {
2461 if(app == subc.get()) {
2462 found = true;
2463 }
2464 }
2465 if(!found) {
2466 throw OptionNotFound("The Given app is not a subcommand");
2467 }
2468
2469 if((help_ptr_ == opt) || (help_all_ptr_ == opt))
2470 throw OptionAlreadyAdded("cannot move help options");
2471
2472 if(config_ptr_ == opt)
2473 throw OptionAlreadyAdded("cannot move config file options");
2474
2475 auto iterator =
2476 std::find_if(std::begin(options_), std::end(options_), [opt](const Option_p &v) { return v.get() == opt; });
2477 if(iterator != std::end(options_)) {
2478 const auto &opt_p = *iterator;
2479 if(std::find_if(std::begin(app->options_), std::end(app->options_), [&opt_p](const Option_p &v) {
2480 return (*v == *opt_p);
2481 }) == std::end(app->options_)) {
2482 // only erase after the insertion was successful
2483 app->options_.push_back(std::move(*iterator));
2484 options_.erase(iterator);
2485 } else {
2486 throw OptionAlreadyAdded("option was not located: " + opt->get_name());
2487 }
2488 } else {
2489 throw OptionNotFound("could not locate the given Option");
2490 }
2491}
2492
2493CLI11_INLINE void TriggerOn(App *trigger_app, App *app_to_enable) {
2494 app_to_enable->enabled_by_default(false);
2495 app_to_enable->disabled_by_default();
2496 trigger_app->preparse_callback([app_to_enable](std::size_t) { app_to_enable->disabled(false); });
2497}
2498
2499CLI11_INLINE void TriggerOn(App *trigger_app, std::vector<App *> apps_to_enable) {
2500 for(auto &app : apps_to_enable) {
2501 app->enabled_by_default(false);
2502 app->disabled_by_default();
2503 }
2504
2505 trigger_app->preparse_callback([apps_to_enable](std::size_t) {
2506 for(const auto &app : apps_to_enable) {
2507 app->disabled(false);
2508 }
2509 });
2510}
2511
2512CLI11_INLINE void TriggerOff(App *trigger_app, App *app_to_enable) {
2513 app_to_enable->disabled_by_default(false);
2514 app_to_enable->enabled_by_default();
2515 trigger_app->preparse_callback([app_to_enable](std::size_t) { app_to_enable->disabled(); });
2516}
2517
2518CLI11_INLINE void TriggerOff(App *trigger_app, std::vector<App *> apps_to_enable) {
2519 for(auto &app : apps_to_enable) {
2520 app->disabled_by_default(false);
2521 app->enabled_by_default();
2522 }
2523
2524 trigger_app->preparse_callback([apps_to_enable](std::size_t) {
2525 for(const auto &app : apps_to_enable) {
2526 app->disabled();
2527 }
2528 });
2529}
2530
2531CLI11_INLINE void deprecate_option(Option *opt, const std::string &replacement) {
2532 Validator deprecate_warning{[opt, replacement](std::string &) {
2533 std::cout << opt->get_name() << " is deprecated please use '" << replacement
2534 << "' instead\n";
2535 return std::string();
2536 },
2537 "DEPRECATED"};
2538 deprecate_warning.application_index(0);
2539 opt->check(deprecate_warning);
2540 if(!replacement.empty()) {
2541 opt->description(opt->get_description() + " DEPRECATED: please use '" + replacement + "' instead");
2542 }
2543}
2544
2545CLI11_INLINE void retire_option(App *app, Option *opt) {
2546 App temp;
2547 auto *option_copy = temp.add_option(opt->get_name(false, true))
2548 ->type_size(opt->get_type_size_min(), opt->get_type_size_max())
2549 ->expected(opt->get_expected_min(), opt->get_expected_max())
2550 ->allow_extra_args(opt->get_allow_extra_args());
2551
2552 app->remove_option(opt);
2553 auto *opt2 = app->add_option(option_copy->get_name(false, true), "option has been retired and has no effect");
2554 opt2->type_name("RETIRED")
2555 ->default_str("RETIRED")
2556 ->type_size(option_copy->get_type_size_min(), option_copy->get_type_size_max())
2557 ->expected(option_copy->get_expected_min(), option_copy->get_expected_max())
2558 ->allow_extra_args(option_copy->get_allow_extra_args());
2559
2560 // LCOV_EXCL_START
2561 // something odd with coverage on new compilers
2562 Validator retired_warning{[opt2](std::string &) {
2563 std::cout << "WARNING " << opt2->get_name() << " is retired and has no effect\n";
2564 return std::string();
2565 },
2566 ""};
2567 // LCOV_EXCL_STOP
2568 retired_warning.application_index(0);
2569 opt2->check(retired_warning);
2570}
2571
2572CLI11_INLINE void retire_option(App &app, Option *opt) { retire_option(&app, opt); }
2573
2574CLI11_INLINE void retire_option(App *app, const std::string &option_name) {
2575
2576 auto *opt = app->get_option_no_throw(option_name);
2577 if(opt != nullptr) {
2578 retire_option(app, opt);
2579 return;
2580 }
2581 auto *opt2 = app->add_option(option_name, "option has been retired and has no effect")
2582 ->type_name("RETIRED")
2583 ->expected(0, 1)
2584 ->default_str("RETIRED");
2585 // LCOV_EXCL_START
2586 // something odd with coverage on new compilers
2587 Validator retired_warning{[opt2](std::string &) {
2588 std::cout << "WARNING " << opt2->get_name() << " is retired and has no effect\n";
2589 return std::string();
2590 },
2591 ""};
2592 // LCOV_EXCL_STOP
2593 retired_warning.application_index(0);
2594 opt2->check(retired_warning);
2595}
2596
2597CLI11_INLINE void retire_option(App &app, const std::string &option_name) { retire_option(&app, option_name); }
2598
2599namespace FailureMessage {
2600
2601CLI11_INLINE std::string simple(const App *app, const Error &e) {
2602 std::string header = std::string(e.what()) + "\n";
2603 std::vector<std::string> names;
2604
2605 // Collect names
2606 if(app->get_help_ptr() != nullptr)
2607 names.push_back(app->get_help_ptr()->get_name());
2608
2609 if(app->get_help_all_ptr() != nullptr)
2610 names.push_back(app->get_help_all_ptr()->get_name());
2611
2612 // If any names found, suggest those
2613 if(!names.empty())
2614 header += "Run with " + detail::join(names, " or ") + " for more information.\n";
2615
2616 return header;
2617}
2618
2619CLI11_INLINE std::string help(const App *app, const Error &e) {
2620 std::string header = std::string("ERROR: ") + e.get_name() + ": " + e.what() + "\n";
2621 header += app->help();
2622 return header;
2623}
2624
2625} // namespace FailureMessage
2626
2627// [CLI11:app_inl_hpp:end]
2628} // namespace CLI
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:926
bool subcommand_fallthrough_
Allow subcommands to fallthrough, so that parent commands can trigger other subcommands after subcomm...
Definition App.hpp:257
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:704
CLI11_NODISCARD std::string help(std::string prev="", AppFormatMode mode=AppFormatMode::Normal) const
Definition App_inl.hpp:800
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:1074
CLI11_NODISCARD bool _has_remaining_positionals() const
Count the required remaining positional arguments.
Definition App_inl.hpp:1846
CLI11_NODISCARD detail::Classifier _recognize(const std::string &current, bool ignore_used_subcommands=true) const
Selects a Classifier enum based on the type of the current argument.
Definition App_inl.hpp:1187
App * immediate_callback(bool immediate=true)
Set the subcommand callback to be executed immediately on subcommand completion.
Definition App_inl.hpp:122
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:278
bool allow_non_standard_options_
indicator that the subcommand should allow non-standard option arguments, such as -single_dash_flag
Definition App.hpp:289
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:1222
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:444
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:2431
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:2354
std::size_t require_option_min_
Minimum required options (not inheritable!)
Definition App.hpp:304
NameMatch
enumeration of matching possibilities
Definition App.hpp:1292
App * ignore_underscore(bool value=true)
Ignore underscore. Subcommands inherit value.
Definition App_inl.hpp:148
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:1042
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:1068
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:555
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
void _process_requirements()
Verify required options and cross requirements. Subcommands too (only if selected).
Definition App_inl.hpp:1356
CLI11_NODISCARD std::size_t count_all() const
Definition App_inl.hpp:564
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:1201
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:311
bool remove_needs(Option *opt)
Removes an option from the needs list of this subcommand.
Definition App_inl.hpp:782
Option * get_help_ptr()
Get a pointer to the help flag.
Definition App.hpp:1246
void _configure()
Definition App_inl.hpp:1123
CLI11_NODISCARD std::size_t _count_remaining_positionals(bool required_only=false) const
Count the required remaining positional arguments.
Definition App_inl.hpp:1834
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:387
void parse(int argc, const char *const *argv)
Definition App_inl.hpp:594
void _process_config_file()
Read and process a configuration file (main app only)
Definition App_inl.hpp:1244
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:1544
CLI11_NODISCARD bool check_name(std::string name_to_check) const
Definition App_inl.hpp:986
CLI11_NODISCARD const Option * get_option(std::string option_name) const
Get an option by name.
Definition App_inl.hpp:897
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:1252
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:485
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:2336
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:530
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
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:926
Option * add_flag(std::string flag_name)
Add a flag with no description or variable assignment.
Definition App.hpp:691
void _validate() const
Definition App_inl.hpp:1088
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:1143
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:991
void _process_env()
Get envname options if not yet passed. Runs on all subcommands.
Definition App_inl.hpp:1280
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:1605
CLI11_NODISCARD std::string get_display_name(bool with_aliases=false) const
Get a display name for an app.
Definition App_inl.hpp:970
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:2376
void clear()
Reset the parsed data.
Definition App_inl.hpp:578
App * enabled_by_default(bool enable=true)
Definition App.hpp:455
App * get_subcommand(const App *subcom) const
Definition App_inl.hpp:501
CLI11_NODISCARD std::string version() const
Displays a version string.
Definition App_inl.hpp:814
CLI11_NODISCARD App * get_subcommand_no_throw(std::string subcom) const noexcept
Definition App_inl.hpp:517
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:1624
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
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:431
App(std::string app_description, std::string app_name, App *parent)
Special private constructor for subcommand.
Definition App_inl.hpp:30
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:454
App * preparse_callback(std::function< void(std::size_t)> pp_callback)
Definition App.hpp:391
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:370
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:1484
bool immediate_callback_
Definition App.hpp:155
bool _parse_single(std::vector< std::string > &args, bool &positional_only)
Definition App_inl.hpp:1785
App * name(std::string app_name="")
Set a name for the app (empty will use parser to set the name)
Definition App_inl.hpp:87
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:2454
void _process_extras()
Throw an error if anything is left over and should not be.
Definition App_inl.hpp:1523
CLI11_NODISCARD bool _valid_subcommand(const std::string &current, 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:1170
CLI11_NODISCARD PrefixCommandMode get_prefix_command_mode() const
Get the prefix command status.
Definition App.hpp:1204
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:1029
void _parse_config(const std::vector< ConfigItem > &args)
Definition App_inl.hpp:1616
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
ConfigExtrasMode allow_config_extras_
Definition App.hpp:136
bool _parse_positional(std::vector< std::string > &args, bool haltOnSubcommand)
Definition App_inl.hpp:1856
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:1176
bool _parse_arg(std::vector< std::string > &args, detail::Classifier current_type, bool local_processing_only)
Definition App_inl.hpp:2070
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
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:104
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:402
App * ignore_case(bool value=true)
Ignore case. Subcommands inherit value.
Definition App_inl.hpp:134
bool remove_excludes(Option *opt)
Removes an option from the excludes list of this subcommand.
Definition App_inl.hpp:762
CLI11_NODISCARD std::vector< App * > get_subcommands() const
Definition App.hpp:977
CLI11_NODISCARD config_extras_mode get_allow_config_extras() const
Get the status of allow extras.
Definition App.hpp:1241
bool _parse_subcommand(std::vector< std::string > &args)
Definition App_inl.hpp:2030
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:832
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:162
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:1552
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:1685
void _process_help_flags(CallbackPriority priority, bool trigger_help=false, bool trigger_all_help=false) const
Definition App_inl.hpp:1331
startup_mode default_startup
Definition App.hpp:273
void _process_callbacks(CallbackPriority priority)
Process callbacks. Runs on all subcommands.
Definition App_inl.hpp:1302
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:65
CLI11_NODISCARD App * _find_subcommand(const std::string &subc_name, bool ignore_disabled, bool ignore_used) const noexcept
Definition App_inl.hpp:1994
CLI11_NODISCARD const std::string & get_name() const
Get the name of the current app.
Definition App.hpp:1273
App * disabled(bool disable=true)
Disable the subcommand or option group.
Definition App.hpp:421
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:294
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
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 too many positionals or options are found.
Definition Error.hpp:308
Thrown when parsing an INI file and it is missing.
Definition Error.hpp:198
Definition Error.hpp:343
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 CallbackPriority get_callback_priority() const
The priority of callback.
Definition Option.hpp:161
CLI11_NODISCARD bool get_required() const
True if this is a required option.
Definition Option.hpp:137
CRTP * configurable(bool value=true)
Allow in a configuration file.
Definition Option.hpp:202
CLI11_NODISCARD MultiOptionPolicy get_multi_option_policy() const
The status of the multi option policy.
Definition Option.hpp:158
CLI11_NODISCARD bool get_configurable() const
The status of configurable.
Definition Option.hpp:146
bool required_
True if this is a required option.
Definition Option.hpp:76
CLI11_NODISCARD bool get_disable_flag_override() const
The status of configurable.
Definition Option.hpp:149
CLI11_NODISCARD const std::string & get_group() const
Get the group of this option.
Definition Option.hpp:134
void copy_to(T *other) const
Copy the contents to another similar class (one based on OptionBase)
Definition Option_inl.hpp:25
CRTP * required(bool value=true)
Set the option as required.
Definition Option.hpp:118
Definition Option.hpp:259
Option * expected(int value)
Set the number of expected arguments.
Definition Option_inl.hpp:38
CLI11_NODISCARD bool get_positional() const
True if the argument can be given directly.
Definition Option.hpp:628
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:382
@ callback_run
the callback has been executed
Option * callback_priority(CallbackPriority value=CallbackPriority::Normal)
Definition Option.hpp:448
std::set< Option * > needs_
A list of options that are required with this option.
Definition Option.hpp:326
void run_callback()
Process the callback.
Definition Option_inl.hpp:311
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:258
CLI11_NODISCARD bool check_sname(std::string name) const
Requires "-" to be removed from string.
Definition Option.hpp:683
std::set< Option * > excludes_
A list of options that are excluded with this option.
Definition Option.hpp:329
bool force_callback_
flag indicating that the option should force the callback regardless if any results present
Definition Option.hpp:369
CLI11_NODISCARD bool get_callback_run() const
See if the callback has been run already.
Definition Option.hpp:768
std::vector< std::string > fnames_
a list of flag names with specified default values;
Definition Option.hpp:278
CLI11_NODISCARD int get_items_expected_min() const
The total min number of expected string values to be used.
Definition Option.hpp:617
CLI11_NODISCARD bool check_lname(std::string name) const
Requires "--" to be removed from string.
Definition Option.hpp:688
CLI11_NODISCARD const results_t & results() const
Get the current complete results set.
Definition Option.hpp:714
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:620
CLI11_NODISCARD std::size_t count() const
Count the total number of times an option was passed.
Definition Option.hpp:389
Option * multi_option_policy(MultiOptionPolicy value=MultiOptionPolicy::Throw)
Take the last argument if given multiple times (or another policy)
Definition Option_inl.hpp:244
CLI11_NODISCARD bool get_inject_separator() const
Return the inject_separator flag.
Definition Option.hpp:570
CLI11_NODISCARD std::string get_flag_value(const std::string &name, std::string input_value) const
Definition Option_inl.hpp:411
CLI11_NODISCARD const std::string & get_description() const
Get the description.
Definition Option.hpp:637
CLI11_NODISCARD bool empty() const
True if the option was not passed.
Definition Option.hpp:392
CLI11_NODISCARD int get_expected_min() const
The number of times the option expects to be included.
Definition Option.hpp:612
void clear()
Clear the parsed results (mostly for testing)
Definition Option.hpp:398
CLI11_NODISCARD int get_expected_max() const
The max number of times the option expects to be included.
Definition Option.hpp:614
Option * default_str(std::string val)
Set the default value string representation (does not change the contained value)
Definition Option.hpp:810
std::string envname_
If given, check the environment for this option.
Definition Option.hpp:284
CLI11_NODISCARD bool get_allow_extra_args() const
Get the current value of allow extra args.
Definition Option.hpp:420
std::vector< std::pair< std::string, std::string > > default_flag_values_
Definition Option.hpp:275
Option * add_result(std::string s)
Puts a result at the end.
Definition Option_inl.hpp:457
CLI11_NODISCARD T as() const
Return the results as the specified type.
Definition Option.hpp:761
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:34
std::vector< std::string > inputs
Listing of inputs.
Definition ConfigFwd.hpp:41
std::string name
This is the name.
Definition ConfigFwd.hpp:39
CLI11_NODISCARD std::string fullname() const
The list of parents and name joined by ".".
Definition ConfigFwd.hpp:45
bool multiline
indicator if a multiline vector separator was inserted
Definition ConfigFwd.hpp:43
std::vector< std::string > parents
This is the list of parents.
Definition ConfigFwd.hpp:36