Improve Scroll API and docs (#43)

lucassklp · web-flow · commit c1e0abe976d4 · 2023-07-03T21:59:16.000+01:00
* Add duration and steps

* Fix tests and improve API

* Making code more simple

* Fixing the direction for linux
diff --git a/Desktop.Robot.TestApp/MouseTests.fs b/Desktop.Robot.TestApp/MouseTests.fs
@@ -112,10 +112,11 @@ let tests (window:Window) = testList "Mouse tests" [
 
     uiTest "Can scroll vertical" <| async {
         let wheelDeltas = window.PointerWheelChanged.Select(fun x -> x.Delta)
-
+        let robot = Robot();
+        robot.AutoDelay <- 100;
         let! deltaEvents = attemptUIActionList wheelDeltas <| async {
-            Robot().MouseScrollVertical(100) // scroll down
-            Robot().MouseScrollVertical(-100) // then scroll up
+            robot.MouseScroll(100) // scroll down
+            robot.MouseScroll(-100) // then scroll up
         }
         Expect.hasLength deltaEvents 2 "Should have a wheel event for each mouse scroll"
         let xDeltas = deltaEvents |> List.map (fun p -> p.X)
diff --git a/Desktop.Robot/AbstractRobot.cs b/Desktop.Robot/AbstractRobot.cs
@@ -1,4 +1,5 @@
 ﻿using Desktop.Robot.Clicks;
+using System;
 using System.Drawing;
 using System.Drawing.Imaging;
 using System.Threading;
@@ -7,7 +8,7 @@ namespace Desktop.Robot
 {
     public abstract class AbstractRobot : IRobot
     {
-        public uint AutoDelay { get; set; }
+        public int AutoDelay { get; set; }
 
         public abstract Point GetMousePosition();
 
@@ -25,7 +26,11 @@ public abstract class AbstractRobot : IRobot
 
         public abstract void MouseMove(int x, int y);
 
-        public abstract void MouseScrollVertical(int value);
+        public abstract void MouseScroll(int value);
+
+        public abstract void MouseScroll(int value, TimeSpan duration);
+
+        public abstract void MouseScroll(int value, TimeSpan duration, int steps);
 
         public void MouseMove(Point p) 
         {
@@ -64,17 +69,14 @@ public void MouseUp(IClick click)
             click.ExecuteMouseUp(new MouseContext(GetMousePosition()));
         }
 
-        public void Delay(uint ms)
+        public void Delay(int ms)
         {
-            Thread.Sleep((int)ms);
+            Thread.Sleep(ms);
         }
 
         protected void ApplyAutoDelay()
         {
-            if (AutoDelay > 0)
-            {
-                Thread.Sleep((int)AutoDelay);
-            }
+            Thread.Sleep(AutoDelay);    
         }
-	}
+    }
 }
diff --git a/Desktop.Robot/Clicks/IClick.cs b/Desktop.Robot/Clicks/IClick.cs
@@ -1,5 +1,4 @@
-﻿using System;
-using System.Threading;
+﻿using System.Threading;
 
 namespace Desktop.Robot.Clicks
 {
diff --git a/Desktop.Robot/Clicks/Linux/MiddleClick.cs b/Desktop.Robot/Clicks/Linux/MiddleClick.cs
@@ -1,5 +1,4 @@
-﻿using System;
-namespace Desktop.Robot.Clicks.Linux
+﻿namespace Desktop.Robot.Clicks.Linux
 {
     internal record MiddleClick(int delay) : IClick
     {
diff --git a/Desktop.Robot/Clicks/MouseContext.cs b/Desktop.Robot/Clicks/MouseContext.cs
@@ -1,5 +1,4 @@
-﻿using System;
-using System.Drawing;
+﻿using System.Drawing;
 
 namespace Desktop.Robot.Clicks
 {
diff --git a/Desktop.Robot/Desktop.Robot.csproj b/Desktop.Robot/Desktop.Robot.csproj
@@ -1,19 +1,21 @@
 ﻿<Project Sdk="Microsoft.NET.Sdk">
   <PropertyGroup>
     <TargetFramework>net6.0</TargetFramework>
-    <Version>1.4.0</Version>
+    <Version>1.4.1</Version>
     <GeneratePackageOnBuild>true</GeneratePackageOnBuild>
     <Authors>Lucas Simas</Authors>
     <Description>A library used to control your mouse and keyboard programmatically in .NET Core</Description>
     <PackageProjectUrl>https://lucassklp.github.io/Desktop.Robot/</PackageProjectUrl>
     <RepositoryUrl>https://github.com/lucassklp/Desktop.Robot</RepositoryUrl>
     <PackageIcon>logo.mini.png</PackageIcon>
     <PackageLicenseFile>LICENSE</PackageLicenseFile>
+    <PackageReadmeFile>README.md</PackageReadmeFile>
   </PropertyGroup>
 
   <ItemGroup>
     <None Include="..\LICENSE" Pack="true" PackagePath="\" />
     <None Include="..\Resources\logo.mini.png" Pack="true" PackagePath="\" />
+    <None Include="..\README.md" Pack="true" PackagePath="\" />
   </ItemGroup>
 
   <ItemGroup>
diff --git a/Desktop.Robot/Extensions/BezierMouseMovementExtension.cs b/Desktop.Robot/Extensions/BezierMouseMovementExtension.cs
@@ -46,13 +46,13 @@ public static void BezierMovement(this IRobot robot, Point initial, Point contro
                 points.Add(GetPoint(t, initial, controlPoint, ending));
             }
 
-            var interval = duration.TotalMilliseconds / points.Count;
+            var interval = Convert.ToInt32(duration.TotalMilliseconds / points.Count);
 
             robot.MouseMove(initial);
 
             //Avoiding AutoDelay
             var currentAutoDelay = robot.AutoDelay;
-            robot.AutoDelay = (uint)interval;
+            robot.AutoDelay = interval;
 
             foreach (var point in points)
             {
diff --git a/Desktop.Robot/Extensions/ListenersExtension.cs b/Desktop.Robot/Extensions/ListenersExtension.cs
@@ -1,11 +1,8 @@
 ﻿using System;
-using System.Diagnostics;
 using System.Drawing;
 using System.Reactive.Concurrency;
 using System.Reactive.Disposables;
 using System.Reactive.Linq;
-using System.Runtime.CompilerServices;
-using System.Runtime.InteropServices;
 using System.Threading;
 
 namespace Desktop.Robot.Extensions
diff --git a/Desktop.Robot/Extensions/TypingExtension.cs b/Desktop.Robot/Extensions/TypingExtension.cs
@@ -14,9 +14,9 @@ public static IRobot Type(this IRobot robot, string text)
             return robot;
         }
 
-        public static IRobot Type(this IRobot robot, string text, uint delay)
+        public static IRobot Type(this IRobot robot, string text, int delay)
         {
-            Thread.Sleep((int)robot.AutoDelay);
+            Thread.Sleep(robot.AutoDelay);
             var currentDelay = robot.AutoDelay;
             robot.AutoDelay = delay;
             foreach (var ch in text)
diff --git a/Desktop.Robot/IRobot.cs b/Desktop.Robot/IRobot.cs
@@ -1,11 +1,12 @@
-﻿using System.Drawing;
+﻿using System;
+using System.Drawing;
 using Desktop.Robot.Clicks;
 
 namespace Desktop.Robot
 {
     public interface IRobot
     {
-        uint AutoDelay { get; set; }
+        int AutoDelay { get; set; }
         Image CreateScreenCapture(Rectangle screenRect);
         Color GetPixelColor(int x, int y);
         void KeyPress(Key key);
@@ -17,10 +18,12 @@ public interface IRobot
         void Click(IClick click);
         void MouseDown(IClick click);
         void MouseUp(IClick click);
-        void Delay(uint ms);
+        void Delay(int ms);
         void MouseMove(int x, int y);
         void MouseMove(Point p);
-        void MouseScrollVertical(int value);
+        void MouseScroll(int value);
+        void MouseScroll(int value, TimeSpan duration);
+        void MouseScroll(int value, TimeSpan duration, int steps);
         Point GetMousePosition();
     }
 }
diff --git a/Desktop.Robot/Key.cs b/Desktop.Robot/Key.cs
@@ -1,5 +1,3 @@
-using System;
-using System.Collections.Generic;
 using System.Linq;
 using System.Runtime.InteropServices;
 
diff --git a/Desktop.Robot/Linux/Robot.cs b/Desktop.Robot/Linux/Robot.cs
@@ -69,22 +69,43 @@ public override void MouseMove(int x, int y)
             moveMouse(x, y);
         }
 
-        public override void MouseScrollVertical(int value)
+
+        public override void MouseScroll(int value)
+        {
+            ApplyAutoDelay();
+            DoMouseScroll(value, 100);
+        }
+
+        public override void MouseScroll(int value, TimeSpan duration)
+        {
+            MouseScroll(value, duration, 100);
+        }
+
+        public override void MouseScroll(int value, TimeSpan duration, int steps)
+        {
+            ApplyAutoDelay();
+            for (int i = 0; i < steps; i++)
+            {
+                DoMouseScroll(value / steps, Convert.ToInt32(duration.TotalMilliseconds) / steps);
+            }
+        }
+
+        private void DoMouseScroll(int value, int duration)
         {
             do
             {
                 if (value < 0)
                 {
-                    click(true, Common.UP_BUTTON);
-                    Thread.Sleep(100);
-                    click(false, Common.UP_BUTTON);
+                    click(true, Common.DOWN_BUTTON);
+                    Thread.Sleep(duration);
+                    click(false, Common.DOWN_BUTTON);
                     value++;
                 }
                 else
                 {
-                    click(true, Common.DOWN_BUTTON);
-                    Thread.Sleep(100);
-                    click(false, Common.DOWN_BUTTON);
+                    click(true, Common.UP_BUTTON);
+                    Thread.Sleep(duration);
+                    click(false, Common.UP_BUTTON);
                     value--;
                 }
             }
diff --git a/Desktop.Robot/OSX/Robot.cs b/Desktop.Robot/OSX/Robot.cs
@@ -2,6 +2,7 @@
 using System.Drawing;
 using System.Linq;
 using System.Runtime.InteropServices;
+using System.Threading;
 
 namespace Desktop.Robot.OSX
 {
@@ -67,12 +68,33 @@ public override Point GetMousePosition()
             return new Point(coords[0], screenRes[1] - coords[1]);
         }
 
-		public override void MouseScrollVertical(int value)
-		{
-			verticalScroll(value);
-		}
+        public override void MouseScroll(int value)
+        {
+            ApplyAutoDelay();
+            DoMouseScroll(value);
+        }
+
+        public override void MouseScroll(int value, TimeSpan duration)
+        {
+            MouseScroll(value, duration, 50);
+        }
+
+        public override void MouseScroll(int value, TimeSpan duration, int steps)
+        {
+            ApplyAutoDelay();
+            for (int i = 0; i < steps; i++)
+            {
+                Thread.Sleep(duration / steps);
+                DoMouseScroll(value / steps);
+            }
+        }
+        private void DoMouseScroll(int value)
+        {
+            verticalScroll(value);
+        }
+
 
-		[DllImport("./osx.os", EntryPoint = "setMousePosition")]
+        [DllImport("./osx.os", EntryPoint = "setMousePosition")]
         private static extern void setMousePosition(int x, int y);
 
         [DllImport("./osx.os", EntryPoint = "getMousePosition")]
diff --git a/Desktop.Robot/Robot.cs b/Desktop.Robot/Robot.cs
@@ -29,7 +29,7 @@ public Robot()
             }
         }
 
-        public uint AutoDelay { get => robot.AutoDelay; set => robot.AutoDelay = value; }
+        public int AutoDelay { get => robot.AutoDelay; set => robot.AutoDelay = value; }
 
         public void Click(IClick click)
         {
@@ -41,7 +41,7 @@ public Image CreateScreenCapture(Rectangle screenRect)
             return robot.CreateScreenCapture(screenRect);
         }
 
-        public void Delay(uint ms)
+        public void Delay(int ms)
         {
             robot.Delay(ms);
         }
@@ -102,12 +102,22 @@ public void MouseMove(Point p)
             robot.MouseMove(p);
         }
 
-		public void MouseScrollVertical(int value)
-		{
-            robot.MouseScrollVertical(value);
-		}
+        public void MouseScroll(int value)
+        {
+            robot.MouseScroll(-1 * value);
+        }
+
+        public void MouseScroll(int value, TimeSpan duration)
+        {
+            robot.MouseScroll(-1 * value, duration);
+        }
+
+        public void MouseScroll(int value, TimeSpan duration, int steps)
+        {
+            robot.MouseScroll(-1 * value, duration, steps); 
+        }
 
-		public void MouseUp(IClick click)
+        public void MouseUp(IClick click)
         {
             robot.MouseUp(click);
         }
diff --git a/Desktop.Robot/Windows/Robot.cs b/Desktop.Robot/Windows/Robot.cs
diff --git a/Example/Program.cs b/Example/Program.cs
diff --git a/README.md b/README.md

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`using Desktop.Robot.Clicks;`
	`2`	`+using System;`
`2`	`3`	`using System.Drawing;`
`3`	`4`	`using System.Drawing.Imaging;`
`4`	`5`	`using System.Threading;`
`@@ -7,7 +8,7 @@ namespace Desktop.Robot`
`7`	`8`	`{`
`8`	`9`	`public abstract class AbstractRobot : IRobot`
`9`	`10`	`{`
`10`		`- public uint AutoDelay { get; set; }`
	`11`	`+ public int AutoDelay { get; set; }`
`11`	`12`
`12`	`13`	`public abstract Point GetMousePosition();`
`13`	`14`
`@@ -25,7 +26,11 @@ public abstract class AbstractRobot : IRobot`
`25`	`26`
`26`	`27`	`public abstract void MouseMove(int x, int y);`
`27`	`28`
`28`		`- public abstract void MouseScrollVertical(int value);`
	`29`	`+ public abstract void MouseScroll(int value);`
	`30`	`+`
	`31`	`+ public abstract void MouseScroll(int value, TimeSpan duration);`
	`32`	`+`
	`33`	`+ public abstract void MouseScroll(int value, TimeSpan duration, int steps);`
`29`	`34`
`30`	`35`	`public void MouseMove(Point p)`
`31`	`36`	`{`
`@@ -64,17 +69,14 @@ public void MouseUp(IClick click)`
`64`	`69`	`click.ExecuteMouseUp(new MouseContext(GetMousePosition()));`
`65`	`70`	`}`
`66`	`71`
`67`		`- public void Delay(uint ms)`
	`72`	`+ public void Delay(int ms)`
`68`	`73`	`{`
`69`		`- Thread.Sleep((int)ms);`
	`74`	`+ Thread.Sleep(ms);`
`70`	`75`	`}`
`71`	`76`
`72`	`77`	`protected void ApplyAutoDelay()`
`73`	`78`	`{`
`74`		`- if (AutoDelay > 0)`
`75`		`- {`
`76`		`- Thread.Sleep((int)AutoDelay);`
`77`		`- }`
	`79`	`+ Thread.Sleep(AutoDelay);`
`78`	`80`	`}`
`79`		`- }`
	`81`	`+ }`
`80`	`82`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,4 @@`
`1`		`-using System;`
`2`		`-using System.Threading;`
	`1`	`+using System.Threading;`
`3`	`2`
`4`	`3`	`namespace Desktop.Robot.Clicks`
`5`	`4`	`{`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,4 @@`
`1`		`-using System;`
`2`		`-namespace Desktop.Robot.Clicks.Linux`
	`1`	`+namespace Desktop.Robot.Clicks.Linux`
`3`	`2`	`{`
`4`	`3`	`internal record MiddleClick(int delay) : IClick`
`5`	`4`	`{`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,4 @@`
`1`		`-using System;`
`2`		`-using System.Drawing;`
	`1`	`+using System.Drawing;`
`3`	`2`
`4`	`3`	`namespace Desktop.Robot.Clicks`
`5`	`4`	`{`
Original file line number	Diff line number	Diff line change
`@@ -46,13 +46,13 @@ public static void BezierMovement(this IRobot robot, Point initial, Point contro`
`46`	`46`	`points.Add(GetPoint(t, initial, controlPoint, ending));`
`47`	`47`	`}`
`48`	`48`
`49`		`- var interval = duration.TotalMilliseconds / points.Count;`
	`49`	`+ var interval = Convert.ToInt32(duration.TotalMilliseconds / points.Count);`
`50`	`50`
`51`	`51`	`robot.MouseMove(initial);`
`52`	`52`
`53`	`53`	`//Avoiding AutoDelay`
`54`	`54`	`var currentAutoDelay = robot.AutoDelay;`
`55`		`- robot.AutoDelay = (uint)interval;`
	`55`	`+ robot.AutoDelay = interval;`
`56`	`56`
`57`	`57`	`foreach (var point in points)`
`58`	`58`	`{`
Original file line number	Diff line number	Diff line change
`@@ -14,9 +14,9 @@ public static IRobot Type(this IRobot robot, string text)`
`14`	`14`	`return robot;`
`15`	`15`	`}`
`16`	`16`
`17`		`- public static IRobot Type(this IRobot robot, string text, uint delay)`
	`17`	`+ public static IRobot Type(this IRobot robot, string text, int delay)`
`18`	`18`	`{`
`19`		`- Thread.Sleep((int)robot.AutoDelay);`
	`19`	`+ Thread.Sleep(robot.AutoDelay);`
`20`	`20`	`var currentDelay = robot.AutoDelay;`
`21`	`21`	`robot.AutoDelay = delay;`
`22`	`22`	`foreach (var ch in text)`