Package org.jline.terminal.impl

Class AbstractWindowsTerminal<Console>

java.lang.Object

org.jline.terminal.impl.AbstractTerminal

org.jline.terminal.impl.AbstractWindowsTerminal<Console>

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable, TerminalExt, Terminal

public abstract class AbstractWindowsTerminal<Console>
extends AbstractTerminal

The AbstractWindowsTerminal is used as the base class for windows terminal. Due to windows limitations, mostly the missing support for ansi sequences, the only way to create a correct terminal is to use the windows api to set character attributes, move the cursor, erasing, etc... UTF-8 support is also lacking in windows and the code page supposed to emulate UTF-8 is a bit broken. In order to work around this broken code page, windows api WriteConsoleW is used directly. This means that the writer() becomes the primary output, while the output() is bridged to the writer() using a WriterOutputStream wrapper.

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 Attributes	attributes
protected final ShutdownHooks.Task	closer
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
static final int	ENABLE_VIRTUAL_TERMINAL_PROCESSING
protected static final int	ENABLE_WINDOW_INPUT
protected boolean	focusTracking
protected final Console	inConsole
protected final NonBlockingInputStream	input
protected final Object	lock
protected final Map<Terminal.Signal,Object>	nativeHandlers
protected final int	originalInConsoleMode
protected final int	originalOutConsoleMode
protected final Console	outConsole
protected final OutputStream	output
protected boolean	paused
protected Thread	pump
protected final NonBlockingReader	reader
protected boolean	skipNextLf
protected final Writer	slaveInputPipe
protected Terminal.MouseTracking	tracking
static final String	TYPE_WINDOWS
static final String	TYPE_WINDOWS_256_COLOR
static final String	TYPE_WINDOWS_CONEMU
static final String	TYPE_WINDOWS_VTP
protected final PrintWriter	writer

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

bools, encoding, handlers, ints, name, onClose, palette, status, strings, type

Fields inherited from interface org.jline.terminal.Terminal

TYPE_DUMB, TYPE_DUMB_COLOR

Constructor Summary

Constructors

Constructor	Description
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)

Method Summary

Modifier and Type	Method	Description
boolean	canPauseResume()	Whether this terminal supports Terminal.pause() and Terminal.resume() calls.
protected int	ctrl(char key)
protected void	doClose()
Attributes	getAttributes()	Returns the terminal attributes.
protected abstract int	getConsoleMode(Console console)
protected String	getEscapeSequence(short keyCode, int keyState)
TerminalProvider	getProvider()	Returns the TerminalProvider that created this terminal or null if the terminal was created with no provider.
protected String	getRawSequence(InfoCmp.Capability cap)
SystemStream	getSystemStream()	The underlying system stream, may be SystemStream.Output, SystemStream.Error, or null if this terminal is not bound to a system stream.
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.
InputStream	input()	Retrieve the input stream for this terminal.
OutputStream	output()	Retrieve the output stream for this terminal.
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.
protected abstract boolean	processConsoleInput()	Read a single input event from the input buffer and process it.
void	processInputChar(char c)
protected void	processKeyEvent(boolean isKeyDown, short virtualKeyCode, char ch, int controlKeyState)
protected void	pump()
NonBlockingReader	reader()	Retrieve the Reader for this terminal.
void	resume()	Resume reading the input stream.
void	setAttributes(Attributes attr)	Set the terminal attributes.
protected abstract void	setConsoleMode(Console console, int mode)
void	setSize(Size size)
boolean	trackFocus(boolean tracking)	Enable or disable focus tracking mode.
boolean	trackMouse(Terminal.MouseTracking tracking)	Change the mouse tracking mouse.
protected void	updateConsoleMode()
PrintWriter	writer()	Retrieve the Writer for this terminal.

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

checkInterrupted, close, echo, echo, echoSignal, encoding, enterRawMode, flush, getBooleanCapability, getCursorPosition, getKind, getName, getNumericCapability, getPalette, getStatus, getStatus, getStringCapability, getType, hasMouseSupport, parseInfoCmp, puts, raise, readMouseEvent, readMouseEvent, setOnClose, toString

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, getHeight, getSize, getWidth

Field Details

TYPE_WINDOWS

public static final String TYPE_WINDOWS

See Also:

• Constant Field Values

TYPE_WINDOWS_256_COLOR

public static final String TYPE_WINDOWS_256_COLOR

See Also:

• Constant Field Values

