Add 'src/jexer/' from commit 'cf01c92f5809a0732409e280fb0f32f27393618d'
[fanfix.git] / src / jexer / backend / ECMA48Backend.java
index f1508335a02dbf9f7afc104dac8fa13f9fe5c323..0614e17d9ccc6bb5ba690da0bbd30d39ec3f5851 100644 (file)
@@ -1,60 +1,66 @@
-/**
+/*
  * Jexer - Java Text User Interface
  *
- * Version: $Id$
- *
- * Author: Kevin Lamonte, <a href="mailto:kevin.lamonte@gmail.com">kevin.lamonte@gmail.com</a>
+ * The MIT License (MIT)
  *
- * License: LGPLv3 or later
+ * Copyright (C) 2019 Kevin Lamonte
  *
- * Copyright: This module is licensed under the GNU Lesser General
- * Public License Version 3.  Please see the file "COPYING" in this
- * directory for more information about the GNU Lesser General Public
- * License Version 3.
+ * Permission is hereby granted, free of charge, to any person obtaining a
+ * copy of this software and associated documentation files (the "Software"),
+ * to deal in the Software without restriction, including without limitation
+ * the rights to use, copy, modify, merge, publish, distribute, sublicense,
+ * and/or sell copies of the Software, and to permit persons to whom the
+ * Software is furnished to do so, subject to the following conditions:
  *
- *     Copyright (C) 2015  Kevin Lamonte
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
  *
- * This program is free software; you can redistribute it and/or
- * modify it under the terms of the GNU Lesser General Public License
- * as published by the Free Software Foundation; either version 3 of
- * the License, or (at your option) any later version.
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
+ * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+ * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+ * DEALINGS IN THE SOFTWARE.
  *
- * This program is distributed in the hope that it will be useful, but
- * WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
- * General Public License for more details.
- *
- * You should have received a copy of the GNU Lesser General Public
- * License along with this program; if not, see
- * http://www.gnu.org/licenses/, or write to the Free Software
- * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
- * 02110-1301 USA
+ * @author Kevin Lamonte [kevin.lamonte@gmail.com]
+ * @version 1
  */
 package jexer.backend;
 
 import java.io.InputStream;
 import java.io.OutputStream;
+import java.io.PrintWriter;
+import java.io.Reader;
 import java.io.UnsupportedEncodingException;
-import java.util.List;
-
-import jexer.event.TInputEvent;
-import jexer.io.ECMA48Screen;
-import jexer.io.ECMA48Terminal;
 
 /**
  * This class uses an xterm/ANSI X3.64/ECMA-48 type terminal to provide a
  * screen, keyboard, and mouse to TApplication.
  */
