org.jline.terminal.impl

Class AbstractTerminal

java.lang.Object

org.jline.terminal.impl.AbstractTerminal

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable, Terminal

Direct Known Subclasses:

AbstractPosixTerminal, AbstractWindowsTerminal, DumbTerminal, LineDisciplineTerminal

public abstract class AbstractTerminal
extends Object
implements Terminal

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 and Description
protected Set<InfoCmp.Capability>	bools
protected Map<Terminal.Signal,Terminal.SignalHandler>	handlers
protected Map<InfoCmp.Capability,Integer>	ints
protected String	name
protected Map<InfoCmp.Capability,String>	strings
protected String	type

Fields inherited from interface org.jline.terminal.Terminal

TYPE_DUMB

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
boolean	echo()
boolean	echo(boolean echo)
protected void	echoSignal(Terminal.Signal signal)
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)
String	getStringCapability(InfoCmp.Capability capability)
String	getType()
Terminal.SignalHandler	handle(Terminal.Signal signal, Terminal.SignalHandler handler)
boolean	hasMouseSupport() Returns true if the terminal has support for mouse.
protected void	parseInfoCmp()
boolean	puts(InfoCmp.Capability capability, Object... params)
void	raise(Terminal.Signal signal)
MouseEvent	readMouseEvent() Read a MouseEvent from the terminal input stream.
MouseEvent	readMouseEvent(IntSupplier reader) Read a MouseEvent from the given input stream.
boolean	trackMouse(Terminal.MouseTracking tracking) Change the mouse tracking mouse.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jline.terminal.Terminal

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

Methods inherited from interface java.io.Closeable

close

Field Detail

name

protected final String name

type

protected final String type

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

Constructor Detail

AbstractTerminal

public AbstractTerminal(String name,
                        String type)
                 throws IOException

Throws:

IOException

AbstractTerminal

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

Throws:

IOException

Method Detail

handle

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

Specified by:

handle in interface Terminal

raise

public void raise(Terminal.Signal signal)

Specified by:

raise in interface Terminal

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()

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