Class DefaultDocumentSymbolProvider

Language-specific service for handling document symbols requests.

Implements

DocumentSymbolProvider

Index

Constructors

Properties

nameProvider nodeKindProvider

Methods

createSymbol getChildSymbols getSymbol getSymbols

Constructors

constructor

new DefaultDocumentSymbolProvider(
services: LangiumServices,
): DefaultDocumentSymbolProvider
Parameters
- services: LangiumServices
Returns DefaultDocumentSymbolProvider
- Defined in packages/langium/src/lsp/document-symbol-provider.ts:40

Properties

`Protected` `Readonly`nameProvider

nameProvider: NameProvider

`Protected` `Readonly`nodeKindProvider

nodeKindProvider: NodeKindProvider

Methods

`Protected`createSymbol

createSymbol(
    document: LangiumDocument,
    astNode: AstNode,
    cstNode: CstNode,
    nameNode: CstNode,
    computedName?: string,
): DocumentSymbol
Parameters
- document: LangiumDocument
- astNode: AstNode
- cstNode: CstNode
- nameNode: CstNode
- OptionalcomputedName: string
Returns DocumentSymbol
- Defined in packages/langium/src/lsp/document-symbol-provider.ts:59

`Protected`getChildSymbols

getChildSymbols(
document: LangiumDocument,
astNode: AstNode,
): undefined | DocumentSymbol[]
Parameters
- document: LangiumDocument
- astNode: AstNode
Returns undefined | DocumentSymbol[]
- Defined in packages/langium/src/lsp/document-symbol-provider.ts:69

`Protected`getSymbol

getSymbol(document: LangiumDocument, astNode: AstNode): DocumentSymbol[]
Parameters
- document: LangiumDocument
- astNode: AstNode
Returns DocumentSymbol[]
- Defined in packages/langium/src/lsp/document-symbol-provider.ts:49

getSymbols

getSymbols(
    document: LangiumDocument,
    _params: DocumentSymbolParams,
    _cancelToken?: Cancellation.CancellationToken,
): MaybePromise<DocumentSymbol[]>
Handle a document symbols request.
Parameters
- document: LangiumDocument
  The document in the workspace.
- _params: DocumentSymbolParams
- Optional_cancelToken: Cancellation.CancellationToken
Returns MaybePromise<DocumentSymbol[]>
The symbols for the given document.

Throws
OperationCancelled if cancellation is detected during execution

Throws
ResponseError if an error is detected that should be sent as response to the client
Implementation of DocumentSymbolProvider.getSymbols
- Defined in packages/langium/src/lsp/document-symbol-provider.ts:45