[FancyZones] Overlapping zones selection algorithm - settings (#9874)

* Started work

* Removed bools in favor of an enum, renamed some

* Done something but it still doesn't work

* Settings are now correctly saved

* I'm getting a crash, I need to rebuild from scratch

* Settings page looks alright

* Completed work. Unit tests?

* Use ComboBox instead

* Add telemetry

* Update text

src/modules/fancyzones/lib/FancyZones.cpp

@@ -175,6 +175,12 @@ struct FancyZones : public winrt::implements<FancyZones, IFancyZones, IFancyZone
         return m_windowMoveHandler.InMoveSize();
     }
 
+    IFACEMETHODIMP_(Settings::OverlappingZonesAlgorithm)
+    GetOverlappingZonesAlgorithm() noexcept
+    {
+        return m_settings->GetSettings()->overlappingZonesAlgorithm;
+    }
+
     LRESULT WndProc(HWND, UINT, WPARAM, LPARAM) noexcept;
     void OnDisplayChange(DisplayChangeType changeType) noexcept;
     void AddZoneWindow(HMONITOR monitor, const std::wstring& deviceId) noexcept;

src/modules/fancyzones/lib/FancyZones.h

@@ -1,6 +1,7 @@
 #pragma once
 
 #include <common/hooks/WinHookEvent.h>
+#include "Settings.h"
 
 #include <functional>
 
@@ -102,6 +103,11 @@ interface __declspec(uuid("{5C8D99D6-34B2-4F4A-A8E5-7483F6869775}")) IZoneWindow
      */
     IFACEMETHOD_(bool, InMoveSize)
     () = 0;
+    /**
+     * @returns Enumeration value indicating the algorithm used to choose one of multiple overlapped zones to highlight.
+     */
+    IFACEMETHOD_(Settings::OverlappingZonesAlgorithm, GetOverlappingZonesAlgorithm)
+    () = 0;
 };
 
 winrt::com_ptr<IFancyZones> MakeFancyZones(HINSTANCE hinstance, const winrt::com_ptr<IFancyZonesSettings>& settings, std::function<void()> disableCallback) noexcept;

src/modules/fancyzones/lib/Settings.cpp

@@ -15,6 +15,7 @@ namespace NonLocalizable
     const wchar_t OverrideSnapHotKeysID[] = L"fancyzones_overrideSnapHotkeys";
     const wchar_t MoveWindowAcrossMonitorsID[] = L"fancyzones_moveWindowAcrossMonitors";
     const wchar_t MoveWindowsBasedOnPositionID[] = L"fancyzones_moveWindowsBasedOnPosition";
+    const wchar_t OverlappingZonesAlgorithmID[] = L"fancyzones_overlappingZonesAlgorithm";
     const wchar_t DisplayChangeMoveWindowsID[] = L"fancyzones_displayChange_moveWindows";
     const wchar_t ZoneSetChangeMoveWindowsID[] = L"fancyzones_zoneSetChange_moveWindows";
     const wchar_t AppLastZoneMoveWindowsID[] = L"fancyzones_appLastZone_moveWindows";
@@ -79,16 +80,12 @@ struct FancyZonesSettings : winrt::implements<FancyZonesSettings, IFancyZonesSet
         PCWSTR name;
         bool* value;
         int resourceId;
