Prepares for Fixing #4943 - Refactors ConfigurationManager to be based on MEC

Directory.Packages.props

@@ -14,6 +14,10 @@
     <PackageVersion Include="Microsoft.CodeAnalysis" Version="4.14.0" />
     <PackageVersion Include="Microsoft.CodeAnalysis.Common" Version="4.14.0" />
     <PackageVersion Include="Microsoft.CodeAnalysis.CSharp" Version="5.3.0" />
+    <PackageVersion Include="Microsoft.Extensions.Configuration" Version="10.0.7" />
+    <PackageVersion Include="Microsoft.Extensions.Configuration.Binder" Version="10.0.7" />
+    <PackageVersion Include="Microsoft.Extensions.Configuration.Json" Version="10.0.7" />
+    <PackageVersion Include="Microsoft.Extensions.Options" Version="10.0.7" />
     <PackageVersion Include="Microsoft.Extensions.Logging.Abstractions" Version="10.0.7" />
     <PackageVersion Include="Microsoft.Extensions.Logging" Version="10.0.7" />
     <PackageVersion Include="Microsoft.Extensions.DependencyInjection" Version="10.0.7" />

Terminal.Gui/App/Application.cs

@@ -4,7 +4,9 @@
 
 global using Attribute = Terminal.Gui.Drawing.Attribute;
 global using Color = Terminal.Gui.Drawing.Color;
+#pragma warning disable CS0618 // Obsolete - ConfigurationManager alias and ConfigurationPropertyAttribute still used internally during transition
 global using CM = Terminal.Gui.Configuration.ConfigurationManager;
+#pragma warning restore CS0618
 global using Terminal.Gui.App;
 global using Terminal.Gui.Testing;
 global using Terminal.Gui.Time;
@@ -22,6 +24,8 @@
 using System.Resources;
 using Terminal.Gui.Tracing;
 
+#pragma warning disable CS0618 // Obsolete - Application still uses ConfigurationPropertyAttribute/SettingsScope during transition
+
 namespace Terminal.Gui.App;
 
 /// <summary>
@@ -238,14 +242,14 @@ internal static List<CultureInfo> GetSupportedCultures ()
     [ConfigurationProperty (Scope = typeof (SettingsScope))]
     public static AppModel AppModel
     {
-        get;
+        get => ApplicationSettings.Defaults.AppModel;
         set
         {
-            AppModel oldValue = field;
-            field = value;
-            AppModelChanged?.Invoke (null, new ValueChangedEventArgs<AppModel> (oldValue, field));
+            AppModel oldValue = ApplicationSettings.Defaults.AppModel;
+            ApplicationSettings.Defaults.AppModel = value;
+            AppModelChanged?.Invoke (null, new ValueChangedEventArgs<AppModel> (oldValue, value));
         }
-    } = AppModel.FullScreen;
+    }
 
     /// <summary>
     ///     Gets or sets an override for the initial cursor position used in <see cref="AppModel.Inline"/> mode.
@@ -268,14 +272,14 @@ public static Point? ForceInlinePosition
     [ConfigurationProperty (Scope = typeof (SettingsScope))]
     public static string ForceDriver
     {
-        get;
+        get => ApplicationSettings.Defaults.ForceDriver;
         set
         {
-            string oldValue = field;
-            field = value;
-            ForceDriverChanged?.Invoke (null, new ValueChangedEventArgs<string> (oldValue, field));
+            string oldValue = ApplicationSettings.Defaults.ForceDriver;
+            ApplicationSettings.Defaults.ForceDriver = value;
+            ForceDriverChanged?.Invoke (null, new ValueChangedEventArgs<string> (oldValue, value));
         }
-    } = string.Empty;
+    }
 
     /// <summary>
     ///     Gets or sets the default key bindings for Application-level commands, optionally varying by platform.

Terminal.Gui/App/ApplicationImpl.Lifecycle.cs

@@ -2,6 +2,8 @@
 using Wcwidth;
 using Trace = Terminal.Gui.Tracing.Trace;
 
+#pragma warning disable CS0618 // Obsolete - ConfigurationManager still used internally during transition
+
 namespace Terminal.Gui.App;
 
 internal partial class ApplicationImpl

Terminal.Gui/App/Legacy/Application.Mouse.cs

@@ -9,12 +9,12 @@ public static partial class Application // Mouse handling
     [Obsolete ("The legacy static Application object is going away.")]
     public static bool IsMouseDisabled
     {
-        get;
+        get => ApplicationSettings.Defaults.IsMouseDisabled;
         set
         {
-            bool oldValue = field;
-            field = value;
-            IsMouseDisabledChanged?.Invoke (null, new ValueChangedEventArgs<bool> (oldValue, field));
+            bool oldValue = ApplicationSettings.Defaults.IsMouseDisabled;
+            ApplicationSettings.Defaults.IsMouseDisabled = value;
+            IsMouseDisabledChanged?.Invoke (null, new ValueChangedEventArgs<bool> (oldValue, value));
         }
     }
 

