Class LangiumGrammarScopeProvider

Language-specific service for determining the scope of target elements visible in a specific cross-reference context.

Hierarchy (View Summary)

DefaultScopeProvider
- LangiumGrammarScopeProvider

Index

Constructors

Properties

descriptions globalScopeCache indexManager langiumDocuments nameProvider reflection

Methods

createScope createScopeForNodes getGlobalScope getScope

Constructors

constructor

new LangiumGrammarScopeProvider(
services: LangiumCoreServices,
): LangiumGrammarScopeProvider
Parameters
- services: LangiumCoreServices
Returns LangiumGrammarScopeProvider
Overrides DefaultScopeProvider.constructor
- Defined in packages/langium/src/grammar/references/grammar-scope.ts:26

Properties

`Protected` `Readonly`descriptions

descriptions: AstNodeDescriptionProvider

`Protected` `Readonly`globalScopeCache

globalScopeCache: WorkspaceCache<string, Scope>

`Protected` `Readonly`indexManager

indexManager: IndexManager

`Protected` `Readonly`langiumDocuments

langiumDocuments: LangiumDocuments

`Protected` `Readonly`nameProvider

nameProvider: NameProvider

`Protected` `Readonly`reflection

reflection: AstReflection

Methods

`Protected`createScope

createScope(
    elements: Iterable<AstNodeDescription>,
    outerScope?: Scope,
    options?: ScopeOptions,
): Scope
Create a scope for the given collection of AST node descriptions.
Parameters
- elements: Iterable<AstNodeDescription>
- OptionalouterScope: Scope
- Optionaloptions: ScopeOptions
Returns Scope
Inherited from DefaultScopeProvider.createScope
- Defined in packages/langium/src/references/scope-provider.ts:77

`Protected`createScopeForNodes

createScopeForNodes(
    elements: Iterable<AstNode>,
    outerScope?: Scope,
    options?: ScopeOptions,
): Scope
Create a scope for the given collection of AST nodes, which need to be transformed into respective descriptions first. This is done using the NameProvider and AstNodeDescriptionProvider services.
Parameters
- elements: Iterable<AstNode>
- OptionalouterScope: Scope
- Optionaloptions: ScopeOptions
Returns Scope
Inherited from DefaultScopeProvider.createScopeForNodes
- Defined in packages/langium/src/references/scope-provider.ts:85

`Protected`getGlobalScope

getGlobalScope(referenceType: string, context: ReferenceInfo): Scope
Create a global scope filtered for the given reference type.
Parameters
- referenceType: string
- context: ReferenceInfo
Returns Scope
Overrides DefaultScopeProvider.getGlobalScope
- Defined in packages/langium/src/grammar/references/grammar-scope.ts:72

getScope

getScope(context: ReferenceInfo): Scope
Return a scope describing what elements are visible for the given AST node and cross-reference identifier.
Parameters
- context: ReferenceInfo
  Information about the reference for which a scope is requested.
Returns Scope
Overrides DefaultScopeProvider.getScope
- Defined in packages/langium/src/grammar/references/grammar-scope.ts:31