Format cleanup and req comments

15 files changed, 70 insertions, 54 deletions

diff --git a/src/headless/main.cpp b/src/headless/main.cpp
index 02eeb48..3ae08f0 100644
--- a/src/headless/main.cpp
+++ b/src/headless/main.cpp
@@ -52,7 +52,8 @@ int main(int argc, char const* argv[]) {
 		// TODO - non-Windows default paths
 		static const fs::path default_path = "C:/Program Files (x86)/Steam/steamapps/common/Victoria 2";
 
-		std::cout << "Usage: " << get_program_name(argc > 0 ? argv[0] : nullptr) << " <base defines dir> [[mod defines dir]+]\n"
+		std::cout
+			<< "Usage: " << get_program_name(argc > 0 ? argv[0] : nullptr) << " <base defines dir> [[mod defines dir]+]\n"
 			<< "Requires defines path(s) as arguments, starting with the base defines and continuing with mods.\n"
 			<< "(Paths with spaces need to be enclosed in \"quotes\").\n"
 			<< "Defaulting to " << default_path << std::endl;
diff --git a/src/openvic-simulation/dataloader/Dataloader.cpp b/src/openvic-simulation/dataloader/Dataloader.cpp
index 25641e2..82957fc 100644
--- a/src/openvic-simulation/dataloader/Dataloader.cpp
+++ b/src/openvic-simulation/dataloader/Dataloader.cpp
@@ -1,12 +1,12 @@
 #include "Dataloader.hpp"
 
-#include "openvic-simulation/GameManager.hpp"
-#include "openvic-simulation/utility/Logger.hpp"
-
 #include <openvic-dataloader/csv/Parser.hpp>
 #include <openvic-dataloader/detail/CallbackOStream.hpp>
 #include <openvic-dataloader/v2script/Parser.hpp>
 
+#include "openvic-simulation/GameManager.hpp"
+#include "openvic-simulation/utility/Logger.hpp"
+
 using namespace OpenVic;
 using namespace OpenVic::NodeTools;
 using namespace ovdl;
@@ -51,8 +51,7 @@ fs::path Dataloader::lookup_file(fs::path const& path) const {
 
 const fs::path Dataloader::TXT = ".txt";
 
-static bool contains_file_with_name(Dataloader::path_vector_t const& paths,
-	fs::path const& name) {
+static bool contains_file_with_name(Dataloader::path_vector_t const& paths, fs::path const& name) {
 
 	for (fs::path const& path : paths) {
 		if (path.filename() == name) return true;
@@ -60,8 +59,7 @@ static bool contains_file_with_name(Dataloader::path_vector_t const& paths,
 	return false;
 }
 
-Dataloader::path_vector_t Dataloader::lookup_files_in_dir(fs::path const& path,
-	fs::path const* extension) const {
+Dataloader::path_vector_t Dataloader::lookup_files_in_dir(fs::path const& path, fs::path const* extension) const {
 
 	path_vector_t ret;
 	for (fs::path const& root : roots) {
@@ -81,9 +79,7 @@ Dataloader::path_vector_t Dataloader::lookup_files_in_dir(fs::path const& path,
 	return ret;
 }
 
-bool Dataloader::apply_to_files_in_dir(fs::path const& path,
-	std::function<bool(fs::path const&)> callback,
-	fs::path const* extension) const {
+bool Dataloader::apply_to_files_in_dir(fs::path const& path, std::function<bool(fs::path const&)> callback, fs::path const* extension) const {
 
 	bool ret = true;
 	for (fs::path const& file : lookup_files_in_dir(path, extension)) {
@@ -92,7 +88,7 @@ bool Dataloader::apply_to_files_in_dir(fs::path const& path,
 	return ret;
 }
 
-template<std::derived_from<detail::BasicParser> Parser, bool(Parser::*parse_func)()>
+template<std::derived_from<detail::BasicParser> Parser, bool (Parser::*parse_func)()>
 static Parser _run_ovdl_parser(fs::path const& path) {
 	Parser parser;
 	std::string buffer;
@@ -105,7 +101,8 @@ static Parser _run_ovdl_parser(fs::path const& path) {
 				Logger::error("Invalid input to parser error log callback: ", s, " / ", n, " / ", user_data);
 				return 0;
 			}
-		}, &buffer
+		},
+		&buffer
 	};
 	parser.set_error_log_to(error_log_stream);
 	parser.load_from_file(path);
@@ -181,25 +178,26 @@ bool Dataloader::_load_map_dir(Map& map, fs::path const& map_directory) const {
 
 	bool ret = expect_dictionary_keys(
 		"max_provinces", ONE_EXACTLY,
-			expect_uint(
-				[&map](uint64_t val) -> bool {
-					if (Province::NULL_INDEX < val && val <= Province::MAX_INDEX) {
-						return map.set_max_provinces(val);
-					}
-					Logger::error("Invalid max province count ", val, " (out of valid range ", Province::NULL_INDEX, " < max_provinces <= ", Province::MAX_INDEX, ")");
-					return false;
+		expect_uint(
+			[&map](uint64_t val) -> bool {
+				if (Province::NULL_INDEX < val && val <= Province::MAX_INDEX) {
+					return map.set_max_provinces(val);
 				}
-			),
+				Logger::error("Invalid max province count ", val, " (out of valid range ",
+					Province::NULL_INDEX, " < max_provinces <= ", Province::MAX_INDEX, ")");
+				return false;
+			}
+		),
 		"sea_starts", ONE_EXACTLY,
-			expect_list_reserve_length(
-				water_province_identifiers,
-				expect_identifier(
-					[&water_province_identifiers](std::string_view identifier) -> bool {
-						water_province_identifiers.push_back(identifier);
-						return true;
-					}
-				)
-			),
+		expect_list_reserve_length(
+			water_province_identifiers,
+			expect_identifier(
+				[&water_province_identifiers](std::string_view identifier) -> bool {
+					water_province_identifiers.push_back(identifier);
+					return true;
+				}
+			)
+		),
 
 #define MAP_PATH_DICT_ENTRY(X) \
 		#X, ONE_EXACTLY, expect_string(assign_variable_callback(X)),
diff --git a/src/openvic-simulation/dataloader/Dataloader.hpp b/src/openvic-simulation/dataloader/Dataloader.hpp
index 20538a6..efada89 100644
--- a/src/openvic-simulation/dataloader/Dataloader.hpp
+++ b/src/openvic-simulation/dataloader/Dataloader.hpp
@@ -14,6 +14,7 @@ namespace OpenVic {
 	class Dataloader {
 	public:
 		using path_vector_t = std::vector<fs::path>;
+
 	private:
 		path_vector_t roots;
 
@@ -28,10 +29,8 @@ namespace OpenVic {
 
 		fs::path lookup_file(fs::path const& path) const;
 		static const fs::path TXT;
-		path_vector_t lookup_files_in_dir(fs::path const& path,
-			fs::path const* extension = &TXT) const;
-		bool apply_to_files_in_dir(fs::path const& path,
-			std::function<bool(fs::path const&)> callback,
+		path_vector_t lookup_files_in_dir(fs::path const& path, fs::path const* extension = &TXT) const;
+		bool apply_to_files_in_dir(fs::path const& path, std::function<bool(fs::path const&)> callback,
 			fs::path const* extension = &TXT) const;
 
 		bool load_defines(GameManager& game_manager) const;
diff --git a/src/openvic-simulation/dataloader/NodeTools.cpp b/src/openvic-simulation/dataloader/NodeTools.cpp
index 3b05d04..63a97ad 100644
--- a/src/openvic-simulation/dataloader/NodeTools.cpp
+++ b/src/openvic-simulation/dataloader/NodeTools.cpp
@@ -1,7 +1,5 @@
 #include "NodeTools.hpp"
 
-#include <charconv>
-
 using namespace OpenVic;
 using namespace OpenVic::NodeTools;
 
diff --git a/src/openvic-simulation/dataloader/NodeTools.hpp b/src/openvic-simulation/dataloader/NodeTools.hpp
index 805de94..a68e922 100644
--- a/src/openvic-simulation/dataloader/NodeTools.hpp
+++ b/src/openvic-simulation/dataloader/NodeTools.hpp
@@ -2,12 +2,12 @@
 
 #include <map>
 
+#include <openvic-dataloader/v2script/AbstractSyntaxTree.hpp>
+
 #include "openvic-simulation/types/Colour.hpp"
 #include "openvic-simulation/types/Date.hpp"
 #include "openvic-simulation/types/fixed_point/FixedPoint.hpp"
 
-#include <openvic-dataloader/v2script/AbstractSyntaxTree.hpp>
-
 namespace OpenVic {
 	namespace ast = ovdl::v2script::ast;
 
@@ -56,7 +56,7 @@ namespace OpenVic {
 			size_t count;
 
 			dictionary_entry_t(expected_count_t new_expected_count, node_callback_t new_callback)
-			: expected_count { new_expected_count }, callback { new_callback }, count { 0 } {}
+				: expected_count { new_expected_count }, callback { new_callback }, count { 0 } {}
 
 			constexpr bool must_appear() const {
 				return static_cast<uint8_t>(expected_count) & static_cast<uint8_t>(expected_count_t::_MUST_APPEAR);
@@ -106,7 +106,7 @@ namespace OpenVic {
 		template<typename T>
 		concept Reservable = requires(T& t) {
 			{ t.size() } -> std::same_as<size_t>;
-			t.reserve( size_t {} );
+			t.reserve(size_t {});
 		};
 		template<Reservable T>
 		node_callback_t expect_list_reserve_length(T& t, node_callback_t callback) {
diff --git a/src/openvic-simulation/economy/Good.hpp b/src/openvic-simulation/economy/Good.hpp
index d5cd532..ce97cad 100644
--- a/src/openvic-simulation/economy/Good.hpp
+++ b/src/openvic-simulation/economy/Good.hpp
@@ -1,7 +1,7 @@
 #pragma once
 
-#include "openvic-simulation/types/IdentifierRegistry.hpp"
 #include "openvic-simulation/dataloader/NodeTools.hpp"
+#include "openvic-simulation/types/IdentifierRegistry.hpp"
 
 namespace OpenVic {
 	struct GoodManager;
diff --git a/src/openvic-simulation/map/Map.cpp b/src/openvic-simulation/map/Map.cpp
index 8f10410..728fc42 100644
--- a/src/openvic-simulation/map/Map.cpp
+++ b/src/openvic-simulation/map/Map.cpp
@@ -490,11 +490,9 @@ bool Map::load_province_definitions(std::vector<LineObject> const& lines) {
 			const std::string_view identifier = line.get_value_for(0);
 			if (!identifier.empty()) {
 				colour_t colour;
-				if (!parse_province_colour(colour, {
-					line.get_value_for(1),
-					line.get_value_for(2),
-					line.get_value_for(3)
-				})) {
+				if (!parse_province_colour(colour,
+					{ line.get_value_for(1), line.get_value_for(2), line.get_value_for(3) }
+				)) {
 					Logger::error("Error reading colour in province definition: ", line);
 					ret = false;
 				}
diff --git a/src/openvic-simulation/map/Province.cpp b/src/openvic-simulation/map/Province.cpp
index 8d4abcb..f53de3a 100644
--- a/src/openvic-simulation/map/Province.cpp
+++ b/src/openvic-simulation/map/Province.cpp
@@ -102,7 +102,7 @@ distribution_t const& Province::get_religion_distribution() const {
 }
 
 /* REQUIREMENTS:
- * MAP-65
+ * MAP-65, MAP-68, MAP-70, MAP-234
  */
 void Province::update_pops() {
 	total_population = 0;
diff --git a/src/openvic-simulation/map/Province.hpp b/src/openvic-simulation/map/Province.hpp
index 682fc16..67816ff 100644
--- a/src/openvic-simulation/map/Province.hpp
+++ b/src/openvic-simulation/map/Province.hpp
@@ -10,6 +10,7 @@ namespace OpenVic {
 
 	/* REQUIREMENTS:
 	 * MAP-5, MAP-7, MAP-8, MAP-43, MAP-47
+	 * POP-22
 	 */
 	struct Province : HasIdentifierAndColour {
 		friend struct Map;
diff --git a/src/openvic-simulation/pop/Culture.cpp b/src/openvic-simulation/pop/Culture.cpp
index 7b595fb..709f305 100644
--- a/src/openvic-simulation/pop/Culture.cpp
+++ b/src/openvic-simulation/pop/Culture.cpp
@@ -13,7 +13,6 @@ CultureGroup::CultureGroup(const std::string_view new_identifier, const std::str
 	  unit_graphical_culture_type { new_unit_graphical_culture_type },
 	  is_overseas { new_is_overseas } {}
 
-
 std::string const& CultureGroup::get_leader() const {
 	return leader;
 }
@@ -161,6 +160,26 @@ bool CultureManager::_load_culture(CultureGroup const* culture_group,
 	return ret;
 }
 
+/* REQUIREMENTS:
+ * POP-59,  POP-60,  POP-61,  POP-62,  POP-63,  POP-64,  POP-65,  POP-66,  POP-67,  POP-68,  POP-69,  POP-70,  POP-71,
+ * POP-72,  POP-73,  POP-74,  POP-75,  POP-76,  POP-77,  POP-78,  POP-79,  POP-80,  POP-81,  POP-82,  POP-83,  POP-84,
+ * POP-85,  POP-86,  POP-87,  POP-88,  POP-89,  POP-90,  POP-91,  POP-92,  POP-93,  POP-94,  POP-95,  POP-96,  POP-97,
+ * POP-98,  POP-99,  POP-100, POP-101, POP-102, POP-103, POP-104, POP-105, POP-106, POP-107, POP-108, POP-109, POP-110,
+ * POP-111, POP-112, POP-113, POP-114, POP-115, POP-116, POP-117, POP-118, POP-119, POP-120, POP-121, POP-122, POP-123,
+ * POP-124, POP-125, POP-126, POP-127, POP-128, POP-129, POP-130, POP-131, POP-132, POP-133, POP-134, POP-135, POP-136,
+ * POP-137, POP-138, POP-139, POP-140, POP-141, POP-142, POP-143, POP-144, POP-145, POP-146, POP-147, POP-148, POP-149,
+ * POP-150, POP-151, POP-152, POP-153, POP-154, POP-155, POP-156, POP-157, POP-158, POP-159, POP-160, POP-161, POP-162,
+ * POP-163, POP-164, POP-165, POP-166, POP-167, POP-168, POP-169, POP-170, POP-171, POP-172, POP-173, POP-174, POP-175,
+ * POP-176, POP-177, POP-178, POP-179, POP-180, POP-181, POP-182, POP-183, POP-184, POP-185, POP-186, POP-187, POP-188,
+ * POP-189, POP-190, POP-191, POP-192, POP-193, POP-194, POP-195, POP-196, POP-197, POP-198, POP-199, POP-200, POP-201,
+ * POP-202, POP-203, POP-204, POP-205, POP-206, POP-207, POP-208, POP-209, POP-210, POP-211, POP-212, POP-213, POP-214,
+ * POP-215, POP-216, POP-217, POP-218, POP-219, POP-220, POP-221, POP-222, POP-223, POP-224, POP-225, POP-226, POP-227,
+ * POP-228, POP-229, POP-230, POP-231, POP-232, POP-233, POP-234, POP-235, POP-236, POP-237, POP-238, POP-239, POP-240,
+ * POP-241, POP-242, POP-243, POP-244, POP-245, POP-246, POP-247, POP-248, POP-249, POP-250, POP-251, POP-252, POP-253,
+ * POP-254, POP-255, POP-256, POP-257, POP-258, POP-259, POP-260, POP-261, POP-262, POP-263, POP-264, POP-265, POP-266,
+ * POP-267, POP-268, POP-269, POP-270, POP-271, POP-272, POP-273, POP-274, POP-275, POP-276, POP-277, POP-278, POP-279,
+ * POP-280, POP-281, POP-282, POP-283, POP-284
+ */
 bool CultureManager::load_culture_file(ast::NodeCPtr root) {
 	if (!graphical_culture_types.is_locked()) {
 		Logger::error("Cannot load culture groups until graphical culture types are locked!");
diff --git a/src/openvic-simulation/pop/Pop.hpp b/src/openvic-simulation/pop/Pop.hpp
index d01eb97..e70bc0b 100644
--- a/src/openvic-simulation/pop/Pop.hpp
+++ b/src/openvic-simulation/pop/Pop.hpp
@@ -41,7 +41,7 @@ namespace OpenVic {
 	};
 
 	/* REQUIREMENTS:
-	 * POP-26
+	 * POP-15, POP-16, POP-17, POP-26
 	 */
 	struct PopType : HasIdentifierAndColour {
 		friend struct PopManager;
diff --git a/src/openvic-simulation/pop/Religion.cpp b/src/openvic-simulation/pop/Religion.cpp
index b336ae1..0652eb2 100644
--- a/src/openvic-simulation/pop/Religion.cpp
+++ b/src/openvic-simulation/pop/Religion.cpp
@@ -64,8 +64,11 @@ bool ReligionManager::add_religion(const std::string_view identifier, colour_t c
 	return religions.add_item({ identifier, colour, *group, icon, pagan });
 }
 
+/* REQUIREMENTS:
+ * POP-286, POP-287, POP-288, POP-289, POP-290, POP-291, POP-292,
+ * POP-293, POP-294, POP-295, POP-296, POP-297, POP-298, POP-299
+ */
 bool ReligionManager::load_religion_file(ast::NodeCPtr root) {
-
 	size_t total_expected_religions = 0;
 	bool ret = expect_dictionary_reserve_length(
 		religion_groups,
@@ -85,7 +88,6 @@ bool ReligionManager::load_religion_file(ast::NodeCPtr root) {
 	religions.reserve(religions.size() + total_expected_religions);
 	ret &= expect_dictionary(
 		[this](std::string_view religion_group_key, ast::NodeCPtr religion_group_value) -> bool {
-
 			ReligionGroup const* religion_group = get_religion_group_by_identifier(religion_group_key);
 
 			return expect_dictionary(
diff --git a/src/openvic-simulation/pop/Religion.hpp b/src/openvic-simulation/pop/Religion.hpp
index bd65321..8267659 100644
--- a/src/openvic-simulation/pop/Religion.hpp
+++ b/src/openvic-simulation/pop/Religion.hpp
@@ -1,7 +1,7 @@
 #pragma once
 
-#include "openvic-simulation/types/IdentifierRegistry.hpp"
 #include "openvic-simulation/dataloader/NodeTools.hpp"
+#include "openvic-simulation/types/IdentifierRegistry.hpp"
 
 namespace OpenVic {
 
diff --git a/src/openvic-simulation/types/fixed_point/FixedPointLUT.hpp b/src/openvic-simulation/types/fixed_point/FixedPointLUT.hpp
index 466517b..45cb639 100644
--- a/src/openvic-simulation/types/fixed_point/FixedPointLUT.hpp
+++ b/src/openvic-simulation/types/fixed_point/FixedPointLUT.hpp
@@ -9,7 +9,7 @@
 
 namespace OpenVic::FPLUT {
 
-	#include "FixedPointLUT_sin.hpp"
+#include "FixedPointLUT_sin.hpp"
 
 	constexpr int32_t SHIFT = SIN_LUT_PRECISION - SIN_LUT_COUNT_LOG2;
 
diff --git a/src/openvic-simulation/utility/StringUtils.hpp b/src/openvic-simulation/utility/StringUtils.hpp
index 5d6001c..97efbed 100644
--- a/src/openvic-simulation/utility/StringUtils.hpp
+++ b/src/openvic-simulation/utility/StringUtils.hpp
@@ -26,7 +26,7 @@ namespace OpenVic::StringUtils {
 			if (*str == '0') {
 				if (str + 1 != end && (str[1] == 'x' || str[1] == 'X')) {
 					base = 16; // Hexadecimal.
-					str += 2; // Skip '0x' or '0X'
+					str += 2;  // Skip '0x' or '0X'
 					if (str == end) return 0;
 				} else {
 					base = 8; // Octal.