gui-cs.Terminal.Gui/UnitTests/View/Layout/FrameTests.cs

using Xunit.Abstractions;

namespace Terminal.Gui.LayoutTests;

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

    [Fact]
    public void Frame_Empty_Default ()
    {
        View view = new ();
        Assert.Equal(Rectangle.Empty, view.Frame);

        view.BeginInit();
        view.EndInit();
        Assert.Equal (Rectangle.Empty, view.Frame);
    }

    [Fact]
    public void Frame_Set_Sets ()
    {
        Rectangle frame = new (1, 2, 3, 4);
        View view = new ();
        Assert.True (view.NeedsLayout);
        Assert.Equal (Rectangle.Empty, view.Frame);

        view.Frame = frame;
        Assert.Equal (frame, view.Frame);
        Assert.False (view.NeedsLayout);

        Assert.Equal(view.X, frame.X);
        Assert.Equal (view.Y, frame.Y);
        Assert.Equal (view.Width, frame.Width);
        Assert.Equal (view.Height, frame.Height);
    }

    [Fact]
    public void Frame_Initializer_Sets ()
    {
        Rectangle frame = new (1, 2, 3, 4);
        View view = new ()
        {
            Frame = frame,
        };

        Assert.Equal (frame, view.Frame);
        Assert.False (view.NeedsLayout);
        Assert.Equal (frame.Size, view.Viewport.Size);


        Assert.Equal (view.X, frame.X);
        Assert.Equal (view.Y, frame.Y);
        Assert.Equal (view.Width, frame.Width);
        Assert.Equal (view.Height, frame.Height);
    }


    [Fact]
    public void Frame_Empty_Initializer_Sets ()
    {
        Rectangle frame = new (1, 2, 3, 4);
        View view = new ()
        {
            Frame = frame,
        };

        Assert.Equal (frame, view.Frame);
        Assert.False (view.NeedsLayout);
        Assert.Equal (frame.Size, view.Viewport.Size);

        Assert.Equal (view.X, frame.X);
        Assert.Equal (view.Y, frame.Y);
        Assert.Equal (view.Width, frame.Width);
        Assert.Equal (view.Height, frame.Height);

        view.Frame = Rectangle.Empty;
        Assert.Equal (Rectangle.Empty, view.Frame);
        Assert.False (view.NeedsLayout);
        Assert.Equal (Rectangle.Empty.Size, view.Viewport.Size);

        Assert.Equal (view.X, Rectangle.Empty.X);
        Assert.Equal (view.Y, Rectangle.Empty.Y);
        Assert.Equal (view.Width, Rectangle.Empty.Width);
        Assert.Equal (view.Height, Rectangle.Empty.Height);

        view.Width = Dim.Fill ();
        view.Height = Dim.Fill ();
        Assert.True (view.NeedsLayout);
        view.Layout ();
        Assert.False (view.NeedsLayout);
        Assert.Equal (Application.Screen, view.Frame);

        view.Frame = Rectangle.Empty;
        Assert.Equal (Rectangle.Empty, view.Frame);
        Assert.False (view.NeedsLayout);
        Assert.Equal (Rectangle.Empty.Size, view.Viewport.Size);

        Assert.Equal (view.X, Rectangle.Empty.X);
        Assert.Equal (view.Y, Rectangle.Empty.Y);
        Assert.Equal (view.Width, Rectangle.Empty.Width);
        Assert.Equal (view.Height, Rectangle.Empty.Height);

    }


    [Fact]
    public void Frame_Empty_Initializer_Overrides_Base ()
    {
        // Prove TestView is correct
        FrameTestView view = new ();
        Assert.True (view.NeedsLayout);

        view.Layout ();
        Assert.Equal (new Rectangle(10, 20, 30, 40), view.Frame);
        Assert.Equal (10, view.X.GetAnchor(0));
        Assert.Equal (20, view.Y.GetAnchor(0));
        Assert.Equal (30, view.Width!.GetAnchor(0));
        Assert.Equal (40, view.Height!.GetAnchor(0));
        Assert.Equal (new Rectangle (0, 0, 30, 40), view.Viewport);

        // Set Frame via init
        Rectangle frame = new (1, 2, 3, 4);
        view = new ()
        {
            Frame = frame,
        };
        Assert.Equal (frame, view.Frame);
        Assert.False (view.NeedsLayout);
        Assert.Equal (frame.Size, view.Viewport.Size);

        Assert.Equal (view.X, frame.X);
        Assert.Equal (view.Y, frame.Y);
        Assert.Equal (view.Width, frame.Width);
        Assert.Equal (view.Height, frame.Height);

        // Set Frame via init to empty
        frame = Rectangle.Empty;
        view = new ()
        {
            Frame = frame,
        };
        Assert.Equal (frame, view.Frame);
        Assert.False (view.NeedsLayout);
        Assert.Equal (frame.Size, view.Viewport.Size);

        Assert.Equal (view.X, frame.X);
        Assert.Equal (view.Y, frame.Y);
        Assert.Equal (view.Width, frame.Width);
        Assert.Equal (view.Height, frame.Height);

        // Set back to original state
        view.X = Pos.Func (() => 10);
        view.Y = Pos.Func (() => 20);
        view.Width = Dim.Func (() => 30);
        view.Height = Dim.Func (() => 40);
        Assert.True (view.NeedsLayout);

        view.Layout ();
        Assert.Equal (new Rectangle (10, 20, 30, 40), view.Frame);
        Assert.Equal (10, view.X.GetAnchor (0));
        Assert.Equal (20, view.Y.GetAnchor (0));
        Assert.Equal (30, view.Width!.GetAnchor (0));
        Assert.Equal (40, view.Height!.GetAnchor (0));
        Assert.Equal (new Rectangle (0, 0, 30, 40), view.Viewport);

        view.Frame = frame;
        Assert.Equal (frame, view.Frame);
        Assert.False (view.NeedsLayout);
        Assert.Equal (frame.Size, view.Viewport.Size);

        Assert.Equal (view.X, frame.X);
        Assert.Equal (view.Y, frame.Y);
        Assert.Equal (view.Width, frame.Width);
        Assert.Equal (view.Height, frame.Height);
    }

    private class FrameTestView : View
    {
        public FrameTestView ()
        {
            X = Pos.Func (() => 10);
            Y = Pos.Func (() => 20);
            Width = Dim.Func (() => 30);
            Height = Dim.Func (() => 40);
        }
    }


    // Moved this test from AbsoluteLayoutTests
    // TODO: Refactor as Theory
    [Fact]
    [TestRespondersDisposed]
    public void Frame_Set ()
    {
        var frame = new Rectangle (1, 2, 3, 4);
        var newFrame = new Rectangle (1, 2, 30, 40);

        var v = new View ();
        Assert.Equal (Rectangle.Empty, v.Frame);
        v.Dispose ();

        v = new View { Frame = frame };
        Assert.Equal (frame, v.Frame);

        v.Frame = newFrame;
        Assert.Equal (newFrame, v.Frame);

        Assert.Equal (
                      new Rectangle (0, 0, newFrame.Width, newFrame.Height),
                      v.Viewport
                     ); // With Absolute Viewport *is* deterministic before Layout
        Assert.Equal (Pos.Absolute (1), v.X);
        Assert.Equal (Pos.Absolute (2), v.Y);
        Assert.Equal (Dim.Absolute (30), v.Width);
        Assert.Equal (Dim.Absolute (40), v.Height);
        v.Dispose ();

        v = new View { X = frame.X, Y = frame.Y, Text = "v" };
        v.Frame = newFrame;
        Assert.Equal (newFrame, v.Frame);

        Assert.Equal (
                      new Rectangle (0, 0, newFrame.Width, newFrame.Height),
                      v.Viewport
                     ); // With Absolute Viewport *is* deterministic before Layout
        Assert.Equal (Pos.Absolute (1), v.X);
        Assert.Equal (Pos.Absolute (2), v.Y);
        Assert.Equal (Dim.Absolute (30), v.Width);
        Assert.Equal (Dim.Absolute (40), v.Height);
        v.Dispose ();

        newFrame = new Rectangle (10, 20, 30, 40);
        v = new View { Frame = frame };
        v.Frame = newFrame;
        Assert.Equal (newFrame, v.Frame);

        Assert.Equal (
                      new Rectangle (0, 0, newFrame.Width, newFrame.Height),
                      v.Viewport
                     ); // With Absolute Viewport *is* deterministic before Layout
        Assert.Equal (Pos.Absolute (10), v.X);
        Assert.Equal (Pos.Absolute (20), v.Y);
        Assert.Equal (Dim.Absolute (30), v.Width);
        Assert.Equal (Dim.Absolute (40), v.Height);
        v.Dispose ();

        v = new View { X = frame.X, Y = frame.Y, Text = "v" };
        v.Frame = newFrame;
        Assert.Equal (newFrame, v.Frame);

        Assert.Equal (
                      new Rectangle (0, 0, newFrame.Width, newFrame.Height),
                      v.Viewport
                     ); // With Absolute Viewport *is* deterministic before Layout
        Assert.Equal (Pos.Absolute (10), v.X);
        Assert.Equal (Pos.Absolute (20), v.Y);
        Assert.Equal (Dim.Absolute (30), v.Width);
        Assert.Equal (Dim.Absolute (40), v.Height);
        v.Dispose ();
    }

    private class TestFrameEventsView : View
    {
        public int OnFrameChangedCallCount { get; private set; }
        public int FrameChangedEventCallCount { get; private set; }

        public TestFrameEventsView ()
        {
            FrameChanged += (sender, args) => FrameChangedEventCallCount++;
        }

        protected override void OnFrameChanged (in Rectangle frame)
        {
            OnFrameChangedCallCount++;
            base.OnFrameChanged (frame);
        }
    }

    [Fact]
    public void OnFrameChanged_Called_When_Frame_Changes ()
    {
        // Arrange
        var view = new TestFrameEventsView ();
        var initialFrame = new Rectangle (0, 0, 10, 10);
        var newFrame = new Rectangle (0, 0, 20, 20);
        view.Frame = initialFrame;
        Assert.Equal (1, view.OnFrameChangedCallCount);

        // Act
        view.Frame = newFrame;

        // Assert
        Assert.Equal (2, view.OnFrameChangedCallCount);
    }

    [Fact]
    public void FrameChanged_Event_Raised_When_Frame_Changes ()
    {
        // Arrange
        var view = new TestFrameEventsView ();
        var initialFrame = new Rectangle (0, 0, 10, 10);
        var newFrame = new Rectangle (0, 0, 20, 20);
        view.Frame = initialFrame;
        Assert.Equal (1, view.FrameChangedEventCallCount);

        // Act
        view.Frame = newFrame;

        // Assert
        Assert.Equal (2, view.FrameChangedEventCallCount);
    }
}