-    } m_configBools[14 /* 15 */] = {
-        // "Turning FLASHING_ZONE option off"
+    } m_configBools[14] = {
         { NonLocalizable::ShiftDragID, &m_settings.shiftDrag, IDS_SETTING_DESCRIPTION_SHIFTDRAG },
         { NonLocalizable::MouseSwitchID, &m_settings.mouseSwitch, IDS_SETTING_DESCRIPTION_MOUSESWITCH },
         { NonLocalizable::OverrideSnapHotKeysID, &m_settings.overrideSnapHotkeys, IDS_SETTING_DESCRIPTION_OVERRIDE_SNAP_HOTKEYS },
         { NonLocalizable::MoveWindowAcrossMonitorsID, &m_settings.moveWindowAcrossMonitors, IDS_SETTING_DESCRIPTION_MOVE_WINDOW_ACROSS_MONITORS },
         { NonLocalizable::MoveWindowsBasedOnPositionID, &m_settings.moveWindowsBasedOnPosition, IDS_SETTING_DESCRIPTION_MOVE_WINDOWS_BASED_ON_POSITION },
-
-        // "Turning FLASHING_ZONE option off"
-        //{ L"fancyzones_zoneSetChange_flashZones", &m_settings.zoneSetChange_flashZones, IDS_SETTING_DESCRIPTION_ZONESETCHANGE_FLASHZONES },
         { NonLocalizable::DisplayChangeMoveWindowsID, &m_settings.displayChange_moveWindows, IDS_SETTING_DESCRIPTION_DISPLAYCHANGE_MOVEWINDOWS },
         { NonLocalizable::ZoneSetChangeMoveWindowsID, &m_settings.zoneSetChange_moveWindows, IDS_SETTING_DESCRIPTION_ZONESETCHANGE_MOVEWINDOWS },
         { NonLocalizable::AppLastZoneMoveWindowsID, &m_settings.appLastZone_moveWindows, IDS_SETTING_DESCRIPTION_APPLASTZONE_MOVEWINDOWS },
@@ -238,6 +235,15 @@ void FancyZonesSettings::LoadSettings(PCWSTR config, bool fromFile) noexcept
         {
             m_settings.zoneHighlightOpacity = *val;
         }
+
+        if (auto val = values.get_int_value(NonLocalizable::OverlappingZonesAlgorithmID))
+        {
+            // Avoid undefined behavior
+            if (*val >= 0 || *val < (int)Settings::OverlappingZonesAlgorithm::EnumElements)
+            {
+                m_settings.overlappingZonesAlgorithm = (Settings::OverlappingZonesAlgorithm)*val;
+            }
+        }
     }
     catch (...)
     {
@@ -264,6 +270,7 @@ void FancyZonesSettings::SaveSettings() noexcept
         values.add_property(NonLocalizable::ZoneBorderColorID, m_settings.zoneBorderColor);
         values.add_property(NonLocalizable::ZoneHighlightColorID, m_settings.zoneHighlightColor);
         values.add_property(NonLocalizable::ZoneHighlightOpacityID, m_settings.zoneHighlightOpacity);
+        values.add_property(NonLocalizable::OverlappingZonesAlgorithmID, (int)m_settings.overlappingZonesAlgorithm);
         values.add_property(NonLocalizable::EditorHotkeyID, m_settings.editorHotkey.get_json());
         values.add_property(NonLocalizable::ExcludedAppsID, m_settings.excludedApps);
 

src/modules/fancyzones/lib/Settings.h

@@ -14,6 +14,14 @@ namespace ZonedWindowProperties
 
 struct Settings
 {
+    enum struct OverlappingZonesAlgorithm : int
+    {
+        Smallest = 0,
+        Largest = 1,
+        Positional = 2,
+        EnumElements = 3, // number of elements in the enum, not counting this
+    };
+
     // The values specified here are the defaults.
     bool shiftDrag = true;
     bool mouseSwitch = false;
@@ -34,6 +42,7 @@ struct Settings
     std::wstring zoneBorderColor = L"#FFFFFF";
     std::wstring zoneHighlightColor = L"#008CFF";
     int zoneHighlightOpacity = 50;
+    OverlappingZonesAlgorithm overlappingZonesAlgorithm = OverlappingZonesAlgorithm::Smallest;
     PowerToysSettings::HotkeyObject editorHotkey = PowerToysSettings::HotkeyObject::from_settings(true, false, false, false, VK_OEM_3);
     std::wstring excludedApps = L"";
     std::vector<std::wstring> excludedAppsArray;

src/modules/fancyzones/lib/ZoneSet.cpp

@@ -257,14 +257,16 @@ ZoneSet::ZonesFromPoint(POINT pt) const noexcept
 
         try
         {
+            using Algorithm = Settings::OverlappingZonesAlgorithm;
+
             switch (m_config.SelectionAlgorithm)
             {
-            case ZoneSelectionAlgorithm::SUBREGION:
-                return ZoneSelectSubregion(capturedZones, pt);
-            case ZoneSelectionAlgorithm::SMALLEST:
+            case Algorithm::Smallest:
                 return ZoneSelectPriority(capturedZones, [&](auto zone1, auto zone2) { return zoneArea(zone1) < zoneArea(zone2); });
-            case ZoneSelectionAlgorithm::LARGEST:
+            case Algorithm::Largest:
                 return ZoneSelectPriority(capturedZones, [&](auto zone1, auto zone2) { return zoneArea(zone1) > zoneArea(zone2); });
+            case Algorithm::Positional:
+                return ZoneSelectSubregion(capturedZones, pt);
             }
         }
         catch (std::out_of_range)

src/modules/fancyzones/lib/ZoneSet.h

@@ -152,32 +152,27 @@ interface __declspec(uuid("{E4839EB7-669D-49CF-84A9-71A2DFD851A3}")) IZoneSet :
     IFACEMETHOD_(std::vector<size_t>, GetCombinedZoneRange)(const std::vector<size_t>& initialZones, const std::vector<size_t>& finalZones) const = 0;
 };
 
-enum struct ZoneSelectionAlgorithm
-{
-    SMALLEST = 0,
-    LARGEST = 1,
-    SUBREGION = 2,
-};
-
 struct ZoneSetConfig
 {
     ZoneSetConfig(
         GUID id,
         FancyZonesDataTypes::ZoneSetLayoutType layoutType,
         HMONITOR monitor,
-        int sensitivityRadius) noexcept :
+        int sensitivityRadius,
+        Settings::OverlappingZonesAlgorithm selectionAlgorithm = {}) noexcept :
             Id(id),
             LayoutType(layoutType),
             Monitor(monitor),
-            SensitivityRadius(sensitivityRadius)
+            SensitivityRadius(sensitivityRadius),
+            SelectionAlgorithm(selectionAlgorithm)
     {
     }
 
     GUID Id{};
     FancyZonesDataTypes::ZoneSetLayoutType LayoutType{};
     HMONITOR Monitor{};
     int SensitivityRadius;
-    ZoneSelectionAlgorithm SelectionAlgorithm = ZoneSelectionAlgorithm::SMALLEST;
+    Settings::OverlappingZonesAlgorithm SelectionAlgorithm = Settings::OverlappingZonesAlgorithm::Smallest;
 };
 
 winrt::com_ptr<IZoneSet> MakeZoneSet(ZoneSetConfig const& config) noexcept;

