Implement IntelliSenseServer.Refresh()

Author: govert

Source/ExcelDna.IntelliSense/IntelliSenseServer.cs

@@ -42,6 +42,7 @@ public static class IntelliSenseServer
 
         const string ControlMessageActivate = "ACTIVATE";
         const string ControlMessageDeactivate = "DEACTIVATE";
+        const string ControlMessageRefresh = "REFRESH";
 
         // Info for registration
         // _serverId is a transient ID to identify this IntelliSense server - we could have used the ExcelDnaUtil.XllGuid one too,
@@ -95,6 +96,25 @@ public static void Register()
             Logger.Initialization.Info("IntelliSenseServer.Register End");
         }
 
+        // Invokes a Refresh on the Active server (if there is on)
+        // Must be called from a macro context
+        // Appropriate for calling after registering extra methods in an add-in
+        public static void Refresh()
+        {
+            Logger.Initialization.Info($"IntelliSenseServer.Refresh Begin");
+            if (_isActive)
+            {
+                RefreshProviders();
+            }
+            else
+            {
+                RegistrationInfo registrationInfo = GetActiveRegistrationInfo();
+                if (registrationInfo != null)
+                    RefreshServer(registrationInfo);
+            }
+            Logger.Initialization.Info($"IntelliSenseServer.Refresh End");
+        }
+
         private static void CurrentDomain_ProcessExit(object sender, EventArgs e)
         {
             Logger.Initialization.Verbose("IntelliSenseServer ProcessExit Begin");
@@ -170,6 +190,22 @@ internal static bool Deactivate()
             }
         }
 
+        // Called directly from Refresh or via the control function
+        internal static void RefreshProviders()
+        {
+            Logger.Initialization.Info($"IntelliSenseServer.RefreshProviders");
+            try
+            {
+                Debug.Assert(_helper != null);
+                _helper.RefreshProviders();
+            }
+            catch (Exception ex)
+            {
+                // TODO: Log
+                Logger.Initialization.Error($"IntelliSenseServer.RefreshProviders error: {ex}");
+            }
+        }
+
         // NOTE: Please do not remove this safety mechanism in custom versions.
         //       The IntelliSense mechanism is co-operative between independent add-ins.
         //       Allowing a safe disable options is important to support future versions, and protect against problematic bugs.
@@ -200,7 +236,7 @@ static bool ActivateServer(RegistrationInfo registrationInfo)
             // Suppress errors if things go wrong, including unexpected return types.
             try
             {
-                var result = ExcelDna.Integration.XlCall.Excel(ExcelDna.Integration.XlCall.xlUDF, registrationInfo.GetControlMacroName(), ControlMessageDeactivate);
+                var result = ExcelDna.Integration.XlCall.Excel(ExcelDna.Integration.XlCall.xlUDF, registrationInfo.GetControlMacroName(), ControlMessageActivate);
                 return (bool)result;
             }
             catch (Exception ex)
@@ -232,6 +268,26 @@ static bool DeactivateServer(RegistrationInfo registrationInfo)
             }
         }
 
+        static bool RefreshServer(RegistrationInfo registrationInfo)
+        {
+            // Suppress errors if things go wrong, including unexpected return types.
+            try
+            {
+                var result = ExcelDna.Integration.XlCall.Excel(ExcelDna.Integration.XlCall.xlUDF, registrationInfo.GetControlMacroName(), ControlMessageRefresh);
+                if (result is ExcelError)
+                {
+                    Logger.Initialization.Error($"IntelliSenseServer {registrationInfo.ToRegistrationString()} could not be deactivated.");
+                    return false;
+                }
+                return (bool)result;
+            }
+            catch (Exception ex)
+            {
+                Logger.Initialization.Error(ex, $"IntelliSenseServer Deactivate call for {registrationInfo.ToRegistrationString()} failed.");
+                return false;
+            }
+        }
+
         #region Registration
 
         // NOTE: We have to be really careful about compatibility across versions here...
@@ -434,15 +490,28 @@ static void RegisterControlMacro()
         // NOTE: The name here is used by Reflection above (when registering the method with Excel)
         static object IntelliSenseServerControl(object control)
         {
-            if (control is string && (string)control == ControlMessageActivate)
+            string controlMessage = control as string;
+            if (controlMessage == ControlMessageActivate)
             {
                 Debug.Print("IntelliSenseServer.Activate in AppDomain: " + AppDomain.CurrentDomain.FriendlyName);
-                return IntelliSenseServer.Activate();
+                return Activate();
             }
-            else if (control is string && (string)control == ControlMessageDeactivate)
+            else if (controlMessage == ControlMessageDeactivate)
             {
                 Debug.Print("IntelliSenseServer.Deactivate in AppDomain: " + AppDomain.CurrentDomain.FriendlyName);
-                return IntelliSenseServer.Deactivate();
+                return Deactivate();
+            }
+            else if (controlMessage == ControlMessageRefresh)
+            {
+                Debug.Print("IntelliSenseServer.Refresh in AppDomain: " + AppDomain.CurrentDomain.FriendlyName);
+                if (!_isActive)
+                {
+                    // Something went wrong...
+                    Logger.Initialization.Error("IntelliSenseServer Refresh call on inactive server.");
+                    return false;
+                }
+                RefreshProviders();
+                return true;
             }
             return false;
         }

Source/ExcelDna.IntelliSense/IntellisenseHelper.cs

@@ -68,6 +68,16 @@ void UpdateDisplay(IIntelliSenseProvider provider)
             _display.UpdateFunctionInfos(functionInfos);
         }
 
+        // Must be called on the main thread, in a macro context
+        // TODO: Still not sure how to delete / unregister...
+        internal void RefreshProviders()
+        {
+            foreach (var provider in _providers)
+            {
+                RefreshProvider(provider);
+            }
+        }
+
         public void Dispose()
         {
             Logger.Initialization.Verbose("IntelliSenseHelper Dispose Start");

Source/ExcelDna.IntelliSense/Providers/ExcelDnaIntelliSenseProvider.cs

@@ -34,7 +34,7 @@ public void Refresh()
                 if (regInfoResponse.Equals(ExcelError.ExcelErrorNA))
                 {
                     _regInfoNotAvailable = true;
-                    Logger.Provider.Verbose($"XllRegistrationInfo not available for {_xllPath}");
+                    Logger.Provider.Info($"XllRegistrationInfo not available for {_xllPath}");
                     return;
                 }
 
@@ -175,7 +175,7 @@ public IList<FunctionInfo> GetFunctionInfos()
 
         #endregion
 
-        // DANGER: Still subject to LoaderLock problem...
+        // DANGER: Still subject to LoaderLock warning ...
         // TODO: Consider Load/Unload done when AddIns is enumerated...
         void loaderNotification_LoadNotification(object sender, LoaderNotification.NotificationEventArgs e)
         {
@@ -185,6 +185,9 @@ void loaderNotification_LoadNotification(object sender, LoaderNotification.Notif
         }
 
         // Runs on the main thread, in a macro context 
+        // WARNING: The sequence of calls here, between queued 
+        //          instances of ProcessLoadNotification, Refresh and OnInvalidate
+        //          is quite fragile.
         void ProcessLoadNotification(object state)
         {
             Debug.Assert(Thread.CurrentThread.ManagedThreadId == 1);