viewLayer.js 19 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463
  1. /*---------------------------------------------------------------------------------------------
  2. * Copyright (c) Microsoft Corporation. All rights reserved.
  3. * Licensed under the MIT License. See License.txt in the project root for license information.
  4. *--------------------------------------------------------------------------------------------*/
  5. var _a;
  6. import { createFastDomNode } from '../../../base/browser/fastDomNode.js';
  7. import { createStringBuilder } from '../../common/core/stringBuilder.js';
  8. export class RenderedLinesCollection {
  9. constructor(createLine) {
  10. this._createLine = createLine;
  11. this._set(1, []);
  12. }
  13. flush() {
  14. this._set(1, []);
  15. }
  16. _set(rendLineNumberStart, lines) {
  17. this._lines = lines;
  18. this._rendLineNumberStart = rendLineNumberStart;
  19. }
  20. _get() {
  21. return {
  22. rendLineNumberStart: this._rendLineNumberStart,
  23. lines: this._lines
  24. };
  25. }
  26. /**
  27. * @returns Inclusive line number that is inside this collection
  28. */
  29. getStartLineNumber() {
  30. return this._rendLineNumberStart;
  31. }
  32. /**
  33. * @returns Inclusive line number that is inside this collection
  34. */
  35. getEndLineNumber() {
  36. return this._rendLineNumberStart + this._lines.length - 1;
  37. }
  38. getCount() {
  39. return this._lines.length;
  40. }
  41. getLine(lineNumber) {
  42. const lineIndex = lineNumber - this._rendLineNumberStart;
  43. if (lineIndex < 0 || lineIndex >= this._lines.length) {
  44. throw new Error('Illegal value for lineNumber');
  45. }
  46. return this._lines[lineIndex];
  47. }
  48. /**
  49. * @returns Lines that were removed from this collection
  50. */
  51. onLinesDeleted(deleteFromLineNumber, deleteToLineNumber) {
  52. if (this.getCount() === 0) {
  53. // no lines
  54. return null;
  55. }
  56. const startLineNumber = this.getStartLineNumber();
  57. const endLineNumber = this.getEndLineNumber();
  58. if (deleteToLineNumber < startLineNumber) {
  59. // deleting above the viewport
  60. const deleteCnt = deleteToLineNumber - deleteFromLineNumber + 1;
  61. this._rendLineNumberStart -= deleteCnt;
  62. return null;
  63. }
  64. if (deleteFromLineNumber > endLineNumber) {
  65. // deleted below the viewport
  66. return null;
  67. }
  68. // Record what needs to be deleted
  69. let deleteStartIndex = 0;
  70. let deleteCount = 0;
  71. for (let lineNumber = startLineNumber; lineNumber <= endLineNumber; lineNumber++) {
  72. const lineIndex = lineNumber - this._rendLineNumberStart;
  73. if (deleteFromLineNumber <= lineNumber && lineNumber <= deleteToLineNumber) {
  74. // this is a line to be deleted
  75. if (deleteCount === 0) {
  76. // this is the first line to be deleted
  77. deleteStartIndex = lineIndex;
  78. deleteCount = 1;
  79. }
  80. else {
  81. deleteCount++;
  82. }
  83. }
  84. }
  85. // Adjust this._rendLineNumberStart for lines deleted above
  86. if (deleteFromLineNumber < startLineNumber) {
  87. // Something was deleted above
  88. let deleteAboveCount = 0;
  89. if (deleteToLineNumber < startLineNumber) {
  90. // the entire deleted lines are above
  91. deleteAboveCount = deleteToLineNumber - deleteFromLineNumber + 1;
  92. }
  93. else {
  94. deleteAboveCount = startLineNumber - deleteFromLineNumber;
  95. }
  96. this._rendLineNumberStart -= deleteAboveCount;
  97. }
  98. const deleted = this._lines.splice(deleteStartIndex, deleteCount);
  99. return deleted;
  100. }
  101. onLinesChanged(changeFromLineNumber, changeToLineNumber) {
  102. if (this.getCount() === 0) {
  103. // no lines
  104. return false;
  105. }
  106. const startLineNumber = this.getStartLineNumber();
  107. const endLineNumber = this.getEndLineNumber();
  108. let someoneNotified = false;
  109. for (let changedLineNumber = changeFromLineNumber; changedLineNumber <= changeToLineNumber; changedLineNumber++) {
  110. if (changedLineNumber >= startLineNumber && changedLineNumber <= endLineNumber) {
  111. // Notify the line
  112. this._lines[changedLineNumber - this._rendLineNumberStart].onContentChanged();
  113. someoneNotified = true;
  114. }
  115. }
  116. return someoneNotified;
  117. }
  118. onLinesInserted(insertFromLineNumber, insertToLineNumber) {
  119. if (this.getCount() === 0) {
  120. // no lines
  121. return null;
  122. }
  123. const insertCnt = insertToLineNumber - insertFromLineNumber + 1;
  124. const startLineNumber = this.getStartLineNumber();
  125. const endLineNumber = this.getEndLineNumber();
  126. if (insertFromLineNumber <= startLineNumber) {
  127. // inserting above the viewport
  128. this._rendLineNumberStart += insertCnt;
  129. return null;
  130. }
  131. if (insertFromLineNumber > endLineNumber) {
  132. // inserting below the viewport
  133. return null;
  134. }
  135. if (insertCnt + insertFromLineNumber > endLineNumber) {
  136. // insert inside the viewport in such a way that all remaining lines are pushed outside
  137. const deleted = this._lines.splice(insertFromLineNumber - this._rendLineNumberStart, endLineNumber - insertFromLineNumber + 1);
  138. return deleted;
  139. }
  140. // insert inside the viewport, push out some lines, but not all remaining lines
  141. const newLines = [];
  142. for (let i = 0; i < insertCnt; i++) {
  143. newLines[i] = this._createLine();
  144. }
  145. const insertIndex = insertFromLineNumber - this._rendLineNumberStart;
  146. const beforeLines = this._lines.slice(0, insertIndex);
  147. const afterLines = this._lines.slice(insertIndex, this._lines.length - insertCnt);
  148. const deletedLines = this._lines.slice(this._lines.length - insertCnt, this._lines.length);
  149. this._lines = beforeLines.concat(newLines).concat(afterLines);
  150. return deletedLines;
  151. }
  152. onTokensChanged(ranges) {
  153. if (this.getCount() === 0) {
  154. // no lines
  155. return false;
  156. }
  157. const startLineNumber = this.getStartLineNumber();
  158. const endLineNumber = this.getEndLineNumber();
  159. let notifiedSomeone = false;
  160. for (let i = 0, len = ranges.length; i < len; i++) {
  161. const rng = ranges[i];
  162. if (rng.toLineNumber < startLineNumber || rng.fromLineNumber > endLineNumber) {
  163. // range outside viewport
  164. continue;
  165. }
  166. const from = Math.max(startLineNumber, rng.fromLineNumber);
  167. const to = Math.min(endLineNumber, rng.toLineNumber);
  168. for (let lineNumber = from; lineNumber <= to; lineNumber++) {
  169. const lineIndex = lineNumber - this._rendLineNumberStart;
  170. this._lines[lineIndex].onTokensChanged();
  171. notifiedSomeone = true;
  172. }
  173. }
  174. return notifiedSomeone;
  175. }
  176. }
  177. export class VisibleLinesCollection {
  178. constructor(host) {
  179. this._host = host;
  180. this.domNode = this._createDomNode();
  181. this._linesCollection = new RenderedLinesCollection(() => this._host.createVisibleLine());
  182. }
  183. _createDomNode() {
  184. const domNode = createFastDomNode(document.createElement('div'));
  185. domNode.setClassName('view-layer');
  186. domNode.setPosition('absolute');
  187. domNode.domNode.setAttribute('role', 'presentation');
  188. domNode.domNode.setAttribute('aria-hidden', 'true');
  189. return domNode;
  190. }
  191. // ---- begin view event handlers
  192. onConfigurationChanged(e) {
  193. if (e.hasChanged(130 /* layoutInfo */)) {
  194. return true;
  195. }
  196. return false;
  197. }
  198. onFlushed(e) {
  199. this._linesCollection.flush();
  200. // No need to clear the dom node because a full .innerHTML will occur in ViewLayerRenderer._render
  201. return true;
  202. }
  203. onLinesChanged(e) {
  204. return this._linesCollection.onLinesChanged(e.fromLineNumber, e.toLineNumber);
  205. }
  206. onLinesDeleted(e) {
  207. const deleted = this._linesCollection.onLinesDeleted(e.fromLineNumber, e.toLineNumber);
  208. if (deleted) {
  209. // Remove from DOM
  210. for (let i = 0, len = deleted.length; i < len; i++) {
  211. const lineDomNode = deleted[i].getDomNode();
  212. if (lineDomNode) {
  213. this.domNode.domNode.removeChild(lineDomNode);
  214. }
  215. }
  216. }
  217. return true;
  218. }
  219. onLinesInserted(e) {
  220. const deleted = this._linesCollection.onLinesInserted(e.fromLineNumber, e.toLineNumber);
  221. if (deleted) {
  222. // Remove from DOM
  223. for (let i = 0, len = deleted.length; i < len; i++) {
  224. const lineDomNode = deleted[i].getDomNode();
  225. if (lineDomNode) {
  226. this.domNode.domNode.removeChild(lineDomNode);
  227. }
  228. }
  229. }
  230. return true;
  231. }
  232. onScrollChanged(e) {
  233. return e.scrollTopChanged;
  234. }
  235. onTokensChanged(e) {
  236. return this._linesCollection.onTokensChanged(e.ranges);
  237. }
  238. onZonesChanged(e) {
  239. return true;
  240. }
  241. // ---- end view event handlers
  242. getStartLineNumber() {
  243. return this._linesCollection.getStartLineNumber();
  244. }
  245. getEndLineNumber() {
  246. return this._linesCollection.getEndLineNumber();
  247. }
  248. getVisibleLine(lineNumber) {
  249. return this._linesCollection.getLine(lineNumber);
  250. }
  251. renderLines(viewportData) {
  252. const inp = this._linesCollection._get();
  253. const renderer = new ViewLayerRenderer(this.domNode.domNode, this._host, viewportData);
  254. const ctx = {
  255. rendLineNumberStart: inp.rendLineNumberStart,
  256. lines: inp.lines,
  257. linesLength: inp.lines.length
  258. };
  259. // Decide if this render will do a single update (single large .innerHTML) or many updates (inserting/removing dom nodes)
  260. const resCtx = renderer.render(ctx, viewportData.startLineNumber, viewportData.endLineNumber, viewportData.relativeVerticalOffset);
  261. this._linesCollection._set(resCtx.rendLineNumberStart, resCtx.lines);
  262. }
  263. }
  264. class ViewLayerRenderer {
  265. constructor(domNode, host, viewportData) {
  266. this.domNode = domNode;
  267. this.host = host;
  268. this.viewportData = viewportData;
  269. }
  270. render(inContext, startLineNumber, stopLineNumber, deltaTop) {
  271. const ctx = {
  272. rendLineNumberStart: inContext.rendLineNumberStart,
  273. lines: inContext.lines.slice(0),
  274. linesLength: inContext.linesLength
  275. };
  276. if ((ctx.rendLineNumberStart + ctx.linesLength - 1 < startLineNumber) || (stopLineNumber < ctx.rendLineNumberStart)) {
  277. // There is no overlap whatsoever
  278. ctx.rendLineNumberStart = startLineNumber;
  279. ctx.linesLength = stopLineNumber - startLineNumber + 1;
  280. ctx.lines = [];
  281. for (let x = startLineNumber; x <= stopLineNumber; x++) {
  282. ctx.lines[x - startLineNumber] = this.host.createVisibleLine();
  283. }
  284. this._finishRendering(ctx, true, deltaTop);
  285. return ctx;
  286. }
  287. // Update lines which will remain untouched
  288. this._renderUntouchedLines(ctx, Math.max(startLineNumber - ctx.rendLineNumberStart, 0), Math.min(stopLineNumber - ctx.rendLineNumberStart, ctx.linesLength - 1), deltaTop, startLineNumber);
  289. if (ctx.rendLineNumberStart > startLineNumber) {
  290. // Insert lines before
  291. const fromLineNumber = startLineNumber;
  292. const toLineNumber = Math.min(stopLineNumber, ctx.rendLineNumberStart - 1);
  293. if (fromLineNumber <= toLineNumber) {
  294. this._insertLinesBefore(ctx, fromLineNumber, toLineNumber, deltaTop, startLineNumber);
  295. ctx.linesLength += toLineNumber - fromLineNumber + 1;
  296. }
  297. }
  298. else if (ctx.rendLineNumberStart < startLineNumber) {
  299. // Remove lines before
  300. const removeCnt = Math.min(ctx.linesLength, startLineNumber - ctx.rendLineNumberStart);
  301. if (removeCnt > 0) {
  302. this._removeLinesBefore(ctx, removeCnt);
  303. ctx.linesLength -= removeCnt;
  304. }
  305. }
  306. ctx.rendLineNumberStart = startLineNumber;
  307. if (ctx.rendLineNumberStart + ctx.linesLength - 1 < stopLineNumber) {
  308. // Insert lines after
  309. const fromLineNumber = ctx.rendLineNumberStart + ctx.linesLength;
  310. const toLineNumber = stopLineNumber;
  311. if (fromLineNumber <= toLineNumber) {
  312. this._insertLinesAfter(ctx, fromLineNumber, toLineNumber, deltaTop, startLineNumber);
  313. ctx.linesLength += toLineNumber - fromLineNumber + 1;
  314. }
  315. }
  316. else if (ctx.rendLineNumberStart + ctx.linesLength - 1 > stopLineNumber) {
  317. // Remove lines after
  318. const fromLineNumber = Math.max(0, stopLineNumber - ctx.rendLineNumberStart + 1);
  319. const toLineNumber = ctx.linesLength - 1;
  320. const removeCnt = toLineNumber - fromLineNumber + 1;
  321. if (removeCnt > 0) {
  322. this._removeLinesAfter(ctx, removeCnt);
  323. ctx.linesLength -= removeCnt;
  324. }
  325. }
  326. this._finishRendering(ctx, false, deltaTop);
  327. return ctx;
  328. }
  329. _renderUntouchedLines(ctx, startIndex, endIndex, deltaTop, deltaLN) {
  330. const rendLineNumberStart = ctx.rendLineNumberStart;
  331. const lines = ctx.lines;
  332. for (let i = startIndex; i <= endIndex; i++) {
  333. const lineNumber = rendLineNumberStart + i;
  334. lines[i].layoutLine(lineNumber, deltaTop[lineNumber - deltaLN]);
  335. }
  336. }
  337. _insertLinesBefore(ctx, fromLineNumber, toLineNumber, deltaTop, deltaLN) {
  338. const newLines = [];
  339. let newLinesLen = 0;
  340. for (let lineNumber = fromLineNumber; lineNumber <= toLineNumber; lineNumber++) {
  341. newLines[newLinesLen++] = this.host.createVisibleLine();
  342. }
  343. ctx.lines = newLines.concat(ctx.lines);
  344. }
  345. _removeLinesBefore(ctx, removeCount) {
  346. for (let i = 0; i < removeCount; i++) {
  347. const lineDomNode = ctx.lines[i].getDomNode();
  348. if (lineDomNode) {
  349. this.domNode.removeChild(lineDomNode);
  350. }
  351. }
  352. ctx.lines.splice(0, removeCount);
  353. }
  354. _insertLinesAfter(ctx, fromLineNumber, toLineNumber, deltaTop, deltaLN) {
  355. const newLines = [];
  356. let newLinesLen = 0;
  357. for (let lineNumber = fromLineNumber; lineNumber <= toLineNumber; lineNumber++) {
  358. newLines[newLinesLen++] = this.host.createVisibleLine();
  359. }
  360. ctx.lines = ctx.lines.concat(newLines);
  361. }
  362. _removeLinesAfter(ctx, removeCount) {
  363. const removeIndex = ctx.linesLength - removeCount;
  364. for (let i = 0; i < removeCount; i++) {
  365. const lineDomNode = ctx.lines[removeIndex + i].getDomNode();
  366. if (lineDomNode) {
  367. this.domNode.removeChild(lineDomNode);
  368. }
  369. }
  370. ctx.lines.splice(removeIndex, removeCount);
  371. }
  372. _finishRenderingNewLines(ctx, domNodeIsEmpty, newLinesHTML, wasNew) {
  373. if (ViewLayerRenderer._ttPolicy) {
  374. newLinesHTML = ViewLayerRenderer._ttPolicy.createHTML(newLinesHTML);
  375. }
  376. const lastChild = this.domNode.lastChild;
  377. if (domNodeIsEmpty || !lastChild) {
  378. this.domNode.innerHTML = newLinesHTML; // explains the ugly casts -> https://github.com/microsoft/vscode/issues/106396#issuecomment-692625393;
  379. }
  380. else {
  381. lastChild.insertAdjacentHTML('afterend', newLinesHTML);
  382. }
  383. let currChild = this.domNode.lastChild;
  384. for (let i = ctx.linesLength - 1; i >= 0; i--) {
  385. const line = ctx.lines[i];
  386. if (wasNew[i]) {
  387. line.setDomNode(currChild);
  388. currChild = currChild.previousSibling;
  389. }
  390. }
  391. }
  392. _finishRenderingInvalidLines(ctx, invalidLinesHTML, wasInvalid) {
  393. const hugeDomNode = document.createElement('div');
  394. if (ViewLayerRenderer._ttPolicy) {
  395. invalidLinesHTML = ViewLayerRenderer._ttPolicy.createHTML(invalidLinesHTML);
  396. }
  397. hugeDomNode.innerHTML = invalidLinesHTML;
  398. for (let i = 0; i < ctx.linesLength; i++) {
  399. const line = ctx.lines[i];
  400. if (wasInvalid[i]) {
  401. const source = hugeDomNode.firstChild;
  402. const lineDomNode = line.getDomNode();
  403. lineDomNode.parentNode.replaceChild(source, lineDomNode);
  404. line.setDomNode(source);
  405. }
  406. }
  407. }
  408. _finishRendering(ctx, domNodeIsEmpty, deltaTop) {
  409. const sb = ViewLayerRenderer._sb;
  410. const linesLength = ctx.linesLength;
  411. const lines = ctx.lines;
  412. const rendLineNumberStart = ctx.rendLineNumberStart;
  413. const wasNew = [];
  414. {
  415. sb.reset();
  416. let hadNewLine = false;
  417. for (let i = 0; i < linesLength; i++) {
  418. const line = lines[i];
  419. wasNew[i] = false;
  420. const lineDomNode = line.getDomNode();
  421. if (lineDomNode) {
  422. // line is not new
  423. continue;
  424. }
  425. const renderResult = line.renderLine(i + rendLineNumberStart, deltaTop[i], this.viewportData, sb);
  426. if (!renderResult) {
  427. // line does not need rendering
  428. continue;
  429. }
  430. wasNew[i] = true;
  431. hadNewLine = true;
  432. }
  433. if (hadNewLine) {
  434. this._finishRenderingNewLines(ctx, domNodeIsEmpty, sb.build(), wasNew);
  435. }
  436. }
  437. {
  438. sb.reset();
  439. let hadInvalidLine = false;
  440. const wasInvalid = [];
  441. for (let i = 0; i < linesLength; i++) {
  442. const line = lines[i];
  443. wasInvalid[i] = false;
  444. if (wasNew[i]) {
  445. // line was new
  446. continue;
  447. }
  448. const renderResult = line.renderLine(i + rendLineNumberStart, deltaTop[i], this.viewportData, sb);
  449. if (!renderResult) {
  450. // line does not need rendering
  451. continue;
  452. }
  453. wasInvalid[i] = true;
  454. hadInvalidLine = true;
  455. }
  456. if (hadInvalidLine) {
  457. this._finishRenderingInvalidLines(ctx, sb.build(), wasInvalid);
  458. }
  459. }
  460. }
  461. }
  462. ViewLayerRenderer._ttPolicy = (_a = window.trustedTypes) === null || _a === void 0 ? void 0 : _a.createPolicy('editorViewLayer', { createHTML: value => value });
  463. ViewLayerRenderer._sb = createStringBuilder(100000);