2 * Jexer - Java Text User Interface
4 * The MIT License (MIT)
6 * Copyright (C) 2016 Kevin Lamonte
8 * Permission is hereby granted, free of charge, to any person obtaining a
9 * copy of this software and associated documentation files (the "Software"),
10 * to deal in the Software without restriction, including without limitation
11 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
12 * and/or sell copies of the Software, and to permit persons to whom the
13 * Software is furnished to do so, subject to the following conditions:
15 * The above copyright notice and this permission notice shall be included in
16 * all copies or substantial portions of the Software.
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
21 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
23 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
24 * DEALINGS IN THE SOFTWARE.
26 * @author Kevin Lamonte [kevin.lamonte@gmail.com]
31 import java
.io
.InputStream
;
32 import java
.io
.IOException
;
33 import java
.io
.OutputStream
;
34 import java
.io
.PrintWriter
;
35 import java
.io
.Reader
;
36 import java
.io
.UnsupportedEncodingException
;
37 import java
.util
.Collections
;
38 import java
.util
.Date
;
39 import java
.util
.HashMap
;
40 import java
.util
.ArrayList
;
41 import java
.util
.LinkedList
;
42 import java
.util
.List
;
45 import jexer
.bits
.CellAttributes
;
46 import jexer
.bits
.ColorTheme
;
47 import jexer
.bits
.GraphicsChars
;
48 import jexer
.event
.TCommandEvent
;
49 import jexer
.event
.TInputEvent
;
50 import jexer
.event
.TKeypressEvent
;
51 import jexer
.event
.TMenuEvent
;
52 import jexer
.event
.TMouseEvent
;
53 import jexer
.event
.TResizeEvent
;
54 import jexer
.backend
.Backend
;
55 import jexer
.backend
.SwingBackend
;
56 import jexer
.backend
.ECMA48Backend
;
57 import jexer
.io
.Screen
;
58 import jexer
.menu
.TMenu
;
59 import jexer
.menu
.TMenuItem
;
60 import static jexer
.TCommand
.*;
63 * TApplication sets up a full Text User Interface application.
65 public class TApplication
implements Runnable
{
68 * If true, emit thread stuff to System.err.
70 private static final boolean debugThreads
= false;
73 * If true, emit events being processed to System.err.
75 private static final boolean debugEvents
= false;
78 * Two backend types are available.
80 public static enum BackendType
{
87 * An ECMA48 / ANSI X3.64 / XTERM style terminal.
98 * WidgetEventHandler is the main event consumer loop. There are at most
99 * two such threads in existence: the primary for normal case and a
100 * secondary that is used for TMessageBox, TInputBox, and similar.
102 private class WidgetEventHandler
implements Runnable
{
104 * The main application.
106 private TApplication application
;
109 * Whether or not this WidgetEventHandler is the primary or secondary
112 private boolean primary
= true;
115 * Public constructor.
117 * @param application the main application
118 * @param primary if true, this is the primary event handler thread
120 public WidgetEventHandler(final TApplication application
,
121 final boolean primary
) {
123 this.application
= application
;
124 this.primary
= primary
;
133 while (!application
.quit
) {
135 // Wait until application notifies me
136 while (!application
.quit
) {
138 synchronized (application
.drainEventQueue
) {
139 if (application
.drainEventQueue
.size() > 0) {
144 synchronized (this) {
146 System
.err
.printf("%s %s sleep\n", this,
147 primary ?
"primary" : "secondary");
153 System
.err
.printf("%s %s AWAKE\n", this,
154 primary ?
"primary" : "secondary");
158 && (application
.secondaryEventReceiver
== null)
160 // Secondary thread, emergency exit. If we
161 // got here then something went wrong with
162 // the handoff between yield() and
164 synchronized (application
.primaryEventHandler
) {
165 application
.primaryEventHandler
.notify();
167 application
.secondaryEventHandler
= null;
168 throw new RuntimeException(
169 "secondary exited at wrong time");
173 } catch (InterruptedException e
) {
178 // Wait for drawAll() or doIdle() to be done, then handle the
180 boolean oldLock
= lockHandleEvent();
181 assert (oldLock
== false);
183 // Pull all events off the queue
185 TInputEvent event
= null;
186 synchronized (application
.drainEventQueue
) {
187 if (application
.drainEventQueue
.size() == 0) {
190 event
= application
.drainEventQueue
.remove(0);
192 application
.repaint
= true;
194 primaryHandleEvent(event
);
196 secondaryHandleEvent(event
);
199 && (application
.secondaryEventReceiver
== null)
201 // Secondary thread, time to exit.
203 // DO NOT UNLOCK. Primary thread just came back from
204 // primaryHandleEvent() and will unlock in the else
205 // block below. Just wake it up.
206 synchronized (application
.primaryEventHandler
) {
207 application
.primaryEventHandler
.notify();
209 // Now eliminate my reference so that
210 // wakeEventHandler() resumes working on the primary.
211 application
.secondaryEventHandler
= null;
218 // Unlock. Either I am primary thread, or I am secondary
219 // thread and still running.
220 oldLock
= unlockHandleEvent();
221 assert (oldLock
== true);
223 // I have done some work of some kind. Tell the main run()
224 // loop to wake up now.
225 synchronized (application
) {
226 application
.notify();
229 } // while (true) (main runnable loop)
234 * The primary event handler thread.
236 private volatile WidgetEventHandler primaryEventHandler
;
239 * The secondary event handler thread.
241 private volatile WidgetEventHandler secondaryEventHandler
;
244 * The widget receiving events from the secondary event handler thread.
246 private volatile TWidget secondaryEventReceiver
;
249 * Spinlock for the primary and secondary event handlers.
250 * WidgetEventHandler.run() is responsible for setting this value.
252 private volatile boolean insideHandleEvent
= false;
255 * Wake the sleeping active event handler.
257 private void wakeEventHandler() {
258 if (secondaryEventHandler
!= null) {
259 synchronized (secondaryEventHandler
) {
260 secondaryEventHandler
.notify();
263 assert (primaryEventHandler
!= null);
264 synchronized (primaryEventHandler
) {
265 primaryEventHandler
.notify();
271 * Set the insideHandleEvent flag to true. lockoutEventHandlers() will
272 * spin indefinitely until unlockHandleEvent() is called.
274 * @return the old value of insideHandleEvent
276 private boolean lockHandleEvent() {
278 System
.err
.printf(" >> lockHandleEvent(): oldValue %s",
281 boolean oldValue
= true;
283 synchronized (this) {
284 // Wait for TApplication.run() to finish using the global state
285 // before allowing further event processing.
286 while (lockoutHandleEvent
== true) {
288 // Backoff so that the backend can finish its work.
290 } catch (InterruptedException e
) {
295 oldValue
= insideHandleEvent
;
296 insideHandleEvent
= true;
300 System
.err
.printf(" ***\n");
306 * Set the insideHandleEvent flag to false. lockoutEventHandlers() will
307 * spin indefinitely until unlockHandleEvent() is called.
309 * @return the old value of insideHandleEvent
311 private boolean unlockHandleEvent() {
313 System
.err
.printf(" << unlockHandleEvent(): oldValue %s\n",
316 synchronized (this) {
317 boolean oldValue
= insideHandleEvent
;
318 insideHandleEvent
= false;
324 * Spinlock for the primary and secondary event handlers. When true, the
325 * event handlers will spinlock wait before calling handleEvent().
327 private volatile boolean lockoutHandleEvent
= false;
330 * TApplication.run() needs to be able rely on the global data structures
331 * being intact when calling doIdle() and drawAll(). Tell the event
332 * handlers to wait for an unlock before handling their events.
334 private void stopEventHandlers() {
336 System
.err
.printf(">> stopEventHandlers()");
339 lockoutHandleEvent
= true;
340 // Wait for the last event to finish processing before returning
341 // control to TApplication.run().
342 while (insideHandleEvent
== true) {
344 // Backoff so that the event handler can finish its work.
346 } catch (InterruptedException e
) {
352 System
.err
.printf(" XXX\n");
357 * TApplication.run() needs to be able rely on the global data structures
358 * being intact when calling doIdle() and drawAll(). Tell the event
359 * handlers that it is now OK to handle their events.
361 private void startEventHandlers() {
363 System
.err
.printf("<< startEventHandlers()\n");
365 lockoutHandleEvent
= false;
369 * Access to the physical screen, keyboard, and mouse.
371 private Backend backend
;
378 public final Screen
getScreen() {
379 return backend
.getScreen();
383 * Actual mouse coordinate X.
388 * Actual mouse coordinate Y.
393 * Old version of mouse coordinate X.
395 private int oldMouseX
;
398 * Old version mouse coordinate Y.
400 private int oldMouseY
;
403 * Event queue that is filled by run().
405 private List
<TInputEvent
> fillEventQueue
;
408 * Event queue that will be drained by either primary or secondary
411 private List
<TInputEvent
> drainEventQueue
;
414 * Top-level menus in this application.
416 private List
<TMenu
> menus
;
419 * Stack of activated sub-menus in this application.
421 private List
<TMenu
> subMenus
;
424 * The currently acive menu.
426 private TMenu activeMenu
= null;
429 * Active keyboard accelerators.
431 private Map
<TKeypress
, TMenuItem
> accelerators
;
436 private List
<TMenuItem
> menuItems
;
439 * Windows and widgets pull colors from this ColorTheme.
441 private ColorTheme theme
;
444 * Get the color theme.
448 public final ColorTheme
getTheme() {
453 * The top-level windows (but not menus).
455 private List
<TWindow
> windows
;
458 * Timers that are being ticked.
460 private List
<TTimer
> timers
;
463 * When true, exit the application.
465 private volatile boolean quit
= false;
468 * When true, repaint the entire screen.
470 private volatile boolean repaint
= true;
473 * Y coordinate of the top edge of the desktop. For now this is a
474 * constant. Someday it would be nice to have a multi-line menu or
477 private static final int desktopTop
= 1;
480 * Get Y coordinate of the top edge of the desktop.
482 * @return Y coordinate of the top edge of the desktop
484 public final int getDesktopTop() {
489 * Y coordinate of the bottom edge of the desktop.
491 private int desktopBottom
;
494 * Get Y coordinate of the bottom edge of the desktop.
496 * @return Y coordinate of the bottom edge of the desktop
498 public final int getDesktopBottom() {
499 return desktopBottom
;
503 * Public constructor.
505 * @param backendType BackendType.XTERM, BackendType.ECMA48 or
507 * @throws UnsupportedEncodingException if an exception is thrown when
508 * creating the InputStreamReader
510 public TApplication(final BackendType backendType
)
511 throws UnsupportedEncodingException
{
513 switch (backendType
) {
515 backend
= new SwingBackend(this);
520 backend
= new ECMA48Backend(this, null, null);
523 throw new IllegalArgumentException("Invalid backend type: "
530 * Public constructor. The backend type will be BackendType.ECMA48.
532 * @param input an InputStream connected to the remote user, or null for
533 * System.in. If System.in is used, then on non-Windows systems it will
534 * be put in raw mode; shutdown() will (blindly!) put System.in in cooked
535 * mode. input is always converted to a Reader with UTF-8 encoding.
536 * @param output an OutputStream connected to the remote user, or null
537 * for System.out. output is always converted to a Writer with UTF-8
539 * @throws UnsupportedEncodingException if an exception is thrown when
540 * creating the InputStreamReader
542 public TApplication(final InputStream input
,
543 final OutputStream output
) throws UnsupportedEncodingException
{
545 backend
= new ECMA48Backend(this, input
, output
);
550 * Public constructor. The backend type will be BackendType.ECMA48.
552 * @param input the InputStream underlying 'reader'. Its available()
553 * method is used to determine if reader.read() will block or not.
554 * @param reader a Reader connected to the remote user.
555 * @param writer a PrintWriter connected to the remote user.
556 * @param setRawMode if true, set System.in into raw mode with stty.
557 * This should in general not be used. It is here solely for Demo3,
558 * which uses System.in.
559 * @throws IllegalArgumentException if input, reader, or writer are null.
561 public TApplication(final InputStream input
, final Reader reader
,
562 final PrintWriter writer
, final boolean setRawMode
) {
564 backend
= new ECMA48Backend(this, input
, reader
, writer
, setRawMode
);
569 * Public constructor. The backend type will be BackendType.ECMA48.
571 * @param input the InputStream underlying 'reader'. Its available()
572 * method is used to determine if reader.read() will block or not.
573 * @param reader a Reader connected to the remote user.
574 * @param writer a PrintWriter connected to the remote user.
575 * @throws IllegalArgumentException if input, reader, or writer are null.
577 public TApplication(final InputStream input
, final Reader reader
,
578 final PrintWriter writer
) {
580 this(input
, reader
, writer
, false);
584 * Public constructor. This hook enables use with new non-Jexer
587 * @param backend a Backend that is already ready to go.
589 public TApplication(final Backend backend
) {
590 this.backend
= backend
;
595 * Finish construction once the backend is set.
597 private void TApplicationImpl() {
598 theme
= new ColorTheme();
599 desktopBottom
= getScreen().getHeight() - 1;
600 fillEventQueue
= new ArrayList
<TInputEvent
>();
601 drainEventQueue
= new ArrayList
<TInputEvent
>();
602 windows
= new LinkedList
<TWindow
>();
603 menus
= new LinkedList
<TMenu
>();
604 subMenus
= new LinkedList
<TMenu
>();
605 timers
= new LinkedList
<TTimer
>();
606 accelerators
= new HashMap
<TKeypress
, TMenuItem
>();
607 menuItems
= new ArrayList
<TMenuItem
>();
609 // Setup the main consumer thread
610 primaryEventHandler
= new WidgetEventHandler(this, true);
611 (new Thread(primaryEventHandler
)).start();
615 * Invert the cell color at a position. This is used to track the mouse.
617 * @param x column position
618 * @param y row position
620 private void invertCell(final int x
, final int y
) {
622 System
.err
.printf("invertCell() %d %d\n", x
, y
);
624 CellAttributes attr
= getScreen().getAttrXY(x
, y
);
625 attr
.setForeColor(attr
.getForeColor().invert());
626 attr
.setBackColor(attr
.getBackColor().invert());
627 getScreen().putAttrXY(x
, y
, attr
, false);
633 private void drawAll() {
635 System
.err
.printf("drawAll() enter\n");
640 System
.err
.printf("drawAll() !repaint\n");
642 synchronized (getScreen()) {
643 if ((oldMouseX
!= mouseX
) || (oldMouseY
!= mouseY
)) {
644 // The only thing that has happened is the mouse moved.
645 // Clear the old position and draw the new position.
646 invertCell(oldMouseX
, oldMouseY
);
647 invertCell(mouseX
, mouseY
);
651 if (getScreen().isDirty()) {
652 backend
.flushScreen();
659 System
.err
.printf("drawAll() REDRAW\n");
662 // If true, the cursor is not visible
663 boolean cursor
= false;
665 // Start with a clean screen
668 // Draw the background
669 CellAttributes background
= theme
.getColor("tapplication.background");
670 getScreen().putAll(GraphicsChars
.HATCH
, background
);
672 // Draw each window in reverse Z order
673 List
<TWindow
> sorted
= new LinkedList
<TWindow
>(windows
);
674 Collections
.sort(sorted
);
675 Collections
.reverse(sorted
);
676 for (TWindow window
: sorted
) {
677 window
.drawChildren();
680 // Draw the blank menubar line - reset the screen clipping first so
681 // it won't trim it out.
682 getScreen().resetClipping();
683 getScreen().hLineXY(0, 0, getScreen().getWidth(), ' ',
684 theme
.getColor("tmenu"));
685 // Now draw the menus.
687 for (TMenu menu
: menus
) {
688 CellAttributes menuColor
;
689 CellAttributes menuMnemonicColor
;
690 if (menu
.isActive()) {
691 menuColor
= theme
.getColor("tmenu.highlighted");
692 menuMnemonicColor
= theme
.getColor("tmenu.mnemonic.highlighted");
694 menuColor
= theme
.getColor("tmenu");
695 menuMnemonicColor
= theme
.getColor("tmenu.mnemonic");
697 // Draw the menu title
698 getScreen().hLineXY(x
, 0, menu
.getTitle().length() + 2, ' ',
700 getScreen().putStringXY(x
+ 1, 0, menu
.getTitle(), menuColor
);
701 // Draw the highlight character
702 getScreen().putCharXY(x
+ 1 + menu
.getMnemonic().getShortcutIdx(),
703 0, menu
.getMnemonic().getShortcut(), menuMnemonicColor
);
705 if (menu
.isActive()) {
707 // Reset the screen clipping so we can draw the next title.
708 getScreen().resetClipping();
710 x
+= menu
.getTitle().length() + 2;
713 for (TMenu menu
: subMenus
) {
714 // Reset the screen clipping so we can draw the next sub-menu.
715 getScreen().resetClipping();
719 // Draw the mouse pointer
720 invertCell(mouseX
, mouseY
);
724 // Place the cursor if it is visible
725 TWidget activeWidget
= null;
726 if (sorted
.size() > 0) {
727 activeWidget
= sorted
.get(sorted
.size() - 1).getActiveChild();
728 if (activeWidget
.isCursorVisible()) {
729 getScreen().putCursor(true, activeWidget
.getCursorAbsoluteX(),
730 activeWidget
.getCursorAbsoluteY());
737 getScreen().hideCursor();
740 // Flush the screen contents
741 if (getScreen().isDirty()) {
742 backend
.flushScreen();
749 * Run this application until it exits.
753 // Timeout is in milliseconds, so default timeout after 1 second
757 // If I've got no updates to render, wait for something from the
758 // backend or a timer.
760 && ((mouseX
== oldMouseX
) && (mouseY
== oldMouseY
))
762 // Never sleep longer than 50 millis. We need time for
763 // windows with background tasks to update the display, and
764 // still flip buffers reasonably quickly in
765 // backend.flushPhysical().
766 timeout
= getSleepTime(50);
770 // As of now, I've got nothing to do: no I/O, nothing from
771 // the consumer threads, no timers that need to run ASAP. So
772 // wait until either the backend or the consumer threads have
775 synchronized (this) {
778 } catch (InterruptedException e
) {
779 // I'm awake and don't care why, let's see what's going
785 // Prevent stepping on the primary or secondary event handler.
788 // Pull any pending I/O events
789 backend
.getEvents(fillEventQueue
);
791 // Dispatch each event to the appropriate handler, one at a time.
793 TInputEvent event
= null;
794 if (fillEventQueue
.size() == 0) {
797 event
= fillEventQueue
.remove(0);
798 metaHandleEvent(event
);
801 // Wake a consumer thread if we have any pending events.
802 if (drainEventQueue
.size() > 0) {
806 // Process timers and call doIdle()'s
810 synchronized (getScreen()) {
814 // Let the event handlers run again.
815 startEventHandlers();
819 // Shutdown the event consumer threads
820 if (secondaryEventHandler
!= null) {
821 synchronized (secondaryEventHandler
) {
822 secondaryEventHandler
.notify();
825 if (primaryEventHandler
!= null) {
826 synchronized (primaryEventHandler
) {
827 primaryEventHandler
.notify();
831 // Shutdown the user I/O thread(s)
834 // Close all the windows. This gives them an opportunity to release
841 * Peek at certain application-level events, add to eventQueue, and wake
842 * up the consuming Thread.
844 * @param event the input event to consume
846 private void metaHandleEvent(final TInputEvent event
) {
849 System
.err
.printf(String
.format("metaHandleEvents event: %s\n",
850 event
)); System
.err
.flush();
854 // Do no more processing if the application is already trying
859 // Special application-wide events -------------------------------
862 if (event
instanceof TCommandEvent
) {
863 TCommandEvent command
= (TCommandEvent
) event
;
864 if (command
.getCmd().equals(cmAbort
)) {
871 if (event
instanceof TResizeEvent
) {
872 TResizeEvent resize
= (TResizeEvent
) event
;
873 synchronized (getScreen()) {
874 getScreen().setDimensions(resize
.getWidth(),
876 desktopBottom
= getScreen().getHeight() - 1;
885 // Peek at the mouse position
886 if (event
instanceof TMouseEvent
) {
887 TMouseEvent mouse
= (TMouseEvent
) event
;
888 synchronized (getScreen()) {
889 if ((mouseX
!= mouse
.getX()) || (mouseY
!= mouse
.getY())) {
892 mouseX
= mouse
.getX();
893 mouseY
= mouse
.getY();
898 // Put into the main queue
899 drainEventQueue
.add(event
);
903 * Dispatch one event to the appropriate widget or application-level
904 * event handler. This is the primary event handler, it has the normal
905 * application-wide event handling.
907 * @param event the input event to consume
908 * @see #secondaryHandleEvent(TInputEvent event)
910 private void primaryHandleEvent(final TInputEvent event
) {
913 System
.err
.printf("Handle event: %s\n", event
);
916 // Special application-wide events -----------------------------------
918 // Peek at the mouse position
919 if (event
instanceof TMouseEvent
) {
920 // See if we need to switch focus to another window or the menu
921 checkSwitchFocus((TMouseEvent
) event
);
924 // Handle menu events
925 if ((activeMenu
!= null) && !(event
instanceof TCommandEvent
)) {
926 TMenu menu
= activeMenu
;
928 if (event
instanceof TMouseEvent
) {
929 TMouseEvent mouse
= (TMouseEvent
) event
;
931 while (subMenus
.size() > 0) {
932 TMenu subMenu
= subMenus
.get(subMenus
.size() - 1);
933 if (subMenu
.mouseWouldHit(mouse
)) {
936 if ((mouse
.getType() == TMouseEvent
.Type
.MOUSE_MOTION
)
937 && (!mouse
.isMouse1())
938 && (!mouse
.isMouse2())
939 && (!mouse
.isMouse3())
940 && (!mouse
.isMouseWheelUp())
941 && (!mouse
.isMouseWheelDown())
945 // We navigated away from a sub-menu, so close it
949 // Convert the mouse relative x/y to menu coordinates
950 assert (mouse
.getX() == mouse
.getAbsoluteX());
951 assert (mouse
.getY() == mouse
.getAbsoluteY());
952 if (subMenus
.size() > 0) {
953 menu
= subMenus
.get(subMenus
.size() - 1);
955 mouse
.setX(mouse
.getX() - menu
.getX());
956 mouse
.setY(mouse
.getY() - menu
.getY());
958 menu
.handleEvent(event
);
962 if (event
instanceof TKeypressEvent
) {
963 TKeypressEvent keypress
= (TKeypressEvent
) event
;
965 // See if this key matches an accelerator, and if so dispatch the
967 TKeypress keypressLowercase
= keypress
.getKey().toLowerCase();
968 TMenuItem item
= null;
969 synchronized (accelerators
) {
970 item
= accelerators
.get(keypressLowercase
);
973 if (item
.isEnabled()) {
974 // Let the menu item dispatch
979 // Handle the keypress
980 if (onKeypress(keypress
)) {
985 if (event
instanceof TCommandEvent
) {
986 if (onCommand((TCommandEvent
) event
)) {
991 if (event
instanceof TMenuEvent
) {
992 if (onMenu((TMenuEvent
) event
)) {
997 // Dispatch events to the active window -------------------------------
998 for (TWindow window
: windows
) {
999 if (window
.isActive()) {
1000 if (event
instanceof TMouseEvent
) {
1001 TMouseEvent mouse
= (TMouseEvent
) event
;
1002 // Convert the mouse relative x/y to window coordinates
1003 assert (mouse
.getX() == mouse
.getAbsoluteX());
1004 assert (mouse
.getY() == mouse
.getAbsoluteY());
1005 mouse
.setX(mouse
.getX() - window
.getX());
1006 mouse
.setY(mouse
.getY() - window
.getY());
1009 System
.err
.printf("TApplication dispatch event: %s\n",
1012 window
.handleEvent(event
);
1018 * Dispatch one event to the appropriate widget or application-level
1019 * event handler. This is the secondary event handler used by certain
1020 * special dialogs (currently TMessageBox and TFileOpenBox).
1022 * @param event the input event to consume
1023 * @see #primaryHandleEvent(TInputEvent event)
1025 private void secondaryHandleEvent(final TInputEvent event
) {
1026 secondaryEventReceiver
.handleEvent(event
);
1030 * Enable a widget to override the primary event thread.
1032 * @param widget widget that will receive events
1034 public final void enableSecondaryEventReceiver(final TWidget widget
) {
1035 assert (secondaryEventReceiver
== null);
1036 assert (secondaryEventHandler
== null);
1037 assert ((widget
instanceof TMessageBox
)
1038 || (widget
instanceof TFileOpenBox
));
1039 secondaryEventReceiver
= widget
;
1040 secondaryEventHandler
= new WidgetEventHandler(this, false);
1041 (new Thread(secondaryEventHandler
)).start();
1045 * Yield to the secondary thread.
1047 public final void yield() {
1048 assert (secondaryEventReceiver
!= null);
1049 // This is where we handoff the event handler lock from the primary
1050 // to secondary thread. We unlock here, and in a future loop the
1051 // secondary thread locks again. When it gives up, we have the
1052 // single lock back.
1053 boolean oldLock
= unlockHandleEvent();
1056 while (secondaryEventReceiver
!= null) {
1057 synchronized (primaryEventHandler
) {
1059 primaryEventHandler
.wait();
1060 } catch (InterruptedException e
) {
1068 * Do stuff when there is no user input.
1070 private void doIdle() {
1072 System
.err
.printf("doIdle()\n");
1075 // Now run any timers that have timed out
1076 Date now
= new Date();
1077 List
<TTimer
> keepTimers
= new LinkedList
<TTimer
>();
1078 for (TTimer timer
: timers
) {
1079 if (timer
.getNextTick().getTime() <= now
.getTime()) {
1081 if (timer
.recurring
) {
1082 keepTimers
.add(timer
);
1085 keepTimers
.add(timer
);
1088 timers
= keepTimers
;
1091 for (TWindow window
: windows
) {
1097 * Get the amount of time I can sleep before missing a Timer tick.
1099 * @param timeout = initial (maximum) timeout in millis
1100 * @return number of milliseconds between now and the next timer event
1102 private long getSleepTime(final long timeout
) {
1103 Date now
= new Date();
1104 long nowTime
= now
.getTime();
1105 long sleepTime
= timeout
;
1106 for (TTimer timer
: timers
) {
1107 long nextTickTime
= timer
.getNextTick().getTime();
1108 if (nextTickTime
< nowTime
) {
1112 long timeDifference
= nextTickTime
- nowTime
;
1113 if (timeDifference
< sleepTime
) {
1114 sleepTime
= timeDifference
;
1117 assert (sleepTime
>= 0);
1118 assert (sleepTime
<= timeout
);
1123 * Close window. Note that the window's destructor is NOT called by this
1124 * method, instead the GC is assumed to do the cleanup.
1126 * @param window the window to remove
1128 public final void closeWindow(final TWindow window
) {
1129 synchronized (windows
) {
1130 int z
= window
.getZ();
1133 Collections
.sort(windows
);
1135 TWindow activeWindow
= null;
1136 for (TWindow w
: windows
) {
1138 w
.setZ(w
.getZ() - 1);
1139 if (w
.getZ() == 0) {
1142 assert (activeWindow
== null);
1154 // Perform window cleanup
1157 // Check if we are closing a TMessageBox or similar
1158 if (secondaryEventReceiver
!= null) {
1159 assert (secondaryEventHandler
!= null);
1161 // Do not send events to the secondaryEventReceiver anymore, the
1162 // window is closed.
1163 secondaryEventReceiver
= null;
1165 // Wake the secondary thread, it will wake the primary as it
1167 synchronized (secondaryEventHandler
) {
1168 secondaryEventHandler
.notify();
1174 * Switch to the next window.
1176 * @param forward if true, then switch to the next window in the list,
1177 * otherwise switch to the previous window in the list
1179 public final void switchWindow(final boolean forward
) {
1180 // Only switch if there are multiple windows
1181 if (windows
.size() < 2) {
1185 synchronized (windows
) {
1187 // Swap z/active between active window and the next in the list
1188 int activeWindowI
= -1;
1189 for (int i
= 0; i
< windows
.size(); i
++) {
1190 if (windows
.get(i
).isActive()) {
1195 assert (activeWindowI
>= 0);
1197 // Do not switch if a window is modal
1198 if (windows
.get(activeWindowI
).isModal()) {
1204 nextWindowI
= (activeWindowI
+ 1) % windows
.size();
1206 if (activeWindowI
== 0) {
1207 nextWindowI
= windows
.size() - 1;
1209 nextWindowI
= activeWindowI
- 1;
1212 windows
.get(activeWindowI
).setActive(false);
1213 windows
.get(activeWindowI
).setZ(windows
.get(nextWindowI
).getZ());
1214 windows
.get(activeWindowI
).onUnfocus();
1215 windows
.get(nextWindowI
).setZ(0);
1216 windows
.get(nextWindowI
).setActive(true);
1217 windows
.get(nextWindowI
).onFocus();
1219 } // synchronized (windows)
1224 * Add a window to my window list and make it active.
1226 * @param window new window to add
1228 public final void addWindow(final TWindow window
) {
1229 synchronized (windows
) {
1230 // Do not allow a modal window to spawn a non-modal window
1231 if ((windows
.size() > 0) && (windows
.get(0).isModal())) {
1232 assert (window
.isModal());
1234 for (TWindow w
: windows
) {
1239 w
.setZ(w
.getZ() + 1);
1241 windows
.add(window
);
1243 window
.setActive(true);
1249 * Check if there is a system-modal window on top.
1251 * @return true if the active window is modal
1253 private boolean modalWindowActive() {
1254 if (windows
.size() == 0) {
1257 return windows
.get(windows
.size() - 1).isModal();
1261 * Check if a mouse event would hit either the active menu or any open
1264 * @param mouse mouse event
1265 * @return true if the mouse would hit the active menu or an open
1268 private boolean mouseOnMenu(final TMouseEvent mouse
) {
1269 assert (activeMenu
!= null);
1270 List
<TMenu
> menus
= new LinkedList
<TMenu
>(subMenus
);
1271 Collections
.reverse(menus
);
1272 for (TMenu menu
: menus
) {
1273 if (menu
.mouseWouldHit(mouse
)) {
1277 return activeMenu
.mouseWouldHit(mouse
);
1281 * See if we need to switch window or activate the menu based on
1284 * @param mouse mouse event
1286 private void checkSwitchFocus(final TMouseEvent mouse
) {
1288 if ((mouse
.getType() == TMouseEvent
.Type
.MOUSE_DOWN
)
1289 && (activeMenu
!= null)
1290 && (mouse
.getAbsoluteY() != 0)
1291 && (!mouseOnMenu(mouse
))
1293 // They clicked outside the active menu, turn it off
1294 activeMenu
.setActive(false);
1296 for (TMenu menu
: subMenus
) {
1297 menu
.setActive(false);
1303 // See if they hit the menu bar
1304 if ((mouse
.getType() == TMouseEvent
.Type
.MOUSE_DOWN
)
1305 && (mouse
.isMouse1())
1306 && (!modalWindowActive())
1307 && (mouse
.getAbsoluteY() == 0)
1310 for (TMenu menu
: subMenus
) {
1311 menu
.setActive(false);
1315 // They selected the menu, go activate it
1316 for (TMenu menu
: menus
) {
1317 if ((mouse
.getAbsoluteX() >= menu
.getX())
1318 && (mouse
.getAbsoluteX() < menu
.getX()
1319 + menu
.getTitle().length() + 2)
1321 menu
.setActive(true);
1324 menu
.setActive(false);
1330 // See if they hit the menu bar
1331 if ((mouse
.getType() == TMouseEvent
.Type
.MOUSE_MOTION
)
1332 && (mouse
.isMouse1())
1333 && (activeMenu
!= null)
1334 && (mouse
.getAbsoluteY() == 0)
1337 TMenu oldMenu
= activeMenu
;
1338 for (TMenu menu
: subMenus
) {
1339 menu
.setActive(false);
1343 // See if we should switch menus
1344 for (TMenu menu
: menus
) {
1345 if ((mouse
.getAbsoluteX() >= menu
.getX())
1346 && (mouse
.getAbsoluteX() < menu
.getX()
1347 + menu
.getTitle().length() + 2)
1349 menu
.setActive(true);
1353 if (oldMenu
!= activeMenu
) {
1354 // They switched menus
1355 oldMenu
.setActive(false);
1360 // Only switch if there are multiple windows
1361 if (windows
.size() < 2) {
1365 // Switch on the upclick
1366 if (mouse
.getType() != TMouseEvent
.Type
.MOUSE_UP
) {
1370 synchronized (windows
) {
1371 Collections
.sort(windows
);
1372 if (windows
.get(0).isModal()) {
1373 // Modal windows don't switch
1377 for (TWindow window
: windows
) {
1378 assert (!window
.isModal());
1379 if (window
.mouseWouldHit(mouse
)) {
1380 if (window
== windows
.get(0)) {
1381 // Clicked on the same window, nothing to do
1385 // We will be switching to another window
1386 assert (windows
.get(0).isActive());
1387 assert (!window
.isActive());
1388 windows
.get(0).onUnfocus();
1389 windows
.get(0).setActive(false);
1390 windows
.get(0).setZ(window
.getZ());
1392 window
.setActive(true);
1399 // Clicked on the background, nothing to do
1404 * Turn off the menu.
1406 public final void closeMenu() {
1407 if (activeMenu
!= null) {
1408 activeMenu
.setActive(false);
1410 for (TMenu menu
: subMenus
) {
1411 menu
.setActive(false);
1418 * Turn off a sub-menu.
1420 public final void closeSubMenu() {
1421 assert (activeMenu
!= null);
1422 TMenu item
= subMenus
.get(subMenus
.size() - 1);
1423 assert (item
!= null);
1424 item
.setActive(false);
1425 subMenus
.remove(subMenus
.size() - 1);
1429 * Switch to the next menu.
1431 * @param forward if true, then switch to the next menu in the list,
1432 * otherwise switch to the previous menu in the list
1434 public final void switchMenu(final boolean forward
) {
1435 assert (activeMenu
!= null);
1437 for (TMenu menu
: subMenus
) {
1438 menu
.setActive(false);
1442 for (int i
= 0; i
< menus
.size(); i
++) {
1443 if (activeMenu
== menus
.get(i
)) {
1445 if (i
< menus
.size() - 1) {
1453 activeMenu
.setActive(false);
1454 activeMenu
= menus
.get(i
);
1455 activeMenu
.setActive(true);
1462 * Method that TApplication subclasses can override to handle menu or
1463 * posted command events.
1465 * @param command command event
1466 * @return if true, this event was consumed
1468 protected boolean onCommand(final TCommandEvent command
) {
1469 // Default: handle cmExit
1470 if (command
.equals(cmExit
)) {
1471 if (messageBox("Confirmation", "Exit application?",
1472 TMessageBox
.Type
.YESNO
).getResult() == TMessageBox
.Result
.YES
) {
1478 if (command
.equals(cmShell
)) {
1479 openTerminal(0, 0, TWindow
.RESIZABLE
);
1483 if (command
.equals(cmTile
)) {
1487 if (command
.equals(cmCascade
)) {
1491 if (command
.equals(cmCloseAll
)) {
1500 * Method that TApplication subclasses can override to handle menu
1503 * @param menu menu event
1504 * @return if true, this event was consumed
1506 protected boolean onMenu(final TMenuEvent menu
) {
1508 // Default: handle MID_EXIT
1509 if (menu
.getId() == TMenu
.MID_EXIT
) {
1510 if (messageBox("Confirmation", "Exit application?",
1511 TMessageBox
.Type
.YESNO
).getResult() == TMessageBox
.Result
.YES
) {
1517 if (menu
.getId() == TMenu
.MID_SHELL
) {
1518 openTerminal(0, 0, TWindow
.RESIZABLE
);
1522 if (menu
.getId() == TMenu
.MID_TILE
) {
1526 if (menu
.getId() == TMenu
.MID_CASCADE
) {
1530 if (menu
.getId() == TMenu
.MID_CLOSE_ALL
) {
1538 * Method that TApplication subclasses can override to handle keystrokes.
1540 * @param keypress keystroke event
1541 * @return if true, this event was consumed
1543 protected boolean onKeypress(final TKeypressEvent keypress
) {
1544 // Default: only menu shortcuts
1546 // Process Alt-F, Alt-E, etc. menu shortcut keys
1547 if (!keypress
.getKey().isFnKey()
1548 && keypress
.getKey().isAlt()
1549 && !keypress
.getKey().isCtrl()
1550 && (activeMenu
== null)
1553 assert (subMenus
.size() == 0);
1555 for (TMenu menu
: menus
) {
1556 if (Character
.toLowerCase(menu
.getMnemonic().getShortcut())
1557 == Character
.toLowerCase(keypress
.getKey().getChar())
1560 menu
.setActive(true);
1570 * Add a menu item to the global list. If it has a keyboard accelerator,
1571 * that will be added the global hash.
1573 * @param item the menu item
1575 public final void addMenuItem(final TMenuItem item
) {
1576 menuItems
.add(item
);
1578 TKeypress key
= item
.getKey();
1580 synchronized (accelerators
) {
1581 assert (accelerators
.get(key
) == null);
1582 accelerators
.put(key
.toLowerCase(), item
);
1588 * Disable one menu item.
1590 * @param id the menu item ID
1592 public final void disableMenuItem(final int id
) {
1593 for (TMenuItem item
: menuItems
) {
1594 if (item
.getId() == id
) {
1595 item
.setEnabled(false);
1601 * Disable the range of menu items with ID's between lower and upper,
1604 * @param lower the lowest menu item ID
1605 * @param upper the highest menu item ID
1607 public final void disableMenuItems(final int lower
, final int upper
) {
1608 for (TMenuItem item
: menuItems
) {
1609 if ((item
.getId() >= lower
) && (item
.getId() <= upper
)) {
1610 item
.setEnabled(false);
1616 * Enable one menu item.
1618 * @param id the menu item ID
1620 public final void enableMenuItem(final int id
) {
1621 for (TMenuItem item
: menuItems
) {
1622 if (item
.getId() == id
) {
1623 item
.setEnabled(true);
1629 * Enable the range of menu items with ID's between lower and upper,
1632 * @param lower the lowest menu item ID
1633 * @param upper the highest menu item ID
1635 public final void enableMenuItems(final int lower
, final int upper
) {
1636 for (TMenuItem item
: menuItems
) {
1637 if ((item
.getId() >= lower
) && (item
.getId() <= upper
)) {
1638 item
.setEnabled(true);
1644 * Recompute menu x positions based on their title length.
1646 public final void recomputeMenuX() {
1648 for (TMenu menu
: menus
) {
1650 x
+= menu
.getTitle().length() + 2;
1655 * Post an event to process and turn off the menu.
1657 * @param event new event to add to the queue
1659 public final void addMenuEvent(final TInputEvent event
) {
1660 synchronized (fillEventQueue
) {
1661 fillEventQueue
.add(event
);
1667 * Add a sub-menu to the list of open sub-menus.
1669 * @param menu sub-menu
1671 public final void addSubMenu(final TMenu menu
) {
1676 * Convenience function to add a top-level menu.
1678 * @param title menu title
1679 * @return the new menu
1681 public final TMenu
addMenu(final String title
) {
1684 TMenu menu
= new TMenu(this, x
, y
, title
);
1691 * Convenience function to add a default "File" menu.
1693 * @return the new menu
1695 public final TMenu
addFileMenu() {
1696 TMenu fileMenu
= addMenu("&File");
1697 fileMenu
.addDefaultItem(TMenu
.MID_OPEN_FILE
);
1698 fileMenu
.addSeparator();
1699 fileMenu
.addDefaultItem(TMenu
.MID_SHELL
);
1700 fileMenu
.addDefaultItem(TMenu
.MID_EXIT
);
1705 * Convenience function to add a default "Edit" menu.
1707 * @return the new menu
1709 public final TMenu
addEditMenu() {
1710 TMenu editMenu
= addMenu("&Edit");
1711 editMenu
.addDefaultItem(TMenu
.MID_CUT
);
1712 editMenu
.addDefaultItem(TMenu
.MID_COPY
);
1713 editMenu
.addDefaultItem(TMenu
.MID_PASTE
);
1714 editMenu
.addDefaultItem(TMenu
.MID_CLEAR
);
1719 * Convenience function to add a default "Window" menu.
1721 * @return the new menu
1723 public final TMenu
addWindowMenu() {
1724 TMenu windowMenu
= addMenu("&Window");
1725 windowMenu
.addDefaultItem(TMenu
.MID_TILE
);
1726 windowMenu
.addDefaultItem(TMenu
.MID_CASCADE
);
1727 windowMenu
.addDefaultItem(TMenu
.MID_CLOSE_ALL
);
1728 windowMenu
.addSeparator();
1729 windowMenu
.addDefaultItem(TMenu
.MID_WINDOW_MOVE
);
1730 windowMenu
.addDefaultItem(TMenu
.MID_WINDOW_ZOOM
);
1731 windowMenu
.addDefaultItem(TMenu
.MID_WINDOW_NEXT
);
1732 windowMenu
.addDefaultItem(TMenu
.MID_WINDOW_PREVIOUS
);
1733 windowMenu
.addDefaultItem(TMenu
.MID_WINDOW_CLOSE
);
1738 * Close all open windows.
1740 private void closeAllWindows() {
1741 // Don't do anything if we are in the menu
1742 if (activeMenu
!= null) {
1746 synchronized (windows
) {
1747 for (TWindow window
: windows
) {
1748 closeWindow(window
);
1754 * Re-layout the open windows as non-overlapping tiles. This produces
1755 * almost the same results as Turbo Pascal 7.0's IDE.
1757 private void tileWindows() {
1758 synchronized (windows
) {
1759 // Don't do anything if we are in the menu
1760 if (activeMenu
!= null) {
1763 int z
= windows
.size();
1769 a
= (int)(Math
.sqrt(z
));
1773 if (((a
* b
) + c
) == z
) {
1781 int newWidth
= (getScreen().getWidth() / a
);
1782 int newHeight1
= ((getScreen().getHeight() - 1) / b
);
1783 int newHeight2
= ((getScreen().getHeight() - 1) / (b
+ c
));
1785 List
<TWindow
> sorted
= new LinkedList
<TWindow
>(windows
);
1786 Collections
.sort(sorted
);
1787 Collections
.reverse(sorted
);
1788 for (int i
= 0; i
< sorted
.size(); i
++) {
1789 int logicalX
= i
/ b
;
1790 int logicalY
= i
% b
;
1791 if (i
>= ((a
- 1) * b
)) {
1793 logicalY
= i
- ((a
- 1) * b
);
1796 TWindow w
= sorted
.get(i
);
1797 w
.setX(logicalX
* newWidth
);
1798 w
.setWidth(newWidth
);
1799 if (i
>= ((a
- 1) * b
)) {
1800 w
.setY((logicalY
* newHeight2
) + 1);
1801 w
.setHeight(newHeight2
);
1803 w
.setY((logicalY
* newHeight1
) + 1);
1804 w
.setHeight(newHeight1
);
1811 * Re-layout the open windows as overlapping cascaded windows.
1813 private void cascadeWindows() {
1814 synchronized (windows
) {
1815 // Don't do anything if we are in the menu
1816 if (activeMenu
!= null) {
1821 List
<TWindow
> sorted
= new LinkedList
<TWindow
>(windows
);
1822 Collections
.sort(sorted
);
1823 Collections
.reverse(sorted
);
1824 for (TWindow window
: sorted
) {
1829 if (x
> getScreen().getWidth()) {
1832 if (y
>= getScreen().getHeight()) {
1840 * Convenience function to add a timer.
1842 * @param duration number of milliseconds to wait between ticks
1843 * @param recurring if true, re-schedule this timer after every tick
1844 * @param action function to call when button is pressed
1847 public final TTimer
addTimer(final long duration
, final boolean recurring
,
1848 final TAction action
) {
1850 TTimer timer
= new TTimer(duration
, recurring
, action
);
1851 synchronized (timers
) {
1858 * Convenience function to remove a timer.
1860 * @param timer timer to remove
1862 public final void removeTimer(final TTimer timer
) {
1863 synchronized (timers
) {
1864 timers
.remove(timer
);
1869 * Convenience function to spawn a message box.
1871 * @param title window title, will be centered along the top border
1872 * @param caption message to display. Use embedded newlines to get a
1874 * @return the new message box
1876 public final TMessageBox
messageBox(final String title
,
1877 final String caption
) {
1879 return new TMessageBox(this, title
, caption
, TMessageBox
.Type
.OK
);
1883 * Convenience function to spawn a message box.
1885 * @param title window title, will be centered along the top border
1886 * @param caption message to display. Use embedded newlines to get a
1888 * @param type one of the TMessageBox.Type constants. Default is
1890 * @return the new message box
1892 public final TMessageBox
messageBox(final String title
,
1893 final String caption
, final TMessageBox
.Type type
) {
1895 return new TMessageBox(this, title
, caption
, type
);
1899 * Convenience function to spawn an input box.
1901 * @param title window title, will be centered along the top border
1902 * @param caption message to display. Use embedded newlines to get a
1904 * @return the new input box
1906 public final TInputBox
inputBox(final String title
, final String caption
) {
1908 return new TInputBox(this, title
, caption
);
1912 * Convenience function to spawn an input box.
1914 * @param title window title, will be centered along the top border
1915 * @param caption message to display. Use embedded newlines to get a
1917 * @param text initial text to seed the field with
1918 * @return the new input box
1920 public final TInputBox
inputBox(final String title
, final String caption
,
1921 final String text
) {
1923 return new TInputBox(this, title
, caption
, text
);
1927 * Convenience function to open a terminal window.
1929 * @param x column relative to parent
1930 * @param y row relative to parent
1931 * @return the terminal new window
1933 public final TTerminalWindow
openTerminal(final int x
, final int y
) {
1934 return openTerminal(x
, y
, TWindow
.RESIZABLE
);
1938 * Convenience function to open a terminal window.
1940 * @param x column relative to parent
1941 * @param y row relative to parent
1942 * @param flags mask of CENTERED, MODAL, or RESIZABLE
1943 * @return the terminal new window
1945 public final TTerminalWindow
openTerminal(final int x
, final int y
,
1948 return new TTerminalWindow(this, x
, y
, flags
);
1952 * Convenience function to spawn an file open box.
1954 * @param path path of selected file
1955 * @return the result of the new file open box
1956 * @throws IOException if java.io operation throws
1958 public final String
fileOpenBox(final String path
) throws IOException
{
1960 TFileOpenBox box
= new TFileOpenBox(this, path
, TFileOpenBox
.Type
.OPEN
);
1961 return box
.getFilename();
1965 * Convenience function to spawn an file open box.
1967 * @param path path of selected file
1968 * @param type one of the Type constants
1969 * @return the result of the new file open box
1970 * @throws IOException if java.io operation throws
1972 public final String
fileOpenBox(final String path
,
1973 final TFileOpenBox
.Type type
) throws IOException
{
1975 TFileOpenBox box
= new TFileOpenBox(this, path
, type
);
1976 return box
.getFilename();