Class DefaultDefinitionProvider

Language-specific service for handling go to definition requests.

Hierarchy (View Summary)

DefaultDefinitionProvider
- LangiumGrammarDefinitionProvider

Implements

DefinitionProvider

Index

Constructors

Properties

grammarConfig nameProvider references

Methods

collectLocationLinks findLinks getDefinition

Constructors

constructor

new DefaultDefinitionProvider(
services: LangiumServices,
): DefaultDefinitionProvider
Parameters
- services: LangiumServices
Returns DefaultDefinitionProvider
- Defined in packages/langium/src/lsp/definition-provider.ts:50

Properties

`Protected` `Readonly`grammarConfig

grammarConfig: GrammarConfig

`Protected` `Readonly`nameProvider

nameProvider: NameProvider

`Protected` `Readonly`references

references: References

Methods

`Protected`collectLocationLinks

collectLocationLinks(
sourceCstNode: CstNode,
_params: DefinitionParams,
): MaybePromise<undefined | LocationLink[]>
Parameters
- sourceCstNode: CstNode
- _params: DefinitionParams
Returns MaybePromise<undefined | LocationLink[]>
- Defined in packages/langium/src/lsp/definition-provider.ts:68

`Protected`findLinks

findLinks(source: CstNode): GoToLink[]
Parameters
- source: CstNode
Returns GoToLink[]
- Defined in packages/langium/src/lsp/definition-provider.ts:81

getDefinition

getDefinition(
    document: LangiumDocument,
    params: DefinitionParams,
    _cancelToken?: Cancellation.CancellationToken,
): MaybePromise<undefined | LocationLink[]>
Handle a go to definition request.
Parameters
- document: LangiumDocument
  The document in which the request was triggered.
- params: DefinitionParams
  The parameters of the request.
- Optional_cancelToken: Cancellation.CancellationToken
Returns MaybePromise<undefined | LocationLink[]>
A list of location links to the definition(s) of the symbol at the given position.

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 DefinitionProvider.getDefinition
- Defined in packages/langium/src/lsp/definition-provider.ts:56