From 51c77e1d9417924e2cf0d86e10cdbb5fd1d5e3f1 Mon Sep 17 00:00:00 2001
From: PalmerAL <PalmerAL@users.noreply.github.com>
Date: Sat, 21 Dec 2024 10:55:11 +0000
Subject: [PATCH 1/2] fully replace mousetrap with before-input-event

---
 index.html                           |   6 +-
 js/keybindings.js                    | 122 +++++++++++++--------------
 js/searchbar/bookmarkEditor.js       |   1 -
 js/taskOverlay/taskOverlayBuilder.js |   1 -
 main/main.js                         |   4 +
 package.json                         |   1 -
 6 files changed, 65 insertions(+), 70 deletions(-)

diff --git a/index.html b/index.html
index da74b9b88..e47af0aec 100644
--- a/index.html
+++ b/index.html
@@ -136,7 +136,7 @@
       </div>
       <div id="tabs">
         <div id="tab-editor" hidden>
-          <input id="tab-editor-input" class="mousetrap" spellcheck="false" />
+          <input id="tab-editor-input" spellcheck="false" />
         </div>
         <div id="tabs-inner" role="tablist" class="has-thin-scrollbar"></div>
       </div>
@@ -216,7 +216,7 @@
       hidden
       class="theme-background-color theme-text-color"
     >
-      <input id="findinpage-input" class="mousetrap" />
+      <input id="findinpage-input" />
       <span id="findinpage-count" class="inline-text"></span>
       <div class="divider"></div>
       <button id="findinpage-previous-match">
@@ -238,7 +238,7 @@
       >
       <div class="task-search-input-container">
         <i class="i carbon:search"></i>
-        <input type="search" id="task-search-input" class="mousetrap"/>
+        <input type="search" id="task-search-input"/>
       </div>
     </div>
       <div id="task-area"></div>
diff --git a/js/keybindings.js b/js/keybindings.js
index 1cebc30b4..51eb61414 100644
--- a/js/keybindings.js
+++ b/js/keybindings.js
@@ -1,11 +1,10 @@
 /*
 There are three possible ways that keybindings can be handled.
  Shortcuts that appear in the menubar are registered in main.js, and send IPC messages to the window (which are handled by menuRenderer.js)
- - If the browser UI is focused, shortcuts are handled by Mousetrap.
-  - If a BrowserView is focused, shortcuts are handled by the before-input-event listener.
+ - If the browser UI is focused, a before-input-event is generated in the main process and forwarded to here.
+  - If a BrowserView is focused, a before-input-event is generated from the webContents and forwarded to here.
   */
 
-const Mousetrap = require('mousetrap')
 const keyMapModule = require('util/keyMap.js')
 
 var webviews = require('webviews.js')
@@ -15,7 +14,6 @@ var settings = require('util/settings/settings.js')
 var keyMap = keyMapModule.userKeyMap(settings.get('keyMap'))
 
 var shortcutsList = []
