新增AnsiColors、AnsiColorWrapper

This commit is contained in:
TomXin 2022-08-27 15:59:03 +08:00
parent ef0fc738f1
commit 4e53873d81
3 changed files with 312 additions and 0 deletions

View File

@ -0,0 +1,83 @@
package cn.hutool.core.lang.ansi;
import cn.hutool.core.lang.Assert;
import java.util.Objects;
/**
* ANSI 颜色包装类
*
* @author TomXin
* @since 5.8.6
*/
public class AnsiColorWrapper {
private final int code;
private final AnsiColors.BitDepth bitDepth;
/**
* 创建指定位深度的 {@link AnsiColorWrapper} 实例
* @param code 颜色编码位深度为4bit时code取值范围[30~37][90~97]位深度为8bit时code取值范围[0~255]
* @param bitDepth 位深度
*/
public AnsiColorWrapper(int code, AnsiColors.BitDepth bitDepth) {
if (bitDepth==AnsiColors.BitDepth.FOUR){
Assert.isTrue((30<=code&&code<=37)||(90<=code&&code<=97),"The value of 4 bit color only supported [30~37],[90~97].");
}
Assert.isTrue((0<=code&&code<=255),"The value of 8 bit color only supported [0~255].");
this.code = code;
this.bitDepth = bitDepth;
}
/**
* 转换为 {@link AnsiElement} 实例
*
* @param foreOrBack 区分前景还是背景
* @return {@link AnsiElement} 实例
*/
public AnsiElement toAnsiElement(ForeOrBack foreOrBack){
if (bitDepth== AnsiColors.BitDepth.FOUR){
if (foreOrBack == ForeOrBack.FORE){
return AnsiColor.valueOf(String.valueOf(code));
}
return AnsiBackground.valueOf(String.valueOf(code + 10));
}
if (foreOrBack == ForeOrBack.FORE){
return Ansi8BitColor.foreground(code);
}
return Ansi8BitColor.background(code);
}
/**
* 区分前景还是背景
*/
public enum ForeOrBack{
/**
* 前景
*/
FORE,
/**
* 背景
*/
BACK,
}
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
AnsiColorWrapper that = (AnsiColorWrapper) o;
return code == that.code && bitDepth == that.bitDepth;
}
@Override
public int hashCode() {
return Objects.hash(code, bitDepth);
}
}

View File

