extHostNotebook.ts 31.8 KB
Newer Older
R
rebornix 已提交
1 2 3 4 5 6
/*---------------------------------------------------------------------------------------------
 *  Copyright (c) Microsoft Corporation. All rights reserved.
 *  Licensed under the MIT License. See License.txt in the project root for license information.
 *--------------------------------------------------------------------------------------------*/

import * as vscode from 'vscode';
R
rebornix 已提交
7 8
import { readonly } from 'vs/base/common/errors';
import { Emitter, Event } from 'vs/base/common/event';
R
rebornix 已提交
9
import { Disposable, DisposableStore, IDisposable } from 'vs/base/common/lifecycle';
10
import { ISplice } from 'vs/base/common/sequence';
11 12
import { URI, UriComponents } from 'vs/base/common/uri';
import { IExtensionDescription } from 'vs/platform/extensions/common/extensions';
R
rebornix 已提交
13
import { CellKind, CellOutputKind, ExtHostNotebookShape, IMainContext, MainContext, MainThreadNotebookShape, NotebookCellOutputsSplice, MainThreadDocumentsShape, INotebookEditorPropertiesChangeData, INotebookDocumentsAndEditorsDelta } from 'vs/workbench/api/common/extHost.protocol';
14
import { ExtHostCommands } from 'vs/workbench/api/common/extHostCommands';
15
import { ExtHostDocumentsAndEditors } from 'vs/workbench/api/common/extHostDocumentsAndEditors';
R
rebornix 已提交
16
import { CellEditType, CellUri, diff, ICellEditOperation, ICellInsertEdit, IErrorOutput, INotebookDisplayOrder, INotebookEditData, IOrderedMimeType, IStreamOutput, ITransformedDisplayOutputDto, mimeTypeSupportedByCore, NotebookCellsChangedEvent, NotebookCellsSplice2, sortMimeTypes, ICellDeleteEdit, notebookDocumentMetadataDefaults, NotebookCellsChangeType, NotebookDataDto } from 'vs/workbench/contrib/notebook/common/notebookCommon';
17
import { Disposable as VSCodeDisposable } from './extHostTypes';
18
import { CancellationToken } from 'vs/base/common/cancellation';
19 20
import { ExtHostDocumentData } from 'vs/workbench/api/common/extHostDocumentData';
import { NotImplementedProxy } from 'vs/base/common/types';
R
rebornix 已提交
21
import * as typeConverters from 'vs/workbench/api/common/extHostTypeConverters';
R
rebornix 已提交
22
import { asWebviewUri, WebviewInitData } from 'vs/workbench/api/common/shared/webview';
23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43

interface IObservable<T> {
	proxy: T;
	onDidChange: Event<void>;
}

function getObservable<T extends Object>(obj: T): IObservable<T> {
	const onDidChange = new Emitter<void>();
	const proxy = new Proxy(obj, {
		set(target: T, p: PropertyKey, value: any, _receiver: any): boolean {
			target[p as keyof T] = value;
			onDidChange.fire();
			return true;
		}
	});

	return {
		proxy,
		onDidChange: onDidChange.event
	};
}
R
rebornix 已提交
44

45
export class ExtHostCell extends Disposable implements vscode.NotebookCell {
R
rebornix 已提交
46

47
	// private originalSource: string[];
R
rebornix 已提交
48
	private _outputs: any[];
49 50
	private _onDidChangeOutputs = new Emitter<ISplice<vscode.CellOutput>[]>();
	onDidChangeOutputs: Event<ISplice<vscode.CellOutput>[]> = this._onDidChangeOutputs.event;
51 52
	// private _textDocument: vscode.TextDocument | undefined;
	// private _initalVersion: number = -1;
53
	private _outputMapping = new Set<vscode.CellOutput>();
54 55 56
	private _metadata: vscode.NotebookCellMetadata;

	private _metadataChangeListener: IDisposable;
R
rebornix 已提交
57

58 59 60 61 62 63
	private _documentData: ExtHostDocumentData;

	get document(): vscode.TextDocument {
		return this._documentData.document;
	}

R
rebornix 已提交
64
	get source() {
65 66
		// todo@jrieken remove this
		return this._documentData.getText();
R
rebornix 已提交
67 68
	}

R
rebornix 已提交
69
	constructor(
70 71
		private readonly viewType: string,
		private readonly documentUri: URI,
72 73
		readonly handle: number,
		readonly uri: URI,
74
		content: string,
R
rebornix 已提交
75
		public readonly cellKind: CellKind,
R
rebornix 已提交
76
		public language: string,
R
rebornix 已提交
77
		outputs: any[],
78
		_metadata: vscode.NotebookCellMetadata | undefined,
79
		private _proxy: MainThreadNotebookShape,
R
rebornix 已提交
80
	) {
81
		super();
82 83 84 85 86 87 88
		this._documentData = new ExtHostDocumentData(
			new class extends NotImplementedProxy<MainThreadDocumentsShape>('document') { },
			uri,
			content.split(/\r|\n|\r\n/g), '\n',
			language, 0, false
		);

R
rebornix 已提交
89
		this._outputs = outputs;
90

91
		const observableMetadata = getObservable(_metadata || {});
92 93 94 95
		this._metadata = observableMetadata.proxy;
		this._metadataChangeListener = this._register(observableMetadata.onDidChange(() => {
			this.updateMetadata();
		}));
R
rebornix 已提交
96 97 98 99 100 101
	}

