Fix up providers

govert · govert · commit 4388c7afb6c8 · 2016-04-24T18:42:29.000+02:00
diff --git a/Source/ExcelDna.IntelliSense/ExcelDna.IntelliSense.csproj b/Source/ExcelDna.IntelliSense/ExcelDna.IntelliSense.csproj
@@ -40,6 +40,21 @@
       <HintPath>..\packages\UIAComWrapper.1.1.0.14\lib\net40\Interop.UIAutomationClient.dll</HintPath>
       <EmbedInteropTypes>False</EmbedInteropTypes>
     </Reference>
+    <Reference Include="Microsoft.Office.Interop.Excel, Version=14.0.0.0, Culture=neutral, PublicKeyToken=71e9bce111e9429c, processorArchitecture=MSIL">
+      <EmbedInteropTypes>True</EmbedInteropTypes>
+      <HintPath>..\packages\ExcelDna.Interop.14.0.1\lib\Microsoft.Office.Interop.Excel.dll</HintPath>
+      <Private>True</Private>
+    </Reference>
+    <Reference Include="Microsoft.Vbe.Interop, Version=14.0.0.0, Culture=neutral, PublicKeyToken=71e9bce111e9429c, processorArchitecture=MSIL">
+      <EmbedInteropTypes>True</EmbedInteropTypes>
+      <HintPath>..\packages\ExcelDna.Interop.14.0.1\lib\Microsoft.Vbe.Interop.dll</HintPath>
+      <Private>True</Private>
+    </Reference>
+    <Reference Include="Office, Version=14.0.0.0, Culture=neutral, PublicKeyToken=71e9bce111e9429c, processorArchitecture=MSIL">
+      <EmbedInteropTypes>True</EmbedInteropTypes>
+      <HintPath>..\packages\ExcelDna.Interop.14.0.1\lib\Office.dll</HintPath>
+      <Private>True</Private>
+    </Reference>
     <Reference Include="System" />
     <Reference Include="System.Core" />
     <Reference Include="System.Drawing" />
diff --git a/Source/ExcelDna.IntelliSense/IntelliSenseProvider.cs b/Source/ExcelDna.IntelliSense/IntelliSenseProvider.cs
@@ -5,6 +5,7 @@
 using System.Linq;
 using System.Threading;
 using ExcelDna.Integration;
