terminalInstance.ts 23.9 KB
Newer Older
1 2 3 4 5
/*---------------------------------------------------------------------------------------------
 *  Copyright (c) Microsoft Corporation. All rights reserved.
 *  Licensed under the MIT License. See License.txt in the project root for license information.
 *--------------------------------------------------------------------------------------------*/

6
import * as path from 'path';
7
import DOM = require('vs/base/browser/dom');
J
Johannes Rieken 已提交
8
import Event, { Emitter } from 'vs/base/common/event';
9 10
import URI from 'vs/base/common/uri';
import cp = require('child_process');
11
import lifecycle = require('vs/base/common/lifecycle');
C
Christof Marti 已提交
12
import nls = require('vs/nls');
C
Christof Marti 已提交
13
import os = require('os');
14
import platform = require('vs/base/common/platform');
15
import xterm = require('xterm');
16
import { Dimension } from 'vs/base/browser/builder';
17
import { IContextKeyService, IContextKey } from 'vs/platform/contextkey/common/contextkey';
18 19
import { IKeybindingService } from 'vs/platform/keybinding/common/keybinding';
import { IMessageService, Severity } from 'vs/platform/message/common/message';
20
import { IPanelService } from 'vs/workbench/services/panel/common/panelService';
21
import { IStringDictionary } from 'vs/base/common/collections';
22
import { ITerminalInstance, KEYBINDING_CONTEXT_TERMINAL_TEXT_SELECTED, TERMINAL_PANEL_ID, IShellLaunchConfig } from 'vs/workbench/parts/terminal/common/terminal';
23
import { ITerminalProcessFactory } from 'vs/workbench/parts/terminal/electron-browser/terminal';
24
import { IWorkspace, IWorkspaceContextService } from 'vs/platform/workspace/common/workspace';
25
import { IWorkbenchEditorService } from 'vs/workbench/services/editor/common/editorService';
26 27
import { StandardKeyboardEvent } from 'vs/base/browser/keyboardEvent';
import { TabFocus } from 'vs/editor/common/config/commonEditorConfig';
28
import { TerminalConfigHelper } from 'vs/workbench/parts/terminal/electron-browser/terminalConfigHelper';
29
import { TerminalLinkHandler } from 'vs/workbench/parts/terminal/electron-browser/terminalLinkHandler';
30

D
Daniel Imms 已提交
31 32 33
/** The amount of time to consider terminal errors to be related to the launch */
const LAUNCHING_DURATION = 500;

34 35 36 37 38 39 40 41 42
class StandardTerminalProcessFactory implements ITerminalProcessFactory {
	public create(env: { [key: string]: string }): cp.ChildProcess {
		return cp.fork('./terminalProcess', [], {
			env,
			cwd: URI.parse(path.dirname(require.toUrl('./terminalProcess'))).fsPath
		});
	}
}

43
export class TerminalInstance implements ITerminalInstance {
44
	private static readonly EOL_REGEX = /\r?\n/g;
C
Christof Marti 已提交
45

46
	private static _terminalProcessFactory: ITerminalProcessFactory = new StandardTerminalProcessFactory();
D
Daniel Imms 已提交
47 48
	private static _idCounter = 1;

49
	private _id: number;
D
Daniel Imms 已提交
50
	private _isExiting: boolean;
K
Kai Wood 已提交
51
	private _hadFocusOnExit: boolean;
52
	private _isLaunching: boolean;
D
Daniel Imms 已提交
53
	private _isVisible: boolean;
54
	private _isDisposed: boolean;
55
	private _onDisposed: Emitter<ITerminalInstance>;
56
	private _onProcessIdReady: Emitter<TerminalInstance>;
D
Daniel Imms 已提交
57
	private _onTitleChanged: Emitter<string>;
D
Daniel Imms 已提交
58
	private _process: cp.ChildProcess;
59
	private _processId: number;
D
Daniel Imms 已提交
60
	private _skipTerminalCommands: string[];
D
Daniel Imms 已提交
61
	private _title: string;
62 63
	private _instanceDisposables: lifecycle.IDisposable[];
	private _processDisposables: lifecycle.IDisposable[];
D
Daniel Imms 已提交
64 65 66
	private _wrapperElement: HTMLDivElement;
	private _xterm: any;
	private _xtermElement: HTMLDivElement;
67
	private _terminalHasTextContextKey: IContextKey<boolean>;
68 69
	private _cols: number;
	private _rows: number;
D
Daniel Imms 已提交
70

71
	public get id(): number { return this._id; }
72
	public get processId(): number { return this._processId; }
73
	public get onDisposed(): Event<ITerminalInstance> { return this._onDisposed.event; }
74
	public get onProcessIdReady(): Event<TerminalInstance> { return this._onProcessIdReady.event; }
D
Daniel Imms 已提交
75
	public get onTitleChanged(): Event<string> { return this._onTitleChanged.event; }
D
Daniel Imms 已提交
76
	public get title(): string { return this._title; }
K
Kai Wood 已提交
77
	public get hadFocusOnExit(): boolean { return this._hadFocusOnExit; }
78 79

