Files
Terminal.Gui/docfx/docs/config.md
Copilot c5906c2dc1 #4329—Major Terminal.Gui v2 Architecture Modernization: Application Decoupling, Terminology Improvements, and Nullable Migration (#4338)
* Initial plan

* Add comprehensive terminology proposal for Application.Top/Toplevel renaming

Co-authored-by: tig <585482+tig@users.noreply.github.com>

* Add terminology proposal summary document

Co-authored-by: tig <585482+tig@users.noreply.github.com>

* Add before/after comparison document for terminology proposal

Co-authored-by: tig <585482+tig@users.noreply.github.com>

* Add index document for terminology proposal

Co-authored-by: tig <585482+tig@users.noreply.github.com>

* Add Mermaid diagrams visualizing the terminology proposal

Co-authored-by: tig <585482+tig@users.noreply.github.com>

* Move terminology docs to docfx/docs per CONTRIBUTING.md guidelines

Co-authored-by: tig <585482+tig@users.noreply.github.com>

* Update terminology proposal to reflect recent modernization (post-MainLoop removal)

Co-authored-by: tig <585482+tig@users.noreply.github.com>

* Update terminology proposal - validate against recent driver refactoring changes

Co-authored-by: tig <585482+tig@users.noreply.github.com>

* Update proposal after massive v2_develop modernization - TopLevels now public, RunState→SessionToken

Co-authored-by: tig <585482+tig@users.noreply.github.com>

* Update proposal: RunStack → SessionStack to align with SessionToken terminology

Co-authored-by: tig <585482+tig@users.noreply.github.com>

* Phase 1: Core API rename - Application.Top→Current, TopLevels→SessionStack

Co-authored-by: tig <585482+tig@users.noreply.github.com>

* Phase 2: Fix test compilation errors for renamed properties

Co-authored-by: tig <585482+tig@users.noreply.github.com>

* Phase 3: Update documentation files with new terminology

Co-authored-by: tig <585482+tig@users.noreply.github.com>

* Refactor generic type names and remove unused field

Renamed generic type parameters in `Dim` and `Pos` classes for clarity:
- `T` was renamed to `TDim` in `Dim.Has` method.
- `T` was renamed to `TPos` in `Pos.Has` method.
Updated type casting and pattern matching logic to reflect these changes.

Removed the unused `_stopAfterFirstIteration` field from the `ApplicationImpl` class to clean up the codebase.

* Increase minimum code coverage target to 75%

Updated the `codecov.yml` configuration file to raise the
`project.default.target` value from 70% to 75%, enforcing
stricter code coverage requirements for the overall project.

* Add comprehensive unit tests for ApplicationImpl Begin/End logic

Added ApplicationImplBeginEndTests with 16 tests covering:
- Begin/End argument validation
- SessionStack push/pop operations
- Current property management
- Balanced Begin/End enforcement
- Multiple nested Begin/End scenarios
- ResetState cleanup behavior
- Toplevel activation/deactivation
- SessionToken management

Tests validate the fragile state management logic in ApplicationImpl.Lifecycle.cs
and ApplicationImpl.Run.cs to catch regressions in Current/SessionStack handling.

Co-authored-by: tig <585482+tig@users.noreply.github.com>

* Refactor ApplicationImplBeginEndTests to work with ApplicationImpl instances directly

Tests now:
- Create ApplicationImpl instances directly instead of using global Application
- Use try-finally blocks to ensure Shutdown() is always called
- Work with app.Init() and app.Shutdown() properly
- 13 of 16 tests passing (3 tests need adjustment for ResetState behavior)

Tests validate fragile Begin/End state management logic without polluting global Application state.

Co-authored-by: tig <585482+tig@users.noreply.github.com>

* Fix ApplicationImplBeginEndTests: Remove explicit ResetState calls, rely on Shutdown

Per maintainer feedback:
- Tests should not call ResetState explicitly if they call Shutdown (Shutdown calls ResetState)
- Removed all explicit app.ResetState() calls from tests
- Tests now only call Shutdown in finally blocks for cleanup
- Ensured toplevels are disposed BEFORE Shutdown to satisfy DEBUG_IDISPOSABLE assertions
- Fixed test cleanup order to prevent ResetState assertion failures
- All 16 tests now pass successfully

ResetState is idempotent - the issue was tests calling it unnecessarily and with incorrect disposal ordering.

Co-authored-by: tig <585482+tig@users.noreply.github.com>

* Phase 1: Enable nullable by default, add directives to all files

- Added <Nullable>enable</Nullable> to Terminal.Gui.csproj
- Removed #nullable enable from 37 files (now redundant with project setting)
- Added #nullable disable to 170 files that don't have nullable enabled yet
- Build successful with 279 nullable warnings (expected)

Breakdown of files with #nullable disable:
- 27 in Views/ directory (will remain disabled per plan)
- 143 outside Views/ (need to be fixed in subsequent commits)

Next: Systematically fix nullable issues in non-View files.

Co-authored-by: tig <585482+tig@users.noreply.github.com>

* Phase 2: Remove nullable disable from all non-View files - COMPLETE!

- Removed #nullable disable from 142 non-View files
- All non-View code is now nullable-enabled
- Build successful with 0 errors, only 1 unrelated warning
- Created NULLABLE_VIEWS_REMAINING.md documenting the 121 View files still with nullable disable

Nullable cleanup summary:
 App/: 25 files - nullable enabled
 Configuration/: 24 files - nullable enabled
 ViewBase/: 30 files - nullable enabled
 Drivers/: 25 files - nullable enabled
 Drawing/: 18 files - nullable enabled
 FileServices/: 7 files - nullable enabled
 Input/: 6 files - nullable enabled
 Text/: 5 files - nullable enabled
 Resources/: 3 files - nullable enabled
