Use Highlight matches from Everything (#4196)

* Use Highlight matches from Everything

To solve inaccurate highlight when facing Chinese Pinyin searches

* Fix typos

* Update comments

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Remove unnecessary constructor

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Use camel case for parameters

* Use ToInt32 instead of explicit converting

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Revert "Remove unnecessary constructor"

This reverts commit 7e9dc18.

* Make SearchResult readonly and init HighlightData to empty list

Changed SearchResult to a readonly record struct for better immutability and performance. Updated HighlightData to initialize as an empty list using a collection expression instead of null. Retained the default constructor with a clarifying comment.

* Fix incorrect argument type after merging

---------

Co-authored-by: Jack251970 <1160210343@qq.com>
Co-authored-by: Jack Ye <jack1160210343@gmail.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Author: 3 people

Plugins/Flow.Launcher.Plugin.Explorer/Search/Everything/EverythingAPI.cs

@@ -157,7 +157,8 @@ public static async IAsyncEnumerable<SearchResult> SearchAsync(EverythingSearchO
                         Type = EverythingApiDllImport.Everything_IsFolderResult(idx) ? ResultType.Folder :
                             EverythingApiDllImport.Everything_IsFileResult(idx) ? ResultType.File :
                             ResultType.Volume,
-                        Score = (int)EverythingApiDllImport.Everything_GetResultRunCount( (uint)idx) 
+                        Score = Convert.ToInt32(EverythingApiDllImport.Everything_GetResultRunCount((uint)idx)),
+                        HighlightData = EverythingHighlightStringToHighlightList(EverythingApiDllImport.Everything_GetResultHighlightedFileName((uint)idx))
                     };
 
                     yield return result;
@@ -208,5 +209,55 @@ public static async Task IncrementRunCounterAsync(string fileOrFolder)
             }
             finally { _semaphore.Release(); }
         }
+
+        /// <summary>
+        /// Convert the highlighted string from Everything API to a list of highlight indexes for our Result.
+        /// </summary>
+        /// <param name="highlightString">Text inside a * quote is highlighted, two consecutive *'s is a single literal *. For example, in the highlighted text: abc*123* the 123 part is highlighted.</param>
+        /// <returns>A list of zero-based character indices that should be highlighted.</returns>
+        public static List<int> EverythingHighlightStringToHighlightList(string highlightString)
+        {
+            var highlightData = new List<int>();
+
+            if (string.IsNullOrEmpty(highlightString))
+                return highlightData;
+
+            var isHighlighted = false;
+            var actualIndex = 0; // Index in the actual string (without * markers)
+            var length = highlightString.Length;
+
+            for (var i = 0; i < length; i++)
+            {
+                if (highlightString[i] == '*')
+                {
+                    // Check if it's a literal * (two consecutive *)
+                    if (i + 1 < length && highlightString[i + 1] == '*')
+                    {
+                        // Two consecutive *'s represent a single literal *
+                        if (isHighlighted)
+                        {
+                            highlightData.Add(actualIndex);
+                        }
+                        actualIndex++;
+                        i++; // Skip the next *
+                    }
+                    else
+                    {
+                        isHighlighted = !isHighlighted;
+                    }
+                }
+                else
+                {
+                    // Regular character
+                    if (isHighlighted)
+                    {
+                        highlightData.Add(actualIndex);
+                    }
+                    actualIndex++;
+                }
+            }
+
+            return highlightData;
+        }
     }
 }

Plugins/Flow.Launcher.Plugin.Explorer/Search/Everything/EverythingApiDllImport.cs

@@ -147,7 +147,7 @@ public static void Load(string directory)
         [DllImport(DLL)]
         public static extern bool Everything_GetResultDateRecentlyChanged(uint nIndex, out long lpFileTime);
         [DllImport(DLL, CharSet = CharSet.Unicode)]
-        public static extern IntPtr Everything_GetResultHighlightedFileName(uint nIndex);
+        public static extern string Everything_GetResultHighlightedFileName(uint nIndex);
         [DllImport(DLL, CharSet = CharSet.Unicode)]
         public static extern IntPtr Everything_GetResultHighlightedPath(uint nIndex);
         [DllImport(DLL, CharSet = CharSet.Unicode)]

