Avalonia/tests/Avalonia.Controls.UnitTests/Presenters/ScrollContentPresenterTests.cs

using System;
using System.Collections.Generic;
using System.Reactive.Linq;
using Avalonia.Controls.Presenters;
using Avalonia.Controls.Templates;
using Avalonia.Layout;
using Avalonia.UnitTests;
using Xunit;
using Xunit.Sdk;

namespace Avalonia.Controls.UnitTests.Presenters
{
    public class ScrollContentPresenterTests : NameScopeTests
    {
        [Theory]
        [InlineData(HorizontalAlignment.Stretch, VerticalAlignment.Stretch, 10, 10, 80, 80)]
        [InlineData(HorizontalAlignment.Left, VerticalAlignment.Stretch, 10, 10, 16, 80)]
        [InlineData(HorizontalAlignment.Right, VerticalAlignment.Stretch, 74, 10, 16, 80)]
        [InlineData(HorizontalAlignment.Center, VerticalAlignment.Stretch, 42, 10, 16, 80)]
        [InlineData(HorizontalAlignment.Stretch, VerticalAlignment.Top, 10, 10, 80, 16)]
        [InlineData(HorizontalAlignment.Stretch, VerticalAlignment.Bottom, 10, 74, 80, 16)]
        [InlineData(HorizontalAlignment.Stretch, VerticalAlignment.Center, 10, 42, 80, 16)]
        public void Alignment_And_Padding_Are_Applied_To_Child_Bounds(
            HorizontalAlignment h,
            VerticalAlignment v,
            double expectedX,
            double expectedY,
            double expectedWidth,
            double expectedHeight)
        {
            Border content;
            var target = new ScrollContentPresenter
            {
                Padding = new Thickness(10),
                Content = content = new Border
                {
                    MinWidth = 16,
                    MinHeight = 16,
                    HorizontalAlignment = h,
                    VerticalAlignment = v,
                },
            };

            target.UpdateChild();
            target.Measure(new Size(100, 100));
            target.Arrange(new Rect(0, 0, 100, 100));

            Assert.Equal(new Rect(expectedX, expectedY, expectedWidth, expectedHeight), content.Bounds);
        }

        [Fact]
        public void DesiredSize_Is_Content_Size_When_Smaller_Than_AvailableSize()
        {
            var target = new ScrollContentPresenter
            {
                Padding = new Thickness(10),
                Content = new Border
                {
                    MinWidth = 16,
                    MinHeight = 16,
                },
            };

            target.UpdateChild();
            target.Measure(new Size(100, 100));
            target.Arrange(new Rect(0, 0, 100, 100));

            Assert.Equal(new Size(16, 16), target.DesiredSize);
        }

        [Fact]
        public void DesiredSize_Is_AvailableSize_When_Content_Larger_Than_AvailableSize()
        {
            var target = new ScrollContentPresenter
            {
                Padding = new Thickness(10),
                Content = new Border
                {
                    MinWidth = 160,
                    MinHeight = 160,
                },
            };

            target.UpdateChild();
            target.Measure(new Size(100, 100));
            target.Arrange(new Rect(0, 0, 100, 100));

            Assert.Equal(new Size(100, 100), target.DesiredSize);
        }

        [Fact]
        public void Content_Can_Be_Larger_Than_Viewport()
        {
            TestControl content;
            var target = new ScrollContentPresenter
            {
                CanHorizontallyScroll = true,
                CanVerticallyScroll = true,
                Content = content = new TestControl(),
            };

            target.UpdateChild();
            target.Measure(new Size(100, 100));
            target.Arrange(new Rect(0, 0, 100, 100));

            Assert.Equal(new Rect(0, 0, 150, 150), content.Bounds);
        }

        [Fact]
        public void Content_Can_Be_Offset()
        {
            Border content;
            var target = new ScrollContentPresenter
            {
                CanHorizontallyScroll = true,
                CanVerticallyScroll = true,
                Content = content = new Border
                {
                    Width = 150,
                    Height = 150,
                },
            };

            target.UpdateChild();
            target.Measure(new Size(100, 100));
            target.Arrange(new Rect(0, 0, 100, 100));

            target.Offset = new Vector(25, 25);

            target.Measure(new Size(100, 100));
            target.Arrange(new Rect(0, 0, 100, 100));

            Assert.Equal(new Rect(-25, -25, 150, 150), content.Bounds);
        }

