Changeset 13080

Timestamp:

10/29/15 12:50:06 (9 years ago)

Author:

jkarder

Message:

#2298: added ExecutableScript and ExecutableScriptView

Location:

trunk/sources

Files:

• HeuristicLab.Scripting.Views/3.3/CSharpScriptView.Designer.cs (modified) (7 diffs)
• HeuristicLab.Scripting.Views/3.3/CSharpScriptView.cs (modified) (5 diffs)
• HeuristicLab.Scripting.Views/3.3/ExecutableScriptView.Designer.cs (added)
• HeuristicLab.Scripting.Views/3.3/ExecutableScriptView.cs (added)
• HeuristicLab.Scripting.Views/3.3/HeuristicLab.Scripting.Views-3.3.csproj (modified) (1 diff)
• HeuristicLab.Scripting/3.3/ExecutableScript.cs (added)
• HeuristicLab.Scripting/3.3/HeuristicLab.Scripting-3.3.csproj (modified) (1 diff)
• HeuristicLab.Scripting/3.3/Scripts/CSharp/CSharpScript.cs (modified) (8 diffs)

trunk/sources/HeuristicLab.Scripting.Views/3.3/CSharpScriptView.Designer.cs

@@ -20 +20 @@
 #endregion
 
-using System.Windows.Forms;
 
 namespace HeuristicLab.Scripting.Views {
@@ -47 +46 @@
     /// </summary>
     private void InitializeComponent() {
-      this.components = new System.ComponentModel.Container();
-      this.startStopButton = new System.Windows.Forms.Button();
       this.splitContainer2 = new System.Windows.Forms.SplitContainer();
       this.variableStoreView = new HeuristicLab.Scripting.Views.VariableStoreView();
       this.viewHost = new HeuristicLab.MainForm.WindowsForms.ViewHost();
-      this.executionTimeTextBox = new System.Windows.Forms.TextBox();
-      this.executionTimeLabel = new System.Windows.Forms.Label();
+      this.infoTabControl.SuspendLayout();
+      this.outputTabPage.SuspendLayout();
+      this.errorListTabPage.SuspendLayout();
       ((System.ComponentModel.ISupportInitialize)(this.splitContainer1)).BeginInit();
       this.splitContainer1.Panel1.SuspendLayout();
+      this.splitContainer1.Panel2.SuspendLayout();
       this.splitContainer1.SuspendLayout();
       ((System.ComponentModel.ISupportInitialize)(this.errorProvider)).BeginInit();
@@ -64 +63 @@
       this.SuspendLayout();
       // 
-      // splitContainer1.Panel1
+      // executionTimeLabel
       // 
-      this.splitContainer1.Panel1.Controls.Add(this.executionTimeTextBox);
-      this.splitContainer1.Panel1.Controls.Add(this.executionTimeLabel);
-      this.splitContainer1.Panel1.Controls.SetChildIndex(this.executionTimeTextBox, 0);
-      this.splitContainer1.Panel1.Controls.SetChildIndex(this.executionTimeLabel, 0);
+      this.executionTimeLabel.Location = new System.Drawing.Point(394, 393);
+      // 
+      // executionTimeTextBox
+      // 
+      this.executionTimeTextBox.Location = new System.Drawing.Point(483, 390);
+      // 
+      // splitContainer1
+      // 
+      this.splitContainer1.Anchor = ((System.Windows.Forms.AnchorStyles)((System.Windows.Forms.AnchorStyles.Top | System.Windows.Forms.AnchorStyles.Left)));
+      this.splitContainer1.Dock = System.Windows.Forms.DockStyle.Fill;
+      this.splitContainer1.Location = new System.Drawing.Point(0, 0);
       this.splitContainer1.Size = new System.Drawing.Size(637, 543);
-      // 
-      // nameTextBox
-      // 
-      this.errorProvider.SetIconAlignment(this.nameTextBox, System.Windows.Forms.ErrorIconAlignment.MiddleLeft);
-      this.errorProvider.SetIconPadding(this.nameTextBox, 2);
-      this.nameTextBox.Location = new System.Drawing.Point(60, 0);
-      this.nameTextBox.Size = new System.Drawing.Size(750, 20);
-      // 
-      // infoLabel
-      // 
-      this.infoLabel.Location = new System.Drawing.Point(816, 4);
-      // 
-      // startStopButton
-      // 
-      this.startStopButton.Image = HeuristicLab.Common.Resources.VSImageLibrary.Play;
-      this.startStopButton.Location = new System.Drawing.Point(36, 26);
-      this.startStopButton.Name = "startStopButton";
-      this.startStopButton.Size = new System.Drawing.Size(24, 24);
-      this.startStopButton.TabIndex = 1;
-      this.startStopButton.TextImageRelation = System.Windows.Forms.TextImageRelation.ImageBeforeText;
-      this.toolTip.SetToolTip(this.startStopButton, "Run (F5)");
-      this.startStopButton.UseVisualStyleBackColor = true;
-      this.startStopButton.Click += new System.EventHandler(this.StartStopButtonOnClick);
+      this.splitContainer1.SplitterDistance = 427;
       // 
       // splitContainer2
@@ -114 +98 @@
       this.splitContainer2.SplitterDistance = 637;
       this.splitContainer2.TabIndex = 7;
-      //
-      // splitContainer1
-      //
-      this.splitContainer1.Location = new System.Drawing.Point(0, 0);
-      this.splitContainer1.Dock = DockStyle.Fill;
       // 
       // variableStoreView
@@ -145 +124 @@
       this.viewHost.ViewType = null;
       // 
-      // executionTimeTextBox
-      // 
-      this.executionTimeTextBox.Anchor = ((System.Windows.Forms.AnchorStyles)((System.Windows.Forms.AnchorStyles.Bottom | System.Windows.Forms.AnchorStyles.Right)));
-      this.executionTimeTextBox.Location = new System.Drawing.Point(483, 390);
-      this.executionTimeTextBox.Name = "executionTimeTextBox";
-      this.executionTimeTextBox.ReadOnly = true;
-      this.executionTimeTextBox.Size = new System.Drawing.Size(137, 20);
-      this.executionTimeTextBox.TabIndex = 17;
-      // 
-      // executionTimeLabel
-      // 
-      this.executionTimeLabel.Anchor = ((System.Windows.Forms.AnchorStyles)((System.Windows.Forms.AnchorStyles.Bottom | System.Windows.Forms.AnchorStyles.Right)));
-      this.executionTimeLabel.AutoSize = true;
-      this.executionTimeLabel.Location = new System.Drawing.Point(394, 393);
-      this.executionTimeLabel.Name = "executionTimeLabel";
-      this.executionTimeLabel.Size = new System.Drawing.Size(83, 13);
-      this.executionTimeLabel.TabIndex = 16;
-      this.executionTimeLabel.Text = "&Execution Time:";
-      // 
-      // ScriptView
+      // CSharpScriptView
       // 
       this.AutoScaleMode = System.Windows.Forms.AutoScaleMode.Inherit;
       this.Controls.Add(this.splitContainer2);
-      this.Controls.Add(this.startStopButton);
-      this.Name = "ScriptView";
-      this.Size = new System.Drawing.Size(835, 602);
+      this.Name = "CSharpScriptView";
+      this.Controls.SetChildIndex(this.infoTextLabel, 0);
+      this.Controls.SetChildIndex(this.compileButton, 0);
       this.Controls.SetChildIndex(this.startStopButton, 0);
       this.Controls.SetChildIndex(this.splitContainer2, 0);
@@ -176 +136 @@
       this.Controls.SetChildIndex(this.nameTextBox, 0);
       this.Controls.SetChildIndex(this.infoLabel, 0);
+      this.infoTabControl.ResumeLayout(false);
+      this.outputTabPage.ResumeLayout(false);
+      this.outputTabPage.PerformLayout();
+      this.errorListTabPage.ResumeLayout(false);
       this.splitContainer1.Panel1.ResumeLayout(false);
       this.splitContainer1.Panel1.PerformLayout();
+      this.splitContainer1.Panel2.ResumeLayout(false);
       ((System.ComponentModel.ISupportInitialize)(this.splitContainer1)).EndInit();
       this.splitContainer1.ResumeLayout(false);
+      ((System.ComponentModel.ISupportInitialize)(this.errorProvider)).EndInit();
       this.splitContainer2.Panel1.ResumeLayout(false);
       this.splitContainer2.Panel2.ResumeLayout(false);
@@ -191 +157 @@
     #endregion
 
-    protected System.Windows.Forms.Button startStopButton;
     protected System.Windows.Forms.SplitContainer splitContainer2;
     protected MainForm.WindowsForms.ViewHost viewHost;
     protected VariableStoreView variableStoreView;
-    protected TextBox executionTimeTextBox;
-    protected Label executionTimeLabel;
   }
 }

