Refactor UIMonitor and Watchers

Author: govert

Source/ExcelDna.IntelliSense.Host/AddIn.cs

@@ -14,7 +14,8 @@ public class AddIn : IExcelAddIn
         public void AutoOpen()
         {
             IntelliSenseServer.Register();
-            // ExcelDna.Logging.LogDisplay.Show();
+            ExcelDna.Logging.LogDisplay.Show();
+            ExcelDna.Logging.LogDisplay.DisplayOrder = ExcelDna.Logging.DisplayOrder.NewestFirst;
         }
 
         public void AutoClose()

Source/ExcelDna.IntelliSense.Host/ExcelDna.IntelliSense.Host-AddIn.xll.config

@@ -1,8 +1,18 @@
 <?xml version="1.0" encoding="utf-8" ?>
 <configuration>
   <system.diagnostics>
+    <trace autoflush="true" indentsize="4"/>
     <sources>
-      <source name="ExcelDna.IntelliSense" switchValue="Off">
+      <source name="ExcelDna.IntelliSense" switchValue="All">
+        <listeners>
+          <!--<remove name="Default" />-->
+          <!--<add name="LogDisplay" type="ExcelDna.Logging.LogDisplayTraceListener,ExcelDna.Integration">
+            <filter type="System.Diagnostics.EventTypeFilter" initializeData="All"/>
+          </add>-->
+          <add name="File" type="System.Diagnostics.TextWriterTraceListener" initializeData="ExcelDna.IntelliSense.log" >
+            <filter type="System.Diagnostics.EventTypeFilter" initializeData="All"/>
+          </add>
+        </listeners>
       </source>
     </sources>
   </system.diagnostics>

Source/ExcelDna.IntelliSense/ExcelDna.IntelliSense.csproj

@@ -72,24 +72,26 @@
   </ItemGroup>
   <ItemGroup>
     <Compile Include="FormattedText.cs" />
-    <Compile Include="FormulaParser.cs" />
+    <Compile Include="UIMonitor\FormulaEditWatcher.cs" />
+    <Compile Include="UIMonitor\FormulaParser.cs" />
     <Compile Include="IntelliSenseDisplay.cs" />
     <Compile Include="IntelliSenseHelper.cs" />
     <Compile Include="IntelliSenseProvider.cs" />
     <Compile Include="IntelliSenseServer.cs" />
     <Compile Include="Logging.cs" />
+    <Compile Include="UIMonitor\PopupListWatcher.cs" />
     <Compile Include="Properties\AssemblyInfo.cs" />
     <Compile Include="SingleThreadSynchronizationContext.cs" />
     <Compile Include="ToolTipForm.cs">
       <SubType>Form</SubType>
     </Compile>
-    <Compile Include="UIMonitor.cs" />
-    <Compile Include="Watchers.cs" />
+    <Compile Include="UIMonitor\UIMonitor.cs" />
+    <Compile Include="UIMonitor\WindowWatcher.cs" />
     <Compile Include="Win32Helper.cs" />
     <Compile Include="LoaderNotification.cs" />
     <Compile Include="WindowResizer.cs" />
-    <Compile Include="WinEvents.cs" />
-    <Compile Include="XlCall.cs" />
+    <Compile Include="UIMonitor\WinEvents.cs" />
+    <Compile Include="UIMonitor\XlCall.cs" />
   </ItemGroup>
   <ItemGroup>
     <EmbeddedResource Include="ToolTipForm.resx">

Source/ExcelDna.IntelliSense/IntelliSenseDisplay.cs

