window.ts 27.8 KB
Newer Older
E
Erich Gamma 已提交
1 2 3 4 5 6 7
/*---------------------------------------------------------------------------------------------
 *  Copyright (c) Microsoft Corporation. All rights reserved.
 *  Licensed under the MIT License. See License.txt in the project root for license information.
 *--------------------------------------------------------------------------------------------*/

'use strict';

J
Joao Moreno 已提交
8 9
import * as path from 'path';
import * as objects from 'vs/base/common/objects';
10
import { stopProfiling } from 'vs/base/node/profiler';
11
import nls = require('vs/nls');
12
import URI from "vs/base/common/uri";
13
import { IStorageService } from 'vs/platform/storage/node/storage';
14
import { shell, screen, BrowserWindow, systemPreferences, app } from 'electron';
J
Joao Moreno 已提交
15
import { TPromise, TValueCallback } from 'vs/base/common/winjs.base';
J
Joao Moreno 已提交
16
import { IEnvironmentService, ParsedArgs } from 'vs/platform/environment/common/environment';
17
import { ILogService } from 'vs/platform/log/common/log';
18
import { IConfigurationService } from 'vs/platform/configuration/common/configuration';
J
Joao Moreno 已提交
19
import { parseArgs } from 'vs/platform/environment/node/argv';
20
import product from 'vs/platform/node/product';
21
import { getCommonHTTPHeaders } from 'vs/platform/environment/node/http';
B
Benjamin Pasero 已提交
22
import { IWindowSettings, MenuBarVisibility, IWindowConfiguration, ReadyState } from 'vs/platform/windows/common/windows';
23
import { IDisposable, dispose } from 'vs/base/common/lifecycle';
24
import { KeyboardLayoutMonitor } from 'vs/code/electron-main/keyboard';
B
Benjamin Pasero 已提交
25 26
import { isLinux, isMacintosh, isWindows } from 'vs/base/common/platform';
import { ICodeWindow } from "vs/platform/windows/electron-main/windows";
27
import { IWorkspaceIdentifier, IWorkspacesMainService, IWorkspaceSavedEvent } from "vs/platform/workspaces/common/workspaces";
28
import { IBackupMainService } from "vs/platform/backup/common/backup";
29

E
Erich Gamma 已提交
30 31 32 33 34 35
export interface IWindowState {
	width?: number;
	height?: number;
	x?: number;
	y?: number;
	mode?: WindowMode;
36
	display?: number;
E
Erich Gamma 已提交
37 38
}

39 40
export interface IWindowCreationOptions {
	state: IWindowState;
41
	extensionDevelopmentPath?: string;
42
	isExtensionTestHost?: boolean;
43 44
}

E
Erich Gamma 已提交
45 46 47
export enum WindowMode {
	Maximized,
	Normal,
48
	Minimized, // not used anymore, but also cannot remove due to existing stored UI state (needs migration)
49
	Fullscreen
E
Erich Gamma 已提交
50 51
}

B
Benjamin Pasero 已提交
52
export const defaultWindowState = function (mode = WindowMode.Normal): IWindowState {
E
Erich Gamma 已提交
53 54 55
	return {
		width: 1024,
		height: 768,
56
		mode
E
Erich Gamma 已提交
57 58 59
	};
};

B
Benjamin Pasero 已提交
60 61 62 63 64 65 66 67
interface IWorkbenchEditorConfiguration {
	workbench: {
		editor: {
			swipeToNavigate: boolean
		}
	};
}

B
Benjamin Pasero 已提交
68
export class CodeWindow implements ICodeWindow {
E
Erich Gamma 已提交
69

70
	public static themeStorageKey = 'theme';
71
	public static themeBackgroundStorageKey = 'themeBackground';
72

E
Erich Gamma 已提交
73 74 75
	private static MIN_WIDTH = 200;
	private static MIN_HEIGHT = 120;

B
Benjamin Pasero 已提交
76
	private hiddenTitleBarStyle: boolean;
E
Erich Gamma 已提交
77
	private showTimeoutHandle: any;
B
Benjamin Pasero 已提交
78
	private _id: number;
79
	private _win: Electron.BrowserWindow;
E
Erich Gamma 已提交
80 81 82
	private _lastFocusTime: number;
	private _readyState: ReadyState;
	private windowState: IWindowState;
83
	private currentMenuBarVisibility: MenuBarVisibility;
84
	private toDispose: IDisposable[];
85
	private representedFilename: string;
E
Erich Gamma 已提交
86

B
Benjamin Pasero 已提交
87
	private whenReadyCallbacks: TValueCallback<CodeWindow>[];
E
Erich Gamma 已提交
88 89 90 91

