Class InteractiveShell

Inheritance
object
InteractiveShell
Implements
Inherited Members
Namespace: SociallyDistant.Core.Core.Scripting
Assembly: SociallyDistant.Framework.dll
Syntax
public class InteractiveShell : ITerminalProcessController, ICommandShell, IAutoCompleteSource, IScriptExecutionContext

Constructors

InteractiveShell(IScriptExecutionContext)

Declaration
public InteractiveShell(IScriptExecutionContext context)
Parameters
Type Name Description
IScriptExecutionContext context

Properties

FileSystem

Gets a reference to the shell's file system. If null, glob patterns won't be expanded.

Declaration
public IVirtualFileSystem? FileSystem { get; }
Property Value
Type Description
IVirtualFileSystem

HandleExceptionsGracefully

Declaration
public bool HandleExceptionsGracefully { get; set; }
Property Value
Type Description
bool

Home

Gets a path to the user's home directory. If null, there is no home directory and '~' characters will not be expanded to it.

Declaration
public string? Home { get; }
Property Value
Type Description
string

IsExecutionHalted

Declaration
public bool IsExecutionHalted { get; }
Property Value
Type Description
bool

ParserOptions

Declaration
public ShellParseOptions ParserOptions { get; }
Property Value
Type Description
ShellParseOptions

Title

Declaration
public string Title { get; }
Property Value
Type Description
string

UseLegacyParser

Declaration
public bool UseLegacyParser { get; set; }
Property Value
Type Description
bool

WorkingDirectory

Gets a path to the current working directory. If none is specified, "/" will be used instead.

Declaration
public string? WorkingDirectory { get; }
Property Value
Type Description
string

Methods

DeclareFunction(string, IScriptFunction)

Declaration
public void DeclareFunction(string name, IScriptFunction body)
Parameters
Type Name Description
string name
IScriptFunction body

GetCompletions(StringBuilder, out int)

Declaration
public IReadOnlyList<string> GetCompletions(StringBuilder text, out int insertionPoint)
Parameters
Type Name Description
StringBuilder text
int insertionPoint
Returns
Type Description
IReadOnlyList<string>

GetVariableValue(string)

Declaration
public string GetVariableValue(string name)
Parameters
Type Name Description
string name
Returns
Type Description
string

HandleCommandNotFound(string, string[], IConsoleDriver)

Declaration
public void HandleCommandNotFound(string name, string[] args, IConsoleDriver console)
Parameters
Type Name Description
string name
string[] args
IConsoleDriver console

OpenFileConsole(IConsoleDriver, string, FileRedirectionType)

Declaration
public IConsoleDriver OpenFileConsole(IConsoleDriver realConsole, string filePath, FileRedirectionType mode)
Parameters
Type Name Description
IConsoleDriver realConsole
string filePath
FileRedirectionType mode
Returns
Type Description
IConsoleDriver

ParseScript(string)

Declaration
public ShellInstruction ParseScript(string scriptText)
Parameters
Type Name Description
string scriptText
Returns
Type Description
ShellInstruction

ProcessBuiltIn(ISystemProcess, ITextConsole, string, string[])

Declaration
public bool ProcessBuiltIn(ISystemProcess process, ITextConsole console, string name, string[] arguments)
Parameters
Type Name Description
ISystemProcess process
ITextConsole console
string name
string[] arguments
Returns
Type Description
bool

Run(IConsoleDriver)

Declaration
public Task Run(IConsoleDriver console)
Parameters
Type Name Description
IConsoleDriver console
Returns
Type Description
Task

RunParsedScript(ShellInstruction, IConsoleDriver?)

Declaration
public Task<int> RunParsedScript(ShellInstruction scriptTree, IConsoleDriver? console = null)
Parameters
Type Name Description
ShellInstruction scriptTree
IConsoleDriver console
Returns
Type Description
Task<int>

RunScript(IConsoleDriver, string)

Declaration
public Task RunScript(IConsoleDriver console, string scriptText)
Parameters
Type Name Description
IConsoleDriver console
string scriptText
Returns
Type Description
Task

RunScript(string)

Declaration
public Task RunScript(string scriptText)
Parameters
Type Name Description
string scriptText
Returns
Type Description
Task

SetVariableValue(string, string)

Declaration
public void SetVariableValue(string name, string newValue)
Parameters
Type Name Description
string name
string newValue

TryExecuteCommandAsync(string, string[], IConsoleDriver, IScriptExecutionContext?)

Declaration
public Task<int?> TryExecuteCommandAsync(string name, string[] args, IConsoleDriver console, IScriptExecutionContext? callSite = null)
Parameters
Type Name Description
string name
string[] args
IConsoleDriver console
IScriptExecutionContext callSite
Returns
Type Description
Task<int?>

Implements