OpenJDK 27 · jdk.internal.org.jline.terminal.impl.AbstractWindowsTerminal

Field Summary

Modifier and Type	Field and Description
pack-priv static final int	ALT_FLAG
protected final Attributes	attributes
pack-priv static final int	CAPSLOCK_ON
protected final ShutdownHooks.Task	closer
private volatile boolean	closing
pack-priv static final int	CTRL_FLAG
protected static final int	ENABLE_ECHO_INPUT
protected static final int	ENABLE_EXTENDED_FLAGS
protected static final int	ENABLE_INSERT_MODE
protected static final int	ENABLE_LINE_INPUT
protected static final int	ENABLE_MOUSE_INPUT
protected static final int	ENABLE_PROCESSED_INPUT
protected static final int	ENABLE_QUICK_EDIT_MODE
public static final int	ENABLE_VIRTUAL_TERMINAL_PROCESSING
protected static final int	ENABLE_WINDOW_INPUT
protected boolean	focusTracking
protected final Console	inConsole
protected final InputStream	input
pack-priv static final int	LEFT_ALT_PRESSED
pack-priv static final int	LEFT_CTRL_PRESSED
protected final Object	lock
protected final Map<Terminal.Signal, Object>	nativeHandlers
pack-priv static final int	NUMLOCK_ON
protected final int	originalInConsoleMode
protected final int	originalOutConsoleMode
protected final Console	outConsole
protected final OutputStream	output
protected boolean	paused
private final TerminalProvider	provider
protected Thread	pump
protected final NonBlockingReader	reader
pack-priv static final int	RIGHT_ALT_PRESSED
pack-priv static final int	RIGHT_CTRL_PRESSED
pack-priv static final int	SCROLLLOCK_ON
pack-priv static final int	SHIFT_FLAG
pack-priv static final int	SHIFT_PRESSED
protected boolean	skipNextLf
protected final Writer	slaveInputPipe
private final SystemStream	systemStream
protected Terminal.MouseTracking	tracking
public static final String	TYPE_WINDOWS
public static final String	TYPE_WINDOWS_256_COLOR
public static final String	TYPE_WINDOWS_CONEMU
public static final String	TYPE_WINDOWS_VTP
private static final int	UTF8_CODE_PAGE
protected final PrintWriter	writer

Inherited from jdk.internal.org.jline.terminal.impl.AbstractTerminal:: bools encoding handlers ints name onClose palette status strings type

Constructor Summary

Access	Constructor and Description
public	AbstractWindowsTerminal(TerminalProvider provider, SystemStream systemStream, Writer writer, String name, String type, Charset encoding, boolean nativeSignals, Terminal.SignalHandler signalHandler, Console inConsole, int inConsoleMode, Console outConsole, int outConsoleMode, Function<InputStream, InputStream> inputStreamWrapper)

Method Summary

