window.ts 24.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 10
import * as path from 'path';
import * as platform from 'vs/base/common/platform';
import * as objects from 'vs/base/common/objects';
11
import { stopProfiling } from 'vs/base/node/profiler';
12
import nls = require('vs/nls');
13
import { IStorageService } from 'vs/code/electron-main/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';
B
Benjamin Pasero 已提交
17
import { ILogService } from 'vs/code/electron-main/log';
18
import { IConfigurationService } from 'vs/platform/configuration/common/configuration';
19
import { IWorkbenchEditorConfiguration } from 'vs/workbench/common/editor';
J
Joao Moreno 已提交
20
import { parseArgs } from 'vs/platform/environment/node/argv';
21
import product from 'vs/platform/node/product';
22
import { getCommonHTTPHeaders } from 'vs/platform/environment/node/http';
23
import { IWindowSettings, MenuBarVisibility } from 'vs/platform/windows/common/windows';
24
import { IDisposable, dispose } from 'vs/base/common/lifecycle';
E
Erich Gamma 已提交
25

26

E
Erich Gamma 已提交
27 28 29 30 31 32 33 34
export interface IWindowState {
	width?: number;
	height?: number;
	x?: number;
	y?: number;
	mode?: WindowMode;
}

35 36
export interface IWindowCreationOptions {
	state: IWindowState;
37
	extensionDevelopmentPath?: string;
38
	isExtensionTestHost?: boolean;
39 40
}

E
Erich Gamma 已提交
41 42 43
export enum WindowMode {
	Maximized,
	Normal,
44 45
	Minimized,
	Fullscreen
E
Erich Gamma 已提交
46 47
}

B
Benjamin Pasero 已提交
48
export const defaultWindowState = function (mode = WindowMode.Normal): IWindowState {
E
Erich Gamma 已提交
49 50 51
	return {
		width: 1024,
		height: 768,
52
		mode
E
Erich Gamma 已提交
53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73
	};
};

export interface IPath {

	// the workspace spath for a VSCode instance which can be null
	workspacePath?: string;

	// the file path to open within a VSCode instance
	filePath?: string;

	// the line number in the file path to open
	lineNumber?: number;

	// the column number in the file path to open
	columnNumber?: number;

	// indicator to create the file path in the VSCode instance
	createFilePath?: boolean;
}

B
Benjamin Pasero 已提交
74
export interface IWindowConfiguration extends ParsedArgs {
75 76 77
	appRoot: string;
	execPath: string;

78
	userEnv: platform.IProcessEnvironment;
B
Benjamin Pasero 已提交
79

A
Alex Dima 已提交
80 81 82 83
	/**
	 * The physical keyboard is of ISO type (on OSX)
	 */
	isISOKeyboard?: boolean;
84
	zoomLevel?: number;
85
	fullscreen?: boolean;
86
	highContrast?: boolean;
M
Martin Aeschlimann 已提交
87
	baseTheme?: string;
88
	backgroundColor?: string;
89 90 91 92 93
	accessibilitySupport?: boolean;

	isInitialStartup?: boolean;

	perfStartTime?: number;
94
	perfAppReady?: number;
95
	perfWindowLoadTime?: number;
96

B
Benjamin Pasero 已提交
97
	workspacePath?: string;
98

E
Erich Gamma 已提交
99 100
	filesToOpen?: IPath[];
	filesToCreate?: IPath[];
101
	filesToDiff?: IPath[];
102 103

	nodeCachedDataDir: string;
E
Erich Gamma 已提交
104 105
}

B
Benjamin Pasero 已提交
106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128
export enum ReadyState {

	/**
	 * This window has not loaded any HTML yet
	 */
	NONE,

	/**
	 * This window is loading HTML
	 */
	LOADING,

	/**
	 * This window is navigating to another HTML
	 */
	NAVIGATING,

	/**
	 * This window is done loading HTML
	 */
	READY
}

129 130
interface IConfiguration {
	window: {
131
		menuBarVisibility: MenuBarVisibility;
132 133 134
	};
}

