jline

Class WindowsTerminal

Implemented Interfaces:
ConsoleOperations

public class WindowsTerminal
extends Terminal

Terminal implementation for Microsoft Windows. Terminal initialization in initializeTerminal() is accomplished by extracting the jline_version.dll, saving it to the system temporary directoy (determined by the setting of the java.io.tmpdir System property), loading the library, and then calling the Win32 APIs SetConsoleMode and GetConsoleMode to disable character echoing.

By default, the readCharacter(InputStream) method will attempt to test to see if the specified InputStream is System.in or a wrapper around FileDescriptor.in, and if so, will bypass the character reading to directly invoke the readc() method in the JNI library. This is so the class can read special keys (like arrow keys) which are otherwise inaccessible via the System.in stream. Using JNI reading can be bypassed by setting the jline.WindowsTerminal.disableDirectConsole system property to true.

Author:
Marc Prud'hommeaux

Field Summary

static int
DELETE_KEY
When following the SPECIAL_KEY_INDICATOR or NUMPAD_KEY_INDICATOR this character indicates that the delete key was pressed.
static int
DOWN_ARROW_KEY
When following the SPECIAL_KEY_INDICATOR or NUMPAD_KEY_INDICATOR this character indicates an down arrow key press.
static char
END_KEY
When following the SPECIAL_KEY_INDICATOR or NUMPAD_KEY_INDICATOR this character indicates that the end key was pressed.
static char
ESCAPE_KEY
When following the SPECIAL_KEY_INDICATOR or NUMPAD_KEY_INDICATOR, this character indicates that the escape key was pressed.
static int
HOME_KEY
When following the SPECIAL_KEY_INDICATOR or NUMPAD_KEY_INDICATOR this character indicates that the home key was pressed.
static char
INSERT_KEY
When following the SPECIAL_KEY_INDICATOR or NUMPAD_KEY_INDICATOR this character indicates that the insert key was pressed.
static int
LEFT_ARROW_KEY
When following the SPECIAL_KEY_INDICATOR or NUMPAD_KEY_INDICATOR, this character indicates an left arrow key press.
static int
NUMPAD_KEY_INDICATOR
On windows terminals, this character indicates that a special key on the number pad has been pressed.
static char
PAGE_DOWN_KEY
When following the SPECIAL_KEY_INDICATOR or NUMPAD_KEY_INDICATOR this character indicates that the page down key was pressed.
static char
PAGE_UP_KEY
When following the SPECIAL_KEY_INDICATOR or NUMPAD_KEY_INDICATOR this character indicates that the page up key was pressed.
static int
RIGHT_ARROW_KEY
When following the SPECIAL_KEY_INDICATOR or NUMPAD_KEY_INDICATOR this character indicates an right arrow key press.
static int
SPECIAL_KEY_INDICATOR
On windows terminals, this character indicates that a 'special' key has been pressed.
static int
UP_ARROW_KEY
When following the SPECIAL_KEY_INDICATOR or NUMPAD_KEY_INDICATOR this character indicates an up arrow key press.

Fields inherited from interface jline.ConsoleOperations

ADD, BACKSPACE, CHANGE_CASE, CHANGE_META, CLEAR_LINE, CLEAR_SCREEN, COMPLETE, CR, CTRL_A, CTRL_B, CTRL_C, CTRL_D, CTRL_E, CTRL_F, CTRL_K, CTRL_L, CTRL_N, CTRL_OB, CTRL_P, CTRL_QM, DELETE, DELETE_META, DELETE_NEXT_CHAR, DELETE_PREV_CHAR, DELETE_PREV_WORD, END_OF_HISTORY, END_WORD, EXIT, INSERT, KEYBOARD_BELL, KILL_LINE, KILL_LINE_PREV, MOVE_TO_BEG, MOVE_TO_END, NEWLINE, NEXT_CHAR, NEXT_HISTORY, NEXT_SPACE_WORD, NEXT_WORD, PASTE, PASTE_NEXT, PASTE_PREV, PREV_CHAR, PREV_HISTORY, PREV_SPACE_WORD, PREV_WORD, REDISPLAY, REPEAT_NEXT_CHAR, REPEAT_PREV_CHAR, REPEAT_SEARCH_NEXT, REPEAT_SEARCH_PREV, REPLACE_CHAR, REPLACE_MODE, RESET_LINE, SEARCH_NEXT, SEARCH_PREV, START_OF_HISTORY, SUBSTITUTE_CHAR, SUBSTITUTE_LINE, TO_END_WORD, TO_NEXT_CHAR, TO_PREV_CHAR, UNDO, UNKNOWN

Constructor Summary

WindowsTerminal()

Method Summary

void
disableEcho()
void
enableEcho()
InputStream
getDefaultBindings()
Boolean
getDirectConsole()
Whether or not to allow the use of the JNI console interaction.
boolean
getEcho()
int
getTerminalHeight()
Unsupported; return the default.
int
getTerminalWidth()
Unsupported; return the default.
void
initializeTerminal()
boolean
isANSISupported()
Windows doesn't support ANSI codes by default; disable them.
boolean
isEchoEnabled()
boolean
isSupported()
int
readCharacter(InputStream in)
int
readVirtualKey(InputStream in)
void
setDirectConsole(Boolean directConsole)
Whether or not to allow the use of the JNI console interaction.