trunk/sources/HeuristicLab.Scripting.Views/3.3/CSharpScriptView.cs

@@ -21 +21 @@
 
 using System;
-using System.Drawing;
-using System.Threading;
 using System.Windows.Forms;
 using HeuristicLab.Common;
-using HeuristicLab.Common.Resources;
 using HeuristicLab.MainForm;
 
@@ -32 +29 @@
   [View("C# Script View")]
   [Content(typeof(CSharpScript), true)]
-  public partial class CSharpScriptView : ScriptView {
-    private const string ScriptExecutionStartedMessage = "Script execution started";
-    private const string ScriptExecutionCanceledMessage = "Script execution canceled";
-    private const string ScriptExecutionSuccessfulMessage = "Script execution successful";
-    private const string ScriptExecutionFailedMessage = "Script execution failed";
-
-    protected bool Running { get; set; }
+  public partial class CSharpScriptView : ExecutableScriptView {
 
     public new CSharpScript Content {
@@ -51 +42 @@
     protected override void RegisterContentEvents() {
       base.RegisterContentEvents();
-      Content.ScriptExecutionStarted += ContentOnScriptExecutionStarted;
-      Content.ScriptExecutionFinished += ContentOnScriptExecutionFinished;
       Content.ConsoleOutputChanged += ContentOnConsoleOutputChanged;
-      Content.ExecutionTimeChanged += ContentOnExecutionTimeChanged;
     }
 
     protected override void DeregisterContentEvents() {
-      Content.ScriptExecutionStarted -= ContentOnScriptExecutionStarted;
-      Content.ScriptExecutionFinished -= ContentOnScriptExecutionFinished;
       Content.ConsoleOutputChanged -= ContentOnConsoleOutputChanged;
-      Content.ExecutionTimeChanged -= ContentOnExecutionTimeChanged;
       base.DeregisterContentEvents();
     }
 
     #region Content event handlers
-    protected virtual void ContentOnScriptExecutionStarted(object sender, EventArgs e) {
-      if (InvokeRequired)
-        Invoke((Action<object, EventArgs>)ContentOnScriptExecutionStarted, sender, e);
-      else {
-        Locked = true;
-        ReadOnly = true;
-        startStopButton.Image = VSImageLibrary.Stop;
-        toolTip.SetToolTip(startStopButton, "Stop (Shift+F5)");
-        UpdateInfoTextLabel(ScriptExecutionStartedMessage, SystemColors.ControlText);
-        infoTabControl.SelectedTab = outputTabPage;
-      }
-    }
-    protected virtual void ContentOnScriptExecutionFinished(object sender, EventArgs<Exception> e) {
-      if (InvokeRequired)
-        Invoke((Action<object, EventArgs<Exception>>)ContentOnScriptExecutionFinished, sender, e);
-      else {
-        Locked = false;
-        ReadOnly = false;
-        startStopButton.Image = VSImageLibrary.Play;
-        toolTip.SetToolTip(startStopButton, "Run (F5)");
-
-        var ex = e.Value;
-        if (ex == null) {
-          UpdateInfoTextLabel(ScriptExecutionSuccessfulMessage, Color.DarkGreen);
-        } else if (ex is ThreadAbortException) {
-          // the execution was canceled by the user
-          UpdateInfoTextLabel(ScriptExecutionCanceledMessage, Color.DarkOrange);
-        } else {
-          UpdateInfoTextLabel(ScriptExecutionFailedMessage, Color.DarkRed);
-          PluginInfrastructure.ErrorHandling.ShowErrorDialog(this, ex);
-        }
-
-        Running = false;
-      }
-    }
     protected virtual void ContentOnConsoleOutputChanged(object sender, EventArgs<string> e) {
       if (InvokeRequired)
@@ -106 +56 @@
       else {
         outputTextBox.AppendText(e.Value);
-      }
-    }
-    protected virtual void ContentOnExecutionTimeChanged(object sender, EventArgs eventArgs) {
-      if (InvokeRequired)
-        Invoke((Action<object, EventArgs>)ContentOnExecutionTimeChanged, sender, eventArgs);
-      else {
-        executionTimeTextBox.Text = Content == null ? "-" : Content.ExecutionTime.ToString();
       }
     }
@@ -121 +64 @@
       if (Content == null) {
         variableStoreView.Content = null;
-        executionTimeTextBox.Text = "-";
       } else {
         variableStoreView.Content = Content.VariableStore;
-        executionTimeTextBox.Text = Content.ExecutionTime.ToString();
       }
     }
-
-    protected override void SetEnabledStateOfControls() {
-      base.SetEnabledStateOfControls();
-      startStopButton.Enabled = Content != null && (!Locked || Running);
-    }
-
-    protected virtual void StartStopButtonOnClick(object sender, EventArgs e) {
-      if (Running) {
-        Content.Kill();
-      } else
-        if (Compile()) {
-        outputTextBox.Clear();
-        Running = true;
-        Content.ExecuteAsync();
-      }
-    }
-
-    #region global HotKeys
-    protected override bool ProcessCmdKey(ref Message msg, Keys keyData) {
-      switch (keyData) {
-        case Keys.F5:
-          if (Content != null && !Locked && !Running) {
-            if (Compile()) {
-              outputTextBox.Clear();
-              Content.ExecuteAsync();
-              Running = true;
-            }
-          }
-          return true;
-        case Keys.F5 | Keys.Shift:
-          if (Running) Content.Kill();
-          return true;
-        case Keys.F6:
-          if (!Running) base.ProcessCmdKey(ref msg, keyData);
-          return true;
-      }
-      return base.ProcessCmdKey(ref msg, keyData);
-    }
-    #endregion
   }
 }