135
export class VSCodeWindow {
E
Erich Gamma 已提交
136

137
	public static themeStorageKey = 'theme';
138
	public static themeBackgroundStorageKey = 'themeBackground';
139

E
Erich Gamma 已提交
140 141 142
	private static MIN_WIDTH = 200;
	private static MIN_HEIGHT = 120;

143
	private options: IWindowCreationOptions;
B
Benjamin Pasero 已提交
144
	private hiddenTitleBarStyle: boolean;
E
Erich Gamma 已提交
145
	private showTimeoutHandle: any;
B
Benjamin Pasero 已提交
146
	private _id: number;
147
	private _win: Electron.BrowserWindow;
E
Erich Gamma 已提交
148 149
	private _lastFocusTime: number;
	private _readyState: ReadyState;
150
	private _extensionDevelopmentPath: string;
151
	private _isExtensionTestHost: boolean;
E
Erich Gamma 已提交
152
	private windowState: IWindowState;
153
	private currentMenuBarVisibility: MenuBarVisibility;
E
Erich Gamma 已提交
154
	private currentWindowMode: WindowMode;
155
	private toDispose: IDisposable[];
E
Erich Gamma 已提交
156 157 158 159 160 161

	private whenReadyCallbacks: TValueCallback<VSCodeWindow>[];

	private currentConfig: IWindowConfiguration;
	private pendingLoadConfig: IWindowConfiguration;

J
Joao Moreno 已提交
162 163 164
	constructor(
		config: IWindowCreationOptions,
		@ILogService private logService: ILogService,
165
		@IEnvironmentService private environmentService: IEnvironmentService,
166 167
		@IConfigurationService private configurationService: IConfigurationService,
		@IStorageService private storageService: IStorageService
J
Joao Moreno 已提交
168
	) {
169
		this.options = config;
E
Erich Gamma 已提交
170 171
		this._lastFocusTime = -1;
		this._readyState = ReadyState.NONE;
172
		this._extensionDevelopmentPath = config.extensionDevelopmentPath;
173
		this._isExtensionTestHost = config.isExtensionTestHost;
E
Erich Gamma 已提交
174
		this.whenReadyCallbacks = [];
175
		this.toDispose = [];
E
Erich Gamma 已提交
176 177

		// Load window state
178
		this.restoreWindowState(config.state);
E
Erich Gamma 已提交
179

180 181 182
		// in case we are maximized or fullscreen, only show later after the call to maximize/fullscreen (see below)
		const isFullscreenOrMaximized = (this.currentWindowMode === WindowMode.Maximized || this.currentWindowMode === WindowMode.Fullscreen);

183
		const options: Electron.BrowserWindowOptions = {
E
Erich Gamma 已提交
184 185 186 187
			width: this.windowState.width,
			height: this.windowState.height,
			x: this.windowState.x,
			y: this.windowState.y,
188
			backgroundColor: this.getBackgroundColor(),
189 190
			minWidth: VSCodeWindow.MIN_WIDTH,
			minHeight: VSCodeWindow.MIN_HEIGHT,
191
			show: !isFullscreenOrMaximized,
B
Benjamin Pasero 已提交
192
			title: product.nameLong,
193
			webPreferences: {
194 195
				'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)
196
			}
E
Erich Gamma 已提交
197 198
		};

J
Joao Moreno 已提交
199
		if (platform.isLinux) {
200
			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 已提交
201 202
		}

203 204 205 206 207 208 209 210
		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;
		}

211
		let useCustomTitleStyle = false;
212
		if (platform.isMacintosh && (!windowConfig || !windowConfig.titleBarStyle || windowConfig.titleBarStyle === 'custom')) {
213
			const isDev = !this.environmentService.isBuilt || !!config.extensionDevelopmentPath;
B
Benjamin Pasero 已提交
214
			if (!isDev) {
215
				useCustomTitleStyle = true; // not enabled when developing due to https://github.com/electron/electron/issues/3647
B
Benjamin Pasero 已提交
216 217 218
			}
		}

219 220 221 222
		if (useNativeTabs) {
			useCustomTitleStyle = false; // native tabs on sierra do not work with custom title style
		}

223 224 225 226 227
		if (useCustomTitleStyle) {
			options.titleBarStyle = 'hidden';
			this.hiddenTitleBarStyle = true;
		}

E
Erich Gamma 已提交
228 229
		// Create the browser window.
		this._win = new BrowserWindow(options);
B
Benjamin Pasero 已提交
230
		this._id = this._win.id;
E
Erich Gamma 已提交
231

232 233 234 235
		if (useCustomTitleStyle) {
			this._win.setSheetOffset(22); // offset dialogs by the height of the custom title bar if we have any
		}

236 237 238 239 240 241 242 243 244
		// Set relaunch command
		if (platform.isWindows && product.win32AppUserModelId && typeof this._win.setAppDetails === 'function') {
			this._win.setAppDetails({
				appId: product.win32AppUserModelId,
				relaunchCommand: `"${process.execPath}" -n`,
				relaunchDisplayName: product.nameLong
			});
		}

245
		if (isFullscreenOrMaximized) {
E
Erich Gamma 已提交
246 247
			this.win.maximize();

248 249 250 251
			if (this.currentWindowMode === WindowMode.Fullscreen) {
				this.win.setFullScreen(true);
			}

E
Erich Gamma 已提交
252 253 254 255 256
			if (!this.win.isVisible()) {
				this.win.show(); // to reduce flicker from the default window size to maximize, we only show after maximize
			}
		}

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

259
		// respect configured menu bar visibility
B
Benjamin Pasero 已提交
260
		this.onConfigurationUpdated();
261

B
Benjamin Pasero 已提交
262
		// TODO@joao: hook this up to some initialization routine this causes a race between setting the headers and doing
B
Benjamin Pasero 已提交
263 264 265
		// a request that needs them. chances are low
		this.setCommonHTTPHeaders();

B
Benjamin Pasero 已提交
266
		// Eventing
E
Erich Gamma 已提交
267 268 269
		this.registerListeners();
	}

