@theia/plugin-ext 1.53.0-next.55 → 1.53.0-next.64

package/src/main/browser/custom-editors/custom-editor-opener.tsx

@@ -1,205 +1,205 @@
-// *****************************************************************************
-// Copyright (C) 2021 SAP SE or an SAP affiliate company 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 URI from '@theia/core/lib/common/uri';
-import {
-    ApplicationShell, DiffUris, OpenHandler, OpenerOptions, PreferenceService, SplitWidget, Widget, WidgetManager, WidgetOpenerOptions, getDefaultHandler, defaultHandlerPriority
-} from '@theia/core/lib/browser';
-import { CustomEditor, CustomEditorPriority, CustomEditorSelector } from '../../../common';
-import { CustomEditorWidget } from './custom-editor-widget';
-import { PluginCustomEditorRegistry } from './plugin-custom-editor-registry';
-import { generateUuid } from '@theia/core/lib/common/uuid';
-import { DisposableCollection, Emitter } from '@theia/core';
-import { match } from '@theia/core/lib/common/glob';
-
-export class CustomEditorOpener implements OpenHandler {
-
-    readonly id: string;
-    readonly label: string;
-
-    private readonly onDidOpenCustomEditorEmitter = new Emitter<[CustomEditorWidget, WidgetOpenerOptions?]>();
-    readonly onDidOpenCustomEditor = this.onDidOpenCustomEditorEmitter.event;
-
-    constructor(
-        private readonly editor: CustomEditor,
-        protected readonly shell: ApplicationShell,
-        protected readonly widgetManager: WidgetManager,
-        protected readonly editorRegistry: PluginCustomEditorRegistry,
-        protected readonly preferenceService: PreferenceService
-    ) {
-        this.id = CustomEditorOpener.toCustomEditorId(this.editor.viewType);
-        this.label = this.editor.displayName;
-    }
-
-    static toCustomEditorId(editorViewType: string): string {
-        return `custom-editor-${editorViewType}`;
-    }
-
-    canHandle(uri: URI, options?: OpenerOptions): number {
-        let priority = 0;
-        const { selector } = this.editor;
-        if (DiffUris.isDiffUri(uri)) {
-            const [left, right] = DiffUris.decode(uri);
-            if (this.matches(selector, right) && this.matches(selector, left)) {
-                priority = this.getPriority();
-            }
-        } else if (this.matches(selector, uri)) {
-            if (getDefaultHandler(uri, this.preferenceService) === this.editor.viewType) {
-                priority = defaultHandlerPriority;
-            } else {
-                priority = this.getPriority();
-            }
-        }
-        return priority;
-    }
-
-    canOpenWith(uri: URI): number {
-        if (this.matches(this.editor.selector, uri)) {
-            return this.getPriority();
-        }
-        return 0;
-    }
-
-    getPriority(): number {
-        switch (this.editor.priority) {
-            case CustomEditorPriority.default: return 500;
-            case CustomEditorPriority.builtin: return 400;
-            /** `option` should not open the custom-editor by default. */
-            case CustomEditorPriority.option: return 1;
-            default: return 200;
-        }
-    }
-
-    protected readonly pendingWidgetPromises = new Map<string, Promise<CustomEditorWidget>>();
-    protected async openCustomEditor(uri: URI, options?: WidgetOpenerOptions): Promise<CustomEditorWidget> {
-        let widget: CustomEditorWidget | undefined;
-        let isNewWidget = false;
-        const uriString = uri.toString();
-        let widgetPromise = this.pendingWidgetPromises.get(uriString);
-        if (widgetPromise) {
-            widget = await widgetPromise;
-        } else {
-            const widgets = this.widgetManager.getWidgets(CustomEditorWidget.FACTORY_ID) as CustomEditorWidget[];
-            widget = widgets.find(w => w.viewType === this.editor.viewType && w.resource.toString() === uriString);
-            if (!widget) {
-                isNewWidget = true;
-                const id = generateUuid();
-                widgetPromise = this.widgetManager.getOrCreateWidget<CustomEditorWidget>(CustomEditorWidget.FACTORY_ID, { id }).then(async w => {
-                    try {
-                        w.viewType = this.editor.viewType;
-                        w.resource = uri;
-                        await this.editorRegistry.resolveWidget(w);
-                        if (options?.widgetOptions) {
-                            await this.shell.addWidget(w, options.widgetOptions);
-                        }
-                        return w;
-                    } catch (e) {
-                        w.dispose();
-                        throw e;
-                    }
-                }).finally(() => this.pendingWidgetPromises.delete(uriString));
-                this.pendingWidgetPromises.set(uriString, widgetPromise);
-                widget = await widgetPromise;
-            }
-        }
-        if (options?.mode === 'activate') {
-            await this.shell.activateWidget(widget.id);
-        } else if (options?.mode === 'reveal') {
-            await this.shell.revealWidget(widget.id);
-        }
-        if (isNewWidget) {
-            this.onDidOpenCustomEditorEmitter.fire([widget, options]);
-        }
-        return widget;
-    }
-
-    protected async openSideBySide(uri: URI, options?: WidgetOpenerOptions): Promise<Widget | undefined> {
-        const [leftUri, rightUri] = DiffUris.decode(uri);
-        const widget = await this.widgetManager.getOrCreateWidget<SplitWidget>(
-            CustomEditorWidget.SIDE_BY_SIDE_FACTORY_ID, { uri: uri.toString(), viewType: this.editor.viewType });
-        if (!widget.panes.length) { // a new widget
-            const trackedDisposables = new DisposableCollection(widget);
-            try {
-                const createPane = async (paneUri: URI) => {
-                    let pane = await this.openCustomEditor(paneUri);
-                    if (pane.isAttached) {
-                        await this.shell.closeWidget(pane.id);
-                        if (!pane.isDisposed) { // user canceled
-                            return undefined;
-                        }
-                        pane = await this.openCustomEditor(paneUri);
-                    }
-                    return pane;
-                };
-
-                const rightPane = await createPane(rightUri);
-                if (!rightPane) {
-                    trackedDisposables.dispose();
-                    return undefined;
-                }
-                trackedDisposables.push(rightPane);
-
-                const leftPane = await createPane(leftUri);
-                if (!leftPane) {
-                    trackedDisposables.dispose();
-                    return undefined;
-                }
-                trackedDisposables.push(leftPane);
-
-                widget.addPane(leftPane);
-                widget.addPane(rightPane);
-
-                // dispose the widget if either of its panes gets externally disposed
-                leftPane.disposed.connect(() => widget.dispose());
-                rightPane.disposed.connect(() => widget.dispose());
-
-                if (options?.widgetOptions) {
-                    await this.shell.addWidget(widget, options.widgetOptions);
-                }
-            } catch (e) {
-                trackedDisposables.dispose();
-                console.error(e);
-                throw e;
-            }
-        }
-        if (options?.mode === 'activate') {
-            await this.shell.activateWidget(widget.id);
-        } else if (options?.mode === 'reveal') {
-            await this.shell.revealWidget(widget.id);
-        }
-        return widget;
-    }
-
-    async open(uri: URI, options?: WidgetOpenerOptions): Promise<Widget | undefined> {
-        options = { ...options };
-        options.mode ??= 'activate';
-        options.widgetOptions ??= { area: 'main' };
-        return DiffUris.isDiffUri(uri) ? this.openSideBySide(uri, options) : this.openCustomEditor(uri, options);
-    }
-
-    matches(selectors: CustomEditorSelector[], resource: URI): boolean {
-        return selectors.some(selector => this.selectorMatches(selector, resource));
-    }
-
-    selectorMatches(selector: CustomEditorSelector, resource: URI): boolean {
-        if (selector.filenamePattern) {
-            if (match(selector.filenamePattern.toLowerCase(), resource.path.name.toLowerCase() + resource.path.ext.toLowerCase())) {
-                return true;
-            }
-        }
-        return false;
-    }
-}
+// *****************************************************************************
+// Copyright (C) 2021 SAP SE or an SAP affiliate company 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 URI from '@theia/core/lib/common/uri';
+import {
+    ApplicationShell, DiffUris, OpenHandler, OpenerOptions, PreferenceService, SplitWidget, Widget, WidgetManager, WidgetOpenerOptions, getDefaultHandler, defaultHandlerPriority
+} from '@theia/core/lib/browser';
+import { CustomEditor, CustomEditorPriority, CustomEditorSelector } from '../../../common';
+import { CustomEditorWidget } from './custom-editor-widget';
+import { PluginCustomEditorRegistry } from './plugin-custom-editor-registry';
+import { generateUuid } from '@theia/core/lib/common/uuid';
+import { DisposableCollection, Emitter } from '@theia/core';
+import { match } from '@theia/core/lib/common/glob';
+
+export class CustomEditorOpener implements OpenHandler {
+
+    readonly id: string;
+    readonly label: string;
+
+    private readonly onDidOpenCustomEditorEmitter = new Emitter<[CustomEditorWidget, WidgetOpenerOptions?]>();
+    readonly onDidOpenCustomEditor = this.onDidOpenCustomEditorEmitter.event;
+
+    constructor(
+        private readonly editor: CustomEditor,
+        protected readonly shell: ApplicationShell,
+        protected readonly widgetManager: WidgetManager,
+        protected readonly editorRegistry: PluginCustomEditorRegistry,
+        protected readonly preferenceService: PreferenceService
+    ) {
+        this.id = CustomEditorOpener.toCustomEditorId(this.editor.viewType);
+        this.label = this.editor.displayName;
+    }
+
+    static toCustomEditorId(editorViewType: string): string {
+        return `custom-editor-${editorViewType}`;
+    }
+
+    canHandle(uri: URI, options?: OpenerOptions): number {
+        let priority = 0;
+        const { selector } = this.editor;
+        if (DiffUris.isDiffUri(uri)) {
+            const [left, right] = DiffUris.decode(uri);
+            if (this.matches(selector, right) && this.matches(selector, left)) {
+                priority = this.getPriority();
+            }
+        } else if (this.matches(selector, uri)) {
+            if (getDefaultHandler(uri, this.preferenceService) === this.editor.viewType) {
+                priority = defaultHandlerPriority;
+            } else {
+                priority = this.getPriority();
+            }
+        }
+        return priority;
+    }
+
+    canOpenWith(uri: URI): number {
+        if (this.matches(this.editor.selector, uri)) {
+            return this.getPriority();
+        }
+        return 0;
+    }
+
+    getPriority(): number {
+        switch (this.editor.priority) {
+            case CustomEditorPriority.default: return 500;
+            case CustomEditorPriority.builtin: return 400;
+            /** `option` should not open the custom-editor by default. */
+            case CustomEditorPriority.option: return 1;
+            default: return 200;
+        }
+    }
+
+    protected readonly pendingWidgetPromises = new Map<string, Promise<CustomEditorWidget>>();
+    protected async openCustomEditor(uri: URI, options?: WidgetOpenerOptions): Promise<CustomEditorWidget> {
+        let widget: CustomEditorWidget | undefined;
+        let isNewWidget = false;
+        const uriString = uri.toString();
+        let widgetPromise = this.pendingWidgetPromises.get(uriString);
+        if (widgetPromise) {
+            widget = await widgetPromise;
+        } else {
+            const widgets = this.widgetManager.getWidgets(CustomEditorWidget.FACTORY_ID) as CustomEditorWidget[];
+            widget = widgets.find(w => w.viewType === this.editor.viewType && w.resource.toString() === uriString);
+            if (!widget) {
+                isNewWidget = true;
+                const id = generateUuid();
+                widgetPromise = this.widgetManager.getOrCreateWidget<CustomEditorWidget>(CustomEditorWidget.FACTORY_ID, { id }).then(async w => {
+                    try {
+                        w.viewType = this.editor.viewType;
+                        w.resource = uri;
+                        await this.editorRegistry.resolveWidget(w);
+                        if (options?.widgetOptions) {
+                            await this.shell.addWidget(w, options.widgetOptions);
+                        }
+                        return w;
+                    } catch (e) {
+                        w.dispose();
+                        throw e;
+                    }
+                }).finally(() => this.pendingWidgetPromises.delete(uriString));
+                this.pendingWidgetPromises.set(uriString, widgetPromise);
+                widget = await widgetPromise;
+            }
+        }
+        if (options?.mode === 'activate') {
+            await this.shell.activateWidget(widget.id);
+        } else if (options?.mode === 'reveal') {
+            await this.shell.revealWidget(widget.id);
+        }
+        if (isNewWidget) {
+            this.onDidOpenCustomEditorEmitter.fire([widget, options]);
+        }
+        return widget;
+    }
+
+    protected async openSideBySide(uri: URI, options?: WidgetOpenerOptions): Promise<Widget | undefined> {
+        const [leftUri, rightUri] = DiffUris.decode(uri);
+        const widget = await this.widgetManager.getOrCreateWidget<SplitWidget>(
+            CustomEditorWidget.SIDE_BY_SIDE_FACTORY_ID, { uri: uri.toString(), viewType: this.editor.viewType });
+        if (!widget.panes.length) { // a new widget
+            const trackedDisposables = new DisposableCollection(widget);
+            try {
+                const createPane = async (paneUri: URI) => {
+                    let pane = await this.openCustomEditor(paneUri);
+                    if (pane.isAttached) {
+                        await this.shell.closeWidget(pane.id);
+                        if (!pane.isDisposed) { // user canceled
+                            return undefined;
+                        }
+                        pane = await this.openCustomEditor(paneUri);
+                    }
+                    return pane;
+                };
+
+                const rightPane = await createPane(rightUri);
+                if (!rightPane) {
+                    trackedDisposables.dispose();
+                    return undefined;
+                }
+                trackedDisposables.push(rightPane);
+
+                const leftPane = await createPane(leftUri);
+                if (!leftPane) {
+                    trackedDisposables.dispose();
+                    return undefined;
+                }
+                trackedDisposables.push(leftPane);
+
+                widget.addPane(leftPane);
+                widget.addPane(rightPane);
+
+                // dispose the widget if either of its panes gets externally disposed
+                leftPane.disposed.connect(() => widget.dispose());
+                rightPane.disposed.connect(() => widget.dispose());
+
+                if (options?.widgetOptions) {
+                    await this.shell.addWidget(widget, options.widgetOptions);
+                }
+            } catch (e) {
+                trackedDisposables.dispose();
+                console.error(e);
+                throw e;
+            }
+        }
+        if (options?.mode === 'activate') {
+            await this.shell.activateWidget(widget.id);
+        } else if (options?.mode === 'reveal') {
+            await this.shell.revealWidget(widget.id);
+        }
+        return widget;
+    }
+
+    async open(uri: URI, options?: WidgetOpenerOptions): Promise<Widget | undefined> {
+        options = { ...options };
+        options.mode ??= 'activate';
+        options.widgetOptions ??= { area: 'main' };
+        return DiffUris.isDiffUri(uri) ? this.openSideBySide(uri, options) : this.openCustomEditor(uri, options);
+    }
+
+    matches(selectors: CustomEditorSelector[], resource: URI): boolean {
+        return selectors.some(selector => this.selectorMatches(selector, resource));
+    }
+
+    selectorMatches(selector: CustomEditorSelector, resource: URI): boolean {
+        if (selector.filenamePattern) {
+            if (match(selector.filenamePattern.toLowerCase(), resource.path.name.toLowerCase() + resource.path.ext.toLowerCase())) {
+                return true;
+            }
+        }
+        return false;
+    }
+}

