[Breaking change] feat: controller features

MaaXYZ/MaaFramework#815

Author: moomiji

src/MaaFramework.Binding.Native/Extensions/DesktopWindowInfoExtensions.cs

@@ -10,23 +10,25 @@ public static class DesktopWindowInfoExtensions
     /// </summary>
     /// <param name="info">The DesktopWindowInfo.</param>
     /// <param name="screencapMethod">The screencap method.</param>
-    /// <param name="inputMethod">The input method.</param>
+    /// <param name="mouseMethod">The mouse method.</param>
+    /// <param name="keyboardMethod">The keyboard method.</param>
     /// <param name="hWnd">The new handle to a win32 window.</param>
     /// <param name="link">Executes <see cref="MaaController.LinkStart"/> if <see cref="LinkOption.Start"/>; otherwise, not link.</param>
     /// <param name="check">Checks LinkStart().Wait() status if <see cref="CheckStatusOption.ThrowIfNotSucceeded"/>; otherwise, not check.</param>
     /// <returns>A MaaWin32Controller.</returns>
     /// <exception cref="ArgumentNullException"/>
     public static MaaWin32Controller ToWin32Controller(this DesktopWindowInfo info,
         Win32ScreencapMethod screencapMethod,
-        Win32InputMethod inputMethod,
+        Win32InputMethod mouseMethod,
+        Win32InputMethod keyboardMethod,
         nint? hWnd = null,
         LinkOption link = LinkOption.Start,
         CheckStatusOption check = CheckStatusOption.ThrowIfNotSucceeded)
     {
         ArgumentNullException.ThrowIfNull(info);
 
         return hWnd.HasValue
-            ? new MaaWin32Controller(hWnd.Value, screencapMethod, inputMethod, link, check)
-            : new MaaWin32Controller(info, screencapMethod, inputMethod, link, check);
+            ? new MaaWin32Controller(hWnd.Value, screencapMethod, mouseMethod, keyboardMethod, link, check)
+            : new MaaWin32Controller(info, screencapMethod, mouseMethod, keyboardMethod, link, check);
     }
 }

src/MaaFramework.Binding.UnitTests/Test_Custom.cs

