X-Git-Url: http://git.nikiroo.be/?a=blobdiff_plain;f=src%2Fjexer%2Ftterminal%2FECMA48.java;h=7a37a95fdd765cae7e7eb389cc5446fd603ff5d1;hb=d36057dfab8def933a64be042b039d76708ac5ba;hp=f088f6a75b598afab9047f94cb60eec1afafce0e;hpb=14c78e1b06945584719c1a1dac67e320ec57fdf8;p=fanfix.git
diff --git a/src/jexer/tterminal/ECMA48.java b/src/jexer/tterminal/ECMA48.java
index f088f6a..7a37a95 100644
--- a/src/jexer/tterminal/ECMA48.java
+++ b/src/jexer/tterminal/ECMA48.java
@@ -3,7 +3,7 @@
*
* The MIT License (MIT)
*
- * Copyright (C) 2016 Kevin Lamonte
+ * Copyright (C) 2017 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,6 +28,7 @@
*/
package jexer.tterminal;
+import java.io.BufferedOutputStream;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.io.IOException;
@@ -46,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.
*
*
@@ -87,6 +90,10 @@ import static jexer.TKeypress.*;
*/
public class ECMA48 implements Runnable {
+ // ------------------------------------------------------------------------
+ // Constants --------------------------------------------------------------
+ // ------------------------------------------------------------------------
+
/**
* The emulator can emulate several kinds of terminals.
*/
@@ -113,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 "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.
*/
- 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.
@@ -334,58 +245,20 @@ 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 DeviceType type = DeviceType.VT102;
/**
- * 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 List 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.
@@ -395,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
@@ -408,122 +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,
- SGR
- }
-
/**
* Which mouse encoding is active.
*/
@@ -535,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.
*/
@@ -608,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 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.
*/
@@ -690,15 +419,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.
*/
private boolean reverseVideo = false;
@@ -708,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.
@@ -813,23 +543,520 @@ public class ECMA48 implements Runnable {
this.lineWrap = that.lineWrap;
}
- /**
- * Public constructor.
- */
- public SaveableState() {
- reset();
+ /**
+ * Public constructor.
+ */
+ public SaveableState() {
+ reset();
+ }
+ }
+
+ // ------------------------------------------------------------------------
+ // Constructors -----------------------------------------------------------
+ // ------------------------------------------------------------------------
+
+ /**
+ * 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
+ */
+ 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));
+ }
+
+ // 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));
}
}
/**
- * The current terminal state.
+ * Get visible cursor flag.
+ *
+ * @return if true, the cursor is visible
*/
- private SaveableState currentState;
+ public final boolean isCursorVisible() {
+ return cursorVisible;
+ }
/**
- * The last saved terminal state.
+ * 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
*/
- private SaveableState savedState;
+ 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.
@@ -867,6 +1094,11 @@ public class ECMA48 implements Runnable {
arrowKeyMode = ArrowKeyMode.ANSI;
keypadMode = KeypadMode.Numeric;
wrapLineFlag = false;
+ if (displayListener != null) {
+ width = displayListener.getDisplayWidth();
+ height = displayListener.getDisplayHeight();
+ rightMargin = width - 1;
+ }
// Flags
shiftOut = false;
@@ -894,52 +1126,6 @@ public class ECMA48 implements Runnable {
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.
- * @throws UnsupportedEncodingException if an exception is thrown when
- * creating the InputStreamReader
- */
- public ECMA48(final DeviceType type, final InputStream inputStream,
- final OutputStream outputStream) throws UnsupportedEncodingException {
-
- assert (inputStream != null);
- assert (outputStream != null);
-
- csiParams = new ArrayList();
- tabStops = new ArrayList();
- 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;
- }
-
- 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();
- }
-
/**
* Append a new line to the bottom of the display, adding lines off the
* top to the scrollback buffer.
@@ -1255,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.
*
@@ -1298,7 +1524,7 @@ public class ECMA48 implements Runnable {
return sb.toString();
}
- if (keypress.equals(kbBackspace)) {
+ if (keypress.equals(kbBackspaceDel)) {
switch (type) {
case VT100:
return "\010";
@@ -1311,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";
+ }
}
}
@@ -1500,6 +1834,9 @@ public class ECMA48 implements Runnable {
if (vt52Mode) {
return "\0332P";
}
+ if (type == DeviceType.XTERM) {
+ return "\0331;2P";
+ }
return "\033O2P";
}
@@ -1508,6 +1845,9 @@ public class ECMA48 implements Runnable {
if (vt52Mode) {
return "\0332Q";
}
+ if (type == DeviceType.XTERM) {
+ return "\0331;2Q";
+ }
return "\033O2Q";
}
@@ -1516,6 +1856,9 @@ public class ECMA48 implements Runnable {
if (vt52Mode) {
return "\0332R";
}
+ if (type == DeviceType.XTERM) {
+ return "\0331;2R";
+ }
return "\033O2R";
}
@@ -1524,6 +1867,9 @@ public class ECMA48 implements Runnable {
if (vt52Mode) {
return "\0332S";
}
+ if (type == DeviceType.XTERM) {
+ return "\0331;2S";
+ }
return "\033O2S";
}
@@ -1572,6 +1918,9 @@ public class ECMA48 implements Runnable {
if (vt52Mode) {
return "\0335P";
}
+ if (type == DeviceType.XTERM) {
+ return "\0331;5P";
+ }
return "\033O5P";
}
@@ -1580,6 +1929,9 @@ public class ECMA48 implements Runnable {
if (vt52Mode) {
return "\0335Q";
}
+ if (type == DeviceType.XTERM) {
+ return "\0331;5Q";
+ }
return "\033O5Q";
}
@@ -1588,6 +1940,9 @@ public class ECMA48 implements Runnable {
if (vt52Mode) {
return "\0335R";
}
+ if (type == DeviceType.XTERM) {
+ return "\0331;5R";
+ }
return "\033O5R";
}
@@ -1596,6 +1951,9 @@ public class ECMA48 implements Runnable {
if (vt52Mode) {
return "\0335S";
}
+ if (type == DeviceType.XTERM) {
+ return "\0331;5S";
+ }
return "\033O5S";
}
@@ -1639,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)) {
@@ -1690,6 +2058,17 @@ 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.isFnKey()) {
StringBuilder sb = new StringBuilder();
@@ -2266,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);
@@ -3523,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) == '?') {
@@ -3550,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
@@ -5762,83 +6154,4 @@ public class ECMA48 implements Runnable {
return currentState.cursorY;
}
- /**
- * 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];
- }
- }
-
- 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();
- }
-
}