Package org.jline.terminal.impl

Class PosixSysTerminal

java.lang.Object

org.jline.terminal.impl.AbstractTerminal

org.jline.terminal.impl.AbstractPosixTerminal

org.jline.terminal.impl.PosixSysTerminal

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable, Sized, TerminalExt, Terminal

public class PosixSysTerminal
extends AbstractPosixTerminal

Terminal implementation for POSIX systems using system streams.

The PosixSysTerminal class provides a terminal implementation for POSIX systems (Linux, macOS, etc.) that uses the system standard input and output streams. It extends the AbstractPosixTerminal class and adds functionality specific to system stream-based terminals.

This implementation is used when connecting to the actual system terminal, such as when running a console application in a terminal window. It provides access to the standard input and output streams, allowing for interaction with the user through the terminal.

Key features of this implementation include:

• Direct access to system standard input and output
• Support for terminal attributes and size changes
• Support for non-blocking I/O
• Automatic restoration of terminal state on shutdown

See Also:

• AbstractPosixTerminal
• Pty

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 ShutdownHooks.Task	closer
protected final NonBlockingInputStream	input
protected final Map<Terminal.Signal,Object>	nativeHandlers
protected final OutputStream	output
protected final TerminalProvider	provider
protected final NonBlockingReader	reader
protected final PrintWriter	writer

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

originalAttributes, pty

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

bools, closed, currentMouseTracking, encoding, handlers, inputEncoding, ints, name, onClose, outputEncoding, palette, status, strings, type

Fields inherited from interface org.jline.terminal.Terminal

TYPE_DUMB, TYPE_DUMB_COLOR

Constructor Summary

Constructors

Constructor	Description
PosixSysTerminal(String name, String type, Pty pty, Charset encoding, boolean nativeSignals, Terminal.SignalHandler signalHandler)	Creates a POSIX system terminal backed by the provided PTY, using the same charset for input and output, and optionally enabling native signal handling.
PosixSysTerminal(String name, String type, Pty pty, Charset encoding, Charset inputEncoding, Charset outputEncoding, boolean nativeSignals, Terminal.SignalHandler signalHandler)	Creates a POSIX system terminal backed by the given PTY and character encodings, without a TerminalProvider.
PosixSysTerminal(TerminalProvider provider, String name, String type, Pty pty, Charset encoding, Charset inputEncoding, Charset outputEncoding, boolean nativeSignals, Terminal.SignalHandler signalHandler)	Create a POSIX system terminal backed by the provided PTY, initializing non-blocking input/output, reader/writer encodings, and optional native signal handlers.

Method Summary

Modifier and Type	Method	Description
protected void	doClose()	Closes the terminal and releases its resources: flushes pending output, removes the shutdown hook, unregisters any native signal handlers, performs superclass shutdown, and closes the reader.
Terminal.SignalHandler	handle(Terminal.Signal signal, Terminal.SignalHandler handler)	Install a new handler for the given signal and synchronize native registration when the handler changes.
InputStream	input()	Retrieve the input stream for this terminal.
OutputStream	output()	Retrieve the output stream for this terminal.
NonBlockingReader	reader()	Retrieve the Reader for this terminal.
boolean	supportsGraphemeClusterMode()	Determine if grapheme cluster mode is supported for this terminal.
PrintWriter	writer()	Retrieve the Writer for this terminal.

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

getAttributes, getCursorPosition, getDefaultBackgroundColor, getDefaultForegroundColor, getProvider, getPty, getSize, getSystemStream, setAttributes, setSize, toString

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

canPauseResume, checkClosed, checkInterrupted, close, detectTrueColorSupport, echo, echo, echoSignal, encoding, enterRawMode, flush, getBooleanCapability, getCurrentMouseTracking, getGraphemeClusterMode, getKind, getName, getNumericCapability, getPalette, getStatus, getStatus, getStringCapability, getType, hasFocusSupport, hasMouseSupport, inputEncoding, isClusterGrouped, outputEncoding, parseInfoCmp, pause, pause, paused, puts, raise, readMouseEvent, readMouseEvent, readMouseEvent, readMouseEvent, resume, setGraphemeClusterMode, setOnClose, 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, getColumns, getHeight, getRows, getWidth, setSize

Field Details

provider

protected final TerminalProvider provider

input

protected final NonBlockingInputStream input

output

protected final OutputStream output

reader

protected final NonBlockingReader reader

writer

protected final PrintWriter writer

nativeHandlers

protected final Map<Terminal.Signal,Object> nativeHandlers

