Added built in simple help.

Added control for turning LOGGING on.
Added menu for turning REPORT on.
Beefed up error handling during sequence processing.
Improved performance by only evaluating the target app control tree once and caching Regexs.

Author: Darin Higgins

Disambiguator/Disambiguator.csproj

@@ -86,6 +86,12 @@
     </Reference>
   </ItemGroup>
   <ItemGroup>
+    <Compile Include="DisambiguatorHelp.cs">
+      <SubType>Form</SubType>
+    </Compile>
+    <Compile Include="DisambiguatorHelp.Designer.cs">
+      <DependentUpon>DisambiguatorHelp.cs</DependentUpon>
+    </Compile>
     <Compile Include="Properties\Resources.Designer.cs">
       <AutoGen>True</AutoGen>
       <DesignTime>True</DesignTime>
@@ -98,6 +104,9 @@
     </Compile>
   </ItemGroup>
   <ItemGroup>
+    <EmbeddedResource Include="DisambiguatorHelp.resx">
+      <DependentUpon>DisambiguatorHelp.cs</DependentUpon>
+    </EmbeddedResource>
     <EmbeddedResource Include="Properties\Resources.resx">
       <Generator>ResXFileCodeGenerator</Generator>
       <LastGenOutput>Resources.Designer.cs</LastGenOutput>
@@ -107,6 +116,7 @@
     </EmbeddedResource>
   </ItemGroup>
   <ItemGroup>
+    <EmbeddedResource Include="DisambiguatorHelp.rtf" />
     <None Include="KeePass.exe">
       <CopyToOutputDirectory>Always</CopyToOutputDirectory>
     </None>

Disambiguator/DisambiguatorExt.cs

@@ -42,6 +42,11 @@ public sealed class DisambiguatorExt : Plugin
         /// </summary>
         private bool _reportOn = false;
 
+        /// <summary>
+        /// used to turn logging on or off dynamically
+        /// </summary>
+        private static bool _loggingOn = false;
+
         /// <summary>
         /// is reporting on for this invocation
         /// </summary>
@@ -98,6 +103,22 @@ public override ToolStripMenuItem GetMenuItem(PluginMenuType t)
                     };
                     subMenu.Click += this.OnSetReportClicked;
                     menuItem.DropDownItems.Add(subMenu);
+
+                    subMenu = new ToolStripMenuItem()
+                    {
+                        Text = "Logging",
+                        CheckOnClick = true,
+                        Checked = false,
+                    };
+                    subMenu.Click += this.OnSetLoggingClicked;
+                    menuItem.DropDownItems.Add(subMenu);
+
+                    subMenu = new ToolStripMenuItem()
+                    {
+                        Text = "Help",
+                    };
+                    subMenu.Click += this.OnHelpClicked;
+                    menuItem.DropDownItems.Add(subMenu);
                     break;
 
                 //case PluginMenuType.Group:
@@ -124,6 +145,27 @@ public override ToolStripMenuItem GetMenuItem(PluginMenuType t)
             return menuItem;
         }
 
+        private void OnSetLoggingClicked(object sender, EventArgs e)
+        {
+            var menuItem = sender as ToolStripMenuItem;
+            _loggingOn = menuItem.Checked;
+
+            if (_loggingOn)
+            {
+                MessageBox.Show("Disambiguator Logging is now enabled\r\n\r\n" +
+                    "With logging on, a Disambiguator.log file will be written to\r\n" +
+                    "the current user's Desktop.\r\n\r\n" +
+                    "It is recommended to only turn on logging when asked to by\r\n" +
+                    "The Disambiguator development team."
+                    , "The Disambiguator", MessageBoxButtons.OK, MessageBoxIcon.Information);
+            }
+        }
+
+        private void OnHelpClicked(object sender, EventArgs e)
+        {
+            new DisambiguatorHelp().ShowDialog();
+        }
+
 
         private void OnSetReportClicked(object sender, EventArgs e)
         {
@@ -137,13 +179,13 @@ private void OnSetReportClicked(object sender, EventArgs e)
                     "evaluate the target application and display a report of the\r\n" +
                     "executable name and various control details you can use\r\n" +
                     "to pinpoint the specific autotype sequence to use."
-                    , "The Disambiguator");
+                    , "The Disambiguator", MessageBoxButtons.OK, MessageBoxIcon.Exclamation);
             }
             else
             {
                 MessageBox.Show("Disambiguator Reporting is now disabled\r\n\r\n" +
                     "Standard autotype functionality will now resume."
-                    , "The Disambiguator");
+                    , "The Disambiguator", MessageBoxButtons.OK, MessageBoxIcon.Information);
             }
         }
 
