@theia/core 1.18.0 → 1.19.0

package/src/electron-browser/window/electron-window-preferences.ts

@@ -15,7 +15,9 @@
  ********************************************************************************/
 
 import { interfaces } from 'inversify';
+import { nls } from '../../common/nls';
 import { createPreferenceProxy, PreferenceContribution, PreferenceProxy, PreferenceSchema, PreferenceService } from '../../browser/preferences';
+import { isOSX, isWindows } from '../../common';
 
 export namespace ZoomLevel {
     export const DEFAULT = 0;
@@ -36,13 +38,23 @@ export const electronWindowPreferencesSchema: PreferenceSchema = {
             'maximum': ZoomLevel.MAX,
             'scope': 'application',
             // eslint-disable-next-line max-len
-            'description': 'Adjust the zoom level of the window. The original size is 0 and each increment above (e.g. 1.0) or below (e.g. -1.0) represents zooming 20% larger or smaller. You can also enter decimals to adjust the zoom level with a finer granularity.'
+            'description': nls.localize('vscode/desktop.contribution/zoomLevel', 'Adjust the zoom level of the window. The original size is 0 and each increment above (e.g. 1.0) or below (e.g. -1.0) represents zooming 20% larger or smaller. You can also enter decimals to adjust the zoom level with a finer granularity.')
+        },
+        'window.titleBarStyle': {
+            type: 'string',
+            enum: ['native', 'custom'],
+            default: isWindows ? 'custom' : 'native',
+            scope: 'application',
+            // eslint-disable-next-line max-len
+            description: nls.localize('vscode/desktop.contribution/titleBarStyle', 'Adjust the appearance of the window title bar. On Linux and Windows, this setting also affects the application and context menu appearances. Changes require a full restart to apply.'),
+            included: !isOSX
         },
     }
 };
 
 export class ElectronWindowConfiguration {
     'window.zoomLevel': number;
+    'window.titleBarStyle': 'native' | 'custom';
 }
 
 export const ElectronWindowPreferenceContribution = Symbol('ElectronWindowPreferenceContribution');

package/src/electron-browser/window/electron-window-service.ts

@@ -16,7 +16,7 @@
 
 import { injectable, inject, postConstruct } from 'inversify';
 import { remote } from '../../../shared/electron';
-import { NewWindowOptions } from '../../browser/window/window-service';
+import { NewWindowOptions } from '../../common/window';
 import { DefaultWindowService } from '../../browser/window/default-window-service';
 import { ElectronMainWindowService } from '../../electron-common/electron-main-window-service';
 import { ElectronWindowPreferences } from './electron-window-preferences';

package/src/electron-common/electron-main-window-service.ts

@@ -14,8 +14,7 @@
  * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
  ********************************************************************************/
 
-// eslint-disable-next-line @theia/runtime-import-check
-import { NewWindowOptions } from '../browser/window/window-service';
+import { NewWindowOptions } from '../common/window';
 
 export const electronMainWindowServicePath = '/services/electron-window';
 export const ElectronMainWindowService = Symbol('ElectronMainWindowService');

package/src/electron-common/messaging/electron-messages.ts

@@ -0,0 +1,20 @@
+/********************************************************************************
+ * Copyright (C) 2021 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 const RequestTitleBarStyle = 'requestTitleBarStyle';
+export const TitleBarStyleChanged = 'titleBarStyleChanged';
+export const TitleBarStyleAtStartup = 'titleBarStyleAtStartup';
+export const Restart = 'restart';

package/src/electron-main/electron-main-application.ts

@@ -15,7 +15,7 @@
  ********************************************************************************/
 
 import { inject, injectable, named } from 'inversify';
-import { screen, globalShortcut, app, BrowserWindow, BrowserWindowConstructorOptions, Event as ElectronEvent } from '../../shared/electron';
+import { screen, globalShortcut, ipcMain, app, BrowserWindow, BrowserWindowConstructorOptions, Event as ElectronEvent } from '../../shared/electron';
 import * as path from 'path';
 import { Argv } from 'yargs';
 import { AddressInfo } from 'net';
