Merge pull request microsoft#94327 from shskwmt/94173-scroll-when-inserting-suggestion

jrieken · web-flow · commit 896de3362b3a · 2020-05-04T11:42:10.000+02:00
Feature microsoft#94173: Scroll when inserting suggestion
diff --git a/src/vs/editor/browser/core/editorState.ts b/src/vs/editor/browser/core/editorState.ts
@@ -156,12 +156,13 @@ export class StableEditorScrollState {
 				visiblePositionScrollDelta = editor.getScrollTop() - visiblePositionScrollTop;
 			}
 		}
-		return new StableEditorScrollState(visiblePosition, visiblePositionScrollDelta);
+		return new StableEditorScrollState(visiblePosition, visiblePositionScrollDelta, editor.getPosition());
 	}
 
 	constructor(
 		private readonly _visiblePosition: Position | null,
-		private readonly _visiblePositionScrollDelta: number
+		private readonly _visiblePositionScrollDelta: number,
+		private readonly _cursorPosition: Position | null
 	) {
 	}
 
@@ -171,4 +172,15 @@ export class StableEditorScrollState {
 			editor.setScrollTop(visiblePositionScrollTop + this._visiblePositionScrollDelta);
 		}
 	}
+
+	public restoreRelativeVerticalPositionOfCursor(editor: ICodeEditor): void {
+		const currentCursorPosition = editor.getPosition();
+
+		if (!this._cursorPosition || !currentCursorPosition) {
+			return;
+		}
+
+		const offset = editor.getTopForLineNumber(currentCursorPosition.lineNumber) - editor.getTopForLineNumber(this._cursorPosition.lineNumber);
+		editor.setScrollTop(editor.getScrollTop() + offset);
+	}
 }
diff --git a/src/vs/editor/contrib/suggest/suggestController.ts b/src/vs/editor/contrib/suggest/suggestController.ts
@@ -8,6 +8,7 @@ import { isNonEmptyArray } from 'vs/base/common/arrays';
 import { onUnexpectedError } from 'vs/base/common/errors';
 import { KeyCode, KeyMod, SimpleKeybinding } from 'vs/base/common/keyCodes';
 import { dispose, IDisposable, DisposableStore, toDisposable, MutableDisposable } from 'vs/base/common/lifecycle';
+import { StableEditorScrollState } from 'vs/editor/browser/core/editorState';
 import { ICodeEditor } from 'vs/editor/browser/editorBrowser';
 import { EditorAction, EditorCommand, registerEditorAction, registerEditorCommand, registerEditorContribution, ServicesAccessor } from 'vs/editor/browser/editorExtensions';
 import { EditOperation } from 'vs/editor/common/core/editOperation';
@@ -273,6 +274,8 @@ export class SuggestController implements IEditorContribution {
 		// keep item in memory
 		this._memoryService.memorize(model, this.editor.getPosition(), item);
 
+		const scrollState = StableEditorScrollState.capture(this.editor);
+
 		if (Array.isArray(suggestion.additionalTextEdits)) {
 			this.editor.executeEdits('suggestController.additionalTextEdits', suggestion.additionalTextEdits.map(edit => EditOperation.replace(Range.lift(edit.range), edit.text)));
 		}
@@ -290,6 +293,8 @@ export class SuggestController implements IEditorContribution {
 			adjustWhitespace: !(suggestion.insertTextRules! & CompletionItemInsertTextRule.KeepWhitespace)
 		});
 
+		scrollState.restoreRelativeVerticalPositionOfCursor(this.editor);
+
 		if (!(flags & InsertFlags.NoAfterUndoStop)) {
 			this.editor.pushUndoStop();
 		}

Original file line number	Diff line number	Diff line change
`@@ -156,12 +156,13 @@ export class StableEditorScrollState {`
`156`	`156`	`visiblePositionScrollDelta = editor.getScrollTop() - visiblePositionScrollTop;`
`157`	`157`	`}`
`158`	`158`	`}`
`159`		`- return new StableEditorScrollState(visiblePosition, visiblePositionScrollDelta);`
	`159`	`+ return new StableEditorScrollState(visiblePosition, visiblePositionScrollDelta, editor.getPosition());`
`160`	`160`	`}`
`161`	`161`
`162`	`162`	`constructor(`
`163`	`163`	`private readonly _visiblePosition: Position \| null,`
`164`		`- private readonly _visiblePositionScrollDelta: number`
	`164`	`+ private readonly _visiblePositionScrollDelta: number,`
	`165`	`+ private readonly _cursorPosition: Position \| null`
`165`	`166`	`) {`
`166`	`167`	`}`
`167`	`168`
`@@ -171,4 +172,15 @@ export class StableEditorScrollState {`
`171`	`172`	`editor.setScrollTop(visiblePositionScrollTop + this._visiblePositionScrollDelta);`
`172`	`173`	`}`
`173`	`174`	`}`
	`175`	`+`
	`176`	`+ public restoreRelativeVerticalPositionOfCursor(editor: ICodeEditor): void {`
	`177`	`+ const currentCursorPosition = editor.getPosition();`
	`178`	`+`
	`179`	`+ if (!this._cursorPosition \|\| !currentCursorPosition) {`
	`180`	`+ return;`
	`181`	`+ }`
	`182`	`+`
	`183`	`+ const offset = editor.getTopForLineNumber(currentCursorPosition.lineNumber) - editor.getTopForLineNumber(this._cursorPosition.lineNumber);`
	`184`	`+ editor.setScrollTop(editor.getScrollTop() + offset);`
	`185`	`+ }`
`174`	`186`	`}`