Interface Linker

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

interface Linker {
    buildMultiReference(
        node: AstNode,
        property: string,
        refNode: undefined | CstNode,
        refText: string,
    ): MultiReference;
    buildReference(
        node: AstNode,
        property: string,
        refNode: undefined | CstNode,
        refText: string,
    ): Reference;
    getCandidate(refInfo: ReferenceInfo): LinkingError | AstNodeDescription;
    getCandidates(refInfo: ReferenceInfo): LinkingError | AstNodeDescription[];
    link(
        document: LangiumDocument,
        cancelToken?: Cancellation.CancellationToken,
    ): Promise<void>;
    unlink(document: LangiumDocument): void;
}

Implemented by

DefaultLinker

Index

Methods

buildMultiReference buildReference getCandidate getCandidates link unlink

Methods

buildMultiReference

buildMultiReference(
    node: AstNode,
    property: string,
    refNode: undefined | CstNode,
    refText: string,
): MultiReference
Parameters
- node: AstNode
- property: string
- refNode: undefined | CstNode
- refText: string
Returns MultiReference
- Defined in packages/langium/src/references/linker.ts:77

buildReference

buildReference(
    node: AstNode,
    property: string,
    refNode: undefined | CstNode,
    refText: string,
): Reference
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
the desired Reference node, whose behavior wrt. resolving the cross reference is implementation specific.
- Defined in packages/langium/src/references/linker.ts:75

getCandidate

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

getCandidates

getCandidates(refInfo: ReferenceInfo): LinkingError | AstNodeDescription[]
Determines a candidate AST node description for linking the given reference.
Parameters
- refInfo: ReferenceInfo
Returns LinkingError | AstNodeDescription[]
- Defined in packages/langium/src/references/linker.ts:56

link

link(
document: LangiumDocument,
cancelToken?: Cancellation.CancellationToken,
): 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
  A LangiumDocument that shall be linked.
- OptionalcancelToken: Cancellation.CancellationToken
  A token for cancelling the operation.
Returns Promise<void>
Throws
OperationCancelled if a cancellation event is detected
- Defined in packages/langium/src/references/linker.ts:33

unlink

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