app.hpp

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2026 Klaus Reimer <k@ailis.de>
// SPDX-License-Identifier: MIT
 
#pragma once
 
#include <optional>
#include <string>
#include <string_view>
 
#include <kaycxx/cli/command.hpp>
 
namespace kaycxx::cli {
 
struct app_options {
    std::optional<std::string_view> version = std::nullopt;
 
    std::optional<std::string_view> description = std::nullopt;
 
    std::optional<std::string_view> author = std::nullopt;
 
    std::optional<std::string_view> email = std::nullopt;
 
    std::optional<std::string_view> bugs = std::nullopt;
 
    std::optional<std::string_view> copyright = std::nullopt;
 
    std::optional<std::string_view> license = std::nullopt;
};
 
class app final : public command {
public:
    explicit app(std::string_view name, app_options options = app_options{});
 
    app(app const&) = delete;
 
    app& operator=(app const&) = delete;
 
    app(app&& other) noexcept;
 
    ~app() override = default;
 
    [[nodiscard]] std::optional<std::string> const& version() const noexcept;
 
    [[nodiscard]] std::optional<std::string> const& author() const noexcept;
 
    [[nodiscard]] std::optional<std::string> const& email() const noexcept;
 
    [[nodiscard]] std::optional<std::string> const& bugs() const noexcept;
 
    [[nodiscard]] std::optional<std::string> const& copyright() const noexcept;
 
    [[nodiscard]] std::optional<std::string> const& license() const noexcept;
 
    [[nodiscard]] command_handle command(std::string_view name, std::optional<std::string_view> description = std::nullopt);
 
private:
    [[nodiscard]] app const& root() const noexcept override;
 
    std::optional<std::string> version_;
 
    std::optional<std::string> author_;
 
    std::optional<std::string> email_;
 
    std::optional<std::string> bugs_;
 
    std::optional<std::string> copyright_;
 
    std::optional<std::string> license_;
};
 
} // namespace kaycxx::cli