aboutsummaryrefslogtreecommitdiff
path: root/src/openvic2
diff options
context:
space:
mode:
Diffstat (limited to 'src/openvic2')
-rw-r--r--src/openvic2/Date.cpp161
-rw-r--r--src/openvic2/Date.hpp83
-rw-r--r--src/openvic2/GameAdvancementHook.cpp72
-rw-r--r--src/openvic2/GameAdvancementHook.hpp42
-rw-r--r--src/openvic2/GameManager.cpp46
-rw-r--r--src/openvic2/GameManager.hpp29
-rw-r--r--src/openvic2/Good.cpp3
-rw-r--r--src/openvic2/Good.hpp21
-rw-r--r--src/openvic2/Logger.cpp26
-rw-r--r--src/openvic2/Logger.hpp83
-rw-r--r--src/openvic2/Types.cpp31
-rw-r--r--src/openvic2/Types.hpp141
-rw-r--r--src/openvic2/map/Building.cpp124
-rw-r--r--src/openvic2/map/Building.hpp75
-rw-r--r--src/openvic2/map/Map.cpp332
-rw-r--r--src/openvic2/map/Map.hpp90
-rw-r--r--src/openvic2/map/Province.cpp68
-rw-r--r--src/openvic2/map/Province.hpp42
-rw-r--r--src/openvic2/map/Region.cpp24
-rw-r--r--src/openvic2/map/Region.hpp30
20 files changed, 1523 insertions, 0 deletions
diff --git a/src/openvic2/Date.cpp b/src/openvic2/Date.cpp
new file mode 100644
index 0000000..ed800d5
--- /dev/null
+++ b/src/openvic2/Date.cpp
@@ -0,0 +1,161 @@
+#include "Date.hpp"
+
+#include <cctype>
+#include <algorithm>
+
+#include "Logger.hpp"
+
+using namespace OpenVic2;
+
+Timespan::Timespan(day_t value) : days{value} {}
+
+bool Timespan::operator<(Timespan other) const { return days < other.days; };
+bool Timespan::operator>(Timespan other) const { return days > other.days; };
+bool Timespan::operator<=(Timespan other) const { return days <= other.days; };
+bool Timespan::operator>=(Timespan other) const { return days >= other.days; };
+bool Timespan::operator==(Timespan other) const { return days == other.days; };
+bool Timespan::operator!=(Timespan other) const { return days != other.days; };
+
+Timespan Timespan::operator+(Timespan other) const { return days + other.days; }
+
+Timespan Timespan::operator-(Timespan other) const { return days - other.days; }
+
+Timespan Timespan::operator*(day_t factor) const { return days * factor; }
+
+Timespan Timespan::operator/(day_t factor) const { return days / factor; }
+
+Timespan& Timespan::operator+=(Timespan other) {
+ days += other.days;
+ return *this;
+}
+
+Timespan& Timespan::operator-=(Timespan other) {
+ days -= other.days;
+ return *this;
+}
+
+Timespan& Timespan::operator++() {
+ days++;
+ return *this;
+}
+
+Timespan Timespan::operator++(int) {
+ Timespan old = *this;
+ ++(*this);
+ return old;
+}
+
+Timespan::operator day_t() const {
+ return days;
+}
+
+Timespan::operator double() const {
+ return days;
+}
+
+Timespan::operator std::string() const {
+ return std::to_string(days);
+}
+
+std::ostream& OpenVic2::operator<<(std::ostream& out, Timespan timespan) {
+ return out << static_cast<std::string>(timespan);
+}
+
+Timespan Date::_dateToTimespan(year_t year, month_t month, day_t day) {
+ month = std::clamp<month_t>(month, 1, MONTHS_IN_YEAR);
+ day = std::clamp<day_t>(day, 1, DAYS_IN_MONTH[month - 1]);
+ return year * DAYS_IN_YEAR + DAYS_UP_TO_MONTH[month - 1] + day - 1;
+}
+
+Date::Date(Timespan total_days) : timespan{ total_days } {
+ if (timespan < 0) {
+ Logger::error("Invalid timespan for date: ", timespan, " (cannot be negative)");
+ timespan = 0;
+ }
+}
+
+Date::Date(year_t year, month_t month, day_t day) : timespan{ _dateToTimespan(year, month, day) } {}
+
+Date::year_t Date::getYear() const {
+ return static_cast<Timespan::day_t>(timespan) / DAYS_IN_YEAR;
+}
+
+Date::month_t Date::getMonth() const {
+ return ((static_cast<Timespan::day_t>(timespan) % DAYS_IN_YEAR) / 32) + 1;
+}
+
+Date::day_t Date::getDay() const {
+ const Timespan::day_t days_in_year = static_cast<Timespan::day_t>(timespan) % DAYS_IN_YEAR;
+ return days_in_year - DAYS_UP_TO_MONTH[days_in_year / 32] + 1;
+}
+
+
+bool Date::operator<(Date other) const { return timespan < other.timespan; };
+bool Date::operator>(Date other) const { return timespan > other.timespan; };
+bool Date::operator<=(Date other) const { return timespan <= other.timespan; };
+bool Date::operator>=(Date other) const { return timespan >= other.timespan; };
+bool Date::operator==(Date other) const { return timespan == other.timespan; };
+bool Date::operator!=(Date other) const { return timespan != other.timespan; };
+
+Date Date::operator+(Timespan other) const { return timespan + other; }
+
+Timespan Date::operator-(Date other) const { return timespan - other.timespan; }
+
+Date& Date::operator+=(Timespan other) {
+ timespan += other;
+ return *this;
+}
+
+Date& Date::operator-=(Timespan other) {
+ timespan -= other;
+ return *this;
+}
+
+Date& Date::operator++() {
+ timespan++;
+ return *this;
+}
+
+Date Date::operator++(int) {
+ Date old = *this;
+ ++(*this);
+ return old;
+}
+
+Date::operator std::string() const {
+ std::stringstream ss;
+ ss << *this;
+ return ss.str();
+}
+
+std::ostream& OpenVic2::operator<<(std::ostream& out, Date date) {
+ return out << (int) date.getYear() << '.' << (int) date.getMonth() << '.' << (int) date.getDay();
+}
+
+// Parsed from string of the form YYYY.MM.DD
+Date Date::from_string(std::string const& date) {
+ year_t year = 0;
+ month_t month = 1;
+ day_t day = 1;
+
+ size_t first_pos = 0;
+ while (first_pos < date.length() && std::isdigit(date[first_pos++]));
+ year = atoi(date.substr(0, first_pos).c_str());
+ if (first_pos < date.length()) {
+ if (date[first_pos] == '.') {
+ size_t second_pos = first_pos + 1;
+ while (second_pos < date.length() && std::isdigit(date[second_pos++]));
+ month = atoi(date.substr(first_pos, second_pos - first_pos).c_str());
+ if (second_pos < date.length()) {
+ if (date[second_pos] == '.') {
+ size_t third_pos = second_pos + 1;
+ while (third_pos < date.length() && std::isdigit(date[third_pos++]));
+ day = atoi(date.substr(second_pos, third_pos - second_pos).c_str());
+ if (third_pos < date.length())
+ Logger::error("Unexpected string \"", date.substr(third_pos), "\" at the end of date ", date);
+ } else Logger::error("Unexpected character \"", date[second_pos], "\" in date ", date);
+ }
+ } else Logger::error("Unexpected character \"", date[first_pos], "\" in date ", date);
+ }
+ return _dateToTimespan(year, month, day);
+};
diff --git a/src/openvic2/Date.hpp b/src/openvic2/Date.hpp
new file mode 100644
index 0000000..b19602b
--- /dev/null
+++ b/src/openvic2/Date.hpp
@@ -0,0 +1,83 @@
+#pragma once
+
+#include <cstdint>
+#include <string>
+#include <ostream>
+
+namespace OpenVic2 {
+ // A relative period between points in time, measured in days
+ struct Timespan {
+ using day_t = int64_t;
+ private:
+ day_t days;
+ public:
+ Timespan(day_t value = 0);
+
+ bool operator<(Timespan other) const;
+ bool operator>(Timespan other) const;
+ bool operator<=(Timespan other) const;
+ bool operator>=(Timespan other) const;
+ bool operator==(Timespan other) const;
+ bool operator!=(Timespan other) const;
+
+ Timespan operator+(Timespan other) const;
+ Timespan operator-(Timespan other) const;
+ Timespan operator*(day_t factor) const;
+ Timespan operator/(day_t factor) const;
+ Timespan& operator+=(Timespan other);
+ Timespan& operator-=(Timespan other);
+ Timespan& operator++();
+ Timespan operator++(int);
+
+ explicit operator day_t() const;
+ explicit operator double() const;
+ explicit operator std::string() const;
+ };
+ std::ostream& operator<< (std::ostream& out, Timespan timespan);
+
+ // Represents an in-game date
+ // Note: Current implementation does not account for leap-years, or dates before Year 0
+ struct Date {
+ using year_t = uint16_t;
+ using month_t = uint8_t;
+ using day_t = uint8_t;
+
+ static constexpr Timespan::day_t MONTHS_IN_YEAR = 12;
+ static constexpr Timespan::day_t DAYS_IN_YEAR = 365;
+ static constexpr Timespan::day_t DAYS_IN_MONTH[MONTHS_IN_YEAR] = { 31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31 };
+ static constexpr Timespan::day_t DAYS_UP_TO_MONTH[MONTHS_IN_YEAR] = { 0, 31, 59, 90, 120, 151, 181, 212, 243, 273, 304, 334 };
+ private:
+ // Number of days since Jan 1st, Year 0
+ Timespan timespan;
+
+ static Timespan _dateToTimespan(year_t year, month_t month, day_t day);
+ public:
+ // The Timespan is considered to be the number of days since Jan 1st, Year 0
+ Date(Timespan total_days);
+ // Year month day specification
+ Date(year_t year = 0, month_t month = 1, day_t day = 1);
+
+ year_t getYear() const;
+ month_t getMonth() const;
+ day_t getDay() const;
+
+ bool operator<(Date other) const;
+ bool operator>(Date other) const;
+ bool operator<=(Date other) const;
+ bool operator>=(Date other) const;
+ bool operator==(Date other) const;
+ bool operator!=(Date other) const;
+
+ Date operator+(Timespan other) const;
+ Timespan operator-(Date other) const;
+ Date& operator+=(Timespan other);
+ Date& operator-=(Timespan other);
+ Date& operator++();
+ Date operator++(int);
+
+ explicit operator std::string() const;
+ // Parsed from string of the form YYYY.MM.DD
+ static Date from_string(std::string const& date);
+ };
+ std::ostream& operator<< (std::ostream& out, Date date);
+}
diff --git a/src/openvic2/GameAdvancementHook.cpp b/src/openvic2/GameAdvancementHook.cpp
new file mode 100644
index 0000000..d90b7b1
--- /dev/null
+++ b/src/openvic2/GameAdvancementHook.cpp
@@ -0,0 +1,72 @@
+#include "GameAdvancementHook.hpp"
+
+using namespace OpenVic2;
+
+const std::vector<std::chrono::milliseconds> GameAdvancementHook::GAME_SPEEDS = {
+ std::chrono::milliseconds{ 4000 },
+ std::chrono::milliseconds{ 3000 },
+ std::chrono::milliseconds{ 2000 },
+ std::chrono::milliseconds{ 1000 },
+ std::chrono::milliseconds{ 100 },
+ std::chrono::milliseconds{ 1 } };
+
+GameAdvancementHook::GameAdvancementHook(AdvancementFunction tickFunction, RefreshFunction updateFunction, bool startPaused, speed_t startingSpeed)
+ : triggerFunction{ tickFunction }, refreshFunction{ updateFunction }, isPaused{ startPaused } {
+ lastPolledTime = std::chrono::high_resolution_clock::now();
+ setSimulationSpeed(startingSpeed);
+}
+
+void GameAdvancementHook::setSimulationSpeed(speed_t speed) {
+ if (speed < 0)
+ currentSpeed = 0;
+ else if (speed >= GAME_SPEEDS.size())
+ currentSpeed = GAME_SPEEDS.size() - 1;
+ else
+ currentSpeed = speed;
+}
+
+GameAdvancementHook::speed_t GameAdvancementHook::getSimulationSpeed() const {
+ return currentSpeed;
+}
+
+void GameAdvancementHook::increaseSimulationSpeed() {
+ setSimulationSpeed(currentSpeed + 1);
+}
+
+void GameAdvancementHook::decreaseSimulationSpeed() {
+ setSimulationSpeed(currentSpeed - 1);
+}
+
+bool GameAdvancementHook::canIncreaseSimulationSpeed() const {
+ return currentSpeed + 1 < GAME_SPEEDS.size();
+}
+
+bool GameAdvancementHook::canDecreaseSimulationSpeed() const {
+ return currentSpeed > 0;
+}
+
+GameAdvancementHook& GameAdvancementHook::operator++() {
+ increaseSimulationSpeed();
+ return *this;
+};
+
+GameAdvancementHook& GameAdvancementHook::operator--() {
+ decreaseSimulationSpeed();
+ return *this;
+};
+
+void GameAdvancementHook::conditionallyAdvanceGame() {
+ if (!isPaused) {
+ std::chrono::time_point<std::chrono::high_resolution_clock> currentTime = std::chrono::high_resolution_clock::now();
+ if (std::chrono::duration_cast<std::chrono::milliseconds>(currentTime - lastPolledTime) >= GAME_SPEEDS[currentSpeed]) {
+ lastPolledTime = currentTime;
+ if (triggerFunction) triggerFunction();
+ }
+ }
+ if (refreshFunction) refreshFunction();
+}
+
+void GameAdvancementHook::reset() {
+ isPaused = true;
+ currentSpeed = 0;
+}
diff --git a/src/openvic2/GameAdvancementHook.hpp b/src/openvic2/GameAdvancementHook.hpp
new file mode 100644
index 0000000..07f8414
--- /dev/null
+++ b/src/openvic2/GameAdvancementHook.hpp
@@ -0,0 +1,42 @@
+#pragma once
+
+#include <chrono>
+#include <functional>
+#include <vector>
+
+namespace OpenVic2 {
+ //Conditionally advances game with provided behaviour
+ //Class governs game speed and pause state
+ class GameAdvancementHook {
+ public:
+ using AdvancementFunction = std::function<void()>;
+ using RefreshFunction = std::function<void()>;
+ using speed_t = int8_t;
+
+ //Minimum number of miliseconds before the simulation advances
+ static const std::vector<std::chrono::milliseconds> GAME_SPEEDS;
+
+ private:
+ std::chrono::time_point<std::chrono::high_resolution_clock> lastPolledTime;
+ //A function pointer that advances the simulation, intended to be a capturing lambda or something similar. May need to be reworked later
+ AdvancementFunction triggerFunction;
+ RefreshFunction refreshFunction;
+ speed_t currentSpeed;
+
+ public:
+ bool isPaused;
+
+ GameAdvancementHook(AdvancementFunction tickFunction, RefreshFunction updateFunction, bool startPaused = true, speed_t startingSpeed = 0);
+
+ void setSimulationSpeed(speed_t speed);
+ speed_t getSimulationSpeed() const;
+ void increaseSimulationSpeed();
+ void decreaseSimulationSpeed();
+ bool canIncreaseSimulationSpeed() const;
+ bool canDecreaseSimulationSpeed() const;
+ GameAdvancementHook& operator++();
+ GameAdvancementHook& operator--();
+ void conditionallyAdvanceGame();
+ void reset();
+ };
+} \ No newline at end of file
diff --git a/src/openvic2/GameManager.cpp b/src/openvic2/GameManager.cpp
new file mode 100644
index 0000000..58e40bb
--- /dev/null
+++ b/src/openvic2/GameManager.cpp
@@ -0,0 +1,46 @@
+#include "GameManager.hpp"
+
+#include "Logger.hpp"
+
+using namespace OpenVic2;
+
+GameManager::GameManager(state_updated_func_t state_updated_callback)
+ : clock{ [this]() { tick(); }, [this]() { update_state(); } }, state_updated{ state_updated_callback } {}
+
+void GameManager::set_needs_update() {
+ needs_update = true;
+}
+
+void GameManager::update_state() {
+ if (needs_update) {
+ Logger::info("Update: ", today);
+ map.update_state(today);
+ if (state_updated) state_updated();
+ needs_update = false;
+ }
+}
+
+void GameManager::tick() {
+ today++;
+ Logger::info("Tick: ", today);
+ map.tick(today);
+ set_needs_update();
+}
+
+return_t GameManager::setup() {
+ clock.reset();
+ today = { 1836 };
+ set_needs_update();
+ return map.generate_province_buildings(building_manager);
+}
+
+Date const& GameManager::get_today() const {
+ return today;
+}
+
+return_t GameManager::expand_building(index_t province_index, std::string const& building_type_identifier) {
+ set_needs_update();
+ Province* province = map.get_province_by_index(province_index);
+ if (province == nullptr) return FAILURE;
+ return province->expand_building(building_type_identifier);
+}
diff --git a/src/openvic2/GameManager.hpp b/src/openvic2/GameManager.hpp
new file mode 100644
index 0000000..70e98bd
--- /dev/null
+++ b/src/openvic2/GameManager.hpp
@@ -0,0 +1,29 @@
+#pragma once
+
+#include "GameAdvancementHook.hpp"
+#include "map/Map.hpp"
+
+namespace OpenVic2 {
+ struct GameManager {
+ using state_updated_func_t = std::function<void()>;
+
+ Map map;
+ BuildingManager building_manager;
+ GameAdvancementHook clock;
+ private:
+ Date today;
+ state_updated_func_t state_updated;
+ bool needs_update;
+
+ void set_needs_update();
+ void update_state();
+ void tick();
+ public:
+ GameManager(state_updated_func_t state_updated_callback);
+
+ return_t setup();
+
+ Date const& get_today() const;
+ return_t expand_building(index_t province_index, std::string const& building_type_identifier);
+ };
+}
diff --git a/src/openvic2/Good.cpp b/src/openvic2/Good.cpp
new file mode 100644
index 0000000..e3389de
--- /dev/null
+++ b/src/openvic2/Good.cpp
@@ -0,0 +1,3 @@
+#include "Good.hpp"
+
+using namespace OpenVic2;
diff --git a/src/openvic2/Good.hpp b/src/openvic2/Good.hpp
new file mode 100644
index 0000000..378bbc4
--- /dev/null
+++ b/src/openvic2/Good.hpp
@@ -0,0 +1,21 @@
+#pragma once
+
+#include "Types.hpp"
+
+namespace OpenVic2 {
+ class Good : HasIdentifier {
+ public:
+ std::string category;
+ price_t cost;
+ std::string colour;
+ bool isAvailable;
+ bool isTradable;
+ bool isMoney;
+ bool hasOverseasPenalty;
+
+ Good(Good&&) = default;
+ Good(std::string const& identifier,std::string const& category, price_t cost, std::string const& colour,
+ bool isAvailable, bool isTradable, bool isMoney, bool hasOverseasPenalty) : HasIdentifier(identifier),
+ category(category), cost(cost), colour(colour), isAvailable(isAvailable), isMoney(isMoney), hasOverseasPenalty(hasOverseasPenalty) {};
+ };
+}
diff --git a/src/openvic2/Logger.cpp b/src/openvic2/Logger.cpp
new file mode 100644
index 0000000..4d7378e
--- /dev/null
+++ b/src/openvic2/Logger.cpp
@@ -0,0 +1,26 @@
+#include "Logger.hpp"
+
+#include <iostream>
+
+using namespace OpenVic2;
+
+Logger::log_func_t Logger::info_func = [](std::string&& str) { std::cout << str; };
+Logger::log_func_t Logger::error_func = [](std::string&& str) { std::cerr << str; };
+
+char const* Logger::get_filename(char const* filepath) {
+ if (filepath == nullptr) return nullptr;
+ char const* last_slash = filepath;
+ while (*filepath != '\0') {
+ if (*filepath == '\\' || *filepath == '/') last_slash = filepath + 1;
+ filepath++;
+ }
+ return last_slash;
+}
+
+void Logger::set_info_func(log_func_t log_func) {
+ info_func = log_func;
+}
+
+void Logger::set_error_func(log_func_t log_func) {
+ error_func = log_func;
+}
diff --git a/src/openvic2/Logger.hpp b/src/openvic2/Logger.hpp
new file mode 100644
index 0000000..624df29
--- /dev/null
+++ b/src/openvic2/Logger.hpp
@@ -0,0 +1,83 @@
+#pragma once
+
+#include <functional>
+#include <sstream>
+#ifdef __cpp_lib_source_location
+#include <source_location>
+#endif
+
+namespace OpenVic2 {
+
+ #ifndef __cpp_lib_source_location
+ #include <string>
+ //Implementation of std::source_location for compilers that do not support it
+ //Note: uses non-standard extensions that are supported by Clang, GCC, and MSVC
+ //https://clang.llvm.org/docs/LanguageExtensions.html#source-location-builtins
+ //https://stackoverflow.com/a/67970107
+ class source_location {
+ std::string _file;
+ int _line;
+ std::string _function;
+
+ public:
+ source_location(std::string f, int l, std::string n) : _file(f), _line(l), _function(n) {}
+ static source_location current(std::string f = __builtin_FILE(), int l = __builtin_LINE(), std::string n = __builtin_FUNCTION()) {
+ return source_location(f, l, n);
+ }
+
+ inline char const* file_name() const { return _file.c_str(); }
+ inline int line() const {return _line; }
+ inline char const* function_name() const { return _function.c_str(); }
+ };
+ #endif
+
+ class Logger {
+ using log_func_t = std::function<void(std::string&&)>;
+
+ #ifdef __cpp_lib_source_location
+ using source_location = std::source_location;
+ #else
+ using source_location = OpenVic2::source_location;
+ #endif
+
+ static log_func_t info_func, error_func;
+
+ static char const* get_filename(char const* filepath);
+
+ template <typename... Ts>
+ struct log {
+ log(log_func_t log_func, Ts&&... ts, const source_location& location) {
+ if (log_func) {
+ std::stringstream stream;
+ stream << std::endl << get_filename(location.file_name()) << "(" << location.line() << ") `" << location.function_name() << "`: ";
+ ((stream << std::forward<Ts>(ts)), ...);
+ stream << std::endl;
+ log_func(stream.str());
+ }
+ }
+ };
+ public:
+ static void set_info_func(log_func_t log_func);
+ static void set_error_func(log_func_t log_func);
+
+ template <typename... Ts>
+ struct info {
+ info(Ts&&... ts, const source_location& location = source_location::current()) {
+ log<Ts...>{ info_func, std::forward<Ts>(ts)..., location };
+ }
+ };
+
+ template <typename... Ts>
+ info(Ts&&...) -> info<Ts...>;
+
+ template <typename... Ts>
+ struct error {
+ error(Ts&&... ts, const source_location& location = source_location::current()) {
+ log<Ts...>{ error_func, std::forward<Ts>(ts)..., location };
+ }
+ };
+
+ template <typename... Ts>
+ error(Ts&&...) -> error<Ts...>;
+ };
+}
diff --git a/src/openvic2/Types.cpp b/src/openvic2/Types.cpp
new file mode 100644
index 0000000..f51ad7c
--- /dev/null
+++ b/src/openvic2/Types.cpp
@@ -0,0 +1,31 @@
+#include "Types.hpp"
+
+#include <cassert>
+#include <sstream>
+#include <iomanip>
+
+using namespace OpenVic2;
+
+HasIdentifier::HasIdentifier(std::string const& new_identifier) : identifier{ new_identifier } {
+ assert(!identifier.empty());
+}
+
+std::string const& HasIdentifier::get_identifier() const {
+ return identifier;
+}
+
+HasColour::HasColour(colour_t const new_colour) : colour(new_colour) {
+ assert(colour != NULL_COLOUR && colour <= MAX_COLOUR_RGB);
+}
+
+colour_t HasColour::get_colour() const { return colour; }
+
+std::string OpenVic2::HasColour::colour_to_hex_string(colour_t const colour) {
+ std::ostringstream stream;
+ stream << std::hex << std::setfill('0') << std::setw(6) << colour;
+ return stream.str();
+}
+
+std::string HasColour::colour_to_hex_string() const {
+ return colour_to_hex_string(colour);
+}
diff --git a/src/openvic2/Types.hpp b/src/openvic2/Types.hpp
new file mode 100644
index 0000000..e4a0e2d
--- /dev/null
+++ b/src/openvic2/Types.hpp
@@ -0,0 +1,141 @@
+#pragma once
+
+#include <vector>
+#include <cstdint>
+#include <algorithm>
+#include <map>
+
+#include "Logger.hpp"
+
+namespace OpenVic2 {
+ // Represents a 24-bit RGB integer OR a 32-bit ARGB integer
+ using colour_t = uint32_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;
+ }
+
+ 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
+ using price_t = double;
+ using return_t = bool;
+
+ // This mirrors godot::Error, where `OK = 0` and `FAILED = 1`.
+ static constexpr return_t SUCCESS = false, FAILURE = true;
+
+ /*
+ * 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 const& new_identifier);
+ public:
+ HasIdentifier(HasIdentifier const&) = delete;
+ HasIdentifier(HasIdentifier&&) = default;
+ HasIdentifier& operator=(HasIdentifier const&) = delete;
+ HasIdentifier& operator=(HasIdentifier&&) = delete;
+
+ std::string const& get_identifier() const;
+ };
+
+ /*
+ * Base class for objects with associated colour information
+ */
+ class HasColour {
+ const colour_t colour;
+ protected:
+ HasColour(colour_t const new_colour);
+ 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;
+ static std::string colour_to_hex_string(colour_t const colour);
+ };
+
+ /*
+ * Template for a list of objects with unique string identifiers that can
+ * be locked to prevent any further additions. The template argument T is
+ * the type of object that the registry will store, and the second part ensures
+ * that HasIdentifier is a base class of T.
+ */
+ 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) {
+ if (locked) {
+ Logger::error("Cannot add item to the ", name, " registry - locked!");
+ return FAILURE;
+ }
+ T const* old_item = get_item_by_identifier(item.get_identifier());
+ if (old_item != nullptr) {
+ 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;
+ }
+ void lock(bool log = true) {
+ if (locked) {
+ Logger::error("Failed to lock ", name, " registry - already locked!");
+ } else {
+ locked = true;
+ if (log) Logger::info("Locked ", name, " registry after registering ", get_item_count(), " items");
+ }
+ }
+ bool is_locked() const {
+ return locked;
+ }
+ void reset() {
+ identifier_index_map.clear();
+ items.clear();
+ locked = false;
+ }
+ size_t get_item_count() const {
+ return items.size();
+ }
+ T* get_item_by_identifier(std::string const& identifier) {
+ 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 {
+ 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) {
+ return index < items.size() ? &items[index] : nullptr;
+ }
+ T const* get_item_by_index(size_t index) const {
+ return index < items.size() ? &items[index] : nullptr;
+ }
+ std::vector<T>& get_items() {
+ return items;
+ }
+ std::vector<T> const& get_items() const {
+ return items;
+ }
+ };
+}
diff --git a/src/openvic2/map/Building.cpp b/src/openvic2/map/Building.cpp
new file mode 100644
index 0000000..1e26873
--- /dev/null
+++ b/src/openvic2/map/Building.cpp
@@ -0,0 +1,124 @@
+#include "Building.hpp"
+
+#include <cassert>
+
+#include "../Logger.hpp"
+#include "Province.hpp"
+
+using namespace OpenVic2;
+
+Building::Building(BuildingType const& new_type) : HasIdentifier{ new_type.get_identifier() }, type{ new_type } {}
+
+bool Building::_can_expand() const {
+ return level < type.get_max_level();
+}
+
+BuildingType const& Building::get_type() const {
+ return type;
+}
+
+Building::level_t Building::get_level() const {
+ return level;
+}
+
+Building::ExpansionState Building::get_expansion_state() const {
+ return expansion_state;
+}
+
+Date const& Building::get_start_date() const {
+ return start;
+}
+
+Date const& Building::get_end_date() const {
+ return end;
+}
+
+float Building::get_expansion_progress() const {
+ return expansion_progress;
+}
+
+return_t Building::expand() {
+ if (expansion_state == ExpansionState::CanExpand) {
+ expansion_state = ExpansionState::Preparing;
+ expansion_progress = 0.0f;
+ return SUCCESS;
+ }
+ return FAILURE;
+}
+
+/* REQUIREMENTS:
+ * MAP-71, MAP-74, MAP-77
+ */
+void Building::update_state(Date const& today) {
+ switch (expansion_state) {
+ case ExpansionState::Preparing:
+ start = today;
+ end = start + type.get_build_time();
+ break;
+ case ExpansionState::Expanding:
+ expansion_progress = static_cast<double>(today - start) / static_cast<double>(end - start);
+ break;
+ default: expansion_state = _can_expand() ? ExpansionState::CanExpand : ExpansionState::CannotExpand;
+ }
+}
+
+void Building::tick(Date const& today) {
+ if (expansion_state == ExpansionState::Preparing) {
+ expansion_state = ExpansionState::Expanding;
+ }
+ if (expansion_state == ExpansionState::Expanding) {
+ if (end <= today) {
+ level++;
+ expansion_state = ExpansionState::CannotExpand;
+ }
+ }
+}
+
+BuildingType::BuildingType(std::string const& 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 } {
+ assert(new_max_level >= 0);
+ assert(build_time >= 0);
+}
+
+Building::level_t BuildingType::get_max_level() const {
+ return max_level;
+}
+
+Timespan BuildingType::get_build_time() const {
+ return build_time;
+}
+
+BuildingManager::BuildingManager() : building_types{ "building types" } {}
+
+return_t BuildingManager::add_building_type(std::string const& identifier, Building::level_t max_level, Timespan build_time) {
+ if (identifier.empty()) {
+ Logger::error("Invalid building type identifier - empty!");
+ return FAILURE;
+ }
+ if (max_level < 0) {
+ Logger::error("Invalid building type max level: ", max_level);
+ return FAILURE;
+ }
+ if (build_time < 0) {
+ Logger::error("Invalid building type build time: ", build_time);
+ return FAILURE;
+ }
+ return building_types.add_item({ identifier, max_level, build_time });
+}
+
+void BuildingManager::lock_building_types() {
+ building_types.lock();
+}
+
+BuildingType const* BuildingManager::get_building_type_by_identifier(std::string const& identifier) const {
+ return building_types.get_item_by_identifier(identifier);
+}
+
+return_t BuildingManager::generate_province_buildings(Province& province) const {
+ return_t ret = SUCCESS;
+ province.reset_buildings();
+ 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/openvic2/map/Building.hpp b/src/openvic2/map/Building.hpp
new file mode 100644
index 0000000..78d08ae
--- /dev/null
+++ b/src/openvic2/map/Building.hpp
@@ -0,0 +1,75 @@
+#pragma once
+
+#include <vector>
+
+#include "../Types.hpp"
+#include "../Date.hpp"
+
+namespace OpenVic2 {
+ struct Province;
+ struct BuildingType;
+
+ /* REQUIREMENTS:
+ * MAP-11, MAP-72, MAP-73
+ * MAP-12, MAP-75, MAP-76
+ * MAP-13, MAP-78, MAP-79
+ */
+ struct Building : HasIdentifier {
+ friend struct Province;
+
+ using level_t = int8_t;
+
+ enum class ExpansionState { CannotExpand, CanExpand, Preparing, Expanding };
+ private:
+ BuildingType const& type;
+ level_t level = 0;
+ ExpansionState expansion_state = ExpansionState::CannotExpand;
+ Date start, end;
+ float expansion_progress;
+
+ Building(BuildingType const& new_type);
+
+ bool _can_expand() const;
+ public:
+ Building(Building&&) = default;
+
+ BuildingType const& get_type() const;
+ level_t get_level() const;
+ ExpansionState get_expansion_state() const;
+ Date const& get_start_date() const;
+ Date const& get_end_date() const;
+ float get_expansion_progress() const;
+
+ return_t expand();
+ void update_state(Date const& today);
+ void tick(Date const& today);
+ };
+
+ struct BuildingManager;
+
+ struct BuildingType : HasIdentifier {
+ friend struct BuildingManager;
+ private:
+ 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);
+ public:
+ BuildingType(BuildingType&&) = default;
+
+ Building::level_t get_max_level() const;
+ Timespan get_build_time() const;
+ };
+
+ struct BuildingManager {
+ private:
+ IdentifierRegistry<BuildingType> building_types;
+ public:
+ BuildingManager();
+
+ return_t add_building_type(std::string const& 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;
+ return_t generate_province_buildings(Province& province) const;
+ };
+}
diff --git a/src/openvic2/map/Map.cpp b/src/openvic2/map/Map.cpp
new file mode 100644
index 0000000..1f44c43
--- /dev/null
+++ b/src/openvic2/map/Map.cpp
@@ -0,0 +1,332 @@
+#include "Map.hpp"
+
+#include <cassert>
+#include <unordered_set>
+
+#include "../Logger.hpp"
+
+using namespace OpenVic2;
+
+Mapmode::Mapmode(index_t new_index, std::string const& new_identifier, colour_func_t new_colour_func)
+ : HasIdentifier{ new_identifier }, index{ new_index }, colour_func{ new_colour_func } {
+ assert(colour_func != nullptr);
+}
+
+Mapmode::index_t Mapmode::get_index() const {
+ return index;
+}
+
+colour_t Mapmode::get_colour(Map const& map, Province const& province) const {
+ return colour_func ? colour_func(map, province) : NULL_COLOUR;
+}
+
+Map::Map() : provinces{ "provinces" }, regions{ "regions" }, mapmodes{ "mapmodes" } {}
+
+return_t Map::add_province(std::string const& 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;
+ }
+ if (identifier.empty()) {
+ Logger::error("Invalid province identifier - empty!");
+ return FAILURE;
+ }
+ 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 };
+ 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));
+}
+
+void Map::lock_provinces() {
+ provinces.lock();
+}
+
+return_t Map::set_water_province(std::string const& identifier) {
+ if (water_provinces_locked) {
+ Logger::error("The map's water provinces have already been locked!");
+ return FAILURE;
+ }
+ Province* province = get_province_by_identifier(identifier);
+ if (province == nullptr) {
+ Logger::error("Unrecognised water province identifier: ", identifier);
+ return FAILURE;
+ }
+ if (province->is_water()) {
+ Logger::error("Province ", identifier, " is already a water province!");
+ 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);
+}
+
+return_t Map::add_region(std::string const& identifier, std::vector<std::string> 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) {
+ Province* province = get_province_by_identifier(province_identifier);
+ if (province != nullptr) {
+ if (new_region.contains_province(province)) {
+ Logger::error("Duplicate province identifier ", province_identifier);
+ ret = FAILURE;
+ } else {
+ size_t other_region_index = reinterpret_cast<size_t>(province->get_region());
+ if (other_region_index != 0) {
+ other_region_index--;
+ 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;
+ } else new_region.provinces.insert(province);
+ }
+ } else {
+ Logger::error("Invalid province identifier ", province_identifier);
+ ret = FAILURE;
+ }
+ }
+ if (!new_region.get_province_count()) {
+ Logger::error("No valid provinces in region's list");
+ return FAILURE;
+ }
+
+ // 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<Region*>(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.lock();
+ for (Region& region : regions.get_items())
+ for (Province* province : region.get_provinces())
+ province->region = &region;
+}
+
+size_t Map::get_province_count() const {
+ return provinces.get_item_count();
+}
+
+Province* Map::get_province_by_index(index_t index) {
+ return index != NULL_INDEX ? provinces.get_item_by_index(index - 1) : nullptr;
+}
+
+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) {
+ return provinces.get_item_by_identifier(identifier);
+}
+
+Province const* Map::get_province_by_identifier(std::string const& identifier) const {
+ return provinces.get_item_by_identifier(identifier);
+}
+
+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 {
+ if (x < width && y < height) return province_shape_image[x + y * width].index;
+ return NULL_INDEX;
+}
+
+Region* Map::get_region_by_identifier(std::string const& identifier) {
+ return regions.get_item_by_identifier(identifier);
+}
+
+Region const* Map::get_region_by_identifier(std::string const& identifier) const {
+ return regions.get_item_by_identifier(identifier);
+}
+
+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,
+ 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;
+ }
+ if (!provinces.is_locked()) {
+ Logger::error("Province index image cannot be generated until after provinces are locked!");
+ return FAILURE;
+ }
+ if (new_width < 1 || new_height < 1) {
+ Logger::error("Invalid province image dimensions: ", new_width, "x", new_height);
+ return FAILURE;
+ }
+ if (colour_data == nullptr) {
+ 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_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 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) == 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) == province_colour) {
+ province_shape_image[idx].index = province_shape_image[jdx].index;
+ continue;
+ }
+ }
+ 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;
+ continue;
+ }
+ 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;
+ }
+ }
+
+ 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;
+ }
+ }
+ return ret;
+}
+
+size_t Map::get_width() const {
+ return width;
+}
+
+size_t Map::get_height() const {
+ return height;
+}
+
+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) {
+ if (identifier.empty()) {
+ Logger::error("Invalid mapmode identifier - empty!");
+ return FAILURE;
+ }
+ if (colour_func == nullptr) {
+ Logger::error("Mapmode colour function is null for identifier: ", identifier);
+ return FAILURE;
+ }
+ 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.get_item_count();
+}
+
+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 {
+ return mapmodes.get_item_by_identifier(identifier);
+}
+
+return_t Map::generate_mapmode_colours(Mapmode::index_t index, uint8_t* target) const {
+ if (target == nullptr) {
+ Logger::error("Mapmode colour target pointer is null!");
+ return FAILURE;
+ }
+ Mapmode const* mapmode = mapmodes.get_item_by_index(index);
+ if (mapmode == nullptr) {
+ Logger::error("Invalid mapmode index: ", index);
+ return FAILURE;
+ }
+ // Skip past Province::NULL_INDEX
+ for (size_t i = 0; i < MAPMODE_COLOUR_SIZE; ++i)
+ *target++ = 0;
+ for (Province const& province : provinces.get_items()) {
+ const colour_t colour = mapmode->get_colour(*this, province);
+ *target++ = (colour >> 16) & 0xFF;
+ *target++ = (colour >> 8) & 0xFF;
+ *target++ = colour & 0xFF;
+ *target++ = (colour >> 24) & 0xFF;
+ }
+ return SUCCESS;
+}
+
+return_t Map::generate_province_buildings(BuildingManager const& manager) {
+ return_t ret = SUCCESS;
+ for (Province& province : provinces.get_items())
+ if (manager.generate_province_buildings(province) != SUCCESS) ret = FAILURE;
+ return ret;
+}
+
+void Map::update_state(Date const& today) {
+ for (Province& province : provinces.get_items())
+ province.update_state(today);
+}
+
+void Map::tick(Date const& today) {
+ for (Province& province : provinces.get_items())
+ province.tick(today);
+}
diff --git a/src/openvic2/map/Map.hpp b/src/openvic2/map/Map.hpp
new file mode 100644
index 0000000..cb8dcb1
--- /dev/null
+++ b/src/openvic2/map/Map.hpp
@@ -0,0 +1,90 @@
+#pragma once
+
+#include <functional>
+
+#include "Region.hpp"
+
+namespace OpenVic2 {
+
+ struct Mapmode : HasIdentifier {
+ friend struct Map;
+
+ using colour_func_t = std::function<colour_t (Map const&, Province const&)>;
+ using index_t = size_t;
+ private:
+ 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);
+ public:
+ index_t get_index() const;
+ colour_t get_colour(Map const& map, Province const& province) const;
+ };
+
+ /* REQUIREMENTS:
+ * 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;
+ 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;
+ bool water_provinces_locked = false;
+ size_t water_province_count = 0;
+
+ 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();
+
+ return_t add_province(std::string const& identifier, colour_t colour);
+ void lock_provinces();
+ return_t set_water_province(std::string const& identifier);
+ void lock_water_provinces();
+ return_t add_region(std::string const& identifier, std::vector<std::string> 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;
+ 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,
+ 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;
+
+ return_t add_mapmode(std::string const& 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;
+ 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);
+
+ void update_state(Date const& today);
+ void tick(Date const& today);
+ };
+}
diff --git a/src/openvic2/map/Province.cpp b/src/openvic2/map/Province.cpp
new file mode 100644
index 0000000..b3d455b
--- /dev/null
+++ b/src/openvic2/map/Province.cpp
@@ -0,0 +1,68 @@
+#include "Province.hpp"
+
+#include <cassert>
+#include <sstream>
+#include <iomanip>
+
+using namespace OpenVic2;
+
+Province::Province(index_t new_index, std::string const& new_identifier, colour_t new_colour) :
+ HasIdentifier{ new_identifier }, HasColour{ new_colour }, index{ new_index }, buildings{ "buildings" } {
+ assert(index != NULL_INDEX);
+ assert(new_colour != NULL_COLOUR);
+}
+
+index_t Province::get_index() const {
+ return index;
+}
+
+Region* Province::get_region() const {
+ return region;
+}
+
+bool Province::is_water() const {
+ return water;
+}
+
+Province::life_rating_t Province::get_life_rating() const {
+ return life_rating;
+}
+
+return_t Province::add_building(BuildingType const& type) {
+ return buildings.add_item({ type });
+}
+
+void Province::lock_buildings() {
+ buildings.lock(false);
+}
+
+void Province::reset_buildings() {
+ buildings.reset();
+}
+
+std::vector<Building> const& Province::get_buildings() const {
+ return buildings.get_items();
+}
+
+return_t Province::expand_building(std::string const& building_type_identifier) {
+ Building* building = buildings.get_item_by_identifier(building_type_identifier);
+ if (building == nullptr) return FAILURE;
+ return building->expand();
+}
+
+std::string Province::to_string() const {
+ std::stringstream stream;
+ stream << "(#" << std::to_string(index) << ", " << get_identifier() << ", 0x" << colour_to_hex_string() << ")";
+ return stream.str();
+}
+
+void Province::update_state(Date const& today) {
+ for (Building& building : buildings.get_items())
+ building.update_state(today);
+
+}
+
+void Province::tick(Date const& today) {
+ for (Building& building : buildings.get_items())
+ building.tick(today);
+}
diff --git a/src/openvic2/map/Province.hpp b/src/openvic2/map/Province.hpp
new file mode 100644
index 0000000..9b07fc1
--- /dev/null
+++ b/src/openvic2/map/Province.hpp
@@ -0,0 +1,42 @@
+#pragma once
+
+#include "Building.hpp"
+
+namespace OpenVic2 {
+ struct Map;
+ struct Region;
+
+ /* REQUIREMENTS:
+ * MAP-5, MAP-8, MAP-43, MAP-47
+ */
+ struct Province : HasIdentifier, HasColour {
+ friend struct Map;
+
+ using life_rating_t = int8_t;
+
+ private:
+ const index_t index;
+ Region* region = nullptr;
+ bool water = false;
+ life_rating_t life_rating = 0;
+ IdentifierRegistry<Building> buildings;
+
+ Province(index_t new_index, std::string const& new_identifier, colour_t new_colour);
+ public:
+ Province(Province&&) = default;
+
+ index_t get_index() const;
+ Region* get_region() const;
+ bool is_water() const;
+ life_rating_t get_life_rating() const;
+ return_t add_building(BuildingType const& type);
+ void lock_buildings();
+ void reset_buildings();
+ std::vector<Building> const& get_buildings() const;
+ return_t expand_building(std::string const& building_type_identifier);
+ std::string to_string() const;
+
+ void update_state(Date const& today);
+ void tick(Date const& today);
+ };
+}
diff --git a/src/openvic2/map/Region.cpp b/src/openvic2/map/Region.cpp
new file mode 100644
index 0000000..da0dfdd
--- /dev/null
+++ b/src/openvic2/map/Region.cpp
@@ -0,0 +1,24 @@
+#include "Region.hpp"
+
+#include <cassert>
+
+using namespace OpenVic2;
+
+size_t ProvinceSet::get_province_count() const {
+ return provinces.size();
+}
+
+bool ProvinceSet::contains_province(Province const* province) const {
+ return province && std::find(provinces.begin(), provinces.end(), province) != provinces.end();
+}
+
+std::set<Province*> const& ProvinceSet::get_provinces() const {
+ return provinces;
+}
+
+Region::Region(std::string const& new_identifier) : HasIdentifier{ new_identifier } {}
+
+colour_t Region::get_colour() const {
+ if (provinces.empty()) return 0xFF0000;
+ return (*provinces.cbegin())->get_colour();
+}
diff --git a/src/openvic2/map/Region.hpp b/src/openvic2/map/Region.hpp
new file mode 100644
index 0000000..3920dfc
--- /dev/null
+++ b/src/openvic2/map/Region.hpp
@@ -0,0 +1,30 @@
+#pragma once
+
+#include <set>
+
+#include "Province.hpp"
+
+namespace OpenVic2 {
+
+ struct ProvinceSet {
+ protected:
+ std::set<Province*> provinces;
+ public:
+ size_t get_province_count() const;
+ bool contains_province(Province const* province) const;
+ std::set<Province*> const& get_provinces() const;
+ };
+
+ /* REQUIREMENTS:
+ * MAP-6, MAP-44, MAP-48
+ */
+ struct Region : HasIdentifier, ProvinceSet {
+ friend struct Map;
+ private:
+ Region(std::string const& new_identifier);
+ public:
+ Region(Region&&) = default;
+
+ colour_t get_colour() const;
+ };
+}