Changeset 3289

Timestamp:

04/09/10 01:15:16 (14 years ago)

Author:

swagner

Message:

Implemented logs of engines (#963).

Location:

trunk/sources

Files:

• HeuristicLab.Core.Views/3.3/Auxiliary.cs (modified) (2 diffs)
• HeuristicLab.Core.Views/3.3/EngineView.Designer.cs (modified) (4 diffs)
• HeuristicLab.Core.Views/3.3/EngineView.cs (modified) (6 diffs)
• HeuristicLab.Core.Views/3.3/HeuristicLab.Core.Views-3.3.csproj (modified) (1 diff)
• HeuristicLab.Core.Views/3.3/LogView.Designer.cs (added)
• HeuristicLab.Core.Views/3.3/LogView.cs (added)
• HeuristicLab.Core/3.3/Engine.cs (modified) (4 diffs)
• HeuristicLab.Core/3.3/Executable.cs (modified) (1 diff)
• HeuristicLab.Core/3.3/HeuristicLab.Core-3.3.csproj (modified) (1 diff)
• HeuristicLab.Core/3.3/Interfaces/IEngine.cs (modified) (1 diff)
• HeuristicLab.Core/3.3/Interfaces/ILog.cs (added)
• HeuristicLab.Core/3.3/Log.cs (added)
• HeuristicLab.PluginInfrastructure/Main.cs (modified) (1 diff)
• HeuristicLab.PluginInfrastructure/Starter/StarterForm.cs (modified) (1 diff)
• HeuristicLab.SequentialEngine/3.3/SequentialEngine.cs (modified) (1 diff)

trunk/sources/HeuristicLab.Core.Views/3.3/Auxiliary.cs

@@ -23 +23 @@
 using System.Text;
 using System.Windows.Forms;
+using HeuristicLab.Core;
 
 namespace HeuristicLab.Core.Views {
@@ -45 +46 @@
     /// <param name="ex">The exception to display.</param>
     public static void ShowErrorMessageBox(Exception ex) {
-      MessageBox.Show(BuildErrorMessage(ex),
+      MessageBox.Show(Log.BuildErrorMessage(ex),
                       "Error - " + ex.GetType().Name,
                       MessageBoxButtons.OK,
                       MessageBoxIcon.Error);
     }
-    /// <summary>
-    /// Builds an error message out of an exception and formats it accordingly.
-    /// </summary>
-    /// <param name="ex">The exception to format.</param>
-    /// <returns>The formated message.</returns>
-    public static string BuildErrorMessage(Exception ex) {
-      string nl = Environment.NewLine;
-      StringBuilder sb = new StringBuilder();
-      sb.Append("Sorry, but something went wrong!" + nl + ex.Message + nl + ex.StackTrace);
-
-      while (ex.InnerException != null) {
-        ex = ex.InnerException;
-        sb.Append(nl + "-----" + nl + ex.Message + nl + ex.StackTrace);
-      }
-      return sb.ToString();
-    }
     #endregion
   }

trunk/sources/HeuristicLab.Core.Views/3.3/EngineView.Designer.cs

@@ -47 +47 @@
       this.executionTimeTextBox = new System.Windows.Forms.TextBox();
       this.executionTimeLabel = new System.Windows.Forms.Label();
-      this.logTextBox = new System.Windows.Forms.TextBox();
-      this.logLabel = new System.Windows.Forms.Label();
+      this.logView = new HeuristicLab.Core.Views.LogView();
       this.SuspendLayout();
       // 
@@ -70 +69 @@
       this.executionTimeLabel.Text = "&Execution Time:";
       // 
-      // logTextBox
+      // logView
       // 
-      this.logTextBox.Anchor = ((System.Windows.Forms.AnchorStyles)((((System.Windows.Forms.AnchorStyles.Top | System.Windows.Forms.AnchorStyles.Bottom)
+      this.logView.Anchor = ((System.Windows.Forms.AnchorStyles)((((System.Windows.Forms.AnchorStyles.Top | System.Windows.Forms.AnchorStyles.Bottom)
                   | System.Windows.Forms.AnchorStyles.Left)
                   | System.Windows.Forms.AnchorStyles.Right)));
-      this.logTextBox.Location = new System.Drawing.Point(0, 39);
-      this.logTextBox.Multiline = true;
-      this.logTextBox.Name = "logTextBox";
-      this.logTextBox.ReadOnly = true;
-      this.logTextBox.ScrollBars = System.Windows.Forms.ScrollBars.Both;
-      this.logTextBox.Size = new System.Drawing.Size(430, 315);
-      this.logTextBox.TabIndex = 3;
-      this.logTextBox.WordWrap = false;
-      // 
-      // logLabel
-      // 
-      this.logLabel.AutoSize = true;
-      this.logLabel.Location = new System.Drawing.Point(3, 23);
-      this.logLabel.Name = "logLabel";
-      this.logLabel.Size = new System.Drawing.Size(28, 13);
-      this.logLabel.TabIndex = 2;
-      this.logLabel.Text = "&Log:";
+      this.logView.Caption = "LogView";
+      this.logView.Content = null;
+      this.logView.Location = new System.Drawing.Point(0, 26);
+      this.logView.Name = "logView";
+      this.logView.Size = new System.Drawing.Size(430, 328);
+      this.logView.TabIndex = 2;
       // 
       // EngineView
@@ -97 +85 @@
       this.AutoScaleDimensions = new System.Drawing.SizeF(6F, 13F);
       this.AutoScaleMode = System.Windows.Forms.AutoScaleMode.Font;
-      this.Controls.Add(this.logTextBox);
       this.Controls.Add(this.executionTimeTextBox);
-      this.Controls.Add(this.logLabel);
       this.Controls.Add(this.executionTimeLabel);
+      this.Controls.Add(this.logView);
       this.Name = "EngineView";
       this.Size = new System.Drawing.Size(430, 354);
@@ -112 +99 @@
     protected System.Windows.Forms.TextBox executionTimeTextBox;
     protected System.Windows.Forms.Label executionTimeLabel;
-    protected System.Windows.Forms.TextBox logTextBox;
-    protected System.Windows.Forms.Label logLabel;
+    protected LogView logView;
 
   }

trunk/sources/HeuristicLab.Core.Views/3.3/EngineView.cs

@@ -21 +21 @@
 
 using System;
-using HeuristicLab.Common;
 using HeuristicLab.MainForm;
 
@@ -57 +56 @@
     /// <remarks>Calls <see cref="ViewBase.RemoveItemEvents"/> of base class <see cref="ViewBase"/>.</remarks>
     protected override void DeregisterContentEvents() {
-      Content.ExecutionStateChanged -= new EventHandler(Content_ExecutionStateChanged);
       Content.ExecutionTimeChanged -= new EventHandler(Content_ExecutionTimeChanged);
-      Content.ExceptionOccurred -= new EventHandler<EventArgs<Exception>>(Content_ExceptionOccurred);
       base.DeregisterContentEvents();
     }
@@ -69 +66 @@
     protected override void RegisterContentEvents() {
       base.RegisterContentEvents();
-      Content.ExecutionStateChanged += new EventHandler(Content_ExecutionStateChanged);
       Content.ExecutionTimeChanged += new EventHandler(Content_ExecutionTimeChanged);
-      Content.ExceptionOccurred += new EventHandler<EventArgs<Exception>>(Content_ExceptionOccurred);
     }
 
@@ -80 +75 @@
     protected override void OnContentChanged() {
       base.OnContentChanged();
-      logTextBox.Clear();
       if (Content == null) {
-        logTextBox.Enabled = false;
+        logView.Content = null;
+        logView.Enabled = false;
         executionTimeTextBox.Text = "-";
         executionTimeTextBox.Enabled = false;
       } else {
-        logTextBox.Enabled = true;
+        logView.Content = Content.Log;
+        logView.Enabled = true;
         executionTimeTextBox.Text = Content.ExecutionTime.ToString();
         executionTimeTextBox.Enabled = true;
@@ -92 +88 @@
     }
 
-    #region Content Events
-    protected virtual void Content_ExecutionStateChanged(object sender, EventArgs e) {
-      if (InvokeRequired)
-        Invoke(new EventHandler(Content_ExecutionStateChanged), sender, e);
-      else {
-        if (Content.ExecutionState == ExecutionState.Prepared) Log("Engine prepared");
-        else if (Content.ExecutionState == ExecutionState.Started) Log("Engine started");
-        else if (Content.ExecutionState == ExecutionState.Paused) Log("Engine paused");
-        else if (Content.ExecutionState == ExecutionState.Stopped) Log("Engine stopped");
-      }
-    }
     protected virtual void Content_ExecutionTimeChanged(object sender, EventArgs e) {
       if (InvokeRequired)
@@ -109 +94 @@
         executionTimeTextBox.Text = Content.ExecutionTime.ToString();
     }
-    protected virtual void Content_ExceptionOccurred(object sender, EventArgs<Exception> e) {
-      if (InvokeRequired)
-        Invoke(new EventHandler<EventArgs<Exception>>(Content_ExceptionOccurred), sender, e);
-      else
-        Log(Auxiliary.BuildErrorMessage(e.Value));
-    }
-    #endregion
-
-    #region Helpers
-    protected virtual void Log(string message) {
-      if (InvokeRequired)
-        Invoke(new Action<string>(Log), message);
-      else {
-        message = DateTime.Now.ToString() + "\t" + message;
-        string[] newLines = message.Split(new string[] { Environment.NewLine }, StringSplitOptions.None);
-        string[] lines = new string[logTextBox.Lines.Length + newLines.Length];
-        logTextBox.Lines.CopyTo(lines, 0);
-        newLines.CopyTo(lines, logTextBox.Lines.Length);
-        logTextBox.Lines = lines;
-      }
-    }
-    #endregion
   }
 }

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

@@ -87 +87 @@
   <ItemGroup>
     <None Include="HeuristicLabCoreViewsPlugin.cs.frame" />
+    <Compile Include="LogView.cs">
+      <SubType>UserControl</SubType>
+    </Compile>
+    <Compile Include="LogView.Designer.cs">
+      <DependentUpon>LogView.cs</DependentUpon>
+    </Compile>
     <Compile Include="VariableValueView.cs">
       <SubType>UserControl</SubType>

trunk/sources/HeuristicLab.Core/3.3/Engine.cs

@@ -30 +30 @@
   public abstract class Engine : Executable, IEngine {
     [Storable]
+    protected ILog log;
+    public ILog Log {
+      get { return log; }
+    }
+
+    [Storable]
     private Stack<IOperation> executionStack;
     protected Stack<IOperation> ExecutionStack {
@@ -41 +47 @@
     protected Engine()
       : base() {
+      log = new Log();
       executionStack = new Stack<IOperation>();
+      pausePending = stopPending = false;
+      timer = new System.Timers.Timer(100);
+      timer.AutoReset = true;
+      timer.Elapsed += new System.Timers.ElapsedEventHandler(timer_Elapsed);
+    }
+    [StorableConstructor]
+    protected Engine(bool deserializing)
+      : base(deserializing) {
       pausePending = stopPending = false;
       timer = new System.Timers.Timer(100);
@@ -51 +66 @@
       if (ExecutionState == ExecutionState.Started) throw new InvalidOperationException(string.Format("Clone not allowed in execution state \"{0}\".", ExecutionState));
       Engine clone = (Engine)base.Clone(cloner);
+      clone.log = (ILog)cloner.Clone(log);
       IOperation[] contexts = executionStack.ToArray();
       for (int i = contexts.Length - 1; i >= 0; i--)
@@ -71 +87 @@
       OnPrepared();
     }
+    protected override void OnPrepared() {
+      Log.LogMessage("Engine prepared");
+      base.OnPrepared();
+    }
+
     public override void Start() {
       base.Start();
       ThreadPool.QueueUserWorkItem(new WaitCallback(Run), null);
     }
+    protected override void OnStarted() {
+      Log.LogMessage("Engine started");
+      base.OnStarted();
+    }
+
     public override void Pause() {
       base.Pause();
       pausePending = true;
     }
+    protected override void OnPaused() {
+      Log.LogMessage("Engine paused");
+      base.OnPaused();
+    }
+
     public override void Stop() {
       base.Stop();
       stopPending = true;
       if (ExecutionState == ExecutionState.Paused) OnStopped();
+    }
+    protected override void OnStopped() {
+      Log.LogMessage("Engine stopped");
+      base.OnStopped();
+    }
+
+    protected override void OnExceptionOccurred(Exception exception) {
+      Log.LogException(exception);
+      base.OnExceptionOccurred(exception);
     }
 

trunk/sources/HeuristicLab.Core/3.3/Executable.cs

@@ -59 +59 @@
       executionTime = TimeSpan.Zero;
     }
+    [StorableConstructor]
+    protected Executable(bool deserializing) : base(deserializing) { }
 
     public override IDeepCloneable Clone(Cloner cloner) {

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

@@ -103 +103 @@
     <Compile Include="Attributes\CreatableAttribute.cs" />
     <None Include="HeuristicLabCorePlugin.cs.frame" />
+    <Compile Include="Log.cs" />
     <Compile Include="Executable.cs" />
     <Compile Include="ExecutionState.cs" />
+    <Compile Include="Interfaces\ILog.cs" />
     <Compile Include="Interfaces\IExecutable.cs" />
     <Compile Include="Interfaces\IParameterizedNamedItem.cs" />

trunk/sources/HeuristicLab.Core/3.3/Interfaces/IEngine.cs

@@ -20 +20 @@
 #endregion
 
-using System;
-using HeuristicLab.Common;
-
 namespace HeuristicLab.Core {
   public interface IEngine : IExecutable {
+    ILog Log { get; }
+
     void Prepare(IOperation initialOperation);
   }

trunk/sources/HeuristicLab.PluginInfrastructure/Main.cs

@@ -108 +108 @@
       string nl = Environment.NewLine;
       StringBuilder sb = new StringBuilder();
-      sb.Append("Sorry, but something went wrong!" +  nl + ex.Message + nl + ex.StackTrace);
+      sb.Append(ex.Message + nl + ex.StackTrace);
 
       while (ex.InnerException != null) {

trunk/sources/HeuristicLab.PluginInfrastructure/Starter/StarterForm.cs

@@ -192 +192 @@
     }
     private static string BuildErrorMessage(Exception ex) {
+      string nl = Environment.NewLine;
       StringBuilder sb = new StringBuilder();
-      sb.Append("Sorry, but something went wrong!\n\n" + ex.Message + "\n\n" + ex.StackTrace);
+      sb.Append(ex.Message + nl + ex.StackTrace);
 
       while (ex.InnerException != null) {
         ex = ex.InnerException;
-        sb.Append("\n\n-----\n\n" + ex.Message + "\n\n" + ex.StackTrace);
+        sb.Append(nl + "-----" + nl + ex.Message + nl + ex.StackTrace);
       }
       return sb.ToString();

trunk/sources/HeuristicLab.SequentialEngine/3.3/SequentialEngine.cs

@@ -62 +62 @@
           Pause();
         }
-        if (operation.Operator.Breakpoint)
+        if (operation.Operator.Breakpoint) {
+          Log.LogMessage(string.Format("Breakpoint: {0} ({1})", operation.Operator.Name, operation.Operator.ItemName));
           Pause();
+        }
       }
     }