Merge pull request #77887 from microsoft/tyriar/xterm-update

xterm@3.15.0-beta87 

package.json

@@ -51,7 +51,7 @@
     "vscode-ripgrep": "^1.5.5",
     "vscode-sqlite3": "4.0.8",
     "vscode-textmate": "^4.2.2",
-    "xterm": "3.15.0-beta71",
+    "xterm": "3.15.0-beta87",
     "xterm-addon-search": "0.2.0-beta2",
     "xterm-addon-web-links": "0.1.0-beta10",
     "yauzl": "^2.9.2",
@@ -158,4 +158,4 @@
     "windows-mutex": "0.3.0",
     "windows-process-tree": "0.2.4"
   }
-}
\ No newline at end of file
+}

src/typings/xterm.d.ts

@@ -15,6 +15,11 @@ declare module 'xterm' {
 	 */
 	export type FontWeight = 'normal' | 'bold' | '100' | '200' | '300' | '400' | '500' | '600' | '700' | '800' | '900';
 
+	/**
+	 * A string representing log level.
+	 */
+	export type LogLevel = 'debug' | 'info' | 'warn' | 'error' | 'off';
+
 	/**
 	 * A string representing a renderer type.
 	 */
@@ -107,6 +112,18 @@ declare module 'xterm' {
 		 */
 		lineHeight?: number;
 
+		/**
+		 * What log level to use, this will log for all levels below and including
+		 * what is set:
+		 *
+		 * 1. debug
+		 * 2. info (default)
+		 * 3. warn
+		 * 4. error
+		 * 5. off
+		 */
+		logLevel?: LogLevel;
+
 		/**
 		 * Whether to treat option as the meta key.
 		 */
@@ -177,6 +194,12 @@ declare module 'xterm' {
 		 *   not whitespace.
 		 */
 		windowsMode?: boolean;
+
+		/**
+		 * A string containing all characters that are considered word separated by the
+		 * double click to select work logic.
+		*/
+		wordSeparator?: string;
 	}
 
 	/**
@@ -191,7 +214,7 @@ declare module 'xterm' {
 		cursor?: string,
 		/** The accent color of the cursor (fg color for a block cursor) */
 		cursorAccent?: string,
-		/** The selection color (can be transparent) */
+		/** The selection background color (can be transparent) */
 		selection?: string,
 		/** ANSI black (eg. `\x1b[30m`) */
 		black?: string,
@@ -483,12 +506,14 @@ declare module 'xterm' {
 		 * final character (e.g "m" for SGR) of the CSI sequence.
 		 * @param callback The function to handle the escape sequence. The callback
 		 * is called with the numerical params, as well as the special characters
-		 * (e.g. "$" for DECSCPP). Return true if the sequence was handled; false if
+		 * (e.g. "$" for DECSCPP). If the sequence has subparams the array will
+		 * contain subarrays with their numercial values.
+		 * Return true if the sequence was handled; false if
 		 * we should try a previous handler (set by addCsiHandler or setCsiHandler).
 		 * The most recently-added handler is tried first.
 		 * @return An IDisposable you can call to remove this handler.
 		 */
-		addCsiHandler(flag: string, callback: (params: number[], collect: string) => boolean): IDisposable;
+		addCsiHandler(flag: string, callback: (params: (number | number[])[], collect: string) => boolean): IDisposable;
 
 		/**
 		 * (EXPERIMENTAL) Adds a handler for OSC escape sequences.
@@ -668,12 +693,12 @@ declare module 'xterm' {
 		 * Retrieves an option's value from the terminal.
 		 * @param key The option key.
 		 */
-		getOption(key: 'bellSound' | 'bellStyle' | 'cursorStyle' | 'fontFamily' | 'fontWeight' | 'fontWeightBold' | 'rendererType' | 'termName'): string;
+		getOption(key: 'bellSound' | 'bellStyle' | 'cursorStyle' | 'fontFamily' | 'fontWeight' | 'fontWeightBold' | 'logLevel' | 'rendererType' | 'termName' | 'wordSeparator'): string;
 		/**
 		 * Retrieves an option's value from the terminal.
 		 * @param key The option key.
 		 */
-		getOption(key: 'allowTransparency' | 'cancelEvents' | 'convertEol' | 'cursorBlink' | 'debug' | 'disableStdin' | 'macOptionIsMeta' | 'rightClickSelectsWord' | 'popOnBell' | 'screenKeys' | 'useFlowControl' | 'visualBell' | 'windowsMode'): boolean;
+		getOption(key: 'allowTransparency' | 'cancelEvents' | 'convertEol' | 'cursorBlink' | 'disableStdin' | 'macOptionIsMeta' | 'rightClickSelectsWord' | 'popOnBell' | 'screenKeys' | 'useFlowControl' | 'visualBell' | 'windowsMode'): boolean;
 		/**
 		 * Retrieves an option's value from the terminal.
 		 * @param key The option key.
@@ -700,13 +725,19 @@ declare module 'xterm' {
 		 * @param key The option key.
 		 * @param value The option value.
 		 */
-		setOption(key: 'fontFamily' | 'termName' | 'bellSound', value: string): void;
+		setOption(key: 'fontFamily' | 'termName' | 'bellSound' | 'wordSeparator', value: string): void;
 		/**
 		* Sets an option on the terminal.
 		* @param key The option key.
 		* @param value The option value.
 		*/
 		setOption(key: 'fontWeight' | 'fontWeightBold', value: null | 'normal' | 'bold' | '100' | '200' | '300' | '400' | '500' | '600' | '700' | '800' | '900'): void;
+		/**
+		* Sets an option on the terminal.
+		* @param key The option key.
+		* @param value The option value.
+		*/
+		setOption(key: 'logLevel', value: LogLevel): void;
 		/**
 		 * Sets an option on the terminal.
 		 * @param key The option key.
@@ -724,7 +755,7 @@ declare module 'xterm' {
 		 * @param key The option key.
 		 * @param value The option value.
 		 */
-		setOption(key: 'allowTransparency' | 'cancelEvents' | 'convertEol' | 'cursorBlink' | 'debug' | 'disableStdin' | 'macOptionIsMeta' | 'popOnBell' | 'rightClickSelectsWord' | 'screenKeys' | 'useFlowControl' | 'visualBell' | 'windowsMode', value: boolean): void;
+		setOption(key: 'allowTransparency' | 'cancelEvents' | 'convertEol' | 'cursorBlink' | 'disableStdin' | 'macOptionIsMeta' | 'popOnBell' | 'rightClickSelectsWord' | 'screenKeys' | 'useFlowControl' | 'visualBell' | 'windowsMode', value: boolean): void;
 		/**
 		 * Sets an option on the terminal.
 		 * @param key The option key.
@@ -929,16 +960,16 @@ declare module 'xterm' {
 // Modifications to official .d.ts below
 declare module 'xterm' {
 	interface TerminalCore {
-		debug: boolean;
-
-		handler(text: string): void;
-
 		_onScroll: IEventEmitter<number>;
 		_onKey: IEventEmitter<{ key: string }>;
 
 		_charSizeService: {
 			width: number;
 			height: number;
+		};
+
+		_coreService: {
+			triggerDataEvent(data: string, wasUserInput?: boolean): void;
 		}
 
 		_renderService: {

src/vs/platform/driver/electron-browser/driver.ts

@@ -206,7 +206,7 @@ class WindowDriver implements IWindowDriver {
 			throw new Error(`Xterm not found: ${selector}`);
 		}
 
-		xterm._core.handler(text);
+		xterm._core._coreService.triggerDataEvent(text);
 	}
 
 	async openDevTools(): Promise<void> {

src/vs/workbench/contrib/terminal/browser/terminalInstance.ts

@@ -1420,8 +1420,7 @@ export class TerminalInstance implements ITerminalInstance {
 	}
 
 	public toggleEscapeSequenceLogging(): void {
-		this._xterm._core.debug = !this._xterm._core.debug;
-		this._xterm.setOption('debug', this._xterm._core.debug);
+		this._xterm.setOption('logLevel', 'debug');
 	}
 
 	public getInitialCwd(): Promise<string> {

yarn.lock

@@ -9872,10 +9872,10 @@ xterm-addon-web-links@0.1.0-beta10:
   resolved "https://registry.yarnpkg.com/xterm-addon-web-links/-/xterm-addon-web-links-0.1.0-beta10.tgz#610fa9773a2a5ccd41c1c83ba0e2dd2c9eb66a23"
   integrity sha512-xfpjy0V6bB4BR44qIgZQPoCMVakxb65gMscPkHpO//QxvUxKzabV3dxOsIbeZRFkUGsWTFlvz2OoaBLoNtv5gg==
 
-xterm@3.15.0-beta71:
-  version "3.15.0-beta71"
-  resolved "https://registry.yarnpkg.com/xterm/-/xterm-3.15.0-beta71.tgz#2728c9800ca3b08423e835e9504bd1f4b5de6253"
-  integrity sha512-8M/cLaxZ+iDopRxLPdPfKuDGaNNyYTdCeytdxjMSH0N7dZzbx6fbaEygQdCrV5pO9cGnT92MefSjVPGRXRiBLA==
+xterm@3.15.0-beta87:
+  version "3.15.0-beta87"
+  resolved "https://registry.yarnpkg.com/xterm/-/xterm-3.15.0-beta87.tgz#d04af8d89f1f2c6c1d1580960653c32b2cc344e9"
+  integrity sha512-9HdgqnWCoEErvhk2Q0flDSlpAOnd4o+qe4+GeN6EwzKWPVdm1aNYLwdmeaOKAjZZfE+wchGu+HaslSRwfyu5yg==
 
 y18n@^3.2.1:
   version "3.2.1"