App.hpp

Go to the documentation of this file.

// Copyright (c) 2017-2026, University of Cincinnati, developed by Henry Schreiner
// under NSF AWARD 1414736 and by the respective contributors.
// All rights reserved.
//
// SPDX-License-Identifier: BSD-3-Clause

#pragma once

// IWYU pragma: private, include "CLI/CLI.hpp"

// [CLI11:public_includes:set]
#include <algorithm>
#include <cstdint>
#include <functional>
#include <iostream>
#include <iterator>
#include <memory>
#include <numeric>
#include <set>
#include <sstream>
#include <string>
#include <utility>
#include <vector>
// [CLI11:public_includes:end]

// CLI Library includes
#include "ConfigFwd.hpp"
#include "Error.hpp"
#include "FormatterFwd.hpp"
#include "Macros.hpp"
#include "Option.hpp"
#include "Split.hpp"
#include "StringTools.hpp"
#include "TypeTools.hpp"

namespace CLI {
// [CLI11:app_hpp:verbatim]

#ifndef CLI11_PARSE
#define CLI11_PARSE(app, ...)                                                                                          \
    try {                                                                                                              \
        (app).parse(__VA_ARGS__);                                                                                      \
    } catch(const CLI::ParseError &e) {                                                                                \
        return (app).exit(e);                                                                                          \
    }
#endif

namespace detail {
enum class Classifier : std::uint8_t {
    NONE,
    POSITIONAL_MARK,
    SHORT,
    LONG,
    WINDOWS_STYLE,
    SUBCOMMAND,
    SUBCOMMAND_TERMINATOR
};
struct AppFriend;
}  // namespace detail

namespace FailureMessage {
CLI11_INLINE std::string simple(const App *app, const Error &e);

CLI11_INLINE std::string help(const App *app, const Error &e);
}  // namespace FailureMessage

enum class ExtrasMode : std::uint8_t {
    Error = 0,
    ErrorImmediately,
    Ignore,
    AssumeSingleArgument,
    AssumeMultipleArguments,
    Capture
};

enum class ConfigExtrasMode : std::uint8_t { Error = 0, Ignore, IgnoreAll, Capture };

enum class config_extras_mode : std::uint8_t { error = 0, ignore, ignore_all, capture };

enum class PrefixCommandMode : std::uint8_t { Off = 0, SeparatorOnly = 1, On = 2 };

class App;

using App_p = std::shared_ptr<App>;

namespace detail {

template <typename T, enable_if_t<!std::is_integral<T>::value || (sizeof(T) <= 1U), detail::enabler> = detail::dummy>
Option *default_flag_modifiers(Option *opt) {
    return opt->always_capture_default();
}

template <typename T, enable_if_t<std::is_integral<T>::value && (sizeof(T) > 1U), detail::enabler> = detail::dummy>
Option *default_flag_modifiers(Option *opt) {
    return opt->multi_option_policy(MultiOptionPolicy::Sum)->default_str("0")->force_callback();
}

}  // namespace detail

class Option_group;

class App {
    friend Option;
    friend detail::AppFriend;

  protected:
    // This library follows the Google style guide for member names ending in underscores


    std::string name_{};

    std::string description_{};

    ExtrasMode allow_extras_{ExtrasMode::Error};

    ConfigExtrasMode allow_config_extras_{ConfigExtrasMode::Ignore};

    PrefixCommandMode prefix_command_{PrefixCommandMode::Off};

    bool has_automatic_name_{false};

    bool required_{false};

    bool disabled_{false};

    bool pre_parse_called_{false};

    bool immediate_callback_{false};

    std::function<void(std::size_t)> pre_parse_callback_{};

    std::function<void()> parse_complete_callback_{};

    std::function<void()> final_callback_{};


    OptionDefaults option_defaults_{};

    std::vector<Option_p> options_{};


    std::string usage_{};

    std::function<std::string()> usage_callback_{};

    std::string footer_{};

    std::function<std::string()> footer_callback_{};

    Option *help_ptr_{nullptr};

    Option *help_all_ptr_{nullptr};

    Option *version_ptr_{nullptr};

    std::shared_ptr<FormatterBase> formatter_{new Formatter()};

    std::function<std::string(const App *, const Error &e)> failure_message_{FailureMessage::simple};


    using missing_t = std::vector<std::pair<detail::Classifier, std::string>>;

    missing_t missing_{};

    std::vector<Option *> parse_order_{};

    std::vector<App *> parsed_subcommands_{};

    std::set<App *> exclude_subcommands_{};

