enum_metadata.hpp

// Copyright Take Vos 2021-2022.
// Distributed under the Boost Software License, Version 1.0.
// (See accompanying file LICENSE_1_0.txt or copy at https://www.boost.org/LICENSE_1_0.txt)
 
#pragma once
 
#include "../macros.hpp"
#include "cast.hpp"
#include "terminate.hpp"
#include "exception.hpp"
#include <cstddef>
#include <type_traits>
#include <array>
#include <algorithm>
#include <string_view>
#include <stdexcept>
#include <concepts>
 
hi_export_module(hikogui.utility.enum_metadata);
 
hi_warning_push();
// C26445: Do not assign gsl::span or std::string_view to a reference. They are cheap to construct and are not owners of
// the underlying data. (gsl.view).
// False positive, sometimes the template is instantiated with string_view, sometimes not.
hi_warning_ignore_msvc(26445);
 
hi_export namespace hi { inline namespace v1 {
 
template<typename ValueType, typename NameType, std::size_t N>
class enum_metadata {
public:
    using value_type = ValueType;
    using name_type = NameType;
 
    constexpr static std::size_t count = N;
 
    bool values_are_continues;
 
    static_assert(std::is_enum_v<value_type>, "value_type Must be an enum");
    static_assert(N != 0);
 
    [[nodiscard]] constexpr size_t size() const noexcept
    {
        return count;
    }
 
    [[nodiscard]] constexpr value_type minimum() const noexcept
    {
        return std::get<0>(_by_value).value;
    }
 
    [[nodiscard]] constexpr value_type maximum() const noexcept
    {
        return std::get<N - 1>(_by_value).value;
    }
 
    template<typename... Args>
    [[nodiscard]] constexpr enum_metadata(Args const&...args) noexcept
    {
        static_assert(sizeof...(Args) == N * 2);
        add_value_name<0>(args...);
 
        std::sort(_by_name.begin(), _by_name.end(), [](auto const& a, auto const& b) {
            return a.name < b.name;
        });
 
        std::sort(_by_value.begin(), _by_value.end(), [](auto const& a, auto const& b) {
            return std::to_underlying(a.value) < std::to_underlying(b.value);
        });
 
        values_are_continues = check_values_are_continues();
    }
 
    template<std::convertible_to<name_type> Name>
    [[nodiscard]] constexpr bool contains(Name&& name) const noexcept
    {
        return find(name_type{std::forward<Name>(name)}) != nullptr;
    }
 
    [[nodiscard]] constexpr bool contains(value_type value) const noexcept
    {
        return find(value) != nullptr;
    }
 
    template<std::convertible_to<name_type> Name>
    [[nodiscard]] constexpr value_type at(Name&& name) const
    {
        if (auto const *value = find(name_type{std::forward<Name>(name)})) {
            return *value;
        } else {
            throw std::out_of_range{"enum_metadata::at"};
        }
    }
 
    [[nodiscard]] constexpr name_type const& at(value_type value) const
    {
        if (auto const *name = find(value)) {
            return *name;
        } else {
            throw std::out_of_range{"enum_metadata::at"};
        }
    }
 
    template<std::convertible_to<name_type> Name>
    [[nodiscard]] constexpr std::optional<value_type> at_if(Name&& name) const noexcept
    {
        if (auto const *value = find(name_type{std::forward<Name>(name)})) {
            return *value;
        } else {
            return std::nullopt;
        }
    }
 
    template<std::convertible_to<name_type> Name>
    [[nodiscard]] constexpr value_type at(Name&& name, value_type default_value) const noexcept
    {
        if (auto const *value = find(name_type{std::forward<Name>(name)})) {
            return *value;
        } else {
            return default_value;
        }
    }
 
    template<std::convertible_to<name_type> Name>
    [[nodiscard]] constexpr name_type at(value_type value, Name&& default_name) const noexcept
    {
        if (auto const *name = find(value)) {
            return *name;
        } else {
            return std::forward<Name>(default_name);
        }
    }
 
    template<std::convertible_to<name_type> Name>
    [[nodiscard]] constexpr value_type operator[](Name&& name) const noexcept
    {
        auto *value = find(name_type{std::forward<Name>(name)});
        hi_assert_not_null(value);
        return *value;
    }
 
    [[nodiscard]] constexpr name_type const& operator[](value_type value) const noexcept
    {
        auto *name = find(value);
        hi_assert_not_null(name);
        return *name;
    }
 
private:
    struct value_name {
        value_type value;
        name_type name;
 
        constexpr value_name() noexcept : value(), name() {}
        constexpr value_name(value_type value, name_type name) noexcept : value(value), name(std::move(name)) {}
    };
 
    std::array<value_name, N> _by_name;
    std::array<value_name, N> _by_value;
 
    [[nodiscard]] constexpr name_type const *find(value_type value) const noexcept
    {
        if (values_are_continues) {
            // If the enum values are continues we can do an associative lookup.
            auto const it = _by_value.begin();
            auto const offset = std::to_underlying(it->value);
            auto const i = std::to_underlying(value) - offset;
            return (i >= 0 and i < N) ? &(it + i)->name : nullptr;
 
        } else {
            auto const it = std::lower_bound(_by_value.begin(), _by_value.end(), value, [](auto const& item, auto const& key) {
                return item.value < key;
            });
 
            return (it != _by_value.end() and it->value == value) ? &it->name : nullptr;
        }
    }
 
    [[nodiscard]] constexpr value_type const *find(name_type const& name) const noexcept
    {
        auto const it = std::lower_bound(_by_name.begin(), _by_name.end(), name, [](auto const& item, auto const& key) {
            return item.name < key;
        });
 
        return (it != _by_name.end() and it->name == name) ? &it->value : nullptr;
    }
 
    template<std::size_t I, typename... Rest>
    constexpr void add_value_name(value_type value, name_type name, Rest const&...rest) noexcept
    {
        static_assert(sizeof...(Rest) % 2 == 0);
 
        std::get<I>(_by_name) = {value, name};
        std::get<I>(_by_value) = {value, std::move(name)};
 
        if constexpr (sizeof...(Rest) > 0) {
            add_value_name<I + 1>(rest...);
        }
    }
 
    [[nodiscard]] constexpr bool check_values_are_continues() const noexcept
    {
        auto check_value = std::to_underlying(minimum());
        for (auto const& item : _by_value) {
            if (std::to_underlying(item.value) != check_value++) {
                return false;
            }
        }
        return true;
    }
};
 
template<typename T>
struct enum_metadata_name {
    using type = std::decay_t<T>;
};
 
// clang-format off
template<> struct enum_metadata_name<char const *> { using type = std::string_view; };
template<> struct enum_metadata_name<char *> { using type = std::string_view; };
template<size_t N> struct enum_metadata_name<char [N]> { using type = std::string_view; };
template<size_t N> struct enum_metadata_name<char const [N]> { using type = std::string_view; };
// clang-format on
 
template<typename T>
using enum_metadata_name_t = enum_metadata_name<T>::type;
 
template<typename ValueType, typename NameType, typename... Rest>
enum_metadata(ValueType const&, NameType const&, Rest const&...)
    -> enum_metadata<ValueType, enum_metadata_name_t<NameType>, (sizeof...(Rest) + 2) / 2>;
 
}} // namespace hi::inline v1
 
hi_warning_pop();