⏸️  Views/: 121 files - remain disabled (as requested)

Total: 143 files nullable-enabled, 121 View files remain disabled.

Co-authored-by: tig <585482+tig@users.noreply.github.com>

* WIP: fixing nullability issues.

* Fixed final nullability issues.

* Moved Arrangment tests

* Refactor and improve modularity across multiple classes

Refactored `FillRectangles` in `RegionScenario` and `Region` to accept an `IDriver` parameter, reducing reliance on global state. Updated `ApplicationImpl` to replace static method calls with instance methods for better encapsulation. Renamed `Toplevel` to `Current` in `IPopover` and related classes for clarity.

Simplified `LineCanvas` methods by removing unnecessary `IDriver` parameters. Added `Id` and `App` properties to `View` for better state management and unique identification. Streamlined the `Driver` property in `View` with a concise getter.

Improved formatting and consistency across files, including `Region` and `IntersectionRuneResolver`. Enhanced thread safety in `Region` and cleaned up redundant code. Updated tests to align with interface changes and ensure compatibility.

* Refactor to make IDriver dependency explicit

Updated `AnsiEscapeSequenceRequest.Send` to accept an `IDriver?` parameter, replacing reliance on `Application.Driver`. Refactored `AnsiRequestScheduler` methods (`SendOrSchedule`, `RunSchedule`, and private `Send`) to propagate the `IDriver?` parameter, ensuring explicit driver dependency.

Modified `DriverImpl.QueueAnsiRequest` to pass `this` to `SendOrSchedule`. Updated `AnsiRequestSchedulerTests` to reflect new method signatures, passing `null` for the driver parameter where applicable.

Added `<param>` documentation for new parameters to improve clarity. These changes enhance flexibility, maintainability, and testability by reducing reliance on global state and allowing driver substitution in tests.

* WIP: Started migrating to View.App

Refactored `ApplicationImpl` to ensure proper handling of the `App`
property for `Toplevel` instances, improving modularity. Replaced
direct references to `Application` with `App` in `Border`, `ShadowView`,
and other classes to enhance flexibility and maintainability.

Introduced `GetApp` in `View` to allow overrides for retrieving the
`App` instance. Updated `Adornment` to use this method. Moved mouse
event subscriptions in `Border` to `BeginInit` for proper lifecycle
management.

Updated unit tests in `ArrangementTests` to use `App.Mouse` instead of
`Application.Mouse`, ensuring alignment with the refactored design.
Added `BeginInit` and `EndInit` calls for proper initialization during
tests. Removed redundant code and improved test assertions.

* WIP: Next set of View.App changes

Updated `SetClipToScreen`, `SetClip`, and `GetClip` methods to accept an `IDriver` parameter, replacing reliance on the global `Application.Driver`. This improves modularity, testability, and reduces implicit global state usage.

- Updated `Driver` property in `View` to use `App?.Driver` as fallback.
- Refactored `DimAuto` to use `App?.Screen.Size` with a default for unit tests.
- Updated all test cases to align with the new method signatures.
- Performed general cleanup for consistency and readability.

* Adds View clip tests.

* Merged

* Merged

* wip

* Fixed test bug.

* Refactored Thickness.Draw to require driver.

* Made TextFormatter.Draw require driver.

* Code cleanup.

* Un did stoopid idea.

* Decouped Application.Navigation

* MASSIVE - Almost completely decoupled Application from View etc...

* Obsolete

* Missed some

* More cleanup and decoupling.

Refactor `ToString` and remove legacy code

Refactored `ToString` implementations across `Application`, `DriverImpl`, and `IDriver` to improve consistency and maintainability. Removed the legacy `ToString(IDriver? driver)` method and its associated references. Simplified `ToString` in `DriverImpl` to generate a string representation of the `Contents` buffer.

Replaced redundant XML documentation with `<inheritdoc/>` tags to reduce duplication. Cleaned up unused `global using` directives and removed deprecated methods and properties, including `Screen`, `SetCursorVisibility`, and `IsRuneSupported`.

Updated test cases in `GuiTestContext` and `DriverAssert` to use the new `ToString` implementation. Improved error messages for better debugging output. Streamlined LINQ queries and removed redundant checks for better readability and performance.

Enhanced maintainability by decluttering the codebase, aligning namespaces, and consolidating related changes.

* Changes before error encountered

Co-authored-by: tig <585482+tig@users.noreply.github.com>

* Update docfx/docs to document View.App architecture and instance-based patterns

Updated 16 documentation files to reflect the major architectural changes:

NEW FILES:
- application.md: Comprehensive deep dive on decoupled Application architecture

UPDATED FILES:
- View.md: Documents View.App property, GetApp(), and instance-based patterns
- navigation.md: Shows View.App usage instead of static Application
- drivers.md: Documents View.Driver and GetDriver() patterns
- keyboard.md: Event handling through View.App
- mouse.md: Mouse event handling via View.App
- arrangement.md: Updated code examples to use View.App
- drawing.md: Rendering examples with instance-based API
- cursor.md: Cursor management through View.App
- multitasking.md: SessionStack and session management via View.App
- Popovers.md: Popover patterns with View.App
- cancellable-work-pattern.md: Updated examples
- command.md: Command pattern with View.App context
- config.md: Configuration access through View.App
- migratingfromv1.md: Migration guide for static→instance patterns
- newinv2.md: Documents new instance-based architecture

All code examples now demonstrate the instance-based API (view.App.Current)
instead of obsolete static Application references. Documentation accurately
reflects the massive architectural decoupling achieved in this PR.

Co-authored-by: tig <585482+tig@users.noreply.github.com>

* Add `ToAnsi` support for ANSI escape sequence generation

