Changeset 6862

Timestamp:

10/03/11 18:34:23 (13 years ago)

Author:

ascheibe

Message:

#1631 inherited ThreadSafeLog from Log to fix the LockRecursionException problem

Location:

trunk/sources

Files:

• HeuristicLab.Core/3.3/Log.cs (modified) (3 diffs)
• HeuristicLab.Core/3.3/ThreadSafeLog.cs (modified) (2 diffs)
• HeuristicLab/3.3/Tests/ThreadSafeLogTest.cs (modified) (2 diffs)

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

@@ -71 +71 @@
     }
     public virtual void LogMessage(string message) {
-      string s = DateTime.Now.ToString() + "\t" + message;
+      string s = FormatLogMessage(message);
       messages.Add(s);
       CapMessages();
@@ -77 +77 @@
     }
     public virtual void LogException(Exception ex) {
-      string s = DateTime.Now.ToString() + "\t" + "Exception occurred:" + Environment.NewLine + ErrorHandling.BuildErrorMessage(ex);
+      string s = FormatException(ex);
       messages.Add(s);
       CapMessages();
@@ -86 +86 @@
         messages.RemoveAt(0);
       }
+    }
+    protected virtual string FormatLogMessage(string message) {
+      return DateTime.Now.ToString() + "\t" + message;
+    }
+    protected virtual string FormatException(Exception ex) {
+      return DateTime.Now.ToString() + "\t" + "Exception occurred:" + Environment.NewLine + ErrorHandling.BuildErrorMessage(ex);
     }
 

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

@@ -22 +22 @@
 using System;
 using System.Collections.Generic;
-using System.Drawing;
 using System.Linq;
 using System.Threading;
 using HeuristicLab.Common;
-using HeuristicLab.Common.Resources;
 using HeuristicLab.Persistence.Default.CompositeSerializers.Storable;
 
@@ -32 +30 @@
   [Item("ThreadSafeLog", "A thread-safe log for logging string messages.")]
   [StorableClass]
-  public class ThreadSafeLog : Item, ILog, IStorableContent {
+  public class ThreadSafeLog : Log, IDeepCloneable {
     protected ReaderWriterLockSlim locker = new ReaderWriterLockSlim();
 
-    public string Filename { get; set; }
-
-    public override Image ItemImage {
-      get { return VSImageLibrary.File; }
-    }
-
-    public IEnumerable<string> Messages {
+    public override IEnumerable<string> Messages {
       get {
         locker.EnterReadLock();
         try {
-          return log.Messages.ToArray(); // return copy of messages
-        } finally { locker.ExitReadLock(); }
+          return messages.ToArray(); // return copy of messages
+        }
+        finally { locker.ExitReadLock(); }
       }
     }
 
-    [Storable]
-    protected ILog log;
-
     [StorableConstructor]
     protected ThreadSafeLog(bool deserializing) : base(deserializing) { }
-    public ThreadSafeLog()
-      : base() {
-      this.log = new Log();
-      RegisterLogEvents();
-    }
-    public ThreadSafeLog(ILog log)
-      : base() {
-      this.log = log;
-      RegisterLogEvents();
+    public ThreadSafeLog(long maxMessageCount = -1)
+      : base(maxMessageCount) {
     }
 
-    protected ThreadSafeLog(ThreadSafeLog original, Cloner cloner)
-      : base(original, cloner) {
+    protected ThreadSafeLog(ThreadSafeLog original, Cloner cloner) {
       original.locker.EnterReadLock();
       try {
-        log = cloner.Clone(original.log);
-      } finally { original.locker.ExitReadLock(); }
+        cloner.RegisterClonedObject(original, this);
+        this.messages = new List<string>(original.messages);
+        this.maxMessageCount = original.maxMessageCount;
+      }
+      finally { original.locker.ExitReadLock(); }
     }
+
     public override IDeepCloneable Clone(Cloner cloner) {
       return new ThreadSafeLog(this, cloner);
     }
 
-    public virtual void Clear() {
+    public override void Clear() {
       locker.EnterWriteLock();
       try {
-        log.Clear();
-      } finally { locker.ExitWriteLock(); }
+        messages.Clear();
+      }
+      finally { locker.ExitWriteLock(); }
+      OnCleared();
     }
 
-    public virtual void LogMessage(string message) {
+    public override void LogMessage(string message) {
+      string s = FormatLogMessage(message);
       locker.EnterWriteLock();
       try {
-        log.LogMessage(message);
-      } finally { locker.ExitWriteLock(); }
+        messages.Add(s);
+        CapMessages();
+      }
+      finally { locker.ExitWriteLock(); }
+      OnMessageAdded(s);
     }
 
-    public virtual void LogException(Exception ex) {
+    public override void LogException(Exception ex) {
+      string s = FormatException(ex);
       locker.EnterWriteLock();
       try {
-        log.LogException(ex);
-      } finally { locker.ExitWriteLock(); }
+        messages.Add(s);
+        CapMessages();
+      }
+      finally { locker.ExitWriteLock(); }
+      OnMessageAdded(s);
     }
-
-    #region Log Events
-    private void RegisterLogEvents() {
-      this.log.Cleared += new EventHandler(log_Cleared);
-      this.log.MessageAdded += new EventHandler<EventArgs<string>>(log_MessageAdded);
-      this.log.ToStringChanged += new EventHandler(log_ToStringChanged);
-    }
-
-    private void log_ToStringChanged(object sender, EventArgs e) {
-      OnToStringChanged();
-    }
-
-    private void log_MessageAdded(object sender, EventArgs<string> e) {
-      OnMessageAdded(e.Value);
-    }
-
-    private void log_Cleared(object sender, EventArgs e) {
-      OnCleared();
-    }
-    #endregion
-
-    #region Event Handler
-    public event EventHandler<EventArgs<string>> MessageAdded;
-    protected virtual void OnMessageAdded(string message) {
-      EventHandler<EventArgs<string>> handler = MessageAdded;
-      if (handler != null) handler(this, new EventArgs<string>(message));
-    }
-    public event EventHandler Cleared;
-    protected virtual void OnCleared() {
-      EventHandler handler = Cleared;
-      if (handler != null) handler(this, EventArgs.Empty);
-    }
-    #endregion
-
-
   }
 }

trunk/sources/HeuristicLab/3.3/Tests/ThreadSafeLogTest.cs

@@ -20 +20 @@
 #endregion
 
+using System;
 using System.Linq;
 using System.Threading.Tasks;
+using HeuristicLab.Common;
 using HeuristicLab.Core;
 using Microsoft.VisualStudio.TestTools.UnitTesting;
@@ -41 +43 @@
       Assert.AreEqual(count, log.Messages.Count());
     }
+
+    private ThreadSafeLog recursionInLogViewTestLog;
+    [TestMethod]
+    public void ThreadSafeLogRecursionInLogViewTest() {
+      int count = 10;
+      recursionInLogViewTestLog = new ThreadSafeLog();
+      recursionInLogViewTestLog.MessageAdded += new EventHandler<EventArgs<string>>(log_MessageAdded);
+
+      for (int i = 0; i < count; i++) {
+        recursionInLogViewTestLog.LogMessage("Message " + i);
+      }
+    }
+    void log_MessageAdded(object sender, EventArgs<string> e) {
+      //access Messages like LogView does
+      Console.WriteLine(string.Join(Environment.NewLine, recursionInLogViewTestLog.Messages.ToArray()));
+    }
   }
 }