Difference between revisions of "Unit Shell"

From Ultibo.org
Jump to: navigation, search
 
(4 intermediate revisions by the same user not shown)
Line 6: Line 6:
  
 
'''Ultibo Generic Shell unit'''
 
'''Ultibo Generic Shell unit'''
−
 
−
''To be documented''
 
  
 
=== Constants ===
 
=== Constants ===
Line 61: Line 59:
 
</div></div>
 
</div></div>
 
<br />
 
<br />
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 20px; padding-bottom: 15px;">
 +
<div style="font-size: 14px; padding-left: 12px;">'''Shell cursor mode''' <code> SHELL_CURSOR_MODE_* </code></div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
| <code>SHELL_CURSOR_MODE_INSERT = 0;</code>
 +
| style="width: 50%;"|&nbsp;
 +
|-
 +
| <code>SHELL_CURSOR_MODE_OVERWRITE = 1;</code>
 +
| &nbsp;
 +
|-
 +
|}
 +
</div></div>
 +
<br />
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 20px; padding-bottom: 15px;">
 +
<div style="font-size: 14px; padding-left: 12px;">'''Shell cursor shape''' <code> SHELL_CURSOR_SHAPE_* </code></div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
| <code>SHELL_CURSOR_SHAPE_LINE = 0;</code>
 +
| style="width: 50%;"|&nbsp;
 +
|-
 +
| <code>SHELL_CURSOR_SHAPE_BAR = 1;</code>
 +
| &nbsp;
 +
|-
 +
| <code>SHELL_CURSOR_SHAPE_BLOCK = 2;</code>
 +
| &nbsp;
 +
|-
 +
|}
 +
</div></div>
 +
<br />
 
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 20px; padding-bottom: 15px;">
 
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 20px; padding-bottom: 15px;">
 
<div style="font-size: 14px; padding-left: 12px;">'''Shell session flag''' <code> SHELL_SESSION_FLAG_* </code></div>
 
<div style="font-size: 14px; padding-left: 12px;">'''Shell session flag''' <code> SHELL_SESSION_FLAG_* </code></div>
Line 94: Line 123:
 
| <code>SHELL_COMMAND_FLAG_EXTENDED = $00000008;</code>
 
| <code>SHELL_COMMAND_FLAG_EXTENDED = $00000008;</code>
 
| Extended command, pass command name to command for extended handling
 
| Extended command, pass command name to command for extended handling
 +
|-
 +
| <code>SHELL_COMMAND_FLAG_COMPLETION = $00000008;</code>
 +
| Command supports auto completion
 
|-
 
|-
 
|}
 
|}
Line 171: Line 203:
 
|-
 
|-
 
| <code>SHELL_ALIAS_CLEAR = 'CLEAR';</code>
 
| <code>SHELL_ALIAS_CLEAR = 'CLEAR';</code>
 +
| &nbsp;
 +
|-
 +
| <code>SHELL_ALIAS_REBOOT = 'REBOOT';</code>
 
| &nbsp;
 
| &nbsp;
 +
|-
 +
|}
 +
</div></div>
 +
<br />
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 20px; padding-bottom: 15px;">
 +
<div style="font-size: 14px; padding-left: 12px;">'''Shell history''' <code> SHELL_HISTORY_* </code></div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
| <code>SHELL_HISTORY_MAX_COUNT = 100;</code>
 +
| style="width: 50%;"|&nbsp;
 
|-
 
|-
 
|}
 
|}
Line 186: Line 232:
 
| <code>SHELL_LOG_LEVEL_INFO = LOG_LEVEL_INFO;</code>
 
| <code>SHELL_LOG_LEVEL_INFO = LOG_LEVEL_INFO;</code>
 
| Shell informational messages
 
| Shell informational messages
 +
|-
 +
| <code>SHELL_LOG_LEVEL_WARN = LOG_LEVEL_WARN;</code>
 +
| Shell warning messages
 
|-
 
|-
 
| <code>SHELL_LOG_LEVEL_ERROR = LOG_LEVEL_ERROR;</code>
 
