Skip to content

Commit

Permalink
wip: feat: restore legacy parser
Browse files Browse the repository at this point in the history 
This commit adds the serializer of a Component into its String
representation.
  • Loading branch information
@diogotcorreia
diogotcorreia committed Jul 18, 2024
1 parent bd70339 commit 815cf0a
Show file tree
Hide file tree
Showing 2 changed files with 282 additions and 0 deletions.
212 changes: 212 additions & 0 deletions core/src/main/java/com/rexcantor64/triton/language/parser/LegacyParser.java
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,212 @@
package com.rexcantor64.triton.language.parser;

import com.rexcantor64.triton.api.config.FeatureSyntax;
import com.rexcantor64.triton.api.language.Localized;
import com.rexcantor64.triton.api.language.MessageParser;
import com.rexcantor64.triton.api.language.TranslationResult;
import lombok.Getter;
import lombok.val;
import net.kyori.adventure.text.Component;
import net.kyori.adventure.text.KeybindComponent;
import net.kyori.adventure.text.TextComponent;
import net.kyori.adventure.text.TranslatableComponent;
import net.kyori.adventure.text.event.ClickEvent;
import net.kyori.adventure.text.event.HoverEvent;
import net.kyori.adventure.text.flattener.ComponentFlattener;
import net.kyori.adventure.text.flattener.FlattenerListener;
import net.kyori.adventure.text.format.NamedTextColor;
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.text.format.TextFormat;
import net.kyori.adventure.text.serializer.legacy.CharacterAndFormat;
import net.kyori.adventure.text.serializer.legacy.LegacyComponentSerializer;
import net.kyori.adventure.text.serializer.legacy.Reset;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import org.jetbrains.annotations.VisibleForTesting;

import java.util.Arrays;
import java.util.HashMap;
import java.util.UUID;

/**
* A message parser that has the same behaviour as the parser on Triton v3 and below.
* For backwards compatibility purposes.
*
* @since 4.0.0
*/
public class LegacyParser implements MessageParser {
private static final char CLICK_DELIM = '\uE400';
private static final char CLICK_END_DELIM = '\uE401';
private static final char HOVER_DELIM = '\uE500';
private static final char HOVER_END_DELIM = '\uE501';
private static final char TRANSLATABLE_DELIM = '\uE600';
private static final char KEYBIND_DELIM = '\uE700';
private static final char FONT_START_DELIM = '\uE800';
private static final char FONT_MID_DELIM = '\uE802';
private static final char FONT_END_DELIM = '\uE801';

@Override
public @NotNull TranslationResult<String> translateString(String text, Localized language, FeatureSyntax syntax) {
return null;
}

@Override
public @NotNull TranslationResult<Component> translateComponent(Component component, Localized language, FeatureSyntax syntax) {
return null;
}

/**
* Represents a {@link Component} but as a String and with additional storage for the
* values of click/hover events and translatable components.
*/
@VisibleForTesting
static class SerializedComponent {
private final ComponentFlattener FLATTENER = ComponentFlattener.builder()
.mapper(KeybindComponent.class, component -> KEYBIND_DELIM + component.keybind() + KEYBIND_DELIM)
.mapper(TextComponent.class, TextComponent::content)
.mapper(TranslatableComponent.class, component -> {
val uuid = UUID.randomUUID();
this.translatableComponents.put(uuid, component);

// Key is only included for backwards-compatibility
return TRANSLATABLE_DELIM + component.key() + TRANSLATABLE_DELIM + uuid + TRANSLATABLE_DELIM;
})
// ignore unknown components
.build();

@Getter
private final HashMap<UUID, TranslatableComponent> translatableComponents = new HashMap<>();
@Getter
private final HashMap<UUID, ClickEvent> clickEvents = new HashMap<>();
@Getter
private final HashMap<UUID, HoverEvent<?>> hoverEvents = new HashMap<>();
@Getter
private String text;

public SerializedComponent(Component component) {
val flattenerListener = new CursedFlattenerListener();
FLATTENER.flatten(component, flattenerListener);
this.text = flattenerListener.toString();
}

/**
* Uses reserved unicode characters to delimit components/styles that cannot be represented with
* legacy color codes, such as click, hover, translatable components, fonts, keybinds, etc.
* The used characters are:
* <ul>
* <li>\uE400 and \E401 for click events</li>
* <li>\uE500 and \E501 for hover events</li>
* <li>\uE600 for translatable components</li>
* <li>\uE700 for keybind components</li>
* <li>\uE800, \uE801 and \uE802 for fonts</li>
* </ul>
*/
private class CursedFlattenerListener implements FlattenerListener {
private final StringBuilder stringBuilder = new StringBuilder();
private Style[] stack = new Style[8];
private int topIndex = -1;

@Override
public void component(@NotNull String text) {
stringBuilder.append(text);
}

@Override
public void pushStyle(@NotNull Style style) {
val i = ++this.topIndex;
if (i >= this.stack.length) {
this.stack = Arrays.copyOf(this.stack, this.stack.length * 2);
}
if (i > 0) {
style = this.stack[i - 1].merge(style);
}
this.stack[i] = style;

@Nullable val color = style.color();
if (color == null) {
this.stringBuilder.append(formatToString(Reset.INSTANCE));
} else {
this.stringBuilder.append(formatToString(color));
}

style.decorations().entrySet().stream()
.filter(entry -> entry.getValue() == TextDecoration.State.TRUE)
.forEach(entry -> this.stringBuilder.append(formatToString(entry.getKey())));

@Nullable val clickEvent = style.clickEvent();
if (clickEvent != null && (i == 0 || !clickEvent.equals(this.stack[i - 1].clickEvent()))) {
val uuid = UUID.randomUUID();
SerializedComponent.this.clickEvents.put(uuid, clickEvent);

this.stringBuilder
.append(CLICK_DELIM)
.append(clickEvent.action().ordinal()) // backwards compatibility only
.append(uuid);
}

@Nullable val hoverEvent = style.hoverEvent();
if (hoverEvent != null && (i == 0 || !hoverEvent.equals(this.stack[i - 1].hoverEvent()))) {
val uuid = UUID.randomUUID();
SerializedComponent.this.hoverEvents.put(uuid, hoverEvent);

this.stringBuilder
.append(HOVER_DELIM)
.append(uuid);
}

@Nullable val font = style.font();
if (font != null && (i == 0 || !font.equals(this.stack[i - 1].font()))) {
this.stringBuilder
.append(FONT_START_DELIM)
.append(font.asString())
.append(FONT_MID_DELIM);
}
}

@Override
public void popStyle(@NotNull Style style) {
val i = this.topIndex--;

@Nullable val clickEvent = style.clickEvent();
if (clickEvent != null && (i == 0 || !clickEvent.equals(this.stack[i - 1].clickEvent()))) {
this.stringBuilder.append(CLICK_END_DELIM);
}

@Nullable val hoverEvent = style.hoverEvent();
if (hoverEvent != null && (i == 0 || !hoverEvent.equals(this.stack[i - 1].hoverEvent()))) {
this.stringBuilder.append(HOVER_END_DELIM);
}

@Nullable val font = style.font();
if (font != null && (i == 0 || !font.equals(this.stack[i - 1].font()))) {
this.stringBuilder.append(FONT_END_DELIM);
}
}

public String toString() {
return this.stringBuilder.toString();
}

private @NotNull String formatToString(@NotNull TextFormat format) {
if (format instanceof TextColor && !(format instanceof NamedTextColor)) {
// this is a hex color
final TextColor color = (TextColor) format;
String hexCode = String.format("%06x", color.value());
final StringBuilder legacy = new StringBuilder("§x");
for (int i = 0, length = hexCode.length(); i < length; i++) {
legacy.append(LegacyComponentSerializer.SECTION_CHAR).append(hexCode.charAt(i));
}
return legacy.toString();
}
return CharacterAndFormat.defaults().stream()
.filter(characterAndFormat -> characterAndFormat.format().equals(format))
.findFirst()
.map(CharacterAndFormat::character)
.map(c -> "§" + c)
.orElse("");
}
}
}
}
70 changes: 70 additions & 0 deletions core/src/test/java/com/rexcantor64/triton/language/parser/LegacyParserTest.java
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
package com.rexcantor64.triton.language.parser;

