feat: add support for mouse clicks with modifier keys

socsieng · Jan 1, 2021 · 1654fd7 · 1654fd7
1 parent 21bf513
commit 1654fd7
Show file tree

Hide file tree

Showing 6 changed files with 43 additions and 15 deletions.
diff --git a/Sources/SendKeysLib/Commands/CommandExecutor.swift b/Sources/SendKeysLib/Commands/CommandExecutor.swift
@@ -57,11 +57,13 @@ public class CommandExecutor: CommandExecutorProtocol {
 
     private func executeMouseClick(_ command: Command) {
         let button = command.arguments[0]!
-        let clicks = Int(command.arguments[1]!)!
+        let modifiers = command.arguments[1] ?? ""
+        let clicks = Int(command.arguments[2]!)!
 
         try! mouseController.click(
             CGPoint(x: -1, y: -1),
             button: getMouseButton(button: button),
+            flags: KeyPresser.getModifierFlags(modifiers.components(separatedBy: ",")),
             clickCount: clicks
         )
     }

diff --git a/Sources/SendKeysLib/Commands/MouseClickCommandMatcher.swift b/Sources/SendKeysLib/Commands/MouseClickCommandMatcher.swift
@@ -2,15 +2,17 @@ import Foundation
 
 public class MouseClickCommandMatcher: CommandMatcher {
     public init() {
-        super.init(try! NSRegularExpression(pattern: "\\<m:([a-z]+)(:(\\d+))?\\>"))
+        super.init(try! NSRegularExpression(pattern: "\\<m:([a-z]+)(:([a-z,]+))?(:(\\d+))?\\>"))
     }
 
     override public func createCommand(_ arguments: [String?]) -> Command {
         let button = arguments[1]
-        let clicks = arguments[3]
+        let modifiers = arguments[3]
+        let clicks = arguments[5]
 
         return Command(.mouseClick, [
             button!,
+            modifiers,
             clicks ?? "1"
         ])
     }

diff --git a/Sources/SendKeysLib/KeyPresser.swift b/Sources/SendKeysLib/KeyPresser.swift
@@ -3,13 +3,7 @@ import Foundation
 class KeyPresser {
     func pressKey(key: String, modifiers: [String]) throws {
         let keycode = KeyCodes.getKeyCode(key) ?? 0
-
-        var flags: CGEventFlags = []
-        for modifier in modifiers {
-            let flag = try getModifierFlag(modifier)
-            flags.insert(flag)
-        }
-
+        let flags = try! KeyPresser.getModifierFlags(modifiers)
         let keyDownEvent = CGEvent(keyboardEventSource: nil, virtualKey: keycode, keyDown: true)
 
         if keycode == 0 {
@@ -29,7 +23,18 @@ class KeyPresser {
         keyUpEvent!.post(tap: CGEventTapLocation.cghidEventTap)
     }
 
-    private func getModifierFlag(_ modifier: String) throws -> CGEventFlags {
+    static func getModifierFlags(_ modifiers: [String]) throws -> CGEventFlags {
+        var flags: CGEventFlags = []
+
+        for modifier in modifiers.filter({ !$0.isEmpty }) {
+            let flag = try getModifierFlag(modifier)
+            flags.insert(flag)
+        }
+
+        return flags
+    }
+
+    private static func getModifierFlag(_ modifier: String) throws -> CGEventFlags {
         switch modifier {
         case "⌘",
              "cmd",

diff --git a/Sources/SendKeysLib/MouseController.swift b/Sources/SendKeysLib/MouseController.swift
@@ -22,7 +22,7 @@ class MouseController {
         animator.animate()
     }
 
-    func click(_ location: CGPoint, button: CGMouseButton, clickCount: Int) {
+    func click(_ location: CGPoint, button: CGMouseButton, flags: CGEventFlags, clickCount: Int) {
         let resolvedLocation = resolveLocation(location)
 
         var downMouseType = CGEventType.leftMouseDown
@@ -34,6 +34,7 @@ class MouseController {
         }
 
         let downEvent = CGEvent(mouseEventSource: nil, mouseType: downMouseType, mouseCursorPosition: resolvedLocation, mouseButton: button)
+        downEvent?.flags = flags
         downEvent?.post(tap: CGEventTapLocation.cghidEventTap)
 
         let upEvent = CGEvent(mouseEventSource: nil, mouseType: upMouseType, mouseCursorPosition: resolvedLocation, mouseButton: button)

diff --git a/Tests/SendKeysTests/CommandIteratorTests.swift b/Tests/SendKeysTests/CommandIteratorTests.swift
@@ -141,7 +141,16 @@ final class CommandIteratorTests: XCTestCase {
         XCTAssertEqual(
             commands,
             [
-                Command(CommandType.mouseClick, ["left", "1"])
+                Command(CommandType.mouseClick, ["left", nil, "1"])
+            ])
+    }
+
+    func testParsesMouseClickWithModifiers() throws {
+        let commands = getCommands(CommandsIterator("<m:left:shift,command>"))
+        XCTAssertEqual(
+            commands,
+            [
+                Command(CommandType.mouseClick, ["left", "shift,command", "1"])
             ])
     }
 
@@ -150,7 +159,16 @@ final class CommandIteratorTests: XCTestCase {
         XCTAssertEqual(
             commands,
             [
-                Command(CommandType.mouseClick, ["right", "2"])
+                Command(CommandType.mouseClick, ["right", nil, "2"])
+            ])
+    }
+
+    func testParsesMouseClickWithModifiersAndClickCount() throws {
+        let commands = getCommands(CommandsIterator("<m:right:command:2>"))
+        XCTAssertEqual(
+            commands,
+            [
+                Command(CommandType.mouseClick, ["right", "command", "2"])
             ])
     }
 

diff --git a/Tests/SendKeysTests/CommandsProcessorTests.swift b/Tests/SendKeysTests/CommandsProcessorTests.swift
@@ -130,7 +130,7 @@ final class CommandProcessorTests: XCTestCase {
             Command(.pause, ["0.1"]),
             Command(.mouseMove, ["-1", "-1", "200", "200", "1"]),
             Command(.pause, ["0.1"]),
-            Command(.mouseClick, ["left", "1"]),
+            Command(.mouseClick, ["left", nil, "1"]),
         ])
     }
 }