From b878f8132be59576fc87e39405b1914eff9f55d3 Mon Sep 17 00:00:00 2001
From: Sindre Sorhus <sindresorhus@gmail.com>
Date: Sat, 2 Sep 2023 02:54:04 +0700
Subject: [PATCH] Fix shortcut recorder not properly stopping when window gets
 hidden and fix preventing initial focus

Fixes #145
Fixes #144
---
 Sources/KeyboardShortcuts/RecorderCocoa.swift | 60 +++++++++++++++----
 1 file changed, 47 insertions(+), 13 deletions(-)

diff --git a/Sources/KeyboardShortcuts/RecorderCocoa.swift b/Sources/KeyboardShortcuts/RecorderCocoa.swift
index 8dd3c40..3084658 100644
--- a/Sources/KeyboardShortcuts/RecorderCocoa.swift
+++ b/Sources/KeyboardShortcuts/RecorderCocoa.swift
@@ -26,11 +26,13 @@ extension KeyboardShortcuts {
 	```
 	*/
 	public final class RecorderCocoa: NSSearchField, NSSearchFieldDelegate {
-		private let minimumWidth: Double = 130
-		private var eventMonitor: LocalEventMonitor?
+		private let minimumWidth = 130.0
 		private let onChange: ((_ shortcut: Shortcut?) -> Void)?
-		private var observer: NSObjectProtocol?
 		private var canBecomeKey = false
+		private var eventMonitor: LocalEventMonitor?
+		private var shortcutsNameChangeObserver: NSObjectProtocol?
+		private var windowDidResignKeyObserver: NSObjectProtocol?
+		private var windowDidBecomeKeyObserver: NSObjectProtocol?
 
 		/**
 		The shortcut name for the recorder.
@@ -116,7 +118,7 @@ extension KeyboardShortcuts {
 		}
 
 		private func setUpEvents() {
-			observer = NotificationCenter.default.addObserver(forName: .shortcutByNameDidChange, object: nil, queue: nil) { [weak self] notification in
+			shortcutsNameChangeObserver = NotificationCenter.default.addObserver(forName: .shortcutByNameDidChange, object: nil, queue: nil) { [weak self] notification in
 				guard
 					let self,
 					let nameInNotification = notification.userInfo?["name"] as? KeyboardShortcuts.Name,
@@ -129,6 +131,23 @@ extension KeyboardShortcuts {
 			}
 		}
 
+		private func endRecording() {
+			eventMonitor = nil
+			placeholderString = "record_shortcut".localized
+			showsCancelButton = !stringValue.isEmpty
+			restoreCaret()
+			KeyboardShortcuts.isPaused = false
+		}
+
+		private func preventBecomingKey() {
+			canBecomeKey = false
+
+			// Prevent the control from receiving the initial focus.
+			DispatchQueue.main.async { [self] in
+				canBecomeKey = true
+			}
+		}
+
 		/// :nodoc:
 		public func controlTextDidChange(_ object: Notification) {
 			if stringValue.isEmpty {
@@ -145,23 +164,38 @@ extension KeyboardShortcuts {
 
 		/// :nodoc:
 		public func controlTextDidEndEditing(_ object: Notification) {
-			eventMonitor = nil
-			placeholderString = "record_shortcut".localized
-			showsCancelButton = !stringValue.isEmpty
-            restoreCaret()
-			KeyboardShortcuts.isPaused = false
+			endRecording()
 		}
 
 		/// :nodoc:
 		override public func viewDidMoveToWindow() {
-			guard window != nil else {
+			guard let window else {
+				windowDidResignKeyObserver = nil
+				windowDidBecomeKeyObserver = nil
+				endRecording()
 				return
 			}
 
-			// Prevent the control from receiving the initial focus.
-			DispatchQueue.main.async { [self] in
-				canBecomeKey = true
+			// Ensures the recorder stops when the window is hidden.
+			// This is especially important for Settings windows, which as of macOS 13.5, only hides instead of closes when you click the close button.
+			windowDidResignKeyObserver = NotificationCenter.default.addObserver(forName: NSWindow.didResignKeyNotification, object: window, queue: nil) { [weak self] _ in
+				guard
+					let self,
+					let window = self.window
+				else {
+					return
+				}
+
+				self.endRecording()
+				window.makeFirstResponder(nil)
 			}
+
+			// Ensures the recorder does not receive initial focus when a hidden window becomes unhidden.
+			windowDidBecomeKeyObserver = NotificationCenter.default.addObserver(forName: NSWindow.didBecomeKeyNotification, object: window, queue: nil) { [weak self] _ in
+				self?.preventBecomingKey()
+			}
+
+			preventBecomingKey()
 		}
 
 		/// :nodoc: