state/com.monkopedia.kodemirror.state/ChangeSet

ChangeSet

A change set represents a group of modifications to a document. It stores the document length, and can only be applied to documents with exactly that length.

Types

Companion

object Companion

Properties

desc

val desc: ChangeDesc

Get a change description for this change set.

empty

val empty: Boolean

False when there are actual changes in this set.

invertedDesc

val invertedDesc: ChangeDesc

Get a description of the inverted form of these changes.

length

val length: Int

The length of the document before the change.

newLength

val newLength: Int

The length of the document after the change.

Functions

apply

fun apply(doc: Text): Text

Apply the changes to a document, returning the modified document.

compose

fun compose(other: ChangeSet): ChangeSet

Combine two subsequent change sets into a single set. other must start in the document produced by this.

composeDesc

fun composeDesc(other: ChangeDesc): ChangeDesc

Compute the combined effect of applying another set of changes after this one. The length of the document after this set should match the length before other.

invert

fun invert(doc: Text): ChangeSet

Given the document as it existed before the changes, return a change set that represents the inverse of this set, which could be used to go from the document created by the changes back to the document as it existed before the changes.

iterChangedRanges

fun iterChangedRanges(f: (fromA: DocPos, toA: DocPos, fromB: DocPos, toB: DocPos) -> Unit, individual: Boolean = false)

Iterate over the ranges changed by these changes.

iterChanges

fun iterChanges(f: (fromA: DocPos, toA: DocPos, fromB: DocPos, toB: DocPos, inserted: Text) -> Unit, individual: Boolean = false)

Iterate over the changed ranges in the document.

iterGaps

fun iterGaps(f: (posA: DocPos, posB: DocPos, length: Int) -> Unit)

Iterate over the unchanged parts left by these changes. posA provides the position of the range in the old document, posB the new position in the changed document.

map

fun map(other: ChangeDesc, before: Boolean = false): ChangeSet

Given another change set starting in the same document, maps this change set over the other, producing a new change set that can be applied to the document produced by applying other.

mapDesc

open override fun mapDesc(other: ChangeDesc, before: Boolean = false): ChangeDesc

Map this description, which should start with the same document as other, over another set of changes, so that it can be applied after it. When before is true, map as if the changes in this happened before the ones in other.

mapPos

fun mapPos(pos: DocPos, assoc: Int = -1): DocPos

Map a given position through these changes, to produce a position pointing into the new document.

fun mapPos(pos: DocPos, assoc: Int, mode: MapMode): DocPos?

Map a given position through these changes. Returns null if the position was deleted according to the given mode.

toChangeSetJSON

fun toChangeSetJSON(): List<ChangeSetJsonPart>

Serialize this change set to a JSON-representable value.

toJSON

fun toJSON(): List<Int>

Serialize this change desc to a JSON-representable value.

toString

open override fun toString(): String

touchesRange

fun touchesRange(from: DocPos, to: DocPos = from): TouchesResult

Check whether these changes touch a given range. When one of the changes entirely covers the range, the string "cover" is returned.