closer

protected final ShutdownHooks.Task closer

Constructor Details

PosixSysTerminal

public PosixSysTerminal(String name,
 String type,
 Pty pty,
 Charset encoding,
 boolean nativeSignals,
 Terminal.SignalHandler signalHandler)
                 throws IOException

Creates a POSIX system terminal backed by the provided PTY, using the same charset for input and output, and optionally enabling native signal handling.

Parameters:

name - the terminal name

type - the terminal type (TERM)

pty - the pseudo-terminal providing slave input/output streams for the terminal

encoding - the charset used for both input and output encoding

nativeSignals - if true, native OS signal handlers will be registered

signalHandler - the initial handler to install for native signals

Throws:

IOException - if an I/O error occurs while initializing the terminal

PosixSysTerminal

public PosixSysTerminal(String name,
 String type,
 Pty pty,
 Charset encoding,
 Charset inputEncoding,
 Charset outputEncoding,
 boolean nativeSignals,
 Terminal.SignalHandler signalHandler)
                 throws IOException

Creates a POSIX system terminal backed by the given PTY and character encodings, without a TerminalProvider.

Parameters:

name - the terminal name

type - the terminal type (TERM)

pty - the pseudoterminal providing slave input/output streams

encoding - the primary charset for the terminal

inputEncoding - the charset used for input decoding

outputEncoding - the charset used for output encoding

nativeSignals - whether native signal handlers should be registered

signalHandler - the initial handler to install for native signals

Throws:

IOException - if an I/O error occurs while initializing the terminal

PosixSysTerminal

public PosixSysTerminal(TerminalProvider provider,
 String name,
 String type,
 Pty pty,
 Charset encoding,
 Charset inputEncoding,
 Charset outputEncoding,
 boolean nativeSignals,
 Terminal.SignalHandler signalHandler)
                 throws IOException

Create a POSIX system terminal backed by the provided PTY, initializing non-blocking input/output, reader/writer encodings, and optional native signal handlers.

Parameters:

provider - optional TerminalProvider used for native signal registration; may be null

name - the terminal name

type - the terminal type (TERM)

pty - the PTY whose slave streams back this terminal

encoding - the primary charset for the terminal

inputEncoding - the charset used for the terminal reader

outputEncoding - the charset used for the terminal writer

nativeSignals - if true, register native OS signal handlers for all signals

signalHandler - the initial handler to install for native signals; if `SignalHandler.SIG_DFL`, default native handlers will be registered

Throws:

IOException - if the PTY streams or terminal I/O cannot be initialized

Method Details

handle

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

Install a new handler for the given signal and synchronize native registration when the handler changes. If the new handler differs from the previous one, registers a native default handler when the new handler is `SignalHandler.SIG_DFL`; otherwise registers a native handler that will raise the signal.

Specified by:

handle in interface Terminal

Overrides:

handle in class AbstractTerminal

Parameters:

signal - the signal to update

handler - the new handler to install for the signal

Returns:

the previous handler for the signal

See Also:

• Terminal.Signal
• Terminal.SignalHandler
• Terminal.raise(Signal)

supportsGraphemeClusterMode

public boolean supportsGraphemeClusterMode()

Determine if grapheme cluster mode is supported for this terminal.

Specified by:

supportsGraphemeClusterMode in interface Terminal

Overrides:

supportsGraphemeClusterMode in class AbstractTerminal

Returns:

`true` if grapheme cluster mode is supported, `false` otherwise; on Windows this always returns `false` to avoid writing a DECRQM probe to raw stdout/stderr that may not be a real PTY and could contaminate process output.

See Also:

• Terminal.setGraphemeClusterMode(boolean, boolean)
• Terminal.getGraphemeClusterMode()

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.

The returned reader is owned by this terminal and will be closed when the terminal is closed. Callers should not close it directly.

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.

The returned writer is owned by this terminal and will be closed when the terminal is closed. Callers should not close it directly.

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.

The returned stream is owned by this terminal and will be closed when the terminal is closed. Callers should not close it directly.

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.

The returned stream is owned by this terminal and will be closed when the terminal is closed. Callers should not close it directly.

Returns:

The output stream

See Also:

• Terminal.writer()

doClose

protected void doClose()
                throws IOException

Closes the terminal and releases its resources: flushes pending output, removes the shutdown hook, unregisters any native signal handlers, performs superclass shutdown, and closes the reader.

Overrides:

doClose in class AbstractPosixTerminal

Throws:

IOException - if an I/O error occurs while flushing or closing the terminal streams