FileContext class

new FileContext(parent: ParserRuleContext | undefined, invokingState: number)

Parameters

number ruleIndex

Property Value

Set the outer alternative number for this context node. Default implementation does nothing to avoid backing field overhead for trees that don't need it. Create a subclass of ParserRuleContext with backing field and set option contextSuperClass. @since 4.5.3

altNumber: number

Property Value

Inherited From RuleContext.altNumber

childCount: number

Property Value

Inherited From ParserRuleContext.childCount

If we are debugging or building a parse tree for a visitor, we need to track all of the tokens and rule invocations associated with this rule's context. This is empty for parsing w/o tree constr. operation because we don't the need to track the details about how we parse this rule.

children?: ParseTree[]

Property Value

Inherited From ParserRuleContext.children

The exception that forced this rule to return. If the rule successfully completed, this is undefined.

exception?: RecognitionException

Property Value

Inherited From ParserRuleContext.exception

invokingState: number

Property Value

Inherited From RuleContext.invokingState

A context is empty if there is no invoking state; meaning nobody called current context.

isEmpty: boolean

Property Value

Inherited From RuleContext.isEmpty

parent: ParserRuleContext | undefined

Property Value

Inherited From ParserRuleContext.parent

payload: RuleContext

Property Value

Inherited From RuleContext.payload

ruleContext: this

Property Value

Inherited From ParserRuleContext.ruleContext

sourceInterval: Interval

Property Value

Inherited From ParserRuleContext.sourceInterval

Get the initial token in this context. Note that the range from start to stop is inclusive, so for rules that do not consume anything (for example, zero length or error productions) this token may exceed stop.

start: Token

Property Value

Inherited From ParserRuleContext.start

Get the final token in this context. Note that the range from start to stop is inclusive, so for rules that do not consume anything (for example, zero length or error productions) this token may precede start.

stop: Token | undefined

Property Value

Inherited From ParserRuleContext.stop

Return the combined text of all child nodes. This method only considers tokens which have been added to the parse tree. Since tokens on hidden channels (e.g. whitespace or comments) are not added to the parse trees, they will not appear in the output of this method.

text: string

Property Value

Inherited From RuleContext.text

function accept<Result>(visitor: ExpressionAntlrParserVisitor<Result>): Result

Parameters

Returns

function enterRule(listener: ExpressionAntlrParserListener)

Parameters

function EOF(): TerminalNode

Returns

function exitRule(listener: ExpressionAntlrParserListener)

Parameters

function expression(): ExpressionContext

Returns

Add a parse tree node to this as a child. Works for internal and leaf nodes. Does not set parent link; other add methods must do that. Other addChild methods call this. We cannot set the parent pointer of the incoming node because the existing interfaces do not have a setParent() method and I don't want to break backward compatibility for this.

@since 4.7

function addAnyChild<T>(t: T): T

Parameters

Returns

Inherited From ParserRuleContext.addAnyChild

function addChild(ruleInvocation: RuleContext)

Parameters

Inherited From ParserRuleContext.addChild

Add a token leaf node child and force its parent to be this node.

function addChild(t: TerminalNode)

Parameters

Inherited From ParserRuleContext.addChild

