Merge branch 'next' of https://github.com/rubberduck-vba/Rubberduck into next

Author: ThunderFrame

.gitignore

@@ -6,6 +6,7 @@
 *.user
 *.sln.docstates
 *.csproj.user
+*.csproj.DotSettings
 
 # External NuGet Packages
 [Pp]ackages/

.nuget/NuGet.exe

@@ -1,10 +1,12 @@
 <img src="http://i.stack.imgur.com/jnBEp.jpg" width=100% />
 
+<!-- campaign is no longer accepting donations
 ### Donate!
 
 If you like this project and would like to thank its contributors, you are welcome to support our GoFundMe campaign to finance Rubberduck swag and international shipping - contributors will be getting t-shirts, mugs, and other cool things.
 
 [![GoFundMe campaign](https://user-images.githubusercontent.com/5751684/29191799-e3d20b72-7dec-11e7-8ec6-0c69da4a3135.png)](https://www.gofundme.com/rubberduckvba)
+-->
 
 Branch     | Description | Build Status |
 |------------|---|--------------|

README.md

@@ -56,7 +56,6 @@ internal Declaration(RubberduckDeclaration declaration)
                 { Parsing.Symbols.DeclarationType.Control, DeclarationType.Control },
                 { Parsing.Symbols.DeclarationType.UserForm, DeclarationType.UserForm },
                 { Parsing.Symbols.DeclarationType.Document, DeclarationType.Document },
-                { Parsing.Symbols.DeclarationType.ModuleOption, DeclarationType.ModuleOption },
                 { Parsing.Symbols.DeclarationType.Procedure, DeclarationType.Procedure },
                 { Parsing.Symbols.DeclarationType.Function, DeclarationType.Function },
                 { Parsing.Symbols.DeclarationType.PropertyGet, DeclarationType.PropertyGet },

RetailCoder.VBE/API/VBA/Declaration.cs

@@ -12,7 +12,6 @@ public enum DeclarationType
         Control, //= 1 << 3,
         UserForm,// = 1 << 4,
         Document,// = 1 << 5,
-        ModuleOption,// = 1 << 6,
         Procedure, //= 1 << 8,
         Function,// = 1 << 9,
         PropertyGet,// = 1 << 11,

RetailCoder.VBE/API/VBA/DeclarationType.cs

@@ -9,38 +9,35 @@ public struct HotkeyInfo
     {
         private const Keys Modifiers = Keys.Alt | Keys.Control | Keys.Shift;
 
-        private readonly IntPtr _hookId;
-        private readonly Keys _keys;
-
         public HotkeyInfo(IntPtr hookId, Keys keys)
         {
-            _hookId = hookId;
-            _keys = keys;
+            HookId = hookId;
+            Keys = keys;
         }
 
-        public IntPtr HookId { get { return _hookId; } }
-        public Keys Keys { get { return _keys; } }
+        public IntPtr HookId { get; }
+        public Keys Keys { get; }
 
         public override string ToString()
         {
             var builder = new StringBuilder();
-            if (_keys.HasFlag(Keys.Alt))
+            if (Keys.HasFlag(Keys.Alt))
             {
                 builder.Append(RubberduckUI.GeneralSettings_HotkeyAlt);
                 builder.Append('+');
             }
-            if (_keys.HasFlag(Keys.Control))
+            if (Keys.HasFlag(Keys.Control))
             {
                 builder.Append(RubberduckUI.GeneralSettings_HotkeyCtrl);
                 builder.Append('+');
             }
-            if (_keys.HasFlag(Keys.Shift))
+            if (Keys.HasFlag(Keys.Shift))
             {
                 builder.Append(RubberduckUI.GeneralSettings_HotkeyShift);
                 builder.Append('+');
             }
 
-            builder.Append(HotkeyDisplayConverter.Convert(_keys & ~Modifiers));
+            builder.Append(HotkeyDisplayConverter.Convert(Keys & ~Modifiers));
             return builder.ToString();
         }
     }

RetailCoder.VBE/Common/Hotkeys/HotkeyInfo.cs

@@ -19,10 +19,10 @@
 using Rubberduck.Settings;
 using Rubberduck.SettingsProvider;
 using Rubberduck.VBEditor.Events;
-using Rubberduck.VBEditor.SafeComWrappers;
 using Rubberduck.VBEditor.SafeComWrappers.Abstract;
 using Rubberduck.VBEditor.WindowsApi;
 using User32 = Rubberduck.Common.WinAPI.User32;
+using Windows = Rubberduck.VBEditor.SafeComWrappers.VBA.Windows;
 
 namespace Rubberduck
 {
@@ -204,56 +204,83 @@ private void InitializeAddIn()
 
         private void Startup()
         {
-            var currentDomain = AppDomain.CurrentDomain;
-            currentDomain.AssemblyResolve += LoadFromSameFolder;
+            try
+            {
+                var currentDomain = AppDomain.CurrentDomain;
+                currentDomain.UnhandledException += HandlAppDomainException;
+                currentDomain.AssemblyResolve += LoadFromSameFolder;
+
+                _kernel = new StandardKernel(new NinjectSettings {LoadExtensions = true}, new FuncModule(), new DynamicProxyModule());
+                _kernel.Load(new RubberduckModule(_ide, _addin));
 
-            _kernel = new StandardKernel(new NinjectSettings {LoadExtensions = true}, new FuncModule(), new DynamicProxyModule());
-            _kernel.Load(new RubberduckModule(_ide, _addin));
+                _app = _kernel.Get<App>();
+                _app.Startup();
 
-            _app = _kernel.Get<App>();
-            _app.Startup();
+                _isInitialized = true;
+
+            }
+            catch (Exception e)
+            {
+                _logger.Log(LogLevel.Fatal, e, "Startup sequence threw an unexpected exception.");
+                //throw; // <<~ uncomment to crash the process
+            }
+        }
 
-            _isInitialized = true;
+        private void HandlAppDomainException(object sender, UnhandledExceptionEventArgs e)
+        {
+            _logger.Log(LogLevel.Fatal, e);
         }
 
         private void ShutdownAddIn()
         {
-            Debug.WriteLine("Extension unhooking VBENativeServices events.");
-            VBENativeServices.UnhookEvents();
-
             var currentDomain = AppDomain.CurrentDomain;
-            currentDomain.AssemblyResolve -= LoadFromSameFolder;
-            Debug.WriteLine("Extension broadcasting shutdown.");
-            User32.EnumChildWindows(_ide.MainWindow.Handle(), EnumCallback, new IntPtr(0));
-
-            Debug.WriteLine("Extension calling ReleaseDockableHosts.");
-            VBEditor.SafeComWrappers.VBA.Windows.ReleaseDockableHosts();
-
-            if (_app != null)
-            {
-                Debug.WriteLine("Extension calling App.Shutdown.");
-                _app.Shutdown();
-                _app = null;
-            }
-
-            if (_kernel != null)
+            try
             {
-                Debug.WriteLine("Extension calling Kernel.Dispose.");
-                _kernel.Dispose();
-                _kernel = null;
-            }
-
-            Debug.WriteLine("Extension: Initiating garbage collection.");
+                _logger.Log(LogLevel.Info, "Rubberduck is shutting down.");
+                _logger.Log(LogLevel.Trace, "Unhooking VBENativeServices events...");
+                VBENativeServices.UnhookEvents();
 
-            GC.Collect();
+                _logger.Log(LogLevel.Trace, "Broadcasting shutdown...");
+                User32.EnumChildWindows(_ide.MainWindow.Handle(), EnumCallback, new IntPtr(0));
 
-            Debug.WriteLine("Extension: Initiated garbage collection.");
+                _logger.Log(LogLevel.Trace, "Releasing dockable hosts...");
+                Windows.ReleaseDockableHosts();
 
-            GC.WaitForPendingFinalizers();
+                if (_app != null)
+                {
+                    _logger.Log(LogLevel.Trace, "Initiating App.Shutdown...");
+                    _app.Shutdown();
+                    _app = null;
+                }
 
-            Debug.WriteLine("Extension: Finalizers have run.");
+                if (_kernel != null)
+                {
+                    _logger.Log(LogLevel.Trace, "Disposing IoC container...");
+                    _kernel.Dispose();
+                    _kernel = null;
+                }
 
-            _isInitialized = false;
+                _isInitialized = false;
+                _logger.Log(LogLevel.Info, "No exceptions were thrown.");
+            }
+            catch (Exception e)
+            {
+                _logger.Error(e);
+                _logger.Log(LogLevel.Warn, "Exception is swallowed.");
+                //throw; // <<~ uncomment to crash the process
+            }
+            finally
+            {
+                _logger.Log(LogLevel.Trace, "Unregistering AppDomain handlers....");
+                currentDomain.AssemblyResolve -= LoadFromSameFolder;
+                currentDomain.UnhandledException -= HandlAppDomainException;
+                _logger.Log(LogLevel.Trace, "Done. Initiating garbage collection...");
+                GC.Collect();
+                _logger.Log(LogLevel.Trace, "Done. Waiting for pending finalizers...");
+                GC.WaitForPendingFinalizers();
+                _logger.Log(LogLevel.Trace, "Done. Shutdown completed. Quack!");
+                _isInitialized = false;
+            }
         }
 
         private static int EnumCallback(IntPtr hwnd, IntPtr lparam)

RetailCoder.VBE/Extension.cs

@@ -51,9 +51,9 @@ public CodeExplorerComponentViewModel(CodeExplorerItemViewModel parent, Declarat
             _name = _declaration.IdentifierName;
 
             var component = declaration.QualifiedName.QualifiedModuleName.Component;
-            if (component.Type == ComponentType.Document)
+            try
             {
-                try
+                if (component.Type == ComponentType.Document)
                 {
                     var parenthesizedName = component.Properties["Name"].Value.ToString();
 
@@ -72,10 +72,10 @@ public CodeExplorerComponentViewModel(CodeExplorerItemViewModel parent, Declarat
                         _name += " (" + parenthesizedName + ")";
                     }
                 }
-                catch
-                {
-                    // gotcha! (this means that the property either doesn't exist or we weren't able to get it for some reason)
-                }
+            }
+            catch
+            {
+                // gotcha! (this means that the property either doesn't exist or we weren't able to get it for some reason)
             }
         }
 

RetailCoder.VBE/Navigation/CodeExplorer/CodeExplorerComponentViewModel.cs

@@ -31,18 +31,21 @@ public class CompareByType : Comparer<CodeExplorerItemViewModel>
     {
         private static readonly Dictionary<DeclarationType, int> SortOrder = new Dictionary<DeclarationType, int>
         {
+            // Some DeclarationTypes we want to treat the same, like Subs and Functions,
+            // or Property Gets, Lets, and Sets.
+            // Give them the same number.
             {DeclarationType.LibraryFunction, 0},
-            {DeclarationType.LibraryProcedure, 1},
-            {DeclarationType.UserDefinedType, 2},
-            {DeclarationType.Enumeration, 3},
-            {DeclarationType.Event, 4},
-            {DeclarationType.Constant, 5},
-            {DeclarationType.Variable, 6},
-            {DeclarationType.PropertyGet, 7},
-            {DeclarationType.PropertyLet, 8},
-            {DeclarationType.PropertySet, 9},
-            {DeclarationType.Function, 10},
-            {DeclarationType.Procedure, 11}
+            {DeclarationType.LibraryProcedure, 0},
+            {DeclarationType.UserDefinedType, 1},
+            {DeclarationType.Enumeration, 2},
+            {DeclarationType.Event, 3},
+            {DeclarationType.Constant, 4},
+            {DeclarationType.Variable, 5},
+            {DeclarationType.PropertyGet, 6},
+            {DeclarationType.PropertyLet, 6},
+            {DeclarationType.PropertySet, 6},
+            {DeclarationType.Function, 7},
+            {DeclarationType.Procedure, 7}
         };
 
         public override int Compare(CodeExplorerItemViewModel x, CodeExplorerItemViewModel y)
@@ -69,17 +72,21 @@ public override int Compare(CodeExplorerItemViewModel x, CodeExplorerItemViewMod
                 if (SortOrder.TryGetValue(xNode.Declaration.DeclarationType, out xValue) &&
                     SortOrder.TryGetValue(yNode.Declaration.DeclarationType, out yValue))
                 {
-                    return xValue < yValue ? -1 : 1;
+                    if (xValue != yValue)
+                    { return xValue < yValue ? -1 : 1; }
                 }
-
-                return xNode.Declaration.DeclarationType < yNode.Declaration.DeclarationType ? -1 : 1;
             }
 
-            if (xNode.Declaration.Accessibility != yNode.Declaration.Accessibility)
+            // The Tree shows Public and Private Subs/Functions with a seperate icon.
+            // But Public and Implicit Subs/Functions appear the same, so treat Implicts like Publics.
+            var xNodeAcc = xNode.Declaration.Accessibility == Accessibility.Implicit ? Accessibility.Public : xNode.Declaration.Accessibility;
+            var yNodeAcc = yNode.Declaration.Accessibility == Accessibility.Implicit ? Accessibility.Public : yNode.Declaration.Accessibility;
+
+            if (xNodeAcc != yNodeAcc)
             {
-                return xNode.Declaration.Accessibility < yNode.Declaration.Accessibility ? -1 : 1;
+                return xNodeAcc > yNodeAcc ? -1 : 1;
             }
-            
+
             if (x.ExpandedIcon != y.ExpandedIcon)
             {
                 // ReSharper disable PossibleInvalidOperationException - this will have a component
@@ -121,12 +128,12 @@ public override int Compare(CodeExplorerItemViewModel x, CodeExplorerItemViewMod
                 return x.QualifiedSelection.HasValue ? -1 : 1;
             }
 
-            if (x.QualifiedSelection.Value.Selection == y.QualifiedSelection.Value.Selection)
+            if (x.QualifiedSelection.Value.Selection.StartLine == y.QualifiedSelection.Value.Selection.StartLine)
             {
                 return 0;
             }
 
-            return x.QualifiedSelection.Value.Selection < y.QualifiedSelection.Value.Selection ? -1 : 1;
+            return x.QualifiedSelection.Value.Selection.StartLine < y.QualifiedSelection.Value.Selection.StartLine ? -1 : 1;
         }
     }
 
@@ -183,6 +190,17 @@ public bool IsExpanded
 
         public bool IsSelected { get; set; }
 
+        private bool _isVisisble = true;
+        public bool IsVisible
+        {
+            get { return _isVisisble; }
+            set
+            {
+                _isVisisble = value;
+                OnPropertyChanged();
+            }
+        }
+
         public abstract string Name { get; }
         public abstract string NameWithSignature { get; }
         public abstract BitmapImage CollapsedIcon { get; }
@@ -221,9 +239,9 @@ public void AddChild(CodeExplorerItemViewModel item)
             _items.Add(item);
         }
 
-        public void ReorderItems(bool sortByName, bool sortByType)
+        public void ReorderItems(bool sortByName, bool groupByType)
         {
-            if (sortByType)
+            if (groupByType)
             {
                 Items = sortByName
                     ? Items.OrderBy(o => o, new CompareByType()).ThenBy(t => t, new CompareByName()).ToList()