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
.SwingSessionInfo
;
55 import static jexer
.TCommand
.*;
56 import static jexer
.TKeypress
.*;
59 * This class reads keystrokes and mouse events from an Swing JFrame.
61 public final class SwingTerminal
implements ComponentListener
, KeyListener
,
62 MouseListener
, MouseMotionListener
,
63 MouseWheelListener
, WindowListener
{
68 private SwingScreen screen
;
71 * The session information.
73 private SwingSessionInfo 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
;
95 * The last reported mouse X position.
97 private int oldMouseX
= -1;
100 * The last reported mouse Y position.
102 private int oldMouseY
= -1;
105 * true if mouse1 was down. Used to report mouse1 on the release event.
107 private boolean mouse1
= false;
110 * true if mouse2 was down. Used to report mouse2 on the release event.
112 private boolean mouse2
= false;
115 * true if mouse3 was down. Used to report mouse3 on the release event.
117 private boolean mouse3
= false;
120 * Check if there are events in the queue.
122 * @return if true, getEvents() has something to return to the backend
124 public boolean hasEvents() {
125 synchronized (eventQueue
) {
126 return (eventQueue
.size() > 0);
131 * Constructor sets up state for getEvent().
133 * @param listener the object this backend needs to wake up when new
135 * @param screen the top-level Swing frame
137 public SwingTerminal(final Object listener
, final SwingScreen screen
) {
138 this.listener
= listener
;
139 this.screen
= screen
;
143 sessionInfo
= screen
.getSessionInfo();
144 eventQueue
= new LinkedList
<TInputEvent
>();
146 screen
.frame
.addKeyListener(this);
147 screen
.frame
.addWindowListener(this);
148 screen
.frame
.addComponentListener(this);
149 screen
.frame
.addMouseListener(this);
150 screen
.frame
.addMouseMotionListener(this);
151 screen
.frame
.addMouseWheelListener(this);
155 * Restore terminal to normal state.
157 public void shutdown() {
158 // System.err.println("=== shutdown() ==="); System.err.flush();
159 screen
.frame
.dispose();
163 * Return any events in the IO queue.
165 * @param queue list to append new events to
167 public void getEvents(final List
<TInputEvent
> queue
) {
168 synchronized (eventQueue
) {
169 if (eventQueue
.size() > 0) {
170 synchronized (queue
) {
171 queue
.addAll(eventQueue
);
179 * Pass Swing keystrokes into the event queue.
181 * @param key keystroke received
184 public void keyReleased(final KeyEvent key
) {
185 // Ignore release events
189 * Pass Swing keystrokes into the event queue.
191 * @param key keystroke received
194 public void keyTyped(final KeyEvent key
) {
195 // Ignore typed events
199 * Pass Swing keystrokes into the event queue.
201 * @param key keystroke received
204 public void keyPressed(final KeyEvent key
) {
206 boolean shift
= false;
207 boolean ctrl
= false;
209 boolean isKey
= false;
210 if (key
.isActionKey()) {
213 ch
= key
.getKeyChar();
215 alt
= key
.isAltDown();
216 ctrl
= key
.isControlDown();
217 shift
= key
.isShiftDown();
220 System.err.printf("Swing Key: %s\n", key);
221 System.err.printf(" isKey: %s\n", isKey);
222 System.err.printf(" alt: %s\n", alt);
223 System.err.printf(" ctrl: %s\n", ctrl);
224 System.err.printf(" shift: %s\n", shift);
225 System.err.printf(" ch: %s\n", ch);
228 // Special case: not return the bare modifier presses
229 switch (key
.getKeyCode()) {
230 case KeyEvent
.VK_ALT
:
232 case KeyEvent
.VK_ALT_GRAPH
:
234 case KeyEvent
.VK_CONTROL
:
236 case KeyEvent
.VK_SHIFT
:
238 case KeyEvent
.VK_META
:
244 TKeypress keypress
= null;
246 switch (key
.getKeyCode()) {
248 keypress
= new TKeypress(true, TKeypress
.F1
, ' ',
252 keypress
= new TKeypress(true, TKeypress
.F2
, ' ',
256 keypress
= new TKeypress(true, TKeypress
.F3
, ' ',
260 keypress
= new TKeypress(true, TKeypress
.F4
, ' ',
264 keypress
= new TKeypress(true, TKeypress
.F5
, ' ',
268 keypress
= new TKeypress(true, TKeypress
.F6
, ' ',
272 keypress
= new TKeypress(true, TKeypress
.F7
, ' ',
276 keypress
= new TKeypress(true, TKeypress
.F8
, ' ',
280 keypress
= new TKeypress(true, TKeypress
.F9
, ' ',
283 case KeyEvent
.VK_F10
:
284 keypress
= new TKeypress(true, TKeypress
.F10
, ' ',
287 case KeyEvent
.VK_F11
:
288 keypress
= new TKeypress(true, TKeypress
.F11
, ' ',
291 case KeyEvent
.VK_F12
:
292 keypress
= new TKeypress(true, TKeypress
.F12
, ' ',
295 case KeyEvent
.VK_HOME
:
296 keypress
= new TKeypress(true, TKeypress
.HOME
, ' ',
299 case KeyEvent
.VK_END
:
300 keypress
= new TKeypress(true, TKeypress
.END
, ' ',
303 case KeyEvent
.VK_PAGE_UP
:
304 keypress
= new TKeypress(true, TKeypress
.PGUP
, ' ',
307 case KeyEvent
.VK_PAGE_DOWN
:
308 keypress
= new TKeypress(true, TKeypress
.PGDN
, ' ',
311 case KeyEvent
.VK_INSERT
:
312 keypress
= new TKeypress(true, TKeypress
.INS
, ' ',
315 case KeyEvent
.VK_DELETE
:
316 keypress
= new TKeypress(true, TKeypress
.DEL
, ' ',
319 case KeyEvent
.VK_RIGHT
:
320 keypress
= new TKeypress(true, TKeypress
.RIGHT
, ' ',
323 case KeyEvent
.VK_LEFT
:
324 keypress
= new TKeypress(true, TKeypress
.LEFT
, ' ',
328 keypress
= new TKeypress(true, TKeypress
.UP
, ' ',
331 case KeyEvent
.VK_DOWN
:
332 keypress
= new TKeypress(true, TKeypress
.DOWN
, ' ',
335 case KeyEvent
.VK_TAB
:
336 // Special case: distinguish TAB vs BTAB
338 keypress
= kbShiftTab
;
343 case KeyEvent
.VK_ENTER
:
344 keypress
= new TKeypress(true, TKeypress
.ENTER
, ' ',
347 case KeyEvent
.VK_ESCAPE
:
348 keypress
= new TKeypress(true, TKeypress
.ESC
, ' ',
351 case KeyEvent
.VK_BACK_SPACE
:
352 // Special case: return it as kbBackspace (Ctrl-H)
353 keypress
= new TKeypress(false, 0, 'H', false, true, false);
356 // Unsupported, ignore
361 if (keypress
== null) {
364 keypress
= kbBackspace
;
377 keypress
= kbShiftTab
;
386 if (!alt
&& ctrl
&& !shift
) {
387 ch
= KeyEvent
.getKeyText(key
.getKeyCode()).charAt(0);
389 // Not a special key, put it together
390 keypress
= new TKeypress(false, 0, ch
, alt
, ctrl
, shift
);
394 // Save it and we are done.
395 synchronized (eventQueue
) {
396 eventQueue
.add(new TKeypressEvent(keypress
));
398 synchronized (listener
) {
399 listener
.notifyAll();
404 * Pass window events into the event queue.
406 * @param event window event received
409 public void windowActivated(final WindowEvent event
) {
410 // Force a total repaint
411 synchronized (screen
) {
412 screen
.clearPhysical();
417 * Pass window events into the event queue.
419 * @param event window event received
422 public void windowClosed(final WindowEvent event
) {
427 * Pass window events into the event queue.
429 * @param event window event received
432 public void windowClosing(final WindowEvent event
) {
433 // Drop a cmAbort and walk away
434 synchronized (eventQueue
) {
435 eventQueue
.add(new TCommandEvent(cmAbort
));
437 synchronized (listener
) {
438 listener
.notifyAll();
443 * Pass window events into the event queue.
445 * @param event window event received
448 public void windowDeactivated(final WindowEvent event
) {
453 * Pass window events into the event queue.
455 * @param event window event received
458 public void windowDeiconified(final WindowEvent event
) {
463 * Pass window events into the event queue.
465 * @param event window event received
468 public void windowIconified(final WindowEvent event
) {
473 * Pass window events into the event queue.
475 * @param event window event received
478 public void windowOpened(final WindowEvent event
) {
483 * Pass component events into the event queue.
485 * @param event component event received
488 public void componentHidden(final ComponentEvent event
) {
493 * Pass component events into the event queue.
495 * @param event component event received
498 public void componentShown(final ComponentEvent event
) {
503 * Pass component events into the event queue.
505 * @param event component event received
508 public void componentMoved(final ComponentEvent event
) {
513 * Pass component events into the event queue.
515 * @param event component event received
518 public void componentResized(final ComponentEvent event
) {
519 // Drop a new TResizeEvent into the queue
520 sessionInfo
.queryWindowSize();
521 synchronized (eventQueue
) {
522 TResizeEvent windowResize
= new TResizeEvent(TResizeEvent
.Type
.SCREEN
,
523 sessionInfo
.getWindowWidth(), sessionInfo
.getWindowHeight());
524 eventQueue
.add(windowResize
);
526 synchronized (listener
) {
527 listener
.notifyAll();
532 * Pass mouse events into the event queue.
534 * @param mouse mouse event received
537 public void mouseDragged(final MouseEvent mouse
) {
538 int modifiers
= mouse
.getModifiersEx();
539 boolean eventMouse1
= false;
540 boolean eventMouse2
= false;
541 boolean eventMouse3
= false;
542 if ((modifiers
& MouseEvent
.BUTTON1_DOWN_MASK
) != 0) {
545 if ((modifiers
& MouseEvent
.BUTTON2_DOWN_MASK
) != 0) {
548 if ((modifiers
& MouseEvent
.BUTTON3_DOWN_MASK
) != 0) {
551 mouse1
= eventMouse1
;
552 mouse2
= eventMouse2
;
553 mouse3
= eventMouse3
;
554 int x
= screen
.textColumn(mouse
.getX());
555 int y
= screen
.textRow(mouse
.getY());
557 TMouseEvent mouseEvent
= new TMouseEvent(TMouseEvent
.Type
.MOUSE_MOTION
,
558 x
, y
, x
, y
, mouse1
, mouse2
, mouse3
, false, false);
560 synchronized (eventQueue
) {
561 eventQueue
.add(mouseEvent
);
563 synchronized (listener
) {
564 listener
.notifyAll();
569 * Pass mouse events into the event queue.
571 * @param mouse mouse event received
574 public void mouseMoved(final MouseEvent mouse
) {
575 int x
= screen
.textColumn(mouse
.getX());
576 int y
= screen
.textRow(mouse
.getY());
577 if ((x
== oldMouseX
) && (y
== oldMouseY
)) {
578 // Bail out, we've moved some pixels but not a whole text cell.
584 TMouseEvent mouseEvent
= new TMouseEvent(TMouseEvent
.Type
.MOUSE_MOTION
,
585 x
, y
, x
, y
, mouse1
, mouse2
, mouse3
, false, false);
587 synchronized (eventQueue
) {
588 eventQueue
.add(mouseEvent
);
590 synchronized (listener
) {
591 listener
.notifyAll();
596 * Pass mouse events into the event queue.
598 * @param mouse mouse event received
601 public void mouseClicked(final MouseEvent mouse
) {
606 * Pass mouse events into the event queue.
608 * @param mouse mouse event received
611 public void mouseEntered(final MouseEvent mouse
) {
616 * Pass mouse events into the event queue.
618 * @param mouse mouse event received
621 public void mouseExited(final MouseEvent mouse
) {
626 * Pass mouse events into the event queue.
628 * @param mouse mouse event received
631 public void mousePressed(final MouseEvent mouse
) {
632 int modifiers
= mouse
.getModifiersEx();
633 boolean eventMouse1
= false;
634 boolean eventMouse2
= false;
635 boolean eventMouse3
= false;
636 if ((modifiers
& MouseEvent
.BUTTON1_DOWN_MASK
) != 0) {
639 if ((modifiers
& MouseEvent
.BUTTON2_DOWN_MASK
) != 0) {
642 if ((modifiers
& MouseEvent
.BUTTON3_DOWN_MASK
) != 0) {
645 mouse1
= eventMouse1
;
646 mouse2
= eventMouse2
;
647 mouse3
= eventMouse3
;
648 int x
= screen
.textColumn(mouse
.getX());
649 int y
= screen
.textRow(mouse
.getY());
651 TMouseEvent mouseEvent
= new TMouseEvent(TMouseEvent
.Type
.MOUSE_DOWN
,
652 x
, y
, x
, y
, mouse1
, mouse2
, mouse3
, false, false);
654 synchronized (eventQueue
) {
655 eventQueue
.add(mouseEvent
);
657 synchronized (listener
) {
658 listener
.notifyAll();
663 * Pass mouse events into the event queue.
665 * @param mouse mouse event received
668 public void mouseReleased(final MouseEvent mouse
) {
669 int modifiers
= mouse
.getModifiersEx();
670 boolean eventMouse1
= false;
671 boolean eventMouse2
= false;
672 boolean eventMouse3
= false;
673 if ((modifiers
& MouseEvent
.BUTTON1_DOWN_MASK
) != 0) {
676 if ((modifiers
& MouseEvent
.BUTTON2_DOWN_MASK
) != 0) {
679 if ((modifiers
& MouseEvent
.BUTTON3_DOWN_MASK
) != 0) {
694 int x
= screen
.textColumn(mouse
.getX());
695 int y
= screen
.textRow(mouse
.getY());
697 TMouseEvent mouseEvent
= new TMouseEvent(TMouseEvent
.Type
.MOUSE_UP
,
698 x
, y
, x
, y
, eventMouse1
, eventMouse2
, eventMouse3
, false, false);
700 synchronized (eventQueue
) {
701 eventQueue
.add(mouseEvent
);
703 synchronized (listener
) {
704 listener
.notifyAll();
709 * Pass mouse events into the event queue.
711 * @param mouse mouse event received
714 public void mouseWheelMoved(final MouseWheelEvent mouse
) {
715 int modifiers
= mouse
.getModifiersEx();
716 boolean eventMouse1
= false;
717 boolean eventMouse2
= false;
718 boolean eventMouse3
= false;
719 boolean mouseWheelUp
= false;
720 boolean mouseWheelDown
= false;
721 if ((modifiers
& MouseEvent
.BUTTON1_DOWN_MASK
) != 0) {
724 if ((modifiers
& MouseEvent
.BUTTON2_DOWN_MASK
) != 0) {
727 if ((modifiers
& MouseEvent
.BUTTON3_DOWN_MASK
) != 0) {
730 mouse1
= eventMouse1
;
731 mouse2
= eventMouse2
;
732 mouse3
= eventMouse3
;
733 int x
= screen
.textColumn(mouse
.getX());
734 int y
= screen
.textRow(mouse
.getY());
735 if (mouse
.getWheelRotation() > 0) {
736 mouseWheelDown
= true;
738 if (mouse
.getWheelRotation() < 0) {
742 TMouseEvent mouseEvent
= new TMouseEvent(TMouseEvent
.Type
.MOUSE_DOWN
,
743 x
, y
, x
, y
, mouse1
, mouse2
, mouse3
, mouseWheelUp
, mouseWheelDown
);
745 synchronized (eventQueue
) {
746 eventQueue
.add(mouseEvent
);
748 synchronized (listener
) {
749 listener
.notifyAll();