[FancyZones] Split and reorganize FancyZonesData and JSON Helpers (#5028)

* Rename JsonHelpers to FancyZonesData Add new JsonHelpers.[h|cpp] files * Introduce FancyZonesDataTypes * Move first part of JSON related stuff to JsonHelpers files * Small refactor * Move all json related stuff to JsonHelpers * Minor refactoring * Fix formating * Remove GetPersistFancyZonesJSONPath() and GetPersistAppZoneHistoryFilePath() Remove GetActiveZoneSetTmpPath(), GetDeletedCustomZoneSetsTmpPath and GetAppliedZoneSetTmpPath() Simplify tests * Address PR comment - Rename FancyZonesDataNS to FancyZonesData * Address PR comment - Rename local var * Delete obsolete stuff * Remove double and uneeded includes Introduce const non-localizable string variables Address all othe PR comments * Add comments to explain hardcoded values * Remove FancyZonesData namespace * Introduce const non-localizable string variables in FancyZonesDataTypes * Add comments to explain FancyZonesData maps Co-authored-by: Clint Rutkas <clint@rutkas.com>
2026-04-08 20:27:36 +02:00 · 2020-07-22 10:39:13 +02:00
parent 4f45cf1386
commit 0027a0af40
25 changed files with 1924 additions and 1934 deletions
--- a/src/modules/fancyzones/lib/FancyZonesData.h
+++ b/src/modules/fancyzones/lib/FancyZonesData.h
@@ -0,0 +1,137 @@
+#pragma once
+
+#include "JsonHelpers.h"
+
+#include <common/settings_helpers.h>
+#include <common/json.h>
+#include <mutex>
+
+#include <string>
+#include <unordered_map>
+#include <optional>
+#include <vector>
+#include <winnt.h>
+
+namespace FancyZonesDataTypes
+{
+    struct ZoneSetData;
+    struct DeviceInfoData;
+    struct CustomZoneSetData;
+    struct AppZoneHistoryData;
+}
+
+#if defined(UNIT_TESTS)
+namespace FancyZonesUnitTests
+{
+    class FancyZonesDataUnitTests;
+    class FancyZonesIFancyZonesCallbackUnitTests;
+    class ZoneSetCalculateZonesUnitTests;
+    class ZoneWindowUnitTests;
+}
+#endif
+
+class FancyZonesData
+{
+public:
+    FancyZonesData();
+
+    std::optional<FancyZonesDataTypes::DeviceInfoData> FindDeviceInfo(const std::wstring& zoneWindowId) const;
+
+    std::optional<FancyZonesDataTypes::CustomZoneSetData> FindCustomZoneSet(const std::wstring& guid) const;
+
+    inline const std::unordered_map<std::wstring, FancyZonesDataTypes::DeviceInfoData>& GetDeviceInfoMap() const
+    {
+        std::scoped_lock lock{ dataLock };
+        return deviceInfoMap;
+    }
+
+    inline const std::unordered_map<std::wstring, FancyZonesDataTypes::CustomZoneSetData>& GetCustomZoneSetsMap() const
+    {
+        std::scoped_lock lock{ dataLock };
+        return customZoneSetsMap;
+    }
+
+    inline const std::unordered_map<std::wstring, std::vector<FancyZonesDataTypes::AppZoneHistoryData>>& GetAppZoneHistoryMap() const
+    {
+        std::scoped_lock lock{ dataLock };
+        return appZoneHistoryMap;
+    }
+
+    void AddDevice(const std::wstring& deviceId);
+    void CloneDeviceInfo(const std::wstring& source, const std::wstring& destination);
+    void UpdatePrimaryDesktopData(const std::wstring& desktopId);
+    void RemoveDeletedDesktops(const std::vector<std::wstring>& activeDesktops);
+
+    bool IsAnotherWindowOfApplicationInstanceZoned(HWND window, const std::wstring_view& deviceId) const;
+    void UpdateProcessIdToHandleMap(HWND window, const std::wstring_view& deviceId);
+    std::vector<int> GetAppLastZoneIndexSet(HWND window, const std::wstring_view& deviceId, const std::wstring_view& zoneSetId) const;
+    bool RemoveAppLastZone(HWND window, const std::wstring_view& deviceId, const std::wstring_view& zoneSetId);
+    bool SetAppLastZones(HWND window, const std::wstring& deviceId, const std::wstring& zoneSetId, const std::vector<int>& zoneIndexSet);
+
+    void SetActiveZoneSet(const std::wstring& deviceId, const FancyZonesDataTypes::ZoneSetData& zoneSet);
+
+    bool SerializeDeviceInfoToTmpFile(const std::wstring& uniqueId) const;
+    void ParseDataFromTmpFiles();
+
+    json::JsonObject GetPersistFancyZonesJSON();
+
+    void LoadFancyZonesData();
+    void SaveFancyZonesData() const;
+
+private:
+#if defined(UNIT_TESTS)
+    friend class FancyZonesUnitTests::FancyZonesDataUnitTests;
+    friend class FancyZonesUnitTests::FancyZonesIFancyZonesCallbackUnitTests;
+    friend class FancyZonesUnitTests::ZoneWindowUnitTests;
+    friend class FancyZonesUnitTests::ZoneSetCalculateZonesUnitTests;
+
+    inline void SetDeviceInfo(const std::wstring& deviceId, FancyZonesDataTypes::DeviceInfoData data)
+    {
+        deviceInfoMap[deviceId] = data;
+    }
+
+    inline bool ParseDeviceInfos(const json::JsonObject& fancyZonesDataJSON)
+    {
+        deviceInfoMap = JSONHelpers::ParseDeviceInfos(fancyZonesDataJSON);
+        return !deviceInfoMap.empty();
+    }
+
+    inline void clear_data()
+    {
+        appZoneHistoryMap.clear();
+        deviceInfoMap.clear();
+        customZoneSetsMap.clear();
+    }
+
+    inline void SetSettingsModulePath(std::wstring_view moduleName)
+    {
+        std::wstring result = PTSettingsHelper::get_module_save_folder_location(moduleName);
+        zonesSettingsFileName = result + L"\\" + std::wstring(L"zones-settings.json");
+        appZoneHistoryFileName = result + L"\\" + std::wstring(L"app-zone-history.json");
+    }
+#endif
+    void ParseDeviceInfoFromTmpFile(std::wstring_view tmpFilePath);
+    void ParseCustomZoneSetFromTmpFile(std::wstring_view tmpFilePath);
+    void ParseDeletedCustomZoneSetsFromTmpFile(std::wstring_view tmpFilePath);
+
+    void MigrateCustomZoneSetsFromRegistry();
+    void RemoveDesktopAppZoneHistory(const std::wstring& desktopId);
+
+    // Maps app path to app's zone history data
+    std::unordered_map<std::wstring, std::vector<FancyZonesDataTypes::AppZoneHistoryData>> appZoneHistoryMap{};
+    // Maps device unique ID to device data
+    std::unordered_map<std::wstring, FancyZonesDataTypes::DeviceInfoData> deviceInfoMap{};
+    // Maps custom zoneset UUID to it's data
+    std::unordered_map<std::wstring, FancyZonesDataTypes::CustomZoneSetData> customZoneSetsMap{};
+
+    std::wstring zonesSettingsFileName;
+    std::wstring appZoneHistoryFileName;
+
+    std::wstring activeZoneSetTmpFileName;
+    std::wstring appliedZoneSetTmpFileName;
+    std::wstring deletedCustomZoneSetsTmpFileName;
+
+    mutable std::recursive_mutex dataLock;
+};
+
+FancyZonesData& FancyZonesDataInstance();