@@ -179,19 +221,26 @@ private void OnMainOptionsClicked(object sender, EventArgs e)
         /// <param name="e"></param>
         private void AutoType_SequenceQueriesBegin(object sender, SequenceQueriesEventArgs e)
         {
-            Debug("Sequence Queries Begin");
+            try
+            {
+                Debug("Sequence Queries Begin");
 
-            _exePath = getExecutableFromHwnd(e.TargetWindowHandle).ToLower();
-            _exeFile = Path.GetFileName(_exePath);
-            _report = _reportOn;
-            _matchCount = 0;
+                _exePath = getExecutableFromHwnd(e.TargetWindowHandle).ToLower();
+                _exeFile = Path.GetFileName(_exePath);
+                _report = _reportOn;
+                _matchCount = 0;
 
-            //traverse the control tree for the target window to collect
-            //a list of UIelements that we can use to disambiguate
-            _currentUIElements = TraverseControlTree(e.TargetWindowHandle);
+                //traverse the control tree for the target window to collect
+                //a list of UIelements that we can use to disambiguate
+                _currentUIElements = TraverseControlTree(e.TargetWindowHandle);
 
-            //once the target app is analyzed, show any report window (if applicable)
-            TestOutput.ShowOnTop();
+                //once the target app is analyzed, show any report window (if applicable)
+                TestOutput.ShowOnTop();
+            }
+            catch (Exception ex)
+            {
+                Debug("Error In AutoType_SequenceQueriesBegin: " + ex.ToString());
+            }
         }
 
 
@@ -274,28 +323,49 @@ private void AutoType_SequenceQueriesEnd(object sender, SequenceQueriesEventArgs
         /// <param name="e"></param>
         private void AutoType_SequenceQuery(object sender, SequenceQueryEventArgs e)
         {
-            //if reporting is on, we don't actually try to match anything
-            if (_report) return;
+            try
+            {
+                //if reporting is on, we don't actually try to match anything
+                if (_report) return;
+
+                //main win title and AutoType sequence for this entry
+                //we have to check this separately from the custom associations
+                var autoTypeSequenceTitle = e.Entry.Strings.ReadSafe("Title");
+                string entryAutoTypeSequence = e.Entry.GetAutoTypeSequence();
 
-            //main win title and AutoType sequence for this entry
-            //we have to check this separately from the custom associations
-            var autoTypeSequenceTitle = e.Entry.Strings.ReadSafe("Title");
-            string entryAutoTypeSequence = e.Entry.GetAutoTypeSequence();
+                try
+                {
+                    Debug("ResolveSequence for AutoType Sequence Title");
+                    ResolveSequence(autoTypeSequenceTitle, entryAutoTypeSequence, e);
+                }
+                catch (Exception ex)
+                {
+                    Debug("Error In AutoType_SequenceQuery.Resolving Title: " + ex.ToString());
+                }
 
-            Debug("ResolveSequence for AutoType Sequence Title");
-            ResolveSequence(autoTypeSequenceTitle, entryAutoTypeSequence, e);
+                //run through the target window associations looking for match elements
+                foreach (AutoTypeAssociation association in e.Entry.AutoType.Associations)
+                {
+                    //get the window name (this would usually contain the TITLE of the window
+                    //that would match
+                    try
+                    { 
+                    var winName = association.WindowName;
+                    Debug("ResolveSequence for AutoType Association Name");
+                    ResolveSequence(winName, association.Sequence, e);
+                    }
+                    catch (Exception ex)
+                    {
+                        Debug("Error In AutoType_SequenceQuery.Resolving AutoType Associations: " + ex.ToString());
+                    }
+                }
 
-            //run through the target window associations looking for match elements
-            foreach (AutoTypeAssociation association in e.Entry.AutoType.Associations)
+                Debug("Finished AutoType_SequenceQuery");
+            }
+            catch (Exception ex)
             {
-                //get the window name (this would usually contain the TITLE of the window
-                //that would match
-                var winName = association.WindowName;
-                Debug("ResolveSequence for AutoType Association Name");
-                ResolveSequence(winName, association.Sequence, e);
+                Debug("Error In AutoType_SequenceQuery: " + ex.ToString());
             }
-
-            Debug("Finished AutoType_SequenceQuery");
         }
 
 
@@ -581,6 +651,7 @@ private static string LogFile
 
         internal static void Debug(string template, params object[] args)
         {
+            if (!_loggingOn) return;
             try
             {
                 var buf = string.Format(template, args);

Disambiguator/DisambiguatorHelp.Designer.cs

@@ -0,0 +1,50 @@
+using System;
+using System.Collections.Generic;
+using System.ComponentModel;
+using System.Data;
+using System.Drawing;
+using System.IO;
+using System.Linq;
+using System.Reflection;
+using System.Text;
+using System.Threading.Tasks;
+using System.Windows.Forms;
+
+
+namespace Disambiguator
+{
+    public partial class DisambiguatorHelp : Form
+    {
+        public DisambiguatorHelp()
+        {
+            InitializeComponent();
+        }
+
+
+        private void btnClose_Click(object sender, EventArgs e)
+        {
+            this.Close();
+        }
+
+
+        private void DisambiguatorHelp_Load(object sender, EventArgs e)
+        {
+            Assembly asm = Assembly.GetExecutingAssembly();
+            Stream stream = asm.GetManifestResourceStream("Disambiguator.DisambiguatorHelp.rtf");
+
+            this.rtfHelp.LoadFile(stream, RichTextBoxStreamType.RichText);
+            this.rtfHelp.ReadOnly = true;
+            this.rtfHelp.LinkClicked += RtfHelp_LinkClicked;
+        }
+
+
+        private void RtfHelp_LinkClicked(object sender, LinkClickedEventArgs e)
+        {
+            try
+            {
+                System.Diagnostics.Process.Start(e.LinkText);
+            }
+            catch { }
+        }
+    }
+}