From 6a271e067fa917614f4c81f473533e24c6d04404 Mon Sep 17 00:00:00 2001 From: toasted-nutbread Date: Sat, 13 Feb 2021 22:52:28 -0500 Subject: Move mixed/js (#1383) * Move mixed/js/core.js to js/core.js * Move mixed/js/yomichan.js to js/yomichan.js * Move mixed/js/timer.js to js/debug/timer.js * Move mixed/js/hotkey-handler.js to js/input/hotkey-handler.js * Move mixed/js/hotkey-help-controller.js to js/input/hotkey-help-controller.js * Move mixed/js/hotkey-util.js to js/input/hotkey-util.js * Move mixed/js/audio-system.js to js/input/audio-system.js * Move mixed/js/media-loader.js to js/input/media-loader.js * Move mixed/js/text-to-speech-audio.js to js/input/text-to-speech-audio.js * Move mixed/js/comm.js to js/comm/cross-frame-api.js * Move mixed/js/api.js to js/comm/api.js * Move mixed/js/frame-client.js to js/comm/frame-client.js * Move mixed/js/frame-endpoint.js to js/comm/frame-endpoint.js * Move mixed/js/display.js to js/display/display.js * Move mixed/js/display-audio.js to js/display/display-audio.js * Move mixed/js/display-generator.js to js/display/display-generator.js * Move mixed/js/display-history.js to js/display/display-history.js * Move mixed/js/display-notification.js to js/display/display-notification.js * Move mixed/js/display-profile-selection.js to js/display/display-profile-selection.js * Move mixed/js/japanese.js to js/language/japanese-util.js * Move mixed/js/dictionary-data-util.js to js/language/dictionary-data-util.js * Move mixed/js/document-focus-controller.js to js/dom/document-focus-controller.js * Move mixed/js/document-util.js to js/dom/document-util.js * Move mixed/js/dom-data-binder.js to js/dom/dom-data-binder.js * Move mixed/js/html-template-collection.js to js/dom/html-template-collection.js * Move mixed/js/panel-element.js to js/dom/panel-element.js * Move mixed/js/popup-menu.js to js/dom/popup-menu.js * Move mixed/js/selector-observer.js to js/dom/selector-observer.js * Move mixed/js/scroll.js to js/dom/window-scroll.js * Move mixed/js/text-scanner.js to js/language/text-scanner.js * Move mixed/js/cache-map.js to js/general/cache-map.js * Move mixed/js/object-property-accessor.js to js/general/object-property-accessor.js * Move mixed/js/task-accumulator.js to js/general/task-accumulator.js * Move mixed/js/environment.js to js/background/environment.js * Move mixed/js/dynamic-loader.js to js/scripting/dynamic-loader.js * Move mixed/js/dynamic-loader-sentinel.js to js/scripting/dynamic-loader-sentinel.js --- ext/mixed/js/hotkey-util.js | 297 -------------------------------------------- 1 file changed, 297 deletions(-) delete mode 100644 ext/mixed/js/hotkey-util.js (limited to 'ext/mixed/js/hotkey-util.js') diff --git a/ext/mixed/js/hotkey-util.js b/ext/mixed/js/hotkey-util.js deleted file mode 100644 index ea3daf97..00000000 --- a/ext/mixed/js/hotkey-util.js +++ /dev/null @@ -1,297 +0,0 @@ -/* - * Copyright (C) 2021 Yomichan Authors - * - * This program is free software: you can redistribute it and/or modify - * it under the terms of the GNU General Public License as published by - * the Free Software Foundation, either version 3 of the License, or - * (at your option) any later version. - * - * This program is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU General Public License for more details. - * - * You should have received a copy of the GNU General Public License - * along with this program. If not, see . - */ - -/** - * Utility class to help display hotkeys and convert to/from commands. - */ -class HotkeyUtil { - /** - * Creates a new instance. - */ - constructor(os=null) { - this._os = os; - this._inputSeparator = ' + '; - this._modifierKeyNames = new Map(); - this._mouseInputNamePattern = /^mouse(\d+)$/; - this._modifierPriorities = new Map([ - ['meta', -4], - ['ctrl', -3], - ['alt', -2], - ['shift', -1] - ]); - this._stringComparer = new Intl.Collator('en-US'); // Invariant locale - - this._updateModifierKeyNames(); - } - - /** - * Gets the operating system for this instance. - * The operating system is used to display system-localized modifier key names. - */ - get os() { - return this._os; - } - - /** - * Sets the operating system for this instance. - * @param value The value to assign. - * Valid values are: win, mac, linux, openbsd, cros, android. - */ - set os(value) { - if (this._os === value) { return; } - this._os = value; - this._updateModifierKeyNames(); - } - - /** - * Gets a display string for a key and a set of modifiers. - * @param key The key code string, or `null` for no key. - * @param modifiers An array of modifiers. - * Valid values are: ctrl, alt, shift, meta, or mouseN, where N is an integer. - * @returns A user-friendly string for the combination of key and modifiers. - */ - getInputDisplayValue(key, modifiers) { - const separator = this._inputSeparator; - let displayValue = ''; - let first = true; - for (const modifier of modifiers) { - if (first) { - first = false; - } else { - displayValue += separator; - } - displayValue += this.getModifierDisplayValue(modifier); - } - if (typeof key === 'string') { - if (!first) { displayValue += separator; } - displayValue += this.getKeyDisplayValue(key); - } - return displayValue; - } - - /** - * Gets a display string for a single modifier. - * @param modifier A string representing a modifier. - * Valid values are: ctrl, alt, shift, meta, or mouseN, where N is an integer. - * @returns A user-friendly string for the modifier. - */ - getModifierDisplayValue(modifier) { - const match = this._mouseInputNamePattern.exec(modifier); - if (match !== null) { - return `Mouse ${match[1]}`; - } - - const name = this._modifierKeyNames.get(modifier); - return (typeof name !== 'undefined' ? name : modifier); - } - - /** - * Gets a display string for a key. - * @param key The key code string, or `null` for no key. - * @returns A user-friendly string for the combination of key and modifiers, or `null` if key was already `null`. - */ - getKeyDisplayValue(key) { - if (typeof key === 'string' && key.length === 4 && key.startsWith('Key')) { - key = key.substring(3); - } - return key; - } - - /** - * Gets a display string for a single modifier. - * @param modifier A string representing a modifier. - * Valid values are: ctrl, alt, shift, meta, or mouseN, where N is an integer. - * @returns `'mouse'` if the modifier represents a mouse button, `'key'` otherwise. - */ - getModifierType(modifier) { - return (this._mouseInputNamePattern.test(modifier) ? 'mouse' : 'key'); - } - - /** - * Converts an extension command string into a standard input. - * @param command An extension command string. - * @returns An object `{key, modifiers}`, where key is a string (or `null`) representing the key, and modifiers is an array of modifier keys. - */ - convertCommandToInput(command) { - let key = null; - const modifiers = new Set(); - if (typeof command === 'string' && command.length > 0) { - const parts = command.split('+'); - const ii = parts.length - 1; - key = this._convertCommandKeyToInputKey(parts[ii]); - for (let i = 0; i < ii; ++i) { - modifiers.add(this._convertCommandModifierToInputModifier(parts[i])); - } - } - return {key, modifiers: this.sortModifiers([...modifiers])}; - } - - /** - * Gets a command string for a specified input. - * @param key The key code string, or `null` for no key. - * @param modifiers An array of modifier keys. - * Valid values are: ctrl, alt, shift, meta. - * @returns An extension command string representing the input. - */ - convertInputToCommand(key, modifiers) { - const separator = '+'; - let command = ''; - let first = true; - for (const modifier of modifiers) { - if (first) { - first = false; - } else { - command += separator; - } - command += this._convertInputModifierToCommandModifier(modifier); - } - if (typeof key === 'string') { - if (!first) { command += separator; } - command += this._convertInputKeyToCommandKey(key); - } - return command; - } - - /** - * Sorts an array of modifiers. - * @param modifiers An array of modifiers. - * Valid values are: ctrl, alt, shift, meta. - * @returns A sorted array of modifiers. The array instance is the same as the input array. - */ - sortModifiers(modifiers) { - const pattern = this._mouseInputNamePattern; - const keyPriorities = this._modifierPriorities; - const stringComparer = this._stringComparer; - - const count = modifiers.length; - const modifierInfos = []; - for (let i = 0; i < count; ++i) { - const modifier = modifiers[i]; - const match = pattern.exec(modifier); - let info; - if (match !== null) { - info = [modifier, 1, Number.parseInt(match[1], 10), i]; - } else { - let priority = keyPriorities.get(modifier); - if (typeof priority === 'undefined') { priority = 0; } - info = [modifier, 0, priority, i]; - } - modifierInfos.push(info); - } - - modifierInfos.sort((a, b) => { - let i = a[1] - b[1]; - if (i !== 0) { return i; } - - i = a[2] - b[2]; - if (i !== 0) { return i; } - - i = stringComparer.compare(a[0], b[0]); - if (i !== 0) { return i; } - - i = a[3] - b[3]; - return i; - }); - - for (let i = 0; i < count; ++i) { - modifiers[i] = modifierInfos[i][0]; - } - - return modifiers; - } - - // Private - - _getModifierKeyNames(os) { - switch (os) { - case 'win': - return [ - ['alt', 'Alt'], - ['ctrl', 'Ctrl'], - ['shift', 'Shift'], - ['meta', 'Windows'] - ]; - case 'mac': - return [ - ['alt', 'Opt'], - ['ctrl', 'Ctrl'], - ['shift', 'Shift'], - ['meta', 'Cmd'] - ]; - case 'linux': - case 'openbsd': - case 'cros': - case 'android': - return [ - ['alt', 'Alt'], - ['ctrl', 'Ctrl'], - ['shift', 'Shift'], - ['meta', 'Super'] - ]; - default: // 'unknown', etc - return [ - ['alt', 'Alt'], - ['ctrl', 'Ctrl'], - ['shift', 'Shift'], - ['meta', 'Meta'] - ]; - } - } - - _updateModifierKeyNames() { - const map = this._modifierKeyNames; - map.clear(); - for (const [key, value] of this._getModifierKeyNames(this._os)) { - map.set(key, value); - } - } - - _convertCommandKeyToInputKey(key) { - if (key.length === 1) { - key = `Key${key}`; - } - return key; - } - - _convertCommandModifierToInputModifier(modifier) { - switch (modifier) { - case 'Ctrl': return (this._os === 'mac' ? 'meta' : 'ctrl'); - case 'Alt': return 'alt'; - case 'Shift': return 'shift'; - case 'MacCtrl': return 'ctrl'; - case 'Command': return 'meta'; - default: return modifier; - } - } - - _convertInputKeyToCommandKey(key) { - if (key.length === 4 && key.startsWith('Key')) { - key = key.substring(3); - } - return key; - } - - _convertInputModifierToCommandModifier(modifier) { - switch (modifier) { - case 'ctrl': return (this._os === 'mac' ? 'MacCtrl' : 'Ctrl'); - case 'alt': return 'Alt'; - case 'shift': return 'Shift'; - case 'meta': return 'Command'; - default: return modifier; - } - } -} -- cgit v1.2.3