Merge pull request #103 from OpenVic2Project/terrain

Cosmetic terrain + Hashmaps

16 files changed, 99 insertions, 80 deletions

diff --git a/extension/src/openvic2/Date.cpp b/extension/src/openvic2/Date.cpp
index bb891fd..ed800d5 100644
--- a/extension/src/openvic2/Date.cpp
+++ b/extension/src/openvic2/Date.cpp
@@ -1,9 +1,9 @@
-#include "openvic2/Date.hpp"
+#include "Date.hpp"
 
 #include <cctype>
 #include <algorithm>
 
-#include "openvic2/Logger.hpp"
+#include "Logger.hpp"
 
 using namespace OpenVic2;
 
diff --git a/extension/src/openvic2/GameAdvancementHook.cpp b/extension/src/openvic2/GameAdvancementHook.cpp
index 4b9bc25..d90b7b1 100644
--- a/extension/src/openvic2/GameAdvancementHook.cpp
+++ b/extension/src/openvic2/GameAdvancementHook.cpp
@@ -1,4 +1,4 @@
-#include "openvic2/GameAdvancementHook.hpp"
+#include "GameAdvancementHook.hpp"
 
 using namespace OpenVic2;
 
diff --git a/extension/src/openvic2/GameManager.cpp b/extension/src/openvic2/GameManager.cpp
index ca6e8ab..58e40bb 100644
--- a/extension/src/openvic2/GameManager.cpp
+++ b/extension/src/openvic2/GameManager.cpp
@@ -1,6 +1,6 @@
-#include "openvic2/GameManager.hpp"
+#include "GameManager.hpp"
 
-#include "openvic2/Logger.hpp"
+#include "Logger.hpp"
 
 using namespace OpenVic2;
 
diff --git a/extension/src/openvic2/GameManager.hpp b/extension/src/openvic2/GameManager.hpp
index 7b15dc8..70e98bd 100644
--- a/extension/src/openvic2/GameManager.hpp
+++ b/extension/src/openvic2/GameManager.hpp
@@ -1,8 +1,7 @@
 #pragma once
 
