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

package/src/browser/context-key-service.ts

@@ -1,142 +1,142 @@
-// *****************************************************************************
-// Copyright (C) 2019 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 { Emitter, Event } from '../common/event';
-
-export type ContextKeyValue = null | undefined | boolean | number | string
-    | Array<null | undefined | boolean | number | string>
-    | Record<string, null | undefined | boolean | number | string>;
-
-export interface ContextKey<T extends ContextKeyValue = ContextKeyValue> {
-    set(value: T | undefined): void;
-    reset(): void;
-    get(): T | undefined;
-}
-
-export namespace ContextKey {
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    export const None: ContextKey<any> = Object.freeze({
-        set: () => { },
-        reset: () => { },
-        get: () => undefined
-    });
-}
-
-export interface ContextKeyChangeEvent {
-    affects(keys: { has(key: string): boolean }): boolean;
-}
-
-export const ContextKeyService = Symbol('ContextKeyService');
-
-export interface ContextMatcher {
-    /**
-     * Whether the expression is satisfied. If `context` provided, the service will attempt to retrieve a context object associated with that element.
-     */
-    match(expression: string, context?: HTMLElement): boolean;
-}
-
-export interface ContextKeyService extends ContextMatcher {
-    readonly onDidChange: Event<ContextKeyChangeEvent>;
-
-    createKey<T extends ContextKeyValue>(key: string, defaultValue: T | undefined): ContextKey<T>;
-
-    /**
-     * @returns a Set of the keys used by the given `expression` or `undefined` if none are used or the expression cannot be parsed.
-     */
-    parseKeys(expression: string): Set<string> | undefined;
-
-    /**
-     * Creates a temporary context that will use the `values` passed in when evaluating {@link callback}.
-     * {@link callback | The callback} must be synchronous.
-     */
-    with<T>(values: Record<string, unknown>, callback: () => T): T;
-
-    /**
-     * Creates a child service with a separate context scoped to the HTML element passed in.
-     * Useful for e.g. setting the {view} context value for particular widgets.
-     */
-    createScoped(target: HTMLElement): ScopedValueStore;
-
-    /**
-     * @param overlay values to be used in the new {@link ContextKeyService}. These values will be static.
-     * Creates a child service with a separate context and a set of fixed values to override parent values.
-     */
-    createOverlay(overlay: Iterable<[string, unknown]>): ContextMatcher;
-
-    /**
-     * Set or modify a value in the service's context.
-     */
-    setContext(key: string, value: unknown): void;
-}
-
-export type ScopedValueStore = Omit<ContextKeyService, 'onDidChange' | 'match' | 'parseKeys' | 'with' | 'createOverlay'>;
-
-@injectable()
-export class ContextKeyServiceDummyImpl implements ContextKeyService {
-
-    protected readonly onDidChangeEmitter = new Emitter<ContextKeyChangeEvent>();
-    readonly onDidChange = this.onDidChangeEmitter.event;
-    protected fireDidChange(event: ContextKeyChangeEvent): void {
-        this.onDidChangeEmitter.fire(event);
-    }
-
-    createKey<T extends ContextKeyValue>(key: string, defaultValue: T | undefined): ContextKey<T> {
-        return ContextKey.None;
-    }
-    /**
-     * It should be implemented by an extension, e.g. by the monaco extension.
-     */
-    match(expression: string, context?: HTMLElement): boolean {
-        return true;
-    }
-
-    /**
-     * It should be implemented by an extension, e.g. by the monaco extension.
-     */
-    parseKeys(expression: string): Set<string> | undefined {
-        return new Set<string>();
-    }
-
-    /**
-     * Details should be implemented by an extension, e.g. by the monaco extension.
-     * Callback must be synchronous.
-     */
-    with<T>(values: Record<string, unknown>, callback: () => T): T {
-        return callback();
-    }
-
-    /**
-     * Details should implemented by an extension, e.g. by the monaco extension.
-     */
-    createScoped(target: HTMLElement): ContextKeyService {
-        return this;
-    }
-
-    /**
-     * Details should be implemented by an extension, e.g. the monaco extension.
-     */
-    createOverlay(overlay: Iterable<[string, unknown]>): ContextMatcher {
-        return this;
-    }
-
-    /**
-     * Details should be implemented by an extension, e.g. by the monaco extension.
-     */
-    setContext(key: string, value: unknown): void { }
-
-    dispose(): void { }
-}
+// *****************************************************************************
+// Copyright (C) 2019 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 { Emitter, Event } from '../common/event';
+import { Disposable } from '../common';
+
+export type ContextKeyValue = null | undefined | boolean | number | string
+    | Array<null | undefined | boolean | number | string>
+    | Record<string, null | undefined | boolean | number | string>;
+
+export interface ContextKey<T extends ContextKeyValue = ContextKeyValue> {
+    set(value: T | undefined): void;
+    reset(): void;
+    get(): T | undefined;
+}
+
+export namespace ContextKey {
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    export const None: ContextKey<any> = Object.freeze({
+        set: () => { },
+        reset: () => { },
+        get: () => undefined
+    });
+}
+
+export interface ContextKeyChangeEvent {
+    affects(keys: { has(key: string): boolean }): boolean;
+}
+
+export const ContextKeyService = Symbol('ContextKeyService');
+
+export interface ContextMatcher {
+    /**
+     * Whether the expression is satisfied. If `context` provided, the service will attempt to retrieve a context object associated with that element.
+     */
+    match(expression: string, context?: HTMLElement): boolean;
+}
+
+export interface ContextKeyService extends ContextMatcher {
+    readonly onDidChange: Event<ContextKeyChangeEvent>;
+
+    createKey<T extends ContextKeyValue>(key: string, defaultValue: T | undefined): ContextKey<T>;
+
+    /**
+     * @returns a Set of the keys used by the given `expression` or `undefined` if none are used or the expression cannot be parsed.
+     */
+    parseKeys(expression: string): Set<string> | undefined;
+
+    /**
+     * Creates a temporary context that will use the `values` passed in when evaluating {@link callback}.
+     * {@link callback | The callback} must be synchronous.
+     */
+    with<T>(values: Record<string, unknown>, callback: () => T): T;
+
+    /**
+     * Creates a child service with a separate context scoped to the HTML element passed in.
+     * Useful for e.g. setting the {view} context value for particular widgets.
+     */
+    createScoped(target: HTMLElement): ScopedValueStore;
+
+    /**
+     * @param overlay values to be used in the new {@link ContextKeyService}. These values will be static.
+     * Creates a child service with a separate context and a set of fixed values to override parent values.
+     */
+    createOverlay(overlay: Iterable<[string, unknown]>): ContextMatcher;
+
+    /**
+     * Set or modify a value in the service's context.
+     */
+    setContext(key: string, value: unknown): void;
+}
+
+export type ScopedValueStore = Omit<ContextKeyService, 'onDidChange' | 'match' | 'parseKeys' | 'with' | 'createOverlay'> & Disposable;
+
+@injectable()
+export class ContextKeyServiceDummyImpl implements ContextKeyService {
+    protected readonly onDidChangeEmitter = new Emitter<ContextKeyChangeEvent>();
+    readonly onDidChange = this.onDidChangeEmitter.event;
+    protected fireDidChange(event: ContextKeyChangeEvent): void {
+        this.onDidChangeEmitter.fire(event);
+    }
+
+    createKey<T extends ContextKeyValue>(key: string, defaultValue: T | undefined): ContextKey<T> {
+        return ContextKey.None;
+    }
+    /**
+     * It should be implemented by an extension, e.g. by the monaco extension.
+     */
+    match(expression: string, context?: HTMLElement): boolean {
+        return true;
+    }
+
+    /**
+     * It should be implemented by an extension, e.g. by the monaco extension.
+     */
+    parseKeys(expression: string): Set<string> | undefined {
+        return new Set<string>();
+    }
+
+    /**
+     * Details should be implemented by an extension, e.g. by the monaco extension.
+     * Callback must be synchronous.
+     */
+    with<T>(values: Record<string, unknown>, callback: () => T): T {
+        return callback();
+    }
+
+    /**
+     * Details should implemented by an extension, e.g. by the monaco extension.
+     */
+    createScoped(target: HTMLElement): ScopedValueStore {
+        return this;
+    }
+
+    /**
+     * Details should be implemented by an extension, e.g. the monaco extension.
+     */
+    createOverlay(overlay: Iterable<[string, unknown]>): ContextMatcher {
+        return this;
+    }
+
+    /**
+     * Details should be implemented by an extension, e.g. by the monaco extension.
+     */
+    setContext(key: string, value: unknown): void { }
+
+    dispose(): void { }
+}