+using Microsoft.Office.Interop.Excel;
 
 namespace ExcelDna.IntelliSense
 {
@@ -33,14 +34,15 @@ namespace ExcelDna.IntelliSense
     // TODO: Consider interaction with Application.MacroOptions. (or not?)
 
     // TODO: We might relax the threading rules, to say that Refresh runs on the same thread as Invalidate 
-    // TODO: We might get rid of Refresh (since that runs in the Invalidate context)    
+    // TODO: We might get rid of Refresh (since that runs in the Invalidate context)
+    // TODO: The two providers have been refactored to work very similarly - maybe be can extract out a base class...
     interface IIntelliSenseProvider : IDisposable
     {
         void Initialize();  // Executed in a macro context, on the main Excel thread
         void Refresh();     // Executed in a macro context, on the main Excel thread
         event EventHandler Invalidate;  // Must be raised in a macro context, on the main thread
 
-        IEnumerable<IntelliSenseFunctionInfo> GetFunctionInfos(); // Called from a worker thread - no Excel or COM access (probably an MTA thread involved in the UI Automation)
+        IList<IntelliSenseFunctionInfo> GetFunctionInfos(); // Called from a worker thread - no Excel or COM access (probably an MTA thread involved in the UI Automation)
     }
 
     // Provides IntelliSense info for all Excel-DNA based .xll add-ins, using the built-in RegistrationInfo helper function.
@@ -137,53 +139,14 @@ public IEnumerable<IntelliSenseFunctionInfo> GetFunctionInfos()
         public event EventHandler Invalidate;
 
         public ExcelDnaIntelliSenseProvider()
-        {
-            var threadRefresh = new Thread(RunRefreshWatch);
-            threadRefresh.Start();
-        }
-
-        // DANGER: Still subject to LoaderLock problem...
-        void loaderNotification_LoadNotification(object sender, LoaderNotification.NotificationEventArgs e)
-        {
-            Debug.Print($"@>@>@>@> LoadNotification: {e.Reason} - {e.FullDllName}");
-            if (e.FullDllName.EndsWith(".xll", StringComparison.OrdinalIgnoreCase))
-                _syncContextExcel.Post(ProcessLoadNotification, e);
-        }
-
-        // Runs on the main thread, in a macro context 
-        void ProcessLoadNotification(object state)
-        {
-            Debug.Assert(Thread.CurrentThread.ManagedThreadId == 1);
-            // we might want to introduce a delay here, so that the .xll can complete loading...
-            var notification = (LoaderNotification.NotificationEventArgs)state;;
-            var xllPath = notification.FullDllName;
-            lock (_xllRegistrationInfos)
-            {
-                XllRegistrationInfo regInfo;
-                if (!_xllRegistrationInfos.TryGetValue(xllPath, out regInfo))
-                {
-                    if (notification.Reason == LoaderNotification.Reason.Loaded)
-                    {
-                        regInfo = new XllRegistrationInfo(xllPath);
-                        _xllRegistrationInfos[xllPath] = regInfo;
-                        regInfo.Refresh();
-                        OnInvalidate();
-                    }
-                }
-                else if (notification.Reason == LoaderNotification.Reason.Unloaded)
-                {
-                    _xllRegistrationInfos.Remove(xllPath);
-                }
-            }
-        }
-
-        void RunRefreshWatch()
         {
             _loaderNotification = new LoaderNotification();
             _loaderNotification.LoadNotification += loaderNotification_LoadNotification;
             _syncContextExcel = new ExcelSynchronizationContext();
         }
 
+        #region IIntelliSenseProvider implementation
+
         // Must be called on the main Excel thread
         public void Initialize()
         {
@@ -193,10 +156,9 @@ public void Initialize()
             {
                 foreach (var xllPath in GetLoadedXllPaths())
                 {
-                    XllRegistrationInfo regInfo;
-                    if (!_xllRegistrationInfos.TryGetValue(xllPath, out regInfo))
+                    if (!_xllRegistrationInfos.ContainsKey(xllPath))
                     {
-                        regInfo = new XllRegistrationInfo(xllPath);
+                        XllRegistrationInfo regInfo = new XllRegistrationInfo(xllPath);
                         _xllRegistrationInfos[xllPath] = regInfo;
                         regInfo.Refresh();
                     }
@@ -219,14 +181,53 @@ public void Refresh()
         }
 
         // May be called from any thread
-        public IEnumerable<IntelliSenseFunctionInfo> GetFunctionInfos()
+        public IList<IntelliSenseFunctionInfo> GetFunctionInfos()
         {
             lock (_xllRegistrationInfos)
             {
                 return _xllRegistrationInfos.Values.SelectMany(ri => ri.GetFunctionInfos()).ToList();
             }
         }
 
+        #endregion
+
+        // DANGER: Still subject to LoaderLock problem...
+        // TODO: Consider Load/Unload done when AddIns is enumerated...
+        void loaderNotification_LoadNotification(object sender, LoaderNotification.NotificationEventArgs e)
+        {
+            Debug.Print($"@>@>@>@> LoadNotification: {e.Reason} - {e.FullDllName}");
+            if (e.FullDllName.EndsWith(".xll", StringComparison.OrdinalIgnoreCase))
+                _syncContextExcel.Post(ProcessLoadNotification, e);
+        }
+
+        // Runs on the main thread, in a macro context 
+        void ProcessLoadNotification(object state)
+        {
+            Debug.Assert(Thread.CurrentThread.ManagedThreadId == 1);
+            // we might want to introduce a delay here, so that the .xll can complete loading...
+            var notification = (LoaderNotification.NotificationEventArgs)state;;
+            var xllPath = notification.FullDllName;
+            lock (_xllRegistrationInfos)
+            {
+                XllRegistrationInfo regInfo;
+                if (!_xllRegistrationInfos.TryGetValue(xllPath, out regInfo))
+                {
+                    if (notification.Reason == LoaderNotification.Reason.Loaded)
+                    {
+                        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();
+                    }
+                }
+                else if (notification.Reason == LoaderNotification.Reason.Unloaded)
+                {
+                    _xllRegistrationInfos.Remove(xllPath);
+                    // OnInvalidate();
+                }
+            }
+        }
+
         // Called in macro context
         // Might be implemented by COM AddIns check, or checking loaded Modules with Win32
         // Application.AddIns2 also lists add-ins interactively loaded (Excel 2010+) and has IsOpen property.
@@ -278,7 +279,7 @@ public WorkbookRegistrationInfo(string name)
             {
                 _name = name;
             }
-
+ 
             // Called in a macro context
             public void Refresh()
             {
@@ -349,38 +350,97 @@ public IEnumerable<IntelliSenseFunctionInfo> GetFunctionInfos()
         Dictionary<string, WorkbookRegistrationInfo> _workbookRegistrationInfos = new Dictionary<string, WorkbookRegistrationInfo>();
 
         public event EventHandler Invalidate;
-        
+
+        #region IIntelliSenseProvider implementation
+
+        public WorkbookIntelliSenseProvider()
+        {
+        }
+
         public void Initialize()
         {
             Logger.Provider.Info("WorkbookIntelliSenseProvider.Initialize");
 
+            // The events are just to keep track of the set of open workbooks, 
+            var xlApp = (Application)ExcelDnaUtil.Application;
+            xlApp.WorkbookOpen += Excel_WorkbookOpen;
+            xlApp.WorkbookBeforeClose += Excel_WorkbookBeforeClose;
+            //xlApp.WorkbookAddinInstall += Excel_WorkbookAddinInstall;
+            //xlApp.WorkbookAddinUninstall += Excel_WorkbookAddinUninstall;
+
             //var app = ExcelDnaUtil.Application;
             // app.WorkbookLoaded...
-            foreach (var name in GetLoadedWorkbookNames())
+            lock (_workbookRegistrationInfos)
             {
-                WorkbookRegistrationInfo regInfo;
-                if (!_workbookRegistrationInfos.TryGetValue(name, out regInfo))
+                foreach (var name in GetLoadedWorkbookNames())
                 {
-                    regInfo = new WorkbookRegistrationInfo(name);
-                    _workbookRegistrationInfos[name] = regInfo;
+                    if (!_workbookRegistrationInfos.ContainsKey(name))
+                    {
+                        WorkbookRegistrationInfo regInfo = new WorkbookRegistrationInfo(name);
+                        _workbookRegistrationInfos[name] = regInfo;
+                        regInfo.Refresh();
+                    }
                 }
-                regInfo.Refresh();
             }
         }
 
+        // Runs on the main thread
         public void Refresh()
         {
             Logger.Provider.Info("WorkbookIntelliSenseProvider.Refresh");
+            lock (_workbookRegistrationInfos)
+            {
+                foreach (var regInfo in _workbookRegistrationInfos.Values)
+                {
+                    regInfo.Refresh();
+                }
+            }
         }
 
-        public IEnumerable<IntelliSenseFunctionInfo> GetFunctionInfos()
+        // May be called from any thread
+        public IList<IntelliSenseFunctionInfo> GetFunctionInfos()
         {
-            return _workbookRegistrationInfos.Values.SelectMany(ri => ri.GetFunctionInfos());
+            lock (_workbookRegistrationInfos)
+            {
+                return _workbookRegistrationInfos.Values.SelectMany(ri => ri.GetFunctionInfos()).ToList();
+            }
         }
 
+        #endregion
+
+        void Excel_WorkbookOpen(Workbook Wb)
+        {
+            var regInfo = new WorkbookRegistrationInfo(Wb.Name);
+            lock (_workbookRegistrationInfos)
+            {
+                _workbookRegistrationInfos[Wb.Name] = regInfo;
+                OnInvalidate();
+            }
+        }
+
+        void Excel_WorkbookBeforeClose(Workbook Wb, ref bool Cancel)
+        {
+            // Do we have to worry about renaming / Save As?
+            lock (_workbookRegistrationInfos)
+            {
+                _workbookRegistrationInfos.Remove(Wb.Name);
+            }
+        }
+
+        //private void Excel_WorkbookAddinInstall(Workbook Wb)
+        //{
+        //    throw new NotImplementedException();
+        //}
+
+        //private void Excel_WorkbookAddinUninstall(Workbook Wb)
+        //{
+        //    throw new NotImplementedException();
+        //}
+
         // Called in macro context
         // Might be implemented by tracking Application events
         // Remember this changes when a workbook is saved, and can refer to the wrong workbook as they are closed / opened
+        // CONSIDER: Check AddIns2 ?
         IEnumerable<string> GetLoadedWorkbookNames()
         {
             // TODO: Implement properly...
@@ -391,6 +451,11 @@ IEnumerable<string> GetLoadedWorkbookNames()
             }
         }
 
+        void OnInvalidate()
+        {
+            Invalidate?.Invoke(this, EventArgs.Empty);
+        }
+
         public void Dispose()
         {
         }
diff --git a/Source/ExcelDna.IntelliSense/packages.config b/Source/ExcelDna.IntelliSense/packages.config
@@ -1,6 +1,7 @@
 ﻿<?xml version="1.0" encoding="utf-8"?>
 <packages>
   <package id="ExcelDna.Integration" version="0.33.9" targetFramework="net40" />
+  <package id="ExcelDna.Interop" version="14.0.1" targetFramework="net40" />
   <package id="Excel-DNA.Lib" version="0.33.9" targetFramework="net40" />
   <package id="UIAComWrapper" version="1.1.0.14" targetFramework="net40" />
 </packages>
