retrofit from GJexer
[nikiroo-utils.git] / src / jexer / TTerminalWindow.java
index 31834eebc2324bc02f9e7261277d3994a108ca1b..b55e7b05bc1137600ea337cb71acc2ba29976b87 100644 (file)
@@ -3,7 +3,7 @@
  *
  * The MIT License (MIT)
  *
- * Copyright (C) 2017 Kevin Lamonte
+ * Copyright (C) 2019 Kevin Lamonte
  *
  * Permission is hereby granted, free of charge, to any person obtaining a
  * copy of this software and associated documentation files (the "Software"),
@@ -31,7 +31,7 @@ package jexer;
 import java.io.IOException;
 import java.lang.reflect.Field;
 import java.text.MessageFormat;
-import java.util.LinkedList;
+import java.util.ArrayList;
 import java.util.List;
 import java.util.Map;
 import java.util.ResourceBundle;
@@ -39,8 +39,10 @@ import java.util.ResourceBundle;
 import jexer.bits.Cell;
 import jexer.bits.CellAttributes;
 import jexer.event.TKeypressEvent;
+import jexer.event.TMenuEvent;
 import jexer.event.TMouseEvent;
 import jexer.event.TResizeEvent;
+import jexer.menu.TMenu;
 import jexer.tterminal.DisplayLine;
 import jexer.tterminal.DisplayListener;
 import jexer.tterminal.ECMA48;
@@ -58,6 +60,10 @@ public class TTerminalWindow extends TScrollableWindow
      */
     private static final ResourceBundle i18n = ResourceBundle.getBundle(TTerminalWindow.class.getName());
 
+    // ------------------------------------------------------------------------
+    // Variables --------------------------------------------------------------
+    // ------------------------------------------------------------------------
+
     /**
      * The emulator.
      */
@@ -71,120 +77,66 @@ public class TTerminalWindow extends TScrollableWindow
     /**
      * If true, we are using the ptypipe utility to support dynamic window
      * resizing.  ptypipe is available at
-     * https://github.com/klamonte/ptypipe .
+     * https://gitlab.com/klamonte/ptypipe .
      */
     private boolean ptypipe = false;
 
     /**
-     * Claim the keystrokes the emulator will need.
+     * If true, close the window when the shell exits.
      */
-    private void addShortcutKeys() {
-        addShortcutKeypress(kbCtrlA);
-        addShortcutKeypress(kbCtrlB);
-        addShortcutKeypress(kbCtrlC);
-        addShortcutKeypress(kbCtrlD);
-        addShortcutKeypress(kbCtrlE);
-        addShortcutKeypress(kbCtrlF);
-        addShortcutKeypress(kbCtrlG);
-        addShortcutKeypress(kbCtrlH);
-        addShortcutKeypress(kbCtrlU);
-        addShortcutKeypress(kbCtrlJ);
-        addShortcutKeypress(kbCtrlK);
-        addShortcutKeypress(kbCtrlL);
-        addShortcutKeypress(kbCtrlM);
-        addShortcutKeypress(kbCtrlN);
-        addShortcutKeypress(kbCtrlO);
-        addShortcutKeypress(kbCtrlP);
-        addShortcutKeypress(kbCtrlQ);
-        addShortcutKeypress(kbCtrlR);
-        addShortcutKeypress(kbCtrlS);
-        addShortcutKeypress(kbCtrlT);
-        addShortcutKeypress(kbCtrlU);
-        addShortcutKeypress(kbCtrlV);
-        addShortcutKeypress(kbCtrlW);
-        addShortcutKeypress(kbCtrlX);
-        addShortcutKeypress(kbCtrlY);
-        addShortcutKeypress(kbCtrlZ);
-        addShortcutKeypress(kbF1);
-        addShortcutKeypress(kbF2);
-        addShortcutKeypress(kbF3);
-        addShortcutKeypress(kbF4);
-        addShortcutKeypress(kbF5);
-        addShortcutKeypress(kbF6);
-        addShortcutKeypress(kbF7);
-        addShortcutKeypress(kbF8);
-        addShortcutKeypress(kbF9);
-        addShortcutKeypress(kbF10);
-        addShortcutKeypress(kbF11);
-        addShortcutKeypress(kbF12);
-        addShortcutKeypress(kbAltA);
-        addShortcutKeypress(kbAltB);
-        addShortcutKeypress(kbAltC);
-        addShortcutKeypress(kbAltD);
-        addShortcutKeypress(kbAltE);
-        addShortcutKeypress(kbAltF);
-        addShortcutKeypress(kbAltG);
-        addShortcutKeypress(kbAltH);
-        addShortcutKeypress(kbAltU);
-        addShortcutKeypress(kbAltJ);
-        addShortcutKeypress(kbAltK);
-        addShortcutKeypress(kbAltL);
-        addShortcutKeypress(kbAltM);
-        addShortcutKeypress(kbAltN);
-        addShortcutKeypress(kbAltO);
-        addShortcutKeypress(kbAltP);
-        addShortcutKeypress(kbAltQ);
-        addShortcutKeypress(kbAltR);
-        addShortcutKeypress(kbAltS);
-        addShortcutKeypress(kbAltT);
-        addShortcutKeypress(kbAltU);
-        addShortcutKeypress(kbAltV);
-        addShortcutKeypress(kbAltW);
-        addShortcutKeypress(kbAltX);
-        addShortcutKeypress(kbAltY);
-        addShortcutKeypress(kbAltZ);
-    }
+    private boolean closeOnExit = false;
+
+    // ------------------------------------------------------------------------
+    // Constructors -----------------------------------------------------------
+    // ------------------------------------------------------------------------
 
     /**
-     * Spawn the shell.
+     * Public constructor spawns a custom command line.
      *
+     * @param application TApplication that manages this window
+     * @param x column relative to parent
+     * @param y row relative to parent
      * @param commandLine the command line to execute
      */
