X-Git-Url: http://git.nikiroo.be/?a=blobdiff_plain;f=src%2Fjexer%2Ftterminal%2FECMA48.java;h=7a37a95fdd765cae7e7eb389cc5446fd603ff5d1;hb=d36057dfab8def933a64be042b039d76708ac5ba;hp=017c3c7f1df6b6b347f1f862d9151de06231ce35;hpb=a90d3119be3030c35765a00d3cc149f61fd8f69e;p=fanfix.git diff --git a/src/jexer/tterminal/ECMA48.java b/src/jexer/tterminal/ECMA48.java index 017c3c7..7a37a95 100644 --- a/src/jexer/tterminal/ECMA48.java +++ b/src/jexer/tterminal/ECMA48.java @@ -1,35 +1,34 @@ -/** +/* * Jexer - Java Text User Interface * - * License: LGPLv3 or later - * - * This module is licensed under the GNU Lesser General Public License - * Version 3. Please see the file "COPYING" in this directory for more - * information about the GNU Lesser General Public License Version 3. + * The MIT License (MIT) * - * Copyright (C) 2015 Kevin Lamonte + * Copyright (C) 2017 Kevin Lamonte * - * This program is free software; you can redistribute it and/or - * modify it under the terms of the GNU Lesser General Public License - * as published by the Free Software Foundation; either version 3 of - * the License, or (at your option) any later version. + * Permission is hereby granted, free of charge, to any person obtaining a + * copy of this software and associated documentation files (the "Software"), + * to deal in the Software without restriction, including without limitation + * the rights to use, copy, modify, merge, publish, distribute, sublicense, + * and/or sell copies of the Software, and to permit persons to whom the + * Software is furnished to do so, subject to the following conditions: * - * This program is distributed in the hope that it will be useful, but - * WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - * General Public License for more details. + * The above copyright notice and this permission notice shall be included in + * all copies or substantial portions of the Software. * - * You should have received a copy of the GNU Lesser General Public - * License along with this program; if not, see - * http://www.gnu.org/licenses/, or write to the Free Software - * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA - * 02110-1301 USA + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL + * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING + * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER + * DEALINGS IN THE SOFTWARE. * * @author Kevin Lamonte [kevin.lamonte@gmail.com] * @version 1 */ package jexer.tterminal; +import java.io.BufferedOutputStream; import java.io.InputStream; import java.io.InputStreamReader; import java.io.IOException; @@ -48,10 +47,12 @@ import jexer.event.TMouseEvent; import jexer.bits.Color; import jexer.bits.Cell; import jexer.bits.CellAttributes; +import jexer.io.ReadTimeoutException; +import jexer.io.TimeoutInputStream; import static jexer.TKeypress.*; /** - * This implements a complex ANSI ECMA-48/ISO 6429/ANSI X3.64 type consoles, + * This implements a complex ECMA-48/ISO 6429/ANSI X3.64 type console, * including a scrollback buffer. * *