	private currentConfig: IWindowConfiguration;
	private pendingLoadConfig: IWindowConfiguration;

J
Joao Moreno 已提交
92 93 94
	constructor(
		config: IWindowCreationOptions,
		@ILogService private logService: ILogService,
95
		@IEnvironmentService private environmentService: IEnvironmentService,
96
		@IConfigurationService private configurationService: IConfigurationService,
97
		@IStorageService private storageService: IStorageService,
98 99
		@IWorkspacesMainService private workspaceService: IWorkspacesMainService,
		@IBackupMainService private backupService: IBackupMainService
J
Joao Moreno 已提交
100
	) {
E
Erich Gamma 已提交
101 102 103
		this._lastFocusTime = -1;
		this._readyState = ReadyState.NONE;
		this.whenReadyCallbacks = [];
104
		this.toDispose = [];
E
Erich Gamma 已提交
105

B
Benjamin Pasero 已提交
106 107 108 109 110 111 112 113 114 115 116 117
		// create browser window
		this.createBrowserWindow(config);

		// respect configured menu bar visibility
		this.onConfigurationUpdated();

		// Eventing
		this.registerListeners();
	}

	private createBrowserWindow(config: IWindowCreationOptions): void {

E
Erich Gamma 已提交
118
		// Load window state
B
Benjamin Pasero 已提交
119
		this.windowState = this.restoreWindowState(config.state);
E
Erich Gamma 已提交
120

121
		// in case we are maximized or fullscreen, only show later after the call to maximize/fullscreen (see below)
B
Benjamin Pasero 已提交
122
		const isFullscreenOrMaximized = (this.windowState.mode === WindowMode.Maximized || this.windowState.mode === WindowMode.Fullscreen);
123

124
		const options: Electron.BrowserWindowOptions = {
E
Erich Gamma 已提交
125 126 127 128
			width: this.windowState.width,
			height: this.windowState.height,
			x: this.windowState.x,
			y: this.windowState.y,
R
Ryan Adolf 已提交
129
			// backgroundColor: this.getBackgroundColor(),
B
Benjamin Pasero 已提交
130 131
			minWidth: CodeWindow.MIN_WIDTH,
			minHeight: CodeWindow.MIN_HEIGHT,
R
Ryan Adolf 已提交
132
			show: false, //!isFullscreenOrMaximized,
B
Benjamin Pasero 已提交
133
			title: product.nameLong,
134
			webPreferences: {
135 136
				'backgroundThrottling': false, // by default if Code is in the background, intervals and timeouts get throttled,
				disableBlinkFeatures: 'Auxclick' // disable auxclick events (see https://developers.google.com/web/updates/2016/10/auxclick)
R
Ryan Adolf 已提交
137
			},
R
Ryan Adolf 已提交
138 139 140 141 142
			transparent: false,
			frame: false,
			resizable: true,
			thickFrame: true,
			backgroundColor: '#00000000'
E
Erich Gamma 已提交
143 144
		};

145
		if (isLinux) {
146
			options.icon = path.join(this.environmentService.appRoot, 'resources/linux/code.png'); // Windows and Mac are better off using the embedded icon(s)
E
Erich Gamma 已提交
147 148
		}

149 150 151 152 153 154 155 156
		const windowConfig = this.configurationService.getConfiguration<IWindowSettings>('window');

		let useNativeTabs = false;
		if (windowConfig && windowConfig.nativeTabs) {
			options.tabbingIdentifier = product.nameShort; // this opts in to sierra tabs
			useNativeTabs = true;
		}

157
		let useCustomTitleStyle = false;
158
		if (isMacintosh && (!windowConfig || !windowConfig.titleBarStyle || windowConfig.titleBarStyle === 'custom')) {
159
			const isDev = !this.environmentService.isBuilt || !!config.extensionDevelopmentPath;
B
Benjamin Pasero 已提交
160
			if (!isDev) {
161
				useCustomTitleStyle = true; // not enabled when developing due to https://github.com/electron/electron/issues/3647
B
Benjamin Pasero 已提交
162 163 164
			}
		}

165 166 167 168
		if (useNativeTabs) {
			useCustomTitleStyle = false; // native tabs on sierra do not work with custom title style
		}

169 170 171 172 173
		if (useCustomTitleStyle) {
			options.titleBarStyle = 'hidden';
			this.hiddenTitleBarStyle = true;
		}

E
Erich Gamma 已提交
174 175
		// Create the browser window.
		this._win = new BrowserWindow(options);
B
Benjamin Pasero 已提交
176
		this._id = this._win.id;
E
Erich Gamma 已提交
177

178 179 180 181
		if (useCustomTitleStyle) {
			this._win.setSheetOffset(22); // offset dialogs by the height of the custom title bar if we have any
		}

182
		// Set relaunch command
183
		if (isWindows && product.win32AppUserModelId && typeof this._win.setAppDetails === 'function') {
184 185 186 187 188 189 190
			this._win.setAppDetails({
				appId: product.win32AppUserModelId,
				relaunchCommand: `"${process.execPath}" -n`,
				relaunchDisplayName: product.nameLong
			});
		}

191
		if (isFullscreenOrMaximized) {
B
Benjamin Pasero 已提交
192
			this._win.maximize();
E
Erich Gamma 已提交
193

B
Benjamin Pasero 已提交
194
			if (this.windowState.mode === WindowMode.Fullscreen) {
B
Benjamin Pasero 已提交
195
				this._win.setFullScreen(true);
196 197
			}

B
Benjamin Pasero 已提交
198 199
			if (!this._win.isVisible()) {
				this._win.show(); // to reduce flicker from the default window size to maximize, we only show after maximize
E
Erich Gamma 已提交
200 201 202
			}
		}

203
		this._lastFocusTime = Date.now(); // since we show directly, we need to set the last focus time too
E
Erich Gamma 已提交
204 205
	}

206
	public hasHiddenTitleBarStyle(): boolean {
B
Benjamin Pasero 已提交
207
		return this.hiddenTitleBarStyle;
208 209
	}

210
	public get isExtensionDevelopmentHost(): boolean {
211
		return !!this.config.extensionDevelopmentPath;
212 213
	}

214
	public get isExtensionTestHost(): boolean {
215
		return !!this.config.extensionTestsPath;
216 217
	}

218
	public get extensionDevelopmentPath(): string {
219
		return this.config.extensionDevelopmentPath;
E
Erich Gamma 已提交
220 221 222 223 224 225
	}