Modifier and Type	Method and Description
public boolean	canPauseResume() Overrides jdk.internal.org.jline.terminal.impl.AbstractTerminal.canPauseResume. Implements jdk.internal.org.jline.terminal.Terminal.canPauseResume. Whether this terminal supports `pause()` and `resume()` calls.
protected int	ctrl(char key)
protected void	doClose() Overrides jdk.internal.org.jline.terminal.impl.AbstractTerminal.doClose.
public Attributes	getAttributes() Implements jdk.internal.org.jline.terminal.Terminal.getAttributes. Returns the terminal attributes.
protected abstract int	getConsoleMode(Console console)
protected String	getEscapeSequence(short keyCode, int keyState)
public TerminalProvider	getProvider() Implements jdk.internal.org.jline.terminal.spi.TerminalExt.getProvider. Returns the `TerminalProvider` that created this terminal or `null` if the terminal was created with no provider.
protected String	getRawSequence(InfoCmp.Capability cap)
public SystemStream	getSystemStream() Implements jdk.internal.org.jline.terminal.spi.TerminalExt.getSystemStream. The underlying system stream, may be `SystemStream#Output`, `SystemStream#Error`, or `null` if this terminal is not bound to a system stream.
public Terminal.SignalHandler	handle(Terminal.Signal signal, Terminal.SignalHandler handler) Overrides jdk.internal.org.jline.terminal.impl.AbstractTerminal.handle. Implements jdk.internal.org.jline.terminal.Terminal.handle. Registers a handler for the given `Signal`.
public boolean	hasFocusSupport() Overrides jdk.internal.org.jline.terminal.impl.AbstractTerminal.hasFocusSupport. Implements jdk.internal.org.jline.terminal.Terminal.hasFocusSupport. Returns `true` if the terminal has support for focus tracking.
public InputStream	input() Implements jdk.internal.org.jline.terminal.Terminal.input. Retrieve the input stream for this terminal.
public OutputStream	output() Implements jdk.internal.org.jline.terminal.Terminal.output. Retrieve the output stream for this terminal.
public void	pause() Overrides jdk.internal.org.jline.terminal.impl.AbstractTerminal.pause. Implements jdk.internal.org.jline.terminal.Terminal.pause. Stop reading the input stream.
public void	pause(boolean wait) Overrides jdk.internal.org.jline.terminal.impl.AbstractTerminal.pause. Implements jdk.internal.org.jline.terminal.Terminal.pause. Stop reading the input stream and optionally wait for the underlying threads to finish.
public boolean	paused() Overrides jdk.internal.org.jline.terminal.impl.AbstractTerminal.paused. Implements jdk.internal.org.jline.terminal.Terminal.paused. Check whether the terminal is currently reading the input stream or not.
protected abstract boolean	Returns: true if new input was generated from the event processConsoleInput() Read a single input event from the input buffer and process it.
public void	processInputChar(char c)
protected void	processKeyEvent(final boolean isKeyDown, final short virtualKeyCode, char ch, final int controlKeyState)
protected void	pump()
public NonBlockingReader	reader() Implements jdk.internal.org.jline.terminal.Terminal.reader. Retrieve the `Reader` for this terminal.
public void	resume() Overrides jdk.internal.org.jline.terminal.impl.AbstractTerminal.resume. Implements jdk.internal.org.jline.terminal.Terminal.resume. Resume reading the input stream.
public void	setAttributes(Attributes attr) Implements jdk.internal.org.jline.terminal.Terminal.setAttributes. Set the terminal attributes.
protected abstract void	setConsoleMode(Console console, int mode)
public void	setSize(Size size) Implements jdk.internal.org.jline.terminal.Terminal.setSize.
public boolean	trackFocus(boolean tracking) Overrides jdk.internal.org.jline.terminal.impl.AbstractTerminal.trackFocus. Implements jdk.internal.org.jline.terminal.Terminal.trackFocus. Enable or disable focus tracking mode.
public boolean	trackMouse(Terminal.MouseTracking tracking) Overrides jdk.internal.org.jline.terminal.impl.AbstractTerminal.trackMouse. Implements jdk.internal.org.jline.terminal.Terminal.trackMouse. Change the mouse tracking mouse.
protected void	updateConsoleMode()
public PrintWriter	writer() Implements jdk.internal.org.jline.terminal.Terminal.writer. Retrieve the `Writer` for this terminal.

Field Detail

ALT_FLAG	back to summary
pack-priv static final int ALT_FLAG

attributes	back to summary
protected final Attributes attributes

CAPSLOCK_ON	back to summary
pack-priv static final int CAPSLOCK_ON

closer	back to summary
protected final ShutdownHooks.Task closer

closing	back to summary
private volatile boolean closing

CTRL_FLAG	back to summary
pack-priv static final int CTRL_FLAG

ENABLE_ECHO_INPUT	back to summary
protected static final int ENABLE_ECHO_INPUT

ENABLE_EXTENDED_FLAGS	back to summary
protected static final int ENABLE_EXTENDED_FLAGS

ENABLE_INSERT_MODE	back to summary
protected static final int ENABLE_INSERT_MODE

ENABLE_LINE_INPUT	back to summary
protected static final int ENABLE_LINE_INPUT

ENABLE_MOUSE_INPUT	back to summary
protected static final int ENABLE_MOUSE_INPUT

ENABLE_PROCESSED_INPUT	back to summary
protected static final int ENABLE_PROCESSED_INPUT

ENABLE_QUICK_EDIT_MODE	back to summary
protected static final int ENABLE_QUICK_EDIT_MODE

ENABLE_VIRTUAL_TERMINAL_PROCESSING	back to summary
public static final int ENABLE_VIRTUAL_TERMINAL_PROCESSING

ENABLE_WINDOW_INPUT	back to summary
protected static final int ENABLE_WINDOW_INPUT

focusTracking	back to summary
protected boolean focusTracking

inConsole	back to summary
protected final Console inConsole

input	back to summary
protected final InputStream input

LEFT_ALT_PRESSED	back to summary
pack-priv static final int LEFT_ALT_PRESSED

LEFT_CTRL_PRESSED	back to summary
pack-priv static final int LEFT_CTRL_PRESSED

lock	back to summary
protected final Object lock

nativeHandlers	back to summary
protected final Map<Terminal.Signal, Object> nativeHandlers

