/*--------------------------------------------------------------------------------------------- * Copyright (c) Microsoft Corporation. All rights reserved. * Licensed under the MIT License. See License.txt in the project root for license information. *--------------------------------------------------------------------------------------------*/ import { Disposable } from 'vs/base/common/lifecycle'; import { ExtHostContext, MainThreadTreeViewsShape, ExtHostTreeViewsShape, MainContext, CheckboxUpdate } from 'vs/workbench/api/common/extHost.protocol'; import { ITreeViewDataProvider, ITreeItem, IViewsService, ITreeView, IViewsRegistry, ITreeViewDescriptor, IRevealOptions, Extensions, ResolvableTreeItem, ITreeViewDragAndDropController, IViewBadge, NoTreeViewError } from 'vs/workbench/common/views'; import { extHostNamedCustomer, IExtHostContext } from 'vs/workbench/services/extensions/common/extHostCustomers'; import { distinct } from 'vs/base/common/arrays'; import { INotificationService } from 'vs/platform/notification/common/notification'; import { isUndefinedOrNull, isNumber } from 'vs/base/common/types'; import { Registry } from 'vs/platform/registry/common/platform'; import { IExtensionService } from 'vs/workbench/services/extensions/common/extensions'; import { ILogService } from 'vs/platform/log/common/log'; import { CancellationToken } from 'vs/base/common/cancellation'; import { createStringDataTransferItem, VSDataTransfer } from 'vs/base/common/dataTransfer'; import { VSBuffer } from 'vs/base/common/buffer'; import { DataTransferFileCache } from 'vs/workbench/api/common/shared/dataTransferCache'; import * as typeConvert from 'vs/workbench/api/common/extHostTypeConverters'; @extHostNamedCustomer(MainContext.MainThreadTreeViews) export class MainThreadTreeViews extends Disposable implements MainThreadTreeViewsShape { private readonly _proxy: ExtHostTreeViewsShape; private readonly _dataProviders: Map = new Map(); private readonly _dndControllers = new Map(); constructor( extHostContext: IExtHostContext, @IViewsService private readonly viewsService: IViewsService, @INotificationService private readonly notificationService: INotificationService, @IExtensionService private readonly extensionService: IExtensionService, @ILogService private readonly logService: ILogService ) { super(); this._proxy = extHostContext.getProxy(ExtHostContext.ExtHostTreeViews); } async $registerTreeViewDataProvider(treeViewId: string, options: { showCollapseAll: boolean; canSelectMany: boolean; dropMimeTypes: string[]; dragMimeTypes: string[]; hasHandleDrag: boolean; hasHandleDrop: boolean; manuallyManageCheckboxes: boolean }): Promise { this.logService.trace('MainThreadTreeViews#$registerTreeViewDataProvider', treeViewId, options); this.extensionService.whenInstalledExtensionsRegistered().then(() => { const dataProvider = new TreeViewDataProvider(treeViewId, this._proxy, this.notificationService); this._dataProviders.set(treeViewId, dataProvider); const dndController = (options.hasHandleDrag || options.hasHandleDrop) ? new TreeViewDragAndDropController(treeViewId, options.dropMimeTypes, options.dragMimeTypes, options.hasHandleDrag, this._proxy) : undefined; const viewer = this.getTreeView(treeViewId); if (viewer) { // Order is important here. The internal tree isn't created until the dataProvider is set. // Set all other properties first! viewer.showCollapseAllAction = options.showCollapseAll; viewer.canSelectMany = options.canSelectMany; viewer.manuallyManageCheckboxes = options.manuallyManageCheckboxes; viewer.dragAndDropController = dndController; if (dndController) { this._dndControllers.set(treeViewId, dndController); } viewer.dataProvider = dataProvider; this.registerListeners(treeViewId, viewer); this._proxy.$setVisible(treeViewId, viewer.visible); } else { this.notificationService.error('No view is registered with id: ' + treeViewId); } }); } $reveal(treeViewId: string, itemInfo: { item: ITreeItem; parentChain: ITreeItem[] } | undefined, options: IRevealOptions): Promise { this.logService.trace('MainThreadTreeViews#$reveal', treeViewId, itemInfo?.item, itemInfo?.parentChain, options); return this.viewsService.openView(treeViewId, options.focus) .then(() => { const viewer = this.getTreeView(treeViewId); if (viewer && itemInfo) { return this.reveal(viewer, this._dataProviders.get(treeViewId)!, itemInfo.item, itemInfo.parentChain, options); } return undefined; }); } $refresh(treeViewId: string, itemsToRefreshByHandle: { [treeItemHandle: string]: ITreeItem }): Promise { this.logService.trace('MainThreadTreeViews#$refresh', treeViewId, itemsToRefreshByHandle); const viewer = this.getTreeView(treeViewId); const dataProvider = this._dataProviders.get(treeViewId); if (viewer && dataProvider) { const itemsToRefresh = dataProvider.getItemsToRefresh(itemsToRefreshByHandle); return viewer.refresh(itemsToRefresh.length ? itemsToRefresh : undefined); } return Promise.resolve(); } $setMessage(treeViewId: string, message: string): void { this.logService.trace('MainThreadTreeViews#$setMessage', treeViewId, message); const viewer = this.getTreeView(treeViewId); if (viewer) { viewer.message = message; } } $setTitle(treeViewId: string, title: string, description: string | undefined): void { this.logService.trace('MainThreadTreeViews#$setTitle', treeViewId, title, description); const viewer = this.getTreeView(treeViewId); if (viewer) { viewer.title = title; viewer.description = description; } } $setBadge(treeViewId: string, badge: IViewBadge | undefined): void { this.logService.trace('MainThreadTreeViews#$setBadge', treeViewId, badge?.value, badge?.tooltip); const viewer = this.getTreeView(treeViewId); if (viewer) { viewer.badge = badge; } } $resolveDropFileData(destinationViewId: string, requestId: number, dataItemId: string): Promise { const controller = this._dndControllers.get(destinationViewId); if (!controller) { throw new Error('Unknown tree'); } return controller.resolveDropFileData(requestId, dataItemId); } public async $disposeTree(treeViewId: string): Promise { const viewer = this.getTreeView(treeViewId); if (viewer) { viewer.dataProvider = undefined; } } private async reveal(treeView: ITreeView, dataProvider: TreeViewDataProvider, itemIn: ITreeItem, parentChain: ITreeItem[], options: IRevealOptions): Promise { options = options ? options : { select: false, focus: false }; const select = isUndefinedOrNull(options.select) ? false : options.select; const focus = isUndefinedOrNull(options.focus) ? false : options.focus; let expand = Math.min(isNumber(options.expand) ? options.expand : options.expand === true ? 1 : 0, 3); if (dataProvider.isEmpty()) { // Refresh if empty await treeView.refresh(); } for (const parent of parentChain) { const parentItem = dataProvider.getItem(parent.handle); if (parentItem) { await treeView.expand(parentItem); } } const item = dataProvider.getItem(itemIn.handle); if (item) { await treeView.reveal(item); if (select) { treeView.setSelection([item]); } if (focus === false) { treeView.setFocus(); } else if (focus) { treeView.setFocus(item); } let itemsToExpand = [item]; for (; itemsToExpand.length > 0 && expand > 0; expand--) { await treeView.expand(itemsToExpand); itemsToExpand = itemsToExpand.reduce((result, itemValue) => { const item = dataProvider.getItem(itemValue.handle); if (item && item.children && item.children.length) { result.push(...item.children); } return result; }, [] as ITreeItem[]); } } } private registerListeners(treeViewId: string, treeView: ITreeView): void { this._register(treeView.onDidExpandItem(item => this._proxy.$setExpanded(treeViewId, item.handle, true))); this._register(treeView.onDidCollapseItem(item => this._proxy.$setExpanded(treeViewId, item.handle, false))); this._register(treeView.onDidChangeSelectionAndFocus(items => this._proxy.$setSelectionAndFocus(treeViewId, items.selection.map(({ handle }) => handle), items.focus.handle))); this._register(treeView.onDidChangeVisibility(isVisible => this._proxy.$setVisible(treeViewId, isVisible))); this._register(treeView.onDidChangeCheckboxState(items => { this._proxy.$changeCheckboxState(treeViewId, items.map(item => { return { treeItemHandle: item.handle, newState: item.checkbox?.isChecked ?? false }; })); })); } private getTreeView(treeViewId: string): ITreeView | null { const viewDescriptor: ITreeViewDescriptor = Registry.as(Extensions.ViewsRegistry).getView(treeViewId); return viewDescriptor ? viewDescriptor.treeView : null; } override dispose(): void { this._dataProviders.forEach((dataProvider, treeViewId) => { const treeView = this.getTreeView(treeViewId); if (treeView) { treeView.dataProvider = undefined; } }); this._dataProviders.clear(); this._dndControllers.clear(); super.dispose(); } } type TreeItemHandle = string; class TreeViewDragAndDropController implements ITreeViewDragAndDropController { private readonly dataTransfersCache = new DataTransferFileCache(); constructor(private readonly treeViewId: string, readonly dropMimeTypes: string[], readonly dragMimeTypes: string[], readonly hasWillDrop: boolean, private readonly _proxy: ExtHostTreeViewsShape) { } async handleDrop(dataTransfer: VSDataTransfer, targetTreeItem: ITreeItem | undefined, token: CancellationToken, operationUuid?: string, sourceTreeId?: string, sourceTreeItemHandles?: string[]): Promise { const request = this.dataTransfersCache.add(dataTransfer); try { const dataTransferDto = await typeConvert.DataTransfer.from(dataTransfer); if (token.isCancellationRequested) { return; } return await this._proxy.$handleDrop(this.treeViewId, request.id, dataTransferDto, targetTreeItem?.handle, token, operationUuid, sourceTreeId, sourceTreeItemHandles); } finally { request.dispose(); } } async handleDrag(sourceTreeItemHandles: string[], operationUuid: string, token: CancellationToken): Promise { if (!this.hasWillDrop) { return; } const additionalDataTransferDTO = await this._proxy.$handleDrag(this.treeViewId, sourceTreeItemHandles, operationUuid, token); if (!additionalDataTransferDTO) { return; } const additionalDataTransfer = new VSDataTransfer(); additionalDataTransferDTO.items.forEach(([type, item]) => { additionalDataTransfer.replace(type, createStringDataTransferItem(item.asString)); }); return additionalDataTransfer; } public resolveDropFileData(requestId: number, dataItemId: string): Promise { return this.dataTransfersCache.resolveFileData(requestId, dataItemId); } } class TreeViewDataProvider implements ITreeViewDataProvider { private readonly itemsMap: Map = new Map(); private hasResolve: Promise; constructor(private readonly treeViewId: string, private readonly _proxy: ExtHostTreeViewsShape, private readonly notificationService: INotificationService ) { this.hasResolve = this._proxy.$hasResolve(this.treeViewId); } getChildren(treeItem?: ITreeItem): Promise { return this._proxy.$getChildren(this.treeViewId, treeItem ? treeItem.handle : undefined) .then( children => this.postGetChildren(children), err => { // It can happen that a tree view is disposed right as `getChildren` is called. This results in an error because the data provider gets removed. // The tree will shortly get cleaned up in this case. We just need to handle the error here. if (!NoTreeViewError.is(err)) { this.notificationService.error(err); } return []; }); } getItemsToRefresh(itemsToRefreshByHandle: { [treeItemHandle: string]: ITreeItem }): ITreeItem[] { const itemsToRefresh: ITreeItem[] = []; if (itemsToRefreshByHandle) { for (const treeItemHandle of Object.keys(itemsToRefreshByHandle)) { const currentTreeItem = this.getItem(treeItemHandle); if (currentTreeItem) { // Refresh only if the item exists const treeItem = itemsToRefreshByHandle[treeItemHandle]; // Update the current item with refreshed item this.updateTreeItem(currentTreeItem, treeItem); if (treeItemHandle === treeItem.handle) { itemsToRefresh.push(currentTreeItem); } else { // Update maps when handle is changed and refresh parent this.itemsMap.delete(treeItemHandle); this.itemsMap.set(currentTreeItem.handle, currentTreeItem); const parent = treeItem.parentHandle ? this.itemsMap.get(treeItem.parentHandle) : null; if (parent) { itemsToRefresh.push(parent); } } } } } return itemsToRefresh; } getItem(treeItemHandle: string): ITreeItem | undefined { return this.itemsMap.get(treeItemHandle); } isEmpty(): boolean { return this.itemsMap.size === 0; } private async postGetChildren(elements: ITreeItem[] | undefined): Promise { if (elements === undefined) { return undefined; } const result: ResolvableTreeItem[] = []; const hasResolve = await this.hasResolve; if (elements) { for (const element of elements) { const resolvable = new ResolvableTreeItem(element, hasResolve ? (token) => { return this._proxy.$resolve(this.treeViewId, element.handle, token); } : undefined); this.itemsMap.set(element.handle, resolvable); result.push(resolvable); } } return result; } private updateTreeItem(current: ITreeItem, treeItem: ITreeItem): void { treeItem.children = treeItem.children ? treeItem.children : undefined; if (current) { const properties = distinct([...Object.keys(current instanceof ResolvableTreeItem ? current.asTreeItem() : current), ...Object.keys(treeItem)]); for (const property of properties) { (current)[property] = (treeItem)[property]; } if (current instanceof ResolvableTreeItem) { current.resetResolve(); } } } }