viewLineRenderer.ts 23.0 KB
Newer Older
1 2 3 4 5 6
/*---------------------------------------------------------------------------------------------
 *  Copyright (c) Microsoft Corporation. All rights reserved.
 *  Licensed under the MIT License. See License.txt in the project root for license information.
 *--------------------------------------------------------------------------------------------*/
'use strict';

A
Alex Dima 已提交
7
import { ViewLineToken } from 'vs/editor/common/core/viewLineToken';
J
Johannes Rieken 已提交
8
import { CharCode } from 'vs/base/common/charCode';
A
Alex Dima 已提交
9
import { LineDecoration, LineDecorationsNormalizer } from 'vs/editor/common/viewLayout/lineDecorations';
A
Alex Dima 已提交
10
import * as strings from 'vs/base/common/strings';
11
import { IStringBuilder, createStringBuilder } from 'vs/editor/common/core/stringBuilder';
A
Alex Dima 已提交
12

A
Alex Dima 已提交
13 14 15 16 17 18
export const enum RenderWhitespace {
	None = 0,
	Boundary = 1,
	All = 2
}

A
Alex Dima 已提交
19 20 21 22 23 24 25 26 27 28 29 30 31 32 33
class LinePart {
	_linePartBrand: void;

	/**
	 * last char index of this token (not inclusive).
	 */
	public readonly endIndex: number;
	public readonly type: string;

	constructor(endIndex: number, type: string) {
		this.endIndex = endIndex;
		this.type = type;
	}
}

A
Alex Dima 已提交
34
export class RenderLineInput {
35

36
	public readonly useMonospaceOptimizations: boolean;
37
	public readonly lineContent: string;
38
	public readonly mightContainRTL: boolean;
39
	public readonly fauxIndentLength: number;
A
Alex Dima 已提交
40
	public readonly lineTokens: ViewLineToken[];
A
Alex Dima 已提交
41
	public readonly lineDecorations: LineDecoration[];
42 43 44
	public readonly tabSize: number;
	public readonly spaceWidth: number;
	public readonly stopRenderingLineAfter: number;
A
Alex Dima 已提交
45
	public readonly renderWhitespace: RenderWhitespace;
46
	public readonly renderControlCharacters: boolean;
47
	public readonly fontLigatures: boolean;
A
Alex Dima 已提交
48 49

	constructor(
50
		useMonospaceOptimizations: boolean,
A
Alex Dima 已提交
51
		lineContent: string,
52
		mightContainRTL: boolean,
53
		fauxIndentLength: number,
A
Alex Dima 已提交
54
		lineTokens: ViewLineToken[],
A
Alex Dima 已提交
55
		lineDecorations: LineDecoration[],
A
Alex Dima 已提交
56
		tabSize: number,
57
		spaceWidth: number,
A
Alex Dima 已提交
58
		stopRenderingLineAfter: number,
59
		renderWhitespace: 'none' | 'boundary' | 'all',
60
		renderControlCharacters: boolean,
61
		fontLigatures: boolean
A
Alex Dima 已提交
62
	) {
63
		this.useMonospaceOptimizations = useMonospaceOptimizations;
A
Alex Dima 已提交
64
		this.lineContent = lineContent;
65
		this.mightContainRTL = mightContainRTL;
66
		this.fauxIndentLength = fauxIndentLength;
67 68
		this.lineTokens = lineTokens;
		this.lineDecorations = lineDecorations;
A
Alex Dima 已提交
69
		this.tabSize = tabSize;
70
		this.spaceWidth = spaceWidth;
A
Alex Dima 已提交
71
		this.stopRenderingLineAfter = stopRenderingLineAfter;
A
Alex Dima 已提交
72 73 74 75 76 77 78
		this.renderWhitespace = (
			renderWhitespace === 'all'
				? RenderWhitespace.All
				: renderWhitespace === 'boundary'
					? RenderWhitespace.Boundary
					: RenderWhitespace.None
		);
79
		this.renderControlCharacters = renderControlCharacters;
80
		this.fontLigatures = fontLigatures;
A
Alex Dima 已提交
81 82
	}

A
Alex Dima 已提交
83
	public equals(other: RenderLineInput): boolean {
A
Alex Dima 已提交
84
		return (
85
			this.useMonospaceOptimizations === other.useMonospaceOptimizations
86
			&& this.lineContent === other.lineContent
87
			&& this.mightContainRTL === other.mightContainRTL
88
			&& this.fauxIndentLength === other.fauxIndentLength
A
Alex Dima 已提交
89 90 91 92 93
			&& this.tabSize === other.tabSize
			&& this.spaceWidth === other.spaceWidth
			&& this.stopRenderingLineAfter === other.stopRenderingLineAfter
			&& this.renderWhitespace === other.renderWhitespace
			&& this.renderControlCharacters === other.renderControlCharacters
94
			&& this.fontLigatures === other.fontLigatures
A
Alex Dima 已提交
95
			&& LineDecoration.equalsArr(this.lineDecorations, other.lineDecorations)
A
Alex Dima 已提交
96
			&& ViewLineToken.equalsArr(this.lineTokens, other.lineTokens)
A
Alex Dima 已提交
97
		);
A
Alex Dima 已提交
98
	}
99 100
}

