Interface References

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

interface References {
    findDeclaration(sourceCstNode: CstNode): undefined | AstNode;
    findDeclarationNode(sourceCstNode: CstNode): undefined | CstNode;
    findReferences(targetNode: AstNode, options: FindReferencesOptions): Stream<ReferenceDescription>;
}

Implemented by

DefaultReferences

Index

Methods

findDeclaration findDeclarationNode findReferences

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
- Defined in packages/langium/src/references/references.ts:33

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
- Defined in packages/langium/src/references/references.ts:41

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>
- Defined in packages/langium/src/references/references.ts:48