gui-cs.Terminal.Gui/Terminal.Gui/Views/CheckBox.cs

namespace Terminal.Gui;

/// <summary>The <see cref="CheckBox"/> <see cref="View"/> shows an on/off toggle that the user can set</summary>
public class CheckBox : View
{
    private readonly Rune _charChecked;
    private readonly Rune _charNullChecked;
    private readonly Rune _charUnChecked;
    private bool _allowNullChecked;
    private bool? _checked = false;

    /// <summary>
    ///     Initializes a new instance of <see cref="CheckBox"/> based on the given text, using
    ///     <see cref="LayoutStyle.Computed"/> layout.
    /// </summary>
    public CheckBox ()
    {
        _charNullChecked = Glyphs.NullChecked;
        _charChecked = Glyphs.Checked;
        _charUnChecked = Glyphs.UnChecked;
        HotKeySpecifier = (Rune)'_';

        // Ensures a height of 1 if AutoSize is set to false
        Height = 1;

        CanFocus = true;
        AutoSize = true;

        // Things this view knows how to do
        AddCommand (Command.ToggleChecked, () => ToggleChecked ());

        AddCommand (
                    Command.Accept,
                    () =>
                    {
                        if (!HasFocus)
                        {
                            SetFocus ();
                        }

                        ToggleChecked ();

                        return true;
                    }
                   );

        // Default keybindings for this view
        KeyBindings.Add (Key.Space, Command.ToggleChecked);
    }

    /// <summary>
    ///     If <see langword="true"/> allows <see cref="Checked"/> to be null, true or false. If <see langword="false"/>
    ///     only allows <see cref="Checked"/> to be true or false.
    /// </summary>
    public bool AllowNullChecked
    {
        get => _allowNullChecked;
        set
        {
            _allowNullChecked = value;
            Checked ??= false;
        }
    }

    /// <summary>The state of the <see cref="CheckBox"/></summary>
    public bool? Checked
    {
        get => _checked;
        set
        {
            if (value is null && !AllowNullChecked)
            {
                return;
            }

            _checked = value;
            UpdateTextFormatterText ();
            OnResizeNeeded ();
        }
    }

    /// <inheritdoc/>
    public override Key HotKey
    {
        get => base.HotKey;
        set
        {
            if (value is null)
            {
                throw new ArgumentException (nameof (value));
            }

            Key prev = base.HotKey;

            if (prev != value)
            {
                base.HotKey = TextFormatter.HotKey = value;

                // Also add Alt+HotKey
                if (prev != Key.Empty && KeyBindings.TryGet (prev.WithAlt, out _))
                {
                    if (value.KeyCode == KeyCode.Null)
                    {
                        KeyBindings.Remove (prev.WithAlt);
                    }
                    else
                    {
                        KeyBindings.Replace (prev.WithAlt, value.WithAlt);
                    }
                }
                else if (value != Key.Empty)
                {
                    KeyBindings.Add (value.WithAlt, Command.Accept);
                }
            }
        }
    }

    /// <inheritdoc/>
    public override bool MouseEvent (MouseEvent me)
    {
        if (!me.Flags.HasFlag (MouseFlags.Button1Clicked) || !CanFocus)
        {
            return false;
        }

        ToggleChecked ();

        return true;
    }

    /// <inheritdoc/>
    public override bool OnEnter (View view)
    {
        Application.Driver.SetCursorVisibility (CursorVisibility.Invisible);

        return base.OnEnter (view);
    }

    /// <summary>Called when the <see cref="Checked"/> property changes. Invokes the <see cref="Toggled"/> event.</summary>
    public virtual void OnToggled (ToggleEventArgs e) { Toggled?.Invoke (this, e); }

    /// <inheritdoc/>
    public override void PositionCursor () { Move (0, 0); }

    /// <summary>Toggled event, raised when the <see cref="CheckBox"/>  is toggled.</summary>
    /// <remarks>
    ///     Client code can hook up to this event, it is raised when the <see cref="CheckBox"/> is activated either with
    ///     the mouse or the keyboard. The passed <c>bool</c> contains the previous state.
    /// </remarks>
    public event EventHandler<ToggleEventArgs> Toggled;

    /// <inheritdoc/>
    protected override void UpdateTextFormatterText ()
    {
        switch (TextAlignment)
        {
            case TextAlignment.Left:
            case TextAlignment.Centered:
            case TextAlignment.Justified:
                TextFormatter.Text = $"{GetCheckedState ()} {GetFormatterText ()}";

                break;
            case TextAlignment.Right:
                TextFormatter.Text = $"{GetFormatterText ()} {GetCheckedState ()}";

                break;
        }
    }

    private Rune GetCheckedState ()
    {
        return Checked switch
               {
                   true => _charChecked,
                   false => _charUnChecked,
                   var _ => _charNullChecked
               };
    }

    private string GetFormatterText ()
    {
        if (AutoSize || string.IsNullOrEmpty (Text) || Frame.Width <= 2)
        {
            return Text;
        }

        return Text [..Math.Min (Frame.Width - 2, Text.GetRuneCount ())];
    }

    private bool ToggleChecked ()
    {
        if (!HasFocus)
        {
            SetFocus ();
        }

        bool? previousChecked = Checked;

        if (AllowNullChecked)
        {
            switch (previousChecked)
            {
                case null:
                    Checked = true;

                    break;
                case true:
                    Checked = false;

                    break;
                case false:
                    Checked = null;

                    break;
            }
        }
        else
        {
            Checked = !Checked;
        }

        OnToggled (new ToggleEventArgs (previousChecked, Checked));
        SetNeedsDisplay ();

        return true;
    }
}