Class DefaultLinker

Language-specific service for resolving cross-references in the AST.

Implements

Linker

Index

Constructors

constructor

new DefaultLinker(services): DefaultLinker
Parameters
- services: LangiumCoreServices
Returns DefaultLinker
- Defined in packages/langium/src/references/linker.ts:83

Properties

`Protected` `Readonly`astNodeLocator

astNodeLocator: AstNodeLocator

`Protected` `Readonly`langiumDocuments

langiumDocuments: (() => LangiumDocuments)

`Protected` `Readonly`reflection

reflection: AstReflection

`Protected` `Readonly`scopeProvider

scopeProvider: ScopeProvider

Methods

buildReference

buildReference(node, property, refNode, refText): Reference<AstNode>
Creates a cross reference node being aware of its containing AstNode, the corresponding CstNode, the cross reference text denoting the target AstNode being already extracted of the document text, as well as the unique cross reference identifier.

Default behavior:
- The returned Reference's 'ref' property pointing to the target AstNode is populated lazily on its first visit.
- If the target AstNode cannot be resolved on the first visit, an error indicator will be installed and further resolution attempts will not be performed.
Parameters
- node: AstNode
  The containing AST node
- property: string
  The AST node property being referenced
- refNode: undefined | CstNode
  The corresponding CST node
- refText: string
  The cross reference text denoting the target AstNode
Returns Reference<AstNode>
the desired Reference node, whose behavior wrt. resolving the cross reference is implementation specific.
Implementation of Linker.buildReference
- Defined in packages/langium/src/references/linker.ts:147

`Protected`createLinkingError

createLinkingError(refInfo, targetDescription?): LinkingError
Parameters
- refInfo: ReferenceInfo
- OptionaltargetDescription: AstNodeDescription
Returns LinkingError
- Defined in packages/langium/src/references/linker.ts:231

`Protected`doLink

doLink(refInfo, document): void
Parameters
- refInfo: ReferenceInfo
- document: LangiumDocument<AstNode>
Returns void
- Defined in packages/langium/src/references/linker.ts:97

getCandidate

getCandidate(refInfo): AstNodeDescription | LinkingError
Determines a candidate AST node description for linking the given reference.
Parameters
- refInfo: ReferenceInfo
  Information about the reference.
Returns AstNodeDescription | LinkingError
Implementation of Linker.getCandidate
- Defined in packages/langium/src/references/linker.ts:141

`Protected`getLinkedNode

getLinkedNode(refInfo): {
    descr?: AstNodeDescription;
    error?: LinkingError;
    node?: AstNode;
}
Parameters
- refInfo: ReferenceInfo
Returns {
    descr?: AstNodeDescription;
    error?: LinkingError;
    node?: AstNode;
}
- Optionaldescr?: AstNodeDescription
- Optionalerror?: LinkingError
- Optionalnode?: AstNode
- Defined in packages/langium/src/references/linker.ts:191

link

link(document, cancelToken?): Promise<void>
Links all cross-references within the specified document. The default implementation loads only target elements from documents that are present in the LangiumDocuments service. The linked references are stored in the document's references property.
Parameters
- document: LangiumDocument<AstNode>
  A LangiumDocument that shall be linked.
- cancelToken: CancellationToken = CancellationToken.None
  A token for cancelling the operation.
Returns Promise<void>
Throws
OperationCancelled if a cancellation event is detected
Implementation of Linker.link
- Defined in packages/langium/src/references/linker.ts:90

`Protected`loadAstNode

loadAstNode(nodeDescription): undefined | AstNode
Parameters
- nodeDescription: AstNodeDescription
Returns undefined | AstNode
- Defined in packages/langium/src/references/linker.ts:220

unlink

unlink(document): void
Unlinks all references within the specified document and removes them from the list of references.
Parameters
- document: LangiumDocument<AstNode>
  A LangiumDocument that shall be unlinked.
Returns void
Implementation of Linker.unlink
- Defined in packages/langium/src/references/linker.ts:133

Class DefaultLinker

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns DefaultLinker

Properties

Protected ReadonlyastNodeLocator

Protected ReadonlylangiumDocuments

Protected Readonlyreflection

Protected ReadonlyscopeProvider

Methods

buildReference

Parameters

Returns Reference<AstNode>

ProtectedcreateLinkingError

Parameters

Returns LinkingError

ProtecteddoLink

Parameters

Returns void

getCandidate

Parameters

Returns AstNodeDescription | LinkingError

ProtectedgetLinkedNode

Parameters

Returns { descr?: AstNodeDescription; error?: LinkingError; node?: AstNode; }

Optionaldescr?: AstNodeDescription

Optionalerror?: LinkingError

Optionalnode?: AstNode

link

Parameters

Returns Promise<void>

Throws

ProtectedloadAstNode

Parameters

Returns undefined | AstNode

unlink

Parameters

Returns void

Settings

On This Page

`Protected` `Readonly`astNodeLocator

`Protected` `Readonly`langiumDocuments

`Protected` `Readonly`reflection

`Protected` `Readonly`scopeProvider

`Protected`createLinkingError

`Protected`doLink

`Protected`getLinkedNode

Returns {
descr?: AstNodeDescription;
error?: LinkingError;
node?: AstNode;
}

`Optional`descr?: AstNodeDescription

`Optional`error?: LinkingError

`Optional`node?: AstNode

`Protected`loadAstNode