Moved tools under categories, changed the title showed in Search box and more...

src/dev/impl/DevToys/Api/Tools/IToolProvider.cs

@@ -1,18 +1,34 @@
 #nullable enable
 
-using System.ComponentModel;
+using DevToys.Core.Threading;
+using Windows.UI.Xaml.Controls;
 
 namespace DevToys.Api.Tools
 {
     /// <summary>
     /// Provides information about a tool and create an instance of it.
     /// </summary>
-    public interface IToolProvider : INotifyPropertyChanged
+    public interface IToolProvider
     {
         /// <summary>
-        /// Gets the name of the tool. It will be displayed in the list of tools.
+        /// Gets the name of the tool that will be displayed in the main menu of the app.
         /// </summary>
-        string DisplayName { get; }
+        string MenuDisplayName { get; }
+
+        /// <summary>
+        /// Gets the name of the tool that will be displayed in the search bar. Sometimes
+        /// it is needed to have a different one than the name showed in the menu to increase
+        /// result accuracy. For example, while <see cref="MenuDisplayName"/> could be "JSON"
+        /// for a tool that is under the Formatter category, <see cref="SearchDisplayName"/>
+        /// could be "JSON Formatter", which can be helpful to differentiate from other similar
+        /// tools like "JSON Converter".
+        /// </summary>
+        string? SearchDisplayName { get; }
+
+        /// <summary>
+        /// Gets the description of the tool that will be displayed in the tool grid view.
+        /// </summary>
+        string? Description { get; }
 
         /// <summary>
         /// Gets the name of the tool that will be told to the user when using screen reader.
@@ -22,7 +38,7 @@ public interface IToolProvider : INotifyPropertyChanged
         /// <summary>
         /// Gets an object type that has a width, height and image data. It can be an icon through a font, an SVG...etc.
         /// </summary>
-        object IconSource { get; }
+        TaskCompletionNotifier<IconElement> IconSource { get; }
 
         /// <summary>
         /// Creates a new instance of the tool.

src/dev/impl/DevToys/Api/Tools/IToolProviderFactory.cs

@@ -32,6 +32,11 @@ public interface IToolProviderFactory
         /// </summary>
         IEnumerable<MatchedToolProvider> GetAllTools();
 
+        /// <summary>
+        /// Gets a flat list of all the children and sub-children of a given tool provider.
+        /// </summary>
+        IEnumerable<IToolProvider> GetAllChildrenTools(IToolProvider toolProvider);
+
         /// <summary>
         /// Gets the list of tools available that have the <see cref="IsFooterItemAttribute"/>.
         /// </summary>

src/dev/impl/DevToys/Api/Tools/MatchedToolProvider.cs

@@ -19,14 +19,15 @@ public class MatchedToolProvider : INotifyPropertyChanged
     {
         private readonly List<MatchedToolProvider> _childrenTools = new();
         private MatchSpan[] _matchedSpans = Array.Empty<MatchSpan>();
+        private bool _isBeingProgrammaticallySelected;
 
         /// <summary>
         /// Gets the tool provider.
         /// </summary>
         public IToolProvider ToolProvider { get; }
 
         /// <summary>
-        /// Gets or sets the list of spans that matched the search in the <see cref="IToolProvider.DisplayName"/>.
+        /// Gets or sets the list of spans that matched the search in the <see cref="IToolProvider.SearchDisplayName"/>.
         /// </summary>
         public MatchSpan[] MatchedSpans
         {
@@ -36,13 +37,15 @@ public MatchSpan[] MatchedSpans
                 _matchedSpans = value;
                 ThreadHelper.RunOnUIThreadAsync(() =>
                 {
-                    RaisePropertyChanged(nameof(AnyMatchedSpan));
                     RaisePropertyChanged(nameof(MatchedSpans));
                 }).Forget();
             }
         }
 
-        public bool AnyMatchedSpan => MatchedSpans.Length > 0;
+        /// <summary>
+        /// Gets or sets the total amount of match in after a search (which can be different from <see cref="MatchedSpans"/>).
+        /// </summary>
+        public int TotalMatchCount { get; set; }
 
         /// <summary>
         /// Gets the metadata of the tool provider.
@@ -70,9 +73,11 @@ public IReadOnlyList<MatchedToolProvider> ChildrenTools
             }
         }
 
-        public bool HasRecommandedChildrenTool => ChildrenTools.Any(item => item.IsRecommended || item.HasRecommandedChildrenTool);
+        public bool MenuItemShouldBeExpanded
+            => _isBeingProgrammaticallySelected
+            || ChildrenTools.Any(item => item.IsRecommended || item.MenuItemShouldBeExpanded);
 
-        internal TaskCompletionNotifier<IconElement> Icon => (TaskCompletionNotifier<IconElement>)ToolProvider.IconSource;
+        internal TaskCompletionNotifier<IconElement> Icon => ToolProvider.IconSource;
 
         public event PropertyChangedEventHandler? PropertyChanged;
 
@@ -103,24 +108,47 @@ internal void AddChildTool(MatchedToolProvider child)
 
             if (child.IsRecommended)
             {
-                RaisePropertyChanged(nameof(HasRecommandedChildrenTool));
+                RaisePropertyChanged(nameof(MenuItemShouldBeExpanded));
             }
 
             child.PropertyChanged += Child_PropertyChanged;
         }
 
+        internal IDisposable ForceMenuItemShouldBeExpanded()
+        {
+            // Notify that parents menu item should be expanded if they're not yet.
+            _isBeingProgrammaticallySelected = true;
+            RaisePropertyChanged(nameof(MenuItemShouldBeExpanded));
+            return new SelectMenuItemProgrammaticallyResult(this);
+        }
+
         private void Child_PropertyChanged(object sender, PropertyChangedEventArgs e)
         {
-            if ((e.PropertyName == nameof(IsRecommended) || e.PropertyName == nameof(HasRecommandedChildrenTool))
-                && HasRecommandedChildrenTool)
+            if ((e.PropertyName == nameof(IsRecommended) || e.PropertyName == nameof(MenuItemShouldBeExpanded))
+                && MenuItemShouldBeExpanded)
             {
-                RaisePropertyChanged(nameof(HasRecommandedChildrenTool));
+                RaisePropertyChanged(nameof(MenuItemShouldBeExpanded));
             }
         }
 
         protected void RaisePropertyChanged(string propertyName)
         {
             PropertyChanged?.Invoke(this, new PropertyChangedEventArgs(propertyName));
         }
+
+        private class SelectMenuItemProgrammaticallyResult : IDisposable
+        {
+            private readonly MatchedToolProvider _matchedToolProvider;
+
+            public SelectMenuItemProgrammaticallyResult(MatchedToolProvider matchedToolProvider)
+            {
+                _matchedToolProvider = matchedToolProvider;
+            }
+
+            public void Dispose()
+            {
+                _matchedToolProvider._isBeingProgrammaticallySelected = false;
+            }
+        }
     }
 }