Allow user to stop sending mouse clicks after the mouse is moved

dabroz · dabroz · commit 7289b3bb2b5c · 2023-07-04T18:49:09.000+02:00
diff --git a/auto-clicker.xcodeproj/project.pbxproj b/auto-clicker.xcodeproj/project.pbxproj
@@ -9,6 +9,9 @@
 /* Begin PBXBuildFile section */
 		4C5D699D2A4ECDF800E72CEE /* NotificationsSettingsTabView.swift in Sources */ = {isa = PBXBuildFile; fileRef = 4C5D699C2A4ECDF800E72CEE /* NotificationsSettingsTabView.swift */; };
 		4C5D699F2A4EED3500E72CEE /* NotificationService.swift in Sources */ = {isa = PBXBuildFile; fileRef = 4C5D699E2A4EED3500E72CEE /* NotificationService.swift */; };
+		5DB2BECC2A54826B008AFE05 /* MouseMoveSelector.swift in Sources */ = {isa = PBXBuildFile; fileRef = 5DB2BECB2A54826B008AFE05 /* MouseMoveSelector.swift */; };
+		5DB2BECE2A5482DC008AFE05 /* MouseMoveModal.swift in Sources */ = {isa = PBXBuildFile; fileRef = 5DB2BECD2A5482DC008AFE05 /* MouseMoveModal.swift */; };
+		5DB2BED02A548325008AFE05 /* MouseMove.swift in Sources */ = {isa = PBXBuildFile; fileRef = 5DB2BECF2A548325008AFE05 /* MouseMove.swift */; };
 		B50022CA2875F5BF00610474 /* HelpCommands.swift in Sources */ = {isa = PBXBuildFile; fileRef = B50022C92875F5BF00610474 /* HelpCommands.swift */; };
 		B510760927F4A21500BB1CDA /* DateStrings in Frameworks */ = {isa = PBXBuildFile; productRef = B510760827F4A21500BB1CDA /* DateStrings */; };
 		B510760C27F4A23300BB1CDA /* KeyboardShortcuts in Frameworks */ = {isa = PBXBuildFile; productRef = B510760B27F4A23300BB1CDA /* KeyboardShortcuts */; };
@@ -77,6 +80,9 @@
 /* Begin PBXFileReference section */
 		4C5D699C2A4ECDF800E72CEE /* NotificationsSettingsTabView.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = NotificationsSettingsTabView.swift; sourceTree = "<group>"; };
 		4C5D699E2A4EED3500E72CEE /* NotificationService.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = NotificationService.swift; sourceTree = "<group>"; };
+		5DB2BECB2A54826B008AFE05 /* MouseMoveSelector.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = MouseMoveSelector.swift; sourceTree = "<group>"; };
+		5DB2BECD2A5482DC008AFE05 /* MouseMoveModal.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = MouseMoveModal.swift; sourceTree = "<group>"; };
+		5DB2BECF2A548325008AFE05 /* MouseMove.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = MouseMove.swift; sourceTree = "<group>"; };
 		B50022C92875F5BF00610474 /* HelpCommands.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = HelpCommands.swift; sourceTree = "<group>"; };
 		B510760E27F4A25400BB1CDA /* WindowStateService.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = WindowStateService.swift; sourceTree = "<group>"; };
 		B510761027F4A33D00BB1CDA /* SettingsView.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SettingsView.swift; sourceTree = "<group>"; };
@@ -333,6 +339,8 @@
 				B5F6A01A27F3A8A6003CD730 /* StatBox.swift */,
 				B510761E27F4B6F500BB1CDA /* KeyboardShortcutHint.swift */,
 				B5BCE808287C2F4D00B739AD /* SmallText.swift */,
+				5DB2BECB2A54826B008AFE05 /* MouseMoveSelector.swift */,
+				5DB2BECD2A5482DC008AFE05 /* MouseMoveModal.swift */,
 			);
 			path = Components;
 			sourceTree = "<group>";
