Package org.jline.terminal.impl

Class LineDisciplineTerminal

java.lang.Object

org.jline.terminal.impl.AbstractTerminal

org.jline.terminal.impl.LineDisciplineTerminal

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable, TerminalExt, Terminal

Direct Known Subclasses:

ExternalTerminal

public class LineDisciplineTerminal
extends AbstractTerminal

Abstract terminal with support for line discipline. The Terminal interface represents the slave side of a PTY, but implementations derived from this class will handle both the slave and master side of things. In order to correctly handle line discipline, the terminal needs to read the input in advance in order to raise the signals as fast as possible. For example, when the user hits Ctrl+C, we can't wait until the application consumes all the read events. The same applies to echoing, when enabled, as the echoing has to happen as soon as the user hit the keyboard, and not only when the application running in the terminal processes the input.

Nested Class Summary

Nested classes/interfaces inherited from interface org.jline.terminal.Terminal

Terminal.MouseTracking, Terminal.Signal, Terminal.SignalHandler

Field Summary

Fields

Modifier and Type	Field	Description
protected final Attributes	attributes	Console data
protected final OutputStream	masterOutput
protected final Size	size
protected boolean	skipNextLf
protected final NonBlockingPumpInputStream	slaveInput
protected final OutputStream	slaveInputPipe
protected final OutputStream	slaveOutput
protected final NonBlockingReader	slaveReader
protected final PrintWriter	slaveWriter

Fields inherited from class org.jline.terminal.impl.AbstractTerminal

bools, encoding, handlers, ints, name, onClose, palette, status, strings, type

Fields inherited from interface org.jline.terminal.Terminal

TYPE_DUMB, TYPE_DUMB_COLOR

Constructor Summary

Constructors

Constructor	Description
LineDisciplineTerminal(String name, String type, OutputStream masterOutput, Charset encoding)
LineDisciplineTerminal(String name, String type, OutputStream masterOutput, Charset encoding, Terminal.SignalHandler signalHandler)

Method Summary

Modifier and Type	Method	Description
protected void	doClose()
protected boolean	doProcessInputByte(int c)
Attributes	getAttributes()	Returns the terminal attributes.
TerminalProvider	getProvider()	Returns the TerminalProvider that created this terminal or null if the terminal was created with no provider.
Size	getSize()	Retrieve the size of the visible window
SystemStream	getSystemStream()	The underlying system stream, may be SystemStream.Output, SystemStream.Error, or null if this terminal is not bound to a system stream.
InputStream	input()	Retrieve the input stream for this terminal.
OutputStream	output()	Retrieve the output stream for this terminal.
void	processInputByte(int c)	Master input processing.
void	processInputBytes(byte[] input)
void	processInputBytes(byte[] input, int offset, int length)
protected void	processIOException(IOException ioException)
protected void	processOutputByte(int c)	Master output processing.
void	raise(Terminal.Signal signal)	Raise the specific signal.
NonBlockingReader	reader()	Retrieve the Reader for this terminal.
void	setAttributes(Attributes attr)	Set the terminal attributes.
void	setSize(Size sz)
PrintWriter	writer()	Retrieve the Writer for this terminal.

Methods inherited from class org.jline.terminal.impl.AbstractTerminal

canPauseResume, checkInterrupted, close, echo, echo, echoSignal, encoding, enterRawMode, flush, getBooleanCapability, getCursorPosition, getKind, getName, getNumericCapability, getPalette, getStatus, getStatus, getStringCapability, getType, handle, hasFocusSupport, hasMouseSupport, parseInfoCmp, pause, pause, paused, puts, readMouseEvent, readMouseEvent, resume, setOnClose, toString, trackFocus, trackMouse

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.jline.terminal.Terminal

getBufferSize, getHeight, getWidth

Field Details

masterOutput

protected final OutputStream masterOutput

slaveInputPipe

protected final OutputStream slaveInputPipe

slaveInput

protected final NonBlockingPumpInputStream slaveInput

slaveReader

protected final NonBlockingReader slaveReader

slaveWriter

protected final PrintWriter slaveWriter

