improve performance when accessing the non-scalar suffixes of a widget Style

Author: JonnyOThan

CHANGELOG.md

@@ -7,6 +7,10 @@
 - Add `JUMPSTACK` kRISC instruction to support jump tables for switch case (thanks @CoderCatGG) [commit](https://github.com/KSP-KOS/KOS/commit/3089ecc2f6bf15ee3a6d3a8722ce1efc7e8415c4)
 - Add `ALLHIDDENFIELDS`, `ALLHIDDENFIELDNAMES`, `HASHIDDENFIELD` and `GETHIDDENFIELD` to access fields of partmodules that are not visible in the UI (thanks @AntonKuzin) [commit](https://github.com/KSP-KOS/KOS/commit/c047c3210bf74fc529c7eb1703ad8110e6bc4abc)
 
+### Performance Improvements
+
+- Accessing the non-scalar suffixes of a widget `Style` no longer creates new objects - they are shared for each call.  This may be a breaking change if your script was relying on getting a distinct object each time.
+
 ### Bug Fixes
 
 - Fixed numeric formatting patters (thanks @sisve) [commit](https://github.com/KSP-KOS/KOS/commit/5780b75ff90e238c441ab71d366391b051e8bd14)

src/kOS/Suffixed/Widget/WidgetStyle.cs

@@ -42,12 +42,43 @@ RgbaColor TextColor
             }
         }
 
+        WidgetStyleRectOffset margin;
+        WidgetStyleRectOffset padding;
+        WidgetStyleRectOffset border;
+        WidgetStyleRectOffset overflow;
+        WidgetStyleState normal;
+        WidgetStyleState focused;
+        WidgetStyleState active;
+        WidgetStyleState hover;
+        WidgetStyleState onNormal;
+        WidgetStyleState onFocused;
+        WidgetStyleState onActive;
+        WidgetStyleState onHover;
+
+        WidgetStyleRectOffset CreateWidgetStyleRectOffsetSuffix(RectOffset rectOffset, ref WidgetStyleRectOffset suffix)
+        {
+            if (suffix == null)
+            {
+                suffix = new WidgetStyleRectOffset(rectOffset);
+            }
+            return suffix;
+        }
+
+        WidgetStyleState CreateWidgetStyleStateSuffix(GUIStyleState guiStyleState, ref WidgetStyleState suffix)
+        {
+            if (suffix == null)
+            {
+                suffix = new WidgetStyleState(guiStyleState);
+            }
+            return suffix;
+        }
+
         private void InitializeSuffixes()
         {
-            AddSuffix("MARGIN", new Suffix<WidgetStyleRectOffset>(() => new WidgetStyleRectOffset(Writable.margin)));
-            AddSuffix("PADDING", new Suffix<WidgetStyleRectOffset>(() => new WidgetStyleRectOffset(Writable.padding)));
-            AddSuffix("BORDER", new Suffix<WidgetStyleRectOffset>(() => new WidgetStyleRectOffset(Writable.border)));
-            AddSuffix("OVERFLOW", new Suffix<WidgetStyleRectOffset>(() => new WidgetStyleRectOffset(Writable.overflow)));
+            AddSuffix("MARGIN", new Suffix<WidgetStyleRectOffset>(() => CreateWidgetStyleRectOffsetSuffix(Writable.margin, ref margin)));
+            AddSuffix("PADDING", new Suffix<WidgetStyleRectOffset>(() => CreateWidgetStyleRectOffsetSuffix(Writable.padding, ref padding)));
+            AddSuffix("BORDER", new Suffix<WidgetStyleRectOffset>(() => CreateWidgetStyleRectOffsetSuffix(Writable.border, ref border)));
+            AddSuffix("OVERFLOW", new Suffix<WidgetStyleRectOffset>(() => CreateWidgetStyleRectOffsetSuffix(Writable.overflow, ref overflow)));
 
             AddSuffix("WIDTH", new SetSuffix<ScalarValue>(() => ReadOnly.fixedWidth, value => Writable.fixedWidth = value));
             AddSuffix("HEIGHT", new SetSuffix<ScalarValue>(() => ReadOnly.fixedHeight, value => Writable.fixedHeight = value));
@@ -58,14 +89,14 @@ private void InitializeSuffixes()
             AddSuffix("BG", new SetSuffix<StringValue>(() => "", value => Writable.normal.background = Widget.GetTexture(value)));
             AddSuffix("TEXTCOLOR", new SetSuffix<RgbaColor>(() => TextColor, value => TextColor = value));
 
-            AddSuffix("NORMAL", new Suffix<WidgetStyleState>(() => new WidgetStyleState(Writable.normal)));
-            AddSuffix("FOCUSED", new Suffix<WidgetStyleState>(() => new WidgetStyleState(Writable.focused)));
-            AddSuffix("ACTIVE", new Suffix<WidgetStyleState>(() => new WidgetStyleState(Writable.active)));
-            AddSuffix("HOVER", new Suffix<WidgetStyleState>(() => new WidgetStyleState(Writable.hover)));
-            AddSuffix(new[] { "ON", "NORMAL_ON" }, new Suffix<WidgetStyleState>(() => new WidgetStyleState(Writable.onNormal)));
-            AddSuffix("FOCUSED_ON", new Suffix<WidgetStyleState>(() => new WidgetStyleState(Writable.onFocused)));
-            AddSuffix("ACTIVE_ON", new Suffix<WidgetStyleState>(() => new WidgetStyleState(Writable.onActive)));
-            AddSuffix("HOVER_ON", new Suffix<WidgetStyleState>(() => new WidgetStyleState(Writable.onHover)));
+            AddSuffix("NORMAL", new Suffix<WidgetStyleState>(() => CreateWidgetStyleStateSuffix(Writable.normal, ref normal)));
+            AddSuffix("FOCUSED", new Suffix<WidgetStyleState>(() => CreateWidgetStyleStateSuffix(Writable.focused, ref focused)));
+            AddSuffix("ACTIVE", new Suffix<WidgetStyleState>(() => CreateWidgetStyleStateSuffix(Writable.active, ref active)));
+            AddSuffix("HOVER", new Suffix<WidgetStyleState>(() => CreateWidgetStyleStateSuffix(Writable.hover, ref hover)));
+            AddSuffix(new[] { "ON", "NORMAL_ON" }, new Suffix<WidgetStyleState>(() => CreateWidgetStyleStateSuffix(Writable.onNormal, ref onNormal)));
+            AddSuffix("FOCUSED_ON", new Suffix<WidgetStyleState>(() => CreateWidgetStyleStateSuffix(Writable.onFocused, ref onFocused)));
+            AddSuffix("ACTIVE_ON", new Suffix<WidgetStyleState>(() => CreateWidgetStyleStateSuffix(Writable.onActive, ref onActive)));
+            AddSuffix("HOVER_ON", new Suffix<WidgetStyleState>(() => CreateWidgetStyleStateSuffix(Writable.onHover, ref onHover)));
 
             AddSuffix("FONT", new SetSuffix<StringValue>(GetFont, SetFont));
             AddSuffix("FONTSIZE", new SetSuffix<ScalarIntValue>(() => ReadOnly.fontSize, value => Writable.fontSize = value));