SPPTBranch

interface SPPTBranch : SPPTNode

A branch in a SharedPackedParseTree

Functions

branchChild

abstract fun branchChild(index: Int): SPPTBranch

contains

abstract 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

nonSkipChild

abstract fun nonSkipChild(index: Int): SPPTNode

Properties

asBranch

abstract val asBranch: SPPTBranch

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

asLeaf

abstract val asLeaf: SPPTLeaf

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

branchNonSkipChildren

abstract 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

abstract val children: List<SPPTNode>

the first one of the children alternatives of this branch.

childrenAlternatives

abstract val childrenAlternatives: Set<List<SPPTNode>>

the set of alternative children for this branch

identity

abstract val identity: SPPTNodeIdentity

the identity of this node

isBranch

abstract val isBranch: Boolean

true if this node is a branch

isEmptyLeaf

abstract 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

abstract val isEmptyMatch: Boolean

isLeaf

abstract val isLeaf: Boolean

true if this node is a Leaf

isSkip

abstract 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

abstract val lastLeaf: SPPTLeaf

location

abstract val location: InputLocation

matchedText

abstract val matchedText: String

all text matched by this node

matchedTextLength

abstract val matchedTextLength: Int

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

name

abstract val name: String

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

nextInputPosition

abstract val nextInputPosition: Int

startPosition + matchedTextLength

nonSkipChildren

abstract val nonSkipChildren: List<SPPTNode>

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

nonSkipMatchedText

abstract val nonSkipMatchedText: String

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

numberOfLines

abstract val numberOfLines: Int

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

option

abstract val option: Int

parent

abstract var parent: SPPTBranch?

A parent might be null if the construction of the node has not set it (it is not required)the parent branch of this node.

priority

abstract val priority: Int

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

runtimeRuleNumber

abstract val runtimeRuleNumber: Int

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

startPosition

abstract val startPosition: Int

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