trunk/sources/HeuristicLab.Scripting.Views/3.3/HeuristicLab.Scripting.Views-3.3.csproj

@@ -97 +97 @@
     <Compile Include="CSharpScriptView.Designer.cs">
       <DependentUpon>CSharpScriptView.cs</DependentUpon>
+    </Compile>
+    <Compile Include="ExecutableScriptView.cs">
+      <SubType>UserControl</SubType>
+    </Compile>
+    <Compile Include="ExecutableScriptView.Designer.cs">
+      <DependentUpon>ExecutableScriptView.cs</DependentUpon>
     </Compile>
     <Compile Include="ScriptView.cs">

trunk/sources/HeuristicLab.Scripting/3.3/HeuristicLab.Scripting-3.3.csproj

@@ -92 +92 @@
   <ItemGroup>
     <Compile Include="CompilationException.cs" />
+    <Compile Include="ExecutableScript.cs" />
     <Compile Include="Scripts\CSharp\CSharpScript.cs" />
     <Compile Include="Scripts\Templates\CSharpScriptTemplate.cs" />

trunk/sources/HeuristicLab.Scripting/3.3/Scripts/CSharp/CSharpScript.cs

@@ -23 +23 @@
 using System.Linq;
 using System.Reflection;
-using System.Threading;
 using HeuristicLab.Common;
 using HeuristicLab.Core;
