Fix lag in TTerminalWindow
[fanfix.git] / src / jexer / TTerminalWindow.java
index 89280fd1d4d18d1b0a4ff0c05139dc916bb8c56a..af319c92d92ea3308037a998463a6c3f777e9a12 100644 (file)
@@ -30,15 +30,19 @@ package jexer;
 
 import java.io.IOException;
 import java.lang.reflect.Field;
+import java.text.MessageFormat;
 import java.util.LinkedList;
 import java.util.List;
 import java.util.Map;
+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;
@@ -50,6 +54,12 @@ import static jexer.TKeypress.*;
 public class TTerminalWindow extends TScrollableWindow
                              implements DisplayListener {
 
+
+    /**
+     * Translated strings.
+     */
+    private static final ResourceBundle i18n = ResourceBundle.getBundle(TTerminalWindow.class.getName());
+
     /**
      * The emulator.
      */
@@ -138,17 +148,11 @@ public class TTerminalWindow extends TScrollableWindow
     }
 
     /**
-     * Public constructor spawns a shell.
+     * Spawn the 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 commandLine the command line to execute
      */
-    public TTerminalWindow(final TApplication application, final int x,
-        final int y, final int flags) {
-
-        super(application, "Terminal", x, y, 80 + 2, 24 + 2, flags);
+    private void spawnShell(final String commandLine) {
 
         vScroller = new TVScroller(this, getWidth() - 2, 0, getHeight() - 2);
         setBottomValue(0);
@@ -157,43 +161,8 @@ public class TTerminalWindow extends TScrollableWindow
         ECMA48.DeviceType deviceType = ECMA48.DeviceType.XTERM;
 
         try {
-            String [] cmdShellWindows = {
-                "cmd.exe"
-            };
-
-            // You cannot run a login shell in a bare Process interactively,
-            // due to libc's behavior of buffering when stdin/stdout aren't a
-            // tty.  Use 'script' instead to run a shell in a pty.  And
-            // because BSD and GNU differ on the '-f' vs '-F' flags, we need
-            // two different commands.  Lovely.
-            String [] cmdShellGNU = {
-                "script", "-fqe", "/dev/null"
-            };
-            String [] cmdShellBSD = {
-                "script", "-q", "-F", "/dev/null"
-            };
-            String [] cmdShellPtypipe = {
-                "ptypipe", "/bin/bash", "--login"
-            };
-            // Spawn a shell and pass its I/O to the other constructor.
-
-            ProcessBuilder pb;
-            if ((System.getProperty("jexer.TTerminal.ptypipe") != null)
-                && (System.getProperty("jexer.TTerminal.ptypipe").
-                    equals("true"))
-            ) {
-                pb = new ProcessBuilder(cmdShellPtypipe);
-                ptypipe = true;
-            } else if (System.getProperty("os.name").startsWith("Windows")) {
-                pb = new ProcessBuilder(cmdShellWindows);
-            } else if (System.getProperty("os.name").startsWith("Mac")) {
-                pb = new ProcessBuilder(cmdShellBSD);
-            } else if (System.getProperty("os.name").startsWith("Linux")) {
-                pb = new ProcessBuilder(cmdShellGNU);
-            } else {
-                // When all else fails, assume GNU.
-                pb = new ProcessBuilder(cmdShellGNU);
-            }
+            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"));
@@ -202,10 +171,11 @@ public class TTerminalWindow extends TScrollableWindow
             pb.redirectErrorStream(true);
             shell = pb.start();
             emulator = new ECMA48(deviceType, shell.getInputStream(),
-                shell.getOutputStream());
-            emulator.setListener(this);
+                shell.getOutputStream(), this);
         } catch (IOException e) {
-            messageBox("Error", "Error launching shell: " + e.getMessage());
+            messageBox(i18n.getString("errorLaunchingShellTitle"),
+                MessageFormat.format(i18n.getString("errorLaunchingShellText"),
+                    e.getMessage()));
         }
 
         // Setup the scroll bars
@@ -216,7 +186,106 @@ public class TTerminalWindow extends TScrollableWindow
         addShortcutKeys();
 
         // Add shortcut text
-        newStatusBar("Terminal session executing...");
+        newStatusBar(i18n.getString("statusBarRunning"));
+    }
+
+    /**
+     * 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
+     */
+    public TTerminalWindow(final TApplication application, final int x,
+        final int y, final String commandLine) {
+
+        this(application, x, y, RESIZABLE, commandLine);
+    }
+
+    /**
+     * 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 commandLine the command line to execute
+     */
+    public TTerminalWindow(final TApplication application, final int x,
+        final int y, final int flags, final String commandLine) {
+
+        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;
+
+        // Spawn a shell and pass its I/O to the other constructor.
+        if ((System.getProperty("jexer.TTerminal.ptypipe") != null)
+            && (System.getProperty("jexer.TTerminal.ptypipe").
+                equals("true"))
+        ) {
+            ptypipe = true;
+            spawnShell(cmdShellPtypipe);
+        } else if (System.getProperty("os.name").startsWith("Windows")) {
+            spawnShell(cmdShellWindows);
+        } else if (System.getProperty("os.name").startsWith("Mac")) {
+            spawnShell(cmdShellBSD);
+        } else if (System.getProperty("os.name").startsWith("Linux")) {
+            spawnShell(cmdShellGNU);
+        } else {
+            // When all else fails, assume GNU.
+            spawnShell(cmdShellGNU);
+        }
+    }
+
+    /**
+     * 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
+     */
+    public TTerminalWindow(final TApplication application, final int x,
+        final int y, final int flags) {
+
+        super(application, i18n.getString("windowTitle"), x, y,
+            80 + 2, 24 + 2, flags);
+
+        String cmdShellWindows = "cmd.exe";
+
+        // You cannot run a login shell in a bare Process interactively, due
+        // to libc's behavior of buffering when stdin/stdout aren't a tty.
+        // Use 'script' instead to run a shell in a pty.  And because BSD and
+        // GNU differ on the '-f' vs '-F' flags, we need two different
+        // commands.  Lovely.
+        String cmdShellGNU = "script -fqe /dev/null";
+        String cmdShellBSD = "script -q -F /dev/null";
+
+        // ptypipe is another solution that permits dynamic window resizing.
+        String cmdShellPtypipe = "ptypipe /bin/bash --login";
+
+        // Spawn a shell and pass its I/O to the other constructor.
+        if ((System.getProperty("jexer.TTerminal.ptypipe") != null)
+            && (System.getProperty("jexer.TTerminal.ptypipe").
+                equals("true"))
+        ) {
+            ptypipe = true;
+            spawnShell(cmdShellPtypipe);
+        } else if (System.getProperty("os.name").startsWith("Windows")) {
+            spawnShell(cmdShellWindows);
+        } else if (System.getProperty("os.name").startsWith("Mac")) {
+            spawnShell(cmdShellBSD);
+        } else if (System.getProperty("os.name").startsWith("Linux")) {
+            spawnShell(cmdShellGNU);
+        } else {
+            // When all else fails, assume GNU.
+            spawnShell(cmdShellGNU);
+        }
     }
 
     /**
@@ -346,7 +415,31 @@ public class TTerminalWindow extends TScrollableWindow
      * Called by emulator when fresh data has come in.
      */
     public void displayChanged() {
-        doRepaint();
+        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;
     }
 
     /**
@@ -362,6 +455,13 @@ public class TTerminalWindow extends TScrollableWindow
         }
     }
 
+    /**
+     * Hook for subclasses to be notified of the shell termination.
+     */
+    public void onShellExit() {
+        getApplication().postEvent(new TMenuEvent(TMenu.MID_REPAINT));
+    }
+
     /**
      * Copy out variables from the emulator that TTerminal has to expose on
      * screen.
@@ -394,13 +494,14 @@ public class TTerminalWindow extends TScrollableWindow
                 try {
                     int rc = shell.exitValue();
                     // The emulator exited on its own, all is fine
-                    setTitle(String.format("%s [Completed - %d]",
-                            getTitle(), rc));
+                    setTitle(MessageFormat.format(i18n.
+                            getString("windowTitleCompleted"), getTitle(), rc));
                     shell = null;
                     emulator.close();
                     clearShortcutKeypresses();
-                    statusBar.setText("Terminal session completed, exit " +
-                        "code " + rc + ".");
+                    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
@@ -411,13 +512,14 @@ public class TTerminalWindow extends TScrollableWindow
                 try {
                     int rc = shell.exitValue();
                     // If we got here, the shell died.
-                    setTitle(String.format("%s [Completed - %d]",
-                            getTitle(), rc));
+                    setTitle(MessageFormat.format(i18n.
+                            getString("windowTitleCompleted"), getTitle(), rc));
                     shell = null;
                     emulator.close();
                     clearShortcutKeypresses();
-                    statusBar.setText("Terminal session completed, exit " +
-                        "code " + rc + ".");
+                    statusBar.setText(MessageFormat.format(i18n.
+                            getString("statusBarCompleted"), rc));
+                    onShellExit();
                 } catch (IllegalThreadStateException e) {
                     // The shell is still running, do nothing.
                 }