TokenizingTextBoxItem.AutoSuggestBox.cs

// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
// See the LICENSE file in the project root for more information.

using Windows.System;

#if WINAPPSDK
using Microsoft.UI;
#else
using Windows.UI;
#endif

namespace CommunityToolkit.WinUI.Controls;

/// <summary>
/// A control that manages as the item logic for the <see cref="TokenizingTextBox"/> control.
/// </summary>
[System.Diagnostics.CodeAnalysis.SuppressMessage("StyleCop.CSharp.ReadabilityRules", "SA1124:Do not use regions", Justification = "Organization")]
[TemplatePart(Name = PART_AutoSuggestBox, Type = typeof(AutoSuggestBox))] //// String case
[TemplatePart(Name = PART_TokensCounter, Type = typeof(TextBlock))]
public partial class TokenizingTextBoxItem
{
    private const string PART_AutoSuggestBox = "PART_AutoSuggestBox";
    private const string PART_TokensCounter = "PART_TokensCounter";
    private const string QueryButton = "QueryButton";

    private AutoSuggestBox _autoSuggestBox;

    [System.Diagnostics.CodeAnalysis.SuppressMessage("StyleCop.CSharp.MaintainabilityRules", "SA1401:Fields should be private", Justification = "Tight Coupling with Parent for Selection control.")]
    internal TextBox _autoSuggestTextBox;

    /// <summary>
    /// Event raised when the 'Clear' Button is clicked.
    /// </summary>
    internal event TypedEventHandler<TokenizingTextBoxItem, RoutedEventArgs> AutoSuggestTextBoxLoaded;

    internal bool UseCharacterAsUser { get; set; }

    /// <summary>
    /// Gets a value indicating whether the textbox caret is in the first position. False otherwise
    /// </summary>
    private bool IsCaretAtStart => _autoSuggestTextBox?.SelectionStart == 0;

    /// <summary>
    /// Gets a value indicating whether the textbox caret is in the last position. False otherwise
    /// </summary>
    private bool IsCaretAtEnd => _autoSuggestTextBox?.SelectionStart == _autoSuggestTextBox?.Text.Length ||
                                 _autoSuggestTextBox?.SelectionStart + _autoSuggestTextBox?.SelectionLength == _autoSuggestTextBox?.Text.Length;

    /// <summary>
    /// Gets a value indicating whether all text in the text box is currently selected. False otherwise.
    /// </summary>
    private bool IsAllSelected => _autoSuggestTextBox?.SelectedText == _autoSuggestTextBox?.Text && !string.IsNullOrEmpty(_autoSuggestTextBox?.Text);

    /// <summary>
    /// Used to track if we're on the first character of the textbox while there is selected text
    /// </summary>
    private bool _isSelectedFocusOnFirstCharacter = false;

    /// <summary>
    /// Used to track if we're on the last character of the textbox while there is selected text
    /// </summary>
    private bool _isSelectedFocusOnLastCharacter = false;