@@ -71,6 +71,8 @@ public bool Analyze(in IMaaContext context, in AnalyzeArgs args, in AnalyzeResul
 
             var recognitionDetail =
                 context.RunRecognition(DiffEntry, args.Image, DiffParam);
+            Assert.IsFalse(
+                context.GetNodeData(DiffEntry, out data));
             Assert.IsNotNull(
                 recognitionDetail?.HitBox);
 
@@ -81,16 +83,14 @@ public bool Analyze(in IMaaContext context, in AnalyzeArgs args, in AnalyzeResul
             Assert.IsTrue(
                 cloneContext.OverrideNext(DiffEntry, [DiffEntry]));
 
+            Assert.IsFalse(
+                context.GetNodeData(DiffEntry, out data));
             Assert.IsTrue(
                 cloneContext.GetNodeData(DiffEntry, out data));
             Assert.IsNotNull(data);
             Assert.IsTrue(
                 data.Contains($"\"next\":[\"{DiffEntry}\"]"));
 
-            Assert.IsTrue(
-                context.GetNodeData(DiffEntry, out data));
-            Assert.IsFalse(
-                data.Contains($"\"next\":[\"{DiffEntry}\"]"));
 
             Assert.IsTrue(
                 recognitionDetail.HitBox.TryCopyTo(results.Box));
@@ -212,6 +212,8 @@ public bool RequestUuid(in IMaaStringBuffer buffer)
             return uuid is not null && buffer.TrySetValue(uuid);
         }
 
+        public ControllerFeatures GetFeatures() => ControllerFeatures.None;
+
         public bool Screencap(in IMaaImageBuffer buffer)
             => c.Screencap().Wait().IsSucceeded() && c.GetCachedImage(buffer);
 

src/MaaFramework.Binding.UnitTests/Test_IMaaAgentClient.cs

@@ -152,7 +152,7 @@ public void Case_RunTask(MaaTypes type, IMaaAgentClient maaAgentClient)
         using (var cts = new CancellationTokenSource(10 * 1000))
         {
             Assert.IsTrue(
-            //  agent.LinkStart());
+                // agent.LinkStart());
                 agent.LinkStart(StartupAgentServer, cts.Token));
         }
         var status = maa

src/MaaFramework.Binding.UnitTests/Test_IMaaController.cs

@@ -119,16 +119,19 @@ public void CreateInstances()
         using var win32Native1 = new MaaWin32Controller(
             windowInfo.Handle,
             Win32ScreencapMethod.GDI,
+            Win32InputMethod.SendMessage,
             Win32InputMethod.SendMessage);
         using var win32Native2 = new MaaWin32Controller(
             windowInfo.Handle,
             Win32ScreencapMethod.GDI,
             Win32InputMethod.SendMessage,
+            Win32InputMethod.SendMessage,
             LinkOption.None);
         using var win32Native3 = new MaaWin32Controller(
             windowInfo.Handle,
             Win32ScreencapMethod.GDI,
             Win32InputMethod.SendMessage,
+            Win32InputMethod.SendMessage,
             LinkOption.Start,
             CheckStatusOption.None);
         #endregion
@@ -387,8 +390,8 @@ public void CreateInvalidInstances()
 
 #if !GITHUB_ACTIONS
         #region MaaWin32Controller
-        Assert.ThrowsExactly<ArgumentException>(static () => new MaaWin32Controller(1, Win32ScreencapMethod.None, Win32InputMethod.Seize));
-        Assert.ThrowsExactly<ArgumentException>(static () => new MaaWin32Controller(1, Win32ScreencapMethod.GDI, Win32InputMethod.None));
+        Assert.ThrowsExactly<ArgumentException>(static () => new MaaWin32Controller(1, Win32ScreencapMethod.None, Win32InputMethod.Seize, Win32InputMethod.Seize));
+        Assert.ThrowsExactly<ArgumentException>(static () => new MaaWin32Controller(1, Win32ScreencapMethod.GDI, Win32InputMethod.None, Win32InputMethod.None));
         #endregion
 #endif
 #endif

src/MaaFramework.Binding.UnitTests/Test_IMaaToolkit.cs

@@ -104,7 +104,8 @@ private static void Test_Win32_WindowInfos(MaaTypes type, IList<DesktopWindowInf
         {
             MaaTypes.Native => windows[0].ToWin32Controller(
                 screencapMethod: Win32ScreencapMethod.GDI,
-                inputMethod: Win32InputMethod.SendMessage,
+                mouseMethod: Win32InputMethod.SendMessage,
+                keyboardMethod: Win32InputMethod.SendMessage,
                 link: LinkOption.None),
             _ => throw new NotImplementedException(),
         };
@@ -118,7 +119,8 @@ private static void Test_Win32_WindowInfos(MaaTypes type, IList<DesktopWindowInf
         {
             MaaTypes.Native => windows[0].ToWin32Controller(
                 screencapMethod: Win32ScreencapMethod.GDI,
-                inputMethod: Win32InputMethod.SendMessage),
+                mouseMethod: Win32InputMethod.SendMessage,
+                keyboardMethod: Win32InputMethod.SendMessage),
             _ => throw new NotImplementedException(),
         };
 #endif

src/MaaFramework.Binding/Custom/IMaaCustomController.cs

@@ -15,6 +15,7 @@ public interface IMaaCustomController : IMaaCustomResource, IDisposable
     ///     Write result to buffer.
     /// </remarks>
     bool RequestUuid(in IMaaStringBuffer buffer);
+    ControllerFeatures GetFeatures();
 
     /// <remarks>
     ///     Write result to width and height.

src/MaaFramework.Binding/Enums/ControllerFeatures.cs

@@ -0,0 +1,22 @@
+//------------------------------------------------------------------------------
+// <auto-generated>
+//     This code was generated by a tool.
+//
+//     Changes to this file may cause incorrect behavior and will be lost if
+//     the code is regenerated.
+// </auto-generated>
+//------------------------------------------------------------------------------
+
+#pragma warning disable CS1573 // 参数在 XML 注释中没有匹配的 param 标记
+#pragma warning disable CS1591 // 缺少对公共可见类型或成员的 XML 注释
+
+namespace MaaFramework.Binding;
+
+[Flags]
+public enum ControllerFeatures : System.UInt64
+{
+    None = 0,
+    UseMouseDownAndUpInsteadOfClick = 1,
+    UseKeyboardDownAndUpInsteadOfClick = (1 << 1),
+}
+