ref: switch from adventure NBT to LinBus (#2778)

* Switch from adventure NBT to LinBus

* Cleanup

* Clean

* Reimplement NumberTag behaviour

* Use 0.1.0 release

* Fix build, remove fawe tags

---------

Co-authored-by: Octavia Togami <octavia.togami@gmail.com>

Author: dordsor21

buildSrc/src/main/kotlin/LibsConfig.kt

@@ -40,8 +40,7 @@ fun Project.applyLibrariesConfiguration() {
 
     val relocations = mapOf(
         "net.kyori.text" to "com.sk89q.worldedit.util.formatting.text",
-        "net.kyori.minecraft" to "com.sk89q.worldedit.util.kyori",
-        "net.kyori.adventure.nbt" to "com.sk89q.worldedit.util.nbt"
+        "net.kyori.minecraft" to "com.sk89q.worldedit.util.kyori"
 
     )
 
@@ -53,9 +52,14 @@ fun Project.applyLibrariesConfiguration() {
             exclude(dependency("com.google.guava:guava"))
             exclude(dependency("com.google.code.gson:gson"))
             exclude(dependency("com.google.errorprone:error_prone_annotations"))
+            exclude(dependency("com.google.guava:failureaccess"))
             exclude(dependency("org.checkerframework:checker-qual"))
+            exclude(dependency("org.jetbrains:annotations"))
             exclude(dependency("org.apache.logging.log4j:log4j-api"))
             exclude(dependency("com.google.code.findbugs:jsr305"))
+            exclude {
+                it.moduleGroup == "org.jetbrains.kotlin"
+            }
         }
 
         relocations.forEach { (from, to) ->
@@ -67,11 +71,19 @@ fun Project.applyLibrariesConfiguration() {
             .filterIsInstance<ModuleDependency>()
             .map { it.copy() }
             .map { dependency ->
-                dependency.artifact {
-                    name = dependency.name
-                    type = artifactType
-                    extension = "jar"
-                    classifier = artifactType
+                val category = dependency.attributes.getAttribute(Category.CATEGORY_ATTRIBUTE)?.name
+                if (category == Category.REGULAR_PLATFORM || category == Category.ENFORCED_PLATFORM) {
+                    return@map dependency
+                }
+                try {
+                    dependency.artifact {
+                        name = dependency.name
+                        type = artifactType
+                        extension = "jar"
+                        classifier = artifactType
+                    }
+                } catch (e: Exception) {
+                    throw RuntimeException("Failed to add artifact to dependency: $dependency", e)
                 }
                 dependency
             }
@@ -85,6 +97,10 @@ fun Project.applyLibrariesConfiguration() {
         from({
             altConfigFiles("sources")
         })
+
+        // Yeet module-info's
+        exclude("module-info.java")
+
         relocations.forEach { (from, to) ->
             val filePattern = Regex("(.*)${from.replace('.', '/')}((?:/|$).*)")
             val textPattern = Regex.fromLiteral(from)

gradle/libs.versions.toml

@@ -40,6 +40,7 @@ paperlib = "1.0.8"
 paster = "1.1.6"
 vault = "1.7.1"
 serverlib = "2.3.6"
+linbus = "0.1.0"
 ## Internal
 text-adapter = "3.0.6"
 text = "3.0.4"
@@ -78,7 +79,6 @@ bstatsBase = { group = "org.bstats", name = "bstats-base", version.ref = "bstats
 bstatsBukkit = { group = "org.bstats", name = "bstats-bukkit", version.ref = "bstats" }
 sparsebitset = { group = "com.zaxxer", name = "SparseBitSet", version.ref = "sparsebitset" }
 parallelgzip = { group = "org.anarres", name = "parallelgzip", version.ref = "parallelgzip" }
-adventureNbt = { group = "net.kyori", name = "adventure-nbt", version.ref = "adventure" }
 truezip = { group = "de.schlichtherle", name = "truezip", version.ref = "truezip" }
 autoValueAnnotations = { group = "com.google.auto.value", name = "auto-value-annotations", version.ref = "auto-value" }
 autoValue = { group = "com.google.auto.value", name = "auto-value", version.ref = "auto-value" }
@@ -101,6 +101,11 @@ paster = { group = "com.intellectualsites.paster", name = "Paster", version.ref
 vault = { group = "com.github.MilkBowl", name = "VaultAPI", version.ref = "vault" }
 serverlib = { group = "dev.notmyfault.serverlib", name = "ServerLib", version.ref = "serverlib" }
 checkerqual = { group = "org.checkerframework", name = "checker-qual", version.ref = "checkerqual" }
+linBus-bom = { group = "org.enginehub.lin-bus", name = "lin-bus-bom", version.ref = "linbus" }
+linBus-common = { group = "org.enginehub.lin-bus", name = "lin-bus-common" }
+linBus-stream = { group = "org.enginehub.lin-bus", name = "lin-bus-stream" }
+linBus-tree = { group = "org.enginehub.lin-bus", name = "lin-bus-tree" }
+linBus-format-snbt = { group = "org.enginehub.lin-bus.format", name = "lin-bus-format-snbt" }
 
 # Internal
 ## Text

worldedit-bukkit/adapters/adapter-1_19_4/src/main/java/com/sk89q/worldedit/bukkit/adapter/ext/fawe/v1_19_R3/PaperweightAdapter.java

@@ -35,7 +35,6 @@
 import com.mojang.datafixers.DataFixerBuilder;
 import com.mojang.datafixers.schemas.Schema;
 import com.mojang.serialization.Dynamic;
-import com.sk89q.worldedit.util.nbt.CompoundBinaryTag;
 import net.minecraft.core.Direction;
 import net.minecraft.nbt.NbtOps;
 import net.minecraft.network.chat.Component;
@@ -48,7 +47,9 @@
 import net.minecraft.world.item.DyeColor;
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
+import org.enginehub.linbus.tree.LinCompoundTag;
 
+import javax.annotation.Nullable;
 import java.lang.reflect.Type;
 import java.util.ArrayList;
 import java.util.EnumMap;
@@ -62,7 +63,6 @@
 import java.util.UUID;
 import java.util.concurrent.Executor;
 import java.util.stream.Collectors;
-import javax.annotation.Nullable;
 
 /**
  * Handles converting all Pre 1.13.2 data using the Legacy DataFix System (ported to 1.13.2)
@@ -78,16 +78,15 @@
 @SuppressWarnings({ "rawtypes", "unchecked" })
 class PaperweightDataConverters extends DataFixerBuilder implements com.sk89q.worldedit.world.DataFixer {
 
-    //FAWE start - BinaryTag
     @SuppressWarnings("unchecked")
     @Override
     public <T> T fixUp(FixType<T> type, T original, int srcVer) {
         if (type == FixTypes.CHUNK) {
-            return (T) fixChunk((CompoundBinaryTag) original, srcVer);
+            return (T) fixChunk((LinCompoundTag) original, srcVer);
         } else if (type == FixTypes.BLOCK_ENTITY) {
-            return (T) fixBlockEntity((CompoundBinaryTag) original, srcVer);
+            return (T) fixBlockEntity((LinCompoundTag) original, srcVer);
         } else if (type == FixTypes.ENTITY) {
-            return (T) fixEntity((CompoundBinaryTag) original, srcVer);
+            return (T) fixEntity((LinCompoundTag) original, srcVer);
         } else if (type == FixTypes.BLOCK_STATE) {
             return (T) fixBlockState((String) original, srcVer);
         } else if (type == FixTypes.ITEM_TYPE) {
@@ -98,24 +97,23 @@ public <T> T fixUp(FixType<T> type, T original, int srcVer) {
         return original;
     }
 
-    private CompoundBinaryTag fixChunk(CompoundBinaryTag originalChunk, int srcVer) {
-        net.minecraft.nbt.CompoundTag tag = (net.minecraft.nbt.CompoundTag) adapter.fromNativeBinary(originalChunk);
+    private LinCompoundTag fixChunk(LinCompoundTag originalChunk, int srcVer) {
+        net.minecraft.nbt.CompoundTag tag = (net.minecraft.nbt.CompoundTag) adapter.fromNativeLin(originalChunk);
         net.minecraft.nbt.CompoundTag fixed = convert(LegacyType.CHUNK, tag, srcVer);
-        return (CompoundBinaryTag) adapter.toNativeBinary(fixed);
+        return (LinCompoundTag) adapter.toNativeLin(fixed);
     }
 
-    private CompoundBinaryTag fixBlockEntity(CompoundBinaryTag origTileEnt, int srcVer) {
-        net.minecraft.nbt.CompoundTag tag = (net.minecraft.nbt.CompoundTag) adapter.fromNativeBinary(origTileEnt);
+    private LinCompoundTag fixBlockEntity(LinCompoundTag origTileEnt, int srcVer) {
+        net.minecraft.nbt.CompoundTag tag = (net.minecraft.nbt.CompoundTag) adapter.fromNativeLin(origTileEnt);
         net.minecraft.nbt.CompoundTag fixed = convert(LegacyType.BLOCK_ENTITY, tag, srcVer);
-        return (CompoundBinaryTag) adapter.toNativeBinary(fixed);
+        return (LinCompoundTag) adapter.toNativeLin(fixed);
     }
 
-    private CompoundBinaryTag fixEntity(CompoundBinaryTag origEnt, int srcVer) {
-        net.minecraft.nbt.CompoundTag tag = (net.minecraft.nbt.CompoundTag) adapter.fromNativeBinary(origEnt);
+    private LinCompoundTag fixEntity(LinCompoundTag origEnt, int srcVer) {
+        net.minecraft.nbt.CompoundTag tag = (net.minecraft.nbt.CompoundTag) adapter.fromNativeLin(origEnt);
         net.minecraft.nbt.CompoundTag fixed = convert(LegacyType.ENTITY, tag, srcVer);
-        return (CompoundBinaryTag) adapter.toNativeBinary(fixed);
+        return (LinCompoundTag) adapter.toNativeLin(fixed);
     }
-    //FAWE end
 
     private String fixBlockState(String blockState, int srcVer) {
         net.minecraft.nbt.CompoundTag stateNBT = stateToNBT(blockState);

worldedit-bukkit/adapters/adapter-1_19_4/src/main/java/com/sk89q/worldedit/bukkit/adapter/ext/fawe/v1_19_R3/PaperweightDataConverters.java

@@ -19,25 +19,28 @@
 
 package com.sk89q.worldedit.bukkit.adapter.ext.fawe.v1_19_R3;
 
+import com.sk89q.jnbt.CompoundTag;
 import com.sk89q.worldedit.bukkit.BukkitAdapter;
 import com.sk89q.worldedit.internal.block.BlockStateIdAccess;
 import com.sk89q.worldedit.internal.wna.WorldNativeAccess;
 import com.sk89q.worldedit.util.SideEffect;
 import com.sk89q.worldedit.util.SideEffectSet;
-import com.sk89q.worldedit.util.nbt.CompoundBinaryTag;
 import com.sk89q.worldedit.world.block.BlockState;
 import net.minecraft.core.BlockPos;
+import net.minecraft.nbt.Tag;
 import net.minecraft.server.level.ChunkHolder;
 import net.minecraft.server.level.ServerLevel;
 import net.minecraft.world.level.block.Block;
+import net.minecraft.world.level.block.entity.BlockEntity;
 import net.minecraft.world.level.chunk.LevelChunk;
 import org.bukkit.craftbukkit.v1_19_R3.CraftWorld;
 import org.bukkit.craftbukkit.v1_19_R3.block.data.CraftBlockData;
 import org.bukkit.event.block.BlockPhysicsEvent;
+import org.enginehub.linbus.tree.LinCompoundTag;
 
+import javax.annotation.Nullable;
 import java.lang.ref.WeakReference;
 import java.util.Objects;
-import javax.annotation.Nullable;
 
 public class PaperweightWorldNativeAccess implements WorldNativeAccess<LevelChunk, net.minecraft.world.level.block.state.BlockState, BlockPos> {
     private static final int UPDATE = 1;
@@ -101,8 +104,15 @@ public void updateLightingForBlock(BlockPos position) {
     }
 
     @Override
-    public boolean updateTileEntity(final BlockPos position, final CompoundBinaryTag tag) {
-        return false;
+    public boolean updateTileEntity(BlockPos position, LinCompoundTag tag) {
+        // We will assume that the tile entity was created for us
+        BlockEntity tileEntity = getWorld().getBlockEntity(position);
+        if (tileEntity == null) {
+            return false;
+        }
+        Tag nativeTag = adapter.fromNative(new CompoundTag(tag));
+        PaperweightAdapter.readTagIntoTileEntity((net.minecraft.nbt.CompoundTag) nativeTag, tileEntity);
+        return true;
     }
 
     @Override

worldedit-bukkit/adapters/adapter-1_19_4/src/main/java/com/sk89q/worldedit/bukkit/adapter/ext/fawe/v1_19_R3/PaperweightWorldNativeAccess.java

@@ -35,9 +35,6 @@
 import com.sk89q.worldedit.util.SideEffect;
 import com.sk89q.worldedit.util.SideEffectSet;
 import com.sk89q.worldedit.util.formatting.text.Component;
-import com.sk89q.worldedit.util.nbt.BinaryTag;
-import com.sk89q.worldedit.util.nbt.CompoundBinaryTag;
-import com.sk89q.worldedit.util.nbt.StringBinaryTag;
 import com.sk89q.worldedit.world.RegenOptions;
 import com.sk89q.worldedit.world.biome.BiomeType;
 import com.sk89q.worldedit.world.block.BaseBlock;
@@ -83,6 +80,9 @@
 import org.bukkit.craftbukkit.v1_19_R3.inventory.CraftItemStack;
 import org.bukkit.craftbukkit.v1_19_R3.util.CraftNamespacedKey;
 import org.bukkit.entity.Player;
+import org.enginehub.linbus.tree.LinCompoundTag;
+import org.enginehub.linbus.tree.LinStringTag;
+import org.enginehub.linbus.tree.LinTag;
 
 import javax.annotation.Nullable;
 import java.lang.ref.WeakReference;
@@ -274,7 +274,7 @@ public BaseBlock getFullBlock(final Location location) {
             BlockEntity blockEntity = chunk.getBlockEntity(blockPos, LevelChunk.EntityCreationType.CHECK);
             if (blockEntity != null) {
                 net.minecraft.nbt.CompoundTag tag = blockEntity.saveWithId();
-                return state.toBaseBlock((CompoundBinaryTag) toNativeBinary(tag));
+                return state.toBaseBlock((LinCompoundTag) toNativeLin(tag));
             }
         }
 
@@ -302,14 +302,14 @@ public BaseEntity getEntity(org.bukkit.entity.Entity entity) {
 
         if (id != null) {
             EntityType type = com.sk89q.worldedit.world.entity.EntityTypes.get(id);
-            Supplier<CompoundBinaryTag> saveTag = () -> {
+            Supplier<LinCompoundTag> saveTag = () -> {
                 final net.minecraft.nbt.CompoundTag minecraftTag = new net.minecraft.nbt.CompoundTag();
                 PaperweightPlatformAdapter.readEntityIntoTag(mcEntity, minecraftTag);
                 //add Id for AbstractChangeSet to work
-                final CompoundBinaryTag tag = (CompoundBinaryTag) toNativeBinary(minecraftTag);
-                final Map<String, BinaryTag> tags = NbtUtils.getCompoundBinaryTagValues(tag);
-                tags.put("Id", StringBinaryTag.of(id));
-                return CompoundBinaryTag.from(tags);
+                final LinCompoundTag tag = (LinCompoundTag) toNativeLin(minecraftTag);
+                final Map<String, LinTag<?>> tags = NbtUtils.getLinCompoundTagValues(tag);
+                tags.put("Id", LinStringTag.of(id));
+                return LinCompoundTag.of(tags);
             };
             return new LazyBaseEntity(type, saveTag);
         } else {
@@ -514,7 +514,7 @@ protected ServerLevel getServerLevel(final World world) {
     public BaseItemStack adapt(org.bukkit.inventory.ItemStack itemStack) {
         final ItemStack nmsStack = CraftItemStack.asNMSCopy(itemStack);
         final BaseItemStack weStack = new BaseItemStack(BukkitAdapter.asItemType(itemStack.getType()), itemStack.getAmount());
-        weStack.setNbt(((CompoundBinaryTag) toNativeBinary(nmsStack.getTag())));
+        weStack.setNbt((LinCompoundTag) toNativeLin(nmsStack.getTag()));
         return weStack;
     }
 

worldedit-bukkit/adapters/adapter-1_19_4/src/main/java/com/sk89q/worldedit/bukkit/adapter/impl/fawe/v1_19_R3/PaperweightFaweAdapter.java

@@ -9,7 +9,6 @@
 import com.sk89q.worldedit.internal.wna.WorldNativeAccess;
 import com.sk89q.worldedit.util.SideEffect;
 import com.sk89q.worldedit.util.SideEffectSet;
-import com.sk89q.worldedit.util.nbt.CompoundBinaryTag;
 import com.sk89q.worldedit.world.block.BlockState;
 import net.minecraft.core.BlockPos;
 import net.minecraft.core.Direction;
@@ -24,6 +23,7 @@
 import org.bukkit.craftbukkit.v1_19_R3.CraftWorld;
 import org.bukkit.craftbukkit.v1_19_R3.block.data.CraftBlockData;
 import org.bukkit.event.block.BlockPhysicsEvent;
+import org.enginehub.linbus.tree.LinCompoundTag;
 
 import javax.annotation.Nullable;
 import java.lang.ref.WeakReference;
@@ -132,14 +132,14 @@ public void updateLightingForBlock(BlockPos blockPos) {
     }
 
     @Override
-    public boolean updateTileEntity(BlockPos blockPos, CompoundBinaryTag tag) {
+    public boolean updateTileEntity(BlockPos blockPos, LinCompoundTag tag) {
         // We will assume that the tile entity was created for us,
         // though we do not do this on the other versions
         BlockEntity blockEntity = getLevel().getBlockEntity(blockPos);
         if (blockEntity == null) {
             return false;
         }
-        net.minecraft.nbt.Tag nativeTag = paperweightFaweAdapter.fromNativeBinary(tag);
+        net.minecraft.nbt.Tag nativeTag = paperweightFaweAdapter.fromNativeLin(tag);
         blockEntity.load((CompoundTag) nativeTag);
         return true;
     }

worldedit-bukkit/adapters/adapter-1_19_4/src/main/java/com/sk89q/worldedit/bukkit/adapter/impl/fawe/v1_19_R3/PaperweightFaweWorldNativeAccess.java

@@ -732,7 +732,7 @@ public synchronized <T extends Future<T>> T call(IChunkSet set, Runnable finaliz
                         Iterator<CompoundTag> iterator = entities.iterator();
                         while (iterator.hasNext()) {
                             final CompoundTag nativeTag = iterator.next();
-                            final Map<String, Tag> entityTagMap = nativeTag.getValue();
+                            final Map<String, Tag<?, ?>> entityTagMap = nativeTag.getValue();
                             final StringTag idTag = (StringTag) entityTagMap.get("Id");
                             final ListTag posTag = (ListTag) entityTagMap.get("Pos");
                             final ListTag rotTag = (ListTag) entityTagMap.get("Rotation");

worldedit-bukkit/adapters/adapter-1_19_4/src/main/java/com/sk89q/worldedit/bukkit/adapter/impl/fawe/v1_19_R3/PaperweightGetBlocks.java

@@ -6,8 +6,8 @@
 import com.sk89q.jnbt.StringTag;
 import com.sk89q.jnbt.Tag;
 import com.sk89q.worldedit.bukkit.WorldEditPlugin;
-import com.sk89q.worldedit.util.nbt.CompoundBinaryTag;
 import net.minecraft.nbt.NumericTag;
+import org.enginehub.linbus.tree.LinCompoundTag;
 
 import java.util.ArrayList;
 import java.util.Collections;
@@ -36,17 +36,17 @@ public net.minecraft.nbt.CompoundTag get() {
 
     @Override
     @SuppressWarnings("unchecked")
-    public Map<String, Tag> getValue() {
+    public Map<String, Tag<?, ?>> getValue() {
         if (compoundTag == null) {
             compoundTag = (CompoundTag) WorldEditPlugin.getInstance().getBukkitImplAdapter().toNative(compoundTagSupplier.get());
         }
         return compoundTag.getValue();
     }
 
     @Override
-    public CompoundBinaryTag asBinaryTag() {
+    public LinCompoundTag toLinTag() {
         getValue();
-        return compoundTag.asBinaryTag();
+        return compoundTag.toLinTag();
     }
 
     public boolean containsKey(String key) {
@@ -94,10 +94,10 @@ public int asInt(String key) {
     }
 
     @SuppressWarnings("unchecked")
-    public List<Tag> getList(String key) {
+    public List<? extends Tag<?, ?>> getList(String key) {
         net.minecraft.nbt.Tag tag = compoundTagSupplier.get().get(key);
         if (tag instanceof net.minecraft.nbt.ListTag nbtList) {
-            ArrayList<Tag> list = new ArrayList<>();
+            ArrayList<Tag<?, ?>> list = new ArrayList<>();
             for (net.minecraft.nbt.Tag elem : nbtList) {
                 if (elem instanceof net.minecraft.nbt.CompoundTag compoundTag) {
                     list.add(new PaperweightLazyCompoundTag(compoundTag));
@@ -120,7 +120,7 @@ public ListTag getListTag(String key) {
     }
 
     @SuppressWarnings("unchecked")
-    public <T extends Tag> List<T> getList(String key, Class<T> listType) {
+    public <T extends Tag<?, ?>> List<T> getList(String key, Class<T> listType) {
         ListTag listTag = getListTag(key);
         if (listTag.getType().equals(listType)) {
             return (List<T>) listTag.getValue();