Merge commit 'be3e8236086165e5e45a5a10783823874b3f3ebd' as 'lib/vscode'

2026-05-08 13:27:25 +02:00 · 2020-12-15 15:52:33 -07:00
parent 6c5c22ea8e be3e823608
commit 41bee49d07
4649 changed files with 1311795 additions and 0 deletions
--- a/lib/vscode/src/vs/base/common/keybindingLabels.ts
+++ b/lib/vscode/src/vs/base/common/keybindingLabels.ts
@@ -0,0 +1,190 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+import * as nls from 'vs/nls';
+import { OperatingSystem } from 'vs/base/common/platform';
+
+export interface ModifierLabels {
+	readonly ctrlKey: string;
+	readonly shiftKey: string;
+	readonly altKey: string;
+	readonly metaKey: string;
+	readonly separator: string;
+}
+
+export interface Modifiers {
+	readonly ctrlKey: boolean;
+	readonly shiftKey: boolean;
+	readonly altKey: boolean;
+	readonly metaKey: boolean;
+}
+
+export interface KeyLabelProvider<T extends Modifiers> {
+	(keybinding: T): string | null;
+}
+
+export class ModifierLabelProvider {
+
+	public readonly modifierLabels: ModifierLabels[];
+
+	constructor(mac: ModifierLabels, windows: ModifierLabels, linux: ModifierLabels = windows) {
+		this.modifierLabels = [null!]; // index 0 will never me accessed.
+		this.modifierLabels[OperatingSystem.Macintosh] = mac;
+		this.modifierLabels[OperatingSystem.Windows] = windows;
+		this.modifierLabels[OperatingSystem.Linux] = linux;
+	}
+
+	public toLabel<T extends Modifiers>(OS: OperatingSystem, parts: T[], keyLabelProvider: KeyLabelProvider<T>): string | null {
+		if (parts.length === 0) {
+			return null;
+		}
+
+		const result: string[] = [];
+		for (let i = 0, len = parts.length; i < len; i++) {
+			const part = parts[i];
+			const keyLabel = keyLabelProvider(part);
+			if (keyLabel === null) {
+				// this keybinding cannot be expressed...
+				return null;
+			}
+			result[i] = _simpleAsString(part, keyLabel, this.modifierLabels[OS]);
+		}
+		return result.join(' ');
+	}
+}
+
+/**
+ * A label provider that prints modifiers in a suitable format for displaying in the UI.
+ */
+export const UILabelProvider = new ModifierLabelProvider(
+	{
+		ctrlKey: '⌃',
+		shiftKey: '⇧',
+		altKey: '⌥',
+		metaKey: '⌘',
+		separator: '',
+	},
+	{
+		ctrlKey: nls.localize({ key: 'ctrlKey', comment: ['This is the short form for the Control key on the keyboard'] }, "Ctrl"),
+		shiftKey: nls.localize({ key: 'shiftKey', comment: ['This is the short form for the Shift key on the keyboard'] }, "Shift"),
+		altKey: nls.localize({ key: 'altKey', comment: ['This is the short form for the Alt key on the keyboard'] }, "Alt"),
+		metaKey: nls.localize({ key: 'windowsKey', comment: ['This is the short form for the Windows key on the keyboard'] }, "Windows"),
+		separator: '+',
+	},
+	{
+		ctrlKey: nls.localize({ key: 'ctrlKey', comment: ['This is the short form for the Control key on the keyboard'] }, "Ctrl"),
+		shiftKey: nls.localize({ key: 'shiftKey', comment: ['This is the short form for the Shift key on the keyboard'] }, "Shift"),
+		altKey: nls.localize({ key: 'altKey', comment: ['This is the short form for the Alt key on the keyboard'] }, "Alt"),
+		metaKey: nls.localize({ key: 'superKey', comment: ['This is the short form for the Super key on the keyboard'] }, "Super"),
+		separator: '+',
+	}
+);
+
+/**
+ * A label provider that prints modifiers in a suitable format for ARIA.
+ */
+export const AriaLabelProvider = new ModifierLabelProvider(
+	{
+		ctrlKey: nls.localize({ key: 'ctrlKey.long', comment: ['This is the long form for the Control key on the keyboard'] }, "Control"),
+		shiftKey: nls.localize({ key: 'shiftKey.long', comment: ['This is the long form for the Shift key on the keyboard'] }, "Shift"),
+		altKey: nls.localize({ key: 'altKey.long', comment: ['This is the long form for the Alt key on the keyboard'] }, "Alt"),
+		metaKey: nls.localize({ key: 'cmdKey.long', comment: ['This is the long form for the Command key on the keyboard'] }, "Command"),
+		separator: '+',
+	},
+	{
+		ctrlKey: nls.localize({ key: 'ctrlKey.long', comment: ['This is the long form for the Control key on the keyboard'] }, "Control"),
+		shiftKey: nls.localize({ key: 'shiftKey.long', comment: ['This is the long form for the Shift key on the keyboard'] }, "Shift"),
+		altKey: nls.localize({ key: 'altKey.long', comment: ['This is the long form for the Alt key on the keyboard'] }, "Alt"),
+		metaKey: nls.localize({ key: 'windowsKey.long', comment: ['This is the long form for the Windows key on the keyboard'] }, "Windows"),
+		separator: '+',
+	},
+	{
+		ctrlKey: nls.localize({ key: 'ctrlKey.long', comment: ['This is the long form for the Control key on the keyboard'] }, "Control"),
+		shiftKey: nls.localize({ key: 'shiftKey.long', comment: ['This is the long form for the Shift key on the keyboard'] }, "Shift"),
+		altKey: nls.localize({ key: 'altKey.long', comment: ['This is the long form for the Alt key on the keyboard'] }, "Alt"),
+		metaKey: nls.localize({ key: 'superKey.long', comment: ['This is the long form for the Super key on the keyboard'] }, "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
+ */
+export 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.
+ */
+export 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: Modifiers, key: string, labels: ModifierLabels): string {
+	if (key === null) {
+		return '';
+	}
+
+	const result: string[] = [];
+
+	// 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);
+}