Refactor unapplied change counter

Author: Ortham

CMakeLists.txt

@@ -409,6 +409,7 @@ set(LOOT_SRC_GUI_H_FILES
     "${CMAKE_SOURCE_DIR}/src/gui/query/types/get_overlapping_plugins_query.h"
     "${CMAKE_SOURCE_DIR}/src/gui/query/types/get_game_data_query.h"
     "${CMAKE_SOURCE_DIR}/src/gui/query/types/sort_plugins_query.h"
+    "${CMAKE_SOURCE_DIR}/src/gui/state/change_count.h"
     "${CMAKE_SOURCE_DIR}/src/gui/state/game/detection/common.h"
     "${CMAKE_SOURCE_DIR}/src/gui/state/game/detection/detail.h"
     "${CMAKE_SOURCE_DIR}/src/gui/state/game/detection/epic_games_store.h"
@@ -430,7 +431,6 @@ set(LOOT_SRC_GUI_H_FILES
     "${CMAKE_SOURCE_DIR}/src/gui/state/loot_paths.h"
     "${CMAKE_SOURCE_DIR}/src/gui/state/loot_settings.h"
     "${CMAKE_SOURCE_DIR}/src/gui/state/loot_state.h"
-    "${CMAKE_SOURCE_DIR}/src/gui/state/unapplied_change_counter.h"
     "${CMAKE_SOURCE_DIR}/src/gui/resource.h"
     "${CMAKE_SOURCE_DIR}/src/gui/version.h")
 

cmake/tests.cmake

@@ -29,6 +29,7 @@ set(LOOT_SRC_TESTS_GUI_CPP_FILES
 "${CMAKE_SOURCE_DIR}/src/tests/gui/qt/tasks/non_blocking_test_task.cpp")
 
 set(LOOT_SRC_TESTS_GUI_H_FILES
+"${CMAKE_SOURCE_DIR}/src/tests/gui/state/change_count_test.h"
 "${CMAKE_SOURCE_DIR}/src/tests/gui/state/game/detection/common_test.h"
 "${CMAKE_SOURCE_DIR}/src/tests/gui/state/game/detection/detail_test.h"
 "${CMAKE_SOURCE_DIR}/src/tests/gui/state/game/detection/epic_games_store_test.h"
@@ -46,7 +47,6 @@ set(LOOT_SRC_TESTS_GUI_H_FILES
 "${CMAKE_SOURCE_DIR}/src/tests/gui/state/game/helpers_test.h"
 "${CMAKE_SOURCE_DIR}/src/tests/gui/state/loot_paths_test.h"
 "${CMAKE_SOURCE_DIR}/src/tests/gui/state/loot_settings_test.h"
-"${CMAKE_SOURCE_DIR}/src/tests/gui/state/unapplied_change_counter_test.h"
 "${CMAKE_SOURCE_DIR}/src/tests/gui/qt/helpers_test.h"
 "${CMAKE_SOURCE_DIR}/src/tests/gui/qt/tasks/non_blocking_test_task.h"
 "${CMAKE_SOURCE_DIR}/src/tests/gui/qt/tasks/tasks_test.h"
@@ -100,6 +100,7 @@ set(LOOT_GUI_TESTS_ALL_SOURCES
     "${CMAKE_SOURCE_DIR}/src/gui/sourced_message.h"
     "${CMAKE_SOURCE_DIR}/src/gui/qt/helpers.h"
     "${CMAKE_SOURCE_DIR}/src/gui/qt/tasks/tasks.h"
+    "${CMAKE_SOURCE_DIR}/src/gui/state/change_count.h"
     "${CMAKE_SOURCE_DIR}/src/gui/state/game/detection/common.h"
     "${CMAKE_SOURCE_DIR}/src/gui/state/game/detection/detail.h"
     "${CMAKE_SOURCE_DIR}/src/gui/state/game/detection/epic_games_store.h"
@@ -120,8 +121,7 @@ set(LOOT_GUI_TESTS_ALL_SOURCES
     "${CMAKE_SOURCE_DIR}/src/gui/state/game/validation.h"
     "${CMAKE_SOURCE_DIR}/src/gui/state/loot_paths.h"
     "${CMAKE_SOURCE_DIR}/src/gui/state/loot_settings.h"
-    "${CMAKE_SOURCE_DIR}/src/gui/state/loot_state.h"
-    "${CMAKE_SOURCE_DIR}/src/gui/state/unapplied_change_counter.h")
+    "${CMAKE_SOURCE_DIR}/src/gui/state/loot_state.h")
 
 ##############################
 # Define Targets

resources/l10n/template.pot

@@ -8,7 +8,7 @@ msgid ""
 msgstr ""
 "Project-Id-Version: LOOT 0.25.2\n"
 "Report-Msgid-Bugs-To: https://github.com/loot/loot/issues\n"
-"POT-Creation-Date: 2025-04-03 20:52+0100\n"
+"POT-Creation-Date: 2025-04-03 21:42+0100\n"
 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
 "Language-Team: LANGUAGE <[email protected]>\n"
@@ -431,7 +431,7 @@ msgid "F&ilters"
 msgstr ""
 
 #: src/gui/qt/main_window.cpp:1075 src/gui/qt/main_window.cpp:1528
-#: src/gui/qt/main_window.cpp:2152
+#: src/gui/qt/main_window.cpp:2154
 msgid "Updating and parsing masterlist…"
 msgstr ""
 
@@ -632,41 +632,41 @@ msgstr ""
 msgid "About LOOT"
 msgstr ""
 
-#: src/gui/qt/main_window.cpp:2362
+#: src/gui/qt/main_window.cpp:2364
 msgid "Identifying overlapping plugins…"
 msgstr ""
 
-#: src/gui/qt/main_window.cpp:2510
+#: src/gui/qt/main_window.cpp:2512
 msgid ""
 "Auto-sort has been cancelled as there is at least one error message "
 "displayed."
 msgstr ""
 
-#: src/gui/qt/main_window.cpp:2569
+#: src/gui/qt/main_window.cpp:2571
 msgid "No masterlist update was necessary."
 msgstr ""
 
-#: src/gui/qt/main_window.cpp:2589
+#: src/gui/qt/main_window.cpp:2591
 #, c++-format
 msgid "Masterlist updated to revision {0}."
 msgstr ""
 
-#: src/gui/qt/main_window.cpp:2653
+#: src/gui/qt/main_window.cpp:2655
 msgid "No masterlist updates were necessary."
 msgstr ""
 
-#: src/gui/qt/main_window.cpp:2676
+#: src/gui/qt/main_window.cpp:2678
 msgid ""
 "Masterlists updated for the following games:\n"
 "\n"
 msgstr ""
 
-#: src/gui/qt/main_window.cpp:2738
+#: src/gui/qt/main_window.cpp:2740
 #, c++-format
 msgid "A [new release]({0}) of LOOT is available."
 msgstr ""
 
-#: src/gui/qt/main_window.cpp:2755
+#: src/gui/qt/main_window.cpp:2757
 msgid ""
 "Failed to check for LOOT updates! You can check your LOOTDebugLog.txt (you "
 "can get to it through the main menu) for more information."
@@ -1083,7 +1083,7 @@ msgstr ""
 msgid "Add new game…"
 msgstr ""
 
-#: src/gui/query/types/apply_sort_query.h:76
+#: src/gui/query/types/apply_sort_query.h:75
 msgid ""
 "Oh no, something went wrong! This is usually because \"{0}\" is set to be "
 "read-only. If it is, unset it and try again. If it isn't, you can check your "
@@ -1118,49 +1118,49 @@ msgstr ""
 msgid "Error: Game-specific settings could not be initialised. {0}"
 msgstr ""
 
-#: src/gui/state/loot_state.cpp:197
+#: src/gui/state/loot_state.cpp:201
 #, c++-format
 msgid "Error: Could not create LOOT data directory. {0}"
 msgstr ""
 
 #. translators: This error is displayed when LOOT is unable to
 #. load its own settings file. The placeholder is for additional
 #. detail about what went wrong.
-#: src/gui/state/loot_state.cpp:211 src/gui/state/loot_state.cpp:265
+#: src/gui/state/loot_state.cpp:215 src/gui/state/loot_state.cpp:269
 #, c++-format
 msgid "Error: Settings parsing failed. {0}"
 msgstr ""
 
 #. translators: --auto-sort and --game are command-line arguments and
 #. shouldn't be translated.
-#: src/gui/state/loot_state.cpp:220
+#: src/gui/state/loot_state.cpp:224
 msgid "Error: --auto-sort was passed but no --game parameter was provided."
 msgstr ""
 
-#: src/gui/state/loot_state.cpp:306
+#: src/gui/state/loot_state.cpp:310
 #, c++-format
 msgid "Error: Could not create LOOT prelude directory. {0}"
 msgstr ""
 
 #. translators: --game and --game-path are command-line arguments and
 #. shouldn't be translated.
-#: src/gui/state/loot_state.cpp:323
+#: src/gui/state/loot_state.cpp:327
 msgid "Error: --game-path was passed but no --game parameter was provided."
 msgstr ""
 
-#: src/gui/state/loot_state.cpp:336
+#: src/gui/state/loot_state.cpp:340
 #, c++-format
 msgid "Error: failed to override game path, the game {0} was not recognised."
 msgstr ""
 
-#: src/gui/state/loot_state.cpp:370
+#: src/gui/state/loot_state.cpp:374
 msgid ""
 "No supported games were detected. Try running the launcher(s) for the "
 "supported game(s) that you have installed (e.g. press \"Play\" in Steam or "
 "GOG Galaxy), then restarting LOOT."
 msgstr ""
 
-#: src/gui/state/loot_state.cpp:389
+#: src/gui/state/loot_state.cpp:393
 #, c++-format
 msgid ""
 "The initial game with folder name \"{0}\" could not be set. If it is "
@@ -1177,7 +1177,17 @@ msgstr ""
 msgid "The group \"{0}\" does not exist."
 msgstr ""
 
-#: src/gui/state/game/game.cpp:570
+#: src/gui/state/game/game.cpp:831
+msgid ""
+"Sorting failed because there is at least one installed plugin that depends "
+"on at least one plugin that is not installed."
+msgstr ""
+
+#: src/gui/state/game/game.cpp:862
+msgid "You have not sorted your load order this session."
+msgstr ""
+
+#: src/gui/state/game/game.cpp:940
 #, c++-format
 msgid ""
 "An error occurred while parsing the metadata list(s): {0}.\n"
@@ -1196,17 +1206,7 @@ msgid ""
 "[LOOT's website]({1})."
 msgstr ""
 
-#: src/gui/state/game/game.cpp:970
-msgid ""
-"Sorting failed because there is at least one installed plugin that depends "
-"on at least one plugin that is not installed."
-msgstr ""
-
-#: src/gui/state/game/game.cpp:1007
-msgid "You have not sorted your load order this session."
-msgstr ""
-
-#: src/gui/state/game/game.cpp:1127
+#: src/gui/state/game/game.cpp:1115
 msgid ""
 "Failed to load the current load order, information displayed may be "
 "incorrect."

src/gui/qt/main_window.cpp

@@ -1097,7 +1097,7 @@ void MainWindow::sortPlugins(bool isAutoSort) {
 
   std::unique_ptr<Query> sortPluginsQuery =
       std::make_unique<SortPluginsQuery>(state.GetCurrentGame(),
-                                         state,
+                                         state.GetUnappliedChangeCount(),
                                          state.getSettings().getLanguage(),
                                          sendProgressUpdate);
 
@@ -1247,7 +1247,7 @@ PluginItem MainWindow::getSelectedPlugin() const {
 }
 
 void MainWindow::closeEvent(QCloseEvent* event) {
-  if (state.HasUnappliedChanges()) {
+  if (state.GetUnappliedChangeCount().IsNonZero()) {
     auto changeType = pluginEditorWidget->isVisible()
                           ? boost::locale::translate("metadata edits")
                           : boost::locale::translate("sorted load order");
@@ -1418,7 +1418,7 @@ bool MainWindow::handlePluginsSorted(QueryResult result) {
   if (loadOrderHasChanged) {
     enterSortingState();
   } else {
-    state.DecrementUnappliedChangeCounter();
+    state.GetUnappliedChangeCount().Decrement();
 
     const auto message =
         translate("Sorting made no changes to the load order.");
@@ -1789,7 +1789,7 @@ void MainWindow::on_actionEditMetadata_triggered() {
 
     pluginEditorWidget->show();
 
-    state.IncrementUnappliedChangeCounter();
+    state.GetUnappliedChangeCount().Increment();
 
     // Refresh the sidebar items so that all their groups are displayed.
     pluginItemModel->setEditorPluginName(selectedPluginName);
@@ -2086,8 +2086,9 @@ void MainWindow::on_actionApplySort_triggered() {
   try {
     auto sortedPluginNames = pluginItemModel->getPluginNames();
 
-    auto query =
-        ApplySortQuery<>(state.GetCurrentGame(), state, sortedPluginNames);
+    auto query = ApplySortQuery(state.GetCurrentGame(),
+                                state.GetUnappliedChangeCount(),
+                                sortedPluginNames);
 
     try {
       query.executeLogic();
@@ -2109,7 +2110,8 @@ void MainWindow::on_actionApplySort_triggered() {
 
 void MainWindow::on_actionDiscardSort_triggered() {
   try {
-    auto query = CancelSortQuery(state.GetCurrentGame(), state);
+    auto query = CancelSortQuery(state.GetCurrentGame(),
+                                 state.GetUnappliedChangeCount());
 
     auto result = query.executeLogic();
 
@@ -2326,7 +2328,7 @@ void MainWindow::on_pluginEditorWidget_accepted(PluginMetadata userMetadata) {
 
     refreshPluginRawData(pluginName);
 
-    state.DecrementUnappliedChangeCounter();
+    state.GetUnappliedChangeCount().Decrement();
 
     exitEditingState();
   } catch (const std::exception& e) {
@@ -2335,7 +2337,7 @@ void MainWindow::on_pluginEditorWidget_accepted(PluginMetadata userMetadata) {
 }
 
 void MainWindow::on_pluginEditorWidget_rejected() {
-  state.DecrementUnappliedChangeCounter();
+  state.GetUnappliedChangeCount().Decrement();
 
   pluginItemModel->setEditorPluginName(std::nullopt);
 

src/gui/query/types/apply_sort_query.h

@@ -32,22 +32,21 @@ along with LOOT.  If not, see
 #include "gui/query/query.h"
 
 namespace loot {
-template<typename G = gui::Game>
 class ApplySortQuery : public Query {
 public:
-  ApplySortQuery(G& game,
-                 UnappliedChangeCounter& counter,
+  ApplySortQuery(gui::Game& game,
+                 ChangeCount& counter,
                  const std::vector<std::string>& plugins) :
-      game_(game), counter_(counter), plugins_(plugins) {}
+      game_(&game), counter_(&counter), plugins_(plugins) {}
 
   QueryResult executeLogic() override {
     auto logger = getLogger();
     if (logger) {
       logger->trace("User has accepted sorted load order, applying it.");
     }
     try {
-      game_.SetLoadOrder(plugins_);
-      counter_.DecrementUnappliedChangeCounter();
+      game_->SetLoadOrder(plugins_);
+      counter_->Decrement();
     } catch (...) {
       useSortingErrorMessage = true;
       throw;
@@ -58,19 +57,19 @@ class ApplySortQuery : public Query {
 
   std::string getErrorMessage() const override {
     if (useSortingErrorMessage) {
-      return getSortingErrorMessage(game_);
+      return getSortingErrorMessage(*game_);
     }
 
     return Query::getErrorMessage();
   }
 
 private:
-  G& game_;
-  UnappliedChangeCounter& counter_;
+  gui::Game* game_;
+  ChangeCount* counter_;
   const std::vector<std::string> plugins_;
   bool useSortingErrorMessage{false};
 
-  std::string getSortingErrorMessage(const G& game) const {
+  std::string getSortingErrorMessage(const gui::Game& game) const {
     return fmt::format(
         boost::locale::translate(
             "Oh no, something went wrong! This is usually because \"{0}\" "

src/gui/query/types/cancel_sort_query.h

@@ -34,17 +34,17 @@ along with LOOT.  If not, see
 namespace loot {
 class CancelSortQuery : public Query {
 public:
-  CancelSortQuery(gui::Game& game, UnappliedChangeCounter& counter) :
-      game_(game), counter_(counter) {}
+  CancelSortQuery(gui::Game& game, ChangeCount& counter) :
+      game_(&game), counter_(&counter) {}
 
   QueryResult executeLogic() override {
     auto logger = getLogger();
     if (logger) {
       logger->trace("User has rejected sorted load order, discarding it.");
     }
 
-    counter_.DecrementUnappliedChangeCounter();
-    game_.DecrementLoadOrderSortCount();
+    counter_->Decrement();
+    game_->DecrementLoadOrderSortCount();
 
     const std::function<std::pair<std::string, std::optional<short>>(
         const PluginInterface* const, std::optional<short>, bool)>
@@ -54,12 +54,12 @@ class CancelSortQuery : public Query {
           return std::make_pair(plugin->GetName(), loadOrderIndex);
         };
 
-    return MapFromLoadOrderData(game_, game_.GetLoadOrder(), mapper);
+    return MapFromLoadOrderData(*game_, game_->GetLoadOrder(), mapper);
   }
 
 private:
-  gui::Game& game_;
-  UnappliedChangeCounter& counter_;
+  gui::Game* game_;
+  ChangeCount* counter_;
 };
 }