path: root/src/openvic-simulation/types/IdentifierRegistry.hpp

#pragma once

#include <cassert>
#include <vector>

#include "openvic-simulation/dataloader/NodeTools.hpp"
#include "openvic-simulation/types/fixed_point/FixedPointMap.hpp"
#include "openvic-simulation/utility/Getters.hpp"
#include "openvic-simulation/utility/Logger.hpp"

namespace OpenVic {

   constexpr bool valid_basic_identifier_char(char c) {
      return ('A' <= c && c <= 'Z') || ('a' <= c && c <= 'z') || ('0' <= c && c <= '9') || c == '_';
   }
   constexpr bool valid_basic_identifier(std::string_view identifier) {
      return std::all_of(identifier.begin(), identifier.end(), valid_basic_identifier_char);
   }
   constexpr std::string_view extract_basic_identifier_prefix(std::string_view identifier) {
      size_t len = 0;
      while (len < identifier.size() && valid_basic_identifier_char(identifier[len])) {
         ++len;
      }
      return { identifier.data(), len };
   }

   /*
    * Base class for objects with a non-empty string identifier. Uniquely named instances of a type derived from this class
    * can be entered into an IdentifierRegistry instance.
    */
   class HasIdentifier {
      const std::string PROPERTY(identifier);

   protected:
      HasIdentifier(std::string_view new_identifier): identifier { new_identifier } {
         assert(!identifier.empty());
      }

   public:
      HasIdentifier(HasIdentifier const&) = delete;
      HasIdentifier(HasIdentifier&&) = default;
      HasIdentifier& operator=(HasIdentifier const&) = delete;
      HasIdentifier& operator=(HasIdentifier&&) = delete;
   };

   inline std::ostream& operator<<(std::ostream& stream, HasIdentifier const& obj) {
      return stream << obj.get_identifier();
   }
   inline std::ostream& operator<<(std::ostream& stream, HasIdentifier const* obj) {
      return obj != nullptr ? stream << *obj : stream << "<NULL>";
   }

   /*
    * Base class for objects with associated colour information.
    */
   template<IsColour ColourT>
   class _HasColour {
      const ColourT PROPERTY(colour);

   protected:
      _HasColour(ColourT new_colour, bool cannot_be_null): colour { new_colour } {
         assert(!cannot_be_null || !colour.is_null());
      }

   public:
      _HasColour(_HasColour const&) = delete;
      _HasColour(_HasColour&&) = default;
      _HasColour& operator=(_HasColour const&) = delete;
      _HasColour& operator=(_HasColour&&) = delete;
   };

   /*
    * Base class for objects with a unique string identifier and associated colour information.
    */
   template<IsColour ColourT>
   class _HasIdentifierAndColour : public HasIdentifier, public _HasColour<ColourT> {
   protected:
      _HasIdentifierAndColour(std::string_view new_identifier, ColourT new_colour, bool cannot_be_null)
         : HasIdentifier { new_identifier }, _HasColour<ColourT> { new_colour, cannot_be_null } {}

   public:
      _HasIdentifierAndColour(_HasIdentifierAndColour const&) = delete;
      _HasIdentifierAndColour(_HasIdentifierAndColour&&) = default;
      _HasIdentifierAndColour& operator=(_HasIdentifierAndColour const&) = delete;
      _HasIdentifierAndColour& operator=(_HasIdentifierAndColour&&) = delete;
   };

   using HasIdentifierAndColour = _HasIdentifierAndColour<colour_t>;
   using HasIdentifierAndAlphaColour = _HasIdentifierAndColour<colour_argb_t>;

   /* Callbacks for trying to add duplicate keys via UniqueKeyRegistry::add_item */
   static bool duplicate_fail_callback(std::string_view registry_name, std::string_view duplicate_identifier) {
      Logger::error(
         "Failure adding item to the ", registry_name, " registry - an item with the identifier \"", duplicate_identifier,
         "\" already exists!"
      );
      return false;
   }
   static bool duplicate_warning_callback(std::string_view registry_name, std::string_view duplicate_identifier) {
      Logger::warning(
         "Warning adding item to the ", registry_name, " registry - an item with the identifier \"", duplicate_identifier,
         "\" already exists!"
      );
      return true;
   }
   static bool duplicate_ignore_callback(std::string_view registry_name, std::string_view duplicate_identifier) {
      return true;
   }