-    private void spawnShell(final String commandLine) {
-
-        vScroller = new TVScroller(this, getWidth() - 2, 0, getHeight() - 2);
-        setBottomValue(0);
+    public TTerminalWindow(final TApplication application, final int x,
+        final int y, final String commandLine) {
 
-        // Assume XTERM
-        ECMA48.DeviceType deviceType = ECMA48.DeviceType.XTERM;
+        this(application, x, y, RESIZABLE, commandLine.split("\\s+"),
+            System.getProperty("jexer.TTerminal.closeOnExit",
+                "false").equals("true"));
+    }
 
-        try {
-            String [] command = commandLine.split("\\s");
-            ProcessBuilder pb = new ProcessBuilder(command);
-            Map<String, String> env = pb.environment();
-            env.put("TERM", ECMA48.deviceTypeTerm(deviceType));
-            env.put("LANG", ECMA48.deviceTypeLang(deviceType, "en"));
-            env.put("COLUMNS", "80");
-            env.put("LINES", "24");
-            pb.redirectErrorStream(true);
-            shell = pb.start();
-            emulator = new ECMA48(deviceType, shell.getInputStream(),
-                shell.getOutputStream(), this);
-        } catch (IOException e) {
-            messageBox(i18n.getString("errorLaunchingShellTitle"),
-                MessageFormat.format(i18n.getString("errorLaunchingShellText"),
-                    e.getMessage()));
-        }
+    /**
+     * Public constructor spawns a custom command line.
+     *
+     * @param application TApplication that manages this window
+     * @param x column relative to parent
+     * @param y row relative to parent
+     * @param commandLine the command line to execute
+     * @param closeOnExit if true, close the window when the command exits
+     */
+    public TTerminalWindow(final TApplication application, final int x,
+        final int y, final String commandLine, final boolean closeOnExit) {
 
-        // Setup the scroll bars
-        onResize(new TResizeEvent(TResizeEvent.Type.WIDGET, getWidth(),
-                getHeight()));
+        this(application, x, y, RESIZABLE, commandLine.split("\\s+"),
+            closeOnExit);
+    }
 
-        // Claim the keystrokes the emulator will need.
-        addShortcutKeys();
+    /**
+     * Public constructor spawns a custom command line.
+     *
+     * @param application TApplication that manages this window
+     * @param x column relative to parent
+     * @param y row relative to parent
+     * @param flags mask of CENTERED, MODAL, or RESIZABLE
+     * @param command the command line to execute
+     */
+    public TTerminalWindow(final TApplication application, final int x,
+        final int y, final int flags, final String [] command) {
 
-        // Add shortcut text
-        newStatusBar(i18n.getString("statusBarRunning"));
+        this(application, x, y, flags, command,
+            System.getProperty("jexer.TTerminal.closeOnExit",
+                "false").equals("true"));
     }
 
     /**
@@ -194,18 +146,19 @@ public class TTerminalWindow extends TScrollableWindow
      * @param x column relative to parent
      * @param y row relative to parent
      * @param flags mask of CENTERED, MODAL, or RESIZABLE
-     * @param commandLine the command line to execute
+     * @param command the command line to execute
+     * @param closeOnExit if true, close the window when the command exits
      */
     public TTerminalWindow(final TApplication application, final int x,
-        final int y, final int flags, final String commandLine) {
+        final int y, final int flags, final String [] command,
+        final boolean closeOnExit) {
 
         super(application, i18n.getString("windowTitle"), x, y,
             80 + 2, 24 + 2, flags);
 
-        String cmdShellWindows = "cmd.exe /c" + commandLine;
-        String cmdShellGNU = "script -fqe /dev/null -c " + commandLine;
-        String cmdShellBSD = "script -q -F /dev/null -c " + commandLine;
-        String cmdShellPtypipe = "ptypipe " + commandLine;
+        this.closeOnExit = closeOnExit;
+
+        String [] fullCommand;
 
         // Spawn a shell and pass its I/O to the other constructor.
         if ((System.getProperty("jexer.TTerminal.ptypipe") != null)
@@ -213,17 +166,32 @@ public class TTerminalWindow extends TScrollableWindow
                 equals("true"))
         ) {
             ptypipe = true;
-            spawnShell(cmdShellPtypipe);
+            fullCommand = new String[command.length + 1];
+            fullCommand[0] = "ptypipe";
+            System.arraycopy(command, 0, fullCommand, 1, command.length);
         } else if (System.getProperty("os.name").startsWith("Windows")) {
-            spawnShell(cmdShellWindows);
+            fullCommand = new String[3];
+            fullCommand[0] = "cmd";
+            fullCommand[1] = "/c";
+            fullCommand[2] = stringArrayToString(command);
         } else if (System.getProperty("os.name").startsWith("Mac")) {
-            spawnShell(cmdShellBSD);
-        } else if (System.getProperty("os.name").startsWith("Linux")) {
-            spawnShell(cmdShellGNU);
+            fullCommand = new String[6];
+            fullCommand[0] = "script";
+            fullCommand[1] = "-q";
+            fullCommand[2] = "-F";
+            fullCommand[3] = "/dev/null";
+            fullCommand[4] = "-c";
+            fullCommand[5] = stringArrayToString(command);
         } else {
-            // When all else fails, assume GNU.
-            spawnShell(cmdShellGNU);
+            // Default: behave like Linux
+            fullCommand = new String[5];
+            fullCommand[0] = "script";
+            fullCommand[1] = "-fqe";
+            fullCommand[2] = "/dev/null";
+            fullCommand[3] = "-c";
+            fullCommand[4] = stringArrayToString(command);
         }
+        spawnShell(fullCommand);
     }
 
     /**
@@ -237,9 +205,29 @@ public class TTerminalWindow extends TScrollableWindow
     public TTerminalWindow(final TApplication application, final int x,
         final int y, final int flags) {
 
+        this(application, x, y, flags,
+            System.getProperty("jexer.TTerminal.closeOnExit",
+                "false").equals("true"));
+
+    }
+
+    /**
+     * Public constructor spawns a shell.
+     *
+     * @param application TApplication that manages this window
+     * @param x column relative to parent
+     * @param y row relative to parent
+     * @param flags mask of CENTERED, MODAL, or RESIZABLE
+     * @param closeOnExit if true, close the window when the shell exits
+     */
+    public TTerminalWindow(final TApplication application, final int x,
+        final int y, final int flags, final boolean closeOnExit) {
+
         super(application, i18n.getString("windowTitle"), x, y,
             80 + 2, 24 + 2, flags);
 
+        this.closeOnExit = closeOnExit;
+
         String cmdShellWindows = "cmd.exe";
 
         // You cannot run a login shell in a bare Process interactively, due
@@ -259,51 +247,22 @@ public class TTerminalWindow extends TScrollableWindow
                 equals("true"))
         ) {
             ptypipe = true;
-            spawnShell(cmdShellPtypipe);
+            spawnShell(cmdShellPtypipe.split("\\s+"));
         } else if (System.getProperty("os.name").startsWith("Windows")) {
-            spawnShell(cmdShellWindows);
+            spawnShell(cmdShellWindows.split("\\s+"));
         } else if (System.getProperty("os.name").startsWith("Mac")) {
-            spawnShell(cmdShellBSD);
+            spawnShell(cmdShellBSD.split("\\s+"));
         } else if (System.getProperty("os.name").startsWith("Linux")) {
-            spawnShell(cmdShellGNU);
+            spawnShell(cmdShellGNU.split("\\s+"));
         } else {
             // When all else fails, assume GNU.
-            spawnShell(cmdShellGNU);
+            spawnShell(cmdShellGNU.split("\\s+"));
         }
     }
 