Introduced `ToAnsi` in `IDriver` and `IOutput` interfaces to generate
ANSI escape sequences representing the terminal's current state. This
enables serialization of terminal content for debugging, testing, and
exporting.

Implemented `ToAnsi` in `DriverImpl` and `FakeOutput`, supporting both
16-color and RGB modes. Refactored `OutputBase` with helper methods
`BuildAnsiForRegion` and `AppendCellAnsi` for efficient ANSI generation.

Enhanced `GuiTestContext` with `AnsiScreenShot` for capturing terminal
state during tests. Added `ToAnsiTests` for comprehensive validation,
including edge cases, performance, and wide/Unicode character handling.

Updated documentation to reflect `ToAnsi` functionality and modernized
driver architecture. Improved testability, modularity, and performance
while removing legacy driver references.

* Improve null safety and cleanup in GuiTestContext

Enhanced null safety across `GuiTestContext` and `GuiTestContextTests`:
- Replaced `a` with `app` for better readability in tests.
- Added null checks (`!`, `?.`) to prevent potential null reference exceptions.
- Removed redundant `WaitIteration` and duplicate `ScreenShot` calls.

Improved error handling and robustness:
- Updated shutdown logic to use null-safe calls for `RequestStop` and `Shutdown`.
- Applied null-safe invocation for `_applicationImpl.Invoke`.

General cleanup:
- Removed redundant method calls and improved naming consistency.
- Ensured better maintainability and adherence to best practices.

* Refactor docs: remove deprecated files, update architecture

Removed outdated documentation files related to the terminology
proposal (`terminology-before-after.md`, `terminology-diagrams.md`,
`terminology-index.md`, `terminology-proposal-summary.md`,
`terminology-proposal.md`) from the `Docs` project. These files
were either deprecated or consolidated into other documentation.

Updated `application.md`:
- Added a "View Hierarchy and Run Stack" section with a Mermaid
  diagram to illustrate the relationship between the view hierarchy
  and the application session stack.
- Added a "Usage Example Flow" section with a sequence diagram
  to demonstrate the flow of running and stopping views.

These changes improve clarity, streamline documentation, and
align with the finalized terminology updates for the
`Application.Current` and `Application.SessionStack` APIs.

* Refactor Init/Run methods to simplify driver handling

The `Init` method in `Application` and `IApplication` now accepts only an optional `driverName` parameter, removing the `IDriver` parameter. This simplifies initialization by relying on driver names to determine the appropriate driver.

The `Run` methods have been updated to use `driverName` instead of `driver`, ensuring consistency with the updated `Init` method.

Replaced redundant inline documentation with `<inheritdoc>` tags to improve maintainability and consistency. Legacy `Application` methods (`Init`, `Shutdown`, `Run`) have been marked as `[Obsolete]` to signal their eventual deprecation.

Test cases have been refactored to align with the updated `Init` method signature, removing unused `driver` parameters. Documentation files have also been updated to reflect these API changes.

These changes improve clarity, reduce complexity, and ensure a more consistent API design.

* Refactor: Introduce Application.Create() factory method

Introduced a new static method `Application.Create()` to create
instances of `IApplication`, replacing direct instantiation of
`ApplicationImpl`. This enforces a cleaner, recommended pattern
for creating application instances.

Made the `ApplicationImpl` constructor `internal` to ensure
`Application.Create()` is used for instance creation.

Refactored test cases across multiple files to use
`Application.Create()` instead of directly instantiating
`ApplicationImpl`. Simplified object initialization in tests
using target-typed `new()` expressions.

Updated documentation and examples in `application.md` to
reflect the new instance-based architecture and highlight its
benefits, such as supporting multiple applications with
different drivers.

Improved code readability, formatting, and consistency in
tests and documentation. Aligned `ApplicationImplBeginEndTests`
to use `IApplication` directly, adhering to the new architecture.

* Added `Application.StopAll` and fixed coupling issues.

Refactored `ApplicationImpl` to use an instance-based approach, replacing the static singleton pattern and Lazy<T>. Introduced `SetInstance` for configuring the singleton instance and updated tests to use `ApplicationImpl.Instance` or explicitly set the `Driver` property.

Enabled nullable reference types across the codebase, updating fields and variables to nullable types where applicable. Added null checks to improve safety and prevent runtime errors.

Refactored timeout management by introducing tokens for `Application.AddTimeout` and adding a `StopAll` method to `TimedEvents` for cleanup. Updated tests to use `System.Threading.Timer` for independent watchdog timers.

Removed legacy code, improved logging for error cases, and updated view initialization to explicitly set `App` or `Driver` in tests. Enhanced test coverage and restructured `ScrollSliderTests` for better readability.

Performed general code cleanup, including formatting changes, removal of unused imports, and improved naming consistency.

* Refactor: Transition to IApplication interface

Refactored the codebase to replace the static `Application` class with the `IApplication` interface, improving modularity, testability, and maintainability. Updated methods like `Application.Run`, `RequestStop`, and `Init` to use the new interface.

Marked static members `SessionStack` and `Current` as `[Obsolete]` and delegated their functionality to `ApplicationImpl.Instance`. Updated XML documentation to reflect these changes.

Simplified code by removing redundant comments, unused code, and converting methods like `GetMarginThickness` to single-line expressions. Improved null safety with null-conditional operators in `ToplevelTransitionManager`.

Enhanced consistency with formatting updates, logging improvements, and better error handling. Updated `Shortcut` and other classes to align with the new interface-based design.

Made breaking changes, including the removal of the `helpText` parameter in the `Shortcut` constructor. Updated `Wizard`, `Dialog`, and `GraphView` to use `IApplication` methods. Adjusted `ViewportSettings` and `HighlightStates` for better behavior.

* Enhance null-safety and simplify codebase