	get outputs() {
		return this._outputs;
	}

R
rebornix 已提交
102
	set outputs(newOutputs: vscode.CellOutput[]) {
103
		let diffs = diff<vscode.CellOutput>(this._outputs || [], newOutputs || [], (a) => {
104 105 106 107 108 109 110 111 112 113 114 115 116
			return this._outputMapping.has(a);
		});

		diffs.forEach(diff => {
			for (let i = diff.start; i < diff.start + diff.deleteCount; i++) {
				this._outputMapping.delete(this._outputs[i]);
			}

			diff.toInsert.forEach(output => {
				this._outputMapping.add(output);
			});
		});

R
rebornix 已提交
117
		this._outputs = newOutputs;
118
		this._onDidChangeOutputs.fire(diffs);
R
rebornix 已提交
119 120
	}

121 122 123 124
	get metadata() {
		return this._metadata;
	}

R
rebornix 已提交
125
	set metadata(newMetadata: vscode.NotebookCellMetadata) {
126
		// Don't apply metadata defaults here, 'undefined' means 'inherit from document metadata'
127
		this._metadataChangeListener.dispose();
128
		const observableMetadata = getObservable(newMetadata);
129 130 131 132 133 134 135
		this._metadata = observableMetadata.proxy;
		this._metadataChangeListener = this._register(observableMetadata.onDidChange(() => {
			this.updateMetadata();
		}));

		this.updateMetadata();
	}
136

137 138
	private updateMetadata(): Promise<void> {
		return this._proxy.$updateNotebookCellMetadata(this.viewType, this.documentUri, this.handle, this._metadata);
139 140
	}

141 142 143
	attachTextDocument(document: ExtHostDocumentData) {
		this._documentData = document;
		// this._initalVersion = this._documentData.version;
R
rebornix 已提交
144 145
	}

R
rebornix 已提交
146
	detachTextDocument() {
147
		// no-op? keep stale document until new comes along?
R
rebornix 已提交
148

149 150 151 152 153
		// if (this._textDocument && this._textDocument.version !== this._initalVersion) {
		// 	this.originalSource = this._textDocument.getText().split(/\r|\n|\r\n/g);
		// }
		// this._textDocument = undefined;
		// this._initalVersion = -1;
R
rebornix 已提交
154 155 156
	}
}

R
rebornix 已提交
157
export class ExtHostNotebookDocument extends Disposable implements vscode.NotebookDocument {
R
rebornix 已提交
158
	private static _handlePool: number = 0;
R
rebornix 已提交
159 160 161 162
	readonly handle = ExtHostNotebookDocument._handlePool++;

	private _cells: ExtHostCell[] = [];

R
rebornix 已提交
163 164
	private _cellDisposableMapping = new Map<number, DisposableStore>();

R
rebornix 已提交
165 166 167 168
	get cells() {
		return this._cells;
	}

R
rebornix 已提交
169 170 171 172 173
	private _languages: string[] = [];

	get languages() {
		return this._languages = [];
	}
R
rebornix 已提交
174

R
rebornix 已提交
175 176 177
	set languages(newLanguages: string[]) {
		this._languages = newLanguages;
		this._proxy.$updateNotebookLanguages(this.viewType, this.uri, this._languages);
R
rebornix 已提交
178
	}
R
rebornix 已提交
179

180 181
	private _metadata: Required<vscode.NotebookDocumentMetadata> = notebookDocumentMetadataDefaults;
	private _metadataChangeListener: IDisposable;
R
rebornix 已提交
182 183 184 185 186

	get metadata() {
		return this._metadata;
	}

187 188 189 190 191 192
	set metadata(newMetadata: Required<vscode.NotebookDocumentMetadata>) {
		this._metadataChangeListener.dispose();
		newMetadata = {
			...notebookDocumentMetadataDefaults,
			...newMetadata
		};
R
rebornix 已提交
193 194 195 196
		if (this._metadataChangeListener) {
			this._metadataChangeListener.dispose();
		}

197 198 199 200 201
		const observableMetadata = getObservable(newMetadata);
		this._metadata = observableMetadata.proxy;
		this._metadataChangeListener = this._register(observableMetadata.onDidChange(() => {
			this.updateMetadata();
		}));
R
rebornix 已提交
202 203

		this.updateMetadata();
R
rebornix 已提交
204 205
	}

R
rebornix 已提交
206
	private _displayOrder: string[] = [];
R
rebornix 已提交
207 208 209 210 211

	get displayOrder() {
		return this._displayOrder;
	}

R
rebornix 已提交
212
	set displayOrder(newOrder: string[]) {
R
rebornix 已提交
213 214 215
		this._displayOrder = newOrder;
	}

R
rebornix 已提交
216 217 218 219 220 221
	private _versionId = 0;

	get versionId() {
		return this._versionId;
	}

R
rebornix 已提交
222
	constructor(
R
rebornix 已提交
223
		private readonly _proxy: MainThreadNotebookShape,
R
rebornix 已提交
224
		private _documentsAndEditors: ExtHostDocumentsAndEditors,
R
rebornix 已提交
225
		public viewType: string,
R
rebornix 已提交
226 227
		public uri: URI,
		public renderingHandler: ExtHostNotebookOutputRenderingHandler
R
rebornix 已提交
228
	) {
R
rebornix 已提交
229
		super();
230 231 232 233 234 235 236 237 238 239

		const observableMetadata = getObservable(notebookDocumentMetadataDefaults);
		this._metadata = observableMetadata.proxy;
		this._metadataChangeListener = this._register(observableMetadata.onDidChange(() => {
			this.updateMetadata();
		}));
	}

