Files
lix/lix/libcmd/enum-traits.hh
T
Raito Bezarius 135c28be53 libcmd: introduce enum traits for CLI parsing
Parsing and completing enumerations on the CLI was usually done by hand.

With this enum trait, the parsing and completion is automated away.

Change-Id: Icd49729564355d4c79e2c8050ce7e8b9d8e7eda3
Signed-off-by: Raito Bezarius <raito@lix.systems>
2026-03-03 20:54:08 +00:00

77 lines
1.9 KiB
C++

#pragma once
///@file
#include <string_view>
#include <type_traits>
#include <utility>
#include <optional>
#include <ranges>
#include "lix/libutil/args.hh"
namespace nix::cli {
template<typename Enum>
struct enum_cli_traits;
template<typename Enum>
constexpr std::string_view toString(Enum value)
{
for (const auto & [name, val] : enum_cli_traits<Enum>::values) {
if (val == value) {
return name;
}
}
std::terminate();
}
template<typename Enum>
std::optional<Enum> fromString(std::string_view str)
{
for (const auto & [name, val] : enum_cli_traits<Enum>::values) {
if (name == str) {
return val;
}
}
return std::nullopt;
}
template<typename Enum>
void completeAmongEnumChoices(AddCompletions & completions, size_t, std::string_view prefix)
{
for (const auto & [name, _] : enum_cli_traits<Enum>::values) {
if (name.starts_with(prefix)) {
completions.add(name);
}
}
}
template<typename Enum>
Enum parseEnumArg(std::string text)
{
auto valueOpt = fromString<Enum>(text);
if (valueOpt) {
return *valueOpt;
} else {
auto names = std::ranges::views::keys(enum_cli_traits<Enum>::values)
| std::ranges::to<std::set<std::string>>();
auto suggestions = Suggestions::bestMatches(names, text);
throw UsageError(suggestions, "'%s' is not a recognised '%s'", text, enum_cli_traits<Enum>::typeName);
}
}
template<typename Enum>
std::optional<Enum> parseOptionalEnumArg(std::string text)
{
auto target = fromString<Enum>(text);
if (!target && text != "") {
auto names = std::ranges::views::keys(enum_cli_traits<Enum>::values) | std::ranges::to<std::set>();
auto suggestions = Suggestions::bestMatches(names, text);
throw UsageError(suggestions, "'%s' is not a recognised '%s'", text, enum_cli_traits<Enum>::typeName);
}
return target;
}
}