Merge pull request #198 from OpenVicProject/resultant-modifier

Calculate country and province modifier sums

8 files changed, 182 insertions, 4 deletions

diff --git a/src/openvic-simulation/map/Crime.cpp b/src/openvic-simulation/map/Crime.cpp
index fb521ad..176f71b 100644
--- a/src/openvic-simulation/map/Crime.cpp
+++ b/src/openvic-simulation/map/Crime.cpp
@@ -1,5 +1,7 @@
 #include "Crime.hpp"
 
+#include "openvic-simulation/modifier/ModifierManager.hpp"
+
 using namespace OpenVic;
 using namespace OpenVic::NodeTools;
 
@@ -27,17 +29,23 @@ bool CrimeManager::load_crime_modifiers(ModifierManager const& modifier_manager,
 	const bool ret = expect_dictionary_reserve_length(
 		crime_modifiers,
 		[this, &modifier_manager](std::string_view key, ast::NodeCPtr value) -> bool {
+			using enum Modifier::modifier_type_t;
+
 			ModifierValue modifier_value;
 			IconModifier::icon_t icon = 0;
 			ConditionScript trigger { scope_t::PROVINCE, scope_t::NO_SCOPE, scope_t::NO_SCOPE };
 			bool default_active = false;
+
 			bool ret = modifier_manager.expect_modifier_value_and_keys(
 				move_variable_callback(modifier_value),
+				CRIME,
 				"icon", ZERO_OR_ONE, expect_uint(assign_variable_callback(icon)),
 				"trigger", ONE_EXACTLY, trigger.expect_script(),
 				"active", ZERO_OR_ONE, expect_bool(assign_variable_callback(default_active))
 			)(value);
+
 			ret &= add_crime_modifier(key, std::move(modifier_value), icon, std::move(trigger), default_active);
+
 			return ret;
 		}
 	)(root);
diff --git a/src/openvic-simulation/map/MapDefinition.cpp b/src/openvic-simulation/map/MapDefinition.cpp
index 828a679..5fe7189 100644
--- a/src/openvic-simulation/map/MapDefinition.cpp
+++ b/src/openvic-simulation/map/MapDefinition.cpp
@@ -3,6 +3,7 @@
 #include <cstdint>
 #include <vector>
 
+#include "openvic-simulation/modifier/ModifierManager.hpp"
 #include "openvic-simulation/types/Colour.hpp"
 #include "openvic-simulation/types/OrderedContainers.hpp"
 #include "openvic-simulation/types/Vector.hpp"
@@ -954,8 +955,12 @@ bool MapDefinition::load_climate_file(ModifierManager const& modifier_manager, a
 			bool ret = true;
 			Climate* cur_climate = climates.get_item_by_identifier(identifier);
 			if (cur_climate == nullptr) {
+				using enum Modifier::modifier_type_t;
+
 				ModifierValue values;
-				ret &= modifier_manager.expect_modifier_value(move_variable_callback(values))(node);
+
+				ret &= modifier_manager.expect_modifier_value(move_variable_callback(values), CLIMATE)(node);
+
 				ret &= climates.add_item({ identifier, std::move(values), Modifier::modifier_type_t::CLIMATE });
 			} else {
 				ret &= expect_list_reserve_length(*cur_climate, expect_province_definition_identifier(
@@ -999,6 +1004,8 @@ bool MapDefinition::load_continent_file(ModifierManager const& modifier_manager,
 	bool ret = expect_dictionary_reserve_length(
 		continents,
 		[this, &modifier_manager](std::string_view identifier, ast::NodeCPtr node) -> bool {
+			using enum Modifier::modifier_type_t;
+
 			if (identifier.empty()) {
 				Logger::error("Invalid continent identifier - empty!");
 				return false;
@@ -1006,7 +1013,9 @@ bool MapDefinition::load_continent_file(ModifierManager const& modifier_manager,
 
 			ModifierValue values;
 			std::vector<ProvinceDefinition const*> prov_list;
-			bool ret = modifier_manager.expect_modifier_value_and_keys(move_variable_callback(values),
+			bool ret = modifier_manager.expect_modifier_value_and_keys(
+				move_variable_callback(values),
+				CONTINENT,
 				"provinces", ONE_EXACTLY, expect_list_reserve_length(prov_list, expect_province_definition_identifier(
 					[&prov_list](ProvinceDefinition const& province) -> bool {
 						if (province.continent == nullptr) {
diff --git a/src/openvic-simulation/map/MapInstance.cpp b/src/openvic-simulation/map/MapInstance.cpp
index 0ce8cea..d8ec2fb 100644
--- a/src/openvic-simulation/map/MapInstance.cpp
+++ b/src/openvic-simulation/map/MapInstance.cpp
@@ -118,6 +118,12 @@ bool MapInstance::apply_history_to_provinces(
 	return ret;
 }
 
+void MapInstance::update_modifier_sums(Date today, StaticModifierCache const& static_modifier_cache) {
+	for (ProvinceInstance& province : province_instances.get_items()) {
+		province.update_modifier_sum(today, static_modifier_cache);
+	}
+}
+
 void MapInstance::update_gamestate(Date today, DefineManager const& define_manager) {
 	for (ProvinceInstance& province : province_instances.get_items()) {
 		province.update_gamestate(today, define_manager);
diff --git a/src/openvic-simulation/map/MapInstance.hpp b/src/openvic-simulation/map/MapInstance.hpp
index 99c13d3..e7c623e 100644
--- a/src/openvic-simulation/map/MapInstance.hpp
+++ b/src/openvic-simulation/map/MapInstance.hpp
@@ -52,6 +52,7 @@ namespace OpenVic {
 			IssueManager const& issue_manager
 		);
 
+		void update_modifier_sums(Date today, StaticModifierCache const& static_modifier_cache);
 		void update_gamestate(Date today, DefineManager const& define_manager);
 		void tick(Date today);
 	};
diff --git a/src/openvic-simulation/map/ProvinceDefinition.cpp b/src/openvic-simulation/map/ProvinceDefinition.cpp
index 14828e8..60c8d6c 100644
--- a/src/openvic-simulation/map/ProvinceDefinition.cpp
+++ b/src/openvic-simulation/map/ProvinceDefinition.cpp
@@ -89,7 +89,7 @@ bool ProvinceDefinition::load_positions(
 					port = true;
 					port_adjacent_province = province;
 				} else {
-					/*  Expected provinces with invalid ports: 39, 296, 1047, 1406, 2044 */
+					/* Expected provinces with invalid ports: 39, 296, 1047, 1406, 2044 */
 					Logger::warning(
 						"Invalid port for province ", get_identifier(), ": facing province ", province,
 						" which has: water = ", province->is_water(), ", adjacent = ", is_adjacent_to(province)
diff --git a/src/openvic-simulation/map/ProvinceInstance.cpp b/src/openvic-simulation/map/ProvinceInstance.cpp
index 06b3f1e..236efd2 100644
--- a/src/openvic-simulation/map/ProvinceInstance.cpp
+++ b/src/openvic-simulation/map/ProvinceInstance.cpp
@@ -2,9 +2,13 @@
 
 #include "openvic-simulation/country/CountryInstance.hpp"
 #include "openvic-simulation/history/ProvinceHistory.hpp"
+#include "openvic-simulation/map/Crime.hpp"
 #include "openvic-simulation/map/ProvinceDefinition.hpp"
+#include "openvic-simulation/map/Region.hpp"
+#include "openvic-simulation/map/TerrainType.hpp"
 #include "openvic-simulation/military/UnitInstanceGroup.hpp"
 #include "openvic-simulation/misc/Define.hpp"
+#include "openvic-simulation/modifier/StaticModifierCache.hpp"
 #include "openvic-simulation/politics/Ideology.hpp"
 
 using namespace OpenVic;
@@ -21,6 +25,8 @@ ProvinceInstance::ProvinceInstance(
 	owner { nullptr },
 	controller { nullptr },
 	cores {},
+	modifier_sum {},
+	event_modifiers {},
 	slave { false },
 	crime { nullptr },
 	rgo { nullptr },
@@ -185,6 +191,126 @@ void ProvinceInstance::_update_pops(DefineManager const& define_manager) {
 	}
 }
 
+void ProvinceInstance::update_modifier_sum(Date today, StaticModifierCache const& static_modifier_cache) {
+	// Update sum of direct province modifiers
+	modifier_sum.clear();
+
+	const ModifierSum::modifier_source_t province_source { this };
+
+	// Erase expired event modifiers and add non-expired ones to the sum
+	std::erase_if(event_modifiers, [this, today, &province_source](ModifierInstance const& modifier) -> bool {
+		if (today <= modifier.get_expiry_date()) {
+			modifier_sum.add_modifier(*modifier.get_modifier(), province_source);
+			return false;
+		} else {
+			return true;
+		}
+	});
+
+	// Add static modifiers
+	if (is_owner_core()) {
+		modifier_sum.add_modifier_nullcheck(static_modifier_cache.get_core(), province_source);
+	}
+	if (province_definition.is_water()) {
+		modifier_sum.add_modifier_nullcheck(static_modifier_cache.get_sea_zone(), province_source);
+	} else {
+		modifier_sum.add_modifier_nullcheck(static_modifier_cache.get_land_province(), province_source);
+
+		if (province_definition.is_coastal()) {
+			modifier_sum.add_modifier_nullcheck(static_modifier_cache.get_coastal(), province_source);
+		} else {
+			modifier_sum.add_modifier_nullcheck(static_modifier_cache.get_non_coastal(), province_source);
+		}
+
+		// TODO - overseas, blockaded, no_adjacent_controlled, has_siege, occupied, nationalism, infrastructure
+	}
+
+	for (BuildingInstance const& building : buildings.get_items()) {
+		modifier_sum.add_modifier(building.get_building_type(), province_source);
+	}
+
+	modifier_sum.add_modifier_nullcheck(crime, province_source);
+
+	modifier_sum.add_modifier_nullcheck(province_definition.get_continent(), province_source);
+
+	modifier_sum.add_modifier_nullcheck(province_definition.get_climate(), province_source);
+
+	modifier_sum.add_modifier_nullcheck(terrain_type, province_source);
+
+	if constexpr (!ADD_OWNER_CONTRIBUTION) {
+		if (owner != nullptr) {
+			owner->contribute_province_modifier_sum(modifier_sum);
+		}
+	}
+}
+
+void ProvinceInstance::contribute_country_modifier_sum(ModifierSum const& owner_modifier_sum) {
+	modifier_sum.add_modifier_sum_exclude_source(owner_modifier_sum, this);
+}
+
+fixed_point_t ProvinceInstance::get_modifier_effect_value(ModifierEffect const& effect) const {
+	if constexpr (ADD_OWNER_CONTRIBUTION) {
+		return modifier_sum.get_effect(effect);
+	} else {
+		using enum ModifierEffect::target_t;
+
+		if (owner != nullptr) {
+			if (ModifierEffect::excludes_targets(effect.get_targets(), PROVINCE)) {
+				// Non-province targeted effects are already added to the country modifier sum
+				return owner->get_modifier_effect_value(effect);
+			} else {
+				// Province-targeted effects aren't passed to the country modifier sum
+				return owner->get_modifier_effect_value(effect) + modifier_sum.get_effect(effect);
+			}
+		} else {
+			return modifier_sum.get_effect(effect);
+		}
+	}
+}
+
+fixed_point_t ProvinceInstance::get_modifier_effect_value_nullcheck(ModifierEffect const* effect) const {
+	if (effect != nullptr) {
+		return get_modifier_effect_value(*effect);
+	} else {
+		return fixed_point_t::_0();
+	}
+}
+
+void ProvinceInstance::push_contributing_modifiers(
+	ModifierEffect const& effect, std::vector<ModifierSum::modifier_entry_t>& contributions
+) const {
+	if constexpr (ADD_OWNER_CONTRIBUTION) {
+		modifier_sum.push_contributing_modifiers(effect, contributions);
+	} else {
+		using enum ModifierEffect::target_t;
+
+		if (owner != nullptr) {
+			if (ModifierEffect::excludes_targets(effect.get_targets(), PROVINCE)) {
+				// Non-province targeted effects are already added to the country modifier sum
+				owner->push_contributing_modifiers(effect, contributions);
+			} else {
+				// Province-targeted effects aren't passed to the country modifier sum
+				modifier_sum.push_contributing_modifiers(effect, contributions);
+				owner->push_contributing_modifiers(effect, contributions);
+			}
+		} else {
+			modifier_sum.push_contributing_modifiers(effect, contributions);
+		}
+	}
+}
+
+std::vector<ModifierSum::modifier_entry_t> ProvinceInstance::get_contributing_modifiers(ModifierEffect const& effect) const {
+	if constexpr (ADD_OWNER_CONTRIBUTION) {
+		return modifier_sum.get_contributing_modifiers(effect);
+	} else {
+		std::vector<ModifierSum::modifier_entry_t> contributions;
+
+		push_contributing_modifiers(effect, contributions);
+
+		return contributions;
+	}
+}
+
 void ProvinceInstance::update_gamestate(Date today, DefineManager const& define_manager) {
 	for (BuildingInstance& building : buildings.get_items()) {
 		building.update_gamestate(today);
diff --git a/src/openvic-simulation/map/ProvinceInstance.hpp b/src/openvic-simulation/map/ProvinceInstance.hpp
index fa0be98..e7c0326 100644
--- a/src/openvic-simulation/map/ProvinceInstance.hpp
+++ b/src/openvic-simulation/map/ProvinceInstance.hpp
@@ -5,6 +5,7 @@
 #include "openvic-simulation/economy/BuildingInstance.hpp"
 #include "openvic-simulation/military/UnitInstance.hpp"
 #include "openvic-simulation/military/UnitType.hpp"
+#include "openvic-simulation/modifier/ModifierSum.hpp"
 #include "openvic-simulation/pop/Pop.hpp"
 #include "openvic-simulation/types/fixed_point/FixedPointMap.hpp"
 #include "openvic-simulation/types/HasIdentifier.hpp"
@@ -21,6 +22,7 @@ namespace OpenVic {
 	struct Ideology;
 	struct Culture;
 	struct Religion;
+	struct StaticModifierCache;
 	struct BuildingTypeManager;
 	struct ProvinceHistoryEntry;
 	struct IssueManager;
@@ -68,6 +70,15 @@ namespace OpenVic {
 		CountryInstance* PROPERTY(controller);
 		ordered_set<CountryInstance*> PROPERTY(cores);
 
+	public:
+		static constexpr bool ADD_OWNER_CONTRIBUTION = true;
+
+	private:
+		// The total/resultant modifier affecting this province, including owner country contributions if
+		// ADD_OWNER_CONTRIBUTION is true.
+		ModifierSum PROPERTY(modifier_sum);
+		std::vector<ModifierInstance> PROPERTY(event_modifiers);
+
 		bool PROPERTY(slave);
 		Crime const* PROPERTY_RW(crime);
 		// TODO - change this into a factory-like structure
@@ -124,6 +135,15 @@ namespace OpenVic {
 		bool add_pop_vec(std::vector<PopBase> const& pop_vec);
 		size_t get_pop_count() const;
 
+		void update_modifier_sum(Date today, StaticModifierCache const& static_modifier_cache);
+		void contribute_country_modifier_sum(ModifierSum const& owner_modifier_sum);
+		fixed_point_t get_modifier_effect_value(ModifierEffect const& effect) const;
+		fixed_point_t get_modifier_effect_value_nullcheck(ModifierEffect const* effect) const;
+		void push_contributing_modifiers(
+			ModifierEffect const& effect, std::vector<ModifierSum::modifier_entry_t>& contributions
+		) const;
+		std::vector<ModifierSum::modifier_entry_t> get_contributing_modifiers(ModifierEffect const& effect) const;
+
 		void update_gamestate(Date today, DefineManager const& define_manager);
 		void tick(Date today);
 
diff --git a/src/openvic-simulation/map/TerrainType.cpp b/src/openvic-simulation/map/TerrainType.cpp
index b4cc430..1531507 100644
--- a/src/openvic-simulation/map/TerrainType.cpp
+++ b/src/openvic-simulation/map/TerrainType.cpp
@@ -1,5 +1,6 @@
 #include "TerrainType.hpp"
 
+#include "openvic-simulation/modifier/ModifierManager.hpp"
 #include "openvic-simulation/types/Colour.hpp"
 
 using namespace OpenVic;
@@ -71,14 +72,21 @@ node_callback_t TerrainTypeManager::_load_terrain_type_categories(ModifierManage
 	return [this, &modifier_manager](ast::NodeCPtr root) -> bool {
 		const bool ret = expect_dictionary_reserve_length(terrain_types,
 			[this, &modifier_manager](std::string_view type_key, ast::NodeCPtr type_node) -> bool {
+				using enum Modifier::modifier_type_t;
+
 				ModifierValue values;
 				colour_t colour = colour_t::null();
 				bool is_water = false;
-				bool ret = modifier_manager.expect_modifier_value_and_keys(move_variable_callback(values),
+
+				bool ret = modifier_manager.expect_modifier_value_and_keys(
+					move_variable_callback(values),
+					TERRAIN,
 					"color", ONE_EXACTLY, expect_colour(assign_variable_callback(colour)),
 					"is_water", ZERO_OR_ONE, expect_bool(assign_variable_callback(is_water))
 				)(type_node);
+
 				ret &= add_terrain_type(type_key, colour, std::move(values), is_water);
+
 				return ret;
 			}
 		)(root);