    /// Called from <see cref="OnApplyTemplate"/>
    private void OnApplyTemplateAutoSuggestBox(AutoSuggestBox auto)
    {
        if (_autoSuggestBox != null)
        {
            _autoSuggestBox.Loaded -= OnASBLoaded;

            _autoSuggestBox.QuerySubmitted -= AutoSuggestBox_QuerySubmitted;
            _autoSuggestBox.SuggestionChosen -= AutoSuggestBox_SuggestionChosen;
            _autoSuggestBox.TextChanged -= AutoSuggestBox_TextChanged;
            _autoSuggestBox.PointerEntered -= AutoSuggestBox_PointerEntered;
            _autoSuggestBox.PointerExited -= AutoSuggestBox_PointerExited;
            _autoSuggestBox.PointerCanceled -= AutoSuggestBox_PointerExited;
            _autoSuggestBox.PointerCaptureLost -= AutoSuggestBox_PointerExited;
            _autoSuggestBox.GotFocus -= AutoSuggestBox_GotFocus;
            _autoSuggestBox.LostFocus -= AutoSuggestBox_LostFocus;

            // Remove any previous QueryIcon
            _autoSuggestBox.QueryIcon = null;
        }

        _autoSuggestBox = auto;

        if (_autoSuggestBox != null)
        {
            _autoSuggestBox.Loaded += OnASBLoaded;

            _autoSuggestBox.QuerySubmitted += AutoSuggestBox_QuerySubmitted;
            _autoSuggestBox.SuggestionChosen += AutoSuggestBox_SuggestionChosen;
            _autoSuggestBox.TextChanged += AutoSuggestBox_TextChanged;
            _autoSuggestBox.PointerEntered += AutoSuggestBox_PointerEntered;
            _autoSuggestBox.PointerExited += AutoSuggestBox_PointerExited;
            _autoSuggestBox.PointerCanceled += AutoSuggestBox_PointerExited;
            _autoSuggestBox.PointerCaptureLost += AutoSuggestBox_PointerExited;
            _autoSuggestBox.GotFocus += AutoSuggestBox_GotFocus;
            _autoSuggestBox.LostFocus += AutoSuggestBox_LostFocus;

            // Setup a binding to the QueryIcon of the Parent if we're the last box.
            if (Content is ITokenStringContainer str)
            {
                // We need to set our initial text in all cases.
                _autoSuggestBox.Text = str.Text;

                // We only set/bind some properties on the last textbox to mimic the autosuggestbox look
                if (str.IsLast)
                {
                    // Workaround for https://github.com/microsoft/microsoft-ui-xaml/issues/2568
                    if (Owner.QueryIcon is FontIconSource fis &&
                        fis.ReadLocalValue(FontIconSource.FontSizeProperty) == DependencyProperty.UnsetValue)
                    {
                        // This can be expensive, could we optimize?
                        // Also, this is changing the FontSize on the IconSource (which could be shared?)
                        fis.FontSize = Owner.TryFindResource("TokenizingTextBoxIconFontSize") as double? ?? 16;
                    }

                    var iconBinding = new Binding()
                    {
                        Source = Owner,
                        Path = new PropertyPath(nameof(Owner.QueryIcon)),
                        RelativeSource = new RelativeSource() { Mode = RelativeSourceMode.TemplatedParent }
                    };

                    #if !HAS_UNO
                    var iconSourceElement = new IconSourceElement();
                    iconSourceElement.SetBinding(IconSourceElement.IconSourceProperty, iconBinding);
                    _autoSuggestBox.QueryIcon = iconSourceElement;
                    #endif
                }
            }
        }
    }

    #region AutoSuggestBox
    private async void AutoSuggestBox_QuerySubmitted(AutoSuggestBox sender, AutoSuggestBoxQuerySubmittedEventArgs args)
    {
        Owner.RaiseQuerySubmitted(sender, args);

        object? chosenItem = null;
        if (args.ChosenSuggestion != null)
        {
            chosenItem = args.ChosenSuggestion;
        }
        else if (!string.IsNullOrWhiteSpace(args.QueryText))
        {
            chosenItem = args.QueryText;
        }

        if (chosenItem != null)
        {
            await Owner.AddTokenAsync(chosenItem); // TODO: Need to pass index?
            sender.Text = string.Empty;
            Owner.Text = string.Empty;
            sender.Focus(FocusState.Programmatic);
        }
    }

    private void AutoSuggestBox_SuggestionChosen(AutoSuggestBox sender, AutoSuggestBoxSuggestionChosenEventArgs args)
    {
        Owner.RaiseSuggestionChosen(sender, args);
    }

    // Called to update text by link:TokenizingTextBox.Properties.cs:TextPropertyChanged
    internal void UpdateText(string text)
    {
        if (_autoSuggestBox != null)
        {
            _autoSuggestBox.Text = text;
        }
        else
        {
            void WaitForLoad(object s, RoutedEventArgs eargs)
            {
                if (_autoSuggestTextBox != null)
                {
                    _autoSuggestTextBox.Text = text;
                }

                AutoSuggestTextBoxLoaded -= WaitForLoad;
            }

            AutoSuggestTextBoxLoaded += WaitForLoad;
        }
    }

