Merge pull request #3635 from MDoerner/ShutdownIssueNextRound

More COM release on shutdown

Author: retailcoder

RetailCoder.VBE/AppMenu.cs

@@ -1,6 +1,8 @@
 using System;
 using System.Collections.Generic;
 using System.Linq;
+using System.Threading;
+using NLog;
 using Rubberduck.Parsing;
 using Rubberduck.Parsing.VBA;
 using Rubberduck.UI;
@@ -17,6 +19,8 @@ public class AppMenu : IAppMenu, IDisposable
         private readonly ISelectionChangeService _selectionService;
         private readonly RubberduckCommandBar _stateBar;
 
+        private static readonly Logger _logger = LogManager.GetCurrentClassLogger();
+
         public AppMenu(IEnumerable<IParentMenuItem> menus, IParseCoordinator parser, ISelectionChangeService selectionService, RubberduckCommandBar stateBar)
         {
             _menus = menus.ToList();
@@ -77,7 +81,14 @@ private void RemoveMenus()
         {
             foreach (var menu in _menus.Where(menu => menu.Item != null))
             {
+                _logger.Debug($"Starting removal of top-level menu {menu.GetType()}.");
                 menu.RemoveMenu();
+                //We do this here and not in the menu items because we only want to dispose of/release the parents of the top level parent menus.
+                //The parents further down get disposed of/released as part of the remove chain.
+                _logger.Trace($"Removing parent menu of top-level menu {menu.GetType()}.");
+                menu.Parent.Dispose();
+                menu.Parent.Release(true);  //todo: Find a way around this!!!
+                menu.Parent = null;
             }
         }
     }

RetailCoder.VBE/Extension.cs

@@ -265,6 +265,20 @@ private void ShutdownAddIn()
                     _container = null;
                 }
 
+                if (_addin != null)
+                {
+                    _logger.Log(LogLevel.Trace, "Disposing AddIn wrapper...");
+                    _addin.Dispose();
+                    _addin = null;
+                }
+
+                if (_ide != null)
+                {
+                    _logger.Log(LogLevel.Trace, "Disposing VBE wrapper...");
+                    _ide.Dispose();
+                    _ide = null;
+                }
+
                 _isInitialized = false;
                 _logger.Log(LogLevel.Info, "No exceptions were thrown.");
             }

RetailCoder.VBE/UI/Command/MenuItems/CommandBars/AppCommandBarBase.cs

@@ -170,12 +170,16 @@ public void RemoveCommandBar()
         {
             try
             {
-                Logger.Debug("Removing commandbar.");
-                RemoveChildren();
-                Item?.Delete();
-                Item?.Release();
-                Item = null;
-                Parent = null;
+                if (Item != null)
+                {
+                    Logger.Debug("Removing commandbar.");
+                    RemoveChildren();
+                    Item.Delete();
+                    Item.Dispose();
+                    Item = null;
+                    Parent?.Dispose();
+                    Parent = null;
+                }
             }
             catch (COMException exception)
             {
@@ -199,7 +203,7 @@ private void RemoveChildren()
                         button.Click -= child_Click;
                     }
                     button.Delete();
-                    button.Release();
+                    button.Dispose();
                 }
             }
             catch (COMException exception)

RetailCoder.VBE/UI/Command/MenuItems/ParentMenus/ParentMenuItemBase.cs

@@ -92,7 +92,7 @@ public void RemoveMenu()
             Logger.Debug($"Removing menu {_key}.");
             RemoveChildren();
             Item?.Delete();
-            Item?.Release();
+            Item?.Dispose();
             Item = null;
         }
 
@@ -106,7 +106,7 @@ private void RemoveChildren()
             {
                 child.Click -= child_Click;
                 child.Delete();
-                child.Release();
+                child.Dispose();
             }
         }
 

RetailCoder.VBE/UI/DockableToolwindowPresenter.cs

@@ -20,7 +20,7 @@ public interface IDockablePresenter : IPresenter
         UserControl UserControl { get; }
     }
 
-    public abstract class DockableToolwindowPresenter : IDockablePresenter
+    public abstract class DockableToolwindowPresenter : IDockablePresenter, IDisposable
     {
         private readonly IAddIn _addin;
         private static readonly Logger Logger = LogManager.GetCurrentClassLogger();
@@ -100,6 +100,23 @@ private void EnsureMinimumWindowSize(IWindow window)
         public virtual void Show() => _window.IsVisible = true;
         public virtual void Hide() => _window.IsVisible = false;
 
+
+        private bool _isDisposed;
+        public void Dispose()
+        {
+            if (_isDisposed)
+            {
+                return;
+            }
+
+            Logger.Trace($"Disposing DockableWindowPresenter of type {this.GetType()}.");
+
+            _window.Dispose();
+
+            _isDisposed = true;
+        }
+
+
         ~DockableToolwindowPresenter()
         {
             // destructor for tracking purposes only - do not suppress unless 

Rubberduck.VBEEditor/SafeComWrappers/Abstract/ISafeComWrapper.cs

@@ -1,6 +1,8 @@
+using System;
+
 namespace Rubberduck.VBEditor.SafeComWrappers.Abstract
 {
-    public interface ISafeComWrapper : INullObjectWrapper
+    public interface ISafeComWrapper : INullObjectWrapper, IDisposable
     {
         void Release(bool final = false);
         bool HasBeenReleased { get; }

Rubberduck.VBEEditor/SafeComWrappers/SafeComWrapper.cs

@@ -1,3 +1,4 @@
+using System;
 using System.Runtime.InteropServices;
 using Rubberduck.VBEditor.SafeComWrappers.Abstract;
 using NLog;
@@ -15,7 +16,7 @@ protected SafeComWrapper(T target)
         }
 
         private int? _rcwReferenceCount;
-        public virtual void Release(bool final = false)
+        public void Release(bool final = false)
         {
             if (HasBeenReleased)
             {
@@ -103,5 +104,28 @@ public override bool Equals(object obj)
         {
             return !(a == b);
         }
-   }
+
+
+        public void Dispose()
+        {
+            Dispose(true);
+            GC.SuppressFinalize(this);
+        }
+
+        private bool _isDisposed;
+        protected virtual void Dispose(bool disposing)
+        {
+            if (_isDisposed)
+            {
+                return;
+            }
+
+            if (disposing && !HasBeenReleased)
+            {
+                Release();
+            }
+
+            _isDisposed = true;
+        }
+    }
 }