package/src/main/browser/custom-editors/custom-editor-service.ts

@@ -1,108 +1,108 @@
-// *****************************************************************************
-// Copyright (C) 2021 SAP SE or an SAP affiliate company 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
-// *****************************************************************************
-/*---------------------------------------------------------------------------------------------
- *  Copyright (c) Microsoft Corporation. All rights reserved.
- *  Licensed under the MIT License. See License.txt in the project root for license information.
- *--------------------------------------------------------------------------------------------*/
-// copied and modified from https://github.com/microsoft/vscode/blob/53eac52308c4611000a171cc7bf1214293473c78/src/vs/workbench/contrib/customEditor/browser/customEditors.ts
-
-import { injectable } from '@theia/core/shared/inversify';
-import URI from '@theia/core/lib/common/uri';
-import { Reference } from '@theia/core/lib/common/reference';
-import { CustomEditorModel } from './custom-editors-main';
-
-@injectable()
-export class CustomEditorService {
-    protected _models = new CustomEditorModelManager();
-    get models(): CustomEditorModelManager { return this._models; }
-}
-
-export class CustomEditorModelManager {
-
-    private readonly references = new Map<string, {
-        readonly viewType: string,
-        readonly model: Promise<CustomEditorModel>,
-        counter: number
-    }>();
-
-    add(resource: URI, viewType: string, model: Promise<CustomEditorModel>): Promise<Reference<CustomEditorModel>> {
-        const key = this.key(resource, viewType);
-        const existing = this.references.get(key);
-        if (existing) {
-            throw new Error('Model already exists');
-        }
-
-        this.references.set(key, { viewType, model, counter: 0 });
-        return this.tryRetain(resource, viewType)!;
-    }
-
-    async get(resource: URI, viewType: string): Promise<CustomEditorModel | undefined> {
-        const key = this.key(resource, viewType);
-        const entry = this.references.get(key);
-        return entry?.model;
-    }
-
-    tryRetain(resource: URI, viewType: string): Promise<Reference<CustomEditorModel>> | undefined {
-        const key = this.key(resource, viewType);
-
-        const entry = this.references.get(key);
-        if (!entry) {
-            return undefined;
-        }
-
-        entry.counter++;
-
-        return entry.model.then(model => ({
-            object: model,
-            dispose: once(() => {
-                if (--entry!.counter <= 0) {
-                    entry.model.then(x => x.dispose());
-                    this.references.delete(key);
-                }
-            }),
-        }));
-    }
-
-    disposeAllModelsForView(viewType: string): void {
-        for (const [key, value] of this.references) {
-            if (value.viewType === viewType) {
-                value.model.then(x => x.dispose());
-                this.references.delete(key);
-            }
-        }
-    }
-
-    private key(resource: URI, viewType: string): string {
-        return `${resource.toString()}@@@${viewType}`;
-    }
-}
-
-export function once<T extends Function>(this: unknown, fn: T): T {
-    const _this = this;
-    let didCall = false;
-    let result: unknown;
-
-    return function (): unknown {
-        if (didCall) {
-            return result;
-        }
-
-        didCall = true;
-        result = fn.apply(_this, arguments);
-
-        return result;
-    } as unknown as T;
-}
+// *****************************************************************************
+// Copyright (C) 2021 SAP SE or an SAP affiliate company 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
+// *****************************************************************************
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+// copied and modified from https://github.com/microsoft/vscode/blob/53eac52308c4611000a171cc7bf1214293473c78/src/vs/workbench/contrib/customEditor/browser/customEditors.ts
+
+import { injectable } from '@theia/core/shared/inversify';
+import URI from '@theia/core/lib/common/uri';
+import { Reference } from '@theia/core/lib/common/reference';
+import { CustomEditorModel } from './custom-editors-main';
+
+@injectable()
+export class CustomEditorService {
+    protected _models = new CustomEditorModelManager();
+    get models(): CustomEditorModelManager { return this._models; }
+}
+
+export class CustomEditorModelManager {
+
+    private readonly references = new Map<string, {
+        readonly viewType: string,
+        readonly model: Promise<CustomEditorModel>,
+        counter: number
+    }>();
+
+    add(resource: URI, viewType: string, model: Promise<CustomEditorModel>): Promise<Reference<CustomEditorModel>> {
+        const key = this.key(resource, viewType);
+        const existing = this.references.get(key);
+        if (existing) {
+            throw new Error('Model already exists');
+        }
+
+        this.references.set(key, { viewType, model, counter: 0 });
+        return this.tryRetain(resource, viewType)!;
+    }
+
+    async get(resource: URI, viewType: string): Promise<CustomEditorModel | undefined> {
+        const key = this.key(resource, viewType);
+        const entry = this.references.get(key);
+        return entry?.model;
+    }
+
+    tryRetain(resource: URI, viewType: string): Promise<Reference<CustomEditorModel>> | undefined {
+        const key = this.key(resource, viewType);
+
+        const entry = this.references.get(key);
+        if (!entry) {
+            return undefined;
+        }
+
+        entry.counter++;
+
+        return entry.model.then(model => ({
+            object: model,
+            dispose: once(() => {
+                if (--entry!.counter <= 0) {
+                    entry.model.then(x => x.dispose());
+                    this.references.delete(key);
+                }
+            }),
+        }));
+    }
+
+    disposeAllModelsForView(viewType: string): void {
+        for (const [key, value] of this.references) {
+            if (value.viewType === viewType) {
+                value.model.then(x => x.dispose());
+                this.references.delete(key);
+            }
+        }
+    }
+
+    private key(resource: URI, viewType: string): string {
+        return `${resource.toString()}@@@${viewType}`;
+    }
+}
+
+export function once<T extends Function>(this: unknown, fn: T): T {
+    const _this = this;
+    let didCall = false;
+    let result: unknown;
+
+    return function (): unknown {
+        if (didCall) {
+            return result;
+        }
+
+        didCall = true;
+        result = fn.apply(_this, arguments);
+
+        return result;
+    } as unknown as T;
+}