viewLineRenderer.ts 23.1 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 123 124
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;
	}

	private readonly _data: Uint32Array;
	public readonly length: number;

125 126 127
	private readonly _partLengths: Uint16Array;

	constructor(length: number, partCount: number) {
128 129
		this.length = length;
		this._data = new Uint32Array(this.length);
130
		this._partLengths = new Uint16Array(partCount);
131 132 133 134 135 136 137 138 139 140
	}

	public setPartData(charOffset: number, partIndex: number, charIndex: number): void {
		let partData = (
			(partIndex << CharacterMappingConstants.PART_INDEX_OFFSET)
			| (charIndex << CharacterMappingConstants.CHAR_INDEX_OFFSET)
		) >>> 0;
		this._data[charOffset] = partData;
	}

141 142 143 144 145 146 147 148
	public setPartLength(partIndex: number, length: number): void {
		this._partLengths[partIndex] = length;
	}

	public getPartLengths(): Uint16Array {
		return this._partLengths;
	}

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 219 220 221 222
	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 已提交
223
export class RenderLineOutput {
A
Alex Dima 已提交
224
	_renderLineOutputBrand: void;
A
Alex Dima 已提交
225

226
	readonly characterMapping: CharacterMapping;
227
	readonly containsRTL: boolean;
228
	readonly containsForeignElements: boolean;
A
Alex Dima 已提交
229

230
	constructor(characterMapping: CharacterMapping, containsRTL: boolean, containsForeignElements: boolean) {
231
		this.characterMapping = characterMapping;
232
		this.containsRTL = containsRTL;
233
		this.containsForeignElements = containsForeignElements;
A
Alex Dima 已提交
234
	}
235 236
}

237
export function renderViewLine(input: RenderLineInput, sb: IStringBuilder): RenderLineOutput {
A
Alex Dima 已提交
238
	if (input.lineContent.length === 0) {
239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260

		let containsForeignElements = false;

		// This is basically for IE's hit test to work
		let content: string = '<span><span>&nbsp;</span></span>';

		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) {
				content = `<span><span class="${classNames.join(' ')}">&nbsp;</span></span>`;
			}
		}

261
		sb.appendASCIIString(content);
A
Alex Dima 已提交
262
		return new RenderLineOutput(
263
			new CharacterMapping(0, 0),
264
			false,
265
			containsForeignElements
A
Alex Dima 已提交
266
		);
267 268
	}

269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285
	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 已提交
286 287 288 289
}

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

A
Alex Dima 已提交
306
function resolveRenderLineInput(input: RenderLineInput): ResolvedRenderLineInput {
307
	const useMonospaceOptimizations = input.useMonospaceOptimizations;
A
Alex Dima 已提交
308
	const lineContent = input.lineContent;
309

A
Alex Dima 已提交
310 311
	let isOverflowing: boolean;
	let len: number;
A
Alex Dima 已提交
312

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

321
	let tokens = transformAndRemoveOverflowing(input.lineTokens, input.fauxIndentLength, len);
A
Alex Dima 已提交
322
	if (input.renderWhitespace === RenderWhitespace.All || input.renderWhitespace === RenderWhitespace.Boundary) {
323
		tokens = _applyRenderWhitespace(lineContent, len, tokens, input.fauxIndentLength, input.tabSize, useMonospaceOptimizations, input.renderWhitespace === RenderWhitespace.Boundary);
A
Alex Dima 已提交
324
	}
325
	let containsForeignElements = false;
A
Alex Dima 已提交
326
	if (input.lineDecorations.length > 0) {
327 328 329 330 331 332 333
		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 已提交
334 335
		tokens = _applyInlineDecorations(lineContent, len, tokens, input.lineDecorations);
	}
336
	let containsRTL = false;
337
	if (input.mightContainRTL) {
338 339
		containsRTL = strings.containsRTL(lineContent);
	}
340
	if (!containsRTL && !input.fontLigatures) {
341
		tokens = splitLargeTokens(lineContent, tokens);
342 343
	}

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

359 360 361 362
/**
 * 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`.
 */
363 364 365 366 367 368 369 370
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, '');
	}

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

386 387 388
	return result;
}

389 390 391 392 393 394 395 396 397 398 399 400
/**
 * 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.
 */