B
Benjamin Pasero 已提交
270 271 272 273 274 275 276 277 278 279 280 281 282 283
	private setCommonHTTPHeaders(): void {
		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) });
			});
		});
	}

284
	public hasHiddenTitleBarStyle(): boolean {
B
Benjamin Pasero 已提交
285
		return this.hiddenTitleBarStyle;
286 287
	}

288
	public get isExtensionDevelopmentHost(): boolean {
289 290 291
		return !!this._extensionDevelopmentPath;
	}

292 293 294 295
	public get isExtensionTestHost(): boolean {
		return this._isExtensionTestHost;
	}

296 297
	public get extensionDevelopmentPath(): string {
		return this._extensionDevelopmentPath;
E
Erich Gamma 已提交
298 299 300 301 302 303
	}

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

B
Benjamin Pasero 已提交
304 305 306 307
	public get id(): number {
		return this._id;
	}

308
	public get win(): Electron.BrowserWindow {
E
Erich Gamma 已提交
309 310 311
		return this._win;
	}

B
Benjamin Pasero 已提交
312
	public focus(): void {
E
Erich Gamma 已提交
313 314 315 316
		if (!this._win) {
			return;
		}

B
Benjamin Pasero 已提交
317 318
		if (this._win.isMinimized()) {
			this._win.restore();
E
Erich Gamma 已提交
319 320
		}

B
Benjamin Pasero 已提交
321
		this._win.focus();
E
Erich Gamma 已提交
322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359
	}

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

	public get openedWorkspacePath(): string {
		return this.currentConfig.workspacePath;
	}

	public get openedFilePath(): string {
		return this.currentConfig.filesToOpen && this.currentConfig.filesToOpen[0] && this.currentConfig.filesToOpen[0].filePath;
	}

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

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

	public ready(): TPromise<VSCodeWindow> {
		return new TPromise<VSCodeWindow>((c) => {
			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;
	}

360
	private registerNavigationListenerOn(command: 'swipe' | 'app-command', back: 'left' | 'browser-backward', forward: 'right' | 'browser-forward', acrossEditors: boolean) {
361 362 363 364 365 366
		this._win.on(command, (e, cmd) => {
			if (this.readyState !== ReadyState.READY) {
				return; // window must be ready
			}

			if (cmd === back) {
367
				this.send('vscode:runAction', acrossEditors ? 'workbench.action.openPreviousRecentlyUsedEditor' : 'workbench.action.navigateBack');
368
			} else if (cmd === forward) {
369
				this.send('vscode:runAction', acrossEditors ? 'workbench.action.openNextRecentlyUsedEditor' : 'workbench.action.navigateForward');
370 371 372
			}
		});
	}
B
Benjamin Pasero 已提交
373

E
Erich Gamma 已提交
374 375 376 377 378 379 380 381 382 383
	private registerListeners(): void {

		// 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 已提交
384
				this.pendingLoadConfig = null;
E
Erich Gamma 已提交
385 386 387 388 389 390 391 392 393 394 395 396 397 398 399
			}

			// To prevent flashing, we set the window visible after the page has finished to load but before VSCode is loaded
			if (!this.win.isVisible()) {
				if (this.currentWindowMode === WindowMode.Maximized) {
					this.win.maximize();
				}

				if (!this.win.isVisible()) { // maximize also makes visible
					this.win.show();
				}
			}
		});

		// App commands support
