/*--------------------------------------------------------------------------------------------- * 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, INotebookDocumentsAndEditorsDelta, INotebookModelAddedData } from '../common/extHost.protocol'; import { Disposable, IDisposable, combinedDisposable } from 'vs/base/common/lifecycle'; import { URI, UriComponents } from 'vs/base/common/uri'; import { INotebookService, IMainNotebookController } from 'vs/workbench/contrib/notebook/common/notebookService'; import { INotebookTextModel, INotebookMimeTypeSelector, NOTEBOOK_DISPLAY_ORDER, NotebookCellOutputsSplice, NotebookDocumentMetadata, NotebookCellMetadata, ICellEditOperation, ACCESSIBLE_NOTEBOOK_DISPLAY_ORDER, CellEditType, CellKind, INotebookKernelInfo, INotebookKernelInfoDto, INotebookTextModelBackup, IEditor, INotebookRendererInfo, IOutputRenderRequest, IOutputRenderResponse } from 'vs/workbench/contrib/notebook/common/notebookCommon'; import { IConfigurationService } from 'vs/platform/configuration/common/configuration'; import { NotebookTextModel } from 'vs/workbench/contrib/notebook/common/model/notebookTextModel'; import { IEditorService } from 'vs/workbench/services/editor/common/editorService'; import { INotebookEditor } from 'vs/workbench/contrib/notebook/browser/notebookBrowser'; import { CancellationToken } from 'vs/base/common/cancellation'; import { IAccessibilityService } from 'vs/platform/accessibility/common/accessibility'; import { IRelativePattern } from 'vs/base/common/glob'; import { ExtensionIdentifier } from 'vs/platform/extensions/common/extensions'; export class MainThreadNotebookDocument extends Disposable { private _textModel: NotebookTextModel; get textModel() { return this._textModel; } constructor( private readonly _proxy: ExtHostNotebookShape, public handle: number, public viewType: string, public uri: URI, readonly notebookService: INotebookService ) { super(); this._textModel = new NotebookTextModel(handle, viewType, uri); this._register(this._textModel.onDidModelChange(e => { this._proxy.$acceptModelChanged(this.uri, e); this._proxy.$acceptEditorPropertiesChanged(uri, { selections: { selections: this._textModel.selections }, metadata: null }); })); this._register(this._textModel.onDidSelectionChange(e => { const selectionsChange = e ? { selections: e } : null; this._proxy.$acceptEditorPropertiesChanged(uri, { selections: selectionsChange, metadata: null }); })); } async applyEdit(modelVersionId: number, edits: ICellEditOperation[]): Promise { await this.notebookService.transformEditsOutputs(this.textModel, edits); return this._textModel.$applyEdit(modelVersionId, edits); } async spliceNotebookCellOutputs(cellHandle: number, splices: NotebookCellOutputsSplice[]) { await this.notebookService.transformSpliceOutputs(this.textModel, splices); this._textModel.$spliceNotebookCellOutputs(cellHandle, splices); } dispose() { this._textModel.dispose(); super.dispose(); } } class DocumentAndEditorState { static ofMaps(before: Map, after: Map): { removed: V[], added: V[] } { const removed: V[] = []; const added: V[] = []; before.forEach((value, index) => { if (!after.has(index)) { removed.push(value); } }); after.forEach((value, index) => { if (!before.has(index)) { added.push(value); } }); return { removed, added }; } static compute(before: DocumentAndEditorState | undefined, after: DocumentAndEditorState): INotebookDocumentsAndEditorsDelta { if (!before) { const apiEditors = []; for (let id in after.textEditors) { const editor = after.textEditors.get(id)!; apiEditors.push({ id, documentUri: editor.uri!, selections: editor!.textModel!.selections }); } return { addedDocuments: [], addedEditors: apiEditors }; } // const documentDelta = delta.ofSets(before.documents, after.documents); const editorDelta = DocumentAndEditorState.ofMaps(before.textEditors, after.textEditors); const addedAPIEditors = editorDelta.added.map(add => ({ id: add.getId(), documentUri: add.uri!, selections: add.textModel!.selections })); const removedAPIEditors = editorDelta.removed.map(removed => removed.getId()); // const oldActiveEditor = before.activeEditor !== after.activeEditor ? before.activeEditor : undefined; const newActiveEditor = before.activeEditor !== after.activeEditor ? after.activeEditor : undefined; // return new DocumentAndEditorStateDelta( // documentDelta.removed, documentDelta.added, // editorDelta.removed, editorDelta.added, // oldActiveEditor, newActiveEditor // ); return { addedEditors: addedAPIEditors, removedEditors: removedAPIEditors, newActiveEditor: newActiveEditor }; } constructor( readonly documents: Set, readonly textEditors: Map, readonly activeEditor: string | null | undefined, ) { // } } @extHostNamedCustomer(MainContext.MainThreadNotebook) export class MainThreadNotebooks extends Disposable implements MainThreadNotebookShape { private readonly _notebookProviders = new Map(); private readonly _notebookKernels = new Map(); private readonly _notebookRenderers = new Map(); private readonly _proxy: ExtHostNotebookShape; private _toDisposeOnEditorRemove = new Map(); private _currentState?: DocumentAndEditorState; constructor( extHostContext: IExtHostContext, @INotebookService private _notebookService: INotebookService, @IConfigurationService private readonly configurationService: IConfigurationService, @IEditorService private readonly editorService: IEditorService, @IAccessibilityService private readonly accessibilityService: IAccessibilityService ) { super(); this._proxy = extHostContext.getProxy(ExtHostContext.ExtHostNotebook); this.registerListeners(); } async $tryApplyEdits(viewType: string, resource: UriComponents, modelVersionId: number, edits: ICellEditOperation[], renderers: number[]): Promise { let controller = this._notebookProviders.get(viewType); if (controller) { return controller.tryApplyEdits(resource, modelVersionId, edits, renderers); } return false; } registerListeners() { this._notebookService.listNotebookEditors().forEach((e) => { this._addNotebookEditor(e); }); this._register(this._notebookService.onDidChangeActiveEditor(e => { this._proxy.$acceptDocumentAndEditorsDelta({ newActiveEditor: e }); })); this._register(this._notebookService.onDidChangeVisibleEditors(e => { this._proxy.$acceptDocumentAndEditorsDelta({ visibleEditors: e }); })); this._register(this._notebookService.onNotebookEditorAdd(editor => { this._addNotebookEditor(editor); })); this._register(this._notebookService.onNotebookEditorRemove(editor => { this._removeNotebookEditor(editor); })); const updateOrder = () => { let userOrder = this.configurationService.getValue('notebook.displayOrder'); this._proxy.$acceptDisplayOrder({ defaultOrder: this.accessibilityService.isScreenReaderOptimized() ? ACCESSIBLE_NOTEBOOK_DISPLAY_ORDER : NOTEBOOK_DISPLAY_ORDER, userOrder: userOrder }); }; updateOrder(); this._register(this.configurationService.onDidChangeConfiguration(e => { if (e.affectedKeys.indexOf('notebook.displayOrder') >= 0) { updateOrder(); } })); this._register(this.accessibilityService.onDidChangeScreenReaderOptimized(() => { updateOrder(); })); const activeEditorPane = this.editorService.activeEditorPane as any | undefined; const notebookEditor = activeEditorPane?.isNotebookEditor ? activeEditorPane.getControl() : undefined; this._updateState(notebookEditor); } async addNotebookDocument(data: INotebookModelAddedData) { await this._proxy.$acceptDocumentAndEditorsDelta({ addedDocuments: [data] }); } private _addNotebookEditor(e: IEditor) { this._toDisposeOnEditorRemove.set(e.getId(), combinedDisposable( e.onDidChangeModel(() => this._updateState()), e.onDidFocusEditorWidget(() => { this._updateState(e); }), )); const activeEditorPane = this.editorService.activeEditorPane as any | undefined; const notebookEditor = activeEditorPane?.isNotebookEditor ? activeEditorPane.getControl() : undefined; this._updateState(notebookEditor); } private _removeNotebookEditor(e: IEditor) { const sub = this._toDisposeOnEditorRemove.get(e.getId()); if (sub) { this._toDisposeOnEditorRemove.delete(e.getId()); sub.dispose(); this._updateState(); } } private async _updateState(focusedNotebookEditor?: IEditor) { const documents = new Set(); this._notebookService.listNotebookDocuments().forEach(document => { documents.add(document.uri); }); const editors = new Map(); let activeEditor: string | null = null; for (const editor of this._notebookService.listNotebookEditors()) { if (editor.hasModel()) { editors.set(editor.getId(), editor); if (editor.hasFocus()) { activeEditor = editor.getId(); } } } if (!activeEditor && focusedNotebookEditor) { activeEditor = focusedNotebookEditor.getId(); } // editors always have view model attached, which means there is already a document in exthost. const newState = new DocumentAndEditorState(documents, editors, activeEditor); const delta = DocumentAndEditorState.compute(this._currentState, newState); // const isEmptyChange = (!delta.addedDocuments || delta.addedDocuments.length === 0) // && (!delta.removedDocuments || delta.removedDocuments.length === 0) // && (!delta.addedEditors || delta.addedEditors.length === 0) // && (!delta.removedEditors || delta.removedEditors.length === 0) // && (delta.newActiveEditor === undefined) // if (!isEmptyChange) { this._currentState = newState; await this._proxy.$acceptDocumentAndEditorsDelta(delta); // } } async $registerNotebookRenderer(extension: NotebookExtensionDescription, type: string, selectors: INotebookMimeTypeSelector, preloads: UriComponents[]): Promise { const renderer = new MainThreadNotebookRenderer(this._proxy, type, extension.id, URI.revive(extension.location), selectors, preloads.map(uri => URI.revive(uri))); this._notebookRenderers.set(type, renderer); this._notebookService.registerNotebookRenderer(type, renderer); } async $unregisterNotebookRenderer(id: string): Promise { this._notebookService.unregisterNotebookRenderer(id); } async $registerNotebookProvider(extension: NotebookExtensionDescription, viewType: string, kernel: INotebookKernelInfoDto | undefined): Promise { let controller = new MainThreadNotebookController(this._proxy, this, viewType, kernel, this._notebookService); 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 $registerNotebookKernel(extension: NotebookExtensionDescription, id: string, label: string, selectors: (string | IRelativePattern)[], preloads: UriComponents[]): Promise { const kernel = new MainThreadNotebookKernel(this._proxy, id, label, selectors, extension.id, URI.revive(extension.location), preloads.map(preload => URI.revive(preload))); this._notebookKernels.set(id, kernel); this._notebookService.registerNotebookKernel(kernel); return; } async $unregisterNotebookKernel(id: string): Promise { this._notebookKernels.delete(id); this._notebookService.unregisterNotebookKernel(id); return; } async $updateNotebookLanguages(viewType: string, resource: UriComponents, languages: string[]): Promise { let controller = this._notebookProviders.get(viewType); if (controller) { controller.updateLanguages(resource, languages); } } async $updateNotebookMetadata(viewType: string, resource: UriComponents, metadata: NotebookDocumentMetadata): Promise { let controller = this._notebookProviders.get(viewType); if (controller) { controller.updateNotebookMetadata(resource, metadata); } } async $updateNotebookCellMetadata(viewType: string, resource: UriComponents, handle: number, metadata: NotebookCellMetadata): Promise { let controller = this._notebookProviders.get(viewType); if (controller) { controller.updateNotebookCellMetadata(resource, handle, metadata); } } async $spliceNotebookCellOutputs(viewType: string, resource: UriComponents, cellHandle: number, splices: NotebookCellOutputsSplice[], renderers: number[]): Promise { let controller = this._notebookProviders.get(viewType); await controller?.spliceNotebookCellOutputs(resource, cellHandle, splices, renderers); } async executeNotebook(viewType: string, uri: URI, useAttachedKernel: boolean, token: CancellationToken): Promise { return this._proxy.$executeNotebook(viewType, uri, undefined, useAttachedKernel, token); } async $postMessage(handle: number, value: any): Promise { const activeEditorPane = this.editorService.activeEditorPane as any | undefined; if (activeEditorPane?.isNotebookEditor) { const notebookEditor = (activeEditorPane.getControl() as INotebookEditor); if (notebookEditor.viewModel?.handle === handle) { notebookEditor.postMessage(value); return true; } } return false; } } export class MainThreadNotebookController implements IMainNotebookController { private _mapping: Map = new Map(); static documentHandle: number = 0; constructor( private readonly _proxy: ExtHostNotebookShape, private _mainThreadNotebook: MainThreadNotebooks, private _viewType: string, readonly kernel: INotebookKernelInfoDto | undefined, readonly notebookService: INotebookService, ) { } async createNotebook(viewType: string, uri: URI, backup: INotebookTextModelBackup | undefined, forceReload: boolean, editorId?: string): Promise { let mainthreadNotebook = this._mapping.get(URI.from(uri).toString()); if (mainthreadNotebook) { if (forceReload) { const data = await this._proxy.$resolveNotebookData(viewType, uri); if (!data) { return; } mainthreadNotebook.textModel.languages = data.languages; mainthreadNotebook.textModel.metadata = data.metadata; mainthreadNotebook.textModel.$applyEdit(mainthreadNotebook.textModel.versionId, [ { editType: CellEditType.Delete, count: mainthreadNotebook.textModel.cells.length, index: 0 }, { editType: CellEditType.Insert, index: 0, cells: data.cells } ]); } return mainthreadNotebook.textModel; } let document = new MainThreadNotebookDocument(this._proxy, MainThreadNotebookController.documentHandle++, viewType, uri, this.notebookService); this._mapping.set(document.uri.toString(), document); if (backup) { // trigger events document.textModel.metadata = backup.metadata; document.textModel.languages = backup.languages; document.textModel.$applyEdit(document.textModel.versionId, [ { editType: CellEditType.Insert, index: 0, cells: backup.cells || [] } ]); await this._mainThreadNotebook.addNotebookDocument({ viewType: document.viewType, handle: document.handle, uri: document.uri, metadata: document.textModel.metadata, versionId: document.textModel.versionId, cells: document.textModel.cells.map(cell => ({ handle: cell.handle, uri: cell.uri, source: cell.textBuffer.getLinesContent(), language: cell.language, cellKind: cell.cellKind, outputs: cell.outputs, metadata: cell.metadata })), attachedEditor: editorId ? { id: editorId, selections: document.textModel.selections } : undefined }); return document.textModel; } // open notebook document const data = await this._proxy.$resolveNotebookData(viewType, uri); if (!data) { return; } document.textModel.languages = data.languages; document.textModel.metadata = data.metadata; if (data.cells.length) { document.textModel.initialize(data!.cells); } else { const mainCell = document.textModel.createCellTextModel([''], document.textModel.languages.length ? document.textModel.languages[0] : '', CellKind.Code, [], undefined); document.textModel.insertTemplateCell(mainCell); } await this._mainThreadNotebook.addNotebookDocument({ viewType: document.viewType, handle: document.handle, uri: document.uri, metadata: document.textModel.metadata, versionId: document.textModel.versionId, cells: document.textModel.cells.map(cell => ({ handle: cell.handle, uri: cell.uri, source: cell.textBuffer.getLinesContent(), language: cell.language, cellKind: cell.cellKind, outputs: cell.outputs, metadata: cell.metadata })), attachedEditor: editorId ? { id: editorId, selections: document.textModel.selections } : undefined }); this._proxy.$acceptEditorPropertiesChanged(uri, { selections: null, metadata: document.textModel.metadata }); return document.textModel; } async tryApplyEdits(resource: UriComponents, modelVersionId: number, edits: ICellEditOperation[], renderers: number[]): Promise { let mainthreadNotebook = this._mapping.get(URI.from(resource).toString()); if (mainthreadNotebook) { return await mainthreadNotebook.applyEdit(modelVersionId, edits); } return false; } async spliceNotebookCellOutputs(resource: UriComponents, cellHandle: number, splices: NotebookCellOutputsSplice[], renderers: number[]): Promise { let mainthreadNotebook = this._mapping.get(URI.from(resource).toString()); await mainthreadNotebook?.spliceNotebookCellOutputs(cellHandle, splices); } async executeNotebook(viewType: string, uri: URI, useAttachedKernel: boolean, token: CancellationToken): Promise { return this._mainThreadNotebook.executeNotebook(viewType, uri, useAttachedKernel, token); } onDidReceiveMessage(editorId: string, message: any): void { this._proxy.$onDidReceiveMessage(editorId, message); } async removeNotebookDocument(notebook: INotebookTextModel): Promise { let document = this._mapping.get(URI.from(notebook.uri).toString()); if (!document) { return; } await this._proxy.$acceptDocumentAndEditorsDelta({ removedDocuments: [notebook.uri] }); document.dispose(); this._mapping.delete(URI.from(notebook.uri).toString()); } // Methods for ExtHost updateLanguages(resource: UriComponents, languages: string[]) { let document = this._mapping.get(URI.from(resource).toString()); document?.textModel.updateLanguages(languages); } updateNotebookMetadata(resource: UriComponents, metadata: NotebookDocumentMetadata) { let document = this._mapping.get(URI.from(resource).toString()); document?.textModel.updateNotebookMetadata(metadata); } updateNotebookCellMetadata(resource: UriComponents, handle: number, metadata: NotebookCellMetadata) { let document = this._mapping.get(URI.from(resource).toString()); document?.textModel.updateNotebookCellMetadata(handle, metadata); } // updateNotebookRenderers(resource: UriComponents, renderers: number[]): void { // let document = this._mapping.get(URI.from(resource).toString()); // document?.textModel.updateRenderers(renderers); // } async executeNotebookCell(uri: URI, handle: number, useAttachedKernel: boolean, token: CancellationToken): Promise { return this._proxy.$executeNotebook(this._viewType, uri, handle, useAttachedKernel, token); } async save(uri: URI, token: CancellationToken): Promise { return this._proxy.$saveNotebook(this._viewType, uri, token); } async saveAs(uri: URI, target: URI, token: CancellationToken): Promise { return this._proxy.$saveNotebookAs(this._viewType, uri, target, token); } } export class MainThreadNotebookKernel implements INotebookKernelInfo { constructor( private readonly _proxy: ExtHostNotebookShape, readonly id: string, readonly label: string, readonly selectors: (string | IRelativePattern)[], readonly extension: ExtensionIdentifier, readonly extensionLocation: URI, readonly preloads: URI[] ) { } async executeNotebook(viewType: string, uri: URI, handle: number | undefined, token: CancellationToken): Promise { return this._proxy.$executeNotebook2(this.id, viewType, uri, handle, token); } } export class MainThreadNotebookRenderer implements INotebookRendererInfo { constructor( private readonly _proxy: ExtHostNotebookShape, readonly id: string, readonly extensionId: ExtensionIdentifier, readonly extensionLocation: URI, readonly selectors: INotebookMimeTypeSelector, readonly preloads: URI[] ) { } render(uri: URI, request: IOutputRenderRequest): Promise | undefined> { return this._proxy.$renderOutputs(uri, this.id, request); } render2(uri: URI, request: IOutputRenderRequest): Promise | undefined> { return this._proxy.$renderOutputs2(uri, this.id, request); } }