Module io.xpipe.core

Package io.xpipe.core.process

Interface ShellDialect

public interface ShellDialect

Method Summary

Modifier and Type	Method	Description
void	addInlineVariablesToCommand(Map<String,String> variables, CommandBuilder command)
String	appendToPathVariableCommand(String entry)
default String	applyProfileFilesCommand()
default String	applyRcFileCommand()
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)
CommandControl	createTextFileWriteCommand(ShellControl parent, String content, String file)
CommandControl	deleteFileOrDirectory(ShellControl sc, String file)
Charset	determineCharset(ShellControl control)
CommandControl	directoryExists(ShellControl shellControl, String directory)
boolean	doesEchoInput()
String	environmentVariable(String name)
CommandControl	evaluateExpression(ShellControl shellControl, String s)
String	executeCommandWithShell(String cmd)
String	executeWithNoInitFiles(ShellDialect parentDialect, String file)
default void	exit(ShellControl sc)
String	fileArgument(String s)
static String	flatten(List<String> command)
String	getCatchAllVariable()
default String	getCdCommand(String directory)
default String	getConcatenationOperator()
String	getDisplayName()
default ShellDialect	getDumbReplacementDialect()
String	getEchoCommand(String s, boolean toErrorStream)
default String	getExitCommand()
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()
default String	getLoginOpenCommand()
String	getMkdirsCommand(String dirs)
NewLine	getNewLine()
String	getOpenCommand()
default String	getOrConcatenationOperator()
String	getPauseCommand()
default String	getPopdCommand()
default String	getPrintEnvironmentVariableCommand(String name)
String	getPrintExitCodeCommand(String prefix)
String	getPrintVariableCommand(String name)
String	getPrintWorkingDirectoryCommand()
default String	getPushdCommand(String directory)
StreamCharset	getScriptCharset()
String	getScriptFileEnding()
String	getScriptPermissionsCommand(String file)
String	getSetEnvironmentVariableCommand(String variable, String value)
String	getUsernameVariableName()
String	getWhichCommand(String executable)
String	initFileName(ShellControl sc)
default boolean	isCompatibleTo(ShellDialect other)
default boolean	isSelectable()
default boolean	isSupportedShell()
Stream<FileSystem.FileEntry>	listFiles(FileSystem fs, ShellControl control, String dir)
Stream<String>	listRoots(ShellControl control)
String	prepareAskpassContent(ShellControl sc, String fileName, List<String> s)
void	prepareDumbTerminalCommands(ShellControl sc)
String	prepareProperTerminalCommands()
String	prepareScriptContent(String content)
String	prepareTerminalInitFileOpenCommand(ShellDialect parentDialect, ShellControl sc, String file)
CommandControl	prepareUserTempDirectory(ShellControl shellControl, String directory)
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	runScriptSilentlyCommand(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)

Method Details

flatten

static String flatten(List<String> command)

isSupportedShell

default boolean isSupportedShell()

isSelectable

default boolean isSelectable()

isCompatibleTo

default boolean isCompatibleTo(ShellDialect other)

getDumbReplacementDialect

default ShellDialect getDumbReplacementDialect()

getCatchAllVariable

String getCatchAllVariable()

queryVersion

String queryVersion(ShellControl shellControl)
             throws Exception

Throws:

Exception

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)

fileArgument

String fileArgument(String s)

quoteArgument

String quoteArgument(String s)

executeWithNoInitFiles

String executeWithNoInitFiles(ShellDialect parentDialect,
 String file)

prepareDumbTerminalCommands

void prepareDumbTerminalCommands(ShellControl sc)
                          throws Exception

Throws:

Exception

prepareProperTerminalCommands

String prepareProperTerminalCommands()

appendToPathVariableCommand

String appendToPathVariableCommand(String entry)

applyRcFileCommand

default String applyRcFileCommand()

changeTitleCommand

String changeTitleCommand(String newTitle)

applyProfileFilesCommand

default String applyProfileFilesCommand()

createStreamFileWriteCommand

CommandControl createStreamFileWriteCommand(ShellControl shellControl,
 String file)

getCdCommand

default String getCdCommand(String directory)

getPushdCommand

default String getPushdCommand(String directory)

getPopdCommand

default String getPopdCommand()

getScriptFileEnding

String getScriptFileEnding()

addInlineVariablesToCommand

void addInlineVariablesToCommand(Map<String,String> variables,
 CommandBuilder command)

listFiles

Stream<FileSystem.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)

exit

default void exit(ShellControl sc)
           throws IOException

Throws:

IOException

getExitCommand

default String getExitCommand()

environmentVariable

String environmentVariable(String name)

getConcatenationOperator

default String getConcatenationOperator()

getOrConcatenationOperator

default String getOrConcatenationOperator()

getScriptPermissionsCommand

String getScriptPermissionsCommand(String file)

prepareAskpassContent

String prepareAskpassContent(ShellControl sc,
 String fileName,
 List<String> s)
                      throws Exception

Throws:

Exception

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)

getUsernameVariableName

String getUsernameVariableName()

getPrintExitCodeCommand

String getPrintExitCodeCommand(String prefix)

getPrintEnvironmentVariableCommand

default String getPrintEnvironmentVariableCommand(String name)

getOpenCommand

String getOpenCommand()

getLoginOpenCommand

default String getLoginOpenCommand()

prepareTerminalInitFileOpenCommand

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

runScriptCommand

String runScriptCommand(ShellControl parent,
 String file)

runScriptSilentlyCommand

String runScriptSilentlyCommand(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()

getScriptCharset

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()

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)

getNewLine

NewLine getNewLine()

getId

String getId()

getDisplayName

String getDisplayName()

doesEchoInput

boolean doesEchoInput()