101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122
export const enum CharacterMappingConstants {
	PART_INDEX_MASK = 0b11111111111111110000000000000000,
	CHAR_INDEX_MASK = 0b00000000000000001111111111111111,

	CHAR_INDEX_OFFSET = 0,
	PART_INDEX_OFFSET = 16
}

/**
 * Provides a both direction mapping between a line's character and its rendered position.
 */
export class CharacterMapping {

	public static getPartIndex(partData: number): number {
		return (partData & CharacterMappingConstants.PART_INDEX_MASK) >>> CharacterMappingConstants.PART_INDEX_OFFSET;
	}

	public static getCharIndex(partData: number): number {
		return (partData & CharacterMappingConstants.CHAR_INDEX_MASK) >>> CharacterMappingConstants.CHAR_INDEX_OFFSET;
	}

	public readonly length: number;
123 124
	private readonly _data: Uint32Array;
	private readonly _absoluteOffsets: Uint32Array;
125 126

	constructor(length: number, partCount: number) {
127 128
		this.length = length;
		this._data = new Uint32Array(this.length);
129
		this._absoluteOffsets = new Uint32Array(this.length);
130 131
	}

132
	public setPartData(charOffset: number, partIndex: number, charIndex: number, partAbsoluteOffset: number): void {
133 134 135 136 137
		let partData = (
			(partIndex << CharacterMappingConstants.PART_INDEX_OFFSET)
			| (charIndex << CharacterMappingConstants.CHAR_INDEX_OFFSET)
		) >>> 0;
		this._data[charOffset] = partData;
138
		this._absoluteOffsets[charOffset] = partAbsoluteOffset + charIndex;
139 140
	}

141 142
	public getAbsoluteOffsets(): Uint32Array {
		return this._absoluteOffsets;
143 144
	}

145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218
	public charOffsetToPartData(charOffset: number): number {
		if (this.length === 0) {
			return 0;
		}
		if (charOffset < 0) {
			return this._data[0];
		}
		if (charOffset >= this.length) {
			return this._data[this.length - 1];
		}
		return this._data[charOffset];
	}

	public partDataToCharOffset(partIndex: number, partLength: number, charIndex: number): number {
		if (this.length === 0) {
			return 0;
		}

		let searchEntry = (
			(partIndex << CharacterMappingConstants.PART_INDEX_OFFSET)
			| (charIndex << CharacterMappingConstants.CHAR_INDEX_OFFSET)
		) >>> 0;

		let min = 0;
		let max = this.length - 1;
		while (min + 1 < max) {
			let mid = ((min + max) >>> 1);
			let midEntry = this._data[mid];
			if (midEntry === searchEntry) {
				return mid;
			} else if (midEntry > searchEntry) {
				max = mid;
			} else {
				min = mid;
			}
		}

		if (min === max) {
			return min;
		}

		let minEntry = this._data[min];
		let maxEntry = this._data[max];

		if (minEntry === searchEntry) {
			return min;
		}
		if (maxEntry === searchEntry) {
			return max;
		}

		let minPartIndex = CharacterMapping.getPartIndex(minEntry);
		let minCharIndex = CharacterMapping.getCharIndex(minEntry);

		let maxPartIndex = CharacterMapping.getPartIndex(maxEntry);
		let maxCharIndex: number;

		if (minPartIndex !== maxPartIndex) {
			// sitting between parts
			maxCharIndex = partLength;
		} else {
			maxCharIndex = CharacterMapping.getCharIndex(maxEntry);
		}

		let minEntryDistance = charIndex - minCharIndex;
		let maxEntryDistance = maxCharIndex - charIndex;

		if (minEntryDistance <= maxEntryDistance) {
			return min;
		}
		return max;
	}
}

