CLI11  2.5.0
Option.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 <functional>
14 #include <memory>
15 #include <set>
16 #include <string>
17 #include <tuple>
18 #include <utility>
19 #include <vector>
20 // [CLI11:public_includes:end]
21 
22 #include "Error.hpp"
23 #include "Macros.hpp"
24 #include "Split.hpp"
25 #include "StringTools.hpp"
26 #include "Validators.hpp"
27 
28 namespace CLI {
29 // [CLI11:option_hpp:verbatim]
30 
31 using results_t = std::vector<std::string>;
33 using callback_t = std::function<bool(const results_t &)>;
34 
35 class Option;
36 class App;
37 
38 using Option_p = std::unique_ptr<Option>;
40 enum class MultiOptionPolicy : char {
41  Throw,
42  TakeLast,
43  TakeFirst,
44  Join,
45  TakeAll,
46  Sum,
47  Reverse,
48 };
49 
52 template <typename CRTP> class OptionBase {
53  friend App;
54 
55  protected:
57  std::string group_ = std::string("OPTIONS");
58 
60  bool required_{false};
61 
63  bool ignore_case_{false};
64 
66  bool ignore_underscore_{false};
67 
69  bool configurable_{true};
70 
73 
75  char delimiter_{'\0'};
76 
79 
82 
84  template <typename T> void copy_to(T *other) const;
85 
86  public:
87  // setters
88 
90  CRTP *group(const std::string &name) {
92  throw IncorrectConstruction("Group names may not contain newlines or null characters");
93  }
94  group_ = name;
95  return static_cast<CRTP *>(this);
96  }
97 
99  CRTP *required(bool value = true) {
100  required_ = value;
101  return static_cast<CRTP *>(this);
102  }
103 
105  CRTP *mandatory(bool value = true) { return required(value); }
106 
107  CRTP *always_capture_default(bool value = true) {
108  always_capture_default_ = value;
109  return static_cast<CRTP *>(this);
110  }
111 
112  // Getters
113 
115  CLI11_NODISCARD const std::string &get_group() const { return group_; }
116 
118  CLI11_NODISCARD bool get_required() const { return required_; }
119 
122 
125 
128 
131 
133  CLI11_NODISCARD char get_delimiter() const { return delimiter_; }
134 
137 
140 
141  // Shortcuts for multi option policy
142 
144  CRTP *take_last() {
145  auto *self = static_cast<CRTP *>(this);
147  return self;
148  }
149 
151  CRTP *take_first() {
152  auto *self = static_cast<CRTP *>(this);
154  return self;
155  }
156 
158  CRTP *take_all() {
159  auto self = static_cast<CRTP *>(this);
161  return self;
162  }
163 
165  CRTP *join() {
166  auto *self = static_cast<CRTP *>(this);
168  return self;
169  }
170 
172  CRTP *join(char delim) {
173  auto self = static_cast<CRTP *>(this);
174  self->delimiter_ = delim;
175  self->multi_option_policy(MultiOptionPolicy::Join);
176  return self;
177  }
178 
180  CRTP *configurable(bool value = true) {
181  configurable_ = value;
182  return static_cast<CRTP *>(this);
183  }
184 
186  CRTP *delimiter(char value = '\0') {
187  delimiter_ = value;
188  return static_cast<CRTP *>(this);
189  }
190 };
191 
194 class OptionDefaults : public OptionBase<OptionDefaults> {
195  public:
196  OptionDefaults() = default;
197 
198  // Methods here need a different implementation if they are Option vs. OptionDefault
199 
202  multi_option_policy_ = value;
203  return this;
204  }
205 
207  OptionDefaults *ignore_case(bool value = true) {
208  ignore_case_ = value;
209  return this;
210  }
211 
213  OptionDefaults *ignore_underscore(bool value = true) {
214  ignore_underscore_ = value;
215  return this;
216  }
217 
219  OptionDefaults *disable_flag_override(bool value = true) {
220  disable_flag_override_ = value;
221  return this;
222  }
223 
225  OptionDefaults *delimiter(char value = '\0') {
226  delimiter_ = value;
227  return this;
228  }
229 };
230 
231 class Option : public OptionBase<Option> {
232  friend App;
233 
234  protected:
237 
239  std::vector<std::string> snames_{};
240 
242  std::vector<std::string> lnames_{};
243 
246  std::vector<std::pair<std::string, std::string>> default_flag_values_{};
247 
249  std::vector<std::string> fnames_{};
250 
252  std::string pname_{};
253 
255  std::string envname_{};
256 
260 
262  std::string description_{};
263 
265  std::string default_str_{};
266 
268  std::string option_text_{};
269 
273  std::function<std::string()> type_name_{[]() { return std::string(); }};
274 
276  std::function<std::string()> default_function_{};
277 
281 
287 
292 
294  std::vector<Validator> validators_{};
295 
297  std::set<Option *> needs_{};
298 
300  std::set<Option *> excludes_{};
301 
305 
307  App *parent_{nullptr};
308 
311 
315 
321  enum class option_state : char {
322  parsing = 0,
323  validated = 2,
324  reduced = 4,
325  callback_run = 6,
326  };
330  bool allow_extra_args_{false};
332  bool flag_like_{false};
336  bool inject_separator_{false};
338  bool trigger_on_result_{false};
340  bool force_callback_{false};
342 
344  Option(std::string option_name,
345  std::string option_description,
346  callback_t callback,
347  App *parent,
348  bool allow_non_standard = false)
349  : description_(std::move(option_description)), parent_(parent), callback_(std::move(callback)) {
350  std::tie(snames_, lnames_, pname_) = detail::get_names(detail::split_names(option_name), allow_non_standard);
351  }
352 
353  public:
356 
357  Option(const Option &) = delete;
358  Option &operator=(const Option &) = delete;
359 
361  CLI11_NODISCARD std::size_t count() const { return results_.size(); }
362 
364  CLI11_NODISCARD bool empty() const { return results_.empty(); }
365 
367  explicit operator bool() const { return !empty() || force_callback_; }
368 
370  void clear() {
371  results_.clear();
373  }
374 
378 
380  Option *expected(int value);
381 
383  Option *expected(int value_min, int value_max);
384 
387  Option *allow_extra_args(bool value = true) {
388  allow_extra_args_ = value;
389  return this;
390  }
394  Option *trigger_on_parse(bool value = true) {
395  trigger_on_result_ = value;
396  return this;
397  }
400 
402  Option *force_callback(bool value = true) {
403  force_callback_ = value;
404  return this;
405  }
408 
411  Option *run_callback_for_default(bool value = true) {
413  return this;
414  }
417 
419  Option *check(Validator validator, const std::string &validator_name = "");
420 
422  Option *check(std::function<std::string(const std::string &)> Validator,
423  std::string Validator_description = "",
424  std::string Validator_name = "");
425 
427  Option *transform(Validator Validator, const std::string &Validator_name = "");
428 
430  Option *transform(const std::function<std::string(std::string)> &func,
431  std::string transform_description = "",
432  std::string transform_name = "");
433 
435  Option *each(const std::function<void(std::string)> &func);
436 
438  Validator *get_validator(const std::string &Validator_name = "");
439 
441  Validator *get_validator(int index);
442 
444  Option *needs(Option *opt) {
445  if(opt != this) {
446  needs_.insert(opt);
447  }
448  return this;
449  }
450 
452  template <typename T = App> Option *needs(std::string opt_name) {
453  auto opt = static_cast<T *>(parent_)->get_option_no_throw(opt_name);
454  if(opt == nullptr) {
455  throw IncorrectConstruction::MissingOption(opt_name);
456  }
457  return needs(opt);
458  }
459 
461  template <typename A, typename B, typename... ARG> Option *needs(A opt, B opt1, ARG... args) {
462  needs(opt);
463  return needs(opt1, args...); // NOLINT(readability-suspicious-call-argument)
464  }
465 
467  bool remove_needs(Option *opt);
468 
470  Option *excludes(Option *opt);
471 
473  template <typename T = App> Option *excludes(std::string opt_name) {
474  auto opt = static_cast<T *>(parent_)->get_option_no_throw(opt_name);
475  if(opt == nullptr) {
476  throw IncorrectConstruction::MissingOption(opt_name);
477  }
478  return excludes(opt);
479  }
480 
482  template <typename A, typename B, typename... ARG> Option *excludes(A opt, B opt1, ARG... args) {
483  excludes(opt);
484  return excludes(opt1, args...);
485  }
486 
488  bool remove_excludes(Option *opt);
489 
491  Option *envname(std::string name) {
492  envname_ = std::move(name);
493  return this;
494  }
495 
500  template <typename T = App> Option *ignore_case(bool value = true);
501 
506  template <typename T = App> Option *ignore_underscore(bool value = true);
507 
510 
512  Option *disable_flag_override(bool value = true) {
513  disable_flag_override_ = value;
514  return this;
515  }
519 
522 
527 
530 
532  CLI11_NODISCARD std::string get_envname() const { return envname_; }
533 
535  CLI11_NODISCARD std::set<Option *> get_needs() const { return needs_; }
536 
538  CLI11_NODISCARD std::set<Option *> get_excludes() const { return excludes_; }
539 
541  CLI11_NODISCARD std::string get_default_str() const { return default_str_; }
542 
545 
547  CLI11_NODISCARD const std::vector<std::string> &get_lnames() const { return lnames_; }
548 
550  CLI11_NODISCARD const std::vector<std::string> &get_snames() const { return snames_; }
551 
553  CLI11_NODISCARD const std::vector<std::string> &get_fnames() const { return fnames_; }
555  CLI11_NODISCARD const std::string &get_single_name() const {
556  if(!lnames_.empty()) {
557  return lnames_[0];
558  }
559  if(!snames_.empty()) {
560  return snames_[0];
561  }
562  if(!pname_.empty()) {
563  return pname_;
564  }
565  return envname_;
566  }
569 
574 
577 
580  int t = type_size_max_;
582  }
585 
587  CLI11_NODISCARD bool get_positional() const { return !pname_.empty(); }
588 
590  CLI11_NODISCARD bool nonpositional() const { return (!lnames_.empty() || !snames_.empty()); }
591 
593  CLI11_NODISCARD bool has_description() const { return !description_.empty(); }
594 
596  CLI11_NODISCARD const std::string &get_description() const { return description_; }
597 
599  Option *description(std::string option_description) {
600  description_ = std::move(option_description);
601  return this;
602  }
603 
604  Option *option_text(std::string text) {
605  option_text_ = std::move(text);
606  return this;
607  }
608 
609  CLI11_NODISCARD const std::string &get_option_text() const { return option_text_; }
610 
614 
619  CLI11_NODISCARD std::string get_name(bool positional = false,
620  bool all_options = false
621  ) const;
622 
626 
628  void run_callback();
629 
631  CLI11_NODISCARD const std::string &matching_name(const Option &other) const;
632 
634  bool operator==(const Option &other) const { return !matching_name(other).empty(); }
635 
637  CLI11_NODISCARD bool check_name(const std::string &name) const;
638 
640  CLI11_NODISCARD bool check_sname(std::string name) const {
641  return (detail::find_member(std::move(name), snames_, ignore_case_) >= 0);
642  }
643 
645  CLI11_NODISCARD bool check_lname(std::string name) const {
646  return (detail::find_member(std::move(name), lnames_, ignore_case_, ignore_underscore_) >= 0);
647  }
648 
650  CLI11_NODISCARD bool check_fname(std::string name) const {
651  if(fnames_.empty()) {
652  return false;
653  }
654  return (detail::find_member(std::move(name), fnames_, ignore_case_, ignore_underscore_) >= 0);
655  }
656 
659  CLI11_NODISCARD std::string get_flag_value(const std::string &name, std::string input_value) const;
660 
662  Option *add_result(std::string s);
663 
665  Option *add_result(std::string s, int &results_added);
666 
668  Option *add_result(std::vector<std::string> s);
669 
671  CLI11_NODISCARD const results_t &results() const { return results_; }
672 
675 
677  template <typename T> void results(T &output) const {
678  bool retval = false;
679  if(current_option_state_ >= option_state::reduced || (results_.size() == 1 && validators_.empty())) {
680  const results_t &res = (proc_results_.empty()) ? results_ : proc_results_;
681  retval = detail::lexical_conversion<T, T>(res, output);
682  } else {
683  results_t res;
684  if(results_.empty()) {
685  if(!default_str_.empty()) {
686  // _add_results takes an rvalue only
687  _add_result(std::string(default_str_), res);
688  _validate_results(res);
689  results_t extra;
690  _reduce_results(extra, res);
691  if(!extra.empty()) {
692  res = std::move(extra);
693  }
694  } else {
695  res.emplace_back();
696  }
697  } else {
698  res = reduced_results();
699  }
700  retval = detail::lexical_conversion<T, T>(res, output);
701  }
702  if(!retval) {
704  }
705  }
706 
708  template <typename T> CLI11_NODISCARD T as() const {
709  T output;
710  results(output);
711  return output;
712  }
713 
716 
720 
722  Option *type_name_fn(std::function<std::string()> typefun) {
723  type_name_ = std::move(typefun);
724  return this;
725  }
726 
728  Option *type_name(std::string typeval) {
729  type_name_fn([typeval]() { return typeval; });
730  return this;
731  }
732 
734  Option *type_size(int option_type_size);
735 
737  Option *type_size(int option_type_size_min, int option_type_size_max);
738 
740  void inject_separator(bool value = true) { inject_separator_ = value; }
741 
743  Option *default_function(const std::function<std::string()> &func) {
744  default_function_ = func;
745  return this;
746  }
747 
750  if(default_function_) {
752  }
753  return this;
754  }
755 
757  Option *default_str(std::string val) {
758  default_str_ = std::move(val);
759  return this;
760  }
761 
764  template <typename X> Option *default_val(const X &val) {
765  std::string val_str = detail::to_string(val);
766  auto old_option_state = current_option_state_;
767  results_t old_results{std::move(results_)};
768  results_.clear();
769  try {
770  add_result(val_str);
771  // if trigger_on_result_ is set the callback already ran
773  run_callback(); // run callback sets the state, we need to reset it again
775  } else {
776  _validate_results(results_);
777  current_option_state_ = old_option_state;
778  }
779  } catch(const ValidationError &err) {
780  // this should be done
781  results_ = std::move(old_results);
782  current_option_state_ = old_option_state;
783  // try an alternate way to convert
784  std::string alternate = detail::value_string(val);
785  if(!alternate.empty() && alternate != val_str) {
786  return default_val(alternate);
787  }
788 
789  throw ValidationError(get_name(),
790  std::string("given default value does not pass validation :") + err.what());
791  } catch(const ConversionError &err) {
792  // this should be done
793  results_ = std::move(old_results);
794  current_option_state_ = old_option_state;
795 
796  throw ConversionError(
797  get_name(), std::string("given default value(\"") + val_str + "\") produces an error : " + err.what());
798  } catch(const CLI::Error &) {
799  results_ = std::move(old_results);
800  current_option_state_ = old_option_state;
801  throw;
802  }
803  results_ = std::move(old_results);
804  default_str_ = std::move(val_str);
805  return this;
806  }
807 
809  CLI11_NODISCARD std::string get_type_name() const;
810 
811  private:
813  void _validate_results(results_t &res) const;
814 
818  void _reduce_results(results_t &out, const results_t &original) const;
819 
820  // Run a result through the Validators
821  std::string _validate(std::string &result, int index) const;
822 
824  int _add_result(std::string &&result, std::vector<std::string> &res) const;
825 };
826 
827 // [CLI11:option_hpp:end]
828 } // namespace CLI
829 
830 #ifndef CLI11_COMPILE
831 #include "impl/Option_inl.hpp" // IWYU pragma: export
832 #endif
bool run_callback_for_default_
Control option to run the callback to set the default.
Definition: Option.hpp:334
CLI11_NODISCARD std::string get_default_str() const
The default value (for help printing)
Definition: Option.hpp:541
CLI11_NODISCARD const std::vector< std::string > & get_lnames() const
Get the long names.
Definition: Option.hpp:547
std::string option_text_
If given, replace the text that describes the option type and usage in the help text.
Definition: Option.hpp:268
CLI11_NODISCARD int get_type_size_min() const
The minimum number of arguments the option expects.
Definition: Option.hpp:524
CLI11_NODISCARD std::size_t count() const
Count the total number of times an option was passed.
Definition: Option.hpp:361
Option * each(const std::function< void(std::string)> &func)
Adds a user supplied function to run on each item passed in (communicate though lambda capture) ...
CLI11_NODISCARD bool get_inject_separator() const
Return the inject_separator flag.
Definition: Option.hpp:529
std::function< std::string()> type_name_
Definition: Option.hpp:273
CRTP * required(bool value=true)
Set the option as required.
Definition: Option.hpp:99
take only the first Expected number of arguments
CLI11_NODISCARD bool get_run_callback_for_default() const
Get the current value of run_callback_for_default.
Definition: Option.hpp:416
std::string description_
The description for help strings.
Definition: Option.hpp:262
Option * needs(std::string opt_name)
Can find a string if needed.
Definition: Option.hpp:452
option_state
enumeration for the option state machine
Definition: Option.hpp:321
CLI11_NODISCARD std::set< Option * > get_excludes() const
The set of options excluded.
Definition: Option.hpp:538
CRTP * group(const std::string &name)
Changes the group membership.
Definition: Option.hpp:90
Definition: App.hpp:36
bool ignore_underscore_
Ignore underscores when matching (option, not value)
Definition: Option.hpp:66
bool ignore_case_
Ignore the case when matching (option, not value)
Definition: Option.hpp:63
void copy_to(T *other) const
Copy the contents to another similar class (one based on OptionBase)
CLI11_NODISCARD const std::vector< std::string > & get_snames() const
Get the short names.
Definition: Option.hpp:550
CLI11_NODISCARD char get_delimiter() const
Get the current delimiter char.
Definition: Option.hpp:133
std::string envname_
If given, check the environment for this option.
Definition: Option.hpp:255
CLI11_NODISCARD const std::string & get_option_text() const
Definition: Option.hpp:609
MultiOptionPolicy multi_option_policy_
Policy for handling multiple arguments beyond the expected Max.
Definition: Option.hpp:81
Throw an error if any extra arguments were given.
CLI11_NODISCARD int get_expected_min() const
The number of times the option expects to be included.
Definition: Option.hpp:571
CLI11_NODISCARD bool get_trigger_on_parse() const
The status of trigger on parse.
Definition: Option.hpp:399
CLI11_NODISCARD std::string get_envname() const
The environment variable associated to this value.
Definition: Option.hpp:532
Validator * get_validator(const std::string &Validator_name="")
Get a named Validator.
CLI11_NODISCARD int get_type_size() const
The number of arguments the option expects.
Definition: Option.hpp:521
OptionDefaults * ignore_case(bool value=true)
Ignore the case of the option name.
Definition: Option.hpp:207
Option * needs(Option *opt)
Sets required options.
Definition: Option.hpp:444
std::set< Option * > excludes_
A list of options that are excluded with this option.
Definition: Option.hpp:300
bool trigger_on_result_
flag indicating that the option should trigger the validation and callback chain on each result when ...
Definition: Option.hpp:338
CLI11_NODISCARD MultiOptionPolicy get_multi_option_policy() const
The status of the multi option policy.
Definition: Option.hpp:139
Definition: Option.hpp:231
Option * type_name_fn(std::function< std::string()> typefun)
Set the type function to run when displayed on this option.
Definition: Option.hpp:722
STL namespace.
CLI11_NODISCARD bool has_description() const
True if option has description.
Definition: Option.hpp:593
void results(T &output) const
Get the results as a specified type.
Definition: Option.hpp:677
CLI11_NODISCARD results_t reduced_results() const
Get a copy of the results.
The option is currently collecting parsed results.
CLI11_NODISCARD const std::string & get_single_name() const
Get a single name for the option, first of lname, sname, pname, envname.
Definition: Option.hpp:555
CRTP * join(char delim)
Set the multi option policy to join with a specific delimiter.
Definition: Option.hpp:172
OptionDefaults * delimiter(char value= '\0')
set a delimiter character to split up single arguments to treat as multiple inputs ...
Definition: Option.hpp:225
CLI11_NODISCARD bool check_fname(std::string name) const
Requires "--" to be removed from string.
Definition: Option.hpp:650
Option * envname(std::string name)
Sets environment variable to read if no option given.
Definition: Option.hpp:491
CRTP * delimiter(char value= '\0')
Allow in a configuration file.
Definition: Option.hpp:186
Option * disable_flag_override(bool value=true)
Disable flag overrides values, e.g. –flag=is not allowed.
Definition: Option.hpp:512
MultiOptionPolicy
Enumeration of the multiOption Policy selection.
Definition: Option.hpp:40
Option & operator=(const Option &)=delete
OptionDefaults()=default
CLI11_NODISCARD bool get_configurable() const
The status of configurable.
Definition: Option.hpp:127
CLI11_NODISCARD bool get_required() const
True if this is a required option.
Definition: Option.hpp:118
Option * excludes(Option *opt)
Sets excluded options.
CLI11_NODISCARD bool check_sname(std::string name) const
Requires "-" to be removed from string.
Definition: Option.hpp:640
auto to_string(T &&value) -> decltype(std::forward< T >(value))
Convert an object to a string (directly forward if this can become a string)
Definition: TypeTools.hpp:337
Option * default_function(const std::function< std::string()> &func)
Set a capture function for the default. Mostly used by App.
Definition: Option.hpp:743
std::vector< std::string > fnames_
a list of flag names with specified default values;
Definition: Option.hpp:249
bool remove_excludes(Option *opt)
Remove needs link from an option. Returns true if the option really was in the needs list...
std::vector< std::string > snames_
A list of the short names (-a) without the leading dashes.
Definition: Option.hpp:239
Option * excludes(std::string opt_name)
Can find a string if needed.
Definition: Option.hpp:473
CLI11_NODISCARD const std::string & get_description() const
Get the description.
Definition: Option.hpp:596
Option * multi_option_policy(MultiOptionPolicy value=MultiOptionPolicy::Throw)
Take the last argument if given multiple times (or another policy)
Option * trigger_on_parse(bool value=true)
Set the value of trigger_on_parse which specifies that the option callback should be triggered on eve...
Definition: Option.hpp:394
Definition: Option.hpp:52
callback_t callback_
Options store a callback to do all the work.
Definition: Option.hpp:310
CRTP * take_first()
Set the multi option policy to take last.
Definition: Option.hpp:151
Option * transform(Validator Validator, const std::string &Validator_name="")
Adds a transforming Validator with a built in type name.
CLI11_NODISCARD bool get_callback_run() const
See if the callback has been run already.
Definition: Option.hpp:715
int expected_min_
The minimum number of expected values.
Definition: Option.hpp:289
bool flag_like_
Specify that the option should act like a flag vs regular option.
Definition: Option.hpp:332
bool force_callback_
flag indicating that the option should force the callback regardless if any results present ...
Definition: Option.hpp:340
CLI11_NODISCARD bool get_disable_flag_override() const
The status of configurable.
Definition: Option.hpp:130
OptionDefaults * ignore_underscore(bool value=true)
Ignore underscores in the option name.
Definition: Option.hpp:213
std::unique_ptr< Option > Option_p
Definition: Option.hpp:38
CLI11_NODISCARD int get_items_expected_min() const
The total min number of expected string values to be used.
Definition: Option.hpp:576
Option * check(Validator validator, const std::string &validator_name="")
Adds a Validator with a built in type name.
void inject_separator(bool value=true)
Set the value of the separator injection flag.
Definition: Option.hpp:740
std::vector< std::string > results_t
Definition: Option.hpp:31
CLI11_NODISCARD std::string get_flag_value(const std::string &name, std::string input_value) const
Thrown when conversion call back fails, such as when an int fails to coerce to a string.
Definition: Error.hpp:205
OptionDefaults * multi_option_policy(MultiOptionPolicy value=MultiOptionPolicy::Throw)
Take the last argument if given multiple times.
Definition: Option.hpp:201
Option * run_callback_for_default(bool value=true)
Definition: Option.hpp:411
int expected_max_
The maximum number of expected values.
Definition: Option.hpp:291
void clear()
Clear the parsed results (mostly for testing)
Definition: Option.hpp:370
CLI11_NODISCARD std::string get_type_name() const
Get the full typename for this option.
CLI11_NODISCARD bool get_force_callback() const
The status of force_callback.
Definition: Option.hpp:407
results_t proc_results_
results after reduction
Definition: Option.hpp:319
CLI11_NODISCARD bool get_allow_extra_args() const
Get the current value of allow extra args.
Definition: Option.hpp:392
bool always_capture_default_
Automatically capture default value.
Definition: Option.hpp:78
CLI11_NODISCARD int get_expected_max() const
The max number of times the option expects to be included.
Definition: Option.hpp:573
Option * option_text(std::string text)
Definition: Option.hpp:604
std::set< Option * > needs_
A list of options that are required with this option.
Definition: Option.hpp:297
CLI11_NODISCARD int get_expected() const
The number of times the option expects to be included.
Definition: Option.hpp:568
All errors derive from this one.
Definition: Error.hpp:73
std::string pname_
A positional name.
Definition: Option.hpp:252
Thrown when validation of results fails.
Definition: Error.hpp:221
CLI11_NODISCARD std::set< Option * > get_needs() const
The set of options needed.
Definition: Option.hpp:535
std::vector< Validator > validators_
A list of Validators to run on each value parsed.
Definition: Option.hpp:294
CLI11_INLINE std::tuple< std::vector< std::string >, std::vector< std::string >, std::string > get_names(const std::vector< std::string > &input, bool allow_non_standard=false)
Get a vector of short names, one of long names, and a single name.
CLI11_INLINE std::vector< std::string > split_names(std::string current)
bool required_
True if this is a required option.
Definition: Option.hpp:60
CLI11_NODISCARD std::string get_name(bool positional=false, bool all_options=false) const
Gets a comma separated list of names. Will include / prefer the positional name if positional is true...
int type_size_min_
The minimum number of arguments an option should be expecting.
Definition: Option.hpp:286
std::vector< std::pair< std::string, std::string > > default_flag_values_
Definition: Option.hpp:246
bool disable_flag_override_
Disable overriding flag values with '=value'.
Definition: Option.hpp:72
Option * allow_extra_args(bool value=true)
Definition: Option.hpp:387
CLI11_NODISCARD bool check_name(const std::string &name) const
Check a name. Requires "-" or "--" for short / long, supports positional name.
Option * description(std::string option_description)
Set the description.
Definition: Option.hpp:599
Definition: Option.hpp:194
CRTP * join()
Set the multi option policy to join.
Definition: Option.hpp:165
CLI11_NODISCARD bool check_lname(std::string name) const
Requires "--" to be removed from string.
Definition: Option.hpp:645
CLI11_NODISCARD bool get_ignore_case() const
The status of ignore case.
Definition: Option.hpp:121
CLI11_NODISCARD const std::string & get_group() const
Get the group of this option.
Definition: Option.hpp:115
Option * type_size(int option_type_size)
Set a custom option size.
CRTP * take_last()
Set the multi option policy to take last.
Definition: Option.hpp:144
int type_size_max_
Definition: Option.hpp:284
CLI11_NODISCARD bool get_ignore_underscore() const
The status of ignore_underscore.
Definition: Option.hpp:124
App * parent_
link back up to the parent App for fallthrough
Definition: Option.hpp:307
Option * force_callback(bool value=true)
Set the value of force_callback.
Definition: Option.hpp:402
OptionDefaults * disable_flag_override(bool value=true)
Disable overriding flag values with an '=' segment.
Definition: Option.hpp:219
CLI11_NODISCARD int get_type_size_max() const
The maximum number of arguments the option expects.
Definition: Option.hpp:526
#define CLI11_NODISCARD
Definition: Macros.hpp:58
bool inject_separator_
flag indicating a separator needs to be injected after each argument call
Definition: Option.hpp:336
CLI11_NODISCARD bool nonpositional() const
True if option has at least one non-positional name.
Definition: Option.hpp:590
CRTP * configurable(bool value=true)
Allow in a configuration file.
Definition: Option.hpp:180
std::vector< std::string > lnames_
A list of the long names (--long) without the leading dashes.
Definition: Option.hpp:242
Some validators that are provided.
Definition: Validators.hpp:55
CLI11_NODISCARD const std::string & matching_name(const Option &other) const
If options share any of the same names, find it.
CLI11_INLINE std::ptrdiff_t find_member(std::string name, const std::vector< std::string > names, bool ignore_case=false, bool ignore_underscore=false)
Check if a string is a member of a list of strings and optionally ignore case or ignore underscores...
take only the last Expected number of arguments
bool configurable_
Allow this option to be given in a configuration file.
Definition: Option.hpp:69
bool allow_extra_args_
Specify that extra args beyond type_size_max should be allowed.
Definition: Option.hpp:330
bool operator==(const Option &other) const
If options share any of the same names, they are equal (not counting positional)
Definition: Option.hpp:634
CLI11_NODISCARD bool get_always_capture_default() const
Return true if this will automatically capture the default value for help printing.
Definition: Option.hpp:136
Option * type_name(std::string typeval)
Set a custom option typestring.
Definition: Option.hpp:728
Option * ignore_case(bool value=true)
the callback has been executed
std::string value_string(const T &value)
get a string as a convertible value for arithmetic types
Definition: TypeTools.hpp:470
std::string default_str_
A human readable default value, either manually set, captured, or captured by default.
Definition: Option.hpp:265
CRTP * mandatory(bool value=true)
Support Plumbum term.
Definition: Option.hpp:105
std::function< bool(const results_t &)> callback_t
callback function definition
Definition: Option.hpp:33
CLI11_NODISCARD const results_t & results() const
Get the current complete results set.
Definition: Option.hpp:671
CRTP * always_capture_default(bool value=true)
Definition: Option.hpp:107
option_state current_option_state_
Whether the callback has run (needed for INI parsing)
Definition: Option.hpp:328
CLI11_NODISCARD int get_items_expected() const
The total min number of expected string values to be used.
Definition: Option.hpp:584
results_t results_
complete Results of parsing
Definition: Option.hpp:317
std::string group_
The group membership.
Definition: Option.hpp:57
Option * excludes(A opt, B opt1, ARG...args)
Any number supported, any mix of string and Opt.
Definition: Option.hpp:482
merge all the arguments together into a single string via the delimiter character default(' ') ...
Creates a command line program, with very few defaults.
Definition: App.hpp:90
just get all the passed argument regardless
CLI11_NODISCARD int get_items_expected_max() const
Get the maximum number of items expected to be returned and used for the callback.
Definition: Option.hpp:579
CLI11_NODISCARD callback_t get_callback() const
Get the callback function.
Definition: Option.hpp:544
the results have been validated
Option * needs(A opt, B opt1, ARG...args)
Any number supported, any mix of string and Opt.
Definition: Option.hpp:461
CLI11_NODISCARD bool get_positional() const
True if the argument can be given directly.
Definition: Option.hpp:587
CLI11_NODISCARD const std::vector< std::string > & get_fnames() const
Get the flag names with specified default values.
Definition: Option.hpp:553
bool remove_needs(Option *opt)
Remove needs link from an option. Returns true if the option really was in the needs list...
std::enable_if< std::is_integral< T >::value, bool >::type checked_multiply(T &a, T b)
Performs a *= b; if it doesn't cause integer overflow. Returns false otherwise.
Definition: Validators.hpp:461
sum all the arguments together if numerical or concatenate directly without delimiter ...
Option * expected(int value)
Set the number of expected arguments.
char delimiter_
Specify a delimiter character for vector arguments.
Definition: Option.hpp:75
take only the last Expected number of arguments in reverse order
bool valid_alias_name_string(const std::string &str)
Verify an app name.
Definition: StringTools.hpp:166
Option * default_str(std::string val)
Set the default value string representation (does not change the contained value) ...
Definition: Option.hpp:757
Option * capture_default_str()
Capture the default value from the original value (if it can be captured)
Definition: Option.hpp:749
a subset of results has been generated
CRTP * take_all()
Set the multi option policy to take all arguments.
Definition: Option.hpp:158
Option * add_result(std::string s)
Puts a result at the end.
std::function< std::string()> default_function_
Run this function to capture a default (ignore if empty)
Definition: Option.hpp:276
Option(std::string option_name, std::string option_description, callback_t callback, App *parent, bool allow_non_standard=false)
Making an option by hand is not defined, it must be made by the App class.
Definition: Option.hpp:344
constexpr int expected_max_vector_size
Definition: StringTools.hpp:47
Option * default_val(const X &val)
Definition: Option.hpp:764
void run_callback()
Process the callback.
CLI11_NODISCARD T as() const
Return the results as the specified type.
Definition: Option.hpp:708
Option * ignore_underscore(bool value=true)
CLI11_NODISCARD bool empty() const
True if the option was not passed.
Definition: Option.hpp:364