C# Class Myre.Debugging.CommandEngine

A class which provides a command line interface into an assembly.
Exibir arquivo Open project: TomGillen/Myre Class Usage Examples

Public Methods

Method Description
AddCommand ( object target, string methodName ) : void

Adds the command.

AddCommand ( object target, string methodName, string commandName, string description = null ) : void

Adds the command.

AddOption ( object target, string propertyName ) : void

Adds the option.

AddOption ( object target, string propertyName, string optionName, string description = null ) : void

Adds the option.

CommandEngine ( ) : System

Initializes a new instance of the CommandEngine class.

Execute ( string command ) : CommandResult

Executes the specified command.

GetHelp ( string command ) : Myre.Debugging.CommandHelp

Gets intellisense-like help for a command.

GetHelp ( ) : IEnumerable

Gets the command and option help.

GetIdentifierHelp ( string commandOrOption ) : CommandHelpInfo?

Gets help information for a command or option.

RemoveCommand ( string commandName ) : void

Removes the command.

RemoveOption ( string optionName ) : void

Private Methods

Method Description
AppendDefinition ( string item, Myre.Debugging.CommandHelp &commandHelp ) : bool
FindParameterHelp ( string command, string parameters, Myre.Debugging.CommandHelp &help ) : void
GetExpressionHelp ( string command, Myre.Debugging.CommandHelp &help ) : void
GetOption ( string optionName ) : object
GetOrSet ( PropertyInfo property ) : object
GetReturnType ( string item ) : string
ParametersDescription ( MethodInfo method ) : object
RunExpression ( string commandString ) : object
ScanAssembly ( Assembly assembly ) : void
SplitParameters ( string parametersString ) : string[]

Method Details

AddCommand() public method

Adds the command.
public AddCommand ( object target, string methodName ) : void
target object The object containing the method.
methodName string Name of the method.
return void

AddCommand() public method

Adds the command.
public AddCommand ( object target, string methodName, string commandName, string description = null ) : void
target object The object containing the method.
methodName string Name of the method.
commandName string Name of the command.
description string
return void

AddOption() public method

Adds the option.
public AddOption ( object target, string propertyName ) : void
target object The object containing the property.
propertyName string Name of the property.
return void

AddOption() public method

Adds the option.
public AddOption ( object target, string propertyName, string optionName, string description = null ) : void
target object The object containing the property.
propertyName string Name of the property.
optionName string Name of the option.
description string
return void

CommandEngine() public method

Initializes a new instance of the CommandEngine class.
public CommandEngine ( ) : System
return System

Execute() public method

Executes the specified command.
public Execute ( string command ) : CommandResult
command string The command.
return CommandResult

GetHelp() public method

Gets intellisense-like help for a command.
public GetHelp ( string command ) : Myre.Debugging.CommandHelp
command string
return Myre.Debugging.CommandHelp

GetHelp() public method

Gets the command and option help.
public GetHelp ( ) : IEnumerable
return IEnumerable

GetIdentifierHelp() public method

Gets help information for a command or option.
public GetIdentifierHelp ( string commandOrOption ) : CommandHelpInfo?
commandOrOption string The command or option.
return CommandHelpInfo?

RemoveCommand() public method

Removes the command.
public RemoveCommand ( string commandName ) : void
commandName string Name of the command.
return void

RemoveOption() public method

public RemoveOption ( string optionName ) : void
optionName string
return void