Fix drawing glitch
[fanfix.git] / src / jexer / backend / GenericBackend.java
CommitLineData
daa4106c 1/*
df8de03f
KL
2 * Jexer - Java Text User Interface
3 *
e16dda65 4 * The MIT License (MIT)
df8de03f 5 *
a69ed767 6 * Copyright (C) 2019 Kevin Lamonte
df8de03f 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:
df8de03f 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.
df8de03f 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
df8de03f 28 */
42873e30 29package jexer.backend;
df8de03f 30
42873e30 31import java.util.List;
df8de03f 32
42873e30 33import jexer.event.TInputEvent;
abb84744
KL
34import jexer.event.TCommandEvent;
35import static jexer.TCommand.*;
df8de03f 36
42873e30
KL
37/**
38 * This abstract class provides a screen, keyboard, and mouse to
39 * TApplication. It also exposes session information as gleaned from lower
40 * levels of the communication stack.
41 */
42public abstract class GenericBackend implements Backend {
df8de03f 43
d36057df
KL
44 // ------------------------------------------------------------------------
45 // Variables --------------------------------------------------------------
46 // ------------------------------------------------------------------------
47
df8de03f 48 /**
42873e30 49 * The session information.
df8de03f 50 */
42873e30 51 protected SessionInfo sessionInfo;
df8de03f 52
d36057df
KL
53 /**
54 * The screen to draw on.
55 */
56 protected Screen screen;
57
58 /**
59 * Input events are processed by this Terminal.
60 */
61 protected TerminalReader terminal;
62
63bb9478
KL
63 /**
64 * By default, GenericBackend adds a cmAbort after it sees
65 * cmBackendDisconnect, so that TApplication will exit when the user
66 * closes the Swing window or disconnects the ECMA48 streams. But
67 * MultiBackend wraps multiple Backends, and needs to decide when to send
68 * cmAbort differently. Setting this to false is how it manages that.
69 * Note package private access.
70 */
71 boolean abortOnDisconnect = true;
72
d36057df
KL
73 // ------------------------------------------------------------------------
74 // Constructors -----------------------------------------------------------
75 // ------------------------------------------------------------------------
76
77 // ------------------------------------------------------------------------
78 // Backend ----------------------------------------------------------------
79 // ------------------------------------------------------------------------
80
df8de03f 81 /**
42873e30 82 * Getter for sessionInfo.
df8de03f 83 *
42873e30 84 * @return the SessionInfo
df8de03f 85 */
42873e30
KL
86 public final SessionInfo getSessionInfo() {
87 return sessionInfo;
df8de03f
KL
88 }
89
df8de03f 90 /**
42873e30 91 * Getter for screen.
df8de03f 92 *
42873e30 93 * @return the Screen
df8de03f 94 */
42873e30
KL
95 public final Screen getScreen() {
96 return screen;
df8de03f
KL
97 }
98
99 /**
88a99379 100 * Sync the logical screen to the physical device.
df8de03f 101 */
88a99379
KL
102 public void flushScreen() {
103 screen.flushPhysical();
104 }
105
106 /**
d36057df
KL
107 * Check if there are events in the queue.
108 *
109 * @return if true, getEvents() has something to return to the application
88a99379 110 */
d36057df
KL
111 public boolean hasEvents() {
112 return terminal.hasEvents();
113 }
df8de03f
KL
114
115 /**
88a99379 116 * Get keyboard, mouse, and screen resize events.
c8496dac 117 *
42873e30 118 * @param queue list to append new events to
df8de03f 119 */
88a99379
KL
120 public void getEvents(final List<TInputEvent> queue) {
121 if (terminal.hasEvents()) {
122 terminal.getEvents(queue);
abb84744
KL
123
124 // This default backend assumes a single user, and if that user
125 // becomes disconnected we should terminate the application.
63bb9478 126 if ((queue.size() > 0) && (abortOnDisconnect == true)) {
abb84744
KL
127 TInputEvent event = queue.get(queue.size() - 1);
128 if (event instanceof TCommandEvent) {
129 TCommandEvent command = (TCommandEvent) event;
130 if (command.equals(cmBackendDisconnect)) {
131 queue.add(new TCommandEvent(cmAbort));
132 }
133 }
134 }
88a99379
KL
135 }
136 }
df8de03f
KL
137
138 /**
88a99379 139 * Close the I/O, restore the console, etc.
df8de03f 140 */
88a99379
KL
141 public void shutdown() {
142 terminal.closeTerminal();
143 }
c8496dac
KL
144
145 /**
88a99379 146 * Set the window title.
42873e30
KL
147 *
148 * @param title the new title
c8496dac 149 */
88a99379
KL
150 public void setTitle(final String title) {
151 screen.setTitle(title);
152 }
153
154 /**
155 * Set listener to a different Object.
156 *
157 * @param listener the new listening object that run() wakes up on new
158 * input
159 */
160 public void setListener(final Object listener) {
161 terminal.setListener(listener);
162 }
c8496dac 163
e23ea538
KL
164 /**
165 * Reload backend options from System properties.
166 */
167 public void reloadOptions() {
168 terminal.reloadOptions();
169 }
170
df8de03f 171}