src/jexer/backend/ECMA48Backend.java

   1 /*
   2  * Jexer - Java Text User Interface
   3  *
   4  * The MIT License (MIT)
   5  *
   6  * Copyright (C) 2016 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.UnsupportedEncodingException;
  34 import java.util.List;
  35
  36 import jexer.event.TInputEvent;
  37 import jexer.io.ECMA48Screen;
  38 import 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  */
  44 public final class ECMA48Backend extends Backend {
  45
  46     /**
  47      * Input events are processed by this Terminal.
  48      */
  49     private ECMA48Terminal terminal;
  50
  51     /**
  52      * Public constructor.
  53      *
  54      * @param listener the object this backend needs to wake up when new
  55      * input comes in
  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.
  63      * @throws UnsupportedEncodingException if an exception is thrown when
  64      * creating the InputStreamReader
  65      */
  66     public ECMA48Backend(final Object listener, final InputStream input,
  67         final OutputStream output) throws UnsupportedEncodingException {
  68
  69         // Create a terminal and explicitly set stdin into raw mode
  70         terminal = new ECMA48Terminal(listener, input, output);
  71
  72         // Keep the terminal's sessionInfo so that TApplication can see it
  73         sessionInfo = terminal.getSessionInfo();
  74
  75         // Create a screen
  76         screen = new ECMA48Screen(terminal);
  77
  78         // Clear the screen
  79         terminal.getOutput().write(terminal.clearAll());
  80         terminal.flush();
  81     }
  82
  83     /**
  84      * Sync the logical screen to the physical device.
  85      */
  86     @Override
  87     public void flushScreen() {
  88         screen.flushPhysical();
  89     }
  90
  91     /**
  92      * Get keyboard, mouse, and screen resize events.
  93      *
  94      * @param queue list to append new events to
  95      */
  96     @Override
  97     public void getEvents(final List<TInputEvent> queue) {
  98         if (terminal.hasEvents()) {
  99             terminal.getEvents(queue);
 100         }
 101     }
 102
 103     /**
 104      * Close the I/O, restore the console, etc.
 105      */
 106     @Override
 107     public void shutdown() {
 108         terminal.shutdown();
 109     }
 110
 111 }