Finalize generic search argument handling and add tooltips

Author: Banane9

ComponentSelectorAdditions/DefaultConfig.cs

@@ -1,5 +1,7 @@
-using MonkeyLoader.Configuration;
+using Elements.Core;
+using MonkeyLoader.Configuration;
 using System;
+using System.Diagnostics.CodeAnalysis;
 
 namespace ComponentSelectorAdditions
 {
@@ -18,7 +20,7 @@ public sealed class DefaultConfig : ConfigSection
             new ConfigKeyRange<float>(32, 64)
         };
 
-        private static readonly DefiningConfigKey<bool> _useSeparateConcreteGenericColor = new("UseSeparateConcreteGenericColor", "Use a blend between the generic component buttons' green and the non-generic component buttons' cyan for concrete generics.", () => true);
+        private static readonly DefiningConfigKey<colorX?> _separateConcreteGenericColor = new("separateConcreteGenericColor", "The color to use for concrete generic buttons, if defined. Defaults to a blend between the generic component buttons' green and the non-generic component buttons' cyan.", () => colorX.FromHexCode("#255447"));
 
         /// <summary>
         /// Gets this config's instance.
@@ -44,9 +46,15 @@ public sealed class DefaultConfig : ConfigSection
         public float IndirectButtonHeight => _indirectButtonHeight;
 
         /// <summary>
-        /// Gets whether to use a blend between the generic component buttons' green and the non-generic component buttons' cyan for concrete generics.
+        /// Gets the color to use for concrete generic buttons, if defined.
         /// </summary>
-        public bool UseSeperateConcreteGenericColor => _useSeparateConcreteGenericColor;
+        public colorX? SeparateConcreteGenericColor => _separateConcreteGenericColor;
+
+        /// <summary>
+        /// Gets whether the <see cref="SeparateConcreteGenericColor">SeparateConcreteGenericColor</see> is defined.
+        /// </summary>
+        [MemberNotNullWhen(true, nameof(SeparateConcreteGenericColor))]
+        public bool UseSeparateConcreteGenericColor => _separateConcreteGenericColor.GetValue().HasValue;
 
         /// <inheritdoc/>
         public override Version Version { get; } = new Version(1, 0, 0);

ComponentSelectorAdditions/DefaultHandler.cs

@@ -12,6 +12,7 @@
 using System.Text;
 using System.Threading.Tasks;
 using System.IO;
