-
Notifications
You must be signed in to change notification settings - Fork 282
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
4be635b
commit 0afb3d2
Showing
6 changed files
with
294 additions
and
290 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,144 @@ | ||
| using System.Runtime.InteropServices; | ||
|
|
||
| using TerraFX.Interop.Windows; | ||
|
|
||
| using static TerraFX.Interop.Windows.Windows; | ||
|
|
||
| namespace Dalamud.Hooking.WndProcHook; | ||
|
|
||
| /// <summary> | ||
| /// Event arguments for <see cref="WndProcEventDelegate"/>, | ||
| /// and the manager for individual WndProc hook. | ||
| /// </summary> | ||
| internal sealed unsafe class WndProcEventArgs | ||
| { | ||
| private readonly WndProcHookManager owner; | ||
| private readonly delegate* unmanaged<HWND, uint, WPARAM, LPARAM, LRESULT> oldWndProcW; | ||
| private readonly WndProcDelegate myWndProc; | ||
|
|
||
| private GCHandle gcHandle; | ||
| private bool released; | ||
|
|
||
| /// <summary> | ||
| /// Initializes a new instance of the <see cref="WndProcEventArgs"/> class. | ||
| /// </summary> | ||
| /// <param name="owner">The owner.</param> | ||
| /// <param name="hwnd">The handle of the target window of the message.</param> | ||
| /// <param name="viewportId">The viewport ID.</param> | ||
| internal WndProcEventArgs(WndProcHookManager owner, HWND hwnd, int viewportId) | ||
| { | ||
| this.Hwnd = hwnd; | ||
| this.owner = owner; | ||
| this.ViewportId = viewportId; | ||
| this.myWndProc = this.WndProcDetour; | ||
| this.oldWndProcW = (delegate* unmanaged<HWND, uint, WPARAM, LPARAM, LRESULT>)SetWindowLongPtrW( | ||
| hwnd, | ||
| GWLP.GWLP_WNDPROC, | ||
| Marshal.GetFunctionPointerForDelegate(this.myWndProc)); | ||
| this.gcHandle = GCHandle.Alloc(this); | ||
| } | ||
|
|
||
| [UnmanagedFunctionPointer(CallingConvention.StdCall)] | ||
| private delegate LRESULT WndProcDelegate(HWND hwnd, uint uMsg, WPARAM wParam, LPARAM lParam); | ||
|
|
||
| /// <summary> | ||
| /// Gets the handle of the target window of the message. | ||
| /// </summary> | ||
| public HWND Hwnd { get; } | ||
|
|
||
| /// <summary> | ||
| /// Gets the ImGui viewport ID. | ||
| /// </summary> | ||
| public int ViewportId { get; } | ||
|
|
||
| /// <summary> | ||
| /// Gets or sets the message. | ||
| /// </summary> | ||
| public uint Message { get; set; } | ||
|
|
||
| /// <summary> | ||
| /// Gets or sets the WPARAM. | ||
| /// </summary> | ||
| public WPARAM WParam { get; set; } | ||
|
|
||
| /// <summary> | ||
| /// Gets or sets the LPARAM. | ||
| /// </summary> | ||
| public LPARAM LParam { get; set; } | ||
|
|
||
| /// <summary> | ||
| /// Gets or sets a value indicating whether to suppress calling the next WndProc in the chain.<br /> | ||
| /// Does nothing if changed from <see cref="WndProcHookManager.PostWndProc"/>. | ||
| /// </summary> | ||
| public bool SuppressCall { get; set; } | ||
|
|
||
| /// <summary> | ||
| /// Gets or sets the return value.<br /> | ||
| /// Has the return value from next window procedure, if accessed from <see cref="WndProcHookManager.PostWndProc"/>. | ||
| /// </summary> | ||
| public LRESULT ReturnValue { get; set; } | ||
|
|
||
| /// <summary> | ||
| /// Sets <see cref="SuppressCall"/> to <c>true</c> and sets <see cref="ReturnValue"/>. | ||
| /// </summary> | ||
| /// <param name="returnValue">The new return value.</param> | ||
| public void SuppressWithValue(LRESULT returnValue) | ||
| { | ||
| this.ReturnValue = returnValue; | ||
| this.SuppressCall = true; | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Sets <see cref="SuppressCall"/> to <c>true</c> and sets <see cref="ReturnValue"/> from the result of | ||
| /// <see cref="DefWindowProcW"/>. | ||
| /// </summary> | ||
| public void SuppressWithDefault() | ||
| { | ||
| this.ReturnValue = DefWindowProcW(this.Hwnd, this.Message, this.WParam, this.LParam); | ||
| this.SuppressCall = true; | ||
| } | ||
|
|
||
| /// <inheritdoc cref="IDisposable.Dispose"/> | ||
| internal void InternalRelease() | ||
| { | ||
| if (this.released) | ||
| return; | ||
|
|
||
| this.released = true; | ||
| SendMessageW(this.Hwnd, WM.WM_NULL, 0, 0); | ||
| this.FinalRelease(); | ||
| } | ||
|
|
||
| private void FinalRelease() | ||
| { | ||
| if (!this.gcHandle.IsAllocated) | ||
| return; | ||
|
|
||
| this.gcHandle.Free(); | ||
| SetWindowLongPtrW(this.Hwnd, GWLP.GWLP_WNDPROC, (nint)this.oldWndProcW); | ||
| this.owner.OnHookedWindowRemoved(this); | ||
| } | ||
|
|
||
| private LRESULT WndProcDetour(HWND hwnd, uint uMsg, WPARAM wParam, LPARAM lParam) | ||
| { | ||
| if (hwnd != this.Hwnd) | ||
| return CallWindowProcW(this.oldWndProcW, hwnd, uMsg, wParam, lParam); | ||
|
|
||
| this.SuppressCall = false; | ||
| this.ReturnValue = 0; | ||
| this.Message = uMsg; | ||
| this.WParam = wParam; | ||
| this.LParam = lParam; | ||
| this.owner.InvokePreWndProc(this); | ||
|
|
||
| if (!this.SuppressCall) | ||
| this.ReturnValue = CallWindowProcW(this.oldWndProcW, hwnd, uMsg, wParam, lParam); | ||
|
|
||
| this.owner.InvokePostWndProc(this); | ||
|
|
||
| if (uMsg == WM.WM_NCDESTROY || this.released) | ||
| this.FinalRelease(); | ||
|
|
||
| return this.ReturnValue; | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| namespace Dalamud.Hooking.WndProcHook; | ||
|
|
||
| /// <summary> | ||
| /// Delegate for overriding WndProc. | ||
| /// </summary> | ||
| /// <param name="args">The arguments.</param> | ||
| internal delegate void WndProcEventDelegate(WndProcEventArgs args); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,115 @@ | ||
| using System.Collections.Generic; | ||
| using System.Runtime.InteropServices; | ||
|
|
||
| using Dalamud.Interface.Utility; | ||
| using Dalamud.Logging.Internal; | ||
|
|
||
| using TerraFX.Interop.Windows; | ||
|
|
||
| using static TerraFX.Interop.Windows.Windows; | ||
|
|
||
| namespace Dalamud.Hooking.WndProcHook; | ||
|
|
||
| /// <summary> | ||
| /// Manages WndProc hooks for game main window and extra ImGui viewport windows. | ||
| /// </summary> | ||
| [ServiceManager.BlockingEarlyLoadedService] | ||
| internal sealed class WndProcHookManager : IServiceType, IDisposable | ||
| { | ||
| private static readonly ModuleLog Log = new(nameof(WndProcHookManager)); | ||
|
|
||
| private readonly Hook<DispatchMessageWDelegate> dispatchMessageWHook; | ||
| private readonly Dictionary<HWND, WndProcEventArgs> wndProcOverrides = new(); | ||
|
|
||
| [ServiceManager.ServiceConstructor] | ||
| private unsafe WndProcHookManager() | ||
| { | ||
| this.dispatchMessageWHook = Hook<DispatchMessageWDelegate>.FromImport( | ||
| null, | ||
| "user32.dll", | ||
| "DispatchMessageW", | ||
| 0, | ||
| this.DispatchMessageWDetour); | ||
| this.dispatchMessageWHook.Enable(); | ||
| } | ||
|
|
||
| [UnmanagedFunctionPointer(CallingConvention.StdCall)] | ||
| private unsafe delegate nint DispatchMessageWDelegate(MSG* msg); | ||
|
|
||
| /// <summary> | ||
| /// Called before WndProc. | ||
| /// </summary> | ||
| public event WndProcEventDelegate? PreWndProc; | ||
|
|
||
| /// <summary> | ||
| /// Called after WndProc. | ||
| /// </summary> | ||
| public event WndProcEventDelegate? PostWndProc; | ||
|
|
||
| /// <inheritdoc/> | ||
| public void Dispose() | ||
| { | ||
| this.dispatchMessageWHook.Dispose(); | ||
| foreach (var v in this.wndProcOverrides.Values) | ||
| v.InternalRelease(); | ||
| this.wndProcOverrides.Clear(); | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Invokes <see cref="PreWndProc"/>. | ||
| /// </summary> | ||
| /// <param name="args">The arguments.</param> | ||
| internal void InvokePreWndProc(WndProcEventArgs args) | ||
| { | ||
| try | ||
| { | ||
| this.PreWndProc?.Invoke(args); | ||
| } | ||
| catch (Exception e) | ||
| { | ||
| Log.Error(e, $"{nameof(this.PreWndProc)} error"); | ||
| } | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Invokes <see cref="PostWndProc"/>. | ||
| /// </summary> | ||
| /// <param name="args">The arguments.</param> | ||
| internal void InvokePostWndProc(WndProcEventArgs args) | ||
| { | ||
| try | ||
| { | ||
| this.PostWndProc?.Invoke(args); | ||
| } | ||
| catch (Exception e) | ||
| { | ||
| Log.Error(e, $"{nameof(this.PostWndProc)} error"); | ||
| } | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Removes <paramref name="args"/> from the list of known WndProc overrides. | ||
| /// </summary> | ||
| /// <param name="args">Object to remove.</param> | ||
| internal void OnHookedWindowRemoved(WndProcEventArgs args) | ||
| { | ||
| if (!this.dispatchMessageWHook.IsDisposed) | ||
| this.wndProcOverrides.Remove(args.Hwnd); | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Detour for <see cref="DispatchMessageW"/>. Used to discover new windows to hook. | ||
| /// </summary> | ||
| /// <param name="msg">The message.</param> | ||
| /// <returns>The original return value.</returns> | ||
| private unsafe nint DispatchMessageWDetour(MSG* msg) | ||
| { | ||
| if (!this.wndProcOverrides.ContainsKey(msg->hwnd) | ||
| && ImGuiHelpers.FindViewportId(msg->hwnd) is var vpid and >= 0) | ||
| { | ||
| this.wndProcOverrides[msg->hwnd] = new(this, msg->hwnd, vpid); | ||
| } | ||
|
|
||
| return this.dispatchMessageWHook.Original(msg); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.