Add a child to this node based upon matchedToken. It creates a TerminalNodeImpl rather than using [Token)](xref:Parser%23createTerminalNode(ParserRuleContext%2C). I'm leaving this in for compatibility but the parser doesn't use this anymore.

function addChild(matchedToken: Token): TerminalNode

Parameters

Returns

Inherited From ParserRuleContext.addChild

Add an error node child and force its parent to be this node.

function addErrorNode(errorNode: ErrorNode): ErrorNode

Parameters

Returns

Inherited From ParserRuleContext.addErrorNode

Add a child to this node based upon badToken. It creates a ErrorNode rather than using [Token)](xref:Parser%23createErrorNode(ParserRuleContext%2C). I'm leaving this in for compatibility but the parser doesn't use this anymore.

function addErrorNode(badToken: Token): ErrorNode

Parameters

Returns

Inherited From ParserRuleContext.addErrorNode

COPY a ctx (I'm deliberately not using copy constructor) to avoid confusion with creating node with parent. Does not copy children (except error leaves). This is used in the generated parser code to flip a generic XContext node for rule X to a YContext for alt label Y. In that sense, it is not really a generic copy function.

If we do an error sync() at start of a rule, we might add error nodes to the generic XContext so this function must copy those nodes to the YContext as well else they are lost!

function copyFrom(ctx: ParserRuleContext)

Parameters

Inherited From ParserRuleContext.copyFrom

function depth(): number

Returns

Inherited From RuleContext.depth

static function emptyContext(): ParserRuleContext

Returns

Inherited From ParserRuleContext.emptyContext

function getChild(i: number): ParseTree

Parameters

Returns

Inherited From ParserRuleContext.getChild

function getChild<T>(i: number, ctxType: {  }): T

Parameters

Returns

Inherited From ParserRuleContext.getChild

static function getChildContext(parent: RuleContext, invokingState: number): RuleContext

Parameters

Returns

Inherited From RuleContext.getChildContext

function getRuleContext<T>(i: number, ctxType: {  }): T

Parameters

Returns

Inherited From ParserRuleContext.getRuleContext

function getRuleContexts<T>(ctxType: {  }): T[]

Parameters

Returns

Inherited From ParserRuleContext.getRuleContexts

function getToken(ttype: number, i: number): TerminalNode

Parameters

Returns

Inherited From ParserRuleContext.getToken

function getTokens(ttype: number): TerminalNode[]

Parameters

Returns

Inherited From ParserRuleContext.getTokens

Used by enterOuterAlt to toss out a RuleContext previously added as we entered a rule. If we have # label, we will need to remove generic ruleContext object.

function removeLastChild()

Inherited From ParserRuleContext.removeLastChild

function setParent(parent: RuleContext)

Parameters

Inherited From RuleContext.setParent

Used for rule context info debugging during parse-time, not so much for ATN debugging

function toInfoString(recognizer: Parser): string

Parameters

Returns

Inherited From ParserRuleContext.toInfoString

function toString(): string

Returns

Inherited From RuleContext.toString

function toString(recog: Recognizer<any, any> | undefined): string

Parameters

Returns

Inherited From RuleContext.toString

function toString(recog: Recognizer<any, any> | undefined, stop: RuleContext | undefined): string

Parameters

Returns

Inherited From RuleContext.toString

function toString(ruleNames: string[] | undefined): string

Parameters

Returns

Inherited From RuleContext.toString

function toString(ruleNames: string[] | undefined, stop: RuleContext | undefined): string

Parameters

Returns

Inherited From RuleContext.toString

function toStringTree(): string

Returns

Inherited From RuleContext.toStringTree

Print out a whole tree, not just a node, in LISP format (root child1 .. childN). Print just a node if this is a leaf. We have to know the recognizer so we can get rule names.

function toStringTree(recog: Parser): string

Parameters

Returns

Inherited From RuleContext.toStringTree

Print out a whole tree, not just a node, in LISP format (root child1 .. childN). Print just a node if this is a leaf.

function toStringTree(ruleNames: string[] | undefined): string

Parameters

Returns

Inherited From RuleContext.toStringTree

function tryGetChild<T>(i: number, ctxType: {  }): T | undefined

Parameters

Returns

Inherited From ParserRuleContext.tryGetChild

function tryGetRuleContext<T>(i: number, ctxType: {  }): T | undefined

Parameters

Returns

Inherited From ParserRuleContext.tryGetRuleContext

function tryGetToken(ttype: number, i: number): TerminalNode | undefined

Parameters

Returns

Inherited From ParserRuleContext.tryGetToken