	private updateMetadata() {
		this._proxy.$updateNotebookMetadata(this.viewType, this.uri, this._metadata);
R
rebornix 已提交
240
	}
R
rebornix 已提交
241

R
rebornix 已提交
242
	dispose() {
R
rebornix 已提交
243
		super.dispose();
R
rebornix 已提交
244 245
		this._cellDisposableMapping.forEach(cell => cell.dispose());
	}
R
rebornix 已提交
246

R
rebornix 已提交
247
	get fileName() { return this.uri.fsPath; }
R
rebornix 已提交
248

R
rebornix 已提交
249 250
	get isDirty() { return false; }

R
rebornix 已提交
251
	accpetModelChanged(event: NotebookCellsChangedEvent) {
R
rebornix 已提交
252 253 254 255
		if (event.kind === NotebookCellsChangeType.ModelChange) {
			this.$spliceNotebookCells(event.changes);
		} else if (event.kind === NotebookCellsChangeType.Move) {
			this.$moveCell(event.index, event.newIdx);
R
rebornix 已提交
256 257 258 259
		} else if (event.kind === NotebookCellsChangeType.CellClearOutput) {
			this.$clearCellOutputs(event.index);
		} else if (event.kind === NotebookCellsChangeType.CellsClearOutput) {
			this.$clearAllCellOutputs();
260 261
		} else if (event.kind === NotebookCellsChangeType.ChangeLanguage) {
			this.$changeCellLanguage(event.index, event.language);
R
rebornix 已提交
262 263
		}

R
rebornix 已提交
264 265
		this._versionId = event.versionId;
	}
266

R
rebornix 已提交
267 268 269 270
	private $spliceNotebookCells(splices: NotebookCellsSplice2[]): void {
		if (!splices.length) {
			return;
		}
271

R
rebornix 已提交
272 273 274 275
		splices.reverse().forEach(splice => {
			let cellDtos = splice[2];
			let newCells = cellDtos.map(cell => {
				const extCell = new ExtHostCell(this.viewType, this.uri, cell.handle, URI.revive(cell.uri), cell.source.join('\n'), cell.cellKind, cell.language, cell.outputs, cell.metadata, this._proxy);
276
				const documentData = this._documentsAndEditors.getDocument(URI.revive(cell.uri));
277

278 279
				if (documentData) {
					extCell.attachTextDocument(documentData);
R
rebornix 已提交
280 281 282 283
				}

				if (!this._cellDisposableMapping.has(extCell.handle)) {
					this._cellDisposableMapping.set(extCell.handle, new DisposableStore());
284 285
				}

R
rebornix 已提交
286 287 288 289 290 291 292
				let store = this._cellDisposableMapping.get(extCell.handle)!;

				store.add(extCell.onDidChangeOutputs((diffs) => {
					this.eventuallyUpdateCellOutputs(extCell, diffs);
				}));

				return extCell;
293 294
			});

R
rebornix 已提交
295 296 297 298 299
			for (let j = splice[0]; j < splice[0] + splice[1]; j++) {
				this._cellDisposableMapping.get(this.cells[j].handle)?.dispose();
				this._cellDisposableMapping.delete(this.cells[j].handle);

			}
300

R
rebornix 已提交
301 302
			this.cells.splice(splice[0], splice[1], ...newCells);
		});
R
rebornix 已提交
303
	}
R
rebornix 已提交
304

R
rebornix 已提交
305 306 307 308 309
	private $moveCell(index: number, newIdx: number) {
		const cells = this.cells.splice(index, 1);
		this.cells.splice(newIdx, 0, ...cells);
	}

R
rebornix 已提交
310 311 312 313 314 315 316 317 318
	private $clearCellOutputs(index: number) {
		const cell = this.cells[index];
		cell.outputs = [];
	}

	private $clearAllCellOutputs() {
		this.cells.forEach(cell => cell.outputs = []);
	}

319 320 321 322 323
	private $changeCellLanguage(index: number, language: string) {
		const cell = this.cells[index];
		cell.language = language;
	}

324 325 326 327 328
	eventuallyUpdateCellOutputs(cell: ExtHostCell, diffs: ISplice<vscode.CellOutput>[]) {
		let renderers = new Set<number>();
		let outputDtos: NotebookCellOutputsSplice[] = diffs.map(diff => {
			let outputs = diff.toInsert;

329
			let transformedOutputs = outputs.map(output => {
R
rebornix 已提交
330
				if (output.outputKind === CellOutputKind.Rich) {
R
rebornix 已提交
331
					const ret = this.transformMimeTypes(output);
332

333 334
					if (ret.orderedMimeTypes[ret.pickedMimeTypeIndex].isResolved) {
						renderers.add(ret.orderedMimeTypes[ret.pickedMimeTypeIndex].rendererId!);
335
					}
336 337 338
					return ret;
				} else {
					return output as IStreamOutput | IErrorOutput;
339 340 341
				}
			});

342
			return [diff.start, diff.deleteCount, transformedOutputs];
343 344 345 346 347
		});

		this._proxy.$spliceNotebookCellOutputs(this.viewType, this.uri, cell.handle, outputDtos, Array.from(renderers));
	}

R
rebornix 已提交
348
	transformMimeTypes(output: vscode.CellDisplayOutput): ITransformedDisplayOutputDto {
349
		let mimeTypes = Object.keys(output.data);
R
rebornix 已提交
350
		let coreDisplayOrder = this.renderingHandler.outputDisplayOrder;
R
rebornix 已提交
351
		const sorted = sortMimeTypes(mimeTypes, coreDisplayOrder?.userOrder || [], this._displayOrder, coreDisplayOrder?.defaultOrder || []);
352 353 354 355 356 357 358

		let orderMimeTypes: IOrderedMimeType[] = [];

		sorted.forEach(mimeType => {
			let handlers = this.renderingHandler.findBestMatchedRenderer(mimeType);

			if (handlers.length) {
R
rebornix 已提交
359
				let renderedOutput = handlers[0].render(this, output, mimeType);
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

				orderMimeTypes.push({
					mimeType: mimeType,
					isResolved: true,
					rendererId: handlers[0].handle,
					output: renderedOutput
				});

				for (let i = 1; i < handlers.length; i++) {
					orderMimeTypes.push({
						mimeType: mimeType,
						isResolved: false,
						rendererId: handlers[i].handle
					});
				}

				if (mimeTypeSupportedByCore(mimeType)) {
					orderMimeTypes.push({
						mimeType: mimeType,
						isResolved: false,
						rendererId: -1
					});
				}
			} else {
				orderMimeTypes.push({
					mimeType: mimeType,
					isResolved: false
				});
			}
		});

		return {
R
rebornix 已提交
392
			outputKind: output.outputKind,
393 394 395 396 397 398
			data: output.data,
			orderedMimeTypes: orderMimeTypes,
			pickedMimeTypeIndex: 0
		};
	}

R
rebornix 已提交
399
	getCell(cellHandle: number) {
R
rebornix 已提交
400 401
		return this.cells.find(cell => cell.handle === cellHandle);
	}
R
rebornix 已提交
402

403 404
	attachCellTextDocument(textDocument: ExtHostDocumentData) {
		let cell = this.cells.find(cell => cell.uri.toString() === textDocument.document.uri.toString());
R
rebornix 已提交
405 406 407 408 409
		if (cell) {
			cell.attachTextDocument(textDocument);
		}
	}

410 411
	detachCellTextDocument(textDocument: ExtHostDocumentData) {
		let cell = this.cells.find(cell => cell.uri.toString() === textDocument.document.uri.toString());
R
rebornix 已提交
412
		if (cell) {
R
rebornix 已提交
413
			cell.detachTextDocument();
R
rebornix 已提交
414 415
		}
	}
R
rebornix 已提交
416 417
}