+using MonkeyLoader.Resonite.UI;
 
 namespace ComponentSelectorAdditions
 {
@@ -23,8 +24,6 @@ public sealed class DefaultHandler : ConfiguredResoniteMonkey<DefaultHandler, De
         ICancelableEventHandler<BuildCategoryButtonEvent>, ICancelableEventHandler<BuildGroupButtonEvent>, ICancelableEventHandler<BuildComponentButtonEvent>,
         IEventHandler<BuildCustomGenericBuilder>, IEventHandler<EnumerateConcreteGenericsEvent>
     {
-        private static colorX _presetConcreteColor = MathX.Average(RadiantUI_Constants.Sub.GREEN, RadiantUI_Constants.Sub.CYAN);
-
         /// <inheritdoc/>
         public int Priority => HarmonyLib.Priority.Normal;
 
@@ -64,6 +63,7 @@ public static TextField MakeGenericArgumentInput(UIBuilder ui, Type component, T
             {
                 var textField = ui.TextField(parseRTF: false);
                 textField.Text.NullContent.AssignLocaleString(Mod.GetLocaleString("EnterType"));
+                textField.Slot.GetComponent<Button>()?.WithTooltip(Mod.GetLocaleString("EnterType.Tooltip", "parameter", genericArgument.Name));
 
                 return textField;
             }, out var label);
@@ -199,8 +199,8 @@ void ICancelableEventHandler<BuildComponentButtonEvent>.Handle(BuildComponentBut
             var selector = eventData.Selector;
             var component = eventData.Component;
 
-            var tint = component.IsConcreteGeneric && ConfigSection.UseSeperateConcreteGenericColor
-                ? _presetConcreteColor
+            var tint = component.IsConcreteGeneric && ConfigSection.UseSeparateConcreteGenericColor
+                ? ConfigSection.SeparateConcreteGenericColor.Value
                 : component.IsGeneric ? RadiantUI_Constants.Sub.GREEN : RadiantUI_Constants.Sub.CYAN;
 
             var category = GetPrettyPath(component.Category, eventData.RootCategory);

ComponentSelectorAdditions/Events/EnumerateComponentsEvent.cs

@@ -12,16 +12,27 @@ public sealed class EnumerateComponentsEvent : CancelableSortedItemsEvent<Compon
         public Predicate<Type> ComponentFilter { get; }
 
         public override IEnumerable<ComponentResult> Items
-            => sortableItems
-                .Where(entry => ComponentFilter(entry.Key.Type))
-                .Where(entry => Selector.World.Types.IsSupported(entry.Key.Type))
-                .OrderBy(entry => entry.Value)
-                .ThenBy(entry => entry.Key.GroupName ?? entry.Key.Type.Name)
-                .Select(entry => entry.Key);
+        {
+            get
+            {
+                var items = sortableItems
+                    .Where(entry => ComponentFilter(entry.Key.Type))
+                    .Where(entry => Selector.World.Types.IsSupported(entry.Key.Type))
+                    .OrderBy(Value)
+                    .ThenBy(Name);
+
+                // Sort for (concrete) genericness when search has a generic argument
+                if (Path.HasSearchGeneric)
+                    items = items.ThenBy(GenericnessRating);
+
+                return items.Select(entry => entry.Key);
+            }
+        }
 
         public SelectorPath Path { get; }
 
         public CategoryNode<Type> RootCategory { get; }
+
         public ComponentSelector Selector { get; }
 
         /// <inheritdoc/>
@@ -32,5 +43,14 @@ internal EnumerateComponentsEvent(ComponentSelector selector, SelectorPath path,
             RootCategory = rootCategory;
             ComponentFilter = componentFilter;
         }
+
+        private static int GenericnessRating(KeyValuePair<ComponentResult, int> entry)
+            => entry.Key.Type.IsGenericType ? (entry.Key.Type.IsGenericTypeDefinition ? 1 : 0) : 2;
+
+        private static string Name(KeyValuePair<ComponentResult, int> entry)
+            => entry.Key.GroupName ?? entry.Key.Type.Name;
+
+        private static int Value(KeyValuePair<ComponentResult, int> entry)
+            => entry.Value;
     }
 }

ComponentSelectorAdditions/Locale/de.json

@@ -6,7 +6,11 @@
     "ComponentSelectorAdditions.Description": "Dieser MonkeyLoader Mod für Resonite strukturiert Komponenten-Selektoren und ProtoFlux Nodebrowser neu und fügt eine Suchfunktion sowie Kategorien für zuletzt genutzte und favorisierte Komponenten / Nodes hinzu.",
 
     "ComponentSelectorAdditions.Search": "<i>Suchen ...</i>",
+    "ComponentSelectorAdditions.Search.Clear": "Leert das Suchfeld.",
+    "ComponentSelectorAdditions.Search.Tooltip": "<b>Gebe hier deine Suchbegriffe ein. Die Ergebnisse erscheinen, wenn du das tippen pausierst.</b><size=50%><br/><br/></size>Mehrere Suchbegriffe können mit Leerzeichen getrennt werden. Für jeden Begriff wird überprüft, ob dieser im Namen einer Kategorie oder Komponente / Node enthalten ist. Je mehr Begriffe enthalten sind, desto besser wird das Ergebnis gewertet.<br/>Du kannst einen generischen Typparameter anwenden, indem du dessen volle Definition nach einem < eingibst, genauso wie du es bei der normallen Erstellung einer generischen Komponente tun würdest. Bereits das Hinzufügen eines < verbessert die Wertung aller generischen Ergebnisse.",
+
     "ComponentSelectorAdditions.EnterType": "<i>Typ eingeben...</i>",
+    "ComponentSelectorAdditions.EnterType.Tooltip": "<b>Gebe hier die Typdefinition für den generischen Parameter {parameter} ein. Dieser darf uneindeutig sein.</b><size=50%><br/><br/></size>Die Typdefinition sollte so geschrieben werden wie in C#, genauso wie Komponentennamen es zeigen. Ein Integer Field wäre zum Beispiel: IField<int>",
 
     "ComponentSelectorAdditions.CaseSensitivityFix.Description": "Macht das Auswählen von eigenen generischen Typparametern unabhängig von Groß- und Kleinschreibung. Kann deaktiviert werden, wenn der Bug behoben wurde.",
     "ComponentSelectorAdditions.CurrentPathIndicator.Description": "Fügt eine Anzeige für den Pfad der aktuellen Kategorie (und des generischen Typs) zu Komponenten-Selektoren hinzu.",

ComponentSelectorAdditions/Locale/en.json

@@ -3,7 +3,11 @@
   "authors": [ "Banane9" ],
   "messages": {
     "ComponentSelectorAdditions.Search": "<i>Search ...</i>",
+    "ComponentSelectorAdditions.Search.Clear": "Clears the search field.",
+    "ComponentSelectorAdditions.Search.Tooltip": "<b>Enter your search terms here. Results will appear when you pause typing.</b><size=50%><br/><br/></size>Multiple search terms can be split using spaces. Each term gets checked for inclusion in the name of categories or a component / node. The more terms match, the higher the result is ranked.<br/>You can apply a custom generic type by entering its full definition after a <, just like you would when normally creating a generic component. Simply adding the < will already rank up all generic results.",
+
     "ComponentSelectorAdditions.EnterType": "<i>Enter Type ...</i>",
+    "ComponentSelectorAdditions.EnterType.Tooltip": "<b>Enter your type definition for the generic parameter {parameter} here. This is allowed to be ambiguous.</b><size=50%><br/><br/></size>The type definition should be written like it would be in C#, just like component names show it. For example, an integer field would be: IField<int>",
 
     "ComponentSelectorAdditions.CaseSensitivityFix.Description": "Makes picking custom generic type parameters case-insensitive. Can be disabled when the bug gets fixed.",
     "ComponentSelectorAdditions.CurrentPathIndicator.Description": "Adds an indicator for the current category (and generic Type) path to omponent selectors.",

ComponentSelectorAdditions/SearchBar.cs

@@ -12,6 +12,8 @@
 using System.Threading;
 using System.Globalization;
 using MonkeyLoader;
+using MonkeyLoader.Resonite.UI;
+using FrooxEngine.UIX;
 
 namespace ComponentSelectorAdditions
 {
@@ -42,6 +44,8 @@ public void Handle(BuildSelectorHeaderEvent eventData)
 
             ui.Style.FlexibleWidth = 1;
             var textField = ui.TextField(null!, parseRTF: false);
+            textField.Slot.GetComponent<Button>()?.WithTooltip(Mod.GetLocaleString("Search.Tooltip"));
+
             var details = new SelectorSearchBar(searchLayout, textField.Editor.Target, () => ConfigSection.SearchRefreshDelay);
             eventData.SearchBar = details;
 
@@ -51,7 +55,7 @@ public void Handle(BuildSelectorHeaderEvent eventData)
             ui.Style.FlexibleWidth = -1;
             ui.Style.ButtonTextAlignment = Alignment.MiddleCenter;
 
-            var clearButton = ui.Button("∅");
+            var clearButton = ui.Button("∅").WithTooltip(Mod.GetLocaleString("Search.Clear"));
             var clearAction = clearButton.Slot.AttachComponent<ButtonValueSet<string>>();
             clearAction.TargetValue.Target = details.Text.Content;
 
@@ -83,8 +87,8 @@ public void Handle(EnumerateComponentsEvent eventData)
                     SearchCategories(searchCategory)
                     .SelectMany(category => category.Elements
                         .Select(type => (Category: category, Type: type, Matches: SearchContains(type.Name, eventData.Path.SearchFragments)))))
-                .Where(match => match.Matches > 0) // Extra weight for generic results when there's a generic in the search:
-                .OrderByDescending(match => match.Type.IsGenericTypeDefinition && eventData.Path.HasSearchGeneric ? match.Matches + 100 : match.Matches)
+                .Where(match => match.Matches > 0)
+                .OrderByDescending(match => match.Matches)
                 .ThenBy(match => match.Type.Name)
                 .Select(match => (Component: new ComponentResult(match.Category, match.Type), Order: -match.Matches));
 
@@ -106,7 +110,7 @@ public void Handle(EnumerateComponentsEvent eventData)
                             continue;
 
                         --remaining;
-                        eventData.AddItem(new(result.Component.Category, concreteType), result.Order - 1);
+                        eventData.AddItem(new(result.Component.Category, concreteType), result.Order);
                     }
                     catch (Exception ex)
                     {

ComponentSelectorAdditions/SelectorPath.cs

@@ -23,7 +23,7 @@ public sealed class SelectorPath
 
         private static readonly char[] _pathSeparators = { '/', '\\' };
 
-        private static readonly char[] _searchSplits = new[] { ' ', ',', '+', '|' };
+        private static readonly char[] _searchSplits = new[] { ' ', '.', ',', ';', '?', '!', '+', '|', '&', '`', '´', '"', '(', ')', '/', '\\', '\n', '\r', '\t' };
 
         /// <summary>
         /// Gets whether this path targets a generic type.
@@ -99,17 +99,19 @@ internal SelectorPath(string? rawPath, string? search, bool genericType, string?
 
             if (!string.IsNullOrWhiteSpace(search))
             {
-                var genericParamStartIndex = search!.IndexOf(_genericParamStart);
+                search = search!.Replace('[', _genericParamStart).Replace(']', _genericParamEnd);
+
+                var genericParamStartIndex = search.IndexOf(_genericParamStart);
 
                 if (genericParamStartIndex > 0)
                 {
-                    var generic = search[(genericParamStartIndex + 1)..];
+                    var generic = search[(genericParamStartIndex + 1)..].Trim();
                     var starts = generic.Count(static c => c == _genericParamStart);
                     var ends = generic.Count(static c => c == _genericParamEnd);
 
                     if (starts > ends) // Automatically add any missing >
                         generic += new string(_genericParamEnd, starts - ends);
-                    else if (ends > starts) // Probably not gonna happen often, but if someone adds a closing > to much...
+                    else if (ends > starts) // Probably not gonna happen often, but if someone adds too many closing > ...
                         generic = generic.Remove(generic.Length - (ends - starts));
 
                     SearchGeneric = generic;