| <code>SHELL_LOG_LEVEL_ERROR = LOG_LEVEL_ERROR;</code>
Line 206: Line 255:
  
  
−
'''Shell manager'''
+
'''Shell specific classes
  
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
+
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
−
 
+
−
<code>TShellManager = class(TObject)</code>
+
−
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
+
−
{| class="wikitable" style="font-size: 14px; background: white;"
+
 
|-
 
|-
−
|colspan="2"|<div style="font-family: monospace,courier;">'''public'''</div>
+
| [[TShellManager|<code>TShellManager = class(TObject)</code>]]
 
|-
 
|-
−
| <code>constructor Create;</code>
+
|}
−
| style="width: 50%;"|&nbsp;
+
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
 
|-
 
|-
−
| <code>destructor Destroy; override;</code>
+
| [[TShell|<code>TShell = class(TListObject)</code>]]
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|<div style="font-family: monospace,courier;">'''private'''</div>
+
−
|-
+
−
| <code>FLock:TCriticalSectionHandle;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>FShells:TLinkedList;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>FCommands:TLinkedList;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|<div style="font-family: monospace,courier;">'''protected'''</div>
+
−
|-
+
−
| <code>function AcquireLock:Boolean;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function ReleaseLock:Boolean;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|<div style="font-family: monospace,courier;">'''public'''</div>
+
−
|-
+
−
| <code>function GetShell(APrevious:TShell; ALock,AUnlock:Boolean):TShell;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function FindShell(const AName:String):TShell;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>function RegisterShell(AShell:TShell):Boolean;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function DeregisterShell(AShell:TShell):Boolean;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>function GetCommand(APrevious:TShellCommand; ALock,AUnlock:Boolean):TShellCommand;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function FindCommand(const AName:String):TShellCommand;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function DefaultCommand:TShellCommand;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>function RegisterCommand(ACommand:TShellCommand):Boolean;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function DeregisterCommand(ACommand:TShellCommand):Boolean;</code>
+
−
| &nbsp;
+
 
|-
 
|-
 
|}
 
|}
−
</div></div>
+
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
−
 
+
−
'''Shell'''
+
−
 
+
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
+
−
 
+
−
<code>TShell = class(TListObject)</code>
+
−
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
+
−
{| class="wikitable" style="font-size: 14px; background: white;"
+
 
|-
 
|-
−
|colspan="2"|<div style="font-family: monospace,courier;">'''public'''</div>
+
| [[TShellSession|<code>TShellSession = class(TListObject)</code>]]
−
|-
+
−
| <code>constructor Create;</code>
+
−
| style="width: 50%;"|&nbsp;
+
−
|-
+
−
| <code>destructor Destroy; override;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|<div style="font-family: monospace,courier;">'''private'''</div>
+
−
|-
+
−
| <code>FManager:TShellManager;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>FAuthenticator:TAuthenticator;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>FLock:TCriticalSectionHandle;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>FSessions:TLinkedList;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>FCommands:TLinkedList;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>FBanner:String;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>FPrompt:String;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>FError:String;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>FName:String;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>FHash:LongWord;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>FFlags:LongWord;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>procedure SetAuthenticator(AAuthenticator:TAuthenticator);</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>function GetBanner:String;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>procedure SetBanner(const ABanner:String);</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function GetPrompt:String;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>procedure SetPrompt(const APrompt:String);</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function GetError:String;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>procedure SetError(const AError:String);</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>function GetName:String;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>procedure SetName(const AName:String);</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>procedure SetFlags(AFlags:LongWord);</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|<div style="font-family: monospace,courier;">'''protected'''</div>
+
−
|-
+
−
| <code>function AcquireLock:Boolean;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function ReleaseLock:Boolean;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|<div style="font-family: monospace,courier;">'''public'''</div>
+
−
|-
+
−
| <code>property Manager:TShellManager read FManager;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>property Authenticator:TAuthenticator read FAuthenticator write SetAuthenticator;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>property Banner:String read GetBanner write SetBanner;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>property Prompt:String read GetPrompt write SetPrompt;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>property Error:String read GetError write SetError;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>property Name:String read GetName write SetName;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>property Hash:LongWord read FHash;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>property Flags:LongWord read FFlags write SetFlags;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>function DoClear(ASession:TShellSession):Boolean; virtual;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>function DoBanner(ASession:TShellSession):Boolean; virtual;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function DoPrompt(ASession:TShellSession):Boolean; virtual;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function DoError(ASession:TShellSession):Boolean; virtual;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>function DoInput(ASession:TShellSession; var AInput:String):Boolean; virtual;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>function DoOutput(ASession:TShellSession; const AOutput:String):Boolean; virtual;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function DoOutputEx(ASession:TShellSession; const AOutput:String; AReturn:Boolean):Boolean; virtual;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>function DoGetSize(ASession:TShellSession; var ARows,ACols:LongWord):Boolean; virtual;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function DoSetSize(ASession:TShellSession; ARows,ACols:LongWord):Boolean; virtual;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>function DoGetCursor(ASession:TShellSession; var ARow,ACol:LongWord):Boolean; virtual;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function DoSetCursor(ASession:TShellSession; ARow,ACol:LongWord):Boolean; virtual;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>function DoGetColors(ASession:TShellSession; var AForecolor,ABackcolor:LongWord):Boolean; virtual;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function DoSetColors(ASession:TShellSession; AForecolor,ABackcolor:LongWord):Boolean; virtual;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>function DoGetCoordinates(ASession:TShellSession; var ARow,ACol:LongWord):Boolean; virtual;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function DoSetCoordinates(ASession:TShellSession; ARow,ACol:LongWord):Boolean; virtual;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>function GetSession(APrevious:TShellSession; ALock,AUnlock:Boolean):TShellSession;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function FindSession(AIdentifier:LongWord):TShellSession;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>function CreateSession(AIdentifier:LongWord):TShellSession;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function DestroySession(ASession:TShellSession):Boolean;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>function RegisterSession(ASession:TShellSession):Boolean;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function DeregisterSession(ASession:TShellSession):Boolean;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>function GetCommand(APrevious:TShellCommand; ALock,AUnlock:Boolean):TShellCommand;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function FindCommand(const AName:String):TShellCommand;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function DefaultCommand:TShellCommand;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>function RegisterCommand(ACommand:TShellCommand):Boolean;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function DeregisterCommand(ACommand:TShellCommand):Boolean;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>function MatchCommand(const ACommand:String; var AContinue:Boolean):TShellCommand; virtual;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function ProcessCommand(ASession:TShellSession; const ACommand:String):Boolean; virtual;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>function CommandName(const ACommand:String):String;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function CommandSplit(const ACommand:String):TStrings;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function CommandParse(const ACommand:String; var AName:String; var AParameters:TStrings):Boolean;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function CommandIndex(AIndex:Integer; const ACommand:String):String;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>function ParameterIndex(AIndex:Integer; AParameters:TStrings):String;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function ParameterValue(const AParameter:String; AParameters:TStrings):String;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function ParameterExists(const AParameter:String; AParameters:TStrings):Boolean;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>function ParameterValueEx(const AParameter:String; AParameters:TStrings; APlus,AMinus:Boolean):String;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function ParameterExistsEx(const AParameter:String; AParameters:TStrings; APlus,AMinus:Boolean):Boolean;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>function AddOutput(var AOutput:String; ACol:LongWord; const AValue:String):Boolean;</code>
+
−
| &nbsp;
+
 
|-
 
|-
 
|}
 
|}
−
</div></div>
+
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
−
 
+
−
'''Shell session'''
+
−
+
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
+
−
 
+
−
<code>TShellSession = class(TListObject)</code>
+
−
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
+
−
{| class="wikitable" style="font-size: 14px; background: white;"
+
 
|-
 
|-
−
|colspan="2"|<div style="font-family: monospace,courier;">'''public'''</div>
+
| [[TShellCommand|<code>TShellCommand = class(TListObject)</code>]]
−
|-
+
−
| <code>constructor Create(AShell:TShell; AIdentifier:LongWord);</code>
+
−
| style="width: 50%;"|&nbsp;
+
−
|-
+
−
| <code>destructor Destroy; override;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|<div style="font-family: monospace,courier;">'''private'''</div>
+
−
|-
+
−
| <code>FShell:TShell;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>FLock:TCriticalSectionHandle; </code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>FIdentifier:LongWord;</code>
+
−
| Unique identifier for this session
+
−
|-
+
−
| <code>FFlags:LongWord;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>FPrompt:String;</code>
+
−
| Current prompt for this session
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>FData:Pointer;</code>
+
−
| Shell private data for this session
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>procedure SetFlags(AFlags:LongWord);</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>procedure SetData(AData:Pointer);</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>function GetPrompt:String;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>procedure SetPrompt(const APrompt:String);</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|<div style="font-family: monospace,courier;">'''protected'''</div>
+
−
|-
+
−
| <code>function AcquireLock:Boolean;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function ReleaseLock:Boolean;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|<div style="font-family: monospace,courier;">'''public'''</div>
+
−
|-
+
−
| <code>property Shell:TShell read FShell;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>property Identifier:LongWord read FIdentifier;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>property Flags:LongWord read FFlags write SetFlags;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>property Prompt:String read GetPrompt write SetPrompt;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>property Data:Pointer read FData write SetData;</code>
+
−
| &nbsp;
+
 
|-
 
|-
 
|}
 
|}
−
</div></div>
+
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
−
 
+
−
'''Shell command'''
+
−
 
+
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
+
−
 
+
−
<code>TShellCommand = class(TListObject)</code>
+
−
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
+
−
{| class="wikitable" style="font-size: 14px; background: white;"
+
 
|-
 
|-
−
|colspan="2"|<div style="font-family: monospace,courier;">'''public'''</div>
+
| [[TShellAlias|<code>TShellAlias = class(TListObject)</code>]]
−
|-
+
−
| <code>constructor Create;</code>
+
−
| style="width: 50%;"|&nbsp;
+
−
|-
+
−
| <code>destructor Destroy; override;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|<div style="font-family: monospace,courier;">'''private'''</div>
+
−
|-
+
−
| <code>FManager:TShellManager;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>FLock:TCriticalSectionHandle; </code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>FAliases:TLinkedList;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>FName:String;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>FHash:LongWord;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>FFlags:LongWord;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>function GetName:String;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>procedure SetName(const AName:String);</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>procedure SetFlags(AFlags:LongWord);</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|<div style="font-family: monospace,courier;">'''protected'''</div>
+
−
|-
+
−
| <code>function AcquireLock:Boolean;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function ReleaseLock:Boolean;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|<div style="font-family: monospace,courier;">'''public'''</div>
+
−
|-
+
−
| <code>property Manager:TShellManager read FManager;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>property Name:String read GetName write SetName;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>property Hash:LongWord read FHash;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>property Flags:LongWord read FFlags write SetFlags;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>function DoHelp(AShell:TShell; ASession:TShellSession):Boolean; virtual;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function DoInfo(AShell:TShell; ASession:TShellSession):Boolean; virtual;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function DoCommand(AShell:TShell; ASession:TShellSession; AParameters:TStrings):Boolean; virtual;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function DoDefault(AShell:TShell; ASession:TShellSession; const AName:String; AParameters:TStrings):Boolean; virtual;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function DoExtended(AShell:TShell; ASession:TShellSession; const AName:String; AParameters:TStrings):Boolean; virtual;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>function GetAlias(APrevious:TShellAlias; ALock,AUnlock:Boolean):TShellAlias;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function FindAlias(const AName:String):TShellAlias;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>function RegisterAlias(AAlias:TShellAlias):Boolean;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function DeregisterAlias(AAlias:TShellAlias):Boolean;</code>
+
−
| &nbsp;
+
 
|-
 
|-
 
|}
 
|}
−
</div></div>
+
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
−
 
+
−
'''Shell alias'''
+
−
+
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
+
−
 
+
−
<code>TShellAlias = class(TListObject)</code>
+
−
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
+
−
{| class="wikitable" style="font-size: 14px; background: white;"
+
 
|-
 
|-
−
|colspan="2"|<div style="font-family: monospace,courier;">'''public'''</div>
+
| [[TShellHistory|<code>TShellHistory = class(TListObject)</code>]]
−
|-
+
−
| <code>constructor Create;</code>
+
−
| style="width: 50%;"|&nbsp;
+
−
|-
+
−
| <code>destructor Destroy; override;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|<div style="font-family: monospace,courier;">'''private'''</div>
+
−
|-
+
−
| <code>FLock:TCriticalSectionHandle; </code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>FName:String;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>FHash:LongWord;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>FFlags:LongWord;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>function GetName:String;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>procedure SetName(const AName:String);</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>procedure SetFlags(AFlags:LongWord);</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|<div style="font-family: monospace,courier;">'''protected'''</div>
+
−
|-
+
−
| <code>function AcquireLock:Boolean;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function ReleaseLock:Boolean;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|<div style="font-family: monospace,courier;">'''public'''</div>
+
−
|-
+
−
| <code>property Name:String read GetName write SetName;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>property Hash:LongWord read FHash;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>property Flags:LongWord read FFlags write SetFlags;</code>
+
−
| &nbsp;
+
 
|-
 
|-
 
|}
 
|}
−
</div></div>
+
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
−
 
+
−
'''Shell command help'''
+
−
 
+
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
+
−
 
+
−
<code>TShellCommandHelp = class(TShellCommand)</code>
+
−
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
+
−
{| class="wikitable" style="font-size: 14px; background: white;"
+
 
|-
 
|-
−
|colspan="2"|<div style="font-family: monospace,courier;">'''public'''</div>
+
| [[TShellCommandHelp|<code>TShellCommandHelp = class(TShellCommand)</code>]]
−
|-
+
−
| <code>constructor Create;</code>
+
−
| style="width: 50%;"|&nbsp;
+
−
|-
+
−
| <code>destructor Destroy; override;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|<div style="font-family: monospace,courier;">'''private'''</div>
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
|colspan="2"|<div style="font-family: monospace,courier;">'''public'''</div>
+
−
|-
+
−
| <code>function DoInfo(AShell:TShell; ASession:TShellSession):Boolean; override;</code>
+
−
| &nbsp;
+
 
|-
 
|-
 
|}
 
|}
−
</div></div>
+
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
−
 
+
−
'''Shell command information'''
+
−
 
+
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
+
−
 
+
−
<code>TShellCommandInfo = class(TShellCommand)</code>
+
−
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
+
−
{| class="wikitable" style="font-size: 14px; background: white;"
+
 
|-
 
|-
−
|colspan="2"|<div style="font-family: monospace,courier;">'''public'''</div>
+
| [[TShellCommandInfo|<code>TShellCommandInfo = class(TShellCommand)</code>]]
−
|-
+
−
| <code>constructor Create;</code>
+
−
| style="width: 50%;"|&nbsp;
+
−
|-
+
−
|colspan="2"|<div style="font-family: monospace,courier;">'''private'''</div>
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
|colspan="2"|<div style="font-family: monospace,courier;">'''public'''</div>
+
−
|-
+
−
| <code>function DoInfo(AShell:TShell; ASession:TShellSession):Boolean; override;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function DoCommand(AShell:TShell; ASession:TShellSession; AParameters:TStrings):Boolean; override;</code>
+
−
| &nbsp;
+
 
|-
 
|-
 
|}
 
|}
−
</div></div>
+
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
−
 
+
−
'''Shell command version'''
+
−
 
+
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
+
−
 
+
−
<code>TShellCommandVer = class(TShellCommand)</code>
+
−
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
+
−
{| class="wikitable" style="font-size: 14px; background: white;"
+
 
|-
 
|-
−
|colspan="2"|<div style="font-family: monospace,courier;">'''public'''</div>
+
| [[TShellCommandVer|<code>TShellCommandVer = class(TShellCommand)</code>]]
−
|-
+
−
| <code>constructor Create;</code>
+
−
| style="width: 50%;"|&nbsp;
+
−
|-
+
−
| <code>destructor Destroy; override;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|<div style="font-family: monospace,courier;">'''private'''</div>
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
|colspan="2"|<div style="font-family: monospace,courier;">'''public'''</div>
+
−
|-
+
−
| <code>function DoHelp(AShell:TShell; ASession:TShellSession):Boolean; override;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function DoInfo(AShell:TShell; ASession:TShellSession):Boolean; override;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function DoCommand(AShell:TShell; ASession:TShellSession; AParameters:TStrings):Boolean; override;</code>
+
−
| &nbsp;
+
 
|-
 
|-
 
|}
 
|}
−
</div></div>
+
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
−
 
+
−
'''Shell command time'''
+
−
 
+
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
+
−
 
+
−
<code>TShellCommandTime = class(TShellCommand)</code>
+
−
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
+
−
{| class="wikitable" style="font-size: 14px; background: white;"
+
 
|-
 
|-
−
|colspan="2"|<div style="font-family: monospace,courier;">'''public'''</div>
+
| [[TShellCommandTime|<code>TShellCommandTime = class(TShellCommand)</code>]]
−
|-
+
−
| <code>constructor Create;</code>
+
−
| style="width: 50%;"|&nbsp;
+
−
|-
+
−
|colspan="2"|<div style="font-family: monospace,courier;">'''private'''</div>
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
|colspan="2"|<div style="font-family: monospace,courier;">'''public'''</div>
+
−
|-
+
−
| <code>function DoHelp(AShell:TShell; ASession:TShellSession):Boolean; override;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function DoInfo(AShell:TShell; ASession:TShellSession):Boolean; override;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function DoCommand(AShell:TShell; ASession:TShellSession; AParameters:TStrings):Boolean; override;</code>
+
−
| &nbsp;
+
 
|-
 
|-
 
|}
 
|}
−
</div></div>
+
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
−
 
+
−
'''Shell command clear'''
+
−
 
+
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
+
−
 
+
−
<code>TShellCommandClear = class(TShellCommand)</code>
+
−
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
+
−
{| class="wikitable" style="font-size: 14px; background: white;"
+
 
|-
 
|-
−
|colspan="2"|<div style="font-family: monospace,courier;">'''public'''</div>
+
| [[TShellCommandClear|<code>TShellCommandClear = class(TShellCommand)</code>]]
−
|-
+
−
| <code>constructor Create;</code>
+
−
| style="width: 50%;"|&nbsp;
+
−
|-
+
−
| <code>destructor Destroy; override;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|<div style="font-family: monospace,courier;">'''private'''</div>
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
|colspan="2"|<div style="font-family: monospace,courier;">'''public'''</div>
+
−
|-
+
−
| <code>function DoHelp(AShell:TShell; ASession:TShellSession):Boolean; override;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function DoInfo(AShell:TShell; ASession:TShellSession):Boolean; override;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function DoCommand(AShell:TShell; ASession:TShellSession; AParameters:TStrings):Boolean; override;</code>
+
−
| &nbsp;
+
 
|-
 
|-
 
|}
 
|}
−
</div></div>
+
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
−
 
+
−
'''Shell command restart'''
+
−
 
+
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
+
−
 
+
−
<code>TShellCommandRestart = class(TShellCommand)</code>
+
−
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
+
−
{| class="wikitable" style="font-size: 14px; background: white;"
+
 
|-
 
|-
−
|colspan="2"|<div style="font-family: monospace,courier;">'''public'''</div>
+
| [[TShellCommandRestart|<code>TShellCommandRestart = class(TShellCommand)</code>]]
−
|-
+
−
| <code>constructor Create;</code>
+
−
| style="width: 50%;"|&nbsp;
+
−
|-
+
−
|colspan="2"|<div style="font-family: monospace,courier;">'''private'''</div>
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
|colspan="2"|<div style="font-family: monospace,courier;">'''public'''</div>
+
−
|-
+
−
| <code>function DoHelp(AShell:TShell; ASession:TShellSession):Boolean; override;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function DoInfo(AShell:TShell; ASession:TShellSession):Boolean; override;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function DoCommand(AShell:TShell; ASession:TShellSession; AParameters:TStrings):Boolean; override;</code>
+
−
| &nbsp;
+
 
|-
 
|-
 
|}
 
|}
−
</div></div>
+
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
−
 
+
−
'''Shell command shutdown'''
+
−
 
+
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
+
−
 
+
−
<code>TShellCommandShutdown = class(TShellCommand)</code>
+
−
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
+
−
{| class="wikitable" style="font-size: 14px; background: white;"
+
 
|-
 
|-
−
|colspan="2"|<div style="font-family: monospace,courier;">'''public'''</div>
+
| [[TShellCommandShutdown|<code>TShellCommandShutdown = class(TShellCommand)</code>]]
−
|-
+
−
| <code>constructor Create;</code>
+
−
| style="width: 50%;"|&nbsp;
+
−
|-
+
−
|colspan="2"|<div style="font-family: monospace,courier;">'''private'''</div>
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
|colspan="2"|<div style="font-family: monospace,courier;">'''public'''</div>
+
−
|-
+
−
| <code>function DoHelp(AShell:TShell; ASession:TShellSession):Boolean; override;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function DoInfo(AShell:TShell; ASession:TShellSession):Boolean; override;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function DoCommand(AShell:TShell; ASession:TShellSession; AParameters:TStrings):Boolean; override;</code>
+
−
| &nbsp;
+
 
|-
 
|-
 
|}
 
|}
−
</div></div>
+
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
−
+
−
'''Shell command uptime'''
+
−
 
+
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
+
−
 
+
−
<code>TShellCommandUptime = class(TShellCommand)</code>
+
−
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
+
−
{| class="wikitable" style="font-size: 14px; background: white;"
+
 
|-
 
|-
−
|colspan="2"|<div style="font-family: monospace,courier;">'''public'''</div>
+
| [[TShellCommandUptime|<code>TShellCommandUptime = class(TShellCommand)</code>]]
−
|-
+
−
| <code>constructor Create;</code>
+
−
| style="width: 50%;"|&nbsp;
+
−
|-
+
−
|colspan="2"|<div style="font-family: monospace,courier;">'''private'''</div>
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
|colspan="2"|<div style="font-family: monospace,courier;">'''public'''</div>
+
−
|-
+
−
| <code>function DoHelp(AShell:TShell; ASession:TShellSession):Boolean; override;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function DoInfo(AShell:TShell; ASession:TShellSession):Boolean; override;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function DoCommand(AShell:TShell; ASession:TShellSession; AParameters:TStrings):Boolean; override;</code>
+
−
| &nbsp;
+
 
|-
 
|-
 
|}
 
|}
−
</div></div>
+
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
−
 
+
−
'''Shell command threads'''
+
−
 
+
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
+
−
 
+
−
<code>TShellCommandThreads = class(TShellCommand)</code>
+
−
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
+
−
{| class="wikitable" style="font-size: 14px; background: white;"
+
 
|-
 
|-
−
|colspan="2"|<div style="font-family: monospace,courier;">'''public'''</div>
+
| [[TShellCommandThreads|<code>TShellCommandThreads = class(TShellCommand)</code>]]
−
|-
+
−
| <code>constructor Create;</code>
+
−
| style="width: 50%;"|&nbsp;
+
−
|-
+
−
|colspan="2"|<div style="font-family: monospace,courier;">'''private'''</div>
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
|colspan="2"|<div style="font-family: monospace,courier;">'''public'''</div>
+
−
|-
+
−
| <code>function DoHelp(AShell:TShell; ASession:TShellSession):Boolean; override;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function DoInfo(AShell:TShell; ASession:TShellSession):Boolean; override;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function DoCommand(AShell:TShell; ASession:TShellSession; AParameters:TStrings):Boolean; override;</code>
+
−
| &nbsp;
+
 
|-
 
|-
 
|}
 
|}
−
</div></div>
+
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
−
 
+
−
'''Shell command memory'''
+
−
 
+
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
+
−
 
+
−
<code>TShellCommandMemory = class(TShellCommand)</code>
+
−
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
+
−
{| class="wikitable" style="font-size: 14px; background: white;"
+
 
|-
 
|-
−
|colspan="2"|<div style="font-family: monospace,courier;">'''public'''</div>
+
| [[TShellCommandMemory|<code>TShellCommandMemory = class(TShellCommand)</code>]]
−
|-
+
−
| <code>constructor Create;</code>
+
−
| style="width: 50%;"|&nbsp;
+
−
|-
+
−
|colspan="2"|<div style="font-family: monospace,courier;">'''private'''</div>
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
|colspan="2"|<div style="font-family: monospace,courier;">'''public'''</div>
+
−
|-
+
−
| <code>function DoHelp(AShell:TShell; ASession:TShellSession):Boolean; override;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function DoInfo(AShell:TShell; ASession:TShellSession):Boolean; override;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function DoCommand(AShell:TShell; ASession:TShellSession; AParameters:TStrings):Boolean; override;</code>
+
−
| &nbsp;
+
 
|-
 
|-
 
|}
 
|}
−
</div></div> 
+
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
−
 
+
−
'''Shell command devices'''
+
−
 
+
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
+
−
 
+
−
<code>TShellCommandDevices = class(TShellCommand)</code>
+
−
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
+
−
{| class="wikitable" style="font-size: 14px; background: white;"
+
 
|-
 
|-
−
|colspan="2"|<div style="font-family: monospace,courier;">'''public'''</div>
+
| [[TShellCommandDevices|<code>TShellCommandDevices = class(TShellCommand)</code>]]
−
|-
+
−
| <code>constructor Create;</code>
+
−
| style="width: 50%;"|&nbsp;
+
−
|-
+
−
|colspan="2"|<div style="font-family: monospace,courier;">'''private'''</div>
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
|colspan="2"|<div style="font-family: monospace,courier;">'''public'''</div>
+
−
|-
+
−
| <code>function DoHelp(AShell:TShell; ASession:TShellSession):Boolean; override;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function DoInfo(AShell:TShell; ASession:TShellSession):Boolean; override;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function DoCommand(AShell:TShell; ASession:TShellSession; AParameters:TStrings):Boolean; override;</code>
+
−
| &nbsp;
+
 
|-
 
|-
 
|}
 
|}
−
</div></div> 
 
 
<br />
 
<br />
  
Line 1,213: Line 376:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 1,228: Line 391:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 1,240: Line 403:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 1,252: Line 415:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 1,264: Line 427:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 1,276: Line 439:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 1,288: Line 451:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 1,300: Line 463:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 1,312: Line 475:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 1,327: Line 490:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Note'''
+
! Note
 +
