hide mouse for desktop
[fanfix.git] / src / jexer / TApplication.java
1 /*
2 * Jexer - Java Text User Interface
3 *
4 * The MIT License (MIT)
5 *
6 * Copyright (C) 2019 Kevin Lamonte
7 *
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:
14 *
15 * The above copyright notice and this permission notice shall be included in
16 * all copies or substantial portions of the Software.
17 *
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.
25 *
26 * @author Kevin Lamonte [kevin.lamonte@gmail.com]
27 * @version 1
28 */
29 package jexer;
30
31 import java.io.File;
32 import java.io.InputStream;
33 import java.io.IOException;
34 import java.io.OutputStream;
35 import java.io.PrintWriter;
36 import java.io.Reader;
37 import java.io.UnsupportedEncodingException;
38 import java.text.MessageFormat;
39 import java.util.ArrayList;
40 import java.util.Collections;
41 import java.util.Date;
42 import java.util.HashMap;
43 import java.util.LinkedList;
44 import java.util.List;
45 import java.util.Map;
46 import java.util.ResourceBundle;
47
48 import jexer.bits.Cell;
49 import jexer.bits.CellAttributes;
50 import jexer.bits.ColorTheme;
51 import jexer.bits.StringUtils;
52 import jexer.event.TCommandEvent;
53 import jexer.event.TInputEvent;
54 import jexer.event.TKeypressEvent;
55 import jexer.event.TMenuEvent;
56 import jexer.event.TMouseEvent;
57 import jexer.event.TResizeEvent;
58 import jexer.backend.Backend;
59 import jexer.backend.MultiBackend;
60 import jexer.backend.Screen;
61 import jexer.backend.SwingBackend;
62 import jexer.backend.ECMA48Backend;
63 import jexer.backend.TWindowBackend;
64 import jexer.menu.TMenu;
65 import jexer.menu.TMenuItem;
66 import jexer.menu.TSubMenu;
67 import static jexer.TCommand.*;
68 import static jexer.TKeypress.*;
69
70 /**
71 * TApplication is the main driver class for a full Text User Interface
72 * application. It manages windows, provides a menu bar and status bar, and
73 * processes events received from the user.
74 */
75 public class TApplication implements Runnable {
76
77 /**
78 * Translated strings.
79 */
80 private static final ResourceBundle i18n = ResourceBundle.getBundle(TApplication.class.getName());
81
82 // ------------------------------------------------------------------------
83 // Constants --------------------------------------------------------------
84 // ------------------------------------------------------------------------
85
86 /**
87 * If true, emit thread stuff to System.err.
88 */
89 private static final boolean debugThreads = false;
90
91 /**
92 * If true, emit events being processed to System.err.
93 */
94 private static final boolean debugEvents = false;
95
96 /**
97 * If true, do "smart placement" on new windows that are not specified to
98 * be centered.
99 */
100 private static final boolean smartWindowPlacement = true;
101
102 /**
103 * Two backend types are available.
104 */
105 public static enum BackendType {
106 /**
107 * A Swing JFrame.
108 */
109 SWING,
110
111 /**
112 * An ECMA48 / ANSI X3.64 / XTERM style terminal.
113 */
114 ECMA48,
115
116 /**
117 * Synonym for ECMA48.
118 */
119 XTERM
120 }
121
122 // ------------------------------------------------------------------------
123 // Variables --------------------------------------------------------------
124 // ------------------------------------------------------------------------
125
126 /**
127 * The primary event handler thread.
128 */
129 private volatile WidgetEventHandler primaryEventHandler;
130
131 /**
132 * The secondary event handler thread.
133 */
134 private volatile WidgetEventHandler secondaryEventHandler;
135
136 /**
137 * The screen handler thread.
138 */
139 private volatile ScreenHandler screenHandler;
140
141 /**
142 * The widget receiving events from the secondary event handler thread.
143 */
144 private volatile TWidget secondaryEventReceiver;
145
146 /**
147 * Access to the physical screen, keyboard, and mouse.
148 */
149 private Backend backend;
150
151 /**
152 * Actual mouse coordinate X.
153 */
154 private int mouseX;
155
156 /**
157 * Actual mouse coordinate Y.
158 */
159 private int mouseY;
160
161 /**
162 * Old version of mouse coordinate X.
163 */
164 private int oldMouseX;
165
166 /**
167 * Old version mouse coordinate Y.
168 */
169 private int oldMouseY;
170
171 /**
172 * Old drawn version of mouse coordinate X.
173 */
174 private int oldDrawnMouseX;
175
176 /**
177 * Old drawn version mouse coordinate Y.
178 */
179 private int oldDrawnMouseY;
180
181 /**
182 * Old drawn version mouse cell.
183 */
184 private Cell oldDrawnMouseCell = new Cell();
185
186 /**
187 * The last mouse up click time, used to determine if this is a mouse
188 * double-click.
189 */
190 private long lastMouseUpTime;
191
192 /**
193 * The amount of millis between mouse up events to assume a double-click.
194 */
195 private long doubleClickTime = 250;
196
197 /**
198 * Event queue that is filled by run().
199 */
200 private List<TInputEvent> fillEventQueue;
201
202 /**
203 * Event queue that will be drained by either primary or secondary
204 * Thread.
205 */
206 private List<TInputEvent> drainEventQueue;
207
208 /**
209 * Top-level menus in this application.
210 */
211 private List<TMenu> menus;
212
213 /**
214 * Stack of activated sub-menus in this application.
215 */
216 private List<TMenu> subMenus;
217
218 /**
219 * The currently active menu.
220 */
221 private TMenu activeMenu = null;
222
223 /**
224 * Active keyboard accelerators.
225 */
226 private Map<TKeypress, TMenuItem> accelerators;
227
228 /**
229 * All menu items.
230 */
231 private List<TMenuItem> menuItems;
232
233 /**
234 * Windows and widgets pull colors from this ColorTheme.
235 */
236 private ColorTheme theme;
237
238 /**
239 * The top-level windows (but not menus).
240 */
241 private List<TWindow> windows;
242
243 /**
244 * The currently acive window.
245 */
246 private TWindow activeWindow = null;
247
248 /**
249 * Timers that are being ticked.
250 */
251 private List<TTimer> timers;
252
253 /**
254 * When true, the application has been started.
255 */
256 private volatile boolean started = false;
257
258 /**
259 * When true, exit the application.
260 */
261 private volatile boolean quit = false;
262
263 /**
264 * When true, repaint the entire screen.
265 */
266 private volatile boolean repaint = true;
267
268 /**
269 * Y coordinate of the top edge of the desktop. For now this is a
270 * constant. Someday it would be nice to have a multi-line menu or
271 * toolbars.
272 */
273 private int desktopTop = 1;
274
275 /**
276 * Y coordinate of the bottom edge of the desktop.
277 */
278 private int desktopBottom;
279
280 /**
281 * An optional TDesktop background window that is drawn underneath
282 * everything else.
283 */
284 private TDesktop desktop;
285
286 /**
287 * If true, focus follows mouse: windows automatically raised if the
288 * mouse passes over them.
289 */
290 private boolean focusFollowsMouse = false;
291
292 /**
293 * If true, display a text-based mouse cursor.
294 */
295 private boolean textMouse = true;
296
297 /**
298 * If true, hide the mouse after typing a keystroke.
299 */
300 private boolean hideMouseWhenTyping = false;
301
302 /**
303 * If true, the mouse should not be displayed because a keystroke was
304 * typed.
305 */
306 private boolean typingHidMouse = false;
307
308 /**
309 * If true, hide the status bar.
310 */
311 private boolean hideStatusBar = false;
312
313 /**
314 * If true, hide the menu bar.
315 */
316 private boolean hideMenuBar = false;
317
318 /**
319 * The list of commands to run before the next I/O check.
320 */
321 private List<Runnable> invokeLaters = new LinkedList<Runnable>();
322
323 /**
324 * The last time the screen was resized.
325 */
326 private long screenResizeTime = 0;
327
328 /**
329 * WidgetEventHandler is the main event consumer loop. There are at most
330 * two such threads in existence: the primary for normal case and a
331 * secondary that is used for TMessageBox, TInputBox, and similar.
332 */
333 private class WidgetEventHandler implements Runnable {
334 /**
335 * The main application.
336 */
337 private TApplication application;
338
339 /**
340 * Whether or not this WidgetEventHandler is the primary or secondary
341 * thread.
342 */
343 private boolean primary = true;
344
345 /**
346 * Public constructor.
347 *
348 * @param application the main application
349 * @param primary if true, this is the primary event handler thread
350 */
351 public WidgetEventHandler(final TApplication application,
352 final boolean primary) {
353
354 this.application = application;
355 this.primary = primary;
356 }
357
358 /**
359 * The consumer loop.
360 */
361 public void run() {
362 // Wrap everything in a try, so that if we go belly up we can let
363 // the user have their terminal back.
364 try {
365 runImpl();
366 } catch (Throwable t) {
367 this.application.restoreConsole();
368 t.printStackTrace();
369 this.application.exit();
370 }
371 }
372
373 /**
374 * The consumer loop.
375 */
376 private void runImpl() {
377 boolean first = true;
378
379 // Loop forever
380 while (!application.quit) {
381
382 // Wait until application notifies me
383 while (!application.quit) {
384 try {
385 synchronized (application.drainEventQueue) {
386 if (application.drainEventQueue.size() > 0) {
387 break;
388 }
389 }
390
391 long timeout = 0;
392 if (first) {
393 first = false;
394 } else {
395 timeout = application.getSleepTime(1000);
396 }
397
398 if (timeout == 0) {
399 // A timer needs to fire, break out.
400 break;
401 }
402
403 if (debugThreads) {
404 System.err.printf("%d %s %s %s sleep %d millis\n",
405 System.currentTimeMillis(), this,
406 primary ? "primary" : "secondary",
407 Thread.currentThread(), timeout);
408 }
409
410 synchronized (this) {
411 this.wait(timeout);
412 }
413
414 if (debugThreads) {
415 System.err.printf("%d %s %s %s AWAKE\n",
416 System.currentTimeMillis(), this,
417 primary ? "primary" : "secondary",
418 Thread.currentThread());
419 }
420
421 if ((!primary)
422 && (application.secondaryEventReceiver == null)
423 ) {
424 // Secondary thread, emergency exit. If we got
425 // here then something went wrong with the
426 // handoff between yield() and closeWindow().
427 synchronized (application.primaryEventHandler) {
428 application.primaryEventHandler.notify();
429 }
430 application.secondaryEventHandler = null;
431 throw new RuntimeException("secondary exited " +
432 "at wrong time");
433 }
434 break;
435 } catch (InterruptedException e) {
436 // SQUASH
437 }
438 } // while (!application.quit)
439
440 // Pull all events off the queue
441 for (;;) {
442 TInputEvent event = null;
443 synchronized (application.drainEventQueue) {
444 if (application.drainEventQueue.size() == 0) {
445 break;
446 }
447 event = application.drainEventQueue.remove(0);
448 }
449
450 // We will have an event to process, so repaint the
451 // screen at the end.
452 application.repaint = true;
453
454 if (primary) {
455 primaryHandleEvent(event);
456 } else {
457 secondaryHandleEvent(event);
458 }
459 if ((!primary)
460 && (application.secondaryEventReceiver == null)
461 ) {
462 // Secondary thread, time to exit.
463
464 // Eliminate my reference so that wakeEventHandler()
465 // resumes working on the primary.
466 application.secondaryEventHandler = null;
467
468 // We are ready to exit, wake up the primary thread.
469 // Remember that it is currently sleeping inside its
470 // primaryHandleEvent().
471 synchronized (application.primaryEventHandler) {
472 application.primaryEventHandler.notify();
473 }
474
475 // All done!
476 return;
477 }
478
479 } // for (;;)
480
481 // Fire timers, update screen.
482 if (!quit) {
483 application.finishEventProcessing();
484 }
485
486 } // while (true) (main runnable loop)
487 }
488 }
489
490 /**
491 * ScreenHandler pushes screen updates to the physical device.
492 */
493 private class ScreenHandler implements Runnable {
494 /**
495 * The main application.
496 */
497 private TApplication application;
498
499 /**
500 * The dirty flag.
501 */
502 private boolean dirty = false;
503
504 /**
505 * Public constructor.
506 *
507 * @param application the main application
508 */
509 public ScreenHandler(final TApplication application) {
510 this.application = application;
511 }
512
513 /**
514 * The screen update loop.
515 */
516 public void run() {
517 // Wrap everything in a try, so that if we go belly up we can let
518 // the user have their terminal back.
519 try {
520 runImpl();
521 } catch (Throwable t) {
522 this.application.restoreConsole();
523 t.printStackTrace();
524 this.application.exit();
525 }
526 }
527
528 /**
529 * The update loop.
530 */
531 private void runImpl() {
532
533 // Loop forever
534 while (!application.quit) {
535
536 // Wait until application notifies me
537 while (!application.quit) {
538 try {
539 synchronized (this) {
540 if (dirty) {
541 dirty = false;
542 break;
543 }
544
545 // Always check within 50 milliseconds.
546 this.wait(50);
547 }
548 } catch (InterruptedException e) {
549 // SQUASH
550 }
551 } // while (!application.quit)
552
553 // Flush the screen contents
554 if (debugThreads) {
555 System.err.printf("%d %s backend.flushScreen()\n",
556 System.currentTimeMillis(), Thread.currentThread());
557 }
558 synchronized (getScreen()) {
559 backend.flushScreen();
560 }
561 } // while (true) (main runnable loop)
562
563 // Shutdown the user I/O thread(s)
564 backend.shutdown();
565 }
566
567 /**
568 * Set the dirty flag.
569 */
570 public void setDirty() {
571 synchronized (this) {
572 dirty = true;
573 }
574 }
575
576 }
577
578 // ------------------------------------------------------------------------
579 // Constructors -----------------------------------------------------------
580 // ------------------------------------------------------------------------
581
582 /**
583 * Public constructor.
584 *
585 * @param backendType BackendType.XTERM, BackendType.ECMA48 or
586 * BackendType.SWING
587 * @param windowWidth the number of text columns to start with
588 * @param windowHeight the number of text rows to start with
589 * @param fontSize the size in points
590 * @throws UnsupportedEncodingException if an exception is thrown when
591 * creating the InputStreamReader
592 */
593 public TApplication(final BackendType backendType, final int windowWidth,
594 final int windowHeight, final int fontSize)
595 throws UnsupportedEncodingException {
596
597 switch (backendType) {
598 case SWING:
599 backend = new SwingBackend(this, windowWidth, windowHeight,
600 fontSize);
601 break;
602 case XTERM:
603 // Fall through...
604 case ECMA48:
605 backend = new ECMA48Backend(this, null, null, windowWidth,
606 windowHeight, fontSize);
607 break;
608 default:
609 throw new IllegalArgumentException("Invalid backend type: "
610 + backendType);
611 }
612 TApplicationImpl();
613 }
614
615 /**
616 * Public constructor.
617 *
618 * @param backendType BackendType.XTERM, BackendType.ECMA48 or
619 * BackendType.SWING
620 * @throws UnsupportedEncodingException if an exception is thrown when
621 * creating the InputStreamReader
622 */
623 public TApplication(final BackendType backendType)
624 throws UnsupportedEncodingException {
625
626 switch (backendType) {
627 case SWING:
628 // The default SwingBackend is 80x25, 20 pt font. If you want to
629 // change that, you can pass the extra arguments to the
630 // SwingBackend constructor here. For example, if you wanted
631 // 90x30, 16 pt font:
632 //
633 // backend = new SwingBackend(this, 90, 30, 16);
634 backend = new SwingBackend(this);
635 break;
636 case XTERM:
637 // Fall through...
638 case ECMA48:
639 backend = new ECMA48Backend(this, null, null);
640 break;
641 default:
642 throw new IllegalArgumentException("Invalid backend type: "
643 + backendType);
644 }
645 TApplicationImpl();
646 }
647
648 /**
649 * Public constructor. The backend type will be BackendType.ECMA48.
650 *
651 * @param input an InputStream connected to the remote user, or null for
652 * System.in. If System.in is used, then on non-Windows systems it will
653 * be put in raw mode; shutdown() will (blindly!) put System.in in cooked
654 * mode. input is always converted to a Reader with UTF-8 encoding.
655 * @param output an OutputStream connected to the remote user, or null
656 * for System.out. output is always converted to a Writer with UTF-8
657 * encoding.
658 * @throws UnsupportedEncodingException if an exception is thrown when
659 * creating the InputStreamReader
660 */
661 public TApplication(final InputStream input,
662 final OutputStream output) throws UnsupportedEncodingException {
663
664 backend = new ECMA48Backend(this, input, output);
665 TApplicationImpl();
666 }
667
668 /**
669 * Public constructor. The backend type will be BackendType.ECMA48.
670 *
671 * @param input the InputStream underlying 'reader'. Its available()
672 * method is used to determine if reader.read() will block or not.
673 * @param reader a Reader connected to the remote user.
674 * @param writer a PrintWriter connected to the remote user.
675 * @param setRawMode if true, set System.in into raw mode with stty.
676 * This should in general not be used. It is here solely for Demo3,
677 * which uses System.in.
678 * @throws IllegalArgumentException if input, reader, or writer are null.
679 */
680 public TApplication(final InputStream input, final Reader reader,
681 final PrintWriter writer, final boolean setRawMode) {
682
683 backend = new ECMA48Backend(this, input, reader, writer, setRawMode);
684 TApplicationImpl();
685 }
686
687 /**
688 * Public constructor. The backend type will be BackendType.ECMA48.
689 *
690 * @param input the InputStream underlying 'reader'. Its available()
691 * method is used to determine if reader.read() will block or not.
692 * @param reader a Reader connected to the remote user.
693 * @param writer a PrintWriter connected to the remote user.
694 * @throws IllegalArgumentException if input, reader, or writer are null.
695 */
696 public TApplication(final InputStream input, final Reader reader,
697 final PrintWriter writer) {
698
699 this(input, reader, writer, false);
700 }
701
702 /**
703 * Public constructor. This hook enables use with new non-Jexer
704 * backends.
705 *
706 * @param backend a Backend that is already ready to go.
707 */
708 public TApplication(final Backend backend) {
709 this.backend = backend;
710 backend.setListener(this);
711 TApplicationImpl();
712 }
713
714 /**
715 * Finish construction once the backend is set.
716 */
717 private void TApplicationImpl() {
718 // Text block mouse option
719 if (System.getProperty("jexer.textMouse", "true").equals("false")) {
720 textMouse = false;
721 }
722
723 // Hide mouse when typing option
724 if (System.getProperty("jexer.hideMouseWhenTyping",
725 "false").equals("true")) {
726
727 hideMouseWhenTyping = true;
728 }
729
730 // Hide status bar option
731 if (System.getProperty("jexer.hideStatusBar",
732 "false").equals("true")) {
733 hideStatusBar = true;
734 }
735
736 // Hide menu bar option
737 if (System.getProperty("jexer.hideMenuBar", "false").equals("true")) {
738 hideMenuBar = true;
739 }
740
741 theme = new ColorTheme();
742 desktopTop = (hideMenuBar ? 0 : 1);
743 desktopBottom = getScreen().getHeight() - 1 + (hideStatusBar ? 1 : 0);
744 fillEventQueue = new LinkedList<TInputEvent>();
745 drainEventQueue = new LinkedList<TInputEvent>();
746 windows = new LinkedList<TWindow>();
747 menus = new ArrayList<TMenu>();
748 subMenus = new ArrayList<TMenu>();
749 timers = new LinkedList<TTimer>();
750 accelerators = new HashMap<TKeypress, TMenuItem>();
751 menuItems = new LinkedList<TMenuItem>();
752 desktop = new TDesktop(this);
753
754 // Special case: the Swing backend needs to have a timer to drive its
755 // blink state.
756 if ((backend instanceof SwingBackend)
757 || (backend instanceof MultiBackend)
758 ) {
759 // Default to 500 millis, unless a SwingBackend has its own
760 // value.
761 long millis = 500;
762 if (backend instanceof SwingBackend) {
763 millis = ((SwingBackend) backend).getBlinkMillis();
764 }
765 if (millis > 0) {
766 addTimer(millis, true,
767 new TAction() {
768 public void DO() {
769 TApplication.this.doRepaint();
770 }
771 }
772 );
773 }
774 }
775
776 }
777
778 // ------------------------------------------------------------------------
779 // Runnable ---------------------------------------------------------------
780 // ------------------------------------------------------------------------
781
782 /**
783 * Run this application until it exits.
784 */
785 public void run() {
786 // System.err.println("*** TApplication.run() begins ***");
787
788 // Start the screen updater thread
789 screenHandler = new ScreenHandler(this);
790 (new Thread(screenHandler)).start();
791
792 // Start the main consumer thread
793 primaryEventHandler = new WidgetEventHandler(this, true);
794 (new Thread(primaryEventHandler)).start();
795
796 started = true;
797
798 while (!quit) {
799 synchronized (this) {
800 boolean doWait = false;
801
802 if (!backend.hasEvents()) {
803 synchronized (fillEventQueue) {
804 if (fillEventQueue.size() == 0) {
805 doWait = true;
806 }
807 }
808 }
809
810 if (doWait) {
811 // No I/O to dispatch, so wait until the backend
812 // provides new I/O.
813 try {
814 if (debugThreads) {
815 System.err.println(System.currentTimeMillis() +
816 " " + Thread.currentThread() + " MAIN sleep");
817 }
818
819 this.wait();
820
821 if (debugThreads) {
822 System.err.println(System.currentTimeMillis() +
823 " " + Thread.currentThread() + " MAIN AWAKE");
824 }
825 } catch (InterruptedException e) {
826 // I'm awake and don't care why, let's see what's
827 // going on out there.
828 }
829 }
830
831 } // synchronized (this)
832
833 synchronized (fillEventQueue) {
834 // Pull any pending I/O events
835 backend.getEvents(fillEventQueue);
836
837 // Dispatch each event to the appropriate handler, one at a
838 // time.
839 for (;;) {
840 TInputEvent event = null;
841 if (fillEventQueue.size() == 0) {
842 break;
843 }
844 event = fillEventQueue.remove(0);
845 metaHandleEvent(event);
846 }
847 }
848
849 // Wake a consumer thread if we have any pending events.
850 if (drainEventQueue.size() > 0) {
851 wakeEventHandler();
852 }
853
854 } // while (!quit)
855
856 // Shutdown the event consumer threads
857 if (secondaryEventHandler != null) {
858 synchronized (secondaryEventHandler) {
859 secondaryEventHandler.notify();
860 }
861 }
862 if (primaryEventHandler != null) {
863 synchronized (primaryEventHandler) {
864 primaryEventHandler.notify();
865 }
866 }
867
868 // Close all the windows. This gives them an opportunity to release
869 // resources.
870 closeAllWindows();
871
872 // Close the desktop.
873 if (desktop != null) {
874 setDesktop(null);
875 }
876
877 // Give the overarching application an opportunity to release
878 // resources.
879 onExit();
880
881 // System.err.println("*** TApplication.run() exits ***");
882 }
883
884 // ------------------------------------------------------------------------
885 // Event handlers ---------------------------------------------------------
886 // ------------------------------------------------------------------------
887
888 /**
889 * Method that TApplication subclasses can override to handle menu or
890 * posted command events.
891 *
892 * @param command command event
893 * @return if true, this event was consumed
894 */
895 protected boolean onCommand(final TCommandEvent command) {
896 // Default: handle cmExit
897 if (command.equals(cmExit)) {
898 if (messageBox(i18n.getString("exitDialogTitle"),
899 i18n.getString("exitDialogText"),
900 TMessageBox.Type.YESNO).isYes()) {
901
902 exit();
903 }
904 return true;
905 }
906
907 if (command.equals(cmShell)) {
908 openTerminal(0, 0, TWindow.RESIZABLE);
909 return true;
910 }
911
912 if (command.equals(cmTile)) {
913 tileWindows();
914 return true;
915 }
916 if (command.equals(cmCascade)) {
917 cascadeWindows();
918 return true;
919 }
920 if (command.equals(cmCloseAll)) {
921 closeAllWindows();
922 return true;
923 }
924
925 if (command.equals(cmMenu) && (hideMenuBar == false)) {
926 if (!modalWindowActive() && (activeMenu == null)) {
927 if (menus.size() > 0) {
928 menus.get(0).setActive(true);
929 activeMenu = menus.get(0);
930 return true;
931 }
932 }
933 }
934
935 return false;
936 }
937
938 /**
939 * Method that TApplication subclasses can override to handle menu
940 * events.
941 *
942 * @param menu menu event
943 * @return if true, this event was consumed
944 */
945 protected boolean onMenu(final TMenuEvent menu) {
946
947 // Default: handle MID_EXIT
948 if (menu.getId() == TMenu.MID_EXIT) {
949 if (messageBox(i18n.getString("exitDialogTitle"),
950 i18n.getString("exitDialogText"),
951 TMessageBox.Type.YESNO).isYes()) {
952
953 exit();
954 }
955 return true;
956 }
957
958 if (menu.getId() == TMenu.MID_SHELL) {
959 openTerminal(0, 0, TWindow.RESIZABLE);
960 return true;
961 }
962
963 if (menu.getId() == TMenu.MID_TILE) {
964 tileWindows();
965 return true;
966 }
967 if (menu.getId() == TMenu.MID_CASCADE) {
968 cascadeWindows();
969 return true;
970 }
971 if (menu.getId() == TMenu.MID_CLOSE_ALL) {
972 closeAllWindows();
973 return true;
974 }
975 if (menu.getId() == TMenu.MID_ABOUT) {
976 showAboutDialog();
977 return true;
978 }
979 if (menu.getId() == TMenu.MID_REPAINT) {
980 getScreen().clearPhysical();
981 doRepaint();
982 return true;
983 }
984 if (menu.getId() == TMenu.MID_VIEW_IMAGE) {
985 openImage();
986 return true;
987 }
988 if (menu.getId() == TMenu.MID_SCREEN_OPTIONS) {
989 new TFontChooserWindow(this);
990 return true;
991 }
992 return false;
993 }
994
995 /**
996 * Method that TApplication subclasses can override to handle keystrokes.
997 *
998 * @param keypress keystroke event
999 * @return if true, this event was consumed
1000 */
1001 protected boolean onKeypress(final TKeypressEvent keypress) {
1002 // Default: only menu shortcuts
1003
1004 // Process Alt-F, Alt-E, etc. menu shortcut keys
1005 if (!keypress.getKey().isFnKey()
1006 && keypress.getKey().isAlt()
1007 && !keypress.getKey().isCtrl()
1008 && (activeMenu == null)
1009 && !modalWindowActive()
1010 && (hideMenuBar == false)
1011 ) {
1012
1013 assert (subMenus.size() == 0);
1014
1015 for (TMenu menu: menus) {
1016 if (Character.toLowerCase(menu.getMnemonic().getShortcut())
1017 == Character.toLowerCase(keypress.getKey().getChar())
1018 ) {
1019 activeMenu = menu;
1020 menu.setActive(true);
1021 return true;
1022 }
1023 }
1024 }
1025
1026 return false;
1027 }
1028
1029 /**
1030 * Process background events, and update the screen.
1031 */
1032 private void finishEventProcessing() {
1033 if (debugThreads) {
1034 System.err.printf(System.currentTimeMillis() + " " +
1035 Thread.currentThread() + " finishEventProcessing()\n");
1036 }
1037
1038 // Process timers and call doIdle()'s
1039 doIdle();
1040
1041 // Update the screen
1042 synchronized (getScreen()) {
1043 drawAll();
1044 }
1045
1046 // Wake up the screen repainter
1047 wakeScreenHandler();
1048
1049 if (debugThreads) {
1050 System.err.printf(System.currentTimeMillis() + " " +
1051 Thread.currentThread() + " finishEventProcessing() END\n");
1052 }
1053 }
1054
1055 /**
1056 * Peek at certain application-level events, add to eventQueue, and wake
1057 * up the consuming Thread.
1058 *
1059 * @param event the input event to consume
1060 */
1061 private void metaHandleEvent(final TInputEvent event) {
1062
1063 if (debugEvents) {
1064 System.err.printf(String.format("metaHandleEvents event: %s\n",
1065 event)); System.err.flush();
1066 }
1067
1068 if (quit) {
1069 // Do no more processing if the application is already trying
1070 // to exit.
1071 return;
1072 }
1073
1074 // Special application-wide events -------------------------------
1075
1076 // Abort everything
1077 if (event instanceof TCommandEvent) {
1078 TCommandEvent command = (TCommandEvent) event;
1079 if (command.equals(cmAbort)) {
1080 exit();
1081 return;
1082 }
1083 }
1084
1085 synchronized (drainEventQueue) {
1086 // Screen resize
1087 if (event instanceof TResizeEvent) {
1088 TResizeEvent resize = (TResizeEvent) event;
1089 synchronized (getScreen()) {
1090 if ((System.currentTimeMillis() - screenResizeTime >= 15)
1091 || (resize.getWidth() < getScreen().getWidth())
1092 || (resize.getHeight() < getScreen().getHeight())
1093 ) {
1094 getScreen().setDimensions(resize.getWidth(),
1095 resize.getHeight());
1096 screenResizeTime = System.currentTimeMillis();
1097 }
1098 desktopBottom = getScreen().getHeight() - 1;
1099 if (hideStatusBar) {
1100 desktopBottom++;
1101 }
1102 mouseX = 0;
1103 mouseY = 0;
1104 oldMouseX = 0;
1105 oldMouseY = 0;
1106 }
1107 if (desktop != null) {
1108 desktop.setDimensions(0, desktopTop, resize.getWidth(),
1109 (desktopBottom - desktopTop));
1110 desktop.onResize(resize);
1111 }
1112
1113 // Change menu edges if needed.
1114 recomputeMenuX();
1115
1116 // We are dirty, redraw the screen.
1117 doRepaint();
1118
1119 /*
1120 System.err.println("New screen: " + resize.getWidth() +
1121 " x " + resize.getHeight());
1122 */
1123 return;
1124 }
1125
1126 // Put into the main queue
1127 drainEventQueue.add(event);
1128 }
1129 }
1130
1131 /**
1132 * Dispatch one event to the appropriate widget or application-level
1133 * event handler. This is the primary event handler, it has the normal
1134 * application-wide event handling.
1135 *
1136 * @param event the input event to consume
1137 * @see #secondaryHandleEvent(TInputEvent event)
1138 */
1139 private void primaryHandleEvent(final TInputEvent event) {
1140
1141 if (debugEvents) {
1142 System.err.printf("%s primaryHandleEvent: %s\n",
1143 Thread.currentThread(), event);
1144 }
1145 TMouseEvent doubleClick = null;
1146
1147 // Special application-wide events -----------------------------------
1148
1149 if (event instanceof TKeypressEvent) {
1150 if (hideMouseWhenTyping) {
1151 typingHidMouse = true;
1152 }
1153 }
1154
1155 // Peek at the mouse position
1156 if (event instanceof TMouseEvent) {
1157 typingHidMouse = false;
1158
1159 TMouseEvent mouse = (TMouseEvent) event;
1160 if ((mouseX != mouse.getX()) || (mouseY != mouse.getY())) {
1161 oldMouseX = mouseX;
1162 oldMouseY = mouseY;
1163 mouseX = mouse.getX();
1164 mouseY = mouse.getY();
1165 } else {
1166 if ((mouse.getType() == TMouseEvent.Type.MOUSE_DOWN)
1167 && (!mouse.isMouseWheelUp())
1168 && (!mouse.isMouseWheelDown())
1169 ) {
1170 if ((mouse.getTime().getTime() - lastMouseUpTime) <
1171 doubleClickTime) {
1172
1173 // This is a double-click.
1174 doubleClick = new TMouseEvent(TMouseEvent.Type.
1175 MOUSE_DOUBLE_CLICK,
1176 mouse.getX(), mouse.getY(),
1177 mouse.getAbsoluteX(), mouse.getAbsoluteY(),
1178 mouse.isMouse1(), mouse.isMouse2(),
1179 mouse.isMouse3(),
1180 mouse.isMouseWheelUp(), mouse.isMouseWheelDown());
1181
1182 } else {
1183 // The first click of a potential double-click.
1184 lastMouseUpTime = mouse.getTime().getTime();
1185 }
1186 }
1187 }
1188
1189 // See if we need to switch focus to another window or the menu
1190 checkSwitchFocus((TMouseEvent) event);
1191 }
1192
1193 // Handle menu events
1194 if ((activeMenu != null) && !(event instanceof TCommandEvent)) {
1195 TMenu menu = activeMenu;
1196
1197 if (event instanceof TMouseEvent) {
1198 TMouseEvent mouse = (TMouseEvent) event;
1199
1200 while (subMenus.size() > 0) {
1201 TMenu subMenu = subMenus.get(subMenus.size() - 1);
1202 if (subMenu.mouseWouldHit(mouse)) {
1203 break;
1204 }
1205 if ((mouse.getType() == TMouseEvent.Type.MOUSE_MOTION)
1206 && (!mouse.isMouse1())
1207 && (!mouse.isMouse2())
1208 && (!mouse.isMouse3())
1209 && (!mouse.isMouseWheelUp())
1210 && (!mouse.isMouseWheelDown())
1211 ) {
1212 break;
1213 }
1214 // We navigated away from a sub-menu, so close it
1215 closeSubMenu();
1216 }
1217
1218 // Convert the mouse relative x/y to menu coordinates
1219 assert (mouse.getX() == mouse.getAbsoluteX());
1220 assert (mouse.getY() == mouse.getAbsoluteY());
1221 if (subMenus.size() > 0) {
1222 menu = subMenus.get(subMenus.size() - 1);
1223 }
1224 mouse.setX(mouse.getX() - menu.getX());
1225 mouse.setY(mouse.getY() - menu.getY());
1226 }
1227 menu.handleEvent(event);
1228 return;
1229 }
1230
1231 if (event instanceof TKeypressEvent) {
1232 TKeypressEvent keypress = (TKeypressEvent) event;
1233
1234 // See if this key matches an accelerator, and is not being
1235 // shortcutted by the active window, and if so dispatch the menu
1236 // event.
1237 boolean windowWillShortcut = false;
1238 if (activeWindow != null) {
1239 assert (activeWindow.isShown());
1240 if (activeWindow.isShortcutKeypress(keypress.getKey())) {
1241 // We do not process this key, it will be passed to the
1242 // window instead.
1243 windowWillShortcut = true;
1244 }
1245 }
1246
1247 if (!windowWillShortcut && !modalWindowActive()) {
1248 TKeypress keypressLowercase = keypress.getKey().toLowerCase();
1249 TMenuItem item = null;
1250 synchronized (accelerators) {
1251 item = accelerators.get(keypressLowercase);
1252 }
1253 if (item != null) {
1254 if (item.isEnabled()) {
1255 // Let the menu item dispatch
1256 item.dispatch();
1257 return;
1258 }
1259 }
1260
1261 // Handle the keypress
1262 if (onKeypress(keypress)) {
1263 return;
1264 }
1265 }
1266 }
1267
1268 if (event instanceof TCommandEvent) {
1269 if (onCommand((TCommandEvent) event)) {
1270 return;
1271 }
1272 }
1273
1274 if (event instanceof TMenuEvent) {
1275 if (onMenu((TMenuEvent) event)) {
1276 return;
1277 }
1278 }
1279
1280 // Dispatch events to the active window -------------------------------
1281 boolean dispatchToDesktop = true;
1282 TWindow window = activeWindow;
1283 if (window != null) {
1284 assert (window.isActive());
1285 assert (window.isShown());
1286 if (event instanceof TMouseEvent) {
1287 TMouseEvent mouse = (TMouseEvent) event;
1288 // Convert the mouse relative x/y to window coordinates
1289 assert (mouse.getX() == mouse.getAbsoluteX());
1290 assert (mouse.getY() == mouse.getAbsoluteY());
1291 mouse.setX(mouse.getX() - window.getX());
1292 mouse.setY(mouse.getY() - window.getY());
1293
1294 if (doubleClick != null) {
1295 doubleClick.setX(doubleClick.getX() - window.getX());
1296 doubleClick.setY(doubleClick.getY() - window.getY());
1297 }
1298
1299 if (window.mouseWouldHit(mouse)) {
1300 dispatchToDesktop = false;
1301 }
1302 } else if (event instanceof TKeypressEvent) {
1303 dispatchToDesktop = false;
1304 } else if (event instanceof TMenuEvent) {
1305 dispatchToDesktop = false;
1306 }
1307
1308 if (debugEvents) {
1309 System.err.printf("TApplication dispatch event: %s\n",
1310 event);
1311 }
1312 window.handleEvent(event);
1313 if (doubleClick != null) {
1314 window.handleEvent(doubleClick);
1315 }
1316 }
1317 if (dispatchToDesktop) {
1318 // This event is fair game for the desktop to process.
1319 if (desktop != null) {
1320 desktop.handleEvent(event);
1321 if (doubleClick != null) {
1322 desktop.handleEvent(doubleClick);
1323 }
1324 }
1325 }
1326 }
1327
1328 /**
1329 * Dispatch one event to the appropriate widget or application-level
1330 * event handler. This is the secondary event handler used by certain
1331 * special dialogs (currently TMessageBox and TFileOpenBox).
1332 *
1333 * @param event the input event to consume
1334 * @see #primaryHandleEvent(TInputEvent event)
1335 */
1336 private void secondaryHandleEvent(final TInputEvent event) {
1337 TMouseEvent doubleClick = null;
1338
1339 if (debugEvents) {
1340 System.err.printf("%s secondaryHandleEvent: %s\n",
1341 Thread.currentThread(), event);
1342 }
1343
1344 // Peek at the mouse position
1345 if (event instanceof TMouseEvent) {
1346 typingHidMouse = false;
1347
1348 TMouseEvent mouse = (TMouseEvent) event;
1349 if ((mouseX != mouse.getX()) || (mouseY != mouse.getY())) {
1350 oldMouseX = mouseX;
1351 oldMouseY = mouseY;
1352 mouseX = mouse.getX();
1353 mouseY = mouse.getY();
1354 } else {
1355 if ((mouse.getType() == TMouseEvent.Type.MOUSE_DOWN)
1356 && (!mouse.isMouseWheelUp())
1357 && (!mouse.isMouseWheelDown())
1358 ) {
1359 if ((mouse.getTime().getTime() - lastMouseUpTime) <
1360 doubleClickTime) {
1361
1362 // This is a double-click.
1363 doubleClick = new TMouseEvent(TMouseEvent.Type.
1364 MOUSE_DOUBLE_CLICK,
1365 mouse.getX(), mouse.getY(),
1366 mouse.getAbsoluteX(), mouse.getAbsoluteY(),
1367 mouse.isMouse1(), mouse.isMouse2(),
1368 mouse.isMouse3(),
1369 mouse.isMouseWheelUp(), mouse.isMouseWheelDown());
1370
1371 } else {
1372 // The first click of a potential double-click.
1373 lastMouseUpTime = mouse.getTime().getTime();
1374 }
1375 }
1376 }
1377 }
1378
1379 secondaryEventReceiver.handleEvent(event);
1380 // Note that it is possible for secondaryEventReceiver to be null
1381 // now, because its handleEvent() might have finished out on the
1382 // secondary thread. So put any extra processing inside a null
1383 // check.
1384 if (secondaryEventReceiver != null) {
1385 if (doubleClick != null) {
1386 secondaryEventReceiver.handleEvent(doubleClick);
1387 }
1388 }
1389 }
1390
1391 /**
1392 * Enable a widget to override the primary event thread.
1393 *
1394 * @param widget widget that will receive events
1395 */
1396 public final void enableSecondaryEventReceiver(final TWidget widget) {
1397 if (debugThreads) {
1398 System.err.println(System.currentTimeMillis() +
1399 " enableSecondaryEventReceiver()");
1400 }
1401
1402 assert (secondaryEventReceiver == null);
1403 assert (secondaryEventHandler == null);
1404 assert ((widget instanceof TMessageBox)
1405 || (widget instanceof TFileOpenBox));
1406 secondaryEventReceiver = widget;
1407 secondaryEventHandler = new WidgetEventHandler(this, false);
1408
1409 (new Thread(secondaryEventHandler)).start();
1410 }
1411
1412 /**
1413 * Yield to the secondary thread.
1414 */
1415 public final void yield() {
1416 if (debugThreads) {
1417 System.err.printf(System.currentTimeMillis() + " " +
1418 Thread.currentThread() + " yield()\n");
1419 }
1420
1421 assert (secondaryEventReceiver != null);
1422
1423 while (secondaryEventReceiver != null) {
1424 synchronized (primaryEventHandler) {
1425 try {
1426 primaryEventHandler.wait();
1427 } catch (InterruptedException e) {
1428 // SQUASH
1429 }
1430 }
1431 }
1432 }
1433
1434 /**
1435 * Do stuff when there is no user input.
1436 */
1437 private void doIdle() {
1438 if (debugThreads) {
1439 System.err.printf(System.currentTimeMillis() + " " +
1440 Thread.currentThread() + " doIdle()\n");
1441 }
1442
1443 synchronized (timers) {
1444
1445 if (debugThreads) {
1446 System.err.printf(System.currentTimeMillis() + " " +
1447 Thread.currentThread() + " doIdle() 2\n");
1448 }
1449
1450 // Run any timers that have timed out
1451 Date now = new Date();
1452 List<TTimer> keepTimers = new LinkedList<TTimer>();
1453 for (TTimer timer: timers) {
1454 if (timer.getNextTick().getTime() <= now.getTime()) {
1455 // Something might change, so repaint the screen.
1456 repaint = true;
1457 timer.tick();
1458 if (timer.recurring) {
1459 keepTimers.add(timer);
1460 }
1461 } else {
1462 keepTimers.add(timer);
1463 }
1464 }
1465 timers.clear();
1466 timers.addAll(keepTimers);
1467 }
1468
1469 // Call onIdle's
1470 for (TWindow window: windows) {
1471 window.onIdle();
1472 }
1473 if (desktop != null) {
1474 desktop.onIdle();
1475 }
1476
1477 // Run any invokeLaters
1478 synchronized (invokeLaters) {
1479 for (Runnable invoke: invokeLaters) {
1480 invoke.run();
1481 }
1482 invokeLaters.clear();
1483 }
1484
1485 }
1486
1487 /**
1488 * Wake the sleeping active event handler.
1489 */
1490 private void wakeEventHandler() {
1491 if (!started) {
1492 return;
1493 }
1494
1495 if (secondaryEventHandler != null) {
1496 synchronized (secondaryEventHandler) {
1497 secondaryEventHandler.notify();
1498 }
1499 } else {
1500 assert (primaryEventHandler != null);
1501 synchronized (primaryEventHandler) {
1502 primaryEventHandler.notify();
1503 }
1504 }
1505 }
1506
1507 /**
1508 * Wake the sleeping screen handler.
1509 */
1510 private void wakeScreenHandler() {
1511 if (!started) {
1512 return;
1513 }
1514
1515 synchronized (screenHandler) {
1516 screenHandler.notify();
1517 }
1518 }
1519
1520 // ------------------------------------------------------------------------
1521 // TApplication -----------------------------------------------------------
1522 // ------------------------------------------------------------------------
1523
1524 /**
1525 * Place a command on the run queue, and run it before the next round of
1526 * checking I/O.
1527 *
1528 * @param command the command to run later
1529 */
1530 public void invokeLater(final Runnable command) {
1531 synchronized (invokeLaters) {
1532 invokeLaters.add(command);
1533 }
1534 doRepaint();
1535 }
1536
1537 /**
1538 * Restore the console to sane defaults. This is meant to be used for
1539 * improper exits (e.g. a caught exception in main()), and should not be
1540 * necessary for normal program termination.
1541 */
1542 public void restoreConsole() {
1543 if (backend != null) {
1544 if (backend instanceof ECMA48Backend) {
1545 backend.shutdown();
1546 }
1547 }
1548 }
1549
1550 /**
1551 * Get the Backend.
1552 *
1553 * @return the Backend
1554 */
1555 public final Backend getBackend() {
1556 return backend;
1557 }
1558
1559 /**
1560 * Get the Screen.
1561 *
1562 * @return the Screen
1563 */
1564 public final Screen getScreen() {
1565 if (backend instanceof TWindowBackend) {
1566 // We are being rendered to a TWindow. We can't use its
1567 // getScreen() method because that is how it is rendering to a
1568 // hardware backend somewhere. Instead use its getOtherScreen()
1569 // method.
1570 return ((TWindowBackend) backend).getOtherScreen();
1571 } else {
1572 return backend.getScreen();
1573 }
1574 }
1575
1576 /**
1577 * Get the color theme.
1578 *
1579 * @return the theme
1580 */
1581 public final ColorTheme getTheme() {
1582 return theme;
1583 }
1584
1585 /**
1586 * Repaint the screen on the next update.
1587 */
1588 public void doRepaint() {
1589 repaint = true;
1590 wakeEventHandler();
1591 }
1592
1593 /**
1594 * Get Y coordinate of the top edge of the desktop.
1595 *
1596 * @return Y coordinate of the top edge of the desktop
1597 */
1598 public final int getDesktopTop() {
1599 return desktopTop;
1600 }
1601
1602 /**
1603 * Get Y coordinate of the bottom edge of the desktop.
1604 *
1605 * @return Y coordinate of the bottom edge of the desktop
1606 */
1607 public final int getDesktopBottom() {
1608 return desktopBottom;
1609 }
1610
1611 /**
1612 * Set the TDesktop instance.
1613 *
1614 * @param desktop a TDesktop instance, or null to remove the one that is
1615 * set
1616 */
1617 public final void setDesktop(final TDesktop desktop) {
1618 if (this.desktop != null) {
1619 this.desktop.onPreClose();
1620 this.desktop.onUnfocus();
1621 this.desktop.onClose();
1622 }
1623 this.desktop = desktop;
1624 }
1625
1626 /**
1627 * Get the TDesktop instance.
1628 *
1629 * @return the desktop, or null if it is not set
1630 */
1631 public final TDesktop getDesktop() {
1632 return desktop;
1633 }
1634
1635 /**
1636 * Get the current active window.
1637 *
1638 * @return the active window, or null if it is not set
1639 */
1640 public final TWindow getActiveWindow() {
1641 return activeWindow;
1642 }
1643
1644 /**
1645 * Get a (shallow) copy of the window list.
1646 *
1647 * @return a copy of the list of windows for this application
1648 */
1649 public final List<TWindow> getAllWindows() {
1650 List<TWindow> result = new ArrayList<TWindow>();
1651 result.addAll(windows);
1652 return result;
1653 }
1654
1655 /**
1656 * Get focusFollowsMouse flag.
1657 *
1658 * @return true if focus follows mouse: windows automatically raised if
1659 * the mouse passes over them
1660 */
1661 public boolean getFocusFollowsMouse() {
1662 return focusFollowsMouse;
1663 }
1664
1665 /**
1666 * Set focusFollowsMouse flag.
1667 *
1668 * @param focusFollowsMouse if true, focus follows mouse: windows
1669 * automatically raised if the mouse passes over them
1670 */
1671 public void setFocusFollowsMouse(final boolean focusFollowsMouse) {
1672 this.focusFollowsMouse = focusFollowsMouse;
1673 }
1674
1675 /**
1676 * Display the about dialog.
1677 */
1678 protected void showAboutDialog() {
1679 String version = getClass().getPackage().getImplementationVersion();
1680 if (version == null) {
1681 // This is Java 9+, use a hardcoded string here.
1682 version = "0.3.2";
1683 }
1684 messageBox(i18n.getString("aboutDialogTitle"),
1685 MessageFormat.format(i18n.getString("aboutDialogText"), version),
1686 TMessageBox.Type.OK);
1687 }
1688
1689 /**
1690 * Handle the Tool | Open image menu item.
1691 */
1692 private void openImage() {
1693 try {
1694 List<String> filters = new ArrayList<String>();
1695 filters.add("^.*\\.[Jj][Pp][Gg]$");
1696 filters.add("^.*\\.[Jj][Pp][Ee][Gg]$");
1697 filters.add("^.*\\.[Pp][Nn][Gg]$");
1698 filters.add("^.*\\.[Gg][Ii][Ff]$");
1699 filters.add("^.*\\.[Bb][Mm][Pp]$");
1700 String filename = fileOpenBox(".", TFileOpenBox.Type.OPEN, filters);
1701 if (filename != null) {
1702 new TImageWindow(this, new File(filename));
1703 }
1704 } catch (IOException e) {
1705 // Show this exception to the user.
1706 new TExceptionDialog(this, e);
1707 }
1708 }
1709
1710 /**
1711 * Check if application is still running.
1712 *
1713 * @return true if the application is running
1714 */
1715 public final boolean isRunning() {
1716 if (quit == true) {
1717 return false;
1718 }
1719 return true;
1720 }
1721
1722 // ------------------------------------------------------------------------
1723 // Screen refresh loop ----------------------------------------------------
1724 // ------------------------------------------------------------------------
1725
1726 /**
1727 * Invert the cell color at a position. This is used to track the mouse.
1728 *
1729 * @param x column position
1730 * @param y row position
1731 */
1732 private void invertCell(final int x, final int y) {
1733 invertCell(x, y, false);
1734 }
1735
1736 /**
1737 * Invert the cell color at a position. This is used to track the mouse.
1738 *
1739 * @param x column position
1740 * @param y row position
1741 * @param onlyThisCell if true, only invert this cell
1742 */
1743 private void invertCell(final int x, final int y,
1744 final boolean onlyThisCell) {
1745
1746 if (debugThreads) {
1747 System.err.printf("%d %s invertCell() %d %d\n",
1748 System.currentTimeMillis(), Thread.currentThread(), x, y);
1749
1750 if (activeWindow != null) {
1751 System.err.println("activeWindow.hasHiddenMouse() " +
1752 activeWindow.hasHiddenMouse());
1753 }
1754 }
1755
1756 // If this cell is on top of a visible window that has requested a
1757 // hidden mouse, bail out.
1758 if ((activeWindow != null) && (activeMenu == null)) {
1759 if ((activeWindow.hasHiddenMouse() == true)
1760 && (x > activeWindow.getX())
1761 && (x < activeWindow.getX() + activeWindow.getWidth() - 1)
1762 && (y > activeWindow.getY())
1763 && (y < activeWindow.getY() + activeWindow.getHeight() - 1)
1764 ) {
1765 return;
1766 }
1767 }
1768
1769 // If this cell is on top of the desktop, and the desktop has
1770 // requested a hidden mouse, bail out.
1771 if ((desktop != null) && (activeWindow == null) && (activeMenu == null)) {
1772 if ((desktop.hasHiddenMouse() == true)
1773 && (x > desktop.getX())
1774 && (x < desktop.getX() + desktop.getWidth() - 1)
1775 && (y > desktop.getY())
1776 && (y < desktop.getY() + desktop.getHeight() - 1)
1777 ) {
1778 return;
1779 }
1780 }
1781
1782 Cell cell = getScreen().getCharXY(x, y);
1783 if (cell.isImage()) {
1784 cell.invertImage();
1785 }
1786 if (cell.getForeColorRGB() < 0) {
1787 cell.setForeColor(cell.getForeColor().invert());
1788 } else {
1789 cell.setForeColorRGB(cell.getForeColorRGB() ^ 0x00ffffff);
1790 }
1791 if (cell.getBackColorRGB() < 0) {
1792 cell.setBackColor(cell.getBackColor().invert());
1793 } else {
1794 cell.setBackColorRGB(cell.getBackColorRGB() ^ 0x00ffffff);
1795 }
1796 getScreen().putCharXY(x, y, cell);
1797 if ((onlyThisCell == true) || (cell.getWidth() == Cell.Width.SINGLE)) {
1798 return;
1799 }
1800
1801 // This cell is one half of a fullwidth glyph. Invert the other
1802 // half.
1803 if (cell.getWidth() == Cell.Width.LEFT) {
1804 if (x < getScreen().getWidth() - 1) {
1805 Cell rightHalf = getScreen().getCharXY(x + 1, y);
1806 if (rightHalf.getWidth() == Cell.Width.RIGHT) {
1807 invertCell(x + 1, y, true);
1808 return;
1809 }
1810 }
1811 }
1812 if (cell.getWidth() == Cell.Width.RIGHT) {
1813 if (x > 0) {
1814 Cell leftHalf = getScreen().getCharXY(x - 1, y);
1815 if (leftHalf.getWidth() == Cell.Width.LEFT) {
1816 invertCell(x - 1, y, true);
1817 }
1818 }
1819 }
1820 }
1821
1822 /**
1823 * Draw everything.
1824 */
1825 private void drawAll() {
1826 boolean menuIsActive = false;
1827
1828 if (debugThreads) {
1829 System.err.printf("%d %s drawAll() enter\n",
1830 System.currentTimeMillis(), Thread.currentThread());
1831 }
1832
1833 // I don't think this does anything useful anymore...
1834 if (!repaint) {
1835 if (debugThreads) {
1836 System.err.printf("%d %s drawAll() !repaint\n",
1837 System.currentTimeMillis(), Thread.currentThread());
1838 }
1839 if ((oldDrawnMouseX != mouseX) || (oldDrawnMouseY != mouseY)) {
1840 if (debugThreads) {
1841 System.err.printf("%d %s drawAll() !repaint MOUSE\n",
1842 System.currentTimeMillis(), Thread.currentThread());
1843 }
1844
1845 // The only thing that has happened is the mouse moved.
1846
1847 // Redraw the old cell at that position, and save the cell at
1848 // the new mouse position.
1849 if (debugThreads) {
1850 System.err.printf("%d %s restoreImage() %d %d\n",
1851 System.currentTimeMillis(), Thread.currentThread(),
1852 oldDrawnMouseX, oldDrawnMouseY);
1853 }
1854 oldDrawnMouseCell.restoreImage();
1855 getScreen().putCharXY(oldDrawnMouseX, oldDrawnMouseY,
1856 oldDrawnMouseCell);
1857 oldDrawnMouseCell = getScreen().getCharXY(mouseX, mouseY);
1858 if (backend instanceof ECMA48Backend) {
1859 // Special case: the entire row containing the mouse has
1860 // to be re-drawn if it has any image data, AND any rows
1861 // in between.
1862 if (oldDrawnMouseY != mouseY) {
1863 for (int i = oldDrawnMouseY; ;) {
1864 getScreen().unsetImageRow(i);
1865 if (i == mouseY) {
1866 break;
1867 }
1868 if (oldDrawnMouseY < mouseY) {
1869 i++;
1870 } else {
1871 i--;
1872 }
1873 }
1874 } else {
1875 getScreen().unsetImageRow(mouseY);
1876 }
1877 }
1878
1879 if ((textMouse == true) && (typingHidMouse == false)) {
1880 // Draw mouse at the new position.
1881 invertCell(mouseX, mouseY);
1882 }
1883
1884 oldDrawnMouseX = mouseX;
1885 oldDrawnMouseY = mouseY;
1886 }
1887 if (getScreen().isDirty()) {
1888 screenHandler.setDirty();
1889 }
1890 return;
1891 }
1892
1893 if (debugThreads) {
1894 System.err.printf("%d %s drawAll() REDRAW\n",
1895 System.currentTimeMillis(), Thread.currentThread());
1896 }
1897
1898 // If true, the cursor is not visible
1899 boolean cursor = false;
1900
1901 // Start with a clean screen
1902 getScreen().clear();
1903
1904 // Draw the desktop
1905 if (desktop != null) {
1906 desktop.drawChildren();
1907 }
1908
1909 // Draw each window in reverse Z order
1910 List<TWindow> sorted = new ArrayList<TWindow>(windows);
1911 Collections.sort(sorted);
1912 TWindow topLevel = null;
1913 if (sorted.size() > 0) {
1914 topLevel = sorted.get(0);
1915 }
1916 Collections.reverse(sorted);
1917 for (TWindow window: sorted) {
1918 if (window.isShown()) {
1919 window.drawChildren();
1920 }
1921 }
1922
1923 if (hideMenuBar == false) {
1924
1925 // Draw the blank menubar line - reset the screen clipping first
1926 // so it won't trim it out.
1927 getScreen().resetClipping();
1928 getScreen().hLineXY(0, 0, getScreen().getWidth(), ' ',
1929 theme.getColor("tmenu"));
1930 // Now draw the menus.
1931 int x = 1;
1932 for (TMenu menu: menus) {
1933 CellAttributes menuColor;
1934 CellAttributes menuMnemonicColor;
1935 if (menu.isActive()) {
1936 menuIsActive = true;
1937 menuColor = theme.getColor("tmenu.highlighted");
1938 menuMnemonicColor = theme.getColor("tmenu.mnemonic.highlighted");
1939 topLevel = menu;
1940 } else {
1941 menuColor = theme.getColor("tmenu");
1942 menuMnemonicColor = theme.getColor("tmenu.mnemonic");
1943 }
1944 // Draw the menu title
1945 getScreen().hLineXY(x, 0,
1946 StringUtils.width(menu.getTitle()) + 2, ' ', menuColor);
1947 getScreen().putStringXY(x + 1, 0, menu.getTitle(), menuColor);
1948 // Draw the highlight character
1949 getScreen().putCharXY(x + 1 +
1950 menu.getMnemonic().getScreenShortcutIdx(),
1951 0, menu.getMnemonic().getShortcut(), menuMnemonicColor);
1952
1953 if (menu.isActive()) {
1954 ((TWindow) menu).drawChildren();
1955 // Reset the screen clipping so we can draw the next
1956 // title.
1957 getScreen().resetClipping();
1958 }
1959 x += StringUtils.width(menu.getTitle()) + 2;
1960 }
1961
1962 for (TMenu menu: subMenus) {
1963 // Reset the screen clipping so we can draw the next
1964 // sub-menu.
1965 getScreen().resetClipping();
1966 ((TWindow) menu).drawChildren();
1967 }
1968 }
1969 getScreen().resetClipping();
1970
1971 if (hideStatusBar == false) {
1972 // Draw the status bar of the top-level window
1973 TStatusBar statusBar = null;
1974 if (topLevel != null) {
1975 statusBar = topLevel.getStatusBar();
1976 }
1977 if (statusBar != null) {
1978 getScreen().resetClipping();
1979 statusBar.setWidth(getScreen().getWidth());
1980 statusBar.setY(getScreen().getHeight() - topLevel.getY());
1981 statusBar.draw();
1982 } else {
1983 CellAttributes barColor = new CellAttributes();
1984 barColor.setTo(getTheme().getColor("tstatusbar.text"));
1985 getScreen().hLineXY(0, desktopBottom, getScreen().getWidth(),
1986 ' ', barColor);
1987 }
1988 }
1989
1990 // Draw the mouse pointer
1991 if (debugThreads) {
1992 System.err.printf("%d %s restoreImage() %d %d\n",
1993 System.currentTimeMillis(), Thread.currentThread(),
1994 oldDrawnMouseX, oldDrawnMouseY);
1995 }
1996 oldDrawnMouseCell = getScreen().getCharXY(mouseX, mouseY);
1997 if (backend instanceof ECMA48Backend) {
1998 // Special case: the entire row containing the mouse has to be
1999 // re-drawn if it has any image data, AND any rows in between.
2000 if (oldDrawnMouseY != mouseY) {
2001 for (int i = oldDrawnMouseY; ;) {
2002 getScreen().unsetImageRow(i);
2003 if (i == mouseY) {
2004 break;
2005 }
2006 if (oldDrawnMouseY < mouseY) {
2007 i++;
2008 } else {
2009 i--;
2010 }
2011 }
2012 } else {
2013 getScreen().unsetImageRow(mouseY);
2014 }
2015 }
2016 if ((textMouse == true) && (typingHidMouse == false)) {
2017 invertCell(mouseX, mouseY);
2018 }
2019 oldDrawnMouseX = mouseX;
2020 oldDrawnMouseY = mouseY;
2021
2022 // Place the cursor if it is visible
2023 if (!menuIsActive) {
2024
2025 int visibleWindowCount = 0;
2026 for (TWindow window: sorted) {
2027 if (window.isShown()) {
2028 visibleWindowCount++;
2029 }
2030 }
2031 if (visibleWindowCount == 0) {
2032 // No windows are visible, only the desktop. Allow it to
2033 // have the cursor.
2034 if (desktop != null) {
2035 sorted.add(desktop);
2036 }
2037 }
2038
2039 TWidget activeWidget = null;
2040 if (sorted.size() > 0) {
2041 activeWidget = sorted.get(sorted.size() - 1).getActiveChild();
2042 int cursorClipTop = desktopTop;
2043 int cursorClipBottom = desktopBottom;
2044 if (activeWidget.isCursorVisible()) {
2045 if ((activeWidget.getCursorAbsoluteY() <= cursorClipBottom)
2046 && (activeWidget.getCursorAbsoluteY() >= cursorClipTop)
2047 ) {
2048 getScreen().putCursor(true,
2049 activeWidget.getCursorAbsoluteX(),
2050 activeWidget.getCursorAbsoluteY());
2051 cursor = true;
2052 } else {
2053 // Turn off the cursor. Also place it at 0,0.
2054 getScreen().putCursor(false, 0, 0);
2055 cursor = false;
2056 }
2057 }
2058 }
2059 }
2060
2061 // Kill the cursor
2062 if (!cursor) {
2063 getScreen().hideCursor();
2064 }
2065
2066 if (getScreen().isDirty()) {
2067 screenHandler.setDirty();
2068 }
2069 repaint = false;
2070 }
2071
2072 /**
2073 * Force this application to exit.
2074 */
2075 public void exit() {
2076 quit = true;
2077 synchronized (this) {
2078 this.notify();
2079 }
2080 }
2081
2082 /**
2083 * Subclasses can use this hook to cleanup resources. Called as the last
2084 * step of TApplication.run().
2085 */
2086 public void onExit() {
2087 // Default does nothing.
2088 }
2089
2090 // ------------------------------------------------------------------------
2091 // TWindow management -----------------------------------------------------
2092 // ------------------------------------------------------------------------
2093
2094 /**
2095 * Return the total number of windows.
2096 *
2097 * @return the total number of windows
2098 */
2099 public final int windowCount() {
2100 return windows.size();
2101 }
2102
2103 /**
2104 * Return the number of windows that are showing.
2105 *
2106 * @return the number of windows that are showing on screen
2107 */
2108 public final int shownWindowCount() {
2109 int n = 0;
2110 for (TWindow w: windows) {
2111 if (w.isShown()) {
2112 n++;
2113 }
2114 }
2115 return n;
2116 }
2117
2118 /**
2119 * Return the number of windows that are hidden.
2120 *
2121 * @return the number of windows that are hidden
2122 */
2123 public final int hiddenWindowCount() {
2124 int n = 0;
2125 for (TWindow w: windows) {
2126 if (w.isHidden()) {
2127 n++;
2128 }
2129 }
2130 return n;
2131 }
2132
2133 /**
2134 * Check if a window instance is in this application's window list.
2135 *
2136 * @param window window to look for
2137 * @return true if this window is in the list
2138 */
2139 public final boolean hasWindow(final TWindow window) {
2140 if (windows.size() == 0) {
2141 return false;
2142 }
2143 for (TWindow w: windows) {
2144 if (w == window) {
2145 assert (window.getApplication() == this);
2146 return true;
2147 }
2148 }
2149 return false;
2150 }
2151
2152 /**
2153 * Activate a window: bring it to the top and have it receive events.
2154 *
2155 * @param window the window to become the new active window
2156 */
2157 public void activateWindow(final TWindow window) {
2158 if (hasWindow(window) == false) {
2159 /*
2160 * Someone has a handle to a window I don't have. Ignore this
2161 * request.
2162 */
2163 return;
2164 }
2165
2166 // Whatever window might be moving/dragging, stop it now.
2167 for (TWindow w: windows) {
2168 if (w.inMovements()) {
2169 w.stopMovements();
2170 }
2171 }
2172
2173 assert (windows.size() > 0);
2174
2175 if (window.isHidden()) {
2176 // Unhiding will also activate.
2177 showWindow(window);
2178 return;
2179 }
2180 assert (window.isShown());
2181
2182 if (windows.size() == 1) {
2183 assert (window == windows.get(0));
2184 if (activeWindow == null) {
2185 activeWindow = window;
2186 window.setZ(0);
2187 activeWindow.setActive(true);
2188 activeWindow.onFocus();
2189 }
2190
2191 assert (window.isActive());
2192 assert (activeWindow == window);
2193 return;
2194 }
2195
2196 if (activeWindow == window) {
2197 assert (window.isActive());
2198
2199 // Window is already active, do nothing.
2200 return;
2201 }
2202
2203 assert (!window.isActive());
2204 if (activeWindow != null) {
2205 // TODO: see if this assertion is really necessary.
2206 // assert (activeWindow.getZ() == 0);
2207
2208 activeWindow.setActive(false);
2209
2210 // Increment every window Z that is on top of window
2211 for (TWindow w: windows) {
2212 if (w == window) {
2213 continue;
2214 }
2215 if (w.getZ() < window.getZ()) {
2216 w.setZ(w.getZ() + 1);
2217 }
2218 }
2219
2220 // Unset activeWindow now before unfocus, so that a window
2221 // lifecycle change inside onUnfocus() doesn't call
2222 // switchWindow() and lead to a stack overflow.
2223 TWindow oldActiveWindow = activeWindow;
2224 activeWindow = null;
2225 oldActiveWindow.onUnfocus();
2226 }
2227 activeWindow = window;
2228 activeWindow.setZ(0);
2229 activeWindow.setActive(true);
2230 activeWindow.onFocus();
2231 return;
2232 }
2233
2234 /**
2235 * Hide a window.
2236 *
2237 * @param window the window to hide
2238 */
2239 public void hideWindow(final TWindow window) {
2240 if (hasWindow(window) == false) {
2241 /*
2242 * Someone has a handle to a window I don't have. Ignore this
2243 * request.
2244 */
2245 return;
2246 }
2247
2248 // Whatever window might be moving/dragging, stop it now.
2249 for (TWindow w: windows) {
2250 if (w.inMovements()) {
2251 w.stopMovements();
2252 }
2253 }
2254
2255 assert (windows.size() > 0);
2256
2257 if (!window.hidden) {
2258 if (window == activeWindow) {
2259 if (shownWindowCount() > 1) {
2260 switchWindow(true);
2261 } else {
2262 activeWindow = null;
2263 window.setActive(false);
2264 window.onUnfocus();
2265 }
2266 }
2267 window.hidden = true;
2268 window.onHide();
2269 }
2270 }
2271
2272 /**
2273 * Show a window.
2274 *
2275 * @param window the window to show
2276 */
2277 public void showWindow(final TWindow window) {
2278 if (hasWindow(window) == false) {
2279 /*
2280 * Someone has a handle to a window I don't have. Ignore this
2281 * request.
2282 */
2283 return;
2284 }
2285
2286 // Whatever window might be moving/dragging, stop it now.
2287 for (TWindow w: windows) {
2288 if (w.inMovements()) {
2289 w.stopMovements();
2290 }
2291 }
2292
2293 assert (windows.size() > 0);
2294
2295 if (window.hidden) {
2296 window.hidden = false;
2297 window.onShow();
2298 activateWindow(window);
2299 }
2300 }
2301
2302 /**
2303 * Close window. Note that the window's destructor is NOT called by this
2304 * method, instead the GC is assumed to do the cleanup.
2305 *
2306 * @param window the window to remove
2307 */
2308 public final void closeWindow(final TWindow window) {
2309 if (hasWindow(window) == false) {
2310 /*
2311 * Someone has a handle to a window I don't have. Ignore this
2312 * request.
2313 */
2314 return;
2315 }
2316
2317 // Let window know that it is about to be closed, while it is still
2318 // visible on screen.
2319 window.onPreClose();
2320
2321 synchronized (windows) {
2322 // Whatever window might be moving/dragging, stop it now.
2323 for (TWindow w: windows) {
2324 if (w.inMovements()) {
2325 w.stopMovements();
2326 }
2327 }
2328
2329 int z = window.getZ();
2330 window.setZ(-1);
2331 window.onUnfocus();
2332 windows.remove(window);
2333 Collections.sort(windows);
2334 activeWindow = null;
2335 int newZ = 0;
2336 boolean foundNextWindow = false;
2337
2338 for (TWindow w: windows) {
2339 w.setZ(newZ);
2340 newZ++;
2341
2342 // Do not activate a hidden window.
2343 if (w.isHidden()) {
2344 continue;
2345 }
2346
2347 if (foundNextWindow == false) {
2348 foundNextWindow = true;
2349 w.setActive(true);
2350 w.onFocus();
2351 assert (activeWindow == null);
2352 activeWindow = w;
2353 continue;
2354 }
2355
2356 if (w.isActive()) {
2357 w.setActive(false);
2358 w.onUnfocus();
2359 }
2360 }
2361 }
2362
2363 // Perform window cleanup
2364 window.onClose();
2365
2366 // Check if we are closing a TMessageBox or similar
2367 if (secondaryEventReceiver != null) {
2368 assert (secondaryEventHandler != null);
2369
2370 // Do not send events to the secondaryEventReceiver anymore, the
2371 // window is closed.
2372 secondaryEventReceiver = null;
2373
2374 // Wake the secondary thread, it will wake the primary as it
2375 // exits.
2376 synchronized (secondaryEventHandler) {
2377 secondaryEventHandler.notify();
2378 }
2379 }
2380
2381 // Permit desktop to be active if it is the only thing left.
2382 if (desktop != null) {
2383 if (windows.size() == 0) {
2384 desktop.setActive(true);
2385 }
2386 }
2387 }
2388
2389 /**
2390 * Switch to the next window.
2391 *
2392 * @param forward if true, then switch to the next window in the list,
2393 * otherwise switch to the previous window in the list
2394 */
2395 public final void switchWindow(final boolean forward) {
2396 // Only switch if there are multiple visible windows
2397 if (shownWindowCount() < 2) {
2398 return;
2399 }
2400 assert (activeWindow != null);
2401
2402 synchronized (windows) {
2403 // Whatever window might be moving/dragging, stop it now.
2404 for (TWindow w: windows) {
2405 if (w.inMovements()) {
2406 w.stopMovements();
2407 }
2408 }
2409
2410 // Swap z/active between active window and the next in the list
2411 int activeWindowI = -1;
2412 for (int i = 0; i < windows.size(); i++) {
2413 if (windows.get(i) == activeWindow) {
2414 assert (activeWindow.isActive());
2415 activeWindowI = i;
2416 break;
2417 } else {
2418 assert (!windows.get(0).isActive());
2419 }
2420 }
2421 assert (activeWindowI >= 0);
2422
2423 // Do not switch if a window is modal
2424 if (activeWindow.isModal()) {
2425 return;
2426 }
2427
2428 int nextWindowI = activeWindowI;
2429 for (;;) {
2430 if (forward) {
2431 nextWindowI++;
2432 nextWindowI %= windows.size();
2433 } else {
2434 nextWindowI--;
2435 if (nextWindowI < 0) {
2436 nextWindowI = windows.size() - 1;
2437 }
2438 }
2439
2440 if (windows.get(nextWindowI).isShown()) {
2441 activateWindow(windows.get(nextWindowI));
2442 break;
2443 }
2444 }
2445 } // synchronized (windows)
2446
2447 }
2448
2449 /**
2450 * Add a window to my window list and make it active. Note package
2451 * private access.
2452 *
2453 * @param window new window to add
2454 */
2455 final void addWindowToApplication(final TWindow window) {
2456
2457 // Do not add menu windows to the window list.
2458 if (window instanceof TMenu) {
2459 return;
2460 }
2461
2462 // Do not add the desktop to the window list.
2463 if (window instanceof TDesktop) {
2464 return;
2465 }
2466
2467 synchronized (windows) {
2468 if (windows.contains(window)) {
2469 throw new IllegalArgumentException("Window " + window +
2470 " is already in window list");
2471 }
2472
2473 // Whatever window might be moving/dragging, stop it now.
2474 for (TWindow w: windows) {
2475 if (w.inMovements()) {
2476 w.stopMovements();
2477 }
2478 }
2479
2480 // Do not allow a modal window to spawn a non-modal window. If a
2481 // modal window is active, then this window will become modal
2482 // too.
2483 if (modalWindowActive()) {
2484 window.flags |= TWindow.MODAL;
2485 window.flags |= TWindow.CENTERED;
2486 window.hidden = false;
2487 }
2488 if (window.isShown()) {
2489 for (TWindow w: windows) {
2490 if (w.isActive()) {
2491 w.setActive(false);
2492 w.onUnfocus();
2493 }
2494 w.setZ(w.getZ() + 1);
2495 }
2496 }
2497 windows.add(window);
2498 if (window.isShown()) {
2499 activeWindow = window;
2500 activeWindow.setZ(0);
2501 activeWindow.setActive(true);
2502 activeWindow.onFocus();
2503 }
2504
2505 if (((window.flags & TWindow.CENTERED) == 0)
2506 && ((window.flags & TWindow.ABSOLUTEXY) == 0)
2507 && (smartWindowPlacement == true)
2508 && (!(window instanceof TDesktop))
2509 ) {
2510
2511 doSmartPlacement(window);
2512 }
2513 }
2514
2515 // Desktop cannot be active over any other window.
2516 if (desktop != null) {
2517 desktop.setActive(false);
2518 }
2519 }
2520
2521 /**
2522 * Check if there is a system-modal window on top.
2523 *
2524 * @return true if the active window is modal
2525 */
2526 private boolean modalWindowActive() {
2527 if (windows.size() == 0) {
2528 return false;
2529 }
2530
2531 for (TWindow w: windows) {
2532 if (w.isModal()) {
2533 return true;
2534 }
2535 }
2536
2537 return false;
2538 }
2539
2540 /**
2541 * Check if there is a window with overridden menu flag on top.
2542 *
2543 * @return true if the active window is overriding the menu
2544 */
2545 private boolean overrideMenuWindowActive() {
2546 if (activeWindow != null) {
2547 if (activeWindow.hasOverriddenMenu()) {
2548 return true;
2549 }
2550 }
2551
2552 return false;
2553 }
2554
2555 /**
2556 * Close all open windows.
2557 */
2558 private void closeAllWindows() {
2559 // Don't do anything if we are in the menu
2560 if (activeMenu != null) {
2561 return;
2562 }
2563 while (windows.size() > 0) {
2564 closeWindow(windows.get(0));
2565 }
2566 }
2567
2568 /**
2569 * Re-layout the open windows as non-overlapping tiles. This produces
2570 * almost the same results as Turbo Pascal 7.0's IDE.
2571 */
2572 private void tileWindows() {
2573 synchronized (windows) {
2574 // Don't do anything if we are in the menu
2575 if (activeMenu != null) {
2576 return;
2577 }
2578 int z = windows.size();
2579 if (z == 0) {
2580 return;
2581 }
2582 int a = 0;
2583 int b = 0;
2584 a = (int)(Math.sqrt(z));
2585 int c = 0;
2586 while (c < a) {
2587 b = (z - c) / a;
2588 if (((a * b) + c) == z) {
2589 break;
2590 }
2591 c++;
2592 }
2593 assert (a > 0);
2594 assert (b > 0);
2595 assert (c < a);
2596 int newWidth = (getScreen().getWidth() / a);
2597 int newHeight1 = ((getScreen().getHeight() - 1) / b);
2598 int newHeight2 = ((getScreen().getHeight() - 1) / (b + c));
2599
2600 List<TWindow> sorted = new ArrayList<TWindow>(windows);
2601 Collections.sort(sorted);
2602 Collections.reverse(sorted);
2603 for (int i = 0; i < sorted.size(); i++) {
2604 int logicalX = i / b;
2605 int logicalY = i % b;
2606 if (i >= ((a - 1) * b)) {
2607 logicalX = a - 1;
2608 logicalY = i - ((a - 1) * b);
2609 }
2610
2611 TWindow w = sorted.get(i);
2612 int oldWidth = w.getWidth();
2613 int oldHeight = w.getHeight();
2614
2615 w.setX(logicalX * newWidth);
2616 w.setWidth(newWidth);
2617 if (i >= ((a - 1) * b)) {
2618 w.setY((logicalY * newHeight2) + 1);
2619 w.setHeight(newHeight2);
2620 } else {
2621 w.setY((logicalY * newHeight1) + 1);
2622 w.setHeight(newHeight1);
2623 }
2624 if ((w.getWidth() != oldWidth)
2625 || (w.getHeight() != oldHeight)
2626 ) {
2627 w.onResize(new TResizeEvent(TResizeEvent.Type.WIDGET,
2628 w.getWidth(), w.getHeight()));
2629 }
2630 }
2631 }
2632 }
2633
2634 /**
2635 * Re-layout the open windows as overlapping cascaded windows.
2636 */
2637 private void cascadeWindows() {
2638 synchronized (windows) {
2639 // Don't do anything if we are in the menu
2640 if (activeMenu != null) {
2641 return;
2642 }
2643 int x = 0;
2644 int y = 1;
2645 List<TWindow> sorted = new ArrayList<TWindow>(windows);
2646 Collections.sort(sorted);
2647 Collections.reverse(sorted);
2648 for (TWindow window: sorted) {
2649 window.setX(x);
2650 window.setY(y);
2651 x++;
2652 y++;
2653 if (x > getScreen().getWidth()) {
2654 x = 0;
2655 }
2656 if (y >= getScreen().getHeight()) {
2657 y = 1;
2658 }
2659 }
2660 }
2661 }
2662
2663 /**
2664 * Place a window to minimize its overlap with other windows.
2665 *
2666 * @param window the window to place
2667 */
2668 public final void doSmartPlacement(final TWindow window) {
2669 // This is a pretty dumb algorithm, but seems to work. The hardest
2670 // part is computing these "overlap" values seeking a minimum average
2671 // overlap.
2672 int xMin = 0;
2673 int yMin = desktopTop;
2674 int xMax = getScreen().getWidth() - window.getWidth() + 1;
2675 int yMax = desktopBottom - window.getHeight() + 1;
2676 if (xMax < xMin) {
2677 xMax = xMin;
2678 }
2679 if (yMax < yMin) {
2680 yMax = yMin;
2681 }
2682
2683 if ((xMin == xMax) && (yMin == yMax)) {
2684 // No work to do, bail out.
2685 return;
2686 }
2687
2688 // Compute the overlap matrix without the new window.
2689 int width = getScreen().getWidth();
2690 int height = getScreen().getHeight();
2691 int overlapMatrix[][] = new int[width][height];
2692 for (TWindow w: windows) {
2693 if (window == w) {
2694 continue;
2695 }
2696 for (int x = w.getX(); x < w.getX() + w.getWidth(); x++) {
2697 if (x < 0) {
2698 continue;
2699 }
2700 if (x >= width) {
2701 continue;
2702 }
2703 for (int y = w.getY(); y < w.getY() + w.getHeight(); y++) {
2704 if (y < 0) {
2705 continue;
2706 }
2707 if (y >= height) {
2708 continue;
2709 }
2710 overlapMatrix[x][y]++;
2711 }
2712 }
2713 }
2714
2715 long oldOverlapTotal = 0;
2716 long oldOverlapN = 0;
2717 for (int x = 0; x < width; x++) {
2718 for (int y = 0; y < height; y++) {
2719 oldOverlapTotal += overlapMatrix[x][y];
2720 if (overlapMatrix[x][y] > 0) {
2721 oldOverlapN++;
2722 }
2723 }
2724 }
2725
2726
2727 double oldOverlapAvg = (double) oldOverlapTotal / (double) oldOverlapN;
2728 boolean first = true;
2729 int windowX = window.getX();
2730 int windowY = window.getY();
2731
2732 // For each possible (x, y) position for the new window, compute a
2733 // new overlap matrix.
2734 for (int x = xMin; x < xMax; x++) {
2735 for (int y = yMin; y < yMax; y++) {
2736
2737 // Start with the matrix minus this window.
2738 int newMatrix[][] = new int[width][height];
2739 for (int mx = 0; mx < width; mx++) {
2740 for (int my = 0; my < height; my++) {
2741 newMatrix[mx][my] = overlapMatrix[mx][my];
2742 }
2743 }
2744
2745 // Add this window's values to the new overlap matrix.
2746 long newOverlapTotal = 0;
2747 long newOverlapN = 0;
2748 // Start by adding each new cell.
2749 for (int wx = x; wx < x + window.getWidth(); wx++) {
2750 if (wx >= width) {
2751 continue;
2752 }
2753 for (int wy = y; wy < y + window.getHeight(); wy++) {
2754 if (wy >= height) {
2755 continue;
2756 }
2757 newMatrix[wx][wy]++;
2758 }
2759 }
2760 // Now figure out the new value for total coverage.
2761 for (int mx = 0; mx < width; mx++) {
2762 for (int my = 0; my < height; my++) {
2763 newOverlapTotal += newMatrix[x][y];
2764 if (newMatrix[mx][my] > 0) {
2765 newOverlapN++;
2766 }
2767 }
2768 }
2769 double newOverlapAvg = (double) newOverlapTotal / (double) newOverlapN;
2770
2771 if (first) {
2772 // First time: just record what we got.
2773 oldOverlapAvg = newOverlapAvg;
2774 first = false;
2775 } else {
2776 // All other times: pick a new best (x, y) and save the
2777 // overlap value.
2778 if (newOverlapAvg < oldOverlapAvg) {
2779 windowX = x;
2780 windowY = y;
2781 oldOverlapAvg = newOverlapAvg;
2782 }
2783 }
2784
2785 } // for (int x = xMin; x < xMax; x++)
2786
2787 } // for (int y = yMin; y < yMax; y++)
2788
2789 // Finally, set the window's new coordinates.
2790 window.setX(windowX);
2791 window.setY(windowY);
2792 }
2793
2794 // ------------------------------------------------------------------------
2795 // TMenu management -------------------------------------------------------
2796 // ------------------------------------------------------------------------
2797
2798 /**
2799 * Check if a mouse event would hit either the active menu or any open
2800 * sub-menus.
2801 *
2802 * @param mouse mouse event
2803 * @return true if the mouse would hit the active menu or an open
2804 * sub-menu
2805 */
2806 private boolean mouseOnMenu(final TMouseEvent mouse) {
2807 assert (activeMenu != null);
2808 List<TMenu> menus = new ArrayList<TMenu>(subMenus);
2809 Collections.reverse(menus);
2810 for (TMenu menu: menus) {
2811 if (menu.mouseWouldHit(mouse)) {
2812 return true;
2813 }
2814 }
2815 return activeMenu.mouseWouldHit(mouse);
2816 }
2817
2818 /**
2819 * See if we need to switch window or activate the menu based on
2820 * a mouse click.
2821 *
2822 * @param mouse mouse event
2823 */
2824 private void checkSwitchFocus(final TMouseEvent mouse) {
2825
2826 if ((mouse.getType() == TMouseEvent.Type.MOUSE_DOWN)
2827 && (activeMenu != null)
2828 && (mouse.getAbsoluteY() != 0)
2829 && (!mouseOnMenu(mouse))
2830 ) {
2831 // They clicked outside the active menu, turn it off
2832 activeMenu.setActive(false);
2833 activeMenu = null;
2834 for (TMenu menu: subMenus) {
2835 menu.setActive(false);
2836 }
2837 subMenus.clear();
2838 // Continue checks
2839 }
2840
2841 // See if they hit the menu bar
2842 if ((mouse.getType() == TMouseEvent.Type.MOUSE_DOWN)
2843 && (mouse.isMouse1())
2844 && (!modalWindowActive())
2845 && (!overrideMenuWindowActive())
2846 && (mouse.getAbsoluteY() == 0)
2847 && (hideMenuBar == false)
2848 ) {
2849
2850 for (TMenu menu: subMenus) {
2851 menu.setActive(false);
2852 }
2853 subMenus.clear();
2854
2855 // They selected the menu, go activate it
2856 for (TMenu menu: menus) {
2857 if ((mouse.getAbsoluteX() >= menu.getTitleX())
2858 && (mouse.getAbsoluteX() < menu.getTitleX()
2859 + StringUtils.width(menu.getTitle()) + 2)
2860 ) {
2861 menu.setActive(true);
2862 activeMenu = menu;
2863 } else {
2864 menu.setActive(false);
2865 }
2866 }
2867 return;
2868 }
2869
2870 // See if they hit the menu bar
2871 if ((mouse.getType() == TMouseEvent.Type.MOUSE_MOTION)
2872 && (mouse.isMouse1())
2873 && (activeMenu != null)
2874 && (mouse.getAbsoluteY() == 0)
2875 && (hideMenuBar == false)
2876 ) {
2877
2878 TMenu oldMenu = activeMenu;
2879 for (TMenu menu: subMenus) {
2880 menu.setActive(false);
2881 }
2882 subMenus.clear();
2883
2884 // See if we should switch menus
2885 for (TMenu menu: menus) {
2886 if ((mouse.getAbsoluteX() >= menu.getTitleX())
2887 && (mouse.getAbsoluteX() < menu.getTitleX()
2888 + StringUtils.width(menu.getTitle()) + 2)
2889 ) {
2890 menu.setActive(true);
2891 activeMenu = menu;
2892 }
2893 }
2894 if (oldMenu != activeMenu) {
2895 // They switched menus
2896 oldMenu.setActive(false);
2897 }
2898 return;
2899 }
2900
2901 // If a menu is still active, don't switch windows
2902 if (activeMenu != null) {
2903 return;
2904 }
2905
2906 // Only switch if there are multiple windows
2907 if (windows.size() < 2) {
2908 return;
2909 }
2910
2911 if (((focusFollowsMouse == true)
2912 && (mouse.getType() == TMouseEvent.Type.MOUSE_MOTION))
2913 || (mouse.getType() == TMouseEvent.Type.MOUSE_DOWN)
2914 ) {
2915 synchronized (windows) {
2916 Collections.sort(windows);
2917 if (windows.get(0).isModal()) {
2918 // Modal windows don't switch
2919 return;
2920 }
2921
2922 for (TWindow window: windows) {
2923 assert (!window.isModal());
2924
2925 if (window.isHidden()) {
2926 assert (!window.isActive());
2927 continue;
2928 }
2929
2930 if (window.mouseWouldHit(mouse)) {
2931 if (window == windows.get(0)) {
2932 // Clicked on the same window, nothing to do
2933 assert (window.isActive());
2934 return;
2935 }
2936
2937 // We will be switching to another window
2938 assert (windows.get(0).isActive());
2939 assert (windows.get(0) == activeWindow);
2940 assert (!window.isActive());
2941 if (activeWindow != null) {
2942 activeWindow.onUnfocus();
2943 activeWindow.setActive(false);
2944 activeWindow.setZ(window.getZ());
2945 }
2946 activeWindow = window;
2947 window.setZ(0);
2948 window.setActive(true);
2949 window.onFocus();
2950 return;
2951 }
2952 }
2953 }
2954
2955 // Clicked on the background, nothing to do
2956 return;
2957 }
2958
2959 // Nothing to do: this isn't a mouse up, or focus isn't following
2960 // mouse.
2961 return;
2962 }
2963
2964 /**
2965 * Turn off the menu.
2966 */
2967 public final void closeMenu() {
2968 if (activeMenu != null) {
2969 activeMenu.setActive(false);
2970 activeMenu = null;
2971 for (TMenu menu: subMenus) {
2972 menu.setActive(false);
2973 }
2974 subMenus.clear();
2975 }
2976 }
2977
2978 /**
2979 * Get a (shallow) copy of the menu list.
2980 *
2981 * @return a copy of the menu list
2982 */
2983 public final List<TMenu> getAllMenus() {
2984 return new ArrayList<TMenu>(menus);
2985 }
2986
2987 /**
2988 * Add a top-level menu to the list.
2989 *
2990 * @param menu the menu to add
2991 * @throws IllegalArgumentException if the menu is already used in
2992 * another TApplication
2993 */
2994 public final void addMenu(final TMenu menu) {
2995 if ((menu.getApplication() != null)
2996 && (menu.getApplication() != this)
2997 ) {
2998 throw new IllegalArgumentException("Menu " + menu + " is already " +
2999 "part of application " + menu.getApplication());
3000 }
3001 closeMenu();
3002 menus.add(menu);
3003 recomputeMenuX();
3004 }
3005
3006 /**
3007 * Remove a top-level menu from the list.
3008 *
3009 * @param menu the menu to remove
3010 * @throws IllegalArgumentException if the menu is already used in
3011 * another TApplication
3012 */
3013 public final void removeMenu(final TMenu menu) {
3014 if ((menu.getApplication() != null)
3015 && (menu.getApplication() != this)
3016 ) {
3017 throw new IllegalArgumentException("Menu " + menu + " is already " +
3018 "part of application " + menu.getApplication());
3019 }
3020 closeMenu();
3021 menus.remove(menu);
3022 recomputeMenuX();
3023 }
3024
3025 /**
3026 * Turn off a sub-menu.
3027 */
3028 public final void closeSubMenu() {
3029 assert (activeMenu != null);
3030 TMenu item = subMenus.get(subMenus.size() - 1);
3031 assert (item != null);
3032 item.setActive(false);
3033 subMenus.remove(subMenus.size() - 1);
3034 }
3035
3036 /**
3037 * Switch to the next menu.
3038 *
3039 * @param forward if true, then switch to the next menu in the list,
3040 * otherwise switch to the previous menu in the list
3041 */
3042 public final void switchMenu(final boolean forward) {
3043 assert (activeMenu != null);
3044 assert (hideMenuBar == false);
3045
3046 for (TMenu menu: subMenus) {
3047 menu.setActive(false);
3048 }
3049 subMenus.clear();
3050
3051 for (int i = 0; i < menus.size(); i++) {
3052 if (activeMenu == menus.get(i)) {
3053 if (forward) {
3054 if (i < menus.size() - 1) {
3055 i++;
3056 } else {
3057 i = 0;
3058 }
3059 } else {
3060 if (i > 0) {
3061 i--;
3062 } else {
3063 i = menus.size() - 1;
3064 }
3065 }
3066 activeMenu.setActive(false);
3067 activeMenu = menus.get(i);
3068 activeMenu.setActive(true);
3069 return;
3070 }
3071 }
3072 }
3073
3074 /**
3075 * Add a menu item to the global list. If it has a keyboard accelerator,
3076 * that will be added the global hash.
3077 *
3078 * @param item the menu item
3079 */
3080 public final void addMenuItem(final TMenuItem item) {
3081 menuItems.add(item);
3082
3083 TKeypress key = item.getKey();
3084 if (key != null) {
3085 synchronized (accelerators) {
3086 assert (accelerators.get(key) == null);
3087 accelerators.put(key.toLowerCase(), item);
3088 }
3089 }
3090 }
3091
3092 /**
3093 * Disable one menu item.
3094 *
3095 * @param id the menu item ID
3096 */
3097 public final void disableMenuItem(final int id) {
3098 for (TMenuItem item: menuItems) {
3099 if (item.getId() == id) {
3100 item.setEnabled(false);
3101 }
3102 }
3103 }
3104
3105 /**
3106 * Disable the range of menu items with ID's between lower and upper,
3107 * inclusive.
3108 *
3109 * @param lower the lowest menu item ID
3110 * @param upper the highest menu item ID
3111 */
3112 public final void disableMenuItems(final int lower, final int upper) {
3113 for (TMenuItem item: menuItems) {
3114 if ((item.getId() >= lower) && (item.getId() <= upper)) {
3115 item.setEnabled(false);
3116 item.getParent().activate(0);
3117 }
3118 }
3119 }
3120
3121 /**
3122 * Enable one menu item.
3123 *
3124 * @param id the menu item ID
3125 */
3126 public final void enableMenuItem(final int id) {
3127 for (TMenuItem item: menuItems) {
3128 if (item.getId() == id) {
3129 item.setEnabled(true);
3130 item.getParent().activate(0);
3131 }
3132 }
3133 }
3134
3135 /**
3136 * Enable the range of menu items with ID's between lower and upper,
3137 * inclusive.
3138 *
3139 * @param lower the lowest menu item ID
3140 * @param upper the highest menu item ID
3141 */
3142 public final void enableMenuItems(final int lower, final int upper) {
3143 for (TMenuItem item: menuItems) {
3144 if ((item.getId() >= lower) && (item.getId() <= upper)) {
3145 item.setEnabled(true);
3146 item.getParent().activate(0);
3147 }
3148 }
3149 }
3150
3151 /**
3152 * Get the menu item associated with this ID.
3153 *
3154 * @param id the menu item ID
3155 * @return the menu item, or null if not found
3156 */
3157 public final TMenuItem getMenuItem(final int id) {
3158 for (TMenuItem item: menuItems) {
3159 if (item.getId() == id) {
3160 return item;
3161 }
3162 }
3163 return null;
3164 }
3165
3166 /**
3167 * Recompute menu x positions based on their title length.
3168 */
3169 public final void recomputeMenuX() {
3170 int x = 0;
3171 for (TMenu menu: menus) {
3172 menu.setX(x);
3173 menu.setTitleX(x);
3174 x += StringUtils.width(menu.getTitle()) + 2;
3175
3176 // Don't let the menu window exceed the screen width
3177 int rightEdge = menu.getX() + menu.getWidth();
3178 if (rightEdge > getScreen().getWidth()) {
3179 menu.setX(getScreen().getWidth() - menu.getWidth());
3180 }
3181 }
3182 }
3183
3184 /**
3185 * Post an event to process.
3186 *
3187 * @param event new event to add to the queue
3188 */
3189 public final void postEvent(final TInputEvent event) {
3190 synchronized (this) {
3191 synchronized (fillEventQueue) {
3192 fillEventQueue.add(event);
3193 }
3194 if (debugThreads) {
3195 System.err.println(System.currentTimeMillis() + " " +
3196 Thread.currentThread() + " postEvent() wake up main");
3197 }
3198 this.notify();
3199 }
3200 }
3201
3202 /**
3203 * Post an event to process and turn off the menu.
3204 *
3205 * @param event new event to add to the queue
3206 */
3207 public final void postMenuEvent(final TInputEvent event) {
3208 synchronized (this) {
3209 synchronized (fillEventQueue) {
3210 fillEventQueue.add(event);
3211 }
3212 if (debugThreads) {
3213 System.err.println(System.currentTimeMillis() + " " +
3214 Thread.currentThread() + " postMenuEvent() wake up main");
3215 }
3216 closeMenu();
3217 this.notify();
3218 }
3219 }
3220
3221 /**
3222 * Add a sub-menu to the list of open sub-menus.
3223 *
3224 * @param menu sub-menu
3225 */
3226 public final void addSubMenu(final TMenu menu) {
3227 subMenus.add(menu);
3228 }
3229
3230 /**
3231 * Convenience function to add a top-level menu.
3232 *
3233 * @param title menu title
3234 * @return the new menu
3235 */
3236 public final TMenu addMenu(final String title) {
3237 int x = 0;
3238 int y = 0;
3239 TMenu menu = new TMenu(this, x, y, title);
3240 menus.add(menu);
3241 recomputeMenuX();
3242 return menu;
3243 }
3244
3245 /**
3246 * Convenience function to add a default tools (hamburger) menu.
3247 *
3248 * @return the new menu
3249 */
3250 public final TMenu addToolMenu() {
3251 TMenu toolMenu = addMenu(i18n.getString("toolMenuTitle"));
3252 toolMenu.addDefaultItem(TMenu.MID_REPAINT);
3253 toolMenu.addDefaultItem(TMenu.MID_VIEW_IMAGE);
3254 toolMenu.addDefaultItem(TMenu.MID_SCREEN_OPTIONS);
3255 TStatusBar toolStatusBar = toolMenu.newStatusBar(i18n.
3256 getString("toolMenuStatus"));
3257 toolStatusBar.addShortcutKeypress(kbF1, cmHelp, i18n.getString("Help"));
3258 return toolMenu;
3259 }
3260
3261 /**
3262 * Convenience function to add a default "File" menu.
3263 *
3264 * @return the new menu
3265 */
3266 public final TMenu addFileMenu() {
3267 TMenu fileMenu = addMenu(i18n.getString("fileMenuTitle"));
3268 fileMenu.addDefaultItem(TMenu.MID_SHELL);
3269 fileMenu.addSeparator();
3270 fileMenu.addDefaultItem(TMenu.MID_EXIT);
3271 TStatusBar statusBar = fileMenu.newStatusBar(i18n.
3272 getString("fileMenuStatus"));
3273 statusBar.addShortcutKeypress(kbF1, cmHelp, i18n.getString("Help"));
3274 return fileMenu;
3275 }
3276
3277 /**
3278 * Convenience function to add a default "Edit" menu.
3279 *
3280 * @return the new menu
3281 */
3282 public final TMenu addEditMenu() {
3283 TMenu editMenu = addMenu(i18n.getString("editMenuTitle"));
3284 editMenu.addDefaultItem(TMenu.MID_CUT);
3285 editMenu.addDefaultItem(TMenu.MID_COPY);
3286 editMenu.addDefaultItem(TMenu.MID_PASTE);
3287 editMenu.addDefaultItem(TMenu.MID_CLEAR);
3288 TStatusBar statusBar = editMenu.newStatusBar(i18n.
3289 getString("editMenuStatus"));
3290 statusBar.addShortcutKeypress(kbF1, cmHelp, i18n.getString("Help"));
3291 return editMenu;
3292 }
3293
3294 /**
3295 * Convenience function to add a default "Window" menu.
3296 *
3297 * @return the new menu
3298 */
3299 public final TMenu addWindowMenu() {
3300 TMenu windowMenu = addMenu(i18n.getString("windowMenuTitle"));
3301 windowMenu.addDefaultItem(TMenu.MID_TILE);
3302 windowMenu.addDefaultItem(TMenu.MID_CASCADE);
3303 windowMenu.addDefaultItem(TMenu.MID_CLOSE_ALL);
3304 windowMenu.addSeparator();
3305 windowMenu.addDefaultItem(TMenu.MID_WINDOW_MOVE);
3306 windowMenu.addDefaultItem(TMenu.MID_WINDOW_ZOOM);
3307 windowMenu.addDefaultItem(TMenu.MID_WINDOW_NEXT);
3308 windowMenu.addDefaultItem(TMenu.MID_WINDOW_PREVIOUS);
3309 windowMenu.addDefaultItem(TMenu.MID_WINDOW_CLOSE);
3310 TStatusBar statusBar = windowMenu.newStatusBar(i18n.
3311 getString("windowMenuStatus"));
3312 statusBar.addShortcutKeypress(kbF1, cmHelp, i18n.getString("Help"));
3313 return windowMenu;
3314 }
3315
3316 /**
3317 * Convenience function to add a default "Help" menu.
3318 *
3319 * @return the new menu
3320 */
3321 public final TMenu addHelpMenu() {
3322 TMenu helpMenu = addMenu(i18n.getString("helpMenuTitle"));
3323 helpMenu.addDefaultItem(TMenu.MID_HELP_CONTENTS);
3324 helpMenu.addDefaultItem(TMenu.MID_HELP_INDEX);
3325 helpMenu.addDefaultItem(TMenu.MID_HELP_SEARCH);
3326 helpMenu.addDefaultItem(TMenu.MID_HELP_PREVIOUS);
3327 helpMenu.addDefaultItem(TMenu.MID_HELP_HELP);
3328 helpMenu.addDefaultItem(TMenu.MID_HELP_ACTIVE_FILE);
3329 helpMenu.addSeparator();
3330 helpMenu.addDefaultItem(TMenu.MID_ABOUT);
3331 TStatusBar statusBar = helpMenu.newStatusBar(i18n.
3332 getString("helpMenuStatus"));
3333 statusBar.addShortcutKeypress(kbF1, cmHelp, i18n.getString("Help"));
3334 return helpMenu;
3335 }
3336
3337 /**
3338 * Convenience function to add a default "Table" menu.
3339 *
3340 * @return the new menu
3341 */
3342 public final TMenu addTableMenu() {
3343 TMenu tableMenu = addMenu(i18n.getString("tableMenuTitle"));
3344 tableMenu.addDefaultItem(TMenu.MID_TABLE_RENAME_COLUMN, false);
3345 tableMenu.addDefaultItem(TMenu.MID_TABLE_RENAME_ROW, false);
3346 tableMenu.addSeparator();
3347
3348 TSubMenu viewMenu = tableMenu.addSubMenu(i18n.
3349 getString("tableSubMenuView"));
3350 viewMenu.addDefaultItem(TMenu.MID_TABLE_VIEW_ROW_LABELS, false);
3351 viewMenu.addDefaultItem(TMenu.MID_TABLE_VIEW_COLUMN_LABELS, false);
3352 viewMenu.addDefaultItem(TMenu.MID_TABLE_VIEW_HIGHLIGHT_ROW, false);
3353 viewMenu.addDefaultItem(TMenu.MID_TABLE_VIEW_HIGHLIGHT_COLUMN, false);
3354
3355 TSubMenu borderMenu = tableMenu.addSubMenu(i18n.
3356 getString("tableSubMenuBorders"));
3357 borderMenu.addDefaultItem(TMenu.MID_TABLE_BORDER_NONE, false);
3358 borderMenu.addDefaultItem(TMenu.MID_TABLE_BORDER_ALL, false);
3359 borderMenu.addDefaultItem(TMenu.MID_TABLE_BORDER_CELL_NONE, false);
3360 borderMenu.addDefaultItem(TMenu.MID_TABLE_BORDER_CELL_ALL, false);
3361 borderMenu.addDefaultItem(TMenu.MID_TABLE_BORDER_RIGHT, false);
3362 borderMenu.addDefaultItem(TMenu.MID_TABLE_BORDER_LEFT, false);
3363 borderMenu.addDefaultItem(TMenu.MID_TABLE_BORDER_TOP, false);
3364 borderMenu.addDefaultItem(TMenu.MID_TABLE_BORDER_BOTTOM, false);
3365 borderMenu.addDefaultItem(TMenu.MID_TABLE_BORDER_DOUBLE_BOTTOM, false);
3366 borderMenu.addDefaultItem(TMenu.MID_TABLE_BORDER_THICK_BOTTOM, false);
3367 TSubMenu deleteMenu = tableMenu.addSubMenu(i18n.
3368 getString("tableSubMenuDelete"));
3369 deleteMenu.addDefaultItem(TMenu.MID_TABLE_DELETE_LEFT, false);
3370 deleteMenu.addDefaultItem(TMenu.MID_TABLE_DELETE_UP, false);
3371 deleteMenu.addDefaultItem(TMenu.MID_TABLE_DELETE_ROW, false);
3372 deleteMenu.addDefaultItem(TMenu.MID_TABLE_DELETE_COLUMN, false);
3373 TSubMenu insertMenu = tableMenu.addSubMenu(i18n.
3374 getString("tableSubMenuInsert"));
3375 insertMenu.addDefaultItem(TMenu.MID_TABLE_INSERT_LEFT, false);
3376 insertMenu.addDefaultItem(TMenu.MID_TABLE_INSERT_RIGHT, false);
3377 insertMenu.addDefaultItem(TMenu.MID_TABLE_INSERT_ABOVE, false);
3378 insertMenu.addDefaultItem(TMenu.MID_TABLE_INSERT_BELOW, false);
3379 TSubMenu columnMenu = tableMenu.addSubMenu(i18n.
3380 getString("tableSubMenuColumn"));
3381 columnMenu.addDefaultItem(TMenu.MID_TABLE_COLUMN_NARROW, false);
3382 columnMenu.addDefaultItem(TMenu.MID_TABLE_COLUMN_WIDEN, false);
3383 TSubMenu fileMenu = tableMenu.addSubMenu(i18n.
3384 getString("tableSubMenuFile"));
3385 fileMenu.addDefaultItem(TMenu.MID_TABLE_FILE_OPEN_CSV, false);
3386 fileMenu.addDefaultItem(TMenu.MID_TABLE_FILE_SAVE_CSV, false);
3387 fileMenu.addDefaultItem(TMenu.MID_TABLE_FILE_SAVE_TEXT, false);
3388
3389 TStatusBar statusBar = tableMenu.newStatusBar(i18n.
3390 getString("tableMenuStatus"));
3391 statusBar.addShortcutKeypress(kbF1, cmHelp, i18n.getString("Help"));
3392 return tableMenu;
3393 }
3394
3395 // ------------------------------------------------------------------------
3396 // TTimer management ------------------------------------------------------
3397 // ------------------------------------------------------------------------
3398
3399 /**
3400 * Get the amount of time I can sleep before missing a Timer tick.
3401 *
3402 * @param timeout = initial (maximum) timeout in millis
3403 * @return number of milliseconds between now and the next timer event
3404 */
3405 private long getSleepTime(final long timeout) {
3406 Date now = new Date();
3407 long nowTime = now.getTime();
3408 long sleepTime = timeout;
3409
3410 synchronized (timers) {
3411 for (TTimer timer: timers) {
3412 long nextTickTime = timer.getNextTick().getTime();
3413 if (nextTickTime < nowTime) {
3414 return 0;
3415 }
3416
3417 long timeDifference = nextTickTime - nowTime;
3418 if (timeDifference < sleepTime) {
3419 sleepTime = timeDifference;
3420 }
3421 }
3422 }
3423
3424 assert (sleepTime >= 0);
3425 assert (sleepTime <= timeout);
3426 return sleepTime;
3427 }
3428
3429 /**
3430 * Convenience function to add a timer.
3431 *
3432 * @param duration number of milliseconds to wait between ticks
3433 * @param recurring if true, re-schedule this timer after every tick
3434 * @param action function to call when button is pressed
3435 * @return the timer
3436 */
3437 public final TTimer addTimer(final long duration, final boolean recurring,
3438 final TAction action) {
3439
3440 TTimer timer = new TTimer(duration, recurring, action);
3441 synchronized (timers) {
3442 timers.add(timer);
3443 }
3444 return timer;
3445 }
3446
3447 /**
3448 * Convenience function to remove a timer.
3449 *
3450 * @param timer timer to remove
3451 */
3452 public final void removeTimer(final TTimer timer) {
3453 synchronized (timers) {
3454 timers.remove(timer);
3455 }
3456 }
3457
3458 // ------------------------------------------------------------------------
3459 // Other TWindow constructors ---------------------------------------------
3460 // ------------------------------------------------------------------------
3461
3462 /**
3463 * Convenience function to spawn a message box.
3464 *
3465 * @param title window title, will be centered along the top border
3466 * @param caption message to display. Use embedded newlines to get a
3467 * multi-line box.
3468 * @return the new message box
3469 */
3470 public final TMessageBox messageBox(final String title,
3471 final String caption) {
3472
3473 return new TMessageBox(this, title, caption, TMessageBox.Type.OK);
3474 }
3475
3476 /**
3477 * Convenience function to spawn a message box.
3478 *
3479 * @param title window title, will be centered along the top border
3480 * @param caption message to display. Use embedded newlines to get a
3481 * multi-line box.
3482 * @param type one of the TMessageBox.Type constants. Default is
3483 * Type.OK.
3484 * @return the new message box
3485 */
3486 public final TMessageBox messageBox(final String title,
3487 final String caption, final TMessageBox.Type type) {
3488
3489 return new TMessageBox(this, title, caption, type);
3490 }
3491
3492 /**
3493 * Convenience function to spawn an input box.
3494 *
3495 * @param title window title, will be centered along the top border
3496 * @param caption message to display. Use embedded newlines to get a
3497 * multi-line box.
3498 * @return the new input box
3499 */
3500 public final TInputBox inputBox(final String title, final String caption) {
3501
3502 return new TInputBox(this, title, caption);
3503 }
3504
3505 /**
3506 * Convenience function to spawn an input box.
3507 *
3508 * @param title window title, will be centered along the top border
3509 * @param caption message to display. Use embedded newlines to get a
3510 * multi-line box.
3511 * @param text initial text to seed the field with
3512 * @return the new input box
3513 */
3514 public final TInputBox inputBox(final String title, final String caption,
3515 final String text) {
3516
3517 return new TInputBox(this, title, caption, text);
3518 }
3519
3520 /**
3521 * Convenience function to spawn an input box.
3522 *
3523 * @param title window title, will be centered along the top border
3524 * @param caption message to display. Use embedded newlines to get a
3525 * multi-line box.
3526 * @param text initial text to seed the field with
3527 * @param type one of the Type constants. Default is Type.OK.
3528 * @return the new input box
3529 */
3530 public final TInputBox inputBox(final String title, final String caption,
3531 final String text, final TInputBox.Type type) {
3532
3533 return new TInputBox(this, title, caption, text, type);
3534 }
3535
3536 /**
3537 * Convenience function to open a terminal window.
3538 *
3539 * @param x column relative to parent
3540 * @param y row relative to parent
3541 * @return the terminal new window
3542 */
3543 public final TTerminalWindow openTerminal(final int x, final int y) {
3544 return openTerminal(x, y, TWindow.RESIZABLE);
3545 }
3546
3547 /**
3548 * Convenience function to open a terminal window.
3549 *
3550 * @param x column relative to parent
3551 * @param y row relative to parent
3552 * @param closeOnExit if true, close the window when the command exits
3553 * @return the terminal new window
3554 */
3555 public final TTerminalWindow openTerminal(final int x, final int y,
3556 final boolean closeOnExit) {
3557
3558 return openTerminal(x, y, TWindow.RESIZABLE, closeOnExit);
3559 }
3560
3561 /**
3562 * Convenience function to open a terminal window.
3563 *
3564 * @param x column relative to parent
3565 * @param y row relative to parent
3566 * @param flags mask of CENTERED, MODAL, or RESIZABLE
3567 * @return the terminal new window
3568 */
3569 public final TTerminalWindow openTerminal(final int x, final int y,
3570 final int flags) {
3571
3572 return new TTerminalWindow(this, x, y, flags);
3573 }
3574
3575 /**
3576 * Convenience function to open a terminal window.
3577 *
3578 * @param x column relative to parent
3579 * @param y row relative to parent
3580 * @param flags mask of CENTERED, MODAL, or RESIZABLE
3581 * @param closeOnExit if true, close the window when the command exits
3582 * @return the terminal new window
3583 */
3584 public final TTerminalWindow openTerminal(final int x, final int y,
3585 final int flags, final boolean closeOnExit) {
3586
3587 return new TTerminalWindow(this, x, y, flags, closeOnExit);
3588 }
3589
3590 /**
3591 * Convenience function to open a terminal window and execute a custom
3592 * command line inside it.
3593 *
3594 * @param x column relative to parent
3595 * @param y row relative to parent
3596 * @param commandLine the command line to execute
3597 * @return the terminal new window
3598 */
3599 public final TTerminalWindow openTerminal(final int x, final int y,
3600 final String commandLine) {
3601
3602 return openTerminal(x, y, TWindow.RESIZABLE, commandLine);
3603 }
3604
3605 /**
3606 * Convenience function to open a terminal window and execute a custom
3607 * command line inside it.
3608 *
3609 * @param x column relative to parent
3610 * @param y row relative to parent
3611 * @param commandLine the command line to execute
3612 * @param closeOnExit if true, close the window when the command exits
3613 * @return the terminal new window
3614 */
3615 public final TTerminalWindow openTerminal(final int x, final int y,
3616 final String commandLine, final boolean closeOnExit) {
3617
3618 return openTerminal(x, y, TWindow.RESIZABLE, commandLine, closeOnExit);
3619 }
3620
3621 /**
3622 * Convenience function to open a terminal window and execute a custom
3623 * command line inside it.
3624 *
3625 * @param x column relative to parent
3626 * @param y row relative to parent
3627 * @param flags mask of CENTERED, MODAL, or RESIZABLE
3628 * @param command the command line to execute
3629 * @return the terminal new window
3630 */
3631 public final TTerminalWindow openTerminal(final int x, final int y,
3632 final int flags, final String [] command) {
3633
3634 return new TTerminalWindow(this, x, y, flags, command);
3635 }
3636
3637 /**
3638 * Convenience function to open a terminal window and execute a custom
3639 * command line inside it.
3640 *
3641 * @param x column relative to parent
3642 * @param y row relative to parent
3643 * @param flags mask of CENTERED, MODAL, or RESIZABLE
3644 * @param command the command line to execute
3645 * @param closeOnExit if true, close the window when the command exits
3646 * @return the terminal new window
3647 */
3648 public final TTerminalWindow openTerminal(final int x, final int y,
3649 final int flags, final String [] command, final boolean closeOnExit) {
3650
3651 return new TTerminalWindow(this, x, y, flags, command, closeOnExit);
3652 }
3653
3654 /**
3655 * Convenience function to open a terminal window and execute a custom
3656 * command line inside it.
3657 *
3658 * @param x column relative to parent
3659 * @param y row relative to parent
3660 * @param flags mask of CENTERED, MODAL, or RESIZABLE
3661 * @param commandLine the command line to execute
3662 * @return the terminal new window
3663 */
3664 public final TTerminalWindow openTerminal(final int x, final int y,
3665 final int flags, final String commandLine) {
3666
3667 return new TTerminalWindow(this, x, y, flags, commandLine.split("\\s+"));
3668 }
3669
3670 /**
3671 * Convenience function to open a terminal window and execute a custom
3672 * command line inside it.
3673 *
3674 * @param x column relative to parent
3675 * @param y row relative to parent
3676 * @param flags mask of CENTERED, MODAL, or RESIZABLE
3677 * @param commandLine the command line to execute
3678 * @param closeOnExit if true, close the window when the command exits
3679 * @return the terminal new window
3680 */
3681 public final TTerminalWindow openTerminal(final int x, final int y,
3682 final int flags, final String commandLine, final boolean closeOnExit) {
3683
3684 return new TTerminalWindow(this, x, y, flags, commandLine.split("\\s+"),
3685 closeOnExit);
3686 }
3687
3688 /**
3689 * Convenience function to spawn an file open box.
3690 *
3691 * @param path path of selected file
3692 * @return the result of the new file open box
3693 * @throws IOException if java.io operation throws
3694 */
3695 public final String fileOpenBox(final String path) throws IOException {
3696
3697 TFileOpenBox box = new TFileOpenBox(this, path, TFileOpenBox.Type.OPEN);
3698 return box.getFilename();
3699 }
3700
3701 /**
3702 * Convenience function to spawn an file open box.
3703 *
3704 * @param path path of selected file
3705 * @param type one of the Type constants
3706 * @return the result of the new file open box
3707 * @throws IOException if java.io operation throws
3708 */
3709 public final String fileOpenBox(final String path,
3710 final TFileOpenBox.Type type) throws IOException {
3711
3712 TFileOpenBox box = new TFileOpenBox(this, path, type);
3713 return box.getFilename();
3714 }
3715
3716 /**
3717 * Convenience function to spawn a file open box.
3718 *
3719 * @param path path of selected file
3720 * @param type one of the Type constants
3721 * @param filter a string that files must match to be displayed
3722 * @return the result of the new file open box
3723 * @throws IOException of a java.io operation throws
3724 */
3725 public final String fileOpenBox(final String path,
3726 final TFileOpenBox.Type type, final String filter) throws IOException {
3727
3728 ArrayList<String> filters = new ArrayList<String>();
3729 filters.add(filter);
3730
3731 TFileOpenBox box = new TFileOpenBox(this, path, type, filters);
3732 return box.getFilename();
3733 }
3734
3735 /**
3736 * Convenience function to spawn a file open box.
3737 *
3738 * @param path path of selected file
3739 * @param type one of the Type constants
3740 * @param filters a list of strings that files must match to be displayed
3741 * @return the result of the new file open box
3742 * @throws IOException of a java.io operation throws
3743 */
3744 public final String fileOpenBox(final String path,
3745 final TFileOpenBox.Type type,
3746 final List<String> filters) throws IOException {
3747
3748 TFileOpenBox box = new TFileOpenBox(this, path, type, filters);
3749 return box.getFilename();
3750 }
3751
3752 /**
3753 * Convenience function to create a new window and make it active.
3754 * Window will be located at (0, 0).
3755 *
3756 * @param title window title, will be centered along the top border
3757 * @param width width of window
3758 * @param height height of window
3759 * @return the new window
3760 */
3761 public final TWindow addWindow(final String title, final int width,
3762 final int height) {
3763
3764 TWindow window = new TWindow(this, title, 0, 0, width, height);
3765 return window;
3766 }
3767
3768 /**
3769 * Convenience function to create a new window and make it active.
3770 * Window will be located at (0, 0).
3771 *
3772 * @param title window title, will be centered along the top border
3773 * @param width width of window
3774 * @param height height of window
3775 * @param flags bitmask of RESIZABLE, CENTERED, or MODAL
3776 * @return the new window
3777 */
3778 public final TWindow addWindow(final String title,
3779 final int width, final int height, final int flags) {
3780
3781 TWindow window = new TWindow(this, title, 0, 0, width, height, flags);
3782 return window;
3783 }
3784
3785 /**
3786 * Convenience function to create a new window and make it active.
3787 *
3788 * @param title window title, will be centered along the top border
3789 * @param x column relative to parent
3790 * @param y row relative to parent
3791 * @param width width of window
3792 * @param height height of window
3793 * @return the new window
3794 */
3795 public final TWindow addWindow(final String title,
3796 final int x, final int y, final int width, final int height) {
3797
3798 TWindow window = new TWindow(this, title, x, y, width, height);
3799 return window;
3800 }
3801
3802 /**
3803 * Convenience function to create a new window and make it active.
3804 *
3805 * @param title window title, will be centered along the top border
3806 * @param x column relative to parent
3807 * @param y row relative to parent
3808 * @param width width of window
3809 * @param height height of window
3810 * @param flags mask of RESIZABLE, CENTERED, or MODAL
3811 * @return the new window
3812 */
3813 public final TWindow addWindow(final String title,
3814 final int x, final int y, final int width, final int height,
3815 final int flags) {
3816
3817 TWindow window = new TWindow(this, title, x, y, width, height, flags);
3818 return window;
3819 }
3820
3821 }