Jexer image protocol performance
[fanfix.git] / src / jexer / tterminal / ECMA48.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.tterminal;
30
31 import java.awt.Graphics2D;
32 import java.awt.image.BufferedImage;
33 import java.io.BufferedInputStream;
34 import java.io.BufferedOutputStream;
35 import java.io.ByteArrayInputStream;
36 import java.io.CharArrayWriter;
37 import java.io.InputStream;
38 import java.io.InputStreamReader;
39 import java.io.IOException;
40 import java.io.OutputStream;
41 import java.io.OutputStreamWriter;
42 import java.io.PrintWriter;
43 import java.io.Reader;
44 import java.io.UnsupportedEncodingException;
45 import java.io.Writer;
46 import java.util.ArrayList;
47 import java.util.Collections;
48 import java.util.HashMap;
49 import java.util.List;
50 import javax.imageio.ImageIO;
51
52 import jexer.TKeypress;
53 import jexer.backend.GlyphMaker;
54 import jexer.bits.Color;
55 import jexer.bits.Cell;
56 import jexer.bits.CellAttributes;
57 import jexer.bits.StringUtils;
58 import jexer.event.TInputEvent;
59 import jexer.event.TKeypressEvent;
60 import jexer.event.TMouseEvent;
61 import jexer.io.ReadTimeoutException;
62 import jexer.io.TimeoutInputStream;
63 import static jexer.TKeypress.*;
64
65 /**
66 * This implements a complex ECMA-48/ISO 6429/ANSI X3.64 type console,
67 * including a scrollback buffer.
68 *
69 * <p>
70 * It currently implements VT100, VT102, VT220, and XTERM with the following
71 * caveats:
72 *
73 * <p>
74 * - The vttest scenario for VT220 8-bit controls (11.1.2.3) reports a
75 * failure with XTERM. This is due to vttest failing to decode the UTF-8
76 * stream.
77 *
78 * <p>
79 * - Smooth scrolling, printing, keyboard locking, keyboard leds, and tests
80 * from VT100 are not supported.
81 *
82 * <p>
83 * - User-defined keys (DECUDK), downloadable fonts (DECDLD), and VT100/ANSI
84 * compatibility mode (DECSCL) from VT220 are not supported. (Also,
85 * because DECSCL is not supported, it will fail the last part of the
86 * vttest "Test of VT52 mode" if DeviceType is set to VT220.)
87 *
88 * <p>
89 * - Numeric/application keys from the number pad are not supported because
90 * they are not exposed from the TKeypress API.
91 *
92 * <p>
93 * - VT52 HOLD SCREEN mode is not supported.
94 *
95 * <p>
96 * - In VT52 graphics mode, the 3/, 5/, and 7/ characters (fraction
97 * numerators) are not rendered correctly.
98 *
99 * <p>
100 * - All data meant for the 'printer' (CSI Pc ? i) is discarded.
101 */
102 public class ECMA48 implements Runnable {
103
104 // ------------------------------------------------------------------------
105 // Constants --------------------------------------------------------------
106 // ------------------------------------------------------------------------
107
108 /**
109 * The emulator can emulate several kinds of terminals.
110 */
111 public enum DeviceType {
112 /**
113 * DEC VT100 but also including the three VT102 functions.
114 */
115 VT100,
116
117 /**
118 * DEC VT102.
119 */
120 VT102,
121
122 /**
123 * DEC VT220.
124 */
125 VT220,
126
127 /**
128 * A subset of xterm.
129 */
130 XTERM
131 }
132
133 /**
134 * Parser character scan states.
135 */
136 private enum ScanState {
137 GROUND,
138 ESCAPE,
139 ESCAPE_INTERMEDIATE,
140 CSI_ENTRY,
141 CSI_PARAM,
142 CSI_INTERMEDIATE,
143 CSI_IGNORE,
144 DCS_ENTRY,
145 DCS_INTERMEDIATE,
146 DCS_PARAM,
147 DCS_PASSTHROUGH,
148 DCS_IGNORE,
149 DCS_SIXEL,
150 SOSPMAPC_STRING,
151 OSC_STRING,
152 VT52_DIRECT_CURSOR_ADDRESS
153 }
154
155 /**
156 * The selected number pad mode (DECKPAM, DECKPNM). We record this, but
157 * can't really use it in keypress() because we do not see number pad
158 * events from TKeypress.
159 */
160 private enum KeypadMode {
161 Application,
162 Numeric
163 }
164
165 /**
166 * Arrow keys can emit three different sequences (DECCKM or VT52
167 * submode).
168 */
169 private enum ArrowKeyMode {
170 VT52,
171 ANSI,
172 VT100
173 }
174
175 /**
176 * Available character sets for GL, GR, G0, G1, G2, G3.
177 */
178 private enum CharacterSet {
179 US,
180 UK,
181 DRAWING,
182 ROM,
183 ROM_SPECIAL,
184 VT52_GRAPHICS,
185 DEC_SUPPLEMENTAL,
186 NRC_DUTCH,
187 NRC_FINNISH,
188 NRC_FRENCH,
189 NRC_FRENCH_CA,
190 NRC_GERMAN,
191 NRC_ITALIAN,
192 NRC_NORWEGIAN,
193 NRC_SPANISH,
194 NRC_SWEDISH,
195 NRC_SWISS
196 }
197
198 /**
199 * Single-shift states used by the C1 control characters SS2 (0x8E) and
200 * SS3 (0x8F).
201 */
202 private enum Singleshift {
203 NONE,
204 SS2,
205 SS3
206 }
207
208 /**
209 * VT220+ lockshift states.
210 */
211 private enum LockshiftMode {
212 NONE,
213 G1_GR,
214 G2_GR,
215 G2_GL,
216 G3_GR,
217 G3_GL
218 }
219
220 /**
221 * XTERM mouse reporting protocols.
222 */
223 public enum MouseProtocol {
224 OFF,
225 X10,
226 NORMAL,
227 BUTTONEVENT,
228 ANYEVENT
229 }
230
231 /**
232 * XTERM mouse reporting encodings.
233 */
234 private enum MouseEncoding {
235 X10,
236 UTF8,
237 SGR
238 }
239
240 // ------------------------------------------------------------------------
241 // Variables --------------------------------------------------------------
242 // ------------------------------------------------------------------------
243
244 /**
245 * The enclosing listening object.
246 */
247 private DisplayListener displayListener;
248
249 /**
250 * When true, the reader thread is expected to exit.
251 */
252 private volatile boolean stopReaderThread = false;
253
254 /**
255 * The reader thread.
256 */
257 private Thread readerThread = null;
258
259 /**
260 * The type of emulator to be.
261 */
262 private final DeviceType type;
263
264 /**
265 * The scrollback buffer characters + attributes.
266 */
267 private volatile ArrayList<DisplayLine> scrollback;
268
269 /**
270 * The raw display buffer characters + attributes.
271 */
272 private volatile ArrayList<DisplayLine> display;
273
274 /**
275 * The maximum number of lines in the scrollback buffer.
276 */
277 private int maxScrollback = 10000;
278
279 /**
280 * The terminal's input. For type == XTERM, this is an InputStreamReader
281 * with UTF-8 encoding.
282 */
283 private Reader input;
284
285 /**
286 * The terminal's raw InputStream. This is used for type != XTERM.
287 */
288 private volatile TimeoutInputStream inputStream;
289
290 /**
291 * The terminal's output. For type == XTERM, this wraps an
292 * OutputStreamWriter with UTF-8 encoding.
293 */
294 private Writer output;
295
296 /**
297 * The terminal's raw OutputStream. This is used for type != XTERM.
298 */
299 private OutputStream outputStream;
300
301 /**
302 * Current scanning state.
303 */
304 private ScanState scanState;
305
306 /**
307 * Which mouse protocol is active.
308 */
309 private MouseProtocol mouseProtocol = MouseProtocol.OFF;
310
311 /**
312 * Which mouse encoding is active.
313 */
314 private MouseEncoding mouseEncoding = MouseEncoding.X10;
315
316 /**
317 * A terminal may request that the mouse pointer be hidden using a
318 * Privacy Message containing either "hideMousePointer" or
319 * "showMousePointer". This is currently only used within Jexer by
320 * TTerminalWindow so that only the bottom-most instance of nested
321 * Jexer's draws the mouse within its application window.
322 */
323 private boolean hideMousePointer = false;
324
325 /**
326 * Physical display width. We start at 80x24, but the user can resize us
327 * bigger/smaller.
328 */
329 private int width = 80;
330
331 /**
332 * Physical display height. We start at 80x24, but the user can resize
333 * us bigger/smaller.
334 */
335 private int height = 24;
336
337 /**
338 * Top margin of the scrolling region.
339 */
340 private int scrollRegionTop = 0;
341
342 /**
343 * Bottom margin of the scrolling region.
344 */
345 private int scrollRegionBottom = height - 1;
346
347 /**
348 * Right margin column number. This can be selected by the remote side
349 * to be 80/132 (rightMargin values 79/131), or it can be (width - 1).
350 */
351 private int rightMargin = 79;
352
353 /**
354 * Last character printed.
355 */
356 private int repCh;
357
358 /**
359 * VT100-style line wrapping: a character is placed in column 80 (or
360 * 132), but the line does NOT wrap until another character is written to
361 * column 1 of the next line, after which the cursor moves to column 2.
362 */
363 private boolean wrapLineFlag = false;
364
365 /**
366 * VT220 single shift flag.
367 */
368 private Singleshift singleshift = Singleshift.NONE;
369
370 /**
371 * true = insert characters, false = overwrite.
372 */
373 private boolean insertMode = false;
374
375 /**
376 * VT52 mode as selected by DECANM. True means VT52, false means
377 * ANSI. Default is ANSI.
378 */
379 private boolean vt52Mode = false;
380
381 /**
382 * Visible cursor (DECTCEM).
383 */
384 private boolean cursorVisible = true;
385
386 /**
387 * Screen title as set by the xterm OSC sequence. Lots of applications
388 * send a screenTitle regardless of whether it is an xterm client or not.
389 */
390 private String screenTitle = "";
391
392 /**
393 * Parameter characters being collected.
394 */
395 private List<Integer> csiParams;
396
397 /**
398 * Non-csi collect buffer.
399 */
400 private StringBuilder collectBuffer = new StringBuilder(128);
401
402 /**
403 * When true, use the G1 character set.
404 */
405 private boolean shiftOut = false;
406
407 /**
408 * Horizontal tab stop locations.
409 */
410 private List<Integer> tabStops;
411
412 /**
413 * S8C1T. True means 8bit controls, false means 7bit controls.
414 */
415 private boolean s8c1t = false;
416
417 /**
418 * Printer mode. True means send all output to printer, which discards
419 * it.
420 */
421 private boolean printerControllerMode = false;
422
423 /**
424 * LMN line mode. If true, linefeed() puts the cursor on the first
425 * column of the next line. If false, linefeed() puts the cursor one
426 * line down on the current line. The default is false.
427 */
428 private boolean newLineMode = false;
429
430 /**
431 * Whether arrow keys send ANSI, VT100, or VT52 sequences.
432 */
433 private ArrowKeyMode arrowKeyMode;
434
435 /**
436 * Whether number pad keys send VT100 or VT52, application or numeric
437 * sequences.
438 */
439 @SuppressWarnings("unused")
440 private KeypadMode keypadMode;
441
442 /**
443 * When true, the terminal is in 132-column mode (DECCOLM).
444 */
445 private boolean columns132 = false;
446
447 /**
448 * true = reverse video. Set by DECSCNM.
449 */
450 private boolean reverseVideo = false;
451
452 /**
453 * false = echo characters locally.
454 */
455 private boolean fullDuplex = true;
456
457 /**
458 * The current terminal state.
459 */
460 private SaveableState currentState;
461
462 /**
463 * The last saved terminal state.
464 */
465 private SaveableState savedState;
466
467 /**
468 * The 88- or 256-color support RGB colors.
469 */
470 private List<Integer> colors88;
471
472 /**
473 * Sixel collection buffer.
474 */
475 private StringBuilder sixelParseBuffer = new StringBuilder(2048);
476
477 /**
478 * Sixel shared palette.
479 */
480 private HashMap<Integer, java.awt.Color> sixelPalette;
481
482 /**
483 * The width of a character cell in pixels.
484 */
485 private int textWidth = 16;
486
487 /**
488 * The height of a character cell in pixels.
489 */
490 private int textHeight = 20;
491
492 /**
493 * The last used height of a character cell in pixels, only used for
494 * full-width chars.
495 */
496 private int lastTextHeight = -1;
497
498 /**
499 * The glyph drawer for full-width chars.
500 */
501 private GlyphMaker glyphMaker = null;
502
503 /**
504 * Input queue for keystrokes and mouse events to send to the remote
505 * side.
506 */
507 private ArrayList<TInputEvent> userQueue = new ArrayList<TInputEvent>();
508
509 /**
510 * DECSC/DECRC save/restore a subset of the total state. This class
511 * encapsulates those specific flags/modes.
512 */
513 private class SaveableState {
514
515 /**
516 * When true, cursor positions are relative to the scrolling region.
517 */
518 public boolean originMode = false;
519
520 /**
521 * The current editing X position.
522 */
523 public int cursorX = 0;
524
525 /**
526 * The current editing Y position.
527 */
528 public int cursorY = 0;
529
530 /**
531 * Which character set is currently selected in G0.
532 */
533 public CharacterSet g0Charset = CharacterSet.US;
534
535 /**
536 * Which character set is currently selected in G1.
537 */
538 public CharacterSet g1Charset = CharacterSet.DRAWING;
539
540 /**
541 * Which character set is currently selected in G2.
542 */
543 public CharacterSet g2Charset = CharacterSet.US;
544
545 /**
546 * Which character set is currently selected in G3.
547 */
548 public CharacterSet g3Charset = CharacterSet.US;
549
550 /**
551 * Which character set is currently selected in GR.
552 */
553 public CharacterSet grCharset = CharacterSet.DRAWING;
554
555 /**
556 * The current drawing attributes.
557 */
558 public CellAttributes attr;
559
560 /**
561 * GL lockshift mode.
562 */
563 public LockshiftMode glLockshift = LockshiftMode.NONE;
564
565 /**
566 * GR lockshift mode.
567 */
568 public LockshiftMode grLockshift = LockshiftMode.NONE;
569
570 /**
571 * Line wrap.
572 */
573 public boolean lineWrap = true;
574
575 /**
576 * Reset to defaults.
577 */
578 public void reset() {
579 originMode = false;
580 cursorX = 0;
581 cursorY = 0;
582 g0Charset = CharacterSet.US;
583 g1Charset = CharacterSet.DRAWING;
584 g2Charset = CharacterSet.US;
585 g3Charset = CharacterSet.US;
586 grCharset = CharacterSet.DRAWING;
587 attr = new CellAttributes();
588 glLockshift = LockshiftMode.NONE;
589 grLockshift = LockshiftMode.NONE;
590 lineWrap = true;
591 }
592
593 /**
594 * Copy attributes from another instance.
595 *
596 * @param that the other instance to match
597 */
598 public void setTo(final SaveableState that) {
599 this.originMode = that.originMode;
600 this.cursorX = that.cursorX;
601 this.cursorY = that.cursorY;
602 this.g0Charset = that.g0Charset;
603 this.g1Charset = that.g1Charset;
604 this.g2Charset = that.g2Charset;
605 this.g3Charset = that.g3Charset;
606 this.grCharset = that.grCharset;
607 this.attr = new CellAttributes();
608 this.attr.setTo(that.attr);
609 this.glLockshift = that.glLockshift;
610 this.grLockshift = that.grLockshift;
611 this.lineWrap = that.lineWrap;
612 }
613
614 /**
615 * Public constructor.
616 */
617 public SaveableState() {
618 reset();
619 }
620 }
621
622 // ------------------------------------------------------------------------
623 // Constructors -----------------------------------------------------------
624 // ------------------------------------------------------------------------
625
626 /**
627 * Public constructor.
628 *
629 * @param type one of the DeviceType constants to select VT100, VT102,
630 * VT220, or XTERM
631 * @param inputStream an InputStream connected to the remote side. For
632 * type == XTERM, inputStream is converted to a Reader with UTF-8
633 * encoding.
634 * @param outputStream an OutputStream connected to the remote user. For
635 * type == XTERM, outputStream is converted to a Writer with UTF-8
636 * encoding.
637 * @param displayListener a callback to the outer display, or null for
638 * default VT100 behavior
639 * @throws UnsupportedEncodingException if an exception is thrown when
640 * creating the InputStreamReader
641 */
642 public ECMA48(final DeviceType type, final InputStream inputStream,
643 final OutputStream outputStream, final DisplayListener displayListener)
644 throws UnsupportedEncodingException {
645
646 assert (inputStream != null);
647 assert (outputStream != null);
648
649 csiParams = new ArrayList<Integer>();
650 tabStops = new ArrayList<Integer>();
651 scrollback = new ArrayList<DisplayLine>();
652 display = new ArrayList<DisplayLine>();
653
654 this.type = type;
655 if (inputStream instanceof TimeoutInputStream) {
656 this.inputStream = (TimeoutInputStream)inputStream;
657 } else {
658 this.inputStream = new TimeoutInputStream(inputStream, 2000);
659 }
660 if (type == DeviceType.XTERM) {
661 this.input = new InputStreamReader(new BufferedInputStream(
662 this.inputStream, 1024 * 128), "UTF-8");
663 this.output = new OutputStreamWriter(new
664 BufferedOutputStream(outputStream), "UTF-8");
665 this.outputStream = null;
666 } else {
667 this.output = null;
668 this.outputStream = new BufferedOutputStream(outputStream);
669 }
670 this.displayListener = displayListener;
671
672 reset();
673 for (int i = 0; i < height; i++) {
674 display.add(new DisplayLine(currentState.attr));
675 }
676 assert (currentState.cursorY < height);
677 assert (currentState.cursorX < width);
678
679 // Spin up the input reader
680 readerThread = new Thread(this);
681 readerThread.start();
682 }
683
684 // ------------------------------------------------------------------------
685 // Runnable ---------------------------------------------------------------
686 // ------------------------------------------------------------------------
687
688 /**
689 * Read function runs on a separate thread.
690 */
691 public final void run() {
692 boolean utf8 = false;
693 boolean done = false;
694
695 if (type == DeviceType.XTERM) {
696 utf8 = true;
697 }
698
699 // available() will often return > 1, so we need to read in chunks to
700 // stay caught up.
701 char [] readBufferUTF8 = null;
702 byte [] readBuffer = null;
703 if (utf8) {
704 readBufferUTF8 = new char[2048];
705 } else {
706 readBuffer = new byte[2048];
707 }
708
709 while (!done && !stopReaderThread) {
710 synchronized (userQueue) {
711 while (userQueue.size() > 0) {
712 handleUserEvent(userQueue.remove(0));
713 }
714 }
715
716 try {
717 int n = inputStream.available();
718
719 // System.err.printf("available() %d\n", n); System.err.flush();
720 if (utf8) {
721 if (readBufferUTF8.length < n) {
722 // The buffer wasn't big enough, make it huger
723 int newSizeHalf = Math.max(readBufferUTF8.length,
724 n);
725
726 readBufferUTF8 = new char[newSizeHalf * 2];
727 }
728 } else {
729 if (readBuffer.length < n) {
730 // The buffer wasn't big enough, make it huger
731 int newSizeHalf = Math.max(readBuffer.length, n);
732 readBuffer = new byte[newSizeHalf * 2];
733 }
734 }
735 if (n == 0) {
736 try {
737 Thread.sleep(10);
738 } catch (InterruptedException e) {
739 // SQUASH
740 }
741 continue;
742 }
743
744 int rc = -1;
745 try {
746 if (utf8) {
747 rc = input.read(readBufferUTF8, 0,
748 readBufferUTF8.length);
749 } else {
750 rc = inputStream.read(readBuffer, 0,
751 readBuffer.length);
752 }
753 } catch (ReadTimeoutException e) {
754 rc = 0;
755 }
756
757 // System.err.printf("read() %d\n", rc); System.err.flush();
758 if (rc == -1) {
759 // This is EOF
760 done = true;
761 } else {
762 // Don't step on UI events
763 synchronized (this) {
764 if (utf8) {
765 for (int i = 0; i < rc;) {
766 int ch = Character.codePointAt(readBufferUTF8,
767 i);
768 i += Character.charCount(ch);
769
770 // Special case for VT10x: 7-bit characters
771 // only.
772 if ((type == DeviceType.VT100)
773 || (type == DeviceType.VT102)
774 ) {
775 consume(ch & 0x7F);
776 } else {
777 consume(ch);
778 }
779 }
780 } else {
781 for (int i = 0; i < rc; i++) {
782 // Special case for VT10x: 7-bit characters
783 // only.
784 if ((type == DeviceType.VT100)
785 || (type == DeviceType.VT102)
786 ) {
787 consume(readBuffer[i] & 0x7F);
788 } else {
789 consume(readBuffer[i]);
790 }
791 }
792 }
793 }
794 // Permit my enclosing UI to know that I updated.
795 if (displayListener != null) {
796 displayListener.displayChanged();
797 }
798 }
799 // System.err.println("end while loop"); System.err.flush();
800 } catch (IOException e) {
801 done = true;
802
803 // This is an unusual case. We want to see the stack trace,
804 // but it is related to the spawned process rather than the
805 // actual UI. We will generate the stack trace, and consume
806 // it as though it was emitted by the shell.
807 CharArrayWriter writer= new CharArrayWriter();
808 // Send a ST and RIS to clear the emulator state.
809 try {
810 writer.write("\033\\\033c");
811 writer.write("\n-----------------------------------\n");
812 e.printStackTrace(new PrintWriter(writer));
813 writer.write("\n-----------------------------------\n");
814 } catch (IOException e2) {
815 // SQUASH
816 }
817 char [] stackTrace = writer.toCharArray();
818 for (int i = 0; i < stackTrace.length; i++) {
819 if (stackTrace[i] == '\n') {
820 consume('\r');
821 }
822 consume(stackTrace[i]);
823 }
824 }
825
826 } // while ((done == false) && (stopReaderThread == false))
827
828 // Let the rest of the world know that I am done.
829 stopReaderThread = true;
830
831 try {
832 inputStream.cancelRead();
833 inputStream.close();
834 inputStream = null;
835 } catch (IOException e) {
836 // SQUASH
837 }
838 try {
839 input.close();
840 input = null;
841 } catch (IOException e) {
842 // SQUASH
843 }
844
845 // Permit my enclosing UI to know that I updated.
846 if (displayListener != null) {
847 displayListener.displayChanged();
848 }
849
850 // System.err.println("*** run() exiting..."); System.err.flush();
851 }
852
853 // ------------------------------------------------------------------------
854 // ECMA48 -----------------------------------------------------------------
855 // ------------------------------------------------------------------------
856
857 /**
858 * Process keyboard and mouse events from the user.
859 *
860 * @param event the input event to consume
861 */
862 private void handleUserEvent(final TInputEvent event) {
863 if (event instanceof TKeypressEvent) {
864 keypress(((TKeypressEvent) event).getKey());
865 }
866 if (event instanceof TMouseEvent) {
867 mouse((TMouseEvent) event);
868 }
869 }
870
871 /**
872 * Add a keyboard and mouse event from the user to the queue.
873 *
874 * @param event the input event to consume
875 */
876 public void addUserEvent(final TInputEvent event) {
877 synchronized (userQueue) {
878 userQueue.add(event);
879 }
880 }
881
882 /**
883 * Return the proper primary Device Attributes string.
884 *
885 * @return string to send to remote side that is appropriate for the
886 * this.type
887 */
888 private String deviceTypeResponse() {
889 switch (type) {
890 case VT100:
891 // "I am a VT100 with advanced video option" (often VT102)
892 return "\033[?1;2c";
893
894 case VT102:
895 // "I am a VT102"
896 return "\033[?6c";
897
898 case VT220:
899 case XTERM:
900 // "I am a VT220" - 7 bit version, with sixel and Jexer image
901 // support.
902 if (!s8c1t) {
903 return "\033[?62;1;6;9;4;22;444c";
904 }
905 // "I am a VT220" - 8 bit version, with sixel and Jexer image
906 // support.
907 return "\u009b?62;1;6;9;4;22;444c";
908 default:
909 throw new IllegalArgumentException("Invalid device type: " + type);
910 }
911 }
912
913 /**
914 * Return the proper TERM environment variable for this device type.
915 *
916 * @param deviceType DeviceType.VT100, DeviceType, XTERM, etc.
917 * @return "vt100", "xterm", etc.
918 */
919 public static String deviceTypeTerm(final DeviceType deviceType) {
920 switch (deviceType) {
921 case VT100:
922 return "vt100";
923
924 case VT102:
925 return "vt102";
926
927 case VT220:
928 return "vt220";
929
930 case XTERM:
931 return "xterm";
932
933 default:
934 throw new IllegalArgumentException("Invalid device type: "
935 + deviceType);
936 }
937 }
938
939 /**
940 * Return the proper LANG for this device type. Only XTERM devices know
941 * about UTF-8, the others are defined by their standard to be either
942 * 7-bit or 8-bit characters only.
943 *
944 * @param deviceType DeviceType.VT100, DeviceType, XTERM, etc.
945 * @param baseLang a base language without UTF-8 flag such as "C" or
946 * "en_US"
947 * @return "en_US", "en_US.UTF-8", etc.
948 */
949 public static String deviceTypeLang(final DeviceType deviceType,
950 final String baseLang) {
951
952 switch (deviceType) {
953
954 case VT100:
955 case VT102:
956 case VT220:
957 return baseLang;
958
959 case XTERM:
960 return baseLang + ".UTF-8";
961
962 default:
963 throw new IllegalArgumentException("Invalid device type: "
964 + deviceType);
965 }
966 }
967
968 /**
969 * Write a string directly to the remote side.
970 *
971 * @param str string to send
972 */
973 public void writeRemote(final String str) {
974 if (stopReaderThread) {
975 // Reader hit EOF, bail out now.
976 close();
977 return;
978 }
979
980 // System.err.printf("writeRemote() '%s'\n", str);
981
982 switch (type) {
983 case VT100:
984 case VT102:
985 case VT220:
986 if (outputStream == null) {
987 return;
988 }
989 try {
990 outputStream.flush();
991 for (int i = 0; i < str.length(); i++) {
992 outputStream.write(str.charAt(i));
993 }
994 outputStream.flush();
995 } catch (IOException e) {
996 // Assume EOF
997 close();
998 }
999 break;
1000 case XTERM:
1001 if (output == null) {
1002 return;
1003 }
1004 try {
1005 output.flush();
1006 output.write(str);
1007 output.flush();
1008 } catch (IOException e) {
1009 // Assume EOF
1010 close();
1011 }
1012 break;
1013 default:
1014 throw new IllegalArgumentException("Invalid device type: " + type);
1015 }
1016 }
1017
1018 /**
1019 * Close the input and output streams and stop the reader thread. Note
1020 * that it is safe to call this multiple times.
1021 */
1022 public final void close() {
1023
1024 // Tell the reader thread to stop looking at input. It will close
1025 // the input streams.
1026 if (stopReaderThread == false) {
1027 stopReaderThread = true;
1028 try {
1029 readerThread.join(1000);
1030 } catch (InterruptedException e) {
1031 // SQUASH
1032 }
1033 }
1034
1035 // Now close the output stream.
1036 switch (type) {
1037 case VT100:
1038 case VT102:
1039 case VT220:
1040 if (outputStream != null) {
1041 try {
1042 outputStream.close();
1043 } catch (IOException e) {
1044 // SQUASH
1045 }
1046 outputStream = null;
1047 }
1048 break;
1049 case XTERM:
1050 if (outputStream != null) {
1051 try {
1052 outputStream.close();
1053 } catch (IOException e) {
1054 // SQUASH
1055 }
1056 outputStream = null;
1057 }
1058 if (output != null) {
1059 try {
1060 output.close();
1061 } catch (IOException e) {
1062 // SQUASH
1063 }
1064 output = null;
1065 }
1066 break;
1067 default:
1068 throw new IllegalArgumentException("Invalid device type: " +
1069 type);
1070 }
1071 }
1072
1073 /**
1074 * See if the reader thread is still running.
1075 *
1076 * @return if true, we are still connected to / reading from the remote
1077 * side
1078 */
1079 public final boolean isReading() {
1080 return (!stopReaderThread);
1081 }
1082
1083 /**
1084 * Obtain a new blank display line for an external user
1085 * (e.g. TTerminalWindow).
1086 *
1087 * @return new blank line
1088 */
1089 public final DisplayLine getBlankDisplayLine() {
1090 return new DisplayLine(currentState.attr);
1091 }
1092
1093 /**
1094 * Get the scrollback buffer.
1095 *
1096 * @return the scrollback buffer
1097 */
1098 public final List<DisplayLine> getScrollbackBuffer() {
1099 return scrollback;
1100 }
1101
1102 /**
1103 * Get the display buffer.
1104 *
1105 * @return the display buffer
1106 */
1107 public final List<DisplayLine> getDisplayBuffer() {
1108 return display;
1109 }
1110
1111 /**
1112 * Get the visible display + scrollback buffer, offset by a specified
1113 * number of rows from the bottom.
1114 *
1115 * @param visibleHeight the total height of the display to show
1116 * @param scrollBottom the number of rows from the bottom to scroll back
1117 * @return a copy of the display + scrollback buffers
1118 */
1119 public final List<DisplayLine> getVisibleDisplay(final int visibleHeight,
1120 final int scrollBottom) {
1121
1122 assert (visibleHeight >= 0);
1123 assert (scrollBottom >= 0);
1124
1125 int visibleBottom = scrollback.size() + display.size() - scrollBottom;
1126
1127 List<DisplayLine> preceedingBlankLines = new ArrayList<DisplayLine>();
1128 int visibleTop = visibleBottom - visibleHeight;
1129 if (visibleTop < 0) {
1130 for (int i = visibleTop; i < 0; i++) {
1131 preceedingBlankLines.add(getBlankDisplayLine());
1132 }
1133 visibleTop = 0;
1134 }
1135 assert (visibleTop >= 0);
1136
1137 List<DisplayLine> displayLines = new ArrayList<DisplayLine>();
1138 displayLines.addAll(scrollback);
1139 displayLines.addAll(display);
1140
1141 List<DisplayLine> visibleLines = new ArrayList<DisplayLine>();
1142 visibleLines.addAll(preceedingBlankLines);
1143 visibleLines.addAll(displayLines.subList(visibleTop, visibleBottom));
1144
1145 // Fill in the blank lines on bottom
1146 int bottomBlankLines = visibleHeight - visibleLines.size();
1147 assert (bottomBlankLines >= 0);
1148 for (int i = 0; i < bottomBlankLines; i++) {
1149 visibleLines.add(getBlankDisplayLine());
1150 }
1151
1152 return copyBuffer(visibleLines);
1153 }
1154
1155 /**
1156 * Copy a display buffer.
1157 *
1158 * @param buffer the buffer to copy
1159 * @return a deep copy of the buffer's data
1160 */
1161 private List<DisplayLine> copyBuffer(final List<DisplayLine> buffer) {
1162 ArrayList<DisplayLine> result = new ArrayList<DisplayLine>(buffer.size());
1163 for (DisplayLine line: buffer) {
1164 result.add(new DisplayLine(line));
1165 }
1166 return result;
1167 }
1168
1169 /**
1170 * Get the display width.
1171 *
1172 * @return the width (usually 80 or 132)
1173 */
1174 public final int getWidth() {
1175 return width;
1176 }
1177
1178 /**
1179 * Set the display width.
1180 *
1181 * @param width the new width
1182 */
1183 public final synchronized void setWidth(final int width) {
1184 this.width = width;
1185 rightMargin = width - 1;
1186 if (currentState.cursorX >= width) {
1187 currentState.cursorX = width - 1;
1188 }
1189 if (savedState.cursorX >= width) {
1190 savedState.cursorX = width - 1;
1191 }
1192 }
1193
1194 /**
1195 * Get the display height.
1196 *
1197 * @return the height (usually 24)
1198 */
1199 public final int getHeight() {
1200 return height;
1201 }
1202
1203 /**
1204 * Set the display height.
1205 *
1206 * @param height the new height
1207 */
1208 public final synchronized void setHeight(final int height) {
1209 int delta = height - this.height;
1210 this.height = height;
1211 scrollRegionBottom += delta;
1212 if ((scrollRegionBottom < 0) || (scrollRegionTop > height - 1)) {
1213 scrollRegionBottom = height - 1;
1214 }
1215 if (scrollRegionTop >= scrollRegionBottom) {
1216 scrollRegionTop = 0;
1217 }
1218 if (currentState.cursorY >= height) {
1219 currentState.cursorY = height - 1;
1220 }
1221 if (savedState.cursorY >= height) {
1222 savedState.cursorY = height - 1;
1223 }
1224 while (display.size() < height) {
1225 DisplayLine line = new DisplayLine(currentState.attr);
1226 line.setReverseColor(reverseVideo);
1227 display.add(line);
1228 }
1229 while (display.size() > height) {
1230 scrollback.add(display.remove(0));
1231 }
1232 }
1233
1234 /**
1235 * Get visible cursor flag.
1236 *
1237 * @return if true, the cursor is visible
1238 */
1239 public final boolean isCursorVisible() {
1240 return cursorVisible;
1241 }
1242
1243 /**
1244 * Get the screen title as set by the xterm OSC sequence. Lots of
1245 * applications send a screenTitle regardless of whether it is an xterm
1246 * client or not.
1247 *
1248 * @return screen title
1249 */
1250 public final String getScreenTitle() {
1251 return screenTitle;
1252 }
1253
1254 /**
1255 * Get 132 columns value.
1256 *
1257 * @return if true, the terminal is in 132 column mode
1258 */
1259 public final boolean isColumns132() {
1260 return columns132;
1261 }
1262
1263 /**
1264 * Clear the CSI parameters and flags.
1265 */
1266 private void toGround() {
1267 csiParams.clear();
1268 collectBuffer.setLength(0);
1269 scanState = ScanState.GROUND;
1270 }
1271
1272 /**
1273 * Reset the tab stops list.
1274 */
1275 private void resetTabStops() {
1276 tabStops.clear();
1277 for (int i = 0; (i * 8) <= rightMargin; i++) {
1278 tabStops.add(Integer.valueOf(i * 8));
1279 }
1280 }
1281
1282 /**
1283 * Reset the 88- or 256-colors.
1284 */
1285 private void resetColors() {
1286 colors88 = new ArrayList<Integer>(256);
1287 for (int i = 0; i < 256; i++) {
1288 colors88.add(0);
1289 }
1290
1291 // Set default system colors.
1292 colors88.set(0, 0x00000000);
1293 colors88.set(1, 0x00a80000);
1294 colors88.set(2, 0x0000a800);
1295 colors88.set(3, 0x00a85400);
1296 colors88.set(4, 0x000000a8);
1297 colors88.set(5, 0x00a800a8);
1298 colors88.set(6, 0x0000a8a8);
1299 colors88.set(7, 0x00a8a8a8);
1300
1301 colors88.set(8, 0x00545454);
1302 colors88.set(9, 0x00fc5454);
1303 colors88.set(10, 0x0054fc54);
1304 colors88.set(11, 0x00fcfc54);
1305 colors88.set(12, 0x005454fc);
1306 colors88.set(13, 0x00fc54fc);
1307 colors88.set(14, 0x0054fcfc);
1308 colors88.set(15, 0x00fcfcfc);
1309 }
1310
1311 /**
1312 * Get the RGB value of one of the indexed colors.
1313 *
1314 * @param index the color index
1315 * @return the RGB value
1316 */
1317 private int get88Color(final int index) {
1318 // System.err.print("get88Color: " + index);
1319 if ((index < 0) || (index > colors88.size())) {
1320 // System.err.println(" -- UNKNOWN");
1321 return 0;
1322 }
1323 // System.err.printf(" %08x\n", colors88.get(index));
1324 return colors88.get(index);
1325 }
1326
1327 /**
1328 * Set one of the indexed colors to a color specification.
1329 *
1330 * @param index the color index
1331 * @param spec the specification, typically something like "rgb:aa/bb/cc"
1332 */
1333 private void set88Color(final int index, final String spec) {
1334 // System.err.println("set88Color: " + index + " '" + spec + "'");
1335
1336 if ((index < 0) || (index > colors88.size())) {
1337 return;
1338 }
1339 if (spec.startsWith("rgb:")) {
1340 String [] rgbTokens = spec.substring(4).split("/");
1341 if (rgbTokens.length == 3) {
1342 try {
1343 int rgb = (Integer.parseInt(rgbTokens[0], 16) << 16);
1344 rgb |= Integer.parseInt(rgbTokens[1], 16) << 8;
1345 rgb |= Integer.parseInt(rgbTokens[2], 16);
1346 // System.err.printf(" set to %08x\n", rgb);
1347 colors88.set(index, rgb);
1348 } catch (NumberFormatException e) {
1349 // SQUASH
1350 }
1351 }
1352 return;
1353 }
1354
1355 if (spec.toLowerCase().equals("black")) {
1356 colors88.set(index, 0x00000000);
1357 } else if (spec.toLowerCase().equals("red")) {
1358 colors88.set(index, 0x00a80000);
1359 } else if (spec.toLowerCase().equals("green")) {
1360 colors88.set(index, 0x0000a800);
1361 } else if (spec.toLowerCase().equals("yellow")) {
1362 colors88.set(index, 0x00a85400);
1363 } else if (spec.toLowerCase().equals("blue")) {
1364 colors88.set(index, 0x000000a8);
1365 } else if (spec.toLowerCase().equals("magenta")) {
1366 colors88.set(index, 0x00a800a8);
1367 } else if (spec.toLowerCase().equals("cyan")) {
1368 colors88.set(index, 0x0000a8a8);
1369 } else if (spec.toLowerCase().equals("white")) {
1370 colors88.set(index, 0x00a8a8a8);
1371 }
1372
1373 }
1374
1375 /**
1376 * Reset the emulation state.
1377 */
1378 private void reset() {
1379
1380 currentState = new SaveableState();
1381 savedState = new SaveableState();
1382 scanState = ScanState.GROUND;
1383 if (displayListener != null) {
1384 width = displayListener.getDisplayWidth();
1385 height = displayListener.getDisplayHeight();
1386 } else {
1387 width = 80;
1388 height = 24;
1389 }
1390 scrollRegionTop = 0;
1391 scrollRegionBottom = height - 1;
1392 rightMargin = width - 1;
1393 newLineMode = false;
1394 arrowKeyMode = ArrowKeyMode.ANSI;
1395 keypadMode = KeypadMode.Numeric;
1396 wrapLineFlag = false;
1397
1398 // Flags
1399 shiftOut = false;
1400 vt52Mode = false;
1401 insertMode = false;
1402 columns132 = false;
1403 newLineMode = false;
1404 reverseVideo = false;
1405 fullDuplex = true;
1406 cursorVisible = true;
1407
1408 // VT220
1409 singleshift = Singleshift.NONE;
1410 s8c1t = false;
1411 printerControllerMode = false;
1412
1413 // XTERM
1414 mouseProtocol = MouseProtocol.OFF;
1415 mouseEncoding = MouseEncoding.X10;
1416
1417 // Tab stops
1418 resetTabStops();
1419
1420 // Reset extra colors
1421 resetColors();
1422
1423 // Clear CSI stuff
1424 toGround();
1425 }
1426
1427 /**
1428 * Append a new line to the bottom of the display, adding lines off the
1429 * top to the scrollback buffer.
1430 */
1431 private void newDisplayLine() {
1432 // Scroll the top line off into the scrollback buffer
1433 scrollback.add(display.get(0));
1434 if (scrollback.size() > maxScrollback) {
1435 scrollback.remove(0);
1436 scrollback.trimToSize();
1437 }
1438 display.remove(0);
1439 display.trimToSize();
1440 DisplayLine line = new DisplayLine(currentState.attr);
1441 line.setReverseColor(reverseVideo);
1442 display.add(line);
1443 }
1444
1445 /**
1446 * Wraps the current line.
1447 */
1448 private void wrapCurrentLine() {
1449 if (currentState.cursorY == height - 1) {
1450 newDisplayLine();
1451 }
1452 if (currentState.cursorY < height - 1) {
1453 currentState.cursorY++;
1454 }
1455 currentState.cursorX = 0;
1456 }
1457
1458 /**
1459 * Handle a carriage return.
1460 */
1461 private void carriageReturn() {
1462 currentState.cursorX = 0;
1463 wrapLineFlag = false;
1464 }
1465
1466 /**
1467 * Reverse the color of the visible display.
1468 */
1469 private void invertDisplayColors() {
1470 for (DisplayLine line: display) {
1471 line.setReverseColor(!line.isReverseColor());
1472 }
1473 }
1474
1475 /**
1476 * Handle a linefeed.
1477 */
1478 private void linefeed() {
1479 if (currentState.cursorY < scrollRegionBottom) {
1480 // Increment screen y
1481 currentState.cursorY++;
1482 } else {
1483
1484 // Screen y does not increment
1485
1486 /*
1487 * Two cases: either we're inside a scrolling region or not. If
1488 * the scrolling region bottom is the bottom of the screen, then
1489 * push the top line into the buffer. Else scroll the scrolling
1490 * region up.
1491 */
1492 if ((scrollRegionBottom == height - 1) && (scrollRegionTop == 0)) {
1493
1494 // We're at the bottom of the scroll region, AND the scroll
1495 // region is the entire screen.
1496
1497 // New line
1498 newDisplayLine();
1499
1500 } else {
1501 // We're at the bottom of the scroll region, AND the scroll
1502 // region is NOT the entire screen.
1503 scrollingRegionScrollUp(scrollRegionTop, scrollRegionBottom, 1);
1504 }
1505 }
1506
1507 if (newLineMode) {
1508 currentState.cursorX = 0;
1509 }
1510 wrapLineFlag = false;
1511 }
1512
1513 /**
1514 * Prints one character to the display buffer.
1515 *
1516 * @param ch character to display
1517 */
1518 private void printCharacter(final int ch) {
1519 int rightMargin = this.rightMargin;
1520
1521 if (StringUtils.width(ch) == 2) {
1522 // This is a full-width character. Save two spaces, and then
1523 // draw the character as two image halves.
1524 int x0 = currentState.cursorX;
1525 int y0 = currentState.cursorY;
1526 printCharacter(' ');
1527 printCharacter(' ');
1528 if ((currentState.cursorX == x0 + 2)
1529 && (currentState.cursorY == y0)
1530 ) {
1531 // We can draw both halves of the character.
1532 drawHalves(x0, y0, x0 + 1, y0, ch);
1533 } else if ((currentState.cursorX == x0 + 1)
1534 && (currentState.cursorY == y0)
1535 ) {
1536 // VT100 line wrap behavior: we should be at the right
1537 // margin. We can draw both halves of the character.
1538 drawHalves(x0, y0, x0 + 1, y0, ch);
1539 } else {
1540 // The character splits across the line. Draw the entire
1541 // character on the new line, giving one more space for it.
1542 x0 = currentState.cursorX - 1;
1543 y0 = currentState.cursorY;
1544 printCharacter(' ');
1545 drawHalves(x0, y0, x0 + 1, y0, ch);
1546 }
1547 return;
1548 }
1549
1550 // Check if we have double-width, and if so chop at 40/66 instead of
1551 // 80/132
1552 if (display.get(currentState.cursorY).isDoubleWidth()) {
1553 rightMargin = ((rightMargin + 1) / 2) - 1;
1554 }
1555
1556 // Check the unusually-complicated line wrapping conditions...
1557 if (currentState.cursorX == rightMargin) {
1558
1559 if (currentState.lineWrap == true) {
1560 /*
1561 * This case happens when: the cursor was already on the
1562 * right margin (either through printing or by an explicit
1563 * placement command), and a character was printed.
1564 *
1565 * The line wraps only when a new character arrives AND the
1566 * cursor is already on the right margin AND has placed a
1567 * character in its cell. Easier to see than to explain.
1568 */
1569 if (wrapLineFlag == false) {
1570 /*
1571 * This block marks the case that we are in the margin
1572 * and the first character has been received and printed.
1573 */
1574 wrapLineFlag = true;
1575 } else {
1576 /*
1577 * This block marks the case that we are in the margin
1578 * and the second character has been received and
1579 * printed.
1580 */
1581 wrapLineFlag = false;
1582 wrapCurrentLine();
1583 }
1584 }
1585 } else if (currentState.cursorX <= rightMargin) {
1586 /*
1587 * This is the normal case: a character came in and was printed
1588 * to the left of the right margin column.
1589 */
1590
1591 // Turn off VT100 special-case flag
1592 wrapLineFlag = false;
1593 }
1594
1595 // "Print" the character
1596 Cell newCell = new Cell(ch);
1597 CellAttributes newCellAttributes = (CellAttributes) newCell;
1598 newCellAttributes.setTo(currentState.attr);
1599 DisplayLine line = display.get(currentState.cursorY);
1600
1601 if (StringUtils.width(ch) == 1) {
1602 // Insert mode special case
1603 if (insertMode == true) {
1604 line.insert(currentState.cursorX, newCell);
1605 } else {
1606 // Replace an existing character
1607 line.replace(currentState.cursorX, newCell);
1608 }
1609
1610 // Increment horizontal
1611 if (wrapLineFlag == false) {
1612 currentState.cursorX++;
1613 if (currentState.cursorX > rightMargin) {
1614 currentState.cursorX--;
1615 }
1616 }
1617 }
1618 }
1619
1620 /**
1621 * Translate the mouse event to a VT100, VT220, or XTERM sequence and
1622 * send to the remote side.
1623 *
1624 * @param mouse mouse event received from the local user
1625 */
1626 private void mouse(final TMouseEvent mouse) {
1627
1628 /*
1629 System.err.printf("mouse(): protocol %s encoding %s mouse %s\n",
1630 mouseProtocol, mouseEncoding, mouse);
1631 */
1632
1633 if (mouseEncoding == MouseEncoding.X10) {
1634 // We will support X10 but only for (160,94) and smaller.
1635 if ((mouse.getX() >= 160) || (mouse.getY() >= 94)) {
1636 return;
1637 }
1638 }
1639
1640 switch (mouseProtocol) {
1641
1642 case OFF:
1643 // Do nothing
1644 return;
1645
1646 case X10:
1647 // Only report button presses
1648 if (mouse.getType() != TMouseEvent.Type.MOUSE_DOWN) {
1649 return;
1650 }
1651 break;
1652
1653 case NORMAL:
1654 // Only report button presses and releases
1655 if ((mouse.getType() != TMouseEvent.Type.MOUSE_DOWN)
1656 && (mouse.getType() != TMouseEvent.Type.MOUSE_UP)
1657 ) {
1658 return;
1659 }
1660 break;
1661
1662 case BUTTONEVENT:
1663 /*
1664 * Only report button presses, button releases, and motions that
1665 * have a button down (i.e. drag-and-drop).
1666 */
1667 if (mouse.getType() == TMouseEvent.Type.MOUSE_MOTION) {
1668 if (!mouse.isMouse1()
1669 && !mouse.isMouse2()
1670 && !mouse.isMouse3()
1671 && !mouse.isMouseWheelUp()
1672 && !mouse.isMouseWheelDown()
1673 ) {
1674 return;
1675 }
1676 }
1677 break;
1678
1679 case ANYEVENT:
1680 // Report everything
1681 break;
1682 }
1683
1684 // Now encode the event
1685 StringBuilder sb = new StringBuilder(6);
1686 if (mouseEncoding == MouseEncoding.SGR) {
1687 sb.append((char) 0x1B);
1688 sb.append("[<");
1689 int buttons = 0;
1690
1691 if (mouse.isMouse1()) {
1692 if (mouse.getType() == TMouseEvent.Type.MOUSE_MOTION) {
1693 buttons = 32;
1694 } else {
1695 buttons = 0;
1696 }
1697 } else if (mouse.isMouse2()) {
1698 if (mouse.getType() == TMouseEvent.Type.MOUSE_MOTION) {
1699 buttons = 33;
1700 } else {
1701 buttons = 1;
1702 }
1703 } else if (mouse.isMouse3()) {
1704 if (mouse.getType() == TMouseEvent.Type.MOUSE_MOTION) {
1705 buttons = 34;
1706 } else {
1707 buttons = 2;
1708 }
1709 } else if (mouse.isMouseWheelUp()) {
1710 buttons = 64;
1711 } else if (mouse.isMouseWheelDown()) {
1712 buttons = 65;
1713 } else {
1714 // This is motion with no buttons down.
1715 buttons = 35;
1716 }
1717 if (mouse.isAlt()) {
1718 buttons |= 0x08;
1719 }
1720 if (mouse.isCtrl()) {
1721 buttons |= 0x10;
1722 }
1723 if (mouse.isShift()) {
1724 buttons |= 0x04;
1725 }
1726
1727 sb.append(String.format("%d;%d;%d", buttons, mouse.getX() + 1,
1728 mouse.getY() + 1));
1729
1730 if (mouse.getType() == TMouseEvent.Type.MOUSE_UP) {
1731 sb.append("m");
1732 } else {
1733 sb.append("M");
1734 }
1735
1736 } else {
1737 // X10 and UTF8 encodings
1738 sb.append((char) 0x1B);
1739 sb.append('[');
1740 sb.append('M');
1741 int buttons = 0;
1742 if (mouse.getType() == TMouseEvent.Type.MOUSE_UP) {
1743 buttons = 0x03 + 32;
1744 } else if (mouse.isMouse1()) {
1745 if (mouse.getType() == TMouseEvent.Type.MOUSE_MOTION) {
1746 buttons = 0x00 + 32 + 32;
1747 } else {
1748 buttons = 0x00 + 32;
1749 }
1750 } else if (mouse.isMouse2()) {
1751 if (mouse.getType() == TMouseEvent.Type.MOUSE_MOTION) {
1752 buttons = 0x01 + 32 + 32;
1753 } else {
1754 buttons = 0x01 + 32;
1755 }
1756 } else if (mouse.isMouse3()) {
1757 if (mouse.getType() == TMouseEvent.Type.MOUSE_MOTION) {
1758 buttons = 0x02 + 32 + 32;
1759 } else {
1760 buttons = 0x02 + 32;
1761 }
1762 } else if (mouse.isMouseWheelUp()) {
1763 buttons = 0x04 + 64;
1764 } else if (mouse.isMouseWheelDown()) {
1765 buttons = 0x05 + 64;
1766 } else {
1767 // This is motion with no buttons down.
1768 buttons = 0x03 + 32;
1769 }
1770 if (mouse.isAlt()) {
1771 buttons |= 0x08;
1772 }
1773 if (mouse.isCtrl()) {
1774 buttons |= 0x10;
1775 }
1776 if (mouse.isShift()) {
1777 buttons |= 0x04;
1778 }
1779
1780 sb.append((char) (buttons & 0xFF));
1781 sb.append((char) (mouse.getX() + 33));
1782 sb.append((char) (mouse.getY() + 33));
1783 }
1784
1785 // System.err.printf("Would write: \'%s\'\n", sb.toString());
1786 writeRemote(sb.toString());
1787 }
1788
1789 /**
1790 * Translate the keyboard press to a VT100, VT220, or XTERM sequence and
1791 * send to the remote side.
1792 *
1793 * @param keypress keypress received from the local user
1794 */
1795 private void keypress(final TKeypress keypress) {
1796 writeRemote(keypressToString(keypress));
1797 }
1798
1799 /**
1800 * Build one of the complex xterm keystroke sequences, storing the result in
1801 * xterm_keystroke_buffer.
1802 *
1803 * @param ss3 the prefix to use based on VT100 state.
1804 * @param first the first character, usually a number.
1805 * @param first the last character, one of the following: ~ A B C D F H
1806 * @param ctrl whether or not ctrl is down
1807 * @param alt whether or not alt is down
1808 * @param shift whether or not shift is down
1809 * @return the buffer with the full key sequence
1810 */
1811 private String xtermBuildKeySequence(final String ss3, final char first,
1812 final char last, boolean ctrl, boolean alt, boolean shift) {
1813
1814 StringBuilder sb = new StringBuilder(ss3);
1815 if ((last == '~') || (ctrl == true) || (alt == true)
1816 || (shift == true)
1817 ) {
1818 sb.append(first);
1819 if ( (ctrl == false) && (alt == false) && (shift == true)) {
1820 sb.append(";2");
1821 } else if ((ctrl == false) && (alt == true) && (shift == false)) {
1822 sb.append(";3");
1823 } else if ((ctrl == false) && (alt == true) && (shift == true)) {
1824 sb.append(";4");
1825 } else if ((ctrl == true) && (alt == false) && (shift == false)) {
1826 sb.append(";5");
1827 } else if ((ctrl == true) && (alt == false) && (shift == true)) {
1828 sb.append(";6");
1829 } else if ((ctrl == true) && (alt == true) && (shift == false)) {
1830 sb.append(";7");
1831 } else if ((ctrl == true) && (alt == true) && (shift == true)) {
1832 sb.append(";8");
1833 }
1834 }
1835 sb.append(last);
1836 return sb.toString();
1837 }
1838
1839 /**
1840 * Translate the keyboard press to a VT100, VT220, or XTERM sequence.
1841 *
1842 * @param keypress keypress received from the local user
1843 * @return string to transmit to the remote side
1844 */
1845 @SuppressWarnings("fallthrough")
1846 private String keypressToString(final TKeypress keypress) {
1847
1848 if ((fullDuplex == false) && (!keypress.isFnKey())) {
1849 /*
1850 * If this is a control character, process it like it came from
1851 * the remote side.
1852 */
1853 if (keypress.getChar() < 0x20) {
1854 handleControlChar((char) keypress.getChar());
1855 } else {
1856 // Local echo for everything else
1857 printCharacter(keypress.getChar());
1858 }
1859 if (displayListener != null) {
1860 displayListener.displayChanged();
1861 }
1862 }
1863
1864 if ((newLineMode == true) && (keypress.equals(kbEnter))) {
1865 // NLM: send CRLF
1866 return "\015\012";
1867 }
1868
1869 // Handle control characters
1870 if ((keypress.isCtrl()) && (!keypress.isFnKey())) {
1871 StringBuilder sb = new StringBuilder();
1872 int ch = keypress.getChar();
1873 ch -= 0x40;
1874 sb.append(Character.toChars(ch));
1875 return sb.toString();
1876 }
1877
1878 // Handle alt characters
1879 if ((keypress.isAlt()) && (!keypress.isFnKey())) {
1880 StringBuilder sb = new StringBuilder("\033");
1881 int ch = keypress.getChar();
1882 sb.append(Character.toChars(ch));
1883 return sb.toString();
1884 }
1885
1886 if (keypress.equals(kbBackspaceDel)) {
1887 switch (type) {
1888 case VT100:
1889 return "\010";
1890 case VT102:
1891 return "\010";
1892 case VT220:
1893 return "\177";
1894 case XTERM:
1895 return "\177";
1896 }
1897 }
1898
1899 if (keypress.equalsWithoutModifiers(kbLeft)) {
1900 switch (type) {
1901 case XTERM:
1902 switch (arrowKeyMode) {
1903 case ANSI:
1904 return xtermBuildKeySequence("\033[", '1', 'D',
1905 keypress.isCtrl(), keypress.isAlt(),
1906 keypress.isShift());
1907 case VT52:
1908 return xtermBuildKeySequence("\033", '1', 'D',
1909 keypress.isCtrl(), keypress.isAlt(),
1910 keypress.isShift());
1911 case VT100:
1912 return xtermBuildKeySequence("\033O", '1', 'D',
1913 keypress.isCtrl(), keypress.isAlt(),
1914 keypress.isShift());
1915 }
1916 default:
1917 switch (arrowKeyMode) {
1918 case ANSI:
1919 return "\033[D";
1920 case VT52:
1921 return "\033D";
1922 case VT100:
1923 return "\033OD";
1924 }
1925 }
1926 }
1927
1928 if (keypress.equalsWithoutModifiers(kbRight)) {
1929 switch (type) {
1930 case XTERM:
1931 switch (arrowKeyMode) {
1932 case ANSI:
1933 return xtermBuildKeySequence("\033[", '1', 'C',
1934 keypress.isCtrl(), keypress.isAlt(),
1935 keypress.isShift());
1936 case VT52:
1937 return xtermBuildKeySequence("\033", '1', 'C',
1938 keypress.isCtrl(), keypress.isAlt(),
1939 keypress.isShift());
1940 case VT100:
1941 return xtermBuildKeySequence("\033O", '1', 'C',
1942 keypress.isCtrl(), keypress.isAlt(),
1943 keypress.isShift());
1944 }
1945 default:
1946 switch (arrowKeyMode) {
1947 case ANSI:
1948 return "\033[C";
1949 case VT52:
1950 return "\033C";
1951 case VT100:
1952 return "\033OC";
1953 }
1954 }
1955 }
1956
1957 if (keypress.equalsWithoutModifiers(kbUp)) {
1958 switch (type) {
1959 case XTERM:
1960 switch (arrowKeyMode) {
1961 case ANSI:
1962 return xtermBuildKeySequence("\033[", '1', 'A',
1963 keypress.isCtrl(), keypress.isAlt(),
1964 keypress.isShift());
1965 case VT52:
1966 return xtermBuildKeySequence("\033", '1', 'A',
1967 keypress.isCtrl(), keypress.isAlt(),
1968 keypress.isShift());
1969 case VT100:
1970 return xtermBuildKeySequence("\033O", '1', 'A',
1971 keypress.isCtrl(), keypress.isAlt(),
1972 keypress.isShift());
1973 }
1974 default:
1975 switch (arrowKeyMode) {
1976 case ANSI:
1977 return "\033[A";
1978 case VT52:
1979 return "\033A";
1980 case VT100:
1981 return "\033OA";
1982 }
1983 }
1984 }
1985
1986 if (keypress.equalsWithoutModifiers(kbDown)) {
1987 switch (type) {
1988 case XTERM:
1989 switch (arrowKeyMode) {
1990 case ANSI:
1991 return xtermBuildKeySequence("\033[", '1', 'B',
1992 keypress.isCtrl(), keypress.isAlt(),
1993 keypress.isShift());
1994 case VT52:
1995 return xtermBuildKeySequence("\033", '1', 'B',
1996 keypress.isCtrl(), keypress.isAlt(),
1997 keypress.isShift());
1998 case VT100:
1999 return xtermBuildKeySequence("\033O", '1', 'B',
2000 keypress.isCtrl(), keypress.isAlt(),
2001 keypress.isShift());
2002 }
2003 default:
2004 switch (arrowKeyMode) {
2005 case ANSI:
2006 return "\033[B";
2007 case VT52:
2008 return "\033B";
2009 case VT100:
2010 return "\033OB";
2011 }
2012 }
2013 }
2014
2015 if (keypress.equalsWithoutModifiers(kbHome)) {
2016 switch (type) {
2017 case XTERM:
2018 switch (arrowKeyMode) {
2019 case ANSI:
2020 return xtermBuildKeySequence("\033[", '1', 'H',
2021 keypress.isCtrl(), keypress.isAlt(),
2022 keypress.isShift());
2023 case VT52:
2024 return xtermBuildKeySequence("\033", '1', 'H',
2025 keypress.isCtrl(), keypress.isAlt(),
2026 keypress.isShift());
2027 case VT100:
2028 return xtermBuildKeySequence("\033O", '1', 'H',
2029 keypress.isCtrl(), keypress.isAlt(),
2030 keypress.isShift());
2031 }
2032 default:
2033 switch (arrowKeyMode) {
2034 case ANSI:
2035 return "\033[H";
2036 case VT52:
2037 return "\033H";
2038 case VT100:
2039 return "\033OH";
2040 }
2041 }
2042 }
2043
2044 if (keypress.equalsWithoutModifiers(kbEnd)) {
2045 switch (type) {
2046 case XTERM:
2047 switch (arrowKeyMode) {
2048 case ANSI:
2049 return xtermBuildKeySequence("\033[", '1', 'F',
2050 keypress.isCtrl(), keypress.isAlt(),
2051 keypress.isShift());
2052 case VT52:
2053 return xtermBuildKeySequence("\033", '1', 'F',
2054 keypress.isCtrl(), keypress.isAlt(),
2055 keypress.isShift());
2056 case VT100:
2057 return xtermBuildKeySequence("\033O", '1', 'F',
2058 keypress.isCtrl(), keypress.isAlt(),
2059 keypress.isShift());
2060 }
2061 default:
2062 switch (arrowKeyMode) {
2063 case ANSI:
2064 return "\033[F";
2065 case VT52:
2066 return "\033F";
2067 case VT100:
2068 return "\033OF";
2069 }
2070 }
2071 }
2072
2073 if (keypress.equals(kbF1)) {
2074 // PF1
2075 if (vt52Mode) {
2076 return "\033P";
2077 }
2078 return "\033OP";
2079 }
2080
2081 if (keypress.equals(kbF2)) {
2082 // PF2
2083 if (vt52Mode) {
2084 return "\033Q";
2085 }
2086 return "\033OQ";
2087 }
2088
2089 if (keypress.equals(kbF3)) {
2090 // PF3
2091 if (vt52Mode) {
2092 return "\033R";
2093 }
2094 return "\033OR";
2095 }
2096
2097 if (keypress.equals(kbF4)) {
2098 // PF4
2099 if (vt52Mode) {
2100 return "\033S";
2101 }
2102 return "\033OS";
2103 }
2104
2105 if (keypress.equals(kbF5)) {
2106 switch (type) {
2107 case VT100:
2108 return "\033Ot";
2109 case VT102:
2110 return "\033Ot";
2111 case VT220:
2112 return "\033[15~";
2113 case XTERM:
2114 return "\033[15~";
2115 }
2116 }
2117
2118 if (keypress.equals(kbF6)) {
2119 switch (type) {
2120 case VT100:
2121 return "\033Ou";
2122 case VT102:
2123 return "\033Ou";
2124 case VT220:
2125 return "\033[17~";
2126 case XTERM:
2127 return "\033[17~";
2128 }
2129 }
2130
2131 if (keypress.equals(kbF7)) {
2132 switch (type) {
2133 case VT100:
2134 return "\033Ov";
2135 case VT102:
2136 return "\033Ov";
2137 case VT220:
2138 return "\033[18~";
2139 case XTERM:
2140 return "\033[18~";
2141 }
2142 }
2143
2144 if (keypress.equals(kbF8)) {
2145 switch (type) {
2146 case VT100:
2147 return "\033Ol";
2148 case VT102:
2149 return "\033Ol";
2150 case VT220:
2151 return "\033[19~";
2152 case XTERM:
2153 return "\033[19~";
2154 }
2155 }
2156
2157 if (keypress.equals(kbF9)) {
2158 switch (type) {
2159 case VT100:
2160 return "\033Ow";
2161 case VT102:
2162 return "\033Ow";
2163 case VT220:
2164 return "\033[20~";
2165 case XTERM:
2166 return "\033[20~";
2167 }
2168 }
2169
2170 if (keypress.equals(kbF10)) {
2171 switch (type) {
2172 case VT100:
2173 return "\033Ox";
2174 case VT102:
2175 return "\033Ox";
2176 case VT220:
2177 return "\033[21~";
2178 case XTERM:
2179 return "\033[21~";
2180 }
2181 }
2182
2183 if (keypress.equals(kbF11)) {
2184 return "\033[23~";
2185 }
2186
2187 if (keypress.equals(kbF12)) {
2188 return "\033[24~";
2189 }
2190
2191 if (keypress.equals(kbShiftF1)) {
2192 // Shifted PF1
2193 if (vt52Mode) {
2194 return "\0332P";
2195 }
2196 if (type == DeviceType.XTERM) {
2197 return "\0331;2P";
2198 }
2199 return "\033O2P";
2200 }
2201
2202 if (keypress.equals(kbShiftF2)) {
2203 // Shifted PF2
2204 if (vt52Mode) {
2205 return "\0332Q";
2206 }
2207 if (type == DeviceType.XTERM) {
2208 return "\0331;2Q";
2209 }
2210 return "\033O2Q";
2211 }
2212
2213 if (keypress.equals(kbShiftF3)) {
2214 // Shifted PF3
2215 if (vt52Mode) {
2216 return "\0332R";
2217 }
2218 if (type == DeviceType.XTERM) {
2219 return "\0331;2R";
2220 }
2221 return "\033O2R";
2222 }
2223
2224 if (keypress.equals(kbShiftF4)) {
2225 // Shifted PF4
2226 if (vt52Mode) {
2227 return "\0332S";
2228 }
2229 if (type == DeviceType.XTERM) {
2230 return "\0331;2S";
2231 }
2232 return "\033O2S";
2233 }
2234
2235 if (keypress.equals(kbShiftF5)) {
2236 // Shifted F5
2237 return "\033[15;2~";
2238 }
2239
2240 if (keypress.equals(kbShiftF6)) {
2241 // Shifted F6
2242 return "\033[17;2~";
2243 }
2244
2245 if (keypress.equals(kbShiftF7)) {
2246 // Shifted F7
2247 return "\033[18;2~";
2248 }
2249
2250 if (keypress.equals(kbShiftF8)) {
2251 // Shifted F8
2252 return "\033[19;2~";
2253 }
2254
2255 if (keypress.equals(kbShiftF9)) {
2256 // Shifted F9
2257 return "\033[20;2~";
2258 }
2259
2260 if (keypress.equals(kbShiftF10)) {
2261 // Shifted F10
2262 return "\033[21;2~";
2263 }
2264
2265 if (keypress.equals(kbShiftF11)) {
2266 // Shifted F11
2267 return "\033[23;2~";
2268 }
2269
2270 if (keypress.equals(kbShiftF12)) {
2271 // Shifted F12
2272 return "\033[24;2~";
2273 }
2274
2275 if (keypress.equals(kbCtrlF1)) {
2276 // Control PF1
2277 if (vt52Mode) {
2278 return "\0335P";
2279 }
2280 if (type == DeviceType.XTERM) {
2281 return "\0331;5P";
2282 }
2283 return "\033O5P";
2284 }
2285
2286 if (keypress.equals(kbCtrlF2)) {
2287 // Control PF2
2288 if (vt52Mode) {
2289 return "\0335Q";
2290 }
2291 if (type == DeviceType.XTERM) {
2292 return "\0331;5Q";
2293 }
2294 return "\033O5Q";
2295 }
2296
2297 if (keypress.equals(kbCtrlF3)) {
2298 // Control PF3
2299 if (vt52Mode) {
2300 return "\0335R";
2301 }
2302 if (type == DeviceType.XTERM) {
2303 return "\0331;5R";
2304 }
2305 return "\033O5R";
2306 }
2307
2308 if (keypress.equals(kbCtrlF4)) {
2309 // Control PF4
2310 if (vt52Mode) {
2311 return "\0335S";
2312 }
2313 if (type == DeviceType.XTERM) {
2314 return "\0331;5S";
2315 }
2316 return "\033O5S";
2317 }
2318
2319 if (keypress.equals(kbCtrlF5)) {
2320 // Control F5
2321 return "\033[15;5~";
2322 }
2323
2324 if (keypress.equals(kbCtrlF6)) {
2325 // Control F6
2326 return "\033[17;5~";
2327 }
2328
2329 if (keypress.equals(kbCtrlF7)) {
2330 // Control F7
2331 return "\033[18;5~";
2332 }
2333
2334 if (keypress.equals(kbCtrlF8)) {
2335 // Control F8
2336 return "\033[19;5~";
2337 }
2338
2339 if (keypress.equals(kbCtrlF9)) {
2340 // Control F9
2341 return "\033[20;5~";
2342 }
2343
2344 if (keypress.equals(kbCtrlF10)) {
2345 // Control F10
2346 return "\033[21;5~";
2347 }
2348
2349 if (keypress.equals(kbCtrlF11)) {
2350 // Control F11
2351 return "\033[23;5~";
2352 }
2353
2354 if (keypress.equals(kbCtrlF12)) {
2355 // Control F12
2356 return "\033[24;5~";
2357 }
2358
2359 if (keypress.equalsWithoutModifiers(kbPgUp)) {
2360 switch (type) {
2361 case XTERM:
2362 return xtermBuildKeySequence("\033[", '5', '~',
2363 keypress.isCtrl(), keypress.isAlt(),
2364 keypress.isShift());
2365 default:
2366 return "\033[5~";
2367 }
2368 }
2369
2370 if (keypress.equalsWithoutModifiers(kbPgDn)) {
2371 switch (type) {
2372 case XTERM:
2373 return xtermBuildKeySequence("\033[", '6', '~',
2374 keypress.isCtrl(), keypress.isAlt(),
2375 keypress.isShift());
2376 default:
2377 return "\033[6~";
2378 }
2379 }
2380
2381 if (keypress.equalsWithoutModifiers(kbIns)) {
2382 switch (type) {
2383 case XTERM:
2384 return xtermBuildKeySequence("\033[", '2', '~',
2385 keypress.isCtrl(), keypress.isAlt(),
2386 keypress.isShift());
2387 default:
2388 return "\033[2~";
2389 }
2390 }
2391
2392 if (keypress.equalsWithoutModifiers(kbDel)) {
2393 switch (type) {
2394 case XTERM:
2395 return xtermBuildKeySequence("\033[", '3', '~',
2396 keypress.isCtrl(), keypress.isAlt(),
2397 keypress.isShift());
2398 default:
2399 // Delete sends real delete for VTxxx
2400 return "\177";
2401 }
2402 }
2403
2404 if (keypress.equals(kbEnter)) {
2405 return "\015";
2406 }
2407
2408 if (keypress.equals(kbEsc)) {
2409 return "\033";
2410 }
2411
2412 if (keypress.equals(kbAltEsc)) {
2413 return "\033\033";
2414 }
2415
2416 if (keypress.equals(kbTab)) {
2417 return "\011";
2418 }
2419
2420 if ((keypress.equalsWithoutModifiers(kbBackTab)) ||
2421 (keypress.equals(kbShiftTab))
2422 ) {
2423 switch (type) {
2424 case XTERM:
2425 return "\033[Z";
2426 default:
2427 return "\011";
2428 }
2429 }
2430
2431 // Non-alt, non-ctrl characters
2432 if (!keypress.isFnKey()) {
2433 StringBuilder sb = new StringBuilder();
2434 sb.append(Character.toChars(keypress.getChar()));
2435 return sb.toString();
2436 }
2437 return "";
2438 }
2439
2440 /**
2441 * Map a symbol in any one of the VT100/VT220 character sets to a Unicode
2442 * symbol.
2443 *
2444 * @param ch 8-bit character from the remote side
2445 * @param charsetGl character set defined for GL
2446 * @param charsetGr character set defined for GR
2447 * @return character to display on the screen
2448 */
2449 private char mapCharacterCharset(final int ch,
2450 final CharacterSet charsetGl,
2451 final CharacterSet charsetGr) {
2452
2453 int lookupChar = ch;
2454 CharacterSet lookupCharset = charsetGl;
2455
2456 if (ch >= 0x80) {
2457 assert ((type == DeviceType.VT220) || (type == DeviceType.XTERM));
2458 lookupCharset = charsetGr;
2459 lookupChar &= 0x7F;
2460 }
2461
2462 switch (lookupCharset) {
2463
2464 case DRAWING:
2465 return DECCharacterSets.SPECIAL_GRAPHICS[lookupChar];
2466
2467 case UK:
2468 return DECCharacterSets.UK[lookupChar];
2469
2470 case US:
2471 return DECCharacterSets.US_ASCII[lookupChar];
2472
2473 case NRC_DUTCH:
2474 return DECCharacterSets.NL[lookupChar];
2475
2476 case NRC_FINNISH:
2477 return DECCharacterSets.FI[lookupChar];
2478
2479 case NRC_FRENCH:
2480 return DECCharacterSets.FR[lookupChar];
2481
2482 case NRC_FRENCH_CA:
2483 return DECCharacterSets.FR_CA[lookupChar];
2484
2485 case NRC_GERMAN:
2486 return DECCharacterSets.DE[lookupChar];
2487
2488 case NRC_ITALIAN:
2489 return DECCharacterSets.IT[lookupChar];
2490
2491 case NRC_NORWEGIAN:
2492 return DECCharacterSets.NO[lookupChar];
2493
2494 case NRC_SPANISH:
2495 return DECCharacterSets.ES[lookupChar];
2496
2497 case NRC_SWEDISH:
2498 return DECCharacterSets.SV[lookupChar];
2499
2500 case NRC_SWISS:
2501 return DECCharacterSets.SWISS[lookupChar];
2502
2503 case DEC_SUPPLEMENTAL:
2504 return DECCharacterSets.DEC_SUPPLEMENTAL[lookupChar];
2505
2506 case VT52_GRAPHICS:
2507 return DECCharacterSets.VT52_SPECIAL_GRAPHICS[lookupChar];
2508
2509 case ROM:
2510 return DECCharacterSets.US_ASCII[lookupChar];
2511
2512 case ROM_SPECIAL:
2513 return DECCharacterSets.US_ASCII[lookupChar];
2514
2515 default:
2516 throw new IllegalArgumentException("Invalid character set value: "
2517 + lookupCharset);
2518 }
2519 }
2520
2521 /**
2522 * Map an 8-bit byte into a printable character.
2523 *
2524 * @param ch either 8-bit or Unicode character from the remote side
2525 * @return character to display on the screen
2526 */
2527 private int mapCharacter(final int ch) {
2528 if (ch >= 0x100) {
2529 // Unicode character, just return it
2530 return ch;
2531 }
2532
2533 CharacterSet charsetGl = currentState.g0Charset;
2534 CharacterSet charsetGr = currentState.grCharset;
2535
2536 if (vt52Mode == true) {
2537 if (shiftOut == true) {
2538 // Shifted out character, pull from VT52 graphics
2539 charsetGl = currentState.g1Charset;
2540 charsetGr = CharacterSet.US;
2541 } else {
2542 // Normal
2543 charsetGl = currentState.g0Charset;
2544 charsetGr = CharacterSet.US;
2545 }
2546
2547 // Pull the character
2548 return mapCharacterCharset(ch, charsetGl, charsetGr);
2549 }
2550
2551 // shiftOout
2552 if (shiftOut == true) {
2553 // Shifted out character, pull from G1
2554 charsetGl = currentState.g1Charset;
2555 charsetGr = currentState.grCharset;
2556
2557 // Pull the character
2558 return mapCharacterCharset(ch, charsetGl, charsetGr);
2559 }
2560
2561 // SS2
2562 if (singleshift == Singleshift.SS2) {
2563
2564 singleshift = Singleshift.NONE;
2565
2566 // Shifted out character, pull from G2
2567 charsetGl = currentState.g2Charset;
2568 charsetGr = currentState.grCharset;
2569 }
2570
2571 // SS3
2572 if (singleshift == Singleshift.SS3) {
2573
2574 singleshift = Singleshift.NONE;
2575
2576 // Shifted out character, pull from G3
2577 charsetGl = currentState.g3Charset;
2578 charsetGr = currentState.grCharset;
2579 }
2580
2581 if ((type == DeviceType.VT220) || (type == DeviceType.XTERM)) {
2582 // Check for locking shift
2583
2584 switch (currentState.glLockshift) {
2585
2586 case G1_GR:
2587 throw new IllegalArgumentException("programming bug");
2588
2589 case G2_GR:
2590 throw new IllegalArgumentException("programming bug");
2591
2592 case G3_GR:
2593 throw new IllegalArgumentException("programming bug");
2594
2595 case G2_GL:
2596 // LS2
2597 charsetGl = currentState.g2Charset;
2598 break;
2599
2600 case G3_GL:
2601 // LS3
2602 charsetGl = currentState.g3Charset;
2603 break;
2604
2605 case NONE:
2606 // Normal
2607 charsetGl = currentState.g0Charset;
2608 break;
2609 }
2610
2611 switch (currentState.grLockshift) {
2612
2613 case G2_GL:
2614 throw new IllegalArgumentException("programming bug");
2615
2616 case G3_GL:
2617 throw new IllegalArgumentException("programming bug");
2618
2619 case G1_GR:
2620 // LS1R
2621 charsetGr = currentState.g1Charset;
2622 break;
2623
2624 case G2_GR:
2625 // LS2R
2626 charsetGr = currentState.g2Charset;
2627 break;
2628
2629 case G3_GR:
2630 // LS3R
2631 charsetGr = currentState.g3Charset;
2632 break;
2633
2634 case NONE:
2635 // Normal
2636 charsetGr = CharacterSet.DEC_SUPPLEMENTAL;
2637 break;
2638 }
2639
2640
2641 }
2642
2643 // Pull the character
2644 return mapCharacterCharset(ch, charsetGl, charsetGr);
2645 }
2646
2647 /**
2648 * Scroll the text within a scrolling region up n lines.
2649 *
2650 * @param regionTop top row of the scrolling region
2651 * @param regionBottom bottom row of the scrolling region
2652 * @param n number of lines to scroll
2653 */
2654 private void scrollingRegionScrollUp(final int regionTop,
2655 final int regionBottom, final int n) {
2656
2657 if (regionTop >= regionBottom) {
2658 return;
2659 }
2660
2661 // Sanity check: see if there will be any characters left after the
2662 // scroll
2663 if (regionBottom + 1 - regionTop <= n) {
2664 // There won't be anything left in the region, so just call
2665 // eraseScreen() and return.
2666 eraseScreen(regionTop, 0, regionBottom, width - 1, false);
2667 return;
2668 }
2669
2670 int remaining = regionBottom + 1 - regionTop - n;
2671 List<DisplayLine> displayTop = display.subList(0, regionTop);
2672 List<DisplayLine> displayBottom = display.subList(regionBottom + 1,
2673 display.size());
2674 List<DisplayLine> displayMiddle = display.subList(regionBottom + 1
2675 - remaining, regionBottom + 1);
2676 display = new ArrayList<DisplayLine>(displayTop);
2677 display.addAll(displayMiddle);
2678 for (int i = 0; i < n; i++) {
2679 DisplayLine line = new DisplayLine(currentState.attr);
2680 line.setReverseColor(reverseVideo);
2681 display.add(line);
2682 }
2683 display.addAll(displayBottom);
2684
2685 assert (display.size() == height);
2686 }
2687
2688 /**
2689 * Scroll the text within a scrolling region down n lines.
2690 *
2691 * @param regionTop top row of the scrolling region
2692 * @param regionBottom bottom row of the scrolling region
2693 * @param n number of lines to scroll
2694 */
2695 private void scrollingRegionScrollDown(final int regionTop,
2696 final int regionBottom, final int n) {
2697
2698 if (regionTop >= regionBottom) {
2699 return;
2700 }
2701
2702 // Sanity check: see if there will be any characters left after the
2703 // scroll
2704 if (regionBottom + 1 - regionTop <= n) {
2705 // There won't be anything left in the region, so just call
2706 // eraseScreen() and return.
2707 eraseScreen(regionTop, 0, regionBottom, width - 1, false);
2708 return;
2709 }
2710
2711 int remaining = regionBottom + 1 - regionTop - n;
2712 List<DisplayLine> displayTop = display.subList(0, regionTop);
2713 List<DisplayLine> displayBottom = display.subList(regionBottom + 1,
2714 display.size());
2715 List<DisplayLine> displayMiddle = display.subList(regionTop,
2716 regionTop + remaining);
2717 display = new ArrayList<DisplayLine>(displayTop);
2718 for (int i = 0; i < n; i++) {
2719 DisplayLine line = new DisplayLine(currentState.attr);
2720 line.setReverseColor(reverseVideo);
2721 display.add(line);
2722 }
2723 display.addAll(displayMiddle);
2724 display.addAll(displayBottom);
2725
2726 assert (display.size() == height);
2727 }
2728
2729 /**
2730 * Process a control character.
2731 *
2732 * @param ch 8-bit character from the remote side
2733 */
2734 private void handleControlChar(final char ch) {
2735 assert ((ch <= 0x1F) || ((ch >= 0x7F) && (ch <= 0x9F)));
2736
2737 switch (ch) {
2738
2739 case 0x00:
2740 // NUL - discard
2741 return;
2742
2743 case 0x05:
2744 // ENQ
2745
2746 // Transmit the answerback message.
2747 // Not supported
2748 break;
2749
2750 case 0x07:
2751 // BEL
2752 // Not supported
2753 break;
2754
2755 case 0x08:
2756 // BS
2757 cursorLeft(1, false);
2758 break;
2759
2760 case 0x09:
2761 // HT
2762 advanceToNextTabStop();
2763 break;
2764
2765 case 0x0A:
2766 // LF
2767 linefeed();
2768 break;
2769
2770 case 0x0B:
2771 // VT
2772 linefeed();
2773 break;
2774
2775 case 0x0C:
2776 // FF
2777 linefeed();
2778 break;
2779
2780 case 0x0D:
2781 // CR
2782 carriageReturn();
2783 break;
2784
2785 case 0x0E:
2786 // SO
2787 shiftOut = true;
2788 currentState.glLockshift = LockshiftMode.NONE;
2789 break;
2790
2791 case 0x0F:
2792 // SI
2793 shiftOut = false;
2794 currentState.glLockshift = LockshiftMode.NONE;
2795 break;
2796
2797 case 0x84:
2798 // IND
2799 ind();
2800 break;
2801
2802 case 0x85:
2803 // NEL
2804 nel();
2805 break;
2806
2807 case 0x88:
2808 // HTS
2809 hts();
2810 break;
2811
2812 case 0x8D:
2813 // RI
2814 ri();
2815 break;
2816
2817 case 0x8E:
2818 // SS2
2819 singleshift = Singleshift.SS2;
2820 break;
2821
2822 case 0x8F:
2823 // SS3
2824 singleshift = Singleshift.SS3;
2825 break;
2826
2827 default:
2828 break;
2829 }
2830
2831 }
2832
2833 /**
2834 * Advance the cursor to the next tab stop.
2835 */
2836 private void advanceToNextTabStop() {
2837 if (tabStops.size() == 0) {
2838 // Go to the rightmost column
2839 cursorRight(rightMargin - currentState.cursorX, false);
2840 return;
2841 }
2842 for (Integer stop: tabStops) {
2843 if (stop > currentState.cursorX) {
2844 cursorRight(stop - currentState.cursorX, false);
2845 return;
2846 }
2847 }
2848 /*
2849 * We got here, meaning there isn't a tab stop beyond the current
2850 * cursor position. Place the cursor of the right-most edge of the
2851 * screen.
2852 */
2853 cursorRight(rightMargin - currentState.cursorX, false);
2854 }
2855
2856 /**
2857 * Save a character into the collect buffer.
2858 *
2859 * @param ch character to save
2860 */
2861 private void collect(final char ch) {
2862 collectBuffer.append(ch);
2863 }
2864
2865 /**
2866 * Save a byte into the CSI parameters buffer.
2867 *
2868 * @param ch byte to save
2869 */
2870 private void param(final byte ch) {
2871 if (csiParams.size() == 0) {
2872 csiParams.add(Integer.valueOf(0));
2873 }
2874 Integer x = csiParams.get(csiParams.size() - 1);
2875 if ((ch >= '0') && (ch <= '9')) {
2876 x *= 10;
2877 x += (ch - '0');
2878 csiParams.set(csiParams.size() - 1, x);
2879 }
2880
2881 if ((ch == ';') && (csiParams.size() < 16)) {
2882 csiParams.add(Integer.valueOf(0));
2883 }
2884 }
2885
2886 /**
2887 * Get a CSI parameter value, with a default.
2888 *
2889 * @param position parameter index. 0 is the first parameter.
2890 * @param defaultValue value to use if csiParams[position] doesn't exist
2891 * @return parameter value
2892 */
2893 private int getCsiParam(final int position, final int defaultValue) {
2894 if (csiParams.size() < position + 1) {
2895 return defaultValue;
2896 }
2897 return csiParams.get(position).intValue();
2898 }
2899
2900 /**
2901 * Get a CSI parameter value, clamped to within min/max.
2902 *
2903 * @param position parameter index. 0 is the first parameter.
2904 * @param defaultValue value to use if csiParams[position] doesn't exist
2905 * @param minValue minimum value inclusive
2906 * @param maxValue maximum value inclusive
2907 * @return parameter value
2908 */
2909 private int getCsiParam(final int position, final int defaultValue,
2910 final int minValue, final int maxValue) {
2911
2912 assert (minValue <= maxValue);
2913 int value = getCsiParam(position, defaultValue);
2914 if (value < minValue) {
2915 value = minValue;
2916 }
2917 if (value > maxValue) {
2918 value = maxValue;
2919 }
2920 return value;
2921 }
2922
2923 /**
2924 * Set or unset a toggle.
2925 *
2926 * @param value true for set ('h'), false for reset ('l')
2927 */
2928 private void setToggle(final boolean value) {
2929 boolean decPrivateModeFlag = false;
2930
2931 for (int i = 0; i < collectBuffer.length(); i++) {
2932 if (collectBuffer.charAt(i) == '?') {
2933 decPrivateModeFlag = true;
2934 break;
2935 }
2936 }
2937
2938 for (Integer i: csiParams) {
2939
2940 switch (i) {
2941
2942 case 1:
2943 if (decPrivateModeFlag == true) {
2944 // DECCKM
2945 if (value == true) {
2946 // Use application arrow keys
2947 arrowKeyMode = ArrowKeyMode.VT100;
2948 } else {
2949 // Use ANSI arrow keys
2950 arrowKeyMode = ArrowKeyMode.ANSI;
2951 }
2952 }
2953 break;
2954 case 2:
2955 if (decPrivateModeFlag == true) {
2956 if (value == false) {
2957
2958 // DECANM
2959 vt52Mode = true;
2960 arrowKeyMode = ArrowKeyMode.VT52;
2961
2962 /*
2963 * From the VT102 docs: "You use ANSI mode to select
2964 * most terminal features; the terminal uses the same
2965 * features when it switches to VT52 mode. You
2966 * cannot, however, change most of these features in
2967 * VT52 mode."
2968 *
2969 * In other words, do not reset any other attributes
2970 * when switching between VT52 submode and ANSI.
2971 *
2972 * HOWEVER, the real vt100 does switch the character
2973 * set according to Usenet.
2974 */
2975 currentState.g0Charset = CharacterSet.US;
2976 currentState.g1Charset = CharacterSet.DRAWING;
2977 shiftOut = false;
2978
2979 if ((type == DeviceType.VT220)
2980 || (type == DeviceType.XTERM)) {
2981
2982 // VT52 mode is explicitly 7-bit
2983 s8c1t = false;
2984 singleshift = Singleshift.NONE;
2985 }
2986 }
2987 } else {
2988 // KAM
2989 if (value == true) {
2990 // Turn off keyboard
2991 // Not supported
2992 } else {
2993 // Turn on keyboard
2994 // Not supported
2995 }
2996 }
2997 break;
2998 case 3:
2999 if (decPrivateModeFlag == true) {
3000 // DECCOLM
3001 if (value == true) {
3002 // 132 columns
3003 columns132 = true;
3004 rightMargin = 131;
3005 } else {
3006 // 80 columns
3007 columns132 = false;
3008 if ((displayListener != null)
3009 && (type == DeviceType.XTERM)
3010 ) {
3011 // For xterms, reset to the actual width, not 80
3012 // columns.
3013 width = displayListener.getDisplayWidth();
3014 rightMargin = width - 1;
3015 } else {
3016 rightMargin = 79;
3017 width = rightMargin + 1;
3018 }
3019 }
3020 // Entire screen is cleared, and scrolling region is
3021 // reset
3022 eraseScreen(0, 0, height - 1, width - 1, false);
3023 scrollRegionTop = 0;
3024 scrollRegionBottom = height - 1;
3025 // Also home the cursor
3026 cursorPosition(0, 0);
3027 }
3028 break;
3029 case 4:
3030 if (decPrivateModeFlag == true) {
3031 // DECSCLM
3032 if (value == true) {
3033 // Smooth scroll
3034 // Not supported
3035 } else {
3036 // Jump scroll
3037 // Not supported
3038 }
3039 } else {
3040 // IRM
3041 if (value == true) {
3042 insertMode = true;
3043 } else {
3044 insertMode = false;
3045 }
3046 }
3047 break;
3048 case 5:
3049 if (decPrivateModeFlag == true) {
3050 // DECSCNM
3051 if (value == true) {
3052 /*
3053 * Set selects reverse screen, a white screen
3054 * background with black characters.
3055 */
3056 if (reverseVideo != true) {
3057 /*
3058 * If in normal video, switch it back
3059 */
3060 invertDisplayColors();
3061 }
3062 reverseVideo = true;
3063 } else {
3064 /*
3065 * Reset selects normal screen, a black screen
3066 * background with white characters.
3067 */
3068 if (reverseVideo == true) {
3069 /*
3070 * If in reverse video already, switch it back
3071 */
3072 invertDisplayColors();
3073 }
3074 reverseVideo = false;
3075 }
3076 }
3077 break;
3078 case 6:
3079 if (decPrivateModeFlag == true) {
3080 // DECOM
3081 if (value == true) {
3082 // Origin is relative to scroll region cursor.
3083 // Cursor can NEVER leave scrolling region.
3084 currentState.originMode = true;
3085 cursorPosition(0, 0);
3086 } else {
3087 // Origin is absolute to entire screen. Cursor can
3088 // leave the scrolling region via cup() and hvp().
3089 currentState.originMode = false;
3090 cursorPosition(0, 0);
3091 }
3092 }
3093 break;
3094 case 7:
3095 if (decPrivateModeFlag == true) {
3096 // DECAWM
3097 if (value == true) {
3098 // Turn linewrap on
3099 currentState.lineWrap = true;
3100 } else {
3101 // Turn linewrap off
3102 currentState.lineWrap = false;
3103 }
3104 }
3105 break;
3106 case 8:
3107 if (decPrivateModeFlag == true) {
3108 // DECARM
3109 if (value == true) {
3110 // Keyboard auto-repeat on
3111 // Not supported
3112 } else {
3113 // Keyboard auto-repeat off
3114 // Not supported
3115 }
3116 }
3117 break;
3118 case 12:
3119 if (decPrivateModeFlag == false) {
3120 // SRM
3121 if (value == true) {
3122 // Local echo off
3123 fullDuplex = true;
3124 } else {
3125 // Local echo on
3126 fullDuplex = false;
3127 }
3128 }
3129 break;
3130 case 18:
3131 if (decPrivateModeFlag == true) {
3132 // DECPFF
3133 // Not supported
3134 }
3135 break;
3136 case 19:
3137 if (decPrivateModeFlag == true) {
3138 // DECPEX
3139 // Not supported
3140 }
3141 break;
3142 case 20:
3143 if (decPrivateModeFlag == false) {
3144 // LNM
3145 if (value == true) {
3146 /*
3147 * Set causes a received linefeed, form feed, or
3148 * vertical tab to move cursor to first column of
3149 * next line. RETURN transmits both a carriage return
3150 * and linefeed. This selection is also called new
3151 * line option.
3152 */
3153 newLineMode = true;
3154 } else {
3155 /*
3156 * Reset causes a received linefeed, form feed, or
3157 * vertical tab to move cursor to next line in
3158 * current column. RETURN transmits a carriage
3159 * return.
3160 */
3161 newLineMode = false;
3162 }
3163 }
3164 break;
3165
3166 case 25:
3167 if ((type == DeviceType.VT220) || (type == DeviceType.XTERM)) {
3168 if (decPrivateModeFlag == true) {
3169 // DECTCEM
3170 if (value == true) {
3171 // Visible cursor
3172 cursorVisible = true;
3173 } else {
3174 // Invisible cursor
3175 cursorVisible = false;
3176 }
3177 }
3178 }
3179 break;
3180
3181 case 42:
3182 if ((type == DeviceType.VT220) || (type == DeviceType.XTERM)) {
3183 if (decPrivateModeFlag == true) {
3184 // DECNRCM
3185 if (value == true) {
3186 // Select national mode NRC
3187 // Not supported
3188 } else {
3189 // Select multi-national mode
3190 // Not supported
3191 }
3192 }
3193 }
3194
3195 break;
3196
3197 case 80:
3198 if (type == DeviceType.XTERM) {
3199 if (decPrivateModeFlag == true) {
3200 if (value == true) {
3201 // Enable sixel scrolling (default).
3202 // Not supported
3203 } else {
3204 // Disable sixel scrolling.
3205 // Not supported
3206 }
3207 }
3208 }
3209
3210 break;
3211
3212 case 1000:
3213 if ((type == DeviceType.XTERM)
3214 && (decPrivateModeFlag == true)
3215 ) {
3216 // Mouse: normal tracking mode
3217 if (value == true) {
3218 mouseProtocol = MouseProtocol.NORMAL;
3219 } else {
3220 mouseProtocol = MouseProtocol.OFF;
3221 }
3222 }
3223 break;
3224
3225 case 1002:
3226 if ((type == DeviceType.XTERM)
3227 && (decPrivateModeFlag == true)
3228 ) {
3229 // Mouse: normal tracking mode
3230 if (value == true) {
3231 mouseProtocol = MouseProtocol.BUTTONEVENT;
3232 } else {
3233 mouseProtocol = MouseProtocol.OFF;
3234 }
3235 }
3236 break;
3237
3238 case 1003:
3239 if ((type == DeviceType.XTERM)
3240 && (decPrivateModeFlag == true)
3241 ) {
3242 // Mouse: Any-event tracking mode
3243 if (value == true) {
3244 mouseProtocol = MouseProtocol.ANYEVENT;
3245 } else {
3246 mouseProtocol = MouseProtocol.OFF;
3247 }
3248 }
3249 break;
3250
3251 case 1005:
3252 if ((type == DeviceType.XTERM)
3253 && (decPrivateModeFlag == true)
3254 ) {
3255 // Mouse: UTF-8 coordinates
3256 if (value == true) {
3257 mouseEncoding = MouseEncoding.UTF8;
3258 } else {
3259 mouseEncoding = MouseEncoding.X10;
3260 }
3261 }
3262 break;
3263
3264 case 1006:
3265 if ((type == DeviceType.XTERM)
3266 && (decPrivateModeFlag == true)
3267 ) {
3268 // Mouse: SGR coordinates
3269 if (value == true) {
3270 mouseEncoding = MouseEncoding.SGR;
3271 } else {
3272 mouseEncoding = MouseEncoding.X10;
3273 }
3274 }
3275 break;
3276
3277 case 1070:
3278 if (type == DeviceType.XTERM) {
3279 if (decPrivateModeFlag == true) {
3280 if (value == true) {
3281 // Use private color registers for each sixel
3282 // graphic (default).
3283 sixelPalette = null;
3284 } else {
3285 // Use shared color registers for each sixel
3286 // graphic.
3287 sixelPalette = new HashMap<Integer, java.awt.Color>();
3288 }
3289 }
3290 }
3291 break;
3292
3293 default:
3294 break;
3295
3296 }
3297 }
3298 }
3299
3300 /**
3301 * DECSC - Save cursor.
3302 */
3303 private void decsc() {
3304 savedState.setTo(currentState);
3305 }
3306
3307 /**
3308 * DECRC - Restore cursor.
3309 */
3310 private void decrc() {
3311 currentState.setTo(savedState);
3312 }
3313
3314 /**
3315 * IND - Index.
3316 */
3317 private void ind() {
3318 // Move the cursor and scroll if necessary. If at the bottom line
3319 // already, a scroll up is supposed to be performed.
3320 if (currentState.cursorY == scrollRegionBottom) {
3321 scrollingRegionScrollUp(scrollRegionTop, scrollRegionBottom, 1);
3322 }
3323 cursorDown(1, true);
3324 }
3325
3326 /**
3327 * RI - Reverse index.
3328 */
3329 private void ri() {
3330 // Move the cursor and scroll if necessary. If at the top line
3331 // already, a scroll down is supposed to be performed.
3332 if (currentState.cursorY == scrollRegionTop) {
3333 scrollingRegionScrollDown(scrollRegionTop, scrollRegionBottom, 1);
3334 }
3335 cursorUp(1, true);
3336 }
3337
3338 /**
3339 * NEL - Next line.
3340 */
3341 private void nel() {
3342 // Move the cursor and scroll if necessary. If at the bottom line
3343 // already, a scroll up is supposed to be performed.
3344 if (currentState.cursorY == scrollRegionBottom) {
3345 scrollingRegionScrollUp(scrollRegionTop, scrollRegionBottom, 1);
3346 }
3347 cursorDown(1, true);
3348
3349 // Reset to the beginning of the next line
3350 currentState.cursorX = 0;
3351 }
3352
3353 /**
3354 * DECKPAM - Keypad application mode.
3355 */
3356 private void deckpam() {
3357 keypadMode = KeypadMode.Application;
3358 }
3359
3360 /**
3361 * DECKPNM - Keypad numeric mode.
3362 */
3363 private void deckpnm() {
3364 keypadMode = KeypadMode.Numeric;
3365 }
3366
3367 /**
3368 * Move up n spaces.
3369 *
3370 * @param n number of spaces to move
3371 * @param honorScrollRegion if true, then do nothing if the cursor is
3372 * outside the scrolling region
3373 */
3374 private void cursorUp(final int n, final boolean honorScrollRegion) {
3375 int top;
3376
3377 /*
3378 * Special case: if a user moves the cursor from the right margin, we
3379 * have to reset the VT100 right margin flag.
3380 */
3381 if (n > 0) {
3382 wrapLineFlag = false;
3383 }
3384
3385 for (int i = 0; i < n; i++) {
3386 if (honorScrollRegion == true) {
3387 // Honor the scrolling region
3388 if ((currentState.cursorY < scrollRegionTop)
3389 || (currentState.cursorY > scrollRegionBottom)
3390 ) {
3391 // Outside region, do nothing
3392 return;
3393 }
3394 // Inside region, go up
3395 top = scrollRegionTop;
3396 } else {
3397 // Non-scrolling case
3398 top = 0;
3399 }
3400
3401 if (currentState.cursorY > top) {
3402 currentState.cursorY--;
3403 }
3404 }
3405 }
3406
3407 /**
3408 * Move down n spaces.
3409 *
3410 * @param n number of spaces to move
3411 * @param honorScrollRegion if true, then do nothing if the cursor is
3412 * outside the scrolling region
3413 */
3414 private void cursorDown(final int n, final boolean honorScrollRegion) {
3415 int bottom;
3416
3417 /*
3418 * Special case: if a user moves the cursor from the right margin, we
3419 * have to reset the VT100 right margin flag.
3420 */
3421 if (n > 0) {
3422 wrapLineFlag = false;
3423 }
3424
3425 for (int i = 0; i < n; i++) {
3426
3427 if (honorScrollRegion == true) {
3428 // Honor the scrolling region
3429 if (currentState.cursorY > scrollRegionBottom) {
3430 // Outside region, do nothing
3431 return;
3432 }
3433 // Inside region, go down
3434 bottom = scrollRegionBottom;
3435 } else {
3436 // Non-scrolling case
3437 bottom = height - 1;
3438 }
3439
3440 if (currentState.cursorY < bottom) {
3441 currentState.cursorY++;
3442 }
3443 }
3444 }
3445
3446 /**
3447 * Move left n spaces.
3448 *
3449 * @param n number of spaces to move
3450 * @param honorScrollRegion if true, then do nothing if the cursor is
3451 * outside the scrolling region
3452 */
3453 private void cursorLeft(final int n, final boolean honorScrollRegion) {
3454 /*
3455 * Special case: if a user moves the cursor from the right margin, we
3456 * have to reset the VT100 right margin flag.
3457 */
3458 if (n > 0) {
3459 wrapLineFlag = false;
3460 }
3461
3462 for (int i = 0; i < n; i++) {
3463 if (honorScrollRegion == true) {
3464 // Honor the scrolling region
3465 if ((currentState.cursorY < scrollRegionTop)
3466 || (currentState.cursorY > scrollRegionBottom)
3467 ) {
3468 // Outside region, do nothing
3469 return;
3470 }
3471 }
3472
3473 if (currentState.cursorX > 0) {
3474 currentState.cursorX--;
3475 }
3476 }
3477 }
3478
3479 /**
3480 * Move right n spaces.
3481 *
3482 * @param n number of spaces to move
3483 * @param honorScrollRegion if true, then do nothing if the cursor is
3484 * outside the scrolling region
3485 */
3486 private void cursorRight(final int n, final boolean honorScrollRegion) {
3487 int rightMargin = this.rightMargin;
3488
3489 /*
3490 * Special case: if a user moves the cursor from the right margin, we
3491 * have to reset the VT100 right margin flag.
3492 */
3493 if (n > 0) {
3494 wrapLineFlag = false;
3495 }
3496
3497 if (display.get(currentState.cursorY).isDoubleWidth()) {
3498 rightMargin = ((rightMargin + 1) / 2) - 1;
3499 }
3500
3501 for (int i = 0; i < n; i++) {
3502 if (honorScrollRegion == true) {
3503 // Honor the scrolling region
3504 if ((currentState.cursorY < scrollRegionTop)
3505 || (currentState.cursorY > scrollRegionBottom)
3506 ) {
3507 // Outside region, do nothing
3508 return;
3509 }
3510 }
3511
3512 if (currentState.cursorX < rightMargin) {
3513 currentState.cursorX++;
3514 }
3515 }
3516 }
3517
3518 /**
3519 * Move cursor to (col, row) where (0, 0) is the top-left corner.
3520 *
3521 * @param row row to move to
3522 * @param col column to move to
3523 */
3524 private void cursorPosition(int row, final int col) {
3525 int rightMargin = this.rightMargin;
3526
3527 assert (col >= 0);
3528 assert (row >= 0);
3529
3530 if (display.get(currentState.cursorY).isDoubleWidth()) {
3531 rightMargin = ((rightMargin + 1) / 2) - 1;
3532 }
3533
3534 // Set column number
3535 currentState.cursorX = col;
3536
3537 // Sanity check, bring column back to margin.
3538 if (currentState.cursorX > rightMargin) {
3539 currentState.cursorX = rightMargin;
3540 }
3541
3542 // Set row number
3543 if (currentState.originMode == true) {
3544 row += scrollRegionTop;
3545 }
3546 if (currentState.cursorY < row) {
3547 cursorDown(row - currentState.cursorY, false);
3548 } else if (currentState.cursorY > row) {
3549 cursorUp(currentState.cursorY - row, false);
3550 }
3551
3552 wrapLineFlag = false;
3553 }
3554
3555 /**
3556 * HTS - Horizontal tabulation set.
3557 */
3558 private void hts() {
3559 for (Integer stop: tabStops) {
3560 if (stop == currentState.cursorX) {
3561 // Already have a tab stop here
3562 return;
3563 }
3564 }
3565
3566 // Append a tab stop to the end of the array and resort them
3567 tabStops.add(currentState.cursorX);
3568 Collections.sort(tabStops);
3569 }
3570
3571 /**
3572 * DECSWL - Single-width line.
3573 */
3574 private void decswl() {
3575 display.get(currentState.cursorY).setDoubleWidth(false);
3576 display.get(currentState.cursorY).setDoubleHeight(0);
3577 }
3578
3579 /**
3580 * DECDWL - Double-width line.
3581 */
3582 private void decdwl() {
3583 display.get(currentState.cursorY).setDoubleWidth(true);
3584 display.get(currentState.cursorY).setDoubleHeight(0);
3585 }
3586
3587 /**
3588 * DECHDL - Double-height + double-width line.
3589 *
3590 * @param topHalf if true, this sets the row to be the top half row of a
3591 * double-height row
3592 */
3593 private void dechdl(final boolean topHalf) {
3594 display.get(currentState.cursorY).setDoubleWidth(true);
3595 if (topHalf == true) {
3596 display.get(currentState.cursorY).setDoubleHeight(1);
3597 } else {
3598 display.get(currentState.cursorY).setDoubleHeight(2);
3599 }
3600 }
3601
3602 /**
3603 * DECALN - Screen alignment display.
3604 */
3605 private void decaln() {
3606 Cell newCell = new Cell('E');
3607 for (DisplayLine line: display) {
3608 for (int i = 0; i < line.length(); i++) {
3609 line.replace(i, newCell);
3610 }
3611 }
3612 }
3613
3614 /**
3615 * DECSCL - Compatibility level.
3616 */
3617 private void decscl() {
3618 int i = getCsiParam(0, 0);
3619 int j = getCsiParam(1, 0);
3620
3621 if (i == 61) {
3622 // Reset fonts
3623 currentState.g0Charset = CharacterSet.US;
3624 currentState.g1Charset = CharacterSet.DRAWING;
3625 s8c1t = false;
3626 } else if (i == 62) {
3627
3628 if ((j == 0) || (j == 2)) {
3629 s8c1t = true;
3630 } else if (j == 1) {
3631 s8c1t = false;
3632 }
3633 }
3634 }
3635
3636 /**
3637 * CUD - Cursor down.
3638 */
3639 private void cud() {
3640 cursorDown(getCsiParam(0, 1, 1, height), true);
3641 }
3642
3643 /**
3644 * CUF - Cursor forward.
3645 */
3646 private void cuf() {
3647 cursorRight(getCsiParam(0, 1, 1, rightMargin + 1), true);
3648 }
3649
3650 /**
3651 * CUB - Cursor backward.
3652 */
3653 private void cub() {
3654 cursorLeft(getCsiParam(0, 1, 1, currentState.cursorX + 1), true);
3655 }
3656
3657 /**
3658 * CUU - Cursor up.
3659 */
3660 private void cuu() {
3661 cursorUp(getCsiParam(0, 1, 1, currentState.cursorY + 1), true);
3662 }
3663
3664 /**
3665 * CUP - Cursor position.
3666 */
3667 private void cup() {
3668 cursorPosition(getCsiParam(0, 1, 1, height) - 1,
3669 getCsiParam(1, 1, 1, rightMargin + 1) - 1);
3670 }
3671
3672 /**
3673 * CNL - Cursor down and to column 1.
3674 */
3675 private void cnl() {
3676 cursorDown(getCsiParam(0, 1, 1, height), true);
3677 // To column 0
3678 cursorLeft(currentState.cursorX, true);
3679 }
3680
3681 /**
3682 * CPL - Cursor up and to column 1.
3683 */
3684 private void cpl() {
3685 cursorUp(getCsiParam(0, 1, 1, currentState.cursorY + 1), true);
3686 // To column 0
3687 cursorLeft(currentState.cursorX, true);
3688 }
3689
3690 /**
3691 * CHA - Cursor to column # in current row.
3692 */
3693 private void cha() {
3694 cursorPosition(currentState.cursorY,
3695 getCsiParam(0, 1, 1, rightMargin + 1) - 1);
3696 }
3697
3698 /**
3699 * VPA - Cursor to row #, same column.
3700 */
3701 private void vpa() {
3702 cursorPosition(getCsiParam(0, 1, 1, height) - 1,
3703 currentState.cursorX);
3704 }
3705
3706 /**
3707 * ED - Erase in display.
3708 */
3709 private void ed() {
3710 boolean honorProtected = false;
3711 boolean decPrivateModeFlag = false;
3712
3713 for (int i = 0; i < collectBuffer.length(); i++) {
3714 if (collectBuffer.charAt(i) == '?') {
3715 decPrivateModeFlag = true;
3716 break;
3717 }
3718 }
3719
3720 if (((type == DeviceType.VT220) || (type == DeviceType.XTERM))
3721 && (decPrivateModeFlag == true)
3722 ) {
3723 honorProtected = true;
3724 }
3725
3726 int i = getCsiParam(0, 0);
3727
3728 if (i == 0) {
3729 // Erase from here to end of screen
3730 if (currentState.cursorY < height - 1) {
3731 eraseScreen(currentState.cursorY + 1, 0, height - 1, width - 1,
3732 honorProtected);
3733 }
3734 eraseLine(currentState.cursorX, width - 1, honorProtected);
3735 } else if (i == 1) {
3736 // Erase from beginning of screen to here
3737 eraseScreen(0, 0, currentState.cursorY - 1, width - 1,
3738 honorProtected);
3739 eraseLine(0, currentState.cursorX, honorProtected);
3740 } else if (i == 2) {
3741 // Erase entire screen
3742 eraseScreen(0, 0, height - 1, width - 1, honorProtected);
3743 }
3744 }
3745
3746 /**
3747 * EL - Erase in line.
3748 */
3749 private void el() {
3750 boolean honorProtected = false;
3751 boolean decPrivateModeFlag = false;
3752
3753 for (int i = 0; i < collectBuffer.length(); i++) {
3754 if (collectBuffer.charAt(i) == '?') {
3755 decPrivateModeFlag = true;
3756 break;
3757 }
3758 }
3759
3760 if (((type == DeviceType.VT220) || (type == DeviceType.XTERM))
3761 && (decPrivateModeFlag == true)
3762 ) {
3763 honorProtected = true;
3764 }
3765
3766 int i = getCsiParam(0, 0);
3767
3768 if (i == 0) {
3769 // Erase from here to end of line
3770 eraseLine(currentState.cursorX, width - 1, honorProtected);
3771 } else if (i == 1) {
3772 // Erase from beginning of line to here
3773 eraseLine(0, currentState.cursorX, honorProtected);
3774 } else if (i == 2) {
3775 // Erase entire line
3776 eraseLine(0, width - 1, honorProtected);
3777 }
3778 }
3779
3780 /**
3781 * ECH - Erase # of characters in current row.
3782 */
3783 private void ech() {
3784 int i = getCsiParam(0, 1, 1, width);
3785
3786 // Erase from here to i characters
3787 eraseLine(currentState.cursorX, currentState.cursorX + i - 1, false);
3788 }
3789
3790 /**
3791 * IL - Insert line.
3792 */
3793 private void il() {
3794 int i = getCsiParam(0, 1);
3795
3796 if ((currentState.cursorY >= scrollRegionTop)
3797 && (currentState.cursorY <= scrollRegionBottom)
3798 ) {
3799
3800 // I can get the same effect with a scroll-down
3801 scrollingRegionScrollDown(currentState.cursorY,
3802 scrollRegionBottom, i);
3803 }
3804 }
3805
3806 /**
3807 * DCH - Delete char.
3808 */
3809 private void dch() {
3810 int n = getCsiParam(0, 1);
3811 DisplayLine line = display.get(currentState.cursorY);
3812 Cell blank = new Cell();
3813 for (int i = 0; i < n; i++) {
3814 line.delete(currentState.cursorX, blank);
3815 }
3816 }
3817
3818 /**
3819 * ICH - Insert blank char at cursor.
3820 */
3821 private void ich() {
3822 int n = getCsiParam(0, 1);
3823 DisplayLine line = display.get(currentState.cursorY);
3824 Cell blank = new Cell();
3825 for (int i = 0; i < n; i++) {
3826 line.insert(currentState.cursorX, blank);
3827 }
3828 }
3829
3830 /**
3831 * DL - Delete line.
3832 */
3833 private void dl() {
3834 int i = getCsiParam(0, 1);
3835
3836 if ((currentState.cursorY >= scrollRegionTop)
3837 && (currentState.cursorY <= scrollRegionBottom)) {
3838
3839 // I can get the same effect with a scroll-down
3840 scrollingRegionScrollUp(currentState.cursorY,
3841 scrollRegionBottom, i);
3842 }
3843 }
3844
3845 /**
3846 * HVP - Horizontal and vertical position.
3847 */
3848 private void hvp() {
3849 cup();
3850 }
3851
3852 /**
3853 * REP - Repeat character.
3854 */
3855 private void rep() {
3856 int n = getCsiParam(0, 1);
3857 for (int i = 0; i < n; i++) {
3858 printCharacter(repCh);
3859 }
3860 }
3861
3862 /**
3863 * SU - Scroll up.
3864 */
3865 private void su() {
3866 scrollingRegionScrollUp(scrollRegionTop, scrollRegionBottom,
3867 getCsiParam(0, 1, 1, height));
3868 }
3869
3870 /**
3871 * SD - Scroll down.
3872 */
3873 private void sd() {
3874 scrollingRegionScrollDown(scrollRegionTop, scrollRegionBottom,
3875 getCsiParam(0, 1, 1, height));
3876 }
3877
3878 /**
3879 * CBT - Go back X tab stops.
3880 */
3881 private void cbt() {
3882 int tabsToMove = getCsiParam(0, 1);
3883 int tabI;
3884
3885 for (int i = 0; i < tabsToMove; i++) {
3886 int j = currentState.cursorX;
3887 for (tabI = 0; tabI < tabStops.size(); tabI++) {
3888 if (tabStops.get(tabI) >= currentState.cursorX) {
3889 break;
3890 }
3891 }
3892 tabI--;
3893 if (tabI <= 0) {
3894 j = 0;
3895 } else {
3896 j = tabStops.get(tabI);
3897 }
3898 cursorPosition(currentState.cursorY, j);
3899 }
3900 }
3901
3902 /**
3903 * CHT - Advance X tab stops.
3904 */
3905 private void cht() {
3906 int n = getCsiParam(0, 1);
3907 for (int i = 0; i < n; i++) {
3908 advanceToNextTabStop();
3909 }
3910 }
3911
3912 /**
3913 * SGR - Select graphics rendition.
3914 */
3915 private void sgr() {
3916
3917 if (csiParams.size() == 0) {
3918 currentState.attr.reset();
3919 return;
3920 }
3921
3922 int sgrColorMode = -1;
3923 boolean idx88Color = false;
3924 boolean rgbColor = false;
3925 int rgbRed = -1;
3926 int rgbGreen = -1;
3927
3928 for (Integer i: csiParams) {
3929
3930 if ((sgrColorMode == 38) || (sgrColorMode == 48)) {
3931
3932 assert (type == DeviceType.XTERM);
3933
3934 if (idx88Color) {
3935 /*
3936 * Indexed color mode, we now have the index number.
3937 */
3938 if (sgrColorMode == 38) {
3939 currentState.attr.setForeColorRGB(get88Color(i));
3940 } else {
3941 assert (sgrColorMode == 48);
3942 currentState.attr.setBackColorRGB(get88Color(i));
3943 }
3944 sgrColorMode = -1;
3945 idx88Color = false;
3946 continue;
3947 }
3948
3949 if (rgbColor) {
3950 /*
3951 * RGB color mode, we are collecting tokens.
3952 */
3953 if (rgbRed == -1) {
3954 rgbRed = i & 0xFF;
3955 } else if (rgbGreen == -1) {
3956 rgbGreen = i & 0xFF;
3957 } else {
3958 int rgb = rgbRed << 16;
3959 rgb |= rgbGreen << 8;
3960 rgb |= i & 0xFF;
3961
3962 // System.err.printf("RGB: %08x\n", rgb);
3963
3964 if (sgrColorMode == 38) {
3965 currentState.attr.setForeColorRGB(rgb);
3966 } else {
3967 assert (sgrColorMode == 48);
3968 currentState.attr.setBackColorRGB(rgb);
3969 }
3970 rgbRed = -1;
3971 rgbGreen = -1;
3972 sgrColorMode = -1;
3973 rgbColor = false;
3974 }
3975 continue;
3976 }
3977
3978 switch (i) {
3979
3980 case 2:
3981 /*
3982 * RGB color mode.
3983 */
3984 rgbColor = true;
3985 break;
3986
3987 case 5:
3988 /*
3989 * Indexed color mode.
3990 */
3991 idx88Color = true;
3992 break;
3993
3994 default:
3995 /*
3996 * This is neither indexed nor RGB color. Bail out.
3997 */
3998 return;
3999 }
4000
4001 } // if ((sgrColorMode == 38) || (sgrColorMode == 48))
4002
4003 switch (i) {
4004
4005 case 0:
4006 // Normal
4007 currentState.attr.reset();
4008 break;
4009
4010 case 1:
4011 // Bold
4012 currentState.attr.setBold(true);
4013 break;
4014
4015 case 4:
4016 // Underline
4017 currentState.attr.setUnderline(true);
4018 break;
4019
4020 case 5:
4021 // Blink
4022 currentState.attr.setBlink(true);
4023 break;
4024
4025 case 7:
4026 // Reverse
4027 currentState.attr.setReverse(true);
4028 break;
4029
4030 default:
4031 break;
4032 }
4033
4034 if (type == DeviceType.XTERM) {
4035
4036 switch (i) {
4037
4038 case 8:
4039 // Invisible
4040 // Not supported
4041 break;
4042
4043 case 90:
4044 // Set black foreground
4045 currentState.attr.setForeColorRGB(get88Color(8));
4046 break;
4047 case 91:
4048 // Set red foreground
4049 currentState.attr.setForeColorRGB(get88Color(9));
4050 break;
4051 case 92:
4052 // Set green foreground
4053 currentState.attr.setForeColorRGB(get88Color(10));
4054 break;
4055 case 93:
4056 // Set yellow foreground
4057 currentState.attr.setForeColorRGB(get88Color(11));
4058 break;
4059 case 94:
4060 // Set blue foreground
4061 currentState.attr.setForeColorRGB(get88Color(12));
4062 break;
4063 case 95:
4064 // Set magenta foreground
4065 currentState.attr.setForeColorRGB(get88Color(13));
4066 break;
4067 case 96:
4068 // Set cyan foreground
4069 currentState.attr.setForeColorRGB(get88Color(14));
4070 break;
4071 case 97:
4072 // Set white foreground
4073 currentState.attr.setForeColorRGB(get88Color(15));
4074 break;
4075
4076 case 100:
4077 // Set black background
4078 currentState.attr.setBackColorRGB(get88Color(8));
4079 break;
4080 case 101:
4081 // Set red background
4082 currentState.attr.setBackColorRGB(get88Color(9));
4083 break;
4084 case 102:
4085 // Set green background
4086 currentState.attr.setBackColorRGB(get88Color(10));
4087 break;
4088 case 103:
4089 // Set yellow background
4090 currentState.attr.setBackColorRGB(get88Color(11));
4091 break;
4092 case 104:
4093 // Set blue background
4094 currentState.attr.setBackColorRGB(get88Color(12));
4095 break;
4096 case 105:
4097 // Set magenta background
4098 currentState.attr.setBackColorRGB(get88Color(13));
4099 break;
4100 case 106:
4101 // Set cyan background
4102 currentState.attr.setBackColorRGB(get88Color(14));
4103 break;
4104 case 107:
4105 // Set white background
4106 currentState.attr.setBackColorRGB(get88Color(15));
4107 break;
4108
4109 default:
4110 break;
4111 }
4112 }
4113
4114 if ((type == DeviceType.VT220)
4115 || (type == DeviceType.XTERM)) {
4116
4117 switch (i) {
4118
4119 case 22:
4120 // Normal intensity
4121 currentState.attr.setBold(false);
4122 break;
4123
4124 case 24:
4125 // No underline
4126 currentState.attr.setUnderline(false);
4127 break;
4128
4129 case 25:
4130 // No blink
4131 currentState.attr.setBlink(false);
4132 break;
4133
4134 case 27:
4135 // Un-reverse
4136 currentState.attr.setReverse(false);
4137 break;
4138
4139 default:
4140 break;
4141 }
4142 }
4143
4144 // A true VT100/102/220 does not support color, however everyone
4145 // is used to their terminal emulator supporting color so we will
4146 // unconditionally support color for all DeviceType's.
4147
4148 switch (i) {
4149
4150 case 30:
4151 // Set black foreground
4152 currentState.attr.setForeColor(Color.BLACK);
4153 currentState.attr.setForeColorRGB(-1);
4154 break;
4155 case 31:
4156 // Set red foreground
4157 currentState.attr.setForeColor(Color.RED);
4158 currentState.attr.setForeColorRGB(-1);
4159 break;
4160 case 32:
4161 // Set green foreground
4162 currentState.attr.setForeColor(Color.GREEN);
4163 currentState.attr.setForeColorRGB(-1);
4164 break;
4165 case 33:
4166 // Set yellow foreground
4167 currentState.attr.setForeColor(Color.YELLOW);
4168 currentState.attr.setForeColorRGB(-1);
4169 break;
4170 case 34:
4171 // Set blue foreground
4172 currentState.attr.setForeColor(Color.BLUE);
4173 currentState.attr.setForeColorRGB(-1);
4174 break;
4175 case 35:
4176 // Set magenta foreground
4177 currentState.attr.setForeColor(Color.MAGENTA);
4178 currentState.attr.setForeColorRGB(-1);
4179 break;
4180 case 36:
4181 // Set cyan foreground
4182 currentState.attr.setForeColor(Color.CYAN);
4183 currentState.attr.setForeColorRGB(-1);
4184 break;
4185 case 37:
4186 // Set white foreground
4187 currentState.attr.setForeColor(Color.WHITE);
4188 currentState.attr.setForeColorRGB(-1);
4189 break;
4190 case 38:
4191 if (type == DeviceType.XTERM) {
4192 /*
4193 * Xterm supports T.416 / ISO-8613-3 codes to select
4194 * either an indexed color or an RGB value. (It also
4195 * permits these ISO-8613-3 SGR sequences to be separated
4196 * by colons rather than semicolons.)
4197 *
4198 * We will support only the following:
4199 *
4200 * 1. Indexed color mode (88- or 256-color modes).
4201 *
4202 * 2. Direct RGB.
4203 *
4204 * These cover most of the use cases in the real world.
4205 *
4206 * HOWEVER, note that this is an awful broken "standard",
4207 * with no way to do it "right". See
4208 * http://invisible-island.net/ncurses/ncurses.faq.html#xterm_16MegaColors
4209 * for a detailed discussion of the current state of RGB
4210 * in various terminals, the point of which is that none
4211 * of them really do the same thing despite all appearing
4212 * to be "xterm".
4213 *
4214 * Also see
4215 * https://bugs.kde.org/show_bug.cgi?id=107487#c3 .
4216 * where it is assumed that supporting just the "indexed
4217 * mode" of these sequences (which could align easily
4218 * with existing SGR colors) is assumed to mean full
4219 * support of 24-bit RGB. So it is all or nothing.
4220 *
4221 * Finally, these sequences break the assumptions of
4222 * standard ECMA-48 style parsers as pointed out at
4223 * https://bugs.kde.org/show_bug.cgi?id=107487#c11 .
4224 * Therefore in order to keep a clean display, we cannot
4225 * parse anything else in this sequence.
4226 */
4227 sgrColorMode = 38;
4228 continue;
4229 } else {
4230 // Underscore on, default foreground color
4231 currentState.attr.setUnderline(true);
4232 currentState.attr.setForeColor(Color.WHITE);
4233 }
4234 break;
4235 case 39:
4236 // Underscore off, default foreground color
4237 currentState.attr.setUnderline(false);
4238 currentState.attr.setForeColor(Color.WHITE);
4239 currentState.attr.setForeColorRGB(-1);
4240 break;
4241 case 40:
4242 // Set black background
4243 currentState.attr.setBackColor(Color.BLACK);
4244 currentState.attr.setBackColorRGB(-1);
4245 break;
4246 case 41:
4247 // Set red background
4248 currentState.attr.setBackColor(Color.RED);
4249 currentState.attr.setBackColorRGB(-1);
4250 break;
4251 case 42:
4252 // Set green background
4253 currentState.attr.setBackColor(Color.GREEN);
4254 currentState.attr.setBackColorRGB(-1);
4255 break;
4256 case 43:
4257 // Set yellow background
4258 currentState.attr.setBackColor(Color.YELLOW);
4259 currentState.attr.setBackColorRGB(-1);
4260 break;
4261 case 44:
4262 // Set blue background
4263 currentState.attr.setBackColor(Color.BLUE);
4264 currentState.attr.setBackColorRGB(-1);
4265 break;
4266 case 45:
4267 // Set magenta background
4268 currentState.attr.setBackColor(Color.MAGENTA);
4269 currentState.attr.setBackColorRGB(-1);
4270 break;
4271 case 46:
4272 // Set cyan background
4273 currentState.attr.setBackColor(Color.CYAN);
4274 currentState.attr.setBackColorRGB(-1);
4275 break;
4276 case 47:
4277 // Set white background
4278 currentState.attr.setBackColor(Color.WHITE);
4279 currentState.attr.setBackColorRGB(-1);
4280 break;
4281 case 48:
4282 if (type == DeviceType.XTERM) {
4283 /*
4284 * Xterm supports T.416 / ISO-8613-3 codes to select
4285 * either an indexed color or an RGB value. (It also
4286 * permits these ISO-8613-3 SGR sequences to be separated
4287 * by colons rather than semicolons.)
4288 *
4289 * We will support only the following:
4290 *
4291 * 1. Indexed color mode (88- or 256-color modes).
4292 *
4293 * 2. Direct RGB.
4294 *
4295 * These cover most of the use cases in the real world.
4296 *
4297 * HOWEVER, note that this is an awful broken "standard",
4298 * with no way to do it "right". See
4299 * http://invisible-island.net/ncurses/ncurses.faq.html#xterm_16MegaColors
4300 * for a detailed discussion of the current state of RGB
4301 * in various terminals, the point of which is that none
4302 * of them really do the same thing despite all appearing
4303 * to be "xterm".
4304 *
4305 * Also see
4306 * https://bugs.kde.org/show_bug.cgi?id=107487#c3 .
4307 * where it is assumed that supporting just the "indexed
4308 * mode" of these sequences (which could align easily
4309 * with existing SGR colors) is assumed to mean full
4310 * support of 24-bit RGB. So it is all or nothing.
4311 *
4312 * Finally, these sequences break the assumptions of
4313 * standard ECMA-48 style parsers as pointed out at
4314 * https://bugs.kde.org/show_bug.cgi?id=107487#c11 .
4315 * Therefore in order to keep a clean display, we cannot
4316 * parse anything else in this sequence.
4317 */
4318 sgrColorMode = 48;
4319 continue;
4320 }
4321 break;
4322 case 49:
4323 // Default background
4324 currentState.attr.setBackColor(Color.BLACK);
4325 currentState.attr.setBackColorRGB(-1);
4326 break;
4327
4328 default:
4329 break;
4330 }
4331 }
4332 }
4333
4334 /**
4335 * DA - Device attributes.
4336 */
4337 private void da() {
4338 int extendedFlag = 0;
4339 int i = 0;
4340 if (collectBuffer.length() > 0) {
4341 String args = collectBuffer.substring(1);
4342 if (collectBuffer.charAt(0) == '>') {
4343 extendedFlag = 1;
4344 if (collectBuffer.length() >= 2) {
4345 i = Integer.parseInt(args);
4346 }
4347 } else if (collectBuffer.charAt(0) == '=') {
4348 extendedFlag = 2;
4349 if (collectBuffer.length() >= 2) {
4350 i = Integer.parseInt(args);
4351 }
4352 } else {
4353 // Unknown code, bail out
4354 return;
4355 }
4356 }
4357
4358 if ((i != 0) && (i != 1)) {
4359 return;
4360 }
4361
4362 if ((extendedFlag == 0) && (i == 0)) {
4363 // Send string directly to remote side
4364 writeRemote(deviceTypeResponse());
4365 return;
4366 }
4367
4368 if ((type == DeviceType.VT220) || (type == DeviceType.XTERM)) {
4369
4370 if ((extendedFlag == 1) && (i == 0)) {
4371 /*
4372 * Request "What type of terminal are you, what is your
4373 * firmware version, and what hardware options do you have
4374 * installed?"
4375 *
4376 * Respond: "I am a VT220 (identification code of 1), my
4377 * firmware version is _____ (Pv), and I have _____ Po
4378 * options installed."
4379 *
4380 * (Same as xterm)
4381 *
4382 */
4383
4384 if (s8c1t == true) {
4385 writeRemote("\u009b>1;10;0c");
4386 } else {
4387 writeRemote("\033[>1;10;0c");
4388 }
4389 }
4390 }
4391
4392 // VT420 and up
4393 if ((extendedFlag == 2) && (i == 0)) {
4394
4395 /*
4396 * Request "What is your unit ID?"
4397 *
4398 * Respond: "I was manufactured at site 00 and have a unique ID
4399 * number of 123."
4400 *
4401 */
4402 writeRemote("\033P!|00010203\033\\");
4403 }
4404 }
4405
4406 /**
4407 * DECSTBM - Set top and bottom margins.
4408 */
4409 private void decstbm() {
4410 boolean decPrivateModeFlag = false;
4411
4412 for (int i = 0; i < collectBuffer.length(); i++) {
4413 if (collectBuffer.charAt(i) == '?') {
4414 decPrivateModeFlag = true;
4415 break;
4416 }
4417 }
4418 if (decPrivateModeFlag) {
4419 // This could be restore DEC private mode values.
4420 // Ignore it.
4421 } else {
4422 // DECSTBM
4423 int top = getCsiParam(0, 1, 1, height) - 1;
4424 int bottom = getCsiParam(1, height, 1, height) - 1;
4425 if (bottom > height - 1) {
4426 bottom = height - 1;
4427 }
4428
4429 if (top > bottom) {
4430 top = bottom;
4431 }
4432 scrollRegionTop = top;
4433 scrollRegionBottom = bottom;
4434
4435 // Home cursor
4436 cursorPosition(0, 0);
4437 }
4438 }
4439
4440 /**
4441 * DECREQTPARM - Request terminal parameters.
4442 */
4443 private void decreqtparm() {
4444 int i = getCsiParam(0, 0);
4445
4446 if ((i != 0) && (i != 1)) {
4447 return;
4448 }
4449
4450 String str = "";
4451
4452 /*
4453 * Request terminal parameters.
4454 *
4455 * Respond with:
4456 *
4457 * Parity NONE, 8 bits, xmitspeed 38400, recvspeed 38400.
4458 * (CLoCk MULtiplier = 1, STP option flags = 0)
4459 *
4460 * (Same as xterm)
4461 */
4462 if (((type == DeviceType.VT220) || (type == DeviceType.XTERM))
4463 && (s8c1t == true)
4464 ) {
4465 str = String.format("\u009b%d;1;1;128;128;1;0x", i + 2);
4466 } else {
4467 str = String.format("\033[%d;1;1;128;128;1;0x", i + 2);
4468 }
4469 writeRemote(str);
4470 }
4471
4472 /**
4473 * DECSCA - Select Character Attributes.
4474 */
4475 private void decsca() {
4476 int i = getCsiParam(0, 0);
4477
4478 if ((i == 0) || (i == 2)) {
4479 // Protect mode OFF
4480 currentState.attr.setProtect(false);
4481 }
4482 if (i == 1) {
4483 // Protect mode ON
4484 currentState.attr.setProtect(true);
4485 }
4486 }
4487
4488 /**
4489 * DECSTR - Soft Terminal Reset.
4490 */
4491 private void decstr() {
4492 // Do exactly like RIS - Reset to initial state
4493 reset();
4494 // Do I clear screen too? I think so...
4495 eraseScreen(0, 0, height - 1, width - 1, false);
4496 cursorPosition(0, 0);
4497 }
4498
4499 /**
4500 * DSR - Device status report.
4501 */
4502 private void dsr() {
4503 boolean decPrivateModeFlag = false;
4504 int row = currentState.cursorY;
4505
4506 for (int i = 0; i < collectBuffer.length(); i++) {
4507 if (collectBuffer.charAt(i) == '?') {
4508 decPrivateModeFlag = true;
4509 break;
4510 }
4511 }
4512
4513 int i = getCsiParam(0, 0);
4514
4515 switch (i) {
4516
4517 case 5:
4518 // Request status report. Respond with "OK, no malfunction."
4519
4520 // Send string directly to remote side
4521 if (((type == DeviceType.VT220) || (type == DeviceType.XTERM))
4522 && (s8c1t == true)
4523 ) {
4524 writeRemote("\u009b0n");
4525 } else {
4526 writeRemote("\033[0n");
4527 }
4528 break;
4529
4530 case 6:
4531 // Request cursor position. Respond with current position.
4532 if (currentState.originMode == true) {
4533 row -= scrollRegionTop;
4534 }
4535 String str = "";
4536 if (((type == DeviceType.VT220) || (type == DeviceType.XTERM))
4537 && (s8c1t == true)
4538 ) {
4539 str = String.format("\u009b%d;%dR", row + 1,
4540 currentState.cursorX + 1);
4541 } else {
4542 str = String.format("\033[%d;%dR", row + 1,
4543 currentState.cursorX + 1);
4544 }
4545
4546 // Send string directly to remote side
4547 writeRemote(str);
4548 break;
4549
4550 case 15:
4551 if (decPrivateModeFlag == true) {
4552
4553 // Request printer status report. Respond with "Printer not
4554 // connected."
4555
4556 if (((type == DeviceType.VT220) || (type == DeviceType.XTERM))
4557 && (s8c1t == true)) {
4558 writeRemote("\u009b?13n");
4559 } else {
4560 writeRemote("\033[?13n");
4561 }
4562 }
4563 break;
4564
4565 case 25:
4566 if (((type == DeviceType.VT220) || (type == DeviceType.XTERM))
4567 && (decPrivateModeFlag == true)
4568 ) {
4569
4570 // Request user-defined keys are locked or unlocked. Respond
4571 // with "User-defined keys are locked."
4572
4573 if (s8c1t == true) {
4574 writeRemote("\u009b?21n");
4575 } else {
4576 writeRemote("\033[?21n");
4577 }
4578 }
4579 break;
4580
4581 case 26:
4582 if (((type == DeviceType.VT220) || (type == DeviceType.XTERM))
4583 && (decPrivateModeFlag == true)
4584 ) {
4585
4586 // Request keyboard language. Respond with "Keyboard
4587 // language is North American."
4588
4589 if (s8c1t == true) {
4590 writeRemote("\u009b?27;1n");
4591 } else {
4592 writeRemote("\033[?27;1n");
4593 }
4594
4595 }
4596 break;
4597
4598 default:
4599 // Some other option, ignore
4600 break;
4601 }
4602 }
4603
4604 /**
4605 * TBC - Tabulation clear.
4606 */
4607 private void tbc() {
4608 int i = getCsiParam(0, 0);
4609 if (i == 0) {
4610 List<Integer> newStops = new ArrayList<Integer>();
4611 for (Integer stop: tabStops) {
4612 if (stop == currentState.cursorX) {
4613 continue;
4614 }
4615 newStops.add(stop);
4616 }
4617 tabStops = newStops;
4618 }
4619 if (i == 3) {
4620 tabStops.clear();
4621 }
4622 }
4623
4624 /**
4625 * Erase the characters in the current line from the start column to the
4626 * end column, inclusive.
4627 *
4628 * @param start starting column to erase (between 0 and width - 1)
4629 * @param end ending column to erase (between 0 and width - 1)
4630 * @param honorProtected if true, do not erase characters with the
4631 * protected attribute set
4632 */
4633 private void eraseLine(int start, int end, final boolean honorProtected) {
4634
4635 if (start > end) {
4636 return;
4637 }
4638 if (end > width - 1) {
4639 end = width - 1;
4640 }
4641 if (start < 0) {
4642 start = 0;
4643 }
4644
4645 for (int i = start; i <= end; i++) {
4646 DisplayLine line = display.get(currentState.cursorY);
4647 if ((!honorProtected)
4648 || ((honorProtected) && (!line.charAt(i).isProtect()))) {
4649
4650 switch (type) {
4651 case VT100:
4652 case VT102:
4653 case VT220:
4654 /*
4655 * From the VT102 manual:
4656 *
4657 * Erasing a character also erases any character
4658 * attribute of the character.
4659 */
4660 line.setBlank(i);
4661 break;
4662 case XTERM:
4663 /*
4664 * Erase with the current color a.k.a. back-color erase
4665 * (bce).
4666 */
4667 line.setChar(i, ' ');
4668 line.setAttr(i, currentState.attr);
4669 break;
4670 }
4671 }
4672 }
4673 }
4674
4675 /**
4676 * Erase a rectangular section of the screen, inclusive. end column,
4677 * inclusive.
4678 *
4679 * @param startRow starting row to erase (between 0 and height - 1)
4680 * @param startCol starting column to erase (between 0 and width - 1)
4681 * @param endRow ending row to erase (between 0 and height - 1)
4682 * @param endCol ending column to erase (between 0 and width - 1)
4683 * @param honorProtected if true, do not erase characters with the
4684 * protected attribute set
4685 */
4686 private void eraseScreen(final int startRow, final int startCol,
4687 final int endRow, final int endCol, final boolean honorProtected) {
4688
4689 int oldCursorY;
4690
4691 if ((startRow < 0)
4692 || (startCol < 0)
4693 || (endRow < 0)
4694 || (endCol < 0)
4695 || (endRow < startRow)
4696 || (endCol < startCol)
4697 ) {
4698 return;
4699 }
4700
4701 oldCursorY = currentState.cursorY;
4702 for (int i = startRow; i <= endRow; i++) {
4703 currentState.cursorY = i;
4704 eraseLine(startCol, endCol, honorProtected);
4705
4706 // Erase display clears the double attributes
4707 display.get(i).setDoubleWidth(false);
4708 display.get(i).setDoubleHeight(0);
4709 }
4710 currentState.cursorY = oldCursorY;
4711 }
4712
4713 /**
4714 * VT220 printer functions. All of these are parsed, but won't do
4715 * anything.
4716 */
4717 private void printerFunctions() {
4718 boolean decPrivateModeFlag = false;
4719 for (int i = 0; i < collectBuffer.length(); i++) {
4720 if (collectBuffer.charAt(i) == '?') {
4721 decPrivateModeFlag = true;
4722 break;
4723 }
4724 }
4725
4726 int i = getCsiParam(0, 0);
4727
4728 switch (i) {
4729
4730 case 0:
4731 if (decPrivateModeFlag == false) {
4732 // Print screen
4733 }
4734 break;
4735
4736 case 1:
4737 if (decPrivateModeFlag == true) {
4738 // Print cursor line
4739 }
4740 break;
4741
4742 case 4:
4743 if (decPrivateModeFlag == true) {
4744 // Auto print mode OFF
4745 } else {
4746 // Printer controller OFF
4747
4748 // Characters re-appear on the screen
4749 printerControllerMode = false;
4750 }
4751 break;
4752
4753 case 5:
4754 if (decPrivateModeFlag == true) {
4755 // Auto print mode
4756
4757 } else {
4758 // Printer controller
4759
4760 // Characters get sucked into oblivion
4761 printerControllerMode = true;
4762 }
4763 break;
4764
4765 default:
4766 break;
4767
4768 }
4769 }
4770
4771 /**
4772 * Handle the SCAN_OSC_STRING state. Handle this in VT100 because lots
4773 * of remote systems will send an XTerm title sequence even if TERM isn't
4774 * xterm.
4775 *
4776 * @param xtermChar the character received from the remote side
4777 */
4778 private void oscPut(final char xtermChar) {
4779 // System.err.println("oscPut: " + xtermChar);
4780
4781 boolean oscEnd = false;
4782
4783 if (xtermChar == 0x07) {
4784 oscEnd = true;
4785 }
4786 if ((xtermChar == '\\')
4787 && (collectBuffer.charAt(collectBuffer.length() - 1) == '\033')
4788 ) {
4789 oscEnd = true;
4790 }
4791
4792 // Collect first
4793 collectBuffer.append(xtermChar);
4794
4795 // Xterm cases...
4796 if (oscEnd) {
4797 String args = null;
4798 if (xtermChar == 0x07) {
4799 args = collectBuffer.substring(0, collectBuffer.length() - 1);
4800 } else {
4801 args = collectBuffer.substring(0, collectBuffer.length() - 2);
4802 }
4803
4804 String [] p = args.split(";");
4805 if (p.length > 0) {
4806 if ((p[0].equals("0")) || (p[0].equals("2"))) {
4807 if (p.length > 1) {
4808 // Screen title
4809 screenTitle = p[1];
4810 }
4811 }
4812
4813 if (p[0].equals("4")) {
4814 for (int i = 1; i + 1 < p.length; i += 2) {
4815 // Set a color index value
4816 try {
4817 set88Color(Integer.parseInt(p[i]), p[i + 1]);
4818 } catch (NumberFormatException e) {
4819 // SQUASH
4820 }
4821 }
4822 }
4823
4824 if (p[0].equals("10")) {
4825 if (p[1].equals("?")) {
4826 // Respond with foreground color.
4827 java.awt.Color color = jexer.backend.SwingTerminal.attrToForegroundColor(currentState.attr);
4828
4829 writeRemote(String.format(
4830 "\033]10;rgb:%04x/%04x/%04x\033\\",
4831 color.getRed() << 8,
4832 color.getGreen() << 8,
4833 color.getBlue() << 8));
4834 }
4835 }
4836
4837 if (p[0].equals("11")) {
4838 if (p[1].equals("?")) {
4839 // Respond with background color.
4840 java.awt.Color color = jexer.backend.SwingTerminal.attrToBackgroundColor(currentState.attr);
4841
4842 writeRemote(String.format(
4843 "\033]11;rgb:%04x/%04x/%04x\033\\",
4844 color.getRed() << 8,
4845 color.getGreen() << 8,
4846 color.getBlue() << 8));
4847 }
4848 }
4849
4850 if (p[0].equals("444")) {
4851 if (p[1].equals("0") && (p.length == 6)) {
4852 // Jexer image - RGB
4853 parseJexerImageRGB(p[2], p[3], p[4], p[5]);
4854 } else if (p[1].equals("1") && (p.length == 4)) {
4855 // Jexer image - PNG
4856 parseJexerImageFile(1, p[2], p[3]);
4857 } else if (p[1].equals("2") && (p.length == 4)) {
4858 // Jexer image - JPG
4859 parseJexerImageFile(2, p[2], p[3]);
4860 }
4861 }
4862 }
4863
4864 // Go to SCAN_GROUND state
4865 toGround();
4866 return;
4867 }
4868 }
4869
4870 /**
4871 * Handle the SCAN_SOSPMAPC_STRING state. This is currently only used by
4872 * Jexer ECMA48Terminal to talk to ECMA48.
4873 *
4874 * @param pmChar the character received from the remote side
4875 */
4876 private void pmPut(final char pmChar) {
4877 // System.err.println("pmPut: " + pmChar);
4878
4879 boolean pmEnd = false;
4880
4881 if ((pmChar == '\\')
4882 && (collectBuffer.charAt(collectBuffer.length() - 1) == '\033')
4883 ) {
4884 pmEnd = true;
4885 }
4886
4887 // Collect first
4888 collectBuffer.append(pmChar);
4889
4890 // Xterm cases...
4891 if (pmEnd) {
4892 String arg = null;
4893 arg = collectBuffer.substring(0, collectBuffer.length() - 2);
4894
4895 // System.err.println("arg: '" + arg + "'");
4896
4897 if (arg.equals("hideMousePointer")) {
4898 hideMousePointer = true;
4899 }
4900 if (arg.equals("showMousePointer")) {
4901 hideMousePointer = false;
4902 }
4903
4904 // Go to SCAN_GROUND state
4905 toGround();
4906 return;
4907 }
4908 }
4909
4910 /**
4911 * Perform xterm window operations.
4912 */
4913 private void xtermWindowOps() {
4914 boolean xtermPrivateModeFlag = false;
4915
4916 for (int i = 0; i < collectBuffer.length(); i++) {
4917 if (collectBuffer.charAt(i) == '?') {
4918 xtermPrivateModeFlag = true;
4919 break;
4920 }
4921 }
4922
4923 int i = getCsiParam(0, 0);
4924
4925 if (!xtermPrivateModeFlag) {
4926 switch (i) {
4927 case 14:
4928 // Report xterm text area size in pixels as CSI 4 ; height ;
4929 // width t
4930 writeRemote(String.format("\033[4;%d;%dt", textHeight * height,
4931 textWidth * width));
4932 break;
4933 case 16:
4934 // Report character size in pixels as CSI 6 ; height ; width
4935 // t
4936 writeRemote(String.format("\033[6;%d;%dt", textHeight,
4937 textWidth));
4938 break;
4939 case 18:
4940 // Report the text are size in characters as CSI 8 ; height ;
4941 // width t
4942 writeRemote(String.format("\033[8;%d;%dt", height, width));
4943 break;
4944 default:
4945 break;
4946 }
4947 }
4948 }
4949
4950 /**
4951 * Respond to xterm sixel query.
4952 */
4953 private void xtermSixelQuery() {
4954 int item = getCsiParam(0, 0);
4955 int action = getCsiParam(1, 0);
4956 int value = getCsiParam(2, 0);
4957
4958 switch (item) {
4959 case 1:
4960 if (action == 1) {
4961 // Report number of color registers.
4962 writeRemote(String.format("\033[?%d;%d;%dS", item, 0, 1024));
4963 return;
4964 }
4965 break;
4966 default:
4967 break;
4968 }
4969 // We will not support this option.
4970 writeRemote(String.format("\033[?%d;%dS", item, action));
4971 }
4972
4973 /**
4974 * Run this input character through the ECMA48 state machine.
4975 *
4976 * @param ch character from the remote side
4977 */
4978 private void consume(final int ch) {
4979
4980 // DEBUG
4981 // System.err.printf("%c STATE = %s\n", ch, scanState);
4982
4983 // Special "anywhere" states
4984
4985 // 18, 1A --> execute, then switch to SCAN_GROUND
4986 if ((ch == 0x18) || (ch == 0x1A)) {
4987 // CAN and SUB abort escape sequences
4988 toGround();
4989 return;
4990 }
4991
4992 // 80-8F, 91-97, 99, 9A, 9C --> execute, then switch to SCAN_GROUND
4993
4994 // 0x1B == ESCAPE
4995 if (ch == 0x1B) {
4996 if ((type == DeviceType.XTERM)
4997 && ((scanState == ScanState.OSC_STRING)
4998 || (scanState == ScanState.DCS_SIXEL)
4999 || (scanState == ScanState.SOSPMAPC_STRING))
5000 ) {
5001 // Xterm can pass ESCAPE to its OSC sequence.
5002 // Xterm can pass ESCAPE to its DCS sequence.
5003 // Jexer can pass ESCAPE to its PM sequence.
5004 } else if ((scanState != ScanState.DCS_ENTRY)
5005 && (scanState != ScanState.DCS_INTERMEDIATE)
5006 && (scanState != ScanState.DCS_IGNORE)
5007 && (scanState != ScanState.DCS_PARAM)
5008 && (scanState != ScanState.DCS_PASSTHROUGH)
5009 ) {
5010 scanState = ScanState.ESCAPE;
5011 return;
5012 }
5013 }
5014
5015 // 0x9B == CSI 8-bit sequence
5016 if (ch == 0x9B) {
5017 scanState = ScanState.CSI_ENTRY;
5018 return;
5019 }
5020
5021 // 0x9D goes to ScanState.OSC_STRING
5022 if (ch == 0x9D) {
5023 scanState = ScanState.OSC_STRING;
5024 return;
5025 }
5026
5027 // 0x90 goes to DCS_ENTRY
5028 if (ch == 0x90) {
5029 scanState = ScanState.DCS_ENTRY;
5030 return;
5031 }
5032
5033 // 0x98, 0x9E, and 0x9F go to SOSPMAPC_STRING
5034 if ((ch == 0x98) || (ch == 0x9E) || (ch == 0x9F)) {
5035 scanState = ScanState.SOSPMAPC_STRING;
5036 return;
5037 }
5038
5039 // 0x7F (DEL) is always discarded
5040 if (ch == 0x7F) {
5041 return;
5042 }
5043
5044 switch (scanState) {
5045
5046 case GROUND:
5047 // 00-17, 19, 1C-1F --> execute
5048 // 80-8F, 91-9A, 9C --> execute
5049 if ((ch <= 0x1F) || ((ch >= 0x80) && (ch <= 0x9F))) {
5050 handleControlChar((char) ch);
5051 }
5052
5053 // 20-7F --> print
5054 if (((ch >= 0x20) && (ch <= 0x7F))
5055 || (ch >= 0xA0)
5056 ) {
5057
5058 // VT220 printer --> trash bin
5059 if (((type == DeviceType.VT220)
5060 || (type == DeviceType.XTERM))
5061 && (printerControllerMode == true)
5062 ) {
5063 return;
5064 }
5065
5066 // Hang onto this character
5067 repCh = mapCharacter(ch);
5068
5069 // Print this character
5070 printCharacter(repCh);
5071 }
5072 return;
5073
5074 case ESCAPE:
5075 // 00-17, 19, 1C-1F --> execute
5076 if (ch <= 0x1F) {
5077 handleControlChar((char) ch);
5078 return;
5079 }
5080
5081 // 20-2F --> collect, then switch to ESCAPE_INTERMEDIATE
5082 if ((ch >= 0x20) && (ch <= 0x2F)) {
5083 collect((char) ch);
5084 scanState = ScanState.ESCAPE_INTERMEDIATE;
5085 return;
5086 }
5087
5088 // 30-4F, 51-57, 59, 5A, 5C, 60-7E --> dispatch, then switch to GROUND
5089 if ((ch >= 0x30) && (ch <= 0x4F)) {
5090 switch (ch) {
5091 case '0':
5092 case '1':
5093 case '2':
5094 case '3':
5095 case '4':
5096 case '5':
5097 case '6':
5098 break;
5099 case '7':
5100 // DECSC - Save cursor
5101 // Note this code overlaps both ANSI and VT52 mode
5102 decsc();
5103 break;
5104
5105 case '8':
5106 // DECRC - Restore cursor
5107 // Note this code overlaps both ANSI and VT52 mode
5108 decrc();
5109 break;
5110
5111 case '9':
5112 case ':':
5113 case ';':
5114 break;
5115 case '<':
5116 if (vt52Mode == true) {
5117 // DECANM - Enter ANSI mode
5118 vt52Mode = false;
5119 arrowKeyMode = ArrowKeyMode.VT100;
5120
5121 /*
5122 * From the VT102 docs: "You use ANSI mode to select
5123 * most terminal features; the terminal uses the same
5124 * features when it switches to VT52 mode. You
5125 * cannot, however, change most of these features in
5126 * VT52 mode."
5127 *
5128 * In other words, do not reset any other attributes
5129 * when switching between VT52 submode and ANSI.
5130 */
5131
5132 // Reset fonts
5133 currentState.g0Charset = CharacterSet.US;
5134 currentState.g1Charset = CharacterSet.DRAWING;
5135 s8c1t = false;
5136 singleshift = Singleshift.NONE;
5137 currentState.glLockshift = LockshiftMode.NONE;
5138 currentState.grLockshift = LockshiftMode.NONE;
5139 }
5140 break;
5141 case '=':
5142 // DECKPAM - Keypad application mode
5143 // Note this code overlaps both ANSI and VT52 mode
5144 deckpam();
5145 break;
5146 case '>':
5147 // DECKPNM - Keypad numeric mode
5148 // Note this code overlaps both ANSI and VT52 mode
5149 deckpnm();
5150 break;
5151 case '?':
5152 case '@':
5153 break;
5154 case 'A':
5155 if (vt52Mode == true) {
5156 // Cursor up, and stop at the top without scrolling
5157 cursorUp(1, false);
5158 }
5159 break;
5160 case 'B':
5161 if (vt52Mode == true) {
5162 // Cursor down, and stop at the bottom without scrolling
5163 cursorDown(1, false);
5164 }
5165 break;
5166 case 'C':
5167 if (vt52Mode == true) {
5168 // Cursor right, and stop at the right without scrolling
5169 cursorRight(1, false);
5170 }
5171 break;
5172 case 'D':
5173 if (vt52Mode == true) {
5174 // Cursor left, and stop at the left without scrolling
5175 cursorLeft(1, false);
5176 } else {
5177 // IND - Index
5178 ind();
5179 }
5180 break;
5181 case 'E':
5182 if (vt52Mode == true) {
5183 // Nothing
5184 } else {
5185 // NEL - Next line
5186 nel();
5187 }
5188 break;
5189 case 'F':
5190 if (vt52Mode == true) {
5191 // G0 --> Special graphics
5192 currentState.g0Charset = CharacterSet.VT52_GRAPHICS;
5193 }
5194 break;
5195 case 'G':
5196 if (vt52Mode == true) {
5197 // G0 --> ASCII set
5198 currentState.g0Charset = CharacterSet.US;
5199 }
5200 break;
5201 case 'H':
5202 if (vt52Mode == true) {
5203 // Cursor to home
5204 cursorPosition(0, 0);
5205 } else {
5206 // HTS - Horizontal tabulation set
5207 hts();
5208 }
5209 break;
5210 case 'I':
5211 if (vt52Mode == true) {
5212 // Reverse line feed. Same as RI.
5213 ri();
5214 }
5215 break;
5216 case 'J':
5217 if (vt52Mode == true) {
5218 // Erase to end of screen
5219 eraseLine(currentState.cursorX, width - 1, false);
5220 eraseScreen(currentState.cursorY + 1, 0, height - 1,
5221 width - 1, false);
5222 }
5223 break;
5224 case 'K':
5225 if (vt52Mode == true) {
5226 // Erase to end of line
5227 eraseLine(currentState.cursorX, width - 1, false);
5228 }
5229 break;
5230 case 'L':
5231 break;
5232 case 'M':
5233 if (vt52Mode == true) {
5234 // Nothing
5235 } else {
5236 // RI - Reverse index
5237 ri();
5238 }
5239 break;
5240 case 'N':
5241 if (vt52Mode == false) {
5242 // SS2
5243 singleshift = Singleshift.SS2;
5244 }
5245 break;
5246 case 'O':
5247 if (vt52Mode == false) {
5248 // SS3
5249 singleshift = Singleshift.SS3;
5250 }
5251 break;
5252 }
5253 toGround();
5254 return;
5255 }
5256 if ((ch >= 0x51) && (ch <= 0x57)) {
5257 switch (ch) {
5258 case 'Q':
5259 case 'R':
5260 case 'S':
5261 case 'T':
5262 case 'U':
5263 case 'V':
5264 case 'W':
5265 break;
5266 }
5267 toGround();
5268 return;
5269 }
5270 if (ch == 0x59) {
5271 // 'Y'
5272 if (vt52Mode == true) {
5273 scanState = ScanState.VT52_DIRECT_CURSOR_ADDRESS;
5274 } else {
5275 toGround();
5276 }
5277 return;
5278 }
5279 if (ch == 0x5A) {
5280 // 'Z'
5281 if (vt52Mode == true) {
5282 // Identify
5283 // Send string directly to remote side
5284 writeRemote("\033/Z");
5285 } else {
5286 // DECID
5287 // Send string directly to remote side
5288 writeRemote(deviceTypeResponse());
5289 }
5290 toGround();
5291 return;
5292 }
5293 if (ch == 0x5C) {
5294 // '\'
5295 toGround();
5296 return;
5297 }
5298
5299 // VT52 cannot get to any of these other states
5300 if (vt52Mode == true) {
5301 toGround();
5302 return;
5303 }
5304
5305 if ((ch >= 0x60) && (ch <= 0x7E)) {
5306 switch (ch) {
5307 case '`':
5308 case 'a':
5309 case 'b':
5310 break;
5311 case 'c':
5312 // RIS - Reset to initial state
5313 reset();
5314 // Do I clear screen too? I think so...
5315 eraseScreen(0, 0, height - 1, width - 1, false);
5316 cursorPosition(0, 0);
5317 break;
5318 case 'd':
5319 case 'e':
5320 case 'f':
5321 case 'g':
5322 case 'h':
5323 case 'i':
5324 case 'j':
5325 case 'k':
5326 case 'l':
5327 case 'm':
5328 break;
5329 case 'n':
5330 if ((type == DeviceType.VT220)
5331 || (type == DeviceType.XTERM)) {
5332
5333 // VT220 lockshift G2 into GL
5334 currentState.glLockshift = LockshiftMode.G2_GL;
5335 shiftOut = false;
5336 }
5337 break;
5338 case 'o':
5339 if ((type == DeviceType.VT220)
5340 || (type == DeviceType.XTERM)) {
5341
5342 // VT220 lockshift G3 into GL
5343 currentState.glLockshift = LockshiftMode.G3_GL;
5344 shiftOut = false;
5345 }
5346 break;
5347 case 'p':
5348 case 'q':
5349 case 'r':
5350 case 's':
5351 case 't':
5352 case 'u':
5353 case 'v':
5354 case 'w':
5355 case 'x':
5356 case 'y':
5357 case 'z':
5358 case '{':
5359 break;
5360 case '|':
5361 if ((type == DeviceType.VT220)
5362 || (type == DeviceType.XTERM)) {
5363
5364 // VT220 lockshift G3 into GR
5365 currentState.grLockshift = LockshiftMode.G3_GR;
5366 shiftOut = false;
5367 }
5368 break;
5369 case '}':
5370 if ((type == DeviceType.VT220)
5371 || (type == DeviceType.XTERM)) {
5372
5373 // VT220 lockshift G2 into GR
5374 currentState.grLockshift = LockshiftMode.G2_GR;
5375 shiftOut = false;
5376 }
5377 break;
5378
5379 case '~':
5380 if ((type == DeviceType.VT220)
5381 || (type == DeviceType.XTERM)) {
5382
5383 // VT220 lockshift G1 into GR
5384 currentState.grLockshift = LockshiftMode.G1_GR;
5385 shiftOut = false;
5386 }
5387 break;
5388 }
5389 toGround();
5390 }
5391
5392 // 7F --> ignore
5393
5394 // 0x5B goes to CSI_ENTRY
5395 if (ch == 0x5B) {
5396 scanState = ScanState.CSI_ENTRY;
5397 }
5398
5399 // 0x5D goes to OSC_STRING
5400 if (ch == 0x5D) {
5401 scanState = ScanState.OSC_STRING;
5402 }
5403
5404 // 0x50 goes to DCS_ENTRY
5405 if (ch == 0x50) {
5406 scanState = ScanState.DCS_ENTRY;
5407 }
5408
5409 // 0x58, 0x5E, and 0x5F go to SOSPMAPC_STRING
5410 if ((ch == 0x58) || (ch == 0x5E) || (ch == 0x5F)) {
5411 scanState = ScanState.SOSPMAPC_STRING;
5412 }
5413
5414 return;
5415
5416 case ESCAPE_INTERMEDIATE:
5417 // 00-17, 19, 1C-1F --> execute
5418 if (ch <= 0x1F) {
5419 handleControlChar((char) ch);
5420 }
5421
5422 // 20-2F --> collect
5423 if ((ch >= 0x20) && (ch <= 0x2F)) {
5424 collect((char) ch);
5425 }
5426
5427 // 30-7E --> dispatch, then switch to GROUND
5428 if ((ch >= 0x30) && (ch <= 0x7E)) {
5429 switch (ch) {
5430 case '0':
5431 if ((collectBuffer.length() == 1)
5432 && (collectBuffer.charAt(0) == '(')) {
5433 // G0 --> Special graphics
5434 currentState.g0Charset = CharacterSet.DRAWING;
5435 }
5436 if ((collectBuffer.length() == 1)
5437 && (collectBuffer.charAt(0) == ')')) {
5438 // G1 --> Special graphics
5439 currentState.g1Charset = CharacterSet.DRAWING;
5440 }
5441 if ((type == DeviceType.VT220)
5442 || (type == DeviceType.XTERM)) {
5443
5444 if ((collectBuffer.length() == 1)
5445 && (collectBuffer.charAt(0) == '*')) {
5446 // G2 --> Special graphics
5447 currentState.g2Charset = CharacterSet.DRAWING;
5448 }
5449 if ((collectBuffer.length() == 1)
5450 && (collectBuffer.charAt(0) == '+')) {
5451 // G3 --> Special graphics
5452 currentState.g3Charset = CharacterSet.DRAWING;
5453 }
5454 }
5455 break;
5456 case '1':
5457 if ((collectBuffer.length() == 1)
5458 && (collectBuffer.charAt(0) == '(')) {
5459 // G0 --> Alternate character ROM standard character set
5460 currentState.g0Charset = CharacterSet.ROM;
5461 }
5462 if ((collectBuffer.length() == 1)
5463 && (collectBuffer.charAt(0) == ')')) {
5464 // G1 --> Alternate character ROM standard character set
5465 currentState.g1Charset = CharacterSet.ROM;
5466 }
5467 break;
5468 case '2':
5469 if ((collectBuffer.length() == 1)
5470 && (collectBuffer.charAt(0) == '(')) {
5471 // G0 --> Alternate character ROM special graphics
5472 currentState.g0Charset = CharacterSet.ROM_SPECIAL;
5473 }
5474 if ((collectBuffer.length() == 1)
5475 && (collectBuffer.charAt(0) == ')')) {
5476 // G1 --> Alternate character ROM special graphics
5477 currentState.g1Charset = CharacterSet.ROM_SPECIAL;
5478 }
5479 break;
5480 case '3':
5481 if ((collectBuffer.length() == 1)
5482 && (collectBuffer.charAt(0) == '#')) {
5483 // DECDHL - Double-height line (top half)
5484 dechdl(true);
5485 }
5486 break;
5487 case '4':
5488 if ((collectBuffer.length() == 1)
5489 && (collectBuffer.charAt(0) == '#')) {
5490 // DECDHL - Double-height line (bottom half)
5491 dechdl(false);
5492 }
5493 if ((type == DeviceType.VT220)
5494 || (type == DeviceType.XTERM)) {
5495
5496 if ((collectBuffer.length() == 1)
5497 && (collectBuffer.charAt(0) == '(')) {
5498 // G0 --> DUTCH
5499 currentState.g0Charset = CharacterSet.NRC_DUTCH;
5500 }
5501 if ((collectBuffer.length() == 1)
5502 && (collectBuffer.charAt(0) == ')')) {
5503 // G1 --> DUTCH
5504 currentState.g1Charset = CharacterSet.NRC_DUTCH;
5505 }
5506 if ((collectBuffer.length() == 1)
5507 && (collectBuffer.charAt(0) == '*')) {
5508 // G2 --> DUTCH
5509 currentState.g2Charset = CharacterSet.NRC_DUTCH;
5510 }
5511 if ((collectBuffer.length() == 1)
5512 && (collectBuffer.charAt(0) == '+')) {
5513 // G3 --> DUTCH
5514 currentState.g3Charset = CharacterSet.NRC_DUTCH;
5515 }
5516 }
5517 break;
5518 case '5':
5519 if ((collectBuffer.length() == 1)
5520 && (collectBuffer.charAt(0) == '#')) {
5521 // DECSWL - Single-width line
5522 decswl();
5523 }
5524 if ((type == DeviceType.VT220)
5525 || (type == DeviceType.XTERM)) {
5526
5527 if ((collectBuffer.length() == 1)
5528 && (collectBuffer.charAt(0) == '(')) {
5529 // G0 --> FINNISH
5530 currentState.g0Charset = CharacterSet.NRC_FINNISH;
5531 }
5532 if ((collectBuffer.length() == 1)
5533 && (collectBuffer.charAt(0) == ')')) {
5534 // G1 --> FINNISH
5535 currentState.g1Charset = CharacterSet.NRC_FINNISH;
5536 }
5537 if ((collectBuffer.length() == 1)
5538 && (collectBuffer.charAt(0) == '*')) {
5539 // G2 --> FINNISH
5540 currentState.g2Charset = CharacterSet.NRC_FINNISH;
5541 }
5542 if ((collectBuffer.length() == 1)
5543 && (collectBuffer.charAt(0) == '+')) {
5544 // G3 --> FINNISH
5545 currentState.g3Charset = CharacterSet.NRC_FINNISH;
5546 }
5547 }
5548 break;
5549 case '6':
5550 if ((collectBuffer.length() == 1)
5551 && (collectBuffer.charAt(0) == '#')) {
5552 // DECDWL - Double-width line
5553 decdwl();
5554 }
5555 if ((type == DeviceType.VT220)
5556 || (type == DeviceType.XTERM)) {
5557
5558 if ((collectBuffer.length() == 1)
5559 && (collectBuffer.charAt(0) == '(')) {
5560 // G0 --> NORWEGIAN
5561 currentState.g0Charset = CharacterSet.NRC_NORWEGIAN;
5562 }
5563 if ((collectBuffer.length() == 1)
5564 && (collectBuffer.charAt(0) == ')')) {
5565 // G1 --> NORWEGIAN
5566 currentState.g1Charset = CharacterSet.NRC_NORWEGIAN;
5567 }
5568 if ((collectBuffer.length() == 1)
5569 && (collectBuffer.charAt(0) == '*')) {
5570 // G2 --> NORWEGIAN
5571 currentState.g2Charset = CharacterSet.NRC_NORWEGIAN;
5572 }
5573 if ((collectBuffer.length() == 1)
5574 && (collectBuffer.charAt(0) == '+')) {
5575 // G3 --> NORWEGIAN
5576 currentState.g3Charset = CharacterSet.NRC_NORWEGIAN;
5577 }
5578 }
5579 break;
5580 case '7':
5581 if ((type == DeviceType.VT220)
5582 || (type == DeviceType.XTERM)) {
5583
5584 if ((collectBuffer.length() == 1)
5585 && (collectBuffer.charAt(0) == '(')) {
5586 // G0 --> SWEDISH
5587 currentState.g0Charset = CharacterSet.NRC_SWEDISH;
5588 }
5589 if ((collectBuffer.length() == 1)
5590 && (collectBuffer.charAt(0) == ')')) {
5591 // G1 --> SWEDISH
5592 currentState.g1Charset = CharacterSet.NRC_SWEDISH;
5593 }
5594 if ((collectBuffer.length() == 1)
5595 && (collectBuffer.charAt(0) == '*')) {
5596 // G2 --> SWEDISH
5597 currentState.g2Charset = CharacterSet.NRC_SWEDISH;
5598 }
5599 if ((collectBuffer.length() == 1)
5600 && (collectBuffer.charAt(0) == '+')) {
5601 // G3 --> SWEDISH
5602 currentState.g3Charset = CharacterSet.NRC_SWEDISH;
5603 }
5604 }
5605 break;
5606 case '8':
5607 if ((collectBuffer.length() == 1)
5608 && (collectBuffer.charAt(0) == '#')) {
5609 // DECALN - Screen alignment display
5610 decaln();
5611 }
5612 break;
5613 case '9':
5614 case ':':
5615 case ';':
5616 break;
5617 case '<':
5618 if ((type == DeviceType.VT220)
5619 || (type == DeviceType.XTERM)) {
5620
5621 if ((collectBuffer.length() == 1)
5622 && (collectBuffer.charAt(0) == '(')) {
5623 // G0 --> DEC_SUPPLEMENTAL
5624 currentState.g0Charset = CharacterSet.DEC_SUPPLEMENTAL;
5625 }
5626 if ((collectBuffer.length() == 1)
5627 && (collectBuffer.charAt(0) == ')')) {
5628 // G1 --> DEC_SUPPLEMENTAL
5629 currentState.g1Charset = CharacterSet.DEC_SUPPLEMENTAL;
5630 }
5631 if ((collectBuffer.length() == 1)
5632 && (collectBuffer.charAt(0) == '*')) {
5633 // G2 --> DEC_SUPPLEMENTAL
5634 currentState.g2Charset = CharacterSet.DEC_SUPPLEMENTAL;
5635 }
5636 if ((collectBuffer.length() == 1)
5637 && (collectBuffer.charAt(0) == '+')) {
5638 // G3 --> DEC_SUPPLEMENTAL
5639 currentState.g3Charset = CharacterSet.DEC_SUPPLEMENTAL;
5640 }
5641 }
5642 break;
5643 case '=':
5644 if ((type == DeviceType.VT220)
5645 || (type == DeviceType.XTERM)) {
5646
5647 if ((collectBuffer.length() == 1)
5648 && (collectBuffer.charAt(0) == '(')) {
5649 // G0 --> SWISS
5650 currentState.g0Charset = CharacterSet.NRC_SWISS;
5651 }
5652 if ((collectBuffer.length() == 1)
5653 && (collectBuffer.charAt(0) == ')')) {
5654 // G1 --> SWISS
5655 currentState.g1Charset = CharacterSet.NRC_SWISS;
5656 }
5657 if ((collectBuffer.length() == 1)
5658 && (collectBuffer.charAt(0) == '*')) {
5659 // G2 --> SWISS
5660 currentState.g2Charset = CharacterSet.NRC_SWISS;
5661 }
5662 if ((collectBuffer.length() == 1)
5663 && (collectBuffer.charAt(0) == '+')) {
5664 // G3 --> SWISS
5665 currentState.g3Charset = CharacterSet.NRC_SWISS;
5666 }
5667 }
5668 break;
5669 case '>':
5670 case '?':
5671 case '@':
5672 break;
5673 case 'A':
5674 if ((collectBuffer.length() == 1)
5675 && (collectBuffer.charAt(0) == '(')) {
5676 // G0 --> United Kingdom set
5677 currentState.g0Charset = CharacterSet.UK;
5678 }
5679 if ((collectBuffer.length() == 1)
5680 && (collectBuffer.charAt(0) == ')')) {
5681 // G1 --> United Kingdom set
5682 currentState.g1Charset = CharacterSet.UK;
5683 }
5684 if ((type == DeviceType.VT220)
5685 || (type == DeviceType.XTERM)) {
5686
5687 if ((collectBuffer.length() == 1)
5688 && (collectBuffer.charAt(0) == '*')) {
5689 // G2 --> United Kingdom set
5690 currentState.g2Charset = CharacterSet.UK;
5691 }
5692 if ((collectBuffer.length() == 1)
5693 && (collectBuffer.charAt(0) == '+')) {
5694 // G3 --> United Kingdom set
5695 currentState.g3Charset = CharacterSet.UK;
5696 }
5697 }
5698 break;
5699 case 'B':
5700 if ((collectBuffer.length() == 1)
5701 && (collectBuffer.charAt(0) == '(')) {
5702 // G0 --> ASCII set
5703 currentState.g0Charset = CharacterSet.US;
5704 }
5705 if ((collectBuffer.length() == 1)
5706 && (collectBuffer.charAt(0) == ')')) {
5707 // G1 --> ASCII set
5708 currentState.g1Charset = CharacterSet.US;
5709 }
5710 if ((type == DeviceType.VT220)
5711 || (type == DeviceType.XTERM)) {
5712
5713 if ((collectBuffer.length() == 1)
5714 && (collectBuffer.charAt(0) == '*')) {
5715 // G2 --> ASCII
5716 currentState.g2Charset = CharacterSet.US;
5717 }
5718 if ((collectBuffer.length() == 1)
5719 && (collectBuffer.charAt(0) == '+')) {
5720 // G3 --> ASCII
5721 currentState.g3Charset = CharacterSet.US;
5722 }
5723 }
5724 break;
5725 case 'C':
5726 if ((type == DeviceType.VT220)
5727 || (type == DeviceType.XTERM)) {
5728
5729 if ((collectBuffer.length() == 1)
5730 && (collectBuffer.charAt(0) == '(')) {
5731 // G0 --> FINNISH
5732 currentState.g0Charset = CharacterSet.NRC_FINNISH;
5733 }
5734 if ((collectBuffer.length() == 1)
5735 && (collectBuffer.charAt(0) == ')')) {
5736 // G1 --> FINNISH
5737 currentState.g1Charset = CharacterSet.NRC_FINNISH;
5738 }
5739 if ((collectBuffer.length() == 1)
5740 && (collectBuffer.charAt(0) == '*')) {
5741 // G2 --> FINNISH
5742 currentState.g2Charset = CharacterSet.NRC_FINNISH;
5743 }
5744 if ((collectBuffer.length() == 1)
5745 && (collectBuffer.charAt(0) == '+')) {
5746 // G3 --> FINNISH
5747 currentState.g3Charset = CharacterSet.NRC_FINNISH;
5748 }
5749 }
5750 break;
5751 case 'D':
5752 break;
5753 case 'E':
5754 if ((type == DeviceType.VT220)
5755 || (type == DeviceType.XTERM)) {
5756
5757 if ((collectBuffer.length() == 1)
5758 && (collectBuffer.charAt(0) == '(')) {
5759 // G0 --> NORWEGIAN
5760 currentState.g0Charset = CharacterSet.NRC_NORWEGIAN;
5761 }
5762 if ((collectBuffer.length() == 1)
5763 && (collectBuffer.charAt(0) == ')')) {
5764 // G1 --> NORWEGIAN
5765 currentState.g1Charset = CharacterSet.NRC_NORWEGIAN;
5766 }
5767 if ((collectBuffer.length() == 1)
5768 && (collectBuffer.charAt(0) == '*')) {
5769 // G2 --> NORWEGIAN
5770 currentState.g2Charset = CharacterSet.NRC_NORWEGIAN;
5771 }
5772 if ((collectBuffer.length() == 1)
5773 && (collectBuffer.charAt(0) == '+')) {
5774 // G3 --> NORWEGIAN
5775 currentState.g3Charset = CharacterSet.NRC_NORWEGIAN;
5776 }
5777 }
5778 break;
5779 case 'F':
5780 if ((type == DeviceType.VT220)
5781 || (type == DeviceType.XTERM)) {
5782
5783 if ((collectBuffer.length() == 1)
5784 && (collectBuffer.charAt(0) == ' ')) {
5785 // S7C1T
5786 s8c1t = false;
5787 }
5788 }
5789 break;
5790 case 'G':
5791 if ((type == DeviceType.VT220)
5792 || (type == DeviceType.XTERM)) {
5793
5794 if ((collectBuffer.length() == 1)
5795 && (collectBuffer.charAt(0) == ' ')) {
5796 // S8C1T
5797 s8c1t = true;
5798 }
5799 }
5800 break;
5801 case 'H':
5802 if ((type == DeviceType.VT220)
5803 || (type == DeviceType.XTERM)) {
5804
5805 if ((collectBuffer.length() == 1)
5806 && (collectBuffer.charAt(0) == '(')) {
5807 // G0 --> SWEDISH
5808 currentState.g0Charset = CharacterSet.NRC_SWEDISH;
5809 }
5810 if ((collectBuffer.length() == 1)
5811 && (collectBuffer.charAt(0) == ')')) {
5812 // G1 --> SWEDISH
5813 currentState.g1Charset = CharacterSet.NRC_SWEDISH;
5814 }
5815 if ((collectBuffer.length() == 1)
5816 && (collectBuffer.charAt(0) == '*')) {
5817 // G2 --> SWEDISH
5818 currentState.g2Charset = CharacterSet.NRC_SWEDISH;
5819 }
5820 if ((collectBuffer.length() == 1)
5821 && (collectBuffer.charAt(0) == '+')) {
5822 // G3 --> SWEDISH
5823 currentState.g3Charset = CharacterSet.NRC_SWEDISH;
5824 }
5825 }
5826 break;
5827 case 'I':
5828 case 'J':
5829 break;
5830 case 'K':
5831 if ((type == DeviceType.VT220)
5832 || (type == DeviceType.XTERM)) {
5833
5834 if ((collectBuffer.length() == 1)
5835 && (collectBuffer.charAt(0) == '(')) {
5836 // G0 --> GERMAN
5837 currentState.g0Charset = CharacterSet.NRC_GERMAN;
5838 }
5839 if ((collectBuffer.length() == 1)
5840 && (collectBuffer.charAt(0) == ')')) {
5841 // G1 --> GERMAN
5842 currentState.g1Charset = CharacterSet.NRC_GERMAN;
5843 }
5844 if ((collectBuffer.length() == 1)
5845 && (collectBuffer.charAt(0) == '*')) {
5846 // G2 --> GERMAN
5847 currentState.g2Charset = CharacterSet.NRC_GERMAN;
5848 }
5849 if ((collectBuffer.length() == 1)
5850 && (collectBuffer.charAt(0) == '+')) {
5851 // G3 --> GERMAN
5852 currentState.g3Charset = CharacterSet.NRC_GERMAN;
5853 }
5854 }
5855 break;
5856 case 'L':
5857 case 'M':
5858 case 'N':
5859 case 'O':
5860 case 'P':
5861 break;
5862 case 'Q':
5863 if ((type == DeviceType.VT220)
5864 || (type == DeviceType.XTERM)) {
5865
5866 if ((collectBuffer.length() == 1)
5867 && (collectBuffer.charAt(0) == '(')) {
5868 // G0 --> FRENCH_CA
5869 currentState.g0Charset = CharacterSet.NRC_FRENCH_CA;
5870 }
5871 if ((collectBuffer.length() == 1)
5872 && (collectBuffer.charAt(0) == ')')) {
5873 // G1 --> FRENCH_CA
5874 currentState.g1Charset = CharacterSet.NRC_FRENCH_CA;
5875 }
5876 if ((collectBuffer.length() == 1)
5877 && (collectBuffer.charAt(0) == '*')) {
5878 // G2 --> FRENCH_CA
5879 currentState.g2Charset = CharacterSet.NRC_FRENCH_CA;
5880 }
5881 if ((collectBuffer.length() == 1)
5882 && (collectBuffer.charAt(0) == '+')) {
5883 // G3 --> FRENCH_CA
5884 currentState.g3Charset = CharacterSet.NRC_FRENCH_CA;
5885 }
5886 }
5887 break;
5888 case 'R':
5889 if ((type == DeviceType.VT220)
5890 || (type == DeviceType.XTERM)) {
5891
5892 if ((collectBuffer.length() == 1)
5893 && (collectBuffer.charAt(0) == '(')) {
5894 // G0 --> FRENCH
5895 currentState.g0Charset = CharacterSet.NRC_FRENCH;
5896 }
5897 if ((collectBuffer.length() == 1)
5898 && (collectBuffer.charAt(0) == ')')) {
5899 // G1 --> FRENCH
5900 currentState.g1Charset = CharacterSet.NRC_FRENCH;
5901 }
5902 if ((collectBuffer.length() == 1)
5903 && (collectBuffer.charAt(0) == '*')) {
5904 // G2 --> FRENCH
5905 currentState.g2Charset = CharacterSet.NRC_FRENCH;
5906 }
5907 if ((collectBuffer.length() == 1)
5908 && (collectBuffer.charAt(0) == '+')) {
5909 // G3 --> FRENCH
5910 currentState.g3Charset = CharacterSet.NRC_FRENCH;
5911 }
5912 }
5913 break;
5914 case 'S':
5915 case 'T':
5916 case 'U':
5917 case 'V':
5918 case 'W':
5919 case 'X':
5920 break;
5921 case 'Y':
5922 if ((type == DeviceType.VT220)
5923 || (type == DeviceType.XTERM)) {
5924
5925 if ((collectBuffer.length() == 1)
5926 && (collectBuffer.charAt(0) == '(')) {
5927 // G0 --> ITALIAN
5928 currentState.g0Charset = CharacterSet.NRC_ITALIAN;
5929 }
5930 if ((collectBuffer.length() == 1)
5931 && (collectBuffer.charAt(0) == ')')) {
5932 // G1 --> ITALIAN
5933 currentState.g1Charset = CharacterSet.NRC_ITALIAN;
5934 }
5935 if ((collectBuffer.length() == 1)
5936 && (collectBuffer.charAt(0) == '*')) {
5937 // G2 --> ITALIAN
5938 currentState.g2Charset = CharacterSet.NRC_ITALIAN;
5939 }
5940 if ((collectBuffer.length() == 1)
5941 && (collectBuffer.charAt(0) == '+')) {
5942 // G3 --> ITALIAN
5943 currentState.g3Charset = CharacterSet.NRC_ITALIAN;
5944 }
5945 }
5946 break;
5947 case 'Z':
5948 if ((type == DeviceType.VT220)
5949 || (type == DeviceType.XTERM)) {
5950
5951 if ((collectBuffer.length() == 1)
5952 && (collectBuffer.charAt(0) == '(')) {
5953 // G0 --> SPANISH
5954 currentState.g0Charset = CharacterSet.NRC_SPANISH;
5955 }
5956 if ((collectBuffer.length() == 1)
5957 && (collectBuffer.charAt(0) == ')')) {
5958 // G1 --> SPANISH
5959 currentState.g1Charset = CharacterSet.NRC_SPANISH;
5960 }
5961 if ((collectBuffer.length() == 1)
5962 && (collectBuffer.charAt(0) == '*')) {
5963 // G2 --> SPANISH
5964 currentState.g2Charset = CharacterSet.NRC_SPANISH;
5965 }
5966 if ((collectBuffer.length() == 1)
5967 && (collectBuffer.charAt(0) == '+')) {
5968 // G3 --> SPANISH
5969 currentState.g3Charset = CharacterSet.NRC_SPANISH;
5970 }
5971 }
5972 break;
5973 case '[':
5974 case '\\':
5975 case ']':
5976 case '^':
5977 case '_':
5978 case '`':
5979 case 'a':
5980 case 'b':
5981 case 'c':
5982 case 'd':
5983 case 'e':
5984 case 'f':
5985 case 'g':
5986 case 'h':
5987 case 'i':
5988 case 'j':
5989 case 'k':
5990 case 'l':
5991 case 'm':
5992 case 'n':
5993 case 'o':
5994 case 'p':
5995 case 'q':
5996 case 'r':
5997 case 's':
5998 case 't':
5999 case 'u':
6000 case 'v':
6001 case 'w':
6002 case 'x':
6003 case 'y':
6004 case 'z':
6005 case '{':
6006 case '|':
6007 case '}':
6008 case '~':
6009 break;
6010 }
6011 toGround();
6012 }
6013
6014 // 7F --> ignore
6015
6016 // 0x9C goes to GROUND
6017 if (ch == 0x9C) {
6018 toGround();
6019 }
6020
6021 return;
6022
6023 case CSI_ENTRY:
6024 // 00-17, 19, 1C-1F --> execute
6025 if (ch <= 0x1F) {
6026 handleControlChar((char) ch);
6027 }
6028
6029 // 20-2F --> collect, then switch to CSI_INTERMEDIATE
6030 if ((ch >= 0x20) && (ch <= 0x2F)) {
6031 collect((char) ch);
6032 scanState = ScanState.CSI_INTERMEDIATE;
6033 }
6034
6035 // 30-39, 3B --> param, then switch to CSI_PARAM
6036 if ((ch >= '0') && (ch <= '9')) {
6037 param((byte) ch);
6038 scanState = ScanState.CSI_PARAM;
6039 }
6040 if (ch == ';') {
6041 param((byte) ch);
6042 scanState = ScanState.CSI_PARAM;
6043 }
6044
6045 // 3C-3F --> collect, then switch to CSI_PARAM
6046 if ((ch >= 0x3C) && (ch <= 0x3F)) {
6047 collect((char) ch);
6048 scanState = ScanState.CSI_PARAM;
6049 }
6050
6051 // 40-7E --> dispatch, then switch to GROUND
6052 if ((ch >= 0x40) && (ch <= 0x7E)) {
6053 switch (ch) {
6054 case '@':
6055 // ICH - Insert character
6056 ich();
6057 break;
6058 case 'A':
6059 // CUU - Cursor up
6060 cuu();
6061 break;
6062 case 'B':
6063 // CUD - Cursor down
6064 cud();
6065 break;
6066 case 'C':
6067 // CUF - Cursor forward
6068 cuf();
6069 break;
6070 case 'D':
6071 // CUB - Cursor backward
6072 cub();
6073 break;
6074 case 'E':
6075 // CNL - Cursor down and to column 1
6076 if (type == DeviceType.XTERM) {
6077 cnl();
6078 }
6079 break;
6080 case 'F':
6081 // CPL - Cursor up and to column 1
6082 if (type == DeviceType.XTERM) {
6083 cpl();
6084 }
6085 break;
6086 case 'G':
6087 // CHA - Cursor to column # in current row
6088 if (type == DeviceType.XTERM) {
6089 cha();
6090 }
6091 break;
6092 case 'H':
6093 // CUP - Cursor position
6094 cup();
6095 break;
6096 case 'I':
6097 // CHT - Cursor forward X tab stops (default 1)
6098 if (type == DeviceType.XTERM) {
6099 cht();
6100 }
6101 break;
6102 case 'J':
6103 // ED - Erase in display
6104 ed();
6105 break;
6106 case 'K':
6107 // EL - Erase in line
6108 el();
6109 break;
6110 case 'L':
6111 // IL - Insert line
6112 il();
6113 break;
6114 case 'M':
6115 // DL - Delete line
6116 dl();
6117 break;
6118 case 'N':
6119 case 'O':
6120 break;
6121 case 'P':
6122 // DCH - Delete character
6123 dch();
6124 break;
6125 case 'Q':
6126 case 'R':
6127 break;
6128 case 'S':
6129 // Scroll up X lines (default 1)
6130 if (type == DeviceType.XTERM) {
6131 boolean xtermPrivateModeFlag = false;
6132 for (int i = 0; i < collectBuffer.length(); i++) {
6133 if (collectBuffer.charAt(i) == '?') {
6134 xtermPrivateModeFlag = true;
6135 break;
6136 }
6137 }
6138 if (xtermPrivateModeFlag) {
6139 xtermSixelQuery();
6140 } else {
6141 su();
6142 }
6143 }
6144 break;
6145 case 'T':
6146 // Scroll down X lines (default 1)
6147 if (type == DeviceType.XTERM) {
6148 sd();
6149 }
6150 break;
6151 case 'U':
6152 case 'V':
6153 case 'W':
6154 break;
6155 case 'X':
6156 if ((type == DeviceType.VT220)
6157 || (type == DeviceType.XTERM)) {
6158
6159 // ECH - Erase character
6160 ech();
6161 }
6162 break;
6163 case 'Y':
6164 break;
6165 case 'Z':
6166 // CBT - Cursor backward X tab stops (default 1)
6167 if (type == DeviceType.XTERM) {
6168 cbt();
6169 }
6170 break;
6171 case '[':
6172 case '\\':
6173 case ']':
6174 case '^':
6175 case '_':
6176 break;
6177 case '`':
6178 // HPA - Cursor to column # in current row. Same as CHA
6179 if (type == DeviceType.XTERM) {
6180 cha();
6181 }
6182 break;
6183 case 'a':
6184 // HPR - Cursor right. Same as CUF
6185 if (type == DeviceType.XTERM) {
6186 cuf();
6187 }
6188 break;
6189 case 'b':
6190 // REP - Repeat last char X times
6191 if (type == DeviceType.XTERM) {
6192 rep();
6193 }
6194 break;
6195 case 'c':
6196 // DA - Device attributes
6197 da();
6198 break;
6199 case 'd':
6200 // VPA - Cursor to row, current column.
6201 if (type == DeviceType.XTERM) {
6202 vpa();
6203 }
6204 break;
6205 case 'e':
6206 // VPR - Cursor down. Same as CUD
6207 if (type == DeviceType.XTERM) {
6208 cud();
6209 }
6210 break;
6211 case 'f':
6212 // HVP - Horizontal and vertical position
6213 hvp();
6214 break;
6215 case 'g':
6216 // TBC - Tabulation clear
6217 tbc();
6218 break;
6219 case 'h':
6220 // Sets an ANSI or DEC private toggle
6221 setToggle(true);
6222 break;
6223 case 'i':
6224 if ((type == DeviceType.VT220)
6225 || (type == DeviceType.XTERM)) {
6226
6227 // Printer functions
6228 printerFunctions();
6229 }
6230 break;
6231 case 'j':
6232 case 'k':
6233 break;
6234 case 'l':
6235 // Sets an ANSI or DEC private toggle
6236 setToggle(false);
6237 break;
6238 case 'm':
6239 // SGR - Select graphics rendition
6240 sgr();
6241 break;
6242 case 'n':
6243 // DSR - Device status report
6244 dsr();
6245 break;
6246 case 'o':
6247 case 'p':
6248 break;
6249 case 'q':
6250 // DECLL - Load leds
6251 // Not supported
6252 break;
6253 case 'r':
6254 // DECSTBM - Set top and bottom margins
6255 decstbm();
6256 break;
6257 case 's':
6258 // Save cursor (ANSI.SYS)
6259 if (type == DeviceType.XTERM) {
6260 savedState.cursorX = currentState.cursorX;
6261 savedState.cursorY = currentState.cursorY;
6262 }
6263 break;
6264 case 't':
6265 if (type == DeviceType.XTERM) {
6266 // Window operations
6267 xtermWindowOps();
6268 }
6269 break;
6270 case 'u':
6271 // Restore cursor (ANSI.SYS)
6272 if (type == DeviceType.XTERM) {
6273 cursorPosition(savedState.cursorY, savedState.cursorX);
6274 }
6275 break;
6276 case 'v':
6277 case 'w':
6278 break;
6279 case 'x':
6280 // DECREQTPARM - Request terminal parameters
6281 decreqtparm();
6282 break;
6283 case 'y':
6284 case 'z':
6285 case '{':
6286 case '|':
6287 case '}':
6288 case '~':
6289 break;
6290 }
6291 toGround();
6292 }
6293
6294 // 7F --> ignore
6295
6296 // 0x9C goes to GROUND
6297 if (ch == 0x9C) {
6298 toGround();
6299 }
6300
6301 // 0x3A goes to CSI_IGNORE
6302 if (ch == 0x3A) {
6303 scanState = ScanState.CSI_IGNORE;
6304 }
6305 return;
6306
6307 case CSI_PARAM:
6308 // 00-17, 19, 1C-1F --> execute
6309 if (ch <= 0x1F) {
6310 handleControlChar((char) ch);
6311 }
6312
6313 // 20-2F --> collect, then switch to CSI_INTERMEDIATE
6314 if ((ch >= 0x20) && (ch <= 0x2F)) {
6315 collect((char) ch);
6316 scanState = ScanState.CSI_INTERMEDIATE;
6317 }
6318
6319 // 30-39, 3B --> param
6320 if ((ch >= '0') && (ch <= '9')) {
6321 param((byte) ch);
6322 }
6323 if (ch == ';') {
6324 param((byte) ch);
6325 }
6326
6327 // 0x3A goes to CSI_IGNORE
6328 if (ch == 0x3A) {
6329 scanState = ScanState.CSI_IGNORE;
6330 }
6331 // 0x3C-3F goes to CSI_IGNORE
6332 if ((ch >= 0x3C) && (ch <= 0x3F)) {
6333 scanState = ScanState.CSI_IGNORE;
6334 }
6335
6336 // 40-7E --> dispatch, then switch to GROUND
6337 if ((ch >= 0x40) && (ch <= 0x7E)) {
6338 switch (ch) {
6339 case '@':
6340 // ICH - Insert character
6341 ich();
6342 break;
6343 case 'A':
6344 // CUU - Cursor up
6345 cuu();
6346 break;
6347 case 'B':
6348 // CUD - Cursor down
6349 cud();
6350 break;
6351 case 'C':
6352 // CUF - Cursor forward
6353 cuf();
6354 break;
6355 case 'D':
6356 // CUB - Cursor backward
6357 cub();
6358 break;
6359 case 'E':
6360 // CNL - Cursor down and to column 1
6361 if (type == DeviceType.XTERM) {
6362 cnl();
6363 }
6364 break;
6365 case 'F':
6366 // CPL - Cursor up and to column 1
6367 if (type == DeviceType.XTERM) {
6368 cpl();
6369 }
6370 break;
6371 case 'G':
6372 // CHA - Cursor to column # in current row
6373 if (type == DeviceType.XTERM) {
6374 cha();
6375 }
6376 break;
6377 case 'H':
6378 // CUP - Cursor position
6379 cup();
6380 break;
6381 case 'I':
6382 // CHT - Cursor forward X tab stops (default 1)
6383 if (type == DeviceType.XTERM) {
6384 cht();
6385 }
6386 break;
6387 case 'J':
6388 // ED - Erase in display
6389 ed();
6390 break;
6391 case 'K':
6392 // EL - Erase in line
6393 el();
6394 break;
6395 case 'L':
6396 // IL - Insert line
6397 il();
6398 break;
6399 case 'M':
6400 // DL - Delete line
6401 dl();
6402 break;
6403 case 'N':
6404 case 'O':
6405 break;
6406 case 'P':
6407 // DCH - Delete character
6408 dch();
6409 break;
6410 case 'Q':
6411 case 'R':
6412 break;
6413 case 'S':
6414 // Scroll up X lines (default 1)
6415 if (type == DeviceType.XTERM) {
6416 boolean xtermPrivateModeFlag = false;
6417 for (int i = 0; i < collectBuffer.length(); i++) {
6418 if (collectBuffer.charAt(i) == '?') {
6419 xtermPrivateModeFlag = true;
6420 break;
6421 }
6422 }
6423 if (xtermPrivateModeFlag) {
6424 xtermSixelQuery();
6425 } else {
6426 su();
6427 }
6428 }
6429 break;
6430 case 'T':
6431 // Scroll down X lines (default 1)
6432 if (type == DeviceType.XTERM) {
6433 sd();
6434 }
6435 break;
6436 case 'U':
6437 case 'V':
6438 case 'W':
6439 break;
6440 case 'X':
6441 if ((type == DeviceType.VT220)
6442 || (type == DeviceType.XTERM)) {
6443
6444 // ECH - Erase character
6445 ech();
6446 }
6447 break;
6448 case 'Y':
6449 break;
6450 case 'Z':
6451 // CBT - Cursor backward X tab stops (default 1)
6452 if (type == DeviceType.XTERM) {
6453 cbt();
6454 }
6455 break;
6456 case '[':
6457 case '\\':
6458 case ']':
6459 case '^':
6460 case '_':
6461 break;
6462 case '`':
6463 // HPA - Cursor to column # in current row. Same as CHA
6464 if (type == DeviceType.XTERM) {
6465 cha();
6466 }
6467 break;
6468 case 'a':
6469 // HPR - Cursor right. Same as CUF
6470 if (type == DeviceType.XTERM) {
6471 cuf();
6472 }
6473 break;
6474 case 'b':
6475 // REP - Repeat last char X times
6476 if (type == DeviceType.XTERM) {
6477 rep();
6478 }
6479 break;
6480 case 'c':
6481 // DA - Device attributes
6482 da();
6483 break;
6484 case 'd':
6485 // VPA - Cursor to row, current column.
6486 if (type == DeviceType.XTERM) {
6487 vpa();
6488 }
6489 break;
6490 case 'e':
6491 // VPR - Cursor down. Same as CUD
6492 if (type == DeviceType.XTERM) {
6493 cud();
6494 }
6495 break;
6496 case 'f':
6497 // HVP - Horizontal and vertical position
6498 hvp();
6499 break;
6500 case 'g':
6501 // TBC - Tabulation clear
6502 tbc();
6503 break;
6504 case 'h':
6505 // Sets an ANSI or DEC private toggle
6506 setToggle(true);
6507 break;
6508 case 'i':
6509 if ((type == DeviceType.VT220)
6510 || (type == DeviceType.XTERM)) {
6511
6512 // Printer functions
6513 printerFunctions();
6514 }
6515 break;
6516 case 'j':
6517 case 'k':
6518 break;
6519 case 'l':
6520 // Sets an ANSI or DEC private toggle
6521 setToggle(false);
6522 break;
6523 case 'm':
6524 // SGR - Select graphics rendition
6525 sgr();
6526 break;
6527 case 'n':
6528 // DSR - Device status report
6529 dsr();
6530 break;
6531 case 'o':
6532 case 'p':
6533 break;
6534 case 'q':
6535 // DECLL - Load leds
6536 // Not supported
6537 break;
6538 case 'r':
6539 // DECSTBM - Set top and bottom margins
6540 decstbm();
6541 break;
6542 case 's':
6543 break;
6544 case 't':
6545 if (type == DeviceType.XTERM) {
6546 // Window operations
6547 xtermWindowOps();
6548 }
6549 break;
6550 case 'u':
6551 case 'v':
6552 case 'w':
6553 break;
6554 case 'x':
6555 // DECREQTPARM - Request terminal parameters
6556 decreqtparm();
6557 break;
6558 case 'y':
6559 case 'z':
6560 case '{':
6561 case '|':
6562 case '}':
6563 case '~':
6564 break;
6565 }
6566 toGround();
6567 }
6568
6569 // 7F --> ignore
6570 return;
6571
6572 case CSI_INTERMEDIATE:
6573 // 00-17, 19, 1C-1F --> execute
6574 if (ch <= 0x1F) {
6575 handleControlChar((char) ch);
6576 }
6577
6578 // 20-2F --> collect
6579 if ((ch >= 0x20) && (ch <= 0x2F)) {
6580 collect((char) ch);
6581 }
6582
6583 // 0x30-3F goes to CSI_IGNORE
6584 if ((ch >= 0x30) && (ch <= 0x3F)) {
6585 scanState = ScanState.CSI_IGNORE;
6586 }
6587
6588 // 40-7E --> dispatch, then switch to GROUND
6589 if ((ch >= 0x40) && (ch <= 0x7E)) {
6590 switch (ch) {
6591 case '@':
6592 case 'A':
6593 case 'B':
6594 case 'C':
6595 case 'D':
6596 case 'E':
6597 case 'F':
6598 case 'G':
6599 case 'H':
6600 case 'I':
6601 case 'J':
6602 case 'K':
6603 case 'L':
6604 case 'M':
6605 case 'N':
6606 case 'O':
6607 case 'P':
6608 case 'Q':
6609 case 'R':
6610 case 'S':
6611 case 'T':
6612 case 'U':
6613 case 'V':
6614 case 'W':
6615 case 'X':
6616 case 'Y':
6617 case 'Z':
6618 case '[':
6619 case '\\':
6620 case ']':
6621 case '^':
6622 case '_':
6623 case '`':
6624 case 'a':
6625 case 'b':
6626 case 'c':
6627 case 'd':
6628 case 'e':
6629 case 'f':
6630 case 'g':
6631 case 'h':
6632 case 'i':
6633 case 'j':
6634 case 'k':
6635 case 'l':
6636 case 'm':
6637 case 'n':
6638 case 'o':
6639 break;
6640 case 'p':
6641 if (((type == DeviceType.VT220)
6642 || (type == DeviceType.XTERM))
6643 && (collectBuffer.charAt(collectBuffer.length() - 1) == '\"')
6644 ) {
6645 // DECSCL - compatibility level
6646 decscl();
6647 }
6648 if ((type == DeviceType.XTERM)
6649 && (collectBuffer.charAt(collectBuffer.length() - 1) == '!')
6650 ) {
6651 // DECSTR - Soft terminal reset
6652 decstr();
6653 }
6654 break;
6655 case 'q':
6656 if (((type == DeviceType.VT220)
6657 || (type == DeviceType.XTERM))
6658 && (collectBuffer.charAt(collectBuffer.length() - 1) == '\"')
6659 ) {
6660 // DECSCA
6661 decsca();
6662 }
6663 break;
6664 case 'r':
6665 case 's':
6666 case 't':
6667 case 'u':
6668 case 'v':
6669 case 'w':
6670 case 'x':
6671 case 'y':
6672 case 'z':
6673 case '{':
6674 case '|':
6675 case '}':
6676 case '~':
6677 break;
6678 }
6679 toGround();
6680 }
6681
6682 // 7F --> ignore
6683 return;
6684
6685 case CSI_IGNORE:
6686 // 00-17, 19, 1C-1F --> execute
6687 if (ch <= 0x1F) {
6688 handleControlChar((char) ch);
6689 }
6690
6691 // 20-2F --> collect
6692 if ((ch >= 0x20) && (ch <= 0x2F)) {
6693 collect((char) ch);
6694 }
6695
6696 // 40-7E --> ignore, then switch to GROUND
6697 if ((ch >= 0x40) && (ch <= 0x7E)) {
6698 toGround();
6699 }
6700
6701 // 20-3F, 7F --> ignore
6702
6703 return;
6704
6705 case DCS_ENTRY:
6706
6707 // 0x9C goes to GROUND
6708 if (ch == 0x9C) {
6709 toGround();
6710 }
6711
6712 // 0x1B 0x5C goes to GROUND
6713 if (ch == 0x1B) {
6714 collect((char) ch);
6715 }
6716 if (ch == 0x5C) {
6717 if ((collectBuffer.length() > 0)
6718 && (collectBuffer.charAt(collectBuffer.length() - 1) == 0x1B)
6719 ) {
6720 toGround();
6721 }
6722 }
6723
6724 // 20-2F --> collect, then switch to DCS_INTERMEDIATE
6725 if ((ch >= 0x20) && (ch <= 0x2F)) {
6726 collect((char) ch);
6727 scanState = ScanState.DCS_INTERMEDIATE;
6728 }
6729
6730 // 30-39, 3B --> param, then switch to DCS_PARAM
6731 if ((ch >= '0') && (ch <= '9')) {
6732 param((byte) ch);
6733 scanState = ScanState.DCS_PARAM;
6734 }
6735 if (ch == ';') {
6736 param((byte) ch);
6737 scanState = ScanState.DCS_PARAM;
6738 }
6739
6740 // 3C-3F --> collect, then switch to DCS_PARAM
6741 if ((ch >= 0x3C) && (ch <= 0x3F)) {
6742 collect((char) ch);
6743 scanState = ScanState.DCS_PARAM;
6744 }
6745
6746 // 00-17, 19, 1C-1F, 7F --> ignore
6747
6748 // 0x3A goes to DCS_IGNORE
6749 if (ch == 0x3F) {
6750 scanState = ScanState.DCS_IGNORE;
6751 }
6752
6753 // 0x71 goes to DCS_SIXEL
6754 if (ch == 0x71) {
6755 sixelParseBuffer.setLength(0);
6756 scanState = ScanState.DCS_SIXEL;
6757 } else if ((ch >= 0x40) && (ch <= 0x7E)) {
6758 // 0x40-7E goes to DCS_PASSTHROUGH
6759 scanState = ScanState.DCS_PASSTHROUGH;
6760 }
6761 return;
6762
6763 case DCS_INTERMEDIATE:
6764
6765 // 0x9C goes to GROUND
6766 if (ch == 0x9C) {
6767 toGround();
6768 }
6769
6770 // 0x1B 0x5C goes to GROUND
6771 if (ch == 0x1B) {
6772 collect((char) ch);
6773 }
6774 if (ch == 0x5C) {
6775 if ((collectBuffer.length() > 0)
6776 && (collectBuffer.charAt(collectBuffer.length() - 1) == 0x1B)
6777 ) {
6778 toGround();
6779 }
6780 }
6781
6782 // 0x30-3F goes to DCS_IGNORE
6783 if ((ch >= 0x30) && (ch <= 0x3F)) {
6784 scanState = ScanState.DCS_IGNORE;
6785 }
6786
6787 // 0x40-7E goes to DCS_PASSTHROUGH
6788 if ((ch >= 0x40) && (ch <= 0x7E)) {
6789 scanState = ScanState.DCS_PASSTHROUGH;
6790 }
6791
6792 // 00-17, 19, 1C-1F, 7F --> ignore
6793 return;
6794
6795 case DCS_PARAM:
6796
6797 // 0x9C goes to GROUND
6798 if (ch == 0x9C) {
6799 toGround();
6800 }
6801
6802 // 0x1B 0x5C goes to GROUND
6803 if (ch == 0x1B) {
6804 collect((char) ch);
6805 }
6806 if (ch == 0x5C) {
6807 if ((collectBuffer.length() > 0)
6808 && (collectBuffer.charAt(collectBuffer.length() - 1) == 0x1B)
6809 ) {
6810 toGround();
6811 }
6812 }
6813
6814 // 20-2F --> collect, then switch to DCS_INTERMEDIATE
6815 if ((ch >= 0x20) && (ch <= 0x2F)) {
6816 collect((char) ch);
6817 scanState = ScanState.DCS_INTERMEDIATE;
6818 }
6819
6820 // 30-39, 3B --> param
6821 if ((ch >= '0') && (ch <= '9')) {
6822 param((byte) ch);
6823 }
6824 if (ch == ';') {
6825 param((byte) ch);
6826 }
6827
6828 // 00-17, 19, 1C-1F, 7F --> ignore
6829
6830 // 0x3A, 3C-3F goes to DCS_IGNORE
6831 if (ch == 0x3F) {
6832 scanState = ScanState.DCS_IGNORE;
6833 }
6834 if ((ch >= 0x3C) && (ch <= 0x3F)) {
6835 scanState = ScanState.DCS_IGNORE;
6836 }
6837
6838 // 0x71 goes to DCS_SIXEL
6839 if (ch == 0x71) {
6840 sixelParseBuffer.setLength(0);
6841 scanState = ScanState.DCS_SIXEL;
6842 } else if ((ch >= 0x40) && (ch <= 0x7E)) {
6843 // 0x40-7E goes to DCS_PASSTHROUGH
6844 scanState = ScanState.DCS_PASSTHROUGH;
6845 }
6846 return;
6847
6848 case DCS_PASSTHROUGH:
6849 // 0x9C goes to GROUND
6850 if (ch == 0x9C) {
6851 toGround();
6852 }
6853
6854 // 0x1B 0x5C goes to GROUND
6855 if (ch == 0x1B) {
6856 collect((char) ch);
6857 }
6858 if (ch == 0x5C) {
6859 if ((collectBuffer.length() > 0)
6860 && (collectBuffer.charAt(collectBuffer.length() - 1) == 0x1B)
6861 ) {
6862 toGround();
6863 }
6864 }
6865
6866 // 00-17, 19, 1C-1F, 20-7E --> put
6867 if (ch <= 0x17) {
6868 // We ignore all DCS except sixel.
6869 return;
6870 }
6871 if (ch == 0x19) {
6872 // We ignore all DCS except sixel.
6873 return;
6874 }
6875 if ((ch >= 0x1C) && (ch <= 0x1F)) {
6876 // We ignore all DCS except sixel.
6877 return;
6878 }
6879 if ((ch >= 0x20) && (ch <= 0x7E)) {
6880 // We ignore all DCS except sixel.
6881 return;
6882 }
6883
6884 // 7F --> ignore
6885
6886 return;
6887
6888 case DCS_IGNORE:
6889 // 00-17, 19, 1C-1F, 20-7F --> ignore
6890
6891 // 0x9C goes to GROUND
6892 if (ch == 0x9C) {
6893 toGround();
6894 }
6895
6896 return;
6897
6898 case DCS_SIXEL:
6899 // 0x9C goes to GROUND
6900 if (ch == 0x9C) {
6901 parseSixel();
6902 toGround();
6903 return;
6904 }
6905
6906 // 0x1B 0x5C goes to GROUND
6907 if (ch == 0x1B) {
6908 collect((char) ch);
6909 return;
6910 }
6911 if (ch == 0x5C) {
6912 if ((collectBuffer.length() > 0)
6913 && (collectBuffer.charAt(collectBuffer.length() - 1) == 0x1B)
6914 ) {
6915 parseSixel();
6916 toGround();
6917 return;
6918 }
6919 }
6920
6921 // 00-17, 19, 1C-1F, 20-7E --> put
6922 if ((ch <= 0x17)
6923 || (ch == 0x19)
6924 || ((ch >= 0x1C) && (ch <= 0x1F))
6925 || ((ch >= 0x20) && (ch <= 0x7E))
6926 ) {
6927 sixelParseBuffer.append((char) ch);
6928 }
6929
6930 // 7F --> ignore
6931 return;
6932
6933 case SOSPMAPC_STRING:
6934 // 00-17, 19, 1C-1F, 20-7F --> ignore
6935
6936 // Special case for Jexer: PM can pass one control character
6937 if (ch == 0x1B) {
6938 pmPut((char) ch);
6939 }
6940
6941 if ((ch >= 0x20) && (ch <= 0x7F)) {
6942 pmPut((char) ch);
6943 }
6944
6945 // 0x9C goes to GROUND
6946 if (ch == 0x9C) {
6947 toGround();
6948 }
6949
6950 return;
6951
6952 case OSC_STRING:
6953 // Special case for Xterm: OSC can pass control characters
6954 if ((ch == 0x9C) || (ch == 0x07) || (ch == 0x1B)) {
6955 oscPut((char) ch);
6956 }
6957
6958 // 00-17, 19, 1C-1F --> ignore
6959
6960 // 20-7F --> osc_put
6961 if ((ch >= 0x20) && (ch <= 0x7F)) {
6962 oscPut((char) ch);
6963 }
6964
6965 // 0x9C goes to GROUND
6966 if (ch == 0x9C) {
6967 toGround();
6968 }
6969
6970 return;
6971
6972 case VT52_DIRECT_CURSOR_ADDRESS:
6973 // This is a special case for the VT52 sequence "ESC Y l c"
6974 if (collectBuffer.length() == 0) {
6975 collect((char) ch);
6976 } else if (collectBuffer.length() == 1) {
6977 // We've got the two characters, one in the buffer and the
6978 // other in ch.
6979 cursorPosition(collectBuffer.charAt(0) - '\040', ch - '\040');
6980 toGround();
6981 }
6982 return;
6983 }
6984
6985 }
6986
6987 /**
6988 * Expose current cursor X to outside world.
6989 *
6990 * @return current cursor X
6991 */
6992 public final int getCursorX() {
6993 if (display.get(currentState.cursorY).isDoubleWidth()) {
6994 return currentState.cursorX * 2;
6995 }
6996 return currentState.cursorX;
6997 }
6998
6999 /**
7000 * Expose current cursor Y to outside world.
7001 *
7002 * @return current cursor Y
7003 */
7004 public final int getCursorY() {
7005 return currentState.cursorY;
7006 }
7007
7008 /**
7009 * Returns true if this terminal has requested the mouse pointer be
7010 * hidden.
7011 *
7012 * @return true if this terminal has requested the mouse pointer be
7013 * hidden
7014 */
7015 public final boolean hasHiddenMousePointer() {
7016 return hideMousePointer;
7017 }
7018
7019 /**
7020 * Get the mouse protocol.
7021 *
7022 * @return MouseProtocol.OFF, MouseProtocol.X10, etc.
7023 */
7024 public MouseProtocol getMouseProtocol() {
7025 return mouseProtocol;
7026 }
7027
7028 /**
7029 * Draw the left and right cells of a two-cell-wide (full-width) glyph.
7030 *
7031 * @param leftX the x position to draw the left half to
7032 * @param leftY the y position to draw the left half to
7033 * @param rightX the x position to draw the right half to
7034 * @param rightY the y position to draw the right half to
7035 * @param ch the character to draw
7036 */
7037 private void drawHalves(final int leftX, final int leftY,
7038 final int rightX, final int rightY, final int ch) {
7039
7040 // System.err.println("drawHalves(): " + Integer.toHexString(ch));
7041
7042 if (lastTextHeight != textHeight) {
7043 glyphMaker = GlyphMaker.getInstance(textHeight);
7044 lastTextHeight = textHeight;
7045 }
7046
7047 Cell cell = new Cell(ch, currentState.attr);
7048 BufferedImage image = glyphMaker.getImage(cell, textWidth * 2,
7049 textHeight);
7050 BufferedImage leftImage = image.getSubimage(0, 0, textWidth,
7051 textHeight);
7052 BufferedImage rightImage = image.getSubimage(textWidth, 0, textWidth,
7053 textHeight);
7054
7055 Cell left = new Cell(cell);
7056 left.setImage(leftImage);
7057 left.setWidth(Cell.Width.LEFT);
7058 display.get(leftY).replace(leftX, left);
7059
7060 Cell right = new Cell(cell);
7061 right.setImage(rightImage);
7062 right.setWidth(Cell.Width.RIGHT);
7063 display.get(rightY).replace(rightX, right);
7064 }
7065
7066 /**
7067 * Set the width of a character cell in pixels.
7068 *
7069 * @param textWidth the width in pixels of a character cell
7070 */
7071 public void setTextWidth(final int textWidth) {
7072 this.textWidth = textWidth;
7073 }
7074
7075 /**
7076 * Set the height of a character cell in pixels.
7077 *
7078 * @param textHeight the height in pixels of a character cell
7079 */
7080 public void setTextHeight(final int textHeight) {
7081 this.textHeight = textHeight;
7082 }
7083
7084 /**
7085 * Parse a sixel string into a bitmap image, and overlay that image onto
7086 * the text cells.
7087 */
7088 private void parseSixel() {
7089
7090 /*
7091 System.err.println("parseSixel(): '" + sixelParseBuffer.toString()
7092 + "'");
7093 */
7094
7095 Sixel sixel = new Sixel(sixelParseBuffer.toString(), sixelPalette);
7096 BufferedImage image = sixel.getImage();
7097
7098 // System.err.println("parseSixel(): image " + image);
7099
7100 if (image == null) {
7101 // Sixel data was malformed in some way, bail out.
7102 return;
7103 }
7104 if ((image.getWidth() < 1)
7105 || (image.getWidth() > 10000)
7106 || (image.getHeight() < 1)
7107 || (image.getHeight() > 10000)
7108 ) {
7109 return;
7110 }
7111
7112 imageToCells(image, true);
7113 }
7114
7115 /**
7116 * Parse a "Jexer" RGB image string into a bitmap image, and overlay that
7117 * image onto the text cells.
7118 *
7119 * @param pw width token
7120 * @param ph height token
7121 * @param ps scroll token
7122 * @param data pixel data
7123 */
7124 private void parseJexerImageRGB(final String pw, final String ph,
7125 final String ps, final String data) {
7126
7127 int imageWidth = 0;
7128 int imageHeight = 0;
7129 boolean scroll = false;
7130 try {
7131 imageWidth = Integer.parseInt(pw);
7132 imageHeight = Integer.parseInt(ph);
7133 } catch (NumberFormatException e) {
7134 // SQUASH
7135 return;
7136 }
7137 if ((imageWidth < 1)
7138 || (imageWidth > 10000)
7139 || (imageHeight < 1)
7140 || (imageHeight > 10000)
7141 ) {
7142 return;
7143 }
7144 if (ps.equals("1")) {
7145 scroll = true;
7146 } else if (ps.equals("0")) {
7147 scroll = false;
7148 } else {
7149 return;
7150 }
7151
7152 byte [] bytes = StringUtils.fromBase64(data.getBytes());
7153 if (bytes.length != (imageWidth * imageHeight * 3)) {
7154 return;
7155 }
7156
7157 BufferedImage image = new BufferedImage(imageWidth, imageHeight,
7158 BufferedImage.TYPE_INT_ARGB);
7159
7160 for (int x = 0; x < imageWidth; x++) {
7161 for (int y = 0; y < imageHeight; y++) {
7162 int red = bytes[(y * imageWidth * 3) + (x * 3) ];
7163 if (red < 0) {
7164 red += 256;
7165 }
7166 int green = bytes[(y * imageWidth * 3) + (x * 3) + 1];
7167 if (green < 0) {
7168 green += 256;
7169 }
7170 int blue = bytes[(y * imageWidth * 3) + (x * 3) + 2];
7171 if (blue < 0) {
7172 blue += 256;
7173 }
7174 int rgb = 0xFF000000 | (red << 16) | (green << 8) | blue;
7175 image.setRGB(x, y, rgb);
7176 }
7177 }
7178
7179 imageToCells(image, scroll);
7180 }
7181
7182 /**
7183 * Parse a "Jexer" PNG or JPG image string into a bitmap image, and
7184 * overlay that image onto the text cells.
7185 *
7186 * @param type 1 for PNG, 2 for JPG
7187 * @param ps scroll token
7188 * @param data pixel data
7189 */
7190 private void parseJexerImageFile(final int type, final String ps,
7191 final String data) {
7192
7193 int imageWidth = 0;
7194 int imageHeight = 0;
7195 boolean scroll = false;
7196 BufferedImage image = null;
7197 try {
7198 byte [] bytes = StringUtils.fromBase64(data.getBytes());
7199
7200 switch (type) {
7201 case 1:
7202 if ((bytes[0] != (byte) 0x89)
7203 || (bytes[1] != 'P')
7204 || (bytes[2] != 'N')
7205 || (bytes[3] != 'G')
7206 || (bytes[4] != (byte) 0x0D)
7207 || (bytes[5] != (byte) 0x0A)
7208 || (bytes[6] != (byte) 0x1A)
7209 || (bytes[7] != (byte) 0x0A)
7210 ) {
7211 // File does not have PNG header, bail out.
7212 return;
7213 }
7214 break;
7215
7216 case 2:
7217 if ((bytes[0] != (byte) 0XFF)
7218 || (bytes[1] != (byte) 0xD8)
7219 || (bytes[2] != (byte) 0xFF)
7220 ) {
7221 // File does not have JPG header, bail out.
7222 return;
7223 }
7224 break;
7225
7226 default:
7227 // Unsupported type, bail out.
7228 return;
7229 }
7230
7231 image = ImageIO.read(new ByteArrayInputStream(bytes));
7232 } catch (IOException e) {
7233 // SQUASH
7234 return;
7235 }
7236 assert (image != null);
7237 imageWidth = image.getWidth();
7238 imageHeight = image.getHeight();
7239 if ((imageWidth < 1)
7240 || (imageWidth > 10000)
7241 || (imageHeight < 1)
7242 || (imageHeight > 10000)
7243 ) {
7244 return;
7245 }
7246 if (ps.equals("1")) {
7247 scroll = true;
7248 } else if (ps.equals("0")) {
7249 scroll = false;
7250 } else {
7251 return;
7252 }
7253
7254 imageToCells(image, scroll);
7255 }
7256
7257 /**
7258 * Break up an image into the cells at the current cursor.
7259 *
7260 * @param image the image to display
7261 * @param scroll if true, scroll the image and move the cursor
7262 */
7263 private void imageToCells(final BufferedImage image, final boolean scroll) {
7264 assert (image != null);
7265
7266 /*
7267 * Procedure:
7268 *
7269 * Break up the image into text cell sized pieces as a new array of
7270 * Cells.
7271 *
7272 * Note original column position x0.
7273 *
7274 * For each cell:
7275 *
7276 * 1. Advance (printCharacter(' ')) for horizontal increment, or
7277 * index (linefeed() + cursorPosition(y, x0)) for vertical
7278 * increment.
7279 *
7280 * 2. Set (x, y) cell image data.
7281 *
7282 * 3. For the right and bottom edges:
7283 *
7284 * a. Render the text to pixels using Terminus font.
7285 *
7286 * b. Blit the image on top of the text, using alpha channel.
7287 */
7288 int cellColumns = image.getWidth() / textWidth;
7289 if (cellColumns * textWidth < image.getWidth()) {
7290 cellColumns++;
7291 }
7292 int cellRows = image.getHeight() / textHeight;
7293 if (cellRows * textHeight < image.getHeight()) {
7294 cellRows++;
7295 }
7296
7297 // Break the image up into an array of cells.
7298 Cell [][] cells = new Cell[cellColumns][cellRows];
7299
7300 for (int x = 0; x < cellColumns; x++) {
7301 for (int y = 0; y < cellRows; y++) {
7302
7303 int width = textWidth;
7304 if ((x + 1) * textWidth > image.getWidth()) {
7305 width = image.getWidth() - (x * textWidth);
7306 }
7307 int height = textHeight;
7308 if ((y + 1) * textHeight > image.getHeight()) {
7309 height = image.getHeight() - (y * textHeight);
7310 }
7311
7312 Cell cell = new Cell();
7313 cell.setImage(image.getSubimage(x * textWidth,
7314 y * textHeight, width, height));
7315
7316 cells[x][y] = cell;
7317 }
7318 }
7319
7320 int x0 = currentState.cursorX;
7321 int y0 = currentState.cursorY;
7322 for (int y = 0; y < cellRows; y++) {
7323 for (int x = 0; x < cellColumns; x++) {
7324 assert (currentState.cursorX <= rightMargin);
7325
7326 // A real sixel terminal would render the text of the current
7327 // cell first, then image over it (accounting for blank
7328 // pixels). We do not support that. A cell is either text,
7329 // or image, but not a mix of image-over-text.
7330 DisplayLine line = display.get(currentState.cursorY);
7331 line.replace(currentState.cursorX, cells[x][y]);
7332
7333 // If at the end of the visible screen, stop.
7334 if (currentState.cursorX == rightMargin) {
7335 break;
7336 }
7337 // Room for more image on the visible screen.
7338 currentState.cursorX++;
7339 }
7340 if (currentState.cursorY < scrollRegionBottom - 1) {
7341 // Not at the bottom, down a line.
7342 linefeed();
7343 } else if (scroll == true) {
7344 // At the bottom, scroll as needed.
7345 linefeed();
7346 } else {
7347 // At the bottom, no more scrolling, done.
7348 break;
7349 }
7350
7351 cursorPosition(currentState.cursorY, x0);
7352 }
7353
7354 if (scroll == false) {
7355 cursorPosition(y0, x0);
7356 }
7357
7358 }
7359
7360 }