gui-cs.Terminal.Gui/UnitTests/View/Adornment/ToScreenTests.cs

using Xunit.Abstractions;

namespace Terminal.Gui.ViewTests;

/// <summary>
/// Test the <see cref="Adornment.FrameToScreen"/> and <see cref="View.ViewportToScreen"/> methods.
/// DOES NOT TEST View.xxxToScreen methods. Those are in ./View/Layout/ToScreenTests.cs
/// </summary>
/// <param name="output"></param>
public class AdornmentToScreenTests (ITestOutputHelper output)
{
    private readonly ITestOutputHelper _output = output;

    [Theory]
    [InlineData (0, 0)]
    [InlineData (1, 1)]
    [InlineData (-1, -1)]
    [InlineData (11, 11)]
    public void FrameToScreen_NoSuperView_WithoutAdornments (int x, int expectedX)
    {
        // We test with only X because Y is equivalent. Height/Width are irrelevant.
        // Arrange
        var frame = new Rectangle (x, 0, 10, 10);

        var view = new View ();
        view.Frame = frame;

        // Act
        var marginScreen = view.Margin.FrameToScreen();
        var borderScreen = view.Border.FrameToScreen ();
        var paddingScreen = view.Padding.FrameToScreen ();

        // Assert
        Assert.Equal(expectedX, marginScreen.X);
        Assert.Equal (expectedX + view.Margin.Thickness.Left, borderScreen.X);
        Assert.Equal (expectedX + view.Margin.Thickness.Left + view.Border.Thickness.Left, paddingScreen.X);
    }

    [Theory]
    [InlineData (0, 0)]
    [InlineData (1, 1)]
    [InlineData (-1, -1)]
    [InlineData (11, 11)]
    public void FrameToScreen_NoSuperView_WithAdornments (int x, int expectedX)
    {
        // We test with only X because Y is equivalent. Height/Width are irrelevant.
        // Arrange
        var frame = new Rectangle (x, 0, 10, 10);

        var view = new View ();
        view.Border.Thickness = new (1);
        view.Frame = frame;

        // Act
        var marginScreen = view.Margin.FrameToScreen ();
        var borderScreen = view.Border.FrameToScreen ();
        var paddingScreen = view.Padding.FrameToScreen ();

        // Assert
        Assert.Equal (expectedX, marginScreen.X);
        Assert.Equal (expectedX + view.Margin.Thickness.Left, borderScreen.X);
        Assert.Equal (expectedX + view.Margin.Thickness.Left + view.Border.Thickness.Left, paddingScreen.X);
    }

    [Theory]
    [InlineData (0, 0)]
    [InlineData (1, 1)]
    [InlineData (-1, -1)]
    [InlineData (11, 11)]
    public void FrameToScreen_SuperView_WithoutAdornments (int x, int expectedX)
    {
        // We test with only X because Y is equivalent. Height/Width are irrelevant.
        // Arrange
        var frame = new Rectangle (x, 0, 10, 10);

        var superView = new View ()
        {
            X = 0,
            Y = 0,
            Height = Dim.Fill (),
            Width = Dim.Fill ()
        };

        var view = new View ();
        view.Frame = frame;

        superView.Add (view);
        superView.LayoutSubviews ();

        // Act
        var marginScreen = view.Margin.FrameToScreen ();
        var borderScreen = view.Border.FrameToScreen ();
        var paddingScreen = view.Padding.FrameToScreen ();

        // Assert
        Assert.Equal (expectedX, marginScreen.X);
        Assert.Equal (expectedX + view.Margin.Thickness.Left, borderScreen.X);
        Assert.Equal (expectedX + view.Margin.Thickness.Left + view.Border.Thickness.Left, paddingScreen.X);
    }

    [Theory]
    [InlineData (0, 3)]
    [InlineData (1, 4)]
    [InlineData (-1, 2)]
    [InlineData (11, 14)]
    public void FrameToScreen_SuperView_WithAdornments (int x, int expectedX)
    {
        // We test with only X because Y is equivalent. Height/Width are irrelevant.
        // Arrange
        var frame = new Rectangle (x, 0, 10, 10);

        var superView = new View ()
        {
            X = 0,
            Y = 0,
            Height = Dim.Fill (),
            Width = Dim.Fill ()
        };
        superView.Margin.Thickness = new (1);
        superView.Border.Thickness = new (1);
        superView.Padding.Thickness = new (1);

        var view = new View ();
        view.Frame = frame;

        superView.Add (view);
        superView.LayoutSubviews ();

        // Act
        var marginScreen = view.Margin.FrameToScreen ();
        var borderScreen = view.Border.FrameToScreen ();
        var paddingScreen = view.Padding.FrameToScreen ();

        // Assert
        Assert.Equal (expectedX, marginScreen.X);
        Assert.Equal (expectedX + view.Margin.Thickness.Left, borderScreen.X);
        Assert.Equal (expectedX + view.Margin.Thickness.Left + view.Border.Thickness.Left, paddingScreen.X);
    }

