antlr-ng Tool Class Hierarchy / index / GrammarRootAST

Class: GrammarRootAST

This is the root node for a grammar (for the top level grammarSpec rule).

Extends

• GrammarASTWithOptions

Implements

• IGrammarRootAST

Constructors

Constructor

new GrammarRootAST(node): GrammarRootAST;

Parameters

node

GrammarRootAST

Returns

GrammarRootAST

Overrides

GrammarASTWithOptions.constructor

Constructor

new GrammarRootAST(t, tokenStream): GrammarRootAST;

Parameters

t

Token

tokenStream

TokenStream

Returns

GrammarRootAST

Overrides

GrammarASTWithOptions.constructor

Constructor

new GrammarRootAST(
   type, 
   t, 
   tokenStream): GrammarRootAST;

Parameters

type

number

t

Token

tokenStream

TokenStream

Returns

GrammarRootAST

Overrides

GrammarASTWithOptions.constructor

Constructor

new GrammarRootAST(
   type, 
   t, 
   text, 
   tokenStream): GrammarRootAST;

Parameters

type

number

t

Token

text

string

tokenStream

TokenStream

Returns

GrammarRootAST

Overrides

GrammarASTWithOptions.constructor

Properties

astType

readonly astType: string = "GrammarASTWithOptions";

A discriminator to distinguish between different grammar AST types without creating a circular dependency.

Implementation of

IGrammarRootAST.astType

Inherited from

GrammarASTWithOptions.astType

---

atnState?

optional atnState: ATNState;

If we build an ATN, we make AST node point at left edge of ATN construct

Implementation of

IGrammarRootAST.atnState

Inherited from

GrammarASTWithOptions.atnState

---

childIndex

childIndex: number = -1;

What index is this node in the child list? Range: 0..n-1

Implementation of

IGrammarRootAST.childIndex

Inherited from

GrammarASTWithOptions.childIndex

---

children

children: CommonTree[] = [];

Implementation of

IGrammarRootAST.children

Inherited from

GrammarASTWithOptions.children

---

fileName

fileName: string;

Implementation of

IGrammarRootAST.fileName

---

g

g: Grammar;

For process AST nodes from imported grammars.

Implementation of

IGrammarRootAST.g

Inherited from

GrammarASTWithOptions.g

---

grammarType

grammarType: GrammarType;

Implementation of

IGrammarRootAST.grammarType

---

hasErrors

hasErrors: boolean = false;

Implementation of

IGrammarRootAST.hasErrors

---

parent

parent: null | CommonTree = null;

Who is the parent node of this node? If null, implies node is root.

Implementation of

IGrammarRootAST.parent

Inherited from

GrammarASTWithOptions.parent

---

startIndex

startIndex: number = -1;

What token indexes bracket all tokens associated with this node and below?

Implementation of

IGrammarRootAST.startIndex

Inherited from

GrammarASTWithOptions.startIndex

---

stopIndex

stopIndex: number = -1;

What token indexes bracket all tokens associated with this node and below?

Implementation of

IGrammarRootAST.stopIndex

Inherited from

GrammarASTWithOptions.stopIndex

---

textOverride

textOverride: string;

Implementation of

IGrammarRootAST.textOverride

Inherited from

GrammarASTWithOptions.textOverride

---

token?

optional token: Token;

A single token is the payload.

Implementation of

IGrammarRootAST.token

Inherited from

GrammarASTWithOptions.token

---

tokenStream

readonly tokenStream: TokenStream;

Track stream used to create this tree

Implementation of

IGrammarRootAST.tokenStream

---

toolConfiguration?

optional toolConfiguration: IToolConfiguration;

Implementation of

IGrammarRootAST.toolConfiguration

Methods

addChild()

addChild(t?): void;

Adds t as child of this node.

Warning: if t has no children, but child does and child isNil then this routine moves children to t via t.children = child.children, i.e., without copying the array.

Parameters

t?

CommonTree

The child to add.

Returns

void

Implementation of

IGrammarRootAST.addChild

Inherited from

GrammarASTWithOptions.addChild

---

addChildren()

addChildren(kids): void;

Adds all elements of kids list as children of this node.

Parameters

kids

CommonTree[]

The children to add.

Returns

void

Implementation of

IGrammarRootAST.addChildren

Inherited from

GrammarASTWithOptions.addChildren

---

deleteChild()

Call Signature

deleteChild(i): null | CommonTree;

Parameters

i

number

Returns

null | CommonTree

Implementation of

IGrammarRootAST.deleteChild

Inherited from

GrammarASTWithOptions.deleteChild

Call Signature

deleteChild(t): boolean;

Parameters

t

CommonTree

Returns

boolean

Implementation of

IGrammarRootAST.deleteChild

Inherited from

GrammarASTWithOptions.deleteChild

---

dupNode()

dupNode(): GrammarRootAST;

Returns

GrammarRootAST

Implementation of

IGrammarRootAST.dupNode

Overrides

