Release v5.4: drop IN_MenuMouse raw-mouse hooks

Author: d3nd3

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## v5.4
+
+- Raw mouse: removed the `IN_MenuMouse` engine hook (SofExe `0x4A420`), Pre/Post callbacks, and `in_menumouse.cpp`. `GetCursorPos` no longer takes a special “real API” path while menu-mouse runs; with raw mouse enabled it always drains pending mickeys and reports the synthetic cursor position like other code paths.
+
 ## v5.3
 
 - Raw mouse: if `RegisterRawInputDevices` returns `ERROR_INVALID_PARAMETER` (87) for focus-following registration (`hwndTarget=NULL`), retry once with an explicit same-process top-level HWND (resolved via `cl_hwnd`, window heuristics, or foreground when it belongs to the game process). Non-null `hwndTarget` must be owned by the calling process; comments in `raw_shared.cpp` document that Win32 rule.

VERSION

@@ -1 +1 @@
-5.3
+5.4

build/generated_detours.cpp

@@ -153,10 +153,6 @@ namespace detour_Sys_SendKeyEvents {
     tSys_SendKeyEvents oSys_SendKeyEvents = nullptr;
 }
 
-namespace detour_IN_MenuMouse {
-    tIN_MenuMouse oIN_MenuMouse = nullptr;
-}
-
 namespace detour_GetCursorPos {
     tGetCursorPos oGetCursorPos = nullptr;
 }
@@ -572,17 +568,6 @@ namespace detour_Sys_SendKeyEvents {
     }
 }
 
