markdownHoverParticipant.js 7.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132
  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 __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
  6. var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
  7. if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
  8. else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
  9. return c > 3 && r && Object.defineProperty(target, key, r), r;
  10. };
  11. var __param = (this && this.__param) || function (paramIndex, decorator) {
  12. return function (target, key) { decorator(target, key, paramIndex); }
  13. };
  14. import * as dom from '../../../base/browser/dom.js';
  15. import { asArray } from '../../../base/common/arrays.js';
  16. import { AsyncIterableObject } from '../../../base/common/async.js';
  17. import { isEmptyMarkdownString, MarkdownString } from '../../../base/common/htmlContent.js';
  18. import { DisposableStore } from '../../../base/common/lifecycle.js';
  19. import { MarkdownRenderer } from '../../browser/core/markdownRenderer.js';
  20. import { Position } from '../../common/core/position.js';
  21. import { Range } from '../../common/core/range.js';
  22. import { HoverProviderRegistry } from '../../common/modes.js';
  23. import { IModeService } from '../../common/services/modeService.js';
  24. import { getHover } from './getHover.js';
  25. import * as nls from '../../../nls.js';
  26. import { IConfigurationService } from '../../../platform/configuration/common/configuration.js';
  27. import { IOpenerService } from '../../../platform/opener/common/opener.js';
  28. const $ = dom.$;
  29. export class MarkdownHover {
  30. constructor(owner, range, contents, ordinal) {
  31. this.owner = owner;
  32. this.range = range;
  33. this.contents = contents;
  34. this.ordinal = ordinal;
  35. }
  36. isValidForHoverAnchor(anchor) {
  37. return (anchor.type === 1 /* Range */
  38. && this.range.startColumn <= anchor.range.startColumn
  39. && this.range.endColumn >= anchor.range.endColumn);
  40. }
  41. }
  42. let MarkdownHoverParticipant = class MarkdownHoverParticipant {
  43. constructor(_editor, _hover, _modeService, _openerService, _configurationService) {
  44. this._editor = _editor;
  45. this._hover = _hover;
  46. this._modeService = _modeService;
  47. this._openerService = _openerService;
  48. this._configurationService = _configurationService;
  49. }
  50. createLoadingMessage(anchor) {
  51. return new MarkdownHover(this, anchor.range, [new MarkdownString().appendText(nls.localize('modesContentHover.loading', "Loading..."))], 2000);
  52. }
  53. computeSync(anchor, lineDecorations) {
  54. if (!this._editor.hasModel() || anchor.type !== 1 /* Range */) {
  55. return [];
  56. }
  57. const model = this._editor.getModel();
  58. const lineNumber = anchor.range.startLineNumber;
  59. const maxColumn = model.getLineMaxColumn(lineNumber);
  60. const result = [];
  61. let index = 1000;
  62. const lineLength = model.getLineLength(lineNumber);
  63. const languageId = model.getLanguageIdAtPosition(anchor.range.startLineNumber, anchor.range.startColumn);
  64. const maxTokenizationLineLength = this._configurationService.getValue('editor.maxTokenizationLineLength', {
  65. overrideIdentifier: languageId
  66. });
  67. if (typeof maxTokenizationLineLength === 'number' && lineLength >= maxTokenizationLineLength) {
  68. result.push(new MarkdownHover(this, anchor.range, [{
  69. value: nls.localize('too many characters', "Tokenization is skipped for long lines for performance reasons. This can be configured via `editor.maxTokenizationLineLength`.")
  70. }], index++));
  71. }
  72. for (const d of lineDecorations) {
  73. const startColumn = (d.range.startLineNumber === lineNumber) ? d.range.startColumn : 1;
  74. const endColumn = (d.range.endLineNumber === lineNumber) ? d.range.endColumn : maxColumn;
  75. const hoverMessage = d.options.hoverMessage;
  76. if (!hoverMessage || isEmptyMarkdownString(hoverMessage)) {
  77. continue;
  78. }
  79. const range = new Range(anchor.range.startLineNumber, startColumn, anchor.range.startLineNumber, endColumn);
  80. result.push(new MarkdownHover(this, range, asArray(hoverMessage), index++));
  81. }
  82. return result;
  83. }
  84. computeAsync(anchor, lineDecorations, token) {
  85. if (!this._editor.hasModel() || anchor.type !== 1 /* Range */) {
  86. return AsyncIterableObject.EMPTY;
  87. }
  88. const model = this._editor.getModel();
  89. if (!HoverProviderRegistry.has(model)) {
  90. return AsyncIterableObject.EMPTY;
  91. }
  92. const position = new Position(anchor.range.startLineNumber, anchor.range.startColumn);
  93. return getHover(model, position, token)
  94. .filter(item => !isEmptyMarkdownString(item.hover.contents))
  95. .map(item => {
  96. const rng = item.hover.range ? Range.lift(item.hover.range) : anchor.range;
  97. return new MarkdownHover(this, rng, item.hover.contents, item.ordinal);
  98. });
  99. }
  100. renderHoverParts(hoverParts, fragment, statusBar) {
  101. return renderMarkdownHovers(hoverParts, fragment, this._editor, this._hover, this._modeService, this._openerService);
  102. }
  103. };
  104. MarkdownHoverParticipant = __decorate([
  105. __param(2, IModeService),
  106. __param(3, IOpenerService),
  107. __param(4, IConfigurationService)
  108. ], MarkdownHoverParticipant);
  109. export { MarkdownHoverParticipant };
  110. export function renderMarkdownHovers(hoverParts, fragment, editor, hover, modeService, openerService) {
  111. // Sort hover parts to keep them stable since they might come in async, out-of-order
  112. hoverParts.sort((a, b) => a.ordinal - b.ordinal);
  113. const disposables = new DisposableStore();
  114. for (const hoverPart of hoverParts) {
  115. for (const contents of hoverPart.contents) {
  116. if (isEmptyMarkdownString(contents)) {
  117. continue;
  118. }
  119. const markdownHoverElement = $('div.hover-row.markdown-hover');
  120. const hoverContentsElement = dom.append(markdownHoverElement, $('div.hover-contents'));
  121. const renderer = disposables.add(new MarkdownRenderer({ editor }, modeService, openerService));
  122. disposables.add(renderer.onDidRenderAsync(() => {
  123. hoverContentsElement.className = 'hover-contents code-hover-contents';
  124. hover.onContentsChanged();
  125. }));
  126. const renderedContents = disposables.add(renderer.render(contents));
  127. hoverContentsElement.appendChild(renderedContents.element);
  128. fragment.appendChild(markdownHoverElement);
  129. }
  130. }
  131. return disposables;
  132. }