	public get config(): IWindowConfiguration {
		return this.currentConfig;
	}

B
Benjamin Pasero 已提交
226 227 228 229
	public get id(): number {
		return this._id;
	}

230
	public get win(): Electron.BrowserWindow {
E
Erich Gamma 已提交
231 232 233
		return this._win;
	}

234
	public setRepresentedFilename(filename: string): void {
235
		if (isMacintosh) {
236 237 238 239 240 241 242
			this.win.setRepresentedFilename(filename);
		} else {
			this.representedFilename = filename;
		}
	}

	public getRepresentedFilename(): string {
243
		if (isMacintosh) {
244 245 246 247 248 249
			return this.win.getRepresentedFilename();
		}

		return this.representedFilename;
	}

B
Benjamin Pasero 已提交
250
	public focus(): void {
E
Erich Gamma 已提交
251 252 253 254
		if (!this._win) {
			return;
		}

B
Benjamin Pasero 已提交
255 256
		if (this._win.isMinimized()) {
			this._win.restore();
E
Erich Gamma 已提交
257 258
		}

B
Benjamin Pasero 已提交
259
		this._win.focus();
E
Erich Gamma 已提交
260 261 262 263 264 265
	}

	public get lastFocusTime(): number {
		return this._lastFocusTime;
	}

266 267
	public get backupPath(): string {
		return this.currentConfig ? this.currentConfig.backupPath : void 0;
E
Erich Gamma 已提交
268 269
	}

270
	public get openedWorkspace(): IWorkspaceIdentifier {
271
		return this.currentConfig ? this.currentConfig.workspace : void 0;
272 273
	}

274 275 276 277
	public get openedFolderPath(): string {
		return this.currentConfig ? this.currentConfig.folderPath : void 0;
	}

E
Erich Gamma 已提交
278
	public get openedFilePath(): string {
279
		return this.currentConfig && this.currentConfig.filesToOpen && this.currentConfig.filesToOpen[0] && this.currentConfig.filesToOpen[0].filePath;
E
Erich Gamma 已提交
280 281 282 283 284 285 286 287 288 289 290
	}

	public setReady(): void {
		this._readyState = ReadyState.READY;

		// inform all waiting promises that we are ready now
		while (this.whenReadyCallbacks.length) {
			this.whenReadyCallbacks.pop()(this);
		}
	}

B
Benjamin Pasero 已提交
291 292
	public ready(): TPromise<CodeWindow> {
		return new TPromise<CodeWindow>((c) => {
E
Erich Gamma 已提交
293 294 295 296 297 298 299 300 301 302 303 304 305 306 307
			if (this._readyState === ReadyState.READY) {
				return c(this);
			}

			// otherwise keep and call later when we are ready
			this.whenReadyCallbacks.push(c);
		});
	}

	public get readyState(): ReadyState {
		return this._readyState;
	}

