27#include "ConfigFwd.hpp"
29#include "FormatterFwd.hpp"
33#include "StringTools.hpp"
34#include "TypeTools.hpp"
40#define CLI11_PARSE(app, ...) \
42 (app).parse(__VA_ARGS__); \
43 } catch(const CLI::ParseError &e) { \
44 return (app).exit(e); \
49enum class Classifier : std::uint8_t {
61namespace FailureMessage {
63CLI11_INLINE std::string simple(
const App *app,
const Error &e);
66CLI11_INLINE std::string help(
const App *app,
const Error &e);
71enum class config_extras_mode : std::uint8_t { error = 0, ignore, ignore_all, capture };
75using App_p = std::shared_ptr<App>;
80template <typename T, enable_if_t<!std::is_integral<T>::value || (
sizeof(T) <= 1U), detail::enabler> = detail::dummy>
81Option *default_flag_modifiers(Option *opt) {
82 return opt->always_capture_default();
86template <typename T, enable_if_t<std::is_integral<T>::value && (
sizeof(T) > 1U), detail::enabler> = detail::dummy>
87Option *default_flag_modifiers(Option *opt) {
194 using missing_t = std::vector<std::pair<detail::Classifier, std::string>>;
253 enum class startup_mode : std::uint8_t { stable, enabled, disabled };
315 std::vector<std::string> normalized_argv_{};
318 std::vector<char *> normalized_argv_view_{};
322 App(std::string app_description, std::string app_name,
App *parent);
329 explicit App(std::string app_description =
"", std::string app_name =
"")
330 :
App(app_description, app_name, nullptr) {
331 set_help_flag(
"-h,--help",
"Print this help message and exit");
334 App(
const App &) =
delete;
335 App &operator=(
const App &) =
delete;
380 App *
name(std::string app_name =
"");
437 (
default_startup == startup_mode::disabled) ? startup_mode::disabled : startup_mode::stable;
514 formatter_ = std::make_shared<FormatterLambda>(fmt);
549 callback_t option_callback,
550 std::string option_description =
"",
551 bool defaulted =
false,
552 std::function<std::string()> func = {});
555 template <
typename AssignTo,
556 typename ConvertTo = AssignTo,
557 enable_if_t<!std::is_const<ConvertTo>::value, detail::enabler> = detail::dummy>
560 std::string option_description =
"") {
562 auto fun = [&variable](
const CLI::results_t &res) {
563 return detail::lexical_conversion<AssignTo, ConvertTo>(res, variable);
566 Option *opt =
add_option(option_name, fun, option_description,
false, [&variable]() {
567 return CLI::detail::checked_to_string<AssignTo, ConvertTo>(variable);
569 opt->
type_name(detail::type_name<ConvertTo>());
574 opt->
type_size(detail::type_count_min<ConvertTo>::value, (std::max)(Tcount, XCcount));
575 opt->
expected(detail::expected_count<ConvertTo>::value);
581 template <typename AssignTo, enable_if_t<!std::is_const<AssignTo>::value, detail::enabler> = detail::dummy>
584 std::string option_description =
"") {
586 auto fun = [&variable](
const CLI::results_t &res) {
587 return detail::lexical_conversion<AssignTo, AssignTo>(res, variable);
590 Option *opt =
add_option(option_name, fun, option_description,
false, []() {
return std::string{}; });
591 opt->
type_name(detail::type_name<AssignTo>());
593 opt->
expected(detail::expected_count<AssignTo>::value);
599 template <
typename ArgType>
601 const std::function<
void(
const ArgType &)> &func,
602 std::string option_description =
"") {
604 auto fun = [func](
const CLI::results_t &res) {
606 bool result = detail::lexical_conversion<ArgType, ArgType>(res, variable);
613 Option *opt =
add_option(option_name, std::move(fun), option_description,
false);
614 opt->
type_name(detail::type_name<ArgType>());
616 opt->
expected(detail::expected_count<ArgType>::value);
622 return add_option(option_name, CLI::callback_t{}, std::string{},
false);
626 template <
typename T,
627 enable_if_t<std::is_const<T>::value && std::is_constructible<std::string, T>::value, detail::enabler> =
630 return add_option(option_name, CLI::callback_t(), option_description,
false);
634 Option *
set_help_flag(std::string flag_name =
"",
const std::string &help_description =
"");
641 const std::string &versionString =
"",
642 const std::string &version_help =
"Display program version information and exit");
646 std::function<std::string()> vfunc,
647 const std::string &version_help =
"Display program version information and exit");
651 Option *_add_flag_internal(std::string flag_name, CLI::callback_t fun, std::string flag_description);
655 Option *
add_flag(std::string flag_name) {
return _add_flag_internal(flag_name, CLI::callback_t(), std::string{}); }
660 template <
typename T,
661 enable_if_t<std::is_const<T>::value && std::is_constructible<std::string, T>::value, detail::enabler> =
664 return _add_flag_internal(flag_name, CLI::callback_t(), flag_description);
669 template <
typename T,
670 enable_if_t<!detail::is_mutable_container<T>::value && !std::is_const<T>::value &&
671 !std::is_constructible<std::function<void(
int)>, T>::value,
672 detail::enabler> = detail::dummy>
675 std::string flag_description =
"") {
677 CLI::callback_t fun = [&flag_result](
const CLI::results_t &res) {
678 using CLI::detail::lexical_cast;
679 return lexical_cast(res[0], flag_result);
681 auto *opt = _add_flag_internal(flag_name, std::move(fun), std::move(flag_description));
682 return detail::default_flag_modifiers<T>(opt);
686 template <
typename T,
687 enable_if_t<!std::is_assignable<std::function<void(std::int64_t)> &, T>::value, detail::enabler> =
690 std::vector<T> &flag_results,
691 std::string flag_description =
"") {
692 CLI::callback_t fun = [&flag_results](
const CLI::results_t &res) {
694 for(
const auto &elem : res) {
695 using CLI::detail::lexical_cast;
696 flag_results.emplace_back();
697 retval &= lexical_cast(elem, flag_results.back());
701 return _add_flag_internal(flag_name, std::move(fun), std::move(flag_description))
708 std::function<
void(
void)> function,
709 std::string flag_description =
"");
713 std::function<
void(std::int64_t)> function,
714 std::string flag_description =
"");
719 std::function<
void(std::int64_t)> function,
720 std::string flag_description =
"") {
721 return add_flag_function(std::move(flag_name), std::move(function), std::move(flag_description));
726 Option *
set_config(std::string option_name =
"",
727 std::string default_filename =
"",
728 const std::string &help_message =
"Read an ini file",
729 bool config_required =
false);
735 template <
typename T = Option_group>
737 if(!detail::valid_alias_name_string(group_name)) {
740 auto option_group = std::make_shared<T>(std::move(group_description), group_name,
this);
741 auto *ptr = option_group.get();
743 App_p app_ptr = std::dynamic_pointer_cast<App>(option_group);
745 app_ptr->footer_ =
"";
746 app_ptr->set_help_flag();
756 App *
add_subcommand(std::string subcommand_name =
"", std::string subcommand_description =
"");
797 CLI11_NODISCARD std::size_t
count_all()
const;
878 explicit operator bool()
const {
return parsed_ > 0; }
898 void parse(
int argc,
const char *
const *argv);
899 void parse(
int argc,
const wchar_t *
const *argv);
902 template <
class CharT>
void parse_char_t(
int argc,
const CharT *
const *argv);
909 void parse(std::string commandline,
bool program_name_included =
false);
910 void parse(std::wstring commandline,
bool program_name_included =
false);
914 void parse(std::vector<std::string> &args);
917 void parse(std::vector<std::string> &&args);
919 void parse_from_stream(std::istream &input);
927 int exit(
const Error &e, std::ostream &out = std::cout, std::ostream &err = std::cerr)
const;
942 std::vector<const App *>
get_subcommands(
const std::function<
bool(
const App *)> &filter)
const;
955 CLI11_NODISCARD
bool got_subcommand(std::string subcommand_name)
const noexcept {
957 return (sub !=
nullptr) ? (sub->
parsed_ > 0) :
false;
995 throw OptionNotFound(
"nullptr passed");
998 throw OptionNotFound(
"cannot self reference in needs");
1021 usage_ = std::move(usage_string);
1025 App *
usage(std::function<std::string()> usage_function) {
1031 footer_ = std::move(footer_string);
1041 CLI11_NODISCARD std::string
config_to_str(
bool default_also =
false,
bool write_description =
false)
const {
1047 CLI11_NODISCARD std::string
help(std::string prev =
"", AppFormatMode mode = AppFormatMode::Normal)
const;
1050 CLI11_NODISCARD std::string
version()
const;
1064#if CLI11_USE_STATIC_RTTI == 0
1081 std::vector<const Option *>
get_options(
const std::function<
bool(
const Option *)> filter = {})
const;
1084 std::vector<Option *>
get_options(
const std::function<
bool(Option *)> filter = {});
1090 CLI11_NODISCARD
const Option *
get_option_no_throw(std::string option_name)
const noexcept;
1095 if(opt ==
nullptr) {
1104 if(opt ==
nullptr) {
1239 CLI11_NODISCARD std::string
get_display_name(
bool with_aliases =
false)
const;
1243 CLI11_NODISCARD
bool check_name(std::string name_to_check)
const;
1246 enum class NameMatch : std::uint8_t { none = 0, exact = 1, prefix = 2 };
1254 CLI11_NODISCARD std::vector<std::string>
get_groups()
const;
1260 CLI11_NODISCARD std::vector<std::string>
remaining(
bool recurse =
false)
const;
1266 CLI11_NODISCARD std::size_t
remaining_size(
bool recurse =
false)
const;
1283 void run_callback(
bool final_mode =
false,
bool suppress_final_callback =
false);
1286 CLI11_NODISCARD
bool _valid_subcommand(
const std::string ¤t,
bool ignore_used =
true)
const;
1289 CLI11_NODISCARD detail::Classifier
_recognize(
const std::string ¤t,
1290 bool ignore_used_subcommands =
true)
const;
1328 void _parse(std::vector<std::string> &args);
1331 void _parse(std::vector<std::string> &&args);
1350 bool _parse_single(std::vector<std::string> &args,
bool &positional_only);
1365 CLI11_NODISCARD
App *
1366 _find_subcommand(
const std::string &subc_name,
bool ignore_disabled,
bool ignore_used)
const noexcept;
1377 bool _parse_arg(std::vector<std::string> &args, detail::Classifier current_type,
bool local_processing_only);
1389 void _move_to_missing(detail::Classifier val_type,
const std::string &val);
1399 Option_group(std::string group_description, std::string group_name,
App *parent)
1400 :
App(std::move(group_description),
"", parent) {
1403 if(group_name.empty() || group_name.front() ==
'+') {
1429 subc->get_parent()->remove_subcommand(subcom);
1436CLI11_INLINE
void TriggerOn(App *trigger_app, App *app_to_enable);
1439CLI11_INLINE
void TriggerOn(App *trigger_app, std::vector<App *> apps_to_enable);
1442CLI11_INLINE
void TriggerOff(App *trigger_app, App *app_to_enable);
1445CLI11_INLINE
void TriggerOff(App *trigger_app, std::vector<App *> apps_to_enable);
1448CLI11_INLINE
void deprecate_option(Option *opt,
const std::string &replacement =
"");
1451inline void deprecate_option(App *app,
const std::string &option_name,
const std::string &replacement =
"") {
1452 auto *opt = app->get_option(option_name);
1453 deprecate_option(opt, replacement);
1457inline void deprecate_option(App &app,
const std::string &option_name,
const std::string &replacement =
"") {
1458 auto *opt = app.get_option(option_name);
1459 deprecate_option(opt, replacement);
1463CLI11_INLINE
void retire_option(App *app, Option *opt);
1466CLI11_INLINE
void retire_option(App &app, Option *opt);
1469CLI11_INLINE
void retire_option(App *app,
const std::string &option_name);
1472CLI11_INLINE
void retire_option(App &app,
const std::string &option_name);
1480 template <
typename... Args>
static decltype(
auto)
parse_arg(
App *app, Args &&...args) {
1481 return app->
_parse_arg(std::forward<Args>(args)...);
1485 template <
typename... Args>
static decltype(
auto)
parse_subcommand(
App *app, Args &&...args) {
1490 template <
typename... Args>
1493 return app->
_parse_arg(std::forward<Args>(args)...);
1497 template <
typename... Args>
1511#ifndef CLI11_COMPILE
1512#include "impl/App_inl.hpp"
Creates a command line program, with very few defaults.
Definition App.hpp:98
CLI11_NODISCARD Option * get_option_no_throw(std::string option_name) noexcept
Get an option by name (noexcept non-const version)
Definition App_inl.hpp:853
bool subcommand_fallthrough_
Allow subcommands to fallthrough, so that parent commands can trigger other subcommands after subcomm...
Definition App.hpp:240
int exit(const Error &e, std::ostream &out=std::cout, std::ostream &err=std::cerr) const
Print a nice error message and return the exit code.
Definition App_inl.hpp:683
CLI11_NODISCARD std::string help(std::string prev="", AppFormatMode mode=AppFormatMode::Normal) const
Definition App_inl.hpp:779
CLI11_NODISCARD std::size_t remaining_size(bool recurse=false) const
This returns the number of remaining options, minus the – separator.
Definition App_inl.hpp:993
const Option * operator[](const std::string &option_name) const
Shortcut bracket operator for getting a pointer to an option.
Definition App.hpp:1111
CLI11_NODISCARD bool _has_remaining_positionals() const
Count the required remaining positional arguments.
Definition App_inl.hpp:1727
App * configurable(bool value=true)
Specify that the subcommand can be triggered by a config file.
Definition App.hpp:498
CLI11_NODISCARD bool get_allow_subcommand_prefix_matching() const
Get the status of allowing prefix matching for subcommands.
Definition App.hpp:1181
CLI11_NODISCARD detail::Classifier _recognize(const std::string ¤t, bool ignore_used_subcommands=true) const
Selects a Classifier enum based on the type of the current argument.
Definition App_inl.hpp:1106
App * immediate_callback(bool immediate=true)
Set the subcommand callback to be executed immediately on subcommand completion.
Definition App_inl.hpp:121
Option * set_help_flag(std::string flag_name="", const std::string &help_description="")
Set a help flag, replace the existing one if present.
Definition App_inl.hpp:258
App * _get_fallthrough_parent()
Get the appropriate parent to fallthrough to which is the first one that has a name or the main app.
Definition App_inl.hpp:2203
CLI11_NODISCARD std::string config_to_str(bool default_also=false, bool write_description=false) const
Definition App.hpp:1041
bool allow_non_standard_options_
indicator that the subcommand should allow non-standard option arguments, such as -single_dash_flag
Definition App.hpp:272
App * usage(std::function< std::string()> usage_function)
Set usage.
Definition App.hpp:1025
CLI11_NODISCARD bool get_enabled_by_default() const
Get the status of disabled by default.
Definition App.hpp:1190
Option * config_ptr_
Pointer to the config option.
Definition App.hpp:306
CLI11_NODISCARD bool get_allow_non_standard_option_names() const
Get the status of allowing non standard option names.
Definition App.hpp:1178
CLI11_NODISCARD bool get_configurable() const
Check the status of the allow windows style options.
Definition App.hpp:1135
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:582
CLI11_NODISCARD std::string get_usage() const
Generate and return the usage.
Definition App.hpp:1141
CLI11_NODISCARD std::shared_ptr< FormatterBase > get_formatter() const
Access the formatter.
Definition App.hpp:1056
Option * add_option(std::string option_name)
Add option with no description or variable assignment.
Definition App.hpp:621
App * subcommand_fallthrough(bool value=true)
Set subcommand fallthrough, set to true so that subcommands on parents are recognized.
Definition App.hpp:871
App * config_formatter(std::shared_ptr< Config > fmt)
Set the config formatter.
Definition App.hpp:519
App * allow_config_extras(bool allow=true)
ignore extras in config files
Definition App.hpp:458
App * disabled_by_default(bool disable=true)
Set the subcommand to be disabled by default, so on clear(), at the start of each parse it is disable...
Definition App.hpp:421
void _move_to_missing(detail::Classifier val_type, const std::string &val)
Helper function to place extra values in the most appropriate position.
Definition App_inl.hpp:2265
std::size_t require_option_min_
Minimum required options (not inheritable!)
Definition App.hpp:287
NameMatch
enumeration of matching possibilities
Definition App.hpp:1246
App * silent(bool silence=true)
silence the subcommand from showing up in the processed list
Definition App.hpp:404
App * clear_aliases()
clear all the aliases of the current App
Definition App.hpp:1233
CLI11_NODISCARD bool get_ignore_underscore() const
Check the status of ignore_underscore.
Definition App.hpp:1120
App * ignore_underscore(bool value=true)
Ignore underscore. Subcommands inherit value.
Definition App_inl.hpp:147
App * allow_extras(bool allow=true)
Remove the error when extras are left over on the command line.
Definition App.hpp:386
App * fallthrough(bool value=true)
Definition App.hpp:865
std::size_t require_subcommand_max_
Max number of subcommands allowed (parsing stops after this number). 0 is unlimited INHERITABLE.
Definition App.hpp:284
Option * get_config_ptr()
Get a pointer to the config option.
Definition App.hpp:1209
std::vector< App_p > subcommands_
Storage for subcommand list.
Definition App.hpp:227
CLI11_NODISCARD std::vector< std::string > remaining(bool recurse=false) const
This returns the missing options from the current subcommand.
Definition App_inl.hpp:961
CLI11_NODISCARD bool get_allow_extras() const
Get the status of allow extras.
Definition App.hpp:1166
CLI11_NODISCARD std::vector< std::string > remaining_for_passthrough(bool recurse=false) const
This returns the missing options in a form ready for processing by another command line program.
Definition App_inl.hpp:987
std::uint32_t parsed_
Counts the number of times this command/subcommand was parsed.
Definition App.hpp:278
CLI11_NODISCARD App * get_option_group(std::string group_name) const
Check to see if an option group is part of this App.
Definition App_inl.hpp:535
App * require_subcommand()
The argumentless form of require subcommand requires 1 or more subcommands.
Definition App.hpp:806
Option * get_option(std::string option_name)
Get an option by name (non-const version)
Definition App.hpp:1102
std::string usage_
Usage to put after program/subcommand description in the help output INHERITABLE.
Definition App.hpp:164
OptionDefaults option_defaults_
The default values for options, customizable and changeable INHERITABLE.
Definition App.hpp:154
void _process_help_flags(bool trigger_help=false, bool trigger_all_help=false) const
Definition App_inl.hpp:1245
CLI11_NODISCARD const Option * get_version_ptr() const
Get a pointer to the version option. (const)
Definition App.hpp:1218
void _process_requirements()
Verify required options and cross requirements. Subcommands too (only if selected).
Definition App_inl.hpp:1267
CLI11_NODISCARD std::size_t count_all() const
Definition App_inl.hpp:544
CLI11_NODISCARD bool get_fallthrough() const
Check the status of fallthrough.
Definition App.hpp:1123
bool disabled_
If set to true the subcommand is disabled and cannot be used, ignored for main app.
Definition App.hpp:131
CLI11_NODISCARD bool get_prefix_command() const
Get the prefix command status.
Definition App.hpp:1163
Option * add_option(std::string option_name, AssignTo &variable, std::string option_description="")
Add option for assigning to a variable.
Definition App.hpp:558
CLI11_NODISCARD std::size_t get_require_subcommand_max() const
Get the required max subcommand value.
Definition App.hpp:1154
Option * set_version_flag(std::string flag_name="", const std::string &versionString="", const std::string &version_help="Display program version information and exit")
Set a version flag and version display string, replace the existing one if present.
Definition App_inl.hpp:291
bool required_
If set to true the subcommand is required to be processed and used, ignored for main app.
Definition App.hpp:128
bool remove_needs(Option *opt)
Removes an option from the needs list of this subcommand.
Definition App_inl.hpp:761
const Option * operator[](const char *option_name) const
Shortcut bracket operator for getting a pointer to an option.
Definition App.hpp:1114
CLI11_NODISCARD bool get_immediate_callback() const
Get the status of disabled.
Definition App.hpp:1184
Option * get_help_ptr()
Get a pointer to the help flag.
Definition App.hpp:1200
App * require_subcommand(int value)
Definition App.hpp:815
void _configure()
Definition App_inl.hpp:1042
CLI11_NODISCARD std::size_t _count_remaining_positionals(bool required_only=false) const
Count the required remaining positional arguments.
Definition App_inl.hpp:1715
Option * add_flag_function(std::string flag_name, std::function< void(std::int64_t)> function, std::string flag_description="")
Add option for callback with an integer value.
Definition App_inl.hpp:367
OptionDefaults * option_defaults()
Get the OptionDefault object, to set option defaults.
Definition App.hpp:528
void parse(int argc, const char *const *argv)
Definition App_inl.hpp:573
void _process_config_file()
Read and process a configuration file (main app only)
Definition App_inl.hpp:1163
std::string footer_
Footer to put after all options in the help output INHERITABLE.
Definition App.hpp:170
void increment_parsed()
Internal function to recursively increment the parsed counter on the current app as well unnamed subc...
Definition App_inl.hpp:1447
config_extras_mode allow_config_extras_
Definition App.hpp:119
CLI11_NODISCARD bool check_name(std::string name_to_check) const
Definition App_inl.hpp:905
CLI11_NODISCARD std::string get_footer() const
Generate and return the footer.
Definition App.hpp:1146
App * required(bool require=true)
Remove the error when extras are left over on the command line.
Definition App.hpp:392
Option * version_ptr_
A pointer to a version flag if there is one.
Definition App.hpp:182
CLI11_NODISCARD const Option * get_help_all_ptr() const
Get a pointer to the help all flag. (const)
Definition App.hpp:1206
bool remove_subcommand(App *subcom)
Removes a subcommand from the App. Takes a subcommand pointer. Returns true if found and removed.
Definition App_inl.hpp:465
App * parent_
A pointer to the parent if this is a subcommand.
Definition App.hpp:293
std::set< Option * > exclude_options_
Definition App.hpp:212
void _trigger_pre_parse(std::size_t remaining_args)
Trigger the pre_parse callback if needed.
Definition App_inl.hpp:2185
App * group(std::string group_name)
Changes the group membership.
Definition App.hpp:800
CLI::App_p get_subcommand_ptr(App *subcom) const
Check to see if a subcommand is part of this command and get a shared_ptr to it.
Definition App_inl.hpp:510
std::function< std::string()> footer_callback_
This is a function that generates a footer to put after all other options in help output.
Definition App.hpp:173
std::function< void()> parse_complete_callback_
This is a function that runs when parsing has finished.
Definition App.hpp:144
CLI11_NODISCARD bool get_subcommand_fallthrough() const
Check the status of subcommand fallthrough.
Definition App.hpp:1126
virtual void pre_callback()
Definition App.hpp:887
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:736
App * get_parent()
Get the parent of this subcommand (or nullptr if main app)
Definition App.hpp:1221
Option * add_flag(std::string flag_name)
Add a flag with no description or variable assignment.
Definition App.hpp:655
void _validate() const
Definition App_inl.hpp:1007
std::string name_
Subcommand name or program name (from parser if name is empty)
Definition App.hpp:109
std::vector< App * > parsed_subcommands_
This is a list of the subcommands collected, in order.
Definition App.hpp:205
App(std::string app_description="", std::string app_name="")
Create a new program. Pass in the same arguments as main(), along with a help string.
Definition App.hpp:329
CLI11_NODISCARD const Option * get_help_ptr() const
Get a pointer to the help flag. (const)
Definition App.hpp:1203
bool ignore_underscore_
If true, the program should ignore underscores INHERITABLE.
Definition App.hpp:233
App * allow_windows_style_options(bool value=true)
Definition App.hpp:486
missing_t missing_
Definition App.hpp:199
CLI11_NODISCARD bool get_validate_positionals() const
Get the status of validating positionals.
Definition App.hpp:1192
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:600
void run_callback(bool final_mode=false, bool suppress_final_callback=false)
Internal function to run (App) callback, bottom up.
Definition App_inl.hpp:1062
bool allow_prefix_matching_
indicator to allow subcommands to match with prefix matching
Definition App.hpp:275
std::size_t require_subcommand_min_
Minimum required subcommands (not inheritable!)
Definition App.hpp:281
App * usage(std::string usage_string)
Set usage.
Definition App.hpp:1020
CLI11_NODISCARD NameMatch check_name_detail(std::string name_to_check) const
Definition App_inl.hpp:910
App * allow_subcommand_prefix_matching(bool allowed=true)
allow prefix matching for subcommands
Definition App.hpp:416
void _process_env()
Get envname options if not yet passed. Runs on all subcommands.
Definition App_inl.hpp:1199
std::function< std::string(const App *, const Error &e)> failure_message_
The error message printing function INHERITABLE.
Definition App.hpp:188
void _parse_stream(std::istream &input)
Internal function to parse a stream.
Definition App_inl.hpp:1499
CLI11_NODISCARD std::string get_display_name(bool with_aliases=false) const
Get a display name for an app.
Definition App_inl.hpp:889
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:922
bool has_automatic_name_
If set to true the name was automatically generated from the command line vs a user set name.
Definition App.hpp:125
CLI11_NODISCARD const std::string & _compare_subcommand_names(const App &subcom, const App &base) const
Helper function to run through all possible comparisons of subcommand names to check there is no over...
Definition App_inl.hpp:2214
void clear()
Reset the parsed data.
Definition App_inl.hpp:558
CLI11_NODISCARD std::size_t get_require_option_max() const
Get the required max option value.
Definition App.hpp:1160
App * enabled_by_default(bool enable=true)
Definition App.hpp:432
App * footer(std::string footer_string)
Set footer.
Definition App.hpp:1030
App * get_subcommand(const App *subcom) const
Definition App_inl.hpp:481
App * require_option(int value)
Definition App.hpp:844
CLI11_NODISCARD std::string version() const
Displays a version string.
Definition App_inl.hpp:793
virtual ~App()=default
virtual destructor
CLI11_NODISCARD App * get_subcommand_no_throw(std::string subcom) const noexcept
Definition App_inl.hpp:497
CLI11_NODISCARD std::size_t count(std::string option_name) const
Counts the number of times the given option was passed.
Definition App.hpp:934
bool _add_flag_like_result(Option *op, const ConfigItem &item, const std::vector< std::string > &inputs)
store the results for a flag like option
Definition App_inl.hpp:1518
std::vector< Option_p > options_
The list of options, stored locally.
Definition App.hpp:157
Option * help_all_ptr_
A pointer to the help all flag if there is one INHERITABLE.
Definition App.hpp:179
bool validate_optional_arguments_
If set to true optional vector arguments are validated before assigning INHERITABLE.
Definition App.hpp:265
std::function< void()> final_callback_
This is a function that runs when all processing has completed.
Definition App.hpp:147
bool remove_option(Option *opt)
Removes an option from the App. Takes an option pointer. Returns true if found and removed.
Definition App_inl.hpp:411
App * require_option()
The argumentless form of require option requires 1 or more options be used.
Definition App.hpp:835
App(std::string app_description, std::string app_name, App *parent)
Special private constructor for subcommand.
Definition App_inl.hpp:29
std::function< std::string()> usage_callback_
This is a function that generates a usage to put after program/subcommand description in help output.
Definition App.hpp:167
App * add_subcommand(std::string subcommand_name="", std::string subcommand_description="")
Add a subcommand. Inherits INHERITABLE and OptionDefaults, and help flag.
Definition App_inl.hpp:434
App * preparse_callback(std::function< void(std::size_t)> pp_callback)
Definition App.hpp:374
Option * add_flag_callback(std::string flag_name, std::function< void(void)> function, std::string flag_description="")
Add option for callback that is triggered with a true flag and takes no arguments.
Definition App_inl.hpp:350
bool positionals_at_end_
specify that positional arguments come at the end of the argument sequence not inheritable
Definition App.hpp:251
void _process()
Process callbacks and such.
Definition App_inl.hpp:1395
bool immediate_callback_
Definition App.hpp:138
bool _parse_single(std::vector< std::string > &args, bool &positional_only)
Definition App_inl.hpp:1673
App * name(std::string app_name="")
Set a name for the app (empty will use parser to set the name)
Definition App_inl.hpp:86
void _move_option(Option *opt, App *app)
function that could be used by subclasses of App to shift options around into subcommands
Definition App_inl.hpp:2281
CLI11_NODISCARD bool get_required() const
Get the status of required.
Definition App.hpp:1169
void _process_extras()
Throw an error if anything is left over and should not be.
Definition App_inl.hpp:1418
CLI11_NODISCARD bool _valid_subcommand(const std::string ¤t, bool ignore_used=true) const
Check to see if a subcommand is valid. Give up immediately if subcommand max has been reached.
Definition App_inl.hpp:1089
Option * add_flag(std::string flag_name, T &flag_description)
Definition App.hpp:663
CLI11_NODISCARD bool get_ignore_case() const
Check the status of ignore_case.
Definition App.hpp:1117
App * parse_complete_callback(std::function< void()> pc_callback)
Definition App.hpp:367
bool configurable_
if set to true the subcommand can be triggered via configuration files INHERITABLE
Definition App.hpp:259
CLI11_NODISCARD std::vector< std::string > get_groups() const
Get the groups available directly from this option (in order)
Definition App_inl.hpp:948
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:955
App * formatter_fn(std::function< std::string(const App *, std::string, AppFormatMode)> fmt)
Set the help formatter.
Definition App.hpp:513
CLI11_NODISCARD const std::vector< std::string > & get_aliases() const
Get the aliases of the current app.
Definition App.hpp:1230
void _parse_config(const std::vector< ConfigItem > &args)
Definition App_inl.hpp:1510
App * description(std::string app_description)
Set the description of the app.
Definition App.hpp:1075
CLI11_NODISCARD std::shared_ptr< ConfigBase > get_config_formatter_base() const
Access the config formatter as a configBase pointer.
Definition App.hpp:1062
std::string description_
Description of the current program/subcommand.
Definition App.hpp:112
App * excludes(App *app)
Sets excluded subcommands for the subcommand.
Definition App.hpp:970
App * allow_non_standard_option_names(bool allowed=true)
allow non standard option names
Definition App.hpp:410
CLI11_NODISCARD bool get_positionals_at_end() const
Check the status of the allow windows style options.
Definition App.hpp:1132
Option * get_version_ptr()
Get a pointer to the version option.
Definition App.hpp:1215
CLI11_NODISCARD std::size_t get_require_option_min() const
Get the required min option value.
Definition App.hpp:1157
std::size_t require_option_max_
Max number of options allowed. 0 is unlimited (not inheritable)
Definition App.hpp:290
CLI11_NODISCARD bool get_disabled() const
Get the status of disabled.
Definition App.hpp:1172
CLI11_NODISCARD bool get_allow_windows_style_options() const
Check the status of the allow windows style options.
Definition App.hpp:1129
std::vector< std::string > aliases_
Alias names for the subcommand.
Definition App.hpp:299
CLI11_NODISCARD bool parsed() const
Check to see if this subcommand was parsed, true only if received on command line.
Definition App.hpp:525
std::set< App * > exclude_subcommands_
this is a list of subcommands that are exclusionary to this one
Definition App.hpp:208
CLI11_NODISCARD bool get_disabled_by_default() const
Get the status of disabled by default.
Definition App.hpp:1187
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:689
CLI11_NODISCARD std::size_t count() const
Definition App.hpp:793
bool _parse_positional(std::vector< std::string > &args, bool haltOnSubcommand)
Definition App_inl.hpp:1737
bool ignore_case_
If true, the program name is not case-sensitive INHERITABLE.
Definition App.hpp:230
CLI11_NODISCARD const std::string & get_group() const
Get the group of this subcommand.
Definition App.hpp:1138
bool _parse_arg(std::vector< std::string > &args, detail::Classifier current_type, bool local_processing_only)
Definition App_inl.hpp:1945
bool silent_
Definition App.hpp:269
CLI11_NODISCARD const App * get_parent() const
Get the parent of this subcommand (or nullptr if main app) (const version)
Definition App.hpp:1224
std::function< void(std::size_t)> pre_parse_callback_
This is a function that runs prior to the start of parsing.
Definition App.hpp:141
App * final_callback(std::function< void()> app_callback)
Definition App.hpp:360
std::string group_
The group membership INHERITABLE.
Definition App.hpp:296
App * alias(std::string app_name)
Set an alias for the app.
Definition App_inl.hpp:103
bool pre_parse_called_
Flag indicating that the pre_parse_callback has been triggered.
Definition App.hpp:134
void _process_callbacks()
Process callbacks. Runs on all subcommands.
Definition App_inl.hpp:1221
App * validate_positionals(bool validate=true)
Set the subcommand to validate positional arguments before assigning.
Definition App.hpp:446
Option * help_ptr_
A pointer to the help flag if there is one INHERITABLE.
Definition App.hpp:176
Option * set_config(std::string option_name="", std::string default_filename="", const std::string &help_message="Read an ini file", bool config_required=false)
Set a configuration ini file option, or clear it if no name passed.
Definition App_inl.hpp:382
App * footer(std::function< std::string()> footer_function)
Set footer.
Definition App.hpp:1035
App * ignore_case(bool value=true)
Ignore case. Subcommands inherit value.
Definition App_inl.hpp:133
App * excludes(Option *opt)
Sets excluded options for the subcommand.
Definition App.hpp:961
CLI11_NODISCARD std::shared_ptr< Config > get_config_formatter() const
Access the config formatter.
Definition App.hpp:1059
bool remove_excludes(Option *opt)
Removes an option from the excludes list of this subcommand.
Definition App_inl.hpp:741
CLI11_NODISCARD std::vector< App * > get_subcommands() const
Definition App.hpp:938
bool got_subcommand(const App *subcom) const
Check to see if given subcommand was selected.
Definition App.hpp:949
CLI11_NODISCARD config_extras_mode get_allow_config_extras() const
Get the status of allow extras.
Definition App.hpp:1197
bool _parse_subcommand(std::vector< std::string > &args)
Definition App_inl.hpp:1905
App * positionals_at_end(bool value=true)
Specify that the positional arguments are only at the end of the sequence.
Definition App.hpp:492
bool fallthrough_
Definition App.hpp:237
std::set< Option * > need_options_
Definition App.hpp:220
CLI11_NODISCARD bool get_validate_optional_arguments() const
Get the status of validating optional vector arguments.
Definition App.hpp:1194
CLI11_NODISCARD bool get_silent() const
Get the status of silence.
Definition App.hpp:1175
std::vector< const Option * > get_options(const std::function< bool(const Option *)> filter={}) const
Get the list of options (user facing function, so returns raw pointers), has optional filter function...
Definition App_inl.hpp:811
std::set< App * > need_subcommands_
Definition App.hpp:216
App * validate_optional_arguments(bool validate=true)
Set the subcommand to validate optional vector arguments before assigning.
Definition App.hpp:452
bool prefix_command_
If true, cease processing on an unrecognized option (implies allow_extras) INHERITABLE.
Definition App.hpp:122
Option * add_option(std::string option_name, callback_t option_callback, std::string option_description="", bool defaulted=false, std::function< std::string()> func={})
Definition App_inl.hpp:161
App * formatter(std::shared_ptr< FormatterBase > fmt)
Set the help formatter.
Definition App.hpp:507
std::vector< Option * > parse_order_
This is a list of pointers to options with the original parse order.
Definition App.hpp:202
Option * add_option(std::string option_name, T &option_description)
Add option with description but with no variable assignment or callback.
Definition App.hpp:629
App * prefix_command(bool is_prefix=true)
Definition App.hpp:476
CLI11_NODISCARD const std::vector< Option * > & parse_order() const
This gets a vector of pointers with the original parse order.
Definition App.hpp:1257
void _parse(std::vector< std::string > &args)
Internal parse function.
Definition App_inl.hpp:1455
bool validate_positionals_
If set to true positional options are validated before assigning INHERITABLE.
Definition App.hpp:262
bool _parse_single_config(const ConfigItem &item, std::size_t level=0)
Fill in a single config option.
Definition App_inl.hpp:1578
startup_mode default_startup
Definition App.hpp:256
App * allow_config_extras(config_extras_mode mode)
ignore extras in config files
Definition App.hpp:469
Option * add_flag(std::string flag_name, T &flag_result, std::string flag_description="")
Definition App.hpp:673
bool allow_extras_
If true, allow extra arguments (ie, don't throw an error). INHERITABLE.
Definition App.hpp:115
CLI11_NODISCARD std::string get_description() const
Get the app or subcommand description.
Definition App.hpp:1072
App * require_option(std::size_t min, std::size_t max)
Definition App.hpp:857
CLI11_NODISCARD char ** ensure_utf8(char **argv)
Convert the contents of argv to UTF-8. Only does something on Windows, does nothing elsewhere.
Definition App_inl.hpp:64
CLI11_NODISCARD App * _find_subcommand(const std::string &subc_name, bool ignore_disabled, bool ignore_used) const noexcept
Definition App_inl.hpp:1869
CLI11_NODISCARD std::size_t get_require_subcommand_min() const
Get the required min subcommand value.
Definition App.hpp:1151
CLI11_NODISCARD const Option * get_config_ptr() const
Get a pointer to the config option. (const)
Definition App.hpp:1212
CLI11_NODISCARD const std::string & get_name() const
Get the name of the current app.
Definition App.hpp:1227
App * disabled(bool disable=true)
Disable the subcommand or option group.
Definition App.hpp:398
App * callback(std::function< void()> app_callback)
Definition App.hpp:349
std::shared_ptr< FormatterBase > formatter_
This is the formatter for help printing. Default provided. INHERITABLE (same pointer)
Definition App.hpp:185
Option * set_help_all_flag(std::string help_name="", const std::string &help_description="")
Set a help all flag, replaced the existing one if present.
Definition App_inl.hpp:274
App * require_subcommand(std::size_t min, std::size_t max)
Definition App.hpp:828
CLI11_NODISCARD const Option * get_option(std::string option_name) const
Get an option by name.
Definition App.hpp:1093
bool allow_windows_style_options_
Allow '/' for options for Windows like options. Defaults to true on Windows, false otherwise....
Definition App.hpp:243
std::shared_ptr< Config > config_formatter_
This is the formatter for help printing. Default provided. INHERITABLE (same pointer)
Definition App.hpp:309
This converter works with INI/TOML files; to write INI files use ConfigINI.
Definition ConfigFwd.hpp:85
All errors derive from this one.
Definition Error.hpp:73
Thrown when an option is set to conflicting values (non-vector and multi args, for example)
Definition Error.hpp:96
Extension of App to better manage groups of options.
Definition App.hpp:1397
App * add_subcommand(App *subcom)
Add an existing subcommand to be a member of an option_group.
Definition App.hpp:1427
Option * add_option(Option *opt)
Add an existing option to the Option_group.
Definition App.hpp:1411
void add_options(Option *opt, Args... args)
Add a bunch of options to the group.
Definition App.hpp:1421
void add_options(Option *opt)
Add an existing option to the Option_group.
Definition App.hpp:1419
Definition Option.hpp:194
Definition Option.hpp:231
Option * type_size(int option_type_size)
Set a custom option size.
Definition Option_inl.hpp:467
Option * expected(int value)
Set the number of expected arguments.
Definition Option_inl.hpp:36
Option * type_name(std::string typeval)
Set a custom option typestring.
Definition Option.hpp:728
CLI11_NODISCARD std::size_t count() const
Count the total number of times an option was passed.
Definition Option.hpp:361
Option * run_callback_for_default(bool value=true)
Definition Option.hpp:411
Option * multi_option_policy(MultiOptionPolicy value=MultiOptionPolicy::Throw)
Take the last argument if given multiple times (or another policy)
Definition Option_inl.hpp:220
Option * default_str(std::string val)
Set the default value string representation (does not change the contained value)
Definition Option.hpp:757
Option * force_callback(bool value=true)
Set the value of force_callback.
Definition Option.hpp:402
Thrown when counting a nonexistent option.
Definition Error.hpp:351
Holds values to load into Options.
Definition ConfigFwd.hpp:29
This class is simply to allow tests access to App's protected functions.
Definition App.hpp:1476
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:1498
static App * get_fallthrough_parent(App *app)
Wrap the fallthrough parent function to make sure that is working correctly.
Definition App.hpp:1504
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:1491
This will only trigger for actual void type.
Definition TypeTools.hpp:504