    [Theory]
    [InlineData (0, 0)]
    [InlineData (1, 1)]
    [InlineData (-1, -1)]
    [InlineData (11, 11)]
    public void FrameToScreen_NestedSuperView_WithoutAdornments (int x, int expectedX)
    {
        // We test with only X because Y is equivalent. Height/Width are irrelevant.
        // Arrange
        var frame = new Rectangle (x, 0, 10, 10);

        var superSuperView = new View ()
        {
            X = 0,
            Y = 0,
            Height = Dim.Fill (),
            Width = Dim.Fill ()
        };

        var superView = new View ()
        {
            X = 0,
            Y = 0,
            Height = Dim.Fill (),
            Width = Dim.Fill ()
        };

        superSuperView.Add (superView);

        var view = new View ();
        view.Frame = frame;

        superView.Add (view);
        superView.LayoutSubviews ();

        // Act
        var marginScreen = view.Margin.FrameToScreen ();
        var borderScreen = view.Border.FrameToScreen ();
        var paddingScreen = view.Padding.FrameToScreen ();

        // Assert
        Assert.Equal (expectedX, marginScreen.X);
        Assert.Equal (expectedX + view.Margin.Thickness.Left, borderScreen.X);
        Assert.Equal (expectedX + view.Margin.Thickness.Left + view.Border.Thickness.Left, paddingScreen.X);
    }

    [Theory]
    [InlineData (0, 6)]
    [InlineData (1, 7)]
    [InlineData (-1, 5)]
    [InlineData (11, 17)]
    public void FrameToScreen_NestedSuperView_WithAdornments (int x, int expectedX)
    {
        // We test with only X because Y is equivalent. Height/Width are irrelevant.
        // Arrange
        var frame = new Rectangle (x, 0, 10, 10);

        var superSuperView = new View ()
        {
            X = 0,
            Y = 0,
            Height = Dim.Fill (),
            Width = Dim.Fill ()
        };
        superSuperView.Margin.Thickness = new (1);
        superSuperView.Border.Thickness = new (1);
        superSuperView.Padding.Thickness = new (1);

        var superView = new View ()
        {
            X = 0,
            Y = 0,
            Height = Dim.Fill (),
            Width = Dim.Fill ()
        };
        superView.Margin.Thickness = new (1);
        superView.Border.Thickness = new (1);
        superView.Padding.Thickness = new (1);
        superSuperView.Add (superView);

        var view = new View ();
        view.Frame = frame;

        superView.Add (view);
        superView.LayoutSubviews ();

        // Act
        var marginScreen = view.Margin.FrameToScreen ();
        var borderScreen = view.Border.FrameToScreen ();
        var paddingScreen = view.Padding.FrameToScreen ();

        // Assert
        Assert.Equal (expectedX, marginScreen.X);
        Assert.Equal (expectedX + view.Margin.Thickness.Left, borderScreen.X);
        Assert.Equal (expectedX + view.Margin.Thickness.Left + view.Border.Thickness.Left, paddingScreen.X);
    }

    // Adornment.ViewportToScreen tests ============================

    [Theory]
    [InlineData (0, 0, 0)]
    [InlineData (1, 0, 1)]
    [InlineData (-1, 0, -1)]
    [InlineData (11, 0, 11)]
    public void ViewportToScreen_NoSuperView_WithoutAdornments (int frameX, int testX, int expectedX)
    {
        // We test with only X because Y is equivalent. Height/Width are irrelevant.
        // Arrange
        var frame = new Rectangle (frameX, 0, 10, 10);

        var view = new View ();
        view.Frame = frame;

        // Act
        var marginScreen = view.Margin.ViewportToScreen (new (testX, 0, 0, 0));
        var borderScreen = view.Border.ViewportToScreen (new (testX, 0, 0, 0));
        var paddingScreen = view.Padding.ViewportToScreen (new (testX, 0, 0, 0));

        // Assert
        Assert.Equal (expectedX, marginScreen.X);
        Assert.Equal (expectedX + view.Margin.Thickness.Left, borderScreen.X);
        Assert.Equal (expectedX + view.Margin.Thickness.Left + view.Border.Thickness.Left, paddingScreen.X);
    }