A
Alex Dima 已提交
219
export class RenderLineOutput {
A
Alex Dima 已提交
220
	_renderLineOutputBrand: void;
A
Alex Dima 已提交
221

222
	readonly characterMapping: CharacterMapping;
223
	readonly containsRTL: boolean;
224
	readonly containsForeignElements: boolean;
A
Alex Dima 已提交
225

226
	constructor(characterMapping: CharacterMapping, containsRTL: boolean, containsForeignElements: boolean) {
227
		this.characterMapping = characterMapping;
228
		this.containsRTL = containsRTL;
229
		this.containsForeignElements = containsForeignElements;
A
Alex Dima 已提交
230
	}
231 232
}

233
export function renderViewLine(input: RenderLineInput, sb: IStringBuilder): RenderLineOutput {
A
Alex Dima 已提交
234
	if (input.lineContent.length === 0) {
235 236 237 238

		let containsForeignElements = false;

		// This is basically for IE's hit test to work
239
		let content: string = '<span><span>\u00a0</span></span>';
240 241 242 243 244 245 246 247 248 249 250 251 252

		if (input.lineDecorations.length > 0) {
			// This line is empty, but it contains inline decorations
			let classNames: string[] = [];
			for (let i = 0, len = input.lineDecorations.length; i < len; i++) {
				const lineDecoration = input.lineDecorations[i];
				if (lineDecoration.insertsBeforeOrAfter) {
					classNames[i] = input.lineDecorations[i].className;
					containsForeignElements = true;
				}
			}

			if (containsForeignElements) {
253
				content = `<span><span class="${classNames.join(' ')}">\u00a0</span></span>`;
254 255 256
			}
		}

257
		sb.appendASCIIString(content);
A
Alex Dima 已提交
258
		return new RenderLineOutput(
259
			new CharacterMapping(0, 0),
260
			false,
261
			containsForeignElements
A
Alex Dima 已提交
262
		);
263 264
	}

265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281
	return _renderLine(resolveRenderLineInput(input), sb);
}

export class RenderLineOutput2 {
	constructor(
		public readonly characterMapping: CharacterMapping,
		public readonly html: string,
		public readonly containsRTL: boolean,
		public readonly containsForeignElements: boolean
	) {
	}
}

export function renderViewLine2(input: RenderLineInput): RenderLineOutput2 {
	let sb = createStringBuilder(10000);
	let out = renderViewLine(input, sb);
	return new RenderLineOutput2(out.characterMapping, sb.build(), out.containsRTL, out.containsForeignElements);
A
Alex Dima 已提交
282 283 284 285
}

class ResolvedRenderLineInput {
	constructor(
286
		public readonly fontIsMonospace: boolean,
A
Alex Dima 已提交
287 288 289
		public readonly lineContent: string,
		public readonly len: number,
		public readonly isOverflowing: boolean,
A
Alex Dima 已提交
290
		public readonly parts: LinePart[],
291
		public readonly containsForeignElements: boolean,
A
Alex Dima 已提交
292
		public readonly tabSize: number,
293
		public readonly containsRTL: boolean,
A
Alex Dima 已提交
294 295 296 297 298
		public readonly spaceWidth: number,
		public readonly renderWhitespace: RenderWhitespace,
		public readonly renderControlCharacters: boolean,
	) {
		//
299
	}
A
Alex Dima 已提交
300
}
301

