X-Git-Url: http://git.nikiroo.be/?a=blobdiff_plain;f=src%2Fjexer%2Fnet%2FTelnetOutputStream.java;h=6e7536a847f3bcb5e9a68b2c90f38026f2ed2694;hb=12b90437b5f22c2ae6e9b9b14c3b62b60f6143e5;hp=98727277a8b47e6a5397d3ac3e77e131424edce8;hpb=005ec49709aab8590ee9571f17a67440969c6248;p=fanfix.git diff --git a/src/jexer/net/TelnetOutputStream.java b/src/jexer/net/TelnetOutputStream.java index 9872727..6e7536a 100644 --- a/src/jexer/net/TelnetOutputStream.java +++ b/src/jexer/net/TelnetOutputStream.java @@ -1,29 +1,27 @@ -/** +/* * Jexer - Java Text User Interface * - * License: LGPLv3 or later - * - * 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. + * The MIT License (MIT) * - * Copyright (C) 2015 Kevin Lamonte + * Copyright (C) 2019 Kevin Lamonte * - * 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. + * 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: * - * 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. + * The above copyright notice and this permission notice shall be included in + * all copies or substantial portions of the Software. * - * 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 + * 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. * * @author Kevin Lamonte [kevin.lamonte@gmail.com] * @version 1 @@ -33,10 +31,16 @@ package jexer.net; import java.io.OutputStream; import java.io.IOException; +import static jexer.net.TelnetSocket.*; + /** * TelnetOutputStream works with TelnetSocket to perform the telnet protocol. */ -public final class TelnetOutputStream extends OutputStream { +public class TelnetOutputStream extends OutputStream { + + // ------------------------------------------------------------------------ + // Variables -------------------------------------------------------------- + // ------------------------------------------------------------------------ /** * The root TelnetSocket that has my telnet protocol state. @@ -48,22 +52,35 @@ public final class TelnetOutputStream extends OutputStream { */ private OutputStream output; + /** + * When true, the last byte the caller passed to write() was a CR. + */ + private boolean writeCR = false; + + // ------------------------------------------------------------------------ + // Constructors ----------------------------------------------------------- + // ------------------------------------------------------------------------ + /** * Package private constructor. * * @param master the master TelnetSocket * @param output the underlying socket's OutputStream */ - TelnetOutputStream(TelnetSocket master, OutputStream output) { + TelnetOutputStream(final TelnetSocket master, final OutputStream output) { this.master = master; this.output = output; } - // OutputStream interface ------------------------------------------------- + // ------------------------------------------------------------------------ + // OutputStrem ------------------------------------------------------------ + // ------------------------------------------------------------------------ /** * Closes this output stream and releases any system resources associated * with this stream. + * + * @throws IOException if an I/O error occurs */ @Override public void close() throws IOException { @@ -76,16 +93,18 @@ public final class TelnetOutputStream extends OutputStream { /** * Flushes this output stream and forces any buffered output bytes to be * written out. + * + * @throws IOException if an I/O error occurs */ @Override public void flush() throws IOException { - if ((master.nvt.binaryMode == false) && (master.nvt.writeCR == true)) { + if ((master.binaryMode == false) && (writeCR == true)) { // The last byte sent to this.write() was a CR, which was never // actually sent. So send the CR in ascii mode, then flush. // CR -> CR NULL - output.write(master.C_CR); - output.write(master.C_NUL); - master.nvt.writeCR = false; + output.write(C_CR); + output.write(C_NUL); + writeCR = false; } output.flush(); } @@ -93,42 +112,67 @@ public final class TelnetOutputStream extends OutputStream { /** * Writes b.length bytes from the specified byte array to this output * stream. + * + * @param b the data. + * @throws IOException if an I/O error occurs */ @Override - public void write(byte[] b) throws IOException { + public void write(final byte[] b) throws IOException { writeImpl(b, 0, b.length); } /** * Writes len bytes from the specified byte array starting at offset off * to this output stream. + * + * @param b the data. + * @param off the start offset in the data. + * @param len the number of bytes to write. + * @throws IOException if an I/O error occurs */ @Override - public void write(byte[] b, int off, int len) throws IOException { + public void write(final byte[] b, final int off, + final int len) throws IOException { + writeImpl(b, off, len); } /** * Writes the specified byte to this output stream. + * + * @param b the byte to write. + * @throws IOException if an I/O error occurs */ @Override - public void write(int b) throws IOException { + public void write(final int b) throws IOException { byte [] bytes = new byte[1]; - bytes[0] = (byte)b; + bytes[0] = (byte) b; writeImpl(bytes, 0, 1); } + // ------------------------------------------------------------------------ + // TelnetOutputStrem ------------------------------------------------------ + // ------------------------------------------------------------------------ + /** * Writes b.length bytes from the specified byte array to this output * stream. Note package private access. + * + * @param b the data. + * @throws IOException if an I/O error occurs */ - void rawWrite(byte[] b) throws IOException { + void rawWrite(final byte[] b) throws IOException { output.write(b, 0, b.length); } /** * Writes len bytes from the specified byte array starting at offset off * to this output stream. + * + * @param b the data. + * @param off the start offset in the data. + * @param len the number of bytes to write. + * @throws IOException if an I/O error occurs */ private void writeImpl(final byte[] b, final int off, final int len) throws IOException { @@ -141,19 +185,19 @@ public final class TelnetOutputStream extends OutputStream { // Flush what we have generated so far and reset the buffer, // because the next byte could generate up to 4 output bytes // (CR ). - super.write(writeBuffer, 0, writeBufferI); + output.write(writeBuffer, 0, writeBufferI); writeBufferI = 0; } // Pull the next byte byte ch = b[i + off]; - if (master.nvt.binaryMode == true) { + if (master.binaryMode == true) { - if (ch == master.TELNET_IAC) { + if (ch == TELNET_IAC) { // IAC -> IAC IAC - writeBuffer[writeBufferI++] = (byte)master.TELNET_IAC; - writeBuffer[writeBufferI++] = (byte)master.TELNET_IAC; + writeBuffer[writeBufferI++] = (byte) TELNET_IAC; + writeBuffer[writeBufferI++] = (byte) TELNET_IAC; } else { // Anything else -> just send writeBuffer[writeBufferI++] = ch; @@ -165,40 +209,40 @@ public final class TelnetOutputStream extends OutputStream { // the case that the last byte of b was a CR. // Bare carriage return -> CR NUL - if (ch == master.C_CR) { - if (master.nvt.writeCR == true) { + if (ch == C_CR) { + if (writeCR == true) { // Flush the previous CR to the stream. // CR -> CR NULL - writeBuffer[writeBufferI++] = (byte)master.C_CR; - writeBuffer[writeBufferI++] = (byte)master.C_NUL; + writeBuffer[writeBufferI++] = (byte) C_CR; + writeBuffer[writeBufferI++] = (byte) C_NUL; } - master.nvt.writeCR = true; - } else if (ch == master.C_LF) { - if (master.nvt.writeCR == true) { + writeCR = true; + } else if (ch == C_LF) { + if (writeCR == true) { // CR LF -> CR LF - writeBuffer[writeBufferI++] = (byte)master.C_CR; - writeBuffer[writeBufferI++] = (byte)master.C_LF; - master.nvt.writeCR = false; + writeBuffer[writeBufferI++] = (byte) C_CR; + writeBuffer[writeBufferI++] = (byte) C_LF; + writeCR = false; } else { // Bare LF -> LF writeBuffer[writeBufferI++] = ch; } - } else if (ch == master.TELNET_IAC) { - if (master.nvt.writeCR == true) { + } else if (ch == TELNET_IAC) { + if (writeCR == true) { // CR -> CR NULL - writeBuffer[writeBufferI++] = (byte)master.C_CR; - writeBuffer[writeBufferI++] = (byte)master.C_NUL; - master.nvt.writeCR = false; + writeBuffer[writeBufferI++] = (byte) C_CR; + writeBuffer[writeBufferI++] = (byte) C_NUL; + writeCR = false; } // IAC -> IAC IAC - writeBuffer[writeBufferI++] = (byte)master.TELNET_IAC; - writeBuffer[writeBufferI++] = (byte)master.TELNET_IAC; + writeBuffer[writeBufferI++] = (byte) TELNET_IAC; + writeBuffer[writeBufferI++] = (byte) TELNET_IAC; } else { - if (master.nvt.writeCR == true) { + if (writeCR == true) { // CR -> CR NULL - writeBuffer[writeBufferI++] = (byte)master.C_CR; - writeBuffer[writeBufferI++] = (byte)master.C_NUL; - master.nvt.writeCR = false; + writeBuffer[writeBufferI++] = (byte) C_CR; + writeBuffer[writeBufferI++] = (byte) C_NUL; + writeCR = false; } else { // Normal character */ writeBuffer[writeBufferI++] = ch; @@ -209,9 +253,8 @@ public final class TelnetOutputStream extends OutputStream { if (writeBufferI > 0) { // Flush what we have generated so far and reset the buffer. - super.write(writeBuffer, 0, writeBufferI); + output.write(writeBuffer, 0, writeBufferI); } } - }