feat: Filters: IsEmpty is now tri-state so you can make filter rules for empty and non-empty code items

Author: sboulema

docs/filterrules.md

@@ -15,7 +15,10 @@ Secondly select a number of modifiers to narrow down the rule.
 Match code items by access (public, private, etc...)
 
 ### Empty
-Match code items that do not have visible child items
+Match code items that:
+- Checked: do not have visible child items
+- Unchecked: do have visible child items
+- Indeterminate: either do or do not have visible child items
 
 ## Action
 Finally select then action to should be applied to the code item.

docs/links.md

@@ -23,4 +23,5 @@ Here is a list of links to helpful pages I needed when developing this extension
 - [Setting WPF border visible or not depending on ScrollViewer's VerticalScrollBarVisibility property](https://stackoverflow.com/questions/73199311/setting-wpf-border-visible-or-not-depending-on-scrollviewers-verticalscrollbarv/73199480#73199480)
 - [CommentRemover Sample](https://github.com/microsoft/VSExtensibility/tree/main/New_Extensibility_Model/Samples/CommentRemover)
 - [CompositeExtension Sample](https://github.com/microsoft/VSExtensibility/tree/main/New_Extensibility_Model/Samples/CompositeExtension)
-- [VSExtensibility - #554 - Feature request: Text Editor: Scroll to line](https://github.com/microsoft/VSExtensibility/issues/554)
+- [VSExtensibility - #554 - Feature request: Text Editor: Scroll to line](https://github.com/microsoft/VSExtensibility/issues/554)
+- [The CheckBox control](https://wpf-tutorial.com/basic-controls/the-checkbox-control/)

src/CodeNav.OutOfProc/Dialogs/FilterDialog/FilterDialogControl.xaml

@@ -74,7 +74,10 @@
                                     BorderThickness="0,0,1,0"
                                     Margin="-6,-3,-6,-3">
                                     <StackPanel Margin="6,2,6,2" VerticalAlignment="Center">
-                                        <CheckBox IsChecked="{Binding IsEmpty}" IsEnabled="{Binding IsEmptyEnabled}" />
+                                        <CheckBox
+                                            IsThreeState="True"
+                                            IsChecked="{Binding IsEmpty}"
+                                            IsEnabled="{Binding IsEmptyEnabled}" />
                                     </StackPanel>
                                 </Border>
                             </DataTemplate>
@@ -146,7 +149,10 @@
                     <LineBreak/>
                     <Run FontWeight="Bold">Access:</Run> Match code items with access modifier
                     <LineBreak/>
-                    <Run FontWeight="Bold">Empty:</Run> Match code items that do not have visible child items
+                    <Run FontWeight="Bold">Empty:</Run> Match code items that:
+                    <LineBreak/>Checked: do not have visible child items
+                    <LineBreak/>Unchecked: do have visible child items
+                    <LineBreak/>Indeterminate: either do or do not have visible child items
                 </TextBlock>
                 <TextBlock>
                     <Run FontWeight="Bold">Actions</Run>

src/CodeNav.OutOfProc/Helpers/FilterRuleHelper.cs

@@ -7,15 +7,22 @@ namespace CodeNav.OutOfProc.Helpers;
 
 public static class FilterRuleHelper
 {
-    public static FilterRuleViewModel? GetFilterRule(IEnumerable<FilterRuleViewModel> filterRules, CodeItem item)
+    /// <summary>
+    /// Get the last matching filter rule for a given code item
+    /// </summary>
+    /// <param name="filterRules">List of filter rules</param>
+    /// <param name="codeItem">Code item</param>
+    /// <returns>Matching filter rule</returns>
+    public static FilterRuleViewModel? GetFilterRule(IEnumerable<FilterRuleViewModel> filterRules, CodeItem codeItem)
     {
         // Get the most specific filter rule for the item
         var filterRule = filterRules
-            .Where(filterRule => filterRule.Access == item.Access ||
+            .Where(filterRule => filterRule.Access == codeItem.Access ||
                                  filterRule.Access == CodeItemAccessEnum.All)
-            .Where(filterRule => filterRule.Kind == item.Kind ||
+            .Where(filterRule => filterRule.Kind == codeItem.Kind ||
                                  filterRule.Kind == CodeItemKindEnum.All)
-            .Where(filterRule => filterRule.IsEmpty == IsEmpty(item))
+            .Where(filterRule => filterRule.IsEmpty == null ||
+                                 filterRule.IsEmpty == IsEmpty(codeItem))
             .LastOrDefault();
 
         return filterRule;

src/CodeNav.OutOfProc/Helpers/SettingsHelper.cs

@@ -112,7 +112,7 @@ public class FilterRule
 
     public CodeItemAccessEnum Access { get; set; }
 
-    public bool IsEmpty { get; set; }
+    public bool? IsEmpty { get; set; } = false;
 
     public bool Hide { get; set; }
 

src/CodeNav.OutOfProc/ViewModels/FilterRuleViewModel.cs

@@ -36,7 +36,7 @@ public CodeItemAccessEnum Access
     }
 
     [DataMember]
-    public bool IsEmpty { get; set; }
+    public bool? IsEmpty { get; set; } = false;
 
     private bool _hide;
 

test/HelperTests/VisibilityHelperTests.cs

@@ -1,6 +1,4 @@
 using System.Windows;
-using CodeNav.OutOfProc.Constants;
-using CodeNav.OutOfProc.ViewModels;
 
 namespace CodeNav.Test.HelperTests;