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 will use System.in and System.out and UTF-8
  45      * encoding. On non-Windows systems System.in will be put in raw mode;
  46      * shutdown() will (blindly!) put System.in in cooked mode.
  47      *
  48      * @throws UnsupportedEncodingException if an exception is thrown when
  49      * creating the InputStreamReader
  50      */
  51     public ECMA48Backend() throws UnsupportedEncodingException {
  52         this(null, null, null);
  53     }
  54
  55     /**
  56      * Public constructor.
  57      *
  58      * @param listener the object this backend needs to wake up when new
  59      * input comes in
  60      * @param input an InputStream connected to the remote user, or null for
  61      * System.in.  If System.in is used, then on non-Windows systems it will
  62      * be put in raw mode; shutdown() will (blindly!) put System.in in cooked
  63      * mode.  input is always converted to a Reader with UTF-8 encoding.
  64      * @param output an OutputStream connected to the remote user, or null
  65      * for System.out.  output is always converted to a Writer with UTF-8
  66      * encoding.
  67      * @param windowWidth the number of text columns to start with
  68      * @param windowHeight the number of text rows to start with
  69      * @param fontSize the size in points.  ECMA48 cannot set it, but it is
  70      * here to match the Swing API.
  71      * @throws UnsupportedEncodingException if an exception is thrown when
  72      * creating the InputStreamReader
  73      */
  74     public ECMA48Backend(final Object listener, final InputStream input,
  75         final OutputStream output, final int windowWidth,
  76         final int windowHeight, final int fontSize)
  77         throws UnsupportedEncodingException {
  78
  79         // Create a terminal and explicitly set stdin into raw mode
  80         terminal = new ECMA48Terminal(listener, input, output, windowWidth,
  81             windowHeight);
  82
  83         // Keep the terminal's sessionInfo so that TApplication can see it
  84         sessionInfo = ((ECMA48Terminal) terminal).getSessionInfo();
  85
  86         // ECMA48Terminal is the screen too
  87         screen = (ECMA48Terminal) terminal;
  88     }
  89
  90     /**
  91      * Public constructor.
  92      *
  93      * @param listener the object this backend needs to wake up when new
  94      * input comes in
  95      * @param input an InputStream connected to the remote user, or null for
  96      * System.in.  If System.in is used, then on non-Windows systems it will
  97      * be put in raw mode; shutdown() will (blindly!) put System.in in cooked
  98      * mode.  input is always converted to a Reader with UTF-8 encoding.
  99      * @param output an OutputStream connected to the remote user, or null
 100      * for System.out.  output is always converted to a Writer with UTF-8
 101      * encoding.
 102      * @throws UnsupportedEncodingException if an exception is thrown when
 103      * creating the InputStreamReader
 104      */
 105     public ECMA48Backend(final Object listener, final InputStream input,
 106         final OutputStream output) throws UnsupportedEncodingException {
 107
 108         // Create a terminal and explicitly set stdin into raw mode
 109         terminal = new ECMA48Terminal(listener, input, output);
 110
 111         // Keep the terminal's sessionInfo so that TApplication can see it
 112         sessionInfo = ((ECMA48Terminal) terminal).getSessionInfo();
 113
 114         // ECMA48Terminal is the screen too
 115         screen = (ECMA48Terminal) terminal;
 116     }
 117
 118     /**
 119      * Public constructor.
 120      *
 121      * @param listener the object this backend needs to wake up when new
 122      * input comes in
 123      * @param input the InputStream underlying 'reader'.  Its available()
 124      * method is used to determine if reader.read() will block or not.
 125      * @param reader a Reader connected to the remote user.
 126      * @param writer a PrintWriter connected to the remote user.
 127      * @param setRawMode if true, set System.in into raw mode with stty.
 128      * This should in general not be used.  It is here solely for Demo3,
 129      * which uses System.in.
 130      * @throws IllegalArgumentException if input, reader, or writer are null.
 131      */
 132     public ECMA48Backend(final Object listener, final InputStream input,
 133         final Reader reader, final PrintWriter writer,
 134         final boolean setRawMode) {
 135
 136         // Create a terminal and explicitly set stdin into raw mode
 137         terminal = new ECMA48Terminal(listener, input, reader, writer,
 138             setRawMode);
 139
 140         // Keep the terminal's sessionInfo so that TApplication can see it
 141         sessionInfo = ((ECMA48Terminal) terminal).getSessionInfo();
 142
 143         // ECMA48Terminal is the screen too
 144         screen = (ECMA48Terminal) terminal;
 145     }
 146
 147     /**
 148      * Public constructor.
 149      *
 150      * @param listener the object this backend needs to wake up when new
 151      * input comes in
 152      * @param input the InputStream underlying 'reader'.  Its available()
 153      * method is used to determine if reader.read() will block or not.
 154      * @param reader a Reader connected to the remote user.
 155      * @param writer a PrintWriter connected to the remote user.
 156      * @throws IllegalArgumentException if input, reader, or writer are null.
 157      */
 158     public ECMA48Backend(final Object listener, final InputStream input,
 159         final Reader reader, final PrintWriter writer) {
 160
 161         this(listener, input, reader, writer, false);
 162     }
 163
 164
 165 }