Merge commit '77d3a60869e7a780c6ae069e51530e1eacece5e2'
[nikiroo-utils.git] / src / jexer / backend / ECMA48Backend.java
CommitLineData
daa4106c 1/*
05dbb28d
KL
2 * Jexer - Java Text User Interface
3 *
e16dda65 4 * The MIT License (MIT)
05dbb28d 5 *
a69ed767 6 * Copyright (C) 2019 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 */
29package jexer.backend;
30
31import java.io.InputStream;
32import java.io.OutputStream;
6985c572
KL
33import java.io.PrintWriter;
34import java.io.Reader;
05dbb28d 35import java.io.UnsupportedEncodingException;
05dbb28d
KL
36
37/**
38 * This class uses an xterm/ANSI X3.64/ECMA-48 type terminal to provide a
39 * screen, keyboard, and mouse to TApplication.
40 */
051e2913 41public class ECMA48Backend extends GenericBackend {
05dbb28d 42
d36057df
KL
43 // ------------------------------------------------------------------------
44 // Constructors -----------------------------------------------------------
45 // ------------------------------------------------------------------------
46
3e074355
KL
47 /**
48 * Public constructor will use System.in and System.out and UTF-8
49 * encoding. On non-Windows systems System.in will be put in raw mode;
50 * shutdown() will (blindly!) put System.in in cooked mode.
51 *
52 * @throws UnsupportedEncodingException if an exception is thrown when
53 * creating the InputStreamReader
54 */
55 public ECMA48Backend() throws UnsupportedEncodingException {
56 this(null, null, null);
57 }
58
05dbb28d
KL
59 /**
60 * Public constructor.
61 *
92554d64 62 * @param listener the object this backend needs to wake up when new
eb29bbb5
KL
63 * input comes in
64 * @param input an InputStream connected to the remote user, or null for
65 * System.in. If System.in is used, then on non-Windows systems it will
66 * be put in raw mode; shutdown() will (blindly!) put System.in in cooked
67 * mode. input is always converted to a Reader with UTF-8 encoding.
68 * @param output an OutputStream connected to the remote user, or null
69 * for System.out. output is always converted to a Writer with UTF-8
70 * encoding.
71 * @param windowWidth the number of text columns to start with
72 * @param windowHeight the number of text rows to start with
73 * @param fontSize the size in points. ECMA48 cannot set it, but it is
74 * here to match the Swing API.
75 * @throws UnsupportedEncodingException if an exception is thrown when
76 * creating the InputStreamReader
77 */
78 public ECMA48Backend(final Object listener, final InputStream input,
79 final OutputStream output, final int windowWidth,
80 final int windowHeight, final int fontSize)
81 throws UnsupportedEncodingException {
82
83 // Create a terminal and explicitly set stdin into raw mode
84 terminal = new ECMA48Terminal(listener, input, output, windowWidth,
85 windowHeight);
86
87 // Keep the terminal's sessionInfo so that TApplication can see it
88 sessionInfo = ((ECMA48Terminal) terminal).getSessionInfo();
89
90 // ECMA48Terminal is the screen too
91 screen = (ECMA48Terminal) terminal;
92 }
93
94 /**
95 * Public constructor.
96 *
97 * @param listener the object this backend needs to wake up when new
92554d64 98 * input comes in
05dbb28d
KL
99 * @param input an InputStream connected to the remote user, or null for
100 * System.in. If System.in is used, then on non-Windows systems it will
101 * be put in raw mode; shutdown() will (blindly!) put System.in in cooked
102 * mode. input is always converted to a Reader with UTF-8 encoding.
103 * @param output an OutputStream connected to the remote user, or null
104 * for System.out. output is always converted to a Writer with UTF-8
105 * encoding.
7b5261bc
KL
106 * @throws UnsupportedEncodingException if an exception is thrown when
107 * creating the InputStreamReader
05dbb28d 108 */
92554d64 109 public ECMA48Backend(final Object listener, final InputStream input,
7b5261bc
KL
110 final OutputStream output) throws UnsupportedEncodingException {
111
112 // Create a terminal and explicitly set stdin into raw mode
92554d64 113 terminal = new ECMA48Terminal(listener, input, output);
05dbb28d 114
7b5261bc 115 // Keep the terminal's sessionInfo so that TApplication can see it
88a99379 116 sessionInfo = ((ECMA48Terminal) terminal).getSessionInfo();
05dbb28d 117
42873e30 118 // ECMA48Terminal is the screen too
88a99379 119 screen = (ECMA48Terminal) terminal;
05dbb28d
KL
120 }
121
6985c572
KL
122 /**
123 * Public constructor.
124 *
125 * @param listener the object this backend needs to wake up when new
126 * input comes in
127 * @param input the InputStream underlying 'reader'. Its available()
128 * method is used to determine if reader.read() will block or not.
129 * @param reader a Reader connected to the remote user.
130 * @param writer a PrintWriter connected to the remote user.
131 * @param setRawMode if true, set System.in into raw mode with stty.
132 * This should in general not be used. It is here solely for Demo3,
133 * which uses System.in.
134 * @throws IllegalArgumentException if input, reader, or writer are null.
135 */
136 public ECMA48Backend(final Object listener, final InputStream input,
137 final Reader reader, final PrintWriter writer,
138 final boolean setRawMode) {
139
140 // Create a terminal and explicitly set stdin into raw mode
141 terminal = new ECMA48Terminal(listener, input, reader, writer,
142 setRawMode);
143
144 // Keep the terminal's sessionInfo so that TApplication can see it
88a99379 145 sessionInfo = ((ECMA48Terminal) terminal).getSessionInfo();
6985c572 146
42873e30 147 // ECMA48Terminal is the screen too
88a99379 148 screen = (ECMA48Terminal) terminal;
6985c572
KL
149 }
150
151 /**
152 * Public constructor.
153 *
154 * @param listener the object this backend needs to wake up when new
155 * input comes in
156 * @param input the InputStream underlying 'reader'. Its available()
157 * method is used to determine if reader.read() will block or not.
158 * @param reader a Reader connected to the remote user.
159 * @param writer a PrintWriter connected to the remote user.
160 * @throws IllegalArgumentException if input, reader, or writer are null.
161 */
162 public ECMA48Backend(final Object listener, final InputStream input,
163 final Reader reader, final PrintWriter writer) {
164
165 this(listener, input, reader, writer, false);
166 }
167
05dbb28d 168}