    std::set<Option *> exclude_options_{};

    std::set<App *> need_subcommands_{};

    std::set<Option *> need_options_{};


    std::vector<App_p> subcommands_{};

    bool ignore_case_{false};

    bool ignore_underscore_{false};

    bool fallthrough_{false};

    bool subcommand_fallthrough_{true};

    bool allow_windows_style_options_{
#ifdef _WIN32
        true
#else
        false
#endif
    };
    bool positionals_at_end_{false};

    enum class startup_mode : std::uint8_t { stable, enabled, disabled };
    startup_mode default_startup{startup_mode::stable};

    bool configurable_{false};

    bool validate_positionals_{false};

    bool validate_optional_arguments_{false};

    bool silent_{false};

    bool allow_non_standard_options_{false};

    bool allow_prefix_matching_{false};

    std::uint32_t parsed_{0U};

    std::size_t require_subcommand_min_{0};

    std::size_t require_subcommand_max_{0};

    std::size_t require_option_min_{0};

    std::size_t require_option_max_{0};

    App *parent_{nullptr};

    std::string group_{"SUBCOMMANDS"};

    std::vector<std::string> aliases_{};


    Option *config_ptr_{nullptr};

    std::shared_ptr<Config> config_formatter_{new ConfigTOML()};


#ifdef _WIN32
    std::vector<std::string> normalized_argv_{};

    std::vector<char *> normalized_argv_view_{};
#endif

    App(std::string app_description, std::string app_name, App *parent);

  public:

    explicit App(std::string app_description = "", std::string app_name = "")
        : App(app_description, app_name, nullptr) {
        set_help_flag("-h,--help", "Print this help message and exit");
    }

    App(const App &) = delete;
    App &operator=(const App &) = delete;

    virtual ~App() = default;

    CLI11_NODISCARD char **ensure_utf8(char **argv);

    App *callback(std::function<void()> app_callback) {
        if(immediate_callback_) {
            parse_complete_callback_ = std::move(app_callback);
        } else {
            final_callback_ = std::move(app_callback);
        }
        return this;
    }

    App *final_callback(std::function<void()> app_callback) {
        final_callback_ = std::move(app_callback);
        return this;
    }

    App *parse_complete_callback(std::function<void()> pc_callback) {
        parse_complete_callback_ = std::move(pc_callback);
        return this;
    }

    App *preparse_callback(std::function<void(std::size_t)> pp_callback) {
        pre_parse_callback_ = std::move(pp_callback);
        return this;
    }

    App *name(std::string app_name = "");

    App *alias(std::string app_name);

    App *allow_extras(bool allow = true) {
        allow_extras_ = allow ? ExtrasMode::Capture : ExtrasMode::Error;
        return this;
    }

    App *allow_extras(ExtrasMode allow) {
        allow_extras_ = allow;
        return this;
    }

    App *required(bool require = true) {
        required_ = require;
        return this;
    }

    App *disabled(bool disable = true) {
        disabled_ = disable;
        return this;
    }

    App *silent(bool silence = true) {
        silent_ = silence;
        return this;
    }

    App *allow_non_standard_option_names(bool allowed = true) {
        allow_non_standard_options_ = allowed;
        return this;
    }

    App *allow_subcommand_prefix_matching(bool allowed = true) {
        allow_prefix_matching_ = allowed;
        return this;
    }
    App *disabled_by_default(bool disable = true) {
        if(disable) {
            default_startup = startup_mode::disabled;
        } else {
            default_startup = (default_startup == startup_mode::enabled) ? startup_mode::enabled : startup_mode::stable;
        }
        return this;
    }

    App *enabled_by_default(bool enable = true) {
        if(enable) {
            default_startup = startup_mode::enabled;
        } else {
            default_startup =
                (default_startup == startup_mode::disabled) ? startup_mode::disabled : startup_mode::stable;
        }
        return this;
    }

    App *immediate_callback(bool immediate = true);

    App *validate_positionals(bool validate = true) {
        validate_positionals_ = validate;
        return this;
    }

    App *validate_optional_arguments(bool validate = true) {
        validate_optional_arguments_ = validate;
        return this;
    }

    App *allow_config_extras(bool allow = true) {
        if(allow) {
            allow_config_extras_ = ConfigExtrasMode::Capture;
            allow_extras_ = ExtrasMode::Capture;
        } else {
            allow_config_extras_ = ConfigExtrasMode::Error;
        }
        return this;
    }

    App *allow_config_extras(config_extras_mode mode) {
        allow_config_extras_ = static_cast<ConfigExtrasMode>(mode);
        return this;
    }

