packable_tile.hpp

Go to the documentation of this file.

#pragma once
 
#include <compare>
#include <cstddef>
#include <string>
#include <variant>
 
#include "porytiles/domain/models/color_set.hpp"
#include "porytiles/utilities/panic/panic.hpp"
 
namespace porytiles {
 
class PackableTile {
  public:
    struct HintId {
        std::string name;
        [[nodiscard]] auto operator<=>(const HintId &) const = default;
        [[nodiscard]] bool operator==(const HintId &) const = default;
    };
 
    class PrefilledPaletteId {
      public:
        static constexpr std::size_t max_index = 15;
 
        explicit PrefilledPaletteId(std::size_t index) : index_{index}
        {
            if (index > max_index) {
                panic(
                    "PrefilledPaletteId index out of range: " + std::to_string(index) + " > " +
                    std::to_string(max_index));
            }
        }
 
        [[nodiscard]] std::size_t index() const
        {
            return index_;
        }
 
        [[nodiscard]] auto operator<=>(const PrefilledPaletteId &) const = default;
        [[nodiscard]] bool operator==(const PrefilledPaletteId &) const = default;
 
      private:
        std::size_t index_;
    };
 
    struct AnimId {
        std::string name;
        std::size_t subtile_index;
        [[nodiscard]] auto operator<=>(const AnimId &) const = default;
        [[nodiscard]] bool operator==(const AnimId &) const = default;
    };
 
    struct RegularId {
        std::size_t index;
        [[nodiscard]] auto operator<=>(const RegularId &) const = default;
        [[nodiscard]] bool operator==(const RegularId &) const = default;
    };
 
    struct PrimaryTileId {
        std::size_t tile_index;
        std::size_t pal_index;
        [[nodiscard]] auto operator<=>(const PrimaryTileId &) const = default;
        [[nodiscard]] bool operator==(const PrimaryTileId &) const = default;
    };
 
    using Id = std::variant<HintId, PrefilledPaletteId, RegularId, AnimId, PrimaryTileId>;
 
    PackableTile(HintId id, ColorSet color_set);
 
    PackableTile(PrefilledPaletteId id, ColorSet color_set);
 
    PackableTile(RegularId id, ColorSet color_set);
 
    PackableTile(AnimId id, ColorSet color_set);
 
    PackableTile(PrimaryTileId id, ColorSet color_set);
 
    PackableTile(Id id, ColorSet color_set);
 
    [[nodiscard]] const Id &id() const
    {
        return id_;
    }
 
    // @pre: is_hint() must be true
    [[nodiscard]] const std::string &hint_name() const;
 
    // @pre: is_prefilled_palette() must be true
    [[nodiscard]] std::size_t prefilled_index() const;
 
    // @pre: is_regular() must be true
    [[nodiscard]] std::size_t regular_index() const;
 
    [[nodiscard]] bool is_hint() const
    {
        return std::holds_alternative<HintId>(id_);
    }
 
    [[nodiscard]] bool is_prefilled_palette() const
    {
        return std::holds_alternative<PrefilledPaletteId>(id_);
    }
 
    [[nodiscard]] bool is_regular() const
    {
        return std::holds_alternative<RegularId>(id_);
    }
 
    [[nodiscard]] const ColorSet &color_set() const
    {
        return color_set_;
    }
 
    [[nodiscard]] std::size_t color_count() const;
 
    [[nodiscard]] auto operator<=>(const PackableTile &other) const
    {
        return id_ <=> other.id_;
    }
 
    [[nodiscard]] bool operator==(const PackableTile &other) const
    {
        return id_ == other.id_;
    }
 
  private:
    Id id_;
    ColorSet color_set_;
};
 
inline std::string to_string(const PackableTile::Id &id)
{
    return std::visit(
        []<typename IdVariant>(const IdVariant &value) -> std::string {
            using T = std::decay_t<IdVariant>;
            if constexpr (std::is_same_v<T, PackableTile::HintId>) {
                return "Hint(" + value.name + ")";
            }
            else if constexpr (std::is_same_v<T, PackableTile::PrefilledPaletteId>) {
                return "Prefilled(" + std::to_string(value.index()) + ")";
            }
            else if constexpr (std::is_same_v<T, PackableTile::RegularId>) {
                return "Regular(" + std::to_string(value.index) + ")";
            }
            else if constexpr (std::is_same_v<T, PackableTile::AnimId>) {
                return "Anim(" + value.name + ", " + std::to_string(value.subtile_index) + ")";
            }
            else if constexpr (std::is_same_v<T, PackableTile::PrimaryTileId>) {
                return "Primary(tile=" + std::to_string(value.tile_index) + ", pal=" + std::to_string(value.pal_index) +
                       ")";
            }
            else {
                static_assert(sizeof(T) == 0, "Unhandled PackableTile::Id variant alternative");
                panic("Unhandled PackableTile::Id variant alternative");
            }
        },
        id);
}
 
} // namespace porytiles
 
// Hash specializations for Id types (enables std::hash<PackableTile::Id>)
template <>
struct std::hash<porytiles::PackableTile::HintId> {
    std::size_t operator()(const porytiles::PackableTile::HintId &id) const noexcept
    {
        return std::hash<std::string>{}(id.name);
    }
};
 
template <>
struct std::hash<porytiles::PackableTile::PrefilledPaletteId> {
    std::size_t operator()(const porytiles::PackableTile::PrefilledPaletteId &id) const noexcept
    {
        return std::hash<std::size_t>{}(id.index());
    }
};
 
template <>
struct std::hash<porytiles::PackableTile::RegularId> {
    std::size_t operator()(const porytiles::PackableTile::RegularId &id) const noexcept
    {
        return std::hash<std::size_t>{}(id.index);
    }
};
 
template <>
struct std::hash<porytiles::PackableTile::AnimId> {
    std::size_t operator()(const porytiles::PackableTile::AnimId &id) const noexcept
    {
        // Hash combining via Boost's hash_combine formula: the magic constant 0x9e3779b9 is the golden ratio's
        // fractional part scaled to 32 bits, and the bit shifts spread bits to avoid collisions
        std::size_t seed = std::hash<std::string>{}(id.name);
        seed ^= std::hash<std::size_t>{}(id.subtile_index) + 0x9e3779b9 + (seed << 6) + (seed >> 2);
        return seed;
    }
};
 
template <>
struct std::hash<porytiles::PackableTile::PrimaryTileId> {
    std::size_t operator()(const porytiles::PackableTile::PrimaryTileId &id) const noexcept
    {
        std::size_t seed = std::hash<std::size_t>{}(id.tile_index);
        seed ^= std::hash<std::size_t>{}(id.pal_index) + 0x9e3779b9 + (seed << 6) + (seed >> 2);
        return seed;
    }
};