-public class ECMA48Backend extends Backend {
+public class ECMA48Backend extends GenericBackend {
+
+    // ------------------------------------------------------------------------
+    // Constructors -----------------------------------------------------------
+    // ------------------------------------------------------------------------
 
     /**
-     * Input events are processed by this Terminal.
+     * Public constructor will use System.in and System.out and UTF-8
+     * encoding. On non-Windows systems System.in will be put in raw mode;
+     * shutdown() will (blindly!) put System.in in cooked mode.
+     *
+     * @throws UnsupportedEncodingException if an exception is thrown when
+     * creating the InputStreamReader
      */
-    private ECMA48Terminal terminal;
+    public ECMA48Backend() throws UnsupportedEncodingException {
+        this(null, null, null);
+    }
 
     /**
      * Public constructor.
      *
+     * @param listener the object this backend needs to wake up when new
+     * input comes in
      * @param input an InputStream connected to the remote user, or null for
      * System.in.  If System.in is used, then on non-Windows systems it will
      * be put in raw mode; shutdown() will (blindly!) put System.in in cooked
@@ -62,73 +68,101 @@ public class ECMA48Backend extends Backend {
      * @param output an OutputStream connected to the remote user, or null
      * for System.out.  output is always converted to a Writer with UTF-8
      * encoding.
+     * @param windowWidth the number of text columns to start with
+     * @param windowHeight the number of text rows to start with
+     * @param fontSize the size in points.  ECMA48 cannot set it, but it is
+     * here to match the Swing API.
+     * @throws UnsupportedEncodingException if an exception is thrown when
+     * creating the InputStreamReader
      */
-    public ECMA48Backend(InputStream input, OutputStream output) throws UnsupportedEncodingException {
+    public ECMA48Backend(final Object listener, final InputStream input,
+        final OutputStream output, final int windowWidth,
+        final int windowHeight, final int fontSize)
+        throws UnsupportedEncodingException {
 
-       // Create a terminal and explicitly set stdin into raw mode
-       terminal = new ECMA48Terminal(input, output);
+        // Create a terminal and explicitly set stdin into raw mode
+        terminal = new ECMA48Terminal(listener, input, output, windowWidth,
+            windowHeight);
 
-       // Create a screen
-       screen = new ECMA48Screen(terminal);
+        // Keep the terminal's sessionInfo so that TApplication can see it
+        sessionInfo = ((ECMA48Terminal) terminal).getSessionInfo();
 
-       // Clear the screen
-       terminal.getOutput().write(terminal.clearAll());
-       terminal.flush();
+        // ECMA48Terminal is the screen too
+        screen = (ECMA48Terminal) terminal;
     }
 
     /**
-     * Sync the logical screen to the physical device.
+     * Public constructor.
+     *
+     * @param listener the object this backend needs to wake up when new
+     * input comes in
+     * @param input an InputStream connected to the remote user, or null for
+     * System.in.  If System.in is used, then on non-Windows systems it will
+     * be put in raw mode; shutdown() will (blindly!) put System.in in cooked
+     * mode.  input is always converted to a Reader with UTF-8 encoding.
+     * @param output an OutputStream connected to the remote user, or null
+     * for System.out.  output is always converted to a Writer with UTF-8
+     * encoding.
+     * @throws UnsupportedEncodingException if an exception is thrown when
+     * creating the InputStreamReader
      */
-    @Override
-    public void flushScreen() {
-       screen.flushPhysical();
+    public ECMA48Backend(final Object listener, final InputStream input,
+        final OutputStream output) throws UnsupportedEncodingException {
+
+        // Create a terminal and explicitly set stdin into raw mode
+        terminal = new ECMA48Terminal(listener, input, output);
+
+        // Keep the terminal's sessionInfo so that TApplication can see it
+        sessionInfo = ((ECMA48Terminal) terminal).getSessionInfo();
+
+        // ECMA48Terminal is the screen too
+        screen = (ECMA48Terminal) terminal;
     }
 
     /**
-     * Get keyboard, mouse, and screen resize events.
+     * Public constructor.
      *
-     * @param queue list to append new events to
-     * @param timeout maximum amount of time (in millis) to wait for an
-     * event.  0 means to return immediately, i.e. perform a poll.
+     * @param listener the object this backend needs to wake up when new
+     * input comes in
+     * @param input the InputStream underlying 'reader'.  Its available()
+     * method is used to determine if reader.read() will block or not.
+     * @param reader a Reader connected to the remote user.
+     * @param writer a PrintWriter connected to the remote user.
+     * @param setRawMode if true, set System.in into raw mode with stty.
+     * This should in general not be used.  It is here solely for Demo3,
+     * which uses System.in.
+     * @throws IllegalArgumentException if input, reader, or writer are null.
      */
-    @Override
-    public void getEvents(List<TInputEvent> queue, int timeout) {
-       if (timeout > 0) {
-           // Try to sleep, let the terminal's input thread wake me up if
-           // something came in.
-           synchronized (terminal) {
-               try {
-                   terminal.wait(timeout);
-                   if (terminal.hasEvents()) {
-                       // System.err.println("getEvents()");
-                       terminal.getIdleEvents(queue);
-                   } else {
-                       // If I got here, then I timed out.  Call
-                       // terminal.getIdleEvents() to pick up stragglers
-                       // like bare resize.
-                       // System.err.println("getIdleEvents()");
-                       terminal.getIdleEvents(queue);
-                   }
-               } catch (InterruptedException e) {
-                   // Spurious interrupt, pretend it was like a timeout.
-                   // System.err.println("[interrupt] getEvents()");
-                   terminal.getIdleEvents(queue);
-               }
-           }
-       } else {
-           // Asking for a poll, go get it.
-           System.err.println("[polled] getEvents()");
-           terminal.getEvents(queue);
-       }
+    public ECMA48Backend(final Object listener, final InputStream input,
+        final Reader reader, final PrintWriter writer,
+        final boolean setRawMode) {
+
+        // Create a terminal and explicitly set stdin into raw mode
+        terminal = new ECMA48Terminal(listener, input, reader, writer,
+            setRawMode);
+
+        // Keep the terminal's sessionInfo so that TApplication can see it
+        sessionInfo = ((ECMA48Terminal) terminal).getSessionInfo();
+
+        // ECMA48Terminal is the screen too
+        screen = (ECMA48Terminal) terminal;
     }
 
     /**
-     * Subclasses must provide an implementation that closes sockets,
-     * restores console, etc.
+     * Public constructor.
+     *
+     * @param listener the object this backend needs to wake up when new
+     * input comes in
+     * @param input the InputStream underlying 'reader'.  Its available()
+     * method is used to determine if reader.read() will block or not.
+     * @param reader a Reader connected to the remote user.
+     * @param writer a PrintWriter connected to the remote user.
+     * @throws IllegalArgumentException if input, reader, or writer are null.
      */
-    @Override
-    public void shutdown() {
-       terminal.shutdown();
+    public ECMA48Backend(final Object listener, final InputStream input,
+        final Reader reader, final PrintWriter writer) {
+
+        this(listener, input, reader, writer, false);
     }
 
 }