A
Alex Dima 已提交
302
function resolveRenderLineInput(input: RenderLineInput): ResolvedRenderLineInput {
303
	const useMonospaceOptimizations = input.useMonospaceOptimizations;
A
Alex Dima 已提交
304
	const lineContent = input.lineContent;
305

A
Alex Dima 已提交
306 307
	let isOverflowing: boolean;
	let len: number;
A
Alex Dima 已提交
308

A
Alex Dima 已提交
309 310 311 312 313 314 315
	if (input.stopRenderingLineAfter !== -1 && input.stopRenderingLineAfter < lineContent.length) {
		isOverflowing = true;
		len = input.stopRenderingLineAfter;
	} else {
		isOverflowing = false;
		len = lineContent.length;
	}
316

317
	let tokens = transformAndRemoveOverflowing(input.lineTokens, input.fauxIndentLength, len);
A
Alex Dima 已提交
318
	if (input.renderWhitespace === RenderWhitespace.All || input.renderWhitespace === RenderWhitespace.Boundary) {
319
		tokens = _applyRenderWhitespace(lineContent, len, tokens, input.fauxIndentLength, input.tabSize, useMonospaceOptimizations, input.renderWhitespace === RenderWhitespace.Boundary);
A
Alex Dima 已提交
320
	}
321
	let containsForeignElements = false;
A
Alex Dima 已提交
322
	if (input.lineDecorations.length > 0) {
323 324 325 326 327 328 329
		for (let i = 0, len = input.lineDecorations.length; i < len; i++) {
			const lineDecoration = input.lineDecorations[i];
			if (lineDecoration.insertsBeforeOrAfter) {
				containsForeignElements = true;
				break;
			}
		}
A
Alex Dima 已提交
330 331
		tokens = _applyInlineDecorations(lineContent, len, tokens, input.lineDecorations);
	}
332
	let containsRTL = false;
333
	if (input.mightContainRTL) {
334 335
		containsRTL = strings.containsRTL(lineContent);
	}
336
	if (!containsRTL && !input.fontLigatures) {
337
		tokens = splitLargeTokens(lineContent, tokens);
338 339
	}

A
Alex Dima 已提交
340
	return new ResolvedRenderLineInput(
341
		useMonospaceOptimizations,
A
Alex Dima 已提交
342 343 344 345
		lineContent,
		len,
		isOverflowing,
		tokens,
346
		containsForeignElements,
A
Alex Dima 已提交
347
		input.tabSize,
348
		containsRTL,
A
Alex Dima 已提交
349 350 351 352
		input.spaceWidth,
		input.renderWhitespace,
		input.renderControlCharacters
	);
353 354
}

355 356 357 358
/**
 * In the rendering phase, characters are always looped until token.endIndex.
 * Ensure that all tokens end before `len` and the last one ends precisely at `len`.
 */
359 360 361 362 363 364 365 366
function transformAndRemoveOverflowing(tokens: ViewLineToken[], fauxIndentLength: number, len: number): LinePart[] {
	let result: LinePart[] = [], resultLen = 0;

	// The faux indent part of the line should have no token type
	if (fauxIndentLength > 0) {
		result[resultLen++] = new LinePart(fauxIndentLength, '');
	}

367
	for (let tokenIndex = 0, tokensLen = tokens.length; tokenIndex < tokensLen; tokenIndex++) {
A
Alex Dima 已提交
368 369
		const token = tokens[tokenIndex];
		const endIndex = token.endIndex;
370 371 372 373
		if (endIndex <= fauxIndentLength) {
			// The faux indent part of the line should have no token type
			continue;
		}
A
Alex Dima 已提交
374 375
		const type = token.getType();
		if (endIndex >= len) {
376
			result[resultLen++] = new LinePart(len, type);
377 378
			break;
		}
379
		result[resultLen++] = new LinePart(endIndex, type);
380
	}
381

382 383 384
	return result;
}

385 386 387 388 389 390 391 392 393 394 395 396
/**
 * written as a const enum to get value inlining.
 */
const enum Constants {
	LongToken = 50
}

/**
 * See https://github.com/Microsoft/vscode/issues/6885.
 * It appears that having very large spans causes very slow reading of character positions.
 * So here we try to avoid that.
 */