@@ -32 +31 @@
   [Creatable(CreatableAttribute.Categories.Scripts, Priority = 100)]
   [StorableClass]
-  public class CSharpScript : Script, IStorableContent {
+  public class CSharpScript : ExecutableScript, IStorableContent {
     #region Constants
-    protected const string ExecuteMethodName = "Execute";
     protected override string CodeTemplate { get { return ScriptTemplates.CSharpScriptTemplate; } }
     #endregion
@@ -40 +38 @@
     #region Fields & Properties
     private CSharpScriptBase compiledScript;
-    private Thread scriptThread;
-    private DateTime lastUpdateTime;
 
     public string Filename { get; set; }
@@ -50 +46 @@
       get { return variableStore; }
     }
-
-    [Storable]
-    private TimeSpan executionTime;
-    public TimeSpan ExecutionTime {
-      get { return executionTime; }
-      protected set {
-        executionTime = value;
-        OnExecutionTimeChanged();
-      }
-    }
     #endregion
 
-    #region Construction & Initialization
+    #region Construction & Cloning
     [StorableConstructor]
     protected CSharpScript(bool deserializing) : base(deserializing) { }
@@ -68 +54 @@
       : base(original, cloner) {
       variableStore = cloner.Clone(original.variableStore);
-      executionTime = original.executionTime;
     }
-    public CSharpScript() {
+    public CSharpScript()
+      : base() {
       variableStore = new VariableStore();
-      executionTime = TimeSpan.Zero;
-      Code = CodeTemplate;
     }
     public CSharpScript(string code)
       : base(code) {
       variableStore = new VariableStore();
-      executionTime = TimeSpan.Zero;
     }
 
@@ -97 +80 @@
 
     #region Compilation
-
     public override Assembly Compile() {
       DeregisterScriptEvents();
@@ -109 +91 @@
     #endregion
 
-    public virtual void ExecuteAsync() {
+    protected override void ExecuteCode() {
       if (compiledScript == null) return;
-      executionTime = TimeSpan.Zero;
-      scriptThread = new Thread(() => {
-        Exception ex = null;
-        var timer = new System.Timers.Timer(250) { AutoReset = true };
-        timer.Elapsed += timer_Elapsed;
-        try {
-          OnScriptExecutionStarted();
-          lastUpdateTime = DateTime.UtcNow;
-          timer.Start();
-          compiledScript.Execute(VariableStore);
-        } catch (Exception e) {
-          ex = e;
-        } finally {
-          scriptThread = null;
-          timer.Elapsed -= timer_Elapsed;
-          timer.Stop();
-          ExecutionTime += DateTime.UtcNow - lastUpdateTime;
-          OnScriptExecutionFinished(ex);
-        }
-      });
-      scriptThread.SetApartmentState(ApartmentState.STA);
-      scriptThread.Start();
-    }
 
-    public virtual void Kill() {
-      if (scriptThread == null) return;
-      scriptThread.Abort();
-    }
-
-    private void timer_Elapsed(object sender, System.Timers.ElapsedEventArgs e) {
-      var timer = (System.Timers.Timer)sender;
-      timer.Enabled = false;
-      DateTime now = DateTime.UtcNow;
-      ExecutionTime += now - lastUpdateTime;
-      lastUpdateTime = now;
-      timer.Enabled = true;
+      compiledScript.Execute(VariableStore);
     }
 
     protected virtual void CompiledScriptOnConsoleOutputChanged(object sender, EventArgs<string> e) {
       OnConsoleOutputChanged(e.Value);
-    }
-
-    public event EventHandler ScriptExecutionStarted;
-    protected virtual void OnScriptExecutionStarted() {
-      var handler = ScriptExecutionStarted;
-      if (handler != null) handler(this, EventArgs.Empty);
-    }
-
-    public event EventHandler<EventArgs<Exception>> ScriptExecutionFinished;
-    protected virtual void OnScriptExecutionFinished(Exception e) {
-      var handler = ScriptExecutionFinished;
-      if (handler != null) handler(this, new EventArgs<Exception>(e));
     }
 
@@ -170 +106 @@
       if (handler != null) handler(this, new EventArgs<string>(args));
     }
-
-    public event EventHandler ExecutionTimeChanged;
-    protected virtual void OnExecutionTimeChanged() {
-      var handler = ExecutionTimeChanged;
-      if (handler != null) handler(this, EventArgs.Empty);
-    }
   }
 }