IdentifiedObjectMap.hpp

#pragma once
#include <score/model/IdentifiedObject.hpp>
#include <score/tools/std/IndirectContainer.hpp>
 
#include <ossia/detail/hash_map.hpp>
 
#include <iterator>
#include <list>
#include <vector>
// This file contains a fast map for items based on their identifier,
// based on boost's multi-index maps.
 
template <class Element, class Model = Element, bool Order = false>
class IdContainer;
 
// We have to write two implementations since const_mem_fun does not handle
// inheritance.
 
template <typename Element, typename Model>
  requires std::is_base_of_v<IdentifiedObject<Model>, Element>
class IdContainer<Element, Model, true>
{
public:
  using model_type = Model;
  using order_t = std::list<Element*>;
  using map_t
      = ossia::hash_map<Id<Model>, std::pair<Element*, typename order_t::iterator>>;
  map_t m_map;
  order_t m_order;
 
  using value_type = Element;
  using iterator = score::indirect_iterator<typename order_t::iterator>;
  using const_iterator = score::indirect_iterator<typename order_t::const_iterator>;
  using const_reverse_iterator
      = score::indirect_iterator<typename order_t::const_reverse_iterator>;
 
  IdContainer() INLINE_EXPORT = default;
  IdContainer(const IdContainer& other) = delete;
  IdContainer(IdContainer&& other) noexcept = delete;
  IdContainer& operator=(const IdContainer& other) = delete;
  IdContainer& operator=(IdContainer&& other) = delete;
 
  ~IdContainer() INLINE_EXPORT
  {
    // To ensure that children are deleted before their parents
    for(auto elt : m_order)
    {
      delete elt;
    }
  }
 
  OSSIA_INLINE auto& ordered() INLINE_EXPORT { return m_order; }
 
  OSSIA_INLINE const_iterator begin() const INLINE_EXPORT
  {
    return score::make_indirect_iterator(this->m_order.begin());
  }
  OSSIA_INLINE const_reverse_iterator rbegin() const INLINE_EXPORT
  {
    return score::make_indirect_iterator(this->m_order.rbegin());
  }
  OSSIA_INLINE const_iterator cbegin() const INLINE_EXPORT
  {
    return score::make_indirect_iterator(this->m_order.cbegin());
  }
  OSSIA_INLINE const_iterator end() const INLINE_EXPORT
  {
    return score::make_indirect_iterator(this->m_order.end());
  }
  OSSIA_INLINE const_reverse_iterator rend() const INLINE_EXPORT
  {
    return score::make_indirect_iterator(this->m_order.rend());
  }
  OSSIA_INLINE const_iterator cend() const INLINE_EXPORT
  {
    return score::make_indirect_iterator(this->m_order.cend());
  }
 
  OSSIA_INLINE std::size_t size() const INLINE_EXPORT { return m_map.size(); }
 
  bool empty() const INLINE_EXPORT { return m_map.empty(); }
 
  std::vector<Element*> as_vec() const INLINE_EXPORT
  {
    return std::vector<Element*>(m_order.begin(), m_order.end());
  }
 
  score::IndirectContainer<Element> as_indirect_vec() const INLINE_EXPORT
  {
    return score::IndirectContainer<Element>(m_order.begin(), m_order.end());
  }
 
  void insert(value_type* t) INLINE_EXPORT
  {
    SCORE_ASSERT(m_map.find(t->id()) == m_map.end());
    m_order.push_back(t);
    m_map.insert({t->id(), {t, std::prev(m_order.end())}});
  }
 
  void remove(typename map_t::iterator it) INLINE_EXPORT
  {
    // No delete : it is done in EntityMap.
 
    if(it != this->m_map.end())
    {
      m_order.erase(it->second.second);
      m_map.erase(it);
    }
  }
  void remove(typename map_t::const_iterator it) INLINE_EXPORT
  {
    // No delete : it is done in EntityMap.
 
    if(it != this->m_map.end())
    {
      m_order.erase(it->second.second);
      m_map.erase(it);
    }
  }
 
