[FindMyMouse]Do not activate on game mode (#13990)

* [FindMyMouse] Do not activate on game mode

* Add settings scaffolding

* fix spellchecker

* Address PR comments

* Adress UI feedback

src/modules/MouseUtils/FindMyMouse/FindMyMouse.cpp

@@ -3,6 +3,7 @@
 #include "pch.h"
 #include "FindMyMouse.h"
 #include "trace.h"
+#include "common/utils/game_mode.h"
 
 #ifdef COMPOSITION
 namespace winrt
@@ -18,6 +19,8 @@ namespace ABI
 }
 #endif
 
+bool m_doNotActivateOnGameMode = true;
+
 #pragma region Super_Sonar_Base_Code
 
 template<typename D>
@@ -250,6 +253,12 @@ void SuperSonar<D>::OnSonarInput(WPARAM flags, HRAWINPUT hInput)
 template<typename D>
 void SuperSonar<D>::OnSonarKeyboardInput(RAWINPUT const& input)
 {
+    // Don't activate if game mode is on.
+    if (m_doNotActivateOnGameMode && detect_game_mode())
+    {
+        return;
+    }
+
     if (input.data.keyboard.VKey != VK_CONTROL)
     {
         StopSonar();
@@ -777,6 +786,11 @@ bool FindMyMouseIsEnabled()
     return (m_sonar != nullptr);
 }
 
+void FindMyMouseSetDoNotActivateOnGameMode(bool doNotActivate)
+{
+    m_doNotActivateOnGameMode = doNotActivate;
+}
+
 // Based on SuperSonar's original wWinMain.
 int FindMyMouseMain(HINSTANCE hinst)
 {

src/modules/MouseUtils/FindMyMouse/FindMyMouse.h

@@ -3,4 +3,4 @@
 int FindMyMouseMain(HINSTANCE hinst);
 void FindMyMouseDisable();
 bool FindMyMouseIsEnabled();
-
+void FindMyMouseSetDoNotActivateOnGameMode(bool doNotActivate);

src/modules/MouseUtils/FindMyMouse/dllmain.cpp

@@ -6,6 +6,14 @@
 #include <thread>
 #include <common/utils/logger_helper.h>
 
+
+namespace
+{
+    const wchar_t JSON_KEY_PROPERTIES[] = L"properties";
+    const wchar_t JSON_KEY_VALUE[] = L"value";
+    const wchar_t JSON_KEY_DO_NOT_ACTIVATE_ON_GAME_MODE[] = L"do_not_activate_on_game_mode";
+}
+
 extern "C" IMAGE_DOS_HEADER __ImageBase;
 
 HMODULE m_hModule;
@@ -43,6 +51,9 @@ private:
     // Load initial settings from the persisted values.
     void init_settings();
 
+    // Helper function to extract the settings
+    void parse_settings(PowerToysSettings::PowerToyValues& settings);
+
 public:
     // Constructor
     FindMyMouse()
@@ -96,6 +107,8 @@ public:
             PowerToysSettings::PowerToyValues values =
                 PowerToysSettings::PowerToyValues::from_json_string(config, get_key());
 
+            parse_settings(values);
+
             values.save_to_settings_file();
         }
         catch (std::exception&)
@@ -135,6 +148,7 @@ void FindMyMouse::init_settings()
         // Load and parse the settings file for this PowerToy.
         PowerToysSettings::PowerToyValues settings =
             PowerToysSettings::PowerToyValues::load_from_settings_file(FindMyMouse::get_key());
+        parse_settings(settings);
     }
     catch (std::exception&)
     {
@@ -142,6 +156,30 @@ void FindMyMouse::init_settings()
     }
 }
 
+void FindMyMouse::parse_settings(PowerToysSettings::PowerToyValues& settings)
+{
+    FindMyMouseSetDoNotActivateOnGameMode(true);
+
+    auto settingsObject = settings.get_raw_json();
+    if (settingsObject.GetView().Size())
+    {
+        try
+        {
+            auto jsonPropertiesObject = settingsObject.GetNamedObject(JSON_KEY_PROPERTIES).GetNamedObject(JSON_KEY_DO_NOT_ACTIVATE_ON_GAME_MODE);
+            FindMyMouseSetDoNotActivateOnGameMode((bool)jsonPropertiesObject.GetNamedBoolean(JSON_KEY_VALUE));
+        }
+        catch (...)
+        {
+            Logger::warn("Failed to get 'do not activate on game mode' setting");
+        }
+    }
+    else
+    {
+        Logger::info("Find My Mouse settings are empty");
+    }
+}
+
+
 extern "C" __declspec(dllexport) PowertoyModuleIface* __cdecl powertoy_create()
 {
     return new FindMyMouse();