Move the view when performing actions on the list

Author: object-Object

Common/src/main/kotlin/gay/object/hexdebug/blocks/splicing/SplicingTableBlockEntity.kt

@@ -244,7 +244,9 @@ class SplicingTableBlockEntity(pos: BlockPos, state: BlockState) :
         }
         if (writeList(list)) {
             shouldConsumeMedia = true
-            selection = Selection.edge(typedSelection.start + 1)
+            selection = Selection.edge(typedSelection.start + 1)?.also {
+                makeEdgeVisible(it.index)
+            }
             pushUndoState(
                 list = Some(list),
                 selection = Some(selection),

Common/src/main/kotlin/gay/object/hexdebug/gui/splicing/SplicingTableMenu.kt

@@ -51,16 +51,18 @@ class SplicingTableMenu(
         index3 = SplicingTableDataSlot.MEDIA_3.index,
     )
 
-    val selection by ContainerDataSelectionDelegate(
+    var selection by ContainerDataSelectionDelegate(
         data,
         fromIndex = SplicingTableDataSlot.SELECTION_FROM.index,
         toIndex = SplicingTableDataSlot.SELECTION_TO.index,
     )
+        private set
 
-    val viewStartIndex by ContainerDataDelegate(
+    var viewStartIndex by ContainerDataDelegate(
         data,
         index = SplicingTableDataSlot.VIEW_START_INDEX.index,
     )
+        private set
 
     var clientView = SplicingTableClientView.empty()
 
@@ -141,7 +143,16 @@ class SplicingTableMenu(
     ) = addSlot(FilteredSlot(table, slot, x, y).also(builder))
 
     fun sendData(player: ServerPlayer) {
-        table.getClientView()?.let { MsgSplicingTableNewDataS2C(it).sendToPlayer(player) }
+        table.getClientView()?.let {
+            MsgSplicingTableNewDataS2C(it, selection, viewStartIndex).sendToPlayer(player)
+        }
+    }
+
+    fun receiveData(msg: MsgSplicingTableNewDataS2C) {
+        clientView = msg.data
+        // TODO: does this make the client send a packet to the server?
+        selection = msg.selection
+        viewStartIndex = msg.viewStartIndex
     }
 
     companion object {

Common/src/main/kotlin/gay/object/hexdebug/networking/handler/ClientMessageHandler.kt

@@ -71,7 +71,7 @@ fun HexDebugMessageS2C.applyOnClient(ctx: PacketContext) = ctx.queue {
 
         is MsgSplicingTableNewDataS2C -> {
             SplicingTableMenu.getInstance(ctx.player)?.also { menu ->
-                menu.clientView = data
+                menu.receiveData(this)
                 SplicingTableScreen.getInstance()?.reloadData()
             }
         }

Common/src/main/kotlin/gay/object/hexdebug/networking/msg/MsgSplicingTableNewDataS2C.kt

@@ -1,13 +1,17 @@
 package gay.`object`.hexdebug.networking.msg
 
 import at.petrak.hexcasting.api.casting.math.HexPattern
-import gay.`object`.hexdebug.splicing.IotaClientView
-import gay.`object`.hexdebug.splicing.SplicingTableClientView
+import gay.`object`.hexdebug.splicing.*
 import net.minecraft.nbt.CompoundTag
 import net.minecraft.network.FriendlyByteBuf
 
 /** The result of running a splicing table action on the server. */
-data class MsgSplicingTableNewDataS2C(val data: SplicingTableClientView) : HexDebugMessageS2C {
+data class MsgSplicingTableNewDataS2C(
+    val data: SplicingTableClientView,
+    // these are sent in the container data, but we also need to send them in this packet to avoid weird flickering
+    val selection: Selection?,
+    val viewStartIndex: Int,
+) : HexDebugMessageS2C {
     companion object : HexDebugMessageCompanion<MsgSplicingTableNewDataS2C> {
         override val type = MsgSplicingTableNewDataS2C::class.java
 
@@ -31,6 +35,8 @@ data class MsgSplicingTableNewDataS2C(val data: SplicingTableClientView) : HexDe
                 undoSize = buf.readInt(),
                 undoIndex = buf.readInt(),
             ),
+            selection = buf.readSelection(),
+            viewStartIndex = buf.readInt(),
         )
 
         override fun MsgSplicingTableNewDataS2C.encode(buf: FriendlyByteBuf) {
@@ -50,6 +56,8 @@ data class MsgSplicingTableNewDataS2C(val data: SplicingTableClientView) : HexDe
                 buf.writeBoolean(hasHex)
                 buf.writeInt(undoSize)
                 buf.writeInt(undoIndex)
+                buf.writeSelection(selection)
+                buf.writeInt(viewStartIndex)
             }
         }
     }

Common/src/main/kotlin/gay/object/hexdebug/splicing/Selection.kt

@@ -1,5 +1,6 @@
 package gay.`object`.hexdebug.splicing
 
+import net.minecraft.network.FriendlyByteBuf
 import java.util.*
 import kotlin.math.max
 import kotlin.math.min
@@ -88,3 +89,23 @@ sealed class Selection private constructor(val from: Int, open val to: Int?) {
         }
     }
 }
+
+/** Writes an optional [Selection] to the buffer. */
+fun FriendlyByteBuf.writeSelection(selection: Selection?) {
+    writeNullable(selection) { buf, value ->
+        value.also {
+            buf.writeInt(it.from)
+            buf.writeNullable(it.to, FriendlyByteBuf::writeInt)
+        }
+    }
+}
+
+/** Reads an optional [Selection] from the buffer. */
+fun FriendlyByteBuf.readSelection(): Selection? {
+    return readNullable { buf ->
+        Selection.of(
+            from = buf.readInt(),
+            to = buf.readNullable(FriendlyByteBuf::readInt),
+        )
+    }
+}

Common/src/main/kotlin/gay/object/hexdebug/splicing/SplicingTableAction.kt

@@ -84,10 +84,7 @@ enum class SplicingTableAction(val value: Value<*>) {
         test = { _, _ -> undoSize > 1 && undoIndex > 0 },
         validate = { undoStack.size > 1 && undoStack.index > 0 },
     ) {
-        val state = undoStack.undo()
-        if (state != null) {
-            selection = state.applyTo(this, selection)
-        }
+        undoStack.undo()?.applyTo(this)
     }),
 
     REDO(Value(
@@ -96,10 +93,7 @@ enum class SplicingTableAction(val value: Value<*>) {
         test = { _, _ -> undoSize > 1 && undoIndex < undoSize - 1 },
         validate = { undoStack.size > 1 && undoStack.index < undoStack.stack.lastIndex },
     ) {
-        val state = undoStack.redo()
-        if (state != null) {
-            selection = state.applyTo(this, selection)
-        }
+        undoStack.redo()?.applyTo(this)
     }),
 
     // rw list range
@@ -112,7 +106,9 @@ enum class SplicingTableAction(val value: Value<*>) {
     ) {
         list.add(typedSelection.end, list.removeAt(typedSelection.start - 1))
         if (writeList(list)) {
-            selection = typedSelection.moveBy(-1)
+            selection = typedSelection.moveBy(-1)?.also {
+                makeIotaVisible(it.start)
+            }
             pushUndoState(
                 list = Some(list),
                 selection = Some(selection),
@@ -128,7 +124,9 @@ enum class SplicingTableAction(val value: Value<*>) {
     ) {
         list.add(typedSelection.start, list.removeAt(typedSelection.end + 1))
         if (writeList(list)) {
-            selection = typedSelection.moveBy(1)
+            selection = typedSelection.moveBy(1)?.also {
+                makeIotaVisible(it.lastIndex)
+            }
             pushUndoState(
                 list = Some(list),
                 selection = Some(selection),
@@ -139,7 +137,9 @@ enum class SplicingTableAction(val value: Value<*>) {
     DUPLICATE(Value(ReadWriteListRange, consumesMedia = true) {
         list.addAll(typedSelection.end + 1, typedSelection.subList(list))
         if (writeList(list)) {
-            selection = Selection.withSize(typedSelection.end + 1, typedSelection.size)
+            selection = Selection.withSize(typedSelection.end + 1, typedSelection.size)?.also {
+                makeIotaVisible(it.end)
+            }
             pushUndoState(
                 list = Some(list),
                 selection = Some(selection),
@@ -150,7 +150,9 @@ enum class SplicingTableAction(val value: Value<*>) {
     DELETE(Value(ReadWriteListRange, consumesMedia = true) {
         typedSelection.mutableSubList(list).clear()
         if (writeList(list)) {
-            selection = Selection.edge(typedSelection.start)
+            selection = Selection.edge(typedSelection.start)?.also {
+                makeEdgeVisible(it.index)
+            }
             pushUndoState(
                 list = Some(list),
                 selection = Some(selection),
@@ -165,7 +167,9 @@ enum class SplicingTableAction(val value: Value<*>) {
         typedSelection.mutableSubList(list).clear()
         if (isClipboardTransferSafe(iota) && writeClipboard(iota)) {
             if (writeList(list)) {
-                selection = Selection.edge(typedSelection.start)
+                selection = Selection.edge(typedSelection.start)?.also {
+                    makeEdgeVisible(it.index)
+                }
                 pushUndoState(
                     list = Some(list),
                     clipboard = Some(iota),
@@ -196,7 +200,9 @@ enum class SplicingTableAction(val value: Value<*>) {
             add(clipboard)
         }
         if (isClipboardTransferSafe(clipboard) && writeList(list)) {
-            selection = Selection.edge(typedSelection.start + 1)
+            selection = Selection.edge(typedSelection.start + 1)?.also {
+                makeEdgeVisible(it.index)
+            }
             pushUndoState(
                 list = Some(list),
                 selection = Some(selection),
@@ -214,7 +220,9 @@ enum class SplicingTableAction(val value: Value<*>) {
             addAll(values)
         }
         if (isClipboardTransferSafe(clipboard) && writeList(list)) {
-            selection = Selection.edge(typedSelection.start + values.size)
+            selection = Selection.edge(typedSelection.start + values.size)?.also {
+                makeEdgeVisible(it.index)
+            }
             pushUndoState(
                 list = Some(list),
                 selection = Some(selection),

Common/src/main/kotlin/gay/object/hexdebug/splicing/SplicingTableData.kt

@@ -70,7 +70,28 @@ open class SplicingTableData(
         selection: Option<Selection?> = None(),
     ) {
         // copy list to avoid mutability issues
-        undoStack.push(UndoStack.Entry(list.map { it.toList() }, clipboard, selection))
+        undoStack.push(UndoStack.Entry(
+            list = list.map { it.toList() },
+            clipboard = clipboard,
+            selection = selection,
+        ))
+    }
+
+    fun makeIotaVisible(index: Int) {
+        when {
+            index < viewStartIndex -> viewStartIndex = index
+            index > viewEndIndex -> viewEndIndex = index
+        }
+    }
+
+    fun makeEdgeVisible(index: Int) {
+        // index refers to the cell to the right of this edge
+        when {
+            // an edge is visible on the LEFT side if the cell to the RIGHT is visible
+            index < viewStartIndex -> viewStartIndex = index
+            // or on the RIGHT side if the cell to the LEFT is visible
+            index - 1 > viewEndIndex -> viewEndIndex = index - 1
+        }
     }
 
     fun writeList(value: List<Iota>) = writeIota(listWriter, ListIota(value))

Common/src/main/kotlin/gay/object/hexdebug/splicing/UndoStack.kt

@@ -47,10 +47,10 @@ data class UndoStack(
     ) {
         val isNotEmpty = list is Some || clipboard is Some || selection is Some
 
-        fun applyTo(data: SplicingTableData, defaultSelection: Selection?): Selection? = data.let {
+        fun applyTo(data: SplicingTableData) {
             list.ifPresent(data::writeList)
             clipboard.ifPresent(data::writeClipboard)
-            selection.getOrElse(defaultSelection)
+            selection.ifPresent { data.selection = it }
         }
     }
 }