R
rebornix 已提交
418
export class NotebookEditorCellEditBuilder implements vscode.NotebookEditorCellEdit {
R
rebornix 已提交
419 420 421
	private _finalized: boolean = false;
	private readonly _documentVersionId: number;
	private _collectedEdits: ICellEditOperation[] = [];
R
rebornix 已提交
422
	private _renderers = new Set<number>();
R
rebornix 已提交
423 424 425 426

	constructor(
		readonly editor: ExtHostNotebookEditor
	) {
R
rebornix 已提交
427
		this._documentVersionId = editor.document.versionId;
R
rebornix 已提交
428 429 430 431 432 433
	}

	finalize(): INotebookEditData {
		this._finalized = true;
		return {
			documentVersionId: this._documentVersionId,
R
rebornix 已提交
434 435
			edits: this._collectedEdits,
			renderers: Array.from(this._renderers)
R
rebornix 已提交
436 437 438 439 440 441 442 443 444
		};
	}

	private _throwIfFinalized() {
		if (this._finalized) {
			throw new Error('Edit is only valid while callback runs');
		}
	}

R
rebornix 已提交
445
	insert(index: number, content: string | string[], language: string, type: CellKind, outputs: vscode.CellOutput[], metadata: vscode.NotebookCellMetadata | undefined): void {
R
rebornix 已提交
446 447
		this._throwIfFinalized();

R
rebornix 已提交
448
		const sourceArr = Array.isArray(content) ? content : content.split(/\r|\n|\r\n/g);
R
rebornix 已提交
449
		let cell = {
R
rebornix 已提交
450
			source: sourceArr,
R
rebornix 已提交
451
			language,
R
rebornix 已提交
452
			cellKind: type,
R
rebornix 已提交
453 454
			outputs: (outputs as any[]), // TODO@rebornix
			metadata
R
rebornix 已提交
455 456 457 458
		};

		const transformedOutputs = outputs.map(output => {
			if (output.outputKind === CellOutputKind.Rich) {
R
rebornix 已提交
459
				const ret = this.editor.document.transformMimeTypes(output);
R
rebornix 已提交
460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475

				if (ret.orderedMimeTypes[ret.pickedMimeTypeIndex].isResolved) {
					this._renderers.add(ret.orderedMimeTypes[ret.pickedMimeTypeIndex].rendererId!);
				}
				return ret;
			} else {
				return output as IStreamOutput | IErrorOutput;
			}
		});

		cell.outputs = transformedOutputs;

		this._collectedEdits.push({
			editType: CellEditType.Insert,
			index,
			cells: [cell]
R
rebornix 已提交
476 477 478 479 480 481 482 483
		});
	}

	delete(index: number): void {
		this._throwIfFinalized();

		this._collectedEdits.push({
			editType: CellEditType.Delete,
484 485
			index,
			count: 1
R
rebornix 已提交
486 487 488 489
		});
	}
}

R
rebornix 已提交
490
export class ExtHostNotebookEditor extends Disposable implements vscode.NotebookEditor {
R
rebornix 已提交
491
	private _viewColumn: vscode.ViewColumn | undefined;
R
rebornix 已提交
492 493

	selection?: ExtHostCell = undefined;
494
	onDidReceiveMessage: vscode.Event<any> = this._onDidReceiveMessage.event;
R
rebornix 已提交
495 496