401
function splitLargeTokens(lineContent: string, tokens: LinePart[]): LinePart[] {
402
	let lastTokenEndIndex = 0;
A
Alex Dima 已提交
403
	let result: LinePart[] = [], resultLen = 0;
404 405 406 407 408 409 410 411 412
	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);
413 414 415 416 417
				let lastCharInPiece = lineContent.charCodeAt(pieceEndIndex - 1);
				if (strings.isHighSurrogate(lastCharInPiece)) {
					// Don't cut in the middle of a surrogate pair
					pieceEndIndex--;
				}
A
Alex Dima 已提交
418
				result[resultLen++] = new LinePart(pieceEndIndex, tokenType);
419
			}
A
Alex Dima 已提交
420
			result[resultLen++] = new LinePart(tokenEndIndex, tokenType);
421 422 423 424 425 426 427 428 429 430 431 432 433 434
		} 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 已提交
435
function _applyRenderWhitespace(lineContent: string, len: number, tokens: LinePart[], fauxIndentLength: number, tabSize: number, useMonospaceOptimizations: boolean, onlyBoundary: boolean): LinePart[] {
A
Alex Dima 已提交
436

A
Alex Dima 已提交
437
	let result: LinePart[] = [], resultLen = 0;
A
Alex Dima 已提交
438 439 440
	let tokenIndex = 0;
	let tokenType = tokens[tokenIndex].type;
	let tokenEndIndex = tokens[tokenIndex].endIndex;
441

A
Alex Dima 已提交
442 443 444 445 446 447 448 449 450
	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);
	}
451

A
Alex Dima 已提交
452 453 454 455 456 457 458 459
	let tmpIndent = 0;
	for (let charIndex = 0; charIndex < fauxIndentLength; charIndex++) {
		const chCode = lineContent.charCodeAt(charIndex);
		if (chCode === CharCode.Tab) {
			tmpIndent = tabSize;
		} else {
			tmpIndent++;
		}
460
	}
A
Alex Dima 已提交
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 489 490 491 492
	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
493
			if (!isInWhitespace || (!useMonospaceOptimizations && tmpIndent >= tabSize)) {
A
Alex Dima 已提交
494
				// leaving whitespace token or entering a new indent
A
Alex Dima 已提交
495
				result[resultLen++] = new LinePart(charIndex, 'vs-whitespace');
A
Alex Dima 已提交
496 497 498 499 500
				tmpIndent = tmpIndent % tabSize;
			}
		} else {
			// was in regular token
			if (charIndex === tokenEndIndex || (isInWhitespace && charIndex > fauxIndentLength)) {
A
Alex Dima 已提交
501
				result[resultLen++] = new LinePart(charIndex, tokenType);
A
Alex Dima 已提交
502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522
				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 已提交
523
		result[resultLen++] = new LinePart(len, 'vs-whitespace');
A
Alex Dima 已提交
524 525
	} else {
		// was in regular token
A
Alex Dima 已提交
526
		result[resultLen++] = new LinePart(len, tokenType);
A
Alex Dima 已提交
527 528 529
	}

	return result;
530 531
}

532 533 534 535
/**
 * 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 已提交
536 537
function _applyInlineDecorations(lineContent: string, len: number, tokens: LinePart[], _lineDecorations: LineDecoration[]): LinePart[] {
	_lineDecorations.sort(LineDecoration.compare);
A
Alex Dima 已提交
538 539
	const lineDecorations = LineDecorationsNormalizer.normalize(_lineDecorations);
	const lineDecorationsLen = lineDecorations.length;
A
Alex Dima 已提交
540

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

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

A
Alex Dima 已提交
551 552
			if (lineDecoration.startOffset > lastResultEndIndex) {
				lastResultEndIndex = lineDecoration.startOffset;
A
Alex Dima 已提交
553
				result[resultLen++] = new LinePart(lastResultEndIndex, tokenType);
A
Alex Dima 已提交
554
			}
A
Alex Dima 已提交
555

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

A
Alex Dima 已提交
569 570
		if (tokenEndIndex > lastResultEndIndex) {
			lastResultEndIndex = tokenEndIndex;
A
Alex Dima 已提交
571
			result[resultLen++] = new LinePart(lastResultEndIndex, tokenType);
572
		}
A
Alex Dima 已提交
573
	}
574

A
Alex Dima 已提交
575 576 577
	return result;
}

578 579 580 581
/**
 * 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).
 */
