@theia/core 1.17.2 → 1.18.0-next.05f289b3

package/src/browser/breadcrumbs/breadcrumbs-service.ts

@@ -0,0 +1,108 @@
+/********************************************************************************
+ * 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 WITH Classpath-exception-2.0
+ ********************************************************************************/
+
+import { inject, injectable, named, postConstruct } from 'inversify';
+import { ContributionProvider, Prioritizeable, Emitter, Event } from '../../common';
+import URI from '../../common/uri';
+import { Coordinate } from '../context-menu-renderer';
+import { BreadcrumbPopupContainer, BreadcrumbPopupContainerFactory } from './breadcrumb-popup-container';
+import { BreadcrumbsContribution, Styles, Breadcrumb } from './breadcrumbs-constants';
+
+@injectable()
+export class BreadcrumbsService {
+
+    @inject(ContributionProvider) @named(BreadcrumbsContribution)
+    protected readonly contributions: ContributionProvider<BreadcrumbsContribution>;
+
+    @inject(BreadcrumbPopupContainerFactory) protected readonly breadcrumbPopupContainerFactory: BreadcrumbPopupContainerFactory;
+
+    protected hasSubscribed = false;
+
+    protected popupsOverlayContainer: HTMLDivElement;
+
+    protected readonly onDidChangeBreadcrumbsEmitter = new Emitter<URI>();
+
+    @postConstruct()
+    init(): void {
+        this.createOverlayContainer();
+    }
+
+    protected createOverlayContainer(): void {
+        this.popupsOverlayContainer = window.document.createElement('div');
+        this.popupsOverlayContainer.id = Styles.BREADCRUMB_POPUP_OVERLAY_CONTAINER;
+        if (window.document.body) {
+            window.document.body.appendChild(this.popupsOverlayContainer);
+        }
+    }
+
+    /**
+     * Subscribe to this event emitter to be notified when the breadcrumbs have changed.
+     * The URI is the URI of the editor the breadcrumbs have changed for.
+     */
+    get onDidChangeBreadcrumbs(): Event<URI> {
+        // This lazy subscription is to address problems in inversify's instantiation routine
+        // related to use of the IconThemeService by different components instantiated by the
+        // ContributionProvider.
+        if (!this.hasSubscribed) {
+            this.subscribeToContributions();
+        }
+        return this.onDidChangeBreadcrumbsEmitter.event;
+    }
+
+    /**
+     * Subscribes to the onDidChangeBreadcrumbs events for all contributions.
+     */
+    protected subscribeToContributions(): void {
+        this.hasSubscribed = true;
+        for (const contribution of this.contributions.getContributions()) {
+            contribution.onDidChangeBreadcrumbs(uri => this.onDidChangeBreadcrumbsEmitter.fire(uri));
+        }
+    }
+
+    /**
+     * Returns the breadcrumbs for a given URI, possibly an empty list.
+     */
+    async getBreadcrumbs(uri: URI): Promise<Breadcrumb[]> {
+        const result: Breadcrumb[] = [];
+        for (const contribution of await this.prioritizedContributions()) {
+            result.push(...await contribution.computeBreadcrumbs(uri));
+        }
+        return result;
+    }
+
+    protected async prioritizedContributions(): Promise<BreadcrumbsContribution[]> {
+        const prioritized = await Prioritizeable.prioritizeAll(
+            this.contributions.getContributions(), contribution => contribution.priority);
+        return prioritized.map(p => p.value).reverse();
+    }
+
+    /**
+     * Opens a popup for the given breadcrumb at the given position.
+     */
+    async openPopup(breadcrumb: Breadcrumb, position: Coordinate): Promise<BreadcrumbPopupContainer | undefined> {
+        const contribution = this.contributions.getContributions().find(c => c.type === breadcrumb.type);
+        if (contribution) {
+            const popup = this.breadcrumbPopupContainerFactory(this.popupsOverlayContainer, breadcrumb.id, position);
+            const popupContent = await contribution.attachPopupContent(breadcrumb, popup.container);
+            if (popupContent && popup.isOpen) {
+                popup.onDidDispose(() => popupContent.dispose());
+            } else {
+                popupContent?.dispose();
+            }
+            return popup;
+        }
+    }
+}

package/src/browser/breadcrumbs/index.ts

@@ -0,0 +1,21 @@
+/********************************************************************************
+ * 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 WITH Classpath-exception-2.0
+ ********************************************************************************/
+
+export * from './breadcrumb-popup-container';
+export * from './breadcrumb-renderer';
+export * from './breadcrumbs-renderer';
+export * from './breadcrumbs-service';
+export * from './breadcrumbs-constants';

package/src/browser/common-frontend-contribution.ts

@@ -1921,6 +1921,51 @@ export class CommonFrontendContribution implements FrontendApplicationContributi
                     light: '#c5c5c5',
                     hc: '#c5c5c5'
                 }, description: 'Editor gutter decoration color for commenting ranges.'
