-
- All Superinterfaces:
AutoCloseable,Closeable,Flushable
- All Known Implementing Classes:
AbstractPosixTerminal,AbstractTerminal,AbstractWindowsTerminal,DumbTerminal,ExternalTerminal,JansiWinSysTerminal,JnaWinSysTerminal,LineDisciplineTerminal,PosixPtyTerminal,PosixSysTerminal
public interface Terminal extends Closeable, Flushable
A terminal representing a virtual terminal on the computer. Terminals should be closed by calling theCloseable.close()method in order to restore their original state.
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static classTerminal.MouseTrackingstatic classTerminal.Signalstatic interfaceTerminal.SignalHandler
-
Field Summary
Fields Modifier and Type Field Description static StringTYPE_DUMBType used for dumb terminals.static StringTYPE_DUMB_COLOR
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description booleancanPauseResume()booleanecho()booleanecho(boolean echo)Charsetencoding()AttributesenterRawMode()voidflush()AttributesgetAttributes()booleangetBooleanCapability(InfoCmp.Capability capability)default SizegetBufferSize()Retrieve the size of the window buffer.CursorgetCursorPosition(IntConsumer discarded)Query the terminal to report the cursor position.default intgetHeight()StringgetName()IntegergetNumericCapability(InfoCmp.Capability capability)ColorPalettegetPalette()Color supportSizegetSize()Retrieve the size of the visible windowStringgetStringCapability(InfoCmp.Capability capability)StringgetType()default intgetWidth()Terminal.SignalHandlerhandle(Terminal.Signal signal, Terminal.SignalHandler handler)booleanhasFocusSupport()Returnstrueif the terminal has support for focus tracking.booleanhasMouseSupport()Returnstrueif the terminal has support for mouse.InputStreaminput()Retrieve the input stream for this terminal.OutputStreamoutput()Retrieve the output stream for this terminal.voidpause()Stop reading the input stream.voidpause(boolean wait)Stop reading the input stream and optionally wait for the underlying threads to finish.booleanpaused()Check whether the terminal is currently reading the input stream or not.booleanputs(InfoCmp.Capability capability, Object... params)voidraise(Terminal.Signal signal)NonBlockingReaderreader()Retrieve theReaderfor this terminal.MouseEventreadMouseEvent()Read a MouseEvent from the terminal input stream.MouseEventreadMouseEvent(IntSupplier reader)Read a MouseEvent from the given input stream.voidresume()Resume reading the input stream.voidsetAttributes(Attributes attr)voidsetSize(Size size)booleantrackFocus(boolean tracking)Enable or disable focus tracking mode.booleantrackMouse(Terminal.MouseTracking tracking)Change the mouse tracking mouse.PrintWriterwriter()Retrieve theWriterfor this terminal.
-
-
-
Field Detail
-
TYPE_DUMB
static final String TYPE_DUMB
Type used for dumb terminals.- See Also:
- Constant Field Values
-
TYPE_DUMB_COLOR
static final String TYPE_DUMB_COLOR
- See Also:
- Constant Field Values
-
-
Method Detail
-
getName
String getName()
-
handle
Terminal.SignalHandler handle(Terminal.Signal signal, Terminal.SignalHandler handler)
-
raise
void raise(Terminal.Signal signal)
-
reader
NonBlockingReader reader()
Retrieve theReaderfor this terminal. This is the standard way to read input from this terminal. The reader is non blocking.- Returns:
- The non blocking reader
-
writer
PrintWriter writer()
Retrieve theWriterfor this terminal. This is the standard way to write to this terminal.- Returns:
- The writer
-
encoding
Charset encoding()
- Returns:
- The terminal encoding
-
input
InputStream input()
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 thereader()instead.- Returns:
- The input stream
- See Also:
reader()
-
output
OutputStream output()
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 thewriter()instead.- Returns:
- The output stream
- See Also:
writer()
-
canPauseResume
boolean canPauseResume()
-
pause
void pause(boolean wait) throws InterruptedExceptionStop reading the input stream and optionally wait for the underlying threads to finish.- Parameters:
wait-trueto wait until the terminal is actually paused- Throws:
InterruptedException- if the call has been interrupted
-
paused
boolean paused()
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.
-
enterRawMode
Attributes enterRawMode()
-
echo
boolean echo()
-
echo
boolean echo(boolean echo)
-
getAttributes
Attributes getAttributes()
-
setAttributes
void setAttributes(Attributes attr)
-
getSize
Size getSize()
Retrieve the size of the visible window- Returns:
- the visible terminal size
- See Also:
getBufferSize()
-
setSize
void setSize(Size size)
-
getWidth
default int getWidth()
-
getHeight
default int getHeight()
-
getBufferSize
default Size getBufferSize()
Retrieve the size of the window buffer. Some terminals can be configured to have a buffer size larger than the visible window size and provide scroll bars. In such cases, this method should attempt to return the size of the whole buffer. ThegetBufferSize()method can be used to avoid wrapping when using the terminal in a line editing mode, while thegetSize()method should be used when using full screen mode.- Returns:
- the terminal buffer size
- See Also:
getSize()
-
getType
String getType()
-
puts
boolean puts(InfoCmp.Capability capability, Object... params)
-
getBooleanCapability
boolean getBooleanCapability(InfoCmp.Capability capability)
-
getNumericCapability
Integer getNumericCapability(InfoCmp.Capability capability)
-
getStringCapability
String getStringCapability(InfoCmp.Capability capability)
-
getCursorPosition
Cursor getCursorPosition(IntConsumer discarded)
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 usingorg.jline.keymap.BindingReader#runMacro(String)- Parameters:
discarded- a consumer receiving discarded characters- Returns:
nullif cursor position reporting is not supported or a valid cursor position
-
hasMouseSupport
boolean hasMouseSupport()
Returnstrueif the terminal has support for mouse.- Returns:
- whether mouse is supported by the terminal
- See Also:
trackMouse(MouseTracking)
-
trackMouse
boolean trackMouse(Terminal.MouseTracking tracking)
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 theInfoCmp.Capability.key_mouseto the input stream. When this character sequence is detected, thereadMouseEvent()method can be called to actually read the corresponding mouse event.- Parameters:
tracking- the mouse tracking mode- Returns:
trueif mouse tracking is supported
-
readMouseEvent
MouseEvent readMouseEvent()
Read a MouseEvent from the terminal input stream. Such an event must have been detected by scanning the terminal'sInfoCmp.Capability.key_mousein the stream immediately before reading the event.- Returns:
- the decoded mouse event.
- See Also:
trackMouse(MouseTracking)
-
readMouseEvent
MouseEvent readMouseEvent(IntSupplier reader)
Read a MouseEvent from the given input stream.- Parameters:
reader- the input supplier- Returns:
- the decoded mouse event
-
hasFocusSupport
boolean hasFocusSupport()
Returnstrueif the terminal has support for focus tracking.- Returns:
- whether focus tracking is supported by the terminal
- See Also:
trackFocus(boolean)
-
trackFocus
boolean trackFocus(boolean tracking)
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.- Parameters:
tracking- whether the focus tracking mode should be enabled or not- Returns:
trueif focus tracking is supported
-
getPalette
ColorPalette getPalette()
Color support
-
-