-namespace detour_IN_MenuMouse {
-    ManagerType& GetManager() {
-        static ManagerType* instance = nullptr;
-        if (!instance) {
-            static char storage[sizeof(ManagerType)];
-            instance = new(storage) ManagerType();
-        }
-        return *instance;
-    }
-}
-
 namespace detour_GetCursorPos {
     ManagerType& GetManager() {
         static ManagerType* instance = nullptr;
@@ -750,17 +735,6 @@ namespace detour_CinematicFreeze {
     }
 }
 
-namespace detour_IN_MenuMouse {
-    void __cdecl hkIN_MenuMouse(cvar_t* cvar1, cvar_t* cvar2) {
-        ManagerType& mgr = GetManager();
-        if (mgr.GetPreCallbackCount() > 0) mgr.DispatchPre(cvar1, cvar2);
-        if (oIN_MenuMouse) {
-            oIN_MenuMouse(cvar1, cvar2);
-        }
-        if (mgr.GetPostCallbackCount() > 0) mgr.DispatchPost(cvar1, cvar2);
-    }
-}
-
 // Override hooks (hooks.json override: true)
 // Note: Override hooks with custom_detour: true are manually installed at runtime and not generated here
 namespace detour_CL_Precache_f {

build/generated_detours.h

@@ -1006,33 +1006,6 @@ namespace {
     static AutoDetour_Sys_SendKeyEvents g_AutoDetour_Sys_SendKeyEvents;
 }
 
-namespace detour_IN_MenuMouse {
-    using tIN_MenuMouse = void(__cdecl*)(cvar_t* cvar1, cvar_t* cvar2);
-    extern tIN_MenuMouse oIN_MenuMouse;
-    using ManagerType = TypedSharedHookManager<void, cvar_t*, cvar_t*>;
-    ManagerType& GetManager();
-    
-    void __cdecl hkIN_MenuMouse(cvar_t* cvar1, cvar_t* cvar2);
-}
-
-namespace {
-    struct AutoDetour_IN_MenuMouse {
-        AutoDetour_IN_MenuMouse() {
-            using namespace detour_IN_MenuMouse;
-            if (!GetDetourSystem().IsDetourRegistered("IN_MenuMouse")) {
-                GetDetourSystem().RegisterDetour(
-                    reinterpret_cast<void*>(0x0004A420),
-                    reinterpret_cast<void*>(detour_IN_MenuMouse::hkIN_MenuMouse),
-                    reinterpret_cast<void**>(&detour_IN_MenuMouse::oIN_MenuMouse),
-                    "IN_MenuMouse",
-                    DetourModule::SofExe,
-                    static_cast<size_t>(0));
-            }
-        }
-    };
-    static AutoDetour_IN_MenuMouse g_AutoDetour_IN_MenuMouse;
-}
-
 namespace detour_GetCursorPos {
     using tGetCursorPos = BOOL(__stdcall*)(LPPOINT lpPoint);
     extern tGetCursorPos oGetCursorPos;

build/generated_registrations.h

@@ -56,8 +56,6 @@ extern void r_blendlightmaps_post_callback();
 extern void r_blendlightmaps_pre_callback();
 extern void raw_mouse_EarlyStartup();
 extern void raw_mouse_RefDllLoaded(char const* name);
-extern void raw_mouse_in_menumouse_post(cvar_t* cvar1, cvar_t* cvar2);
-extern void raw_mouse_in_menumouse_pre(cvar_t*& cvar1, cvar_t*& cvar2);
 extern void scaledCon_EarlyStartup();
 extern void scaledHud_RefDllLoaded(char const* name);
 extern void scaledUIBase_RefDllLoaded(char const* name);
@@ -161,19 +159,6 @@ inline void RegisterAllFeatureHooks() {
             100);
         PrintOut(PRINT_LOG, "[RegisterAllFeatureHooks] R_BlendLightmaps post callbacks: %zu\n", mgr.GetPostCallbackCount());
     }
-    detour_IN_MenuMouse::GetManager().RegisterPreCallback(
-        "raw_mouse", "raw_mouse_in_menumouse_pre",
-        [](cvar_t*& cvar1, cvar_t*& cvar2) { raw_mouse_in_menumouse_pre(cvar1, cvar2); },
-        0);
-    {
-        auto& mgr = detour_IN_MenuMouse::GetManager();
-        PrintOut(PRINT_LOG, "[RegisterAllFeatureHooks] IN_MenuMouse manager at 0x%p\n", &mgr);
-        mgr.RegisterPostCallback(
-            "raw_mouse", "raw_mouse_in_menumouse_post",
-            [](cvar_t* cvar1, cvar_t* cvar2) { raw_mouse_in_menumouse_post(cvar1, cvar2); },
-            0);
-        PrintOut(PRINT_LOG, "[RegisterAllFeatureHooks] IN_MenuMouse post callbacks: %zu\n", mgr.GetPostCallbackCount());
-    }
     detour_GL_FindImage::GetManager().RegisterPostCallback(
         "scaled_ui_base", "gl_findimage_post_callback",
         [](void* result, char* filename, int imagetype, char mimap, char allowPicmip) { return gl_findimage_post_callback(result, filename, imagetype, mimap, allowPicmip); },

detours.yaml

@@ -431,18 +431,6 @@ functions:
     detour_len: 5
     params: []
 
-  - name: IN_MenuMouse
-    module: SofExe
-    identifier: "0x0004A420"
-    return_type: void
-    calling_convention: __cdecl
-    detour_len: 0
-    params:
-      - type: cvar_t*
-        name: cvar1
-      - type: cvar_t*
-        name: cvar2
-
   - name: GetCursorPos
     module: Unknown
     identifier: "GetCursorPos"

hdr/version.h

@@ -7,4 +7,4 @@
     Increment version using: ./increment_version.sh
 */
 
-#define SOFBUDDY_VERSION "5.3"
+#define SOFBUDDY_VERSION "5.4"

src/features/raw_mouse/README.md

@@ -39,7 +39,7 @@ References: MSDN [GetRawInputBuffer](https://learn.microsoft.com/en-us/windows/w
 - **Sys_SendKeyEvents** – Replaced entirely: `raw_mouse_consume_deltas()`, then `Sys_SendKeyEvents_Replacement()` (capped pump + frame time). Raw-buffer draining now lives in the `GetCursorPos` path.
 
 ## Custom detours
-- **SetCursorPos** (patch + GetProcAddress) – When enabled: treat as recenter; set `window_center`, return TRUE without moving OS cursor. Patched at IN_Frame, IN_MouseMove, IN_MenuMouse. When disabled: real SetCursorPos.
+- **SetCursorPos** (patch + GetProcAddress) – When enabled: treat as recenter; set `window_center`, return TRUE without moving OS cursor. Patched at IN_Frame, IN_MouseMove. When disabled: real SetCursorPos.
 
 ## Technical details
 - **Registration:** `raw_mouse_ensure_registered()` clears stale cached targets, resolves a usable game HWND for clip/focus tracking, and separately ensures the process-level raw mouse registration exists. The Win32 registration path always uses `hwndTarget = NULL` for the normal focused-app case, which removes the usual “bad HWND” source of error 87.

src/features/raw_mouse/hooks/getcursorpos.cpp

@@ -16,11 +16,6 @@ BOOL getcursorpos_override_callback(
     return original(lpPoint);
   }
 
-  if (raw_mouse_in_menumouse_scope()) {
-    SOFBUDDY_ASSERT(original != nullptr);
-    return original(lpPoint);
-  }
-
   raw_mouse_drain_pending_raw_for_cursor();
 
   if (!lpPoint) {

src/features/raw_mouse/hooks/hooks.json

@@ -1,16 +1,4 @@
 [
-  {
-    "function": "IN_MenuMouse",
-    "callback": "raw_mouse_in_menumouse_pre",
-    "phase": "Pre",
-    "priority": 0
-  },
-  {
-    "function": "IN_MenuMouse",
-    "callback": "raw_mouse_in_menumouse_post",
-    "phase": "Post",
-    "priority": 0
-  },
   {
     "function": "GetCursorPos",
     "callback": "getcursorpos_override_callback",