   /* _GetIdentifier - takes _Type const* and returns std::string_view
    * _GetPointer - takes _Storage [const]& and returns T [const]*
    */
   template<typename _Type, typename _Storage, typename _GetIdentifier, typename _GetPointer>
   class UniqueKeyRegistry {

      const std::string name;
      const bool log_lock;
      std::vector<_Storage> PROPERTY_REF(items);
      bool locked = false;
      string_map_t<size_t> identifier_index_map;

      _GetIdentifier GetIdentifier;
      _GetPointer GetPointer;

   public:
      using value_type = _Type;
      using storage_type = _Storage;

      UniqueKeyRegistry(
         std::string_view new_name, bool new_log_lock = true, _GetIdentifier new_GetIdentifier = {},
         _GetPointer new_GetPointer = {}
      ) : name { new_name }, log_lock { new_log_lock }, GetIdentifier { new_GetIdentifier }, GetPointer { new_GetPointer } {}

      std::string_view get_name() const {
         return name;
      }

      bool add_item(
         storage_type&& item,
         NodeTools::callback_t<std::string_view, std::string_view> duplicate_callback = duplicate_fail_callback
      ) {
         if (locked) {
            Logger::error("Cannot add item to the ", name, " registry - locked!");
            return false;
         }
         const std::string_view new_identifier = GetIdentifier(GetPointer(item));
         if (duplicate_callback &&
            duplicate_callback.target<bool(std::string_view, std::string_view)>() == duplicate_ignore_callback) {
            if (has_identifier(new_identifier)) {
               return true;
            }
         } else {
            value_type const* old_item = get_item_by_identifier(new_identifier);
            if (old_item != nullptr) {
               return duplicate_callback(name, new_identifier);
            }
         }
         const std::pair<string_map_t<size_t>::iterator, bool> ret =
            identifier_index_map.emplace(std::move(new_identifier), items.size());
         items.emplace_back(std::move(item));
         return ret.second && ret.first->second + 1 == items.size();
      }

      void lock() {
         if (locked) {
            Logger::error("Failed to lock ", name, " registry - already locked!");
         } else {
            locked = true;
            if (log_lock) {
               Logger::info("Locked ", name, " registry after registering ", size(), " items");
            }
         }
      }

      bool is_locked() const {
         return locked;
      }

      void reset() {
         identifier_index_map.clear();
         items.clear();
         locked = false;
      }

      size_t size() const {
         return items.size();
      }

      bool empty() const {
         return items.empty();
      }

      void reserve(size_t size) {
         if (locked) {
            Logger::error("Failed to reserve space for ", size, " items in ", name, " registry - already locked!");
         } else {
            items.reserve(size);
         }
      }

#define GETTERS(CONST) \
   value_type CONST* get_item_by_identifier(std::string_view identifier) CONST { \
      const typename decltype(identifier_index_map)::const_iterator it = identifier_index_map.find(identifier); \
      if (it != identifier_index_map.end()) { \
         return GetPointer(items[it->second]); \
      } \
      return nullptr; \
   } \
   value_type CONST* get_item_by_index(size_t index) CONST { \
      return index < items.size() ? GetPointer(items[index]) : nullptr; \
   } \
   NodeTools::Callback<std::string_view> auto expect_item_str( \
      NodeTools::Callback<value_type CONST&> auto callback, bool warn \
   ) CONST { \
      return [this, callback, warn](std::string_view identifier) -> bool { \
         value_type CONST* item = get_item_by_identifier(identifier); \
         if (item != nullptr) { \
            return callback(*item); \
         } \
         if (!warn) { \
            Logger::error("Invalid ", name, ": ", identifier); \
            return false; \
         } else { \
            Logger::warning("Invalid ", name, ": ", identifier); \
            return true; \
         } \
      }; \
   } \
   NodeTools::NodeCallback auto expect_item_identifier( \
      NodeTools::Callback<value_type CONST&> auto callback, bool warn \
   ) CONST { \
      return NodeTools::expect_identifier(expect_item_str(callback, warn)); \
   } \
   NodeTools::NodeCallback auto expect_item_dictionary_and_default( \
      NodeTools::Callback<value_type CONST&, ast::NodeCPtr> auto callback, \
      NodeTools::KeyValueCallback auto default_callback \
   ) CONST { \
      return NodeTools::expect_dictionary( \
         [this, callback, default_callback](std::string_view key, ast::NodeCPtr value) -> bool { \
            value_type CONST* item = get_item_by_identifier(key); \
            if (item != nullptr) { \
               return callback(*item, value); \
            } else {\
               return default_callback(key, value); \
            } \
         } \
      ); \
   } \
   NodeTools::NodeCallback auto expect_item_dictionary( \
      NodeTools::Callback<value_type CONST&, ast::NodeCPtr> auto callback \
   ) CONST { \
      return expect_item_dictionary_and_default( \
         callback, [this](std::string_view key, ast::NodeCPtr) -> bool { \
            Logger::error("Invalid ", name, ": ", key); \
            return false; \
         } \
      ); \
   }

#if defined(_MSC_VER)
#pragma warning(push)
#pragma warning(disable : 4003)
#endif
      GETTERS()
      GETTERS(const)

#if defined(_MSC_VER)
#pragma warning(pop)
#endif

#undef GETTERS

