40 #define CLI11_PARSE(app, ...) \
42 (app).parse(__VA_ARGS__); \
43 } catch(const CLI::ParseError &e) { \
44 return (app).exit(e); \
53 namespace FailureMessage {
67 using App_p = std::shared_ptr<App>;
186 using missing_t = std::vector<std::pair<detail::Classifier, std::string>>;
303 std::vector<std::string> normalized_argv_{};
307 std::vector<char *> normalized_argv_view_{};
311 App(std::string app_description, std::string app_name,
App *parent);
318 explicit App(std::string app_description =
"", std::string app_name =
"")
319 :
App(app_description, app_name, nullptr) {
320 set_help_flag(
"-h,--help",
"Print this help message and exit");
323 App(
const App &) =
delete;
327 virtual ~App() =
default;
369 App *
name(std::string app_name =
"");
498 formatter_ = std::make_shared<FormatterLambda>(fmt);
534 std::string option_description =
"",
535 bool defaulted =
false,
536 std::function<std::string()> func = {});
539 template <
typename AssignTo,
540 typename ConvertTo = AssignTo,
544 std::string option_description =
"") {
547 return detail::lexical_conversion<AssignTo, ConvertTo>(res, variable);
550 Option *opt =
add_option(option_name, fun, option_description,
false, [&variable]() {
551 return CLI::detail::checked_to_string<AssignTo, ConvertTo>(variable);
553 opt->
type_name(detail::type_name<ConvertTo>());
558 opt->
type_size(detail::type_count_min<ConvertTo>::value, (std::max)(Tcount, XCcount));
559 opt->
expected(detail::expected_count<ConvertTo>::value);
565 template <typename AssignTo, enable_if_t<!std::is_const<AssignTo>::value, detail::enabler> =
detail::dummy>
568 std::string option_description =
"") {
571 return detail::lexical_conversion<AssignTo, AssignTo>(res, variable);
574 Option *opt =
add_option(option_name, fun, option_description,
false, []() {
return std::string{}; });
575 opt->
type_name(detail::type_name<AssignTo>());
577 opt->
expected(detail::expected_count<AssignTo>::value);
583 template <
typename ArgType>
585 const std::function<
void(
const ArgType &)> &func,
586 std::string option_description =
"") {
590 bool result = detail::lexical_conversion<ArgType, ArgType>(res, variable);
597 Option *opt =
add_option(option_name, std::move(fun), option_description,
false);
598 opt->
type_name(detail::type_name<ArgType>());
600 opt->
expected(detail::expected_count<ArgType>::value);
610 template <
typename T,
618 Option *
set_help_flag(std::string flag_name =
"",
const std::string &help_description =
"");
625 const std::string &versionString =
"",
626 const std::string &version_help =
"Display program version information and exit");
630 std::function<std::string()> vfunc,
631 const std::string &version_help =
"Display program version information and exit");
635 Option *_add_flag_internal(std::string flag_name,
CLI::callback_t fun, std::string flag_description);
644 template <
typename T,
648 return _add_flag_internal(flag_name,
CLI::callback_t(), flag_description);
653 template <
typename T,
655 !std::is_constructible<std::function<void(int)>, T>::value,
659 std::string flag_description =
"") {
665 auto *opt = _add_flag_internal(flag_name, std::move(fun), std::move(flag_description));
666 return detail::default_flag_modifiers<T>(opt);
670 template <
typename T,
674 std::vector<T> &flag_results,
675 std::string flag_description =
"") {
678 for(
const auto &elem : res) {
680 flag_results.emplace_back();
685 return _add_flag_internal(flag_name, std::move(fun), std::move(flag_description))
692 std::function<
void(
void)>
function,
693 std::string flag_description =
"");
697 std::function<
void(std::int64_t)>
function,
698 std::string flag_description =
"");
703 std::function<
void(std::int64_t)>
function,
704 std::string flag_description =
"") {
705 return add_flag_function(std::move(flag_name), std::move(
function), std::move(flag_description));
710 Option *
set_config(std::string option_name =
"",
711 std::string default_filename =
"",
712 const std::string &help_message =
"Read an ini file",
713 bool config_required =
false);
719 template <
typename T = Option_group>
724 auto option_group = std::make_shared<T>(std::move(group_description), group_name,
this);
725 auto *ptr = option_group.get();
727 App_p app_ptr = std::dynamic_pointer_cast<
App>(option_group);
737 App *
add_subcommand(std::string subcommand_name =
"", std::string subcommand_description =
"");
859 explicit operator bool()
const {
return parsed_ > 0; }
879 void parse(
int argc,
const char *
const *argv);
880 void parse(
int argc,
const wchar_t *
const *argv);
883 template <
class CharT>
void parse_char_t(
int argc,
const CharT *
const *argv);
890 void parse(std::string commandline,
bool program_name_included =
false);
891 void parse(std::wstring commandline,
bool program_name_included =
false);
895 void parse(std::vector<std::string> &args);
898 void parse(std::vector<std::string> &&args);
908 int exit(
const Error &e, std::ostream &out = std::cout, std::ostream &err = std::cerr)
const;
923 std::vector<const App *>
get_subcommands(
const std::function<
bool(
const App *)> &filter)
const;
938 return (sub !=
nullptr) ? (sub->
parsed_ > 0) :
false;
1002 usage_ = std::move(usage_string);
1006 App *
usage(std::function<std::string()> usage_function) {
1012 footer_ = std::move(footer_string);
1045 #if CLI11_USE_STATIC_RTTI == 0
1062 std::vector<const Option *>
get_options(
const std::function<
bool(
const Option *)> filter = {})
const;
1065 std::vector<Option *>
get_options(
const std::function<
bool(Option *)> filter = {});
1076 if(opt ==
nullptr) {
1085 if(opt ==
nullptr) {
1252 void run_callback(
bool final_mode =
false,
bool suppress_final_callback =
false);
1259 bool ignore_used_subcommands =
true)
const;
1297 void _parse(std::vector<std::string> &args);
1300 void _parse(std::vector<std::string> &&args);
1316 bool _parse_single(std::vector<std::string> &args,
bool &positional_only);
1332 _find_subcommand(
const std::string &subc_name,
bool ignore_disabled,
bool ignore_used)
const noexcept;
1366 :
App(
std::move(group_description),
"", parent) {
1369 if(group_name.empty() || group_name.front() ==
'+') {
1395 subc->get_parent()->remove_subcommand(subcom);
1446 template <
typename... Args>
static decltype(
auto)
parse_arg(
App *app, Args &&...args) {
1447 return app->
_parse_arg(std::forward<Args>(args)...);
1451 template <
typename... Args>
static decltype(
auto)
parse_subcommand(
App *app, Args &&...args) {
1455 template <
typename... Args>
1459 return app->
_parse_arg(std::forward<Args>(args)...);
1463 template <
typename... Args>
1477 #ifndef CLI11_COMPILE
1478 #include "impl/App_inl.hpp"
CLI11_NODISCARD const Option * get_version_ptr() const
Get a pointer to the version option. (const)
Definition: App.hpp:1196
App * clear_aliases()
clear all the aliases of the current App
Definition: App.hpp:1211
CLI11_NODISCARD const Option * get_config_ptr() const
Get a pointer to the config option. (const)
Definition: App.hpp:1190
void _move_option(Option *opt, App *app)
function that could be used by subclasses of App to shift options around into subcommands ...
void failure_message(std::function< std::string(const App *, const Error &e)> function)
Provide a function to print a help message. The function gets access to the App pointer and error...
Definition: App.hpp:903
CLI11_NODISCARD std::size_t count(std::string option_name) const
Counts the number of times the given option was passed.
Definition: App.hpp:915
CLI11_NODISCARD std::string get_usage() const
Generate and return the usage.
Definition: App.hpp:1122
void run_callback(bool final_mode=false, bool suppress_final_callback=false)
Internal function to run (App) callback, bottom up.
This class is simply to allow tests access to App's protected functions.
Definition: App.hpp:1442
CLI11_NODISCARD std::size_t count() const
Count the total number of times an option was passed.
Definition: Option.hpp:361
CLI11_NODISCARD std::size_t count() const
Definition: App.hpp:774
std::size_t require_subcommand_min_
Minimum required subcommands (not inheritable!)
Definition: App.hpp:270
bool disabled_
If set to true the subcommand is disabled and cannot be used, ignored for main app.
Definition: App.hpp:123
CLI11_INLINE std::string help(const App *app, const Error &e)
Printout the full help string on error (if this fn is set, the old default for CLI11) ...
CLI11_NODISCARD const App * get_parent() const
Get the parent of this subcommand (or nullptr if main app) (const version)
Definition: App.hpp:1202
bool _parse_subcommand(std::vector< std::string > &args)
App * config_formatter(std::shared_ptr< Config > fmt)
Set the config formatter.
Definition: App.hpp:503
CLI11_NODISCARD const std::vector< std::string > & get_aliases() const
Get the aliases of the current app.
Definition: App.hpp:1208
bool has_automatic_name_
If set to true the name was automatically generated from the command line vs a user set name...
Definition: App.hpp:117
CLI11_NODISCARD bool get_required() const
Get the status of required.
Definition: App.hpp:1150
config_extras_mode
enumeration of modes of how to deal with extras in config files
Definition: App.hpp:63
void _process_help_flags(bool trigger_help=false, bool trigger_all_help=false) const
App * needs(App *app)
Definition: App.hpp:974
App * require_option()
The argumentless form of require option requires 1 or more options be used.
Definition: App.hpp:816
App * require_option(std::size_t min, std::size_t max)
Definition: App.hpp:838
CLI11_NODISCARD const std::string & _compare_subcommand_names(const App &subcom, const App &base) const
Helper function to run through all possible comparisons of subcommand names to check there is no over...
startup_mode default_startup
Definition: App.hpp:248
CLI::App_p get_subcommand_ptr(App *subcom) const
Check to see if a subcommand is part of this command and get a shared_ptr to it.
void clear()
Reset the parsed data.
Option * set_version_flag(std::string flag_name="", const std::string &versionString="", const std::string &version_help="Display program version information and exit")
Set a version flag and version display string, replace the existing one if present.
Option * add_option(std::string option_name, T &option_description)
Add option with description but with no variable assignment or callback.
Definition: App.hpp:613
Classifier
Definition: App.hpp:49
std::vector< std::string > aliases_
Alias names for the subcommand.
Definition: App.hpp:288
CLI11_NODISCARD std::vector< std::string > remaining_for_passthrough(bool recurse=false) const
This returns the missing options in a form ready for processing by another command line program...
CLI11_NODISCARD char ** ensure_utf8(char **argv)
Convert the contents of argv to UTF-8. Only does something on Windows, does nothing elsewhere...
App * parent_
A pointer to the parent if this is a subcommand.
Definition: App.hpp:282
App * silent(bool silence=true)
silence the subcommand from showing up in the processed list
Definition: App.hpp:393
bool remove_excludes(Option *opt)
Removes an option from the excludes list of this subcommand.
std::vector< App_p > subcommands_
Storage for subcommand list.
Definition: App.hpp:219
CLI11_NODISCARD std::shared_ptr< ConfigBase > get_config_formatter_base() const
Access the config formatter as a configBase pointer.
Definition: App.hpp:1043
std::string description_
Description of the current program/subcommand.
Definition: App.hpp:104
std::string footer_
Footer to put after all options in the help output INHERITABLE.
Definition: App.hpp:162
App * allow_non_standard_option_names(bool allowed=true)
allow non standard option names
Definition: App.hpp:399
App * allow_extras(bool allow=true)
Remove the error when extras are left over on the command line.
Definition: App.hpp:375
std::set< Option * > need_options_
Definition: App.hpp:212
Option * version_ptr_
A pointer to a version flag if there is one.
Definition: App.hpp:174
App(std::string app_description="", std::string app_name="")
Create a new program. Pass in the same arguments as main(), along with a help string.
Definition: App.hpp:318
Option * get_config_ptr()
Get a pointer to the config option.
Definition: App.hpp:1187
std::vector< Option_p > options_
The list of options, stored locally.
Definition: App.hpp:149
CLI11_INLINE void TriggerOff(App *trigger_app, App *app_to_enable)
Helper function to disable one option group/subcommand when another is used.
CLI11_NODISCARD bool get_ignore_case() const
Check the status of ignore_case.
Definition: App.hpp:1098
enabler
Simple empty scoped class.
Definition: TypeTools.hpp:36
std::set< Option * > exclude_options_
Definition: App.hpp:204
Option * add_option_no_stream(std::string option_name, AssignTo &variable, std::string option_description="")
Add option for assigning to a variable.
Definition: App.hpp:566
Option * add_option(std::string option_name)
Add option with no description or variable assignment.
Definition: App.hpp:605
bool _parse_single_config(const ConfigItem &item, std::size_t level=0)
Fill in a single config option.
CLI11_NODISCARD std::string help(std::string prev="", AppFormatMode mode=AppFormatMode::Normal) const
CLI11_NODISCARD std::size_t count_all() const
CLI11_NODISCARD const std::vector< Option * > & parse_order() const
This gets a vector of pointers with the original parse order.
Definition: App.hpp:1226
CLI11_INLINE void deprecate_option(Option *opt, const std::string &replacement="")
Helper function to mark an option as deprecated.
App * preparse_callback(std::function< void(std::size_t)> pp_callback)
Definition: App.hpp:363
CLI11_NODISCARD App * get_subcommand_no_throw(std::string subcom) const noexcept
std::size_t require_option_min_
Minimum required options (not inheritable!)
Definition: App.hpp:276
void _trigger_pre_parse(std::size_t remaining_args)
Trigger the pre_parse callback if needed.
CLI11_NODISCARD const Option * get_help_ptr() const
Get a pointer to the help flag. (const)
Definition: App.hpp:1181
App * validate_optional_arguments(bool validate=true)
Set the subcommand to validate optional vector arguments before assigning.
Definition: App.hpp:436
bool remove_needs(Option *opt)
Removes an option from the needs list of this subcommand.
int exit(const Error &e, std::ostream &out=std::cout, std::ostream &err=std::cerr) const
Print a nice error message and return the exit code.
Definition: Option.hpp:231
CLI11_NODISCARD bool get_validate_positionals() const
Get the status of validating positionals.
Definition: App.hpp:1170
void _process_extras()
Throw an error if anything is left over and should not be.
std::vector< Option * > parse_order_
This is a list of pointers to options with the original parse order.
Definition: App.hpp:194
CLI11_NODISCARD config_extras_mode get_allow_config_extras() const
Get the status of allow extras.
Definition: App.hpp:1175
void _process_callbacks()
Process callbacks. Runs on all subcommands.
App * ignore_case(bool value=true)
Ignore case. Subcommands inherit value.
bool _parse_positional(std::vector< std::string > &args, bool haltOnSubcommand)
void _move_to_missing(detail::Classifier val_type, const std::string &val)
Helper function to place extra values in the most appropriate position.
Extension of App to better manage groups of options.
Definition: App.hpp:1363
void _process_env()
Get envname options if not yet passed. Runs on all subcommands.
App * formatter(std::shared_ptr< FormatterBase > fmt)
Set the help formatter.
Definition: App.hpp:491
CLI11_NODISCARD Option * get_option_no_throw(std::string option_name) noexcept
Get an option by name (noexcept non-const version)
App(std::string app_description, std::string app_name, App *parent)
Special private constructor for subcommand.
Option * add_flag_callback(std::string flag_name, std::function< void(void)> function, std::string flag_description="")
Add option for callback that is triggered with a true flag and takes no arguments.
CLI11_NODISCARD bool get_disabled_by_default() const
Get the status of disabled by default.
Definition: App.hpp:1165
CLI11_NODISCARD detail::Classifier _recognize(const std::string ¤t, bool ignore_used_subcommands=true) const
Selects a Classifier enum based on the type of the current argument.
bool _parse_single(std::vector< std::string > &args, bool &positional_only)
const Option * operator[](const std::string &option_name) const
Shortcut bracket operator for getting a pointer to an option.
Definition: App.hpp:1092
ConfigBase ConfigTOML
the default Config is the TOML file format
Definition: ConfigFwd.hpp:188
App * callback(std::function< void()> app_callback)
Definition: App.hpp:338
std::function< std::string()> usage_callback_
This is a function that generates a usage to put after program/subcommand description in help output...
Definition: App.hpp:159
CLI11_NODISCARD std::vector< std::string > remaining(bool recurse=false) const
This returns the missing options from the current subcommand.
std::function< void()> parse_complete_callback_
This is a function that runs when parsing has finished.
Definition: App.hpp:136
CLI11_NODISCARD std::size_t get_require_subcommand_min() const
Get the required min subcommand value.
Definition: App.hpp:1132
T * add_option_group(std::string group_name, std::string group_description="")
creates an option group as part of the given app
Definition: App.hpp:720
bool lexical_cast(const std::string &input, T &output)
Integer conversion.
Definition: TypeTools.hpp:1112
constexpr enabler dummy
An instance to use in EnableIf.
Definition: TypeTools.hpp:39
Option * add_flag(std::string flag_name)
Add a flag with no description or variable assignment.
Definition: App.hpp:639
static auto parse_arg(App *app, Args &&...args) -> typename std::result_of< decltype(&App::_parse_arg)(App, Args...)>::type
Wrap _parse_short, perfectly forward arguments and return.
Definition: App.hpp:1457
bool remove_subcommand(App *subcom)
Removes a subcommand from the App. Takes a subcommand pointer. Returns true if found and removed...
CLI11_INLINE void TriggerOn(App *trigger_app, App *app_to_enable)
Helper function to enable one option group/subcommand when another is used.
std::vector< const Option * > get_options(const std::function< bool(const Option *)> filter={}) const
Get the list of options (user facing function, so returns raw pointers), has optional filter function...
bool allow_non_standard_options_
indicator that the subcommand should allow non-standard option arguments, such as -single_dash_flag ...
Definition: App.hpp:264
App * get_parent()
Get the parent of this subcommand (or nullptr if main app)
Definition: App.hpp:1199
Option * help_ptr_
A pointer to the help flag if there is one INHERITABLE.
Definition: App.hpp:168
Option * add_flag(std::string flag_name, T &flag_description)
Definition: App.hpp:647
bool allow_extras_
If true, allow extra arguments (ie, don't throw an error). INHERITABLE.
Definition: App.hpp:107
Option * multi_option_policy(MultiOptionPolicy value=MultiOptionPolicy::Throw)
Take the last argument if given multiple times (or another policy)
Option * get_option(std::string option_name)
Get an option by name (non-const version)
Definition: App.hpp:1083
std::string group_
The group membership INHERITABLE.
Definition: App.hpp:285
CLI11_NODISCARD bool get_allow_windows_style_options() const
Check the status of the allow windows style options.
Definition: App.hpp:1110
const Option * operator[](const char *option_name) const
Shortcut bracket operator for getting a pointer to an option.
Definition: App.hpp:1095
bool pre_parse_called_
Flag indicating that the pre_parse_callback has been triggered.
Definition: App.hpp:126
App * enabled_by_default(bool enable=true)
Definition: App.hpp:416
App * disabled(bool disable=true)
Disable the subcommand or option group.
Definition: App.hpp:387
CLI11_NODISCARD bool get_enabled_by_default() const
Get the status of disabled by default.
Definition: App.hpp:1168
bool validate_positionals_
If set to true positional options are validated before assigning INHERITABLE.
Definition: App.hpp:254
Option * add_flag_function(std::string flag_name, std::function< void(std::int64_t)> function, std::string flag_description="")
Add option for callback with an integer value.
CLI11_INLINE std::string simple(const App *app, const Error &e)
Printout a clean, simple message on error (the default in CLI11 1.5+)
OptionDefaults * option_defaults()
Get the OptionDefault object, to set option defaults.
Definition: App.hpp:512
#define CLI11_INLINE
Definition: Macros.hpp:150
App * allow_config_extras(config_extras_mode mode)
ignore extras in config files
Definition: App.hpp:453
CLI11_NODISCARD bool get_allow_extras() const
Get the status of allow extras.
Definition: App.hpp:1147
Option * help_all_ptr_
A pointer to the help all flag if there is one INHERITABLE.
Definition: App.hpp:171
Option * get_version_ptr()
Get a pointer to the version option.
Definition: App.hpp:1193
App * get_subcommand(const App *subcom) const
CLI11_NODISCARD bool parsed() const
Check to see if this subcommand was parsed, true only if received on command line.
Definition: App.hpp:509
CLI11_NODISCARD std::size_t remaining_size(bool recurse=false) const
This returns the number of remaining options, minus the – separator.
void _parse(std::vector< std::string > &args)
Internal parse function.
bool allow_windows_style_options_
Allow '/' for options for Windows like options. Defaults to true on Windows, false otherwise...
Definition: App.hpp:235
App * configurable(bool value=true)
Specify that the subcommand can be triggered by a config file.
Definition: App.hpp:482
bool fallthrough_
Definition: App.hpp:229
CLI11_NODISCARD bool get_disabled() const
Get the status of disabled.
Definition: App.hpp:1153
std::vector< std::string > results_t
Definition: Option.hpp:31
App * description(std::string app_description)
Set the description of the app.
Definition: App.hpp:1056
Option * add_option(std::string option_name, AssignTo &variable, std::string option_description="")
Add option for assigning to a variable.
Definition: App.hpp:542
std::function< std::string()> footer_callback_
This is a function that generates a footer to put after all other options in help output...
Definition: App.hpp:165
static auto parse_subcommand(App *app, Args &&...args) -> typename std::result_of< decltype(&App::_parse_subcommand)(App, Args...)>::type
Wrap _parse_subcommand, perfectly forward arguments and return.
Definition: App.hpp:1464
CLI11_NODISCARD const Option * get_help_all_ptr() const
Get a pointer to the help all flag. (const)
Definition: App.hpp:1184
Option * run_callback_for_default(bool value=true)
Definition: Option.hpp:411
App * require_subcommand()
The argumentless form of require subcommand requires 1 or more subcommands.
Definition: App.hpp:787
CLI11_NODISCARD std::string version() const
Displays a version string.
App * add_subcommand(App *subcom)
Add an existing subcommand to be a member of an option_group.
Definition: App.hpp:1393
CLI11_INLINE void retire_option(App *app, Option *opt)
Helper function to mark an option as retired.
CLI11_NODISCARD std::size_t _count_remaining_positionals(bool required_only=false) const
Count the required remaining positional arguments.
AppFormatMode
Definition: FormatterFwd.hpp:32
OptionDefaults option_defaults_
The default values for options, customizable and changeable INHERITABLE.
Definition: App.hpp:146
void _parse_stream(std::istream &input)
Internal function to parse a stream.
All errors derive from this one.
Definition: Error.hpp:73
CLI11_NODISCARD bool get_immediate_callback() const
Get the status of disabled.
Definition: App.hpp:1162
bool prefix_command_
If true, cease processing on an unrecognized option (implies allow_extras) INHERITABLE.
Definition: App.hpp:114
missing_t missing_
Definition: App.hpp:191
App * allow_windows_style_options(bool value=true)
Definition: App.hpp:470
void _process_config_file()
Read and process a configuration file (main app only)
CLI11_NODISCARD App * get_option_group(std::string group_name) const
Check to see if an option group is part of this App.
void add_options(Option *opt)
Add an existing option to the Option_group.
Definition: App.hpp:1385
App * prefix_command(bool is_prefix=true)
Definition: App.hpp:460
CLI11_NODISCARD bool _has_remaining_positionals() const
Count the required remaining positional arguments.
App * required(bool require=true)
Remove the error when extras are left over on the command line.
Definition: App.hpp:381
std::shared_ptr< Config > config_formatter_
This is the formatter for help printing. Default provided. INHERITABLE (same pointer) ...
Definition: App.hpp:298
std::set< App * > need_subcommands_
Definition: App.hpp:208
App * usage(std::string usage_string)
Set usage.
Definition: App.hpp:1001
CLI11_NODISCARD const std::string & get_group() const
Get the group of this subcommand.
Definition: App.hpp:1119
std::string name_
Subcommand name or program name (from parser if name is empty)
Definition: App.hpp:101
Definition: Option.hpp:194
CLI11_NODISCARD std::string get_description() const
Get the app or subcommand description.
Definition: App.hpp:1053
typename std::enable_if< B, T >::type enable_if_t
Definition: TypeTools.hpp:47
CLI11_NODISCARD bool get_positionals_at_end() const
Check the status of the allow windows style options.
Definition: App.hpp:1113
App * alias(std::string app_name)
Set an alias for the app.
App * formatter_fn(std::function< std::string(const App *, std::string, AppFormatMode)> fmt)
Set the help formatter.
Definition: App.hpp:497
CLI11_NODISCARD App * _find_subcommand(const std::string &subc_name, bool ignore_disabled, bool ignore_used) const noexcept
The normal, detailed help.
Option * get_help_ptr()
Get a pointer to the help flag.
Definition: App.hpp:1178
bool silent_
Definition: App.hpp:261
Option * set_config(std::string option_name="", std::string default_filename="", const std::string &help_message="Read an ini file", bool config_required=false)
Set a configuration ini file option, or clear it if no name passed.
Option * type_size(int option_type_size)
Set a custom option size.
App & operator=(const App &)=delete
App * immediate_callback(bool immediate=true)
Set the subcommand callback to be executed immediately on subcommand completion.
App * footer(std::string footer_string)
Set footer.
Definition: App.hpp:1011
App * allow_config_extras(bool allow=true)
ignore extras in config files
Definition: App.hpp:442
App * require_subcommand(int value)
Definition: App.hpp:796
CLI11_NODISCARD std::string get_footer() const
Generate and return the footer.
Definition: App.hpp:1127
Option * config_ptr_
Pointer to the config option.
Definition: App.hpp:295
CLI11_NODISCARD std::shared_ptr< FormatterBase > get_formatter() const
Access the formatter.
Definition: App.hpp:1037
void parse(int argc, const char *const *argv)
Option * force_callback(bool value=true)
Set the value of force_callback.
Definition: Option.hpp:402
CLI11_NODISCARD bool get_allow_non_standard_option_names() const
Get the status of silence.
Definition: App.hpp:1159
void increment_parsed()
Internal function to recursively increment the parsed counter on the current app as well unnamed subc...
CLI11_NODISCARD std::string get_display_name(bool with_aliases=false) const
Get a display name for an app.
CLI11_NODISCARD std::size_t get_require_option_max() const
Get the required max option value.
Definition: App.hpp:1141
#define CLI11_NODISCARD
Definition: Macros.hpp:58
App * final_callback(std::function< void()> app_callback)
Definition: App.hpp:349
bool ignore_underscore_
If true, the program should ignore underscores INHERITABLE.
Definition: App.hpp:225
This will only trigger for actual void type.
Definition: TypeTools.hpp:504
App * name(std::string app_name="")
Set a name for the app (empty will use parser to set the name)
CLI11_NODISCARD bool get_subcommand_fallthrough() const
Check the status of subcommand fallthrough.
Definition: App.hpp:1107
std::function< void(std::size_t)> pre_parse_callback_
This is a function that runs prior to the start of parsing.
Definition: App.hpp:133
bool validate_optional_arguments_
If set to true optional vector arguments are validated before assigning INHERITABLE.
Definition: App.hpp:257
App * add_subcommand(std::string subcommand_name="", std::string subcommand_description="")
Add a subcommand. Inherits INHERITABLE and OptionDefaults, and help flag.
CLI11_NODISCARD bool get_silent() const
Get the status of silence.
Definition: App.hpp:1156
CLI11_NODISCARD bool get_ignore_underscore() const
Check the status of ignore_underscore.
Definition: App.hpp:1101
std::size_t require_subcommand_max_
Max number of subcommands allowed (parsing stops after this number). 0 is unlimited INHERITABLE...
Definition: App.hpp:273
std::vector< std::pair< detail::Classifier, std::string >> missing_t
Definition: App.hpp:186
Option * add_option(std::string option_name, callback_t option_callback, std::string option_description="", bool defaulted=false, std::function< std::string()> func={})
CLI11_NODISCARD bool _valid_subcommand(const std::string ¤t, bool ignore_used=true) const
Check to see if a subcommand is valid. Give up immediately if subcommand max has been reached...
Option * add_option_function(std::string option_name, const std::function< void(const ArgType &)> &func, std::string option_description="")
Add option for a callback of a specific type.
Definition: App.hpp:584
CLI11_NODISCARD bool check_name(std::string name_to_check) const
Check the name, case-insensitive and underscore insensitive if set.
CLI11_NODISCARD bool get_prefix_command() const
Get the prefix command status.
Definition: App.hpp:1144
App * excludes(App *app)
Sets excluded subcommands for the subcommand.
Definition: App.hpp:951
App * validate_positionals(bool validate=true)
Set the subcommand to validate positional arguments before assigning.
Definition: App.hpp:430
bool remove_option(Option *opt)
Removes an option from the App. Takes an option pointer. Returns true if found and removed...
App * positionals_at_end(bool value=true)
Specify that the positional arguments are only at the end of the sequence.
Definition: App.hpp:476
App * ignore_underscore(bool value=true)
Ignore underscore. Subcommands inherit value.
Option * type_name(std::string typeval)
Set a custom option typestring.
Definition: Option.hpp:728
virtual ~App()=default
virtual destructor
Option * add_flag(std::string flag_name, std::vector< T > &flag_results, std::string flag_description="")
Vector version to capture multiple flags.
Definition: App.hpp:673
static App * get_fallthrough_parent(App *app)
Wrap the fallthrough parent function to make sure that is working correctly.
Definition: App.hpp:1470
CLI11_NODISCARD std::vector< App * > get_subcommands() const
Definition: App.hpp:919
void _process_requirements()
Verify required options and cross requirements. Subcommands too (only if selected).
CLI11_NODISCARD bool get_fallthrough() const
Check the status of fallthrough.
Definition: App.hpp:1104
App * needs(Option *opt)
Definition: App.hpp:966
App * require_option(int value)
Definition: App.hpp:825
CLI11_NODISCARD const Option * get_option(std::string option_name) const
Get an option by name.
Definition: App.hpp:1074
CLI11_NODISCARD std::size_t get_require_subcommand_max() const
Get the required max subcommand value.
Definition: App.hpp:1135
CLI11_NODISCARD bool got_subcommand(std::string subcommand_name) const noexcept
Check with name instead of pointer to see if subcommand was selected.
Definition: App.hpp:936
Holds values to load into Options.
Definition: ConfigFwd.hpp:29
config_extras_mode allow_config_extras_
Definition: App.hpp:111
std::vector< App * > parsed_subcommands_
This is a list of the subcommands collected, in order.
Definition: App.hpp:197
std::shared_ptr< FormatterBase > formatter_
This is the formatter for help printing. Default provided. INHERITABLE (same pointer) ...
Definition: App.hpp:177
App * subcommand_fallthrough(bool value=true)
Set subcommand fallthrough, set to true so that subcommands on parents are recognized.
Definition: App.hpp:852
std::function< bool(const results_t &)> callback_t
callback function definition
Definition: Option.hpp:33
startup_mode
Definition: App.hpp:245
CRTP * always_capture_default(bool value=true)
Definition: Option.hpp:107
App * excludes(Option *opt)
Sets excluded options for the subcommand.
Definition: App.hpp:942
bool ignore_case_
If true, the program name is not case-sensitive INHERITABLE.
Definition: App.hpp:222
App * footer(std::function< std::string()> footer_function)
Set footer.
Definition: App.hpp:1016
Option * add_flag(std::string flag_name, T &flag_result, std::string flag_description="")
Definition: App.hpp:657
CLI11_NODISCARD bool get_validate_optional_arguments() const
Get the status of validating optional vector arguments.
Definition: App.hpp:1172
CLI11_NODISCARD const std::string & get_name() const
Get the name of the current app.
Definition: App.hpp:1205
bool required_
If set to true the subcommand is required to be processed and used, ignored for main app...
Definition: App.hpp:120
bool got_subcommand(const App *subcom) const
Check to see if given subcommand was selected.
Definition: App.hpp:930
Creates a command line program, with very few defaults.
Definition: App.hpp:90
App * group(std::string group_name)
Changes the group membership.
Definition: App.hpp:781
just get all the passed argument regardless
Option * set_help_flag(std::string flag_name="", const std::string &help_description="")
Set a help flag, replace the existing one if present.
CLI11_NODISCARD std::vector< std::string > get_groups() const
Get the groups available directly from this option (in order)
std::function< std::string(const App *, const Error &e)> failure_message_
The error message printing function INHERITABLE.
Definition: App.hpp:180
CLI11_NODISCARD std::size_t get_require_option_min() const
Get the required min option value.
Definition: App.hpp:1138
bool configurable_
if set to true the subcommand can be triggered via configuration files INHERITABLE ...
Definition: App.hpp:251
CLI11_NODISCARD std::string config_to_str(bool default_also=false, bool write_description=false) const
Definition: App.hpp:1022
This converter works with INI/TOML files; to write INI files use ConfigINI.
Definition: ConfigFwd.hpp:85
bool _parse_arg(std::vector< std::string > &args, detail::Classifier current_type, bool local_processing_only)
App * require_subcommand(std::size_t min, std::size_t max)
Definition: App.hpp:809
std::string usage_
Usage to put after program/subcommand description in the help output INHERITABLE. ...
Definition: App.hpp:156
CLI11_NODISCARD bool get_configurable() const
Check the status of the allow windows style options.
Definition: App.hpp:1116
void parse_from_stream(std::istream &input)
bool immediate_callback_
Definition: App.hpp:130
bool subcommand_fallthrough_
Allow subcommands to fallthrough, so that parent commands can trigger other subcommands after subcomm...
Definition: App.hpp:232
Option * default_flag_modifiers(Option *opt)
helper functions for adding in appropriate flag modifiers for add_flag
Definition: App.hpp:73
std::set< App * > exclude_subcommands_
this is a list of subcommands that are exclusionary to this one
Definition: App.hpp:200
App * _get_fallthrough_parent()
Get the appropriate parent to fallthrough to which is the first one that has a name or the main app...
App * parse_complete_callback(std::function< void()> pc_callback)
Definition: App.hpp:356
CLI11_NODISCARD std::shared_ptr< Config > get_config_formatter() const
Access the config formatter.
Definition: App.hpp:1040
sum all the arguments together if numerical or concatenate directly without delimiter ...
Option * expected(int value)
Set the number of expected arguments.
bool valid_alias_name_string(const std::string &str)
Verify an app name.
Definition: StringTools.hpp:166
App * usage(std::function< std::string()> usage_function)
Set usage.
Definition: App.hpp:1006
std::uint32_t parsed_
Counts the number of times this command/subcommand was parsed.
Definition: App.hpp:267
Option * default_str(std::string val)
Set the default value string representation (does not change the contained value) ...
Definition: Option.hpp:757
std::shared_ptr< App > App_p
Definition: App.hpp:67
bool positionals_at_end_
specify that positional arguments come at the end of the argument sequence not inheritable ...
Definition: App.hpp:243
Option * add_option(Option *opt)
Add an existing option to the Option_group.
Definition: App.hpp:1377
App * disabled_by_default(bool disable=true)
Set the subcommand to be disabled by default, so on clear(), at the start of each parse it is disable...
Definition: App.hpp:405
void _process()
Process callbacks and such.
App * fallthrough(bool value=true)
Definition: App.hpp:846
Option_group(std::string group_description, std::string group_name, App *parent)
Definition: App.hpp:1365
std::size_t require_option_max_
Max number of options allowed. 0 is unlimited (not inheritable)
Definition: App.hpp:279
void _parse_config(const std::vector< ConfigItem > &args)
virtual void pre_callback()
Definition: App.hpp:868
Option * set_help_all_flag(std::string help_name="", const std::string &help_description="")
Set a help all flag, replaced the existing one if present.
void add_options(Option *opt, Args...args)
Add a bunch of options to the group.
Definition: App.hpp:1387
std::function< void()> final_callback_
This is a function that runs when all processing has completed.
Definition: App.hpp:139