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
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
|
/*---------------------------------------------------------------------------------------------
* 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 { IActionViewItem } from 'vs/base/browser/ui/actionbar/actionbar';
import { IAction, toAction } from 'vs/base/common/actions';
import { CancellationToken } from 'vs/base/common/cancellation';
import { IErrorWithActions } from 'vs/base/common/errorMessage';
import { Emitter, Event } from 'vs/base/common/event';
import { DisposableStore, MutableDisposable } from 'vs/base/common/lifecycle';
import { extname, isEqual } from 'vs/base/common/resources';
import { URI } from 'vs/base/common/uri';
import { ITextResourceConfigurationService } from 'vs/editor/common/services/textResourceConfiguration';
import { localize } from 'vs/nls';
import { IContextKeyService } from 'vs/platform/contextkey/common/contextkey';
import { IEditorOptions } from 'vs/platform/editor/common/editor';
import { IFileService } from 'vs/platform/files/common/files';
import { IInstantiationService } from 'vs/platform/instantiation/common/instantiation';
import { IStorageService } from 'vs/platform/storage/common/storage';
import { ITelemetryService } from 'vs/platform/telemetry/common/telemetry';
import { IThemeService } from 'vs/platform/theme/common/themeService';
import { EditorPane } from 'vs/workbench/browser/parts/editor/editorPane';
import { DEFAULT_EDITOR_ASSOCIATION, EditorInputCapabilities, EditorPaneSelectionChangeReason, EditorPaneSelectionCompareResult, EditorResourceAccessor, IEditorMemento, IEditorOpenContext, IEditorPaneSelection, IEditorPaneSelectionChangeEvent, IEditorPaneWithSelection } from 'vs/workbench/common/editor';
import { EditorInput } from 'vs/workbench/common/editor/editorInput';
import { SELECT_KERNEL_ID } from 'vs/workbench/contrib/notebook/browser/controller/coreActions';
import { INotebookEditorOptions, INotebookEditorViewState } from 'vs/workbench/contrib/notebook/browser/notebookBrowser';
import { IBorrowValue, INotebookEditorService } from 'vs/workbench/contrib/notebook/browser/notebookEditorService';
import { NotebookEditorWidget } from 'vs/workbench/contrib/notebook/browser/notebookEditorWidget';
import { NotebooKernelActionViewItem } from 'vs/workbench/contrib/notebook/browser/viewParts/notebookKernelActionViewItem';
import { NotebookTextModel } from 'vs/workbench/contrib/notebook/common/model/notebookTextModel';
import { NOTEBOOK_EDITOR_ID } from 'vs/workbench/contrib/notebook/common/notebookCommon';
import { NotebookEditorInput } from 'vs/workbench/contrib/notebook/common/notebookEditorInput';
import { clearMarks, getAndClearMarks, mark } from 'vs/workbench/contrib/notebook/common/notebookPerformance';
import { IEditorDropService } from 'vs/workbench/services/editor/browser/editorDropService';
import { GroupsOrder, IEditorGroup, IEditorGroupsService } from 'vs/workbench/services/editor/common/editorGroupsService';
import { IEditorService } from 'vs/workbench/services/editor/common/editorService';
const NOTEBOOK_EDITOR_VIEW_STATE_PREFERENCE_KEY = 'NotebookEditorViewState';
export class NotebookEditor extends EditorPane implements IEditorPaneWithSelection {
static readonly ID: string = NOTEBOOK_EDITOR_ID;
private readonly _editorMemento: IEditorMemento<INotebookEditorViewState>;
private readonly _groupListener = this._register(new DisposableStore());
private readonly _widgetDisposableStore: DisposableStore = this._register(new DisposableStore());
private _widget: IBorrowValue<NotebookEditorWidget> = { value: undefined };
private _rootElement!: HTMLElement;
private _dimension?: DOM.Dimension;
private readonly _inputListener = this._register(new MutableDisposable());
// override onDidFocus and onDidBlur to be based on the NotebookEditorWidget element
private readonly _onDidFocusWidget = this._register(new Emitter<void>());
override get onDidFocus(): Event<void> { return this._onDidFocusWidget.event; }
private readonly _onDidBlurWidget = this._register(new Emitter<void>());
override get onDidBlur(): Event<void> { return this._onDidBlurWidget.event; }
private readonly _onDidChangeModel = this._register(new Emitter<void>());
readonly onDidChangeModel: Event<void> = this._onDidChangeModel.event;
private readonly _onDidChangeSelection = this._register(new Emitter<IEditorPaneSelectionChangeEvent>());
readonly onDidChangeSelection = this._onDidChangeSelection.event;
constructor(
@ITelemetryService telemetryService: ITelemetryService,
@IThemeService themeService: IThemeService,
@IInstantiationService private readonly _instantiationService: IInstantiationService,
@IStorageService storageService: IStorageService,
@IEditorService private readonly _editorService: IEditorService,
@IEditorGroupsService private readonly _editorGroupService: IEditorGroupsService,
@IEditorDropService private readonly _editorDropService: IEditorDropService,
@INotebookEditorService private readonly _notebookWidgetService: INotebookEditorService,
@IContextKeyService private readonly _contextKeyService: IContextKeyService,
@IFileService private readonly _fileService: IFileService,
@ITextResourceConfigurationService configurationService: ITextResourceConfigurationService
) {
super(NotebookEditor.ID, telemetryService, themeService, storageService);
this._editorMemento = this.getEditorMemento<INotebookEditorViewState>(_editorGroupService, configurationService, NOTEBOOK_EDITOR_VIEW_STATE_PREFERENCE_KEY);
this._register(this._fileService.onDidChangeFileSystemProviderCapabilities(e => this._onDidChangeFileSystemProvider(e.scheme)));
this._register(this._fileService.onDidChangeFileSystemProviderRegistrations(e => this._onDidChangeFileSystemProvider(e.scheme)));
}
private _onDidChangeFileSystemProvider(scheme: string): void {
if (this.input instanceof NotebookEditorInput && this.input.resource?.scheme === scheme) {
this._updateReadonly(this.input);
}
}
private _onDidChangeInputCapabilities(input: NotebookEditorInput): void {
if (this.input === input) {
this._updateReadonly(input);
}
}
private _updateReadonly(input: NotebookEditorInput): void {
if (this._widget.value) {
this._widget.value.setOptions({ isReadOnly: input.hasCapability(EditorInputCapabilities.Readonly) });
}
}
get textModel(): NotebookTextModel | undefined {
return this._widget.value?.textModel;
}
override get minimumWidth(): number { return 220; }
override get maximumWidth(): number { return Number.POSITIVE_INFINITY; }
// these setters need to exist because this extends from EditorPane
override set minimumWidth(value: number) { /*noop*/ }
override set maximumWidth(value: number) { /*noop*/ }
//#region Editor Core
override get scopedContextKeyService(): IContextKeyService | undefined {
return this._widget.value?.scopedContextKeyService;
}
protected createEditor(parent: HTMLElement): void {
this._rootElement = DOM.append(parent, DOM.$('.notebook-editor'));
}
getDomNode() {
return this._rootElement;
}
override getActionViewItem(action: IAction): IActionViewItem | undefined {
if (action.id === SELECT_KERNEL_ID) {
// this is being disposed by the consumer
return this._instantiationService.createInstance(NotebooKernelActionViewItem, action, this);
}
return undefined;
}
override getControl(): NotebookEditorWidget | undefined {
return this._widget.value;
}
override setEditorVisible(visible: boolean, group: IEditorGroup | undefined): void {
super.setEditorVisible(visible, group);
if (group) {
this._groupListener.clear();
this._groupListener.add(group.onWillCloseEditor(e => this._saveEditorViewState(e.editor)));
this._groupListener.add(group.onDidModelChange(() => {
if (this._editorGroupService.activeGroup !== group) {
this._widget?.value?.updateEditorFocus();
}
}));
}
if (!visible) {
this._saveEditorViewState(this.input);
if (this.input && this._widget.value) {
// the widget is not transfered to other editor inputs
this._widget.value.onWillHide();
}
}
}
override focus() {
super.focus();
this._widget.value?.focus();
}
override hasFocus(): boolean {
const activeElement = document.activeElement;
const value = this._widget.value;
return !!value && (DOM.isAncestor(activeElement, value.getDomNode() || DOM.isAncestor(activeElement, value.getOverflowContainerDomNode())));
}
override async setInput(input: NotebookEditorInput, options: INotebookEditorOptions | undefined, context: IEditorOpenContext, token: CancellationToken, noRetry?: boolean): Promise<void> {
try {
clearMarks(input.resource);
mark(input.resource, 'startTime');
const group = this.group!;
this._inputListener.value = input.onDidChangeCapabilities(() => this._onDidChangeInputCapabilities(input));
this._widgetDisposableStore.clear();
// there currently is a widget which we still own so
// we need to hide it before getting a new widget
if (this._widget.value) {
this._widget.value.onWillHide();
}
this._widget = <IBorrowValue<NotebookEditorWidget>>this._instantiationService.invokeFunction(this._notebookWidgetService.retrieveWidget, group, input);
this._widgetDisposableStore.add(this._widget.value!.onDidChangeModel(() => this._onDidChangeModel.fire()));
this._widgetDisposableStore.add(this._widget.value!.onDidChangeActiveCell(() => this._onDidChangeSelection.fire({ reason: EditorPaneSelectionChangeReason.USER })));
if (this._dimension) {
this._widget.value!.layout(this._dimension, this._rootElement);
}
// only now `setInput` and yield/await. this is AFTER the actual widget is ready. This is very important
// so that others synchronously receive a notebook editor with the correct widget being set
await super.setInput(input, options, context, token);
const model = await input.resolve();
mark(input.resource, 'inputLoaded');
// Check for cancellation
if (token.isCancellationRequested) {
return undefined;
}
// The widget has been taken away again. This can happen when the tab has been closed while
// loading was in progress, in particular when open the same resource as different view type.
// When this happen, retry once
if (!this._widget.value) {
if (noRetry) {
return undefined;
}
return this.setInput(input, options, context, token, true);
}
if (model === null) {
throw new Error(localize('fail.noEditor', "Cannot open resource with notebook editor type '{0}', please check if you have the right extension installed and enabled.", input.viewType));
}
this._widgetDisposableStore.add(model.notebook.onDidChangeContent(() => this._onDidChangeSelection.fire({ reason: EditorPaneSelectionChangeReason.EDIT })));
const viewState = options?.viewState ?? this._loadNotebookEditorViewState(input);
this._widget.value?.setParentContextKeyService(this._contextKeyService);
await this._widget.value!.setModel(model.notebook, viewState);
const isReadOnly = input.hasCapability(EditorInputCapabilities.Readonly);
await this._widget.value!.setOptions({ ...options, isReadOnly });
this._widgetDisposableStore.add(this._widget.value!.onDidFocusWidget(() => this._onDidFocusWidget.fire()));
this._widgetDisposableStore.add(this._widget.value!.onDidBlurWidget(() => this._onDidBlurWidget.fire()));
this._widgetDisposableStore.add(this._editorDropService.createEditorDropTarget(this._widget.value!.getDomNode(), {
containsGroup: (group) => this.group?.id === group.id
}));
mark(input.resource, 'editorLoaded');
type WorkbenchNotebookOpenClassification = {
scheme: { classification: 'SystemMetaData'; purpose: 'FeatureInsight' };
ext: { classification: 'SystemMetaData'; purpose: 'FeatureInsight' };
viewType: { classification: 'SystemMetaData'; purpose: 'FeatureInsight' };
extensionActivated: { classification: 'SystemMetaData'; purpose: 'FeatureInsight' };
inputLoaded: { classification: 'SystemMetaData'; purpose: 'FeatureInsight' };
webviewCommLoaded: { classification: 'SystemMetaData'; purpose: 'FeatureInsight' };
customMarkdownLoaded: { classification: 'SystemMetaData'; purpose: 'FeatureInsight' };
editorLoaded: { classification: 'SystemMetaData'; purpose: 'FeatureInsight' };
};
type WorkbenchNotebookOpenEvent = {
scheme: string;
ext: string;
viewType: string;
extensionActivated: number;
inputLoaded: number;
webviewCommLoaded: number;
customMarkdownLoaded: number;
editorLoaded: number;
};
const perfMarks = getAndClearMarks(input.resource);
if (perfMarks) {
const startTime = perfMarks['startTime'];
const extensionActivated = perfMarks['extensionActivated'];
const inputLoaded = perfMarks['inputLoaded'];
const customMarkdownLoaded = perfMarks['customMarkdownLoaded'];
const editorLoaded = perfMarks['editorLoaded'];
if (
startTime !== undefined
&& extensionActivated !== undefined
&& inputLoaded !== undefined
&& customMarkdownLoaded !== undefined
&& editorLoaded !== undefined
) {
this.telemetryService.publicLog2<WorkbenchNotebookOpenEvent, WorkbenchNotebookOpenClassification>('notebook/editorOpenPerf', {
scheme: model.notebook.uri.scheme,
ext: extname(model.notebook.uri),
viewType: model.notebook.viewType,
extensionActivated: extensionActivated - startTime,
inputLoaded: inputLoaded - startTime,
webviewCommLoaded: inputLoaded - startTime,
customMarkdownLoaded: customMarkdownLoaded - startTime,
editorLoaded: editorLoaded - startTime
});
} else {
console.warn(`notebook file open perf marks are broken: startTime ${startTime}, extensionActiviated ${extensionActivated}, inputLoaded ${inputLoaded}, customMarkdownLoaded ${customMarkdownLoaded}, editorLoaded ${editorLoaded}`);
}
}
} catch (e) {
const error: Error & IErrorWithActions = e instanceof Error ? e : new Error(e.message);
error.actions = [
toAction({
id: 'workbench.notebook.action.openInTextEditor', label: localize('notebookOpenInTextEditor', "Open in Text Editor"), run: async () => {
const activeEditorPane = this._editorService.activeEditorPane;
if (!activeEditorPane) {
return;
}
const activeEditorResource = EditorResourceAccessor.getCanonicalUri(activeEditorPane.input);
if (!activeEditorResource) {
return;
}
if (activeEditorResource.toString() === input.resource?.toString()) {
// Replace the current editor with the text editor
return this._editorService.openEditor({
resource: activeEditorResource,
options: {
override: DEFAULT_EDITOR_ASSOCIATION.id,
pinned: true // new file gets pinned by default
}
});
}
return;
}
})
];
throw error;
}
}
override clearInput(): void {
this._inputListener.clear();
if (this._widget.value) {
this._saveEditorViewState(this.input);
this._widget.value.onWillHide();
}
super.clearInput();
}
override setOptions(options: INotebookEditorOptions | undefined): void {
this._widget.value?.setOptions(options);
super.setOptions(options);
}
protected override saveState(): void {
this._saveEditorViewState(this.input);
super.saveState();
}
override getViewState(): INotebookEditorViewState | undefined {
const input = this.input;
if (!(input instanceof NotebookEditorInput)) {
return undefined;
}
this._saveEditorViewState(input);
return this._loadNotebookEditorViewState(input);
}
getSelection(): IEditorPaneSelection | undefined {
if (this._widget.value) {
const cellUri = this._widget.value.getActiveCell()?.uri;
if (cellUri) {
return new NotebookEditorSelection(cellUri);
}
}
return undefined;
}
private _saveEditorViewState(input: EditorInput | undefined): void {
if (this.group && this._widget.value && input instanceof NotebookEditorInput) {
if (this._widget.value.isDisposed) {
return;
}
const state = this._widget.value.getEditorViewState();
this._editorMemento.saveEditorState(this.group, input.resource, state);
}
}
private _loadNotebookEditorViewState(input: NotebookEditorInput): INotebookEditorViewState | undefined {
let result: INotebookEditorViewState | undefined;
if (this.group) {
result = this._editorMemento.loadEditorState(this.group, input.resource);
}
if (result) {
return result;
}
// when we don't have a view state for the group/input-tuple then we try to use an existing
// editor for the same resource.
for (const group of this._editorGroupService.getGroups(GroupsOrder.MOST_RECENTLY_ACTIVE)) {
if (group.activeEditorPane !== this && group.activeEditorPane instanceof NotebookEditor && group.activeEditor?.matches(input)) {
return group.activeEditorPane._widget.value?.getEditorViewState();
}
}
return;
}
layout(dimension: DOM.Dimension): void {
this._rootElement.classList.toggle('mid-width', dimension.width < 1000 && dimension.width >= 600);
this._rootElement.classList.toggle('narrow-width', dimension.width < 600);
this._dimension = dimension;
if (!this._widget.value || !(this._input instanceof NotebookEditorInput)) {
return;
}
if (this._input.resource.toString() !== this.textModel?.uri.toString() && this._widget.value?.hasModel()) {
// input and widget mismatch
// this happens when
// 1. open document A, pin the document
// 2. open document B
// 3. close document B
// 4. a layout is triggered
return;
}
this._widget.value.layout(this._dimension, this._rootElement);
}
//#endregion
//#region Editor Features
//#endregion
override dispose() {
super.dispose();
}
// toJSON(): object {
// return {
// notebookHandle: this.viewModel?.handle
// };
// }
}
class NotebookEditorSelection implements IEditorPaneSelection {
constructor(
private readonly cellUri: URI
) { }
compare(other: IEditorPaneSelection): EditorPaneSelectionCompareResult {
if (!(other instanceof NotebookEditorSelection)) {
return EditorPaneSelectionCompareResult.DIFFERENT;
}
if (isEqual(this.cellUri, other.cellUri)) {
return EditorPaneSelectionCompareResult.IDENTICAL;
}
return EditorPaneSelectionCompareResult.DIFFERENT;
}
restore(options: IEditorOptions): INotebookEditorOptions {
const notebookOptions: INotebookEditorOptions = {
cellOptions: {
resource: this.cellUri
}
};
Object.assign(notebookOptions, options);
return notebookOptions;
}
log(): string {
return this.cellUri.fragment;
}
}
|