Interface AbstractElement

A node in the Abstract Syntax Tree (AST).

interface AbstractElement {
    $container?: AstNode;
    $containerIndex?: number;
    $containerProperty?: string;
    $cstNode?: CstNode;
    $document?: LangiumDocument<AstNode>;
    $type:
        | "AbstractElement"
        | "Action"
        | "Alternatives"
        | "Assignment"
        | "CharacterRange"
        | "CrossReference"
        | "EndOfFile"
        | "Group"
        | "Keyword"
        | "NegatedToken"
        | "RegexToken"
        | "RuleCall"
        | "TerminalAlternatives"
        | "TerminalGroup"
        | "TerminalRuleCall"
        | "UnorderedGroup"
        | "UntilToken"
        | "Wildcard";
    cardinality?: "*" | "+" | "?";
    lookahead?:
        | "?!"
        | "?<!"
        | "?<="
        | "?=";
}

Hierarchy (view full)

Properties

$container? $containerIndex? $containerProperty? $cstNode? $document? $type cardinality? lookahead?

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.

Readonly$type

$type:
    | "AbstractElement"
    | "Action"
    | "Alternatives"
    | "Assignment"
    | "CharacterRange"
    | "CrossReference"
    | "EndOfFile"
    | "Group"
    | "Keyword"
    | "NegatedToken"
    | "RegexToken"
    | "RuleCall"
    | "TerminalAlternatives"
    | "TerminalGroup"
    | "TerminalRuleCall"
    | "UnorderedGroup"
    | "UntilToken"
    | "Wildcard"

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

Optionalcardinality

cardinality?: "*" | "+" | "?"

Optionallookahead

lookahead?:
    | "?!"
    | "?<!"
    | "?<="
    | "?="

Settings

Member Visibility

On This Page

Properties