-/**
+/*
* 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;
-import java.io.InputStream;
import java.io.IOException;
-import java.io.OutputStream;
-import java.io.UnsupportedEncodingException;
+import java.lang.reflect.Field;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;
/**
* TTerminalWindow exposes a ECMA-48 / ANSI X3.64 style terminal in a window.
*/
-public class TTerminalWindow extends TWindow {
+public class TTerminalWindow extends TScrollableWindow {
/**
* The emulator.
private Process shell;
/**
- * Vertical scrollbar.
+ * Claim the keystrokes the emulator will need.
*/
- private TVScroller vScroller;
+ 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);
+ }
/**
* Public constructor spawns a shell.
super(application, "Terminal", x, y, 80 + 2, 24 + 2, flags);
+ vScroller = new TVScroller(this, getWidth() - 2, 0, getHeight() - 2);
+ setBottomValue(0);
+
// Assume XTERM
ECMA48.DeviceType deviceType = ECMA48.DeviceType.XTERM;
// 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.
- String [] cmdShell = {
+ // 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"
+ };
// Spawn a shell and pass its I/O to the other constructor.
ProcessBuilder pb;
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 {
- pb = new ProcessBuilder(cmdShell);
+ // When all else fails, assume GNU.
+ pb = new ProcessBuilder(cmdShellGNU);
}
Map<String, String> env = pb.environment();
env.put("TERM", ECMA48.deviceTypeTerm(deviceType));
emulator = new ECMA48(deviceType, shell.getInputStream(),
shell.getOutputStream());
} catch (IOException e) {
- e.printStackTrace();
+ messageBox("Error", "Error launching shell: " + 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("Terminal session executing...");
}
/**
- * Public constructor.
- *
- * @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 input an InputStream connected to the remote side. For type ==
- * XTERM, input is converted to a Reader with UTF-8 encoding.
- * @param output an OutputStream connected to the remote user. For type
- * == XTERM, output is converted to a Writer with UTF-8 encoding.
- * @throws UnsupportedEncodingException if an exception is thrown when
- * creating the InputStreamReader
+ * Terminate the child of the 'script' process used on POSIX. This may
+ * or may not work.
*/
- public TTerminalWindow(final TApplication application, final int x,
- final int y, final int flags, final InputStream input,
- final OutputStream output) throws UnsupportedEncodingException {
-
- super(application, "Terminal", x, y, 80 + 2, 24 + 2, flags);
-
- emulator = new ECMA48(ECMA48.DeviceType.XTERM, input, output);
-
- // Setup the scroll bars
- onResize(new TResizeEvent(TResizeEvent.Type.WIDGET, getWidth(),
- getHeight()));
-
+ 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;
+ }
+ }
}
/**
synchronized (emulator) {
// Update the scroll bars
- reflow();
+ reflowData();
// Draw the box using my superclass
super.draw();
// Put together the visible rows
int visibleHeight = getHeight() - 2;
int visibleBottom = scrollback.size() + display.size()
- + vScroller.getValue();
+ + getVerticalValue();
assert (visibleBottom >= 0);
List<DisplayLine> preceedingBlankLines = new LinkedList<DisplayLine>();
Cell ch = line.charAt(i);
Cell newCell = new Cell();
newCell.setTo(ch);
- boolean reverse = line.isReverseColor() ^ ch.getReverse();
+ boolean reverse = line.isReverseColor() ^ ch.isReverse();
newCell.setReverse(false);
if (reverse) {
newCell.setBackColor(ch.getForeColor());
/**
* Handle window close.
*/
- @Override public void onClose() {
+ @Override
+ public void onClose() {
+ emulator.close();
if (shell != null) {
+ terminateShellChildProcess();
shell.destroy();
shell = null;
- } else {
- emulator.close();
}
}
setCursorX(emulator.getCursorX() + 1);
setCursorY(emulator.getCursorY() + 1
- + (getHeight() - 2 - emulator.getHeight()));
- if (vScroller != null) {
- setCursorY(getCursorY() - vScroller.getValue());
- }
- setHasCursor(emulator.visibleCursor());
+ + (getHeight() - 2 - emulator.getHeight())
+ - getVerticalValue());
+ setCursorVisible(emulator.isCursorVisible());
if (getCursorX() > getWidth() - 2) {
- setHasCursor(false);
+ setCursorVisible(false);
}
if ((getCursorY() > getHeight() - 2) || (getCursorY() < 0)) {
- setHasCursor(false);
+ setCursorVisible(false);
}
if (emulator.getScreenTitle().length() > 0) {
// Only update the title if the shell is still alive
// Check to see if the shell has died.
if (!emulator.isReading() && (shell != null)) {
- // The emulator exited on its own, all is fine
- setTitle(String.format("%s [Completed - %d]",
- getTitle(), shell.exitValue()));
- shell = null;
- emulator.close();
+ try {
+ int rc = shell.exitValue();
+ // The emulator exited on its own, all is fine
+ setTitle(String.format("%s [Completed - %d]",
+ getTitle(), rc));
+ shell = null;
+ emulator.close();
+ clearShortcutKeypresses();
+ statusBar.setText("Terminal session completed, exit " +
+ "code " + 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 {
getTitle(), rc));
shell = null;
emulator.close();
+ clearShortcutKeypresses();
+ statusBar.setText("Terminal session completed, exit " +
+ "code " + rc + ".");
} catch (IllegalThreadStateException e) {
// The shell is still running, do nothing.
}
if (resize.getType() == TResizeEvent.Type.WIDGET) {
// Resize the scroll bars
- reflow();
+ reflowData();
+ placeScrollbars();
// Get out of scrollback
- vScroller.setValue(0);
+ setVerticalValue(0);
}
return;
/**
* Resize scrollbars for a new width/height.
*/
- private void reflow() {
+ @Override
+ public void reflowData() {
// Synchronize against the emulator so we don't stomp on its reader
// thread.
readEmulatorState();
// Vertical scrollbar
- if (vScroller == null) {
- vScroller = new TVScroller(this, getWidth() - 2, 0,
- getHeight() - 2);
- vScroller.setBottomValue(0);
- vScroller.setValue(0);
- } else {
- vScroller.setX(getWidth() - 2);
- vScroller.setHeight(getHeight() - 2);
- }
- vScroller.setTopValue(getHeight() - 2
+ setTopValue(getHeight() - 2
- (emulator.getScrollbackBuffer().size()
+ emulator.getDisplayBuffer().size()));
- vScroller.setBigChange(getHeight() - 2);
+ setVerticalBigChange(getHeight() - 2);
} // synchronized (emulator)
}
|| keypress.equals(kbCtrlPgUp)
|| keypress.equals(kbAltPgUp)
) {
- vScroller.bigDecrement();
+ bigVerticalDecrement();
return;
}
if (keypress.equals(kbShiftPgDn)
|| keypress.equals(kbCtrlPgDn)
|| keypress.equals(kbAltPgDn)
) {
- vScroller.bigIncrement();
+ bigVerticalIncrement();
return;
}
synchronized (emulator) {
if (emulator.isReading()) {
// Get out of scrollback
- vScroller.setValue(0);
+ setVerticalValue(0);
emulator.keypress(keypress.getKey());
// UGLY HACK TIME! cmd.exe needs CRLF, not just CR, so if
return;
}
- if (mouse.getMouseWheelUp()) {
- vScroller.decrement();
+ if (mouse.isMouseWheelUp()) {
+ verticalDecrement();
return;
}
- if (mouse.getMouseWheelDown()) {
- vScroller.increment();
+ if (mouse.isMouseWheelDown()) {
+ verticalIncrement();
return;
}
if (mouseOnEmulator(mouse)) {