2 * Jexer - Java Text User Interface
4 * The MIT License (MIT)
6 * Copyright (C) 2017 Kevin Lamonte
8 * Permission is hereby granted, free of charge, to any person obtaining a
9 * copy of this software and associated documentation files (the "Software"),
10 * to deal in the Software without restriction, including without limitation
11 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
12 * and/or sell copies of the Software, and to permit persons to whom the
13 * Software is furnished to do so, subject to the following conditions:
15 * The above copyright notice and this permission notice shall be included in
16 * all copies or substantial portions of the Software.
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
21 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
23 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
24 * DEALINGS IN THE SOFTWARE.
26 * @author Kevin Lamonte [kevin.lamonte@gmail.com]
29 package jexer
.backend
;
31 import java
.io
.InputStream
;
32 import java
.io
.OutputStream
;
33 import java
.io
.PrintWriter
;
34 import java
.io
.Reader
;
35 import java
.io
.UnsupportedEncodingException
;
36 import java
.util
.List
;
38 import jexer
.event
.TInputEvent
;
39 import jexer
.io
.ECMA48Screen
;
40 import jexer
.io
.ECMA48Terminal
;
43 * This class uses an xterm/ANSI X3.64/ECMA-48 type terminal to provide a
44 * screen, keyboard, and mouse to TApplication.
46 public final class ECMA48Backend
extends Backend
{
49 * Input events are processed by this Terminal.
51 private ECMA48Terminal terminal
;
56 * @param listener the object this backend needs to wake up when new
58 * @param input an InputStream connected to the remote user, or null for
59 * System.in. If System.in is used, then on non-Windows systems it will
60 * be put in raw mode; shutdown() will (blindly!) put System.in in cooked
61 * mode. input is always converted to a Reader with UTF-8 encoding.
62 * @param output an OutputStream connected to the remote user, or null
63 * for System.out. output is always converted to a Writer with UTF-8
65 * @throws UnsupportedEncodingException if an exception is thrown when
66 * creating the InputStreamReader
68 public ECMA48Backend(final Object listener
, final InputStream input
,
69 final OutputStream output
) throws UnsupportedEncodingException
{
71 // Create a terminal and explicitly set stdin into raw mode
72 terminal
= new ECMA48Terminal(listener
, input
, output
);
74 // Keep the terminal's sessionInfo so that TApplication can see it
75 sessionInfo
= terminal
.getSessionInfo();
78 screen
= new ECMA48Screen(terminal
);
81 terminal
.getOutput().write(terminal
.clearAll());
88 * @param listener the object this backend needs to wake up when new
90 * @param input the InputStream underlying 'reader'. Its available()
91 * method is used to determine if reader.read() will block or not.
92 * @param reader a Reader connected to the remote user.
93 * @param writer a PrintWriter connected to the remote user.
94 * @param setRawMode if true, set System.in into raw mode with stty.
95 * This should in general not be used. It is here solely for Demo3,
96 * which uses System.in.
97 * @throws IllegalArgumentException if input, reader, or writer are null.
99 public ECMA48Backend(final Object listener
, final InputStream input
,
100 final Reader reader
, final PrintWriter writer
,
101 final boolean setRawMode
) {
103 // Create a terminal and explicitly set stdin into raw mode
104 terminal
= new ECMA48Terminal(listener
, input
, reader
, writer
,
107 // Keep the terminal's sessionInfo so that TApplication can see it
108 sessionInfo
= terminal
.getSessionInfo();
111 screen
= new ECMA48Screen(terminal
);
114 terminal
.getOutput().write(terminal
.clearAll());
119 * Public constructor.
121 * @param listener the object this backend needs to wake up when new
123 * @param input the InputStream underlying 'reader'. Its available()
124 * method is used to determine if reader.read() will block or not.
125 * @param reader a Reader connected to the remote user.
126 * @param writer a PrintWriter connected to the remote user.
127 * @throws IllegalArgumentException if input, reader, or writer are null.
129 public ECMA48Backend(final Object listener
, final InputStream input
,
130 final Reader reader
, final PrintWriter writer
) {
132 this(listener
, input
, reader
, writer
, false);
136 * Sync the logical screen to the physical device.
139 public void flushScreen() {
140 screen
.flushPhysical();
144 * Get keyboard, mouse, and screen resize events.
146 * @param queue list to append new events to
149 public void getEvents(final List
<TInputEvent
> queue
) {
150 if (terminal
.hasEvents()) {
151 terminal
.getEvents(queue
);
156 * Close the I/O, restore the console, etc.
159 public void shutdown() {
164 * Set the window title.
166 * @param title the new title
169 public void setTitle(final String title
) {
170 ((ECMA48Screen
) screen
).setTitle(title
);