Interface Grammar

A node in the Abstract Syntax Tree (AST).

interface Grammar {
    $container?: AstNode;
    $containerIndex?: number;
    $containerProperty?: string;
    $cstNode?: CstNode;
    $document?: LangiumDocument<AstNode>;
    $type: "Grammar";
    definesHiddenTokens: boolean;
    hiddenTokens: Reference<GrammarAST.AbstractRule>[];
    imports: GrammarAST.GrammarImport[];
    interfaces: GrammarAST.Interface[];
    isDeclared: boolean;
    name?: string;
    rules: GrammarAST.AbstractRule[];
    types: GrammarAST.Type[];
    usedGrammars: Reference<Grammar>[];
}

Hierarchy (view full)

Properties

$container? $containerIndex? $containerProperty? $cstNode? $document? $type definesHiddenTokens hiddenTokens imports interfaces isDeclared name? rules types usedGrammars

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

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

definesHiddenTokens

definesHiddenTokens: boolean

hiddenTokens

hiddenTokens: Reference<GrammarAST.AbstractRule>[]

imports

imports: GrammarAST.GrammarImport[]

interfaces

interfaces: GrammarAST.Interface[]

isDeclared

isDeclared: boolean

Optionalname

name?: string

rules

rules: GrammarAST.AbstractRule[]

types

types: GrammarAST.Type[]

usedGrammars

usedGrammars: Reference<Grammar>[]

Settings

Member Visibility

On This Page

Properties