Plugins/Flow.Launcher.Plugin.Explorer/Search/ResultManager.cs

@@ -106,9 +106,9 @@ public static Result CreateResult(Query query, SearchResult result)
             return result.Type switch
             {
                 ResultType.Folder or ResultType.Volume =>
-                    CreateFolderResult(Path.GetFileName(result.FullPath), result.FullPath, result.FullPath, query, result.Score, result.WindowsIndexed),
+                    CreateFolderResult(Path.GetFileName(result.FullPath), result.FullPath, result.FullPath, query, result.Score, result.WindowsIndexed, result.HighlightData),
                 ResultType.File =>
-                    CreateFileResult(result.FullPath, query, result.Score, result.WindowsIndexed),
+                    CreateFileResult(result.FullPath, query, result.Score, result.WindowsIndexed, name: null, highlightData: result.HighlightData),
                 _ => throw new ArgumentOutOfRangeException(null)
             };
         }
@@ -134,7 +134,7 @@ internal static void ShowNativeContextMenu(string path, ResultType type)
             }
         }
 
-        internal static Result CreateFolderResult(string title, string subtitle, string path, Query query, int score = 0, bool windowsIndexed = false)
+        internal static Result CreateFolderResult(string title, string subtitle, string path, Query query, int score = 0, bool windowsIndexed = false, List<int> highlightData = null)
         {
             if (Settings.BoostHomeFolderScore && IsHomeFolderPath(path))
                 score += HomeFolderScoreBoost;
@@ -145,7 +145,7 @@ internal static Result CreateFolderResult(string title, string subtitle, string
                 IcoPath = path,
                 SubTitle = subtitle,
                 AutoCompleteText = GetAutoCompleteText(title, query, path, ResultType.Folder),
-                TitleHighlightData = Context.API.FuzzySearch(query.Search, title).MatchData,
+                TitleHighlightData = highlightData ?? Context.API.FuzzySearch(query.Search, title).MatchData,
                 CopyText = path,
                 Preview = new Result.PreviewInfo
                 {
@@ -327,7 +327,7 @@ internal static Result CreateOpenCurrentFolderResult(string path, string actionK
             };
         }
 
-        internal static Result CreateFileResult(string filePath, Query query, int score = 0, bool windowsIndexed = false, string name = null)
+        internal static Result CreateFileResult(string filePath, Query query, int score = 0, bool windowsIndexed = false, string name = null, List<int> highlightData = null)
         {
             var isMedia = IsMedia(Path.GetExtension(filePath));
             var title = name ?? Path.GetFileName(filePath) ?? string.Empty;
@@ -347,7 +347,7 @@ internal static Result CreateFileResult(string filePath, Query query, int score
                     FilePath = filePath,
                 },
                 AutoCompleteText = GetAutoCompleteText(title, query, filePath, ResultType.File),
-                TitleHighlightData = Context.API.FuzzySearch(query.Search, title).MatchData,
+                TitleHighlightData = highlightData ?? Context.API.FuzzySearch(query.Search, title).MatchData,
                 Score = score,
                 CopyText = filePath,
                 PreviewPanel = new Lazy<UserControl>(() => new PreviewPanel(Settings, filePath, ResultType.File)),

Plugins/Flow.Launcher.Plugin.Explorer/Search/SearchResult.cs

@@ -1,11 +1,19 @@
+using System.Collections.Generic;
+
 namespace Flow.Launcher.Plugin.Explorer.Search
 {
-    public record struct SearchResult
+    public readonly record struct SearchResult
     {
+        // Constructor is necesssary for record struct
+        public SearchResult()
+        {
+        }
+
         public string FullPath { get; init; }
         public ResultType Type { get; init; }
         public int Score { get; init; }
 
         public bool WindowsIndexed { get; init; }
+        public List<int> HighlightData { get; init; } = [];
     }
 }