src/jexer/backend/ECMA48Backend.java

   1 /*
   2  * Jexer - Java Text User Interface
   3  *
   4  * The MIT License (MIT)
   5  *
   6  * Copyright (C) 2017 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.PrintWriter;
  34 import java.io.Reader;
  35 import java.io.UnsupportedEncodingException;
  36
  37 /**
  38  * This class uses an xterm/ANSI X3.64/ECMA-48 type terminal to provide a
  39  * screen, keyboard, and mouse to TApplication.
  40  */
  41 public final class ECMA48Backend extends GenericBackend {
  42
  43     /**
  44      * Public constructor.
  45      *
  46      * @param listener the object this backend needs to wake up when new
  47      * input comes in
  48      * @param input an InputStream connected to the remote user, or null for
  49      * System.in.  If System.in is used, then on non-Windows systems it will
  50      * be put in raw mode; shutdown() will (blindly!) put System.in in cooked
  51      * mode.  input is always converted to a Reader with UTF-8 encoding.
  52      * @param output an OutputStream connected to the remote user, or null
  53      * for System.out.  output is always converted to a Writer with UTF-8
  54      * encoding.
  55      * @throws UnsupportedEncodingException if an exception is thrown when
  56      * creating the InputStreamReader
  57      */
  58     public ECMA48Backend(final Object listener, final InputStream input,
  59         final OutputStream output) throws UnsupportedEncodingException {
  60
  61         // Create a terminal and explicitly set stdin into raw mode
  62         terminal = new ECMA48Terminal(listener, input, output);
  63
  64         // Keep the terminal's sessionInfo so that TApplication can see it
  65         sessionInfo = ((ECMA48Terminal) terminal).getSessionInfo();
  66
  67         // ECMA48Terminal is the screen too
  68         screen = (ECMA48Terminal) terminal;
  69     }
  70
  71     /**
  72      * Public constructor.
  73      *
  74      * @param listener the object this backend needs to wake up when new
  75      * input comes in
  76      * @param input the InputStream underlying 'reader'.  Its available()
  77      * method is used to determine if reader.read() will block or not.
  78      * @param reader a Reader connected to the remote user.
  79      * @param writer a PrintWriter connected to the remote user.
  80      * @param setRawMode if true, set System.in into raw mode with stty.
  81      * This should in general not be used.  It is here solely for Demo3,
  82      * which uses System.in.
  83      * @throws IllegalArgumentException if input, reader, or writer are null.
  84      */
  85     public ECMA48Backend(final Object listener, final InputStream input,
  86         final Reader reader, final PrintWriter writer,
  87         final boolean setRawMode) {
  88
  89         // Create a terminal and explicitly set stdin into raw mode
  90         terminal = new ECMA48Terminal(listener, input, reader, writer,
  91             setRawMode);
  92
  93         // Keep the terminal's sessionInfo so that TApplication can see it
  94         sessionInfo = ((ECMA48Terminal) terminal).getSessionInfo();
  95
  96         // ECMA48Terminal is the screen too
  97         screen = (ECMA48Terminal) terminal;
  98     }
  99
 100     /**
 101      * Public constructor.
 102      *
 103      * @param listener the object this backend needs to wake up when new
 104      * input comes in
 105      * @param input the InputStream underlying 'reader'.  Its available()
 106      * method is used to determine if reader.read() will block or not.
 107      * @param reader a Reader connected to the remote user.
 108      * @param writer a PrintWriter connected to the remote user.
 109      * @throws IllegalArgumentException if input, reader, or writer are null.
 110      */
 111     public ECMA48Backend(final Object listener, final InputStream input,
 112         final Reader reader, final PrintWriter writer) {
 113
 114         this(listener, input, reader, writer, false);
 115     }
 116
 117
 118 }