Support for Xterm ctrl/alt/shift function keys
[fanfix.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 *
e16dda65 6 * Copyright (C) 2016 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;
33import java.io.UnsupportedEncodingException;
34import java.util.List;
35
36import jexer.event.TInputEvent;
37import jexer.io.ECMA48Screen;
38import jexer.io.ECMA48Terminal;
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 */
2b9c27db 44public final class ECMA48Backend extends Backend {
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
7b5261bc
KL
75 // Create a screen
76 screen = new ECMA48Screen(terminal);
05dbb28d 77
7b5261bc
KL
78 // Clear the screen
79 terminal.getOutput().write(terminal.clearAll());
80 terminal.flush();
05dbb28d
KL
81 }
82
83 /**
84 * Sync the logical screen to the physical device.
85 */
86 @Override
2b9c27db 87 public void flushScreen() {
7b5261bc 88 screen.flushPhysical();
05dbb28d
KL
89 }
90
91 /**
92 * Get keyboard, mouse, and screen resize events.
93 *
623a1bd1 94 * @param queue list to append new events to
05dbb28d
KL
95 */
96 @Override
92554d64
KL
97 public void getEvents(final List<TInputEvent> queue) {
98 if (terminal.hasEvents()) {
7b5261bc
KL
99 terminal.getEvents(queue);
100 }
05dbb28d
KL
101 }
102
103 /**
7b5261bc 104 * Close the I/O, restore the console, etc.
05dbb28d
KL
105 */
106 @Override
2b9c27db 107 public void shutdown() {
7b5261bc 108 terminal.shutdown();
05dbb28d
KL
109 }
110
111}