CLI11
C++11 Command Line Interface Parser
Loading...
Searching...
No Matches
App_inl.hpp
1// Copyright (c) 2017-2025, 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);
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);
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);
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);
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();
584 parsed_subcommands_.clear();
585 for(const Option_p &opt : options_) {
586 opt->clear();
587 }
588 for(const App_p &subc : subcommands_) {
589 subc->clear();
590 }
591}
592
593CLI11_INLINE void App::parse(int argc, const char *const *argv) { parse_char_t(argc, argv); }
594CLI11_INLINE void App::parse(int argc, const wchar_t *const *argv) { parse_char_t(argc, argv); }
595
596namespace detail {
597
598// Do nothing or perform narrowing
599CLI11_INLINE const char *maybe_narrow(const char *str) { return str; }
600CLI11_INLINE std::string maybe_narrow(const wchar_t *str) { return narrow(str); }
601
602} // namespace detail
603
604template <class CharT> CLI11_INLINE void App::parse_char_t(int argc, const CharT *const *argv) {
605 // If the name is not set, read from command line
606 if(name_.empty() || has_automatic_name_) {
607 has_automatic_name_ = true;
608 name_ = detail::maybe_narrow(argv[0]);
609 }
610
611 std::vector<std::string> args;
612 args.reserve(static_cast<std::size_t>(argc) - 1U);
613 for(auto i = static_cast<std::size_t>(argc) - 1U; i > 0U; --i)
614 args.emplace_back(detail::maybe_narrow(argv[i]));
615
616 parse(std::move(args));
617}
618
619CLI11_INLINE void App::parse(std::string commandline, bool program_name_included) {
620
621 if(program_name_included) {
622 auto nstr = detail::split_program_name(commandline);
623 if((name_.empty()) || (has_automatic_name_)) {
624 has_automatic_name_ = true;
625 name_ = nstr.first;
626 }
627 commandline = std::move(nstr.second);
628 } else {
629 detail::trim(commandline);
630 }
631 // the next section of code is to deal with quoted arguments after an '=' or ':' for windows like operations
632 if(!commandline.empty()) {
633 commandline = detail::find_and_modify(commandline, "=", detail::escape_detect);
635 commandline = detail::find_and_modify(commandline, ":", detail::escape_detect);
636 }
637
638 auto args = detail::split_up(std::move(commandline));
639 // remove all empty strings
640 args.erase(std::remove(args.begin(), args.end(), std::string{}), args.end());
641 try {
642 detail::remove_quotes(args);
643 } catch(const std::invalid_argument &arg) {
644 throw CLI::ParseError(arg.what(), CLI::ExitCodes::InvalidError);
645 }
646 std::reverse(args.begin(), args.end());
647 parse(std::move(args));
648}
649
650CLI11_INLINE void App::parse(std::wstring commandline, bool program_name_included) {
651 parse(narrow(commandline), program_name_included);
652}
653
654CLI11_INLINE void App::parse(std::vector<std::string> &args) {
655 // Clear if parsed
656 if(parsed_ > 0)
657 clear();
658
659 // parsed_ is incremented in commands/subcommands,
660 // but placed here to make sure this is cleared when
661 // running parse after an error is thrown, even by _validate or _configure.
662 parsed_ = 1;
663 _validate();
664 _configure();
665 // set the parent as nullptr as this object should be the top now
666 parent_ = nullptr;
667 parsed_ = 0;
668
669 _parse(args);
670 run_callback();
671}
672
673CLI11_INLINE void App::parse(std::vector<std::string> &&args) {
674 // Clear if parsed
675 if(parsed_ > 0)
676 clear();
677
678 // parsed_ is incremented in commands/subcommands,
679 // but placed here to make sure this is cleared when
680 // running parse after an error is thrown, even by _validate or _configure.
681 parsed_ = 1;
682 _validate();
683 _configure();
684 // set the parent as nullptr as this object should be the top now
685 parent_ = nullptr;
686 parsed_ = 0;
687
688 _parse(std::move(args));
689 run_callback();
690}
691
692CLI11_INLINE void App::parse_from_stream(std::istream &input) {
693 if(parsed_ == 0) {
694 _validate();
695 _configure();
696 // set the parent as nullptr as this object should be the top now
697 }
698
699 _parse_stream(input);
700 run_callback();
701}
702
703CLI11_INLINE int App::exit(const Error &e, std::ostream &out, std::ostream &err) const {
704
706 if(e.get_name() == "RuntimeError")
707 return e.get_exit_code();
708
709 if(e.get_name() == "CallForHelp") {
710 out << help();
711 return e.get_exit_code();
712 }
713
714 if(e.get_name() == "CallForAllHelp") {
715 out << help("", AppFormatMode::All);
716 return e.get_exit_code();
717 }
718
719 if(e.get_name() == "CallForVersion") {
720 out << e.what() << '\n';
721 return e.get_exit_code();
722 }
723
724 if(e.get_exit_code() != static_cast<int>(ExitCodes::Success)) {
726 err << failure_message_(this, e) << std::flush;
727 }
728
729 return e.get_exit_code();
730}
731
732CLI11_INLINE std::vector<const App *> App::get_subcommands(const std::function<bool(const App *)> &filter) const {
733 std::vector<const App *> subcomms(subcommands_.size());
734 std::transform(
735 std::begin(subcommands_), std::end(subcommands_), std::begin(subcomms), [](const App_p &v) { return v.get(); });
736
737 if(filter) {
738 subcomms.erase(std::remove_if(std::begin(subcomms),
739 std::end(subcomms),
740 [&filter](const App *app) { return !filter(app); }),
741 std::end(subcomms));
742 }
743
744 return subcomms;
745}
746
747CLI11_INLINE std::vector<App *> App::get_subcommands(const std::function<bool(App *)> &filter) {
748 std::vector<App *> subcomms(subcommands_.size());
749 std::transform(
750 std::begin(subcommands_), std::end(subcommands_), std::begin(subcomms), [](const App_p &v) { return v.get(); });
751
752 if(filter) {
753 subcomms.erase(
754 std::remove_if(std::begin(subcomms), std::end(subcomms), [&filter](App *app) { return !filter(app); }),
755 std::end(subcomms));
756 }
757
758 return subcomms;
759}
760
761CLI11_INLINE bool App::remove_excludes(Option *opt) {
762 auto iterator = std::find(std::begin(exclude_options_), std::end(exclude_options_), opt);
763 if(iterator == std::end(exclude_options_)) {
764 return false;
765 }
766 exclude_options_.erase(iterator);
767 return true;
768}
769
770CLI11_INLINE bool App::remove_excludes(App *app) {
771 auto iterator = std::find(std::begin(exclude_subcommands_), std::end(exclude_subcommands_), app);
772 if(iterator == std::end(exclude_subcommands_)) {
773 return false;
774 }
775 auto *other_app = *iterator;
776 exclude_subcommands_.erase(iterator);
777 other_app->remove_excludes(this);
778 return true;
779}
780
781CLI11_INLINE bool App::remove_needs(Option *opt) {
782 auto iterator = std::find(std::begin(need_options_), std::end(need_options_), opt);
783 if(iterator == std::end(need_options_)) {
784 return false;
785 }
786 need_options_.erase(iterator);
787 return true;
788}
789
790CLI11_INLINE bool App::remove_needs(App *app) {
791 auto iterator = std::find(std::begin(need_subcommands_), std::end(need_subcommands_), app);
792 if(iterator == std::end(need_subcommands_)) {
793 return false;
794 }
795 need_subcommands_.erase(iterator);
796 return true;
797}
798
799CLI11_NODISCARD CLI11_INLINE std::string App::help(std::string prev, AppFormatMode mode) const {
800 if(prev.empty())
801 prev = get_name();
802 else
803 prev += " " + get_name();
804
805 // Delegate to subcommand if needed
806 auto selected_subcommands = get_subcommands();
807 if(!selected_subcommands.empty()) {
808 return selected_subcommands.back()->help(prev, mode);
809 }
810 return formatter_->make_help(this, prev, mode);
811}
812
813CLI11_NODISCARD CLI11_INLINE std::string App::version() const {
814 std::string val;
815 if(version_ptr_ != nullptr) {
816 // copy the results for reuse later
817 results_t rv = version_ptr_->results();
819 version_ptr_->add_result("true");
820 try {
822 } catch(const CLI::CallForVersion &cfv) {
823 val = cfv.what();
824 }
827 }
828 return val;
829}
830
831CLI11_INLINE std::vector<const Option *> App::get_options(const std::function<bool(const Option *)> filter) const {
832 std::vector<const Option *> options(options_.size());
833 std::transform(
834 std::begin(options_), std::end(options_), std::begin(options), [](const Option_p &val) { return val.get(); });
835
836 if(filter) {
837 options.erase(std::remove_if(std::begin(options),
838 std::end(options),
839 [&filter](const Option *opt) { return !filter(opt); }),
840 std::end(options));
841 }
842 for(const auto &subcp : subcommands_) {
843 // also check down into nameless subcommands
844 const App *subc = subcp.get();
845 if(subc->get_name().empty() && !subc->get_group().empty() && subc->get_group().front() == '+') {
846 std::vector<const Option *> subcopts = subc->get_options(filter);
847 options.insert(options.end(), subcopts.begin(), subcopts.end());
848 }
849 }
850 return options;
851}
852
853CLI11_INLINE std::vector<Option *> App::get_options(const std::function<bool(Option *)> filter) {
854 std::vector<Option *> options(options_.size());
855 std::transform(
856 std::begin(options_), std::end(options_), std::begin(options), [](const Option_p &val) { return val.get(); });
857
858 if(filter) {
859 options.erase(
860 std::remove_if(std::begin(options), std::end(options), [&filter](Option *opt) { return !filter(opt); }),
861 std::end(options));
862 }
863 for(auto &subc : subcommands_) {
864 // also check down into nameless subcommands and specific groups
865 if(subc->get_name().empty() || (!subc->get_group().empty() && subc->get_group().front() == '+')) {
866 auto subcopts = subc->get_options(filter);
867 options.insert(options.end(), subcopts.begin(), subcopts.end());
868 }
869 }
870 return options;
871}
872
873CLI11_NODISCARD CLI11_INLINE Option *App::get_option_no_throw(std::string option_name) noexcept {
874 for(Option_p &opt : options_) {
875 if(opt->check_name(option_name)) {
876 return opt.get();
877 }
878 }
879 for(auto &subc : subcommands_) {
880 // also check down into nameless subcommands
881 if(subc->get_name().empty()) {
882 auto *opt = subc->get_option_no_throw(option_name);
883 if(opt != nullptr) {
884 return opt;
885 }
886 }
887 }
888 return nullptr;
889}
890
891CLI11_NODISCARD CLI11_INLINE const Option *App::get_option_no_throw(std::string option_name) const noexcept {
892 for(const Option_p &opt : options_) {
893 if(opt->check_name(option_name)) {
894 return opt.get();
895 }
896 }
897 for(const auto &subc : subcommands_) {
898 // also check down into nameless subcommands
899 if(subc->get_name().empty()) {
900 auto *opt = subc->get_option_no_throw(option_name);
901 if(opt != nullptr) {
902 return opt;
903 }
904 }
905 }
906 return nullptr;
907}
908
909CLI11_NODISCARD CLI11_INLINE std::string App::get_display_name(bool with_aliases) const {
910 if(name_.empty()) {
911 return std::string("[Option Group: ") + get_group() + "]";
912 }
913 if(aliases_.empty() || !with_aliases) {
914 return name_;
915 }
916 std::string dispname = name_;
917 for(const auto &lalias : aliases_) {
918 dispname.push_back(',');
919 dispname.push_back(' ');
920 dispname.append(lalias);
921 }
922 return dispname;
923}
924
925CLI11_NODISCARD CLI11_INLINE bool App::check_name(std::string name_to_check) const {
926 auto result = check_name_detail(std::move(name_to_check));
927 return (result != NameMatch::none);
928}
929
930CLI11_NODISCARD CLI11_INLINE App::NameMatch App::check_name_detail(std::string name_to_check) const {
931 std::string local_name = name_;
933 local_name = detail::remove_underscore(name_);
934 name_to_check = detail::remove_underscore(name_to_check);
935 }
936 if(ignore_case_) {
937 local_name = detail::to_lower(name_);
938 name_to_check = detail::to_lower(name_to_check);
939 }
940
941 if(local_name == name_to_check) {
942 return App::NameMatch::exact;
943 }
944 if(allow_prefix_matching_ && name_to_check.size() < local_name.size()) {
945 if(local_name.compare(0, name_to_check.size(), name_to_check) == 0) {
946 return App::NameMatch::prefix;
947 }
948 }
949 for(std::string les : aliases_) { // NOLINT(performance-for-range-copy)
951 les = detail::remove_underscore(les);
952 }
953 if(ignore_case_) {
954 les = detail::to_lower(les);
955 }
956 if(les == name_to_check) {
957 return App::NameMatch::exact;
958 }
959 if(allow_prefix_matching_ && name_to_check.size() < les.size()) {
960 if(les.compare(0, name_to_check.size(), name_to_check) == 0) {
961 return App::NameMatch::prefix;
962 }
963 }
964 }
965 return App::NameMatch::none;
966}
967
968CLI11_NODISCARD CLI11_INLINE std::vector<std::string> App::get_groups() const {
969 std::vector<std::string> groups;
970
971 for(const Option_p &opt : options_) {
972 // Add group if it is not already in there
973 if(std::find(groups.begin(), groups.end(), opt->get_group()) == groups.end()) {
974 groups.push_back(opt->get_group());
975 }
976 }
977
978 return groups;
979}
980
981CLI11_NODISCARD CLI11_INLINE std::vector<std::string> App::remaining(bool recurse) const {
982 std::vector<std::string> miss_list;
983 for(const std::pair<detail::Classifier, std::string> &miss : missing_) {
984 miss_list.push_back(std::get<1>(miss));
985 }
986 // Get from a subcommand that may allow extras
987 if(recurse) {
988 if(!allow_extras_) {
989 for(const auto &sub : subcommands_) {
990 if(sub->name_.empty() && !sub->missing_.empty()) {
991 for(const std::pair<detail::Classifier, std::string> &miss : sub->missing_) {
992 miss_list.push_back(std::get<1>(miss));
993 }
994 }
995 }
996 }
997 // Recurse into subcommands
998
999 for(const App *sub : parsed_subcommands_) {
1000 std::vector<std::string> output = sub->remaining(recurse);
1001 std::copy(std::begin(output), std::end(output), std::back_inserter(miss_list));
1002 }
1003 }
1004 return miss_list;
1005}
1006
1007CLI11_NODISCARD CLI11_INLINE std::vector<std::string> App::remaining_for_passthrough(bool recurse) const {
1008 std::vector<std::string> miss_list = remaining(recurse);
1009 std::reverse(std::begin(miss_list), std::end(miss_list));
1010 return miss_list;
1011}
1012
1013CLI11_NODISCARD CLI11_INLINE std::size_t App::remaining_size(bool recurse) const {
1014 auto remaining_options = static_cast<std::size_t>(std::count_if(
1015 std::begin(missing_), std::end(missing_), [](const std::pair<detail::Classifier, std::string> &val) {
1016 return val.first != detail::Classifier::POSITIONAL_MARK;
1017 }));
1018
1019 if(recurse) {
1020 for(const App_p &sub : subcommands_) {
1021 remaining_options += sub->remaining_size(recurse);
1022 }
1023 }
1024 return remaining_options;
1025}
1026
1027CLI11_INLINE void App::_validate() const {
1028 // count the number of positional only args
1029 auto pcount = std::count_if(std::begin(options_), std::end(options_), [](const Option_p &opt) {
1030 return opt->get_items_expected_max() >= detail::expected_max_vector_size && !opt->nonpositional();
1031 });
1032 if(pcount > 1) {
1033 auto pcount_req = std::count_if(std::begin(options_), std::end(options_), [](const Option_p &opt) {
1034 return opt->get_items_expected_max() >= detail::expected_max_vector_size && !opt->nonpositional() &&
1035 opt->get_required();
1036 });
1037 if(pcount - pcount_req > 1) {
1038 throw InvalidError(name_);
1039 }
1040 }
1041
1042 std::size_t nameless_subs{0};
1043 for(const App_p &app : subcommands_) {
1044 app->_validate();
1045 if(app->get_name().empty())
1046 ++nameless_subs;
1047 }
1048
1049 if(require_option_min_ > 0) {
1050 if(require_option_max_ > 0) {
1052 throw(InvalidError("Required min options greater than required max options", ExitCodes::InvalidError));
1053 }
1054 }
1055 if(require_option_min_ > (options_.size() + nameless_subs)) {
1056 throw(
1057 InvalidError("Required min options greater than number of available options", ExitCodes::InvalidError));
1058 }
1059 }
1060}
1061
1062CLI11_INLINE void App::_configure() {
1063 if(default_startup == startup_mode::enabled) {
1064 disabled_ = false;
1065 } else if(default_startup == startup_mode::disabled) {
1066 disabled_ = true;
1067 }
1068 for(const App_p &app : subcommands_) {
1069 if(app->has_automatic_name_) {
1070 app->name_.clear();
1071 }
1072 if(app->name_.empty()) {
1073 app->fallthrough_ = false; // make sure fallthrough_ is false to prevent infinite loop
1074 app->prefix_command_ = false;
1075 }
1076 // make sure the parent is set to be this object in preparation for parse
1077 app->parent_ = this;
1078 app->_configure();
1079 }
1080}
1081
1082CLI11_INLINE void App::run_callback(bool final_mode, bool suppress_final_callback) {
1083 pre_callback();
1084 // in the main app if immediate_callback_ is set it runs the main callback before the used subcommands
1085 if(!final_mode && parse_complete_callback_) {
1087 }
1088 // run the callbacks for the received subcommands
1089 for(App *subc : get_subcommands()) {
1090 if(subc->parent_ == this) {
1091 subc->run_callback(true, suppress_final_callback);
1092 }
1093 }
1094 // now run callbacks for option_groups
1095 for(auto &subc : subcommands_) {
1096 if(subc->name_.empty() && subc->count_all() > 0) {
1097 subc->run_callback(true, suppress_final_callback);
1098 }
1099 }
1100
1101 // finally run the main callback
1102 if(final_callback_ && (parsed_ > 0) && (!suppress_final_callback)) {
1103 if(!name_.empty() || count_all() > 0 || parent_ == nullptr) {
1105 }
1106 }
1107}
1108
1109CLI11_NODISCARD CLI11_INLINE bool App::_valid_subcommand(const std::string &current, bool ignore_used) const {
1110 // Don't match if max has been reached - but still check parents
1113 return parent_ != nullptr && parent_->_valid_subcommand(current, ignore_used);
1114 }
1115 auto *com = _find_subcommand(current, true, ignore_used);
1116 if(com != nullptr) {
1117 return true;
1118 }
1119 // Check parent if exists, else return false
1121 return parent_ != nullptr && parent_->_valid_subcommand(current, ignore_used);
1122 }
1123 return false;
1124}
1125
1126CLI11_NODISCARD CLI11_INLINE detail::Classifier App::_recognize(const std::string &current,
1127 bool ignore_used_subcommands) const {
1128 std::string dummy1, dummy2;
1129
1130 if(current == "--")
1131 return detail::Classifier::POSITIONAL_MARK;
1132 if(_valid_subcommand(current, ignore_used_subcommands))
1133 return detail::Classifier::SUBCOMMAND;
1134 if(detail::split_long(current, dummy1, dummy2))
1135 return detail::Classifier::LONG;
1136 if(detail::split_short(current, dummy1, dummy2)) {
1137 if((dummy1[0] >= '0' && dummy1[0] <= '9') ||
1138 (dummy1[0] == '.' && !dummy2.empty() && (dummy2[0] >= '0' && dummy2[0] <= '9'))) {
1139 // it looks like a number but check if it could be an option
1140 if(get_option_no_throw(std::string{'-', dummy1[0]}) == nullptr) {
1141 return detail::Classifier::NONE;
1142 }
1143 }
1144 return detail::Classifier::SHORT;
1145 }
1146 if((allow_windows_style_options_) && (detail::split_windows_style(current, dummy1, dummy2)))
1147 return detail::Classifier::WINDOWS_STYLE;
1148 if((current == "++") && !name_.empty() && parent_ != nullptr)
1149 return detail::Classifier::SUBCOMMAND_TERMINATOR;
1150 auto dotloc = current.find_first_of('.');
1151 if(dotloc != std::string::npos) {
1152 auto *cm = _find_subcommand(current.substr(0, dotloc), true, ignore_used_subcommands);
1153 if(cm != nullptr) {
1154 auto res = cm->_recognize(current.substr(dotloc + 1), ignore_used_subcommands);
1155 if(res == detail::Classifier::SUBCOMMAND) {
1156 return res;
1157 }
1158 }
1159 }
1160 return detail::Classifier::NONE;
1161}
1162
1163CLI11_INLINE bool App::_process_config_file(const std::string &config_file, bool throw_error) {
1164 auto path_result = detail::check_path(config_file.c_str());
1165 if(path_result == detail::path_type::file) {
1166 try {
1167 std::vector<ConfigItem> values = config_formatter_->from_file(config_file);
1168 _parse_config(values);
1169 return true;
1170 } catch(const FileError &) {
1171 if(throw_error) {
1172 throw;
1173 }
1174 return false;
1175 }
1176 } else if(throw_error) {
1177 throw FileError::Missing(config_file);
1178 } else {
1179 return false;
1180 }
1181}
1182
1183CLI11_INLINE void App::_process_config_file() {
1184 if(config_ptr_ != nullptr) {
1185 bool config_required = config_ptr_->get_required();
1186 auto file_given = config_ptr_->count() > 0;
1187 if(!(file_given || config_ptr_->envname_.empty())) {
1188 std::string ename_string = detail::get_environment_value(config_ptr_->envname_);
1189 if(!ename_string.empty()) {
1190 config_ptr_->add_result(ename_string);
1191 }
1192 }
1194
1195 auto config_files = config_ptr_->as<std::vector<std::string>>();
1196 bool files_used{file_given};
1197 if(config_files.empty() || config_files.front().empty()) {
1198 if(config_required) {
1199 throw FileError("config file is required but none was given");
1200 }
1201 return;
1202 }
1203 for(const auto &config_file : config_files) {
1204 if(_process_config_file(config_file, config_required || file_given)) {
1205 files_used = true;
1206 }
1207 }
1208 if(!files_used) {
1209 // this is done so the count shows as 0 if no callbacks were processed
1210 config_ptr_->clear();
1211 bool force = config_ptr_->force_callback_;
1215 }
1216 }
1217}
1218
1219CLI11_INLINE void App::_process_env() {
1220 for(const Option_p &opt : options_) {
1221 if(opt->count() == 0 && !opt->envname_.empty()) {
1222 std::string ename_string = detail::get_environment_value(opt->envname_);
1223 if(!ename_string.empty()) {
1224 std::string result = ename_string;
1225 result = opt->_validate(result, 0);
1226 if(result.empty()) {
1227 opt->add_result(ename_string);
1228 }
1229 }
1230 }
1231 }
1232
1233 for(App_p &sub : subcommands_) {
1234 if(sub->get_name().empty() || (sub->count_all() > 0 && !sub->parse_complete_callback_)) {
1235 // only process environment variables if the callback has actually been triggered already
1236 sub->_process_env();
1237 }
1238 }
1239}
1240
1241CLI11_INLINE void App::_process_callbacks() {
1242
1243 for(App_p &sub : subcommands_) {
1244 // process the priority option_groups first
1245 if(sub->get_name().empty() && sub->parse_complete_callback_) {
1246 if(sub->count_all() > 0) {
1247 sub->_process_callbacks();
1248 sub->run_callback();
1249 }
1250 }
1251 }
1252
1253 for(const Option_p &opt : options_) {
1254 if((*opt) && !opt->get_callback_run()) {
1255 opt->run_callback();
1256 }
1257 }
1258 for(App_p &sub : subcommands_) {
1259 if(!sub->parse_complete_callback_) {
1260 sub->_process_callbacks();
1261 }
1262 }
1263}
1264
1265CLI11_INLINE void App::_process_help_flags(bool trigger_help, bool trigger_all_help) const {
1266 const Option *help_ptr = get_help_ptr();
1267 const Option *help_all_ptr = get_help_all_ptr();
1268
1269 if(help_ptr != nullptr && help_ptr->count() > 0)
1270 trigger_help = true;
1271 if(help_all_ptr != nullptr && help_all_ptr->count() > 0)
1272 trigger_all_help = true;
1273
1274 // If there were parsed subcommands, call those. First subcommand wins if there are multiple ones.
1275 if(!parsed_subcommands_.empty()) {
1276 for(const App *sub : parsed_subcommands_)
1277 sub->_process_help_flags(trigger_help, trigger_all_help);
1278
1279 // Only the final subcommand should call for help. All help wins over help.
1280 } else if(trigger_all_help) {
1281 throw CallForAllHelp();
1282 } else if(trigger_help) {
1283 throw CallForHelp();
1284 }
1285}
1286
1287CLI11_INLINE void App::_process_requirements() {
1288 // check excludes
1289 bool excluded{false};
1290 std::string excluder;
1291 for(const auto &opt : exclude_options_) {
1292 if(opt->count() > 0) {
1293 excluded = true;
1294 excluder = opt->get_name();
1295 }
1296 }
1297 for(const auto &subc : exclude_subcommands_) {
1298 if(subc->count_all() > 0) {
1299 excluded = true;
1300 excluder = subc->get_display_name();
1301 }
1302 }
1303 if(excluded) {
1304 if(count_all() > 0) {
1305 throw ExcludesError(get_display_name(), excluder);
1306 }
1307 // if we are excluded but didn't receive anything, just return
1308 return;
1309 }
1310
1311 // check excludes
1312 bool missing_needed{false};
1313 std::string missing_need;
1314 for(const auto &opt : need_options_) {
1315 if(opt->count() == 0) {
1316 missing_needed = true;
1317 missing_need = opt->get_name();
1318 }
1319 }
1320 for(const auto &subc : need_subcommands_) {
1321 if(subc->count_all() == 0) {
1322 missing_needed = true;
1323 missing_need = subc->get_display_name();
1324 }
1325 }
1326 if(missing_needed) {
1327 if(count_all() > 0) {
1328 throw RequiresError(get_display_name(), missing_need);
1329 }
1330 // if we missing something but didn't have any options, just return
1331 return;
1332 }
1333
1334 std::size_t used_options = 0;
1335 for(const Option_p &opt : options_) {
1336
1337 if(opt->count() != 0) {
1338 ++used_options;
1339 }
1340 // Required but empty
1341 if(opt->get_required() && opt->count() == 0) {
1342 throw RequiredError(opt->get_name());
1343 }
1344 // Requires
1345 for(const Option *opt_req : opt->needs_)
1346 if(opt->count() > 0 && opt_req->count() == 0)
1347 throw RequiresError(opt->get_name(), opt_req->get_name());
1348 // Excludes
1349 for(const Option *opt_ex : opt->excludes_)
1350 if(opt->count() > 0 && opt_ex->count() != 0)
1351 throw ExcludesError(opt->get_name(), opt_ex->get_name());
1352 }
1353 // check for the required number of subcommands
1354 if(require_subcommand_min_ > 0) {
1355 auto selected_subcommands = get_subcommands();
1356 if(require_subcommand_min_ > selected_subcommands.size())
1357 throw RequiredError::Subcommand(require_subcommand_min_);
1358 }
1359
1360 // Max error cannot occur, the extra subcommand will parse as an ExtrasError or a remaining item.
1361
1362 // run this loop to check how many unnamed subcommands were actually used since they are considered options
1363 // from the perspective of an App
1364 for(App_p &sub : subcommands_) {
1365 if(sub->disabled_)
1366 continue;
1367 if(sub->name_.empty() && sub->count_all() > 0) {
1368 ++used_options;
1369 }
1370 }
1371
1372 if(require_option_min_ > used_options || (require_option_max_ > 0 && require_option_max_ < used_options)) {
1373 auto option_list = detail::join(options_, [this](const Option_p &ptr) {
1374 if(ptr.get() == help_ptr_ || ptr.get() == help_all_ptr_) {
1375 return std::string{};
1376 }
1377 return ptr->get_name(false, true);
1378 });
1379
1380 auto subc_list = get_subcommands([](App *app) { return ((app->get_name().empty()) && (!app->disabled_)); });
1381 if(!subc_list.empty()) {
1382 option_list += "," + detail::join(subc_list, [](const App *app) { return app->get_display_name(); });
1383 }
1384 throw RequiredError::Option(require_option_min_, require_option_max_, used_options, option_list);
1385 }
1386
1387 // now process the requirements for subcommands if needed
1388 for(App_p &sub : subcommands_) {
1389 if(sub->disabled_)
1390 continue;
1391 if(sub->name_.empty() && sub->required_ == false) {
1392 if(sub->count_all() == 0) {
1393 if(require_option_min_ > 0 && require_option_min_ <= used_options) {
1394 continue;
1395 // if we have met the requirement and there is nothing in this option group skip checking
1396 // requirements
1397 }
1398 if(require_option_max_ > 0 && used_options >= require_option_min_) {
1399 continue;
1400 // if we have met the requirement and there is nothing in this option group skip checking
1401 // requirements
1402 }
1403 }
1404 }
1405 if(sub->count() > 0 || sub->name_.empty()) {
1406 sub->_process_requirements();
1407 }
1408
1409 if(sub->required_ && sub->count_all() == 0) {
1410 throw(CLI::RequiredError(sub->get_display_name()));
1411 }
1412 }
1413}
1414
1415CLI11_INLINE void App::_process() {
1416 // help takes precedence over other potential errors and config and environment shouldn't be processed if help
1417 // throws
1419 std::exception_ptr config_exception;
1420 try {
1421 // the config file might generate a FileError but that should not be processed until later in the process
1422 // to allow for help, version and other errors to generate first.
1424
1425 // process env shouldn't throw but no reason to process it if config generated an error
1426 _process_env();
1427 } catch(const CLI::FileError &) {
1428 config_exception = std::current_exception();
1429 }
1430 // callbacks and requirements processing can generate exceptions which should take priority
1431 // over the config file error if one exists.
1433
1435
1436 if(config_exception) {
1437 std::rethrow_exception(config_exception);
1438 }
1439}
1440
1441CLI11_INLINE void App::_process_extras() {
1442 if(!(allow_extras_ || prefix_command_)) {
1443 std::size_t num_left_over = remaining_size();
1444 if(num_left_over > 0) {
1445 throw ExtrasError(name_, remaining(false));
1446 }
1447 }
1448
1449 for(App_p &sub : subcommands_) {
1450 if(sub->count() > 0)
1451 sub->_process_extras();
1452 }
1453}
1454
1455CLI11_INLINE void App::_process_extras(std::vector<std::string> &args) {
1456 if(!(allow_extras_ || prefix_command_)) {
1457 std::size_t num_left_over = remaining_size();
1458 if(num_left_over > 0) {
1459 args = remaining(false);
1460 throw ExtrasError(name_, args);
1461 }
1462 }
1463
1464 for(App_p &sub : subcommands_) {
1465 if(sub->count() > 0)
1466 sub->_process_extras(args);
1467 }
1468}
1469
1470CLI11_INLINE void App::increment_parsed() {
1471 ++parsed_;
1472 for(App_p &sub : subcommands_) {
1473 if(sub->get_name().empty())
1474 sub->increment_parsed();
1475 }
1476}
1477
1478CLI11_INLINE void App::_parse(std::vector<std::string> &args) {
1480 _trigger_pre_parse(args.size());
1481 bool positional_only = false;
1482
1483 while(!args.empty()) {
1484 if(!_parse_single(args, positional_only)) {
1485 break;
1486 }
1487 }
1488
1489 if(parent_ == nullptr) {
1490 _process();
1491
1492 // Throw error if any items are left over (depending on settings)
1493 _process_extras(args);
1494
1495 // Convert missing (pairs) to extras (string only) ready for processing in another app
1496 args = remaining_for_passthrough(false);
1497 } else if(parse_complete_callback_) {
1498 _process_env();
1502 run_callback(false, true);
1503 }
1504}
1505
1506CLI11_INLINE void App::_parse(std::vector<std::string> &&args) {
1507 // this can only be called by the top level in which case parent == nullptr by definition
1508 // operation is simplified
1510 _trigger_pre_parse(args.size());
1511 bool positional_only = false;
1512
1513 while(!args.empty()) {
1514 _parse_single(args, positional_only);
1515 }
1516 _process();
1517
1518 // Throw error if any items are left over (depending on settings)
1520}
1521
1522CLI11_INLINE void App::_parse_stream(std::istream &input) {
1523 auto values = config_formatter_->from_config(input);
1524 _parse_config(values);
1526 _trigger_pre_parse(values.size());
1527 _process();
1528
1529 // Throw error if any items are left over (depending on settings)
1531}
1532
1533CLI11_INLINE void App::_parse_config(const std::vector<ConfigItem> &args) {
1534 for(const ConfigItem &item : args) {
1535 if(!_parse_single_config(item) && allow_config_extras_ == config_extras_mode::error)
1536 throw ConfigError::Extras(item.fullname());
1537 }
1538}
1539
1540CLI11_INLINE bool
1541App::_add_flag_like_result(Option *op, const ConfigItem &item, const std::vector<std::string> &inputs) {
1542 if(item.inputs.size() <= 1) {
1543 // Flag parsing
1544 auto res = config_formatter_->to_flag(item);
1545 bool converted{false};
1546 if(op->get_disable_flag_override()) {
1547 auto val = detail::to_flag_value(res);
1548 if(val == 1) {
1549 res = op->get_flag_value(item.name, "{}");
1550 converted = true;
1551 }
1552 }
1553
1554 if(!converted) {
1555 errno = 0;
1556 if(res != "{}" || op->get_expected_max() <= 1) {
1557 res = op->get_flag_value(item.name, res);
1558 }
1559 }
1560
1561 op->add_result(res);
1562 return true;
1563 }
1564 if(static_cast<int>(inputs.size()) > op->get_items_expected_max() &&
1565 op->get_multi_option_policy() != MultiOptionPolicy::TakeAll &&
1566 op->get_multi_option_policy() != MultiOptionPolicy::Join) {
1567 if(op->get_items_expected_max() > 1) {
1568 throw ArgumentMismatch::AtMost(item.fullname(), op->get_items_expected_max(), inputs.size());
1569 }
1570
1571 if(!op->get_disable_flag_override()) {
1572 throw ConversionError::TooManyInputsFlag(item.fullname());
1573 }
1574 // if the disable flag override is set then we must have the flag values match a known flag value
1575 // this is true regardless of the output value, so an array input is possible and must be accounted for
1576 for(const auto &res : inputs) {
1577 bool valid_value{false};
1578 if(op->default_flag_values_.empty()) {
1579 if(res == "true" || res == "false" || res == "1" || res == "0") {
1580 valid_value = true;
1581 }
1582 } else {
1583 for(const auto &valid_res : op->default_flag_values_) {
1584 if(valid_res.second == res) {
1585 valid_value = true;
1586 break;
1587 }
1588 }
1589 }
1590
1591 if(valid_value) {
1592 op->add_result(res);
1593 } else {
1594 throw InvalidError("invalid flag argument given");
1595 }
1596 }
1597 return true;
1598 }
1599 return false;
1600}
1601
1602CLI11_INLINE bool App::_parse_single_config(const ConfigItem &item, std::size_t level) {
1603
1604 if(level < item.parents.size()) {
1605 auto *subcom = get_subcommand_no_throw(item.parents.at(level));
1606 return (subcom != nullptr) ? subcom->_parse_single_config(item, level + 1) : false;
1607 }
1608 // check for section open
1609 if(item.name == "++") {
1610 if(configurable_) {
1613 if(parent_ != nullptr) {
1614 parent_->parsed_subcommands_.push_back(this);
1615 }
1616 }
1617 return true;
1618 }
1619 // check for section close
1620 if(item.name == "--") {
1624 run_callback();
1625 }
1626 return true;
1627 }
1628 Option *op = get_option_no_throw("--" + item.name);
1629 if(op == nullptr) {
1630 if(item.name.size() == 1) {
1631 op = get_option_no_throw("-" + item.name);
1632 }
1633 if(op == nullptr) {
1634 op = get_option_no_throw(item.name);
1635 }
1636 } else if(!op->get_configurable()) {
1637 if(item.name.size() == 1) {
1638 auto *testop = get_option_no_throw("-" + item.name);
1639 if(testop != nullptr && testop->get_configurable()) {
1640 op = testop;
1641 }
1642 }
1643 }
1644 if(op == nullptr || !op->get_configurable()) {
1645 std::string iname = item.name;
1646 auto options = get_options([iname](const CLI::Option *opt) {
1647 return (opt->get_configurable() &&
1648 (opt->check_name(iname) || opt->check_lname(iname) || opt->check_sname(iname)));
1649 });
1650 if(!options.empty()) {
1651 op = options[0];
1652 }
1653 }
1654 if(op == nullptr) {
1655 // If the option was not present
1656 if(get_allow_config_extras() == config_extras_mode::capture) {
1657 // Should we worry about classifying the extras properly?
1658 missing_.emplace_back(detail::Classifier::NONE, item.fullname());
1659 for(const auto &input : item.inputs) {
1660 missing_.emplace_back(detail::Classifier::NONE, input);
1661 }
1662 }
1663 return false;
1664 }
1665
1666 if(!op->get_configurable()) {
1667 if(get_allow_config_extras() == config_extras_mode::ignore_all) {
1668 return false;
1669 }
1670 throw ConfigError::NotConfigurable(item.fullname());
1671 }
1672 if(op->empty()) {
1673 std::vector<std::string> buffer; // a buffer to use for copying an modifying inputs in a few cases
1674 bool useBuffer{false};
1675 if(item.multiline) {
1676 if(!op->get_inject_separator()) {
1677 buffer = item.inputs;
1678 buffer.erase(std::remove(buffer.begin(), buffer.end(), "%%"), buffer.end());
1679 useBuffer = true;
1680 }
1681 }
1682 const std::vector<std::string> &inputs = (useBuffer) ? buffer : item.inputs;
1683 if(op->get_expected_min() == 0) {
1684 if(_add_flag_like_result(op, item, inputs)) {
1685 return true;
1686 }
1687 }
1688 op->add_result(inputs);
1689 op->run_callback();
1690 }
1691
1692 return true;
1693}
1694
1695CLI11_INLINE bool App::_parse_single(std::vector<std::string> &args, bool &positional_only) {
1696 bool retval = true;
1697 detail::Classifier classifier = positional_only ? detail::Classifier::NONE : _recognize(args.back());
1698 switch(classifier) {
1699 case detail::Classifier::POSITIONAL_MARK:
1700 args.pop_back();
1701 positional_only = true;
1702 if((!_has_remaining_positionals()) && (parent_ != nullptr)) {
1703 retval = false;
1704 } else {
1705 _move_to_missing(classifier, "--");
1706 }
1707 break;
1708 case detail::Classifier::SUBCOMMAND_TERMINATOR:
1709 // treat this like a positional mark if in the parent app
1710 args.pop_back();
1711 retval = false;
1712 break;
1713 case detail::Classifier::SUBCOMMAND:
1714 retval = _parse_subcommand(args);
1715 break;
1716 case detail::Classifier::LONG:
1717 case detail::Classifier::SHORT:
1718 case detail::Classifier::WINDOWS_STYLE:
1719 // If already parsed a subcommand, don't accept options_
1720 retval = _parse_arg(args, classifier, false);
1721 break;
1722 case detail::Classifier::NONE:
1723 // Probably a positional or something for a parent (sub)command
1724 retval = _parse_positional(args, false);
1725 if(retval && positionals_at_end_) {
1726 positional_only = true;
1727 }
1728 break;
1729 // LCOV_EXCL_START
1730 default:
1731 throw HorribleError("unrecognized classifier (you should not see this!)");
1732 // LCOV_EXCL_STOP
1733 }
1734 return retval;
1735}
1736
1737CLI11_NODISCARD CLI11_INLINE std::size_t App::_count_remaining_positionals(bool required_only) const {
1738 std::size_t retval = 0;
1739 for(const Option_p &opt : options_) {
1740 if(opt->get_positional() && (!required_only || opt->get_required())) {
1741 if(opt->get_items_expected_min() > 0 && static_cast<int>(opt->count()) < opt->get_items_expected_min()) {
1742 retval += static_cast<std::size_t>(opt->get_items_expected_min()) - opt->count();
1743 }
1744 }
1745 }
1746 return retval;
1747}
1748
1749CLI11_NODISCARD CLI11_INLINE bool App::_has_remaining_positionals() const {
1750 for(const Option_p &opt : options_) {
1751 if(opt->get_positional() && ((static_cast<int>(opt->count()) < opt->get_items_expected_min()))) {
1752 return true;
1753 }
1754 }
1755
1756 return false;
1757}
1758
1759CLI11_INLINE bool App::_parse_positional(std::vector<std::string> &args, bool haltOnSubcommand) {
1760
1761 const std::string &positional = args.back();
1762 Option *posOpt{nullptr};
1763
1765 // deal with the case of required arguments at the end which should take precedence over other arguments
1766 auto arg_rem = args.size();
1767 auto remreq = _count_remaining_positionals(true);
1768 if(arg_rem <= remreq) {
1769 for(const Option_p &opt : options_) {
1770 if(opt->get_positional() && opt->required_) {
1771 if(static_cast<int>(opt->count()) < opt->get_items_expected_min()) {
1773 std::string pos = positional;
1774 pos = opt->_validate(pos, 0);
1775 if(!pos.empty()) {
1776 continue;
1777 }
1778 }
1779 posOpt = opt.get();
1780 break;
1781 }
1782 }
1783 }
1784 }
1785 }
1786 if(posOpt == nullptr) {
1787 for(const Option_p &opt : options_) {
1788 // Eat options, one by one, until done
1789 if(opt->get_positional() &&
1790 (static_cast<int>(opt->count()) < opt->get_items_expected_max() || opt->get_allow_extra_args())) {
1792 std::string pos = positional;
1793 pos = opt->_validate(pos, 0);
1794 if(!pos.empty()) {
1795 continue;
1796 }
1797 }
1798 posOpt = opt.get();
1799 break;
1800 }
1801 }
1802 }
1803 if(posOpt != nullptr) {
1804 parse_order_.push_back(posOpt);
1805 if(posOpt->get_inject_separator()) {
1806 if(!posOpt->results().empty() && !posOpt->results().back().empty()) {
1807 posOpt->add_result(std::string{});
1808 }
1809 }
1810 results_t prev;
1811 if(posOpt->get_trigger_on_parse() && posOpt->current_option_state_ == Option::option_state::callback_run) {
1812 prev = posOpt->results();
1813 posOpt->clear();
1814 }
1815 if(posOpt->get_expected_min() == 0) {
1816 ConfigItem item;
1817 item.name = posOpt->pname_;
1818 item.inputs.push_back(positional);
1819 // input is singular guaranteed to return true in that case
1820 _add_flag_like_result(posOpt, item, item.inputs);
1821 } else {
1822 posOpt->add_result(positional);
1823 }
1824
1825 if(posOpt->get_trigger_on_parse()) {
1826 if(!posOpt->empty()) {
1827 posOpt->run_callback();
1828 } else {
1829 if(!prev.empty()) {
1830 posOpt->add_result(prev);
1831 }
1832 }
1833 }
1834
1835 args.pop_back();
1836 return true;
1837 }
1838
1839 for(auto &subc : subcommands_) {
1840 if((subc->name_.empty()) && (!subc->disabled_)) {
1841 if(subc->_parse_positional(args, false)) {
1842 if(!subc->pre_parse_called_) {
1843 subc->_trigger_pre_parse(args.size());
1844 }
1845 return true;
1846 }
1847 }
1848 }
1849 // let the parent deal with it if possible
1850 if(parent_ != nullptr && fallthrough_) {
1851 return _get_fallthrough_parent()->_parse_positional(args, static_cast<bool>(parse_complete_callback_));
1852 }
1854 auto *com = _find_subcommand(args.back(), true, false);
1855 if(com != nullptr && (require_subcommand_max_ == 0 || require_subcommand_max_ > parsed_subcommands_.size())) {
1856 if(haltOnSubcommand) {
1857 return false;
1858 }
1859 args.pop_back();
1860 com->_parse(args);
1861 return true;
1862 }
1866 auto *parent_app = (parent_ != nullptr) ? _get_fallthrough_parent() : this;
1867 com = parent_app->_find_subcommand(args.back(), true, false);
1868 if(com != nullptr && (com->parent_->require_subcommand_max_ == 0 ||
1869 com->parent_->require_subcommand_max_ > com->parent_->parsed_subcommands_.size())) {
1870 return false;
1871 }
1872 }
1874 std::vector<std::string> rargs;
1875 rargs.resize(args.size());
1876 std::reverse_copy(args.begin(), args.end(), rargs.begin());
1877 throw CLI::ExtrasError(name_, rargs);
1878 }
1880 if(parent_ != nullptr && name_.empty()) {
1881 return false;
1882 }
1884 _move_to_missing(detail::Classifier::NONE, positional);
1885 args.pop_back();
1886 if(prefix_command_) {
1887 while(!args.empty()) {
1888 _move_to_missing(detail::Classifier::NONE, args.back());
1889 args.pop_back();
1890 }
1891 }
1892
1893 return true;
1894}
1895
1896CLI11_NODISCARD CLI11_INLINE App *
1897App::_find_subcommand(const std::string &subc_name, bool ignore_disabled, bool ignore_used) const noexcept {
1898 App *bcom{nullptr};
1899 for(const App_p &com : subcommands_) {
1900 if(com->disabled_ && ignore_disabled)
1901 continue;
1902 if(com->get_name().empty()) {
1903 auto *subc = com->_find_subcommand(subc_name, ignore_disabled, ignore_used);
1904 if(subc != nullptr) {
1905 if(bcom != nullptr) {
1906 return nullptr;
1907 }
1908 bcom = subc;
1909 if(!allow_prefix_matching_) {
1910 return bcom;
1911 }
1912 }
1913 }
1914 auto res = com->check_name_detail(subc_name);
1915 if(res != NameMatch::none) {
1916 if((!*com) || !ignore_used) {
1917 if(res == NameMatch::exact) {
1918 return com.get();
1919 }
1920 if(bcom != nullptr) {
1921 return nullptr;
1922 }
1923 bcom = com.get();
1924 if(!allow_prefix_matching_) {
1925 return bcom;
1926 }
1927 }
1928 }
1929 }
1930 return bcom;
1931}
1932
1933CLI11_INLINE bool App::_parse_subcommand(std::vector<std::string> &args) {
1934 if(_count_remaining_positionals(/* required */ true) > 0) {
1935 _parse_positional(args, false);
1936 return true;
1937 }
1938 auto *com = _find_subcommand(args.back(), true, true);
1939 if(com == nullptr) {
1940 // the main way to get here is using .notation
1941 auto dotloc = args.back().find_first_of('.');
1942 if(dotloc != std::string::npos) {
1943 com = _find_subcommand(args.back().substr(0, dotloc), true, true);
1944 if(com != nullptr) {
1945 args.back() = args.back().substr(dotloc + 1);
1946 args.push_back(com->get_display_name());
1947 }
1948 }
1949 }
1950 if(com != nullptr) {
1951 args.pop_back();
1952 if(!com->silent_) {
1953 parsed_subcommands_.push_back(com);
1954 }
1955 com->_parse(args);
1956 auto *parent_app = com->parent_;
1957 while(parent_app != this) {
1958 parent_app->_trigger_pre_parse(args.size());
1959 if(!com->silent_) {
1960 parent_app->parsed_subcommands_.push_back(com);
1961 }
1962 parent_app = parent_app->parent_;
1963 }
1964 return true;
1965 }
1966
1967 if(parent_ == nullptr)
1968 throw HorribleError("Subcommand " + args.back() + " missing");
1969 return false;
1970}
1971
1972CLI11_INLINE bool
1973App::_parse_arg(std::vector<std::string> &args, detail::Classifier current_type, bool local_processing_only) {
1974
1975 std::string current = args.back();
1976
1977 std::string arg_name;
1978 std::string value;
1979 std::string rest;
1980
1981 switch(current_type) {
1982 case detail::Classifier::LONG:
1983 if(!detail::split_long(current, arg_name, value))
1984 throw HorribleError("Long parsed but missing (you should not see this):" + args.back());
1985 break;
1986 case detail::Classifier::SHORT:
1987 if(!detail::split_short(current, arg_name, rest))
1988 throw HorribleError("Short parsed but missing! You should not see this");
1989 break;
1990 case detail::Classifier::WINDOWS_STYLE:
1991 if(!detail::split_windows_style(current, arg_name, value))
1992 throw HorribleError("windows option parsed but missing! You should not see this");
1993 break;
1994 case detail::Classifier::SUBCOMMAND:
1995 case detail::Classifier::SUBCOMMAND_TERMINATOR:
1996 case detail::Classifier::POSITIONAL_MARK:
1997 case detail::Classifier::NONE:
1998 default:
1999 throw HorribleError("parsing got called with invalid option! You should not see this");
2000 }
2001
2002 auto op_ptr = std::find_if(std::begin(options_), std::end(options_), [arg_name, current_type](const Option_p &opt) {
2003 if(current_type == detail::Classifier::LONG)
2004 return opt->check_lname(arg_name);
2005 if(current_type == detail::Classifier::SHORT)
2006 return opt->check_sname(arg_name);
2007 // this will only get called for detail::Classifier::WINDOWS_STYLE
2008 return opt->check_lname(arg_name) || opt->check_sname(arg_name);
2009 });
2010
2011 // Option not found
2012 while(op_ptr == std::end(options_)) {
2013 // using while so we can break
2014 for(auto &subc : subcommands_) {
2015 if(subc->name_.empty() && !subc->disabled_) {
2016 if(subc->_parse_arg(args, current_type, local_processing_only)) {
2017 if(!subc->pre_parse_called_) {
2018 subc->_trigger_pre_parse(args.size());
2019 }
2020 return true;
2021 }
2022 }
2023 }
2024 if(allow_non_standard_options_ && current_type == detail::Classifier::SHORT && current.size() > 2) {
2025 std::string narg_name;
2026 std::string nvalue;
2027 detail::split_long(std::string{'-'} + current, narg_name, nvalue);
2028 op_ptr = std::find_if(std::begin(options_), std::end(options_), [narg_name](const Option_p &opt) {
2029 return opt->check_sname(narg_name);
2030 });
2031 if(op_ptr != std::end(options_)) {
2032 arg_name = narg_name;
2033 value = nvalue;
2034 rest.clear();
2035 break;
2036 }
2037 }
2038
2039 // don't capture missing if this is a nameless subcommand and nameless subcommands can't fallthrough
2040 if(parent_ != nullptr && name_.empty()) {
2041 return false;
2042 }
2043
2044 // now check for '.' notation of subcommands
2045 auto dotloc = arg_name.find_first_of('.', 1);
2046 if(dotloc != std::string::npos && dotloc < arg_name.size() - 1) {
2047 // using dot notation is equivalent to single argument subcommand
2048 auto *sub = _find_subcommand(arg_name.substr(0, dotloc), true, false);
2049 if(sub != nullptr) {
2050 std::string v = args.back();
2051 args.pop_back();
2052 arg_name = arg_name.substr(dotloc + 1);
2053 if(arg_name.size() > 1) {
2054 args.push_back(std::string("--") + v.substr(dotloc + 3));
2055 current_type = detail::Classifier::LONG;
2056 } else {
2057 auto nval = v.substr(dotloc + 2);
2058 nval.front() = '-';
2059 if(nval.size() > 2) {
2060 // '=' not allowed in short form arguments
2061 args.push_back(nval.substr(3));
2062 nval.resize(2);
2063 }
2064 args.push_back(nval);
2065 current_type = detail::Classifier::SHORT;
2066 }
2067 std::string dummy1, dummy2;
2068 bool val = false;
2069 if((current_type == detail::Classifier::SHORT && detail::valid_first_char(args.back()[1])) ||
2070 detail::split_long(args.back(), dummy1, dummy2)) {
2071 val = sub->_parse_arg(args, current_type, true);
2072 }
2073
2074 if(val) {
2075 if(!sub->silent_) {
2076 parsed_subcommands_.push_back(sub);
2077 }
2078 // deal with preparsing
2080 _trigger_pre_parse(args.size());
2081 // run the parse complete callback since the subcommand processing is now complete
2082 if(sub->parse_complete_callback_) {
2083 sub->_process_env();
2084 sub->_process_callbacks();
2085 sub->_process_help_flags();
2086 sub->_process_requirements();
2087 sub->run_callback(false, true);
2088 }
2089 return true;
2090 }
2091 args.pop_back();
2092 args.push_back(v);
2093 }
2094 }
2095 if(local_processing_only) {
2096 return false;
2097 }
2098 // If a subcommand, try the main command
2099 if(parent_ != nullptr && fallthrough_)
2100 return _get_fallthrough_parent()->_parse_arg(args, current_type, false);
2101
2102 // Otherwise, add to missing
2103 args.pop_back();
2104 _move_to_missing(current_type, current);
2105 return true;
2106 }
2107
2108 args.pop_back();
2109
2110 // Get a reference to the pointer to make syntax bearable
2111 Option_p &op = *op_ptr;
2113 if(op->get_inject_separator()) {
2114 if(!op->results().empty() && !op->results().back().empty()) {
2115 op->add_result(std::string{});
2116 }
2117 }
2118 if(op->get_trigger_on_parse() && op->current_option_state_ == Option::option_state::callback_run) {
2119 op->clear();
2120 }
2121 int min_num = (std::min)(op->get_type_size_min(), op->get_items_expected_min());
2122 int max_num = op->get_items_expected_max();
2123 // check container like options to limit the argument size to a single type if the allow_extra_flags argument is
2124 // set. 16 is somewhat arbitrary (needs to be at least 4)
2125 if(max_num >= detail::expected_max_vector_size / 16 && !op->get_allow_extra_args()) {
2126 auto tmax = op->get_type_size_max();
2127 max_num = detail::checked_multiply(tmax, op->get_expected_min()) ? tmax : detail::expected_max_vector_size;
2128 }
2129 // Make sure we always eat the minimum for unlimited vectors
2130 int collected = 0; // total number of arguments collected
2131 int result_count = 0; // local variable for number of results in a single arg string
2132 // deal with purely flag like things
2133 if(max_num == 0) {
2134 auto res = op->get_flag_value(arg_name, value);
2135 op->add_result(res);
2136 parse_order_.push_back(op.get());
2137 } else if(!value.empty()) { // --this=value
2138 op->add_result(value, result_count);
2139 parse_order_.push_back(op.get());
2140 collected += result_count;
2141 // -Trest
2142 } else if(!rest.empty()) {
2143 op->add_result(rest, result_count);
2144 parse_order_.push_back(op.get());
2145 rest = "";
2146 collected += result_count;
2147 }
2148
2149 // gather the minimum number of arguments
2150 while(min_num > collected && !args.empty()) {
2151 std::string current_ = args.back();
2152 args.pop_back();
2153 op->add_result(current_, result_count);
2154 parse_order_.push_back(op.get());
2155 collected += result_count;
2156 }
2157
2158 if(min_num > collected) { // if we have run out of arguments and the minimum was not met
2159 throw ArgumentMismatch::TypedAtLeast(op->get_name(), min_num, op->get_type_name());
2160 }
2161
2162 // now check for optional arguments
2163 if(max_num > collected || op->get_allow_extra_args()) { // we allow optional arguments
2164 auto remreqpos = _count_remaining_positionals(true);
2165 // we have met the minimum now optionally check up to the maximum
2166 while((collected < max_num || op->get_allow_extra_args()) && !args.empty() &&
2167 _recognize(args.back(), false) == detail::Classifier::NONE) {
2168 // If any required positionals remain, don't keep eating
2169 if(remreqpos >= args.size()) {
2170 break;
2171 }
2173 std::string arg = args.back();
2174 arg = op->_validate(arg, 0);
2175 if(!arg.empty()) {
2176 break;
2177 }
2178 }
2179 op->add_result(args.back(), result_count);
2180 parse_order_.push_back(op.get());
2181 args.pop_back();
2182 collected += result_count;
2183 }
2184
2185 // Allow -- to end an unlimited list and "eat" it
2186 if(!args.empty() && _recognize(args.back()) == detail::Classifier::POSITIONAL_MARK)
2187 args.pop_back();
2188 // optional flag that didn't receive anything now get the default value
2189 if(min_num == 0 && max_num > 0 && collected == 0) {
2190 auto res = op->get_flag_value(arg_name, std::string{});
2191 op->add_result(res);
2192 parse_order_.push_back(op.get());
2193 }
2194 }
2195 // if we only partially completed a type then add an empty string if allowed for later processing
2196 if(min_num > 0 && (collected % op->get_type_size_max()) != 0) {
2197 if(op->get_type_size_max() != op->get_type_size_min()) {
2198 op->add_result(std::string{});
2199 } else {
2200 throw ArgumentMismatch::PartialType(op->get_name(), op->get_type_size_min(), op->get_type_name());
2201 }
2202 }
2203 if(op->get_trigger_on_parse()) {
2204 op->run_callback();
2205 }
2206 if(!rest.empty()) {
2207 rest = "-" + rest;
2208 args.push_back(rest);
2209 }
2210 return true;
2211}
2212
2213CLI11_INLINE void App::_trigger_pre_parse(std::size_t remaining_args) {
2214 if(!pre_parse_called_) {
2215 pre_parse_called_ = true;
2217 pre_parse_callback_(remaining_args);
2218 }
2219 } else if(immediate_callback_) {
2220 if(!name_.empty()) {
2221 auto pcnt = parsed_;
2222 missing_t extras = std::move(missing_);
2223 clear();
2224 parsed_ = pcnt;
2225 pre_parse_called_ = true;
2226 missing_ = std::move(extras);
2227 }
2228 }
2229}
2230
2232 if(parent_ == nullptr) {
2233 throw(HorribleError("No Valid parent"));
2234 }
2235 auto *fallthrough_parent = parent_;
2236 while((fallthrough_parent->parent_ != nullptr) && (fallthrough_parent->get_name().empty())) {
2237 fallthrough_parent = fallthrough_parent->parent_;
2238 }
2239 return fallthrough_parent;
2240}
2241
2242CLI11_NODISCARD CLI11_INLINE const std::string &App::_compare_subcommand_names(const App &subcom,
2243 const App &base) const {
2244 static const std::string estring;
2245 if(subcom.disabled_) {
2246 return estring;
2247 }
2248 for(const auto &subc : base.subcommands_) {
2249 if(subc.get() != &subcom) {
2250 if(subc->disabled_) {
2251 continue;
2252 }
2253 if(!subcom.get_name().empty()) {
2254 if(subc->check_name(subcom.get_name())) {
2255 return subcom.get_name();
2256 }
2257 }
2258 if(!subc->get_name().empty()) {
2259 if(subcom.check_name(subc->get_name())) {
2260 return subc->get_name();
2261 }
2262 }
2263 for(const auto &les : subcom.aliases_) {
2264 if(subc->check_name(les)) {
2265 return les;
2266 }
2267 }
2268 // this loop is needed in case of ignore_underscore or ignore_case on one but not the other
2269 for(const auto &les : subc->aliases_) {
2270 if(subcom.check_name(les)) {
2271 return les;
2272 }
2273 }
2274 // if the subcommand is an option group we need to check deeper
2275 if(subc->get_name().empty()) {
2276 const auto &cmpres = _compare_subcommand_names(subcom, *subc);
2277 if(!cmpres.empty()) {
2278 return cmpres;
2279 }
2280 }
2281 // if the test subcommand is an option group we need to check deeper
2282 if(subcom.get_name().empty()) {
2283 const auto &cmpres = _compare_subcommand_names(*subc, subcom);
2284 if(!cmpres.empty()) {
2285 return cmpres;
2286 }
2287 }
2288 }
2289 }
2290 return estring;
2291}
2292
2293CLI11_INLINE void App::_move_to_missing(detail::Classifier val_type, const std::string &val) {
2294 if(allow_extras_ || subcommands_.empty()) {
2295 missing_.emplace_back(val_type, val);
2296 return;
2297 }
2298 // allow extra arguments to be places in an option group if it is allowed there
2299 for(auto &subc : subcommands_) {
2300 if(subc->name_.empty() && subc->allow_extras_) {
2301 subc->missing_.emplace_back(val_type, val);
2302 return;
2303 }
2304 }
2305 // if we haven't found any place to put them yet put them in missing
2306 missing_.emplace_back(val_type, val);
2307}
2308
2309CLI11_INLINE void App::_move_option(Option *opt, App *app) {
2310 if(opt == nullptr) {
2311 throw OptionNotFound("the option is NULL");
2312 }
2313 // verify that the give app is actually a subcommand
2314 bool found = false;
2315 for(auto &subc : subcommands_) {
2316 if(app == subc.get()) {
2317 found = true;
2318 }
2319 }
2320 if(!found) {
2321 throw OptionNotFound("The Given app is not a subcommand");
2322 }
2323
2324 if((help_ptr_ == opt) || (help_all_ptr_ == opt))
2325 throw OptionAlreadyAdded("cannot move help options");
2326
2327 if(config_ptr_ == opt)
2328 throw OptionAlreadyAdded("cannot move config file options");
2329
2330 auto iterator =
2331 std::find_if(std::begin(options_), std::end(options_), [opt](const Option_p &v) { return v.get() == opt; });
2332 if(iterator != std::end(options_)) {
2333 const auto &opt_p = *iterator;
2334 if(std::find_if(std::begin(app->options_), std::end(app->options_), [&opt_p](const Option_p &v) {
2335 return (*v == *opt_p);
2336 }) == std::end(app->options_)) {
2337 // only erase after the insertion was successful
2338 app->options_.push_back(std::move(*iterator));
2339 options_.erase(iterator);
2340 } else {
2341 throw OptionAlreadyAdded("option was not located: " + opt->get_name());
2342 }
2343 } else {
2344 throw OptionNotFound("could not locate the given Option");
2345 }
2346}
2347
2348CLI11_INLINE void TriggerOn(App *trigger_app, App *app_to_enable) {
2349 app_to_enable->enabled_by_default(false);
2350 app_to_enable->disabled_by_default();
2351 trigger_app->preparse_callback([app_to_enable](std::size_t) { app_to_enable->disabled(false); });
2352}
2353
2354CLI11_INLINE void TriggerOn(App *trigger_app, std::vector<App *> apps_to_enable) {
2355 for(auto &app : apps_to_enable) {
2356 app->enabled_by_default(false);
2357 app->disabled_by_default();
2358 }
2359
2360 trigger_app->preparse_callback([apps_to_enable](std::size_t) {
2361 for(const auto &app : apps_to_enable) {
2362 app->disabled(false);
2363 }
2364 });
2365}
2366
2367CLI11_INLINE void TriggerOff(App *trigger_app, App *app_to_enable) {
2368 app_to_enable->disabled_by_default(false);
2369 app_to_enable->enabled_by_default();
2370 trigger_app->preparse_callback([app_to_enable](std::size_t) { app_to_enable->disabled(); });
2371}
2372
2373CLI11_INLINE void TriggerOff(App *trigger_app, std::vector<App *> apps_to_enable) {
2374 for(auto &app : apps_to_enable) {
2375 app->disabled_by_default(false);
2376 app->enabled_by_default();
2377 }
2378
2379 trigger_app->preparse_callback([apps_to_enable](std::size_t) {
2380 for(const auto &app : apps_to_enable) {
2381 app->disabled();
2382 }
2383 });
2384}
2385
2386CLI11_INLINE void deprecate_option(Option *opt, const std::string &replacement) {
2387 Validator deprecate_warning{[opt, replacement](std::string &) {
2388 std::cout << opt->get_name() << " is deprecated please use '" << replacement
2389 << "' instead\n";
2390 return std::string();
2391 },
2392 "DEPRECATED"};
2393 deprecate_warning.application_index(0);
2394 opt->check(deprecate_warning);
2395 if(!replacement.empty()) {
2396 opt->description(opt->get_description() + " DEPRECATED: please use '" + replacement + "' instead");
2397 }
2398}
2399
2400CLI11_INLINE void retire_option(App *app, Option *opt) {
2401 App temp;
2402 auto *option_copy = temp.add_option(opt->get_name(false, true))
2403 ->type_size(opt->get_type_size_min(), opt->get_type_size_max())
2404 ->expected(opt->get_expected_min(), opt->get_expected_max())
2405 ->allow_extra_args(opt->get_allow_extra_args());
2406
2407 app->remove_option(opt);
2408 auto *opt2 = app->add_option(option_copy->get_name(false, true), "option has been retired and has no effect");
2409 opt2->type_name("RETIRED")
2410 ->default_str("RETIRED")
2411 ->type_size(option_copy->get_type_size_min(), option_copy->get_type_size_max())
2412 ->expected(option_copy->get_expected_min(), option_copy->get_expected_max())
2413 ->allow_extra_args(option_copy->get_allow_extra_args());
2414
2415 // LCOV_EXCL_START
2416 // something odd with coverage on new compilers
2417 Validator retired_warning{[opt2](std::string &) {
2418 std::cout << "WARNING " << opt2->get_name() << " is retired and has no effect\n";
2419 return std::string();
2420 },
2421 ""};
2422 // LCOV_EXCL_STOP
2423 retired_warning.application_index(0);
2424 opt2->check(retired_warning);
2425}
2426
2427CLI11_INLINE void retire_option(App &app, Option *opt) { retire_option(&app, opt); }
2428
2429CLI11_INLINE void retire_option(App *app, const std::string &option_name) {
2430
2431 auto *opt = app->get_option_no_throw(option_name);
2432 if(opt != nullptr) {
2433 retire_option(app, opt);
2434 return;
2435 }
2436 auto *opt2 = app->add_option(option_name, "option has been retired and has no effect")
2437 ->type_name("RETIRED")
2438 ->expected(0, 1)
2439 ->default_str("RETIRED");
2440 // LCOV_EXCL_START
2441 // something odd with coverage on new compilers
2442 Validator retired_warning{[opt2](std::string &) {
2443 std::cout << "WARNING " << opt2->get_name() << " is retired and has no effect\n";
2444 return std::string();
2445 },
2446 ""};
2447 // LCOV_EXCL_STOP
2448 retired_warning.application_index(0);
2449 opt2->check(retired_warning);
2450}
2451
2452CLI11_INLINE void retire_option(App &app, const std::string &option_name) { retire_option(&app, option_name); }
2453
2454namespace FailureMessage {
2455
2456CLI11_INLINE std::string simple(const App *app, const Error &e) {
2457 std::string header = std::string(e.what()) + "\n";
2458 std::vector<std::string> names;
2459
2460 // Collect names
2461 if(app->get_help_ptr() != nullptr)
2462 names.push_back(app->get_help_ptr()->get_name());
2463
2464 if(app->get_help_all_ptr() != nullptr)
2465 names.push_back(app->get_help_all_ptr()->get_name());
2466
2467 // If any names found, suggest those
2468 if(!names.empty())
2469 header += "Run with " + detail::join(names, " or ") + " for more information.\n";
2470
2471 return header;
2472}
2473
2474CLI11_INLINE std::string help(const App *app, const Error &e) {
2475 std::string header = std::string("ERROR: ") + e.get_name() + ": " + e.what() + "\n";
2476 header += app->help();
2477 return header;
2478}
2479
2480} // namespace FailureMessage
2481
2482// [CLI11:app_inl_hpp:end]
2483} // namespace CLI
Creates a command line program, with very few defaults.
Definition App.hpp:98
CLI11_NODISCARD Option * get_option_no_throw(std::string option_name) noexcept
Get an option by name (noexcept non-const version)
Definition App_inl.hpp:873
bool subcommand_fallthrough_
Allow subcommands to fallthrough, so that parent commands can trigger other subcommands after subcomm...
Definition App.hpp:240
int exit(const Error &e, std::ostream &out=std::cout, std::ostream &err=std::cerr) const
Print a nice error message and return the exit code.
Definition App_inl.hpp:703
CLI11_NODISCARD std::string help(std::string prev="", AppFormatMode mode=AppFormatMode::Normal) const
Definition App_inl.hpp:799
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:1013
CLI11_NODISCARD bool _has_remaining_positionals() const
Count the required remaining positional arguments.
Definition App_inl.hpp:1749
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:1126
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
App * _get_fallthrough_parent()
Get the appropriate parent to fallthrough to which is the first one that has a name or the main app.
Definition App_inl.hpp:2231
bool allow_non_standard_options_
indicator that the subcommand should allow non-standard option arguments, such as -single_dash_flag
Definition App.hpp:272
Option * config_ptr_
Pointer to the config option.
Definition App.hpp:306
CLI11_NODISCARD bool get_allow_non_standard_option_names() const
Get the status of allowing non standard option names.
Definition App.hpp:1180
App * disabled_by_default(bool disable=true)
Set the subcommand to be disabled by default, so on clear(), at the start of each parse it is disable...
Definition App.hpp:421
void _move_to_missing(detail::Classifier val_type, const std::string &val)
Helper function to place extra values in the most appropriate position.
Definition App_inl.hpp:2293
std::size_t require_option_min_
Minimum required options (not inheritable!)
Definition App.hpp:287
NameMatch
enumeration of matching possibilities
Definition App.hpp:1248
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:284
std::vector< App_p > subcommands_
Storage for subcommand list.
Definition App.hpp:227
CLI11_NODISCARD std::vector< std::string > remaining(bool recurse=false) const
This returns the missing options from the current subcommand.
Definition App_inl.hpp:981
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:1007
std::uint32_t parsed_
Counts the number of times this command/subcommand was parsed.
Definition App.hpp:278
CLI11_NODISCARD App * get_option_group(std::string group_name) const
Check to see if an option group is part of this App.
Definition App_inl.hpp:555
std::string usage_
Usage to put after program/subcommand description in the help output INHERITABLE.
Definition App.hpp:164
OptionDefaults option_defaults_
The default values for options, customizable and changeable INHERITABLE.
Definition App.hpp:154
void _process_help_flags(bool trigger_help=false, bool trigger_all_help=false) const
Definition App_inl.hpp:1265
void _process_requirements()
Verify required options and cross requirements. Subcommands too (only if selected).
Definition App_inl.hpp:1287
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:131
Option * set_version_flag(std::string flag_name="", const std::string &versionString="", const std::string &version_help="Display program version information and exit")
Set a version flag and version display string, replace the existing one if present.
Definition App_inl.hpp:311
bool remove_needs(Option *opt)
Removes an option from the needs list of this subcommand.
Definition App_inl.hpp:781
Option * get_help_ptr()
Get a pointer to the help flag.
Definition App.hpp:1202
void _configure()
Definition App_inl.hpp:1062
CLI11_NODISCARD std::size_t _count_remaining_positionals(bool required_only=false) const
Count the required remaining positional arguments.
Definition App_inl.hpp:1737
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:593
void _process_config_file()
Read and process a configuration file (main app only)
Definition App_inl.hpp:1183
std::string footer_
Footer to put after all options in the help output INHERITABLE.
Definition App.hpp:170
void increment_parsed()
Internal function to recursively increment the parsed counter on the current app as well unnamed subc...
Definition App_inl.hpp:1470
config_extras_mode allow_config_extras_
Definition App.hpp:119
CLI11_NODISCARD bool check_name(std::string name_to_check) const
Definition App_inl.hpp:925
Option * version_ptr_
A pointer to a version flag if there is one.
Definition App.hpp:182
CLI11_NODISCARD const Option * get_help_all_ptr() const
Get a pointer to the help all flag. (const)
Definition App.hpp:1208
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:293
std::set< Option * > exclude_options_
Definition App.hpp:212
void _trigger_pre_parse(std::size_t remaining_args)
Trigger the pre_parse callback if needed.
Definition App_inl.hpp:2213
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
std::function< void()> parse_complete_callback_
This is a function that runs when parsing has finished.
Definition App.hpp:144
virtual void pre_callback()
Definition App.hpp:889
Option * add_flag(std::string flag_name)
Add a flag with no description or variable assignment.
Definition App.hpp:655
void _validate() const
Definition App_inl.hpp:1027
std::string name_
Subcommand name or program name (from parser if name is empty)
Definition App.hpp:109
std::vector< App * > parsed_subcommands_
This is a list of the subcommands collected, in order.
Definition App.hpp:205
bool ignore_underscore_
If true, the program should ignore underscores INHERITABLE.
Definition App.hpp:233
missing_t missing_
Definition App.hpp:199
void run_callback(bool final_mode=false, bool suppress_final_callback=false)
Internal function to run (App) callback, bottom up.
Definition App_inl.hpp:1082
bool allow_prefix_matching_
indicator to allow subcommands to match with prefix matching
Definition App.hpp:275
std::size_t require_subcommand_min_
Minimum required subcommands (not inheritable!)
Definition App.hpp:281
CLI11_NODISCARD NameMatch check_name_detail(std::string name_to_check) const
Definition App_inl.hpp:930
void _process_env()
Get envname options if not yet passed. Runs on all subcommands.
Definition App_inl.hpp:1219
std::function< std::string(const App *, const Error &e)> failure_message_
The error message printing function INHERITABLE.
Definition App.hpp:188
void _parse_stream(std::istream &input)
Internal function to parse a stream.
Definition App_inl.hpp:1522
CLI11_NODISCARD std::string get_display_name(bool with_aliases=false) const
Get a display name for an app.
Definition App_inl.hpp:909
bool has_automatic_name_
If set to true the name was automatically generated from the command line vs a user set name.
Definition App.hpp:125
CLI11_NODISCARD const std::string & _compare_subcommand_names(const App &subcom, const App &base) const
Helper function to run through all possible comparisons of subcommand names to check there is no over...
Definition App_inl.hpp:2242
void clear()
Reset the parsed data.
Definition App_inl.hpp:578
App * enabled_by_default(bool enable=true)
Definition App.hpp:432
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:813
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:1541
std::vector< Option_p > options_
The list of options, stored locally.
Definition App.hpp:157
Option * help_all_ptr_
A pointer to the help all flag if there is one INHERITABLE.
Definition App.hpp:179
bool validate_optional_arguments_
If set to true optional vector arguments are validated before assigning INHERITABLE.
Definition App.hpp:265
std::function< void()> final_callback_
This is a function that runs when all processing has completed.
Definition App.hpp:147
bool remove_option(Option *opt)
Removes an option from the App. Takes an option pointer. Returns true if found and removed.
Definition App_inl.hpp: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:374
Option * add_flag_callback(std::string flag_name, std::function< void(void)> function, std::string flag_description="")
Add option for callback that is triggered with a true flag and takes no arguments.
Definition App_inl.hpp:370
bool positionals_at_end_
specify that positional arguments come at the end of the argument sequence not inheritable
Definition App.hpp:251
void _process()
Process callbacks and such.
Definition App_inl.hpp:1415
bool immediate_callback_
Definition App.hpp:138
bool _parse_single(std::vector< std::string > &args, bool &positional_only)
Definition App_inl.hpp:1695
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:2309
void _process_extras()
Throw an error if anything is left over and should not be.
Definition App_inl.hpp:1441
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:1109
bool configurable_
if set to true the subcommand can be triggered via configuration files INHERITABLE
Definition App.hpp:259
CLI11_NODISCARD std::vector< std::string > get_groups() const
Get the groups available directly from this option (in order)
Definition App_inl.hpp:968
void _parse_config(const std::vector< ConfigItem > &args)
Definition App_inl.hpp:1533
std::size_t require_option_max_
Max number of options allowed. 0 is unlimited (not inheritable)
Definition App.hpp:290
std::vector< std::string > aliases_
Alias names for the subcommand.
Definition App.hpp:299
std::set< App * > exclude_subcommands_
this is a list of subcommands that are exclusionary to this one
Definition App.hpp:208
bool _parse_positional(std::vector< std::string > &args, bool haltOnSubcommand)
Definition App_inl.hpp:1759
bool ignore_case_
If true, the program name is not case-sensitive INHERITABLE.
Definition App.hpp:230
CLI11_NODISCARD const std::string & get_group() const
Get the group of this subcommand.
Definition App.hpp:1140
bool _parse_arg(std::vector< std::string > &args, detail::Classifier current_type, bool local_processing_only)
Definition App_inl.hpp:1973
std::function< void(std::size_t)> pre_parse_callback_
This is a function that runs prior to the start of parsing.
Definition App.hpp:141
std::string group_
The group membership INHERITABLE.
Definition App.hpp:296
App * alias(std::string app_name)
Set an alias for the app.
Definition App_inl.hpp:104
bool pre_parse_called_
Flag indicating that the pre_parse_callback has been triggered.
Definition App.hpp:134
void _process_callbacks()
Process callbacks. Runs on all subcommands.
Definition App_inl.hpp:1241
Option * help_ptr_
A pointer to the help flag if there is one INHERITABLE.
Definition App.hpp:176
Option * set_config(std::string option_name="", std::string default_filename="", const std::string &help_message="Read an ini file", bool config_required=false)
Set a configuration ini file option, or clear it if no name passed.
Definition App_inl.hpp: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:761
CLI11_NODISCARD std::vector< App * > get_subcommands() const
Definition App.hpp:940
CLI11_NODISCARD config_extras_mode get_allow_config_extras() const
Get the status of allow extras.
Definition App.hpp:1199
bool _parse_subcommand(std::vector< std::string > &args)
Definition App_inl.hpp:1933
bool fallthrough_
Definition App.hpp:237
std::set< Option * > need_options_
Definition App.hpp:220
std::vector< const Option * > get_options(const std::function< bool(const Option *)> filter={}) const
Get the list of options (user facing function, so returns raw pointers), has optional filter function...
Definition App_inl.hpp:831
std::set< App * > need_subcommands_
Definition App.hpp:216
bool prefix_command_
If true, cease processing on an unrecognized option (implies allow_extras) INHERITABLE.
Definition App.hpp:122
Option * add_option(std::string option_name, callback_t option_callback, std::string option_description="", bool defaulted=false, std::function< std::string()> func={})
Definition App_inl.hpp:162
std::vector< Option * > parse_order_
This is a list of pointers to options with the original parse order.
Definition App.hpp:202
void _parse(std::vector< std::string > &args)
Internal parse function.
Definition App_inl.hpp:1478
bool validate_positionals_
If set to true positional options are validated before assigning INHERITABLE.
Definition App.hpp:262
bool _parse_single_config(const ConfigItem &item, std::size_t level=0)
Fill in a single config option.
Definition App_inl.hpp:1602
startup_mode default_startup
Definition App.hpp:256
bool allow_extras_
If true, allow extra arguments (ie, don't throw an error). INHERITABLE.
Definition App.hpp:115
CLI11_NODISCARD char ** ensure_utf8(char **argv)
Convert the contents of argv to UTF-8. Only does something on Windows, does nothing elsewhere.
Definition App_inl.hpp:65
CLI11_NODISCARD App * _find_subcommand(const std::string &subc_name, bool ignore_disabled, bool ignore_used) const noexcept
Definition App_inl.hpp:1897
CLI11_NODISCARD const std::string & get_name() const
Get the name of the current app.
Definition App.hpp:1229
App * disabled(bool disable=true)
Disable the subcommand or option group.
Definition App.hpp:398
std::shared_ptr< FormatterBase > formatter_
This is the formatter for help printing. Default provided. INHERITABLE (same pointer)
Definition App.hpp:185
Option * set_help_all_flag(std::string help_name="", const std::string &help_description="")
Set a help all flag, replaced the existing one if present.
Definition App_inl.hpp:294
bool allow_windows_style_options_
Allow '/' for options for Windows like options. Defaults to true on Windows, false otherwise....
Definition App.hpp:243
std::shared_ptr< Config > config_formatter_
This is the formatter for help printing. Default provided. INHERITABLE (same pointer)
Definition App.hpp:309
Usually something like –help-all on command line.
Definition Error.hpp:178
-h or –help on command line
Definition Error.hpp:172
-v or –version on command line
Definition Error.hpp:185
All errors derive from this one.
Definition Error.hpp:73
Thrown when an excludes option is present.
Definition Error.hpp:301
Thrown when 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 bool get_required() const
True if this is a required option.
Definition Option.hpp:120
CRTP * configurable(bool value=true)
Allow in a configuration file.
Definition Option.hpp:182
CLI11_NODISCARD MultiOptionPolicy get_multi_option_policy() const
The status of the multi option policy.
Definition Option.hpp:141
CLI11_NODISCARD bool get_configurable() const
The status of configurable.
Definition Option.hpp:129
bool required_
True if this is a required option.
Definition Option.hpp:62
CLI11_NODISCARD bool get_disable_flag_override() const
The status of configurable.
Definition Option.hpp:132
CLI11_NODISCARD const std::string & get_group() const
Get the group of this option.
Definition Option.hpp:117
void copy_to(T *other) const
Copy the contents to another similar class (one based on OptionBase)
Definition Option_inl.hpp:24
CRTP * required(bool value=true)
Set the option as required.
Definition Option.hpp:101
Definition Option.hpp:233
Option * expected(int value)
Set the number of expected arguments.
Definition Option_inl.hpp:36
CLI11_NODISCARD bool get_positional() const
True if the argument can be given directly.
Definition Option.hpp:590
CLI11_NODISCARD bool check_name(const std::string &name) const
Check a name. Requires "-" or "--" for short / long, supports positional name.
Definition Option_inl.hpp:354
@ callback_run
the callback has been executed
std::set< Option * > needs_
A list of options that are required with this option.
Definition Option.hpp:300
void run_callback()
Process the callback.
Definition Option_inl.hpp:286
CLI11_NODISCARD bool check_sname(std::string name) const
Requires "-" to be removed from string.
Definition Option.hpp:643
CLI11_NODISCARD std::string get_name(bool positional=false, bool all_options=false) const
Gets a comma separated list of names. Will include / prefer the positional name if positional is true...
Definition Option_inl.hpp:233
std::set< Option * > excludes_
A list of options that are excluded with this option.
Definition Option.hpp:303
bool force_callback_
flag indicating that the option should force the callback regardless if any results present
Definition Option.hpp:343
CLI11_NODISCARD bool get_callback_run() const
See if the callback has been run already.
Definition Option.hpp:720
std::vector< std::string > fnames_
a list of flag names with specified default values;
Definition Option.hpp:252
CLI11_NODISCARD int get_items_expected_min() const
The total min number of expected string values to be used.
Definition Option.hpp:579
CLI11_NODISCARD bool check_lname(std::string name) const
Requires "--" to be removed from string.
Definition Option.hpp:648
CLI11_NODISCARD const results_t & results() const
Get the current complete results set.
Definition Option.hpp:674
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:582
CLI11_NODISCARD std::size_t count() const
Count the total number of times an option was passed.
Definition Option.hpp:364
Option * multi_option_policy(MultiOptionPolicy value=MultiOptionPolicy::Throw)
Take the last argument if given multiple times (or another policy)
Definition Option_inl.hpp:220
CLI11_NODISCARD bool get_inject_separator() const
Return the inject_separator flag.
Definition Option.hpp:532
CLI11_NODISCARD std::string get_flag_value(const std::string &name, std::string input_value) const
Definition Option_inl.hpp:383
CLI11_NODISCARD const std::string & get_description() const
Get the description.
Definition Option.hpp:599
CLI11_NODISCARD bool empty() const
True if the option was not passed.
Definition Option.hpp:367
CLI11_NODISCARD int get_expected_min() const
The number of times the option expects to be included.
Definition Option.hpp:574
void clear()
Clear the parsed results (mostly for testing)
Definition Option.hpp:373
CLI11_NODISCARD int get_expected_max() const
The max number of times the option expects to be included.
Definition Option.hpp:576
Option * default_str(std::string val)
Set the default value string representation (does not change the contained value)
Definition Option.hpp:762
std::string envname_
If given, check the environment for this option.
Definition Option.hpp:258
CLI11_NODISCARD bool get_allow_extra_args() const
Get the current value of allow extra args.
Definition Option.hpp:395
std::vector< std::pair< std::string, std::string > > default_flag_values_
Definition Option.hpp:249
Option * add_result(std::string s)
Puts a result at the end.
Definition Option_inl.hpp:429
CLI11_NODISCARD T as() const
Return the results as the specified type.
Definition Option.hpp:713
Thrown when counting a nonexistent option.
Definition Error.hpp:351
Anything that can error in Parse.
Definition Error.hpp:159
Thrown when a required option is missing.
Definition Error.hpp:228
Thrown when a requires option is missing.
Definition Error.hpp:294
Holds values to load into Options.
Definition ConfigFwd.hpp:29
std::vector< std::string > inputs
Listing of inputs.
Definition ConfigFwd.hpp:36
std::string name
This is the name.
Definition ConfigFwd.hpp:34
CLI11_NODISCARD std::string fullname() const
The list of parents and name joined by ".".
Definition ConfigFwd.hpp:40
bool multiline
indicator if a multiline vector separator was inserted
Definition ConfigFwd.hpp:38
std::vector< std::string > parents
This is the list of parents.
Definition ConfigFwd.hpp:31