    App *allow_config_extras(ConfigExtrasMode mode) {
        allow_config_extras_ = mode;
        return this;
    }

    App *prefix_command(bool is_prefix = true) {
        prefix_command_ = is_prefix ? PrefixCommandMode::On : PrefixCommandMode::Off;
        return this;
    }

    App *prefix_command(PrefixCommandMode mode) {
        prefix_command_ = mode;
        return this;
    }

    App *ignore_case(bool value = true);

    App *allow_windows_style_options(bool value = true) {
        allow_windows_style_options_ = value;
        return this;
    }

    App *positionals_at_end(bool value = true) {
        positionals_at_end_ = value;
        return this;
    }

    App *configurable(bool value = true) {
        configurable_ = value;
        return this;
    }

    App *ignore_underscore(bool value = true);

    App *formatter(std::shared_ptr<FormatterBase> fmt) {
        formatter_ = fmt;
        return this;
    }

    App *formatter_fn(std::function<std::string(const App *, std::string, AppFormatMode)> fmt) {
        formatter_ = std::make_shared<FormatterLambda>(fmt);
        return this;
    }

    App *config_formatter(std::shared_ptr<Config> fmt) {
        config_formatter_ = fmt;
        return this;
    }

    CLI11_NODISCARD bool parsed() const { return parsed_ > 0; }

    OptionDefaults *option_defaults() { return &option_defaults_; }


    Option *add_option(std::string option_name,
                       callback_t option_callback,
                       std::string option_description = "",
                       bool defaulted = false,
                       std::function<std::string()> func = {});

    template <typename AssignTo,
              typename ConvertTo = AssignTo,
              enable_if_t<!std::is_const<ConvertTo>::value, detail::enabler> = detail::dummy>
    Option *add_option(std::string option_name,
                       AssignTo &variable,  
                       std::string option_description = "") {

        auto fun = [&variable](const CLI::results_t &res) {  // comment for spacing
            return detail::lexical_conversion<AssignTo, ConvertTo>(res, variable);
        };

        Option *opt = add_option(option_name, fun, option_description, false, [&variable]() {
            return CLI::detail::checked_to_string<AssignTo, ConvertTo>(variable);
        });
        opt->type_name(detail::type_name<ConvertTo>());
        // these must be actual lvalues since (std::max) sometimes is defined in terms of references and references
        // to structs used in the evaluation can be temporary so that would cause issues.
        auto Tcount = detail::type_count<AssignTo>::value;
        auto XCcount = detail::type_count<ConvertTo>::value;
        opt->type_size(detail::type_count_min<ConvertTo>::value, (std::max)(Tcount, XCcount));
        opt->expected(detail::expected_count<ConvertTo>::value);
        opt->run_callback_for_default();
        return opt;
    }

    template <typename AssignTo, enable_if_t<!std::is_const<AssignTo>::value, detail::enabler> = detail::dummy>
    Option *add_option_no_stream(std::string option_name,
                                 AssignTo &variable,  
                                 std::string option_description = "") {

        auto fun = [&variable](const CLI::results_t &res) {  // comment for spacing
            return detail::lexical_conversion<AssignTo, AssignTo>(res, variable);
        };

        Option *opt = add_option(option_name, fun, option_description, false, []() { return std::string{}; });
        opt->type_name(detail::type_name<AssignTo>());
        opt->type_size(detail::type_count_min<AssignTo>::value, detail::type_count<AssignTo>::value);
        opt->expected(detail::expected_count<AssignTo>::value);
        opt->run_callback_for_default();
        return opt;
    }

    template <typename ArgType>
    Option *add_option_function(std::string option_name,
                                const std::function<void(const ArgType &)> &func,  
                                std::string option_description = "") {

        auto fun = [func](const CLI::results_t &res) {
            ArgType variable;
            bool result = detail::lexical_conversion<ArgType, ArgType>(res, variable);
            if(result) {
                func(variable);
            }
            return result;
        };

        Option *opt = add_option(option_name, std::move(fun), option_description, false);
        opt->type_name(detail::type_name<ArgType>());
        opt->type_size(detail::type_count_min<ArgType>::value, detail::type_count<ArgType>::value);
        opt->expected(detail::expected_count<ArgType>::value);
        return opt;
    }

    Option *add_option(std::string option_name) {
        return add_option(option_name, CLI::callback_t{}, std::string{}, false);
    }

