Something went wrong. Try again.
Pop-up dictionary browser extension for language learning. Successor to Yomichan. (PERSONAL FORK)
Something went wrong. Try again.
JavaScript
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219/* * Copyright (C) 2023-2025 Yomitan Authors * Copyright (C) 2021-2022 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 <https://www.gnu.org/licenses/>. */
import {parseJson} from '../core/json.js';import {isObjectNotArray} from '../core/object-utilities.js';import {HotkeyUtil} from './hotkey-util.js';
export class HotkeyHelpController { constructor() { /** @type {HotkeyUtil} */ this._hotkeyUtil = new HotkeyUtil(); /** @type {Map<string, string>} */ this._localActionHotkeys = new Map(); /** @type {Map<string, string>} */ this._globalActionHotkeys = new Map(); /** @type {RegExp} */ this._replacementPattern = /\{0\}/g; }
/** * @param {import('../comm/api.js').API} api */ async prepare(api) { const {platform: {os}} = await api.getEnvironmentInfo(); this._hotkeyUtil.os = os; await this._setupGlobalCommands(this._globalActionHotkeys); }
/** * @param {import('settings').ProfileOptions} options */ setOptions(options) { const hotkeys = options.inputs.hotkeys; const hotkeyMap = this._localActionHotkeys; hotkeyMap.clear(); for (const {enabled, action, key, modifiers} of hotkeys) { if (!enabled || key === null || action === '' || hotkeyMap.has(action)) { continue; } hotkeyMap.set(action, this._hotkeyUtil.getInputDisplayValue(key, modifiers)); } }
/** * @param {ParentNode} node */ setupNode(node) { const replacementPattern = this._replacementPattern; for (const node2 of /** @type {NodeListOf<HTMLElement>} */ (node.querySelectorAll('[data-hotkey]'))) { const info = this._getNodeInfo(node2); if (info === null) { continue; } const {action, global, attributes, values, defaultAttributeValues} = info; const multipleValues = Array.isArray(values); const hotkey = (global ? this._globalActionHotkeys : this._localActionHotkeys).get(action); for (let i = 0, ii = attributes.length; i < ii; ++i) { const attribute = attributes[i]; /** @type {unknown} */ let value; if (typeof hotkey !== 'undefined') { value = multipleValues ? values[i] : values; if (typeof value === 'string') { value = value.replace(replacementPattern, hotkey); } } else { value = defaultAttributeValues[i]; }
if (typeof value === 'string') { node2.setAttribute(attribute, value); } else { node2.removeAttribute(attribute); } } } }
// Private
/** * @returns {Promise<chrome.commands.Command[]>} */ _getAllCommands() { return new Promise((resolve, reject) => { if (!(isObjectNotArray(chrome.commands) && typeof chrome.commands.getAll === 'function')) { resolve([]); return; }
chrome.commands.getAll((result) => { const e = chrome.runtime.lastError; if (e) { reject(new Error(e.message)); } else { resolve(result); } }); }); }
/** * @param {Map<string, string>} commandMap */ async _setupGlobalCommands(commandMap) { const commands = await this._getAllCommands();
commandMap.clear(); for (const {name, shortcut} of commands) { if (typeof name !== 'string' || typeof shortcut !== 'string' || shortcut.length === 0) { continue; } const {key, modifiers} = this._hotkeyUtil.convertCommandToInput(shortcut); commandMap.set(name, this._hotkeyUtil.getInputDisplayValue(key, modifiers)); } }
/** * @param {HTMLElement} node * @param {unknown[]} data * @param {string[]} attributes * @returns {unknown[]} */ _getDefaultAttributeValues(node, data, attributes) { if (data.length > 3) { const result = data[3]; if (Array.isArray(result)) { return result; } }
/** @type {(?string)[]} */ const defaultAttributeValues = []; for (let i = 0, ii = attributes.length; i < ii; ++i) { const attribute = attributes[i]; const value = node.hasAttribute(attribute) ? node.getAttribute(attribute) : null; defaultAttributeValues.push(value); } data[3] = defaultAttributeValues; node.dataset.hotkey = JSON.stringify(data); return defaultAttributeValues; }
/** * @param {HTMLElement} node * @returns {?{action: string, global: boolean, attributes: string[], values: unknown, defaultAttributeValues: unknown[]}} */ _getNodeInfo(node) { const {hotkey} = node.dataset; if (typeof hotkey !== 'string') { return null; } const data = /** @type {unknown} */ (parseJson(hotkey)); if (!Array.isArray(data)) { return null; } const dataArray = /** @type {unknown[]} */ (data); const [action, attributes, values] = dataArray; if (typeof action !== 'string') { return null; } /** @type {string[]} */ const attributesArray = []; if (Array.isArray(attributes)) { for (const item of attributes) { if (typeof item !== 'string') { continue; } attributesArray.push(item); } } else if (typeof attributes === 'string') { attributesArray.push(attributes); } const defaultAttributeValues = this._getDefaultAttributeValues(node, data, attributesArray); const globalPrexix = 'global:'; const global = action.startsWith(globalPrexix); return { action: global ? action.substring(globalPrexix.length) : action, global, attributes: attributesArray, values, defaultAttributeValues, }; }
/** * @param {HTMLElement} node * @returns {?string} */ getHotkeyLabel(node) { const {hotkey} = node.dataset; if (typeof hotkey !== 'string') { return null; }
const data = /** @type {unknown} */ (parseJson(hotkey)); if (!Array.isArray(data)) { return null; }
const values = /** @type {unknown[]} */ (data)[2]; if (typeof values !== 'string') { return null; }
return values; }
/** * @param {HTMLElement} node * @param {string} label */ setHotkeyLabel(node, label) { const {hotkey} = node.dataset; if (typeof hotkey !== 'string') { return; }
const data = /** @type {unknown} */ (parseJson(hotkey)); if (!Array.isArray(data)) { return; }
data[2] = label; node.dataset.hotkey = JSON.stringify(data); }}