140 lines
4.1 KiB
JavaScript
140 lines
4.1 KiB
JavaScript
import { localize } from '../../nls.js';
|
|
|
|
/*---------------------------------------------------------------------------------------------
|
|
* Copyright (c) Microsoft Corporation. All rights reserved.
|
|
* Licensed under the MIT License. See License.txt in the project root for license information.
|
|
*--------------------------------------------------------------------------------------------*/
|
|
class ModifierLabelProvider {
|
|
constructor(mac, windows, linux = windows) {
|
|
this.modifierLabels = [null]; // index 0 will never me accessed.
|
|
this.modifierLabels[2 /* OperatingSystem.Macintosh */] = mac;
|
|
this.modifierLabels[1 /* OperatingSystem.Windows */] = windows;
|
|
this.modifierLabels[3 /* OperatingSystem.Linux */] = linux;
|
|
}
|
|
toLabel(OS, chords, keyLabelProvider) {
|
|
if (chords.length === 0) {
|
|
return null;
|
|
}
|
|
const result = [];
|
|
for (let i = 0, len = chords.length; i < len; i++) {
|
|
const chord = chords[i];
|
|
const keyLabel = keyLabelProvider(chord);
|
|
if (keyLabel === null) {
|
|
// this keybinding cannot be expressed...
|
|
return null;
|
|
}
|
|
result[i] = _simpleAsString(chord, keyLabel, this.modifierLabels[OS]);
|
|
}
|
|
return result.join(' ');
|
|
}
|
|
}
|
|
/**
|
|
* A label provider that prints modifiers in a suitable format for displaying in the UI.
|
|
*/
|
|
const UILabelProvider = new ModifierLabelProvider({
|
|
ctrlKey: '\u2303',
|
|
shiftKey: '⇧',
|
|
altKey: '⌥',
|
|
metaKey: '⌘',
|
|
separator: '',
|
|
}, {
|
|
ctrlKey: localize(35, "Ctrl"),
|
|
shiftKey: localize(36, "Shift"),
|
|
altKey: localize(37, "Alt"),
|
|
metaKey: localize(38, "Windows"),
|
|
separator: '+',
|
|
}, {
|
|
ctrlKey: localize(39, "Ctrl"),
|
|
shiftKey: localize(40, "Shift"),
|
|
altKey: localize(41, "Alt"),
|
|
metaKey: localize(42, "Super"),
|
|
separator: '+',
|
|
});
|
|
/**
|
|
* A label provider that prints modifiers in a suitable format for ARIA.
|
|
*/
|
|
const AriaLabelProvider = new ModifierLabelProvider({
|
|
ctrlKey: localize(43, "Control"),
|
|
shiftKey: localize(44, "Shift"),
|
|
altKey: localize(45, "Option"),
|
|
metaKey: localize(46, "Command"),
|
|
separator: '+',
|
|
}, {
|
|
ctrlKey: localize(47, "Control"),
|
|
shiftKey: localize(48, "Shift"),
|
|
altKey: localize(49, "Alt"),
|
|
metaKey: localize(50, "Windows"),
|
|
separator: '+',
|
|
}, {
|
|
ctrlKey: localize(51, "Control"),
|
|
shiftKey: localize(52, "Shift"),
|
|
altKey: localize(53, "Alt"),
|
|
metaKey: localize(54, "Super"),
|
|
separator: '+',
|
|
});
|
|
/**
|
|
* A label provider that prints modifiers in a suitable format for Electron Accelerators.
|
|
* See https://github.com/electron/electron/blob/master/docs/api/accelerator.md
|
|
*/
|
|
const ElectronAcceleratorLabelProvider = new ModifierLabelProvider({
|
|
ctrlKey: 'Ctrl',
|
|
shiftKey: 'Shift',
|
|
altKey: 'Alt',
|
|
metaKey: 'Cmd',
|
|
separator: '+',
|
|
}, {
|
|
ctrlKey: 'Ctrl',
|
|
shiftKey: 'Shift',
|
|
altKey: 'Alt',
|
|
metaKey: 'Super',
|
|
separator: '+',
|
|
});
|
|
/**
|
|
* A label provider that prints modifiers in a suitable format for user settings.
|
|
*/
|
|
const UserSettingsLabelProvider = new ModifierLabelProvider({
|
|
ctrlKey: 'ctrl',
|
|
shiftKey: 'shift',
|
|
altKey: 'alt',
|
|
metaKey: 'cmd',
|
|
separator: '+',
|
|
}, {
|
|
ctrlKey: 'ctrl',
|
|
shiftKey: 'shift',
|
|
altKey: 'alt',
|
|
metaKey: 'win',
|
|
separator: '+',
|
|
}, {
|
|
ctrlKey: 'ctrl',
|
|
shiftKey: 'shift',
|
|
altKey: 'alt',
|
|
metaKey: 'meta',
|
|
separator: '+',
|
|
});
|
|
function _simpleAsString(modifiers, key, labels) {
|
|
if (key === null) {
|
|
return '';
|
|
}
|
|
const result = [];
|
|
// translate modifier keys: Ctrl-Shift-Alt-Meta
|
|
if (modifiers.ctrlKey) {
|
|
result.push(labels.ctrlKey);
|
|
}
|
|
if (modifiers.shiftKey) {
|
|
result.push(labels.shiftKey);
|
|
}
|
|
if (modifiers.altKey) {
|
|
result.push(labels.altKey);
|
|
}
|
|
if (modifiers.metaKey) {
|
|
result.push(labels.metaKey);
|
|
}
|
|
// the actual key
|
|
if (key !== '') {
|
|
result.push(key);
|
|
}
|
|
return result.join(labels.separator);
|
|
}
|
|
|
|
export { AriaLabelProvider, ElectronAcceleratorLabelProvider, ModifierLabelProvider, UILabelProvider, UserSettingsLabelProvider };
|