@theia/core 1.53.0-next.5 → 1.53.0-next.55

package/src/browser/tree/tree-decorator.ts

@@ -1,238 +1,238 @@
-// *****************************************************************************
-// Copyright (C) 2018 TypeFox and others.
-//
-// This program and the accompanying materials are made available under the
-// terms of the Eclipse Public License v. 2.0 which is available at
-// http://www.eclipse.org/legal/epl-2.0.
-//
-// This Source Code may also be made available under the following Secondary
-// Licenses when the conditions for such availability set forth in the Eclipse
-// Public License v. 2.0 are satisfied: GNU General Public License, version 2
-// with the GNU Classpath Exception which is available at
-// https://www.gnu.org/software/classpath/license.html.
-//
-// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
-// *****************************************************************************
-
-import { injectable } from 'inversify';
-import { Tree, TreeNode } from './tree';
-import { Event, Emitter, Disposable, DisposableCollection, MaybePromise } from '../../common';
-import { WidgetDecoration } from '../widget-decoration';
-
-/**
- * The {@link TreeDecorator} allows adapting the look and the style of the tree items within a widget. Changes are reflected in
- * the form of `decoration data`. This `decoration data` is a map storing {@link TreeDecoration.Data} for affected tree nodes (using the unique node id as key).
- * It is important to notice that there is no common contribution point for `TreeDecorators`. Instead, each {@link TreeDecoratorService} is
- * supposed to declare its own contribution provider for `TreeDecorators`.
- *
- * ### Example usage
- * A simple tree decorator that changes the background color of each tree node to `red`.
- *
- * ```typescript
- * @injectable()
- * export class MyTreeDecorator implements TreeDecorator {
- *     id = 'myTreeDecorator';
- *
- *     protected readonly emitter = new Emitter<(tree: Tree) => Map<string, TreeDecoration.Data>>();
- *
- *     get onDidChangeDecorations(): Event<(tree: Tree) => Map<string, TreeDecoration.Data>> {
- *         return this.emitter.event;
- *     }
- *
- *     decorations(tree: Tree): MaybePromise<Map<string, TreeDecoration.Data>> {
- *         const result = new Map();
- *
- *         if (tree.root === undefined) {
- *             return result;
- *         }
- *         for (const treeNode of new DepthFirstTreeIterator(tree.root)) {
- *             result.set(treeNode.id,<TreeDecoration.Data>{backgroundColor:'red'})
- *         }
- *         return result;
- *     }
- * }
- * ```
- */
-export interface TreeDecorator {
-
-    /**
-     * The unique identifier of the decorator. Ought to be unique in the application.
-     */
-    readonly id: string;
-
-    /**
-     * Fired when this decorator has calculated all the `decoration data` for the tree nodes.
-     */
-    readonly onDidChangeDecorations: Event<(tree: Tree) => Map<string, TreeDecoration.Data>>;
-
-    /**
-     * Computes the current `decoration data` for the given tree. Might return a promise if the computation is handled asynchronously.
-     *
-     * @param tree the tree to decorate.
-     *
-     * @returns (a promise of) a map containing the current {@linkTreeDecoration.Data} for each node. Keys are the unique identifier of the tree nodes.
-     */
-    decorations(tree: Tree): MaybePromise<Map<string, TreeDecoration.Data>>;
-
-}
-
-export const TreeDecoratorService = Symbol('TreeDecoratorService');
-
-/**
- * The {@link TreeDecoratorService} manages a set of known {link TreeDecorator}s and emits events when
- * any of the known decorators has changes. Typically, a `TreeDecoratorService` provides a contribution point that can be used to
- * register {@link TreeDecorator}s exclusively for this service.
- *
- * ### Example usage
- * ```typescript
- * export const MyTreeDecorator = Symbol('MyTreeDecorator');
- *
- * @injectable()
- * export class MyDecorationService extends AbstractTreeDecoratorService {
- *     constructor(@inject(ContributionProvider) @named(MyTreeDecorator) protected readonly contributions: ContributionProvider<TreeDecorator>) {
- *         super(contributions.getContributions());
- *     }
- * }
- * ```
- */
-export interface TreeDecoratorService extends Disposable {
-
-    /**
-     * Fired when any of the available tree decorators has changes.
-     */
-    readonly onDidChangeDecorations: Event<void>;
-
-    /**
-     * Computes the decorations for the tree based on the actual state of this decorator service.
-     *
-     * @param tree the tree to decorate
-     *
-     * @returns (a promise of) the computed `decoration data`
-     */
-    getDecorations(tree: Tree): MaybePromise<Map<string, TreeDecoration.Data[]>>;
-
-    /**
-     * Transforms the `decoration data` into an object, so that it can be safely serialized into JSON.
-     * @param decorations the `decoration data` that should be deflated
-     *
-     * @returns the `decoration data` as serializable JSON object
-     */
-    deflateDecorators(decorations: Map<string, TreeDecoration.Data[]>): object;
-
-    /**
-     * Counterpart of the [deflateDecorators](#deflateDecorators) method. Restores the argument into a Map
-     * of tree node IDs and the corresponding decorations data array (`decoration data`).
-     *
-     * @returns the deserialized `decoration data
-     */
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    inflateDecorators(state: any): Map<string, TreeDecoration.Data[]>;
-
-}
-
-/**
- * The default tree decorator service. Does nothing at all. One has to rebind to a concrete implementation
- * if decorators have to be supported in the tree widget.
- */
-@injectable()
-export class NoopTreeDecoratorService implements TreeDecoratorService {
-
-    protected readonly emitter = new Emitter<void>();
-    readonly onDidChangeDecorations = this.emitter.event;
-
-    dispose(): void {
-        this.emitter.dispose();
-    }
-
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    getDecorations(): Map<any, any> {
-        return new Map();
-    }
-
-    deflateDecorators(): object {
-        return {};
-    }
-
-    inflateDecorators(): Map<string, TreeDecoration.Data[]> {
-        return new Map();
-    }
-
-}
-
-/**
- * Abstract decorator service implementation which emits events from all known tree decorators and caches the current state.
- */
-@injectable()
-export abstract class AbstractTreeDecoratorService implements TreeDecoratorService {
-
-    protected readonly onDidChangeDecorationsEmitter = new Emitter<void>();
-    readonly onDidChangeDecorations = this.onDidChangeDecorationsEmitter.event;
-
-    protected readonly toDispose = new DisposableCollection();
-
-    constructor(protected readonly decorators: ReadonlyArray<TreeDecorator>) {
-        this.toDispose.push(this.onDidChangeDecorationsEmitter);
-        this.toDispose.pushAll(this.decorators.map(decorator =>
-            decorator.onDidChangeDecorations(data =>
-                this.onDidChangeDecorationsEmitter.fire(undefined)
-            ))
-        );
-    }
-
-    dispose(): void {
-        this.toDispose.dispose();
-    }
-
-    async getDecorations(tree: Tree): Promise<Map<string, TreeDecoration.Data[]>> {
-        const changes = new Map();
-        for (const decorator of this.decorators) {
-            for (const [id, data] of (await decorator.decorations(tree)).entries()) {
-                if (changes.has(id)) {
-                    changes.get(id)!.push(data);
-                } else {
-                    changes.set(id, [data]);
-                }
-            }
-        }
-        return changes;
-    }
-
-    deflateDecorators(decorations: Map<string, TreeDecoration.Data[]>): object {
-        // eslint-disable-next-line no-null/no-null
-        const state = Object.create(null);
-        for (const [id, data] of decorations) {
-            state[id] = data;
-        }
-        return state;
-    }
-
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    inflateDecorators(state: any): Map<string, TreeDecoration.Data[]> {
-        const decorators = new Map<string, TreeDecoration.Data[]>();
-        for (const id of Object.keys(state)) {
-            decorators.set(id, state[id]);
-        }
-        return decorators;
-    }
-
-}
-
-/**
- * @deprecated import from `@theia/core/lib/browser/widget-decoration` instead.
- */
-export import TreeDecoration = WidgetDecoration;
-
-export interface DecoratedTreeNode extends TreeNode {
-    /**
-     * The additional tree decoration data attached to the tree node itself.
-     */
-    readonly decorationData: TreeDecoration.Data;
-}
-export namespace DecoratedTreeNode {
-    /**
-     * Type-guard for decorated tree nodes.
-     */
-    export function is(node: TreeNode | undefined): node is DecoratedTreeNode {
-        return !!node && 'decorationData' in node;
-    }
-}
+// *****************************************************************************
+// Copyright (C) 2018 TypeFox and others.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Eclipse Public License v. 2.0 which is available at
+// http://www.eclipse.org/legal/epl-2.0.
+//
+// This Source Code may also be made available under the following Secondary
+// Licenses when the conditions for such availability set forth in the Eclipse
+// Public License v. 2.0 are satisfied: GNU General Public License, version 2
+// with the GNU Classpath Exception which is available at
+// https://www.gnu.org/software/classpath/license.html.
+//
+// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
+// *****************************************************************************
+
+import { injectable } from 'inversify';
+import { Tree, TreeNode } from './tree';
+import { Event, Emitter, Disposable, DisposableCollection, MaybePromise } from '../../common';
+import { WidgetDecoration } from '../widget-decoration';
+
+/**
+ * The {@link TreeDecorator} allows adapting the look and the style of the tree items within a widget. Changes are reflected in
+ * the form of `decoration data`. This `decoration data` is a map storing {@link TreeDecoration.Data} for affected tree nodes (using the unique node id as key).
+ * It is important to notice that there is no common contribution point for `TreeDecorators`. Instead, each {@link TreeDecoratorService} is
+ * supposed to declare its own contribution provider for `TreeDecorators`.
+ *
+ * ### Example usage
+ * A simple tree decorator that changes the background color of each tree node to `red`.
+ *
+ * ```typescript
+ * @injectable()
+ * export class MyTreeDecorator implements TreeDecorator {
+ *     id = 'myTreeDecorator';
+ *
+ *     protected readonly emitter = new Emitter<(tree: Tree) => Map<string, TreeDecoration.Data>>();
+ *
+ *     get onDidChangeDecorations(): Event<(tree: Tree) => Map<string, TreeDecoration.Data>> {
+ *         return this.emitter.event;
+ *     }
+ *
+ *     decorations(tree: Tree): MaybePromise<Map<string, TreeDecoration.Data>> {
+ *         const result = new Map();
+ *
+ *         if (tree.root === undefined) {
+ *             return result;
+ *         }
+ *         for (const treeNode of new DepthFirstTreeIterator(tree.root)) {
+ *             result.set(treeNode.id,<TreeDecoration.Data>{backgroundColor:'red'})
+ *         }
+ *         return result;
+ *     }
+ * }
+ * ```
+ */
+export interface TreeDecorator {
+
+    /**
+     * The unique identifier of the decorator. Ought to be unique in the application.
+     */
+    readonly id: string;
+
+    /**
+     * Fired when this decorator has calculated all the `decoration data` for the tree nodes.
+     */
+    readonly onDidChangeDecorations: Event<(tree: Tree) => Map<string, TreeDecoration.Data>>;
+
+    /**
+     * Computes the current `decoration data` for the given tree. Might return a promise if the computation is handled asynchronously.
+     *
+     * @param tree the tree to decorate.
+     *
+     * @returns (a promise of) a map containing the current {@linkTreeDecoration.Data} for each node. Keys are the unique identifier of the tree nodes.
+     */
+    decorations(tree: Tree): MaybePromise<Map<string, TreeDecoration.Data>>;
+
+}
+
+export const TreeDecoratorService = Symbol('TreeDecoratorService');
+
+/**
+ * The {@link TreeDecoratorService} manages a set of known {link TreeDecorator}s and emits events when
+ * any of the known decorators has changes. Typically, a `TreeDecoratorService` provides a contribution point that can be used to
+ * register {@link TreeDecorator}s exclusively for this service.
+ *
+ * ### Example usage
+ * ```typescript
+ * export const MyTreeDecorator = Symbol('MyTreeDecorator');
+ *
+ * @injectable()
+ * export class MyDecorationService extends AbstractTreeDecoratorService {
+ *     constructor(@inject(ContributionProvider) @named(MyTreeDecorator) protected readonly contributions: ContributionProvider<TreeDecorator>) {
+ *         super(contributions.getContributions());
+ *     }
+ * }
+ * ```
+ */
+export interface TreeDecoratorService extends Disposable {
+
+    /**
+     * Fired when any of the available tree decorators has changes.
+     */
+    readonly onDidChangeDecorations: Event<void>;
+
+    /**
+     * Computes the decorations for the tree based on the actual state of this decorator service.
+     *
+     * @param tree the tree to decorate
+     *
+     * @returns (a promise of) the computed `decoration data`
+     */
+    getDecorations(tree: Tree): MaybePromise<Map<string, TreeDecoration.Data[]>>;
+
+    /**
+     * Transforms the `decoration data` into an object, so that it can be safely serialized into JSON.
+     * @param decorations the `decoration data` that should be deflated
+     *
+     * @returns the `decoration data` as serializable JSON object
+     */
+    deflateDecorators(decorations: Map<string, TreeDecoration.Data[]>): object;
+
+    /**
+     * Counterpart of the [deflateDecorators](#deflateDecorators) method. Restores the argument into a Map
+     * of tree node IDs and the corresponding decorations data array (`decoration data`).
+     *
+     * @returns the deserialized `decoration data
+     */
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    inflateDecorators(state: any): Map<string, TreeDecoration.Data[]>;
+
+}
+
+/**
+ * The default tree decorator service. Does nothing at all. One has to rebind to a concrete implementation
+ * if decorators have to be supported in the tree widget.
+ */
+@injectable()
+export class NoopTreeDecoratorService implements TreeDecoratorService {
+
+    protected readonly emitter = new Emitter<void>();
+    readonly onDidChangeDecorations = this.emitter.event;
+
+    dispose(): void {
+        this.emitter.dispose();
+    }
+
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    getDecorations(): Map<any, any> {
+        return new Map();
+    }
+
+    deflateDecorators(): object {
+        return {};
+    }
+
+    inflateDecorators(): Map<string, TreeDecoration.Data[]> {
+        return new Map();
+    }
+
+}
+
+/**
+ * Abstract decorator service implementation which emits events from all known tree decorators and caches the current state.
+ */
+@injectable()
+export abstract class AbstractTreeDecoratorService implements TreeDecoratorService {
+
+    protected readonly onDidChangeDecorationsEmitter = new Emitter<void>();
+    readonly onDidChangeDecorations = this.onDidChangeDecorationsEmitter.event;
+
+    protected readonly toDispose = new DisposableCollection();
+
+    constructor(protected readonly decorators: ReadonlyArray<TreeDecorator>) {
+        this.toDispose.push(this.onDidChangeDecorationsEmitter);
+        this.toDispose.pushAll(this.decorators.map(decorator =>
+            decorator.onDidChangeDecorations(data =>
+                this.onDidChangeDecorationsEmitter.fire(undefined)
+            ))
+        );
+    }
+
+    dispose(): void {
+        this.toDispose.dispose();
+    }
+
+    async getDecorations(tree: Tree): Promise<Map<string, TreeDecoration.Data[]>> {
+        const changes = new Map();
+        for (const decorator of this.decorators) {
+            for (const [id, data] of (await decorator.decorations(tree)).entries()) {
+                if (changes.has(id)) {
+                    changes.get(id)!.push(data);
+                } else {
+                    changes.set(id, [data]);
+                }
+            }
+        }
+        return changes;
+    }
+
+    deflateDecorators(decorations: Map<string, TreeDecoration.Data[]>): object {
+        // eslint-disable-next-line no-null/no-null
+        const state = Object.create(null);
+        for (const [id, data] of decorations) {
+            state[id] = data;
+        }
+        return state;
+    }
+
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    inflateDecorators(state: any): Map<string, TreeDecoration.Data[]> {
+        const decorators = new Map<string, TreeDecoration.Data[]>();
+        for (const id of Object.keys(state)) {
+            decorators.set(id, state[id]);
+        }
+        return decorators;
+    }
+
+}
+
+/**
+ * @deprecated import from `@theia/core/lib/browser/widget-decoration` instead.
+ */
+export import TreeDecoration = WidgetDecoration;
+
+export interface DecoratedTreeNode extends TreeNode {
+    /**
+     * The additional tree decoration data attached to the tree node itself.
+     */
+    readonly decorationData: TreeDecoration.Data;
+}
+export namespace DecoratedTreeNode {
+    /**
+     * Type-guard for decorated tree nodes.
+     */
+    export function is(node: TreeNode | undefined): node is DecoratedTreeNode {
+        return !!node && 'decorationData' in node;
+    }
+}