Add image support setting, disabled by default

Author: Tyriar

src/vs/platform/terminal/common/terminal.ts

@@ -117,6 +117,7 @@ export const enum TerminalSettingId {
 	ShellIntegrationDecorationsEnabled = 'terminal.integrated.shellIntegration.decorationsEnabled',
 	ShellIntegrationCommandHistory = 'terminal.integrated.shellIntegration.history',
 	ShellIntegrationSuggestEnabled = 'terminal.integrated.shellIntegration.suggestEnabled',
+	ExperimentalImageSupport = 'terminal.integrated.experimentalImageSupport',
 	SmoothScrolling = 'terminal.integrated.smoothScrolling'
 }
 

src/vs/workbench/contrib/terminal/browser/xterm/xtermTerminal.ts

@@ -246,6 +246,7 @@ export class XtermTerminal extends DisposableStore implements IXtermTerminal, II
 
 		// Load addons
 		this._updateUnicodeVersion();
+		this._refreshImageAddon();
 		this._markNavigationAddon = this._instantiationService.createInstance(MarkNavigationAddon, _capabilities);
 		this.raw.loadAddon(this._markNavigationAddon);
 		this._decorationAddon = this._instantiationService.createInstance(DecorationAddon, this._capabilities);
@@ -254,8 +255,6 @@ export class XtermTerminal extends DisposableStore implements IXtermTerminal, II
 		this._shellIntegrationAddon = this._instantiationService.createInstance(ShellIntegrationAddon, shellIntegrationNonce, disableShellIntegrationReporting, this._telemetryService);
 		this.raw.loadAddon(this._shellIntegrationAddon);
 
-		this._getImageAddon();
-
 		// Load the suggest addon, this should be loaded regardless of the setting as the sequences
 		// may still come in
 		this._suggestAddon = this._instantiationService.createInstance(SuggestAddon, this._terminalSuggestWidgetVisibleContextKey);
@@ -337,6 +336,7 @@ export class XtermTerminal extends DisposableStore implements IXtermTerminal, II
 				this._disposeOfCanvasRenderer();
 			}
 		}
+		this._refreshImageAddon();
 	}
 
 	private _shouldLoadWebgl(): boolean {
@@ -420,19 +420,6 @@ export class XtermTerminal extends DisposableStore implements IXtermTerminal, II
 		return this._searchAddon;
 	}
 
-	private async _getImageAddon(): Promise<ImageAddonType> {
-		if (this._imageAddon) {
-			return this._imageAddon;
-		}
-		console.log('1');
-		const AddonCtor = await this._getImageAddonConstructor();
-		this._imageAddon = new AddonCtor();
-		console.log('2');
-		this.raw.loadAddon(this._imageAddon);
-		console.log('3');
-		return this._imageAddon;
-	}
-
 	clearSearchDecorations(): void {
 		this._searchAddon?.clearDecorations();
 	}
@@ -591,6 +578,23 @@ export class XtermTerminal extends DisposableStore implements IXtermTerminal, II
 		return CanvasAddon;
 	}
 
+	private async _refreshImageAddon(): Promise<void> {
+		if (this._configHelper.config.experimentalImageSupport) {
+			if (!this._imageAddon) {
+				const AddonCtor = await this._getImageAddonConstructor();
+				this._imageAddon = new AddonCtor();
+				this.raw.loadAddon(this._imageAddon);
+			}
+		} else {
+			try {
+				this._imageAddon?.dispose();
+			} catch {
+				// ignore
+			}
+			this._imageAddon = undefined;
+		}
+	}
+
 	protected async _getImageAddonConstructor(): Promise<typeof ImageAddonType> {
 		if (!ImageAddon) {
 			ImageAddon = (await import('xterm-addon-image')).ImageAddon;

src/vs/workbench/contrib/terminal/common/terminal.ts

@@ -304,6 +304,7 @@ export interface ITerminalConfiguration {
 		enabled: boolean;
 		decorationsEnabled: boolean;
 	};
+	experimentalImageSupport: boolean;
 	smoothScrolling: boolean;
 }
 

src/vs/workbench/contrib/terminal/common/terminalConfiguration.ts

@@ -585,7 +585,14 @@ const terminalConfiguration: IConfigurationNode = {
 			markdownDescription: localize('terminal.integrated.smoothScrolling', "Controls whether the terminal will scroll using an animation."),
 			type: 'boolean',
 			default: false
-		}
+		},
+		[TerminalSettingId.ExperimentalImageSupport]: {
+			restricted: true,
+			markdownDescription: localize('terminal.integrated.experimentalImageSupport', "Enables experimental image support in the terminal. Both sixel and iTerm's inline image protocol are supported."),
+			type: 'boolean',
+			default: false,
+			tags: ['experimental']
+		},
 	}
 };