NUMLOCK_ON	back to summary
pack-priv static final int NUMLOCK_ON

originalInConsoleMode	back to summary
protected final int originalInConsoleMode

originalOutConsoleMode	back to summary
protected final int originalOutConsoleMode

outConsole	back to summary
protected final Console outConsole

output	back to summary
protected final OutputStream output

paused	back to summary
protected boolean paused

provider	back to summary
private final TerminalProvider provider

pump	back to summary
protected Thread pump

reader	back to summary
protected final NonBlockingReader reader

RIGHT_ALT_PRESSED	back to summary
pack-priv static final int RIGHT_ALT_PRESSED

RIGHT_CTRL_PRESSED	back to summary
pack-priv static final int RIGHT_CTRL_PRESSED

SCROLLLOCK_ON	back to summary
pack-priv static final int SCROLLLOCK_ON

SHIFT_FLAG	back to summary
pack-priv static final int SHIFT_FLAG

SHIFT_PRESSED	back to summary
pack-priv static final int SHIFT_PRESSED

skipNextLf	back to summary
protected boolean skipNextLf

slaveInputPipe	back to summary
protected final Writer slaveInputPipe

systemStream	back to summary
private final SystemStream systemStream

tracking	back to summary
protected Terminal.MouseTracking tracking

TYPE_WINDOWS	back to summary
public static final String TYPE_WINDOWS

TYPE_WINDOWS_256_COLOR	back to summary
public static final String TYPE_WINDOWS_256_COLOR

TYPE_WINDOWS_CONEMU	back to summary
public static final String TYPE_WINDOWS_CONEMU

TYPE_WINDOWS_VTP	back to summary
public static final String TYPE_WINDOWS_VTP

UTF8_CODE_PAGE	back to summary
private static final int UTF8_CODE_PAGE

writer	back to summary
protected final PrintWriter writer

Constructor Detail

AbstractWindowsTerminal	back to summary
public AbstractWindowsTerminal(TerminalProvider provider, SystemStream systemStream, Writer writer, String name, String type, Charset encoding, boolean nativeSignals, Terminal.SignalHandler signalHandler, Console inConsole, int inConsoleMode, Console outConsole, int outConsoleMode, Function<InputStream, InputStream> inputStreamWrapper) throws IOException Annotations @SuppressWarnings:this-escape

AbstractWindowsTerminal

back to summary

public AbstractWindowsTerminal(TerminalProvider provider, SystemStream systemStream, Writer writer, String name, String type, Charset encoding, boolean nativeSignals, Terminal.SignalHandler signalHandler, Console inConsole, int inConsoleMode, Console outConsole, int outConsoleMode, Function<InputStream, InputStream> inputStreamWrapper) throws IOException

Annotations

@SuppressWarnings:this-escape

Method Detail

canPauseResume back to summary

public boolean canPauseResume()

Overrides jdk.internal.org.jline.terminal.impl.AbstractTerminal.canPauseResume.

Implements jdk.internal.org.jline.terminal.Terminal.canPauseResume.

Doc from jdk.internal.org.jline.terminal.Terminal.canPauseResume.

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

Annotations

@Override

ctrl	back to summary
protected int ctrl(char key)

doClose	back to summary
protected void doClose() throws IOException Overrides jdk.internal.org.jline.terminal.impl.AbstractTerminal.doClose.

getAttributes back to summary

public Attributes getAttributes()

Implements jdk.internal.org.jline.terminal.Terminal.getAttributes.

Doc from jdk.internal.org.jline.terminal.Terminal.getAttributes.

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

getConsoleMode	back to summary
protected abstract int getConsoleMode(Console console)

getEscapeSequence	back to summary
protected String getEscapeSequence(short keyCode, int keyState)

getProvider back to summary

public TerminalProvider getProvider()

Implements jdk.internal.org.jline.terminal.spi.TerminalExt.getProvider.

Doc from jdk.internal.org.jline.terminal.spi.TerminalExt.getProvider.

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

Annotations

@Override

getRawSequence	back to summary
protected String getRawSequence(InfoCmp.Capability cap)

getSystemStream back to summary

public SystemStream getSystemStream()

Implements jdk.internal.org.jline.terminal.spi.TerminalExt.getSystemStream.

Doc from jdk.internal.org.jline.terminal.spi.TerminalExt.getSystemStream.

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

Annotations

@Override

handle back to summary

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

Overrides jdk.internal.org.jline.terminal.impl.AbstractTerminal.handle.

Implements jdk.internal.org.jline.terminal.Terminal.handle.

Doc from jdk.internal.org.jline.terminal.Terminal.handle.

