CLI11
C++11 Command Line Interface Parser
CLI::App Member List

This is the complete list of members for CLI::App, including all inherited members.

_configure()CLI::Appinlineprotected
_count_remaining_positionals(bool required_only=false) constCLI::Appinlineprotected
_find_subcommand(const std::string &subc_name, bool ignore_disabled, bool ignore_used) const noexceptCLI::Appinlineprotected
_get_fallthrough_parent()CLI::Appinlineprotected
_has_remaining_positionals() constCLI::Appinlineprotected
_move_option(Option *opt, App *app)CLI::Appinline
_move_to_missing(detail::Classifier val_type, const std::string &val)CLI::Appinlineprotected
_parse(std::vector< std::string > &args)CLI::Appinlineprotected
_parse(std::vector< std::string > &&args)CLI::Appinlineprotected
_parse_arg(std::vector< std::string > &args, detail::Classifier current_type)CLI::Appinlineprotected
_parse_config(std::vector< ConfigItem > &args)CLI::Appinlineprotected
_parse_positional(std::vector< std::string > &args)CLI::Appinlineprotected
_parse_single(std::vector< std::string > &args, bool &positional_only)CLI::Appinlineprotected
_parse_single_config(const ConfigItem &item, size_t level=0)CLI::Appinlineprotected
_parse_subcommand(std::vector< std::string > &args)CLI::Appinlineprotected
_process()CLI::Appinlineprotected
_process_callbacks()CLI::Appinlineprotected
_process_env()CLI::Appinlineprotected
_process_extras()CLI::Appinlineprotected
_process_extras(std::vector< std::string > &args)CLI::Appinlineprotected
_process_help_flags(bool trigger_help=false, bool trigger_all_help=false) constCLI::Appinlineprotected
_process_ini()CLI::Appinlineprotected
_process_requirements()CLI::Appinlineprotected
_recognize(const std::string &current, bool ignore_used_subcommands=true) constCLI::Appinlineprotected
_trigger_pre_parse(size_t remaining_args)CLI::Appinlineprotected
_valid_subcommand(const std::string &current, bool ignore_used=true) constCLI::Appinlineprotected
_validate() constCLI::Appinlineprotected
add_complex(std::string option_name, T &variable, std::string option_description="", bool defaulted=false, std::string label="COMPLEX")CLI::Appinline
add_flag(std::string flag_name)CLI::Appinline
add_flag(std::string flag_name, T &flag_description)CLI::Appinline
add_flag(std::string flag_name, T &flag_count, std::string flag_description="")CLI::Appinline
add_flag(std::string flag_name, T &flag_result, std::string flag_description="")CLI::Appinline
add_flag(std::string flag_name, std::vector< T > &flag_results, std::string flag_description="")CLI::Appinline
add_flag_callback(std::string flag_name, std::function< void(void)> function, std::string flag_description="")CLI::Appinline
add_flag_function(std::string flag_name, std::function< void(int64_t)> function, std::string flag_description="")CLI::Appinline
add_mutable_set(std::string option_name, T &member, const std::set< T > &options, std::string option_description="")CLI::Appinline
add_mutable_set(std::string option_name, T &member, const std::set< T > &options, std::string option_description, bool defaulted)CLI::Appinline
add_option(std::string option_name, callback_t option_callback, std::string option_description="", bool defaulted=false, std::function< std::string()> func={})CLI::Appinline
add_option(std::string option_name, T &variable, std::string option_description="", bool defaulted=false)CLI::Appinline
add_option(std::string option_name)CLI::Appinline
add_option(std::string option_name, T &option_description)CLI::Appinline
add_option(std::string option_name, std::vector< T > &variable, std::string option_description="", bool defaulted=false)CLI::Appinline
add_option_function(std::string option_name, const std::function< void(const T &)> &func, std::string option_description="")CLI::Appinline
add_option_function(std::string option_name, const std::function< void(const T &)> &func, std::string option_description="")CLI::Appinline
add_option_group(std::string group_name, std::string group_description="")CLI::Appinline
add_set(std::string option_name, T &member, std::set< T > options, std::string option_description="")CLI::Appinline
add_set(std::string option_name, T &member, std::set< T > options, std::string option_description, bool defaulted)CLI::Appinline
add_subcommand(std::string subcommand_name="", std::string subcommand_description="")CLI::Appinline
add_subcommand(CLI::App_p subcom)CLI::Appinline
allow_config_extras(bool allow=true)CLI::Appinline
allow_config_extras_CLI::Appprotected
allow_extras(bool allow=true)CLI::Appinline
allow_extras_CLI::Appprotected
allow_windows_style_options(bool value=true)CLI::Appinline
allow_windows_style_options_CLI::Appprotected
App(std::string app_description, std::string app_name, App *parent)CLI::Appinlineprotected
App(std::string app_description="", std::string app_name="")CLI::Appinlineexplicit
callback(std::function< void()> app_callback)CLI::Appinline
callback_CLI::Appprotected
check_name(std::string name_to_check) constCLI::Appinline
clear()CLI::Appinline
CLI11_DEPRECATED("Use ->transform(CLI::IsMember(..., CLI::ignore_case)) instead") Option *add_set_ignore_case(stdCLI::Appinline
CLI11_DEPRECATED("Use ->transform(CLI::IsMember(..., CLI::ignore_case)) with a (shared) pointer instead") Option *add_mutable_set_ignore_case(stdCLI::Appinline
CLI11_DEPRECATED("Use ->transform(CLI::IsMember(..., CLI::ignore_case)) instead") Option *add_set_ignore_case(stdCLI::Appinline
CLI11_DEPRECATED("Use ->transform(CLI::IsMember(...)) with a (shared) pointer instead") Option *add_mutable_set_ignore_case(stdCLI::Appinline
CLI11_DEPRECATED("Use ->transform(CLI::IsMember(..., CLI::ignore_underscore)) instead") Option *add_set_ignore_underscore(stdCLI::Appinline
CLI11_DEPRECATED("Use ->transform(CLI::IsMember(..., CLI::ignore_underscore)) with a (shared) pointer instead") Option *add_mutable_set_ignore_underscore(stdCLI::Appinline
CLI11_DEPRECATED("Use ->transform(CLI::IsMember(..., CLI::ignore_underscore)) instead") Option *add_set_ignore_underscore(stdCLI::Appinline
CLI11_DEPRECATED("Use ->transform(CLI::IsMember(..., CLI::ignore_underscore)) with a (shared) pointer instead") Option *add_mutable_set_ignore_underscore(stdCLI::Appinline
CLI11_DEPRECATED("Use ->transform(CLI::IsMember(..., CLI::ignore_case, CLI::ignore_underscore)) instead") Option *add_set_ignore_case_underscore(stdCLI::Appinline
CLI11_DEPRECATED("Use ->transform(CLI::IsMember(..., CLI::ignore_case, CLI::ignore_underscore)) with a (shared) pointer instead") Option *add_mutable_set_ignore_case_underscore(stdCLI::Appinline
CLI11_DEPRECATED("Use ->transform(CLI::IsMember(..., CLI::ignore_case, CLI::ignore_underscore)) instead") Option *add_set_ignore_case_underscore(stdCLI::Appinline
CLI11_DEPRECATED("Use ->transform(CLI::IsMember(..., CLI::ignore_case, CLI::ignore_underscore)) with a (shared) pointer instead") Option *add_mutable_set_ignore_case_underscore(stdCLI::Appinline
config_formatter(std::shared_ptr< Config > fmt)CLI::Appinline
config_formatter_CLI::Appprotected
config_name_CLI::Appprotected
config_ptr_CLI::Appprotected
config_required_CLI::Appprotected
config_to_str(bool default_also=false, bool write_description=false) constCLI::Appinline
count() constCLI::Appinline
count(std::string option_name) constCLI::Appinline
count_all() constCLI::Appinline
description(std::string app_description)CLI::Appinline
description_CLI::Appprotected
disabled(bool disable=true)CLI::Appinline
disabled_CLI::Appprotected
disabled_by_default(bool disable=true)CLI::Appinline
disabled_by_default_CLI::Appprotected
enabled_by_default(bool enable=true)CLI::Appinline
enabled_by_default_CLI::Appprotected
exclude_options_CLI::Appprotected
exclude_subcommands_CLI::Appprotected
excludes(Option *opt)CLI::Appinline
excludes(App *app)CLI::Appinline
exit(const Error &e, std::ostream &out=std::cout, std::ostream &err=std::cerr) constCLI::Appinline
failure_message(std::function< std::string(const App *, const Error &e)> function)CLI::Appinline
failure_message_CLI::Appprotected
fallthrough(bool value=true)CLI::Appinline
fallthrough_CLI::Appprotected
footer(std::string footer_string)CLI::Appinline
footer_CLI::Appprotected
formatter(std::shared_ptr< FormatterBase > fmt)CLI::Appinline
formatter_CLI::Appprotected
formatter_fn(std::function< std::string(const App *, std::string, AppFormatMode)> fmt)CLI::Appinline
get_allow_config_extras() constCLI::Appinline
get_allow_extras() constCLI::Appinline
get_allow_windows_style_options() constCLI::Appinline
get_config_formatter() constCLI::Appinline
get_config_ptr()CLI::Appinline
get_config_ptr() constCLI::Appinline
get_description() constCLI::Appinline
get_disabled() constCLI::Appinline
get_disabled_by_default() constCLI::Appinline
get_display_name() constCLI::Appinline
get_enabled_by_default() constCLI::Appinline
get_fallthrough() constCLI::Appinline
get_footer() constCLI::Appinline
get_formatter() constCLI::Appinline
get_group() constCLI::Appinline
get_groups() constCLI::Appinline
get_help_all_ptr() constCLI::Appinline
get_help_ptr()CLI::Appinline
get_help_ptr() constCLI::Appinline
get_ignore_case() constCLI::Appinline
get_ignore_underscore() constCLI::Appinline
get_immediate_callback() constCLI::Appinline
get_name() constCLI::Appinline
get_option(std::string option_name) constCLI::Appinline
get_option(std::string option_name)CLI::Appinline
get_option_group(std::string group_name) constCLI::Appinline
get_option_no_throw(std::string option_name) noexceptCLI::Appinline
get_option_no_throw(std::string option_name) const noexceptCLI::Appinline
get_options(const std::function< bool(const Option *)> filter={}) constCLI::Appinline
get_parent()CLI::Appinline
get_parent() constCLI::Appinline
get_positionals_at_end() constCLI::Appinline
get_prefix_command() constCLI::Appinline
get_require_option_max() constCLI::Appinline
get_require_option_min() constCLI::Appinline
get_require_subcommand_max() constCLI::Appinline
get_require_subcommand_min() constCLI::Appinline
get_required() constCLI::Appinline
get_subcommand(App *subcom) constCLI::Appinline
get_subcommand(std::string subcom) constCLI::Appinline
get_subcommand(int index=0) constCLI::Appinline
get_subcommand_ptr(App *subcom) constCLI::Appinline
get_subcommand_ptr(std::string subcom) constCLI::Appinline
get_subcommand_ptr(int index=0) constCLI::Appinline
get_subcommands() constCLI::Appinline
get_subcommands(const std::function< bool(const App *)> &filter) constCLI::Appinline
get_subcommands(const std::function< bool(App *)> &filter)CLI::Appinline
get_validate_positionals() constCLI::Appinline
got_subcommand(App *subcom) constCLI::Appinline
got_subcommand(std::string subcommand_name) constCLI::Appinline
group(std::string group_name)CLI::Appinline
group_CLI::Appprotected
has_automatic_name_CLI::Appprotected
help(std::string prev="", AppFormatMode mode=AppFormatMode::Normal) constCLI::Appinline
help_all_ptr_CLI::Appprotected
help_ptr_CLI::Appprotected
ignore_case(bool value=true)CLI::Appinline
ignore_case_CLI::Appprotected
ignore_underscore(bool value=true)CLI::Appinline
ignore_underscore_CLI::Appprotected
immediate_callback(bool immediate=true)CLI::Appinline
immediate_callback_CLI::Appprotected
increment_parsed()CLI::Appinlineprotected
missing_CLI::Appprotected
missing_t typedef (defined in CLI::App)CLI::Appprotected
name(std::string app_name="")CLI::Appinline
name_CLI::Appprotected
operator bool() constCLI::Appinline
operator[](const std::string &option_name) constCLI::Appinline
operator[](const char *option_name) constCLI::Appinline
option_defaults()CLI::Appinline
option_defaults_CLI::Appprotected
options_CLI::Appprotected
parent_CLI::Appprotected
parse(int argc, const char *const *argv)CLI::Appinline
parse(std::string commandline, bool program_name_included=false)CLI::Appinline
parse(std::vector< std::string > &args)CLI::Appinline
parse(std::vector< std::string > &&args)CLI::Appinline
parse_order() constCLI::Appinline
parse_order_CLI::Appprotected
parsed() constCLI::Appinline
parsed_CLI::Appprotected
parsed_subcommands_CLI::Appprotected
positionals_at_end(bool value=true)CLI::Appinline
positionals_at_end_CLI::Appprotected
pre_callback()CLI::Appinlinevirtual
pre_parse_callback_CLI::Appprotected
pre_parse_called_CLI::Appprotected
prefix_command(bool allow=true)CLI::Appinline
prefix_command_CLI::Appprotected
preparse_callback(std::function< void(size_t)> pp_callback)CLI::Appinline
remaining(bool recurse=false) constCLI::Appinline
remaining_for_passthrough(bool recurse=false) constCLI::Appinline
remaining_size(bool recurse=false) constCLI::Appinline
remove_excludes(Option *opt)CLI::Appinline
remove_excludes(App *app)CLI::Appinline
remove_option(Option *opt)CLI::Appinline
remove_subcommand(App *subcom)CLI::Appinline
require_option()CLI::Appinline
require_option(int value)CLI::Appinline
require_option(size_t min, size_t max)CLI::Appinline
require_option_max_CLI::Appprotected
require_option_min_CLI::Appprotected
require_subcommand()CLI::Appinline
require_subcommand(int value)CLI::Appinline
require_subcommand(size_t min, size_t max)CLI::Appinline
require_subcommand_max_CLI::Appprotected
require_subcommand_min_CLI::Appprotected
required(bool require=true)CLI::Appinline
required_CLI::Appprotected
run_callback()CLI::Appinlineprotected
set_config(std::string option_name="", std::string default_filename="", std::string help_message="Read an ini file", bool config_required=false)CLI::Appinline
set_help_all_flag(std::string help_name="", const std::string &help_description="")CLI::Appinline
set_help_flag(std::string flag_name="", const std::string &help_description="")CLI::Appinline
subcommands_CLI::Appprotected
validate_positionals(bool validate=true)CLI::Appinline
validate_positionals_CLI::Appprotected
~App()=defaultCLI::Appvirtual