397
function splitLargeTokens(lineContent: string, tokens: LinePart[]): LinePart[] {
398
	let lastTokenEndIndex = 0;
A
Alex Dima 已提交
399
	let result: LinePart[] = [], resultLen = 0;
400 401 402 403 404 405 406 407 408
	for (let i = 0, len = tokens.length; i < len; i++) {
		const token = tokens[i];
		const tokenEndIndex = token.endIndex;
		let diff = (tokenEndIndex - lastTokenEndIndex);
		if (diff > Constants.LongToken) {
			const tokenType = token.type;
			const piecesCount = Math.ceil(diff / Constants.LongToken);
			for (let j = 1; j < piecesCount; j++) {
				let pieceEndIndex = lastTokenEndIndex + (j * Constants.LongToken);
409 410 411 412 413
				let lastCharInPiece = lineContent.charCodeAt(pieceEndIndex - 1);
				if (strings.isHighSurrogate(lastCharInPiece)) {
					// Don't cut in the middle of a surrogate pair
					pieceEndIndex--;
				}
A
Alex Dima 已提交
414
				result[resultLen++] = new LinePart(pieceEndIndex, tokenType);
415
			}
A
Alex Dima 已提交
416
			result[resultLen++] = new LinePart(tokenEndIndex, tokenType);
417 418 419 420 421 422 423 424 425 426 427 428 429 430
		} else {
			result[resultLen++] = token;
		}
		lastTokenEndIndex = tokenEndIndex;
	}

	return result;
}

/**
 * Whitespace is rendered by "replacing" tokens with a special-purpose `vs-whitespace` type that is later recognized in the rendering phase.
 * Moreover, a token is created for every visual indent because on some fonts the glyphs used for rendering whitespace (&rarr; or &middot;) do not have the same width as &nbsp;.
 * The rendering phase will generate `style="width:..."` for these tokens.
 */
A
Alex Dima 已提交
431
function _applyRenderWhitespace(lineContent: string, len: number, tokens: LinePart[], fauxIndentLength: number, tabSize: number, useMonospaceOptimizations: boolean, onlyBoundary: boolean): LinePart[] {
A
Alex Dima 已提交
432

A
Alex Dima 已提交
433
	let result: LinePart[] = [], resultLen = 0;
A
Alex Dima 已提交
434 435 436
	let tokenIndex = 0;
	let tokenType = tokens[tokenIndex].type;
	let tokenEndIndex = tokens[tokenIndex].endIndex;
437

A
Alex Dima 已提交
438 439 440 441 442 443 444 445 446
	let firstNonWhitespaceIndex = strings.firstNonWhitespaceIndex(lineContent);
	let lastNonWhitespaceIndex: number;
	if (firstNonWhitespaceIndex === -1) {
		// The entire line is whitespace
		firstNonWhitespaceIndex = len;
		lastNonWhitespaceIndex = len;
	} else {
		lastNonWhitespaceIndex = strings.lastNonWhitespaceIndex(lineContent);
	}
447

A
Alex Dima 已提交
448 449 450 451 452 453 454 455
	let tmpIndent = 0;
	for (let charIndex = 0; charIndex < fauxIndentLength; charIndex++) {
		const chCode = lineContent.charCodeAt(charIndex);
		if (chCode === CharCode.Tab) {
			tmpIndent = tabSize;
		} else {
			tmpIndent++;
		}
456
	}
A
Alex Dima 已提交
457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488
	tmpIndent = tmpIndent % tabSize;

	let wasInWhitespace = false;
	for (let charIndex = fauxIndentLength; charIndex < len; charIndex++) {
		const chCode = lineContent.charCodeAt(charIndex);

		let isInWhitespace: boolean;
		if (charIndex < firstNonWhitespaceIndex || charIndex > lastNonWhitespaceIndex) {
			// in leading or trailing whitespace
			isInWhitespace = true;
		} else if (chCode === CharCode.Tab) {
			// a tab character is rendered both in all and boundary cases
			isInWhitespace = true;
		} else if (chCode === CharCode.Space) {
			// hit a space character
			if (onlyBoundary) {
				// rendering only boundary whitespace
				if (wasInWhitespace) {
					isInWhitespace = true;
				} else {
					const nextChCode = (charIndex + 1 < len ? lineContent.charCodeAt(charIndex + 1) : CharCode.Null);
					isInWhitespace = (nextChCode === CharCode.Space || nextChCode === CharCode.Tab);
				}
			} else {
				isInWhitespace = true;
			}
		} else {
			isInWhitespace = false;
		}

		if (wasInWhitespace) {
			// was in whitespace token
489
			if (!isInWhitespace || (!useMonospaceOptimizations && tmpIndent >= tabSize)) {
A
Alex Dima 已提交
490
				// leaving whitespace token or entering a new indent
A
Alex Dima 已提交
491
				result[resultLen++] = new LinePart(charIndex, 'vs-whitespace');
A
Alex Dima 已提交
492 493 494 495 496
				tmpIndent = tmpIndent % tabSize;
			}
		} else {
			// was in regular token
			if (charIndex === tokenEndIndex || (isInWhitespace && charIndex > fauxIndentLength)) {
A
Alex Dima 已提交
497
				result[resultLen++] = new LinePart(charIndex, tokenType);
A
Alex Dima 已提交
498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518
				tmpIndent = tmpIndent % tabSize;
			}
		}

		if (chCode === CharCode.Tab) {
			tmpIndent = tabSize;
		} else {
			tmpIndent++;
		}

		wasInWhitespace = isInWhitespace;

		if (charIndex === tokenEndIndex) {
			tokenIndex++;
			tokenType = tokens[tokenIndex].type;
			tokenEndIndex = tokens[tokenIndex].endIndex;
		}
	}

	if (wasInWhitespace) {
		// was in whitespace token
A
Alex Dima 已提交
519
		result[resultLen++] = new LinePart(len, 'vs-whitespace');
A
Alex Dima 已提交
520 521
	} else {
		// was in regular token
A
Alex Dima 已提交
522
		result[resultLen++] = new LinePart(len, tokenType);
A
Alex Dima 已提交
523 524 525
	}

	return result;
526 527
}