	constructor(
497
		private readonly viewType: string,
R
rebornix 已提交
498 499
		readonly id: string,
		public uri: URI,
500 501
		private _proxy: MainThreadNotebookShape,
		private _onDidReceiveMessage: Emitter<any>,
R
rebornix 已提交
502 503
		private _webviewId: string,
		private _webviewInitData: WebviewInitData,
R
rebornix 已提交
504
		public document: ExtHostNotebookDocument,
R
rebornix 已提交
505
		private _documentsAndEditors: ExtHostDocumentsAndEditors
R
rebornix 已提交
506
	) {
R
rebornix 已提交
507 508
		super();
		this._register(this._documentsAndEditors.onDidAddDocuments(documents => {
509 510
			for (const documentData of documents) {
				let data = CellUri.parse(documentData.document.uri);
J
Johannes Rieken 已提交
511 512
				if (data) {
					if (this.document.uri.toString() === data.notebook.toString()) {
513
						document.attachCellTextDocument(documentData);
R
rebornix 已提交
514 515 516
					}
				}
			}
R
rebornix 已提交
517
		}));
R
rebornix 已提交
518

R
rebornix 已提交
519
		this._register(this._documentsAndEditors.onDidRemoveDocuments(documents => {
520 521
			for (const documentData of documents) {
				let data = CellUri.parse(documentData.document.uri);
J
Johannes Rieken 已提交
522 523
				if (data) {
					if (this.document.uri.toString() === data.notebook.toString()) {
524
						document.detachCellTextDocument(documentData);
R
rebornix 已提交
525 526 527
					}
				}
			}
R
rebornix 已提交
528 529 530
		}));
	}

R
rebornix 已提交
531 532
	edit(callback: (editBuilder: NotebookEditorCellEditBuilder) => void): Thenable<boolean> {
		const edit = new NotebookEditorCellEditBuilder(this);
R
rebornix 已提交
533 534 535 536
		callback(edit);
		return this._applyEdit(edit);
	}

R
rebornix 已提交
537
	private _applyEdit(editBuilder: NotebookEditorCellEditBuilder): Promise<boolean> {
R
rebornix 已提交
538 539 540 541 542 543 544
		const editData = editBuilder.finalize();

		// return when there is nothing to do
		if (editData.edits.length === 0) {
			return Promise.resolve(true);
		}

R
rebornix 已提交
545 546 547 548 549 550 551 552 553 554 555 556 557 558
		let compressedEdits: ICellEditOperation[] = [];
		let compressedEditsIndex = -1;

		for (let i = 0; i < editData.edits.length; i++) {
			if (compressedEditsIndex < 0) {
				compressedEdits.push(editData.edits[i]);
				compressedEditsIndex++;
				continue;
			}

			let prevIndex = compressedEditsIndex;
			let prev = compressedEdits[prevIndex];

			if (prev.editType === CellEditType.Insert && editData.edits[i].editType === CellEditType.Insert) {
559
				if (prev.index === editData.edits[i].index) {
R
rebornix 已提交
560 561 562 563 564
					prev.cells.push(...(editData.edits[i] as ICellInsertEdit).cells);
					continue;
				}
			}

565 566 567 568 569 570 571
			if (prev.editType === CellEditType.Delete && editData.edits[i].editType === CellEditType.Delete) {
				if (prev.index === editData.edits[i].index) {
					prev.count += (editData.edits[i] as ICellDeleteEdit).count;
					continue;
				}
			}

R
rebornix 已提交
572 573 574
			compressedEdits.push(editData.edits[i]);
			compressedEditsIndex++;
		}
R
rebornix 已提交
575

R
rebornix 已提交
576
		return this._proxy.$tryApplyEdits(this.viewType, this.uri, editData.documentVersionId, compressedEdits, editData.renderers);
R
rebornix 已提交
577 578 579 580 581 582 583 584
	}

	get viewColumn(): vscode.ViewColumn | undefined {
		return this._viewColumn;
	}

	set viewColumn(value) {
		throw readonly('viewColumn');
R
rebornix 已提交
585
	}
586 587 588 589 590

	async postMessage(message: any): Promise<boolean> {
		return this._proxy.$postMessage(this.document.handle, message);
	}

R
rebornix 已提交
591 592 593
	asWebviewUri(localResource: vscode.Uri): vscode.Uri {
		return asWebviewUri(this._webviewInitData, this._webviewId, localResource);
	}
R
rebornix 已提交
594 595
}

R
rebornix 已提交
596
export class ExtHostNotebookOutputRenderer {
R
rebornix 已提交
597 598 599
	private static _handlePool: number = 0;
	readonly handle = ExtHostNotebookOutputRenderer._handlePool++;

R
rebornix 已提交
600
	constructor(
R
rebornix 已提交
601 602 603
		public type: string,
		public filter: vscode.NotebookOutputSelector,
		public renderer: vscode.NotebookOutputRenderer
R
rebornix 已提交
604 605 606 607
	) {

	}

R
rebornix 已提交
608 609 610
	matches(mimeType: string): boolean {
		if (this.filter.subTypes) {
			if (this.filter.subTypes.indexOf(mimeType) >= 0) {
R
rebornix 已提交
611 612 613 614 615 616
				return true;
			}
		}
		return false;
	}

R
rebornix 已提交
617
	render(document: ExtHostNotebookDocument, output: vscode.CellDisplayOutput, mimeType: string): string {
R
rebornix 已提交
618
		let html = this.renderer.render(document, output, mimeType);
R
rebornix 已提交
619

620
		return html;
R
rebornix 已提交
621 622 623 624
	}
}

export interface ExtHostNotebookOutputRenderingHandler {
R
rebornix 已提交
625
	outputDisplayOrder: INotebookDisplayOrder | undefined;
R
rebornix 已提交
626
	findBestMatchedRenderer(mimeType: string): ExtHostNotebookOutputRenderer[];
R
rebornix 已提交
627 628 629
}

export class ExtHostNotebookController implements ExtHostNotebookShape, ExtHostNotebookOutputRenderingHandler {
R
rebornix 已提交
630 631
	private static _handlePool: number = 0;

R
rebornix 已提交
632
	private readonly _proxy: MainThreadNotebookShape;
R
rebornix 已提交
633
	private readonly _notebookContentProviders = new Map<string, { readonly provider: vscode.NotebookContentProvider, readonly extension: IExtensionDescription; }>();
R
rebornix 已提交
634
	private readonly _notebookKernels = new Map<string, { readonly kernel: vscode.NotebookKernel, readonly extension: IExtensionDescription; }>();
R
rebornix 已提交
635
	private readonly _documents = new Map<string, ExtHostNotebookDocument>();
R
rebornix 已提交
636
	private readonly _editors = new Map<string, { editor: ExtHostNotebookEditor, onDidReceiveMessage: Emitter<any>; }>();
R
rebornix 已提交
637
	private readonly _notebookOutputRenderers = new Map<number, ExtHostNotebookOutputRenderer>();
638

R
rebornix 已提交
639 640
	private readonly _onDidChangeNotebookDocument = new Emitter<{ document: ExtHostNotebookDocument, changes: NotebookCellsChangedEvent[]; }>();
	readonly onDidChangeNotebookDocument: Event<{ document: ExtHostNotebookDocument, changes: NotebookCellsChangedEvent[]; }> = this._onDidChangeNotebookDocument.event;
641

R
rebornix 已提交
642
	private _outputDisplayOrder: INotebookDisplayOrder | undefined;
R
rebornix 已提交
643

R
rebornix 已提交
644
	get outputDisplayOrder(): INotebookDisplayOrder | undefined {
R
rebornix 已提交
645
		return this._outputDisplayOrder;
R
rebornix 已提交
646 647
	}

R
rebornix 已提交
648 649 650 651 652 653
	private _activeNotebookDocument: ExtHostNotebookDocument | undefined;

	get activeNotebookDocument() {
		return this._activeNotebookDocument;
	}

R
rebornix 已提交
654 655 656 657 658 659
	private _activeNotebookEditor: ExtHostNotebookEditor | undefined;

	get activeNotebookEditor() {
		return this._activeNotebookEditor;
	}

R
rebornix 已提交
660 661
	private _onDidOpenNotebookDocument = new Emitter<vscode.NotebookDocument>();
	onDidOpenNotebookDocument: Event<vscode.NotebookDocument> = this._onDidOpenNotebookDocument.event;
R
rebornix 已提交
662 663
	private _onDidCloseNotebookDocument = new Emitter<vscode.NotebookDocument>();
	onDidCloseNotebookDocument: Event<vscode.NotebookDocument> = this._onDidCloseNotebookDocument.event;
R
rebornix 已提交
664

R
rebornix 已提交
665
	constructor(mainContext: IMainContext, commands: ExtHostCommands, private _documentsAndEditors: ExtHostDocumentsAndEditors, private readonly _webviewInitData: WebviewInitData) {
R
rebornix 已提交
666
		this._proxy = mainContext.getProxy(MainContext.MainThreadNotebook);
667 668 669 670 671 672 673 674

		commands.registerArgumentProcessor({
			processArgument: arg => {
				if (arg && arg.$mid === 12) {
					const documentHandle = arg.notebookEditor?.notebookHandle;
					const cellHandle = arg.cell.handle;

					for (let value of this._editors) {
675 676
						if (value[1].editor.document.handle === documentHandle) {
							const cell = value[1].editor.document.getCell(cellHandle);
677 678 679 680 681 682
							if (cell) {
								return cell;
							}
						}
					}
				}
B
Benjamin Pasero 已提交
683
				return arg;
684 685
			}
		});
R
rebornix 已提交
686 687
	}

R
rebornix 已提交
688
	registerNotebookOutputRenderer(
R
rebornix 已提交
689
		type: string,
R
rebornix 已提交
690
		extension: IExtensionDescription,
R
rebornix 已提交
691
		filter: vscode.NotebookOutputSelector,
R
rebornix 已提交
692
		renderer: vscode.NotebookOutputRenderer
R
rebornix 已提交
693
	): vscode.Disposable {
R
rebornix 已提交
694
		let extHostRenderer = new ExtHostNotebookOutputRenderer(type, filter, renderer);
R
rebornix 已提交
695
		this._notebookOutputRenderers.set(extHostRenderer.handle, extHostRenderer);
R
rebornix 已提交
696
		this._proxy.$registerNotebookRenderer({ id: extension.identifier, location: extension.extensionLocation }, type, filter, extHostRenderer.handle, renderer.preloads || []);
R
rebornix 已提交
697
		return new VSCodeDisposable(() => {
R
rebornix 已提交
698 699 700
			this._notebookOutputRenderers.delete(extHostRenderer.handle);
			this._proxy.$unregisterNotebookRenderer(extHostRenderer.handle);
		});
R
rebornix 已提交
701 702
	}

R
rebornix 已提交
703 704
	findBestMatchedRenderer(mimeType: string): ExtHostNotebookOutputRenderer[] {
		let matches: ExtHostNotebookOutputRenderer[] = [];
R
rebornix 已提交
705
		for (let renderer of this._notebookOutputRenderers) {
R
rebornix 已提交
706
			if (renderer[1].matches(mimeType)) {
R
rebornix 已提交
707
				matches.push(renderer[1]);
R
rebornix 已提交
708 709 710
			}
		}

R
rebornix 已提交
711
		return matches;
R
rebornix 已提交
712 713
	}

R
rebornix 已提交
714 715 716 717 718 719
	registerNotebookContentProvider(
		extension: IExtensionDescription,
		viewType: string,
		provider: vscode.NotebookContentProvider,
	): vscode.Disposable {

R
rebornix 已提交
720
		if (this._notebookContentProviders.has(viewType)) {
R
rebornix 已提交
721 722 723 724
			throw new Error(`Notebook provider for '${viewType}' already registered`);
		}

		this._notebookContentProviders.set(viewType, { extension, provider });
R
rebornix 已提交
725
		this._proxy.$registerNotebookProvider({ id: extension.identifier, location: extension.extensionLocation }, viewType, provider.kernel ? { id: viewType, label: provider.kernel.label, extensionLocation: extension.extensionLocation, preloads: provider.kernel.preloads } : undefined);
R
rebornix 已提交
726 727 728 729 730 731
		return new VSCodeDisposable(() => {
			this._notebookContentProviders.delete(viewType);
			this._proxy.$unregisterNotebookProvider(viewType);
		});
	}

R
rebornix 已提交
732 733 734 735 736 737 738 739
	registerNotebookKernel(extension: IExtensionDescription, id: string, selectors: vscode.GlobPattern[], kernel: vscode.NotebookKernel): vscode.Disposable {
		if (this._notebookKernels.has(id)) {
			throw new Error(`Notebook kernel for '${id}' already registered`);
		}

		this._notebookKernels.set(id, { kernel, extension });
		const transformedSelectors = selectors.map(selector => typeConverters.GlobPattern.from(selector));

R
rebornix 已提交
740
		this._proxy.$registerNotebookKernel({ id: extension.identifier, location: extension.extensionLocation }, id, kernel.label, transformedSelectors, kernel.preloads || []);
R
rebornix 已提交
741 742 743 744 745 746
		return new VSCodeDisposable(() => {
			this._notebookKernels.delete(id);
			this._proxy.$unregisterNotebookKernel(id);
		});
	}

R
rebornix 已提交
747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841
	async $resolveNotebookData(viewType: string, uri: UriComponents): Promise<NotebookDataDto | undefined> {
		let provider = this._notebookContentProviders.get(viewType);
		let document = this._documents.get(URI.revive(uri).toString());

		if (provider && document) {
			const rawCells = await provider.provider.openNotebook(URI.revive(uri));
			const renderers = new Set<number>();
			const dto = {
				metadata: {
					...notebookDocumentMetadataDefaults,
					...rawCells.metadata
				},
				languages: rawCells.languages,
				cells: rawCells.cells.map(cell => {
					let transformedOutputs = cell.outputs.map(output => {
						if (output.outputKind === CellOutputKind.Rich) {
							// TODO display string[]
							const ret = this._transformMimeTypes(document!, (rawCells.metadata.displayOrder as string[]) || [], output);

							if (ret.orderedMimeTypes[ret.pickedMimeTypeIndex].isResolved) {
								renderers.add(ret.orderedMimeTypes[ret.pickedMimeTypeIndex].rendererId!);
							}
							return ret;
						} else {
							return output as IStreamOutput | IErrorOutput;
						}
					});

					return {
						language: cell.language,
						cellKind: cell.cellKind,
						metadata: cell.metadata,
						source: cell.source,
						outputs: transformedOutputs
					};
				})
			};

			return dto;
		}

		return;
	}

	private _transformMimeTypes(document: ExtHostNotebookDocument, displayOrder: string[], output: vscode.CellDisplayOutput): ITransformedDisplayOutputDto {
		let mimeTypes = Object.keys(output.data);
		let coreDisplayOrder = this.outputDisplayOrder;
		const sorted = sortMimeTypes(mimeTypes, coreDisplayOrder?.userOrder || [], displayOrder, coreDisplayOrder?.defaultOrder || []);

		let orderMimeTypes: IOrderedMimeType[] = [];

		sorted.forEach(mimeType => {
			let handlers = this.findBestMatchedRenderer(mimeType);

			if (handlers.length) {
				let renderedOutput = handlers[0].render(document, output, mimeType);

				orderMimeTypes.push({
					mimeType: mimeType,
					isResolved: true,
					rendererId: handlers[0].handle,
					output: renderedOutput
				});

				for (let i = 1; i < handlers.length; i++) {
					orderMimeTypes.push({
						mimeType: mimeType,
						isResolved: false,
						rendererId: handlers[i].handle
					});
				}

				if (mimeTypeSupportedByCore(mimeType)) {
					orderMimeTypes.push({
						mimeType: mimeType,
						isResolved: false,
						rendererId: -1
					});
				}
			} else {
				orderMimeTypes.push({
					mimeType: mimeType,
					isResolved: false
				});
			}
		});

		return {
			outputKind: output.outputKind,
			data: output.data,
			orderedMimeTypes: orderMimeTypes,
			pickedMimeTypeIndex: 0
		};
	}

R
rebornix 已提交
842
	async $executeNotebook(viewType: string, uri: UriComponents, cellHandle: number | undefined, useAttachedKernel: boolean, token: CancellationToken): Promise<void> {
R
rebornix 已提交
843
		let document = this._documents.get(URI.revive(uri).toString());
R
rebornix 已提交
844

R
rebornix 已提交
845
		if (!document) {
R
rebornix 已提交
846
			return;
R
rebornix 已提交
847
		}
R
rebornix 已提交
848

R
rebornix 已提交
849
		if (this._notebookContentProviders.has(viewType)) {
R
rebornix 已提交
850 851
			const cell = cellHandle !== undefined ? document.getCell(cellHandle) : undefined;
			const provider = this._notebookContentProviders.get(viewType)!.provider;
R
rebornix 已提交
852

R
rebornix 已提交
853 854 855 856 857 858 859 860 861
			if (provider.kernel && useAttachedKernel) {
				if (cell) {
					return provider.kernel.executeCell(document, cell, token);
				} else {
					return provider.kernel.executeAllCells(document, token);
				}
			} else {
				return provider.executeCell(document, cell, token);
			}
R
rebornix 已提交
862
		}
R
rebornix 已提交
863 864
	}

R
rebornix 已提交
865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886
	async $executeNotebook2(kernelId: string, viewType: string, uri: UriComponents, cellHandle: number | undefined, token: CancellationToken): Promise<void> {
		let document = this._documents.get(URI.revive(uri).toString());

		if (!document || document.viewType !== viewType) {
			return;
		}

		let kernelInfo = this._notebookKernels.get(kernelId);

		if (!kernelInfo) {
			return;
		}

		let cell = cellHandle !== undefined ? document.getCell(cellHandle) : undefined;

		if (cell) {
			return kernelInfo.kernel.executeCell(document, cell, token);
		} else {
			return kernelInfo.kernel.executeAllCells(document, token);
		}
	}

R
rebornix 已提交
887
	async $saveNotebook(viewType: string, uri: UriComponents, token: CancellationToken): Promise<boolean> {
R
rebornix 已提交
888
		let document = this._documents.get(URI.revive(uri).toString());
R
rebornix 已提交
889 890 891 892 893 894
		if (!document) {
			return false;
		}

		if (this._notebookContentProviders.has(viewType)) {
			try {
R
rebornix 已提交
895
				await this._notebookContentProviders.get(viewType)!.provider.saveNotebook(document, token);
R
rebornix 已提交
896 897 898 899 900 901 902
			} catch (e) {
				return false;
			}

			return true;
		}

R
saveAs  
rebornix 已提交
903 904 905 906 907 908 909 910 911 912 913 914 915 916 917
		return false;
	}

