Refactor providers so that xml file overrides dna attributes

Author: govert

Source/ExcelDna.IntelliSense/IntelliSenseDisplay.cs

@@ -516,7 +516,7 @@ public void RegisterFunctionInfo(FunctionInfo functionInfo)
             }
             else
             {
-                // Update  against the function name
+                // Update against the function name
                 _functionInfoMap[functionInfo.Name] = functionInfo;
             }
         }

Source/ExcelDna.IntelliSense/IntellisenseHelper.cs

@@ -23,12 +23,10 @@ public IntelliSenseHelper()
             _uiMonitor = new UIMonitor(_syncContextMain);
             _display = new IntelliSenseDisplay(_syncContextMain, _uiMonitor);
 
-            var xmlProvider = new XmlIntelliSenseProvider();
             _providers = new List<IIntelliSenseProvider>
             {
-                new ExcelDnaIntelliSenseProvider(xmlProvider),
-                new WorkbookIntelliSenseProvider(xmlProvider),
-                xmlProvider
+                new ExcelDnaIntelliSenseProvider(),
+                new WorkbookIntelliSenseProvider(),
             };
 
             RegisterIntellisense();

Source/ExcelDna.IntelliSense/Providers/ExcelDnaIntelliSenseProvider.cs

@@ -108,12 +108,12 @@ public IEnumerable<FunctionInfo> GetFunctionInfos()
         bool _isDirty;
         public event EventHandler Invalidate;
 
-        public ExcelDnaIntelliSenseProvider(XmlIntelliSenseProvider xmlProvider)
+        public ExcelDnaIntelliSenseProvider()
         {
-            _xmlProvider = xmlProvider;
             _loaderNotification = new LoaderNotification();
             _loaderNotification.LoadNotification += loaderNotification_LoadNotification;
             _syncContextExcel = new ExcelSynchronizationContext();
+            _xmlProvider = new XmlIntelliSenseProvider();
         }
 
         #region IIntelliSenseProvider implementation
@@ -123,6 +123,9 @@ public void Initialize()
         {
             Debug.Assert(Thread.CurrentThread.ManagedThreadId == 1);
             Logger.Provider.Info("ExcelDnaIntelliSenseProvider.Initialize");
+
+            _xmlProvider.Initialize();
+
             lock (_xllRegistrationInfos)
             {
                 foreach (var xllPath in GetLoadedXllPaths())
@@ -133,7 +136,7 @@ public void Initialize()
                         XllRegistrationInfo regInfo = new XllRegistrationInfo(xllPath);
                         _xllRegistrationInfos[xllPath] = regInfo;
 
-                       _xmlProvider.RegisterXmlFunctionInfo(GetXmlPath(xllPath));
+                        _xmlProvider.RegisterXmlFunctionInfo(GetXmlPath(xllPath));
 
                         regInfo.Refresh();
                     }
@@ -152,25 +155,30 @@ public void Refresh()
                 {
                     regInfo.Refresh();
                 }
+                _xmlProvider.Refresh();
                 _isDirty = false;
             }
         }
 
         // May be called from any thread
         public IList<FunctionInfo> GetFunctionInfos()
         {
-            IList<FunctionInfo> functionInfos;
+            IList<FunctionInfo> excelDnaInfos;
             lock (_xllRegistrationInfos)
             {
-                functionInfos = _xllRegistrationInfos.Values.SelectMany(ri => ri.GetFunctionInfos()).ToList();
+                excelDnaInfos = _xllRegistrationInfos.Values.SelectMany(ri => ri.GetFunctionInfos()).ToList();
             }
             Logger.Provider.Verbose("ExcelDnaIntelliSenseProvider.GetFunctionInfos Begin");
-            foreach (var info in functionInfos)
+            foreach (var info in excelDnaInfos)
             {
                 Logger.Provider.Verbose($"\t{info.Name}({info.ArgumentList.Count}) - {info.Description} ");
             }
+
+            var xmlInfos = _xmlProvider.GetFunctionInfos();
+            var allInfos = excelDnaInfos.Concat(xmlInfos).ToList();
+
             Logger.Provider.Verbose("ExcelDnaIntelliSenseProvider.GetFunctionInfos End");
-            return functionInfos;
+            return allInfos;
         }
 
         #endregion
