[FancyZones] Customize default layouts (#21156)

2026-04-07 11:46:30 +02:00 · 2022-10-25 17:55:36 +02:00
parent 2add9db780
commit 10bfb014eb
25 changed files with 1133 additions and 110 deletions
--- a/src/modules/fancyzones/FancyZonesTests/UnitTests/DefaultLayoutsTests.Spec.cpp
+++ b/src/modules/fancyzones/FancyZonesTests/UnitTests/DefaultLayoutsTests.Spec.cpp
@@ -0,0 +1,121 @@
+#include "pch.h"
+#include <filesystem>
+
+#include <FancyZonesLib/FancyZonesData/DefaultLayouts.h>
+#include <FancyZonesLib/FancyZonesData/LayoutDefaults.h>
+#include <FancyZonesLib/util.h>
+
+using namespace Microsoft::VisualStudio::CppUnitTestFramework;
+
+namespace FancyZonesUnitTests
+{
+    TEST_CLASS (DefaultLayoutsUnitTests)
+    {
+        std::wstring m_testFolder = L"FancyZonesUnitTests";
+        std::wstring m_testFolderPath = PTSettingsHelper::get_module_save_folder_location(m_testFolder);
+
+        TEST_METHOD_CLEANUP(CleanUp)
+        {
+            std::filesystem::remove(DefaultLayouts::DefaultLayoutsFileName());
+            std::filesystem::remove_all(m_testFolderPath);
+        }
+
+        TEST_METHOD (DefaultLayoutsParse)
+        {
+            // prepare
+            json::JsonObject root{};
+            json::JsonArray layoutsArray{};
+
+            // custom, horizontal
+            {
+                json::JsonObject layout{};
+                layout.SetNamedValue(NonLocalizable::DefaultLayoutsIds::UuidID, json::value(L"{ACE817FD-2C51-4E13-903A-84CAB86FD17C}"));
+                layout.SetNamedValue(NonLocalizable::DefaultLayoutsIds::TypeID, json::value(L"custom"));
+
+                json::JsonObject obj{};
+                obj.SetNamedValue(NonLocalizable::DefaultLayoutsIds::MonitorConfigurationTypeID, json::value(L"horizontal"));
+                obj.SetNamedValue(NonLocalizable::DefaultLayoutsIds::LayoutID, layout);
+                layoutsArray.Append(obj);
+            }
+
+            // template, vertical
+            {
+                json::JsonObject layout{};
+                layout.SetNamedValue(NonLocalizable::DefaultLayoutsIds::TypeID, json::value(L"grid"));
+                layout.SetNamedValue(NonLocalizable::DefaultLayoutsIds::ShowSpacingID, json::value(true));
+                layout.SetNamedValue(NonLocalizable::DefaultLayoutsIds::SpacingID, json::value(1));
+                layout.SetNamedValue(NonLocalizable::DefaultLayoutsIds::ZoneCountID, json::value(4));
+                layout.SetNamedValue(NonLocalizable::DefaultLayoutsIds::SensitivityRadiusID, json::value(30));
+
+                json::JsonObject obj{};
+                obj.SetNamedValue(NonLocalizable::DefaultLayoutsIds::MonitorConfigurationTypeID, json::value(L"vertical"));
+                obj.SetNamedValue(NonLocalizable::DefaultLayoutsIds::LayoutID, layout);
+                layoutsArray.Append(obj);
+            }
+
+            root.SetNamedValue(NonLocalizable::DefaultLayoutsIds::DefaultLayoutsArrayID, layoutsArray);
+            json::to_file(DefaultLayouts::DefaultLayoutsFileName(), root);
+
+            // test
+            DefaultLayouts::instance().LoadData();
+            
+            Layout horizontal{
+                .uuid = FancyZonesUtils::GuidFromString(L"{ACE817FD-2C51-4E13-903A-84CAB86FD17C}").value(),
+                .type = FancyZonesDataTypes::ZoneSetLayoutType::Custom
+            };
+            Assert::IsTrue(horizontal == DefaultLayouts::instance().GetDefaultLayout(MonitorConfiguraionType::Horizontal));
+
+            Layout vertical{
+                .uuid = GUID_NULL,
+                .type = FancyZonesDataTypes::ZoneSetLayoutType::Grid,
+                .showSpacing = true,
+                .spacing = 1,
+                .zoneCount = 4,
+                .sensitivityRadius = 30
+            };
+            Assert::IsTrue(vertical == DefaultLayouts::instance().GetDefaultLayout(MonitorConfiguraionType::Vertical));
+        }
+
+            TEST_METHOD (DefaultLayoutsParseEmpty)
+            {
+                // prepare
+                json::JsonObject root{};
+                json::JsonArray layoutsArray{};
+                root.SetNamedValue(NonLocalizable::DefaultLayoutsIds::DefaultLayoutsArrayID, layoutsArray);
+                json::to_file(DefaultLayouts::DefaultLayoutsFileName(), root);
+
+                // test
+                DefaultLayouts::instance().LoadData();
+
+                Layout priorityGrid{
+                    .uuid = GUID_NULL,
+                    .type = FancyZonesDataTypes::ZoneSetLayoutType::PriorityGrid,
+                    .showSpacing = DefaultValues::ShowSpacing,
+                    .spacing = DefaultValues::Spacing,
+                    .zoneCount = DefaultValues::ZoneCount,
+                    .sensitivityRadius = DefaultValues::SensitivityRadius
+                };
+
+                Assert::IsTrue(priorityGrid == DefaultLayouts::instance().GetDefaultLayout(MonitorConfiguraionType::Horizontal));
+                Assert::IsTrue(priorityGrid == DefaultLayouts::instance().GetDefaultLayout(MonitorConfiguraionType::Vertical));
+            }
+
+            TEST_METHOD (DefaultLayoutsNoFile)
+            {
+                // test
+                DefaultLayouts::instance().LoadData();
+
+                Layout priorityGrid{
+                    .uuid = GUID_NULL,
+                    .type = FancyZonesDataTypes::ZoneSetLayoutType::PriorityGrid,
+                    .showSpacing = DefaultValues::ShowSpacing,
+                    .spacing = DefaultValues::Spacing,
+                    .zoneCount = DefaultValues::ZoneCount,
+                    .sensitivityRadius = DefaultValues::SensitivityRadius
+                };
+
+                Assert::IsTrue(priorityGrid == DefaultLayouts::instance().GetDefaultLayout(MonitorConfiguraionType::Horizontal));
+                Assert::IsTrue(priorityGrid == DefaultLayouts::instance().GetDefaultLayout(MonitorConfiguraionType::Vertical));
+            }
+    };
+}
--- a/src/modules/fancyzones/FancyZonesTests/UnitTests/UnitTests.vcxproj
+++ b/src/modules/fancyzones/FancyZonesTests/UnitTests/UnitTests.vcxproj
@@ -44,6 +44,7 @@
    <ClCompile Include="AppliedLayoutsTests.Spec.cpp" />
    <ClCompile Include="AppZoneHistoryTests.Spec.cpp" />
    <ClCompile Include="CustomLayoutsTests.Spec.cpp" />
+    <ClCompile Include="DefaultLayoutsTests.Spec.cpp" />
    <ClCompile Include="FancyZonesSettings.Spec.cpp" />
    <ClCompile Include="JsonHelpers.Tests.cpp" />
    <ClCompile Include="LayoutHotkeysTests.Spec.cpp" />
--- a/src/modules/fancyzones/FancyZonesTests/UnitTests/UnitTests.vcxproj.filters
+++ b/src/modules/fancyzones/FancyZonesTests/UnitTests/UnitTests.vcxproj.filters
@@ -57,6 +57,9 @@
    <ClCompile Include="WorkAreaIdTests.Spec.cpp">
      <Filter>Source Files</Filter>
    </ClCompile>
+    <ClCompile Include="DefaultLayoutsTests.Spec.cpp">
+      <Filter>Source Files</Filter>
+    </ClCompile>
  </ItemGroup>
  <ItemGroup>
    <ClInclude Include="pch.h">
--- a/src/modules/fancyzones/FancyZonesTests/UnitTests/WorkArea.Spec.cpp
+++ b/src/modules/fancyzones/FancyZonesTests/UnitTests/WorkArea.Spec.cpp
@@ -2,20 +2,14 @@

 #include <filesystem>

-#include <FancyZonesLib/util.h>
-#include <FancyZonesLib/ZoneSet.h>
 #include <FancyZonesLib/WorkArea.h>
-#include <FancyZonesLib/FancyZones.h>
 #include <FancyZonesLib/FancyZonesData/AppliedLayouts.h>
 #include <FancyZonesLib/FancyZonesData/AppZoneHistory.h>
-#include <FancyZonesLib/FancyZonesDataTypes.h>
-#include <FancyZonesLib/JsonHelpers.h>
+#include <FancyZonesLib/FancyZonesData/DefaultLayouts.h>
 #include "Util.h"

 #include <common/utils/process_path.h>

-#include <CppUnitTestLogger.h>
-
 using namespace Microsoft::VisualStudio::CppUnitTestFramework;

 namespace FancyZonesUnitTests
@@ -40,36 +34,43 @@ namespace FancyZonesUnitTests

            AppZoneHistory::instance().LoadData();
            AppliedLayouts::instance().LoadData();
+            DefaultLayouts::instance().LoadData();
        }

        TEST_METHOD_CLEANUP(CleanUp)
        {
            std::filesystem::remove(AppliedLayouts::AppliedLayoutsFileName());
            std::filesystem::remove(AppZoneHistory::AppZoneHistoryFileName());
+
+            std::filesystem::remove(DefaultLayouts::DefaultLayoutsFileName());
        }

        TEST_METHOD (CreateWorkArea)
        {
+            const auto defaultLayout = DefaultLayouts::instance().GetDefaultLayout();
+
            auto workArea = MakeWorkArea({}, Mocks::Monitor(), m_uniqueId, m_emptyUniqueId);
            Assert::IsFalse(workArea == nullptr);
            Assert::IsTrue(m_uniqueId == workArea->UniqueId());

            auto* zoneSet{ workArea->ZoneSet() };
            Assert::IsNotNull(zoneSet);
-            Assert::AreEqual(static_cast<int>(zoneSet->LayoutType()), static_cast<int>(FancyZonesDataTypes::ZoneSetLayoutType::PriorityGrid));
-            Assert::AreEqual(zoneSet->GetZones().size(), static_cast<size_t>(3));
+            Assert::AreEqual(static_cast<int>(defaultLayout.type), static_cast<int>(zoneSet->LayoutType()));
+            Assert::AreEqual(static_cast<size_t>(defaultLayout.zoneCount), zoneSet->GetZones().size());
        }

        TEST_METHOD (CreateCombinedWorkArea)
        {
+            const auto defaultLayout = DefaultLayouts::instance().GetDefaultLayout();
+
            auto workArea = MakeWorkArea({}, {}, m_uniqueId, m_emptyUniqueId);
            Assert::IsFalse(workArea == nullptr);
            Assert::IsTrue(m_uniqueId == workArea->UniqueId());

            auto* zoneSet{ workArea->ZoneSet() };
            Assert::IsNotNull(zoneSet);
-            Assert::AreEqual(static_cast<int>(zoneSet->LayoutType()), static_cast<int>(FancyZonesDataTypes::ZoneSetLayoutType::PriorityGrid));
-            Assert::AreEqual(zoneSet->GetZones().size(), static_cast<size_t>(3));
+            Assert::AreEqual(static_cast<int>(defaultLayout.type), static_cast<int>(zoneSet->LayoutType()));
+            Assert::AreEqual(static_cast<size_t>(defaultLayout.zoneCount), zoneSet->GetZones().size());
        }

        TEST_METHOD (CreateWorkAreaClonedFromParent)
