Add support for customizing equal rules for results

Author: Jack251970

Flow.Launcher.Plugin/Result.cs

@@ -1,5 +1,4 @@
 using System;
-using System.Runtime;
 using System.Collections.Generic;
 using System.IO;
 using System.Threading.Tasks;
@@ -13,7 +12,6 @@ namespace Flow.Launcher.Plugin
     /// </summary>
     public class Result
     {
-
         private string _pluginDirectory;
 
         private string _icoPath;
@@ -103,7 +101,6 @@ public string IcoPath
         /// </summary>
         public GlyphInfo Glyph { get; init; }
 
-
         /// <summary>
         /// An action to take in the form of a function call when the result has been selected.
         /// </summary>
@@ -273,6 +270,26 @@ public ValueTask<bool> ExecuteAsync(ActionContext context)
         /// </summary>
         public const int MaxScore = int.MaxValue;
 
+        /// <summary>
+        /// An action to get the key of the title. This is used when FL checks whether the result is the topmost record. Or FL calculates the hashcode of the result for user selected records.
+        /// This can be useful when your plugin will change the title of the result dynamically.
+        /// </summary>
+        /// <remarks>
+        /// The function is invoked with the title of the result as the only parameter.
+        /// Its result determines the key of the title.
+        /// </remarks>
+        public Func<string, string> GetTitleKey { get; set; } = null;
+
+        /// <summary>
+        /// An action to get the key of the subtitle. This is used when FL checks whether the result is the topmost record. Or FL calculates the hashcode of the result for user selected records.
+        /// This can be useful when your plugin will change the subtitle of the result dynamically.
+        /// </summary>
+        /// <remarks>
+        /// The function is invoked with the subtitle of the result as the only parameter.
+        /// Its result determines the key of the subtitle.
+        /// </remarks>
+        public Func<string, string> GetSubTitleKey { get; set; } = null;
+
         /// <summary>
         /// Info of the preview section of a <see cref="Result"/>
         /// </summary>

Flow.Launcher/Storage/TopMostRecord.cs

@@ -52,8 +52,14 @@ public class Record
 
         public bool Equals(Result r)
         {
-            return Title == r.Title
-                && SubTitle == r.SubTitle
+            var titleEqual = r.GetTitleKey != null ?
+                r.GetTitleKey(Title) == r.GetTitleKey(r.Title) :
+                Title == r.Title;
+            var subTitleEqual = r.GetSubTitleKey != null ?
+                r.GetSubTitleKey(SubTitle) == r.GetSubTitleKey(r.SubTitle) :
+                SubTitle == r.SubTitle;
+            return titleEqual
+                && subTitleEqual
                 && PluginID == r.PluginID;
         }
     }

Flow.Launcher/Storage/UserSelectedRecord.cs

@@ -15,7 +15,6 @@ public class UserSelectedRecord
         [JsonInclude, JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
         public Dictionary<string, int> records { get; private set; }
 
-
         public UserSelectedRecord()
         {
             recordsWithQuery = new Dictionary<int, int>();
@@ -45,8 +44,8 @@ private static int GenerateStaticHashCode(string s, int start = HASH_INITIAL)
 
         private static int GenerateResultHashCode(Result result)
         {
-            int hashcode = GenerateStaticHashCode(result.Title);
-            return GenerateStaticHashCode(result.SubTitle, hashcode);
+            int hashcode = GenerateStaticHashCode(result.GetTitleKey != null ? result.GetTitleKey(result.Title) : result.Title);
+            return GenerateStaticHashCode(result.GetSubTitleKey != null ? result.GetSubTitleKey(result.SubTitle) : result.SubTitle, hashcode);
         }
 
         private static int GenerateQueryAndResultHashCode(Query query, Result result)
@@ -58,8 +57,8 @@ private static int GenerateQueryAndResultHashCode(Query query, Result result)
 
             int hashcode = GenerateStaticHashCode(query.ActionKeyword);
             hashcode = GenerateStaticHashCode(query.Search, hashcode);
-            hashcode = GenerateStaticHashCode(result.Title, hashcode);
-            hashcode = GenerateStaticHashCode(result.SubTitle, hashcode);
+            hashcode = GenerateStaticHashCode(result.GetTitleKey != null ? result.GetTitleKey(result.Title) : result.Title, hashcode);
+            hashcode = GenerateStaticHashCode(result.GetSubTitleKey != null ? result.GetSubTitleKey(result.SubTitle) : result.SubTitle, hashcode);
 
             return hashcode;
         }