From d3f3187209cb4085f27f95ce8ad2a77af25704fd Mon Sep 17 00:00:00 2001 From: Hop311 Date: Sun, 23 Apr 2023 19:49:01 +0100 Subject: C++ refactoring + simulation prototype --- extension/src/openvic2/Date.cpp | 190 ++++++++----- extension/src/openvic2/Date.hpp | 139 +++++----- extension/src/openvic2/GameAdvancementHook.cpp | 120 ++++----- extension/src/openvic2/GameAdvancementHook.hpp | 29 +- extension/src/openvic2/GameManager.cpp | 43 +++ extension/src/openvic2/GameManager.hpp | 29 ++ extension/src/openvic2/Logger.cpp | 26 ++ extension/src/openvic2/Logger.hpp | 83 ++++++ extension/src/openvic2/Map.cpp | 348 ------------------------ extension/src/openvic2/Map.hpp | 67 ----- extension/src/openvic2/Province.cpp | 43 --- extension/src/openvic2/Province.hpp | 39 --- extension/src/openvic2/Region.cpp | 26 -- extension/src/openvic2/Region.hpp | 29 -- extension/src/openvic2/Types.cpp | 4 +- extension/src/openvic2/Types.hpp | 8 +- extension/src/openvic2/map/Building.cpp | 129 +++++++++ extension/src/openvic2/map/Building.hpp | 63 +++++ extension/src/openvic2/map/Map.cpp | 359 +++++++++++++++++++++++++ extension/src/openvic2/map/Map.hpp | 73 +++++ extension/src/openvic2/map/Province.cpp | 67 +++++ extension/src/openvic2/map/Province.hpp | 45 ++++ extension/src/openvic2/map/Region.cpp | 26 ++ extension/src/openvic2/map/Region.hpp | 28 ++ 24 files changed, 1238 insertions(+), 775 deletions(-) create mode 100644 extension/src/openvic2/GameManager.cpp create mode 100644 extension/src/openvic2/GameManager.hpp create mode 100644 extension/src/openvic2/Logger.cpp create mode 100644 extension/src/openvic2/Logger.hpp delete mode 100644 extension/src/openvic2/Map.cpp delete mode 100644 extension/src/openvic2/Map.hpp delete mode 100644 extension/src/openvic2/Province.cpp delete mode 100644 extension/src/openvic2/Province.hpp delete mode 100644 extension/src/openvic2/Region.cpp delete mode 100644 extension/src/openvic2/Region.hpp create mode 100644 extension/src/openvic2/map/Building.cpp create mode 100644 extension/src/openvic2/map/Building.hpp create mode 100644 extension/src/openvic2/map/Map.cpp create mode 100644 extension/src/openvic2/map/Map.hpp create mode 100644 extension/src/openvic2/map/Province.cpp create mode 100644 extension/src/openvic2/map/Province.hpp create mode 100644 extension/src/openvic2/map/Region.cpp create mode 100644 extension/src/openvic2/map/Region.hpp (limited to 'extension/src/openvic2') diff --git a/extension/src/openvic2/Date.cpp b/extension/src/openvic2/Date.cpp index e1cef72..bb891fd 100644 --- a/extension/src/openvic2/Date.cpp +++ b/extension/src/openvic2/Date.cpp @@ -1,115 +1,161 @@ -#include -#include "Date.hpp" +#include "openvic2/Date.hpp" + +#include +#include + +#include "openvic2/Logger.hpp" using namespace OpenVic2; -bool Timespan::operator< (Timespan const& other) const { return days < other.days; } -bool Timespan::operator> (Timespan const& other) const { return days > other.days; } -bool Timespan::operator<= (Timespan const& other) const { return days <= other.days; } -bool Timespan::operator>= (Timespan const& other) const { return days >= other.days; } -bool Timespan::operator== (Timespan const& other) const { return days == other.days; } -bool Timespan::operator!= (Timespan const& other) const { return days != other.days; } +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+ (Timespan const& other) const { return Timespan(days + other.days); } -Timespan Timespan::operator- (Timespan const& other) const { return Timespan(days - other.days); } -Timespan Timespan::operator* (int64_t const& factor) const { return Timespan(days * factor); } -Timespan Timespan::operator/ (int64_t const& factor) const { return Timespan(days / factor); } +Timespan Timespan::operator*(day_t factor) const { return days * factor; } -Timespan& Timespan::operator+= (Timespan const& other) { +Timespan Timespan::operator/(day_t factor) const { return days / factor; } + +Timespan& Timespan::operator+=(Timespan other) { days += other.days; return *this; } -Timespan& Timespan::operator-= (Timespan const& other) { + +Timespan& Timespan::operator-=(Timespan other) { days -= other.days; return *this; } -Timespan::operator std::string() const { - return std::to_string(days); +Timespan& Timespan::operator++() { + days++; + return *this; } -std::ostream &operator<<(std::ostream &out, Timespan const& timespan) { - return out << static_cast(timespan); + +Timespan Timespan::operator++(int) { + Timespan old = *this; + ++(*this); + return old; } -Timespan fromYearZero(year_t year, month_t month, date_t day) { - int64_t daysElapsed = year * DAYS_IN_YEAR; - size_t daysSinceMonthStart = (day == 0) ? 0 : day - 1; //Underflow protection - for (size_t x = 0; x < month && x < MONTHS_IN_YEAR; x++) { - daysElapsed += DAYS_IN_MONTH[x]; - } - daysElapsed += daysSinceMonthStart; - return Timespan(daysElapsed); +Timespan::operator day_t() const { + return days; } -//This function is not set up to handle dates before Year 0 -YearMonthDayBundle toGregorianDate(Timespan const& timespan) { - year_t year = 0; - month_t month = 0; - date_t day = 0; +Timespan::operator double() const { + return days; +} - if (timespan >= 0) { - year = timespan.days / DAYS_IN_YEAR; - int64_t remainingDays = timespan.days % DAYS_IN_YEAR; +Timespan::operator std::string() const { + return std::to_string(days); +} + +std::ostream& OpenVic2::operator<<(std::ostream& out, Timespan timespan) { + return out << static_cast(timespan); +} - for (size_t x = 0; x < MONTHS_IN_YEAR && remainingDays >= DAYS_IN_MONTH[x]; x++) { - remainingDays -= DAYS_IN_MONTH[x]; - month++; - } +Timespan Date::_dateToTimespan(year_t year, month_t month, day_t day) { + month = std::clamp(month, 1, MONTHS_IN_YEAR); + day = std::clamp(day, 1, DAYS_IN_MONTH[month - 1]); + return year * DAYS_IN_YEAR + DAYS_UP_TO_MONTH[month - 1] + day - 1; +} - //Corrects month and day to be 1-indexed - month++; - day++; +Date::Date(Timespan total_days) : timespan{ total_days } { + if (timespan < 0) { + Logger::error("Invalid timespan for date: ", timespan, " (cannot be negative)"); + timespan = 0; } - return std::make_tuple(year, month, day); } +Date::Date(year_t year, month_t month, day_t day) : timespan{ _dateToTimespan(year, month, day) } {} -Date::Date(Timespan const& timespan) : ts(timespan) { updateDate(ts); } +Date::year_t Date::getYear() const { + return static_cast(timespan) / DAYS_IN_YEAR; +} -Date::Date(year_t year, month_t month, date_t day) { - ts = fromYearZero(year, month, day); - updateDate(ts); +Date::month_t Date::getMonth() const { + return ((static_cast(timespan) % DAYS_IN_YEAR) / 32) + 1; } -void Date::updateDate(Timespan const& timespan) { - gregorianDate = toGregorianDate(timespan); +Date::day_t Date::getDay() const { + const Timespan::day_t days_in_year = static_cast(timespan) % DAYS_IN_YEAR; + return days_in_year - DAYS_UP_TO_MONTH[days_in_year / 32] + 1; } -size_t Date::getDay() const { return std::get<2>(gregorianDate); } -size_t Date::getMonth() const { return std::get<1>(gregorianDate); } -size_t Date::getYear() const { return std::get<0>(gregorianDate); } -bool Date::operator< (Date const& other) const { return ts < other.ts; } -bool Date::operator> (Date const& other) const { return ts > other.ts; } -bool Date::operator<= (Date const& other) const { return ts <= other.ts; } -bool Date::operator>= (Date const& other) const { return ts >= other.ts; } -bool Date::operator== (Date const& other) const { return ts == other.ts; } -bool Date::operator!= (Date const& other) const { return ts != other.ts; } +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 timespan) const { return Date(ts + timespan); } -Timespan Date::operator- (Date const& other) const { return ts - other.ts; } +Date& Date::operator+=(Timespan other) { + timespan += other; + return *this; +} -Date& Date::operator+= (Timespan const& timespan) { - ts += timespan; - updateDate(ts); +Date& Date::operator-=(Timespan other) { + timespan -= other; return *this; } -Date& Date::operator-= (Timespan const& timespan) { - ts -= timespan; - updateDate(ts); + +Date& Date::operator++() { + timespan++; return *this; } -Date Date::operator++ (int) { - Date oldCopy = *this; - (*this) += 1; - return oldCopy; + +Date Date::operator++(int) { + Date old = *this; + ++(*this); + return old; } Date::operator std::string() const { std::stringstream ss; - ss << getYear() << '.' << getMonth() << '.' << getDay(); + ss << *this; return ss.str(); } -std::ostream &operator<<(std::ostream &out, Date const& date) { - return out << static_cast(date); + +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/extension/src/openvic2/Date.hpp b/extension/src/openvic2/Date.hpp index 9ed5963..b19602b 100644 --- a/extension/src/openvic2/Date.hpp +++ b/extension/src/openvic2/Date.hpp @@ -1,86 +1,83 @@ #pragma once #include -#include -#include #include -#include +#include namespace OpenVic2 { - //A relative period between points in time, measured in days + // A relative period between points in time, measured in days struct Timespan { - int64_t days; - - Timespan() : days(0) {} - Timespan(int64_t const& value) : days(value) {} - - bool operator< (Timespan const& other) const; - bool operator> (Timespan const& other) const; - bool operator<= (Timespan const& other) const; - bool operator>= (Timespan const& other) const; - bool operator== (Timespan const& other) const; - bool operator!= (Timespan const& other) const; - - Timespan operator+ (Timespan const& other) const; - Timespan operator- (Timespan const& other) const; - Timespan operator* (int64_t const& factor) const; - Timespan operator/ (int64_t const& factor) const; - - Timespan& operator+= (Timespan const& other); - Timespan& operator-= (Timespan const& other); - + 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; - friend std::ostream& operator<< (std::ostream& out, Timespan const& timespan); }; + std::ostream& operator<< (std::ostream& out, Timespan timespan); - static constexpr size_t MONTHS_IN_YEAR = 12; - static constexpr size_t DAYS_IN_YEAR = 365; - static constexpr size_t DAYS_IN_MONTH[MONTHS_IN_YEAR] = {31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31}; - - using date_t = uint8_t; - using month_t = uint8_t; - using year_t = uint16_t; - using YearMonthDayBundle = std::tuple; - - //Represents an in-game date - //Note: Current implementation does not account for leap-years, or dates before Year 0 + // Represents an in-game date + // Note: Current implementation does not account for leap-years, or dates before Year 0 struct Date { - private: - YearMonthDayBundle gregorianDate; - //Number of days since Jan 1st, Year 0 - Timespan ts; - - public: - //The Timespan is considered to be the number of days since Jan 1st, Year 0 - Date(Timespan const& timespan); - - //Year month day specification - Date(year_t year = 1836, month_t month = 1, date_t day = 1); - - private: - void updateDate(Timespan const& timespan); - - public: - size_t getDay() const; - size_t getMonth() const; - size_t getYear() const; - - bool operator< (Date const& other) const; - bool operator> (Date const& other) const; - bool operator<= (Date const& other) const; - bool operator>= (Date const& other) const; - bool operator== (Date const& other) const; - bool operator!= (Date const& other) const; - - Date operator+ (Timespan timespan) const; - Timespan operator- (Date const& other) const; - - Date& operator+= (Timespan const& timespan); - Date& operator-= (Timespan const& timespan); - //Postfix increment - Date operator++ (int); + 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; - friend std::ostream& operator<< (std::ostream& out, Date const& date); + // 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/extension/src/openvic2/GameAdvancementHook.cpp b/extension/src/openvic2/GameAdvancementHook.cpp index 3db3224..c78847b 100644 --- a/extension/src/openvic2/GameAdvancementHook.cpp +++ b/extension/src/openvic2/GameAdvancementHook.cpp @@ -1,69 +1,67 @@ -#include "GameAdvancementHook.hpp" +#include "openvic2/GameAdvancementHook.hpp" -namespace OpenVic2 { - GameAdvancementHook::GameAdvancementHook(AdvancementFunction function, bool startPaused, GameSpeed startingSpeed) { - triggerFunction = function; - lastPolledTime = std::chrono::high_resolution_clock::now(); - isPaused = startPaused; - currentSpeed = startingSpeed; - } +using namespace OpenVic2; - void GameAdvancementHook::increaseSimulationSpeed() { - switch (currentSpeed) { - case(GameSpeed::Speed1): - currentSpeed = GameSpeed::Speed2; - break; - case(GameSpeed::Speed2): - currentSpeed = GameSpeed::Speed3; - break; - case(GameSpeed::Speed3): - currentSpeed = GameSpeed::Speed4; - break; - case(GameSpeed::Speed4): - currentSpeed = GameSpeed::Speed5; - break; - } - } +const std::vector 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 } }; - void GameAdvancementHook::decreaseSimulationSpeed() { - switch (currentSpeed) { - case(GameSpeed::Speed2): - currentSpeed = GameSpeed::Speed1; - break; - case(GameSpeed::Speed3): - currentSpeed = GameSpeed::Speed2; - break; - case(GameSpeed::Speed4): - currentSpeed = GameSpeed::Speed3; - break; - case(GameSpeed::Speed5): - currentSpeed = GameSpeed::Speed4; - break; - } - } +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++(int) { - GameAdvancementHook oldCopy = *this; - increaseSimulationSpeed(); - return oldCopy; - }; +GameAdvancementHook& GameAdvancementHook::operator++() { + increaseSimulationSpeed(); + return *this; +}; - GameAdvancementHook GameAdvancementHook::operator--(int) { - GameAdvancementHook oldCopy = *this; - decreaseSimulationSpeed(); - return oldCopy; - }; +GameAdvancementHook& GameAdvancementHook::operator--() { + decreaseSimulationSpeed(); + return *this; +}; - void GameAdvancementHook::conditionallyAdvanceGame() { - if (!isPaused) { - std::chrono::time_point previousTime = lastPolledTime; - std::chrono::time_point currentTime = std::chrono::high_resolution_clock::now(); - if (std::chrono::duration_cast(currentTime - previousTime).count() >= static_cast(currentSpeed)) { - lastPolledTime = currentTime; - if (triggerFunction) { - triggerFunction(); - } - } +void GameAdvancementHook::conditionallyAdvanceGame() { + if (!isPaused) { + std::chrono::time_point currentTime = std::chrono::high_resolution_clock::now(); + if (std::chrono::duration_cast(currentTime - lastPolledTime) >= GAME_SPEEDS[currentSpeed]) { + lastPolledTime = currentTime; + if (triggerFunction) triggerFunction(); } } -} \ No newline at end of file + if (refreshFunction) refreshFunction(); +} diff --git a/extension/src/openvic2/GameAdvancementHook.hpp b/extension/src/openvic2/GameAdvancementHook.hpp index 72af4ac..572494a 100644 --- a/extension/src/openvic2/GameAdvancementHook.hpp +++ b/extension/src/openvic2/GameAdvancementHook.hpp @@ -2,39 +2,40 @@ #include #include +#include namespace OpenVic2 { - //Value of different game speeds are the minimum number of miliseconds before the simulation advances - enum class GameSpeed { - Speed1 = 4000, - Speed2 = 3000, - Speed3 = 2000, - Speed4 = 1000, - Speed5 = 100, - Speed6 = 1 - }; - //Conditionally advances game with provided behaviour //Class governs game speed and pause state class GameAdvancementHook { public: using AdvancementFunction = std::function; + using RefreshFunction = std::function; + using speed_t = int8_t; + + //Minimum number of miliseconds before the simulation advances + static const std::vector GAME_SPEEDS; private: std::chrono::time_point 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; public: bool isPaused; - GameSpeed currentSpeed; + speed_t currentSpeed; - GameAdvancementHook(AdvancementFunction function = nullptr, bool startPaused = false, GameSpeed startingSpeed = GameSpeed::Speed1); + GameAdvancementHook(AdvancementFunction tickFunction, RefreshFunction updateFunction, bool startPaused = false, speed_t startingSpeed = 0); + void setSimulationSpeed(speed_t speed); + speed_t getSimulationSpeed() const; void increaseSimulationSpeed(); void decreaseSimulationSpeed(); - GameAdvancementHook operator++(int); - GameAdvancementHook operator--(int); + bool canIncreaseSimulationSpeed() const; + bool canDecreaseSimulationSpeed() const; + GameAdvancementHook& operator++(); + GameAdvancementHook& operator--(); void conditionallyAdvanceGame(); }; } \ No newline at end of file diff --git a/extension/src/openvic2/GameManager.cpp b/extension/src/openvic2/GameManager.cpp new file mode 100644 index 0000000..da742ca --- /dev/null +++ b/extension/src/openvic2/GameManager.cpp @@ -0,0 +1,43 @@ +#include "openvic2/GameManager.hpp" + +#include "openvic2/Logger.hpp" + +using namespace OpenVic2; + +GameManager::GameManager(state_updated_func_t state_updated_callback) + : clock{ [this]() { tick(); }, [this]() { update_state(); }, true }, today{ 1836 }, 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(); +} + +void GameManager::finished_loading_data() { + map.generate_province_buildings(building_manager); +} + +Date const& GameManager::get_today() const { + return today; +} + +return_t GameManager::expand_building(Province::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/extension/src/openvic2/GameManager.hpp b/extension/src/openvic2/GameManager.hpp new file mode 100644 index 0000000..cba0180 --- /dev/null +++ b/extension/src/openvic2/GameManager.hpp @@ -0,0 +1,29 @@ +#pragma once + +#include "openvic2/GameAdvancementHook.hpp" +#include "openvic2/map/Map.hpp" + +namespace OpenVic2 { + struct GameManager { + using state_updated_func_t = std::function; + + Map map; + BuildingManager building_manager; + GameAdvancementHook clock; + private: + Date today; + state_updated_func_t state_updated; + bool needs_update = true; + + void set_needs_update(); + void update_state(); + void tick(); + public: + GameManager(state_updated_func_t state_updated_callback); + + void finished_loading_data(); + + Date const& get_today() const; + return_t expand_building(Province::index_t province_index, std::string const& building_type_identifier); + }; +} diff --git a/extension/src/openvic2/Logger.cpp b/extension/src/openvic2/Logger.cpp new file mode 100644 index 0000000..f211e7e --- /dev/null +++ b/extension/src/openvic2/Logger.cpp @@ -0,0 +1,26 @@ +#include "openvic2/Logger.hpp" + +#include + +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; }; + +const char* Logger::get_filename(const char* filepath) { + if (filepath == nullptr) return nullptr; + const char *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/extension/src/openvic2/Logger.hpp b/extension/src/openvic2/Logger.hpp new file mode 100644 index 0000000..749c67f --- /dev/null +++ b/extension/src/openvic2/Logger.hpp @@ -0,0 +1,83 @@ +#pragma once + +#include +#include +#ifdef __cpp_lib_source_location +#include +#endif + +namespace OpenVic2 { + + #ifndef __cpp_lib_source_location + #include + //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 const char* file_name() const { return _file.c_str(); } + inline int line() const {return _line; } + inline const char* function_name() const { return _function.c_str(); } + }; + #endif + + class Logger { + using log_func_t = std::function; + + #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 const char* get_filename(const char* filepath); + + template + 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)), ...); + 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 + struct info { + info(Ts&&... ts, const source_location& location = source_location::current()) { + log{ info_func, std::forward(ts)..., location }; + } + }; + + template + info(Ts&&...) -> info; + + template + struct error { + error(Ts&&... ts, const source_location& location = source_location::current()) { + log{ error_func, std::forward(ts)..., location }; + } + }; + + template + error(Ts&&...) -> error; + }; +} diff --git a/extension/src/openvic2/Map.cpp b/extension/src/openvic2/Map.cpp deleted file mode 100644 index 0ac8091..0000000 --- a/extension/src/openvic2/Map.cpp +++ /dev/null @@ -1,348 +0,0 @@ -#include "Map.hpp" - -#include -#include - -using namespace OpenVic2; - -static const std::string SEPARATOR = "\n - "; - -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; -} - -Mapmode::colour_func_t Mapmode::get_colour_func() const { - return colour_func; -} - -return_t Map::add_province(std::string const& identifier, Province::colour_t colour, std::string& error_message) { - if (provinces_locked) { - error_message = "The map's province list has already been locked!"; - return FAILURE; - } - if (provinces.size() >= Province::MAX_INDEX) { - error_message = "The map's province list is full - there can be at most " + std::to_string(Province::MAX_INDEX) + " provinces"; - return FAILURE; - } - if (identifier.empty()) { - error_message = "Empty province identifier for colour " + Province::colour_to_hex_string(colour); - return FAILURE; - } - if (colour == Province::NULL_COLOUR || colour > Province::MAX_COLOUR) { - error_message = "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) { - error_message = "Duplicate province identifiers: " + old_province->to_string() + " and " + new_province.to_string(); - return FAILURE; - } - old_province = get_province_by_colour(colour); - if (old_province != nullptr) { - error_message = "Duplicate province colours: " + old_province->to_string() + " and " + new_province.to_string(); - return FAILURE; - } - provinces.push_back(new_province); - error_message = "Added province: " + new_province.to_string(); - return SUCCESS; -} - -void Map::lock_provinces() { - provinces_locked = true; -} - -return_t Map::set_water_province(std::string const& identifier, std::string& error_message) { - if (water_provinces_locked) { - error_message = "The map's water provinces have already been locked!"; - return FAILURE; - } - Province* province = get_province_by_identifier(identifier); - if (province == nullptr) { - error_message = "Unrecognised water province identifier: " + identifier; - return FAILURE; - } - if (province->is_water()) { - error_message = "Province " + identifier + " is already a water province!"; - return FAILURE; - } - province->water = true; - error_message = "Set province " + identifier + " as a water province"; - return SUCCESS; -} - -void Map::lock_water_provinces() { - water_provinces_locked = true; -} - -return_t Map::add_region(std::string const& identifier, std::vector const& province_identifiers, std::string& error_message) { - if (regions_locked) { - error_message = "The map's region list has already been locked!"; - return FAILURE; - } - if (identifier.empty()) { - error_message = "Empty region identifier!"; - return FAILURE; - } - if (provinces.empty()) { - error_message = "Empty province list for region " + identifier; - return FAILURE; - } - Region new_region{ identifier }; - error_message.clear(); - 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)) - error_message += SEPARATOR + "Duplicate province identifier " + province_identifier; - else { - size_t other_region_index = reinterpret_cast(province->get_region()); - if (other_region_index != 0) { - other_region_index--; - error_message += SEPARATOR + "Province " + province_identifier + " is already part of "; - if (other_region_index < regions.size()) - error_message += regions[other_region_index].get_identifier(); - else - error_message += "an unknown region with index " + std::to_string(other_region_index); - } else new_region.provinces.insert(province); - } - } else error_message += SEPARATOR + "Invalid province identifier " + province_identifier; - } - return_t ret = SUCCESS; - if (!new_region.get_province_count()) { - error_message += SEPARATOR + "No valid provinces in region's list"; - ret = FAILURE; - } - Region const* old_region = get_region_by_identifier(identifier); - if (old_region != nullptr) { - error_message += SEPARATOR + "Duplicate region identifiers: " + old_region->get_identifier() + " and " + identifier; - ret = FAILURE; - } - - if (ret == SUCCESS) { - 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()); - for (Province* province : new_region.get_provinces()) - province->region = tmp_region_index; - if (!error_message.empty()) { - error_message += SEPARATOR; - ret = FAILURE; - } - error_message += "Added region: " + identifier; - } - if (ret != SUCCESS) error_message = "Error message for region: " + identifier + error_message; - return ret; -} - -void Map::lock_regions() { - regions_locked = true; - for (Region& region : regions) - for (Province* province : region.get_provinces()) - province->region = ®ion; -} - -size_t Map::get_province_count() const { - return provinces.size(); -} - -Province* Map::get_province_by_index(Province::index_t index) { - return index != Province::NULL_INDEX && index <= provinces.size() ? &provinces[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; -} - -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; -} - -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; -} - -Province* Map::get_province_by_colour(Province::colour_t colour) { - if (colour != Province::NULL_COLOUR) - for (Province& province : provinces) - 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) - if (province.get_colour() == colour) return &province; - return nullptr; -} - -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; -} - -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; -} - -static Province::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_index_image(size_t new_width, size_t new_height, uint8_t const* colour_data, std::string& error_message) { - if (!province_index_image.empty()) { - error_message = "Province index image has already been generated!"; - return FAILURE; - } - if (!provinces_locked) { - error_message = "Province index image cannot be generated until after provinces are locked!"; - return FAILURE; - } - if (new_width < 1 || new_height < 1) { - error_message = "Invalid province image dimensions: " + std::to_string(new_width) + "x" + std::to_string(new_height); - return FAILURE; - } - if (colour_data == nullptr) { - error_message = "Province colour data pointer is null!"; - return FAILURE; - } - width = new_width; - height = new_height; - province_index_image.resize(width * height); - - std::vector province_checklist(provinces.size()); - return_t ret = SUCCESS; - std::unordered_set unrecognised_colours; - error_message.clear(); - - for (int32_t y = 0; y < height; ++y) { - for (int32_t x = 0; x < width; ++x) { - const int32_t idx = x + y * width; - const Province::colour_t colour = colour_at(colour_data, idx); - if (x > 0) { - const int32_t jdx = idx - 1; - if (colour_at(colour_data, jdx) == colour) { - province_index_image[idx] = province_index_image[jdx]; - continue; - } - } - if (y > 0) { - const int32_t jdx = idx - width; - if (colour_at(colour_data, jdx) == colour) { - province_index_image[idx] = province_index_image[jdx]; - continue; - } - } - Province const* province = get_province_by_colour(colour); - if (province != nullptr) { - const Province::index_t index = province->get_index(); - province_index_image[idx] = index; - province_checklist[index - 1] = true; - continue; - } - if (unrecognised_colours.find(colour) == unrecognised_colours.end()) { - unrecognised_colours.insert(colour); - error_message += SEPARATOR + "Unrecognised province colour " + Province::colour_to_hex_string(colour) + " at (" + std::to_string(x) + ", " + std::to_string(y) + ")"; - ret = FAILURE; - } - province_index_image[idx] = Province::NULL_INDEX; - } - } - - for (size_t idx = 0; idx < province_checklist.size(); ++idx) { - if (!province_checklist[idx]) { - error_message += SEPARATOR + "Province missing from shape image: " + provinces[idx].to_string(); - ret = FAILURE; - } - } - - if (!error_message.empty()) error_message = "Error message for province index image generation:" + error_message + SEPARATOR; - error_message += "Generated province index image"; - return ret; -} - -size_t Map::get_width() const { - return width; -} - -size_t Map::get_height() const { - return height; -} - -std::vector const& Map::get_province_index_image() const { - return province_index_image; -} - -return_t Map::add_mapmode(std::string const& identifier, Mapmode::colour_func_t colour_func, std::string& error_message) { - if (identifier.empty()) { - error_message = "Empty mapmode identifier!"; - return FAILURE; - } - if (colour_func == nullptr) { - error_message = "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) { - error_message = "Duplicate mapmode identifiers: " + old_mapmode->get_identifier() + " and " + identifier; - return FAILURE; - } - mapmodes.push_back(new_mapmode); - error_message = "Added mapmode: " + identifier; - return SUCCESS; -} - -size_t Map::get_mapmode_count() const { - return mapmodes.size(); -} - -Mapmode const* Map::get_mapmode_by_index(size_t index) const { - return index < mapmodes.size() ? &mapmodes[index] : nullptr; -} - -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_t Map::generate_mapmode_colours(Mapmode::index_t index, uint8_t* target, std::string& error_message) const { - if (target == nullptr) { - error_message = "Mapmode colour target pointer is null!"; - return FAILURE; - } - if (index >= mapmodes.size()) { - error_message = "Invalid mapmode index: " + std::to_string(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); - *target++ = (colour >> 16) & 0xFF; - *target++ = (colour >> 8) & 0xFF; - *target++ = colour & 0xFF; - *target++ = province.is_water() ? 0 : 255; - } - error_message = "Generated province colours for mapmode " + mapmode.get_identifier(); - return SUCCESS; -} diff --git a/extension/src/openvic2/Map.hpp b/extension/src/openvic2/Map.hpp deleted file mode 100644 index 73ab8fd..0000000 --- a/extension/src/openvic2/Map.hpp +++ /dev/null @@ -1,67 +0,0 @@ -#pragma once - -#include -#include - -#include "Region.hpp" - -namespace OpenVic2 { - - struct Mapmode : HasIdentifier { - friend struct Map; - - using colour_func_t = std::function; - using index_t = size_t; - private: - index_t index; - 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_func_t get_colour_func() const; - }; - - /* REQUIREMENTS: - * MAP-4 - */ - struct Map { - private: - std::vector provinces; - std::vector regions; - bool provinces_locked = false, water_provinces_locked = false, regions_locked = false; - - size_t width = 0, height = 0; - std::vector province_index_image; - std::vector mapmodes; - public: - return_t add_province(std::string const& identifier, Province::colour_t colour, std::string& error_message); - void lock_provinces(); - return_t set_water_province(std::string const& identifier, std::string& error_message); - void lock_water_provinces(); - return_t add_region(std::string const& identifier, std::vector const& province_identifiers, std::string& error_message); - void lock_regions(); - - size_t get_province_count() const; - Province* get_province_by_index(Province::index_t index); - Province const* get_province_by_index(Province::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(Province::colour_t colour); - Province const* get_province_by_colour(Province::colour_t colour) 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_index_image(size_t new_width, size_t new_height, uint8_t const* colour_data, std::string& error_message); - size_t get_width() const; - size_t get_height() const; - std::vector const& get_province_index_image() const; - - return_t add_mapmode(std::string const& identifier, Mapmode::colour_func_t colour_func, std::string& error_message); - 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; - return_t generate_mapmode_colours(Mapmode::index_t index, uint8_t* target, std::string& error_message) const; - }; -} diff --git a/extension/src/openvic2/Province.cpp b/extension/src/openvic2/Province.cpp deleted file mode 100644 index 7d55708..0000000 --- a/extension/src/openvic2/Province.cpp +++ /dev/null @@ -1,43 +0,0 @@ -#include "Province.hpp" - -#include -#include -#include - -using namespace OpenVic2; - -Province::Province(index_t new_index, std::string const& new_identifier, colour_t new_colour) : - HasIdentifier(new_identifier), index(new_index), colour(new_colour) { - assert(index != NULL_INDEX); - assert(colour != NULL_COLOUR); -} - -std::string Province::colour_to_hex_string(colour_t colour) { - std::ostringstream stream; - stream << std::hex << std::setfill('0') << std::setw(6) << colour; - return stream.str(); -} - -Province::index_t Province::get_index() const { - return index; -} - -Province::colour_t Province::get_colour() const { - return colour; -} - -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; -} - -std::string Province::to_string() const { - return "(#" + std::to_string(index) + ", " + get_identifier() + ", 0x" + colour_to_hex_string(colour) + ")"; -} diff --git a/extension/src/openvic2/Province.hpp b/extension/src/openvic2/Province.hpp deleted file mode 100644 index deebd8c..0000000 --- a/extension/src/openvic2/Province.hpp +++ /dev/null @@ -1,39 +0,0 @@ -#pragma once - -#include "Types.hpp" - -namespace OpenVic2 { - struct Region; - struct Map; - - /* REQUIREMENTS: - * MAP-5, MAP-8, MAP-43, MAP-47 - */ - struct Province : HasIdentifier { - friend struct Map; - - using colour_t = uint32_t; - using index_t = uint16_t; - using life_rating_t = int8_t; - - static const colour_t NULL_COLOUR = 0, MAX_COLOUR = 0xFFFFFF; - static const index_t NULL_INDEX = 0, MAX_INDEX = 0xFFFF; - private: - index_t index; - colour_t colour; - Region* region = nullptr; - bool water = false; - life_rating_t life_rating = 0; - - Province(index_t new_index, std::string const& new_identifier, colour_t new_colour); - public: - static std::string colour_to_hex_string(colour_t colour); - - index_t get_index() const; - colour_t get_colour() const; - Region* get_region() const; - bool is_water() const; - life_rating_t get_life_rating() const; - std::string to_string() const; - }; -} diff --git a/extension/src/openvic2/Region.cpp b/extension/src/openvic2/Region.cpp deleted file mode 100644 index 67a75a9..0000000 --- a/extension/src/openvic2/Region.cpp +++ /dev/null @@ -1,26 +0,0 @@ -#include "Region.hpp" - -#include -#include - -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 const& ProvinceSet::get_provinces() const { - return provinces; -} - -Region::Region(std::string const& new_identifier) : HasIdentifier(new_identifier) {} - -Province::colour_t Region::get_colour() const { - if (provinces.empty()) return 0xFF0000; - Province const* province = *provinces.cbegin(); - return province->get_colour(); -} diff --git a/extension/src/openvic2/Region.hpp b/extension/src/openvic2/Region.hpp deleted file mode 100644 index 4ebabd1..0000000 --- a/extension/src/openvic2/Region.hpp +++ /dev/null @@ -1,29 +0,0 @@ -#pragma once - -#include - -#include "Province.hpp" - -namespace OpenVic2 { - struct Map; - - struct ProvinceSet { - protected: - std::set provinces; - public: - size_t get_province_count() const; - bool contains_province(Province const* province) const; - std::set 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: - Province::colour_t get_colour() const; - }; -} diff --git a/extension/src/openvic2/Types.cpp b/extension/src/openvic2/Types.cpp index 67c7a21..861ab50 100644 --- a/extension/src/openvic2/Types.cpp +++ b/extension/src/openvic2/Types.cpp @@ -1,10 +1,10 @@ -#include "Types.hpp" +#include "openvic2/Types.hpp" #include using namespace OpenVic2; -HasIdentifier::HasIdentifier(std::string const& new_identifier) : identifier(new_identifier) { +HasIdentifier::HasIdentifier(std::string const& new_identifier) : identifier{ new_identifier } { assert(!identifier.empty()); } diff --git a/extension/src/openvic2/Types.hpp b/extension/src/openvic2/Types.hpp index bf5ee27..b20db10 100644 --- a/extension/src/openvic2/Types.hpp +++ b/extension/src/openvic2/Types.hpp @@ -1,14 +1,16 @@ #pragma once #include +#include + +#include "openvic2/Logger.hpp" namespace OpenVic2 { using return_t = bool; // This mirrors godot::Error, where `OK = 0` and `FAILED = 1`. - static const return_t SUCCESS = false, FAILURE = true; + static constexpr return_t SUCCESS = false, FAILURE = true; - struct HasIdentifier { - private: + class HasIdentifier { std::string identifier; protected: HasIdentifier(std::string const& new_identifier); diff --git a/extension/src/openvic2/map/Building.cpp b/extension/src/openvic2/map/Building.cpp new file mode 100644 index 0000000..f453a0f --- /dev/null +++ b/extension/src/openvic2/map/Building.cpp @@ -0,0 +1,129 @@ +#include "openvic2/map/Building.hpp" + +#include + +#include "openvic2/Logger.hpp" + +using namespace OpenVic2; + +Building::Building(BuildingType const& new_type) : 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; +} + +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(today - start) / static_cast(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; +} + +return_t BuildingManager::add_building_type(std::string const& identifier, Building::level_t max_level, Timespan build_time) { + if (building_types_locked) { + Logger::error("The building type list has already been locked!"); + return FAILURE; + } + if (identifier.empty()) { + Logger::error("Empty building type identifier!"); + 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; + } + BuildingType new_building_type{ identifier, max_level, build_time }; + BuildingType const* old_building_type = get_building_type_by_identifier(identifier); + if (old_building_type != nullptr) { + Logger::error("Duplicate building type identifiers: ", old_building_type->get_identifier(), " and ", identifier); + return FAILURE; + } + building_types.push_back(new_building_type); + return SUCCESS; +} + +void BuildingManager::lock_building_types() { + building_types_locked = true; + Logger::info("Locked building types after registering ", building_types.size()); +} + +BuildingType const* BuildingManager::get_building_type_by_identifier(std::string const& identifier) const { + if (!identifier.empty()) + for (BuildingType const& building_type : building_types) + if (building_type.get_identifier() == identifier) return &building_type; + return nullptr; +} + +void BuildingManager::generate_province_buildings(std::vector& buildings) const { + for (BuildingType const& type : building_types) + buildings.push_back(Building{ type }); +} diff --git a/extension/src/openvic2/map/Building.hpp b/extension/src/openvic2/map/Building.hpp new file mode 100644 index 0000000..7a1a777 --- /dev/null +++ b/extension/src/openvic2/map/Building.hpp @@ -0,0 +1,63 @@ +#pragma once + +#include + +#include "openvic2/Types.hpp" +#include "openvic2/Date.hpp" + +namespace OpenVic2 { + struct BuildingManager; + struct BuildingType; + + struct Building { + friend struct BuildingManager; + + 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: + 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 BuildingType : HasIdentifier { + friend struct BuildingManager; + private: + Building::level_t max_level; + Timespan build_time; + + BuildingType(std::string const& new_identifier, Building::level_t new_max_level, Timespan new_build_time); + public: + Building::level_t get_max_level() const; + Timespan get_build_time() const; + }; + + struct BuildingManager { + private: + std::vector building_types; + bool building_types_locked = false; + public: + 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; + void generate_province_buildings(std::vector& buildings) const; + }; +} diff --git a/extension/src/openvic2/map/Map.cpp b/extension/src/openvic2/map/Map.cpp new file mode 100644 index 0000000..1089d61 --- /dev/null +++ b/extension/src/openvic2/map/Map.cpp @@ -0,0 +1,359 @@ +#include "openvic2/map/Map.hpp" + +#include +#include + +#include "openvic2/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; +} + +Mapmode::colour_func_t Mapmode::get_colour_func() const { + return colour_func; +} + +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) { + 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); + 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; +} + +void Map::lock_provinces() { + provinces_locked = true; + Logger::info("Locked provinces after registering ", provinces.size()); +} + +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 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) { + 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(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()); + 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; + } + 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()); + for (Province* province : new_region.get_provinces()) + province->region = tmp_region_index; + return ret; +} + +void Map::lock_regions() { + regions_locked = true; + for (Region& region : regions) + 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(); +} + +Province* Map::get_province_by_index(Province::index_t index) { + return index != Province::NULL_INDEX && index <= provinces.size() ? &provinces[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; +} + +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; +} + +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; +} + +Province* Map::get_province_by_colour(Province::colour_t colour) { + if (colour != Province::NULL_COLOUR) + for (Province& province : provinces) + 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) + if (province.get_colour() == colour) return &province; + return nullptr; +} + +Province::index_t Map::get_province_index_at(size_t x, size_t y) const { + if (x < width && y < height) return province_index_image[x + y * width]; + return Province::NULL_INDEX; +} + +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; +} + +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; +} + +static Province::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_index_image(size_t new_width, size_t new_height, uint8_t const* colour_data) { + if (!province_index_image.empty()) { + Logger::error("Province index image has already been generated!"); + return FAILURE; + } + if (!provinces_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; + } + width = new_width; + height = new_height; + province_index_image.resize(width * height); + + std::vector province_checklist(provinces.size()); + return_t ret = SUCCESS; + std::unordered_set unrecognised_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 Province::colour_t colour = colour_at(colour_data, idx); + if (x > 0) { + const int32_t jdx = idx - 1; + if (colour_at(colour_data, jdx) == colour) { + province_index_image[idx] = province_index_image[jdx]; + continue; + } + } + if (y > 0) { + const int32_t jdx = idx - width; + if (colour_at(colour_data, jdx) == colour) { + province_index_image[idx] = province_index_image[jdx]; + continue; + } + } + Province const* province = get_province_by_colour(colour); + if (province != nullptr) { + const Province::index_t index = province->get_index(); + province_index_image[idx] = index; + province_checklist[index - 1] = true; + 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, ")"); + ret = FAILURE; + } + province_index_image[idx] = Province::NULL_INDEX; + } + } + + 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()); + ret = FAILURE; + } + } + return ret; +} + +size_t Map::get_width() const { + return width; +} + +size_t Map::get_height() const { + return height; +} + +std::vector const& Map::get_province_index_image() const { + return province_index_image; +} + +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; +} + +size_t Map::get_mapmode_count() const { + return mapmodes.size(); +} + +Mapmode const* Map::get_mapmode_by_index(size_t index) const { + return index < mapmodes.size() ? &mapmodes[index] : nullptr; +} + +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_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; + } + if (index >= mapmodes.size()) { + 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); + *target++ = (colour >> 16) & 0xFF; + *target++ = (colour >> 8) & 0xFF; + *target++ = colour & 0xFF; + *target++ = province.is_water() ? 0 : 255; + } + return SUCCESS; +} + +void Map::generate_province_buildings(BuildingManager const& manager) { + for (Province& province : provinces) + manager.generate_province_buildings(province.buildings); +} + +void Map::update_state(Date const& today) { + for (Province& province : provinces) + province.update_state(today); +} + +void Map::tick(Date const& today) { + for (Province& province : provinces) + province.tick(today); +} diff --git a/extension/src/openvic2/map/Map.hpp b/extension/src/openvic2/map/Map.hpp new file mode 100644 index 0000000..b6e7ac2 --- /dev/null +++ b/extension/src/openvic2/map/Map.hpp @@ -0,0 +1,73 @@ +#pragma once + +#include + +#include "openvic2/map/Region.hpp" + +namespace OpenVic2 { + + struct Mapmode : HasIdentifier { + friend struct Map; + + using colour_func_t = std::function; + using index_t = size_t; + private: + index_t index; + 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_func_t get_colour_func() const; + }; + + /* REQUIREMENTS: + * MAP-4 + */ + struct Map { + private: + std::vector provinces; + std::vector regions; + bool provinces_locked = false, water_provinces_locked = false, regions_locked = false; + size_t water_province_count = 0; + + size_t width = 0, height = 0; + std::vector province_index_image; + std::vector mapmodes; + public: + return_t add_province(std::string const& identifier, Province::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 const& province_identifiers); + void lock_regions(); + + size_t get_province_count() const; + Province* get_province_by_index(Province::index_t index); + Province const* get_province_by_index(Province::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(Province::colour_t colour); + Province const* get_province_by_colour(Province::colour_t colour) const; + Province::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_index_image(size_t new_width, size_t new_height, uint8_t const* colour_data); + size_t get_width() const; + size_t get_height() const; + std::vector const& get_province_index_image() const; + + return_t add_mapmode(std::string const& identifier, Mapmode::colour_func_t colour_func); + 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; + return_t generate_mapmode_colours(Mapmode::index_t index, uint8_t* target) const; + + void generate_province_buildings(BuildingManager const& manager); + + void update_state(Date const& today); + void tick(Date const& today); + }; +} diff --git a/extension/src/openvic2/map/Province.cpp b/extension/src/openvic2/map/Province.cpp new file mode 100644 index 0000000..c641b7e --- /dev/null +++ b/extension/src/openvic2/map/Province.cpp @@ -0,0 +1,67 @@ +#include "openvic2/map/Province.hpp" + +#include +#include +#include + +using namespace OpenVic2; + +Province::Province(index_t new_index, std::string const& new_identifier, colour_t new_colour) : + HasIdentifier{ new_identifier }, index{ new_index }, colour{ new_colour } { + assert(index != NULL_INDEX); + assert(colour != NULL_COLOUR); +} + +std::string Province::colour_to_hex_string(colour_t colour) { + std::ostringstream stream; + stream << std::hex << std::setfill('0') << std::setw(6) << colour; + return stream.str(); +} + +Province::index_t Province::get_index() const { + return index; +} + +Province::colour_t Province::get_colour() const { + return colour; +} + +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; +} + +std::vector const& Province::get_buildings() const { + return buildings; +} + +return_t Province::expand_building(std::string const& building_type_identifier) { + for (Building& building : buildings) + if (building.get_type().get_identifier() == building_type_identifier) + return building.expand(); + return FAILURE; +} + +std::string Province::to_string() const { + std::stringstream stream; + stream << "(#" << std::to_string(index) << ", " << get_identifier() << ", 0x" << colour_to_hex_string(colour) << ")"; + return stream.str(); +} + +void Province::update_state(Date const& today) { + for (Building& building : buildings) + building.update_state(today); + +} + +void Province::tick(Date const& today) { + for (Building& building : buildings) + building.tick(today); +} diff --git a/extension/src/openvic2/map/Province.hpp b/extension/src/openvic2/map/Province.hpp new file mode 100644 index 0000000..79c6861 --- /dev/null +++ b/extension/src/openvic2/map/Province.hpp @@ -0,0 +1,45 @@ +#pragma once + +#include "openvic2/map/Building.hpp" + +namespace OpenVic2 { + struct Map; + struct Region; + + /* REQUIREMENTS: + * MAP-5, MAP-8, MAP-43, MAP-47 + */ + struct Province : HasIdentifier { + friend struct Map; + + using colour_t = uint32_t; + using index_t = uint16_t; + using life_rating_t = int8_t; + + static constexpr colour_t NULL_COLOUR = 0, MAX_COLOUR = 0xFFFFFF; + static constexpr index_t NULL_INDEX = 0, MAX_INDEX = 0xFFFF; + private: + index_t index; + colour_t colour; + Region* region = nullptr; + bool water = false; + life_rating_t life_rating = 0; + std::vector buildings; + + Province(index_t new_index, std::string const& new_identifier, colour_t new_colour); + public: + static std::string colour_to_hex_string(colour_t colour); + + index_t get_index() const; + colour_t get_colour() const; + Region* get_region() const; + bool is_water() const; + life_rating_t get_life_rating() const; + std::vector 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/extension/src/openvic2/map/Region.cpp b/extension/src/openvic2/map/Region.cpp new file mode 100644 index 0000000..3e5bee7 --- /dev/null +++ b/extension/src/openvic2/map/Region.cpp @@ -0,0 +1,26 @@ +#include "openvic2/map/Region.hpp" + +#include +#include + +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 const& ProvinceSet::get_provinces() const { + return provinces; +} + +Region::Region(std::string const& new_identifier) : HasIdentifier{ new_identifier } {} + +Province::colour_t Region::get_colour() const { + if (provinces.empty()) return 0xFF0000; + Province const* province = *provinces.cbegin(); + return province->get_colour(); +} diff --git a/extension/src/openvic2/map/Region.hpp b/extension/src/openvic2/map/Region.hpp new file mode 100644 index 0000000..2eec1cd --- /dev/null +++ b/extension/src/openvic2/map/Region.hpp @@ -0,0 +1,28 @@ +#pragma once + +#include + +#include "openvic2/map/Province.hpp" + +namespace OpenVic2 { + + struct ProvinceSet { + protected: + std::set provinces; + public: + size_t get_province_count() const; + bool contains_province(Province const* province) const; + std::set 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: + Province::colour_t get_colour() const; + }; +} -- cgit v1.2.3-56-ga3b1