Package org.jline.terminal.impl.jna.win

Class JnaWinSysTerminal

java.lang.Object

org.jline.terminal.impl.AbstractTerminal

org.jline.terminal.impl.AbstractWindowsTerminal

org.jline.terminal.impl.jna.win.JnaWinSysTerminal

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable, Terminal

public class JnaWinSysTerminal
extends AbstractWindowsTerminal

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
private static final com.sun.jna.Pointer	consoleIn
private static final com.sun.jna.Pointer	consoleOut
private final com.sun.jna.ptr.IntByReference	eventsRead
private char[]	focus
private final Kernel32.INPUT_RECORD[]	inputEvents
private char[]	mouse

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

attributes, closer, ENABLE_ECHO_INPUT, ENABLE_INSERT_MODE, ENABLE_LINE_INPUT, ENABLE_MOUSE_INPUT, ENABLE_PROCESSED_INPUT, ENABLE_QUICK_EDIT_MODE, ENABLE_VIRTUAL_TERMINAL_PROCESSING, ENABLE_WINDOW_INPUT, focusTracking, input, lock, nativeHandlers, originalConsoleMode, output, paused, pump, reader, slaveInputPipe, tracking, TYPE_WINDOWS, TYPE_WINDOWS_256_COLOR, TYPE_WINDOWS_CONEMU, TYPE_WINDOWS_VTP, 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
JnaWinSysTerminal(Writer writer, String name, String type, Charset encoding, int codepage, boolean nativeSignals, Terminal.SignalHandler signalHandler)

Method Summary

Modifier and Type	Method	Description
static JnaWinSysTerminal	createTerminal(String name, String type, boolean ansiPassThrough, Charset encoding, int codepage, boolean nativeSignals, Terminal.SignalHandler signalHandler, boolean paused)
Size	getBufferSize()	Retrieve the size of the window buffer.
protected int	getConsoleMode()
Cursor	getCursorPosition(IntConsumer discarded)	Query the terminal to report the cursor position.
Size	getSize()	Retrieve the size of the visible window
static boolean	isConsoleInput()
static boolean	isConsoleOutput()
static boolean	isWindowsConsole()
protected boolean	processConsoleInput()	Read a single input event from the input buffer and process it.
private void	processFocusEvent(boolean hasFocus)
private void	processKeyEvent(Kernel32.KEY_EVENT_RECORD keyEvent)
private void	processMouseEvent(Kernel32.MOUSE_EVENT_RECORD mouseEvent)
private Kernel32.INPUT_RECORD	readConsoleInput(int dwMilliseconds)
protected void	setConsoleMode(int mode)

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

canPauseResume, ctrl, doClose, getAttributes, getEscapeSequence, getRawSequence, handle, hasFocusSupport, input, output, pause, pause, paused, processInputChar, processKeyEvent, pump, reader, resume, setAttributes, setSize, trackFocus, trackMouse, updateConsoleMode, writer

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

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

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

Field Details

consoleIn

private static final com.sun.jna.Pointer consoleIn

consoleOut

private static final com.sun.jna.Pointer consoleOut

focus

private char[] focus

mouse

private char[] mouse

inputEvents

private final Kernel32.INPUT_RECORD[] inputEvents

eventsRead

private final com.sun.jna.ptr.IntByReference eventsRead

Constructor Details

JnaWinSysTerminal

JnaWinSysTerminal(Writer writer,
 String name,
 String type,
 Charset encoding,
 int codepage,
 boolean nativeSignals,
 Terminal.SignalHandler signalHandler)
           throws IOException

Throws:

IOException

Method Details

createTerminal

public static JnaWinSysTerminal createTerminal(String name,
 String type,
 boolean ansiPassThrough,
 Charset encoding,
 int codepage,
 boolean nativeSignals,
 Terminal.SignalHandler signalHandler,
 boolean paused)
                                        throws IOException

Throws:

IOException

isWindowsConsole

public static boolean isWindowsConsole()

isConsoleOutput

public static boolean isConsoleOutput()

isConsoleInput

public static boolean isConsoleInput()

getConsoleMode

protected int getConsoleMode()

Specified by:

getConsoleMode in class AbstractWindowsTerminal

setConsoleMode

protected void setConsoleMode(int mode)

Specified by:

setConsoleMode in class AbstractWindowsTerminal

getSize

public Size getSize()

Description copied from interface: Terminal

Retrieve the size of the visible window

Returns:

the visible terminal size

See Also:

• Terminal.getBufferSize()

getBufferSize

public Size getBufferSize()

Description copied from interface: Terminal

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. The getBufferSize() method can be used to avoid wrapping when using the terminal in a line editing mode, while the Terminal.getSize() method should be used when using full screen mode.

Returns:

the terminal buffer size

See Also:

• Terminal.getSize()

processConsoleInput

protected boolean processConsoleInput()
                               throws IOException

Description copied from class: AbstractWindowsTerminal

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

Specified by:

processConsoleInput in class AbstractWindowsTerminal

Returns:

true if new input was generated from the event

Throws:

IOException - if anything wrong happens

processKeyEvent

private void processKeyEvent(Kernel32.KEY_EVENT_RECORD keyEvent)
                      throws IOException

Throws:

IOException

processFocusEvent

private void processFocusEvent(boolean hasFocus)
                        throws IOException

Throws:

IOException

processMouseEvent

private void processMouseEvent(Kernel32.MOUSE_EVENT_RECORD mouseEvent)
                        throws IOException

Throws:

IOException

readConsoleInput

private Kernel32.INPUT_RECORD readConsoleInput(int dwMilliseconds)
                                        throws IOException

Throws:

IOException

getCursorPosition

public Cursor getCursorPosition(IntConsumer discarded)

Description copied from interface: Terminal

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 using org.jline.keymap.BindingReader#runMacro(String)

Specified by:

getCursorPosition in interface Terminal

Overrides:

getCursorPosition in class AbstractTerminal

Parameters:

discarded - a consumer receiving discarded characters

Returns:

null if cursor position reporting is not supported or a valid cursor position