  void remove(const Id<Model>& id) INLINE_EXPORT { remove(m_map.find(id)); }
 
  void clear() INLINE_EXPORT
  {
    m_map.clear();
    m_order.clear();
    // TODO why no delete ?!
    // e.g. in some cases (Curve::Model::clear()) it deletes afterwards
    // but not in Scenario destructor
  }
 
  const_iterator find(const Id<Model>& id) const INLINE_EXPORT
  {
    auto it = this->m_map.find(id);
    if(it != this->m_map.end())
    {
      return score::make_indirect_iterator(
          (typename order_t::const_iterator)it->second.second);
    }
    else
    {
      return score::make_indirect_iterator(this->m_order.end());
    }
  }
 
  Element& at(const Id<Model>& id) const INLINE_EXPORT
  {
    auto item = this->m_map.find(id);
    SCORE_ASSERT(item != this->m_map.end());
 
    id.m_ptr = item->second.first;
    return safe_cast<Element&>(*item->second.first);
  }
};
 
template <typename Element, typename Model>
  requires std::is_base_of_v<IdentifiedObject<Model>, Element>
class IdContainer<Element, Model, false>
{
public:
  using model_type = Model;
  using map_t = ossia::hash_map<Id<Model>, Element*>;
  map_t m_map;
 
  using value_type = Element;
  using iterator = score::indirect_map_iterator<typename map_t::iterator>;
  using const_iterator = score::indirect_map_iterator<typename map_t::const_iterator>;
  // using reverse_iterator = score::indirect_iterator<typename map_t::reverse_iterator>;
 
  IdContainer() INLINE_EXPORT = default;
  IdContainer(const IdContainer& other) = delete;
  IdContainer(IdContainer&& other) noexcept = delete;
  IdContainer& operator=(const IdContainer& other) = delete;
  IdContainer& operator=(IdContainer&& other) = delete;
 
  ~IdContainer() INLINE_EXPORT
  {
    // To ensure that children are deleted before their parents
    for(const auto& elt : m_map)
    {
      delete elt.second;
    }
  }
 
  OSSIA_INLINE const_iterator begin() const INLINE_EXPORT
  {
    return score::make_indirect_map_iterator(this->m_map.begin());
  }
  /*
  OSSIA_INLINE reverse_iterator rbegin() const INLINE_EXPORT
  {
    return score::make_indirect_map_iterator(this->m_map.rbegin());
  }
  */
  OSSIA_INLINE const_iterator cbegin() const INLINE_EXPORT
  {
    return score::make_indirect_map_iterator(this->m_map.cbegin());
  }
  OSSIA_INLINE const_iterator end() const INLINE_EXPORT
  {
    return score::make_indirect_map_iterator(this->m_map.end());
  }
  /*
  OSSIA_INLINE reverse_iterator rend() const INLINE_EXPORT
  {
    return score::make_indirect_map_iterator(this->m_map.rend());
  }
  */
  OSSIA_INLINE const_iterator cend() const INLINE_EXPORT
  {
    return score::make_indirect_map_iterator(this->m_map.cend());
  }
 
  OSSIA_INLINE std::size_t size() const INLINE_EXPORT { return m_map.size(); }
 
  OSSIA_INLINE bool empty() const INLINE_EXPORT { return m_map.empty(); }
 
  std::vector<Element*> as_vec() const INLINE_EXPORT
  {
    std::vector<Element*> e;
    e.reserve(m_map.size());
    for(auto& [key, val] : m_map)
    {
      e.push_back(val);
    }
    return e;
  }
 
  score::IndirectContainer<Element> as_indirect_vec() const INLINE_EXPORT
  {
    score::IndirectContainer<Element> e;
    e.reserve(m_map.size());
    for(auto& [key, val] : m_map)
    {
      e.push_back(val);
    }
    return e;
  }
 
