Collapse dead post-GumCommon platform #if branches in Forms header usings (#3541)

vchelaru · claude · web-flow · commit 9c94486f2fbd · 2026-07-08T06:58:48.000-06:00
* Collapse dead post-GumCommon platform #if branches in Forms header usings The Gum Forms control files physically live in MonoGameGum/Forms/ but are compiled exactly once — into GumCommon (net8.0), which defines none of XNALIKE/RAYLIB/SOKOL/SKIA/FRB. Every runtime (MonoGame/KNI/FNA/Raylib/Sokol) compile-Removes them and consumes them from the GumCommon reference; FRB is the one exception, compiling these same files separately with FRB defined. So in each file's top-of-file using-selection block, the #elif XNALIKE / #elif RAYLIB / #elif SOKOL branches were dead code that nothing compiled — and actively misleading (they read as if MonoGame uses XNA Keys, which it no longer does after the shipped neutral-Keys migration). Collapsed each to just #if FRB / neutral #else. KeyCombo.cs rewritten from '#if !XNALIKE && !FRB' to the same '#if FRB / #else' shape (behavior-identical). Also deleted the dead '#if MONOGAME' block in FrameworkElementExt.cs (unused 'using Microsoft.Xna.Framework;' whose only consumer is a commented-out AddDebugOverlay), and corrected a KeyCombo comment made stale by the migration. Content-only edits: no files added/renamed/deleted, so no projitems changes. FRB #if branches and body platform #if blocks (TextBoxBase caret/native-keyboard, RangeBase MONOGAME, ANDROID) left untouched. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> * Document why TextBox caret fast-path stays #if XNALIKE, link #3542 The #if XNALIKE caret block in GetIndex is only compiled by FRB's XNA-family builds post-GumCommon migration; it gates an XNA bitmap-font capability (not FRB-ness), so it is intentionally not #if FRB. Tracks the IFormsText lift in #3542. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> * Document ListBox selection-modifier-key type change in May migration doc The four public static ListBox multi-select modifier keys (ToggleSelectionModifierKey, AlternateToggleSelectionModifierKey, RangeSelectionModifierKey, AlternateRangeSelectionModifierKey) also flipped from XNA Keys to Gum.Forms.Input.Keys when Forms moved to GumCommon, but were missing from the migration doc's widened-input-types section. Adds the table row plus a short subsection. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
diff --git a/MonoGameGum/Forms/Controls/ComboBox.cs b/MonoGameGum/Forms/Controls/ComboBox.cs
@@ -20,11 +20,6 @@
 using Buttons = FlatRedBall.Input.Xbox360GamePad.Button;
 using GamepadButton = FlatRedBall.Input.Xbox360GamePad.Button;
 namespace FlatRedBall.Forms.Controls;
-#elif XNALIKE
-using MonoGameGum.Input;
-using Gum.Input;
-using GamepadButton = Gum.Input.GamepadButton;
-using Microsoft.Xna.Framework.Input;
 #else
 using Gum.Input;
 using GamepadButton = Gum.Input.GamepadButton;
diff --git a/MonoGameGum/Forms/Controls/FrameworkElement.cs b/MonoGameGum/Forms/Controls/FrameworkElement.cs
@@ -32,24 +32,13 @@
 using Buttons = FlatRedBall.Input.Xbox360GamePad.Button;
 using GamepadButton = FlatRedBall.Input.Xbox360GamePad.Button;
 namespace FlatRedBall.Forms.Controls;
-#elif XNALIKE
-using Keys = Microsoft.Xna.Framework.Input.Keys;
-using Microsoft.Xna.Framework.Input;
-using MonoGameGum.Input;
-using Gum.Input;
-using GamepadButton = Gum.Input.GamepadButton;
-using Gum.Converters;
-#elif RAYLIB
-using RaylibGum;
-using Gum.Input;
-using Keys = Gum.Forms.Input.Keys;
-#elif SOKOL
-using Gum.Input;
-using Keys = Gum.Forms.Input.Keys;
 #else
-// Default branch — used when this file is compiled into GumCommon, which defines
-// none of FRB/XNALIKE/RAYLIB/SOKOL. The Forms abstraction lives in Gum.Input /
-// Gum.Forms.Input, so the headless build picks up the same shared types Raylib/Sokol use.
+// Non-FRB branch. These Forms control files compile exactly once — into GumCommon
+// (net8.0), which defines none of XNALIKE/RAYLIB/SOKOL/SKIA. Every runtime
+// (MonoGame/KNI/FNA/Raylib/Sokol) compile-Removes them and consumes them from that
+// GumCommon reference, so the former per-platform #elif branches were dead code and
+// were removed; only FRB compiles these files separately and keeps its own branch above.
+// The Forms abstraction lives in Gum.Input / Gum.Forms.Input.
 using Gum.Input;
 using Keys = Gum.Forms.Input.Keys;
 #endif
