RobustToolbox/Robust.Client/UserInterface/Controls/ScrollContainer.cs

using System;
using System.Diagnostics.Contracts;
using System.Numerics;
using Robust.Shared.Maths;

namespace Robust.Client.UserInterface.Controls
{
    [Virtual]
    public class ScrollContainer : Container
    {
        private bool _queueScrolled = false;
        private bool _vScrollEnabled = true;
        private bool _hScrollEnabled = true;

        private bool? _vScrollBarHidden = null;
        private bool? _hScrollBarHidden = null;

        private bool _vScrollVisible;
        private bool _hScrollVisible;

        private readonly VScrollBar _vScrollBar;
        private readonly HScrollBar _hScrollBar;

        private bool _suppressScrollValueChanged;

        /// <summary>
        /// If true then if we have a y-axis scroll it will convert it to an x-axis scroll.
        /// </summary>
        public bool FallbackDeltaScroll { get; set; } = true;

        public int ScrollSpeedX { get; set; } = 50;
        public int ScrollSpeedY { get; set; } = 50;

        public float VScroll
        {
            get => _vScrollBar.Value;
            set => _vScrollBar.Value = value;
        }

        public float VScrollTarget
        {
            get => _vScrollBar.ValueTarget;
            set => _vScrollBar.ValueTarget = value;
        }

        public float HScroll
        {
            get => _hScrollBar.Value;
            set => _hScrollBar.Value = value;
        }

        public float HScrollTarget
        {
            get => _hScrollBar.ValueTarget;
            set => _hScrollBar.ValueTarget = value;
        }

        private bool _reserveScrollbarSpace;
        public bool ReserveScrollbarSpace
        {
            get => _reserveScrollbarSpace;
            set
            {
                if (value == _reserveScrollbarSpace)
                    return;

                _reserveScrollbarSpace = value;
                _vScrollBar.ReservesSpace = value;
                _hScrollBar.ReservesSpace = value;
            }
        }

        public bool ReturnMeasure { get; set; } = false;

        public event Action? OnScrolled;

        public ScrollContainer()
        {
            MouseFilter = MouseFilterMode.Pass;
            RectClipContent = true;

            Action<Range> ev = _scrollValueChanged;
            _hScrollBar = new HScrollBar
            {
                Visible = _hScrollEnabled,
                VerticalAlignment = VAlignment.Bottom,
                HorizontalAlignment = HAlignment.Stretch
            };
            _vScrollBar = new VScrollBar
            {
                Visible = _vScrollEnabled,
                VerticalAlignment = VAlignment.Stretch,
                HorizontalAlignment = HAlignment.Right
            };
            AddChild(_hScrollBar);
            AddChild(_vScrollBar);
            _hScrollBar.OnValueChanged += ev;
            _vScrollBar.OnValueChanged += ev;
            _vScrollBar.ReservesSpace = ReserveScrollbarSpace;
            _hScrollBar.ReservesSpace = ReserveScrollbarSpace;
        }

        public bool VScrollEnabled
        {
            get => _vScrollEnabled;
            set
            {
                _vScrollEnabled = value;
                InvalidateMeasure();
            }
        }

        public bool HScrollEnabled
        {
            get => _hScrollEnabled;
            set
            {
                _hScrollEnabled = value;
                InvalidateMeasure();
            }
        }

        /// <summary>
        /// <para>
        ///     Prevents the vertical scrollbar from being visible when <see langword="true"/>, and allows it to be visible when <see langword="false"/>.
        ///     When <see langword="null"/>, falls back to the value of the style property instead.
        /// </para>
        /// <para>
        ///    This is an override for the <see langword="bool"/> style property of the same name. Said style property mirrors the behavior of this property, and defaults to <see langword="false"/>.
        /// </para>
        /// </summary>
        /// <seealso cref="VScrollEnabled"/>
        /// <seealso cref="HScrollBarHidden"/>
        public bool? VScrollBarHidden
        {
            get => _vScrollBarHidden;
            set
            {
                _vScrollBarHidden = value;
                InvalidateArrange();
            }
        }