| None documented
 +
|-
 +
|}
 +
</div></div>
 +
<br />
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
 +
<pre style="border: 0; padding-bottom:0px;">procedure ShellLogInfo(const AText:String); inline;</pre>
 +
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 1,334: Line 509:
 
<br />
 
<br />
 
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
 
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
−
<pre style="border: 0; padding-bottom:0px;">procedure ShellLogInfo(const AText:String);</pre>
+
<pre style="border: 0; padding-bottom:0px;">procedure ShellLogWarn(const AText:String); inline;</pre>
 
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
 
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
 
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 1,346: Line 521:
 
<br />
 
<br />
 
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
 
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
−
<pre style="border: 0; padding-bottom:0px;">procedure ShellLogError(const AText:String);</pre>
+
<pre style="border: 0; padding-bottom:0px;">procedure ShellLogError(const AText:String); inline;</pre>
 
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
 
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
 
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 1,358: Line 533:
 
<br />
 
<br />
 
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
 
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
−
<pre style="border: 0; padding-bottom:0px;">procedure ShellLogDebug(const AText:String);</pre>
+
<pre style="border: 0; padding-bottom:0px;">procedure ShellLogDebug(const AText:String); inline;</pre>
 
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
 
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
 
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-

Latest revision as of 04:43, 31 August 2021