	async $saveNotebookAs(viewType: string, uri: UriComponents, target: UriComponents, token: CancellationToken): Promise<boolean> {
		let document = this._documents.get(URI.revive(uri).toString());
		if (!document) {
			return false;
		}

		if (this._notebookContentProviders.has(viewType)) {
			try {
				await this._notebookContentProviders.get(viewType)!.provider.saveNotebookAs(URI.revive(target), document, token);
			} catch (e) {
				return false;
			}
R
rebornix 已提交
918

R
rebornix 已提交
919
			return true;
R
rebornix 已提交
920 921 922 923 924
		}

		return false;
	}

R
rebornix 已提交
925
	$acceptDisplayOrder(displayOrder: INotebookDisplayOrder): void {
R
rebornix 已提交
926
		this._outputDisplayOrder = displayOrder;
R
rebornix 已提交
927
	}
928 929 930 931 932 933 934 935

	$onDidReceiveMessage(uri: UriComponents, message: any): void {
		let editor = this._editors.get(URI.revive(uri).toString());

		if (editor) {
			editor.onDidReceiveMessage.fire(message);
		}
	}
R
rebornix 已提交
936 937 938 939 940 941

	$acceptModelChanged(uriComponents: UriComponents, event: NotebookCellsChangedEvent): void {
		let editor = this._editors.get(URI.revive(uriComponents).toString());

		if (editor) {
			editor.editor.document.accpetModelChanged(event);
942 943
			this._onDidChangeNotebookDocument.fire({
				document: editor.editor.document,
R
rebornix 已提交
944
				changes: [event]
945
			});
R
rebornix 已提交
946 947 948
		}

	}
R
rebornix 已提交
949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966

	$acceptEditorPropertiesChanged(uriComponents: UriComponents, data: INotebookEditorPropertiesChangeData): void {
		let editor = this._editors.get(URI.revive(uriComponents).toString());

		if (!editor) {
			return;
		}

		if (data.selections) {
			const cells = editor.editor.document.cells;

			if (data.selections.selections.length) {
				const firstCell = data.selections.selections[0];
				editor.editor.selection = cells.find(cell => cell.handle === firstCell);
			} else {
				editor.editor.selection = undefined;
			}
		}
R
rebornix 已提交
967 968 969 970 971 972 973

		if (data.metadata) {
			editor.editor.document.metadata = {
				...notebookDocumentMetadataDefaults,
				...data.metadata
			};
		}
R
rebornix 已提交
974
	}
R
rebornix 已提交
975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002

	async $acceptDocumentAndEditorsDelta(delta: INotebookDocumentsAndEditorsDelta) {
		if (delta.removedDocuments) {
			delta.removedDocuments.forEach((uri) => {
				let document = this._documents.get(URI.revive(uri).toString());

				if (document) {
					document.dispose();
					this._documents.delete(URI.revive(uri).toString());
					this._onDidCloseNotebookDocument.fire(document);
				}

				let editor = this._editors.get(URI.revive(uri).toString());

				if (editor) {
					editor.editor.dispose();
					editor.onDidReceiveMessage.dispose();
					this._editors.delete(URI.revive(uri).toString());
				}
			});
		}

		if (delta.addedDocuments) {
			delta.addedDocuments.forEach(modelData => {
				const revivedUri = URI.revive(modelData.uri);
				const viewType = modelData.viewType;
				if (!this._documents.has(revivedUri.toString())) {
					let document = new ExtHostNotebookDocument(this._proxy, this._documentsAndEditors, viewType, revivedUri, this);
R
rebornix 已提交
1003 1004 1005 1006 1007 1008 1009
					if (modelData.metadata) {
						document.metadata = {
							...notebookDocumentMetadataDefaults,
							...modelData.metadata
						};
					}

R
rebornix 已提交
1010 1011 1012 1013
					this._documents.set(revivedUri.toString(), document);
				}

				const onDidReceiveMessage = new Emitter<any>();
R
rebornix 已提交
1014
				const document = this._documents.get(revivedUri.toString())!;
R
rebornix 已提交
1015 1016 1017 1018 1019 1020 1021

				let editor = new ExtHostNotebookEditor(
					viewType,
					`${ExtHostNotebookController._handlePool++}`,
					revivedUri,
					this._proxy,
					onDidReceiveMessage,
R
rebornix 已提交
1022 1023
					modelData.webviewId,
					this._webviewInitData,
R
rebornix 已提交
1024
					document,
R
rebornix 已提交
1025 1026 1027
					this._documentsAndEditors
				);

R
rebornix 已提交
1028 1029
				this._onDidOpenNotebookDocument.fire(document);

R
rebornix 已提交
1030 1031 1032 1033 1034 1035 1036 1037 1038 1039
				// TODO, does it already exist?
				this._editors.set(revivedUri.toString(), { editor, onDidReceiveMessage });
			});
		}

		if (delta.newActiveEditor) {
			this._activeNotebookDocument = this._documents.get(URI.revive(delta.newActiveEditor).toString());
			this._activeNotebookEditor = this._editors.get(URI.revive(delta.newActiveEditor).toString())?.editor;
		}
	}
R
rebornix 已提交
1040
}