	public constructor(
D
Daniel Imms 已提交
80 81
		private _terminalFocusContextKey: IContextKey<boolean>,
		private _configHelper: TerminalConfigHelper,
82
		private _linkHandler: TerminalLinkHandler,
D
Daniel Imms 已提交
83
		private _container: HTMLElement,
84
		private _shellLaunchConfig: IShellLaunchConfig,
85
		@IContextKeyService private _contextKeyService: IContextKeyService,
D
Daniel Imms 已提交
86
		@IKeybindingService private _keybindingService: IKeybindingService,
87
		@IMessageService private _messageService: IMessageService,
88
		@IPanelService private _panelService: IPanelService,
89 90
		@IWorkspaceContextService private _contextService: IWorkspaceContextService,
		@IWorkbenchEditorService private _editorService: IWorkbenchEditorService
91
	) {
92 93
		this._instanceDisposables = [];
		this._processDisposables = [];
D
Daniel Imms 已提交
94
		this._skipTerminalCommands = [];
D
Daniel Imms 已提交
95
		this._isExiting = false;
K
Kai Wood 已提交
96
		this._hadFocusOnExit = false;
97
		this._isLaunching = true;
D
Daniel Imms 已提交
98
		this._isVisible = false;
99
		this._isDisposed = false;
D
Daniel Imms 已提交
100
		this._id = TerminalInstance._idCounter++;
101
		this._terminalHasTextContextKey = KEYBINDING_CONTEXT_TERMINAL_TEXT_SELECTED.bindTo(this._contextKeyService);
D
Daniel Imms 已提交
102

103
		this._onDisposed = new Emitter<TerminalInstance>();
104 105
		this._onProcessIdReady = new Emitter<TerminalInstance>();
		this._onTitleChanged = new Emitter<string>();
106

107
		this._initDimensions();
D
Daniel Imms 已提交
108
		this._createProcess(this._contextService.getWorkspace(), this._shellLaunchConfig);
109
		this._createXterm();
D
Daniel Imms 已提交
110

111
		// Only attach xterm.js to the DOM if the terminal panel has been opened before.
D
Daniel Imms 已提交
112 113
		if (_container) {
			this.attachToElement(_container);
114 115 116
		}
	}

D
Daniel Imms 已提交
117
	public addDisposable(disposable: lifecycle.IDisposable): void {
118
		this._instanceDisposables.push(disposable);
D
Daniel Imms 已提交
119 120
	}

121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136
	private _initDimensions(): void {
		// The terminal panel needs to have been created
		if (!this._container) {
			return;
		}

		const computedStyle = window.getComputedStyle(this._container);
		const width = parseInt(computedStyle.getPropertyValue('width').replace('px', ''), 10);
		const height = parseInt(computedStyle.getPropertyValue('height').replace('px', ''), 10);
		this._evaluateColsAndRows(width, height);
	}

