lspLanguageFeatures.ts 24 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904
  1. /*---------------------------------------------------------------------------------------------
  2. * Copyright (c) Microsoft Corporation. All rights reserved.
  3. * Licensed under the MIT License. See License.txt in the project root for license information.
  4. *--------------------------------------------------------------------------------------------*/
  5. import * as lsTypes from 'vscode-languageserver-types';
  6. import {
  7. languages,
  8. editor,
  9. IMarkdownString,
  10. Uri,
  11. Position,
  12. IRange,
  13. Range,
  14. CancellationToken,
  15. IDisposable,
  16. MarkerSeverity,
  17. IEvent
  18. } from '../fillers/monaco-editor-core';
  19. export interface WorkerAccessor<T> {
  20. (...more: Uri[]): Promise<T>;
  21. }
  22. //#region DiagnosticsAdapter
  23. export interface ILanguageWorkerWithDiagnostics {
  24. doValidation(uri: string): Promise<lsTypes.Diagnostic[]>;
  25. }
  26. export class DiagnosticsAdapter<T extends ILanguageWorkerWithDiagnostics> {
  27. protected readonly _disposables: IDisposable[] = [];
  28. private readonly _listener: { [uri: string]: IDisposable } = Object.create(null);
  29. constructor(
  30. private readonly _languageId: string,
  31. protected readonly _worker: WorkerAccessor<T>,
  32. configChangeEvent: IEvent<any>
  33. ) {
  34. const onModelAdd = (model: editor.IModel): void => {
  35. let modeId = model.getLanguageId();
  36. if (modeId !== this._languageId) {
  37. return;
  38. }
  39. let handle: number;
  40. this._listener[model.uri.toString()] = model.onDidChangeContent(() => {
  41. window.clearTimeout(handle);
  42. handle = window.setTimeout(() => this._doValidate(model.uri, modeId), 500);
  43. });
  44. this._doValidate(model.uri, modeId);
  45. };
  46. const onModelRemoved = (model: editor.IModel): void => {
  47. editor.setModelMarkers(model, this._languageId, []);
  48. let uriStr = model.uri.toString();
  49. let listener = this._listener[uriStr];
  50. if (listener) {
  51. listener.dispose();
  52. delete this._listener[uriStr];
  53. }
  54. };
  55. this._disposables.push(editor.onDidCreateModel(onModelAdd));
  56. this._disposables.push(editor.onWillDisposeModel(onModelRemoved));
  57. this._disposables.push(
  58. editor.onDidChangeModelLanguage((event) => {
  59. onModelRemoved(event.model);
  60. onModelAdd(event.model);
  61. })
  62. );
  63. this._disposables.push(
  64. configChangeEvent((_) => {
  65. editor.getModels().forEach((model) => {
  66. if (model.getLanguageId() === this._languageId) {
  67. onModelRemoved(model);
  68. onModelAdd(model);
  69. }
  70. });
  71. })
  72. );
  73. this._disposables.push({
  74. dispose: () => {
  75. editor.getModels().forEach(onModelRemoved);
  76. for (let key in this._listener) {
  77. this._listener[key].dispose();
  78. }
  79. }
  80. });
  81. editor.getModels().forEach(onModelAdd);
  82. }
  83. public dispose(): void {
  84. this._disposables.forEach((d) => d && d.dispose());
  85. this._disposables.length = 0;
  86. }
  87. private _doValidate(resource: Uri, languageId: string): void {
  88. this._worker(resource)
  89. .then((worker) => {
  90. return worker.doValidation(resource.toString());
  91. })
  92. .then((diagnostics) => {
  93. const markers = diagnostics.map((d) => toDiagnostics(resource, d));
  94. let model = editor.getModel(resource);
  95. if (model && model.getLanguageId() === languageId) {
  96. editor.setModelMarkers(model, languageId, markers);
  97. }
  98. })
  99. .then(undefined, (err) => {
  100. console.error(err);
  101. });
  102. }
  103. }
  104. function toSeverity(lsSeverity: number | undefined): MarkerSeverity {
  105. switch (lsSeverity) {
  106. case lsTypes.DiagnosticSeverity.Error:
  107. return MarkerSeverity.Error;
  108. case lsTypes.DiagnosticSeverity.Warning:
  109. return MarkerSeverity.Warning;
  110. case lsTypes.DiagnosticSeverity.Information:
  111. return MarkerSeverity.Info;
  112. case lsTypes.DiagnosticSeverity.Hint:
  113. return MarkerSeverity.Hint;
  114. default:
  115. return MarkerSeverity.Info;
  116. }
  117. }
  118. function toDiagnostics(resource: Uri, diag: lsTypes.Diagnostic): editor.IMarkerData {
  119. let code = typeof diag.code === 'number' ? String(diag.code) : <string>diag.code;
  120. return {
  121. severity: toSeverity(diag.severity),
  122. startLineNumber: diag.range.start.line + 1,
  123. startColumn: diag.range.start.character + 1,
  124. endLineNumber: diag.range.end.line + 1,
  125. endColumn: diag.range.end.character + 1,
  126. message: diag.message,
  127. code: code,
  128. source: diag.source
  129. };
  130. }
  131. //#endregion
  132. //#region CompletionAdapter
  133. export interface ILanguageWorkerWithCompletions {
  134. doComplete(uri: string, position: lsTypes.Position): Promise<lsTypes.CompletionList>;
  135. }
  136. export class CompletionAdapter<T extends ILanguageWorkerWithCompletions>
  137. implements languages.CompletionItemProvider
  138. {
  139. constructor(
  140. private readonly _worker: WorkerAccessor<T>,
  141. private readonly _triggerCharacters: string[]
  142. ) {}
  143. public get triggerCharacters(): string[] {
  144. return this._triggerCharacters;
  145. }
  146. provideCompletionItems(
  147. model: editor.IReadOnlyModel,
  148. position: Position,
  149. context: languages.CompletionContext,
  150. token: CancellationToken
  151. ): Promise<languages.CompletionList | undefined> {
  152. const resource = model.uri;
  153. return this._worker(resource)
  154. .then((worker) => {
  155. return worker.doComplete(resource.toString(), fromPosition(position));
  156. })
  157. .then((info) => {
  158. if (!info) {
  159. return;
  160. }
  161. const wordInfo = model.getWordUntilPosition(position);
  162. const wordRange = new Range(
  163. position.lineNumber,
  164. wordInfo.startColumn,
  165. position.lineNumber,
  166. wordInfo.endColumn
  167. );
  168. const items: languages.CompletionItem[] = info.items.map((entry) => {
  169. const item: languages.CompletionItem = {
  170. label: entry.label,
  171. insertText: entry.insertText || entry.label,
  172. sortText: entry.sortText,
  173. filterText: entry.filterText,
  174. documentation: entry.documentation,
  175. detail: entry.detail,
  176. command: toCommand(entry.command),
  177. range: wordRange,
  178. kind: toCompletionItemKind(entry.kind)
  179. };
  180. if (entry.textEdit) {
  181. if (isInsertReplaceEdit(entry.textEdit)) {
  182. item.range = {
  183. insert: toRange(entry.textEdit.insert),
  184. replace: toRange(entry.textEdit.replace)
  185. };
  186. } else {
  187. item.range = toRange(entry.textEdit.range);
  188. }
  189. item.insertText = entry.textEdit.newText;
  190. }
  191. if (entry.additionalTextEdits) {
  192. item.additionalTextEdits =
  193. entry.additionalTextEdits.map<languages.TextEdit>(toTextEdit);
  194. }
  195. if (entry.insertTextFormat === lsTypes.InsertTextFormat.Snippet) {
  196. item.insertTextRules = languages.CompletionItemInsertTextRule.InsertAsSnippet;
  197. }
  198. return item;
  199. });
  200. return {
  201. isIncomplete: info.isIncomplete,
  202. suggestions: items
  203. };
  204. });
  205. }
  206. }
  207. export function fromPosition(position: Position): lsTypes.Position;
  208. export function fromPosition(position: undefined): undefined;
  209. export function fromPosition(position: Position | undefined): lsTypes.Position | undefined;
  210. export function fromPosition(position: Position | undefined): lsTypes.Position | undefined {
  211. if (!position) {
  212. return void 0;
  213. }
  214. return { character: position.column - 1, line: position.lineNumber - 1 };
  215. }
  216. export function fromRange(range: IRange): lsTypes.Range;
  217. export function fromRange(range: undefined): undefined;
  218. export function fromRange(range: IRange | undefined): lsTypes.Range | undefined;
  219. export function fromRange(range: IRange | undefined): lsTypes.Range | undefined {
  220. if (!range) {
  221. return void 0;
  222. }
  223. return {
  224. start: {
  225. line: range.startLineNumber - 1,
  226. character: range.startColumn - 1
  227. },
  228. end: { line: range.endLineNumber - 1, character: range.endColumn - 1 }
  229. };
  230. }
  231. export function toRange(range: lsTypes.Range): Range;
  232. export function toRange(range: undefined): undefined;
  233. export function toRange(range: lsTypes.Range | undefined): Range | undefined;
  234. export function toRange(range: lsTypes.Range | undefined): Range | undefined {
  235. if (!range) {
  236. return void 0;
  237. }
  238. return new Range(
  239. range.start.line + 1,
  240. range.start.character + 1,
  241. range.end.line + 1,
  242. range.end.character + 1
  243. );
  244. }
  245. function isInsertReplaceEdit(
  246. edit: lsTypes.TextEdit | lsTypes.InsertReplaceEdit
  247. ): edit is lsTypes.InsertReplaceEdit {
  248. return (
  249. typeof (<lsTypes.InsertReplaceEdit>edit).insert !== 'undefined' &&
  250. typeof (<lsTypes.InsertReplaceEdit>edit).replace !== 'undefined'
  251. );
  252. }
  253. function toCompletionItemKind(kind: number | undefined): languages.CompletionItemKind {
  254. const mItemKind = languages.CompletionItemKind;
  255. switch (kind) {
  256. case lsTypes.CompletionItemKind.Text:
  257. return mItemKind.Text;
  258. case lsTypes.CompletionItemKind.Method:
  259. return mItemKind.Method;
  260. case lsTypes.CompletionItemKind.Function:
  261. return mItemKind.Function;
  262. case lsTypes.CompletionItemKind.Constructor:
  263. return mItemKind.Constructor;
  264. case lsTypes.CompletionItemKind.Field:
  265. return mItemKind.Field;
  266. case lsTypes.CompletionItemKind.Variable:
  267. return mItemKind.Variable;
  268. case lsTypes.CompletionItemKind.Class:
  269. return mItemKind.Class;
  270. case lsTypes.CompletionItemKind.Interface:
  271. return mItemKind.Interface;
  272. case lsTypes.CompletionItemKind.Module:
  273. return mItemKind.Module;
  274. case lsTypes.CompletionItemKind.Property:
  275. return mItemKind.Property;
  276. case lsTypes.CompletionItemKind.Unit:
  277. return mItemKind.Unit;
  278. case lsTypes.CompletionItemKind.Value:
  279. return mItemKind.Value;
  280. case lsTypes.CompletionItemKind.Enum:
  281. return mItemKind.Enum;
  282. case lsTypes.CompletionItemKind.Keyword:
  283. return mItemKind.Keyword;
  284. case lsTypes.CompletionItemKind.Snippet:
  285. return mItemKind.Snippet;
  286. case lsTypes.CompletionItemKind.Color:
  287. return mItemKind.Color;
  288. case lsTypes.CompletionItemKind.File:
  289. return mItemKind.File;
  290. case lsTypes.CompletionItemKind.Reference:
  291. return mItemKind.Reference;
  292. }
  293. return mItemKind.Property;
  294. }
  295. function fromCompletionItemKind(kind: languages.CompletionItemKind): lsTypes.CompletionItemKind {
  296. const mItemKind = languages.CompletionItemKind;
  297. switch (kind) {
  298. case mItemKind.Text:
  299. return lsTypes.CompletionItemKind.Text;
  300. case mItemKind.Method:
  301. return lsTypes.CompletionItemKind.Method;
  302. case mItemKind.Function:
  303. return lsTypes.CompletionItemKind.Function;
  304. case mItemKind.Constructor:
  305. return lsTypes.CompletionItemKind.Constructor;
  306. case mItemKind.Field:
  307. return lsTypes.CompletionItemKind.Field;
  308. case mItemKind.Variable:
  309. return lsTypes.CompletionItemKind.Variable;
  310. case mItemKind.Class:
  311. return lsTypes.CompletionItemKind.Class;
  312. case mItemKind.Interface:
  313. return lsTypes.CompletionItemKind.Interface;
  314. case mItemKind.Module:
  315. return lsTypes.CompletionItemKind.Module;
  316. case mItemKind.Property:
  317. return lsTypes.CompletionItemKind.Property;
  318. case mItemKind.Unit:
  319. return lsTypes.CompletionItemKind.Unit;
  320. case mItemKind.Value:
  321. return lsTypes.CompletionItemKind.Value;
  322. case mItemKind.Enum:
  323. return lsTypes.CompletionItemKind.Enum;
  324. case mItemKind.Keyword:
  325. return lsTypes.CompletionItemKind.Keyword;
  326. case mItemKind.Snippet:
  327. return lsTypes.CompletionItemKind.Snippet;
  328. case mItemKind.Color:
  329. return lsTypes.CompletionItemKind.Color;
  330. case mItemKind.File:
  331. return lsTypes.CompletionItemKind.File;
  332. case mItemKind.Reference:
  333. return lsTypes.CompletionItemKind.Reference;
  334. }
  335. return lsTypes.CompletionItemKind.Property;
  336. }
  337. export function toTextEdit(textEdit: lsTypes.TextEdit): languages.TextEdit;
  338. export function toTextEdit(textEdit: undefined): undefined;
  339. export function toTextEdit(textEdit: lsTypes.TextEdit | undefined): languages.TextEdit | undefined;
  340. export function toTextEdit(textEdit: lsTypes.TextEdit | undefined): languages.TextEdit | undefined {
  341. if (!textEdit) {
  342. return void 0;
  343. }
  344. return {
  345. range: toRange(textEdit.range),
  346. text: textEdit.newText
  347. };
  348. }
  349. function toCommand(c: lsTypes.Command | undefined): languages.Command | undefined {
  350. return c && c.command === 'editor.action.triggerSuggest'
  351. ? { id: c.command, title: c.title, arguments: c.arguments }
  352. : undefined;
  353. }
  354. //#endregion
  355. //#region HoverAdapter
  356. export interface ILanguageWorkerWithHover {
  357. doHover(uri: string, position: lsTypes.Position): Promise<lsTypes.Hover | null>;
  358. }
  359. export class HoverAdapter<T extends ILanguageWorkerWithHover> implements languages.HoverProvider {
  360. constructor(private readonly _worker: WorkerAccessor<T>) {}
  361. provideHover(
  362. model: editor.IReadOnlyModel,
  363. position: Position,
  364. token: CancellationToken
  365. ): Promise<languages.Hover | undefined> {
  366. let resource = model.uri;
  367. return this._worker(resource)
  368. .then((worker) => {
  369. return worker.doHover(resource.toString(), fromPosition(position));
  370. })
  371. .then((info) => {
  372. if (!info) {
  373. return;
  374. }
  375. return <languages.Hover>{
  376. range: toRange(info.range),
  377. contents: toMarkedStringArray(info.contents)
  378. };
  379. });
  380. }
  381. }
  382. function isMarkupContent(thing: any): thing is lsTypes.MarkupContent {
  383. return (
  384. thing && typeof thing === 'object' && typeof (<lsTypes.MarkupContent>thing).kind === 'string'
  385. );
  386. }
  387. function toMarkdownString(entry: lsTypes.MarkupContent | lsTypes.MarkedString): IMarkdownString {
  388. if (typeof entry === 'string') {
  389. return {
  390. value: entry
  391. };
  392. }
  393. if (isMarkupContent(entry)) {
  394. if (entry.kind === 'plaintext') {
  395. return {
  396. value: entry.value.replace(/[\\`*_{}[\]()#+\-.!]/g, '\\$&')
  397. };
  398. }
  399. return {
  400. value: entry.value
  401. };
  402. }
  403. return { value: '```' + entry.language + '\n' + entry.value + '\n```\n' };
  404. }
  405. function toMarkedStringArray(
  406. contents: lsTypes.MarkupContent | lsTypes.MarkedString | lsTypes.MarkedString[]
  407. ): IMarkdownString[] | undefined {
  408. if (!contents) {
  409. return void 0;
  410. }
  411. if (Array.isArray(contents)) {
  412. return contents.map(toMarkdownString);
  413. }
  414. return [toMarkdownString(contents)];
  415. }
  416. //#endregion
  417. //#region DocumentHighlightAdapter
  418. export interface ILanguageWorkerWithDocumentHighlights {
  419. findDocumentHighlights(
  420. uri: string,
  421. position: lsTypes.Position
  422. ): Promise<lsTypes.DocumentHighlight[]>;
  423. }
  424. export class DocumentHighlightAdapter<T extends ILanguageWorkerWithDocumentHighlights>
  425. implements languages.DocumentHighlightProvider
  426. {
  427. constructor(private readonly _worker: WorkerAccessor<T>) {}
  428. public provideDocumentHighlights(
  429. model: editor.IReadOnlyModel,
  430. position: Position,
  431. token: CancellationToken
  432. ): Promise<languages.DocumentHighlight[]> {
  433. const resource = model.uri;
  434. return this._worker(resource)
  435. .then((worker) => worker.findDocumentHighlights(resource.toString(), fromPosition(position)))
  436. .then((entries) => {
  437. if (!entries) {
  438. return;
  439. }
  440. return entries.map((entry) => {
  441. return <languages.DocumentHighlight>{
  442. range: toRange(entry.range),
  443. kind: toDocumentHighlightKind(entry.kind)
  444. };
  445. });
  446. });
  447. }
  448. }
  449. function toDocumentHighlightKind(
  450. kind: lsTypes.DocumentHighlightKind
  451. ): languages.DocumentHighlightKind {
  452. switch (kind) {
  453. case lsTypes.DocumentHighlightKind.Read:
  454. return languages.DocumentHighlightKind.Read;
  455. case lsTypes.DocumentHighlightKind.Write:
  456. return languages.DocumentHighlightKind.Write;
  457. case lsTypes.DocumentHighlightKind.Text:
  458. return languages.DocumentHighlightKind.Text;
  459. }
  460. return languages.DocumentHighlightKind.Text;
  461. }
  462. //#endregion
  463. //#region DefinitionAdapter
  464. export interface ILanguageWorkerWithDefinitions {
  465. findDefinition(uri: string, position: lsTypes.Position): Promise<lsTypes.Location>;
  466. }
  467. export class DefinitionAdapter<T extends ILanguageWorkerWithDefinitions>
  468. implements languages.DefinitionProvider
  469. {
  470. constructor(private readonly _worker: WorkerAccessor<T>) {}
  471. public provideDefinition(
  472. model: editor.IReadOnlyModel,
  473. position: Position,
  474. token: CancellationToken
  475. ): Promise<languages.Definition> {
  476. const resource = model.uri;
  477. return this._worker(resource)
  478. .then((worker) => {
  479. return worker.findDefinition(resource.toString(), fromPosition(position));
  480. })
  481. .then((definition) => {
  482. if (!definition) {
  483. return;
  484. }
  485. return [toLocation(definition)];
  486. });
  487. }
  488. }
  489. function toLocation(location: lsTypes.Location): languages.Location {
  490. return {
  491. uri: Uri.parse(location.uri),
  492. range: toRange(location.range)
  493. };
  494. }
  495. //#endregion
  496. //#region ReferenceAdapter
  497. export interface ILanguageWorkerWithReferences {
  498. findReferences(uri: string, position: lsTypes.Position): Promise<lsTypes.Location[]>;
  499. }
  500. export class ReferenceAdapter<T extends ILanguageWorkerWithReferences>
  501. implements languages.ReferenceProvider
  502. {
  503. constructor(private readonly _worker: WorkerAccessor<T>) {}
  504. provideReferences(
  505. model: editor.IReadOnlyModel,
  506. position: Position,
  507. context: languages.ReferenceContext,
  508. token: CancellationToken
  509. ): Promise<languages.Location[]> {
  510. const resource = model.uri;
  511. return this._worker(resource)
  512. .then((worker) => {
  513. return worker.findReferences(resource.toString(), fromPosition(position));
  514. })
  515. .then((entries) => {
  516. if (!entries) {
  517. return;
  518. }
  519. return entries.map(toLocation);
  520. });
  521. }
  522. }
  523. //#endregion
  524. //#region RenameAdapter
  525. export interface ILanguageWorkerWithRename {
  526. doRename(
  527. uri: string,
  528. position: lsTypes.Position,
  529. newName: string
  530. ): Promise<lsTypes.WorkspaceEdit>;
  531. }
  532. export class RenameAdapter<T extends ILanguageWorkerWithRename>
  533. implements languages.RenameProvider
  534. {
  535. constructor(private readonly _worker: WorkerAccessor<T>) {}
  536. provideRenameEdits(
  537. model: editor.IReadOnlyModel,
  538. position: Position,
  539. newName: string,
  540. token: CancellationToken
  541. ): Promise<languages.WorkspaceEdit> {
  542. const resource = model.uri;
  543. return this._worker(resource)
  544. .then((worker) => {
  545. return worker.doRename(resource.toString(), fromPosition(position), newName);
  546. })
  547. .then((edit) => {
  548. return toWorkspaceEdit(edit);
  549. });
  550. }
  551. }
  552. function toWorkspaceEdit(edit: lsTypes.WorkspaceEdit): languages.WorkspaceEdit {
  553. if (!edit || !edit.changes) {
  554. return void 0;
  555. }
  556. let resourceEdits: languages.WorkspaceTextEdit[] = [];
  557. for (let uri in edit.changes) {
  558. const _uri = Uri.parse(uri);
  559. for (let e of edit.changes[uri]) {
  560. resourceEdits.push({
  561. resource: _uri,
  562. edit: {
  563. range: toRange(e.range),
  564. text: e.newText
  565. }
  566. });
  567. }
  568. }
  569. return {
  570. edits: resourceEdits
  571. };
  572. }
  573. //#endregion
  574. //#region DocumentSymbolAdapter
  575. export interface ILanguageWorkerWithDocumentSymbols {
  576. findDocumentSymbols(uri: string): Promise<lsTypes.SymbolInformation[]>;
  577. }
  578. export class DocumentSymbolAdapter<T extends ILanguageWorkerWithDocumentSymbols>
  579. implements languages.DocumentSymbolProvider
  580. {
  581. constructor(private readonly _worker: WorkerAccessor<T>) {}
  582. public provideDocumentSymbols(
  583. model: editor.IReadOnlyModel,
  584. token: CancellationToken
  585. ): Promise<languages.DocumentSymbol[] | undefined> {
  586. const resource = model.uri;
  587. return this._worker(resource)
  588. .then((worker) => worker.findDocumentSymbols(resource.toString()))
  589. .then((items) => {
  590. if (!items) {
  591. return;
  592. }
  593. return items.map((item) => ({
  594. name: item.name,
  595. detail: '',
  596. containerName: item.containerName,
  597. kind: toSymbolKind(item.kind),
  598. range: toRange(item.location.range),
  599. selectionRange: toRange(item.location.range),
  600. tags: []
  601. }));
  602. });
  603. }
  604. }
  605. function toSymbolKind(kind: lsTypes.SymbolKind): languages.SymbolKind {
  606. let mKind = languages.SymbolKind;
  607. switch (kind) {
  608. case lsTypes.SymbolKind.File:
  609. return mKind.Array;
  610. case lsTypes.SymbolKind.Module:
  611. return mKind.Module;
  612. case lsTypes.SymbolKind.Namespace:
  613. return mKind.Namespace;
  614. case lsTypes.SymbolKind.Package:
  615. return mKind.Package;
  616. case lsTypes.SymbolKind.Class:
  617. return mKind.Class;
  618. case lsTypes.SymbolKind.Method:
  619. return mKind.Method;
  620. case lsTypes.SymbolKind.Property:
  621. return mKind.Property;
  622. case lsTypes.SymbolKind.Field:
  623. return mKind.Field;
  624. case lsTypes.SymbolKind.Constructor:
  625. return mKind.Constructor;
  626. case lsTypes.SymbolKind.Enum:
  627. return mKind.Enum;
  628. case lsTypes.SymbolKind.Interface:
  629. return mKind.Interface;
  630. case lsTypes.SymbolKind.Function:
  631. return mKind.Function;
  632. case lsTypes.SymbolKind.Variable:
  633. return mKind.Variable;
  634. case lsTypes.SymbolKind.Constant:
  635. return mKind.Constant;
  636. case lsTypes.SymbolKind.String:
  637. return mKind.String;
  638. case lsTypes.SymbolKind.Number:
  639. return mKind.Number;
  640. case lsTypes.SymbolKind.Boolean:
  641. return mKind.Boolean;
  642. case lsTypes.SymbolKind.Array:
  643. return mKind.Array;
  644. }
  645. return mKind.Function;
  646. }
  647. //#endregion
  648. //#region DocumentLinkAdapter
  649. export interface ILanguageWorkerWithDocumentLinks {
  650. findDocumentLinks(uri: string): Promise<lsTypes.DocumentLink[]>;
  651. }
  652. export class DocumentLinkAdapter<T extends ILanguageWorkerWithDocumentLinks>
  653. implements languages.LinkProvider
  654. {
  655. constructor(private _worker: WorkerAccessor<T>) {}
  656. public provideLinks(
  657. model: editor.IReadOnlyModel,
  658. token: CancellationToken
  659. ): Promise<languages.ILinksList> {
  660. const resource = model.uri;
  661. return this._worker(resource)
  662. .then((worker) => worker.findDocumentLinks(resource.toString()))
  663. .then((items) => {
  664. if (!items) {
  665. return;
  666. }
  667. return {
  668. links: items.map((item) => ({
  669. range: toRange(item.range),
  670. url: item.target
  671. }))
  672. };
  673. });
  674. }
  675. }
  676. //#endregion
  677. //#region DocumentFormattingEditProvider, DocumentRangeFormattingEditProvider
  678. export interface ILanguageWorkerWithFormat {
  679. format(
  680. uri: string,
  681. range: lsTypes.Range | null,
  682. options: lsTypes.FormattingOptions
  683. ): Promise<lsTypes.TextEdit[]>;
  684. }
  685. export class DocumentFormattingEditProvider<T extends ILanguageWorkerWithFormat>
  686. implements languages.DocumentFormattingEditProvider
  687. {
  688. constructor(private _worker: WorkerAccessor<T>) {}
  689. public provideDocumentFormattingEdits(
  690. model: editor.IReadOnlyModel,
  691. options: languages.FormattingOptions,
  692. token: CancellationToken
  693. ): Promise<languages.TextEdit[] | undefined> {
  694. const resource = model.uri;
  695. return this._worker(resource).then((worker) => {
  696. return worker
  697. .format(resource.toString(), null, fromFormattingOptions(options))
  698. .then((edits) => {
  699. if (!edits || edits.length === 0) {
  700. return;
  701. }
  702. return edits.map<languages.TextEdit>(toTextEdit);
  703. });
  704. });
  705. }
  706. }
  707. export class DocumentRangeFormattingEditProvider<T extends ILanguageWorkerWithFormat>
  708. implements languages.DocumentRangeFormattingEditProvider
  709. {
  710. constructor(private _worker: WorkerAccessor<T>) {}
  711. public provideDocumentRangeFormattingEdits(
  712. model: editor.IReadOnlyModel,
  713. range: Range,
  714. options: languages.FormattingOptions,
  715. token: CancellationToken
  716. ): Promise<languages.TextEdit[] | undefined> {
  717. const resource = model.uri;
  718. return this._worker(resource).then((worker) => {
  719. return worker
  720. .format(resource.toString(), fromRange(range), fromFormattingOptions(options))
  721. .then((edits) => {
  722. if (!edits || edits.length === 0) {
  723. return;
  724. }
  725. return edits.map<languages.TextEdit>(toTextEdit);
  726. });
  727. });
  728. }
  729. }
  730. function fromFormattingOptions(options: languages.FormattingOptions): lsTypes.FormattingOptions {
  731. return {
  732. tabSize: options.tabSize,
  733. insertSpaces: options.insertSpaces
  734. };
  735. }
  736. //#endregion
  737. //#region DocumentColorAdapter
  738. export interface ILanguageWorkerWithDocumentColors {
  739. findDocumentColors(uri: string): Promise<lsTypes.ColorInformation[]>;
  740. getColorPresentations(
  741. uri: string,
  742. color: lsTypes.Color,
  743. range: lsTypes.Range
  744. ): Promise<lsTypes.ColorPresentation[]>;
  745. }
  746. export class DocumentColorAdapter<T extends ILanguageWorkerWithDocumentColors>
  747. implements languages.DocumentColorProvider
  748. {
  749. constructor(private readonly _worker: WorkerAccessor<T>) {}
  750. public provideDocumentColors(
  751. model: editor.IReadOnlyModel,
  752. token: CancellationToken
  753. ): Promise<languages.IColorInformation[] | undefined> {
  754. const resource = model.uri;
  755. return this._worker(resource)
  756. .then((worker) => worker.findDocumentColors(resource.toString()))
  757. .then((infos) => {
  758. if (!infos) {
  759. return;
  760. }
  761. return infos.map((item) => ({
  762. color: item.color,
  763. range: toRange(item.range)
  764. }));
  765. });
  766. }
  767. public provideColorPresentations(
  768. model: editor.IReadOnlyModel,
  769. info: languages.IColorInformation,
  770. token: CancellationToken
  771. ): Promise<languages.IColorPresentation[] | undefined> {
  772. const resource = model.uri;
  773. return this._worker(resource)
  774. .then((worker) =>
  775. worker.getColorPresentations(resource.toString(), info.color, fromRange(info.range))
  776. )
  777. .then((presentations) => {
  778. if (!presentations) {
  779. return;
  780. }
  781. return presentations.map((presentation) => {
  782. let item: languages.IColorPresentation = {
  783. label: presentation.label
  784. };
  785. if (presentation.textEdit) {
  786. item.textEdit = toTextEdit(presentation.textEdit);
  787. }
  788. if (presentation.additionalTextEdits) {
  789. item.additionalTextEdits =
  790. presentation.additionalTextEdits.map<languages.TextEdit>(toTextEdit);
  791. }
  792. return item;
  793. });
  794. });
  795. }
  796. }
  797. //#endregion