*
* The MIT License (MIT)
*
- * Copyright (C) 2017 Kevin Lamonte
+ * Copyright (C) 2019 Kevin Lamonte
*
* Permission is hereby granted, free of charge, to any person obtaining a
* copy of this software and associated documentation files (the "Software"),
import java.util.List;
import jexer.event.TInputEvent;
+import jexer.event.TCommandEvent;
+import static jexer.TCommand.*;
/**
* This abstract class provides a screen, keyboard, and mouse to
*/
public abstract class GenericBackend implements Backend {
+ // ------------------------------------------------------------------------
+ // Variables --------------------------------------------------------------
+ // ------------------------------------------------------------------------
+
/**
* The session information.
*/
protected SessionInfo sessionInfo;
+ /**
+ * The screen to draw on.
+ */
+ protected Screen screen;
+
+ /**
+ * Input events are processed by this Terminal.
+ */
+ protected TerminalReader terminal;
+
+ /**
+ * By default, GenericBackend adds a cmAbort after it sees
+ * cmBackendDisconnect, so that TApplication will exit when the user
+ * closes the Swing window or disconnects the ECMA48 streams. But
+ * MultiBackend wraps multiple Backends, and needs to decide when to send
+ * cmAbort differently. Setting this to false is how it manages that.
+ * Note package private access.
+ */
+ boolean abortOnDisconnect = true;
+
+ // ------------------------------------------------------------------------
+ // Constructors -----------------------------------------------------------
+ // ------------------------------------------------------------------------
+
+ // ------------------------------------------------------------------------
+ // Backend ----------------------------------------------------------------
+ // ------------------------------------------------------------------------
+
/**
* Getter for sessionInfo.
*
return sessionInfo;
}
- /**
- * The screen to draw on.
- */
- protected Screen screen;
-
/**
* Getter for screen.
*
}
/**
- * Subclasses must provide an implementation that syncs the logical
- * screen to the physical device.
+ * Sync the logical screen to the physical device.
*/
- public abstract void flushScreen();
+ public void flushScreen() {
+ screen.flushPhysical();
+ }
+
+ /**
+ * Check if there are events in the queue.
+ *
+ * @return if true, getEvents() has something to return to the application
+ */
+ public boolean hasEvents() {
+ return terminal.hasEvents();
+ }
/**
- * Subclasses must provide an implementation to get keyboard, mouse, and
- * screen resize events.
+ * Get keyboard, mouse, and screen resize events.
*
* @param queue list to append new events to
*/
- public abstract void getEvents(List<TInputEvent> queue);
+ public void getEvents(final List<TInputEvent> queue) {
+ if (terminal.hasEvents()) {
+ terminal.getEvents(queue);
+
+ // This default backend assumes a single user, and if that user
+ // becomes disconnected we should terminate the application.
+ if ((queue.size() > 0) && (abortOnDisconnect == true)) {
+ TInputEvent event = queue.get(queue.size() - 1);
+ if (event instanceof TCommandEvent) {
+ TCommandEvent command = (TCommandEvent) event;
+ if (command.equals(cmBackendDisconnect)) {
+ queue.add(new TCommandEvent(cmAbort));
+ }
+ }
+ }
+ }
+ }
/**
- * Subclasses must provide an implementation that closes sockets,
- * restores console, etc.
+ * Close the I/O, restore the console, etc.
*/
- public abstract void shutdown();
+ public void shutdown() {
+ terminal.closeTerminal();
+ }
/**
- * Subclasses must provide an implementation that sets the window title.
+ * Set the window title.
*
* @param title the new title
*/
- public abstract void setTitle(final String title);
+ public void setTitle(final String title) {
+ screen.setTitle(title);
+ }
+
+ /**
+ * Set listener to a different Object.
+ *
+ * @param listener the new listening object that run() wakes up on new
+ * input
+ */
+ public void setListener(final Object listener) {
+ terminal.setListener(listener);
+ }
+
+ /**
+ * Reload backend options from System properties.
+ */
+ public void reloadOptions() {
+ terminal.reloadOptions();
+ }
}