+            },
+            {
+                id: 'breadcrumb.foreground',
+                defaults: {
+                    dark: Color.transparent('foreground', 0.8),
+                    light: Color.transparent('foreground', 0.8),
+                    hc: Color.transparent('foreground', 0.8),
+                },
+                description: 'Color of breadcrumb item text'
+            },
+            {
+                id: 'breadcrumb.background',
+                defaults: {
+                    dark: 'editor.background',
+                    light: 'editor.background',
+                    hc: 'editor.background',
+                },
+                description: 'Color of breadcrumb item background'
+            },
+            {
+                id: 'breadcrumb.focusForeground',
+                defaults: {
+                    dark: Color.lighten('foreground', 0.1),
+                    light: Color.darken('foreground', 0.2),
+                    hc: Color.lighten('foreground', 0.1),
+                },
+                description: 'Color of breadcrumb item text when focused'
+            },
+            {
+                id: 'breadcrumb.activeSelectionForeground',
+                defaults: {
+                    dark: Color.lighten('foreground', 0.1),
+                    light: Color.darken('foreground', 0.2),
+                    hc: Color.lighten('foreground', 0.1),
+                },
+                description: 'Color of selected breadcrumb item'
+            },
+            {
+                id: 'breadcrumbPicker.background',
+                defaults: {
+                    dark: 'editorWidget.background',
+                    light: 'editorWidget.background',
+                    hc: 'editorWidget.background',
+                },
+                description: 'Background color of breadcrumb item picker'
             }
         );
     }

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

@@ -20,12 +20,20 @@ import { injectable } from 'inversify';
 import { MenuPath } from '../common/menu';
 import { Disposable, DisposableCollection } from '../common/disposable';
 
-export type Anchor = MouseEvent | { x: number, y: number };
+export interface Coordinate { x: number; y: number; }
+export const Coordinate = Symbol('Coordinate');
 