Improved null-safety by adopting nullable reference types and adding null-forgiving operators (`!`) where appropriate. Replaced direct method calls with null-safe calls using the null-conditional operator (`?.`) to prevent potential `NullReferenceException`.

Removed default parameter values in test methods to enforce explicit parameter passing. Refactored test classes to remove unnecessary dependencies on `ITestOutputHelper`.

Fixed a bug in `WindowsOutput.cs` by setting `_force16Colors` to `false` to avoid reliance on a problematic driver property. Updated `SessionTokenTests` to use null-forgiving operators for clarity in intentional null usage.

Simplified graph and UI updates by ensuring safe access to properties and methods. Cleaned up namespaces and removed unused `using` directives for better readability.

Updated `Dispose` methods to use null-safe calls and replaced nullable driver initialization with non-nullable initialization in `ScrollSliderTests` to ensure proper instantiation.

* Refactor test code to use nullable `App` property

Replaced direct `Application` references with `App` property across test classes to improve encapsulation and robustness. Updated `GuiTestContext` to use a nullable `App` property, replacing `_applicationImpl` for consistency.

Refactored key event handling to use `App.Driver` and revised `InitializeApplication` and `CleanupApplication` methods to ensure safe usage of the nullable `App` property. Updated `Then` callbacks to explicitly pass `App` for clarity.

Replaced `Application.QuitKey` with `context.App?.Keyboard.RaiseKeyDownEvent` to ensure context-specific event handling. Refactored `EnableForDesign` logic in `MenuBarv2Tests` and `PopoverMenuTests` to operate on the correct application instance.

Improved null safety in test assertions and revised `RequestStop` and `Shutdown` calls to use `App?.RequestStop` and `App?.Shutdown`. Updated navigation logic to use `Terminal.Gui.App.Application` for namespace consistency.

Enhanced exception handling in the `Invoke` method and performed general cleanup to align with modern C# practices, improving maintainability and readability.

* Commented out exception handling in Application.Shutdown

The `try-catch` block around `Application.Shutdown` was commented out, disabling the logging of exceptions thrown after a test exited. This change removes the `catch` block that used `Debug.WriteLine` for logging.

The `finally` block remains intact, ensuring cleanup operations such as clearing `View.Instances` and resetting the application state are still executed.

* Fixes #4394 - Changing Theme at Runtime does not Update Some Properties

* Tweaks to config format.

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: Tig <tig@users.noreply.github.com>
Co-authored-by: tig <585482+tig@users.noreply.github.com>
2025-11-19 16:23:35 -05:00

971 lines
24 KiB
Markdown

