From e781d54348ec222a1cc7bd332b9277f42812fa6f Mon Sep 17 00:00:00 2001 From: carm Date: Fri, 16 Dec 2022 04:13:49 +0800 Subject: [PATCH] =?UTF-8?q?feat(color):=20=E5=AE=8C=E5=96=84ColorParser?= =?UTF-8?q?=E6=94=AF=E6=8C=81=E6=B8=90=E5=8F=98RGB=E9=A2=9C=E8=89=B2?= =?UTF-8?q?=E3=80=82?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../common/utils/ColorParser.java | 185 +++++++++++++++++- 1 file changed, 176 insertions(+), 9 deletions(-) diff --git a/common/src/main/java/cc/carm/lib/mineconfiguration/common/utils/ColorParser.java b/common/src/main/java/cc/carm/lib/mineconfiguration/common/utils/ColorParser.java index 3f92fa4..58a46c6 100644 --- a/common/src/main/java/cc/carm/lib/mineconfiguration/common/utils/ColorParser.java +++ b/common/src/main/java/cc/carm/lib/mineconfiguration/common/utils/ColorParser.java @@ -1,31 +1,93 @@ package cc.carm.lib.mineconfiguration.common.utils; -import java.util.Arrays; +import org.jetbrains.annotations.NotNull; +import org.jetbrains.annotations.Nullable; + +import java.awt.*; import java.util.List; +import java.util.*; import java.util.regex.Matcher; import java.util.regex.Pattern; import java.util.stream.Collectors; +import java.util.stream.IntStream; +/** + * 颜色解析器，来自EasyPlugin项目。 + *
普通颜色 格式 {@code &+颜色代码 }，如 {@literal &c} 、{@literal &a} + *
RGB颜色(版本需要≥1.14) 格式 {@code &(#XXXXXX) }，如 {@literal &(#aaaaaa)} + *
渐变RBG颜色(版本需要≥1.14) 格式 {@code &<#XXXXXX>FOOBAR&<#XXXXXX> } + *

注意：当使用渐变RGB颜色时，普通颜色代码与RGB颜色代码将失效。 + * + * @author CarmJos + * @since 1.4.18 + */ public class ColorParser { - public static Pattern HEX_PATTERN = Pattern.compile("&\\(&?#([0-9a-fA-F]{6})\\)"); + public static final Pattern HEX_PATTERN = Pattern.compile("&\\(&?#([\\da-fA-F]{6})\\)"); + public static final Pattern GRADIENT_PATTERN = Pattern.compile("&<&?#([\\da-fA-F]{6})>"); + public static final Pattern COLOR_PATTERN = Pattern.compile("([&§][0-9a-fA-FrRxX])+"); // 会影响颜色的代码 + public static final Pattern FORMAT_PATTERN = Pattern.compile("([&§][0-9a-fA-Fk-oK-OrRxX])+"); // MC可用的格式化代码 - public static String parse(String text) { - return parseBaseColor(parseHexColor(text)); + /** + * 清除一条消息中的全部颜色代码 (包括RGB颜色代码与渐变颜色代码) + * + * @param text 源消息内容 + * @return 清理颜色后的消息 + */ + public static @NotNull String clear(@NotNull String text) { + text = HEX_PATTERN.matcher(text).replaceAll(""); + text = GRADIENT_PATTERN.matcher(text).replaceAll(""); + text = COLOR_PATTERN.matcher(text).replaceAll(""); + return text; } - public static String[] parse(String... texts) { + /** + * 对一条消息进行颜色解析，包括普通颜色代码、RGB颜色代码与RBG渐变代码。 + * + * @param text 源消息内容 + * @return 解析后的消息 + */ + public static @NotNull String parse(@NotNull String text) { + return parseBaseColor(parseGradientColor(parseHexColor(text))); + } + + /** + * 对多条消息进行颜色解析，包括普通颜色代码、RGB颜色代码与RBG渐变代码。 + * + * @param texts 源消息内容 + * @return 解析后的消息 + */ + public static @NotNull String[] parse(@NotNull String... texts) { return parse(Arrays.asList(texts)).toArray(new String[0]); } - public static List parse(List texts) { + /** + * 对多条消息进行颜色解析，包括普通颜色代码、RGB颜色代码与RBG渐变代码。 + * + * @param texts 源消息内容 + * @return 解析后的消息 + */ + public static @NotNull List parse(@NotNull Collection texts) { return texts.stream().map(ColorParser::parse).collect(Collectors.toList()); } + /** + * 解析消息中的基本颜色代码格式 {@code &+颜色代码 }，如 {@literal &c} 、{@literal &a} + * + * @param text 消息内容 + * @return RGB处理后的消息 + * @see net.md_5.bungee.api.ChatColor + */ public static String parseBaseColor(final String text) { return text.replaceAll("&", "§").replace("§§", "&"); } + /** + * 解析消息中的RGB颜色代码(版本需要≥1.14) 格式 {@code &(#XXXXXX) }，如 {@literal &(#aaaaaa)} + * + * @param text 消息内容 + * @return RGB处理后的消息 + */ public static String parseHexColor(String text) { Matcher matcher = HEX_PATTERN.matcher(text); while (matcher.find()) { @@ -35,9 +97,114 @@ public class ColorParser { return text; } - private static String buildHexColor(String hexCode) { - return Arrays.stream(hexCode.split("")) - .map(s -> '§' + s) + /** + * 对一条消息进行RGB渐变处理(版本需要≥1.14)，格式 {@code &<#XXXXXX>FOOBAR&<#XXXXXX> }。 + * + * @param text 消息内容 + * @return RGB渐变处理后的消息 + */ + public static @NotNull String parseGradientColor(@NotNull String text) { + List colors = new ArrayList<>(); + + Matcher matcher = ColorParser.GRADIENT_PATTERN.matcher(text); + while (matcher.find()) colors.add(matcher.group(1)); + + if (colors.isEmpty()) return text; // 无渐变颜色，直接跳出 + + String[] parts = ColorParser.GRADIENT_PATTERN.split(text); + StringBuilder builder = new StringBuilder(); + for (int i = 0; i < parts.length; i++) { + String startHex = i - 1 >= 0 && colors.size() > i - 1 ? colors.get(i - 1) : null; // 本条消息的起始颜色 + String endHex = colors.size() > i ? colors.get(i) : null; // 本条消息的结束颜色 + builder.append(gradientText(parts[i], startHex, endHex)); + } + + return builder.toString(); + } + + public static @NotNull String gradientText(@NotNull String text, + @Nullable Color startColor, @Nullable Color endColor) { + Objects.requireNonNull(text, "Text to be gradient should not be null!"); + if (startColor == null || endColor == null || text.isEmpty()) { + // 起始颜色有任一为空，则不进行渐变上色。 + // 若有起始颜色，则代表其跟在某个渐变之后，应当添加"&r"阻断前面的渐变。 + return (startColor != null ? "&r" : "") + text; + } + + // 用于记录消息中特殊格式的位置 + // 在渐变中，允许使用格式字符与颜色字符来改变其中某个字的颜色/格式，以支持更多形式内容。 + LinkedHashMap extraFormats = new LinkedHashMap<>(); + Matcher matcher = ColorParser.FORMAT_PATTERN.matcher(text); + while (matcher.find()) { + extraFormats.put(matcher.start(), matcher.group()); + text = matcher.replaceFirst(""); + matcher.reset(text); + } + + if (text.length() == 1) { + // 当只有一个实际字符时，无需进行渐变计算，直接返回 中间颜色+起始格式(如果有)+消息 即可。 + return colorText(text, extraFormats.get(0), buildHexColor(mediumHex(startColor, endColor))); + } + + String[] characters = text.split(""); + int step = characters.length; // 变换次数 + + // 决定每种颜色变换的方向 + int rDirection = startColor.getRed() < endColor.getRed() ? 1 : -1; + int gDirection = startColor.getGreen() < endColor.getGreen() ? 1 : -1; + int bDirection = startColor.getBlue() < endColor.getBlue() ? 1 : -1; + + // 决定每种颜色每次变换的度 + int rStep = Math.abs(startColor.getRed() - endColor.getRed()) / (step - 1); + int gStep = Math.abs(startColor.getGreen() - endColor.getGreen()) / (step - 1); + int bStep = Math.abs(startColor.getBlue() - endColor.getBlue()) / (step - 1); + + String[] hexes = IntStream.range(0, step).mapToObj(i -> colorToHex( + startColor.getRed() + rStep * i * rDirection, + startColor.getGreen() + gStep * i * gDirection, + startColor.getBlue() + bStep * i * bDirection + )).toArray(String[]::new); + + return IntStream.range(0, characters.length) + .mapToObj(i -> colorText(characters[i], extraFormats.get(i), buildHexColor(hexes[i]))) + .collect(Collectors.joining()); + } + + protected static String gradientText(@NotNull String text, @Nullable String startHex, @Nullable String endHex) { + return gradientText(text, + startHex == null ? null : Color.decode("0x" + startHex), + endHex == null ? null : Color.decode("0x" + endHex) + ); + } + + private static String mediumHex(@NotNull Color start, @NotNull Color end) { + return colorToHex( + Math.abs(start.getRed() - end.getRed()) / 2, + Math.abs(start.getGreen() - end.getGreen()) / 2, + Math.abs(start.getBlue() - end.getBlue()) / 2 + ); + } + + private static String colorText(String message, @Nullable String format, @Nullable String color) { + if (format != null && COLOR_PATTERN.matcher(format).find()) { + // format中存在影响颜色的内容，则当前消息的颜色会被覆盖。 + // 为了减少最终消息的长度，故直接返回键入的FORMAT和对应消息的内容。 + return format + message; + } + return (color == null ? "" : color) + (format == null ? "" : parseBaseColor(format)) + message; + } + + protected static String colorToHex(Color color) { + return colorToHex(color.getRed(), color.getGreen(), color.getBlue()); + } + + protected static String colorToHex(int r, int g, int b) { + // 将R、G、B转换为16进制(若非2位则补0)输出 + return String.format("%02X%02X%02X", r, g, b); + } + + protected static String buildHexColor(String hexCode) { + return Arrays.stream(hexCode.split("")).map(s -> '§' + s) .collect(Collectors.joining("", '§' + "x", "")); }