SPPTNode

interface SPPTNode
Content copied to clipboard

A leaf node has no children.

Functions

contains
Link copied to clipboard
common
abstract fun contains(other: SPPTNode): Boolean
Content copied to clipboard
  • 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

Properties

asBranch
Link copied to clipboard
common
abstract val asBranch: SPPTBranch
Content copied to clipboard
this node cast to an ISPPFBranch (or null if the node is not a branch)
asLeaf
Link copied to clipboard
common
abstract val asLeaf: SPPTLeaf
Content copied to clipboard
this node cast to an ILeaf (or null if the node is not a leaf)
identity
Link copied to clipboard
common
abstract val identity: SPPTNodeIdentity
Content copied to clipboard
the identity of this node
isBranch
Link copied to clipboard
common
abstract val isBranch: Boolean
Content copied to clipboard
true if this node is a branch
isEmptyLeaf
Link copied to clipboard
common
abstract val isEmptyLeaf: Boolean
Content copied to clipboard
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
Link copied to clipboard
common
abstract val isEmptyMatch: Boolean
Content copied to clipboard
isLeaf
Link copied to clipboard
common
abstract val isLeaf: Boolean
Content copied to clipboard
true if this node is a Leaf
isSkip
Link copied to clipboard
common
abstract val isSkip: Boolean
Content copied to clipboard
a grammar can define some rules as 'skip' rules, for example a rule to match whitespace is commonly a skip rule.
lastLeaf
Link copied to clipboard
common
abstract val lastLeaf: SPPTLeaf
Content copied to clipboard
location
Link copied to clipboard
common
abstract val location: InputLocation
Content copied to clipboard
matchedText
Link copied to clipboard
common
abstract val matchedText: String
Content copied to clipboard
all text matched by this node
matchedTextLength
Link copied to clipboard
common
abstract val matchedTextLength: Int
Content copied to clipboard
the length of the text (in characters) matched by this node, derived from identity
name
Link copied to clipboard
common
abstract val name: String
Content copied to clipboard
the name of the runtime rule that caused this node to be constructed
nextInputPosition
Link copied to clipboard
common
abstract val nextInputPosition: Int
Content copied to clipboard
startPosition + matchedTextLength
nonSkipMatchedText
Link copied to clipboard
common
abstract val nonSkipMatchedText: String
Content copied to clipboard
all text matched by this node excluding text that was matched by skip rules.
numberOfLines
Link copied to clipboard
common
abstract val numberOfLines: Int
Content copied to clipboard
the number of lines (end of line markers) covered by the text that this node matches
option
Link copied to clipboard
common
abstract val option: Int
Content copied to clipboard
parent
Link copied to clipboard
common
abstract var parent: SPPTBranch?
Content copied to clipboard
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
Link copied to clipboard
common
abstract val priority: Int
Content copied to clipboard
the priority of this node according to the grammar (0 if no priority defined by parent rule)
runtimeRuleNumber
Link copied to clipboard
common
abstract val runtimeRuleNumber: Int
Content copied to clipboard
the rule number from the runtime grammar that caused this node to be constructed, derived from identity
startPosition
Link copied to clipboard
common
abstract val startPosition: Int
Content copied to clipboard
the index position of the input text at which this node starts its match, derived from identity

Inheritors

SPPTNodeAbstract
Link copied to clipboard
SPPTNodeFromInputAbstract
Link copied to clipboard
SPPTBranch
Link copied to clipboard
SPPTLeaf
Link copied to clipboard