Interface ParserRule

A node in the Abstract Syntax Tree (AST).

interface ParserRule {
    $container: Grammar;
    $containerIndex?: number;
    $containerProperty?: string;
    $cstNode?: CstNode;
    $document?: LangiumDocument<AstNode>;
    $type: "ParserRule";
    dataType?: GrammarAST.PrimitiveType;
    definesHiddenTokens: boolean;
    definition: GrammarAST.AbstractElement;
    entry: boolean;
    fragment: boolean;
    hiddenTokens: Reference<GrammarAST.AbstractRule>[];
    inferredType?: GrammarAST.InferredType;
    name: string;
    parameters: GrammarAST.Parameter[];
    returnType?: Reference<GrammarAST.AbstractType>;
    wildcard: boolean;
}

Hierarchy (view full)

Properties

$container $containerIndex? $containerProperty? $cstNode? $document? $type dataType? definesHiddenTokens definition entry fragment hiddenTokens inferredType? name parameters returnType? wildcard

Properties

Readonly$container

$container: Grammar

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: "ParserRule"

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

OptionaldataType

dataType?: GrammarAST.PrimitiveType

definesHiddenTokens

definesHiddenTokens: boolean

definition

definition: GrammarAST.AbstractElement

entry

entry: boolean

fragment

fragment: boolean

hiddenTokens

hiddenTokens: Reference<GrammarAST.AbstractRule>[]

OptionalinferredType

inferredType?: GrammarAST.InferredType

name

name: string

parameters

parameters: GrammarAST.Parameter[]

OptionalreturnType

returnType?: Reference<GrammarAST.AbstractType>

wildcard

wildcard: boolean

Settings

Member Visibility

On This Page

Properties