slaveOutput

protected final OutputStream slaveOutput

attributes

protected final Attributes attributes

Console data

size

protected final Size size

skipNextLf

protected boolean skipNextLf

Constructor Details

LineDisciplineTerminal

public LineDisciplineTerminal(String name,
 String type,
 OutputStream masterOutput,
 Charset encoding)
                       throws IOException

Throws:

IOException

LineDisciplineTerminal

public LineDisciplineTerminal(String name,
 String type,
 OutputStream masterOutput,
 Charset encoding,
 Terminal.SignalHandler signalHandler)
                       throws IOException

Throws:

IOException

Method Details

reader

public NonBlockingReader reader()

Description copied from interface: Terminal

Retrieve the Reader for this terminal. This is the standard way to read input from this terminal. The reader is non blocking.

Returns:

The non blocking reader

writer

public PrintWriter writer()

Description copied from interface: Terminal

Retrieve the Writer for this terminal. This is the standard way to write to this terminal.

Returns:

The writer

input

public InputStream input()

Description copied from interface: Terminal

Retrieve the input stream for this terminal. In some rare cases, there may be a need to access the terminal input stream directly. In the usual cases, use the Terminal.reader() instead.

Returns:

The input stream

See Also:

• Terminal.reader()

output

public OutputStream output()

Description copied from interface: Terminal

Retrieve the output stream for this terminal. In some rare cases, there may be a need to access the terminal output stream directly. In the usual cases, use the Terminal.writer() instead.

Returns:

The output stream

See Also:

• Terminal.writer()

getAttributes

public Attributes getAttributes()

Description copied from interface: Terminal

Returns the terminal attributes. The returned object can be safely modified further used in a call to Terminal.setAttributes(Attributes).

Returns:

the terminal attributes.

setAttributes

public void setAttributes(Attributes attr)

Description copied from interface: Terminal

Set the terminal attributes. The terminal will perform a copy of the given attributes.

Parameters:

attr - the new attributes

getSize

public Size getSize()

Description copied from interface: Terminal

Retrieve the size of the visible window

Returns:

the visible terminal size

See Also:

• Terminal.getBufferSize()

setSize

public void setSize(Size sz)

raise

public void raise(Terminal.Signal signal)

Description copied from interface: Terminal

Raise the specific signal. This is not method usually called by non system terminals. When accessing a terminal through a SSH or Telnet connection, signals may be conveyed by the protocol and thus need to be raised when reaching the terminal code. The terminals do that automatically when the terminal input stream has a character mapped to Attributes.ControlChar.VINTR, Attributes.ControlChar.VQUIT, or Attributes.ControlChar.VSUSP.

Specified by:

raise in interface Terminal

Overrides:

raise in class AbstractTerminal

Parameters:

signal - the signal to raise

processInputByte

public void processInputByte(int c)
                      throws IOException

Master input processing. All data coming to the terminal should be provided using this method.

Parameters:

c - the input byte

Throws:

IOException - if anything wrong happens

processInputBytes

public void processInputBytes(byte[] input)
                       throws IOException

Throws:

IOException

processInputBytes

public void processInputBytes(byte[] input,
 int offset,
 int length)
                       throws IOException

Throws:

IOException

doProcessInputByte

protected boolean doProcessInputByte(int c)
                              throws IOException

Throws:

IOException

processOutputByte

protected void processOutputByte(int c)
                          throws IOException

Master output processing. All data going to the master should be provided by this method.

Parameters:

c - the output byte

Throws:

IOException - if anything wrong happens

processIOException

protected void processIOException(IOException ioException)

doClose

protected void doClose()
                throws IOException

Overrides:

doClose in class AbstractTerminal

Throws:

IOException

getProvider

public TerminalProvider getProvider()

Description copied from interface: TerminalExt

Returns the TerminalProvider that created this terminal or null if the terminal was created with no provider.

getSystemStream

public SystemStream getSystemStream()

Description copied from interface: TerminalExt

The underlying system stream, may be SystemStream.Output, SystemStream.Error, or null if this terminal is not bound to a system stream.