Add PromptInputModel.onDidInterrupt

Part of microsoft#210757

Author: Tyriar

src/vs/platform/terminal/common/capabilities/commandDetection/promptInputModel.ts

@@ -19,10 +19,18 @@ const enum PromptInputState {
 	Execute,
 }
 
+/**
+ * A model of the prompt input state using shell integration and analyzing the terminal buffer. This
+ * may not be 100% accurate but provides a best guess.
+ */
 export interface IPromptInputModel {
 	readonly onDidStartInput: Event<IPromptInputModelState>;
 	readonly onDidChangeInput: Event<IPromptInputModelState>;
 	readonly onDidFinishInput: Event<IPromptInputModelState>;
+	/**
+	 * Fires immediately before {@link onDidFinishInput} when a SIGINT/Ctrl+C/^C is detected.
+	 */
+	readonly onDidInterrupt: Event<IPromptInputModelState>;
 
 	readonly value: string;
 	readonly cursorIndex: number;
@@ -48,6 +56,8 @@ export class PromptInputModel extends Disposable implements IPromptInputModel {
 	private _commandStartX: number = 0;
 	private _continuationPrompt: string | undefined;
 
+	private _lastUserInput: string = '';
+
 	private _value: string = '';
 	get value() { return this._value; }
 
@@ -63,6 +73,8 @@ export class PromptInputModel extends Disposable implements IPromptInputModel {
 	readonly onDidChangeInput = this._onDidChangeInput.event;
 	private readonly _onDidFinishInput = this._register(new Emitter<IPromptInputModelState>());
 	readonly onDidFinishInput = this._onDidFinishInput.event;
+	private readonly _onDidInterrupt = this._register(new Emitter<IPromptInputModelState>());
+	readonly onDidInterrupt = this._onDidInterrupt.event;
 
 	constructor(
 		private readonly _xterm: Terminal,
@@ -72,11 +84,12 @@ export class PromptInputModel extends Disposable implements IPromptInputModel {
 	) {
 		super();
 
-		this._register(this._xterm.onData(e => this._handleInput(e)));
 		this._register(Event.any(
-			this._xterm.onWriteParsed,
 			this._xterm.onCursorMove,
+			this._xterm.onData,
+			this._xterm.onWriteParsed,
 		)(() => this._sync()));
+		this._register(this._xterm.onData(e => this._handleUserInput(e)));
 
 		this._register(onCommandStart(e => this._handleCommandStart(e as { marker: IMarker })));
 		this._register(onCommandExecuted(() => this._handleCommandExecuted()));
@@ -121,11 +134,11 @@ export class PromptInputModel extends Disposable implements IPromptInputModel {
 
 		this._state = PromptInputState.Execute;
 		this._cursorIndex = -1;
-		this._onDidFinishInput.fire(this._createStateObject());
-	}
-
-	private _handleInput(data: string) {
-		this._sync();
+		const event = this._createStateObject();
+		if (this._lastUserInput === '\u0003') { // ETX end of text (ctrl+c)
+			this._onDidInterrupt.fire(event);
+		}
+		this._onDidFinishInput.fire(event);
 	}
 
 	@throttle(0)
@@ -207,6 +220,10 @@ export class PromptInputModel extends Disposable implements IPromptInputModel {
 		}
 	}
 
+	private _handleUserInput(e: string) {
+		this._lastUserInput = e;
+	}
+
 	/**
 	 * Detect ghost text by looking for italic or dim text in or after the cursor and
 	 * non-italic/dim text in the cell closest non-whitespace cell before the cursor.

src/vs/platform/terminal/test/common/capabilities/commandDetection/promptInputModel.test.ts

@@ -14,7 +14,7 @@ import { Terminal } from '@xterm/headless';
 import { notDeepStrictEqual, strictEqual } from 'assert';
 import { timeout } from 'vs/base/common/async';
 
-suite('PromptInputModel', () => {
+suite.only('PromptInputModel', () => {
 	const store = ensureNoDisposablesAreLeakedInTestSuite();
 
 	let promptInputModel: PromptInputModel;
@@ -78,7 +78,7 @@ suite('PromptInputModel', () => {
 		await assertPromptInput('|');
 	});
 
-	test('should not fire events when nothing changes', async () => {
+	test('should not fire onDidChangeInput events when nothing changes', async () => {
 		const events: IPromptInputModelState[] = [];
 		store.add(promptInputModel.onDidChangeInput(e => events.push(e)));
 
@@ -108,6 +108,26 @@ suite('PromptInputModel', () => {
 		}
 	});
 
+	test('should fire onDidInterrupt followed by onDidFinish when ctrl+c is pressed', async () => {
+		await writePromise('$ ');
+		fireCommandStart();
+		await assertPromptInput('|');
+
+		await writePromise('foo');
+		await assertPromptInput('foo|');
+
+		await new Promise<void>(r => {
+			store.add(promptInputModel.onDidInterrupt(() => {
+				// Fire onDidFinishInput immediately after onDidInterrupt
+				store.add(promptInputModel.onDidFinishInput(() => {
+					r();
+				}));
+			}));
+			xterm.input('\x03');
+			writePromise('^C').then(() => fireCommandExecuted());
+		});
+	});
+
 	test('cursor navigation', async () => {
 		await writePromise('$ ');
 		fireCommandStart();