ArenaMap.h

// Copyright (c) Stefano Cristiano
// SPDX-License-Identifier: MIT
#pragma once
#include "../Foundation/Assert.h"
#include "../Foundation/Globals.h"
#include "../Foundation/Memory.h"
#include "ArenaMapKey.h"
 
namespace SC
{
template <typename T>
struct ArenaMap;
} // namespace SC
 
 
template <typename T>
struct SC::ArenaMap
{
    using Key = ArenaMapKey<T>;
    using Gen = typename Key::Generation;
 
    ArenaMap(Globals::Type globalsType = Globals::Global) : globalsType(globalsType) {}
 
    ~ArenaMap() { clear(); }
 
    ArenaMap(const ArenaMap& other) : globalsType(other.globalsType) { *this = other; }
 
    ArenaMap(ArenaMap&& other) : globalsType(other.globalsType) { *this = move(other); }
 
    ArenaMap& operator=(const ArenaMap& other)
    {
        clear();
        auto& allocator = Globals::get(globalsType).allocator;
        T*    newItems  = reinterpret_cast<T*>(allocator.allocate(this, other.itemsSize * sizeof(T), alignof(T)));
        Gen*  newGens   = reinterpret_cast<Gen*>(allocator.allocate(this, other.itemsSize * sizeof(Gen), alignof(Gen)));
        SC_ASSERT_RELEASE(newItems);
        SC_ASSERT_RELEASE(newGens);
        ::memset(newGens, 0, other.itemsSize * sizeof(Gen));
        items       = newItems;
        generations = newGens;
        itemsSize   = other.itemsSize;
        for (size_t idx = 0; idx < other.itemsSize; ++idx)
        {
            if (other.generations[idx].used)
            {
                placementNew(items[idx], other.items[idx]);
            }
            generations[idx] = other.generations[idx];
        }
        numUsed = other.numUsed;
        return *this;
    }
 
    ArenaMap& operator=(ArenaMap&& other)
    {
        clear();
        items             = other.items;
        itemsSize         = other.itemsSize;
        other.items       = nullptr;
        other.itemsSize   = 0;
        generations       = other.generations;
        other.generations = nullptr;
        numUsed           = other.numUsed;
        other.numUsed     = 0;
        return *this;
    }
 
    uint32_t getNumAllocated() const { return static_cast<uint32_t>(itemsSize); }
 
    template <typename MapType>
    struct ArenaMapIterator
    {
        MapType* map   = nullptr;
        uint32_t index = 0;
 
        void operator++()
        {
            const auto numAllocated = map->getNumAllocated();
            for (++index; index < numAllocated; ++index)
            {
                if (map->generations[index].used)
                {
                    break;
                }
            }
        }
 
        bool operator==(ArenaMapIterator it) const
        {
            SC_ASSERT_DEBUG(it.map == map and map != nullptr);
            return it.index == index;
        }
        bool operator!=(ArenaMapIterator it) const
        {
            SC_ASSERT_DEBUG(it.map == map and map != nullptr);
            return it.index != index;
        }
 
        auto& operator*() const { return map->items[index]; }
        auto* operator->() const { return &map->items[index]; }
    };
    using ConstIterator = ArenaMapIterator<const ArenaMap>;
    using Iterator      = ArenaMapIterator<ArenaMap>;
 
    ConstIterator cbegin() const { return begin(); }
    ConstIterator cend() const { return end(); }
    ConstIterator begin() const
    {
        for (size_t idx = 0; idx < getNumAllocated(); ++idx)
        {
            if (generations[idx].used)
            {
                return {this, static_cast<uint32_t>(idx)};
            }
        }
        return end();
    }
 
    ConstIterator end() const { return {this, getNumAllocated()}; }
 
    Iterator begin()
    {
        for (size_t idx = 0; idx < getNumAllocated(); ++idx)
        {
            if (generations[idx].used)
            {
                return {this, static_cast<uint32_t>(idx)};
            }
        }
        return end();
    }
 
    Iterator end() { return {this, getNumAllocated()}; }
 
