Merge pull request #144080 from microsoft/hediet/widget-position-affi…

…nity

Fixes #132021 by introducing position affinity for widgets.

src/vs/editor/browser/editorBrowser.ts

@@ -140,6 +140,12 @@ export interface IContentWidgetPosition {
 	 * Placement preference for position, in order of preference.
 	 */
 	preference: ContentWidgetPositionPreference[];
+
+	/**
+	 * Placement preference when multiple view positions refer to the same (model) position.
+	 * This plays a role when injected text is involved.
+	*/
+	positionAffinity?: PositionAffinity;
 }
 /**
  * A content widget renders inline with the text and can be easily placed 'near' an editor position.

src/vs/editor/browser/view.ts

@@ -502,7 +502,7 @@ export class View extends ViewEventHandler {
 			}
 		}
 		const newPreference = widgetData.position ? widgetData.position.preference : null;
-		this._contentWidgets.setWidgetPosition(widgetData.widget, newRange, newPreference);
+		this._contentWidgets.setWidgetPosition(widgetData.widget, newRange, newPreference, widgetData.position?.positionAffinity ?? null);
 		this._scheduleRender();
 	}
 

src/vs/editor/browser/viewParts/contentWidgets/contentWidgets.ts

@@ -15,6 +15,7 @@ import * as viewEvents from 'vs/editor/common/viewEvents';
 import { ViewportData } from 'vs/editor/common/viewLayout/viewLinesViewportData';
 import { EditorOption } from 'vs/editor/common/config/editorOptions';
 import { IDimension } from 'vs/editor/common/core/dimension';
+import { PositionAffinity } from 'vs/editor/common/model';
 
 
 class Coordinate {
@@ -112,9 +113,9 @@ export class ViewContentWidgets extends ViewPart {
 		this.setShouldRender();
 	}
 
-	public setWidgetPosition(widget: IContentWidget, range: IRange | null, preference: ContentWidgetPositionPreference[] | null): void {
+	public setWidgetPosition(widget: IContentWidget, range: IRange | null, preference: ContentWidgetPositionPreference[] | null, affinity: PositionAffinity | null): void {
 		const myWidget = this._widgets[widget.getId()];
-		myWidget.setPosition(range, preference);
+		myWidget.setPosition(range, preference, affinity);
 
 		this.setShouldRender();
 	}
@@ -193,6 +194,7 @@ class Widget {
 	private _lineHeight: number;
 
 	private _range: IRange | null;
+	private _affinity: PositionAffinity | null;
 	private _viewRange: Range | null;
 	private _preference: ContentWidgetPositionPreference[] | null;
 	private _cachedDomNodeOffsetWidth: number;
@@ -222,6 +224,7 @@ class Widget {
 
 		this._range = null;
 		this._viewRange = null;
+		this._affinity = null;
 		this._preference = [];
 		this._cachedDomNodeOffsetWidth = -1;
 		this._cachedDomNodeOffsetHeight = -1;
@@ -248,18 +251,19 @@ class Widget {
 	}
 
 	public onLineMappingChanged(e: viewEvents.ViewLineMappingChangedEvent): void {
-		this._setPosition(this._range);
+		this._setPosition(this._range, this._affinity);
 	}
 
-	private _setPosition(range: IRange | null): void {
+	private _setPosition(range: IRange | null, affinity: PositionAffinity | null): void {
 		this._range = range;
 		this._viewRange = null;
+		this._affinity = affinity;
 
 		if (this._range) {
 			// Do not trust that widgets give a valid position
 			const validModelRange = this._context.viewModel.model.validateRange(this._range);
 			if (this._context.viewModel.coordinatesConverter.modelPositionIsVisible(validModelRange.getStartPosition()) || this._context.viewModel.coordinatesConverter.modelPositionIsVisible(validModelRange.getEndPosition())) {
-				this._viewRange = this._context.viewModel.coordinatesConverter.convertModelRangeToViewRange(validModelRange);
+				this._viewRange = this._context.viewModel.coordinatesConverter.convertModelRangeToViewRange(validModelRange, this._affinity ?? undefined);
 			}
 		}
 	}
@@ -272,8 +276,8 @@ class Widget {
 		);
 	}
 
-	public setPosition(range: IRange | null, preference: ContentWidgetPositionPreference[] | null): void {
-		this._setPosition(range);
+	public setPosition(range: IRange | null, preference: ContentWidgetPositionPreference[] | null, affinity: PositionAffinity | null): void {
+		this._setPosition(range, affinity);
 		this._preference = preference;
 		if (this._viewRange && this._preference && this._preference.length > 0) {
 			// this content widget would like to be visible if possible

src/vs/editor/contrib/message/browser/messageController.ts

@@ -13,6 +13,7 @@ import { EditorCommand, registerEditorCommand, registerEditorContribution } from
 import { IPosition } from 'vs/editor/common/core/position';
 import { Range } from 'vs/editor/common/core/range';
 import { IEditorContribution, ScrollType } from 'vs/editor/common/editorCommon';
+import { PositionAffinity } from 'vs/editor/common/model';
 import * as nls from 'vs/nls';
 import { IContextKey, IContextKeyService, RawContextKey } from 'vs/platform/contextkey/common/contextkey';
 import { KeybindingWeight } from 'vs/platform/keybinding/common/keybindingsRegistry';
@@ -181,7 +182,14 @@ class MessageWidget implements IContentWidget {
 	}
 
 	getPosition(): IContentWidgetPosition {
-		return { position: this._position, preference: [ContentWidgetPositionPreference.ABOVE, ContentWidgetPositionPreference.BELOW] };
+		return {
+			position: this._position,
+			preference: [
+				ContentWidgetPositionPreference.ABOVE,
+				ContentWidgetPositionPreference.BELOW,
+			],
+			positionAffinity: PositionAffinity.Right,
+		};
 	}
 
 	afterRender(position: ContentWidgetPositionPreference | null): void {

src/vs/monaco.d.ts

@@ -4608,6 +4608,11 @@ declare namespace monaco.editor {
 		 * Placement preference for position, in order of preference.
 		 */
 		preference: ContentWidgetPositionPreference[];
+		/**
+		 * Placement preference when multiple view positions refer to the same (model) position.
+		 * This plays a role when injected text is involved.
+		*/
+		positionAffinity?: PositionAffinity;
 	}
 
 	/**