@@ -256,9 +256,16 @@ void FormulaEditTextChange(string formulaPrefix, Rect editWindowBounds, Rect exc
                 IntelliSenseFunctionInfo functionInfo;
                 if (_functionInfoMap.TryGetValue(functionName, out functionInfo))
                 {
-                    _argumentsToolTip.ShowToolTip(
-                        GetFunctionIntelliSense(functionInfo, currentArgIndex),
-                        (int)editWindowBounds.Left, (int)editWindowBounds.Bottom + 5);
+                    if (_argumentsToolTip != null)
+                    {
+                        _argumentsToolTip.ShowToolTip(
+                            GetFunctionIntelliSense(functionInfo, currentArgIndex),
+                            (int)editWindowBounds.Left, (int)editWindowBounds.Bottom + 5);
+                    }
+                    else
+                    {
+                        Logger.Display.Warn("FormulaEditTextChange with no arguments tooltip !?");
+                    }
                     return;
                 }
 

Source/ExcelDna.IntelliSense/IntelliSenseProvider.cs

@@ -71,6 +71,7 @@ public void Refresh()
                 if (regInfoResponse.Equals(ExcelError.ExcelErrorNA))
                 {
                     _regInfoNotAvailable = true;
+                    Logger.Provider.Verbose($"XllRegistrationInfo not available for {_xllPath}");
                     return;
                 }
 
@@ -101,7 +102,9 @@ public IEnumerable<IntelliSenseFunctionInfo> GetFunctionInfos()
                 if (regInfo == null)
                     yield break;
 
-                for (int i = 0; i < regInfo.GetLength(0); i++)
+                int regInfoCount = regInfo.GetLength(0);
+                Logger.Provider.Verbose($"XllRegistrationInfo for {_xllPath}: {regInfoCount} registrations");
+                for (int i = 0; i < regInfoCount; i++)
                 {
                     if (regInfo[i, 0] is ExcelEmpty)
                     {
@@ -136,6 +139,7 @@ public IEnumerable<IntelliSenseFunctionInfo> GetFunctionInfos()
         ExcelSynchronizationContext _syncContextExcel;
         Dictionary<string, XllRegistrationInfo> _xllRegistrationInfos = new Dictionary<string, XllRegistrationInfo>();
         LoaderNotification _loaderNotification;
+        bool _isDirty;
         public event EventHandler Invalidate;
 
         public ExcelDnaIntelliSenseProvider()
@@ -158,6 +162,7 @@ public void Initialize()
                 {
                     if (!_xllRegistrationInfos.ContainsKey(xllPath))
                     {
+                        Logger.Provider.Verbose($"ExcelDnaIntelliSenseProvider.Initialize: Adding XllRegistrationInfo for {xllPath}");
                         XllRegistrationInfo regInfo = new XllRegistrationInfo(xllPath);
                         _xllRegistrationInfos[xllPath] = regInfo;
                         regInfo.Refresh();
@@ -177,16 +182,25 @@ public void Refresh()
                 {
                     regInfo.Refresh();
                 }
+                _isDirty = false;
             }
         }
 
         // May be called from any thread
         public IList<IntelliSenseFunctionInfo> GetFunctionInfos()
         {
+            IList<IntelliSenseFunctionInfo> functionInfos;
             lock (_xllRegistrationInfos)
             {
-                return _xllRegistrationInfos.Values.SelectMany(ri => ri.GetFunctionInfos()).ToList();
+                functionInfos = _xllRegistrationInfos.Values.SelectMany(ri => ri.GetFunctionInfos()).ToList();
             }
+            Logger.Provider.Verbose("ExcelDnaIntelliSenseProvider.GetFunctionInfos Begin");
+            foreach (var info in functionInfos)
+            {
+                Logger.Provider.Verbose($"\t{info.FunctionName}({info.ArgumentList.Count}) - {info.Description} ");
+            }
+            Logger.Provider.Verbose("ExcelDnaIntelliSenseProvider.GetFunctionInfos End");
+            return functionInfos;
         }
 
         #endregion
@@ -195,7 +209,7 @@ public IList<IntelliSenseFunctionInfo> GetFunctionInfos()
         // TODO: Consider Load/Unload done when AddIns is enumerated...
         void loaderNotification_LoadNotification(object sender, LoaderNotification.NotificationEventArgs e)
         {
-            Debug.Print($"@>@>@>@> LoadNotification: {e.Reason} - {e.FullDllName}");
+            // Debug.Print($"@>@>@>@> LoadNotification: {e.Reason} - {e.FullDllName}");
             if (e.FullDllName.EndsWith(".xll", StringComparison.OrdinalIgnoreCase))
                 _syncContextExcel.Post(ProcessLoadNotification, e);
         }
@@ -207,6 +221,9 @@ void ProcessLoadNotification(object state)
             // we might want to introduce a delay here, so that the .xll can complete loading...
             var notification = (LoaderNotification.NotificationEventArgs)state;;
             var xllPath = notification.FullDllName;
+
+            Logger.Provider.Verbose($"ExcelDnaIntelliSenseProvider.ProcessLoadNotification {notification}, {xllPath}");
+
             lock (_xllRegistrationInfos)
             {
                 XllRegistrationInfo regInfo;
@@ -217,12 +234,18 @@ void ProcessLoadNotification(object state)
                         regInfo = new XllRegistrationInfo(xllPath);
                         _xllRegistrationInfos[xllPath] = regInfo;
                         //regInfo.Refresh();    // Rather not.... so that we don't even try during the AddIns enumeration... OnInvalidate will lead to Refresh()
-                        OnInvalidate();
+
+                        if (!_isDirty)
+                        {
+                            _isDirty = true;
+                            _syncContextExcel.Post(OnInvalidate, null);
+                        }
                     }
                 }
                 else if (notification.Reason == LoaderNotification.Reason.Unloaded)
                 {
                     _xllRegistrationInfos.Remove(xllPath);
+                    // Not too worried about cleaning up
                     // OnInvalidate();
                 }
             }
@@ -247,7 +270,7 @@ IEnumerable<string> GetLoadedXllPaths()
             }
         }
 
-        void OnInvalidate()
+        void OnInvalidate(object _unused_)
         {
             Invalidate?.Invoke(this, EventArgs.Empty);
         }

Source/ExcelDna.IntelliSense/IntelliSenseServer.cs

