Adds options for cursor height (microsoft#211473)

* Issue microsoft#168531: Cursor Height. Changed viewCursor to consider cursor height each time cursor is rendered. Cursor height is dependent on font line height and font size.

* Reduce formatting diffs

* Small fixes

---------

Co-authored-by: Alexandru Dima <[email protected]>

Author: omar-cs

src/vs/editor/browser/viewParts/viewCursors/viewCursor.ts

@@ -47,6 +47,7 @@ export class ViewCursor {
 
 	private _cursorStyle: TextEditorCursorStyle;
 	private _lineCursorWidth: number;
+	private _lineCursorHeight: number;
 	private _typicalHalfwidthCharacterWidth: number;
 
 	private _isVisible: boolean;
@@ -65,6 +66,7 @@ export class ViewCursor {
 		this._cursorStyle = options.get(EditorOption.effectiveCursorStyle);
 		this._typicalHalfwidthCharacterWidth = fontInfo.typicalHalfwidthCharacterWidth;
 		this._lineCursorWidth = Math.min(options.get(EditorOption.cursorWidth), this._typicalHalfwidthCharacterWidth);
+		this._lineCursorHeight = options.get(EditorOption.cursorHeight);
 
 		this._isVisible = true;
 
@@ -131,6 +133,7 @@ export class ViewCursor {
 		this._cursorStyle = options.get(EditorOption.effectiveCursorStyle);
 		this._typicalHalfwidthCharacterWidth = fontInfo.typicalHalfwidthCharacterWidth;
 		this._lineCursorWidth = Math.min(options.get(EditorOption.cursorWidth), this._typicalHalfwidthCharacterWidth);
+		this._lineCursorHeight = options.get(EditorOption.cursorHeight);
 		applyFontInfo(this._domNode, fontInfo);
 
 		return true;
@@ -161,6 +164,13 @@ export class ViewCursor {
 		let textContent = '';
 		let textContentClassName = '';
 		const [position, nextGrapheme] = this._getGraphemeAwarePosition();
+		const lineHeight = this._context.viewLayout.getLineHeightForLineNumber(position.lineNumber);
+		const lineCursorHeight = (
+			this._lineCursorHeight === 0
+				? lineHeight // 0 indicates that the cursor should take the full line height
+				: Math.min(lineHeight, this._lineCursorHeight)
+		);
+		const lineHeightAdjustment = (lineHeight - lineCursorHeight) / 2;
 
 		if (this._cursorStyle === TextEditorCursorStyle.Line || this._cursorStyle === TextEditorCursorStyle.LineThin) {
 			const visibleRange = ctx.visibleRangeForPosition(position);
@@ -189,9 +199,8 @@ export class ViewCursor {
 				left -= paddingLeft;
 			}
 
-			const top = ctx.getVerticalOffsetForLineNumber(position.lineNumber) - ctx.bigNumbersDelta;
-			const lineHeight = this._context.viewLayout.getLineHeightForLineNumber(position.lineNumber);
-			return new ViewCursorRenderData(top, left, paddingLeft, width, lineHeight, textContent, textContentClassName);
+			const top = ctx.getVerticalOffsetForLineNumber(position.lineNumber) - ctx.bigNumbersDelta + lineHeightAdjustment;
+			return new ViewCursorRenderData(top, left, paddingLeft, width, lineCursorHeight, textContent, textContentClassName);
 		}
 
 		const visibleRangeForCharacter = ctx.linesVisibleRangesForRange(new Range(position.lineNumber, position.column, position.lineNumber, position.column + nextGrapheme.length), false);
@@ -221,7 +230,6 @@ export class ViewCursor {
 		}
 
 		let top = ctx.getVerticalOffsetForLineNumber(position.lineNumber) - ctx.bigNumbersDelta;
-		const lineHeight = this._context.viewLayout.getLineHeightForLineNumber(position.lineNumber);
 		let height = lineHeight;
 
 		// Underline might interfere with clicking

src/vs/editor/common/config/editorOptions.ts

@@ -272,6 +272,10 @@ export interface IEditorOptions {
 	 * Control the width of the cursor when cursorStyle is set to 'line'
 	 */
 	cursorWidth?: number;
+	/**
+	 * Control the height of the cursor when cursorStyle is set to 'line'
+	 */
+	cursorHeight?: number;
 	/**
 	 * Enable font ligatures.
 	 * Defaults to false.
@@ -5616,6 +5620,7 @@ export const enum EditorOption {
 	cursorSurroundingLines,
 	cursorSurroundingLinesStyle,
 	cursorWidth,
+	cursorHeight,
 	disableLayerHinting,
 	disableMonospaceOptimizations,
 	domReadOnly,
@@ -6026,6 +6031,11 @@ export const EditorOptions = {
 		0, 0, Constants.MAX_SAFE_SMALL_INTEGER,
 		{ markdownDescription: nls.localize('cursorWidth', "Controls the width of the cursor when `#editor.cursorStyle#` is set to `line`.") }
 	)),
+	cursorHeight: register(new EditorIntOption(
+		EditorOption.cursorHeight, 'cursorHeight',
+		0, 0, Constants.MAX_SAFE_SMALL_INTEGER,
+		{ markdownDescription: nls.localize('cursorHeight', "Controls the height of the cursor when `#editor.cursorStyle#` is set to `line`. Cursor's max height depends on line height.") }
+	)),
 	disableLayerHinting: register(new EditorBooleanOption(
 		EditorOption.disableLayerHinting, 'disableLayerHinting', false,
 	)),

src/vs/editor/common/standalone/standaloneEnums.ts

@@ -212,137 +212,138 @@ export enum EditorOption {
 	cursorSurroundingLines = 35,
 	cursorSurroundingLinesStyle = 36,
 	cursorWidth = 37,
-	disableLayerHinting = 38,
-	disableMonospaceOptimizations = 39,
-	domReadOnly = 40,
-	dragAndDrop = 41,
-	dropIntoEditor = 42,
-	editContext = 43,
-	emptySelectionClipboard = 44,
-	experimentalGpuAcceleration = 45,
-	experimentalWhitespaceRendering = 46,
-	extraEditorClassName = 47,
-	fastScrollSensitivity = 48,
-	find = 49,
-	fixedOverflowWidgets = 50,
-	folding = 51,
-	foldingStrategy = 52,
-	foldingHighlight = 53,
-	foldingImportsByDefault = 54,
-	foldingMaximumRegions = 55,
-	unfoldOnClickAfterEndOfLine = 56,
-	fontFamily = 57,
-	fontInfo = 58,
-	fontLigatures = 59,
-	fontSize = 60,
-	fontWeight = 61,
-	fontVariations = 62,
-	formatOnPaste = 63,
-	formatOnType = 64,
-	glyphMargin = 65,
-	gotoLocation = 66,
-	hideCursorInOverviewRuler = 67,
-	hover = 68,
-	inDiffEditor = 69,
-	inlineSuggest = 70,
-	letterSpacing = 71,
-	lightbulb = 72,
-	lineDecorationsWidth = 73,
-	lineHeight = 74,
-	lineNumbers = 75,
-	lineNumbersMinChars = 76,
-	linkedEditing = 77,
-	links = 78,
-	matchBrackets = 79,
-	minimap = 80,
-	mouseStyle = 81,
-	mouseWheelScrollSensitivity = 82,
-	mouseWheelZoom = 83,
-	multiCursorMergeOverlapping = 84,
-	multiCursorModifier = 85,
-	multiCursorPaste = 86,
-	multiCursorLimit = 87,
-	occurrencesHighlight = 88,
-	occurrencesHighlightDelay = 89,
-	overtypeCursorStyle = 90,
-	overtypeOnPaste = 91,
-	overviewRulerBorder = 92,
-	overviewRulerLanes = 93,
-	padding = 94,
-	pasteAs = 95,
-	parameterHints = 96,
-	peekWidgetDefaultFocus = 97,
-	placeholder = 98,
-	definitionLinkOpensInPeek = 99,
-	quickSuggestions = 100,
-	quickSuggestionsDelay = 101,
-	readOnly = 102,
-	readOnlyMessage = 103,
-	renameOnType = 104,
-	renderControlCharacters = 105,
-	renderFinalNewline = 106,
-	renderLineHighlight = 107,
-	renderLineHighlightOnlyWhenFocus = 108,
-	renderValidationDecorations = 109,
-	renderWhitespace = 110,
-	revealHorizontalRightPadding = 111,
-	roundedSelection = 112,
-	rulers = 113,
-	scrollbar = 114,
-	scrollBeyondLastColumn = 115,
-	scrollBeyondLastLine = 116,
-	scrollPredominantAxis = 117,
-	selectionClipboard = 118,
-	selectionHighlight = 119,
-	selectionHighlightMaxLength = 120,
-	selectionHighlightMultiline = 121,
-	selectOnLineNumbers = 122,
-	showFoldingControls = 123,
-	showUnused = 124,
-	snippetSuggestions = 125,
-	smartSelect = 126,
-	smoothScrolling = 127,
-	stickyScroll = 128,
-	stickyTabStops = 129,
-	stopRenderingLineAfter = 130,
-	suggest = 131,
-	suggestFontSize = 132,
-	suggestLineHeight = 133,
-	suggestOnTriggerCharacters = 134,
-	suggestSelection = 135,
-	tabCompletion = 136,
-	tabIndex = 137,
-	unicodeHighlighting = 138,
-	unusualLineTerminators = 139,
-	useShadowDOM = 140,
-	useTabStops = 141,
-	wordBreak = 142,
-	wordSegmenterLocales = 143,
-	wordSeparators = 144,
-	wordWrap = 145,
-	wordWrapBreakAfterCharacters = 146,
-	wordWrapBreakBeforeCharacters = 147,
-	wordWrapColumn = 148,
-	wordWrapOverride1 = 149,
-	wordWrapOverride2 = 150,
-	wrappingIndent = 151,
-	wrappingStrategy = 152,
-	showDeprecated = 153,
-	inertialScroll = 154,
-	inlayHints = 155,
-	wrapOnEscapedLineFeeds = 156,
-	effectiveCursorStyle = 157,
-	editorClassName = 158,
-	pixelRatio = 159,
-	tabFocusMode = 160,
-	layoutInfo = 161,
-	wrappingInfo = 162,
-	defaultColorDecorators = 163,
-	colorDecoratorsActivatedOn = 164,
-	inlineCompletionsAccessibilityVerbose = 165,
-	effectiveEditContext = 166,
-	scrollOnMiddleClick = 167,
-	effectiveAllowVariableFonts = 168
+	cursorHeight = 38,
+	disableLayerHinting = 39,
+	disableMonospaceOptimizations = 40,
+	domReadOnly = 41,
+	dragAndDrop = 42,
+	dropIntoEditor = 43,
+	editContext = 44,
+	emptySelectionClipboard = 45,
+	experimentalGpuAcceleration = 46,
+	experimentalWhitespaceRendering = 47,
+	extraEditorClassName = 48,
+	fastScrollSensitivity = 49,
+	find = 50,
+	fixedOverflowWidgets = 51,
+	folding = 52,
+	foldingStrategy = 53,
+	foldingHighlight = 54,
+	foldingImportsByDefault = 55,
+	foldingMaximumRegions = 56,
+	unfoldOnClickAfterEndOfLine = 57,
+	fontFamily = 58,
+	fontInfo = 59,
+	fontLigatures = 60,
+	fontSize = 61,
+	fontWeight = 62,
+	fontVariations = 63,
+	formatOnPaste = 64,
+	formatOnType = 65,
+	glyphMargin = 66,
+	gotoLocation = 67,
+	hideCursorInOverviewRuler = 68,
+	hover = 69,
+	inDiffEditor = 70,
+	inlineSuggest = 71,
+	letterSpacing = 72,
+	lightbulb = 73,
+	lineDecorationsWidth = 74,
+	lineHeight = 75,
+	lineNumbers = 76,
+	lineNumbersMinChars = 77,
+	linkedEditing = 78,
+	links = 79,
+	matchBrackets = 80,
+	minimap = 81,
+	mouseStyle = 82,
+	mouseWheelScrollSensitivity = 83,
+	mouseWheelZoom = 84,
+	multiCursorMergeOverlapping = 85,
+	multiCursorModifier = 86,
+	multiCursorPaste = 87,
+	multiCursorLimit = 88,
+	occurrencesHighlight = 89,
+	occurrencesHighlightDelay = 90,
+	overtypeCursorStyle = 91,
+	overtypeOnPaste = 92,
+	overviewRulerBorder = 93,
+	overviewRulerLanes = 94,
+	padding = 95,
+	pasteAs = 96,
+	parameterHints = 97,
+	peekWidgetDefaultFocus = 98,
+	placeholder = 99,
+	definitionLinkOpensInPeek = 100,
+	quickSuggestions = 101,
+	quickSuggestionsDelay = 102,
+	readOnly = 103,
+	readOnlyMessage = 104,
+	renameOnType = 105,
+	renderControlCharacters = 106,
+	renderFinalNewline = 107,
+	renderLineHighlight = 108,
+	renderLineHighlightOnlyWhenFocus = 109,
+	renderValidationDecorations = 110,
+	renderWhitespace = 111,
+	revealHorizontalRightPadding = 112,
+	roundedSelection = 113,
+	rulers = 114,
+	scrollbar = 115,
+	scrollBeyondLastColumn = 116,
+	scrollBeyondLastLine = 117,
+	scrollPredominantAxis = 118,
+	selectionClipboard = 119,
+	selectionHighlight = 120,
+	selectionHighlightMaxLength = 121,
+	selectionHighlightMultiline = 122,
+	selectOnLineNumbers = 123,
+	showFoldingControls = 124,
+	showUnused = 125,
+	snippetSuggestions = 126,
+	smartSelect = 127,
+	smoothScrolling = 128,
+	stickyScroll = 129,
+	stickyTabStops = 130,
+	stopRenderingLineAfter = 131,
+	suggest = 132,
+	suggestFontSize = 133,
+	suggestLineHeight = 134,
+	suggestOnTriggerCharacters = 135,
+	suggestSelection = 136,
+	tabCompletion = 137,
+	tabIndex = 138,
+	unicodeHighlighting = 139,
+	unusualLineTerminators = 140,
+	useShadowDOM = 141,
+	useTabStops = 142,
+	wordBreak = 143,
+	wordSegmenterLocales = 144,
+	wordSeparators = 145,
+	wordWrap = 146,
+	wordWrapBreakAfterCharacters = 147,
+	wordWrapBreakBeforeCharacters = 148,
+	wordWrapColumn = 149,
+	wordWrapOverride1 = 150,
+	wordWrapOverride2 = 151,
+	wrappingIndent = 152,
+	wrappingStrategy = 153,
+	showDeprecated = 154,
+	inertialScroll = 155,
+	inlayHints = 156,
+	wrapOnEscapedLineFeeds = 157,
+	effectiveCursorStyle = 158,
+	editorClassName = 159,
+	pixelRatio = 160,
+	tabFocusMode = 161,
+	layoutInfo = 162,
+	wrappingInfo = 163,
+	defaultColorDecorators = 164,
+	colorDecoratorsActivatedOn = 165,
+	inlineCompletionsAccessibilityVerbose = 166,
+	effectiveEditContext = 167,
+	scrollOnMiddleClick = 168,
+	effectiveAllowVariableFonts = 169
 }
 
 /**