-export function toAnchor(anchor: HTMLElement | { x: number, y: number }): Anchor {
+export type Anchor = MouseEvent | Coordinate;
+
+export function toAnchor(anchor: HTMLElement | Coordinate): Anchor {
     return anchor instanceof HTMLElement ? { x: anchor.offsetLeft, y: anchor.offsetTop } : anchor;
 }
 
+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();

package/src/browser/core-preferences.ts

@@ -23,6 +23,55 @@ import { isOSX } from '../common/os';
 export const corePreferenceSchema: PreferenceSchema = {
     'type': 'object',
     properties: {
+        'application.confirmExit': {
+            type: 'string',
+            enum: [
+                'never',
+                'ifRequired',
+                'always',
+            ],
+            default: 'ifRequired',
+            description: 'When to confirm before closing the application window.',
+        },
+        'breadcrumbs.enabled': {
+            'type': 'boolean',
+            'default': true,
+            'description': 'Enable/disable navigation breadcrumbs.',
+            'scope': 'application'
+        },
+        'files.encoding': {
+            'type': 'string',
+            'enum': Object.keys(SUPPORTED_ENCODINGS),
+            'default': 'utf8',
+            'description': 'The default character set encoding to use when reading and writing files. This setting can also be configured per language.',
+            'scope': 'language-overridable',
+            'enumDescriptions': Object.keys(SUPPORTED_ENCODINGS).map(key => SUPPORTED_ENCODINGS[key].labelLong),
+            'included': Object.keys(SUPPORTED_ENCODINGS).length > 1
+        },
+        'keyboard.dispatch': {
+            type: 'string',
+            enum: [
+                'code',
+                'keyCode',
+            ],
+            default: 'code',
+            description: 'Whether to interpret keypresses by the `code` of the physical key, or by the `keyCode` provided by the OS.'
+        },
+        'window.menuBarVisibility': {
+            type: 'string',
+            enum: ['classic', 'visible', 'hidden', 'compact'],
+            markdownEnumDescriptions: [
+                'Menu is displayed at the top of the window and only hidden in full screen mode.',
+                'Menu is always visible at the top of the window even in full screen mode.',
+                'Menu is always hidden.',
+                'Menu is displayed as a compact button in the sidebar.'
+            ],
+            default: 'classic',
+            scope: 'application',
+            markdownDescription: `Control the visibility of the menu bar.
+            A setting of 'compact' will move the menu into the sidebar.`,
+            included: !isOSX
+        },
         'workbench.list.openMode': {
             type: 'string',
             enum: [
@@ -43,16 +92,6 @@ export const corePreferenceSchema: PreferenceSchema = {
             'description': 'Controls whether editors showing a file that was opened during the session should close automatically when getting deleted or renamed by some other process. Disabling this will keep the editor open  on such an event. Note that deleting from within the application will always close the editor and that dirty files will never close to preserve your data.',
             'default': false
         },
-        'application.confirmExit': {
-            type: 'string',
-            enum: [
-                'never',
-                'ifRequired',
-                'always',
-            ],
-            default: 'ifRequired',
-            description: 'When to confirm before closing the application window.',
-        },
         'workbench.commandPalette.history': {
             type: 'number',
             default: 50,
@@ -74,51 +113,21 @@ export const corePreferenceSchema: PreferenceSchema = {
             default: false,
             description: 'Controls whether to suppress notification popups.'
         },
-        'files.encoding': {
-            'type': 'string',
-            'enum': Object.keys(SUPPORTED_ENCODINGS),
-            'default': 'utf8',
-            'description': 'The default character set encoding to use when reading and writing files. This setting can also be configured per language.',
-            'scope': 'language-overridable',
-            'enumDescriptions': Object.keys(SUPPORTED_ENCODINGS).map(key => SUPPORTED_ENCODINGS[key].labelLong),
-            'included': Object.keys(SUPPORTED_ENCODINGS).length > 1
-        },
         'workbench.tree.renderIndentGuides': {
             type: 'string',
             enum: ['onHover', 'none', 'always'],
             default: 'onHover',
             description: 'Controls whether the tree should render indent guides.'
         },
-        'keyboard.dispatch': {
-            type: 'string',
-            enum: [
-                'code',
-                'keyCode',
-            ],
-            default: 'code',
-            description: 'Whether to interpret keypresses by the `code` of the physical key, or by the `keyCode` provided by the OS.'
-        },
-        'window.menuBarVisibility': {
-            type: 'string',
-            enum: ['classic', 'visible', 'hidden', 'compact'],
-            markdownEnumDescriptions: [
-                'Menu is displayed at the top of the window and only hidden in full screen mode.',
-                'Menu is always visible at the top of the window even in full screen mode.',
-                'Menu is always hidden.',
-                'Menu is displayed as a compact button in the sidebar.'
-            ],
-            default: 'classic',
-            scope: 'application',
-            markdownDescription: `Control the visibility of the menu bar. 
-            A setting of 'compact' will move the menu into the sidebar.`,
-            included: !isOSX
-        },
     }
 };
 
 export interface CoreConfiguration {
     'application.confirmExit': 'never' | 'ifRequired' | 'always';
+    'breadcrumbs.enabled': boolean;
+    'files.encoding': string
     'keyboard.dispatch': 'code' | 'keyCode';
+    'window.menuBarVisibility': 'classic' | 'visible' | 'hidden' | 'compact';
     'workbench.list.openMode': 'singleClick' | 'doubleClick';
     'workbench.commandPalette.history': number;
     'workbench.editor.highlightModifiedTabs': boolean;
@@ -126,9 +135,7 @@ export interface CoreConfiguration {
     'workbench.colorTheme': string;
     'workbench.iconTheme': string | null;
     'workbench.silentNotifications': boolean;
-    'files.encoding': string
     'workbench.tree.renderIndentGuides': 'onHover' | 'none' | 'always';
-    'window.menuBarVisibility': 'classic' | 'visible' | 'hidden' | 'compact';
 }
 
 export const CorePreferenceContribution = Symbol('CorePreferenceContribution');

package/src/browser/dialogs.ts

@@ -17,7 +17,7 @@
 import { injectable, inject } from 'inversify';
 import { Disposable, MaybePromise, CancellationTokenSource } from '../common';
 import { Key } from './keyboard/keys';
-import { Widget, BaseWidget, Message, addKeyListener } from './widgets';
+import { Widget, BaseWidget, Message, addKeyListener, codiconArray } from './widgets';
 import { FrontendApplicationContribution } from './frontend-application';
 
 @injectable()
@@ -168,8 +168,7 @@ export abstract class AbstractDialog<T> extends BaseWidget {
         titleContentNode.appendChild(this.titleNode);
 
         this.closeCrossNode = document.createElement('i');
-        this.closeCrossNode.classList.add('fa');
-        this.closeCrossNode.classList.add('fa-times');
+        this.closeCrossNode.classList.add(...codiconArray('close'));
         this.closeCrossNode.classList.add('closeButton');
         titleContentNode.appendChild(this.closeCrossNode);
 

package/src/browser/diff-uris.ts

@@ -17,6 +17,7 @@
 import { injectable, inject } from 'inversify';
 import URI from '../common/uri';
 import { LabelProviderContribution, LabelProvider, DidChangeLabelEvent } from './label-provider';
+import { codicon } from './widgets';
 
 export namespace DiffUris {
 
@@ -101,7 +102,7 @@ export class DiffUriLabelProviderContribution implements LabelProviderContributi
     }
 
     getIcon(uri: URI): string {
-        return 'fa fa-columns';
+        return codicon('split-horizontal');
     }
 
     affects(diffUri: URI, event: DidChangeLabelEvent): boolean {

package/src/browser/frontend-application-module.ts

@@ -50,7 +50,7 @@ import { StatusBar, StatusBarImpl } from './status-bar/status-bar';
 import { LabelParser } from './label-parser';
 import { LabelProvider, LabelProviderContribution, DefaultUriLabelProviderContribution } from './label-provider';
 import { PreferenceService } from './preferences';
-import { ContextMenuRenderer } from './context-menu-renderer';
+import { ContextMenuRenderer, Coordinate } from './context-menu-renderer';
 import { ThemeService } from './theming';
 import { ConnectionStatusService, FrontendConnectionStatusService, ApplicationConnectionStatusContribution, PingService } from './connection-status-service';
 import { DiffUriLabelProviderContribution } from './diff-uris';
@@ -96,16 +96,28 @@ import { keytarServicePath, KeytarService } from '../common/keytar-protocol';
 import { CredentialsService, CredentialsServiceImpl } from './credentials-service';
 import { ContributionFilterRegistry, ContributionFilterRegistryImpl } from '../common/contribution-filter';
 import { QuickCommandFrontendContribution } from './quick-input/quick-command-frontend-contribution';
-import { QuickHelpService } from './quick-input/quick-help-service';
 import { QuickPickService, quickPickServicePath } from '../common/quick-pick-service';
 import {
     QuickPickServiceImpl,
-    QuickInputFrontendContribution
+    QuickInputFrontendContribution,
+    QuickAccessContribution,
+    QuickCommandService,
+    QuickHelpService
 } from './quick-input';
-import { QuickAccessContribution } from './quick-input/quick-access';
-import { QuickCommandService } from './quick-input/quick-command-service';
 import { SidebarBottomMenuWidget } from './shell/sidebar-bottom-menu-widget';
 import { WindowContribution } from './window-contribution';
+import {
+    BreadcrumbID,
+    BreadcrumbPopupContainer,
+    BreadcrumbPopupContainerFactory,
+    BreadcrumbRenderer,
+    BreadcrumbsContribution,
+    BreadcrumbsRenderer,
+    BreadcrumbsRendererFactory,
+    BreadcrumbsService,
+    DefaultBreadcrumbRenderer,
+} from './breadcrumbs';
+import { RendererHost } from './widgets';
 
 export { bindResourceProvider, bindMessageService, bindPreferenceService };
 
@@ -150,13 +162,7 @@ export const frontendApplicationModule = new ContainerModule((bind, unbind, isBo
         return container.get(TabBarToolbar);
     });
 
-    bind(DockPanelRendererFactory).toFactory(context => () => {
-        const { container } = context;
-        const tabBarToolbarRegistry = container.get(TabBarToolbarRegistry);
-        const tabBarRendererFactory: () => TabBarRenderer = container.get(TabBarRendererFactory);
-        const tabBarToolbarFactory: () => TabBarToolbar = container.get(TabBarToolbarFactory);
-        return new DockPanelRenderer(tabBarRendererFactory, tabBarToolbarRegistry, tabBarToolbarFactory);
-    });
+    bind(DockPanelRendererFactory).toFactory(context => () => context.container.get(DockPanelRenderer));
     bind(DockPanelRenderer).toSelf();
     bind(TabBarRendererFactory).toFactory(context => () => {
         const contextMenuRenderer = context.container.get<ContextMenuRenderer>(ContextMenuRenderer);
@@ -361,4 +367,22 @@ export const frontendApplicationModule = new ContainerModule((bind, unbind, isBo
     for (const contribution of [CommandContribution, KeybindingContribution, MenuContribution]) {
         bind(contribution).toService(WindowContribution);
     }
+    bindContributionProvider(bind, BreadcrumbsContribution);
+    bind(BreadcrumbsService).toSelf().inSingletonScope();
+    bind(BreadcrumbsRenderer).toSelf();
+    bind(BreadcrumbsRendererFactory).toFactory(ctx =>
+        () => {
+            const childContainer = ctx.container.createChild();
+            childContainer.bind(BreadcrumbRenderer).to(DefaultBreadcrumbRenderer).inSingletonScope();
+            return childContainer.get(BreadcrumbsRenderer);
+        }
+    );
+    bind(BreadcrumbPopupContainer).toSelf();
+    bind(BreadcrumbPopupContainerFactory).toFactory(({ container }) => (parent: HTMLElement, breadcrumbId: string, position: Coordinate): BreadcrumbPopupContainer => {
+        const child = container.createChild();
+        child.bind(RendererHost).toConstantValue(parent);
+        child.bind(BreadcrumbID).toConstantValue(breadcrumbId);
+        child.bind(Coordinate).toConstantValue(position);
+        return child.get(BreadcrumbPopupContainer);
+    });
 });