Implement multiple actions (double tap, triple tap) (#349)

* Implement double tap and new actions array in config

* Update native widgets to use new actions parameter

* Refactor new actions parameter moving it to main definition
Renamed old action and longAction to legacy

* Fix tests

* Remove unused code

* Readd test for legacyAction

* Implement triple tap

* Add new actions explanation

* Add support for multiple actions and same trigger

Author: cipi1965

MTMR/CustomButtonTouchBarItem.swift

@@ -8,18 +8,32 @@
 
 import Cocoa
 
+struct ItemAction {
+    typealias TriggerClosure = (() -> Void)?
+    
+    let trigger: Action.Trigger
+    let closure: TriggerClosure
+    
+    init(trigger: Action.Trigger, _ closure: TriggerClosure) {
+        self.trigger = trigger
+        self.closure = closure
+    }
+}
+
 class CustomButtonTouchBarItem: NSCustomTouchBarItem, NSGestureRecognizerDelegate {
-    var tapClosure: (() -> Void)?
-    var longTapClosure: (() -> Void)? {
+    
+    var actions: [ItemAction] = [] {
         didSet {
-            longClick.isEnabled = longTapClosure != nil
+            multiClick.isDoubleClickEnabled = actions.filter({ $0.trigger == .doubleTap }).count > 0
+            multiClick.isTripleClickEnabled = actions.filter({ $0.trigger == .tripleTap }).count > 0
+            longClick.isEnabled = actions.filter({ $0.trigger == .longTap }).count > 0
         }
     }
     var finishViewConfiguration: ()->() = {}
 
     private var button: NSButton!
-    private var singleClick: HapticClickGestureRecognizer!
     private var longClick: LongPressGestureRecognizer!
+    private var multiClick: MultiClickGestureRecognizer!
 
     init(identifier: NSTouchBarItem.Identifier, title: String) {
         attributedTitle = title.defaultTouchbarAttributedString
@@ -31,10 +45,17 @@ class CustomButtonTouchBarItem: NSCustomTouchBarItem, NSGestureRecognizerDelegat
         longClick.isEnabled = false
         longClick.allowedTouchTypes = .direct
         longClick.delegate = self
-
-        singleClick = HapticClickGestureRecognizer(target: self, action: #selector(handleGestureSingle))
-        singleClick.allowedTouchTypes = .direct
-        singleClick.delegate = self
+        
+        multiClick = MultiClickGestureRecognizer(
+            target: self,
+            action: #selector(handleGestureSingleTap),
+            doubleAction: #selector(handleGestureDoubleTap),
+            tripleAction: #selector(handleGestureTripleTap)
+        )
+        multiClick.allowedTouchTypes = .direct
+        multiClick.delegate = self
+        multiClick.isDoubleClickEnabled = false
+        multiClick.isTripleClickEnabled = false
 
         reinstallButton()
         button.attributedTitle = attributedTitle
@@ -100,33 +121,43 @@ class CustomButtonTouchBarItem: NSCustomTouchBarItem, NSGestureRecognizerDelegat
         view = button
 
         view.addGestureRecognizer(longClick)
-        view.addGestureRecognizer(singleClick)
+        // view.addGestureRecognizer(singleClick)
+        view.addGestureRecognizer(multiClick)
         finishViewConfiguration()
     }
 
     func gestureRecognizer(_ gestureRecognizer: NSGestureRecognizer, shouldRequireFailureOf otherGestureRecognizer: NSGestureRecognizer) -> Bool {
-        if gestureRecognizer == singleClick && otherGestureRecognizer == longClick
-            || gestureRecognizer == longClick && otherGestureRecognizer == singleClick // need it
+        if gestureRecognizer == multiClick && otherGestureRecognizer == longClick
+            || gestureRecognizer == longClick && otherGestureRecognizer == multiClick // need it
         {
             return false
         }
         return true
     }
-
-    @objc func handleGestureSingle(gr: NSClickGestureRecognizer) {
-        switch gr.state {
-        case .ended:
-            tapClosure?()
-            break
-        default:
-            break
+    
+    func callActions(for trigger: Action.Trigger) {
+        let itemActions = self.actions.filter { $0.trigger == trigger }
+        for itemAction in itemActions {
+            itemAction.closure?()
         }
     }
+    
+    @objc func handleGestureSingleTap() {
+        callActions(for: .singleTap)
+    }
+    
+    @objc func handleGestureDoubleTap() {
+        callActions(for: .doubleTap)
+    }
+    
+    @objc func handleGestureTripleTap() {
+        callActions(for: .tripleTap)
+    }
 
     @objc func handleGestureLong(gr: NSPressGestureRecognizer) {
         switch gr.state {
         case .possible: // tiny hack because we're calling action manually
-            (self.longTapClosure ?? self.tapClosure)?()
+            callActions(for: .longTap)
             break
         default:
             break
@@ -176,15 +207,78 @@ class CustomButtonCell: NSButtonCell {
     }
 }
 
-class HapticClickGestureRecognizer: NSClickGestureRecognizer {
+// Thanks to https://stackoverflow.com/a/49843893
+final class MultiClickGestureRecognizer: NSClickGestureRecognizer {
+
+    private let _action: Selector
+    private let _doubleAction: Selector
+    private let _tripleAction: Selector
+    private var _clickCount: Int = 0
+    
+    public var isDoubleClickEnabled = true
+    public var isTripleClickEnabled = true
+
+    override var action: Selector? {
+        get {
+            return nil /// prevent base class from performing any actions
+        } set {
+            if newValue != nil { // if they are trying to assign an actual action
+                fatalError("Only use init(target:action:doubleAction) for assigning actions")
+            }
+        }
+    }
+
+    required init(target: AnyObject, action: Selector, doubleAction: Selector, tripleAction: Selector) {
+        _action = action
+        _doubleAction = doubleAction
+        _tripleAction = tripleAction
+        super.init(target: target, action: nil)
+    }
+
+    required init?(coder: NSCoder) {
+        fatalError("init(target:action:doubleAction:tripleAction) is only support atm")
+    }
+    
     override func touchesBegan(with event: NSEvent) {
         HapticFeedback.shared?.tap(strong: 2)
         super.touchesBegan(with: event)
     }
-    
+
     override func touchesEnded(with event: NSEvent) {
         HapticFeedback.shared?.tap(strong: 1)
         super.touchesEnded(with: event)
+        _clickCount += 1
+        
+        var delayThreshold: TimeInterval // fine tune this as needed
+        
+        guard isDoubleClickEnabled || isTripleClickEnabled else {
+            _ = target?.perform(_action)
+            return
+        }
+        
+        if (isTripleClickEnabled) {
+            delayThreshold = 0.4
+            perform(#selector(_resetAndPerformActionIfNecessary), with: nil, afterDelay: delayThreshold)
+            if _clickCount == 3 {
+                _ = target?.perform(_tripleAction)
+            }
+        } else {
+            delayThreshold = 0.3
+            perform(#selector(_resetAndPerformActionIfNecessary), with: nil, afterDelay: delayThreshold)
+            if _clickCount == 2 {
+                _ = target?.perform(_doubleAction)
+            }
+        }
+    }
+
+    @objc private func _resetAndPerformActionIfNecessary() {
+        if _clickCount == 1 {
+            _ = target?.perform(_action)
+        }
+        if isTripleClickEnabled && _clickCount == 2 {
+            _ = target?.perform(_doubleAction)
+        }
+        _clickCount = 0
     }
 }