import net.kyori.adventure.key.Key;
import net.kyori.adventure.text.Component;
import net.kyori.adventure.text.event.ClickEvent;
import net.kyori.adventure.text.event.HoverEvent;
import net.kyori.adventure.text.format.NamedTextColor;
import net.kyori.adventure.text.format.TextColor;
import net.kyori.adventure.text.format.TextDecoration;
import org.junit.jupiter.api.Test;

import static org.junit.jupiter.api.Assertions.assertEquals;

public class LegacyParserTest {

private final AdventureParser parser = new AdventureParser();

@Test
public void testSerializingComponent() {
Component component = Component.text("Lorem ")
.append(
Component.text("ipsum dolor ")
.color(NamedTextColor.BLACK)
.decorate(TextDecoration.BOLD)
)
.append(
Component.text("sit amet,")
.decorate(TextDecoration.BOLD)
)
.append(
Component.text(" consectetur ")
.color(TextColor.color(0xaabbcc))
.clickEvent(ClickEvent.copyToClipboard("some text"))
.append(
Component.text("adipiscing ")
.font(Key.key("default"))
)
.append(
Component.text("elit. ")
.hoverEvent(HoverEvent.showText(Component.text("hello world")))
)
)
.append(
Component.text("Maecenas imperdiet ")
.color(NamedTextColor.AQUA)
.append(
Component.translatable(
"some.key",
Component.text("arg 1")
)
)
);

LegacyParser.SerializedComponent serializedComponent = new LegacyParser.SerializedComponent(component);

assertEquals(1, serializedComponent.getClickEvents().size());
assertEquals(1, serializedComponent.getHoverEvents().size());
assertEquals(1, serializedComponent.getTranslatableComponents().size());
assertEquals(
"§rLorem §0§lipsum dolor §r§lsit amet,§x§a§a§b§b§c§c\uE4005"
+ serializedComponent.getClickEvents().keySet().iterator().next()
+ " consectetur §x§a§a§b§b§c§c\uE800minecraft:default\uE802adipiscing \uE801§x§a§a§b§b§c§c\uE500"
+ serializedComponent.getHoverEvents().keySet().iterator().next()
+ "elit. \uE501\uE401§bMaecenas imperdiet §b\uE600some.key\uE600"
+ serializedComponent.getTranslatableComponents().keySet().iterator().next()
+ "\uE600",
serializedComponent.getText()
);
}
}

0 comments on commit 815cf0a

Please sign in to comment.