Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Exploration: implementing variable line heights #233110

Draft
wants to merge 8 commits into
base: main
Choose a base branch
from
Draft

Exploration: implementing variable line heights #233110

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
03425a9
Fix advanced line wrap if decorations are present
remcohaszing Nov 21, 2023
88e5584
Support dynamic line heights using decorations
remcohaszing Sep 29, 2023
d84a703
undo commenting
aiday-mar Nov 5, 2024
a2637a1
fixing compiler errors
aiday-mar Nov 5, 2024
824113e
placing tests in block comment
aiday-mar Nov 5, 2024
c54ab2c
adding logs
aiday-mar Nov 14, 2024
a98064b
limiting amount of logging
aiday-mar Nov 14, 2024
8a71210
changikng the font size and the line height directly in the code
aiday-mar Nov 14, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions src/vs/editor/browser/observableCodeEditor.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -201,6 +201,8 @@ export class ObservableCodeEditor extends Disposable {
}

public setDecorations(decorations: IObservable<IModelDeltaDecoration[]>): IDisposable {
console.log('setDecorations of ObservableCodeEditor');
console.log('decorations : ', decorations);
const d = new DisposableStore();
const decorationsCollection = this.editor.createDecorationsCollection();
d.add(autorunOpts({ owner: this, debugName: () => `Apply decorations from ${decorations.debugName}` }, reader => {
Expand Down
4 changes: 4 additions & 0 deletions src/vs/editor/browser/services/abstractCodeEditorService.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -457,6 +457,7 @@ class DecorationTypeOptionsProvider implements IModelDecorationOptionsProvider {
public afterContentClassName: string | undefined;
public glyphMarginClassName: string | undefined;
public isWholeLine: boolean;
public lineHeight?: number;
public overviewRuler: IModelDecorationOverviewRulerOptions | undefined;
public stickiness: TrackedRangeStickiness | undefined;
public beforeInjectedText: InjectedTextOptions | undefined;
Expand Down Expand Up @@ -517,6 +518,8 @@ class DecorationTypeOptionsProvider implements IModelDecorationOptionsProvider {

const options = providerArgs.options;
this.isWholeLine = Boolean(options.isWholeLine);
console.log('options.lineHeight : ', options.lineHeight);
this.lineHeight = options.lineHeight;
this.stickiness = options.rangeBehavior;

const lightOverviewRulerColor = options.light && options.light.overviewRulerColor || options.overviewRulerColor;
Expand Down Expand Up @@ -546,6 +549,7 @@ class DecorationTypeOptionsProvider implements IModelDecorationOptionsProvider {
className: this.className,
glyphMarginClassName: this.glyphMarginClassName,
isWholeLine: this.isWholeLine,
lineHeight: this.lineHeight,
overviewRuler: this.overviewRuler,
stickiness: this.stickiness,
before: this.beforeInjectedText,
Expand Down
174 changes: 132 additions & 42 deletions src/vs/editor/browser/view/domLineBreaksComputer.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,15 @@ import { FontInfo } from '../../common/config/fontInfo.js';
import { StringBuilder } from '../../common/core/stringBuilder.js';
import { InjectedTextOptions } from '../../common/model.js';
import { ILineBreaksComputer, ILineBreaksComputerFactory, ModelLineProjectionData } from '../../common/modelLineProjectionData.js';
import { LineInjectedText } from '../../common/textModelEvents.js';
import { InlineClassName, LineInjectedText } from '../../common/textModelEvents.js';

const ttPolicy = createTrustedTypesPolicy('domLineBreaksComputer', { createHTML: value => value });

export class DOMLineBreaksComputerFactory implements ILineBreaksComputerFactory {

private readonly maxLogsIndex = 10;
private currentIndex = 0;

public static create(targetWindow: Window): DOMLineBreaksComputerFactory {
return new DOMLineBreaksComputerFactory(new WeakRef(targetWindow));
}
Expand All @@ -29,19 +32,29 @@ export class DOMLineBreaksComputerFactory implements ILineBreaksComputerFactory
public createLineBreaksComputer(fontInfo: FontInfo, tabSize: number, wrappingColumn: number, wrappingIndent: WrappingIndent, wordBreak: 'normal' | 'keepAll'): ILineBreaksComputer {
const requests: string[] = [];
const injectedTexts: (LineInjectedText[] | null)[] = [];
const inlineClassNames: (InlineClassName[] | null)[] = [];
return {
addRequest: (lineText: string, injectedText: LineInjectedText[] | null, previousLineBreakData: ModelLineProjectionData | null) => {
addRequest: (lineText: string, injectedText: LineInjectedText[] | null, inlineClassName: InlineClassName[] | null, previousLineBreakData: ModelLineProjectionData | null) => {
requests.push(lineText);
injectedTexts.push(injectedText);
if (this.currentIndex < this.maxLogsIndex) {
console.log('inlineClassName : ', inlineClassName);
}
this.currentIndex++;
inlineClassNames.push(inlineClassName);
},
finalize: () => {
return createLineBreaks(assertIsDefined(this.targetWindow.deref()), requests, fontInfo, tabSize, wrappingColumn, wrappingIndent, wordBreak, injectedTexts);
if (this.currentIndex < this.maxLogsIndex) {
console.log('inlineClassNames : ', inlineClassNames);
}
this.currentIndex++;
return createLineBreaks(assertIsDefined(this.targetWindow.deref()), requests, fontInfo, tabSize, wrappingColumn, wrappingIndent, wordBreak, injectedTexts, inlineClassNames, this.maxLogsIndex, this.currentIndex);
}
};
}
}

function createLineBreaks(targetWindow: Window, requests: string[], fontInfo: FontInfo, tabSize: number, firstLineBreakColumn: number, wrappingIndent: WrappingIndent, wordBreak: 'normal' | 'keepAll', injectedTextsPerLine: (LineInjectedText[] | null)[]): (ModelLineProjectionData | null)[] {
function createLineBreaks(targetWindow: Window, requests: string[], fontInfo: FontInfo, tabSize: number, firstLineBreakColumn: number, wrappingIndent: WrappingIndent, wordBreak: 'normal' | 'keepAll', injectedTextsPerLine: (LineInjectedText[] | null)[], inlineClassNamesPerLine: (InlineClassName[] | null)[], maxLogsIndex: number, currentIndex: number): (ModelLineProjectionData | null)[] {
function createEmptyLineBreakWithPossiblyInjectedText(requestIdx: number): ModelLineProjectionData | null {
const injectedTexts = injectedTextsPerLine[requestIdx];
if (injectedTexts) {
Expand Down Expand Up @@ -78,10 +91,13 @@ function createLineBreaks(targetWindow: Window, requests: string[], fontInfo: Fo
const firstNonWhitespaceIndices: number[] = [];
const wrappedTextIndentLengths: number[] = [];
const renderLineContents: string[] = [];
const allCharOffsets: number[][] = [];
const allVisibleColumns: number[][] = [];
for (let i = 0; i < requests.length; i++) {
const lineContent = LineInjectedText.applyInjectedText(requests[i], injectedTextsPerLine[i]);
if (currentIndex < maxLogsIndex) {
console.log('requests[i] : ', requests[i]);
console.log('LineInjectedText.applyInjectedText(requests[i], injectedTextsPerLine[i]) : ', LineInjectedText.applyInjectedText(requests[i], injectedTextsPerLine[i]));
}
const lineContent = requests[i];

let firstNonWhitespaceIndex = 0;
let wrappedTextIndentLength = 0;
Expand Down Expand Up @@ -118,12 +134,10 @@ function createLineBreaks(targetWindow: Window, requests: string[], fontInfo: Fo
}

const renderLineContent = lineContent.substr(firstNonWhitespaceIndex);
const tmp = renderLine(renderLineContent, wrappedTextIndentLength, tabSize, width, sb, additionalIndentLength);
allVisibleColumns[i] = renderLine(renderLineContent, wrappedTextIndentLength, tabSize, width, sb, additionalIndentLength, inlineClassNamesPerLine[i], maxLogsIndex, currentIndex);
firstNonWhitespaceIndices[i] = firstNonWhitespaceIndex;
wrappedTextIndentLengths[i] = wrappedTextIndentLength;
renderLineContents[i] = renderLineContent;
allCharOffsets[i] = tmp[0];
allVisibleColumns[i] = tmp[1];
}
const html = sb.build();
const trustedhtml = ttPolicy?.createHTML(html) ?? html;
Expand All @@ -148,7 +162,7 @@ function createLineBreaks(targetWindow: Window, requests: string[], fontInfo: Fo
const result: (ModelLineProjectionData | null)[] = [];
for (let i = 0; i < requests.length; i++) {
const lineDomNode = lineDomNodes[i];
const breakOffsets: number[] | null = readLineBreaks(range, lineDomNode, renderLineContents[i], allCharOffsets[i]);
const breakOffsets: number[] | null = readLineBreaks(range, lineDomNode, renderLineContents[i], maxLogsIndex, currentIndex);
if (breakOffsets === null) {
result[i] = createEmptyLineBreakWithPossiblyInjectedText(i);
continue;
Expand Down Expand Up @@ -192,7 +206,7 @@ const enum Constants {
SPAN_MODULO_LIMIT = 16384
}

function renderLine(lineContent: string, initialVisibleColumn: number, tabSize: number, width: number, sb: StringBuilder, wrappingIndentLength: number): [number[], number[]] {
function renderLine(lineContent: string, initialVisibleColumn: number, tabSize: number, width: number, sb: StringBuilder, wrappingIndentLength: number, inlineClassNames: InlineClassName[] | null, maxLogsIndex: number, currentIndex: number): number[] {

if (wrappingIndentLength !== 0) {
const hangingOffset = String(wrappingIndentLength);
Expand All @@ -213,16 +227,56 @@ function renderLine(lineContent: string, initialVisibleColumn: number, tabSize:
const len = lineContent.length;
let visibleColumn = initialVisibleColumn;
let charOffset = 0;
const charOffsets: number[] = [];
const visibleColumns: number[] = [];
let nextCharCode = (0 < len ? lineContent.charCodeAt(0) : CharCode.Null);

if (currentIndex < maxLogsIndex) {
console.log('lineContent : ', lineContent);
console.log('inlineClassNames : ', inlineClassNames);
}
const classNames = new Array<string>(len).fill('');
if (inlineClassNames) {
const inlineClassNamesLength = inlineClassNames.length;
for (let i = 0; i < inlineClassNamesLength; i++) {
const inlineClassName = inlineClassNames[i];
const className = inlineClassName.className;
const charStart = inlineClassName.startColumn - 1;
const charEnd = Math.min(inlineClassName.endColumn - 1, len);
if (currentIndex < maxLogsIndex) {
console.log('charStart : ', charStart);
console.log('charEnd : ', charEnd);
}
for (let charIndex = charStart; charIndex < charEnd; charIndex++) {
classNames[charIndex] = classNames[charIndex] += ' ' + className;
}
}
}
if (currentIndex < maxLogsIndex) {
console.log('classNames : ', classNames);
}
// Forxe the text to be aligned vertically. We use the middle alignment to
// calculate whether or not a line is wrapped.
const style = '<span style="vertical-align:middle !important"';
sb.appendString('<span>');
sb.appendString(style);
sb.appendString('>');
let previousClassName: string | undefined;
for (let charIndex = 0; charIndex < len; charIndex++) {
const className = classNames[charIndex];
if (className !== previousClassName) {
sb.appendString('</span>');
sb.appendString(style);
if (className) {
sb.appendString(' class="');
sb.appendString(className);
sb.appendString('"');
}
sb.appendString('>');
previousClassName = className;
}
if (charIndex !== 0 && charIndex % Constants.SPAN_MODULO_LIMIT === 0) {
sb.appendString('</span><span>');
sb.appendString('</span></span><span><span>');
}
charOffsets[charIndex] = charOffset;
visibleColumns[charIndex] = visibleColumn;
const charCode = nextCharCode;
nextCharCode = (charIndex + 1 < len ? lineContent.charCodeAt(charIndex + 1) : CharCode.Null);
Expand Down Expand Up @@ -286,25 +340,43 @@ function renderLine(lineContent: string, initialVisibleColumn: number, tabSize:
charOffset += producedCharacters;
visibleColumn += charWidth;
}
sb.appendString('</span>');
sb.appendString('</span></span>');

charOffsets[lineContent.length] = charOffset;
visibleColumns[lineContent.length] = visibleColumn;

sb.appendString('</div>');

return [charOffsets, visibleColumns];
if (currentIndex < maxLogsIndex) {
console.log('sb.build() : ', sb.build());
}
return visibleColumns;
}

function readLineBreaks(range: Range, lineDomNode: HTMLDivElement, lineContent: string, charOffsets: number[]): number[] | null {
function readLineBreaks(range: Range, lineDomNode: HTMLDivElement, lineContent: string, maxLogsIndex: number, currentIndex: number): number[] | null {
if (currentIndex < maxLogsIndex) {
console.log('lineContent : ', lineContent);
}
if (lineContent.length <= 1) {
return null;
}
const spans = <HTMLSpanElement[]>Array.prototype.slice.call(lineDomNode.children, 0);

const breakOffsets: number[] = [];
try {
discoverBreaks(range, spans, charOffsets, 0, null, lineContent.length - 1, null, breakOffsets);
if (currentIndex < maxLogsIndex) {
console.log('lineDomNode : ', lineDomNode);
}
for (const wrapper of lineDomNode.children) {
if (currentIndex < maxLogsIndex) {
console.log('wrapper : ', wrapper);
}
for (const child of wrapper.children) {
const textNode = child.firstChild;
const length = textNode?.textContent?.length;
if (length) {
discoverBreaks(range, textNode, undefined, 0, length, 0, breakOffsets, maxLogsIndex, currentIndex);
}
}
}
} catch (err) {
console.log(err);
return null;
Expand All @@ -318,34 +390,52 @@ function readLineBreaks(range: Range, lineDomNode: HTMLDivElement, lineContent:
return breakOffsets;
}

function discoverBreaks(range: Range, spans: HTMLSpanElement[], charOffsets: number[], low: number, lowRects: DOMRectList | null, high: number, highRects: DOMRectList | null, result: number[]): void {
function discoverBreaks(range: Range, node: ChildNode, previousMiddle: number | undefined, low: number, high: number, lineOffset: number, result: number[], maxLogsIndex: number, currentIndex: number) {
if (low === high) {
return;
}

lowRects = lowRects || readClientRect(range, spans, charOffsets[low], charOffsets[low + 1]);
highRects = highRects || readClientRect(range, spans, charOffsets[high], charOffsets[high + 1]);

if (Math.abs(lowRects[0].top - highRects[0].top) <= 0.1) {
// same line
return;
}
range.setStart(node, low);
range.setEnd(node, high);
const chunkSize = high - low;

// there is at least one line break between these two offsets
if (low + 1 === high) {
// the two characters are adjacent, so the line break must be exactly between them
result.push(high);
return;
if (currentIndex < maxLogsIndex) {
console.log('discoverBreaks');
console.log('high : ', high);
console.log('low : ', low);
console.log('chunkSize : ', chunkSize);
}

const mid = low + ((high - low) / 2) | 0;
const midRects = readClientRect(range, spans, charOffsets[mid], charOffsets[mid + 1]);
discoverBreaks(range, spans, charOffsets, low, lowRects, mid, midRects, result);
discoverBreaks(range, spans, charOffsets, mid, midRects, high, highRects, result);
}
const rects = range.getClientRects();
if (rects.length === 0) {
lineOffset += chunkSize;
if (currentIndex < maxLogsIndex) {
console.log('lineOffset : ', lineOffset);
}
} else if (rects.length === 1) {
const rect = rects[0];
const middle = (rect.top + rect.bottom) / 2;
if (currentIndex < maxLogsIndex) {
console.log('middle : ', middle);
}
if (previousMiddle !== undefined && Math.abs(previousMiddle - middle) > 0.5) {
result.push(lineOffset);
}

function readClientRect(range: Range, spans: HTMLSpanElement[], startOffset: number, endOffset: number): DOMRectList {
range.setStart(spans[(startOffset / Constants.SPAN_MODULO_LIMIT) | 0].firstChild!, startOffset % Constants.SPAN_MODULO_LIMIT);
range.setEnd(spans[(endOffset / Constants.SPAN_MODULO_LIMIT) | 0].firstChild!, endOffset % Constants.SPAN_MODULO_LIMIT);
return range.getClientRects();
previousMiddle = middle;
lineOffset += chunkSize;
if (currentIndex < maxLogsIndex) {
console.log('lineOffset : ', lineOffset);
}
} else {
let middle = low + ((chunkSize / 2) | 0);
if (currentIndex < maxLogsIndex) {
console.log('middle : ', middle);
}
if (node.textContent!.charCodeAt(middle) === CharCode.Space) {
middle += 1;
}
discoverBreaks(range, node, previousMiddle, low, middle, lineOffset, result, maxLogsIndex, currentIndex);
discoverBreaks(range, node, previousMiddle, middle, high, lineOffset, result, maxLogsIndex, currentIndex);
}
}
Loading
Loading