CLI11  2.5.0
App.hpp
Go to the documentation of this file.
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 
36 namespace 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 
48 namespace detail {
50 struct AppFriend;
51 } // namespace detail
52 
53 namespace FailureMessage {
55 CLI11_INLINE std::string simple(const App *app, const Error &e);
56 
58 CLI11_INLINE std::string help(const App *app, const Error &e);
59 } // namespace FailureMessage
60 
62 
63 enum class config_extras_mode : char { error = 0, ignore, ignore_all, capture };
64 
65 class App;
66 
67 using App_p = std::shared_ptr<App>;
68 
69 namespace detail {
71 
72 template <typename T, enable_if_t<!std::is_integral<T>::value || (sizeof(T) <= 1U), detail::enabler> = detail::dummy>
74  return opt->always_capture_default();
75 }
76 
78 template <typename T, enable_if_t<std::is_integral<T>::value && (sizeof(T) > 1U), detail::enabler> = detail::dummy>
81 }
82 
83 } // namespace detail
84 
85 class Option_group;
87 
90 class App {
91  friend Option;
92  friend detail::AppFriend;
93 
94  protected:
95  // This library follows the Google style guide for member names ending in underscores
96 
99 
101  std::string name_{};
102 
104  std::string description_{};
105 
107  bool allow_extras_{false};
108 
112 
114  bool prefix_command_{false};
115 
117  bool has_automatic_name_{false};
118 
120  bool required_{false};
121 
123  bool disabled_{false};
124 
126  bool pre_parse_called_{false};
127 
130  bool immediate_callback_{false};
131 
133  std::function<void(std::size_t)> pre_parse_callback_{};
134 
136  std::function<void()> parse_complete_callback_{};
137 
139  std::function<void()> final_callback_{};
140 
144 
147 
149  std::vector<Option_p> options_{};
150 
154 
156  std::string usage_{};
157 
159  std::function<std::string()> usage_callback_{};
160 
162  std::string footer_{};
163 
165  std::function<std::string()> footer_callback_{};
166 
168  Option *help_ptr_{nullptr};
169 
172 
174  Option *version_ptr_{nullptr};
175 
177  std::shared_ptr<FormatterBase> formatter_{new Formatter()};
178 
180  std::function<std::string(const App *, const Error &e)> failure_message_{FailureMessage::simple};
181 
185 
186  using missing_t = std::vector<std::pair<detail::Classifier, std::string>>;
187 
192 
194  std::vector<Option *> parse_order_{};
195 
197  std::vector<App *> parsed_subcommands_{};
198 
200  std::set<App *> exclude_subcommands_{};
201 
204  std::set<Option *> exclude_options_{};
205 
208  std::set<App *> need_subcommands_{};
209 
212  std::set<Option *> need_options_{};
213 
217 
219  std::vector<App_p> subcommands_{};
220 
222  bool ignore_case_{false};
223 
225  bool ignore_underscore_{false};
226 
229  bool fallthrough_{false};
230 
233 
236 #ifdef _WIN32
237  true
238 #else
239  false
240 #endif
241  };
243  bool positionals_at_end_{false};
244 
245  enum class startup_mode : char { stable, enabled, disabled };
249 
251  bool configurable_{false};
252 
255 
258 
261  bool silent_{false};
262 
265 
267  std::uint32_t parsed_{0U};
268 
270  std::size_t require_subcommand_min_{0};
271 
273  std::size_t require_subcommand_max_{0};
274 
276  std::size_t require_option_min_{0};
277 
279  std::size_t require_option_max_{0};
280 
282  App *parent_{nullptr};
283 
285  std::string group_{"SUBCOMMANDS"};
286 
288  std::vector<std::string> aliases_{};
289 
293 
295  Option *config_ptr_{nullptr};
296 
298  std::shared_ptr<Config> config_formatter_{new ConfigTOML()};
299 
301 
302 #ifdef _WIN32
303  std::vector<std::string> normalized_argv_{};
305 
307  std::vector<char *> normalized_argv_view_{};
308 #endif
309 
311  App(std::string app_description, std::string app_name, App *parent);
312 
313  public:
316 
318  explicit App(std::string app_description = "", std::string app_name = "")
319  : App(app_description, app_name, nullptr) {
320  set_help_flag("-h,--help", "Print this help message and exit");
321  }
322 
323  App(const App &) = delete;
324  App &operator=(const App &) = delete;
325 
327  virtual ~App() = default;
328 
330  CLI11_NODISCARD char **ensure_utf8(char **argv);
331 
338  App *callback(std::function<void()> app_callback) {
339  if(immediate_callback_) {
340  parse_complete_callback_ = std::move(app_callback);
341  } else {
342  final_callback_ = std::move(app_callback);
343  }
344  return this;
345  }
346 
349  App *final_callback(std::function<void()> app_callback) {
350  final_callback_ = std::move(app_callback);
351  return this;
352  }
353 
356  App *parse_complete_callback(std::function<void()> pc_callback) {
357  parse_complete_callback_ = std::move(pc_callback);
358  return this;
359  }
360 
363  App *preparse_callback(std::function<void(std::size_t)> pp_callback) {
364  pre_parse_callback_ = std::move(pp_callback);
365  return this;
366  }
367 
369  App *name(std::string app_name = "");
370 
372  App *alias(std::string app_name);
373 
375  App *allow_extras(bool allow = true) {
376  allow_extras_ = allow;
377  return this;
378  }
379 
381  App *required(bool require = true) {
382  required_ = require;
383  return this;
384  }
385 
387  App *disabled(bool disable = true) {
388  disabled_ = disable;
389  return this;
390  }
391 
393  App *silent(bool silence = true) {
394  silent_ = silence;
395  return this;
396  }
397 
399  App *allow_non_standard_option_names(bool allowed = true) {
400  allow_non_standard_options_ = allowed;
401  return this;
402  }
403 
405  App *disabled_by_default(bool disable = true) {
406  if(disable) {
408  } else {
410  }
411  return this;
412  }
413 
416  App *enabled_by_default(bool enable = true) {
417  if(enable) {
419  } else {
422  }
423  return this;
424  }
425 
427  App *immediate_callback(bool immediate = true);
428 
430  App *validate_positionals(bool validate = true) {
431  validate_positionals_ = validate;
432  return this;
433  }
434 
436  App *validate_optional_arguments(bool validate = true) {
437  validate_optional_arguments_ = validate;
438  return this;
439  }
440 
442  App *allow_config_extras(bool allow = true) {
443  if(allow) {
445  allow_extras_ = true;
446  } else {
448  }
449  return this;
450  }
451 
454  allow_config_extras_ = mode;
455  return this;
456  }
457 
460  App *prefix_command(bool is_prefix = true) {
461  prefix_command_ = is_prefix;
462  return this;
463  }
464 
466  App *ignore_case(bool value = true);
467 
470  App *allow_windows_style_options(bool value = true) {
472  return this;
473  }
474 
476  App *positionals_at_end(bool value = true) {
477  positionals_at_end_ = value;
478  return this;
479  }
480 
482  App *configurable(bool value = true) {
483  configurable_ = value;
484  return this;
485  }
486 
488  App *ignore_underscore(bool value = true);
489 
491  App *formatter(std::shared_ptr<FormatterBase> fmt) {
492  formatter_ = fmt;
493  return this;
494  }
495 
497  App *formatter_fn(std::function<std::string(const App *, std::string, AppFormatMode)> fmt) {
498  formatter_ = std::make_shared<FormatterLambda>(fmt);
499  return this;
500  }
501 
503  App *config_formatter(std::shared_ptr<Config> fmt) {
504  config_formatter_ = fmt;
505  return this;
506  }
507 
509  CLI11_NODISCARD bool parsed() const { return parsed_ > 0; }
510 
513 
517 
532  Option *add_option(std::string option_name,
533  callback_t option_callback,
534  std::string option_description = "",
535  bool defaulted = false,
536  std::function<std::string()> func = {});
537 
539  template <typename AssignTo,
540  typename ConvertTo = AssignTo,
541  enable_if_t<!std::is_const<ConvertTo>::value, detail::enabler> = detail::dummy>
542  Option *add_option(std::string option_name,
543  AssignTo &variable,
544  std::string option_description = "") {
545 
546  auto fun = [&variable](const CLI::results_t &res) { // comment for spacing
547  return detail::lexical_conversion<AssignTo, ConvertTo>(res, variable);
548  };
549 
550  Option *opt = add_option(option_name, fun, option_description, false, [&variable]() {
551  return CLI::detail::checked_to_string<AssignTo, ConvertTo>(variable);
552  });
553  opt->type_name(detail::type_name<ConvertTo>());
554  // these must be actual lvalues since (std::max) sometimes is defined in terms of references and references
555  // to structs used in the evaluation can be temporary so that would cause issues.
558  opt->type_size(detail::type_count_min<ConvertTo>::value, (std::max)(Tcount, XCcount));
559  opt->expected(detail::expected_count<ConvertTo>::value);
561  return opt;
562  }
563 
565  template <typename AssignTo, enable_if_t<!std::is_const<AssignTo>::value, detail::enabler> = detail::dummy>
566  Option *add_option_no_stream(std::string option_name,
567  AssignTo &variable,
568  std::string option_description = "") {
569 
570  auto fun = [&variable](const CLI::results_t &res) { // comment for spacing
571  return detail::lexical_conversion<AssignTo, AssignTo>(res, variable);
572  };
573 
574  Option *opt = add_option(option_name, fun, option_description, false, []() { return std::string{}; });
575  opt->type_name(detail::type_name<AssignTo>());
576  opt->type_size(detail::type_count_min<AssignTo>::value, detail::type_count<AssignTo>::value);
577  opt->expected(detail::expected_count<AssignTo>::value);
579  return opt;
580  }
581 
583  template <typename ArgType>
584  Option *add_option_function(std::string option_name,
585  const std::function<void(const ArgType &)> &func,
586  std::string option_description = "") {
587 
588  auto fun = [func](const CLI::results_t &res) {
589  ArgType variable;
590  bool result = detail::lexical_conversion<ArgType, ArgType>(res, variable);
591  if(result) {
592  func(variable);
593  }
594  return result;
595  };
596 
597  Option *opt = add_option(option_name, std::move(fun), option_description, false);
598  opt->type_name(detail::type_name<ArgType>());
599  opt->type_size(detail::type_count_min<ArgType>::value, detail::type_count<ArgType>::value);
600  opt->expected(detail::expected_count<ArgType>::value);
601  return opt;
602  }
603 
605  Option *add_option(std::string option_name) {
606  return add_option(option_name, CLI::callback_t{}, std::string{}, false);
607  }
608 
610  template <typename T,
611  enable_if_t<std::is_const<T>::value && std::is_constructible<std::string, T>::value, detail::enabler> =
613  Option *add_option(std::string option_name, T &option_description) {
614  return add_option(option_name, CLI::callback_t(), option_description, false);
615  }
616 
618  Option *set_help_flag(std::string flag_name = "", const std::string &help_description = "");
619 
621  Option *set_help_all_flag(std::string help_name = "", const std::string &help_description = "");
622 
624  Option *set_version_flag(std::string flag_name = "",
625  const std::string &versionString = "",
626  const std::string &version_help = "Display program version information and exit");
627 
629  Option *set_version_flag(std::string flag_name,
630  std::function<std::string()> vfunc,
631  const std::string &version_help = "Display program version information and exit");
632 
633  private:
635  Option *_add_flag_internal(std::string flag_name, CLI::callback_t fun, std::string flag_description);
636 
637  public:
639  Option *add_flag(std::string flag_name) { return _add_flag_internal(flag_name, CLI::callback_t(), std::string{}); }
640 
644  template <typename T,
645  enable_if_t<std::is_const<T>::value && std::is_constructible<std::string, T>::value, detail::enabler> =
647  Option *add_flag(std::string flag_name, T &flag_description) {
648  return _add_flag_internal(flag_name, CLI::callback_t(), flag_description);
649  }
650 
653  template <typename T,
654  enable_if_t<!detail::is_mutable_container<T>::value && !std::is_const<T>::value &&
655  !std::is_constructible<std::function<void(int)>, T>::value,
656  detail::enabler> = detail::dummy>
657  Option *add_flag(std::string flag_name,
658  T &flag_result,
659  std::string flag_description = "") {
660 
661  CLI::callback_t fun = [&flag_result](const CLI::results_t &res) {
663  return lexical_cast(res[0], flag_result);
664  };
665  auto *opt = _add_flag_internal(flag_name, std::move(fun), std::move(flag_description));
666  return detail::default_flag_modifiers<T>(opt);
667  }
668 
670  template <typename T,
673  Option *add_flag(std::string flag_name,
674  std::vector<T> &flag_results,
675  std::string flag_description = "") {
676  CLI::callback_t fun = [&flag_results](const CLI::results_t &res) {
677  bool retval = true;
678  for(const auto &elem : res) {
680  flag_results.emplace_back();
681  retval &= lexical_cast(elem, flag_results.back());
682  }
683  return retval;
684  };
685  return _add_flag_internal(flag_name, std::move(fun), std::move(flag_description))
688  }
689 
691  Option *add_flag_callback(std::string flag_name,
692  std::function<void(void)> function,
693  std::string flag_description = "");
694 
696  Option *add_flag_function(std::string flag_name,
697  std::function<void(std::int64_t)> function,
698  std::string flag_description = "");
699 
700 #ifdef CLI11_CPP14
701  Option *add_flag(std::string flag_name,
703  std::function<void(std::int64_t)> function,
704  std::string flag_description = "") {
705  return add_flag_function(std::move(flag_name), std::move(function), std::move(flag_description));
706  }
707 #endif
708 
710  Option *set_config(std::string option_name = "",
711  std::string default_filename = "",
712  const std::string &help_message = "Read an ini file",
713  bool config_required = false);
714 
716  bool remove_option(Option *opt);
717 
719  template <typename T = Option_group>
720  T *add_option_group(std::string group_name, std::string group_description = "") {
721  if(!detail::valid_alias_name_string(group_name)) {
722  throw IncorrectConstruction("option group names may not contain newlines or null characters");
723  }
724  auto option_group = std::make_shared<T>(std::move(group_description), group_name, this);
725  auto *ptr = option_group.get();
726  // move to App_p for overload resolution on older gcc versions
727  App_p app_ptr = std::dynamic_pointer_cast<App>(option_group);
728  add_subcommand(std::move(app_ptr));
729  return ptr;
730  }
731 
735 
737  App *add_subcommand(std::string subcommand_name = "", std::string subcommand_description = "");
738 
740  App *add_subcommand(CLI::App_p subcom);
741 
743  bool remove_subcommand(App *subcom);
744 
747  App *get_subcommand(const App *subcom) const;
748 
750  CLI11_NODISCARD App *get_subcommand(std::string subcom) const;
751 
754  CLI11_NODISCARD App *get_subcommand_no_throw(std::string subcom) const noexcept;
755 
757  CLI11_NODISCARD App *get_subcommand(int index = 0) const;
758 
760  CLI::App_p get_subcommand_ptr(App *subcom) const;
761 
763  CLI11_NODISCARD CLI::App_p get_subcommand_ptr(std::string subcom) const;
764 
766  CLI11_NODISCARD CLI::App_p get_subcommand_ptr(int index = 0) const;
767 
769  CLI11_NODISCARD App *get_option_group(std::string group_name) const;
770 
774  CLI11_NODISCARD std::size_t count() const { return parsed_; }
775 
778  CLI11_NODISCARD std::size_t count_all() const;
779 
781  App *group(std::string group_name) {
782  group_ = group_name;
783  return this;
784  }
785 
790  return this;
791  }
792 
796  App *require_subcommand(int value) {
797  if(value < 0) {
799  require_subcommand_max_ = static_cast<std::size_t>(-value);
800  } else {
801  require_subcommand_min_ = static_cast<std::size_t>(value);
802  require_subcommand_max_ = static_cast<std::size_t>(value);
803  }
804  return this;
805  }
806 
809  App *require_subcommand(std::size_t min, std::size_t max) {
812  return this;
813  }
814 
819  return this;
820  }
821 
825  App *require_option(int value) {
826  if(value < 0) {
828  require_option_max_ = static_cast<std::size_t>(-value);
829  } else {
830  require_option_min_ = static_cast<std::size_t>(value);
831  require_option_max_ = static_cast<std::size_t>(value);
832  }
833  return this;
834  }
835 
838  App *require_option(std::size_t min, std::size_t max) {
839  require_option_min_ = min;
840  require_option_max_ = max;
841  return this;
842  }
843 
846  App *fallthrough(bool value = true) {
847  fallthrough_ = value;
848  return this;
849  }
850 
852  App *subcommand_fallthrough(bool value = true) {
853  subcommand_fallthrough_ = value;
854  return this;
855  }
856 
859  explicit operator bool() const { return parsed_ > 0; }
860 
864 
868  virtual void pre_callback() {}
869 
873  //
875  void clear();
876 
879  void parse(int argc, const char *const *argv);
880  void parse(int argc, const wchar_t *const *argv);
881 
882  private:
883  template <class CharT> void parse_char_t(int argc, const CharT *const *argv);
884 
885  public:
890  void parse(std::string commandline, bool program_name_included = false);
891  void parse(std::wstring commandline, bool program_name_included = false);
892 
895  void parse(std::vector<std::string> &args);
896 
898  void parse(std::vector<std::string> &&args);
899 
900  void parse_from_stream(std::istream &input);
901 
903  void failure_message(std::function<std::string(const App *, const Error &e)> function) {
904  failure_message_ = function;
905  }
906 
908  int exit(const Error &e, std::ostream &out = std::cout, std::ostream &err = std::cerr) const;
909 
913 
915  CLI11_NODISCARD std::size_t count(std::string option_name) const { return get_option(option_name)->count(); }
916 
919  CLI11_NODISCARD std::vector<App *> get_subcommands() const { return parsed_subcommands_; }
920 
923  std::vector<const App *> get_subcommands(const std::function<bool(const App *)> &filter) const;
924 
927  std::vector<App *> get_subcommands(const std::function<bool(App *)> &filter);
928 
930  bool got_subcommand(const App *subcom) const {
931  // get subcom needed to verify that this was a real subcommand
932  return get_subcommand(subcom)->parsed_ > 0;
933  }
934 
936  CLI11_NODISCARD bool got_subcommand(std::string subcommand_name) const noexcept {
937  App *sub = get_subcommand_no_throw(subcommand_name);
938  return (sub != nullptr) ? (sub->parsed_ > 0) : false;
939  }
940 
942  App *excludes(Option *opt) {
943  if(opt == nullptr) {
944  throw OptionNotFound("nullptr passed");
945  }
946  exclude_options_.insert(opt);
947  return this;
948  }
949 
951  App *excludes(App *app) {
952  if(app == nullptr) {
953  throw OptionNotFound("nullptr passed");
954  }
955  if(app == this) {
956  throw OptionNotFound("cannot self reference in needs");
957  }
958  auto res = exclude_subcommands_.insert(app);
959  // subcommand exclusion should be symmetric
960  if(res.second) {
961  app->exclude_subcommands_.insert(this);
962  }
963  return this;
964  }
965 
966  App *needs(Option *opt) {
967  if(opt == nullptr) {
968  throw OptionNotFound("nullptr passed");
969  }
970  need_options_.insert(opt);
971  return this;
972  }
973 
974  App *needs(App *app) {
975  if(app == nullptr) {
976  throw OptionNotFound("nullptr passed");
977  }
978  if(app == this) {
979  throw OptionNotFound("cannot self reference in needs");
980  }
981  need_subcommands_.insert(app);
982  return this;
983  }
984 
986  bool remove_excludes(Option *opt);
987 
989  bool remove_excludes(App *app);
990 
992  bool remove_needs(Option *opt);
993 
995  bool remove_needs(App *app);
999 
1001  App *usage(std::string usage_string) {
1002  usage_ = std::move(usage_string);
1003  return this;
1004  }
1006  App *usage(std::function<std::string()> usage_function) {
1007  usage_callback_ = std::move(usage_function);
1008  return this;
1009  }
1011  App *footer(std::string footer_string) {
1012  footer_ = std::move(footer_string);
1013  return this;
1014  }
1016  App *footer(std::function<std::string()> footer_function) {
1017  footer_callback_ = std::move(footer_function);
1018  return this;
1019  }
1022  CLI11_NODISCARD std::string config_to_str(bool default_also = false, bool write_description = false) const {
1023  return config_formatter_->to_config(this, default_also, write_description, "");
1024  }
1025 
1028  CLI11_NODISCARD std::string help(std::string prev = "", AppFormatMode mode = AppFormatMode::Normal) const;
1029 
1031  CLI11_NODISCARD std::string version() const;
1035 
1037  CLI11_NODISCARD std::shared_ptr<FormatterBase> get_formatter() const { return formatter_; }
1038 
1040  CLI11_NODISCARD std::shared_ptr<Config> get_config_formatter() const { return config_formatter_; }
1041 
1043  CLI11_NODISCARD std::shared_ptr<ConfigBase> get_config_formatter_base() const {
1044  // This is safer as a dynamic_cast if we have RTTI, as Config -> ConfigBase
1045 #if CLI11_USE_STATIC_RTTI == 0
1046  return std::dynamic_pointer_cast<ConfigBase>(config_formatter_);
1047 #else
1048  return std::static_pointer_cast<ConfigBase>(config_formatter_);
1049 #endif
1050  }
1051 
1053  CLI11_NODISCARD std::string get_description() const { return description_; }
1054 
1056  App *description(std::string app_description) {
1057  description_ = std::move(app_description);
1058  return this;
1059  }
1060 
1062  std::vector<const Option *> get_options(const std::function<bool(const Option *)> filter = {}) const;
1063 
1065  std::vector<Option *> get_options(const std::function<bool(Option *)> filter = {});
1066 
1068  CLI11_NODISCARD Option *get_option_no_throw(std::string option_name) noexcept;
1069 
1071  CLI11_NODISCARD const Option *get_option_no_throw(std::string option_name) const noexcept;
1072 
1074  CLI11_NODISCARD const Option *get_option(std::string option_name) const {
1075  const auto *opt = get_option_no_throw(option_name);
1076  if(opt == nullptr) {
1077  throw OptionNotFound(option_name);
1078  }
1079  return opt;
1080  }
1081 
1083  Option *get_option(std::string option_name) {
1084  auto *opt = get_option_no_throw(option_name);
1085  if(opt == nullptr) {
1086  throw OptionNotFound(option_name);
1087  }
1088  return opt;
1089  }
1090 
1092  const Option *operator[](const std::string &option_name) const { return get_option(option_name); }
1093 
1095  const Option *operator[](const char *option_name) const { return get_option(option_name); }
1096 
1099 
1102 
1105 
1108 
1111 
1114 
1117 
1119  CLI11_NODISCARD const std::string &get_group() const { return group_; }
1120 
1122  CLI11_NODISCARD std::string get_usage() const {
1123  return (usage_callback_) ? usage_callback_() + '\n' + usage_ : usage_;
1124  }
1125 
1127  CLI11_NODISCARD std::string get_footer() const {
1128  return (footer_callback_) ? footer_callback_() + '\n' + footer_ : footer_;
1129  }
1130 
1133 
1136 
1139 
1142 
1145 
1148 
1150  CLI11_NODISCARD bool get_required() const { return required_; }
1151 
1153  CLI11_NODISCARD bool get_disabled() const { return disabled_; }
1154 
1156  CLI11_NODISCARD bool get_silent() const { return silent_; }
1157 
1160 
1163 
1166 
1173 
1176 
1179 
1181  CLI11_NODISCARD const Option *get_help_ptr() const { return help_ptr_; }
1182 
1185 
1188 
1191 
1194 
1197 
1199  App *get_parent() { return parent_; }
1200 
1202  CLI11_NODISCARD const App *get_parent() const { return parent_; }
1203 
1205  CLI11_NODISCARD const std::string &get_name() const { return name_; }
1206 
1208  CLI11_NODISCARD const std::vector<std::string> &get_aliases() const { return aliases_; }
1209 
1212  aliases_.clear();
1213  return this;
1214  }
1215 
1217  CLI11_NODISCARD std::string get_display_name(bool with_aliases = false) const;
1218 
1220  CLI11_NODISCARD bool check_name(std::string name_to_check) const;
1221 
1223  CLI11_NODISCARD std::vector<std::string> get_groups() const;
1224 
1226  CLI11_NODISCARD const std::vector<Option *> &parse_order() const { return parse_order_; }
1227 
1229  CLI11_NODISCARD std::vector<std::string> remaining(bool recurse = false) const;
1230 
1232  CLI11_NODISCARD std::vector<std::string> remaining_for_passthrough(bool recurse = false) const;
1233 
1235  CLI11_NODISCARD std::size_t remaining_size(bool recurse = false) const;
1236 
1238 
1239  protected:
1244  void _validate() const;
1245 
1249  void _configure();
1250 
1252  void run_callback(bool final_mode = false, bool suppress_final_callback = false);
1253 
1255  CLI11_NODISCARD bool _valid_subcommand(const std::string &current, bool ignore_used = true) const;
1256 
1258  CLI11_NODISCARD detail::Classifier _recognize(const std::string &current,
1259  bool ignore_used_subcommands = true) const;
1260 
1261  // The parse function is now broken into several parts, and part of process
1262 
1264  void _process_config_file();
1265 
1267  bool _process_config_file(const std::string &config_file, bool throw_error);
1268 
1270  void _process_env();
1271 
1273  void _process_callbacks();
1274 
1278  void _process_help_flags(bool trigger_help = false, bool trigger_all_help = false) const;
1279 
1281  void _process_requirements();
1282 
1284  void _process();
1285 
1287  void _process_extras();
1288 
1291  void _process_extras(std::vector<std::string> &args);
1292 
1294  void increment_parsed();
1295 
1297  void _parse(std::vector<std::string> &args);
1298 
1300  void _parse(std::vector<std::string> &&args);
1301 
1303  void _parse_stream(std::istream &input);
1304 
1309  void _parse_config(const std::vector<ConfigItem> &args);
1310 
1312  bool _parse_single_config(const ConfigItem &item, std::size_t level = 0);
1313 
1316  bool _parse_single(std::vector<std::string> &args, bool &positional_only);
1317 
1319  CLI11_NODISCARD std::size_t _count_remaining_positionals(bool required_only = false) const;
1320 
1323 
1327  bool _parse_positional(std::vector<std::string> &args, bool haltOnSubcommand);
1328 
1332  _find_subcommand(const std::string &subc_name, bool ignore_disabled, bool ignore_used) const noexcept;
1333 
1338  bool _parse_subcommand(std::vector<std::string> &args);
1339 
1343  bool _parse_arg(std::vector<std::string> &args, detail::Classifier current_type, bool local_processing_only);
1344 
1346  void _trigger_pre_parse(std::size_t remaining_args);
1347 
1350 
1352  CLI11_NODISCARD const std::string &_compare_subcommand_names(const App &subcom, const App &base) const;
1353 
1355  void _move_to_missing(detail::Classifier val_type, const std::string &val);
1356 
1357  public:
1359  void _move_option(Option *opt, App *app);
1360 }; // namespace CLI
1361 
1363 class Option_group : public App {
1364  public:
1365  Option_group(std::string group_description, std::string group_name, App *parent)
1366  : App(std::move(group_description), "", parent) {
1367  group(group_name);
1368  // option groups should have automatic fallthrough
1369  if(group_name.empty() || group_name.front() == '+') {
1370  // help will not be used by default in these contexts
1371  set_help_flag("");
1372  set_help_all_flag("");
1373  }
1374  }
1375  using App::add_option;
1378  if(get_parent() == nullptr) {
1379  throw OptionNotFound("Unable to locate the specified option");
1380  }
1381  get_parent()->_move_option(opt, this);
1382  return opt;
1383  }
1385  void add_options(Option *opt) { add_option(opt); }
1387  template <typename... Args> void add_options(Option *opt, Args... args) {
1388  add_option(opt);
1389  add_options(args...);
1390  }
1391  using App::add_subcommand;
1393  App *add_subcommand(App *subcom) {
1394  App_p subc = subcom->get_parent()->get_subcommand_ptr(subcom);
1395  subc->get_parent()->remove_subcommand(subcom);
1396  add_subcommand(std::move(subc));
1397  return subcom;
1398  }
1399 };
1400 
1402 CLI11_INLINE void TriggerOn(App *trigger_app, App *app_to_enable);
1403 
1405 CLI11_INLINE void TriggerOn(App *trigger_app, std::vector<App *> apps_to_enable);
1406 
1408 CLI11_INLINE void TriggerOff(App *trigger_app, App *app_to_enable);
1409 
1411 CLI11_INLINE void TriggerOff(App *trigger_app, std::vector<App *> apps_to_enable);
1412 
1414 CLI11_INLINE void deprecate_option(Option *opt, const std::string &replacement = "");
1415 
1417 inline void deprecate_option(App *app, const std::string &option_name, const std::string &replacement = "") {
1418  auto *opt = app->get_option(option_name);
1419  deprecate_option(opt, replacement);
1420 }
1421 
1423 inline void deprecate_option(App &app, const std::string &option_name, const std::string &replacement = "") {
1424  auto *opt = app.get_option(option_name);
1425  deprecate_option(opt, replacement);
1426 }
1427 
1429 CLI11_INLINE void retire_option(App *app, Option *opt);
1430 
1432 CLI11_INLINE void retire_option(App &app, Option *opt);
1433 
1435 CLI11_INLINE void retire_option(App *app, const std::string &option_name);
1436 
1438 CLI11_INLINE void retire_option(App &app, const std::string &option_name);
1439 
1440 namespace detail {
1442 struct AppFriend {
1443 #ifdef CLI11_CPP14
1444 
1446  template <typename... Args> static decltype(auto) parse_arg(App *app, Args &&...args) {
1447  return app->_parse_arg(std::forward<Args>(args)...);
1448  }
1449 
1451  template <typename... Args> static decltype(auto) parse_subcommand(App *app, Args &&...args) {
1452  return app->_parse_subcommand(std::forward<Args>(args)...);
1453  }
1454 #else
1455  template <typename... Args>
1457  static auto parse_arg(App *app, Args &&...args) ->
1458  typename std::result_of<decltype (&App::_parse_arg)(App, Args...)>::type {
1459  return app->_parse_arg(std::forward<Args>(args)...);
1460  }
1461 
1463  template <typename... Args>
1464  static auto parse_subcommand(App *app, Args &&...args) ->
1465  typename std::result_of<decltype (&App::_parse_subcommand)(App, Args...)>::type {
1466  return app->_parse_subcommand(std::forward<Args>(args)...);
1467  }
1468 #endif
1469  static App *get_fallthrough_parent(App *app) { return app->_get_fallthrough_parent(); }
1471 };
1472 } // namespace detail
1473 
1474 // [CLI11:app_hpp:end]
1475 } // namespace CLI
1476 
1477 #ifndef CLI11_COMPILE
1478 #include "impl/App_inl.hpp" // IWYU pragma: export
1479 #endif
CLI11_NODISCARD const Option * get_version_ptr() const
Get a pointer to the version option. (const)
Definition: App.hpp:1196
App * clear_aliases()
clear all the aliases of the current App
Definition: App.hpp:1211
CLI11_NODISCARD const Option * get_config_ptr() const
Get a pointer to the config option. (const)
Definition: App.hpp:1190
void _move_option(Option *opt, App *app)
function that could be used by subclasses of App to shift options around into subcommands ...
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:903
CLI11_NODISCARD std::size_t count(std::string option_name) const
Counts the number of times the given option was passed.
Definition: App.hpp:915
CLI11_NODISCARD std::string get_usage() const
Generate and return the usage.
Definition: App.hpp:1122
void run_callback(bool final_mode=false, bool suppress_final_callback=false)
Internal function to run (App) callback, bottom up.
This class is simply to allow tests access to App's protected functions.
Definition: App.hpp:1442
CLI11_NODISCARD std::size_t count() const
Count the total number of times an option was passed.
Definition: Option.hpp:361
CLI11_NODISCARD std::size_t count() const
Definition: App.hpp:774
std::size_t require_subcommand_min_
Minimum required subcommands (not inheritable!)
Definition: App.hpp:270
bool disabled_
If set to true the subcommand is disabled and cannot be used, ignored for main app.
Definition: App.hpp:123
CLI11_INLINE std::string help(const App *app, const Error &e)
Printout the full help string on error (if this fn is set, the old default for CLI11) ...
void _validate() const
CLI11_NODISCARD const App * get_parent() const
Get the parent of this subcommand (or nullptr if main app) (const version)
Definition: App.hpp:1202
bool _parse_subcommand(std::vector< std::string > &args)
App * config_formatter(std::shared_ptr< Config > fmt)
Set the config formatter.
Definition: App.hpp:503
CLI11_NODISCARD const std::vector< std::string > & get_aliases() const
Get the aliases of the current app.
Definition: App.hpp:1208
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:117
CLI11_NODISCARD bool get_required() const
Get the status of required.
Definition: App.hpp:1150
config_extras_mode
enumeration of modes of how to deal with extras in config files
Definition: App.hpp:63
void _process_help_flags(bool trigger_help=false, bool trigger_all_help=false) const
App * needs(App *app)
Definition: App.hpp:974
App * require_option()
The argumentless form of require option requires 1 or more options be used.
Definition: App.hpp:816
App * require_option(std::size_t min, std::size_t max)
Definition: App.hpp:838
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...
startup_mode default_startup
Definition: App.hpp:248
Definition: App.hpp:36
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.
void clear()
Reset the parsed data.
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.
Option * add_option(std::string option_name, T &option_description)
Add option with description but with no variable assignment or callback.
Definition: App.hpp:613
Classifier
Definition: App.hpp:49
std::vector< std::string > aliases_
Alias names for the subcommand.
Definition: App.hpp:288
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...
CLI11_NODISCARD char ** ensure_utf8(char **argv)
Convert the contents of argv to UTF-8. Only does something on Windows, does nothing elsewhere...
App * parent_
A pointer to the parent if this is a subcommand.
Definition: App.hpp:282
App * silent(bool silence=true)
silence the subcommand from showing up in the processed list
Definition: App.hpp:393
bool remove_excludes(Option *opt)
Removes an option from the excludes list of this subcommand.
std::vector< App_p > subcommands_
Storage for subcommand list.
Definition: App.hpp:219
CLI11_NODISCARD std::shared_ptr< ConfigBase > get_config_formatter_base() const
Access the config formatter as a configBase pointer.
Definition: App.hpp:1043
std::string description_
Description of the current program/subcommand.
Definition: App.hpp:104
std::string footer_
Footer to put after all options in the help output INHERITABLE.
Definition: App.hpp:162
App * allow_non_standard_option_names(bool allowed=true)
allow non standard option names
Definition: App.hpp:399
App * allow_extras(bool allow=true)
Remove the error when extras are left over on the command line.
Definition: App.hpp:375
std::set< Option * > need_options_
Definition: App.hpp:212
Option * version_ptr_
A pointer to a version flag if there is one.
Definition: App.hpp:174
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:318
Option * get_config_ptr()
Get a pointer to the config option.
Definition: App.hpp:1187
std::vector< Option_p > options_
The list of options, stored locally.
Definition: App.hpp:149
CLI11_INLINE void TriggerOff(App *trigger_app, App *app_to_enable)
Helper function to disable one option group/subcommand when another is used.
CLI11_NODISCARD bool get_ignore_case() const
Check the status of ignore_case.
Definition: App.hpp:1098
enabler
Simple empty scoped class.
Definition: TypeTools.hpp:36
std::set< Option * > exclude_options_
Definition: App.hpp:204
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:566
Option * add_option(std::string option_name)
Add option with no description or variable assignment.
Definition: App.hpp:605
bool _parse_single_config(const ConfigItem &item, std::size_t level=0)
Fill in a single config option.
CLI11_NODISCARD std::string help(std::string prev="", AppFormatMode mode=AppFormatMode::Normal) const
CLI11_NODISCARD std::size_t count_all() const
CLI11_NODISCARD const std::vector< Option * > & parse_order() const
This gets a vector of pointers with the original parse order.
Definition: App.hpp:1226
CLI11_INLINE void deprecate_option(Option *opt, const std::string &replacement="")
Helper function to mark an option as deprecated.
App * preparse_callback(std::function< void(std::size_t)> pp_callback)
Definition: App.hpp:363
CLI11_NODISCARD App * get_subcommand_no_throw(std::string subcom) const noexcept
std::size_t require_option_min_
Minimum required options (not inheritable!)
Definition: App.hpp:276
void _trigger_pre_parse(std::size_t remaining_args)
Trigger the pre_parse callback if needed.
CLI11_NODISCARD const Option * get_help_ptr() const
Get a pointer to the help flag. (const)
Definition: App.hpp:1181
App * validate_optional_arguments(bool validate=true)
Set the subcommand to validate optional vector arguments before assigning.
Definition: App.hpp:436
bool remove_needs(Option *opt)
Removes an option from the needs list of this subcommand.
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: Option.hpp:231
CLI11_NODISCARD bool get_validate_positionals() const
Get the status of validating positionals.
Definition: App.hpp:1170
void _process_extras()
Throw an error if anything is left over and should not be.
std::vector< Option * > parse_order_
This is a list of pointers to options with the original parse order.
Definition: App.hpp:194
CLI11_NODISCARD config_extras_mode get_allow_config_extras() const
Get the status of allow extras.
Definition: App.hpp:1175
void _process_callbacks()
Process callbacks. Runs on all subcommands.
STL namespace.
App * ignore_case(bool value=true)
Ignore case. Subcommands inherit value.
bool _parse_positional(std::vector< std::string > &args, bool haltOnSubcommand)
void _move_to_missing(detail::Classifier val_type, const std::string &val)
Helper function to place extra values in the most appropriate position.
Extension of App to better manage groups of options.
Definition: App.hpp:1363
void _process_env()
Get envname options if not yet passed. Runs on all subcommands.
App * formatter(std::shared_ptr< FormatterBase > fmt)
Set the help formatter.
Definition: App.hpp:491
CLI11_NODISCARD Option * get_option_no_throw(std::string option_name) noexcept
Get an option by name (noexcept non-const version)
App(std::string app_description, std::string app_name, App *parent)
Special private constructor for subcommand.
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.
CLI11_NODISCARD bool get_disabled_by_default() const
Get the status of disabled by default.
Definition: App.hpp:1165
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.
bool _parse_single(std::vector< std::string > &args, bool &positional_only)
const Option * operator[](const std::string &option_name) const
Shortcut bracket operator for getting a pointer to an option.
Definition: App.hpp:1092
ConfigBase ConfigTOML
the default Config is the TOML file format
Definition: ConfigFwd.hpp:188
App * callback(std::function< void()> app_callback)
Definition: App.hpp:338
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:159
CLI11_NODISCARD std::vector< std::string > remaining(bool recurse=false) const
This returns the missing options from the current subcommand.
std::function< void()> parse_complete_callback_
This is a function that runs when parsing has finished.
Definition: App.hpp:136
CLI11_NODISCARD std::size_t get_require_subcommand_min() const
Get the required min subcommand value.
Definition: App.hpp:1132
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:720
bool lexical_cast(const std::string &input, T &output)
Integer conversion.
Definition: TypeTools.hpp:1112
constexpr enabler dummy
An instance to use in EnableIf.
Definition: TypeTools.hpp:39
Option * add_flag(std::string flag_name)
Add a flag with no description or variable assignment.
Definition: App.hpp:639
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:1457
bool remove_subcommand(App *subcom)
Removes a subcommand from the App. Takes a subcommand pointer. Returns true if found and removed...
CLI11_INLINE void TriggerOn(App *trigger_app, App *app_to_enable)
Helper function to enable one option group/subcommand when another is used.
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...
bool allow_non_standard_options_
indicator that the subcommand should allow non-standard option arguments, such as -single_dash_flag ...
Definition: App.hpp:264
App * get_parent()
Get the parent of this subcommand (or nullptr if main app)
Definition: App.hpp:1199
Option * help_ptr_
A pointer to the help flag if there is one INHERITABLE.
Definition: App.hpp:168
Option * add_flag(std::string flag_name, T &flag_description)
Definition: App.hpp:647
bool allow_extras_
If true, allow extra arguments (ie, don't throw an error). INHERITABLE.
Definition: App.hpp:107
Option * multi_option_policy(MultiOptionPolicy value=MultiOptionPolicy::Throw)
Take the last argument if given multiple times (or another policy)
Option * get_option(std::string option_name)
Get an option by name (non-const version)
Definition: App.hpp:1083
std::string group_
The group membership INHERITABLE.
Definition: App.hpp:285
CLI11_NODISCARD bool get_allow_windows_style_options() const
Check the status of the allow windows style options.
Definition: App.hpp:1110
const Option * operator[](const char *option_name) const
Shortcut bracket operator for getting a pointer to an option.
Definition: App.hpp:1095
bool pre_parse_called_
Flag indicating that the pre_parse_callback has been triggered.
Definition: App.hpp:126
App * enabled_by_default(bool enable=true)
Definition: App.hpp:416
App * disabled(bool disable=true)
Disable the subcommand or option group.
Definition: App.hpp:387
CLI11_NODISCARD bool get_enabled_by_default() const
Get the status of disabled by default.
Definition: App.hpp:1168
bool validate_positionals_
If set to true positional options are validated before assigning INHERITABLE.
Definition: App.hpp:254
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.
CLI11_INLINE std::string simple(const App *app, const Error &e)
Printout a clean, simple message on error (the default in CLI11 1.5+)
OptionDefaults * option_defaults()
Get the OptionDefault object, to set option defaults.
Definition: App.hpp:512
#define CLI11_INLINE
Definition: Macros.hpp:150
App * allow_config_extras(config_extras_mode mode)
ignore extras in config files
Definition: App.hpp:453
CLI11_NODISCARD bool get_allow_extras() const
Get the status of allow extras.
Definition: App.hpp:1147
Option * help_all_ptr_
A pointer to the help all flag if there is one INHERITABLE.
Definition: App.hpp:171
Option * get_version_ptr()
Get a pointer to the version option.
Definition: App.hpp:1193
App * get_subcommand(const App *subcom) const
CLI11_NODISCARD bool parsed() const
Check to see if this subcommand was parsed, true only if received on command line.
Definition: App.hpp:509
CLI11_NODISCARD std::size_t remaining_size(bool recurse=false) const
This returns the number of remaining options, minus the – separator.
void _parse(std::vector< std::string > &args)
Internal parse function.
bool allow_windows_style_options_
Allow '/' for options for Windows like options. Defaults to true on Windows, false otherwise...
Definition: App.hpp:235
App * configurable(bool value=true)
Specify that the subcommand can be triggered by a config file.
Definition: App.hpp:482
bool fallthrough_
Definition: App.hpp:229
CLI11_NODISCARD bool get_disabled() const
Get the status of disabled.
Definition: App.hpp:1153
std::vector< std::string > results_t
Definition: Option.hpp:31
App * description(std::string app_description)
Set the description of the app.
Definition: App.hpp:1056
Option * add_option(std::string option_name, AssignTo &variable, std::string option_description="")
Add option for assigning to a variable.
Definition: App.hpp:542
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:165
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:1464
CLI11_NODISCARD const Option * get_help_all_ptr() const
Get a pointer to the help all flag. (const)
Definition: App.hpp:1184
Option * run_callback_for_default(bool value=true)
Definition: Option.hpp:411
App * require_subcommand()
The argumentless form of require subcommand requires 1 or more subcommands.
Definition: App.hpp:787
CLI11_NODISCARD std::string version() const
Displays a version string.
App * add_subcommand(App *subcom)
Add an existing subcommand to be a member of an option_group.
Definition: App.hpp:1393
CLI11_INLINE void retire_option(App *app, Option *opt)
Helper function to mark an option as retired.
CLI11_NODISCARD std::size_t _count_remaining_positionals(bool required_only=false) const
Count the required remaining positional arguments.
AppFormatMode
Definition: FormatterFwd.hpp:32
OptionDefaults option_defaults_
The default values for options, customizable and changeable INHERITABLE.
Definition: App.hpp:146
void _parse_stream(std::istream &input)
Internal function to parse a stream.
All errors derive from this one.
Definition: Error.hpp:73
CLI11_NODISCARD bool get_immediate_callback() const
Get the status of disabled.
Definition: App.hpp:1162
bool prefix_command_
If true, cease processing on an unrecognized option (implies allow_extras) INHERITABLE.
Definition: App.hpp:114
missing_t missing_
Definition: App.hpp:191
App * allow_windows_style_options(bool value=true)
Definition: App.hpp:470
void _process_config_file()
Read and process a configuration file (main app only)
void _configure()
CLI11_NODISCARD App * get_option_group(std::string group_name) const
Check to see if an option group is part of this App.
void add_options(Option *opt)
Add an existing option to the Option_group.
Definition: App.hpp:1385
App * prefix_command(bool is_prefix=true)
Definition: App.hpp:460
CLI11_NODISCARD bool _has_remaining_positionals() const
Count the required remaining positional arguments.
App * required(bool require=true)
Remove the error when extras are left over on the command line.
Definition: App.hpp:381
std::shared_ptr< Config > config_formatter_
This is the formatter for help printing. Default provided. INHERITABLE (same pointer) ...
Definition: App.hpp:298
std::set< App * > need_subcommands_
Definition: App.hpp:208
App * usage(std::string usage_string)
Set usage.
Definition: App.hpp:1001
CLI11_NODISCARD const std::string & get_group() const
Get the group of this subcommand.
Definition: App.hpp:1119
std::string name_
Subcommand name or program name (from parser if name is empty)
Definition: App.hpp:101
Definition: Option.hpp:194
CLI11_NODISCARD std::string get_description() const
Get the app or subcommand description.
Definition: App.hpp:1053
typename std::enable_if< B, T >::type enable_if_t
Definition: TypeTools.hpp:47
CLI11_NODISCARD bool get_positionals_at_end() const
Check the status of the allow windows style options.
Definition: App.hpp:1113
App * alias(std::string app_name)
Set an alias for the app.
App * formatter_fn(std::function< std::string(const App *, std::string, AppFormatMode)> fmt)
Set the help formatter.
Definition: App.hpp:497
CLI11_NODISCARD App * _find_subcommand(const std::string &subc_name, bool ignore_disabled, bool ignore_used) const noexcept
The normal, detailed help.
Option * get_help_ptr()
Get a pointer to the help flag.
Definition: App.hpp:1178
bool silent_
Definition: App.hpp:261
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.
Option * type_size(int option_type_size)
Set a custom option size.
App & operator=(const App &)=delete
App * immediate_callback(bool immediate=true)
Set the subcommand callback to be executed immediately on subcommand completion.
App * footer(std::string footer_string)
Set footer.
Definition: App.hpp:1011
App * allow_config_extras(bool allow=true)
ignore extras in config files
Definition: App.hpp:442
App * require_subcommand(int value)
Definition: App.hpp:796
CLI11_NODISCARD std::string get_footer() const
Generate and return the footer.
Definition: App.hpp:1127
Option * config_ptr_
Pointer to the config option.
Definition: App.hpp:295
CLI11_NODISCARD std::shared_ptr< FormatterBase > get_formatter() const
Access the formatter.
Definition: App.hpp:1037
void parse(int argc, const char *const *argv)
Option * force_callback(bool value=true)
Set the value of force_callback.
Definition: Option.hpp:402
CLI11_NODISCARD bool get_allow_non_standard_option_names() const
Get the status of silence.
Definition: App.hpp:1159
void increment_parsed()
Internal function to recursively increment the parsed counter on the current app as well unnamed subc...
CLI11_NODISCARD std::string get_display_name(bool with_aliases=false) const
Get a display name for an app.
CLI11_NODISCARD std::size_t get_require_option_max() const
Get the required max option value.
Definition: App.hpp:1141
#define CLI11_NODISCARD
Definition: Macros.hpp:58
App * final_callback(std::function< void()> app_callback)
Definition: App.hpp:349
bool ignore_underscore_
If true, the program should ignore underscores INHERITABLE.
Definition: App.hpp:225
This will only trigger for actual void type.
Definition: TypeTools.hpp:504
App * name(std::string app_name="")
Set a name for the app (empty will use parser to set the name)
CLI11_NODISCARD bool get_subcommand_fallthrough() const
Check the status of subcommand fallthrough.
Definition: App.hpp:1107
std::function< void(std::size_t)> pre_parse_callback_
This is a function that runs prior to the start of parsing.
Definition: App.hpp:133
bool validate_optional_arguments_
If set to true optional vector arguments are validated before assigning INHERITABLE.
Definition: App.hpp:257
App * add_subcommand(std::string subcommand_name="", std::string subcommand_description="")
Add a subcommand. Inherits INHERITABLE and OptionDefaults, and help flag.
CLI11_NODISCARD bool get_silent() const
Get the status of silence.
Definition: App.hpp:1156
CLI11_NODISCARD bool get_ignore_underscore() const
Check the status of ignore_underscore.
Definition: App.hpp:1101
std::size_t require_subcommand_max_
Max number of subcommands allowed (parsing stops after this number). 0 is unlimited INHERITABLE...
Definition: App.hpp:273
std::vector< std::pair< detail::Classifier, std::string >> missing_t
Definition: App.hpp:186
Option * add_option(std::string option_name, callback_t option_callback, std::string option_description="", bool defaulted=false, std::function< std::string()> func={})
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...
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:584
CLI11_NODISCARD bool check_name(std::string name_to_check) const
Check the name, case-insensitive and underscore insensitive if set.
CLI11_NODISCARD bool get_prefix_command() const
Get the prefix command status.
Definition: App.hpp:1144
App * excludes(App *app)
Sets excluded subcommands for the subcommand.
Definition: App.hpp:951
App * validate_positionals(bool validate=true)
Set the subcommand to validate positional arguments before assigning.
Definition: App.hpp:430
bool remove_option(Option *opt)
Removes an option from the App. Takes an option pointer. Returns true if found and removed...
App * positionals_at_end(bool value=true)
Specify that the positional arguments are only at the end of the sequence.
Definition: App.hpp:476
App * ignore_underscore(bool value=true)
Ignore underscore. Subcommands inherit value.
Option * type_name(std::string typeval)
Set a custom option typestring.
Definition: Option.hpp:728
virtual ~App()=default
virtual destructor
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:673
static App * get_fallthrough_parent(App *app)
Wrap the fallthrough parent function to make sure that is working correctly.
Definition: App.hpp:1470
CLI11_NODISCARD std::vector< App * > get_subcommands() const
Definition: App.hpp:919
void _process_requirements()
Verify required options and cross requirements. Subcommands too (only if selected).
CLI11_NODISCARD bool get_fallthrough() const
Check the status of fallthrough.
Definition: App.hpp:1104
App * needs(Option *opt)
Definition: App.hpp:966
App * require_option(int value)
Definition: App.hpp:825
CLI11_NODISCARD const Option * get_option(std::string option_name) const
Get an option by name.
Definition: App.hpp:1074
CLI11_NODISCARD std::size_t get_require_subcommand_max() const
Get the required max subcommand value.
Definition: App.hpp:1135
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:936
Holds values to load into Options.
Definition: ConfigFwd.hpp:29
config_extras_mode allow_config_extras_
Definition: App.hpp:111
Definition: FormatterFwd.hpp:147
std::vector< App * > parsed_subcommands_
This is a list of the subcommands collected, in order.
Definition: App.hpp:197
std::shared_ptr< FormatterBase > formatter_
This is the formatter for help printing. Default provided. INHERITABLE (same pointer) ...
Definition: App.hpp:177
App * subcommand_fallthrough(bool value=true)
Set subcommand fallthrough, set to true so that subcommands on parents are recognized.
Definition: App.hpp:852
std::function< bool(const results_t &)> callback_t
callback function definition
Definition: Option.hpp:33
startup_mode
Definition: App.hpp:245
CRTP * always_capture_default(bool value=true)
Definition: Option.hpp:107
App * excludes(Option *opt)
Sets excluded options for the subcommand.
Definition: App.hpp:942
bool ignore_case_
If true, the program name is not case-sensitive INHERITABLE.
Definition: App.hpp:222
App * footer(std::function< std::string()> footer_function)
Set footer.
Definition: App.hpp:1016
Option * add_flag(std::string flag_name, T &flag_result, std::string flag_description="")
Definition: App.hpp:657
CLI11_NODISCARD bool get_validate_optional_arguments() const
Get the status of validating optional vector arguments.
Definition: App.hpp:1172
CLI11_NODISCARD const std::string & get_name() const
Get the name of the current app.
Definition: App.hpp:1205
bool required_
If set to true the subcommand is required to be processed and used, ignored for main app...
Definition: App.hpp:120
bool got_subcommand(const App *subcom) const
Check to see if given subcommand was selected.
Definition: App.hpp:930
Creates a command line program, with very few defaults.
Definition: App.hpp:90
App * group(std::string group_name)
Changes the group membership.
Definition: App.hpp:781
just get all the passed argument regardless
Option * set_help_flag(std::string flag_name="", const std::string &help_description="")
Set a help flag, replace the existing one if present.
CLI11_NODISCARD std::vector< std::string > get_groups() const
Get the groups available directly from this option (in order)
std::function< std::string(const App *, const Error &e)> failure_message_
The error message printing function INHERITABLE.
Definition: App.hpp:180
CLI11_NODISCARD std::size_t get_require_option_min() const
Get the required min option value.
Definition: App.hpp:1138
bool configurable_
if set to true the subcommand can be triggered via configuration files INHERITABLE ...
Definition: App.hpp:251
CLI11_NODISCARD std::string config_to_str(bool default_also=false, bool write_description=false) const
Definition: App.hpp:1022
This converter works with INI/TOML files; to write INI files use ConfigINI.
Definition: ConfigFwd.hpp:85
bool _parse_arg(std::vector< std::string > &args, detail::Classifier current_type, bool local_processing_only)
App * require_subcommand(std::size_t min, std::size_t max)
Definition: App.hpp:809
std::string usage_
Usage to put after program/subcommand description in the help output INHERITABLE. ...
Definition: App.hpp:156
CLI11_NODISCARD bool get_configurable() const
Check the status of the allow windows style options.
Definition: App.hpp:1116
void parse_from_stream(std::istream &input)
bool immediate_callback_
Definition: App.hpp:130
bool subcommand_fallthrough_
Allow subcommands to fallthrough, so that parent commands can trigger other subcommands after subcomm...
Definition: App.hpp:232
Option * default_flag_modifiers(Option *opt)
helper functions for adding in appropriate flag modifiers for add_flag
Definition: App.hpp:73
std::set< App * > exclude_subcommands_
this is a list of subcommands that are exclusionary to this one
Definition: App.hpp:200
App * _get_fallthrough_parent()
Get the appropriate parent to fallthrough to which is the first one that has a name or the main app...
App * parse_complete_callback(std::function< void()> pc_callback)
Definition: App.hpp:356
CLI11_NODISCARD std::shared_ptr< Config > get_config_formatter() const
Access the config formatter.
Definition: App.hpp:1040
sum all the arguments together if numerical or concatenate directly without delimiter ...
Option * expected(int value)
Set the number of expected arguments.
bool valid_alias_name_string(const std::string &str)
Verify an app name.
Definition: StringTools.hpp:166
App * usage(std::function< std::string()> usage_function)
Set usage.
Definition: App.hpp:1006
std::uint32_t parsed_
Counts the number of times this command/subcommand was parsed.
Definition: App.hpp:267
Option * default_str(std::string val)
Set the default value string representation (does not change the contained value) ...
Definition: Option.hpp:757
std::shared_ptr< App > App_p
Definition: App.hpp:67
bool positionals_at_end_
specify that positional arguments come at the end of the argument sequence not inheritable ...
Definition: App.hpp:243
Option * add_option(Option *opt)
Add an existing option to the Option_group.
Definition: App.hpp:1377
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:405
void _process()
Process callbacks and such.
App * fallthrough(bool value=true)
Definition: App.hpp:846
Option_group(std::string group_description, std::string group_name, App *parent)
Definition: App.hpp:1365
std::size_t require_option_max_
Max number of options allowed. 0 is unlimited (not inheritable)
Definition: App.hpp:279
void _parse_config(const std::vector< ConfigItem > &args)
virtual void pre_callback()
Definition: App.hpp:868
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.
void add_options(Option *opt, Args...args)
Add a bunch of options to the group.
Definition: App.hpp:1387
std::function< void()> final_callback_
This is a function that runs when all processing has completed.
Definition: App.hpp:139