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
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
|
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
import { AppConstants } from "resource://gre/modules/AppConstants.sys.mjs";
const lazy = {};
ChromeUtils.defineLazyGetter(lazy, "PlatformKeys", function () {
return Services.strings.createBundle(
"chrome://global-platform/locale/platformKeys.properties"
);
});
ChromeUtils.defineLazyGetter(lazy, "Keys", function () {
return Services.strings.createBundle(
"chrome://global/locale/keys.properties"
);
});
export var ShortcutUtils = {
IS_VALID: "valid",
INVALID_KEY: "invalid_key",
INVALID_MODIFIER: "invalid_modifier",
INVALID_COMBINATION: "invalid_combination",
DUPLICATE_MODIFIER: "duplicate_modifier",
MODIFIER_REQUIRED: "modifier_required",
CLOSE_TAB: "CLOSE_TAB",
CYCLE_TABS: "CYCLE_TABS",
TOGGLE_CARET_BROWSING: "TOGGLE_CARET_BROWSING",
MOVE_TAB_BACKWARD: "MOVE_TAB_BACKWARD",
MOVE_TAB_FORWARD: "MOVE_TAB_FORWARD",
NEXT_TAB: "NEXT_TAB",
PREVIOUS_TAB: "PREVIOUS_TAB",
/**
* Prettifies the modifier keys for an element.
*
* @param Node aElemKey
* The key element to get the modifiers from.
* @return string
* A prettified and properly separated modifier keys string.
*/
prettifyShortcut(aElemKey) {
let elemString = this.getModifierString(aElemKey.getAttribute("modifiers"));
let key = this.getKeyString(
aElemKey.getAttribute("keycode"),
aElemKey.getAttribute("key")
);
return elemString + key;
},
metaKeyIsCommandKey() {
return AppConstants.platform == "macosx";
},
getModifierString(elemMod) {
if (!elemMod) {
return "";
}
let elemString = "";
let haveCloverLeaf = false;
if (elemMod.match("accel")) {
if (Services.appinfo.OS == "Darwin") {
haveCloverLeaf = true;
} else {
elemString +=
lazy.PlatformKeys.GetStringFromName("VK_CONTROL") +
lazy.PlatformKeys.GetStringFromName("MODIFIER_SEPARATOR");
}
}
if (elemMod.match("access")) {
if (Services.appinfo.OS == "Darwin") {
elemString +=
lazy.PlatformKeys.GetStringFromName("VK_CONTROL") +
lazy.PlatformKeys.GetStringFromName("MODIFIER_SEPARATOR");
} else {
elemString +=
lazy.PlatformKeys.GetStringFromName("VK_ALT") +
lazy.PlatformKeys.GetStringFromName("MODIFIER_SEPARATOR");
}
}
if (elemMod.match("meta") && !this.metaKeyIsCommandKey()) {
elemString +=
lazy.PlatformKeys.GetStringFromName("VK_COMMAND_OR_WIN") +
lazy.PlatformKeys.GetStringFromName("MODIFIER_SEPARATOR");
}
if (elemMod.match("shift")) {
elemString +=
lazy.PlatformKeys.GetStringFromName("VK_SHIFT") +
lazy.PlatformKeys.GetStringFromName("MODIFIER_SEPARATOR");
}
if (elemMod.match("alt")) {
elemString +=
lazy.PlatformKeys.GetStringFromName("VK_ALT") +
lazy.PlatformKeys.GetStringFromName("MODIFIER_SEPARATOR");
}
if (elemMod.match("ctrl") || elemMod.match("control")) {
elemString +=
lazy.PlatformKeys.GetStringFromName("VK_CONTROL") +
lazy.PlatformKeys.GetStringFromName("MODIFIER_SEPARATOR");
}
if (elemMod.match("meta") && this.metaKeyIsCommandKey()) {
elemString +=
lazy.PlatformKeys.GetStringFromName("VK_COMMAND_OR_WIN") +
lazy.PlatformKeys.GetStringFromName("MODIFIER_SEPARATOR");
}
if (haveCloverLeaf) {
elemString +=
lazy.PlatformKeys.GetStringFromName("VK_COMMAND_OR_WIN") +
lazy.PlatformKeys.GetStringFromName("MODIFIER_SEPARATOR");
}
return elemString;
},
getKeyString(keyCode, keyAttribute) {
let key;
if (keyCode) {
keyCode = keyCode.toUpperCase();
if (AppConstants.platform == "macosx") {
// Return fancy Unicode symbols for some keys.
switch (keyCode) {
case "VK_LEFT":
return "\u2190"; // U+2190 LEFTWARDS ARROW
case "VK_RIGHT":
return "\u2192"; // U+2192 RIGHTWARDS ARROW
}
}
try {
let bundle = keyCode == "VK_RETURN" ? lazy.PlatformKeys : lazy.Keys;
// Some keys might not exist in the locale file, which will throw.
key = bundle.GetStringFromName(keyCode);
} catch (ex) {
console.error("Error finding ", keyCode, ": ", ex);
key = keyCode.replace(/^VK_/, "");
}
} else {
key = keyAttribute.toUpperCase();
}
return key;
},
getKeyAttribute(chromeKey) {
if (/^[A-Z]$/.test(chromeKey)) {
// We use the key attribute for single characters.
return ["key", chromeKey];
}
return ["keycode", this.getKeycodeAttribute(chromeKey)];
},
/**
* Determines the corresponding XUL keycode from the given chrome key.
*
* For example:
*
* input | output
* ---------------------------------------
* "PageUp" | "VK_PAGE_UP"
* "Delete" | "VK_DELETE"
*
* @param {string} chromeKey The chrome key (e.g. "PageUp", "Space", ...)
* @returns {string} The constructed value for the Key's 'keycode' attribute.
*/
getKeycodeAttribute(chromeKey) {
if (/^[0-9]/.test(chromeKey)) {
return `VK_${chromeKey}`;
}
return `VK${chromeKey.replace(/([A-Z])/g, "_$&").toUpperCase()}`;
},
findShortcut(aElemCommand) {
let document = aElemCommand.ownerDocument;
return document.querySelector(
'key[command="' + aElemCommand.getAttribute("id") + '"]'
);
},
chromeModifierKeyMap: {
Alt: "alt",
Command: "accel",
Ctrl: "accel",
MacCtrl: "control",
Shift: "shift",
},
/**
* Determines the corresponding XUL modifiers from the chrome modifiers.
*
* For example:
*
* input | output
* ---------------------------------------
* ["Ctrl", "Shift"] | "accel,shift"
* ["MacCtrl"] | "control"
*
* @param {Array} chromeModifiers The array of chrome modifiers.
* @returns {string} The constructed value for the Key's 'modifiers' attribute.
*/
getModifiersAttribute(chromeModifiers) {
return Array.from(chromeModifiers, modifier => {
return ShortcutUtils.chromeModifierKeyMap[modifier];
})
.sort()
.join(",");
},
/**
* Validate if a shortcut string is valid and return an error code if it
* isn't valid.
*
* For example:
*
* input | output
* ---------------------------------------
* "Ctrl+Shift+A" | IS_VALID
* "Shift+F" | MODIFIER_REQUIRED
* "Command+>" | INVALID_KEY
*
* @param {string} string The shortcut string.
* @returns {string} The code for the validation result.
*/
validate(string) {
// A valid shortcut key for a webextension manifest
const MEDIA_KEYS =
/^(MediaNextTrack|MediaPlayPause|MediaPrevTrack|MediaStop)$/;
const BASIC_KEYS =
/^([A-Z0-9]|Comma|Period|Home|End|PageUp|PageDown|Space|Insert|Delete|Up|Down|Left|Right)$/;
const FUNCTION_KEYS = /^(F[1-9]|F1[0-2])$/;
if (MEDIA_KEYS.test(string.trim())) {
return this.IS_VALID;
}
let modifiers = string.split("+").map(s => s.trim());
let key = modifiers.pop();
let chromeModifiers = modifiers.map(
m => ShortcutUtils.chromeModifierKeyMap[m]
);
// If the modifier wasn't found it will be undefined.
if (chromeModifiers.some(modifier => !modifier)) {
return this.INVALID_MODIFIER;
}
switch (modifiers.length) {
case 0:
// A lack of modifiers is only allowed with function keys.
if (!FUNCTION_KEYS.test(key)) {
return this.MODIFIER_REQUIRED;
}
break;
case 1:
// Shift is only allowed on its own with function keys.
if (chromeModifiers[0] == "shift" && !FUNCTION_KEYS.test(key)) {
return this.MODIFIER_REQUIRED;
}
break;
case 2:
if (chromeModifiers[0] == chromeModifiers[1]) {
return this.DUPLICATE_MODIFIER;
}
break;
default:
return this.INVALID_COMBINATION;
}
if (!BASIC_KEYS.test(key) && !FUNCTION_KEYS.test(key)) {
return this.INVALID_KEY;
}
return this.IS_VALID;
},
/**
* Attempt to find a key for a given shortcut string, such as
* "Ctrl+Shift+A" and determine if it is a system shortcut.
*
* @param {Object} win The window to look for key elements in.
* @param {string} value The shortcut string.
* @returns {boolean} Whether a system shortcut was found or not.
*/
isSystem(win, value) {
let modifiers = value.split("+");
let chromeKey = modifiers.pop();
let modifiersString = this.getModifiersAttribute(modifiers);
let keycode = this.getKeycodeAttribute(chromeKey);
let baseSelector = "key";
if (modifiers.length) {
baseSelector += `[modifiers="${modifiersString}"]`;
}
let keyEl = win.document.querySelector(
[
`${baseSelector}[key="${chromeKey}"]`,
`${baseSelector}[key="${chromeKey.toLowerCase()}"]`,
`${baseSelector}[keycode="${keycode}"]`,
].join(",")
);
return keyEl && !keyEl.closest("keyset").id.startsWith("ext-keyset-id");
},
/**
* Determine what action a KeyboardEvent should perform, if any.
*
* @param {KeyboardEvent} event The event to check for a related system action.
* @returns {string} A string identifying the action, or null if no action is found.
*/
// eslint-disable-next-line complexity
getSystemActionForEvent(event, { rtl } = {}) {
// On Windows, Win key state is not strictly checked so that we can ignore
// Win key state to check the other modifier state.
const meaningfulMetaKey = event.metaKey && AppConstants.platform != "win";
// This is set to true only when the Meta key is accel key on the platform.
const accelMetaKey = event.metaKey && this.metaKeyIsCommandKey();
switch (event.keyCode) {
case event.DOM_VK_TAB:
if (event.ctrlKey && !event.altKey && !meaningfulMetaKey) {
return ShortcutUtils.CYCLE_TABS;
}
break;
case event.DOM_VK_F7:
// shift + F7 is the default DevTools shortcut for the Style Editor.
if (!event.shiftKey) {
return ShortcutUtils.TOGGLE_CARET_BROWSING;
}
break;
case event.DOM_VK_PAGE_UP:
if (
event.ctrlKey &&
!event.shiftKey &&
!event.altKey &&
!meaningfulMetaKey
) {
return ShortcutUtils.PREVIOUS_TAB;
}
if (
event.ctrlKey &&
event.shiftKey &&
!event.altKey &&
!meaningfulMetaKey
) {
return ShortcutUtils.MOVE_TAB_BACKWARD;
}
break;
case event.DOM_VK_PAGE_DOWN:
if (
event.ctrlKey &&
!event.shiftKey &&
!event.altKey &&
!meaningfulMetaKey
) {
return ShortcutUtils.NEXT_TAB;
}
if (
event.ctrlKey &&
event.shiftKey &&
!event.altKey &&
!meaningfulMetaKey
) {
return ShortcutUtils.MOVE_TAB_FORWARD;
}
break;
case event.DOM_VK_LEFT:
if (accelMetaKey && event.altKey && !event.shiftKey && !event.ctrlKey) {
return ShortcutUtils.PREVIOUS_TAB;
}
break;
case event.DOM_VK_RIGHT:
if (accelMetaKey && event.altKey && !event.shiftKey && !event.ctrlKey) {
return ShortcutUtils.NEXT_TAB;
}
break;
}
if (AppConstants.platform == "macosx") {
if (!event.altKey && event.metaKey) {
switch (event.charCode) {
case "}".charCodeAt(0):
if (rtl) {
return ShortcutUtils.PREVIOUS_TAB;
}
return ShortcutUtils.NEXT_TAB;
case "{".charCodeAt(0):
if (rtl) {
return ShortcutUtils.NEXT_TAB;
}
return ShortcutUtils.PREVIOUS_TAB;
}
}
}
// Not on Mac from now on.
if (AppConstants.platform != "macosx") {
if (
event.ctrlKey &&
!event.shiftKey &&
event.keyCode == KeyEvent.DOM_VK_F4
) {
return ShortcutUtils.CLOSE_TAB;
}
}
return null;
},
};
Object.freeze(ShortcutUtils);
|