@@ -380,6 +388,7 @@
 			isa = PBXGroup;
 			children = (
 				B5E6395527CA76CB008B111A /* Duration.swift */,
+				5DB2BECF2A548325008AFE05 /* MouseMove.swift */,
 				B5BCE802287BF59900B739AD /* Colour.swift */,
 			);
 			path = Enums;
@@ -579,6 +588,7 @@
 				4C5D699F2A4EED3500E72CEE /* NotificationService.swift in Sources */,
 				B510763227FF7EC800BB1CDA /* InputAwareView.swift in Sources */,
 				B5B6B46328032D3200C779FD /* PermissionsView.swift in Sources */,
+				5DB2BED02A548325008AFE05 /* MouseMove.swift in Sources */,
 				B510762327F4BB5F00BB1CDA /* KeyboardShortcutsSettingsTabView.swift in Sources */,
 				B510761A27F4A5BD00BB1CDA /* AppDelegate.swift in Sources */,
 				B5D603F528830A3600655D2C /* SettingsTabItemView.swift in Sources */,
@@ -607,6 +617,7 @@
 				B5E92B1427F1087E00A7FC63 /* UnderlinedTextFieldStyle.swift in Sources */,
 				B510762D27F4BF0C00BB1CDA /* Defaults+Workaround.swift in Sources */,
 				B510761627F4A43B00BB1CDA /* GeneralSettingsTabView.swift in Sources */,
+				5DB2BECE2A5482DC008AFE05 /* MouseMoveModal.swift in Sources */,
 				B510761827F4A58500BB1CDA /* KeyboardShortcuts.swift in Sources */,
 				B510763527FF811B00BB1CDA /* PressKeyListenerModal.swift in Sources */,
 				B53027FA264C2748002B8610 /* DelayTimer.swift in Sources */,
@@ -624,6 +635,7 @@
 				B5E92B1C27F1BA5E00A7FC63 /* ThemeService.swift in Sources */,
 				C4345BB52846056000365CF9 /* ProcessInfo+Extensions.swift in Sources */,
 				B5E6395327CA62EB008B111A /* ThemedButtonStyle.swift in Sources */,
+				5DB2BECC2A54826B008AFE05 /* MouseMoveSelector.swift in Sources */,
 				B510762127F4BB4900BB1CDA /* AppearanceSettingsTabView.swift in Sources */,
 				B5BF094328832A4E008092D9 /* MenuBarView.swift in Sources */,
 			);
diff --git a/auto-clicker.xcodeproj/project.xcworkspace/xcshareddata/swiftpm/Package.resolved b/auto-clicker.xcodeproj/project.xcworkspace/xcshareddata/swiftpm/Package.resolved
diff --git a/auto-clicker/Build Assets/Info.plist b/auto-clicker/Build Assets/Info.plist
@@ -30,7 +30,7 @@
 		</dict>
 	</array>
 	<key>CFBundleVersion</key>
-	<string>97ad514</string>
+	<string>ef40c75</string>
 	<key>LSApplicationCategoryType</key>
 	<string>public.app-category.utilities</string>
 	<key>LSMinimumSystemVersion</key>
diff --git a/auto-clicker/Enums/MouseMove.swift b/auto-clicker/Enums/MouseMove.swift
@@ -0,0 +1,51 @@
+//
+//  MouseMove.swift
+//  auto-clicker
+//
+//  Created by Tomasz Pędraszewski on 04/07/2023.
+//
+
+import Foundation
+import SwiftUI
+
+enum MouseMove: String, CustomStringConvertible, CaseIterable, Identifiable, Codable {
+    case enabled = "mousemove_enabled"
+    case disabled = "mousemove_disabled"
+
+    var id: String {
+        self.rawValue
+    }
+
+    var description: String {
+        self.rawValue
+    }
+
+    var localised: LocalizedStringKey {
+        LocalizedStringKey(self.description)
+    }
+
+    var textView: some View {
+        switch self {
+        case .enabled, .disabled:
+            return Text(self.description)
+        }
+    }
+
+    func buttonView(action: @escaping () -> Void) -> some View {
+        switch self {
+        case .enabled, .disabled:
+                return Button(action: action) {
+                    Text(self.localised, comment: "Mouse move option buttons")
+                }
+        }
+    }
+
+    func asBoolean() -> Bool {
+        switch self {
+        case .enabled:
+            return true
+        case .disabled:
+            return false
+        }
+    }
+}
diff --git a/auto-clicker/Localisation/en-GB.lproj/Localizable.strings b/auto-clicker/Localisation/en-GB.lproj/Localizable.strings
@@ -15,6 +15,8 @@
 "main_window_second"                  = "second";
 "main_window_seconds"                 = "seconds";
 "main_window_before_starting"         = " before starting";