-    /**
-     * Terminate the child of the 'script' process used on POSIX.  This may
-     * or may not work.
-     */
-    private void terminateShellChildProcess() {
-        int pid = -1;
-        if (shell.getClass().getName().equals("java.lang.UNIXProcess")) {
-            /* get the PID on unix/linux systems */
-            try {
-                Field field = shell.getClass().getDeclaredField("pid");
-                field.setAccessible(true);
-                pid = field.getInt(shell);
-            } catch (Throwable e) {
-                // SQUASH, this didn't work.  Just bail out quietly.
-                return;
-            }
-        }
-        if (pid != -1) {
-            // shell.destroy() works successfully at killing this side of
-            // 'script'.  But we need to make sure the other side (child
-            // process) is also killed.
-            String [] cmdKillIt = {
-                "pkill", "-P", Integer.toString(pid)
-            };
-            try {
-                Runtime.getRuntime().exec(cmdKillIt);
-            } catch (Throwable e) {
-                // SQUASH, this didn't work.  Just bail out quietly.
-                return;
-            }
-        }
-    }
+    // ------------------------------------------------------------------------
+    // TScrollableWindow ------------------------------------------------------
+    // ------------------------------------------------------------------------
 
     /**
      * Draw the display buffer.
@@ -329,7 +288,7 @@ public class TTerminalWindow extends TScrollableWindow
                 + getVerticalValue();
             assert (visibleBottom >= 0);
 
-            List<DisplayLine> preceedingBlankLines = new LinkedList<DisplayLine>();
+            List<DisplayLine> preceedingBlankLines = new ArrayList<DisplayLine>();
             int visibleTop = visibleBottom - visibleHeight;
             if (visibleTop < 0) {
                 for (int i = visibleTop; i < 0; i++) {
@@ -339,11 +298,11 @@ public class TTerminalWindow extends TScrollableWindow
             }
             assert (visibleTop >= 0);
 
-            List<DisplayLine> displayLines = new LinkedList<DisplayLine>();
+            List<DisplayLine> displayLines = new ArrayList<DisplayLine>();
             displayLines.addAll(scrollback);
             displayLines.addAll(display);
 
-            List<DisplayLine> visibleLines = new LinkedList<DisplayLine>();
+            List<DisplayLine> visibleLines = new ArrayList<DisplayLine>();
             visibleLines.addAll(preceedingBlankLines);
             visibleLines.addAll(displayLines.subList(visibleTop,
                     visibleBottom));
@@ -368,14 +327,24 @@ public class TTerminalWindow extends TScrollableWindow
                     boolean reverse = line.isReverseColor() ^ ch.isReverse();
                     newCell.setReverse(false);
                     if (reverse) {
-                        newCell.setBackColor(ch.getForeColor());
-                        newCell.setForeColor(ch.getBackColor());
+                        if (ch.getForeColorRGB() < 0) {
+                            newCell.setBackColor(ch.getForeColor());
+                            newCell.setBackColorRGB(-1);
+                        } else {
+                            newCell.setBackColorRGB(ch.getForeColorRGB());
+                        }
+                        if (ch.getBackColorRGB() < 0) {
+                            newCell.setForeColor(ch.getBackColor());
+                            newCell.setForeColorRGB(-1);
+                        } else {
+                            newCell.setForeColorRGB(ch.getBackColorRGB());
+                        }
                     }
                     if (line.isDoubleWidth()) {
-                        getScreen().putCharXY((i * 2) + 1, row, newCell);
-                        getScreen().putCharXY((i * 2) + 2, row, ' ', newCell);
+                        putCharXY((i * 2) + 1, row, newCell);
+                        putCharXY((i * 2) + 2, row, ' ', newCell);
                     } else {
-                        getScreen().putCharXY(i + 1, row, newCell);
+                        putCharXY(i + 1, row, newCell);
                     }
                 }
                 row++;
@@ -387,45 +356,13 @@ public class TTerminalWindow extends TScrollableWindow
             CellAttributes background = new CellAttributes();
             // Fill in the blank lines on bottom
             for (int i = 0; i < visibleHeight; i++) {
-                getScreen().hLineXY(1, i + row, getWidth() - 2, ' ',
-                    background);
+                hLineXY(1, i + row, getWidth() - 2, ' ', background);
             }
 
         } // synchronized (emulator)
 
     }
 
-    /**
-     * Called by emulator when fresh data has come in.
-     */
-    public void displayChanged() {
-        doRepaint();
-    }
-
-    /**
-     * Function to call to obtain the display width.
-     *
-     * @return the number of columns in the display
-     */
-    public int getDisplayWidth() {
-        if (ptypipe) {
-            return getWidth() - 2;
-        }
-        return 80;
-    }
-
-    /**
-     * Function to call to obtain the display height.
-     *
-     * @return the number of rows in the display
-     */
-    public int getDisplayHeight() {
-        if (ptypipe) {
-            return getHeight() - 2;
-        }
-        return 24;
-    }
-
     /**
      * Handle window close.
      */
