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
|
/*---------------------------------------------------------------------------------------------
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the MIT License. See License.txt in the project root for license information.
*--------------------------------------------------------------------------------------------*/
import * as dom from 'vs/base/browser/dom';
import { CancellationTokenSource } from 'vs/base/common/cancellation';
import { KeyCode } from 'vs/base/common/keyCodes';
import { DisposableStore } from 'vs/base/common/lifecycle';
import { ICodeEditor } from 'vs/editor/browser/editorBrowser';
import { EditorAction2, registerEditorContribution } from 'vs/editor/browser/editorExtensions';
import { IEditorContribution } from 'vs/editor/common/editorCommon';
import { EditorContextKeys } from 'vs/editor/common/editorContextKeys';
import { InlayHintItem, asCommandLink } from 'vs/editor/contrib/inlayHints/browser/inlayHints';
import { InlayHintsController } from 'vs/editor/contrib/inlayHints/browser/inlayHintsController';
import { localize } from 'vs/nls';
import { registerAction2 } from 'vs/platform/actions/common/actions';
import { IContextKey, IContextKeyService, RawContextKey } from 'vs/platform/contextkey/common/contextkey';
import { IInstantiationService, ServicesAccessor } from 'vs/platform/instantiation/common/instantiation';
import { KeybindingWeight } from 'vs/platform/keybinding/common/keybindingsRegistry';
import { Link } from 'vs/platform/opener/browser/link';
import { AudioCue, IAudioCueService } from 'vs/workbench/contrib/audioCues/browser/audioCueService';
export class InlayHintsAccessibility implements IEditorContribution {
static readonly IsReading = new RawContextKey<boolean>('isReadingLineWithInlayHints', false, { type: 'boolean', description: localize('isReadingLineWithInlayHints', "Whether the current line and its inlay hints are currently focused") });
static readonly ID: string = 'editor.contrib.InlayHintsAccessibility';
static get(editor: ICodeEditor): InlayHintsAccessibility | undefined {
return editor.getContribution<InlayHintsAccessibility>(InlayHintsAccessibility.ID) ?? undefined;
}
private readonly _ariaElement: HTMLSpanElement;
private readonly _ctxIsReading: IContextKey<boolean>;
private _sessionDispoosables = new DisposableStore();
constructor(
private readonly _editor: ICodeEditor,
@IContextKeyService contextKeyService: IContextKeyService,
@IAudioCueService private readonly _audioCueService: IAudioCueService,
@IInstantiationService private readonly _instaService: IInstantiationService,
) {
this._ariaElement = document.createElement('span');
this._ariaElement.style.position = 'fixed';
this._ariaElement.className = 'inlayhint-accessibility-element';
this._ariaElement.tabIndex = 0;
this._ariaElement.setAttribute('aria-description', localize('description', "Code with Inlay Hint Information"));
this._ctxIsReading = InlayHintsAccessibility.IsReading.bindTo(contextKeyService);
}
dispose(): void {
this._sessionDispoosables.dispose();
this._ctxIsReading.reset();
this._ariaElement.remove();
}
private _reset(): void {
dom.clearNode(this._ariaElement);
this._sessionDispoosables.clear();
this._ctxIsReading.reset();
}
private async _read(line: number, hints: InlayHintItem[]) {
this._sessionDispoosables.clear();
if (!this._ariaElement.isConnected) {
this._editor.getDomNode()?.appendChild(this._ariaElement);
}
if (!this._editor.hasModel() || !this._ariaElement.isConnected) {
this._ctxIsReading.set(false);
return;
}
const cts = new CancellationTokenSource();
this._sessionDispoosables.add(cts);
for (const hint of hints) {
await hint.resolve(cts.token);
}
if (cts.token.isCancellationRequested) {
return;
}
const model = this._editor.getModel();
// const text = this._editor.getModel().getLineContent(line);
const newChildren: (string | HTMLElement)[] = [];
let start = 0;
let tooLongToRead = false;
for (const item of hints) {
// text
const part = model.getValueInRange({ startLineNumber: line, startColumn: start + 1, endLineNumber: line, endColumn: item.hint.position.column });
if (part.length > 0) {
newChildren.push(part);
start = item.hint.position.column - 1;
}
// check length
if (start > 750) {
newChildren.push('…');
tooLongToRead = true;
break;
}
// hint
const em = document.createElement('em');
const { label } = item.hint;
if (typeof label === 'string') {
em.innerText = label;
} else {
for (const part of label) {
if (part.command) {
const link = this._instaService.createInstance(Link, em,
{ href: asCommandLink(part.command), label: part.label, title: part.command.title },
undefined
);
this._sessionDispoosables.add(link);
} else {
em.innerText += part.label;
}
}
}
newChildren.push(em);
}
// trailing text
if (!tooLongToRead) {
newChildren.push(model.getValueInRange({ startLineNumber: line, startColumn: start + 1, endLineNumber: line, endColumn: Number.MAX_SAFE_INTEGER }));
}
dom.reset(this._ariaElement, ...newChildren);
this._ariaElement.focus();
this._ctxIsReading.set(true);
// reset on blur
this._sessionDispoosables.add(dom.addDisposableListener(this._ariaElement, 'focusout', () => {
this._reset();
}));
}
startInlayHintsReading(): void {
if (!this._editor.hasModel()) {
return;
}
const line = this._editor.getPosition().lineNumber;
const hints = InlayHintsController.get(this._editor)?.getInlayHintsForLine(line);
if (!hints || hints.length === 0) {
this._audioCueService.playAudioCue(AudioCue.noInlayHints);
} else {
this._read(line, hints);
}
}
stopInlayHintsReading(): void {
this._reset();
this._editor.focus();
}
}
registerAction2(class StartReadHints extends EditorAction2 {
constructor() {
super({
id: 'inlayHints.startReadingLineWithHint',
title: localize('read.title', 'Read Line With Inline Hints'),
precondition: EditorContextKeys.hasInlayHintsProvider,
f1: true
});
}
runEditorCommand(_accessor: ServicesAccessor, editor: ICodeEditor) {
const ctrl = InlayHintsAccessibility.get(editor);
if (ctrl) {
ctrl.startInlayHintsReading();
}
}
});
registerAction2(class StopReadHints extends EditorAction2 {
constructor() {
super({
id: 'inlayHints.stopReadingLineWithHint',
title: localize('stop.title', 'Stop Inlay Hints Reading'),
precondition: InlayHintsAccessibility.IsReading,
f1: true,
keybinding: {
weight: KeybindingWeight.EditorContrib,
primary: KeyCode.Escape
}
});
}
runEditorCommand(_accessor: ServicesAccessor, editor: ICodeEditor) {
const ctrl = InlayHintsAccessibility.get(editor);
if (ctrl) {
ctrl.stopInlayHintsReading();
}
}
});
registerEditorContribution(InlayHintsAccessibility.ID, InlayHintsAccessibility);
|