    template <typename T,
              enable_if_t<std::is_const<T>::value && std::is_constructible<std::string, T>::value, detail::enabler> =
                  detail::dummy>
    Option *add_option(std::string option_name, T &option_description) {
        return add_option(option_name, CLI::callback_t(), option_description, false);
    }

    Option *set_help_flag(std::string flag_name = "", const std::string &help_description = "");

    Option *set_help_all_flag(std::string help_name = "", const std::string &help_description = "");

    Option *set_version_flag(std::string flag_name = "",
                             const std::string &versionString = "",
                             const std::string &version_help = "Display program version information and exit");

    Option *set_version_flag(std::string flag_name,
                             std::function<std::string()> vfunc,
                             const std::string &version_help = "Display program version information and exit");

  private:
    Option *_add_flag_internal(std::string flag_name, CLI::callback_t fun, std::string flag_description);

  public:
    Option *add_flag(std::string flag_name) { return _add_flag_internal(flag_name, CLI::callback_t(), std::string{}); }

    template <typename T,
              enable_if_t<(std::is_const<typename std::remove_reference<T>::type>::value ||
                           std::is_rvalue_reference<T &&>::value) &&
                              std::is_constructible<std::string, typename std::remove_reference<T>::type>::value,
                          detail::enabler> = detail::dummy>
    Option *add_flag(std::string flag_name, T &&flag_description) {
        return _add_flag_internal(flag_name, CLI::callback_t(), std::forward<T>(flag_description));
    }

    template <typename T,
              enable_if_t<!detail::is_mutable_container<T>::value && !std::is_const<T>::value &&
                              !std::is_constructible<std::function<void(int)>, T>::value,
                          detail::enabler> = detail::dummy>
    Option *add_flag(std::string flag_name,
                     T &flag_result,  
                     std::string flag_description = "") {

        CLI::callback_t fun = [&flag_result](const CLI::results_t &res) {
            using CLI::detail::lexical_cast;
            return lexical_cast(res[0], flag_result);
        };
        auto *opt = _add_flag_internal(flag_name, std::move(fun), std::move(flag_description));
        return detail::default_flag_modifiers<T>(opt);
    }

    template <typename T,
              enable_if_t<!std::is_assignable<std::function<void(std::int64_t)> &, T>::value, detail::enabler> =
                  detail::dummy>
    Option *add_flag(std::string flag_name,
                     std::vector<T> &flag_results,  
                     std::string flag_description = "") {
        CLI::callback_t fun = [&flag_results](const CLI::results_t &res) {
            bool retval = true;
            for(const auto &elem : res) {
                using CLI::detail::lexical_cast;
                flag_results.emplace_back();
                retval &= lexical_cast(elem, flag_results.back());
            }
            return retval;
        };
        return _add_flag_internal(flag_name, std::move(fun), std::move(flag_description))
            ->multi_option_policy(MultiOptionPolicy::TakeAll)
            ->run_callback_for_default();
    }

    Option *add_flag_callback(std::string flag_name,
                              std::function<void(void)> function,  
                              std::string flag_description = "");

    Option *add_flag_function(std::string flag_name,
                              std::function<void(std::int64_t)> function,  
                              std::string flag_description = "");

#ifdef CLI11_CPP14
    Option *add_flag(std::string flag_name,
                     std::function<void(std::int64_t)> function,  
                     std::string flag_description = "") {
        return add_flag_function(std::move(flag_name), std::move(function), std::move(flag_description));
    }
#endif

    Option *set_config(std::string option_name = "",
                       std::string default_filename = "",
                       const std::string &help_message = "Read an ini file",
                       bool config_required = false);

    bool remove_option(Option *opt);

    template <typename T = Option_group>
    T *add_option_group(std::string group_name, std::string group_description = "") {
        if(!detail::valid_alias_name_string(group_name)) {
            throw IncorrectConstruction("option group names may not contain newlines or null characters");
        }
        auto option_group = std::make_shared<T>(std::move(group_description), group_name, this);
        auto *ptr = option_group.get();
        // move to App_p for overload resolution on older gcc versions
        App_p app_ptr = std::static_pointer_cast<App>(option_group);
        // don't inherit the footer in option groups and clear the help flag by default
        app_ptr->footer_ = "";
        app_ptr->set_help_flag();
        add_subcommand(std::move(app_ptr));
        return ptr;
    }


    App *add_subcommand(std::string subcommand_name = "", std::string subcommand_description = "");

    App *add_subcommand(CLI::App_p subcom);

    bool remove_subcommand(App *subcom);

    App *get_subcommand(const App *subcom) const;

