parameter_base.hpp

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2026 Klaus Reimer <k@ailis.de>
// SPDX-License-Identifier: MIT
 
#pragma once
 
#include <any>
#include <cstddef>
#include <optional>
#include <span>
#include <string>
#include <string_view>
 
namespace kaycxx::cli {
 
class parameter_base {
public:
    explicit parameter_base(std::string_view name, std::optional<std::string_view> description = std::nullopt);
 
    virtual ~parameter_base() = default;
 
    [[nodiscard]] std::string const& name() const noexcept;
 
    [[nodiscard]] std::optional<std::string> const& description() const noexcept;
 
    [[nodiscard]] std::optional<std::string> const& default_value_text() const noexcept;
 
    [[nodiscard]] virtual std::string usage() const = 0;
 
    [[nodiscard]] virtual std::size_t min_count() const noexcept = 0;
 
    [[nodiscard]] virtual std::size_t max_count() const noexcept = 0;
 
    [[nodiscard]] virtual std::any parse_values(std::span<std::string_view const> values) const = 0;
 
protected:
    void default_value_text(std::string text);
 
private:
    std::string name_;
 
    std::optional<std::string> description_;
 
    std::optional<std::string> default_value_text_;
};
 
} // namespace kaycxx::cli