Add ToolStripItemTarget. (#87)

* Add ToolStripItemTarget.

* Switch to using layout instead of strings

Also move logic directly to write method rather than add a billion
arguments to FindItemAndSendTheMessage

* Add unit tests for ToolStripMenuItemTarget.

* Do events so invoke can apply. Dispose form.

* Add whitespace for clarity. Test dumb theory.

* Add second DoEvents to make test pass because ???

* Run form on STA thread.

* Read item only from form thread.

* Add ability to track pending invocations for tests

* Bring back the form threading.

* Fix unit testing

Use collections so tests don't run simultaneously as well as remove
tricky code that didn't work and is just clutter if unneeded.

* Simplify test further.

Co-authored-by: JTignor <[email protected]>

Author: Fr33dan

NLog.Windows.Forms.Tests/RichTextBoxTargetTests.cs

@@ -12,6 +12,7 @@
 
 namespace NLog.Windows.Forms.Tests
 {
+    [Collection("NLog.Windows.Forms Tests")]
     public class RichTextBoxTargetTests
     {
         private Logger logger = LogManager.GetLogger("NLog.UnitTests.Targets.RichTextBoxTargetTests");

NLog.Windows.Forms.Tests/ToolStripItemTargetTests.cs

@@ -0,0 +1,82 @@
+using NLog.Config;
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+using System.Windows.Forms;
+using Xunit;
+
+namespace NLog.Windows.Forms.Tests
+{
+    [Collection("NLog.Windows.Forms Tests")]
+    public class ToolStripItemTargetTests
+    {
+        private Logger logger = LogManager.GetLogger("NLog.UnitTests.Targets.ToolStripItemTargetTests");
+
+        [Fact]
+        public void SimpleToolStripItemTargetTest()
+        {
+            Form testForm = null;
+            try
+            {
+                testForm = new Form();
+                testForm.Name = "Form1";
+
+                ToolStrip testMenuStrip = new ToolStrip();
+                testMenuStrip.Name = "ToolStrip1";
+                testForm.Controls.Add(testMenuStrip);
+
+                ToolStripMenuItem testItem = new ToolStripMenuItem();
+                testItem.Name = "Item1";
+                testMenuStrip.Items.Add(testItem);
+
+                testForm.Show();
+
+                Application.DoEvents();
+
+                ToolStripItemTarget target = new ToolStripItemTarget()
+                {
+                    ItemName = "Item1",
+                    FormName = "Form1",
+                    ToolStripName = "ToolStrip1",
+                    Layout = "${level} ${logger} ${message}"
+                };
+                SimpleConfigurator.ConfigureForTargetLogging(target, LogLevel.Trace);
+
+                logger.Fatal("Test");   // Send log
+                Application.DoEvents(); // Do events to allow the invoked method is completed.
+                Assert.Equal("Fatal NLog.UnitTests.Targets.ToolStripItemTargetTests Test", testItem.Text); // Test if method worked.
+                
+                logger.Error("Foo");
+                Application.DoEvents();
+                Assert.Equal("Error NLog.UnitTests.Targets.ToolStripItemTargetTests Foo", testItem.Text);
+                
+                logger.Warn("Bar");
+                Application.DoEvents();
+                Assert.Equal("Warn NLog.UnitTests.Targets.ToolStripItemTargetTests Bar", testItem.Text);
+                
+                logger.Info("Test");
+                Application.DoEvents();
+                Assert.Equal("Info NLog.UnitTests.Targets.ToolStripItemTargetTests Test", testItem.Text);
+                
+                logger.Debug("Foo");
+                Application.DoEvents();
+                Assert.Equal("Debug NLog.UnitTests.Targets.ToolStripItemTargetTests Foo", testItem.Text);
+                
+                logger.Trace("Bar");
+                Application.DoEvents();
+                Assert.Equal("Trace NLog.UnitTests.Targets.ToolStripItemTargetTests Bar", testItem.Text);
+
+            }
+            finally
+            {
+                if (testForm != null)
+                {
+                    testForm.Dispose();
+                }
+                LogManager.Configuration = null;
+            }
+        }
+    }
+}

NLog.Windows.Forms/FormHelper.cs

@@ -55,6 +55,34 @@ internal static Control FindControl(string name, Control searchControl)
             return null;
         }
 
+        /// <summary>
+        /// Finds item within searchCollection it's contents drop down items.
+        /// </summary>
+        /// <param name="name">Name of the ToolStripItem</param>
+        /// <param name="searchCollection">Collection of ToolStripItem we are looking for the item in.</param>
+        /// <returns>A value of null of no item has been found.</returns>
+        internal static ToolStripItem FindToolStripItem(string name, ToolStripItemCollection searchCollection)
+        {
+            foreach (ToolStripItem childItem in searchCollection)
+            {
+                if(childItem.Name == name)
+                {
+                    return childItem;
+                }
+                if(childItem is ToolStripDropDownItem)
+                {
+                    ToolStripDropDownItem childDropDown = childItem as ToolStripDropDownItem;
+                    ToolStripItem foundItem = FindToolStripItem(name, childDropDown.DropDownItems);
+
+                    if (foundItem != null)
+                    {
+                        return foundItem;
+                    }
+                }
+            }
+            return null;
+        }
+
         /// <summary>
         /// Finds control of specified type embended on searchControl.
         /// </summary>

NLog.Windows.Forms/ToolStripItemTarget.cs

@@ -0,0 +1,130 @@
+using System;
+using System.ComponentModel;
+using System.Windows.Forms;
+using NLog.Common;
+using NLog.Config;
+using NLog.Layouts;
+using NLog.Targets;
+
+namespace NLog.Windows.Forms
+{
+    /// <summary>
+    /// Logs text to Windows.Forms.ToolStripItem.Text property control of specified Name.
+    /// </summary>
+    /// <example>
+    /// <p>
+    /// To set up the target in the <a href="config.html">configuration file</a>, 
+    /// use the following syntax:
+    /// </p>
+    /// <code lang="XML" source="examples/targets/Configuration File/ToolStripItem/NLog.config" />
+    /// <p>
+    /// The result is:
+    /// </p>
+    /// <img src="examples/targets/Screenshots/ToolStripItem/ToolStripItem.gif" />
+    /// <p>
+    /// To set up the log target programmatically similar to above use code like this:
+    /// </p>
+    /// <code lang="C#" source="examples/targets/Configuration API/ToolStripItem/Form1.cs" />,
+    /// </example>
+    [Target("ToolStripItem")]
+    public sealed class ToolStripItemTarget : TargetWithLayout
+    {
+        /// <summary>
+        /// Initializes a new instance of the <see cref="ToolStripItemTarget" /> class.
+        /// </summary>
+        /// <remarks>
+        /// The default value of the layout is: <code>${longdate}|${level:uppercase=true}|${logger}|${message}</code>
+        /// </remarks>
+        public ToolStripItemTarget()
+        {
+        }
+
+        private delegate void DelSendTheMessageToFormControl(ToolStripItem control, string logMessage);
+
+        /// <summary>
+        /// Gets or sets the name of the ToolStripItem to which NLog will log write log text.
+        /// </summary>
+        /// <docgen category='Form Options' order='10' />
+        [RequiredParameter]
+        public Layout ItemName { get; set; }
+
+        /// <summary>
+        /// Gets or sets the name of ToolStrip that contains the ToolStripItem to which NLog will log write log text.
+        /// </summary>
+        /// <docgen category='Form Options' order='10' />
+        [RequiredParameter]
+        public Layout ToolStripName { get; set; }
+
+        /// <summary>
+        /// Gets or sets the name of the Form on which the ToolStrip is located.
+        /// </summary>
+        /// <docgen category='Form Options' order='10' />
+        public Layout FormName { get; set; }
+
+        /// <summary>
+        /// Log message to item.
+        /// </summary>
+        /// <param name="logEvent">
+        /// The logging event.
+        /// </param>
+        protected override void Write(LogEventInfo logEvent)
+        {
+            string logMessage = Layout.Render(logEvent);
+
+            Form form = null;
+
+            if (Form.ActiveForm != null)
+            {
+                form = Form.ActiveForm;
+            }
+
+            if (Application.OpenForms[FormName.Render(logEvent)] != null)
+            {
+                form = Application.OpenForms[FormName.Render(logEvent)];
+            }
+
+            if (form == null)
+            {
+                InternalLogger.Info("Form {0} not found", FormName);
+                return;
+            }
+
+            Control control = FormHelper.FindControl(ToolStripName.Render(logEvent), form);
+
+            if (control == null || !(control is ToolStrip))
+            {
+                InternalLogger.Info("ToolStrip {0} on Form {1} not found", ToolStripName, FormName);
+                return;
+            }
+
+            ToolStrip toolStrip = control as ToolStrip;
+
+            ToolStripItem item = FormHelper.FindToolStripItem(ItemName.Render(logEvent), toolStrip.Items);
+
+            if (item == null)
+            {
+                InternalLogger.Info("ToolStripItem {0} on ToolStrip {1} not found", ItemName, ToolStripName);
+                return;
+            }
+
+            try
+            {
+                control.BeginInvoke(new DelSendTheMessageToFormControl(SendTheMessageToFormControl), item, logMessage);
+                
+            }
+            catch (Exception ex)
+            {
+                InternalLogger.Warn(ex.ToString());
+
+                if (LogManager.ThrowExceptions)
+                {
+                    throw;
+                }
+            }
+        }
+        private void SendTheMessageToFormControl(ToolStripItem item, string logMessage)
+        {
+            item.Text = logMessage;
+        }
+    }
+}