"use strict"; /* -------------------------------------------------------------------------------------------- * Copyright (c) Microsoft Corporation. All rights reserved. * Licensed under the MIT License. See License.txt in the project root for license information. * ------------------------------------------------------------------------------------------ */ /// Object.defineProperty(exports, "__esModule", { value: true }); exports.createConverter = void 0; const code = require("vscode"); const ls = require("vscode-languageserver-protocol"); const Is = require("./utils/is"); const protocolCompletionItem_1 = require("./protocolCompletionItem"); const protocolCodeLens_1 = require("./protocolCodeLens"); const protocolDocumentLink_1 = require("./protocolDocumentLink"); const protocolCodeAction_1 = require("./protocolCodeAction"); const protocolDiagnostic_1 = require("./protocolDiagnostic"); const protocolCallHierarchyItem_1 = require("./protocolCallHierarchyItem"); const vscode_languageserver_protocol_1 = require("vscode-languageserver-protocol"); var CodeBlock; (function (CodeBlock) { function is(value) { let candidate = value; return candidate && Is.string(candidate.language) && Is.string(candidate.value); } CodeBlock.is = is; })(CodeBlock || (CodeBlock = {})); function createConverter(uriConverter, trustMarkdown) { const nullConverter = (value) => code.Uri.parse(value); const _uriConverter = uriConverter || nullConverter; function asUri(value) { return _uriConverter(value); } function asDiagnostics(diagnostics) { return diagnostics.map(asDiagnostic); } function asDiagnostic(diagnostic) { let result = new protocolDiagnostic_1.ProtocolDiagnostic(asRange(diagnostic.range), diagnostic.message, asDiagnosticSeverity(diagnostic.severity), diagnostic.data); if (diagnostic.code !== undefined) { if (ls.CodeDescription.is(diagnostic.codeDescription)) { result.code = { value: diagnostic.code, target: asUri(diagnostic.codeDescription.href) }; } else if (protocolDiagnostic_1.DiagnosticCode.is(diagnostic.code)) { result.hasDiagnosticCode = true; result.code = { value: diagnostic.code.value, target: asUri(diagnostic.code.target) }; } else { result.code = diagnostic.code; } } if (diagnostic.source) { result.source = diagnostic.source; } if (diagnostic.relatedInformation) { result.relatedInformation = asRelatedInformation(diagnostic.relatedInformation); } if (Array.isArray(diagnostic.tags)) { result.tags = asDiagnosticTags(diagnostic.tags); } return result; } function asRelatedInformation(relatedInformation) { return relatedInformation.map(asDiagnosticRelatedInformation); } function asDiagnosticRelatedInformation(information) { return new code.DiagnosticRelatedInformation(asLocation(information.location), information.message); } function asDiagnosticTags(tags) { if (!tags) { return undefined; } let result = []; for (let tag of tags) { let converted = asDiagnosticTag(tag); if (converted !== undefined) { result.push(converted); } } return result.length > 0 ? result : undefined; } function asDiagnosticTag(tag) { switch (tag) { case ls.DiagnosticTag.Unnecessary: return code.DiagnosticTag.Unnecessary; case ls.DiagnosticTag.Deprecated: return code.DiagnosticTag.Deprecated; default: return undefined; } } function asPosition(value) { if (!value) { return undefined; } return new code.Position(value.line, value.character); } function asRange(value) { if (!value) { return undefined; } return new code.Range(asPosition(value.start), asPosition(value.end)); } function asRanges(value) { return value.map(value => asRange(value)); } function asDiagnosticSeverity(value) { if (value === undefined || value === null) { return code.DiagnosticSeverity.Error; } switch (value) { case ls.DiagnosticSeverity.Error: return code.DiagnosticSeverity.Error; case ls.DiagnosticSeverity.Warning: return code.DiagnosticSeverity.Warning; case ls.DiagnosticSeverity.Information: return code.DiagnosticSeverity.Information; case ls.DiagnosticSeverity.Hint: return code.DiagnosticSeverity.Hint; } return code.DiagnosticSeverity.Error; } function asHoverContent(value) { if (Is.string(value)) { return asMarkdownString(value); } else if (CodeBlock.is(value)) { let result = asMarkdownString(); return result.appendCodeblock(value.value, value.language); } else if (Array.isArray(value)) { let result = []; for (let element of value) { let item = asMarkdownString(); if (CodeBlock.is(element)) { item.appendCodeblock(element.value, element.language); } else { item.appendMarkdown(element); } result.push(item); } return result; } else { let result; switch (value.kind) { case ls.MarkupKind.Markdown: return asMarkdownString(value.value); case ls.MarkupKind.PlainText: result = asMarkdownString(); result.appendText(value.value); return result; default: result = asMarkdownString(); result.appendText(`Unsupported Markup content received. Kind is: ${value.kind}`); return result; } } } function asDocumentation(value) { if (Is.string(value)) { return value; } else { switch (value.kind) { case ls.MarkupKind.Markdown: return asMarkdownString(value.value); case ls.MarkupKind.PlainText: return value.value; default: return `Unsupported Markup content received. Kind is: ${value.kind}`; } } } function asMarkdownString(value) { const result = new code.MarkdownString(value); if (trustMarkdown === true) { result.isTrusted = trustMarkdown; } return result; } function asHover(hover) { if (!hover) { return undefined; } return new code.Hover(asHoverContent(hover.contents), asRange(hover.range)); } function asCompletionResult(result) { if (!result) { return undefined; } if (Array.isArray(result)) { let items = result; return items.map(asCompletionItem); } let list = result; return new code.CompletionList(list.items.map(asCompletionItem), list.isIncomplete); } function asCompletionItemKind(value) { // Protocol item kind is 1 based, codes item kind is zero based. if (ls.CompletionItemKind.Text <= value && value <= ls.CompletionItemKind.TypeParameter) { return [value - 1, undefined]; } return [code.CompletionItemKind.Text, value]; } function asCompletionItemTag(tag) { switch (tag) { case ls.CompletionItemTag.Deprecated: return code.CompletionItemTag.Deprecated; } return undefined; } function asCompletionItemTags(tags) { if (tags === undefined || tags === null) { return []; } const result = []; for (let tag of tags) { const converted = asCompletionItemTag(tag); if (converted !== undefined) { result.push(converted); } } return result; } function asCompletionItem(item) { let tags = asCompletionItemTags(item.tags); let result = new protocolCompletionItem_1.default(item.label); if (item.detail) { result.detail = item.detail; } if (item.documentation) { result.documentation = asDocumentation(item.documentation); result.documentationFormat = Is.string(item.documentation) ? '$string' : item.documentation.kind; } if (item.filterText) { result.filterText = item.filterText; } let insertText = asCompletionInsertText(item); if (insertText) { result.insertText = insertText.text; result.range = insertText.range; result.fromEdit = insertText.fromEdit; } if (Is.number(item.kind)) { let [itemKind, original] = asCompletionItemKind(item.kind); result.kind = itemKind; if (original) { result.originalItemKind = original; } } if (item.sortText) { result.sortText = item.sortText; } if (item.additionalTextEdits) { result.additionalTextEdits = asTextEdits(item.additionalTextEdits); } if (Is.stringArray(item.commitCharacters)) { result.commitCharacters = item.commitCharacters.slice(); } if (item.command) { result.command = asCommand(item.command); } if (item.deprecated === true || item.deprecated === false) { result.deprecated = item.deprecated; if (item.deprecated === true) { tags.push(code.CompletionItemTag.Deprecated); } } if (item.preselect === true || item.preselect === false) { result.preselect = item.preselect; } if (item.data !== undefined) { result.data = item.data; } if (tags.length > 0) { result.tags = tags; } if (item.insertTextMode !== undefined) { result.insertTextMode = item.insertTextMode; if (item.insertTextMode === vscode_languageserver_protocol_1.InsertTextMode.asIs) { result.keepWhitespace = true; } } return result; } function asCompletionInsertText(item) { if (item.textEdit) { if (item.insertTextFormat === ls.InsertTextFormat.Snippet) { return { text: new code.SnippetString(item.textEdit.newText), range: asCompletionRange(item.textEdit), fromEdit: true }; } else { return { text: item.textEdit.newText, range: asCompletionRange(item.textEdit), fromEdit: true }; } } else if (item.insertText) { if (item.insertTextFormat === ls.InsertTextFormat.Snippet) { return { text: new code.SnippetString(item.insertText), fromEdit: false }; } else { return { text: item.insertText, fromEdit: false }; } } else { return undefined; } } function asCompletionRange(value) { if (ls.InsertReplaceEdit.is(value)) { return { inserting: asRange(value.insert), replacing: asRange(value.replace) }; } else { return asRange(value.range); } } function asTextEdit(edit) { if (!edit) { return undefined; } return new code.TextEdit(asRange(edit.range), edit.newText); } function asTextEdits(items) { if (!items) { return undefined; } return items.map(asTextEdit); } function asSignatureHelp(item) { if (!item) { return undefined; } let result = new code.SignatureHelp(); if (Is.number(item.activeSignature)) { result.activeSignature = item.activeSignature; } else { // activeSignature was optional in the past result.activeSignature = 0; } if (Is.number(item.activeParameter)) { result.activeParameter = item.activeParameter; } else { // activeParameter was optional in the past result.activeParameter = 0; } if (item.signatures) { result.signatures = asSignatureInformations(item.signatures); } return result; } function asSignatureInformations(items) { return items.map(asSignatureInformation); } function asSignatureInformation(item) { let result = new code.SignatureInformation(item.label); if (item.documentation !== undefined) { result.documentation = asDocumentation(item.documentation); } if (item.parameters !== undefined) { result.parameters = asParameterInformations(item.parameters); } if (item.activeParameter !== undefined) { result.activeParameter = item.activeParameter; } { return result; } } function asParameterInformations(item) { return item.map(asParameterInformation); } function asParameterInformation(item) { let result = new code.ParameterInformation(item.label); if (item.documentation) { result.documentation = asDocumentation(item.documentation); } return result; } function asLocation(item) { if (!item) { return undefined; } return new code.Location(_uriConverter(item.uri), asRange(item.range)); } function asDeclarationResult(item) { if (!item) { return undefined; } return asLocationResult(item); } function asDefinitionResult(item) { if (!item) { return undefined; } return asLocationResult(item); } function asLocationLink(item) { if (!item) { return undefined; } let result = { targetUri: _uriConverter(item.targetUri), targetRange: asRange(item.targetRange), originSelectionRange: asRange(item.originSelectionRange), targetSelectionRange: asRange(item.targetSelectionRange) }; if (!result.targetSelectionRange) { throw new Error(`targetSelectionRange must not be undefined or null`); } return result; } function asLocationResult(item) { if (!item) { return undefined; } if (Is.array(item)) { if (item.length === 0) { return []; } else if (ls.LocationLink.is(item[0])) { let links = item; return links.map((link) => asLocationLink(link)); } else { let locations = item; return locations.map((location) => asLocation(location)); } } else if (ls.LocationLink.is(item)) { return [asLocationLink(item)]; } else { return asLocation(item); } } function asReferences(values) { if (!values) { return undefined; } return values.map(location => asLocation(location)); } function asDocumentHighlights(values) { if (!values) { return undefined; } return values.map(asDocumentHighlight); } function asDocumentHighlight(item) { let result = new code.DocumentHighlight(asRange(item.range)); if (Is.number(item.kind)) { result.kind = asDocumentHighlightKind(item.kind); } return result; } function asDocumentHighlightKind(item) { switch (item) { case ls.DocumentHighlightKind.Text: return code.DocumentHighlightKind.Text; case ls.DocumentHighlightKind.Read: return code.DocumentHighlightKind.Read; case ls.DocumentHighlightKind.Write: return code.DocumentHighlightKind.Write; } return code.DocumentHighlightKind.Text; } function asSymbolInformations(values, uri) { if (!values) { return undefined; } return values.map(information => asSymbolInformation(information, uri)); } function asSymbolKind(item) { if (item <= ls.SymbolKind.TypeParameter) { // Symbol kind is one based in the protocol and zero based in code. return item - 1; } return code.SymbolKind.Property; } function asSymbolTag(value) { switch (value) { case ls.SymbolTag.Deprecated: return code.SymbolTag.Deprecated; default: return undefined; } } function asSymbolTags(items) { if (items === undefined || items === null) { return undefined; } const result = []; for (const item of items) { const converted = asSymbolTag(item); if (converted !== undefined) { result.push(converted); } } return result.length === 0 ? undefined : result; } function asSymbolInformation(item, uri) { // Symbol kind is one based in the protocol and zero based in code. let result = new code.SymbolInformation(item.name, asSymbolKind(item.kind), asRange(item.location.range), item.location.uri ? _uriConverter(item.location.uri) : uri); fillTags(result, item); if (item.containerName) { result.containerName = item.containerName; } return result; } function asDocumentSymbols(values) { if (values === undefined || values === null) { return undefined; } return values.map(asDocumentSymbol); } function asDocumentSymbol(value) { let result = new code.DocumentSymbol(value.name, value.detail || '', asSymbolKind(value.kind), asRange(value.range), asRange(value.selectionRange)); fillTags(result, value); if (value.children !== undefined && value.children.length > 0) { let children = []; for (let child of value.children) { children.push(asDocumentSymbol(child)); } result.children = children; } return result; } function fillTags(result, value) { result.tags = asSymbolTags(value.tags); if (value.deprecated) { if (!result.tags) { result.tags = [code.SymbolTag.Deprecated]; } else { if (!result.tags.includes(code.SymbolTag.Deprecated)) { result.tags = result.tags.concat(code.SymbolTag.Deprecated); } } } } function asCommand(item) { let result = { title: item.title, command: item.command }; if (item.arguments) { result.arguments = item.arguments; } return result; } function asCommands(items) { if (!items) { return undefined; } return items.map(asCommand); } const kindMapping = new Map(); kindMapping.set(ls.CodeActionKind.Empty, code.CodeActionKind.Empty); kindMapping.set(ls.CodeActionKind.QuickFix, code.CodeActionKind.QuickFix); kindMapping.set(ls.CodeActionKind.Refactor, code.CodeActionKind.Refactor); kindMapping.set(ls.CodeActionKind.RefactorExtract, code.CodeActionKind.RefactorExtract); kindMapping.set(ls.CodeActionKind.RefactorInline, code.CodeActionKind.RefactorInline); kindMapping.set(ls.CodeActionKind.RefactorRewrite, code.CodeActionKind.RefactorRewrite); kindMapping.set(ls.CodeActionKind.Source, code.CodeActionKind.Source); kindMapping.set(ls.CodeActionKind.SourceOrganizeImports, code.CodeActionKind.SourceOrganizeImports); function asCodeActionKind(item) { if (item === undefined || item === null) { return undefined; } let result = kindMapping.get(item); if (result) { return result; } let parts = item.split('.'); result = code.CodeActionKind.Empty; for (let part of parts) { result = result.append(part); } return result; } function asCodeActionKinds(items) { if (items === undefined || items === null) { return undefined; } return items.map(kind => asCodeActionKind(kind)); } function asCodeAction(item) { if (item === undefined || item === null) { return undefined; } let result = new protocolCodeAction_1.default(item.title, item.data); if (item.kind !== undefined) { result.kind = asCodeActionKind(item.kind); } if (item.diagnostics !== undefined) { result.diagnostics = asDiagnostics(item.diagnostics); } if (item.edit !== undefined) { result.edit = asWorkspaceEdit(item.edit); } if (item.command !== undefined) { result.command = asCommand(item.command); } if (item.isPreferred !== undefined) { result.isPreferred = item.isPreferred; } if (item.disabled !== undefined) { result.disabled = { reason: item.disabled.reason }; } return result; } function asCodeLens(item) { if (!item) { return undefined; } let result = new protocolCodeLens_1.default(asRange(item.range)); if (item.command) { result.command = asCommand(item.command); } if (item.data !== undefined && item.data !== null) { result.data = item.data; } return result; } function asCodeLenses(items) { if (!items) { return undefined; } return items.map((codeLens) => asCodeLens(codeLens)); } function asWorkspaceEdit(item) { if (!item) { return undefined; } const sharedMetadata = new Map(); if (item.changeAnnotations !== undefined) { for (const key of Object.keys(item.changeAnnotations)) { const metaData = asWorkspaceEditEntryMetadata(item.changeAnnotations[key]); sharedMetadata.set(key, metaData); } } const asMetadata = (annotation) => { if (annotation === undefined) { return undefined; } else { return sharedMetadata.get(annotation); } }; const result = new code.WorkspaceEdit(); if (item.documentChanges) { for (const change of item.documentChanges) { if (ls.CreateFile.is(change)) { result.createFile(_uriConverter(change.uri), change.options, asMetadata(change.annotationId)); } else if (ls.RenameFile.is(change)) { result.renameFile(_uriConverter(change.oldUri), _uriConverter(change.newUri), change.options, asMetadata(change.annotationId)); } else if (ls.DeleteFile.is(change)) { result.deleteFile(_uriConverter(change.uri), change.options, asMetadata(change.annotationId)); } else if (ls.TextDocumentEdit.is(change)) { const uri = _uriConverter(change.textDocument.uri); for (const edit of change.edits) { if (vscode_languageserver_protocol_1.AnnotatedTextEdit.is(edit)) { result.replace(uri, asRange(edit.range), edit.newText, asMetadata(edit.annotationId)); } else { result.replace(uri, asRange(edit.range), edit.newText); } } } else { throw new Error(`Unknown workspace edit change received:\n${JSON.stringify(change, undefined, 4)}`); } } } else if (item.changes) { Object.keys(item.changes).forEach(key => { result.set(_uriConverter(key), asTextEdits(item.changes[key])); }); } return result; } function asWorkspaceEditEntryMetadata(annotation) { if (annotation === undefined) { return undefined; } return { label: annotation.label, needsConfirmation: !!annotation.needsConfirmation, description: annotation.description }; } function asDocumentLink(item) { let range = asRange(item.range); let target = item.target ? asUri(item.target) : undefined; // target must be optional in DocumentLink let link = new protocolDocumentLink_1.default(range, target); if (item.tooltip !== undefined) { link.tooltip = item.tooltip; } if (item.data !== undefined && item.data !== null) { link.data = item.data; } return link; } function asDocumentLinks(items) { if (!items) { return undefined; } return items.map(asDocumentLink); } function asColor(color) { return new code.Color(color.red, color.green, color.blue, color.alpha); } function asColorInformation(ci) { return new code.ColorInformation(asRange(ci.range), asColor(ci.color)); } function asColorInformations(colorInformation) { if (Array.isArray(colorInformation)) { return colorInformation.map(asColorInformation); } return undefined; } function asColorPresentation(cp) { let presentation = new code.ColorPresentation(cp.label); presentation.additionalTextEdits = asTextEdits(cp.additionalTextEdits); if (cp.textEdit) { presentation.textEdit = asTextEdit(cp.textEdit); } return presentation; } function asColorPresentations(colorPresentations) { if (Array.isArray(colorPresentations)) { return colorPresentations.map(asColorPresentation); } return undefined; } function asFoldingRangeKind(kind) { if (kind) { switch (kind) { case ls.FoldingRangeKind.Comment: return code.FoldingRangeKind.Comment; case ls.FoldingRangeKind.Imports: return code.FoldingRangeKind.Imports; case ls.FoldingRangeKind.Region: return code.FoldingRangeKind.Region; } } return undefined; } function asFoldingRange(r) { return new code.FoldingRange(r.startLine, r.endLine, asFoldingRangeKind(r.kind)); } function asFoldingRanges(foldingRanges) { if (Array.isArray(foldingRanges)) { return foldingRanges.map(asFoldingRange); } return undefined; } function asSelectionRange(selectionRange) { return new code.SelectionRange(asRange(selectionRange.range), selectionRange.parent ? asSelectionRange(selectionRange.parent) : undefined); } function asSelectionRanges(selectionRanges) { if (!Array.isArray(selectionRanges)) { return []; } let result = []; for (let range of selectionRanges) { result.push(asSelectionRange(range)); } return result; } function asCallHierarchyItem(item) { if (item === null) { return undefined; } let result = new protocolCallHierarchyItem_1.default(asSymbolKind(item.kind), item.name, item.detail || '', asUri(item.uri), asRange(item.range), asRange(item.selectionRange), item.data); if (item.tags !== undefined) { result.tags = asSymbolTags(item.tags); } return result; } function asCallHierarchyItems(items) { if (items === null) { return undefined; } return items.map(item => asCallHierarchyItem(item)); } function asCallHierarchyIncomingCall(item) { return new code.CallHierarchyIncomingCall(asCallHierarchyItem(item.from), asRanges(item.fromRanges)); } function asCallHierarchyIncomingCalls(items) { if (items === null) { return undefined; } return items.map(item => asCallHierarchyIncomingCall(item)); } function asCallHierarchyOutgoingCall(item) { return new code.CallHierarchyOutgoingCall(asCallHierarchyItem(item.to), asRanges(item.fromRanges)); } function asCallHierarchyOutgoingCalls(items) { if (items === null) { return undefined; } return items.map(item => asCallHierarchyOutgoingCall(item)); } function asSemanticTokens(value) { if (value === undefined || value === null) { return undefined; } return new code.SemanticTokens(new Uint32Array(value.data), value.resultId); } function asSemanticTokensEdit(value) { return new code.SemanticTokensEdit(value.start, value.deleteCount, value.data !== undefined ? new Uint32Array(value.data) : undefined); } function asSemanticTokensEdits(value) { if (value === undefined || value === null) { return undefined; } return new code.SemanticTokensEdits(value.edits.map(asSemanticTokensEdit), value.resultId); } function asSemanticTokensLegend(value) { return value; } function asLinkedEditingRanges(value) { if (value === null || value === undefined) { return undefined; } return new code.LinkedEditingRanges(asRanges(value.ranges), asRegularExpression(value.wordPattern)); } function asRegularExpression(value) { if (value === null || value === undefined) { return undefined; } return new RegExp(value); } return { asUri, asDiagnostics, asDiagnostic, asRange, asRanges, asPosition, asDiagnosticSeverity, asDiagnosticTag, asHover, asCompletionResult, asCompletionItem, asTextEdit, asTextEdits, asSignatureHelp, asSignatureInformations, asSignatureInformation, asParameterInformations, asParameterInformation, asDeclarationResult, asDefinitionResult, asLocation, asReferences, asDocumentHighlights, asDocumentHighlight, asDocumentHighlightKind, asSymbolKind, asSymbolTag, asSymbolTags, asSymbolInformations, asSymbolInformation, asDocumentSymbols, asDocumentSymbol, asCommand, asCommands, asCodeAction, asCodeActionKind, asCodeActionKinds, asCodeLens, asCodeLenses, asWorkspaceEdit, asDocumentLink, asDocumentLinks, asFoldingRangeKind, asFoldingRange, asFoldingRanges, asColor, asColorInformation, asColorInformations, asColorPresentation, asColorPresentations, asSelectionRange, asSelectionRanges, asSemanticTokensLegend, asSemanticTokens, asSemanticTokensEdit, asSemanticTokensEdits, asCallHierarchyItem, asCallHierarchyItems, asCallHierarchyIncomingCall, asCallHierarchyIncomingCalls, asCallHierarchyOutgoingCall, asCallHierarchyOutgoingCalls, asLinkedEditingRanges: asLinkedEditingRanges }; } exports.createConverter = createConverter; //# sourceMappingURL=protocolConverter.js.map