  void insert(value_type* t) INLINE_EXPORT
  {
    SCORE_ASSERT(m_map.find(t->id()) == m_map.end());
    m_map.insert({t->id(), t});
  }
 
  void remove(typename map_t::iterator it) INLINE_EXPORT
  {
    // No delete : it is done in EntityMap.
    if(it != this->m_map.end())
    {
      m_map.erase(it);
    }
  }
  void remove(typename map_t::const_iterator it) INLINE_EXPORT
  {
    // No delete : it is done in EntityMap.
    if(it != this->m_map.end())
    {
      m_map.erase(it);
    }
  }
 
  void remove(const Id<Model>& id) INLINE_EXPORT { remove(m_map.find(id)); }
 
  void clear() INLINE_EXPORT
  {
    m_map.clear();
    // TODO why no delete ?!
    // e.g. in some cases (Curve::Model::clear()) it deletes afterwards
    // but not in Scenario destructor
  }
 
  const_iterator find(const Id<Model>& id) const INLINE_EXPORT
  {
    auto it = this->m_map.find(id);
    if(it != this->m_map.end())
    {
      return score::make_indirect_map_iterator(it);
    }
    else
    {
      return score::make_indirect_map_iterator(this->m_map.end());
    }
  }
 
  Element& at(const Id<Model>& id) const INLINE_EXPORT
  {
    auto item = this->m_map.find(id);
    SCORE_ASSERT(item != this->m_map.end());
 
    id.m_ptr = item->second;
    return safe_cast<Element&>(*item->second);
  }
};
 
template <typename Element, typename Model>
  requires(!std::is_base_of_v<IdentifiedObject<Model>, Element>)
class IdContainer<Element, Model, false>
{
public:
  using model_type = Model;
  ossia::hash_map<Id<Model>, Element*> m_map;
 
  std::vector<Element*> as_vec() const INLINE_EXPORT
  {
    std::vector<Element*> v;
    const auto N = m_map.size();
    v.reserve(N);
    for(auto& e : m_map)
    {
      v.push_back(e.second);
    }
    return v;
  }
 
  OSSIA_INLINE auto begin() const INLINE_EXPORT
  {
    return score::make_indirect_map_iterator(this->m_map.begin());
  }
  OSSIA_INLINE auto rbegin() const INLINE_EXPORT
  {
    return score::make_indirect_map_iterator(this->m_map.begin());
  }
  OSSIA_INLINE auto cbegin() const INLINE_EXPORT
  {
    return score::make_indirect_map_iterator(this->m_map.cbegin());
  }
  OSSIA_INLINE auto end() const INLINE_EXPORT
  {
    return score::make_indirect_map_iterator(this->m_map.end());
  }
  OSSIA_INLINE auto rend() const INLINE_EXPORT
  {
    return score::make_indirect_map_iterator(this->m_map.end());
  }
  OSSIA_INLINE auto cend() const INLINE_EXPORT
  {
    return score::make_indirect_map_iterator(this->m_map.cend());
  }
 
  auto find(const Id<Model>& id) const INLINE_EXPORT
  {
    return score::make_indirect_map_iterator(this->m_map.find(id));
  }
 
  void insert(Element* t) INLINE_EXPORT
  {
    SCORE_ASSERT(m_map.find(t->id()) == m_map.end());
    m_map.insert({t->id(), t});
  }
 
  void erase(const Id<Model>& id) INLINE_EXPORT
  {
    auto it = m_map.find(id);
    if(it != m_map.end())
    {
      auto ptr = it->second;
      m_map.erase(it);
      delete ptr;
    }
  }
 
  void remove_all() INLINE_EXPORT
  {
    for(auto& e : m_map)
    {
      delete e.second;
    }
    m_map.clear();
  }
 
  auto& at(const Id<Model>& id) const INLINE_EXPORT
  {
    auto item = this->m_map.find(id);
    SCORE_ASSERT(item != this->m_map.end());
    return *item->second;
  }
};