	/**
	 * Evaluates and sets the cols and rows of the terminal if possible.
	 * @param width The width of the container.
	 * @param height The height of the container.
D
Daniel Imms 已提交
137
	 * @return The terminal's width if it requires a layout.
138
	 */
D
Daniel Imms 已提交
139
	private _evaluateColsAndRows(width: number, height: number): number {
140 141 142
		// The font needs to have been initialized
		const font = this._configHelper.getFont();
		if (!font || !font.charWidth || !font.charHeight) {
D
Daniel Imms 已提交
143
			return null;
144 145 146 147 148
		}

		// TODO: Fetch size from panel so initial size is correct
		// The panel is minimized
		if (!height) {
D
Daniel Imms 已提交
149
			return null;
150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165
		} else {
			// Trigger scroll event manually so that the viewport's scroll area is synced. This
			// needs to happen otherwise its scrollTop value is invalid when the panel is toggled as
			// it gets removed and then added back to the DOM (resetting scrollTop to 0).
			// Upstream issue: https://github.com/sourcelair/xterm.js/issues/291
			if (this._xterm) {
				this._xterm.emit('scroll', this._xterm.ydisp);
			}
		}

		const padding = parseInt(getComputedStyle(document.querySelector('.terminal-outer-container')).paddingLeft.split('px')[0], 10);
		// Use left padding as right padding, right padding is not defined in CSS just in case
		// xterm.js causes an unexpected overflow.
		const innerWidth = width - padding * 2;
		this._cols = Math.floor(innerWidth / font.charWidth);
		this._rows = Math.floor(height / font.charHeight);
D
Daniel Imms 已提交
166
		return innerWidth;
167 168
	}

169 170 171 172
	/**
	 * Create xterm.js instance and attach data listeners.
	 */
	protected _createXterm(): void {
173 174 175
		this._xterm = xterm({
			scrollback: this._configHelper.getScrollback()
		});
176
		this._process.on('message', (message) => this._sendPtyDataToXterm(message));
D
Daniel Imms 已提交
177
		this._xterm.on('data', (data) => {
178 179 180 181 182 183
			if (this._process) {
				this._process.send({
					event: 'input',
					data: this._sanitizeInput(data)
				});
			}
D
Daniel Imms 已提交
184 185
			return false;
		});
186 187 188 189 190 191 192 193 194 195 196 197 198
	}

