LICENSE CHANGED TO MIT
[nikiroo-utils.git] / src / jexer / TApplication.java
index 2b8f47e47cbf80b84cdd5bb83ce90c7bdfa2846f..f4cf2d5cb7a54a800c421e21b854b8552247725a 100644 (file)
@@ -1,29 +1,27 @@
-/**
+/*
  * 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) 2016 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
@@ -31,6 +29,7 @@
 package jexer;
 
 import java.io.InputStream;
+import java.io.IOException;
 import java.io.OutputStream;
 import java.io.UnsupportedEncodingException;
 import java.util.Collections;
@@ -88,7 +87,7 @@ public class TApplication implements Runnable {
         ECMA48,
 
         /**
-         * Synonym for ECMA48
+         * Synonym for ECMA48.
          */
         XTERM
     }
@@ -174,6 +173,11 @@ public class TApplication implements Runnable {
                     }
                 }
 
+                // 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;
@@ -183,10 +187,6 @@ public class TApplication implements Runnable {
                         }
                         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);
@@ -210,14 +210,14 @@ public class TApplication implements Runnable {
 
                         // 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) {
@@ -281,7 +281,14 @@ public class TApplication implements Runnable {
         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;
@@ -330,7 +337,14 @@ public class TApplication implements Runnable {
         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");
@@ -414,6 +428,11 @@ public class TApplication implements Runnable {
      */
     private Map<TKeypress, TMenuItem> accelerators;
 
+    /**
+     * All menu items.
+     */
+    private List<TMenuItem> menuItems;
+
     /**
      * Windows and widgets pull colors from this ColorTheme.
      */
@@ -497,6 +516,10 @@ public class TApplication implements Runnable {
             // Fall through...
         case ECMA48:
             backend = new ECMA48Backend(this, null, null);
+            break;
+        default:
+            throw new IllegalArgumentException("Invalid backend type: "
+                + backendType);
         }
         TApplicationImpl();
     }
@@ -545,6 +568,7 @@ public class TApplication implements Runnable {
         subMenus        = new LinkedList<TMenu>();
         timers          = new LinkedList<TTimer>();
         accelerators    = new HashMap<TKeypress, TMenuItem>();
+        menuItems       = new ArrayList<TMenuItem>();
 
         // Setup the main consumer thread
         primaryEventHandler = new WidgetEventHandler(this, true);
@@ -569,21 +593,19 @@ public class TApplication implements Runnable {
     /**
      * 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();
@@ -623,7 +645,7 @@ public class TApplication implements Runnable {
         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 {
@@ -633,12 +655,12 @@ public class TApplication implements Runnable {
             // 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();
@@ -659,7 +681,7 @@ public class TApplication implements Runnable {
         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;
@@ -691,24 +713,11 @@ public class TApplication implements Runnable {
             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) {
@@ -727,31 +736,27 @@ public class TApplication implements Runnable {
                 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();
 
@@ -845,9 +850,7 @@ public class TApplication implements Runnable {
         }
 
         // Put into the main queue
-        synchronized (drainEventQueue) {
-            drainEventQueue.add(event);
-        }
+        drainEventQueue.add(event);
     }
 
     /**
@@ -885,11 +888,11 @@ public class TApplication implements Runnable {
                         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;
                     }
@@ -921,7 +924,7 @@ public class TApplication implements Runnable {
                 item = accelerators.get(keypressLowercase);
             }
             if (item != null) {
-                if (item.getEnabled()) {
+                if (item.isEnabled()) {
                     // Let the menu item dispatch
                     item.dispatch();
                     return;
@@ -947,7 +950,7 @@ public class TApplication implements Runnable {
 
         // 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
@@ -985,7 +988,8 @@ public class TApplication implements Runnable {
     public final void enableSecondaryEventReceiver(final TWidget widget) {
         assert (secondaryEventReceiver == null);
         assert (secondaryEventHandler == null);
-        assert (widget instanceof TMessageBox);
+        assert ((widget instanceof TMessageBox)
+            || (widget instanceof TFileOpenBox));
         secondaryEventReceiver = widget;
         secondaryEventHandler = new WidgetEventHandler(this, false);
         (new Thread(secondaryEventHandler)).start();
@@ -1001,7 +1005,7 @@ public class TApplication implements Runnable {
         // secondary thread locks again.  When it gives up, we have the
         // single lock back.
         boolean oldLock = unlockHandleEvent();
-        assert (oldLock == true);
+        assert (oldLock);
 
         while (secondaryEventReceiver != null) {
             synchronized (primaryEventHandler) {
@@ -1079,6 +1083,7 @@ public class TApplication implements Runnable {
         synchronized (windows) {
             int z = window.getZ();
             window.setZ(-1);
+            window.onUnfocus();
             Collections.sort(windows);
             windows.remove(0);
             TWindow activeWindow = null;
@@ -1087,10 +1092,14 @@ public class TApplication implements Runnable {
                     w.setZ(w.getZ() - 1);
                     if (w.getZ() == 0) {
                         w.setActive(true);
+                        w.onFocus();
                         assert (activeWindow == null);
                         activeWindow = w;
                     } else {
-                        w.setActive(false);
+                        if (w.isActive()) {
+                            w.setActive(false);
+                            w.onUnfocus();
+                        }
                     }
                 }
             }
@@ -1132,7 +1141,7 @@ public class TApplication implements Runnable {
             // 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;
                 }
@@ -1156,8 +1165,10 @@ public class TApplication implements Runnable {
             }
             windows.get(activeWindowI).setActive(false);
             windows.get(activeWindowI).setZ(windows.get(nextWindowI).getZ());
+            windows.get(activeWindowI).onUnfocus();
             windows.get(nextWindowI).setZ(0);
             windows.get(nextWindowI).setActive(true);
+            windows.get(nextWindowI).onFocus();
 
         } // synchronized (windows)
 
@@ -1175,12 +1186,16 @@ public class TApplication implements Runnable {
                 assert (window.isModal());
             }
             for (TWindow w: windows) {
-                w.setActive(false);
+                if (w.isActive()) {
+                    w.setActive(false);
+                    w.onUnfocus();
+                }
                 w.setZ(w.getZ() + 1);
             }
             windows.add(window);
-            window.setActive(true);
             window.setZ(0);
+            window.setActive(true);
+            window.onFocus();
         }
     }
 
@@ -1241,7 +1256,7 @@ public class TApplication implements Runnable {
 
         // See if they hit the menu bar
         if ((mouse.getType() == TMouseEvent.Type.MOUSE_DOWN)
-            && (mouse.getMouse1())
+            && (mouse.isMouse1())
             && (!modalWindowActive())
             && (mouse.getAbsoluteY() == 0)
         ) {
@@ -1268,7 +1283,7 @@ public class TApplication implements Runnable {
 
         // See if they hit the menu bar
         if ((mouse.getType() == TMouseEvent.Type.MOUSE_MOTION)
-            && (mouse.getMouse1())
+            && (mouse.isMouse1())
             && (activeMenu != null)
             && (mouse.getAbsoluteY() == 0)
         ) {
@@ -1322,12 +1337,14 @@ public class TApplication implements Runnable {
                     }
 
                     // 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).onUnfocus();
                     windows.get(0).setActive(false);
                     windows.get(0).setZ(window.getZ());
                     window.setZ(0);
                     window.setActive(true);
+                    window.onFocus();
                     return;
                 }
             }
@@ -1481,9 +1498,9 @@ public class TApplication implements Runnable {
         // 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)
         ) {
 
@@ -1491,7 +1508,7 @@ public class TApplication implements Runnable {
 
             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);
@@ -1504,17 +1521,76 @@ public class TApplication implements Runnable {
     }
 
     /**
-     * Add a keyboard accelerator to the global hash.
+     * Add a menu item to the global list.  If it has a keyboard accelerator,
+     * that will be added the global hash.
      *
-     * @param item menu item this accelerator relates to
-     * @param keypress keypress that will dispatch a TMenuEvent
+     * @param item the menu item
      */
-    public final void addAccelerator(final TMenuItem item,
-        final TKeypress keypress) {
+    public final void addMenuItem(final TMenuItem item) {
+        menuItems.add(item);
 
-        synchronized (accelerators) {
-            assert (accelerators.get(keypress) == null);
-            accelerators.put(keypress, item);
+        TKeypress key = item.getKey();
+        if (key != null) {
+            synchronized (accelerators) {
+                assert (accelerators.get(key) == null);
+                accelerators.put(key.toLowerCase(), item);
+            }
+        }
+    }
+
+    /**
+     * Disable one menu item.
+     *
+     * @param id the menu item ID
+     */
+    public final void disableMenuItem(final int id) {
+        for (TMenuItem item: menuItems) {
+            if (item.getId() == id) {
+                item.setEnabled(false);
+            }
+        }
+    }
+
+    /**
+     * Disable the range of menu items with ID's between lower and upper,
+     * inclusive.
+     *
+     * @param lower the lowest menu item ID
+     * @param upper the highest menu item ID
+     */
+    public final void disableMenuItems(final int lower, final int upper) {
+        for (TMenuItem item: menuItems) {
+            if ((item.getId() >= lower) && (item.getId() <= upper)) {
+                item.setEnabled(false);
+            }
+        }
+    }
+
+    /**
+     * Enable one menu item.
+     *
+     * @param id the menu item ID
+     */
+    public final void enableMenuItem(final int id) {
+        for (TMenuItem item: menuItems) {
+            if (item.getId() == id) {
+                item.setEnabled(true);
+            }
+        }
+    }
+
+    /**
+     * Enable the range of menu items with ID's between lower and upper,
+     * inclusive.
+     *
+     * @param lower the lowest menu item ID
+     * @param upper the highest menu item ID
+     */
+    public final void enableMenuItems(final int lower, final int upper) {
+        for (TMenuItem item: menuItems) {
+            if ((item.getId() >= lower) && (item.getId() <= upper)) {
+                item.setEnabled(true);
+            }
         }
     }
 
@@ -1826,4 +1902,32 @@ public class TApplication implements Runnable {
         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
+     * @throws IOException if java.io operation throws
+     */
+    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
+     * @throws IOException if java.io operation throws
+     */
+    public final String fileOpenBox(final String path,
+        final TFileOpenBox.Type type) throws IOException {
+
+        TFileOpenBox box = new TFileOpenBox(this, path, type);
+        return box.getFilename();
+    }
+
 }