From fb3b586a3569a6ee15c8ae36a12d2db0c97bf072 Mon Sep 17 00:00:00 2001
From: Ellpeck <me@ellpeck.de>
Date: Sun, 9 Jun 2024 20:29:23 +0200
Subject: [PATCH] Track element area update recursion count in UiMetrics

---
 CHANGELOG.md                |  1 +
 MLEM.Ui/Elements/Element.cs |  5 +++++
 MLEM.Ui/UiMetrics.cs        | 17 ++++++++++++++++-
 3 files changed, 22 insertions(+), 1 deletion(-)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 7f88478..a4b4cdb 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -32,6 +32,7 @@ Additions
 Improvements
 - **Include the SpriteBatchContext in OnDrawn, OnElementDrawn and OnSelectedElementDrawn**
 - Allow scrolling panels to set height based on children by setting TreatSizeAsMaximum
+- Track element area update recursion count in UiMetrics
 
 Fixes
 - Fixed hidden scroll bars inhibiting scrolling on their parent panel
diff --git a/MLEM.Ui/Elements/Element.cs b/MLEM.Ui/Elements/Element.cs
index e6d10d8..ba5aa81 100644
--- a/MLEM.Ui/Elements/Element.cs
+++ b/MLEM.Ui/Elements/Element.cs
@@ -832,6 +832,11 @@ namespace MLEM.Ui.Elements {
                     // we want to leave some leeway to prevent float rounding causing an infinite loop
                     if (!autoSize.Equals(this.UnscrolledArea.Size, Element.Epsilon)) {
                         recursion++;
+
+                        this.System.Metrics.SummedRecursionDepth++;
+                        if (recursion > this.System.Metrics.MaxRecursionDepth)
+                            this.System.Metrics.MaxRecursionDepth = recursion;
+
                         if (recursion >= 64)
                             throw new ArithmeticException($"The area of {this} has recursively updated too often. Does its child {foundChild} contain any conflicting auto-sizing settings?");
                         UpdateDisplayArea(autoSize);
diff --git a/MLEM.Ui/UiMetrics.cs b/MLEM.Ui/UiMetrics.cs
index 994cfc1..1d44366 100644
--- a/MLEM.Ui/UiMetrics.cs
+++ b/MLEM.Ui/UiMetrics.cs
@@ -29,6 +29,15 @@ namespace MLEM.Ui {
         /// The amount of times that <see cref="Element.Update"/> was called.
         /// </summary>
         public uint Updates { get; internal set; }
+        /// <summary>
+        /// The total amount of recursions that <see cref="Element.ForceUpdateArea"/> went through.
+        /// Can be divided by <see cref="ForceAreaUpdates"/> to get an average.
+        /// </summary>
+        public uint SummedRecursionDepth { get; internal set; }
+        /// <summary>
+        /// The maximum recursion depth that <see cref="Element.ForceUpdateArea"/> went through in a single call.
+        /// </summary>
+        public int MaxRecursionDepth { get; internal set; }
 
         /// <summary>
         /// The amount of time that <see cref="Element.Draw(Microsoft.Xna.Framework.GameTime,Microsoft.Xna.Framework.Graphics.SpriteBatch,float,MLEM.Graphics.SpriteBatchContext)"/> took.
@@ -49,6 +58,8 @@ namespace MLEM.Ui {
             this.ForceAreaUpdates = 0;
             this.ActualAreaUpdates = 0;
             this.Updates = 0;
+            this.SummedRecursionDepth = 0;
+            this.MaxRecursionDepth = 0;
         }
 
         /// <summary>
@@ -62,7 +73,7 @@ namespace MLEM.Ui {
         /// <summary>Returns the fully qualified type name of this instance.</summary>
         /// <returns>The fully qualified type name.</returns>
         public override string ToString() {
-            return $"{nameof(this.ForceAreaUpdateTime)}: {this.ForceAreaUpdateTime}, {nameof(this.UpdateTime)}: {this.UpdateTime}, {nameof(this.ForceAreaUpdates)}: {this.ForceAreaUpdates}, {nameof(this.ActualAreaUpdates)}: {this.ActualAreaUpdates}, {nameof(this.Updates)}: {this.Updates}, {nameof(this.DrawTime)}: {this.DrawTime}, {nameof(this.Draws)}: {this.Draws}";
+            return $"{nameof(this.ForceAreaUpdateTime)}: {this.ForceAreaUpdateTime}, {nameof(this.UpdateTime)}: {this.UpdateTime}, {nameof(this.ForceAreaUpdates)}: {this.ForceAreaUpdates}, {nameof(this.ActualAreaUpdates)}: {this.ActualAreaUpdates}, {nameof(this.Updates)}: {this.Updates}, {nameof(this.SummedRecursionDepth)}: {this.SummedRecursionDepth}, {nameof(this.MaxRecursionDepth)}: {this.MaxRecursionDepth}, {nameof(this.DrawTime)}: {this.DrawTime}, {nameof(this.Draws)}: {this.Draws}";
         }
 
         /// <summary>
@@ -78,6 +89,8 @@ namespace MLEM.Ui {
                 ForceAreaUpdates = left.ForceAreaUpdates + right.ForceAreaUpdates,
                 ActualAreaUpdates = left.ActualAreaUpdates + right.ActualAreaUpdates,
                 Updates = left.Updates + right.Updates,
+                SummedRecursionDepth = left.SummedRecursionDepth + right.SummedRecursionDepth,
+                MaxRecursionDepth = left.MaxRecursionDepth + right.MaxRecursionDepth,
                 DrawTime = left.DrawTime + right.DrawTime,
                 Draws = left.Draws + right.Draws
             };
@@ -96,6 +109,8 @@ namespace MLEM.Ui {
                 ForceAreaUpdates = left.ForceAreaUpdates - right.ForceAreaUpdates,
                 ActualAreaUpdates = left.ActualAreaUpdates - right.ActualAreaUpdates,
                 Updates = left.Updates - right.Updates,
+                SummedRecursionDepth = left.SummedRecursionDepth - right.SummedRecursionDepth,
+                MaxRecursionDepth = left.MaxRecursionDepth - right.MaxRecursionDepth,
                 DrawTime = left.DrawTime - right.DrawTime,
                 Draws = left.Draws - right.Draws
             };