+"main_window_stop_mousemove"          = "And";
+"main_window_stop_mousemove_end"      = "when the mouse is moved";
 "main_window_start_btn"               = "START";
 "main_window_stop_btn"                = "STOP";
 "main_window_stat_box_next_press_at"  = "NEXT PRESS AT";
@@ -27,6 +29,10 @@
 "duration_hours"               = "Hours(s)";
 "duration_modal_cancel_button" = "Cancel";
 
+"mousemove_enabled"             = "stop";
+"mousemove_disabled"            = "continue";
+"mousemove_modal_cancel_button" = "Cancel";
+
 "key_listener_modal_press_prompt"         = "Press your desired input...";
 "key_listener_modal_dismiss_key_prompt"   = "Hold the escape key when done.";
 "key_listener_modal_dismiss_key_override" = "To use the escape key itself, press it twice.";
diff --git a/auto-clicker/Models/FormState.swift b/auto-clicker/Models/FormState.swift
@@ -14,6 +14,7 @@ struct FormState: Codable, Defaults.Serializable {
     var pressAmount: Int
     var startDelay: Int
     var repeatAmount: Int
+    var stopOnMouseMove: MouseMove
 }
 
 extension FormState {
@@ -24,5 +25,6 @@ extension FormState {
         self.pressAmount = DEFAULT_PRESS_AMOUNT
         self.startDelay = DEFAULT_START_DELAY
         self.repeatAmount = DEFAULT_REPEAT_AMOUNT
+        self.stopOnMouseMove = MouseMove.disabled
     }
 }
