yorkie/dev.yorkie.util/IndexTreeNode

IndexTreeNode

abstract class IndexTreeNode<T : IndexTreeNode<T>>

IndexTreeNode is the node of IndexTree. It is used to represent the document of text-based editors.

Constructors

IndexTreeNode

constructor()

Types

Companion

object Companion

OnRemovedListener

fun interface OnRemovedListener<T : IndexTreeNode<T>>

Properties

allChildren

val allChildren: List<T>

Returns the children of the node including tombstones.

children

val children: List<T>

Returns the children of the node. Tombstone nodes remain awhile in the tree during editing. They will be removed after the editing is done. So, we need to filter out the tombstone nodes to get the real children.

dataSize

abstract val dataSize: DataSize

hasTextChild

val hasTextChild: Boolean

Returns true if the node's children consist of only text children.

isRemoved

abstract val isRemoved: Boolean

isText

val isText: Boolean

nextSibling

val nextSibling: T?

onRemovedListener

var onRemovedListener: IndexTreeNode.OnRemovedListener<T>?

val paddedSize: Int

var parent: T?

val prevSibling: T?

var totalSize: Int

abstract val type: String

value

abstract var value: String

visibleSize

var visibleSize: Int

Functions

append

fun append(node: T)

Appends the given node to the children.

cloneElement

abstract fun cloneElement(issueTimeTicket: () -> TimeTicket): T

Clones the element node with the given issueTimeTicket lambda and value.

cloneText

abstract fun cloneText(offset: Int): T

Clones the text node with the given id and value.

detachChild

fun detachChild(child: T)

Detaches the given alive child from this node for moving between parents (i.e. merge). Updates both visibleSize and totalSize.

findOffset

fun findOffset(node: T, includeRemoved: Boolean = false): Int

Returns the offset of the given node in the children. If includeRemoved is true, it includes removed nodes in the calculation.

getChildrenText

fun getChildrenText(): String

getChildrenText returns text value of all text type children.

insertAfter

fun insertAfter(targetNode: T, newNode: T)

Inserts the newNode after the targetNode.

insertAt

fun insertAt(offset: Int, newNode: T)

Inserts the newNode at the given offset.

insertBefore

fun insertBefore(targetNode: T, newNode: T)

Inserts the newNode before the targetNode.

isSplitSiblingSkipForBoundaryMigration

open fun isSplitSiblingSkipForBoundaryMigration(child: T): Boolean

Returns true when child is an element split sibling that the §7.3 boundary-insert migration must skip (not migrate) but keep scanning past. Subclasses override; the default returns false.

isUnknownToEditor

open fun isUnknownToEditor(child: T, versionVector: VersionVector): Boolean

Returns true when child was created by an operation the editor did not yet know about (per versionVector). Subclasses override; default false.

paddedSize

fun paddedSize(includeRemoved: Boolean = false): Int

Returns the length of the node including padding. If includeRemoved is true, it includes removed nodes in the calculation.

prepend

fun prepend(node: T)

Prepends the given node to the children.

removeChild

fun removeChild(child: T)

Removes the given child (physically purges it from the tree).

shouldKeepChildInLeft

open fun shouldKeepChildInLeft(child: T, versionVector: VersionVector?, allChildren: List<T>): Boolean

Returns true when child should be kept in the original (left) node rather than moved to the split sibling. Subclasses override this to implement merge-aware split semantics. The default always returns false.

splitElement

fun splitElement(offset: Int, versionVector: VersionVector? = null, issueTimeTicket: () -> TimeTicket): Pair<T?, DataSize>

splitText

fun splitText(offset: Int, absOffset: Int): Pair<T?, DataSize>

updateAncestorSize

fun updateAncestorSize(delta: Int, includeRemoved: Boolean = false)

Updates the size of the ancestors. It is used when the size of the node is changed. If includeRemoved is true, it updates ancestors totalSize including removed nodes.

updateDescendantSize

fun updateDescendantSize(includeRemoved: Boolean = false): Int

Updates the size of the descendants. It is used when the tree is newly created and the size of the descendants is not calculated. If includeRemoved is true, it includes removed nodes in the calculation.