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

package/src/browser/theming.ts

@@ -1,206 +1,206 @@
-// *****************************************************************************
-// 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
-// *****************************************************************************
-
-import { Emitter, Event } from '../common/event';
-import { Disposable } from '../common/disposable';
-import { FrontendApplicationConfigProvider } from './frontend-application-config-provider';
-import { ApplicationProps, DefaultTheme } from '@theia/application-package/lib/application-props';
-import { Theme, ThemeChangeEvent } from '../common/theme';
-import { inject, injectable, postConstruct } from 'inversify';
-import { Deferred } from '../common/promise-util';
-import { PreferenceSchemaProvider, PreferenceService } from './preferences';
-import debounce = require('lodash.debounce');
-
-const COLOR_THEME_PREFERENCE_KEY = 'workbench.colorTheme';
-const NO_THEME = { id: 'no-theme', label: 'Not a real theme.', type: 'dark' } as const;
-
-@injectable()
-export class ThemeService {
-    static readonly STORAGE_KEY = 'theme';
-
-    @inject(PreferenceService) protected readonly preferences: PreferenceService;
-    @inject(PreferenceSchemaProvider) protected readonly schemaProvider: PreferenceSchemaProvider;
-
-    protected themes: { [id: string]: Theme } = {};
-    protected activeTheme: Theme = NO_THEME;
-    protected readonly themeChange = new Emitter<ThemeChangeEvent>();
-    protected readonly deferredInitializer = new Deferred();
-    get initialized(): Promise<void> {
-        return this.deferredInitializer.promise;
-    }
-
-    readonly onDidColorThemeChange: Event<ThemeChangeEvent> = this.themeChange.event;
-
-    @postConstruct()
-    protected init(): void {
-        this.register(...BuiltinThemeProvider.themes);
-        this.loadUserTheme();
-        this.preferences.ready.then(() => {
-            this.validateActiveTheme();
-            this.updateColorThemePreference();
-            this.preferences.onPreferencesChanged(changes => {
-                if (COLOR_THEME_PREFERENCE_KEY in changes) {
-                    this.validateActiveTheme();
-                }
-            });
-        });
-    }
-
-    register(...themes: Theme[]): Disposable {
-        for (const theme of themes) {
-            this.themes[theme.id] = theme;
-        }
-        this.validateActiveTheme();
-        this.updateColorThemePreference();
-        return Disposable.create(() => {
-            for (const theme of themes) {
-                delete this.themes[theme.id];
-                if (this.activeTheme === theme) {
-                    this.setCurrentTheme(this.defaultTheme.id, false);
-                }
-            }
-            this.updateColorThemePreference();
-        });
-    }
-
-    protected validateActiveTheme(): void {
-        if (this.preferences.isReady) {
-            const configuredTheme = this.getConfiguredTheme();
-            if (configuredTheme && configuredTheme !== this.activeTheme) {
-                this.setCurrentTheme(configuredTheme.id, false);
-            }
-        }
-    }
-
-    protected updateColorThemePreference = debounce(() => this.doUpdateColorThemePreference(), 500);
-
-    protected doUpdateColorThemePreference(): void {
-        const preference = this.schemaProvider.getSchemaProperty(COLOR_THEME_PREFERENCE_KEY);
-        if (preference) {
-            const sortedThemes = this.getThemes().sort((a, b) => a.label.localeCompare(b.label));
-            this.schemaProvider.updateSchemaProperty(COLOR_THEME_PREFERENCE_KEY, {
-                ...preference,
-                enum: sortedThemes.map(e => e.id),
-                enumItemLabels: sortedThemes.map(e => e.label)
-            });
-        }
-    }
-
-    getThemes(): Theme[] {
-        const result = [];
-        for (const o in this.themes) {
-            if (this.themes.hasOwnProperty(o)) {
-                result.push(this.themes[o]);
-            }
-        }
-        return result;
-    }
-
-    getTheme(themeId: string): Theme {
-        return this.themes[themeId] || this.defaultTheme;
-    }
-
-    protected tryGetTheme(themeId: string): Theme | undefined {
-        return this.themes[themeId];
-    }
-
-    /** Should only be called at startup. */
-    loadUserTheme(): void {
-        const storedThemeId = window.localStorage.getItem(ThemeService.STORAGE_KEY) ?? this.defaultTheme.id;
-        const theme = this.getTheme(storedThemeId);
-        this.setCurrentTheme(theme.id, false);
-        this.deferredInitializer.resolve();
-    }
-
-    /**
-     * @param persist If `true`, the value of the `workbench.colorTheme` preference will be set to the provided ID.
-     */
-    setCurrentTheme(themeId: string, persist = true): void {
-        const newTheme = this.tryGetTheme(themeId);
-        const oldTheme = this.activeTheme;
-        if (newTheme && newTheme !== oldTheme) {
-            oldTheme?.deactivate?.();
-            newTheme.activate?.();
-            this.activeTheme = newTheme;
-            this.themeChange.fire({ newTheme, oldTheme });
-        }
-        if (persist) {
-            this.preferences.updateValue(COLOR_THEME_PREFERENCE_KEY, themeId);
-        }
-    }
-
-    getCurrentTheme(): Theme {
-        return this.activeTheme;
-    }
-
-    protected getConfiguredTheme(): Theme | undefined {
-        const configuredId = this.preferences.get<string>(COLOR_THEME_PREFERENCE_KEY);
-        return configuredId ? this.themes[configuredId.toString()] : undefined;
-    }
-
-    /**
-     * The default theme. If that is not applicable, returns with the fallback theme.
-     */
-    get defaultTheme(): Theme {
-        return this.tryGetTheme(DefaultTheme.defaultForOSTheme(FrontendApplicationConfigProvider.get().defaultTheme))
-            ?? this.getTheme(DefaultTheme.defaultForOSTheme(ApplicationProps.DEFAULT.frontend.config.defaultTheme));
-    }
-
-    /**
-     * Resets the state to the user's default, or to the fallback theme. Also discards any persisted state in the local storage.
-     */
-    reset(): void {
-        this.setCurrentTheme(this.defaultTheme.id);
-    }
-}
-
-export class BuiltinThemeProvider {
-
-    static readonly darkTheme: Theme = {
-        id: 'dark',
-        type: 'dark',
-        label: 'Dark (Theia)',
-        editorTheme: 'dark-theia' // loaded in /packages/monaco/src/browser/textmate/monaco-theme-registry.ts
-    };
-
-    static readonly lightTheme: Theme = {
-        id: 'light',
-        type: 'light',
-        label: 'Light (Theia)',
-        editorTheme: 'light-theia' // loaded in /packages/monaco/src/browser/textmate/monaco-theme-registry.ts
-    };
-
-    static readonly hcTheme: Theme = {
-        id: 'hc-theia',
-        type: 'hc',
-        label: 'High Contrast (Theia)',
-        editorTheme: 'hc-theia' // loaded in /packages/monaco/src/browser/textmate/monaco-theme-registry.ts
-    };
-
-    static readonly hcLightTheme: Theme = {
-        id: 'hc-theia-light',
-        type: 'hcLight',
-        label: 'High Contrast Light (Theia)',
-        editorTheme: 'hc-theia-light' // loaded in /packages/monaco/src/browser/textmate/monaco-theme-registry.ts
-    };
-
-    static readonly themes = [
-        BuiltinThemeProvider.darkTheme,
-        BuiltinThemeProvider.lightTheme,
-        BuiltinThemeProvider.hcTheme,
-        BuiltinThemeProvider.hcLightTheme
-    ];
-}
+// *****************************************************************************
+// 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
+// *****************************************************************************
+
+import { Emitter, Event } from '../common/event';
+import { Disposable } from '../common/disposable';
+import { FrontendApplicationConfigProvider } from './frontend-application-config-provider';
+import { ApplicationProps, DefaultTheme } from '@theia/application-package/lib/application-props';
+import { Theme, ThemeChangeEvent } from '../common/theme';
+import { inject, injectable, postConstruct } from 'inversify';
+import { Deferred } from '../common/promise-util';
+import { PreferenceSchemaProvider, PreferenceService } from './preferences';
+import debounce = require('lodash.debounce');
+
+const COLOR_THEME_PREFERENCE_KEY = 'workbench.colorTheme';
+const NO_THEME = { id: 'no-theme', label: 'Not a real theme.', type: 'dark' } as const;
+
+@injectable()
+export class ThemeService {
+    static readonly STORAGE_KEY = 'theme';
+
+    @inject(PreferenceService) protected readonly preferences: PreferenceService;
+    @inject(PreferenceSchemaProvider) protected readonly schemaProvider: PreferenceSchemaProvider;
+
+    protected themes: { [id: string]: Theme } = {};
+    protected activeTheme: Theme = NO_THEME;
+    protected readonly themeChange = new Emitter<ThemeChangeEvent>();
+    protected readonly deferredInitializer = new Deferred();
+    get initialized(): Promise<void> {
+        return this.deferredInitializer.promise;
+    }
+
+    readonly onDidColorThemeChange: Event<ThemeChangeEvent> = this.themeChange.event;
+
+    @postConstruct()
+    protected init(): void {
+        this.register(...BuiltinThemeProvider.themes);
+        this.loadUserTheme();
+        this.preferences.ready.then(() => {
+            this.validateActiveTheme();
+            this.updateColorThemePreference();
+            this.preferences.onPreferencesChanged(changes => {
+                if (COLOR_THEME_PREFERENCE_KEY in changes) {
+                    this.validateActiveTheme();
+                }
+            });
+        });
+    }
+
+    register(...themes: Theme[]): Disposable {
+        for (const theme of themes) {
+            this.themes[theme.id] = theme;
+        }
+        this.validateActiveTheme();
+        this.updateColorThemePreference();
+        return Disposable.create(() => {
+            for (const theme of themes) {
+                delete this.themes[theme.id];
+                if (this.activeTheme === theme) {
+                    this.setCurrentTheme(this.defaultTheme.id, false);
+                }
+            }
+            this.updateColorThemePreference();
+        });
+    }
+
+    protected validateActiveTheme(): void {
+        if (this.preferences.isReady) {
+            const configuredTheme = this.getConfiguredTheme();
+            if (configuredTheme && configuredTheme !== this.activeTheme) {
+                this.setCurrentTheme(configuredTheme.id, false);
+            }
+        }
+    }
+
+    protected updateColorThemePreference = debounce(() => this.doUpdateColorThemePreference(), 500);
+
+    protected doUpdateColorThemePreference(): void {
+        const preference = this.schemaProvider.getSchemaProperty(COLOR_THEME_PREFERENCE_KEY);
+        if (preference) {
+            const sortedThemes = this.getThemes().sort((a, b) => a.label.localeCompare(b.label));
+            this.schemaProvider.updateSchemaProperty(COLOR_THEME_PREFERENCE_KEY, {
+                ...preference,
+                enum: sortedThemes.map(e => e.id),
+                enumItemLabels: sortedThemes.map(e => e.label)
+            });
+        }
+    }
+
+    getThemes(): Theme[] {
+        const result = [];
+        for (const o in this.themes) {
+            if (this.themes.hasOwnProperty(o)) {
+                result.push(this.themes[o]);
+            }
+        }
+        return result;
+    }
+
+    getTheme(themeId: string): Theme {
+        return this.themes[themeId] || this.defaultTheme;
+    }
+
+    protected tryGetTheme(themeId: string): Theme | undefined {
+        return this.themes[themeId];
+    }
+
+    /** Should only be called at startup. */
+    loadUserTheme(): void {
+        const storedThemeId = window.localStorage.getItem(ThemeService.STORAGE_KEY) ?? this.defaultTheme.id;
+        const theme = this.getTheme(storedThemeId);
+        this.setCurrentTheme(theme.id, false);
+        this.deferredInitializer.resolve();
+    }
+
+    /**
+     * @param persist If `true`, the value of the `workbench.colorTheme` preference will be set to the provided ID.
+     */
+    setCurrentTheme(themeId: string, persist = true): void {
+        const newTheme = this.tryGetTheme(themeId);
+        const oldTheme = this.activeTheme;
+        if (newTheme && newTheme !== oldTheme) {
+            oldTheme?.deactivate?.();
+            newTheme.activate?.();
+            this.activeTheme = newTheme;
+            this.themeChange.fire({ newTheme, oldTheme });
+        }
+        if (persist) {
+            this.preferences.updateValue(COLOR_THEME_PREFERENCE_KEY, themeId);
+        }
+    }
+
+    getCurrentTheme(): Theme {
+        return this.activeTheme;
+    }
+
+    protected getConfiguredTheme(): Theme | undefined {
+        const configuredId = this.preferences.get<string>(COLOR_THEME_PREFERENCE_KEY);
+        return configuredId ? this.themes[configuredId.toString()] : undefined;
+    }
+
+    /**
+     * The default theme. If that is not applicable, returns with the fallback theme.
+     */
+    get defaultTheme(): Theme {
+        return this.tryGetTheme(DefaultTheme.defaultForOSTheme(FrontendApplicationConfigProvider.get().defaultTheme))
+            ?? this.getTheme(DefaultTheme.defaultForOSTheme(ApplicationProps.DEFAULT.frontend.config.defaultTheme));
+    }
+
+    /**
+     * Resets the state to the user's default, or to the fallback theme. Also discards any persisted state in the local storage.
+     */
+    reset(): void {
+        this.setCurrentTheme(this.defaultTheme.id);
+    }
+}
+
+export class BuiltinThemeProvider {
+
+    static readonly darkTheme: Theme = {
+        id: 'dark',
+        type: 'dark',
+        label: 'Dark (Theia)',
+        editorTheme: 'dark-theia' // loaded in /packages/monaco/src/browser/textmate/monaco-theme-registry.ts
+    };
+
+    static readonly lightTheme: Theme = {
+        id: 'light',
+        type: 'light',
+        label: 'Light (Theia)',
+        editorTheme: 'light-theia' // loaded in /packages/monaco/src/browser/textmate/monaco-theme-registry.ts
+    };
+
+    static readonly hcTheme: Theme = {
+        id: 'hc-theia',
+        type: 'hc',
+        label: 'High Contrast (Theia)',
+        editorTheme: 'hc-theia' // loaded in /packages/monaco/src/browser/textmate/monaco-theme-registry.ts
+    };
+
+    static readonly hcLightTheme: Theme = {
+        id: 'hc-theia-light',
+        type: 'hcLight',
+        label: 'High Contrast Light (Theia)',
+        editorTheme: 'hc-theia-light' // loaded in /packages/monaco/src/browser/textmate/monaco-theme-registry.ts
+    };
+
+    static readonly themes = [
+        BuiltinThemeProvider.darkTheme,
+        BuiltinThemeProvider.lightTheme,
+        BuiltinThemeProvider.hcTheme,
+        BuiltinThemeProvider.hcLightTheme
+    ];
+}

