#pragma once #include #include #include "openvic-simulation/dataloader/NodeTools.hpp" #include "openvic-simulation/utility/Logger.hpp" #define REF_GETTERS(var) \ constexpr decltype(var)& get_##var() { return var; } \ constexpr decltype(var) const& get_##var() const { return var; } namespace OpenVic { /* * Base class for objects with a non-empty string identifier, * uniquely named instances of which can be entered into an * IdentifierRegistry instance. */ class HasIdentifier { const std::string identifier; protected: HasIdentifier(std::string_view new_identifier); public: HasIdentifier(HasIdentifier const&) = delete; HasIdentifier(HasIdentifier&&) = default; HasIdentifier& operator=(HasIdentifier const&) = delete; HasIdentifier& operator=(HasIdentifier&&) = delete; std::string_view get_identifier() const; }; std::ostream& operator<<(std::ostream& stream, HasIdentifier const& obj); std::ostream& operator<<(std::ostream& stream, HasIdentifier const* obj); /* * Base class for objects with associated colour information. */ class HasColour { const colour_t colour; protected: HasColour(const colour_t new_colour, bool can_be_null, bool can_have_alpha); public: HasColour(HasColour const&) = delete; HasColour(HasColour&&) = default; HasColour& operator=(HasColour const&) = delete; HasColour& operator=(HasColour&&) = delete; colour_t get_colour() const; std::string colour_to_hex_string() const; }; /* * Base class for objects with a unique string identifier * and associated colour information. */ class HasIdentifierAndColour : public HasIdentifier, public HasColour { protected: HasIdentifierAndColour(std::string_view new_identifier, const colour_t new_colour, bool can_be_null, bool can_have_alpha); public: HasIdentifierAndColour(HasIdentifierAndColour const&) = delete; HasIdentifierAndColour(HasIdentifierAndColour&&) = default; HasIdentifierAndColour& operator=(HasIdentifierAndColour const&) = delete; HasIdentifierAndColour& operator=(HasIdentifierAndColour&&) = delete; }; template using decimal_map_t = std::map; template constexpr typename decimal_map_t::value_type get_largest_item(decimal_map_t const& map) { constexpr auto pred = [](typename decimal_map_t::value_type a, typename decimal_map_t::value_type b) -> bool { return a.second < b.second; }; const typename decimal_map_t::const_iterator result = std::max_element( map.begin(), map.end(), pred ); if (result != map.end()) { return *result; } else { return { nullptr, -1 }; } } using distribution_t = decimal_map_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 class UniqueKeyRegistry { const std::string name; const bool log_lock; std::vector<_Storage> items; bool locked = false; string_map_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 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)); value_type const* old_item = get_item_by_identifier(new_identifier); if (old_item != nullptr) { return duplicate_callback(name, new_identifier); } identifier_index_map.emplace(new_identifier, items.size()); items.push_back(std::move(item)); return true; } 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 \ 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() ? &items[index] : nullptr; \ } \ NodeTools::callback_t expect_item_identifier(NodeTools::callback_t callback) _const { \ return [this, callback](std::string_view identifier) -> bool { \ value_type _const* item = get_item_by_identifier(identifier); \ if (item != nullptr) return callback(*item); \ Logger::error("Invalid ", name, ": ", identifier); \ return false; \ }; \ } \ NodeTools::node_callback_t expect_item_dictionary(NodeTools::callback_t callback) _const { \ return NodeTools::expect_dictionary([this, 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); \ } \ Logger::error("Invalid ", name, " identifier: ", key); \ return false; \ }); \ } #define _const GETTERS #undef _const #define _const const GETTERS #undef _const #undef GETTERS bool has_identifier(std::string_view identifier) const { return get_item_by_identifier(identifier) != nullptr; } bool has_index(size_t index) const { return get_item_by_index(index) != nullptr; } REF_GETTERS(items) std::vector get_item_identifiers() const { std::vector identifiers; identifiers.reserve(items.size()); for (typename decltype(identifier_index_map)::value_type const& entry : identifier_index_map) { identifiers.push_back(entry.first); } return identifiers; } NodeTools::node_callback_t expect_item_decimal_map(NodeTools::callback_t&&> callback) const { return [this, callback](ast::NodeCPtr node) -> bool { decimal_map_t 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, val); return ret; })(node); ret &= callback(std::move(map)); return ret; }; } }; /* Standard value storage */ template 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 using ValueRegistry = UniqueKeyRegistry<_Type, _Type, _GetIdentifier, _addressof<_Type>>; /* std::unique_ptr dynamic storage */ template struct _uptr_get { constexpr T* operator()(std::unique_ptr& item) const { return item.get(); } constexpr T const* operator()(std::unique_ptr const& item) const { return item.get(); } }; template using InstanceRegistry = UniqueKeyRegistry<_Type, std::unique_ptr<_Type>, _GetIdentifier, _uptr_get<_Type>>; /* HasIdentifier versions */ template T> struct _get_identifier { constexpr std::string_view operator()(T const* item) const { return item->get_identifier(); } }; template _Type> using IdentifierRegistry = ValueRegistry<_Type, _get_identifier<_Type>>; template _Type> using IdentifierInstanceRegistry = InstanceRegistry<_Type, _get_identifier<_Type>>; #define IDENTIFIER_REGISTRY_ACCESSORS_CUSTOM_PLURAL(singular, plural) \ void lock_##plural() { plural.lock(); } \ bool plural##_are_locked() const { return plural.is_locked(); } \ decltype(plural)::value_type const* get_##singular##_by_identifier(std::string_view identifier) const { \ return plural.get_item_by_identifier(identifier); } \ bool has_##singular##_identifier(std::string_view identifier) const { \ return plural.has_identifier(identifier); } \ size_t get_##singular##_count() const { \ return plural.size(); } \ std::vector const& get_##plural() const { \ return plural.get_items(); } \ std::vector get_##singular##_identifiers() const { \ return plural.get_item_identifiers(); } \ NodeTools::callback_t expect_##singular##_identifier(NodeTools::callback_t callback) const { \ return plural.expect_item_identifier(callback); } \ NodeTools::node_callback_t expect_##singular##_dictionary(NodeTools::callback_t callback) const { \ return plural.expect_item_dictionary(callback); } \ NodeTools::node_callback_t expect_##singular##_decimal_map(NodeTools::callback_t&&> callback) const { \ return plural.expect_item_decimal_map(callback); } #define IDENTIFIER_REGISTRY_NON_CONST_ACCESSORS_CUSTOM_PLURAL(singular, plural) \ decltype(plural)::value_type* get_##singular##_by_identifier(std::string_view identifier) { \ return plural.get_item_by_identifier(identifier); } \ NodeTools::callback_t expect_##singular##_identifier(NodeTools::callback_t callback) { \ return plural.expect_item_identifier(callback); } \ NodeTools::node_callback_t expect_##singular##_dictionary(NodeTools::callback_t callback) { \ return plural.expect_item_dictionary(callback); } #define IDENTIFIER_REGISTRY_ACCESSORS(name) IDENTIFIER_REGISTRY_ACCESSORS_CUSTOM_PLURAL(name, name##s) #define IDENTIFIER_REGISTRY_NON_CONST_ACCESSORS(name) IDENTIFIER_REGISTRY_NON_CONST_ACCESSORS_CUSTOM_PLURAL(name, name##s) }