	private registerListeners(): void {

308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343
		// Set common HTTP headers
		// TODO@joao: hook this up to some initialization routine this causes a race between setting the headers and doing
		// a request that needs them. chances are low
		getCommonHTTPHeaders().done(headers => {
			if (!this._win) {
				return;
			}

			const urls = ['https://marketplace.visualstudio.com/*', 'https://*.vsassets.io/*'];

			this._win.webContents.session.webRequest.onBeforeSendHeaders({ urls }, (details, cb) => {
				cb({ cancel: false, requestHeaders: objects.assign(details.requestHeaders, headers) });
			});
		});

		// Prevent loading of svgs
		this._win.webContents.session.webRequest.onBeforeRequest((details, callback) => {
			if (details.url.indexOf('.svg') > 0) {
				const uri = URI.parse(details.url);
				if (uri && !uri.scheme.match(/file/i) && (uri.path as any).endsWith('.svg')) {
					return callback({ cancel: true });
				}
			}

			return callback({});
		});

		this._win.webContents.session.webRequest.onHeadersReceived((details, callback) => {
			const contentType: string[] = (details.responseHeaders['content-type'] || details.responseHeaders['Content-Type']) as any;
			if (contentType && Array.isArray(contentType) && contentType.some(x => x.toLowerCase().indexOf('image/svg') >= 0)) {
				return callback({ cancel: true });
			}

			return callback({ cancel: false, responseHeaders: details.responseHeaders });
		});

E
Erich Gamma 已提交
344 345 346 347 348 349 350 351
		// Remember that we loaded
		this._win.webContents.on('did-finish-load', () => {
			this._readyState = ReadyState.LOADING;

			// Associate properties from the load request if provided
			if (this.pendingLoadConfig) {
				this.currentConfig = this.pendingLoadConfig;

B
Benjamin Pasero 已提交
352
				this.pendingLoadConfig = null;
E
Erich Gamma 已提交
353 354
			}

B
Benjamin Pasero 已提交
355
			// To prevent flashing, we set the window visible after the page has finished to load but before Code is loaded
B
Benjamin Pasero 已提交
356
			if (!this._win.isVisible()) {
B
Benjamin Pasero 已提交
357
				if (this.windowState.mode === WindowMode.Maximized) {
B
Benjamin Pasero 已提交
358
					this._win.maximize();
E
Erich Gamma 已提交
359 360
				}

B
Benjamin Pasero 已提交
361 362
				if (!this._win.isVisible()) { // maximize also makes visible
					this._win.show();
E
Erich Gamma 已提交
363 364 365 366 367
				}
			}
		});

		// App commands support
368
		this.registerNavigationListenerOn('app-command', 'browser-backward', 'browser-forward', false);
E
Erich Gamma 已提交
369 370 371 372 373

		// Handle code that wants to open links
		this._win.webContents.on('new-window', (event: Event, url: string) => {
			event.preventDefault();

B
Benjamin Pasero 已提交
374
			shell.openExternal(url);
E
Erich Gamma 已提交
375 376 377 378
		});

		// Window Focus
		this._win.on('focus', () => {
B
Benjamin Pasero 已提交
379
			this._lastFocusTime = Date.now();
E
Erich Gamma 已提交
380 381
		});

382 383 384 385 386 387 388 389 390
		// Window Fullscreen
		this._win.on('enter-full-screen', () => {
			this.sendWhenReady('vscode:enterFullScreen');
		});

		this._win.on('leave-full-screen', () => {
			this.sendWhenReady('vscode:leaveFullScreen');
		});

E
Erich Gamma 已提交
391 392
		// Window Failed to load
		this._win.webContents.on('did-fail-load', (event: Event, errorCode: string, errorDescription: string) => {
B
Benjamin Pasero 已提交
393
			this.logService.warn('[electron event]: fail to load, ', errorDescription);
E
Erich Gamma 已提交
394 395 396 397
		});

		// Prevent any kind of navigation triggered by the user!
		// But do not touch this in dev version because it will prevent "Reload" from dev tools
398
		if (this.environmentService.isBuilt) {
E
Erich Gamma 已提交
399 400 401 402 403 404
			this._win.webContents.on('will-navigate', (event: Event) => {
				if (event) {
					event.preventDefault();
				}
			});
		}
B
Benjamin Pasero 已提交
405 406

		// Handle configuration changes
B
Benjamin Pasero 已提交
407
		this.toDispose.push(this.configurationService.onDidUpdateConfiguration(e => this.onConfigurationUpdated()));
408

409
		// Handle Workspace events
410
		this.toDispose.push(this.workspaceService.onWorkspaceSaved(e => this.onWorkspaceSaved(e)));
411
		this.toDispose.push(this.workspaceService.onWorkspaceDeleted(e => this.onWorkspaceDeleted(e)));
412 413 414 415 416 417 418
	}

	private onWorkspaceSaved(e: IWorkspaceSavedEvent): void {

		// Make sure to update our workspace config if we detect that it
		// was saved to a new config location
		if (this.openedWorkspace && this.openedWorkspace.id === e.workspace.id && this.openedWorkspace.configPath !== e.workspace.configPath) {
419 420 421 422 423 424 425 426 427 428
			this.currentConfig.workspace.configPath = e.workspace.configPath;
		}
	}

