/*--------------------------------------------------------------------------------------------- * Copyright (c) Microsoft Corporation. All rights reserved. * Licensed under the MIT License. See License.txt in the project root for license information. *--------------------------------------------------------------------------------------------*/ import * as DOM from 'vs/base/browser/dom'; import { CancellationToken } from 'vs/base/common/cancellation'; import { Emitter } from 'vs/base/common/event'; import { combinedDisposable, Disposable, DisposableStore, IDisposable } from 'vs/base/common/lifecycle'; import { ResourceMap } from 'vs/base/common/map'; import { Schemas } from 'vs/base/common/network'; import { URI, UriComponents } from 'vs/base/common/uri'; import { IAccessibilityService } from 'vs/platform/accessibility/common/accessibility'; import { IConfigurationService } from 'vs/platform/configuration/common/configuration'; import { ILogService } from 'vs/platform/log/common/log'; import { extHostNamedCustomer } from 'vs/workbench/api/common/extHostCustomers'; import { INotebookEditor } from 'vs/workbench/contrib/notebook/browser/notebookBrowser'; import { NotebookCellTextModel } from 'vs/workbench/contrib/notebook/common/model/notebookCellTextModel'; import { NotebookTextModel } from 'vs/workbench/contrib/notebook/common/model/notebookTextModel'; import { INotebookCellStatusBarService } from 'vs/workbench/contrib/notebook/common/notebookCellStatusBarService'; import { ACCESSIBLE_NOTEBOOK_DISPLAY_ORDER, CellEditType, CellKind, DisplayOrderKey, ICellEditOperation, ICellRange, IEditor, IMainCellDto, INotebookDocumentFilter, NotebookCellMetadata, NotebookCellOutputsSplice, NotebookCellsChangeType, NotebookDocumentMetadata, NOTEBOOK_DISPLAY_ORDER, TransientMetadata } from 'vs/workbench/contrib/notebook/common/notebookCommon'; import { IMainNotebookController, INotebookService } from 'vs/workbench/contrib/notebook/common/notebookService'; import { IEditorService } from 'vs/workbench/services/editor/common/editorService'; import { IWorkingCopyService } from 'vs/workbench/services/workingCopy/common/workingCopyService'; import { ExtHostContext, ExtHostNotebookShape, IExtHostContext, INotebookCellStatusBarEntryDto, INotebookDocumentsAndEditorsDelta, INotebookModelAddedData, MainContext, MainThreadNotebookShape, NotebookEditorRevealType, NotebookExtensionDescription } from '../common/extHost.protocol'; class DocumentAndEditorState { static ofSets(before: Set, after: Set): { removed: T[], added: T[] } { const removed: T[] = []; const added: T[] = []; before.forEach(element => { if (!after.has(element)) { removed.push(element); } }); after.forEach(element => { if (!before.has(element)) { added.push(element); } }); return { removed, added }; } 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!.getSelectionHandles(), visibleRanges: editor.visibleRanges }); } return { addedDocuments: [], addedEditors: apiEditors, visibleEditors: [...after.visibleEditors].map(editor => editor[0]) }; } const documentDelta = DocumentAndEditorState.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.getSelectionHandles(), visibleRanges: add.visibleRanges })); 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; const visibleEditorDelta = DocumentAndEditorState.ofMaps(before.visibleEditors, after.visibleEditors); return { addedDocuments: documentDelta.added.map((e: NotebookTextModel): INotebookModelAddedData => { return { viewType: e.viewType, uri: e.uri, metadata: e.metadata, versionId: e.versionId, cells: e.cells.map(cell => ({ handle: cell.handle, uri: cell.uri, source: cell.textBuffer.getLinesContent(), eol: cell.textBuffer.getEOL(), language: cell.language, cellKind: cell.cellKind, outputs: cell.outputs, metadata: cell.metadata })), // attachedEditor: editorId ? { // id: editorId, // selections: document.textModel.selections // } : undefined }; }), removedDocuments: documentDelta.removed.map(e => e.uri), addedEditors: addedAPIEditors, removedEditors: removedAPIEditors, newActiveEditor: newActiveEditor, visibleEditors: visibleEditorDelta.added.length === 0 && visibleEditorDelta.removed.length === 0 ? undefined : [...after.visibleEditors].map(editor => editor[0]) }; } constructor( readonly documents: Set, readonly textEditors: Map, readonly activeEditor: string | null | undefined, readonly visibleEditors: Map ) { // } } @extHostNamedCustomer(MainContext.MainThreadNotebook) export class MainThreadNotebooks extends Disposable implements MainThreadNotebookShape { private readonly _notebookProviders = new Map(); private readonly _notebookKernelProviders = new Map, provider: IDisposable }>(); private readonly _proxy: ExtHostNotebookShape; private _toDisposeOnEditorRemove = new Map(); private _currentState?: DocumentAndEditorState; private _editorEventListenersMapping: Map = new Map(); private _documentEventListenersMapping: ResourceMap = new ResourceMap(); private readonly _cellStatusBarEntries: Map = new Map(); constructor( extHostContext: IExtHostContext, @INotebookService private _notebookService: INotebookService, @IConfigurationService private readonly configurationService: IConfigurationService, @IEditorService private readonly editorService: IEditorService, @IAccessibilityService private readonly accessibilityService: IAccessibilityService, @ILogService private readonly logService: ILogService, @INotebookCellStatusBarService private readonly cellStatusBarService: INotebookCellStatusBarService, @IWorkingCopyService private readonly _workingCopyService: IWorkingCopyService, ) { super(); this._proxy = extHostContext.getProxy(ExtHostContext.ExtHostNotebook); this.registerListeners(); } async $tryApplyEdits(_viewType: string, resource: UriComponents, modelVersionId: number, cellEdits: ICellEditOperation[], newMetadata: NotebookDocumentMetadata | undefined): Promise { const textModel = this._notebookService.getNotebookTextModel(URI.from(resource)); if (!textModel) { return false; } this._notebookService.transformEditsOutputs(textModel, cellEdits); //TODO@rebornix should this go into applyEdit? if (newMetadata) { textModel.updateNotebookMetadata(newMetadata); } return textModel.applyEdit(modelVersionId, cellEdits, true); } private _isDeltaEmpty(delta: INotebookDocumentsAndEditorsDelta) { if (delta.addedDocuments !== undefined && delta.addedDocuments.length > 0) { return false; } if (delta.removedDocuments !== undefined && delta.removedDocuments.length > 0) { return false; } if (delta.addedEditors !== undefined && delta.addedEditors.length > 0) { return false; } if (delta.removedEditors !== undefined && delta.removedEditors.length > 0) { return false; } if (delta.visibleEditors !== undefined && delta.visibleEditors.length > 0) { return false; } if (delta.newActiveEditor !== undefined) { return false; } return true; } private _emitDelta(delta: INotebookDocumentsAndEditorsDelta) { if (this._isDeltaEmpty(delta)) { return; } return this._proxy.$acceptDocumentAndEditorsDelta(delta); } registerListeners() { this._notebookService.listNotebookEditors().forEach((e) => { this._addNotebookEditor(e); }); this._register(this._notebookService.onDidChangeActiveEditor(e => { this._updateState(); })); this._register(this._notebookService.onDidChangeVisibleEditors(e => { if (this._notebookProviders.size > 0) { if (!this._currentState) { // no current state means we didn't even create editors in ext host yet. return; } // we can't simply update visibleEditors as we need to check if we should create editors first. this._updateState(); } })); const notebookEditorAddedHandler = (editor: IEditor) => { if (!this._editorEventListenersMapping.has(editor.getId())) { const disposableStore = new DisposableStore(); disposableStore.add(editor.onDidChangeVisibleRanges(() => { this._proxy.$acceptEditorPropertiesChanged(editor.getId(), { visibleRanges: { ranges: editor.visibleRanges }, selections: null }); })); disposableStore.add(editor.onDidChangeSelection(() => { const selectionHandles = editor.getSelectionHandles(); this._proxy.$acceptEditorPropertiesChanged(editor.getId(), { visibleRanges: null, selections: { selections: selectionHandles } }); })); this._editorEventListenersMapping.set(editor.getId(), disposableStore); } }; this._register(this._notebookService.onNotebookEditorAdd(editor => { notebookEditorAddedHandler(editor); this._addNotebookEditor(editor); })); this._register(this._notebookService.onNotebookEditorsRemove(editors => { this._removeNotebookEditor(editors); editors.forEach(editor => { this._editorEventListenersMapping.get(editor.getId())?.dispose(); this._editorEventListenersMapping.delete(editor.getId()); }); })); this._notebookService.listNotebookEditors().forEach(editor => { notebookEditorAddedHandler(editor); }); const cellToDto = (cell: NotebookCellTextModel): IMainCellDto => { return { handle: cell.handle, uri: cell.uri, source: cell.textBuffer.getLinesContent(), eol: cell.textBuffer.getEOL(), language: cell.language, cellKind: cell.cellKind, outputs: cell.outputs, metadata: cell.metadata }; }; const notebookDocumentAddedHandler = (textModel: NotebookTextModel) => { if (!this._editorEventListenersMapping.has(textModel.uri.toString())) { const disposableStore = new DisposableStore(); disposableStore.add(textModel!.onDidChangeContent(e => { const data = e.kind === NotebookCellsChangeType.ModelChange || e.kind === NotebookCellsChangeType.Initialize ? { kind: e.kind, versionId: e.versionId, changes: e.changes.map(diff => [diff[0], diff[1], diff[2].map(cell => cellToDto(cell as NotebookCellTextModel))] as [number, number, IMainCellDto[]]) } : ( e.kind === NotebookCellsChangeType.Move ? { kind: e.kind, index: e.index, length: e.length, newIdx: e.newIdx, versionId: e.versionId, cells: e.cells.map(cell => cellToDto(cell as NotebookCellTextModel)) } : e ); /** * TODO@rebornix, @jrieken * When a document is modified, it will trigger onDidChangeContent events. * The first event listener is this one, which doesn't know if the text model is dirty or not. It can ask `workingCopyService` but get the wrong result * The second event listener is `NotebookEditorModel`, which will then set `isDirty` to `true`. * Since `e.transient` decides if the model should be dirty or not, we will use the same logic here. */ this._proxy.$acceptModelChanged(textModel.uri, data, !e.transient); this._proxy.$acceptDocumentPropertiesChanged(textModel.uri, { metadata: null }); })); this._editorEventListenersMapping.set(textModel!.uri.toString(), disposableStore); } }; this._notebookService.listNotebookDocuments().forEach(notebookDocumentAddedHandler); this._register(this._notebookService.onDidAddNotebookDocument(document => { notebookDocumentAddedHandler(document); this._updateState(); })); this._register(this._notebookService.onDidRemoveNotebookDocument(uri => { this._documentEventListenersMapping.get(uri)?.dispose(); this._documentEventListenersMapping.delete(uri); this._updateState(); })); this._register(this._notebookService.onDidChangeNotebookActiveKernel(e => { this._proxy.$acceptNotebookActiveKernelChange(e); })); this._register(this._notebookService.onNotebookDocumentSaved(e => { this._proxy.$acceptModelSaved(e); })); const updateOrder = () => { let userOrder = this.configurationService.getValue(DisplayOrderKey); 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(DisplayOrderKey) >= 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); } 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(editors: IEditor[]) { editors.forEach(e => { const sub = this._toDisposeOnEditorRemove.get(e.getId()); if (sub) { this._toDisposeOnEditorRemove.delete(e.getId()); sub.dispose(); } }); this._updateState(); } private async _updateState(focusedNotebookEditor?: IEditor) { let activeEditor: string | null = null; const activeEditorPane = this.editorService.activeEditorPane as any | undefined; if (activeEditorPane?.isNotebookEditor) { const notebookEditor = (activeEditorPane.getControl() as INotebookEditor); activeEditor = notebookEditor && notebookEditor.hasModel() ? notebookEditor!.getId() : null; } const documentEditorsMap = new Map(); const editors = new Map(); this._notebookService.listNotebookEditors().forEach(editor => { if (editor.hasModel()) { editors.set(editor.getId(), editor); documentEditorsMap.set(editor.textModel!.uri.toString(), editor); } }); const visibleEditorsMap = new Map(); this.editorService.visibleEditorPanes.forEach(editor => { if ((editor as any).isNotebookEditor) { const nbEditorWidget = (editor as any).getControl() as INotebookEditor; if (nbEditorWidget && editors.has(nbEditorWidget.getId())) { visibleEditorsMap.set(nbEditorWidget.getId(), nbEditorWidget); } } }); const documents = new Set(); this._notebookService.listNotebookDocuments().forEach(document => { documents.add(document); }); if (!activeEditor && focusedNotebookEditor && focusedNotebookEditor.hasModel()) { 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, visibleEditorsMap); 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._emitDelta(delta); // } } async $registerNotebookProvider(extension: NotebookExtensionDescription, viewType: string, supportBackup: boolean, options: { transientOutputs: boolean; transientMetadata: TransientMetadata }): Promise { const controller: IMainNotebookController = { supportBackup, options, reloadNotebook: async (mainthreadTextModel: NotebookTextModel) => { const data = await this._proxy.$resolveNotebookData(viewType, mainthreadTextModel.uri); mainthreadTextModel.updateLanguages(data.languages); mainthreadTextModel.metadata = data.metadata; mainthreadTextModel.transientOptions = options; const edits: ICellEditOperation[] = [ { editType: CellEditType.Replace, index: 0, count: mainthreadTextModel.cells.length, cells: data.cells } ]; this._notebookService.transformEditsOutputs(mainthreadTextModel, edits); await new Promise(resolve => { DOM.scheduleAtNextAnimationFrame(() => { const ret = mainthreadTextModel!.applyEdit(mainthreadTextModel!.versionId, edits, true); resolve(ret); }); }); }, resolveNotebookDocument: async (viewType: string, uri: URI, backupId?: string) => { const data = await this._proxy.$resolveNotebookData(viewType, uri, backupId); return { data, transientOptions: options }; }, resolveNotebookEditor: async (viewType: string, uri: URI, editorId: string) => { await this._proxy.$resolveNotebookEditor(viewType, uri, editorId); }, onDidReceiveMessage: (editorId: string, rendererType: string | undefined, message: unknown) => { this._proxy.$onDidReceiveMessage(editorId, rendererType, message); }, save: async (uri: URI, token: CancellationToken) => { return this._proxy.$saveNotebook(viewType, uri, token); }, saveAs: async (uri: URI, target: URI, token: CancellationToken) => { return this._proxy.$saveNotebookAs(viewType, uri, target, token); }, backup: async (uri: URI, token: CancellationToken) => { return this._proxy.$backup(viewType, uri, token); } }; const disposable = this._notebookService.registerNotebookController(viewType, extension, controller); this._notebookProviders.set(viewType, { controller, disposable }); return; } async $onNotebookChange(_viewType: string, uri: UriComponents): Promise { const textModel = this._notebookService.getNotebookTextModel(URI.from(uri)); textModel?.handleUnknownChange(); } async $unregisterNotebookProvider(viewType: string): Promise { const entry = this._notebookProviders.get(viewType); if (entry) { entry.disposable.dispose(); this._notebookProviders.delete(viewType); } } async $registerNotebookKernelProvider(extension: NotebookExtensionDescription, handle: number, documentFilter: INotebookDocumentFilter): Promise { const emitter = new Emitter(); const that = this; const provider = this._notebookService.registerNotebookKernelProvider({ providerExtensionId: extension.id.value, providerDescription: extension.description, onDidChangeKernels: emitter.event, selector: documentFilter, provideKernels: async (uri: URI, token: CancellationToken) => { const kernels = await that._proxy.$provideNotebookKernels(handle, uri, token); return kernels.map(kernel => { return { ...kernel, providerHandle: handle }; }); }, resolveKernel: (editorId: string, uri: URI, kernelId: string, token: CancellationToken) => { return that._proxy.$resolveNotebookKernel(handle, editorId, uri, kernelId, token); }, executeNotebook: (uri: URI, kernelId: string, cellHandle: number | undefined) => { this.logService.debug('MainthreadNotebooks.registerNotebookKernelProvider#executeNotebook', uri.path, kernelId, cellHandle); return that._proxy.$executeNotebookKernelFromProvider(handle, uri, kernelId, cellHandle); }, cancelNotebook: (uri: URI, kernelId: string, cellHandle: number | undefined) => { this.logService.debug('MainthreadNotebooks.registerNotebookKernelProvider#cancelNotebook', uri.path, kernelId, cellHandle); return that._proxy.$cancelNotebookKernelFromProvider(handle, uri, kernelId, cellHandle); }, }); this._notebookKernelProviders.set(handle, { extension, emitter, provider }); return; } async $unregisterNotebookKernelProvider(handle: number): Promise { const entry = this._notebookKernelProviders.get(handle); if (entry) { entry.emitter.dispose(); entry.provider.dispose(); this._notebookKernelProviders.delete(handle); } } $onNotebookKernelChange(handle: number, uriComponents: UriComponents): void { const entry = this._notebookKernelProviders.get(handle); entry?.emitter.fire(uriComponents ? URI.revive(uriComponents) : undefined); } async $updateNotebookLanguages(viewType: string, resource: UriComponents, languages: string[]): Promise { this.logService.debug('MainThreadNotebooks#updateNotebookLanguages', resource.path, languages); const textModel = this._notebookService.getNotebookTextModel(URI.from(resource)); textModel?.updateLanguages(languages); } async $updateNotebookMetadata(viewType: string, resource: UriComponents, metadata: NotebookDocumentMetadata): Promise { this.logService.debug('MainThreadNotebooks#updateNotebookMetadata', resource.path, metadata); const textModel = this._notebookService.getNotebookTextModel(URI.from(resource)); textModel?.updateNotebookMetadata(metadata); } async $updateNotebookCellMetadata(viewType: string, resource: UriComponents, handle: number, metadata: NotebookCellMetadata): Promise { this.logService.debug('MainThreadNotebooks#updateNotebookCellMetadata', resource.path, handle, metadata); const textModel = this._notebookService.getNotebookTextModel(URI.from(resource)); if (!textModel) { return; } const index = textModel.cells.findIndex(cell => cell.handle === handle); if (index < 0) { return; } textModel.applyEdit(textModel.versionId, [{ editType: CellEditType.Metadata, index, metadata }], true); } async $spliceNotebookCellOutputs(viewType: string, resource: UriComponents, cellHandle: number, splices: NotebookCellOutputsSplice[]): Promise { this.logService.debug('MainThreadNotebooks#spliceNotebookCellOutputs', resource.path, cellHandle); const textModel = this._notebookService.getNotebookTextModel(URI.from(resource)); if (textModel) { this._notebookService.transformSpliceOutputs(textModel, splices); textModel._spliceNotebookCellOutputs(cellHandle, splices); } } async $postMessage(editorId: string, forRendererId: string | undefined, value: any): Promise { const editor = this._notebookService.getNotebookEditor(editorId) as INotebookEditor | undefined; if (editor?.isNotebookEditor) { editor.postMessage(forRendererId, value); return true; } return false; } $onDidEdit(resource: UriComponents, viewType: string, editId: number, label: string | undefined): void { const textModel = this._notebookService.getNotebookTextModel(URI.from(resource)); if (textModel) { textModel.handleUnknownEdit(label, () => { const isDirty = this._workingCopyService.isDirty(textModel.uri.with({ scheme: Schemas.vscodeNotebook })); return this._proxy.$undoNotebook(textModel.viewType, textModel.uri, editId, isDirty); }, () => { const isDirty = this._workingCopyService.isDirty(textModel.uri.with({ scheme: Schemas.vscodeNotebook })); return this._proxy.$redoNotebook(textModel.viewType, textModel.uri, editId, isDirty); }); } } $onContentChange(resource: UriComponents, viewType: string): void { const textModel = this._notebookService.getNotebookTextModel(URI.from(resource)); textModel?.handleUnknownChange(); } async $tryRevealRange(id: string, range: ICellRange, revealType: NotebookEditorRevealType) { const editor = this._notebookService.listNotebookEditors().find(editor => editor.getId() === id); if (editor && editor.isNotebookEditor) { const notebookEditor = editor as INotebookEditor; const viewModel = notebookEditor.viewModel; const cell = viewModel?.viewCells[range.start]; if (!cell) { return; } switch (revealType) { case NotebookEditorRevealType.Default: notebookEditor.revealInView(cell); break; case NotebookEditorRevealType.InCenter: notebookEditor.revealInCenter(cell); break; case NotebookEditorRevealType.InCenterIfOutsideViewport: notebookEditor.revealInCenterIfOutsideViewport(cell); break; default: break; } } } async $setStatusBarEntry(id: number, rawStatusBarEntry: INotebookCellStatusBarEntryDto): Promise { const statusBarEntry = { ...rawStatusBarEntry, ...{ cellResource: URI.revive(rawStatusBarEntry.cellResource) } }; const existingEntry = this._cellStatusBarEntries.get(id); if (existingEntry) { existingEntry.dispose(); } if (statusBarEntry.visible) { this._cellStatusBarEntries.set( id, this.cellStatusBarService.addEntry(statusBarEntry)); } } }