        [Fact]
        public void Measure_Should_Pass_Bounded_X_If_CannotScrollHorizontally()
        {
            var child = new TestControl();
            var target = new ScrollContentPresenter
            {
                CanVerticallyScroll = true,
                Content = child,
            };

            target.UpdateChild();
            target.Measure(new Size(100, 100));

            Assert.Equal(new Size(100, double.PositiveInfinity), child.AvailableSize);
        }

        [Fact]
        public void Measure_Should_Pass_Unbounded_X_If_CanScrollHorizontally()
        {
            var child = new TestControl();
            var target = new ScrollContentPresenter
            {
                CanHorizontallyScroll = true,
                CanVerticallyScroll = true,
                Content = child,
            };

            target.UpdateChild();
            target.Measure(new Size(100, 100));

            Assert.Equal(Size.Infinity, child.AvailableSize);
        }

        [Fact]
        public void Arrange_Should_Set_Viewport_And_Extent_In_That_Order()
        {
            var target = new ScrollContentPresenter
            {
                Content = new Border { Width = 40, Height = 50 }
            };

            var set = new List<string>();

            target.UpdateChild();
            target.Measure(new Size(100, 100));

            target.GetObservable(ScrollViewer.ViewportProperty).Skip(1).Subscribe(_ => set.Add("Viewport"));
            target.GetObservable(ScrollViewer.ExtentProperty).Skip(1).Subscribe(_ => set.Add("Extent"));

            target.Arrange(new Rect(0, 0, 100, 100));

            Assert.Equal(new[] { "Viewport", "Extent" }, set);
        }

        [Fact]
        public void Should_Correctly_Arrange_Child_Larger_Than_Viewport()
        {
            var child = new Canvas { MinWidth = 150, MinHeight = 150 };
            var target = new ScrollContentPresenter { Content = child, };

            target.UpdateChild();
            target.Measure(Size.Infinity);
            target.Arrange(new Rect(0, 0, 100, 100));

            Assert.Equal(new Size(150, 150), child.Bounds.Size);
        }

        [Fact]
        public void Arrange_Should_Constrain_Child_Width_When_CanHorizontallyScroll_False()
        {
            var child = new WrapPanel
            {
                Children =
                {
                    new Border { Width = 40, Height = 50 },
                    new Border { Width = 40, Height = 50 },
                    new Border { Width = 40, Height = 50 },
                }
            };

            var target = new ScrollContentPresenter
            {
                Content = child,
                CanHorizontallyScroll = false,
            };

            target.UpdateChild();
            target.Measure(Size.Infinity);
            target.Arrange(new Rect(0, 0, 100, 100));

            Assert.Equal(100, child.Bounds.Width);
        }

        [Fact]
        public void Extent_Should_Include_Content_Margin()
        {
            var target = new ScrollContentPresenter
            {
                Content = new Border
                {
                    Width = 100,
                    Height = 100,
                    Margin = new Thickness(5),
                }
            };

            target.UpdateChild();
            target.Measure(new Size(50, 50));
            target.Arrange(new Rect(0, 0, 50, 50));

            Assert.Equal(new Size(110, 110), target.Extent);
        }

        [Fact]
        public void Extent_Should_Include_Content_Margin_Scaled_With_Layout_Rounding()
        {
            var root = new TestRoot
            {
                LayoutScaling = 1.25,
                UseLayoutRounding = true
            };

            var target = new ScrollContentPresenter
            {
                HorizontalAlignment = HorizontalAlignment.Center,
                VerticalAlignment = VerticalAlignment.Center,
                Content = new Border
                {
                    Width = 200,
                    Height = 200,
                    Margin = new Thickness(2)
                }
            };

            root.Child = target;
            target.UpdateChild();
            target.Measure(new Size(1000, 1000));
            target.Arrange(new Rect(0, 0, 1000, 1000));

            Assert.Equal(new Size(203.2, 203.2), target.Viewport);
            Assert.Equal(new Size(203.2, 203.2), target.Extent);
        }