# Configuration Management Deep Dive
Terminal.Gui provides a comprehensive configuration system that allows users and developers to customize application behavior and appearance through JSON configuration files. The [ConfigurationManager](~/api/Terminal.Gui.Configuration.ConfigurationManager.yml) enables persistent settings, themes, and application-specific preferences.
## Table of Contents
- [Overview](#overview)
- [Getting Started](#getting-started)
- [Configuration Scopes](#configuration-scopes)
- [Configuration Locations and Precedence](#configuration-locations-and-precedence)
- [Themes and Schemes](#themes-and-schemes)
- [Defining Configuration Properties](#defining-configuration-properties)
- [Loading and Applying Configuration](#loading-and-applying-configuration)
- [Events](#events)
- [What Can Be Configured](#what-can-be-configured)
- [Configuration File Format](#configuration-file-format)
- [Best Practices](#best-practices)
---
## Overview
The [ConfigurationManager](~/api/Terminal.Gui.Configuration.ConfigurationManager.yml) provides:
- **Persistent Settings** - User preferences stored in JSON files
- **Theme System** - Named collections of visual settings
- **Scheme Management** - Color and text style definitions
- **Configuration Precedence** - Layered configuration from multiple sources
- **Runtime Configuration** - In-memory configuration without files
- **AOT Compatible** - Works with Native AOT compilation
### Key Features
- JSON-based configuration with schema validation
- Multiple configuration locations (user home, app directory, resources)
- Process-wide settings using static properties
- Built-in themes (Default, Dark, Light, etc.)
- Custom glyphs and Unicode characters
- Event-driven configuration changes
---
## Getting Started
### Enabling Configuration
**ConfigurationManager is disabled by default** and must be explicitly enabled:
```csharp
using Terminal.Gui.Configuration;
class Program
{
static void Main()
{
// Enable configuration with all sources
ConfigurationManager.Enable(ConfigLocations.All);
Application.Init();
// ... rest of app
}
}
```
### Quick Example
```csharp
// Enable configuration
ConfigurationManager.Enable(ConfigLocations.All);
// Listen for configuration changes
ConfigurationManager.Applied += (sender, e) =>
{
Console.WriteLine("Configuration applied!");
};
// Switch themes
ThemeManager.Theme = "Dark";
ConfigurationManager.Apply();
```
---
## Configuration Scopes
Terminal.Gui uses three configuration scopes, each serving a different purpose:
### 1. SettingsScope
System-level settings that affect Terminal.Gui behavior. Only Terminal.Gui library developers can define [SettingsScope](~/api/Terminal.Gui.Configuration.SettingsScope.yml) properties.
```csharp
[ConfigurationProperty(Scope = typeof(SettingsScope))]
public static bool Force16Colors { get; set; } = false;
```
**Examples:**
- `Application.QuitKey` - Default key to quit applications
- `Application.Force16Colors` - Force 16-color mode
- `Key.Separator` - Character separating keys in key combinations
### 2. ThemeScope
Visual appearance settings that can be themed. Only Terminal.Gui library developers can define [ThemeScope](~/api/Terminal.Gui.Configuration.ThemeScope.yml) properties.
```csharp
[ConfigurationProperty(Scope = typeof(ThemeScope))]
public static LineStyle DefaultBorderStyle { get; set; } = LineStyle.Single;
```
**Examples:**
- `Window.DefaultBorderStyle` - Default border style for windows
- `Dialog.DefaultShadow` - Default shadow style for dialogs
- `Schemes` - Color schemes for the theme
### 3. AppSettingsScope (Default)
Application-specific settings. Application developers can define [AppSettingsScope](~/api/Terminal.Gui.Configuration.AppSettingsScope.yml) properties for their apps.
```csharp
[ConfigurationProperty] // AppSettingsScope is default
public static string MyAppSetting { get; set; } = "default value";
```
**Important:**
- App developers **cannot** define `SettingsScope` or `ThemeScope` properties
- AppSettings property names must be globally unique (automatically prefixed with class name)
---
## Configuration Locations and Precedence
Configuration is loaded from multiple locations with increasing precedence (higher numbers override lower):
### ConfigLocations Enum
[ConfigLocations](~/api/Terminal.Gui.Configuration.ConfigLocations.yml) specifies where configuration can be loaded from:
1. **[ConfigLocations.HardCoded](~/api/Terminal.Gui.Configuration.ConfigLocations.yml)** (Lowest Precedence)
- Default values in code (static property initializers)
- Always available, even when ConfigurationManager is disabled
2. **[ConfigLocations.LibraryResources](~/api/Terminal.Gui.Configuration.ConfigLocations.yml)**
- Settings in `Terminal.Gui.dll` resources (`Terminal.Gui.Resources.config.json`)
- Defines default themes and settings for the library
3. **[ConfigLocations.Runtime](~/api/Terminal.Gui.Configuration.ConfigLocations.yml)**
- Settings in [ConfigurationManager.RuntimeConfig](~/api/Terminal.Gui.Configuration.ConfigurationManager.yml#Terminal_Gui_Configuration_ConfigurationManager_RuntimeConfig) string property
- In-memory configuration without files
4. **[ConfigLocations.AppResources](~/api/Terminal.Gui.Configuration.ConfigLocations.yml)**
- App-specific resources (`MyApp.Resources.config.json` or `Resources/config.json`)
- Embedded in the application assembly
5. **[ConfigLocations.AppHome](~/api/Terminal.Gui.Configuration.ConfigLocations.yml)**
- App-specific file in user's home directory (`~/.tui/MyApp.config.json`)
6. **[ConfigLocations.AppCurrent](~/api/Terminal.Gui.Configuration.ConfigLocations.yml)**
- App-specific file in current directory (`./.tui/MyApp.config.json`)
7. **[ConfigLocations.GlobalHome](~/api/Terminal.Gui.Configuration.ConfigLocations.yml)**
- Global file in user's home directory (`~/.tui/config.json`)
8. **[ConfigLocations.GlobalCurrent](~/api/Terminal.Gui.Configuration.ConfigLocations.yml)** (Highest Precedence)
- Global file in current directory (`./.tui/config.json`)
### Precedence Diagram
```mermaid
graph TD
A[1. Hard-coded Defaults] --> B[2. Library Resources]
B --> C[3. Runtime Config]
C --> D[4. App Resources]
D --> E[5. App Home Directory]
E --> F[6. App Current Directory]
F --> G[7. Global Home Directory]
G --> H[8. Global Current Directory]
style A fill:#f9f9f9
style H fill:#90EE90
```
### File Locations
**Global Settings** (`config.json`):
- Windows: `C:\Users\username\.tui\config.json`
- macOS/Linux: `~/.tui/config.json` or `./.tui/config.json`
**App-Specific Settings** (`AppName.config.json`):
- Windows: `C:\Users\username\.tui\UICatalog.config.json`
- macOS/Linux: `~/.tui/UICatalog.config.json` or `./.tui/UICatalog.config.json`
---
## Themes and Schemes
### Theme System
A **Theme** is a named collection of visual settings bundled together. Terminal.Gui includes several built-in themes.
#### Built-in Themes
- **Default** - The default Terminal.Gui theme (matches hard-coded defaults)
- **Dark** - Dark color scheme with heavy borders
- **Light** - Light color scheme
- **TurboPascal 5** - Classic Turbo Pascal IDE colors
- **And more** - See `Terminal.Gui/Resources/config.json` for all built-in themes
#### Using Themes
```csharp
// Get current theme
ThemeScope currentTheme = ThemeManager.GetCurrentTheme();
// Get all available themes
Dictionary<string, ThemeScope> themes = ThemeManager.GetThemes();
// Get theme names
ImmutableList<string> themeNames = ThemeManager.GetThemeNames();
// Switch themes
ThemeManager.Theme = "Dark";
ConfigurationManager.Apply();
// Listen for theme changes
ThemeManager.ThemeChanged += (sender, e) =>
{
// Update UI based on new theme
};
```
### Scheme System
A **Scheme** defines the colors and text styles for a specific UI context (e.g., Dialog, Menu, TopLevel).
See the [Scheme Deep Dive](scheme.md) for complete details on the scheme system.
#### Built-in Schemes
[Schemes](~/api/Terminal.Gui.Drawing.Schemes.yml) enum defines the standard schemes:
- **TopLevel** - Top-level application windows
- **Base** - Default for most views
- **Dialog** - Dialogs and message boxes
- **Menu** - Menus and status bars
- **Error** - Error messages and dialogs
#### Working with Schemes
```csharp
// Get all schemes for current theme
Dictionary<string, Scheme> schemes = SchemeManager.GetCurrentSchemes();
// Get specific scheme
Scheme dialogScheme = SchemeManager.GetScheme(Schemes.Dialog);
// Get scheme names
ImmutableList<string> schemeNames = SchemeManager.GetSchemeNames();
// Add custom scheme
SchemeManager.AddScheme("MyScheme", new Scheme
{
Normal = new Attribute(Color.White, Color.Blue),
Focus = new Attribute(Color.Black, Color.Cyan)
});
// Listen for scheme changes
SchemeManager.CollectionChanged += (sender, e) =>
{
// Handle scheme changes
};
```
#### Scheme Structure
Each [Scheme](~/api/Terminal.Gui.Drawing.Scheme.yml) maps [VisualRole](~/api/Terminal.Gui.Drawing.VisualRole.yml) to [Attribute](~/api/Terminal.Gui.Drawing.Attribute.yml):
```json
{
"TopLevel": {
"Normal": {
"Foreground": "BrightGreen",
"Background": "Black",
"Style": "None"
},
"Focus": {
"Foreground": "White",
"Background": "Cyan",
"Style": "Bold"
},
"HotNormal": {
"Foreground": "Yellow",
"Background": "Black"
},
"HotFocus": {
"Foreground": "Blue",
"Background": "Cyan",
"Style": "Underline"
},
"Disabled": {
"Foreground": "DarkGray",
"Background": "Black",
"Style": "Faint"
}
}
}
```
---
## Defining Configuration Properties
### Basic Property Definition
Application developers define settings using the [ConfigurationPropertyAttribute](~/api/Terminal.Gui.Configuration.ConfigurationPropertyAttribute.yml):
```csharp
public class MyApp
{
[ConfigurationProperty]
public static string MySetting { get; set; } = "Default Value";
[ConfigurationProperty]
public static int MaxItems { get; set; } = 100;
}
```
**Requirements:**
- Must be `public` or `internal`
- Must be `static`
- Must be a property (not a field)
- Must have a default value
### Property Naming
AppSettings properties are automatically prefixed with the class name to ensure global uniqueness:
```csharp
// Code
public class MyApp
{
[ConfigurationProperty]
public static string MySetting { get; set; } = "value";
}
// JSON
{
"AppSettings": {
"MyApp.MySetting": "value"
}
}
```
### Scope Specification
Use the `Scope` parameter to specify non-default scopes (Terminal.Gui library only):
```csharp
// SettingsScope - Library-wide settings
[ConfigurationProperty(Scope = typeof(SettingsScope))]
public static bool Force16Colors { get; set; } = false;
// ThemeScope - Visual settings
[ConfigurationProperty(Scope = typeof(ThemeScope))]
public static LineStyle DefaultBorderStyle { get; set; } = LineStyle.Single;
// AppSettingsScope - Application settings (default)
[ConfigurationProperty] // or explicitly: Scope = typeof(AppSettingsScope)
public static string MyAppSetting { get; set; } = "default";
```
### Omit Class Name (Advanced)
For library developers only, use `OmitClassName = true` for cleaner JSON:
```csharp
[ConfigurationProperty(Scope = typeof(ThemeScope), OmitClassName = true)]
public static Dictionary<string, Scheme> Schemes { get; set; } = new();
```
---
## Loading and Applying Configuration
### Enable with Load and Apply
The simplest approach - enable and load in one call:
```csharp
ConfigurationManager.Enable(ConfigLocations.All);
```
This:
1. Enables ConfigurationManager
2. Loads configuration from all locations
3. Applies settings to the application
### Granular Control
For more control, use [Load](~/api/Terminal.Gui.Configuration.ConfigurationManager.yml#Terminal_Gui_Configuration_ConfigurationManager_Load_Terminal_Gui_Configuration_ConfigLocations_) and [Apply](~/api/Terminal.Gui.Configuration.ConfigurationManager.yml#Terminal_Gui_Configuration_ConfigurationManager_Apply) separately:
```csharp
// Enable without loading
ConfigurationManager.Enable(ConfigLocations.None);
// Load from specific locations
ConfigurationManager.Load(ConfigLocations.GlobalHome | ConfigLocations.AppResources);
// Apply settings
ConfigurationManager.Apply();
```
### Runtime Configuration
Set configuration directly in code without files:
```csharp
ConfigurationManager.RuntimeConfig = @"
{
""Application.QuitKey"": ""Ctrl+Q"",
""Application.Force16Colors"": true
}";
ConfigurationManager.Enable(ConfigLocations.Runtime);
```
### Reset to Defaults
Reset all settings to hard-coded defaults:
```csharp
ConfigurationManager.ResetToHardCodedDefaults();
```
---
## Events
The ConfigurationManager provides events to track configuration changes:
### Applied Event
Raised after configuration is applied to the application:
```csharp
ConfigurationManager.Applied += (sender, e) =>
{
// Configuration has been applied
// Update UI or refresh views
};
```
### ThemeChanged Event
Raised when the active theme changes:
```csharp
ThemeManager.ThemeChanged += (sender, e) =>
{
// Theme has changed
// Refresh all views to use new theme
Application.Current?.SetNeedsDraw();
};
```
### CollectionChanged Event
Raised when schemes collection changes:
```csharp
SchemeManager.CollectionChanged += (sender, e) =>
{
// Schemes have changed
};
```
---
## What Can Be Configured
### Application Settings
System-wide settings from [SettingsScope](~/api/Terminal.Gui.Configuration.SettingsScope.yml):
```json
{
"Application.QuitKey": "Esc",
"Application.Force16Colors": false,
"Application.IsMouseDisabled": false,
"Application.ArrangeKey": "Ctrl+F5",
"Application.NextTabKey": "Tab",
"Application.PrevTabKey": "Shift+Tab",
"Application.NextTabGroupKey": "F6",
"Application.PrevTabGroupKey": "Shift+F6",
"Key.Separator": "+"
}
```
### View-Specific Settings
Settings for individual View types from [ThemeScope](~/api/Terminal.Gui.Configuration.ThemeScope.yml):
```json
{
"Window.DefaultBorderStyle": "Single",
"Window.DefaultShadow": "None",
"Dialog.DefaultBorderStyle": "Heavy",
"Dialog.DefaultShadow": "Transparent",
"Dialog.DefaultButtonAlignment": "End",
"FrameView.DefaultBorderStyle": "Rounded",
"Button.DefaultShadow": "None",
"PopoverMenu.DefaultKey": "Shift+F10",
"FileDialog.MaxSearchResults": 10000
}
```
### Glyphs
Customize the Unicode characters used for drawing:
```json
{
"Glyphs.RightArrow": "►",
"Glyphs.LeftArrow": "U+25C4",
"Glyphs.DownArrow": "\\u25BC",
"Glyphs.UpArrow": 965010,
"Glyphs.LeftBracket": "[",
"Glyphs.RightBracket": "]",
"Glyphs.Checked": "☑",
"Glyphs.UnChecked": "☐",
"Glyphs.Selected": "◉",
"Glyphs.UnSelected": "○"
}
```
Glyphs can be specified as:
- Unicode character: `"►"`
- U+ format: `"U+25C4"`
- UTF-16 format: `"\\u25BC"`
- Decimal codepoint: `965010`
### Discovering Configuration Properties
To find all available configuration properties:
```csharp
// Get hard-coded configuration
SettingsScope hardCoded = ConfigurationManager.GetHardCodedConfig();
// Iterate through all properties
foreach (var property in hardCoded)
{
Console.WriteLine($"{property.Key} = {property.Value}");
}
```
Or search the source code for `[ConfigurationProperty]` attributes.
---
## Themes and Schemes
### Theme Structure
A theme is a named collection bundling visual settings and schemes:
```json
{
"Themes": [
{
"Dark": {
"Dialog.DefaultBorderStyle": "Heavy",
"Dialog.DefaultShadow": "Transparent",
"Window.DefaultBorderStyle": "Single",
"Button.DefaultShadow": "Opaque",
"Schemes": [
{
"TopLevel": {
"Normal": { "Foreground": "BrightGreen", "Background": "Black" },
"Focus": { "Foreground": "White", "Background": "Cyan" }
},
"Dialog": {
"Normal": { "Foreground": "Black", "Background": "Gray" }
}
}
]
}
}
]
}
```
### Creating Custom Themes
Custom themes can be defined in configuration files:
```json
{
"Themes": [
{
"MyCustomTheme": {
"Window.DefaultBorderStyle": "Double",
"Dialog.DefaultShadow": "Opaque",
"Schemes": [
{
"Base": {
"Normal": {
"Foreground": "Cyan",
"Background": "Black",
"Style": "Bold"
}
}
}
]
}
}
]
}
```
Then activate the theme:
```csharp
ThemeManager.Theme = "MyCustomTheme";
ConfigurationManager.Apply();
```
### Theme Inheritance
Themes only override specified properties. To build on an existing theme:
```csharp
// Start with default theme
ThemeManager.Theme = "Default";
ConfigurationManager.Apply();
// Apply custom theme (overrides only what's specified)
ThemeManager.Theme = "MyCustomTheme";
ConfigurationManager.Apply();
```
### TextStyle in Schemes
Each [Attribute](~/api/Terminal.Gui.Drawing.Attribute.yml) in a scheme now includes [TextStyle](~/api/Terminal.Gui.Drawing.TextStyle.yml):
```json
{
"Normal": {
"Foreground": "White",
"Background": "Blue",
"Style": "Bold, Underline"
}
}
```
Available styles (combinable):
- `None`
- `Bold`
- `Faint`
- `Italic`
- `Underline`
- `Blink`
- `Reverse`
- `Strikethrough`
---
## Configuration File Format
### Schema
All configuration files must conform to the JSON schema:
**Schema URL:** https://gui-cs.github.io/Terminal.Gui/schemas/tui-config-schema.json
### Root Structure
```json
{
"$schema": "https://gui-cs.github.io/Terminal.Gui/schemas/tui-config-schema.json",
// SettingsScope properties
"Application.QuitKey": "Esc",
"Application.Force16Colors": false,
// Current theme name
"Theme": "Dark",
// Theme definitions
"Themes": [
{
"Dark": {
// ThemeScope properties
"Window.DefaultBorderStyle": "Single",
// Schemes
"Schemes": [ ... ]
}
}
],
// AppSettings
"AppSettings": {
"MyApp.MySetting": "value"
}
}
```
### Complete Example
See the default configuration file:
[!code-json[config.json](../../Terminal.Gui/Resources/config.json)]
---
## Best Practices
### For Application Developers
**1. Enable Early**
Enable ConfigurationManager at the start of `Main()`, before `Application.Init()`:
```csharp
static void Main()
{
ConfigurationManager.Enable(ConfigLocations.All);
Application.Init();
// ...
}
```
**2. Use AppSettings for App Configuration**
```csharp
public class MyApp
{
[ConfigurationProperty]
public static bool ShowWelcomeMessage { get; set; } = true;
[ConfigurationProperty]
public static string DefaultDirectory { get; set; } = "";
}
```
**3. Ship Default Configuration as Resource**
Include a `Resources/config.json` file in your app:
```xml
<ItemGroup>
<EmbeddedResource Include="Resources\config.json" />
</ItemGroup>
```
**4. Handle Configuration Changes**
```csharp
ConfigurationManager.Applied += (sender, e) =>
{
// Refresh UI when configuration changes
RefreshAllViews();
};
```
### For Library Developers
**1. Use Appropriate Scopes**
- `SettingsScope` - For system-wide behavior
- `ThemeScope` - For visual appearance that should be themeable
- Don't use `AppSettingsScope` in library code
**2. Provide Meaningful Defaults**
```csharp
[ConfigurationProperty(Scope = typeof(ThemeScope))]
public static LineStyle DefaultBorderStyle { get; set; } = LineStyle.Single;
```
**3. Document Configuration Properties**
```csharp
/// <summary>
/// Gets or sets the default border style for all Windows.
/// </summary>
[ConfigurationProperty(Scope = typeof(ThemeScope))]
public static LineStyle DefaultBorderStyle { get; set; } = LineStyle.Single;
```
### Process-Wide Settings
> [!IMPORTANT]
> Configuration settings are applied at the **process level**.
>
> Since configuration properties are static, changes affect all applications in the same process. This is typically not an issue for normal applications, but can affect scenarios with:
> - Multiple Terminal.Gui apps in the same process
> - Unit tests running in parallel
> - Hot reload scenarios
---
## Advanced Topics
### JSON Error Handling
Control how JSON parsing errors are handled:
```json
{
"ConfigurationManager.ThrowOnJsonErrors": true
}
```
- `false` (default) - Silent failures, errors logged
- `true` - Throws exceptions on JSON parsing errors
### Manually Trigger Updates
Update ConfigurationManager to reflect current static property values:
```csharp
// Change a setting programmatically
Application.QuitKey = Key.Q.WithCtrl;
// Update ConfigurationManager to reflect the change
ConfigurationManager.UpdateToCurrentValues();
// Save to file (if needed)
string json = ConfigurationManager.Serialize();
File.WriteAllText("my-config.json", json);
```
### Disable ConfigurationManager
Disable and optionally reset to defaults:
```csharp
// Disable but keep current settings
ConfigurationManager.Disable(resetToHardCodedDefaults: false);
// Disable and reset to hard-coded defaults
ConfigurationManager.Disable(resetToHardCodedDefaults: true);
```
### File System Watching
Watch for configuration file changes:
```csharp
var watcher = new FileSystemWatcher(
Path.Combine(Environment.GetFolderPath(Environment.SpecialFolder.UserProfile), ".tui"));
watcher.Filter = "*.json";
watcher.Changed += (s, e) =>
{
ConfigurationManager.Load(ConfigLocations.GlobalHome);
ConfigurationManager.Apply();
};
watcher.EnableRaisingEvents = true;
```
See UICatalog's `ConfigurationEditor` scenario for a complete example.
---
## Examples
### Example 1: Simple Theme Switching
```csharp
using Terminal.Gui;
using Terminal.Gui.Configuration;
ConfigurationManager.Enable(ConfigLocations.All);
Application.Init();
var themeSelector = new ComboBox
{
X = 1,
Y = 1,
Width = 20
};
themeSelector.SetSource(ThemeManager.GetThemeNames());
themeSelector.SelectedItemChanged += (s, e) =>
{
ThemeManager.Theme = e.Value.ToString();
ConfigurationManager.Apply();
};
Application.Run(new Window { Title = "Theme Demo" }).Add(themeSelector);
Application.Shutdown();
```
### Example 2: Custom Application Settings
```csharp
public class MyApp
{
[ConfigurationProperty]
public static string LastOpenedFile { get; set; } = "";
[ConfigurationProperty]
public static int WindowWidth { get; set; } = 80;
[ConfigurationProperty]
public static int WindowHeight { get; set; } = 25;
}
// Enable and use
ConfigurationManager.Enable(ConfigLocations.All);
// Settings are automatically loaded and applied
var window = new Window
{
Width = MyApp.WindowWidth,
Height = MyApp.WindowHeight
};
// Later, save updated settings
MyApp.WindowWidth = 100;
ConfigurationManager.UpdateToCurrentValues();
// Could save to file here
```
### Example 3: Runtime Configuration
```csharp
ConfigurationManager.RuntimeConfig = @"
{
""Application.QuitKey"": ""Ctrl+Q"",
""Application.Force16Colors"": true,
""Theme"": ""Dark""
}";
ConfigurationManager.Enable(ConfigLocations.Runtime);
// Settings are now applied
// QuitKey is Ctrl+Q
// 16-color mode is forced
// Dark theme is active
```
---
## See Also
- **[Scheme Deep Dive](scheme.md)** - Color scheme details
- **[Drawing Deep Dive](drawing.md)** - Color and attribute system
- **[View Deep Dive](View.md)** - View configuration properties
- **[Theme Schema](https://gui-cs.github.io/Terminal.Gui/schemas/tui-config-schema.json)** - JSON schema for validation
- **[Default Config](../../Terminal.Gui/Resources/config.json)** - Complete default configuration
### UICatalog Examples
The UICatalog application demonstrates configuration management:
- **Configuration Editor** - Interactive editor for configuration files
- **Themes** - Theme viewer and selector
- **File System Watcher** - Automatic reload on configuration file changes
### API Reference
- [ConfigurationManager](~/api/Terminal.Gui.Configuration.ConfigurationManager.yml)
- [ConfigLocations](~/api/Terminal.Gui.Configuration.ConfigLocations.yml)
- [SettingsScope](~/api/Terminal.Gui.Configuration.SettingsScope.yml)
- [ThemeScope](~/api/Terminal.Gui.Configuration.ThemeScope.yml)
- [AppSettingsScope](~/api/Terminal.Gui.Configuration.AppSettingsScope.yml)
- [ThemeManager](~/api/Terminal.Gui.Configuration.ThemeManager.yml)
- [SchemeManager](~/api/Terminal.Gui.Configuration.SchemeManager.yml)
- [ConfigurationPropertyAttribute](~/api/Terminal.Gui.Configuration.ConfigurationPropertyAttribute.yml)