IGLib
1.5
The IGLib base library for development of numerical, technical and business applications.
|
Simple command-line application interpreters, holds a set of commands that can be executed by name. Each of these command can take an arbitrary number of string arguments. Interpreter has its internal variables, which are strings. Each variable has a name and a value. If any arguments (and even command) start with the '$' character then then it is treated as reference to a variable and is substituted with the value of that variable (whose name follows the '$' character) before it is used. More...
Classes | |
class | InterpreterPipeClient |
Client to the interpreter pipe server (classes derived from InterpreterPipeServer). More... | |
class | InterpreterPipeServer |
Command-line interpreter's server that creates a named pipe, listens on its input stream for client requests, executes requests in the corresponding interpreter, and sends responses back to the client. More... | |
Public Member Functions | |
delegate string | ApplicationCommandDelegate (ICommandLineApplicationInterpreter interpreter, string commandName, string[] args) |
Delegate for commands that are installed on interpreter. More... | |
delegate void | ModuleDelegate (string modulename, ICommandLineApplicationInterpreter interpreter) |
Delegate for installing a module on the interpreter. More... | |
CommandLineApplicationInterpreter () | |
Creates a new MessyApplication object initialized with some basisc applications. More... | |
CommandLineApplicationInterpreter (bool caseSensitive) | |
Construct a new commandline interpreter object initialized with some basisc commands. More... | |
virtual string | GetVariable (string varName) |
Returns the value of the specified variable of the current command line interpreter. null is returned if the specified variable does not exist. More... | |
virtual string | SetVariable (string varName, string value) |
Sets the specified variable to the specified value. More... | |
virtual string | ClearVariable (string varName) |
Clears (removes) the specified variable. More... | |
virtual string | PrintVariable (string varName) |
Prints the specified variable. More... | |
virtual string[] | GetArguments (string commandLine) |
Parses a command line and extracts arguments from it. Arguments can be separated according to usual rules for command-line arguments: spaces are separators, there can be arbitraty number of spaces, and if we want an argument to contain spaces, we must enclose it in double quotes. Command line can also contain the command name followed by arguments. In this case it is treated in the same way, and command can be obtained simply as the first string in the returned array. More... | |
virtual string | RunFile (string filePath) |
Runs all commands that are written in a file. Each line of a file is interpreted as a single command, consisting of command name followed by arguments. More... | |
virtual string | RunInteractive () |
Reads commands one by one from the standard input and executes them. More... | |
string | ExpressionEvaluatorInteractive () |
Runs interpreter's expression evaluator interactively. More... | |
string | ExpressionEvaluatorEvaluate (string[] args) |
string[] | GetCommands () |
Returns an array of installed commands. More... | |
virtual bool | ContainsCommand (string commandName) |
Returns true if the interpreter contains a command with specified name, false otherwise. More... | |
virtual string | RunRepeat (string[] args) |
Runs command several times where the first argument is number of repetitions, second argument is command name. Extracts command name and runs the corresponding command delegate. Before running it, arguments for the application delegate are extracted and then passed to the delegate. More... | |
virtual string | RunRepeatVerbose (string[] args) |
Runs command several times where the first argument is number of repetitions, second argument is command name. Extracts command name and runs the corresponding command delegate. Before running it, arguments for the application delegate are extracted and then passed to the delegate. More... | |
virtual string | RunRepeatSilent (string[] args) |
Runs command several times where the first argument is number of repetitions, second argument is command name. Extracts command name and runs the corresponding command delegate. Before running it, arguments for the application delegate are extracted and then passed to the delegate. More... | |
virtual string | RunRepeatSpecificOutputLevel (string[] args) |
Runs command several times where the first argument is number of repetitions, second argument is command name. Extracts command name and runs the corresponding command delegate. Before running it, arguments for the application delegate are extracted and then passed to the delegate. More... | |
virtual string | RunRepeat (int outputLevel, string[] args) |
Runs command several times where the first argument is number of repetitions, second argument is command name. Extracts command name and runs the corresponding command delegate. Before running it, arguments for the application delegate are extracted and then passed to the delegate. More... | |
virtual string | RunTryCatch (int outputLevel, string[] args) |
Runs command in a try-catch block, where first argument is command name. Extracts command name and runs the corresponding command delegate. Before running it, arguments for the application delegate are extracted and then passed to the delegate. More... | |
string | RunWithoutModifications (string commandName, params string[] commandArguments) |
Runs the specified command with specified name, installed on the current application object, without any modifications of the command arguments. More... | |
virtual string | Run (string commandName, params string[] commandArguments) |
Runs the specified command with specified name, installed on the current application object. More... | |
string | Run (string[] args) |
Runs command where the first argument is command name. Extracts command name and runs the corresponding command delegate.Before running it, arguments for the application delegate are extracted and then passed to the delegate. More... | |
void | AddParallelCommand (CommandLineJobContainer commandData) |
Adds a new parallel command data to the list of commands executed by in parallel. More... | |
CommandLineJobContainer | GetParallelCommandData (int id) |
Returns the command data object of the parallel command that with the specified ID. More... | |
void | PrintParallelCommands (bool printAll) |
Prints the commands that were scheduled for parallel execution, together with their current status, results and execution times (when available). More... | |
virtual void | UpdateThreadPriorityFromSystem () |
Updates thread priority (property ThreadPriority) of the interpreter to the current global thread priority (the UtilSystem.ThreadPriority property). More... | |
void | RegisterSystemPriorityUpdating () |
Registers the UpdateThreadPriorityFromSystem method as "event handler" for system priority changes. After registration, this method will be called every time the value of the UtilSystem.ThreadPriority property changes. More... | |
void | UnregisterSystemPriorityUpdating () |
Unregisters the UpdateThreadPriorityFromSystem method as "event handler" for system priority changes. More... | |
int[] | RunParallelRepeat (int numRepeat, string command, string[] commandArguments) |
Runs the specified command with arguments the specified number of times in parallel threads by using the interpreter's job dispatcher with corresponding parallel servers. More... | |
int | RunParallel (string command, string[] commandArguments) |
Runs she specified command with arguments once in a parallel thread by using the interpreter's job dispatcher with corresponding parallel servers. More... | |
virtual string | RunAsync (string[] args) |
Runs a command asynchronously where the first argument is command name. Extracts command name and runs the corresponding application delegate. Before running it, arguments for the application delegate are extracted and then passed to the delegate. More... | |
virtual string | RunAsync (string commandName, params string[] commandArguments) |
Runs the command with specified name (installed on the current interpreter object) asynchronously. More... | |
bool | AsyncIsCompleted (int id) |
Returns true if the asynchronous command execution identified by id has completed, and false otherwise. More... | |
bool | AsyncIsAllCompleted () |
Returns true if all asynchronous command executions have completed, and false otherwise. More... | |
void | AsyncWaitAll () |
Waits until all asynchronously commands that have been eventually executed by the current interpreter, complete. More... | |
string | AsyncWait (int callId) |
Waits for the specified asynchronous command (specified by command ID) to complete. More... | |
virtual void | AddCommand (string commandName, ApplicationCommandDelegate commandDelegate) |
Adds command with the specified name. More... | |
virtual void | RemoveCommand (string commandName) |
Removes the command with the specified name. More... | |
virtual void | RemoveAllCommands () |
Removes all commands from the current interpreter. More... | |
virtual void | AddModule (string moduleName, ModuleDelegate moduleDelegate) |
Adds a new module to the interpreter. This adds an initialization function (via a delegate) which is executed when module module initialization is performed. More... | |
virtual void | LoadModule (string moduleName) |
Loads and initializes the specified module. More... | |
virtual string | ModuleTestCommandName (string modulename) |
Returns the standard name for the command that gets installed when a module is loaded. More... | |
virtual bool | IsModuleLoaded (string moduleName) |
Returns true if the specified module has been loaded on the interpreter, false if not. More... | |
virtual string | RunScriptFile (string scriptFilePath, string[] initAndRunArgs) |
Dynamically loads (temporarily, just for execution of the current commad) a class form the script contained in the specified file and executes its executable method. The file must contain the script that is dynamically loaded and executed, in form of definition of the appropriate class of type ILoadableScript. The dynamically loadable script class is loaded from the file and instantiated by the LoadableScriptInterpreter interpreter that is based on loadable scripts. More... | |
void | LoadScript (string newCommandName, string scriptFilePath, string[] initArgs) |
Dynamically loads (compiles and instantiates) a loadable script class contained in the specified file, and installs a new command on LoadableScriptInterpreter and on the current interpreter, based on the dynamically created instance of the loaded (dynamically compiled) class. More... | |
virtual string | RunLoadedScript (string commandName, string[] arguments) |
Executes the specified command that has been dynamically loaded form a script. More... | |
string[] | GetLoadableScriptReferencedAssemblies () |
Returns an array of assemblies that are currently referenced by the script loader that takes care of loading the dynamic scripts. More... | |
InterpreterPipeServer | CreatePipeServer (string pipeName, string serverName=null, bool createCommand=false, int outputLevel=3) |
Creates and registers a new interpreter's named pipe server. More... | |
string | RemovePipeServers (params string[] serverNames) |
Removes the specified interpreter's named pipe servers. Servers are stopped and their pipes closed. Returns a string contaiing information about the removed servers. More... | |
string | PipeServerInfo (string serverName=null) |
Returns a string containing informattion on the installed named pipe servers. More... | |
InterpreterPipeClient | CreatePipeClient (string pipeName, string clientName=null, bool createCommand=false, int outputLevel=3) |
Creates and registers a new interpreter's named pipe client. More... | |
string | RemovePipeClients (params string[] clientNames) |
Removes the specified interpreter's named pipe clients. Client's pipes are closed. Returns a string contaiing information about the removed clients. More... | |
string | PipeClientInfo (string clientName=null) |
Returns a string containing informattion on the installed named pipe clients. More... | |
string | PipeClientGetServerResponse (string clientName, string commandLineString) |
Sends the specified command to the corresponding pipe serverr and reads and returns its response. More... | |
![]() | |
string | Run (string commandName, string[] args) |
Runs the command with specified name, installed on the current application object. More... | |
void | AddCommand (string appName, CommandLineApplicationInterpreter.ApplicationCommandDelegate appMain) |
Adds command with the specified name. More... | |
void | AddModule (string moduleName, CommandLineApplicationInterpreter.ModuleDelegate moduleDelegate) |
Adds a new module to the interpreter. This adds an initialization function (via a delegate) which is executed when module module initialization is performed. More... | |
Static Public Member Functions | |
static void | ExecuteSystemCommand (string[] args) |
Executes the specified system commmand and blocks until the execution completes. More... | |
static void | ExecuteSystemCommand (string command, params string[] args) |
Executes system command with arguments. More... | |
Public Attributes | |
const bool | DefaultCaseSensitive = false |
Default value of the flg indicating whether command names are case sensitive. More... | |
const string | DefaultName = "ApplicationIntepreter" |
Default interpreter name. More... | |
const string | AutoGlobalName = "AutomaticGlobalInterpreter" |
const string | AutoGlobalDescription = "Automatically created global command-line interpreter." |
StopWatch | _timer |
Static Public Attributes | |
static int | DefaultOutputLevel = 1 |
static bool | DefaultWarnCommandReplacement = true |
Protected Member Functions | |||
virtual bool | IsVariableReference (string str) | ||
Returns true if the specified string represents a variable reference, false otherwise. More... | |||
virtual string | SubstituteVariableReference (string str) | ||
Returns value of the referenced variable if the specified string represents a variable reference (begins with the variableStart character, usually '$'), otherwise the original sting is returned. More... | |||
virtual void | ExecuteSystemCommandsInteractive () | ||
Reads commands with their arguments ont by one from the console and executes them as system commands. More... | |||
void | AsyncRunCallback (IAsyncResult ar) | ||
Callback method for asynchronous command executions. More... | |||
virtual string | CmdSetVariable (ICommandLineApplicationInterpreter interpreter, string cmdName, string[] args) | ||
Command. Sets the specified varuable to the specified value. Usage: More... | |||
virtual string | CmdGetVariable (ICommandLineApplicationInterpreter interpreter, string cmdName, string[] args) | ||
Command. Gets the specified varuable and returns its value (or null if the variable does not exist). Variable name must be the only argument of the command. More... | |||
virtual string | CmdClearVariable (ICommandLineApplicationInterpreter interpreter, string cmdName, string[] args) | ||
Command. Clears the specified varuable. Variable name must be the only argument of the command. More... | |||
virtual string | CmdPrintVariable (ICommandLineApplicationInterpreter interpreter, string cmdName, string[] args) | ||
Command. Prints the specified varuable. Variable name must be the only argument of the command. More... | |||
virtual string | CmdWriteLine (ICommandLineApplicationInterpreter interpreter, string cmdName, string[] args) | ||
Command. Prints concatenated argument with spaces between them. More... | |||
virtual string | CmdWrite (ICommandLineApplicationInterpreter interpreter, string cmdName, string[] args) | ||
Command. Prints concatenated argument with spaces between them. More... | |||
virtual string | CmdRunFile (ICommandLineApplicationInterpreter interpreter, string cmdName, string[] args) | ||
Command. Runs a file by running all its lines in the current interpreter. File name must be the only argument of the command. More... | |||
virtual string | CmdRunRepeatVerbose (ICommandLineApplicationInterpreter interpreter, string cmdName, string[] args) | ||
Command. Runs another command repetitively the specified number of times. First argument must be the number of times command is run, the second argument must be command to be run repetitively, and the rest of the arguments are passed to that command as its arguments. More... | |||
virtual string | CmdRunRepeat (ICommandLineApplicationInterpreter interpreter, string cmdName, string[] args) | ||
Command. Runs another command repetitively the specified number of times. First argument must be the number of times command is run, the second argument must be command to be run repetitively, and the rest of the arguments are passed to that command as its arguments. More... | |||
virtual string | CmdTryRun (ICommandLineApplicationInterpreter interpreter, string cmdName, string[] args) | ||
Command. Runs another command in a try-catch block, such that if command throws an exception execution is not broken. The second argument must be command to be run, and the rest of the arguments are passed to that command as its arguments. More... | |||
virtual string | CmdThtrowExceptions (ICommandLineApplicationInterpreter interpreter, string cmdName, string[] args) | ||
Command. Sets the flag for rethrowing exceptions in the interaction mode. Optional boolean arguemnt, default is true. More... | |||
virtual string | CmdRunInteractive (ICommandLineApplicationInterpreter interpreter, string cmdName, string[] args) | ||
Command. Runs interpreter commands interactively. Reads commands one by one from console and executes them, until only Enter is pressed.. More... | |||
virtual string | CmdRunSystem (ICommandLineApplicationInterpreter interpreter, string cmdName, string[] args) | ||
Command. Runs the specified command-line by the operating system. The first argument is the command to be executed while the following arguments are arguments to this command. If there are no arguments then user is requested to insert commands interactively. More... | |||
virtual string | CmdExpressionEvaluatorInteractive (ICommandLineApplicationInterpreter interpreter, string cmdName, string[] args) | ||
Command. Runs the built in expression evaluator. More... | |||
virtual string | CmdSetPriority (ICommandLineApplicationInterpreter interpreter, string cmdName, string[] args) | ||
Interpreter command. Sets the priority of the current process. More... | |||
virtual string | CmdRunParallel (ICommandLineApplicationInterpreter interpreter, string cmdName, string[] args) | ||
Interpreter command. Runs the specified command-line in parallel thread. More... | |||
virtual string | CmdRunParallelRepeat (ICommandLineApplicationInterpreter interpreter, string cmdName, string[] args) | ||
Interpreter command. Runs the specified command-line several times in the specified number of parallel threads. More... | |||
virtual string | CmdPrintParallelCommands (ICommandLineApplicationInterpreter interpreter, string cmdName, string[] args) | ||
Interpreter command. Prints data about commands executed in parallel threads. More... | |||
virtual string | CmdRunAsync (ICommandLineApplicationInterpreter interpreter, string cmdName, string[] args) | ||
Command. Runs the specified command-line asynchronously. More... | |||
virtual string | CmdAsyncWaitResults (ICommandLineApplicationInterpreter interpreter, string cmdName, string[] args) | ||
Command. Wait until asynchronously invoked command with the specified ID (first argument, must represent an int) completes. More... | |||
virtual string | CmdAsyncCompleted (ICommandLineApplicationInterpreter interpreter, string cmdName, string[] args) | ||
Command. Returns a flag indicating whether the asynchroneous command invocation identified by the specified ID (first argument, must represent an int) has completed. More... | |||
virtual string | CmdSleepSeconds (ICommandLineApplicationInterpreter interpreter, string cmdName, string[] args) | ||
Command. Sleeps (suspends execution of the executing thread) for the specified number of seconds. More... | |||
virtual string | CmdLoadModule (ICommandLineApplicationInterpreter interpreter, string cmdName, string[] args) | ||
Command. Loads the specified module (whos name must be the first argument) and performs its initialization. If there are more than 1 arguments then the rest of the arguments specify a command and (if more than 1) its arguments, and the specified command is also run. More... | |||
virtual string | CmdIsModuleLoaded (ICommandLineApplicationInterpreter interpreter, string cmdName, string[] args) | ||
Executinon method for command that checks if module is loaded. Writes to condole whether module is loaded or not, and returns "1" if module is loaded and "0" if not. More... | |||
virtual string | CmdModuleTestCommand (ICommandLineApplicationInterpreter interpreter, string cmdName, string[] args) | ||
Executinon method for test command that is installed when a module is installed. This is a command that enables to verify that a module with the specified name has been installed. More... | |||
virtual string | CmdTestFromTestModules (ICommandLineApplicationInterpreter interpreter, string cmdName, string[] args) | ||
Executinon method for test command, which just prints its name and arguments. This is a replacement for usuel test command, which gets installed when one of the two basic test modules are installed. More... | |||
virtual string | CmdPipeServerCreate (ICommandLineApplicationInterpreter interpreter, string cmdName, string[] args) | ||
Command. Creates a new server that listens for interpreter commands on a named pipe, executes them, and writes result back to the named pipe. Command arguments are pipe name and server name (optional, if not specified then server name is the same as pipe name). More... | |||
virtual string | CmdPipeServersRemove (ICommandLineApplicationInterpreter interpreter, string cmdName, string[] args) | ||
Command. Removes the spcified (or all, if names are not specified) named pipe servers. Command arguments are names of the pipe servers to be removed. If none is specified then all pipe servers installed on the interperter are removed. More... | |||
virtual string | CmdPipeServerInfo (ICommandLineApplicationInterpreter interpreter, string cmdName, string[] args) | ||
Command. Prints and returns inormation on the installed named pipe servers. Optional command argument is server name. If not specified then information about all installed servers is printed and returned.
| |||
virtual string | CmdPipeClientCreate (ICommandLineApplicationInterpreter interpreter, string cmdName, string[] args) | ||
Command. Creates a new client to the interpreter pipe server. The client can send command to the server listening on the specified named pipe, and recieves responses from the server and returns them. Command arguments are pipe name and client name (optional, if not specified then server name is the same as pipe name). More... | |||
virtual string | CmdPipeClientsRemove (ICommandLineApplicationInterpreter interpreter, string cmdName, string[] args) | ||
Command. Removes the spcified (or all, if names are not specified) named pipe clients. Command arguments are names of the pipe clients to be removed. If none is specified then all pipe clients installed on the interperter are removed. More... | |||
virtual string | CmdPipeClientInfo (ICommandLineApplicationInterpreter interpreter, string cmdName, string[] args) | ||
Command. Prints and returns inormation on the installed named pipe clients. Optional command argument is client name. If not specified then information about all installed clients is printed and returned.
| |||
virtual string | CmdPipeClientGetServerResponse (ICommandLineApplicationInterpreter interpreter, string cmdName, string[] args) | ||
Command. Sends the specified command to the corresponding pipe serverr and reads and returns its response. Command argument is the (interpreter's) name of the pipe client followed by command and eventual arguments sent to the server.
| |||
virtual string | CmdRunInternalScriptClass (ICommandLineApplicationInterpreter interpreter, string cmdName, string[] args) | ||
Interpreter command. Dynamically creates and runs an internal script object, i.e. an object of the class that is already compiled in the code. Interpreter command arguments: The first argument must be a full name of the script class whose object is run. The rest of the arguments (if any) are directly transferred to the executable method of the script and are also used as argument to script initialization method. More... | |||
virtual string | CmdRunScriptFile (ICommandLineApplicationInterpreter interpreter, string cmdName, string[] args) | ||
Interpreter command. Dynamically loads (temporarily, just for execution of the current commad) a class form the script contained in the specified file and executes its executable method. The file must contain the script that is dynamically loaded and executed, in form of definition of the appropriate class of type ILoadableScript . The dynamically loadable script class is loaded from the file and instantiated by the LoadableScriptInterpreter loadable script-based interpreter object. Interpreter command arguments: Path to the file containing loadable script must be the first argument to the method. The rest of the arguments (if any) are directly transferred to the executable method of the script. More... | |||
virtual string | CmdLoadScript (ICommandLineApplicationInterpreter interpreter, string cmdName, string[] args) | ||
Interpreter command. Dynamically loads (compiles and instantiates) a loadable script class contained in the specified file, and installs a new command on LoadableScriptInterpreter and on the current interpreter, based on the dynamically allocated instance of the loaded (dynamically compiled) class. Required arguments to the interpreter command are: More... | |||
virtual string | CmdRunLoadedScript (ICommandLineApplicationInterpreter interpreter, string cmdName, string[] args) | ||
Interpreter command. Runs a command based on dynamically loaded loadable script class. Arguments passed to this command are directly passed on to the dynamically loaded script class installed on LoadableScriptInterpreter under the same cmdName . Typically, the command that is executed by the current method, has been previously installed by the CmdLoadScript(...) method. More... | |||
virtual string | WriteLoadableScriptReferencedAssemblies (ICommandLineApplicationInterpreter interpreter, string cmdName, string[] args) | ||
Interpreter command. Writes to the console the assemblies that are currently referenced by compiler used for dynamic loading of scripts. This information can be used for control if something goes wrong with dynamic script loading. More... | |||
virtual string | CmdExit (ICommandLineApplicationInterpreter interpreter, string cmdName, string[] args) | ||
Execution method that exits the interpreter. More... | |||
virtual string | CmdHelp (ICommandLineApplicationInterpreter interpreter, string cmdName, string[] args) | ||
Execution method for applications help. More... | |||
virtual string | CmdAbout (ICommandLineApplicationInterpreter interpreter, string cmdName, string[] args) | ||
Execution method that prints some information about the application. More... | |||
virtual string | CmdApplicationInfo (ICommandLineApplicationInterpreter interpreter, string cmdName, string[] args) | ||
Execution method that prints some information about the current application. More... | |||
virtual string | CmdComment (ICommandLineApplicationInterpreter interpreter, string cmdName, string[] args) | ||
Execution method that does nothing (for comments). More... | |||
virtual string | CmdPrintCommands (ICommandLineApplicationInterpreter interpreter, string cmdName, string[] args) | ||
Execution method for command that prints names of all installed applications. More... | |||
virtual string | CmdTestProduct (ICommandLineApplicationInterpreter interpreter, string cmdName, string[] args) | ||
Executinon method for test command, which just prints its name and arguments. More... | |||
virtual string | CmdTest (ICommandLineApplicationInterpreter interpreter, string cmdName, string[] args) | ||
Executinon method for test command, which just prints its name and arguments. More... | |||
virtual string | CmdTestSpeed (ICommandLineApplicationInterpreter interpreter, string cmdName, string[] args) | ||
Executinon method for TestSpeed command, performs test of speed of numerical computations on LU decomposition, and outputs the result and comparison with reference results (usually achieved on Igor's computer). More... | |||
virtual string | CmdTestSpeedLong (ICommandLineApplicationInterpreter interpreter, string cmdName, string[] args) | ||
Executinon method for TestSpeedLong command, performs a longer test of speed of numerical computations on QR decomposition, and outputs the result and comparison with reference results (usually achieved on Igor's computer). More... | |||
virtual string | CmdTestQR (ICommandLineApplicationInterpreter interpreter, string cmdName, string[] args) | ||
Executinon method for TestQR command, performs test of QR decomposition. More... | |||
virtual double | TestComputationalTimesQR (int numEq, int outLevel) | ||
Test of QR decomposition. Writes times necessary for all steps. More... | |||
virtual string | CmdTestLU (ICommandLineApplicationInterpreter interpreter, string cmdName, string[] args) | ||
Executinon method for TestLU command, performs test of LU decomposition. More... | |||
virtual double | TestComputationalTimesLU (int numEq, int outLevel) | ||
Test of LU decomposition. More... | |||
Protected Attributes | |
bool | _caseSensitive = false |
SortedDictionary< string, ApplicationCommandDelegate > | _commands = new SortedDictionary<string, ApplicationCommandDelegate>() |
SortedDictionary< string, string > | _variables = new SortedDictionary<string, string>() |
SortedDictionary< string, ModuleDelegate > | _modules = new SortedDictionary<string, ModuleDelegate>() |
List< String > | _loadedModules = new List<string>() |
string | _name = DefaultName |
string | _sescription = "Application's command-line interpreter." |
string | _description |
char | variableStart = '$' |
bool | _exit = false |
int | _outputLevel = DefaultOutputLevel |
Default level of output for some of the interpreters' functionality (e.g. asynchronous command execution). More... | |
ExpressionEvaluatorJs | _expressionEvaluator |
List< CommandLineJobContainer > | _parallelCommands |
ThreadPriority | _threadPriority = UtilSystem.ThreadPriority |
bool | _systemPriorityUpdatesRegistered = false |
Whether the "event" handler for system priprity changes has already been registered. More... | |
int | _maxNumParallelServers = 0 |
string | _ModuleTestCommandPrefix = "TestModule_" |
const string | TestSpeedReferenceSystem = "Intel Core i7 2.8 GHz" |
Description of reference configuration. More... | |
const int | TestSpeedNumEq = 500 |
Number of equations used to test speed of numerical computations. More... | |
const double | TestSpeedReferenceTime = 0.640917 |
Reference execution time for speed test for numerical operations. More... | |
const int | TestSpeedLongNumEq = 1000 |
Number of equations used to test speed of numerical computations. More... | |
const double | TestSpeedLongReferenceTime = 63.9688 |
Reference execution time for speed test for numerical operations. More... | |
Static Protected Attributes | |
static List < CommandLineApplicationInterpreter > | _interpreters = new List<CommandLineApplicationInterpreter>() |
static int | DefaultNumEquations = 1000 |
Properties | |
object | Lock [get] |
This object's central lock object to be used by other object. Do not use this object for locking in class' methods, for this you should use InternalLock. More... | |
bool | Exit [get, protected set] |
Whether the exit flag is set, usually causing interpreter to stop. More... | |
static List < CommandLineApplicationInterpreter > | Interpreters [get] |
static CommandLineApplicationInterpreter | Global [get] |
Global command-line interpreter. More... | |
string | Name [get, set] |
Name of the current interpreter. More... | |
string | Description [get, set] |
Description of hte current interpreter. More... | |
StopWatch | Timer [get] |
Gets the stopwatch used for measuring time of commands. More... | |
int | OutputLevel [get, set] |
Level of output for some of the interpreter's functionality (e.g. asynchronous command execution). More... | |
bool | WarnCommandReplacement [get, set] |
Specifies whether a wrning should be launched whenever an installed command is being replaced. More... | |
virtual bool | ThrowExceptions [get, set] |
Flag specifying whether exceptions are thrown in interactive mode or not. More... | |
ExpressionEvaluatorJs | ExpressionEvaluator [get, protected set] |
Expression evaluator used by the current More... | |
List< CommandLineJobContainer > | ParallelCommands [get] |
List where parallel commands are stored. More... | |
ThreadPriority | ThreadPriority [get, set] |
Priority of the current interpreter main thread and threads for executing the parallel commands. More... | |
int | MaxNumParallelServers [get, set] |
Maximal number of parallel servers allowed to be created for parallel command execution. More... | |
List< IAsyncResult > | AsyncCommandResults [get] |
List of IAsyncResult objects that were returned by asynchronous command invocations. More... | |
bool | AsyncEndInvokeInCallback [get, set] |
Flag indicating whether Endinvoke must be called in the callback of asynchronous command calls. More... | |
virtual LoadableScriptInterpreterBase | LoadableScriptInterpreter [get, set] |
Interpreter based on dynamically loadable scripts. This enables installation and running of commands that are based on C# code that is dynamically compiled. Ihe object is created on first get access if it has not been assigned before. This property can be overridden in derived classes such that getter creates a dynamically loadable script - based interpreter of another kind. This is important because different script loaders (in particuar with different dynamic libraries referenced) will be used in different contexts. Another possibility is that a custom object is assigned to this property, usually in the initialization stage of the current interpreter. More... | |
ScriptLoaderBase | ScriptLoader [get] |
Gets the script loader that is used by the current command-line interpreter for dynamically loading commands from scripts. More... | |
SortedList< string, IpcStreamServerBase > | PipeServers [get] |
Array of registered pipe servers, accessible through server name. More... | |
SortedList< string, IpcStreamClientBase > | IpcClients [get] |
Array of registered pipe clients, accessible through client name. More... | |
![]() | |
string | Name [get, set] |
Name of the current interpreter. More... | |
string | Description [get, set] |
Description of hte current interpreter. More... | |
bool | Exit [get] |
Whether the exit flag is set, usually causing interpreter to stop. More... | |
StopWatch | Timer [get] |
Gets the stopwatch used for measuring time of commands. More... | |
int | OutputLevel [get, set] |
Level of output for some of the interpreter's functionality (e.g. asynchronous command execution). More... | |
bool | WarnCommandReplacement [get, set] |
Specifies whether a wrning should be launched whenever an installed command is being replaced. More... | |
LoadableScriptInterpreterBase | LoadableScriptInterpreter [get, set] |
Interprater based on dynamically loadable scripts. This enables installation and running of commands that are based on C# code that is dynamically compiled. Ihe object is created on first get access if it has not been assigned before. This property can be overridden in derived classes such that getter creates a dynamically loadable script - based interpreter of another kind. This is important because different script loaders (in particuar with different dynamic libraries referenced) will be used in different contexts. Another possibility is that a custom object is assigned to this property, usually in the initialization stage of the current interpreter. More... | |
![]() | |
object | Lock [get] |
Private Member Functions | |
void | ModuleTest1 (string name, ICommandLineApplicationInterpreter interpreter) |
Loads the first built-in test module (just for testing modules). More... | |
void | ModuleTest2 (string name, ICommandLineApplicationInterpreter interpreter) |
Loads the second built-in test module (just for testing modules). More... | |
Private Attributes | |
object | _mainLock = new object() |
bool | _warnCommandReplacement = DefaultWarnCommandReplacement |
bool | _throwExceptions = false |
ParallelJobDispatcherGen < CommandLineJobContainer, CommandLineJobContainer > | _parallelDispatcher |
List< IAsyncResult > | _asyncCommandResults |
List of asynchronous results objects from individual asynchronous executions. More... | |
bool | _asyncEndInvokeInCallback = true |
LoadableScriptInterpreterBase | _loadableScriptInterpreter |
SortedList< string, IpcStreamServerBase > | _pipeServers = null |
SortedList< string, IpcStreamClientBase > | _pipeClients = null |
Simple command-line application interpreters, holds a set of commands that can be executed by name. Each of these command can take an arbitrary number of string arguments. Interpreter has its internal variables, which are strings. Each variable has a name and a value. If any arguments (and even command) start with the '$' character then then it is treated as reference to a variable and is substituted with the value of that variable (whose name follows the '$' character) before it is used.
This is a case of a very primitive interpreter, which can be used only for finding and executing commands by name and passing an array of strig arguments to them.
$A Igor Nov08;
|
inline |
Creates a new MessyApplication object initialized with some basisc applications.
The flag indicating whether interpreter is case sensitive or not is set to DefaultCaseSensitive
|
inline |
Construct a new commandline interpreter object initialized with some basisc commands.
caseSensitive | Flag that specifies whether command names are case sensitive. |
delegate string IG.Lib.CommandLineApplicationInterpreter.ApplicationCommandDelegate | ( | ICommandLineApplicationInterpreter | interpreter, |
string | commandName, | ||
string[] | args | ||
) |
Delegate for commands that are installed on interpreter.
interpreter | Interpreter on which commad is run. Enables access to interpreter internal data from command body. |
commandName | Command name. |
args | Command arguments. |
delegate void IG.Lib.CommandLineApplicationInterpreter.ModuleDelegate | ( | string | modulename, |
ICommandLineApplicationInterpreter | interpreter | ||
) |
Delegate for installing a module on the interpreter.
modulename | Name of the module. |
interpreter | Interperter where module is installed. |
|
inlinevirtual |
Returns the value of the specified variable of the current command line interpreter. null is returned if the specified variable does not exist.
varName | Name of the variable. |
Implements IG.Lib.ICommandLineApplicationInterpreter.
|
inlineprotectedvirtual |
Returns true if the specified string represents a variable reference, false otherwise.
str | String that is checked. |
|
inlineprotectedvirtual |
Returns value of the referenced variable if the specified string represents a variable reference (begins with the variableStart character, usually '$'), otherwise the original sting is returned.
str | String that is eventually substituted by variable value in the case that it represents a variable reference. |
|
inlinevirtual |
Sets the specified variable to the specified value.
varName | Name of the variable to be set. |
value | Value that is assigned to the variable. |
Implements IG.Lib.ICommandLineApplicationInterpreter.
|
inlinevirtual |
Clears (removes) the specified variable.
varName | Name of the variable to be cleared. |
Implements IG.Lib.ICommandLineApplicationInterpreter.
|
inlinevirtual |
Prints the specified variable.
varName | Name of the variable to be cleared. |
Implements IG.Lib.ICommandLineApplicationInterpreter.
|
inlinevirtual |
Parses a command line and extracts arguments from it. Arguments can be separated according to usual rules for command-line arguments: spaces are separators, there can be arbitraty number of spaces, and if we want an argument to contain spaces, we must enclose it in double quotes. Command line can also contain the command name followed by arguments. In this case it is treated in the same way, and command can be obtained simply as the first string in the returned array.
commandLine | Command line that is split to individual arguments. Command line can also contain a command, which is treated equally. |
Implements IG.Lib.ICommandLineApplicationInterpreter.
References IG.Lib.UtilStr.GetArgumentsArray().
|
inlinevirtual |
Runs all commands that are written in a file. Each line of a file is interpreted as a single command, consisting of command name followed by arguments.
filePath | Path to the file containing commands. |
Implements IG.Lib.ICommandLineApplicationInterpreter.
|
inlinevirtual |
Reads commands one by one from the standard input and executes them.
Implements IG.Lib.ICommandLineApplicationInterpreter.
References IG.Lib.UtilConsole.Read().
|
inlinestatic |
Executes the specified system commmand and blocks until the execution completes.
args | Array of strings where the first element is command to be executed, and the subsequent elements are command-line arguments. |
|
inlinestatic |
Executes system command with arguments.
command | Command string, usually a path to executable or other type of command. |
args | Arguments to system command. |
References IG.Lib.UtilSystem.ExecuteSystemCommand().
|
inlineprotectedvirtual |
Reads commands with their arguments ont by one from the console and executes them as system commands.
References IG.Lib.UtilConsole.Read().
|
inline |
Runs interpreter's expression evaluator interactively.
|
inline |
|
inline |
Returns an array of installed commands.
The returned array is created anew and command names are copied to it from a collection of keys of a sorted dictionary (type SortedDictionary{T, T}).
|
inlinevirtual |
Returns true if the interpreter contains a command with specified name, false otherwise.
commandName | Name of the command whose existence is queried. |
Implements IG.Lib.ICommandLineApplicationInterpreter.
|
inlinevirtual |
Runs command several times where the first argument is number of repetitions, second argument is command name. Extracts command name and runs the corresponding command delegate. Before running it, arguments for the application delegate are extracted and then passed to the delegate.
The interpreter's output level is used.
args | Command arguments where the first argument is command name. The rest of the arguments are collected and passed to the command delegate. |
|
inlinevirtual |
Runs command several times where the first argument is number of repetitions, second argument is command name. Extracts command name and runs the corresponding command delegate. Before running it, arguments for the application delegate are extracted and then passed to the delegate.
Output level 3 is used, such that all information is output to console.
args | Command arguments where the first argument is command name. The rest of the arguments are collected and passed to the command delegate. |
|
inlinevirtual |
Runs command several times where the first argument is number of repetitions, second argument is command name. Extracts command name and runs the corresponding command delegate. Before running it, arguments for the application delegate are extracted and then passed to the delegate.
Output level 0 is used, such that no information is output to console.
args | Command arguments where the first argument is command name. The rest of the arguments are collected and passed to the command delegate. |
|
inlinevirtual |
Runs command several times where the first argument is number of repetitions, second argument is command name. Extracts command name and runs the corresponding command delegate. Before running it, arguments for the application delegate are extracted and then passed to the delegate.
Output level is defined by the first argument. Level 0 means no output, level 1 means that summary is written to the console, and level e means that a note is printed before and afterr each repetition starts.
args | Command arguments where the first argument is command name. The rest of the arguments are collected and passed to the command delegate. |
|
inlinevirtual |
Runs command several times where the first argument is number of repetitions, second argument is command name. Extracts command name and runs the corresponding command delegate. Before running it, arguments for the application delegate are extracted and then passed to the delegate.
outputLevel | Level of output of the command. |
args | Command arguments where the first argument is command name. The rest of the arguments are collected and passed to the command delegate. |
References IG.Lib.StopWatch.Start(), IG.Lib.StopWatch.Stop(), IG.Lib.StopWatch.Time, IG.Lib.StopWatch.TotalCpuTime, and IG.Lib.StopWatch.TotalTime.
|
inlinevirtual |
Runs command in a try-catch block, where first argument is command name. Extracts command name and runs the corresponding command delegate. Before running it, arguments for the application delegate are extracted and then passed to the delegate.
outputLevel | Level of output of the command. |
args | Command arguments where the first argument is command name. The rest of the arguments are collected and passed to the command delegate. |
|
inline |
Runs the specified command with specified name, installed on the current application object, without any modifications of the command arguments.
commandName | Command name. |
commandArguments | Command arguments. |
This method should not be overriden, but the Run(string, string[]) method can be, e.g. in order to perform some argument or command name transformations.
Implements IG.Lib.ICommandLineApplicationInterpreter.
|
inlinevirtual |
Runs the specified command with specified name, installed on the current application object.
commandName | Command name. |
commandArguments | Command arguments. |
Reimplemented in IG.Lib.CommandLineApplicationScriptInterpreter.
Referenced by IG.Lib.ApplicationCommandlineBase.AplicationMain().
|
inline |
Runs command where the first argument is command name. Extracts command name and runs the corresponding command delegate.Before running it, arguments for the application delegate are extracted and then passed to the delegate.
args | Command arguments where the first argument is command name. The rest of the arguments are collected and passed to the command delegate. |
Implements IG.Lib.ICommandLineApplicationInterpreter.
|
inline |
Adds a new parallel command data to the list of commands executed by in parallel.
commandData | Command data object that is added to the list of barallelly executed commands. |
|
inline |
Returns the command data object of the parallel command that with the specified ID.
id | Identification nuber of the job container that carries command data and executes it. |
References IG.Lib.CommandLineJobContainer.Id.
|
inline |
Prints the commands that were scheduled for parallel execution, together with their current status, results and execution times (when available).
printAll | Whether all commands are printed (included those already completed). If false then only completed commands are printed. |
References IG.Lib.CommandLineJobContainer.ToString().
|
inlinevirtual |
Updates thread priority (property ThreadPriority) of the interpreter to the current global thread priority (the UtilSystem.ThreadPriority property).
References IG.Lib.UtilSystem.ThreadPriority.
|
inline |
Registers the UpdateThreadPriorityFromSystem method as "event handler" for system priority changes. After registration, this method will be called every time the value of the UtilSystem.ThreadPriority property changes.
References IG.Lib.UtilSystem.AddOnThreadPriorityChange().
Referenced by IG.Lib.ShellApplication< InterpreterType >.CreateInterpreter().
|
inline |
Unregisters the UpdateThreadPriorityFromSystem method as "event handler" for system priority changes.
References IG.Lib.UtilSystem.RemoveOnThreadPriorityChange().
|
inline |
Runs the specified command with arguments the specified number of times in parallel threads by using the interpreter's job dispatcher with corresponding parallel servers.
numRepeat | Number of parallel executions of the command that are started. |
command | Command that is run in each of the parallel threads. |
commandArguments | Command arguments. |
Parallel commands are scheduled for execution by interpreter's dispathcer (the ParallelDispatcher property), which delegates execution to its parallel servers.
Before transferring them to the dispatcher, commands are wrapped into job container object of type CommandLineJobContainer. Job containers are stored in a list, such that execution status and results can be accessed through contaier ID (which is returned by the method).
New parallel servers are dynamically added to the dispatcher if there are no idle servers to execute the parallel command immediately at the time it is called. However, the maximal number of parallel servers can be limited by the MaxNumParallelServers property.
References IG.Lib.CommandLineJobContainer.CommandArguments, IG.Lib.CommandLineJobContainer.CommandName, and IG.Lib.CommandLineJobContainer.Id.
|
inline |
Runs she specified command with arguments once in a parallel thread by using the interpreter's job dispatcher with corresponding parallel servers.
command | Command that is run in each of the parallel threads. |
commandArguments | Command arguments. |
|
inlinevirtual |
Runs a command asynchronously where the first argument is command name. Extracts command name and runs the corresponding application delegate. Before running it, arguments for the application delegate are extracted and then passed to the delegate.
args | Command arguments where the first argument is command name. The rest of the arguments are collected and passed to the command delegate. |
Implements IG.Lib.ICommandLineApplicationInterpreter.
|
inlinevirtual |
Runs the command with specified name (installed on the current interpreter object) asynchronously.
commandName | Command name. |
commandArguments | Command arguments. |
Implements IG.Lib.ICommandLineApplicationInterpreter.
|
inline |
Returns true if the asynchronous command execution identified by id has completed, and false otherwise.
id | ID of the asynchronous command execution that is querried. |
Implements IG.Lib.ICommandLineApplicationInterpreter.
|
inline |
Returns true if all asynchronous command executions have completed, and false otherwise.
|
inline |
Waits until all asynchronously commands that have been eventually executed by the current interpreter, complete.
It is sometimes necessary to call this method if any asynchronous command invocations were made because such commands are executed in background threads, which are automatically broken when all foreground threads complete.
Implements IG.Lib.ICommandLineApplicationInterpreter.
|
inline |
Waits for the specified asynchronous command (specified by command ID) to complete.
callId | ID of the asynchronous command execution. |
Implements IG.Lib.ICommandLineApplicationInterpreter.
|
inlineprotected |
Callback method for asynchronous command executions.
ar | Asynchronous results that are passed to the method. |
|
inlinevirtual |
Adds command with the specified name.
commandName | Name of the commant. |
commandDelegate | Delegate that will be used to execute the command. |
|
inlinevirtual |
Removes the command with the specified name.
commandName | Name of the commad. |
Implements IG.Lib.ICommandLineApplicationInterpreter.
|
inlinevirtual |
Removes all commands from the current interpreter.
Implements IG.Lib.ICommandLineApplicationInterpreter.
|
inlinevirtual |
Adds a new module to the interpreter. This adds an initialization function (via a delegate) which is executed when module module initialization is performed.
moduleName | Name of the module. When used, module names are case sensitive if commands are case sensitive. |
moduleDelegate | Method that performs module initialization. |
|
inlinevirtual |
Loads and initializes the specified module.
moduleName | Name of the module. It is case sensitive if commands are case sensitive. |
Implements IG.Lib.ICommandLineApplicationInterpreter.
|
inlinevirtual |
Returns the standard name for the command that gets installed when a module is loaded.
modulename | Name of the module that is loaded. |
Whenever a module is loaded,
|
inlinevirtual |
Returns true if the specified module has been loaded on the interpreter, false if not.
moduleName | Name of the module. |
Implements IG.Lib.ICommandLineApplicationInterpreter.
|
inlinevirtual |
Dynamically loads (temporarily, just for execution of the current commad) a class form the script contained in the specified file and executes its executable method. The file must contain the script that is dynamically loaded and executed, in form of definition of the appropriate class of type ILoadableScript. The dynamically loadable script class is loaded from the file and instantiated by the LoadableScriptInterpreter interpreter that is based on loadable scripts.
scriptFilePath | Path to the file containing loadable script must be the first argument to the method. |
initAndRunArgs | Initialization arguments for the object that will be instantiated in order to execute the script. |
Implements IG.Lib.ICommandLineApplicationInterpreter.
|
inline |
Dynamically loads (compiles and instantiates) a loadable script class contained in the specified file, and installs a new command on LoadableScriptInterpreter and on the current interpreter, based on the dynamically created instance of the loaded (dynamically compiled) class.
newCommandName | Name of the newly installed command. |
scriptFilePath | Name of the file containing the script code that defines a loadable script class. |
initArgs | Arguments to the initialization method of the loaded object. The initialization method will be called before the first call to the executable method of the class, which takes care of execution of the newly installed command. |
Implements IG.Lib.ICommandLineApplicationInterpreter.
|
inlinevirtual |
Executes the specified command that has been dynamically loaded form a script.
commandName | Name under which the command is installed on the current intepreter and on interpreder based on dynamically loaded scripts (LoadableScriptInterpreter). |
arguments | Arguments to the command. |
Implements IG.Lib.ICommandLineApplicationInterpreter.
|
inline |
Returns an array of assemblies that are currently referenced by the script loader that takes care of loading the dynamic scripts.
Implements IG.Lib.ICommandLineApplicationInterpreter.
|
inlineprotectedvirtual |
Command. Sets the specified varuable to the specified value.
Usage:
interpreter | Interpreter on which commad is run. |
cmdName | Command name. |
args | Command arguments. |
References IG.Lib.UtilSystem.GetCurrentProcessExecutableName().
|
inlineprotectedvirtual |
Command. Gets the specified varuable and returns its value (or null if the variable does not exist). Variable name must be the only argument of the command.
interpreter | Interpreter on which commad is run. |
cmdName | Command name. |
args | Command arguments. |
References IG.Lib.UtilSystem.GetCurrentProcessExecutableName().
|
inlineprotectedvirtual |
Command. Clears the specified varuable. Variable name must be the only argument of the command.
interpreter | Interpreter on which commad is run. |
cmdName | Command name. |
args | Command arguments. |
References IG.Lib.UtilSystem.GetCurrentProcessExecutableName().
|
inlineprotectedvirtual |
Command. Prints the specified varuable. Variable name must be the only argument of the command.
interpreter | Interpreter on which commad is run. |
cmdName | Command name. |
args | Command arguments. |
References IG.Lib.UtilSystem.GetCurrentProcessExecutableName().
|
inlineprotectedvirtual |
Command. Prints concatenated argument with spaces between them.
interpreter | Interpreter on which commad is run. |
cmdName | Command name. |
args | Command arguments. |
|
inlineprotectedvirtual |
Command. Prints concatenated argument with spaces between them.
interpreter | Interpreter on which commad is run. |
cmdName | Command name. |
args | Command arguments. |
References IG.Lib.UtilSystem.GetCurrentProcessExecutableName().
|
inlineprotectedvirtual |
Command. Runs a file by running all its lines in the current interpreter. File name must be the only argument of the command.
interpreter | Interpreter on which commad is run. |
cmdName | Command name. |
args | Command arguments. |
References IG.Lib.UtilSystem.GetCurrentProcessExecutableName().
|
inlineprotectedvirtual |
Command. Runs another command repetitively the specified number of times. First argument must be the number of times command is run, the second argument must be command to be run repetitively, and the rest of the arguments are passed to that command as its arguments.
interpreter | Interpreter on which commad is run. |
cmdName | Command name. |
args | Command arguments. |
References IG.Lib.UtilSystem.GetCurrentProcessExecutableName().
|
inlineprotectedvirtual |
Command. Runs another command repetitively the specified number of times. First argument must be the number of times command is run, the second argument must be command to be run repetitively, and the rest of the arguments are passed to that command as its arguments.
interpreter | Interpreter on which commad is run. |
cmdName | Command name. |
args | Command arguments. |
References IG.Lib.UtilSystem.GetCurrentProcessExecutableName().
|
inlineprotectedvirtual |
Command. Runs another command in a try-catch block, such that if command throws an exception execution is not broken. The second argument must be command to be run, and the rest of the arguments are passed to that command as its arguments.
interpreter | Interpreter on which commad is run. |
cmdName | Command name. |
args | Command arguments. |
References IG.Lib.UtilSystem.GetCurrentProcessExecutableName().
|
inlineprotectedvirtual |
Command. Sets the flag for rethrowing exceptions in the interaction mode. Optional boolean arguemnt, default is true.
interpreter | Interpreter on which commad is run. |
cmdName | Command name. |
args | Command arguments. |
References IG.Lib.UtilSystem.GetCurrentProcessExecutableName(), and IG.Lib.Util.TryParseBoolean().
|
inlineprotectedvirtual |
Command. Runs interpreter commands interactively. Reads commands one by one from console and executes them, until only Enter is pressed..
interpreter | Interpreter on which commad is run. |
cmdName | Command name. |
args | Command arguments. |
References IG.Lib.UtilSystem.GetCurrentProcessExecutableName().
|
inlineprotectedvirtual |
Command. Runs the specified command-line by the operating system. The first argument is the command to be executed while the following arguments are arguments to this command. If there are no arguments then user is requested to insert commands interactively.
interpreter | Interpreter on which commad is run. |
cmdName | Command name of this command. |
args | Command arguments this command. |
References IG.Lib.UtilSystem.GetCurrentProcessExecutableName().
|
inlineprotectedvirtual |
Command. Runs the built in expression evaluator.
interpreter | Interpreter on which commad is run. |
cmdName | Command name of this command. |
args | Command arguments this command. |
References IG.Lib.UtilSystem.GetCurrentProcessExecutableName().
|
inlineprotectedvirtual |
Interpreter command. Sets the priority of the current process.
interpreter | Interpreter by which commad is run. |
cmdName | Command name. |
args | Command arguments of this command. |
References IG.Lib.UtilSystem.GetCurrentProcessExecutableName(), IG.Lib.UtilSystem.ThreadPriority, and IG.Lib.Util.TryParseThreadPriority().
|
inlineprotectedvirtual |
Interpreter command. Runs the specified command-line in parallel thread.
The first argument is the command to be executed while the following arguments are arguments to this command.
interpreter | Interpreter on which commad is run. |
cmdName | Command name of this command. |
args | Command arguments of this command. |
References IG.Lib.UtilSystem.GetCurrentProcessExecutableName().
|
inlineprotectedvirtual |
Interpreter command. Runs the specified command-line several times in the specified number of parallel threads.
The first argument is the number of parallel executions of the same command, the second argument is command to be executed while the following arguments are arguments to this command.
interpreter | Interpreter on which commad is run. |
cmdName | Command name of this command. |
args | Command arguments of this command. |
References IG.Lib.UtilSystem.GetCurrentProcessExecutableName().
|
inlineprotectedvirtual |
Interpreter command. Prints data about commands executed in parallel threads.
The optional first argument is a flag (boolean, can be integer) that specifies whether the completed commands are also printed or not. Default is true.
interpreter | Interpreter by which commad is run. |
cmdName | Command name of this command. |
args | Command arguments of this command. |
References IG.Lib.UtilSystem.GetCurrentProcessExecutableName(), and IG.Lib.Util.TryParseBoolean().
|
inlineprotectedvirtual |
Command. Runs the specified command-line asynchronously.
The first argument is the command to be executed while the following arguments are arguments to this command.
interpreter | Interpreter on which commad is run. |
cmdName | Command name of this command. |
args | Command arguments of this command. |
References IG.Lib.UtilSystem.GetCurrentProcessExecutableName().
|
inlineprotectedvirtual |
Command. Wait until asynchronously invoked command with the specified ID (first argument, must represent an int) completes.
The first argument is the ID of asynchronous invocation whose results are waited.
interpreter | Interpreter on which commad is run. |
cmdName | Command name of this command. |
args | Command arguments of this command. |
References IG.Lib.UtilSystem.GetCurrentProcessExecutableName().
|
inlineprotectedvirtual |
Command. Returns a flag indicating whether the asynchroneous command invocation identified by the specified ID (first argument, must represent an int) has completed.
The first argument is the ID of asynchronous invocation whose completion is waited for.
interpreter | Interpreter on which commad is run. |
cmdName | Command name of this command. |
args | Command arguments of this command. |
References IG.Lib.UtilSystem.GetCurrentProcessExecutableName().
|
inlineprotectedvirtual |
Command. Sleeps (suspends execution of the executing thread) for the specified number of seconds.
The first argument is the number of seconds (must be string representing double) to sleep.
interpreter | Interpreter on which commad is run. |
cmdName | Command name of this command. |
args | Command arguments of this command. |
References IG.Lib.UtilSystem.GetCurrentProcessExecutableName().
|
inlineprotectedvirtual |
Command. Loads the specified module (whos name must be the first argument) and performs its initialization. If there are more than 1 arguments then the rest of the arguments specify a command and (if more than 1) its arguments, and the specified command is also run.
interpreter | Interpreter on which commad is run. |
cmdName | Command name. |
args | Command arguments. |
References IG.Lib.UtilSystem.GetCurrentProcessExecutableName().
|
inlineprotectedvirtual |
Executinon method for command that checks if module is loaded. Writes to condole whether module is loaded or not, and returns "1" if module is loaded and "0" if not.
interpreter | Interpreter on which commad is run. |
cmdName | Command name. |
args | Command arguments. |
References IG.Lib.UtilSystem.GetCurrentProcessExecutableName().
|
inlineprotectedvirtual |
Executinon method for test command that is installed when a module is installed. This is a command that enables to verify that a module with the specified name has been installed.
interpreter | Interpreter on which commad is run. |
cmdName | Command name. |
args | Command arguments. |
References IG.Lib.UtilSystem.GetCurrentProcessExecutableName().
|
inlineprotectedvirtual |
Executinon method for test command, which just prints its name and arguments. This is a replacement for usuel test command, which gets installed when one of the two basic test modules are installed.
interpreter | Interpreter on which commad is run. Enables access to interpreter internal data from command body. |
cmdName | Command name. |
args | Command arguments. |
References IG.Lib.UtilSystem.GetCurrentProcessExecutableName().
|
inline |
Creates and registers a new interpreter's named pipe server.
pipeName | Name of the pipe where the server listens. |
serverName | name of the pipe server. If not specified then it is the same as pipe name. |
createCommand | Whether an interpreter command is created for accessig the server. Not functional at the moment. |
outputLevel | Output level with which the server is started. |
References IG.Lib.IpcStreamClientServerBase.OutputLevel, and IG.Lib.IpcStreamServerBase.ThreadServe().
|
inline |
Removes the specified interpreter's named pipe servers. Servers are stopped and their pipes closed. Returns a string contaiing information about the removed servers.
serverNames | Names of the servers to be removed. |
References IG.Lib.IpcStreamClientServerBase2.ClosePipe(), IG.Lib.IpcStreamClientServerBase2.Name, and IG.Lib.IpcStreamServerBase.StopServer().
|
inline |
Returns a string containing informattion on the installed named pipe servers.
serverName | Name of the pipe server (optional). If specified then information is returned only for the server with this particular name (otherwise information is returned for all installed servers). |
|
inlineprotectedvirtual |
Command. Creates a new server that listens for interpreter commands on a named pipe, executes them, and writes result back to the named pipe. Command arguments are pipe name and server name (optional, if not specified then server name is the same as pipe name).
interpreter | Interpreter on which commad is run. |
cmdName | Command name. |
args | Command arguments. |
References IG.Lib.UtilSystem.GetCurrentProcessExecutableName(), and IG.Lib.Util.TryParseBoolean().
|
inlineprotectedvirtual |
Command. Removes the spcified (or all, if names are not specified) named pipe servers. Command arguments are names of the pipe servers to be removed. If none is specified then all pipe servers installed on the interperter are removed.
interpreter | Interpreter on which commad is run. |
cmdName | Command name. |
References IG.Lib.UtilSystem.GetCurrentProcessExecutableName().
|
inlineprotectedvirtual |
Command. Prints and returns inormation on the installed named pipe servers. Optional command argument is server name. If not specified then information about all installed servers is printed and returned.
cmdName | Command name. |
References IG.Lib.UtilSystem.GetCurrentProcessExecutableName().
|
inline |
Creates and registers a new interpreter's named pipe client.
pipeName | Name of the pipe where the client listens. |
clientName | name of the pipe client. If not specified then it is the same as pipe name. |
createCommand | Whether command for direct access is created or not. If true then an interpreter command with the same name as the name of the client is created, which can be directly used for sending requests by the created client (without specifying the command for sending a request first and then the server name and then the actual command). |
outputLevel | Output level with which the client is started. |
References IG.Lib.NamedPipeClientBase.Connect(), and IG.Lib.IpcStreamClientServerBase.OutputLevel.
|
inline |
Removes the specified interpreter's named pipe clients. Client's pipes are closed. Returns a string contaiing information about the removed clients.
clientNames | Names of the clients to be removed. |
References IG.Lib.IpcStreamClientServerBase2.ClosePipe(), and IG.Lib.IpcStreamClientServerBase2.Name.
|
inline |
Returns a string containing informattion on the installed named pipe clients.
clientName | Name of the pipe client. If specified then information is returned only for the client with this particular name (otherwise information is returned for all installed clients). |
|
inline |
Sends the specified command to the corresponding pipe serverr and reads and returns its response.
clientName | Name of the pipe client that sends the request to the named pipe server and returns the response. |
commandLineString | Comandline string that is sent to the server as request. |
References IG.Lib.IpcStreamClientBase.GetServerResponse().
|
inlineprotectedvirtual |
Command. Creates a new client to the interpreter pipe server. The client can send command to the server listening on the specified named pipe, and recieves responses from the server and returns them. Command arguments are pipe name and client name (optional, if not specified then server name is the same as pipe name).
interpreter | Interpreter on which commad is run. |
cmdName | Command name. |
References IG.Lib.UtilSystem.GetCurrentProcessExecutableName(), and IG.Lib.Util.TryParseBoolean().
|
inlineprotectedvirtual |
Command. Removes the spcified (or all, if names are not specified) named pipe clients. Command arguments are names of the pipe clients to be removed. If none is specified then all pipe clients installed on the interperter are removed.
interpreter | Interpreter on which commad is run. |
cmdName | Command name. |
References IG.Lib.UtilSystem.GetCurrentProcessExecutableName().
|
inlineprotectedvirtual |
Command. Prints and returns inormation on the installed named pipe clients. Optional command argument is client name. If not specified then information about all installed clients is printed and returned.
cmdName | Command name. |
References IG.Lib.UtilSystem.GetCurrentProcessExecutableName().
|
inlineprotectedvirtual |
Command. Sends the specified command to the corresponding pipe serverr and reads and returns its response. Command argument is the (interpreter's) name of the pipe client followed by command and eventual arguments sent to the server.
cmdName | Command name. |
References IG.Lib.UtilStr.GetCommandLine(), and IG.Lib.UtilSystem.GetCurrentProcessExecutableName().
|
inlineprotectedvirtual |
Interpreter command. Dynamically creates and runs an internal script object, i.e. an object of the class that is already compiled in the code. Interpreter command arguments: The first argument must be a full name of the script class whose object is run. The rest of the arguments (if any) are directly transferred to the executable method of the script and are also used as argument to script initialization method.
interpreter | Interpreter on which commad is run. |
commandName | Name of the command |
commandArgumens | Command arguments. |
References IG.Lib.ScriptLoaderBase.CreateScriptObject(), IG.Lib.UtilSystem.GetCurrentProcessExecutableName(), IG.Lib.ILoadableScript.InitializationArguments, and IG.Lib.ILoadableScript.Run().
|
inlineprotectedvirtual |
Interpreter command. Dynamically loads (temporarily, just for execution of the current commad) a class form the script contained in the specified file and executes its executable method. The file must contain the script that is dynamically loaded and executed, in form of definition of the appropriate class of type ILoadableScript . The dynamically loadable script class is loaded from the file and instantiated by the LoadableScriptInterpreter loadable script-based interpreter object. Interpreter command arguments: Path to the file containing loadable script must be the first argument to the method. The rest of the arguments (if any) are directly transferred to the executable method of the script.
interpreter | Interpreter on which commad is run. |
commandName | Name of the command |
commandArgumens | Command arguments. |
References IG.Lib.UtilSystem.GetCurrentProcessExecutableName().
|
inlineprotectedvirtual |
Interpreter command. Dynamically loads (compiles and instantiates) a loadable script class contained in the specified file, and installs a new command on LoadableScriptInterpreter and on the current interpreter, based on the dynamically allocated instance of the loaded (dynamically compiled) class. Required arguments to the interpreter command are:
interpreter | Interpreter on which commad is run. |
commandName | Name of the command |
commandArgumens | Command arguments. |
References IG.Lib.UtilSystem.GetCurrentProcessExecutableName().
|
inlineprotectedvirtual |
Interpreter command. Runs a command based on dynamically loaded loadable script class. Arguments passed to this command are directly passed on to the dynamically loaded script class installed on LoadableScriptInterpreter under the same cmdName . Typically, the command that is executed by the current method, has been previously installed by the CmdLoadScript(...) method.
interpreter | Interpreter on which commad is run. |
commandName | Name of the command, which must be the same as command name under which dynamically loaded class is installed on LoadableScriptInterpreter. |
commandArgumens | Command arguments. These arguments are directly passed to the executable method on the corresponding class. |
References IG.Lib.UtilSystem.GetCurrentProcessExecutableName().
|
inlineprotectedvirtual |
Interpreter command. Writes to the console the assemblies that are currently referenced by compiler used for dynamic loading of scripts. This information can be used for control if something goes wrong with dynamic script loading.
interpreter | Interpreter on which commad is run. |
commandName | Name of the command. |
commandArgumens | Command arguments. |
References IG.Lib.UtilSystem.GetCurrentProcessExecutableName().
|
inlineprotectedvirtual |
Execution method that exits the interpreter.
interpreter | Interpreter on which commad is run. |
cmdName | Command name. |
args | Command arguments. |
References IG.Lib.UtilSystem.GetCurrentProcessExecutableName().
|
inlineprotectedvirtual |
Execution method for applications help.
interpreter | Interpreter on which commad is run. |
cmdName | Command name. |
args | Command arguments. |
References IG.Lib.UtilSystem.GetCurrentProcessExecutableName().
|
inlineprotectedvirtual |
Execution method that prints some information about the application.
interpreter | Interpreter on which commad is run. |
cmdName | Command name. |
args | Command arguments. |
Reimplemented in IG.Lib.NeuralApplicationInterpreter.
References IG.Lib.UtilSystem.GetApplicationInfo(), IG.Lib.UtilSystem.GetAssemblyByName(), IG.Lib.UtilSystem.GetCurrentProcessExecutableName(), and IG.Lib.Util.TryParseBoolean().
|
inlineprotectedvirtual |
Execution method that prints some information about the current application.
interpreter | Interpreter on which commad is run. |
cmdName | Command name. |
args | Command arguments. |
References IG.Lib.UtilSystem.GetApplicationInfo(), IG.Lib.UtilSystem.GetAssemblyByName(), IG.Lib.UtilSystem.GetCurrentProcessExecutableName(), and IG.Lib.Util.TryParseBoolean().
|
inlineprotectedvirtual |
Execution method that does nothing (for comments).
interpreter | Interpreter on which commad is run. |
cmdName | Command name. |
args | Command arguments. |
References IG.Lib.UtilSystem.GetCurrentProcessExecutableName().
|
inlineprotectedvirtual |
Execution method for command that prints names of all installed applications.
interpreter | Interpreter on which commad is run. |
cmdName | Command name. |
args | Command arguments. |
References IG.Lib.UtilSystem.GetCurrentProcessExecutableName().
|
inlineprotectedvirtual |
Executinon method for test command, which just prints its name and arguments.
interpreter | Interpreter on which commad is run. |
cmdName | Command name. |
args | Command arguments. |
References IG.Lib.UtilSystem.GetCurrentProcessExecutableName().
|
inlineprotectedvirtual |
Executinon method for test command, which just prints its name and arguments.
interpreter | Interpreter on which commad is run. |
cmdName | Command name. |
args | Command arguments. |
References IG.Lib.UtilSystem.GetCurrentProcessExecutableName().
|
inlineprotectedvirtual |
Executinon method for TestSpeed command, performs test of speed of numerical computations on LU decomposition, and outputs the result and comparison with reference results (usually achieved on Igor's computer).
interpreter | Interpreter on which commad is run. |
cmdName | Command name. |
args | Command arguments. |
References IG.Lib.UtilSystem.GetCurrentProcessExecutableName().
|
inlineprotectedvirtual |
Executinon method for TestSpeedLong command, performs a longer test of speed of numerical computations on QR decomposition, and outputs the result and comparison with reference results (usually achieved on Igor's computer).
interpreter | Interpreter on which commad is run. |
cmdName | Command name. |
args | Command arguments. |
References IG.Lib.UtilSystem.GetCurrentProcessExecutableName().
|
inlineprotectedvirtual |
Executinon method for TestQR command, performs test of QR decomposition.
Command takes 1 argument that is dimension of the system of equations to be solved. If dimension is not stated then default value is taken.
Optionally, command can take the second argument that represents number of repetitions of the decomposition test. In this tame, command returns average total execution time for each test.
interpreter | Interpreter on which commad is run. |
cmdName | Command name. |
args | Command arguments. |
References IG.Lib.UtilSystem.GetCurrentProcessExecutableName().
|
inlineprotectedvirtual |
Test of QR decomposition. Writes times necessary for all steps.
numEq | Number of equations to be solved with decomposition. |
outLevel | Level of output. |
References IG.Num.SpeedTestCpu.TestComputationalTimesQR().
|
inlineprotectedvirtual |
Executinon method for TestLU command, performs test of LU decomposition.
Command takes 1 argument that is dimension of the system of equations to be solved. If dimension is not stated then default value is taken.
Optionally, command can take the second argument that represents number of repetitions of the decomposition test. In this tame, command returns average total execution time for each test.
interpreter | Interpreter on which commad is run. |
cmdName | Command name. |
args | Command arguments. |
References IG.Lib.UtilSystem.GetCurrentProcessExecutableName().
|
inlineprotectedvirtual |
Test of LU decomposition.
outLevel | Level of output. |
numEq | Number of equations to be solved with decomposition. |
References IG.Num.SpeedTestCpu.TestComputationalTimesLU().
|
inlineprivate |
Loads the first built-in test module (just for testing modules).
name | Name under which the module is being loaded. |
interpreter | Command line interpreter under on which the module is loaded. |
References IG.Lib.ICommandLineApplicationInterpreter.AddCommand().
|
inlineprivate |
Loads the second built-in test module (just for testing modules).
name | Name under which the module is being loaded. |
interpreter | Command line interpreter under on which the module is loaded. |
References IG.Lib.ICommandLineApplicationInterpreter.AddCommand().
const bool IG.Lib.CommandLineApplicationInterpreter.DefaultCaseSensitive = false |
Default value of the flg indicating whether command names are case sensitive.
|
protected |
|
private |
|
staticprotected |
|
protected |
|
protected |
|
protected |
|
protected |
const string IG.Lib.CommandLineApplicationInterpreter.DefaultName = "ApplicationIntepreter" |
Default interpreter name.
const string IG.Lib.CommandLineApplicationInterpreter.AutoGlobalName = "AutomaticGlobalInterpreter" |
const string IG.Lib.CommandLineApplicationInterpreter.AutoGlobalDescription = "Automatically created global command-line interpreter." |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
StopWatch IG.Lib.CommandLineApplicationInterpreter._timer |
|
static |
|
protected |
Default level of output for some of the interpreters' functionality (e.g. asynchronous command execution).
|
static |
|
private |
|
private |
|
protected |
|
protected |
|
private |
|
protected |
|
protected |
Whether the "event" handler for system priprity changes has already been registered.
|
protected |
|
private |
List of asynchronous results objects from individual asynchronous executions.
|
private |
|
protected |
|
private |
|
private |
|
private |
|
protected |
Description of reference configuration.
|
protected |
Number of equations used to test speed of numerical computations.
|
protected |
Reference execution time for speed test for numerical operations.
|
protected |
Number of equations used to test speed of numerical computations.
|
protected |
Reference execution time for speed test for numerical operations.
|
staticprotected |
|
get |
This object's central lock object to be used by other object. Do not use this object for locking in class' methods, for this you should use InternalLock.
|
getprotected set |
Whether the exit flag is set, usually causing interpreter to stop.
|
staticget |
|
staticget |
Global command-line interpreter.
This returns the first interpreter created in the application, or a new interpreter if no interpreters have been created yet.
|
getset |
Name of the current interpreter.
|
getset |
Description of hte current interpreter.
|
get |
Gets the stopwatch used for measuring time of commands.
This property always returns an initialized stopwatch.
|
getset |
Level of output for some of the interpreter's functionality (e.g. asynchronous command execution).
|
getset |
Specifies whether a wrning should be launched whenever an installed command is being replaced.
Referenced by IG.Lib.ApplicationCommandlineBase.AplicationMain(), and IG.Lib.LoadableScriptBase.Script_CreateInterpreterWithoutCommands().
|
getset |
Flag specifying whether exceptions are thrown in interactive mode or not.
If false then only error messages are written to console, but exceptions are not rethrown.
In some modes of operation, exceptions thrown in commands executed by the interpreter are cought, user is notified about the exception (usually by writing the error message to the console), but exceptions are not re-thrown. Because of this behavior, much information about exceptions is lost (e.g. the stack trace).
|
getprotected set |
Expression evaluator used by the current
|
get |
List where parallel commands are stored.
|
getset |
Priority of the current interpreter main thread and threads for executing the parallel commands.
Setting priority changes priority of the threads.
|
getset |
Maximal number of parallel servers allowed to be created for parallel command execution.
If less than 1 then creation of unlimited number of servers is allowed. As long as the number is not exceeded, new servers will be created whenever a new parallel jobs are created and no servers are idle, in order to start execution of new parallel jobs immediately.
|
getprotected |
List of IAsyncResult objects that were returned by asynchronous command invocations.
Lazy evaluation, created when getter is invoked first time.
|
getsetprotected |
Flag indicating whether Endinvoke must be called in the callback of asynchronous command calls.
This flag is unset temporarily in methods where endinvoke is called explicitly.
|
getset |
Interpreter based on dynamically loadable scripts. This enables installation and running of commands that are based on C# code that is dynamically compiled. Ihe object is created on first get access if it has not been assigned before. This property can be overridden in derived classes such that getter creates a dynamically loadable script - based interpreter of another kind. This is important because different script loaders (in particuar with different dynamic libraries referenced) will be used in different contexts. Another possibility is that a custom object is assigned to this property, usually in the initialization stage of the current interpreter.
ArgumentNullException | When set to null reference. |
$A Igor Aug11;
|
get |
Gets the script loader that is used by the current command-line interpreter for dynamically loading commands from scripts.
|
getprivate |
Array of registered pipe servers, accessible through server name.
|
getprivate |
Array of registered pipe clients, accessible through client name.