400
		this.registerNavigationListenerOn('app-command', 'browser-backward', 'browser-forward', false);
E
Erich Gamma 已提交
401 402 403 404 405

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

B
Benjamin Pasero 已提交
406
			shell.openExternal(url);
E
Erich Gamma 已提交
407 408 409 410
		});

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

414 415 416 417 418 419 420 421 422
		// Window Fullscreen
		this._win.on('enter-full-screen', () => {
			this.sendWhenReady('vscode:enterFullScreen');
		});

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

423 424 425 426 427 428 429 430 431 432 433
		// React to HC color scheme changes (Windows)
		if (platform.isWindows) {
			systemPreferences.on('inverted-color-scheme-changed', () => {
				if (systemPreferences.isInvertedColorScheme()) {
					this.sendWhenReady('vscode:enterHighContrast');
				} else {
					this.sendWhenReady('vscode:leaveHighContrast');
				}
			});
		}

E
Erich Gamma 已提交
434 435 436 437 438 439 440
		// Window Failed to load
		this._win.webContents.on('did-fail-load', (event: Event, errorCode: string, errorDescription: string) => {
			console.warn('[electron event]: fail to load, ', errorDescription);
		});

		// 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
441
		if (this.environmentService.isBuilt) {
E
Erich Gamma 已提交
442 443 444 445 446 447
			this._win.webContents.on('will-navigate', (event: Event) => {
				if (event) {
					event.preventDefault();
				}
			});
		}
B
Benjamin Pasero 已提交
448 449

		// Handle configuration changes
B
Benjamin Pasero 已提交
450
		this.toDispose.push(this.configurationService.onDidUpdateConfiguration(e => this.onConfigurationUpdated()));
E
Erich Gamma 已提交
451 452
	}

B
Benjamin Pasero 已提交
453
	private onConfigurationUpdated(): void {
454
		const newMenuBarVisibility = this.getMenuBarVisibility();
B
Benjamin Pasero 已提交
455 456 457 458
		if (newMenuBarVisibility !== this.currentMenuBarVisibility) {
			this.currentMenuBarVisibility = newMenuBarVisibility;
			this.setMenuBarVisibility(newMenuBarVisibility);
		}
459 460

		// Swipe command support (macOS)
B
Benjamin Pasero 已提交
461 462 463
		if (platform.isMacintosh) {
			const config = this.configurationService.getConfiguration<IWorkbenchEditorConfiguration>();
			if (config && config.workbench && config.workbench.editor && config.workbench.editor.swipeToNavigate) {
464
				this.registerNavigationListenerOn('swipe', 'left', 'right', true);
B
Benjamin Pasero 已提交
465 466 467
			} else {
				this._win.removeAllListeners('swipe');
			}
468
		}
B
Benjamin Pasero 已提交
469 470
	};

E
Erich Gamma 已提交
471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487
	public load(config: IWindowConfiguration): void {

		// 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;
		}

488 489 490 491 492
		// Make sure to clear any previous edited state
		if (platform.isMacintosh && this._win.isDocumentEdited()) {
			this._win.setDocumentEdited(false);
		}

E
Erich Gamma 已提交
493
		// Load URL
B
Benjamin Pasero 已提交
494
		this._win.loadURL(this.getUrl(config));
E
Erich Gamma 已提交
495 496

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

J
Johannes Rieken 已提交
508 509 510 511
		// (--prof-startup) save profile to disk
		const { profileStartup } = this.environmentService;
		if (profileStartup) {
			stopProfiling(profileStartup.dir, profileStartup.prefix)
512
				.done(undefined, err => console.error(err));
513
		}
E
Erich Gamma 已提交
514 515
	}

B
Benjamin Pasero 已提交
516
	public reload(cli?: ParsedArgs): void {
E
Erich Gamma 已提交
517 518

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

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

533 534
		configuration.isInitialStartup = false; // since this is a reload

E
Erich Gamma 已提交
535 536 537 538
		// Load config
		this.load(configuration);
	}

