view.js 20 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403
  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. import * as dom from '../../base/browser/dom.js';
  6. import { Selection } from '../common/core/selection.js';
  7. import { createFastDomNode } from '../../base/browser/fastDomNode.js';
  8. import { onUnexpectedError } from '../../base/common/errors.js';
  9. import { PointerHandler } from './controller/pointerHandler.js';
  10. import { TextAreaHandler } from './controller/textAreaHandler.js';
  11. import { ViewController } from './view/viewController.js';
  12. import { ViewUserInputEvents } from './view/viewUserInputEvents.js';
  13. import { ContentViewOverlays, MarginViewOverlays } from './view/viewOverlays.js';
  14. import { PartFingerprints } from './view/viewPart.js';
  15. import { ViewContentWidgets } from './viewParts/contentWidgets/contentWidgets.js';
  16. import { CurrentLineHighlightOverlay, CurrentLineMarginHighlightOverlay } from './viewParts/currentLineHighlight/currentLineHighlight.js';
  17. import { DecorationsOverlay } from './viewParts/decorations/decorations.js';
  18. import { EditorScrollbar } from './viewParts/editorScrollbar/editorScrollbar.js';
  19. import { GlyphMarginOverlay } from './viewParts/glyphMargin/glyphMargin.js';
  20. import { IndentGuidesOverlay } from './viewParts/indentGuides/indentGuides.js';
  21. import { LineNumbersOverlay } from './viewParts/lineNumbers/lineNumbers.js';
  22. import { ViewLines } from './viewParts/lines/viewLines.js';
  23. import { LinesDecorationsOverlay } from './viewParts/linesDecorations/linesDecorations.js';
  24. import { Margin } from './viewParts/margin/margin.js';
  25. import { MarginViewLineDecorationsOverlay } from './viewParts/marginDecorations/marginDecorations.js';
  26. import { Minimap } from './viewParts/minimap/minimap.js';
  27. import { ViewOverlayWidgets } from './viewParts/overlayWidgets/overlayWidgets.js';
  28. import { DecorationsOverviewRuler } from './viewParts/overviewRuler/decorationsOverviewRuler.js';
  29. import { OverviewRuler } from './viewParts/overviewRuler/overviewRuler.js';
  30. import { Rulers } from './viewParts/rulers/rulers.js';
  31. import { ScrollDecorationViewPart } from './viewParts/scrollDecoration/scrollDecoration.js';
  32. import { SelectionsOverlay } from './viewParts/selections/selections.js';
  33. import { ViewCursors } from './viewParts/viewCursors/viewCursors.js';
  34. import { ViewZones } from './viewParts/viewZones/viewZones.js';
  35. import { Position } from '../common/core/position.js';
  36. import { Range } from '../common/core/range.js';
  37. import { RenderingContext } from './view/renderingContext.js';
  38. import { ViewContext } from '../common/viewModel/viewContext.js';
  39. import { ViewportData } from '../common/viewLayout/viewLinesViewportData.js';
  40. import { ViewEventHandler } from '../common/viewEventHandler.js';
  41. import { getThemeTypeSelector } from '../../platform/theme/common/themeService.js';
  42. import { PointerHandlerLastRenderData } from './controller/mouseTarget.js';
  43. import { BlockDecorations } from './viewParts/blockDecorations/blockDecorations.js';
  44. export class View extends ViewEventHandler {
  45. constructor(commandDelegate, configuration, colorTheme, model, userInputEvents, overflowWidgetsDomNode) {
  46. super();
  47. this._selections = [new Selection(1, 1, 1, 1)];
  48. this._renderAnimationFrame = null;
  49. const viewController = new ViewController(configuration, model, userInputEvents, commandDelegate);
  50. // The view context is passed on to most classes (basically to reduce param. counts in ctors)
  51. this._context = new ViewContext(configuration, colorTheme, model);
  52. // Ensure the view is the first event handler in order to update the layout
  53. this._context.addEventHandler(this);
  54. this._viewParts = [];
  55. // Keyboard handler
  56. this._textAreaHandler = new TextAreaHandler(this._context, viewController, this._createTextAreaHandlerHelper());
  57. this._viewParts.push(this._textAreaHandler);
  58. // These two dom nodes must be constructed up front, since references are needed in the layout provider (scrolling & co.)
  59. this._linesContent = createFastDomNode(document.createElement('div'));
  60. this._linesContent.setClassName('lines-content' + ' monaco-editor-background');
  61. this._linesContent.setPosition('absolute');
  62. this.domNode = createFastDomNode(document.createElement('div'));
  63. this.domNode.setClassName(this._getEditorClassName());
  64. // Set role 'code' for better screen reader support https://github.com/microsoft/vscode/issues/93438
  65. this.domNode.setAttribute('role', 'code');
  66. this._overflowGuardContainer = createFastDomNode(document.createElement('div'));
  67. PartFingerprints.write(this._overflowGuardContainer, 3 /* PartFingerprint.OverflowGuard */);
  68. this._overflowGuardContainer.setClassName('overflow-guard');
  69. this._scrollbar = new EditorScrollbar(this._context, this._linesContent, this.domNode, this._overflowGuardContainer);
  70. this._viewParts.push(this._scrollbar);
  71. // View Lines
  72. this._viewLines = new ViewLines(this._context, this._linesContent);
  73. // View Zones
  74. this._viewZones = new ViewZones(this._context);
  75. this._viewParts.push(this._viewZones);
  76. // Decorations overview ruler
  77. const decorationsOverviewRuler = new DecorationsOverviewRuler(this._context);
  78. this._viewParts.push(decorationsOverviewRuler);
  79. const scrollDecoration = new ScrollDecorationViewPart(this._context);
  80. this._viewParts.push(scrollDecoration);
  81. const contentViewOverlays = new ContentViewOverlays(this._context);
  82. this._viewParts.push(contentViewOverlays);
  83. contentViewOverlays.addDynamicOverlay(new CurrentLineHighlightOverlay(this._context));
  84. contentViewOverlays.addDynamicOverlay(new SelectionsOverlay(this._context));
  85. contentViewOverlays.addDynamicOverlay(new IndentGuidesOverlay(this._context));
  86. contentViewOverlays.addDynamicOverlay(new DecorationsOverlay(this._context));
  87. const marginViewOverlays = new MarginViewOverlays(this._context);
  88. this._viewParts.push(marginViewOverlays);
  89. marginViewOverlays.addDynamicOverlay(new CurrentLineMarginHighlightOverlay(this._context));
  90. marginViewOverlays.addDynamicOverlay(new GlyphMarginOverlay(this._context));
  91. marginViewOverlays.addDynamicOverlay(new MarginViewLineDecorationsOverlay(this._context));
  92. marginViewOverlays.addDynamicOverlay(new LinesDecorationsOverlay(this._context));
  93. marginViewOverlays.addDynamicOverlay(new LineNumbersOverlay(this._context));
  94. const margin = new Margin(this._context);
  95. margin.getDomNode().appendChild(this._viewZones.marginDomNode);
  96. margin.getDomNode().appendChild(marginViewOverlays.getDomNode());
  97. this._viewParts.push(margin);
  98. // Content widgets
  99. this._contentWidgets = new ViewContentWidgets(this._context, this.domNode);
  100. this._viewParts.push(this._contentWidgets);
  101. this._viewCursors = new ViewCursors(this._context);
  102. this._viewParts.push(this._viewCursors);
  103. // Overlay widgets
  104. this._overlayWidgets = new ViewOverlayWidgets(this._context);
  105. this._viewParts.push(this._overlayWidgets);
  106. const rulers = new Rulers(this._context);
  107. this._viewParts.push(rulers);
  108. const blockOutline = new BlockDecorations(this._context);
  109. this._viewParts.push(blockOutline);
  110. const minimap = new Minimap(this._context);
  111. this._viewParts.push(minimap);
  112. // -------------- Wire dom nodes up
  113. if (decorationsOverviewRuler) {
  114. const overviewRulerData = this._scrollbar.getOverviewRulerLayoutInfo();
  115. overviewRulerData.parent.insertBefore(decorationsOverviewRuler.getDomNode(), overviewRulerData.insertBefore);
  116. }
  117. this._linesContent.appendChild(contentViewOverlays.getDomNode());
  118. this._linesContent.appendChild(rulers.domNode);
  119. this._linesContent.appendChild(blockOutline.domNode);
  120. this._linesContent.appendChild(this._viewZones.domNode);
  121. this._linesContent.appendChild(this._viewLines.getDomNode());
  122. this._linesContent.appendChild(this._contentWidgets.domNode);
  123. this._linesContent.appendChild(this._viewCursors.getDomNode());
  124. this._overflowGuardContainer.appendChild(margin.getDomNode());
  125. this._overflowGuardContainer.appendChild(this._scrollbar.getDomNode());
  126. this._overflowGuardContainer.appendChild(scrollDecoration.getDomNode());
  127. this._overflowGuardContainer.appendChild(this._textAreaHandler.textArea);
  128. this._overflowGuardContainer.appendChild(this._textAreaHandler.textAreaCover);
  129. this._overflowGuardContainer.appendChild(this._overlayWidgets.getDomNode());
  130. this._overflowGuardContainer.appendChild(minimap.getDomNode());
  131. this.domNode.appendChild(this._overflowGuardContainer);
  132. if (overflowWidgetsDomNode) {
  133. overflowWidgetsDomNode.appendChild(this._contentWidgets.overflowingContentWidgetsDomNode.domNode);
  134. }
  135. else {
  136. this.domNode.appendChild(this._contentWidgets.overflowingContentWidgetsDomNode);
  137. }
  138. this._applyLayout();
  139. // Pointer handler
  140. this._pointerHandler = this._register(new PointerHandler(this._context, viewController, this._createPointerHandlerHelper()));
  141. }
  142. _flushAccumulatedAndRenderNow() {
  143. this._renderNow();
  144. }
  145. _createPointerHandlerHelper() {
  146. return {
  147. viewDomNode: this.domNode.domNode,
  148. linesContentDomNode: this._linesContent.domNode,
  149. viewLinesDomNode: this._viewLines.getDomNode().domNode,
  150. focusTextArea: () => {
  151. this.focus();
  152. },
  153. dispatchTextAreaEvent: (event) => {
  154. this._textAreaHandler.textArea.domNode.dispatchEvent(event);
  155. },
  156. getLastRenderData: () => {
  157. const lastViewCursorsRenderData = this._viewCursors.getLastRenderData() || [];
  158. const lastTextareaPosition = this._textAreaHandler.getLastRenderData();
  159. return new PointerHandlerLastRenderData(lastViewCursorsRenderData, lastTextareaPosition);
  160. },
  161. shouldSuppressMouseDownOnViewZone: (viewZoneId) => {
  162. return this._viewZones.shouldSuppressMouseDownOnViewZone(viewZoneId);
  163. },
  164. shouldSuppressMouseDownOnWidget: (widgetId) => {
  165. return this._contentWidgets.shouldSuppressMouseDownOnWidget(widgetId);
  166. },
  167. getPositionFromDOMInfo: (spanNode, offset) => {
  168. this._flushAccumulatedAndRenderNow();
  169. return this._viewLines.getPositionFromDOMInfo(spanNode, offset);
  170. },
  171. visibleRangeForPosition: (lineNumber, column) => {
  172. this._flushAccumulatedAndRenderNow();
  173. return this._viewLines.visibleRangeForPosition(new Position(lineNumber, column));
  174. },
  175. getLineWidth: (lineNumber) => {
  176. this._flushAccumulatedAndRenderNow();
  177. return this._viewLines.getLineWidth(lineNumber);
  178. }
  179. };
  180. }
  181. _createTextAreaHandlerHelper() {
  182. return {
  183. visibleRangeForPosition: (position) => {
  184. this._flushAccumulatedAndRenderNow();
  185. return this._viewLines.visibleRangeForPosition(position);
  186. }
  187. };
  188. }
  189. _applyLayout() {
  190. const options = this._context.configuration.options;
  191. const layoutInfo = options.get(133 /* EditorOption.layoutInfo */);
  192. this.domNode.setWidth(layoutInfo.width);
  193. this.domNode.setHeight(layoutInfo.height);
  194. this._overflowGuardContainer.setWidth(layoutInfo.width);
  195. this._overflowGuardContainer.setHeight(layoutInfo.height);
  196. this._linesContent.setWidth(1000000);
  197. this._linesContent.setHeight(1000000);
  198. }
  199. _getEditorClassName() {
  200. const focused = this._textAreaHandler.isFocused() ? ' focused' : '';
  201. return this._context.configuration.options.get(130 /* EditorOption.editorClassName */) + ' ' + getThemeTypeSelector(this._context.theme.type) + focused;
  202. }
  203. // --- begin event handlers
  204. handleEvents(events) {
  205. super.handleEvents(events);
  206. this._scheduleRender();
  207. }
  208. onConfigurationChanged(e) {
  209. this.domNode.setClassName(this._getEditorClassName());
  210. this._applyLayout();
  211. return false;
  212. }
  213. onCursorStateChanged(e) {
  214. this._selections = e.selections;
  215. return false;
  216. }
  217. onFocusChanged(e) {
  218. this.domNode.setClassName(this._getEditorClassName());
  219. return false;
  220. }
  221. onThemeChanged(e) {
  222. this._context.theme.update(e.theme);
  223. this.domNode.setClassName(this._getEditorClassName());
  224. return false;
  225. }
  226. // --- end event handlers
  227. dispose() {
  228. if (this._renderAnimationFrame !== null) {
  229. this._renderAnimationFrame.dispose();
  230. this._renderAnimationFrame = null;
  231. }
  232. this._contentWidgets.overflowingContentWidgetsDomNode.domNode.remove();
  233. this._context.removeEventHandler(this);
  234. this._viewLines.dispose();
  235. // Destroy view parts
  236. for (const viewPart of this._viewParts) {
  237. viewPart.dispose();
  238. }
  239. super.dispose();
  240. }
  241. _scheduleRender() {
  242. if (this._renderAnimationFrame === null) {
  243. this._renderAnimationFrame = dom.runAtThisOrScheduleAtNextAnimationFrame(this._onRenderScheduled.bind(this), 100);
  244. }
  245. }
  246. _onRenderScheduled() {
  247. this._renderAnimationFrame = null;
  248. this._flushAccumulatedAndRenderNow();
  249. }
  250. _renderNow() {
  251. safeInvokeNoArg(() => this._actualRender());
  252. }
  253. _getViewPartsToRender() {
  254. const result = [];
  255. let resultLen = 0;
  256. for (const viewPart of this._viewParts) {
  257. if (viewPart.shouldRender()) {
  258. result[resultLen++] = viewPart;
  259. }
  260. }
  261. return result;
  262. }
  263. _actualRender() {
  264. if (!dom.isInDOM(this.domNode.domNode)) {
  265. return;
  266. }
  267. let viewPartsToRender = this._getViewPartsToRender();
  268. if (!this._viewLines.shouldRender() && viewPartsToRender.length === 0) {
  269. // Nothing to render
  270. return;
  271. }
  272. const partialViewportData = this._context.viewLayout.getLinesViewportData();
  273. this._context.viewModel.setViewport(partialViewportData.startLineNumber, partialViewportData.endLineNumber, partialViewportData.centeredLineNumber);
  274. const viewportData = new ViewportData(this._selections, partialViewportData, this._context.viewLayout.getWhitespaceViewportData(), this._context.viewModel);
  275. if (this._contentWidgets.shouldRender()) {
  276. // Give the content widgets a chance to set their max width before a possible synchronous layout
  277. this._contentWidgets.onBeforeRender(viewportData);
  278. }
  279. if (this._viewLines.shouldRender()) {
  280. this._viewLines.renderText(viewportData);
  281. this._viewLines.onDidRender();
  282. // Rendering of viewLines might cause scroll events to occur, so collect view parts to render again
  283. viewPartsToRender = this._getViewPartsToRender();
  284. }
  285. const renderingContext = new RenderingContext(this._context.viewLayout, viewportData, this._viewLines);
  286. // Render the rest of the parts
  287. for (const viewPart of viewPartsToRender) {
  288. viewPart.prepareRender(renderingContext);
  289. }
  290. for (const viewPart of viewPartsToRender) {
  291. viewPart.render(renderingContext);
  292. viewPart.onDidRender();
  293. }
  294. }
  295. // --- BEGIN CodeEditor helpers
  296. delegateVerticalScrollbarPointerDown(browserEvent) {
  297. this._scrollbar.delegateVerticalScrollbarPointerDown(browserEvent);
  298. }
  299. restoreState(scrollPosition) {
  300. this._context.viewModel.viewLayout.setScrollPosition({ scrollTop: scrollPosition.scrollTop }, 1 /* ScrollType.Immediate */);
  301. this._context.viewModel.tokenizeViewport();
  302. this._renderNow();
  303. this._viewLines.updateLineWidths();
  304. this._context.viewModel.viewLayout.setScrollPosition({ scrollLeft: scrollPosition.scrollLeft }, 1 /* ScrollType.Immediate */);
  305. }
  306. getOffsetForColumn(modelLineNumber, modelColumn) {
  307. const modelPosition = this._context.viewModel.model.validatePosition({
  308. lineNumber: modelLineNumber,
  309. column: modelColumn
  310. });
  311. const viewPosition = this._context.viewModel.coordinatesConverter.convertModelPositionToViewPosition(modelPosition);
  312. this._flushAccumulatedAndRenderNow();
  313. const visibleRange = this._viewLines.visibleRangeForPosition(new Position(viewPosition.lineNumber, viewPosition.column));
  314. if (!visibleRange) {
  315. return -1;
  316. }
  317. return visibleRange.left;
  318. }
  319. getTargetAtClientPoint(clientX, clientY) {
  320. const mouseTarget = this._pointerHandler.getTargetAtClientPoint(clientX, clientY);
  321. if (!mouseTarget) {
  322. return null;
  323. }
  324. return ViewUserInputEvents.convertViewToModelMouseTarget(mouseTarget, this._context.viewModel.coordinatesConverter);
  325. }
  326. createOverviewRuler(cssClassName) {
  327. return new OverviewRuler(this._context, cssClassName);
  328. }
  329. change(callback) {
  330. this._viewZones.changeViewZones(callback);
  331. this._scheduleRender();
  332. }
  333. render(now, everything) {
  334. if (everything) {
  335. // Force everything to render...
  336. this._viewLines.forceShouldRender();
  337. for (const viewPart of this._viewParts) {
  338. viewPart.forceShouldRender();
  339. }
  340. }
  341. if (now) {
  342. this._flushAccumulatedAndRenderNow();
  343. }
  344. else {
  345. this._scheduleRender();
  346. }
  347. }
  348. focus() {
  349. this._textAreaHandler.focusTextArea();
  350. }
  351. isFocused() {
  352. return this._textAreaHandler.isFocused();
  353. }
  354. setAriaOptions(options) {
  355. this._textAreaHandler.setAriaOptions(options);
  356. }
  357. addContentWidget(widgetData) {
  358. this._contentWidgets.addWidget(widgetData.widget);
  359. this.layoutContentWidget(widgetData);
  360. this._scheduleRender();
  361. }
  362. layoutContentWidget(widgetData) {
  363. var _a, _b;
  364. let newRange = widgetData.position ? widgetData.position.range || null : null;
  365. if (newRange === null) {
  366. const newPosition = widgetData.position ? widgetData.position.position : null;
  367. if (newPosition !== null) {
  368. newRange = new Range(newPosition.lineNumber, newPosition.column, newPosition.lineNumber, newPosition.column);
  369. }
  370. }
  371. const newPreference = widgetData.position ? widgetData.position.preference : null;
  372. this._contentWidgets.setWidgetPosition(widgetData.widget, newRange, newPreference, (_b = (_a = widgetData.position) === null || _a === void 0 ? void 0 : _a.positionAffinity) !== null && _b !== void 0 ? _b : null);
  373. this._scheduleRender();
  374. }
  375. removeContentWidget(widgetData) {
  376. this._contentWidgets.removeWidget(widgetData.widget);
  377. this._scheduleRender();
  378. }
  379. addOverlayWidget(widgetData) {
  380. this._overlayWidgets.addWidget(widgetData.widget);
  381. this.layoutOverlayWidget(widgetData);
  382. this._scheduleRender();
  383. }
  384. layoutOverlayWidget(widgetData) {
  385. const newPreference = widgetData.position ? widgetData.position.preference : null;
  386. const shouldRender = this._overlayWidgets.setWidgetPosition(widgetData.widget, newPreference);
  387. if (shouldRender) {
  388. this._scheduleRender();
  389. }
  390. }
  391. removeOverlayWidget(widgetData) {
  392. this._overlayWidgets.removeWidget(widgetData.widget);
  393. this._scheduleRender();
  394. }
  395. }
  396. function safeInvokeNoArg(func) {
  397. try {
  398. return func();
  399. }
  400. catch (e) {
  401. onUnexpectedError(e);
  402. }
  403. }