    private void AutoSuggestBox_TextChanged(AutoSuggestBox sender, AutoSuggestBoxTextChangedEventArgs args)
    {
        if (sender.Text == null)
        {
            return;
        }

        if (!EqualityComparer<string>.Default.Equals(sender.Text, Owner.Text))
        {
            Owner.Text = sender.Text; // Update parent text property, if different
        }

        // Override our programmatic manipulation as we're redirecting input for the user
        if (UseCharacterAsUser)
        {
            UseCharacterAsUser = false;

            args.Reason = AutoSuggestionBoxTextChangeReason.UserInput;
        }

        Owner.RaiseTextChanged(sender, args);

        var t = sender.Text?.Trim() ?? string.Empty;

        // Look for Token Delimiters to create new tokens when text changes.
        if (!string.IsNullOrEmpty(Owner.TokenDelimiter) && t.Contains(Owner.TokenDelimiter))
        {
            bool lastDelimited = t[t.Length - 1] == Owner.TokenDelimiter[0];

#if HAS_UNO
            string[] tokens = t.Split(new[] { Owner.TokenDelimiter }, System.StringSplitOptions.RemoveEmptyEntries);
#else
            string[] tokens = t.Split(Owner.TokenDelimiter);
#endif
            int numberToProcess = lastDelimited ? tokens.Length : tokens.Length - 1;
            for (int position = 0; position < numberToProcess; position++)
            {
                string token = tokens[position];
                token = token.Trim();
                if (token.Length > 0)
                {
                    _ = Owner.AddTokenAsync(token); //// TODO: Pass Index?
                }
            }

            if (lastDelimited)
            {
                sender.Text = string.Empty;
            }
            else
            {
                sender.Text = tokens[tokens.Length - 1].Trim();
            }
        }
    }
#endregion

    #region Visual State Management for Parent
    private void AutoSuggestBox_PointerEntered(object sender, PointerRoutedEventArgs e)
    {
        VisualStateManager.GoToState(Owner, TokenizingTextBox.PART_PointerOverState, true);
    }

    private void AutoSuggestBox_PointerExited(object sender, PointerRoutedEventArgs e)
    {
        VisualStateManager.GoToState(Owner, TokenizingTextBox.PART_NormalState, true);
    }

    private void AutoSuggestBox_LostFocus(object sender, RoutedEventArgs e)
    {
        VisualStateManager.GoToState(Owner, TokenizingTextBox.PART_UnfocusedState, true);
    }

    private void AutoSuggestBox_GotFocus(object sender, RoutedEventArgs e)
    {
        // Verify if the usual behavior of clearing token selection is required
        if (Owner.PauseTokenClearOnFocus == false && !TokenizingTextBox.IsShiftPressed)
        {
            // Clear any selected tokens
            Owner.DeselectAll();
        }

        Owner.PauseTokenClearOnFocus = false;

        VisualStateManager.GoToState(Owner, TokenizingTextBox.PART_FocusedState, true);
    }
    #endregion

    #region Inner TextBox
    private void OnASBLoaded(object sender, RoutedEventArgs e)
    {
        UpdateQueryIconVisibility();
        UpdateTokensCounter(this);

        // Local function for Selection changed
        void AutoSuggestTextBox_SelectionChanged(object box, RoutedEventArgs args)
        {
            if (!(IsAllSelected || TokenizingTextBox.IsShiftPressed || Owner.IsClearingForClick))
            {
                Owner.DeselectAllTokensAndText(this);
            }

            // Ensure flag is always reset
            Owner.IsClearingForClick = false;
        }

        // local function for clearing selection on interaction with text box
        async void AutoSuggestTextBox_TextChangingAsync(TextBox o, TextBoxTextChangingEventArgs args)
        {
            // remove any selected tokens.
            if (Owner.SelectedItems.Count > 1)
            {
                await Owner.RemoveAllSelectedTokens();
            }
        }

        if (_autoSuggestTextBox != null)
        {
            _autoSuggestTextBox.PreviewKeyDown -= this.AutoSuggestTextBox_PreviewKeyDown;
            _autoSuggestTextBox.TextChanging -= AutoSuggestTextBox_TextChangingAsync;
            _autoSuggestTextBox.SelectionChanged -= AutoSuggestTextBox_SelectionChanged;
            _autoSuggestTextBox.SelectionChanging -= AutoSuggestTextBox_SelectionChanging;
        }

        _autoSuggestTextBox = _autoSuggestBox.FindDescendant<TextBox>()!;

        if (_autoSuggestTextBox != null)
        {
            _autoSuggestTextBox.PreviewKeyDown += this.AutoSuggestTextBox_PreviewKeyDown;
            _autoSuggestTextBox.TextChanging += AutoSuggestTextBox_TextChangingAsync;
            _autoSuggestTextBox.SelectionChanged += AutoSuggestTextBox_SelectionChanged;
            _autoSuggestTextBox.SelectionChanging += AutoSuggestTextBox_SelectionChanging;

            AutoSuggestTextBoxLoaded?.Invoke(this, e);
        }
    }

