jline
Class UnixTerminal

java.lang.Object
  jline.Terminal
      jline.UnixTerminal

All Implemented Interfaces:

ConsoleOperations

public class UnixTerminal

extends Terminal

Terminal that is used for unix platforms. Terminal initialization is handled by issuing the stty command against the /dev/tty file to disable character echoing and enable character input. All known unix systems (including Linux and Macintosh OS X) support the stty), so this implementation should work for an reasonable POSIX system.

Author:

Marc Prud'hommeaux, Updates Dale Kemp 2005-12-03

Field Summary

static short	ARROW_DOWN
static short	ARROW_LEFT
static short	ARROW_PREFIX
static short	ARROW_RIGHT
static short	ARROW_START
static short	ARROW_UP
static short	END_CODE
static short	HOME_CODE
private static java.lang.String	sttyCommand
private java.util.Map	terminfo

Fields inherited from class jline.Terminal

Fields inherited from interface jline.ConsoleOperations

ADD, BACKSPACE, CHANGE_CASE, CHANGE_META, CLEAR_SCREEN, COMPLETE, CR, CTRL_A, CTRL_B, CTRL_C, CTRL_D, CTRL_E, CTRL_F, CTRL_N, CTRL_P, DELETE_META, DELETE_NEXT_CHAR, DELETE_PREV_CHAR, DELETE_PREV_WORD, 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, SUBSTITUTE_CHAR, SUBSTITUTE_LINE, TO_END_WORD, TO_NEXT_CHAR, TO_PREV_CHAR, UNDO, UNKNOWN

Constructor Summary

UnixTerminal()

Method Summary

private void	consumeException(java.lang.Throwable e) No-op for exceptions we want to silently consume.
private static java.lang.String	exec(java.lang.String cmd) Execute the specified command and return the output (both stdout and stderr).
private static java.lang.String	exec(java.lang.String[] cmd) Execute the specified command and return the output (both stdout and stderr).
boolean	getEcho() Returns true if the terminal will echo all characters type.
static java.lang.String	getSttyCommand() The command to use to set the terminal options.
int	getTerminalHeight() Returns the value of "stty size" height param.
private static int	getTerminalProperty(java.lang.String prop)
int	getTerminalWidth() Returns the value of "stty size" width param.
void	initializeTerminal() Remove line-buffered input by invoking "stty -icanon min 1" against the current terminal.
boolean	isSupported() Returns true if this terminal is capable of initializing the terminal to use jline.
static void	main(java.lang.String[] args)
int	readVirtualKey(java.io.InputStream in) Reads a virtual key from the console.
static void	setSttyCommand(java.lang.String cmd) The command to use to set the terminal options.
private static java.lang.String	stty(java.lang.String args) Execute the stty command with the specified arguments against the current active terminal.

Methods inherited from class jline.Terminal

afterReadLine, beforeReadLine, getTerminal, isANSISupported, readCharacter, setupTerminal

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ARROW_START

public static final short ARROW_START

See Also:

Constant Field Values

ARROW_PREFIX

public static final short ARROW_PREFIX

See Also:

Constant Field Values

ARROW_LEFT

public static final short ARROW_LEFT

See Also:

Constant Field Values

ARROW_RIGHT

public static final short ARROW_RIGHT

See Also:

Constant Field Values

ARROW_UP

public static final short ARROW_UP

See Also:

Constant Field Values

ARROW_DOWN

public static final short ARROW_DOWN

See Also:

Constant Field Values

HOME_CODE

public static final short HOME_CODE

See Also:

Constant Field Values

END_CODE

public static final short END_CODE

See Also:

Constant Field Values

terminfo

private java.util.Map terminfo

sttyCommand

private static java.lang.String sttyCommand

Constructor Detail

UnixTerminal

public UnixTerminal()

Method Detail

initializeTerminal

public void initializeTerminal()
                        throws java.io.IOException,
                               java.lang.InterruptedException

Remove line-buffered input by invoking "stty -icanon min 1" against the current terminal.

Specified by:

initializeTerminal in class Terminal

Throws:

java.io.IOException

java.lang.InterruptedException

readVirtualKey

public int readVirtualKey(java.io.InputStream in)
                   throws java.io.IOException

Description copied from class: Terminal

Reads a virtual key from the console. Typically, this will just be the raw character that was entered, but in some cases, multiple input keys will need to be translated into a single virtual key.

Overrides:

readVirtualKey in class Terminal

Parameters:

in - the InputStream to read from

Returns:

the virtual key (e.g., ConsoleOperations#VK_UP)

Throws:

java.io.IOException

consumeException

private void consumeException(java.lang.Throwable e)

No-op for exceptions we want to silently consume.

isSupported

public boolean isSupported()

Description copied from class: Terminal

Returns true if this terminal is capable of initializing the terminal to use jline.

Specified by:

isSupported in class Terminal

getEcho

public boolean getEcho()

Description copied from class: Terminal

Returns true if the terminal will echo all characters type.

Specified by:

getEcho in class Terminal

getTerminalWidth

public int getTerminalWidth()

Returns the value of "stty size" width param. Note: this method caches the value from the first time it is called in order to increase speed, which means that changing to size of the terminal will not be reflected in the console.

Specified by:

getTerminalWidth in class Terminal

getTerminalHeight

public int getTerminalHeight()

Returns the value of "stty size" height param. Note: this method caches the value from the first time it is called in order to increase speed, which means that changing to size of the terminal will not be reflected in the console.

Specified by:

getTerminalHeight in class Terminal

getTerminalProperty

private static int getTerminalProperty(java.lang.String prop)
                                throws java.io.IOException,
                                       java.lang.InterruptedException

Throws:

java.io.IOException

java.lang.InterruptedException

stty

private static java.lang.String stty(java.lang.String args)
                              throws java.io.IOException,
                                     java.lang.InterruptedException

Execute the stty command with the specified arguments against the current active terminal.

Throws:

java.io.IOException

java.lang.InterruptedException

exec

private static java.lang.String exec(java.lang.String cmd)
                              throws java.io.IOException,
                                     java.lang.InterruptedException

Execute the specified command and return the output (both stdout and stderr).

Throws:

java.io.IOException

java.lang.InterruptedException

exec

private static java.lang.String exec(java.lang.String[] cmd)
                              throws java.io.IOException,
                                     java.lang.InterruptedException

Execute the specified command and return the output (both stdout and stderr).

Throws:

java.io.IOException

java.lang.InterruptedException

setSttyCommand

public static void setSttyCommand(java.lang.String cmd)

The command to use to set the terminal options. Defaults to "stty", or the value of the system property "jline.sttyCommand".

getSttyCommand

public static java.lang.String getSttyCommand()

The command to use to set the terminal options. Defaults to "stty", or the value of the system property "jline.sttyCommand".

main

public static void main(java.lang.String[] args)