	public attachToElement(container: HTMLElement): void {
		if (this._wrapperElement) {
			throw new Error('The terminal instance has already been attached to a container');
		}

		this._container = container;
		this._wrapperElement = document.createElement('div');
		DOM.addClass(this._wrapperElement, 'terminal-wrapper');
		this._xtermElement = document.createElement('div');

		this._xterm.open(this._xtermElement);
199
		this._linkHandler.initialize(this._xterm);
D
Daniel Imms 已提交
200
		this._linkHandler.registerLocalLinkHandler(this._xterm);
D
Daniel Imms 已提交
201
		this._xterm.attachCustomKeydownHandler((event: KeyboardEvent) => {
202 203 204 205 206
			// Disable all input if the terminal is exiting
			if (this._isExiting) {
				return false;
			}

207 208
			// Skip processing by xterm.js of keyboard events that resolve to commands described
			// within commandsToSkipShell
D
Daniel Imms 已提交
209
			const standardKeyboardEvent = new StandardKeyboardEvent(event);
210
			const keybinding = standardKeyboardEvent.toKeybinding();
D
Daniel Imms 已提交
211 212
			const resolveResult = this._keybindingService.resolve(keybinding, standardKeyboardEvent.target);
			if (resolveResult && this._skipTerminalCommands.some(k => k === resolveResult.commandId)) {
D
Daniel Imms 已提交
213 214 215 216 217 218 219 220
				event.preventDefault();
				return false;
			}

			// If tab focus mode is on, tab is not passed to the terminal
			if (TabFocus.getTabFocusMode() && event.keyCode === 9) {
				return false;
			}
221
			return undefined;
D
Daniel Imms 已提交
222
		});
223
		this._instanceDisposables.push(DOM.addDisposableListener(this._xterm.element, 'mouseup', (event: KeyboardEvent) => {
224 225 226
			// Wait until mouseup has propogated through the DOM before evaluating the new selection
			// state.
			setTimeout(() => {
227 228
				this._refreshSelectionContextKey();
			}, 0);
229
		}));
230 231

		// xterm.js currently drops selection on keyup as we need to handle this case.
232
		this._instanceDisposables.push(DOM.addDisposableListener(this._xterm.element, 'keyup', (event: KeyboardEvent) => {
233 234 235 236
			// Wait until keyup has propogated through the DOM before evaluating the new selection
			// state.
			setTimeout(() => {
				this._refreshSelectionContextKey();
237
			}, 0);
238
		}));
D
Daniel Imms 已提交
239

D
Daniel Imms 已提交
240 241
		const xtermHelper: HTMLElement = this._xterm.element.querySelector('.xterm-helpers');
		const focusTrap: HTMLElement = document.createElement('div');
242 243
		focusTrap.setAttribute('tabindex', '0');
		DOM.addClass(focusTrap, 'focus-trap');
244
		this._instanceDisposables.push(DOM.addDisposableListener(focusTrap, 'focus', (event: FocusEvent) => {
245 246 247 248
			let currentElement = focusTrap;
			while (!DOM.hasClass(currentElement, 'part')) {
				currentElement = currentElement.parentElement;
			}
D
Daniel Imms 已提交
249
			const hidePanelElement = <HTMLElement>currentElement.querySelector('.hide-panel-action');
250
			hidePanelElement.focus();
251
		}));
D
Daniel Imms 已提交
252
		xtermHelper.insertBefore(focusTrap, this._xterm.textarea);
253

254
		this._instanceDisposables.push(DOM.addDisposableListener(this._xterm.textarea, 'focus', (event: KeyboardEvent) => {
D
Daniel Imms 已提交
255
			this._terminalFocusContextKey.set(true);
256
		}));
257
		this._instanceDisposables.push(DOM.addDisposableListener(this._xterm.textarea, 'blur', (event: KeyboardEvent) => {
D
Daniel Imms 已提交
258
			this._terminalFocusContextKey.reset();
259
			this._refreshSelectionContextKey();
260
		}));
261
		this._instanceDisposables.push(DOM.addDisposableListener(this._xterm.element, 'focus', (event: KeyboardEvent) => {
D
Daniel Imms 已提交
262
			this._terminalFocusContextKey.set(true);
263
		}));
264
		this._instanceDisposables.push(DOM.addDisposableListener(this._xterm.element, 'blur', (event: KeyboardEvent) => {
D
Daniel Imms 已提交
265
			this._terminalFocusContextKey.reset();
266
			this._refreshSelectionContextKey();
267 268
		}));

D
Daniel Imms 已提交
269 270
		this._wrapperElement.appendChild(this._xtermElement);
		this._container.appendChild(this._wrapperElement);
271

272 273 274 275
		const computedStyle = window.getComputedStyle(this._container);
		const width = parseInt(computedStyle.getPropertyValue('width').replace('px', ''), 10);
		const height = parseInt(computedStyle.getPropertyValue('height').replace('px', ''), 10);
		this.layout(new Dimension(width, height));
D
Daniel Imms 已提交
276
		this.setVisible(this._isVisible);
277
		this.updateConfig();
278 279
	}

280 281
	public registerLinkMatcher(regex: RegExp, handler: (url: string) => void, matchIndex?: number, validationCallback?: (uri: string, callback: (isValid: boolean) => void) => void): number {
		return this._linkHandler.registerCustomLinkHandler(this._xterm, regex, handler, matchIndex, validationCallback);
282 283 284 285 286 287
	}

	public deregisterLinkMatcher(linkMatcherId: number): void {
		this._xterm.deregisterLinkMatcher(linkMatcherId);
	}

288 289 290 291
	public hasSelection(): boolean {
		return !document.getSelection().isCollapsed;
	}

D
Daniel Imms 已提交
292
	public copySelection(): void {
D
Daniel Imms 已提交
293 294 295
		if (document.activeElement.classList.contains('xterm')) {
			document.execCommand('copy');
		} else {
D
Daniel Imms 已提交
296
			this._messageService.show(Severity.Warning, nls.localize('terminal.integrated.copySelection.noSelection', 'Cannot copy terminal selection when terminal does not have focus'));
D
Daniel Imms 已提交
297
		}
D
Daniel Imms 已提交
298 299
	}

300 301 302 303
	public clearSelection(): void {
		document.getSelection().empty();
	}

D
Daniel Imms 已提交
304
	public dispose(): void {
K
Kai Wood 已提交
305 306 307
		if (this._xterm && this._xterm.element) {
			this._hadFocusOnExit = DOM.hasClass(this._xterm.element, 'focus');
		}
D
Daniel Imms 已提交
308 309 310
		if (this._wrapperElement) {
			this._container.removeChild(this._wrapperElement);
			this._wrapperElement = null;
D
Daniel Imms 已提交
311
		}
D
Daniel Imms 已提交
312 313 314
		if (this._xterm) {
			this._xterm.destroy();
			this._xterm = null;
D
Daniel Imms 已提交
315
		}
D
Daniel Imms 已提交
316 317 318
		if (this._process) {
			if (this._process.connected) {
				this._process.kill();
D
Daniel Imms 已提交
319
			}
D
Daniel Imms 已提交
320
			this._process = null;
D
Daniel Imms 已提交
321
		}
322 323 324 325
		if (!this._isDisposed) {
			this._isDisposed = true;
			this._onDisposed.fire(this);
		}
326 327
		this._processDisposables = lifecycle.dispose(this._processDisposables);
		this._instanceDisposables = lifecycle.dispose(this._instanceDisposables);
D
Daniel Imms 已提交
328 329
	}

D
Daniel Imms 已提交
330
	public focus(force?: boolean): void {
D
Daniel Imms 已提交
331
		if (!this._xterm) {
D
Daniel Imms 已提交
332 333
			return;
		}
D
Daniel Imms 已提交
334
		const text = window.getSelection().toString();
D
Daniel Imms 已提交
335
		if (!text || force) {
D
Daniel Imms 已提交
336
			this._xterm.focus();
D
Daniel Imms 已提交
337
		}
D
Daniel Imms 已提交
338 339 340
	}

