Create a scripting environment

[jkarder]

A scripting environment should be created to provide rapid prototyping features.

[jkarder]

r10331: created branch

[jkarder]

r10332: added prototype of a scripting environment

[jkarder]

r10358:

• refactored HLScriptGeneration to separate outputs from different running HL scripts.
• added persistence support for HLScripts and fixed cloning
• added code completion for all types in the currently loaded assemblies
• merged trunk changes

[jkarder]

r10359: merged HLScript branch back to trunk

[mkommend]

Some issues which I found during testing:

• Build configurations, especially paths, are not set correctly
• Consider renaming the projects / classes (e.g., HeuristicLab.Scripting, HeuristicLabScript)
• IMHO the complete source code should always be visible, instead of hiding some parts.
• I would prefer to have a real C# script with a static void main entry point, which could also be executed in other development environments. Another benefit would be that the error line numbers would automatically match the displayed line numbers.
• Exceptions should additionally be shown in an error dialog. If one does not view the log, the person has no clue that an exception was thrown.

[abeham]

r10391: fixed build configuration, output path and added ignore properties

[jkarder]

r10401:

• renamed some HLScript files
• fixed a bug where variables could be renamed while a script was running
• the complete source code is now always visible
• removed "show generated code" feature

[abeham]

Results of yesterday's meeting:

• Change plugin to HeuristicLab.Scripting and HeuristicLab.Scripting.Views and adapt the objects (also rename the trac component)
• Put an extra Compile Button and register F6 as a shortcut
• Put the output window first and error list second
• Automatically change tabs: when compiling -> errors, when running -> output
• When an exception is thrown it should be viewed using the PluginInfrastructure
• Remove the namespace declaration in the script
• Names in the VariableStore have to conform to C# property names
• Contains(string) method to check if a variable is present in the VariableStore
• Split the start page vertically and group samples and scripts on the right hand side
• After implementing the changes mkommend will do the code review

[abeham]

swagner suggested to add the ability to split the script into multiple scripts. Instead of having a Code property that returns only a single string, it should be able to store a collection. The view could be enhanced to include a DockPanel and open each code in a separate docking windows inside that panel as well as to include buttons to add or remove new windows.

[jkarder]

r10506: applied some of the changes suggested in comment:11:ticket:2136

• change namespaces to HeuristicLab.Scripting.*
• added extra compile button and registered F6 as a shortcut
• changed the order of the output window and the error list
• tabs (output window and error list) are selected automatically
• thrown exceptions are shown using the PluginInfrastructure
• removed namespace declaration in the script
• names in the VariableStore are now conform to C# property names

[jkarder]

r10474: using RandomEnumerable.SampleProportional in BiasedMultiVRPOperators.

It is listed in this ticket as svn:ignore properties were added to the scripting folders with this changeset.

[jkarder]

r10510: renamed folders of HeuristicLab.Scripting and HeuristicLab.HLScript.Views

[jkarder]

r10511: added Contains(string) method to check if a variable is present in the VariableStore

[jkarder]

r10512:

• the Variables class now implements IEnumerable<T>
• added Keys and Values properties to the Variables class

[abeham]

r10566:

• Made Variables class public (could be used in other scripts as well)
• Renamed ItemName to "C# Script"

[abeham]

r10577:

• Fixed drag-drop behavior in VariableStoreView
• Added additional information to Script and changed setting name and description

I noticed that if multiple items are to be dragged they're combined into a List<object> and should of course be expanded again. This does not work currently.

[jkarder]

r10642: fixed automatic selection of tabs (output window and error list)

[abeham]

The tool tip for the run/stop button needs to reflect the state of the button.

[abeham]

I would propose to change the type of compiledScript to dynamic. It would allow to compile anything into the running environment, not just scripts. I've attached a patch for this change.

Edit: The patch has become obsolete with the separation of Script and CSharpScript

[jkarder]

r10727:

• fixed tool tips
• added Clear() method to remove all variables present in the VariableStore
• the script cannot be compiled and started with the shortcuts anymore if it is already running

[abeham]

I wanted to change a couple of things to make it easier to embed scripting in other parts of HeuristicLab.

r10731:

• Split Script into Script and CSharpScript
• Split ScriptView into ScriptView and CSharpScriptView

[abeham]

r10747: fixed anchor in ScriptView

[abeham]

r10761: fixed a bug when switching views

[abeham]

I would ask you to do a review of this feature so that we can release this.

[mkommend]

Review comments

Script.cs

• Remove virtual modifier from the properties that are not overriden
• CompilationUnitCode is never used (except cloning)
• Default ctor should not call virtual properties and misses its base ctor call

CSharpScript

• Make CompiledScript and ScriptThread property private.
• DeregisterScriptEvents should be called before the CompiledScript is set to null, because otherwise it has no effect (line 111).
• Check in the compile method if multiple classes derived from CSharpScriptBase are defined, because this would lead to an undefined behavior. You could use Single instead of First for example.
• Why is reflection used to call the execute method of CSharpScriptBase in CSharpScript.Execute? Wouldn't it be easier to call CompiledScript.Execute(VariableStore); (line 127) and get rid of the reflection code.

CSharpScriptBase

• Choose a more appropriate name for the usb variable (e.g., script, scriptBase,...).
• Is it necessary that vars is of type dynamic? Couldn't I type vars statically to Variables?

ScriptView

• Comment in line 151 is wrong. According to ​MSDN is resizes the column to the header width.

CSharpScriptView

• OnContentChanged duplicates code from its base class.
• The same holds for SetEnabledStateOfControls.

[abeham]

please implement the review comments

[jkarder]

r10857: implemented review comments from mkommend in comment:32:ticket:2136

[jkarder]

Replying to mkommend:

• Is it necessary that vars is of type dynamic? Couldn't I type vars statically to Variables?

Yes, vars has to be of type dynamic because otherwise its dynamic runtime behavior (invokation of DynamicObject.TryGetMember() etc.) would not work.

[jkarder]

r10865: fixed compilation error output in console

[mkommend]

Reviewed r10857 & r10865.

[abeham]

r10891: merged r10359, r10391, r10401, r10506 to stable

r10892: merged r10510, r10511, r10512, r10566, r10577, r10642, r10727, r10731, r10747, r10761, r10857, r10865 to stable