539
	private getUrl(windowConfiguration: IWindowConfiguration): string {
J
Joao Moreno 已提交
540
		let url = require.toUrl('vs/workbench/electron-browser/bootstrap/index.html');
E
Erich Gamma 已提交
541

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

549 550 551
		// Set fullscreen state
		windowConfiguration.fullscreen = this._win.isFullScreen();

552
		// Set Accessibility Config
553
		windowConfiguration.highContrast = platform.isWindows && systemPreferences.isInvertedColorScheme() && (!windowConfig || windowConfig.autoDetectHighContrast);
554 555
		windowConfiguration.accessibilitySupport = app.isAccessibilitySupportEnabled();

556 557
		// Theme
		windowConfiguration.baseTheme = this.getBaseTheme();
558
		windowConfiguration.backgroundColor = this.getBackgroundColor();
M
Martin Aeschlimann 已提交
559

560 561
		// Perf Counters
		windowConfiguration.perfStartTime = global.perfStartTime;
562
		windowConfiguration.perfAppReady = global.perfAppReady;
563
		windowConfiguration.perfWindowLoadTime = Date.now();
564

565 566 567
		// Config (combination of process.argv and window configuration)
		const environment = parseArgs(process.argv);
		const config = objects.assign(environment, windowConfiguration);
568 569 570 571 572
		for (let key in config) {
			if (!config[key]) {
				delete config[key]; // only send over properties that have a true value
			}
		}
573

E
Erich Gamma 已提交
574 575 576 577 578
		url += '?config=' + encodeURIComponent(JSON.stringify(config));

		return url;
	}

579
	private getBaseTheme(): string {
580 581 582
		if (platform.isWindows && systemPreferences.isInvertedColorScheme()) {
			return 'hc-black';
		}
583 584 585 586
		const theme = this.storageService.getItem<string>(VSCodeWindow.themeStorageKey, 'vs-dark');
		return theme.split(' ')[0];
	}

587 588 589 590 591 592 593 594 595 596 597 598 599 600
	private getBackgroundColor(): string {
		if (platform.isWindows && systemPreferences.isInvertedColorScheme()) {
			return '#000000';
		}

		let background = this.storageService.getItem<string>(VSCodeWindow.themeBackgroundStorageKey, null);
		if (!background) {
			let baseTheme = this.getBaseTheme();
			return baseTheme === 'hc-black' ? '#000000' : (baseTheme === 'vs' ? '#FFFFFF' : (platform.isMacintosh ? '#171717' : '#1E1E1E')); // https://github.com/electron/electron/issues/5150
		}

		return background;
	}

E
Erich Gamma 已提交
601 602
	public serializeWindowState(): IWindowState {
		if (this.win.isFullScreen()) {
603
			return {
604 605 606 607 608 609
				mode: WindowMode.Fullscreen,
				// still carry over window dimensions from previous sessions!
				width: this.windowState.width,
				height: this.windowState.height,
				x: this.windowState.x,
				y: this.windowState.y
610
			};
E
Erich Gamma 已提交
611 612
		}

613
		const state: IWindowState = Object.create(null);
E
Erich Gamma 已提交
614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633
		let mode: WindowMode;

		// get window mode
		if (!platform.isMacintosh && this.win.isMaximized()) {
			mode = WindowMode.Maximized;
		} else if (this.win.isMinimized()) {
			mode = WindowMode.Minimized;
		} else {
			mode = WindowMode.Normal;
		}

		// we don't want to save minimized state, only maximized or normal
		if (mode === WindowMode.Maximized) {
			state.mode = WindowMode.Maximized;
		} else if (mode !== WindowMode.Minimized) {
			state.mode = WindowMode.Normal;
		}

		// only consider non-minimized window states
		if (mode === WindowMode.Normal || mode === WindowMode.Maximized) {
634 635
			const pos = this.win.getPosition();
			const size = this.win.getSize();
E
Erich Gamma 已提交
636 637 638 639 640 641 642 643 644 645 646 647 648 649 650

			state.x = pos[0];
			state.y = pos[1];
			state.width = size[0];
			state.height = size[1];
		}

		return state;
	}

	private restoreWindowState(state?: IWindowState): void {
		if (state) {
			try {
				state = this.validateWindowState(state);
			} catch (err) {
J
Joao Moreno 已提交
651
				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 已提交
652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675
			}
		}

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

		this.windowState = state;
		this.currentWindowMode = this.windowState.mode;
	}

	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;
		}