-#include "openvic2/GameAdvancementHook.hpp"
-#include "openvic2/map/Map.hpp"
-#include "openvic2/Types.hpp"
+#include "GameAdvancementHook.hpp"
+#include "map/Map.hpp"
 
 namespace OpenVic2 {
 	struct GameManager {
diff --git a/extension/src/openvic2/Good.hpp b/extension/src/openvic2/Good.hpp
index 54078dd..378bbc4 100644
--- a/extension/src/openvic2/Good.hpp
+++ b/extension/src/openvic2/Good.hpp
@@ -1,6 +1,5 @@
 #pragma once
 
-#include <string>
 #include "Types.hpp"
 
 namespace OpenVic2 {
diff --git a/extension/src/openvic2/Logger.cpp b/extension/src/openvic2/Logger.cpp
index 56d74ab..4d7378e 100644
--- a/extension/src/openvic2/Logger.cpp
+++ b/extension/src/openvic2/Logger.cpp
@@ -1,4 +1,4 @@
-#include "openvic2/Logger.hpp"
+#include "Logger.hpp"
 
 #include <iostream>
 
diff --git a/extension/src/openvic2/Types.cpp b/extension/src/openvic2/Types.cpp
index 42aa5a4..f51ad7c 100644
--- a/extension/src/openvic2/Types.cpp
+++ b/extension/src/openvic2/Types.cpp
@@ -1,9 +1,8 @@
-#include "openvic2/Types.hpp"
+#include "Types.hpp"
 
 #include <cassert>
 #include <sstream>
 #include <iomanip>
-#include "Types.hpp"
 
 using namespace OpenVic2;
 
@@ -16,7 +15,7 @@ std::string const& HasIdentifier::get_identifier() const {
 }
 
 HasColour::HasColour(colour_t const new_colour) : colour(new_colour) {
-	assert(colour <= MAX_COLOUR && colour != NULL_COLOUR);
+	assert(colour != NULL_COLOUR && colour <= MAX_COLOUR_RGB);
 }
 
 colour_t HasColour::get_colour() const { return colour; }
@@ -29,4 +28,4 @@ std::string OpenVic2::HasColour::colour_to_hex_string(colour_t const colour) {
 
 std::string HasColour::colour_to_hex_string() const {
 	return colour_to_hex_string(colour);
-}
\ No newline at end of file
+}
diff --git a/extension/src/openvic2/Types.hpp b/extension/src/openvic2/Types.hpp
index f1ba639..e4a0e2d 100644
--- a/extension/src/openvic2/Types.hpp
+++ b/extension/src/openvic2/Types.hpp
@@ -1,20 +1,29 @@
 #pragma once
 
-#include <string>
 #include <vector>
 #include <cstdint>
+#include <algorithm>
+#include <map>
 
-#include "openvic2/Logger.hpp"
+#include "Logger.hpp"
 
 namespace OpenVic2 {
-	//Represents a 24-bit RGB integer
+	// Represents a 24-bit RGB integer OR a 32-bit ARGB integer
 	using colour_t = uint32_t;
-	using index_t = uint16_t;
+	/* When colour_t is used as an identifier, NULL_COLOUR is disallowed
+	 * and should be reserved as an error value.
+	 * When colour_t is used in a purely graphical context, NULL_COLOUR
+	 * should be allowed.
+	 */
+	static constexpr colour_t NULL_COLOUR = 0, MAX_COLOUR_RGB = 0xFFFFFF;
+	constexpr colour_t to_alpha_value(float a) {
+		return static_cast<colour_t>(std::clamp(a, 0.0f, 1.0f) * 255.0f) << 24;
+	}
 
-	static constexpr colour_t NULL_COLOUR = 0, MAX_COLOUR = 0xFFFFFF;
+	using index_t = uint16_t;
 	static constexpr index_t NULL_INDEX = 0, MAX_INDEX = 0xFFFF;
 
-	//TODO: price_t must be changed to a fixed-point numeric type before multiplayer
+	// TODO: price_t must be changed to a fixed-point numeric type before multiplayer
 	using price_t = double;
 	using return_t = bool;
 
@@ -65,9 +74,12 @@ namespace OpenVic2 {
 	 */
 	template<class T, typename std::enable_if<std::is_base_of<HasIdentifier, T>::value>::type* = nullptr>
 	class IdentifierRegistry {
+		using identifier_index_map_t = std::map<std::string, size_t>;
+
 		const std::string name;
 		std::vector<T> items;
 		bool locked = false;
+		identifier_index_map_t identifier_index_map;
 	public:
 		IdentifierRegistry(std::string const& new_name) : name(new_name) {}
 		return_t add_item(T&& item) {
@@ -80,6 +92,7 @@ namespace OpenVic2 {
 				Logger::error("Cannot add item to the ", name, " registry - an item with the identifier \"", item.get_identifier(), "\" already exists!");
 				return FAILURE;
 			}
+			identifier_index_map[item.get_identifier()] = items.size();
 			items.push_back(std::move(item));
 			return SUCCESS;
 		}
@@ -95,6 +108,7 @@ namespace OpenVic2 {
 			return locked;
 		}
 		void reset() {
+			identifier_index_map.clear();
 			items.clear();
 			locked = false;
 		}
@@ -102,15 +116,13 @@ namespace OpenVic2 {
 			return items.size();
 		}
 		T* get_item_by_identifier(std::string const& identifier) {
-			if (!identifier.empty())
-				for (T& item : items)
-					if (item.get_identifier() == identifier) return &item;
+			const identifier_index_map_t::const_iterator it = identifier_index_map.find(identifier);
+			if (it != identifier_index_map.end()) return &items[it->second];
 			return nullptr;
 		}
 		T const* get_item_by_identifier(std::string const& identifier) const {
-			if (!identifier.empty())
-				for (T const& item : items)
-					if (item.get_identifier() == identifier) return &item;
+			const identifier_index_map_t::const_iterator it = identifier_index_map.find(identifier);
+			if (it != identifier_index_map.end()) return &items[it->second];
 			return nullptr;
 		}
 		T* get_item_by_index(size_t index) {
diff --git a/extension/src/openvic2/map/Building.cpp b/extension/src/openvic2/map/Building.cpp
index 00e121b..1e26873 100644
--- a/extension/src/openvic2/map/Building.cpp
+++ b/extension/src/openvic2/map/Building.cpp
@@ -1,9 +1,9 @@
-#include "openvic2/map/Building.hpp"
+#include "Building.hpp"
 
 #include <cassert>
 
-#include "openvic2/Logger.hpp"
-#include "openvic2/map/Province.hpp"
+#include "../Logger.hpp"
+#include "Province.hpp"
 
 using namespace OpenVic2;
 
diff --git a/extension/src/openvic2/map/Building.hpp b/extension/src/openvic2/map/Building.hpp
index 1305014..78d08ae 100644
--- a/extension/src/openvic2/map/Building.hpp
+++ b/extension/src/openvic2/map/Building.hpp
@@ -2,8 +2,8 @@
 
 #include <vector>
 
-#include "openvic2/Types.hpp"
-#include "openvic2/Date.hpp"
+#include "../Types.hpp"
+#include "../Date.hpp"
 
 namespace OpenVic2 {
 	struct Province;
diff --git a/extension/src/openvic2/map/Map.cpp b/extension/src/openvic2/map/Map.cpp
index 4e7c0bb..1f44c43 100644
--- a/extension/src/openvic2/map/Map.cpp
+++ b/extension/src/openvic2/map/Map.cpp
@@ -1,9 +1,9 @@
-#include "openvic2/map/Map.hpp"
+#include "Map.hpp"
 
 #include <cassert>
 #include <unordered_set>
 
-#include "openvic2/Logger.hpp"
+#include "../Logger.hpp"
 
 using namespace OpenVic2;
 
@@ -31,16 +31,17 @@ return_t Map::add_province(std::string const& identifier, colour_t colour) {
 		Logger::error("Invalid province identifier - empty!");
 		return FAILURE;
 	}
-	if (colour == NULL_COLOUR || colour > MAX_COLOUR) {
+	if (colour == NULL_COLOUR || colour > MAX_COLOUR_RGB) {
 		Logger::error("Invalid province colour: ", Province::colour_to_hex_string(colour));
 		return FAILURE;
 	}
 	Province new_province{ static_cast<index_t>(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());
+	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());
 		return FAILURE;
 	}
+	colour_index_map[new_province.get_colour()] = new_province.get_index();
 	return provinces.add_item(std::move(new_province));
 }
 
@@ -142,20 +143,10 @@ Province const* Map::get_province_by_identifier(std::string const& identifier) c
 	return provinces.get_item_by_identifier(identifier);
 }
 
-Province* Map::get_province_by_colour(colour_t colour) {
-	if (colour != NULL_COLOUR)
-		for (Province& province : provinces.get_items())
-			if (province.get_colour() == colour) return &province;
-	return nullptr;
-}
-
-Province const* Map::get_province_by_colour(colour_t colour) const {
-	if (colour == NULL_COLOUR) { return nullptr; }
-	for (Province const& province : provinces.get_items()) {
-		if (province.get_colour() == colour)
-			return &province;
-	}
-	return nullptr;
+index_t Map::get_index_from_colour(colour_t colour) const {
+	const colour_index_map_t::const_iterator it = colour_index_map.find(colour);
+	if (it != colour_index_map.end()) return it->second;
+	return NULL_INDEX;
 }
 
 index_t Map::get_province_index_at(size_t x, size_t y) const {
@@ -175,7 +166,8 @@ static colour_t colour_at(uint8_t const* colour_data, int32_t idx) {
 	return (colour_data[idx * 3] << 16) | (colour_data[idx * 3 + 1] << 8) | colour_data[idx * 3 + 2];
 }
 
-return_t Map::generate_province_shape_image(size_t new_width, size_t new_height, uint8_t const* colour_data) {
+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) {
 	if (!province_shape_image.empty()) {
 		Logger::error("Province index image has already been generated!");
 		return FAILURE;
@@ -192,47 +184,61 @@ return_t Map::generate_province_shape_image(size_t new_width, size_t new_height,
 		Logger::error("Province colour data pointer is null!");
 		return FAILURE;
 	}
+	if (terrain_data == nullptr) {
+		Logger::error("Province terrain data pointer is null!");
+		return FAILURE;
+	}
 	width = new_width;
 	height = new_height;
 	province_shape_image.resize(width * height);
 
 	std::vector<bool> province_checklist(provinces.get_item_count());
 	return_t ret = SUCCESS;
-	std::unordered_set<colour_t> unrecognised_colours;
+	std::unordered_set<colour_t> unrecognised_province_colours, unrecognised_terrain_colours;
 
 	for (int32_t y = 0; y < height; ++y) {
 		for (int32_t x = 0; x < width; ++x) {
 			const int32_t idx = x + y * width;
-			const colour_t colour = colour_at(colour_data, idx);
+
+			const colour_t terrain_colour = colour_at(terrain_data, idx);
+			const terrain_variant_map_t::const_iterator it = terrain_variant_map.find(terrain_colour);
+			if (it != terrain_variant_map.end()) province_shape_image[idx].terrain = it->second;
+			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;
+				}
+				province_shape_image[idx].terrain = 0;
+			}
+
+			const colour_t province_colour = colour_at(colour_data, idx);
 			if (x > 0) {
 				const int32_t jdx = idx - 1;
-				if (colour_at(colour_data, jdx) == colour) {
-					province_shape_image[idx] = province_shape_image[jdx];
+				if (colour_at(colour_data, jdx) == province_colour) {
+					province_shape_image[idx].index = province_shape_image[jdx].index;
 					continue;
 				}
 			}
 			if (y > 0) {
 				const int32_t jdx = idx - width;
-				if (colour_at(colour_data, jdx) == colour) {
-					province_shape_image[idx] = province_shape_image[jdx];
+				if (colour_at(colour_data, jdx) == province_colour) {
+					province_shape_image[idx].index = province_shape_image[jdx].index;
 					continue;
 				}
 			}
-			Province const* province = get_province_by_colour(colour);
-			if (province != nullptr) {
-				const index_t index = province->get_index();
+			const index_t index = get_index_from_colour(province_colour);
+			if (index != NULL_INDEX) {
 				province_checklist[index - 1] = true;
 				province_shape_image[idx].index = index;
-				province_shape_image[idx].terrain = !province->is_water();
 				continue;
 			}
-			if (unrecognised_colours.find(colour) == unrecognised_colours.end()) {
-				unrecognised_colours.insert(colour);
-				Logger::error("Unrecognised province colour ", Province::colour_to_hex_string(colour), " at (", x, ", ", y, ")");
+			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;
 			}
 			province_shape_image[idx].index = NULL_INDEX;
-			province_shape_image[idx].terrain = 0;
 		}
 	}
 
@@ -303,6 +309,7 @@ return_t Map::generate_mapmode_colours(Mapmode::index_t index, uint8_t* target)
 		*target++ = (colour >> 16) & 0xFF;
 		*target++ = (colour >> 8) & 0xFF;
 		*target++ = colour & 0xFF;
+		*target++ = (colour >> 24) & 0xFF;
 	}
 	return SUCCESS;
 }
diff --git a/extension/src/openvic2/map/Map.hpp b/extension/src/openvic2/map/Map.hpp
index e5be9c7..cb8dcb1 100644
--- a/extension/src/openvic2/map/Map.hpp
+++ b/extension/src/openvic2/map/Map.hpp
@@ -2,8 +2,7 @@
 
 #include <functional>
 
-#include "openvic2/map/Region.hpp"
-#include "openvic2/Types.hpp"
+#include "Region.hpp"
 
 namespace OpenVic2 {
 
@@ -26,13 +25,18 @@ namespace OpenVic2 {
 	 * MAP-4
 	 */
 	struct Map {
+		using terrain_t = uint8_t;
+		using terrain_variant_map_t = std::map<colour_t, terrain_t>;
+
 		#pragma pack(push, 1)
 		struct shape_pixel_t {
 			index_t index;
-			uint8_t terrain;
+			terrain_t terrain;
 		};
 		#pragma pack(pop)
 	private:
+		using colour_index_map_t = std::map<colour_t, index_t>;
+
 		IdentifierRegistry<Province> provinces;
 		IdentifierRegistry<Region> regions;
 		IdentifierRegistry<Mapmode> mapmodes;
@@ -41,6 +45,9 @@ namespace OpenVic2 {
 
 		size_t width = 0, height = 0;
 		std::vector<shape_pixel_t> province_shape_image;
+		colour_index_map_t colour_index_map;
+
+		index_t get_index_from_colour(colour_t colour) const;
 	public:
 		Map();
 
@@ -56,14 +63,13 @@ namespace OpenVic2 {
 		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_colour(colour_t colour);
-		Province const* get_province_by_colour(colour_t colour) const;
 		index_t get_province_index_at(size_t x, size_t y) const;
 
 		Region* get_region_by_identifier(std::string const& identifier);
 		Region const* get_region_by_identifier(std::string const& identifier) const;
 
-		return_t generate_province_shape_image(size_t new_width, size_t new_height, uint8_t const* colour_data);
+		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);
 		size_t get_width() const;
 		size_t get_height() const;
 		std::vector<shape_pixel_t> const& get_province_shape_image() const;
@@ -73,7 +79,7 @@ namespace OpenVic2 {
 		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;
-		static constexpr size_t MAPMODE_COLOUR_SIZE = 3;
+		static constexpr size_t MAPMODE_COLOUR_SIZE = 4;
 		return_t generate_mapmode_colours(Mapmode::index_t index, uint8_t* target) const;
 
 		return_t generate_province_buildings(BuildingManager const& manager);
diff --git a/extension/src/openvic2/map/Province.cpp b/extension/src/openvic2/map/Province.cpp
index 472cccb..b3d455b 100644
--- a/extension/src/openvic2/map/Province.cpp
+++ b/extension/src/openvic2/map/Province.cpp
@@ -1,4 +1,4 @@
-#include "openvic2/map/Province.hpp"
+#include "Province.hpp"
 
 #include <cassert>
 #include <sstream>
diff --git a/extension/src/openvic2/map/Province.hpp b/extension/src/openvic2/map/Province.hpp
index 65eaa09..9b07fc1 100644
--- a/extension/src/openvic2/map/Province.hpp
+++ b/extension/src/openvic2/map/Province.hpp
@@ -1,7 +1,6 @@
 #pragma once
 
-#include "openvic2/map/Building.hpp"
-#include "openvic2/Types.hpp"
+#include "Building.hpp"
 
 namespace OpenVic2 {
 	struct Map;
diff --git a/extension/src/openvic2/map/Region.cpp b/extension/src/openvic2/map/Region.cpp
index 6839a10..da0dfdd 100644
--- a/extension/src/openvic2/map/Region.cpp
+++ b/extension/src/openvic2/map/Region.cpp
@@ -1,7 +1,6 @@
-#include "openvic2/map/Region.hpp"
+#include "Region.hpp"
 
 #include <cassert>
-#include <algorithm>
 
 using namespace OpenVic2;
 
diff --git a/extension/src/openvic2/map/Region.hpp b/extension/src/openvic2/map/Region.hpp
index 58fad31..3920dfc 100644
--- a/extension/src/openvic2/map/Region.hpp
+++ b/extension/src/openvic2/map/Region.hpp
@@ -2,8 +2,7 @@
 
 #include <set>
 
-#include "openvic2/map/Province.hpp"
-#include "openvic2/Types.hpp"
+#include "Province.hpp"
 
 namespace OpenVic2 {