CLI11
C++11 Command Line Interface Parser
Loading...
Searching...
No Matches
App.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// [CLI11:public_includes:set]
12#include <algorithm>
13#include <cstdint>
14#include <functional>
15#include <iostream>
16#include <iterator>
17#include <memory>
18#include <numeric>
19#include <set>
20#include <sstream>
21#include <string>
22#include <utility>
23#include <vector>
24// [CLI11:public_includes:end]
25
26// CLI Library includes
27#include "ConfigFwd.hpp"
28#include "Error.hpp"
29#include "FormatterFwd.hpp"
30#include "Macros.hpp"
31#include "Option.hpp"
32#include "Split.hpp"
33#include "StringTools.hpp"
34#include "TypeTools.hpp"
35
36namespace CLI {
37// [CLI11:app_hpp:verbatim]
38
39#ifndef CLI11_PARSE
40#define CLI11_PARSE(app, ...) \
41 try { \
42 (app).parse(__VA_ARGS__); \
43 } catch(const CLI::ParseError &e) { \
44 return (app).exit(e); \
45 }
46#endif
47
48namespace detail {
49enum class Classifier : std::uint8_t {
50 NONE,
51 POSITIONAL_MARK,
52 SHORT,
53 LONG,
54 WINDOWS_STYLE,
55 SUBCOMMAND,
56 SUBCOMMAND_TERMINATOR
57};
58struct AppFriend;
59} // namespace detail
60
61namespace FailureMessage {
63CLI11_INLINE std::string simple(const App *app, const Error &e);
64
66CLI11_INLINE std::string help(const App *app, const Error &e);
67} // namespace FailureMessage
68
70
71enum class config_extras_mode : std::uint8_t { error = 0, ignore, ignore_all, capture };
72
73class App;
74
75using App_p = std::shared_ptr<App>;
76
77namespace detail {
79
80template <typename T, enable_if_t<!std::is_integral<T>::value || (sizeof(T) <= 1U), detail::enabler> = detail::dummy>
81Option *default_flag_modifiers(Option *opt) {
82 return opt->always_capture_default();
83}
84
86template <typename T, enable_if_t<std::is_integral<T>::value && (sizeof(T) > 1U), detail::enabler> = detail::dummy>
87Option *default_flag_modifiers(Option *opt) {
88 return opt->multi_option_policy(MultiOptionPolicy::Sum)->default_str("0")->force_callback();
89}
90
91} // namespace detail
92
93class Option_group;
95
98class App {
99 friend Option;
100 friend detail::AppFriend;
101
102 protected:
103 // This library follows the Google style guide for member names ending in underscores
104
107
109 std::string name_{};
110
112 std::string description_{};
113
115 bool allow_extras_{false};
116
119 config_extras_mode allow_config_extras_{config_extras_mode::ignore};
120
122 bool prefix_command_{false};
123
126
128 bool required_{false};
129
131 bool disabled_{false};
132
134 bool pre_parse_called_{false};
135
139
141 std::function<void(std::size_t)> pre_parse_callback_{};
142
144 std::function<void()> parse_complete_callback_{};
145
147 std::function<void()> final_callback_{};
148
152
155
157 std::vector<Option_p> options_{};
158
162
164 std::string usage_{};
165
167 std::function<std::string()> usage_callback_{};
168
170 std::string footer_{};
171
173 std::function<std::string()> footer_callback_{};
174
176 Option *help_ptr_{nullptr};
177
180
183
185 std::shared_ptr<FormatterBase> formatter_{new Formatter()};
186
188 std::function<std::string(const App *, const Error &e)> failure_message_{FailureMessage::simple};
189
193
194 using missing_t = std::vector<std::pair<detail::Classifier, std::string>>;
195
199 missing_t missing_{};
200
202 std::vector<Option *> parse_order_{};
203
205 std::vector<App *> parsed_subcommands_{};
206
208 std::set<App *> exclude_subcommands_{};
209
212 std::set<Option *> exclude_options_{};
213
216 std::set<App *> need_subcommands_{};
217
220 std::set<Option *> need_options_{};
221
225
227 std::vector<App_p> subcommands_{};
228
230 bool ignore_case_{false};
231
234
237 bool fallthrough_{false};
238
241
244#ifdef _WIN32
245 true
246#else
247 false
248#endif
249 };
252
253 enum class startup_mode : std::uint8_t { stable, enabled, disabled };
256 startup_mode default_startup{startup_mode::stable};
257
259 bool configurable_{false};
260
263
266
269 bool silent_{false};
270
273
275 std::uint32_t parsed_{0U};
276
279
282
284 std::size_t require_option_min_{0};
285
287 std::size_t require_option_max_{0};
288
290 App *parent_{nullptr};
291
293 std::string group_{"SUBCOMMANDS"};
294
296 std::vector<std::string> aliases_{};
297
301
304
306 std::shared_ptr<Config> config_formatter_{new ConfigTOML()};
307
309
310#ifdef _WIN32
312 std::vector<std::string> normalized_argv_{};
313
315 std::vector<char *> normalized_argv_view_{};
316#endif
317
319 App(std::string app_description, std::string app_name, App *parent);
320
321 public:
324
326 explicit App(std::string app_description = "", std::string app_name = "")
327 : App(app_description, app_name, nullptr) {
328 set_help_flag("-h,--help", "Print this help message and exit");
329 }
330
331 App(const App &) = delete;
332 App &operator=(const App &) = delete;
333
335 virtual ~App() = default;
336
338 CLI11_NODISCARD char **ensure_utf8(char **argv);
339
346 App *callback(std::function<void()> app_callback) {
348 parse_complete_callback_ = std::move(app_callback);
349 } else {
350 final_callback_ = std::move(app_callback);
351 }
352 return this;
353 }
354
357 App *final_callback(std::function<void()> app_callback) {
358 final_callback_ = std::move(app_callback);
359 return this;
360 }
361
364 App *parse_complete_callback(std::function<void()> pc_callback) {
365 parse_complete_callback_ = std::move(pc_callback);
366 return this;
367 }
368
371 App *preparse_callback(std::function<void(std::size_t)> pp_callback) {
372 pre_parse_callback_ = std::move(pp_callback);
373 return this;
374 }
375
377 App *name(std::string app_name = "");
378
380 App *alias(std::string app_name);
381
383 App *allow_extras(bool allow = true) {
384 allow_extras_ = allow;
385 return this;
386 }
387
389 App *required(bool require = true) {
390 required_ = require;
391 return this;
392 }
393
395 App *disabled(bool disable = true) {
396 disabled_ = disable;
397 return this;
398 }
399
401 App *silent(bool silence = true) {
402 silent_ = silence;
403 return this;
404 }
405
407 App *allow_non_standard_option_names(bool allowed = true) {
409 return this;
410 }
411
413 App *disabled_by_default(bool disable = true) {
414 if(disable) {
415 default_startup = startup_mode::disabled;
416 } else {
417 default_startup = (default_startup == startup_mode::enabled) ? startup_mode::enabled : startup_mode::stable;
418 }
419 return this;
420 }
421
424 App *enabled_by_default(bool enable = true) {
425 if(enable) {
426 default_startup = startup_mode::enabled;
427 } else {
429 (default_startup == startup_mode::disabled) ? startup_mode::disabled : startup_mode::stable;
430 }
431 return this;
432 }
433
435 App *immediate_callback(bool immediate = true);
436
438 App *validate_positionals(bool validate = true) {
439 validate_positionals_ = validate;
440 return this;
441 }
442
444 App *validate_optional_arguments(bool validate = true) {
446 return this;
447 }
448
450 App *allow_config_extras(bool allow = true) {
451 if(allow) {
452 allow_config_extras_ = config_extras_mode::capture;
453 allow_extras_ = true;
454 } else {
455 allow_config_extras_ = config_extras_mode::error;
456 }
457 return this;
458 }
459
461 App *allow_config_extras(config_extras_mode mode) {
463 return this;
464 }
465
468 App *prefix_command(bool is_prefix = true) {
469 prefix_command_ = is_prefix;
470 return this;
471 }
472
474 App *ignore_case(bool value = true);
475
478 App *allow_windows_style_options(bool value = true) {
480 return this;
481 }
482
484 App *positionals_at_end(bool value = true) {
485 positionals_at_end_ = value;
486 return this;
487 }
488
490 App *configurable(bool value = true) {
491 configurable_ = value;
492 return this;
493 }
494
496 App *ignore_underscore(bool value = true);
497
499 App *formatter(std::shared_ptr<FormatterBase> fmt) {
500 formatter_ = fmt;
501 return this;
502 }
503
505 App *formatter_fn(std::function<std::string(const App *, std::string, AppFormatMode)> fmt) {
506 formatter_ = std::make_shared<FormatterLambda>(fmt);
507 return this;
508 }
509
511 App *config_formatter(std::shared_ptr<Config> fmt) {
512 config_formatter_ = fmt;
513 return this;
514 }
515
517 CLI11_NODISCARD bool parsed() const { return parsed_ > 0; }
518
521
525
540 Option *add_option(std::string option_name,
541 callback_t option_callback,
542 std::string option_description = "",
543 bool defaulted = false,
544 std::function<std::string()> func = {});
545
547 template <typename AssignTo,
548 typename ConvertTo = AssignTo,
549 enable_if_t<!std::is_const<ConvertTo>::value, detail::enabler> = detail::dummy>
550 Option *add_option(std::string option_name,
551 AssignTo &variable,
552 std::string option_description = "") {
553
554 auto fun = [&variable](const CLI::results_t &res) { // comment for spacing
555 return detail::lexical_conversion<AssignTo, ConvertTo>(res, variable);
556 };
557
558 Option *opt = add_option(option_name, fun, option_description, false, [&variable]() {
559 return CLI::detail::checked_to_string<AssignTo, ConvertTo>(variable);
560 });
561 opt->type_name(detail::type_name<ConvertTo>());
562 // these must be actual lvalues since (std::max) sometimes is defined in terms of references and references
563 // to structs used in the evaluation can be temporary so that would cause issues.
566 opt->type_size(detail::type_count_min<ConvertTo>::value, (std::max)(Tcount, XCcount));
567 opt->expected(detail::expected_count<ConvertTo>::value);
569 return opt;
570 }
571
573 template <typename AssignTo, enable_if_t<!std::is_const<AssignTo>::value, detail::enabler> = detail::dummy>
574 Option *add_option_no_stream(std::string option_name,
575 AssignTo &variable,
576 std::string option_description = "") {
577
578 auto fun = [&variable](const CLI::results_t &res) { // comment for spacing
579 return detail::lexical_conversion<AssignTo, AssignTo>(res, variable);
580 };
581
582 Option *opt = add_option(option_name, fun, option_description, false, []() { return std::string{}; });
583 opt->type_name(detail::type_name<AssignTo>());
584 opt->type_size(detail::type_count_min<AssignTo>::value, detail::type_count<AssignTo>::value);
585 opt->expected(detail::expected_count<AssignTo>::value);
587 return opt;
588 }
589
591 template <typename ArgType>
592 Option *add_option_function(std::string option_name,
593 const std::function<void(const ArgType &)> &func,
594 std::string option_description = "") {
595
596 auto fun = [func](const CLI::results_t &res) {
597 ArgType variable;
598 bool result = detail::lexical_conversion<ArgType, ArgType>(res, variable);
599 if(result) {
600 func(variable);
601 }
602 return result;
603 };
604
605 Option *opt = add_option(option_name, std::move(fun), option_description, false);
606 opt->type_name(detail::type_name<ArgType>());
607 opt->type_size(detail::type_count_min<ArgType>::value, detail::type_count<ArgType>::value);
608 opt->expected(detail::expected_count<ArgType>::value);
609 return opt;
610 }
611
613 Option *add_option(std::string option_name) {
614 return add_option(option_name, CLI::callback_t{}, std::string{}, false);
615 }
616
618 template <typename T,
619 enable_if_t<std::is_const<T>::value && std::is_constructible<std::string, T>::value, detail::enabler> =
620 detail::dummy>
621 Option *add_option(std::string option_name, T &option_description) {
622 return add_option(option_name, CLI::callback_t(), option_description, false);
623 }
624
626 Option *set_help_flag(std::string flag_name = "", const std::string &help_description = "");
627
629 Option *set_help_all_flag(std::string help_name = "", const std::string &help_description = "");
630
632 Option *set_version_flag(std::string flag_name = "",
633 const std::string &versionString = "",
634 const std::string &version_help = "Display program version information and exit");
635
637 Option *set_version_flag(std::string flag_name,
638 std::function<std::string()> vfunc,
639 const std::string &version_help = "Display program version information and exit");
640
641 private:
643 Option *_add_flag_internal(std::string flag_name, CLI::callback_t fun, std::string flag_description);
644
645 public:
647 Option *add_flag(std::string flag_name) { return _add_flag_internal(flag_name, CLI::callback_t(), std::string{}); }
648
652 template <typename T,
653 enable_if_t<std::is_const<T>::value && std::is_constructible<std::string, T>::value, detail::enabler> =
654 detail::dummy>
655 Option *add_flag(std::string flag_name, T &flag_description) {
656 return _add_flag_internal(flag_name, CLI::callback_t(), flag_description);
657 }
658
661 template <typename T,
662 enable_if_t<!detail::is_mutable_container<T>::value && !std::is_const<T>::value &&
663 !std::is_constructible<std::function<void(int)>, T>::value,
664 detail::enabler> = detail::dummy>
665 Option *add_flag(std::string flag_name,
666 T &flag_result,
667 std::string flag_description = "") {
668
669 CLI::callback_t fun = [&flag_result](const CLI::results_t &res) {
670 using CLI::detail::lexical_cast;
671 return lexical_cast(res[0], flag_result);
672 };
673 auto *opt = _add_flag_internal(flag_name, std::move(fun), std::move(flag_description));
674 return detail::default_flag_modifiers<T>(opt);
675 }
676
678 template <typename T,
679 enable_if_t<!std::is_assignable<std::function<void(std::int64_t)> &, T>::value, detail::enabler> =
680 detail::dummy>
681 Option *add_flag(std::string flag_name,
682 std::vector<T> &flag_results,
683 std::string flag_description = "") {
684 CLI::callback_t fun = [&flag_results](const CLI::results_t &res) {
685 bool retval = true;
686 for(const auto &elem : res) {
687 using CLI::detail::lexical_cast;
688 flag_results.emplace_back();
689 retval &= lexical_cast(elem, flag_results.back());
690 }
691 return retval;
692 };
693 return _add_flag_internal(flag_name, std::move(fun), std::move(flag_description))
694 ->multi_option_policy(MultiOptionPolicy::TakeAll)
696 }
697
699 Option *add_flag_callback(std::string flag_name,
700 std::function<void(void)> function,
701 std::string flag_description = "");
702
704 Option *add_flag_function(std::string flag_name,
705 std::function<void(std::int64_t)> function,
706 std::string flag_description = "");
707
708#ifdef CLI11_CPP14
710 Option *add_flag(std::string flag_name,
711 std::function<void(std::int64_t)> function,
712 std::string flag_description = "") {
713 return add_flag_function(std::move(flag_name), std::move(function), std::move(flag_description));
714 }
715#endif
716
718 Option *set_config(std::string option_name = "",
719 std::string default_filename = "",
720 const std::string &help_message = "Read an ini file",
721 bool config_required = false);
722
724 bool remove_option(Option *opt);
725
727 template <typename T = Option_group>
728 T *add_option_group(std::string group_name, std::string group_description = "") {
729 if(!detail::valid_alias_name_string(group_name)) {
730 throw IncorrectConstruction("option group names may not contain newlines or null characters");
731 }
732 auto option_group = std::make_shared<T>(std::move(group_description), group_name, this);
733 auto *ptr = option_group.get();
734 // move to App_p for overload resolution on older gcc versions
735 App_p app_ptr = std::dynamic_pointer_cast<App>(option_group);
736 // don't inherit the footer in option groups and clear the help flag by default
737 app_ptr->footer_ = "";
738 app_ptr->set_help_flag();
739 add_subcommand(std::move(app_ptr));
740 return ptr;
741 }
742
746
748 App *add_subcommand(std::string subcommand_name = "", std::string subcommand_description = "");
749
751 App *add_subcommand(CLI::App_p subcom);
752
754 bool remove_subcommand(App *subcom);
755
758 App *get_subcommand(const App *subcom) const;
759
761 CLI11_NODISCARD App *get_subcommand(std::string subcom) const;
762
765 CLI11_NODISCARD App *get_subcommand_no_throw(std::string subcom) const noexcept;
766
768 CLI11_NODISCARD App *get_subcommand(int index = 0) const;
769
771 CLI::App_p get_subcommand_ptr(App *subcom) const;
772
774 CLI11_NODISCARD CLI::App_p get_subcommand_ptr(std::string subcom) const;
775
777 CLI11_NODISCARD CLI::App_p get_subcommand_ptr(int index = 0) const;
778
780 CLI11_NODISCARD App *get_option_group(std::string group_name) const;
781
785 CLI11_NODISCARD std::size_t count() const { return parsed_; }
786
789 CLI11_NODISCARD std::size_t count_all() const;
790
792 App *group(std::string group_name) {
793 group_ = group_name;
794 return this;
795 }
796
801 return this;
802 }
803
808 if(value < 0) {
810 require_subcommand_max_ = static_cast<std::size_t>(-value);
811 } else {
812 require_subcommand_min_ = static_cast<std::size_t>(value);
813 require_subcommand_max_ = static_cast<std::size_t>(value);
814 }
815 return this;
816 }
817
820 App *require_subcommand(std::size_t min, std::size_t max) {
823 return this;
824 }
825
830 return this;
831 }
832
836 App *require_option(int value) {
837 if(value < 0) {
839 require_option_max_ = static_cast<std::size_t>(-value);
840 } else {
841 require_option_min_ = static_cast<std::size_t>(value);
842 require_option_max_ = static_cast<std::size_t>(value);
843 }
844 return this;
845 }
846
849 App *require_option(std::size_t min, std::size_t max) {
852 return this;
853 }
854
857 App *fallthrough(bool value = true) {
858 fallthrough_ = value;
859 return this;
860 }
861
863 App *subcommand_fallthrough(bool value = true) {
865 return this;
866 }
867
870 explicit operator bool() const { return parsed_ > 0; }
871
875
879 virtual void pre_callback() {}
880
884 //
886 void clear();
887
890 void parse(int argc, const char *const *argv);
891 void parse(int argc, const wchar_t *const *argv);
892
893 private:
894 template <class CharT> void parse_char_t(int argc, const CharT *const *argv);
895
896 public:
901 void parse(std::string commandline, bool program_name_included = false);
902 void parse(std::wstring commandline, bool program_name_included = false);
903
906 void parse(std::vector<std::string> &args);
907
909 void parse(std::vector<std::string> &&args);
910
911 void parse_from_stream(std::istream &input);
912
914 void failure_message(std::function<std::string(const App *, const Error &e)> function) {
915 failure_message_ = function;
916 }
917
919 int exit(const Error &e, std::ostream &out = std::cout, std::ostream &err = std::cerr) const;
920
924
926 CLI11_NODISCARD std::size_t count(std::string option_name) const { return get_option(option_name)->count(); }
927
930 CLI11_NODISCARD std::vector<App *> get_subcommands() const { return parsed_subcommands_; }
931
934 std::vector<const App *> get_subcommands(const std::function<bool(const App *)> &filter) const;
935
938 std::vector<App *> get_subcommands(const std::function<bool(App *)> &filter);
939
941 bool got_subcommand(const App *subcom) const {
942 // get subcom needed to verify that this was a real subcommand
943 return get_subcommand(subcom)->parsed_ > 0;
944 }
945
947 CLI11_NODISCARD bool got_subcommand(std::string subcommand_name) const noexcept {
948 App *sub = get_subcommand_no_throw(subcommand_name);
949 return (sub != nullptr) ? (sub->parsed_ > 0) : false;
950 }
951
954 if(opt == nullptr) {
955 throw OptionNotFound("nullptr passed");
956 }
957 exclude_options_.insert(opt);
958 return this;
959 }
960
962 App *excludes(App *app) {
963 if(app == nullptr) {
964 throw OptionNotFound("nullptr passed");
965 }
966 if(app == this) {
967 throw OptionNotFound("cannot self reference in needs");
968 }
969 auto res = exclude_subcommands_.insert(app);
970 // subcommand exclusion should be symmetric
971 if(res.second) {
972 app->exclude_subcommands_.insert(this);
973 }
974 return this;
975 }
976
977 App *needs(Option *opt) {
978 if(opt == nullptr) {
979 throw OptionNotFound("nullptr passed");
980 }
981 need_options_.insert(opt);
982 return this;
983 }
984
985 App *needs(App *app) {
986 if(app == nullptr) {
987 throw OptionNotFound("nullptr passed");
988 }
989 if(app == this) {
990 throw OptionNotFound("cannot self reference in needs");
991 }
992 need_subcommands_.insert(app);
993 return this;
994 }
995
997 bool remove_excludes(Option *opt);
998
1000 bool remove_excludes(App *app);
1001
1003 bool remove_needs(Option *opt);
1004
1006 bool remove_needs(App *app);
1010
1012 App *usage(std::string usage_string) {
1013 usage_ = std::move(usage_string);
1014 return this;
1015 }
1017 App *usage(std::function<std::string()> usage_function) {
1018 usage_callback_ = std::move(usage_function);
1019 return this;
1020 }
1022 App *footer(std::string footer_string) {
1023 footer_ = std::move(footer_string);
1024 return this;
1025 }
1027 App *footer(std::function<std::string()> footer_function) {
1028 footer_callback_ = std::move(footer_function);
1029 return this;
1030 }
1033 CLI11_NODISCARD std::string config_to_str(bool default_also = false, bool write_description = false) const {
1034 return config_formatter_->to_config(this, default_also, write_description, "");
1035 }
1036
1039 CLI11_NODISCARD std::string help(std::string prev = "", AppFormatMode mode = AppFormatMode::Normal) const;
1040
1042 CLI11_NODISCARD std::string version() const;
1046
1048 CLI11_NODISCARD std::shared_ptr<FormatterBase> get_formatter() const { return formatter_; }
1049
1051 CLI11_NODISCARD std::shared_ptr<Config> get_config_formatter() const { return config_formatter_; }
1052
1054 CLI11_NODISCARD std::shared_ptr<ConfigBase> get_config_formatter_base() const {
1055 // This is safer as a dynamic_cast if we have RTTI, as Config -> ConfigBase
1056#if CLI11_USE_STATIC_RTTI == 0
1057 return std::dynamic_pointer_cast<ConfigBase>(config_formatter_);
1058#else
1059 return std::static_pointer_cast<ConfigBase>(config_formatter_);
1060#endif
1061 }
1062
1064 CLI11_NODISCARD std::string get_description() const { return description_; }
1065
1067 App *description(std::string app_description) {
1068 description_ = std::move(app_description);
1069 return this;
1070 }
1071
1073 std::vector<const Option *> get_options(const std::function<bool(const Option *)> filter = {}) const;
1074
1076 std::vector<Option *> get_options(const std::function<bool(Option *)> filter = {});
1077
1079 CLI11_NODISCARD Option *get_option_no_throw(std::string option_name) noexcept;
1080
1082 CLI11_NODISCARD const Option *get_option_no_throw(std::string option_name) const noexcept;
1083
1085 CLI11_NODISCARD const Option *get_option(std::string option_name) const {
1086 const auto *opt = get_option_no_throw(option_name);
1087 if(opt == nullptr) {
1088 throw OptionNotFound(option_name);
1089 }
1090 return opt;
1091 }
1092
1094 Option *get_option(std::string option_name) {
1095 auto *opt = get_option_no_throw(option_name);
1096 if(opt == nullptr) {
1097 throw OptionNotFound(option_name);
1098 }
1099 return opt;
1100 }
1101
1103 const Option *operator[](const std::string &option_name) const { return get_option(option_name); }
1104
1106 const Option *operator[](const char *option_name) const { return get_option(option_name); }
1107
1109 CLI11_NODISCARD bool get_ignore_case() const { return ignore_case_; }
1110
1112 CLI11_NODISCARD bool get_ignore_underscore() const { return ignore_underscore_; }
1113
1115 CLI11_NODISCARD bool get_fallthrough() const { return fallthrough_; }
1116
1118 CLI11_NODISCARD bool get_subcommand_fallthrough() const { return subcommand_fallthrough_; }
1119
1121 CLI11_NODISCARD bool get_allow_windows_style_options() const { return allow_windows_style_options_; }
1122
1124 CLI11_NODISCARD bool get_positionals_at_end() const { return positionals_at_end_; }
1125
1127 CLI11_NODISCARD bool get_configurable() const { return configurable_; }
1128
1130 CLI11_NODISCARD const std::string &get_group() const { return group_; }
1131
1133 CLI11_NODISCARD std::string get_usage() const {
1134 return (usage_callback_) ? usage_callback_() + '\n' + usage_ : usage_;
1135 }
1136
1138 CLI11_NODISCARD std::string get_footer() const {
1139 return (footer_callback_) ? footer_callback_() + '\n' + footer_ : footer_;
1140 }
1141
1143 CLI11_NODISCARD std::size_t get_require_subcommand_min() const { return require_subcommand_min_; }
1144
1146 CLI11_NODISCARD std::size_t get_require_subcommand_max() const { return require_subcommand_max_; }
1147
1149 CLI11_NODISCARD std::size_t get_require_option_min() const { return require_option_min_; }
1150
1152 CLI11_NODISCARD std::size_t get_require_option_max() const { return require_option_max_; }
1153
1155 CLI11_NODISCARD bool get_prefix_command() const { return prefix_command_; }
1156
1158 CLI11_NODISCARD bool get_allow_extras() const { return allow_extras_; }
1159
1161 CLI11_NODISCARD bool get_required() const { return required_; }
1162
1164 CLI11_NODISCARD bool get_disabled() const { return disabled_; }
1165
1167 CLI11_NODISCARD bool get_silent() const { return silent_; }
1168
1171
1173 CLI11_NODISCARD bool get_immediate_callback() const { return immediate_callback_; }
1174
1176 CLI11_NODISCARD bool get_disabled_by_default() const { return (default_startup == startup_mode::disabled); }
1177
1179 CLI11_NODISCARD bool get_enabled_by_default() const { return (default_startup == startup_mode::enabled); }
1181 CLI11_NODISCARD bool get_validate_positionals() const { return validate_positionals_; }
1183 CLI11_NODISCARD bool get_validate_optional_arguments() const { return validate_optional_arguments_; }
1184
1186 CLI11_NODISCARD config_extras_mode get_allow_config_extras() const { return allow_config_extras_; }
1187
1190
1192 CLI11_NODISCARD const Option *get_help_ptr() const { return help_ptr_; }
1193
1195 CLI11_NODISCARD const Option *get_help_all_ptr() const { return help_all_ptr_; }
1196
1199
1201 CLI11_NODISCARD const Option *get_config_ptr() const { return config_ptr_; }
1202
1205
1207 CLI11_NODISCARD const Option *get_version_ptr() const { return version_ptr_; }
1208
1210 App *get_parent() { return parent_; }
1211
1213 CLI11_NODISCARD const App *get_parent() const { return parent_; }
1214
1216 CLI11_NODISCARD const std::string &get_name() const { return name_; }
1217
1219 CLI11_NODISCARD const std::vector<std::string> &get_aliases() const { return aliases_; }
1220
1223 aliases_.clear();
1224 return this;
1225 }
1226
1228 CLI11_NODISCARD std::string get_display_name(bool with_aliases = false) const;
1229
1231 CLI11_NODISCARD bool check_name(std::string name_to_check) const;
1232
1234 CLI11_NODISCARD std::vector<std::string> get_groups() const;
1235
1237 CLI11_NODISCARD const std::vector<Option *> &parse_order() const { return parse_order_; }
1238
1240 CLI11_NODISCARD std::vector<std::string> remaining(bool recurse = false) const;
1241
1243 CLI11_NODISCARD std::vector<std::string> remaining_for_passthrough(bool recurse = false) const;
1244
1246 CLI11_NODISCARD std::size_t remaining_size(bool recurse = false) const;
1247
1249
1250 protected:
1255 void _validate() const;
1256
1260 void _configure();
1261
1263 void run_callback(bool final_mode = false, bool suppress_final_callback = false);
1264
1266 CLI11_NODISCARD bool _valid_subcommand(const std::string &current, bool ignore_used = true) const;
1267
1269 CLI11_NODISCARD detail::Classifier _recognize(const std::string &current,
1270 bool ignore_used_subcommands = true) const;
1271
1272 // The parse function is now broken into several parts, and part of process
1273
1275 void _process_config_file();
1276
1278 bool _process_config_file(const std::string &config_file, bool throw_error);
1279
1281 void _process_env();
1282
1284 void _process_callbacks();
1285
1289 void _process_help_flags(bool trigger_help = false, bool trigger_all_help = false) const;
1290
1292 void _process_requirements();
1293
1295 void _process();
1296
1298 void _process_extras();
1299
1302 void _process_extras(std::vector<std::string> &args);
1303
1305 void increment_parsed();
1306
1308 void _parse(std::vector<std::string> &args);
1309
1311 void _parse(std::vector<std::string> &&args);
1312
1314 void _parse_stream(std::istream &input);
1315
1320 void _parse_config(const std::vector<ConfigItem> &args);
1321
1323 bool _parse_single_config(const ConfigItem &item, std::size_t level = 0);
1324
1327 bool _parse_single(std::vector<std::string> &args, bool &positional_only);
1328
1330 CLI11_NODISCARD std::size_t _count_remaining_positionals(bool required_only = false) const;
1331
1333 CLI11_NODISCARD bool _has_remaining_positionals() const;
1334
1338 bool _parse_positional(std::vector<std::string> &args, bool haltOnSubcommand);
1339
1342 CLI11_NODISCARD App *
1343 _find_subcommand(const std::string &subc_name, bool ignore_disabled, bool ignore_used) const noexcept;
1344
1349 bool _parse_subcommand(std::vector<std::string> &args);
1350
1354 bool _parse_arg(std::vector<std::string> &args, detail::Classifier current_type, bool local_processing_only);
1355
1357 void _trigger_pre_parse(std::size_t remaining_args);
1358
1361
1363 CLI11_NODISCARD const std::string &_compare_subcommand_names(const App &subcom, const App &base) const;
1364
1366 void _move_to_missing(detail::Classifier val_type, const std::string &val);
1367
1368 public:
1370 void _move_option(Option *opt, App *app);
1371}; // namespace CLI
1372
1374class Option_group : public App {
1375 public:
1376 Option_group(std::string group_description, std::string group_name, App *parent)
1377 : App(std::move(group_description), "", parent) {
1378 group(group_name);
1379 // option groups should have automatic fallthrough
1380 if(group_name.empty() || group_name.front() == '+') {
1381 // help will not be used by default in these contexts
1382 set_help_flag("");
1384 }
1385 }
1386 using App::add_option;
1389 if(get_parent() == nullptr) {
1390 throw OptionNotFound("Unable to locate the specified option");
1391 }
1392 get_parent()->_move_option(opt, this);
1393 return opt;
1394 }
1396 void add_options(Option *opt) { add_option(opt); }
1398 template <typename... Args> void add_options(Option *opt, Args... args) {
1399 add_option(opt);
1400 add_options(args...);
1401 }
1402 using App::add_subcommand;
1405 App_p subc = subcom->get_parent()->get_subcommand_ptr(subcom);
1406 subc->get_parent()->remove_subcommand(subcom);
1407 add_subcommand(std::move(subc));
1408 return subcom;
1409 }
1410};
1411
1413CLI11_INLINE void TriggerOn(App *trigger_app, App *app_to_enable);
1414
1416CLI11_INLINE void TriggerOn(App *trigger_app, std::vector<App *> apps_to_enable);
1417
1419CLI11_INLINE void TriggerOff(App *trigger_app, App *app_to_enable);
1420
1422CLI11_INLINE void TriggerOff(App *trigger_app, std::vector<App *> apps_to_enable);
1423
1425CLI11_INLINE void deprecate_option(Option *opt, const std::string &replacement = "");
1426
1428inline void deprecate_option(App *app, const std::string &option_name, const std::string &replacement = "") {
1429 auto *opt = app->get_option(option_name);
1430 deprecate_option(opt, replacement);
1431}
1432
1434inline void deprecate_option(App &app, const std::string &option_name, const std::string &replacement = "") {
1435 auto *opt = app.get_option(option_name);
1436 deprecate_option(opt, replacement);
1437}
1438
1440CLI11_INLINE void retire_option(App *app, Option *opt);
1441
1443CLI11_INLINE void retire_option(App &app, Option *opt);
1444
1446CLI11_INLINE void retire_option(App *app, const std::string &option_name);
1447
1449CLI11_INLINE void retire_option(App &app, const std::string &option_name);
1450
1451namespace detail {
1454#ifdef CLI11_CPP14
1455
1457 template <typename... Args> static decltype(auto) parse_arg(App *app, Args &&...args) {
1458 return app->_parse_arg(std::forward<Args>(args)...);
1459 }
1460
1462 template <typename... Args> static decltype(auto) parse_subcommand(App *app, Args &&...args) {
1463 return app->_parse_subcommand(std::forward<Args>(args)...);
1464 }
1465#else
1467 template <typename... Args>
1468 static auto parse_arg(App *app, Args &&...args) ->
1469 typename std::result_of<decltype (&App::_parse_arg)(App, Args...)>::type {
1470 return app->_parse_arg(std::forward<Args>(args)...);
1471 }
1472
1474 template <typename... Args>
1475 static auto parse_subcommand(App *app, Args &&...args) ->
1476 typename std::result_of<decltype (&App::_parse_subcommand)(App, Args...)>::type {
1477 return app->_parse_subcommand(std::forward<Args>(args)...);
1478 }
1479#endif
1482};
1483} // namespace detail
1484
1485// [CLI11:app_hpp:end]
1486} // namespace CLI
1487
1488#ifndef CLI11_COMPILE
1489#include "impl/App_inl.hpp" // IWYU pragma: export
1490#endif
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:844
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:674
CLI11_NODISCARD std::string help(std::string prev="", AppFormatMode mode=AppFormatMode::Normal) const
Definition App_inl.hpp:770
CLI11_NODISCARD std::size_t remaining_size(bool recurse=false) const
This returns the number of remaining options, minus the – separator.
Definition App_inl.hpp:969
const Option * operator[](const std::string &option_name) const
Shortcut bracket operator for getting a pointer to an option.
Definition App.hpp:1103
CLI11_NODISCARD bool _has_remaining_positionals() const
Count the required remaining positional arguments.
Definition App_inl.hpp:1695
App * configurable(bool value=true)
Specify that the subcommand can be triggered by a config file.
Definition App.hpp:490
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:1082
App * immediate_callback(bool immediate=true)
Set the subcommand callback to be executed immediately on subcommand completion.
Definition App_inl.hpp:120
Option * set_help_flag(std::string flag_name="", const std::string &help_description="")
Set a help flag, replace the existing one if present.
Definition App_inl.hpp:251
App * _get_fallthrough_parent()
Get the appropriate parent to fallthrough to which is the first one that has a name or the main app.
Definition App_inl.hpp:2142
CLI11_NODISCARD std::string config_to_str(bool default_also=false, bool write_description=false) const
Definition App.hpp:1033
bool allow_non_standard_options_
indicator that the subcommand should allow non-standard option arguments, such as -single_dash_flag
Definition App.hpp:272
App * usage(std::function< std::string()> usage_function)
Set usage.
Definition App.hpp:1017
CLI11_NODISCARD bool get_enabled_by_default() const
Get the status of disabled by default.
Definition App.hpp:1179
Option * config_ptr_
Pointer to the config option.
Definition App.hpp:303
CLI11_NODISCARD bool get_allow_non_standard_option_names() const
Get the status of silence.
Definition App.hpp:1170
CLI11_NODISCARD bool get_configurable() const
Check the status of the allow windows style options.
Definition App.hpp:1127
Option * add_option_no_stream(std::string option_name, AssignTo &variable, std::string option_description="")
Add option for assigning to a variable.
Definition App.hpp:574
CLI11_NODISCARD std::string get_usage() const
Generate and return the usage.
Definition App.hpp:1133
CLI11_NODISCARD std::shared_ptr< FormatterBase > get_formatter() const
Access the formatter.
Definition App.hpp:1048
Option * add_option(std::string option_name)
Add option with no description or variable assignment.
Definition App.hpp:613
App * subcommand_fallthrough(bool value=true)
Set subcommand fallthrough, set to true so that subcommands on parents are recognized.
Definition App.hpp:863
App * config_formatter(std::shared_ptr< Config > fmt)
Set the config formatter.
Definition App.hpp:511
App * allow_config_extras(bool allow=true)
ignore extras in config files
Definition App.hpp:450
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:413
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:2204
std::size_t require_option_min_
Minimum required options (not inheritable!)
Definition App.hpp:284
App * silent(bool silence=true)
silence the subcommand from showing up in the processed list
Definition App.hpp:401
App * clear_aliases()
clear all the aliases of the current App
Definition App.hpp:1222
CLI11_NODISCARD bool get_ignore_underscore() const
Check the status of ignore_underscore.
Definition App.hpp:1112
App * ignore_underscore(bool value=true)
Ignore underscore. Subcommands inherit value.
Definition App_inl.hpp:146
App * allow_extras(bool allow=true)
Remove the error when extras are left over on the command line.
Definition App.hpp:383
App * fallthrough(bool value=true)
Definition App.hpp:857
std::size_t require_subcommand_max_
Max number of subcommands allowed (parsing stops after this number). 0 is unlimited INHERITABLE.
Definition App.hpp:281
Option * get_config_ptr()
Get a pointer to the config option.
Definition App.hpp:1198
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:937
CLI11_NODISCARD bool get_allow_extras() const
Get the status of allow extras.
Definition App.hpp:1158
CLI11_NODISCARD std::vector< std::string > remaining_for_passthrough(bool recurse=false) const
This returns the missing options in a form ready for processing by another command line program.
Definition App_inl.hpp:963
std::uint32_t parsed_
Counts the number of times this command/subcommand was parsed.
Definition App.hpp:275
CLI11_NODISCARD App * get_option_group(std::string group_name) const
Check to see if an option group is part of this App.
Definition App_inl.hpp:526
App * require_subcommand()
The argumentless form of require subcommand requires 1 or more subcommands.
Definition App.hpp:798
Option * get_option(std::string option_name)
Get an option by name (non-const version)
Definition App.hpp:1094
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:1221
CLI11_NODISCARD const Option * get_version_ptr() const
Get a pointer to the version option. (const)
Definition App.hpp:1207
void _process_requirements()
Verify required options and cross requirements. Subcommands too (only if selected).
Definition App_inl.hpp:1243
CLI11_NODISCARD std::size_t count_all() const
Definition App_inl.hpp:535
CLI11_NODISCARD bool get_fallthrough() const
Check the status of fallthrough.
Definition App.hpp:1115
bool disabled_
If set to true the subcommand is disabled and cannot be used, ignored for main app.
Definition App.hpp:131
CLI11_NODISCARD bool get_prefix_command() const
Get the prefix command status.
Definition App.hpp:1155
Option * add_option(std::string option_name, AssignTo &variable, std::string option_description="")
Add option for assigning to a variable.
Definition App.hpp:550
CLI11_NODISCARD std::size_t get_require_subcommand_max() const
Get the required max subcommand value.
Definition App.hpp:1146
Option * set_version_flag(std::string flag_name="", const std::string &versionString="", const std::string &version_help="Display program version information and exit")
Set a version flag and version display string, replace the existing one if present.
Definition App_inl.hpp:284
bool required_
If set to true the subcommand is required to be processed and used, ignored for main app.
Definition App.hpp:128
bool remove_needs(Option *opt)
Removes an option from the needs list of this subcommand.
Definition App_inl.hpp:752
const Option * operator[](const char *option_name) const
Shortcut bracket operator for getting a pointer to an option.
Definition App.hpp:1106
CLI11_NODISCARD bool get_immediate_callback() const
Get the status of disabled.
Definition App.hpp:1173
Option * get_help_ptr()
Get a pointer to the help flag.
Definition App.hpp:1189
App * require_subcommand(int value)
Definition App.hpp:807
void _configure()
Definition App_inl.hpp:1018
CLI11_NODISCARD std::size_t _count_remaining_positionals(bool required_only=false) const
Count the required remaining positional arguments.
Definition App_inl.hpp:1683
Option * add_flag_function(std::string flag_name, std::function< void(std::int64_t)> function, std::string flag_description="")
Add option for callback with an integer value.
Definition App_inl.hpp:360
OptionDefaults * option_defaults()
Get the OptionDefault object, to set option defaults.
Definition App.hpp:520
void parse(int argc, const char *const *argv)
Definition App_inl.hpp:564
void _process_config_file()
Read and process a configuration file (main app only)
Definition App_inl.hpp:1139
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:1423
config_extras_mode allow_config_extras_
Definition App.hpp:119
CLI11_NODISCARD bool check_name(std::string name_to_check) const
Check the name, case-insensitive and underscore insensitive if set.
Definition App_inl.hpp:896
CLI11_NODISCARD std::string get_footer() const
Generate and return the footer.
Definition App.hpp:1138
App * required(bool require=true)
Remove the error when extras are left over on the command line.
Definition App.hpp:389
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:1195
bool remove_subcommand(App *subcom)
Removes a subcommand from the App. Takes a subcommand pointer. Returns true if found and removed.
Definition App_inl.hpp:456
App * parent_
A pointer to the parent if this is a subcommand.
Definition App.hpp:290
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:2124
App * group(std::string group_name)
Changes the group membership.
Definition App.hpp:792
CLI::App_p get_subcommand_ptr(App *subcom) const
Check to see if a subcommand is part of this command and get a shared_ptr to it.
Definition App_inl.hpp:501
std::function< std::string()> footer_callback_
This is a function that generates a footer to put after all other options in help output.
Definition App.hpp:173
std::function< void()> parse_complete_callback_
This is a function that runs when parsing has finished.
Definition App.hpp:144
CLI11_NODISCARD bool get_subcommand_fallthrough() const
Check the status of subcommand fallthrough.
Definition App.hpp:1118
virtual void pre_callback()
Definition App.hpp:879
T * add_option_group(std::string group_name, std::string group_description="")
creates an option group as part of the given app
Definition App.hpp:728
App * get_parent()
Get the parent of this subcommand (or nullptr if main app)
Definition App.hpp:1210
Option * add_flag(std::string flag_name)
Add a flag with no description or variable assignment.
Definition App.hpp:647
void _validate() const
Definition App_inl.hpp:983
std::string name_
Subcommand name or program name (from parser if name is empty)
Definition App.hpp:109
std::vector< App * > parsed_subcommands_
This is a list of the subcommands collected, in order.
Definition App.hpp:205
App(std::string app_description="", std::string app_name="")
Create a new program. Pass in the same arguments as main(), along with a help string.
Definition App.hpp:326
CLI11_NODISCARD const Option * get_help_ptr() const
Get a pointer to the help flag. (const)
Definition App.hpp:1192
bool ignore_underscore_
If true, the program should ignore underscores INHERITABLE.
Definition App.hpp:233
App * allow_windows_style_options(bool value=true)
Definition App.hpp:478
missing_t missing_
Definition App.hpp:199
CLI11_NODISCARD bool get_validate_positionals() const
Get the status of validating positionals.
Definition App.hpp:1181
Option * add_option_function(std::string option_name, const std::function< void(const ArgType &)> &func, std::string option_description="")
Add option for a callback of a specific type.
Definition App.hpp:592
void run_callback(bool final_mode=false, bool suppress_final_callback=false)
Internal function to run (App) callback, bottom up.
Definition App_inl.hpp:1038
std::size_t require_subcommand_min_
Minimum required subcommands (not inheritable!)
Definition App.hpp:278
App * usage(std::string usage_string)
Set usage.
Definition App.hpp:1012
void _process_env()
Get envname options if not yet passed. Runs on all subcommands.
Definition App_inl.hpp:1175
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:1475
CLI11_NODISCARD std::string get_display_name(bool with_aliases=false) const
Get a display name for an app.
Definition App_inl.hpp:880
void failure_message(std::function< std::string(const App *, const Error &e)> function)
Provide a function to print a help message. The function gets access to the App pointer and error.
Definition App.hpp:914
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:2153
void clear()
Reset the parsed data.
Definition App_inl.hpp:549
CLI11_NODISCARD std::size_t get_require_option_max() const
Get the required max option value.
Definition App.hpp:1152
App * enabled_by_default(bool enable=true)
Definition App.hpp:424
App * footer(std::string footer_string)
Set footer.
Definition App.hpp:1022
App * get_subcommand(const App *subcom) const
Definition App_inl.hpp:472
App * require_option(int value)
Definition App.hpp:836
CLI11_NODISCARD std::string version() const
Displays a version string.
Definition App_inl.hpp:784
virtual ~App()=default
virtual destructor
CLI11_NODISCARD App * get_subcommand_no_throw(std::string subcom) const noexcept
Definition App_inl.hpp:488
CLI11_NODISCARD std::size_t count(std::string option_name) const
Counts the number of times the given option was passed.
Definition App.hpp:926
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:404
App * require_option()
The argumentless form of require option requires 1 or more options be used.
Definition App.hpp:827
App(std::string app_description, std::string app_name, App *parent)
Special private constructor for subcommand.
Definition App_inl.hpp:29
std::function< std::string()> usage_callback_
This is a function that generates a usage to put after program/subcommand description in help output.
Definition App.hpp:167
App * add_subcommand(std::string subcommand_name="", std::string subcommand_description="")
Add a subcommand. Inherits INHERITABLE and OptionDefaults, and help flag.
Definition App_inl.hpp:425
App * preparse_callback(std::function< void(std::size_t)> pp_callback)
Definition App.hpp:371
Option * add_flag_callback(std::string flag_name, std::function< void(void)> function, std::string flag_description="")
Add option for callback that is triggered with a true flag and takes no arguments.
Definition App_inl.hpp:343
bool 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:1371
bool immediate_callback_
Definition App.hpp:138
bool _parse_single(std::vector< std::string > &args, bool &positional_only)
Definition App_inl.hpp:1641
App * name(std::string app_name="")
Set a name for the app (empty will use parser to set the name)
Definition App_inl.hpp:85
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:2220
CLI11_NODISCARD bool get_required() const
Get the status of required.
Definition App.hpp:1161
void _process_extras()
Throw an error if anything is left over and should not be.
Definition App_inl.hpp:1394
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:1065
Option * add_flag(std::string flag_name, T &flag_description)
Definition App.hpp:655
CLI11_NODISCARD bool get_ignore_case() const
Check the status of ignore_case.
Definition App.hpp:1109
App * parse_complete_callback(std::function< void()> pc_callback)
Definition App.hpp:364
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:924
CLI11_NODISCARD bool got_subcommand(std::string subcommand_name) const noexcept
Check with name instead of pointer to see if subcommand was selected.
Definition App.hpp:947
App * formatter_fn(std::function< std::string(const App *, std::string, AppFormatMode)> fmt)
Set the help formatter.
Definition App.hpp:505
CLI11_NODISCARD const std::vector< std::string > & get_aliases() const
Get the aliases of the current app.
Definition App.hpp:1219
void _parse_config(const std::vector< ConfigItem > &args)
Definition App_inl.hpp:1486
App * description(std::string app_description)
Set the description of the app.
Definition App.hpp:1067
CLI11_NODISCARD std::shared_ptr< ConfigBase > get_config_formatter_base() const
Access the config formatter as a configBase pointer.
Definition App.hpp:1054
std::string description_
Description of the current program/subcommand.
Definition App.hpp:112
App * excludes(App *app)
Sets excluded subcommands for the subcommand.
Definition App.hpp:962
App * allow_non_standard_option_names(bool allowed=true)
allow non standard option names
Definition App.hpp:407
CLI11_NODISCARD bool get_positionals_at_end() const
Check the status of the allow windows style options.
Definition App.hpp:1124
Option * get_version_ptr()
Get a pointer to the version option.
Definition App.hpp:1204
CLI11_NODISCARD std::size_t get_require_option_min() const
Get the required min option value.
Definition App.hpp:1149
std::size_t require_option_max_
Max number of options allowed. 0 is unlimited (not inheritable)
Definition App.hpp:287
CLI11_NODISCARD bool get_disabled() const
Get the status of disabled.
Definition App.hpp:1164
CLI11_NODISCARD bool get_allow_windows_style_options() const
Check the status of the allow windows style options.
Definition App.hpp:1121
std::vector< std::string > aliases_
Alias names for the subcommand.
Definition App.hpp:296
CLI11_NODISCARD bool parsed() const
Check to see if this subcommand was parsed, true only if received on command line.
Definition App.hpp:517
std::set< App * > exclude_subcommands_
this is a list of subcommands that are exclusionary to this one
Definition App.hpp:208
CLI11_NODISCARD bool get_disabled_by_default() const
Get the status of disabled by default.
Definition App.hpp:1176
Option * add_flag(std::string flag_name, std::vector< T > &flag_results, std::string flag_description="")
Vector version to capture multiple flags.
Definition App.hpp:681
CLI11_NODISCARD std::size_t count() const
Definition App.hpp:785
bool _parse_positional(std::vector< std::string > &args, bool haltOnSubcommand)
Definition App_inl.hpp:1705
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:1130
bool _parse_arg(std::vector< std::string > &args, detail::Classifier current_type, bool local_processing_only)
Definition App_inl.hpp:1884
bool silent_
Definition App.hpp:269
CLI11_NODISCARD const App * get_parent() const
Get the parent of this subcommand (or nullptr if main app) (const version)
Definition App.hpp:1213
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
App * final_callback(std::function< void()> app_callback)
Definition App.hpp:357
std::string group_
The group membership INHERITABLE.
Definition App.hpp:293
App * alias(std::string app_name)
Set an alias for the app.
Definition App_inl.hpp:102
bool pre_parse_called_
Flag indicating that the pre_parse_callback has been triggered.
Definition App.hpp:134
void _process_callbacks()
Process callbacks. Runs on all subcommands.
Definition App_inl.hpp:1197
App * validate_positionals(bool validate=true)
Set the subcommand to validate positional arguments before assigning.
Definition App.hpp:438
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:375
App * footer(std::function< std::string()> footer_function)
Set footer.
Definition App.hpp:1027
App * ignore_case(bool value=true)
Ignore case. Subcommands inherit value.
Definition App_inl.hpp:132
App * excludes(Option *opt)
Sets excluded options for the subcommand.
Definition App.hpp:953
CLI11_NODISCARD std::shared_ptr< Config > get_config_formatter() const
Access the config formatter.
Definition App.hpp:1051
bool remove_excludes(Option *opt)
Removes an option from the excludes list of this subcommand.
Definition App_inl.hpp:732
CLI11_NODISCARD std::vector< App * > get_subcommands() const
Definition App.hpp:930
bool got_subcommand(const App *subcom) const
Check to see if given subcommand was selected.
Definition App.hpp:941
CLI11_NODISCARD config_extras_mode get_allow_config_extras() const
Get the status of allow extras.
Definition App.hpp:1186
bool _parse_subcommand(std::vector< std::string > &args)
Definition App_inl.hpp:1844
App * positionals_at_end(bool value=true)
Specify that the positional arguments are only at the end of the sequence.
Definition App.hpp:484
bool fallthrough_
Definition App.hpp:237
std::set< Option * > need_options_
Definition App.hpp:220
CLI11_NODISCARD bool get_validate_optional_arguments() const
Get the status of validating optional vector arguments.
Definition App.hpp:1183
CLI11_NODISCARD bool get_silent() const
Get the status of silence.
Definition App.hpp:1167
std::vector< const Option * > get_options(const std::function< bool(const Option *)> filter={}) const
Get the list of options (user facing function, so returns raw pointers), has optional filter function...
Definition App_inl.hpp:802
std::set< App * > need_subcommands_
Definition App.hpp:216
App * validate_optional_arguments(bool validate=true)
Set the subcommand to validate optional vector arguments before assigning.
Definition App.hpp:444
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:160
App * formatter(std::shared_ptr< FormatterBase > fmt)
Set the help formatter.
Definition App.hpp:499
std::vector< Option * > parse_order_
This is a list of pointers to options with the original parse order.
Definition App.hpp:202
Option * add_option(std::string option_name, T &option_description)
Add option with description but with no variable assignment or callback.
Definition App.hpp:621
App * prefix_command(bool is_prefix=true)
Definition App.hpp:468
CLI11_NODISCARD const std::vector< Option * > & parse_order() const
This gets a vector of pointers with the original parse order.
Definition App.hpp:1237
void _parse(std::vector< std::string > &args)
Internal parse function.
Definition App_inl.hpp:1431
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:1493
startup_mode default_startup
Definition App.hpp:256
App * allow_config_extras(config_extras_mode mode)
ignore extras in config files
Definition App.hpp:461
Option * add_flag(std::string flag_name, T &flag_result, std::string flag_description="")
Definition App.hpp:665
bool allow_extras_
If true, allow extra arguments (ie, don't throw an error). INHERITABLE.
Definition App.hpp:115
CLI11_NODISCARD std::string get_description() const
Get the app or subcommand description.
Definition App.hpp:1064
App * require_option(std::size_t min, std::size_t max)
Definition App.hpp:849
CLI11_NODISCARD char ** ensure_utf8(char **argv)
Convert the contents of argv to UTF-8. Only does something on Windows, does nothing elsewhere.
Definition App_inl.hpp:63
CLI11_NODISCARD App * _find_subcommand(const std::string &subc_name, bool ignore_disabled, bool ignore_used) const noexcept
Definition App_inl.hpp:1826
CLI11_NODISCARD std::size_t get_require_subcommand_min() const
Get the required min subcommand value.
Definition App.hpp:1143
CLI11_NODISCARD const Option * get_config_ptr() const
Get a pointer to the config option. (const)
Definition App.hpp:1201
CLI11_NODISCARD const std::string & get_name() const
Get the name of the current app.
Definition App.hpp:1216
App * disabled(bool disable=true)
Disable the subcommand or option group.
Definition App.hpp:395
App * callback(std::function< void()> app_callback)
Definition App.hpp:346
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:267
App * require_subcommand(std::size_t min, std::size_t max)
Definition App.hpp:820
CLI11_NODISCARD const Option * get_option(std::string option_name) const
Get an option by name.
Definition App.hpp:1085
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:306
This converter works with INI/TOML files; to write INI files use ConfigINI.
Definition ConfigFwd.hpp:85
All errors derive from this one.
Definition Error.hpp:73
Definition FormatterFwd.hpp:147
Thrown when an option is set to conflicting values (non-vector and multi args, for example)
Definition Error.hpp:96
Extension of App to better manage groups of options.
Definition App.hpp:1374
App * add_subcommand(App *subcom)
Add an existing subcommand to be a member of an option_group.
Definition App.hpp:1404
Option * add_option(Option *opt)
Add an existing option to the Option_group.
Definition App.hpp:1388
void add_options(Option *opt, Args... args)
Add a bunch of options to the group.
Definition App.hpp:1398
void add_options(Option *opt)
Add an existing option to the Option_group.
Definition App.hpp:1396
Definition Option.hpp:194
Definition Option.hpp:231
Option * type_size(int option_type_size)
Set a custom option size.
Definition Option_inl.hpp:467
Option * expected(int value)
Set the number of expected arguments.
Definition Option_inl.hpp:36
Option * type_name(std::string typeval)
Set a custom option typestring.
Definition Option.hpp:728
CLI11_NODISCARD std::size_t count() const
Count the total number of times an option was passed.
Definition Option.hpp:361
Option * run_callback_for_default(bool value=true)
Definition Option.hpp:411
Option * multi_option_policy(MultiOptionPolicy value=MultiOptionPolicy::Throw)
Take the last argument if given multiple times (or another policy)
Definition Option_inl.hpp:220
Option * default_str(std::string val)
Set the default value string representation (does not change the contained value)
Definition Option.hpp:757
Option * force_callback(bool value=true)
Set the value of force_callback.
Definition Option.hpp:402
Thrown when counting a nonexistent option.
Definition Error.hpp:351
Holds values to load into Options.
Definition ConfigFwd.hpp:29
This class is simply to allow tests access to App's protected functions.
Definition App.hpp:1453
static auto parse_subcommand(App *app, Args &&...args) -> typename std::result_of< decltype(&App::_parse_subcommand)(App, Args...)>::type
Wrap _parse_subcommand, perfectly forward arguments and return.
Definition App.hpp:1475
static App * get_fallthrough_parent(App *app)
Wrap the fallthrough parent function to make sure that is working correctly.
Definition App.hpp:1481
static auto parse_arg(App *app, Args &&...args) -> typename std::result_of< decltype(&App::_parse_arg)(App, Args...)>::type
Wrap _parse_short, perfectly forward arguments and return.
Definition App.hpp:1468
This will only trigger for actual void type.
Definition TypeTools.hpp:504