Tree decorators infrastructure created

A first example is also included: gitStatusTreeDecorator Resolves #5866 Related #211
microsoft · Jul 3, 2016 · b47ebd3 · b47ebd3
1 parent 4e72dcc
commit b47ebd3
Show file tree

Hide file tree

Showing 12 changed files with 308 additions and 12 deletions.
diff --git a/src/vs/base/parts/tree/browser/tree.ts b/src/vs/base/parts/tree/browser/tree.ts
@@ -12,6 +12,12 @@ import Keyboard = require('vs/base/browser/keyboardEvent');
 import { INavigator } from 'vs/base/common/iterator';
 import { ScrollbarVisibility } from 'vs/base/browser/ui/scrollbar/scrollableElementOptions';
 
+export interface IRow {
+	element: HTMLElement;
+	templateId: string;
+	templateData: any;
+}
+
 export interface ITree extends Events.IEventEmitter {
 
 	emit(eventType:string, data?:any):void;
@@ -355,6 +361,12 @@ export interface IDataSource {
 	getParent(tree: ITree, element: any): WinJS.Promise;
 }
 
+export interface IDecorator {
+	onActivate(tree: ITree): void;
+	decorate(tree: ITree, element: any, templateId: string, row: IRow): void;
+	dispose(): void;
+}
+
 export interface IRenderer {
 
 	/**
@@ -614,6 +626,7 @@ export interface IHighlightEvent {
 export interface ITreeConfiguration {
 	dataSource: IDataSource;
 	renderer?: IRenderer;
+	decorator?: IDecorator;
 	controller?: IController;
 	dnd?: IDragAndDrop;
 	filter?: IFilter;

diff --git a/src/vs/base/parts/tree/browser/treeImpl.ts b/src/vs/base/parts/tree/browser/treeImpl.ts
@@ -22,6 +22,7 @@ export class TreeContext implements _.ITreeContext {
 	public dataSource:_.IDataSource;
 	public renderer:_.IRenderer;
 	public controller:_.IController;
+	public decorator:_.IDecorator;
 	public dnd:_.IDragAndDrop;
 	public filter:_.IFilter;
 	public sorter:_.ISorter;
@@ -42,7 +43,12 @@ export class TreeContext implements _.ITreeContext {
 		this.dnd = configuration.dnd || new TreeDefaults.DefaultDragAndDrop();
 		this.filter = configuration.filter || new TreeDefaults.DefaultFilter();
 		this.sorter = configuration.sorter || null;
+		this.decorator = configuration.decorator || null;
 		this.accessibilityProvider = configuration.accessibilityProvider || new TreeDefaults.DefaultAccessibilityProvider();
+
+		if (this.decorator) {
+			this.decorator.onActivate(tree);
+		}
 	}
 }
 
@@ -327,6 +333,9 @@ export class Tree extends Events.EventEmitter implements _.ITree {
 			this.view.dispose();
 			this.view = null;
 		}
+		if (this.context.decorator !== null) {
+			this.context.decorator.dispose();
+		}
 
 		super.dispose();
 	}

diff --git a/src/vs/base/parts/tree/browser/treeView.ts b/src/vs/base/parts/tree/browser/treeView.ts
@@ -24,12 +24,6 @@ import _ = require('vs/base/parts/tree/browser/tree');
 import { IViewItem } from 'vs/base/parts/tree/browser/treeViewModel';
 import {KeyCode} from 'vs/base/common/keyCodes';
 
-export interface IRow {
-	element: HTMLElement;
-	templateId: string;
-	templateData: any;
-}
-
 function getLastScrollTime(element: HTMLElement): number {
 	var value = element.getAttribute('last-scroll-time');
 	return value ? parseInt(value, 10) : 0;
@@ -45,15 +39,15 @@ function removeFromParent(element: HTMLElement): void {
 
 export class RowCache implements Lifecycle.IDisposable {
 
-	private _cache: { [templateId:string]: IRow[]; };
-	private scrollingRow: IRow;
+	private _cache: { [templateId:string]: _.IRow[]; };
+	private scrollingRow: _.IRow;
 
 	constructor(private context: _.ITreeContext) {
 		this._cache = { '': [] };
 		this.scrollingRow = null;
 	}
 
-	public alloc(templateId: string): IRow {
+	public alloc(templateId: string): _.IRow {
 		var result = this.cache(templateId).pop();
 
 		if (!result) {
@@ -73,7 +67,7 @@ export class RowCache implements Lifecycle.IDisposable {
 		return result;
 	}
 
-	public release(templateId: string, row: IRow): void {
+	public release(templateId: string, row: _.IRow): void {
 		var lastScrollTime = getLastScrollTime(row.element);
 
 		if (!lastScrollTime) {
@@ -102,7 +96,7 @@ export class RowCache implements Lifecycle.IDisposable {
 		DOM.addClass(this.scrollingRow.element, 'scrolling');
 	}
 
-	private cache(templateId: string): IRow[] {
+	private cache(templateId: string): _.IRow[] {
 		return this._cache[templateId] || (this._cache[templateId] = []);
 	}
 
@@ -142,7 +136,7 @@ export class ViewItem implements IViewItem {
 
 	public model: Model.Item;
 	public id: string;
-	protected row: IRow;
+	protected row: _.IRow;
 
 	public top: number;
 	public height: number;
@@ -284,6 +278,9 @@ export class ViewItem implements IViewItem {
 
 		if (!skipUserRender) {
 			this.context.renderer.renderElement(this.context.tree, this.model.getElement(), this.templateId, this.row.templateData);
+			if (this.context.decorator) {
+				this.context.decorator.decorate(this.context.tree, this.model.getElement(), this.templateId, this.row);
+			}
 		}
 	}
 
@@ -451,6 +448,7 @@ export class TreeView extends HeightMap {
 			filter: context.filter,
 			sorter: context.sorter,
 			tree: context.tree,
+			decorator: context.decorator,
 			accessibilityProvider: context.accessibilityProvider,
 			options: context.options,
 			cache: new RowCache(context)

diff --git a/src/vs/workbench/browser/workbench.ts b/src/vs/workbench/browser/workbench.ts
@@ -22,6 +22,7 @@ import {Identifiers} from 'vs/workbench/common/constants';
 import {isWindows, isLinux} from 'vs/base/common/platform';
 import {IOptions} from 'vs/workbench/common/options';
 import {IWorkbenchContributionsRegistry, Extensions as WorkbenchExtensions} from 'vs/workbench/common/contributions';
+import {IDecoratorRegistry, Extensions as DecoratorExtensions} from 'vs/workbench/parts/decorators/decoratorRegistry';
 import {IEditorRegistry, Extensions as EditorExtensions, BaseEditor} from 'vs/workbench/browser/parts/editor/baseEditor';
 import {TextEditorOptions, EditorInput, EditorOptions} from 'vs/workbench/common/editor';
 import {Part} from 'vs/workbench/browser/part';
@@ -397,6 +398,7 @@ export class Workbench implements IPartService {
 		<IActionBarRegistry>Registry.as(ActionBarExtensions.Actionbar).setInstantiationService(this.instantiationService);
 		<IWorkbenchContributionsRegistry>Registry.as(WorkbenchExtensions.Workbench).setInstantiationService(this.instantiationService);
 		<IEditorRegistry>Registry.as(EditorExtensions.Editors).setInstantiationService(this.instantiationService);
+		<IDecoratorRegistry>Registry.as(DecoratorExtensions.Decorators).setInstantiationService(this.instantiationService);
 	}
 
 	private initSettings(): void {

diff --git a/src/vs/workbench/parts/decorators/decoratorRegistry.ts b/src/vs/workbench/parts/decorators/decoratorRegistry.ts
@@ -0,0 +1,46 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+'use strict';
+
+import {Registry, BaseRegistry} from 'vs/platform/platform';
+import {IConstructorSignature0} from 'vs/platform/instantiation/common/instantiation';
+import tree = require('vs/base/parts/tree/browser/tree');
+
+export namespace Extensions {
+	export const Decorators = 'decorator.contributions.kind';
+}
+
+export type IDecoratorSignature = IConstructorSignature0<tree.IDecorator>;
+
+export interface IDecoratorRegistry {
+
+	/**
+	 * Registers a decorator to the platform that will be loaded when the workbench starts and disposed when
+	 * the workbench shuts down.
+	 */
+	registerDecorator(decorator: IDecoratorSignature): void;
+
+	/**
+	 * Returns all decorators that are known to the platform.
+	 */
+	getDecorators(): tree.IDecorator[];
+}
+
+class DecorationsRegistry extends BaseRegistry<tree.IDecorator> implements IDecoratorRegistry {
+
+	public registerDecorator(ctor: IDecoratorSignature): void {
+		super._register(ctor);
+	}
+
+	public getDecorators(): tree.IDecorator[] {
+		return super._getInstances();
+	}
+
+	public setDecorators(contributions: tree.IDecorator[]): void {
+		super._setInstances(contributions);
+	}
+}
+
+Registry.add(Extensions.Decorators, new DecorationsRegistry());
diff --git a/src/vs/workbench/parts/decorators/treeDecorator.ts b/src/vs/workbench/parts/decorators/treeDecorator.ts
@@ -0,0 +1,31 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+'use strict';
+import tree = require('vs/base/parts/tree/browser/tree');
+import lifecycle = require('vs/base/common/lifecycle');
+import {Registry} from 'vs/platform/platform';
+import {IDecoratorRegistry, Extensions as DecoratorExtensions} from 'vs/workbench/parts/decorators/decoratorRegistry';
+
+export class TreeDecorator implements tree.IDecorator {
+
+	protected decorators: tree.IDecorator[] = [];
+	protected toDispose: lifecycle.IDisposable[] = [];
+	constructor() {
+	}
+
+	public onActivate(tree: tree.ITree): void {
+		this.decorators = Registry.as<IDecoratorRegistry>(DecoratorExtensions.Decorators).getDecorators();
+		this.decorators.forEach(decorator=>decorator.onActivate(tree));
+	}
+
+	public decorate(tree: tree.ITree, element: any, templateId: string, row: tree.IRow): void {
+		this.decorators.forEach(decorator=>decorator.decorate(tree,element,templateId, row));
+	}
+
+	public dispose(): void {
+		this.decorators.forEach(decorator => decorator.dispose());
+		this.toDispose.forEach(item => item.dispose());
+	}
+}
diff --git a/src/vs/workbench/parts/files/browser/views/explorerView.ts b/src/vs/workbench/parts/files/browser/views/explorerView.ts
@@ -15,6 +15,7 @@ import paths = require('vs/base/common/paths');
 import {Action, IActionRunner, IAction} from 'vs/base/common/actions';
 import {prepareActions} from 'vs/workbench/browser/actionBarRegistry';
 import {ITree} from 'vs/base/parts/tree/browser/tree';
+import {TreeDecorator} from 'vs/workbench/parts/decorators/treeDecorator';
 import {Tree} from 'vs/base/parts/tree/browser/treeImpl';
 import {EditorOptions} from 'vs/workbench/common/editor';
 import {LocalFileChangeEvent, IFilesConfiguration} from 'vs/workbench/parts/files/common/files';
@@ -330,6 +331,7 @@ export class ExplorerView extends CollapsibleViewletView {
 		let dataSource = this.instantiationService.createInstance(FileDataSource);
 		let renderer = this.instantiationService.createInstance(FileRenderer, this.viewletState, this.actionRunner);
 		let controller = this.instantiationService.createInstance(FileController, this.viewletState);
+		let decorator = this.instantiationService.createInstance(TreeDecorator);
 		let sorter = new FileSorter();
 		this.filter = this.instantiationService.createInstance(FileFilter);
 		let dnd = this.instantiationService.createInstance(FileDragAndDrop);
@@ -340,6 +342,7 @@ export class ExplorerView extends CollapsibleViewletView {
 			renderer: renderer,
 			controller: controller,
 			sorter: sorter,
+			decorator: decorator,
 			filter: this.filter,
 			dnd: dnd,
 			accessibilityProvider: accessibility

diff --git a/src/vs/workbench/parts/files/browser/views/explorerViewer.ts b/src/vs/workbench/parts/files/browser/views/explorerViewer.ts
@@ -261,6 +261,7 @@ export class FileRenderer extends ActionsRenderer implements IRenderer {
 	constructor(
 		state: FileViewletState,
 		actionRunner: IActionRunner,
+		@IWorkspaceContextService private contextService: IWorkspaceContextService,
 		@IContextViewService private contextViewService: IContextViewService
 	) {
 		super({

diff --git a/src/vs/workbench/parts/files/browser/views/openEditorsView.ts b/src/vs/workbench/parts/files/browser/views/openEditorsView.ts
@@ -11,6 +11,7 @@ import {IAction, IActionRunner} from 'vs/base/common/actions';
 import dom = require('vs/base/browser/dom');
 import {CollapsibleState} from 'vs/base/browser/ui/splitview/splitview';
 import {Tree} from 'vs/base/parts/tree/browser/treeImpl';
+import {TreeDecorator} from 'vs/workbench/parts/decorators/treeDecorator';
 import {IContextMenuService} from 'vs/platform/contextview/browser/contextView';
 import {IMessageService} from 'vs/platform/message/common/message';
 import {IInstantiationService} from 'vs/platform/instantiation/common/instantiation';
@@ -93,13 +94,15 @@ export class OpenEditorsView extends AdaptiveCollapsibleViewletView {
 		const dataSource = this.instantiationService.createInstance(DataSource);
 		const actionProvider = this.instantiationService.createInstance(ActionProvider, this.model);
 		const renderer = this.instantiationService.createInstance(Renderer, actionProvider, this.model);
+		const decorator = this.instantiationService.createInstance(TreeDecorator);
 		const controller = this.instantiationService.createInstance(Controller, actionProvider, this.model);
 		const accessibilityProvider = this.instantiationService.createInstance(AccessibilityProvider);
 		const dnd = this.instantiationService.createInstance(DragAndDrop);
 
 		this.tree = new Tree(this.treeContainer, {
 			dataSource,
 			renderer,
+			decorator,
 			controller,
 			accessibilityProvider,
 			dnd