@@ -107,6 +108,67 @@ namespace FancyZonesUnitTests
            Assert::AreEqual(layout.spacing, actualLayout.spacing);
            Assert::AreEqual(layout.zoneCount, actualLayout.zoneCount);
        }
+
+        TEST_METHOD (CreateWorkAreaWithCustomDefault)
+        {
+            // prepare
+            json::JsonObject root{};
+            json::JsonArray layoutsArray{};
+            json::JsonObject layout{};
+            layout.SetNamedValue(NonLocalizable::DefaultLayoutsIds::UuidID, json::value(L"{ACE817FD-2C51-4E13-903A-84CAB86FD17C}"));
+            layout.SetNamedValue(NonLocalizable::DefaultLayoutsIds::TypeID, json::value(L"custom"));
+            json::JsonObject item{};
+            item.SetNamedValue(NonLocalizable::DefaultLayoutsIds::MonitorConfigurationTypeID, json::value(L"horizontal"));
+            item.SetNamedValue(NonLocalizable::DefaultLayoutsIds::LayoutID, layout);
+            layoutsArray.Append(item);
+            root.SetNamedValue(NonLocalizable::DefaultLayoutsIds::DefaultLayoutsArrayID, layoutsArray);
+            
+            json::to_file(DefaultLayouts::DefaultLayoutsFileName(), root);
+            DefaultLayouts::instance().LoadData();
+
+            // test
+            auto workArea = MakeWorkArea({}, Mocks::Monitor(), m_uniqueId, m_emptyUniqueId);
+            Assert::IsFalse(workArea == nullptr);
+            Assert::IsTrue(m_uniqueId == workArea->UniqueId());
+
+            auto* zoneSet{ workArea->ZoneSet() };
+            Assert::IsNotNull(zoneSet);
+            Assert::AreEqual(static_cast<int>(FancyZonesDataTypes::ZoneSetLayoutType::Custom), static_cast<int>(zoneSet->LayoutType()));
+            Assert::IsTrue(FancyZonesUtils::GuidFromString(L"{ACE817FD-2C51-4E13-903A-84CAB86FD17C}").value() == zoneSet->Id());
+        }
+
+        TEST_METHOD (CreateWorkAreaWithTemplateDefault)
+        {
+            // prepare
+            json::JsonObject root{};
+            json::JsonArray layoutsArray{};
+            json::JsonObject layout{};
+            layout.SetNamedValue(NonLocalizable::DefaultLayoutsIds::TypeID, json::value(L"grid"));
+            layout.SetNamedValue(NonLocalizable::DefaultLayoutsIds::ShowSpacingID, json::value(true));
+            layout.SetNamedValue(NonLocalizable::DefaultLayoutsIds::SpacingID, json::value(1));
+            layout.SetNamedValue(NonLocalizable::DefaultLayoutsIds::ZoneCountID, json::value(4));
+            layout.SetNamedValue(NonLocalizable::DefaultLayoutsIds::SensitivityRadiusID, json::value(30));
+
+            json::JsonObject item{};
+            item.SetNamedValue(NonLocalizable::DefaultLayoutsIds::MonitorConfigurationTypeID, json::value(L"horizontal"));
+            item.SetNamedValue(NonLocalizable::DefaultLayoutsIds::LayoutID, layout);
+            layoutsArray.Append(item);
+            root.SetNamedValue(NonLocalizable::DefaultLayoutsIds::DefaultLayoutsArrayID, layoutsArray);
+
+            json::to_file(DefaultLayouts::DefaultLayoutsFileName(), root);
+            DefaultLayouts::instance().LoadData();
+
+            // test
+            auto workArea = MakeWorkArea({}, Mocks::Monitor(), m_uniqueId, m_emptyUniqueId);
+            Assert::IsFalse(workArea == nullptr);
+            Assert::IsTrue(m_uniqueId == workArea->UniqueId());
+
+            auto* zoneSet{ workArea->ZoneSet() };
+            Assert::IsNotNull(zoneSet);
+            Assert::AreEqual(static_cast<int>(FancyZonesDataTypes::ZoneSetLayoutType::Grid), static_cast<int>(zoneSet->LayoutType()));
+            Assert::AreEqual(static_cast<size_t>(4), zoneSet->GetZones().size());
+            Assert::IsTrue(GUID_NULL == zoneSet->Id());
+        }
    };

    TEST_CLASS (WorkAreaUnitTests)