Methods inherited from class jline.Terminal

afterReadLine, beforeReadLine, disableEcho, enableEcho, getDefaultBindings, getEcho, getTerminal, getTerminalHeight, getTerminalWidth, initializeTerminal, isANSISupported, isEchoEnabled, isSupported, readCharacter, readVirtualKey, resetTerminal, setupTerminal

Field Details

DELETE_KEY

public static final int DELETE_KEY
When following the SPECIAL_KEY_INDICATOR or NUMPAD_KEY_INDICATOR this character indicates that the delete key was pressed.
Field Value:
83

DOWN_ARROW_KEY

public static final int DOWN_ARROW_KEY
When following the SPECIAL_KEY_INDICATOR or NUMPAD_KEY_INDICATOR this character indicates an down arrow key press.
Field Value:
80

END_KEY

public static final char END_KEY
When following the SPECIAL_KEY_INDICATOR or NUMPAD_KEY_INDICATOR this character indicates that the end key was pressed.
Field Value:
'O'

ESCAPE_KEY

public static final char ESCAPE_KEY
When following the SPECIAL_KEY_INDICATOR or NUMPAD_KEY_INDICATOR, this character indicates that the escape key was pressed.
Field Value:
'\u0000'

HOME_KEY

public static final int HOME_KEY
When following the SPECIAL_KEY_INDICATOR or NUMPAD_KEY_INDICATOR this character indicates that the home key was pressed.
Field Value:
71

INSERT_KEY

public static final char INSERT_KEY
When following the SPECIAL_KEY_INDICATOR or NUMPAD_KEY_INDICATOR this character indicates that the insert key was pressed.
Field Value:
'R'

LEFT_ARROW_KEY

public static final int LEFT_ARROW_KEY
When following the SPECIAL_KEY_INDICATOR or NUMPAD_KEY_INDICATOR, this character indicates an left arrow key press.
Field Value:
75

NUMPAD_KEY_INDICATOR

public static final int NUMPAD_KEY_INDICATOR
On windows terminals, this character indicates that a special key on the number pad has been pressed.
Field Value:
0

PAGE_DOWN_KEY

public static final char PAGE_DOWN_KEY
When following the SPECIAL_KEY_INDICATOR or NUMPAD_KEY_INDICATOR this character indicates that the page down key was pressed.
Field Value:
'Q'

PAGE_UP_KEY

public static final char PAGE_UP_KEY
When following the SPECIAL_KEY_INDICATOR or NUMPAD_KEY_INDICATOR this character indicates that the page up key was pressed.
Field Value:
'I'

RIGHT_ARROW_KEY

public static final int RIGHT_ARROW_KEY
When following the SPECIAL_KEY_INDICATOR or NUMPAD_KEY_INDICATOR this character indicates an right arrow key press.
Field Value:
77

SPECIAL_KEY_INDICATOR

public static final int SPECIAL_KEY_INDICATOR
On windows terminals, this character indicates that a 'special' key has been pressed. This means that a key such as an arrow key, or delete, or home, etc. will be indicated by the next character.
Field Value:
224

UP_ARROW_KEY

public static final int UP_ARROW_KEY
When following the SPECIAL_KEY_INDICATOR or NUMPAD_KEY_INDICATOR this character indicates an up arrow key press.
Field Value:
72

Constructor Details

WindowsTerminal

public WindowsTerminal()

Method Details

disableEcho

public void disableEcho()
Overrides:
disableEcho in interface Terminal

enableEcho

public void enableEcho()
Overrides:
enableEcho in interface Terminal

getDefaultBindings

public InputStream getDefaultBindings()
Overrides:
getDefaultBindings in interface Terminal

getDirectConsole

public Boolean getDirectConsole()
Whether or not to allow the use of the JNI console interaction.

getEcho

public boolean getEcho()
Overrides:
getEcho in interface Terminal

getTerminalHeight

public int getTerminalHeight()
Unsupported; return the default.
Overrides:
getTerminalHeight in interface Terminal

getTerminalWidth

public int getTerminalWidth()
Unsupported; return the default.
Overrides:
getTerminalWidth in interface Terminal

initializeTerminal

public void initializeTerminal()
            throws Exception
Overrides:
initializeTerminal in interface Terminal

isANSISupported

public boolean isANSISupported()
Windows doesn't support ANSI codes by default; disable them.
Overrides:
isANSISupported in interface Terminal

isEchoEnabled

public boolean isEchoEnabled()
Overrides:
isEchoEnabled in interface Terminal

isSupported

public boolean isSupported()
Overrides:
isSupported in interface Terminal

readCharacter

public int readCharacter(InputStream in)
            throws IOException
Overrides:
readCharacter in interface Terminal

readVirtualKey

public int readVirtualKey(InputStream in)
            throws IOException
Overrides:
readVirtualKey in interface Terminal

setDirectConsole

public void setDirectConsole(Boolean directConsole)
Whether or not to allow the use of the JNI console interaction.