fix: Block cursor be on inlay hint (#209417)

microsoft · Aug 24, 2024 · c4e5284 · c4e5284
1 parent 6a6ce14
commit c4e5284
Show file tree

Hide file tree

Showing 6 changed files with 38 additions and 8 deletions.
diff --git a/src/vs/editor/common/cursor/oneCursor.ts b/src/vs/editor/common/cursor/oneCursor.ts
@@ -3,7 +3,7 @@
  *  Licensed under the MIT License. See License.txt in the project root for license information.
  *--------------------------------------------------------------------------------------------*/
 
-import { CursorState, ICursorSimpleModel, SelectionStartKind, SingleCursorState } from 'vs/editor/common/cursorCommon';
+import { CursorConfiguration, CursorState, ICursorSimpleModel, SelectionStartKind, SingleCursorState } from 'vs/editor/common/cursorCommon';
 import { CursorContext } from 'vs/editor/common/cursor/cursorContext';
 import { Position } from 'vs/editor/common/core/position';
 import { Range } from 'vs/editor/common/core/range';
@@ -88,12 +88,12 @@ export class Cursor {
 		return viewModel.normalizePosition(position, PositionAffinity.None);
 	}
 
-	private static _validateViewState(viewModel: ICursorSimpleModel, viewState: SingleCursorState): SingleCursorState {
+	private static _validateViewState(viewModel: ICursorSimpleModel, viewState: SingleCursorState, cursorConfig: CursorConfiguration): SingleCursorState {
 		const position = viewState.position;
 		const sStartPosition = viewState.selectionStart.getStartPosition();
 		const sEndPosition = viewState.selectionStart.getEndPosition();
 
-		const validPosition = viewModel.normalizePosition(position, PositionAffinity.None);
+		const validPosition = viewModel.normalizePosition(position, cursorConfig.cursorStyleKind === 'onCharacter' ? PositionAffinity.RightOfInjectedTextBlockCursor : PositionAffinity.None);
 		const validSStartPosition = this._validatePositionWithCache(viewModel, sStartPosition, position, validPosition);
 		const validSEndPosition = this._validatePositionWithCache(viewModel, sEndPosition, sStartPosition, validSStartPosition);
 
@@ -113,7 +113,7 @@ export class Cursor {
 
 	private _setState(context: CursorContext, modelState: SingleCursorState | null, viewState: SingleCursorState | null): void {
 		if (viewState) {
-			viewState = Cursor._validateViewState(context.viewModel, viewState);
+			viewState = Cursor._validateViewState(context.viewModel, viewState, context.cursorConfig);
 		}
 
 		if (!modelState) {

diff --git a/src/vs/editor/common/cursorCommon.ts b/src/vs/editor/common/cursorCommon.ts
@@ -3,7 +3,7 @@
  *  Licensed under the MIT License. See License.txt in the project root for license information.
  *--------------------------------------------------------------------------------------------*/
 
-import { ConfigurationChangedEvent, EditorAutoClosingEditStrategy, EditorAutoClosingStrategy, EditorAutoIndentStrategy, EditorAutoSurroundStrategy, EditorOption } from 'vs/editor/common/config/editorOptions';
+import { ConfigurationChangedEvent, EditorAutoClosingEditStrategy, EditorAutoClosingStrategy, EditorAutoIndentStrategy, EditorAutoSurroundStrategy, EditorOption, TextEditorCursorStyle } from 'vs/editor/common/config/editorOptions';
 import { LineTokens } from 'vs/editor/common/tokens/lineTokens';
 import { Position } from 'vs/editor/common/core/position';
 import { Range } from 'vs/editor/common/core/range';
@@ -81,6 +81,21 @@ export class CursorConfiguration {
 	private readonly _languageId: string;
 	private _electricChars: { [key: string]: boolean } | null;
 
+	public readonly cursorStyle: TextEditorCursorStyle;
+
+	public get cursorStyleKind(): 'beforeCharacter' | 'onCharacter' {
+		switch (this.cursorStyle) {
+			case TextEditorCursorStyle.Line:
+			case TextEditorCursorStyle.LineThin:
+				return 'beforeCharacter';
+			case TextEditorCursorStyle.Block:
+			case TextEditorCursorStyle.Underline:
+			case TextEditorCursorStyle.BlockOutline:
+			case TextEditorCursorStyle.UnderlineThin:
+				return 'onCharacter';
+		}
+	}
+
 	public static shouldRecreate(e: ConfigurationChangedEvent): boolean {
 		return (
 			e.hasChanged(EditorOption.layoutInfo)
@@ -99,6 +114,7 @@ export class CursorConfiguration {
 			|| e.hasChanged(EditorOption.fontInfo)
 			|| e.hasChanged(EditorOption.readOnly)
 			|| e.hasChanged(EditorOption.wordSegmenterLocales)
+			|| e.hasChanged(EditorOption.cursorStyle)
 		);
 	}
 
@@ -141,6 +157,8 @@ export class CursorConfiguration {
 		this.surroundingPairs = {};
 		this._electricChars = null;
 
+		this.cursorStyle = options.get(EditorOption.cursorStyle);
+
 		this.shouldAutoCloseBefore = {
 			quote: this._getShouldAutoClose(languageId, this.autoClosingQuotes, true),
 			comment: this._getShouldAutoClose(languageId, this.autoClosingComments, false),

diff --git a/src/vs/editor/common/model.ts b/src/vs/editor/common/model.ts
@@ -1359,6 +1359,10 @@ export const enum PositionAffinity {
 	 * If the given position is on injected text, prefers the position right of it.
 	*/
 	RightOfInjectedText = 4,
+	/**
+	 * If the given position is on injected text, prefers the position right of it.
+	 */
+	RightOfInjectedTextBlockCursor = 5,
 }
 
 /**

diff --git a/src/vs/editor/common/modelLineProjectionData.ts b/src/vs/editor/common/modelLineProjectionData.ts
@@ -229,7 +229,7 @@ export class ModelLineProjectionData {
 
 				return result;
 			}
-		} else if (affinity === PositionAffinity.Right || affinity === PositionAffinity.RightOfInjectedText) {
+		} else if (affinity === PositionAffinity.Right || affinity === PositionAffinity.RightOfInjectedText || affinity === PositionAffinity.RightOfInjectedTextBlockCursor) {
 			let result = injectedText.offsetInInputWithInjections + injectedText.length;
 			let index = injectedText.injectedTextIndex;
 			// traverse all injected text that touch each other

diff --git a/src/vs/editor/common/standalone/standaloneEnums.ts b/src/vs/editor/common/standalone/standaloneEnums.ts
@@ -795,7 +795,11 @@ export enum PositionAffinity {
 	/**
 	 * If the given position is on injected text, prefers the position right of it.
 	*/
-	RightOfInjectedText = 4
+	RightOfInjectedText = 4,
+	/**
+	 * If the given position is on injected text, prefers the position right of it.
+	 */
+	RightOfInjectedTextBlockCursor = 5
 }
 
 export enum RenderLineNumbersType {

diff --git a/src/vs/monaco.d.ts b/src/vs/monaco.d.ts
@@ -2387,7 +2387,11 @@ declare namespace monaco.editor {
 		/**
 		 * If the given position is on injected text, prefers the position right of it.
 		*/
-		RightOfInjectedText = 4
+		RightOfInjectedText = 4,
+		/**
+		 * If the given position is on injected text, prefers the position right of it.
+		 */
+		RightOfInjectedTextBlockCursor = 5
 	}
 
 	/**