# HG changeset patch
# User cin
# Date 2014-04-18 08:34:45
# Node ID d9d794b61bb95c4b2b9c22b2f269cc4eee9bcfa6
# Parent  b181f7bcb259c134156b4e5f51d6ae0ad636f201

Interactive tracing
Improved working with tracing contexts

diff --git a/Implab.Diagnostics.Interactive/InteractiveListener.cs b/Implab.Diagnostics.Interactive/InteractiveListener.cs
--- a/Implab.Diagnostics.Interactive/InteractiveListener.cs
+++ b/Implab.Diagnostics.Interactive/InteractiveListener.cs
@@ -9,15 +9,14 @@ using System.Windows.Forms;
 
 namespace Implab.Diagnostics.Interactive
 {
-    public class InteractiveListener: Disposable
+    public class InteractiveListener: TextListenerBase
     {
         TraceForm m_form;
         
         SynchronizationContext m_syncGuiThread;
+        readonly Promise<object> m_guiStarted = new Promise<object>();
         
         readonly IPromiseBase m_guiFinished;
-        readonly Promise<object> m_guiStarted = new Promise<object>();
-
         readonly IPromiseBase m_workerFinished = new Promise<object>();
         
         readonly MTQueue<TraceViewItem> m_queue = new MTQueue<TraceViewItem>();
@@ -30,17 +29,19 @@ namespace Implab.Diagnostics.Interactive
         bool m_paused;
         readonly ManualResetEvent m_pauseEvent = new ManualResetEvent(true);
 
-        public InteractiveListener() {
-            m_guiFinished = AsyncPool.InvokeNewThread(() => {
-                GuiThread();
-                return 0;
-            });
+        public InteractiveListener(bool global) : base(global) {
+            m_guiFinished = AsyncPool.InvokeNewThread(GuiThread);
+            m_workerFinished = AsyncPool.InvokeNewThread(QueueThread);
 
             m_guiStarted.Join();
         }
 
         void GuiThread() {
             m_form = new TraceForm(); // will create SynchronizationContext
+
+            m_form.PauseEvents += (s,a) => Pause();
+            m_form.ResumeEvents += (s, a) => Resume();
+
             m_syncGuiThread = SynchronizationContext.Current;
             m_guiStarted.Resolve();
             Application.Run();
@@ -93,6 +94,8 @@ namespace Implab.Diagnostics.Interactive
         }
 
         void Terminate() {
+            m_exitPending = true;
+            Resume();            
             m_syncGuiThread.Post(x => Application.ExitThread(), null);
         }
 
@@ -103,5 +106,17 @@ namespace Implab.Diagnostics.Interactive
             }
             base.Dispose(disposing);
         }
+
+        protected override void WriteEntry(TraceContext context, EventText text, string channel) {
+            var item = new TraceViewItem {
+                Indent = text.indent,
+                Message = text.content,
+                Thread = context.ThreadId,
+                Channel = channel,
+                Timestamp = Environment.TickCount
+            };
+
+            Enqueue(item);
+        }
     }
 }
diff --git a/Implab.Diagnostics.Interactive/TraceForm.Designer.cs b/Implab.Diagnostics.Interactive/TraceForm.Designer.cs
--- a/Implab.Diagnostics.Interactive/TraceForm.Designer.cs
+++ b/Implab.Diagnostics.Interactive/TraceForm.Designer.cs
@@ -30,6 +30,7 @@
             this.eventsDataGrid = new System.Windows.Forms.DataGridView();
             this.traceViewItemBindingSource = new System.Windows.Forms.BindingSource(this.components);
             this.threadDataGridViewTextBoxColumn = new System.Windows.Forms.DataGridViewTextBoxColumn();
+            this.Channel = new System.Windows.Forms.DataGridViewTextBoxColumn();
             this.messageDataGridViewTextBoxColumn = new System.Windows.Forms.DataGridViewTextBoxColumn();
             ((System.ComponentModel.ISupportInitialize)(this.eventsDataGrid)).BeginInit();
             ((System.ComponentModel.ISupportInitialize)(this.traceViewItemBindingSource)).BeginInit();