    [Theory]
    [InlineData (0, 0, 0)]
    [InlineData (1, 0, 1)]
    [InlineData (-1, 0, -1)]
    [InlineData (11, 0, 11)]

    [InlineData (0, 1, 1)]
    [InlineData (1, 1, 2)]
    [InlineData (-1, 1, 0)]
    [InlineData (11, 1, 12)]

    [InlineData (0, -1, -1)]
    [InlineData (1, -1, 0)]
    [InlineData (-1, -1, -2)]
    [InlineData (11, -1, 10)]
    public void ViewportToScreen_NoSuperView_WithAdornments (int frameX, int testX, int expectedX)
    {
        // We test with only X because Y is equivalent. Height/Width are irrelevant.
        // Arrange
        var frame = new Rectangle (frameX, 0, 10, 10);

        var view = new View ();
        view.Margin.Thickness = new (1);
        view.Border.Thickness = new (1);
        view.Padding.Thickness = new (1);
        // Total thickness is 3 (view.Viewport will be Frame.Width - 6)
        view.Frame = frame;

        Assert.Equal(4, view.Viewport.Width);

        // Act
        var marginScreen = view.Margin.ViewportToScreen (new (testX, 0, 0, 0));
        var borderScreen = view.Border.ViewportToScreen (new (testX, 0, 0, 0));
        var paddingScreen = view.Padding.ViewportToScreen (new (testX, 0, 0, 0));

        // Assert
        Assert.Equal (expectedX, marginScreen.X);
        Assert.Equal (expectedX + view.Margin.Thickness.Left, borderScreen.X);
        Assert.Equal (expectedX + view.Margin.Thickness.Left + view.Border.Thickness.Left, paddingScreen.X);
    }

    [Theory]
    [InlineData (0, 0, 0)]
    [InlineData (1, 0, 1)]
    [InlineData (-1, 0, -1)]
    [InlineData (11, 0, 11)]

    [InlineData (0, 1, 1)]
    [InlineData (1, 1, 2)]
    [InlineData (-1, 1, 0)]
    [InlineData (11, 1, 12)]

    [InlineData (0, -1, -1)]
    [InlineData (1, -1, 0)]
    [InlineData (-1, -1, -2)]
    [InlineData (11, -1, 10)]
    public void ViewportToScreen_SuperView_WithoutAdornments (int frameX, int testX, int expectedX)
    {
        // We test with only X because Y is equivalent. Height/Width are irrelevant.
        // Arrange
        var frame = new Rectangle (frameX, 0, 10, 10);

        var superView = new View ()
        {
            X = 0,
            Y = 0,
            Height = Dim.Fill (),
            Width = Dim.Fill ()
        };

        var view = new View ();
        view.Frame = frame;

        superView.Add (view);
        superView.LayoutSubviews ();

        // Act
        var marginScreen = view.Margin.ViewportToScreen (new (testX, 0, 0, 0));
        var borderScreen = view.Border.ViewportToScreen (new (testX, 0, 0, 0));
        var paddingScreen = view.Padding.ViewportToScreen (new (testX, 0, 0, 0));

        // Assert
        Assert.Equal (expectedX, marginScreen.X);
        Assert.Equal (expectedX + view.Margin.Thickness.Left, borderScreen.X);
        Assert.Equal (expectedX + view.Border.Thickness.Left, paddingScreen.X);
    }

    [Theory]
    [InlineData (0, 0, 1)]
    [InlineData (1, 0, 2)]
    [InlineData (-1, 0, 0)]
    [InlineData (11, 0, 12)]

    [InlineData (0, 1, 2)]
    [InlineData (1, 1, 3)]
    [InlineData (-1, 1, 1)]
    [InlineData (11, 1, 13)]

    [InlineData (0, -1, 0)]
    [InlineData (1, -1, 1)]
    [InlineData (-1, -1, -1)]
    [InlineData (11, -1, 11)]
    public void ViewportToScreen_SuperView_WithAdornments (int frameX, int testX, int expectedX)
    {
        // We test with only X because Y is equivalent. Height/Width are irrelevant.
        // Arrange
        var frame = new Rectangle (frameX, 0, 10, 10);

        var superView = new View ()
        {
            X = 0,
            Y = 0,
            Height = Dim.Fill (),
            Width = Dim.Fill ()
        };
        superView.Border.Thickness = new (1);

        var view = new View ();
        view.Frame = frame;

        superView.Add (view);
        superView.LayoutSubviews ();

        // Act
        var marginScreen = view.Margin.ViewportToScreen (new (testX, 0, 0, 0));
        var borderScreen = view.Border.ViewportToScreen (new (testX, 0, 0, 0));
        var paddingScreen = view.Padding.ViewportToScreen (new (testX, 0, 0, 0));

        // Assert
        Assert.Equal (expectedX, marginScreen.X);
        Assert.Equal (expectedX + view.Margin.Thickness.Left, borderScreen.X);
        Assert.Equal (expectedX + view.Border.Thickness.Left, paddingScreen.X);
    }

