Package com.intellij.execution.configurations

Class PtyCommandLine

java.lang.Object

com.intellij.execution.configurations.GeneralCommandLine

com.intellij.execution.configurations.PtyCommandLine

All Implemented Interfaces:

UserDataHolder

public class PtyCommandLine
extends GeneralCommandLine

A flavor of GeneralCommandLine to start processes with Pseudo-Terminal (PTY). Warning: PtyCommandLine works with ProcessHandler only in blocking read mode. Please make sure that you use appropriate ProcessHandler implementation. Works for Linux, macOS, and Windows. On Windows, PTY is emulated by creating an invisible console window (see Pty4j and WinPty implementation).

Nested Class Summary

Nested classes/interfaces inherited from class com.intellij.execution.configurations.GeneralCommandLine

GeneralCommandLine.ParentEnvironmentType

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_COLUMNS

Constructor Summary

Constructors

Constructor and Description
PtyCommandLine()
PtyCommandLine(GeneralCommandLine original)
PtyCommandLine(java.util.List<java.lang.String> command)

Method Summary

Modifier and Type	Method and Description
boolean	isConsoleMode()
static boolean	isEnabled()
void	setConsoleMode(boolean consoleMode) Deprecated. use withConsoleMode(boolean)
void	setInitialColumns(int initialColumns) Deprecated. use withInitialColumns(int)
void	setInitialRows(int initialRows) Deprecated. use withInitialRows(int)
void	setUseCygwinLaunch(boolean useCygwinLaunch) Deprecated. use withUseCygwinLaunch(boolean)
protected java.lang.Process	startProcess(java.util.List<java.lang.String> commands)
java.lang.Process	startProcessWithPty(java.util.List<java.lang.String> commands)
PtyCommandLine	withConsoleMode(boolean consoleMode)
PtyCommandLine	withInitialColumns(int initialColumns)
PtyCommandLine	withInitialRows(int initialRows)
PtyCommandLine	withUseCygwinLaunch(boolean useCygwinLaunch)

Methods inherited from class com.intellij.execution.configurations.GeneralCommandLine

addParameter, addParameters, addParameters, buildProcess, createProcess, getCharset, getCommandLineList, getCommandLineString, getCommandLineString, getEffectiveEnvironment, getEnvironment, getExePath, getInputFile, getParametersList, getParentEnvironment, getParentEnvironmentType, getPreparedCommandLine, getPreparedCommandLine, getUserData, getWorkDirectory, inescapableQuote, isPassParentEnvironment, isRedirectErrorStream, prepareCommandLine, putUserData, setCharset, setExePath, setPassParentEnvironment, setRedirectErrorStream, setupEnvironment, setWorkDirectory, setWorkDirectory, toString, withCharset, withEnvironment, withEnvironment, withExePath, withInput, withParameters, withParameters, withParentEnvironmentType, withRedirectErrorStream, withWorkDirectory, withWorkDirectory

Methods inherited from class java.lang.Object

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

Field Detail

MAX_COLUMNS

public static final int MAX_COLUMNS

See Also:

Constant Field Values

Constructor Detail

PtyCommandLine

public PtyCommandLine()

PtyCommandLine

public PtyCommandLine(java.util.List<java.lang.String> command)

PtyCommandLine

public PtyCommandLine(GeneralCommandLine original)

Method Detail

isEnabled

public static boolean isEnabled()

setUseCygwinLaunch

@Deprecated
public void setUseCygwinLaunch(boolean useCygwinLaunch)

Deprecated. use withUseCygwinLaunch(boolean)

setConsoleMode

@Deprecated
public void setConsoleMode(boolean consoleMode)

Deprecated. use withConsoleMode(boolean)

setInitialColumns

@Deprecated
public void setInitialColumns(int initialColumns)

Deprecated. use withInitialColumns(int)

setInitialRows

@Deprecated
public void setInitialRows(int initialRows)

Deprecated. use withInitialRows(int)

withUseCygwinLaunch

public PtyCommandLine withUseCygwinLaunch(boolean useCygwinLaunch)

withConsoleMode

public PtyCommandLine withConsoleMode(boolean consoleMode)

isConsoleMode

public boolean isConsoleMode()

withInitialColumns

public PtyCommandLine withInitialColumns(int initialColumns)

withInitialRows

public PtyCommandLine withInitialRows(int initialRows)

startProcess

protected java.lang.Process startProcess(java.util.List<java.lang.String> commands)
                                  throws java.io.IOException

Overrides:

startProcess in class GeneralCommandLine

Throws:

java.io.IOException

startProcessWithPty

public java.lang.Process startProcessWithPty(java.util.List<java.lang.String> commands)
                                      throws java.io.IOException

Throws:

java.io.IOException