org.eclipse.cdt.utils.pty

Class PTY

java.lang.Object

org.eclipse.cdt.utils.pty.PTY

public class PTY
extends Object

PTY - pseudo terminal support.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	PTY.MasterFD The master fd is used on two streams.

Constructor Summary

Constructors

Constructor and Description
PTY() Create PTY for use with Eclipse console.
PTY(boolean console) Create pseudo-terminal.

Method Summary

Modifier and Type	Method and Description
InputStream	getInputStream()
PTY.MasterFD	getMasterFD()
OutputStream	getOutputStream()
String	getSlaveName()
boolean	isConsole()
static boolean	isSupported()
void	setTerminalSize(int width, int height) Change terminal window size to given width and height.

Methods inherited from class java.lang.Object

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

Constructor Detail

PTY

public PTY()
    throws IOException

Create PTY for use with Eclipse console. Identical to PTY(true).

Throws:

IOException - if something goes wrong.

PTY

public PTY(boolean console)
    throws IOException

Create pseudo-terminal.

The provided flag indicates whether the pseudo terminal is used with the interactive Eclipse console:

• If true the terminal is configured with no echo and stderr is redirected to a pipe instead of the PTY.
• If false the terminal is configured with echo and stderr is connected to the PTY. This mode is best suited for use with a proper terminal emulation. Note that this mode might not be supported on all platforms. Known platforms which support this mode are: linux-x86, linux-x86_64, solaris-sparc, macosx.

Parameters:

console - whether terminal is used with Eclipse console

Throws:

IOException - if the PTY could not be created

Since:

5.2

Method Detail

getSlaveName

public String getSlaveName()

getMasterFD

public PTY.MasterFD getMasterFD()

isConsole

public final boolean isConsole()

Returns:

whether this pseudo terminal is for use with the Eclipse console.

getOutputStream

public OutputStream getOutputStream()

getInputStream

public InputStream getInputStream()

setTerminalSize

public final void setTerminalSize(int width,
                                  int height)

Change terminal window size to given width and height.

This should only be used when the pseudo terminal is configured for use with a terminal emulation, i.e. when isConsole() returns false.

Note: This method may not be supported on all platforms. Known platforms which support this method are: linux-x86, linux-x86_64, solaris-sparc, macosx.

Parameters:

width - the given width.

height - the given height.

isSupported

public static boolean isSupported()