1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
|
/*
* Copyright (C) 2023-2024 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];
let value;
if (typeof hotkey !== 'undefined') {
value = /** @type {unknown} */ (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 [action, attributes, values] = /** @type {unknown[]} */ (data);
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);
}
}
|