528 529 530 531
/**
 * Inline decorations are "merged" on top of tokens.
 * Special care must be taken when multiple inline decorations are at play and they overlap.
 */
A
Alex Dima 已提交
532 533
function _applyInlineDecorations(lineContent: string, len: number, tokens: LinePart[], _lineDecorations: LineDecoration[]): LinePart[] {
	_lineDecorations.sort(LineDecoration.compare);
A
Alex Dima 已提交
534 535
	const lineDecorations = LineDecorationsNormalizer.normalize(_lineDecorations);
	const lineDecorationsLen = lineDecorations.length;
A
Alex Dima 已提交
536

A
Alex Dima 已提交
537
	let lineDecorationIndex = 0;
A
Alex Dima 已提交
538
	let result: LinePart[] = [], resultLen = 0, lastResultEndIndex = 0;
A
Alex Dima 已提交
539 540 541 542
	for (let tokenIndex = 0, len = tokens.length; tokenIndex < len; tokenIndex++) {
		const token = tokens[tokenIndex];
		const tokenEndIndex = token.endIndex;
		const tokenType = token.type;
543

A
Alex Dima 已提交
544 545
		while (lineDecorationIndex < lineDecorationsLen && lineDecorations[lineDecorationIndex].startOffset < tokenEndIndex) {
			const lineDecoration = lineDecorations[lineDecorationIndex];
546

A
Alex Dima 已提交
547 548
			if (lineDecoration.startOffset > lastResultEndIndex) {
				lastResultEndIndex = lineDecoration.startOffset;
A
Alex Dima 已提交
549
				result[resultLen++] = new LinePart(lastResultEndIndex, tokenType);
A
Alex Dima 已提交
550
			}
A
Alex Dima 已提交
551

552
			if (lineDecoration.endOffset + 1 <= tokenEndIndex) {
553
				// This line decoration ends before this token ends
A
Alex Dima 已提交
554
				lastResultEndIndex = lineDecoration.endOffset + 1;
A
Alex Dima 已提交
555
				result[resultLen++] = new LinePart(lastResultEndIndex, tokenType + ' ' + lineDecoration.className);
A
Alex Dima 已提交
556 557
				lineDecorationIndex++;
			} else {
558 559
				// This line decoration continues on to the next token
				lastResultEndIndex = tokenEndIndex;
A
Alex Dima 已提交
560
				result[resultLen++] = new LinePart(lastResultEndIndex, tokenType + ' ' + lineDecoration.className);
A
Alex Dima 已提交
561 562 563
				break;
			}
		}
564

A
Alex Dima 已提交
565 566
		if (tokenEndIndex > lastResultEndIndex) {
			lastResultEndIndex = tokenEndIndex;
A
Alex Dima 已提交
567
			result[resultLen++] = new LinePart(lastResultEndIndex, tokenType);
568
		}
A
Alex Dima 已提交
569
	}
570

A
Alex Dima 已提交
571 572 573
	return result;
}