        [Fact]
        public void Extent_Should_Be_Rounded_To_Viewport_When_Close()
        {
            var root = new TestRoot
            {
                LayoutScaling = 1.75,
                UseLayoutRounding = true
            };

            var target = new ScrollContentPresenter
            {
                HorizontalAlignment = HorizontalAlignment.Center,
                VerticalAlignment = VerticalAlignment.Center,
                Content = new Border
                {
                    Width = 164.57142857142858,
                    Height = 164.57142857142858,
                    Margin = new Thickness(6)
                }
            };

            root.Child = target;
            target.UpdateChild();
            target.Measure(new Size(1000, 1000));
            target.Arrange(new Rect(0, 0, 1000, 1000));

            var nonRoundedVieViewport = target.Child!.Bounds.Size.Inflate(
                LayoutHelper.RoundLayoutThickness(target.Child.Margin, root.LayoutScaling));

            Assert.Equal(new Size(176.00000000000003, 176.00000000000003), nonRoundedVieViewport);
            Assert.Equal(new Size(176, 176), target.Viewport);
            Assert.Equal(new Size(176, 176), target.Extent);
        }

        [Fact]
        public void Extent_Width_Should_Be_Arrange_Width_When_CanScrollHorizontally_False()
        {
            var child = new WrapPanel
            {
                Children =
                {
                    new Border { Width = 40, Height = 50 },
                    new Border { Width = 40, Height = 50 },
                    new Border { Width = 40, Height = 50 },
                }
            };

            var target = new ScrollContentPresenter
            {
                Content = child,
                CanHorizontallyScroll = false,
            };

            target.UpdateChild();
            target.Measure(Size.Infinity);
            target.Arrange(new Rect(0, 0, 100, 100));

            Assert.Equal(new Size(100, 100), target.Extent);
        }

        [Fact]
        public void Setting_Offset_Should_Invalidate_Arrange()
        {
            var target = new ScrollContentPresenter
            {
                Content = new Border { Width = 140, Height = 150 }
            };

            target.UpdateChild();
            target.Measure(new Size(100, 100));
            target.Arrange(new Rect(0, 0, 100, 100));
            target.Offset = new Vector(10, 100);

            Assert.True(target.IsMeasureValid);
            Assert.False(target.IsArrangeValid);
        }

        [Fact]
        public void BringDescendantIntoView_Should_Update_Offset()
        {
            var target = new ScrollContentPresenter
            {
                Width = 100,
                Height = 100,
                CanVerticallyScroll = true,
                CanHorizontallyScroll = true,
                Content = new Border
                {
                    Width = 200,
                    Height = 200,
                }
            };

            target.UpdateChild();
            target.Measure(Size.Infinity);
            target.Arrange(new Rect(0, 0, 100, 100));
            target.BringDescendantIntoView(target.Child!, new Rect(200, 200, 0, 0));

            Assert.Equal(new Vector(100, 100), target.Offset);
        }

        [Fact]
        public void BringDescendantIntoView_Should_Handle_Child_Margin()
        {
            Border border;
            var target = new ScrollContentPresenter
            {
                CanHorizontallyScroll = true,
                CanVerticallyScroll = true,
                Width = 100,
                Height = 100,
                Content = new Decorator
                {
                    Margin = new Thickness(50),
                    Child = border = new Border
                    {
                        Width = 200,
                        Height = 200,
                    }
                }
            };

            target.UpdateChild();
            target.Measure(Size.Infinity);
            target.Arrange(new Rect(0, 0, 100, 100));
            target.BringDescendantIntoView(border, new Rect(200, 200, 0, 0));

            Assert.Equal(new Vector(150, 150), target.Offset);
        }

        [Fact]
        public void BringDescendantIntoView_Should_Move_Child_Even_With_Margin_In_Parent()
        {
            var namescope = new NameScope();
            var content = new StackPanel()
            {
                Orientation = Orientation.Vertical,
                Width = 100,
                Margin = new Thickness(0, 200),
            };

            for(int i = 0; i < 100; i++)
            {
                var child = new Border
                {
                    Width = 100,
                    Height = 20,
                    Name = $"Border{i}"
                }.RegisterInNameScope(namescope);
                content.Children.Add(child);
            }
            var target = new ScrollContentPresenter
            {
                CanHorizontallyScroll = true,
                CanVerticallyScroll = true,
                Width = 200,
                Height = 100,
                Content = new Decorator
                {
                    Child = content
                }
            };

            NameScope.SetNameScope(target, namescope);

            target.UpdateChild();
            target.Measure(Size.Infinity);
            target.Arrange(new Rect(0, 0, 100, 100));

            // Border20 is at position 0,600 with bottom at Y=620
            var border20 = target.GetControl<Border>("Border20");
            target.BringDescendantIntoView(border20, new Rect(border20.Bounds.Size));

            // With viewport Height of 100, border becomes fully visible when alligned from the bottom at Offset Y=520, i.e. 620-100
            Assert.Equal(new Vector(0, 520), target.Offset);

            // Reset stack panel's margin
            content.Margin = default;
            target.Measure(Size.Infinity);
            target.Arrange(new Rect(0, 0, 100, 100));

            // Border20 is at position 0,800 with bottom at Y=820
            var border40 = target.GetControl<Border>("Border40");
            target.BringDescendantIntoView(border40, new Rect(border40.Bounds.Size));

            // With viewport Height of 100, border becomes fully visible when alligned from the bottom at Offset Y=720, i.e. 820-100
            Assert.Equal(new Vector(0, 720), target.Offset);
        }

