From 8fba1c8a02f8680e0d80279b8b6451fea4a40a62 Mon Sep 17 00:00:00 2001 From: Hop311 Date: Tue, 25 Apr 2023 00:03:15 +0100 Subject: Req comments + cleanup + c++ registry refactoring --- extension/src/openvic2/map/Map.cpp | 139 ++++++++++++------------------------- 1 file changed, 43 insertions(+), 96 deletions(-) (limited to 'extension/src/openvic2/map/Map.cpp') diff --git a/extension/src/openvic2/map/Map.cpp b/extension/src/openvic2/map/Map.cpp index 1089d61..a440f67 100644 --- a/extension/src/openvic2/map/Map.cpp +++ b/extension/src/openvic2/map/Map.cpp @@ -16,45 +16,32 @@ Mapmode::index_t Mapmode::get_index() const { return index; } -Mapmode::colour_func_t Mapmode::get_colour_func() const { - return colour_func; +Province::colour_t Mapmode::get_colour(Map const& map, Province const& province) const { + return colour_func ? colour_func(map, province) : Province::NULL_COLOUR; } +const char Map::provinces_name[] = "provinces", Map::regions_name[] = "regions", Map::mapmodes_name[] = "mapmodes"; + return_t Map::add_province(std::string const& identifier, Province::colour_t colour) { - if (provinces_locked) { - Logger::error("The map's province list has already been locked!"); - return FAILURE; - } - if (provinces.size() >= Province::MAX_INDEX) { + if (provinces.get_item_count() >= Province::MAX_INDEX) { Logger::error("The map's province list is full - there can be at most ", Province::MAX_INDEX, " provinces"); return FAILURE; } - if (identifier.empty()) { - Logger::error("Empty province identifier for colour ", Province::colour_to_hex_string(colour)); - return FAILURE; - } if (colour == Province::NULL_COLOUR || colour > Province::MAX_COLOUR) { Logger::error("Invalid province colour: ", Province::colour_to_hex_string(colour)); return FAILURE; } - Province new_province{ static_cast(provinces.size() + 1), identifier, colour }; - Province const* old_province = get_province_by_identifier(identifier); - if (old_province != nullptr) { - Logger::error("Duplicate province identifiers: ", old_province->to_string(), " and ", new_province.to_string()); - return FAILURE; - } - old_province = get_province_by_colour(colour); + Province new_province{ static_cast(provinces.get_item_count() + 1), identifier, colour }; + Province const* old_province = get_province_by_colour(colour); if (old_province != nullptr) { Logger::error("Duplicate province colours: ", old_province->to_string(), " and ", new_province.to_string()); return FAILURE; } - provinces.push_back(new_province); - return SUCCESS; + return provinces.add_item(std::move(new_province)); } void Map::lock_provinces() { - provinces_locked = true; - Logger::info("Locked provinces after registering ", provinces.size()); + provinces.lock(); } return_t Map::set_water_province(std::string const& identifier) { @@ -82,18 +69,6 @@ void Map::lock_water_provinces() { } return_t Map::add_region(std::string const& identifier, std::vector const& province_identifiers) { - if (regions_locked) { - Logger::error("The map's region list has already been locked!"); - return FAILURE; - } - if (identifier.empty()) { - Logger::error("Empty region identifier!"); - return FAILURE; - } - if (provinces.empty()) { - Logger::error("Empty province list for region ", identifier); - return FAILURE; - } return_t ret = SUCCESS; Region new_region{ identifier }; for (std::string const& province_identifier : province_identifiers) { @@ -106,8 +81,8 @@ return_t Map::add_region(std::string const& identifier, std::vector size_t other_region_index = reinterpret_cast(province->get_region()); if (other_region_index != 0) { other_region_index--; - if (other_region_index < regions.size()) - Logger::error("Province ", province_identifier, " is already part of ", regions[other_region_index].get_identifier()); + if (other_region_index < regions.get_item_count()) + Logger::error("Province ", province_identifier, " is already part of ", regions.get_item_by_index(other_region_index)->get_identifier()); else Logger::error("Province ", province_identifier, " is already part of an unknown region with index ", other_region_index); ret = FAILURE; @@ -122,65 +97,53 @@ return_t Map::add_region(std::string const& identifier, std::vector Logger::error("No valid provinces in region's list"); return FAILURE; } - Region const* old_region = get_region_by_identifier(identifier); - if (old_region != nullptr) { - Logger::error("Duplicate region identifiers: ", old_region->get_identifier(), " and ", identifier); - return FAILURE; - } - regions.push_back(new_region); // Used to detect provinces listed in multiple regions, will // be corrected once regions is stable (i.e. lock_regions). - Region* tmp_region_index = reinterpret_cast(regions.size()); + Region* tmp_region_index = reinterpret_cast(regions.get_item_count()); for (Province* province : new_region.get_provinces()) province->region = tmp_region_index; + if (regions.add_item(std::move(new_region)) != SUCCESS) ret = FAILURE; return ret; } void Map::lock_regions() { - regions_locked = true; - for (Region& region : regions) + regions.lock(); + for (Region& region : regions.get_items()) for (Province* province : region.get_provinces()) province->region = ®ion; - Logger::info("Locked regions after registering ", regions.size()); } size_t Map::get_province_count() const { - return provinces.size(); + return provinces.get_item_count(); } Province* Map::get_province_by_index(Province::index_t index) { - return index != Province::NULL_INDEX && index <= provinces.size() ? &provinces[index - 1] : nullptr; + return index != Province::NULL_INDEX ? provinces.get_item_by_index(index - 1) : nullptr; } Province const* Map::get_province_by_index(Province::index_t index) const { - return index != Province::NULL_INDEX && index <= provinces.size() ? &provinces[index - 1] : nullptr; + return index != Province::NULL_INDEX ? provinces.get_item_by_index(index - 1) : nullptr; } Province* Map::get_province_by_identifier(std::string const& identifier) { - if (!identifier.empty()) - for (Province& province : provinces) - if (province.get_identifier() == identifier) return &province; - return nullptr; + return provinces.get_item_by_identifier(identifier); } Province const* Map::get_province_by_identifier(std::string const& identifier) const { - if (!identifier.empty()) - for (Province const& province : provinces) - if (province.get_identifier() == identifier) return &province; - return nullptr; + return provinces.get_item_by_identifier(identifier); } Province* Map::get_province_by_colour(Province::colour_t colour) { if (colour != Province::NULL_COLOUR) - for (Province& province : provinces) + for (Province& province : provinces.get_items()) if (province.get_colour() == colour) return &province; return nullptr; } Province const* Map::get_province_by_colour(Province::colour_t colour) const { if (colour != Province::NULL_COLOUR) - for (Province const& province : provinces) + for (Province const& province : provinces.get_items()) if (province.get_colour() == colour) return &province; return nullptr; } @@ -191,17 +154,11 @@ Province::index_t Map::get_province_index_at(size_t x, size_t y) const { } Region* Map::get_region_by_identifier(std::string const& identifier) { - if (!identifier.empty()) - for (Region& region : regions) - if (region.get_identifier() == identifier) return ®ion; - return nullptr; + return regions.get_item_by_identifier(identifier); } Region const* Map::get_region_by_identifier(std::string const& identifier) const { - if (!identifier.empty()) - for (Region const& region : regions) - if (region.get_identifier() == identifier) return ®ion; - return nullptr; + return regions.get_item_by_identifier(identifier); } static Province::colour_t colour_at(uint8_t const* colour_data, int32_t idx) { @@ -213,7 +170,7 @@ return_t Map::generate_province_index_image(size_t new_width, size_t new_height, Logger::error("Province index image has already been generated!"); return FAILURE; } - if (!provinces_locked) { + if (!provinces.is_locked()) { Logger::error("Province index image cannot be generated until after provinces are locked!"); return FAILURE; } @@ -229,7 +186,7 @@ return_t Map::generate_province_index_image(size_t new_width, size_t new_height, height = new_height; province_index_image.resize(width * height); - std::vector province_checklist(provinces.size()); + std::vector province_checklist(provinces.get_item_count()); return_t ret = SUCCESS; std::unordered_set unrecognised_colours; @@ -269,7 +226,7 @@ return_t Map::generate_province_index_image(size_t new_width, size_t new_height, for (size_t idx = 0; idx < province_checklist.size(); ++idx) { if (!province_checklist[idx]) { - Logger::error("Province missing from shape image: ", provinces[idx].to_string()); + Logger::error("Province missing from shape image: ", provinces.get_item_by_index(idx)->to_string()); ret = FAILURE; } } @@ -289,37 +246,27 @@ std::vector const& Map::get_province_index_image() const { } return_t Map::add_mapmode(std::string const& identifier, Mapmode::colour_func_t colour_func) { - if (identifier.empty()) { - Logger::error("Empty mapmode identifier!"); - return FAILURE; - } if (colour_func == nullptr) { Logger::error("Mapmode colour function is null for identifier: ", identifier); return FAILURE; } - Mapmode new_mapmode{ mapmodes.size(), identifier, colour_func }; - Mapmode const* old_mapmode = get_mapmode_by_identifier(identifier); - if (old_mapmode != nullptr) { - Logger::error("Duplicate mapmode identifiers: ", old_mapmode->get_identifier(), " and ", identifier); - return FAILURE; - } - mapmodes.push_back(new_mapmode); - return SUCCESS; + return mapmodes.add_item({ mapmodes.get_item_count(), identifier, colour_func }); +} + +void Map::lock_mapmodes() { + mapmodes.lock(); } size_t Map::get_mapmode_count() const { - return mapmodes.size(); + return mapmodes.get_item_count(); } Mapmode const* Map::get_mapmode_by_index(size_t index) const { - return index < mapmodes.size() ? &mapmodes[index] : nullptr; + return mapmodes.get_item_by_index(index); } Mapmode const* Map::get_mapmode_by_identifier(std::string const& identifier) const { - if (!identifier.empty()) - for (Mapmode const& mapmode : mapmodes) - if (mapmode.get_identifier() == identifier) return &mapmode; - return nullptr; + return mapmodes.get_item_by_identifier(identifier); } return_t Map::generate_mapmode_colours(Mapmode::index_t index, uint8_t* target) const { @@ -327,14 +274,14 @@ return_t Map::generate_mapmode_colours(Mapmode::index_t index, uint8_t* target) Logger::error("Mapmode colour target pointer is null!"); return FAILURE; } - if (index >= mapmodes.size()) { + Mapmode const* mapmode = mapmodes.get_item_by_index(index); + if (mapmode == nullptr) { Logger::error("Invalid mapmode index: ", index); return FAILURE; } - Mapmode const& mapmode = mapmodes[index]; target += 4; // Skip past Province::NULL_INDEX - for (Province const& province : provinces) { - const Province::colour_t colour = mapmode.get_colour_func()(*this, province); + for (Province const& province : provinces.get_items()) { + const Province::colour_t colour = mapmode->get_colour(*this, province); *target++ = (colour >> 16) & 0xFF; *target++ = (colour >> 8) & 0xFF; *target++ = colour & 0xFF; @@ -344,16 +291,16 @@ return_t Map::generate_mapmode_colours(Mapmode::index_t index, uint8_t* target) } void Map::generate_province_buildings(BuildingManager const& manager) { - for (Province& province : provinces) - manager.generate_province_buildings(province.buildings); + for (Province& province : provinces.get_items()) + manager.generate_province_buildings(province.buildings.get_items()); } void Map::update_state(Date const& today) { - for (Province& province : provinces) + for (Province& province : provinces.get_items()) province.update_state(today); } void Map::tick(Date const& today) { - for (Province& province : provinces) + for (Province& province : provinces.get_items()) province.tick(today); } -- cgit v1.2.3-56-ga3b1