Interface AstNodeWithTextRegion

AstNodes that may carry information on their definition area within the DSL text.

interface AstNodeWithTextRegion {
    $container?: AstNode;
    $containerIndex?: number;
    $containerProperty?: string;
    $cstNode?: CstNode;
    $document?: LangiumDocument<AstNode>;
    $sourceText?: string;
    $textRegion?: AstNodeRegionWithAssignments;
    $type: string;
}

Hierarchy (view full)

Properties

$container? $containerIndex? $containerProperty? $cstNode? $document? $sourceText? $textRegion? $type

Properties

Optional Readonly$container

$container?: AstNode

The container node in the AST; every node except the root node has a container.

Optional Readonly$containerIndex

$containerIndex?: number

In case $containerProperty is an array, the array index is stored here.

Optional Readonly$containerProperty

$containerProperty?: string

The property of the $container node that contains this node. This is either a direct reference or an array.

Optional Readonly$cstNode

$cstNode?: CstNode

The Concrete Syntax Tree (CST) node of the text range from which this node was parsed.

Optional Readonly$document

$document?: LangiumDocument<AstNode>

The document containing the AST; only the root node has a direct reference to the document.

Optional$sourceText

$sourceText?: string

Optional$textRegion

$textRegion?: AstNodeRegionWithAssignments

Readonly$type

$type: string

Every AST node has a type corresponding to what was specified in the grammar declaration.

Settings

Member Visibility

On This Page

Properties