src/modules/fancyzones/lib/ZoneWindow.cpp

@@ -406,7 +406,8 @@ void ZoneWindow::CalculateZoneSet() noexcept
             zoneSetId,
             activeZoneSet.type,
             m_monitor,
-            sensitivityRadius));
+            sensitivityRadius,
+            m_host->GetOverlappingZonesAlgorithm()));
 
         RECT workArea;
         if (m_monitor)

src/modules/fancyzones/lib/trace.cpp

@@ -55,6 +55,7 @@
 #define NumberOfZonesKey "NumberOfZones"
 #define NumberOfWindowsKey "NumberOfWindows"
 #define InputModeKey "InputMode"
+#define OverlappingZonesAlgorithmKey "OverlappingZonesAlgorithm"
 
 TRACELOGGING_DEFINE_PROVIDER(
     g_hProvider,
@@ -260,6 +261,7 @@ void Trace::SettingsChanged(const Settings& settings) noexcept
         TraceLoggingWideString(settings.zoneBorderColor.c_str(), ZoneBorderColorKey),
         TraceLoggingWideString(settings.zoneHighlightColor.c_str(), ZoneHighlightColorKey),
         TraceLoggingInt32(settings.zoneHighlightOpacity, ZoneHighlightOpacityKey),
+        TraceLoggingInt32((int)settings.overlappingZonesAlgorithm, OverlappingZonesAlgorithmKey),
         TraceLoggingWideString(hotkeyStr.c_str(), HotkeyKey),
         TraceLoggingInt32(static_cast<int>(settings.excludedAppsArray.size()), ExcludedAppsCountKey));
 }

src/modules/fancyzones/tests/UnitTests/ZoneSet.Spec.cpp

@@ -28,7 +28,7 @@ namespace FancyZonesUnitTests
                 auto hres = CoCreateGuid(&m_id);
                 Assert::AreEqual(S_OK, hres);
 