	private onWorkspaceDeleted(workspace: IWorkspaceIdentifier): void {

		// Make sure to update our workspace config if we detect that it
		// was deleted
		if (this.openedWorkspace && this.openedWorkspace.id === workspace.id && this.openedWorkspace.configPath === workspace.configPath) {
			this.currentConfig.workspace = void 0;
429
		}
E
Erich Gamma 已提交
430 431
	}

B
Benjamin Pasero 已提交
432
	private onConfigurationUpdated(): void {
433
		const newMenuBarVisibility = this.getMenuBarVisibility();
B
Benjamin Pasero 已提交
434 435 436 437
		if (newMenuBarVisibility !== this.currentMenuBarVisibility) {
			this.currentMenuBarVisibility = newMenuBarVisibility;
			this.setMenuBarVisibility(newMenuBarVisibility);
		}
438 439

		// Swipe command support (macOS)
440
		if (isMacintosh) {
B
Benjamin Pasero 已提交
441 442
			const config = this.configurationService.getConfiguration<IWorkbenchEditorConfiguration>();
			if (config && config.workbench && config.workbench.editor && config.workbench.editor.swipeToNavigate) {
443
				this.registerNavigationListenerOn('swipe', 'left', 'right', true);
B
Benjamin Pasero 已提交
444 445 446
			} else {
				this._win.removeAllListeners('swipe');
			}
447
		}
B
Benjamin Pasero 已提交
448 449
	};

B
Benjamin Pasero 已提交
450 451 452 453 454 455 456 457 458 459 460 461 462 463
	private registerNavigationListenerOn(command: 'swipe' | 'app-command', back: 'left' | 'browser-backward', forward: 'right' | 'browser-forward', acrossEditors: boolean) {
		this._win.on(command, (e, cmd) => {
			if (this.readyState !== ReadyState.READY) {
				return; // window must be ready
			}

			if (cmd === back) {
				this.send('vscode:runAction', acrossEditors ? 'workbench.action.openPreviousRecentlyUsedEditor' : 'workbench.action.navigateBack');
			} else if (cmd === forward) {
				this.send('vscode:runAction', acrossEditors ? 'workbench.action.openNextRecentlyUsedEditor' : 'workbench.action.navigateForward');
			}
		});
	}

464
	public load(config: IWindowConfiguration, isReload?: boolean): void {
E
Erich Gamma 已提交
465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480

		// If this is the first time the window is loaded, we associate the paths
		// directly with the window because we assume the loading will just work
		if (this.readyState === ReadyState.NONE) {
			this.currentConfig = config;
		}

		// Otherwise, the window is currently showing a folder and if there is an
		// unload handler preventing the load, we cannot just associate the paths
		// because the loading might be vetoed. Instead we associate it later when
		// the window load event has fired.
		else {
			this.pendingLoadConfig = config;
			this._readyState = ReadyState.NAVIGATING;
		}

481
		// Clear Document Edited if needed
482
		if (isMacintosh && this._win.isDocumentEdited()) {
483 484 485 486 487 488 489 490 491 492 493 494
			if (!isReload || !this.backupService.isHotExitEnabled()) {
				this._win.setDocumentEdited(false);
			}
		}

		// Clear Title and Filename if needed
		if (!isReload) {
			if (this.getRepresentedFilename()) {
				this.setRepresentedFilename('');
			}

			this._win.setTitle(product.nameLong);
495 496
		}

E
Erich Gamma 已提交
497
		// Load URL
B
Benjamin Pasero 已提交
498
		this._win.loadURL(this.getUrl(config));
E
Erich Gamma 已提交
499 500

		// Make window visible if it did not open in N seconds because this indicates an error
501 502
		// Only do this when running out of sources and not when running tests
		if (!this.environmentService.isBuilt && !this.environmentService.extensionTestsPath) {
E
Erich Gamma 已提交
503 504 505 506
			this.showTimeoutHandle = setTimeout(() => {
				if (this._win && !this._win.isVisible() && !this._win.isMinimized()) {
					this._win.show();
					this._win.focus();
507
					this._win.webContents.openDevTools();
E
Erich Gamma 已提交
508 509 510
				}
			}, 10000);
		}
511

J
Johannes Rieken 已提交
512 513 514
		// (--prof-startup) save profile to disk
		const { profileStartup } = this.environmentService;
		if (profileStartup) {
B
Benjamin Pasero 已提交
515
			stopProfiling(profileStartup.dir, profileStartup.prefix).done(undefined, err => this.logService.error(err));
516
		}
E
Erich Gamma 已提交
517 518
	}

B
Benjamin Pasero 已提交
519
	public reload(cli?: ParsedArgs): void {
E
Erich Gamma 已提交
520 521

		// Inherit current properties but overwrite some
522
		const configuration: IWindowConfiguration = objects.mixin({}, this.currentConfig);
E
Erich Gamma 已提交
523 524
		delete configuration.filesToOpen;
		delete configuration.filesToCreate;
525
		delete configuration.filesToDiff;
526

E
Erich Gamma 已提交
527
		// Some configuration things get inherited if the window is being reloaded and we are
B
Benjamin Pasero 已提交
528
		// in extension development mode. These options are all development related.
529
		if (this.isExtensionDevelopmentHost && cli) {
B
Benjamin Pasero 已提交
530
			configuration.verbose = cli.verbose;
531
			configuration.debugPluginHost = cli.debugPluginHost;
532
			configuration.debugBrkPluginHost = cli.debugBrkPluginHost;
533
			configuration.debugId = cli.debugId;
534
			configuration['extensions-dir'] = cli['extensions-dir'];
E
Erich Gamma 已提交
535 536
		}

537 538
		configuration.isInitialStartup = false; // since this is a reload

E
Erich Gamma 已提交
539
		// Load config
540
		this.load(configuration, true);
E
Erich Gamma 已提交
541 542
	}

543
	private getUrl(windowConfiguration: IWindowConfiguration): string {
E
Erich Gamma 已提交
544

545
		// Set zoomlevel
546 547
		const windowConfig = this.configurationService.getConfiguration<IWindowSettings>('window');
		const zoomLevel = windowConfig && windowConfig.zoomLevel;
548 549 550 551
		if (typeof zoomLevel === 'number') {
			windowConfiguration.zoomLevel = zoomLevel;
		}

552 553 554
		// Set fullscreen state
		windowConfiguration.fullscreen = this._win.isFullScreen();

555
		// Set Accessibility Config
556
		windowConfiguration.highContrast = isWindows && systemPreferences.isInvertedColorScheme() && (!windowConfig || windowConfig.autoDetectHighContrast);
557 558
		windowConfiguration.accessibilitySupport = app.isAccessibilitySupportEnabled();

559 560 561
		// Set Keyboard Config
		windowConfiguration.isISOKeyboard = KeyboardLayoutMonitor.INSTANCE.isISOKeyboard();

562 563
		// Theme
		windowConfiguration.baseTheme = this.getBaseTheme();
564
		windowConfiguration.backgroundColor = this.getBackgroundColor();
M
Martin Aeschlimann 已提交
565

566 567
		// Perf Counters
		windowConfiguration.perfStartTime = global.perfStartTime;
568
		windowConfiguration.perfAppReady = global.perfAppReady;
569
		windowConfiguration.perfWindowLoadTime = Date.now();
570

571 572 573
		// Config (combination of process.argv and window configuration)
		const environment = parseArgs(process.argv);
		const config = objects.assign(environment, windowConfiguration);
574 575 576 577 578
		for (let key in config) {
			if (!config[key]) {
				delete config[key]; // only send over properties that have a true value
			}
		}
579

B
Benjamin Pasero 已提交
580
		return `${require.toUrl('vs/workbench/electron-browser/bootstrap/index.html')}?config=${encodeURIComponent(JSON.stringify(config))}`;
E
Erich Gamma 已提交
581 582
	}

583
	private getBaseTheme(): string {
584
		if (isWindows && systemPreferences.isInvertedColorScheme()) {
585 586
			return 'hc-black';
		}
B
Benjamin Pasero 已提交
587

B
Benjamin Pasero 已提交
588
		const theme = this.storageService.getItem<string>(CodeWindow.themeStorageKey, 'vs-dark');
B
Benjamin Pasero 已提交
589

590 591 592
		return theme.split(' ')[0];
	}

593
	private getBackgroundColor(): string {
594
		if (isWindows && systemPreferences.isInvertedColorScheme()) {
595 596 597
			return '#000000';
		}

B
Benjamin Pasero 已提交
598
		const background = this.storageService.getItem<string>(CodeWindow.themeBackgroundStorageKey, null);
599
		if (!background) {
B
Benjamin Pasero 已提交
600 601
			const baseTheme = this.getBaseTheme();

602
			return baseTheme === 'hc-black' ? '#000000' : (baseTheme === 'vs' ? '#FFFFFF' : (isMacintosh ? '#171717' : '#1E1E1E')); // https://github.com/electron/electron/issues/5150
603 604 605 606 607
		}

		return background;
	}

E
Erich Gamma 已提交
608
	public serializeWindowState(): IWindowState {
609 610

		// fullscreen gets special treatment
B
Benjamin Pasero 已提交
611
		if (this._win.isFullScreen()) {
612 613
			const display = screen.getDisplayMatching(this.getBounds());

614
			return {
615
				mode: WindowMode.Fullscreen,
616 617
				display: display ? display.id : void 0,

618 619 620 621 622
				// still carry over window dimensions from previous sessions!
				width: this.windowState.width,
				height: this.windowState.height,
				x: this.windowState.x,
				y: this.windowState.y
623
			};
E
Erich Gamma 已提交
624 625
		}

626
		const state: IWindowState = Object.create(null);
E
Erich Gamma 已提交
627 628 629
		let mode: WindowMode;

		// get window mode
630
		if (!isMacintosh && this._win.isMaximized()) {
E
Erich Gamma 已提交
631 632 633 634 635 636 637 638
			mode = WindowMode.Maximized;
		} else {
			mode = WindowMode.Normal;
		}

		// we don't want to save minimized state, only maximized or normal
		if (mode === WindowMode.Maximized) {
			state.mode = WindowMode.Maximized;
639
		} else {
E
Erich Gamma 已提交
640 641 642 643 644
			state.mode = WindowMode.Normal;
		}

		// only consider non-minimized window states
		if (mode === WindowMode.Normal || mode === WindowMode.Maximized) {
645
			const bounds = this.getBounds();
E
Erich Gamma 已提交
646

647 648 649 650
			state.x = bounds.x;
			state.y = bounds.y;
			state.width = bounds.width;
			state.height = bounds.height;
E
Erich Gamma 已提交
651 652 653 654 655
		}

		return state;
	}

B
Benjamin Pasero 已提交
656
	private restoreWindowState(state?: IWindowState): IWindowState {
E
Erich Gamma 已提交
657 658 659 660
		if (state) {
			try {
				state = this.validateWindowState(state);
			} catch (err) {
J
Joao Moreno 已提交
661
				this.logService.log(`Unexpected error validating window state: ${err}\n${err.stack}`); // somehow display API can be picky about the state to validate
E
Erich Gamma 已提交
662 663 664 665 666 667 668
			}
		}

		if (!state) {
			state = defaultWindowState();
		}

B
Benjamin Pasero 已提交
669
		return state;
E
Erich Gamma 已提交
670 671 672 673 674 675 676 677 678 679 680 681 682 683 684
	}