-var registeredMousetrapBindings = {}
 
 /*
 Determines whether a shortcut can actually run
@@ -96,18 +94,6 @@ function defineShortcut (keysOrKeyMapName, fn, options = {}) {
       fn: shortcutCallback,
       keyUp: options.keyUp || false
     })
-    if (!registeredMousetrapBindings[keys + (options.keyUp ? '-keyup' : '')]) {
-      // mousetrap only allows one listener for each key combination (+keyup variant)
-      // so register a single listener, and have it call all the other listeners that we have
-      Mousetrap.bind(keys, function (e, combo) {
-        shortcutsList.forEach(function (shortcut) {
-          if (shortcut.combo === combo && (e.type === 'keyup') === shortcut.keyUp) {
-            shortcut.fn(e, combo)
-          }
-        })
-      }, (options.keyUp ? 'keyup' : null))
-      registeredMousetrapBindings[keys + (options.keyUp ? '-keyup' : '')] = true
-    }
   })
 }
 
@@ -117,58 +103,66 @@ navigator.keyboard.getLayoutMap().then(map => {
   keyboardMap = map
 })
 
-function initialize () {
-  webviews.bindEvent('before-input-event', function (tabId, input) {
-    var expectedKeys = 1
-    // account for additional keys that aren't in the input.key property
-    if (input.alt && input.key !== 'Alt') {
-      expectedKeys++
-    }
-    if (input.shift && input.key !== 'Shift') {
-      expectedKeys++
-    }
-    if (input.control && input.key !== 'Control') {
-      expectedKeys++
+function beforeInputEventHandler (input) {
+  var expectedKeys = 1
+  // account for additional keys that aren't in the input.key property
+  if (input.alt && input.key !== 'Alt') {
+    expectedKeys++
+  }
+  if (input.shift && input.key !== 'Shift') {
+    expectedKeys++
+  }
+  if (input.control && input.key !== 'Control') {
+    expectedKeys++
+  }
+  if (input.meta && input.key !== 'Meta') {
+    expectedKeys++
+  }
+
+  shortcutsList.forEach(function (shortcut) {
+    if ((shortcut.keyUp && input.type !== 'keyUp') || (!shortcut.keyUp && input.type !== 'keyDown')) {
+      return
     }
-    if (input.meta && input.key !== 'Meta') {
-      expectedKeys++
+    var matches = true
+    var matchedKeys = 0
+    shortcut.keys.forEach(function (key) {
+      if (!(
+        key === input.key.toLowerCase() ||
+      // we need this check because the alt key can change the typed key, causing input.key to be a special character instead of the base key
+      // but input.code isn't layout aware, so we need to map it to the correct key for the layout
+      (keyboardMap && key === keyboardMap.get(input.code)) ||
+      (key === 'esc' && input.key === 'Escape') ||
+      (key === 'left' && input.key === 'ArrowLeft') ||
+      (key === 'right' && input.key === 'ArrowRight') ||
+      (key === 'up' && input.key === 'ArrowUp') ||
+      (key === 'down' && input.key === 'ArrowDown') ||
+      (key === 'alt' && (input.alt || input.key === 'Alt')) ||
+      (key === 'option' && (input.alt || input.key === 'Alt')) ||
+      (key === 'shift' && (input.shift || input.key === 'Shift')) ||
+      (key === 'ctrl' && (input.control || input.key === 'Control')) ||
+      (key === 'mod' && window.platformType === 'mac' && (input.meta || input.key === 'Meta')) ||
+      (key === 'mod' && window.platformType !== 'mac' && (input.control || input.key === 'Control'))
+      )
+      ) {
+        matches = false
+      } else {
+        matchedKeys++
+      }
+    })
+
+    if (matches && matchedKeys === expectedKeys) {
+      shortcut.fn(null, shortcut.combo)
     }
+  })
+}
 
-    shortcutsList.forEach(function (shortcut) {
-      if ((shortcut.keyUp && input.type !== 'keyUp') || (!shortcut.keyUp && input.type !== 'keyDown')) {
-        return
-      }
-      var matches = true
-      var matchedKeys = 0
-      shortcut.keys.forEach(function (key) {
-        if (!(
-          key === input.key.toLowerCase() ||
-        // we need this check because the alt key can change the typed key, causing input.key to be a special character instead of the base key
-        // but input.code isn't layout aware, so we need to map it to the correct key for the layout
-        (keyboardMap && key === keyboardMap.get(input.code)) ||
-        (key === 'esc' && input.key === 'Escape') ||
-        (key === 'left' && input.key === 'ArrowLeft') ||
-        (key === 'right' && input.key === 'ArrowRight') ||
-        (key === 'up' && input.key === 'ArrowUp') ||
-        (key === 'down' && input.key === 'ArrowDown') ||
-        (key === 'alt' && (input.alt || input.key === 'Alt')) ||
-        (key === 'option' && (input.alt || input.key === 'Alt')) ||
-        (key === 'shift' && (input.shift || input.key === 'Shift')) ||
-        (key === 'ctrl' && (input.control || input.key === 'Control')) ||
-        (key === 'mod' && window.platformType === 'mac' && (input.meta || input.key === 'Meta')) ||
-        (key === 'mod' && window.platformType !== 'mac' && (input.control || input.key === 'Control'))
-        )
-        ) {
-          matches = false
-        } else {
-          matchedKeys++
-        }
-      })
+function initialize () {
+  webviews.bindEvent('before-input-event', function (tabId, input) {
+    beforeInputEventHandler(input)
+  })
 
-      if (matches && matchedKeys === expectedKeys) {
-        shortcut.fn(null, shortcut.combo)
-      }
-    })
+  ipc.on('before-input-event', function (e, input) {
+    beforeInputEventHandler(input)
   })
 }
 
diff --git a/js/searchbar/bookmarkEditor.js b/js/searchbar/bookmarkEditor.js
index 63f7ef674..93cfe282a 100644
--- a/js/searchbar/bookmarkEditor.js
+++ b/js/searchbar/bookmarkEditor.js
@@ -177,7 +177,6 @@ const bookmarkEditor = {
       var newTagInput = document.createElement('input')
       newTagInput.className = 'tag-input'
       newTagInput.placeholder = l('bookmarksAddTag')
-      newTagInput.classList.add('mousetrap')
       newTagInput.spellcheck = false
       tagArea.appendChild(newTagInput)
 
diff --git a/js/taskOverlay/taskOverlayBuilder.js b/js/taskOverlay/taskOverlayBuilder.js
index 67bb67cd4..f921af1ca 100644
--- a/js/taskOverlay/taskOverlayBuilder.js
+++ b/js/taskOverlay/taskOverlayBuilder.js
@@ -64,7 +64,6 @@ var TaskOverlayBuilder = {
       nameInputField: function (task, taskIndex) {
         var input = document.createElement('input')
         input.classList.add('task-name')
-        input.classList.add('mousetrap')
 
         var taskName = l('defaultTaskName').replace('%n', taskIndex + 1)
 
diff --git a/main/main.js b/main/main.js
index e651fb387..9e3f22f28 100644
--- a/main/main.js
+++ b/main/main.js
@@ -317,6 +317,10 @@ function createWindowWithBounds (bounds, customArgs) {
     }
   })
 
+  newWin.webContents.on('before-input-event', function(e, input) {
+    sendIPCToWindow(newWin, 'before-input-event', input)
+  })
+
   newWin.setTouchBar(buildTouchBar())
 
   windows.addWindow(newWin)
diff --git a/package.json b/package.json
index c87485daf..da00ead58 100644
--- a/package.json
+++ b/package.json
@@ -35,7 +35,6 @@
     "dragula": "github:minbrowser/dragula",
     "electron-squirrel-startup": "^1.0.0",
     "expr-eval": "^2.0.2",
-    "mousetrap": "^1.5.3",
     "node-abi": "^3.8.0",
     "pdfjs-dist": "4.2.67",
     "quick-score": "^0.2.0",

From d1518db08df83f8faceeb445c85aa1ecae5ecef6 Mon Sep 17 00:00:00 2001
From: PalmerAL <PalmerAL@users.noreply.github.com>
Date: Sat, 21 Dec 2024 11:05:29 +0000
Subject: [PATCH 2/2] add super key option

---
 js/keybindings.js          | 3 ++-
 pages/settings/settings.js | 4 ++++
 2 files changed, 6 insertions(+), 1 deletion(-)

diff --git a/js/keybindings.js b/js/keybindings.js
index 51eb61414..b107b18ef 100644
--- a/js/keybindings.js
+++ b/js/keybindings.js
@@ -141,7 +141,8 @@ function beforeInputEventHandler (input) {
       (key === 'shift' && (input.shift || input.key === 'Shift')) ||
       (key === 'ctrl' && (input.control || input.key === 'Control')) ||
       (key === 'mod' && window.platformType === 'mac' && (input.meta || input.key === 'Meta')) ||
-      (key === 'mod' && window.platformType !== 'mac' && (input.control || input.key === 'Control'))
+      (key === 'mod' && window.platformType !== 'mac' && (input.control || input.key === 'Control')) ||
+      (key === 'super' && (input.meta || input.key === 'Meta'))
       )
       ) {
         matches = false
diff --git a/pages/settings/settings.js b/pages/settings/settings.js
index 22eb494d5..ea3f51c4d 100644
--- a/pages/settings/settings.js
+++ b/pages/settings/settings.js
@@ -493,6 +493,9 @@ function formatKeyValue (value) {
     value = value.replace(/\bmod\b/g, 'ctrl')
     value = value.replace(/\boption\b/g, 'alt')
   }
+  if (navigator.platform === 'Win32') {
+    value = value.replace(/\bsuper\b/g, 'win')
+  }
   return value
 }
 
@@ -509,6 +512,7 @@ function parseKeyInput (input) {
     } else {
       e = e.replace(/\b(control)|(ctrl)\b/g, 'mod')
       e = e.replace(/\balt\b/g, 'option')
+      e = e.replace(/\bwin\b/g, 'super')
     }
     return e
   })