@@ -30,8 +30,9 @@ import { ContributionProvider } from '../common/contribution-provider';
 import { ElectronSecurityTokenService } from './electron-security-token-service';
 import { ElectronSecurityToken } from '../electron-common/electron-token';
 import Storage = require('electron-store');
-// eslint-disable-next-line @theia/runtime-import-check
-import { DEFAULT_WINDOW_HASH } from '../browser/window/window-service';
+import { isOSX, isWindows } from '../common';
+import { RequestTitleBarStyle, Restart, TitleBarStyleAtStartup, TitleBarStyleChanged } from '../electron-common/messaging/electron-messages';
+import { DEFAULT_WINDOW_HASH } from '../common/window';
 
 const createYargs: (argv?: string[], cwd?: string) => Argv = require('yargs/yargs');
 
@@ -182,6 +183,10 @@ export class ElectronMainApplication {
     readonly backendPort = this._backendPort.promise;
 
     protected _config: FrontendApplicationConfig | undefined;
+    protected useNativeWindowFrame: boolean = true;
+    protected didUseNativeWindowFrameOnStart = new Map<number, boolean>();
+    protected restarting = false;
+
     get config(): FrontendApplicationConfig {
         if (!this._config) {
             throw new Error('You have to start the application first.');
@@ -190,6 +195,7 @@ export class ElectronMainApplication {
     }
 
     async start(config: FrontendApplicationConfig): Promise<void> {
+        this.useNativeWindowFrame = this.getTitleBarStyle(config) === 'native';
         this._config = config;
         this.hookApplicationEvents();
         const port = await this.startBackend();
@@ -204,6 +210,23 @@ export class ElectronMainApplication {
         });
     }
 
+    protected getTitleBarStyle(config: FrontendApplicationConfig): 'native' | 'custom' {
+        if (isOSX) {
+            return 'native';
+        }
+        const storedFrame = this.electronStore.get('windowstate')?.frame;
+        if (storedFrame !== undefined) {
+            return !!storedFrame ? 'native' : 'custom';
+        }
+        if (config.preferences && config.preferences['window.titleBarStyle']) {
+            const titleBarStyle = config.preferences['window.titleBarStyle'];
+            if (titleBarStyle === 'native' || titleBarStyle === 'custom') {
+                return titleBarStyle;
+            }
+        }
+        return isWindows ? 'custom' : 'native';
+    }
+
     protected async launch(params: ElectronMainExecutionParams): Promise<void> {
         createYargs(params.argv, params.cwd)
             .command('$0 [file]', false,
@@ -233,6 +256,7 @@ export class ElectronMainApplication {
     async getLastWindowOptions(): Promise<TheiaBrowserWindowOptions> {
         const windowState: TheiaBrowserWindowOptions | undefined = this.electronStore.get('windowstate') || this.getDefaultTheiaWindowOptions();
         return {
+            frame: this.useNativeWindowFrame,
             ...windowState,
             ...this.getDefaultOptions()
         };
@@ -327,6 +351,7 @@ export class ElectronMainApplication {
         const y = Math.round(bounds.y + (bounds.height - height) / 2);
         const x = Math.round(bounds.x + (bounds.width - width) / 2);
         return {
+            frame: this.useNativeWindowFrame,
             isFullScreen: false,
             isMaximized: false,
             width,
@@ -348,31 +373,41 @@ export class ElectronMainApplication {
      * Save the window geometry state on every change.
      */
     protected attachSaveWindowState(electronWindow: BrowserWindow): void {
-        const saveWindowState = () => {
-            try {
-                const bounds = electronWindow.getBounds();
-                this.electronStore.set('windowstate', {
-                    isFullScreen: electronWindow.isFullScreen(),
-                    isMaximized: electronWindow.isMaximized(),
-                    width: bounds.width,
-                    height: bounds.height,
-                    x: bounds.x,
-                    y: bounds.y
-                });
-            } catch (e) {
-                console.error('Error while saving window state:', e);
-            }
-        };
         let delayedSaveTimeout: NodeJS.Timer | undefined;
         const saveWindowStateDelayed = () => {
             if (delayedSaveTimeout) {
                 clearTimeout(delayedSaveTimeout);
             }
-            delayedSaveTimeout = setTimeout(saveWindowState, 1000);
+            delayedSaveTimeout = setTimeout(() => this.saveWindowState(electronWindow), 1000);
         };
-        electronWindow.on('close', saveWindowState);
+        electronWindow.on('close', () => {
+            this.saveWindowState(electronWindow);
+            this.didUseNativeWindowFrameOnStart.delete(electronWindow.id);
+        });
         electronWindow.on('resize', saveWindowStateDelayed);
         electronWindow.on('move', saveWindowStateDelayed);
+        this.didUseNativeWindowFrameOnStart.set(electronWindow.id, this.useNativeWindowFrame);
+    }
+
+    protected saveWindowState(electronWindow: BrowserWindow): void {
+        // In some circumstances the `electronWindow` can be `null`
+        if (!electronWindow) {
+            return;
+        }
+        try {
+            const bounds = electronWindow.getBounds();
+            this.electronStore.set('windowstate', {
+                isFullScreen: electronWindow.isFullScreen(),
+                isMaximized: electronWindow.isMaximized(),
+                width: bounds.width,
+                height: bounds.height,
+                x: bounds.x,
+                y: bounds.y,
+                frame: this.useNativeWindowFrame
+            });
+        } catch (e) {
+            console.error('Error while saving window state:', e);
+        }
     }
 
     /**
@@ -477,6 +512,19 @@ export class ElectronMainApplication {
         app.on('will-quit', this.onWillQuit.bind(this));
         app.on('second-instance', this.onSecondInstance.bind(this));
         app.on('window-all-closed', this.onWindowAllClosed.bind(this));
+
+        ipcMain.on(TitleBarStyleChanged, ({ sender }, titleBarStyle: string) => {
+            this.useNativeWindowFrame = titleBarStyle === 'native';
+            this.saveWindowState(BrowserWindow.fromId(sender.id));
+        });
+
+        ipcMain.on(Restart, ({ sender }) => {
+            this.restart(sender.id);
+        });
+
+        ipcMain.on(RequestTitleBarStyle, ({ sender }) => {
+            sender.send(TitleBarStyleAtStartup, this.didUseNativeWindowFrameOnStart.get(sender.id) ? 'native' : 'custom');
+        });
     }
 
     protected onWillQuit(event: ElectronEvent): void {
@@ -495,7 +543,23 @@ export class ElectronMainApplication {
     }
 
     protected onWindowAllClosed(event: ElectronEvent): void {
-        this.requestStop();
+        if (!this.restarting) {
+            this.requestStop();
+        }
+    }
+
+    protected restart(id: number): void {
+        this.restarting = true;
+        const window = BrowserWindow.fromId(id);
+        window.on('closed', async () => {
+            await this.launch({
+                secondInstance: false,
+                argv: this.processArgv.getProcessArgvWithoutBin(process.argv),
+                cwd: process.cwd()
+            });
+            this.restarting = false;
+        });
+        window.close();
     }
 
     protected async startContributions(): Promise<void> {

package/src/electron-main/electron-main-window-service-impl.ts

@@ -18,8 +18,7 @@ import { shell } from '../../shared/electron';
 import { injectable, inject } from 'inversify';
 import { ElectronMainWindowService } from '../electron-common/electron-main-window-service';
 import { ElectronMainApplication } from './electron-main-application';
-// eslint-disable-next-line @theia/runtime-import-check
-import { NewWindowOptions } from '../browser/window/window-service';
+import { NewWindowOptions } from '../common/window';
 
 @injectable()
 export class ElectronMainWindowServiceImpl implements ElectronMainWindowService {

package/src/electron-main/messaging/electron-messaging-contribution.ts

@@ -22,10 +22,9 @@ import { ContributionProvider } from '../../common/contribution-provider';
 import { WebSocketChannel } from '../../common/messaging/web-socket-channel';
 import { MessagingContribution } from '../../node/messaging/messaging-contribution';
 import { ConsoleLogger } from '../../node/messaging/logger';
-import { THEIA_ELECTRON_IPC_CHANNEL_NAME } from '../../electron-common/messaging/electron-connection-handler';
+import { ElectronConnectionHandler, THEIA_ELECTRON_IPC_CHANNEL_NAME } from '../../electron-common/messaging/electron-connection-handler';
 import { ElectronMainApplicationContribution } from '../electron-main-application';
 import { ElectronMessagingService } from './electron-messaging-service';
-import { ElectronConnectionHandler } from '../../electron-common/messaging/electron-connection-handler';
 
 /**
  * This component replicates the role filled by `MessagingContribution` but for Electron.

package/lib/browser/nls.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"nls.d.ts","sourceRoot":"","sources":["../../src/browser/nls.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;kFAckF;AAyBlF,yBAAiB,GAAG,CAAC;IAEV,MAAM,QAAQ,aAAa,CAAC;IAE5B,MAAM,MAAM,oBAA+F,CAAC;IAEnH,SAAgB,QAAQ,CAAC,GAAG,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,MAAM,EAAE,GAAG,MAAM,CAUrF;CACJ;AAED,wBAAsB,gBAAgB,IAAI,OAAO,CAAC,IAAI,CAAC,CAMtD"}

package/lib/browser/nls.js

@@ -1,64 +0,0 @@
-"use strict";
-/********************************************************************************
- * Copyright (C) 2021 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
- ********************************************************************************/
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.loadTranslations = exports.nls = void 0;
-const endpoint_1 = require("./endpoint");
-let localization;
-function format(message, args) {
-    let result = message;
-    if (args.length > 0) {
-        result = message.replace(/\{(\d+)\}/g, (match, rest) => {
-            const index = rest[0];
-            const arg = args[index];
-            let replacement = match;
-            if (typeof arg === 'string') {
-                replacement = arg;
-            }
-            else if (typeof arg === 'number' || typeof arg === 'boolean' || !arg) {
-                replacement = String(arg);
-            }
-            return replacement;
-        });
-    }
-    return result;
-}
-var nls;
-(function (nls) {
-    nls.localeId = 'localeId';
-    nls.locale = typeof window === 'object' && window && window.localStorage.getItem('localeId') || undefined;
-    function localize(key, defaultValue, ...args) {
-        let value = defaultValue;
-        if (localization) {
-            const translation = localization.translations[key];
-            if (translation) {
-                // vscode's localizations often contain additional '&&' symbols, which we simply ignore
-                value = translation.replace(/&&/g, '');
-            }
-        }
-        return format(value, args);
-    }
-    nls.localize = localize;
-})(nls = exports.nls || (exports.nls = {}));
-async function loadTranslations() {
-    if (nls.locale) {
-        const endpoint = new endpoint_1.Endpoint({ path: '/i18n/' + nls.locale }).getRestUrl().toString();
-        const response = await fetch(endpoint);
-        localization = await response.json();
-    }
-}
-exports.loadTranslations = loadTranslations;
-//# sourceMappingURL=nls.js.map

package/lib/browser/nls.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"nls.js","sourceRoot":"","sources":["../../src/browser/nls.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;kFAckF;;;AAGlF,yCAAsC;AAEtC,IAAI,YAAsC,CAAC;AAE3C,SAAS,MAAM,CAAC,OAAe,EAAE,IAAc;IAC3C,IAAI,MAAM,GAAG,OAAO,CAAC;IACrB,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE;QACjB,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,YAAY,EAAE,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE;YACnD,MAAM,KAAK,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;YACtB,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC;YACxB,IAAI,WAAW,GAAG,KAAK,CAAC;YACxB,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE;gBACzB,WAAW,GAAG,GAAG,CAAC;aACrB;iBAAM,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,OAAO,GAAG,KAAK,SAAS,IAAI,CAAC,GAAG,EAAE;gBACpE,WAAW,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;aAC7B;YACD,OAAO,WAAW,CAAC;QACvB,CAAC,CAAC,CAAC;KACN;IACD,OAAO,MAAM,CAAC;AAClB,CAAC;AAED,IAAiB,GAAG,CAiBnB;AAjBD,WAAiB,GAAG;IAEH,YAAQ,GAAG,UAAU,CAAC;IAEtB,UAAM,GAAG,OAAO,MAAM,KAAK,QAAQ,IAAI,MAAM,IAAI,MAAM,CAAC,YAAY,CAAC,OAAO,CAAC,UAAU,CAAC,IAAI,SAAS,CAAC;IAEnH,SAAgB,QAAQ,CAAC,GAAW,EAAE,YAAoB,EAAE,GAAG,IAAc;QACzE,IAAI,KAAK,GAAG,YAAY,CAAC;QACzB,IAAI,YAAY,EAAE;YACd,MAAM,WAAW,GAAG,YAAY,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC;YACnD,IAAI,WAAW,EAAE;gBACb,uFAAuF;gBACvF,KAAK,GAAG,WAAW,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;aAC1C;SACJ;QACD,OAAO,MAAM,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;IAC/B,CAAC;IAVe,YAAQ,WAUvB,CAAA;AACL,CAAC,EAjBgB,GAAG,GAAH,WAAG,KAAH,WAAG,QAiBnB;AAEM,KAAK,UAAU,gBAAgB;IAClC,IAAI,GAAG,CAAC,MAAM,EAAE;QACZ,MAAM,QAAQ,GAAG,IAAI,mBAAQ,CAAC,EAAE,IAAI,EAAE,QAAQ,GAAG,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC,UAAU,EAAE,CAAC,QAAQ,EAAE,CAAC;QACvF,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,QAAQ,CAAC,CAAC;QACvC,YAAY,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;KACxC;AACL,CAAC;AAND,4CAMC"}

package/src/browser/nls.ts

@@ -1,65 +0,0 @@
-/********************************************************************************
- * Copyright (C) 2021 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 { Localization } from '../common/i18n/localization';
-import { Endpoint } from './endpoint';
-
-let localization: Localization | undefined;
-
-function format(message: string, args: string[]): string {
-    let result = message;
-    if (args.length > 0) {
-        result = message.replace(/\{(\d+)\}/g, (match, rest) => {
-            const index = rest[0];
-            const arg = args[index];
-            let replacement = match;
-            if (typeof arg === 'string') {
-                replacement = arg;
-            } else if (typeof arg === 'number' || typeof arg === 'boolean' || !arg) {
-                replacement = String(arg);
-            }
-            return replacement;
-        });
-    }
-    return result;
-}
-
-export namespace nls {
-
-    export const localeId = 'localeId';
-
-    export const locale = typeof window === 'object' && window && window.localStorage.getItem('localeId') || undefined;
-
-    export function localize(key: string, defaultValue: string, ...args: string[]): string {
-        let value = defaultValue;
-        if (localization) {
-            const translation = localization.translations[key];
-            if (translation) {
-                // vscode's localizations often contain additional '&&' symbols, which we simply ignore
-                value = translation.replace(/&&/g, '');
-            }
-        }
-        return format(value, args);
-    }
-}
-
-export async function loadTranslations(): Promise<void> {
-    if (nls.locale) {
-        const endpoint = new Endpoint({ path: '/i18n/' + nls.locale }).getRestUrl().toString();
-        const response = await fetch(endpoint);
-        localization = await response.json();
-    }
-}