aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--.gitignore76
-rw-r--r--Date.cpp161
-rw-r--r--Date.hpp83
-rw-r--r--GameAdvancementHook.cpp72
-rw-r--r--GameAdvancementHook.hpp42
-rw-r--r--GameManager.cpp46
-rw-r--r--GameManager.hpp29
-rw-r--r--Good.cpp3
-rw-r--r--Good.hpp21
-rw-r--r--LICENSE.md674
-rw-r--r--Logger.cpp26
-rw-r--r--Logger.hpp83
-rw-r--r--Types.cpp31
-rw-r--r--Types.hpp141
-rw-r--r--map/Building.cpp124
-rw-r--r--map/Building.hpp75
-rw-r--r--map/Map.cpp332
-rw-r--r--map/Map.hpp90
-rw-r--r--map/Province.cpp68
-rw-r--r--map/Province.hpp42
-rw-r--r--map/Region.cpp24
-rw-r--r--map/Region.hpp30
22 files changed, 2273 insertions, 0 deletions
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..596bc88
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,76 @@
+# Prerequisites
+*.d
+
+# Compiled Object files
+*.slo
+*.lo
+*.o
+*.obj
+
+# Precompiled Headers
+*.gch
+*.pch
+
+# Compiled Dynamic libraries
+*.so
+*.dylib
+*.dll
+
+# Fortran module files
+*.mod
+*.smod
+
+# Compiled Static libraries
+*.lai
+*.la
+*.a
+*.lib
+
+# Executables
+*.exe
+*.out
+*.app
+
+# clangd
+.cache/*
+
+# VSCode
+.vscode/*
+!.vscode/launch.json
+!.vscode/tasks.json
+
+# Visual Studio
+.vs/
+
+# Godot 4+ specific ignores
+.godot/
+game/bin/openvic2/*
+.sconsign*.dblite
+
+# Binaries
+*.o
+*.os
+*.so
+*.obj
+*.bc
+*.pyc
+*.dblite
+*.pdb
+*.lib
+bin/*
+*.config
+*.creator
+*.creator.user
+*.files
+*.includes
+*.idb
+*.exp
+
+# Build configuarion.
+/custom.py
+
+# MacOS stuff
+.DS_Store
+
+*.translation
+!game/common/map/*.obj \ No newline at end of file
diff --git a/Date.cpp b/Date.cpp
new file mode 100644
index 0000000..ed800d5
--- /dev/null
+++ b/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/Date.hpp b/Date.hpp
new file mode 100644
index 0000000..b19602b
--- /dev/null
+++ b/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/GameAdvancementHook.cpp b/GameAdvancementHook.cpp
new file mode 100644
index 0000000..d90b7b1
--- /dev/null
+++ b/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/GameAdvancementHook.hpp b/GameAdvancementHook.hpp
new file mode 100644
index 0000000..07f8414
--- /dev/null
+++ b/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/GameManager.cpp b/GameManager.cpp
new file mode 100644
index 0000000..58e40bb
--- /dev/null
+++ b/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/GameManager.hpp b/GameManager.hpp
new file mode 100644
index 0000000..70e98bd
--- /dev/null
+++ b/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/Good.cpp b/Good.cpp
new file mode 100644
index 0000000..e3389de
--- /dev/null
+++ b/Good.cpp
@@ -0,0 +1,3 @@
+#include "Good.hpp"
+
+using namespace OpenVic2;
diff --git a/Good.hpp b/Good.hpp
new file mode 100644
index 0000000..378bbc4
--- /dev/null
+++ b/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/LICENSE.md b/LICENSE.md
new file mode 100644
index 0000000..f288702
--- /dev/null
+++ b/LICENSE.md
@@ -0,0 +1,674 @@
+ GNU GENERAL PUBLIC LICENSE
+ Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+ Preamble
+
+ The GNU General Public License is a free, copyleft license for
+software and other kinds of works.
+
+ The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works. By contrast,
+the GNU General Public License is intended to guarantee your freedom to
+share and change all versions of a program--to make sure it remains free
+software for all its users. We, the Free Software Foundation, use the
+GNU General Public License for most of our software; it applies also to
+any other work released this way by its authors. You can apply it to
+your programs, too.
+
+ When we speak of free software, we are referring to freedom, not
+price. Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+them if you wish), that you receive source code or can get it if you
+want it, that you can change the software or use pieces of it in new
+free programs, and that you know you can do these things.
+
+ To protect your rights, we need to prevent others from denying you
+these rights or asking you to surrender the rights. Therefore, you have
+certain responsibilities if you distribute copies of the software, or if
+you modify it: responsibilities to respect the freedom of others.
+
+ For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must pass on to the recipients the same
+freedoms that you received. You must make sure that they, too, receive
+or can get the source code. And you must show them these terms so they
+know their rights.
+
+ Developers that use the GNU GPL protect your rights with two steps:
+(1) assert copyright on the software, and (2) offer you this License
+giving you legal permission to copy, distribute and/or modify it.
+
+ For the developers' and authors' protection, the GPL clearly explains
+that there is no warranty for this free software. For both users' and
+authors' sake, the GPL requires that modified versions be marked as
+changed, so that their problems will not be attributed erroneously to
+authors of previous versions.
+
+ Some devices are designed to deny users access to install or run
+modified versions of the software inside them, although the manufacturer
+can do so. This is fundamentally incompatible with the aim of
+protecting users' freedom to change the software. The systematic
+pattern of such abuse occurs in the area of products for individuals to
+use, which is precisely where it is most unacceptable. Therefore, we
+have designed this version of the GPL to prohibit the practice for those
+products. If such problems arise substantially in other domains, we
+stand ready to extend this provision to those domains in future versions
+of the GPL, as needed to protect the freedom of users.
+
+ Finally, every program is threatened constantly by software patents.
+States should not allow patents to restrict development and use of
+software on general-purpose computers, but in those that do, we wish to
+avoid the special danger that patents applied to a free program could
+make it effectively proprietary. To prevent this, the GPL assures that
+patents cannot be used to render the program non-free.
+
+ The precise terms and conditions for copying, distribution and
+modification follow.
+
+ TERMS AND CONDITIONS
+
+ 0. Definitions.
+
+ "This License" refers to version 3 of the GNU General Public License.
+
+ "Copyright" also means copyright-like laws that apply to other kinds of
+works, such as semiconductor masks.
+
+ "The Program" refers to any copyrightable work licensed under this
+License. Each licensee is addressed as "you". "Licensees" and
+"recipients" may be individuals or organizations.
+
+ To "modify" a work means to copy from or adapt all or part of the work
+in a fashion requiring copyright permission, other than the making of an
+exact copy. The resulting work is called a "modified version" of the
+earlier work or a work "based on" the earlier work.
+
+ A "covered work" means either the unmodified Program or a work based
+on the Program.
+
+ To "propagate" a work means to do anything with it that, without
+permission, would make you directly or secondarily liable for
+infringement under applicable copyright law, except executing it on a
+computer or modifying a private copy. Propagation includes copying,
+distribution (with or without modification), making available to the
+public, and in some countries other activities as well.
+
+ To "convey" a work means any kind of propagation that enables other
+parties to make or receive copies. Mere interaction with a user through
+a computer network, with no transfer of a copy, is not conveying.
+
+ An interactive user interface displays "Appropriate Legal Notices"
+to the extent that it includes a convenient and prominently visible
+feature that (1) displays an appropriate copyright notice, and (2)
+tells the user that there is no warranty for the work (except to the
+extent that warranties are provided), that licensees may convey the
+work under this License, and how to view a copy of this License. If
+the interface presents a list of user commands or options, such as a
+menu, a prominent item in the list meets this criterion.
+
+ 1. Source Code.
+
+ The "source code" for a work means the preferred form of the work
+for making modifications to it. "Object code" means any non-source
+form of a work.
+
+ A "Standard Interface" means an interface that either is an official
+standard defined by a recognized standards body, or, in the case of
+interfaces specified for a particular programming language, one that
+is widely used among developers working in that language.
+
+ The "System Libraries" of an executable work include anything, other
+than the work as a whole, that (a) is included in the normal form of
+packaging a Major Component, but which is not part of that Major
+Component, and (b) serves only to enable use of the work with that
+Major Component, or to implement a Standard Interface for which an
+implementation is available to the public in source code form. A
+"Major Component", in this context, means a major essential component
+(kernel, window system, and so on) of the specific operating system
+(if any) on which the executable work runs, or a compiler used to
+produce the work, or an object code interpreter used to run it.
+
+ The "Corresponding Source" for a work in object code form means all
+the source code needed to generate, install, and (for an executable
+work) run the object code and to modify the work, including scripts to
+control those activities. However, it does not include the work's
+System Libraries, or general-purpose tools or generally available free
+programs which are used unmodified in performing those activities but
+which are not part of the work. For example, Corresponding Source
+includes interface definition files associated with source files for
+the work, and the source code for shared libraries and dynamically
+linked subprograms that the work is specifically designed to require,
+such as by intimate data communication or control flow between those
+subprograms and other parts of the work.
+
+ The Corresponding Source need not include anything that users
+can regenerate automatically from other parts of the Corresponding
+Source.
+
+ The Corresponding Source for a work in source code form is that
+same work.
+
+ 2. Basic Permissions.
+
+ All rights granted under this License are granted for the term of
+copyright on the Program, and are irrevocable provided the stated
+conditions are met. This License explicitly affirms your unlimited
+permission to run the unmodified Program. The output from running a
+covered work is covered by this License only if the output, given its
+content, constitutes a covered work. This License acknowledges your
+rights of fair use or other equivalent, as provided by copyright law.
+
+ You may make, run and propagate covered works that you do not
+convey, without conditions so long as your license otherwise remains
+in force. You may convey covered works to others for the sole purpose
+of having them make modifications exclusively for you, or provide you
+with facilities for running those works, provided that you comply with
+the terms of this License in conveying all material for which you do
+not control copyright. Those thus making or running the covered works
+for you must do so exclusively on your behalf, under your direction
+and control, on terms that prohibit them from making any copies of
+your copyrighted material outside their relationship with you.
+
+ Conveying under any other circumstances is permitted solely under
+the conditions stated below. Sublicensing is not allowed; section 10
+makes it unnecessary.
+
+ 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+
+ No covered work shall be deemed part of an effective technological
+measure under any applicable law fulfilling obligations under article
+11 of the WIPO copyright treaty adopted on 20 December 1996, or
+similar laws prohibiting or restricting circumvention of such
+measures.
+
+ When you convey a covered work, you waive any legal power to forbid
+circumvention of technological measures to the extent such circumvention
+is effected by exercising rights under this License with respect to
+the covered work, and you disclaim any intention to limit operation or
+modification of the work as a means of enforcing, against the work's
+users, your or third parties' legal rights to forbid circumvention of
+technological measures.
+
+ 4. Conveying Verbatim Copies.
+
+ You may convey verbatim copies of the Program's source code as you
+receive it, in any medium, provided that you conspicuously and
+appropriately publish on each copy an appropriate copyright notice;
+keep intact all notices stating that this License and any
+non-permissive terms added in accord with section 7 apply to the code;
+keep intact all notices of the absence of any warranty; and give all
+recipients a copy of this License along with the Program.
+
+ You may charge any price or no price for each copy that you convey,
+and you may offer support or warranty protection for a fee.
+
+ 5. Conveying Modified Source Versions.
+
+ You may convey a work based on the Program, or the modifications to
+produce it from the Program, in the form of source code under the
+terms of section 4, provided that you also meet all of these conditions:
+
+ a) The work must carry prominent notices stating that you modified
+ it, and giving a relevant date.
+
+ b) The work must carry prominent notices stating that it is
+ released under this License and any conditions added under section
+ 7. This requirement modifies the requirement in section 4 to
+ "keep intact all notices".
+
+ c) You must license the entire work, as a whole, under this
+ License to anyone who comes into possession of a copy. This
+ License will therefore apply, along with any applicable section 7
+ additional terms, to the whole of the work, and all its parts,
+ regardless of how they are packaged. This License gives no
+ permission to license the work in any other way, but it does not
+ invalidate such permission if you have separately received it.
+
+ d) If the work has interactive user interfaces, each must display
+ Appropriate Legal Notices; however, if the Program has interactive
+ interfaces that do not display Appropriate Legal Notices, your
+ work need not make them do so.
+
+ A compilation of a covered work with other separate and independent
+works, which are not by their nature extensions of the covered work,
+and which are not combined with it such as to form a larger program,
+in or on a volume of a storage or distribution medium, is called an
+"aggregate" if the compilation and its resulting copyright are not
+used to limit the access or legal rights of the compilation's users
+beyond what the individual works permit. Inclusion of a covered work
+in an aggregate does not cause this License to apply to the other
+parts of the aggregate.
+
+ 6. Conveying Non-Source Forms.
+
+ You may convey a covered work in object code form under the terms
+of sections 4 and 5, provided that you also convey the
+machine-readable Corresponding Source under the terms of this License,
+in one of these ways:
+
+ a) Convey the object code in, or embodied in, a physical product
+ (including a physical distribution medium), accompanied by the
+ Corresponding Source fixed on a durable physical medium
+ customarily used for software interchange.
+
+ b) Convey the object code in, or embodied in, a physical product
+ (including a physical distribution medium), accompanied by a
+ written offer, valid for at least three years and valid for as
+ long as you offer spare parts or customer support for that product
+ model, to give anyone who possesses the object code either (1) a
+ copy of the Corresponding Source for all the software in the
+ product that is covered by this License, on a durable physical
+ medium customarily used for software interchange, for a price no
+ more than your reasonable cost of physically performing this
+ conveying of source, or (2) access to copy the
+ Corresponding Source from a network server at no charge.
+
+ c) Convey individual copies of the object code with a copy of the
+ written offer to provide the Corresponding Source. This
+ alternative is allowed only occasionally and noncommercially, and
+ only if you received the object code with such an offer, in accord
+ with subsection 6b.
+
+ d) Convey the object code by offering access from a designated
+ place (gratis or for a charge), and offer equivalent access to the
+ Corresponding Source in the same way through the same place at no
+ further charge. You need not require recipients to copy the
+ Corresponding Source along with the object code. If the place to
+ copy the object code is a network server, the Corresponding Source
+ may be on a different server (operated by you or a third party)
+ that supports equivalent copying facilities, provided you maintain
+ clear directions next to the object code saying where to find the
+ Corresponding Source. Regardless of what server hosts the
+ Corresponding Source, you remain obligated to ensure that it is
+ available for as long as needed to satisfy these requirements.
+
+ e) Convey the object code using peer-to-peer transmission, provided
+ you inform other peers where the object code and Corresponding
+ Source of the work are being offered to the general public at no
+ charge under subsection 6d.
+
+ A separable portion of the object code, whose source code is excluded
+from the Corresponding Source as a System Library, need not be
+included in conveying the object code work.
+
+ A "User Product" is either (1) a "consumer product", which means any
+tangible personal property which is normally used for personal, family,
+or household purposes, or (2) anything designed or sold for incorporation
+into a dwelling. In determining whether a product is a consumer product,
+doubtful cases shall be resolved in favor of coverage. For a particular
+product received by a particular user, "normally used" refers to a
+typical or common use of that class of product, regardless of the status
+of the particular user or of the way in which the particular user
+actually uses, or expects or is expected to use, the product. A product
+is a consumer product regardless of whether the product has substantial
+commercial, industrial or non-consumer uses, unless such uses represent
+the only significant mode of use of the product.
+
+ "Installation Information" for a User Product means any methods,
+procedures, authorization keys, or other information required to install
+and execute modified versions of a covered work in that User Product from
+a modified version of its Corresponding Source. The information must
+suffice to ensure that the continued functioning of the modified object
+code is in no case prevented or interfered with solely because
+modification has been made.
+
+ If you convey an object code work under this section in, or with, or
+specifically for use in, a User Product, and the conveying occurs as
+part of a transaction in which the right of possession and use of the
+User Product is transferred to the recipient in perpetuity or for a
+fixed term (regardless of how the transaction is characterized), the
+Corresponding Source conveyed under this section must be accompanied
+by the Installation Information. But this requirement does not apply
+if neither you nor any third party retains the ability to install
+modified object code on the User Product (for example, the work has
+been installed in ROM).
+
+ The requirement to provide Installation Information does not include a
+requirement to continue to provide support service, warranty, or updates
+for a work that has been modified or installed by the recipient, or for
+the User Product in which it has been modified or installed. Access to a
+network may be denied when the modification itself materially and
+adversely affects the operation of the network or violates the rules and
+protocols for communication across the network.
+
+ Corresponding Source conveyed, and Installation Information provided,
+in accord with this section must be in a format that is publicly
+documented (and with an implementation available to the public in
+source code form), and must require no special password or key for
+unpacking, reading or copying.
+
+ 7. Additional Terms.
+
+ "Additional permissions" are terms that supplement the terms of this
+License by making exceptions from one or more of its conditions.
+Additional permissions that are applicable to the entire Program shall
+be treated as though they were included in this License, to the extent
+that they are valid under applicable law. If additional permissions
+apply only to part of the Program, that part may be used separately
+under those permissions, but the entire Program remains governed by
+this License without regard to the additional permissions.
+
+ When you convey a copy of a covered work, you may at your option
+remove any additional permissions from that copy, or from any part of
+it. (Additional permissions may be written to require their own
+removal in certain cases when you modify the work.) You may place
+additional permissions on material, added by you to a covered work,
+for which you have or can give appropriate copyright permission.
+
+ Notwithstanding any other provision of this License, for material you
+add to a covered work, you may (if authorized by the copyright holders of
+that material) supplement the terms of this License with terms:
+
+ a) Disclaiming warranty or limiting liability differently from the
+ terms of sections 15 and 16 of this License; or
+
+ b) Requiring preservation of specified reasonable legal notices or
+ author attributions in that material or in the Appropriate Legal
+ Notices displayed by works containing it; or
+
+ c) Prohibiting misrepresentation of the origin of that material, or
+ requiring that modified versions of such material be marked in
+ reasonable ways as different from the original version; or
+
+ d) Limiting the use for publicity purposes of names of licensors or
+ authors of the material; or
+
+ e) Declining to grant rights under trademark law for use of some
+ trade names, trademarks, or service marks; or
+
+ f) Requiring indemnification of licensors and authors of that
+ material by anyone who conveys the material (or modified versions of
+ it) with contractual assumptions of liability to the recipient, for
+ any liability that these contractual assumptions directly impose on
+ those licensors and authors.
+
+ All other non-permissive additional terms are considered "further
+restrictions" within the meaning of section 10. If the Program as you
+received it, or any part of it, contains a notice stating that it is
+governed by this License along with a term that is a further
+restriction, you may remove that term. If a license document contains
+a further restriction but permits relicensing or conveying under this
+License, you may add to a covered work material governed by the terms
+of that license document, provided that the further restriction does
+not survive such relicensing or conveying.
+
+ If you add terms to a covered work in accord with this section, you
+must place, in the relevant source files, a statement of the
+additional terms that apply to those files, or a notice indicating
+where to find the applicable terms.
+
+ Additional terms, permissive or non-permissive, may be stated in the
+form of a separately written license, or stated as exceptions;
+the above requirements apply either way.
+
+ 8. Termination.
+
+ You may not propagate or modify a covered work except as expressly
+provided under this License. Any attempt otherwise to propagate or
+modify it is void, and will automatically terminate your rights under
+this License (including any patent licenses granted under the third
+paragraph of section 11).
+
+ However, if you cease all violation of this License, then your
+license from a particular copyright holder is reinstated (a)
+provisionally, unless and until the copyright holder explicitly and
+finally terminates your license, and (b) permanently, if the copyright
+holder fails to notify you of the violation by some reasonable means
+prior to 60 days after the cessation.
+
+ Moreover, your license from a particular copyright holder is
+reinstated permanently if the copyright holder notifies you of the
+violation by some reasonable means, this is the first time you have
+received notice of violation of this License (for any work) from that
+copyright holder, and you cure the violation prior to 30 days after
+your receipt of the notice.
+
+ Termination of your rights under this section does not terminate the
+licenses of parties who have received copies or rights from you under
+this License. If your rights have been terminated and not permanently
+reinstated, you do not qualify to receive new licenses for the same
+material under section 10.
+
+ 9. Acceptance Not Required for Having Copies.
+
+ You are not required to accept this License in order to receive or
+run a copy of the Program. Ancillary propagation of a covered work
+occurring solely as a consequence of using peer-to-peer transmission
+to receive a copy likewise does not require acceptance. However,
+nothing other than this License grants you permission to propagate or
+modify any covered work. These actions infringe copyright if you do
+not accept this License. Therefore, by modifying or propagating a
+covered work, you indicate your acceptance of this License to do so.
+
+ 10. Automatic Licensing of Downstream Recipients.
+
+ Each time you convey a covered work, the recipient automatically
+receives a license from the original licensors, to run, modify and
+propagate that work, subject to this License. You are not responsible
+for enforcing compliance by third parties with this License.
+
+ An "entity transaction" is a transaction transferring control of an
+organization, or substantially all assets of one, or subdividing an
+organization, or merging organizations. If propagation of a covered
+work results from an entity transaction, each party to that
+transaction who receives a copy of the work also receives whatever
+licenses to the work the party's predecessor in interest had or could
+give under the previous paragraph, plus a right to possession of the
+Corresponding Source of the work from the predecessor in interest, if
+the predecessor has it or can get it with reasonable efforts.
+
+ You may not impose any further restrictions on the exercise of the
+rights granted or affirmed under this License. For example, you may
+not impose a license fee, royalty, or other charge for exercise of
+rights granted under this License, and you may not initiate litigation
+(including a cross-claim or counterclaim in a lawsuit) alleging that
+any patent claim is infringed by making, using, selling, offering for
+sale, or importing the Program or any portion of it.
+
+ 11. Patents.
+
+ A "contributor" is a copyright holder who authorizes use under this
+License of the Program or a work on which the Program is based. The
+work thus licensed is called the contributor's "contributor version".
+
+ A contributor's "essential patent claims" are all patent claims
+owned or controlled by the contributor, whether already acquired or
+hereafter acquired, that would be infringed by some manner, permitted
+by this License, of making, using, or selling its contributor version,
+but do not include claims that would be infringed only as a
+consequence of further modification of the contributor version. For
+purposes of this definition, "control" includes the right to grant
+patent sublicenses in a manner consistent with the requirements of
+this License.
+
+ Each contributor grants you a non-exclusive, worldwide, royalty-free
+patent license under the contributor's essential patent claims, to
+make, use, sell, offer for sale, import and otherwise run, modify and
+propagate the contents of its contributor version.
+
+ In the following three paragraphs, a "patent license" is any express
+agreement or commitment, however denominated, not to enforce a patent
+(such as an express permission to practice a patent or covenant not to
+sue for patent infringement). To "grant" such a patent license to a
+party means to make such an agreement or commitment not to enforce a
+patent against the party.
+
+ If you convey a covered work, knowingly relying on a patent license,
+and the Corresponding Source of the work is not available for anyone
+to copy, free of charge and under the terms of this License, through a
+publicly available network server or other readily accessible means,
+then you must either (1) cause the Corresponding Source to be so
+available, or (2) arrange to deprive yourself of the benefit of the
+patent license for this particular work, or (3) arrange, in a manner
+consistent with the requirements of this License, to extend the patent
+license to downstream recipients. "Knowingly relying" means you have
+actual knowledge that, but for the patent license, your conveying the
+covered work in a country, or your recipient's use of the covered work
+in a country, would infringe one or more identifiable patents in that
+country that you have reason to believe are valid.
+
+ If, pursuant to or in connection with a single transaction or
+arrangement, you convey, or propagate by procuring conveyance of, a
+covered work, and grant a patent license to some of the parties
+receiving the covered work authorizing them to use, propagate, modify
+or convey a specific copy of the covered work, then the patent license
+you grant is automatically extended to all recipients of the covered
+work and works based on it.
+
+ A patent license is "discriminatory" if it does not include within
+the scope of its coverage, prohibits the exercise of, or is
+conditioned on the non-exercise of one or more of the rights that are
+specifically granted under this License. You may not convey a covered
+work if you are a party to an arrangement with a third party that is
+in the business of distributing software, under which you make payment
+to the third party based on the extent of your activity of conveying
+the work, and under which the third party grants, to any of the
+parties who would receive the covered work from you, a discriminatory
+patent license (a) in connection with copies of the covered work
+conveyed by you (or copies made from those copies), or (b) primarily
+for and in connection with specific products or compilations that
+contain the covered work, unless you entered into that arrangement,
+or that patent license was granted, prior to 28 March 2007.
+
+ Nothing in this License shall be construed as excluding or limiting
+any implied license or other defenses to infringement that may
+otherwise be available to you under applicable patent law.
+
+ 12. No Surrender of Others' Freedom.
+
+ If conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License. If you cannot convey a
+covered work so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you may
+not convey it at all. For example, if you agree to terms that obligate you
+to collect a royalty for further conveying from those to whom you convey
+the Program, the only way you could satisfy both those terms and this
+License would be to refrain entirely from conveying the Program.
+
+ 13. Use with the GNU Affero General Public License.
+
+ Notwithstanding any other provision of this License, you have
+permission to link or combine any covered work with a work licensed
+under version 3 of the GNU Affero General Public License into a single
+combined work, and to convey the resulting work. The terms of this
+License will continue to apply to the part which is the covered work,
+but the special requirements of the GNU Affero General Public License,
+section 13, concerning interaction through a network will apply to the
+combination as such.
+
+ 14. Revised Versions of this License.
+
+ The Free Software Foundation may publish revised and/or new versions of
+the GNU General Public License from time to time. Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+ Each version is given a distinguishing version number. If the
+Program specifies that a certain numbered version of the GNU General
+Public License "or any later version" applies to it, you have the
+option of following the terms and conditions either of that numbered
+version or of any later version published by the Free Software
+Foundation. If the Program does not specify a version number of the
+GNU General Public License, you may choose any version ever published
+by the Free Software Foundation.
+
+ If the Program specifies that a proxy can decide which future
+versions of the GNU General Public License can be used, that proxy's
+public statement of acceptance of a version permanently authorizes you
+to choose that version for the Program.
+
+ Later license versions may give you additional or different
+permissions. However, no additional obligations are imposed on any
+author or copyright holder as a result of your choosing to follow a
+later version.
+
+ 15. Disclaimer of Warranty.
+
+ THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
+APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
+OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
+IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+ 16. Limitation of Liability.
+
+ IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
+THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
+GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
+USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
+DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
+PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGES.
+
+ 17. Interpretation of Sections 15 and 16.
+
+ If the disclaimer of warranty and limitation of liability provided
+above cannot be given local legal effect according to their terms,
+reviewing courts shall apply local law that most closely approximates
+an absolute waiver of all civil liability in connection with the
+Program, unless a warranty or assumption of liability accompanies a
+copy of the Program in return for a fee.
+
+ END OF TERMS AND CONDITIONS
+
+ How to Apply These Terms to Your New Programs
+
+ If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+ To do so, attach the following notices to the program. It is safest
+to attach them to the start of each source file to most effectively
+state the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+ <one line to give the program's name and a brief idea of what it does.>
+ Copyright (C) <year> <name of author>
+
+ This program is free software: you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation, either version 3 of the License, or
+ (at your option) any later version.
+
+ This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with this program. If not, see <https://www.gnu.org/licenses/>.
+
+Also add information on how to contact you by electronic and paper mail.
+
+ If the program does terminal interaction, make it output a short
+notice like this when it starts in an interactive mode:
+
+ <program> Copyright (C) <year> <name of author>
+ This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+ This is free software, and you are welcome to redistribute it
+ under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License. Of course, your program's commands
+might be different; for a GUI interface, you would use an "about box".
+
+ You should also get your employer (if you work as a programmer) or school,
+if any, to sign a "copyright disclaimer" for the program, if necessary.
+For more information on this, and how to apply and follow the GNU GPL, see
+<https://www.gnu.org/licenses/>.
+
+ The GNU General Public License does not permit incorporating your program
+into proprietary programs. If your program is a subroutine library, you
+may consider it more useful to permit linking proprietary applications with
+the library. If this is what you want to do, use the GNU Lesser General
+Public License instead of this License. But first, please read
+<https://www.gnu.org/licenses/why-not-lgpl.html>.
diff --git a/Logger.cpp b/Logger.cpp
new file mode 100644
index 0000000..4d7378e
--- /dev/null
+++ b/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/Logger.hpp b/Logger.hpp
new file mode 100644
index 0000000..624df29
--- /dev/null
+++ b/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/Types.cpp b/Types.cpp
new file mode 100644
index 0000000..f51ad7c
--- /dev/null
+++ b/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/Types.hpp b/Types.hpp
new file mode 100644
index 0000000..e4a0e2d
--- /dev/null
+++ b/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/map/Building.cpp b/map/Building.cpp
new file mode 100644
index 0000000..1e26873
--- /dev/null
+++ b/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/map/Building.hpp b/map/Building.hpp
new file mode 100644
index 0000000..78d08ae
--- /dev/null
+++ b/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/map/Map.cpp b/map/Map.cpp
new file mode 100644
index 0000000..1f44c43
--- /dev/null
+++ b/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/map/Map.hpp b/map/Map.hpp
new file mode 100644
index 0000000..cb8dcb1
--- /dev/null
+++ b/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/map/Province.cpp b/map/Province.cpp
new file mode 100644
index 0000000..b3d455b
--- /dev/null
+++ b/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/map/Province.hpp b/map/Province.hpp
new file mode 100644
index 0000000..9b07fc1
--- /dev/null
+++ b/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/map/Region.cpp b/map/Region.cpp
new file mode 100644
index 0000000..da0dfdd
--- /dev/null
+++ b/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/map/Region.hpp b/map/Region.hpp
new file mode 100644
index 0000000..3920dfc
--- /dev/null
+++ b/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;
+ };
+}