        /// <summary>
        /// <para>
        ///     Prevents the horizontal scrollbar from being visible when <see langword="true"/>, and allows it to be visible when <see langword="false"/>.
        ///     When <see langword="null"/>, falls back to the value of the style property instead.
        /// </para>
        /// <para>
        ///    This is an override for the <see langword="bool"/> style property of the same name. Said style property mirrors the behavior of this property, and defaults to <see langword="false"/>.
        /// </para>
        /// </summary>
        /// <seealso cref="HScrollEnabled"/>
        /// <seealso cref="VScrollBarHidden"/>
        public bool? HScrollBarHidden
        {
            get => _hScrollBarHidden;
            set
            {
                _hScrollBarHidden = value;
                InvalidateArrange();
            }
        }

        private bool StyleVScrollBarHidden =>
            _vScrollBarHidden ?? TryGetStyleProperty<bool>(nameof(VScrollBarHidden), out var v) && v;

        private bool StyleHScrollBarHidden =>
            _hScrollBarHidden ?? TryGetStyleProperty<bool>(nameof(HScrollBarHidden), out var v) && v;

        protected override Vector2 MeasureOverride(Vector2 availableSize)
        {
            if (_vScrollEnabled)
            {
                _vScrollBar.Measure(availableSize);
                availableSize.X -= _vScrollBar.DesiredSize.X;
            }

            if (_hScrollEnabled)
            {
                _hScrollBar.Measure(availableSize);
                availableSize.Y -= _hScrollBar.DesiredSize.Y;
            }

            var constraint = new Vector2(
                _hScrollEnabled ? float.PositiveInfinity : availableSize.X,
                _vScrollEnabled ? float.PositiveInfinity : availableSize.Y);

            var size = Vector2.Zero;
            foreach (var child in Children)
            {
                child.Measure(constraint);
                size = Vector2.Max(size, child.DesiredSize);
            }

            // Unlike WPF/Avalonia we default to reporting ZERO here instead of available size. This is to fix a bunch
            // of jank with e.g. BoxContainer.
            if (!ReturnMeasure)
                return Vector2.Zero;

            if (_vScrollEnabled && size.Y >= availableSize.Y)
                size.X += _vScrollBar.DesiredSize.X;

            if (_hScrollEnabled && size.X >= availableSize.X)
                size.Y += _hScrollBar.DesiredSize.Y;

            return size;
        }

        protected override Vector2 ArrangeOverride(Vector2 finalSize)
        {
            if (_vScrollBar?.Parent == null || _hScrollBar?.Parent == null)
            {
                // Just don't run this before we're properly initialized.
                return Vector2.Zero;
            }

            // We need to measure our children again, to ensure they're aware of
            // our real, final arrangement. It's a violation of invariants
            // to measure a large space then try to draw them in something smaller.
            //
            // We only call our override, not Measure, to avoid infinite loops.
            // We don't need to update ourselves after all.
            //
            // Atop that, we shouldn't remeasure if we ReturnMeasure, because then
            // we do actually use all of our space and no invariants are getting
            // broken unless our parent is themselves violating invariants.
            // So measuring again using the final size may result in us
            // mysteriously completely rearranging when we're not expected to.
            if (!ReturnMeasure)
                MeasureOverride(finalSize);

            var maxChildMinSize = Vector2.Zero;

            foreach (var child in Children)
            {
                if (child == _vScrollBar || child == _hScrollBar)
                {
                    continue;
                }

                maxChildMinSize = Vector2.Max(child.DesiredSize, maxChildMinSize);
            }

            var (cWidth, cHeight) = maxChildMinSize;
            var hBarSize = _hScrollBar.DesiredSize.Y;
            var vBarSize = _vScrollBar.DesiredSize.X;

            var (sWidth, sHeight) = finalSize;

            try
            {
                // Suppress events to avoid weird recursion.
                _suppressScrollValueChanged = true;

                if (sWidth < cWidth && _hScrollEnabled)
                {
                    sHeight -= hBarSize;
                }

                if (sHeight < cHeight && _vScrollEnabled)
                {
                    sWidth -= vBarSize;
                }

                if (sWidth < cWidth && _hScrollEnabled && !MathHelper.CloseTo(sWidth, cWidth, 1e-3))
                {
                    _hScrollBar.Visible = _hScrollVisible = !StyleHScrollBarHidden;
                    _hScrollBar.Page = sWidth;
                    _hScrollBar.MaxValue = cWidth;
                }
                else
                {
                    _hScrollBar.Visible = _hScrollVisible = false;
                }

                if (sHeight < cHeight && _vScrollEnabled && !MathHelper.CloseTo(sHeight, cHeight, 1e-3))
                {
                    _vScrollBar.Visible = _vScrollVisible = !StyleVScrollBarHidden;
                    _vScrollBar.Page = sHeight;
                    _vScrollBar.MaxValue = cHeight;
                }
                else
                {
                    _vScrollBar.Visible = _vScrollVisible = false;
                }
            }
            finally
            {
                // I really don't think this can throw an exception but oh well let's finally it.
                _suppressScrollValueChanged = false;
            }

            if (_vScrollVisible)
            {
                _vScrollBar.Arrange(UIBox2.FromDimensions(Vector2.Zero, finalSize));
            }

            if (_hScrollVisible)
            {
                _hScrollBar.Arrange(UIBox2.FromDimensions(Vector2.Zero, finalSize));
            }

            var realFinalSize = new Vector2(
                _hScrollEnabled ? Math.Max(cWidth, sWidth) : sWidth,
                _vScrollEnabled ? Math.Max(cHeight, sHeight) : sHeight);

            foreach (var child in Children)
            {
                if (child == _vScrollBar || child == _hScrollBar)
                {
                    continue;
                }

                var position = -GetScrollValue();
                var rect = UIBox2.FromDimensions(position, realFinalSize);
                child.Arrange(rect);
            }

            return finalSize;
        }

