[FindMyMouse] Add setting for excluded apps (#16308)

* refactor find_app_name_in_path

* Add a setting for excluded apps

* Restore game_mode.h

src/modules/MouseUtils/FindMyMouse/FindMyMouse.cpp

@@ -4,6 +4,8 @@
 #include "FindMyMouse.h"
 #include "trace.h"
 #include "common/utils/game_mode.h"
+#include "common/utils/process_path.h"
+#include "common/utils/excluded_apps.h"
 #include <vector>
 
 #ifdef COMPOSITION
@@ -45,6 +47,7 @@ protected:
     void AfterMoveSonar() {}
     void SetSonarVisibility(bool visible) = delete;
     void UpdateMouseSnooping();
+    bool IsForegroundAppExcluded();
 
 protected:
     // Base class members you can access.
@@ -65,6 +68,7 @@ protected:
     int m_sonarZoomFactor = FIND_MY_MOUSE_DEFAULT_SPOTLIGHT_INITIAL_ZOOM;
     DWORD m_fadeDuration = FIND_MY_MOUSE_DEFAULT_ANIMATION_DURATION_MS;
     int m_finalAlphaNumerator = FIND_MY_MOUSE_DEFAULT_OVERLAY_OPACITY;
+    std::vector<std::wstring> m_excludedApps;
     static constexpr int FinalAlphaDenominator = 100;
     winrt::DispatcherQueueController m_dispatcherQueueController{ nullptr };
 
@@ -479,6 +483,11 @@ void SuperSonar<D>::StartSonar()
         return;
     }
 
+    if (IsForegroundAppExcluded())
+    {
+        return;
+    }
+
     Logger::info("Focusing the sonar on the mouse cursor.");
     Trace::MousePointerFocused();
     // Cover the entire virtual screen.
@@ -566,6 +575,25 @@ void SuperSonar<D>::UpdateMouseSnooping()
     }
 }
 
+template<typename D>
+bool SuperSonar<D>::IsForegroundAppExcluded()
+{
+    if (m_excludedApps.size() < 1)
+    {
+        return false;
+    }
+    if (HWND foregroundApp{ GetForegroundWindow() })
+    {
+        auto processPath = get_process_path(foregroundApp);
+        CharUpperBuffW(processPath.data(), (DWORD)processPath.length());
+        return find_app_name_in_path(processPath, m_excludedApps);
+    }
+    else
+    {
+        return false;
+    }
+}
+
 struct CompositionSpotlight : SuperSonar<CompositionSpotlight>
 {
     static constexpr UINT WM_OPACITY_ANIMATION_COMPLETED = WM_APP;
@@ -707,6 +735,7 @@ public:
             m_fadeDuration = settings.animationDurationMs > 0 ? settings.animationDurationMs : 1;
             m_finalAlphaNumerator = settings.overlayOpacity;
             m_sonarZoomFactor = settings.spotlightInitialZoom;
+            m_excludedApps = settings.excludedApps;
         }
         else
         {
@@ -727,11 +756,12 @@ public:
                     m_sonarRadiusFloat = static_cast<float>(m_sonarRadius);
                     m_backgroundColor = localSettings.backgroundColor;
                     m_spotlightColor = localSettings.spotlightColor;
-                    m_activationMethod = settings.activationMethod;
+                    m_activationMethod = localSettings.activationMethod;
                     m_doNotActivateOnGameMode = localSettings.doNotActivateOnGameMode;
                     m_fadeDuration = localSettings.animationDurationMs > 0 ? localSettings.animationDurationMs : 1;
                     m_finalAlphaNumerator = localSettings.overlayOpacity;
                     m_sonarZoomFactor = localSettings.spotlightInitialZoom;
+                    m_excludedApps = localSettings.excludedApps;
                     UpdateMouseSnooping(); // For the shake mouse activation method
 
                     // Apply new settings to runtime composition objects.

src/modules/MouseUtils/FindMyMouse/FindMyMouse.h

@@ -27,6 +27,7 @@ struct FindMyMouseSettings
     int spotlightRadius = FIND_MY_MOUSE_DEFAULT_SPOTLIGHT_RADIUS;
     int animationDurationMs = FIND_MY_MOUSE_DEFAULT_ANIMATION_DURATION_MS;
     int spotlightInitialZoom = FIND_MY_MOUSE_DEFAULT_SPOTLIGHT_INITIAL_ZOOM;
+    std::vector<std::wstring> excludedApps;
 };
 
 int FindMyMouseMain(HINSTANCE hinst, const FindMyMouseSettings& settings);

src/modules/MouseUtils/FindMyMouse/dllmain.cpp

@@ -6,6 +6,7 @@
 #include <thread>
 #include <common/utils/logger_helper.h>
 #include <common/utils/color.h>
+#include <common/utils/string_utils.h>
 
 namespace
 {
@@ -19,6 +20,7 @@ namespace
     const wchar_t JSON_KEY_SPOTLIGHT_RADIUS[] = L"spotlight_radius";
     const wchar_t JSON_KEY_ANIMATION_DURATION_MS[] = L"animation_duration_ms";
     const wchar_t JSON_KEY_SPOTLIGHT_INITIAL_ZOOM[] = L"spotlight_initial_zoom";
+    const wchar_t JSON_KEY_EXCLUDED_APPS[] = L"excluded_apps";
 }
 
 extern "C" IMAGE_DOS_HEADER __ImageBase;
@@ -273,6 +275,31 @@ void FindMyMouse::parse_settings(PowerToysSettings::PowerToyValues& settings)
         {
             Logger::warn("Failed to initialize Spotlight Initial Zoom from settings. Will use default value");
         }
+        try
+        {
+            // Parse Excluded Apps
+            auto jsonPropertiesObject = settingsObject.GetNamedObject(JSON_KEY_PROPERTIES).GetNamedObject(JSON_KEY_EXCLUDED_APPS);
+            std::wstring apps = jsonPropertiesObject.GetNamedString(JSON_KEY_VALUE).c_str();
+            std::vector<std::wstring> excludedApps;
+            auto excludedUppercase = apps;
+            CharUpperBuffW(excludedUppercase.data(), (DWORD)excludedUppercase.length());
+            std::wstring_view view(excludedUppercase);
+            view = left_trim<wchar_t>(trim<wchar_t>(view));
+
+            while (!view.empty())
+            {
+                auto pos = (std::min)(view.find_first_of(L"\r\n"), view.length());
+                excludedApps.emplace_back(view.substr(0, pos));
+                view.remove_prefix(pos);
+                view = left_trim<wchar_t>(trim<wchar_t>(view));
+            }
+
+            findMyMouseSettings.excludedApps = excludedApps;
+        }
+        catch (...)
+        {
+            Logger::warn("Failed to initialize Excluded Apps from settings. Will use default value");
+        }
     }
     else
     {