@@ -47,7 +47,7 @@ namespace ExcelDna.IntelliSense
     // REMEMBER: COM events are not necessarily safe macro contexts.
     public static class IntelliSenseServer
     {
-        const string ServerVersion = "0.0.1";  // TODO: Define and manage this somewhere else
+        const string ServerVersion = "0.0.2";  // TODO: Define and manage this somewhere else
 
         // NOTE: Do not change these constants in custom versions. 
         //       They are part of the co-operative safety mechanism allowing different add-ins providing IntelliSense to work together safely.
@@ -76,10 +76,12 @@ public static class IntelliSenseServer
         // Called directly from AutoOpen.
         public static void Register()
         {
+            TraceLogger.Initialize();
+
+            Logger.Initialization.Info($"IntelliSenseServer.Register Begin: Version {ServerVersion} in {AppDomain.CurrentDomain.FriendlyName}");
             if (IsDisabled())
                 return;
 
-            TraceLogger.Initialize();
             RegisterControlFunction();
             PublishRegistration();
 
@@ -95,6 +97,10 @@ public static void Register()
                 // We're newer - deactivate the active server and activate ourselves.
                 shouldActivate = true;
             }
+            else
+            {
+                Logger.Initialization.Info($"IntelliSenseServer not being activated now. Active Version: {activeInfo.Version}");
+            }
             // Else we're not activating - there is an active server and it is the same version or newer
             // TODO: Tell it to load our UDFs somehow - maybe call a hidden macro?
 
@@ -104,6 +110,7 @@ public static void Register()
             }
 
             AppDomain.CurrentDomain.DomainUnload += CurrentDomain_DomainUnload;
+            Logger.Initialization.Info("IntelliSenseServer.Register End");
         }
 
         // DomainUnload runs when AutoClose() would run on the add-in.
@@ -138,9 +145,9 @@ internal static bool Activate()
                 // TODO: Perhaps also register macro to trigger updates
                 return true;
             }
-            catch (Exception /*ex*/)
+            catch (Exception ex)
             {
-                // TOOD: Log
+                Logger.Initialization.Error($"IntelliSenseServer.Activate failed: {ex}");
                 return false;
             }
         }
@@ -175,9 +182,16 @@ static bool IsDisabled()
             var environmentDisabled = Environment.GetEnvironmentVariable(DisabledVersionsVariable) as string;
 
             var thisVersion = ServerVersion;
-            return IsVersionMatch(thisVersion, machineDisabled) ||
-                   IsVersionMatch(thisVersion, userDisabled) ||
-                   IsVersionMatch(thisVersion, environmentDisabled);
+            var isDisabled = IsVersionMatch(thisVersion, machineDisabled) ||
+                             IsVersionMatch(thisVersion, userDisabled) ||
+                             IsVersionMatch(thisVersion, environmentDisabled);
+
+            if (isDisabled)
+            {
+                Logger.Initialization.Info($"IntelliSenseServer version {thisVersion} is disabled. MachineDisabled: {machineDisabled}, UserDisabled: {userDisabled}, EnvironmentDisabled: {environmentDisabled}");
+            }
+
+            return isDisabled;
         }
 
         // Attempts to activate the server described by registrationInfo

Source/ExcelDna.IntelliSense/IntellisenseHelper.cs

@@ -20,16 +20,19 @@ class IntelliSenseHelper : IDisposable
 
         public IntelliSenseHelper()
         {
+            Logger.Initialization.Verbose("IntelliSenseHelper Constructor Begin");
             _syncContextMain = new WindowsFormsSynchronizationContext();
             _uiMonitor = new UIMonitor(_syncContextMain);
+            _display = new IntelliSenseDisplay(_syncContextMain, _uiMonitor);
 
-            IIntelliSenseProvider excelDnaProvider = new ExcelDnaIntelliSenseProvider();
-            _providers.Add(excelDnaProvider);
-            IIntelliSenseProvider workbookProvider = new WorkbookIntelliSenseProvider();
-            _providers.Add(workbookProvider);
+            _providers = new List<IIntelliSenseProvider>
+            {
+                new ExcelDnaIntelliSenseProvider(),
+                new WorkbookIntelliSenseProvider()
+            };
 
-            _display = new IntelliSenseDisplay(_syncContextMain, _uiMonitor);
             RegisterIntellisense();
+            Logger.Initialization.Verbose("IntelliSenseHelper Constructor End");
         }
 
         void RegisterIntellisense()
@@ -42,7 +45,6 @@ void RegisterIntellisense()
             }
         }
 
-        // Must be raised on the main thread, in a macro context
         // We need to call Refresh on the main thread in a macro context,
         // and then GetFunctionInfos() to update the Display
         void Provider_Invalidate(object sender, EventArgs e)

Source/ExcelDna.IntelliSense/Logging.cs

@@ -51,7 +51,7 @@ namespace ExcelDna.IntelliSense
 
     // NOTE: To simplify configuration (so that we provide one TraceSource per referenced assembly) and still allow some grouping
     //       we use the EventId to define a trace event classification.
-    // These names are not surfaces to the Trace Listeners - just the IDs, so we should document them.
+    // These names are not surfaced to the Trace Listeners - just the IDs, so we should document them.
     enum IntelliSenseTraceEventId
     {
         Initialization = 1,