        protected override void ArrangeCore(UIBox2 finalRect)
        {
            base.ArrangeCore(finalRect);

            if (!_queueScrolled) return;

            OnScrolled?.Invoke();
            _queueScrolled = false;
        }

        protected internal override void MouseWheel(GUIMouseWheelEventArgs args)
        {
            base.MouseWheel(args);

            if (_vScrollEnabled)
            {
                _vScrollBar.ValueTarget -= args.Delta.Y * ScrollSpeedY;
            }

            if (_hScrollEnabled)
            {
                var delta =
                    args.Delta.X == 0f &&
                    !_vScrollEnabled &&
                    FallbackDeltaScroll ?
                        -args.Delta.Y :
                        args.Delta.X;

                _hScrollBar.ValueTarget += delta * ScrollSpeedX;
            }

            if (!_vScrollVisible && !_hScrollVisible)
                return;

            args.Handle();
        }

        protected override void ChildAdded(Control newChild)
        {
            base.ChildAdded(newChild);

            if (_vScrollBar?.Parent == null || _hScrollBar?.Parent == null)
            {
                // Just don't run this before we're properly initialized.
                return;
            }

            _vScrollBar?.SetPositionLast();
            _hScrollBar?.SetPositionLast();
        }

        [Pure]
        public Vector2 GetScrollValue(bool ignoreVisible = false)
        {
            if (ignoreVisible)
                return new(_hScrollBar.Value, _vScrollBar.Value);

            var h = _hScrollBar.Value;
            var v = _vScrollBar.Value;
            // reset the values if everything fits, this is usually the case when the scrollbar is hidden
            // when we intentionally hide the scrollbars this is not the case, so leave it as-is then
            if (!_hScrollVisible && _hScrollBarHidden != true)
                h = 0;

            if (!_vScrollVisible && _vScrollBarHidden != true)
                v = 0;

            return new Vector2(h, v);
        }

        public void SetScrollValue(Vector2 value)
        {
            _suppressScrollValueChanged = true;
            _hScrollBar.Value = value.X;
            _vScrollBar.Value = value.Y;
            _suppressScrollValueChanged = false;
            InvalidateArrange();
            _queueScrolled = true;
        }

        private void _scrollValueChanged(Range obj)
        {
            if (_suppressScrollValueChanged)
            {
                return;
            }

            InvalidateArrange();
            _queueScrolled = true;
        }
    }
}