2 * Jexer - Java Text User Interface
4 * License: LGPLv3 or later
6 * This module is licensed under the GNU Lesser General Public License
7 * Version 3. Please see the file "COPYING" in this directory for more
8 * information about the GNU Lesser General Public License Version 3.
10 * Copyright (C) 2015 Kevin Lamonte
12 * This program is free software; you can redistribute it and/or
13 * modify it under the terms of the GNU Lesser General Public License
14 * as published by the Free Software Foundation; either version 3 of
15 * the License, or (at your option) any later version.
17 * This program is distributed in the hope that it will be useful, but
18 * WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
20 * General Public License for more details.
22 * You should have received a copy of the GNU Lesser General Public
23 * License along with this program; if not, see
24 * http://www.gnu.org/licenses/, or write to the Free Software
25 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
28 * @author Kevin Lamonte [kevin.lamonte@gmail.com]
33 import java
.awt
.event
.ComponentEvent
;
34 import java
.awt
.event
.ComponentListener
;
35 import java
.awt
.event
.KeyEvent
;
36 import java
.awt
.event
.KeyListener
;
37 import java
.awt
.event
.MouseEvent
;
38 import java
.awt
.event
.MouseListener
;
39 import java
.awt
.event
.MouseMotionListener
;
40 import java
.awt
.event
.MouseWheelEvent
;
41 import java
.awt
.event
.MouseWheelListener
;
42 import java
.awt
.event
.WindowEvent
;
43 import java
.awt
.event
.WindowListener
;
44 import java
.util
.List
;
45 import java
.util
.LinkedList
;
47 import jexer
.TKeypress
;
48 import jexer
.event
.TCommandEvent
;
49 import jexer
.event
.TInputEvent
;
50 import jexer
.event
.TKeypressEvent
;
51 import jexer
.event
.TMouseEvent
;
52 import jexer
.event
.TResizeEvent
;
53 import jexer
.session
.SessionInfo
;
54 import jexer
.session
.AWTSessionInfo
;
55 import static jexer
.TCommand
.*;
56 import static jexer
.TKeypress
.*;
59 * This class reads keystrokes and mouse events from an AWT Frame.
61 public final class AWTTerminal
implements ComponentListener
, KeyListener
,
62 MouseListener
, MouseMotionListener
,
63 MouseWheelListener
, WindowListener
{
68 private AWTScreen screen
;
71 * The session information.
73 private AWTSessionInfo sessionInfo
;
76 * Getter for sessionInfo.
78 * @return the SessionInfo
80 public SessionInfo
getSessionInfo() {
85 * The listening object that run() wakes up on new input.
87 private Object listener
;
90 * The event queue, filled up by a thread reading on input.
92 private List
<TInputEvent
> eventQueue
;
97 private Thread readerThread
;
100 * true if mouse1 was down. Used to report mouse1 on the release event.
102 private boolean mouse1
= false;
105 * true if mouse2 was down. Used to report mouse2 on the release event.
107 private boolean mouse2
= false;
110 * true if mouse3 was down. Used to report mouse3 on the release event.
112 private boolean mouse3
= false;
115 * Check if there are events in the queue.
117 * @return if true, getEvents() has something to return to the backend
119 public boolean hasEvents() {
120 synchronized (eventQueue
) {
121 return (eventQueue
.size() > 0);
126 * Constructor sets up state for getEvent().
128 * @param listener the object this backend needs to wake up when new
130 * @param screen the top-level AWT frame
132 public AWTTerminal(final Object listener
, final AWTScreen screen
) {
133 this.listener
= listener
;
134 this.screen
= screen
;
138 sessionInfo
= screen
.getSessionInfo();
139 eventQueue
= new LinkedList
<TInputEvent
>();
141 screen
.frame
.addKeyListener(this);
142 screen
.frame
.addWindowListener(this);
143 screen
.frame
.addComponentListener(this);
144 screen
.frame
.addMouseListener(this);
145 screen
.frame
.addMouseMotionListener(this);
146 screen
.frame
.addMouseWheelListener(this);
150 * Restore terminal to normal state.
152 public void shutdown() {
153 // System.err.println("=== shutdown() ==="); System.err.flush();
154 screen
.frame
.dispose();
158 * Return any events in the IO queue.
160 * @param queue list to append new events to
162 public void getEvents(final List
<TInputEvent
> queue
) {
163 synchronized (eventQueue
) {
164 if (eventQueue
.size() > 0) {
165 synchronized (queue
) {
166 queue
.addAll(eventQueue
);
174 * Pass AWT keystrokes into the event queue.
176 * @param key keystroke received
179 public void keyReleased(final KeyEvent key
) {
180 // Ignore release events
184 * Pass AWT keystrokes into the event queue.
186 * @param key keystroke received
189 public void keyTyped(final KeyEvent key
) {
190 // Ignore typed events
194 * Pass AWT keystrokes into the event queue.
196 * @param key keystroke received
199 public void keyPressed(final KeyEvent key
) {
201 boolean shift
= false;
202 boolean ctrl
= false;
204 boolean isKey
= false;
206 if (key
.isActionKey()) {
209 ch
= key
.getKeyChar();
211 alt
= key
.isAltDown();
212 ctrl
= key
.isControlDown();
213 shift
= key
.isShiftDown();
216 System.err.printf("AWT Key: %s\n", key);
217 System.err.printf(" isKey: %s\n", isKey);
218 System.err.printf(" alt: %s\n", alt);
219 System.err.printf(" ctrl: %s\n", ctrl);
220 System.err.printf(" shift: %s\n", shift);
221 System.err.printf(" ch: %s\n", ch);
224 // Special case: not return the bare modifier presses
225 switch (key
.getKeyCode()) {
226 case KeyEvent
.VK_ALT
:
228 case KeyEvent
.VK_ALT_GRAPH
:
230 case KeyEvent
.VK_CONTROL
:
232 case KeyEvent
.VK_SHIFT
:
234 case KeyEvent
.VK_META
:
240 TKeypress keypress
= null;
242 switch (key
.getKeyCode()) {
244 keypress
= new TKeypress(true, TKeypress
.F1
, ' ',
248 keypress
= new TKeypress(true, TKeypress
.F2
, ' ',
252 keypress
= new TKeypress(true, TKeypress
.F3
, ' ',
256 keypress
= new TKeypress(true, TKeypress
.F4
, ' ',
260 keypress
= new TKeypress(true, TKeypress
.F5
, ' ',
264 keypress
= new TKeypress(true, TKeypress
.F6
, ' ',
268 keypress
= new TKeypress(true, TKeypress
.F7
, ' ',
272 keypress
= new TKeypress(true, TKeypress
.F8
, ' ',
276 keypress
= new TKeypress(true, TKeypress
.F9
, ' ',
279 case KeyEvent
.VK_F10
:
280 keypress
= new TKeypress(true, TKeypress
.F10
, ' ',
283 case KeyEvent
.VK_F11
:
284 keypress
= new TKeypress(true, TKeypress
.F11
, ' ',
287 case KeyEvent
.VK_F12
:
288 keypress
= new TKeypress(true, TKeypress
.F12
, ' ',
291 case KeyEvent
.VK_HOME
:
292 keypress
= new TKeypress(true, TKeypress
.HOME
, ' ',
295 case KeyEvent
.VK_END
:
296 keypress
= new TKeypress(true, TKeypress
.END
, ' ',
299 case KeyEvent
.VK_PAGE_UP
:
300 keypress
= new TKeypress(true, TKeypress
.PGUP
, ' ',
303 case KeyEvent
.VK_PAGE_DOWN
:
304 keypress
= new TKeypress(true, TKeypress
.PGDN
, ' ',
307 case KeyEvent
.VK_INSERT
:
308 keypress
= new TKeypress(true, TKeypress
.INS
, ' ',
311 case KeyEvent
.VK_DELETE
:
312 keypress
= new TKeypress(true, TKeypress
.DEL
, ' ',
315 case KeyEvent
.VK_RIGHT
:
316 keypress
= new TKeypress(true, TKeypress
.RIGHT
, ' ',
319 case KeyEvent
.VK_LEFT
:
320 keypress
= new TKeypress(true, TKeypress
.LEFT
, ' ',
324 keypress
= new TKeypress(true, TKeypress
.UP
, ' ',
327 case KeyEvent
.VK_DOWN
:
328 keypress
= new TKeypress(true, TKeypress
.DOWN
, ' ',
331 case KeyEvent
.VK_TAB
:
332 // Special case: distinguish TAB vs BTAB
334 keypress
= kbShiftTab
;
339 case KeyEvent
.VK_ENTER
:
340 keypress
= new TKeypress(true, TKeypress
.ENTER
, ' ',
343 case KeyEvent
.VK_ESCAPE
:
344 keypress
= new TKeypress(true, TKeypress
.ESC
, ' ',
347 case KeyEvent
.VK_BACK_SPACE
:
348 // Special case: return it as kbBackspace (Ctrl-H)
349 keypress
= new TKeypress(false, 0, 'H', false, true, false);
352 // Unsupported, ignore
357 if (keypress
== null) {
360 keypress
= kbBackspace
;
375 if (!alt
&& ctrl
&& !shift
) {
376 ch
= key
.getKeyText(key
.getKeyCode()).charAt(0);
378 // Not a special key, put it together
379 keypress
= new TKeypress(false, 0, ch
, alt
, ctrl
, shift
);
383 // Save it and we are done.
384 synchronized (eventQueue
) {
385 eventQueue
.add(new TKeypressEvent(keypress
));
387 synchronized (listener
) {
388 listener
.notifyAll();
393 * Pass window events into the event queue.
395 * @param event window event received
398 public void windowActivated(final WindowEvent event
) {
403 * Pass window events into the event queue.
405 * @param event window event received
408 public void windowClosed(final WindowEvent event
) {
413 * Pass window events into the event queue.
415 * @param event window event received
418 public void windowClosing(final WindowEvent event
) {
419 // Drop a cmAbort and walk away
420 synchronized (eventQueue
) {
421 eventQueue
.add(new TCommandEvent(cmAbort
));
423 synchronized (listener
) {
424 listener
.notifyAll();
429 * Pass window events into the event queue.
431 * @param event window event received
434 public void windowDeactivated(final WindowEvent event
) {
439 * Pass window events into the event queue.
441 * @param event window event received
444 public void windowDeiconified(final WindowEvent event
) {
449 * Pass window events into the event queue.
451 * @param event window event received
454 public void windowIconified(final WindowEvent event
) {
459 * Pass window events into the event queue.
461 * @param event window event received
464 public void windowOpened(final WindowEvent event
) {
469 * Pass component events into the event queue.
471 * @param event component event received
474 public void componentHidden(final ComponentEvent event
) {
479 * Pass component events into the event queue.
481 * @param event component event received
484 public void componentShown(final ComponentEvent event
) {
489 * Pass component events into the event queue.
491 * @param event component event received
494 public void componentMoved(final ComponentEvent event
) {
499 * Pass component events into the event queue.
501 * @param event component event received
504 public void componentResized(final ComponentEvent event
) {
505 // Drop a new TResizeEvent into the queue
506 sessionInfo
.queryWindowSize();
507 synchronized (eventQueue
) {
508 TResizeEvent windowResize
= new TResizeEvent(TResizeEvent
.Type
.SCREEN
,
509 sessionInfo
.getWindowWidth(), sessionInfo
.getWindowHeight());
510 eventQueue
.add(windowResize
);
512 synchronized (listener
) {
513 listener
.notifyAll();
518 * Pass mouse events into the event queue.
520 * @param mouse mouse event received
523 public void mouseDragged(final MouseEvent mouse
) {
524 int modifiers
= mouse
.getModifiersEx();
525 boolean eventMouse1
= false;
526 boolean eventMouse2
= false;
527 boolean eventMouse3
= false;
528 if ((modifiers
& MouseEvent
.BUTTON1_DOWN_MASK
) != 0) {
531 if ((modifiers
& MouseEvent
.BUTTON2_DOWN_MASK
) != 0) {
534 if ((modifiers
& MouseEvent
.BUTTON3_DOWN_MASK
) != 0) {
537 mouse1
= eventMouse1
;
538 mouse2
= eventMouse2
;
539 mouse3
= eventMouse3
;
540 int x
= screen
.textColumn(mouse
.getX());
541 int y
= screen
.textRow(mouse
.getY());
543 TMouseEvent mouseEvent
= new TMouseEvent(TMouseEvent
.Type
.MOUSE_MOTION
,
544 x
, y
, x
, y
, mouse1
, mouse2
, mouse3
, false, false);
546 synchronized (eventQueue
) {
547 eventQueue
.add(mouseEvent
);
549 synchronized (listener
) {
550 listener
.notifyAll();
555 * Pass mouse events into the event queue.
557 * @param mouse mouse event received
560 public void mouseMoved(final MouseEvent mouse
) {
561 int x
= screen
.textColumn(mouse
.getX());
562 int y
= screen
.textRow(mouse
.getY());
563 TMouseEvent mouseEvent
= new TMouseEvent(TMouseEvent
.Type
.MOUSE_MOTION
,
564 x
, y
, x
, y
, mouse1
, mouse2
, mouse3
, false, false);
566 synchronized (eventQueue
) {
567 eventQueue
.add(mouseEvent
);
569 synchronized (listener
) {
570 listener
.notifyAll();
575 * Pass mouse events into the event queue.
577 * @param mouse mouse event received
580 public void mouseClicked(final MouseEvent mouse
) {
585 * Pass mouse events into the event queue.
587 * @param mouse mouse event received
590 public void mouseEntered(final MouseEvent mouse
) {
595 * Pass mouse events into the event queue.
597 * @param mouse mouse event received
600 public void mouseExited(final MouseEvent mouse
) {
605 * Pass mouse events into the event queue.
607 * @param mouse mouse event received
610 public void mousePressed(final MouseEvent mouse
) {
611 int modifiers
= mouse
.getModifiersEx();
612 boolean eventMouse1
= false;
613 boolean eventMouse2
= false;
614 boolean eventMouse3
= false;
615 if ((modifiers
& MouseEvent
.BUTTON1_DOWN_MASK
) != 0) {
618 if ((modifiers
& MouseEvent
.BUTTON2_DOWN_MASK
) != 0) {
621 if ((modifiers
& MouseEvent
.BUTTON3_DOWN_MASK
) != 0) {
624 mouse1
= eventMouse1
;
625 mouse2
= eventMouse2
;
626 mouse3
= eventMouse3
;
627 int x
= screen
.textColumn(mouse
.getX());
628 int y
= screen
.textRow(mouse
.getY());
630 TMouseEvent mouseEvent
= new TMouseEvent(TMouseEvent
.Type
.MOUSE_DOWN
,
631 x
, y
, x
, y
, mouse1
, mouse2
, mouse3
, false, false);
633 synchronized (eventQueue
) {
634 eventQueue
.add(mouseEvent
);
636 synchronized (listener
) {
637 listener
.notifyAll();
642 * Pass mouse events into the event queue.
644 * @param mouse mouse event received
647 public void mouseReleased(final MouseEvent mouse
) {
648 int modifiers
= mouse
.getModifiersEx();
649 boolean eventMouse1
= false;
650 boolean eventMouse2
= false;
651 boolean eventMouse3
= false;
652 if ((modifiers
& MouseEvent
.BUTTON1_DOWN_MASK
) != 0) {
655 if ((modifiers
& MouseEvent
.BUTTON2_DOWN_MASK
) != 0) {
658 if ((modifiers
& MouseEvent
.BUTTON3_DOWN_MASK
) != 0) {
673 int x
= screen
.textColumn(mouse
.getX());
674 int y
= screen
.textRow(mouse
.getY());
676 TMouseEvent mouseEvent
= new TMouseEvent(TMouseEvent
.Type
.MOUSE_UP
,
677 x
, y
, x
, y
, eventMouse1
, eventMouse2
, eventMouse3
, false, false);
679 synchronized (eventQueue
) {
680 eventQueue
.add(mouseEvent
);
682 synchronized (listener
) {
683 listener
.notifyAll();
688 * Pass mouse events into the event queue.
690 * @param mouse mouse event received
693 public void mouseWheelMoved(final MouseWheelEvent mouse
) {
694 int modifiers
= mouse
.getModifiersEx();
695 boolean eventMouse1
= false;
696 boolean eventMouse2
= false;
697 boolean eventMouse3
= false;
698 boolean mouseWheelUp
= false;
699 boolean mouseWheelDown
= false;
700 if ((modifiers
& MouseEvent
.BUTTON1_DOWN_MASK
) != 0) {
703 if ((modifiers
& MouseEvent
.BUTTON2_DOWN_MASK
) != 0) {
706 if ((modifiers
& MouseEvent
.BUTTON3_DOWN_MASK
) != 0) {
709 mouse1
= eventMouse1
;
710 mouse2
= eventMouse2
;
711 mouse3
= eventMouse3
;
712 int x
= screen
.textColumn(mouse
.getX());
713 int y
= screen
.textRow(mouse
.getY());
714 if (mouse
.getWheelRotation() > 0) {
715 mouseWheelDown
= true;
717 if (mouse
.getWheelRotation() < 0) {
721 TMouseEvent mouseEvent
= new TMouseEvent(TMouseEvent
.Type
.MOUSE_DOWN
,
722 x
, y
, x
, y
, mouse1
, mouse2
, mouse3
, mouseWheelUp
, mouseWheelDown
);
724 synchronized (eventQueue
) {
725 eventQueue
.add(mouseEvent
);
727 synchronized (listener
) {
728 listener
.notifyAll();