	public paste(): void {
D
Daniel Imms 已提交
341 342
		this.focus();
		document.execCommand('paste');
D
Daniel Imms 已提交
343 344 345
	}

	public sendText(text: string, addNewLine: boolean): void {
D
Daniel Imms 已提交
346 347 348
		if (addNewLine && text.substr(text.length - os.EOL.length) !== os.EOL) {
			text += os.EOL;
		}
D
Daniel Imms 已提交
349
		this._process.send({
D
Daniel Imms 已提交
350 351 352
			event: 'input',
			data: text
		});
D
Daniel Imms 已提交
353
	}
354 355

	public setVisible(visible: boolean): void {
D
Daniel Imms 已提交
356 357 358
		this._isVisible = visible;
		if (this._wrapperElement) {
			DOM.toggleClass(this._wrapperElement, 'active', visible);
359
		}
D
Daniel Imms 已提交
360
		if (visible && this._xterm) {
361 362 363 364 365 366
			// Trigger a manual scroll event which will sync the viewport and scroll bar. This is
			// necessary if the number of rows in the terminal has decreased while it was in the
			// background since scrollTop changes take no effect but the terminal's position does
			// change since the number of visible rows decreases.
			this._xterm.emit('scroll', this._xterm.ydisp);
		}
367 368
	}

369
	public scrollDownLine(): void {
D
Daniel Imms 已提交
370
		this._xterm.scrollDisp(1);
D
Daniel Imms 已提交
371 372
	}

373
	public scrollDownPage(): void {
374
		this._xterm.scrollPages(1);
375 376
	}

377 378 379 380
	public scrollToBottom(): void {
		this._xterm.scrollToBottom();
	}

381
	public scrollUpLine(): void {
D
Daniel Imms 已提交
382
		this._xterm.scrollDisp(-1);
D
Daniel Imms 已提交
383
	}
384

385
	public scrollUpPage(): void {
386
		this._xterm.scrollPages(-1);
387 388
	}

389 390 391 392
	public scrollToTop(): void {
		this._xterm.scrollToTop();
	}

D
Daniel Imms 已提交
393 394 395 396
	public clear(): void {
		this._xterm.clear();
	}

397
	private _refreshSelectionContextKey() {
398 399 400
		const activePanel = this._panelService.getActivePanel();
		const isFocused = activePanel && activePanel.getId() === TERMINAL_PANEL_ID;
		this._terminalHasTextContextKey.set(isFocused && !window.getSelection().isCollapsed);
401 402
	}

D
Daniel Imms 已提交
403
	private _sanitizeInput(data: any) {
404
		return typeof data === 'string' ? data.replace(TerminalInstance.EOL_REGEX, os.EOL) : data;
C
Christof Marti 已提交
405 406
	}

407 408 409 410 411
	protected _getCwd(shell: IShellLaunchConfig, workspace: IWorkspace): string {
		if (shell.cwd) {
			return shell.cwd;
		}

B
Benjamin Pasero 已提交
412
		let cwd: string;
D
Daniel Imms 已提交
413 414

		// TODO: Handle non-existent customCwd
415
		if (!shell.ignoreConfigurationCwd) {
416
			// Evaluate custom cwd first
D
Daniel Imms 已提交
417
			const customCwd = this._configHelper.getCwd();
418 419 420 421 422 423
			if (customCwd) {
				if (path.isAbsolute(customCwd)) {
					cwd = customCwd;
				} else if (workspace) {
					cwd = path.normalize(path.join(workspace.resource.fsPath, customCwd));
				}
D
Daniel Imms 已提交
424 425 426 427 428
			}
		}

		// If there was no custom cwd or it was relative with no workspace
		if (!cwd) {
429
			cwd = workspace ? workspace.resource.fsPath : os.homedir();
D
Daniel Imms 已提交
430 431 432 433 434
		}

		return TerminalInstance._sanitizeCwd(cwd);
	}

435
	protected _createProcess(workspace: IWorkspace, shell: IShellLaunchConfig): void {
D
Daniel Imms 已提交
436
		const locale = this._configHelper.isSetLocaleVariables() ? platform.locale : undefined;
D
Daniel Imms 已提交
437
		if (!shell.executable) {
438
			this._configHelper.mergeDefaultShellPathAndArgs(shell);
P
Pine Wu 已提交
439
		}
440
		const env = TerminalInstance.createTerminalEnv(process.env, shell, this._getCwd(shell, workspace), locale, this._cols, this._rows);
D
Daniel Imms 已提交
441
		this._title = shell.name || '';
D
Daniel Imms 已提交
442
		this._process = cp.fork('./terminalProcess', [], {
443 444 445
			env: env,
			cwd: URI.parse(path.dirname(require.toUrl('./terminalProcess'))).fsPath
		});
D
Daniel Imms 已提交
446
		if (!shell.name) {
447
			// Only listen for process title changes when a name is not provided
D
Daniel Imms 已提交
448
			this._process.on('message', (message) => {
449
				if (message.type === 'title') {
D
Daniel Imms 已提交
450
					this._title = message.content ? message.content : '';
451
					this._onTitleChanged.fire(this._title);
452
				}
453 454
			});
		}
455 456 457 458 459 460
		this._process.on('message', (message) => {
			if (message.type === 'pid') {
				this._processId = message.content;
				this._onProcessIdReady.fire(this);
			}
		});
461 462 463 464 465 466
		this._process.on('exit', exitCode => this._onPtyProcessExit(exitCode));
		setTimeout(() => {
			this._isLaunching = false;
		}, LAUNCHING_DURATION);
	}

467 468 469 470 471 472
	private _sendPtyDataToXterm(message: { type: string, content: string }): void {
		if (message.type === 'data') {
			this._xterm.write(message.content);
		}
	}

473 474 475 476 477 478 479 480
	private _onPtyProcessExit(exitCode: number): void {
		// Prevent dispose functions being triggered multiple times
		if (this._isExiting) {
			return;
		}

		this._isExiting = true;
		let exitCodeMessage: string;
481
		if (exitCode) {
482 483 484
			exitCodeMessage = nls.localize('terminal.integrated.exitedWithCode', 'The terminal process terminated with exit code: {0}', exitCode);
		}

485 486 487 488 489
		// Only trigger wait on exit when the exit was triggered by the process, not through the
		// `workbench.action.terminal.kill` command
		const triggeredByProcess = exitCode !== null;

		if (triggeredByProcess && this._shellLaunchConfig.waitOnExit) {
490
			if (exitCode) {
491 492 493 494 495
				this._xterm.writeln(exitCodeMessage);
			}
			this._xterm.writeln(nls.localize('terminal.integrated.waitOnExit', 'Press any key to close the terminal'));
			// Disable all input if the terminal is exiting and listen for next keypress
			this._xterm.setOption('disableStdin', true);
496
			this._processDisposables.push(DOM.addDisposableListener(this._xterm.textarea, 'keypress', (event: KeyboardEvent) => {
497
				this.dispose();
498
				event.preventDefault();
499
			}));
500 501
		} else {
			this.dispose();
502
			if (exitCode) {
503 504 505 506 507 508 509 510 511
				if (this._isLaunching) {
					let args = '';
					if (this._shellLaunchConfig.args && this._shellLaunchConfig.args.length) {
						args = ' ' + this._shellLaunchConfig.args.map(a => {
							if (a.indexOf(' ') !== -1) {
								return `'${a}'`;
							}
							return a;
						}).join(' ');
512
					}
513 514 515
					this._messageService.show(Severity.Error, nls.localize('terminal.integrated.launchFailed', 'The terminal process command `{0}{1}` failed to launch (exit code: {2})', this._shellLaunchConfig.executable, args, exitCode));
				} else {
					this._messageService.show(Severity.Error, exitCodeMessage);
516 517
				}
			}
518
		}
519 520
	}

521 522
	public reuseTerminal(shell?: IShellLaunchConfig): void {
		// Kill and clean up old process
523 524 525 526 527 528 529
		if (this._process) {
			this._process.removeAllListeners('exit');
			if (this._process.connected) {
				this._process.kill();
			}
			this._process = null;
		}
530 531 532
		lifecycle.dispose(this._processDisposables);
		this._processDisposables = [];

533 534
		// Ensure new processes' output starts at start of new line
		this._xterm.write('\n\x1b[G');
535 536

		// Initialize new process
537
		const oldTitle = this._title;
D
Daniel Imms 已提交
538
		this._createProcess(this._contextService.getWorkspace(), shell);
539 540 541
		if (oldTitle !== this._title) {
			this._onTitleChanged.fire(this._title);
		}
542
		this._process.on('message', (message) => this._sendPtyDataToXterm(message));
543 544

		// Clean up waitOnExit state
545 546
		if (this._isExiting && this._shellLaunchConfig.waitOnExit) {
			this._xterm.setOption('disableStdin', false);
547
			this._isExiting = false;
548
		}
549

550 551 552 553
		// Set the new shell launch config
		this._shellLaunchConfig = shell;
	}

554 555
	// TODO: This should be private/protected
	// TODO: locale should not be optional
556
	public static createTerminalEnv(parentEnv: IStringDictionary<string>, shell: IShellLaunchConfig, cwd: string, locale?: string, cols?: number, rows?: number): IStringDictionary<string> {
557
		const env = shell.env ? shell.env : TerminalInstance._cloneEnv(parentEnv);
558 559
		env['PTYPID'] = process.pid.toString();
		env['PTYSHELL'] = shell.executable;
D
Daniel Imms 已提交
560 561 562 563 564
		if (shell.args) {
			shell.args.forEach((arg, i) => {
				env[`PTYSHELLARG${i}`] = arg;
			});
		}
D
Daniel Imms 已提交
565
		env['PTYCWD'] = cwd;
566
		env['LANG'] = TerminalInstance._getLangEnvVariable(locale);
567 568 569 570
		if (cols && rows) {
			env['PTYCOLS'] = cols.toString();
			env['PTYROWS'] = rows.toString();
		}
571
		return env;
572 573
	}

D
Dirk Baeumer 已提交
574 575
	public onData(listener: (data: string) => void): lifecycle.IDisposable {
		let callback = (message) => {
576 577 578
			if (message.type === 'data') {
				listener(message.content);
			}
D
Dirk Baeumer 已提交
579 580 581 582
		};
		this._process.on('message', callback);
		return {
			dispose: () => {
583 584 585
				if (this._process) {
					this._process.removeListener('message', callback);
				}
D
Dirk Baeumer 已提交
586 587
			}
		};
588 589
	}

D
Dirk Baeumer 已提交
590
	public onExit(listener: (exitCode: number) => void): lifecycle.IDisposable {
591
		this._process.on('exit', listener);
D
Dirk Baeumer 已提交
592 593
		return {
			dispose: () => {
594 595 596
				if (this._process) {
					this._process.removeListener('exit', listener);
				}
D
Dirk Baeumer 已提交
597 598
			}
		};
599 600
	}

D
Daniel Imms 已提交
601
	private static _sanitizeCwd(cwd: string) {
602 603 604
		// Make the drive letter uppercase on Windows (see #9448)
		if (platform.platform === platform.Platform.Windows && cwd && cwd[1] === ':') {
			return cwd[0].toUpperCase() + cwd.substr(1);
D
Daniel Imms 已提交
605
		}
606
		return cwd;
D
Daniel Imms 已提交
607 608
	}

D
Daniel Imms 已提交
609
	private static _cloneEnv(env: IStringDictionary<string>): IStringDictionary<string> {
D
Daniel Imms 已提交
610
		const newEnv: IStringDictionary<string> = Object.create(null);
611 612
		Object.keys(env).forEach((key) => {
			newEnv[key] = env[key];
613
		});
614
		return newEnv;
615 616
	}

617 618
	private static _getLangEnvVariable(locale?: string) {
		const parts = locale ? locale.split('-') : [];
619
		const n = parts.length;
620
		if (n === 0) {
D
Daniel Imms 已提交
621 622
			// Fallback to en_US to prevent possible encoding issues.
			return 'en_US.UTF-8';
623 624 625 626 627 628 629 630 631 632 633 634 635
		}
		if (n === 1) {
			// app.getLocale can return just a language without a variant, fill in the variant for
			// supported languages as many shells expect a 2-part locale.
			const languageVariants = {
				de: 'DE',
				en: 'US',
				es: 'ES',
				fr: 'FR',
				it: 'IT',
				ja: 'JP',
				ko: 'KR',
				ru: 'RU',
636
				zh: 'CN'
637
			};
D
Daniel Imms 已提交
638 639
			if (parts[0] in languageVariants) {
				parts.push(languageVariants[parts[0]]);
640 641 642 643
			}
		} else {
			// Ensure the variant is uppercase
			parts[1] = parts[1].toUpperCase();
D
Daniel Imms 已提交
644
		}
645
		return parts.join('_') + '.UTF-8';
D
Daniel Imms 已提交
646
	}
D
Daniel Imms 已提交
647

648 649
	public updateConfig(): void {
		this._setCursorBlink(this._configHelper.getCursorBlink());
650
		this._setCursorStyle(this._configHelper.getCursorStyle());
651 652 653 654 655
		this._setCommandsToSkipShell(this._configHelper.getCommandsToSkipShell());
		this._setScrollback(this._configHelper.getScrollback());
	}