Registers a handler for the given Signal.

Note that the JVM does not easily allow catching the 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.

Annotations

@Override

hasFocusSupport back to summary

public boolean hasFocusSupport()

Overrides jdk.internal.org.jline.terminal.impl.AbstractTerminal.hasFocusSupport.

Implements jdk.internal.org.jline.terminal.Terminal.hasFocusSupport.

Doc from jdk.internal.org.jline.terminal.Terminal.hasFocusSupport.

Returns true if the terminal has support for focus tracking.

Annotations

@Override

input back to summary

public InputStream input()

Implements jdk.internal.org.jline.terminal.Terminal.input.

Doc from jdk.internal.org.jline.terminal.Terminal.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 the reader() instead.

Annotations

@Override

output back to summary

public OutputStream output()

Implements jdk.internal.org.jline.terminal.Terminal.output.

Doc from jdk.internal.org.jline.terminal.Terminal.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 the writer() instead.

Annotations

@Override

pause

back to summary

public void pause()

Overrides jdk.internal.org.jline.terminal.impl.AbstractTerminal.pause.

Implements jdk.internal.org.jline.terminal.Terminal.pause.

Doc from jdk.internal.org.jline.terminal.Terminal.pause.

Stop reading the input stream.

Annotations

@Override

pause

back to summary

public void pause(boolean wait) throws InterruptedException

Overrides jdk.internal.org.jline.terminal.impl.AbstractTerminal.pause.

Implements jdk.internal.org.jline.terminal.Terminal.pause.

Doc from jdk.internal.org.jline.terminal.Terminal.pause.

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

Annotations

@Override

Exceptions

InterruptedException:: if the call has been interrupted

paused

back to summary

public boolean paused()

Overrides jdk.internal.org.jline.terminal.impl.AbstractTerminal.paused.

Implements jdk.internal.org.jline.terminal.Terminal.paused.

Doc from jdk.internal.org.jline.terminal.Terminal.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.

Annotations

@Override

processConsoleInput

back to summary

protected abstract boolean processConsoleInput() throws IOException

Read a single input event from the input buffer and process it.

Returns:boolean

true if new input was generated from the event

Exceptions

IOException:: if anything wrong happens

processInputChar	back to summary
public void processInputChar(char c) throws IOException

processKeyEvent	back to summary
protected void processKeyEvent(final boolean isKeyDown, final short virtualKeyCode, char ch, final int controlKeyState) throws IOException

pump	back to summary
protected void pump()

reader back to summary

public NonBlockingReader reader()

Implements jdk.internal.org.jline.terminal.Terminal.reader.

Doc from jdk.internal.org.jline.terminal.Terminal.reader.

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

resume

back to summary

public void resume()

Overrides jdk.internal.org.jline.terminal.impl.AbstractTerminal.resume.

Implements jdk.internal.org.jline.terminal.Terminal.resume.

Doc from jdk.internal.org.jline.terminal.Terminal.resume.

Resume reading the input stream.

Annotations

@Override

setAttributes

back to summary

public void setAttributes(Attributes attr)

Implements jdk.internal.org.jline.terminal.Terminal.setAttributes.

Doc from jdk.internal.org.jline.terminal.Terminal.setAttributes.

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

setConsoleMode	back to summary
protected abstract void setConsoleMode(Console console, int mode)

setSize	back to summary
public void setSize(Size size) Implements jdk.internal.org.jline.terminal.Terminal.setSize.

trackFocus

back to summary

public boolean trackFocus(boolean tracking)

Overrides jdk.internal.org.jline.terminal.impl.AbstractTerminal.trackFocus.

Implements jdk.internal.org.jline.terminal.Terminal.trackFocus.

Doc from jdk.internal.org.jline.terminal.Terminal.trackFocus.

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.

Annotations

@Override

trackMouse back to summary

public boolean trackMouse(Terminal.MouseTracking tracking)

Overrides jdk.internal.org.jline.terminal.impl.AbstractTerminal.trackMouse.

Implements jdk.internal.org.jline.terminal.Terminal.trackMouse.

Doc from jdk.internal.org.jline.terminal.Terminal.trackMouse.

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 Capability#key_mouse to the input stream. When this character sequence is detected, the readMouseEvent() method can be called to actually read the corresponding mouse event.

Annotations

@Override

updateConsoleMode	back to summary
protected void updateConsoleMode()

writer back to summary

public PrintWriter writer()

Implements jdk.internal.org.jline.terminal.Terminal.writer.

Doc from jdk.internal.org.jline.terminal.Terminal.writer.

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

public abstract Class AbstractWindowsTerminal<Console>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail