Simplify grouping and sorting, only reparse on UI thread - closes #4637

Author: comintern

Rubberduck.Core/UI/Inspections/InspectionResultComparer.cs

@@ -0,0 +1,104 @@
+using Rubberduck.Parsing.Inspections.Abstract;
+using System.Collections.Generic;
+
+namespace Rubberduck.UI.Inspections
+{
+    public static class InspectionResultComparer
+    {
+        public static Comparer<IInspectionResult> InspectionType { get; } = new CompareByInspectionType();
+
+        public static Comparer<IInspectionResult> Name { get; } = new CompareByInspectionName();
+
+        public static Comparer<IInspectionResult> Location { get; } = new CompareByLocation();
+
+        public static Comparer<IInspectionResult> Severity { get; } = new CompareBySeverity();
+    }
+
+    public class CompareByInspectionType : Comparer<IInspectionResult>
+    {
+        public override int Compare(IInspectionResult x, IInspectionResult y)
+        {
+            if (x == y)
+            {
+                return 0;
+            }
+
+            if (x?.Inspection?.InspectionType is null)
+            {
+                return -1;
+            }
+
+            return x.Inspection.InspectionType.CompareTo(y?.Inspection?.InspectionType);
+        }
+    }
+
+    public class CompareByInspectionName : Comparer<IInspectionResult>
+    {
+        public override int Compare(IInspectionResult x, IInspectionResult y)
+        {
+            if (x == y)
+            {
+                return 0;
+            }
+
+            if (x?.Inspection?.Name is null)
+            {
+                return -1;
+            }
+
+            return x.Inspection.Name.CompareTo(y?.Inspection?.Name);
+        }
+    }
+
+    public class CompareByLocation : Comparer<IInspectionResult>
+    {
+        public override int Compare(IInspectionResult x, IInspectionResult y)
+        {
+            if (x == y)
+            {
+                return 0;
+            }
+
+            var first = x?.QualifiedSelection.QualifiedName;
+
+            if (first is null)
+            {
+                return -1;
+            }
+
+            var second = y?.QualifiedSelection.QualifiedName;
+
+            if (second is null)
+            {
+                return 1;
+            }
+
+            var nameComparison = first.Value.Name.CompareTo(second.Value.Name);
+            if (nameComparison != 0)
+            {
+                return nameComparison;
+            }
+
+            return x.QualifiedSelection.CompareTo(y.QualifiedSelection);
+        }
+    }
+
+    public class CompareBySeverity : Comparer<IInspectionResult>
+    {
+        public override int Compare(IInspectionResult x, IInspectionResult y)
+        {
+            if (x == y)
+            {
+                return 0;
+            }
+
+            if (y?.Inspection is null)
+            {
+                return 1;
+            }
+
+            // The CodeInspectionSeverity enum is ordered least severe to most. We want the opposite. 
+            return y.Inspection.Severity.CompareTo(x?.Inspection?.Severity);
+        }
+    }
+}

Rubberduck.Core/UI/Inspections/InspectionResultGroupingToBooleanConverter.cs

@@ -0,0 +1,39 @@
+using System;
+using System.Globalization;
+using System.Windows.Data;
+
+namespace Rubberduck.UI.Inspections
+{
+    /// <summary>
+    /// Provides a mutally exclusive binding between an InspectionResultGrouping and a boolean. 
+    /// Note: This is a stateful converter, so each bound control requires its own converter instance.
+    /// </summary>
+    public class InspectionResultGroupingToBooleanConverter : IValueConverter
+    {
+        private InspectionResultGrouping _state;
+
+        public object Convert(object value, Type targetType, object parameter, CultureInfo culture)
+        {
+            if (!(parameter is InspectionResultGrouping governing) ||
+                !(value is InspectionResultGrouping bound))
+            {
+                return false;
+            }
+
+            _state = bound;
+            return _state == governing;
+        }
+
+        public object ConvertBack(object value, Type targetType, object parameter, CultureInfo culture)
+        {
+            if (!(parameter is InspectionResultGrouping governing) ||
+                !(value is bool isSet))
+            {
+                return _state;
+            }
+
+            _state = isSet ? governing : _state;
+            return _state;
+        }
+    }
+}

