-/**
+/*
* 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
package jexer;
import java.io.InputStream;
+import java.io.IOException;
import java.io.OutputStream;
import java.io.UnsupportedEncodingException;
import java.util.Collections;
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.
+ */
+ private static final boolean debugThreads = false;
+
+ /**
+ * If true, emit events being processed to System.err.
+ */
+ 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
break;
}
}
- synchronized (application) {
- application.wait();
+
+ synchronized (this) {
+ if (debugThreads) {
+ System.err.printf("%s %s sleep\n", this,
+ primary ? "primary" : "secondary");
+ }
+
+ this.wait();
+
+ if (debugThreads) {
+ System.err.printf("%s %s AWAKE\n", this,
+ primary ? "primary" : "secondary");
+ }
+
if ((!primary)
&& (application.secondaryEventReceiver == null)
) {
- // Secondary thread, time to exit
- return;
+ // Secondary thread, emergency exit. If we
+ // got here then something went wrong with
+ // the handoff between yield() and
+ // closeWindow().
+ synchronized (application.primaryEventHandler) {
+ application.primaryEventHandler.notify();
+ }
+ application.secondaryEventHandler = null;
+ throw new RuntimeException(
+ "secondary exited at wrong time");
}
break;
}
}
}
+ // 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;
}
event = application.drainEventQueue.remove(0);
}
+ application.repaint = true;
if (primary) {
primaryHandleEvent(event);
} else {
if ((!primary)
&& (application.secondaryEventReceiver == null)
) {
- // Secondary thread, time to exit
+ // Secondary thread, time to exit.
+
+ // DO NOT UNLOCK. Primary thread just came back from
+ // primaryHandleEvent() and will unlock in the else
+ // block below. Just wake it up.
+ synchronized (application.primaryEventHandler) {
+ application.primaryEventHandler.notify();
+ }
+ // Now eliminate my reference so that
+ // wakeEventHandler() resumes working on the primary.
+ application.secondaryEventHandler = null;
+
+ // All done!
return;
}
+ } // 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) {
+ application.notify();
}
+
} // while (true) (main runnable loop)
}
}
/**
* The primary event handler thread.
*/
- private WidgetEventHandler primaryEventHandler;
+ private volatile WidgetEventHandler primaryEventHandler;
/**
* The secondary event handler thread.
*/
- private WidgetEventHandler secondaryEventHandler;
+ private volatile WidgetEventHandler secondaryEventHandler;
/**
* The widget receiving events from the secondary event handler thread.
*/
- private TWidget secondaryEventReceiver;
+ private volatile TWidget secondaryEventReceiver;
+
+ /**
+ * Spinlock for the primary and secondary event handlers.
+ * WidgetEventHandler.run() is responsible for setting this value.
+ */
+ private volatile boolean insideHandleEvent = false;
+
+ /**
+ * Wake the sleeping active event handler.
+ */
+ private void wakeEventHandler() {
+ if (secondaryEventHandler != null) {
+ synchronized (secondaryEventHandler) {
+ secondaryEventHandler.notify();
+ }
+ } else {
+ assert (primaryEventHandler != null);
+ synchronized (primaryEventHandler) {
+ primaryEventHandler.notify();
+ }
+ }
+ }
+
+ /**
+ * Set the insideHandleEvent flag to true. lockoutEventHandlers() will
+ * spin indefinitely until unlockHandleEvent() is called.
+ *
+ * @return the old value of insideHandleEvent
+ */
+ private boolean lockHandleEvent() {
+ if (debugThreads) {
+ System.err.printf(" >> lockHandleEvent(): oldValue %s",
+ insideHandleEvent);
+ }
+ boolean oldValue = true;
+
+ synchronized (this) {
+ // Wait for TApplication.run() to finish using the global state
+ // before allowing further event processing.
+ while (lockoutHandleEvent == true) {
+ try {
+ // Backoff so that the backend can finish its work.
+ Thread.sleep(5);
+ } catch (InterruptedException e) {
+ // SQUASH
+ }
+ }
+
+ oldValue = insideHandleEvent;
+ insideHandleEvent = true;
+ }
+
+ if (debugThreads) {
+ System.err.printf(" ***\n");
+ }
+ return oldValue;
+ }
+
+ /**
+ * Set the insideHandleEvent flag to false. lockoutEventHandlers() will
+ * spin indefinitely until unlockHandleEvent() is called.
+ *
+ * @return the old value of insideHandleEvent
+ */
+ private boolean unlockHandleEvent() {
+ if (debugThreads) {
+ System.err.printf(" << unlockHandleEvent(): oldValue %s\n",
+ insideHandleEvent);
+ }
+ synchronized (this) {
+ boolean oldValue = insideHandleEvent;
+ insideHandleEvent = false;
+ return oldValue;
+ }
+ }
+
+ /**
+ * Spinlock for the primary and secondary event handlers. When true, the
+ * event handlers will spinlock wait before calling handleEvent().
+ */
+ private volatile boolean lockoutHandleEvent = false;
+
+ /**
+ * TApplication.run() needs to be able rely on the global data structures
+ * being intact when calling doIdle() and drawAll(). Tell the event
+ * handlers to wait for an unlock before handling their events.
+ */
+ private void stopEventHandlers() {
+ if (debugThreads) {
+ System.err.printf(">> stopEventHandlers()");
+ }
+
+ lockoutHandleEvent = true;
+ // Wait for the last event to finish processing before returning
+ // control to TApplication.run().
+ 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");
+ }
+ }
+
+ /**
+ * TApplication.run() needs to be able rely on the global data structures
+ * being intact when calling doIdle() and drawAll(). Tell the event
+ * handlers that it is now OK to handle their events.
+ */
+ private void startEventHandlers() {
+ if (debugThreads) {
+ System.err.printf("<< startEventHandlers()\n");
+ }
+ lockoutHandleEvent = false;
+ }
/**
* Access to the physical screen, keyboard, and mouse.
*/
private int mouseY;
+ /**
+ * Old version of mouse coordinate X.
+ */
+ private int oldMouseX;
+
+ /**
+ * Old version mouse coordinate Y.
+ */
+ private int oldMouseY;
+
/**
* Event queue that is filled by run().
*/
*/
private Map<TKeypress, TMenuItem> accelerators;
+ /**
+ * All menu items.
+ */
+ private List<TMenuItem> menuItems;
+
/**
* Windows and widgets pull colors from this ColorTheme.
*/
/**
* When true, exit the application.
*/
- private boolean quit = false;
+ private volatile boolean quit = false;
/**
* When true, repaint the entire screen.
*/
- private boolean repaint = true;
-
- /**
- * Request full repaint on next screen refresh.
- */
- public final void setRepaint() {
- repaint = true;
- }
-
- /**
- * When true, just flush updates from the screen.
- */
- private boolean flush = false;
+ private volatile boolean repaint = true;
/**
* Y coordinate of the top edge of the desktop. For now this is a
/**
* 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);
+ break;
+ default:
+ throw new IllegalArgumentException("Invalid backend type: "
+ + backendType);
+ }
+ 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
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();
- } else {
- backend = new ECMA48Backend(input, output);
- }
+ /**
+ * Finish construction once the backend is set.
+ */
+ private void TApplicationImpl() {
theme = new ColorTheme();
desktopBottom = getScreen().getHeight() - 1;
fillEventQueue = new ArrayList<TInputEvent>();
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);
}
/**
- * Invert the cell at the mouse pointer position.
+ * Invert the cell color at a position. This is used to track the mouse.
+ *
+ * @param x column position
+ * @param y row position
*/
- private void drawMouse() {
- CellAttributes attr = getScreen().getAttrXY(mouseX, mouseY);
- attr.setForeColor(attr.getForeColor().invert());
- attr.setBackColor(attr.getBackColor().invert());
- getScreen().putAttrXY(mouseX, mouseY, attr, false);
- flush = true;
-
- if (windows.size() == 0) {
- repaint = true;
+ private void invertCell(final int x, final int y) {
+ synchronized (getScreen()) {
+ CellAttributes attr = getScreen().getAttrXY(x, y);
+ attr.setForeColor(attr.getForeColor().invert());
+ attr.setBackColor(attr.getBackColor().invert());
+ getScreen().putAttrXY(x, y, attr, false);
}
}
/**
* Draw everything.
*/
- public final void drawAll() {
- if ((flush) && (!repaint)) {
- backend.flushScreen();
- flush = false;
- return;
+ private void drawAll() {
+ if (debugThreads) {
+ System.err.printf("drawAll() enter\n");
}
if (!repaint) {
+ 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();
+ }
return;
}
+ if (debugThreads) {
+ System.err.printf("drawAll() REDRAW\n");
+ }
+
// If true, the cursor is not visible
boolean cursor = false;
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 {
// 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();
}
// Draw the mouse pointer
- drawMouse();
+ invertCell(mouseX, mouseY);
// Place the cursor if it is visible
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;
backend.flushScreen();
repaint = false;
- flush = false;
}
/**
* 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.
- int timeout = getSleepTime(1000);
-
- // See if there are any definitely events waiting to be processed
- // or a screen redraw to do. If so, do not wait if there is no
- // I/O coming in.
- synchronized (drainEventQueue) {
- if (drainEventQueue.size() > 0) {
- timeout = 0;
- }
+ long timeout = 0;
+
+ // If I've got no updates to render, wait for something from the
+ // backend or a timer.
+ if (!repaint
+ && ((mouseX == oldMouseX) && (mouseY == oldMouseY))
+ ) {
+ // 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);
}
- synchronized (fillEventQueue) {
- if (fillEventQueue.size() > 0) {
- timeout = 0;
+
+ if (timeout > 0) {
+ // As of now, I've got nothing to do: no I/O, nothing from
+ // the consumer threads, no timers that need to run ASAP. So
+ // wait until either the backend or the consumer threads have
+ // something to do.
+ try {
+ synchronized (this) {
+ this.wait(timeout);
+ }
+ } catch (InterruptedException e) {
+ // I'm awake and don't care why, let's see what's going
+ // on out there.
}
+ repaint = true;
}
+ // Prevent stepping on the primary or secondary event handler.
+ stopEventHandlers();
+
// Pull any pending I/O events
- backend.getEvents(fillEventQueue, timeout);
+ 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.
+ if (drainEventQueue.size() > 0) {
+ wakeEventHandler();
+ }
+
// Process timers and call doIdle()'s
doIdle();
// Update the screen
- drawAll();
- }
+ synchronized (getScreen()) {
+ drawAll();
+ }
- // Shutdown the consumer threads
- synchronized (this) {
- this.notifyAll();
+ // Let the event handlers run again.
+ startEventHandlers();
+
+ } // while (!quit)
+
+ // Shutdown the event consumer threads
+ if (secondaryEventHandler != null) {
+ synchronized (secondaryEventHandler) {
+ secondaryEventHandler.notify();
+ }
+ }
+ if (primaryEventHandler != null) {
+ synchronized (primaryEventHandler) {
+ primaryEventHandler.notify();
+ }
}
+ // Shutdown the user I/O thread(s)
backend.shutdown();
+
+ // Close all the windows. This gives them an opportunity to release
+ // resources.
+ closeAllWindows();
+
}
/**
*/
private void metaHandleEvent(final TInputEvent event) {
- /*
- System.err.printf(String.format("metaHandleEvents event: %s\n",
- event)); System.err.flush();
- */
+ if (debugEvents) {
+ System.err.printf(String.format("metaHandleEvents event: %s\n",
+ event)); System.err.flush();
+ }
if (quit) {
// Do no more processing if the application is already trying
// Screen resize
if (event instanceof TResizeEvent) {
TResizeEvent resize = (TResizeEvent) event;
- getScreen().setDimensions(resize.getWidth(),
- resize.getHeight());
- desktopBottom = getScreen().getHeight() - 1;
- repaint = true;
- mouseX = 0;
- mouseY = 0;
+ synchronized (getScreen()) {
+ getScreen().setDimensions(resize.getWidth(),
+ resize.getHeight());
+ desktopBottom = getScreen().getHeight() - 1;
+ mouseX = 0;
+ mouseY = 0;
+ oldMouseX = 0;
+ oldMouseY = 0;
+ }
return;
}
// Peek at the mouse position
if (event instanceof TMouseEvent) {
TMouseEvent mouse = (TMouseEvent) event;
- if ((mouseX != mouse.getX()) || (mouseY != mouse.getY())) {
- mouseX = mouse.getX();
- mouseY = mouse.getY();
- drawMouse();
+ synchronized (getScreen()) {
+ if ((mouseX != mouse.getX()) || (mouseY != mouse.getY())) {
+ oldMouseX = mouseX;
+ oldMouseY = mouseY;
+ mouseX = mouse.getX();
+ mouseY = mouse.getY();
+ }
}
}
- // Put into the main queue
- synchronized (drainEventQueue) {
- drainEventQueue.add(event);
- }
-
- // Wake all threads: primary thread will either be consuming events
- // again or waiting in yield(), and secondary thread will either not
- // exist or consuming events.
- synchronized (this) {
- this.notifyAll();
- }
+ // Put into the main queue
+ drainEventQueue.add(event);
}
/**
*/
private void primaryHandleEvent(final TInputEvent event) {
- // System.err.printf("Handle event: %s\n", event);
+ if (debugEvents) {
+ System.err.printf("Handle event: %s\n", event);
+ }
// Special application-wide events -----------------------------------
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;
}
item = accelerators.get(keypressLowercase);
}
if (item != null) {
- // Let the menu item dispatch
- item.dispatch();
- return;
- } else {
- // Handle the keypress
- if (onKeypress(keypress)) {
+ if (item.isEnabled()) {
+ // Let the menu item dispatch
+ item.dispatch();
return;
}
}
+ // Handle the keypress
+ if (onKeypress(keypress)) {
+ return;
+ }
}
if (event instanceof TCommandEvent) {
// 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
mouse.setX(mouse.getX() - window.getX());
mouse.setY(mouse.getY() - window.getY());
}
- // System.err("TApplication dispatch event: %s\n", event);
+ if (debugEvents) {
+ System.err.printf("TApplication dispatch event: %s\n",
+ event);
+ }
window.handleEvent(event);
break;
}
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();
-
- // Refresh
- repaint = true;
}
/**
*/
public final void yield() {
assert (secondaryEventReceiver != null);
+ // This is where we handoff the event handler lock from the primary
+ // to secondary thread. We unlock here, and in a future loop the
+ // secondary thread locks again. When it gives up, we have the
+ // single lock back.
+ boolean oldLock = unlockHandleEvent();
+ assert (oldLock);
+
while (secondaryEventReceiver != null) {
- synchronized (this) {
+ synchronized (primaryEventHandler) {
try {
- this.wait();
+ primaryEventHandler.wait();
} catch (InterruptedException e) {
// SQUASH
}
* Do stuff when there is no user input.
*/
private void doIdle() {
+ if (debugThreads) {
+ System.err.printf("doIdle()\n");
+ }
+
// Now run any timers that have timed out
Date now = new Date();
List<TTimer> keepTimers = new LinkedList<TTimer>();
for (TTimer timer: timers) {
- if (timer.getNextTick().getTime() < now.getTime()) {
+ if (timer.getNextTick().getTime() <= now.getTime()) {
timer.tick();
if (timer.recurring) {
keepTimers.add(timer);
/**
* Get the amount of time I can sleep before missing a Timer tick.
*
- * @param timeout = initial (maximum) timeout
+ * @param timeout = initial (maximum) timeout in millis
* @return number of milliseconds between now and the next timer event
*/
- protected int getSleepTime(final int timeout) {
+ private long getSleepTime(final long timeout) {
Date now = new Date();
+ long nowTime = now.getTime();
long sleepTime = timeout;
for (TTimer timer: timers) {
- if (timer.getNextTick().getTime() < now.getTime()) {
+ long nextTickTime = timer.getNextTick().getTime();
+ if (nextTickTime < nowTime) {
return 0;
}
- if ((timer.getNextTick().getTime() > now.getTime())
- && ((timer.getNextTick().getTime() - now.getTime()) < sleepTime)
- ) {
- sleepTime = timer.getNextTick().getTime() - now.getTime();
+
+ long timeDifference = nextTickTime - nowTime;
+ if (timeDifference < sleepTime) {
+ sleepTime = timeDifference;
}
}
assert (sleepTime >= 0);
- return (int)sleepTime;
+ assert (sleepTime <= timeout);
+ return sleepTime;
}
/**
* @param window the window to remove
*/
public final void closeWindow(final TWindow window) {
- int z = window.getZ();
- window.setZ(-1);
- Collections.sort(windows);
- windows.remove(0);
- TWindow activeWindow = null;
- for (TWindow w: windows) {
- if (w.getZ() > z) {
- w.setZ(w.getZ() - 1);
- if (w.getZ() == 0) {
- w.setActive(true);
- assert (activeWindow == null);
- activeWindow = w;
- } else {
- w.setActive(false);
+ synchronized (windows) {
+ int z = window.getZ();
+ window.setZ(-1);
+ window.onUnfocus();
+ Collections.sort(windows);
+ windows.remove(0);
+ TWindow activeWindow = null;
+ for (TWindow w: windows) {
+ if (w.getZ() > z) {
+ w.setZ(w.getZ() - 1);
+ if (w.getZ() == 0) {
+ w.setActive(true);
+ w.onFocus();
+ assert (activeWindow == null);
+ activeWindow = w;
+ } else {
+ if (w.isActive()) {
+ w.setActive(false);
+ w.onUnfocus();
+ }
+ }
}
}
}
// Perform window cleanup
window.onClose();
- // Refresh screen
- repaint = true;
-
// Check if we are closing a TMessageBox or similar
if (secondaryEventReceiver != null) {
assert (secondaryEventHandler != null);
// window is closed.
secondaryEventReceiver = null;
- // Wake all threads: primary thread will be consuming events
- // again, and secondary thread will exit.
- synchronized (this) {
- this.notifyAll();
+ // Wake the secondary thread, it will wake the primary as it
+ // exits.
+ synchronized (secondaryEventHandler) {
+ secondaryEventHandler.notify();
}
}
}
return;
}
- // 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()) {
- activeWindowI = i;
- break;
+ synchronized (windows) {
+
+ // 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).isActive()) {
+ activeWindowI = i;
+ break;
+ }
}
- }
- assert (activeWindowI >= 0);
+ assert (activeWindowI >= 0);
- // Do not switch if a window is modal
- if (windows.get(activeWindowI).isModal()) {
- return;
- }
+ // Do not switch if a window is modal
+ if (windows.get(activeWindowI).isModal()) {
+ return;
+ }
- int nextWindowI;
- if (forward) {
- nextWindowI = (activeWindowI + 1) % windows.size();
- } else {
- if (activeWindowI == 0) {
- nextWindowI = windows.size() - 1;
+ int nextWindowI;
+ if (forward) {
+ nextWindowI = (activeWindowI + 1) % windows.size();
} else {
- nextWindowI = activeWindowI - 1;
+ if (activeWindowI == 0) {
+ nextWindowI = windows.size() - 1;
+ } else {
+ nextWindowI = activeWindowI - 1;
+ }
}
- }
- windows.get(activeWindowI).setActive(false);
- windows.get(activeWindowI).setZ(windows.get(nextWindowI).getZ());
- windows.get(nextWindowI).setZ(0);
- windows.get(nextWindowI).setActive(true);
+ 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)
- // Refresh
- repaint = true;
}
/**
* @param window new window to add
*/
public final void addWindow(final TWindow window) {
- // Do not allow a modal window to spawn a non-modal window
- if ((windows.size() > 0) && (windows.get(0).isModal())) {
- assert (window.isModal());
- }
- for (TWindow w: windows) {
- w.setActive(false);
- w.setZ(w.getZ() + 1);
+ synchronized (windows) {
+ // Do not allow a modal window to spawn a non-modal window
+ if ((windows.size() > 0) && (windows.get(0).isModal())) {
+ assert (window.isModal());
+ }
+ for (TWindow w: windows) {
+ if (w.isActive()) {
+ w.setActive(false);
+ w.onUnfocus();
+ }
+ w.setZ(w.getZ() + 1);
+ }
+ windows.add(window);
+ window.setZ(0);
+ window.setActive(true);
+ window.onFocus();
}
- windows.add(window);
- window.setActive(true);
- window.setZ(0);
}
/**
// See if they hit the menu bar
if ((mouse.getType() == TMouseEvent.Type.MOUSE_DOWN)
- && (mouse.getMouse1())
+ && (mouse.isMouse1())
&& (!modalWindowActive())
&& (mouse.getAbsoluteY() == 0)
) {
menu.setActive(false);
}
}
- repaint = true;
return;
}
// See if they hit the menu bar
if ((mouse.getType() == TMouseEvent.Type.MOUSE_MOTION)
- && (mouse.getMouse1())
+ && (mouse.isMouse1())
&& (activeMenu != null)
&& (mouse.getAbsoluteY() == 0)
) {
// They switched menus
oldMenu.setActive(false);
}
- repaint = true;
return;
}
return;
}
- Collections.sort(windows);
- if (windows.get(0).isModal()) {
- // Modal windows don't switch
- return;
- }
+ synchronized (windows) {
+ Collections.sort(windows);
+ if (windows.get(0).isModal()) {
+ // Modal windows don't switch
+ return;
+ }
- for (TWindow window: windows) {
- assert (!window.isModal());
- if (window.mouseWouldHit(mouse)) {
- if (window == windows.get(0)) {
- // Clicked on the same window, nothing to do
+ for (TWindow window: windows) {
+ assert (!window.isModal());
+ if (window.mouseWouldHit(mouse)) {
+ if (window == windows.get(0)) {
+ // Clicked on the same window, nothing to do
+ return;
+ }
+
+ // We will be switching to another window
+ 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;
}
-
- // We will be switching to another window
- assert (windows.get(0).getActive());
- assert (!window.getActive());
- windows.get(0).setActive(false);
- windows.get(0).setZ(window.getZ());
- window.setZ(0);
- window.setActive(true);
- repaint = true;
- return;
}
}
}
subMenus.clear();
}
- repaint = true;
}
/**
assert (item != null);
item.setActive(false);
subMenus.remove(subMenus.size() - 1);
- repaint = true;
}
/**
activeMenu.setActive(false);
activeMenu = menus.get(i);
activeMenu.setActive(true);
- repaint = true;
return;
}
}
TMessageBox.Type.YESNO).getResult() == TMessageBox.Result.YES) {
quit = true;
}
- repaint = true;
return true;
}
- /*
- TODO
if (command.equals(cmShell)) {
- openTerminal(0, 0, TWindow.Flag.RESIZABLE);
- repaint = true;
+ openTerminal(0, 0, TWindow.RESIZABLE);
return true;
}
- */
if (command.equals(cmTile)) {
tileWindows();
- repaint = true;
return true;
}
if (command.equals(cmCascade)) {
cascadeWindows();
- repaint = true;
return true;
}
if (command.equals(cmCloseAll)) {
closeAllWindows();
- repaint = true;
return true;
}
TMessageBox.Type.YESNO).getResult() == TMessageBox.Result.YES) {
quit = true;
}
- // System.err.printf("onMenu MID_EXIT result: quit = %s\n", quit);
- repaint = true;
return true;
}
- /*
- TODO
- if (menu.id == TMenu.MID_SHELL) {
- openTerminal(0, 0, TWindow.Flag.RESIZABLE);
- repaint = true;
+ if (menu.getId() == TMenu.MID_SHELL) {
+ openTerminal(0, 0, TWindow.RESIZABLE);
return true;
}
- */
if (menu.getId() == TMenu.MID_TILE) {
tileWindows();
- repaint = true;
return true;
}
if (menu.getId() == TMenu.MID_CASCADE) {
cascadeWindows();
- repaint = true;
return true;
}
if (menu.getId() == TMenu.MID_CLOSE_ALL) {
closeAllWindows();
- repaint = true;
return true;
}
return false;
// 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)
) {
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);
- repaint = true;
return true;
}
}
}
/**
- * 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);
- // System.err.printf("addAccelerator: key %s item %s\n", keypress, item);
+ TKeypress key = item.getKey();
+ if (key != null) {
+ synchronized (accelerators) {
+ assert (accelerators.get(key) == null);
+ accelerators.put(key.toLowerCase(), item);
+ }
+ }
+ }
- synchronized (accelerators) {
- assert (accelerators.get(keypress) == null);
- accelerators.put(keypress, 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);
+ }
}
}
* @param title menu title
* @return the new menu
*/
- public final TMenu addMenu(String title) {
+ public final TMenu addMenu(final String title) {
int x = 0;
int y = 0;
TMenu menu = new TMenu(this, x, y, title);
if (activeMenu != null) {
return;
}
- for (TWindow window: windows) {
- closeWindow(window);
+
+ synchronized (windows) {
+ for (TWindow window: windows) {
+ closeWindow(window);
+ }
}
}
* almost the same results as Turbo Pascal 7.0's IDE.
*/
private void tileWindows() {
- // Don't do anything if we are in the menu
- if (activeMenu != null) {
- return;
- }
- int z = windows.size();
- if (z == 0) {
- return;
- }
- int a = 0;
- int b = 0;
- a = (int)(Math.sqrt(z));
- int c = 0;
- while (c < a) {
- b = (z - c) / a;
- if (((a * b) + c) == z) {
- break;
+ synchronized (windows) {
+ // Don't do anything if we are in the menu
+ if (activeMenu != null) {
+ return;
}
- c++;
- }
- assert (a > 0);
- assert (b > 0);
- assert (c < a);
- int newWidth = (getScreen().getWidth() / a);
- int newHeight1 = ((getScreen().getHeight() - 1) / b);
- int newHeight2 = ((getScreen().getHeight() - 1) / (b + c));
- // System.err.printf("Z %s a %s b %s c %s newWidth %s newHeight1 %s newHeight2 %s",
- // z, a, b, c, newWidth, newHeight1, newHeight2);
-
- List<TWindow> sorted = new LinkedList<TWindow>(windows);
- Collections.sort(sorted);
- Collections.reverse(sorted);
- for (int i = 0; i < sorted.size(); i++) {
- int logicalX = i / b;
- int logicalY = i % b;
- if (i >= ((a - 1) * b)) {
- logicalX = a - 1;
- logicalY = i - ((a - 1) * b);
+ int z = windows.size();
+ if (z == 0) {
+ return;
}
+ int a = 0;
+ int b = 0;
+ a = (int)(Math.sqrt(z));
+ int c = 0;
+ while (c < a) {
+ b = (z - c) / a;
+ if (((a * b) + c) == z) {
+ break;
+ }
+ c++;
+ }
+ assert (a > 0);
+ assert (b > 0);
+ assert (c < a);
+ int newWidth = (getScreen().getWidth() / a);
+ int newHeight1 = ((getScreen().getHeight() - 1) / b);
+ int newHeight2 = ((getScreen().getHeight() - 1) / (b + c));
+
+ List<TWindow> sorted = new LinkedList<TWindow>(windows);
+ Collections.sort(sorted);
+ Collections.reverse(sorted);
+ for (int i = 0; i < sorted.size(); i++) {
+ int logicalX = i / b;
+ int logicalY = i % b;
+ if (i >= ((a - 1) * b)) {
+ logicalX = a - 1;
+ logicalY = i - ((a - 1) * b);
+ }
- TWindow w = sorted.get(i);
- w.setX(logicalX * newWidth);
- w.setWidth(newWidth);
- if (i >= ((a - 1) * b)) {
- w.setY((logicalY * newHeight2) + 1);
- w.setHeight(newHeight2);
- } else {
- w.setY((logicalY * newHeight1) + 1);
- w.setHeight(newHeight1);
+ TWindow w = sorted.get(i);
+ w.setX(logicalX * newWidth);
+ w.setWidth(newWidth);
+ if (i >= ((a - 1) * b)) {
+ w.setY((logicalY * newHeight2) + 1);
+ w.setHeight(newHeight2);
+ } else {
+ w.setY((logicalY * newHeight1) + 1);
+ w.setHeight(newHeight1);
+ }
}
}
}
* Re-layout the open windows as overlapping cascaded windows.
*/
private void cascadeWindows() {
- // Don't do anything if we are in the menu
- if (activeMenu != null) {
- return;
- }
- int x = 0;
- int y = 1;
- List<TWindow> sorted = new LinkedList<TWindow>(windows);
- Collections.sort(sorted);
- Collections.reverse(sorted);
- for (TWindow window: sorted) {
- window.setX(x);
- window.setY(y);
- x++;
- y++;
- if (x > getScreen().getWidth()) {
- x = 0;
+ synchronized (windows) {
+ // Don't do anything if we are in the menu
+ if (activeMenu != null) {
+ return;
}
- if (y >= getScreen().getHeight()) {
- y = 1;
+ int x = 0;
+ int y = 1;
+ List<TWindow> sorted = new LinkedList<TWindow>(windows);
+ Collections.sort(sorted);
+ Collections.reverse(sorted);
+ for (TWindow window: sorted) {
+ window.setX(x);
+ window.setY(y);
+ x++;
+ y++;
+ if (x > getScreen().getWidth()) {
+ x = 0;
+ }
+ if (y >= getScreen().getHeight()) {
+ y = 1;
+ }
}
}
}
return new TInputBox(this, title, caption, text);
}
+ /**
+ * Convenience function to open a terminal window.
+ *
+ * @param x column relative to parent
+ * @param y row relative to parent
+ * @return the terminal new window
+ */
+ public final TTerminalWindow openTerminal(final int x, final int y) {
+ return openTerminal(x, y, TWindow.RESIZABLE);
+ }
+
+ /**
+ * Convenience function to open a terminal window.
+ *
+ * @param x column relative to parent
+ * @param y row relative to parent
+ * @param flags mask of CENTERED, MODAL, or RESIZABLE
+ * @return the terminal new window
+ */
+ public final TTerminalWindow openTerminal(final int x, final int y,
+ final int flags) {
+
+ 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();
+ }
+
}
git://git.nikiroo.be / nikiroo-utils.git / blobdiff