enum_serialization.h

Go to the documentation of this file.

// BSD 3-Clause License
// Copyright (c) 2025, 🍀☀🌕🌥 🌊
// See the LICENSE file in the project root for full license information.
 
#pragma once
 
#include <algorithm>
#include <array>
#include <cctype>
#include <span>
#include <string>
#include <string_view>
#include <type_traits>
#include <utility>
 
#include "../patterns/result.h"
 
namespace kcenon::common {
 
template<typename Enum>
struct enum_traits;
 
template<typename Enum>
concept EnumSerializable = std::is_enum_v<Enum> && requires {
    { enum_traits<Enum>::values } -> std::convertible_to<
        std::span<const std::pair<Enum, std::string_view>>>;
    { enum_traits<Enum>::module_name } -> std::convertible_to<std::string_view>;
};
 
template<EnumSerializable Enum>
[[nodiscard]] inline std::string enum_to_string(Enum value) {
    for (const auto& [e, s] : enum_traits<Enum>::values) {
        if (e == value) {
            return std::string(s);
        }
    }
    return "UNKNOWN";
}
 
template<EnumSerializable Enum>
[[nodiscard]] inline Result<Enum> enum_from_string(std::string_view str) {
    // Convert input to uppercase for case-insensitive comparison
    std::string upper(str.size(), '\0');
    std::transform(str.begin(), str.end(), upper.begin(),
                   [](unsigned char c) { return static_cast<char>(std::toupper(c)); });
 
    for (const auto& [e, s] : enum_traits<Enum>::values) {
        if (s == upper) {
            return Result<Enum>::ok(e);
        }
    }
 
    return Result<Enum>::err(
        error_info{1, "Invalid enum value: " + std::string(str),
                   std::string(enum_traits<Enum>::module_name)});
}
 
}  // namespace kcenon::common