2 * Jexer - Java Text User Interface
4 * The MIT License (MIT)
6 * Copyright (C) 2019 Kevin Lamonte
8 * Permission is hereby granted, free of charge, to any person obtaining a
9 * copy of this software and associated documentation files (the "Software"),
10 * to deal in the Software without restriction, including without limitation
11 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
12 * and/or sell copies of the Software, and to permit persons to whom the
13 * Software is furnished to do so, subject to the following conditions:
15 * The above copyright notice and this permission notice shall be included in
16 * all copies or substantial portions of the Software.
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
21 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
23 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
24 * DEALINGS IN THE SOFTWARE.
26 * @author Kevin Lamonte [kevin.lamonte@gmail.com]
29 package jexer
.backend
;
31 import java
.awt
.image
.BufferedImage
;
32 import java
.io
.BufferedReader
;
33 import java
.io
.FileDescriptor
;
34 import java
.io
.FileInputStream
;
35 import java
.io
.InputStream
;
36 import java
.io
.InputStreamReader
;
37 import java
.io
.IOException
;
38 import java
.io
.OutputStream
;
39 import java
.io
.OutputStreamWriter
;
40 import java
.io
.PrintWriter
;
41 import java
.io
.Reader
;
42 import java
.io
.UnsupportedEncodingException
;
43 import java
.util
.ArrayList
;
44 import java
.util
.Collections
;
45 import java
.util
.HashMap
;
46 import java
.util
.List
;
47 import java
.util
.LinkedList
;
51 import jexer
.bits
.Cell
;
52 import jexer
.bits
.CellAttributes
;
53 import jexer
.bits
.Color
;
54 import jexer
.event
.TInputEvent
;
55 import jexer
.event
.TKeypressEvent
;
56 import jexer
.event
.TMouseEvent
;
57 import jexer
.event
.TResizeEvent
;
58 import static jexer
.TKeypress
.*;
61 * This class reads keystrokes and mouse events and emits output to ANSI
62 * X3.64 / ECMA-48 type terminals e.g. xterm, linux, vt100, ansi.sys, etc.
64 public class ECMA48Terminal
extends LogicalScreen
65 implements TerminalReader
, Runnable
{
67 // ------------------------------------------------------------------------
68 // Constants --------------------------------------------------------------
69 // ------------------------------------------------------------------------
72 * States in the input parser.
74 private enum ParseState
{
85 * Number of colors in the sixel palette. Xterm 335 defines the max as
88 private static final int MAX_COLOR_REGISTERS
= 1024;
90 // ------------------------------------------------------------------------
91 // Variables --------------------------------------------------------------
92 // ------------------------------------------------------------------------
95 * Emit debugging to stderr.
97 private boolean debugToStderr
= false;
100 * If true, emit T.416-style RGB colors for normal system colors. This
101 * is a) expensive in bandwidth, and b) potentially terrible looking for
104 private static boolean doRgbColor
= false;
107 * The session information.
109 private SessionInfo sessionInfo
;
112 * The event queue, filled up by a thread reading on input.
114 private List
<TInputEvent
> eventQueue
;
117 * If true, we want the reader thread to exit gracefully.
119 private boolean stopReaderThread
;
124 private Thread readerThread
;
127 * Parameters being collected. E.g. if the string is \033[1;3m, then
128 * params[0] will be 1 and params[1] will be 3.
130 private List
<String
> params
;
133 * Current parsing state.
135 private ParseState state
;
138 * The time we entered ESCAPE. If we get a bare escape without a code
139 * following it, this is used to return that bare escape.
141 private long escapeTime
;
144 * The time we last checked the window size. We try not to spawn stty
145 * more than once per second.
147 private long windowSizeTime
;
150 * true if mouse1 was down. Used to report mouse1 on the release event.
152 private boolean mouse1
;
155 * true if mouse2 was down. Used to report mouse2 on the release event.
157 private boolean mouse2
;
160 * true if mouse3 was down. Used to report mouse3 on the release event.
162 private boolean mouse3
;
165 * Cache the cursor visibility value so we only emit the sequence when we
168 private boolean cursorOn
= true;
171 * Cache the last window size to figure out if a TResizeEvent needs to be
174 private TResizeEvent windowResize
= null;
177 * Window width in pixels. Used for sixel support.
179 private int widthPixels
= 640;
182 * Window height in pixels. Used for sixel support.
184 private int heightPixels
= 400;
187 * If true, emit image data via sixel.
189 private boolean sixel
= true;
192 * The sixel palette handler.
194 private SixelPalette palette
= null;
197 * The sixel post-rendered string cache.
199 private SixelCache sixelCache
= null;
202 * If true, then we changed System.in and need to change it back.
204 private boolean setRawMode
;
207 * The terminal's input. If an InputStream is not specified in the
208 * constructor, then this InputStreamReader will be bound to System.in
209 * with UTF-8 encoding.
211 private Reader input
;
214 * The terminal's raw InputStream. If an InputStream is not specified in
215 * the constructor, then this InputReader will be bound to System.in.
216 * This is used by run() to see if bytes are available() before calling
217 * (Reader)input.read().
219 private InputStream inputStream
;
222 * The terminal's output. If an OutputStream is not specified in the
223 * constructor, then this PrintWriter will be bound to System.out with
226 private PrintWriter output
;
229 * The listening object that run() wakes up on new input.
231 private Object listener
;
234 * SixelPalette is used to manage the conversion of images between 24-bit
235 * RGB color and a palette of MAX_COLOR_REGISTERS colors.
237 private class SixelPalette
{
240 * Color palette for sixel output, sorted low to high.
242 private List
<Integer
> rgbColors
= new ArrayList
<Integer
>();
245 * Map of color palette index for sixel output, from the order it was
246 * generated by makePalette() to rgbColors.
248 private int [] rgbSortedIndex
= new int[MAX_COLOR_REGISTERS
];
251 * The color palette, organized by hue, saturation, and luminance.
252 * This is used for a fast color match.
254 private ArrayList
<ArrayList
<ArrayList
<ColorIdx
>>> hslColors
;
257 * Number of bits for hue.
259 private int hueBits
= -1;
262 * Number of bits for saturation.
264 private int satBits
= -1;
267 * Number of bits for luminance.
269 private int lumBits
= -1;
272 * Step size for hue bins.
274 private int hueStep
= -1;
277 * Step size for saturation bins.
279 private int satStep
= -1;
282 * Cached RGB to HSL result.
284 private int hsl
[] = new int[3];
287 * ColorIdx records a RGB color and its palette index.
289 private class ColorIdx
{
291 * The 24-bit RGB color.
296 * The palette index for this color.
301 * Public constructor.
303 * @param color the 24-bit RGB color
304 * @param index the palette index for this color
306 public ColorIdx(final int color
, final int index
) {
313 * Public constructor.
315 public SixelPalette() {
320 * Find the nearest match for a color in the palette.
322 * @param color the RGB color
323 * @return the index in rgbColors that is closest to color
325 public int matchColor(final int color
) {
330 * matchColor() is a critical performance bottleneck. To make it
331 * decent, we do the following:
333 * 1. Find the nearest two hues that bracket this color.
335 * 2. Find the nearest two saturations that bracket this color.
337 * 3. Iterate within these four bands of luminance values,
338 * returning the closest color by Euclidean distance.
340 * This strategy reduces the search space by about 97%.
342 int red
= (color
>>> 16) & 0xFF;
343 int green
= (color
>>> 8) & 0xFF;
344 int blue
= color
& 0xFF;
346 rgbToHsl(red
, green
, blue
, hsl
);
350 // System.err.printf("%d %d %d\n", hue, sat, lum);
352 double diff
= Double
.MAX_VALUE
;
355 int hue1
= hue
/ (360/hueStep
);
357 if (hue1
>= hslColors
.size() - 1) {
358 // Bracket pure red from above.
359 hue1
= hslColors
.size() - 1;
361 } else if (hue1
== 0) {
362 // Bracket pure red from below.
363 hue2
= hslColors
.size() - 1;
366 for (int hI
= hue1
; hI
!= -1;) {
367 ArrayList
<ArrayList
<ColorIdx
>> sats
= hslColors
.get(hI
);
370 } else if (hI
== hue2
) {
374 int sMin
= (sat
/ satStep
) - 1;
379 } else if (sMin
== sats
.size() - 1) {
384 assert (sMax
- sMin
== 1);
387 // int sMax = sats.size() - 1;
389 for (int sI
= sMin
; sI
<= sMax
; sI
++) {
390 ArrayList
<ColorIdx
> lums
= sats
.get(sI
);
392 // True 3D colorspace match for the remaining values
393 for (ColorIdx c
: lums
) {
394 int rgbColor
= c
.color
;
396 int red2
= (rgbColor
>>> 16) & 0xFF;
397 int green2
= (rgbColor
>>> 8) & 0xFF;
398 int blue2
= rgbColor
& 0xFF;
399 newDiff
+= Math
.pow(red2
- red
, 2);
400 newDiff
+= Math
.pow(green2
- green
, 2);
401 newDiff
+= Math
.pow(blue2
- blue
, 2);
402 if (newDiff
< diff
) {
403 idx
= rgbSortedIndex
[c
.index
];
410 if (((red
* red
) + (green
* green
) + (blue
* blue
)) < diff
) {
411 // Black is a closer match.
413 } else if ((((255 - red
) * (255 - red
)) +
414 ((255 - green
) * (255 - green
)) +
415 ((255 - blue
) * (255 - blue
))) < diff
) {
417 // White is a closer match.
418 idx
= MAX_COLOR_REGISTERS
- 1;
425 * Clamp an int value to [0, 255].
427 * @param x the int value
428 * @return an int between 0 and 255.
430 private int clamp(final int x
) {
441 * Dither an image to a MAX_COLOR_REGISTERS palette. The dithered
442 * image cells will contain indexes into the palette.
444 * @param image the image to dither
445 * @return the dithered image. Every pixel is an index into the
448 public BufferedImage
ditherImage(final BufferedImage image
) {
450 BufferedImage ditheredImage
= new BufferedImage(image
.getWidth(),
451 image
.getHeight(), BufferedImage
.TYPE_INT_ARGB
);
453 int [] rgbArray
= image
.getRGB(0, 0, image
.getWidth(),
454 image
.getHeight(), null, 0, image
.getWidth());
455 ditheredImage
.setRGB(0, 0, image
.getWidth(), image
.getHeight(),
456 rgbArray
, 0, image
.getWidth());
458 for (int imageY
= 0; imageY
< image
.getHeight(); imageY
++) {
459 for (int imageX
= 0; imageX
< image
.getWidth(); imageX
++) {
460 int oldPixel
= ditheredImage
.getRGB(imageX
,
462 int colorIdx
= matchColor(oldPixel
);
463 assert (colorIdx
>= 0);
464 assert (colorIdx
< MAX_COLOR_REGISTERS
);
465 int newPixel
= rgbColors
.get(colorIdx
);
466 ditheredImage
.setRGB(imageX
, imageY
, colorIdx
);
468 int oldRed
= (oldPixel
>>> 16) & 0xFF;
469 int oldGreen
= (oldPixel
>>> 8) & 0xFF;
470 int oldBlue
= oldPixel
& 0xFF;
472 int newRed
= (newPixel
>>> 16) & 0xFF;
473 int newGreen
= (newPixel
>>> 8) & 0xFF;
474 int newBlue
= newPixel
& 0xFF;
476 int redError
= (oldRed
- newRed
) / 16;
477 int greenError
= (oldGreen
- newGreen
) / 16;
478 int blueError
= (oldBlue
- newBlue
) / 16;
480 int red
, green
, blue
;
481 if (imageX
< image
.getWidth() - 1) {
482 int pXpY
= ditheredImage
.getRGB(imageX
+ 1, imageY
);
483 red
= (int) ((pXpY
>>> 16) & 0xFF) + (7 * redError
);
484 green
= (int) ((pXpY
>>> 8) & 0xFF) + (7 * greenError
);
485 blue
= (int) ( pXpY
& 0xFF) + (7 * blueError
);
487 green
= clamp(green
);
489 pXpY
= ((red
& 0xFF) << 16);
490 pXpY
|= ((green
& 0xFF) << 8) | (blue
& 0xFF);
491 ditheredImage
.setRGB(imageX
+ 1, imageY
, pXpY
);
493 if (imageY
< image
.getHeight() - 1) {
494 int pXpYp
= ditheredImage
.getRGB(imageX
+ 1,
496 red
= (int) ((pXpYp
>>> 16) & 0xFF) + redError
;
497 green
= (int) ((pXpYp
>>> 8) & 0xFF) + greenError
;
498 blue
= (int) ( pXpYp
& 0xFF) + blueError
;
500 green
= clamp(green
);
502 pXpYp
= ((red
& 0xFF) << 16);
503 pXpYp
|= ((green
& 0xFF) << 8) | (blue
& 0xFF);
504 ditheredImage
.setRGB(imageX
+ 1, imageY
+ 1, pXpYp
);
506 } else if (imageY
< image
.getHeight() - 1) {
507 int pXmYp
= ditheredImage
.getRGB(imageX
- 1,
509 int pXYp
= ditheredImage
.getRGB(imageX
,
512 red
= (int) ((pXmYp
>>> 16) & 0xFF) + (3 * redError
);
513 green
= (int) ((pXmYp
>>> 8) & 0xFF) + (3 * greenError
);
514 blue
= (int) ( pXmYp
& 0xFF) + (3 * blueError
);
516 green
= clamp(green
);
518 pXmYp
= ((red
& 0xFF) << 16);
519 pXmYp
|= ((green
& 0xFF) << 8) | (blue
& 0xFF);
520 ditheredImage
.setRGB(imageX
- 1, imageY
+ 1, pXmYp
);
522 red
= (int) ((pXYp
>>> 16) & 0xFF) + (5 * redError
);
523 green
= (int) ((pXYp
>>> 8) & 0xFF) + (5 * greenError
);
524 blue
= (int) ( pXYp
& 0xFF) + (5 * blueError
);
526 green
= clamp(green
);
528 pXYp
= ((red
& 0xFF) << 16);
529 pXYp
|= ((green
& 0xFF) << 8) | (blue
& 0xFF);
530 ditheredImage
.setRGB(imageX
, imageY
+ 1, pXYp
);
532 } // for (int imageY = 0; imageY < image.getHeight(); imageY++)
533 } // for (int imageX = 0; imageX < image.getWidth(); imageX++)
535 return ditheredImage
;
539 * Convert an RGB color to HSL.
541 * @param red red color, between 0 and 255
542 * @param green green color, between 0 and 255
543 * @param blue blue color, between 0 and 255
544 * @param hsl the hsl color as [hue, saturation, luminance]
546 private void rgbToHsl(final int red
, final int green
,
547 final int blue
, final int [] hsl
) {
549 assert ((red
>= 0) && (red
<= 255));
550 assert ((green
>= 0) && (green
<= 255));
551 assert ((blue
>= 0) && (blue
<= 255));
553 double R
= red
/ 255.0;
554 double G
= green
/ 255.0;
555 double B
= blue
/ 255.0;
556 boolean Rmax
= false;
557 boolean Gmax
= false;
558 boolean Bmax
= false;
559 double min
= (R
< G ? R
: G
);
560 min
= (min
< B ? min
: B
);
562 if ((R
>= G
) && (R
>= B
)) {
565 } else if ((G
>= R
) && (G
>= B
)) {
568 } else if ((B
>= G
) && (B
>= R
)) {
573 double L
= (min
+ max
) / 2.0;
578 S
= (max
- min
) / (max
+ min
);
580 S
= (max
- min
) / (2.0 - max
- min
);
584 assert (Gmax
== false);
585 assert (Bmax
== false);
586 H
= (G
- B
) / (max
- min
);
588 assert (Rmax
== false);
589 assert (Bmax
== false);
590 H
= 2.0 + (B
- R
) / (max
- min
);
592 assert (Rmax
== false);
593 assert (Gmax
== false);
594 H
= 4.0 + (R
- G
) / (max
- min
);
599 hsl
[0] = (int) (H
* 60.0);
600 hsl
[1] = (int) (S
* 100.0);
601 hsl
[2] = (int) (L
* 100.0);
603 assert ((hsl
[0] >= 0) && (hsl
[0] <= 360));
604 assert ((hsl
[1] >= 0) && (hsl
[1] <= 100));
605 assert ((hsl
[2] >= 0) && (hsl
[2] <= 100));
609 * Convert a HSL color to RGB.
611 * @param hue hue, between 0 and 359
612 * @param sat saturation, between 0 and 100
613 * @param lum luminance, between 0 and 100
614 * @return the rgb color as 0x00RRGGBB
616 private int hslToRgb(final int hue
, final int sat
, final int lum
) {
617 assert ((hue
>= 0) && (hue
<= 360));
618 assert ((sat
>= 0) && (sat
<= 100));
619 assert ((lum
>= 0) && (lum
<= 100));
621 double S
= sat
/ 100.0;
622 double L
= lum
/ 100.0;
623 double C
= (1.0 - Math
.abs((2.0 * L
) - 1.0)) * S
;
624 double Hp
= hue
/ 60.0;
625 double X
= C
* (1.0 - Math
.abs((Hp
% 2) - 1.0));
632 } else if (Hp
<= 2.0) {
635 } else if (Hp
<= 3.0) {
638 } else if (Hp
<= 4.0) {
641 } else if (Hp
<= 5.0) {
644 } else if (Hp
<= 6.0) {
648 double m
= L
- (C
/ 2.0);
649 int red
= ((int) ((Rp
+ m
) * 255.0)) << 16;
650 int green
= ((int) ((Gp
+ m
) * 255.0)) << 8;
651 int blue
= (int) ((Bp
+ m
) * 255.0);
653 return (red
| green
| blue
);
657 * Create the sixel palette.
659 private void makePalette() {
660 // Generate the sixel palette. Because we have no idea at this
661 // layer which image(s) will be shown, we have to use a common
662 // palette with MAX_COLOR_REGISTERS colors for everything, and
663 // map the BufferedImage colors to their nearest neighbor in RGB
666 // We build a palette using the Hue-Saturation-Luminence model,
667 // with 5+ bits for Hue, 2+ bits for Saturation, and 1+ bit for
668 // Luminance. We convert these colors to 24-bit RGB, sort them
669 // ascending, and steal the first index for pure black and the
670 // last for pure white. The 8-bit final palette favors bright
671 // colors, somewhere between pastel and classic television
672 // technicolor. 9- and 10-bit palettes are more uniform.
674 // Default at 256 colors.
679 assert (MAX_COLOR_REGISTERS
>= 256);
680 assert ((MAX_COLOR_REGISTERS
== 256)
681 || (MAX_COLOR_REGISTERS
== 512)
682 || (MAX_COLOR_REGISTERS
== 1024)
683 || (MAX_COLOR_REGISTERS
== 2048));
685 switch (MAX_COLOR_REGISTERS
) {
702 hueStep
= (int) (Math
.pow(2, hueBits
));
703 satStep
= (int) (100 / Math
.pow(2, satBits
));
704 // 1 bit for luminance: 40 and 70.
709 // 2 bits: 20, 40, 60, 80
714 // 3 bits: 8, 20, 32, 44, 56, 68, 80, 92
720 // System.err.printf("<html><body>\n");
721 // Hue is evenly spaced around the wheel.
722 hslColors
= new ArrayList
<ArrayList
<ArrayList
<ColorIdx
>>>();
724 final boolean DEBUG
= false;
725 ArrayList
<Integer
> rawRgbList
= new ArrayList
<Integer
>();
727 for (int hue
= 0; hue
< (360 - (360 % hueStep
));
728 hue
+= (360/hueStep
)) {
730 ArrayList
<ArrayList
<ColorIdx
>> satList
= null;
731 satList
= new ArrayList
<ArrayList
<ColorIdx
>>();
732 hslColors
.add(satList
);
734 // Saturation is linearly spaced between pastel and pure.
735 for (int sat
= satStep
; sat
<= 100; sat
+= satStep
) {
737 ArrayList
<ColorIdx
> lumList
= new ArrayList
<ColorIdx
>();
738 satList
.add(lumList
);
740 // Luminance brackets the pure color, but leaning toward
742 for (int lum
= lumBegin
; lum
< 100; lum
+= lumStep
) {
744 System.err.printf("<font style = \"color:");
745 System.err.printf("hsl(%d, %d%%, %d%%)",
747 System.err.printf(";\">=</font>\n");
749 int rgbColor
= hslToRgb(hue
, sat
, lum
);
750 rgbColors
.add(rgbColor
);
751 ColorIdx colorIdx
= new ColorIdx(rgbColor
,
752 rgbColors
.size() - 1);
753 lumList
.add(colorIdx
);
755 rawRgbList
.add(rgbColor
);
757 int red
= (rgbColor
>>> 16) & 0xFF;
758 int green
= (rgbColor
>>> 8) & 0xFF;
759 int blue
= rgbColor
& 0xFF;
760 int [] backToHsl
= new int[3];
761 rgbToHsl(red
, green
, blue
, backToHsl
);
762 System
.err
.printf("%d [%d] %d [%d] %d [%d]\n",
763 hue
, backToHsl
[0], sat
, backToHsl
[1],
769 // System.err.printf("\n</body></html>\n");
771 assert (rgbColors
.size() == MAX_COLOR_REGISTERS
);
774 * We need to sort rgbColors, so that toSixel() can know where
775 * BLACK and WHITE are in it. But we also need to be able to
776 * find the sorted values using the old unsorted indexes. So we
777 * will sort it, put all the indexes into a HashMap, and then
778 * build rgbSortedIndex[].
780 Collections
.sort(rgbColors
);
781 HashMap
<Integer
, Integer
> rgbColorIndices
= null;
782 rgbColorIndices
= new HashMap
<Integer
, Integer
>();
783 for (int i
= 0; i
< MAX_COLOR_REGISTERS
; i
++) {
784 rgbColorIndices
.put(rgbColors
.get(i
), i
);
786 for (int i
= 0; i
< MAX_COLOR_REGISTERS
; i
++) {
787 int rawColor
= rawRgbList
.get(i
);
788 rgbSortedIndex
[i
] = rgbColorIndices
.get(rawColor
);
791 for (int i
= 0; i
< MAX_COLOR_REGISTERS
; i
++) {
792 assert (rawRgbList
!= null);
793 int idx
= rgbSortedIndex
[i
];
794 int rgbColor
= rgbColors
.get(idx
);
795 if ((idx
!= 0) && (idx
!= MAX_COLOR_REGISTERS
- 1)) {
797 System.err.printf("%d %06x --> %d %06x\n",
798 i, rawRgbList.get(i), idx, rgbColors.get(idx));
800 assert (rgbColor
== rawRgbList
.get(i
));
805 // Set the dimmest color as true black, and the brightest as true
808 rgbColors
.set(MAX_COLOR_REGISTERS
- 1, 0xFFFFFF);
811 System.err.printf("<html><body>\n");
812 for (Integer rgb: rgbColors) {
813 System.err.printf("<font style = \"color:");
814 System.err.printf("#%06x", rgb);
815 System.err.printf(";\">=</font>\n");
817 System.err.printf("\n</body></html>\n");
823 * Emit the sixel palette.
825 * @param sb the StringBuilder to append to
826 * @param used array of booleans set to true for each color actually
827 * used in this cell, or null to emit the entire palette
828 * @return the string to emit to an ANSI / ECMA-style terminal
830 public String
emitPalette(final StringBuilder sb
,
831 final boolean [] used
) {
833 for (int i
= 0; i
< MAX_COLOR_REGISTERS
; i
++) {
834 if (((used
!= null) && (used
[i
] == true)) || (used
== null)) {
835 int rgbColor
= rgbColors
.get(i
);
836 sb
.append(String
.format("#%d;2;%d;%d;%d", i
,
837 ((rgbColor
>>> 16) & 0xFF) * 100 / 255,
838 ((rgbColor
>>> 8) & 0xFF) * 100 / 255,
839 ( rgbColor
& 0xFF) * 100 / 255));
842 return sb
.toString();
847 * SixelCache is a least-recently-used cache that hangs on to the
848 * post-rendered sixel string for a particular set of cells.
850 private class SixelCache
{
853 * Maximum size of the cache.
855 private int maxSize
= 100;
858 * The entries stored in the cache.
860 private HashMap
<String
, CacheEntry
> cache
= null;
863 * CacheEntry is one entry in the cache.
865 private class CacheEntry
{
877 * The last time this entry was used.
879 public long millis
= 0;
882 * Public constructor.
884 * @param key the cache entry key
885 * @param data the cache entry data
887 public CacheEntry(final String key
, final String data
) {
890 this.millis
= System
.currentTimeMillis();
895 * Public constructor.
897 * @param maxSize the maximum size of the cache
899 public SixelCache(final int maxSize
) {
900 this.maxSize
= maxSize
;
901 cache
= new HashMap
<String
, CacheEntry
>();
905 * Make a unique key for a list of cells.
907 * @param cells the cells
910 private String
makeKey(final ArrayList
<Cell
> cells
) {
911 StringBuilder sb
= new StringBuilder();
912 for (Cell cell
: cells
) {
913 sb
.append(cell
.hashCode());
915 return sb
.toString();
919 * Get an entry from the cache.
921 * @param cells the list of cells that are the cache key
922 * @return the sixel string representing these cells, or null if this
923 * list of cells is not in the cache
925 public String
get(final ArrayList
<Cell
> cells
) {
926 CacheEntry entry
= cache
.get(makeKey(cells
));
930 entry
.millis
= System
.currentTimeMillis();
935 * Put an entry into the cache.
937 * @param cells the list of cells that are the cache key
938 * @param data the sixel string representing these cells
940 public void put(final ArrayList
<Cell
> cells
, final String data
) {
941 String key
= makeKey(cells
);
943 // System.err.println("put() " + key + " size " + cache.size());
945 assert (!cache
.containsKey(key
));
947 assert (cache
.size() <= maxSize
);
948 if (cache
.size() == maxSize
) {
949 // Cache is at limit, evict oldest entry.
950 long oldestTime
= Long
.MAX_VALUE
;
951 String keyToRemove
= null;
952 for (CacheEntry entry
: cache
.values()) {
953 if ((entry
.millis
< oldestTime
) || (keyToRemove
== null)) {
954 keyToRemove
= entry
.key
;
955 oldestTime
= entry
.millis
;
959 System.err.println("put() remove key = " + keyToRemove +
960 " size " + cache.size());
962 assert (keyToRemove
!= null);
963 cache
.remove(keyToRemove
);
965 System.err.println("put() removed, size " + cache.size());
968 assert (cache
.size() <= maxSize
);
969 CacheEntry entry
= new CacheEntry(key
, data
);
970 assert (key
.equals(entry
.key
));
971 cache
.put(key
, entry
);
973 System.err.println("put() added key " + key + " " +
974 " size " + cache.size());
980 // ------------------------------------------------------------------------
981 // Constructors -----------------------------------------------------------
982 // ------------------------------------------------------------------------
985 * Constructor sets up state for getEvent().
987 * @param listener the object this backend needs to wake up when new
989 * @param input an InputStream connected to the remote user, or null for
990 * System.in. If System.in is used, then on non-Windows systems it will
991 * be put in raw mode; shutdown() will (blindly!) put System.in in cooked
992 * mode. input is always converted to a Reader with UTF-8 encoding.
993 * @param output an OutputStream connected to the remote user, or null
994 * for System.out. output is always converted to a Writer with UTF-8
996 * @param windowWidth the number of text columns to start with
997 * @param windowHeight the number of text rows to start with
998 * @throws UnsupportedEncodingException if an exception is thrown when
999 * creating the InputStreamReader
1001 public ECMA48Terminal(final Object listener
, final InputStream input
,
1002 final OutputStream output
, final int windowWidth
,
1003 final int windowHeight
) throws UnsupportedEncodingException
{
1005 this(listener
, input
, output
);
1007 // Send dtterm/xterm sequences, which will probably not work because
1008 // allowWindowOps is defaulted to false.
1009 String resizeString
= String
.format("\033[8;%d;%dt", windowHeight
,
1011 this.output
.write(resizeString
);
1012 this.output
.flush();
1016 * Constructor sets up state for getEvent().
1018 * @param listener the object this backend needs to wake up when new
1020 * @param input an InputStream connected to the remote user, or null for
1021 * System.in. If System.in is used, then on non-Windows systems it will
1022 * be put in raw mode; shutdown() will (blindly!) put System.in in cooked
1023 * mode. input is always converted to a Reader with UTF-8 encoding.
1024 * @param output an OutputStream connected to the remote user, or null
1025 * for System.out. output is always converted to a Writer with UTF-8
1027 * @throws UnsupportedEncodingException if an exception is thrown when
1028 * creating the InputStreamReader
1030 public ECMA48Terminal(final Object listener
, final InputStream input
,
1031 final OutputStream output
) throws UnsupportedEncodingException
{
1037 stopReaderThread
= false;
1038 this.listener
= listener
;
1040 if (input
== null) {
1041 // inputStream = System.in;
1042 inputStream
= new FileInputStream(FileDescriptor
.in
);
1046 inputStream
= input
;
1048 this.input
= new InputStreamReader(inputStream
, "UTF-8");
1050 if (input
instanceof SessionInfo
) {
1051 // This is a TelnetInputStream that exposes window size and
1052 // environment variables from the telnet layer.
1053 sessionInfo
= (SessionInfo
) input
;
1055 if (sessionInfo
== null) {
1056 if (input
== null) {
1057 // Reading right off the tty
1058 sessionInfo
= new TTYSessionInfo();
1060 sessionInfo
= new TSessionInfo();
1064 if (output
== null) {
1065 this.output
= new PrintWriter(new OutputStreamWriter(System
.out
,
1068 this.output
= new PrintWriter(new OutputStreamWriter(output
,
1072 // Request xterm report window dimensions in pixels
1073 this.output
.printf("%s", xtermReportWindowPixelDimensions());
1075 // Enable mouse reporting and metaSendsEscape
1076 this.output
.printf("%s%s", mouse(true), xtermMetaSendsEscape(true));
1077 this.output
.flush();
1079 // Query the screen size
1080 sessionInfo
.queryWindowSize();
1081 setDimensions(sessionInfo
.getWindowWidth(),
1082 sessionInfo
.getWindowHeight());
1084 // Hang onto the window size
1085 windowResize
= new TResizeEvent(TResizeEvent
.Type
.SCREEN
,
1086 sessionInfo
.getWindowWidth(), sessionInfo
.getWindowHeight());
1088 // Permit RGB colors only if externally requested.
1089 if (System
.getProperty("jexer.ECMA48.rgbColor") != null) {
1090 if (System
.getProperty("jexer.ECMA48.rgbColor").equals("true")) {
1097 // Pull the system properties for sixel output.
1098 if (System
.getProperty("jexer.ECMA48.sixel") != null) {
1099 if (System
.getProperty("jexer.ECMA48.sixel").equals("true")) {
1106 // Spin up the input reader
1107 eventQueue
= new LinkedList
<TInputEvent
>();
1108 readerThread
= new Thread(this);
1109 readerThread
.start();
1112 this.output
.write(clearAll());
1113 this.output
.flush();
1117 * Constructor sets up state for getEvent().
1119 * @param listener the object this backend needs to wake up when new
1121 * @param input the InputStream underlying 'reader'. Its available()
1122 * method is used to determine if reader.read() will block or not.
1123 * @param reader a Reader connected to the remote user.
1124 * @param writer a PrintWriter connected to the remote user.
1125 * @param setRawMode if true, set System.in into raw mode with stty.
1126 * This should in general not be used. It is here solely for Demo3,
1127 * which uses System.in.
1128 * @throws IllegalArgumentException if input, reader, or writer are null.
1130 public ECMA48Terminal(final Object listener
, final InputStream input
,
1131 final Reader reader
, final PrintWriter writer
,
1132 final boolean setRawMode
) {
1134 if (input
== null) {
1135 throw new IllegalArgumentException("InputStream must be specified");
1137 if (reader
== null) {
1138 throw new IllegalArgumentException("Reader must be specified");
1140 if (writer
== null) {
1141 throw new IllegalArgumentException("Writer must be specified");
1147 stopReaderThread
= false;
1148 this.listener
= listener
;
1150 inputStream
= input
;
1151 this.input
= reader
;
1153 if (setRawMode
== true) {
1156 this.setRawMode
= setRawMode
;
1158 if (input
instanceof SessionInfo
) {
1159 // This is a TelnetInputStream that exposes window size and
1160 // environment variables from the telnet layer.
1161 sessionInfo
= (SessionInfo
) input
;
1163 if (sessionInfo
== null) {
1164 if (setRawMode
== true) {
1165 // Reading right off the tty
1166 sessionInfo
= new TTYSessionInfo();
1168 sessionInfo
= new TSessionInfo();
1172 this.output
= writer
;
1174 // Request xterm report window dimensions in pixels
1175 this.output
.printf("%s", xtermReportWindowPixelDimensions());
1177 // Enable mouse reporting and metaSendsEscape
1178 this.output
.printf("%s%s", mouse(true), xtermMetaSendsEscape(true));
1179 this.output
.flush();
1181 // Query the screen size
1182 sessionInfo
.queryWindowSize();
1183 setDimensions(sessionInfo
.getWindowWidth(),
1184 sessionInfo
.getWindowHeight());
1186 // Hang onto the window size
1187 windowResize
= new TResizeEvent(TResizeEvent
.Type
.SCREEN
,
1188 sessionInfo
.getWindowWidth(), sessionInfo
.getWindowHeight());
1190 // Permit RGB colors only if externally requested
1191 if (System
.getProperty("jexer.ECMA48.rgbColor") != null) {
1192 if (System
.getProperty("jexer.ECMA48.rgbColor").equals("true")) {
1199 // Pull the system properties for sixel output.
1200 if (System
.getProperty("jexer.ECMA48.sixel") != null) {
1201 if (System
.getProperty("jexer.ECMA48.sixel").equals("true")) {
1208 // Spin up the input reader
1209 eventQueue
= new LinkedList
<TInputEvent
>();
1210 readerThread
= new Thread(this);
1211 readerThread
.start();
1214 this.output
.write(clearAll());
1215 this.output
.flush();
1219 * Constructor sets up state for getEvent().
1221 * @param listener the object this backend needs to wake up when new
1223 * @param input the InputStream underlying 'reader'. Its available()
1224 * method is used to determine if reader.read() will block or not.
1225 * @param reader a Reader connected to the remote user.
1226 * @param writer a PrintWriter connected to the remote user.
1227 * @throws IllegalArgumentException if input, reader, or writer are null.
1229 public ECMA48Terminal(final Object listener
, final InputStream input
,
1230 final Reader reader
, final PrintWriter writer
) {
1232 this(listener
, input
, reader
, writer
, false);
1235 // ------------------------------------------------------------------------
1236 // LogicalScreen ----------------------------------------------------------
1237 // ------------------------------------------------------------------------
1240 * Set the window title.
1242 * @param title the new title
1245 public void setTitle(final String title
) {
1246 output
.write(getSetTitleString(title
));
1251 * Push the logical screen to the physical device.
1254 public void flushPhysical() {
1255 StringBuilder sb
= new StringBuilder();
1259 && (cursorY
<= height
- 1)
1260 && (cursorX
<= width
- 1)
1263 sb
.append(cursor(true));
1264 sb
.append(gotoXY(cursorX
, cursorY
));
1266 sb
.append(cursor(false));
1269 output
.write(sb
.toString());
1273 // ------------------------------------------------------------------------
1274 // TerminalReader ---------------------------------------------------------
1275 // ------------------------------------------------------------------------
1278 * Check if there are events in the queue.
1280 * @return if true, getEvents() has something to return to the backend
1282 public boolean hasEvents() {
1283 synchronized (eventQueue
) {
1284 return (eventQueue
.size() > 0);
1289 * Return any events in the IO queue.
1291 * @param queue list to append new events to
1293 public void getEvents(final List
<TInputEvent
> queue
) {
1294 synchronized (eventQueue
) {
1295 if (eventQueue
.size() > 0) {
1296 synchronized (queue
) {
1297 queue
.addAll(eventQueue
);
1305 * Restore terminal to normal state.
1307 public void closeTerminal() {
1309 // System.err.println("=== shutdown() ==="); System.err.flush();
1311 // Tell the reader thread to stop looking at input
1312 stopReaderThread
= true;
1314 readerThread
.join();
1315 } catch (InterruptedException e
) {
1316 if (debugToStderr
) {
1317 e
.printStackTrace();
1321 // Disable mouse reporting and show cursor. Defensive null check
1322 // here in case closeTerminal() is called twice.
1323 if (output
!= null) {
1324 output
.printf("%s%s%s", mouse(false), cursor(true), normal());
1331 // We don't close System.in/out
1333 // Shut down the streams, this should wake up the reader thread
1334 // and make it exit.
1335 if (input
!= null) {
1338 } catch (IOException e
) {
1343 if (output
!= null) {
1351 * Set listener to a different Object.
1353 * @param listener the new listening object that run() wakes up on new
1356 public void setListener(final Object listener
) {
1357 this.listener
= listener
;
1360 // ------------------------------------------------------------------------
1361 // Runnable ---------------------------------------------------------------
1362 // ------------------------------------------------------------------------
1365 * Read function runs on a separate thread.
1368 boolean done
= false;
1369 // available() will often return > 1, so we need to read in chunks to
1371 char [] readBuffer
= new char[128];
1372 List
<TInputEvent
> events
= new LinkedList
<TInputEvent
>();
1374 while (!done
&& !stopReaderThread
) {
1376 // We assume that if inputStream has bytes available, then
1377 // input won't block on read().
1378 int n
= inputStream
.available();
1381 System.err.printf("inputStream.available(): %d\n", n);
1386 if (readBuffer
.length
< n
) {
1387 // The buffer wasn't big enough, make it huger
1388 readBuffer
= new char[readBuffer
.length
* 2];
1391 // System.err.printf("BEFORE read()\n"); System.err.flush();
1393 int rc
= input
.read(readBuffer
, 0, readBuffer
.length
);
1396 System.err.printf("AFTER read() %d\n", rc);
1404 for (int i
= 0; i
< rc
; i
++) {
1405 int ch
= readBuffer
[i
];
1406 processChar(events
, (char)ch
);
1408 getIdleEvents(events
);
1409 if (events
.size() > 0) {
1410 // Add to the queue for the backend thread to
1411 // be able to obtain.
1412 synchronized (eventQueue
) {
1413 eventQueue
.addAll(events
);
1415 if (listener
!= null) {
1416 synchronized (listener
) {
1417 listener
.notifyAll();
1424 getIdleEvents(events
);
1425 if (events
.size() > 0) {
1426 synchronized (eventQueue
) {
1427 eventQueue
.addAll(events
);
1429 if (listener
!= null) {
1430 synchronized (listener
) {
1431 listener
.notifyAll();
1437 // Wait 20 millis for more data
1440 // System.err.println("end while loop"); System.err.flush();
1441 } catch (InterruptedException e
) {
1443 } catch (IOException e
) {
1444 e
.printStackTrace();
1447 } // while ((done == false) && (stopReaderThread == false))
1448 // System.err.println("*** run() exiting..."); System.err.flush();
1451 // ------------------------------------------------------------------------
1452 // ECMA48Terminal ---------------------------------------------------------
1453 // ------------------------------------------------------------------------
1456 * Get the width of a character cell in pixels.
1458 * @return the width in pixels of a character cell
1460 public int getTextWidth() {
1461 return (widthPixels
/ sessionInfo
.getWindowWidth());
1465 * Get the height of a character cell in pixels.
1467 * @return the height in pixels of a character cell
1469 public int getTextHeight() {
1470 return (heightPixels
/ sessionInfo
.getWindowHeight());
1474 * Getter for sessionInfo.
1476 * @return the SessionInfo
1478 public SessionInfo
getSessionInfo() {
1483 * Get the output writer.
1485 * @return the Writer
1487 public PrintWriter
getOutput() {
1492 * Call 'stty' to set cooked mode.
1494 * <p>Actually executes '/bin/sh -c stty sane cooked < /dev/tty'
1496 private void sttyCooked() {
1501 * Call 'stty' to set raw mode.
1503 * <p>Actually executes '/bin/sh -c stty -ignbrk -brkint -parmrk -istrip
1504 * -inlcr -igncr -icrnl -ixon -opost -echo -echonl -icanon -isig -iexten
1505 * -parenb cs8 min 1 < /dev/tty'
1507 private void sttyRaw() {
1512 * Call 'stty' to set raw or cooked mode.
1514 * @param mode if true, set raw mode, otherwise set cooked mode
1516 private void doStty(final boolean mode
) {
1517 String
[] cmdRaw
= {
1518 "/bin/sh", "-c", "stty -ignbrk -brkint -parmrk -istrip -inlcr -igncr -icrnl -ixon -opost -echo -echonl -icanon -isig -iexten -parenb cs8 min 1 < /dev/tty"
1520 String
[] cmdCooked
= {
1521 "/bin/sh", "-c", "stty sane cooked < /dev/tty"
1526 process
= Runtime
.getRuntime().exec(cmdRaw
);
1528 process
= Runtime
.getRuntime().exec(cmdCooked
);
1530 BufferedReader in
= new BufferedReader(new InputStreamReader(process
.getInputStream(), "UTF-8"));
1531 String line
= in
.readLine();
1532 if ((line
!= null) && (line
.length() > 0)) {
1533 System
.err
.println("WEIRD?! Normal output from stty: " + line
);
1536 BufferedReader err
= new BufferedReader(new InputStreamReader(process
.getErrorStream(), "UTF-8"));
1537 line
= err
.readLine();
1538 if ((line
!= null) && (line
.length() > 0)) {
1539 System
.err
.println("Error output from stty: " + line
);
1544 } catch (InterruptedException e
) {
1545 if (debugToStderr
) {
1546 e
.printStackTrace();
1550 int rc
= process
.exitValue();
1552 System
.err
.println("stty returned error code: " + rc
);
1554 } catch (IOException e
) {
1555 e
.printStackTrace();
1562 public void flush() {
1567 * Perform a somewhat-optimal rendering of a line.
1569 * @param y row coordinate. 0 is the top-most row.
1570 * @param sb StringBuilder to write escape sequences to
1571 * @param lastAttr cell attributes from the last call to flushLine
1573 private void flushLine(final int y
, final StringBuilder sb
,
1574 CellAttributes lastAttr
) {
1578 for (int x
= 0; x
< width
; x
++) {
1579 Cell lCell
= logical
[x
][y
];
1580 if (!lCell
.isBlank()) {
1584 // Push textEnd to first column beyond the text area
1588 // reallyCleared = true;
1590 boolean hasImage
= false;
1592 for (int x
= 0; x
< width
; x
++) {
1593 Cell lCell
= logical
[x
][y
];
1594 Cell pCell
= physical
[x
][y
];
1596 if (!lCell
.equals(pCell
) || reallyCleared
) {
1598 if (debugToStderr
) {
1599 System
.err
.printf("\n--\n");
1600 System
.err
.printf(" Y: %d X: %d\n", y
, x
);
1601 System
.err
.printf(" lCell: %s\n", lCell
);
1602 System
.err
.printf(" pCell: %s\n", pCell
);
1603 System
.err
.printf(" ==== \n");
1606 if (lastAttr
== null) {
1607 lastAttr
= new CellAttributes();
1608 sb
.append(normal());
1612 if ((lastX
!= (x
- 1)) || (lastX
== -1)) {
1613 // Advancing at least one cell, or the first gotoXY
1614 sb
.append(gotoXY(x
, y
));
1617 assert (lastAttr
!= null);
1619 if ((x
== textEnd
) && (textEnd
< width
- 1)) {
1620 assert (lCell
.isBlank());
1622 for (int i
= x
; i
< width
; i
++) {
1623 assert (logical
[i
][y
].isBlank());
1624 // Physical is always updated
1625 physical
[i
][y
].reset();
1628 // Clear remaining line
1629 sb
.append(clearRemainingLine());
1634 // Image cell: bypass the rest of the loop, it is not
1636 if (lCell
.isImage()) {
1639 // Save the last rendered cell
1642 // Physical is always updated
1643 physical
[x
][y
].setTo(lCell
);
1647 assert (!lCell
.isImage());
1650 sb
.append(gotoXY(x
, y
));
1653 // Now emit only the modified attributes
1654 if ((lCell
.getForeColor() != lastAttr
.getForeColor())
1655 && (lCell
.getBackColor() != lastAttr
.getBackColor())
1657 && (lCell
.isBold() == lastAttr
.isBold())
1658 && (lCell
.isReverse() == lastAttr
.isReverse())
1659 && (lCell
.isUnderline() == lastAttr
.isUnderline())
1660 && (lCell
.isBlink() == lastAttr
.isBlink())
1662 // Both colors changed, attributes the same
1663 sb
.append(color(lCell
.isBold(),
1664 lCell
.getForeColor(), lCell
.getBackColor()));
1666 if (debugToStderr
) {
1667 System
.err
.printf("1 Change only fore/back colors\n");
1670 } else if (lCell
.isRGB()
1671 && (lCell
.getForeColorRGB() != lastAttr
.getForeColorRGB())
1672 && (lCell
.getBackColorRGB() != lastAttr
.getBackColorRGB())
1673 && (lCell
.isBold() == lastAttr
.isBold())
1674 && (lCell
.isReverse() == lastAttr
.isReverse())
1675 && (lCell
.isUnderline() == lastAttr
.isUnderline())
1676 && (lCell
.isBlink() == lastAttr
.isBlink())
1678 // Both colors changed, attributes the same
1679 sb
.append(colorRGB(lCell
.getForeColorRGB(),
1680 lCell
.getBackColorRGB()));
1682 if (debugToStderr
) {
1683 System
.err
.printf("1 Change only fore/back colors (RGB)\n");
1685 } else if ((lCell
.getForeColor() != lastAttr
.getForeColor())
1686 && (lCell
.getBackColor() != lastAttr
.getBackColor())
1688 && (lCell
.isBold() != lastAttr
.isBold())
1689 && (lCell
.isReverse() != lastAttr
.isReverse())
1690 && (lCell
.isUnderline() != lastAttr
.isUnderline())
1691 && (lCell
.isBlink() != lastAttr
.isBlink())
1693 // Everything is different
1694 sb
.append(color(lCell
.getForeColor(),
1695 lCell
.getBackColor(),
1696 lCell
.isBold(), lCell
.isReverse(),
1698 lCell
.isUnderline()));
1700 if (debugToStderr
) {
1701 System
.err
.printf("2 Set all attributes\n");
1703 } else if ((lCell
.getForeColor() != lastAttr
.getForeColor())
1704 && (lCell
.getBackColor() == lastAttr
.getBackColor())
1706 && (lCell
.isBold() == lastAttr
.isBold())
1707 && (lCell
.isReverse() == lastAttr
.isReverse())
1708 && (lCell
.isUnderline() == lastAttr
.isUnderline())
1709 && (lCell
.isBlink() == lastAttr
.isBlink())
1712 // Attributes same, foreColor different
1713 sb
.append(color(lCell
.isBold(),
1714 lCell
.getForeColor(), true));
1716 if (debugToStderr
) {
1717 System
.err
.printf("3 Change foreColor\n");
1719 } else if (lCell
.isRGB()
1720 && (lCell
.getForeColorRGB() != lastAttr
.getForeColorRGB())
1721 && (lCell
.getBackColorRGB() == lastAttr
.getBackColorRGB())
1722 && (lCell
.getForeColorRGB() >= 0)
1723 && (lCell
.getBackColorRGB() >= 0)
1724 && (lCell
.isBold() == lastAttr
.isBold())
1725 && (lCell
.isReverse() == lastAttr
.isReverse())
1726 && (lCell
.isUnderline() == lastAttr
.isUnderline())
1727 && (lCell
.isBlink() == lastAttr
.isBlink())
1729 // Attributes same, foreColor different
1730 sb
.append(colorRGB(lCell
.getForeColorRGB(), true));
1732 if (debugToStderr
) {
1733 System
.err
.printf("3 Change foreColor (RGB)\n");
1735 } else if ((lCell
.getForeColor() == lastAttr
.getForeColor())
1736 && (lCell
.getBackColor() != lastAttr
.getBackColor())
1738 && (lCell
.isBold() == lastAttr
.isBold())
1739 && (lCell
.isReverse() == lastAttr
.isReverse())
1740 && (lCell
.isUnderline() == lastAttr
.isUnderline())
1741 && (lCell
.isBlink() == lastAttr
.isBlink())
1743 // Attributes same, backColor different
1744 sb
.append(color(lCell
.isBold(),
1745 lCell
.getBackColor(), false));
1747 if (debugToStderr
) {
1748 System
.err
.printf("4 Change backColor\n");
1750 } else if (lCell
.isRGB()
1751 && (lCell
.getForeColorRGB() == lastAttr
.getForeColorRGB())
1752 && (lCell
.getBackColorRGB() != lastAttr
.getBackColorRGB())
1753 && (lCell
.isBold() == lastAttr
.isBold())
1754 && (lCell
.isReverse() == lastAttr
.isReverse())
1755 && (lCell
.isUnderline() == lastAttr
.isUnderline())
1756 && (lCell
.isBlink() == lastAttr
.isBlink())
1758 // Attributes same, foreColor different
1759 sb
.append(colorRGB(lCell
.getBackColorRGB(), false));
1761 if (debugToStderr
) {
1762 System
.err
.printf("4 Change backColor (RGB)\n");
1764 } else if ((lCell
.getForeColor() == lastAttr
.getForeColor())
1765 && (lCell
.getBackColor() == lastAttr
.getBackColor())
1766 && (lCell
.getForeColorRGB() == lastAttr
.getForeColorRGB())
1767 && (lCell
.getBackColorRGB() == lastAttr
.getBackColorRGB())
1768 && (lCell
.isBold() == lastAttr
.isBold())
1769 && (lCell
.isReverse() == lastAttr
.isReverse())
1770 && (lCell
.isUnderline() == lastAttr
.isUnderline())
1771 && (lCell
.isBlink() == lastAttr
.isBlink())
1774 // All attributes the same, just print the char
1777 if (debugToStderr
) {
1778 System
.err
.printf("5 Only emit character\n");
1781 // Just reset everything again
1782 if (!lCell
.isRGB()) {
1783 sb
.append(color(lCell
.getForeColor(),
1784 lCell
.getBackColor(),
1788 lCell
.isUnderline()));
1790 if (debugToStderr
) {
1791 System
.err
.printf("6 Change all attributes\n");
1794 sb
.append(colorRGB(lCell
.getForeColorRGB(),
1795 lCell
.getBackColorRGB(),
1799 lCell
.isUnderline()));
1800 if (debugToStderr
) {
1801 System
.err
.printf("6 Change all attributes (RGB)\n");
1806 // Emit the character
1807 sb
.append(lCell
.getChar());
1809 // Save the last rendered cell
1811 lastAttr
.setTo(lCell
);
1813 // Physical is always updated
1814 physical
[x
][y
].setTo(lCell
);
1816 } // if (!lCell.equals(pCell) || (reallyCleared == true))
1818 } // for (int x = 0; x < width; x++)
1822 * Render the screen to a string that can be emitted to something that
1823 * knows how to process ECMA-48/ANSI X3.64 escape sequences.
1825 * @param sb StringBuilder to write escape sequences to
1826 * @return escape sequences string that provides the updates to the
1829 private String
flushString(final StringBuilder sb
) {
1830 CellAttributes attr
= null;
1832 if (reallyCleared
) {
1833 attr
= new CellAttributes();
1834 sb
.append(clearAll());
1838 * For sixel support, draw all of the sixel output first, and then
1839 * draw everything else afterwards. This works OK, but performance
1840 * is still a drag on larger pictures.
1842 for (int y
= 0; y
< height
; y
++) {
1843 for (int x
= 0; x
< width
; x
++) {
1844 // If physical had non-image data that is now image data, the
1845 // entire row must be redrawn.
1846 Cell lCell
= logical
[x
][y
];
1847 Cell pCell
= physical
[x
][y
];
1848 if (lCell
.isImage() && !pCell
.isImage()) {
1854 for (int y
= 0; y
< height
; y
++) {
1855 for (int x
= 0; x
< width
; x
++) {
1856 Cell lCell
= logical
[x
][y
];
1857 Cell pCell
= physical
[x
][y
];
1859 if (!lCell
.isImage()) {
1865 while ((right
< width
)
1866 && (logical
[right
][y
].isImage())
1867 && (!logical
[right
][y
].equals(physical
[right
][y
])
1872 ArrayList
<Cell
> cellsToDraw
= new ArrayList
<Cell
>();
1873 for (int i
= 0; i
< (right
- x
); i
++) {
1874 assert (logical
[x
+ i
][y
].isImage());
1875 cellsToDraw
.add(logical
[x
+ i
][y
]);
1877 // Physical is always updated.
1878 physical
[x
+ i
][y
].setTo(lCell
);
1880 if (cellsToDraw
.size() > 0) {
1881 sb
.append(toSixel(x
, y
, cellsToDraw
));
1888 // Draw the text part now.
1889 for (int y
= 0; y
< height
; y
++) {
1890 flushLine(y
, sb
, attr
);
1893 reallyCleared
= false;
1895 String result
= sb
.toString();
1896 if (debugToStderr
) {
1897 System
.err
.printf("flushString(): %s\n", result
);
1903 * Reset keyboard/mouse input parser.
1905 private void resetParser() {
1906 state
= ParseState
.GROUND
;
1907 params
= new ArrayList
<String
>();
1913 * Produce a control character or one of the special ones (ENTER, TAB,
1916 * @param ch Unicode code point
1917 * @param alt if true, set alt on the TKeypress
1918 * @return one TKeypress event, either a control character (e.g. isKey ==
1919 * false, ch == 'A', ctrl == true), or a special key (e.g. isKey == true,
1922 private TKeypressEvent
controlChar(final char ch
, final boolean alt
) {
1923 // System.err.printf("controlChar: %02x\n", ch);
1927 // Carriage return --> ENTER
1928 return new TKeypressEvent(kbEnter
, alt
, false, false);
1930 // Linefeed --> ENTER
1931 return new TKeypressEvent(kbEnter
, alt
, false, false);
1934 return new TKeypressEvent(kbEsc
, alt
, false, false);
1937 return new TKeypressEvent(kbTab
, alt
, false, false);
1939 // Make all other control characters come back as the alphabetic
1940 // character with the ctrl field set. So SOH would be 'A' +
1942 return new TKeypressEvent(false, 0, (char)(ch
+ 0x40),
1948 * Produce special key from CSI Pn ; Pm ; ... ~
1950 * @return one KEYPRESS event representing a special key
1952 private TInputEvent
csiFnKey() {
1954 if (params
.size() > 0) {
1955 key
= Integer
.parseInt(params
.get(0));
1957 boolean alt
= false;
1958 boolean ctrl
= false;
1959 boolean shift
= false;
1960 if (params
.size() > 1) {
1961 shift
= csiIsShift(params
.get(1));
1962 alt
= csiIsAlt(params
.get(1));
1963 ctrl
= csiIsCtrl(params
.get(1));
1968 return new TKeypressEvent(kbHome
, alt
, ctrl
, shift
);
1970 return new TKeypressEvent(kbIns
, alt
, ctrl
, shift
);
1972 return new TKeypressEvent(kbDel
, alt
, ctrl
, shift
);
1974 return new TKeypressEvent(kbEnd
, alt
, ctrl
, shift
);
1976 return new TKeypressEvent(kbPgUp
, alt
, ctrl
, shift
);
1978 return new TKeypressEvent(kbPgDn
, alt
, ctrl
, shift
);
1980 return new TKeypressEvent(kbF5
, alt
, ctrl
, shift
);
1982 return new TKeypressEvent(kbF6
, alt
, ctrl
, shift
);
1984 return new TKeypressEvent(kbF7
, alt
, ctrl
, shift
);
1986 return new TKeypressEvent(kbF8
, alt
, ctrl
, shift
);
1988 return new TKeypressEvent(kbF9
, alt
, ctrl
, shift
);
1990 return new TKeypressEvent(kbF10
, alt
, ctrl
, shift
);
1992 return new TKeypressEvent(kbF11
, alt
, ctrl
, shift
);
1994 return new TKeypressEvent(kbF12
, alt
, ctrl
, shift
);
2002 * Produce mouse events based on "Any event tracking" and UTF-8
2004 * http://invisible-island.net/xterm/ctlseqs/ctlseqs.html#Mouse%20Tracking
2006 * @return a MOUSE_MOTION, MOUSE_UP, or MOUSE_DOWN event
2008 private TInputEvent
parseMouse() {
2009 int buttons
= params
.get(0).charAt(0) - 32;
2010 int x
= params
.get(0).charAt(1) - 32 - 1;
2011 int y
= params
.get(0).charAt(2) - 32 - 1;
2013 // Clamp X and Y to the physical screen coordinates.
2014 if (x
>= windowResize
.getWidth()) {
2015 x
= windowResize
.getWidth() - 1;
2017 if (y
>= windowResize
.getHeight()) {
2018 y
= windowResize
.getHeight() - 1;
2021 TMouseEvent
.Type eventType
= TMouseEvent
.Type
.MOUSE_DOWN
;
2022 boolean eventMouse1
= false;
2023 boolean eventMouse2
= false;
2024 boolean eventMouse3
= false;
2025 boolean eventMouseWheelUp
= false;
2026 boolean eventMouseWheelDown
= false;
2028 // System.err.printf("buttons: %04x\r\n", buttons);
2045 if (!mouse1
&& !mouse2
&& !mouse3
) {
2046 eventType
= TMouseEvent
.Type
.MOUSE_MOTION
;
2048 eventType
= TMouseEvent
.Type
.MOUSE_UP
;
2065 // Dragging with mouse1 down
2068 eventType
= TMouseEvent
.Type
.MOUSE_MOTION
;
2072 // Dragging with mouse2 down
2075 eventType
= TMouseEvent
.Type
.MOUSE_MOTION
;
2079 // Dragging with mouse3 down
2082 eventType
= TMouseEvent
.Type
.MOUSE_MOTION
;
2086 // Dragging with mouse2 down after wheelUp
2089 eventType
= TMouseEvent
.Type
.MOUSE_MOTION
;
2093 // Dragging with mouse2 down after wheelDown
2096 eventType
= TMouseEvent
.Type
.MOUSE_MOTION
;
2100 eventMouseWheelUp
= true;
2104 eventMouseWheelDown
= true;
2108 // Unknown, just make it motion
2109 eventType
= TMouseEvent
.Type
.MOUSE_MOTION
;
2112 return new TMouseEvent(eventType
, x
, y
, x
, y
,
2113 eventMouse1
, eventMouse2
, eventMouse3
,
2114 eventMouseWheelUp
, eventMouseWheelDown
);
2118 * Produce mouse events based on "Any event tracking" and SGR
2120 * http://invisible-island.net/xterm/ctlseqs/ctlseqs.html#Mouse%20Tracking
2122 * @param release if true, this was a release ('m')
2123 * @return a MOUSE_MOTION, MOUSE_UP, or MOUSE_DOWN event
2125 private TInputEvent
parseMouseSGR(final boolean release
) {
2126 // SGR extended coordinates - mode 1006
2127 if (params
.size() < 3) {
2128 // Invalid position, bail out.
2131 int buttons
= Integer
.parseInt(params
.get(0));
2132 int x
= Integer
.parseInt(params
.get(1)) - 1;
2133 int y
= Integer
.parseInt(params
.get(2)) - 1;
2135 // Clamp X and Y to the physical screen coordinates.
2136 if (x
>= windowResize
.getWidth()) {
2137 x
= windowResize
.getWidth() - 1;
2139 if (y
>= windowResize
.getHeight()) {
2140 y
= windowResize
.getHeight() - 1;
2143 TMouseEvent
.Type eventType
= TMouseEvent
.Type
.MOUSE_DOWN
;
2144 boolean eventMouse1
= false;
2145 boolean eventMouse2
= false;
2146 boolean eventMouse3
= false;
2147 boolean eventMouseWheelUp
= false;
2148 boolean eventMouseWheelDown
= false;
2151 eventType
= TMouseEvent
.Type
.MOUSE_UP
;
2165 // Motion only, no buttons down
2166 eventType
= TMouseEvent
.Type
.MOUSE_MOTION
;
2170 // Dragging with mouse1 down
2172 eventType
= TMouseEvent
.Type
.MOUSE_MOTION
;
2176 // Dragging with mouse2 down
2178 eventType
= TMouseEvent
.Type
.MOUSE_MOTION
;
2182 // Dragging with mouse3 down
2184 eventType
= TMouseEvent
.Type
.MOUSE_MOTION
;
2188 // Dragging with mouse2 down after wheelUp
2190 eventType
= TMouseEvent
.Type
.MOUSE_MOTION
;
2194 // Dragging with mouse2 down after wheelDown
2196 eventType
= TMouseEvent
.Type
.MOUSE_MOTION
;
2200 eventMouseWheelUp
= true;
2204 eventMouseWheelDown
= true;
2208 // Unknown, bail out
2211 return new TMouseEvent(eventType
, x
, y
, x
, y
,
2212 eventMouse1
, eventMouse2
, eventMouse3
,
2213 eventMouseWheelUp
, eventMouseWheelDown
);
2217 * Return any events in the IO queue due to timeout.
2219 * @param queue list to append new events to
2221 private void getIdleEvents(final List
<TInputEvent
> queue
) {
2222 long nowTime
= System
.currentTimeMillis();
2224 // Check for new window size
2225 long windowSizeDelay
= nowTime
- windowSizeTime
;
2226 if (windowSizeDelay
> 1000) {
2227 sessionInfo
.queryWindowSize();
2228 int newWidth
= sessionInfo
.getWindowWidth();
2229 int newHeight
= sessionInfo
.getWindowHeight();
2231 if ((newWidth
!= windowResize
.getWidth())
2232 || (newHeight
!= windowResize
.getHeight())
2235 if (debugToStderr
) {
2236 System
.err
.println("Screen size changed, old size " +
2238 System
.err
.println(" new size " +
2239 newWidth
+ " x " + newHeight
);
2242 // Request xterm report window dimensions in pixels again.
2243 this.output
.printf("%s", xtermReportWindowPixelDimensions());
2244 this.output
.flush();
2246 TResizeEvent event
= new TResizeEvent(TResizeEvent
.Type
.SCREEN
,
2247 newWidth
, newHeight
);
2248 windowResize
= new TResizeEvent(TResizeEvent
.Type
.SCREEN
,
2249 newWidth
, newHeight
);
2252 windowSizeTime
= nowTime
;
2255 // ESCDELAY type timeout
2256 if (state
== ParseState
.ESCAPE
) {
2257 long escDelay
= nowTime
- escapeTime
;
2258 if (escDelay
> 100) {
2259 // After 0.1 seconds, assume a true escape character
2260 queue
.add(controlChar((char)0x1B, false));
2267 * Returns true if the CSI parameter for a keyboard command means that
2270 private boolean csiIsShift(final String x
) {
2282 * Returns true if the CSI parameter for a keyboard command means that
2285 private boolean csiIsAlt(final String x
) {
2297 * Returns true if the CSI parameter for a keyboard command means that
2300 private boolean csiIsCtrl(final String x
) {
2312 * Parses the next character of input to see if an InputEvent is
2315 * @param events list to append new events to
2316 * @param ch Unicode code point
2318 private void processChar(final List
<TInputEvent
> events
, final char ch
) {
2320 // ESCDELAY type timeout
2321 long nowTime
= System
.currentTimeMillis();
2322 if (state
== ParseState
.ESCAPE
) {
2323 long escDelay
= nowTime
- escapeTime
;
2324 if (escDelay
> 250) {
2325 // After 0.25 seconds, assume a true escape character
2326 events
.add(controlChar((char)0x1B, false));
2332 boolean ctrl
= false;
2333 boolean alt
= false;
2334 boolean shift
= false;
2336 // System.err.printf("state: %s ch %c\r\n", state, ch);
2342 state
= ParseState
.ESCAPE
;
2343 escapeTime
= nowTime
;
2348 // Control character
2349 events
.add(controlChar(ch
, false));
2356 events
.add(new TKeypressEvent(false, 0, ch
,
2357 false, false, false));
2366 // ALT-Control character
2367 events
.add(controlChar(ch
, true));
2373 // This will be one of the function keys
2374 state
= ParseState
.ESCAPE_INTERMEDIATE
;
2378 // '[' goes to CSI_ENTRY
2380 state
= ParseState
.CSI_ENTRY
;
2384 // Everything else is assumed to be Alt-keystroke
2385 if ((ch
>= 'A') && (ch
<= 'Z')) {
2389 events
.add(new TKeypressEvent(false, 0, ch
, alt
, ctrl
, shift
));
2393 case ESCAPE_INTERMEDIATE
:
2394 if ((ch
>= 'P') && (ch
<= 'S')) {
2398 events
.add(new TKeypressEvent(kbF1
));
2401 events
.add(new TKeypressEvent(kbF2
));
2404 events
.add(new TKeypressEvent(kbF3
));
2407 events
.add(new TKeypressEvent(kbF4
));
2416 // Unknown keystroke, ignore
2421 // Numbers - parameter values
2422 if ((ch
>= '0') && (ch
<= '9')) {
2423 params
.set(params
.size() - 1,
2424 params
.get(params
.size() - 1) + ch
);
2425 state
= ParseState
.CSI_PARAM
;
2428 // Parameter separator
2434 if ((ch
>= 0x30) && (ch
<= 0x7E)) {
2438 events
.add(new TKeypressEvent(kbUp
, alt
, ctrl
, shift
));
2443 events
.add(new TKeypressEvent(kbDown
, alt
, ctrl
, shift
));
2448 events
.add(new TKeypressEvent(kbRight
, alt
, ctrl
, shift
));
2453 events
.add(new TKeypressEvent(kbLeft
, alt
, ctrl
, shift
));
2458 events
.add(new TKeypressEvent(kbHome
));
2463 events
.add(new TKeypressEvent(kbEnd
));
2467 // CBT - Cursor backward X tab stops (default 1)
2468 events
.add(new TKeypressEvent(kbBackTab
));
2473 state
= ParseState
.MOUSE
;
2476 // Mouse position, SGR (1006) coordinates
2477 state
= ParseState
.MOUSE_SGR
;
2484 // Unknown keystroke, ignore
2489 // Numbers - parameter values
2490 if ((ch
>= '0') && (ch
<= '9')) {
2491 params
.set(params
.size() - 1,
2492 params
.get(params
.size() - 1) + ch
);
2495 // Parameter separator
2503 // Generate a mouse press event
2504 TInputEvent event
= parseMouseSGR(false);
2505 if (event
!= null) {
2511 // Generate a mouse release event
2512 event
= parseMouseSGR(true);
2513 if (event
!= null) {
2522 // Unknown keystroke, ignore
2527 // Numbers - parameter values
2528 if ((ch
>= '0') && (ch
<= '9')) {
2529 params
.set(params
.size() - 1,
2530 params
.get(params
.size() - 1) + ch
);
2531 state
= ParseState
.CSI_PARAM
;
2534 // Parameter separator
2541 events
.add(csiFnKey());
2546 if ((ch
>= 0x30) && (ch
<= 0x7E)) {
2550 if (params
.size() > 1) {
2551 shift
= csiIsShift(params
.get(1));
2552 alt
= csiIsAlt(params
.get(1));
2553 ctrl
= csiIsCtrl(params
.get(1));
2555 events
.add(new TKeypressEvent(kbUp
, alt
, ctrl
, shift
));
2560 if (params
.size() > 1) {
2561 shift
= csiIsShift(params
.get(1));
2562 alt
= csiIsAlt(params
.get(1));
2563 ctrl
= csiIsCtrl(params
.get(1));
2565 events
.add(new TKeypressEvent(kbDown
, alt
, ctrl
, shift
));
2570 if (params
.size() > 1) {
2571 shift
= csiIsShift(params
.get(1));
2572 alt
= csiIsAlt(params
.get(1));
2573 ctrl
= csiIsCtrl(params
.get(1));
2575 events
.add(new TKeypressEvent(kbRight
, alt
, ctrl
, shift
));
2580 if (params
.size() > 1) {
2581 shift
= csiIsShift(params
.get(1));
2582 alt
= csiIsAlt(params
.get(1));
2583 ctrl
= csiIsCtrl(params
.get(1));
2585 events
.add(new TKeypressEvent(kbLeft
, alt
, ctrl
, shift
));
2590 if (params
.size() > 1) {
2591 shift
= csiIsShift(params
.get(1));
2592 alt
= csiIsAlt(params
.get(1));
2593 ctrl
= csiIsCtrl(params
.get(1));
2595 events
.add(new TKeypressEvent(kbHome
, alt
, ctrl
, shift
));
2600 if (params
.size() > 1) {
2601 shift
= csiIsShift(params
.get(1));
2602 alt
= csiIsAlt(params
.get(1));
2603 ctrl
= csiIsCtrl(params
.get(1));
2605 events
.add(new TKeypressEvent(kbEnd
, alt
, ctrl
, shift
));
2610 if ((params
.size() > 2) && (params
.get(0).equals("4"))) {
2611 if (debugToStderr
) {
2612 System
.err
.printf("windowOp pixels: " +
2613 "height %s width %s\n",
2614 params
.get(1), params
.get(2));
2617 widthPixels
= Integer
.parseInt(params
.get(2));
2618 heightPixels
= Integer
.parseInt(params
.get(1));
2619 } catch (NumberFormatException e
) {
2620 if (debugToStderr
) {
2621 e
.printStackTrace();
2624 if (widthPixels
<= 0) {
2627 if (heightPixels
<= 0) {
2638 // Unknown keystroke, ignore
2643 params
.set(0, params
.get(params
.size() - 1) + ch
);
2644 if (params
.get(0).length() == 3) {
2645 // We have enough to generate a mouse event
2646 events
.add(parseMouse());
2655 // This "should" be impossible to reach
2660 * Request (u)xterm to report the current window size dimensions.
2662 * @return the string to emit to xterm
2664 private String
xtermReportWindowPixelDimensions() {
2669 * Tell (u)xterm that we want alt- keystrokes to send escape + character
2670 * rather than set the 8th bit. Anyone who wants UTF8 should want this
2673 * @param on if true, enable metaSendsEscape
2674 * @return the string to emit to xterm
2676 private String
xtermMetaSendsEscape(final boolean on
) {
2678 return "\033[?1036h\033[?1034l";
2680 return "\033[?1036l";
2684 * Create an xterm OSC sequence to change the window title.
2686 * @param title the new title
2687 * @return the string to emit to xterm
2689 private String
getSetTitleString(final String title
) {
2690 return "\033]2;" + title
+ "\007";
2693 // ------------------------------------------------------------------------
2694 // Sixel output support ---------------------------------------------------
2695 // ------------------------------------------------------------------------
2698 * Start a sixel string for display one row's worth of bitmap data.
2700 * @param x column coordinate. 0 is the left-most column.
2701 * @param y row coordinate. 0 is the top-most row.
2702 * @return the string to emit to an ANSI / ECMA-style terminal
2704 private String
startSixel(final int x
, final int y
) {
2705 StringBuilder sb
= new StringBuilder();
2707 assert (sixel
== true);
2710 sb
.append(gotoXY(x
, y
));
2713 sb
.append("\033Pq");
2715 if (palette
== null) {
2716 palette
= new SixelPalette();
2719 return sb
.toString();
2723 * End a sixel string for display one row's worth of bitmap data.
2725 * @return the string to emit to an ANSI / ECMA-style terminal
2727 private String
endSixel() {
2728 assert (sixel
== true);
2735 * Create a sixel string representing a row of several cells containing
2738 * @param x column coordinate. 0 is the left-most column.
2739 * @param y row coordinate. 0 is the top-most row.
2740 * @param cells the cells containing the bitmap data
2741 * @return the string to emit to an ANSI / ECMA-style terminal
2743 private String
toSixel(final int x
, final int y
,
2744 final ArrayList
<Cell
> cells
) {
2746 StringBuilder sb
= new StringBuilder();
2748 assert (sixel
== true);
2749 assert (cells
!= null);
2750 assert (cells
.size() > 0);
2751 assert (cells
.get(0).getImage() != null);
2753 if (sixelCache
== null) {
2754 sixelCache
= new SixelCache(height
* 10);
2757 // Save and get rows to/from the cache that do NOT have inverted
2759 boolean saveInCache
= true;
2760 for (Cell cell
: cells
) {
2761 if (cell
.isInvertedImage()) {
2762 saveInCache
= false;
2766 String cachedResult
= sixelCache
.get(cells
);
2767 if (cachedResult
!= null) {
2768 // System.err.println("CACHE HIT");
2769 sb
.append(startSixel(x
, y
));
2770 sb
.append(cachedResult
);
2771 sb
.append(endSixel());
2772 return sb
.toString();
2774 // System.err.println("CACHE MISS");
2777 int imageWidth
= cells
.get(0).getImage().getWidth();
2778 int imageHeight
= cells
.get(0).getImage().getHeight();
2780 // cells.get(x).getImage() has a dithered bitmap containing indexes
2781 // into the color palette. Piece these together into one larger
2782 // image for final rendering.
2784 int fullWidth
= cells
.size() * getTextWidth();
2785 int fullHeight
= getTextHeight();
2786 for (int i
= 0; i
< cells
.size(); i
++) {
2787 totalWidth
+= cells
.get(i
).getImage().getWidth();
2790 BufferedImage image
= new BufferedImage(fullWidth
,
2791 fullHeight
, BufferedImage
.TYPE_INT_ARGB
);
2794 for (int i
= 0; i
< cells
.size() - 1; i
++) {
2795 if (cells
.get(i
).isInvertedImage()) {
2796 rgbArray
= new int[imageWidth
* imageHeight
];
2797 for (int j
= 0; j
< rgbArray
.length
; j
++) {
2798 rgbArray
[j
] = 0xFFFFFF;
2801 rgbArray
= cells
.get(i
).getImage().getRGB(0, 0,
2802 imageWidth
, imageHeight
, null, 0, imageWidth
);
2804 image
.setRGB(i
* imageWidth
, 0, imageWidth
, imageHeight
,
2805 rgbArray
, 0, imageWidth
);
2806 if (imageHeight
< fullHeight
) {
2807 int backgroundColor
= cells
.get(i
).getBackground().getRGB();
2808 for (int imageX
= 0; imageX
< image
.getWidth(); imageX
++) {
2809 for (int imageY
= imageHeight
; imageY
< fullHeight
;
2812 image
.setRGB(imageX
, imageY
, backgroundColor
);
2817 totalWidth
-= ((cells
.size() - 1) * imageWidth
);
2818 if (cells
.get(cells
.size() - 1).isInvertedImage()) {
2819 rgbArray
= new int[totalWidth
* imageHeight
];
2820 for (int j
= 0; j
< rgbArray
.length
; j
++) {
2821 rgbArray
[j
] = 0xFFFFFF;
2824 rgbArray
= cells
.get(cells
.size() - 1).getImage().getRGB(0, 0,
2825 totalWidth
, imageHeight
, null, 0, totalWidth
);
2827 image
.setRGB((cells
.size() - 1) * imageWidth
, 0, totalWidth
,
2828 imageHeight
, rgbArray
, 0, totalWidth
);
2830 if (totalWidth
< getTextWidth()) {
2831 int backgroundColor
= cells
.get(cells
.size() - 1).getBackground().getRGB();
2833 for (int imageX
= image
.getWidth() - totalWidth
;
2834 imageX
< image
.getWidth(); imageX
++) {
2836 for (int imageY
= 0; imageY
< fullHeight
; imageY
++) {
2837 image
.setRGB(imageX
, imageY
, backgroundColor
);
2842 // Dither the image. It is ok to lose the original here.
2843 if (palette
== null) {
2844 palette
= new SixelPalette();
2846 image
= palette
.ditherImage(image
);
2848 // Emit the palette, but only for the colors actually used by these
2850 boolean [] usedColors
= new boolean[MAX_COLOR_REGISTERS
];
2851 for (int imageX
= 0; imageX
< image
.getWidth(); imageX
++) {
2852 for (int imageY
= 0; imageY
< image
.getHeight(); imageY
++) {
2853 usedColors
[image
.getRGB(imageX
, imageY
)] = true;
2856 palette
.emitPalette(sb
, usedColors
);
2858 // Render the entire row of cells.
2859 for (int currentRow
= 0; currentRow
< fullHeight
; currentRow
+= 6) {
2860 int [][] sixels
= new int[image
.getWidth()][6];
2862 // See which colors are actually used in this band of sixels.
2863 for (int imageX
= 0; imageX
< image
.getWidth(); imageX
++) {
2864 for (int imageY
= 0;
2865 (imageY
< 6) && (imageY
+ currentRow
< fullHeight
);
2868 int colorIdx
= image
.getRGB(imageX
, imageY
+ currentRow
);
2869 assert (colorIdx
>= 0);
2870 assert (colorIdx
< MAX_COLOR_REGISTERS
);
2872 sixels
[imageX
][imageY
] = colorIdx
;
2876 for (int i
= 0; i
< MAX_COLOR_REGISTERS
; i
++) {
2877 boolean isUsed
= false;
2878 for (int imageX
= 0; imageX
< image
.getWidth(); imageX
++) {
2879 for (int j
= 0; j
< 6; j
++) {
2880 if (sixels
[imageX
][j
] == i
) {
2885 if (isUsed
== false) {
2889 // Set to the beginning of scan line for the next set of
2890 // colored pixels, and select the color.
2891 sb
.append(String
.format("$#%d", i
));
2893 for (int imageX
= 0; imageX
< image
.getWidth(); imageX
++) {
2895 // Add up all the pixels that match this color.
2898 (j
< 6) && (currentRow
+ j
< fullHeight
);
2901 if (sixels
[imageX
][j
] == i
) {
2925 assert (data
< 127);
2927 sb
.append((char) data
);
2928 } // for (int imageX = 0; imageX < image.getWidth(); imageX++)
2929 } // for (int i = 0; i < MAX_COLOR_REGISTERS; i++)
2931 // Advance to the next scan line.
2934 } // for (int currentRow = 0; currentRow < imageHeight; currentRow += 6)
2936 // Kill the very last "-", because it is unnecessary.
2937 sb
.deleteCharAt(sb
.length() - 1);
2940 // This row is OK to save into the cache.
2941 sixelCache
.put(cells
, sb
.toString());
2944 return (startSixel(x
, y
) + sb
.toString() + endSixel());
2947 // ------------------------------------------------------------------------
2948 // End sixel output support -----------------------------------------------
2949 // ------------------------------------------------------------------------
2952 * Create a SGR parameter sequence for a single color change.
2954 * @param bold if true, set bold
2955 * @param color one of the Color.WHITE, Color.BLUE, etc. constants
2956 * @param foreground if true, this is a foreground color
2957 * @return the string to emit to an ANSI / ECMA-style terminal,
2960 private String
color(final boolean bold
, final Color color
,
2961 final boolean foreground
) {
2962 return color(color
, foreground
, true) +
2963 rgbColor(bold
, color
, foreground
);
2967 * Create a T.416 RGB parameter sequence for a single color change.
2969 * @param colorRGB a 24-bit RGB value for foreground color
2970 * @param foreground if true, this is a foreground color
2971 * @return the string to emit to an ANSI / ECMA-style terminal,
2974 private String
colorRGB(final int colorRGB
, final boolean foreground
) {
2976 int colorRed
= (colorRGB
>>> 16) & 0xFF;
2977 int colorGreen
= (colorRGB
>>> 8) & 0xFF;
2978 int colorBlue
= colorRGB
& 0xFF;
2980 StringBuilder sb
= new StringBuilder();
2982 sb
.append("\033[38;2;");
2984 sb
.append("\033[48;2;");
2986 sb
.append(String
.format("%d;%d;%dm", colorRed
, colorGreen
, colorBlue
));
2987 return sb
.toString();
2991 * Create a T.416 RGB parameter sequence for both foreground and
2992 * background color change.
2994 * @param foreColorRGB a 24-bit RGB value for foreground color
2995 * @param backColorRGB a 24-bit RGB value for foreground color
2996 * @return the string to emit to an ANSI / ECMA-style terminal,
2999 private String
colorRGB(final int foreColorRGB
, final int backColorRGB
) {
3000 int foreColorRed
= (foreColorRGB
>>> 16) & 0xFF;
3001 int foreColorGreen
= (foreColorRGB
>>> 8) & 0xFF;
3002 int foreColorBlue
= foreColorRGB
& 0xFF;
3003 int backColorRed
= (backColorRGB
>>> 16) & 0xFF;
3004 int backColorGreen
= (backColorRGB
>>> 8) & 0xFF;
3005 int backColorBlue
= backColorRGB
& 0xFF;
3007 StringBuilder sb
= new StringBuilder();
3008 sb
.append(String
.format("\033[38;2;%d;%d;%dm",
3009 foreColorRed
, foreColorGreen
, foreColorBlue
));
3010 sb
.append(String
.format("\033[48;2;%d;%d;%dm",
3011 backColorRed
, backColorGreen
, backColorBlue
));
3012 return sb
.toString();
3016 * Create a T.416 RGB parameter sequence for a single color change.
3018 * @param bold if true, set bold
3019 * @param color one of the Color.WHITE, Color.BLUE, etc. constants
3020 * @param foreground if true, this is a foreground color
3021 * @return the string to emit to an xterm terminal with RGB support,
3022 * e.g. "\033[38;2;RR;GG;BBm"
3024 private String
rgbColor(final boolean bold
, final Color color
,
3025 final boolean foreground
) {
3026 if (doRgbColor
== false) {
3029 StringBuilder sb
= new StringBuilder("\033[");
3031 // Bold implies foreground only
3033 if (color
.equals(Color
.BLACK
)) {
3034 sb
.append("84;84;84");
3035 } else if (color
.equals(Color
.RED
)) {
3036 sb
.append("252;84;84");
3037 } else if (color
.equals(Color
.GREEN
)) {
3038 sb
.append("84;252;84");
3039 } else if (color
.equals(Color
.YELLOW
)) {
3040 sb
.append("252;252;84");
3041 } else if (color
.equals(Color
.BLUE
)) {
3042 sb
.append("84;84;252");
3043 } else if (color
.equals(Color
.MAGENTA
)) {
3044 sb
.append("252;84;252");
3045 } else if (color
.equals(Color
.CYAN
)) {
3046 sb
.append("84;252;252");
3047 } else if (color
.equals(Color
.WHITE
)) {
3048 sb
.append("252;252;252");
3056 if (color
.equals(Color
.BLACK
)) {
3058 } else if (color
.equals(Color
.RED
)) {
3059 sb
.append("168;0;0");
3060 } else if (color
.equals(Color
.GREEN
)) {
3061 sb
.append("0;168;0");
3062 } else if (color
.equals(Color
.YELLOW
)) {
3063 sb
.append("168;84;0");
3064 } else if (color
.equals(Color
.BLUE
)) {
3065 sb
.append("0;0;168");
3066 } else if (color
.equals(Color
.MAGENTA
)) {
3067 sb
.append("168;0;168");
3068 } else if (color
.equals(Color
.CYAN
)) {
3069 sb
.append("0;168;168");
3070 } else if (color
.equals(Color
.WHITE
)) {
3071 sb
.append("168;168;168");
3075 return sb
.toString();
3079 * Create a T.416 RGB parameter sequence for both foreground and
3080 * background color change.
3082 * @param bold if true, set bold
3083 * @param foreColor one of the Color.WHITE, Color.BLUE, etc. constants
3084 * @param backColor one of the Color.WHITE, Color.BLUE, etc. constants
3085 * @return the string to emit to an xterm terminal with RGB support,
3086 * e.g. "\033[38;2;RR;GG;BB;48;2;RR;GG;BBm"
3088 private String
rgbColor(final boolean bold
, final Color foreColor
,
3089 final Color backColor
) {
3090 if (doRgbColor
== false) {
3094 return rgbColor(bold
, foreColor
, true) +
3095 rgbColor(false, backColor
, false);
3099 * Create a SGR parameter sequence for a single color change.
3101 * @param color one of the Color.WHITE, Color.BLUE, etc. constants
3102 * @param foreground if true, this is a foreground color
3103 * @param header if true, make the full header, otherwise just emit the
3104 * color parameter e.g. "42;"
3105 * @return the string to emit to an ANSI / ECMA-style terminal,
3108 private String
color(final Color color
, final boolean foreground
,
3109 final boolean header
) {
3111 int ecmaColor
= color
.getValue();
3113 // Convert Color.* values to SGR numerics
3121 return String
.format("\033[%dm", ecmaColor
);
3123 return String
.format("%d;", ecmaColor
);
3128 * Create a SGR parameter sequence for both foreground and background
3131 * @param bold if true, set bold
3132 * @param foreColor one of the Color.WHITE, Color.BLUE, etc. constants
3133 * @param backColor one of the Color.WHITE, Color.BLUE, etc. constants
3134 * @return the string to emit to an ANSI / ECMA-style terminal,
3135 * e.g. "\033[31;42m"
3137 private String
color(final boolean bold
, final Color foreColor
,
3138 final Color backColor
) {
3139 return color(foreColor
, backColor
, true) +
3140 rgbColor(bold
, foreColor
, backColor
);
3144 * Create a SGR parameter sequence for both foreground and
3145 * background color change.
3147 * @param foreColor one of the Color.WHITE, Color.BLUE, etc. constants
3148 * @param backColor one of the Color.WHITE, Color.BLUE, etc. constants
3149 * @param header if true, make the full header, otherwise just emit the
3150 * color parameter e.g. "31;42;"
3151 * @return the string to emit to an ANSI / ECMA-style terminal,
3152 * e.g. "\033[31;42m"
3154 private String
color(final Color foreColor
, final Color backColor
,
3155 final boolean header
) {
3157 int ecmaForeColor
= foreColor
.getValue();
3158 int ecmaBackColor
= backColor
.getValue();
3160 // Convert Color.* values to SGR numerics
3161 ecmaBackColor
+= 40;
3162 ecmaForeColor
+= 30;
3165 return String
.format("\033[%d;%dm", ecmaForeColor
, ecmaBackColor
);
3167 return String
.format("%d;%d;", ecmaForeColor
, ecmaBackColor
);
3172 * Create a SGR parameter sequence for foreground, background, and
3173 * several attributes. This sequence first resets all attributes to
3174 * default, then sets attributes as per the parameters.
3176 * @param foreColor one of the Color.WHITE, Color.BLUE, etc. constants
3177 * @param backColor one of the Color.WHITE, Color.BLUE, etc. constants
3178 * @param bold if true, set bold
3179 * @param reverse if true, set reverse
3180 * @param blink if true, set blink
3181 * @param underline if true, set underline
3182 * @return the string to emit to an ANSI / ECMA-style terminal,
3183 * e.g. "\033[0;1;31;42m"
3185 private String
color(final Color foreColor
, final Color backColor
,
3186 final boolean bold
, final boolean reverse
, final boolean blink
,
3187 final boolean underline
) {
3189 int ecmaForeColor
= foreColor
.getValue();
3190 int ecmaBackColor
= backColor
.getValue();
3192 // Convert Color.* values to SGR numerics
3193 ecmaBackColor
+= 40;
3194 ecmaForeColor
+= 30;
3196 StringBuilder sb
= new StringBuilder();
3197 if ( bold
&& reverse
&& blink
&& !underline
) {
3198 sb
.append("\033[0;1;7;5;");
3199 } else if ( bold
&& reverse
&& !blink
&& !underline
) {
3200 sb
.append("\033[0;1;7;");
3201 } else if ( !bold
&& reverse
&& blink
&& !underline
) {
3202 sb
.append("\033[0;7;5;");
3203 } else if ( bold
&& !reverse
&& blink
&& !underline
) {
3204 sb
.append("\033[0;1;5;");
3205 } else if ( bold
&& !reverse
&& !blink
&& !underline
) {
3206 sb
.append("\033[0;1;");
3207 } else if ( !bold
&& reverse
&& !blink
&& !underline
) {
3208 sb
.append("\033[0;7;");
3209 } else if ( !bold
&& !reverse
&& blink
&& !underline
) {
3210 sb
.append("\033[0;5;");
3211 } else if ( bold
&& reverse
&& blink
&& underline
) {
3212 sb
.append("\033[0;1;7;5;4;");
3213 } else if ( bold
&& reverse
&& !blink
&& underline
) {
3214 sb
.append("\033[0;1;7;4;");
3215 } else if ( !bold
&& reverse
&& blink
&& underline
) {
3216 sb
.append("\033[0;7;5;4;");
3217 } else if ( bold
&& !reverse
&& blink
&& underline
) {
3218 sb
.append("\033[0;1;5;4;");
3219 } else if ( bold
&& !reverse
&& !blink
&& underline
) {
3220 sb
.append("\033[0;1;4;");
3221 } else if ( !bold
&& reverse
&& !blink
&& underline
) {
3222 sb
.append("\033[0;7;4;");
3223 } else if ( !bold
&& !reverse
&& blink
&& underline
) {
3224 sb
.append("\033[0;5;4;");
3225 } else if ( !bold
&& !reverse
&& !blink
&& underline
) {
3226 sb
.append("\033[0;4;");
3228 assert (!bold
&& !reverse
&& !blink
&& !underline
);
3229 sb
.append("\033[0;");
3231 sb
.append(String
.format("%d;%dm", ecmaForeColor
, ecmaBackColor
));
3232 sb
.append(rgbColor(bold
, foreColor
, backColor
));
3233 return sb
.toString();
3237 * Create a SGR parameter sequence for foreground, background, and
3238 * several attributes. This sequence first resets all attributes to
3239 * default, then sets attributes as per the parameters.
3241 * @param foreColorRGB a 24-bit RGB value for foreground color
3242 * @param backColorRGB a 24-bit RGB value for foreground color
3243 * @param bold if true, set bold
3244 * @param reverse if true, set reverse
3245 * @param blink if true, set blink
3246 * @param underline if true, set underline
3247 * @return the string to emit to an ANSI / ECMA-style terminal,
3248 * e.g. "\033[0;1;31;42m"
3250 private String
colorRGB(final int foreColorRGB
, final int backColorRGB
,
3251 final boolean bold
, final boolean reverse
, final boolean blink
,
3252 final boolean underline
) {
3254 int foreColorRed
= (foreColorRGB
>>> 16) & 0xFF;
3255 int foreColorGreen
= (foreColorRGB
>>> 8) & 0xFF;
3256 int foreColorBlue
= foreColorRGB
& 0xFF;
3257 int backColorRed
= (backColorRGB
>>> 16) & 0xFF;
3258 int backColorGreen
= (backColorRGB
>>> 8) & 0xFF;
3259 int backColorBlue
= backColorRGB
& 0xFF;
3261 StringBuilder sb
= new StringBuilder();
3262 if ( bold
&& reverse
&& blink
&& !underline
) {
3263 sb
.append("\033[0;1;7;5;");
3264 } else if ( bold
&& reverse
&& !blink
&& !underline
) {
3265 sb
.append("\033[0;1;7;");
3266 } else if ( !bold
&& reverse
&& blink
&& !underline
) {
3267 sb
.append("\033[0;7;5;");
3268 } else if ( bold
&& !reverse
&& blink
&& !underline
) {
3269 sb
.append("\033[0;1;5;");
3270 } else if ( bold
&& !reverse
&& !blink
&& !underline
) {
3271 sb
.append("\033[0;1;");
3272 } else if ( !bold
&& reverse
&& !blink
&& !underline
) {
3273 sb
.append("\033[0;7;");
3274 } else if ( !bold
&& !reverse
&& blink
&& !underline
) {
3275 sb
.append("\033[0;5;");
3276 } else if ( bold
&& reverse
&& blink
&& underline
) {
3277 sb
.append("\033[0;1;7;5;4;");
3278 } else if ( bold
&& reverse
&& !blink
&& underline
) {
3279 sb
.append("\033[0;1;7;4;");
3280 } else if ( !bold
&& reverse
&& blink
&& underline
) {
3281 sb
.append("\033[0;7;5;4;");
3282 } else if ( bold
&& !reverse
&& blink
&& underline
) {
3283 sb
.append("\033[0;1;5;4;");
3284 } else if ( bold
&& !reverse
&& !blink
&& underline
) {
3285 sb
.append("\033[0;1;4;");
3286 } else if ( !bold
&& reverse
&& !blink
&& underline
) {
3287 sb
.append("\033[0;7;4;");
3288 } else if ( !bold
&& !reverse
&& blink
&& underline
) {
3289 sb
.append("\033[0;5;4;");
3290 } else if ( !bold
&& !reverse
&& !blink
&& underline
) {
3291 sb
.append("\033[0;4;");
3293 assert (!bold
&& !reverse
&& !blink
&& !underline
);
3294 sb
.append("\033[0;");
3297 sb
.append("m\033[38;2;");
3298 sb
.append(String
.format("%d;%d;%d", foreColorRed
, foreColorGreen
,
3300 sb
.append("m\033[48;2;");
3301 sb
.append(String
.format("%d;%d;%d", backColorRed
, backColorGreen
,
3304 return sb
.toString();
3308 * Create a SGR parameter sequence to reset to defaults.
3310 * @return the string to emit to an ANSI / ECMA-style terminal,
3313 private String
normal() {
3314 return normal(true) + rgbColor(false, Color
.WHITE
, Color
.BLACK
);
3318 * Create a SGR parameter sequence to reset to defaults.
3320 * @param header if true, make the full header, otherwise just emit the
3321 * bare parameter e.g. "0;"
3322 * @return the string to emit to an ANSI / ECMA-style terminal,
3325 private String
normal(final boolean header
) {
3327 return "\033[0;37;40m";
3333 * Create a SGR parameter sequence for enabling the visible cursor.
3335 * @param on if true, turn on cursor
3336 * @return the string to emit to an ANSI / ECMA-style terminal
3338 private String
cursor(final boolean on
) {
3339 if (on
&& !cursorOn
) {
3343 if (!on
&& cursorOn
) {
3351 * Clear the entire screen. Because some terminals use back-color-erase,
3352 * set the color to white-on-black beforehand.
3354 * @return the string to emit to an ANSI / ECMA-style terminal
3356 private String
clearAll() {
3357 return "\033[0;37;40m\033[2J";
3361 * Clear the line from the cursor (inclusive) to the end of the screen.
3362 * Because some terminals use back-color-erase, set the color to
3363 * white-on-black beforehand.
3365 * @return the string to emit to an ANSI / ECMA-style terminal
3367 private String
clearRemainingLine() {
3368 return "\033[0;37;40m\033[K";
3372 * Move the cursor to (x, y).
3374 * @param x column coordinate. 0 is the left-most column.
3375 * @param y row coordinate. 0 is the top-most row.
3376 * @return the string to emit to an ANSI / ECMA-style terminal
3378 private String
gotoXY(final int x
, final int y
) {
3379 return String
.format("\033[%d;%dH", y
+ 1, x
+ 1);
3383 * Tell (u)xterm that we want to receive mouse events based on "Any event
3384 * tracking", UTF-8 coordinates, and then SGR coordinates. Ideally we
3385 * will end up with SGR coordinates with UTF-8 coordinates as a fallback.
3387 * http://invisible-island.net/xterm/ctlseqs/ctlseqs.html#Mouse%20Tracking
3389 * Note that this also sets the alternate/primary screen buffer.
3391 * @param on If true, enable mouse report and use the alternate screen
3392 * buffer. If false disable mouse reporting and use the primary screen
3394 * @return the string to emit to xterm
3396 private String
mouse(final boolean on
) {
3398 return "\033[?1002;1003;1005;1006h\033[?1049h";
3400 return "\033[?1002;1003;1006;1005l\033[?1049l";