@@ -89,6 +90,10 @@ import static jexer.TKeypress.*; */ public class ECMA48 implements Runnable { + // ------------------------------------------------------------------------ + // Constants -------------------------------------------------------------- + // ------------------------------------------------------------------------ + /** * The emulator can emulate several kinds of terminals. */ @@ -115,215 +120,119 @@ 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: - // "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"; - case XTERM: - // "I am a VT100 with advanced video option" (often VT102) - return "\033[?1;2c"; - 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, + 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 "LANG=en_US", "LANG=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. */ - private 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 { - 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.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 + } - // Synchronize so we don't stomp on the reader thread. - synchronized (this) { + /** + * XTERM mouse reporting protocols. + */ + private enum MouseProtocol { + OFF, + X10, + NORMAL, + BUTTONEVENT, + ANYEVENT + } - // Close the input stream - switch (type) { - case VT100: - case VT102: - case VT220: - if (inputStream != null) { - try { - inputStream.close(); - } catch (IOException e) { - // SQUASH - } - inputStream = null; - } - break; - case XTERM: - if (input != null) { - try { - input.close(); - } catch (IOException e) { - // SQUASH - } - input = null; - inputStream = null; - } - break; - } + /** + * XTERM mouse reporting encodings. + */ + private enum MouseEncoding { + X10, + UTF8, + SGR + } - // Tell the reader thread to stop looking at input. - if (stopReaderThread == false) { - stopReaderThread = true; - try { - readerThread.join(); - } catch (InterruptedException e) { - e.printStackTrace(); - } - } + // ------------------------------------------------------------------------ + // Variables -------------------------------------------------------------- + // ------------------------------------------------------------------------ - // 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 (output != null) { - try { - output.close(); - } catch (IOException e) { - // SQUASH - } - output = null; - } - break; - default: - throw new IllegalArgumentException("Invalid device type: " - + type); - } - } // synchronized (this) - } + /** + * The enclosing listening object. + */ + private DisplayListener displayListener; /** * When true, the reader thread is expected to exit. @@ -335,59 +244,21 @@ 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 - */ - public final boolean isReading() { - return (!stopReaderThread); - } - /** * The type of emulator to be. */ 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. + * The scrollback buffer characters + attributes. */ private volatile List scrollback; - /** - * Get the scrollback buffer. - * - * @return the scrollback buffer - */ - public final List getScrollbackBuffer() { - return scrollback; - } - /** * The raw display buffer characters + attributes. */ private volatile List display; - /** - * Get the display buffer. - * - * @return the display buffer - */ - public final List getDisplayBuffer() { - return display; - } - /** * The terminal's input. For type == XTERM, this is an InputStreamReader * with UTF-8 encoding. @@ -397,7 +268,7 @@ public class ECMA48 implements Runnable { /** * The terminal's raw InputStream. This is used for type != XTERM. */ - private volatile InputStream inputStream; + private volatile TimeoutInputStream inputStream; /** * The terminal's output. For type == XTERM, this wraps an @@ -410,121 +281,16 @@ 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 - } - /** * Which mouse encoding is active. */ @@ -536,30 +302,12 @@ public class ECMA48 implements Runnable { */ private int width; - /** - * Get the display width. - * - * @return the width (usually 80 or 132) - */ - public final int getWidth() { - return width; - } - /** * 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; - } - /** * Top margin of the scrolling region. */ @@ -609,32 +357,12 @@ public class ECMA48 implements Runnable { */ private boolean cursorVisible = true; - /** - * Get visible cursor flag. - * - * @return if true, the cursor is visible - */ - public final boolean visibleCursor() { - 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. */ @@ -682,6 +410,7 @@ public class ECMA48 implements Runnable { * Whether number pad keys send VT100 or VT52, application or numeric * sequences. */ + @SuppressWarnings("unused") private KeypadMode keypadMode; /** @@ -699,6 +428,16 @@ public class ECMA48 implements Runnable { */ private boolean fullDuplex = true; + /** + * The current terminal state. + */ + private SaveableState currentState; + + /** + * The last saved terminal state. + */ + private SaveableState savedState; + /** * DECSC/DECRC save/restore a subset of the total state. This class * encapsulates those specific flags/modes. @@ -812,78 +551,9 @@ public class ECMA48 implements Runnable { } } - /** - * The current terminal state. - */ - private SaveableState currentState; - - /** - * The last saved terminal state. - */ - private SaveableState savedState; - - /** - * Clear the CSI parameters and flags. - */ - private void toGround() { - csiParams.clear(); - collectBuffer = new StringBuilder(8); - scanState = ScanState.GROUND; - } - - /** - * Reset the tab stops list. - */ - private void resetTabStops() { - tabStops.clear(); - for (int i = 0; (i * 8) <= rightMargin; i++) { - tabStops.add(new Integer(i * 8)); - } - } - - /** - * Reset the emulation state. - */ - 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; - - // Flags - shiftOut = false; - vt52Mode = false; - insertMode = false; - columns132 = false; - newLineMode = false; - reverseVideo = false; - fullDuplex = true; - cursorVisible = true; - - // VT220 - singleshift = Singleshift.NONE; - s8c1t = false; - printerControllerMode = false; - - // XTERM - mouseProtocol = MouseProtocol.OFF; - mouseEncoding = MouseEncoding.X10; - - // Tab stops - resetTabStops(); - - // Clear CSI stuff - toGround(); - } + // ------------------------------------------------------------------------ + // Constructors ----------------------------------------------------------- + // ------------------------------------------------------------------------ /** * Public constructor. @@ -891,16 +561,19 @@ public class ECMA48 implements Runnable { * @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, inputStrem is converted to a Reader with UTF-8 + * 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 */ public ECMA48(final DeviceType type, final InputStream inputStream, - final OutputStream outputStream) throws UnsupportedEncodingException { + final OutputStream outputStream, final DisplayListener displayListener) + throws UnsupportedEncodingException { assert (inputStream != null); assert (outputStream != null); @@ -910,25 +583,547 @@ public class ECMA48 implements Runnable { scrollback = new LinkedList(); display = new LinkedList(); - this.type = type; - this.inputStream = inputStream; - if (type == DeviceType.XTERM) { - this.input = new InputStreamReader(inputStream, "UTF-8"); - this.output = new OutputStreamWriter(outputStream, "UTF-8"); - this.outputStream = null; - } else { - this.output = null; - this.outputStream = outputStream; - } + 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)); + } + + // Spin up the input reader + readerThread = new Thread(this); + readerThread.start(); + } + + // ------------------------------------------------------------------------ + // Runnable --------------------------------------------------------------- + // ------------------------------------------------------------------------ + + /** + * Read function runs on a separate thread. + */ + 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[128]; + } else { + readBuffer = new byte[128]; + } + + while (!done && !stopReaderThread) { + 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(2); + } 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) { + for (int i = 0; i < rc; i++) { + int ch = 0; + if (utf8) { + ch = readBufferUTF8[i]; + } else { + ch = readBuffer[i]; + } + + consume((char)ch); + } + } + // 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) { + e.printStackTrace(); + done = true; + } + + } // 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 ----------------------------------------------------------------- + // ------------------------------------------------------------------------ + + /** + * 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 + 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); + } + } + + /** + * 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; + try { + readerThread.join(1000); + } catch (InterruptedException e) { + e.printStackTrace(); + } + } + + // 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 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 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 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)); + } + } + + /** + * 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 = new StringBuilder(8); + scanState = ScanState.GROUND; + } + + /** + * Reset the tab stops list. + */ + private void resetTabStops() { + tabStops.clear(); + for (int i = 0; (i * 8) <= rightMargin; i++) { + tabStops.add(new Integer(i * 8)); + } + } + + /** + * Reset the emulation state. + */ + 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; + } + + // Flags + shiftOut = false; + vt52Mode = false; + insertMode = false; + columns132 = false; + newLineMode = false; + reverseVideo = false; + fullDuplex = true; + cursorVisible = true; + + // VT220 + singleshift = Singleshift.NONE; + s8c1t = false; + printerControllerMode = false; + + // XTERM + mouseProtocol = MouseProtocol.OFF; + mouseEncoding = MouseEncoding.X10; - reset(); - for (int i = 0; i < height; i++) { - display.add(new DisplayLine(currentState.attr)); - } + // Tab stops + resetTabStops(); - // Spin up the input reader - readerThread = new Thread(this); - readerThread.start(); + // Clear CSI stuff + toGround(); } /** @@ -978,7 +1173,6 @@ public class ECMA48 implements Runnable { * Handle a linefeed. */ private void linefeed() { - int i; if (currentState.cursorY < scrollRegionBottom) { // Increment screen y @@ -1102,7 +1296,7 @@ public class ECMA48 implements Runnable { mouseProtocol, mouseEncoding, mouse); */ - if (mouseEncoding != MouseEncoding.UTF8) { + if (mouseEncoding == MouseEncoding.X10) { // We will support X10 but only for (160,94) and smaller. if ((mouse.getX() >= 160) || (mouse.getY() >= 94)) { return; @@ -1137,11 +1331,11 @@ public class ECMA48 implements Runnable { * have a button down (i.e. drag-and-drop). */ if (mouse.getType() == TMouseEvent.Type.MOUSE_MOTION) { - if (!mouse.getMouse1() - && !mouse.getMouse2() - && !mouse.getMouse3() - && !mouse.getMouseWheelUp() - && !mouse.getMouseWheelDown() + if (!mouse.isMouse1() + && !mouse.isMouse2() + && !mouse.isMouse3() + && !mouse.isMouseWheelUp() + && !mouse.isMouseWheelDown() ) { return; } @@ -1155,27 +1349,83 @@ public class ECMA48 implements Runnable { // Now encode the event StringBuilder sb = new StringBuilder(6); - sb.append((char) 0x1B); - sb.append('['); - sb.append('M'); - if (mouse.getType() == TMouseEvent.Type.MOUSE_UP) { - sb.append((char) (0x03 + 32)); - } else if (mouse.getMouse1()) { - sb.append((char) (0x00 + 32)); - } else if (mouse.getMouse2()) { - sb.append((char) (0x01 + 32)); - } else if (mouse.getMouse3()) { - sb.append((char) (0x02 + 32)); - } else if (mouse.getMouseWheelUp()) { - sb.append((char) (0x04 + 64)); - } else if (mouse.getMouseWheelDown()) { - sb.append((char) (0x05 + 64)); + if (mouseEncoding == MouseEncoding.SGR) { + sb.append((char) 0x1B); + sb.append("[<"); + + if (mouse.isMouse1()) { + if (mouse.getType() == TMouseEvent.Type.MOUSE_MOTION) { + sb.append("32;"); + } else { + sb.append("0;"); + } + } else if (mouse.isMouse2()) { + if (mouse.getType() == TMouseEvent.Type.MOUSE_MOTION) { + sb.append("33;"); + } else { + sb.append("1;"); + } + } else if (mouse.isMouse3()) { + if (mouse.getType() == TMouseEvent.Type.MOUSE_MOTION) { + sb.append("34;"); + } else { + sb.append("2;"); + } + } else if (mouse.isMouseWheelUp()) { + sb.append("64;"); + } else if (mouse.isMouseWheelDown()) { + sb.append("65;"); + } else { + // This is motion with no buttons down. + sb.append("35;"); + } + + sb.append(String.format("%d;%d", mouse.getX() + 1, + mouse.getY() + 1)); + + if (mouse.getType() == TMouseEvent.Type.MOUSE_UP) { + sb.append("m"); + } else { + sb.append("M"); + } + } else { - sb.append((char) (0x03 + 32)); - } + // X10 and UTF8 encodings + sb.append((char) 0x1B); + sb.append('['); + sb.append('M'); + if (mouse.getType() == TMouseEvent.Type.MOUSE_UP) { + sb.append((char) (0x03 + 32)); + } else if (mouse.isMouse1()) { + if (mouse.getType() == TMouseEvent.Type.MOUSE_MOTION) { + sb.append((char) (0x00 + 32 + 32)); + } else { + sb.append((char) (0x00 + 32)); + } + } else if (mouse.isMouse2()) { + if (mouse.getType() == TMouseEvent.Type.MOUSE_MOTION) { + sb.append((char) (0x01 + 32 + 32)); + } else { + sb.append((char) (0x01 + 32)); + } + } else if (mouse.isMouse3()) { + if (mouse.getType() == TMouseEvent.Type.MOUSE_MOTION) { + sb.append((char) (0x02 + 32 + 32)); + } else { + sb.append((char) (0x02 + 32)); + } + } else if (mouse.isMouseWheelUp()) { + sb.append((char) (0x04 + 64)); + } else if (mouse.isMouseWheelDown()) { + sb.append((char) (0x05 + 64)); + } else { + // This is motion with no buttons down. + sb.append((char) (0x03 + 32)); + } - sb.append((char) (mouse.getX() + 33)); - sb.append((char) (mouse.getY() + 33)); + sb.append((char) (mouse.getX() + 33)); + sb.append((char) (mouse.getY() + 33)); + } // System.err.printf("Would write: \'%s\'\n", sb.toString()); writeRemote(sb.toString()); @@ -1191,6 +1441,46 @@ public class ECMA48 implements Runnable { writeRemote(keypressToString(keypress)); } + /** + * Build one of the complex xterm keystroke sequences, storing the result in + * xterm_keystroke_buffer. + * + * @param ss3 the prefix to use based on VT100 state. + * @param first the first character, usually a number. + * @param first the last character, one of the following: ~ A B C D F H + * @param ctrl whether or not ctrl is down + * @param alt whether or not alt is down + * @param shift whether or not shift is down + * @return the buffer with the full key sequence + */ + private String xtermBuildKeySequence(final String ss3, final char first, + final char last, boolean ctrl, boolean alt, boolean shift) { + + StringBuilder sb = new StringBuilder(ss3); + if ((last == '~') || (ctrl == true) || (alt == true) + || (shift == true) + ) { + sb.append(first); + if ( (ctrl == false) && (alt == false) && (shift == true)) { + sb.append(";2"); + } else if ((ctrl == false) && (alt == true) && (shift == false)) { + sb.append(";3"); + } else if ((ctrl == false) && (alt == true) && (shift == true)) { + sb.append(";4"); + } else if ((ctrl == true) && (alt == false) && (shift == false)) { + sb.append(";5"); + } else if ((ctrl == true) && (alt == false) && (shift == true)) { + sb.append(";6"); + } else if ((ctrl == true) && (alt == true) && (shift == false)) { + sb.append(";7"); + } else if ((ctrl == true) && (alt == true) && (shift == true)) { + sb.append(";8"); + } + } + sb.append(last); + return sb.toString(); + } + /** * Translate the keyboard press to a VT100, VT220, or XTERM sequence. * @@ -1199,16 +1489,16 @@ public class ECMA48 implements Runnable { */ private String keypressToString(final TKeypress keypress) { - if ((fullDuplex == false) && (!keypress.getIsKey())) { + if ((fullDuplex == false) && (!keypress.isFnKey())) { /* * If this is a control character, process it like it came from * the remote side. */ - if (keypress.getCh() < 0x20) { - handleControlChar(keypress.getCh()); + if (keypress.getChar() < 0x20) { + handleControlChar(keypress.getChar()); } else { // Local echo for everything else - printCharacter(keypress.getCh()); + printCharacter(keypress.getChar()); } } @@ -1218,23 +1508,23 @@ public class ECMA48 implements Runnable { } // Handle control characters - if ((keypress.getCtrl()) && (!keypress.getIsKey())) { + if ((keypress.isCtrl()) && (!keypress.isFnKey())) { StringBuilder sb = new StringBuilder(); - char ch = keypress.getCh(); + char ch = keypress.getChar(); ch -= 0x40; sb.append(ch); return sb.toString(); } // Handle alt characters - if ((keypress.getAlt()) && (!keypress.getIsKey())) { + if ((keypress.isAlt()) && (!keypress.isFnKey())) { StringBuilder sb = new StringBuilder("\033"); - char ch = keypress.getCh(); + char ch = keypress.getChar(); sb.append(ch); return sb.toString(); } - if (keypress.equals(kbBackspace)) { + if (keypress.equals(kbBackspaceDel)) { switch (type) { case VT100: return "\010"; @@ -1247,69 +1537,177 @@ public class ECMA48 implements Runnable { } } - if (keypress.equals(kbLeft)) { - switch (arrowKeyMode) { - case ANSI: - return "\033[D"; - case VT52: - return "\033D"; - case VT100: - return "\033OD"; + if (keypress.equalsWithoutModifiers(kbLeft)) { + switch (type) { + case XTERM: + switch (arrowKeyMode) { + case ANSI: + return xtermBuildKeySequence("\033[", '1', 'D', + keypress.isCtrl(), keypress.isAlt(), + keypress.isShift()); + case VT52: + return xtermBuildKeySequence("\033", '1', 'D', + keypress.isCtrl(), keypress.isAlt(), + keypress.isShift()); + case VT100: + return xtermBuildKeySequence("\033O", '1', 'D', + keypress.isCtrl(), keypress.isAlt(), + keypress.isShift()); + } + default: + switch (arrowKeyMode) { + case ANSI: + return "\033[D"; + case VT52: + return "\033D"; + case VT100: + return "\033OD"; + } } } - if (keypress.equals(kbRight)) { - switch (arrowKeyMode) { - case ANSI: - return "\033[C"; - case VT52: - return "\033C"; - case VT100: - return "\033OC"; + if (keypress.equalsWithoutModifiers(kbRight)) { + switch (type) { + case XTERM: + switch (arrowKeyMode) { + case ANSI: + return xtermBuildKeySequence("\033[", '1', 'C', + keypress.isCtrl(), keypress.isAlt(), + keypress.isShift()); + case VT52: + return xtermBuildKeySequence("\033", '1', 'C', + keypress.isCtrl(), keypress.isAlt(), + keypress.isShift()); + case VT100: + return xtermBuildKeySequence("\033O", '1', 'C', + keypress.isCtrl(), keypress.isAlt(), + keypress.isShift()); + } + default: + switch (arrowKeyMode) { + case ANSI: + return "\033[C"; + case VT52: + return "\033C"; + case VT100: + return "\033OC"; + } } } - if (keypress.equals(kbUp)) { - switch (arrowKeyMode) { - case ANSI: - return "\033[A"; - case VT52: - return "\033A"; - case VT100: - return "\033OA"; + if (keypress.equalsWithoutModifiers(kbUp)) { + switch (type) { + case XTERM: + switch (arrowKeyMode) { + case ANSI: + return xtermBuildKeySequence("\033[", '1', 'A', + keypress.isCtrl(), keypress.isAlt(), + keypress.isShift()); + case VT52: + return xtermBuildKeySequence("\033", '1', 'A', + keypress.isCtrl(), keypress.isAlt(), + keypress.isShift()); + case VT100: + return xtermBuildKeySequence("\033O", '1', 'A', + keypress.isCtrl(), keypress.isAlt(), + keypress.isShift()); + } + default: + switch (arrowKeyMode) { + case ANSI: + return "\033[A"; + case VT52: + return "\033A"; + case VT100: + return "\033OA"; + } } } - if (keypress.equals(kbDown)) { - switch (arrowKeyMode) { - case ANSI: - return "\033[B"; - case VT52: - return "\033B"; - case VT100: - return "\033OB"; + if (keypress.equalsWithoutModifiers(kbDown)) { + switch (type) { + case XTERM: + switch (arrowKeyMode) { + case ANSI: + return xtermBuildKeySequence("\033[", '1', 'B', + keypress.isCtrl(), keypress.isAlt(), + keypress.isShift()); + case VT52: + return xtermBuildKeySequence("\033", '1', 'B', + keypress.isCtrl(), keypress.isAlt(), + keypress.isShift()); + case VT100: + return xtermBuildKeySequence("\033O", '1', 'B', + keypress.isCtrl(), keypress.isAlt(), + keypress.isShift()); + } + default: + switch (arrowKeyMode) { + case ANSI: + return "\033[B"; + case VT52: + return "\033B"; + case VT100: + return "\033OB"; + } } } - if (keypress.equals(kbHome)) { - switch (arrowKeyMode) { - case ANSI: - return "\033[H"; - case VT52: - return "\033H"; - case VT100: - return "\033OH"; + if (keypress.equalsWithoutModifiers(kbHome)) { + switch (type) { + case XTERM: + switch (arrowKeyMode) { + case ANSI: + return xtermBuildKeySequence("\033[", '1', 'H', + keypress.isCtrl(), keypress.isAlt(), + keypress.isShift()); + case VT52: + return xtermBuildKeySequence("\033", '1', 'H', + keypress.isCtrl(), keypress.isAlt(), + keypress.isShift()); + case VT100: + return xtermBuildKeySequence("\033O", '1', 'H', + keypress.isCtrl(), keypress.isAlt(), + keypress.isShift()); + } + default: + switch (arrowKeyMode) { + case ANSI: + return "\033[H"; + case VT52: + return "\033H"; + case VT100: + return "\033OH"; + } } } - if (keypress.equals(kbEnd)) { - switch (arrowKeyMode) { - case ANSI: - return "\033[F"; - case VT52: - return "\033F"; - case VT100: - return "\033OF"; + if (keypress.equalsWithoutModifiers(kbEnd)) { + switch (type) { + case XTERM: + switch (arrowKeyMode) { + case ANSI: + return xtermBuildKeySequence("\033[", '1', 'F', + keypress.isCtrl(), keypress.isAlt(), + keypress.isShift()); + case VT52: + return xtermBuildKeySequence("\033", '1', 'F', + keypress.isCtrl(), keypress.isAlt(), + keypress.isShift()); + case VT100: + return xtermBuildKeySequence("\033O", '1', 'F', + keypress.isCtrl(), keypress.isAlt(), + keypress.isShift()); + } + default: + switch (arrowKeyMode) { + case ANSI: + return "\033[F"; + case VT52: + return "\033F"; + case VT100: + return "\033OF"; + } } } @@ -1436,6 +1834,9 @@ public class ECMA48 implements Runnable { if (vt52Mode) { return "\0332P"; } + if (type == DeviceType.XTERM) { + return "\0331;2P"; + } return "\033O2P"; } @@ -1444,6 +1845,9 @@ public class ECMA48 implements Runnable { if (vt52Mode) { return "\0332Q"; } + if (type == DeviceType.XTERM) { + return "\0331;2Q"; + } return "\033O2Q"; } @@ -1452,6 +1856,9 @@ public class ECMA48 implements Runnable { if (vt52Mode) { return "\0332R"; } + if (type == DeviceType.XTERM) { + return "\0331;2R"; + } return "\033O2R"; } @@ -1460,6 +1867,9 @@ public class ECMA48 implements Runnable { if (vt52Mode) { return "\0332S"; } + if (type == DeviceType.XTERM) { + return "\0331;2S"; + } return "\033O2S"; } @@ -1508,6 +1918,9 @@ public class ECMA48 implements Runnable { if (vt52Mode) { return "\0335P"; } + if (type == DeviceType.XTERM) { + return "\0331;5P"; + } return "\033O5P"; } @@ -1516,6 +1929,9 @@ public class ECMA48 implements Runnable { if (vt52Mode) { return "\0335Q"; } + if (type == DeviceType.XTERM) { + return "\0331;5Q"; + } return "\033O5Q"; } @@ -1524,6 +1940,9 @@ public class ECMA48 implements Runnable { if (vt52Mode) { return "\0335R"; } + if (type == DeviceType.XTERM) { + return "\0331;5R"; + } return "\033O5R"; } @@ -1532,6 +1951,9 @@ public class ECMA48 implements Runnable { if (vt52Mode) { return "\0335S"; } + if (type == DeviceType.XTERM) { + return "\0331;5S"; + } return "\033O5S"; } @@ -1575,39 +1997,49 @@ public class ECMA48 implements Runnable { return "\033[24;5~"; } - if (keypress.equals(kbPgUp)) { - // Page Up - return "\033[5~"; - } - - if (keypress.equals(kbPgDn)) { - // Page Down - return "\033[6~"; - } - - if (keypress.equals(kbIns)) { - // Ins - return "\033[2~"; + if (keypress.equalsWithoutModifiers(kbPgUp)) { + switch (type) { + case XTERM: + return xtermBuildKeySequence("\033[", '5', '~', + keypress.isCtrl(), keypress.isAlt(), + keypress.isShift()); + default: + return "\033[5~"; + } } - if (keypress.equals(kbShiftIns)) { - // This is what xterm sends for SHIFT-INS - return "\033[2;2~"; - // This is what xterm sends for CTRL-INS - // return "\033[2;5~"; + if (keypress.equalsWithoutModifiers(kbPgDn)) { + switch (type) { + case XTERM: + return xtermBuildKeySequence("\033[", '6', '~', + keypress.isCtrl(), keypress.isAlt(), + keypress.isShift()); + default: + return "\033[6~"; + } } - if (keypress.equals(kbShiftDel)) { - // This is what xterm sends for SHIFT-DEL - return "\033[3;2~"; - // This is what xterm sends for CTRL-DEL - // return "\033[3;5~"; + if (keypress.equalsWithoutModifiers(kbIns)) { + switch (type) { + case XTERM: + return xtermBuildKeySequence("\033[", '2', '~', + keypress.isCtrl(), keypress.isAlt(), + keypress.isShift()); + default: + return "\033[2~"; + } } - if (keypress.equals(kbDel)) { - // Delete sends real delete for VTxxx - return "\177"; - // return "\033[3~"; + if (keypress.equalsWithoutModifiers(kbDel)) { + switch (type) { + case XTERM: + return xtermBuildKeySequence("\033[", '3', '~', + keypress.isCtrl(), keypress.isAlt(), + keypress.isShift()); + default: + // Delete sends real delete for VTxxx + return "\177"; + } } if (keypress.equals(kbEnter)) { @@ -1626,10 +2058,21 @@ public class ECMA48 implements Runnable { return "\011"; } + if ((keypress.equalsWithoutModifiers(kbBackTab)) || + (keypress.equals(kbShiftTab)) + ) { + switch (type) { + case XTERM: + return "\033[Z"; + default: + return "\011"; + } + } + // Non-alt, non-ctrl characters - if (!keypress.getIsKey()) { + if (!keypress.isFnKey()) { StringBuilder sb = new StringBuilder(); - sb.append(keypress.getCh()); + sb.append(keypress.getChar()); return sb.toString(); } return ""; @@ -2119,8 +2562,9 @@ public class ECMA48 implements Runnable { } /** - * Set or unset a toggle. value is 'true' for set ('h'), false for reset - * ('l'). + * Set or unset a toggle. + * + * @param value true for set ('h'), false for reset ('l') */ private void setToggle(final boolean value) { boolean decPrivateModeFlag = false; @@ -2201,9 +2645,18 @@ public class ECMA48 implements Runnable { } else { // 80 columns columns132 = false; - rightMargin = 79; + if ((displayListener != null) + && (type == DeviceType.XTERM) + ) { + // For xterms, reset to the actual width, not 80 + // columns. + width = displayListener.getDisplayWidth(); + rightMargin = width - 1; + } else { + rightMargin = 79; + width = rightMargin + 1; + } } - width = rightMargin + 1; // Entire screen is cleared, and scrolling region is // reset eraseScreen(0, 0, height - 1, width - 1, false); @@ -2433,6 +2886,19 @@ public class ECMA48 implements Runnable { } break; + case 1006: + if ((type == DeviceType.XTERM) + && (decPrivateModeFlag == true) + ) { + // Mouse: SGR coordinates + if (value == true) { + mouseEncoding = MouseEncoding.SGR; + } else { + mouseEncoding = MouseEncoding.X10; + } + } + break; + default: break; @@ -3179,9 +3645,41 @@ public class ECMA48 implements Runnable { currentState.attr.setForeColor(Color.WHITE); break; case 38: - // Underscore on, default foreground color - currentState.attr.setUnderline(true); - currentState.attr.setForeColor(Color.WHITE); + if (type == DeviceType.XTERM) { + /* + * Xterm supports T.416 / ISO-8613-3 codes to select + * either an indexed color or an RGB value. (It also + * 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: + * + * 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. 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. + * + * 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; + } else { + // Underscore on, default foreground color + currentState.attr.setUnderline(true); + currentState.attr.setForeColor(Color.WHITE); + } break; case 39: // Underscore off, default foreground color @@ -3220,6 +3718,21 @@ public class ECMA48 implements Runnable { // Set white background currentState.attr.setBackColor(Color.WHITE); break; + case 48: + if (type == DeviceType.XTERM) { + /* + * Xterm supports T.416 / ISO-8613-3 codes to select + * either an indexed color or an RGB value. (It also + * 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. + */ + return; + } + break; case 49: // Default background currentState.attr.setBackColor(Color.BLACK); @@ -3307,17 +3820,31 @@ public class ECMA48 implements Runnable { * DECSTBM - Set top and bottom margins. */ private void decstbm() { - int top = getCsiParam(0, 1, 1, height) - 1; - int bottom = getCsiParam(1, height, 1, height) - 1; + boolean decPrivateModeFlag = false; - if (top > bottom) { - top = bottom; + for (int i = 0; i < collectBuffer.length(); i++) { + if (collectBuffer.charAt(i) == '?') { + decPrivateModeFlag = true; + break; + } } - scrollRegionTop = top; - scrollRegionBottom = bottom; + if (decPrivateModeFlag) { + // This could be restore DEC private mode values. + // Ignore it. + } else { + // DECSTBM + int top = getCsiParam(0, 1, 1, height) - 1; + int bottom = getCsiParam(1, height, 1, height) - 1; - // Home cursor - cursorPosition(0, 0); + if (top > bottom) { + top = bottom; + } + scrollRegionTop = top; + scrollRegionBottom = bottom; + + // Home cursor + cursorPosition(0, 0); + } } /** @@ -3384,6 +3911,7 @@ public class ECMA48 implements Runnable { */ private void dsr() { boolean decPrivateModeFlag = false; + int row = currentState.cursorY; for (int i = 0; i < collectBuffer.length(); i++) { if (collectBuffer.charAt(i) == '?') { @@ -3411,15 +3939,18 @@ public class ECMA48 implements Runnable { case 6: // Request cursor position. Respond with current position. + if (currentState.originMode == true) { + row -= scrollRegionTop; + } String str = ""; if (((type == DeviceType.VT220) || (type == DeviceType.XTERM)) && (s8c1t == true) ) { - str = String.format("\u009b%d;%dR", - currentState.cursorY + 1, currentState.cursorX + 1); + str = String.format("\u009b%d;%dR", row + 1, + currentState.cursorX + 1); } else { - str = String.format("\033[%d;%dR", - currentState.cursorY + 1, currentState.cursorX + 1); + str = String.format("\033[%d;%dR", row + 1, + currentState.cursorX + 1); } // Send string directly to remote side @@ -3524,7 +4055,7 @@ public class ECMA48 implements Runnable { for (int i = start; i <= end; i++) { DisplayLine line = display.get(currentState.cursorY); if ((!honorProtected) - || ((honorProtected) && (!line.charAt(i).getProtect()))) { + || ((honorProtected) && (!line.charAt(i).isProtect()))) { switch (type) { case VT100: @@ -3683,7 +4214,7 @@ public class ECMA48 implements Runnable { * * @param ch character from the remote side */ - public void consume(char ch) { + private void consume(char ch) { // DEBUG // System.err.printf("%c", ch); @@ -5441,8 +5972,8 @@ public class ECMA48 implements Runnable { collect(ch); } if (ch == 0x5C) { - if ((collectBuffer.length() > 0) && - (collectBuffer.charAt(collectBuffer.length() - 1) == 0x1B) + if ((collectBuffer.length() > 0) + && (collectBuffer.charAt(collectBuffer.length() - 1) == 0x1B) ) { toGround(); } @@ -5473,8 +6004,8 @@ public class ECMA48 implements Runnable { collect(ch); } if (ch == 0x5C) { - if ((collectBuffer.length() > 0) && - (collectBuffer.charAt(collectBuffer.length() - 1) == 0x1B) + if ((collectBuffer.length() > 0) + && (collectBuffer.charAt(collectBuffer.length() - 1) == 0x1B) ) { toGround(); } @@ -5623,83 +6154,4 @@ public class ECMA48 implements Runnable { return currentState.cursorY; } - /** - * Read function runs on a separate thread. - */ - public 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[128]; - } else { - readBuffer = new byte[128]; - } - - while (!done && !stopReaderThread) { - 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]; - } - } - - int rc = -1; - if (utf8) { - rc = input.read(readBufferUTF8, 0, - readBufferUTF8.length); - } else { - rc = inputStream.read(readBuffer, 0, - readBuffer.length); - } - // System.err.printf("read() %d\n", rc); System.err.flush(); - if (rc == -1) { - // This is EOF - done = true; - } else { - for (int i = 0; i < rc; i++) { - int ch = 0; - if (utf8) { - ch = readBufferUTF8[i]; - } else { - ch = readBuffer[i]; - } - // Don't step on UI events - synchronized (this) { - consume((char)ch); - } - } - } - // System.err.println("end while loop"); System.err.flush(); - } catch (IOException e) { - e.printStackTrace(); - done = true; - } - } // while ((done == false) && (stopReaderThread == false)) - - // Let the rest of the world know that I am done. - stopReaderThread = true; - - // System.err.println("*** run() exiting..."); System.err.flush(); - } - }