@@ -215,14 +223,15 @@ void ProcessLoadNotification(object state)
                             _isDirty = true;
                             _syncContextExcel.Post(OnInvalidate, null);
                         }
+
                     }
                 }
                 else if (notification.Reason == LoaderNotification.Reason.Unloaded)
                 {
                     _xllRegistrationInfos.Remove(xllPath);
                     _xmlProvider.UnregisterXmlFunctionInfo(GetXmlPath(xllPath));
 
-                    // Not too worried about cleaning up
+                    // Not too eager when cleaning up
                     // OnInvalidate();
                 }
             }

Source/ExcelDna.IntelliSense/Providers/WorkbookIntelliSenseProvider.cs

@@ -115,14 +115,15 @@ public IEnumerable<FunctionInfo> GetFunctionInfos()
 
         #region IIntelliSenseProvider implementation
 
-        public WorkbookIntelliSenseProvider(XmlIntelliSenseProvider xmlProvider)
+        public WorkbookIntelliSenseProvider()
         {
-            _xmlProvider = xmlProvider;
+            _xmlProvider = new XmlIntelliSenseProvider();
         }
 
         public void Initialize()
         {
             Logger.Provider.Info("WorkbookIntelliSenseProvider.Initialize");
+            _xmlProvider.Initialize();
 
             // The events are just to keep track of the set of open workbooks, 
             var xlApp = (Application)ExcelDnaUtil.Application;
@@ -143,9 +144,9 @@ public void Initialize()
                         WorkbookRegistrationInfo regInfo = new WorkbookRegistrationInfo(name);
                         _workbookRegistrationInfos[name] = regInfo;
 
-                        RegisterWithXmlProvider(wb);
-
                         regInfo.Refresh();
+
+                        RegisterWithXmlProvider(wb);
                     }
                 }
             }
@@ -161,6 +162,7 @@ public void Refresh()
                 {
                     regInfo.Refresh();
                 }
+                _xmlProvider.Refresh();
             }
         }
 
@@ -169,7 +171,9 @@ public IList<FunctionInfo> GetFunctionInfos()
         {
             lock (_workbookRegistrationInfos)
             {
-                return _workbookRegistrationInfos.Values.SelectMany(ri => ri.GetFunctionInfos()).ToList();
+                var workbookInfos = _workbookRegistrationInfos.Values.SelectMany(ri => ri.GetFunctionInfos()).ToList();
+                var xmlInfos = _xmlProvider.GetFunctionInfos();
+                return workbookInfos.Concat(xmlInfos).ToList();
             }
         }
 
@@ -216,8 +220,8 @@ void UnregisterWithXmlProvider(Workbook wb)
         {
             var path = wb.FullName;
             var xmlPath = GetXmlPath(path);
-            _xmlProvider.UnregisterXmlFunctionInfo(xmlPath);
             _xmlProvider.UnregisterXmlFunctionInfo(path);
+            _xmlProvider.UnregisterXmlFunctionInfo(xmlPath);
         }
 
         //private void Excel_WorkbookAddinInstall(Workbook Wb)

Source/ExcelDna.IntelliSense/Providers/XmlIntelliSenseProvider.cs

@@ -10,6 +10,8 @@
 namespace ExcelDna.IntelliSense
 {
     // CONSIDER: Support regular .NET XML documentation, either as files or packed?
+    // NOTE: There will be multiple instances of the XmlIntelliSenseProvider instantiated,
+    //       by the ExcelDna- and Workbook-providers
     class XmlIntelliSenseProvider : IIntelliSenseProvider
     {
         public class XmlRegistrationInfo