stubs for TFileOpenBox, cleanup putStringXY
[fanfix.git] / src / jexer / TApplication.java
index 0e5020a05896d3a843c0bc3303a5d77d3851b752..d0c34bf0303adbe99e917f6afbcd278032915af6 100644 (file)
@@ -31,6 +31,7 @@
 package jexer;
 
 import java.io.InputStream;
+import java.io.IOException;
 import java.io.OutputStream;
 import java.io.UnsupportedEncodingException;
 import java.util.Collections;
@@ -51,18 +52,17 @@ import jexer.event.TMenuEvent;
 import jexer.event.TMouseEvent;
 import jexer.event.TResizeEvent;
 import jexer.backend.Backend;
-import jexer.backend.AWTBackend;
+import jexer.backend.SwingBackend;
 import jexer.backend.ECMA48Backend;
 import jexer.io.Screen;
 import jexer.menu.TMenu;
 import jexer.menu.TMenuItem;
 import static jexer.TCommand.*;
-import static jexer.TKeypress.*;
 
 /**
  * TApplication sets up a full Text User Interface application.
  */
-public class TApplication {
+public class TApplication implements Runnable {
 
     /**
      * If true, emit thread stuff to System.err.
@@ -74,6 +74,26 @@ public class TApplication {
      */
     private static final boolean debugEvents = false;
 
+    /**
+     * Two backend types are available.
+     */
+    public static enum BackendType {
+        /**
+         * A Swing JFrame.
+         */
+        SWING,
+
+        /**
+         * An ECMA48 / ANSI X3.64 / XTERM style terminal.
+         */
+        ECMA48,
+
+        /**
+         * Synonym for ECMA48
+         */
+        XTERM
+    }
+
     /**
      * WidgetEventHandler is the main event consumer loop.  There are at most
      * two such threads in existence: the primary for normal case and a
@@ -155,6 +175,11 @@ public class TApplication {
                     }
                 }
 
+                // Wait for drawAll() or doIdle() to be done, then handle the
+                // events.
+                boolean oldLock = lockHandleEvent();
+                assert (oldLock == false);
+
                 // Pull all events off the queue
                 for (;;) {
                     TInputEvent event = null;
@@ -164,10 +189,6 @@ public class TApplication {
                         }
                         event = application.drainEventQueue.remove(0);
                     }
-                    // Wait for drawAll() or doIdle() to be done, then handle
-                    // the event.
-                    boolean oldLock = lockHandleEvent();
-                    assert (oldLock == false);
                     application.repaint = true;
                     if (primary) {
                         primaryHandleEvent(event);
@@ -191,14 +212,14 @@ public class TApplication {
 
                         // All done!
                         return;
-                    } else {
-                        // Unlock.  Either I am primary thread, or I am
-                        // secondary thread and still running.
-                        oldLock = unlockHandleEvent();
-                        assert (oldLock == true);
                     }
                 } // for (;;)
 
+                // Unlock.  Either I am primary thread, or I am secondary
+                // thread and still running.
+                oldLock = unlockHandleEvent();
+                assert (oldLock == true);
+
                 // I have done some work of some kind.  Tell the main run()
                 // loop to wake up now.
                 synchronized (application) {
@@ -262,7 +283,14 @@ public class TApplication {
         synchronized (this) {
             // Wait for TApplication.run() to finish using the global state
             // before allowing further event processing.
-            while (lockoutHandleEvent == true) {}
+            while (lockoutHandleEvent == true) {
+                try {
+                    // Backoff so that the backend can finish its work.
+                    Thread.sleep(5);
+                } catch (InterruptedException e) {
+                    // SQUASH
+                }
+            }
 
             oldValue = insideHandleEvent;
             insideHandleEvent = true;
@@ -311,7 +339,14 @@ public class TApplication {
         lockoutHandleEvent = true;
         // Wait for the last event to finish processing before returning
         // control to TApplication.run().
-        while (insideHandleEvent == true) {}
+        while (insideHandleEvent == true) {
+            try {
+                // Backoff so that the event handler can finish its work.
+                Thread.sleep(1);
+            } catch (InterruptedException e) {
+                // SQUASH
+            }
+        }
 
         if (debugThreads) {
             System.err.printf(" XXX\n");
@@ -462,6 +497,29 @@ public class TApplication {
     /**
      * Public constructor.
      *
+     * @param backendType BackendType.XTERM, BackendType.ECMA48 or
+     * BackendType.SWING
+     * @throws UnsupportedEncodingException if an exception is thrown when
+     * creating the InputStreamReader
+     */
+    public TApplication(final BackendType backendType)
+        throws UnsupportedEncodingException {
+
+        switch (backendType) {
+        case SWING:
+            backend = new SwingBackend(this);
+            break;
+        case XTERM:
+            // Fall through...
+        case ECMA48:
+            backend = new ECMA48Backend(this, null, null);
+        }
+        TApplicationImpl();
+    }
+
+    /**
+     * Public constructor.  The backend type will be BackendType.ECMA48.
+     *
      * @param input an InputStream connected to the remote user, or null for
      * System.in.  If System.in is used, then on non-Windows systems it will
      * be put in raw mode; shutdown() will (blindly!) put System.in in cooked
@@ -475,26 +533,25 @@ public class TApplication {
     public TApplication(final InputStream input,
         final OutputStream output) throws UnsupportedEncodingException {
 
-        // AWT is the default backend on Windows unless explicitly overridden
-        // by jexer.AWT.
-        boolean useAWT = false;
-        if (System.getProperty("os.name").startsWith("Windows")) {
-            useAWT = true;
-        }
-        if (System.getProperty("jexer.AWT") != null) {
-            if (System.getProperty("jexer.AWT", "false").equals("true")) {
-                useAWT = true;
-            } else {
-                useAWT = false;
-            }
-        }
+        backend = new ECMA48Backend(this, input, output);
+        TApplicationImpl();
+    }
 
+    /**
+     * Public constructor.  This hook enables use with new non-Jexer
+     * backends.
+     *
+     * @param backend a Backend that is already ready to go.
+     */
+    public TApplication(final Backend backend) {
+        this.backend = backend;
+        TApplicationImpl();
+    }
 
-        if (useAWT) {
-            backend     = new AWTBackend(this);
-        } else {
-            backend     = new ECMA48Backend(this, input, output);
-        }
+    /**
+     * Finish construction once the backend is set.
+     */
+    private void TApplicationImpl() {
         theme           = new ColorTheme();
         desktopBottom   = getScreen().getHeight() - 1;
         fillEventQueue  = new ArrayList<TInputEvent>();
@@ -528,21 +585,19 @@ public class TApplication {
     /**
      * Draw everything.
      */
-    public final void drawAll() {
+    private void drawAll() {
         if (debugThreads) {
             System.err.printf("drawAll() enter\n");
         }
 
         if (!repaint) {
-            synchronized (getScreen()) {
-                if ((oldMouseX != mouseX) || (oldMouseY != mouseY)) {
-                    // The only thing that has happened is the mouse moved.
-                    // Clear the old position and draw the new position.
-                    invertCell(oldMouseX, oldMouseY);
-                    invertCell(mouseX, mouseY);
-                    oldMouseX = mouseX;
-                    oldMouseY = mouseY;
-                }
+            if ((oldMouseX != mouseX) || (oldMouseY != mouseY)) {
+                // The only thing that has happened is the mouse moved.
+                // Clear the old position and draw the new position.
+                invertCell(oldMouseX, oldMouseY);
+                invertCell(mouseX, mouseY);
+                oldMouseX = mouseX;
+                oldMouseY = mouseY;
             }
             if (getScreen().isDirty()) {
                 backend.flushScreen();
@@ -582,7 +637,7 @@ public class TApplication {
         for (TMenu menu: menus) {
             CellAttributes menuColor;
             CellAttributes menuMnemonicColor;
-            if (menu.getActive()) {
+            if (menu.isActive()) {
                 menuColor = theme.getColor("tmenu.highlighted");
                 menuMnemonicColor = theme.getColor("tmenu.mnemonic.highlighted");
             } else {
@@ -592,12 +647,12 @@ public class TApplication {
             // Draw the menu title
             getScreen().hLineXY(x, 0, menu.getTitle().length() + 2, ' ',
                 menuColor);
-            getScreen().putStrXY(x + 1, 0, menu.getTitle(), menuColor);
+            getScreen().putStringXY(x + 1, 0, menu.getTitle(), menuColor);
             // Draw the highlight character
             getScreen().putCharXY(x + 1 + menu.getMnemonic().getShortcutIdx(),
                 0, menu.getMnemonic().getShortcut(), menuMnemonicColor);
 
-            if (menu.getActive()) {
+            if (menu.isActive()) {
                 menu.drawChildren();
                 // Reset the screen clipping so we can draw the next title.
                 getScreen().resetClipping();
@@ -618,7 +673,7 @@ public class TApplication {
         TWidget activeWidget = null;
         if (sorted.size() > 0) {
             activeWidget = sorted.get(sorted.size() - 1).getActiveChild();
-            if (activeWidget.visibleCursor()) {
+            if (activeWidget.isCursorVisible()) {
                 getScreen().putCursor(true, activeWidget.getCursorAbsoluteX(),
                     activeWidget.getCursorAbsoluteY());
                 cursor = true;
@@ -639,7 +694,7 @@ public class TApplication {
     /**
      * Run this application until it exits.
      */
-    public final void run() {
+    public void run() {
         while (!quit) {
             // Timeout is in milliseconds, so default timeout after 1 second
             // of inactivity.
@@ -650,24 +705,11 @@ public class TApplication {
             if (!repaint
                 && ((mouseX == oldMouseX) && (mouseY == oldMouseY))
             ) {
-                // Never sleep longer than 100 millis, to get windows with
-                // background tasks an opportunity to update the display.
-                timeout = getSleepTime(100);
-
-                // See if there are any definitely events waiting to be
-                // processed.  If so, do not wait -- either there is I/O
-                // coming in or the primary/secondary threads are still
-                // working.
-                synchronized (drainEventQueue) {
-                    if (drainEventQueue.size() > 0) {
-                        timeout = 0;
-                    }
-                }
-                synchronized (fillEventQueue) {
-                    if (fillEventQueue.size() > 0) {
-                        timeout = 0;
-                    }
-                }
+                // Never sleep longer than 50 millis.  We need time for
+                // windows with background tasks to update the display, and
+                // still flip buffers reasonably quickly in
+                // backend.flushPhysical().
+                timeout = getSleepTime(50);
             }
 
             if (timeout > 0) {
@@ -686,31 +728,27 @@ public class TApplication {
                 repaint = true;
             }
 
+            // Prevent stepping on the primary or secondary event handler.
+            stopEventHandlers();
+
             // Pull any pending I/O events
             backend.getEvents(fillEventQueue);
 
             // Dispatch each event to the appropriate handler, one at a time.
             for (;;) {
                 TInputEvent event = null;
-                synchronized (fillEventQueue) {
-                    if (fillEventQueue.size() == 0) {
-                        break;
-                    }
-                    event = fillEventQueue.remove(0);
+                if (fillEventQueue.size() == 0) {
+                    break;
                 }
+                event = fillEventQueue.remove(0);
                 metaHandleEvent(event);
             }
 
             // Wake a consumer thread if we have any pending events.
-            synchronized (drainEventQueue) {
-                if (drainEventQueue.size() > 0) {
-                    wakeEventHandler();
-                }
+            if (drainEventQueue.size() > 0) {
+                wakeEventHandler();
             }
 
-            // Prevent stepping on the primary or secondary event handler.
-            stopEventHandlers();
-
             // Process timers and call doIdle()'s
             doIdle();
 
@@ -804,9 +842,7 @@ public class TApplication {
         }
 
         // Put into the main queue
-        synchronized (drainEventQueue) {
-            drainEventQueue.add(event);
-        }
+        drainEventQueue.add(event);
     }
 
     /**
@@ -844,11 +880,11 @@ public class TApplication {
                         break;
                     }
                     if ((mouse.getType() == TMouseEvent.Type.MOUSE_MOTION)
-                        && (!mouse.getMouse1())
-                        && (!mouse.getMouse2())
-                        && (!mouse.getMouse3())
-                        && (!mouse.getMouseWheelUp())
-                        && (!mouse.getMouseWheelDown())
+                        && (!mouse.isMouse1())
+                        && (!mouse.isMouse2())
+                        && (!mouse.isMouse3())
+                        && (!mouse.isMouseWheelUp())
+                        && (!mouse.isMouseWheelDown())
                     ) {
                         break;
                     }
@@ -880,7 +916,7 @@ public class TApplication {
                 item = accelerators.get(keypressLowercase);
             }
             if (item != null) {
-                if (item.getEnabled()) {
+                if (item.isEnabled()) {
                     // Let the menu item dispatch
                     item.dispatch();
                     return;
@@ -906,7 +942,7 @@ public class TApplication {
 
         // Dispatch events to the active window -------------------------------
         for (TWindow window: windows) {
-            if (window.getActive()) {
+            if (window.isActive()) {
                 if (event instanceof TMouseEvent) {
                     TMouseEvent mouse = (TMouseEvent) event;
                     // Convert the mouse relative x/y to window coordinates
@@ -1091,7 +1127,7 @@ public class TApplication {
             // Swap z/active between active window and the next in the list
             int activeWindowI = -1;
             for (int i = 0; i < windows.size(); i++) {
-                if (windows.get(i).getActive()) {
+                if (windows.get(i).isActive()) {
                     activeWindowI = i;
                     break;
                 }
@@ -1200,7 +1236,7 @@ public class TApplication {
 
         // See if they hit the menu bar
         if ((mouse.getType() == TMouseEvent.Type.MOUSE_DOWN)
-            && (mouse.getMouse1())
+            && (mouse.isMouse1())
             && (!modalWindowActive())
             && (mouse.getAbsoluteY() == 0)
         ) {
@@ -1227,7 +1263,7 @@ public class TApplication {
 
         // See if they hit the menu bar
         if ((mouse.getType() == TMouseEvent.Type.MOUSE_MOTION)
-            && (mouse.getMouse1())
+            && (mouse.isMouse1())
             && (activeMenu != null)
             && (mouse.getAbsoluteY() == 0)
         ) {
@@ -1281,8 +1317,8 @@ public class TApplication {
                     }
 
                     // We will be switching to another window
-                    assert (windows.get(0).getActive());
-                    assert (!window.getActive());
+                    assert (windows.get(0).isActive());
+                    assert (!window.isActive());
                     windows.get(0).setActive(false);
                     windows.get(0).setZ(window.getZ());
                     window.setZ(0);
@@ -1440,9 +1476,9 @@ public class TApplication {
         // Default: only menu shortcuts
 
         // Process Alt-F, Alt-E, etc. menu shortcut keys
-        if (!keypress.getKey().getIsKey()
-            && keypress.getKey().getAlt()
-            && !keypress.getKey().getCtrl()
+        if (!keypress.getKey().isFnKey()
+            && keypress.getKey().isAlt()
+            && !keypress.getKey().isCtrl()
             && (activeMenu == null)
         ) {
 
@@ -1450,7 +1486,7 @@ public class TApplication {
 
             for (TMenu menu: menus) {
                 if (Character.toLowerCase(menu.getMnemonic().getShortcut())
-                    == Character.toLowerCase(keypress.getKey().getCh())
+                    == Character.toLowerCase(keypress.getKey().getChar())
                 ) {
                     activeMenu = menu;
                     menu.setActive(true);
@@ -1785,4 +1821,30 @@ public class TApplication {
         return new TTerminalWindow(this, x, y, flags);
     }
 
+    /**
+     * Convenience function to spawn an file open box.
+     *
+     * @param path path of selected file
+     * @return the result of the new file open box
+     */
+    public final String fileOpenBox(final String path) throws IOException {
+
+        TFileOpenBox box = new TFileOpenBox(this, path, TFileOpenBox.Type.OPEN);
+        return box.getFilename();
+    }
+
+    /**
+     * Convenience function to spawn an file open box.
+     *
+     * @param path path of selected file
+     * @param type one of the Type constants
+     * @return the result of the new file open box
+     */
+    public final String fileOpenBox(final String path,
+        final TFileOpenBox.Type type) throws IOException {
+
+        TFileOpenBox box = new TFileOpenBox(this, path, type);
+        return box.getFilename();
+    }
+
 }