Rubberduck.Core/UI/Inspections/InspectionResultsControl.xaml

@@ -70,6 +70,10 @@
                     <codeInspections:InspectionFilterToBooleanConverter x:Key="WarningFlagConverter" />
                     <codeInspections:InspectionFilterToBooleanConverter x:Key="SuggestionFlagConverter" />
                     <codeInspections:InspectionFilterToBooleanConverter x:Key="HintFlagConverter" />
+                    <codeInspections:InspectionResultGroupingToBooleanConverter x:Key="GroupByTypeConverter" />
+                    <codeInspections:InspectionResultGroupingToBooleanConverter x:Key="GroupByNameConverter" />
+                    <codeInspections:InspectionResultGroupingToBooleanConverter x:Key="GroupByLocationConverter" />
+                    <codeInspections:InspectionResultGroupingToBooleanConverter x:Key="GroupBySeverityConverter" />
                     <Style x:Key="ToolBarToggleStyle" TargetType="ToggleButton">
                         <Setter Property="Margin" Value="2" />
                         <Setter Property="BorderBrush" Value="{x:Static SystemColors.ActiveBorderBrush}" />
@@ -105,25 +109,25 @@
 
                 <ToggleButton Style="{StaticResource ToolBarToggleStyle}"
                               ToolTip="{Resx ResxName=Rubberduck.Resources.RubberduckUI, Key=GroupingStyle_ByInspectionType}"
-                              IsChecked="{Binding GroupByInspectionType, Mode=TwoWay}">
+                              IsChecked="{Binding Path=Grouping, Converter={StaticResource GroupByTypeConverter}, ConverterParameter={x:Static codeInspections:InspectionResultGrouping.Type}}">
                     <Image Source="{StaticResource GroupByInspectionTypeImage}" />
                 </ToggleButton>
 
                 <ToggleButton Style="{StaticResource ToolBarToggleStyle}"
                               ToolTip="{Resx ResxName=Rubberduck.Resources.RubberduckUI, Key=GroupingStyle_ByName}"
-                              IsChecked="{Binding GroupByName, Mode=TwoWay}">
+                              IsChecked="{Binding Path=Grouping, Converter={StaticResource GroupByNameConverter}, ConverterParameter={x:Static codeInspections:InspectionResultGrouping.Name}}">
                     <Image Source="{StaticResource GroupByInspectionImage}" />
                 </ToggleButton>
 
                 <ToggleButton Style="{StaticResource ToolBarToggleStyle}"
                               ToolTip="{Resx ResxName=Rubberduck.Resources.RubberduckUI, Key=GroupingStyle_ByLocation}"
-                              IsChecked="{Binding GroupByLocation, Mode=TwoWay}">
+                              IsChecked="{Binding Path=Grouping, Converter={StaticResource GroupByLocationConverter}, ConverterParameter={x:Static codeInspections:InspectionResultGrouping.Location}}">
                     <Image Source="{StaticResource GroupByLocationImage}" />
                 </ToggleButton>
 
                 <ToggleButton Style="{StaticResource ToolBarToggleStyle}"
                               ToolTip="{Resx ResxName=Rubberduck.Resources.RubberduckUI, Key=GroupingStyle_BySeverity}"
-                              IsChecked="{Binding GroupBySeverity, Mode=TwoWay}" >
+                              IsChecked="{Binding Path=Grouping, Converter={StaticResource GroupBySeverityConverter}, ConverterParameter={x:Static codeInspections:InspectionResultGrouping.Severity}}">
                     <Image Source="{StaticResource GroupBySeverityImage}" />
                 </ToggleButton>
 
@@ -191,7 +195,8 @@
             </DataGrid.Columns>
         </controls:GroupingGrid>
 
-        <controls:EmptyUIRefresh Grid.Row="1" Visibility="{Binding EmptyUIRefreshVisibility}"/>
+        <controls:EmptyUIRefresh Grid.Row="1" Visibility="{Binding Unparsed, Converter={StaticResource BoolToVisibility}}" />
+
 
         <controls:BusyIndicator Grid.Row="1" Width="120" Height="120" Visibility="{Binding IsBusy, Converter={StaticResource BoolToVisibility}}" />