/
document-symbol-provider.ts
73 lines (64 loc) · 2.99 KB
/
document-symbol-provider.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
/******************************************************************************
* Copyright 2021 TypeFox GmbH
* This program and the accompanying materials are made available under the
* terms of the MIT License, which is available in the project root.
******************************************************************************/
import type { DocumentSymbol, DocumentSymbolParams } from 'vscode-languageserver';
import type { CancellationToken } from '../utils/cancellation.js';
import type { NameProvider } from '../references/name-provider.js';
import type { LangiumServices } from './lsp-services.js';
import type { AstNode } from '../syntax-tree.js';
import { streamContents } from '../utils/ast-utils.js';
import type { MaybePromise } from '../utils/promise-utils.js';
import type { LangiumDocument } from '../workspace/documents.js';
import type { NodeKindProvider } from './node-kind-provider.js';
/**
* Language-specific service for handling document symbols requests.
*/
export interface DocumentSymbolProvider {
/**
* Handle a document symbols request.
*
* @throws `OperationCancelled` if cancellation is detected during execution
* @throws `ResponseError` if an error is detected that should be sent as response to the client
*/
getSymbols(document: LangiumDocument, params: DocumentSymbolParams, cancelToken?: CancellationToken): MaybePromise<DocumentSymbol[]>;
}
export class DefaultDocumentSymbolProvider implements DocumentSymbolProvider {
protected readonly nameProvider: NameProvider;
protected readonly nodeKindProvider: NodeKindProvider;
constructor(services: LangiumServices) {
this.nameProvider = services.references.NameProvider;
this.nodeKindProvider = services.shared.lsp.NodeKindProvider;
}
getSymbols(document: LangiumDocument): MaybePromise<DocumentSymbol[]> {
return this.getSymbol(document, document.parseResult.value);
}
protected getSymbol(document: LangiumDocument, astNode: AstNode): DocumentSymbol[] {
const node = astNode.$cstNode;
const nameNode = this.nameProvider.getNameNode(astNode);
if (nameNode && node) {
const name = this.nameProvider.getName(astNode);
return [{
kind: this.nodeKindProvider.getSymbolKind(astNode),
name: name ?? nameNode.text,
range: node.range,
selectionRange: nameNode.range,
children: this.getChildSymbols(document, astNode)
}];
} else {
return this.getChildSymbols(document, astNode) || [];
}
}
protected getChildSymbols(document: LangiumDocument, astNode: AstNode): DocumentSymbol[] | undefined {
const children: DocumentSymbol[] = [];
for (const child of streamContents(astNode)) {
const result = this.getSymbol(document, child);
children.push(...result);
}
if (children.length > 0) {
return children;
}
return undefined;
}
}