-
Notifications
You must be signed in to change notification settings - Fork 6.5k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[Peek] Add basic file querying and navigation (#22589)
* Refactor to facilitate file data initialization * Extract file-related code to new FileManager class * Add temp basic version * Clean + add todo for cancellations * Fix various nav-related issues * Temp - start moving iteration-related code to bg thread * Minor tweaks * Add FEHelper todo * Rename FileManager + various tweaks * Add basic throttling * Improve bg thread synchronization * Clean * Clean * Rename based on feedback * Rename FileQuery * Rename properties * Rename remaining fields * Add todos for nav success/failures Co-authored-by: Esteban Margaron <emargaron@microsoft.com>
- Loading branch information
1 parent
e1cb01d
commit d4e618c
Showing
7 changed files
with
286 additions
and
43 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,170 @@ | ||
| // Copyright (c) Microsoft Corporation | ||
| // The Microsoft Corporation licenses this file to you under the MIT license. | ||
| // See the LICENSE file in the project root for more information. | ||
|
|
||
| namespace Peek.UI | ||
| { | ||
| using System; | ||
| using System.Collections.Generic; | ||
| using System.Diagnostics; | ||
| using System.Threading; | ||
| using System.Threading.Tasks; | ||
| using CommunityToolkit.Mvvm.ComponentModel; | ||
| using Peek.Common.Models; | ||
| using Peek.UI.Helpers; | ||
|
|
||
| public partial class FolderItemsQuery : ObservableObject | ||
| { | ||
| private const int UninitializedItemIndex = -1; | ||
|
|
||
| public void Clear() | ||
| { | ||
| CurrentFile = null; | ||
|
|
||
| if (InitializeFilesTask != null && InitializeFilesTask.Status == TaskStatus.Running) | ||
| { | ||
| Debug.WriteLine("Detected existing initializeFilesTask running. Cancelling it.."); | ||
| CancellationTokenSource.Cancel(); | ||
| } | ||
|
|
||
| InitializeFilesTask = null; | ||
|
|
||
| lock (_mutateQueryDataLock) | ||
| { | ||
| Files = new List<File>(); | ||
| _currentItemIndex = UninitializedItemIndex; | ||
| } | ||
| } | ||
|
|
||
| public void UpdateCurrentItemIndex(int desiredIndex) | ||
| { | ||
| if (Files.Count <= 1 || _currentItemIndex == UninitializedItemIndex || | ||
| (InitializeFilesTask != null && InitializeFilesTask.Status == TaskStatus.Running)) | ||
| { | ||
| return; | ||
| } | ||
|
|
||
| // Current index wraps around when reaching min/max folder item indices | ||
| desiredIndex %= Files.Count; | ||
| _currentItemIndex = desiredIndex < 0 ? Files.Count + desiredIndex : desiredIndex; | ||
|
|
||
| if (_currentItemIndex < 0 || _currentItemIndex >= Files.Count) | ||
| { | ||
| Debug.Assert(false, "Out of bounds folder item index detected."); | ||
| _currentItemIndex = 0; | ||
| } | ||
|
|
||
| CurrentFile = Files[_currentItemIndex]; | ||
| } | ||
|
|
||
| public void Start() | ||
| { | ||
| var folderView = FileExplorerHelper.GetCurrentFolderView(); | ||
| if (folderView == null) | ||
| { | ||
| return; | ||
| } | ||
|
|
||
| Shell32.FolderItems selectedItems = folderView.SelectedItems(); | ||
| if (selectedItems == null || selectedItems.Count == 0) | ||
| { | ||
| return; | ||
| } | ||
|
|
||
| // Prioritize setting CurrentFile, which notifies UI | ||
| var firstSelectedItem = selectedItems.Item(0); | ||
| CurrentFile = new File(firstSelectedItem.Path); | ||
|
|
||
| var items = selectedItems.Count > 1 ? selectedItems : folderView.Folder?.Items(); | ||
| if (items == null) | ||
| { | ||
| return; | ||
| } | ||
|
|
||
| try | ||
| { | ||
| if (InitializeFilesTask != null && InitializeFilesTask.Status == TaskStatus.Running) | ||
| { | ||
| Debug.WriteLine("Detected unexpected existing initializeFilesTask running. Cancelling it.."); | ||
| CancellationTokenSource.Cancel(); | ||
| } | ||
|
|
||
| CancellationTokenSource = new CancellationTokenSource(); | ||
| InitializeFilesTask = new Task(() => InitializeFiles(items, firstSelectedItem, CancellationTokenSource.Token)); | ||
|
|
||
| // Execute file initialization/querying on background thread | ||
| InitializeFilesTask.Start(); | ||
| } | ||
| catch (Exception e) | ||
| { | ||
| Debug.WriteLine("Exception trying to run initializeFilesTask:\n" + e.ToString()); | ||
| } | ||
| } | ||
|
|
||
| // Finds index of firstSelectedItem either amongst folder items, initializing our internal File list | ||
| // since storing Shell32.FolderItems as a field isn't reliable. | ||
| // Can take a few seconds for folders with 1000s of items; ensure it runs on a background thread. | ||
| // | ||
| // TODO optimization: | ||
| // Handle case where selected items count > 1 separately. Although it'll still be slow for 1000s of items selected, | ||
| // we can leverage faster APIs like Windows.Storage when 1 item is selected, and navigation is scoped to | ||
| // the entire folder. We can then avoid iterating through all items here, and maintain a dynamic window of | ||
| // loaded items around the current item index. | ||
| private void InitializeFiles( | ||
| Shell32.FolderItems items, | ||
| Shell32.FolderItem firstSelectedItem, | ||
| CancellationToken cancellationToken) | ||
| { | ||
| var tempFiles = new List<File>(items.Count); | ||
| var tempCurIndex = UninitializedItemIndex; | ||
|
|
||
| for (int i = 0; i < items.Count; i++) | ||
| { | ||
| cancellationToken.ThrowIfCancellationRequested(); | ||
|
|
||
| var item = items.Item(i); | ||
| if (item == null) | ||
| { | ||
| continue; | ||
| } | ||
|
|
||
| if (item.Name == firstSelectedItem.Name) | ||
| { | ||
| tempCurIndex = i; | ||
| } | ||
|
|
||
| tempFiles.Add(new File(item.Path)); | ||
| } | ||
|
|
||
| if (tempCurIndex == UninitializedItemIndex) | ||
| { | ||
| Debug.WriteLine("File query initialization: selectedItem index not found. Navigation remains disabled."); | ||
| return; | ||
| } | ||
|
|
||
| cancellationToken.ThrowIfCancellationRequested(); | ||
|
|
||
| lock (_mutateQueryDataLock) | ||
| { | ||
| cancellationToken.ThrowIfCancellationRequested(); | ||
| Files = tempFiles; | ||
| _currentItemIndex = tempCurIndex; | ||
| } | ||
| } | ||
|
|
||
| private readonly object _mutateQueryDataLock = new (); | ||
|
|
||
| [ObservableProperty] | ||
| private File? _currentFile; | ||
|
|
||
| private List<File> Files { get; set; } = new (); | ||
|
|
||
| private int _currentItemIndex = UninitializedItemIndex; | ||
|
|
||
| public int CurrentItemIndex => _currentItemIndex; | ||
|
|
||
| private CancellationTokenSource CancellationTokenSource { get; set; } = new CancellationTokenSource(); | ||
|
|
||
| private Task? InitializeFilesTask { get; set; } = null; | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
d4e618cThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@check-spelling-bot Report
🔴 Please review
See the 📜action log for details.
Unrecognized words (131)
Previously acknowledged words that are now absent
brucelindbloom chromaticities companding DCR Eqn ffaa FILETIME HICON ITHUMBNAIL Pbgra PKEY Windowsapp :arrow_right:To accept ✔️ these unrecognized words as correct and remove the previously acknowledged and now absent words, run the following commands
... in a clone of the git@github.com:microsoft/PowerToys.git repository
on the
peekbranch (ℹ️ how do I use this?):Available 📚 dictionaries could cover words not in the 📘 dictionary
This includes both expected items (2140) from .github/actions/spell-check/expect.txt and unrecognized words (131)
Consider adding them using (in
.github/workflows/spelling2.yml):To stop checking additional dictionaries, add:
If the flagged items are 🤯 false positives
If items relate to a ...
binary file (or some other file you wouldn't want to check at all).
Please add a file path to the
excludes.txtfile matching the containing file.File paths are Perl 5 Regular Expressions - you can test yours before committing to verify it will match your files.
^refers to the file's path from the root of the repository, so^README\.md$would exclude README.md (on whichever branch you're using).well-formed pattern.
If you can write a pattern that would match it,
try adding it to the
patterns.txtfile.Patterns are Perl 5 Regular Expressions - you can test yours before committing to verify it will match your lines.
Note that patterns can't match multiline strings.