command.hpp

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2026 Klaus Reimer <k@ailis.de>
// SPDX-License-Identifier: MIT
 
#pragma once
 
#include <cstddef>
#include <iostream>
#include <memory>
#include <optional>
#include <string>
#include <string_view>
#include <utility>
#include <vector>
 
#include <kaycxx/cli/args.hpp>
#include <kaycxx/cli/flag.hpp>
#include <kaycxx/cli/flag_handle.hpp>
#include <kaycxx/cli/option.hpp>
#include <kaycxx/cli/option_handle.hpp>
#include <kaycxx/cli/parameter.hpp>
#include <kaycxx/cli/parameter_base.hpp>
#include <kaycxx/cli/parameter_handle.hpp>
#include <kaycxx/cli/parameters.hpp>
#include <kaycxx/cli/parameters_handle.hpp>
#include <kaycxx/cli/repeatable_option_handle.hpp>
#include <kaycxx/cli/switch_base.hpp>
 
namespace kaycxx::cli {
 
class app;
class command_handle;
 
class command {
public:
    command(command const&) = delete;
 
    command& operator=(command const&) = delete;
 
    virtual ~command() = default;
 
    [[nodiscard]] std::string const& name() const noexcept;
 
    [[nodiscard]] std::optional<std::string> const& description() const noexcept;
 
    [[nodiscard]] cli::flag_handle flag(std::string_view name, std::optional<std::string_view> description = std::nullopt);
 
    [[nodiscard]] cli::flag_handle flag(std::string_view name, char alias, std::optional<std::string_view> description = std::nullopt);
 
    template <parseable_value T>
    [[nodiscard]] cli::option_handle<T> option(
        std::string_view name,
        std::string_view value_name,
        std::optional<std::string_view> description = std::nullopt
    ) {
        auto item = std::make_unique<cli::option<T>>(name, value_name, description);
        auto& definition = *item;
        add_switch(std::move(item));
        return cli::option_handle<T>(definition);
    }
 
    template <parseable_value T>
    [[nodiscard]] cli::option_handle<T> option(
        std::string_view name,
        char alias,
        std::string_view value_name,
        std::optional<std::string_view> description = std::nullopt
    ) {
        auto item = std::make_unique<cli::option<T>>(name, alias, value_name, description);
        auto& definition = *item;
        add_switch(std::move(item));
        return cli::option_handle<T>(definition);
    }
 
    template <parseable_value T>
    [[nodiscard]] cli::repeatable_option_handle<T> repeatable_option(
        std::string_view name,
        std::string_view value_name,
        std::optional<std::string_view> description = std::nullopt
    ) {
        auto item = std::make_unique<cli::option<T>>(name, value_name, description);
        item->mark_as_repeatable();
        auto& definition = *item;
        add_switch(std::move(item));
        return cli::repeatable_option_handle<T>(definition);
    }
 
    template <parseable_value T>
    [[nodiscard]] cli::repeatable_option_handle<T> repeatable_option(
        std::string_view name,
        char alias,
        std::string_view value_name,
        std::optional<std::string_view> description = std::nullopt
    ) {
        auto item = std::make_unique<cli::option<T>>(name, alias, value_name, description);
        item->mark_as_repeatable();
        auto& definition = *item;
        add_switch(std::move(item));
        return cli::repeatable_option_handle<T>(definition);
    }
 
    template <parseable_value T>
    [[nodiscard]] cli::parameter_handle<T> parameter(std::string_view name, std::optional<std::string_view> description = std::nullopt) {
        ensure_parameter_allowed();
        auto item = std::make_unique<cli::parameter<T>>(name, description);
        auto& definition = *item;
        parameters_.push_back(std::move(item));
        return cli::parameter_handle<T>(definition);
    }
 
    template <parseable_value T>
    [[nodiscard]] cli::parameters_handle<T> parameters(std::string_view name, std::optional<std::string_view> description = std::nullopt) {
        ensure_parameter_allowed();
        auto item = std::make_unique<cli::parameters<T>>(name, description);
        auto& definition = *item;
        parameters_.push_back(std::move(item));
        return cli::parameters_handle<T>(definition);
    }
 
    [[nodiscard]] cli::args parse(int argc, char *argv[]) const;
 
    int print_help(std::ostream& out = std::cout) const;
 
    int print_version(std::ostream& out = std::cout) const;
 
protected:
    command(std::string_view name, std::optional<std::string_view> description, command* parent);
 
    command(command&& other) noexcept;
 
    [[nodiscard]] command_handle add_command(std::string_view name, std::optional<std::string_view> description = std::nullopt);
 
private:
    class subcommand;
 
    friend class command_handle;
 
    [[nodiscard]] virtual app const& root() const noexcept = 0;
 
    void ensure_parameter_allowed() const;
 
    void add_switch(std::unique_ptr<switch_base> item);
 
    [[nodiscard]] switch_base const* find_switch(std::string_view name) const noexcept;
 
    [[nodiscard]] switch_base const* find_switch(char alias) const noexcept;
 
    [[nodiscard]] switch_base const* find_switch_in_descendants(std::string_view name) const noexcept;
 
    [[nodiscard]] switch_base const* find_switch_in_descendants(char alias) const noexcept;
 
    [[nodiscard]] command const* find_command(std::string_view name) const noexcept;
 
    [[nodiscard]] std::vector<switch_base const*> switches() const;
 
    [[nodiscard]] std::string usage_invocation() const;
 
    [[nodiscard]] std::size_t max_switch_usage_length() const;
 
    [[nodiscard]] std::size_t max_parameter_usage_length() const;
 
    [[nodiscard]] std::size_t max_command_name_length() const;
 
    void apply_option_defaults(args& result) const;
 
    void collect_required_options(args& result) const;
 
    std::string name_;
 
    std::string invocation_;
 
    std::optional<std::string> description_;
 
    command* parent_ = nullptr;
 
    std::vector<std::unique_ptr<switch_base>> switches_;
 
    std::vector<std::unique_ptr<parameter_base>> parameters_;
 
    std::vector<std::unique_ptr<command>> commands_;
};
 
} // namespace kaycxx::cli
 
#include <kaycxx/cli/command_handle.hpp>