	private _setCursorBlink(blink: boolean): void {
D
Daniel Imms 已提交
656
		if (this._xterm && this._xterm.getOption('cursorBlink') !== blink) {
D
Daniel Imms 已提交
657
			this._xterm.setOption('cursorBlink', blink);
D
Daniel Imms 已提交
658
			this._xterm.refresh(0, this._xterm.rows - 1);
D
Daniel Imms 已提交
659 660 661
		}
	}

662 663 664 665 666 667 668 669
	private _setCursorStyle(style: string): void {
		if (this._xterm && this._xterm.getOption('cursorStyle') !== style) {
			// 'line' is used instead of bar in VS Code to be consistent with editor.cursorStyle
			const xtermOption = style === 'line' ? 'bar' : style;
			this._xterm.setOption('cursorStyle', xtermOption);
		}
	}

670
	private _setCommandsToSkipShell(commands: string[]): void {
D
Daniel Imms 已提交
671
		this._skipTerminalCommands = commands;
D
Daniel Imms 已提交
672 673
	}

674
	private _setScrollback(lineCount: number): void {
D
Daniel Imms 已提交
675 676 677 678 679
		if (this._xterm && this._xterm.getOption('scrollback') !== lineCount) {
			this._xterm.setOption('scrollback', lineCount);
		}
	}

680
	public layout(dimension: Dimension): void {
D
Daniel Imms 已提交
681 682
		const terminalWidth = this._evaluateColsAndRows(dimension.width, dimension.height);
		if (!terminalWidth) {
D
Daniel Imms 已提交
683 684
			return;
		}
D
Daniel Imms 已提交
685
		if (this._xterm) {
686
			this._xterm.resize(this._cols, this._rows);
D
Daniel Imms 已提交
687
			this._xterm.element.style.width = terminalWidth + 'px';
D
Daniel Imms 已提交
688
		}
D
Daniel Imms 已提交
689 690
		if (this._process.connected) {
			this._process.send({
D
Daniel Imms 已提交
691
				event: 'resize',
692 693
				cols: this._cols,
				rows: this._rows
D
Daniel Imms 已提交
694 695 696
			});
		}
	}
697 698 699 700

	public static setTerminalProcessFactory(factory: ITerminalProcessFactory): void {
		this._terminalProcessFactory = factory;
	}
701
}