Skip to content

Commit 75f23aa

Browse files
jjw24jjw24
authored
Merge pull request #3412 from Jack251970/load_image_async
New API Function LoadImageAsync
2 parents 6ebb73b + 6af79a1 commit 75f23aa

File tree

14 files changed

+53
-46
lines changed

14 files changed

+53
-46
lines changed

‎Flow.Launcher.Infrastructure/Image/ImageLoader.cs‎

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -284,7 +284,7 @@ public static bool TryGetValue(string path, bool loadFullImage, out ImageSource
284284
return ImageCache.TryGetValue(path, loadFullImage, out image);
285285
}
286286

287-
public static async ValueTask<ImageSource> LoadAsync(string path, bool loadFullImage = false)
287+
public static async ValueTask<ImageSource> LoadAsync(string path, bool loadFullImage = false, bool cacheImage = true)
288288
{
289289
var imageResult = await LoadInternalAsync(path, loadFullImage);
290290

@@ -300,16 +300,18 @@ public static async ValueTask<ImageSource> LoadAsync(string path, bool loadFullI
300300
// image already exists
301301
img = ImageCache[key, loadFullImage] ?? img;
302302
}
303-
else
303+
else if (cacheImage)
304304
{
305-
// new guid
306-
305+
// save guid key
307306
GuidToKey[hash] = path;
308307
}
309308
}
310309

311-
// update cache
312-
ImageCache[path, loadFullImage] = img;
310+
if (cacheImage)
311+
{
312+
// update cache
313+
ImageCache[path, loadFullImage] = img;
314+
}
313315
}
314316

315317
return img;

‎Flow.Launcher.Plugin/Interfaces/IPublicAPI.cs‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
using System.Threading;
99
using System.Threading.Tasks;
1010
using System.Windows;
11+
using System.Windows.Media;
1112