@ -0,0 +1,202 @@
package cn.hutool.core.lang.ansi;
import cn.hutool.core.lang.Assert;
import java.awt.*;
import java.awt.color.ColorSpace;
import java.util.Collections;
import java.util.LinkedHashMap;
import java.util.Map;
/**
*
* {@link Color AWT Colors} 的上下文中使用 {@link AnsiColor} 的实用程序
* <p>来自Spring Boot</p>
*
* @author Craig Burke,Ruben Dijkstra,Phillip Webb,Michael Simons,Tom Xin
* @since 5.8.6
*/
public final class AnsiColors {
private static final Map<AnsiColorWrapper, LabColor> ANSI_COLOR_MAP;
static {
Map<AnsiColorWrapper, LabColor> colorMap = new LinkedHashMap<>();
colorMap.put(new AnsiColorWrapper(30,BitDepth.FOUR), new LabColor(0x000000));
colorMap.put(new AnsiColorWrapper(31,BitDepth.FOUR), new LabColor(0xAA0000));
colorMap.put(new AnsiColorWrapper(32,BitDepth.FOUR), new LabColor(0x00AA00));
colorMap.put(new AnsiColorWrapper(33,BitDepth.FOUR), new LabColor(0xAA5500));
colorMap.put(new AnsiColorWrapper(34,BitDepth.FOUR), new LabColor(0x0000AA));
colorMap.put(new AnsiColorWrapper(35,BitDepth.FOUR), new LabColor(0xAA00AA));
colorMap.put(new AnsiColorWrapper(36,BitDepth.FOUR), new LabColor(0x00AAAA));
colorMap.put(new AnsiColorWrapper(37,BitDepth.FOUR), new LabColor(0xAAAAAA));
colorMap.put(new AnsiColorWrapper(90,BitDepth.FOUR), new LabColor(0x555555));
colorMap.put(new AnsiColorWrapper(91,BitDepth.FOUR), new LabColor(0xFF5555));
colorMap.put(new AnsiColorWrapper(92,BitDepth.FOUR), new LabColor(0x55FF00));
colorMap.put(new AnsiColorWrapper(93,BitDepth.FOUR), new LabColor(0xFFFF55));
colorMap.put(new AnsiColorWrapper(94,BitDepth.FOUR), new LabColor(0x5555FF));
colorMap.put(new AnsiColorWrapper(95,BitDepth.FOUR), new LabColor(0xFF55FF));
colorMap.put(new AnsiColorWrapper(96,BitDepth.FOUR), new LabColor(0x55FFFF));
colorMap.put(new AnsiColorWrapper(97,BitDepth.FOUR), new LabColor(0xFFFFFF));
ANSI_COLOR_MAP = Collections.unmodifiableMap(colorMap);
}
private static final int[] ANSI_8BIT_COLOR_CODE_LOOKUP = new int[] { 0x000000, 0x800000, 0x008000, 0x808000,
0x000080, 0x800080, 0x008080, 0xc0c0c0, 0x808080, 0xff0000, 0x00ff00, 0xffff00, 0x0000ff, 0xff00ff,
0x00ffff, 0xffffff, 0x000000, 0x00005f, 0x000087, 0x0000af, 0x0000d7, 0x0000ff, 0x005f00, 0x005f5f,
0x005f87, 0x005faf, 0x005fd7, 0x005fff, 0x008700, 0x00875f, 0x008787, 0x0087af, 0x0087d7, 0x0087ff,
0x00af00, 0x00af5f, 0x00af87, 0x00afaf, 0x00afd7, 0x00afff, 0x00d700, 0x00d75f, 0x00d787, 0x00d7af,
0x00d7d7, 0x00d7ff, 0x00ff00, 0x00ff5f, 0x00ff87, 0x00ffaf, 0x00ffd7, 0x00ffff, 0x5f0000, 0x5f005f,
0x5f0087, 0x5f00af, 0x5f00d7, 0x5f00ff, 0x5f5f00, 0x5f5f5f, 0x5f5f87, 0x5f5faf, 0x5f5fd7, 0x5f5fff,
0x5f8700, 0x5f875f, 0x5f8787, 0x5f87af, 0x5f87d7, 0x5f87ff, 0x5faf00, 0x5faf5f, 0x5faf87, 0x5fafaf,
0x5fafd7, 0x5fafff, 0x5fd700, 0x5fd75f, 0x5fd787, 0x5fd7af, 0x5fd7d7, 0x5fd7ff, 0x5fff00, 0x5fff5f,
0x5fff87, 0x5fffaf, 0x5fffd7, 0x5fffff, 0x870000, 0x87005f, 0x870087, 0x8700af, 0x8700d7, 0x8700ff,
0x875f00, 0x875f5f, 0x875f87, 0x875faf, 0x875fd7, 0x875fff, 0x878700, 0x87875f, 0x878787, 0x8787af,
0x8787d7, 0x8787ff, 0x87af00, 0x87af5f, 0x87af87, 0x87afaf, 0x87afd7, 0x87afff, 0x87d700, 0x87d75f,
0x87d787, 0x87d7af, 0x87d7d7, 0x87d7ff, 0x87ff00, 0x87ff5f, 0x87ff87, 0x87ffaf, 0x87ffd7, 0x87ffff,
0xaf0000, 0xaf005f, 0xaf0087, 0xaf00af, 0xaf00d7, 0xaf00ff, 0xaf5f00, 0xaf5f5f, 0xaf5f87, 0xaf5faf,
0xaf5fd7, 0xaf5fff, 0xaf8700, 0xaf875f, 0xaf8787, 0xaf87af, 0xaf87d7, 0xaf87ff, 0xafaf00, 0xafaf5f,
0xafaf87, 0xafafaf, 0xafafd7, 0xafafff, 0xafd700, 0xafd75f, 0xafd787, 0xafd7af, 0xafd7d7, 0xafd7ff,
0xafff00, 0xafff5f, 0xafff87, 0xafffaf, 0xafffd7, 0xafffff, 0xd70000, 0xd7005f, 0xd70087, 0xd700af,
0xd700d7, 0xd700ff, 0xd75f00, 0xd75f5f, 0xd75f87, 0xd75faf, 0xd75fd7, 0xd75fff, 0xd78700, 0xd7875f,
0xd78787, 0xd787af, 0xd787d7, 0xd787ff, 0xd7af00, 0xd7af5f, 0xd7af87, 0xd7afaf, 0xd7afd7, 0xd7afff,
0xd7d700, 0xd7d75f, 0xd7d787, 0xd7d7af, 0xd7d7d7, 0xd7d7ff, 0xd7ff00, 0xd7ff5f, 0xd7ff87, 0xd7ffaf,
0xd7ffd7, 0xd7ffff, 0xff0000, 0xff005f, 0xff0087, 0xff00af, 0xff00d7, 0xff00ff, 0xff5f00, 0xff5f5f,
0xff5f87, 0xff5faf, 0xff5fd7, 0xff5fff, 0xff8700, 0xff875f, 0xff8787, 0xff87af, 0xff87d7, 0xff87ff,
0xffaf00, 0xffaf5f, 0xffaf87, 0xffafaf, 0xffafd7, 0xffafff, 0xffd700, 0xffd75f, 0xffd787, 0xffd7af,
0xffd7d7, 0xffd7ff, 0xffff00, 0xffff5f, 0xffff87, 0xffffaf, 0xffffd7, 0xffffff, 0x080808, 0x121212,
0x1c1c1c, 0x262626, 0x303030, 0x3a3a3a, 0x444444, 0x4e4e4e, 0x585858, 0x626262, 0x6c6c6c, 0x767676,
0x808080, 0x8a8a8a, 0x949494, 0x9e9e9e, 0xa8a8a8, 0xb2b2b2, 0xbcbcbc, 0xc6c6c6, 0xd0d0d0, 0xdadada,
0xe4e4e4, 0xeeeeee };
private final Map<AnsiColorWrapper, LabColor> lookup;
/**
* 创建具有指定位深度的新 {@link AnsiColors} 实例
* @param bitDepth 所需的位深度
*/
public AnsiColors(BitDepth bitDepth) {
this.lookup = getLookup(bitDepth);
}
private Map<AnsiColorWrapper, LabColor> getLookup(BitDepth bitDepth) {
if (bitDepth == BitDepth.EIGHT) {
Map<AnsiColorWrapper, LabColor> lookup = new LinkedHashMap<>();
for (int i = 0; i < ANSI_8BIT_COLOR_CODE_LOOKUP.length; i++) {
lookup.put(new AnsiColorWrapper(i,BitDepth.EIGHT), new LabColor(ANSI_8BIT_COLOR_CODE_LOOKUP[i]));
}
return Collections.unmodifiableMap(lookup);
}
return ANSI_COLOR_MAP;
}
/**
* 找到最接近给定 AWT {@link Color} {@link AnsiColorWrapper ANSI 颜色包装} 实例
* @param color AWT 颜色
* @return 最接近指定 ANSI 颜色的 {@link AnsiColorWrapper ANSI 颜色包装} 实例
*/
public AnsiColorWrapper findClosest(Color color) {
return findClosest(new LabColor(color));
}
private AnsiColorWrapper findClosest(LabColor color) {
AnsiColorWrapper closest = null;
double closestDistance = Float.MAX_VALUE;
for (Map.Entry<AnsiColorWrapper, LabColor> entry : this.lookup.entrySet()) {
double candidateDistance = color.getDistance(entry.getValue());
if (closest == null || candidateDistance < closestDistance) {
closestDistance = candidateDistance;
closest = entry.getKey();
}
}
return closest;
}
/**
* 表示以 LAB 形式存储的颜色
*/
private static final class LabColor {
private static final ColorSpace XYZ_COLOR_SPACE = ColorSpace.getInstance(ColorSpace.CS_CIEXYZ);
private final double l;
private final double a;
private final double b;
LabColor(Integer rgb) {
this((rgb != null) ? new Color(rgb) : null);
}
LabColor(Color color) {
Assert.notNull(color, "Color must not be null");
float[] lab = fromXyz(color.getColorComponents(XYZ_COLOR_SPACE, null));
this.l = lab[0];
this.a = lab[1];
this.b = lab[2];
}
private float[] fromXyz(float[] xyz) {
return fromXyz(xyz[0], xyz[1], xyz[2]);
}
private float[] fromXyz(float x, float y, float z) {
double l = (f(y) - 16.0) * 116.0;
double a = (f(x) - f(y)) * 500.0;
double b = (f(y) - f(z)) * 200.0;
return new float[] { (float) l, (float) a, (float) b };
}
private double f(double t) {
return (t > (216.0 / 24389.0)) ? Math.cbrt(t) : (1.0 / 3.0) * Math.pow(29.0 / 6.0, 2) * t + (4.0 / 29.0);
}
// See https://en.wikipedia.org/wiki/Color_difference#CIE94
double getDistance(LabColor other) {
double c1 = Math.sqrt(this.a * this.a + this.b * this.b);
double deltaC = c1 - Math.sqrt(other.a * other.a + other.b * other.b);
double deltaA = this.a - other.a;
double deltaB = this.b - other.b;
double deltaH = Math.sqrt(Math.max(0.0, deltaA * deltaA + deltaB * deltaB - deltaC * deltaC));
return Math.sqrt(Math.max(0.0, Math.pow((this.l - other.l) / (1.0), 2)
+ Math.pow(deltaC / (1 + 0.045 * c1), 2) + Math.pow(deltaH / (1 + 0.015 * c1), 2.0)));
}
}
/**
* 此类支持的位深度
*/
public enum BitDepth {
/**
* 4位 (16色).
* @see AnsiColor
* @see AnsiBackground
*/
FOUR(4),
/**
* 8位 (256色).
* @see Ansi8BitColor
*/
EIGHT(8);
private final int bits;
BitDepth(int bits) {
this.bits = bits;
}
public static BitDepth of(int bits) {
for (BitDepth candidate : values()) {
if (candidate.bits == bits) {
return candidate;
}
}
throw new IllegalArgumentException("Unsupported ANSI bit depth '" + bits + "'");
}
}
}

