Input refactoring (#12)

* Fix folder name typo * Smaller fixes * Shortcut rename to Shortcuts * Fix quoted attributes in UE 5.3 * remove KeyboardShortcutAction * Remove more trivial classes * Rename IKeyboardShortcut * Node delete shortcut
2026-02-27 02:34:45 +08:00 · 2023-08-11 02:48:50 +02:00
parent 2284789e6e
commit ed43ee3edd
29 changed files with 652 additions and 485 deletions
--- a/js/input/keyboard/KeyboardShortcut.js
+++ b/js/input/keyboard/KeyboardShortcut.js
@@ -0,0 +1,126 @@
+import Configuration from "../../Configuration.js"
+import Grammar from "../../serialization/Grammar.js"
+import IInput from "../IInput.js"
+import KeyBindingEntity from "../../entity/KeyBindingEntity.js"
+
+/** @typedef {import("../../Blueprint.js").default} Blueprint */
+
+/**
+ * @template {Element} T
+ * @extends IInput<T>
+ */
+export default class KeyboardShortcut extends IInput {
+
+    static #ignoreEvent =
+        /** @param {KeyboardShortcut} self */
+        self => { }
+
+    /** @type {KeyBindingEntity[]} */
+    #activationKeys
+
+    pressedKey = ""
+
+    /**
+     * @param {T} target
+     * @param {Blueprint} blueprint
+     * @param {Object} options
+     */
+    constructor(
+        target,
+        blueprint,
+        options = {},
+        onKeyDown = KeyboardShortcut.#ignoreEvent,
+        onKeyUp = KeyboardShortcut.#ignoreEvent
+    ) {
+        options.activationKeys ??= []
+        options.consumeEvent ??= true
+        options.listenOnFocus ??= true
+        options.unlistenOnTextEdit ??= true // No shortcuts when inside of a text field
+        if (!(options.activationKeys instanceof Array)) {
+            options.activationKeys = [options.activationKeys]
+        }
+        options.activationKeys = options.activationKeys.map(v => {
+            if (v instanceof KeyBindingEntity) {
+                return v
+            }
+            if (typeof v === "string") {
+                const parsed = Grammar.keyBindingEntity.parse(v)
+                if (parsed.status) {
+                    return parsed.value
+                }
+            }
+            throw new Error("Unexpected key value")
+        })
+
+        super(target, blueprint, options)
+        this.onKeyDown = onKeyDown
+        this.onKeyUp = onKeyUp
+
+        this.#activationKeys = this.options.activationKeys ?? []
+
+        const wantsShift = keyEntry => keyEntry.bShift || keyEntry.Key == "LeftShift" || keyEntry.Key == "RightShift"
+        const wantsCtrl = keyEntry => keyEntry.bCtrl || keyEntry.Key == "LeftControl" || keyEntry.Key == "RightControl"
+        const wantsAlt = keyEntry => keyEntry.bAlt || keyEntry.Key == "LeftAlt" || keyEntry.Key == "RightAlt"
+
+        let self = this
+        /** @param {KeyboardEvent} e */
+        this.keyDownHandler = e => {
+            if (
+                self.#activationKeys.some(keyEntry =>
+                    wantsShift(keyEntry) == e.shiftKey
+                    && wantsCtrl(keyEntry) == e.ctrlKey
+                    && wantsAlt(keyEntry) == e.altKey
+                    && Configuration.Keys[keyEntry.Key.value] == e.code
+                )
+            ) {
+                if (this.consumeEvent) {
+                    e.preventDefault()
+                    e.stopImmediatePropagation()
+                }
+                this.pressedKey = e.code
+                self.fire()
+                document.removeEventListener("keydown", self.keyDownHandler)
+                document.addEventListener("keyup", self.keyUpHandler)
+            }
+        }
+
+        /** @param {KeyboardEvent} e */
+        this.keyUpHandler = e => {
+            if (
+                self.#activationKeys.some(keyEntry =>
+                    keyEntry.bShift && e.key == "Shift"
+                    || keyEntry.bCtrl && e.key == "Control"
+                    || keyEntry.bAlt && e.key == "Alt"
+                    || keyEntry.bCmd && e.key == "Meta"
+                    || Configuration.Keys[keyEntry.Key.value] == e.code
+                )
+            ) {
+                if (this.consumeEvent) {
+                    e.stopImmediatePropagation()
+                }
+                self.unfire()
+                this.pressedKey = ""
+                document.removeEventListener("keyup", this.keyUpHandler)
+                document.addEventListener("keydown", this.keyDownHandler)
+            }
+        }
+    }
+
+    listenEvents() {
+        document.addEventListener("keydown", this.keyDownHandler)
+    }
+
+    unlistenEvents() {
+        document.removeEventListener("keydown", this.keyDownHandler)
+    }
+
+    /* Subclasses can override */
+
+    fire() {
+        this.onKeyDown(this)
+    }
+
+    unfire() {
+        this.onKeyUp(this)
+    }
+}