Commit | Line | Data |
---|---|---|
daa4106c | 1 | /* |
05dbb28d KL |
2 | * Jexer - Java Text User Interface |
3 | * | |
e16dda65 | 4 | * The MIT License (MIT) |
05dbb28d | 5 | * |
a2018e99 | 6 | * Copyright (C) 2017 Kevin Lamonte |
05dbb28d | 7 | * |
e16dda65 KL |
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: | |
05dbb28d | 14 | * |
e16dda65 KL |
15 | * The above copyright notice and this permission notice shall be included in |
16 | * all copies or substantial portions of the Software. | |
05dbb28d | 17 | * |
e16dda65 KL |
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. | |
7b5261bc KL |
25 | * |
26 | * @author Kevin Lamonte [kevin.lamonte@gmail.com] | |
27 | * @version 1 | |
05dbb28d KL |
28 | */ |
29 | package jexer.backend; | |
30 | ||
31 | import java.io.InputStream; | |
32 | import java.io.OutputStream; | |
6985c572 KL |
33 | import java.io.PrintWriter; |
34 | import java.io.Reader; | |
05dbb28d KL |
35 | import java.io.UnsupportedEncodingException; |
36 | import java.util.List; | |
37 | ||
38 | import jexer.event.TInputEvent; | |
05dbb28d KL |
39 | |
40 | /** | |
41 | * This class uses an xterm/ANSI X3.64/ECMA-48 type terminal to provide a | |
42 | * screen, keyboard, and mouse to TApplication. | |
43 | */ | |
42873e30 | 44 | public final class ECMA48Backend extends GenericBackend { |
05dbb28d KL |
45 | |
46 | /** | |
47 | * Input events are processed by this Terminal. | |
48 | */ | |
49 | private ECMA48Terminal terminal; | |
50 | ||
51 | /** | |
52 | * Public constructor. | |
53 | * | |
92554d64 KL |
54 | * @param listener the object this backend needs to wake up when new |
55 | * input comes in | |
05dbb28d KL |
56 | * @param input an InputStream connected to the remote user, or null for |
57 | * System.in. If System.in is used, then on non-Windows systems it will | |
58 | * be put in raw mode; shutdown() will (blindly!) put System.in in cooked | |
59 | * mode. input is always converted to a Reader with UTF-8 encoding. | |
60 | * @param output an OutputStream connected to the remote user, or null | |
61 | * for System.out. output is always converted to a Writer with UTF-8 | |
62 | * encoding. | |
7b5261bc KL |
63 | * @throws UnsupportedEncodingException if an exception is thrown when |
64 | * creating the InputStreamReader | |
05dbb28d | 65 | */ |
92554d64 | 66 | public ECMA48Backend(final Object listener, final InputStream input, |
7b5261bc KL |
67 | final OutputStream output) throws UnsupportedEncodingException { |
68 | ||
69 | // Create a terminal and explicitly set stdin into raw mode | |
92554d64 | 70 | terminal = new ECMA48Terminal(listener, input, output); |
05dbb28d | 71 | |
7b5261bc KL |
72 | // Keep the terminal's sessionInfo so that TApplication can see it |
73 | sessionInfo = terminal.getSessionInfo(); | |
05dbb28d | 74 | |
42873e30 KL |
75 | // ECMA48Terminal is the screen too |
76 | screen = terminal; | |
05dbb28d KL |
77 | } |
78 | ||
6985c572 KL |
79 | /** |
80 | * Public constructor. | |
81 | * | |
82 | * @param listener the object this backend needs to wake up when new | |
83 | * input comes in | |
84 | * @param input the InputStream underlying 'reader'. Its available() | |
85 | * method is used to determine if reader.read() will block or not. | |
86 | * @param reader a Reader connected to the remote user. | |
87 | * @param writer a PrintWriter connected to the remote user. | |
88 | * @param setRawMode if true, set System.in into raw mode with stty. | |
89 | * This should in general not be used. It is here solely for Demo3, | |
90 | * which uses System.in. | |
91 | * @throws IllegalArgumentException if input, reader, or writer are null. | |
92 | */ | |
93 | public ECMA48Backend(final Object listener, final InputStream input, | |
94 | final Reader reader, final PrintWriter writer, | |
95 | final boolean setRawMode) { | |
96 | ||
97 | // Create a terminal and explicitly set stdin into raw mode | |
98 | terminal = new ECMA48Terminal(listener, input, reader, writer, | |
99 | setRawMode); | |
100 | ||
101 | // Keep the terminal's sessionInfo so that TApplication can see it | |
102 | sessionInfo = terminal.getSessionInfo(); | |
103 | ||
42873e30 KL |
104 | // ECMA48Terminal is the screen too |
105 | screen = terminal; | |
6985c572 KL |
106 | } |
107 | ||
108 | /** | |
109 | * Public constructor. | |
110 | * | |
111 | * @param listener the object this backend needs to wake up when new | |
112 | * input comes in | |
113 | * @param input the InputStream underlying 'reader'. Its available() | |
114 | * method is used to determine if reader.read() will block or not. | |
115 | * @param reader a Reader connected to the remote user. | |
116 | * @param writer a PrintWriter connected to the remote user. | |
117 | * @throws IllegalArgumentException if input, reader, or writer are null. | |
118 | */ | |
119 | public ECMA48Backend(final Object listener, final InputStream input, | |
120 | final Reader reader, final PrintWriter writer) { | |
121 | ||
122 | this(listener, input, reader, writer, false); | |
123 | } | |
124 | ||
05dbb28d KL |
125 | /** |
126 | * Sync the logical screen to the physical device. | |
127 | */ | |
128 | @Override | |
2b9c27db | 129 | public void flushScreen() { |
7b5261bc | 130 | screen.flushPhysical(); |
05dbb28d KL |
131 | } |
132 | ||
133 | /** | |
134 | * Get keyboard, mouse, and screen resize events. | |
135 | * | |
623a1bd1 | 136 | * @param queue list to append new events to |
05dbb28d KL |
137 | */ |
138 | @Override | |
92554d64 KL |
139 | public void getEvents(final List<TInputEvent> queue) { |
140 | if (terminal.hasEvents()) { | |
7b5261bc KL |
141 | terminal.getEvents(queue); |
142 | } | |
05dbb28d KL |
143 | } |
144 | ||
145 | /** | |
7b5261bc | 146 | * Close the I/O, restore the console, etc. |
05dbb28d KL |
147 | */ |
148 | @Override | |
2b9c27db | 149 | public void shutdown() { |
42873e30 | 150 | terminal.closeTerminal(); |
05dbb28d KL |
151 | } |
152 | ||
55d2b2c2 KL |
153 | /** |
154 | * Set the window title. | |
155 | * | |
156 | * @param title the new title | |
157 | */ | |
158 | @Override | |
159 | public void setTitle(final String title) { | |
42873e30 | 160 | screen.setTitle(title); |
55d2b2c2 KL |
161 | } |
162 | ||
05dbb28d | 163 | } |