2 * Jexer - Java Text User Interface
4 * The MIT License (MIT)
6 * Copyright (C) 2016 Kevin Lamonte
8 * Permission is hereby granted, free of charge, to any person obtaining a
9 * copy of this software and associated documentation files (the "Software"),
10 * to deal in the Software without restriction, including without limitation
11 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
12 * and/or sell copies of the Software, and to permit persons to whom the
13 * Software is furnished to do so, subject to the following conditions:
15 * The above copyright notice and this permission notice shall be included in
16 * all copies or substantial portions of the Software.
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
21 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
23 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
24 * DEALINGS IN THE SOFTWARE.
26 * @author Kevin Lamonte [kevin.lamonte@gmail.com]
31 import java
.io
.BufferedReader
;
32 import java
.io
.FileDescriptor
;
33 import java
.io
.FileInputStream
;
34 import java
.io
.InputStream
;
35 import java
.io
.InputStreamReader
;
36 import java
.io
.IOException
;
37 import java
.io
.OutputStream
;
38 import java
.io
.OutputStreamWriter
;
39 import java
.io
.PrintWriter
;
40 import java
.io
.Reader
;
41 import java
.io
.UnsupportedEncodingException
;
42 import java
.util
.ArrayList
;
43 import java
.util
.Date
;
44 import java
.util
.List
;
45 import java
.util
.LinkedList
;
47 import jexer
.bits
.Color
;
48 import jexer
.event
.TInputEvent
;
49 import jexer
.event
.TKeypressEvent
;
50 import jexer
.event
.TMouseEvent
;
51 import jexer
.event
.TResizeEvent
;
52 import jexer
.session
.SessionInfo
;
53 import jexer
.session
.TSessionInfo
;
54 import jexer
.session
.TTYSessionInfo
;
55 import static jexer
.TKeypress
.*;
58 * This class reads keystrokes and mouse events and emits output to ANSI
59 * X3.64 / ECMA-48 type terminals e.g. xterm, linux, vt100, ansi.sys, etc.
61 public final class ECMA48Terminal
implements Runnable
{
64 * The session information.
66 private SessionInfo sessionInfo
;
69 * Getter for sessionInfo.
71 * @return the SessionInfo
73 public SessionInfo
getSessionInfo() {
78 * The event queue, filled up by a thread reading on input.
80 private List
<TInputEvent
> eventQueue
;
83 * If true, we want the reader thread to exit gracefully.
85 private boolean stopReaderThread
;
90 private Thread readerThread
;
93 * Parameters being collected. E.g. if the string is \033[1;3m, then
94 * params[0] will be 1 and params[1] will be 3.
96 private ArrayList
<String
> params
;
99 * States in the input parser.
101 private enum ParseState
{
112 * Current parsing state.
114 private ParseState state
;
117 * The time we entered ESCAPE. If we get a bare escape without a code
118 * following it, this is used to return that bare escape.
120 private long escapeTime
;
123 * The time we last checked the window size. We try not to spawn stty
124 * more than once per second.
126 private long windowSizeTime
;
129 * true if mouse1 was down. Used to report mouse1 on the release event.
131 private boolean mouse1
;
134 * true if mouse2 was down. Used to report mouse2 on the release event.
136 private boolean mouse2
;
139 * true if mouse3 was down. Used to report mouse3 on the release event.
141 private boolean mouse3
;
144 * Cache the cursor visibility value so we only emit the sequence when we
147 private boolean cursorOn
= true;
150 * Cache the last window size to figure out if a TResizeEvent needs to be
153 private TResizeEvent windowResize
= null;
156 * If true, then we changed System.in and need to change it back.
158 private boolean setRawMode
;
161 * The terminal's input. If an InputStream is not specified in the
162 * constructor, then this InputStreamReader will be bound to System.in
163 * with UTF-8 encoding.
165 private Reader input
;
168 * The terminal's raw InputStream. If an InputStream is not specified in
169 * the constructor, then this InputReader will be bound to System.in.
170 * This is used by run() to see if bytes are available() before calling
171 * (Reader)input.read().
173 private InputStream inputStream
;
176 * The terminal's output. If an OutputStream is not specified in the
177 * constructor, then this PrintWriter will be bound to System.out with
180 private PrintWriter output
;
183 * The listening object that run() wakes up on new input.
185 private Object listener
;
188 * Get the output writer.
192 public PrintWriter
getOutput() {
197 * Check if there are events in the queue.
199 * @return if true, getEvents() has something to return to the backend
201 public boolean hasEvents() {
202 synchronized (eventQueue
) {
203 return (eventQueue
.size() > 0);
208 * Call 'stty' to set cooked mode.
210 * <p>Actually executes '/bin/sh -c stty sane cooked < /dev/tty'
212 private void sttyCooked() {
217 * Call 'stty' to set raw mode.
219 * <p>Actually executes '/bin/sh -c stty -ignbrk -brkint -parmrk -istrip
220 * -inlcr -igncr -icrnl -ixon -opost -echo -echonl -icanon -isig -iexten
221 * -parenb cs8 min 1 < /dev/tty'
223 private void sttyRaw() {
228 * Call 'stty' to set raw or cooked mode.
230 * @param mode if true, set raw mode, otherwise set cooked mode
232 private void doStty(final boolean mode
) {
234 "/bin/sh", "-c", "stty -ignbrk -brkint -parmrk -istrip -inlcr -igncr -icrnl -ixon -opost -echo -echonl -icanon -isig -iexten -parenb cs8 min 1 < /dev/tty"
236 String
[] cmdCooked
= {
237 "/bin/sh", "-c", "stty sane cooked < /dev/tty"
242 process
= Runtime
.getRuntime().exec(cmdRaw
);
244 process
= Runtime
.getRuntime().exec(cmdCooked
);
246 BufferedReader in
= new BufferedReader(new InputStreamReader(process
.getInputStream(), "UTF-8"));
247 String line
= in
.readLine();
248 if ((line
!= null) && (line
.length() > 0)) {
249 System
.err
.println("WEIRD?! Normal output from stty: " + line
);
252 BufferedReader err
= new BufferedReader(new InputStreamReader(process
.getErrorStream(), "UTF-8"));
253 line
= err
.readLine();
254 if ((line
!= null) && (line
.length() > 0)) {
255 System
.err
.println("Error output from stty: " + line
);
260 } catch (InterruptedException e
) {
264 int rc
= process
.exitValue();
266 System
.err
.println("stty returned error code: " + rc
);
268 } catch (IOException e
) {
274 * Constructor sets up state for getEvent().
276 * @param listener the object this backend needs to wake up when new
278 * @param input an InputStream connected to the remote user, or null for
279 * System.in. If System.in is used, then on non-Windows systems it will
280 * be put in raw mode; shutdown() will (blindly!) put System.in in cooked
281 * mode. input is always converted to a Reader with UTF-8 encoding.
282 * @param output an OutputStream connected to the remote user, or null
283 * for System.out. output is always converted to a Writer with UTF-8
285 * @throws UnsupportedEncodingException if an exception is thrown when
286 * creating the InputStreamReader
288 public ECMA48Terminal(final Object listener
, final InputStream input
,
289 final OutputStream output
) throws UnsupportedEncodingException
{
295 stopReaderThread
= false;
296 this.listener
= listener
;
299 // inputStream = System.in;
300 inputStream
= new FileInputStream(FileDescriptor
.in
);
306 this.input
= new InputStreamReader(inputStream
, "UTF-8");
308 if (input
instanceof SessionInfo
) {
309 // This is a TelnetInputStream that exposes window size and
310 // environment variables from the telnet layer.
311 sessionInfo
= (SessionInfo
) input
;
313 if (sessionInfo
== null) {
315 // Reading right off the tty
316 sessionInfo
= new TTYSessionInfo();
318 sessionInfo
= new TSessionInfo();
322 if (output
== null) {
323 this.output
= new PrintWriter(new OutputStreamWriter(System
.out
,
326 this.output
= new PrintWriter(new OutputStreamWriter(output
,
330 // Enable mouse reporting and metaSendsEscape
331 this.output
.printf("%s%s", mouse(true), xtermMetaSendsEscape(true));
334 // Hang onto the window size
335 windowResize
= new TResizeEvent(TResizeEvent
.Type
.SCREEN
,
336 sessionInfo
.getWindowWidth(), sessionInfo
.getWindowHeight());
338 // Spin up the input reader
339 eventQueue
= new LinkedList
<TInputEvent
>();
340 readerThread
= new Thread(this);
341 readerThread
.start();
345 * Constructor sets up state for getEvent().
347 * @param listener the object this backend needs to wake up when new
349 * @param input the InputStream underlying 'reader'. Its available()
350 * method is used to determine if reader.read() will block or not.
351 * @param reader a Reader connected to the remote user.
352 * @param writer a PrintWriter connected to the remote user.
353 * @param setRawMode if true, set System.in into raw mode with stty.
354 * This should in general not be used. It is here solely for Demo3,
355 * which uses System.in.
356 * @throws IllegalArgumentException if input, reader, or writer are null.
358 public ECMA48Terminal(final Object listener
, final InputStream input
,
359 final Reader reader
, final PrintWriter writer
,
360 final boolean setRawMode
) {
363 throw new IllegalArgumentException("InputStream must be specified");
365 if (reader
== null) {
366 throw new IllegalArgumentException("Reader must be specified");
368 if (writer
== null) {
369 throw new IllegalArgumentException("Writer must be specified");
375 stopReaderThread
= false;
376 this.listener
= listener
;
381 if (setRawMode
== true) {
384 this.setRawMode
= setRawMode
;
386 if (input
instanceof SessionInfo
) {
387 // This is a TelnetInputStream that exposes window size and
388 // environment variables from the telnet layer.
389 sessionInfo
= (SessionInfo
) input
;
391 if (sessionInfo
== null) {
392 sessionInfo
= new TSessionInfo();
395 this.output
= writer
;
397 // Enable mouse reporting and metaSendsEscape
398 this.output
.printf("%s%s", mouse(true), xtermMetaSendsEscape(true));
401 // Hang onto the window size
402 windowResize
= new TResizeEvent(TResizeEvent
.Type
.SCREEN
,
403 sessionInfo
.getWindowWidth(), sessionInfo
.getWindowHeight());
405 // Spin up the input reader
406 eventQueue
= new LinkedList
<TInputEvent
>();
407 readerThread
= new Thread(this);
408 readerThread
.start();
412 * Constructor sets up state for getEvent().
414 * @param listener the object this backend needs to wake up when new
416 * @param input the InputStream underlying 'reader'. Its available()
417 * method is used to determine if reader.read() will block or not.
418 * @param reader a Reader connected to the remote user.
419 * @param writer a PrintWriter connected to the remote user.
420 * @throws IllegalArgumentException if input, reader, or writer are null.
422 public ECMA48Terminal(final Object listener
, final InputStream input
,
423 final Reader reader
, final PrintWriter writer
) {
425 this(listener
, input
, reader
, writer
, false);
429 * Restore terminal to normal state.
431 public void shutdown() {
433 // System.err.println("=== shutdown() ==="); System.err.flush();
435 // Tell the reader thread to stop looking at input
436 stopReaderThread
= true;
439 } catch (InterruptedException e
) {
443 // Disable mouse reporting and show cursor
444 output
.printf("%s%s%s", mouse(false), cursor(true), normal());
450 // We don't close System.in/out
452 // Shut down the streams, this should wake up the reader thread
459 if (output
!= null) {
463 } catch (IOException e
) {
472 public void flush() {
477 * Reset keyboard/mouse input parser.
479 private void reset() {
480 state
= ParseState
.GROUND
;
481 params
= new ArrayList
<String
>();
487 * Produce a control character or one of the special ones (ENTER, TAB,
490 * @param ch Unicode code point
491 * @param alt if true, set alt on the TKeypress
492 * @return one TKeypress event, either a control character (e.g. isKey ==
493 * false, ch == 'A', ctrl == true), or a special key (e.g. isKey == true,
496 private TKeypressEvent
controlChar(final char ch
, final boolean alt
) {
497 // System.err.printf("controlChar: %02x\n", ch);
501 // Carriage return --> ENTER
502 return new TKeypressEvent(kbEnter
, alt
, false, false);
504 // Linefeed --> ENTER
505 return new TKeypressEvent(kbEnter
, alt
, false, false);
508 return new TKeypressEvent(kbEsc
, alt
, false, false);
511 return new TKeypressEvent(kbTab
, alt
, false, false);
513 // Make all other control characters come back as the alphabetic
514 // character with the ctrl field set. So SOH would be 'A' +
516 return new TKeypressEvent(false, 0, (char)(ch
+ 0x40),
522 * Produce special key from CSI Pn ; Pm ; ... ~
524 * @return one KEYPRESS event representing a special key
526 private TInputEvent
csiFnKey() {
528 if (params
.size() > 0) {
529 key
= Integer
.parseInt(params
.get(0));
532 boolean ctrl
= false;
533 boolean shift
= false;
534 if (params
.size() > 1) {
535 shift
= csiIsShift(params
.get(1));
536 alt
= csiIsAlt(params
.get(1));
537 ctrl
= csiIsCtrl(params
.get(1));
542 return new TKeypressEvent(kbHome
, alt
, ctrl
, shift
);
544 return new TKeypressEvent(kbIns
, alt
, ctrl
, shift
);
546 return new TKeypressEvent(kbDel
, alt
, ctrl
, shift
);
548 return new TKeypressEvent(kbEnd
, alt
, ctrl
, shift
);
550 return new TKeypressEvent(kbPgUp
, alt
, ctrl
, shift
);
552 return new TKeypressEvent(kbPgDn
, alt
, ctrl
, shift
);
554 return new TKeypressEvent(kbF5
, alt
, ctrl
, shift
);
556 return new TKeypressEvent(kbF6
, alt
, ctrl
, shift
);
558 return new TKeypressEvent(kbF7
, alt
, ctrl
, shift
);
560 return new TKeypressEvent(kbF8
, alt
, ctrl
, shift
);
562 return new TKeypressEvent(kbF9
, alt
, ctrl
, shift
);
564 return new TKeypressEvent(kbF10
, alt
, ctrl
, shift
);
566 return new TKeypressEvent(kbF11
, alt
, ctrl
, shift
);
568 return new TKeypressEvent(kbF12
, alt
, ctrl
, shift
);
576 * Produce mouse events based on "Any event tracking" and UTF-8
578 * http://invisible-island.net/xterm/ctlseqs/ctlseqs.html#Mouse%20Tracking
580 * @return a MOUSE_MOTION, MOUSE_UP, or MOUSE_DOWN event
582 private TInputEvent
parseMouse() {
583 int buttons
= params
.get(0).charAt(0) - 32;
584 int x
= params
.get(0).charAt(1) - 32 - 1;
585 int y
= params
.get(0).charAt(2) - 32 - 1;
587 // Clamp X and Y to the physical screen coordinates.
588 if (x
>= windowResize
.getWidth()) {
589 x
= windowResize
.getWidth() - 1;
591 if (y
>= windowResize
.getHeight()) {
592 y
= windowResize
.getHeight() - 1;
595 TMouseEvent
.Type eventType
= TMouseEvent
.Type
.MOUSE_DOWN
;
596 boolean eventMouse1
= false;
597 boolean eventMouse2
= false;
598 boolean eventMouse3
= false;
599 boolean eventMouseWheelUp
= false;
600 boolean eventMouseWheelDown
= false;
602 // System.err.printf("buttons: %04x\r\n", buttons);
619 if (!mouse1
&& !mouse2
&& !mouse3
) {
620 eventType
= TMouseEvent
.Type
.MOUSE_MOTION
;
622 eventType
= TMouseEvent
.Type
.MOUSE_UP
;
639 // Dragging with mouse1 down
642 eventType
= TMouseEvent
.Type
.MOUSE_MOTION
;
646 // Dragging with mouse2 down
649 eventType
= TMouseEvent
.Type
.MOUSE_MOTION
;
653 // Dragging with mouse3 down
656 eventType
= TMouseEvent
.Type
.MOUSE_MOTION
;
660 // Dragging with mouse2 down after wheelUp
663 eventType
= TMouseEvent
.Type
.MOUSE_MOTION
;
667 // Dragging with mouse2 down after wheelDown
670 eventType
= TMouseEvent
.Type
.MOUSE_MOTION
;
674 eventMouseWheelUp
= true;
678 eventMouseWheelDown
= true;
682 // Unknown, just make it motion
683 eventType
= TMouseEvent
.Type
.MOUSE_MOTION
;
686 return new TMouseEvent(eventType
, x
, y
, x
, y
,
687 eventMouse1
, eventMouse2
, eventMouse3
,
688 eventMouseWheelUp
, eventMouseWheelDown
);
692 * Produce mouse events based on "Any event tracking" and SGR
694 * http://invisible-island.net/xterm/ctlseqs/ctlseqs.html#Mouse%20Tracking
696 * @param release if true, this was a release ('m')
697 * @return a MOUSE_MOTION, MOUSE_UP, or MOUSE_DOWN event
699 private TInputEvent
parseMouseSGR(final boolean release
) {
700 // SGR extended coordinates - mode 1006
701 if (params
.size() < 3) {
702 // Invalid position, bail out.
705 int buttons
= Integer
.parseInt(params
.get(0));
706 int x
= Integer
.parseInt(params
.get(1)) - 1;
707 int y
= Integer
.parseInt(params
.get(2)) - 1;
709 // Clamp X and Y to the physical screen coordinates.
710 if (x
>= windowResize
.getWidth()) {
711 x
= windowResize
.getWidth() - 1;
713 if (y
>= windowResize
.getHeight()) {
714 y
= windowResize
.getHeight() - 1;
717 TMouseEvent
.Type eventType
= TMouseEvent
.Type
.MOUSE_DOWN
;
718 boolean eventMouse1
= false;
719 boolean eventMouse2
= false;
720 boolean eventMouse3
= false;
721 boolean eventMouseWheelUp
= false;
722 boolean eventMouseWheelDown
= false;
725 eventType
= TMouseEvent
.Type
.MOUSE_UP
;
739 // Motion only, no buttons down
740 eventType
= TMouseEvent
.Type
.MOUSE_MOTION
;
744 // Dragging with mouse1 down
746 eventType
= TMouseEvent
.Type
.MOUSE_MOTION
;
750 // Dragging with mouse2 down
752 eventType
= TMouseEvent
.Type
.MOUSE_MOTION
;
756 // Dragging with mouse3 down
758 eventType
= TMouseEvent
.Type
.MOUSE_MOTION
;
762 // Dragging with mouse2 down after wheelUp
764 eventType
= TMouseEvent
.Type
.MOUSE_MOTION
;
768 // Dragging with mouse2 down after wheelDown
770 eventType
= TMouseEvent
.Type
.MOUSE_MOTION
;
774 eventMouseWheelUp
= true;
778 eventMouseWheelDown
= true;
785 return new TMouseEvent(eventType
, x
, y
, x
, y
,
786 eventMouse1
, eventMouse2
, eventMouse3
,
787 eventMouseWheelUp
, eventMouseWheelDown
);
791 * Return any events in the IO queue.
793 * @param queue list to append new events to
795 public void getEvents(final List
<TInputEvent
> queue
) {
796 synchronized (eventQueue
) {
797 if (eventQueue
.size() > 0) {
798 synchronized (queue
) {
799 queue
.addAll(eventQueue
);
807 * Return any events in the IO queue due to timeout.
809 * @param queue list to append new events to
811 private void getIdleEvents(final List
<TInputEvent
> queue
) {
812 Date now
= new Date();
814 // Check for new window size
815 long windowSizeDelay
= now
.getTime() - windowSizeTime
;
816 if (windowSizeDelay
> 1000) {
817 sessionInfo
.queryWindowSize();
818 int newWidth
= sessionInfo
.getWindowWidth();
819 int newHeight
= sessionInfo
.getWindowHeight();
820 if ((newWidth
!= windowResize
.getWidth())
821 || (newHeight
!= windowResize
.getHeight())
823 TResizeEvent event
= new TResizeEvent(TResizeEvent
.Type
.SCREEN
,
824 newWidth
, newHeight
);
825 windowResize
= new TResizeEvent(TResizeEvent
.Type
.SCREEN
,
826 newWidth
, newHeight
);
829 windowSizeTime
= now
.getTime();
832 // ESCDELAY type timeout
833 if (state
== ParseState
.ESCAPE
) {
834 long escDelay
= now
.getTime() - escapeTime
;
835 if (escDelay
> 100) {
836 // After 0.1 seconds, assume a true escape character
837 queue
.add(controlChar((char)0x1B, false));
844 * Returns true if the CSI parameter for a keyboard command means that
847 private boolean csiIsShift(final String x
) {
859 * Returns true if the CSI parameter for a keyboard command means that
862 private boolean csiIsAlt(final String x
) {
874 * Returns true if the CSI parameter for a keyboard command means that
877 private boolean csiIsCtrl(final String x
) {
889 * Parses the next character of input to see if an InputEvent is
892 * @param events list to append new events to
893 * @param ch Unicode code point
895 private void processChar(final List
<TInputEvent
> events
, final char ch
) {
897 // ESCDELAY type timeout
898 Date now
= new Date();
899 if (state
== ParseState
.ESCAPE
) {
900 long escDelay
= now
.getTime() - escapeTime
;
901 if (escDelay
> 250) {
902 // After 0.25 seconds, assume a true escape character
903 events
.add(controlChar((char)0x1B, false));
909 boolean ctrl
= false;
911 boolean shift
= false;
913 // System.err.printf("state: %s ch %c\r\n", state, ch);
919 state
= ParseState
.ESCAPE
;
920 escapeTime
= now
.getTime();
926 events
.add(controlChar(ch
, false));
933 events
.add(new TKeypressEvent(false, 0, ch
,
934 false, false, false));
943 // ALT-Control character
944 events
.add(controlChar(ch
, true));
950 // This will be one of the function keys
951 state
= ParseState
.ESCAPE_INTERMEDIATE
;
955 // '[' goes to CSI_ENTRY
957 state
= ParseState
.CSI_ENTRY
;
961 // Everything else is assumed to be Alt-keystroke
962 if ((ch
>= 'A') && (ch
<= 'Z')) {
966 events
.add(new TKeypressEvent(false, 0, ch
, alt
, ctrl
, shift
));
970 case ESCAPE_INTERMEDIATE
:
971 if ((ch
>= 'P') && (ch
<= 'S')) {
975 events
.add(new TKeypressEvent(kbF1
));
978 events
.add(new TKeypressEvent(kbF2
));
981 events
.add(new TKeypressEvent(kbF3
));
984 events
.add(new TKeypressEvent(kbF4
));
993 // Unknown keystroke, ignore
998 // Numbers - parameter values
999 if ((ch
>= '0') && (ch
<= '9')) {
1000 params
.set(params
.size() - 1,
1001 params
.get(params
.size() - 1) + ch
);
1002 state
= ParseState
.CSI_PARAM
;
1005 // Parameter separator
1011 if ((ch
>= 0x30) && (ch
<= 0x7E)) {
1015 events
.add(new TKeypressEvent(kbUp
, alt
, ctrl
, shift
));
1020 events
.add(new TKeypressEvent(kbDown
, alt
, ctrl
, shift
));
1025 events
.add(new TKeypressEvent(kbRight
, alt
, ctrl
, shift
));
1030 events
.add(new TKeypressEvent(kbLeft
, alt
, ctrl
, shift
));
1035 events
.add(new TKeypressEvent(kbHome
));
1040 events
.add(new TKeypressEvent(kbEnd
));
1044 // CBT - Cursor backward X tab stops (default 1)
1045 events
.add(new TKeypressEvent(kbBackTab
));
1050 state
= ParseState
.MOUSE
;
1053 // Mouse position, SGR (1006) coordinates
1054 state
= ParseState
.MOUSE_SGR
;
1061 // Unknown keystroke, ignore
1066 // Numbers - parameter values
1067 if ((ch
>= '0') && (ch
<= '9')) {
1068 params
.set(params
.size() - 1,
1069 params
.get(params
.size() - 1) + ch
);
1072 // Parameter separator
1080 // Generate a mouse press event
1081 TInputEvent event
= parseMouseSGR(false);
1082 if (event
!= null) {
1088 // Generate a mouse release event
1089 event
= parseMouseSGR(true);
1090 if (event
!= null) {
1099 // Unknown keystroke, ignore
1104 // Numbers - parameter values
1105 if ((ch
>= '0') && (ch
<= '9')) {
1106 params
.set(params
.size() - 1,
1107 params
.get(params
.size() - 1) + ch
);
1108 state
= ParseState
.CSI_PARAM
;
1111 // Parameter separator
1118 events
.add(csiFnKey());
1123 if ((ch
>= 0x30) && (ch
<= 0x7E)) {
1127 if (params
.size() > 1) {
1128 shift
= csiIsShift(params
.get(1));
1129 alt
= csiIsAlt(params
.get(1));
1130 ctrl
= csiIsCtrl(params
.get(1));
1132 events
.add(new TKeypressEvent(kbUp
, alt
, ctrl
, shift
));
1137 if (params
.size() > 1) {
1138 shift
= csiIsShift(params
.get(1));
1139 alt
= csiIsAlt(params
.get(1));
1140 ctrl
= csiIsCtrl(params
.get(1));
1142 events
.add(new TKeypressEvent(kbDown
, alt
, ctrl
, shift
));
1147 if (params
.size() > 1) {
1148 shift
= csiIsShift(params
.get(1));
1149 alt
= csiIsAlt(params
.get(1));
1150 ctrl
= csiIsCtrl(params
.get(1));
1152 events
.add(new TKeypressEvent(kbRight
, alt
, ctrl
, shift
));
1157 if (params
.size() > 1) {
1158 shift
= csiIsShift(params
.get(1));
1159 alt
= csiIsAlt(params
.get(1));
1160 ctrl
= csiIsCtrl(params
.get(1));
1162 events
.add(new TKeypressEvent(kbLeft
, alt
, ctrl
, shift
));
1167 if (params
.size() > 1) {
1168 shift
= csiIsShift(params
.get(1));
1169 alt
= csiIsAlt(params
.get(1));
1170 ctrl
= csiIsCtrl(params
.get(1));
1172 events
.add(new TKeypressEvent(kbHome
, alt
, ctrl
, shift
));
1177 if (params
.size() > 1) {
1178 shift
= csiIsShift(params
.get(1));
1179 alt
= csiIsAlt(params
.get(1));
1180 ctrl
= csiIsCtrl(params
.get(1));
1182 events
.add(new TKeypressEvent(kbEnd
, alt
, ctrl
, shift
));
1190 // Unknown keystroke, ignore
1195 params
.set(0, params
.get(params
.size() - 1) + ch
);
1196 if (params
.get(0).length() == 3) {
1197 // We have enough to generate a mouse event
1198 events
.add(parseMouse());
1207 // This "should" be impossible to reach
1212 * Tell (u)xterm that we want alt- keystrokes to send escape + character
1213 * rather than set the 8th bit. Anyone who wants UTF8 should want this
1216 * @param on if true, enable metaSendsEscape
1217 * @return the string to emit to xterm
1219 private String
xtermMetaSendsEscape(final boolean on
) {
1221 return "\033[?1036h\033[?1034l";
1223 return "\033[?1036l";
1227 * Create a SGR parameter sequence for a single color change. Note
1228 * package private access.
1230 * @param color one of the Color.WHITE, Color.BLUE, etc. constants
1231 * @param foreground if true, this is a foreground color
1232 * @return the string to emit to an ANSI / ECMA-style terminal,
1235 String
color(final Color color
, final boolean foreground
) {
1236 return color(color
, foreground
, true);
1240 * Create a SGR parameter sequence for a single color change.
1242 * @param color one of the Color.WHITE, Color.BLUE, etc. constants
1243 * @param foreground if true, this is a foreground color
1244 * @param header if true, make the full header, otherwise just emit the
1245 * color parameter e.g. "42;"
1246 * @return the string to emit to an ANSI / ECMA-style terminal,
1249 private String
color(final Color color
, final boolean foreground
,
1250 final boolean header
) {
1252 int ecmaColor
= color
.getValue();
1254 // Convert Color.* values to SGR numerics
1262 return String
.format("\033[%dm", ecmaColor
);
1264 return String
.format("%d;", ecmaColor
);
1269 * Create a SGR parameter sequence for both foreground and background
1270 * color change. Note package private access.
1272 * @param foreColor one of the Color.WHITE, Color.BLUE, etc. constants
1273 * @param backColor one of the Color.WHITE, Color.BLUE, etc. constants
1274 * @return the string to emit to an ANSI / ECMA-style terminal,
1275 * e.g. "\033[31;42m"
1277 String
color(final Color foreColor
, final Color backColor
) {
1278 return color(foreColor
, backColor
, true);
1282 * Create a SGR parameter sequence for both foreground and
1283 * background color change.
1285 * @param foreColor one of the Color.WHITE, Color.BLUE, etc. constants
1286 * @param backColor one of the Color.WHITE, Color.BLUE, etc. constants
1287 * @param header if true, make the full header, otherwise just emit the
1288 * color parameter e.g. "31;42;"
1289 * @return the string to emit to an ANSI / ECMA-style terminal,
1290 * e.g. "\033[31;42m"
1292 private String
color(final Color foreColor
, final Color backColor
,
1293 final boolean header
) {
1295 int ecmaForeColor
= foreColor
.getValue();
1296 int ecmaBackColor
= backColor
.getValue();
1298 // Convert Color.* values to SGR numerics
1299 ecmaBackColor
+= 40;
1300 ecmaForeColor
+= 30;
1303 return String
.format("\033[%d;%dm", ecmaForeColor
, ecmaBackColor
);
1305 return String
.format("%d;%d;", ecmaForeColor
, ecmaBackColor
);
1310 * Create a SGR parameter sequence for foreground, background, and
1311 * several attributes. This sequence first resets all attributes to
1312 * default, then sets attributes as per the parameters. Note package
1315 * @param foreColor one of the Color.WHITE, Color.BLUE, etc. constants
1316 * @param backColor one of the Color.WHITE, Color.BLUE, etc. constants
1317 * @param bold if true, set bold
1318 * @param reverse if true, set reverse
1319 * @param blink if true, set blink
1320 * @param underline if true, set underline
1321 * @return the string to emit to an ANSI / ECMA-style terminal,
1322 * e.g. "\033[0;1;31;42m"
1324 String
color(final Color foreColor
, final Color backColor
,
1325 final boolean bold
, final boolean reverse
, final boolean blink
,
1326 final boolean underline
) {
1328 int ecmaForeColor
= foreColor
.getValue();
1329 int ecmaBackColor
= backColor
.getValue();
1331 // Convert Color.* values to SGR numerics
1332 ecmaBackColor
+= 40;
1333 ecmaForeColor
+= 30;
1335 StringBuilder sb
= new StringBuilder();
1336 if ( bold
&& reverse
&& blink
&& !underline
) {
1337 sb
.append("\033[0;1;7;5;");
1338 } else if ( bold
&& reverse
&& !blink
&& !underline
) {
1339 sb
.append("\033[0;1;7;");
1340 } else if ( !bold
&& reverse
&& blink
&& !underline
) {
1341 sb
.append("\033[0;7;5;");
1342 } else if ( bold
&& !reverse
&& blink
&& !underline
) {
1343 sb
.append("\033[0;1;5;");
1344 } else if ( bold
&& !reverse
&& !blink
&& !underline
) {
1345 sb
.append("\033[0;1;");
1346 } else if ( !bold
&& reverse
&& !blink
&& !underline
) {
1347 sb
.append("\033[0;7;");
1348 } else if ( !bold
&& !reverse
&& blink
&& !underline
) {
1349 sb
.append("\033[0;5;");
1350 } else if ( bold
&& reverse
&& blink
&& underline
) {
1351 sb
.append("\033[0;1;7;5;4;");
1352 } else if ( bold
&& reverse
&& !blink
&& underline
) {
1353 sb
.append("\033[0;1;7;4;");
1354 } else if ( !bold
&& reverse
&& blink
&& underline
) {
1355 sb
.append("\033[0;7;5;4;");
1356 } else if ( bold
&& !reverse
&& blink
&& underline
) {
1357 sb
.append("\033[0;1;5;4;");
1358 } else if ( bold
&& !reverse
&& !blink
&& underline
) {
1359 sb
.append("\033[0;1;4;");
1360 } else if ( !bold
&& reverse
&& !blink
&& underline
) {
1361 sb
.append("\033[0;7;4;");
1362 } else if ( !bold
&& !reverse
&& blink
&& underline
) {
1363 sb
.append("\033[0;5;4;");
1364 } else if ( !bold
&& !reverse
&& !blink
&& underline
) {
1365 sb
.append("\033[0;4;");
1367 assert (!bold
&& !reverse
&& !blink
&& !underline
);
1368 sb
.append("\033[0;");
1370 sb
.append(String
.format("%d;%dm", ecmaForeColor
, ecmaBackColor
));
1371 return sb
.toString();
1375 * Create a SGR parameter sequence to reset to defaults. Note package
1378 * @return the string to emit to an ANSI / ECMA-style terminal,
1382 return normal(true);
1386 * Create a SGR parameter sequence to reset to defaults.
1388 * @param header if true, make the full header, otherwise just emit the
1389 * bare parameter e.g. "0;"
1390 * @return the string to emit to an ANSI / ECMA-style terminal,
1393 private String
normal(final boolean header
) {
1395 return "\033[0;37;40m";
1401 * Create a SGR parameter sequence for enabling the visible cursor. Note
1402 * package private access.
1404 * @param on if true, turn on cursor
1405 * @return the string to emit to an ANSI / ECMA-style terminal
1407 String
cursor(final boolean on
) {
1408 if (on
&& !cursorOn
) {
1412 if (!on
&& cursorOn
) {
1420 * Clear the entire screen. Because some terminals use back-color-erase,
1421 * set the color to white-on-black beforehand.
1423 * @return the string to emit to an ANSI / ECMA-style terminal
1425 public String
clearAll() {
1426 return "\033[0;37;40m\033[2J";
1430 * Clear the line from the cursor (inclusive) to the end of the screen.
1431 * Because some terminals use back-color-erase, set the color to
1432 * white-on-black beforehand. Note package private access.
1434 * @return the string to emit to an ANSI / ECMA-style terminal
1436 String
clearRemainingLine() {
1437 return "\033[0;37;40m\033[K";
1441 * Move the cursor to (x, y). Note package private access.
1443 * @param x column coordinate. 0 is the left-most column.
1444 * @param y row coordinate. 0 is the top-most row.
1445 * @return the string to emit to an ANSI / ECMA-style terminal
1447 String
gotoXY(final int x
, final int y
) {
1448 return String
.format("\033[%d;%dH", y
+ 1, x
+ 1);
1452 * Tell (u)xterm that we want to receive mouse events based on "Any event
1453 * tracking", UTF-8 coordinates, and then SGR coordinates. Ideally we
1454 * will end up with SGR coordinates with UTF-8 coordinates as a fallback.
1456 * http://invisible-island.net/xterm/ctlseqs/ctlseqs.html#Mouse%20Tracking
1458 * Note that this also sets the alternate/primary screen buffer.
1460 * @param on If true, enable mouse report and use the alternate screen
1461 * buffer. If false disable mouse reporting and use the primary screen
1463 * @return the string to emit to xterm
1465 private String
mouse(final boolean on
) {
1467 return "\033[?1002;1003;1005;1006h\033[?1049h";
1469 return "\033[?1002;1003;1006;1005l\033[?1049l";
1473 * Read function runs on a separate thread.
1476 boolean done
= false;
1477 // available() will often return > 1, so we need to read in chunks to
1479 char [] readBuffer
= new char[128];
1480 List
<TInputEvent
> events
= new LinkedList
<TInputEvent
>();
1482 while (!done
&& !stopReaderThread
) {
1484 // We assume that if inputStream has bytes available, then
1485 // input won't block on read().
1486 int n
= inputStream
.available();
1488 if (readBuffer
.length
< n
) {
1489 // The buffer wasn't big enough, make it huger
1490 readBuffer
= new char[readBuffer
.length
* 2];
1493 int rc
= input
.read(readBuffer
, 0, readBuffer
.length
);
1494 // System.err.printf("read() %d", rc); System.err.flush();
1499 for (int i
= 0; i
< rc
; i
++) {
1500 int ch
= readBuffer
[i
];
1501 processChar(events
, (char)ch
);
1503 getIdleEvents(events
);
1504 if (events
.size() > 0) {
1505 // Add to the queue for the backend thread to
1506 // be able to obtain.
1507 synchronized (eventQueue
) {
1508 eventQueue
.addAll(events
);
1510 synchronized (listener
) {
1511 listener
.notifyAll();
1517 getIdleEvents(events
);
1518 if (events
.size() > 0) {
1519 synchronized (eventQueue
) {
1520 eventQueue
.addAll(events
);
1523 synchronized (listener
) {
1524 listener
.notifyAll();
1528 // Wait 10 millis for more data
1531 // System.err.println("end while loop"); System.err.flush();
1532 } catch (InterruptedException e
) {
1534 } catch (IOException e
) {
1535 e
.printStackTrace();
1538 } // while ((done == false) && (stopReaderThread == false))
1539 // System.err.println("*** run() exiting..."); System.err.flush();