X-Git-Url: http://git.nikiroo.be/?a=blobdiff_plain;f=src%2Fjexer%2Ftterminal%2FECMA48.java;h=537b2e0a4a3ba25238ee5d935f393aa07fcba24c;hb=505be508ae7d3fb48122be548b310a238cfb91eb;hp=3702b8bc5bc64d3c9e9e454dbdb8179e464aafc0;hpb=b2d49e0f15810a35a206e88c9bad11b053ed65fc;p=fanfix.git diff --git a/src/jexer/tterminal/ECMA48.java b/src/jexer/tterminal/ECMA48.java index 3702b8b..537b2e0 100644 --- a/src/jexer/tterminal/ECMA48.java +++ b/src/jexer/tterminal/ECMA48.java @@ -3,7 +3,7 @@ * * The MIT License (MIT) * - * Copyright (C) 2017 Kevin Lamonte + * Copyright (C) 2019 Kevin Lamonte * * Permission is hereby granted, free of charge, to any person obtaining a * copy of this software and associated documentation files (the "Software"), @@ -28,25 +28,36 @@ */ package jexer.tterminal; +import java.awt.Graphics; +import java.awt.image.BufferedImage; +import java.io.BufferedInputStream; import java.io.BufferedOutputStream; +import java.io.ByteArrayInputStream; +import java.io.CharArrayWriter; import java.io.InputStream; import java.io.InputStreamReader; import java.io.IOException; import java.io.OutputStream; import java.io.OutputStreamWriter; +import java.io.PrintWriter; import java.io.Reader; import java.io.UnsupportedEncodingException; import java.io.Writer; import java.util.ArrayList; import java.util.Collections; -import java.util.LinkedList; +import java.util.HashMap; import java.util.List; +import javax.imageio.ImageIO; import jexer.TKeypress; -import jexer.event.TMouseEvent; +import jexer.backend.GlyphMaker; import jexer.bits.Color; import jexer.bits.Cell; import jexer.bits.CellAttributes; +import jexer.bits.StringUtils; +import jexer.event.TInputEvent; +import jexer.event.TKeypressEvent; +import jexer.event.TMouseEvent; import jexer.io.ReadTimeoutException; import jexer.io.TimeoutInputStream; import static jexer.TKeypress.*; @@ -90,6 +101,10 @@ import static jexer.TKeypress.*; */ public class ECMA48 implements Runnable { + // ------------------------------------------------------------------------ + // Constants -------------------------------------------------------------- + // ------------------------------------------------------------------------ + /** * The emulator can emulate several kinds of terminals. */ @@ -116,194 +131,116 @@ public class ECMA48 implements Runnable { } /** - * Return the proper primary Device Attributes string. - * - * @return string to send to remote side that is appropriate for the - * this.type + * Parser character scan states. */ - private String deviceTypeResponse() { - switch (type) { - case VT100: - // "I am a VT100 with advanced video option" (often VT102) - return "\033[?1;2c"; - - case VT102: - // "I am a VT102" - return "\033[?6c"; - - case VT220: - case XTERM: - // "I am a VT220" - 7 bit version - if (!s8c1t) { - return "\033[?62;1;6c"; - } - // "I am a VT220" - 8 bit version - return "\u009b?62;1;6c"; - default: - throw new IllegalArgumentException("Invalid device type: " + type); - } + private enum ScanState { + GROUND, + ESCAPE, + ESCAPE_INTERMEDIATE, + CSI_ENTRY, + CSI_PARAM, + CSI_INTERMEDIATE, + CSI_IGNORE, + DCS_ENTRY, + DCS_INTERMEDIATE, + DCS_PARAM, + DCS_PASSTHROUGH, + DCS_IGNORE, + DCS_SIXEL, + SOSPMAPC_STRING, + OSC_STRING, + VT52_DIRECT_CURSOR_ADDRESS } /** - * Return the proper TERM environment variable for this device type. - * - * @param deviceType DeviceType.VT100, DeviceType, XTERM, etc. - * @return "vt100", "xterm", etc. + * The selected number pad mode (DECKPAM, DECKPNM). We record this, but + * can't really use it in keypress() because we do not see number pad + * events from TKeypress. */ - public static String deviceTypeTerm(final DeviceType deviceType) { - switch (deviceType) { - case VT100: - return "vt100"; - - case VT102: - return "vt102"; - - case VT220: - return "vt220"; - - case XTERM: - return "xterm"; - - default: - throw new IllegalArgumentException("Invalid device type: " - + deviceType); - } + private enum KeypadMode { + Application, + Numeric } /** - * Return the proper LANG for this device type. Only XTERM devices know - * about UTF-8, the others are defined by their standard to be either - * 7-bit or 8-bit characters only. - * - * @param deviceType DeviceType.VT100, DeviceType, XTERM, etc. - * @param baseLang a base language without UTF-8 flag such as "C" or - * "en_US" - * @return "en_US", "en_US.UTF-8", etc. + * Arrow keys can emit three different sequences (DECCKM or VT52 + * submode). */ - public static String deviceTypeLang(final DeviceType deviceType, - final String baseLang) { - - switch (deviceType) { - - case VT100: - case VT102: - case VT220: - return baseLang; - - case XTERM: - return baseLang + ".UTF-8"; - - default: - throw new IllegalArgumentException("Invalid device type: " - + deviceType); - } + private enum ArrowKeyMode { + VT52, + ANSI, + VT100 } /** - * Write a string directly to the remote side. - * - * @param str string to send + * Available character sets for GL, GR, G0, G1, G2, G3. */ - public void writeRemote(final String str) { - if (stopReaderThread) { - // Reader hit EOF, bail out now. - close(); - return; - } - - // System.err.printf("writeRemote() '%s'\n", str); + private enum CharacterSet { + US, + UK, + DRAWING, + ROM, + ROM_SPECIAL, + VT52_GRAPHICS, + DEC_SUPPLEMENTAL, + NRC_DUTCH, + NRC_FINNISH, + NRC_FRENCH, + NRC_FRENCH_CA, + NRC_GERMAN, + NRC_ITALIAN, + NRC_NORWEGIAN, + NRC_SPANISH, + NRC_SWEDISH, + NRC_SWISS + } - switch (type) { - case VT100: - case VT102: - case VT220: - if (outputStream == null) { - return; - } - try { - outputStream.flush(); - for (int i = 0; i < str.length(); i++) { - outputStream.write(str.charAt(i)); - } - outputStream.flush(); - } catch (IOException e) { - // Assume EOF - close(); - } - break; - case XTERM: - if (output == null) { - return; - } - try { - output.flush(); - output.write(str); - output.flush(); - } catch (IOException e) { - // Assume EOF - close(); - } - break; - default: - throw new IllegalArgumentException("Invalid device type: " + type); - } + /** + * Single-shift states used by the C1 control characters SS2 (0x8E) and + * SS3 (0x8F). + */ + private enum Singleshift { + NONE, + SS2, + SS3 } /** - * Close the input and output streams and stop the reader thread. Note - * that it is safe to call this multiple times. + * VT220+ lockshift states. */ - public final void close() { + private enum LockshiftMode { + NONE, + G1_GR, + G2_GR, + G2_GL, + G3_GR, + G3_GL + } - // Tell the reader thread to stop looking at input. It will close - // the input streams. - if (stopReaderThread == false) { - stopReaderThread = true; - try { - readerThread.join(1000); - } catch (InterruptedException e) { - e.printStackTrace(); - } - } + /** + * XTERM mouse reporting protocols. + */ + public enum MouseProtocol { + OFF, + X10, + NORMAL, + BUTTONEVENT, + ANYEVENT + } - // Now close the output stream. - switch (type) { - case VT100: - case VT102: - case VT220: - if (outputStream != null) { - try { - outputStream.close(); - } catch (IOException e) { - // SQUASH - } - outputStream = null; - } - break; - case XTERM: - if (outputStream != null) { - try { - outputStream.close(); - } catch (IOException e) { - // SQUASH - } - outputStream = null; - } - if (output != null) { - try { - output.close(); - } catch (IOException e) { - // SQUASH - } - output = null; - } - break; - default: - throw new IllegalArgumentException("Invalid device type: " + - type); - } + /** + * XTERM mouse reporting encodings. + */ + private enum MouseEncoding { + X10, + UTF8, + SGR } + // ------------------------------------------------------------------------ + // Variables -------------------------------------------------------------- + // ------------------------------------------------------------------------ + /** * The enclosing listening object. */ @@ -320,57 +257,24 @@ public class ECMA48 implements Runnable { private Thread readerThread = null; /** - * See if the reader thread is still running. - * - * @return if true, we are still connected to / reading from the remote - * side + * The type of emulator to be. */ - public final boolean isReading() { - return (!stopReaderThread); - } + private final DeviceType type; /** - * The type of emulator to be. + * The scrollback buffer characters + attributes. */ - private DeviceType type = DeviceType.VT102; - - /** - * Obtain a new blank display line for an external user - * (e.g. TTerminalWindow). - * - * @return new blank line - */ - public final DisplayLine getBlankDisplayLine() { - return new DisplayLine(currentState.attr); - } - - /** - * The scrollback buffer characters + attributes. - */ - private volatile List scrollback; - - /** - * Get the scrollback buffer. - * - * @return the scrollback buffer - */ - public final List getScrollbackBuffer() { - return scrollback; - } + private volatile ArrayList scrollback; /** * The raw display buffer characters + attributes. */ - private volatile List display; + private volatile ArrayList display; /** - * Get the display buffer. - * - * @return the display buffer + * The maximum number of lines in the scrollback buffer. */ - public final List getDisplayBuffer() { - return display; - } + private int scrollbackMax = 10000; /** * The terminal's input. For type == XTERM, this is an InputStreamReader @@ -394,231 +298,69 @@ public class ECMA48 implements Runnable { */ private OutputStream outputStream; - /** - * Parser character scan states. - */ - enum ScanState { - GROUND, - ESCAPE, - ESCAPE_INTERMEDIATE, - CSI_ENTRY, - CSI_PARAM, - CSI_INTERMEDIATE, - CSI_IGNORE, - DCS_ENTRY, - DCS_INTERMEDIATE, - DCS_PARAM, - DCS_PASSTHROUGH, - DCS_IGNORE, - SOSPMAPC_STRING, - OSC_STRING, - VT52_DIRECT_CURSOR_ADDRESS - } - /** * Current scanning state. */ private ScanState scanState; - /** - * The selected number pad mode (DECKPAM, DECKPNM). We record this, but - * can't really use it in keypress() because we do not see number pad - * events from TKeypress. - */ - private enum KeypadMode { - Application, - Numeric - } - - /** - * Arrow keys can emit three different sequences (DECCKM or VT52 - * submode). - */ - private enum ArrowKeyMode { - VT52, - ANSI, - VT100 - } - - /** - * Available character sets for GL, GR, G0, G1, G2, G3. - */ - private enum CharacterSet { - US, - UK, - DRAWING, - ROM, - ROM_SPECIAL, - VT52_GRAPHICS, - DEC_SUPPLEMENTAL, - NRC_DUTCH, - NRC_FINNISH, - NRC_FRENCH, - NRC_FRENCH_CA, - NRC_GERMAN, - NRC_ITALIAN, - NRC_NORWEGIAN, - NRC_SPANISH, - NRC_SWEDISH, - NRC_SWISS - } - - /** - * Single-shift states used by the C1 control characters SS2 (0x8E) and - * SS3 (0x8F). - */ - private enum Singleshift { - NONE, - SS2, - SS3 - } - - /** - * VT220+ lockshift states. - */ - private enum LockshiftMode { - NONE, - G1_GR, - G2_GR, - G2_GL, - G3_GR, - G3_GL - } - - /** - * XTERM mouse reporting protocols. - */ - private enum MouseProtocol { - OFF, - X10, - NORMAL, - BUTTONEVENT, - ANYEVENT - } - /** * Which mouse protocol is active. */ private MouseProtocol mouseProtocol = MouseProtocol.OFF; - /** - * XTERM mouse reporting encodings. - */ - private enum MouseEncoding { - X10, - UTF8, - SGR - } - /** * Which mouse encoding is active. */ private MouseEncoding mouseEncoding = MouseEncoding.X10; /** - * Physical display width. We start at 80x24, but the user can resize us - * bigger/smaller. - */ - private int width; - - /** - * Get the display width. - * - * @return the width (usually 80 or 132) + * A terminal may request that the mouse pointer be hidden using a + * Privacy Message containing either "hideMousePointer" or + * "showMousePointer". This is currently only used within Jexer by + * TTerminalWindow so that only the bottom-most instance of nested + * Jexer's draws the mouse within its application window. */ - public final int getWidth() { - return width; - } + private boolean hideMousePointer = false; /** - * Set the display width. - * - * @param width the new width + * Physical display width. We start at 80x24, but the user can resize us + * bigger/smaller. */ - public final void setWidth(final int width) { - this.width = width; - rightMargin = width - 1; - if (currentState.cursorX >= width) { - currentState.cursorX = width - 1; - } - if (savedState.cursorX >= width) { - savedState.cursorX = width - 1; - } - } + private int width = 80; /** * Physical display height. We start at 80x24, but the user can resize * us bigger/smaller. */ - private int height; - - /** - * Get the display height. - * - * @return the height (usually 24) - */ - public final int getHeight() { - return height; - } - - /** - * Set the display height. - * - * @param height the new height - */ - public final void setHeight(final int height) { - int delta = height - this.height; - this.height = height; - scrollRegionBottom += delta; - if (scrollRegionBottom < 0) { - scrollRegionBottom = height; - } - if (scrollRegionTop >= scrollRegionBottom) { - scrollRegionTop = 0; - } - if (currentState.cursorY >= height) { - currentState.cursorY = height - 1; - } - if (savedState.cursorY >= height) { - savedState.cursorY = height - 1; - } - while (display.size() < height) { - DisplayLine line = new DisplayLine(currentState.attr); - line.setReverseColor(reverseVideo); - display.add(line); - } - while (display.size() > height) { - scrollback.add(display.remove(0)); - } - } + private int height = 24; /** * Top margin of the scrolling region. */ - private int scrollRegionTop; + private int scrollRegionTop = 0; /** * Bottom margin of the scrolling region. */ - private int scrollRegionBottom; + private int scrollRegionBottom = height - 1; /** * Right margin column number. This can be selected by the remote side * to be 80/132 (rightMargin values 79/131), or it can be (width - 1). */ - private int rightMargin; + private int rightMargin = 79; /** * Last character printed. */ - private char repCh; + private int repCh; /** * VT100-style line wrapping: a character is placed in column 80 (or * 132), but the line does NOT wrap until another character is written to * column 1 of the next line, after which the cursor moves to column 2. */ - private boolean wrapLineFlag; + private boolean wrapLineFlag = false; /** * VT220 single shift flag. @@ -641,32 +383,12 @@ public class ECMA48 implements Runnable { */ private boolean cursorVisible = true; - /** - * Get visible cursor flag. - * - * @return if true, the cursor is visible - */ - public final boolean isCursorVisible() { - return cursorVisible; - } - /** * Screen title as set by the xterm OSC sequence. Lots of applications * send a screenTitle regardless of whether it is an xterm client or not. */ private String screenTitle = ""; - /** - * Get the screen title as set by the xterm OSC sequence. Lots of - * applications send a screenTitle regardless of whether it is an xterm - * client or not. - * - * @return screen title - */ - public final String getScreenTitle() { - return screenTitle; - } - /** * Parameter characters being collected. */ @@ -675,7 +397,7 @@ public class ECMA48 implements Runnable { /** * Non-csi collect buffer. */ - private StringBuilder collectBuffer; + private StringBuilder collectBuffer = new StringBuilder(128); /** * When true, use the G1 character set. @@ -722,15 +444,6 @@ public class ECMA48 implements Runnable { */ private boolean columns132 = false; - /** - * Get 132 columns value. - * - * @return if true, the terminal is in 132 column mode - */ - public final boolean isColumns132() { - return columns132; - } - /** * true = reverse video. Set by DECSCNM. */ @@ -742,35 +455,92 @@ public class ECMA48 implements Runnable { private boolean fullDuplex = true; /** - * DECSC/DECRC save/restore a subset of the total state. This class - * encapsulates those specific flags/modes. + * The current terminal state. */ - private class SaveableState { + private SaveableState currentState; - /** - * When true, cursor positions are relative to the scrolling region. - */ - public boolean originMode = false; + /** + * The last saved terminal state. + */ + private SaveableState savedState; - /** - * The current editing X position. - */ - public int cursorX = 0; + /** + * The 88- or 256-color support RGB colors. + */ + private List colors88; - /** - * The current editing Y position. - */ - public int cursorY = 0; + /** + * Sixel collection buffer. + */ + private StringBuilder sixelParseBuffer = new StringBuilder(2048); - /** - * Which character set is currently selected in G0. - */ - public CharacterSet g0Charset = CharacterSet.US; + /** + * Sixel shared palette. + */ + private HashMap sixelPalette; - /** - * Which character set is currently selected in G1. - */ - public CharacterSet g1Charset = CharacterSet.DRAWING; + /** + * The width of a character cell in pixels. + */ + private int textWidth = 16; + + /** + * The height of a character cell in pixels. + */ + private int textHeight = 20; + + /** + * The last used height of a character cell in pixels, only used for + * full-width chars. + */ + private int lastTextHeight = -1; + + /** + * The glyph drawer for full-width chars. + */ + private GlyphMaker glyphMaker = null; + + /** + * Input queue for keystrokes and mouse events to send to the remote + * side. + */ + private ArrayList userQueue = new ArrayList(); + + /** + * Number of bytes/characters passed to consume(). + */ + private long readCount = 0; + + /** + * DECSC/DECRC save/restore a subset of the total state. This class + * encapsulates those specific flags/modes. + */ + private class SaveableState { + + /** + * When true, cursor positions are relative to the scrolling region. + */ + public boolean originMode = false; + + /** + * The current editing X position. + */ + public int cursorX = 0; + + /** + * The current editing Y position. + */ + public int cursorY = 0; + + /** + * Which character set is currently selected in G0. + */ + public CharacterSet g0Charset = CharacterSet.US; + + /** + * Which character set is currently selected in G1. + */ + public CharacterSet g1Charset = CharacterSet.DRAWING; /** * Which character set is currently selected in G2. @@ -854,57 +624,1066 @@ public class ECMA48 implements Runnable { } } + // ------------------------------------------------------------------------ + // Constructors ----------------------------------------------------------- + // ------------------------------------------------------------------------ + /** - * The current terminal state. + * Public constructor. + * + * @param type one of the DeviceType constants to select VT100, VT102, + * VT220, or XTERM + * @param inputStream an InputStream connected to the remote side. For + * type == XTERM, inputStream is converted to a Reader with UTF-8 + * encoding. + * @param outputStream an OutputStream connected to the remote user. For + * type == XTERM, outputStream is converted to a Writer with UTF-8 + * encoding. + * @param displayListener a callback to the outer display, or null for + * default VT100 behavior + * @throws UnsupportedEncodingException if an exception is thrown when + * creating the InputStreamReader */ - private SaveableState currentState; + public ECMA48(final DeviceType type, final InputStream inputStream, + final OutputStream outputStream, final DisplayListener displayListener) + throws UnsupportedEncodingException { + + assert (inputStream != null); + assert (outputStream != null); + + csiParams = new ArrayList(); + tabStops = new ArrayList(); + scrollback = new ArrayList(); + display = new ArrayList(); + + this.type = type; + if (inputStream instanceof TimeoutInputStream) { + this.inputStream = (TimeoutInputStream)inputStream; + } else { + this.inputStream = new TimeoutInputStream(inputStream, 2000); + } + if (type == DeviceType.XTERM) { + this.input = new InputStreamReader(new BufferedInputStream( + this.inputStream, 1024 * 128), "UTF-8"); + this.output = new OutputStreamWriter(new + BufferedOutputStream(outputStream), "UTF-8"); + this.outputStream = null; + } else { + this.output = null; + this.outputStream = new BufferedOutputStream(outputStream); + } + this.displayListener = displayListener; + + reset(); + for (int i = 0; i < height; i++) { + display.add(new DisplayLine(currentState.attr)); + } + assert (currentState.cursorY < height); + assert (currentState.cursorX < width); + + // Spin up the input reader + readerThread = new Thread(this); + readerThread.start(); + } + + // ------------------------------------------------------------------------ + // Runnable --------------------------------------------------------------- + // ------------------------------------------------------------------------ /** - * The last saved terminal state. + * Read function runs on a separate thread. */ - private SaveableState savedState; + public final void run() { + boolean utf8 = false; + boolean done = false; + + if (type == DeviceType.XTERM) { + utf8 = true; + } + + // available() will often return > 1, so we need to read in chunks to + // stay caught up. + char [] readBufferUTF8 = null; + byte [] readBuffer = null; + if (utf8) { + readBufferUTF8 = new char[2048]; + } else { + readBuffer = new byte[2048]; + } + + while (!done && !stopReaderThread) { + synchronized (userQueue) { + while (userQueue.size() > 0) { + handleUserEvent(userQueue.remove(0)); + } + } + + try { + int n = inputStream.available(); + + // System.err.printf("available() %d\n", n); System.err.flush(); + if (utf8) { + if (readBufferUTF8.length < n) { + // The buffer wasn't big enough, make it huger + int newSizeHalf = Math.max(readBufferUTF8.length, + n); + + readBufferUTF8 = new char[newSizeHalf * 2]; + } + } else { + if (readBuffer.length < n) { + // The buffer wasn't big enough, make it huger + int newSizeHalf = Math.max(readBuffer.length, n); + readBuffer = new byte[newSizeHalf * 2]; + } + } + if (n == 0) { + try { + Thread.sleep(10); + } catch (InterruptedException e) { + // SQUASH + } + continue; + } + + int rc = -1; + try { + if (utf8) { + rc = input.read(readBufferUTF8, 0, + readBufferUTF8.length); + } else { + rc = inputStream.read(readBuffer, 0, + readBuffer.length); + } + } catch (ReadTimeoutException e) { + rc = 0; + } + + // System.err.printf("read() %d\n", rc); System.err.flush(); + if (rc == -1) { + // This is EOF + done = true; + } else { + // Don't step on UI events + synchronized (this) { + if (utf8) { + for (int i = 0; i < rc;) { + int ch = Character.codePointAt(readBufferUTF8, + i); + i += Character.charCount(ch); + + // Special case for VT10x: 7-bit characters + // only. + if ((type == DeviceType.VT100) + || (type == DeviceType.VT102) + ) { + consume(ch & 0x7F); + } else { + consume(ch); + } + } + } else { + for (int i = 0; i < rc; i++) { + // Special case for VT10x: 7-bit characters + // only. + if ((type == DeviceType.VT100) + || (type == DeviceType.VT102) + ) { + consume(readBuffer[i] & 0x7F); + } else { + consume(readBuffer[i]); + } + } + } + } + // Permit my enclosing UI to know that I updated. + if (displayListener != null) { + displayListener.displayChanged(); + } + } + // System.err.println("end while loop"); System.err.flush(); + } catch (IOException e) { + done = true; + + // This is an unusual case. We want to see the stack trace, + // but it is related to the spawned process rather than the + // actual UI. We will generate the stack trace, and consume + // it as though it was emitted by the shell. + CharArrayWriter writer= new CharArrayWriter(); + // Send a ST and RIS to clear the emulator state. + try { + writer.write("\033\\\033c"); + writer.write("\n-----------------------------------\n"); + e.printStackTrace(new PrintWriter(writer)); + writer.write("\n-----------------------------------\n"); + } catch (IOException e2) { + // SQUASH + } + char [] stackTrace = writer.toCharArray(); + for (int i = 0; i < stackTrace.length; i++) { + if (stackTrace[i] == '\n') { + consume('\r'); + } + consume(stackTrace[i]); + } + } + + } // while ((done == false) && (stopReaderThread == false)) + + // Let the rest of the world know that I am done. + stopReaderThread = true; + + try { + inputStream.cancelRead(); + inputStream.close(); + inputStream = null; + } catch (IOException e) { + // SQUASH + } + try { + input.close(); + input = null; + } catch (IOException e) { + // SQUASH + } + + // Permit my enclosing UI to know that I updated. + if (displayListener != null) { + displayListener.displayChanged(); + } + + // System.err.println("*** run() exiting..."); System.err.flush(); + } + + // ------------------------------------------------------------------------ + // ECMA48 ----------------------------------------------------------------- + // ------------------------------------------------------------------------ /** - * Clear the CSI parameters and flags. + * Wait for a period of time to get output from the launched process. + * + * @param millis millis to wait for, or 0 to wait forever + * @return true if the launched process has emitted something */ - private void toGround() { - csiParams.clear(); - collectBuffer = new StringBuilder(8); - scanState = ScanState.GROUND; + public boolean waitForOutput(final int millis) { + if (millis < 0) { + throw new IllegalArgumentException("timeout must be >= 0"); + } + int waitedMillis = millis; + final int pollTimeout = 5; + while (true) { + if (readCount != 0) { + return true; + } + if ((millis > 0) && (waitedMillis < 0)){ + return false; + } + try { + Thread.sleep(pollTimeout); + } catch (InterruptedException e) { + // SQUASH + } + waitedMillis -= pollTimeout; + } } /** - * Reset the tab stops list. + * Process keyboard and mouse events from the user. + * + * @param event the input event to consume */ - private void resetTabStops() { - tabStops.clear(); - for (int i = 0; (i * 8) <= rightMargin; i++) { - tabStops.add(new Integer(i * 8)); + private void handleUserEvent(final TInputEvent event) { + if (event instanceof TKeypressEvent) { + keypress(((TKeypressEvent) event).getKey()); + } + if (event instanceof TMouseEvent) { + mouse((TMouseEvent) event); } } /** - * Reset the emulation state. + * Add a keyboard and mouse event from the user to the queue. + * + * @param event the input event to consume */ - private void reset() { - - currentState = new SaveableState(); - savedState = new SaveableState(); - scanState = ScanState.GROUND; - width = 80; - height = 24; - scrollRegionTop = 0; - scrollRegionBottom = height - 1; - rightMargin = width - 1; - newLineMode = false; - arrowKeyMode = ArrowKeyMode.ANSI; - keypadMode = KeypadMode.Numeric; - wrapLineFlag = false; - if (displayListener != null) { - width = displayListener.getDisplayWidth(); - height = displayListener.getDisplayHeight(); - rightMargin = width - 1; + public void addUserEvent(final TInputEvent event) { + synchronized (userQueue) { + userQueue.add(event); } + } + + /** + * Return the proper primary Device Attributes string. + * + * @return string to send to remote side that is appropriate for the + * this.type + */ + private String deviceTypeResponse() { + switch (type) { + case VT100: + // "I am a VT100 with advanced video option" (often VT102) + return "\033[?1;2c"; + + case VT102: + // "I am a VT102" + return "\033[?6c"; + + case VT220: + case XTERM: + // "I am a VT220" - 7 bit version, with sixel and Jexer image + // support. + if (!s8c1t) { + return "\033[?62;1;6;9;4;22;444c"; + } + // "I am a VT220" - 8 bit version, with sixel and Jexer image + // support. + return "\u009b?62;1;6;9;4;22;444c"; + default: + throw new IllegalArgumentException("Invalid device type: " + type); + } + } + + /** + * Return the proper TERM environment variable for this device type. + * + * @param deviceType DeviceType.VT100, DeviceType, XTERM, etc. + * @return "vt100", "xterm", etc. + */ + public static String deviceTypeTerm(final DeviceType deviceType) { + switch (deviceType) { + case VT100: + return "vt100"; + + case VT102: + return "vt102"; + + case VT220: + return "vt220"; + + case XTERM: + return "xterm"; + + default: + throw new IllegalArgumentException("Invalid device type: " + + deviceType); + } + } + + /** + * Return the proper LANG for this device type. Only XTERM devices know + * about UTF-8, the others are defined by their standard to be either + * 7-bit or 8-bit characters only. + * + * @param deviceType DeviceType.VT100, DeviceType, XTERM, etc. + * @param baseLang a base language without UTF-8 flag such as "C" or + * "en_US" + * @return "en_US", "en_US.UTF-8", etc. + */ + public static String deviceTypeLang(final DeviceType deviceType, + final String baseLang) { + + switch (deviceType) { + + case VT100: + case VT102: + case VT220: + return baseLang; + + case XTERM: + return baseLang + ".UTF-8"; + + default: + throw new IllegalArgumentException("Invalid device type: " + + deviceType); + } + } + + /** + * Write a string directly to the remote side. + * + * @param str string to send + */ + public void writeRemote(final String str) { + if (stopReaderThread) { + // Reader hit EOF, bail out now. + close(); + return; + } + + // System.err.printf("writeRemote() '%s'\n", str); + + switch (type) { + case VT100: + case VT102: + case VT220: + if (outputStream == null) { + return; + } + try { + outputStream.flush(); + for (int i = 0; i < str.length(); i++) { + outputStream.write(str.charAt(i)); + } + outputStream.flush(); + } catch (IOException e) { + // Assume EOF + close(); + } + break; + case XTERM: + if (output == null) { + return; + } + try { + output.flush(); + output.write(str); + output.flush(); + } catch (IOException e) { + // Assume EOF + close(); + } + break; + default: + throw new IllegalArgumentException("Invalid device type: " + type); + } + } + + /** + * Close the input and output streams and stop the reader thread. Note + * that it is safe to call this multiple times. + */ + public final void close() { + + // Tell the reader thread to stop looking at input. It will close + // the input streams. + if (stopReaderThread == false) { + stopReaderThread = true; + } + + // Now close the output stream. + switch (type) { + case VT100: + case VT102: + case VT220: + if (outputStream != null) { + try { + outputStream.close(); + } catch (IOException e) { + // SQUASH + } + outputStream = null; + } + break; + case XTERM: + if (outputStream != null) { + try { + outputStream.close(); + } catch (IOException e) { + // SQUASH + } + outputStream = null; + } + if (output != null) { + try { + output.close(); + } catch (IOException e) { + // SQUASH + } + output = null; + } + break; + default: + throw new IllegalArgumentException("Invalid device type: " + + type); + } + } + + /** + * See if the reader thread is still running. + * + * @return if true, we are still connected to / reading from the remote + * side + */ + public final boolean isReading() { + return (!stopReaderThread); + } + + /** + * Obtain a new blank display line for an external user + * (e.g. TTerminalWindow). + * + * @return new blank line + */ + public final DisplayLine getBlankDisplayLine() { + return new DisplayLine(currentState.attr); + } + + /** + * Get the scrollback buffer. + * + * @return the scrollback buffer + */ + public final List getScrollbackBuffer() { + return scrollback; + } + + /** + * Get the display buffer. + * + * @return the display buffer + */ + public final List getDisplayBuffer() { + return display; + } + + /** + * Get the visible display + scrollback buffer, offset by a specified + * number of rows from the bottom. + * + * @param visibleHeight the total height of the display to show + * @param scrollBottom the number of rows from the bottom to scroll back + * @return a copy of the display + scrollback buffers + */ + public final List getVisibleDisplay(final int visibleHeight, + final int scrollBottom) { + + assert (visibleHeight >= 0); + assert (scrollBottom >= 0); + + int visibleBottom = scrollback.size() + display.size() - scrollBottom; + + List preceedingBlankLines = new ArrayList(); + int visibleTop = visibleBottom - visibleHeight; + if (visibleTop < 0) { + for (int i = visibleTop; i < 0; i++) { + preceedingBlankLines.add(getBlankDisplayLine()); + } + visibleTop = 0; + } + assert (visibleTop >= 0); + + List displayLines = new ArrayList(); + displayLines.addAll(scrollback); + displayLines.addAll(display); + + List visibleLines = new ArrayList(); + visibleLines.addAll(preceedingBlankLines); + visibleLines.addAll(displayLines.subList(visibleTop, visibleBottom)); + + // Fill in the blank lines on bottom + int bottomBlankLines = visibleHeight - visibleLines.size(); + assert (bottomBlankLines >= 0); + for (int i = 0; i < bottomBlankLines; i++) { + visibleLines.add(getBlankDisplayLine()); + } + + return copyBuffer(visibleLines); + } + + /** + * Copy a display buffer. + * + * @param buffer the buffer to copy + * @return a deep copy of the buffer's data + */ + private List copyBuffer(final List buffer) { + ArrayList result = new ArrayList(buffer.size()); + for (DisplayLine line: buffer) { + result.add(new DisplayLine(line)); + } + return result; + } + + /** + * Get the display width. + * + * @return the width (usually 80 or 132) + */ + public final int getWidth() { + return width; + } + + /** + * Set the display width. + * + * @param width the new width + */ + public final synchronized void setWidth(final int width) { + this.width = width; + rightMargin = width - 1; + if (currentState.cursorX >= width) { + currentState.cursorX = width - 1; + } + if (savedState.cursorX >= width) { + savedState.cursorX = width - 1; + } + } + + /** + * Get the display height. + * + * @return the height (usually 24) + */ + public final int getHeight() { + return height; + } + + /** + * Set the display height. + * + * @param height the new height + */ + public final synchronized void setHeight(final int height) { + int delta = height - this.height; + this.height = height; + scrollRegionBottom += delta; + if ((scrollRegionBottom < 0) || (scrollRegionTop > height - 1)) { + scrollRegionBottom = height - 1; + } + if (scrollRegionTop >= scrollRegionBottom) { + scrollRegionTop = 0; + } + if (currentState.cursorY >= height) { + currentState.cursorY = height - 1; + } + if (savedState.cursorY >= height) { + savedState.cursorY = height - 1; + } + while (display.size() < height) { + DisplayLine line = new DisplayLine(currentState.attr); + line.setReverseColor(reverseVideo); + display.add(line); + } + while (display.size() > height) { + appendScrollbackLine(display.remove(0)); + } + } + + /** + * Get the maximum number of lines in the scrollback buffer. + * + * @return the maximum number of lines in the scrollback buffer + */ + public int getScrollbackMax() { + return scrollbackMax; + } + + /** + * Set the maximum number of lines for the scrollback buffer. + * + * @param scrollbackMax the maximum number of lines for the scrollback + * buffer + */ + public final void setScrollbackMax(final int scrollbackMax) { + this.scrollbackMax = scrollbackMax; + } + + /** + * Get visible cursor flag. + * + * @return if true, the cursor is visible + */ + public final boolean isCursorVisible() { + return cursorVisible; + } + + /** + * Get the screen title as set by the xterm OSC sequence. Lots of + * applications send a screenTitle regardless of whether it is an xterm + * client or not. + * + * @return screen title + */ + public final String getScreenTitle() { + return screenTitle; + } + + /** + * Get 132 columns value. + * + * @return if true, the terminal is in 132 column mode + */ + public final boolean isColumns132() { + return columns132; + } + + /** + * Clear the CSI parameters and flags. + */ + private void toGround() { + csiParams.clear(); + collectBuffer.setLength(0); + scanState = ScanState.GROUND; + } + + /** + * Reset the tab stops list. + */ + private void resetTabStops() { + tabStops.clear(); + for (int i = 0; (i * 8) <= rightMargin; i++) { + tabStops.add(Integer.valueOf(i * 8)); + } + } + + /** + * Reset the 88- or 256-colors. + */ + private void resetColors() { + colors88 = new ArrayList(256); + for (int i = 0; i < 256; i++) { + colors88.add(0); + } + + // Set default system colors. These match DOS colors. + colors88.set(0, 0x00000000); + colors88.set(1, 0x00a80000); + colors88.set(2, 0x0000a800); + colors88.set(3, 0x00a85400); + colors88.set(4, 0x000000a8); + colors88.set(5, 0x00a800a8); + colors88.set(6, 0x0000a8a8); + colors88.set(7, 0x00a8a8a8); + + colors88.set(8, 0x00545454); + colors88.set(9, 0x00fc5454); + colors88.set(10, 0x0054fc54); + colors88.set(11, 0x00fcfc54); + colors88.set(12, 0x005454fc); + colors88.set(13, 0x00fc54fc); + colors88.set(14, 0x0054fcfc); + colors88.set(15, 0x00fcfcfc); + + // These match xterm's default colors from 256colres.h. + colors88.set(16, 0x000000); + colors88.set(17, 0x00005f); + colors88.set(18, 0x000087); + colors88.set(19, 0x0000af); + colors88.set(20, 0x0000d7); + colors88.set(21, 0x0000ff); + colors88.set(22, 0x005f00); + colors88.set(23, 0x005f5f); + colors88.set(24, 0x005f87); + colors88.set(25, 0x005faf); + colors88.set(26, 0x005fd7); + colors88.set(27, 0x005fff); + colors88.set(28, 0x008700); + colors88.set(29, 0x00875f); + colors88.set(30, 0x008787); + colors88.set(31, 0x0087af); + colors88.set(32, 0x0087d7); + colors88.set(33, 0x0087ff); + colors88.set(34, 0x00af00); + colors88.set(35, 0x00af5f); + colors88.set(36, 0x00af87); + colors88.set(37, 0x00afaf); + colors88.set(38, 0x00afd7); + colors88.set(39, 0x00afff); + colors88.set(40, 0x00d700); + colors88.set(41, 0x00d75f); + colors88.set(42, 0x00d787); + colors88.set(43, 0x00d7af); + colors88.set(44, 0x00d7d7); + colors88.set(45, 0x00d7ff); + colors88.set(46, 0x00ff00); + colors88.set(47, 0x00ff5f); + colors88.set(48, 0x00ff87); + colors88.set(49, 0x00ffaf); + colors88.set(50, 0x00ffd7); + colors88.set(51, 0x00ffff); + colors88.set(52, 0x5f0000); + colors88.set(53, 0x5f005f); + colors88.set(54, 0x5f0087); + colors88.set(55, 0x5f00af); + colors88.set(56, 0x5f00d7); + colors88.set(57, 0x5f00ff); + colors88.set(58, 0x5f5f00); + colors88.set(59, 0x5f5f5f); + colors88.set(60, 0x5f5f87); + colors88.set(61, 0x5f5faf); + colors88.set(62, 0x5f5fd7); + colors88.set(63, 0x5f5fff); + colors88.set(64, 0x5f8700); + colors88.set(65, 0x5f875f); + colors88.set(66, 0x5f8787); + colors88.set(67, 0x5f87af); + colors88.set(68, 0x5f87d7); + colors88.set(69, 0x5f87ff); + colors88.set(70, 0x5faf00); + colors88.set(71, 0x5faf5f); + colors88.set(72, 0x5faf87); + colors88.set(73, 0x5fafaf); + colors88.set(74, 0x5fafd7); + colors88.set(75, 0x5fafff); + colors88.set(76, 0x5fd700); + colors88.set(77, 0x5fd75f); + colors88.set(78, 0x5fd787); + colors88.set(79, 0x5fd7af); + colors88.set(80, 0x5fd7d7); + colors88.set(81, 0x5fd7ff); + colors88.set(82, 0x5fff00); + colors88.set(83, 0x5fff5f); + colors88.set(84, 0x5fff87); + colors88.set(85, 0x5fffaf); + colors88.set(86, 0x5fffd7); + colors88.set(87, 0x5fffff); + colors88.set(88, 0x870000); + colors88.set(89, 0x87005f); + colors88.set(90, 0x870087); + colors88.set(91, 0x8700af); + colors88.set(92, 0x8700d7); + colors88.set(93, 0x8700ff); + colors88.set(94, 0x875f00); + colors88.set(95, 0x875f5f); + colors88.set(96, 0x875f87); + colors88.set(97, 0x875faf); + colors88.set(98, 0x875fd7); + colors88.set(99, 0x875fff); + colors88.set(100, 0x878700); + colors88.set(101, 0x87875f); + colors88.set(102, 0x878787); + colors88.set(103, 0x8787af); + colors88.set(104, 0x8787d7); + colors88.set(105, 0x8787ff); + colors88.set(106, 0x87af00); + colors88.set(107, 0x87af5f); + colors88.set(108, 0x87af87); + colors88.set(109, 0x87afaf); + colors88.set(110, 0x87afd7); + colors88.set(111, 0x87afff); + colors88.set(112, 0x87d700); + colors88.set(113, 0x87d75f); + colors88.set(114, 0x87d787); + colors88.set(115, 0x87d7af); + colors88.set(116, 0x87d7d7); + colors88.set(117, 0x87d7ff); + colors88.set(118, 0x87ff00); + colors88.set(119, 0x87ff5f); + colors88.set(120, 0x87ff87); + colors88.set(121, 0x87ffaf); + colors88.set(122, 0x87ffd7); + colors88.set(123, 0x87ffff); + colors88.set(124, 0xaf0000); + colors88.set(125, 0xaf005f); + colors88.set(126, 0xaf0087); + colors88.set(127, 0xaf00af); + colors88.set(128, 0xaf00d7); + colors88.set(129, 0xaf00ff); + colors88.set(130, 0xaf5f00); + colors88.set(131, 0xaf5f5f); + colors88.set(132, 0xaf5f87); + colors88.set(133, 0xaf5faf); + colors88.set(134, 0xaf5fd7); + colors88.set(135, 0xaf5fff); + colors88.set(136, 0xaf8700); + colors88.set(137, 0xaf875f); + colors88.set(138, 0xaf8787); + colors88.set(139, 0xaf87af); + colors88.set(140, 0xaf87d7); + colors88.set(141, 0xaf87ff); + colors88.set(142, 0xafaf00); + colors88.set(143, 0xafaf5f); + colors88.set(144, 0xafaf87); + colors88.set(145, 0xafafaf); + colors88.set(146, 0xafafd7); + colors88.set(147, 0xafafff); + colors88.set(148, 0xafd700); + colors88.set(149, 0xafd75f); + colors88.set(150, 0xafd787); + colors88.set(151, 0xafd7af); + colors88.set(152, 0xafd7d7); + colors88.set(153, 0xafd7ff); + colors88.set(154, 0xafff00); + colors88.set(155, 0xafff5f); + colors88.set(156, 0xafff87); + colors88.set(157, 0xafffaf); + colors88.set(158, 0xafffd7); + colors88.set(159, 0xafffff); + colors88.set(160, 0xd70000); + colors88.set(161, 0xd7005f); + colors88.set(162, 0xd70087); + colors88.set(163, 0xd700af); + colors88.set(164, 0xd700d7); + colors88.set(165, 0xd700ff); + colors88.set(166, 0xd75f00); + colors88.set(167, 0xd75f5f); + colors88.set(168, 0xd75f87); + colors88.set(169, 0xd75faf); + colors88.set(170, 0xd75fd7); + colors88.set(171, 0xd75fff); + colors88.set(172, 0xd78700); + colors88.set(173, 0xd7875f); + colors88.set(174, 0xd78787); + colors88.set(175, 0xd787af); + colors88.set(176, 0xd787d7); + colors88.set(177, 0xd787ff); + colors88.set(178, 0xd7af00); + colors88.set(179, 0xd7af5f); + colors88.set(180, 0xd7af87); + colors88.set(181, 0xd7afaf); + colors88.set(182, 0xd7afd7); + colors88.set(183, 0xd7afff); + colors88.set(184, 0xd7d700); + colors88.set(185, 0xd7d75f); + colors88.set(186, 0xd7d787); + colors88.set(187, 0xd7d7af); + colors88.set(188, 0xd7d7d7); + colors88.set(189, 0xd7d7ff); + colors88.set(190, 0xd7ff00); + colors88.set(191, 0xd7ff5f); + colors88.set(192, 0xd7ff87); + colors88.set(193, 0xd7ffaf); + colors88.set(194, 0xd7ffd7); + colors88.set(195, 0xd7ffff); + colors88.set(196, 0xff0000); + colors88.set(197, 0xff005f); + colors88.set(198, 0xff0087); + colors88.set(199, 0xff00af); + colors88.set(200, 0xff00d7); + colors88.set(201, 0xff00ff); + colors88.set(202, 0xff5f00); + colors88.set(203, 0xff5f5f); + colors88.set(204, 0xff5f87); + colors88.set(205, 0xff5faf); + colors88.set(206, 0xff5fd7); + colors88.set(207, 0xff5fff); + colors88.set(208, 0xff8700); + colors88.set(209, 0xff875f); + colors88.set(210, 0xff8787); + colors88.set(211, 0xff87af); + colors88.set(212, 0xff87d7); + colors88.set(213, 0xff87ff); + colors88.set(214, 0xffaf00); + colors88.set(215, 0xffaf5f); + colors88.set(216, 0xffaf87); + colors88.set(217, 0xffafaf); + colors88.set(218, 0xffafd7); + colors88.set(219, 0xffafff); + colors88.set(220, 0xffd700); + colors88.set(221, 0xffd75f); + colors88.set(222, 0xffd787); + colors88.set(223, 0xffd7af); + colors88.set(224, 0xffd7d7); + colors88.set(225, 0xffd7ff); + colors88.set(226, 0xffff00); + colors88.set(227, 0xffff5f); + colors88.set(228, 0xffff87); + colors88.set(229, 0xffffaf); + colors88.set(230, 0xffffd7); + colors88.set(231, 0xffffff); + colors88.set(232, 0x080808); + colors88.set(233, 0x121212); + colors88.set(234, 0x1c1c1c); + colors88.set(235, 0x262626); + colors88.set(236, 0x303030); + colors88.set(237, 0x3a3a3a); + colors88.set(238, 0x444444); + colors88.set(239, 0x4e4e4e); + colors88.set(240, 0x585858); + colors88.set(241, 0x626262); + colors88.set(242, 0x6c6c6c); + colors88.set(243, 0x767676); + colors88.set(244, 0x808080); + colors88.set(245, 0x8a8a8a); + colors88.set(246, 0x949494); + colors88.set(247, 0x9e9e9e); + colors88.set(248, 0xa8a8a8); + colors88.set(249, 0xb2b2b2); + colors88.set(250, 0xbcbcbc); + colors88.set(251, 0xc6c6c6); + colors88.set(252, 0xd0d0d0); + colors88.set(253, 0xdadada); + colors88.set(254, 0xe4e4e4); + colors88.set(255, 0xeeeeee); + + } + + /** + * Get the RGB value of one of the indexed colors. + * + * @param index the color index + * @return the RGB value + */ + private int get88Color(final int index) { + // System.err.print("get88Color: " + index); + if ((index < 0) || (index > colors88.size())) { + // System.err.println(" -- UNKNOWN"); + return 0; + } + // System.err.printf(" %08x\n", colors88.get(index)); + return colors88.get(index); + } + + /** + * Set one of the indexed colors to a color specification. + * + * @param index the color index + * @param spec the specification, typically something like "rgb:aa/bb/cc" + */ + private void set88Color(final int index, final String spec) { + // System.err.println("set88Color: " + index + " '" + spec + "'"); + + if ((index < 0) || (index > colors88.size())) { + return; + } + if (spec.startsWith("rgb:")) { + String [] rgbTokens = spec.substring(4).split("/"); + if (rgbTokens.length == 3) { + try { + int rgb = (Integer.parseInt(rgbTokens[0], 16) << 16); + rgb |= Integer.parseInt(rgbTokens[1], 16) << 8; + rgb |= Integer.parseInt(rgbTokens[2], 16); + // System.err.printf(" set to %08x\n", rgb); + colors88.set(index, rgb); + } catch (NumberFormatException e) { + // SQUASH + } + } + return; + } + + if (spec.toLowerCase().equals("black")) { + colors88.set(index, 0x00000000); + } else if (spec.toLowerCase().equals("red")) { + colors88.set(index, 0x00a80000); + } else if (spec.toLowerCase().equals("green")) { + colors88.set(index, 0x0000a800); + } else if (spec.toLowerCase().equals("yellow")) { + colors88.set(index, 0x00a85400); + } else if (spec.toLowerCase().equals("blue")) { + colors88.set(index, 0x000000a8); + } else if (spec.toLowerCase().equals("magenta")) { + colors88.set(index, 0x00a800a8); + } else if (spec.toLowerCase().equals("cyan")) { + colors88.set(index, 0x0000a8a8); + } else if (spec.toLowerCase().equals("white")) { + colors88.set(index, 0x00a8a8a8); + } + + } + + /** + * Reset the emulation state. + */ + private void reset() { + + currentState = new SaveableState(); + savedState = new SaveableState(); + scanState = ScanState.GROUND; + if (displayListener != null) { + width = displayListener.getDisplayWidth(); + height = displayListener.getDisplayHeight(); + } else { + width = 80; + height = 24; + } + scrollRegionTop = 0; + scrollRegionBottom = height - 1; + rightMargin = width - 1; + newLineMode = false; + arrowKeyMode = ArrowKeyMode.ANSI; + keypadMode = KeypadMode.Numeric; + wrapLineFlag = false; // Flags shiftOut = false; @@ -928,63 +1707,22 @@ public class ECMA48 implements Runnable { // Tab stops resetTabStops(); + // Reset extra colors + resetColors(); + // Clear CSI stuff toGround(); } /** - * Public constructor. - * - * @param type one of the DeviceType constants to select VT100, VT102, - * VT220, or XTERM - * @param inputStream an InputStream connected to the remote side. For - * type == XTERM, inputStream is converted to a Reader with UTF-8 - * encoding. - * @param outputStream an OutputStream connected to the remote user. For - * type == XTERM, outputStream is converted to a Writer with UTF-8 - * encoding. - * @param displayListener a callback to the outer display, or null for - * default VT100 behavior - * @throws UnsupportedEncodingException if an exception is thrown when - * creating the InputStreamReader + * Append a to the scrollback buffer, clearing image data for lines more + * than three screenfuls in. */ - public ECMA48(final DeviceType type, final InputStream inputStream, - final OutputStream outputStream, final DisplayListener displayListener) - throws UnsupportedEncodingException { - - assert (inputStream != null); - assert (outputStream != null); - - csiParams = new ArrayList(); - tabStops = new ArrayList(); - scrollback = new LinkedList(); - display = new LinkedList(); - - this.type = type; - if (inputStream instanceof TimeoutInputStream) { - this.inputStream = (TimeoutInputStream)inputStream; - } else { - this.inputStream = new TimeoutInputStream(inputStream, 2000); - } - if (type == DeviceType.XTERM) { - this.input = new InputStreamReader(this.inputStream, "UTF-8"); - this.output = new OutputStreamWriter(new - BufferedOutputStream(outputStream), "UTF-8"); - this.outputStream = null; - } else { - this.output = null; - this.outputStream = new BufferedOutputStream(outputStream); - } - this.displayListener = displayListener; - - reset(); - for (int i = 0; i < height; i++) { - display.add(new DisplayLine(currentState.attr)); + private void appendScrollbackLine(DisplayLine line) { + scrollback.add(line); + if (scrollback.size() > height * 3) { + scrollback.get(scrollback.size() - (height * 3)).clearImages(); } - - // Spin up the input reader - readerThread = new Thread(this); - readerThread.start(); } /** @@ -993,8 +1731,13 @@ public class ECMA48 implements Runnable { */ private void newDisplayLine() { // Scroll the top line off into the scrollback buffer - scrollback.add(display.get(0)); + appendScrollbackLine(display.get(0)); + while (scrollback.size() > scrollbackMax) { + scrollback.remove(0); + scrollback.trimToSize(); + } display.remove(0); + display.trimToSize(); DisplayLine line = new DisplayLine(currentState.attr); line.setReverseColor(reverseVideo); display.add(line); @@ -1034,7 +1777,6 @@ public class ECMA48 implements Runnable { * Handle a linefeed. */ private void linefeed() { - if (currentState.cursorY < scrollRegionBottom) { // Increment screen y currentState.cursorY++; @@ -1074,9 +1816,38 @@ public class ECMA48 implements Runnable { * * @param ch character to display */ - private void printCharacter(final char ch) { + private void printCharacter(final int ch) { int rightMargin = this.rightMargin; + if (StringUtils.width(ch) == 2) { + // This is a full-width character. Save two spaces, and then + // draw the character as two image halves. + int x0 = currentState.cursorX; + int y0 = currentState.cursorY; + printCharacter(' '); + printCharacter(' '); + if ((currentState.cursorX == x0 + 2) + && (currentState.cursorY == y0) + ) { + // We can draw both halves of the character. + drawHalves(x0, y0, x0 + 1, y0, ch); + } else if ((currentState.cursorX == x0 + 1) + && (currentState.cursorY == y0) + ) { + // VT100 line wrap behavior: we should be at the right + // margin. We can draw both halves of the character. + drawHalves(x0, y0, x0 + 1, y0, ch); + } else { + // The character splits across the line. Draw the entire + // character on the new line, giving one more space for it. + x0 = currentState.cursorX - 1; + y0 = currentState.cursorY; + printCharacter(' '); + drawHalves(x0, y0, x0 + 1, y0, ch); + } + return; + } + // Check if we have double-width, and if so chop at 40/66 instead of // 80/132 if (display.get(currentState.cursorY).isDoubleWidth()) { @@ -1127,19 +1898,22 @@ public class ECMA48 implements Runnable { CellAttributes newCellAttributes = (CellAttributes) newCell; newCellAttributes.setTo(currentState.attr); DisplayLine line = display.get(currentState.cursorY); - // Insert mode special case - if (insertMode == true) { - line.insert(currentState.cursorX, newCell); - } else { - // Replace an existing character - line.replace(currentState.cursorX, newCell); - } - // Increment horizontal - if (wrapLineFlag == false) { - currentState.cursorX++; - if (currentState.cursorX > rightMargin) { - currentState.cursorX--; + if (StringUtils.width(ch) == 1) { + // Insert mode special case + if (insertMode == true) { + line.insert(currentState.cursorX, newCell); + } else { + // Replace an existing character + line.replace(currentState.cursorX, newCell); + } + + // Increment horizontal + if (wrapLineFlag == false) { + currentState.cursorX++; + if (currentState.cursorX > rightMargin) { + currentState.cursorX--; + } } } } @@ -1150,7 +1924,7 @@ public class ECMA48 implements Runnable { * * @param mouse mouse event received from the local user */ - public void mouse(final TMouseEvent mouse) { + private void mouse(final TMouseEvent mouse) { /* System.err.printf("mouse(): protocol %s encoding %s mouse %s\n", @@ -1213,35 +1987,45 @@ public class ECMA48 implements Runnable { if (mouseEncoding == MouseEncoding.SGR) { sb.append((char) 0x1B); sb.append("[<"); + int buttons = 0; if (mouse.isMouse1()) { if (mouse.getType() == TMouseEvent.Type.MOUSE_MOTION) { - sb.append("32;"); + buttons = 32; } else { - sb.append("0;"); + buttons = 0; } } else if (mouse.isMouse2()) { if (mouse.getType() == TMouseEvent.Type.MOUSE_MOTION) { - sb.append("33;"); + buttons = 33; } else { - sb.append("1;"); + buttons = 1; } } else if (mouse.isMouse3()) { if (mouse.getType() == TMouseEvent.Type.MOUSE_MOTION) { - sb.append("34;"); + buttons = 34; } else { - sb.append("2;"); + buttons = 2; } } else if (mouse.isMouseWheelUp()) { - sb.append("64;"); + buttons = 64; } else if (mouse.isMouseWheelDown()) { - sb.append("65;"); + buttons = 65; } else { // This is motion with no buttons down. - sb.append("35;"); + buttons = 35; + } + if (mouse.isAlt()) { + buttons |= 0x08; + } + if (mouse.isCtrl()) { + buttons |= 0x10; + } + if (mouse.isShift()) { + buttons |= 0x04; } - sb.append(String.format("%d;%d", mouse.getX() + 1, + sb.append(String.format("%d;%d;%d", buttons, mouse.getX() + 1, mouse.getY() + 1)); if (mouse.getType() == TMouseEvent.Type.MOUSE_UP) { @@ -1255,35 +2039,46 @@ public class ECMA48 implements Runnable { sb.append((char) 0x1B); sb.append('['); sb.append('M'); + int buttons = 0; if (mouse.getType() == TMouseEvent.Type.MOUSE_UP) { - sb.append((char) (0x03 + 32)); + buttons = 0x03 + 32; } else if (mouse.isMouse1()) { if (mouse.getType() == TMouseEvent.Type.MOUSE_MOTION) { - sb.append((char) (0x00 + 32 + 32)); + buttons = 0x00 + 32 + 32; } else { - sb.append((char) (0x00 + 32)); + buttons = 0x00 + 32; } } else if (mouse.isMouse2()) { if (mouse.getType() == TMouseEvent.Type.MOUSE_MOTION) { - sb.append((char) (0x01 + 32 + 32)); + buttons = 0x01 + 32 + 32; } else { - sb.append((char) (0x01 + 32)); + buttons = 0x01 + 32; } } else if (mouse.isMouse3()) { if (mouse.getType() == TMouseEvent.Type.MOUSE_MOTION) { - sb.append((char) (0x02 + 32 + 32)); + buttons = 0x02 + 32 + 32; } else { - sb.append((char) (0x02 + 32)); + buttons = 0x02 + 32; } } else if (mouse.isMouseWheelUp()) { - sb.append((char) (0x04 + 64)); + buttons = 0x04 + 64; } else if (mouse.isMouseWheelDown()) { - sb.append((char) (0x05 + 64)); + buttons = 0x05 + 64; } else { // This is motion with no buttons down. - sb.append((char) (0x03 + 32)); + buttons = 0x03 + 32; + } + if (mouse.isAlt()) { + buttons |= 0x08; + } + if (mouse.isCtrl()) { + buttons |= 0x10; + } + if (mouse.isShift()) { + buttons |= 0x04; } + sb.append((char) (buttons & 0xFF)); sb.append((char) (mouse.getX() + 33)); sb.append((char) (mouse.getY() + 33)); } @@ -1298,7 +2093,7 @@ public class ECMA48 implements Runnable { * * @param keypress keypress received from the local user */ - public void keypress(final TKeypress keypress) { + private void keypress(final TKeypress keypress) { writeRemote(keypressToString(keypress)); } @@ -1348,6 +2143,7 @@ public class ECMA48 implements Runnable { * @param keypress keypress received from the local user * @return string to transmit to the remote side */ + @SuppressWarnings("fallthrough") private String keypressToString(final TKeypress keypress) { if ((fullDuplex == false) && (!keypress.isFnKey())) { @@ -1356,11 +2152,14 @@ public class ECMA48 implements Runnable { * the remote side. */ if (keypress.getChar() < 0x20) { - handleControlChar(keypress.getChar()); + handleControlChar((char) keypress.getChar()); } else { // Local echo for everything else printCharacter(keypress.getChar()); } + if (displayListener != null) { + displayListener.displayChanged(); + } } if ((newLineMode == true) && (keypress.equals(kbEnter))) { @@ -1371,21 +2170,21 @@ public class ECMA48 implements Runnable { // Handle control characters if ((keypress.isCtrl()) && (!keypress.isFnKey())) { StringBuilder sb = new StringBuilder(); - char ch = keypress.getChar(); + int ch = keypress.getChar(); ch -= 0x40; - sb.append(ch); + sb.append(Character.toChars(ch)); return sb.toString(); } // Handle alt characters if ((keypress.isAlt()) && (!keypress.isFnKey())) { StringBuilder sb = new StringBuilder("\033"); - char ch = keypress.getChar(); - sb.append(ch); + int ch = keypress.getChar(); + sb.append(Character.toChars(ch)); return sb.toString(); } - if (keypress.equals(kbBackspace)) { + if (keypress.equals(kbBackspaceDel)) { switch (type) { case VT100: return "\010"; @@ -1933,7 +2732,7 @@ public class ECMA48 implements Runnable { // Non-alt, non-ctrl characters if (!keypress.isFnKey()) { StringBuilder sb = new StringBuilder(); - sb.append(keypress.getChar()); + sb.append(Character.toChars(keypress.getChar())); return sb.toString(); } return ""; @@ -1948,7 +2747,7 @@ public class ECMA48 implements Runnable { * @param charsetGr character set defined for GR * @return character to display on the screen */ - private char mapCharacterCharset(final char ch, + private char mapCharacterCharset(final int ch, final CharacterSet charsetGl, final CharacterSet charsetGr) { @@ -2026,7 +2825,7 @@ public class ECMA48 implements Runnable { * @param ch either 8-bit or Unicode character from the remote side * @return character to display on the screen */ - private char mapCharacter(final char ch) { + private int mapCharacter(final int ch) { if (ch >= 0x100) { // Unicode character, just return it return ch; @@ -2086,13 +2885,13 @@ public class ECMA48 implements Runnable { switch (currentState.glLockshift) { case G1_GR: - assert (false); + throw new IllegalArgumentException("programming bug"); case G2_GR: - assert (false); + throw new IllegalArgumentException("programming bug"); case G3_GR: - assert (false); + throw new IllegalArgumentException("programming bug"); case G2_GL: // LS2 @@ -2113,10 +2912,10 @@ public class ECMA48 implements Runnable { switch (currentState.grLockshift) { case G2_GL: - assert (false); + throw new IllegalArgumentException("programming bug"); case G3_GL: - assert (false); + throw new IllegalArgumentException("programming bug"); case G1_GR: // LS1R @@ -2175,7 +2974,7 @@ public class ECMA48 implements Runnable { display.size()); List displayMiddle = display.subList(regionBottom + 1 - remaining, regionBottom + 1); - display = new LinkedList(displayTop); + display = new ArrayList(displayTop); display.addAll(displayMiddle); for (int i = 0; i < n; i++) { DisplayLine line = new DisplayLine(currentState.attr); @@ -2216,7 +3015,7 @@ public class ECMA48 implements Runnable { display.size()); List displayMiddle = display.subList(regionTop, regionTop + remaining); - display = new LinkedList(displayTop); + display = new ArrayList(displayTop); for (int i = 0; i < n; i++) { DisplayLine line = new DisplayLine(currentState.attr); line.setReverseColor(reverseVideo); @@ -2371,7 +3170,7 @@ public class ECMA48 implements Runnable { */ private void param(final byte ch) { if (csiParams.size() == 0) { - csiParams.add(new Integer(0)); + csiParams.add(Integer.valueOf(0)); } Integer x = csiParams.get(csiParams.size() - 1); if ((ch >= '0') && (ch <= '9')) { @@ -2380,8 +3179,8 @@ public class ECMA48 implements Runnable { csiParams.set(csiParams.size() - 1, x); } - if (ch == ';') { - csiParams.add(new Integer(0)); + if ((ch == ';') && (csiParams.size() < 16)) { + csiParams.add(Integer.valueOf(0)); } } @@ -2429,6 +3228,7 @@ public class ECMA48 implements Runnable { */ private void setToggle(final boolean value) { boolean decPrivateModeFlag = false; + for (int i = 0; i < collectBuffer.length(); i++) { if (collectBuffer.charAt(i) == '?') { decPrivateModeFlag = true; @@ -2695,6 +3495,21 @@ public class ECMA48 implements Runnable { break; + case 80: + if (type == DeviceType.XTERM) { + if (decPrivateModeFlag == true) { + if (value == true) { + // Enable sixel scrolling (default). + // Not supported + } else { + // Disable sixel scrolling. + // Not supported + } + } + } + + break; + case 1000: if ((type == DeviceType.XTERM) && (decPrivateModeFlag == true) @@ -2760,6 +3575,22 @@ public class ECMA48 implements Runnable { } break; + case 1070: + if (type == DeviceType.XTERM) { + if (decPrivateModeFlag == true) { + if (value == true) { + // Use private color registers for each sixel + // graphic (default). + sixelPalette = null; + } else { + // Use shared color registers for each sixel + // graphic. + sixelPalette = new HashMap(); + } + } + } + break; + default: break; @@ -3073,8 +3904,7 @@ public class ECMA48 implements Runnable { * DECALN - Screen alignment display. */ private void decaln() { - Cell newCell = new Cell(); - newCell.setChar('E'); + Cell newCell = new Cell('E'); for (DisplayLine line: display) { for (int i = 0; i < line.length(); i++) { line.replace(i, newCell); @@ -3390,8 +4220,87 @@ public class ECMA48 implements Runnable { return; } + int sgrColorMode = -1; + boolean idx88Color = false; + boolean rgbColor = false; + int rgbRed = -1; + int rgbGreen = -1; + for (Integer i: csiParams) { + if ((sgrColorMode == 38) || (sgrColorMode == 48)) { + + assert (type == DeviceType.XTERM); + + if (idx88Color) { + /* + * Indexed color mode, we now have the index number. + */ + if (sgrColorMode == 38) { + currentState.attr.setForeColorRGB(get88Color(i)); + } else { + assert (sgrColorMode == 48); + currentState.attr.setBackColorRGB(get88Color(i)); + } + sgrColorMode = -1; + idx88Color = false; + continue; + } + + if (rgbColor) { + /* + * RGB color mode, we are collecting tokens. + */ + if (rgbRed == -1) { + rgbRed = i & 0xFF; + } else if (rgbGreen == -1) { + rgbGreen = i & 0xFF; + } else { + int rgb = rgbRed << 16; + rgb |= rgbGreen << 8; + rgb |= i & 0xFF; + + // System.err.printf("RGB: %08x\n", rgb); + + if (sgrColorMode == 38) { + currentState.attr.setForeColorRGB(rgb); + } else { + assert (sgrColorMode == 48); + currentState.attr.setBackColorRGB(rgb); + } + rgbRed = -1; + rgbGreen = -1; + sgrColorMode = -1; + rgbColor = false; + } + continue; + } + + switch (i) { + + case 2: + /* + * RGB color mode. + */ + rgbColor = true; + continue; + + case 5: + /* + * Indexed color mode. + */ + idx88Color = true; + continue; + + default: + /* + * This is neither indexed nor RGB color. Bail out. + */ + return; + } + + } // if ((sgrColorMode == 38) || (sgrColorMode == 48)) + switch (i) { case 0: @@ -3429,7 +4338,73 @@ public class ECMA48 implements Runnable { case 8: // Invisible - // TODO + // Not supported + break; + + case 90: + // Set black foreground + currentState.attr.setForeColorRGB(get88Color(8)); + break; + case 91: + // Set red foreground + currentState.attr.setForeColorRGB(get88Color(9)); + break; + case 92: + // Set green foreground + currentState.attr.setForeColorRGB(get88Color(10)); + break; + case 93: + // Set yellow foreground + currentState.attr.setForeColorRGB(get88Color(11)); + break; + case 94: + // Set blue foreground + currentState.attr.setForeColorRGB(get88Color(12)); + break; + case 95: + // Set magenta foreground + currentState.attr.setForeColorRGB(get88Color(13)); + break; + case 96: + // Set cyan foreground + currentState.attr.setForeColorRGB(get88Color(14)); + break; + case 97: + // Set white foreground + currentState.attr.setForeColorRGB(get88Color(15)); + break; + + case 100: + // Set black background + currentState.attr.setBackColorRGB(get88Color(8)); + break; + case 101: + // Set red background + currentState.attr.setBackColorRGB(get88Color(9)); + break; + case 102: + // Set green background + currentState.attr.setBackColorRGB(get88Color(10)); + break; + case 103: + // Set yellow background + currentState.attr.setBackColorRGB(get88Color(11)); + break; + case 104: + // Set blue background + currentState.attr.setBackColorRGB(get88Color(12)); + break; + case 105: + // Set magenta background + currentState.attr.setBackColorRGB(get88Color(13)); + break; + case 106: + // Set cyan background + currentState.attr.setBackColorRGB(get88Color(14)); + break; + case 107: + // Set white background + currentState.attr.setBackColorRGB(get88Color(15)); break; default: @@ -3476,34 +4451,42 @@ public class ECMA48 implements Runnable { case 30: // Set black foreground currentState.attr.setForeColor(Color.BLACK); + currentState.attr.setForeColorRGB(-1); break; case 31: // Set red foreground currentState.attr.setForeColor(Color.RED); + currentState.attr.setForeColorRGB(-1); break; case 32: // Set green foreground currentState.attr.setForeColor(Color.GREEN); + currentState.attr.setForeColorRGB(-1); break; case 33: // Set yellow foreground currentState.attr.setForeColor(Color.YELLOW); + currentState.attr.setForeColorRGB(-1); break; case 34: // Set blue foreground currentState.attr.setForeColor(Color.BLUE); + currentState.attr.setForeColorRGB(-1); break; case 35: // Set magenta foreground currentState.attr.setForeColor(Color.MAGENTA); + currentState.attr.setForeColorRGB(-1); break; case 36: // Set cyan foreground currentState.attr.setForeColor(Color.CYAN); + currentState.attr.setForeColorRGB(-1); break; case 37: // Set white foreground currentState.attr.setForeColor(Color.WHITE); + currentState.attr.setForeColorRGB(-1); break; case 38: if (type == DeviceType.XTERM) { @@ -3513,21 +4496,28 @@ public class ECMA48 implements Runnable { * permits these ISO-8613-3 SGR sequences to be separated * by colons rather than semicolons.) * - * We will not support any of these additional color - * codes at this time: + * We will support only the following: + * + * 1. Indexed color mode (88- or 256-color modes). * - * 1. http://invisible-island.net/ncurses/ncurses.faq.html#xterm_16MegaColors - * has a detailed discussion of the current state of - * RGB in various terminals, the point of which is - * that none of them really do the same thing despite - * all appearing to be "xterm". + * 2. Direct RGB. * - * 2. As seen in - * https://bugs.kde.org/show_bug.cgi?id=107487#c3, - * even supporting just the "indexed mode" of these - * sequences (which could align easily with existing - * SGR colors) is assumed to mean full support of - * 24-bit RGB. So it is all or nothing. + * These cover most of the use cases in the real world. + * + * HOWEVER, note that this is an awful broken "standard", + * with no way to do it "right". See + * http://invisible-island.net/ncurses/ncurses.faq.html#xterm_16MegaColors + * for a detailed discussion of the current state of RGB + * in various terminals, the point of which is that none + * of them really do the same thing despite all appearing + * to be "xterm". + * + * Also see + * https://bugs.kde.org/show_bug.cgi?id=107487#c3 . + * where it is assumed that supporting just the "indexed + * mode" of these sequences (which could align easily + * with existing SGR colors) is assumed to mean full + * support of 24-bit RGB. So it is all or nothing. * * Finally, these sequences break the assumptions of * standard ECMA-48 style parsers as pointed out at @@ -3535,7 +4525,8 @@ public class ECMA48 implements Runnable { * Therefore in order to keep a clean display, we cannot * parse anything else in this sequence. */ - return; + sgrColorMode = 38; + continue; } else { // Underscore on, default foreground color currentState.attr.setUnderline(true); @@ -3546,38 +4537,47 @@ public class ECMA48 implements Runnable { // Underscore off, default foreground color currentState.attr.setUnderline(false); currentState.attr.setForeColor(Color.WHITE); + currentState.attr.setForeColorRGB(-1); break; case 40: // Set black background currentState.attr.setBackColor(Color.BLACK); + currentState.attr.setBackColorRGB(-1); break; case 41: // Set red background currentState.attr.setBackColor(Color.RED); + currentState.attr.setBackColorRGB(-1); break; case 42: // Set green background currentState.attr.setBackColor(Color.GREEN); + currentState.attr.setBackColorRGB(-1); break; case 43: // Set yellow background currentState.attr.setBackColor(Color.YELLOW); + currentState.attr.setBackColorRGB(-1); break; case 44: // Set blue background currentState.attr.setBackColor(Color.BLUE); + currentState.attr.setBackColorRGB(-1); break; case 45: // Set magenta background currentState.attr.setBackColor(Color.MAGENTA); + currentState.attr.setBackColorRGB(-1); break; case 46: // Set cyan background currentState.attr.setBackColor(Color.CYAN); + currentState.attr.setBackColorRGB(-1); break; case 47: // Set white background currentState.attr.setBackColor(Color.WHITE); + currentState.attr.setBackColorRGB(-1); break; case 48: if (type == DeviceType.XTERM) { @@ -3587,16 +4587,43 @@ public class ECMA48 implements Runnable { * permits these ISO-8613-3 SGR sequences to be separated * by colons rather than semicolons.) * - * We will not support this at this time. Also, in order - * to keep a clean display, we cannot parse anything else - * in this sequence. + * We will support only the following: + * + * 1. Indexed color mode (88- or 256-color modes). + * + * 2. Direct RGB. + * + * These cover most of the use cases in the real world. + * + * HOWEVER, note that this is an awful broken "standard", + * with no way to do it "right". See + * http://invisible-island.net/ncurses/ncurses.faq.html#xterm_16MegaColors + * for a detailed discussion of the current state of RGB + * in various terminals, the point of which is that none + * of them really do the same thing despite all appearing + * to be "xterm". + * + * Also see + * https://bugs.kde.org/show_bug.cgi?id=107487#c3 . + * where it is assumed that supporting just the "indexed + * mode" of these sequences (which could align easily + * with existing SGR colors) is assumed to mean full + * support of 24-bit RGB. So it is all or nothing. + * + * Finally, these sequences break the assumptions of + * standard ECMA-48 style parsers as pointed out at + * https://bugs.kde.org/show_bug.cgi?id=107487#c11 . + * Therefore in order to keep a clean display, we cannot + * parse anything else in this sequence. */ - return; + sgrColorMode = 48; + continue; } break; case 49: // Default background currentState.attr.setBackColor(Color.BLACK); + currentState.attr.setBackColorRGB(-1); break; default: @@ -3616,12 +4643,12 @@ public class ECMA48 implements Runnable { if (collectBuffer.charAt(0) == '>') { extendedFlag = 1; if (collectBuffer.length() >= 2) { - i = Integer.parseInt(args.toString()); + i = Integer.parseInt(args); } } else if (collectBuffer.charAt(0) == '=') { extendedFlag = 2; if (collectBuffer.length() >= 2) { - i = Integer.parseInt(args.toString()); + i = Integer.parseInt(args); } } else { // Unknown code, bail out @@ -3696,6 +4723,9 @@ public class ECMA48 implements Runnable { // DECSTBM int top = getCsiParam(0, 1, 1, height) - 1; int bottom = getCsiParam(1, height, 1, height) - 1; + if (bottom > height - 1) { + bottom = height - 1; + } if (top > bottom) { top = bottom; @@ -4047,14 +5077,32 @@ public class ECMA48 implements Runnable { * @param xtermChar the character received from the remote side */ private void oscPut(final char xtermChar) { + // System.err.println("oscPut: " + xtermChar); + + boolean oscEnd = false; + + if (xtermChar == 0x07) { + oscEnd = true; + } + if ((xtermChar == '\\') + && (collectBuffer.charAt(collectBuffer.length() - 1) == '\033') + ) { + oscEnd = true; + } + // Collect first collectBuffer.append(xtermChar); // Xterm cases... - if (xtermChar == 0x07) { - String args = collectBuffer.substring(0, - collectBuffer.length() - 1); - String [] p = args.toString().split(";"); + if (oscEnd) { + String args = null; + if (xtermChar == 0x07) { + args = collectBuffer.substring(0, collectBuffer.length() - 1); + } else { + args = collectBuffer.substring(0, collectBuffer.length() - 2); + } + + String [] p = args.split(";"); if (p.length > 0) { if ((p[0].equals("0")) || (p[0].equals("2"))) { if (p.length > 1) { @@ -4062,6 +5110,56 @@ public class ECMA48 implements Runnable { screenTitle = p[1]; } } + + if (p[0].equals("4")) { + for (int i = 1; i + 1 < p.length; i += 2) { + // Set a color index value + try { + set88Color(Integer.parseInt(p[i]), p[i + 1]); + } catch (NumberFormatException e) { + // SQUASH + } + } + } + + if (p[0].equals("10")) { + if (p[1].equals("?")) { + // Respond with foreground color. + java.awt.Color color = jexer.backend.SwingTerminal.attrToForegroundColor(currentState.attr); + + writeRemote(String.format( + "\033]10;rgb:%04x/%04x/%04x\033\\", + color.getRed() << 8, + color.getGreen() << 8, + color.getBlue() << 8)); + } + } + + if (p[0].equals("11")) { + if (p[1].equals("?")) { + // Respond with background color. + java.awt.Color color = jexer.backend.SwingTerminal.attrToBackgroundColor(currentState.attr); + + writeRemote(String.format( + "\033]11;rgb:%04x/%04x/%04x\033\\", + color.getRed() << 8, + color.getGreen() << 8, + color.getBlue() << 8)); + } + } + + if (p[0].equals("444")) { + if (p[1].equals("0") && (p.length == 6)) { + // Jexer image - RGB + parseJexerImageRGB(p[2], p[3], p[4], p[5]); + } else if (p[1].equals("1") && (p.length == 4)) { + // Jexer image - PNG + parseJexerImageFile(1, p[2], p[3]); + } else if (p[1].equals("2") && (p.length == 4)) { + // Jexer image - JPG + parseJexerImageFile(2, p[2], p[3]); + } + } } // Go to SCAN_GROUND state @@ -4071,19 +5169,118 @@ public class ECMA48 implements Runnable { } /** - * Run this input character through the ECMA48 state machine. + * Handle the SCAN_SOSPMAPC_STRING state. This is currently only used by + * Jexer ECMA48Terminal to talk to ECMA48. * - * @param ch character from the remote side + * @param pmChar the character received from the remote side */ - private void consume(char ch) { + private void pmPut(final char pmChar) { + // System.err.println("pmPut: " + pmChar); - // DEBUG - // System.err.printf("%c", ch); + boolean pmEnd = false; + + if ((pmChar == '\\') + && (collectBuffer.charAt(collectBuffer.length() - 1) == '\033') + ) { + pmEnd = true; + } + + // Collect first + collectBuffer.append(pmChar); + + // Xterm cases... + if (pmEnd) { + String arg = null; + arg = collectBuffer.substring(0, collectBuffer.length() - 2); + + // System.err.println("arg: '" + arg + "'"); + + if (arg.equals("hideMousePointer")) { + hideMousePointer = true; + } + if (arg.equals("showMousePointer")) { + hideMousePointer = false; + } + + // Go to SCAN_GROUND state + toGround(); + return; + } + } + + /** + * Perform xterm window operations. + */ + private void xtermWindowOps() { + boolean xtermPrivateModeFlag = false; + + for (int i = 0; i < collectBuffer.length(); i++) { + if (collectBuffer.charAt(i) == '?') { + xtermPrivateModeFlag = true; + break; + } + } + + int i = getCsiParam(0, 0); + + if (!xtermPrivateModeFlag) { + switch (i) { + case 14: + // Report xterm text area size in pixels as CSI 4 ; height ; + // width t + writeRemote(String.format("\033[4;%d;%dt", textHeight * height, + textWidth * width)); + break; + case 16: + // Report character size in pixels as CSI 6 ; height ; width + // t + writeRemote(String.format("\033[6;%d;%dt", textHeight, + textWidth)); + break; + case 18: + // Report the text are size in characters as CSI 8 ; height ; + // width t + writeRemote(String.format("\033[8;%d;%dt", height, width)); + break; + default: + break; + } + } + } + + /** + * Respond to xterm sixel query. + */ + private void xtermSixelQuery() { + int item = getCsiParam(0, 0); + int action = getCsiParam(1, 0); + int value = getCsiParam(2, 0); - // Special case for VT10x: 7-bit characters only - if ((type == DeviceType.VT100) || (type == DeviceType.VT102)) { - ch = (char)(ch & 0x7F); + switch (item) { + case 1: + if (action == 1) { + // Report number of color registers. + writeRemote(String.format("\033[?%d;%d;%dS", item, 0, 1024)); + return; + } + break; + default: + break; } + // We will not support this option. + writeRemote(String.format("\033[?%d;%dS", item, action)); + } + + /** + * Run this input character through the ECMA48 state machine. + * + * @param ch character from the remote side + */ + private void consume(final int ch) { + readCount++; + + // DEBUG + // System.err.printf("%c STATE = %s\n", ch, scanState); // Special "anywhere" states @@ -4097,16 +5294,24 @@ public class ECMA48 implements Runnable { // 80-8F, 91-97, 99, 9A, 9C --> execute, then switch to SCAN_GROUND // 0x1B == ESCAPE - if ((ch == 0x1B) - && (scanState != ScanState.DCS_ENTRY) - && (scanState != ScanState.DCS_INTERMEDIATE) - && (scanState != ScanState.DCS_IGNORE) - && (scanState != ScanState.DCS_PARAM) - && (scanState != ScanState.DCS_PASSTHROUGH) - ) { - - scanState = ScanState.ESCAPE; - return; + if (ch == 0x1B) { + if ((type == DeviceType.XTERM) + && ((scanState == ScanState.OSC_STRING) + || (scanState == ScanState.DCS_SIXEL) + || (scanState == ScanState.SOSPMAPC_STRING)) + ) { + // Xterm can pass ESCAPE to its OSC sequence. + // Xterm can pass ESCAPE to its DCS sequence. + // Jexer can pass ESCAPE to its PM sequence. + } else if ((scanState != ScanState.DCS_ENTRY) + && (scanState != ScanState.DCS_INTERMEDIATE) + && (scanState != ScanState.DCS_IGNORE) + && (scanState != ScanState.DCS_PARAM) + && (scanState != ScanState.DCS_PASSTHROUGH) + ) { + scanState = ScanState.ESCAPE; + return; + } } // 0x9B == CSI 8-bit sequence @@ -4144,7 +5349,7 @@ public class ECMA48 implements Runnable { // 00-17, 19, 1C-1F --> execute // 80-8F, 91-9A, 9C --> execute if ((ch <= 0x1F) || ((ch >= 0x80) && (ch <= 0x9F))) { - handleControlChar(ch); + handleControlChar((char) ch); } // 20-7F --> print @@ -4171,13 +5376,13 @@ public class ECMA48 implements Runnable { case ESCAPE: // 00-17, 19, 1C-1F --> execute if (ch <= 0x1F) { - handleControlChar(ch); + handleControlChar((char) ch); return; } // 20-2F --> collect, then switch to ESCAPE_INTERMEDIATE if ((ch >= 0x20) && (ch <= 0x2F)) { - collect(ch); + collect((char) ch); scanState = ScanState.ESCAPE_INTERMEDIATE; return; } @@ -4513,12 +5718,12 @@ public class ECMA48 implements Runnable { case ESCAPE_INTERMEDIATE: // 00-17, 19, 1C-1F --> execute if (ch <= 0x1F) { - handleControlChar(ch); + handleControlChar((char) ch); } // 20-2F --> collect if ((ch >= 0x20) && (ch <= 0x2F)) { - collect(ch); + collect((char) ch); } // 30-7E --> dispatch, then switch to GROUND @@ -5120,12 +6325,12 @@ public class ECMA48 implements Runnable { case CSI_ENTRY: // 00-17, 19, 1C-1F --> execute if (ch <= 0x1F) { - handleControlChar(ch); + handleControlChar((char) ch); } // 20-2F --> collect, then switch to CSI_INTERMEDIATE if ((ch >= 0x20) && (ch <= 0x2F)) { - collect(ch); + collect((char) ch); scanState = ScanState.CSI_INTERMEDIATE; } @@ -5141,7 +6346,7 @@ public class ECMA48 implements Runnable { // 3C-3F --> collect, then switch to CSI_PARAM if ((ch >= 0x3C) && (ch <= 0x3F)) { - collect(ch); + collect((char) ch); scanState = ScanState.CSI_PARAM; } @@ -5225,7 +6430,18 @@ public class ECMA48 implements Runnable { case 'S': // Scroll up X lines (default 1) if (type == DeviceType.XTERM) { - su(); + boolean xtermPrivateModeFlag = false; + for (int i = 0; i < collectBuffer.length(); i++) { + if (collectBuffer.charAt(i) == '?') { + xtermPrivateModeFlag = true; + break; + } + } + if (xtermPrivateModeFlag) { + xtermSixelQuery(); + } else { + su(); + } } break; case 'T': @@ -5348,6 +6564,10 @@ public class ECMA48 implements Runnable { } break; case 't': + if (type == DeviceType.XTERM) { + // Window operations + xtermWindowOps(); + } break; case 'u': // Restore cursor (ANSI.SYS) @@ -5389,12 +6609,12 @@ public class ECMA48 implements Runnable { case CSI_PARAM: // 00-17, 19, 1C-1F --> execute if (ch <= 0x1F) { - handleControlChar(ch); + handleControlChar((char) ch); } // 20-2F --> collect, then switch to CSI_INTERMEDIATE if ((ch >= 0x20) && (ch <= 0x2F)) { - collect(ch); + collect((char) ch); scanState = ScanState.CSI_INTERMEDIATE; } @@ -5495,7 +6715,18 @@ public class ECMA48 implements Runnable { case 'S': // Scroll up X lines (default 1) if (type == DeviceType.XTERM) { - su(); + boolean xtermPrivateModeFlag = false; + for (int i = 0; i < collectBuffer.length(); i++) { + if (collectBuffer.charAt(i) == '?') { + xtermPrivateModeFlag = true; + break; + } + } + if (xtermPrivateModeFlag) { + xtermSixelQuery(); + } else { + su(); + } } break; case 'T': @@ -5611,7 +6842,13 @@ public class ECMA48 implements Runnable { decstbm(); break; case 's': + break; case 't': + if (type == DeviceType.XTERM) { + // Window operations + xtermWindowOps(); + } + break; case 'u': case 'v': case 'w': @@ -5637,12 +6874,12 @@ public class ECMA48 implements Runnable { case CSI_INTERMEDIATE: // 00-17, 19, 1C-1F --> execute if (ch <= 0x1F) { - handleControlChar(ch); + handleControlChar((char) ch); } // 20-2F --> collect if ((ch >= 0x20) && (ch <= 0x2F)) { - collect(ch); + collect((char) ch); } // 0x30-3F goes to CSI_IGNORE @@ -5750,12 +6987,12 @@ public class ECMA48 implements Runnable { case CSI_IGNORE: // 00-17, 19, 1C-1F --> execute if (ch <= 0x1F) { - handleControlChar(ch); + handleControlChar((char) ch); } // 20-2F --> collect if ((ch >= 0x20) && (ch <= 0x2F)) { - collect(ch); + collect((char) ch); } // 40-7E --> ignore, then switch to GROUND @@ -5776,7 +7013,7 @@ public class ECMA48 implements Runnable { // 0x1B 0x5C goes to GROUND if (ch == 0x1B) { - collect(ch); + collect((char) ch); } if (ch == 0x5C) { if ((collectBuffer.length() > 0) @@ -5788,7 +7025,7 @@ public class ECMA48 implements Runnable { // 20-2F --> collect, then switch to DCS_INTERMEDIATE if ((ch >= 0x20) && (ch <= 0x2F)) { - collect(ch); + collect((char) ch); scanState = ScanState.DCS_INTERMEDIATE; } @@ -5804,7 +7041,7 @@ public class ECMA48 implements Runnable { // 3C-3F --> collect, then switch to DCS_PARAM if ((ch >= 0x3C) && (ch <= 0x3F)) { - collect(ch); + collect((char) ch); scanState = ScanState.DCS_PARAM; } @@ -5815,8 +7052,12 @@ public class ECMA48 implements Runnable { scanState = ScanState.DCS_IGNORE; } - // 0x40-7E goes to DCS_PASSTHROUGH - if ((ch >= 0x40) && (ch <= 0x7E)) { + // 0x71 goes to DCS_SIXEL + if (ch == 0x71) { + sixelParseBuffer.setLength(0); + scanState = ScanState.DCS_SIXEL; + } else if ((ch >= 0x40) && (ch <= 0x7E)) { + // 0x40-7E goes to DCS_PASSTHROUGH scanState = ScanState.DCS_PASSTHROUGH; } return; @@ -5830,7 +7071,7 @@ public class ECMA48 implements Runnable { // 0x1B 0x5C goes to GROUND if (ch == 0x1B) { - collect(ch); + collect((char) ch); } if (ch == 0x5C) { if ((collectBuffer.length() > 0) @@ -5862,7 +7103,7 @@ public class ECMA48 implements Runnable { // 0x1B 0x5C goes to GROUND if (ch == 0x1B) { - collect(ch); + collect((char) ch); } if (ch == 0x5C) { if ((collectBuffer.length() > 0) @@ -5874,7 +7115,7 @@ public class ECMA48 implements Runnable { // 20-2F --> collect, then switch to DCS_INTERMEDIATE if ((ch >= 0x20) && (ch <= 0x2F)) { - collect(ch); + collect((char) ch); scanState = ScanState.DCS_INTERMEDIATE; } @@ -5896,8 +7137,12 @@ public class ECMA48 implements Runnable { scanState = ScanState.DCS_IGNORE; } - // 0x40-7E goes to DCS_PASSTHROUGH - if ((ch >= 0x40) && (ch <= 0x7E)) { + // 0x71 goes to DCS_SIXEL + if (ch == 0x71) { + sixelParseBuffer.setLength(0); + scanState = ScanState.DCS_SIXEL; + } else if ((ch >= 0x40) && (ch <= 0x7E)) { + // 0x40-7E goes to DCS_PASSTHROUGH scanState = ScanState.DCS_PASSTHROUGH; } return; @@ -5910,7 +7155,7 @@ public class ECMA48 implements Runnable { // 0x1B 0x5C goes to GROUND if (ch == 0x1B) { - collect(ch); + collect((char) ch); } if (ch == 0x5C) { if ((collectBuffer.length() > 0) @@ -5921,17 +7166,20 @@ public class ECMA48 implements Runnable { } // 00-17, 19, 1C-1F, 20-7E --> put - // TODO if (ch <= 0x17) { + // We ignore all DCS except sixel. return; } if (ch == 0x19) { + // We ignore all DCS except sixel. return; } if ((ch >= 0x1C) && (ch <= 0x1F)) { + // We ignore all DCS except sixel. return; } if ((ch >= 0x20) && (ch <= 0x7E)) { + // We ignore all DCS except sixel. return; } @@ -5949,9 +7197,53 @@ public class ECMA48 implements Runnable { return; + case DCS_SIXEL: + // 0x9C goes to GROUND + if (ch == 0x9C) { + parseSixel(); + toGround(); + return; + } + + // 0x1B 0x5C goes to GROUND + if (ch == 0x1B) { + collect((char) ch); + return; + } + if (ch == 0x5C) { + if ((collectBuffer.length() > 0) + && (collectBuffer.charAt(collectBuffer.length() - 1) == 0x1B) + ) { + parseSixel(); + toGround(); + return; + } + } + + // 00-17, 19, 1C-1F, 20-7E --> put + if ((ch <= 0x17) + || (ch == 0x19) + || ((ch >= 0x1C) && (ch <= 0x1F)) + || ((ch >= 0x20) && (ch <= 0x7E)) + ) { + sixelParseBuffer.append((char) ch); + } + + // 7F --> ignore + return; + case SOSPMAPC_STRING: // 00-17, 19, 1C-1F, 20-7F --> ignore + // Special case for Jexer: PM can pass one control character + if (ch == 0x1B) { + pmPut((char) ch); + } + + if ((ch >= 0x20) && (ch <= 0x7F)) { + pmPut((char) ch); + } + // 0x9C goes to GROUND if (ch == 0x9C) { toGround(); @@ -5961,15 +7253,15 @@ public class ECMA48 implements Runnable { case OSC_STRING: // Special case for Xterm: OSC can pass control characters - if ((ch == 0x9C) || (ch <= 0x07)) { - oscPut(ch); + if ((ch == 0x9C) || (ch == 0x07) || (ch == 0x1B)) { + oscPut((char) ch); } // 00-17, 19, 1C-1F --> ignore // 20-7F --> osc_put if ((ch >= 0x20) && (ch <= 0x7F)) { - oscPut(ch); + oscPut((char) ch); } // 0x9C goes to GROUND @@ -5982,7 +7274,7 @@ public class ECMA48 implements Runnable { case VT52_DIRECT_CURSOR_ADDRESS: // This is a special case for the VT52 sequence "ESC Y l c" if (collectBuffer.length() == 0) { - collect(ch); + collect((char) ch); } else if (collectBuffer.length() == 1) { // We've got the two characters, one in the buffer and the // other in ch. @@ -6016,122 +7308,368 @@ public class ECMA48 implements Runnable { } /** - * Read function runs on a separate thread. + * Returns true if this terminal has requested the mouse pointer be + * hidden. + * + * @return true if this terminal has requested the mouse pointer be + * hidden */ - public final void run() { - boolean utf8 = false; - boolean done = false; + public final boolean hasHiddenMousePointer() { + return hideMousePointer; + } - if (type == DeviceType.XTERM) { - utf8 = true; + /** + * Get the mouse protocol. + * + * @return MouseProtocol.OFF, MouseProtocol.X10, etc. + */ + public MouseProtocol getMouseProtocol() { + return mouseProtocol; + } + + /** + * Draw the left and right cells of a two-cell-wide (full-width) glyph. + * + * @param leftX the x position to draw the left half to + * @param leftY the y position to draw the left half to + * @param rightX the x position to draw the right half to + * @param rightY the y position to draw the right half to + * @param ch the character to draw + */ + private void drawHalves(final int leftX, final int leftY, + final int rightX, final int rightY, final int ch) { + + // System.err.println("drawHalves(): " + Integer.toHexString(ch)); + + if (lastTextHeight != textHeight) { + glyphMaker = GlyphMaker.getInstance(textHeight); + lastTextHeight = textHeight; + } + + Cell cell = new Cell(ch, currentState.attr); + BufferedImage image = glyphMaker.getImage(cell, textWidth * 2, + textHeight); + BufferedImage leftImage = image.getSubimage(0, 0, textWidth, + textHeight); + BufferedImage rightImage = image.getSubimage(textWidth, 0, textWidth, + textHeight); + + Cell left = new Cell(cell); + left.setImage(leftImage); + left.setWidth(Cell.Width.LEFT); + display.get(leftY).replace(leftX, left); + + Cell right = new Cell(cell); + right.setImage(rightImage); + right.setWidth(Cell.Width.RIGHT); + display.get(rightY).replace(rightX, right); + } + + /** + * Set the width of a character cell in pixels. + * + * @param textWidth the width in pixels of a character cell + */ + public void setTextWidth(final int textWidth) { + this.textWidth = textWidth; + } + + /** + * Set the height of a character cell in pixels. + * + * @param textHeight the height in pixels of a character cell + */ + public void setTextHeight(final int textHeight) { + this.textHeight = textHeight; + } + + /** + * Parse a sixel string into a bitmap image, and overlay that image onto + * the text cells. + */ + private void parseSixel() { + + /* + System.err.println("parseSixel(): '" + sixelParseBuffer.toString() + + "'"); + */ + + Sixel sixel = new Sixel(sixelParseBuffer.toString(), sixelPalette); + BufferedImage image = sixel.getImage(); + + // System.err.println("parseSixel(): image " + image); + + if (image == null) { + // Sixel data was malformed in some way, bail out. + return; + } + if ((image.getWidth() < 1) + || (image.getWidth() > 10000) + || (image.getHeight() < 1) + || (image.getHeight() > 10000) + ) { + return; } - // available() will often return > 1, so we need to read in chunks to - // stay caught up. - char [] readBufferUTF8 = null; - byte [] readBuffer = null; - if (utf8) { - readBufferUTF8 = new char[128]; + imageToCells(image, true); + } + + /** + * Parse a "Jexer" RGB image string into a bitmap image, and overlay that + * image onto the text cells. + * + * @param pw width token + * @param ph height token + * @param ps scroll token + * @param data pixel data + */ + private void parseJexerImageRGB(final String pw, final String ph, + final String ps, final String data) { + + int imageWidth = 0; + int imageHeight = 0; + boolean scroll = false; + try { + imageWidth = Integer.parseInt(pw); + imageHeight = Integer.parseInt(ph); + } catch (NumberFormatException e) { + // SQUASH + return; + } + if ((imageWidth < 1) + || (imageWidth > 10000) + || (imageHeight < 1) + || (imageHeight > 10000) + ) { + return; + } + if (ps.equals("1")) { + scroll = true; + } else if (ps.equals("0")) { + scroll = false; } else { - readBuffer = new byte[128]; + return; } - while (!done && !stopReaderThread) { - try { - int n = inputStream.available(); + byte [] bytes = StringUtils.fromBase64(data.getBytes()); + if (bytes.length != (imageWidth * imageHeight * 3)) { + return; + } - // System.err.printf("available() %d\n", n); System.err.flush(); - if (utf8) { - if (readBufferUTF8.length < n) { - // The buffer wasn't big enough, make it huger - int newSizeHalf = Math.max(readBufferUTF8.length, - n); + BufferedImage image = new BufferedImage(imageWidth, imageHeight, + BufferedImage.TYPE_INT_ARGB); - readBufferUTF8 = new char[newSizeHalf * 2]; - } - } else { - if (readBuffer.length < n) { - // The buffer wasn't big enough, make it huger - int newSizeHalf = Math.max(readBuffer.length, n); - readBuffer = new byte[newSizeHalf * 2]; - } + for (int x = 0; x < imageWidth; x++) { + for (int y = 0; y < imageHeight; y++) { + int red = bytes[(y * imageWidth * 3) + (x * 3) ]; + if (red < 0) { + red += 256; } - if (n == 0) { - try { - Thread.sleep(2); - } catch (InterruptedException e) { - // SQUASH - } - continue; + int green = bytes[(y * imageWidth * 3) + (x * 3) + 1]; + if (green < 0) { + green += 256; } - - int rc = -1; - try { - if (utf8) { - rc = input.read(readBufferUTF8, 0, - readBufferUTF8.length); - } else { - rc = inputStream.read(readBuffer, 0, - readBuffer.length); - } - } catch (ReadTimeoutException e) { - rc = 0; + int blue = bytes[(y * imageWidth * 3) + (x * 3) + 2]; + if (blue < 0) { + blue += 256; } + int rgb = 0xFF000000 | (red << 16) | (green << 8) | blue; + image.setRGB(x, y, rgb); + } + } - // System.err.printf("read() %d\n", rc); System.err.flush(); - if (rc == -1) { - // This is EOF - done = true; - } else { - // Don't step on UI events - synchronized (this) { - for (int i = 0; i < rc; i++) { - int ch = 0; - if (utf8) { - ch = readBufferUTF8[i]; - } else { - ch = readBuffer[i]; - } + imageToCells(image, scroll); + } - consume((char)ch); - } - } - // Permit my enclosing UI to know that I updated. - if (displayListener != null) { - displayListener.displayChanged(); - } + /** + * Parse a "Jexer" PNG or JPG image string into a bitmap image, and + * overlay that image onto the text cells. + * + * @param type 1 for PNG, 2 for JPG + * @param ps scroll token + * @param data pixel data + */ + private void parseJexerImageFile(final int type, final String ps, + final String data) { + + int imageWidth = 0; + int imageHeight = 0; + boolean scroll = false; + BufferedImage image = null; + try { + byte [] bytes = StringUtils.fromBase64(data.getBytes()); + + switch (type) { + case 1: + if ((bytes[0] != (byte) 0x89) + || (bytes[1] != 'P') + || (bytes[2] != 'N') + || (bytes[3] != 'G') + || (bytes[4] != (byte) 0x0D) + || (bytes[5] != (byte) 0x0A) + || (bytes[6] != (byte) 0x1A) + || (bytes[7] != (byte) 0x0A) + ) { + // File does not have PNG header, bail out. + return; } - // System.err.println("end while loop"); System.err.flush(); - } catch (IOException e) { - e.printStackTrace(); - done = true; - } + break; - } // while ((done == false) && (stopReaderThread == false)) + case 2: + if ((bytes[0] != (byte) 0XFF) + || (bytes[1] != (byte) 0xD8) + || (bytes[2] != (byte) 0xFF) + ) { + // File does not have JPG header, bail out. + return; + } + break; - // Let the rest of the world know that I am done. - stopReaderThread = true; + default: + // Unsupported type, bail out. + return; + } - try { - inputStream.cancelRead(); - inputStream.close(); - inputStream = null; + image = ImageIO.read(new ByteArrayInputStream(bytes)); } catch (IOException e) { // SQUASH + return; } - try { - input.close(); - input = null; - } catch (IOException e) { - // SQUASH + assert (image != null); + imageWidth = image.getWidth(); + imageHeight = image.getHeight(); + if ((imageWidth < 1) + || (imageWidth > 10000) + || (imageHeight < 1) + || (imageHeight > 10000) + ) { + return; + } + if (ps.equals("1")) { + scroll = true; + } else if (ps.equals("0")) { + scroll = false; + } else { + return; } - // Permit my enclosing UI to know that I updated. - if (displayListener != null) { - displayListener.displayChanged(); + imageToCells(image, scroll); + } + + /** + * Break up an image into the cells at the current cursor. + * + * @param image the image to display + * @param scroll if true, scroll the image and move the cursor + */ + private void imageToCells(final BufferedImage image, final boolean scroll) { + assert (image != null); + + /* + * Procedure: + * + * Break up the image into text cell sized pieces as a new array of + * Cells. + * + * Note original column position x0. + * + * For each cell: + * + * 1. Advance (printCharacter(' ')) for horizontal increment, or + * index (linefeed() + cursorPosition(y, x0)) for vertical + * increment. + * + * 2. Set (x, y) cell image data. + * + * 3. For the right and bottom edges: + * + * a. Render the text to pixels using Terminus font. + * + * b. Blit the image on top of the text, using alpha channel. + */ + int cellColumns = image.getWidth() / textWidth; + if (cellColumns * textWidth < image.getWidth()) { + cellColumns++; + } + int cellRows = image.getHeight() / textHeight; + if (cellRows * textHeight < image.getHeight()) { + cellRows++; + } + + // Break the image up into an array of cells. + Cell [][] cells = new Cell[cellColumns][cellRows]; + + for (int x = 0; x < cellColumns; x++) { + for (int y = 0; y < cellRows; y++) { + + int width = textWidth; + if ((x + 1) * textWidth > image.getWidth()) { + width = image.getWidth() - (x * textWidth); + } + int height = textHeight; + if ((y + 1) * textHeight > image.getHeight()) { + height = image.getHeight() - (y * textHeight); + } + + Cell cell = new Cell(); + if ((width != textWidth) || (height != textHeight)) { + BufferedImage newImage; + newImage = new BufferedImage(textWidth, textHeight, + BufferedImage.TYPE_INT_ARGB); + + Graphics gr = newImage.getGraphics(); + gr.drawImage(image.getSubimage(x * textWidth, + y * textHeight, width, height), + 0, 0, null, null); + gr.dispose(); + cell.setImage(newImage); + } else { + cell.setImage(image.getSubimage(x * textWidth, + y * textHeight, width, height)); + } + + cells[x][y] = cell; + } + } + + int x0 = currentState.cursorX; + int y0 = currentState.cursorY; + for (int y = 0; y < cellRows; y++) { + for (int x = 0; x < cellColumns; x++) { + assert (currentState.cursorX <= rightMargin); + + // A real sixel terminal would render the text of the current + // cell first, then image over it (accounting for blank + // pixels). We do not support that. A cell is either text, + // or image, but not a mix of image-over-text. + DisplayLine line = display.get(currentState.cursorY); + line.replace(currentState.cursorX, cells[x][y]); + + // If at the end of the visible screen, stop. + if (currentState.cursorX == rightMargin) { + break; + } + // Room for more image on the visible screen. + currentState.cursorX++; + } + if (currentState.cursorY < scrollRegionBottom - 1) { + // Not at the bottom, down a line. + linefeed(); + } else if (scroll == true) { + // At the bottom, scroll as needed. + linefeed(); + } else { + // At the bottom, no more scrolling, done. + break; + } + + cursorPosition(currentState.cursorY, x0); + } + + if (scroll == false) { + cursorPosition(y0, x0); } - // System.err.println("*** run() exiting..."); System.err.flush(); } }