    CLI11_NODISCARD App *get_subcommand(std::string subcom) const;

    CLI11_NODISCARD App *get_subcommand_no_throw(std::string subcom) const noexcept;

    CLI11_NODISCARD App *get_subcommand(int index = 0) const;

    CLI::App_p get_subcommand_ptr(App *subcom) const;

    CLI11_NODISCARD CLI::App_p get_subcommand_ptr(std::string subcom) const;

    CLI11_NODISCARD CLI::App_p get_subcommand_ptr(int index = 0) const;

    CLI11_NODISCARD App *get_option_group(std::string group_name) const;

    CLI11_NODISCARD std::size_t count() const { return parsed_; }

    CLI11_NODISCARD std::size_t count_all() const;

    App *group(std::string group_name) {
        group_ = group_name;
        return this;
    }

    App *require_subcommand() {
        require_subcommand_min_ = 1;
        require_subcommand_max_ = 0;
        return this;
    }

    App *require_subcommand(int value) {
        if(value < 0) {
            require_subcommand_min_ = 0;
            require_subcommand_max_ = static_cast<std::size_t>(-value);
        } else {
            require_subcommand_min_ = static_cast<std::size_t>(value);
            require_subcommand_max_ = static_cast<std::size_t>(value);
        }
        return this;
    }

    App *require_subcommand(std::size_t min, std::size_t max) {
        require_subcommand_min_ = min;
        require_subcommand_max_ = max;
        return this;
    }

    App *require_option() {
        require_option_min_ = 1;
        require_option_max_ = 0;
        return this;
    }

    App *require_option(int value) {
        if(value < 0) {
            require_option_min_ = 0;
            require_option_max_ = static_cast<std::size_t>(-value);
        } else {
            require_option_min_ = static_cast<std::size_t>(value);
            require_option_max_ = static_cast<std::size_t>(value);
        }
        return this;
    }

    App *require_option(std::size_t min, std::size_t max) {
        require_option_min_ = min;
        require_option_max_ = max;
        return this;
    }

    App *fallthrough(bool value = true) {
        fallthrough_ = value;
        return this;
    }

    App *subcommand_fallthrough(bool value = true) {
        subcommand_fallthrough_ = value;
        return this;
    }

    explicit operator bool() const { return parsed_ > 0; }


    virtual void pre_callback() {}

    //
    void clear();

    void parse(int argc, const char *const *argv);
    void parse(int argc, const wchar_t *const *argv);

  private:
    template <class CharT> void parse_char_t(int argc, const CharT *const *argv);

  public:
    void parse(std::string commandline, bool program_name_included = false);
    void parse(std::wstring commandline, bool program_name_included = false);

    void parse(std::vector<std::string> &args);

    void parse(std::vector<std::string> &&args);

    void parse_from_stream(std::istream &input);

    void failure_message(std::function<std::string(const App *, const Error &e)> function) {
        failure_message_ = function;
    }

    int exit(const Error &e, std::ostream &out = std::cout, std::ostream &err = std::cerr) const;


    CLI11_NODISCARD std::size_t count(std::string option_name) const { return get_option(option_name)->count(); }

    CLI11_NODISCARD std::vector<App *> get_subcommands() const { return parsed_subcommands_; }

    std::vector<const App *> get_subcommands(const std::function<bool(const App *)> &filter) const;

    std::vector<App *> get_subcommands(const std::function<bool(App *)> &filter);

    bool got_subcommand(const App *subcom) const {
        // get subcom needed to verify that this was a real subcommand
        return get_subcommand(subcom)->parsed_ > 0;
    }

    CLI11_NODISCARD bool got_subcommand(std::string subcommand_name) const noexcept {
        App *sub = get_subcommand_no_throw(subcommand_name);
        return (sub != nullptr) ? (sub->parsed_ > 0) : false;
    }

    App *excludes(Option *opt) {
        if(opt == nullptr) {
            throw OptionNotFound("nullptr passed");
        }
        exclude_options_.insert(opt);
        return this;
    }

    App *excludes(App *app) {
        if(app == nullptr) {
            throw OptionNotFound("nullptr passed");
        }
        if(app == this) {
            throw OptionNotFound("cannot self reference in needs");
        }
        auto res = exclude_subcommands_.insert(app);
        // subcommand exclusion should be symmetric
        if(res.second) {
            app->exclude_subcommands_.insert(this);
        }
        return this;
    }

    App *needs(Option *opt) {
        if(opt == nullptr) {
            throw OptionNotFound("nullptr passed");
        }
        need_options_.insert(opt);
        return this;
    }

