SPPTBranchFromInputAndGrownChildren

class SPPTBranchFromInputAndGrownChildren : SPPTNodeFromInputAbstract, SPPTBranch

Functions

branchChild

open override fun branchChild(index: Int): SPPTBranch

contains

open override fun contains(other: SPPTNode): Boolean

this leaf contains another leaf if they are equal
this branch contains another branch if all the children alternatives of the other are contained in this

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

nonSkipChild

open override fun nonSkipChild(index: Int): SPPTNode

toString

open override fun toString(): String

toStringIndented

fun toStringIndented(indentIncrement: String): String

Properties

asBranch

open override val asBranch: SPPTBranch

this node cast to an ISPPFBranch (or null if the node is not a branch)

asLeaf

open override val asLeaf: SPPTLeaf

this node cast to an ILeaf (or null if the node is not a leaf)

branchNonSkipChildren

open override val branchNonSkipChildren: List<SPPTBranch>

Filters out any children that are skip nodes or not branchesall children that are branches and non skip (in first one of the children alternatives)

children

open override val children: List<SPPTNode>

the first one of the children alternatives of this branch.

childrenAlternatives

open override val childrenAlternatives: Set<List<SPPTNode>>

the set of alternative children for this branch

embeddedIn

var embeddedIn: String? = null

identity

open override val identity: SPPTNodeIdentity

the identity of this node

isBranch

open override val isBranch: Boolean

true if this node is a branch

isEmptyLeaf

open override val isEmptyLeaf: Boolean

an Empty Leaf is constructed by a parse by specifically matching nothing, caused by:

a rule with no items (for example 'rule = ;')
an optional item (for example 'rule = item?

isEmptyMatch

open override val isEmptyMatch: Boolean

isLeaf

open override val isLeaf: Boolean

true if this node is a Leaf

isSkip

open override val isSkip: Boolean

a grammar can define some rules as 'skip' rules, for example a rule to match whitespace is commonly a skip rule.

lastLeaf

open override val lastLeaf: SPPTLeaf

location

open override val location: InputLocation

matchedText

open override val matchedText: String

all text matched by this node

matchedTextLength

open override val matchedTextLength: Int

the length of the text (in characters) matched by this node, derived from identity

name

open override val name: String

the name of the runtime rule that caused this node to be constructed

nextInputPosition

open override val nextInputPosition: Int

startPosition + matchedTextLength

nonSkipChildren

open override val nonSkipChildren: List<SPPTNode>

the first one of the children alternatives of this branch with all skip nodes removed.

nonSkipMatchedText

open override val nonSkipMatchedText: String

all text matched by this node excluding text that was matched by skip rules.

numberOfLines

open override val numberOfLines: Int

the number of lines (end of line markers) covered by the text that this node matches

option

open override val option: Int

parent

open override var parent: SPPTBranch? = null

The parent branch of this node.

priority

open override val priority: Int

the priority of this node according to the grammar (0 if no priority defined by parent rule)

runtimeRuleNumber

open override val runtimeRuleNumber: Int

the rule number from the runtime grammar that caused this node to be constructed, derived from identity

startPosition

override val startPosition: Int

the index position of the input text at which this node starts its match, derived from identity

tree

open override var tree: SharedPackedParseTree?

The tree which this node is part ofMight be null if the construction of the node has not set it (it is not required)