TYPE_WINDOWS_CONEMU

public static final String TYPE_WINDOWS_CONEMU

See Also:

• Constant Field Values

TYPE_WINDOWS_VTP

public static final String TYPE_WINDOWS_VTP

See Also:

• Constant Field Values

ENABLE_VIRTUAL_TERMINAL_PROCESSING

public static final int ENABLE_VIRTUAL_TERMINAL_PROCESSING

See Also:

• Constant Field Values

ENABLE_PROCESSED_INPUT

protected static final int ENABLE_PROCESSED_INPUT

See Also:

• Constant Field Values

ENABLE_LINE_INPUT

protected static final int ENABLE_LINE_INPUT

See Also:

• Constant Field Values

ENABLE_ECHO_INPUT

protected static final int ENABLE_ECHO_INPUT

See Also:

• Constant Field Values

ENABLE_WINDOW_INPUT

protected static final int ENABLE_WINDOW_INPUT

See Also:

• Constant Field Values

ENABLE_MOUSE_INPUT

protected static final int ENABLE_MOUSE_INPUT

See Also:

• Constant Field Values

ENABLE_INSERT_MODE

protected static final int ENABLE_INSERT_MODE

See Also:

• Constant Field Values

ENABLE_QUICK_EDIT_MODE

protected static final int ENABLE_QUICK_EDIT_MODE

See Also:

• Constant Field Values

ENABLE_EXTENDED_FLAGS

protected static final int ENABLE_EXTENDED_FLAGS

See Also:

• Constant Field Values

slaveInputPipe

protected final Writer slaveInputPipe

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

attributes

protected final Attributes attributes

inConsole

protected final Console inConsole

outConsole

protected final Console outConsole

originalInConsoleMode

protected final int originalInConsoleMode

originalOutConsoleMode

protected final int originalOutConsoleMode

lock

protected final Object lock

paused

protected boolean paused

pump

protected Thread pump

tracking

protected Terminal.MouseTracking tracking

focusTracking

protected boolean focusTracking

skipNextLf

protected boolean skipNextLf

Constructor Details

AbstractWindowsTerminal

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)
                        throws IOException

Throws:

IOException

Method Details

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

Overrides:

handle in class AbstractTerminal

Parameters:

signal - the signal to register a handler for

handler - the handler

Returns:

the previous signal handler

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.

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.

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.

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.

Returns:

The output stream

See Also:

• Terminal.writer()

getAttributes

public Attributes getAttributes()

Description copied from interface: Terminal

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

Returns:

the terminal attributes.

setAttributes

public void setAttributes(Attributes attr)

Description copied from interface: Terminal

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

Parameters:

attr - the new attributes

updateConsoleMode

protected void updateConsoleMode()

ctrl

protected int ctrl(char key)

setSize

public void setSize(Size size)

doClose

protected void doClose()
                throws IOException

Overrides:

doClose in class AbstractTerminal

Throws:

IOException

processKeyEvent

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

Throws:

IOException

getEscapeSequence

protected String getEscapeSequence(short keyCode,
 int keyState)

getRawSequence

protected String getRawSequence(InfoCmp.Capability cap)

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

Overrides:

hasFocusSupport in class AbstractTerminal

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

Overrides:

trackFocus in class AbstractTerminal

Parameters:

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

Returns:

true if focus tracking is supported

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

Overrides:

canPauseResume in class AbstractTerminal

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

Overrides:

pause in class AbstractTerminal

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

Overrides:

pause in class AbstractTerminal

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

Overrides:

resume in class AbstractTerminal

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

Overrides:

paused in class AbstractTerminal

Returns:

whether the terminal is currently reading the input stream or not

See Also:

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

pump

protected void pump()

processInputChar

public void processInputChar(char c)
                      throws IOException

Throws:

IOException

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

Overrides:

trackMouse in class AbstractTerminal

Parameters:

tracking - the mouse tracking mode

Returns:

true if mouse tracking is supported

getConsoleMode

protected abstract int getConsoleMode(Console console)

setConsoleMode

protected abstract void setConsoleMode(Console console,
 int mode)

processConsoleInput

protected abstract boolean processConsoleInput()
                                        throws IOException

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

Returns:

true if new input was generated from the event

Throws:

IOException - if anything wrong happens

getProvider

public TerminalProvider getProvider()

Description copied from interface: TerminalExt

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

getSystemStream

public SystemStream getSystemStream()

Description copied from interface: TerminalExt

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