    App *needs(App *app) {
        if(app == nullptr) {
            throw OptionNotFound("nullptr passed");
        }
        if(app == this) {
            throw OptionNotFound("cannot self reference in needs");
        }
        need_subcommands_.insert(app);
        return this;
    }

    bool remove_excludes(Option *opt);

    bool remove_excludes(App *app);

    bool remove_needs(Option *opt);

    bool remove_needs(App *app);

    App *usage(std::string usage_string) {
        usage_ = std::move(usage_string);
        return this;
    }
    App *usage(std::function<std::string()> usage_function) {
        usage_callback_ = std::move(usage_function);
        return this;
    }
    App *footer(std::string footer_string) {
        footer_ = std::move(footer_string);
        return this;
    }
    App *footer(std::function<std::string()> footer_function) {
        footer_callback_ = std::move(footer_function);
        return this;
    }
    CLI11_NODISCARD std::string config_to_str(bool default_also = false, bool write_description = false) const {
        return config_formatter_->to_config(this, default_also, write_description, "");
    }

    CLI11_NODISCARD std::string help(std::string prev = "", AppFormatMode mode = AppFormatMode::Normal) const;

    CLI11_NODISCARD std::string version() const;

    CLI11_NODISCARD std::shared_ptr<FormatterBase> get_formatter() const { return formatter_; }

    CLI11_NODISCARD std::shared_ptr<Config> get_config_formatter() const { return config_formatter_; }

    CLI11_NODISCARD std::shared_ptr<ConfigBase> get_config_formatter_base() const {
        // This is safer as a dynamic_cast if we have RTTI, as Config -> ConfigBase
#if CLI11_USE_STATIC_RTTI == 0
        return std::dynamic_pointer_cast<ConfigBase>(config_formatter_);
#else
        return std::static_pointer_cast<ConfigBase>(config_formatter_);
#endif
    }

    CLI11_NODISCARD std::string get_description() const { return description_; }

    App *description(std::string app_description) {
        description_ = std::move(app_description);
        return this;
    }

    std::vector<const Option *> get_options(const std::function<bool(const Option *)> filter = {}) const;

    std::vector<Option *> get_options(const std::function<bool(Option *)> filter = {});

    CLI11_NODISCARD Option *get_option_no_throw(std::string option_name) noexcept;

    CLI11_NODISCARD const Option *get_option_no_throw(std::string option_name) const noexcept;

    CLI11_NODISCARD const Option *get_option(std::string option_name) const {
        const auto *opt = get_option_no_throw(option_name);
        if(opt == nullptr) {
            throw OptionNotFound(option_name);
        }
        return opt;
    }

    CLI11_NODISCARD Option *get_option(std::string option_name) {
        auto *opt = get_option_no_throw(option_name);
        if(opt == nullptr) {
            throw OptionNotFound(option_name);
        }
        return opt;
    }

    const Option *operator[](const std::string &option_name) const { return get_option(option_name); }

    const Option *operator[](const char *option_name) const { return get_option(option_name); }

    CLI11_NODISCARD bool get_ignore_case() const { return ignore_case_; }

    CLI11_NODISCARD bool get_ignore_underscore() const { return ignore_underscore_; }

    CLI11_NODISCARD bool get_fallthrough() const { return fallthrough_; }

    CLI11_NODISCARD bool get_subcommand_fallthrough() const { return subcommand_fallthrough_; }

    CLI11_NODISCARD bool get_allow_windows_style_options() const { return allow_windows_style_options_; }

    CLI11_NODISCARD bool get_positionals_at_end() const { return positionals_at_end_; }

    CLI11_NODISCARD bool get_configurable() const { return configurable_; }

    CLI11_NODISCARD const std::string &get_group() const { return group_; }

    CLI11_NODISCARD std::string get_usage() const {
        return (usage_callback_) ? usage_callback_() + '\n' + usage_ : usage_;
    }

    CLI11_NODISCARD std::string get_footer() const {
        return (footer_callback_) ? footer_callback_() + '\n' + footer_ : footer_;
    }

    CLI11_NODISCARD std::size_t get_require_subcommand_min() const { return require_subcommand_min_; }

    CLI11_NODISCARD std::size_t get_require_subcommand_max() const { return require_subcommand_max_; }

    CLI11_NODISCARD std::size_t get_require_option_min() const { return require_option_min_; }

    CLI11_NODISCARD std::size_t get_require_option_max() const { return require_option_max_; }

    CLI11_NODISCARD bool get_prefix_command() const { return static_cast<bool>(prefix_command_); }

    CLI11_NODISCARD PrefixCommandMode get_prefix_command_mode() const { return prefix_command_; }

    CLI11_NODISCARD bool get_allow_extras() const { return allow_extras_ > ExtrasMode::Ignore; }

    CLI11_NODISCARD ExtrasMode get_allow_extras_mode() const { return allow_extras_; }

    CLI11_NODISCARD bool get_required() const { return required_; }

    CLI11_NODISCARD bool get_disabled() const { return disabled_; }

    CLI11_NODISCARD bool get_silent() const { return silent_; }

    CLI11_NODISCARD bool get_allow_non_standard_option_names() const { return allow_non_standard_options_; }

    CLI11_NODISCARD bool get_allow_subcommand_prefix_matching() const { return allow_prefix_matching_; }

    CLI11_NODISCARD bool get_immediate_callback() const { return immediate_callback_; }

    CLI11_NODISCARD bool get_disabled_by_default() const { return (default_startup == startup_mode::disabled); }

    CLI11_NODISCARD bool get_enabled_by_default() const { return (default_startup == startup_mode::enabled); }
    CLI11_NODISCARD bool get_validate_positionals() const { return validate_positionals_; }
    CLI11_NODISCARD bool get_validate_optional_arguments() const { return validate_optional_arguments_; }

    CLI11_NODISCARD config_extras_mode get_allow_config_extras() const {
        return static_cast<config_extras_mode>(allow_config_extras_);
    }

    Option *get_help_ptr() { return help_ptr_; }

    CLI11_NODISCARD const Option *get_help_ptr() const { return help_ptr_; }

    CLI11_NODISCARD const Option *get_help_all_ptr() const { return help_all_ptr_; }

    Option *get_config_ptr() { return config_ptr_; }

    CLI11_NODISCARD const Option *get_config_ptr() const { return config_ptr_; }

    Option *get_version_ptr() { return version_ptr_; }

    CLI11_NODISCARD const Option *get_version_ptr() const { return version_ptr_; }

    App *get_parent() { return parent_; }

    CLI11_NODISCARD const App *get_parent() const { return parent_; }

    CLI11_NODISCARD const std::string &get_name() const { return name_; }

    CLI11_NODISCARD const std::vector<std::string> &get_aliases() const { return aliases_; }

    App *clear_aliases() {
        aliases_.clear();
        return this;
    }

    CLI11_NODISCARD std::string get_display_name(bool with_aliases = false) const;

    CLI11_NODISCARD bool check_name(std::string name_to_check) const;

    enum class NameMatch : std::uint8_t { none = 0, exact = 1, prefix = 2 };

    CLI11_NODISCARD NameMatch check_name_detail(std::string name_to_check) const;

    CLI11_NODISCARD std::vector<std::string> get_groups() const;

    CLI11_NODISCARD const std::vector<Option *> &parse_order() const { return parse_order_; }

    CLI11_NODISCARD std::vector<std::string> remaining(bool recurse = false) const;

    CLI11_NODISCARD std::vector<std::string> remaining_for_passthrough(bool recurse = false) const;

    CLI11_NODISCARD std::size_t remaining_size(bool recurse = false) const;


  protected:
    void _validate() const;

    void _configure();

    void run_callback(bool final_mode = false, bool suppress_final_callback = false);

    CLI11_NODISCARD bool _valid_subcommand(const std::string &current, bool ignore_used = true) const;

    CLI11_NODISCARD detail::Classifier _recognize(const std::string &current,
                                                  bool ignore_used_subcommands = true) const;

    // The parse function is now broken into several parts, and part of process

    void _process_config_file();

    bool _process_config_file(const std::string &config_file, bool throw_error);

    void _process_env();

    void _process_callbacks(CallbackPriority priority);

    void _process_help_flags(CallbackPriority priority, bool trigger_help = false, bool trigger_all_help = false) const;

    void _process_requirements();

    void _process();

    void _process_extras();

    void increment_parsed();

    void _parse(std::vector<std::string> &args);

    void _parse(std::vector<std::string> &&args);

    void _parse_stream(std::istream &input);

    void _parse_config(const std::vector<ConfigItem> &args);

    bool _parse_single_config(const ConfigItem &item, std::size_t level = 0);

    bool _add_flag_like_result(Option *op, const ConfigItem &item, const std::vector<std::string> &inputs);

    bool _parse_single(std::vector<std::string> &args, bool &positional_only);

    CLI11_NODISCARD std::size_t _count_remaining_positionals(bool required_only = false) const;