676
		const displays = screen.getAllDisplays();
E
Erich Gamma 已提交
677 678 679

		// Single Monitor: be strict about x/y positioning
		if (displays.length === 1) {
680
			const displayBounds = displays[0].bounds;
E
Erich Gamma 已提交
681 682 683 684 685 686 687 688 689 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

			// 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;
		}

		// Multi Monitor: be less strict because metrics can be crazy
717 718
		const bounds = { x: state.x, y: state.y, width: state.width, height: state.height };
		const display = screen.getDisplayMatching(bounds);
E
Erich Gamma 已提交
719 720
		if (display && display.bounds.x + display.bounds.width > bounds.x && display.bounds.y + display.bounds.height > bounds.y) {
			if (state.mode === WindowMode.Maximized) {
721
				const defaults = defaultWindowState(WindowMode.Maximized); // when maximized, make sure we have good values when the user restores the window
E
Erich Gamma 已提交
722 723 724 725 726 727 728 729 730 731 732 733
				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 已提交
734
	public getBounds(): Electron.Rectangle {
735 736
		const pos = this.win.getPosition();
		const dimension = this.win.getSize();
E
Erich Gamma 已提交
737 738 739 740 741

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

	public toggleFullScreen(): void {
742
		const willBeFullScreen = !this.win.isFullScreen();
E
Erich Gamma 已提交
743

B
Benjamin Pasero 已提交
744
		// set fullscreen flag on window
745 746
		this.win.setFullScreen(willBeFullScreen);

747
		// respect configured menu bar visibility or default to toggle if not set
748
		this.setMenuBarVisibility(this.currentMenuBarVisibility, false);
B
Benjamin Pasero 已提交
749 750
	}

751
	private getMenuBarVisibility(): MenuBarVisibility {
752
		const windowConfig = this.configurationService.getConfiguration<IWindowSettings>('window');
B
Benjamin Pasero 已提交
753
		if (!windowConfig || !windowConfig.menuBarVisibility) {
754
			return 'default';
B
Benjamin Pasero 已提交
755 756 757 758
		}

		let menuBarVisibility = windowConfig.menuBarVisibility;
		if (['visible', 'toggle', 'hidden'].indexOf(menuBarVisibility) < 0) {
759
			menuBarVisibility = 'default';
B
Benjamin Pasero 已提交
760 761 762
		}

		return menuBarVisibility;
E
Erich Gamma 已提交
763 764
	}

765
	public setMenuBarVisibility(visibility: MenuBarVisibility, notify: boolean = true): void {
B
Benjamin Pasero 已提交
766 767 768 769
		if (platform.isMacintosh) {
			return; // ignore for macOS platform
		}

770 771
		const isFullscreen = this.win.isFullScreen();

772
		switch (visibility) {
773 774 775 776 777
			case ('default'):
				this.win.setMenuBarVisibility(!isFullscreen);
				this.win.setAutoHideMenuBar(isFullscreen);
				break;

D
David Terry 已提交
778
			case ('visible'):
779 780 781
				this.win.setMenuBarVisibility(true);
				this.win.setAutoHideMenuBar(false);
				break;
D
David Terry 已提交
782 783

			case ('toggle'):
784 785
				this.win.setMenuBarVisibility(false);
				this.win.setAutoHideMenuBar(true);
786

787 788 789
				if (notify) {
					this.send('vscode:showInfoMessage', nls.localize('hiddenMenuBar', "You can still access the menu bar by pressing the **Alt** key."));
				};
790
				break;
D
David Terry 已提交
791 792

			case ('hidden'):
793 794 795 796 797 798 799 800 801
				// 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(() => {
					this.win.setMenuBarVisibility(false);
					this.win.setAutoHideMenuBar(false);
				});
802 803
				break;
		};
804 805
	}

806 807 808 809 810 811 812 813 814 815
	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 已提交
816 817 818 819 820
	public dispose(): void {
		if (this.showTimeoutHandle) {
			clearTimeout(this.showTimeoutHandle);
		}

821 822
		this.toDispose = dispose(this.toDispose);

E
Erich Gamma 已提交
823 824
		this._win = null; // Important to dereference the window object to allow for GC
	}
825
}