        [Fact]
        public void BringDescendantIntoView_Should_Not_Move_Child_If_Completely_In_View()
        {
            var namescope = new NameScope();
            var content = new StackPanel()
            {
                Orientation = Orientation.Vertical,
                Width = 100,
            };

            for(int i = 0; i < 100; i++)
            {
                var child = new Border
                {
                    Width = 100,
                    Height = 20,
                    Name = $"Border{i}"
                }.RegisterInNameScope(namescope);
                content.Children.Add(child);
            }
            var target = new ScrollContentPresenter
            {
                CanHorizontallyScroll = true,
                CanVerticallyScroll = true,
                Width = 200,
                Height = 100,
                Content = new Decorator
                {
                    Child = content
                }
            };

            NameScope.SetNameScope(target, namescope);

            target.UpdateChild();
            target.Measure(Size.Infinity);
            target.Arrange(new Rect(0, 0, 100, 100));
            var border3 = target.GetControl<Border>("Border3");
            target.BringDescendantIntoView(border3, new Rect(border3.Bounds.Size));

            // Border3 is still in view, offset hasn't changed
            Assert.Equal(new Vector(0, 0), target.Offset);
        }

        [Fact]
        public void BringDescendantIntoView_Should_Move_Child_At_Least_Partially_Above_Viewport()
        {
            Border border = new Border
            {
                Width = 100,
                Height = 20
            };
            var content = new StackPanel()
            {
                Orientation = Orientation.Vertical,
                Width = 100,
            };

            for(int i = 0; i < 100; i++)
            {
                // border position will be (0,60)
                var child = i == 3 ? border : new Border
                {
                    Width = 100,
                    Height = 20,
                };
                content.Children.Add(child);
            }
            var target = new ScrollContentPresenter
            {
                CanHorizontallyScroll = true,
                CanVerticallyScroll = true,
                Width = 200,
                Height = 100,
                Content = new Decorator
                {
                    Child = content
                }
            };

            target.UpdateChild();
            target.Measure(Size.Infinity);
            target.Arrange(new Rect(0, 0, 100, 100));

            // move border to above the view port
            target.Offset = new Vector(0, 90);
            target.Arrange(new Rect(0, 0, 100, 100));
            target.BringDescendantIntoView(border, new Rect(border.Bounds.Size));

            Assert.Equal(new Vector(0, 60), target.Offset);

            // move border to partially above the view port
            target.Offset = new Vector(0, 70);
            target.Arrange(new Rect(0, 0, 100, 100));
            target.BringDescendantIntoView(border, new Rect(border.Bounds.Size));

            Assert.Equal(new Vector(0, 60), target.Offset);
        }

        [Fact]
        public void BringDescendantIntoView_Should_Not_Move_Child_If_Completely_Covers_Viewport()
        {
            Border border = new Border
            {
                Width = 100,
                Height = 200
            };
            var content = new StackPanel()
            {
                Orientation = Orientation.Vertical,
                Width = 100,
            };

            for (int i = 0; i < 100; i++)
            {
                // border position will be (0,60)
                var child = i == 3 ? border : new Border
                {
                    Width = 100,
                    Height = 20,
                };
                content.Children.Add(child);
            }
            var target = new ScrollContentPresenter
            {
                CanHorizontallyScroll = true,
                CanVerticallyScroll = true,
                Width = 200,
                Height = 100,
                Content = new Decorator
                {
                    Child = content
                }
            };

            target.UpdateChild();
            target.Measure(Size.Infinity);
            target.Arrange(new Rect(0, 0, 100, 100));
            // move border such that it's partially above viewport and partially below viewport
            target.Offset = new Vector(0, 90);
            target.Arrange(new Rect(0, 0, 100, 100));
            target.BringDescendantIntoView(border, new Rect(border.Bounds.Size));

            Assert.Equal(new Vector(0, 90), target.Offset);
        }

