org.jline.terminal.impl

Class AbstractWindowsTerminal

java.lang.Object

org.jline.terminal.impl.AbstractTerminal

org.jline.terminal.impl.AbstractWindowsTerminal

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable, Terminal

public abstract class AbstractWindowsTerminal
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 and Description
protected Attributes	attributes
protected ShutdownHooks.Task	closer
protected static int	ENABLE_ECHO_INPUT
protected static int	ENABLE_INSERT_MODE
protected static int	ENABLE_LINE_INPUT
protected static int	ENABLE_MOUSE_INPUT
protected static int	ENABLE_PROCESSED_INPUT
protected static int	ENABLE_QUICK_EDIT_MODE
protected static int	ENABLE_WINDOW_INPUT
protected InputStream	input
protected Map<Terminal.Signal,Object>	nativeHandlers
protected int	originalConsoleMode
protected OutputStream	output
protected Thread	pump
protected NonBlockingReader	reader
protected Writer	slaveInputPipe
protected Terminal.MouseTracking	tracking
static String	TYPE_WINDOWS
protected PrintWriter	writer

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

bools, encoding, handlers, ints, name, strings, type

Fields inherited from interface org.jline.terminal.Terminal

TYPE_DUMB

Constructor Summary

Constructors

Constructor and Description
AbstractWindowsTerminal(Writer writer, String name, Charset encoding, int codepage, boolean nativeSignals, Terminal.SignalHandler signalHandler)

Method Summary

Modifier and Type	Method and Description
void	close()
protected int	ctrl(char key)
Attributes	getAttributes()
protected abstract int	getConsoleMode()
protected abstract int	getConsoleOutputCP()
protected String	getEscapeSequence(short keyCode, int keyState)
protected String	getRawSequence(InfoCmp.Capability cap)
protected String	getSequence(InfoCmp.Capability cap)
Terminal.SignalHandler	handle(Terminal.Signal signal, Terminal.SignalHandler handler)
InputStream	input()
OutputStream	output()
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()
void	setAttributes(Attributes attr)
protected abstract void	setConsoleMode(int mode)
void	setSize(Size size)
boolean	trackMouse(Terminal.MouseTracking tracking) Change the mouse tracking mouse.
protected void	updateConsoleMode()
PrintWriter	writer()

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

echo, echo, echoSignal, encoding, enterRawMode, flush, getBooleanCapability, getCursorPosition, getKind, getName, getNumericCapability, getStringCapability, getType, hasMouseSupport, parseInfoCmp, puts, raise, readMouseEvent, readMouseEvent

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

getHeight, getSize, getWidth

Field Detail

TYPE_WINDOWS

public static final String TYPE_WINDOWS

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

slaveInputPipe

protected final Writer slaveInputPipe

input

protected final InputStream 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

pump

protected final Thread pump

originalConsoleMode

protected final int originalConsoleMode

tracking

protected Terminal.MouseTracking tracking

Constructor Detail

AbstractWindowsTerminal

public AbstractWindowsTerminal(Writer writer,
                               String name,
                               Charset encoding,
                               int codepage,
                               boolean nativeSignals,
                               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

Overrides:

handle in class AbstractTerminal

reader

public NonBlockingReader reader()

writer

public PrintWriter writer()

input

public InputStream input()

output

public OutputStream output()

getAttributes

public Attributes getAttributes()

setAttributes

public void setAttributes(Attributes attr)

updateConsoleMode

protected void updateConsoleMode()

ctrl

protected int ctrl(char key)

setSize

public void setSize(Size size)

close

public void close()
           throws IOException

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)

getSequence

protected String getSequence(InfoCmp.Capability cap)

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

getConsoleOutputCP

protected abstract int getConsoleOutputCP()

getConsoleMode

protected abstract int getConsoleMode()

setConsoleMode

protected abstract void setConsoleMode(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