/*--------------------------------------------------------------------------------------------- * Copyright (c) Microsoft Corporation. All rights reserved. * Licensed under the MIT License. See License.txt in the project root for license information. *--------------------------------------------------------------------------------------------*/ import { extHostNamedCustomer } from 'vs/workbench/api/common/extHostCustomers'; import { MainContext, MainThreadNotebookShape, NotebookExtensionDescription, IExtHostContext, ExtHostNotebookShape, ExtHostContext } from '../common/extHost.protocol'; import { Disposable, IDisposable } from 'vs/base/common/lifecycle'; import { URI, UriComponents } from 'vs/base/common/uri'; import { INotebookService, IMainNotebookController } from 'vs/workbench/contrib/notebook/browser/notebookService'; import { Emitter, Event } from 'vs/base/common/event'; import { ICell, IOutput, INotebook, INotebookMimeTypeSelector, NOTEBOOK_DISPLAY_ORDER } from 'vs/workbench/contrib/notebook/common/notebookCommon'; import { IConfigurationService } from 'vs/platform/configuration/common/configuration'; export class MainThreadCell implements ICell { private _onDidChangeOutputs = new Emitter(); onDidChangeOutputs: Event = this._onDidChangeOutputs.event; private _onDidChangeDirtyState = new Emitter(); onDidChangeDirtyState: Event = this._onDidChangeDirtyState.event; private _outputs: IOutput[]; get outputs(): IOutput[] { return this._outputs; } set outputs(newOutputs: IOutput[]) { this._outputs = newOutputs; this._onDidChangeOutputs.fire(); } private _isDirty: boolean = false; get isDirty() { return this._isDirty; } set isDirty(newState: boolean) { this._isDirty = newState; this._onDidChangeDirtyState.fire(newState); } readonly uri: URI; constructor( parent: MainThreadNotebookDocument, public handle: number, public source: string[], public language: string, public cell_type: 'markdown' | 'code', outputs: IOutput[] ) { this._outputs = outputs; this.uri = URI.from({ scheme: 'vscode-notebook', authority: parent.viewType, path: `/cell_${handle}.${cell_type === 'markdown' ? 'md' : 'py'}`, query: parent.uri.toString() }); } save() { this._isDirty = false; } } export class MainThreadNotebookDocument extends Disposable implements INotebook { private readonly _onWillDispose: Emitter = this._register(new Emitter()); readonly onWillDispose: Event = this._onWillDispose.event; private readonly _onDidChangeCells = new Emitter(); get onDidChangeCells(): Event { return this._onDidChangeCells.event; } private _onDidChangeDirtyState = new Emitter(); onDidChangeDirtyState: Event = this._onDidChangeDirtyState.event; private _mapping: Map = new Map(); private _cellListeners: Map = new Map(); cells: MainThreadCell[]; activeCell: MainThreadCell | undefined; languages: string[] = []; renderers = new Set(); private _isDirty: boolean = false; get isDirty() { return this._isDirty; } set isDirty(newState: boolean) { this._isDirty = newState; this._onDidChangeDirtyState.fire(newState); } constructor( private readonly _proxy: ExtHostNotebookShape, public handle: number, public viewType: string, public uri: URI ) { super(); this.cells = []; } updateLanguages(languages: string[]) { this.languages = languages; } updateRenderers(renderers: number[]) { renderers.forEach(render => { this.renderers.add(render); }); } updateCell(cell: ICell) { let mcell = this._mapping.get(cell.handle); if (mcell) { mcell.outputs = cell.outputs; } } updateCells(newCells: ICell[]) { // todo, handle cell insertion and deletion if (this.cells.length === 0) { newCells.forEach(cell => { let mainCell = new MainThreadCell(this, cell.handle, cell.source, cell.language, cell.cell_type, cell.outputs); this._mapping.set(cell.handle, mainCell); this.cells.push(mainCell); let dirtyStateListener = mainCell.onDidChangeDirtyState((cellState) => { this.isDirty = this.isDirty || cellState; }); this._cellListeners.set(cell.handle, dirtyStateListener); }); } else { newCells.forEach(newCell => { let cell = this._mapping.get(newCell.handle); if (cell) { cell.outputs = newCell.outputs; } }); } this._onDidChangeCells.fire(); } updateActiveCell(handle: number) { this.activeCell = this._mapping.get(handle); } async createRawCell(viewType: string, uri: URI, index: number, language: string, type: 'markdown' | 'code'): Promise { let cell = await this._proxy.$createEmptyCell(viewType, uri, index, language, type); if (cell) { let mainCell = new MainThreadCell(this, cell.handle, cell.source, cell.language, cell.cell_type, cell.outputs); this._mapping.set(cell.handle, mainCell); this.cells.splice(index, 0, mainCell); let dirtyStateListener = mainCell.onDidChangeDirtyState((cellState) => { this.isDirty = this.isDirty || cellState; }); this._cellListeners.set(cell.handle, dirtyStateListener); return mainCell; } return; } async deleteCell(uri: URI, index: number): Promise { let deleteExtHostCell = await this._proxy.$deleteCell(this.viewType, uri, index); if (deleteExtHostCell) { let cell = this.cells[index]; this._cellListeners.get(cell.handle)?.dispose(); this._cellListeners.delete(cell.handle); this.cells.splice(index, 1); return true; } return false; } async save(): Promise { let ret = await this._proxy.$saveNotebook(this.viewType, this.uri); if (ret) { this.cells.forEach((cell) => { cell.save(); }); } return ret; } dispose() { this._onWillDispose.fire(); super.dispose(); } } @extHostNamedCustomer(MainContext.MainThreadNotebook) export class MainThreadNotebooks extends Disposable implements MainThreadNotebookShape { private readonly _notebookProviders = new Map(); private readonly _proxy: ExtHostNotebookShape; constructor( extHostContext: IExtHostContext, @INotebookService private _notebookService: INotebookService, @IConfigurationService private readonly configurationService: IConfigurationService ) { super(); this._proxy = extHostContext.getProxy(ExtHostContext.ExtHostNotebook); this.registerListeners(); } registerListeners() { this._register(this._notebookService.onDidChangeActiveEditor(e => { this._proxy.$updateActiveEditor(e.viewType, e.uri); })); let userOrder = this.configurationService.getValue('notebook.displayOrder'); this._proxy.$acceptDisplayOrder({ defaultOrder: NOTEBOOK_DISPLAY_ORDER, userOrder: userOrder }); this.configurationService.onDidChangeConfiguration(e => { if (e.affectedKeys.indexOf('notebook.displayOrder') >= 0) { let userOrder = this.configurationService.getValue('notebook.displayOrder'); this._proxy.$acceptDisplayOrder({ defaultOrder: NOTEBOOK_DISPLAY_ORDER, userOrder: userOrder }); } }); } async $registerNotebookRenderer(extension: NotebookExtensionDescription, selectors: INotebookMimeTypeSelector, handle: number, preloads: UriComponents[]): Promise { this._notebookService.registerNotebookRenderer(handle, extension, selectors, preloads.map(uri => URI.revive(uri))); } async $unregisterNotebookRenderer(handle: number): Promise { this._notebookService.unregisterNotebookRenderer(handle); } async $registerNotebookProvider(extension: NotebookExtensionDescription, viewType: string): Promise { let controller = new MainThreadNotebookController(this._proxy, this, viewType); this._notebookProviders.set(viewType, controller); this._notebookService.registerNotebookController(viewType, extension, controller); return; } async $unregisterNotebookProvider(viewType: string): Promise { this._notebookProviders.delete(viewType); this._notebookService.unregisterNotebookProvider(viewType); return; } async $createNotebookDocument(handle: number, viewType: string, resource: UriComponents): Promise { let controller = this._notebookProviders.get(viewType); if (controller) { controller.createNotebookDocument(handle, viewType, resource); } return; } async $updateNotebookCells(viewType: string, resource: UriComponents, cells: ICell[], renderers: number[]): Promise { let controller = this._notebookProviders.get(viewType); if (controller) { controller.updateNotebookCells(resource, cells, renderers); } } async $updateNotebookLanguages(viewType: string, resource: UriComponents, languages: string[]): Promise { let controller = this._notebookProviders.get(viewType); if (controller) { controller.updateLanguages(resource, languages); } } async resolveNotebook(viewType: string, uri: URI): Promise { let handle = await this._proxy.$resolveNotebook(viewType, uri); return handle; } async executeNotebook(viewType: string, uri: URI): Promise { return this._proxy.$executeNotebook(viewType, uri, undefined); } } export class MainThreadNotebookController implements IMainNotebookController { private _mapping: Map = new Map(); constructor( private readonly _proxy: ExtHostNotebookShape, private _mainThreadNotebook: MainThreadNotebooks, private _viewType: string ) { } async resolveNotebook(viewType: string, uri: URI): Promise { // TODO: resolve notebook should wait for all notebook document destory operations to finish. let mainthreadNotebook = this._mapping.get(URI.from(uri).toString()); if (mainthreadNotebook) { return mainthreadNotebook; } let notebookHandle = await this._mainThreadNotebook.resolveNotebook(viewType, uri); if (notebookHandle !== undefined) { mainthreadNotebook = this._mapping.get(URI.from(uri).toString()); return mainthreadNotebook; } return undefined; } async executeNotebook(viewType: string, uri: URI): Promise { this._mainThreadNotebook.executeNotebook(viewType, uri); } // Methods for ExtHost async createNotebookDocument(handle: number, viewType: string, resource: UriComponents): Promise { let document = new MainThreadNotebookDocument(this._proxy, handle, viewType, URI.revive(resource)); this._mapping.set(URI.revive(resource).toString(), document); } updateNotebook(resource: UriComponents, notebook: INotebook): void { let document = this._mapping.get(URI.from(resource).toString()); document?.updateCells(notebook.cells); } updateLanguages(resource: UriComponents, languages: string[]) { let document = this._mapping.get(URI.from(resource).toString()); document?.updateLanguages(languages); } updateNotebookCells(resource: UriComponents, cells: ICell[], renderers: number[]): void { let document = this._mapping.get(URI.from(resource).toString()); document?.updateRenderers(renderers); document?.updateCells(cells); } updateNotebookRenderers(resource: UriComponents, renderers: number[]): void { let document = this._mapping.get(URI.from(resource).toString()); document?.updateRenderers(renderers); } updateNotebookActiveCell(uri: URI, cellHandle: number): void { let mainthreadNotebook = this._mapping.get(URI.from(uri).toString()); mainthreadNotebook?.updateActiveCell(cellHandle); } async createRawCell(uri: URI, index: number, language: string, type: 'markdown' | 'code'): Promise { let mainthreadNotebook = this._mapping.get(URI.from(uri).toString()); return mainthreadNotebook?.createRawCell(this._viewType, uri, index, language, type); } async deleteCell(uri: URI, index: number): Promise { let mainthreadNotebook = this._mapping.get(URI.from(uri).toString()); if (mainthreadNotebook) { return mainthreadNotebook.deleteCell(uri, index); } return false; } executeNotebookActiveCell(uri: URI): void { let mainthreadNotebook = this._mapping.get(URI.from(uri).toString()); if (mainthreadNotebook && mainthreadNotebook.activeCell) { this._proxy.$executeNotebook(this._viewType, uri, mainthreadNotebook.activeCell.handle); } } async destoryNotebookDocument(notebook: INotebook): Promise { let document = this._mapping.get(URI.from(notebook.uri).toString()); if (!document) { return; } let removeFromExtHost = await this._proxy.$destoryNotebookDocument(this._viewType, notebook.uri); if (removeFromExtHost) { document.dispose(); this._mapping.delete(URI.from(notebook.uri).toString()); } } }