diff --git a/auto-clicker/Observable Objects/AutoClickSimulator.swift b/auto-clicker/Observable Objects/AutoClickSimulator.swift
@@ -31,6 +31,8 @@ final class AutoClickSimulator: ObservableObject {
     private var timer: Timer?
     private var mouseLocation: NSPoint { NSEvent.mouseLocation }
     private var activity: Cancellable?
+    
+    private var monitorObject: Any? = nil
 
     func start() {
         self.isAutoClicking = true
@@ -61,6 +63,10 @@ final class AutoClickSimulator: ObservableObject {
                                           userInfo: nil,
                                           repeats: true)
 
+        if (Defaults[.autoClickerState].stopOnMouseMove.asBoolean()) {
+            startMouseMonitoring()
+        }
+        
         if Defaults[.notifyOnStart] {
             NotificationService.scheduleNotification(title: "Started", date: self.nextClickAt)
         }
@@ -72,6 +78,10 @@ final class AutoClickSimulator: ObservableObject {
 
     func stop() {
         self.isAutoClicking = false
+        
+        if let monitorObject = self.monitorObject {
+            NSEvent.removeMonitor(monitorObject)
+        }
 
         if let startMenuItem = MenuBarService.startMenuItem {
             startMenuItem.isEnabled = true
@@ -105,6 +115,12 @@ final class AutoClickSimulator: ObservableObject {
             self.stop()
         }
     }
+    
+    private func startMouseMonitoring() {
+        self.monitorObject = NSEvent.addGlobalMonitorForEvents(matching: [.mouseMoved]) { [weak self] event in
+            self?.stop()
+        }
+    }
 
     private let mouseDownEventMap: [NSEvent.EventType: CGEventType] = [
         .leftMouseDown: .leftMouseDown,
diff --git a/auto-clicker/Views/Main/Components/MouseMoveModal.swift b/auto-clicker/Views/Main/Components/MouseMoveModal.swift
@@ -0,0 +1,42 @@
+//
+//  MouseMoveModal.swift
+//  auto-clicker
+//
+//  Created by Tomasz Pędraszewski on 04/07/2023.
+//
+
+import SwiftUI
+import Defaults
+
+struct MouseMoveModal: View {
+    @Environment(\.presentationMode) private var presentationMode
+
+    @Default(.appearanceSelectedTheme) private var activeTheme
+
+    @Binding var selected: MouseMove
+
+    var body: some View {
+        VStack {
+            ForEach(MouseMove.allCases) { unit in
+                unit.buttonView(action: {
+                    self.presentationMode.wrappedValue.dismiss()
+
+                    self.selected = unit
+                })
+                .buttonStyle(ModalButtonStyle())
+            }
+
+            // 'init(_:role:action:)' is only available in macOS 12.0 or newer
+            // so cannot use a .destructive theme
+            Button("mousemove_modal_cancel_button") {
+                self.presentationMode.wrappedValue.dismiss()
+            }
+            .buttonStyle(ModalButtonStyle(isDestructive: true))
+        }
+        .frame(width: 200, height: 220)
+        .padding(.vertical, 14)
+        .padding(.horizontal, 5)
+        .background(self.activeTheme.backgroundColour)
+        .ignoresSafeArea()
+    }
+}
diff --git a/auto-clicker/Views/Main/Components/MouseMoveSelector.swift b/auto-clicker/Views/Main/Components/MouseMoveSelector.swift
@@ -0,0 +1,24 @@
+//
+//  MouseMoveSelector.swift
+//  auto-clicker
+//
+//  Created by Tomasz Pędraszewski on 04/07/2023.
+//
+
+import SwiftUI
+
+struct MouseMoveSelector: View {
+    @State private var showingMouseMoveModal = false
+
+    @Binding var selectedMouseMove: MouseMove
+
+    var body: some View {
+        Button(self.selectedMouseMove.localised) {
+            self.showingMouseMoveModal = true
+        }
+        .buttonStyle(UnderlinedButtonStyle())
+        .sheet(isPresented: self.$showingMouseMoveModal, content: {
+            MouseMoveModal(selected: self.$selectedMouseMove)
+        })
+    }
+}
diff --git a/auto-clicker/Views/Main/MainView.swift b/auto-clicker/Views/Main/MainView.swift
@@ -130,6 +130,15 @@ struct MainView: View {
 
                     Text(self.formState.startDelay == 1 ? "main_window_second" : "main_window_seconds", comment: "Main window 'second(s)'") + Text("main_window_before_starting", comment: "Main window 'before starting'") + Text("main_window_full_stop", comment: "Main window full stop")
                 }
+                
+                ActionStageLine {
+                    Text("main_window_stop_mousemove", comment: "Main window 'Stop mouse move'")
+                   
+                    MouseMoveSelector(selectedMouseMove: self.$formState.stopOnMouseMove)
+                        .disabled(self.hasStarted)
+                    
+                    Text("main_window_stop_mousemove_end", comment: "Main window 'Stop mouse move end'")
+                }
             }
             .padding(.top, 20)
             .padding(.leading, 20)

Original file line number	Diff line number	Diff line change
`@@ -14,6 +14,7 @@ struct FormState: Codable, Defaults.Serializable {`
`14`	`14`	`var pressAmount: Int`
`15`	`15`	`var startDelay: Int`
`16`	`16`	`var repeatAmount: Int`
	`17`	`+ var stopOnMouseMove: MouseMove`
`17`	`18`	`}`
`18`	`19`
`19`	`20`	`extension FormState {`
`@@ -24,5 +25,6 @@ extension FormState {`
`24`	`25`	`self.pressAmount = DEFAULT_PRESS_AMOUNT`
`25`	`26`	`self.startDelay = DEFAULT_START_DELAY`
`26`	`27`	`self.repeatAmount = DEFAULT_REPEAT_AMOUNT`
	`28`	`+ self.stopOnMouseMove = MouseMove.disabled`
`27`	`29`	`}`
`28`	`30`	`}`