        [Fact]
        public void BringDescendantIntoView_Should_Move_Child_At_Least_Partially_Below_Viewport()
        {
            Border border = new Border
            {
                Width = 100,
                Height = 20
            };
            var content = new StackPanel()
            {
                Orientation = Orientation.Vertical,
                Width = 100,
            };

            for (int i = 0; i < 100; i++)
            {
                // border position will be (0,180)
                var child = i == 9 ? border : new Border
                {
                    Width = 100,
                    Height = 20,
                };
                content.Children.Add(child);
            }
            var target = new ScrollContentPresenter
            {
                CanHorizontallyScroll = true,
                CanVerticallyScroll = true,
                Width = 200,
                Height = 100,
                Content = new Decorator
                {
                    Child = content
                }
            };

            target.UpdateChild();
            target.Measure(Size.Infinity);
            target.Arrange(new Rect(0, 0, 100, 100));

            // border is at (0, 180) and below the viewport
            target.BringDescendantIntoView(border, new Rect(border.Bounds.Size));

            Assert.Equal(new Vector(0, 100), target.Offset);

            // move border to partially below the view port
            target.Offset = new Vector(0, 90);
            target.BringDescendantIntoView(border, new Rect(border.Bounds.Size));
        }

        [Fact]
        public void Nested_Presenters_Should_Scroll_Outer_When_Content_Exceeds_Viewport()
        {
            ScrollContentPresenter innerPresenter;
            Border border;

            var outerPresenter = new ScrollContentPresenter
            {
                CanHorizontallyScroll = true,
                CanVerticallyScroll = true,
                Width = 100,
                Height = 100,
                Content = innerPresenter = new ScrollContentPresenter
                {
                    CanHorizontallyScroll = true,
                    CanVerticallyScroll = true,
                    Width = 100,
                    Height = 200,
                    Content = border = new Border
                    {
                        Width = 200, // larger than viewport
                        Height = 25,
                        HorizontalAlignment = HorizontalAlignment.Left,
                        VerticalAlignment = VerticalAlignment.Top,
                        Margin = new Thickness(0, 120, 0, 0)
                    }
                }
            };

            innerPresenter.UpdateChild();
            outerPresenter.UpdateChild();
            outerPresenter.Measure(new Size(100, 100));
            outerPresenter.Arrange(new Rect(0, 0, 100, 100));

            border.BringIntoView();

            Assert.Equal(new Vector(0, 45), outerPresenter.Offset);
            Assert.Equal(new Vector(0, 0), innerPresenter.Offset);
        }

        [Fact]
        public void Nested_Presenters_Should_Scroll_Outer_When_Viewports_Are_Close()
        {
            ScrollContentPresenter innerPresenter;
            Border border;

            var outerPresenter = new ScrollContentPresenter
            {
                CanHorizontallyScroll = true,
                CanVerticallyScroll = true,
                Width = 100,
                Height = 170.0568181818182,
                UseLayoutRounding = false,
                Content = innerPresenter = new ScrollContentPresenter
                {
                    CanHorizontallyScroll = true,
                    CanVerticallyScroll = true,
                    Width = 100,
                    Height = 493.2613636363636,
                    UseLayoutRounding = false,
                    Content = new StackPanel
                    {
                        Children =
                        {
                            new Border
                            {
                                Height = 455.31818181818187,
                                UseLayoutRounding = false
                            },
                            (border = new Border {
                                Width = 100,
                                Height = 37.94318181818182,
                                UseLayoutRounding = false
                            })
                        }
                    }
                }
            };

            innerPresenter.UpdateChild();
            outerPresenter.UpdateChild();
            outerPresenter.Measure(new Size(100, 170.0568181818182));
            outerPresenter.Arrange(new Rect(0, 0, 100, 170.0568181818182));

            border.BringIntoView();

            Assert.Equal(new Vector(0, 323.20454545454544), outerPresenter.Offset);
            Assert.Equal(new Vector(0, 0), innerPresenter.Offset);
        }

        private class TestControl : Control
        {
            public Size AvailableSize { get; private set; }

            protected override Size MeasureOverride(Size availableSize)
            {
                AvailableSize = availableSize;
                return new Size(150, 150);
            }
        }
    }
}