3e588f992c209c7f6a0e45a2202cfccbf1dd9a22
[fanfix.git] / ECMA48Backend.java
1 /*
2 * Jexer - Java Text User Interface
3 *
4 * The MIT License (MIT)
5 *
6 * Copyright (C) 2017 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.backend;
30
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
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 */
41 public final class ECMA48Backend extends GenericBackend {
42
43 /**
44 * Public constructor will use System.in and System.out and UTF-8
45 * encoding. On non-Windows systems System.in will be put in raw mode;
46 * shutdown() will (blindly!) put System.in in cooked mode.
47 *
48 * @throws UnsupportedEncodingException if an exception is thrown when
49 * creating the InputStreamReader
50 */
51 public ECMA48Backend() throws UnsupportedEncodingException {
52 this(null, null, null);
53 }
54
55 /**
56 * Public constructor.
57 *
58 * @param listener the object this backend needs to wake up when new
59 * input comes in
60 * @param input an InputStream connected to the remote user, or null for
61 * System.in. If System.in is used, then on non-Windows systems it will
62 * be put in raw mode; shutdown() will (blindly!) put System.in in cooked
63 * mode. input is always converted to a Reader with UTF-8 encoding.
64 * @param output an OutputStream connected to the remote user, or null
65 * for System.out. output is always converted to a Writer with UTF-8
66 * encoding.
67 * @throws UnsupportedEncodingException if an exception is thrown when
68 * creating the InputStreamReader
69 */
70 public ECMA48Backend(final Object listener, final InputStream input,
71 final OutputStream output) throws UnsupportedEncodingException {
72
73 // Create a terminal and explicitly set stdin into raw mode
74 terminal = new ECMA48Terminal(listener, input, output);
75
76 // Keep the terminal's sessionInfo so that TApplication can see it
77 sessionInfo = ((ECMA48Terminal) terminal).getSessionInfo();
78
79 // ECMA48Terminal is the screen too
80 screen = (ECMA48Terminal) terminal;
81 }
82
83 /**
84 * Public constructor.
85 *
86 * @param listener the object this backend needs to wake up when new
87 * input comes in
88 * @param input the InputStream underlying 'reader'. Its available()
89 * method is used to determine if reader.read() will block or not.
90 * @param reader a Reader connected to the remote user.
91 * @param writer a PrintWriter connected to the remote user.
92 * @param setRawMode if true, set System.in into raw mode with stty.
93 * This should in general not be used. It is here solely for Demo3,
94 * which uses System.in.
95 * @throws IllegalArgumentException if input, reader, or writer are null.
96 */
97 public ECMA48Backend(final Object listener, final InputStream input,
98 final Reader reader, final PrintWriter writer,
99 final boolean setRawMode) {
100
101 // Create a terminal and explicitly set stdin into raw mode
102 terminal = new ECMA48Terminal(listener, input, reader, writer,
103 setRawMode);
104
105 // Keep the terminal's sessionInfo so that TApplication can see it
106 sessionInfo = ((ECMA48Terminal) terminal).getSessionInfo();
107
108 // ECMA48Terminal is the screen too
109 screen = (ECMA48Terminal) terminal;
110 }
111
112 /**
113 * Public constructor.
114 *
115 * @param listener the object this backend needs to wake up when new
116 * input comes in
117 * @param input the InputStream underlying 'reader'. Its available()
118 * method is used to determine if reader.read() will block or not.
119 * @param reader a Reader connected to the remote user.
120 * @param writer a PrintWriter connected to the remote user.
121 * @throws IllegalArgumentException if input, reader, or writer are null.
122 */
123 public ECMA48Backend(final Object listener, final InputStream input,
124 final Reader reader, final PrintWriter writer) {
125
126 this(listener, input, reader, writer, false);
127 }
128
129
130 }