From abfb6b219b575fa63729feafb2fe6b930519a5b2 Mon Sep 17 00:00:00 2001 From: Jake Potrebic Date: Fri, 8 Dec 2023 21:48:02 -0800 Subject: [PATCH] more work on adventure codecs --- ...tial-work-on-native-Adventure-codecs.patch | 174 +++++------------- 1 file changed, 41 insertions(+), 133 deletions(-) diff --git a/patches/server/0420-initial-work-on-native-Adventure-codecs.patch b/patches/server/0420-initial-work-on-native-Adventure-codecs.patch index c211c454d5..f811852da0 100644 --- a/patches/server/0420-initial-work-on-native-Adventure-codecs.patch +++ b/patches/server/0420-initial-work-on-native-Adventure-codecs.patch @@ -11,30 +11,24 @@ public net.minecraft.network.chat.contents.TranslatableContents filterAllowedArg diff --git a/src/main/java/io/papermc/paper/adventure/AdventureCodecs.java b/src/main/java/io/papermc/paper/adventure/AdventureCodecs.java new file mode 100644 -index 0000000000000000000000000000000000000000..1a13bf3b79b2d11e4ce6cc46eff65fe81a05a1ad +index 0000000000000000000000000000000000000000..87ad79ae42595116a0c1976c418a184cf0d6ddba --- /dev/null +++ b/src/main/java/io/papermc/paper/adventure/AdventureCodecs.java -@@ -0,0 +1,365 @@ +@@ -0,0 +1,273 @@ +package io.papermc.paper.adventure; + -+import com.google.common.base.Suppliers; +import com.mojang.datafixers.util.Either; +import com.mojang.serialization.Codec; +import com.mojang.serialization.DataResult; -+import com.mojang.serialization.DynamicOps; +import com.mojang.serialization.MapCodec; -+import com.mojang.serialization.MapLike; -+import com.mojang.serialization.RecordBuilder; +import com.mojang.serialization.codecs.RecordCodecBuilder; +import java.io.IOException; +import java.util.Collections; +import java.util.List; -+import java.util.Locale; +import java.util.Optional; +import java.util.function.Consumer; +import java.util.function.Function; -+import java.util.function.Supplier; -+import java.util.stream.Stream; ++import java.util.function.Predicate; +import net.kyori.adventure.key.Key; +import net.kyori.adventure.text.Component; +import net.kyori.adventure.text.KeybindComponent; @@ -48,7 +42,6 @@ index 0000000000000000000000000000000000000000..1a13bf3b79b2d11e4ce6cc46eff65fe8 +import net.kyori.adventure.text.format.Style; +import net.kyori.adventure.text.format.TextColor; +import net.kyori.adventure.text.format.TextDecoration; -+import net.kyori.adventure.translation.GlobalTranslator; +import net.minecraft.core.UUIDUtil; +import net.minecraft.core.registries.BuiltInRegistries; +import net.minecraft.nbt.CompoundTag; @@ -66,15 +59,13 @@ index 0000000000000000000000000000000000000000..1a13bf3b79b2d11e4ce6cc46eff65fe8 +import org.intellij.lang.annotations.Subst; + +import static net.kyori.adventure.text.Component.text; ++import static net.minecraft.util.ExtraCodecs.recursive; +import static net.minecraft.util.ExtraCodecs.strictOptionalField; + +@DefaultQualifier(NonNull.class) +public final class AdventureCodecs { + -+ private static final MapCodec COMPONENT_MAP_CODEC = new RecursiveMapCodec<>("adventure Component", c -> createCodec(c, false)); -+ public static final Codec COMPONENT_CODEC = indirectCodec(COMPONENT_MAP_CODEC.codec()); -+ private static final MapCodec RENDERING_COMPONENT_MAP_CODEC = new RecursiveMapCodec<>("rendering adventure Component", c -> createCodec(c, true)); -+ public static final Codec RENDERING_COMPONENT_CODEC = indirectCodec(RENDERING_COMPONENT_MAP_CODEC.codec()); ++ public static final Codec COMPONENT_CODEC = recursive("adventure Component", AdventureCodecs::createCodec); + + private static final Codec TEXT_COLOR_CODEC = Codec.STRING.comapFlatMap(s -> { + if (s.startsWith("#")) { @@ -209,107 +200,57 @@ index 0000000000000000000000000000000000000000..1a13bf3b79b2d11e4ce6cc46eff65fe8 + return style -> Optional.ofNullable(getter.apply(style)); + } + -+ private static final MapCodec TEXT_COMPONENT_CODEC = RecordCodecBuilder.mapCodec((instance) -> { ++ private static final MapCodec TEXT_COMPONENT_MAP_CODEC = RecordCodecBuilder.mapCodec((instance) -> { + return instance.group(Codec.STRING.fieldOf("text").forGetter(TextComponent::content)).apply(instance, Component::text); + }); + private static final Codec PRIMITIVE_ARG_CODEC = ExtraCodecs.validate(ExtraCodecs.JAVA, TranslatableContents::filterAllowedArguments); -+ private static Codec argCodec(final Codec componentCodec) { -+ return Codec.either(PRIMITIVE_ARG_CODEC, componentCodec).xmap((either) -> { -+ return either.map((object) -> { -+ if (object instanceof final Integer integer) { -+ return text(integer); -+ } else if (object instanceof final Long l) { -+ return text(l); -+ } else if (object instanceof final String s) { -+ return text(s); -+ } else if (object instanceof final Boolean bool) { -+ return text(bool); -+ } else if (object instanceof final Float f) { -+ return text(f); -+ } else if (object instanceof final Double d) { -+ return text(d); -+ } else if (object instanceof final Short s) { -+ return text(s); -+ } else { -+ throw new IllegalStateException(); -+ } -+ }, (text) -> text); -+ }, Either::right); -+ } -+ private static MapCodec translatableComponentCodec(final Codec componentCodec) { -+ return RecordCodecBuilder.mapCodec((instance) -> { -+ return instance.group( -+ Codec.STRING.fieldOf("translate").forGetter(TranslatableComponent::key), -+ Codec.STRING.optionalFieldOf("fallback").forGetter(nullableGetter(TranslatableComponent::fallback)), -+ strictOptionalField(argCodec(componentCodec).listOf(), "with").forGetter(c -> c.args().isEmpty() ? Optional.empty() : Optional.of(c.args())) -+ ).apply(instance, (key, fallback, components) -> { -+ return Component.translatable(key, components.orElse(Collections.emptyList())).fallback(fallback.orElse(null)); -+ }); ++ private static final Codec ARG_CODEC = Codec.either(PRIMITIVE_ARG_CODEC, COMPONENT_CODEC).xmap((primitiveOrComponent) -> { ++ return primitiveOrComponent.map(o -> text(String.valueOf(o)), Function.identity()); // just toString all primitives (not 100% correct to vanilla spec) ++ }, Either::right); ++ private static final MapCodec TRANSLATABLE_COMPONENT_MAP_CODEC = RecordCodecBuilder.mapCodec((instance) -> { ++ return instance.group( ++ Codec.STRING.fieldOf("translate").forGetter(TranslatableComponent::key), ++ Codec.STRING.optionalFieldOf("fallback").forGetter(nullableGetter(TranslatableComponent::fallback)), ++ strictOptionalField(ARG_CODEC.listOf(), "with").forGetter(c -> c.args().isEmpty() ? Optional.empty() : Optional.of(c.args())) ++ ).apply(instance, (key, fallback, components) -> { ++ return Component.translatable(key, components.orElse(Collections.emptyList())).fallback(fallback.orElse(null)); + }); -+ } -+ private static MapCodec renderingTranslatableComponentCodec(final Codec componentCodec) { -+ return new MapCodec<>() { -+ @Override -+ public Stream keys(final DynamicOps ops) { -+ return COMPONENT_MAP_CODEC.keys(ops); -+ } ++ }); + -+ @Override -+ public DataResult decode(final DynamicOps ops, final MapLike input) { -+ return DataResult.error(() -> "Cannot decode using the rendering translatable component codec"); -+ } ++ private static final MapCodec KEYBIND_COMPONENT_MAP_CODEC = KeybindContents.CODEC.xmap(k -> Component.keybind(k.getName()), k -> new KeybindContents(k.keybind())); ++ private static final MapCodec SCORE_COMPONENT_MAP_CODEC = ScoreContents.INNER_CODEC.xmap(s -> Component.score(s.getName(), s.getObjective()), s -> new ScoreContents(s.name(), s.objective())); ++ private static final MapCodec SELECTOR_COMPONENT_MAP_CODEC = RecordCodecBuilder.mapCodec((instance) -> { ++ return instance.group( ++ Codec.STRING.fieldOf("selector").forGetter(SelectorComponent::pattern), ++ strictOptionalField(COMPONENT_CODEC, "separator").forGetter(nullableGetter(SelectorComponent::separator)) ++ ).apply(instance, (selector, component) -> Component.selector(selector, component.orElse(null))); ++ }); + -+ @Override -+ public RecordBuilder encode(final TranslatableComponent input, final DynamicOps ops, final RecordBuilder prefix) { -+ final Component rendered = GlobalTranslator.render(input, Locale.US); // TODO get player's locale somehow -+ return COMPONENT_MAP_CODEC.encode(rendered, ops, prefix); // all render-able translatables should be gone, safe to use the non-rendering codec -+ } -+ }; -+ } -+ private static final MapCodec KEYBIND_COMPONENT_CODEC = KeybindContents.CODEC.xmap(k -> Component.keybind(k.getName()), k -> new KeybindContents(k.keybind())); -+ private static final MapCodec SCORE_COMPONENT_CODEC = ScoreContents.INNER_CODEC.xmap(s -> Component.score(s.getName(), s.getObjective()), s -> new ScoreContents(s.name(), s.objective())); -+ private static MapCodec selectorComponentCodec(final Codec componentCodec) { -+ return RecordCodecBuilder.mapCodec((instance) -> { -+ return instance.group( -+ Codec.STRING.fieldOf("selector").forGetter(SelectorComponent::pattern), -+ strictOptionalField(componentCodec, "separator").forGetter(nullableGetter(SelectorComponent::separator)) -+ ).apply(instance, (selector, component) -> Component.selector(selector, component.orElse(null))); -+ }); -+ } -+ -+ private record ComponentType(Function, MapCodec> codec, String id) implements StringRepresentable { ++ private record ComponentType(MapCodec codec, Predicate test, String id) implements StringRepresentable { + @Override + public String getSerializedName() { + return this.id; + } + } + -+ private static final ComponentType PLAIN = new ComponentType<>($ -> TEXT_COMPONENT_CODEC, "text"); -+ private static final ComponentType TRANSLATABLE = new ComponentType<>(AdventureCodecs::translatableComponentCodec, "translatable"); -+ private static final ComponentType RENDERING_TRANSLATABLE = new ComponentType<>(AdventureCodecs::renderingTranslatableComponentCodec, "translatable"); -+ private static final ComponentType KEYBIND = new ComponentType<>($ -> KEYBIND_COMPONENT_CODEC, "keybind"); -+ private static final ComponentType SCORE = new ComponentType<>($ -> SCORE_COMPONENT_CODEC, "score"); -+ private static final ComponentType SELECTOR = new ComponentType<>(AdventureCodecs::selectorComponentCodec, "selector"); ++ private static final ComponentType PLAIN = new ComponentType<>(TEXT_COMPONENT_MAP_CODEC, TextComponent.class::isInstance, "text"); ++ private static final ComponentType TRANSLATABLE = new ComponentType<>(TRANSLATABLE_COMPONENT_MAP_CODEC, TranslatableComponent.class::isInstance, "translatable"); ++ private static final ComponentType KEYBIND = new ComponentType<>(KEYBIND_COMPONENT_MAP_CODEC, KeybindComponent.class::isInstance, "keybind"); ++ private static final ComponentType SCORE = new ComponentType<>(SCORE_COMPONENT_MAP_CODEC, ScoreComponent.class::isInstance, "score"); ++ private static final ComponentType SELECTOR = new ComponentType<>(SELECTOR_COMPONENT_MAP_CODEC, SelectorComponent.class::isInstance, "selector"); + -+ private static MapCodec createCodec(final Codec selfCodec, final boolean renderTranslatables) { -+ final ComponentType[] types = new ComponentType[]{PLAIN, TRANSLATABLE, KEYBIND, SCORE}; -+ final MapCodec legacyCodec = ComponentSerialization.createLegacyComponentMatcher(types, ct -> ct.codec().apply(selfCodec), component -> { -+ if (component instanceof TextComponent) { -+ return PLAIN; -+ } else if (component instanceof TranslatableComponent) { -+ return renderTranslatables ? RENDERING_TRANSLATABLE : TRANSLATABLE; -+ } else if (component instanceof KeybindComponent) { -+ return KEYBIND; -+ } else if (component instanceof ScoreComponent) { -+ return SCORE; -+ } else if (component instanceof SelectorComponent) { -+ return SELECTOR; -+ } else { -+ throw new IllegalStateException(); ++ private static Codec createCodec(final Codec selfCodec) { ++ final ComponentType[] types = new ComponentType[]{PLAIN, TRANSLATABLE, KEYBIND, SCORE, SELECTOR}; ++ final MapCodec legacyCodec = ComponentSerialization.createLegacyComponentMatcher(types, ComponentType::codec, component -> { ++ for (final ComponentType type : types) { ++ if (type.test().test(component)) { ++ return type; ++ } + } ++ throw new IllegalStateException("Unexpected component type " + component); + }, "type"); + -+ return RecordCodecBuilder.mapCodec((instance) -> { ++ final Codec directCodec = RecordCodecBuilder.create((instance) -> { + return instance.group( + legacyCodec.forGetter(Function.identity()), + strictOptionalField(ExtraCodecs.nonEmptyList(selfCodec.listOf()), "extra", List.of()).forGetter(Component::children), @@ -318,10 +259,8 @@ index 0000000000000000000000000000000000000000..1a13bf3b79b2d11e4ce6cc46eff65fe8 + return component.style(style).children(children); + }); + }); -+ } + -+ private static Codec indirectCodec(final Codec selfCodec) { -+ return Codec.either(Codec.either(Codec.STRING, ExtraCodecs.nonEmptyList(selfCodec.listOf())), selfCodec).xmap((stringOrListOrComponent) -> { ++ return Codec.either(Codec.either(Codec.STRING, ExtraCodecs.nonEmptyList(selfCodec.listOf())), directCodec).xmap((stringOrListOrComponent) -> { + return stringOrListOrComponent.map((stringOrList) -> stringOrList.map(Component::text, AdventureCodecs::createFromList), Function.identity()); + }, (text) -> { + final @Nullable String string = tryCollapseToString(text); @@ -346,37 +285,6 @@ index 0000000000000000000000000000000000000000..1a13bf3b79b2d11e4ce6cc46eff65fe8 + return component; + } + -+ static class RecursiveMapCodec extends MapCodec { -+ -+ private final String name; -+ private final Supplier> wrapped; -+ -+ RecursiveMapCodec(final String name, final Function, MapCodec> factory) { -+ this.name = name; -+ this.wrapped = Suppliers.memoize(() -> factory.apply(this.codec())); -+ } -+ -+ @Override -+ public Stream keys(final DynamicOps ops) { -+ return this.wrapped.get().keys(ops); -+ } -+ -+ @Override -+ public DataResult decode(final DynamicOps ops, final MapLike input) { -+ return this.wrapped.get().decode(ops, input); -+ } -+ -+ @Override -+ public RecordBuilder encode(final T input, final DynamicOps ops, final RecordBuilder prefix) { -+ return this.wrapped.get().encode(input, ops, prefix); -+ } -+ -+ @Override -+ public String toString() { -+ return "RecursiveMapCodec[" + this.name + "]"; -+ } -+ } -+ + private AdventureCodecs() { + } +}