Class LangiumGrammarDefinitionProvider

Language-specific service for handling go to definition requests.

Hierarchy (view full)

DefaultDefinitionProvider
- LangiumGrammarDefinitionProvider

Index

Constructors

Properties

documents grammarConfig nameProvider references

Methods

collectLocationLinks findLink findTargetObject getDefinition

Constructors

constructor

new LangiumGrammarDefinitionProvider(services): LangiumGrammarDefinitionProvider
Parameters
- services: LangiumServices
Returns LangiumGrammarDefinitionProvider
Overrides DefaultDefinitionProvider.constructor
- Defined in packages/langium/src/grammar/lsp/grammar-definition.ts:24

Properties

`Protected`documents

documents: LangiumDocuments

`Protected` `Readonly`grammarConfig

grammarConfig: GrammarConfig

`Protected` `Readonly`nameProvider

nameProvider: NameProvider

`Protected` `Readonly`references

references: References

Methods

`Protected`collectLocationLinks

collectLocationLinks(sourceCstNode, _params): MaybePromise<undefined | LocationLink[]>
Parameters
- sourceCstNode: LeafCstNode
- _params: DefinitionParams
Returns MaybePromise<undefined | LocationLink[]>
Overrides DefaultDefinitionProvider.collectLocationLinks
- Defined in packages/langium/src/grammar/lsp/grammar-definition.ts:29

`Protected`findLink

findLink(source): undefined | GoToLink
Parameters
- source: CstNode
Returns undefined | GoToLink
Inherited from DefaultDefinitionProvider.findLink
- Defined in packages/langium/src/lsp/definition-provider.ts:81

`Protected`findTargetObject

findTargetObject(importedGrammar): undefined | AstNode
Parameters
- importedGrammar: Grammar
Returns undefined | AstNode
- Defined in packages/langium/src/grammar/lsp/grammar-definition.ts:51

getDefinition

getDefinition(document, params, _cancelToken?): MaybePromise<undefined | LocationLink[]>
Handle a go to definition request.
Parameters
- document: LangiumDocument<AstNode>
  The document in which the request was triggered.
- params: DefinitionParams
  The parameters of the request.
- Optional_cancelToken: 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
Inherited from DefaultDefinitionProvider.getDefinition
- Defined in packages/langium/src/lsp/definition-provider.ts:56