Class LangiumGrammarReferences

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

Hierarchy (view full)

DefaultReferences
- LangiumGrammarReferences

Index

Constructors

Properties

documents index nameProvider nodeLocator

Methods

createReferencesToAttribute findActionDeclaration findAssignmentDeclaration findDeclaration findDeclarationNode findReferences findReferencesToTypeAttribute findRulesWithReturnType getReferenceToSelf

Constructors

constructor

new LangiumGrammarReferences(services): LangiumGrammarReferences
Parameters
- services: LangiumCoreServices
Returns LangiumGrammarReferences
Overrides DefaultReferences.constructor
- Defined in packages/langium/src/grammar/references/grammar-references.ts:27

Properties

`Protected` `Readonly`documents

documents: LangiumDocuments

`Protected` `Readonly`index

index: IndexManager

`Protected` `Readonly`nameProvider

nameProvider: NameProvider

`Protected` `Readonly`nodeLocator

nodeLocator: AstNodeLocator

Methods

`Protected`createReferencesToAttribute

createReferencesToAttribute(ruleOrAction, attribute): ReferenceDescription[]
Parameters
- ruleOrAction: GrammarAST.ParserRule | GrammarAST.Action
- attribute: GrammarAST.TypeAttribute
Returns ReferenceDescription[]
- Defined in packages/langium/src/grammar/references/grammar-references.ts:78

`Protected`findActionDeclaration

findActionDeclaration(action, featureName?): undefined | GrammarAST.TypeAttribute
Parameters
- action: GrammarAST.Action
- OptionalfeatureName: string
Returns undefined | GrammarAST.TypeAttribute
- Defined in packages/langium/src/grammar/references/grammar-references.ts:140

`Protected`findAssignmentDeclaration

findAssignmentDeclaration(assignment): undefined | AstNode
Parameters
- assignment: GrammarAST.Assignment
Returns undefined | AstNode
- Defined in packages/langium/src/grammar/references/grammar-references.ts:117

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
Overrides DefaultReferences.findDeclaration
- Defined in packages/langium/src/grammar/references/grammar-references.ts:32

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
Inherited from DefaultReferences.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>
Overrides DefaultReferences.findReferences
- Defined in packages/langium/src/grammar/references/grammar-references.ts:46

`Protected`findReferencesToTypeAttribute

findReferencesToTypeAttribute(targetNode, includeDeclaration): Stream<ReferenceDescription>
Parameters
- targetNode: GrammarAST.TypeAttribute
- includeDeclaration: boolean
Returns Stream<ReferenceDescription>
- Defined in packages/langium/src/grammar/references/grammar-references.ts:54

`Protected`findRulesWithReturnType

findRulesWithReturnType(interf): (GrammarAST.ParserRule | GrammarAST.Action)[]
Parameters
- interf: GrammarAST.Interface | GrammarAST.Type
Returns (GrammarAST.ParserRule | GrammarAST.Action)[]
- Defined in packages/langium/src/grammar/references/grammar-references.ts:154

`Protected`getReferenceToSelf

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