      bool has_identifier(std::string_view identifier) const {
         return identifier_index_map.contains(identifier);
      }

      bool has_index(size_t index) const {
         return index < size();
      }

      std::vector<std::string_view> get_item_identifiers() const {
         std::vector<std::string_view> identifiers(items.size());
         for (typename decltype(identifier_index_map)::value_type const& entry : identifier_index_map) {
            identifiers.push_back(entry.first);
         }
         return identifiers;
      }

      NodeTools::NodeCallback auto expect_item_decimal_map(
         NodeTools::Callback<fixed_point_map_t<value_type const*>&&> auto callback
      ) const {
         return [this, callback](ast::NodeCPtr node) -> bool {
            fixed_point_map_t<value_type const*> map;
            bool ret = expect_item_dictionary([&map](value_type const& key, ast::NodeCPtr value) -> bool {
               fixed_point_t val;
               const bool ret = NodeTools::expect_fixed_point(NodeTools::assign_variable_callback(val))(value);
               map.emplace(&key, std::move(val));
               return ret;
            })(node);
            ret &= callback(std::move(map));
            return ret;
         };
      }
   };

   /* Standard value storage */
   template<typename T>
   struct _addressof {
      constexpr T* operator()(T& item) const {
         return std::addressof(item);
      }
      constexpr T const* operator()(T const& item) const {
         return std::addressof(item);
      }
   };

   template<typename _Type, typename _GetIdentifier>
   using ValueRegistry = UniqueKeyRegistry<_Type, _Type, _GetIdentifier, _addressof<_Type>>;

   /* std::unique_ptr dynamic storage */
   template<typename T>
   struct _uptr_get {
      constexpr T* operator()(std::unique_ptr<T>& item) const {
         return item.get();
      }
      constexpr T const* operator()(std::unique_ptr<T> const& item) const {
         return item.get();
      }
   };

   template<typename _Type, typename _GetIdentifier>
   using InstanceRegistry = UniqueKeyRegistry<_Type, std::unique_ptr<_Type>, _GetIdentifier, _uptr_get<_Type>>;

   /* HasIdentifier versions */
   template<std::derived_from<HasIdentifier> T>
   struct _get_identifier {
      constexpr std::string_view operator()(T const* item) const {
         return item->get_identifier();
      }
   };

   template<std::derived_from<HasIdentifier> _Type>
   using IdentifierRegistry = ValueRegistry<_Type, _get_identifier<_Type>>;

