command_handle.hpp

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2026 Klaus Reimer <k@ailis.de>
// SPDX-License-Identifier: MIT
 
#pragma once
 
#include <iostream>
#include <optional>
#include <string>
#include <string_view>
 
#include <kaycxx/cli/command.hpp>
 
namespace kaycxx::cli {
 
class command_handle {
public:
    [[nodiscard]] std::string const& name() const noexcept {
        return command_->name();
    }
 
    [[nodiscard]] std::optional<std::string> const& description() const noexcept {
        return command_->description();
    }
 
    [[nodiscard]] command_handle command(std::string_view name, std::optional<std::string_view> description = std::nullopt) {
        return command_->add_command(name, description);
    }
 
    [[nodiscard]] flag_handle flag(std::string_view name, std::optional<std::string_view> description = std::nullopt) {
        return command_->flag(name, description);
    }
 
    [[nodiscard]] flag_handle flag(std::string_view name, char alias, std::optional<std::string_view> description = std::nullopt) {
        return command_->flag(name, alias, description);
    }
 
    template <parseable_value T>
    [[nodiscard]] option_handle<T> option(
        std::string_view name,
        std::string_view value_name,
        std::optional<std::string_view> description = std::nullopt
    ) {
        return command_->option<T>(name, value_name, description);
    }
 
    template <parseable_value T>
    [[nodiscard]] option_handle<T> option(
        std::string_view name,
        char alias,
        std::string_view value_name,
        std::optional<std::string_view> description = std::nullopt
    ) {
        return command_->option<T>(name, alias, value_name, description);
    }
 
    template <parseable_value T>
    [[nodiscard]] repeatable_option_handle<T> repeatable_option(
        std::string_view name,
        std::string_view value_name,
        std::optional<std::string_view> description = std::nullopt
    ) {
        return command_->repeatable_option<T>(name, value_name, description);
    }
 
    template <parseable_value T>
    [[nodiscard]] 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
    ) {
        return command_->repeatable_option<T>(name, alias, value_name, description);
    }
 
    template <parseable_value T>
    [[nodiscard]] parameter_handle<T> parameter(std::string_view name, std::optional<std::string_view> description = std::nullopt) {
        return command_->parameter<T>(name, description);
    }
 
    template <parseable_value T>
    [[nodiscard]] parameters_handle<T> parameters(std::string_view name, std::optional<std::string_view> description = std::nullopt) {
        return command_->parameters<T>(name, description);
    }
 
    [[nodiscard]] args parse(int argc, char *argv[]) const {
        return command_->parse(argc, argv);
    }
 
    int print_help(std::ostream& out = std::cout) const {
        return command_->print_help(out);
    }
 
    int print_version(std::ostream& out = std::cout) const {
        return command_->print_version(out);
    }
 
private:
    friend class args;
    friend class command;
 
    explicit command_handle(kaycxx::cli::command& definition) noexcept
        : command_(&definition)
    {}
 
    kaycxx::cli::command* command_;
};
 
} // namespace kaycxx::cli