	private validateWindowState(state: IWindowState): IWindowState {
		if (!state) {
			return null;
		}

		if ([state.x, state.y, state.width, state.height].some(n => typeof n !== 'number')) {
			return null;
		}

		if (state.width <= 0 || state.height <= 0) {
			return null;
		}

685
		const displays = screen.getAllDisplays();
E
Erich Gamma 已提交
686 687 688

		// Single Monitor: be strict about x/y positioning
		if (displays.length === 1) {
689
			const displayBounds = displays[0].bounds;
E
Erich Gamma 已提交
690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724

			// Careful with maximized: in that mode x/y can well be negative!
			if (state.mode !== WindowMode.Maximized && displayBounds.width > 0 && displayBounds.height > 0 /* Linux X11 sessions sometimes report wrong display bounds */) {
				if (state.x < displayBounds.x) {
					state.x = displayBounds.x; // prevent window from falling out of the screen to the left
				}

				if (state.y < displayBounds.y) {
					state.y = displayBounds.y; // prevent window from falling out of the screen to the top
				}

				if (state.x > (displayBounds.x + displayBounds.width)) {
					state.x = displayBounds.x; // prevent window from falling out of the screen to the right
				}

				if (state.y > (displayBounds.y + displayBounds.height)) {
					state.y = displayBounds.y; // prevent window from falling out of the screen to the bottom
				}

				if (state.width > displayBounds.width) {
					state.width = displayBounds.width; // prevent window from exceeding display bounds width
				}

				if (state.height > displayBounds.height) {
					state.height = displayBounds.height; // prevent window from exceeding display bounds height
				}
			}

			if (state.mode === WindowMode.Maximized) {
				return defaultWindowState(WindowMode.Maximized); // when maximized, make sure we have good values when the user restores the window
			}

			return state;
		}

725 726 727 728 729 730 731 732 733 734 735 736 737
		// Multi Montior (fullscreen): try to find the previously used display
		if (state.display && state.mode === WindowMode.Fullscreen) {
			const display = displays.filter(d => d.id === state.display)[0];
			if (display && display.bounds && typeof display.bounds.x === 'number' && typeof display.bounds.y === 'number') {
				const defaults = defaultWindowState(WindowMode.Fullscreen); // make sure we have good values when the user restores the window
				defaults.x = display.bounds.x; // carefull to use displays x/y position so that the window ends up on the correct monitor
				defaults.y = display.bounds.y;

				return defaults;
			}
		}

		// Multi Monitor (non-fullscreen): be less strict because metrics can be crazy
738 739
		const bounds = { x: state.x, y: state.y, width: state.width, height: state.height };
		const display = screen.getDisplayMatching(bounds);
E
Erich Gamma 已提交
740 741
		if (display && display.bounds.x + display.bounds.width > bounds.x && display.bounds.y + display.bounds.height > bounds.y) {
			if (state.mode === WindowMode.Maximized) {
742
				const defaults = defaultWindowState(WindowMode.Maximized); // when maximized, make sure we have good values when the user restores the window
E
Erich Gamma 已提交
743 744 745 746 747 748 749 750 751 752 753 754
				defaults.x = state.x; // carefull to keep x/y position so that the window ends up on the correct monitor
				defaults.y = state.y;

				return defaults;
			}

			return state;
		}

		return null;
	}

B
Benjamin Pasero 已提交
755
	public getBounds(): Electron.Rectangle {
B
Benjamin Pasero 已提交
756 757
		const pos = this._win.getPosition();
		const dimension = this._win.getSize();
E
Erich Gamma 已提交
758 759 760 761 762

		return { x: pos[0], y: pos[1], width: dimension[0], height: dimension[1] };
	}