GrammarASTWithOptions.dupNode

---

freshenParentAndChildIndexes()

freshenParentAndChildIndexes(offset?): void;

Sets the parent and child index values for all child of t.

Parameters

offset?

number

The index to start from.

Returns

void

Implementation of

IGrammarRootAST.freshenParentAndChildIndexes

Inherited from

GrammarASTWithOptions.freshenParentAndChildIndexes

---

getAllChildrenWithType()

getAllChildrenWithType(type): GrammarAST[];

Parameters

type

number

Returns

GrammarAST[]

Implementation of

IGrammarRootAST.getAllChildrenWithType

Inherited from

GrammarASTWithOptions.getAllChildrenWithType

---

getAltLabel()

getAltLabel(): null | string;

Walk ancestors of this node until we find ALT with alt!=null or leftRecursiveAltInfo!=null. Then grab label if any. If not a rule element, just returns null.

Returns

null | string

Implementation of

IGrammarRootAST.getAltLabel

Inherited from

GrammarASTWithOptions.getAltLabel

---

getAncestor()

getAncestor(ttype): null | CommonTree;

Walks upwards and get first ancestor with this token type.

Parameters

ttype

number

The token type to check for.

Returns

null | CommonTree

The first ancestor of this node with the specified token type, or null if no ancestor with the type exists.

Implementation of

IGrammarRootAST.getAncestor

Inherited from

GrammarASTWithOptions.getAncestor

---

getAncestors()

protected getAncestors(): null | CommonTree[];

Returns

null | CommonTree[]

a list of all ancestors of this node. The first node of list is the root and the last is the parent of this node.

Implementation of

IGrammarRootAST.getAncestors

Inherited from

GrammarASTWithOptions.getAncestors

---

getCharPositionInLine()

getCharPositionInLine(): number;

Returns

number

Implementation of

IGrammarRootAST.getCharPositionInLine

Inherited from

GrammarASTWithOptions.getCharPositionInLine

---

getFirstChildWithType()

getFirstChildWithType(type): null | CommonTree;

Parameters

type

number

Returns

null | CommonTree

Implementation of

IGrammarRootAST.getFirstChildWithType

Inherited from

GrammarASTWithOptions.getFirstChildWithType

---

getFirstDescendantWithType()

getFirstDescendantWithType(typeOrTypes): null | CommonTree;

Parameters

typeOrTypes

number | BitSet

Returns

null | CommonTree

Implementation of

IGrammarRootAST.getFirstDescendantWithType

Inherited from

GrammarASTWithOptions.getFirstDescendantWithType

---

getGrammarName()

getGrammarName(): null | string;

Returns

null | string

Implementation of

IGrammarRootAST.getGrammarName

---

getLine()

getLine(): number;

Returns

number

Implementation of

IGrammarRootAST.getLine

Inherited from

GrammarASTWithOptions.getLine

---

getNodesWithType()

getNodesWithType(typeOrTypes): GrammarAST[];

Parameters

typeOrTypes

null | number | IntervalSet

Returns

GrammarAST[]

Implementation of

IGrammarRootAST.getNodesWithType

Inherited from

GrammarASTWithOptions.getNodesWithType

---

getNodesWithTypePreorderDFS()

getNodesWithTypePreorderDFS(types): GrammarAST[];

Parameters

types

IntervalSet

Returns

GrammarAST[]

Implementation of

IGrammarRootAST.getNodesWithTypePreorderDFS

Inherited from

GrammarASTWithOptions.getNodesWithTypePreorderDFS

---

getNodeWithTokenIndex()

getNodeWithTokenIndex(index): null | GrammarAST;

Parameters

index

number

Returns

null | GrammarAST

Implementation of

IGrammarRootAST.getNodeWithTokenIndex

Inherited from

GrammarASTWithOptions.getNodeWithTokenIndex

---

getNumberOfOptions()

getNumberOfOptions(): number;

Returns

number

Implementation of

IGrammarRootAST.getNumberOfOptions

Inherited from

GrammarASTWithOptions.getNumberOfOptions

---

getOptionAST()

getOptionAST(key): undefined | GrammarAST;

Gets AST node holding value for option key; ignores default options and command-line forced options.

Parameters

key

string

Returns

undefined | GrammarAST

Implementation of

IGrammarRootAST.getOptionAST

Inherited from

GrammarASTWithOptions.getOptionAST

---

getOptions()

getOptions(): Map<string, null | GrammarAST>;

Returns

Map<string, null | GrammarAST>

Implementation of

IGrammarRootAST.getOptions

Inherited from

GrammarASTWithOptions.getOptions

---

getOptionString()

getOptionString(key): undefined | string;

Parameters

key

string

Returns

undefined | string

Implementation of

IGrammarRootAST.getOptionString

Overrides

GrammarASTWithOptions.getOptionString

---

getSourceInterval()

getSourceInterval(): Interval;

Returns

Interval

Implementation of

IGrammarRootAST.getSourceInterval

