Merge branch 'dev' into multiple_topmost

Author: Jack251970

Flow.Launcher.Core/Plugin/PluginManager.cs

@@ -25,6 +25,7 @@ public static class PluginManager
         private static readonly string ClassName = nameof(PluginManager);
 
         private static IEnumerable<PluginPair> _contextMenuPlugins;
+        private static IEnumerable<PluginPair> _homePlugins;
 
         public static List<PluginPair> AllPlugins { get; private set; }
         public static readonly HashSet<PluginPair> GlobalPlugins = new();
@@ -220,13 +221,16 @@ public static async Task InitializePluginsAsync()
                 {
                     API.LogException(ClassName, $"Fail to Init plugin: {pair.Metadata.Name}", e);
                     pair.Metadata.Disabled = true;
+                    pair.Metadata.HomeDisabled = true;
                     failedPlugins.Enqueue(pair);
                 }
             }));
 
             await Task.WhenAll(InitTasks);
 
             _contextMenuPlugins = GetPluginsForInterface<IContextMenu>();
+            _homePlugins = GetPluginsForInterface<IAsyncHomeQuery>();
+
             foreach (var plugin in AllPlugins)
             {
                 // set distinct on each plugin's action keywords helps only firing global(*) and action keywords once where a plugin
@@ -274,6 +278,11 @@ public static ICollection<PluginPair> ValidPluginsForQuery(Query query)
             };
         }
 
