switch_base.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>
 
namespace kaycxx::cli {
 
class switch_base {
public:
    explicit switch_base(std::string_view name, std::optional<std::string_view> description = std::nullopt);
 
    explicit switch_base(std::string_view name, char alias, std::optional<std::string_view> description = std::nullopt);
 
    virtual ~switch_base() = default;
 
    [[nodiscard]] std::string const& name() const noexcept;
 
    [[nodiscard]] std::optional<char> alias() const noexcept;
 
    [[nodiscard]] std::optional<std::string> const& description() const noexcept;
 
    void mark_as_action() noexcept;
 
    [[nodiscard]] bool is_action() const noexcept;
 
    [[nodiscard]] virtual std::string usage() const = 0;
 
    [[nodiscard]] virtual bool expects_value() const noexcept = 0;
 
private:
    std::string name_;
 
    std::optional<char> alias_;
 
    std::optional<std::string> description_;
 
    bool action_ = false;
};
 
} // namespace kaycxx::cli