Inherited from

GrammarASTWithOptions.getSourceInterval

---

getText()

getText(): string;

Returns

string

Implementation of

IGrammarRootAST.getText

Inherited from

GrammarASTWithOptions.getText

---

getTokenStartIndex()

getTokenStartIndex(): number;

Returns

number

Implementation of

IGrammarRootAST.getTokenStartIndex

Inherited from

GrammarASTWithOptions.getTokenStartIndex

---

getTokenStopIndex()

getTokenStopIndex(): number;

Returns

number

Implementation of

IGrammarRootAST.getTokenStopIndex

Inherited from

GrammarASTWithOptions.getTokenStopIndex

---

getType()

getType(): number;

Returns

number

Implementation of

IGrammarRootAST.getType

Inherited from

GrammarASTWithOptions.getType

---

insertChild()

insertChild(i, t): void;

Inserts child t at child position i (0..n - 1) by shifting children i + 1..n - 1 to the right one position. Sets parent/indexes properly but does NOT collapse nil-rooted t's that come in here like addChild.

Parameters

i

number

The index to insert the child at.

t

CommonTree

The child to insert.

Returns

void

Implementation of

IGrammarRootAST.insertChild

Inherited from

GrammarASTWithOptions.insertChild

---

isNil()

isNil(): boolean;

Returns

boolean

Implementation of

IGrammarRootAST.isNil

Inherited from

GrammarASTWithOptions.isNil

---

replaceChildren()

replaceChildren(
   startChildIndex, 
   stopChildIndex, 
   t): void;

Deletes children from start to stop and replaces with t even if t is a list (nil-root tree). Number of children can increase or decrease. For huge child lists, inserting children can force walking rest of children to set their child index - could be slow.

Parameters

startChildIndex

number

The index to start deleting children.

stopChildIndex

number

The index to stop deleting children.

t

CommonTree

The tree to replace the deleted children with.

Returns

void

Implementation of

IGrammarRootAST.replaceChildren

Inherited from

GrammarASTWithOptions.replaceChildren

---

sanityCheckParentAndChildIndexes()

Call Signature

sanityCheckParentAndChildIndexes(): void;

Returns

void

Implementation of

IGrammarRootAST.sanityCheckParentAndChildIndexes

Inherited from

GrammarASTWithOptions.sanityCheckParentAndChildIndexes

Call Signature

sanityCheckParentAndChildIndexes(parent, i): void;

Parameters

parent

undefined | CommonTree

i

number

Returns

void

Implementation of

IGrammarRootAST.sanityCheckParentAndChildIndexes

Inherited from

GrammarASTWithOptions.sanityCheckParentAndChildIndexes

---

setChild()

setChild(i, t): void;

Parameters

i

number

t

CommonTree

Returns

void

Implementation of

IGrammarRootAST.setChild

Inherited from

GrammarASTWithOptions.setChild

---

setOption()

setOption(key, node): void;

Parameters

key

string

node

null | GrammarAST

Returns

void

Implementation of

IGrammarRootAST.setOption

Inherited from

GrammarASTWithOptions.setOption

---

setText()

setText(text): void;

Parameters

text

string

Returns

void

Implementation of

IGrammarRootAST.setText

Inherited from

GrammarASTWithOptions.setText

---

setTokenStartIndex()

setTokenStartIndex(index): void;

Parameters

index

number

Returns

void

Implementation of

IGrammarRootAST.setTokenStartIndex

Inherited from

GrammarASTWithOptions.setTokenStartIndex

---

setTokenStopIndex()

setTokenStopIndex(index): void;

Parameters

index

number

Returns

void

Implementation of

IGrammarRootAST.setTokenStopIndex

Inherited from

GrammarASTWithOptions.setTokenStopIndex

---

setType()

setType(type): void;

Parameters

type

number

Returns

void

Implementation of

IGrammarRootAST.setType

Inherited from

GrammarASTWithOptions.setType

---

setUnknownTokenBoundaries()

setUnknownTokenBoundaries(): void;

For every node in this subtree, make sure it's start/stop token's are set. Walks depth first, visits bottom up. Only updates nodes with at least one token index < 0.

Returns

void

Implementation of

IGrammarRootAST.setUnknownTokenBoundaries

Inherited from

GrammarASTWithOptions.setUnknownTokenBoundaries

---

toString()

toString(): string;

Returns

string

Implementation of

IGrammarRootAST.toString

Inherited from

GrammarASTWithOptions.toString

---

toStringTree()

toStringTree(): string;

Prints out a whole tree not just a node.

Returns

string

A string representation of the tree.

Implementation of

IGrammarRootAST.toStringTree

Inherited from

GrammarASTWithOptions.toStringTree

---

visit()

visit<T>(v): T;

Type Parameters

T

T

Parameters

v

IGrammarASTVisitor<T>

Returns

T

Implementation of

IGrammarRootAST.visit

Overrides

GrammarASTWithOptions.visit