@@ -440,98 +377,34 @@ public class TTerminalWindow extends TScrollableWindow
     }
 
     /**
-     * Copy out variables from the emulator that TTerminal has to expose on
-     * screen.
+     * Handle window/screen resize events.
+     *
+     * @param resize resize event
      */
-    private void readEmulatorState() {
+    @Override
+    public void onResize(final TResizeEvent resize) {
+
         // Synchronize against the emulator so we don't stomp on its reader
         // thread.
         synchronized (emulator) {
 
-            setCursorX(emulator.getCursorX() + 1);
-            setCursorY(emulator.getCursorY() + 1
-                + (getHeight() - 2 - emulator.getHeight())
-                - getVerticalValue());
-            setCursorVisible(emulator.isCursorVisible());
-            if (getCursorX() > getWidth() - 2) {
-                setCursorVisible(false);
-            }
-            if ((getCursorY() > getHeight() - 2) || (getCursorY() < 0)) {
-                setCursorVisible(false);
-            }
-            if (emulator.getScreenTitle().length() > 0) {
-                // Only update the title if the shell is still alive
-                if (shell != null) {
-                    setTitle(emulator.getScreenTitle());
+            if (resize.getType() == TResizeEvent.Type.WIDGET) {
+                // Resize the scroll bars
+                reflowData();
+                placeScrollbars();
+
+                // Get out of scrollback
+                setVerticalValue(0);
+
+                if (ptypipe) {
+                    emulator.setWidth(getWidth() - 2);
+                    emulator.setHeight(getHeight() - 2);
+
+                    emulator.writeRemote("\033[8;" + (getHeight() - 2) + ";" +
+                        (getWidth() - 2) + "t");
                 }
             }
-
-            // Check to see if the shell has died.
-            if (!emulator.isReading() && (shell != null)) {
-                try {
-                    int rc = shell.exitValue();
-                    // The emulator exited on its own, all is fine
-                    setTitle(MessageFormat.format(i18n.
-                            getString("windowTitleCompleted"), getTitle(), rc));
-                    shell = null;
-                    emulator.close();
-                    clearShortcutKeypresses();
-                    statusBar.setText(MessageFormat.format(i18n.
-                            getString("statusBarCompleted"), rc));
-                } catch (IllegalThreadStateException e) {
-                    // The emulator thread has exited, but the shell Process
-                    // hasn't figured that out yet.  Do nothing, we will see
-                    // this in a future tick.
-                }
-            } else if (emulator.isReading() && (shell != null)) {
-                // The shell might be dead, let's check
-                try {
-                    int rc = shell.exitValue();
-                    // If we got here, the shell died.
-                    setTitle(MessageFormat.format(i18n.
-                            getString("windowTitleCompleted"), getTitle(), rc));
-                    shell = null;
-                    emulator.close();
-                    clearShortcutKeypresses();
-                    statusBar.setText(MessageFormat.format(i18n.
-                            getString("statusBarCompleted"), rc));
-                } catch (IllegalThreadStateException e) {
-                    // The shell is still running, do nothing.
-                }
-            }
-
-        } // synchronized (emulator)
-    }
-
-    /**
-     * Handle window/screen resize events.
-     *
-     * @param resize resize event
-     */
-    @Override
-    public void onResize(final TResizeEvent resize) {
-
-        // Synchronize against the emulator so we don't stomp on its reader
-        // thread.
-        synchronized (emulator) {
-
-            if (resize.getType() == TResizeEvent.Type.WIDGET) {
-                // Resize the scroll bars
-                reflowData();
-                placeScrollbars();
-
-                // Get out of scrollback
-                setVerticalValue(0);
-
-                if (ptypipe) {
-                    emulator.setWidth(getWidth() - 2);
-                    emulator.setHeight(getHeight() - 2);
-
-                    emulator.writeRemote("\033[8;" + (getHeight() - 2) + ";" +
-                        (getWidth() - 2) + "t");
-                }
-            }
-            return;
+            return;
 
         } // synchronized (emulator)
     }
@@ -558,31 +431,6 @@ public class TTerminalWindow extends TScrollableWindow
         } // synchronized (emulator)
     }
 
-    /**
-     * Check if a mouse press/release/motion event coordinate is over the
-     * emulator.
-     *
-     * @param mouse a mouse-based event
-     * @return whether or not the mouse is on the emulator
-     */
-    private final boolean mouseOnEmulator(final TMouseEvent mouse) {
-
-        synchronized (emulator) {
-            if (!emulator.isReading()) {
-                return false;
-            }
-        }
-
-        if ((mouse.getAbsoluteX() >= getAbsoluteX() + 1)
-            && (mouse.getAbsoluteX() <  getAbsoluteX() + getWidth() - 1)
-            && (mouse.getAbsoluteY() >= getAbsoluteY() + 1)
-            && (mouse.getAbsoluteY() <  getAbsoluteY() + getHeight() - 1)
-        ) {
-            return true;
-        }
-        return false;
-    }
-
     /**
      * Handle keystrokes.
      *
@@ -721,4 +569,307 @@ public class TTerminalWindow extends TScrollableWindow
         super.onMouseMotion(mouse);
     }
 
+    // ------------------------------------------------------------------------
+    // TTerminalWindow --------------------------------------------------------
+    // ------------------------------------------------------------------------
+
+    /**
+     * Claim the keystrokes the emulator will need.
+     */
+    private void addShortcutKeys() {
+        addShortcutKeypress(kbCtrlA);
+        addShortcutKeypress(kbCtrlB);
+        addShortcutKeypress(kbCtrlC);
+        addShortcutKeypress(kbCtrlD);
+        addShortcutKeypress(kbCtrlE);
+        addShortcutKeypress(kbCtrlF);
+        addShortcutKeypress(kbCtrlG);
+        addShortcutKeypress(kbCtrlH);
+        addShortcutKeypress(kbCtrlU);
+        addShortcutKeypress(kbCtrlJ);
+        addShortcutKeypress(kbCtrlK);
+        addShortcutKeypress(kbCtrlL);
+        addShortcutKeypress(kbCtrlM);
+        addShortcutKeypress(kbCtrlN);
+        addShortcutKeypress(kbCtrlO);
+        addShortcutKeypress(kbCtrlP);
+        addShortcutKeypress(kbCtrlQ);
+        addShortcutKeypress(kbCtrlR);
+        addShortcutKeypress(kbCtrlS);
+        addShortcutKeypress(kbCtrlT);
+        addShortcutKeypress(kbCtrlU);
+        addShortcutKeypress(kbCtrlV);
+        addShortcutKeypress(kbCtrlW);
+        addShortcutKeypress(kbCtrlX);
+        addShortcutKeypress(kbCtrlY);
+        addShortcutKeypress(kbCtrlZ);
+        addShortcutKeypress(kbF1);
+        addShortcutKeypress(kbF2);
+        addShortcutKeypress(kbF3);
+        addShortcutKeypress(kbF4);
+        addShortcutKeypress(kbF5);
+        addShortcutKeypress(kbF6);
+        addShortcutKeypress(kbF7);
+        addShortcutKeypress(kbF8);
+        addShortcutKeypress(kbF9);
+        addShortcutKeypress(kbF10);
+        addShortcutKeypress(kbF11);
+        addShortcutKeypress(kbF12);
+        addShortcutKeypress(kbAltA);
+        addShortcutKeypress(kbAltB);
+        addShortcutKeypress(kbAltC);
+        addShortcutKeypress(kbAltD);
+        addShortcutKeypress(kbAltE);
+        addShortcutKeypress(kbAltF);
+        addShortcutKeypress(kbAltG);
+        addShortcutKeypress(kbAltH);
+        addShortcutKeypress(kbAltU);
+        addShortcutKeypress(kbAltJ);
+        addShortcutKeypress(kbAltK);
+        addShortcutKeypress(kbAltL);
+        addShortcutKeypress(kbAltM);
+        addShortcutKeypress(kbAltN);
+        addShortcutKeypress(kbAltO);
+        addShortcutKeypress(kbAltP);
+        addShortcutKeypress(kbAltQ);
+        addShortcutKeypress(kbAltR);
+        addShortcutKeypress(kbAltS);
+        addShortcutKeypress(kbAltT);
+        addShortcutKeypress(kbAltU);
+        addShortcutKeypress(kbAltV);
+        addShortcutKeypress(kbAltW);
+        addShortcutKeypress(kbAltX);
+        addShortcutKeypress(kbAltY);
+        addShortcutKeypress(kbAltZ);
+    }
+
+    /**
+     * Convert a string array to a whitespace-separated string.
+     *
+     * @param array the string array
+     * @return a single string
+     */
+    private String stringArrayToString(final String [] array) {
+        StringBuilder sb = new StringBuilder(array[0].length());
+        for (int i = 0; i < array.length; i++) {
+            sb.append(array[i]);
+            if (i < array.length - 1) {
+                sb.append(' ');
+            }
+        }
+        return sb.toString();
+    }
+
+    /**
+     * Spawn the shell.
+     *
+     * @param command the command line to execute
+     */
+    private void spawnShell(final String [] command) {
+
+        /*
+        System.err.printf("spawnShell(): '%s'\n",
+            stringArrayToString(command));
+        */
+
+        vScroller = new TVScroller(this, getWidth() - 2, 0, getHeight() - 2);
+        setBottomValue(0);
+
+        // Assume XTERM
+        ECMA48.DeviceType deviceType = ECMA48.DeviceType.XTERM;
+
+        try {
+            ProcessBuilder pb = new ProcessBuilder(command);
+            Map<String, String> env = pb.environment();
+            env.put("TERM", ECMA48.deviceTypeTerm(deviceType));
+            env.put("LANG", ECMA48.deviceTypeLang(deviceType, "en"));
+            env.put("COLUMNS", "80");
+            env.put("LINES", "24");
+            pb.redirectErrorStream(true);
+            shell = pb.start();
+            emulator = new ECMA48(deviceType, shell.getInputStream(),
+                shell.getOutputStream(), this);
+        } catch (IOException e) {
+            messageBox(i18n.getString("errorLaunchingShellTitle"),
+                MessageFormat.format(i18n.getString("errorLaunchingShellText"),
+                    e.getMessage()));
+        }
+
+        // Setup the scroll bars
+        onResize(new TResizeEvent(TResizeEvent.Type.WIDGET, getWidth(),
+                getHeight()));
+
+        // Claim the keystrokes the emulator will need.
+        addShortcutKeys();
+
+        // Add shortcut text
+        newStatusBar(i18n.getString("statusBarRunning"));
+    }
+
+    /**
+     * Terminate the child of the 'script' process used on POSIX.  This may
+     * or may not work.
+     */
+    private void terminateShellChildProcess() {
+        int pid = -1;
+        if (shell.getClass().getName().equals("java.lang.UNIXProcess")) {
+            /* get the PID on unix/linux systems */
+            try {
+                Field field = shell.getClass().getDeclaredField("pid");
+                field.setAccessible(true);
+                pid = field.getInt(shell);
+            } catch (Throwable e) {
+                // SQUASH, this didn't work.  Just bail out quietly.
+                return;
+            }
+        }
+        if (pid != -1) {
+            // shell.destroy() works successfully at killing this side of
+            // 'script'.  But we need to make sure the other side (child
+            // process) is also killed.
+            String [] cmdKillIt = {
+                "pkill", "-P", Integer.toString(pid)
+            };
+            try {
+                Runtime.getRuntime().exec(cmdKillIt);
+            } catch (Throwable e) {
+                // SQUASH, this didn't work.  Just bail out quietly.
+                return;
+            }
+        }
+    }
+
+    /**
+     * Called by emulator when fresh data has come in.
+     */
+    public void displayChanged() {
+        getApplication().postEvent(new TMenuEvent(TMenu.MID_REPAINT));
+    }
+
+    /**
+     * Function to call to obtain the display width.
+     *
+     * @return the number of columns in the display
+     */
+    public int getDisplayWidth() {
+        if (ptypipe) {
+            return getWidth() - 2;
+        }
+        return 80;
+    }
+
+    /**
+     * Function to call to obtain the display height.
+     *
+     * @return the number of rows in the display
+     */
+    public int getDisplayHeight() {
+        if (ptypipe) {
+            return getHeight() - 2;
+        }
+        return 24;
+    }
+
+    /**
+     * Hook for subclasses to be notified of the shell termination.
+     */
+    public void onShellExit() {
+        if (closeOnExit) {
+            close();
+        }
+        getApplication().postEvent(new TMenuEvent(TMenu.MID_REPAINT));
+    }
+
+    /**
+     * Copy out variables from the emulator that TTerminal has to expose on
+     * screen.
+     */
+    private void readEmulatorState() {
+        // Synchronize against the emulator so we don't stomp on its reader
+        // thread.
+        synchronized (emulator) {
+            setHiddenMouse(emulator.hasHiddenMousePointer());
+            
+            setCursorX(emulator.getCursorX() + 1);
+            setCursorY(emulator.getCursorY() + 1
+                + (getHeight() - 2 - emulator.getHeight())
+                - getVerticalValue());
+            setCursorVisible(emulator.isCursorVisible());
+            if (getCursorX() > getWidth() - 2) {
+                setCursorVisible(false);
+            }
+            if ((getCursorY() > getHeight() - 2) || (getCursorY() < 0)) {
+                setCursorVisible(false);
+            }
+            if (emulator.getScreenTitle().length() > 0) {
+                // Only update the title if the shell is still alive
+                if (shell != null) {
+                    setTitle(emulator.getScreenTitle());
+                }
+            }
+
+            // Check to see if the shell has died.
+            if (!emulator.isReading() && (shell != null)) {
+                try {
+                    int rc = shell.exitValue();
+                    // The emulator exited on its own, all is fine
+                    setTitle(MessageFormat.format(i18n.
+                            getString("windowTitleCompleted"), getTitle(), rc));
+                    shell = null;
+                    emulator.close();
+                    clearShortcutKeypresses();
+                    statusBar.setText(MessageFormat.format(i18n.
+                            getString("statusBarCompleted"), rc));
+                    onShellExit();
+                } catch (IllegalThreadStateException e) {
+                    // The emulator thread has exited, but the shell Process
+                    // hasn't figured that out yet.  Do nothing, we will see
+                    // this in a future tick.
+                }
+            } else if (emulator.isReading() && (shell != null)) {
+                // The shell might be dead, let's check
+                try {
+                    int rc = shell.exitValue();
+                    // If we got here, the shell died.
+                    setTitle(MessageFormat.format(i18n.
+                            getString("windowTitleCompleted"), getTitle(), rc));
+                    shell = null;
+                    emulator.close();
+                    clearShortcutKeypresses();
+                    statusBar.setText(MessageFormat.format(i18n.
+                            getString("statusBarCompleted"), rc));
+                    onShellExit();
+                } catch (IllegalThreadStateException e) {
+                    // The shell is still running, do nothing.
+                }
+            }
+
+        } // synchronized (emulator)
+    }
+
+    /**
+     * Check if a mouse press/release/motion event coordinate is over the
+     * emulator.
+     *
+     * @param mouse a mouse-based event
+     * @return whether or not the mouse is on the emulator
+     */
+    private final boolean mouseOnEmulator(final TMouseEvent mouse) {
+
+        synchronized (emulator) {
+            if (!emulator.isReading()) {
+                return false;
+            }
+        }
+
+        if ((mouse.getAbsoluteX() >= getAbsoluteX() + 1)
+            && (mouse.getAbsoluteX() <  getAbsoluteX() + getWidth() - 1)
+            && (mouse.getAbsoluteY() >= getAbsoluteY() + 1)
+            && (mouse.getAbsoluteY() <  getAbsoluteY() + getHeight() - 1)
+        ) {
+            return true;
+        }
+        return false;
+    }
+
 }