forked from gui-cs/Terminal.Gui
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Fixes gui-cs#2581 Refactor CollectionNavigator so it supports TableVi…
…ew (gui-cs#2586) * Refactor CollectionNavigator to a base and a collection implementation * Refactor CollectionNavigatorBase to look for first match smartly * Add TableCollectionNavigator * Make TableCollectionNavigator a core part of TableView * Fix bad merge * Added tests for tableview collection navigator * Add FileDialogCollectionNavigator which ignores . and directory separator prefixes on file names * whitespace fixes --------- Co-authored-by: Tig <[email protected]>
- Loading branch information
Showing
7 changed files
with
587 additions
and
430 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,225 +1,40 @@ | ||
| using System; | ||
| using System.Collections; | ||
| using System.Collections.Generic; | ||
| using System.Linq; | ||
|
|
||
| namespace Terminal.Gui { | ||
| /// <summary> | ||
| /// Navigates a collection of items using keystrokes. The keystrokes are used to build a search string. | ||
| /// The <see cref="SearchString"/> is used to find the next item in the collection that matches the search string | ||
| /// when <see cref="GetNextMatchingItem(int, char)"/> is called. | ||
| /// <para> | ||
| /// If the user types keystrokes that can't be found in the collection, | ||
| /// the search string is cleared and the next item is found that starts with the last keystroke. | ||
| /// </para> | ||
| /// <para> | ||
| /// If the user pauses keystrokes for a short time (see <see cref="TypingDelay"/>), the search string is cleared. | ||
| /// </para> | ||
| /// </summary> | ||
| public partial class CollectionNavigator { | ||
| /// <summary> | ||
| /// Constructs a new CollectionNavigator. | ||
| /// </summary> | ||
| public CollectionNavigator () { } | ||
|
|
||
| /// <summary> | ||
| /// Constructs a new CollectionNavigator for the given collection. | ||
| /// </summary> | ||
| /// <param name="collection"></param> | ||
| public CollectionNavigator (IEnumerable<object> collection) => Collection = collection; | ||
|
|
||
| DateTime lastKeystroke = DateTime.Now; | ||
| /// <summary> | ||
| /// Gets or sets the number of milliseconds to delay before clearing the search string. The delay is | ||
| /// reset on each call to <see cref="GetNextMatchingItem(int, char)"/>. The default is 500ms. | ||
| /// </summary> | ||
| public int TypingDelay { get; set; } = 500; | ||
|
|
||
| /// <summary> | ||
| /// The compararer function to use when searching the collection. | ||
| /// </summary> | ||
| public StringComparer Comparer { get; set; } = StringComparer.InvariantCultureIgnoreCase; | ||
|
|
||
| /// <inheritdoc/> | ||
| /// <remarks>This implementation is based on a static <see cref="Collection"/> of objects.</remarks> | ||
| public class CollectionNavigator : CollectionNavigatorBase { | ||
| /// <summary> | ||
| /// The collection of objects to search. <see cref="object.ToString()"/> is used to search the collection. | ||
| /// </summary> | ||
| public IEnumerable<object> Collection { get; set; } | ||
|
|
||
| /// <summary> | ||
| /// This event is invoked when <see cref="SearchString"/> changes. Useful for debugging. | ||
| /// </summary> | ||
| public event EventHandler<KeystrokeNavigatorEventArgs> SearchStringChanged; | ||
|
|
||
| private string _searchString = ""; | ||
| /// <summary> | ||
| /// Gets the current search string. This includes the set of keystrokes that have been pressed | ||
| /// since the last unsuccessful match or after <see cref="TypingDelay"/>) milliseconds. Useful for debugging. | ||
| /// </summary> | ||
| public string SearchString { | ||
| get => _searchString; | ||
| private set { | ||
| _searchString = value; | ||
| OnSearchStringChanged (new KeystrokeNavigatorEventArgs (value)); | ||
| } | ||
| } | ||
| public IList Collection { get; set; } | ||
|
|
||
| /// <summary> | ||
| /// Invoked when the <see cref="SearchString"/> changes. Useful for debugging. Invokes the <see cref="SearchStringChanged"/> event. | ||
| /// </summary> | ||
| /// <param name="e"></param> | ||
| public virtual void OnSearchStringChanged (KeystrokeNavigatorEventArgs e) | ||
| { | ||
| SearchStringChanged?.Invoke (this, e); | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Gets the index of the next item in the collection that matches the current <see cref="SearchString"/> plus the provided character (typically | ||
| /// from a key press). | ||
| /// Constructs a new CollectionNavigator. | ||
| /// </summary> | ||
| /// <param name="currentIndex">The index in the collection to start the search from.</param> | ||
| /// <param name="keyStruck">The character of the key the user pressed.</param> | ||
| /// <returns>The index of the item that matches what the user has typed. | ||
| /// Returns <see langword="-1"/> if no item in the collection matched.</returns> | ||
| public int GetNextMatchingItem (int currentIndex, char keyStruck) | ||
| { | ||
| AssertCollectionIsNotNull (); | ||
| if (!char.IsControl (keyStruck)) { | ||
|
|
||
| // maybe user pressed 'd' and now presses 'd' again. | ||
| // a candidate search is things that begin with "dd" | ||
| // but if we find none then we must fallback on cycling | ||
| // d instead and discard the candidate state | ||
| string candidateState = ""; | ||
|
|
||
| // is it a second or third (etc) keystroke within a short time | ||
| if (SearchString.Length > 0 && DateTime.Now - lastKeystroke < TimeSpan.FromMilliseconds (TypingDelay)) { | ||
| // "dd" is a candidate | ||
| candidateState = SearchString + keyStruck; | ||
| } else { | ||
| // its a fresh keystroke after some time | ||
| // or its first ever key press | ||
| SearchString = new string (keyStruck, 1); | ||
| } | ||
|
|
||
| var idxCandidate = GetNextMatchingItem (currentIndex, candidateState, | ||
| // prefer not to move if there are multiple characters e.g. "ca" + 'r' should stay on "car" and not jump to "cart" | ||
| candidateState.Length > 1); | ||
|
|
||
| if (idxCandidate != -1) { | ||
| // found "dd" so candidate searchstring is accepted | ||
| lastKeystroke = DateTime.Now; | ||
| SearchString = candidateState; | ||
| return idxCandidate; | ||
| } | ||
|
|
||
| //// nothing matches "dd" so discard it as a candidate | ||
| //// and just cycle "d" instead | ||
| lastKeystroke = DateTime.Now; | ||
| idxCandidate = GetNextMatchingItem (currentIndex, candidateState); | ||
|
|
||
| // if a match wasn't found, the user typed a 'wrong' key in their search ("can" + 'z' | ||
| // instead of "can" + 'd'). | ||
| if (SearchString.Length > 1 && idxCandidate == -1) { | ||
| // ignore it since we're still within the typing delay | ||
| // don't add it to SearchString either | ||
| return currentIndex; | ||
| } | ||
|
|
||
| // if no changes to current state manifested | ||
| if (idxCandidate == currentIndex || idxCandidate == -1) { | ||
| // clear history and treat as a fresh letter | ||
| ClearSearchString (); | ||
|
|
||
| // match on the fresh letter alone | ||
| SearchString = new string (keyStruck, 1); | ||
| idxCandidate = GetNextMatchingItem (currentIndex, SearchString); | ||
| return idxCandidate == -1 ? currentIndex : idxCandidate; | ||
| } | ||
|
|
||
| // Found another "d" or just leave index as it was | ||
| return idxCandidate; | ||
|
|
||
| } else { | ||
| // clear state because keypress was a control char | ||
| ClearSearchString (); | ||
|
|
||
| // control char indicates no selection | ||
| return -1; | ||
| } | ||
| } | ||
| public CollectionNavigator () { } | ||
|
|
||
| /// <summary> | ||
| /// Gets the index of the next item in the collection that matches <paramref name="search"/>. | ||
| /// Constructs a new CollectionNavigator for the given collection. | ||
| /// </summary> | ||
| /// <param name="currentIndex">The index in the collection to start the search from.</param> | ||
| /// <param name="search">The search string to use.</param> | ||
| /// <param name="minimizeMovement">Set to <see langword="true"/> to stop the search on the first match | ||
| /// if there are multiple matches for <paramref name="search"/>. | ||
| /// e.g. "ca" + 'r' should stay on "car" and not jump to "cart". If <see langword="false"/> (the default), | ||
| /// the next matching item will be returned, even if it is above in the collection. | ||
| /// </param> | ||
| /// <returns>The index of the next matching item or <see langword="-1"/> if no match was found.</returns> | ||
| internal int GetNextMatchingItem (int currentIndex, string search, bool minimizeMovement = false) | ||
| { | ||
| if (string.IsNullOrEmpty (search)) { | ||
| return -1; | ||
| } | ||
| AssertCollectionIsNotNull (); | ||
|
|
||
| // find indexes of items that start with the search text | ||
| int [] matchingIndexes = Collection.Select ((item, idx) => (item, idx)) | ||
| .Where (k => k.item?.ToString ().StartsWith (search, StringComparison.InvariantCultureIgnoreCase) ?? false) | ||
| .Select (k => k.idx) | ||
| .ToArray (); | ||
|
|
||
| // if there are items beginning with search | ||
| if (matchingIndexes.Length > 0) { | ||
| // is one of them currently selected? | ||
| var currentlySelected = Array.IndexOf (matchingIndexes, currentIndex); | ||
|
|
||
| if (currentlySelected == -1) { | ||
| // we are not currently selecting any item beginning with the search | ||
| // so jump to first item in list that begins with the letter | ||
| return matchingIndexes [0]; | ||
| } else { | ||
|
|
||
| // the current index is part of the matching collection | ||
| if (minimizeMovement) { | ||
| // if we would rather not jump around (e.g. user is typing lots of text to get this match) | ||
| return matchingIndexes [currentlySelected]; | ||
| } | ||
|
|
||
| // cycle to next (circular) | ||
| return matchingIndexes [(currentlySelected + 1) % matchingIndexes.Length]; | ||
| } | ||
| } | ||
|
|
||
| // nothing starts with the search | ||
| return -1; | ||
| } | ||
| /// <param name="collection"></param> | ||
| public CollectionNavigator (IList collection) => Collection = collection; | ||
|
|
||
| private void AssertCollectionIsNotNull () | ||
| /// <inheritdoc/> | ||
| protected override object ElementAt (int idx) | ||
| { | ||
| if (Collection == null) { | ||
| throw new InvalidOperationException ("Collection is null"); | ||
| } | ||
| return Collection [idx]; | ||
| } | ||
|
|
||
| private void ClearSearchString () | ||
| /// <inheritdoc/> | ||
| protected override int GetCollectionLength () | ||
| { | ||
| SearchString = ""; | ||
| lastKeystroke = DateTime.Now; | ||
| return Collection.Count; | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Returns true if <paramref name="kb"/> is a searchable key | ||
| /// (e.g. letters, numbers, etc) that are valid to pass to this | ||
| /// class for search filtering. | ||
| /// </summary> | ||
| /// <param name="kb"></param> | ||
| /// <returns></returns> | ||
| public static bool IsCompatibleKey (KeyEvent kb) | ||
| { | ||
| return !kb.IsAlt && !kb.IsCtrl; | ||
| } | ||
| } | ||
| } |
Oops, something went wrong.