Terminal.Gui/App/Tracing/Trace.cs

@@ -39,9 +39,10 @@ public static class Trace
     [JsonConverter (typeof (TraceCategoryJsonConverter))]
     public static TraceCategory EnabledCategories
     {
-        get => _asyncLocalEnabledCategories.Value;
+        get => TraceSettings.Defaults.EnabledCategories;
         set
         {
+            TraceSettings.Defaults.EnabledCategories = value;
             _asyncLocalEnabledCategories.Value = value;
             EnsureBackendIfEnabled ();
         }

Terminal.Gui/Configuration/AppSettingsScope.cs

@@ -1,5 +1,7 @@
 using System.Text.Json.Serialization;
 
+#pragma warning disable CS0618 // Obsolete - AppSettingsScope references ConfigurationPropertyAttribute in docs
+
 namespace Terminal.Gui.Configuration;
 
 /// <summary>The <see cref="Scope{T}"/> class for application-defined configuration settings.</summary>
@@ -23,6 +25,7 @@ namespace Terminal.Gui.Configuration;
 ///    },
 ///  </code>
 /// </example>
+[Obsolete ("Use Microsoft.Extensions.Configuration with TuiConfigurationBuilder instead. See TuiConfigurationBuilder docs for migration guide.")]
 [JsonConverter (typeof (ScopeJsonConverter<AppSettingsScope>))]
 public class AppSettingsScope : Scope<AppSettingsScope>
 { }

Terminal.Gui/Configuration/AttributeJsonConverter.cs

@@ -1,6 +1,8 @@
 using System.Text.Json;
 using System.Text.Json.Serialization;
 
+#pragma warning disable CS0618 // Obsolete - JSON converter still uses ConfigurationManager.SerializerContext during transition
+
 namespace Terminal.Gui.Configuration;
 
 /// <summary>Json converter from the <see cref="Attribute"/> class.</summary>

Terminal.Gui/Configuration/ConcurrentDictionaryJsonConverter.cs

@@ -3,6 +3,8 @@
 using System.Text.Json;
 using System.Text.Json.Serialization;
 
+#pragma warning disable CS0618 // Obsolete - JSON converter still uses ConfigurationManager.SerializerContext during transition
+
 namespace Terminal.Gui.Configuration;
 
 internal class ConcurrentDictionaryJsonConverter<T> : JsonConverter<ConcurrentDictionary<string, T>>

Terminal.Gui/Configuration/ConfigProperty.cs

@@ -7,6 +7,8 @@
 using System.Text.Json.Serialization;
 using Terminal.Gui.Tracing;
 
+#pragma warning disable CS0618 // Obsolete - ConfigProperty references ConfigurationManager/ConfigurationPropertyAttribute internally
+
 namespace Terminal.Gui.Configuration;
 
 /// <summary>
@@ -19,6 +21,7 @@ namespace Terminal.Gui.Configuration;
 ///     serialization, a <see cref="JsonConverter"/> must be provided using the <see cref="JsonConverterAttribute"/>
 ///     attribute.
 /// </remarks>
+[Obsolete ("Being replaced by Microsoft.Extensions.Configuration. Will be removed in a future version.")]
 public class ConfigProperty
 {
     /// <summary>Describes the property.</summary>

Terminal.Gui/Configuration/ConfigPropertyHostTypes.cs

@@ -1,6 +1,8 @@
 using System.Diagnostics.CodeAnalysis;
 using Terminal.Gui.Tracing;
 
+#pragma warning disable CS0618 // Obsolete - ConfigPropertyHostTypes references ConfigurationPropertyAttribute during transition
+
 namespace Terminal.Gui.Configuration;
 
 /// <summary>
@@ -26,6 +28,7 @@ namespace Terminal.Gui.Configuration;
 ///         consumer apps.
 ///     </para>
 /// </remarks>
+[Obsolete ("Being replaced by Microsoft.Extensions.Configuration. Will be removed in a future version.")]
 internal static class ConfigPropertyHostTypes
 {
     private const DynamicallyAccessedMemberTypes PRESERVED_MEMBERS = DynamicallyAccessedMemberTypes.PublicProperties;

Terminal.Gui/Configuration/ConfigurationManager.cs

@@ -8,6 +8,8 @@
 using System.Text.Json.Serialization;
 using Trace = Terminal.Gui.Tracing.Trace;
 
+#pragma warning disable CS0618 // Obsolete - ConfigurationManager uses ConfigProperty/SettingsScope/ThemeScope internally
+
 namespace Terminal.Gui.Configuration;
 
 /// <summary>
@@ -46,6 +48,7 @@ namespace Terminal.Gui.Configuration;
 ///         See the UICatalog example for a complete example of how to use ConfigurationManager.
 ///     </para>
 /// </summary>
+[Obsolete ("ConfigurationManager is being replaced by Microsoft.Extensions.Configuration. Use TuiConfigurationBuilder instead. Will be removed in a future version.")]
 public static class ConfigurationManager
 {
     private static readonly Lock _appNameLock = new ();

Terminal.Gui/Configuration/ConfigurationPropertyAttribute.cs

@@ -5,6 +5,7 @@
 ///     [ConfigurationProperty(Scope = typeof(AppSettingsScope))] public static string? MyProperty { get; set; } = "MyValue";
 /// </example>
 [AttributeUsage (AttributeTargets.Property)]
+[Obsolete ("Use Settings POCOs with TuiConfigurationBuilder instead. Will be removed in a future version.")]
 public class ConfigurationPropertyAttribute : System.Attribute
 {
     /// <summary>

Terminal.Gui/Configuration/DeepCloner.cs

@@ -6,6 +6,8 @@
 using System.Text.Json;
 using System.Text.Json.Serialization.Metadata;
 
+#pragma warning disable CS0618 // Obsolete - DeepCloner still uses ConfigurationManager.SerializerContext during transition
+
 namespace Terminal.Gui.Configuration;
 
 /// <summary>
@@ -390,30 +392,43 @@ private static IDictionary CreateDictionaryInstance (Type dictType, object? comp
             return new Dictionary<string, Scheme?> ();
         }
 
+        if (dictType == typeof (Dictionary<Command, PlatformKeyBinding>))
+        {
+            return new Dictionary<Command, PlatformKeyBinding> ();
+        }
+
+        if (dictType == typeof (Dictionary<string, Dictionary<Command, PlatformKeyBinding>>))
+        {
+            if (comparer is IEqualityComparer<string> stringComparer)
+            {
+                return new Dictionary<string, Dictionary<Command, PlatformKeyBinding>> (stringComparer);
+            }
+
+            return new Dictionary<string, Dictionary<Command, PlatformKeyBinding>> ();
+        }
+
         // AOT-safe: use the source-generated JSON serializer to create empty dictionary instances.
         // This avoids Activator.CreateInstance, whose target constructors are trimmed by the AOT linker
         // for closed generic dictionary types not otherwise statically reachable.
-        // Only used when no comparer is needed — Deserialize("{}") always creates a default-comparer instance.
-        if (comparer is null)
+        // Always attempted regardless of comparer — in AOT, a default-comparer dictionary is preferable
+        // to a crash from a trimmed constructor.
+        try
         {
-            try
+            JsonTypeInfo? jsonTypeInfo = ConfigurationManager.SerializerContext.GetTypeInfo (dictType);
+
+            if (jsonTypeInfo is not null)
             {
-                JsonTypeInfo? jsonTypeInfo = ConfigurationManager.SerializerContext.GetTypeInfo (dictType);
+                IDictionary? result = JsonSerializer.Deserialize ("{}", jsonTypeInfo) as IDictionary;
 
-                if (jsonTypeInfo is not null)
+                if (result is not null)
                 {
-                    IDictionary? result = JsonSerializer.Deserialize ("{}", jsonTypeInfo) as IDictionary;
-
-                    if (result is not null)
-                    {
-                        return result;
-                    }
+                    return result;
                 }
             }
-            catch (InvalidOperationException)
-            {
-                // JSON serializer context may not be initialized — fall through to reflective construction.
-            }
+        }
+        catch (InvalidOperationException)
+        {
+            // JSON serializer context may not be initialized — fall through to reflective construction.
         }
 
         try

Terminal.Gui/Configuration/DictionaryJsonConverter.cs

@@ -2,6 +2,8 @@
 using System.Text.Json;
 using System.Text.Json.Serialization;
 
+#pragma warning disable CS0618 // Obsolete - JSON converter still uses ConfigurationManager.SerializerContext during transition
+
 namespace Terminal.Gui.Configuration;
 
 internal class DictionaryJsonConverter<T> : JsonConverter<Dictionary<string, T>>

Terminal.Gui/Configuration/SchemeJsonConverter.cs

@@ -1,6 +1,8 @@
 using System.Text.Json;
 using System.Text.Json.Serialization;
 
+#pragma warning disable CS0618 // Obsolete - JSON converter still uses ConfigurationManager.SerializerContext during transition
+
 namespace Terminal.Gui.Configuration;
 
 // ReSharper disable StringLiteralTypo

Terminal.Gui/Configuration/SchemeManager.cs

@@ -3,6 +3,8 @@
 using System.Diagnostics.CodeAnalysis;
 using System.Text.Json.Serialization;
 
+#pragma warning disable CS0618 // Obsolete - SchemeManager still uses ConfigurationManager/ConfigProperty/ThemeScope internally during transition
+
 namespace Terminal.Gui.Configuration;
 
 /// <summary>

Terminal.Gui/Configuration/Scope.cs

@@ -2,6 +2,8 @@
 using System.Diagnostics;
 using System.Diagnostics.CodeAnalysis;
 
+#pragma warning disable CS0618 // Obsolete - Scope uses ConfigProperty/ConfigurationPropertyAttribute internally
+
 namespace Terminal.Gui.Configuration;
 
 /// <summary>

Terminal.Gui/Configuration/ScopeJsonConverter.cs

@@ -6,6 +6,8 @@
 using System.Text.Json.Serialization;
 using System.Text.Json.Serialization.Metadata;
 
+#pragma warning disable CS0618 // Obsolete - ScopeJsonConverter still uses ConfigurationManager internally during transition
+
 namespace Terminal.Gui.Configuration;
 
 /// <summary>
@@ -140,8 +142,6 @@ public override TScopeT Read (ref Utf8JsonReader reader, Type typeToConvert, Jso
                 else
                 {
                     // Unknown property
-                    // TODO: To support forward compatibility, we should just ignore unknown properties?
-                    // TODO: Eg if we read an unknown property, it's possible that the property was added in a later version
                     throw new JsonException ($"{propertyName}: Unknown property name.");
                 }
             }

Terminal.Gui/Configuration/Settings/ApplicationSettings.cs

@@ -0,0 +1,23 @@
+namespace Terminal.Gui.Configuration;
+
+/// <summary>
+///     Settings POCO for application-level configuration (SettingsScope).
+///     These correspond to the static properties on <see cref="Application"/> and related classes.
+/// </summary>
+public class ApplicationSettings
+{
+    /// <summary>Gets or sets the application model (FullScreen or Inline).</summary>
+    public AppModel AppModel { get; set; } = AppModel.FullScreen;
+
+    /// <summary>Gets or sets the driver to force (e.g., "windows", "dotnet", "ansi"). Empty means auto-detect.</summary>
+    public string ForceDriver { get; set; } = string.Empty;
+
+    /// <summary>Gets or sets whether the mouse is disabled.</summary>
+    public bool IsMouseDisabled { get; set; }
+
+    /// <summary>
+    ///     The static facade instance. Always contains the current effective values.
+    ///     Updated by the MEC binding at <see cref="IApplication"/> initialization.
+    /// </summary>
+    public static ApplicationSettings Defaults { get; set; } = new ();
+}

Terminal.Gui/Configuration/Settings/ButtonSettings.cs

@@ -0,0 +1,19 @@
+namespace Terminal.Gui.Configuration;
+
+/// <summary>
+///     Settings POCO for <see cref="Views.Button"/> visual defaults (ThemeScope).
+/// </summary>
+public class ButtonSettings
+{
+    /// <summary>Gets or sets the default shadow style for buttons.</summary>
+    public ShadowStyles DefaultShadow { get; set; } = ShadowStyles.Opaque;
+
+    /// <summary>Gets or sets the default mouse highlight states for buttons.</summary>
+    public MouseState DefaultMouseHighlightStates { get; set; } = MouseState.In | MouseState.Pressed | MouseState.PressedOutside;
+
+    /// <summary>
+    ///     The static facade instance. Always contains the current effective values.
+    ///     Updated by the MEC binding at <see cref="IApplication"/> initialization.
+    /// </summary>
+    public static ButtonSettings Defaults { get; set; } = new ();
+}

Terminal.Gui/Configuration/Settings/CharMapSettings.cs

@@ -0,0 +1,16 @@
+namespace Terminal.Gui.Configuration;
+
+/// <summary>
+///     Settings POCO for <see cref="Views.CharMap"/> defaults (ThemeScope).
+/// </summary>
+public class CharMapSettings
+{
+    /// <summary>Gets or sets the default cursor style for character map views.</summary>
+    public CursorStyle DefaultCursorStyle { get; set; } = CursorStyle.BlinkingBlock;
+
+    /// <summary>
+    ///     The static facade instance. Always contains the current effective values.
+    ///     Updated by the MEC binding at <see cref="IApplication"/> initialization.
+    /// </summary>
+    public static CharMapSettings Defaults { get; set; } = new ();
+}