@@ -55,6 +56,7 @@
             this.eventsDataGrid.ColumnHeadersHeightSizeMode = System.Windows.Forms.DataGridViewColumnHeadersHeightSizeMode.AutoSize;
             this.eventsDataGrid.Columns.AddRange(new System.Windows.Forms.DataGridViewColumn[] {
             this.threadDataGridViewTextBoxColumn,
+            this.Channel,
             this.messageDataGridViewTextBoxColumn});
             this.eventsDataGrid.DataSource = this.traceViewItemBindingSource;
             dataGridViewCellStyle3.Alignment = System.Windows.Forms.DataGridViewContentAlignment.MiddleLeft;
@@ -87,6 +89,15 @@
             this.threadDataGridViewTextBoxColumn.ReadOnly = true;
             this.threadDataGridViewTextBoxColumn.Width = 5;
             // 
+            // Channel
+            // 
+            this.Channel.AutoSizeMode = System.Windows.Forms.DataGridViewAutoSizeColumnMode.DisplayedCells;
+            this.Channel.DataPropertyName = "Channel";
+            this.Channel.HeaderText = "Channel";
+            this.Channel.Name = "Channel";
+            this.Channel.ReadOnly = true;
+            this.Channel.Width = 79;
+            // 
             // messageDataGridViewTextBoxColumn
             // 
             this.messageDataGridViewTextBoxColumn.AutoSizeMode = System.Windows.Forms.DataGridViewAutoSizeColumnMode.Fill;
@@ -116,6 +127,7 @@
         private System.Windows.Forms.DataGridView eventsDataGrid;
         private System.Windows.Forms.BindingSource traceViewItemBindingSource;
         private System.Windows.Forms.DataGridViewTextBoxColumn threadDataGridViewTextBoxColumn;
+        private System.Windows.Forms.DataGridViewTextBoxColumn Channel;
         private System.Windows.Forms.DataGridViewTextBoxColumn messageDataGridViewTextBoxColumn;
 
     }
diff --git a/Implab.Diagnostics.Interactive/TraceForm.cs b/Implab.Diagnostics.Interactive/TraceForm.cs
--- a/Implab.Diagnostics.Interactive/TraceForm.cs
+++ b/Implab.Diagnostics.Interactive/TraceForm.cs
@@ -13,9 +13,12 @@ namespace Implab.Diagnostics.Interactive
         readonly Dictionary<int, Color> m_threadColors = new Dictionary<int,Color>();
         readonly Random m_rand = new Random();
 
+        public event EventHandler PauseEvents;
+
+        public event EventHandler ResumeEvents;
+
         public TraceForm() {
             InitializeComponent();
-
         }
 
         protected override void OnFormClosing(FormClosingEventArgs e) {
@@ -26,18 +29,9 @@ namespace Implab.Diagnostics.Interactive
             }
         }
 
-        public void AddTraceEvent(int indent, int thread, string message) {
-            traceViewItemBindingSource.Add(new TraceViewItem {
-                Indent = indent,
-                Thread = thread,
-                Message = message,
-                Timestamp = Environment.TickCount
-            });
-
-        }
-
         public void AddTraceEvent(TraceViewItem item) {
             traceViewItemBindingSource.Add(item);
+            eventsDataGrid.FirstDisplayedScrollingRowIndex = eventsDataGrid.RowCount - 1;
         }
 
         Color GetThreadColor(int thread) {
@@ -51,7 +45,8 @@ namespace Implab.Diagnostics.Interactive
 
         private void eventsDataGrid_CellFormatting(object sender, DataGridViewCellFormattingEventArgs e) {
             var data = (TraceViewItem)traceViewItemBindingSource[e.RowIndex];
-            e.CellStyle.Padding = new Padding(data.Indent * 10,0,0,0);
+            if (e.ColumnIndex == messageDataGridViewTextBoxColumn.Index)
+                e.CellStyle.Padding = new Padding(data.Indent * 10,0,0,0);
             e.CellStyle.ForeColor = GetThreadColor(data.Thread);
         }
     }
diff --git a/Implab.Diagnostics.Interactive/TraceForm.resx b/Implab.Diagnostics.Interactive/TraceForm.resx
--- a/Implab.Diagnostics.Interactive/TraceForm.resx
+++ b/Implab.Diagnostics.Interactive/TraceForm.resx
@@ -117,6 +117,9 @@
   <resheader name="writer">
     <value>System.Resources.ResXResourceWriter, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
   </resheader>
