-
Notifications
You must be signed in to change notification settings - Fork 28.9k
/
whitespace.ts
327 lines (286 loc) · 12.6 KB
/
whitespace.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
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
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
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
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
/*---------------------------------------------------------------------------------------------
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the MIT License. See License.txt in the project root for license information.
*--------------------------------------------------------------------------------------------*/
import 'vs/css!./whitespace';
import { DynamicViewOverlay } from 'vs/editor/browser/view/dynamicViewOverlay';
import { Selection } from 'vs/editor/common/core/selection';
import { RenderingContext } from 'vs/editor/browser/view/renderingContext';
import { ViewContext } from 'vs/editor/common/viewModel/viewContext';
import * as viewEvents from 'vs/editor/common/viewEvents';
import { ViewLineData } from 'vs/editor/common/viewModel';
import { EditorOption } from 'vs/editor/common/config/editorOptions';
import { IEditorConfiguration } from 'vs/editor/common/config/editorConfiguration';
import * as strings from 'vs/base/common/strings';
import { CharCode } from 'vs/base/common/charCode';
import { LineRange } from 'vs/editor/common/viewLayout/viewLineRenderer';
import { Position } from 'vs/editor/common/core/position';
import { editorWhitespaces } from 'vs/editor/common/core/editorColorRegistry';
export class WhitespaceOverlay extends DynamicViewOverlay {
private readonly _context: ViewContext;
private _options: WhitespaceOptions;
private _selection: Selection[];
private _renderResult: string[] | null;
constructor(context: ViewContext) {
super();
this._context = context;
this._options = new WhitespaceOptions(this._context.configuration);
this._selection = [];
this._renderResult = null;
this._context.addEventHandler(this);
}
public override dispose(): void {
this._context.removeEventHandler(this);
this._renderResult = null;
super.dispose();
}
// --- begin event handlers
public override onConfigurationChanged(e: viewEvents.ViewConfigurationChangedEvent): boolean {
const newOptions = new WhitespaceOptions(this._context.configuration);
if (this._options.equals(newOptions)) {
return e.hasChanged(EditorOption.layoutInfo);
}
this._options = newOptions;
return true;
}
public override onCursorStateChanged(e: viewEvents.ViewCursorStateChangedEvent): boolean {
this._selection = e.selections;
if (this._options.renderWhitespace === 'selection') {
return true;
}
return false;
}
public override onDecorationsChanged(e: viewEvents.ViewDecorationsChangedEvent): boolean {
return true;
}
public override onFlushed(e: viewEvents.ViewFlushedEvent): boolean {
return true;
}
public override onLinesChanged(e: viewEvents.ViewLinesChangedEvent): boolean {
return true;
}
public override onLinesDeleted(e: viewEvents.ViewLinesDeletedEvent): boolean {
return true;
}
public override onLinesInserted(e: viewEvents.ViewLinesInsertedEvent): boolean {
return true;
}
public override onScrollChanged(e: viewEvents.ViewScrollChangedEvent): boolean {
return e.scrollTopChanged;
}
public override onZonesChanged(e: viewEvents.ViewZonesChangedEvent): boolean {
return true;
}
// --- end event handlers
public prepareRender(ctx: RenderingContext): void {
if (this._options.renderWhitespace === 'none') {
this._renderResult = null;
return;
}
const startLineNumber = ctx.visibleRange.startLineNumber;
const endLineNumber = ctx.visibleRange.endLineNumber;
const lineCount = endLineNumber - startLineNumber + 1;
const needed = new Array<boolean>(lineCount);
for (let i = 0; i < lineCount; i++) {
needed[i] = true;
}
const viewportData = this._context.viewModel.getMinimapLinesRenderingData(ctx.viewportData.startLineNumber, ctx.viewportData.endLineNumber, needed);
this._renderResult = [];
for (let lineNumber = ctx.viewportData.startLineNumber; lineNumber <= ctx.viewportData.endLineNumber; lineNumber++) {
const lineIndex = lineNumber - ctx.viewportData.startLineNumber;
const lineData = viewportData.data[lineIndex]!;
let selectionsOnLine: LineRange[] | null = null;
if (this._options.renderWhitespace === 'selection') {
const selections = this._selection;
for (const selection of selections) {
if (selection.endLineNumber < lineNumber || selection.startLineNumber > lineNumber) {
// Selection does not intersect line
continue;
}
const startColumn = (selection.startLineNumber === lineNumber ? selection.startColumn : lineData.minColumn);
const endColumn = (selection.endLineNumber === lineNumber ? selection.endColumn : lineData.maxColumn);
if (startColumn < endColumn) {
if (!selectionsOnLine) {
selectionsOnLine = [];
}
selectionsOnLine.push(new LineRange(startColumn - 1, endColumn - 1));
}
}
}
this._renderResult[lineIndex] = this._applyRenderWhitespace(ctx, lineNumber, selectionsOnLine, lineData);
}
}
private _applyRenderWhitespace(ctx: RenderingContext, lineNumber: number, selections: LineRange[] | null, lineData: ViewLineData): string {
if (this._options.renderWhitespace === 'selection' && !selections) {
return '';
}
if (this._options.renderWhitespace === 'trailing' && lineData.continuesWithWrappedLine) {
return '';
}
const color = this._context.theme.getColor(editorWhitespaces);
const USE_SVG = this._options.renderWithSVG;
const lineContent = lineData.content;
const len = (this._options.stopRenderingLineAfter === -1 ? lineContent.length : Math.min(this._options.stopRenderingLineAfter, lineContent.length));
const continuesWithWrappedLine = lineData.continuesWithWrappedLine;
const fauxIndentLength = lineData.minColumn - 1;
const onlyBoundary = (this._options.renderWhitespace === 'boundary');
const onlyTrailing = (this._options.renderWhitespace === 'trailing');
const lineHeight = this._options.lineHeight;
const middotWidth = this._options.middotWidth;
const wsmiddotWidth = this._options.wsmiddotWidth;
const spaceWidth = this._options.spaceWidth;
const wsmiddotDiff = Math.abs(wsmiddotWidth - spaceWidth);
const middotDiff = Math.abs(middotWidth - spaceWidth);
// U+2E31 - WORD SEPARATOR MIDDLE DOT
// U+00B7 - MIDDLE DOT
const renderSpaceCharCode = (wsmiddotDiff < middotDiff ? 0x2E31 : 0xB7);
const canUseHalfwidthRightwardsArrow = this._options.canUseHalfwidthRightwardsArrow;
let result: string = '';
let lineIsEmptyOrWhitespace = false;
let firstNonWhitespaceIndex = strings.firstNonWhitespaceIndex(lineContent);
let lastNonWhitespaceIndex: number;
if (firstNonWhitespaceIndex === -1) {
lineIsEmptyOrWhitespace = true;
firstNonWhitespaceIndex = len;
lastNonWhitespaceIndex = len;
} else {
lastNonWhitespaceIndex = strings.lastNonWhitespaceIndex(lineContent);
}
let currentSelectionIndex = 0;
let currentSelection = selections && selections[currentSelectionIndex];
let maxLeft = 0;
for (let charIndex = fauxIndentLength; charIndex < len; charIndex++) {
const chCode = lineContent.charCodeAt(charIndex);
if (currentSelection && charIndex >= currentSelection.endOffset) {
currentSelectionIndex++;
currentSelection = selections && selections[currentSelectionIndex];
}
if (chCode !== CharCode.Tab && chCode !== CharCode.Space) {
continue;
}
if (onlyTrailing && !lineIsEmptyOrWhitespace && charIndex <= lastNonWhitespaceIndex) {
// If rendering only trailing whitespace, check that the charIndex points to trailing whitespace.
continue;
}
if (onlyBoundary && charIndex >= firstNonWhitespaceIndex && charIndex <= lastNonWhitespaceIndex && chCode === CharCode.Space) {
// rendering only boundary whitespace
const prevChCode = (charIndex - 1 >= 0 ? lineContent.charCodeAt(charIndex - 1) : CharCode.Null);
const nextChCode = (charIndex + 1 < len ? lineContent.charCodeAt(charIndex + 1) : CharCode.Null);
if (prevChCode !== CharCode.Space && nextChCode !== CharCode.Space) {
continue;
}
}
if (onlyBoundary && continuesWithWrappedLine && charIndex === len - 1) {
const prevCharCode = (charIndex - 1 >= 0 ? lineContent.charCodeAt(charIndex - 1) : CharCode.Null);
const isSingleTrailingSpace = (chCode === CharCode.Space && (prevCharCode !== CharCode.Space && prevCharCode !== CharCode.Tab));
if (isSingleTrailingSpace) {
continue;
}
}
if (selections && (!currentSelection || currentSelection.startOffset > charIndex || currentSelection.endOffset <= charIndex)) {
// If rendering whitespace on selection, check that the charIndex falls within a selection
continue;
}
const visibleRange = ctx.visibleRangeForPosition(new Position(lineNumber, charIndex + 1));
if (!visibleRange) {
continue;
}
if (USE_SVG) {
maxLeft = Math.max(maxLeft, visibleRange.left);
if (chCode === CharCode.Tab) {
result += this._renderArrow(lineHeight, spaceWidth, visibleRange.left);
} else {
result += `<circle cx="${(visibleRange.left + spaceWidth / 2).toFixed(2)}" cy="${(lineHeight / 2).toFixed(2)}" r="${(spaceWidth / 7).toFixed(2)}" />`;
}
} else {
if (chCode === CharCode.Tab) {
result += `<div class="mwh" style="left:${visibleRange.left}px;height:${lineHeight}px;">${canUseHalfwidthRightwardsArrow ? String.fromCharCode(0xFFEB) : String.fromCharCode(0x2192)}</div>`;
} else {
result += `<div class="mwh" style="left:${visibleRange.left}px;height:${lineHeight}px;">${String.fromCharCode(renderSpaceCharCode)}</div>`;
}
}
}
if (USE_SVG) {
maxLeft = Math.round(maxLeft + spaceWidth);
return (
`<svg style="bottom:0;position:absolute;width:${maxLeft}px;height:${lineHeight}px" viewBox="0 0 ${maxLeft} ${lineHeight}" xmlns="http://www.w3.org/2000/svg" fill="${color}">`
+ result
+ `</svg>`
);
}
return result;
}
private _renderArrow(lineHeight: number, spaceWidth: number, left: number): string {
const strokeWidth = spaceWidth / 7;
const width = spaceWidth;
const dy = lineHeight / 2;
const dx = left;
const p1 = { x: 0, y: strokeWidth / 2 };
const p2 = { x: 100 / 125 * width, y: p1.y };
const p3 = { x: p2.x - 0.2 * p2.x, y: p2.y + 0.2 * p2.x };
const p4 = { x: p3.x + 0.1 * p2.x, y: p3.y + 0.1 * p2.x };
const p5 = { x: p4.x + 0.35 * p2.x, y: p4.y - 0.35 * p2.x };
const p6 = { x: p5.x, y: -p5.y };
const p7 = { x: p4.x, y: -p4.y };
const p8 = { x: p3.x, y: -p3.y };
const p9 = { x: p2.x, y: -p2.y };
const p10 = { x: p1.x, y: -p1.y };
const p = [p1, p2, p3, p4, p5, p6, p7, p8, p9, p10];
const parts = p.map((p) => `${(dx + p.x).toFixed(2)} ${(dy + p.y).toFixed(2)}`).join(' L ');
return `<path d="M ${parts}" />`;
}
public render(startLineNumber: number, lineNumber: number): string {
if (!this._renderResult) {
return '';
}
const lineIndex = lineNumber - startLineNumber;
if (lineIndex < 0 || lineIndex >= this._renderResult.length) {
return '';
}
return this._renderResult[lineIndex];
}
}
class WhitespaceOptions {
public readonly renderWhitespace: 'none' | 'boundary' | 'selection' | 'trailing' | 'all';
public readonly renderWithSVG: boolean;
public readonly spaceWidth: number;
public readonly middotWidth: number;
public readonly wsmiddotWidth: number;
public readonly canUseHalfwidthRightwardsArrow: boolean;
public readonly lineHeight: number;
public readonly stopRenderingLineAfter: number;
constructor(config: IEditorConfiguration) {
const options = config.options;
const fontInfo = options.get(EditorOption.fontInfo);
const experimentalWhitespaceRendering = options.get(EditorOption.experimentalWhitespaceRendering);
if (experimentalWhitespaceRendering === 'off') {
// whitespace is rendered in the view line
this.renderWhitespace = 'none';
this.renderWithSVG = false;
} else if (experimentalWhitespaceRendering === 'svg') {
this.renderWhitespace = options.get(EditorOption.renderWhitespace);
this.renderWithSVG = true;
} else {
this.renderWhitespace = options.get(EditorOption.renderWhitespace);
this.renderWithSVG = false;
}
this.spaceWidth = fontInfo.spaceWidth;
this.middotWidth = fontInfo.middotWidth;
this.wsmiddotWidth = fontInfo.wsmiddotWidth;
this.canUseHalfwidthRightwardsArrow = fontInfo.canUseHalfwidthRightwardsArrow;
this.lineHeight = options.get(EditorOption.lineHeight);
this.stopRenderingLineAfter = options.get(EditorOption.stopRenderingLineAfter);
}
public equals(other: WhitespaceOptions): boolean {
return (
this.renderWhitespace === other.renderWhitespace
&& this.renderWithSVG === other.renderWithSVG
&& this.spaceWidth === other.spaceWidth
&& this.middotWidth === other.middotWidth
&& this.wsmiddotWidth === other.wsmiddotWidth
&& this.canUseHalfwidthRightwardsArrow === other.canUseHalfwidthRightwardsArrow
&& this.lineHeight === other.lineHeight
&& this.stopRenderingLineAfter === other.stopRenderingLineAfter
);
}
}