extHostNotebook.ts 31.0 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';
22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42

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 已提交
43

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

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

	private _metadataChangeListener: IDisposable;
R
rebornix 已提交
56

57 58 59 60 61 62
	private _documentData: ExtHostDocumentData;

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

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

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

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

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

	get outputs() {
		return this._outputs;
	}

R
rebornix 已提交
101
	set outputs(newOutputs: vscode.CellOutput[]) {
102
		let diffs = diff<vscode.CellOutput>(this._outputs || [], newOutputs || [], (a) => {
103 104 105 106 107 108 109 110 111 112 113 114 115
			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 已提交
116
		this._outputs = newOutputs;
117
		this._onDidChangeOutputs.fire(diffs);
R
rebornix 已提交
118 119
	}

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

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

		this.updateMetadata();
	}
135

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

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

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

148 149 150 151 152
		// 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 已提交
153 154 155
	}
}

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

	private _cells: ExtHostCell[] = [];

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

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

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

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

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

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

	get metadata() {
		return this._metadata;
	}

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

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

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

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

	get displayOrder() {
		return this._displayOrder;
	}

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

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

	get versionId() {
		return this._versionId;
	}

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

		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 已提交
239
	}
R
rebornix 已提交
240

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

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

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

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

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

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

R
rebornix 已提交
271 272 273 274
		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);
275
				const documentData = this._documentsAndEditors.getDocument(URI.revive(cell.uri));
276

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

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

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

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

				return extCell;
292 293
			});

R
rebornix 已提交
294 295 296 297 298
			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);

			}
299

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

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

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

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

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

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

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

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

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

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

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

		let orderMimeTypes: IOrderedMimeType[] = [];

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

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

				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 已提交
391
			outputKind: output.outputKind,
392 393 394 395 396 397
			data: output.data,
			orderedMimeTypes: orderMimeTypes,
			pickedMimeTypeIndex: 0
		};
	}

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

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

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

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

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

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

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

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

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

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

				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 已提交
475 476 477 478 479 480 481 482
		});
	}

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

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

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

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

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

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

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

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

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

R
rebornix 已提交
542 543 544 545 546 547 548 549 550 551 552 553 554 555
		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) {
556
				if (prev.index === editData.edits[i].index) {
R
rebornix 已提交
557 558 559 560 561
					prev.cells.push(...(editData.edits[i] as ICellInsertEdit).cells);
					continue;
				}
			}

562 563 564 565 566 567 568
			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 已提交
569 570 571
			compressedEdits.push(editData.edits[i]);
			compressedEditsIndex++;
		}
R
rebornix 已提交
572

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

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

	set viewColumn(value) {
		throw readonly('viewColumn');
R
rebornix 已提交
582
	}
583 584 585 586 587

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

R
rebornix 已提交
588 589
}

R
rebornix 已提交
590
export class ExtHostNotebookOutputRenderer {
R
rebornix 已提交
591 592 593
	private static _handlePool: number = 0;
	readonly handle = ExtHostNotebookOutputRenderer._handlePool++;

R
rebornix 已提交
594
	constructor(
R
rebornix 已提交
595 596 597
		public type: string,
		public filter: vscode.NotebookOutputSelector,
		public renderer: vscode.NotebookOutputRenderer
R
rebornix 已提交
598 599 600 601
	) {

	}

R
rebornix 已提交
602 603 604
	matches(mimeType: string): boolean {
		if (this.filter.subTypes) {
			if (this.filter.subTypes.indexOf(mimeType) >= 0) {
R
rebornix 已提交
605 606 607 608 609 610
				return true;
			}
		}
		return false;
	}

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

614
		return html;
R
rebornix 已提交
615 616 617 618
	}
}

export interface ExtHostNotebookOutputRenderingHandler {
R
rebornix 已提交
619
	outputDisplayOrder: INotebookDisplayOrder | undefined;
R
rebornix 已提交
620
	findBestMatchedRenderer(mimeType: string): ExtHostNotebookOutputRenderer[];
R
rebornix 已提交
621 622 623
}

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

R
rebornix 已提交
626
	private readonly _proxy: MainThreadNotebookShape;
R
rebornix 已提交
627
	private readonly _notebookContentProviders = new Map<string, { readonly provider: vscode.NotebookContentProvider, readonly extension: IExtensionDescription; }>();
R
rebornix 已提交
628
	private readonly _notebookKernels = new Map<string, { readonly kernel: vscode.NotebookKernel, readonly extension: IExtensionDescription; }>();
R
rebornix 已提交
629
	private readonly _documents = new Map<string, ExtHostNotebookDocument>();
R
rebornix 已提交
630
	private readonly _editors = new Map<string, { editor: ExtHostNotebookEditor, onDidReceiveMessage: Emitter<any>; }>();
R
rebornix 已提交
631
	private readonly _notebookOutputRenderers = new Map<number, ExtHostNotebookOutputRenderer>();
632

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

R
rebornix 已提交
636
	private _outputDisplayOrder: INotebookDisplayOrder | undefined;
R
rebornix 已提交
637

R
rebornix 已提交
638
	get outputDisplayOrder(): INotebookDisplayOrder | undefined {
R
rebornix 已提交
639
		return this._outputDisplayOrder;
R
rebornix 已提交
640 641
	}

R
rebornix 已提交
642 643 644 645 646 647
	private _activeNotebookDocument: ExtHostNotebookDocument | undefined;

	get activeNotebookDocument() {
		return this._activeNotebookDocument;
	}

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

	get activeNotebookEditor() {
		return this._activeNotebookEditor;
	}

R
rebornix 已提交
654 655
	private _onDidOpenNotebookDocument = new Emitter<vscode.NotebookDocument>();
	onDidOpenNotebookDocument: Event<vscode.NotebookDocument> = this._onDidOpenNotebookDocument.event;
R
rebornix 已提交
656 657
	private _onDidCloseNotebookDocument = new Emitter<vscode.NotebookDocument>();
	onDidCloseNotebookDocument: Event<vscode.NotebookDocument> = this._onDidCloseNotebookDocument.event;
R
rebornix 已提交
658

659
	constructor(mainContext: IMainContext, commands: ExtHostCommands, private _documentsAndEditors: ExtHostDocumentsAndEditors) {
R
rebornix 已提交
660
		this._proxy = mainContext.getProxy(MainContext.MainThreadNotebook);
661 662 663 664 665 666 667 668

		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) {
669 670
						if (value[1].editor.document.handle === documentHandle) {
							const cell = value[1].editor.document.getCell(cellHandle);
671 672 673 674 675 676
							if (cell) {
								return cell;
							}
						}
					}
				}
B
Benjamin Pasero 已提交
677
				return arg;
678 679
			}
		});
R
rebornix 已提交
680 681
	}

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

R
rebornix 已提交
697 698
	findBestMatchedRenderer(mimeType: string): ExtHostNotebookOutputRenderer[] {
		let matches: ExtHostNotebookOutputRenderer[] = [];
R
rebornix 已提交
699
		for (let renderer of this._notebookOutputRenderers) {
R
rebornix 已提交
700
			if (renderer[1].matches(mimeType)) {
R
rebornix 已提交
701
				matches.push(renderer[1]);
R
rebornix 已提交
702 703 704
			}
		}

R
rebornix 已提交
705
		return matches;
R
rebornix 已提交
706 707
	}

R
rebornix 已提交
708 709 710 711 712 713
	registerNotebookContentProvider(
		extension: IExtensionDescription,
		viewType: string,
		provider: vscode.NotebookContentProvider,
	): vscode.Disposable {

R
rebornix 已提交
714
		if (this._notebookContentProviders.has(viewType)) {
R
rebornix 已提交
715 716 717 718
			throw new Error(`Notebook provider for '${viewType}' already registered`);
		}

		this._notebookContentProviders.set(viewType, { extension, provider });
R
rebornix 已提交
719
		this._proxy.$registerNotebookProvider({ id: extension.identifier, location: extension.extensionLocation }, viewType);
R
rebornix 已提交
720 721 722 723 724 725
		return new VSCodeDisposable(() => {
			this._notebookContentProviders.delete(viewType);
			this._proxy.$unregisterNotebookProvider(viewType);
		});
	}

R
rebornix 已提交
726 727 728 729 730 731 732 733
	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 已提交
734
		this._proxy.$registerNotebookKernel({ id: extension.identifier, location: extension.extensionLocation }, id, kernel.label, transformedSelectors, kernel.preloads || []);
R
rebornix 已提交
735 736 737 738 739 740
		return new VSCodeDisposable(() => {
			this._notebookKernels.delete(id);
			this._proxy.$unregisterNotebookKernel(id);
		});
	}

R
rebornix 已提交
741 742 743 744 745 746 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
	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
		};
	}

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

R
rebornix 已提交
839
		if (!document) {
R
rebornix 已提交
840
			return;
R
rebornix 已提交
841
		}
R
rebornix 已提交
842

R
rebornix 已提交
843 844
		if (this._notebookContentProviders.has(viewType)) {
			let cell = cellHandle !== undefined ? document.getCell(cellHandle) : undefined;
R
rebornix 已提交
845

R
rebornix 已提交
846 847
			return this._notebookContentProviders.get(viewType)!.provider.executeCell(document, cell, token);
		}
R
rebornix 已提交
848 849
	}

R
rebornix 已提交
850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871
	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 已提交
872
	async $saveNotebook(viewType: string, uri: UriComponents, token: CancellationToken): Promise<boolean> {
R
rebornix 已提交
873
		let document = this._documents.get(URI.revive(uri).toString());
R
rebornix 已提交
874 875 876 877 878 879
		if (!document) {
			return false;
		}

		if (this._notebookContentProviders.has(viewType)) {
			try {
R
rebornix 已提交
880
				await this._notebookContentProviders.get(viewType)!.provider.saveNotebook(document, token);
R
rebornix 已提交
881 882 883 884 885 886 887
			} catch (e) {
				return false;
			}

			return true;
		}

R
saveAs  
rebornix 已提交
888 889 890 891 892 893 894 895 896 897 898 899 900 901 902
		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 已提交
903

R
rebornix 已提交
904
			return true;
R
rebornix 已提交
905 906 907 908 909
		}

		return false;
	}

R
rebornix 已提交
910
	$acceptDisplayOrder(displayOrder: INotebookDisplayOrder): void {
R
rebornix 已提交
911
		this._outputDisplayOrder = displayOrder;
R
rebornix 已提交
912
	}
913 914 915 916 917 918 919 920

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

		if (editor) {
			editor.onDidReceiveMessage.fire(message);
		}
	}
R
rebornix 已提交
921 922 923 924 925 926

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

		if (editor) {
			editor.editor.document.accpetModelChanged(event);
927 928
			this._onDidChangeNotebookDocument.fire({
				document: editor.editor.document,
R
rebornix 已提交
929
				changes: [event]
930
			});
R
rebornix 已提交
931 932 933
		}

	}
R
rebornix 已提交
934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951

	$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 已提交
952 953 954 955 956 957 958

		if (data.metadata) {
			editor.editor.document.metadata = {
				...notebookDocumentMetadataDefaults,
				...data.metadata
			};
		}
R
rebornix 已提交
959
	}
R
rebornix 已提交
960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987

	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 已提交
988 989 990 991 992 993 994
					if (modelData.metadata) {
						document.metadata = {
							...notebookDocumentMetadataDefaults,
							...modelData.metadata
						};
					}

R
rebornix 已提交
995 996 997 998
					this._documents.set(revivedUri.toString(), document);
				}

				const onDidReceiveMessage = new Emitter<any>();
R
rebornix 已提交
999
				const document = this._documents.get(revivedUri.toString())!;
R
rebornix 已提交
1000 1001 1002 1003 1004 1005 1006

				let editor = new ExtHostNotebookEditor(
					viewType,
					`${ExtHostNotebookController._handlePool++}`,
					revivedUri,
					this._proxy,
					onDidReceiveMessage,
R
rebornix 已提交
1007
					document,
R
rebornix 已提交
1008 1009 1010
					this._documentsAndEditors
				);

R
rebornix 已提交
1011 1012
				this._onDidOpenNotebookDocument.fire(document);

R
rebornix 已提交
1013 1014 1015 1016 1017 1018 1019 1020 1021 1022
				// 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 已提交
1023
}