Skip to content

Commit 28daa6c

Browse files
MiniDiggerMiniDigger
committed
update adventure codecs, fixes click and hover events
this was PAIN
1 parent 67cc0e5 commit 28daa6c

File tree

1 file changed

+93
-111
lines changed

1 file changed

+93
-111
lines changed

‎paper-server/src/main/java/io/papermc/paper/adventure/AdventureCodecs.java

+93-111
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,17 @@
11
package io.papermc.paper.adventure;
22

3-
import com.google.gson.JsonElement;
4-
import com.google.gson.JsonParser;
5-
import com.mojang.brigadier.exceptions.CommandSyntaxException;
63
import com.mojang.datafixers.util.Either;
7-
import com.mojang.datafixers.util.Pair;
84
import com.mojang.serialization.Codec;
95
import com.mojang.serialization.DataResult;
10-
import com.mojang.serialization.DynamicOps;
11-
import com.mojang.serialization.JsonOps;
126
import com.mojang.serialization.MapCodec;
13-
import com.mojang.serialization.codecs.RecordCodecBuilder;
147
import java.util.Collections;
158
import java.util.List;
169
import java.util.Map;
1710
import java.util.Optional;
18-
import java.util.UUID;
1911
import java.util.function.Consumer;
2012
import java.util.function.Function;
2113
import java.util.function.Predicate;
14+
import com.mojang.serialization.codecs.RecordCodecBuilder;
2215
import net.kyori.adventure.key.Key;
2316
import net.kyori.adventure.text.BlockNBTComponent;
2417
import net.kyori.adventure.text.Component;
@@ -40,22 +33,16 @@
4033
import net.kyori.adventure.text.format.Style;
4134
import net.kyori.adventure.text.format.TextColor;
4235
import net.kyori.adventure.text.format.TextDecoration;
43-
import net.kyori.adventure.text.serializer.plain.PlainTextComponentSerializer;
4436
import net.minecraft.commands.arguments.selector.SelectorPattern;
4537
import net.minecraft.core.UUIDUtil;
4638
import net.minecraft.core.registries.BuiltInRegistries;
47-
import net.minecraft.nbt.CompoundTag;
48-
import net.minecraft.nbt.NbtOps;
49-
import net.minecraft.nbt.Tag;
50-
import net.minecraft.nbt.TagParser;
5139
import net.minecraft.network.RegistryFriendlyByteBuf;
5240
import net.minecraft.network.chat.ComponentSerialization;
5341
import net.minecraft.network.chat.contents.KeybindContents;
5442
import net.minecraft.network.chat.contents.ScoreContents;
5543
import net.minecraft.network.chat.contents.TranslatableContents;
5644
import net.minecraft.network.codec.ByteBufCodecs;
5745
import net.minecraft.network.codec.StreamCodec;
58-
import net.minecraft.resources.RegistryOps;
5946
import net.minecraft.util.ExtraCodecs;
6047
import net.minecraft.util.StringRepresentable;
6148
import net.minecraft.world.item.Item;
@@ -76,7 +63,7 @@
7663
@DefaultQualifier(NonNull.class)
7764
public final class AdventureCodecs {
7865

79-
public static final Codec<Component> COMPONENT_CODEC = recursive("adventure Component", AdventureCodecs::createCodec);
66+
public static final Codec<Component> COMPONENT_CODEC = recursive("adventure Component", AdventureCodecs::createCodec);
8067
public static final StreamCodec<RegistryFriendlyByteBuf, Component> STREAM_COMPONENT_CODEC = ByteBufCodecs.fromCodecWithRegistriesTrusted(COMPONENT_CODEC);
8168

8269
static final Codec<ShadowColor> SHADOW_COLOR_CODEC = ExtraCodecs.ARGB_COLOR_CODEC.xmap(ShadowColor::shadowColor, ShadowColor::value);
@@ -101,102 +88,92 @@ public final class AdventureCodecs {
10188
return Key.parseable(s) ? DataResult.success(Key.key(s)) : DataResult.error(() -> "Cannot convert " + s + " to adventure Key");
10289
}, Key::asString);
10390

104-
static final Codec<ClickEvent.Action> CLICK_EVENT_ACTION_CODEC = Codec.STRING.comapFlatMap(s -> {
105-
final ClickEvent.@Nullable Action value = ClickEvent.Action.NAMES.value(s);
106-
return value != null ? DataResult.success(value) : DataResult.error(() -> "Cannot convert " + s + " to adventure ClickEvent$Action");
107-
}, ClickEvent.Action.NAMES::keyOrThrow);
108-
static final Codec<ClickEvent> CLICK_EVENT_CODEC = RecordCodecBuilder.create((instance) -> {
109-
return instance.group(
110-
CLICK_EVENT_ACTION_CODEC.fieldOf("action").forGetter(ClickEvent::action),
111-
Codec.STRING.fieldOf("value").forGetter(ClickEvent::value)
112-
).apply(instance, ClickEvent::clickEvent);
113-
});
114-
115-
static Codec<HoverEvent.ShowEntity> showEntityCodec(final Codec<Component> componentCodec) {
116-
return RecordCodecBuilder.create((instance) -> {
117-
return instance.group(
118-
KEY_CODEC.fieldOf("type").forGetter(HoverEvent.ShowEntity::type),
119-
UUIDUtil.LENIENT_CODEC.fieldOf("id").forGetter(HoverEvent.ShowEntity::id),
120-
componentCodec.lenientOptionalFieldOf("name").forGetter(he -> Optional.ofNullable(he.name()))
121-
).apply(instance, (key, uuid, component) -> {
122-
return HoverEvent.ShowEntity.showEntity(key, uuid, component.orElse(null));
123-
});
124-
});
125-
}
126-
127-
static Codec<HoverEvent.ShowItem> showItemCodec(final Codec<Component> componentCodec) {
128-
return net.minecraft.network.chat.HoverEvent.ShowItem.CODEC.xmap(internal -> {
129-
@Subst("key") final String typeKey = internal.item().getItemHolder().unwrapKey().orElseThrow().location().toString();
130-
return HoverEvent.ShowItem.showItem(Key.key(typeKey), internal.item().getCount(), PaperAdventure.asAdventure(internal.item().getComponentsPatch()));
131-
}, adventure -> {
132-
final Item itemType = BuiltInRegistries.ITEM.getValue(PaperAdventure.asVanilla(adventure.item()));
133-
final Map<Key, DataComponentValue> dataComponentsMap = adventure.dataComponents();
134-
final ItemStack stack = new ItemStack(BuiltInRegistries.ITEM.wrapAsHolder(itemType), adventure.count(), PaperAdventure.asVanilla(dataComponentsMap));
135-
return new net.minecraft.network.chat.HoverEvent.ShowItem(stack);
136-
}).codec();
137-
}
138-
139-
static final HoverEventType<HoverEvent.ShowEntity> SHOW_ENTITY_HOVER_EVENT_TYPE = new HoverEventType<>(AdventureCodecs::showEntityCodec, HoverEvent.Action.SHOW_ENTITY, "show_entity", AdventureCodecs::legacyDeserializeEntity);
140-
static final HoverEventType<HoverEvent.ShowItem> SHOW_ITEM_HOVER_EVENT_TYPE = new HoverEventType<>(AdventureCodecs::showItemCodec, HoverEvent.Action.SHOW_ITEM, "show_item", AdventureCodecs::legacyDeserializeItem);
141-
static final HoverEventType<Component> SHOW_TEXT_HOVER_EVENT_TYPE = new HoverEventType<>(identity(), HoverEvent.Action.SHOW_TEXT, "show_text", (component, registryOps, codec) -> DataResult.success(component));
142-
static final Codec<HoverEventType<?>> HOVER_EVENT_TYPE_CODEC = StringRepresentable.fromValues(() -> new HoverEventType<?>[]{ SHOW_ENTITY_HOVER_EVENT_TYPE, SHOW_ITEM_HOVER_EVENT_TYPE, SHOW_TEXT_HOVER_EVENT_TYPE });
143-
144-
static DataResult<HoverEvent.ShowEntity> legacyDeserializeEntity(final Component component, final @Nullable RegistryOps<?> ops, final Codec<Component> componentCodec) {
145-
try {
146-
final CompoundTag tag = TagParser.parseCompoundFully(PlainTextComponentSerializer.plainText().serialize(component));
147-
final DynamicOps<JsonElement> dynamicOps = ops != null ? ops.withParent(JsonOps.INSTANCE) : JsonOps.INSTANCE;
148-
final DataResult<Component> entityNameResult = componentCodec.parse(dynamicOps, JsonParser.parseString(tag.getStringOr("name", "")));
149-
@Subst("key") final String keyString = tag.getStringOr("type", "");
150-
final UUID entityUUID = UUID.fromString(tag.getStringOr("id", ""));
151-
return entityNameResult.map(name -> HoverEvent.ShowEntity.showEntity(Key.key(keyString), entityUUID, name));
152-
} catch (final Exception ex) {
153-
return DataResult.error(() -> "Failed to parse tooltip: " + ex.getMessage());
91+
/*
92+
* Click
93+
*/
94+
static final MapCodec<ClickEvent> OPEN_URL_CODEC = mapCodec((instance) -> instance.group(
95+
Codec.STRING.fieldOf("url").forGetter(a -> !a.value().contains("://") ? "https://" + a.value() : a.value())
96+
).apply(instance, ClickEvent::openUrl));
97+
static final MapCodec<ClickEvent> OPEN_FILE_CODEC = mapCodec((instance) -> instance.group(
98+
Codec.STRING.fieldOf("path").forGetter(ClickEvent::value)
99+
).apply(instance, ClickEvent::openFile));
100+
static final MapCodec<ClickEvent> RUN_COMMAND_CODEC = mapCodec((instance) -> instance.group(
101+
Codec.STRING.fieldOf("command").forGetter(ClickEvent::value)
102+
).apply(instance, ClickEvent::runCommand));
103+
static final MapCodec<ClickEvent> SUGGEST_COMMAND_CODEC = mapCodec((instance) -> instance.group(
104+
Codec.STRING.fieldOf("command").forGetter(ClickEvent::value)
105+
).apply(instance, ClickEvent::suggestCommand));
106+
static final MapCodec<ClickEvent> CHANGE_PAGE_CODEC = mapCodec((instance) -> instance.group(
107+
ExtraCodecs.POSITIVE_INT.fieldOf("page").forGetter(a -> Integer.parseInt(a.value()))
108+
).apply(instance, ClickEvent::changePage));
109+
static final MapCodec<ClickEvent> COPY_TO_CLIPBOARD_CODEC = mapCodec((instance) -> instance.group(
110+
Codec.STRING.fieldOf("value").forGetter(ClickEvent::value)
111+
).apply(instance, ClickEvent::copyToClipboard));
112+
113+
static final ClickEventType OPEN_URL_CLICK_EVENT_TYPE = new ClickEventType(OPEN_URL_CODEC, "open_url");
114+
static final ClickEventType OPEN_FILE_CLICK_EVENT_TYPE = new ClickEventType(OPEN_FILE_CODEC, "open_file");
115+
static final ClickEventType RUN_COMMAND_CLICK_EVENT_TYPE = new ClickEventType(RUN_COMMAND_CODEC, "run_command");
116+
static final ClickEventType SUGGEST_COMMAND_CLICK_EVENT_TYPE = new ClickEventType(SUGGEST_COMMAND_CODEC, "suggest_command");
117+
static final ClickEventType CHANGE_PAGE_CLICK_EVENT_TYPE = new ClickEventType(CHANGE_PAGE_CODEC, "change_page");
118+
static final ClickEventType COPY_TO_CLIPBOARD_CLICK_EVENT_TYPE = new ClickEventType(COPY_TO_CLIPBOARD_CODEC, "copy_to_clipboard");
119+
static final Codec<ClickEventType> CLICK_EVENT_TYPE_CODEC = StringRepresentable.fromValues(() -> new ClickEventType[]{OPEN_URL_CLICK_EVENT_TYPE, OPEN_FILE_CLICK_EVENT_TYPE, RUN_COMMAND_CLICK_EVENT_TYPE, SUGGEST_COMMAND_CLICK_EVENT_TYPE, CHANGE_PAGE_CLICK_EVENT_TYPE, COPY_TO_CLIPBOARD_CLICK_EVENT_TYPE});
120+
121+
record ClickEventType(MapCodec<ClickEvent> codec, String id) implements StringRepresentable {
122+
@Override
123+
public String getSerializedName() {
124+
return this.id;
154125
}
155126
}
156127

157-
static DataResult<HoverEvent.ShowItem> legacyDeserializeItem(final Component component, final @Nullable RegistryOps<?> ops, final Codec<Component> componentCodec) {
158-
try {
159-
final CompoundTag tag = TagParser.parseCompoundFully(PlainTextComponentSerializer.plainText().serialize(component));
160-
final DynamicOps<Tag> dynamicOps = ops != null ? ops.withParent(NbtOps.INSTANCE) : NbtOps.INSTANCE;
161-
final DataResult<ItemStack> stackResult = ItemStack.CODEC.parse(dynamicOps, tag);
162-
return stackResult.map(stack -> {
163-
@Subst("key:value") final String location = stack.getItemHolder().unwrapKey().orElseThrow().location().toString();
164-
return HoverEvent.ShowItem.showItem(Key.key(location), stack.getCount(), PaperAdventure.asAdventure(stack.getComponentsPatch()));
165-
});
166-
} catch (final CommandSyntaxException ex) {
167-
return DataResult.error(() -> "Failed to parse item tag: " + ex.getMessage());
128+
private static final Function<ClickEvent, ClickEventType> GET_CLICK_EVENT_TYPE = he -> {
129+
if (he.action() == ClickEvent.Action.OPEN_URL) {
130+
return OPEN_URL_CLICK_EVENT_TYPE;
131+
} else if (he.action() == ClickEvent.Action.OPEN_FILE) {
132+
return OPEN_FILE_CLICK_EVENT_TYPE;
133+
} else if (he.action() == ClickEvent.Action.RUN_COMMAND) {
134+
return RUN_COMMAND_CLICK_EVENT_TYPE;
135+
} else if (he.action() == ClickEvent.Action.SUGGEST_COMMAND) {
136+
return SUGGEST_COMMAND_CLICK_EVENT_TYPE;
137+
} else if (he.action() == ClickEvent.Action.CHANGE_PAGE) {
138+
return CHANGE_PAGE_CLICK_EVENT_TYPE;
139+
} else if (he.action() == ClickEvent.Action.COPY_TO_CLIPBOARD) {
140+
return COPY_TO_CLIPBOARD_CLICK_EVENT_TYPE;
141+
} else {
142+
throw new IllegalStateException();
168143
}
169-
}
144+
};
170145

171-
@FunctionalInterface
172-
interface LegacyDeserializer<T> {
173-
DataResult<T> apply(Component component, @Nullable RegistryOps<?> ops, Codec<Component> componentCodec);
174-
}
146+
static final Codec<ClickEvent> CLICK_EVENT_CODEC = CLICK_EVENT_TYPE_CODEC.dispatch("action", GET_CLICK_EVENT_TYPE, ClickEventType::codec);
147+
148+
/*
149+
* HOVER
150+
*/
151+
static final MapCodec<HoverEvent<Component>> SHOW_TEXT_CODEC = mapCodec((instance) -> instance.group(
152+
COMPONENT_CODEC.fieldOf("value").forGetter(HoverEvent::value)
153+
).apply(instance, HoverEvent::showText));
154+
155+
static final MapCodec<HoverEvent<HoverEvent.ShowEntity>> SHOW_ENTITY_CODEC = mapCodec((instance) -> instance.group(
156+
KEY_CODEC.fieldOf("id").forGetter(a -> a.value().type()),
157+
UUIDUtil.LENIENT_CODEC.fieldOf("uuid").forGetter(a -> a.value().id()),
158+
COMPONENT_CODEC.lenientOptionalFieldOf("name").forGetter(a -> Optional.ofNullable(a.value().name()))
159+
).apply(instance, (key, uuid, component) -> HoverEvent.showEntity(key, uuid, component.orElse(null))));
160+
161+
static final MapCodec<HoverEvent<HoverEvent.ShowItem>> SHOW_ITEM_CODEC = net.minecraft.network.chat.HoverEvent.ShowItem.CODEC.xmap(internal -> {
162+
@Subst("key") final String typeKey = internal.item().getItemHolder().unwrapKey().orElseThrow().location().toString();
163+
return HoverEvent.showItem(Key.key(typeKey), internal.item().getCount(), PaperAdventure.asAdventure(internal.item().getComponentsPatch()));
164+
}, adventure -> {
165+
final Item itemType = BuiltInRegistries.ITEM.getValue(PaperAdventure.asVanilla(adventure.value().item()));
166+
final Map<Key, DataComponentValue> dataComponentsMap = adventure.value().dataComponents();
167+
final ItemStack stack = new ItemStack(BuiltInRegistries.ITEM.wrapAsHolder(itemType), adventure.value().count(), PaperAdventure.asVanilla(dataComponentsMap));
168+
return new net.minecraft.network.chat.HoverEvent.ShowItem(stack);
169+
});
175170

176-
record HoverEventType<V>(Function<Codec<Component>, MapCodec<HoverEvent<V>>> codec, String id, Function<Codec<Component>, MapCodec<HoverEvent<V>>> legacyCodec) implements StringRepresentable {
177-
HoverEventType(final Function<Codec<Component>, Codec<V>> contentCodec, final HoverEvent.Action<V> action, final String id, final LegacyDeserializer<V> legacyDeserializer) {
178-
this(cc -> contentCodec.apply(cc).xmap(v -> HoverEvent.hoverEvent(action, v), HoverEvent::value).fieldOf("contents"),
179-
id,
180-
codec -> (new Codec<HoverEvent<V>>() {
181-
public <D> DataResult<Pair<HoverEvent<V>, D>> decode(final DynamicOps<D> dynamicOps, final D object) {
182-
return codec.decode(dynamicOps, object).flatMap(pair -> {
183-
final DataResult<V> dataResult;
184-
if (dynamicOps instanceof final RegistryOps<D> registryOps) {
185-
dataResult = legacyDeserializer.apply(pair.getFirst(), registryOps, codec);
186-
} else {
187-
dataResult = legacyDeserializer.apply(pair.getFirst(), null, codec);
188-
}
189-
190-
return dataResult.map(value -> Pair.of(HoverEvent.hoverEvent(action, value), pair.getSecond()));
191-
});
192-
}
193-
194-
public <D> DataResult<D> encode(final HoverEvent<V> hoverEvent, final DynamicOps<D> dynamicOps, final D object) {
195-
return DataResult.error(() -> "Can't encode in legacy format");
196-
}
197-
}).fieldOf("value")
198-
);
199-
}
171+
static final HoverEventType<HoverEvent.ShowEntity> SHOW_ENTITY_HOVER_EVENT_TYPE = new HoverEventType<>(SHOW_ENTITY_CODEC, "show_entity");
172+
static final HoverEventType<HoverEvent.ShowItem> SHOW_ITEM_HOVER_EVENT_TYPE = new HoverEventType<>(SHOW_ITEM_CODEC, "show_item");
173+
static final HoverEventType<Component> SHOW_TEXT_HOVER_EVENT_TYPE = new HoverEventType<>(SHOW_TEXT_CODEC, "show_text");
174+
static final Codec<HoverEventType<?>> HOVER_EVENT_TYPE_CODEC = StringRepresentable.fromValues(() -> new HoverEventType<?>[]{SHOW_ENTITY_HOVER_EVENT_TYPE, SHOW_ITEM_HOVER_EVENT_TYPE, SHOW_TEXT_HOVER_EVENT_TYPE});
175+
176+
record HoverEventType<V>(MapCodec<HoverEvent<V>> codec, String id) implements StringRepresentable {
200177
@Override
201178
public String getSerializedName() {
202179
return this.id;
@@ -214,11 +191,12 @@ public String getSerializedName() {
214191
throw new IllegalStateException();
215192
}
216193
};
217-
static final Codec<HoverEvent<?>> HOVER_EVENT_CODEC = Codec.withAlternative(
218-
HOVER_EVENT_TYPE_CODEC.<HoverEvent<?>>dispatchMap("action", GET_HOVER_EVENT_TYPE, het -> het.codec.apply(COMPONENT_CODEC)).codec(),
219-
HOVER_EVENT_TYPE_CODEC.<HoverEvent<?>>dispatchMap("action", GET_HOVER_EVENT_TYPE, het -> het.legacyCodec.apply(COMPONENT_CODEC)).codec()
220-
);
221194

195+
static final Codec<HoverEvent<?>> HOVER_EVENT_CODEC = HOVER_EVENT_TYPE_CODEC.dispatch("action", GET_HOVER_EVENT_TYPE, HoverEventType::codec);
196+
197+
/*
198+
* Style
199+
*/
222200
public static final MapCodec<Style> STYLE_MAP_CODEC = mapCodec((instance) -> {
223201
return instance.group(
224202
TEXT_COLOR_CODEC.optionalFieldOf("color").forGetter(nullableGetter(Style::color)),
@@ -228,8 +206,8 @@ public String getSerializedName() {
228206
Codec.BOOL.optionalFieldOf("underlined").forGetter(decorationGetter(TextDecoration.UNDERLINED)),
229207
Codec.BOOL.optionalFieldOf("strikethrough").forGetter(decorationGetter(TextDecoration.STRIKETHROUGH)),
230208
Codec.BOOL.optionalFieldOf("obfuscated").forGetter(decorationGetter(TextDecoration.OBFUSCATED)),
231-
CLICK_EVENT_CODEC.optionalFieldOf("clickEvent").forGetter(nullableGetter(Style::clickEvent)),
232-
HOVER_EVENT_CODEC.optionalFieldOf("hoverEvent").forGetter(nullableGetter(Style::hoverEvent)),
209+
CLICK_EVENT_CODEC.optionalFieldOf("click_event").forGetter(nullableGetter(Style::clickEvent)),
210+
HOVER_EVENT_CODEC.optionalFieldOf("hover_event").forGetter(nullableGetter(Style::hoverEvent)),
233211
Codec.STRING.optionalFieldOf("insertion").forGetter(nullableGetter(Style::insertion)),
234212
KEY_CODEC.optionalFieldOf("font").forGetter(nullableGetter(Style::font))
235213
).apply(instance, (textColor, shadowColor, bold, italic, underlined, strikethrough, obfuscated, clickEvent, hoverEvent, insertion, font) -> {
@@ -248,6 +226,10 @@ public String getSerializedName() {
248226
});
249227
});
250228
});
229+
230+
/*
231+
* Misc
232+
*/
251233
static Consumer<Boolean> styleBooleanConsumer(final Style.Builder builder, final TextDecoration decoration) {
252234
return b -> builder.decoration(decoration, b);
253235
}

0 commit comments

Comments
 (0)