osu-framework / osu.Framework / Graphics / Performance / GlobalStatisticsDisplay.cs

// Copyright (c) ppy Pty Ltd <[e-mail]>. Licensed under the MIT Licence.
// See the LICENCE file in the repository root for full licence text.

using System.Collections.Generic;
using System.Collections.Specialized;
using System.Linq;
using osu.Framework.Allocation;
using osu.Framework.Bindables;
using osu.Framework.Graphics.Containers;
using osu.Framework.Graphics.Sprites;
using osu.Framework.Graphics.Visualisation;
using osu.Framework.Platform;
using osu.Framework.Statistics;

namespace osu.Framework.Graphics.Performance
{
    /// <summary>
    /// Tracks global game statistics.
    /// </summary>
    internal class GlobalStatisticsDisplay : ToolWindow
    {
        private readonly FillFlowContainer<StatisticsGroup> groups;

        private DotNetRuntimeListener listener;

        private Bindable<bool> performanceLogging;

        public GlobalStatisticsDisplay()
            : base("Global Statistics", "(Ctrl+F2 to toggle)")
        {
            ScrollContent.Children = new Drawable[]
            {
                groups = new AlphabeticalFlow<StatisticsGroup>
                {
                    Padding = new MarginPadding(5),
                    RelativeSizeAxes = Axes.X,
                    AutoSizeAxes = Axes.Y,
                    Direction = FillDirection.Vertical,
                },
            };
        }

        [BackgroundDependencyLoader]
        private void load(GameHost host)
        {
            performanceLogging = host.PerformanceLogging.GetBoundCopy();
        }

        protected override void LoadComplete()
        {
            base.LoadComplete();

            GlobalStatistics.StatisticsChanged += (_, e) =>
            {
                switch (e.Action)
                {
                    case NotifyCollectionChangedAction.Add:
                        add(e.NewItems.Cast<IGlobalStatistic>());
                        break;

                    case NotifyCollectionChangedAction.Remove:
                        remove(e.OldItems.Cast<IGlobalStatistic>());
                        break;
                }
            };

            add(GlobalStatistics.GetStatistics());

            State.BindValueChanged(visibilityChanged, true);
        }

        private void visibilityChanged(ValueChangedEvent<Visibility> state)
        {
            performanceLogging.Value = state.NewValue == Visibility.Visible;

            if (state.NewValue == Visibility.Visible)
            {
                GlobalStatistics.OutputToLog();
                listener = new DotNetRuntimeListener();
            }
            else
                listener?.Dispose();
        }

        private void remove(IEnumerable<IGlobalStatistic> stats) => Schedule(() =>
        {
            foreach (var stat in stats)
                groups.FirstOrDefault(g => g.GroupName == stat.Group)?.Remove(stat);
        });

        private void add(IEnumerable<IGlobalStatistic> stats) => Schedule(() =>
        {
            foreach (var stat in stats)
            {
                var group = groups.FirstOrDefault(g => g.GroupName == stat.Group);

                if (group == null)
                    groups.Add(group = new StatisticsGroup(stat.Group));
                group.Add(stat);
            }
        });

        private class StatisticsGroup : CompositeDrawable, IAlphabeticalSort
        {
            public string GroupName { get; }

            private readonly FillFlowContainer<StatisticsItem> items;

            public StatisticsGroup(string groupName)
            {
                GroupName = groupName;

                RelativeSizeAxes = Axes.X;
                AutoSizeAxes = Axes.Y;

                InternalChildren = new Drawable[]
                {
                    new FillFlowContainer
                    {
                        RelativeSizeAxes = Axes.X,
                        AutoSizeAxes = Axes.Y,
                        Direction = FillDirection.Vertical,
                        Children = new Drawable[]
                        {
                            new SpriteText
                            {
                                Text = GroupName,
                                Font = FrameworkFont.Regular.With(weight: "Bold")
                            },
                            items = new AlphabeticalFlow<StatisticsItem>
                            {
                                Padding = new MarginPadding { Left = 5 },
                                RelativeSizeAxes = Axes.X,
                                AutoSizeAxes = Axes.Y,
                                Direction = FillDirection.Vertical,
                            },
                        }
                    },
                };
            }

            public void Add(IGlobalStatistic stat)
            {
                if (items.Any(s => s.Statistic == stat))
                    return;

                items.Add(new StatisticsItem(stat));
            }

            public void Remove(IGlobalStatistic stat)
            {
                items.FirstOrDefault(s => s.Statistic == stat)?.Expire();
            }

            private class StatisticsItem : CompositeDrawable, IAlphabeticalSort
            {
                public readonly IGlobalStatistic Statistic;

                private readonly SpriteText valueText;

                public StatisticsItem(IGlobalStatistic statistic)
                {
                    Statistic = statistic;

                    RelativeSizeAxes = Axes.X;
                    AutoSizeAxes = Axes.Y;

                    InternalChildren = new Drawable[]
                    {
                        new SpriteText
                        {
                            Font = FrameworkFont.Regular,
                            Colour = FrameworkColour.Yellow,
                            Text = Statistic.Name,
                            RelativeSizeAxes = Axes.X,
                            Width = 0.68f,
                        },
                        valueText = new SpriteText
                        {
                            Font = FrameworkFont.Condensed,
                            RelativePositionAxes = Axes.X,
                            X = 0.7f,
                            RelativeSizeAxes = Axes.X,
                            Width = 0.3f,
                        },
                    };
                }

                public string SortString => Statistic.Name;

                protected override void Update()
                {
                    base.Update();
                    valueText.Text = Statistic.DisplayValue;
                }
            }

            public string SortString => GroupName;
        }

        private interface IAlphabeticalSort
        {
            string SortString { get; }
        }

        private class AlphabeticalFlow<T> : FillFlowContainer<T> where T : Drawable, IAlphabeticalSort
        {
            public override IEnumerable<Drawable> FlowingChildren => base.FlowingChildren.Cast<T>().OrderBy(d => d.SortString);
        }

        protected override void Dispose(bool isDisposing)
        {
            base.Dispose(isDisposing);
            listener?.Dispose();
        }
    }
}