Skip to content

Commit c3b9035

Browse files
quintessequintesse
committed
refactor: create Printable interface for ANSI output
Also added versions of its methods that take an `Appendable` to avoid intermediate String allocations.
1 parent d9b0e47 commit c3b9035

9 files changed

Lines changed: 180 additions & 90 deletions

File tree

‎twinkle-ansi/src/main/java/org/codejive/twinkle/ansi/Ansi.java‎

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
package org.codejive.twinkle.ansi;
22

3+
import java.io.IOException;
4+
35
public class Ansi {
46
public static final char ESC = '\u001B';
57

@@ -68,22 +70,26 @@ public static String style(Object... styles) {
6870
if (styles == null || styles.length == 0) {
6971
return "";
7072
}
71-
return style(new StringBuilder(), styles).toString();
73+
try {
74+
return style(new StringBuilder(), styles).toString();
75+
} catch (IOException e) {
76+
throw new RuntimeException(e);
77+
}
7278
}
7379

74-
public static StringBuilder style(StringBuilder sb, Object... styles) {
80+
public static Appendable style(Appendable appendable, Object... styles) throws IOException {
7581
if (styles == null || styles.length == 0) {
76-
return sb;
82+
return appendable;
7783
}
78-
sb.append(CSI);
84+
appendable.append(CSI);
7985
for (int i = 0; i < styles.length; i++) {
80-
sb.append(styles[i]);
86+
appendable.append(styles[i].toString());
8187
if (i < styles.length - 1) {
82-
sb.append(";");
88+
appendable.append(";");
8389
}
8490
}
85-
sb.append("m");
86-
return sb;
91+
appendable.append("m");
92+
return appendable;
8793
}
8894

8995
public static String foreground(int index) {

‎twinkle-ansi/src/main/java/org/codejive/twinkle/ansi/Printable.java‎

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
package org.codejive.twinkle.ansi;
2+
3+
import java.io.IOException;
4+
import org.jspecify.annotations.NonNull;
5+
6+
public interface Printable {
7+
/**
8+
* Converts the object to an ANSI string, including ANSI escape codes for styles. This method
9+
* resets the current style to default at the start of the string.
10+
*
11+
* @return The ANSI string representation of the object.
12+
*/
13+
@NonNull String toAnsiString();
14+
15+
/**
16+
* Outputs the object as an ANSI string, including ANSI escape codes for styles. This method
17+
* resets the current style to default at the start of the output.
18+
*
19+
* @param appendable The <code>Appendable</code> to write the ANSI output to.
20+
* @return The <code>Appendable</code> passed as parameter.
21+
*/
22+
@NonNull Appendable toAnsi(Appendable appendable) throws IOException;
23+
24+
/**
25+
* Converts the object to an ANSI string, including ANSI escape codes for styles. This method
26+
* takes into account the provided current style to generate a result that is as efficient as
27+
* possible in terms of ANSI codes.
28+
*
29+
* @param currentStyle The current style to start with.
30+
* @return The ANSI string representation of the object.
31+
*/
32+
default @NonNull String toAnsiString(Style currentStyle) {
33+
return toAnsiString(currentStyle.state());
34+
}
35+
36+
/**
37+
* Outputs the object as an ANSI string, including ANSI escape codes for styles. This method
38+
* takes into account the provided current style to generate a result that is as efficient as
39+
* possible in terms of ANSI codes.
40+
*
41+
* @param appendable The <code>Appendable</code> to write the ANSI output to.
42+
* @param currentStyle The current style to start with.
43+
* @return The <code>Appendable</code> passed as parameter.
44+
*/
45+
default @NonNull Appendable toAnsi(Appendable appendable, Style currentStyle)
46+
throws IOException {
47+
return toAnsi(appendable, currentStyle.state());
48+
}
49+
50+
/**
51+
* Converts the object to an ANSI string, including ANSI escape codes for styles. This method
52+
* takes into account the provided current style to generate a result that is as efficient as
53+
* possible in terms of ANSI codes.
54+
*
55+
* @param currentStyleState The current style to start with.
56+
* @return The ANSI string representation of the object.
57+
*/
58+
@NonNull String toAnsiString(long currentStyleState);
59+
60+
/**
61+
* Outputs the object as an ANSI string, including ANSI escape codes for styles. This method
62+
* takes into account the provided current style to generate a result that is as efficient as
63+
* possible in terms of ANSI codes.
64+
*
65+
* @param appendable The <code>Appendable</code> to write the ANSI output to.
66+
* @param currentStyleState The current style to start with.
67+
* @return The <code>Appendable</code> passed as parameter.
68+
*/
69+
@NonNull Appendable toAnsi(Appendable appendable, long currentStyleState) throws IOException;
70+
}

‎twinkle-ansi/src/main/java/org/codejive/twinkle/ansi/Style.java‎

Lines changed: 22 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
package org.codejive.twinkle.ansi;
22

3+
import java.io.IOException;
34
import java.util.ArrayList;
45
import java.util.List;
56
import org.jspecify.annotations.NonNull;
67

7-
public class Style {
8+
public class Style implements Printable {
89
private final long state;
910

1011
private static final long IDX_BOLD = 0;
@@ -347,27 +348,32 @@ public String toString() {
347348
return sb.toString();
348349
}
349350

350-
public String toAnsiString() {
351+
@Override
352+
public @NonNull String toAnsiString() {
351353
return toAnsiString(UNSTYLED);
352354
}
353355

354-
public StringBuilder toAnsiString(StringBuilder sb) {
355-
return toAnsiString(sb, Style.UNSTYLED);
356-
}
357-
358-
public String toAnsiString(Style currentStyle) {
359-
return toAnsiString(currentStyle.state());
360-
}
361-
362-
public StringBuilder toAnsiString(StringBuilder sb, Style currentStyle) {
363-
return toAnsiString(sb, currentStyle.state());
356+
@Override
357+
public @NonNull Appendable toAnsi(Appendable appendable) throws IOException {
358+
try {
359+
return toAnsi(appendable, Style.UNSTYLED);
360+
} catch (IOException e) {
361+
throw new RuntimeException(e);
362+
}
364363
}
365364

366-
public String toAnsiString(long currentStyleState) {
367-
return toAnsiString(new StringBuilder(), currentStyleState).toString();
365+
@Override
366+
public @NonNull String toAnsiString(long currentStyleState) {
367+
try {
368+
return toAnsi(new StringBuilder(), currentStyleState).toString();
369+
} catch (IOException e) {
370+
throw new RuntimeException(e);
371+
}
368372
}
369373

370-
public StringBuilder toAnsiString(StringBuilder sb, long currentStyleState) {
374+
@Override
375+
public @NonNull Appendable toAnsi(Appendable appendable, long currentStyleState)
376+
throws IOException {
371377
List<Object> styles = new ArrayList<>();
372378
if ((currentStyleState & (F_BOLD | F_FAINT)) != (state & (F_BOLD | F_FAINT))) {
373379
// First we switch to NORMAL to clear both BOLD and FAINT
@@ -426,6 +432,6 @@ public StringBuilder toAnsiString(StringBuilder sb, long currentStyleState) {
426432
if ((currentStyleState & MASK_BG_COLOR) != (state & MASK_BG_COLOR)) {
427433
styles.add(bgColor().toAnsiBgArgs());
428434
}
429-
return Ansi.style(sb, styles.toArray());
435+
return Ansi.style(appendable, styles.toArray());
430436
}
431437
}

‎twinkle-chart/src/test/java/examples/BarDemo.java‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,18 +22,18 @@ private static void printSimpleBar() {
2222
Panel pnl = Panel.of(20, 1);
2323
Bar b = Bar.bar().setValue(42);
2424
b.render(pnl);
25-
System.out.println(pnl.toString());
25+
System.out.println(pnl);
2626
}
2727

2828
private static void printHorizontalBars() {
2929
Panel pnl = Panel.of(20, 4);
3030
FracBarConfig cfg = FracBarConfig.create();
3131
renderHorizontal(pnl, cfg);
32-
System.out.println(pnl.toString());
32+
System.out.println(pnl);
3333

3434
cfg.direction(BarConfig.Direction.R2L);
3535
renderHorizontal(pnl, cfg);
36-
System.out.println(pnl.toString());
36+
System.out.println(pnl);
3737
}
3838

3939
private static void renderHorizontal(Panel pnl, FracBarConfig cfg) {
@@ -48,11 +48,11 @@ private static void printVerticalBars() {
4848
Panel pnl = Panel.of(16, 8);
4949
FracBarConfig cfg = FracBarConfig.create().direction(BarConfig.Direction.B2T);
5050
renderVertical(pnl, cfg);
51-
System.out.println(pnl.toString());
51+
System.out.println(pnl);
5252

5353
cfg.direction(BarConfig.Direction.T2B);
5454
renderVertical(pnl, cfg);
55-
System.out.println(pnl.toString());
55+
System.out.println(pnl);
5656
}
5757

5858
private static void renderVertical(Panel pnl, FracBarConfig cfg) {

‎twinkle-chart/src/test/java/examples/MathPlotFourDemo.java‎

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
// java
22
package examples;
33

4+
import java.io.IOException;
5+
import java.io.PrintWriter;
46
import java.util.Random;
57
import org.codejive.twinkle.ansi.Ansi;
68
import org.codejive.twinkle.ansi.Color;
@@ -15,7 +17,7 @@
1517
import org.jspecify.annotations.NonNull;
1618

1719
public class MathPlotFourDemo {
18-
public static void main(String[] args) throws InterruptedException {
20+
public static void main(String[] args) throws InterruptedException, IOException {
1921
Panel pnl = Panel.of(60, 40);
2022
AnimatingMathPlot p1 = new AnimatingMathPlot(Size.of(30, 20), " Interfering Waves 1 ");
2123
AnimatingMathPlot p2 = new AnimatingMathPlot(Size.of(30, 20), " Interfering Waves 2 ");
@@ -26,11 +28,12 @@ public static void main(String[] args) throws InterruptedException {
2628
Canvas v3 = pnl.view(0, 20, 30, 20);
2729
Canvas v4 = pnl.view(30, 20, 30, 20);
2830

29-
System.out.print(Ansi.hideCursor());
31+
PrintWriter pout = new PrintWriter(System.out);
32+
pout.print(Ansi.hideCursor());
3033
try {
3134
for (int i = 0; i < 400; i++) {
3235
if (i > 0) {
33-
System.out.print(Ansi.cursorMove(Ansi.CURSOR_PREV_LINE, pnl.size().height()));
36+
pout.print(Ansi.cursorMove(Ansi.CURSOR_PREV_LINE, pnl.size().height()));
3437
}
3538

3639
p1.update();
@@ -43,12 +46,13 @@ public static void main(String[] args) throws InterruptedException {
4346
p3.render(v3);
4447
p4.render(v4);
4548

46-
System.out.println(pnl.toAnsiString());
49+
pnl.toAnsi(pout);
50+
pout.println();
4751

4852
Thread.sleep(20);
4953
}
5054
} finally {
51-
System.out.print(Ansi.showCursor());
55+
pout.print(Ansi.showCursor());
5256
}
5357
}
5458
}

‎twinkle-core/src/main/java/org/codejive/twinkle/core/text/StyledBuffer.java‎

Lines changed: 2 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
11
package org.codejive.twinkle.core.text;
22

3+
import org.codejive.twinkle.ansi.Printable;
34
import org.codejive.twinkle.ansi.Style;
45
import org.jspecify.annotations.NonNull;
56

6-
public interface StyledBuffer extends StyledCharSequence {
7+
public interface StyledBuffer extends StyledCharSequence, Printable {
78

89
char REPLACEMENT_CHAR = '\uFFFD';
910

@@ -35,36 +36,6 @@ default int putStringAt(int index, @NonNull Style style, @NonNull CharSequence s
3536

3637
@NonNull StyledBuffer resize(int newSize);
3738

38-
/**
39-
* Converts the buffer to an ANSI string, including ANSI escape codes for styles. This method
40-
* resets the current style to default at the start of the string.
41-
*
42-
* @return The ANSI string representation of the styled buffer.
43-
*/
44-
@NonNull String toAnsiString();
45-
46-
/**
47-
* Converts the buffer to an ANSI string, including ANSI escape codes for styles. This method
48-
* takes into account the provided current style to generate a result that is as efficient as
49-
* possible in terms of ANSI codes.
50-
*
51-
* @param currentStyle The current style to start with.
52-
* @return The ANSI string representation of the styled buffer.
53-
*/
54-
default @NonNull String toAnsiString(Style currentStyle) {
55-
return toAnsiString(currentStyle.state());
56-
}
57-
58-
/**
59-
* Converts the buffer to an ANSI string, including ANSI escape codes for styles. This method
60-
* takes into account the provided current style to generate a result that is as efficient as
61-
* possible in terms of ANSI codes.
62-
*
63-
* @param currentStyle The current style to start with.
64-
* @return The ANSI string representation of the styled buffer.
65-
*/
66-
@NonNull String toAnsiString(long currentStyle);
67-
6839
StyledBuffer EMPTY =
6940
new StyledCodepointBuffer(0) {
7041
@Override

‎twinkle-core/src/main/java/org/codejive/twinkle/core/text/StyledCodepointBuffer.java‎

Lines changed: 31 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
package org.codejive.twinkle.core.text;
22

3+
import java.io.IOException;
34
import org.codejive.twinkle.ansi.Ansi;
45
import org.codejive.twinkle.ansi.Style;
56
import org.jspecify.annotations.NonNull;
@@ -255,8 +256,17 @@ private boolean outside(int index, int length) {
255256
// plus 20 extra for escape codes
256257
int initialCapacity = length() + 20;
257258
StringBuilder sb = new StringBuilder(initialCapacity);
258-
sb.append(Ansi.STYLE_RESET);
259-
return toAnsiString(sb, Style.UNSTYLED.state()).toString();
259+
try {
260+
return toAnsi(sb).toString();
261+
} catch (IOException e) {
262+
throw new RuntimeException(e);
263+
}
264+
}
265+
266+
@Override
267+
public @NonNull Appendable toAnsi(Appendable appendable) throws IOException {
268+
appendable.append(Ansi.STYLE_RESET);
269+
return toAnsi(appendable, Style.UNSTYLED.state());
260270
}
261271

262272
/**
@@ -278,22 +288,36 @@ private boolean outside(int index, int length) {
278288
// plus 20 extra for escape codes
279289
int initialCapacity = length() + 20;
280290
StringBuilder sb = new StringBuilder(initialCapacity);
281-
return toAnsiString(sb, styleState).toString();
291+
try {
292+
return toAnsi(sb, styleState).toString();
293+
} catch (IOException e) {
294+
throw new RuntimeException(e);
295+
}
282296
}
283297

284-
private @NonNull StringBuilder toAnsiString(StringBuilder sb, long lastStyleState) {
298+
@Override
299+
public @NonNull Appendable toAnsi(Appendable appendable, long lastStyleState)
300+
throws IOException {
285301
for (int i = 0; i < length(); i++) {
286302
if (styleBuffer[i] != lastStyleState) {
287303
Style style = Style.of(styleBuffer[i]);
288-
style.toAnsiString(sb, lastStyleState);
304+
style.toAnsi(appendable, lastStyleState);
289305
lastStyleState = styleBuffer[i];
290306
}
291307
int cp = cpBuffer[i];
292308
if (cp == '\0') {
293309
cp = ' ';
294310
}
295-
sb.appendCodePoint(cp);
311+
if (Character.isBmpCodePoint(cp)) {
312+
appendable.append((char) cp);
313+
} else if (Character.isValidCodePoint(cp)) {
314+
appendable.append(Character.lowSurrogate(cp));
315+
appendable.append(Character.highSurrogate(cp));
316+
} else {
317+
throw new IllegalArgumentException(
318+
String.format("Not a valid Unicode code point: 0x%X", cp));
319+
}
296320
}
297-
return sb;
321+
return appendable;
298322
}
299323
}

0 commit comments

Comments
 (0)