   template<std::derived_from<HasIdentifier> _Type>
   using IdentifierInstanceRegistry = InstanceRegistry<_Type, _get_identifier<_Type>>;

/* Macros to generate declaration and constant accessor methods for a UniqueKeyRegistry member variable. */

#define IDENTIFIER_REGISTRY(name) \
   IDENTIFIER_REGISTRY_CUSTOM_PLURAL(name, name##s)

#define IDENTIFIER_REGISTRY_CUSTOM_PLURAL(singular, plural) \
   IDENTIFIER_REGISTRY_FULL_CUSTOM(singular, plural, plural, plural, 0)

#define IDENTIFIER_REGISTRY_CUSTOM_INDEX_OFFSET(name, index_offset) \
   IDENTIFIER_REGISTRY_FULL_CUSTOM(name, name##s, name##s, name##s, index_offset)

#define IDENTIFIER_REGISTRY_FULL_CUSTOM(singular, plural, registry, debug_name, index_offset) \
   registry { #debug_name };\
public: \
   void lock_##plural() { \
      registry.lock(); \
   } \
   bool plural##_are_locked() const { \
      return registry.is_locked(); \
   } \
   bool has_##singular##_identifier(std::string_view identifier) const { \
      return registry.has_identifier(identifier); \
   } \
   size_t get_##singular##_count() const { \
      return registry.size(); \
   } \
   bool plural##_empty() const { \
      return registry.empty(); \
   } \
   std::vector<std::string_view> get_##singular##_identifiers() const { \
      return registry.get_item_identifiers(); \
   } \
   NodeTools::NodeCallback auto expect_##singular##_decimal_map( \
      NodeTools::Callback<fixed_point_map_t<decltype(registry)::value_type const*>&&> auto callback \
   ) const { \
      return registry.expect_item_decimal_map(callback); \
   } \
   IDENTIFIER_REGISTRY_INTERNAL_SHARED(singular, plural, registry, index_offset, const) \
private:

/* Macros to generate non-constant accessor methods for a UniqueKeyRegistry member variable. */

#define IDENTIFIER_REGISTRY_NON_CONST_ACCESSORS(name) \
   IDENTIFIER_REGISTRY_NON_CONST_ACCESSORS_CUSTOM_PLURAL(name, name##s)

#define IDENTIFIER_REGISTRY_NON_CONST_ACCESSORS_CUSTOM_PLURAL(singular, plural) \
   IDENTIFIER_REGISTRY_NON_CONST_ACCESSORS_FULL_CUSTOM(singular, plural, plural, plural, 0)

#define IDENTIFIER_REGISTRY_NON_CONST_ACCESSORS_CUSTOM_INDEX_OFFSET(name, index_offset) \
   IDENTIFIER_REGISTRY_NON_CONST_ACCESSORS_FULL_CUSTOM(name, name##s, name##s, name##s, index_offset)

#define IDENTIFIER_REGISTRY_NON_CONST_ACCESSORS_FULL_CUSTOM(singular, plural, registry, debug_name, index_offset) \
   IDENTIFIER_REGISTRY_INTERNAL_SHARED(singular, plural, registry, index_offset,)

#define IDENTIFIER_REGISTRY_INTERNAL_SHARED(singular, plural, registry, index_offset, const_kw) \
   decltype(registry)::value_type const_kw* get_##singular##_by_identifier(std::string_view identifier) const_kw { \
      return registry.get_item_by_identifier(identifier); \
   } \
   decltype(registry)::value_type const_kw* get_##singular##_by_index(size_t index) const_kw { \
      return index >= index_offset ? registry.get_item_by_index(index - index_offset) : nullptr; \
   } \
   std::vector<decltype(registry)::storage_type> const_kw& get_##plural() const_kw { \
      return registry.get_items(); \
   } \
   NodeTools::Callback<std::string_view> auto expect_##singular##_str( \
      NodeTools::Callback<decltype(registry)::value_type const_kw&> auto callback, bool warn = false \
   ) const_kw { \
      return registry.expect_item_str(callback, warn); \
   } \
   NodeTools::NodeCallback auto expect_##singular##_identifier( \
      NodeTools::Callback<decltype(registry)::value_type const_kw&> auto callback, bool warn = false \
   ) const_kw { \
      return registry.expect_item_identifier(callback, warn); \
   } \
   NodeTools::NodeCallback auto expect_##singular##_dictionary_and_default( \
      NodeTools::Callback<decltype(registry)::value_type const_kw&, ast::NodeCPtr> auto callback, \
      NodeTools::KeyValueCallback auto default_callback \
   ) const_kw { \
      return registry.expect_item_dictionary_and_default(callback, default_callback); \
   } \
   NodeTools::NodeCallback auto expect_##singular##_dictionary( \
      NodeTools::Callback<decltype(registry)::value_type const_kw&, ast::NodeCPtr> auto callback \
   ) const_kw { \
      return registry.expect_item_dictionary(callback); \
   }
}