-                ZoneSetConfig m_config = ZoneSetConfig(m_id, m_layoutType, Mocks::Monitor(), DefaultValues::SensitivityRadius);
+                ZoneSetConfig m_config = ZoneSetConfig(m_id, m_layoutType, Mocks::Monitor(), DefaultValues::SensitivityRadius, Settings::OverlappingZonesAlgorithm::Smallest);
                 m_set = MakeZoneSet(m_config);
             }
 

src/modules/fancyzones/tests/UnitTests/ZoneWindow.Spec.cpp

@@ -56,6 +56,11 @@ namespace FancyZonesUnitTests
         {
             return false;
         }
+        IFACEMETHODIMP_(Settings::OverlappingZonesAlgorithm)
+        GetOverlappingZonesAlgorithm() noexcept
+        {
+            return Settings::OverlappingZonesAlgorithm::Smallest;
+        }
 
         IZoneWindow* m_zoneWindow;
     };

src/settings-ui/Microsoft.PowerToys.Settings.UI.Library/FZConfigProperties.cs

@@ -18,6 +18,7 @@ public FZConfigProperties()
             FancyzonesMouseSwitch = new BoolProperty();
             FancyzonesMoveWindowsAcrossMonitors = new BoolProperty();
             FancyzonesMoveWindowsBasedOnPosition = new BoolProperty();
+            FancyzonesOverlappingZonesAlgorithm = new IntProperty();
             FancyzonesDisplayChangeMoveWindows = new BoolProperty();
             FancyzonesZoneSetChangeMoveWindows = new BoolProperty();
             FancyzonesAppLastZoneMoveWindows = new BoolProperty();
@@ -50,6 +51,9 @@ public FZConfigProperties()
         [JsonPropertyName("fancyzones_moveWindowsBasedOnPosition")]
         public BoolProperty FancyzonesMoveWindowsBasedOnPosition { get; set; }
 
+        [JsonPropertyName("fancyzones_overlappingZonesAlgorithm")]
+        public IntProperty FancyzonesOverlappingZonesAlgorithm { get; set; }
+
         [JsonPropertyName("fancyzones_displayChange_moveWindows")]
         public BoolProperty FancyzonesDisplayChangeMoveWindows { get; set; }
 

src/settings-ui/Microsoft.PowerToys.Settings.UI.Library/ViewModels/FancyZonesViewModel.cs

@@ -32,6 +32,13 @@ private enum MoveWindowBehaviour
             MoveWindowBasedOnPosition,
         }
 