	public toggleFullScreen(): void {
B
Benjamin Pasero 已提交
763
		const willBeFullScreen = !this._win.isFullScreen();
E
Erich Gamma 已提交
764

B
Benjamin Pasero 已提交
765
		// set fullscreen flag on window
B
Benjamin Pasero 已提交
766
		this._win.setFullScreen(willBeFullScreen);
767

768
		// respect configured menu bar visibility or default to toggle if not set
769
		this.setMenuBarVisibility(this.currentMenuBarVisibility, false);
B
Benjamin Pasero 已提交
770 771
	}

772
	private getMenuBarVisibility(): MenuBarVisibility {
773
		const windowConfig = this.configurationService.getConfiguration<IWindowSettings>('window');
B
Benjamin Pasero 已提交
774
		if (!windowConfig || !windowConfig.menuBarVisibility) {
775
			return 'default';
B
Benjamin Pasero 已提交
776 777 778 779
		}

		let menuBarVisibility = windowConfig.menuBarVisibility;
		if (['visible', 'toggle', 'hidden'].indexOf(menuBarVisibility) < 0) {
780
			menuBarVisibility = 'default';
B
Benjamin Pasero 已提交
781 782 783
		}

		return menuBarVisibility;
E
Erich Gamma 已提交
784 785
	}

786
	public setMenuBarVisibility(visibility: MenuBarVisibility, notify: boolean = true): void {
787
		if (isMacintosh) {
B
Benjamin Pasero 已提交
788 789 790
			return; // ignore for macOS platform
		}

B
Benjamin Pasero 已提交
791
		const isFullscreen = this._win.isFullScreen();
792

793
		switch (visibility) {
794
			case ('default'):
B
Benjamin Pasero 已提交
795 796
				this._win.setMenuBarVisibility(!isFullscreen);
				this._win.setAutoHideMenuBar(isFullscreen);
797 798
				break;

D
David Terry 已提交
799
			case ('visible'):
B
Benjamin Pasero 已提交
800 801
				this._win.setMenuBarVisibility(true);
				this._win.setAutoHideMenuBar(false);
802
				break;
D
David Terry 已提交
803 804

			case ('toggle'):
B
Benjamin Pasero 已提交
805 806
				this._win.setMenuBarVisibility(false);
				this._win.setAutoHideMenuBar(true);
807

808 809 810
				if (notify) {
					this.send('vscode:showInfoMessage', nls.localize('hiddenMenuBar', "You can still access the menu bar by pressing the **Alt** key."));
				};
811
				break;
D
David Terry 已提交
812 813

			case ('hidden'):
814 815 816 817 818 819
				// for some weird reason that I have no explanation for, the menu bar is not hiding when calling
				// this without timeout (see https://github.com/Microsoft/vscode/issues/19777). there seems to be
				// a timing issue with us opening the first window and the menu bar getting created. somehow the
				// fact that we want to hide the menu without being able to bring it back via Alt key makes Electron
				// still show the menu. Unable to reproduce from a simple Hello World application though...
				setTimeout(() => {
B
Benjamin Pasero 已提交
820 821
					this._win.setMenuBarVisibility(false);
					this._win.setAutoHideMenuBar(false);
822
				});
823 824
				break;
		};
825 826
	}

827 828 829
	public onWindowTitleDoubleClick(): void {

		// Respect system settings on mac with regards to title click on windows title
830
		if (isMacintosh) {
831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853
			const action = systemPreferences.getUserDefault('AppleActionOnDoubleClick', 'string');
			switch (action) {
				case 'Minimize':
					this.win.minimize();
					break;
				case 'None':
					break;
				case 'Maximize':
				default:
					this.win.maximize();
			}
		}

		// Linux/Windows: just toggle maximize/minimized state
		else {
			if (this.win.isMaximized()) {
				this.win.unmaximize();
			} else {
				this.win.maximize();
			}
		}
	}

854 855 856 857 858 859
	public close(): void {
		if (this._win) {
			this._win.close();
		}
	}

860 861 862 863 864 865 866 867 868 869
	public sendWhenReady(channel: string, ...args: any[]): void {
		this.ready().then(() => {
			this.send(channel, ...args);
		});
	}

	public send(channel: string, ...args: any[]): void {
		this._win.webContents.send(channel, ...args);
	}

E
Erich Gamma 已提交
870 871 872 873 874
	public dispose(): void {
		if (this.showTimeoutHandle) {
			clearTimeout(this.showTimeoutHandle);
		}

875 876
		this.toDispose = dispose(this.toDispose);

E
Erich Gamma 已提交
877 878
		this._win = null; // Important to dereference the window object to allow for GC
	}
R
Ryan Adolf 已提交
879
}