using System; using System.Collections.Generic; using System.Linq; namespace Terminal.Gui { /// /// Navigates a collection of items using keystrokes. The keystrokes are used to build a search string. /// The is used to find the next item in the collection that matches the search string /// when is called. /// /// 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. /// /// /// If the user pauses keystrokes for a short time (see ), the search string is cleared. /// /// public partial class CollectionNavigator { /// /// Constructs a new CollectionNavigator. /// public CollectionNavigator () { } /// /// Constructs a new CollectionNavigator for the given collection. /// /// public CollectionNavigator (IEnumerable collection) => Collection = collection; DateTime lastKeystroke = DateTime.Now; /// /// Gets or sets the number of milliseconds to delay before clearing the search string. The delay is /// reset on each call to . The default is 500ms. /// public int TypingDelay { get; set; } = 500; /// /// The compararer function to use when searching the collection. /// public StringComparer Comparer { get; set; } = StringComparer.InvariantCultureIgnoreCase; /// /// The collection of objects to search. is used to search the collection. /// public IEnumerable Collection { get; set; } /// /// This event is invoked when changes. Useful for debugging. /// public event EventHandler SearchStringChanged; private string _searchString = ""; /// /// Gets the current search string. This includes the set of keystrokes that have been pressed /// since the last unsuccessful match or after ) milliseconds. Useful for debugging. /// public string SearchString { get => _searchString; private set { _searchString = value; OnSearchStringChanged (new KeystrokeNavigatorEventArgs (value)); } } /// /// Invoked when the changes. Useful for debugging. Invokes the event. /// /// public virtual void OnSearchStringChanged (KeystrokeNavigatorEventArgs e) { SearchStringChanged?.Invoke (this, e); } /// /// Gets the index of the next item in the collection that matches the current plus the provided character (typically /// from a key press). /// /// The index in the collection to start the search from. /// The character of the key the user pressed. /// The index of the item that matches what the user has typed. /// Returns if no item in the collection matched. 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; } } /// /// Gets the index of the next item in the collection that matches . /// /// The index in the collection to start the search from. /// The search string to use. /// Set to to stop the search on the first match /// if there are multiple matches for . /// e.g. "ca" + 'r' should stay on "car" and not jump to "cart". If (the default), /// the next matching item will be returned, even if it is above in the collection. /// /// The index of the next matching item or if no match was found. 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; } private void AssertCollectionIsNotNull () { if (Collection == null) { throw new InvalidOperationException ("Collection is null"); } } private void ClearSearchString () { SearchString = ""; lastKeystroke = DateTime.Now; } /// /// Returns true if is a searchable key /// (e.g. letters, numbers etc) that is valid to pass to to this /// class for search filtering. /// /// /// public static bool IsCompatibleKey (KeyEvent kb) { return !kb.IsAlt && !kb.IsCapslock && !kb.IsCtrl && !kb.IsScrolllock && !kb.IsNumlock; } } }