Return to Unit Reference


Description

Ultibo Generic Shell unit

Constants


[Expand]
Shell specific constants SHELL_*


[Expand]
Shell flag SHELL_FLAG_*


[Expand]
Shell cursor mode SHELL_CURSOR_MODE_*


[Expand]
Shell cursor shape SHELL_CURSOR_SHAPE_*


[Expand]
Shell session flag SHELL_SESSION_FLAG_*


[Expand]
Shell command flag SHELL_COMMAND_FLAG_*


[Expand]
Shell alias flag SHELL_ALIAS_FLAG_*


[Expand]
Shell command SHELL_COMMAND_*


[Expand]
Shell alias SHELL_ALIAS_*


[Expand]
Shell history SHELL_HISTORY_*


[Expand]
Shell logging SHELL_LOG_*


Type definitions

None defined

Class definitions


Shell specific classes

TShellManager = class(TObject)
TShell = class(TListObject)
TShellSession = class(TListObject)
TShellCommand = class(TListObject)
TShellAlias = class(TListObject)
TShellHistory = class(TListObject)
TShellCommandHelp = class(TShellCommand)
TShellCommandInfo = class(TShellCommand)
TShellCommandVer = class(TShellCommand)
TShellCommandTime = class(TShellCommand)
TShellCommandClear = class(TShellCommand)
TShellCommandRestart = class(TShellCommand)
TShellCommandShutdown = class(TShellCommand)
TShellCommandUptime = class(TShellCommand)
TShellCommandThreads = class(TShellCommand)
TShellCommandMemory = class(TShellCommand)
TShellCommandDevices = class(TShellCommand)