View File

@ -1,8 +1,12 @@
package cn.hutool.core.lang.ansi;
import cn.hutool.core.lang.Console;
import org.junit.Assert;
import org.junit.Ignore;
import org.junit.Test;
import java.awt.*;
public class AnsiEncoderTest {
@Test
@ -10,4 +14,27 @@ public class AnsiEncoderTest {
final String encode = AnsiEncoder.encode(AnsiColor.GREEN, "Hutool test");
Assert.assertEquals("\u001B[32mHutool test\u001B[0;39m", encode);
}
@Test
@Ignore
public void colorfulEncodeTest(){
String text = "Hutool▀████▀";
final AnsiColors ansiColors = new AnsiColors(AnsiColors.BitDepth.EIGHT);
Color[] colorArray = new Color[]{
Color.BLACK, Color.BLUE,
Color.CYAN, Color.DARK_GRAY,
Color.GRAY, Color.GREEN,
Color.LIGHT_GRAY, Color.MAGENTA,
Color.ORANGE, Color.PINK,
Color.RED, Color.WHITE,
Color.YELLOW
};
for (Color foreColor : colorArray) {
AnsiElement foreElement = ansiColors.findClosest(foreColor).toAnsiElement(AnsiColorWrapper.ForeOrBack.FORE);
Color backColor = new Color(255 - foreColor.getRed(), 255 - foreColor.getGreen(), 255 - foreColor.getBlue());
AnsiElement backElement = ansiColors.findClosest(backColor).toAnsiElement(AnsiColorWrapper.ForeOrBack.BACK);
String encode = AnsiEncoder.encode(foreElement, backElement, text);
//Console.print( i%2==1?encode+"\n":encode);
}
}
}