Module io.xpipe.core

Package io.xpipe.core.process

Interface ShellDialect

public interface ShellDialect

Method Summary

Modifier and Type	Method	Description
String	addToPathVariableCommand(List<String> entries, boolean append)
default String	applyInitFileCommand(ShellControl sc)
String	assembleCommand(String command, Map<String,String> variables)
int	assignMissingExitCode()
String	changeTitleCommand(String newTitle)
String	clearDisplayCommand()
CommandControl	createFileExistsCommand(ShellControl sc, String file)
CommandControl	createScriptTextFileWriteCommand(ShellControl parent, String content, String file)
CommandControl	createStreamFileWriteCommand(ShellControl shellControl, String file, long totalBytes)
CommandControl	createTextFileWriteCommand(ShellControl parent, String content, String file)
CommandControl	deleteFileOrDirectory(ShellControl sc, String file)
ShellCapabilities	determineCapabilities()
Charset	determineCharset(ShellControl control)
CommandControl	directoryExists(ShellControl shellControl, String directory)
boolean	doesEchoInputByDefault()
String	environmentVariable(String name)
CommandControl	evaluateExpression(ShellControl shellControl, String s)
String	executeCommandWithShell(String cmd)
Optional<String>	executeRobustBootstrapOutputCommand(ShellControl shellControl, String original)
default String	fileArgument(FilePath s)
String	fileArgument(String s)
ShellDialectAskpass	getAskpass()
String	getCatchAllVariable()
default String	getCdCommand(String directory)
default String	getConcatenationOperator()
String	getDiscardOperator()
String	getDisplayName()
ShellDumbMode	getDumbMode()
String	getEchoCommand(String s, boolean toErrorStream)
String	getExecutableName()
CommandControl	getFileCopyCommand(ShellControl parent, String oldFile, String newFile)
CommandControl	getFileDeleteCommand(ShellControl parent, String file)
CommandControl	getFileMoveCommand(ShellControl parent, String oldFile, String newFile)
CommandControl	getFileReadCommand(ShellControl parent, String file)
CommandControl	getFileTouchCommand(ShellControl parent, String file)
String	getId()
ShellLaunchCommand	getLaunchCommand()
default String	getLicenseFeatureId()
String	getMkdirsCommand(String dirs)
NewLine	getNewLine()
default String	getNormalExitCommand()
CommandBuilder	getOpenScriptCommand(String file)
default String	getPassthroughExitCommand()
String	getPauseCommand()
default String	getPrintEnvironmentVariableCommand(String name)
String	getPrintExitCodeCommand(String id, String prefix, String suffix)
String	getPrintStartEchoCommand(String prefix)
String	getPrintVariableCommand(String name)
String	getPrintWorkingDirectoryCommand()
default StreamCharset	getScriptCharset()
String	getScriptFileEnding()
String	getSetEnvironmentVariableCommand(String variable, String value)
StreamCharset	getTextCharset()
String	getWhichCommand(String executable)
String	initFileName(ShellControl sc)
default boolean	isCompatibleTo(ShellDialect other)
default boolean	isSelectable()
CommandBuilder	launchAsnyc(CommandBuilder cmd)
Stream<FileEntry>	listFiles(FileSystem fs, ShellControl control, String dir)
Stream<String>	listRoots(ShellControl control)
String	literalArgument(String s)
String	nullStdin(String command)
String	prepareScriptContent(String content)
String	prepareTerminalEnvironmentCommands()
String	prepareTerminalInitFileOpenCommand(ShellDialect parentDialect, ShellControl sc, String file, boolean exit)
CommandControl	prepareUserTempDirectory(ShellControl shellControl, String directory)
CommandControl	printUsernameCommand(ShellControl shellControl)
CommandControl	queryFileSize(ShellControl shellControl, String file)
String	queryVersion(ShellControl shellControl)
String	quoteArgument(String s)
default boolean	requiresScript(String content)
CommandControl	resolveDirectory(ShellControl shellControl, String directory)
String	runScriptCommand(ShellControl parent, String file)
String	setSecretEnvironmentVariableCommand(ShellControl sc, String variable, SecretValue value)
String	sourceScriptCommand(ShellControl parent, String file)
CommandControl	symbolicLink(ShellControl sc, String linkFile, String targetFile)
String	terminalLauncherScript(UUID request, String name)
String	unsetEnvironmentVariableCommand(String var)

Method Details

unsetEnvironmentVariableCommand

String unsetEnvironmentVariableCommand(String var)

determineCapabilities

ShellCapabilities determineCapabilities()

launchAsnyc

CommandBuilder launchAsnyc(CommandBuilder cmd)

getLicenseFeatureId

default String getLicenseFeatureId()

terminalLauncherScript

String terminalLauncherScript(UUID request,
 String name)

getExecutableName

String getExecutableName()

isSelectable

default boolean isSelectable()

isCompatibleTo

default boolean isCompatibleTo(ShellDialect other)

getCatchAllVariable

String getCatchAllVariable()

queryVersion

String queryVersion(ShellControl shellControl)
             throws Exception

Throws:

Exception

queryFileSize

CommandControl queryFileSize(ShellControl shellControl,
 String file)

prepareUserTempDirectory

CommandControl prepareUserTempDirectory(ShellControl shellControl,
 String directory)

initFileName

String initFileName(ShellControl sc)
             throws Exception

Throws:

Exception

directoryExists

