gui-cs.Terminal.Gui/UnitTests/Views/ScrollTests.cs

using Xunit.Abstractions;

namespace Terminal.Gui.ViewsTests;

public class ScrollTests
{
    public ScrollTests (ITestOutputHelper output) { _output = output; }
    private readonly ITestOutputHelper _output;

    [Theory]
    [AutoInitShutdown]
    [InlineData (
                    20,
                    @"
█
█
█
█
█
░
░
░
░
░",
                    @"
░
░
█
█
█
█
█
░
░
░",
                    @"
░
░
░
░
░
█
█
█
█
█",
                    @"
░
░
█
█
█
░
░
░
░
░",
                    @"
█████░░░░░",
                    @"
░░█████░░░",
                    @"
░░░░░█████",
                    @"
░░███░░░░░")]
    [InlineData (
                    40,
                    @"
█
█
█
░
░
░
░
░
░
░",
                    @"
░
█
█
█
░
░
░
░
░
░",
                    @"
░
░
█
█
█
░
░
░
░
░",
                    @"
░
█
█
░
░
░
░
░
░
░",
                    @"
███░░░░░░░",
                    @"
░███░░░░░░",
                    @"
░░███░░░░░",
                    @"
░██░░░░░░░")]
    public void Changing_Position_Size_Orientation_Draws_Correctly (
        int size,
        string firstVertExpected,
        string middleVertExpected,
        string endVertExpected,
        string sizeVertExpected,
        string firstHoriExpected,
        string middleHoriExpected,
        string endHoriExpected,
        string sizeHoriExpected
    )
    {
        var scroll = new Scroll
        {
            Orientation = Orientation.Vertical,
            Size = size,
            Height = 10
        };
        var top = new Toplevel ();
        top.Add (scroll);
        Application.Begin (top);

        _ = TestHelpers.AssertDriverContentsWithFrameAre (firstVertExpected, _output);

        scroll.Position = 4;
        Application.Refresh ();

        _ = TestHelpers.AssertDriverContentsWithFrameAre (middleVertExpected, _output);

        scroll.Position = 10;
        Application.Refresh ();

        _ = TestHelpers.AssertDriverContentsWithFrameAre (endVertExpected, _output);

        scroll.Size = size * 2;
        Application.Refresh ();

        _ = TestHelpers.AssertDriverContentsWithFrameAre (sizeVertExpected, _output);

        scroll.Orientation = Orientation.Horizontal;
        scroll.Width = 10;
        scroll.Height = 1;
        scroll.Position = 0;
        scroll.Size = size;
        Application.Refresh ();

        _ = TestHelpers.AssertDriverContentsWithFrameAre (firstHoriExpected, _output);

        scroll.Position = 4;
        Application.Refresh ();

        _ = TestHelpers.AssertDriverContentsWithFrameAre (middleHoriExpected, _output);

        scroll.Position = 10;
        Application.Refresh ();

        _ = TestHelpers.AssertDriverContentsWithFrameAre (endHoriExpected, _output);

        scroll.Size = size * 2;
        Application.Refresh ();

        _ = TestHelpers.AssertDriverContentsWithFrameAre (sizeHoriExpected, _output);
    }

    [Fact]
    public void Constructor_Defaults ()
    {
        var scroll = new Scroll ();
        Assert.True (scroll.WantContinuousButtonPressed);
        Assert.False (scroll.CanFocus);
        Assert.Equal (Orientation.Vertical, scroll.Orientation);
        Assert.Equal (0, scroll.Size);
        Assert.Equal (0, scroll.Position);
        Assert.True (scroll.KeepContentInAllViewport);
    }

    [Fact]
    [AutoInitShutdown]
    public void KeepContentInAllViewport_True_False ()
    {
        var view = new View { Width = Dim.Fill (), Height = Dim.Fill () };
        view.Padding.Thickness = new (0, 0, 2, 0);
        view.SetContentSize (new (view.Viewport.Width, 30));
        var scroll = new Scroll { Width = 2, Height = Dim.Fill (), Size = view.GetContentSize ().Height };
        scroll.PositionChanged += (_, e) => view.Viewport = view.Viewport with { Y = e.CurrentValue };
        view.Padding.Add (scroll);
        var top = new Toplevel ();
        top.Add (view);
        Application.Begin (top);

        Assert.True (scroll.KeepContentInAllViewport);
        Assert.Equal (80, view.Padding.Viewport.Width);
        Assert.Equal (25, view.Padding.Viewport.Height);
        Assert.Equal (2, scroll.Viewport.Width);
        Assert.Equal (25, scroll.Viewport.Height);
        Assert.Equal (30, scroll.Size);

        scroll.KeepContentInAllViewport = false;
        scroll.Position = 50;
        Assert.Equal (scroll.Position, scroll.Size - 1);
        Assert.Equal (scroll.Position, view.Viewport.Y);
        Assert.Equal (29, scroll.Position);
        Assert.Equal (29, view.Viewport.Y);

        top.Dispose ();
    }

    [Theory]
    [AutoInitShutdown]
    [InlineData (
                    Orientation.Vertical,
                    20,
                    10,
                    4,
                    @"
░
░
░
░
░
█
█
█
█
█",
                    0,
                    @"
█
█
█
█
█
░
░
░
░
░")]
    [InlineData (
                    Orientation.Vertical,
                    40,
                    10,
                    5,
                    @"
░
░
█
█
█
░
░
░
░
░",
                    20,
                    @"
░
░
░
░
░
█
█
█
░
░")]
    [InlineData (
                    Orientation.Horizontal,
                    20,
                    10,
                    4,
                    @"
░░░░░█████",
                    0,
                    @"
█████░░░░░")]
    [InlineData (
                    Orientation.Horizontal,
                    40,
                    10,
                    5,
                    @"
░░███░░░░░",
                    20,
                    @"
░░░░░███░░")]
    public void Mouse_On_The_Container (Orientation orientation, int size, int position, int location, string output, int expectedPos, string expectedOut)
    {
        var scroll = new Scroll
        {
            Width = orientation == Orientation.Vertical ? 1 : 10,
            Height = orientation == Orientation.Vertical ? 10 : 1,
            Orientation = orientation, Size = size,
            Position = position
        };
        var top = new Toplevel ();
        top.Add (scroll);
        Application.Begin (top);

        _ = TestHelpers.AssertDriverContentsWithFrameAre (output, _output);

        Application.OnMouseEvent (
                                  new ()
                                  {
                                      Position = orientation == Orientation.Vertical ? new (0, location) : new Point (location, 0),
                                      Flags = MouseFlags.Button1Pressed
                                  });
        Assert.Equal (expectedPos, scroll.Position);

        Application.Refresh ();
        _ = TestHelpers.AssertDriverContentsWithFrameAre (expectedOut, _output);
    }

    [Theory]
    [AutoInitShutdown]
    [InlineData (
                    Orientation.Vertical,
                    20,
                    10,
                    5,
                    5,
                    @"
░
░
░
░
░
█
█
█
█
█",
                    MouseFlags.Button1Pressed,
                    10,
                    @"
░
░
░
░
░
█
█
█
█
█")]
    [InlineData (
                    Orientation.Vertical,
                    40,
                    10,
                    3,
                    3,
                    @"
░
░
█
█
█
░
░
░
░
░",
                    MouseFlags.Button1Pressed,
                    10,
                    @"
░
░
█
█
█
░
░
░
░
░")]
    [InlineData (
                    Orientation.Horizontal,
                    20,
                    10,
                    5,
                    5,
                    @"
░░░░░█████",
                    MouseFlags.Button1Pressed,
                    10,
                    @"
░░░░░█████")]
    [InlineData (
                    Orientation.Horizontal,
                    40,
                    10,
                    3,
                    3,
                    @"
░░███░░░░░",
                    MouseFlags.Button1Pressed,
                    10,
                    @"
░░███░░░░░")]
    [InlineData (
                    Orientation.Vertical,
                    20,
                    10,
                    5,
                    4,
                    @"
░
░
░
░
░
█
█
█
█
█",
                    MouseFlags.Button1Pressed | MouseFlags.ReportMousePosition,
                    8,
                    @"
░
░
░
░
█
█
█
█
█
░")]
    [InlineData (
                    Orientation.Horizontal,
                    20,
                    10,
                    5,
                    4,
                    @"
░░░░░█████",
                    MouseFlags.Button1Pressed | MouseFlags.ReportMousePosition,
                    8,
                    @"
░░░░█████░")]
    [InlineData (
                    Orientation.Vertical,
                    20,
                    10,
                    5,
                    6,
                    @"
░
░
░
░
░
█
█
█
█
█",
                    MouseFlags.Button1Pressed | MouseFlags.ReportMousePosition,
                    10,
                    @"
░
░
░
░
░
█
█
█
█
█")]
    [InlineData (
                    Orientation.Horizontal,
                    20,
                    10,
                    5,
                    6,
                    @"
░░░░░█████",
                    MouseFlags.Button1Pressed | MouseFlags.ReportMousePosition,
                    10,
                    @"
░░░░░█████")]
    [InlineData (
                    Orientation.Vertical,
                    40,
                    10,
                    2,
                    1,
                    @"
░
░
█
█
█
░
░
░
░
░",
                    MouseFlags.Button1Pressed | MouseFlags.ReportMousePosition,
                    4,
                    @"
░
█
█
█
░
░
░
░
░
░")]
    [InlineData (
                    Orientation.Horizontal,
                    40,
                    10,
                    2,
                    1,
                    @"
░░███░░░░░",
                    MouseFlags.Button1Pressed | MouseFlags.ReportMousePosition,
                    4,
                    @"
░███░░░░░░")]
    [InlineData (
                    Orientation.Vertical,
                    40,
                    10,
                    3,
                    4,
                    @"
░
░
█
█
█
░
░
░
░
░",
                    MouseFlags.Button1Pressed | MouseFlags.ReportMousePosition,
                    12,
                    @"
░
░
░
█
█
█
░
░
░
░")]
    [InlineData (
                    Orientation.Horizontal,
                    40,
                    10,
                    3,
                    4,
                    @"
░░███░░░░░",
                    MouseFlags.Button1Pressed | MouseFlags.ReportMousePosition,
                    12,
                    @"
░░░███░░░░")]
    [InlineData (
                    Orientation.Vertical,
                    40,
                    10,
                    2,
                    3,
                    @"
░
░
█
█
█
░
░
░
░
░",
                    MouseFlags.Button1Pressed | MouseFlags.ReportMousePosition,
                    12,
                    @"
░
░
░
█
█
█
░
░
░
░")]
    [InlineData (
                    Orientation.Horizontal,
                    40,
                    10,
                    2,
                    3,
                    @"
░░███░░░░░",
                    MouseFlags.Button1Pressed | MouseFlags.ReportMousePosition,
                    12,
                    @"
░░░███░░░░")]
    [InlineData (
                    Orientation.Vertical,
                    40,
                    10,
                    2,
                    4,
                    @"
░
░
█
█
█
░
░
░
░
░",
                    MouseFlags.Button1Pressed | MouseFlags.ReportMousePosition,
                    16,
                    @"
░
░
░
░
█
█
█
░
░
░")]
    [InlineData (
                    Orientation.Horizontal,
                    40,
                    10,
                    2,
                    4,
                    @"
░░███░░░░░",
                    MouseFlags.Button1Pressed | MouseFlags.ReportMousePosition,
                    16,
                    @"
░░░░███░░░")]
    public void Mouse_On_The_Slider (
        Orientation orientation,
        int size,
        int position,
        int startLocation,
        int endLocation,
        string output,
        MouseFlags mouseFlags,
        int expectedPos,
        string expectedOut
    )
    {
        var scroll = new Scroll
        {
            Width = orientation == Orientation.Vertical ? 1 : 10,
            Height = orientation == Orientation.Vertical ? 10 : 1,
            Orientation = orientation,
            Size = size, Position = position
        };
        var top = new Toplevel ();
        top.Add (scroll);
        Application.Begin (top);

        _ = TestHelpers.AssertDriverContentsWithFrameAre (output, _output);

        Assert.Null (Application.MouseGrabView);

        if (mouseFlags.HasFlag (MouseFlags.ReportMousePosition))
        {
            MouseFlags mf = mouseFlags & ~MouseFlags.ReportMousePosition;

            Application.OnMouseEvent (
                                      new ()
                                      {
                                          Position = orientation == Orientation.Vertical ? new (0, startLocation) : new (startLocation, 0),
                                          Flags = mf
                                      });

            Application.OnMouseEvent (
                                      new ()
                                      {
                                          Position = orientation == Orientation.Vertical ? new (0, endLocation) : new (endLocation, 0),
                                          Flags = mouseFlags
                                      });
        }
        else
        {
            Assert.Equal (startLocation, endLocation);

            Application.OnMouseEvent (
                                      new ()
                                      {
                                          Position = orientation == Orientation.Vertical ? new (0, startLocation) : new (startLocation, 0),
                                          Flags = mouseFlags
                                      });
        }

        Assert.Equal ("scrollSlider", Application.MouseGrabView?.Id);
        Assert.Equal (expectedPos, scroll.Position);

        Application.Refresh ();
        _ = TestHelpers.AssertDriverContentsWithFrameAre (expectedOut, _output);

        Application.OnMouseEvent (
                                  new ()
                                  {
                                      Position = orientation == Orientation.Vertical ? new (0, startLocation) : new (startLocation, 0),
                                      Flags = MouseFlags.Button1Released
                                  });
        Assert.Null (Application.MouseGrabView);
    }

    [Theory]
    [AutoInitShutdown]
    [InlineData (Orientation.Vertical)]
    [InlineData (Orientation.Horizontal)]
    public void Moving_Mouse_Outside_Host_Ensures_Correct_Location (Orientation orientation)
    {
        var scroll = new Scroll
        {
            X = 10, Y = 10, Width = orientation == Orientation.Vertical ? 1 : 10, Height = orientation == Orientation.Vertical ? 10 : 1, Size = 20,
            Position = 5, Orientation = orientation
        };
        var top = new Toplevel ();
        top.Add (scroll);
        Application.Begin (top);

        Rectangle scrollSliderFrame = scroll.Subviews.FirstOrDefault (x => x.Id == "scrollSlider")!.Frame;
        Assert.Equal (scrollSliderFrame, orientation == Orientation.Vertical ? new (0, 2, 1, 5) : new (2, 0, 5, 1));

        Application.OnMouseEvent (new () { Position = orientation == Orientation.Vertical ? new (10, 12) : new (12, 10), Flags = MouseFlags.Button1Pressed });

        Application.OnMouseEvent (
                                  new ()
                                  {
                                      Position = orientation == Orientation.Vertical ? new (10, 0) : new (0, 10),
                                      Flags = MouseFlags.Button1Pressed | MouseFlags.ReportMousePosition
                                  });
        Assert.Equal (new (0, 0), scroll.Subviews.FirstOrDefault (x => x.Id == "scrollSlider")!.Frame.Location);

        Application.OnMouseEvent (
                                  new ()
                                  {
                                      Position = orientation == Orientation.Vertical ? new (0, 25) : new (80, 0),
                                      Flags = MouseFlags.Button1Pressed | MouseFlags.ReportMousePosition
                                  });

        Assert.Equal (
                      orientation == Orientation.Vertical ? new (0, 5) : new (5, 0),
                      scroll.Subviews.FirstOrDefault (x => x.Id == "scrollSlider")!.Frame.Location);
    }

    [Theory]
    [InlineData (Orientation.Vertical, 20, 10)]
    [InlineData (Orientation.Vertical, 40, 30)]
    public void Position_Cannot_Be_Negative_Nor_Greater_Than_Size_Minus_Frame_Length (Orientation orientation, int size, int expectedPos)
    {
        var scroll = new Scroll { Orientation = orientation, Height = 10, Size = size };
        Assert.Equal (0, scroll.Position);

        scroll.Position = -1;
        Assert.Equal (0, scroll.Position);

        scroll.Position = size;
        Assert.Equal (expectedPos, scroll.Position);

        scroll.Position = expectedPos;
        Assert.Equal (expectedPos, scroll.Position);
    }

    [Fact]
    public void PositionChanging_Cancelable_And_PositionChanged_Events ()
    {
        var changingCount = 0;
        var changedCount = 0;
        var scroll = new Scroll { Size = 10 };

        scroll.PositionChanging += (s, e) =>
                                   {
                                       if (changingCount == 0)
                                       {
                                           e.Cancel = true;
                                       }

                                       changingCount++;
                                   };
        scroll.PositionChanged += (s, e) => changedCount++;

        scroll.Position = 1;
        Assert.Equal (0, scroll.Position);
        Assert.Equal (1, changingCount);
        Assert.Equal (0, changedCount);

        scroll.Position = 1;
        Assert.Equal (1, scroll.Position);
        Assert.Equal (2, changingCount);
        Assert.Equal (1, changedCount);
    }

    [Fact]
    public void PositionChanging_PositionChanged_Events_Only_Raises_Once_If_Position_Was_Really_Changed ()
    {
        var changing = 0;
        var cancel = false;
        var changed = 0;
        var scroll = new Scroll { Height = 10, Size = 20 };
        scroll.PositionChanging += Scroll_PositionChanging;
        scroll.PositionChanged += Scroll_PositionChanged;

        Assert.Equal (Orientation.Vertical, scroll.Orientation);
        Assert.Equal (new (0, 0, 1, 10), scroll.Viewport);
        Assert.Equal (0, scroll.Position);
        Assert.Equal (0, changing);
        Assert.Equal (0, changed);

        scroll.Position = 0;
        Assert.Equal (0, scroll.Position);
        Assert.Equal (0, changing);
        Assert.Equal (0, changed);

        scroll.Position = 1;
        Assert.Equal (1, scroll.Position);
        Assert.Equal (1, changing);
        Assert.Equal (1, changed);

        Reset ();
        cancel = true;
        scroll.Position = 2;
        Assert.Equal (1, scroll.Position);
        Assert.Equal (1, changing);
        Assert.Equal (0, changed);

        Reset ();
        scroll.Position = 10;
        Assert.Equal (10, scroll.Position);
        Assert.Equal (1, changing);
        Assert.Equal (1, changed);

        Reset ();
        scroll.Position = 11;
        Assert.Equal (10, scroll.Position);
        Assert.Equal (0, changing);
        Assert.Equal (0, changed);

        Reset ();
        scroll.Position = 0;
        Assert.Equal (0, scroll.Position);
        Assert.Equal (1, changing);
        Assert.Equal (1, changed);

        scroll.PositionChanging -= Scroll_PositionChanging;
        scroll.PositionChanged -= Scroll_PositionChanged;

        void Scroll_PositionChanging (object sender, CancelEventArgs<int> e)
        {
            changing++;
            e.Cancel = cancel;
        }

        void Scroll_PositionChanged (object sender, EventArgs<int> e) { changed++; }

        void Reset ()
        {
            changing = 0;
            cancel = false;
            changed = 0;
        }
    }

    [Fact]
    public void Size_Cannot_Be_Negative ()
    {
        var scroll = new Scroll { Height = 10, Size = -1 };
        Assert.Equal (0, scroll.Size);
        scroll.Size = -10;
        Assert.Equal (0, scroll.Size);
    }

    [Fact]
    public void SizeChanged_Event ()
    {
        var count = 0;
        var scroll = new Scroll ();
        scroll.SizeChanged += (s, e) => count++;

        scroll.Size = 10;
        Assert.Equal (10, scroll.Size);
        Assert.Equal (1, count);
    }

    [Theory]
    [AutoInitShutdown]
    [InlineData (
                    3,
                    10,
                    1,
                    Orientation.Vertical,
                    @"
┌─┐
│█│
│█│
│█│
│█│
│░│
│░│
│░│
│░│
└─┘")]
    [InlineData (
                    10,
                    3,
                    1,
                    Orientation.Horizontal,
                    @"
┌────────┐
│████░░░░│
└────────┘")]
    [InlineData (
                    3,
                    10,
                    3,
                    Orientation.Vertical,
                    @"
┌───┐
│███│
│███│
│███│
│███│
│░░░│
│░░░│
│░░░│
│░░░│
└───┘")]
    [InlineData (
                    10,
                    3,
                    3,
                    Orientation.Horizontal,
                    @"
┌────────┐
│████░░░░│
│████░░░░│
│████░░░░│
└────────┘")]
    public void Vertical_Horizontal_Draws_Correctly (int sizeWidth, int sizeHeight, int widthHeight, Orientation orientation, string expected)
    {
        var super = new Window { Id = "super", Width = Dim.Fill (), Height = Dim.Fill () };
        var top = new Toplevel ();
        top.Add (super);

        var scroll = new Scroll
        {
            Orientation = orientation,
            Size = orientation == Orientation.Vertical ? sizeHeight * 2 : sizeWidth * 2,
            Width = orientation == Orientation.Vertical ? widthHeight : Dim.Fill (),
            Height = orientation == Orientation.Vertical ? Dim.Fill () : widthHeight
        };
        super.Add (scroll);

        Application.Begin (top);

        ((FakeDriver)Application.Driver)!.SetBufferSize (
                                                         sizeWidth + (orientation == Orientation.Vertical ? widthHeight - 1 : 0),
                                                         sizeHeight + (orientation == Orientation.Vertical ? 0 : widthHeight - 1));

        _ = TestHelpers.AssertDriverContentsWithFrameAre (expected, _output);
    }
}