Public variables


Shell logging

SHELL_DEFAULT_LOG_LEVEL:LongWord = SHELL_LOG_LEVEL_DEBUG; Minimum level for Shell messages. Only messages with level greater than or equal to this will be printed.
SHELL_LOG_ENABLED:Boolean;


Function declarations


Initialization functions

[Expand] 
procedure ShellInit;
Description: To be documented


Shell functions

[Expand] 
function ShellGetShell(APrevious:TShell; ALock,AUnlock:Boolean):TShell;
Description: To be documented


[Expand] 
function ShellFindShell(const AName:String):TShell;
Description: To be documented


[Expand] 
function ShellRegisterShell(AShell:TShell):Boolean;
Description: To be documented


[Expand] 
function ShellDeregisterShell(AShell:TShell):Boolean;
Description: To be documented


[Expand] 
function ShellGetCommand(APrevious:TShellCommand; ALock,AUnlock:Boolean):TShellCommand;
Description: To be documented


[Expand] 
function ShellFindCommand(const AName:String):TShellCommand;
Description: To be documented


[Expand] 
function ShellRegisterCommand(ACommand:TShellCommand):Boolean;
Description: To be documented


[Expand] 
function ShellDeregisterCommand(ACommand:TShellCommand):Boolean;
Description: To be documented


Shell helper functions

[Expand] 
procedure ShellLog(Level:LongWord; const AText:String);
Description: To be documented


[Expand] 
procedure ShellLogInfo(const AText:String); inline;
Description: To be documented


[Expand] 
procedure ShellLogWarn(const AText:String); inline;
Description: To be documented


[Expand] 
procedure ShellLogError(const AText:String); inline;
Description: To be documented


[Expand] 
procedure ShellLogDebug(const AText:String); inline;
Description: To be documented


Return to Unit Reference

Retrieved from "https://ultibo.org/mediawiki_ultibo_org/index.php?title=Unit_Shell&oldid=5057"