    [Theory]
    [InlineData (0, 0, 0)]
    [InlineData (1, 0, 1)]
    [InlineData (-1, 0, -1)]
    [InlineData (11, 0, 11)]

    [InlineData (0, 1, 1)]
    [InlineData (1, 1, 2)]
    [InlineData (-1, 1, 0)]
    [InlineData (11, 1, 12)]

    [InlineData (0, -1, -1)]
    [InlineData (1, -1, 0)]
    [InlineData (-1, -1, -2)]
    [InlineData (11, -1, 10)]
    public void ViewportToScreen_NestedSuperView_WithoutAdornments (int frameX, int testX, int expectedX)
    {
        // We test with only X because Y is equivalent. Height/Width are irrelevant.
        // Arrange
        var frame = new Rectangle (frameX, 0, 10, 10);

        var superSuperView = new View ()
        {
            X = 0,
            Y = 0,
            Height = Dim.Fill (),
            Width = Dim.Fill ()
        };

        var superView = new View ()
        {
            X = 0,
            Y = 0,
            Height = Dim.Fill (),
            Width = Dim.Fill ()
        };

        superSuperView.Add (superView);

        var view = new View ();
        view.Frame = frame;

        superView.Add (view);
        superView.LayoutSubviews ();

        // Act
        var marginScreen = view.Margin.ViewportToScreen (new (testX, 0, 0, 0));
        var borderScreen = view.Border.ViewportToScreen (new (testX, 0, 0, 0));
        var paddingScreen = view.Padding.ViewportToScreen (new (testX, 0, 0, 0));

        // Assert
        Assert.Equal (expectedX, marginScreen.X);
        Assert.Equal (expectedX + view.Margin.Thickness.Left, borderScreen.X);
        Assert.Equal (expectedX + view.Border.Thickness.Left, paddingScreen.X);
    }

    [Theory]
    [InlineData (0, 0, 6)]
    [InlineData (1, 0, 7)]
    [InlineData (-1, 0, 5)]
    [InlineData (11, 0, 17)]

    [InlineData (0, 1, 7)]
    [InlineData (1, 1, 8)]
    [InlineData (-1, 1, 6)]
    [InlineData (11, 1, 18)]

    [InlineData (0, -1, 5)]
    [InlineData (1, -1, 6)]
    [InlineData (-1, -1, 4)]
    [InlineData (11, -1, 16)]
    public void ViewportToScreen_NestedSuperView_WithAdornments (int frameX, int testX, int expectedX)
    {
        // We test with only X because Y is equivalent. Height/Width are irrelevant.
        // Arrange
        var frame = new Rectangle (frameX, 0, 10, 10);

        var superSuperView = new View ()
        {
            X = 0,
            Y = 0,
            Height = Dim.Fill (),
            Width = Dim.Fill ()
        };
        superSuperView.Margin.Thickness = new (1);
        superSuperView.Border.Thickness = new (1);
        superSuperView.Padding.Thickness = new (1);

        var superView = new View ()
        {
            X = 0,
            Y = 0,
            Height = Dim.Fill (),
            Width = Dim.Fill ()
        };
        superView.Margin.Thickness = new (1);
        superView.Border.Thickness = new (1);
        superView.Padding.Thickness = new (1);
        superSuperView.Add (superView);

        var view = new View ();
        view.Frame = frame;

        superView.Add (view);
        superView.LayoutSubviews ();

        // Act
        var marginScreen = view.Margin.ViewportToScreen (new (testX, 0, 0, 0));
        var borderScreen = view.Border.ViewportToScreen (new (testX, 0, 0, 0));
        var paddingScreen = view.Padding.ViewportToScreen (new (testX, 0, 0, 0));

        // Assert
        Assert.Equal (expectedX, marginScreen.X);
        Assert.Equal (expectedX + view.Margin.Thickness.Left, borderScreen.X);
        Assert.Equal (expectedX + view.Margin.Thickness.Left + view.Border.Thickness.Left, paddingScreen.X);
    }
}