Class LangiumGrammarReferences

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

Hierarchy (View Summary)

DefaultReferences
- LangiumGrammarReferences

Index

Constructors

constructor

new LangiumGrammarReferences(
services: LangiumCoreServices,
): LangiumGrammarReferences
Parameters
- services: LangiumCoreServices
Returns LangiumGrammarReferences
Inherited from DefaultReferences.constructor
- 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

`Protected`createReferencesToAttribute

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

`Protected`findActionDeclaration

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

`Protected`findAssignmentDeclaration

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

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[]
Inherited from DefaultReferences.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[]
Overrides DefaultReferences.findDeclarations
- Defined in packages/langium/src/grammar/references/grammar-references.ts:25

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

`Protected`findReferencesToTypeAttribute

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

`Protected`findRulesWithReturnType

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

`Protected`getNodeFromReferenceDescription

getNodeFromReferenceDescription(ref?: ReferenceDescription): undefined | AstNode
Parameters
- Optionalref: ReferenceDescription
Returns undefined | AstNode
Inherited from DefaultReferences.getNodeFromReferenceDescription
- 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[]
Inherited from DefaultReferences.getSelfNodes
- Defined in packages/langium/src/references/references.ts:113

`Protected`getSelfReferences

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

Class LangiumGrammarReferences

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns LangiumGrammarReferences

Properties

Protected Readonlydocuments

ProtectedhasMultiReference

Protected Readonlyindex

Protected ReadonlynameProvider

Protected ReadonlynodeLocator

Methods

ProtectedcreateReferencesToAttribute

Parameters

Returns ReferenceDescription[]

ProtectedfindActionDeclaration

Parameters

Returns undefined | GrammarAST.TypeAttribute

ProtectedfindAssignmentDeclaration

Parameters

Returns undefined | AstNode

findDeclarationNodes

Parameters

Returns CstNode[]

findDeclarations

Parameters

Returns AstNode[]

findReferences

Parameters

Returns Stream<ReferenceDescription>

ProtectedfindReferencesToTypeAttribute

Parameters

Returns Stream<ReferenceDescription>

ProtectedfindRulesWithReturnType

Parameters

Returns (GrammarAST.AbstractParserRule | GrammarAST.Action)[]

ProtectedgetNodeFromReferenceDescription

Parameters

Returns undefined | AstNode

ProtectedgetSelfNodes

Parameters

Returns AstNode[]

ProtectedgetSelfReferences

Parameters

Returns ReferenceDescription[]

Settings

On This Page

`Protected` `Readonly`documents

`Protected`hasMultiReference

`Protected` `Readonly`index

`Protected` `Readonly`nameProvider

`Protected` `Readonly`nodeLocator

`Protected`createReferencesToAttribute

`Protected`findActionDeclaration

`Protected`findAssignmentDeclaration

`Protected`findReferencesToTypeAttribute

`Protected`findRulesWithReturnType

`Protected`getNodeFromReferenceDescription

`Protected`getSelfNodes

`Protected`getSelfReferences