package/src/browser/tooltip-service.tsx

@@ -1,96 +1,96 @@
-// *****************************************************************************
-// Copyright (C) 2021 Arm 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, inject, optional, postConstruct } from 'inversify';
-import * as React from 'react';
-import ReactTooltip from 'react-tooltip';
-import { ReactRenderer, RendererHost } from './widgets/react-renderer';
-import { CorePreferences } from './core-preferences';
-import { generateUuid } from '../common/uuid';
-
-export const TooltipService = Symbol('TooltipService');
-
-export interface TooltipService {
-    tooltipId: string;
-    attachTo(host: HTMLElement): void;
-    update(fullRender?: boolean): void;
-}
-
-/**
- * Attributes to be added to an HTML element to enable
- * rich HTML tooltip rendering
- */
-export interface TooltipAttributes {
-    /**
-     * HTML to render in the tooltip.
-     */
-    'data-tip': string;
-    /**
-     * The ID of the tooltip renderer. Should be TOOLTIP_ID.
-     */
-    'data-for': string;
-}
-
-const DELAY_PREFERENCE = 'workbench.hover.delay';
-
-@injectable()
-export class TooltipServiceImpl extends ReactRenderer implements TooltipService {
-
-    @inject(CorePreferences)
-    protected readonly corePreferences: CorePreferences;
-
-    public readonly tooltipId: string;
-    protected rendered = false;
-
-    constructor(
-        @inject(RendererHost) @optional() host?: RendererHost
-    ) {
-        super(host);
-        this.tooltipId = generateUuid();
-    }
-
-    @postConstruct()
-    protected init(): void {
-        this.toDispose.push(this.corePreferences.onPreferenceChanged(preference => {
-            if (preference.preferenceName === DELAY_PREFERENCE) {
-                this.update(true);
-            }
-        }));
-    }
-
-    public attachTo(host: HTMLElement): void {
-        host.appendChild(this.host);
-    }
-
-    public update(fullRender = false): void {
-        if (fullRender || !this.rendered) {
-            this.render();
-            this.rendered = true;
-        }
-
-        ReactTooltip.rebuild();
-    }
-
-    protected override doRender(): React.ReactNode {
-        const hoverDelay = this.corePreferences.get(DELAY_PREFERENCE);
-        return <ReactTooltip id={this.tooltipId} className='theia-tooltip' html={true} delayShow={hoverDelay} />;
-    }
-
-    public override dispose(): void {
-        this.toDispose.dispose();
-        super.dispose();
-    }
-}
+// *****************************************************************************
+// Copyright (C) 2021 Arm 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, inject, optional, postConstruct } from 'inversify';
+import * as React from 'react';
+import ReactTooltip from 'react-tooltip';
+import { ReactRenderer, RendererHost } from './widgets/react-renderer';
+import { CorePreferences } from './core-preferences';
+import { generateUuid } from '../common/uuid';
+
+export const TooltipService = Symbol('TooltipService');
+
+export interface TooltipService {
+    tooltipId: string;
+    attachTo(host: HTMLElement): void;
+    update(fullRender?: boolean): void;
+}
+
+/**
+ * Attributes to be added to an HTML element to enable
+ * rich HTML tooltip rendering
+ */
+export interface TooltipAttributes {
+    /**
+     * HTML to render in the tooltip.
+     */
+    'data-tip': string;
+    /**
+     * The ID of the tooltip renderer. Should be TOOLTIP_ID.
+     */
+    'data-for': string;
+}
+
+const DELAY_PREFERENCE = 'workbench.hover.delay';
+
+@injectable()
+export class TooltipServiceImpl extends ReactRenderer implements TooltipService {
+
+    @inject(CorePreferences)
+    protected readonly corePreferences: CorePreferences;
+
+    public readonly tooltipId: string;
+    protected rendered = false;
+
+    constructor(
+        @inject(RendererHost) @optional() host?: RendererHost
+    ) {
+        super(host);
+        this.tooltipId = generateUuid();
+    }
+
+    @postConstruct()
+    protected init(): void {
+        this.toDispose.push(this.corePreferences.onPreferenceChanged(preference => {
+            if (preference.preferenceName === DELAY_PREFERENCE) {
+                this.update(true);
+            }
+        }));
+    }
+
+    public attachTo(host: HTMLElement): void {
+        host.appendChild(this.host);
+    }
+
+    public update(fullRender = false): void {
+        if (fullRender || !this.rendered) {
+            this.render();
+            this.rendered = true;
+        }
+
+        ReactTooltip.rebuild();
+    }
+
+    protected override doRender(): React.ReactNode {
+        const hoverDelay = this.corePreferences.get(DELAY_PREFERENCE);
+        return <ReactTooltip id={this.tooltipId} className='theia-tooltip' html={true} delayShow={hoverDelay} />;
+    }
+
+    public override dispose(): void {
+        this.toDispose.dispose();
+        super.dispose();
+    }
+}