Code review: Add named constants for deserialization code for better readibility

Author: ottml

libs/s25main/AddonHelperFunctions.h

@@ -14,3 +14,18 @@ class GlobalGameSettings;
 std::function<bool(const BuildingType type)> makeIsUnusedBuilding(const GlobalGameSettings& ggs);
 std::function<bool(const GoodType type)> makeIsUnusedWare(const GlobalGameSettings& ggs);
 std::function<bool(const Job job)> makeIsUnusedJob(const GlobalGameSettings& ggs);
+
+// Only used for deserialization, can be removed when breaking compatibility (GetGameDataVersion)
+constexpr int leatherAddonBuildings = 3;
+constexpr int wineAddonBuildings = 3;
+constexpr int wineAndLeatherAddonBuildings = wineAddonBuildings + leatherAddonBuildings;
+
+constexpr int leatherAddonGoods = 3;
+constexpr int wineAddonGoods = 2;
+constexpr int wineAndLeatherAddonGoods = wineAddonGoods + leatherAddonGoods;
+
+constexpr int leatherAddonJobs = 3;
+constexpr int wineAddonJobs = 3;
+constexpr int wineAndLeatherAddonJobs = wineAddonJobs + leatherAddonJobs;
+
+constexpr uint8_t transportPrioOfLeatherworks = 7;

libs/s25main/GameCommands.cpp

@@ -3,6 +3,7 @@
 // SPDX-License-Identifier: GPL-2.0-or-later
 
 #include "GameCommands.h"
+#include "AddonHelperFunctions.h"
 #include "GamePlayer.h"
 #include "LeatherLoader.h"
 #include "WineLoader.h"
@@ -148,7 +149,8 @@ ChangeBuildOrder::ChangeBuildOrder(Deserializer& ser)
             i = helpers::popEnum<BuildingType>(ser);
     } else
     {
-        auto countOfNotAvailableBuildingsInSaveGame = ser.getDataVersion() < 1 ? 6 : 3;
+        auto countOfNotAvailableBuildingsInSaveGame =
+          ser.getDataVersion() < 1 ? wineAndLeatherAddonBuildings : leatherAddonBuildings;
         std::vector<BuildingType> buildOrder(data.size() - countOfNotAvailableBuildingsInSaveGame);
 
         if(ser.getDataVersion() < 1)
@@ -192,10 +194,10 @@ ChangeTransport::ChangeTransport(Deserializer& ser) : GameCommand(GCType::Change
 
         helpers::popContainer(ser, tmpData, true);
         std::copy(tmpData.begin(), tmpData.end(), data.begin());
-        // all transport prios greater equal 7 are increased by one because the new leatherwork
-        // uses prio 7
+        // all transport prios greater equal transportPrioOfLeatherworks are increased by one because the new
+        // leatherwork uses prio transportPrioOfLeatherworks
         std::transform(data.begin(), data.end() - leatherAddonAdditionalTransportOrders, data.begin(),
-                       [](uint8_t& prio) { return prio < 7 ? prio : prio + 1; });
+                       [](uint8_t& prio) { return prio < transportPrioOfLeatherworks ? prio : prio + 1; });
         data[std::tuple_size<TransportOrders>::value - leatherAddonAdditionalTransportOrders] =
           STD_TRANSPORT_PRIO[GoodType::Leather];
     }

libs/s25main/GamePlayer.cpp

@@ -3,6 +3,7 @@
 // SPDX-License-Identifier: GPL-2.0-or-later
 
 #include "GamePlayer.h"
+#include "AddonHelperFunctions.h"
 #include "Cheats.h"
 #include "EventManager.h"
 #include "FindWhConditions.h"
@@ -299,7 +300,8 @@ void GamePlayer::Deserialize(SerializedGameData& sgd)
 
     if(sgd.GetGameDataVersion() < 12)
     {
-        auto countOfNotAvailableBuildingsInSaveGame = sgd.GetGameDataVersion() < 11 ? 6 : 3;
+        auto countOfNotAvailableBuildingsInSaveGame =
+          sgd.GetGameDataVersion() < 11 ? wineAndLeatherAddonBuildings : leatherAddonBuildings;
         std::vector<BuildingType> build_order_raw(build_order.size() - countOfNotAvailableBuildingsInSaveGame);
         helpers::popContainer(sgd, build_order_raw, true);
 
@@ -313,12 +315,14 @@ void GamePlayer::Deserialize(SerializedGameData& sgd)
 
         std::copy(build_order_raw.begin(), build_order_raw.end(), build_order.begin());
 
-        auto countOfNotAvailableGoodsInSaveGame = sgd.GetGameDataVersion() < 11 ? 5 : 3;
+        auto countOfNotAvailableGoodsInSaveGame =
+          sgd.GetGameDataVersion() < 11 ? wineAndLeatherAddonGoods : leatherAddonGoods;
         std::vector<uint8_t> transportPrio_raw(transportPrio.size() - countOfNotAvailableGoodsInSaveGame);
         helpers::popContainer(sgd, transportPrio_raw, true);
         std::copy(transportPrio_raw.begin(), transportPrio_raw.end(), transportPrio.begin());
         std::transform(transportPrio.begin(), transportPrio.end() - countOfNotAvailableGoodsInSaveGame,
-                       transportPrio.begin(), [](uint8_t& prio) { return prio < 7 ? prio : prio + 1; });
+                       transportPrio.begin(),
+                       [](uint8_t& prio) { return prio < transportPrioOfLeatherworks ? prio : prio + 1; });
     } else
     {
         helpers::popContainer(sgd, build_order);
@@ -334,13 +338,15 @@ void GamePlayer::Deserialize(SerializedGameData& sgd)
 
     if(sgd.GetGameDataVersion() < 12)
     {
-        auto countOfNotAvailableGoodsInSaveGame = sgd.GetGameDataVersion() < 11 ? 5 : 3;
+        auto countOfNotAvailableGoodsInSaveGame =
+          sgd.GetGameDataVersion() < 11 ? wineAndLeatherAddonGoods : leatherAddonGoods;
         std::vector<unsigned int> global_inventory_good_raw(global_inventory.goods.size()
                                                             - countOfNotAvailableGoodsInSaveGame);
         helpers::popContainer(sgd, global_inventory_good_raw, true);
         std::copy(global_inventory_good_raw.begin(), global_inventory_good_raw.end(), global_inventory.goods.begin());
 
-        auto countOfNotAvailableJobsInSaveGame = sgd.GetGameDataVersion() < 11 ? 6 : 3;
+        auto countOfNotAvailableJobsInSaveGame =
+          sgd.GetGameDataVersion() < 11 ? wineAndLeatherAddonJobs : leatherAddonJobs;
         std::vector<unsigned int> global_inventory_people_raw(global_inventory.people.size()
                                                               - countOfNotAvailableJobsInSaveGame);
         helpers::popContainer(sgd, global_inventory_people_raw, true);