Package org.jline.terminal.impl

Class AbstractTerminal

java.lang.Object

org.jline.terminal.impl.AbstractTerminal

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable, TerminalExt, Terminal

Direct Known Subclasses:

AbstractPosixTerminal, AbstractWindowsTerminal, DumbTerminal, LineDisciplineTerminal

public abstract class AbstractTerminal
extends Object
implements TerminalExt

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 Set<InfoCmp.Capability>	bools
protected final Charset	encoding
protected final Map<Terminal.Signal,Terminal.SignalHandler>	handlers
protected final Map<InfoCmp.Capability,Integer>	ints
protected final String	name
protected Runnable	onClose
protected final ColorPalette	palette
protected Status	status
protected final Map<InfoCmp.Capability,String>	strings
protected final String	type

Fields inherited from interface org.jline.terminal.Terminal

TYPE_DUMB, TYPE_DUMB_COLOR

Constructor Summary

Constructors

Constructor	Description
AbstractTerminal(String name, String type)
AbstractTerminal(String name, String type, Charset encoding, Terminal.SignalHandler signalHandler)

Method Summary

Modifier and Type	Method	Description
boolean	canPauseResume()	Whether this terminal supports Terminal.pause() and Terminal.resume() calls.
protected void	checkInterrupted()
final void	close()
protected void	doClose()
boolean	echo()
boolean	echo(boolean echo)
protected void	echoSignal(Terminal.Signal signal)
Charset	encoding()	Returns the Charset that should be used to encode characters for Terminal.input() and Terminal.output().
Attributes	enterRawMode()
void	flush()
boolean	getBooleanCapability(InfoCmp.Capability capability)
Cursor	getCursorPosition(IntConsumer discarded)	Query the terminal to report the cursor position.
String	getKind()
String	getName()
Integer	getNumericCapability(InfoCmp.Capability capability)
ColorPalette	getPalette()	Color support
Status	getStatus()
Status	getStatus(boolean create)
String	getStringCapability(InfoCmp.Capability capability)
String	getType()
Terminal.SignalHandler	handle(Terminal.Signal signal, Terminal.SignalHandler handler)	Registers a handler for the given Terminal.Signal.
boolean	hasFocusSupport()	Returns true if the terminal has support for focus tracking.
boolean	hasMouseSupport()	Returns true if the terminal has support for mouse.
protected void	parseInfoCmp()
void	pause()	Stop reading the input stream.
void	pause(boolean wait)	Stop reading the input stream and optionally wait for the underlying threads to finish.
boolean	paused()	Check whether the terminal is currently reading the input stream or not.
boolean	puts(InfoCmp.Capability capability, Object... params)
void	raise(Terminal.Signal signal)	Raise the specific signal.
MouseEvent	readMouseEvent()	Read a MouseEvent from the terminal input stream.
MouseEvent	readMouseEvent(IntSupplier reader)	Read a MouseEvent from the given input stream.
void	resume()	Resume reading the input stream.
void	setOnClose(Runnable onClose)
String	toString()
boolean	trackFocus(boolean tracking)	Enable or disable focus tracking mode.
boolean	trackMouse(Terminal.MouseTracking tracking)	Change the mouse tracking mouse.

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

getAttributes, getBufferSize, getHeight, getSize, getWidth, input, output, reader, setAttributes, setSize, writer

Methods inherited from interface org.jline.terminal.spi.TerminalExt

getProvider, getSystemStream

Field Details

name

protected final String name

type

protected final String type

encoding

protected final Charset encoding

handlers

protected final Map<Terminal.Signal,Terminal.SignalHandler> handlers

bools

protected final Set<InfoCmp.Capability> bools

ints

protected final Map<InfoCmp.Capability,Integer> ints

strings

protected final Map<InfoCmp.Capability,String> strings

palette

protected final ColorPalette palette

status

protected Status status

onClose

protected Runnable onClose

Constructor Details

AbstractTerminal

public AbstractTerminal(String name,
 String type)
                 throws IOException

Throws:

IOException

AbstractTerminal

public AbstractTerminal(String name,
 String type,
 Charset encoding,
 Terminal.SignalHandler signalHandler)
                 throws IOException

Throws:

IOException

Method Details

setOnClose

public void setOnClose(Runnable onClose)

getStatus

public Status getStatus()

getStatus

public Status getStatus(boolean create)

handle

public Terminal.SignalHandler handle(Terminal.Signal signal,
 Terminal.SignalHandler handler)

Description copied from interface: Terminal

Registers a handler for the given Terminal.Signal.

Note that the JVM does not easily allow catching the Terminal.Signal.QUIT signal, which causes a thread dump to be displayed. This signal is mainly used when connecting through an SSH socket to a virtual terminal.

Specified by:

handle in interface Terminal

Parameters:

signal - the signal to register a handler for

handler - the handler

Returns:

the previous signal handler

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

Parameters:

signal - the signal to raise

close

public final void close()
                 throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException

doClose

protected void doClose()
                throws IOException

Throws:

IOException

echoSignal

protected void echoSignal(Terminal.Signal signal)

enterRawMode

public Attributes enterRawMode()

Specified by:

enterRawMode in interface Terminal

echo

public boolean echo()

Specified by:

echo in interface Terminal

echo

public boolean echo(boolean echo)

Specified by:

echo in interface Terminal

getName

public String getName()

Specified by:

getName in interface Terminal

getType

public String getType()

Specified by:

getType in interface Terminal

getKind

public String getKind()

encoding

public Charset encoding()

Description copied from interface: Terminal

