Class DefaultReferences

Language-specific service for finding references and declaration of a given CstNode.

Hierarchy (view full)

DefaultReferences
- LangiumGrammarReferences

Implements

References

Index

Constructors

Properties

index nameProvider nodeLocator

Methods

findDeclaration findDeclarationNode findReferences getReferenceToSelf

Constructors

constructor

new DefaultReferences(services): DefaultReferences
Parameters
- services: LangiumCoreServices
Returns DefaultReferences
- Defined in packages/langium/src/references/references.ts:71

Properties

`Protected` `Readonly`index

index: IndexManager

`Protected` `Readonly`nameProvider

nameProvider: NameProvider

`Protected` `Readonly`nodeLocator

nodeLocator: AstNodeLocator

Methods

findDeclaration

findDeclaration(sourceCstNode): undefined | AstNode
If the CstNode is a reference node the target CstNode will be returned. If the CstNode is a significant node of the CstNode this CstNode will be returned.
Parameters
- sourceCstNode: CstNode
  CstNode that points to a AstNode
Returns undefined | AstNode
Implementation of References.findDeclaration
- Defined in packages/langium/src/references/references.ts:77

findDeclarationNode

findDeclarationNode(sourceCstNode): undefined | CstNode
If the CstNode is a reference node the target CstNode will be returned. If the CstNode is a significant node of the CstNode this CstNode will be returned.
Parameters
- sourceCstNode: CstNode
  CstNode that points to a AstNode
Returns undefined | CstNode
Implementation of References.findDeclarationNode
- Defined in packages/langium/src/references/references.ts:107

findReferences

findReferences(targetNode, options): Stream<ReferenceDescription>
Finds all references to the target node as references (local references) or reference descriptions.
Parameters
- targetNode: AstNode
  Specified target node whose references should be returned
- options: FindReferencesOptions
Returns Stream<ReferenceDescription>
Implementation of References.findReferences
- Defined in packages/langium/src/references/references.ts:116

`Protected`getReferenceToSelf

getReferenceToSelf(targetNode): undefined | ReferenceDescription
Parameters
- targetNode: AstNode
Returns undefined | ReferenceDescription
- Defined in packages/langium/src/references/references.ts:132