    private void AutoSuggestTextBox_SelectionChanging(TextBox sender, TextBoxSelectionChangingEventArgs args)
    {
#if !HAS_UNO
        _isSelectedFocusOnFirstCharacter = args.SelectionLength > 0 && args.SelectionStart == 0 && _autoSuggestTextBox.SelectionStart > 0;
        _isSelectedFocusOnLastCharacter =
            //// see if we are NOW on the last character.
            //// test if the new selection includes the last character, and the current selection doesn't
            (args.SelectionStart + args.SelectionLength == _autoSuggestTextBox.Text.Length) &&
            (_autoSuggestTextBox.SelectionStart + _autoSuggestTextBox.SelectionLength != _autoSuggestTextBox.Text.Length);
#endif
    }

    private void AutoSuggestTextBox_PreviewKeyDown(object sender, KeyRoutedEventArgs e)
    {
        if (IsCaretAtStart &&
            (e.Key == VirtualKey.Back ||
             e.Key == VirtualKey.Left))
        {
            // if the back key is pressed and there is any selection in the text box then the text box can handle it
            if ((e.Key == VirtualKey.Left && _isSelectedFocusOnFirstCharacter) ||
                _autoSuggestTextBox.SelectionLength == 0)
            {
                if (Owner.SelectPreviousItem(this))
                {
                    if (!TokenizingTextBox.IsShiftPressed)
                    {
                        // Clear any text box selection
                        _autoSuggestTextBox.SelectionLength = 0;
                    }

                    e.Handled = true;
                }
            }
        }
        else if (IsCaretAtEnd && e.Key == VirtualKey.Right)
        {
            // if the back key is pressed and there is any selection in the text box then the text box can handle it
            if (_isSelectedFocusOnLastCharacter || _autoSuggestTextBox.SelectionLength == 0)
            {
                if (Owner.SelectNextItem(this))
                {
                    if (!TokenizingTextBox.IsShiftPressed)
                    {
                        // Clear any text box selection
                        _autoSuggestTextBox.SelectionLength = 0;
                    }

                    e.Handled = true;
                }
            }
        }
        else if (e.Key == VirtualKey.A && Owner.IsControlPressed)
        {
            // Need to provide this shortcut from the textbox only, as ListViewBase will do it for us on token.
            Owner.SelectAllTokensAndText();
        }
    }

    private void UpdateTokensCounter(TokenizingTextBoxItem ttbi)
    {
        if (_autoSuggestBox?.FindDescendant(PART_TokensCounter) is TextBlock maxTokensCounter)
        {
            void OnTokenCountChanged(TokenizingTextBox ttb, object? value = null)
            {
                if (ttb.ItemsSource is InterspersedObservableCollection itemsSource)
                {
                    var currentTokens = itemsSource.ItemsSource.Count;
                    var maxTokens = ttb.MaximumTokens;

                    maxTokensCounter.Text = $"{currentTokens}/{maxTokens}";
                    maxTokensCounter.Visibility = Visibility.Visible;

                    maxTokensCounter.Foreground = (currentTokens >= maxTokens)
                        ? (SolidColorBrush)Application.Current.Resources["SystemFillColorCriticalBrush"]
                        : (SolidColorBrush)Application.Current.Resources["TextFillColorSecondaryBrush"];
                }
            }

            ttbi.Owner.TokenItemAdded -= OnTokenCountChanged;
            ttbi.Owner.TokenItemRemoved -= OnTokenCountChanged;

            if (Content is ITokenStringContainer str && str.IsLast && ttbi?.Owner != null && ttbi.Owner.ReadLocalValue(TokenizingTextBox.MaximumTokensProperty) != DependencyProperty.UnsetValue)
            {
                ttbi.Owner.TokenItemAdded += OnTokenCountChanged;
                ttbi.Owner.TokenItemRemoved += OnTokenCountChanged;
                OnTokenCountChanged(ttbi.Owner);
            }
            else
            {
                maxTokensCounter.Visibility = Visibility.Collapsed;
                maxTokensCounter.Text = string.Empty;
            }
        }
    }

        internal void UpdateQueryIconVisibility()
    {
        if (_autoSuggestBox?.FindDescendant(QueryButton) is Button queryButton)
        {
            if (Owner.QueryIcon != null)
            {
                queryButton.Visibility = Visibility.Visible;
            }
            else
            {
                queryButton.Visibility = Visibility.Collapsed;
            }
        }       
    }
#endregion
}