Add 'src/jexer/' from commit 'cf01c92f5809a0732409e280fb0f32f27393618d'
[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 activeWindow.setActive(false);
2206
2207 // Increment every window Z that is on top of window
2208 for (TWindow w: windows) {
2209 if (w == window) {
2210 continue;
2211 }
2212 if (w.getZ() < window.getZ()) {
2213 w.setZ(w.getZ() + 1);
2214 }
2215 }
2216
2217 // Unset activeWindow now before unfocus, so that a window
2218 // lifecycle change inside onUnfocus() doesn't call
2219 // switchWindow() and lead to a stack overflow.
2220 TWindow oldActiveWindow = activeWindow;
2221 activeWindow = null;
2222 oldActiveWindow.onUnfocus();
2223 }
2224 activeWindow = window;
2225 activeWindow.setZ(0);
2226 activeWindow.setActive(true);
2227 activeWindow.onFocus();
2228 return;
2229 }
2230
2231 /**
2232 * Hide a window.
2233 *
2234 * @param window the window to hide
2235 */
2236 public void hideWindow(final TWindow window) {
2237 if (hasWindow(window) == false) {
2238 /*
2239 * Someone has a handle to a window I don't have. Ignore this
2240 * request.
2241 */
2242 return;
2243 }
2244
2245 // Whatever window might be moving/dragging, stop it now.
2246 for (TWindow w: windows) {
2247 if (w.inMovements()) {
2248 w.stopMovements();
2249 }
2250 }
2251
2252 assert (windows.size() > 0);
2253
2254 if (!window.hidden) {
2255 if (window == activeWindow) {
2256 if (shownWindowCount() > 1) {
2257 switchWindow(true);
2258 } else {
2259 activeWindow = null;
2260 window.setActive(false);
2261 window.onUnfocus();
2262 }
2263 }
2264 window.hidden = true;
2265 window.onHide();
2266 }
2267 }
2268
2269 /**
2270 * Show a window.
2271 *
2272 * @param window the window to show
2273 */
2274 public void showWindow(final TWindow window) {
2275 if (hasWindow(window) == false) {
2276 /*
2277 * Someone has a handle to a window I don't have. Ignore this
2278 * request.
2279 */
2280 return;
2281 }
2282
2283 // Whatever window might be moving/dragging, stop it now.
2284 for (TWindow w: windows) {
2285 if (w.inMovements()) {
2286 w.stopMovements();
2287 }
2288 }
2289
2290 assert (windows.size() > 0);
2291
2292 if (window.hidden) {
2293 window.hidden = false;
2294 window.onShow();
2295 activateWindow(window);
2296 }
2297 }
2298
2299 /**
2300 * Close window. Note that the window's destructor is NOT called by this
2301 * method, instead the GC is assumed to do the cleanup.
2302 *
2303 * @param window the window to remove
2304 */
2305 public final void closeWindow(final TWindow window) {
2306 if (hasWindow(window) == false) {
2307 /*
2308 * Someone has a handle to a window I don't have. Ignore this
2309 * request.
2310 */
2311 return;
2312 }
2313
2314 // Let window know that it is about to be closed, while it is still
2315 // visible on screen.
2316 window.onPreClose();
2317
2318 synchronized (windows) {
2319 // Whatever window might be moving/dragging, stop it now.
2320 for (TWindow w: windows) {
2321 if (w.inMovements()) {
2322 w.stopMovements();
2323 }
2324 }
2325
2326 int z = window.getZ();
2327 window.setZ(-1);
2328 window.onUnfocus();
2329 windows.remove(window);
2330 Collections.sort(windows);
2331 activeWindow = null;
2332 int newZ = 0;
2333 boolean foundNextWindow = false;
2334
2335 for (TWindow w: windows) {
2336 w.setZ(newZ);
2337 newZ++;
2338
2339 // Do not activate a hidden window.
2340 if (w.isHidden()) {
2341 continue;
2342 }
2343
2344 if (foundNextWindow == false) {
2345 foundNextWindow = true;
2346 w.setActive(true);
2347 w.onFocus();
2348 assert (activeWindow == null);
2349 activeWindow = w;
2350 continue;
2351 }
2352
2353 if (w.isActive()) {
2354 w.setActive(false);
2355 w.onUnfocus();
2356 }
2357 }
2358 }
2359
2360 // Perform window cleanup
2361 window.onClose();
2362
2363 // Check if we are closing a TMessageBox or similar
2364 if (secondaryEventReceiver != null) {
2365 assert (secondaryEventHandler != null);
2366
2367 // Do not send events to the secondaryEventReceiver anymore, the
2368 // window is closed.
2369 secondaryEventReceiver = null;
2370
2371 // Wake the secondary thread, it will wake the primary as it
2372 // exits.
2373 synchronized (secondaryEventHandler) {
2374 secondaryEventHandler.notify();
2375 }
2376 }
2377
2378 // Permit desktop to be active if it is the only thing left.
2379 if (desktop != null) {
2380 if (windows.size() == 0) {
2381 desktop.setActive(true);
2382 }
2383 }
2384 }
2385
2386 /**
2387 * Switch to the next window.
2388 *
2389 * @param forward if true, then switch to the next window in the list,
2390 * otherwise switch to the previous window in the list
2391 */
2392 public final void switchWindow(final boolean forward) {
2393 // Only switch if there are multiple visible windows
2394 if (shownWindowCount() < 2) {
2395 return;
2396 }
2397 assert (activeWindow != null);
2398
2399 synchronized (windows) {
2400 // Whatever window might be moving/dragging, stop it now.
2401 for (TWindow w: windows) {
2402 if (w.inMovements()) {
2403 w.stopMovements();
2404 }
2405 }
2406
2407 // Swap z/active between active window and the next in the list
2408 int activeWindowI = -1;
2409 for (int i = 0; i < windows.size(); i++) {
2410 if (windows.get(i) == activeWindow) {
2411 assert (activeWindow.isActive());
2412 activeWindowI = i;
2413 break;
2414 } else {
2415 assert (!windows.get(0).isActive());
2416 }
2417 }
2418 assert (activeWindowI >= 0);
2419
2420 // Do not switch if a window is modal
2421 if (activeWindow.isModal()) {
2422 return;
2423 }
2424
2425 int nextWindowI = activeWindowI;
2426 for (;;) {
2427 if (forward) {
2428 nextWindowI++;
2429 nextWindowI %= windows.size();
2430 } else {
2431 nextWindowI--;
2432 if (nextWindowI < 0) {
2433 nextWindowI = windows.size() - 1;
2434 }
2435 }
2436
2437 if (windows.get(nextWindowI).isShown()) {
2438 activateWindow(windows.get(nextWindowI));
2439 break;
2440 }
2441 }
2442 } // synchronized (windows)
2443
2444 }
2445
2446 /**
2447 * Add a window to my window list and make it active. Note package
2448 * private access.
2449 *
2450 * @param window new window to add
2451 */
2452 final void addWindowToApplication(final TWindow window) {
2453
2454 // Do not add menu windows to the window list.
2455 if (window instanceof TMenu) {
2456 return;
2457 }
2458
2459 // Do not add the desktop to the window list.
2460 if (window instanceof TDesktop) {
2461 return;
2462 }
2463
2464 synchronized (windows) {
2465 if (windows.contains(window)) {
2466 throw new IllegalArgumentException("Window " + window +
2467 " is already in window list");
2468 }
2469
2470 // Whatever window might be moving/dragging, stop it now.
2471 for (TWindow w: windows) {
2472 if (w.inMovements()) {
2473 w.stopMovements();
2474 }
2475 }
2476
2477 // Do not allow a modal window to spawn a non-modal window. If a
2478 // modal window is active, then this window will become modal
2479 // too.
2480 if (modalWindowActive()) {
2481 window.flags |= TWindow.MODAL;
2482 window.flags |= TWindow.CENTERED;
2483 window.hidden = false;
2484 }
2485 if (window.isShown()) {
2486 for (TWindow w: windows) {
2487 if (w.isActive()) {
2488 w.setActive(false);
2489 w.onUnfocus();
2490 }
2491 w.setZ(w.getZ() + 1);
2492 }
2493 }
2494 windows.add(window);
2495 if (window.isShown()) {
2496 activeWindow = window;
2497 activeWindow.setZ(0);
2498 activeWindow.setActive(true);
2499 activeWindow.onFocus();
2500 }
2501
2502 if (((window.flags & TWindow.CENTERED) == 0)
2503 && ((window.flags & TWindow.ABSOLUTEXY) == 0)
2504 && (smartWindowPlacement == true)
2505 && (!(window instanceof TDesktop))
2506 ) {
2507
2508 doSmartPlacement(window);
2509 }
2510 }
2511
2512 // Desktop cannot be active over any other window.
2513 if (desktop != null) {
2514 desktop.setActive(false);
2515 }
2516 }
2517
2518 /**
2519 * Check if there is a system-modal window on top.
2520 *
2521 * @return true if the active window is modal
2522 */
2523 private boolean modalWindowActive() {
2524 if (windows.size() == 0) {
2525 return false;
2526 }
2527
2528 for (TWindow w: windows) {
2529 if (w.isModal()) {
2530 return true;
2531 }
2532 }
2533
2534 return false;
2535 }
2536
2537 /**
2538 * Check if there is a window with overridden menu flag on top.
2539 *
2540 * @return true if the active window is overriding the menu
2541 */
2542 private boolean overrideMenuWindowActive() {
2543 if (activeWindow != null) {
2544 if (activeWindow.hasOverriddenMenu()) {
2545 return true;
2546 }
2547 }
2548
2549 return false;
2550 }
2551
2552 /**
2553 * Close all open windows.
2554 */
2555 private void closeAllWindows() {
2556 // Don't do anything if we are in the menu
2557 if (activeMenu != null) {
2558 return;
2559 }
2560 while (windows.size() > 0) {
2561 closeWindow(windows.get(0));
2562 }
2563 }
2564
2565 /**
2566 * Re-layout the open windows as non-overlapping tiles. This produces
2567 * almost the same results as Turbo Pascal 7.0's IDE.
2568 */
2569 private void tileWindows() {
2570 synchronized (windows) {
2571 // Don't do anything if we are in the menu
2572 if (activeMenu != null) {
2573 return;
2574 }
2575 int z = windows.size();
2576 if (z == 0) {
2577 return;
2578 }
2579 int a = 0;
2580 int b = 0;
2581 a = (int)(Math.sqrt(z));
2582 int c = 0;
2583 while (c < a) {
2584 b = (z - c) / a;
2585 if (((a * b) + c) == z) {
2586 break;
2587 }
2588 c++;
2589 }
2590 assert (a > 0);
2591 assert (b > 0);
2592 assert (c < a);
2593 int newWidth = (getScreen().getWidth() / a);
2594 int newHeight1 = ((getScreen().getHeight() - 1) / b);
2595 int newHeight2 = ((getScreen().getHeight() - 1) / (b + c));
2596
2597 List<TWindow> sorted = new ArrayList<TWindow>(windows);
2598 Collections.sort(sorted);
2599 Collections.reverse(sorted);
2600 for (int i = 0; i < sorted.size(); i++) {
2601 int logicalX = i / b;
2602 int logicalY = i % b;
2603 if (i >= ((a - 1) * b)) {
2604 logicalX = a - 1;
2605 logicalY = i - ((a - 1) * b);
2606 }
2607
2608 TWindow w = sorted.get(i);
2609 int oldWidth = w.getWidth();
2610 int oldHeight = w.getHeight();
2611
2612 w.setX(logicalX * newWidth);
2613 w.setWidth(newWidth);
2614 if (i >= ((a - 1) * b)) {
2615 w.setY((logicalY * newHeight2) + 1);
2616 w.setHeight(newHeight2);
2617 } else {
2618 w.setY((logicalY * newHeight1) + 1);
2619 w.setHeight(newHeight1);
2620 }
2621 if ((w.getWidth() != oldWidth)
2622 || (w.getHeight() != oldHeight)
2623 ) {
2624 w.onResize(new TResizeEvent(TResizeEvent.Type.WIDGET,
2625 w.getWidth(), w.getHeight()));
2626 }
2627 }
2628 }
2629 }
2630
2631 /**
2632 * Re-layout the open windows as overlapping cascaded windows.
2633 */
2634 private void cascadeWindows() {
2635 synchronized (windows) {
2636 // Don't do anything if we are in the menu
2637 if (activeMenu != null) {
2638 return;
2639 }
2640 int x = 0;
2641 int y = 1;
2642 List<TWindow> sorted = new ArrayList<TWindow>(windows);
2643 Collections.sort(sorted);
2644 Collections.reverse(sorted);
2645 for (TWindow window: sorted) {
2646 window.setX(x);
2647 window.setY(y);
2648 x++;
2649 y++;
2650 if (x > getScreen().getWidth()) {
2651 x = 0;
2652 }
2653 if (y >= getScreen().getHeight()) {
2654 y = 1;
2655 }
2656 }
2657 }
2658 }
2659
2660 /**
2661 * Place a window to minimize its overlap with other windows.
2662 *
2663 * @param window the window to place
2664 */
2665 public final void doSmartPlacement(final TWindow window) {
2666 // This is a pretty dumb algorithm, but seems to work. The hardest
2667 // part is computing these "overlap" values seeking a minimum average
2668 // overlap.
2669 int xMin = 0;
2670 int yMin = desktopTop;
2671 int xMax = getScreen().getWidth() - window.getWidth() + 1;
2672 int yMax = desktopBottom - window.getHeight() + 1;
2673 if (xMax < xMin) {
2674 xMax = xMin;
2675 }
2676 if (yMax < yMin) {
2677 yMax = yMin;
2678 }
2679
2680 if ((xMin == xMax) && (yMin == yMax)) {
2681 // No work to do, bail out.
2682 return;
2683 }
2684
2685 // Compute the overlap matrix without the new window.
2686 int width = getScreen().getWidth();
2687 int height = getScreen().getHeight();
2688 int overlapMatrix[][] = new int[width][height];
2689 for (TWindow w: windows) {
2690 if (window == w) {
2691 continue;
2692 }
2693 for (int x = w.getX(); x < w.getX() + w.getWidth(); x++) {
2694 if (x < 0) {
2695 continue;
2696 }
2697 if (x >= width) {
2698 continue;
2699 }
2700 for (int y = w.getY(); y < w.getY() + w.getHeight(); y++) {
2701 if (y < 0) {
2702 continue;
2703 }
2704 if (y >= height) {
2705 continue;
2706 }
2707 overlapMatrix[x][y]++;
2708 }
2709 }
2710 }
2711
2712 long oldOverlapTotal = 0;
2713 long oldOverlapN = 0;
2714 for (int x = 0; x < width; x++) {
2715 for (int y = 0; y < height; y++) {
2716 oldOverlapTotal += overlapMatrix[x][y];
2717 if (overlapMatrix[x][y] > 0) {
2718 oldOverlapN++;
2719 }
2720 }
2721 }
2722
2723
2724 double oldOverlapAvg = (double) oldOverlapTotal / (double) oldOverlapN;
2725 boolean first = true;
2726 int windowX = window.getX();
2727 int windowY = window.getY();
2728
2729 // For each possible (x, y) position for the new window, compute a
2730 // new overlap matrix.
2731 for (int x = xMin; x < xMax; x++) {
2732 for (int y = yMin; y < yMax; y++) {
2733
2734 // Start with the matrix minus this window.
2735 int newMatrix[][] = new int[width][height];
2736 for (int mx = 0; mx < width; mx++) {
2737 for (int my = 0; my < height; my++) {
2738 newMatrix[mx][my] = overlapMatrix[mx][my];
2739 }
2740 }
2741
2742 // Add this window's values to the new overlap matrix.
2743 long newOverlapTotal = 0;
2744 long newOverlapN = 0;
2745 // Start by adding each new cell.
2746 for (int wx = x; wx < x + window.getWidth(); wx++) {
2747 if (wx >= width) {
2748 continue;
2749 }
2750 for (int wy = y; wy < y + window.getHeight(); wy++) {
2751 if (wy >= height) {
2752 continue;
2753 }
2754 newMatrix[wx][wy]++;
2755 }
2756 }
2757 // Now figure out the new value for total coverage.
2758 for (int mx = 0; mx < width; mx++) {
2759 for (int my = 0; my < height; my++) {
2760 newOverlapTotal += newMatrix[x][y];
2761 if (newMatrix[mx][my] > 0) {
2762 newOverlapN++;
2763 }
2764 }
2765 }
2766 double newOverlapAvg = (double) newOverlapTotal / (double) newOverlapN;
2767
2768 if (first) {
2769 // First time: just record what we got.
2770 oldOverlapAvg = newOverlapAvg;
2771 first = false;
2772 } else {
2773 // All other times: pick a new best (x, y) and save the
2774 // overlap value.
2775 if (newOverlapAvg < oldOverlapAvg) {
2776 windowX = x;
2777 windowY = y;
2778 oldOverlapAvg = newOverlapAvg;
2779 }
2780 }
2781
2782 } // for (int x = xMin; x < xMax; x++)
2783
2784 } // for (int y = yMin; y < yMax; y++)
2785
2786 // Finally, set the window's new coordinates.
2787 window.setX(windowX);
2788 window.setY(windowY);
2789 }
2790
2791 // ------------------------------------------------------------------------
2792 // TMenu management -------------------------------------------------------
2793 // ------------------------------------------------------------------------
2794
2795 /**
2796 * Check if a mouse event would hit either the active menu or any open
2797 * sub-menus.
2798 *
2799 * @param mouse mouse event
2800 * @return true if the mouse would hit the active menu or an open
2801 * sub-menu
2802 */
2803 private boolean mouseOnMenu(final TMouseEvent mouse) {
2804 assert (activeMenu != null);
2805 List<TMenu> menus = new ArrayList<TMenu>(subMenus);
2806 Collections.reverse(menus);
2807 for (TMenu menu: menus) {
2808 if (menu.mouseWouldHit(mouse)) {
2809 return true;
2810 }
2811 }
2812 return activeMenu.mouseWouldHit(mouse);
2813 }
2814
2815 /**
2816 * See if we need to switch window or activate the menu based on
2817 * a mouse click.
2818 *
2819 * @param mouse mouse event
2820 */
2821 private void checkSwitchFocus(final TMouseEvent mouse) {
2822
2823 if ((mouse.getType() == TMouseEvent.Type.MOUSE_DOWN)
2824 && (activeMenu != null)
2825 && (mouse.getAbsoluteY() != 0)
2826 && (!mouseOnMenu(mouse))
2827 ) {
2828 // They clicked outside the active menu, turn it off
2829 activeMenu.setActive(false);
2830 activeMenu = null;
2831 for (TMenu menu: subMenus) {
2832 menu.setActive(false);
2833 }
2834 subMenus.clear();
2835 // Continue checks
2836 }
2837
2838 // See if they hit the menu bar
2839 if ((mouse.getType() == TMouseEvent.Type.MOUSE_DOWN)
2840 && (mouse.isMouse1())
2841 && (!modalWindowActive())
2842 && (!overrideMenuWindowActive())
2843 && (mouse.getAbsoluteY() == 0)
2844 && (hideMenuBar == false)
2845 ) {
2846
2847 for (TMenu menu: subMenus) {
2848 menu.setActive(false);
2849 }
2850 subMenus.clear();
2851
2852 // They selected the menu, go activate it
2853 for (TMenu menu: menus) {
2854 if ((mouse.getAbsoluteX() >= menu.getTitleX())
2855 && (mouse.getAbsoluteX() < menu.getTitleX()
2856 + StringUtils.width(menu.getTitle()) + 2)
2857 ) {
2858 menu.setActive(true);
2859 activeMenu = menu;
2860 } else {
2861 menu.setActive(false);
2862 }
2863 }
2864 return;
2865 }
2866
2867 // See if they hit the menu bar
2868 if ((mouse.getType() == TMouseEvent.Type.MOUSE_MOTION)
2869 && (mouse.isMouse1())
2870 && (activeMenu != null)
2871 && (mouse.getAbsoluteY() == 0)
2872 && (hideMenuBar == false)
2873 ) {
2874
2875 TMenu oldMenu = activeMenu;
2876 for (TMenu menu: subMenus) {
2877 menu.setActive(false);
2878 }
2879 subMenus.clear();
2880
2881 // See if we should switch menus
2882 for (TMenu menu: menus) {
2883 if ((mouse.getAbsoluteX() >= menu.getTitleX())
2884 && (mouse.getAbsoluteX() < menu.getTitleX()
2885 + StringUtils.width(menu.getTitle()) + 2)
2886 ) {
2887 menu.setActive(true);
2888 activeMenu = menu;
2889 }
2890 }
2891 if (oldMenu != activeMenu) {
2892 // They switched menus
2893 oldMenu.setActive(false);
2894 }
2895 return;
2896 }
2897
2898 // If a menu is still active, don't switch windows
2899 if (activeMenu != null) {
2900 return;
2901 }
2902
2903 // Only switch if there are multiple windows
2904 if (windows.size() < 2) {
2905 return;
2906 }
2907
2908 if (((focusFollowsMouse == true)
2909 && (mouse.getType() == TMouseEvent.Type.MOUSE_MOTION))
2910 || (mouse.getType() == TMouseEvent.Type.MOUSE_DOWN)
2911 ) {
2912 synchronized (windows) {
2913 Collections.sort(windows);
2914 if (windows.get(0).isModal()) {
2915 // Modal windows don't switch
2916 return;
2917 }
2918
2919 for (TWindow window: windows) {
2920 assert (!window.isModal());
2921
2922 if (window.isHidden()) {
2923 assert (!window.isActive());
2924 continue;
2925 }
2926
2927 if (window.mouseWouldHit(mouse)) {
2928 if (window == windows.get(0)) {
2929 // Clicked on the same window, nothing to do
2930 assert (window.isActive());
2931 return;
2932 }
2933
2934 // We will be switching to another window
2935 assert (windows.get(0).isActive());
2936 assert (windows.get(0) == activeWindow);
2937 assert (!window.isActive());
2938 if (activeWindow != null) {
2939 activeWindow.onUnfocus();
2940 activeWindow.setActive(false);
2941 activeWindow.setZ(window.getZ());
2942 }
2943 activeWindow = window;
2944 window.setZ(0);
2945 window.setActive(true);
2946 window.onFocus();
2947 return;
2948 }
2949 }
2950 }
2951
2952 // Clicked on the background, nothing to do
2953 return;
2954 }
2955
2956 // Nothing to do: this isn't a mouse up, or focus isn't following
2957 // mouse.
2958 return;
2959 }
2960
2961 /**
2962 * Turn off the menu.
2963 */
2964 public final void closeMenu() {
2965 if (activeMenu != null) {
2966 activeMenu.setActive(false);
2967 activeMenu = null;
2968 for (TMenu menu: subMenus) {
2969 menu.setActive(false);
2970 }
2971 subMenus.clear();
2972 }
2973 }
2974
2975 /**
2976 * Get a (shallow) copy of the menu list.
2977 *
2978 * @return a copy of the menu list
2979 */
2980 public final List<TMenu> getAllMenus() {
2981 return new ArrayList<TMenu>(menus);
2982 }
2983
2984 /**
2985 * Add a top-level menu to the list.
2986 *
2987 * @param menu the menu to add
2988 * @throws IllegalArgumentException if the menu is already used in
2989 * another TApplication
2990 */
2991 public final void addMenu(final TMenu menu) {
2992 if ((menu.getApplication() != null)
2993 && (menu.getApplication() != this)
2994 ) {
2995 throw new IllegalArgumentException("Menu " + menu + " is already " +
2996 "part of application " + menu.getApplication());
2997 }
2998 closeMenu();
2999 menus.add(menu);
3000 recomputeMenuX();
3001 }
3002
3003 /**
3004 * Remove a top-level menu from the list.
3005 *
3006 * @param menu the menu to remove
3007 * @throws IllegalArgumentException if the menu is already used in
3008 * another TApplication
3009 */
3010 public final void removeMenu(final TMenu menu) {
3011 if ((menu.getApplication() != null)
3012 && (menu.getApplication() != this)
3013 ) {
3014 throw new IllegalArgumentException("Menu " + menu + " is already " +
3015 "part of application " + menu.getApplication());
3016 }
3017 closeMenu();
3018 menus.remove(menu);
3019 recomputeMenuX();
3020 }
3021
3022 /**
3023 * Turn off a sub-menu.
3024 */
3025 public final void closeSubMenu() {
3026 assert (activeMenu != null);
3027 TMenu item = subMenus.get(subMenus.size() - 1);
3028 assert (item != null);
3029 item.setActive(false);
3030 subMenus.remove(subMenus.size() - 1);
3031 }
3032
3033 /**
3034 * Switch to the next menu.
3035 *
3036 * @param forward if true, then switch to the next menu in the list,
3037 * otherwise switch to the previous menu in the list
3038 */
3039 public final void switchMenu(final boolean forward) {
3040 assert (activeMenu != null);
3041 assert (hideMenuBar == false);
3042
3043 for (TMenu menu: subMenus) {
3044 menu.setActive(false);
3045 }
3046 subMenus.clear();
3047
3048 for (int i = 0; i < menus.size(); i++) {
3049 if (activeMenu == menus.get(i)) {
3050 if (forward) {
3051 if (i < menus.size() - 1) {
3052 i++;
3053 } else {
3054 i = 0;
3055 }
3056 } else {
3057 if (i > 0) {
3058 i--;
3059 } else {
3060 i = menus.size() - 1;
3061 }
3062 }
3063 activeMenu.setActive(false);
3064 activeMenu = menus.get(i);
3065 activeMenu.setActive(true);
3066 return;
3067 }
3068 }
3069 }
3070
3071 /**
3072 * Add a menu item to the global list. If it has a keyboard accelerator,
3073 * that will be added the global hash.
3074 *
3075 * @param item the menu item
3076 */
3077 public final void addMenuItem(final TMenuItem item) {
3078 menuItems.add(item);
3079
3080 TKeypress key = item.getKey();
3081 if (key != null) {
3082 synchronized (accelerators) {
3083 assert (accelerators.get(key) == null);
3084 accelerators.put(key.toLowerCase(), item);
3085 }
3086 }
3087 }
3088
3089 /**
3090 * Disable one menu item.
3091 *
3092 * @param id the menu item ID
3093 */
3094 public final void disableMenuItem(final int id) {
3095 for (TMenuItem item: menuItems) {
3096 if (item.getId() == id) {
3097 item.setEnabled(false);
3098 }
3099 }
3100 }
3101
3102 /**
3103 * Disable the range of menu items with ID's between lower and upper,
3104 * inclusive.
3105 *
3106 * @param lower the lowest menu item ID
3107 * @param upper the highest menu item ID
3108 */
3109 public final void disableMenuItems(final int lower, final int upper) {
3110 for (TMenuItem item: menuItems) {
3111 if ((item.getId() >= lower) && (item.getId() <= upper)) {
3112 item.setEnabled(false);
3113 item.getParent().activate(0);
3114 }
3115 }
3116 }
3117
3118 /**
3119 * Enable one menu item.
3120 *
3121 * @param id the menu item ID
3122 */
3123 public final void enableMenuItem(final int id) {
3124 for (TMenuItem item: menuItems) {
3125 if (item.getId() == id) {
3126 item.setEnabled(true);
3127 item.getParent().activate(0);
3128 }
3129 }
3130 }
3131
3132 /**
3133 * Enable the range of menu items with ID's between lower and upper,
3134 * inclusive.
3135 *
3136 * @param lower the lowest menu item ID
3137 * @param upper the highest menu item ID
3138 */
3139 public final void enableMenuItems(final int lower, final int upper) {
3140 for (TMenuItem item: menuItems) {
3141 if ((item.getId() >= lower) && (item.getId() <= upper)) {
3142 item.setEnabled(true);
3143 item.getParent().activate(0);
3144 }
3145 }
3146 }
3147
3148 /**
3149 * Get the menu item associated with this ID.
3150 *
3151 * @param id the menu item ID
3152 * @return the menu item, or null if not found
3153 */
3154 public final TMenuItem getMenuItem(final int id) {
3155 for (TMenuItem item: menuItems) {
3156 if (item.getId() == id) {
3157 return item;
3158 }
3159 }
3160 return null;
3161 }
3162
3163 /**
3164 * Recompute menu x positions based on their title length.
3165 */
3166 public final void recomputeMenuX() {
3167 int x = 0;
3168 for (TMenu menu: menus) {
3169 menu.setX(x);
3170 menu.setTitleX(x);
3171 x += StringUtils.width(menu.getTitle()) + 2;
3172
3173 // Don't let the menu window exceed the screen width
3174 int rightEdge = menu.getX() + menu.getWidth();
3175 if (rightEdge > getScreen().getWidth()) {
3176 menu.setX(getScreen().getWidth() - menu.getWidth());
3177 }
3178 }
3179 }
3180
3181 /**
3182 * Post an event to process.
3183 *
3184 * @param event new event to add to the queue
3185 */
3186 public final void postEvent(final TInputEvent event) {
3187 synchronized (this) {
3188 synchronized (fillEventQueue) {
3189 fillEventQueue.add(event);
3190 }
3191 if (debugThreads) {
3192 System.err.println(System.currentTimeMillis() + " " +
3193 Thread.currentThread() + " postEvent() wake up main");
3194 }
3195 this.notify();
3196 }
3197 }
3198
3199 /**
3200 * Post an event to process and turn off the menu.
3201 *
3202 * @param event new event to add to the queue
3203 */
3204 public final void postMenuEvent(final TInputEvent event) {
3205 synchronized (this) {
3206 synchronized (fillEventQueue) {
3207 fillEventQueue.add(event);
3208 }
3209 if (debugThreads) {
3210 System.err.println(System.currentTimeMillis() + " " +
3211 Thread.currentThread() + " postMenuEvent() wake up main");
3212 }
3213 closeMenu();
3214 this.notify();
3215 }
3216 }
3217
3218 /**
3219 * Add a sub-menu to the list of open sub-menus.
3220 *
3221 * @param menu sub-menu
3222 */
3223 public final void addSubMenu(final TMenu menu) {
3224 subMenus.add(menu);
3225 }
3226
3227 /**
3228 * Convenience function to add a top-level menu.
3229 *
3230 * @param title menu title
3231 * @return the new menu
3232 */
3233 public final TMenu addMenu(final String title) {
3234 int x = 0;
3235 int y = 0;
3236 TMenu menu = new TMenu(this, x, y, title);
3237 menus.add(menu);
3238 recomputeMenuX();
3239 return menu;
3240 }
3241
3242 /**
3243 * Convenience function to add a default tools (hamburger) menu.
3244 *
3245 * @return the new menu
3246 */
3247 public final TMenu addToolMenu() {
3248 TMenu toolMenu = addMenu(i18n.getString("toolMenuTitle"));
3249 toolMenu.addDefaultItem(TMenu.MID_REPAINT);
3250 toolMenu.addDefaultItem(TMenu.MID_VIEW_IMAGE);
3251 toolMenu.addDefaultItem(TMenu.MID_SCREEN_OPTIONS);
3252 TStatusBar toolStatusBar = toolMenu.newStatusBar(i18n.
3253 getString("toolMenuStatus"));
3254 toolStatusBar.addShortcutKeypress(kbF1, cmHelp, i18n.getString("Help"));
3255 return toolMenu;
3256 }
3257
3258 /**
3259 * Convenience function to add a default "File" menu.
3260 *
3261 * @return the new menu
3262 */
3263 public final TMenu addFileMenu() {
3264 TMenu fileMenu = addMenu(i18n.getString("fileMenuTitle"));
3265 fileMenu.addDefaultItem(TMenu.MID_SHELL);
3266 fileMenu.addSeparator();
3267 fileMenu.addDefaultItem(TMenu.MID_EXIT);
3268 TStatusBar statusBar = fileMenu.newStatusBar(i18n.
3269 getString("fileMenuStatus"));
3270 statusBar.addShortcutKeypress(kbF1, cmHelp, i18n.getString("Help"));
3271 return fileMenu;
3272 }
3273
3274 /**
3275 * Convenience function to add a default "Edit" menu.
3276 *
3277 * @return the new menu
3278 */
3279 public final TMenu addEditMenu() {
3280 TMenu editMenu = addMenu(i18n.getString("editMenuTitle"));
3281 editMenu.addDefaultItem(TMenu.MID_CUT);
3282 editMenu.addDefaultItem(TMenu.MID_COPY);
3283 editMenu.addDefaultItem(TMenu.MID_PASTE);
3284 editMenu.addDefaultItem(TMenu.MID_CLEAR);
3285 TStatusBar statusBar = editMenu.newStatusBar(i18n.
3286 getString("editMenuStatus"));
3287 statusBar.addShortcutKeypress(kbF1, cmHelp, i18n.getString("Help"));
3288 return editMenu;
3289 }
3290
3291 /**
3292 * Convenience function to add a default "Window" menu.
3293 *
3294 * @return the new menu
3295 */
3296 public final TMenu addWindowMenu() {
3297 TMenu windowMenu = addMenu(i18n.getString("windowMenuTitle"));
3298 windowMenu.addDefaultItem(TMenu.MID_TILE);
3299 windowMenu.addDefaultItem(TMenu.MID_CASCADE);
3300 windowMenu.addDefaultItem(TMenu.MID_CLOSE_ALL);
3301 windowMenu.addSeparator();
3302 windowMenu.addDefaultItem(TMenu.MID_WINDOW_MOVE);
3303 windowMenu.addDefaultItem(TMenu.MID_WINDOW_ZOOM);
3304 windowMenu.addDefaultItem(TMenu.MID_WINDOW_NEXT);
3305 windowMenu.addDefaultItem(TMenu.MID_WINDOW_PREVIOUS);
3306 windowMenu.addDefaultItem(TMenu.MID_WINDOW_CLOSE);
3307 TStatusBar statusBar = windowMenu.newStatusBar(i18n.
3308 getString("windowMenuStatus"));
3309 statusBar.addShortcutKeypress(kbF1, cmHelp, i18n.getString("Help"));
3310 return windowMenu;
3311 }
3312
3313 /**
3314 * Convenience function to add a default "Help" menu.
3315 *
3316 * @return the new menu
3317 */
3318 public final TMenu addHelpMenu() {
3319 TMenu helpMenu = addMenu(i18n.getString("helpMenuTitle"));
3320 helpMenu.addDefaultItem(TMenu.MID_HELP_CONTENTS);
3321 helpMenu.addDefaultItem(TMenu.MID_HELP_INDEX);
3322 helpMenu.addDefaultItem(TMenu.MID_HELP_SEARCH);
3323 helpMenu.addDefaultItem(TMenu.MID_HELP_PREVIOUS);
3324 helpMenu.addDefaultItem(TMenu.MID_HELP_HELP);
3325 helpMenu.addDefaultItem(TMenu.MID_HELP_ACTIVE_FILE);
3326 helpMenu.addSeparator();
3327 helpMenu.addDefaultItem(TMenu.MID_ABOUT);
3328 TStatusBar statusBar = helpMenu.newStatusBar(i18n.
3329 getString("helpMenuStatus"));
3330 statusBar.addShortcutKeypress(kbF1, cmHelp, i18n.getString("Help"));
3331 return helpMenu;
3332 }
3333
3334 /**
3335 * Convenience function to add a default "Table" menu.
3336 *
3337 * @return the new menu
3338 */
3339 public final TMenu addTableMenu() {
3340 TMenu tableMenu = addMenu(i18n.getString("tableMenuTitle"));
3341 tableMenu.addDefaultItem(TMenu.MID_TABLE_RENAME_COLUMN, false);
3342 tableMenu.addDefaultItem(TMenu.MID_TABLE_RENAME_ROW, false);
3343 tableMenu.addSeparator();
3344
3345 TSubMenu viewMenu = tableMenu.addSubMenu(i18n.
3346 getString("tableSubMenuView"));
3347 viewMenu.addDefaultItem(TMenu.MID_TABLE_VIEW_ROW_LABELS, false);
3348 viewMenu.addDefaultItem(TMenu.MID_TABLE_VIEW_COLUMN_LABELS, false);
3349 viewMenu.addDefaultItem(TMenu.MID_TABLE_VIEW_HIGHLIGHT_ROW, false);
3350 viewMenu.addDefaultItem(TMenu.MID_TABLE_VIEW_HIGHLIGHT_COLUMN, false);
3351
3352 TSubMenu borderMenu = tableMenu.addSubMenu(i18n.
3353 getString("tableSubMenuBorders"));
3354 borderMenu.addDefaultItem(TMenu.MID_TABLE_BORDER_NONE, false);
3355 borderMenu.addDefaultItem(TMenu.MID_TABLE_BORDER_ALL, false);
3356 borderMenu.addDefaultItem(TMenu.MID_TABLE_BORDER_CELL_NONE, false);
3357 borderMenu.addDefaultItem(TMenu.MID_TABLE_BORDER_CELL_ALL, false);
3358 borderMenu.addDefaultItem(TMenu.MID_TABLE_BORDER_RIGHT, false);
3359 borderMenu.addDefaultItem(TMenu.MID_TABLE_BORDER_LEFT, false);
3360 borderMenu.addDefaultItem(TMenu.MID_TABLE_BORDER_TOP, false);
3361 borderMenu.addDefaultItem(TMenu.MID_TABLE_BORDER_BOTTOM, false);
3362 borderMenu.addDefaultItem(TMenu.MID_TABLE_BORDER_DOUBLE_BOTTOM, false);
3363 borderMenu.addDefaultItem(TMenu.MID_TABLE_BORDER_THICK_BOTTOM, false);
3364 TSubMenu deleteMenu = tableMenu.addSubMenu(i18n.
3365 getString("tableSubMenuDelete"));
3366 deleteMenu.addDefaultItem(TMenu.MID_TABLE_DELETE_LEFT, false);
3367 deleteMenu.addDefaultItem(TMenu.MID_TABLE_DELETE_UP, false);
3368 deleteMenu.addDefaultItem(TMenu.MID_TABLE_DELETE_ROW, false);
3369 deleteMenu.addDefaultItem(TMenu.MID_TABLE_DELETE_COLUMN, false);
3370 TSubMenu insertMenu = tableMenu.addSubMenu(i18n.
3371 getString("tableSubMenuInsert"));
3372 insertMenu.addDefaultItem(TMenu.MID_TABLE_INSERT_LEFT, false);
3373 insertMenu.addDefaultItem(TMenu.MID_TABLE_INSERT_RIGHT, false);
3374 insertMenu.addDefaultItem(TMenu.MID_TABLE_INSERT_ABOVE, false);
3375 insertMenu.addDefaultItem(TMenu.MID_TABLE_INSERT_BELOW, false);
3376 TSubMenu columnMenu = tableMenu.addSubMenu(i18n.
3377 getString("tableSubMenuColumn"));
3378 columnMenu.addDefaultItem(TMenu.MID_TABLE_COLUMN_NARROW, false);
3379 columnMenu.addDefaultItem(TMenu.MID_TABLE_COLUMN_WIDEN, false);
3380 TSubMenu fileMenu = tableMenu.addSubMenu(i18n.
3381 getString("tableSubMenuFile"));
3382 fileMenu.addDefaultItem(TMenu.MID_TABLE_FILE_OPEN_CSV, false);
3383 fileMenu.addDefaultItem(TMenu.MID_TABLE_FILE_SAVE_CSV, false);
3384 fileMenu.addDefaultItem(TMenu.MID_TABLE_FILE_SAVE_TEXT, false);
3385
3386 TStatusBar statusBar = tableMenu.newStatusBar(i18n.
3387 getString("tableMenuStatus"));
3388 statusBar.addShortcutKeypress(kbF1, cmHelp, i18n.getString("Help"));
3389 return tableMenu;
3390 }
3391
3392 // ------------------------------------------------------------------------
3393 // TTimer management ------------------------------------------------------
3394 // ------------------------------------------------------------------------
3395
3396 /**
3397 * Get the amount of time I can sleep before missing a Timer tick.
3398 *
3399 * @param timeout = initial (maximum) timeout in millis
3400 * @return number of milliseconds between now and the next timer event
3401 */
3402 private long getSleepTime(final long timeout) {
3403 Date now = new Date();
3404 long nowTime = now.getTime();
3405 long sleepTime = timeout;
3406
3407 synchronized (timers) {
3408 for (TTimer timer: timers) {
3409 long nextTickTime = timer.getNextTick().getTime();
3410 if (nextTickTime < nowTime) {
3411 return 0;
3412 }
3413
3414 long timeDifference = nextTickTime - nowTime;
3415 if (timeDifference < sleepTime) {
3416 sleepTime = timeDifference;
3417 }
3418 }
3419 }
3420
3421 assert (sleepTime >= 0);
3422 assert (sleepTime <= timeout);
3423 return sleepTime;
3424 }
3425
3426 /**
3427 * Convenience function to add a timer.
3428 *
3429 * @param duration number of milliseconds to wait between ticks
3430 * @param recurring if true, re-schedule this timer after every tick
3431 * @param action function to call when button is pressed
3432 * @return the timer
3433 */
3434 public final TTimer addTimer(final long duration, final boolean recurring,
3435 final TAction action) {
3436
3437 TTimer timer = new TTimer(duration, recurring, action);
3438 synchronized (timers) {
3439 timers.add(timer);
3440 }
3441 return timer;
3442 }
3443
3444 /**
3445 * Convenience function to remove a timer.
3446 *
3447 * @param timer timer to remove
3448 */
3449 public final void removeTimer(final TTimer timer) {
3450 synchronized (timers) {
3451 timers.remove(timer);
3452 }
3453 }
3454
3455 // ------------------------------------------------------------------------
3456 // Other TWindow constructors ---------------------------------------------
3457 // ------------------------------------------------------------------------
3458
3459 /**
3460 * Convenience function to spawn a message box.
3461 *
3462 * @param title window title, will be centered along the top border
3463 * @param caption message to display. Use embedded newlines to get a
3464 * multi-line box.
3465 * @return the new message box
3466 */
3467 public final TMessageBox messageBox(final String title,
3468 final String caption) {
3469
3470 return new TMessageBox(this, title, caption, TMessageBox.Type.OK);
3471 }
3472
3473 /**
3474 * Convenience function to spawn a message box.
3475 *
3476 * @param title window title, will be centered along the top border
3477 * @param caption message to display. Use embedded newlines to get a
3478 * multi-line box.
3479 * @param type one of the TMessageBox.Type constants. Default is
3480 * Type.OK.
3481 * @return the new message box
3482 */
3483 public final TMessageBox messageBox(final String title,
3484 final String caption, final TMessageBox.Type type) {
3485
3486 return new TMessageBox(this, title, caption, type);
3487 }
3488
3489 /**
3490 * Convenience function to spawn an input box.
3491 *
3492 * @param title window title, will be centered along the top border
3493 * @param caption message to display. Use embedded newlines to get a
3494 * multi-line box.
3495 * @return the new input box
3496 */
3497 public final TInputBox inputBox(final String title, final String caption) {
3498
3499 return new TInputBox(this, title, caption);
3500 }
3501
3502 /**
3503 * Convenience function to spawn an input box.
3504 *
3505 * @param title window title, will be centered along the top border
3506 * @param caption message to display. Use embedded newlines to get a
3507 * multi-line box.
3508 * @param text initial text to seed the field with
3509 * @return the new input box
3510 */
3511 public final TInputBox inputBox(final String title, final String caption,
3512 final String text) {
3513
3514 return new TInputBox(this, title, caption, text);
3515 }
3516
3517 /**
3518 * Convenience function to spawn an input box.
3519 *
3520 * @param title window title, will be centered along the top border
3521 * @param caption message to display. Use embedded newlines to get a
3522 * multi-line box.
3523 * @param text initial text to seed the field with
3524 * @param type one of the Type constants. Default is Type.OK.
3525 * @return the new input box
3526 */
3527 public final TInputBox inputBox(final String title, final String caption,
3528 final String text, final TInputBox.Type type) {
3529
3530 return new TInputBox(this, title, caption, text, type);
3531 }
3532
3533 /**
3534 * Convenience function to open a terminal window.
3535 *
3536 * @param x column relative to parent
3537 * @param y row relative to parent
3538 * @return the terminal new window
3539 */
3540 public final TTerminalWindow openTerminal(final int x, final int y) {
3541 return openTerminal(x, y, TWindow.RESIZABLE);
3542 }
3543
3544 /**
3545 * Convenience function to open a terminal window.
3546 *
3547 * @param x column relative to parent
3548 * @param y row relative to parent
3549 * @param closeOnExit if true, close the window when the command exits
3550 * @return the terminal new window
3551 */
3552 public final TTerminalWindow openTerminal(final int x, final int y,
3553 final boolean closeOnExit) {
3554
3555 return openTerminal(x, y, TWindow.RESIZABLE, closeOnExit);
3556 }
3557
3558 /**
3559 * Convenience function to open a terminal window.
3560 *
3561 * @param x column relative to parent
3562 * @param y row relative to parent
3563 * @param flags mask of CENTERED, MODAL, or RESIZABLE
3564 * @return the terminal new window
3565 */
3566 public final TTerminalWindow openTerminal(final int x, final int y,
3567 final int flags) {
3568
3569 return new TTerminalWindow(this, x, y, flags);
3570 }
3571
3572 /**
3573 * Convenience function to open a terminal window.
3574 *
3575 * @param x column relative to parent
3576 * @param y row relative to parent
3577 * @param flags mask of CENTERED, MODAL, or RESIZABLE
3578 * @param closeOnExit if true, close the window when the command exits
3579 * @return the terminal new window
3580 */
3581 public final TTerminalWindow openTerminal(final int x, final int y,
3582 final int flags, final boolean closeOnExit) {
3583
3584 return new TTerminalWindow(this, x, y, flags, closeOnExit);
3585 }
3586
3587 /**
3588 * Convenience function to open a terminal window and execute a custom
3589 * command line inside it.
3590 *
3591 * @param x column relative to parent
3592 * @param y row relative to parent
3593 * @param commandLine the command line to execute
3594 * @return the terminal new window
3595 */
3596 public final TTerminalWindow openTerminal(final int x, final int y,
3597 final String commandLine) {
3598
3599 return openTerminal(x, y, TWindow.RESIZABLE, commandLine);
3600 }
3601
3602 /**
3603 * Convenience function to open a terminal window and execute a custom
3604 * command line inside it.
3605 *
3606 * @param x column relative to parent
3607 * @param y row relative to parent
3608 * @param commandLine the command line to execute
3609 * @param closeOnExit if true, close the window when the command exits
3610 * @return the terminal new window
3611 */
3612 public final TTerminalWindow openTerminal(final int x, final int y,
3613 final String commandLine, final boolean closeOnExit) {
3614
3615 return openTerminal(x, y, TWindow.RESIZABLE, commandLine, closeOnExit);
3616 }
3617
3618 /**
3619 * Convenience function to open a terminal window and execute a custom
3620 * command line inside it.
3621 *
3622 * @param x column relative to parent
3623 * @param y row relative to parent
3624 * @param flags mask of CENTERED, MODAL, or RESIZABLE
3625 * @param command the command line to execute
3626 * @return the terminal new window
3627 */
3628 public final TTerminalWindow openTerminal(final int x, final int y,
3629 final int flags, final String [] command) {
3630
3631 return new TTerminalWindow(this, x, y, flags, command);
3632 }
3633
3634 /**
3635 * Convenience function to open a terminal window and execute a custom
3636 * command line inside it.
3637 *
3638 * @param x column relative to parent
3639 * @param y row relative to parent
3640 * @param flags mask of CENTERED, MODAL, or RESIZABLE
3641 * @param command the command line to execute
3642 * @param closeOnExit if true, close the window when the command exits
3643 * @return the terminal new window
3644 */
3645 public final TTerminalWindow openTerminal(final int x, final int y,
3646 final int flags, final String [] command, final boolean closeOnExit) {
3647
3648 return new TTerminalWindow(this, x, y, flags, command, closeOnExit);
3649 }
3650
3651 /**
3652 * Convenience function to open a terminal window and execute a custom
3653 * command line inside it.
3654 *
3655 * @param x column relative to parent
3656 * @param y row relative to parent
3657 * @param flags mask of CENTERED, MODAL, or RESIZABLE
3658 * @param commandLine the command line to execute
3659 * @return the terminal new window
3660 */
3661 public final TTerminalWindow openTerminal(final int x, final int y,
3662 final int flags, final String commandLine) {
3663
3664 return new TTerminalWindow(this, x, y, flags, commandLine.split("\\s+"));
3665 }
3666
3667 /**
3668 * Convenience function to open a terminal window and execute a custom
3669 * command line inside it.
3670 *
3671 * @param x column relative to parent
3672 * @param y row relative to parent
3673 * @param flags mask of CENTERED, MODAL, or RESIZABLE
3674 * @param commandLine the command line to execute
3675 * @param closeOnExit if true, close the window when the command exits
3676 * @return the terminal new window
3677 */
3678 public final TTerminalWindow openTerminal(final int x, final int y,
3679 final int flags, final String commandLine, final boolean closeOnExit) {
3680
3681 return new TTerminalWindow(this, x, y, flags, commandLine.split("\\s+"),
3682 closeOnExit);
3683 }
3684
3685 /**
3686 * Convenience function to spawn an file open box.
3687 *
3688 * @param path path of selected file
3689 * @return the result of the new file open box
3690 * @throws IOException if java.io operation throws
3691 */
3692 public final String fileOpenBox(final String path) throws IOException {
3693
3694 TFileOpenBox box = new TFileOpenBox(this, path, TFileOpenBox.Type.OPEN);
3695 return box.getFilename();
3696 }
3697
3698 /**
3699 * Convenience function to spawn an file open box.
3700 *
3701 * @param path path of selected file
3702 * @param type one of the Type constants
3703 * @return the result of the new file open box
3704 * @throws IOException if java.io operation throws
3705 */
3706 public final String fileOpenBox(final String path,
3707 final TFileOpenBox.Type type) throws IOException {
3708
3709 TFileOpenBox box = new TFileOpenBox(this, path, type);
3710 return box.getFilename();
3711 }
3712
3713 /**
3714 * Convenience function to spawn a file open box.
3715 *
3716 * @param path path of selected file
3717 * @param type one of the Type constants
3718 * @param filter a string that files must match to be displayed
3719 * @return the result of the new file open box
3720 * @throws IOException of a java.io operation throws
3721 */
3722 public final String fileOpenBox(final String path,
3723 final TFileOpenBox.Type type, final String filter) throws IOException {
3724
3725 ArrayList<String> filters = new ArrayList<String>();
3726 filters.add(filter);
3727
3728 TFileOpenBox box = new TFileOpenBox(this, path, type, filters);
3729 return box.getFilename();
3730 }
3731
3732 /**
3733 * Convenience function to spawn a file open box.
3734 *
3735 * @param path path of selected file
3736 * @param type one of the Type constants
3737 * @param filters a list of strings that files must match to be displayed
3738 * @return the result of the new file open box
3739 * @throws IOException of a java.io operation throws
3740 */
3741 public final String fileOpenBox(final String path,
3742 final TFileOpenBox.Type type,
3743 final List<String> filters) throws IOException {
3744
3745 TFileOpenBox box = new TFileOpenBox(this, path, type, filters);
3746 return box.getFilename();
3747 }
3748
3749 /**
3750 * Convenience function to create a new window and make it active.
3751 * Window will be located at (0, 0).
3752 *
3753 * @param title window title, will be centered along the top border
3754 * @param width width of window
3755 * @param height height of window
3756 * @return the new window
3757 */
3758 public final TWindow addWindow(final String title, final int width,
3759 final int height) {
3760
3761 TWindow window = new TWindow(this, title, 0, 0, width, height);
3762 return window;
3763 }
3764
3765 /**
3766 * Convenience function to create a new window and make it active.
3767 * Window will be located at (0, 0).
3768 *
3769 * @param title window title, will be centered along the top border
3770 * @param width width of window
3771 * @param height height of window
3772 * @param flags bitmask of RESIZABLE, CENTERED, or MODAL
3773 * @return the new window
3774 */
3775 public final TWindow addWindow(final String title,
3776 final int width, final int height, final int flags) {
3777
3778 TWindow window = new TWindow(this, title, 0, 0, width, height, flags);
3779 return window;
3780 }
3781
3782 /**
3783 * Convenience function to create a new window and make it active.
3784 *
3785 * @param title window title, will be centered along the top border
3786 * @param x column relative to parent
3787 * @param y row relative to parent
3788 * @param width width of window
3789 * @param height height of window
3790 * @return the new window
3791 */
3792 public final TWindow addWindow(final String title,
3793 final int x, final int y, final int width, final int height) {
3794
3795 TWindow window = new TWindow(this, title, x, y, width, height);
3796 return window;
3797 }
3798
3799 /**
3800 * Convenience function to create a new window and make it active.
3801 *
3802 * @param title window title, will be centered along the top border
3803 * @param x column relative to parent
3804 * @param y row relative to parent
3805 * @param width width of window
3806 * @param height height of window
3807 * @param flags mask of RESIZABLE, CENTERED, or MODAL
3808 * @return the new window
3809 */
3810 public final TWindow addWindow(final String title,
3811 final int x, final int y, final int width, final int height,
3812 final int flags) {
3813
3814 TWindow window = new TWindow(this, title, x, y, width, height, flags);
3815 return window;
3816 }
3817
3818 }