Class DefaultReferences

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

Hierarchy (View Summary)

DefaultReferences
- LangiumGrammarReferences

Implements

References

Index

Constructors

Properties

documents hasMultiReference index nameProvider nodeLocator

Methods

findDeclarationNodes findDeclarations findReferences getNodeFromReferenceDescription getSelfNodes getSelfReferences

Constructors

constructor

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

Properties

`Protected` `Readonly`documents

documents: LangiumDocuments

`Protected`hasMultiReference

hasMultiReference: boolean

`Protected` `Readonly`index

index: IndexManager

`Protected` `Readonly`nameProvider

nameProvider: NameProvider

`Protected` `Readonly`nodeLocator

nodeLocator: AstNodeLocator

Methods

findDeclarationNodes

findDeclarationNodes(sourceCstNode: CstNode): CstNode[]
If the CstNode is a reference node the target CstNodes 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 CstNode[]
Implementation of References.findDeclarationNodes
- Defined in packages/langium/src/references/references.ts:148

findDeclarations

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

findReferences

findReferences(
targetNode: AstNode,
options: FindReferencesOptions,
): 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:160

`Protected`getNodeFromReferenceDescription

getNodeFromReferenceDescription(ref?: ReferenceDescription): undefined | AstNode
Parameters
- Optionalref: ReferenceDescription
Returns undefined | AstNode
- Defined in packages/langium/src/references/references.ts:137

`Protected`getSelfNodes

getSelfNodes(node: AstNode): AstNode[]
Returns all self-references for the specified node. Since the node can be part of a multi-reference, this method returns all nodes that are part of the same multi-reference.
Parameters
- node: AstNode
Returns AstNode[]
- Defined in packages/langium/src/references/references.ts:113

`Protected`getSelfReferences

getSelfReferences(targetNode: AstNode): ReferenceDescription[]
Parameters
- targetNode: AstNode
Returns ReferenceDescription[]
- Defined in packages/langium/src/references/references.ts:173