1213
namespace Flow.Launcher.Plugin
1314
{
@@ -346,6 +347,20 @@ public interface IPublicAPI
346347
public void StopLoadingBar();
347348

348349
/// <summary>
350+
/// Load image from path. Support local, remote and data:image url.
351+
/// If image path is missing, it will return a missing icon.
352+
/// </summary>
353+
/// <param name="path">The path of the image.</param>
354+
/// <param name="loadFullImage">
355+
/// Load full image or not.
356+
/// </param>
357+
/// <param name="cacheImage">
358+
/// Cache the image or not. Cached image will be stored in FL cache.
359+
/// If the image is just used one time, it's better to set this to false.
360+
/// </param>
361+
/// <returns></returns>
362+
ValueTask<ImageSource> LoadImageAsync(string path, bool loadFullImage = false, bool cacheImage = true);
363+
349364
/// Update the plugin manifest
350365
/// </summary>
351366
/// <param name="usePrimaryUrlOnly">

‎Flow.Launcher/MessageBoxEx.xaml.cs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -156,7 +156,7 @@ private static async Task SetImageOfMessageBoxAsync(MessageBoxImage icon)
156156
private async Task SetImageAsync(string imageName)
157157
{
158158
var imagePath = Path.Combine(Constant.ProgramDirectory, "Images", imageName);
159-
var imageSource = await ImageLoader.LoadAsync(imagePath);
159+
var imageSource = await App.API.LoadImageAsync(imagePath);
160160
Img.Source = imageSource;
161161
}
162162

‎Flow.Launcher/Msg.xaml.cs‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ public Msg()
4343

4444
private async System.Threading.Tasks.Task LoadImageAsync()
4545
{
46-
imgClose.Source = await ImageLoader.LoadAsync(Path.Combine(Infrastructure.Constant.ProgramDirectory, "Images\\close.png"));
46+
imgClose.Source = await App.API.LoadImageAsync(Path.Combine(Constant.ProgramDirectory, "Images\\close.png"));
4747
}
4848

4949
void imgClose_MouseUp(object sender, MouseButtonEventArgs e)
@@ -71,11 +71,11 @@ public async void Show(string title, string subTitle, string iconPath)
7171

7272
if (!File.Exists(iconPath))
7373
{
74-
imgIco.Source = await ImageLoader.LoadAsync(Path.Combine(Constant.ProgramDirectory, "Images\\app.png"));
74+
imgIco.Source = await App.API.LoadImageAsync(Path.Combine(Constant.ProgramDirectory, "Images\\app.png"));
7575
}
7676
else
7777
{
78-
imgIco.Source = await ImageLoader.LoadAsync(iconPath);
78+
imgIco.Source = await App.API.LoadImageAsync(iconPath);
7979
}
8080

8181
Show();

‎Flow.Launcher/PublicAPIInstance.cs‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010
using System.Threading;
1111
using System.Threading.Tasks;
1212
using System.Windows;
13+
using System.Windows.Media;
1314
using CommunityToolkit.Mvvm.DependencyInjection;
1415
using Squirrel;
1516
using Flow.Launcher.Core;
@@ -355,6 +356,9 @@ public MessageBoxResult ShowMsgBox(string messageBoxText, string caption = "", M
355356

356357
public Task ShowProgressBoxAsync(string caption, Func<Action<double>, Task> reportProgressAsync, Action cancelProgress = null) => ProgressBoxEx.ShowAsync(caption, reportProgressAsync, cancelProgress);
357358

359+
public ValueTask<ImageSource> LoadImageAsync(string path, bool loadFullImage = false, bool cacheImage = true) =>
360+
ImageLoader.LoadAsync(path, loadFullImage, cacheImage);
361+
358362
public Task<bool> UpdatePluginManifestAsync(bool usePrimaryUrlOnly = false, CancellationToken token = default) =>
359363
PluginsManifest.UpdateManifestAsync(usePrimaryUrlOnly, token);
360364

‎Flow.Launcher/ViewModel/MainViewModel.cs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1168,7 +1168,7 @@ private async Task QueryResultsAsync(bool searchDelay, bool isReQuery = false, b
11681168
else if (plugins.Count == 1)
11691169
{
11701170
PluginIconPath = plugins.Single().Metadata.IcoPath;
1171-
PluginIconSource = await ImageLoader.LoadAsync(PluginIconPath);
1171+
PluginIconSource = await App.API.LoadImageAsync(PluginIconPath);
11721172
SearchIconVisibility = Visibility.Hidden;
11731173
}
11741174
else

‎Flow.Launcher/ViewModel/PluginViewModel.cs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ private static string PluginManagerActionKeyword
4545

4646
private async Task LoadIconAsync()
4747
{
48-
Image = await ImageLoader.LoadAsync(PluginPair.Metadata.IcoPath);
48+
Image = await App.API.LoadImageAsync(PluginPair.Metadata.IcoPath);
4949
OnPropertyChanged(nameof(Image));
5050
}
5151

‎Flow.Launcher/ViewModel/ResultViewModel.cs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -199,7 +199,7 @@ private async Task<ImageSource> LoadImageInternalAsync(string imagePath, Result.
199199
}
200200
}
201201

202-
return await ImageLoader.LoadAsync(imagePath, loadFullImage).ConfigureAwait(false);
202+
return await App.API.LoadImageAsync(imagePath, loadFullImage).ConfigureAwait(false);
203203
}
204204

205205
private async Task LoadImageAsync()

‎Plugins/Flow.Launcher.Plugin.Explorer/Views/PreviewPanel.xaml.cs‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,6 @@
77
using System.Windows.Controls;
88
using System.Windows.Media;
99
using System.Windows.Media.Imaging;
10-
using Flow.Launcher.Infrastructure.Image;
1110
using Flow.Launcher.Plugin.Explorer.Search;
1211

1312
namespace Flow.Launcher.Plugin.Explorer.Views;
@@ -89,7 +88,7 @@ public PreviewPanel(Settings settings, string filePath)
8988

9089
private async Task LoadImageAsync()
9190
{
92-
PreviewImage = await ImageLoader.LoadAsync(FilePath, true).ConfigureAwait(false);
91+
PreviewImage = await Main.Context.API.LoadImageAsync(FilePath, true).ConfigureAwait(false);
9392
}
9493

9594
public event PropertyChangedEventHandler? PropertyChanged;

‎Plugins/Flow.Launcher.Plugin.WebSearch/SearchSourceViewModel.cs‎

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
1-
using Flow.Launcher.Infrastructure.Image;
2-
using System;
1+
using System;
32
using System.IO;
43
using System.Threading.Tasks;
54
#pragma warning disable IDE0005
@@ -41,8 +40,8 @@ public void CopyNewImageToUserDataDirectoryIfRequired(
4140
#if DEBUG
4241
throw;
4342
#else
44-
Main._context.API.ShowMsgBox(string.Format("Copying the selected image file to {0} has failed, changes will now be reverted", destinationFileNameFullPath));
45-
UpdateIconAttributes(selectedSearchSource, fullPathToOriginalImage);
43+
Main._context.API.ShowMsgBox(string.Format("Copying the selected image file to {0} has failed, changes will now be reverted", destinationFileNameFullPath));
44+
UpdateIconAttributes(selectedSearchSource, fullPathToOriginalImage);
4645
#endif
4746
}
4847
}
@@ -61,7 +60,7 @@ internal bool ShouldProvideHint(string fullPathToSelectedImage)
6160

6261
internal async ValueTask<ImageSource> LoadPreviewIconAsync(string pathToPreviewIconImage)
6362
{
64-
return await ImageLoader.LoadAsync(pathToPreviewIconImage);
63+
return await Main._context.API.LoadImageAsync(pathToPreviewIconImage);
6564
}
6665
}
6766
}

0 commit comments

Comments
 (0)