c05f7e692b5b4fb5c3bdbcd5a465edf79f6ab6f4a5b7dc9b90d9b2c6cd6afe7aa1cd486aba3152c3976db5a3c24c98cd449b14dff2a6de0520988b816958e6 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329
  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 __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
  6. function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
  7. return new (P || (P = Promise))(function (resolve, reject) {
  8. function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
  9. function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
  10. function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
  11. step((generator = generator.apply(thisArg, _arguments || [])).next());
  12. });
  13. };
  14. import { CancellationToken } from '../../../../base/common/cancellation.js';
  15. import { CancellationError, isCancellationError, onUnexpectedExternalError } from '../../../../base/common/errors.js';
  16. import { FuzzyScore } from '../../../../base/common/filters.js';
  17. import { DisposableStore, isDisposable } from '../../../../base/common/lifecycle.js';
  18. import { StopWatch } from '../../../../base/common/stopwatch.js';
  19. import { assertType } from '../../../../base/common/types.js';
  20. import { URI } from '../../../../base/common/uri.js';
  21. import { Position } from '../../../common/core/position.js';
  22. import { Range } from '../../../common/core/range.js';
  23. import { ITextModelService } from '../../../common/services/resolverService.js';
  24. import { SnippetParser } from '../../snippet/browser/snippetParser.js';
  25. import { localize } from '../../../../nls.js';
  26. import { MenuId } from '../../../../platform/actions/common/actions.js';
  27. import { CommandsRegistry } from '../../../../platform/commands/common/commands.js';
  28. import { RawContextKey } from '../../../../platform/contextkey/common/contextkey.js';
  29. import { ILanguageFeaturesService } from '../../../common/services/languageFeatures.js';
  30. import { historyNavigationVisible } from '../../../../platform/history/browser/contextScopedHistoryWidget.js';
  31. export const Context = {
  32. Visible: historyNavigationVisible,
  33. HasFocusedSuggestion: new RawContextKey('suggestWidgetHasFocusedSuggestion', false, localize('suggestWidgetHasSelection', "Whether any suggestion is focused")),
  34. DetailsVisible: new RawContextKey('suggestWidgetDetailsVisible', false, localize('suggestWidgetDetailsVisible', "Whether suggestion details are visible")),
  35. MultipleSuggestions: new RawContextKey('suggestWidgetMultipleSuggestions', false, localize('suggestWidgetMultipleSuggestions', "Whether there are multiple suggestions to pick from")),
  36. MakesTextEdit: new RawContextKey('suggestionMakesTextEdit', true, localize('suggestionMakesTextEdit', "Whether inserting the current suggestion yields in a change or has everything already been typed")),
  37. AcceptSuggestionsOnEnter: new RawContextKey('acceptSuggestionOnEnter', true, localize('acceptSuggestionOnEnter', "Whether suggestions are inserted when pressing Enter")),
  38. HasInsertAndReplaceRange: new RawContextKey('suggestionHasInsertAndReplaceRange', false, localize('suggestionHasInsertAndReplaceRange', "Whether the current suggestion has insert and replace behaviour")),
  39. InsertMode: new RawContextKey('suggestionInsertMode', undefined, { type: 'string', description: localize('suggestionInsertMode', "Whether the default behaviour is to insert or replace") }),
  40. CanResolve: new RawContextKey('suggestionCanResolve', false, localize('suggestionCanResolve', "Whether the current suggestion supports to resolve further details")),
  41. };
  42. export const suggestWidgetStatusbarMenu = new MenuId('suggestWidgetStatusBar');
  43. export class CompletionItem {
  44. constructor(position, completion, container, provider) {
  45. this.position = position;
  46. this.completion = completion;
  47. this.container = container;
  48. this.provider = provider;
  49. // validation
  50. this.isInvalid = false;
  51. // sorting, filtering
  52. this.score = FuzzyScore.Default;
  53. this.distance = 0;
  54. this.textLabel = typeof completion.label === 'string'
  55. ? completion.label
  56. : completion.label.label;
  57. // ensure lower-variants (perf)
  58. this.labelLow = this.textLabel.toLowerCase();
  59. // validate label
  60. this.isInvalid = !this.textLabel;
  61. this.sortTextLow = completion.sortText && completion.sortText.toLowerCase();
  62. this.filterTextLow = completion.filterText && completion.filterText.toLowerCase();
  63. this.extensionId = completion.extensionId;
  64. // normalize ranges
  65. if (Range.isIRange(completion.range)) {
  66. this.editStart = new Position(completion.range.startLineNumber, completion.range.startColumn);
  67. this.editInsertEnd = new Position(completion.range.endLineNumber, completion.range.endColumn);
  68. this.editReplaceEnd = new Position(completion.range.endLineNumber, completion.range.endColumn);
  69. // validate range
  70. this.isInvalid = this.isInvalid
  71. || Range.spansMultipleLines(completion.range) || completion.range.startLineNumber !== position.lineNumber;
  72. }
  73. else {
  74. this.editStart = new Position(completion.range.insert.startLineNumber, completion.range.insert.startColumn);
  75. this.editInsertEnd = new Position(completion.range.insert.endLineNumber, completion.range.insert.endColumn);
  76. this.editReplaceEnd = new Position(completion.range.replace.endLineNumber, completion.range.replace.endColumn);
  77. // validate ranges
  78. this.isInvalid = this.isInvalid
  79. || Range.spansMultipleLines(completion.range.insert) || Range.spansMultipleLines(completion.range.replace)
  80. || completion.range.insert.startLineNumber !== position.lineNumber || completion.range.replace.startLineNumber !== position.lineNumber
  81. || completion.range.insert.startColumn !== completion.range.replace.startColumn;
  82. }
  83. // create the suggestion resolver
  84. if (typeof provider.resolveCompletionItem !== 'function') {
  85. this._resolveCache = Promise.resolve();
  86. this._isResolved = true;
  87. }
  88. }
  89. // ---- resolving
  90. get isResolved() {
  91. return !!this._isResolved;
  92. }
  93. resolve(token) {
  94. return __awaiter(this, void 0, void 0, function* () {
  95. if (!this._resolveCache) {
  96. const sub = token.onCancellationRequested(() => {
  97. this._resolveCache = undefined;
  98. this._isResolved = false;
  99. });
  100. this._resolveCache = Promise.resolve(this.provider.resolveCompletionItem(this.completion, token)).then(value => {
  101. Object.assign(this.completion, value);
  102. this._isResolved = true;
  103. sub.dispose();
  104. }, err => {
  105. if (isCancellationError(err)) {
  106. // the IPC queue will reject the request with the
  107. // cancellation error -> reset cached
  108. this._resolveCache = undefined;
  109. this._isResolved = false;
  110. }
  111. });
  112. }
  113. return this._resolveCache;
  114. });
  115. }
  116. }
  117. export class CompletionOptions {
  118. constructor(snippetSortOrder = 2 /* SnippetSortOrder.Bottom */, kindFilter = new Set(), providerFilter = new Set(), showDeprecated = true) {
  119. this.snippetSortOrder = snippetSortOrder;
  120. this.kindFilter = kindFilter;
  121. this.providerFilter = providerFilter;
  122. this.showDeprecated = showDeprecated;
  123. }
  124. }
  125. CompletionOptions.default = new CompletionOptions();
  126. let _snippetSuggestSupport;
  127. export function getSnippetSuggestSupport() {
  128. return _snippetSuggestSupport;
  129. }
  130. export class CompletionItemModel {
  131. constructor(items, needsClipboard, durations, disposable) {
  132. this.items = items;
  133. this.needsClipboard = needsClipboard;
  134. this.durations = durations;
  135. this.disposable = disposable;
  136. }
  137. }
  138. export function provideSuggestionItems(registry, model, position, options = CompletionOptions.default, context = { triggerKind: 0 /* languages.CompletionTriggerKind.Invoke */ }, token = CancellationToken.None) {
  139. return __awaiter(this, void 0, void 0, function* () {
  140. const sw = new StopWatch(true);
  141. position = position.clone();
  142. const word = model.getWordAtPosition(position);
  143. const defaultReplaceRange = word ? new Range(position.lineNumber, word.startColumn, position.lineNumber, word.endColumn) : Range.fromPositions(position);
  144. const defaultRange = { replace: defaultReplaceRange, insert: defaultReplaceRange.setEndPosition(position.lineNumber, position.column) };
  145. const result = [];
  146. const disposables = new DisposableStore();
  147. const durations = [];
  148. let needsClipboard = false;
  149. const onCompletionList = (provider, container, sw) => {
  150. var _a, _b, _c;
  151. let didAddResult = false;
  152. if (!container) {
  153. return didAddResult;
  154. }
  155. for (const suggestion of container.suggestions) {
  156. if (!options.kindFilter.has(suggestion.kind)) {
  157. // skip if not showing deprecated suggestions
  158. if (!options.showDeprecated && ((_a = suggestion === null || suggestion === void 0 ? void 0 : suggestion.tags) === null || _a === void 0 ? void 0 : _a.includes(1 /* languages.CompletionItemTag.Deprecated */))) {
  159. continue;
  160. }
  161. // fill in default range when missing
  162. if (!suggestion.range) {
  163. suggestion.range = defaultRange;
  164. }
  165. // fill in default sortText when missing
  166. if (!suggestion.sortText) {
  167. suggestion.sortText = typeof suggestion.label === 'string' ? suggestion.label : suggestion.label.label;
  168. }
  169. if (!needsClipboard && suggestion.insertTextRules && suggestion.insertTextRules & 4 /* languages.CompletionItemInsertTextRule.InsertAsSnippet */) {
  170. needsClipboard = SnippetParser.guessNeedsClipboard(suggestion.insertText);
  171. }
  172. result.push(new CompletionItem(position, suggestion, container, provider));
  173. didAddResult = true;
  174. }
  175. }
  176. if (isDisposable(container)) {
  177. disposables.add(container);
  178. }
  179. durations.push({
  180. providerName: (_b = provider._debugDisplayName) !== null && _b !== void 0 ? _b : 'unknown_provider', elapsedProvider: (_c = container.duration) !== null && _c !== void 0 ? _c : -1, elapsedOverall: sw.elapsed()
  181. });
  182. return didAddResult;
  183. };
  184. // ask for snippets in parallel to asking "real" providers. Only do something if configured to
  185. // do so - no snippet filter, no special-providers-only request
  186. const snippetCompletions = (() => __awaiter(this, void 0, void 0, function* () {
  187. if (!_snippetSuggestSupport || options.kindFilter.has(27 /* languages.CompletionItemKind.Snippet */)) {
  188. return;
  189. }
  190. if (options.providerFilter.size > 0 && !options.providerFilter.has(_snippetSuggestSupport)) {
  191. return;
  192. }
  193. const sw = new StopWatch(true);
  194. const list = yield _snippetSuggestSupport.provideCompletionItems(model, position, context, token);
  195. onCompletionList(_snippetSuggestSupport, list, sw);
  196. }))();
  197. // add suggestions from contributed providers - providers are ordered in groups of
  198. // equal score and once a group produces a result the process stops
  199. // get provider groups, always add snippet suggestion provider
  200. for (const providerGroup of registry.orderedGroups(model)) {
  201. // for each support in the group ask for suggestions
  202. let didAddResult = false;
  203. yield Promise.all(providerGroup.map((provider) => __awaiter(this, void 0, void 0, function* () {
  204. if (options.providerFilter.size > 0 && !options.providerFilter.has(provider)) {
  205. return;
  206. }
  207. try {
  208. const sw = new StopWatch(true);
  209. const list = yield provider.provideCompletionItems(model, position, context, token);
  210. didAddResult = onCompletionList(provider, list, sw) || didAddResult;
  211. }
  212. catch (err) {
  213. onUnexpectedExternalError(err);
  214. }
  215. })));
  216. if (didAddResult || token.isCancellationRequested) {
  217. break;
  218. }
  219. }
  220. yield snippetCompletions;
  221. if (token.isCancellationRequested) {
  222. disposables.dispose();
  223. return Promise.reject(new CancellationError());
  224. }
  225. return new CompletionItemModel(result.sort(getSuggestionComparator(options.snippetSortOrder)), needsClipboard, { entries: durations, elapsed: sw.elapsed() }, disposables);
  226. });
  227. }
  228. function defaultComparator(a, b) {
  229. // check with 'sortText'
  230. if (a.sortTextLow && b.sortTextLow) {
  231. if (a.sortTextLow < b.sortTextLow) {
  232. return -1;
  233. }
  234. else if (a.sortTextLow > b.sortTextLow) {
  235. return 1;
  236. }
  237. }
  238. // check with 'label'
  239. if (a.textLabel < b.textLabel) {
  240. return -1;
  241. }
  242. else if (a.textLabel > b.textLabel) {
  243. return 1;
  244. }
  245. // check with 'type'
  246. return a.completion.kind - b.completion.kind;
  247. }
  248. function snippetUpComparator(a, b) {
  249. if (a.completion.kind !== b.completion.kind) {
  250. if (a.completion.kind === 27 /* languages.CompletionItemKind.Snippet */) {
  251. return -1;
  252. }
  253. else if (b.completion.kind === 27 /* languages.CompletionItemKind.Snippet */) {
  254. return 1;
  255. }
  256. }
  257. return defaultComparator(a, b);
  258. }
  259. function snippetDownComparator(a, b) {
  260. if (a.completion.kind !== b.completion.kind) {
  261. if (a.completion.kind === 27 /* languages.CompletionItemKind.Snippet */) {
  262. return 1;
  263. }
  264. else if (b.completion.kind === 27 /* languages.CompletionItemKind.Snippet */) {
  265. return -1;
  266. }
  267. }
  268. return defaultComparator(a, b);
  269. }
  270. const _snippetComparators = new Map();
  271. _snippetComparators.set(0 /* SnippetSortOrder.Top */, snippetUpComparator);
  272. _snippetComparators.set(2 /* SnippetSortOrder.Bottom */, snippetDownComparator);
  273. _snippetComparators.set(1 /* SnippetSortOrder.Inline */, defaultComparator);
  274. export function getSuggestionComparator(snippetConfig) {
  275. return _snippetComparators.get(snippetConfig);
  276. }
  277. CommandsRegistry.registerCommand('_executeCompletionItemProvider', (accessor, ...args) => __awaiter(void 0, void 0, void 0, function* () {
  278. const [uri, position, triggerCharacter, maxItemsToResolve] = args;
  279. assertType(URI.isUri(uri));
  280. assertType(Position.isIPosition(position));
  281. assertType(typeof triggerCharacter === 'string' || !triggerCharacter);
  282. assertType(typeof maxItemsToResolve === 'number' || !maxItemsToResolve);
  283. const { completionProvider } = accessor.get(ILanguageFeaturesService);
  284. const ref = yield accessor.get(ITextModelService).createModelReference(uri);
  285. try {
  286. const result = {
  287. incomplete: false,
  288. suggestions: []
  289. };
  290. const resolving = [];
  291. const completions = yield provideSuggestionItems(completionProvider, ref.object.textEditorModel, Position.lift(position), undefined, { triggerCharacter, triggerKind: triggerCharacter ? 1 /* languages.CompletionTriggerKind.TriggerCharacter */ : 0 /* languages.CompletionTriggerKind.Invoke */ });
  292. for (const item of completions.items) {
  293. if (resolving.length < (maxItemsToResolve !== null && maxItemsToResolve !== void 0 ? maxItemsToResolve : 0)) {
  294. resolving.push(item.resolve(CancellationToken.None));
  295. }
  296. result.incomplete = result.incomplete || item.container.incomplete;
  297. result.suggestions.push(item.completion);
  298. }
  299. try {
  300. yield Promise.all(resolving);
  301. return result;
  302. }
  303. finally {
  304. setTimeout(() => completions.disposable.dispose(), 100);
  305. }
  306. }
  307. finally {
  308. ref.dispose();
  309. }
  310. }));
  311. export function showSimpleSuggestions(editor, provider) {
  312. var _a;
  313. (_a = editor.getContribution('editor.contrib.suggestController')) === null || _a === void 0 ? void 0 : _a.triggerSuggest(new Set().add(provider), undefined, true);
  314. }
  315. export class QuickSuggestionsOptions {
  316. static isAllOff(config) {
  317. return config.other === 'off' && config.comments === 'off' && config.strings === 'off';
  318. }
  319. static isAllOn(config) {
  320. return config.other === 'on' && config.comments === 'on' && config.strings === 'on';
  321. }
  322. static valueFor(config, tokenType) {
  323. switch (tokenType) {
  324. case 1 /* StandardTokenType.Comment */: return config.comments;
  325. case 2 /* StandardTokenType.String */: return config.strings;
  326. default: return config.other;
  327. }
  328. }
  329. }