diff --git a/MonoGameGum/Forms/Controls/FrameworkElementExt.cs b/MonoGameGum/Forms/Controls/FrameworkElementExt.cs
@@ -20,12 +20,6 @@ namespace MonoGameGum.Forms.Controls;
 namespace Gum.Forms.Controls;
 #endif
 
-#if MONOGAME
-
-using Microsoft.Xna.Framework;
-
-#endif
-
 
 public static class FrameworkElementExt
 {
diff --git a/MonoGameGum/Forms/Controls/ListBox.cs b/MonoGameGum/Forms/Controls/ListBox.cs
@@ -24,11 +24,6 @@
 using Buttons = FlatRedBall.Input.Xbox360GamePad.Button;
 using static FlatRedBall.Input.Xbox360GamePad;
 namespace FlatRedBall.Forms.Controls;
-#elif XNALIKE
-using MonoGameGum.Input;
-using Gum.Input;
-using GamepadButton = Gum.Input.GamepadButton;
-using Microsoft.Xna.Framework.Input;
 #else
 using Gum.Input;
 using GamepadButton = Gum.Input.GamepadButton;
diff --git a/MonoGameGum/Forms/Controls/Primitives/ButtonBase.cs b/MonoGameGum/Forms/Controls/Primitives/ButtonBase.cs
@@ -15,11 +15,6 @@
 using GamepadButton = FlatRedBall.Input.Xbox360GamePad.Button;
 using static FlatRedBall.Input.Xbox360GamePad;
 namespace FlatRedBall.Forms.Controls.Primitives;
-#elif XNALIKE
-using Microsoft.Xna.Framework.Input;
-using MonoGameGum.Input;
-using Gum.Input;
-using GamepadButton = Gum.Input.GamepadButton;
 #else
 using Gum.Input;
 using GamepadButton = Gum.Input.GamepadButton;
diff --git a/MonoGameGum/Forms/Controls/Primitives/RangeBase.cs b/MonoGameGum/Forms/Controls/Primitives/RangeBase.cs
@@ -12,8 +12,6 @@
 using FlatRedBall.Gui;
 using InteractiveGue = global::Gum.Wireframe.GraphicalUiElement;
 namespace FlatRedBall.Forms.Controls.Primitives;
-#elif XNALIKE
-using MonoGameGum.Input;
 #endif
 
 
diff --git a/MonoGameGum/Forms/Controls/ScrollBar.cs b/MonoGameGum/Forms/Controls/ScrollBar.cs
@@ -10,9 +10,6 @@
 using FlatRedBall.Forms.Controls.Primitives;
 using InteractiveGue = global::Gum.Wireframe.GraphicalUiElement;
 namespace FlatRedBall.Forms.Controls;
-#elif XNALIKE
-using Microsoft.Xna.Framework;
-using MonoGameGum.Input;
 #endif
 
 #if !FRB
diff --git a/MonoGameGum/Forms/Controls/ScrollViewer.cs b/MonoGameGum/Forms/Controls/ScrollViewer.cs
@@ -17,10 +17,6 @@
 using InteractiveGue = global::Gum.Wireframe.GraphicalUiElement;
 using Buttons = FlatRedBall.Input.Xbox360GamePad.Button;
 namespace FlatRedBall.Forms.Controls;
-#elif XNALIKE
-using GamepadButton = Gum.Input.GamepadButton;
-using Microsoft.Xna.Framework.Input;
-using MonoGameGum.Input;
 #else
 using Gum.Input;
 using GamepadButton = Gum.Input.GamepadButton;
diff --git a/MonoGameGum/Forms/Controls/Slider.cs b/MonoGameGum/Forms/Controls/Slider.cs
@@ -17,11 +17,6 @@
 using static FlatRedBall.Input.Xbox360GamePad;
 using GamepadButton = FlatRedBall.Input.Xbox360GamePad.Button;
 namespace FlatRedBall.Forms.Controls;
-#elif XNALIKE
-using Microsoft.Xna.Framework.Input;
-using MonoGameGum.Input;
-using Gum.Input;
-using GamepadButton = Gum.Input.GamepadButton;
 #else
 using Gum.Input;
 using GamepadButton = Gum.Input.GamepadButton;
diff --git a/MonoGameGum/Forms/Controls/TextBoxBase.cs b/MonoGameGum/Forms/Controls/TextBoxBase.cs
@@ -20,11 +20,6 @@
 using GamepadButton = FlatRedBall.Input.Xbox360GamePad.Button;
 using RenderingLibrary.Graphics;
 namespace FlatRedBall.Forms.Controls;
-#elif XNALIKE
-using Microsoft.Xna.Framework.Input;
-using RenderingLibrary.Graphics;
-using MonoGameGum.Input;
-using GamepadButton = Gum.Input.GamepadButton;
 #else
 using Gum.Input;
 using GamepadButton = Gum.Input.GamepadButton;
@@ -771,6 +766,15 @@ internal int GetCaretIndexAtPosition(float screenX, float screenY)
     // long lines. If you change behavior here, **change BOTH branches**
     // and verify with a test that exercises GetCaretIndexAtPosition under
     // XNALIKE (typing alone does not hit GetIndex).
+    //
+    // NOTE (post-GumCommon migration): these control files now compile in
+    // GumCommon (which defines no XNALIKE), so standalone MonoGame/KNI/FNA/
+    // Raylib/Skia all take the #else path — only FRB's XNA-family builds still
+    // compile the #if XNALIKE fast path. It stays #if XNALIKE (not #if FRB) on
+    // purpose: it gates an XNA bitmap-font *capability*, and FRB has non-XNA
+    // builds (e.g. FlatRedBall.Forms.DesktopGL, SkiaInGum) that correctly use
+    // the #else path. Lifting this into IFormsText so every backend gets the
+    // fast path is tracked in https://github.com/vchelaru/Gum/issues/3542
     private int GetIndex(float cursorOffset, string textToUse)
     {
         var index = textToUse?.Length ?? 0;
diff --git a/MonoGameGum/Input/KeyCombo.cs b/MonoGameGum/Input/KeyCombo.cs
@@ -5,10 +5,10 @@
 using System.Text;
 using System.Threading.Tasks;
 
-#if !XNALIKE && !FRB
-using Keys = Gum.Forms.Input.Keys;
-#else
+#if FRB
 using Microsoft.Xna.Framework.Input;
+#else
+using Keys = Gum.Forms.Input.Keys;
 #endif
 
 // Needs to be in this namespace since it was originally
@@ -25,7 +25,7 @@ public struct KeyCombo
 
 public static class KeyComboExtensions
 {
-    // Converts the platform-local Keys alias (XNA Keys on MonoGame, Gum Keys on Raylib/Sokol)
+    // Converts the platform-local Keys alias (XNA Keys under FRB, Gum Keys everywhere else)
     // to the shared Gum.Forms.Input.Keys that IInputReceiverKeyboard's interface methods accept.
     // Values align across both enums, so an int round-trip is safe.
     private static Gum.Forms.Input.Keys ToGumKey(Keys key) => (Gum.Forms.Input.Keys)(int)key;
diff --git a/docs/gum-tool/upgrading/migrating-to-2026-may.md b/docs/gum-tool/upgrading/migrating-to-2026-may.md
@@ -522,6 +522,7 @@ Most user code is unaffected. The common path — reading `GumService.Keyboard`
 | `ListBox.ControllerButtonPushed` event arg | XNA `Buttons` | `Gum.Input.GamepadButton` |
 | `KeyCombo.PushedKey` / `HeldKey` | XNA `Keys` | `Gum.Forms.Input.Keys` |
 | `KeyEventArgs.Key` | XNA `Keys` | `Gum.Forms.Input.Keys` |
+| `ListBox` selection modifier keys (`ToggleSelectionModifierKey`, etc.) | XNA `Keys` | `Gum.Forms.Input.Keys` |
 
 The `MonoGameGum.Input.GamePad` **class** itself is unchanged — `GumService.GamePads` still returns instances of it, and they still expose `XnaGamePad`, `Capabilities`, etc. Only the static type of the `FrameworkElement.GamePadsForUiControl` list element changed.
 
@@ -577,6 +578,22 @@ textBox.KeyDown += (s, e) =>
 };
 ```
 
+#### `ListBox` selection modifier keys
+
+`ListBox.ToggleSelectionModifierKey`, `AlternateToggleSelectionModifierKey`, `RangeSelectionModifierKey`, and `AlternateRangeSelectionModifierKey` — the `public static` keys that gate multi-select (Ctrl / Shift by default) — are now typed `Gum.Forms.Input.Keys`. Only code that reassigns them needs the type swap.
+
+❌ Old:
+
+```csharp
+ListBox.RangeSelectionModifierKey = Microsoft.Xna.Framework.Input.Keys.LeftAlt;
+```
+
+✅ New:
+
+```csharp
+ListBox.RangeSelectionModifierKey = Gum.Forms.Input.Keys.LeftAlt;
+```
+
 #### `DPadDirection` namespace
 
 The `MonoGameGum.Input.DPadDirection` enum has been deleted. The canonical copy in `Gum.Input.DPadDirection` (with identical values) is now the only one. Code that calls `gamepad.AsDPadPushed(DPadDirection.Up)` keeps working as long as `Gum.Input` is in scope — add `using Gum.Input;` and remove `using MonoGameGum.Input;` if you hit `CS0246: The type or namespace name 'DPadDirection' could not be found`.