+        public static ICollection<PluginPair> ValidPluginsForHomeQuery()
+        {
+            return _homePlugins.ToList();
+        }
+
         public static async Task<List<Result>> QueryForPluginAsync(PluginPair pair, Query query, CancellationToken token)
         {
             var results = new List<Result>();
@@ -318,6 +327,36 @@ public static async Task<List<Result>> QueryForPluginAsync(PluginPair pair, Quer
             return results;
         }
 
+        public static async Task<List<Result>> QueryHomeForPluginAsync(PluginPair pair, Query query, CancellationToken token)
+        {
+            var results = new List<Result>();
+            var metadata = pair.Metadata;
+
+            try
+            {
+                var milliseconds = await API.StopwatchLogDebugAsync(ClassName, $"Cost for {metadata.Name}",
+                    async () => results = await ((IAsyncHomeQuery)pair.Plugin).HomeQueryAsync(token).ConfigureAwait(false));
+
+                token.ThrowIfCancellationRequested();
+                if (results == null)
+                    return null;
+                UpdatePluginMetadata(results, metadata, query);
+
+                token.ThrowIfCancellationRequested();
+            }
+            catch (OperationCanceledException)
+            {
+                // null will be fine since the results will only be added into queue if the token hasn't been cancelled
+                return null;
+            }
+            catch (Exception e)
+            {
+                API.LogException(ClassName, $"Failed to query home for plugin: {metadata.Name}", e);
+                return null;
+            }
+            return results;
+        }
+
         public static void UpdatePluginMetadata(IReadOnlyList<Result> results, PluginMetadata metadata, Query query)
         {
             foreach (var r in results)
@@ -378,6 +417,11 @@ public static List<Result> GetContextMenusForPlugin(Result result)
             return results;
         }
 
+        public static bool IsHomePlugin(string id)
+        {
+            return _homePlugins.Any(p => p.Metadata.ID == id);
+        }
+
         public static bool ActionKeywordRegistered(string actionKeyword)
         {
             // this method is only checking for action keywords (defined as not '*') registration

Flow.Launcher.Core/Plugin/QueryBuilder.cs

@@ -1,4 +1,4 @@
-using System;
+using System;
 using System.Collections.Generic;
 using Flow.Launcher.Plugin;
 
@@ -8,10 +8,23 @@ public static class QueryBuilder
     {
         public static Query Build(string text, Dictionary<string, PluginPair> nonGlobalPlugins)
         {
+            // home query
+            if (string.IsNullOrEmpty(text))
+            {
+                return new Query()
+                {
+                    Search = string.Empty,
+                    RawQuery = string.Empty,
+                    SearchTerms = Array.Empty<string>(),
+                    ActionKeyword = string.Empty
+                };
+            }
+
             // replace multiple white spaces with one white space
             var terms = text.Split(Query.TermSeparator, StringSplitOptions.RemoveEmptyEntries);
             if (terms.Length == 0)
-            { // nothing was typed
+            {
+                // nothing was typed
                 return null;
             }
 
@@ -21,19 +34,21 @@ public static Query Build(string text, Dictionary<string, PluginPair> nonGlobalP
             string[] searchTerms;
 
             if (nonGlobalPlugins.TryGetValue(possibleActionKeyword, out var pluginPair) && !pluginPair.Metadata.Disabled)
-            { // use non global plugin for query
+            {
+                // use non global plugin for query
                 actionKeyword = possibleActionKeyword;
                 search = terms.Length > 1 ? rawQuery[(actionKeyword.Length + 1)..].TrimStart() : string.Empty;
                 searchTerms = terms[1..];
             }
             else
-            { // non action keyword
+            {
+                // non action keyword
                 actionKeyword = string.Empty;
                 search = rawQuery.TrimStart();
                 searchTerms = terms;
             }
 
-            return new Query ()
+            return new Query()
             {
                 Search = search,
                 RawQuery = rawQuery,
@@ -42,4 +57,4 @@ public static Query Build(string text, Dictionary<string, PluginPair> nonGlobalP
             };
         }
     }
-}
+}

Flow.Launcher.Core/Resource/Theme.cs

@@ -76,7 +76,7 @@ public Theme(IPublicAPI publicAPI, Settings settings)
             {
                 _api.LogError(ClassName, "Current theme resource not found. Initializing with default theme.");
                 _oldTheme = Constant.DefaultTheme;
-            };
+            }
         }
 
         #endregion
@@ -126,7 +126,7 @@ public void UpdateFonts()
                 // Load a ResourceDictionary for the specified theme.
                 var themeName = _settings.Theme;
                 var dict = GetThemeResourceDictionary(themeName);
-                
+
                 // Apply font settings to the theme resource.
                 ApplyFontSettings(dict);
                 UpdateResourceDictionary(dict);
@@ -152,11 +152,11 @@ private void ApplyFontSettings(ResourceDictionary dict)
                 var fontStyle = FontHelper.GetFontStyleFromInvariantStringOrNormal(_settings.QueryBoxFontStyle);
                 var fontWeight = FontHelper.GetFontWeightFromInvariantStringOrNormal(_settings.QueryBoxFontWeight);
                 var fontStretch = FontHelper.GetFontStretchFromInvariantStringOrNormal(_settings.QueryBoxFontStretch);
-                
+
                 SetFontProperties(queryBoxStyle, fontFamily, fontStyle, fontWeight, fontStretch, true);
                 SetFontProperties(querySuggestionBoxStyle, fontFamily, fontStyle, fontWeight, fontStretch, false);
             }
-            
+
             if (dict["ItemTitleStyle"] is Style resultItemStyle &&
                 dict["ItemTitleSelectedStyle"] is Style resultItemSelectedStyle &&
                 dict["ItemHotkeyStyle"] is Style resultHotkeyItemStyle &&
@@ -172,7 +172,7 @@ private void ApplyFontSettings(ResourceDictionary dict)
                 SetFontProperties(resultHotkeyItemStyle, fontFamily, fontStyle, fontWeight, fontStretch, false);
                 SetFontProperties(resultHotkeyItemSelectedStyle, fontFamily, fontStyle, fontWeight, fontStretch, false);
             }
-            
+
             if (dict["ItemSubTitleStyle"] is Style resultSubItemStyle &&
                 dict["ItemSubTitleSelectedStyle"] is Style resultSubItemSelectedStyle)
             {
@@ -197,7 +197,7 @@ private static void SetFontProperties(Style style, FontFamily fontFamily, FontSt
                 //  First, find the setters to remove and store them in a list  
                 var settersToRemove = style.Setters
                     .OfType<Setter>()
-                    .Where(setter => 
+                    .Where(setter =>
                         setter.Property == Control.FontFamilyProperty ||
                         setter.Property == Control.FontStyleProperty ||
                         setter.Property == Control.FontWeightProperty ||
@@ -227,18 +227,18 @@ private static void SetFontProperties(Style style, FontFamily fontFamily, FontSt
             {
                 var settersToRemove = style.Setters
                     .OfType<Setter>()
-                    .Where(setter => 
+                    .Where(setter =>
                         setter.Property == TextBlock.FontFamilyProperty ||
                         setter.Property == TextBlock.FontStyleProperty ||
                         setter.Property == TextBlock.FontWeightProperty ||
                         setter.Property == TextBlock.FontStretchProperty)
                     .ToList();
-                
+
                 foreach (var setter in settersToRemove)
                 {
                     style.Setters.Remove(setter);
                 }
-                
+
                 style.Setters.Add(new Setter(TextBlock.FontFamilyProperty, fontFamily));
                 style.Setters.Add(new Setter(TextBlock.FontStyleProperty, fontStyle));
                 style.Setters.Add(new Setter(TextBlock.FontWeightProperty, fontWeight));
@@ -421,7 +421,7 @@ public bool ChangeTheme(string theme = null)
 
                 // Retrieve theme resource – always use the resource with font settings applied.
                 var resourceDict = GetResourceDictionary(theme);
-                
+
                 UpdateResourceDictionary(resourceDict);
 
                 _settings.Theme = theme;

Flow.Launcher.Infrastructure/NativeMethods.txt

@@ -43,6 +43,9 @@ MONITORINFOEXW
 WM_ENTERSIZEMOVE
 WM_EXITSIZEMOVE
 
+OleInitialize
+OleUninitialize
+
 GetKeyboardLayout
 GetWindowThreadProcessId
 ActivateKeyboardLayout
@@ -53,4 +56,4 @@ INPUTLANGCHANGE_FORWARD
 LOCALE_TRANSIENT_KEYBOARD1
 LOCALE_TRANSIENT_KEYBOARD2
 LOCALE_TRANSIENT_KEYBOARD3
-LOCALE_TRANSIENT_KEYBOARD4
+LOCALE_TRANSIENT_KEYBOARD4

Flow.Launcher.Infrastructure/UserSettings/CustomShortcutModel.cs

@@ -1,15 +1,15 @@
 using System;
 using System.Text.Json.Serialization;
+using System.Threading.Tasks;
 
 namespace Flow.Launcher.Infrastructure.UserSettings
 {
+    #region Base
+
     public abstract class ShortcutBaseModel
     {
         public string Key { get; set; }
 
-        [JsonIgnore]
-        public Func<string> Expand { get; set; } = () => { return ""; };
-
         public override bool Equals(object obj)
         {
             return obj is ShortcutBaseModel other &&
@@ -22,16 +22,14 @@ public override int GetHashCode()
         }
     }
 
-    public class CustomShortcutModel : ShortcutBaseModel
+    public class BaseCustomShortcutModel : ShortcutBaseModel
     {
         public string Value { get; set; }
 
-        [JsonConstructorAttribute]
-        public CustomShortcutModel(string key, string value)
+        public BaseCustomShortcutModel(string key, string value)
         {
             Key = key;
             Value = value;
-            Expand = () => { return Value; };
         }
 
         public void Deconstruct(out string key, out string value)
@@ -40,26 +38,69 @@ public void Deconstruct(out string key, out string value)
             value = Value;
         }
 
-        public static implicit operator (string Key, string Value)(CustomShortcutModel shortcut)
+        public static implicit operator (string Key, string Value)(BaseCustomShortcutModel shortcut)
         {
             return (shortcut.Key, shortcut.Value);
         }
 
-        public static implicit operator CustomShortcutModel((string Key, string Value) shortcut)
+        public static implicit operator BaseCustomShortcutModel((string Key, string Value) shortcut)
         {
-            return new CustomShortcutModel(shortcut.Key, shortcut.Value);
+            return new BaseCustomShortcutModel(shortcut.Key, shortcut.Value);
         }
     }
 
-    public class BuiltinShortcutModel : ShortcutBaseModel
+    public class BaseBuiltinShortcutModel : ShortcutBaseModel
     {
         public string Description { get; set; }
 
-        public BuiltinShortcutModel(string key, string description, Func<string> expand)
+        public BaseBuiltinShortcutModel(string key, string description)
         {
             Key = key;
             Description = description;
-            Expand = expand ?? (() => { return ""; });
         }
     }
+
+    #endregion
+
+    #region Custom Shortcut
+
+    public class CustomShortcutModel : BaseCustomShortcutModel
+    {
+        [JsonIgnore]
+        public Func<string> Expand { get; set; } = () => { return string.Empty; };
+
+        [JsonConstructor]
+        public CustomShortcutModel(string key, string value) : base(key, value)
+        {
+            Expand = () => { return Value; };
+        }
+    }
+
+    #endregion
+
+    #region Builtin Shortcut
+
+    public class BuiltinShortcutModel : BaseBuiltinShortcutModel
+    {
+        [JsonIgnore]
+        public Func<string> Expand { get; set; } = () => { return string.Empty; };
+
+        public BuiltinShortcutModel(string key, string description, Func<string> expand) : base(key, description)
+        {
+            Expand = expand ?? (() => { return string.Empty; });
+        }
+    }
+
+    public class AsyncBuiltinShortcutModel : BaseBuiltinShortcutModel
+    {
+        [JsonIgnore]
+        public Func<Task<string>> ExpandAsync { get; set; } = () => { return Task.FromResult(string.Empty); };
+
+        public AsyncBuiltinShortcutModel(string key, string description, Func<Task<string>> expandAsync) : base(key, description)
+        {
+            ExpandAsync = expandAsync ?? (() => { return Task.FromResult(string.Empty); });
+        }
+    }
+
+    #endregion
 }

Flow.Launcher.Infrastructure/UserSettings/PluginSettings.cs

@@ -67,6 +67,7 @@ public void UpdatePluginSettings(List<PluginMetadata> metadatas)
                     metadata.Disabled = settings.Disabled;
                     metadata.Priority = settings.Priority;
                     metadata.SearchDelayTime = settings.SearchDelayTime;
+                    metadata.HomeDisabled = settings.HomeDisabled;
                 }
                 else
                 {
@@ -79,6 +80,7 @@ public void UpdatePluginSettings(List<PluginMetadata> metadatas)
                         DefaultActionKeywords = metadata.ActionKeywords, // metadata provides default values
                         ActionKeywords = metadata.ActionKeywords, // use default value
                         Disabled = metadata.Disabled,
+                        HomeDisabled = metadata.HomeDisabled,
                         Priority = metadata.Priority,
                         DefaultSearchDelayTime = metadata.SearchDelayTime, // metadata provides default values
                         SearchDelayTime = metadata.SearchDelayTime, // use default value
@@ -128,5 +130,6 @@ public class Plugin
         /// Used only to save the state of the plugin in settings
         /// </summary>
         public bool Disabled { get; set; }
+        public bool HomeDisabled { get; set; }
     }
 }