+        private enum OverlappingZonesAlgorithm
+        {
+            Smallest = 0,
+            Largest = 1,
+            Positional = 2,
+        }
+
         public FancyZonesViewModel(ISettingsRepository<GeneralSettings> settingsRepository, ISettingsRepository<FancyZonesSettings> moduleSettingsRepository, Func<string, int> ipcMSGCallBackFunc, string configFileSubfolder = "")
         {
             // To obtain the general settings configurations of PowerToys Settings.
@@ -58,6 +65,7 @@ public FancyZonesViewModel(ISettingsRepository<GeneralSettings> settingsReposito
             _overrideSnapHotkeys = Settings.Properties.FancyzonesOverrideSnapHotkeys.Value;
             _moveWindowsAcrossMonitors = Settings.Properties.FancyzonesMoveWindowsAcrossMonitors.Value;
             _moveWindowBehaviour = Settings.Properties.FancyzonesMoveWindowsBasedOnPosition.Value ? MoveWindowBehaviour.MoveWindowBasedOnPosition : MoveWindowBehaviour.MoveWindowBasedOnZoneIndex;
+            _overlappingZonesAlgorithm = (OverlappingZonesAlgorithm)Settings.Properties.FancyzonesOverlappingZonesAlgorithm.Value;
             _displayChangemoveWindows = Settings.Properties.FancyzonesDisplayChangeMoveWindows.Value;
             _zoneSetChangeMoveWindows = Settings.Properties.FancyzonesZoneSetChangeMoveWindows.Value;
             _appLastZoneMoveWindows = Settings.Properties.FancyzonesAppLastZoneMoveWindows.Value;
@@ -92,6 +100,7 @@ public FancyZonesViewModel(ISettingsRepository<GeneralSettings> settingsReposito
         private bool _overrideSnapHotkeys;
         private bool _moveWindowsAcrossMonitors;
         private MoveWindowBehaviour _moveWindowBehaviour;
+        private OverlappingZonesAlgorithm _overlappingZonesAlgorithm;
         private bool _displayChangemoveWindows;
         private bool _zoneSetChangeMoveWindows;
         private bool _appLastZoneMoveWindows;
@@ -257,6 +266,24 @@ public bool MoveWindowsBasedOnZoneIndex
             }
         }
 
+        public int OverlappingZonesAlgorithmIndex
+        {
+            get
+            {
+                return (int)_overlappingZonesAlgorithm;
+            }
+
+            set
+            {
+                if (value != (int)_overlappingZonesAlgorithm)
+                {
+                    _overlappingZonesAlgorithm = (OverlappingZonesAlgorithm)value;
+                    Settings.Properties.FancyzonesOverlappingZonesAlgorithm.Value = value;
+                    NotifyPropertyChanged();
+                }
+            }
+        }
+
         public bool DisplayChangeMoveWindows
         {
             get

src/settings-ui/Microsoft.PowerToys.Settings.UI/Strings/en-us/Resources.resw

@@ -937,4 +937,16 @@
   <data name="ColorPicker_Editor.Text" xml:space="preserve">
     <value>Editor</value>
   </data>
+  <data name="FancyZones_OverlappingZonesLargest.Content" xml:space="preserve">
+    <value>Activate the largest zone by area</value>
+  </data>
+  <data name="FancyZones_OverlappingZonesPositional.Content" xml:space="preserve">
+    <value>Split the overlapped area into multiple activation targets</value>
+  </data>
+  <data name="FancyZones_OverlappingZonesSmallest.Content" xml:space="preserve">
+    <value>Activate the smallest zone by area</value>
+  </data>
+  <data name="FancyZones_OverlappingZonesLabel.Text" xml:space="preserve">
+    <value>When multiple zones overlap:</value>
+  </data>
 </root>

src/settings-ui/Microsoft.PowerToys.Settings.UI/Styles/_Sizes.xaml

@@ -19,4 +19,7 @@
 
     <!-- MaxWidth of the content panel, similar to W10 Settings -->
     <x:Double x:Key="MaxContentWidth">460</x:Double>
+
+    <!-- Maximum Width of a combo box inside the content panel -->
+    <x:Double x:Key="MaxComboBoxWidth">444</x:Double>
 </ResourceDictionary>

src/settings-ui/Microsoft.PowerToys.Settings.UI/Views/FancyZonesPage.xaml

@@ -125,6 +125,20 @@
                       Margin="{StaticResource XSmallTopMargin}"
                       IsEnabled="{x:Bind Mode=OneWay, Path=ViewModel.IsEnabled}"/>
 
+            <TextBlock x:Uid="FancyZones_OverlappingZonesLabel"
+                       Margin="{StaticResource SmallTopMargin}"
+                       Foreground="{x:Bind Mode=OneWay, Path=ViewModel.IsEnabled, Converter={StaticResource ModuleEnabledToForegroundConverter}}"/>
+
+            <ComboBox Name="FancyZones_OverlappingZonesComboBox"
+                      x:Uid="FancyZones_OverlappingZonesComboBox"
+                      SelectedIndex="{x:Bind Path=ViewModel.OverlappingZonesAlgorithmIndex, Mode=TwoWay}"
+                      VerticalAlignment="Center"
+                      Width="{StaticResource MaxComboBoxWidth}"
+                      Margin="{StaticResource SmallTopMargin}">
+                <ComboBoxItem x:Uid="FancyZones_OverlappingZonesSmallest" />
+                <ComboBoxItem x:Uid="FancyZones_OverlappingZonesLargest" />
+                <ComboBoxItem x:Uid="FancyZones_OverlappingZonesPositional" />
+            </ComboBox>
 
             <TextBlock x:Uid="FancyZones_WindowBehavior_GroupSettings"
                        Style="{StaticResource SettingsGroupTitleStyle}"