    void clear()
    {
        for (size_t idx = 0; idx < itemsSize; ++idx)
        {
            if (generations[idx].used)
            {
                items[idx].~T();
            }
            generations[idx].used = 0;
        }
        Globals::get(globalsType).allocator.release(items);
        items     = nullptr;
        itemsSize = 0;
        Globals::get(globalsType).allocator.release(generations);
        generations = nullptr;
        numUsed     = 0;
    }
 
    [[nodiscard]] size_t size() const { return numUsed; }
 
    [[nodiscard]] size_t capacity() const { return itemsSize; }
 
    [[nodiscard]] bool isFull() const { return itemsSize == numUsed; }
 
    [[nodiscard]] bool resize(size_t newSize)
    {
        if (numUsed != 0)
            return false;
        if (newSize > Key::MaxIndex)
            return false;
 
        Globals::get(globalsType).allocator.release(items);
        items = nullptr;
        Globals::get(globalsType).allocator.release(generations);
        generations     = nullptr;
        auto& allocator = Globals::get(globalsType).allocator;
        T*    newItems  = reinterpret_cast<T*>(allocator.allocate(this, newSize * sizeof(T), alignof(T)));
        if (newItems == nullptr)
            return false;
        items        = newItems;
        Gen* newGens = reinterpret_cast<Gen*>(allocator.allocate(this, newSize * sizeof(Gen), alignof(Gen)));
        if (newGens == nullptr)
            return false;
        ::memset(newGens, 0, newSize * sizeof(Gen));
        generations = newGens;
        itemsSize   = newSize;
        numUsed     = 0;
        return true;
    }
 
    template <typename Value>
    [[nodiscard]] Key insert(const Value& object)
    {
        Key key = allocateNewKeySlot();
        if (key.isValid())
        {
            placementNew(items[key.index], object);
        }
        return key;
    }
 
    [[nodiscard]] Key allocate()
    {
        Key key = allocateNewKeySlot();
        if (key.isValid())
        {
            placementNew(items[key.index]);
        }
        return key;
    }
 
    template <typename Value>
    [[nodiscard]] Key insert(Value&& object)
    {
        Key key = allocateNewKeySlot();
        if (key.isValid())
        {
            placementNew(items[key.index], move(object));
        }
        return key;
    }
 
    [[nodiscard]] bool containsKey(Key key) const
    {
        return key.isValid() and generations[key.index].used != 0 and
               generations[key.index].generation == key.generation.generation;
    }
 
    template <typename ComparableToValue>
    [[nodiscard]] bool containsValue(const ComparableToValue& value, Key* optionalKey = nullptr) const
    {
        for (size_t idx = 0; idx < itemsSize; ++idx)
        {
            if (generations[idx].used and items[idx] == value)
            {
                if (optionalKey)
                {
                    optionalKey->index      = static_cast<uint32_t>(idx);
                    optionalKey->generation = generations[idx];
                }
                return true;
            }
        }
        return false;
    }
 
    [[nodiscard]] bool remove(Key key)
    {
        if (generations[key.index] != key.generation)
            return false;
        if (generations[key.index].generation + 1 <= Key::MaxGenerations)
        {
            generations[key.index].generation++;
        }
        else
        {
            // TODO: Should we give option of failing on generation overflow?
            generations[key.index].generation++;
        }
        generations[key.index].used = 0;
        items[key.index].~T();
        numUsed--;
        return true;
    }
 
    [[nodiscard]] T* get(Key key)
    {
        if (generations[key.index] != key.generation)
            return nullptr;
        return &items[key.index];
    }
 
    [[nodiscard]] const T* get(Key key) const
    {
        if (generations[key.index] != key.generation)
            return nullptr;
        return &items[key.index];
    }
 
  private:
    T*     items     = nullptr;
    size_t itemsSize = 0;
 
    Gen* generations = nullptr;
 
    uint32_t numUsed = 0;
 
    Globals::Type globalsType;
 
    [[nodiscard]] Key allocateNewKeySlot()
    {
        for (size_t idx = 0; idx < itemsSize; ++idx)
        {
            if (generations[idx].used == 0)
            {
                generations[idx].used = 1;
 
                Key key;
                key.generation = generations[idx];
                key.index      = static_cast<uint32_t>(idx);
                numUsed++;
                return key;
            }
        }
        return {};
    }
};