CommandControl directoryExists(ShellControl shellControl,
 String directory)

evaluateExpression

CommandControl evaluateExpression(ShellControl shellControl,
 String s)

resolveDirectory

CommandControl resolveDirectory(ShellControl shellControl,
 String directory)

literalArgument

String literalArgument(String s)

fileArgument

String fileArgument(String s)

fileArgument

default String fileArgument(FilePath s)

quoteArgument

String quoteArgument(String s)

prepareTerminalEnvironmentCommands

String prepareTerminalEnvironmentCommands()

addToPathVariableCommand

String addToPathVariableCommand(List<String> entries,
 boolean append)

applyInitFileCommand

default String applyInitFileCommand(ShellControl sc)
                             throws Exception

Throws:

Exception

changeTitleCommand

String changeTitleCommand(String newTitle)

createStreamFileWriteCommand

CommandControl createStreamFileWriteCommand(ShellControl shellControl,
 String file,
 long totalBytes)

getCdCommand

default String getCdCommand(String directory)

getScriptFileEnding

String getScriptFileEnding()

assembleCommand

String assembleCommand(String command,
 Map<String,String> variables)

listFiles

Stream<FileEntry> listFiles(FileSystem fs,
 ShellControl control,
 String dir)
                     throws Exception

Throws:

Exception

listRoots

Stream<String> listRoots(ShellControl control)
                  throws Exception

Throws:

Exception

getPauseCommand

String getPauseCommand()

prepareScriptContent

String prepareScriptContent(String content)

getPassthroughExitCommand

default String getPassthroughExitCommand()

getNormalExitCommand

default String getNormalExitCommand()

environmentVariable

String environmentVariable(String name)

getConcatenationOperator

default String getConcatenationOperator()

getDiscardOperator

String getDiscardOperator()

nullStdin

String nullStdin(String command)

getAskpass

ShellDialectAskpass getAskpass()

getSetEnvironmentVariableCommand

String getSetEnvironmentVariableCommand(String variable,
 String value)

setSecretEnvironmentVariableCommand

String setSecretEnvironmentVariableCommand(ShellControl sc,
 String variable,
 SecretValue value)
                                    throws Exception

Throws:

Exception

getEchoCommand

String getEchoCommand(String s,
 boolean toErrorStream)

getPrintVariableCommand

String getPrintVariableCommand(String name)

printUsernameCommand

CommandControl printUsernameCommand(ShellControl shellControl)

getPrintStartEchoCommand

String getPrintStartEchoCommand(String prefix)

executeRobustBootstrapOutputCommand

Optional<String> executeRobustBootstrapOutputCommand(ShellControl shellControl,
 String original)
                                              throws Exception

Throws:

Exception

getPrintExitCodeCommand

String getPrintExitCodeCommand(String id,
 String prefix,
 String suffix)

assignMissingExitCode

int assignMissingExitCode()

getPrintEnvironmentVariableCommand

default String getPrintEnvironmentVariableCommand(String name)

getOpenScriptCommand

CommandBuilder getOpenScriptCommand(String file)

prepareTerminalInitFileOpenCommand

String prepareTerminalInitFileOpenCommand(ShellDialect parentDialect,
 ShellControl sc,
 String file,
 boolean exit)

runScriptCommand

String runScriptCommand(ShellControl parent,
 String file)

sourceScriptCommand

String sourceScriptCommand(ShellControl parent,
 String file)

executeCommandWithShell

String executeCommandWithShell(String cmd)

getMkdirsCommand

String getMkdirsCommand(String dirs)

getFileReadCommand

CommandControl getFileReadCommand(ShellControl parent,
 String file)

getPrintWorkingDirectoryCommand

String getPrintWorkingDirectoryCommand()

getTextCharset

StreamCharset getTextCharset()

getScriptCharset

default StreamCharset getScriptCharset()

getFileCopyCommand

CommandControl getFileCopyCommand(ShellControl parent,
 String oldFile,
 String newFile)

getFileMoveCommand

CommandControl getFileMoveCommand(ShellControl parent,
 String oldFile,
 String newFile)

requiresScript

default boolean requiresScript(String content)

createTextFileWriteCommand

CommandControl createTextFileWriteCommand(ShellControl parent,
 String content,
 String file)

createScriptTextFileWriteCommand

CommandControl createScriptTextFileWriteCommand(ShellControl parent,
 String content,
 String file)

deleteFileOrDirectory

CommandControl deleteFileOrDirectory(ShellControl sc,
 String file)

clearDisplayCommand

String clearDisplayCommand()

getLaunchCommand

ShellLaunchCommand getLaunchCommand()

getDumbMode

ShellDumbMode getDumbMode()

createFileExistsCommand

CommandControl createFileExistsCommand(ShellControl sc,
 String file)

symbolicLink

CommandControl symbolicLink(ShellControl sc,
 String linkFile,
 String targetFile)

getFileDeleteCommand

CommandControl getFileDeleteCommand(ShellControl parent,
 String file)

getFileTouchCommand

CommandControl getFileTouchCommand(ShellControl parent,
 String file)

getWhichCommand

String getWhichCommand(String executable)

determineCharset

Charset determineCharset(ShellControl control)
                  throws Exception

Throws:

Exception

getNewLine

NewLine getNewLine()

getId

String getId()

getDisplayName

String getDisplayName()

doesEchoInputByDefault

boolean doesEchoInputByDefault()