Class CygwinTerminal

java.lang.Object

com.googlecode.lanterna.terminal.AbstractTerminal

com.googlecode.lanterna.terminal.ansi.StreamBasedTerminal

com.googlecode.lanterna.terminal.ansi.ANSITerminal

com.googlecode.lanterna.terminal.ansi.UnixLikeTerminal

com.googlecode.lanterna.terminal.ansi.UnixLikeTTYTerminal

com.googlecode.lanterna.terminal.ansi.CygwinTerminal

All Implemented Interfaces:

Scrollable, InputProvider, ExtendedTerminal, Terminal, Closeable, AutoCloseable

public class CygwinTerminal
extends UnixLikeTTYTerminal

This class extends UnixLikeTerminal and implements the Cygwin-specific implementations. This means, running a Java application using Lanterna inside the Cygwin Terminal application. The standard Windows command prompt (cmd.exe) is not supported by this class.

NOTE: This class is experimental and does not fully work! Some of the operations, like disabling echo and changing cbreak seems to be impossible to do without resorting to native code. Running "stty raw" before starting the JVM will improve compatibility.

NOTE: This class will try to find Cygwin by scanning the directories on java.library.path, but you can also tell it where Cygwin is installed by setting the CYGWIN_HOME environment variable.

Nested Class Summary

Nested classes/interfaces inherited from class UnixLikeTerminal

UnixLikeTerminal.CtrlCBehaviour

Field Summary

Fields

Modifier and Type	Field	Description
private static final String	CYGWIN_HOME_ENV
private static final String	JAVA_LIBRARY_PATH_PROPERTY
private static final String	STTY_LOCATION
private static final Pattern	STTY_SIZE_PATTERN

Constructor Summary

Constructors

Constructor	Description
CygwinTerminal(InputStream terminalInput, OutputStream terminalOutput, Charset terminalCharset)	Creates a new CygwinTerminal based off input and output streams and a character set to use

Method Summary

Modifier and Type	Method	Description
protected void	acquire()	Effectively taking over the terminal and enabling it for Lanterna to use, by turning off echo and canonical mode, adding resize listeners and optionally trap unix signals.
private static String	findProgram(String programName)
private String	findSTTY()
protected TerminalSize	findTerminalSize()
private String	getPseudoTerminalDevice()
protected String	runSTTYCommand(String... parameters)

Methods inherited from class UnixLikeTTYTerminal

canonicalMode, exec, keyEchoEnabled, keyStrokeSignalsEnabled, registerTerminalResizeListener, restoreTerminalSettings, saveTerminalSettings

Methods inherited from class UnixLikeTerminal

close, getTerminalCtrlCBehaviour, pollInput, readInput

Methods inherited from class ANSITerminal

clearScreen, deiconify, disableSGR, enableSGR, enterPrivateMode, exitPrivateMode, getCursorPosition, getDefaultKeyDecodingProfile, getTerminalSize, iconify, isInPrivateMode, maximize, popTitle, pushTitle, reportPosition, resetColorAndSGR, restoreCursorPosition, saveCursorPosition, scrollLines, setBackgroundColor, setCursorPosition, setCursorPosition, setCursorVisible, setForegroundColor, setMouseCaptureMode, setTerminalSize, setTitle, unmaximize

Methods inherited from class StreamBasedTerminal

bell, enquireTerminal, flush, getCharset, getInputDecoder, putCharacter, putString, resetMemorizedCursorPosition, translateCharacter, waitForCursorPositionReport, writeToTerminal

Methods inherited from class AbstractTerminal

addResizeListener, newTextGraphics, onResized, onResized, removeResizeListener

Methods inherited from class Object

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

Methods inherited from interface Terminal

addResizeListener, bell, enquireTerminal, flush, newTextGraphics, putCharacter, putString, removeResizeListener

Field Details

STTY_LOCATION

private static final String STTY_LOCATION

STTY_SIZE_PATTERN

private static final Pattern STTY_SIZE_PATTERN

JAVA_LIBRARY_PATH_PROPERTY

private static final String JAVA_LIBRARY_PATH_PROPERTY

See Also:

• Constant Field Values

CYGWIN_HOME_ENV

private static final String CYGWIN_HOME_ENV

See Also:

• Constant Field Values

Constructor Details

CygwinTerminal

public CygwinTerminal(InputStream terminalInput,
 OutputStream terminalOutput,
 Charset terminalCharset)
               throws IOException

Creates a new CygwinTerminal based off input and output streams and a character set to use

Parameters:

terminalInput - Input stream to read input from

terminalOutput - Output stream to write output to

terminalCharset - Character set to use when writing to the output stream

Throws:

IOException - If there was an I/O error when trying to initialize the class and setup the terminal

Method Details

findTerminalSize

protected TerminalSize findTerminalSize()

Overrides:

findTerminalSize in class ANSITerminal

runSTTYCommand

protected String runSTTYCommand(String... parameters)
                         throws IOException

Overrides:

runSTTYCommand in class UnixLikeTTYTerminal

Throws:

IOException

acquire

protected void acquire()
                throws IOException

Description copied from class: UnixLikeTerminal

Effectively taking over the terminal and enabling it for Lanterna to use, by turning off echo and canonical mode, adding resize listeners and optionally trap unix signals. This should be called automatically by the constructor of any end-user class extending from UnixLikeTerminal

Overrides:

acquire in class UnixLikeTTYTerminal

Throws:

IOException - If there was an I/O error

findSTTY

private String findSTTY()

getPseudoTerminalDevice

private String getPseudoTerminalDevice()

findProgram

private static String findProgram(String programName)