    CLI11_NODISCARD bool _has_remaining_positionals() const;

    bool _parse_positional(std::vector<std::string> &args, bool haltOnSubcommand);

    CLI11_NODISCARD App *
    _find_subcommand(const std::string &subc_name, bool ignore_disabled, bool ignore_used) const noexcept;

    bool _parse_subcommand(std::vector<std::string> &args);

    bool _parse_arg(std::vector<std::string> &args, detail::Classifier current_type, bool local_processing_only);

    void _trigger_pre_parse(std::size_t remaining_args);

    CLI11_NODISCARD App *_get_fallthrough_parent() noexcept;

    CLI11_NODISCARD const App *_get_fallthrough_parent() const noexcept;

    CLI11_NODISCARD const std::string &_compare_subcommand_names(const App &subcom, const App &base) const;

    void _move_to_missing(detail::Classifier val_type, const std::string &val);

  public:
    void _move_option(Option *opt, App *app);
};  // namespace CLI

class Option_group : public App {
  public:
    Option_group(std::string group_description, std::string group_name, App *parent)
        : App(std::move(group_description), "", parent) {
        group(group_name);
        // option groups should have automatic fallthrough
        if(group_name.empty() || group_name.front() == '+') {
            // help will not be used by default in these contexts
            set_help_flag("");
            set_help_all_flag("");
        }
    }
    using App::add_option;
    Option *add_option(Option *opt) {
        if(get_parent() == nullptr) {
            throw OptionNotFound("Unable to locate the specified option");
        }
        get_parent()->_move_option(opt, this);
        return opt;
    }
    void add_options(Option *opt) { add_option(opt); }
    template <typename... Args> void add_options(Option *opt, Args... args) {
        add_option(opt);
        add_options(args...);
    }
    using App::add_subcommand;
    App *add_subcommand(App *subcom) {
        App_p subc = subcom->get_parent()->get_subcommand_ptr(subcom);
        subc->get_parent()->remove_subcommand(subcom);
        add_subcommand(std::move(subc));
        return subcom;
    }
};

CLI11_INLINE void TriggerOn(App *trigger_app, App *app_to_enable);

CLI11_INLINE void TriggerOn(App *trigger_app, std::vector<App *> apps_to_enable);

CLI11_INLINE void TriggerOff(App *trigger_app, App *app_to_enable);

CLI11_INLINE void TriggerOff(App *trigger_app, std::vector<App *> apps_to_enable);

CLI11_INLINE void deprecate_option(Option *opt, const std::string &replacement = "");

inline void deprecate_option(App *app, const std::string &option_name, const std::string &replacement = "") {
    auto *opt = app->get_option(option_name);
    deprecate_option(opt, replacement);
}

inline void deprecate_option(App &app, const std::string &option_name, const std::string &replacement = "") {
    auto *opt = app.get_option(option_name);
    deprecate_option(opt, replacement);
}

CLI11_INLINE void retire_option(App *app, Option *opt);

CLI11_INLINE void retire_option(App &app, Option *opt);

CLI11_INLINE void retire_option(App *app, const std::string &option_name);

CLI11_INLINE void retire_option(App &app, const std::string &option_name);

namespace detail {
struct AppFriend {
#ifdef CLI11_CPP14

    template <typename... Args> static decltype(auto) parse_arg(App *app, Args &&...args) {
        return app->_parse_arg(std::forward<Args>(args)...);
    }

    template <typename... Args> static decltype(auto) parse_subcommand(App *app, Args &&...args) {
        return app->_parse_subcommand(std::forward<Args>(args)...);
    }
#else
    template <typename... Args>
    static auto parse_arg(App *app, Args &&...args) ->
        typename std::result_of<decltype (&App::_parse_arg)(App, Args...)>::type {
        return app->_parse_arg(std::forward<Args>(args)...);
    }

    template <typename... Args>
    static auto parse_subcommand(App *app, Args &&...args) ->
        typename std::result_of<decltype (&App::_parse_subcommand)(App, Args...)>::type {
        return app->_parse_subcommand(std::forward<Args>(args)...);
    }
#endif
    static App *get_fallthrough_parent(App *app) { return app->_get_fallthrough_parent(); }

    static const App *get_fallthrough_parent(const App *app) { return app->_get_fallthrough_parent(); }
};
}  // namespace detail

// [CLI11:app_hpp:end]
}  // namespace CLI

#ifndef CLI11_COMPILE
#include "impl/App_inl.hpp"  // IWYU pragma: export
#endif