574 575 576 577
/**
 * This function is on purpose not split up into multiple functions to allow runtime type inference (i.e. performance reasons).
 * Notice how all the needed data is fully resolved and passed in (i.e. no other calls).
 */
578
function _renderLine(input: ResolvedRenderLineInput, sb: IStringBuilder): RenderLineOutput {
579
	const fontIsMonospace = input.fontIsMonospace;
580
	const containsForeignElements = input.containsForeignElements;
A
Alex Dima 已提交
581 582 583
	const lineContent = input.lineContent;
	const len = input.len;
	const isOverflowing = input.isOverflowing;
A
Alex Dima 已提交
584
	const parts = input.parts;
A
Alex Dima 已提交
585
	const tabSize = input.tabSize;
586
	const containsRTL = input.containsRTL;
A
Alex Dima 已提交
587 588 589 590
	const spaceWidth = input.spaceWidth;
	const renderWhitespace = input.renderWhitespace;
	const renderControlCharacters = input.renderControlCharacters;

A
Alex Dima 已提交
591
	const characterMapping = new CharacterMapping(len + 1, parts.length);
A
Alex Dima 已提交
592 593 594 595 596

	let charIndex = 0;
	let tabsCharDelta = 0;
	let charOffsetInPart = 0;

597 598 599
	let prevPartContentCnt = 0;
	let partAbsoluteOffset = 0;

600 601
	sb.appendASCIIString('<span>');

A
Alex Dima 已提交
602
	for (let partIndex = 0, tokensLen = parts.length; partIndex < tokensLen; partIndex++) {
603 604
		partAbsoluteOffset += prevPartContentCnt;

A
Alex Dima 已提交
605 606 607 608
		const part = parts[partIndex];
		const partEndIndex = part.endIndex;
		const partType = part.type;
		const partRendersWhitespace = (renderWhitespace !== RenderWhitespace.None && (partType.indexOf('vs-whitespace') >= 0));
A
Alex Dima 已提交
609
		charOffsetInPart = 0;
A
Alex Dima 已提交
610

611 612 613 614
		sb.appendASCIIString('<span class="');
		sb.appendASCIIString(partType);
		sb.appendASCII(CharCode.DoubleQuote);

A
Alex Dima 已提交
615
		if (partRendersWhitespace) {
616 617

			let partContentCnt = 0;
618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638
			{
				let _charIndex = charIndex;
				let _tabsCharDelta = tabsCharDelta;
				let _charOffsetInPart = charOffsetInPart;

				for (; _charIndex < partEndIndex; _charIndex++) {
					const charCode = lineContent.charCodeAt(_charIndex);

					if (charCode === CharCode.Tab) {
						let insertSpacesCount = tabSize - (_charIndex + _tabsCharDelta) % tabSize;
						_tabsCharDelta += insertSpacesCount - 1;
						_charOffsetInPart += insertSpacesCount - 1;
						partContentCnt += insertSpacesCount;
					} else {
						partContentCnt++;
					}

					_charOffsetInPart++;
				}
			}

639
			if (!fontIsMonospace && !containsForeignElements) {
640 641 642 643 644 645
				sb.appendASCIIString(' style="width:');
				sb.appendASCIIString(String(spaceWidth * partContentCnt));
				sb.appendASCIIString('px"');
			}
			sb.appendASCII(CharCode.GreaterThan);

A
Alex Dima 已提交
646
			for (; charIndex < partEndIndex; charIndex++) {
647
				characterMapping.setPartData(charIndex, partIndex, charOffsetInPart, partAbsoluteOffset);
A
Alex Dima 已提交
648
				const charCode = lineContent.charCodeAt(charIndex);
A
Alex Dima 已提交
649

A
Alex Dima 已提交
650
				if (charCode === CharCode.Tab) {
A
Alex Dima 已提交
651 652 653 654
					let insertSpacesCount = tabSize - (charIndex + tabsCharDelta) % tabSize;
					tabsCharDelta += insertSpacesCount - 1;
					charOffsetInPart += insertSpacesCount - 1;
					if (insertSpacesCount > 0) {
655
						sb.write1(0x2192); // &rarr;
A
Alex Dima 已提交
656 657 658
						insertSpacesCount--;
					}
					while (insertSpacesCount > 0) {
659
						sb.write1(0xA0); // &nbsp;
A
Alex Dima 已提交
660 661
						insertSpacesCount--;
					}
662
				} else {
A
Alex Dima 已提交
663
					// must be CharCode.Space
664
					sb.write1(0xb7); // &middot;
665 666
				}

J
Johannes Rieken 已提交
667
				charOffsetInPart++;
A
Alex Dima 已提交
668
			}
A
Alex Dima 已提交
669

670
			prevPartContentCnt = partContentCnt;
A
Alex Dima 已提交
671

672
		} else {
673 674

			let partContentCnt = 0;
675 676 677 678 679

			if (containsRTL) {
				sb.appendASCIIString(' dir="ltr"');
			}
			sb.appendASCII(CharCode.GreaterThan);
680

A
Alex Dima 已提交
681
			for (; charIndex < partEndIndex; charIndex++) {
682
				characterMapping.setPartData(charIndex, partIndex, charOffsetInPart, partAbsoluteOffset);
A
Alex Dima 已提交
683
				const charCode = lineContent.charCodeAt(charIndex);
684 685

				switch (charCode) {
A
Alex Dima 已提交
686
					case CharCode.Tab:
687 688 689 690
						let insertSpacesCount = tabSize - (charIndex + tabsCharDelta) % tabSize;
						tabsCharDelta += insertSpacesCount - 1;
						charOffsetInPart += insertSpacesCount - 1;
						while (insertSpacesCount > 0) {
691
							sb.write1(0xA0); // &nbsp;
692
							partContentCnt++;
693 694 695 696
							insertSpacesCount--;
						}
						break;

A
Alex Dima 已提交
697
					case CharCode.Space:
698
						sb.write1(0xA0); // &nbsp;
699
						partContentCnt++;
700 701
						break;

A
Alex Dima 已提交
702
					case CharCode.LessThan:
703
						sb.appendASCIIString('&lt;');
704
						partContentCnt++;
705 706
						break;

A
Alex Dima 已提交
707
					case CharCode.GreaterThan:
708
						sb.appendASCIIString('&gt;');
709
						partContentCnt++;
710 711
						break;

A
Alex Dima 已提交
712
					case CharCode.Ampersand:
713
						sb.appendASCIIString('&amp;');
714
						partContentCnt++;
715 716
						break;

A
Alex Dima 已提交
717
					case CharCode.Null:
718
						sb.appendASCIIString('&#00;');
719
						partContentCnt++;
720 721
						break;

A
Alex Dima 已提交
722 723
					case CharCode.UTF8_BOM:
					case CharCode.LINE_SEPARATOR_2028:
724
						sb.write1(0xfffd);
725
						partContentCnt++;
726 727 728
						break;

					default:
A
Alex Dima 已提交
729
						if (renderControlCharacters && charCode < 32) {
730
							sb.write1(9216 + charCode);
731
							partContentCnt++;
732
						} else {
733
							sb.write1(charCode);
734
							partContentCnt++;
735
						}
736 737
				}

J
Johannes Rieken 已提交
738
				charOffsetInPart++;
A
Alex Dima 已提交
739
			}
A
Alex Dima 已提交
740

741
			prevPartContentCnt = partContentCnt;
A
Alex Dima 已提交
742
		}
743 744 745

		sb.appendASCIIString('</span>');

746 747 748 749
	}

	// When getting client rects for the last character, we will position the
	// text range at the end of the span, insteaf of at the beginning of next span
750
	characterMapping.setPartData(len, parts.length - 1, charOffsetInPart, partAbsoluteOffset);
751

A
Alex Dima 已提交
752
	if (isOverflowing) {
753
		sb.appendASCIIString('<span>&hellip;</span>');
754
	}
A
Alex Dima 已提交
755

756
	sb.appendASCIIString('</span>');
757

758
	return new RenderLineOutput(characterMapping, containsRTL, containsForeignElements);
759
}