Returns the Charset that should be used to encode characters for Terminal.input() and Terminal.output().

Specified by:

encoding in interface Terminal

Returns:

The terminal encoding

flush

public void flush()

Specified by:

flush in interface Flushable

Specified by:

flush in interface Terminal

puts

public boolean puts(InfoCmp.Capability capability,
 Object... params)

Specified by:

puts in interface Terminal

getBooleanCapability

public boolean getBooleanCapability(InfoCmp.Capability capability)

Specified by:

getBooleanCapability in interface Terminal

getNumericCapability

public Integer getNumericCapability(InfoCmp.Capability capability)

Specified by:

getNumericCapability in interface Terminal

getStringCapability

public String getStringCapability(InfoCmp.Capability capability)

Specified by:

getStringCapability in interface Terminal

parseInfoCmp

protected void parseInfoCmp()

getCursorPosition

public Cursor getCursorPosition(IntConsumer discarded)

Description copied from interface: Terminal

Query the terminal to report the cursor position. As the response is read from the input stream, some characters may be read before the cursor position is actually read. Those characters can be given back using org.jline.keymap.BindingReader#runMacro(String)

Specified by:

getCursorPosition in interface Terminal

Parameters:

discarded - a consumer receiving discarded characters

Returns:

null if cursor position reporting is not supported or a valid cursor position

hasMouseSupport

public boolean hasMouseSupport()

Description copied from interface: Terminal

Returns true if the terminal has support for mouse.

Specified by:

hasMouseSupport in interface Terminal

Returns:

whether mouse is supported by the terminal

See Also:

• Terminal.trackMouse(MouseTracking)

trackMouse

public boolean trackMouse(Terminal.MouseTracking tracking)

Description copied from interface: Terminal

Change the mouse tracking mouse. To start mouse tracking, this method must be called with a valid mouse tracking mode. Mouse events will be reported by writing the InfoCmp.Capability.key_mouse to the input stream. When this character sequence is detected, the Terminal.readMouseEvent() method can be called to actually read the corresponding mouse event.

Specified by:

trackMouse in interface Terminal

Parameters:

tracking - the mouse tracking mode

Returns:

true if mouse tracking is supported

readMouseEvent

public MouseEvent readMouseEvent()

Description copied from interface: Terminal

Read a MouseEvent from the terminal input stream. Such an event must have been detected by scanning the terminal's InfoCmp.Capability.key_mouse in the stream immediately before reading the event.

Specified by:

readMouseEvent in interface Terminal

Returns:

the decoded mouse event.

See Also:

• Terminal.trackMouse(MouseTracking)

readMouseEvent

public MouseEvent readMouseEvent(IntSupplier reader)

Description copied from interface: Terminal

Read a MouseEvent from the given input stream.

Specified by:

readMouseEvent in interface Terminal

Parameters:

reader - the input supplier

Returns:

the decoded mouse event

hasFocusSupport

public boolean hasFocusSupport()

Description copied from interface: Terminal

Returns true if the terminal has support for focus tracking.

Specified by:

hasFocusSupport in interface Terminal

Returns:

whether focus tracking is supported by the terminal

See Also:

• Terminal.trackFocus(boolean)

trackFocus

public boolean trackFocus(boolean tracking)

Description copied from interface: Terminal

Enable or disable focus tracking mode. When focus tracking has been activated, each time the terminal grabs the focus, the string "\33[I" will be sent to the input stream and each time the focus is lost, the string "\33[O" will be sent to the input stream.

Specified by:

trackFocus in interface Terminal

Parameters:

tracking - whether the focus tracking mode should be enabled or not

Returns:

true if focus tracking is supported

checkInterrupted

protected void checkInterrupted()
                         throws InterruptedIOException

Throws:

InterruptedIOException

canPauseResume

public boolean canPauseResume()

Description copied from interface: Terminal

Whether this terminal supports Terminal.pause() and Terminal.resume() calls.

Specified by:

canPauseResume in interface Terminal

Returns:

whether this terminal supports Terminal.pause() and Terminal.resume() calls.

See Also:

• Terminal.paused()
• Terminal.pause()
• Terminal.resume()

pause

public void pause()

Description copied from interface: Terminal

Stop reading the input stream.

Specified by:

pause in interface Terminal

See Also:

• Terminal.resume()
• Terminal.paused()

pause

public void pause(boolean wait)
           throws InterruptedException

Description copied from interface: Terminal

Stop reading the input stream and optionally wait for the underlying threads to finish.

Specified by:

pause in interface Terminal

Parameters:

wait - true to wait until the terminal is actually paused

Throws:

InterruptedException - if the call has been interrupted

resume

public void resume()

Description copied from interface: Terminal

Resume reading the input stream.

Specified by:

resume in interface Terminal

See Also:

• Terminal.pause()
• Terminal.paused()

paused

public boolean paused()

Description copied from interface: Terminal

Check whether the terminal is currently reading the input stream or not. In order to process signal as quickly as possible, the terminal need to read the input stream and buffer it internally so that it can detect specific characters in the input stream (Ctrl+C, Ctrl+D, etc...) and raise the appropriate signals. However, there are some cases where this processing should be disabled, for example when handing the terminal control to a subprocess.

Specified by:

paused in interface Terminal

Returns:

whether the terminal is currently reading the input stream or not

See Also:

• Terminal.pause()
• Terminal.resume()

getPalette

public ColorPalette getPalette()

Description copied from interface: Terminal

Color support

Specified by:

getPalette in interface Terminal

toString

public String toString()

Overrides:

toString in class Object