std::string const& --> const std::string_view

8 files changed, 133 insertions, 57 deletions

diff --git a/src/openvic/map/Building.cpp b/src/openvic/map/Building.cpp
index 81532c4..73a1886 100644
--- a/src/openvic/map/Building.cpp
+++ b/src/openvic/map/Building.cpp
@@ -76,7 +76,7 @@ void Building::tick(Date const& today) {
 	}
 }
 
-BuildingType::BuildingType(std::string const& new_identifier, Building::level_t new_max_level, Timespan new_build_time)
+BuildingType::BuildingType(const std::string_view new_identifier, Building::level_t new_max_level, Timespan new_build_time)
 	: HasIdentifier { new_identifier },
 	  max_level { new_max_level },
 	  build_time { new_build_time } {
@@ -94,7 +94,7 @@ Timespan BuildingType::get_build_time() const {
 
 BuildingManager::BuildingManager() : building_types { "building types" } {}
 
-return_t BuildingManager::add_building_type(std::string const& identifier, Building::level_t max_level, Timespan build_time) {
+return_t BuildingManager::add_building_type(const std::string_view identifier, Building::level_t max_level, Timespan build_time) {
 	if (identifier.empty()) {
 		Logger::error("Invalid building type identifier - empty!");
 		return FAILURE;
@@ -114,7 +114,7 @@ void BuildingManager::lock_building_types() {
 	building_types.lock();
 }
 
-BuildingType const* BuildingManager::get_building_type_by_identifier(std::string const& identifier) const {
+BuildingType const* BuildingManager::get_building_type_by_identifier(const std::string_view identifier) const {
 	return building_types.get_item_by_identifier(identifier);
 }
 
@@ -124,10 +124,14 @@ return_t BuildingManager::generate_province_buildings(Province& province) const
 		Logger::error("Cannot generate buildings until building types are locked!");
 		return FAILURE;
 	}
-	if (province.is_water()) return SUCCESS;
 	return_t ret = SUCCESS;
-	for (BuildingType const& type : building_types.get_items())
-		if (province.add_building({ type }) != SUCCESS) ret = FAILURE;
+	if (!province.is_water()) {
+		for (BuildingType const& type : building_types.get_items()) {
+			if (province.add_building({ type }) != SUCCESS) {
+				ret = FAILURE;
+			}
+		}
+	}
 	province.lock_buildings();
 	return ret;
 }
diff --git a/src/openvic/map/Building.hpp b/src/openvic/map/Building.hpp
index c4f8950..c00932b 100644
--- a/src/openvic/map/Building.hpp
+++ b/src/openvic/map/Building.hpp
@@ -60,7 +60,7 @@ namespace OpenVic {
 		const Building::level_t max_level;
 		const Timespan build_time;
 
-		BuildingType(std::string const& new_identifier, Building::level_t new_max_level, Timespan new_build_time);
+		BuildingType(const std::string_view new_identifier, Building::level_t new_max_level, Timespan new_build_time);
 
 	public:
 		BuildingType(BuildingType&&) = default;
@@ -78,9 +78,9 @@ namespace OpenVic {
 	public:
 		BuildingManager();
 
-		return_t add_building_type(std::string const& identifier, Building::level_t max_level, Timespan build_time);
+		return_t add_building_type(const std::string_view identifier, Building::level_t max_level, Timespan build_time);
 		void lock_building_types();
-		BuildingType const* get_building_type_by_identifier(std::string const& identifier) const;
+		BuildingType const* get_building_type_by_identifier(const std::string_view identifier) const;
 		return_t generate_province_buildings(Province& province) const;
 	};
 }
diff --git a/src/openvic/map/Map.cpp b/src/openvic/map/Map.cpp
index 21bb6a5..e8599b1 100644
--- a/src/openvic/map/Map.cpp
+++ b/src/openvic/map/Map.cpp
@@ -8,14 +8,15 @@
 
 using namespace OpenVic;
 
-Mapmode::Mapmode(index_t new_index, std::string const& new_identifier, colour_func_t new_colour_func)
+Mapmode::Mapmode(const std::string_view new_identifier, index_t new_index, colour_func_t new_colour_func)
 	: HasIdentifier { new_identifier },
 	  index { new_index },
 	  colour_func { new_colour_func } {
 	assert(colour_func != nullptr);
 }
 
-const Mapmode Mapmode::ERROR_MAPMODE { 0, "mapmode_error", [](Map const& map, Province const& province) -> colour_t { return 0xFFFF0000; } };
+const Mapmode Mapmode::ERROR_MAPMODE { "mapmode_error", 0,
+	[](Map const& map, Province const& province) -> colour_t { return 0xFFFF0000; } };
 
 Mapmode::index_t Mapmode::get_index() const {
 	return index;
@@ -29,7 +30,7 @@ Map::Map() : provinces { "provinces" },
 			 regions { "regions" },
 			 mapmodes { "mapmodes" } {}
 
-return_t Map::add_province(std::string const& identifier, colour_t colour) {
+return_t Map::add_province(const std::string_view identifier, colour_t colour) {
 	if (provinces.get_item_count() >= MAX_INDEX) {
 		Logger::error("The map's province list is full - there can be at most ", MAX_INDEX, " provinces");
 		return FAILURE;
@@ -42,7 +43,7 @@ return_t Map::add_province(std::string const& identifier, colour_t colour) {
 		Logger::error("Invalid province colour for ", identifier, ": ", Province::colour_to_hex_string(colour));
 		return FAILURE;
 	}
-	Province new_province { static_cast<index_t>(provinces.get_item_count() + 1), identifier, colour };
+	Province new_province { identifier, colour, static_cast<index_t>(provinces.get_item_count() + 1) };
 	const index_t index = get_index_from_colour(colour);
 	if (index != NULL_INDEX) {
 		Logger::error("Duplicate province colours: ", get_province_by_index(index)->to_string(), " and ", new_province.to_string());
@@ -56,8 +57,8 @@ void Map::lock_provinces() {
 	provinces.lock();
 }
 
-return_t Map::set_water_province(std::string const& identifier) {
-	if (water_provinces_locked) {
+return_t Map::set_water_province(const std::string_view identifier) {
+	if (water_provinces.is_locked()) {
 		Logger::error("The map's water provinces have already been locked!");
 		return FAILURE;
 	}
@@ -70,24 +71,27 @@ return_t Map::set_water_province(std::string const& identifier) {
 		Logger::error("Province ", identifier, " is already a water province!");
 		return FAILURE;
 	}
+	if (water_provinces.add_province(province) != SUCCESS) {
+		Logger::error("Failed to add province ", identifier, " to water province set!");
+		return FAILURE;
+	}
 	province->water = true;
-	water_province_count++;
 	return SUCCESS;
 }
 
 void Map::lock_water_provinces() {
-	water_provinces_locked = true;
-	Logger::info("Locked water provinces after registering ", water_province_count);
+	water_provinces.lock();
+	Logger::info("Locked water provinces after registering ", water_provinces.get_province_count());
 }
 
-return_t Map::add_region(std::string const& identifier, std::vector<std::string> const& province_identifiers) {
+return_t Map::add_region(const std::string_view identifier, std::vector<std::string_view> const& province_identifiers) {
 	if (identifier.empty()) {
 		Logger::error("Invalid region identifier - empty!");
 		return FAILURE;
 	}
 	Region new_region { identifier };
 	return_t ret = SUCCESS;
-	for (std::string const& province_identifier : province_identifiers) {
+	for (const std::string_view province_identifier : province_identifiers) {
 		Province* province = get_province_by_identifier(province_identifier);
 		if (province != nullptr) {
 			if (new_region.contains_province(province)) {
@@ -102,13 +106,17 @@ return_t Map::add_region(std::string const& identifier, std::vector<std::string>
 					else
 						Logger::error("Cannot add province ", province_identifier, " to region ", identifier, " - it is already part of an unknown region with index ", other_region_index);
 					ret = FAILURE;
-				} else new_region.provinces.push_back(province);
+				} else if (new_region.add_province(province) != SUCCESS) {
+					Logger::error("Failed to add province ", province_identifier, " to region ", identifier);
+					ret = FAILURE;
+				}
 			}
 		} else {
 			Logger::error("Invalid province identifier ", province_identifier, " for region ", identifier);
 			ret = FAILURE;
 		}
 	}
+	new_region.lock();
 	if (!new_region.get_province_count()) {
 		Logger::error("No valid provinces in list for ", identifier);
 		return FAILURE;
@@ -142,11 +150,11 @@ Province const* Map::get_province_by_index(index_t index) const {
 	return index != NULL_INDEX ? provinces.get_item_by_index(index - 1) : nullptr;
 }
 
-Province* Map::get_province_by_identifier(std::string const& identifier) {
+Province* Map::get_province_by_identifier(const std::string_view identifier) {
 	return provinces.get_item_by_identifier(identifier);
 }
 
-Province const* Map::get_province_by_identifier(std::string const& identifier) const {
+Province const* Map::get_province_by_identifier(const std::string_view identifier) const {
 	return provinces.get_item_by_identifier(identifier);
 }
 
@@ -162,7 +170,12 @@ index_t Map::get_province_index_at(size_t x, size_t y) const {
 }
 
 void Map::set_selected_province(index_t index) {
-	selected_province = index <= get_province_count() ? index : NULL_INDEX;
+	if (index < get_province_count()) {
+		Logger::error("Trying to set selected province to an invalid index ", index, " (max index is ", get_province_count(), ")");
+		selected_province = NULL_INDEX;
+	} else {
+		selected_province = index;
+	}
 }
 
 index_t Map::get_selected_province_index() const {
@@ -173,11 +186,12 @@ Province const* Map::get_selected_province() const {
 	return get_province_by_index(get_selected_province_index());
 }
 
-Region* Map::get_region_by_identifier(std::string const& identifier) {
+
+Region* Map::get_region_by_identifier(const std::string_view identifier) {
 	return regions.get_item_by_identifier(identifier);
 }
 
-Region const* Map::get_region_by_identifier(std::string const& identifier) const {
+Region const* Map::get_region_by_identifier(const std::string_view identifier) const {
 	return regions.get_item_by_identifier(identifier);
 }
 
@@ -187,7 +201,7 @@ static colour_t colour_at(uint8_t const* colour_data, int32_t idx) {
 }
 
 return_t Map::generate_province_shape_image(size_t new_width, size_t new_height, uint8_t const* colour_data,
-	uint8_t const* terrain_data, terrain_variant_map_t const& terrain_variant_map) {
+	uint8_t const* terrain_data, terrain_variant_map_t const& terrain_variant_map, bool detailed_errors) {
 	if (!province_shape_image.empty()) {
 		Logger::error("Province index image has already been generated!");
 		return FAILURE;
@@ -226,8 +240,10 @@ return_t Map::generate_province_shape_image(size_t new_width, size_t new_height,
 			else {
 				if (unrecognised_terrain_colours.find(terrain_colour) == unrecognised_terrain_colours.end()) {
 					unrecognised_terrain_colours.insert(terrain_colour);
-					Logger::error("Unrecognised terrain colour ", Province::colour_to_hex_string(terrain_colour), " at (", x, ", ", y, ")");
-					ret = FAILURE;
+					if (detailed_errors) {
+						Logger::error("Unrecognised terrain colour ", Province::colour_to_hex_string(terrain_colour),
+							" at (", x, ", ", y, ")");
+					}
 				}
 				province_shape_image[idx].terrain = 0;
 			}
@@ -255,19 +271,36 @@ return_t Map::generate_province_shape_image(size_t new_width, size_t new_height,
 			}
 			if (unrecognised_province_colours.find(province_colour) == unrecognised_province_colours.end()) {
 				unrecognised_province_colours.insert(province_colour);
-				Logger::error("Unrecognised province colour ", Province::colour_to_hex_string(province_colour), " at (", x, ", ", y, ")");
-				ret = FAILURE;
+				if (detailed_errors) {
+					Logger::error("Unrecognised province colour ", Province::colour_to_hex_string(province_colour),
+						" at (", x, ", ", y, ")");
+				}
 			}
 			province_shape_image[idx].index = NULL_INDEX;
 		}
 	}
+	if (!unrecognised_province_colours.empty()) {
+		Logger::error("Province image contains ", unrecognised_province_colours.size(), " unrecognised province colours");
+		ret = FAILURE;
+	}
+	if (!unrecognised_terrain_colours.empty()) {
+		Logger::error("Terrain image contains ", unrecognised_terrain_colours.size(), " unrecognised terrain colours");
+		ret = FAILURE;
+	}
 
+	size_t missing = 0;
 	for (size_t idx = 0; idx < province_checklist.size(); ++idx) {
 		if (!province_checklist[idx]) {
-			Logger::error("Province missing from shape image: ", provinces.get_item_by_index(idx)->to_string());
-			ret = FAILURE;
+			if (detailed_errors) {
+				Logger::error("Province missing from shape image: ", provinces.get_item_by_index(idx)->to_string());
+			}
+			missing++;
 		}
 	}
+	if (missing > 0) {
+		Logger::error("Province image is missing ", missing, " province colours");
+		ret = FAILURE;
+	}
 	return ret;
 }
 
@@ -283,7 +316,7 @@ std::vector<Map::shape_pixel_t> const& Map::get_province_shape_image() const {
 	return province_shape_image;
 }
 
-return_t Map::add_mapmode(std::string const& identifier, Mapmode::colour_func_t colour_func) {
+return_t Map::add_mapmode(const std::string_view identifier, Mapmode::colour_func_t colour_func) {
 	if (identifier.empty()) {
 		Logger::error("Invalid mapmode identifier - empty!");
 		return FAILURE;
@@ -292,7 +325,7 @@ return_t Map::add_mapmode(std::string const& identifier, Mapmode::colour_func_t
 		Logger::error("Mapmode colour function is null for identifier: ", identifier);
 		return FAILURE;
 	}
-	return mapmodes.add_item({ mapmodes.get_item_count(), identifier, colour_func });
+	return mapmodes.add_item({ identifier, mapmodes.get_item_count(), colour_func });
 }
 
 void Map::lock_mapmodes() {
@@ -307,7 +340,7 @@ Mapmode const* Map::get_mapmode_by_index(size_t index) const {
 	return mapmodes.get_item_by_index(index);
 }
 
-Mapmode const* Map::get_mapmode_by_identifier(std::string const& identifier) const {
+Mapmode const* Map::get_mapmode_by_identifier(const std::string_view identifier) const {
 	return mapmodes.get_item_by_identifier(identifier);
 }
 
diff --git a/src/openvic/map/Map.hpp b/src/openvic/map/Map.hpp
index 3e1370b..64678c8 100644
--- a/src/openvic/map/Map.hpp
+++ b/src/openvic/map/Map.hpp
@@ -16,7 +16,7 @@ namespace OpenVic {
 		const index_t index;
 		const colour_func_t colour_func;
 
-		Mapmode(index_t new_index, std::string const& new_identifier, colour_func_t new_colour_func);
+		Mapmode(const std::string_view new_identifier, index_t new_index, colour_func_t new_colour_func);
 
 	public:
 		static const Mapmode ERROR_MAPMODE;
@@ -46,8 +46,7 @@ namespace OpenVic {
 		IdentifierRegistry<Province> provinces;
 		IdentifierRegistry<Region> regions;
 		IdentifierRegistry<Mapmode> mapmodes;
-		bool water_provinces_locked = false;
-		size_t water_province_count = 0;
+		ProvinceSet water_provinces;
 
 		size_t width = 0, height = 0;
 		std::vector<shape_pixel_t> province_shape_image;
@@ -61,37 +60,37 @@ namespace OpenVic {
 	public:
 		Map();
 
-		return_t add_province(std::string const& identifier, colour_t colour);
+		return_t add_province(const std::string_view identifier, colour_t colour);
 		void lock_provinces();
-		return_t set_water_province(std::string const& identifier);
+		return_t set_water_province(const std::string_view identifier);
 		void lock_water_provinces();
-		return_t add_region(std::string const& identifier, std::vector<std::string> const& province_identifiers);
+		return_t add_region(const std::string_view identifier, std::vector<std::string_view> const& province_identifiers);
 		void lock_regions();
 
 		size_t get_province_count() const;
 		Province* get_province_by_index(index_t index);
 		Province const* get_province_by_index(index_t index) const;
-		Province* get_province_by_identifier(std::string const& identifier);
-		Province const* get_province_by_identifier(std::string const& identifier) const;
+		Province* get_province_by_identifier(const std::string_view identifier);
+		Province const* get_province_by_identifier(const std::string_view identifier) const;
 		index_t get_province_index_at(size_t x, size_t y) const;
 		void set_selected_province(index_t index);
 		index_t get_selected_province_index() const;
 		Province const* get_selected_province() const;
 
-		Region* get_region_by_identifier(std::string const& identifier);
-		Region const* get_region_by_identifier(std::string const& identifier) const;
+		Region* get_region_by_identifier(const std::string_view identifier);
+		Region const* get_region_by_identifier(const std::string_view identifier) const;
 
 		return_t generate_province_shape_image(size_t new_width, size_t new_height, uint8_t const* colour_data,
-			uint8_t const* terrain_data, terrain_variant_map_t const& terrain_variant_map);
+			uint8_t const* terrain_data, terrain_variant_map_t const& terrain_variant_map, bool detailed_errors);
 		size_t get_width() const;
 		size_t get_height() const;
 		std::vector<shape_pixel_t> const& get_province_shape_image() const;
 
-		return_t add_mapmode(std::string const& identifier, Mapmode::colour_func_t colour_func);
+		return_t add_mapmode(const std::string_view identifier, Mapmode::colour_func_t colour_func);
 		void lock_mapmodes();
 		size_t get_mapmode_count() const;
 		Mapmode const* get_mapmode_by_index(Mapmode::index_t index) const;
-		Mapmode const* get_mapmode_by_identifier(std::string const& identifier) const;
+		Mapmode const* get_mapmode_by_identifier(const std::string_view identifier) const;
 		static constexpr size_t MAPMODE_COLOUR_SIZE = 4;
 		return_t generate_mapmode_colours(Mapmode::index_t index, uint8_t* target) const;
 
diff --git a/src/openvic/map/Province.cpp b/src/openvic/map/Province.cpp
index 0b6d1f4..ea284b6 100644
--- a/src/openvic/map/Province.cpp
+++ b/src/openvic/map/Province.cpp
@@ -6,7 +6,7 @@
 
 using namespace OpenVic;
 
-Province::Province(index_t new_index, std::string const& new_identifier, colour_t new_colour)
+Province::Province(const std::string_view new_identifier, colour_t new_colour, index_t new_index)
 	: HasIdentifierAndColour { new_identifier, new_colour, false },
 	  index { new_index },
 	  buildings { "buildings" } {
@@ -41,7 +41,7 @@ void Province::reset_buildings() {
 	buildings.reset();
 }
 
-Building const* Province::get_building_by_identifier(std::string const& identifier) const {
+Building const* Province::get_building_by_identifier(const std::string_view identifier) const {
 	return buildings.get_item_by_identifier(identifier);
 }
 
@@ -49,7 +49,7 @@ std::vector<Building> const& Province::get_buildings() const {
 	return buildings.get_items();
 }
 
-return_t Province::expand_building(std::string const& building_type_identifier) {
+return_t Province::expand_building(const std::string_view building_type_identifier) {
 	Building* building = buildings.get_item_by_identifier(building_type_identifier);
 	if (building == nullptr) return FAILURE;
 	return building->expand();
diff --git a/src/openvic/map/Province.hpp b/src/openvic/map/Province.hpp
index 3ca5d93..20c5870 100644
--- a/src/openvic/map/Province.hpp
+++ b/src/openvic/map/Province.hpp
@@ -29,7 +29,7 @@ namespace OpenVic {
 		Pop::pop_size_t total_population;
 		distribution_t pop_types, cultures;
 
-		Province(index_t new_index, std::string const& new_identifier, colour_t new_colour);
+		Province(const std::string_view new_identifier, colour_t new_colour, index_t new_index);
 
 	public:
 		Province(Province&&) = default;
@@ -41,9 +41,9 @@ namespace OpenVic {
 		return_t add_building(Building&& building);
 		void lock_buildings();
 		void reset_buildings();
-		Building const* get_building_by_identifier(std::string const& identifier) const;
+		Building const* get_building_by_identifier(const std::string_view identifier) const;
 		std::vector<Building> const& get_buildings() const;
-		return_t expand_building(std::string const& building_type_identifier);
+		return_t expand_building(const std::string_view building_type_identifier);
 		Good const* get_rgo() const;
 		std::string to_string() const;
 
diff --git a/src/openvic/map/Region.cpp b/src/openvic/map/Region.cpp
index b83f556..fc207e3 100644
--- a/src/openvic/map/Region.cpp
+++ b/src/openvic/map/Region.cpp
@@ -4,6 +4,41 @@
 
 using namespace OpenVic;
 
+return_t ProvinceSet::add_province(Province* province) {
+	if (locked) {
+		Logger::error("Cannot add province to province set - locked!");
+		return FAILURE;
+	}
+	if (province == nullptr) {
+		Logger::error("Cannot add province to province set - null province!");
+		return FAILURE;
+	}
+	if (contains_province(province)) {
+		Logger::error("Cannot add province ", province->get_identifier(), " to province set - already in the set!");
+		return FAILURE;
+	}
+	provinces.push_back(province);
+	return SUCCESS;
+}
+
+void ProvinceSet::lock(bool log) {
+	if (locked) {
+		Logger::error("Failed to lock province set - already locked!");
+	} else {
+		locked = true;
+		if (log) Logger::info("Locked province set with ", get_province_count(), " provinces");
+	}
+}
+
+bool ProvinceSet::is_locked() const {
+	return locked;
+}
+
+void ProvinceSet::reset() {
+	provinces.clear();
+	locked = false;
+}
+
 size_t ProvinceSet::get_province_count() const {
 	return provinces.size();
 }
@@ -16,7 +51,7 @@ std::vector<Province*> const& ProvinceSet::get_provinces() const {
 	return provinces;
 }
 
-Region::Region(std::string const& new_identifier) : HasIdentifier { new_identifier } {}
+Region::Region(const std::string_view new_identifier) : HasIdentifier { new_identifier } {}
 
 colour_t Region::get_colour() const {
 	if (provinces.empty()) return FULL_COLOUR << 16;
diff --git a/src/openvic/map/Region.hpp b/src/openvic/map/Region.hpp
index 331d883..beeb76e 100644
--- a/src/openvic/map/Region.hpp
+++ b/src/openvic/map/Region.hpp
@@ -7,8 +7,13 @@ namespace OpenVic {
 	struct ProvinceSet {
 	protected:
 		std::vector<Province*> provinces;
+		bool locked = false;
 
 	public:
+		return_t add_province(Province* province);
+		void lock(bool log = false);
+		bool is_locked() const;
+		void reset();
 		size_t get_province_count() const;
 		bool contains_province(Province const* province) const;
 		std::vector<Province*> const& get_provinces() const;
@@ -21,7 +26,7 @@ namespace OpenVic {
 		friend struct Map;
 
 	private:
-		Region(std::string const& new_identifier);
+		Region(const std::string_view new_identifier);
 
 	public:
 		Region(Region&&) = default;