582
function _renderLine(input: ResolvedRenderLineInput, sb: IStringBuilder): RenderLineOutput {
583
	const fontIsMonospace = input.fontIsMonospace;
584
	const containsForeignElements = input.containsForeignElements;
A
Alex Dima 已提交
585 586 587
	const lineContent = input.lineContent;
	const len = input.len;
	const isOverflowing = input.isOverflowing;
A
Alex Dima 已提交
588
	const parts = input.parts;
A
Alex Dima 已提交
589
	const tabSize = input.tabSize;
590
	const containsRTL = input.containsRTL;
A
Alex Dima 已提交
591 592 593 594
	const spaceWidth = input.spaceWidth;
	const renderWhitespace = input.renderWhitespace;
	const renderControlCharacters = input.renderControlCharacters;

A
Alex Dima 已提交
595
	const characterMapping = new CharacterMapping(len + 1, parts.length);
A
Alex Dima 已提交
596 597 598 599 600

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

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

A
Alex Dima 已提交
603 604 605 606 607
	for (let partIndex = 0, tokensLen = parts.length; partIndex < tokensLen; partIndex++) {
		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 已提交
608
		charOffsetInPart = 0;
A
Alex Dima 已提交
609

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

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

			let partContentCnt = 0;
617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645
			{
				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++;
				}
			}

			if (fontIsMonospace || containsForeignElements) {
			} else {
				sb.appendASCIIString(' style="width:');
				sb.appendASCIIString(String(spaceWidth * partContentCnt));
				sb.appendASCIIString('px"');
			}
			sb.appendASCII(CharCode.GreaterThan);

A
Alex Dima 已提交
646 647
			for (; charIndex < partEndIndex; charIndex++) {
				characterMapping.setPartData(charIndex, partIndex, charOffsetInPart);
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.appendASCIIString('&rarr;');
A
Alex Dima 已提交
656 657 658
						insertSpacesCount--;
					}
					while (insertSpacesCount > 0) {
659
						sb.appendASCIIString('&nbsp;');
A
Alex Dima 已提交
660 661
						insertSpacesCount--;
					}
662
				} else {
A
Alex Dima 已提交
663
					// must be CharCode.Space
664
					sb.appendASCIIString('&middot;');
665 666
				}

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

A
Alex Dima 已提交
670
			characterMapping.setPartLength(partIndex, 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 682
			for (; charIndex < partEndIndex; charIndex++) {
				characterMapping.setPartData(charIndex, partIndex, charOffsetInPart);
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.appendASCIIString('&nbsp;');
692
							partContentCnt++;
693 694 695 696
							insertSpacesCount--;
						}
						break;

A
Alex Dima 已提交
697
					case CharCode.Space:
698
						sb.appendASCIIString('&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
						break;

A
Alex Dima 已提交
728
					case CharCode.CarriageReturn:
729
						// zero width space, because carriage return would introduce a line break
730
						sb.appendASCIIString('&#8203;');
731
						partContentCnt++;
732 733 734
						break;

					default:
A
Alex Dima 已提交
735
						if (renderControlCharacters && charCode < 32) {
736
							sb.write1(9216 + charCode);
737
							partContentCnt++;
738
						} else {
739
							sb.write1(charCode);
740
							partContentCnt++;
741
						}
742 743
				}

J
Johannes Rieken 已提交
744
				charOffsetInPart++;
A
Alex Dima 已提交
745
			}
A
Alex Dima 已提交
746

A
Alex Dima 已提交
747
			characterMapping.setPartLength(partIndex, partContentCnt);
A
Alex Dima 已提交
748
		}
749 750 751

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

752 753 754 755
	}

	// 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
A
Alex Dima 已提交
756
	characterMapping.setPartData(len, parts.length - 1, charOffsetInPart);
757

A
Alex Dima 已提交
758
	if (isOverflowing) {
759
		sb.appendASCIIString('<span>&hellip;</span>');
760
	}
A
Alex Dima 已提交
761

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

764
	return new RenderLineOutput(characterMapping, containsRTL, containsForeignElements);
765
}