57 std::string
group_ = std::string(
"Options");
84 template <
typename T>
void copy_to(T *other)
const;
90 CRTP *
group(
const std::string &name) {
95 return static_cast<CRTP *
>(
this);
101 return static_cast<CRTP *
>(
this);
109 return static_cast<CRTP *
>(
this);
145 auto *self =
static_cast<CRTP *
>(
this);
152 auto *self =
static_cast<CRTP *
>(
this);
159 auto self =
static_cast<CRTP *
>(
this);
166 auto *self =
static_cast<CRTP *
>(
this);
173 auto self =
static_cast<CRTP *
>(
this);
174 self->delimiter_ = delim;
182 return static_cast<CRTP *
>(
this);
188 return static_cast<CRTP *
>(
this);
273 std::function<std::string()>
type_name_{[]() {
return std::string(); }};
419 std::string Validator_description =
"",
420 std::string Validator_name =
"");
427 std::string transform_description =
"",
428 std::string transform_name =
"");
449 auto opt =
static_cast<T *
>(
parent_)->get_option_no_throw(opt_name);
451 throw IncorrectConstruction::MissingOption(opt_name);
457 template <
typename A,
typename B,
typename... ARG>
Option *
needs(A opt, B opt1, ARG... args) {
459 return needs(opt1, args...);
470 auto opt =
static_cast<T *
>(
parent_)->get_option_no_throw(opt_name);
472 throw IncorrectConstruction::MissingOption(opt_name);
478 template <
typename A,
typename B,
typename... ARG>
Option *
excludes(A opt, B opt1, ARG... args) {
616 bool all_options =
false
673 template <
typename T>
void results(T &output)
const {
677 retval = detail::lexical_conversion<T, T>(res, output);
684 _validate_results(res);
686 _reduce_results(extra, res);
688 res = std::move(extra);
696 retval = detail::lexical_conversion<T, T>(res, output);
791 void _validate_results(
results_t &res)
const;
799 std::string _validate(std::string &result,
int index)
const;
802 int _add_result(std::string &&result, std::vector<std::string> &res)
const;
809#include "impl/Option_inl.hpp"
#define CLI11_NODISCARD
Definition Macros.hpp:49
Creates a command line program, with very few defaults.
Definition App.hpp:90
Thrown when conversion call back fails, such as when an int fails to coerce to a string.
Definition Error.hpp:205
All errors derive from this one.
Definition Error.hpp:73
Thrown when an option is set to conflicting values (non-vector and multi args, for example)
Definition Error.hpp:96
CRTP * mandatory(bool value=true)
Support Plumbum term.
Definition Option.hpp:105
CRTP * take_all()
Set the multi option policy to take all arguments.
Definition Option.hpp:158
CRTP * group(const std::string &name)
Changes the group membership.
Definition Option.hpp:90
CRTP * join()
Set the multi option policy to join.
Definition Option.hpp:165
bool always_capture_default_
Automatically capture default value.
Definition Option.hpp:78
MultiOptionPolicy multi_option_policy_
Policy for handling multiple arguments beyond the expected Max.
Definition Option.hpp:81
CRTP * join(char delim)
Set the multi option policy to join with a specific delimiter.
Definition Option.hpp:172
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
CLI11_NODISCARD char get_delimiter() const
Get the current delimiter char.
Definition Option.hpp:133
CLI11_NODISCARD bool get_required() const
True if this is a required option.
Definition Option.hpp:118
CRTP * take_first()
Set the multi option policy to take last.
Definition Option.hpp:151
CLI11_NODISCARD bool get_ignore_case() const
The status of ignore case.
Definition Option.hpp:121
bool ignore_case_
Ignore the case when matching (option, not value)
Definition Option.hpp:63
CRTP * configurable(bool value=true)
Allow in a configuration file.
Definition Option.hpp:180
CRTP * delimiter(char value='\0')
Allow in a configuration file.
Definition Option.hpp:186
CLI11_NODISCARD MultiOptionPolicy get_multi_option_policy() const
The status of the multi option policy.
Definition Option.hpp:139
CLI11_NODISCARD bool get_configurable() const
The status of configurable.
Definition Option.hpp:127
bool configurable_
Allow this option to be given in a configuration file.
Definition Option.hpp:69
bool disable_flag_override_
Disable overriding flag values with '=value'.
Definition Option.hpp:72
bool required_
True if this is a required option.
Definition Option.hpp:60
CRTP * take_last()
Set the multi option policy to take last.
Definition Option.hpp:144
char delimiter_
Specify a delimiter character for vector arguments.
Definition Option.hpp:75
CRTP * always_capture_default(bool value=true)
Definition Option.hpp:107
std::string group_
The group membership.
Definition Option.hpp:57
CLI11_NODISCARD bool get_ignore_underscore() const
The status of ignore_underscore.
Definition Option.hpp:124
bool ignore_underscore_
Ignore underscores when matching (option, not value)
Definition Option.hpp:66
CLI11_NODISCARD bool get_disable_flag_override() const
The status of configurable.
Definition Option.hpp:130
CLI11_NODISCARD const std::string & get_group() const
Get the group of this option.
Definition Option.hpp:115
void copy_to(T *other) const
Copy the contents to another similar class (one based on OptionBase)
CRTP * required(bool value=true)
Set the option as required.
Definition Option.hpp:99
Definition Option.hpp:194
OptionDefaults * multi_option_policy(MultiOptionPolicy value=MultiOptionPolicy::Throw)
Take the last argument if given multiple times.
Definition Option.hpp:201
OptionDefaults * ignore_case(bool value=true)
Ignore the case of the option name.
Definition Option.hpp:207
OptionDefaults * ignore_underscore(bool value=true)
Ignore underscores in the option name.
Definition Option.hpp:213
OptionDefaults * delimiter(char value='\0')
set a delimiter character to split up single arguments to treat as multiple inputs
Definition Option.hpp:225
OptionDefaults * disable_flag_override(bool value=true)
Disable overriding flag values with an '=' segment.
Definition Option.hpp:219
Definition Option.hpp:231
CLI11_NODISCARD const std::string & get_option_text() const
Definition Option.hpp:605
CLI11_NODISCARD bool get_positional() const
True if the argument can be given directly.
Definition Option.hpp:583
std::string default_str_
A human readable default value, either manually set, captured, or captured by default.
Definition Option.hpp:265
bool run_callback_for_default_
Control option to run the callback to set the default.
Definition Option.hpp:334
CLI11_NODISCARD std::string get_envname() const
The environment variable associated to this value.
Definition Option.hpp:528
Option * excludes(Option *opt)
Sets excluded options.
Option * type_name(std::string typeval)
Set a custom option typestring.
Definition Option.hpp:724
std::function< std::string()> type_name_
Definition Option.hpp:273
option_state
enumeration for the option state machine
Definition Option.hpp:321
@ reduced
a subset of results has been generated
@ callback_run
the callback has been executed
@ validated
the results have been validated
@ parsing
The option is currently collecting parsed results.
option_state current_option_state_
Whether the callback has run (needed for INI parsing)
Definition Option.hpp:328
std::string option_text_
If given, replace the text that describes the option type and usage in the help text.
Definition Option.hpp:268
int type_size_min_
The minimum number of arguments an option should be expecting.
Definition Option.hpp:286
CLI11_NODISCARD bool check_fname(std::string name) const
Requires "--" to be removed from string.
Definition Option.hpp:646
std::string pname_
A positional name.
Definition Option.hpp:252
int expected_min_
The minimum number of expected values.
Definition Option.hpp:289
Option(std::string option_name, std::string option_description, callback_t callback, App *parent)
Making an option by hand is not defined, it must be made by the App class.
Definition Option.hpp:344
Option * expected(int value_min, int value_max)
Set the range of expected arguments.
Option * ignore_case(bool value=true)
std::set< Option * > needs_
A list of options that are required with this option.
Definition Option.hpp:297
Option * default_function(const std::function< std::string()> &func)
Set a capture function for the default. Mostly used by App.
Definition Option.hpp:739
CLI11_NODISCARD int get_type_size_min() const
The minimum number of arguments the option expects.
Definition Option.hpp:520
bool remove_excludes(Option *opt)
Remove needs link from an option. Returns true if the option really was in the needs list.
Option * multi_option_policy(MultiOptionPolicy value=MultiOptionPolicy::Throw)
Take the last argument if given multiple times (or another policy)
CLI11_NODISCARD bool check_sname(std::string name) const
Requires "-" to be removed from string.
Definition Option.hpp:636
bool trigger_on_result_
flag indicating that the option should trigger the validation and callback chain on each result when ...
Definition Option.hpp:338
bool flag_like_
Specify that the option should act like a flag vs regular option.
Definition Option.hpp:332
Option * add_result(std::string s)
Puts a result at the end.
std::set< Option * > excludes_
A list of options that are excluded with this option.
Definition Option.hpp:300
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_callback_run() const
See if the callback has been run already.
Definition Option.hpp:711
Option & operator=(const Option &)=delete
CLI11_NODISCARD bool get_force_callback() const
The status of force_callback.
Definition Option.hpp:403
std::vector< std::string > fnames_
a list of flag names with specified default values;
Definition Option.hpp:249
CLI11_NODISCARD std::string get_flag_value(const std::string &name, std::string input_value) const
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)
Validator * get_validator(const std::string &Validator_name="")
Get a named Validator.
Option * option_text(std::string text)
Definition Option.hpp:600
CLI11_NODISCARD bool get_run_callback_for_default() const
Get the current value of run_callback_for_default.
Definition Option.hpp:412
Option * check(std::function< std::string(const std::string &)> Validator, std::string Validator_description="", std::string Validator_name="")
Adds a Validator. Takes a const string& and returns an error message (empty if conversion/check is ok...
CLI11_NODISCARD std::string get_default_str() const
The default value (for help printing)
Definition Option.hpp:537
CLI11_NODISCARD bool nonpositional() const
True if option has at least one non-positional name.
Definition Option.hpp:586
CLI11_NODISCARD int get_items_expected_min() const
The total min number of expected string values to be used.
Definition Option.hpp:572
Option * expected(int value)
Set the number of expected arguments.
CLI11_NODISCARD std::string get_type_name() const
Get the full typename for this option.
CLI11_NODISCARD bool check_lname(std::string name) const
Requires "--" to be removed from string.
Definition Option.hpp:641
Option(const Option &)=delete
CLI11_NODISCARD const results_t & results() const
Get the current complete results set.
Definition Option.hpp:667
Option * disable_flag_override(bool value=true)
Disable flag overrides values, e.g. –flag=is not allowed.
Definition Option.hpp:508
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:575
std::vector< std::string > snames_
A list of the short names (-a) without the leading dashes.
Definition Option.hpp:239
results_t proc_results_
results after reduction
Definition Option.hpp:319
CLI11_NODISCARD std::size_t count() const
Count the total number of times an option was passed.
Definition Option.hpp:357
Option * run_callback_for_default(bool value=true)
Definition Option.hpp:407
Option * type_size(int option_type_size_min, int option_type_size_max)
Set a custom option type size range.
void inject_separator(bool value=true)
Set the value of the separator injection flag.
Definition Option.hpp:736
Option * allow_extra_args(bool value=true)
Definition Option.hpp:383
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:390
CLI11_NODISCARD callback_t get_callback() const
Get the callback function.
Definition Option.hpp:540
CLI11_NODISCARD bool get_inject_separator() const
Return the inject_separator flag.
Definition Option.hpp:525
Option * type_size(int option_type_size)
Set a custom option size.
CLI11_NODISCARD results_t reduced_results() const
Get a copy of the results.
App * parent_
link back up to the parent App for fallthrough
Definition Option.hpp:307
CLI11_NODISCARD bool get_trigger_on_parse() const
The status of trigger on parse.
Definition Option.hpp:395
CLI11_NODISCARD const std::vector< std::string > & get_lnames() const
Get the long names.
Definition Option.hpp:543
CLI11_NODISCARD bool check_name(const std::string &name) const
Check a name. Requires "-" or "--" for short / long, supports positional name.
int expected_max_
The maximum number of expected values.
Definition Option.hpp:291
CLI11_NODISCARD std::set< Option * > get_excludes() const
The set of options excluded.
Definition Option.hpp:534
Option * transform(const std::function< std::string(std::string)> &func, std::string transform_description="", std::string transform_name="")
Adds a Validator-like function that can change result.
Option * excludes(std::string opt_name)
Can find a string if needed.
Definition Option.hpp:469
CLI11_NODISCARD int get_items_expected() const
The total min number of expected string values to be used.
Definition Option.hpp:580
CLI11_NODISCARD std::set< Option * > get_needs() const
The set of options needed.
Definition Option.hpp:531
std::string description_
The description for help strings.
Definition Option.hpp:262
CLI11_NODISCARD const std::vector< std::string > & get_snames() const
Get the short names.
Definition Option.hpp:546
CLI11_NODISCARD int get_type_size_max() const
The maximum number of arguments the option expects.
Definition Option.hpp:522
bool inject_separator_
flag indicating a separator needs to be injected after each argument call
Definition Option.hpp:336
bool remove_needs(Option *opt)
Remove needs link from an option. Returns true if the option really was in the needs list.
CLI11_NODISCARD const std::string & get_description() const
Get the description.
Definition Option.hpp:592
void run_callback()
Process the callback.
CLI11_NODISCARD const std::string & get_single_name() const
Get a single name for the option, first of lname, pname, sname, envname.
Definition Option.hpp:551
CLI11_NODISCARD int get_expected() const
The number of times the option expects to be included.
Definition Option.hpp:564
Option * transform(Validator Validator, const std::string &Validator_name="")
Adds a transforming Validator with a built in type name.
callback_t callback_
Options store a callback to do all the work.
Definition Option.hpp:310
CLI11_NODISCARD bool empty() const
True if the option was not passed.
Definition Option.hpp:360
CLI11_NODISCARD int get_expected_min() const
The number of times the option expects to be included.
Definition Option.hpp:567
void clear()
Clear the parsed results (mostly for testing)
Definition Option.hpp:366
CLI11_NODISCARD int get_expected_max() const
The max number of times the option expects to be included.
Definition Option.hpp:569
Option * add_result(std::vector< std::string > s)
Puts a result at the end.
CLI11_NODISCARD const std::string & matching_name(const Option &other) const
If options share any of the same names, find it.
Option * capture_default_str()
Capture the default value from the original value (if it can be captured)
Definition Option.hpp:745
void results(T &output) const
Get the results as a specified type.
Definition Option.hpp:673
Option * default_str(std::string val)
Set the default value string representation (does not change the contained value)
Definition Option.hpp:753
CLI11_NODISCARD int get_type_size() const
The number of arguments the option expects.
Definition Option.hpp:517
std::string envname_
If given, check the environment for this option.
Definition Option.hpp:255
std::function< std::string()> default_function_
Run this function to capture a default (ignore if empty)
Definition Option.hpp:276
CLI11_NODISCARD bool get_allow_extra_args() const
Get the current value of allow extra args.
Definition Option.hpp:388
Option * ignore_underscore(bool value=true)
std::vector< std::pair< std::string, std::string > > default_flag_values_
Definition Option.hpp:246
std::vector< Validator > validators_
A list of Validators to run on each value parsed.
Definition Option.hpp:294
Option * envname(std::string name)
Sets environment variable to read if no option given.
Definition Option.hpp:487
Option * type_name_fn(std::function< std::string()> typefun)
Set the type function to run when displayed on this option.
Definition Option.hpp:718
Option * default_val(const X &val)
Definition Option.hpp:760
Option * add_result(std::string s, int &results_added)
Puts a result at the end and get a count of the number of arguments actually added.
Option * needs(Option *opt)
Sets required options.
Definition Option.hpp:440
int type_size_max_
Definition Option.hpp:284
Option * needs(A opt, B opt1, ARG... args)
Any number supported, any mix of string and Opt.
Definition Option.hpp:457
bool allow_extra_args_
Specify that extra args beyond type_size_max should be allowed.
Definition Option.hpp:330
Option * description(std::string option_description)
Set the description.
Definition Option.hpp:595
std::vector< std::string > lnames_
A list of the long names (--long) without the leading dashes.
Definition Option.hpp:242
Option * force_callback(bool value=true)
Set the value of force_callback.
Definition Option.hpp:398
Validator * get_validator(int index)
Get a Validator by index NOTE: this may not be the order of definition.
bool operator==(const Option &other) const
If options share any of the same names, they are equal (not counting positional)
Definition Option.hpp:630
Option * check(Validator validator, const std::string &validator_name="")
Adds a Validator with a built in type name.
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...
Option * needs(std::string opt_name)
Can find a string if needed.
Definition Option.hpp:448
CLI11_NODISCARD const std::vector< std::string > & get_fnames() const
Get the flag names with specified default values.
Definition Option.hpp:549
CLI11_NODISCARD bool has_description() const
True if option has description.
Definition Option.hpp:589
results_t results_
complete Results of parsing
Definition Option.hpp:317
CLI11_NODISCARD T as() const
Return the results as the specified type.
Definition Option.hpp:704
Option * excludes(A opt, B opt1, ARG... args)
Any number supported, any mix of string and Opt.
Definition Option.hpp:478
Some validators that are provided.
Definition Validators.hpp:55
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:312
CLI11_INLINE std::tuple< std::vector< std::string >, std::vector< std::string >, std::string > get_names(const std::vector< std::string > &input)
Get a vector of short names, one of long names, and a single name.
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
constexpr int expected_max_vector_size
Definition StringTools.hpp:47
bool valid_alias_name_string(const std::string &str)
Verify an app name.
Definition StringTools.hpp:164
CLI11_INLINE std::vector< std::string > split_names(std::string current)
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.
std::unique_ptr< Option > Option_p
Definition Option.hpp:38
std::vector< std::string > results_t
Definition Option.hpp:31
MultiOptionPolicy
Enumeration of the multiOption Policy selection.
Definition Option.hpp:40
@ TakeAll
just get all the passed argument regardless
@ TakeFirst
take only the first Expected number of arguments
@ Reverse
take only the last Expected number of arguments in reverse order
@ Throw
Throw an error if any extra arguments were given.
@ TakeLast
take only the last Expected number of arguments
@ Sum
sum all the arguments together if numerical or concatenate directly without delimiter
@ Join
merge all the arguments together into a single string via the delimiter character default(' ')
std::function< bool(const results_t &)> callback_t
callback function definition
Definition Option.hpp:33