/*--------------------------------------------------------------------------------------------- * Copyright (c) Microsoft Corporation. All rights reserved. * Licensed under the Source EULA. See License.txt in the project root for license information. *--------------------------------------------------------------------------------------------*/ import { URI, UriComponents } from 'vs/base/common/uri'; import { mixin } from 'vs/base/common/objects'; import type * as vscode from 'vscode'; import * as typeConvert from 'vs/workbench/api/common/extHostTypeConverters'; import { Range, Disposable, CompletionList, SnippetString, CodeActionKind, SymbolInformation, DocumentSymbol, SemanticTokensEdits, SemanticTokens, SemanticTokensEdit } from 'vs/workbench/api/common/extHostTypes'; import { ISingleEditOperation } from 'vs/editor/common/model'; import * as modes from 'vs/editor/common/modes'; import { ExtHostDocuments } from 'vs/workbench/api/common/extHostDocuments'; import { ExtHostCommands, CommandsConverter } from 'vs/workbench/api/common/extHostCommands'; import { ExtHostDiagnostics } from 'vs/workbench/api/common/extHostDiagnostics'; import { asPromise } from 'vs/base/common/async'; import * as extHostProtocol from './extHost.protocol'; import { regExpLeadsToEndlessLoop, regExpFlags } from 'vs/base/common/strings'; import { IPosition } from 'vs/editor/common/core/position'; import { IRange, Range as EditorRange } from 'vs/editor/common/core/range'; import { isFalsyOrEmpty, isNonEmptyArray, coalesce, asArray } from 'vs/base/common/arrays'; import { isObject } from 'vs/base/common/types'; import { ISelection, Selection } from 'vs/editor/common/core/selection'; import { ILogService } from 'vs/platform/log/common/log'; import { CancellationToken } from 'vs/base/common/cancellation'; import { ExtensionIdentifier, IExtensionDescription } from 'vs/platform/extensions/common/extensions'; import { IURITransformer } from 'vs/base/common/uriIpc'; import { DisposableStore } from 'vs/base/common/lifecycle'; import { VSBuffer } from 'vs/base/common/buffer'; import { encodeSemanticTokensDto } from 'vs/workbench/api/common/shared/semanticTokensDto'; import { IdGenerator } from 'vs/base/common/idGenerator'; import { IExtHostApiDeprecationService } from 'vs/workbench/api/common/extHostApiDeprecationService'; import { Cache } from './cache'; // --- adapter class DocumentSymbolAdapter { private _documents: ExtHostDocuments; private _provider: vscode.DocumentSymbolProvider; constructor(documents: ExtHostDocuments, provider: vscode.DocumentSymbolProvider) { this._documents = documents; this._provider = provider; } provideDocumentSymbols(resource: URI, token: CancellationToken): Promise { const doc = this._documents.getDocument(resource); return asPromise(() => this._provider.provideDocumentSymbols(doc, token)).then(value => { if (isFalsyOrEmpty(value)) { return undefined; } else if (value![0] instanceof DocumentSymbol) { return (value).map(typeConvert.DocumentSymbol.from); } else { return DocumentSymbolAdapter._asDocumentSymbolTree(value); } }); } private static _asDocumentSymbolTree(infos: SymbolInformation[]): modes.DocumentSymbol[] { // first sort by start (and end) and then loop over all elements // and build a tree based on containment. infos = infos.slice(0).sort((a, b) => { let res = a.location.range.start.compareTo(b.location.range.start); if (res === 0) { res = b.location.range.end.compareTo(a.location.range.end); } return res; }); const res: modes.DocumentSymbol[] = []; const parentStack: modes.DocumentSymbol[] = []; for (const info of infos) { const element: modes.DocumentSymbol = { name: info.name || '!!MISSING: name!!', kind: typeConvert.SymbolKind.from(info.kind), tags: info.tags?.map(typeConvert.SymbolTag.from) || [], detail: '', containerName: info.containerName, range: typeConvert.Range.from(info.location.range), selectionRange: typeConvert.Range.from(info.location.range), children: [] }; while (true) { if (parentStack.length === 0) { parentStack.push(element); res.push(element); break; } const parent = parentStack[parentStack.length - 1]; if (EditorRange.containsRange(parent.range, element.range) && !EditorRange.equalsRange(parent.range, element.range)) { if (parent.children) { parent.children.push(element); } parentStack.push(element); break; } parentStack.pop(); } } return res; } } class CodeLensAdapter { private static _badCmd: vscode.Command = { command: 'missing', title: '!!MISSING: command!!' }; private readonly _cache = new Cache('CodeLens'); private readonly _disposables = new Map(); constructor( private readonly _documents: ExtHostDocuments, private readonly _commands: CommandsConverter, private readonly _provider: vscode.CodeLensProvider ) { } provideCodeLenses(resource: URI, token: CancellationToken): Promise { const doc = this._documents.getDocument(resource); return asPromise(() => this._provider.provideCodeLenses(doc, token)).then(lenses => { if (!lenses || token.isCancellationRequested) { return undefined; } const cacheId = this._cache.add(lenses); const disposables = new DisposableStore(); this._disposables.set(cacheId, disposables); const result: extHostProtocol.ICodeLensListDto = { cacheId, lenses: [], }; for (let i = 0; i < lenses.length; i++) { result.lenses.push({ cacheId: [cacheId, i], range: typeConvert.Range.from(lenses[i].range), command: this._commands.toInternal(lenses[i].command, disposables) }); } return result; }); } resolveCodeLens(symbol: extHostProtocol.ICodeLensDto, token: CancellationToken): Promise { const lens = symbol.cacheId && this._cache.get(...symbol.cacheId); if (!lens) { return Promise.resolve(undefined); } let resolve: Promise; if (typeof this._provider.resolveCodeLens !== 'function' || lens.isResolved) { resolve = Promise.resolve(lens); } else { resolve = asPromise(() => this._provider.resolveCodeLens!(lens, token)); } return resolve.then(newLens => { if (token.isCancellationRequested) { return undefined; } const disposables = symbol.cacheId && this._disposables.get(symbol.cacheId[0]); if (!disposables) { // We've already been disposed of return undefined; } newLens = newLens || lens; symbol.command = this._commands.toInternal(newLens.command || CodeLensAdapter._badCmd, disposables); return symbol; }); } releaseCodeLenses(cachedId: number): void { this._disposables.get(cachedId)?.dispose(); this._disposables.delete(cachedId); this._cache.delete(cachedId); } } function convertToLocationLinks(value: vscode.Location | vscode.Location[] | vscode.LocationLink[] | undefined | null): modes.LocationLink[] { if (Array.isArray(value)) { return (value).map(typeConvert.DefinitionLink.from); } else if (value) { return [typeConvert.DefinitionLink.from(value)]; } return []; } class DefinitionAdapter { constructor( private readonly _documents: ExtHostDocuments, private readonly _provider: vscode.DefinitionProvider ) { } provideDefinition(resource: URI, position: IPosition, token: CancellationToken): Promise { const doc = this._documents.getDocument(resource); const pos = typeConvert.Position.to(position); return asPromise(() => this._provider.provideDefinition(doc, pos, token)).then(convertToLocationLinks); } } class DeclarationAdapter { constructor( private readonly _documents: ExtHostDocuments, private readonly _provider: vscode.DeclarationProvider ) { } provideDeclaration(resource: URI, position: IPosition, token: CancellationToken): Promise { const doc = this._documents.getDocument(resource); const pos = typeConvert.Position.to(position); return asPromise(() => this._provider.provideDeclaration(doc, pos, token)).then(convertToLocationLinks); } } class ImplementationAdapter { constructor( private readonly _documents: ExtHostDocuments, private readonly _provider: vscode.ImplementationProvider ) { } provideImplementation(resource: URI, position: IPosition, token: CancellationToken): Promise { const doc = this._documents.getDocument(resource); const pos = typeConvert.Position.to(position); return asPromise(() => this._provider.provideImplementation(doc, pos, token)).then(convertToLocationLinks); } } class TypeDefinitionAdapter { constructor( private readonly _documents: ExtHostDocuments, private readonly _provider: vscode.TypeDefinitionProvider ) { } provideTypeDefinition(resource: URI, position: IPosition, token: CancellationToken): Promise { const doc = this._documents.getDocument(resource); const pos = typeConvert.Position.to(position); return asPromise(() => this._provider.provideTypeDefinition(doc, pos, token)).then(convertToLocationLinks); } } class HoverAdapter { constructor( private readonly _documents: ExtHostDocuments, private readonly _provider: vscode.HoverProvider, ) { } public provideHover(resource: URI, position: IPosition, token: CancellationToken): Promise { const doc = this._documents.getDocument(resource); const pos = typeConvert.Position.to(position); return asPromise(() => this._provider.provideHover(doc, pos, token)).then(value => { if (!value || isFalsyOrEmpty(value.contents)) { return undefined; } if (!value.range) { value.range = doc.getWordRangeAtPosition(pos); } if (!value.range) { value.range = new Range(pos, pos); } return typeConvert.Hover.from(value); }); } } class EvaluatableExpressionAdapter { constructor( private readonly _documents: ExtHostDocuments, private readonly _provider: vscode.EvaluatableExpressionProvider, ) { } public provideEvaluatableExpression(resource: URI, position: IPosition, token: CancellationToken): Promise { const doc = this._documents.getDocument(resource); const pos = typeConvert.Position.to(position); return asPromise(() => this._provider.provideEvaluatableExpression(doc, pos, token)).then(value => { if (value) { return typeConvert.EvaluatableExpression.from(value); } return undefined; }); } } class DocumentHighlightAdapter { constructor( private readonly _documents: ExtHostDocuments, private readonly _provider: vscode.DocumentHighlightProvider ) { } provideDocumentHighlights(resource: URI, position: IPosition, token: CancellationToken): Promise { const doc = this._documents.getDocument(resource); const pos = typeConvert.Position.to(position); return asPromise(() => this._provider.provideDocumentHighlights(doc, pos, token)).then(value => { if (Array.isArray(value)) { return value.map(typeConvert.DocumentHighlight.from); } return undefined; }); } } class OnTypeRenameAdapter { constructor( private readonly _documents: ExtHostDocuments, private readonly _provider: vscode.OnTypeRenameProvider ) { } provideOnTypeRenameRanges(resource: URI, position: IPosition, token: CancellationToken): Promise<{ ranges: IRange[]; wordPattern?: RegExp; } | undefined> { const doc = this._documents.getDocument(resource); const pos = typeConvert.Position.to(position); return asPromise(() => this._provider.provideOnTypeRenameRanges(doc, pos, token)).then(value => { if (value && Array.isArray(value.ranges)) { return { ranges: coalesce(value.ranges.map(typeConvert.Range.from)), wordPattern: value.wordPattern }; } return undefined; }); } } class ReferenceAdapter { constructor( private readonly _documents: ExtHostDocuments, private readonly _provider: vscode.ReferenceProvider ) { } provideReferences(resource: URI, position: IPosition, context: modes.ReferenceContext, token: CancellationToken): Promise { const doc = this._documents.getDocument(resource); const pos = typeConvert.Position.to(position); return asPromise(() => this._provider.provideReferences(doc, pos, context, token)).then(value => { if (Array.isArray(value)) { return value.map(typeConvert.location.from); } return undefined; }); } } export interface CustomCodeAction extends extHostProtocol.ICodeActionDto { _isSynthetic?: boolean; } class CodeActionAdapter { private static readonly _maxCodeActionsPerFile: number = 1000; private readonly _cache = new Cache('CodeAction'); private readonly _disposables = new Map(); constructor( private readonly _documents: ExtHostDocuments, private readonly _commands: CommandsConverter, private readonly _diagnostics: ExtHostDiagnostics, private readonly _provider: vscode.CodeActionProvider, private readonly _logService: ILogService, private readonly _extension: IExtensionDescription, private readonly _apiDeprecation: IExtHostApiDeprecationService, ) { } provideCodeActions(resource: URI, rangeOrSelection: IRange | ISelection, context: modes.CodeActionContext, token: CancellationToken): Promise { const doc = this._documents.getDocument(resource); const ran = Selection.isISelection(rangeOrSelection) ? typeConvert.Selection.to(rangeOrSelection) : typeConvert.Range.to(rangeOrSelection); const allDiagnostics: vscode.Diagnostic[] = []; for (const diagnostic of this._diagnostics.getDiagnostics(resource)) { if (ran.intersection(diagnostic.range)) { const newLen = allDiagnostics.push(diagnostic); if (newLen > CodeActionAdapter._maxCodeActionsPerFile) { break; } } } const codeActionContext: vscode.CodeActionContext = { diagnostics: allDiagnostics, only: context.only ? new CodeActionKind(context.only) : undefined }; return asPromise(() => this._provider.provideCodeActions(doc, ran, codeActionContext, token)).then((commandsOrActions): extHostProtocol.ICodeActionListDto | undefined => { if (!isNonEmptyArray(commandsOrActions) || token.isCancellationRequested) { return undefined; } const cacheId = this._cache.add(commandsOrActions); const disposables = new DisposableStore(); this._disposables.set(cacheId, disposables); const actions: CustomCodeAction[] = []; for (const candidate of commandsOrActions) { if (!candidate) { continue; } if (CodeActionAdapter._isCommand(candidate)) { // old school: synthetic code action this._apiDeprecation.report('CodeActionProvider.provideCodeActions - return commands', this._extension, `Return 'CodeAction' instances instead.`); actions.push({ _isSynthetic: true, title: candidate.title, command: this._commands.toInternal(candidate, disposables), }); } else { if (codeActionContext.only) { if (!candidate.kind) { this._logService.warn(`${this._extension.identifier.value} - Code actions of kind '${codeActionContext.only.value} 'requested but returned code action does not have a 'kind'. Code action will be dropped. Please set 'CodeAction.kind'.`); } else if (!codeActionContext.only.contains(candidate.kind)) { this._logService.warn(`${this._extension.identifier.value} - Code actions of kind '${codeActionContext.only.value} 'requested but returned code action is of kind '${candidate.kind.value}'. Code action will be dropped. Please check 'CodeActionContext.only' to only return requested code actions.`); } } // new school: convert code action actions.push({ title: candidate.title, command: candidate.command && this._commands.toInternal(candidate.command, disposables), diagnostics: candidate.diagnostics && candidate.diagnostics.map(typeConvert.Diagnostic.from), edit: candidate.edit && typeConvert.WorkspaceEdit.from(candidate.edit), kind: candidate.kind && candidate.kind.value, isPreferred: candidate.isPreferred, disabled: candidate.disabled?.reason }); } } return { cacheId, actions }; }); } public releaseCodeActions(cachedId: number): void { this._disposables.get(cachedId)?.dispose(); this._disposables.delete(cachedId); this._cache.delete(cachedId); } private static _isCommand(thing: any): thing is vscode.Command { return typeof (thing).command === 'string' && typeof (thing).title === 'string'; } } class DocumentFormattingAdapter { constructor( private readonly _documents: ExtHostDocuments, private readonly _provider: vscode.DocumentFormattingEditProvider ) { } provideDocumentFormattingEdits(resource: URI, options: modes.FormattingOptions, token: CancellationToken): Promise { const document = this._documents.getDocument(resource); return asPromise(() => this._provider.provideDocumentFormattingEdits(document, options, token)).then(value => { if (Array.isArray(value)) { return value.map(typeConvert.TextEdit.from); } return undefined; }); } } class RangeFormattingAdapter { constructor( private readonly _documents: ExtHostDocuments, private readonly _provider: vscode.DocumentRangeFormattingEditProvider ) { } provideDocumentRangeFormattingEdits(resource: URI, range: IRange, options: modes.FormattingOptions, token: CancellationToken): Promise { const document = this._documents.getDocument(resource); const ran = typeConvert.Range.to(range); return asPromise(() => this._provider.provideDocumentRangeFormattingEdits(document, ran, options, token)).then(value => { if (Array.isArray(value)) { return value.map(typeConvert.TextEdit.from); } return undefined; }); } } class OnTypeFormattingAdapter { constructor( private readonly _documents: ExtHostDocuments, private readonly _provider: vscode.OnTypeFormattingEditProvider ) { } autoFormatTriggerCharacters: string[] = []; // not here provideOnTypeFormattingEdits(resource: URI, position: IPosition, ch: string, options: modes.FormattingOptions, token: CancellationToken): Promise { const document = this._documents.getDocument(resource); const pos = typeConvert.Position.to(position); return asPromise(() => this._provider.provideOnTypeFormattingEdits(document, pos, ch, options, token)).then(value => { if (Array.isArray(value)) { return value.map(typeConvert.TextEdit.from); } return undefined; }); } } class NavigateTypeAdapter { private readonly _symbolCache = new Map(); private readonly _resultCache = new Map(); constructor( private readonly _provider: vscode.WorkspaceSymbolProvider, private readonly _logService: ILogService ) { } provideWorkspaceSymbols(search: string, token: CancellationToken): Promise { const result: extHostProtocol.IWorkspaceSymbolsDto = extHostProtocol.IdObject.mixin({ symbols: [] }); return asPromise(() => this._provider.provideWorkspaceSymbols(search, token)).then(value => { if (isNonEmptyArray(value)) { for (const item of value) { if (!item) { // drop continue; } if (!item.name) { this._logService.warn('INVALID SymbolInformation, lacks name', item); continue; } const symbol = extHostProtocol.IdObject.mixin(typeConvert.WorkspaceSymbol.from(item)); this._symbolCache.set(symbol._id!, item); result.symbols.push(symbol); } } }).then(() => { if (result.symbols.length > 0) { this._resultCache.set(result._id!, [result.symbols[0]._id!, result.symbols[result.symbols.length - 1]._id!]); } return result; }); } async resolveWorkspaceSymbol(symbol: extHostProtocol.IWorkspaceSymbolDto, token: CancellationToken): Promise { if (typeof this._provider.resolveWorkspaceSymbol !== 'function') { return symbol; } const item = this._symbolCache.get(symbol._id!); if (item) { const value = await asPromise(() => this._provider.resolveWorkspaceSymbol!(item, token)); return value && mixin(symbol, typeConvert.WorkspaceSymbol.from(value), true); } return undefined; } releaseWorkspaceSymbols(id: number): any { const range = this._resultCache.get(id); if (range) { for (let [from, to] = range; from <= to; from++) { this._symbolCache.delete(from); } this._resultCache.delete(id); } } } class RenameAdapter { static supportsResolving(provider: vscode.RenameProvider): boolean { return typeof provider.prepareRename === 'function'; } constructor( private readonly _documents: ExtHostDocuments, private readonly _provider: vscode.RenameProvider, private readonly _logService: ILogService ) { } provideRenameEdits(resource: URI, position: IPosition, newName: string, token: CancellationToken): Promise { const doc = this._documents.getDocument(resource); const pos = typeConvert.Position.to(position); return asPromise(() => this._provider.provideRenameEdits(doc, pos, newName, token)).then(value => { if (!value) { return undefined; } return typeConvert.WorkspaceEdit.from(value); }, err => { const rejectReason = RenameAdapter._asMessage(err); if (rejectReason) { return { rejectReason, edits: undefined! }; } else { // generic error return Promise.reject(err); } }); } resolveRenameLocation(resource: URI, position: IPosition, token: CancellationToken): Promise<(modes.RenameLocation & modes.Rejection) | undefined> { if (typeof this._provider.prepareRename !== 'function') { return Promise.resolve(undefined); } const doc = this._documents.getDocument(resource); const pos = typeConvert.Position.to(position); return asPromise(() => this._provider.prepareRename!(doc, pos, token)).then(rangeOrLocation => { let range: vscode.Range | undefined; let text: string | undefined; if (Range.isRange(rangeOrLocation)) { range = rangeOrLocation; text = doc.getText(rangeOrLocation); } else if (isObject(rangeOrLocation)) { range = rangeOrLocation.range; text = rangeOrLocation.placeholder; } if (!range) { return undefined; } if (range.start.line > pos.line || range.end.line < pos.line) { this._logService.warn('INVALID rename location: position line must be within range start/end lines'); return undefined; } return { range: typeConvert.Range.from(range), text }; }, err => { const rejectReason = RenameAdapter._asMessage(err); if (rejectReason) { return { rejectReason, range: undefined!, text: undefined! }; } else { return Promise.reject(err); } }); } private static _asMessage(err: any): string | undefined { if (typeof err === 'string') { return err; } else if (err instanceof Error && typeof err.message === 'string') { return err.message; } else { return undefined; } } } class SemanticTokensPreviousResult { constructor( public readonly resultId: string | undefined, public readonly tokens?: Uint32Array, ) { } } type RelaxedSemanticTokens = { readonly resultId?: string; readonly data: number[]; }; type RelaxedSemanticTokensEdit = { readonly start: number; readonly deleteCount: number; readonly data?: number[]; }; type RelaxedSemanticTokensEdits = { readonly resultId?: string; readonly edits: RelaxedSemanticTokensEdit[]; }; type ProvidedSemanticTokens = vscode.SemanticTokens | RelaxedSemanticTokens; type ProvidedSemanticTokensEdits = vscode.SemanticTokensEdits | RelaxedSemanticTokensEdits; export class DocumentSemanticTokensAdapter { private readonly _previousResults: Map; private _nextResultId = 1; constructor( private readonly _documents: ExtHostDocuments, private readonly _provider: vscode.DocumentSemanticTokensProvider, ) { this._previousResults = new Map(); } provideDocumentSemanticTokens(resource: URI, previousResultId: number, token: CancellationToken): Promise { const doc = this._documents.getDocument(resource); const previousResult = (previousResultId !== 0 ? this._previousResults.get(previousResultId) : null); return asPromise(() => { if (previousResult && typeof previousResult.resultId === 'string' && typeof this._provider.provideDocumentSemanticTokensEdits === 'function') { return this._provider.provideDocumentSemanticTokensEdits(doc, previousResult.resultId, token); } return this._provider.provideDocumentSemanticTokens(doc, token); }).then((value: ProvidedSemanticTokens | ProvidedSemanticTokensEdits | null | undefined) => { if (previousResult) { this._previousResults.delete(previousResultId); } if (!value) { return null; } value = DocumentSemanticTokensAdapter._fixProvidedSemanticTokens(value); return this._send(DocumentSemanticTokensAdapter._convertToEdits(previousResult, value), value); }); } async releaseDocumentSemanticColoring(semanticColoringResultId: number): Promise { this._previousResults.delete(semanticColoringResultId); } private static _fixProvidedSemanticTokens(v: ProvidedSemanticTokens | ProvidedSemanticTokensEdits): vscode.SemanticTokens | vscode.SemanticTokensEdits { if (DocumentSemanticTokensAdapter._isSemanticTokens(v)) { if (DocumentSemanticTokensAdapter._isCorrectSemanticTokens(v)) { return v; } return new SemanticTokens(new Uint32Array(v.data), v.resultId); } else if (DocumentSemanticTokensAdapter._isSemanticTokensEdits(v)) { if (DocumentSemanticTokensAdapter._isCorrectSemanticTokensEdits(v)) { return v; } return new SemanticTokensEdits(v.edits.map(edit => new SemanticTokensEdit(edit.start, edit.deleteCount, edit.data ? new Uint32Array(edit.data) : edit.data as undefined)), v.resultId); // {{SQL CARBON EDIT}} strict-null-checks } return v; } private static _isSemanticTokens(v: ProvidedSemanticTokens | ProvidedSemanticTokensEdits): v is ProvidedSemanticTokens { return v && !!((v as ProvidedSemanticTokens).data); } private static _isCorrectSemanticTokens(v: ProvidedSemanticTokens): v is vscode.SemanticTokens { return (v.data instanceof Uint32Array); } private static _isSemanticTokensEdits(v: ProvidedSemanticTokens | ProvidedSemanticTokensEdits): v is ProvidedSemanticTokensEdits { return v && Array.isArray((v as ProvidedSemanticTokensEdits).edits); } private static _isCorrectSemanticTokensEdits(v: ProvidedSemanticTokensEdits): v is vscode.SemanticTokensEdits { for (const edit of v.edits) { if (!(edit.data instanceof Uint32Array)) { return false; } } return true; } private static _convertToEdits(previousResult: SemanticTokensPreviousResult | null | undefined, newResult: vscode.SemanticTokens | vscode.SemanticTokensEdits): vscode.SemanticTokens | vscode.SemanticTokensEdits { if (!DocumentSemanticTokensAdapter._isSemanticTokens(newResult)) { return newResult; } if (!previousResult || !previousResult.tokens) { return newResult; } const oldData = previousResult.tokens; const oldLength = oldData.length; const newData = newResult.data; const newLength = newData.length; let commonPrefixLength = 0; const maxCommonPrefixLength = Math.min(oldLength, newLength); while (commonPrefixLength < maxCommonPrefixLength && oldData[commonPrefixLength] === newData[commonPrefixLength]) { commonPrefixLength++; } if (commonPrefixLength === oldLength && commonPrefixLength === newLength) { // complete overlap! return new SemanticTokensEdits([], newResult.resultId); } let commonSuffixLength = 0; const maxCommonSuffixLength = maxCommonPrefixLength - commonPrefixLength; while (commonSuffixLength < maxCommonSuffixLength && oldData[oldLength - commonSuffixLength - 1] === newData[newLength - commonSuffixLength - 1]) { commonSuffixLength++; } return new SemanticTokensEdits([{ start: commonPrefixLength, deleteCount: (oldLength - commonPrefixLength - commonSuffixLength), data: newData.subarray(commonPrefixLength, newLength - commonSuffixLength) }], newResult.resultId); } private _send(value: vscode.SemanticTokens | vscode.SemanticTokensEdits, original: vscode.SemanticTokens | vscode.SemanticTokensEdits): VSBuffer | null { if (DocumentSemanticTokensAdapter._isSemanticTokens(value)) { const myId = this._nextResultId++; this._previousResults.set(myId, new SemanticTokensPreviousResult(value.resultId, value.data)); return encodeSemanticTokensDto({ id: myId, type: 'full', data: value.data }); } if (DocumentSemanticTokensAdapter._isSemanticTokensEdits(value)) { const myId = this._nextResultId++; if (DocumentSemanticTokensAdapter._isSemanticTokens(original)) { // store the original this._previousResults.set(myId, new SemanticTokensPreviousResult(original.resultId, original.data)); } else { this._previousResults.set(myId, new SemanticTokensPreviousResult(value.resultId)); } return encodeSemanticTokensDto({ id: myId, type: 'delta', deltas: (value.edits || []).map(edit => ({ start: edit.start, deleteCount: edit.deleteCount, data: edit.data })) }); } return null; } } export class DocumentRangeSemanticTokensAdapter { constructor( private readonly _documents: ExtHostDocuments, private readonly _provider: vscode.DocumentRangeSemanticTokensProvider, ) { } provideDocumentRangeSemanticTokens(resource: URI, range: IRange, token: CancellationToken): Promise { const doc = this._documents.getDocument(resource); return asPromise(() => this._provider.provideDocumentRangeSemanticTokens(doc, typeConvert.Range.to(range), token)).then(value => { if (!value) { return null; } return this._send(value); }); } private _send(value: vscode.SemanticTokens): VSBuffer | null { return encodeSemanticTokensDto({ id: 0, type: 'full', data: value.data }); } } class SuggestAdapter { static supportsResolving(provider: vscode.CompletionItemProvider): boolean { return typeof provider.resolveCompletionItem === 'function'; } private _cache = new Cache('CompletionItem'); private _disposables = new Map(); constructor( private readonly _documents: ExtHostDocuments, private readonly _commands: CommandsConverter, private readonly _provider: vscode.CompletionItemProvider, private readonly _apiDeprecation: IExtHostApiDeprecationService, private readonly _extension: IExtensionDescription, ) { } async provideCompletionItems(resource: URI, position: IPosition, context: modes.CompletionContext, token: CancellationToken): Promise { const doc = this._documents.getDocument(resource); const pos = typeConvert.Position.to(position); // The default insert/replace ranges. It's important to compute them // before asynchronously asking the provider for its results. See // https://github.com/microsoft/vscode/issues/83400#issuecomment-546851421 const replaceRange = doc.getWordRangeAtPosition(pos) || new Range(pos, pos); const insertRange = replaceRange.with({ end: pos }); const itemsOrList = await asPromise(() => this._provider.provideCompletionItems(doc, pos, token, typeConvert.CompletionContext.to(context))); if (!itemsOrList) { // undefined and null are valid results return undefined; } if (token.isCancellationRequested) { // cancelled -> return without further ado, esp no caching // of results as they will leak return undefined; } const list = Array.isArray(itemsOrList) ? new CompletionList(itemsOrList) : itemsOrList; // keep result for providers that support resolving const pid: number = SuggestAdapter.supportsResolving(this._provider) ? this._cache.add(list.items) : this._cache.add([]); const disposables = new DisposableStore(); this._disposables.set(pid, disposables); const completions: extHostProtocol.ISuggestDataDto[] = []; const result: extHostProtocol.ISuggestResultDto = { x: pid, [extHostProtocol.ISuggestResultDtoField.completions]: completions, [extHostProtocol.ISuggestResultDtoField.defaultRanges]: { replace: typeConvert.Range.from(replaceRange), insert: typeConvert.Range.from(insertRange) }, [extHostProtocol.ISuggestResultDtoField.isIncomplete]: list.isIncomplete || undefined }; for (let i = 0; i < list.items.length; i++) { const item = list.items[i]; // check for bad completion item first const dto = this._convertCompletionItem(item, [pid, i], insertRange, replaceRange); completions.push(dto); } return result; } async resolveCompletionItem(id: extHostProtocol.ChainedCacheId, token: CancellationToken): Promise { if (typeof this._provider.resolveCompletionItem !== 'function') { return undefined; } const item = this._cache.get(...id); if (!item) { return undefined; } const resolvedItem = await asPromise(() => this._provider.resolveCompletionItem!(item, token)); if (!resolvedItem) { return undefined; } return this._convertCompletionItem(resolvedItem, id); } releaseCompletionItems(id: number): any { this._disposables.get(id)?.dispose(); this._disposables.delete(id); this._cache.delete(id); } private _convertCompletionItem(item: vscode.CompletionItem, id: extHostProtocol.ChainedCacheId, defaultInsertRange?: vscode.Range, defaultReplaceRange?: vscode.Range): extHostProtocol.ISuggestDataDto { const disposables = this._disposables.get(id[0]); if (!disposables) { throw Error('DisposableStore is missing...'); } const result: extHostProtocol.ISuggestDataDto = { // x: id, // [extHostProtocol.ISuggestDataDtoField.label]: item.label ?? '', [extHostProtocol.ISuggestDataDtoField.label2]: item.label2, [extHostProtocol.ISuggestDataDtoField.kind]: item.kind !== undefined ? typeConvert.CompletionItemKind.from(item.kind) : undefined, [extHostProtocol.ISuggestDataDtoField.kindModifier]: item.tags && item.tags.map(typeConvert.CompletionItemTag.from), [extHostProtocol.ISuggestDataDtoField.detail]: item.detail, [extHostProtocol.ISuggestDataDtoField.documentation]: typeof item.documentation === 'undefined' ? undefined : typeConvert.MarkdownString.fromStrict(item.documentation), [extHostProtocol.ISuggestDataDtoField.sortText]: item.sortText !== item.label ? item.sortText : undefined, [extHostProtocol.ISuggestDataDtoField.filterText]: item.filterText !== item.label ? item.filterText : undefined, [extHostProtocol.ISuggestDataDtoField.preselect]: item.preselect || undefined, [extHostProtocol.ISuggestDataDtoField.insertTextRules]: item.keepWhitespace ? modes.CompletionItemInsertTextRule.KeepWhitespace : 0, [extHostProtocol.ISuggestDataDtoField.commitCharacters]: item.commitCharacters, [extHostProtocol.ISuggestDataDtoField.additionalTextEdits]: item.additionalTextEdits && item.additionalTextEdits.map(typeConvert.TextEdit.from), [extHostProtocol.ISuggestDataDtoField.command]: this._commands.toInternal(item.command, disposables), }; // 'insertText'-logic if (item.textEdit) { this._apiDeprecation.report('CompletionItem.textEdit', this._extension, `Use 'CompletionItem.insertText' and 'CompletionItem.range' instead.`); result[extHostProtocol.ISuggestDataDtoField.insertText] = item.textEdit.newText; } else if (typeof item.insertText === 'string') { result[extHostProtocol.ISuggestDataDtoField.insertText] = item.insertText; } else if (item.insertText instanceof SnippetString) { result[extHostProtocol.ISuggestDataDtoField.insertText] = item.insertText.value; result[extHostProtocol.ISuggestDataDtoField.insertTextRules]! |= modes.CompletionItemInsertTextRule.InsertAsSnippet; } // 'overwrite[Before|After]'-logic let range: vscode.Range | { inserting: vscode.Range, replacing: vscode.Range; } | undefined; if (item.textEdit) { range = item.textEdit.range; } else if (item.range) { range = item.range; } if (Range.isRange(range)) { // "old" range result[extHostProtocol.ISuggestDataDtoField.range] = typeConvert.Range.from(range); } else if (range && (!defaultInsertRange?.isEqual(range.inserting) || !defaultReplaceRange?.isEqual(range.replacing))) { // ONLY send range when it's different from the default ranges (safe bandwidth) result[extHostProtocol.ISuggestDataDtoField.range] = { insert: typeConvert.Range.from(range.inserting), replace: typeConvert.Range.from(range.replacing) }; } return result; } } class SignatureHelpAdapter { private readonly _cache = new Cache('SignatureHelp'); constructor( private readonly _documents: ExtHostDocuments, private readonly _provider: vscode.SignatureHelpProvider, ) { } provideSignatureHelp(resource: URI, position: IPosition, context: extHostProtocol.ISignatureHelpContextDto, token: CancellationToken): Promise { const doc = this._documents.getDocument(resource); const pos = typeConvert.Position.to(position); const vscodeContext = this.reviveContext(context); return asPromise(() => this._provider.provideSignatureHelp(doc, pos, token, vscodeContext)).then(value => { if (value) { const id = this._cache.add([value]); return { ...typeConvert.SignatureHelp.from(value), id }; } return undefined; }); } private reviveContext(context: extHostProtocol.ISignatureHelpContextDto): vscode.SignatureHelpContext { let activeSignatureHelp: vscode.SignatureHelp | undefined = undefined; if (context.activeSignatureHelp) { const revivedSignatureHelp = typeConvert.SignatureHelp.to(context.activeSignatureHelp); const saved = this._cache.get(context.activeSignatureHelp.id, 0); if (saved) { activeSignatureHelp = saved; activeSignatureHelp.activeSignature = revivedSignatureHelp.activeSignature; activeSignatureHelp.activeParameter = revivedSignatureHelp.activeParameter; } else { activeSignatureHelp = revivedSignatureHelp; } } return { ...context, activeSignatureHelp }; } releaseSignatureHelp(id: number): any { this._cache.delete(id); } } class LinkProviderAdapter { private _cache = new Cache('DocumentLink'); constructor( private readonly _documents: ExtHostDocuments, private readonly _provider: vscode.DocumentLinkProvider ) { } provideLinks(resource: URI, token: CancellationToken): Promise { const doc = this._documents.getDocument(resource); return asPromise(() => this._provider.provideDocumentLinks(doc, token)).then(links => { if (!Array.isArray(links) || links.length === 0) { // bad result return undefined; } if (token.isCancellationRequested) { // cancelled -> return without further ado, esp no caching // of results as they will leak return undefined; } if (typeof this._provider.resolveDocumentLink !== 'function') { // no resolve -> no caching return { links: links.map(typeConvert.DocumentLink.from) }; } else { // cache links for future resolving const pid = this._cache.add(links); const result: extHostProtocol.ILinksListDto = { links: [], id: pid }; for (let i = 0; i < links.length; i++) { const dto: extHostProtocol.ILinkDto = typeConvert.DocumentLink.from(links[i]); dto.cacheId = [pid, i]; result.links.push(dto); } return result; } }); } resolveLink(id: extHostProtocol.ChainedCacheId, token: CancellationToken): Promise { if (typeof this._provider.resolveDocumentLink !== 'function') { return Promise.resolve(undefined); } const item = this._cache.get(...id); if (!item) { return Promise.resolve(undefined); } return asPromise(() => this._provider.resolveDocumentLink!(item, token)).then(value => { return value && typeConvert.DocumentLink.from(value) || undefined; }); } releaseLinks(id: number): any { this._cache.delete(id); } } class ColorProviderAdapter { constructor( private _documents: ExtHostDocuments, private _provider: vscode.DocumentColorProvider ) { } provideColors(resource: URI, token: CancellationToken): Promise { const doc = this._documents.getDocument(resource); return asPromise(() => this._provider.provideDocumentColors(doc, token)).then(colors => { if (!Array.isArray(colors)) { return []; } const colorInfos: extHostProtocol.IRawColorInfo[] = colors.map(ci => { return { color: typeConvert.Color.from(ci.color), range: typeConvert.Range.from(ci.range) }; }); return colorInfos; }); } provideColorPresentations(resource: URI, raw: extHostProtocol.IRawColorInfo, token: CancellationToken): Promise { const document = this._documents.getDocument(resource); const range = typeConvert.Range.to(raw.range); const color = typeConvert.Color.to(raw.color); return asPromise(() => this._provider.provideColorPresentations(color, { document, range }, token)).then(value => { if (!Array.isArray(value)) { return undefined; } return value.map(typeConvert.ColorPresentation.from); }); } } class FoldingProviderAdapter { constructor( private _documents: ExtHostDocuments, private _provider: vscode.FoldingRangeProvider ) { } provideFoldingRanges(resource: URI, context: modes.FoldingContext, token: CancellationToken): Promise { const doc = this._documents.getDocument(resource); return asPromise(() => this._provider.provideFoldingRanges(doc, context, token)).then(ranges => { if (!Array.isArray(ranges)) { return undefined; } return ranges.map(typeConvert.FoldingRange.from); }); } } class SelectionRangeAdapter { constructor( private readonly _documents: ExtHostDocuments, private readonly _provider: vscode.SelectionRangeProvider, private readonly _logService: ILogService ) { } provideSelectionRanges(resource: URI, pos: IPosition[], token: CancellationToken): Promise { const document = this._documents.getDocument(resource); const positions = pos.map(typeConvert.Position.to); return asPromise(() => this._provider.provideSelectionRanges(document, positions, token)).then(allProviderRanges => { if (!isNonEmptyArray(allProviderRanges)) { return []; } if (allProviderRanges.length !== positions.length) { this._logService.warn('BAD selection ranges, provider must return ranges for each position'); return []; } const allResults: modes.SelectionRange[][] = []; for (let i = 0; i < positions.length; i++) { const oneResult: modes.SelectionRange[] = []; allResults.push(oneResult); let last: vscode.Position | vscode.Range = positions[i]; let selectionRange = allProviderRanges[i]; while (true) { if (!selectionRange.range.contains(last)) { throw new Error('INVALID selection range, must contain the previous range'); } oneResult.push(typeConvert.SelectionRange.from(selectionRange)); if (!selectionRange.parent) { break; } last = selectionRange.range; selectionRange = selectionRange.parent; } } return allResults; }); } } class CallHierarchyAdapter { private readonly _idPool = new IdGenerator(''); private readonly _cache = new Map>(); constructor( private readonly _documents: ExtHostDocuments, private readonly _provider: vscode.CallHierarchyProvider ) { } async prepareSession(uri: URI, position: IPosition, token: CancellationToken): Promise { const doc = this._documents.getDocument(uri); const pos = typeConvert.Position.to(position); const items = await this._provider.prepareCallHierarchy(doc, pos, token); if (!items) { return undefined; } const sessionId = this._idPool.nextId(); this._cache.set(sessionId, new Map()); if (Array.isArray(items)) { return items.map(item => this._cacheAndConvertItem(sessionId, item)); } else { return [this._cacheAndConvertItem(sessionId, items)]; } } async provideCallsTo(sessionId: string, itemId: string, token: CancellationToken): Promise { const item = this._itemFromCache(sessionId, itemId); if (!item) { throw new Error('missing call hierarchy item'); } const calls = await this._provider.provideCallHierarchyIncomingCalls(item, token); if (!calls) { return undefined; } return calls.map(call => { return { from: this._cacheAndConvertItem(sessionId, call.from), fromRanges: call.fromRanges.map(r => typeConvert.Range.from(r)) }; }); } async provideCallsFrom(sessionId: string, itemId: string, token: CancellationToken): Promise { const item = this._itemFromCache(sessionId, itemId); if (!item) { throw new Error('missing call hierarchy item'); } const calls = await this._provider.provideCallHierarchyOutgoingCalls(item, token); if (!calls) { return undefined; } return calls.map(call => { return { to: this._cacheAndConvertItem(sessionId, call.to), fromRanges: call.fromRanges.map(r => typeConvert.Range.from(r)) }; }); } releaseSession(sessionId: string): void { this._cache.delete(sessionId); } private _cacheAndConvertItem(sessionId: string, item: vscode.CallHierarchyItem): extHostProtocol.ICallHierarchyItemDto { const map = this._cache.get(sessionId)!; const dto: extHostProtocol.ICallHierarchyItemDto = { _sessionId: sessionId, _itemId: map.size.toString(36), name: item.name, detail: item.detail, kind: typeConvert.SymbolKind.from(item.kind), uri: item.uri, range: typeConvert.Range.from(item.range), selectionRange: typeConvert.Range.from(item.selectionRange), tags: item.tags?.map(typeConvert.SymbolTag.from) }; map.set(dto._itemId, item); return dto; } private _itemFromCache(sessionId: string, itemId: string): vscode.CallHierarchyItem | undefined { const map = this._cache.get(sessionId); return map?.get(itemId); } } type Adapter = DocumentSymbolAdapter | CodeLensAdapter | DefinitionAdapter | HoverAdapter | DocumentHighlightAdapter | ReferenceAdapter | CodeActionAdapter | DocumentFormattingAdapter | RangeFormattingAdapter | OnTypeFormattingAdapter | NavigateTypeAdapter | RenameAdapter | SuggestAdapter | SignatureHelpAdapter | LinkProviderAdapter | ImplementationAdapter | TypeDefinitionAdapter | ColorProviderAdapter | FoldingProviderAdapter | DeclarationAdapter | SelectionRangeAdapter | CallHierarchyAdapter | DocumentSemanticTokensAdapter | DocumentRangeSemanticTokensAdapter | EvaluatableExpressionAdapter | OnTypeRenameAdapter; class AdapterData { constructor( readonly adapter: Adapter, readonly extension: IExtensionDescription | undefined ) { } } export class ExtHostLanguageFeatures implements extHostProtocol.ExtHostLanguageFeaturesShape { private static _handlePool: number = 0; private readonly _uriTransformer: IURITransformer | null; private readonly _proxy: extHostProtocol.MainThreadLanguageFeaturesShape; private _documents: ExtHostDocuments; private _commands: ExtHostCommands; private _diagnostics: ExtHostDiagnostics; private _adapter = new Map(); private readonly _logService: ILogService; private readonly _apiDeprecation: IExtHostApiDeprecationService; constructor( mainContext: extHostProtocol.IMainContext, uriTransformer: IURITransformer | null, documents: ExtHostDocuments, commands: ExtHostCommands, diagnostics: ExtHostDiagnostics, logService: ILogService, apiDeprecationService: IExtHostApiDeprecationService, ) { this._uriTransformer = uriTransformer; this._proxy = mainContext.getProxy(extHostProtocol.MainContext.MainThreadLanguageFeatures); this._documents = documents; this._commands = commands; this._diagnostics = diagnostics; this._logService = logService; this._apiDeprecation = apiDeprecationService; } private _transformDocumentSelector(selector: vscode.DocumentSelector): Array { return coalesce(asArray(selector).map(sel => this._doTransformDocumentSelector(sel))); } private _doTransformDocumentSelector(selector: string | vscode.DocumentFilter): extHostProtocol.IDocumentFilterDto | undefined { if (typeof selector === 'string') { return { $serialized: true, language: selector }; } if (selector) { return { $serialized: true, language: selector.language, scheme: this._transformScheme(selector.scheme), pattern: typeof selector.pattern === 'undefined' ? undefined : typeConvert.GlobPattern.from(selector.pattern), exclusive: selector.exclusive }; } return undefined; } private _transformScheme(scheme: string | undefined): string | undefined { if (this._uriTransformer && typeof scheme === 'string') { return this._uriTransformer.transformOutgoingScheme(scheme); } return scheme; } private _createDisposable(handle: number): Disposable { return new Disposable(() => { this._adapter.delete(handle); this._proxy.$unregister(handle); }); } private _nextHandle(): number { return ExtHostLanguageFeatures._handlePool++; } private _withAdapter(handle: number, ctor: { new(...args: any[]): A; }, callback: (adapter: A, extension: IExtensionDescription | undefined) => Promise, fallbackValue: R): Promise { const data = this._adapter.get(handle); if (!data) { return Promise.resolve(fallbackValue); } if (data.adapter instanceof ctor) { let t1: number; if (data.extension) { t1 = Date.now(); this._logService.trace(`[${data.extension.identifier.value}] INVOKE provider '${(ctor as any).name}'`); } const p = callback(data.adapter, data.extension); const extension = data.extension; if (extension) { Promise.resolve(p).then( () => this._logService.trace(`[${extension.identifier.value}] provider DONE after ${Date.now() - t1}ms`), err => { this._logService.error(`[${extension.identifier.value}] provider FAILED`); this._logService.error(err); } ); } return p; } return Promise.reject(new Error('no adapter found')); } private _addNewAdapter(adapter: Adapter, extension: IExtensionDescription | undefined): number { const handle = this._nextHandle(); this._adapter.set(handle, new AdapterData(adapter, extension)); return handle; } private static _extLabel(ext: IExtensionDescription): string { return ext.displayName || ext.name; } // --- outline registerDocumentSymbolProvider(extension: IExtensionDescription, selector: vscode.DocumentSelector, provider: vscode.DocumentSymbolProvider, metadata?: vscode.DocumentSymbolProviderMetadata): vscode.Disposable { const handle = this._addNewAdapter(new DocumentSymbolAdapter(this._documents, provider), extension); const displayName = (metadata && metadata.label) || ExtHostLanguageFeatures._extLabel(extension); this._proxy.$registerDocumentSymbolProvider(handle, this._transformDocumentSelector(selector), displayName); return this._createDisposable(handle); } $provideDocumentSymbols(handle: number, resource: UriComponents, token: CancellationToken): Promise { return this._withAdapter(handle, DocumentSymbolAdapter, adapter => adapter.provideDocumentSymbols(URI.revive(resource), token), undefined); } // --- code lens registerCodeLensProvider(extension: IExtensionDescription, selector: vscode.DocumentSelector, provider: vscode.CodeLensProvider): vscode.Disposable { const handle = this._nextHandle(); const eventHandle = typeof provider.onDidChangeCodeLenses === 'function' ? this._nextHandle() : undefined; this._adapter.set(handle, new AdapterData(new CodeLensAdapter(this._documents, this._commands.converter, provider), extension)); this._proxy.$registerCodeLensSupport(handle, this._transformDocumentSelector(selector), eventHandle); let result = this._createDisposable(handle); if (eventHandle !== undefined) { const subscription = provider.onDidChangeCodeLenses!(_ => this._proxy.$emitCodeLensEvent(eventHandle)); result = Disposable.from(result, subscription); } return result; } $provideCodeLenses(handle: number, resource: UriComponents, token: CancellationToken): Promise { return this._withAdapter(handle, CodeLensAdapter, adapter => adapter.provideCodeLenses(URI.revive(resource), token), undefined); } $resolveCodeLens(handle: number, symbol: extHostProtocol.ICodeLensDto, token: CancellationToken): Promise { return this._withAdapter(handle, CodeLensAdapter, adapter => adapter.resolveCodeLens(symbol, token), undefined); } $releaseCodeLenses(handle: number, cacheId: number): void { this._withAdapter(handle, CodeLensAdapter, adapter => Promise.resolve(adapter.releaseCodeLenses(cacheId)), undefined); } // --- declaration registerDefinitionProvider(extension: IExtensionDescription, selector: vscode.DocumentSelector, provider: vscode.DefinitionProvider): vscode.Disposable { const handle = this._addNewAdapter(new DefinitionAdapter(this._documents, provider), extension); this._proxy.$registerDefinitionSupport(handle, this._transformDocumentSelector(selector)); return this._createDisposable(handle); } $provideDefinition(handle: number, resource: UriComponents, position: IPosition, token: CancellationToken): Promise { return this._withAdapter(handle, DefinitionAdapter, adapter => adapter.provideDefinition(URI.revive(resource), position, token), []); } registerDeclarationProvider(extension: IExtensionDescription, selector: vscode.DocumentSelector, provider: vscode.DeclarationProvider): vscode.Disposable { const handle = this._addNewAdapter(new DeclarationAdapter(this._documents, provider), extension); this._proxy.$registerDeclarationSupport(handle, this._transformDocumentSelector(selector)); return this._createDisposable(handle); } $provideDeclaration(handle: number, resource: UriComponents, position: IPosition, token: CancellationToken): Promise { return this._withAdapter(handle, DeclarationAdapter, adapter => adapter.provideDeclaration(URI.revive(resource), position, token), []); } registerImplementationProvider(extension: IExtensionDescription, selector: vscode.DocumentSelector, provider: vscode.ImplementationProvider): vscode.Disposable { const handle = this._addNewAdapter(new ImplementationAdapter(this._documents, provider), extension); this._proxy.$registerImplementationSupport(handle, this._transformDocumentSelector(selector)); return this._createDisposable(handle); } $provideImplementation(handle: number, resource: UriComponents, position: IPosition, token: CancellationToken): Promise { return this._withAdapter(handle, ImplementationAdapter, adapter => adapter.provideImplementation(URI.revive(resource), position, token), []); } registerTypeDefinitionProvider(extension: IExtensionDescription, selector: vscode.DocumentSelector, provider: vscode.TypeDefinitionProvider): vscode.Disposable { const handle = this._addNewAdapter(new TypeDefinitionAdapter(this._documents, provider), extension); this._proxy.$registerTypeDefinitionSupport(handle, this._transformDocumentSelector(selector)); return this._createDisposable(handle); } $provideTypeDefinition(handle: number, resource: UriComponents, position: IPosition, token: CancellationToken): Promise { return this._withAdapter(handle, TypeDefinitionAdapter, adapter => adapter.provideTypeDefinition(URI.revive(resource), position, token), []); } // --- extra info registerHoverProvider(extension: IExtensionDescription, selector: vscode.DocumentSelector, provider: vscode.HoverProvider, extensionId?: ExtensionIdentifier): vscode.Disposable { const handle = this._addNewAdapter(new HoverAdapter(this._documents, provider), extension); this._proxy.$registerHoverProvider(handle, this._transformDocumentSelector(selector)); return this._createDisposable(handle); } $provideHover(handle: number, resource: UriComponents, position: IPosition, token: CancellationToken): Promise { return this._withAdapter(handle, HoverAdapter, adapter => adapter.provideHover(URI.revive(resource), position, token), undefined); } // --- debug hover registerEvaluatableExpressionProvider(extension: IExtensionDescription, selector: vscode.DocumentSelector, provider: vscode.EvaluatableExpressionProvider, extensionId?: ExtensionIdentifier): vscode.Disposable { const handle = this._addNewAdapter(new EvaluatableExpressionAdapter(this._documents, provider), extension); this._proxy.$registerEvaluatableExpressionProvider(handle, this._transformDocumentSelector(selector)); return this._createDisposable(handle); } $provideEvaluatableExpression(handle: number, resource: UriComponents, position: IPosition, token: CancellationToken): Promise { return this._withAdapter(handle, EvaluatableExpressionAdapter, adapter => adapter.provideEvaluatableExpression(URI.revive(resource), position, token), undefined); } // --- occurrences registerDocumentHighlightProvider(extension: IExtensionDescription, selector: vscode.DocumentSelector, provider: vscode.DocumentHighlightProvider): vscode.Disposable { const handle = this._addNewAdapter(new DocumentHighlightAdapter(this._documents, provider), extension); this._proxy.$registerDocumentHighlightProvider(handle, this._transformDocumentSelector(selector)); return this._createDisposable(handle); } $provideDocumentHighlights(handle: number, resource: UriComponents, position: IPosition, token: CancellationToken): Promise { return this._withAdapter(handle, DocumentHighlightAdapter, adapter => adapter.provideDocumentHighlights(URI.revive(resource), position, token), undefined); } // --- on type rename registerOnTypeRenameProvider(extension: IExtensionDescription, selector: vscode.DocumentSelector, provider: vscode.OnTypeRenameProvider, wordPattern?: RegExp): vscode.Disposable { const handle = this._addNewAdapter(new OnTypeRenameAdapter(this._documents, provider), extension); const serializedWordPattern = wordPattern ? ExtHostLanguageFeatures._serializeRegExp(wordPattern) : undefined; this._proxy.$registerOnTypeRenameProvider(handle, this._transformDocumentSelector(selector), serializedWordPattern); return this._createDisposable(handle); } $provideOnTypeRenameRanges(handle: number, resource: UriComponents, position: IPosition, token: CancellationToken): Promise<{ ranges: IRange[]; wordPattern?: extHostProtocol.IRegExpDto; } | undefined> { return this._withAdapter(handle, OnTypeRenameAdapter, async adapter => { const res = await adapter.provideOnTypeRenameRanges(URI.revive(resource), position, token); if (res) { return { ranges: res.ranges, wordPattern: res.wordPattern ? ExtHostLanguageFeatures._serializeRegExp(res.wordPattern) : undefined }; } return undefined; }, undefined); } // --- references registerReferenceProvider(extension: IExtensionDescription, selector: vscode.DocumentSelector, provider: vscode.ReferenceProvider): vscode.Disposable { const handle = this._addNewAdapter(new ReferenceAdapter(this._documents, provider), extension); this._proxy.$registerReferenceSupport(handle, this._transformDocumentSelector(selector)); return this._createDisposable(handle); } $provideReferences(handle: number, resource: UriComponents, position: IPosition, context: modes.ReferenceContext, token: CancellationToken): Promise { return this._withAdapter(handle, ReferenceAdapter, adapter => adapter.provideReferences(URI.revive(resource), position, context, token), undefined); } // --- quick fix registerCodeActionProvider(extension: IExtensionDescription, selector: vscode.DocumentSelector, provider: vscode.CodeActionProvider, metadata?: vscode.CodeActionProviderMetadata): vscode.Disposable { const store = new DisposableStore(); const handle = this._addNewAdapter(new CodeActionAdapter(this._documents, this._commands.converter, this._diagnostics, provider, this._logService, extension, this._apiDeprecation), extension); this._proxy.$registerQuickFixSupport(handle, this._transformDocumentSelector(selector), { providedKinds: metadata?.providedCodeActionKinds?.map(kind => kind.value), documentation: metadata?.documentation?.map(x => ({ kind: x.kind.value, command: this._commands.converter.toInternal(x.command, store), })) }, ExtHostLanguageFeatures._extLabel(extension)); store.add(this._createDisposable(handle)); return store; } $provideCodeActions(handle: number, resource: UriComponents, rangeOrSelection: IRange | ISelection, context: modes.CodeActionContext, token: CancellationToken): Promise { return this._withAdapter(handle, CodeActionAdapter, adapter => adapter.provideCodeActions(URI.revive(resource), rangeOrSelection, context, token), undefined); } $releaseCodeActions(handle: number, cacheId: number): void { this._withAdapter(handle, CodeActionAdapter, adapter => Promise.resolve(adapter.releaseCodeActions(cacheId)), undefined); } // --- formatting registerDocumentFormattingEditProvider(extension: IExtensionDescription, selector: vscode.DocumentSelector, provider: vscode.DocumentFormattingEditProvider): vscode.Disposable { const handle = this._addNewAdapter(new DocumentFormattingAdapter(this._documents, provider), extension); this._proxy.$registerDocumentFormattingSupport(handle, this._transformDocumentSelector(selector), extension.identifier, extension.displayName || extension.name); return this._createDisposable(handle); } $provideDocumentFormattingEdits(handle: number, resource: UriComponents, options: modes.FormattingOptions, token: CancellationToken): Promise { return this._withAdapter(handle, DocumentFormattingAdapter, adapter => adapter.provideDocumentFormattingEdits(URI.revive(resource), options, token), undefined); } registerDocumentRangeFormattingEditProvider(extension: IExtensionDescription, selector: vscode.DocumentSelector, provider: vscode.DocumentRangeFormattingEditProvider): vscode.Disposable { const handle = this._addNewAdapter(new RangeFormattingAdapter(this._documents, provider), extension); this._proxy.$registerRangeFormattingSupport(handle, this._transformDocumentSelector(selector), extension.identifier, extension.displayName || extension.name); return this._createDisposable(handle); } $provideDocumentRangeFormattingEdits(handle: number, resource: UriComponents, range: IRange, options: modes.FormattingOptions, token: CancellationToken): Promise { return this._withAdapter(handle, RangeFormattingAdapter, adapter => adapter.provideDocumentRangeFormattingEdits(URI.revive(resource), range, options, token), undefined); } registerOnTypeFormattingEditProvider(extension: IExtensionDescription, selector: vscode.DocumentSelector, provider: vscode.OnTypeFormattingEditProvider, triggerCharacters: string[]): vscode.Disposable { const handle = this._addNewAdapter(new OnTypeFormattingAdapter(this._documents, provider), extension); this._proxy.$registerOnTypeFormattingSupport(handle, this._transformDocumentSelector(selector), triggerCharacters, extension.identifier); return this._createDisposable(handle); } $provideOnTypeFormattingEdits(handle: number, resource: UriComponents, position: IPosition, ch: string, options: modes.FormattingOptions, token: CancellationToken): Promise { return this._withAdapter(handle, OnTypeFormattingAdapter, adapter => adapter.provideOnTypeFormattingEdits(URI.revive(resource), position, ch, options, token), undefined); } // --- navigate types registerWorkspaceSymbolProvider(extension: IExtensionDescription, provider: vscode.WorkspaceSymbolProvider): vscode.Disposable { const handle = this._addNewAdapter(new NavigateTypeAdapter(provider, this._logService), extension); this._proxy.$registerNavigateTypeSupport(handle); return this._createDisposable(handle); } $provideWorkspaceSymbols(handle: number, search: string, token: CancellationToken): Promise { return this._withAdapter(handle, NavigateTypeAdapter, adapter => adapter.provideWorkspaceSymbols(search, token), { symbols: [] }); } $resolveWorkspaceSymbol(handle: number, symbol: extHostProtocol.IWorkspaceSymbolDto, token: CancellationToken): Promise { return this._withAdapter(handle, NavigateTypeAdapter, adapter => adapter.resolveWorkspaceSymbol(symbol, token), undefined); } $releaseWorkspaceSymbols(handle: number, id: number): void { this._withAdapter(handle, NavigateTypeAdapter, adapter => adapter.releaseWorkspaceSymbols(id), undefined); } // --- rename registerRenameProvider(extension: IExtensionDescription, selector: vscode.DocumentSelector, provider: vscode.RenameProvider): vscode.Disposable { const handle = this._addNewAdapter(new RenameAdapter(this._documents, provider, this._logService), extension); this._proxy.$registerRenameSupport(handle, this._transformDocumentSelector(selector), RenameAdapter.supportsResolving(provider)); return this._createDisposable(handle); } $provideRenameEdits(handle: number, resource: UriComponents, position: IPosition, newName: string, token: CancellationToken): Promise { return this._withAdapter(handle, RenameAdapter, adapter => adapter.provideRenameEdits(URI.revive(resource), position, newName, token), undefined); } $resolveRenameLocation(handle: number, resource: URI, position: IPosition, token: CancellationToken): Promise { return this._withAdapter(handle, RenameAdapter, adapter => adapter.resolveRenameLocation(URI.revive(resource), position, token), undefined); } //#region semantic coloring registerDocumentSemanticTokensProvider(extension: IExtensionDescription, selector: vscode.DocumentSelector, provider: vscode.DocumentSemanticTokensProvider, legend: vscode.SemanticTokensLegend): vscode.Disposable { const handle = this._nextHandle(); const eventHandle = (typeof provider.onDidChangeSemanticTokens === 'function' ? this._nextHandle() : undefined); this._adapter.set(handle, new AdapterData(new DocumentSemanticTokensAdapter(this._documents, provider), extension)); this._proxy.$registerDocumentSemanticTokensProvider(handle, this._transformDocumentSelector(selector), legend, eventHandle); let result = this._createDisposable(handle); if (eventHandle) { const subscription = provider.onDidChangeSemanticTokens!(_ => this._proxy.$emitDocumentSemanticTokensEvent(eventHandle)); result = Disposable.from(result, subscription); } return result; } $provideDocumentSemanticTokens(handle: number, resource: UriComponents, previousResultId: number, token: CancellationToken): Promise { return this._withAdapter(handle, DocumentSemanticTokensAdapter, adapter => adapter.provideDocumentSemanticTokens(URI.revive(resource), previousResultId, token), null); } $releaseDocumentSemanticTokens(handle: number, semanticColoringResultId: number): void { this._withAdapter(handle, DocumentSemanticTokensAdapter, adapter => adapter.releaseDocumentSemanticColoring(semanticColoringResultId), undefined); } registerDocumentRangeSemanticTokensProvider(extension: IExtensionDescription, selector: vscode.DocumentSelector, provider: vscode.DocumentRangeSemanticTokensProvider, legend: vscode.SemanticTokensLegend): vscode.Disposable { const handle = this._addNewAdapter(new DocumentRangeSemanticTokensAdapter(this._documents, provider), extension); this._proxy.$registerDocumentRangeSemanticTokensProvider(handle, this._transformDocumentSelector(selector), legend); return this._createDisposable(handle); } $provideDocumentRangeSemanticTokens(handle: number, resource: UriComponents, range: IRange, token: CancellationToken): Promise { return this._withAdapter(handle, DocumentRangeSemanticTokensAdapter, adapter => adapter.provideDocumentRangeSemanticTokens(URI.revive(resource), range, token), null); } //#endregion // --- suggestion registerCompletionItemProvider(extension: IExtensionDescription, selector: vscode.DocumentSelector, provider: vscode.CompletionItemProvider, triggerCharacters: string[]): vscode.Disposable { const handle = this._addNewAdapter(new SuggestAdapter(this._documents, this._commands.converter, provider, this._apiDeprecation, extension), extension); this._proxy.$registerSuggestSupport(handle, this._transformDocumentSelector(selector), triggerCharacters, SuggestAdapter.supportsResolving(provider), extension.identifier); return this._createDisposable(handle); } $provideCompletionItems(handle: number, resource: UriComponents, position: IPosition, context: modes.CompletionContext, token: CancellationToken): Promise { return this._withAdapter(handle, SuggestAdapter, adapter => adapter.provideCompletionItems(URI.revive(resource), position, context, token), undefined); } $resolveCompletionItem(handle: number, id: extHostProtocol.ChainedCacheId, token: CancellationToken): Promise { return this._withAdapter(handle, SuggestAdapter, adapter => adapter.resolveCompletionItem(id, token), undefined); } $releaseCompletionItems(handle: number, id: number): void { this._withAdapter(handle, SuggestAdapter, adapter => adapter.releaseCompletionItems(id), undefined); } // --- parameter hints registerSignatureHelpProvider(extension: IExtensionDescription, selector: vscode.DocumentSelector, provider: vscode.SignatureHelpProvider, metadataOrTriggerChars: string[] | vscode.SignatureHelpProviderMetadata): vscode.Disposable { const metadata: extHostProtocol.ISignatureHelpProviderMetadataDto | undefined = Array.isArray(metadataOrTriggerChars) ? { triggerCharacters: metadataOrTriggerChars, retriggerCharacters: [] } : metadataOrTriggerChars; const handle = this._addNewAdapter(new SignatureHelpAdapter(this._documents, provider), extension); this._proxy.$registerSignatureHelpProvider(handle, this._transformDocumentSelector(selector), metadata); return this._createDisposable(handle); } $provideSignatureHelp(handle: number, resource: UriComponents, position: IPosition, context: extHostProtocol.ISignatureHelpContextDto, token: CancellationToken): Promise { return this._withAdapter(handle, SignatureHelpAdapter, adapter => adapter.provideSignatureHelp(URI.revive(resource), position, context, token), undefined); } $releaseSignatureHelp(handle: number, id: number): void { this._withAdapter(handle, SignatureHelpAdapter, adapter => adapter.releaseSignatureHelp(id), undefined); } // --- links registerDocumentLinkProvider(extension: IExtensionDescription | undefined, selector: vscode.DocumentSelector, provider: vscode.DocumentLinkProvider): vscode.Disposable { const handle = this._addNewAdapter(new LinkProviderAdapter(this._documents, provider), extension); this._proxy.$registerDocumentLinkProvider(handle, this._transformDocumentSelector(selector), typeof provider.resolveDocumentLink === 'function'); return this._createDisposable(handle); } $provideDocumentLinks(handle: number, resource: UriComponents, token: CancellationToken): Promise { return this._withAdapter(handle, LinkProviderAdapter, adapter => adapter.provideLinks(URI.revive(resource), token), undefined); } $resolveDocumentLink(handle: number, id: extHostProtocol.ChainedCacheId, token: CancellationToken): Promise { return this._withAdapter(handle, LinkProviderAdapter, adapter => adapter.resolveLink(id, token), undefined); } $releaseDocumentLinks(handle: number, id: number): void { this._withAdapter(handle, LinkProviderAdapter, adapter => adapter.releaseLinks(id), undefined); } registerColorProvider(extension: IExtensionDescription, selector: vscode.DocumentSelector, provider: vscode.DocumentColorProvider): vscode.Disposable { const handle = this._addNewAdapter(new ColorProviderAdapter(this._documents, provider), extension); this._proxy.$registerDocumentColorProvider(handle, this._transformDocumentSelector(selector)); return this._createDisposable(handle); } $provideDocumentColors(handle: number, resource: UriComponents, token: CancellationToken): Promise { return this._withAdapter(handle, ColorProviderAdapter, adapter => adapter.provideColors(URI.revive(resource), token), []); } $provideColorPresentations(handle: number, resource: UriComponents, colorInfo: extHostProtocol.IRawColorInfo, token: CancellationToken): Promise { return this._withAdapter(handle, ColorProviderAdapter, adapter => adapter.provideColorPresentations(URI.revive(resource), colorInfo, token), undefined); } registerFoldingRangeProvider(extension: IExtensionDescription, selector: vscode.DocumentSelector, provider: vscode.FoldingRangeProvider): vscode.Disposable { const handle = this._addNewAdapter(new FoldingProviderAdapter(this._documents, provider), extension); this._proxy.$registerFoldingRangeProvider(handle, this._transformDocumentSelector(selector)); return this._createDisposable(handle); } $provideFoldingRanges(handle: number, resource: UriComponents, context: vscode.FoldingContext, token: CancellationToken): Promise { return this._withAdapter(handle, FoldingProviderAdapter, adapter => adapter.provideFoldingRanges(URI.revive(resource), context, token), undefined); } // --- smart select registerSelectionRangeProvider(extension: IExtensionDescription, selector: vscode.DocumentSelector, provider: vscode.SelectionRangeProvider): vscode.Disposable { const handle = this._addNewAdapter(new SelectionRangeAdapter(this._documents, provider, this._logService), extension); this._proxy.$registerSelectionRangeProvider(handle, this._transformDocumentSelector(selector)); return this._createDisposable(handle); } $provideSelectionRanges(handle: number, resource: UriComponents, positions: IPosition[], token: CancellationToken): Promise { return this._withAdapter(handle, SelectionRangeAdapter, adapter => adapter.provideSelectionRanges(URI.revive(resource), positions, token), []); } // --- call hierarchy registerCallHierarchyProvider(extension: IExtensionDescription, selector: vscode.DocumentSelector, provider: vscode.CallHierarchyProvider): vscode.Disposable { const handle = this._addNewAdapter(new CallHierarchyAdapter(this._documents, provider), extension); this._proxy.$registerCallHierarchyProvider(handle, this._transformDocumentSelector(selector)); return this._createDisposable(handle); } $prepareCallHierarchy(handle: number, resource: UriComponents, position: IPosition, token: CancellationToken): Promise { return this._withAdapter(handle, CallHierarchyAdapter, adapter => Promise.resolve(adapter.prepareSession(URI.revive(resource), position, token)), undefined); } $provideCallHierarchyIncomingCalls(handle: number, sessionId: string, itemId: string, token: CancellationToken): Promise { return this._withAdapter(handle, CallHierarchyAdapter, adapter => adapter.provideCallsTo(sessionId, itemId, token), undefined); } $provideCallHierarchyOutgoingCalls(handle: number, sessionId: string, itemId: string, token: CancellationToken): Promise { return this._withAdapter(handle, CallHierarchyAdapter, adapter => adapter.provideCallsFrom(sessionId, itemId, token), undefined); } $releaseCallHierarchy(handle: number, sessionId: string): void { this._withAdapter(handle, CallHierarchyAdapter, adapter => Promise.resolve(adapter.releaseSession(sessionId)), undefined); } // --- configuration private static _serializeRegExp(regExp: RegExp): extHostProtocol.IRegExpDto { return { pattern: regExp.source, flags: regExpFlags(regExp), }; } private static _serializeIndentationRule(indentationRule: vscode.IndentationRule): extHostProtocol.IIndentationRuleDto { return { decreaseIndentPattern: ExtHostLanguageFeatures._serializeRegExp(indentationRule.decreaseIndentPattern), increaseIndentPattern: ExtHostLanguageFeatures._serializeRegExp(indentationRule.increaseIndentPattern), indentNextLinePattern: indentationRule.indentNextLinePattern ? ExtHostLanguageFeatures._serializeRegExp(indentationRule.indentNextLinePattern) : undefined, unIndentedLinePattern: indentationRule.unIndentedLinePattern ? ExtHostLanguageFeatures._serializeRegExp(indentationRule.unIndentedLinePattern) : undefined, }; } private static _serializeOnEnterRule(onEnterRule: vscode.OnEnterRule): extHostProtocol.IOnEnterRuleDto { return { beforeText: ExtHostLanguageFeatures._serializeRegExp(onEnterRule.beforeText), afterText: onEnterRule.afterText ? ExtHostLanguageFeatures._serializeRegExp(onEnterRule.afterText) : undefined, oneLineAboveText: onEnterRule.oneLineAboveText ? ExtHostLanguageFeatures._serializeRegExp(onEnterRule.oneLineAboveText) : undefined, action: onEnterRule.action }; } private static _serializeOnEnterRules(onEnterRules: vscode.OnEnterRule[]): extHostProtocol.IOnEnterRuleDto[] { return onEnterRules.map(ExtHostLanguageFeatures._serializeOnEnterRule); } setLanguageConfiguration(extension: IExtensionDescription, languageId: string, configuration: vscode.LanguageConfiguration): vscode.Disposable { let { wordPattern } = configuration; // check for a valid word pattern if (wordPattern && regExpLeadsToEndlessLoop(wordPattern)) { throw new Error(`Invalid language configuration: wordPattern '${wordPattern}' is not allowed to match the empty string.`); } // word definition if (wordPattern) { this._documents.setWordDefinitionFor(languageId, wordPattern); } else { this._documents.setWordDefinitionFor(languageId, undefined); } if (configuration.__electricCharacterSupport) { this._apiDeprecation.report('LanguageConfiguration.__electricCharacterSupport', extension, `Do not use.`); } if (configuration.__characterPairSupport) { this._apiDeprecation.report('LanguageConfiguration.__characterPairSupport', extension, `Do not use.`); } const handle = this._nextHandle(); const serializedConfiguration: extHostProtocol.ILanguageConfigurationDto = { comments: configuration.comments, brackets: configuration.brackets, wordPattern: configuration.wordPattern ? ExtHostLanguageFeatures._serializeRegExp(configuration.wordPattern) : undefined, indentationRules: configuration.indentationRules ? ExtHostLanguageFeatures._serializeIndentationRule(configuration.indentationRules) : undefined, onEnterRules: configuration.onEnterRules ? ExtHostLanguageFeatures._serializeOnEnterRules(configuration.onEnterRules) : undefined, __electricCharacterSupport: configuration.__electricCharacterSupport, __characterPairSupport: configuration.__characterPairSupport, }; this._proxy.$setLanguageConfiguration(handle, languageId, serializedConfiguration); return this._createDisposable(handle); } $setWordDefinitions(wordDefinitions: extHostProtocol.ILanguageWordDefinitionDto[]): void { for (const wordDefinition of wordDefinitions) { this._documents.setWordDefinitionFor(wordDefinition.languageId, new RegExp(wordDefinition.regexSource, wordDefinition.regexFlags)); } } }