Merge pull request #1188 from VaultedMC/master

PAPIComponents Deserializer Support

src/paper/java/me/clip/placeholderapi/PAPIComponents.java

@@ -25,11 +25,14 @@ import me.clip.placeholderapi.replacer.ExactReplacer;
 import me.clip.placeholderapi.replacer.RelationalExactReplacer;
 import me.clip.placeholderapi.replacer.Replacer;
 import net.kyori.adventure.text.Component;
+import net.kyori.adventure.text.ComponentLike;
 import org.bukkit.OfflinePlayer;
 import org.bukkit.entity.Player;
 import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
 
 import java.util.List;
+import java.util.function.Function;
 import java.util.stream.Collectors;
 
 import static me.clip.placeholderapi.PlaceholderAPI.RELATIONAL_PLACEHOLDER_PATTERN;
@@ -43,122 +46,236 @@ public final class PAPIComponents {
      * Translates all placeholders into their corresponding values.
      * <br>The pattern of a valid placeholder is {@literal %<identifier>_<params>%}.
      *
-     * @param player Player to parse the placeholders against
+     * @param player    Player to parse the placeholders against
      * @param component Component to set the placeholder values in
      * @return Component containing all translated placeholders
      */
     @NotNull
     public static Component setPlaceholders(final OfflinePlayer player, @NotNull final Component component) {
-        if (PlaceholderAPIPlugin.getInstance().getPlaceholderAPIConfig().useAdventureProvidedReplacer()) {
+        return setPlaceholders(player, component, null);
-            return component.replaceText(config -> config.match(PlaceholderAPI.PLACEHOLDER_PATTERN).replacement((result, builder) ->
-                    builder.content(PERCENT_EXACT_REPLACER.apply(result.group(), player, PlaceholderAPIPlugin.getInstance().getLocalExpansionManager()::getExpansion))));
-        }
-
-        return ComponentReplacer.replace(component, str -> PlaceholderAPI.setPlaceholders(player, str));
     }
 
     /**
      * Translates all placeholders into their corresponding values.
      * <br>The pattern of a valid placeholder is {@literal %<identifier>_<params>%}.
      *
-     * @param player Player to parse the placeholders against
+     * @param player     Player to parse the placeholders against
+     * @param component  Component to set the placeholder values in
+     * @param deserializer Optional function to serialize parsed placeholder values into ComponentLike
+     * @return Component containing all translated placeholders
+     */
+    @NotNull
+    public static Component setPlaceholders(final OfflinePlayer player, @NotNull final Component component, @Nullable Function<String, ComponentLike> deserializer) {
+        if (PlaceholderAPIPlugin.getInstance().getPlaceholderAPIConfig().useAdventureProvidedReplacer()) {
+            return component.replaceText(config -> config.match(PlaceholderAPI.PLACEHOLDER_PATTERN).replacement((result, builder) -> {
+                String parsed = PERCENT_EXACT_REPLACER.apply(result.group(), player, PlaceholderAPIPlugin.getInstance().getLocalExpansionManager()::getExpansion);
+                return deserializer == null ? builder.content(parsed) : deserializer.apply(parsed);
+            }));
+        }
+
+        return ComponentReplacer.replace(component, str -> PlaceholderAPI.setPlaceholders(player, str), deserializer == null ? null : s -> deserializer.apply(s).asComponent());
+    }
+
+    /**
+     * Translates all placeholders into their corresponding values.
+     * <br>The pattern of a valid placeholder is {@literal %<identifier>_<params>%}.
+     *
+     * @param player     Player to parse the placeholders against
      * @param components List of Components to set the placeholder values in
      * @return List of Components containing all translated placeholders
      */
     @NotNull
     public static List<Component> setPlaceholders(final OfflinePlayer player, @NotNull final List<Component> components) {
-        return components.stream().map(component -> setPlaceholders(player, component)).collect(Collectors.toList());
+        return setPlaceholders(player, components, null);
     }
 
     /**
      * Translates all placeholders into their corresponding values.
      * <br>The pattern of a valid placeholder is {@literal %<identifier>_<params>%}.
      *
-     * @param player Player to parse the placeholders against
+     * @param player     Player to parse the placeholders against
+     * @param components List of Components to set the placeholder values in
+     * @param deserializer Optional function to serialize parsed placeholder values into ComponentLike
+     * @return List of Components containing all translated placeholders
+     */
+    @NotNull
+    public static List<Component> setPlaceholders(final OfflinePlayer player, @NotNull final List<Component> components, @Nullable Function<String, ComponentLike> deserializer) {
+        return components.stream().map(component -> setPlaceholders(player, component, deserializer == null ? null : s -> deserializer.apply(s).asComponent())).collect(Collectors.toList());
+    }
+
+    /**
+     * Translates all placeholders into their corresponding values.
+     * <br>The pattern of a valid placeholder is {@literal %<identifier>_<params>%}.
+     *
+     * @param player    Player to parse the placeholders against
      * @param component Component to set the placeholder values in
      * @return Component containing all translated placeholders
      */
     @NotNull
     public static Component setPlaceholders(final Player player, @NotNull final Component component) {
-        return setPlaceholders((OfflinePlayer) player, component);
+        return setPlaceholders(player, component, null);
     }
 
     /**
      * Translates all placeholders into their corresponding values.
      * <br>The pattern of a valid placeholder is {@literal %<identifier>_<params>%}.
      *
-     * @param player Player to parse the placeholders against
+     * @param player     Player to parse the placeholders against
+     * @param component  Component to set the placeholder values in
+     * @param deserializer Optional function to serialize parsed placeholder values into ComponentLike
+     * @return Component containing all translated placeholders
+     */
+    @NotNull
+    public static Component setPlaceholders(final Player player, @NotNull final Component component, @Nullable Function<String, ComponentLike> deserializer) {
+        return setPlaceholders((OfflinePlayer) player, component, deserializer);
+    }
+
+    /**
+     * Translates all placeholders into their corresponding values.
+     * <br>The pattern of a valid placeholder is {@literal %<identifier>_<params>%}.
+     *
+     * @param player     Player to parse the placeholders against
      * @param components List of Components to set the placeholder values in
      * @return List of components containing all translated placeholders
      */
     @NotNull
     public static List<Component> setPlaceholders(final Player player, @NotNull final List<Component> components) {
-        return setPlaceholders((OfflinePlayer) player, components);
+        return setPlaceholders(player, components, null);
+    }
+
+    /**
+     * Translates all placeholders into their corresponding values.
+     * <br>The pattern of a valid placeholder is {@literal %<identifier>_<params>%}.
+     *
+     * @param player     Player to parse the placeholders against
+     * @param components List of Components to set the placeholder values in
+     * @param deserializer Optional function to serialize parsed placeholder values into ComponentLike
+     * @return List of components containing all translated placeholders
+     */
+    @NotNull
+    public static List<Component> setPlaceholders(final Player player, @NotNull final List<Component> components, @Nullable Function<String, ComponentLike> deserializer) {
+        return setPlaceholders((OfflinePlayer) player, components, deserializer);
     }
 
     /**
      * Translates all placeholders into their corresponding values.
      * <br>The pattern of a valid placeholder is {@literal {<identifier>_<params>}}.
      *
-     * @param player Player to parse the placeholders against
+     * @param player    Player to parse the placeholders against
      * @param component Component to set the placeholder values in
      * @return Component containing all translated placeholders
      */
     @NotNull
     public static Component setBracketPlaceholders(final OfflinePlayer player, @NotNull final Component component) {
+        return setBracketPlaceholders(player, component, null);
+    }
+
+    /**
+     * Translates all placeholders into their corresponding values.
+     * <br>The pattern of a valid placeholder is {@literal {<identifier>_<params>}}.
+     *
+     * @param player     Player to parse the placeholders against
+     * @param component  Component to set the placeholder values in
+     * @param deserializer Optional function to serialize parsed placeholder values into ComponentLike
+     * @return Component containing all translated placeholders
+     */
+    @NotNull
+    public static Component setBracketPlaceholders(final OfflinePlayer player, @NotNull final Component component, @Nullable Function<String, ComponentLike> deserializer) {
         if (PlaceholderAPIPlugin.getInstance().getPlaceholderAPIConfig().useAdventureReplacer()) {
             return component.replaceText(config -> config.match(PlaceholderAPI.BRACKET_PLACEHOLDER_PATTERN).replacement((result, builder) ->
                     builder.content(BRACKET_EXACT_REPLACER.apply(result.group(), player, PlaceholderAPIPlugin.getInstance().getLocalExpansionManager()::getExpansion))));
         }
 
-        return ComponentReplacer.replace(component, str -> PlaceholderAPI.setBracketPlaceholders(player, str));
+        return ComponentReplacer.replace(component, str -> PlaceholderAPI.setBracketPlaceholders(player, str), deserializer == null ? null : s -> deserializer.apply(s).asComponent());
     }
 
     /**
      * Translates all placeholders into their corresponding values.
      * <br>The pattern of a valid placeholder is {@literal {<identifier>_<params>}}.
      *
-     * @param player Player to parse the placeholders against
+     * @param player     Player to parse the placeholders against
      * @param components List of Components to set the placeholder values in
      * @return List of Components containing all translated placeholders
      */
     @NotNull
     public static List<Component> setBracketPlaceholders(final OfflinePlayer player, @NotNull final List<Component> components) {
-        return components.stream().map(component -> setBracketPlaceholders(player, component)).collect(Collectors.toList());
+        return setBracketPlaceholders(player, components, null);
     }
 
     /**
      * Translates all placeholders into their corresponding values.
      * <br>The pattern of a valid placeholder is {@literal {<identifier>_<params>}}.
      *
-     * @param player Player to parse the placeholders against
+     * @param player     Player to parse the placeholders against
+     * @param components List of Components to set the placeholder values in
+     * @param deserializer Optional function to serialize parsed placeholder values into ComponentLike
+     * @return List of Components containing all translated placeholders
+     */
+    @NotNull
+    public static List<Component> setBracketPlaceholders(final OfflinePlayer player, @NotNull final List<Component> components, @Nullable Function<String, ComponentLike> deserializer) {
+        return components.stream().map(component -> setBracketPlaceholders(player, component, deserializer)).collect(Collectors.toList());
+    }
+
+    /**
+     * Translates all placeholders into their corresponding values.
+     * <br>The pattern of a valid placeholder is {@literal {<identifier>_<params>}}.
+     *
+     * @param player    Player to parse the placeholders against
      * @param component Component to set the placeholder values in
      * @return Component containing all translated placeholders
      */
     @NotNull
     public static Component setBracketPlaceholders(final Player player, @NotNull final Component component) {
-        return setBracketPlaceholders((OfflinePlayer) player, component);
+        return setBracketPlaceholders(player, component, null);
     }
 
     /**
      * Translates all placeholders into their corresponding values.
      * <br>The pattern of a valid placeholder is {@literal {<identifier>_<params>}}.
      *
-     * @param player Player to parse the placeholders against
+     * @param player     Player to parse the placeholders against
+     * @param component  Component to set the placeholder values in
+     * @param deserializer Optional function to serialize parsed placeholder values into ComponentLike
+     * @return Component containing all translated placeholders
+     */
+    @NotNull
+    public static Component setBracketPlaceholders(final Player player, @NotNull final Component component, @Nullable Function<String, ComponentLike> deserializer) {
+        return setBracketPlaceholders((OfflinePlayer) player, component, deserializer);
+    }
+
+    /**
+     * Translates all placeholders into their corresponding values.
+     * <br>The pattern of a valid placeholder is {@literal {<identifier>_<params>}}.
+     *
+     * @param player     Player to parse the placeholders against
      * @param components List of Components to set the placeholder values in
      * @return List of Components containing all translated placeholders
      */
     @NotNull
     public static List<Component> setBracketPlaceholders(final Player player, @NotNull final List<Component> components) {
-        return setBracketPlaceholders((OfflinePlayer) player, components);
+        return setBracketPlaceholders(player, components, null);
+    }
+
+    /**
+     * Translates all placeholders into their corresponding values.
+     * <br>The pattern of a valid placeholder is {@literal {<identifier>_<params>}}.
+     *
+     * @param player     Player to parse the placeholders against
+     * @param components List of Components to set the placeholder values in
+     * @param deserializer Optional function to serialize parsed placeholder values into ComponentLike
+     * @return List of Components containing all translated placeholders
+     */
+    @NotNull
+    public static List<Component> setBracketPlaceholders(final Player player, @NotNull final List<Component> components, @Nullable Function<String, ComponentLike> deserializer) {
+        return setBracketPlaceholders((OfflinePlayer) player, components, deserializer);
     }
 
     /**
      * set relational placeholders in the text specified placeholders are matched with the pattern
      * {@literal %<rel_(identifier)_(params)>%} when set with this method
      *
-     * @param one First player to compare
+     * @param one       First player to compare
-     * @param two Second player to compare
+     * @param two       Second player to compare
      * @param component Component to parse the placeholders in
      * @return The Component containing the parsed relational placeholders
      */
@@ -172,8 +289,8 @@ public final class PAPIComponents {
      * Translate placeholders in the provided List based on the relation of the two provided players.
      * <br>The pattern of a valid placeholder is {@literal %rel_<identifier>_<param>%}.
      *
-     * @param one Player to compare
+     * @param one        Player to compare
-     * @param two Player to compare
+     * @param two        Player to compare
      * @param components List of Components to parse the placeholder values to
      * @return The List of Components containing the parsed relational placeholders
      */

src/paper/java/me/clip/placeholderapi/replacer/ComponentReplacer.java

@@ -8,6 +8,7 @@ import net.kyori.adventure.text.event.DataComponentValue;
 import net.kyori.adventure.text.event.HoverEvent;
 import net.kyori.adventure.text.format.Style;
 import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
 
 import java.util.ArrayList;
 import java.util.HashMap;
@@ -17,25 +18,25 @@ import java.util.function.Function;
 
 public class ComponentReplacer {
     @NotNull
-    public static Component replace(@NotNull final Component component, @NotNull final Function<String, String> replacer) {
+    public static Component replace(@NotNull final Component component, @NotNull final Function<String, String> replacer, @Nullable final Function<String, Component> deserializer) {
-        return rebuild(component, replacer);
+        return rebuild(component, replacer, deserializer);
     }
 
     @NotNull
-    private static Component rebuild(@NotNull final Component component, @NotNull final Function<String, String> replacer) {
+    private static Component rebuild(@NotNull final Component component, @NotNull final Function<String, String> replacer, @Nullable final Function<String, Component> deserializer) {
         Component rebuilt;
 
         if (component instanceof TextComponent) {
             final TextComponent text = (TextComponent) component;
             final String replaced = replacer.apply(text.content());
 
-            rebuilt = Component.text(replaced);
+            rebuilt = deserializer == null ? Component.text(replaced) : deserializer.apply(replaced);
         } else if (component instanceof TranslatableComponent) {
             final TranslatableComponent translatable = (TranslatableComponent) component;
             final List<Component> arguments = new ArrayList<>();
 
             for (final ComponentLike arg : translatable.arguments()) {
-                arguments.add(rebuild(arg.asComponent(), replacer));
+                arguments.add(rebuild(arg.asComponent(), replacer, deserializer));
             }
 
             rebuilt = Component.translatable(translatable.key(), arguments);
@@ -52,12 +53,12 @@ public class ComponentReplacer {
             rebuilt = Component.empty();
         }
 
-        rebuilt = rebuilt.style(rebuildStyle(component.style(), replacer));
+        rebuilt = rebuilt.style(rebuildStyle(component.style(), replacer, deserializer));
 
         if (!component.children().isEmpty()) {
             final List<Component> children = new ArrayList<>();
             for (Component child : component.children()) {
-                children.add(rebuild(child, replacer));
+                children.add(rebuild(child, replacer, deserializer));
             }
             rebuilt = rebuilt.children(children);
         }
@@ -66,7 +67,7 @@ public class ComponentReplacer {
     }
 
     @NotNull
-    private static Style rebuildStyle(@NotNull final Style style, @NotNull final Function<String, String> replacer) {
+    private static Style rebuildStyle(@NotNull final Style style, @NotNull final Function<String, String> replacer, @Nullable final Function<String, Component> deserializer) {
         final Style.Builder builder = style.toBuilder();
         final ClickEvent click = style.clickEvent();
 
@@ -77,7 +78,7 @@ public class ComponentReplacer {
         final HoverEvent<?> hover = style.hoverEvent();
 
         if (hover != null) {
-            builder.hoverEvent(rebuildHoverEvent(hover, replacer));
+            builder.hoverEvent(rebuildHoverEvent(hover, replacer, deserializer));
         }
 
         return builder.build();
@@ -113,11 +114,11 @@ public class ComponentReplacer {
     }
 
     @NotNull
-    private static HoverEvent<?> rebuildHoverEvent(@NotNull final HoverEvent<?> hover, @NotNull final Function<String, String> replacer) {
+    private static HoverEvent<?> rebuildHoverEvent(@NotNull final HoverEvent<?> hover, @NotNull final Function<String, String> replacer, @Nullable final Function<String, Component> deserializer) {
         final Object value = hover.value();
 
         if (value instanceof Component) {
-            final Component rebuilt = rebuild((Component) value, replacer);
+            final Component rebuilt = rebuild((Component) value, replacer, deserializer);
             return HoverEvent.showText(rebuilt);
         }
 
@@ -130,7 +131,7 @@ public class ComponentReplacer {
 
             Component rebuiltName = null;
             if (entity.name() != null) {
-                rebuiltName = rebuild(entity.name(), replacer);
+                rebuiltName = rebuild(entity.name(), replacer, deserializer);
             }
 
             return HoverEvent.showEntity(entity.type(), entity.id(), rebuiltName);