package/src/browser/context-menu-renderer.ts

@@ -1,124 +1,124 @@
-// *****************************************************************************
-// Copyright (C) 2017 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
-// *****************************************************************************
-
-/* eslint-disable @typescript-eslint/no-explicit-any */
-
-import { injectable } from 'inversify';
-import { MenuPath } from '../common/menu';
-import { Disposable, DisposableCollection } from '../common/disposable';
-import { ContextMatcher } from './context-key-service';
-
-export interface Coordinate { x: number; y: number; }
-export const Coordinate = Symbol('Coordinate');
-
-export type Anchor = MouseEvent | Coordinate;
-
-export function coordinateFromAnchor(anchor: Anchor): Coordinate {
-    const { x, y } = anchor instanceof MouseEvent ? { x: anchor.clientX, y: anchor.clientY } : anchor;
-    return { x, y };
-}
-
-export abstract class ContextMenuAccess implements Disposable {
-
-    protected readonly toDispose = new DisposableCollection();
-    readonly onDispose = this.toDispose.onDispose;
-
-    constructor(toClose: Disposable) {
-        this.toDispose.push(toClose);
-    }
-
-    get disposed(): boolean {
-        return this.toDispose.disposed;
-    }
-
-    dispose(): void {
-        this.toDispose.dispose();
-    }
-
-}
-
-@injectable()
-export abstract class ContextMenuRenderer {
-
-    protected _current: ContextMenuAccess | undefined;
-    protected readonly toDisposeOnSetCurrent = new DisposableCollection();
-    /**
-     * Currently opened context menu.
-     * Rendering a new context menu will close the current.
-     */
-    get current(): ContextMenuAccess | undefined {
-        return this._current;
-    }
-    protected setCurrent(current: ContextMenuAccess | undefined): void {
-        if (this._current === current) {
-            return;
-        }
-        this.toDisposeOnSetCurrent.dispose();
-        this._current = current;
-        if (current) {
-            this.toDisposeOnSetCurrent.push(current.onDispose(() => {
-                this._current = undefined;
-            }));
-            this.toDisposeOnSetCurrent.push(current);
-        }
-    }
-
-    render(options: RenderContextMenuOptions): ContextMenuAccess {
-        const resolvedOptions = this.resolve(options);
-        const access = this.doRender(resolvedOptions);
-        this.setCurrent(access);
-        return access;
-    }
-
-    protected abstract doRender(options: RenderContextMenuOptions): ContextMenuAccess;
-
-    protected resolve(options: RenderContextMenuOptions): RenderContextMenuOptions {
-        const args: any[] = options.args ? options.args.slice() : [];
-        if (options.includeAnchorArg !== false) {
-            args.push(options.anchor);
-        }
-        return {
-            ...options,
-            args
-        };
-    }
-
-}
-
-export interface RenderContextMenuOptions {
-    menuPath: MenuPath;
-    anchor: Anchor;
-    args?: any[];
-    /**
-     * Whether the anchor should be passed as an argument to the handlers of commands for this context menu.
-     * If true, the anchor will be appended to the list of arguments or passed as the only argument if no other
-     * arguments are supplied.
-     * Default is `true`.
-     */
-    includeAnchorArg?: boolean;
-    /**
-     * A DOM context to use when evaluating any `when` clauses
-     * of menu items registered for this item.
-     */
-    context?: HTMLElement;
-    contextKeyService?: ContextMatcher;
-    onHide?: () => void;
-    /**
-     * If true a single submenu in the context menu is not rendered but its children are rendered on the top level.
-     * Default is `false`.
-     */
-    skipSingleRootNode?: boolean;
-}
+// *****************************************************************************
+// Copyright (C) 2017 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
+// *****************************************************************************
+
+/* eslint-disable @typescript-eslint/no-explicit-any */
+
+import { injectable } from 'inversify';
+import { MenuPath } from '../common/menu';
+import { Disposable, DisposableCollection } from '../common/disposable';
+import { ContextMatcher } from './context-key-service';
+
+export interface Coordinate { x: number; y: number; }
+export const Coordinate = Symbol('Coordinate');
+
+export type Anchor = MouseEvent | Coordinate;
+
+export function coordinateFromAnchor(anchor: Anchor): Coordinate {
+    const { x, y } = anchor instanceof MouseEvent ? { x: anchor.clientX, y: anchor.clientY } : anchor;
+    return { x, y };
+}
+
+export abstract class ContextMenuAccess implements Disposable {
+
+    protected readonly toDispose = new DisposableCollection();
+    readonly onDispose = this.toDispose.onDispose;
+
+    constructor(toClose: Disposable) {
+        this.toDispose.push(toClose);
+    }
+
+    get disposed(): boolean {
+        return this.toDispose.disposed;
+    }
+
+    dispose(): void {
+        this.toDispose.dispose();
+    }
+
+}
+
+@injectable()
+export abstract class ContextMenuRenderer {
+
+    protected _current: ContextMenuAccess | undefined;
+    protected readonly toDisposeOnSetCurrent = new DisposableCollection();
+    /**
+     * Currently opened context menu.
+     * Rendering a new context menu will close the current.
+     */
+    get current(): ContextMenuAccess | undefined {
+        return this._current;
+    }
+    protected setCurrent(current: ContextMenuAccess | undefined): void {
+        if (this._current === current) {
+            return;
+        }
+        this.toDisposeOnSetCurrent.dispose();
+        this._current = current;
+        if (current) {
+            this.toDisposeOnSetCurrent.push(current.onDispose(() => {
+                this._current = undefined;
+            }));
+            this.toDisposeOnSetCurrent.push(current);
+        }
+    }
+
+    render(options: RenderContextMenuOptions): ContextMenuAccess {
+        const resolvedOptions = this.resolve(options);
+        const access = this.doRender(resolvedOptions);
+        this.setCurrent(access);
+        return access;
+    }
+
+    protected abstract doRender(options: RenderContextMenuOptions): ContextMenuAccess;
+
+    protected resolve(options: RenderContextMenuOptions): RenderContextMenuOptions {
+        const args: any[] = options.args ? options.args.slice() : [];
+        if (options.includeAnchorArg !== false) {
+            args.push(options.anchor);
+        }
+        return {
+            ...options,
+            args
+        };
+    }
+
+}
+
+export interface RenderContextMenuOptions {
+    menuPath: MenuPath;
+    anchor: Anchor;
+    args?: any[];
+    /**
+     * Whether the anchor should be passed as an argument to the handlers of commands for this context menu.
+     * If true, the anchor will be appended to the list of arguments or passed as the only argument if no other
+     * arguments are supplied.
+     * Default is `true`.
+     */
+    includeAnchorArg?: boolean;
+    /**
+     * A DOM context to use when evaluating any `when` clauses
+     * of menu items registered for this item.
+     */
+    context?: HTMLElement;
+    contextKeyService?: ContextMatcher;
+    onHide?: () => void;
+    /**
+     * If true a single submenu in the context menu is not rendered but its children are rendered on the top level.
+     * Default is `false`.
+     */
+    skipSingleRootNode?: boolean;
+}