src/vs/base/common/keybindingLabels.ts
184 LOC · 180 covered · 4 uncovered · 18 ranges · 1477 concepts · 8 introducers · 732 tests
File neighbourhood
The centred file is linked to every concept that introduces one of its ranges, every test that runs code from the file, and the gray connector concepts standing between those tests and the file's own introducer concepts. Undirected links join concepts to every file where they introduce source and concepts to the tests they introduce; arrows show specialization between the displayed concepts and bridge only concepts omitted from this view. Concept colors match the source ranges below; connector concepts have no source color and are shown in gray.
Focused file, its introducer and connector concepts, their introduced files, and tests that run code from the file
In the embedded map, ordinary wheel input scrolls the page; use the visible controls to zoom and drag to pan. Open the full-screen map for canvas navigation: wheel pans, Ctrl/Command plus wheel zooms, and arrow keys pan when this region is focused. On touch screens, open the full-screen map to pan or pinch. If JavaScript or WebGL is unavailable, use the related-file, concept, and source links on this page.
Graph controls are ready.
Interactive rendering requires JavaScript and WebGL. Use the related-file, concept, and source links on this page while the interactive map is unavailable.
1
>
/*---------------------------------------------------------------------------------------------
baseResolvedKeybinding.ts ×12
2
>
* Copyright (c) Microsoft Corporation. All rights reserved.
3
>
* Licensed under the MIT License. See License.txt in the project root for license information.
4
>
*--------------------------------------------------------------------------------------------*/
5
>
6
>
import { Modifiers } from './keybindings.js';
7
>
import { OperatingSystem } from './platform.js';
8
>
import * as nls from '../../nls.js';
9
>
10
>
export interface ModifierLabels {
11
>
readonly ctrlKey: string;
12
>
readonly shiftKey: string;
13
>
readonly altKey: string;
14
>
readonly metaKey: string;
15
>
readonly separator: string;
16
>
}
17
>
18
>
export interface KeyLabelProvider<T extends Modifiers> {
19
>
(keybinding: T): string | null;
20
>
}
21
>
22
>
export class ModifierLabelProvider {
23
>
24
>
public readonly modifierLabels: ModifierLabels[];
25
>
26
>
constructor(mac: ModifierLabels, windows: ModifierLabels, linux: ModifierLabels = windows) {
27
>
this.modifierLabels = [null!]; // index 0 will never me accessed.
28
>
this.modifierLabels[OperatingSystem.Macintosh] = mac;
29
>
this.modifierLabels[OperatingSystem.Windows] = windows;
30
>
this.modifierLabels[OperatingSystem.Linux] = linux;
31
>
}
32
>
33
>
public toLabel<T extends Modifiers>(OS: OperatingSystem, chords: readonly T[], keyLabelProvider: KeyLabelProvider<T>): string | null {
35
return null;
36
}
38
>
const result: string[] = [];
39
>
for (let i = 0, len = chords.length; i < len; i++) {
40
>
const chord = chords[i];
41
>
const keyLabel = keyLabelProvider(chord);
42
>
if (keyLabel === null) {
44
>
return null;
45
>
}
47
>
}
48
>
return result.join(' ');
49
>
}
51
>
52
>
/**
53
>
* A label provider that prints modifiers in a suitable format for displaying in the UI.
54
>
*/
55
>
export const UILabelProvider = new ModifierLabelProvider(
56
>
{
57
>
ctrlKey: '\u2303',
58
>
shiftKey: '⇧',
59
>
altKey: '⌥',
60
>
metaKey: '⌘',
61
>
separator: '',
62
>
},
63
>
{
64
>
ctrlKey: nls.localize({ key: 'ctrlKey', comment: ['This is the short form for the Control key on the keyboard'] }, "Ctrl"),
65
>
shiftKey: nls.localize({ key: 'shiftKey', comment: ['This is the short form for the Shift key on the keyboard'] }, "Shift"),
66
>
altKey: nls.localize({ key: 'altKey', comment: ['This is the short form for the Alt key on the keyboard'] }, "Alt"),
67
>
metaKey: nls.localize({ key: 'windowsKey', comment: ['This is the short form for the Windows key on the keyboard'] }, "Windows"),
68
>
separator: '+',
69
>
},
70
>
{
71
>
ctrlKey: nls.localize({ key: 'ctrlKey', comment: ['This is the short form for the Control key on the keyboard'] }, "Ctrl"),
72
>
shiftKey: nls.localize({ key: 'shiftKey', comment: ['This is the short form for the Shift key on the keyboard'] }, "Shift"),
73
>
altKey: nls.localize({ key: 'altKey', comment: ['This is the short form for the Alt key on the keyboard'] }, "Alt"),
74
>
metaKey: nls.localize({ key: 'superKey', comment: ['This is the short form for the Super key on the keyboard'] }, "Super"),
75
>
separator: '+',
76
>
}
77
>
);
78
>
79
>
/**
80
>
* A label provider that prints modifiers in a suitable format for ARIA.
81
>
*/
82
>
export const AriaLabelProvider = new ModifierLabelProvider(
83
>
{
84
>
ctrlKey: nls.localize({ key: 'ctrlKey.long', comment: ['This is the long form for the Control key on the keyboard'] }, "Control"),
85
>
shiftKey: nls.localize({ key: 'shiftKey.long', comment: ['This is the long form for the Shift key on the keyboard'] }, "Shift"),
86
>
altKey: nls.localize({ key: 'optKey.long', comment: ['This is the long form for the Alt/Option key on the keyboard'] }, "Option"),
87
>
metaKey: nls.localize({ key: 'cmdKey.long', comment: ['This is the long form for the Command key on the keyboard'] }, "Command"),
88
>
separator: '+',
89
>
},
90
>
{
91
>
ctrlKey: nls.localize({ key: 'ctrlKey.long', comment: ['This is the long form for the Control key on the keyboard'] }, "Control"),
92
>
shiftKey: nls.localize({ key: 'shiftKey.long', comment: ['This is the long form for the Shift key on the keyboard'] }, "Shift"),
93
>
altKey: nls.localize({ key: 'altKey.long', comment: ['This is the long form for the Alt key on the keyboard'] }, "Alt"),
94
>
metaKey: nls.localize({ key: 'windowsKey.long', comment: ['This is the long form for the Windows key on the keyboard'] }, "Windows"),
95
>
separator: '+',
96
>
},
97
>
{
98
>
ctrlKey: nls.localize({ key: 'ctrlKey.long', comment: ['This is the long form for the Control key on the keyboard'] }, "Control"),
99
>
shiftKey: nls.localize({ key: 'shiftKey.long', comment: ['This is the long form for the Shift key on the keyboard'] }, "Shift"),
100
>
altKey: nls.localize({ key: 'altKey.long', comment: ['This is the long form for the Alt key on the keyboard'] }, "Alt"),
101
>
metaKey: nls.localize({ key: 'superKey.long', comment: ['This is the long form for the Super key on the keyboard'] }, "Super"),
102
>
separator: '+',
103
>
}
104
>
);
105
>
106
>
/**
107
>
* A label provider that prints modifiers in a suitable format for Electron Accelerators.
108
>
* See https://github.com/electron/electron/blob/master/docs/api/accelerator.md
109
>
*/
110
>
export const ElectronAcceleratorLabelProvider = new ModifierLabelProvider(
111
>
{
112
>
ctrlKey: 'Ctrl',
113
>
shiftKey: 'Shift',
114
>
altKey: 'Alt',
115
>
metaKey: 'Cmd',
116
>
separator: '+',
117
>
},
118
>
{
119
>
ctrlKey: 'Ctrl',
120
>
shiftKey: 'Shift',
121
>
altKey: 'Alt',
122
>
metaKey: 'Super',
123
>
separator: '+',
124
>
}
125
>
);
126
>
127
>
/**
128
>
* A label provider that prints modifiers in a suitable format for user settings.
129
>
*/
130
>
export const UserSettingsLabelProvider = new ModifierLabelProvider(
131
>
{
132
>
ctrlKey: 'ctrl',
133
>
shiftKey: 'shift',
134
>
altKey: 'alt',
135
>
metaKey: 'cmd',
136
>
separator: '+',
137
>
},
138
>
{
139
>
ctrlKey: 'ctrl',
140
>
shiftKey: 'shift',
141
>
altKey: 'alt',
142
>
metaKey: 'win',
143
>
separator: '+',
144
>
},
145
>
{
146
>
ctrlKey: 'ctrl',
147
>
shiftKey: 'shift',
148
>
altKey: 'alt',
149
>
metaKey: 'meta',
150
>
separator: '+',
151
>
}
152
>
);
153
>
154
>
function _simpleAsString(modifiers: Modifiers, key: string, labels: ModifierLabels): string {
keybindingLabels.ts ×10
155
>
if (key === null) {
156
return '';
157
}
159
>
const result: string[] = [];
160
>
161
>
// translate modifier keys: Ctrl-Shift-Alt-Meta
162
>
if (modifiers.ctrlKey) {
164
>
}
166
>
if (modifiers.shiftKey) {
168
>
}
170
>
if (modifiers.altKey) {
172
>
}
174
>
if (modifiers.metaKey) {
176
>
}
178
>
// the actual key
179
>
if (key !== '') {
181
>
}
183
>
return result.join(labels.separator);
184
>
}