+  <metadata name="Channel.UserAddedColumn" type="System.Boolean, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089">
+    <value>True</value>
+  </metadata>
   <metadata name="traceViewItemBindingSource.TrayLocation" type="System.Drawing.Point, System.Drawing, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a">
     <value>17, 17</value>
   </metadata>
diff --git a/Implab.Diagnostics.Interactive/TraceViewItem.cs b/Implab.Diagnostics.Interactive/TraceViewItem.cs
--- a/Implab.Diagnostics.Interactive/TraceViewItem.cs
+++ b/Implab.Diagnostics.Interactive/TraceViewItem.cs
@@ -12,6 +12,7 @@ namespace Implab.Diagnostics.Interactive
         public int Timestamp { get; set; }
         public int Indent { get; set; }
         public int Thread { get; set; }
+        public string Channel { get; set; }
 
         public string FormattedMessage {
             get {
diff --git a/Implab/Diagnostics/ConsoleTraceListener.cs b/Implab/Diagnostics/ConsoleTraceListener.cs
--- a/Implab/Diagnostics/ConsoleTraceListener.cs
+++ b/Implab/Diagnostics/ConsoleTraceListener.cs
@@ -13,17 +13,17 @@ namespace Implab.Diagnostics {
 
         }
 
-        public ConsoleTraceListener(bool local)
-            : base(local) {
+        public ConsoleTraceListener(bool global)
+            : base(global) {
 
         }
 
-        protected override void WriteEntry(TraceContext context, EventText text) {
+        protected override void WriteEntry(TraceContext context, EventText text, string channel) {
             var msg = new StringBuilder();
 
             for (int i = 0; i < text.indent; i++)
                 msg.Append("  ");
-            msg.AppendFormat("[{0}]: {1}", context.ThreadId, text.content);
+            msg.AppendFormat("[{0}]:{1}: {2}", context.ThreadId, channel, text.content);
 
             lock (_consoleLock) {
                 Console.ForegroundColor = (ConsoleColor)(context.ThreadId % 15 + 1);
diff --git a/Implab/Diagnostics/LogChannel.cs b/Implab/Diagnostics/LogChannel.cs
--- a/Implab/Diagnostics/LogChannel.cs
+++ b/Implab/Diagnostics/LogChannel.cs
@@ -4,23 +4,74 @@ using System.Linq;
 using System.Text;
 
 namespace Implab.Diagnostics {
+    /// <summary>
+    /// Канал, через который публикуются события журнала.
+    /// </summary>
+    /// <typeparam name="TEvent">Тип событий в канале</typeparam>
+    /// <remarks>
+    /// Событиями журнала могут быть любые типы, например строки, в которых будет передаваться
+    /// информация, или структуры с набором полей, описывающих  важность, текст и другую информацию.
+    /// </remarks>
     public class LogChannel<TEvent> {
         static LogChannel<TEvent> _default = new LogChannel<TEvent>();
 
+        /// <summary>
+        /// Канал по-умолчанию для событий типа <typeparam name="TEvent"/>.
+        /// </summary>
         public static LogChannel<TEvent> Default {
             get {
                 return _default;
             }
         }
 
+        /// <summary>
+        /// Событие появление новой записи в журнале, на это событие подписываются слушатели.
+        /// </summary>
         public event EventHandler<ValueEventArgs<TEvent>> Events;
+        
+        /// <summary>
+        /// Имя канала, полезно для отображения в журнале
+        /// </summary>
+        public string Name {
+            get;
+            private set;
+        }
 
+        /// <summary>
+        /// Создает журнал, имя типа событий назначается в качетве имени канала.
+        /// </summary>
+        public LogChannel()
+            : this(null) {
+        }
+
+        /// <summary>
+        /// Содает канал с указанным именем.
+        /// </summary>
+        /// <param name="name">Имя канала.</param>
+        public LogChannel(string name) {
+            if (String.IsNullOrEmpty(name))
+                name = typeof(TEvent).Name;
+            Name = name;
+        }
+
+        /// <summary>
+        /// Отправляет запись журнала через канал подписчикам.
+        /// </summary>
+        /// <param name="data">Запись журнала.</param>
+        /// <remarks>
+        /// Контекст трассировки от которого рассылается сообщение определяется автоматически из текущего потока.
+        /// </remarks>
         public void LogEvent(TEvent data) {
             var t = Events;
             if (t!= null)
                 t(TraceContext.Current,new ValueEventArgs<TEvent>(data));
         }
 
+        /// <summary>
+        /// Отправляет запись журнала через канал подписчикам.
+        /// </summary>
+        /// <param name="data">Запись журнала.</param>
+        /// <param name="context">Контекст трассировки от которого рассылается сообщение/</param>
         public void LogEvent(TraceContext context,TEvent data) {
             var t = Events;
             if (t != null)
diff --git a/Implab/Diagnostics/TextFileListener.cs b/Implab/Diagnostics/TextFileListener.cs
--- a/Implab/Diagnostics/TextFileListener.cs
+++ b/Implab/Diagnostics/TextFileListener.cs
@@ -8,18 +8,19 @@ namespace Implab.Diagnostics {
     public class TextFileListener: TextListenerBase {
         readonly TextWriter m_textWriter;
 
-        public TextFileListener(string fileName, bool local) : base(local) {
+        public TextFileListener(string fileName, bool global)
+            : base(global) {
             m_textWriter = File.CreateText(fileName);
 
             m_textWriter.WriteLine("LOG {0}", DateTime.Now);
             Register(this);
         }
 
-        protected override void WriteEntry(TraceContext context, EventText text) {
+        protected override void WriteEntry(TraceContext context, EventText text, string channel) {
             var msg = new StringBuilder();
             for (int i = 0; i < text.indent; i++)
                 msg.Append("  ");
-            msg.AppendFormat("[{0}]: {1}", context.ThreadId, text.content);
+            msg.AppendFormat("[{0}]:{1}: {2}", context.ThreadId, channel, text.content);
 
             lock (m_textWriter) {
                 if (!IsDisposed) {
diff --git a/Implab/Diagnostics/TextListenerBase.cs b/Implab/Diagnostics/TextListenerBase.cs
--- a/Implab/Diagnostics/TextListenerBase.cs
+++ b/Implab/Diagnostics/TextListenerBase.cs
@@ -10,9 +10,9 @@ namespace Implab.Diagnostics {
         readonly LogicalOperation m_boundOperation;
         readonly int m_baseIndent;
 
-        protected TextListenerBase(bool local) {
+        protected TextListenerBase(bool global) {
             Register(this);
-            if (local) {
+            if (!global) {
                 m_boundOperation = TraceContext.Current.CurrentOperation;
                 m_baseIndent = Math.Max(0, m_boundOperation.Level - 1);
             }
@@ -36,6 +36,7 @@ namespace Implab.Diagnostics {
                 AssertNotDisposed();
 
                 var formatter = GetService<IEventTextFormatter<TEvent>>();
+                var channelName = channel.Name;
 
                 EventHandler<ValueEventArgs<TEvent>> handler = (sender, args) => {
                     TraceContext context = (TraceContext)sender;
@@ -43,7 +44,7 @@ namespace Implab.Diagnostics {
                     text.indent -= m_baseIndent;
 
                     if (IsRelated(context.CurrentOperation))
-                        WriteEntry(context, text);
+                        WriteEntry(context, text, channelName);
                 };
 
                 if (m_subscriptions.ContainsKey(channel))
@@ -98,7 +99,7 @@ namespace Implab.Diagnostics {
         /// </remarks>
         /// <param name="context">Контекст трассировки.</param>
         /// <param name="text">Текст сообщения.</param>
-        protected abstract void WriteEntry(TraceContext context, EventText text);
+        protected abstract void WriteEntry(TraceContext context, EventText text, string channel);
         
         public EventText Format(TraceContext context, object data) {
             return new EventText {
diff --git a/Implab/Diagnostics/TraceContext.cs b/Implab/Diagnostics/TraceContext.cs
--- a/Implab/Diagnostics/TraceContext.cs
+++ b/Implab/Diagnostics/TraceContext.cs
@@ -25,18 +25,24 @@ namespace Implab.Diagnostics {
         /// </summary>
         public static TraceContext Current {
             get {
-                if (_current == null)
+                if (_current == null) {
                     _current = new TraceContext();
+                    _current.LogEvent(TraceEventType.Created,"[{0}]", _current.ThreadId);
+                }
                 return _current;
             }
         }
 
-        TraceContext(TraceContext context) {
+        TraceContext(TraceContext context)
+            : this(context, false) {
+        }
+
+        TraceContext(TraceContext context, bool attach) {
             if (context == null)
                 throw new ArgumentNullException("context");
 
             m_currentOperation = context.CurrentOperation;
-            m_bound = context.CurrentOperation;
+            m_bound = attach ? context.BoundOperation : context.CurrentOperation;
             m_threadId = Thread.CurrentThread.ManagedThreadId;
         }
 
@@ -57,15 +63,15 @@ namespace Implab.Diagnostics {
         /// контексте ранее начатые логические операции не могут быть завершены.
         /// </para>
         /// <para>
-        /// Если передача состояния состоялась, то вызывается событие трассировки <see cref="TraceEventType.Transfer"/>.
+        /// Если передача состояния состоялась, то вызывается событие трассировки <see cref="TraceEventType.Fork"/>.
         /// </para>
         /// </remarks>
-        public static void Transfer(TraceContext from) {
+        public static void Fork(TraceContext from) {
             if (_current == from)
                 return;
             if (from != null) {
                 var context = new TraceContext(from);
-                context.LogEvent(TraceEventType.Transfer, "[{0}]-->[{1}]",from.ThreadId, context.ThreadId);
+                context.LogEvent(TraceEventType.Fork, "[{0}]-->[{1}]",from.ThreadId, context.ThreadId);
                 _current = context;
             } else {
                 _current = new TraceContext();
@@ -73,7 +79,40 @@ namespace Implab.Diagnostics {
         }
 
         /// <summary>
-        /// Создает постоянную копию текущего контекста, данную копию можно хранить и использовать для передачи через <see cref="Transfer(TraceContext)"/>
+        /// Задает текущему потоку указанный контекст, текущей поток может заканчивать ранее начатые
+        /// логические операции в указанном контексте.
+        /// </summary>
+        /// <param name="source"></param>
+        public static void Attach(TraceContext source) {
+            if (_current == source)
+                return;
+            if (source != null) {
+                var context = new TraceContext(source, true);
+                context.LogEvent(TraceEventType.Attach, "[{0}]-->[{1}]", source.ThreadId, context.ThreadId);
+                _current = context;
+            } else {
+                _current = new TraceContext();
+            }
+        }
+
+        /// <summary>
+        /// Отсоединяет текущий контекст трассировки от потока, для дальнейшей его передачи другому потоку
+        /// <see cref="Attach(TraceContext)"/>.
+        /// </summary>
+        /// <returns>Контекст трассировки потока</returns>
+        /// <remarks>
+        /// После отсоединения контекста трассировки от потока, при первом обращении к трассировке в этом
+        /// потоке будет создан новый контекст.
+        /// </remarks>
+        public static TraceContext Detach() {
+            var context = Current;
+            context.LogEvent(TraceEventType.Detach, null);
+            _current = null;
+            return context;
+        }
+
+        /// <summary>
+        /// Создает постоянную копию текущего контекста, данную копию можно хранить и использовать для передачи через <see cref="Fork(TraceContext)"/>
         /// </summary>
         /// <returns>Копия текущего контекста трассировки.</returns>
         public static TraceContext Snapshot() {
@@ -88,7 +127,7 @@ namespace Implab.Diagnostics {
             if (action == null)
                 throw new ArgumentNullException("action");
             var old = _current;
-            Transfer(this);
+            Fork(this);
             try {
                 action();
             } finally {
diff --git a/Implab/Diagnostics/TraceEventType.cs b/Implab/Diagnostics/TraceEventType.cs
--- a/Implab/Diagnostics/TraceEventType.cs
+++ b/Implab/Diagnostics/TraceEventType.cs
@@ -11,6 +11,9 @@ namespace Implab.Diagnostics {
         Error,
         OperationStarted,
         OperationCompleted,
-        Transfer
+        Fork,
+        Attach,
+        Detach,
+        Created
     }
 }
diff --git a/Implab/Disposable.cs b/Implab/Disposable.cs
--- a/Implab/Disposable.cs
+++ b/Implab/Disposable.cs
@@ -1,10 +1,14 @@
-using System;
+using Implab.Diagnostics;
+using System;
 using System.Collections.Generic;
 using System.Diagnostics;
 using System.Linq;
 using System.Web;
 
 namespace Implab {
+    /// <summary>
+    /// Объект, поддерживающий освобождение ресурсов.
+    /// </summary>
     public class Disposable : IDisposable {
         
         bool m_disposed;
@@ -19,7 +23,16 @@ namespace Implab {
             if (m_disposed)
                 throw new ObjectDisposedException(this.ToString());
         }
-
+        /// <summary>
+        /// Переводит объект в состояние <c>Disposed</c> и вызывает событие <see cref="Disposed"/>
+        /// </summary>
+        /// <param name="disposing">Признак того, что нужно освободить ресурсы, иначе данный метод
+        /// вызван сборщиком мусора и нужно освобождать ТОЛЬКО неуправляемые ресурсы ТОЛЬКО этого
+        /// объекта.</param>
+        /// <remarks>
+        /// Данный метод осуществляет проверку того, что объект уже был освобожден, чтобы не вызывать
+        /// событие <see cref="Disposed"/>. Не поддерживает многопоточность.
+        /// </remarks>
         protected virtual void Dispose(bool disposing) {
             if (disposing && !m_disposed) {
                 m_disposed = true;
@@ -34,8 +47,11 @@ namespace Implab {
             GC.SuppressFinalize(this);
         }
 
+        /// <summary>
+        /// Записывает сообщение об утечке объекта.
+        /// </summary>
         protected virtual void ReportObjectLeaks() {
-            Trace.TraceWarning("The object is marked as disposable but isn't disposed properly: {0}", this);
+            TraceLog.TraceWarning("The object is marked as disposable but isn't disposed properly: {0}", this);
         }
 
         ~Disposable() {
diff --git a/Implab/Parallels/ArrayTraits.cs b/Implab/Parallels/ArrayTraits.cs
--- a/Implab/Parallels/ArrayTraits.cs
+++ b/Implab/Parallels/ArrayTraits.cs
@@ -42,7 +42,7 @@ namespace Implab.Parallels {
             }
 
             protected override void Worker() {
-                TraceContext.Transfer(m_traceContext);
+                TraceContext.Fork(m_traceContext);
                 base.Worker();
             }
 
@@ -99,7 +99,7 @@ namespace Implab.Parallels {
             }
 
             protected override void Worker() {
-                TraceContext.Transfer(m_traceContext);
+                TraceContext.Fork(m_traceContext);
                 base.Worker();
             }
 
diff --git a/Implab/Parallels/AsyncPool.cs b/Implab/Parallels/AsyncPool.cs
--- a/Implab/Parallels/AsyncPool.cs
+++ b/Implab/Parallels/AsyncPool.cs
@@ -17,7 +17,7 @@ namespace Implab.Parallels {
             var caller = TraceContext.Snapshot();
 
 			ThreadPool.QueueUserWorkItem(param => {
-                TraceContext.Transfer(caller);
+                TraceContext.Fork(caller);
 				try {
 					p.Resolve(func());
 				} catch(Exception e) {
@@ -34,7 +34,7 @@ namespace Implab.Parallels {
             var caller = TraceContext.Snapshot();
 
             var worker = new Thread(() => {
-                TraceContext.Transfer(caller);
+                TraceContext.Fork(caller);
                 try {
                     p.Resolve(func());
                 } catch (Exception e) {
@@ -46,5 +46,26 @@ namespace Implab.Parallels {
 
             return p;
         }
+
+
+        public static IPromiseBase InvokeNewThread(Action func) {
+            var p = new Promise<object>();
+
+            var caller = TraceContext.Snapshot();
+
+            var worker = new Thread(() => {
+                TraceContext.Fork(caller);
+                try {
+                    func();
+                    p.Resolve();
+                } catch (Exception e) {
+                    p.Reject(e);
+                }
+            });
+            worker.IsBackground = true;
+            worker.Start();
+
+            return p;
+        }
 	}
 }