Files
Terminal.Gui/Examples/UICatalog/UICatalogRunnable.cs
Tig d303943809 Fixes #4004 & #4445 - Merge of Application.ForceDriver and Driver.Force16Colors and windows" broken in conhost and cmd (#4448)
* Fixes #4004. Driver "windows" broken in conhost and cmd

* Fix unit tests

* Remove IsVirtualTerminal from IApplication. Add IDriverInternal and IOutputInternal interfaces

* Fix result.IsSupported

* Remove internal interfaces and add them in the implementations classes

* Move Sixel from IApplication to IDriver interface it's a characteristic of the driver

* Only if IOutput is OutputBase then set the internal properties

* Prevents driver windows error on Unix system

* Fix scenario sixel error

* Comment some tests because is keyboard layout dependent and shifted key is needed to produce them (Pt)

* Add 🇵🇹 regional indicators test proving they ca be joined as only one grapheme

* SetConsoleActiveScreenBuffer is already called by the constructor and is only needed once

* Finally fixed non virtual terminal in windows driver

* Add more Sixel unit tests

* Add unit tests for OutputBase class

* Avoid emit escape sequence

* Fix assertion failure in UICatalog

* Let each driver to deal with the Sixel write

* When Shutdown is called by the static Application then the ApplicationImpl.ResetStateStatic should be also called

* Add more OutputBase with Sixel unit tests

* Fix some issues with IsVirtualTerminal and Force16Colors with unit tests improvement

* Add Sixel Detect method unit test

* Make Sixel IsSupported and SupportsTransparency consistent with more unit tests

* Fix namespaces and unit test

* Covering more ApplicationImpl Sixel unit test

* Remove DriverImplProxy because sometimes fails in parallel unit tests

* Fix Init_KeyBindings_Are_Not_Reset unit test failing

* Revert "Fix Init_KeyBindings_Are_Not_Reset unit test failing"

This reverts commit 0ab298bc56.

* Fix Force16Colors but still use Application.Force16Colors because of CM

* Enforce conditional

* Revert change

* Moving to a new file

* Add the same workaround as the All_Scenarios_Benchmark unit test

* Fixes #4440. TextView with ReadOnly as true, MoveRight doesn't select text up to the end of the line

* Fixes #4442. TextField PositionCursor doesn't treat zero width as one column

* Each character must return at least one column, with the exception of Tab.

* Add unit test for the ScrollOffset

* Each character must return at least one column, with the exception of Tab.

* Add unit test for the LeftColumn

* WIP

* Refactor DriverImpl and OutputBase for maintainability

Refactored `DriverImpl` to remove `IDisposable` and streamline event
handling, including replacing `OnSizeMonitorOnSizeChanged` with an
inline lambda. Reintroduced `SizeChanged` and updated `SetScreenSize`
to invoke it. Moved `SupportsTrueColor` from `OutputBase` to
`DriverImpl` and reintroduced `Force16Colors` with updated logic.

Reintroduced and updated several `OutputBuffer`-related properties
and methods in `DriverImpl`, including `Screen`, `Clip`, `Cols`, and
`Contents`. Moved `Clipboard` from `OutputBase` to `DriverImpl` and
initialized it with `FakeClipboard`. Simplified `Refresh` and `ToAnsi`
methods in `DriverImpl`.

Removed `Force16Colors` from `OutputBase` and simplified method
signatures, including `ToAnsi` and `BuildAnsiForRegion`. Fixed a
parameter name typo in `AppendOrWriteAttribute`. Made minor code
formatting adjustments.

These changes improve code maintainability, reduce redundancy, and
align the implementation with updated design requirements.

* Refactor Force16Colors handling and improve UICatalog

Refactored the `Force16Colors` property:
- Moved it from `DriverImpl` to `IOutput` and `OutputBase`.
- Simplified its management by removing redundant logic.
- Added `OnDriverOnForce16ColorsChanged` to handle updates.

Updated `UICatalogRunnable`:
- Replaced `Driver.Force16Colors` with `Application.Driver.Force16Colors`.
- Added an `F7` shortcut to toggle `Force16Colors`.
- Removed redundant event handlers and improved formatting.

Updated `config.json`:
- Replaced `Application.Force16Colors` with `Driver.Force16Colors`.
- Improved theme configuration formatting for readability.

Other changes:
- Removed the `force16Colors` parameter from `IOutput.ToAnsi`.
- Improved diagnostics handling in `UICatalogRunnable`.
- General code cleanup for readability and maintainability.

* Refactor `Force16Colors` access and improve null safety

Refactored `Force16Colors` property access to use `Application.Driver!`
for null safety and consistency. Updated event handlers to align with
this pattern. Replaced nullable `DrawContext?` parameters with
non-nullable `DrawContext` in `OnDrawingContent` overrides across
multiple classes to enforce stricter nullability checks.

Removed unused `_cachedCursorVisibility` field in `OutputBase.cs` and
cleaned up commented-out legacy code in `UICatalogRunnable.cs`. Updated
XML documentation to reflect method signature changes and property
references. Refactored `Shortcut` example in documentation for
consistency.

Replaced `Application.LayoutAndDraw` with `SetNeedsDraw` for marking
views as needing redraw. Performed general code cleanup to remove
redundant code and improve consistency.

* Refactor ForceDriver and Force16Colors properties

Removed `[Obsolete]` from `Application.ForceDriver`, making it a stable API. Added comments to clarify its role as a configuration property and its synchronization with `IApplication.ForceDriver`. Introduced `_forceDriver` as a private backing field.

Removed `Force16Colors` from `ApplicationImpl` and eliminated reset logic for `ForceDriver` and `Force16Colors` during shutdown, shifting state management responsibility to the library user.

Updated comments in `Driver.cs` to document `Force16Colors` as a configuration property and its synchronization with `IDriver.Force16Colors`. Retained `_force16Colors` as a private backing field for configuration overrides.

* Updated docs

* There is no way to detect Sixel transparency and so relying in VTS or Xterm with transparency

* Fix detect Sixel unit tests with the adjusting code

* Refactored Output.

* MErging

* - Added `OnDriverOnForce16ColorsChanged` method to handle `Driver.Force16ColorsChanged` events and update the `Force16Colors` property.

- Implemented `IDisposable` to ensure proper cleanup of resources, including unsubscribing from `SizeMonitor.SizeChanged` and `Driver.Force16ColorsChanged` events, and disposing of `_output`.
- Replaced inline `SizeMonitor.SizeChanged` event handler with a dedicated method, `OnSizeMonitorOnSizeChanged`, for better readability and maintainability.

- Simplified the `Screen` property by removing commented-out code and directly returning a `Rectangle` based on `OutputBuffer` dimensions.
- Updated the `Force16Colors` property to use `_output` for both getting and setting its value.
- Performed general cleanup, including removing unused code and improving code structure.

* merged

* Refactor Sixel handling with ConcurrentQueue

Replaced `List<SixelToRender>` with `ConcurrentQueue<SixelToRender>`
to improve thread safety and performance in sixel management.
Updated the `Images` class to avoid unnecessary removal and
re-creation of sixel objects by updating existing ones in place.

Refactored `Application.Sixel` to return a `ConcurrentQueue` and
introduced `GetSixels` in `IDriver` and `IOutput` for consistent
access. Updated `OutputBase` to use a private `ConcurrentQueue`
and adjusted rendering logic accordingly.

Removed legacy and redundant code, including `Application.Driver?.Sixel.Clear()`
and unused properties in `DriverImpl` and `ApplicationImpl`. Updated
tests in `OutputBaseTests` to align with the new implementation.

Added `using System.Collections.Concurrent` where necessary and
improved documentation to reflect the changes. These updates
enhance thread safety, simplify the codebase, and align with
modern concurrent programming practices.

* Tweak

* Refactor DriverImpl to use Dispose and improve modularity

Replaced `Driver.End()` with `Driver.Dispose()` across the codebase, aligning with the `IDisposable` pattern for proper resource cleanup. Updated `DriverImpl` to implement `Dispose`, ensuring event unsubscriptions and resource disposal.

Enhanced `DriverImpl` structure by organizing code into logical regions, improving modularity and readability. Refactored and reintroduced methods and properties like `Clipboard`, `Screen`, `SetScreenSize`, `Cols`, `Rows`, and others for better encapsulation.

Updated the `IDriver` interface to include `IDisposable` and reorganized it into regions. Added new methods and properties such as `Init`, `Refresh`, `Suspend`, `QueueAnsiRequest`, and `ToAnsi`.

Refactored unit tests to replace `driver.End()` with `driver.Dispose()` and ensured proper resource cleanup. Improved code comments and documentation for better clarity.

Aligned with modern C# practices, adopting features like null-coalescing operators and pattern matching. Removed redundant code, addressed some TODOs, and modularized the codebase for maintainability and extensibility.

* Refactor driver docs and update View.Driver usage

Updated `application.md` to clarify the purpose of the `View.Driver` property, replacing the obsolete `Application.Driver`. Added a reference to the "Drivers Deep Dive" documentation for further details.

Refactored the `OnDrawContent` method to use the `Driver` property, ensuring compatibility with the new driver architecture.

Added a new section, "Testing with the New Architecture," to `application.md`, highlighting the improved testability of the instance-based architecture.

Expanded and reorganized `drivers.md` to provide a detailed breakdown of the `IDriver` interface, including lifecycle, components, screen and display, color support, content buffer, drawing, cursor, input events, and ANSI escape sequences. Introduced new subsections for clarity and emphasized the modular design for maintainability.

Added a note in `drivers.md` discouraging direct access to the `Driver` and recommending higher-level abstractions like `Terminal.Gui.App.Application.Screen` and `Terminal.Gui.ViewBase.View` methods for positioning and drawing.

* Refactor IsVirtualTerminal to IsLegacyConsole

Replaced the `IsVirtualTerminal` property with `IsLegacyConsole` across the codebase to better represent legacy versus modern terminal environments. Updated logic in `SixelSupportDetector`, `DriverImpl`, and `OutputBase` to use the new property.

Refactored tests to align with the updated property, including renaming test methods, adjusting mock setups, and replacing `VirtualTerminalTests` with `LegacyConsoleTests`.

Simplified `WindowsOutput` implementation to handle console modes and sixel rendering based on `IsLegacyConsole`. Removed redundant code related to `IsVirtualTerminal`.

Improved code readability and maintainability by using more descriptive property names and ensuring consistency across the codebase. Updated `.DotSettings` with new entries.

* Update Examples/UICatalog/Scenarios/LineDrawing.cs

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Update Examples/UICatalog/Scenarios/Images.cs

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Update Examples/UICatalog/Scenarios/Images.cs

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Update Terminal.Gui/App/IApplication.cs

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Update Terminal.Gui/App/ApplicationImpl.Lifecycle.cs

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Update Examples/UICatalog/Scenarios/ColorPicker.cs

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Update Examples/UICatalog/Scenarios/ColorPicker.cs

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Fix formatting and typo in code and documentation

Improved code readability in `LineDrawing.cs` by fixing spacing
around the ternary operator in `Width` and `Y` property assignments.
Corrected a typo in `drivers.md` by changing "Configuraiton Manager"
to "Configuration Manager" for accurate documentation.

* Test failure casued by assert left in by accident.

* Added a workaround in `OutputBase.cs` to address dirty cell handling in legacy console mode by marking all buffer cells as dirty.

Refactored `_disableMouseCb` event handling in `UICatalogRunnable.cs` to use the `Selecting` event for toggling `Application.IsMouseDisabled`. Simplified `MouseImpl.cs` by converting `App` to an auto-implemented property and removing redundant namespace usage.

Streamlined logging in `WindowsOutput.cs` by replacing verbose `Logging.Logger` calls with shorter alternatives (`Logging.Information`, `Logging.Error`, etc.).

* Update theme and remove unused ListView component

The application's default theme configuration was updated from "Light" to "Amber Phosphor" by modifying the `ConfigurationManager.RuntimeConfig` value.

Additionally, the `ListView` component in the `ExampleWindow` class was removed. This included its initialization, layout properties (`Y`, `Height`, `Width`), and its data source (["One", "Two", "Three", "Four"]).

* Increase safety timeout in NestedRunTimeoutTests to 10s

The timeout duration for the safety mechanism in the
`NestedRunTimeoutTests` class was increased from 5000ms (5s)
to 10000ms (10s). This change allows the app more time to
complete before triggering the safety timeout, reducing the
likelihood of premature termination during long-running tests.

Refactor and enhance test coverage

Refactored `Load_WithInvalidJson_AddsJsonError` test in `SourcesManagerTests.cs` to improve organization and added a note about its impact on parallel execution. Increased the safety timeout in `NestedRunTimeoutTests.cs` from 5 seconds to 10 seconds to address potential premature test timeouts.

* Handle null Driver gracefully in event subscription

Replaced `ArgumentNullException.ThrowIfNull(Driver)` with a null-check conditional in `SubscribeDriverEvents` and `UnsubscribeDriverEvents`. If `Driver` is `null`, the methods now log an error using `Logging.Error` and return early. This prevents potential exceptions and improves error handling.

---------

Co-authored-by: BDisp <bd.bdisp@gmail.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
2025-12-05 17:40:48 -07:00

783 lines
31 KiB
C#

using System.Collections.ObjectModel;
using System.Diagnostics;
using System.Runtime.InteropServices;
using System.Text;
using System.Text.Json.Serialization;
using Microsoft.Extensions.Logging;
using RuntimeEnvironment = Microsoft.DotNet.PlatformAbstractions.RuntimeEnvironment;
#nullable enable
namespace UICatalog;
/// <summary>
/// This is the main UI Catalog app view. It is run fresh when the app loads (if a Scenario has not been passed on
/// the command line) and each time a Scenario ends.
/// </summary>
public class UICatalogRunnable : Runnable
{
// When a scenario is run, the main app is killed. The static
// members are cached so that when the scenario exits the
// main app UI can be restored to previous state
// Note, we used to pass this to scenarios that run, but it just added complexity
// So that was removed. But we still have this here to demonstrate how changing
// the scheme works.
public static string? CachedRunnableScheme { get; set; }
// Diagnostics
private static ViewDiagnosticFlags _diagnosticFlags;
public UICatalogRunnable ()
{
_diagnosticFlags = Diagnostics;
_menuBar = CreateMenuBar ();
_statusBar = CreateStatusBar ();
_categoryList = CreateCategoryList ();
_scenarioList = CreateScenarioList ();
Add (_menuBar, _categoryList, _scenarioList, _statusBar);
IsModalChanged += IsModalChangedHandler;
IsRunningChanged += IsRunningChangedHandler;
// Restore previous selections
if (_categoryList.Source?.Count > 0)
{
_categoryList.SelectedItem = _cachedCategoryIndex ?? 0;
}
else
{
_categoryList.SelectedItem = null;
}
_scenarioList.SelectedRow = _cachedScenarioIndex;
SchemeName = CachedRunnableScheme = SchemeManager.SchemesToSchemeName (Schemes.Base);
ConfigurationManager.Applied += ConfigAppliedHandler;
}
private static bool _isFirstRunning = true;
private void IsModalChangedHandler (object? sender, EventArgs<bool> args)
{
if (!args.Value)
{
return;
}
if (_disableMouseCb is { })
{
_disableMouseCb.CheckedState = Application.IsMouseDisabled ? CheckState.Checked : CheckState.UnChecked;
}
if (_shVersion is { })
{
_shVersion.Title = $"{RuntimeEnvironment.OperatingSystem} {RuntimeEnvironment.OperatingSystemVersion}, {Application.Driver!.GetVersionInfo ()}";
}
if (CachedSelectedScenario != null)
{
CachedSelectedScenario = null;
_isFirstRunning = false;
}
if (!_isFirstRunning)
{
_scenarioList.SetFocus ();
}
if (_statusBar is { })
{
_statusBar.VisibleChanged += (s, e) => { ShowStatusBar = _statusBar.Visible; };
}
IsModalChanged -= IsModalChangedHandler;
_categoryList!.EnsureSelectedItemVisible ();
_scenarioList.EnsureSelectedCellIsVisible ();
}
private void IsRunningChangedHandler (object? sender, EventArgs<bool> args)
{
if (!args.Value)
{
ConfigurationManager.Applied -= ConfigAppliedHandler;
IsRunningChanged -= IsRunningChangedHandler;
}
}
#region MenuBar
private readonly MenuBar? _menuBar;
private CheckBox? _force16ColorsMenuItemCb;
private OptionSelector? _themesSelector;
private OptionSelector? _topSchemesSelector;
private OptionSelector? _logLevelSelector;
private FlagSelector<ViewDiagnosticFlags>? _diagnosticFlagsSelector;
private CheckBox? _disableMouseCb;
private MenuBar CreateMenuBar ()
{
MenuBar menuBar = new (
[
new (
"_File",
[
new MenuItem ()
{
Title ="_Quit",
HelpText = "Quit UI Catalog",
Key = Application.QuitKey,
// By not specifying TargetView the Key Binding will be Application-level
Command = Command.Quit
}
]),
new ("_Themes", CreateThemeMenuItems ()),
new ("Diag_nostics", CreateDiagnosticMenuItems ()),
new ("_Logging", CreateLoggingMenuItems ()),
new (
"_Help",
[
new MenuItem (
"_Documentation",
"API docs",
() => OpenUrl ("https://gui-cs.github.io/Terminal.Gui"),
Key.F1
),
new MenuItem (
"_README",
"Project readme",
() => OpenUrl ("https://github.com/gui-cs/Terminal.Gui"),
Key.F2
),
new MenuItem (
"_About...",
"About UI Catalog",
() => MessageBox.Query (
App,
"",
GetAboutBoxMessage (),
wrapMessage: false,
buttons: "_Ok"
),
Key.A.WithCtrl
)
])
])
{
Title = "menuBar",
Id = "menuBar"
};
return menuBar;
View [] CreateThemeMenuItems ()
{
List<View> menuItems = [];
_force16ColorsMenuItemCb = new ()
{
Title = "Force _16 Colors",
CheckedState = Application.Driver!.Force16Colors ? CheckState.Checked : CheckState.UnChecked,
// Best practice for CheckBoxes in menus is to disable focus and highlight states
CanFocus = false,
HighlightStates = MouseState.None
};
_force16ColorsMenuItemCb.CheckedStateChanging += (sender, args) =>
{
if (Application.Driver!.Force16Colors
&& args.Result == CheckState.UnChecked
&& !Application.Driver!.SupportsTrueColor)
{
args.Handled = true;
}
};
_force16ColorsMenuItemCb.CheckedStateChanged += (sender, args) =>
{
Application.Driver!.Force16Colors = args.Value == CheckState.Checked;
_force16ColorsShortcutCb!.CheckedState = args.Value;
SetNeedsDraw ();
};
menuItems.Add (
new MenuItem
{
CommandView = _force16ColorsMenuItemCb
});
menuItems.Add (new Line ());
if (ConfigurationManager.IsEnabled)
{
_themesSelector = new ()
{
// HighlightStates = MouseState.In,
CanFocus = true,
// InvertFocusAttribute = true
};
_themesSelector.ValueChanged += (_, args) =>
{
if (args.Value is null)
{
return;
}
ThemeManager.Theme = ThemeManager.GetThemeNames () [(int)args.Value];
};
var menuItem = new MenuItem
{
CommandView = _themesSelector,
HelpText = "Cycle Through Themes",
Key = Key.T.WithCtrl
};
menuItems.Add (menuItem);
menuItems.Add (new Line ());
_topSchemesSelector = new ()
{
// HighlightStates = MouseState.In,
};
_topSchemesSelector.ValueChanged += (_, args) =>
{
if (args.Value is null)
{
return;
}
CachedRunnableScheme = SchemeManager.GetSchemesForCurrentTheme ()!.Keys.ToArray () [(int)args.Value];
SchemeName = CachedRunnableScheme;
SetNeedsDraw ();
};
menuItem = new ()
{
Title = "Scheme for Runnable",
SubMenu = new (
[
new ()
{
CommandView = _topSchemesSelector,
HelpText = "Cycle Through schemes",
Key = Key.S.WithCtrl
}
])
};
menuItems.Add (menuItem);
UpdateThemesMenu ();
}
else
{
menuItems.Add (new MenuItem ()
{
Title = "Configuration Manager is not Enabled",
Enabled = false
});
}
return menuItems.ToArray ();
}
View [] CreateDiagnosticMenuItems ()
{
List<View> menuItems = [];
_diagnosticFlagsSelector = new ()
{
Styles = SelectorStyles.ShowNoneFlag,
CanFocus = true
};
_diagnosticFlagsSelector.UsedHotKeys.Add (Key.D);
_diagnosticFlagsSelector.AssignHotKeys = true;
_diagnosticFlagsSelector.Value = Diagnostics;
_diagnosticFlagsSelector.Selecting += (sender, args) =>
{
_diagnosticFlags = (ViewDiagnosticFlags)((int)args.Context!.Source!.Data!);// (ViewDiagnosticFlags)_diagnosticFlagsSelector.Value;
Diagnostics = _diagnosticFlags;
};
MenuItem diagFlagMenuItem = new MenuItem ()
{
CommandView = _diagnosticFlagsSelector,
HelpText = "View Diagnostics"
};
diagFlagMenuItem.Accepting += (sender, args) =>
{
//_diagnosticFlags = (ViewDiagnosticFlags)_diagnosticFlagsSelector.Value;
//Diagnostics = _diagnosticFlags;
//args.Handled = true;
};
menuItems.Add (diagFlagMenuItem);
menuItems.Add (new Line ());
_disableMouseCb = new ()
{
Title = "_Disable Mouse",
CheckedState = Application.IsMouseDisabled ? CheckState.Checked : CheckState.UnChecked,
// Best practice for CheckBoxes in menus is to disable focus and highlight states
CanFocus = false,
HighlightStates = MouseState.None
};
//_disableMouseCb.CheckedStateChanged += (_, args) => { Application.IsMouseDisabled = args.Value == CheckState.Checked; };
_disableMouseCb.Selecting += (sender, args) =>
{
Application.IsMouseDisabled = !Application.IsMouseDisabled;
_disableMouseCb.CheckedState = Application.IsMouseDisabled ? CheckState.Checked : CheckState.None;
};
menuItems.Add (
new MenuItem
{
CommandView = _disableMouseCb,
HelpText = "Disable Mouse"
});
return menuItems.ToArray ();
}
View [] CreateLoggingMenuItems ()
{
List<View?> menuItems = [];
LogLevel [] logLevels = Enum.GetValues<LogLevel> ();
_logLevelSelector = new ()
{
AssignHotKeys = true,
Labels = Enum.GetNames<LogLevel> (),
Value = logLevels.ToList ().IndexOf (Enum.Parse<LogLevel> (UICatalog.Options.DebugLogLevel)),
// HighlightStates = MouseState.In,
};
_logLevelSelector.ValueChanged += (_, args) =>
{
UICatalog.Options = UICatalog.Options with { DebugLogLevel = Enum.GetName (logLevels [args.Value!.Value])! };
UICatalog.LogLevelSwitch.MinimumLevel =
UICatalog.LogLevelToLogEventLevel (Enum.Parse<LogLevel> (UICatalog.Options.DebugLogLevel));
};
menuItems.Add (
new MenuItem
{
CommandView = _logLevelSelector,
HelpText = "Cycle Through Log Levels",
Key = Key.L.WithCtrl
});
// add a separator
menuItems.Add (new Line ());
menuItems.Add (
new MenuItem (
"_Open Log Folder",
string.Empty,
() => OpenUrl (UICatalog.LOGFILE_LOCATION)
));
return menuItems.ToArray ()!;
}
}
private void UpdateThemesMenu ()
{
if (_themesSelector is null)
{
return;
}
_themesSelector.Value = null;
_themesSelector.AssignHotKeys = true;
_themesSelector.UsedHotKeys.Clear ();
_themesSelector.Labels = ThemeManager.GetThemeNames ().ToArray ();
_themesSelector.Value = ThemeManager.GetThemeNames ().IndexOf (ThemeManager.GetCurrentThemeName ());
if (_topSchemesSelector is null)
{
return;
}
_topSchemesSelector.AssignHotKeys = true;
_topSchemesSelector.UsedHotKeys.Clear ();
int? selectedScheme = _topSchemesSelector.Value;
_topSchemesSelector.Labels = SchemeManager.GetSchemeNames ().ToArray ();
_topSchemesSelector.Value = selectedScheme;
if (CachedRunnableScheme is null || !SchemeManager.GetSchemeNames ().Contains (CachedRunnableScheme))
{
CachedRunnableScheme = SchemeManager.SchemesToSchemeName (Schemes.Base);
}
int newSelectedItem = SchemeManager.GetSchemeNames ().IndexOf (CachedRunnableScheme!);
// if the item is in bounds then select it
if (newSelectedItem >= 0 && newSelectedItem < SchemeManager.GetSchemeNames ().Count)
{
_topSchemesSelector.Value = newSelectedItem;
}
}
#endregion MenuBar
#region Scenario List
private readonly TableView _scenarioList;
private static int _cachedScenarioIndex;
public static ObservableCollection<Scenario>? CachedScenarios { get; set; }
// If set, holds the scenario the user selected to run
public static Scenario? CachedSelectedScenario { get; set; }
private TableView CreateScenarioList ()
{
// Create the scenario list. The contents of the scenario list changes whenever the
// Category list selection changes (to show just the scenarios that belong to the selected
// category).
TableView scenarioList = new ()
{
X = Pos.Right (_categoryList!) - 1,
Y = Pos.Bottom (_menuBar!),
Width = Dim.Fill (),
Height = Dim.Fill (Dim.Func (v => v!.Frame.Height, _statusBar)),
//AllowsMarking = false,
CanFocus = true,
Title = "_Scenarios",
BorderStyle = _categoryList!.BorderStyle,
SuperViewRendersLineCanvas = true
};
// TableView provides many options for table headers. For simplicity, we turn all
// of these off. By enabling FullRowSelect and turning off headers, TableView looks just
// like a ListView
scenarioList.FullRowSelect = true;
scenarioList.Style.ShowHeaders = false;
scenarioList.Style.ShowHorizontalHeaderOverline = false;
scenarioList.Style.ShowHorizontalHeaderUnderline = false;
scenarioList.Style.ShowHorizontalBottomline = false;
scenarioList.Style.ShowVerticalCellLines = false;
scenarioList.Style.ShowVerticalHeaderLines = false;
/* By default, TableView lays out columns at render time and only
* measures y rows of data at a time. Where y is the height of the
* console. This is for the following reasons:
*
* - Performance, when tables have a large amount of data
* - Defensive, prevents a single wide cell value pushing other
* columns off-screen (requiring horizontal scrolling
*
* In the case of UICatalog here, such an approach is overkill so
* we just measure all the data ourselves and set the appropriate
* max widths as ColumnStyles
*/
int longestName = CachedScenarios!.Max (s => s.GetName ().Length);
scenarioList.Style.ColumnStyles.Add (
0,
new () { MaxWidth = longestName, MinWidth = longestName, MinAcceptableWidth = longestName }
);
scenarioList.Style.ColumnStyles.Add (1, new () { MaxWidth = 1 });
scenarioList.CellActivated += ScenarioView_OpenSelectedItem;
// TableView typically is a grid where nav keys are biased for moving left/right.
scenarioList.KeyBindings.Remove (Key.Home);
scenarioList.KeyBindings.Add (Key.Home, Command.Start);
scenarioList.KeyBindings.Remove (Key.End);
scenarioList.KeyBindings.Add (Key.End, Command.End);
// Ideally, TableView.MultiSelect = false would turn off any keybindings for
// multi-select options. But it currently does not. UI Catalog uses Ctrl-A for
// a shortcut to About.
scenarioList.MultiSelect = false;
scenarioList.KeyBindings.Remove (Key.A.WithCtrl);
return scenarioList;
}
/// <summary>Launches the selected scenario, setting the global _selectedScenario</summary>
/// <param name="e"></param>
private void ScenarioView_OpenSelectedItem (object? sender, EventArgs? e)
{
if (CachedSelectedScenario is null)
{
// Save selected item state
_cachedCategoryIndex = _categoryList!.SelectedItem;
_cachedScenarioIndex = _scenarioList.SelectedRow;
// Create new instance of scenario (even though Scenarios contains instances)
var selectedScenarioName = (string)_scenarioList.Table [_scenarioList.SelectedRow, 0];
CachedSelectedScenario = (Scenario)Activator.CreateInstance (
CachedScenarios!.FirstOrDefault (
s => s.GetName ()
== selectedScenarioName
)!
.GetType ()
)!;
// Tell the main app to stop
Application.RequestStop ();
}
}
#endregion Scenario List
#region Category List
private readonly ListView? _categoryList;
private static int? _cachedCategoryIndex;
public static ObservableCollection<string>? CachedCategories { get; set; }
private ListView CreateCategoryList ()
{
// Create the Category list view. This list never changes.
ListView categoryList = new ()
{
X = 0,
Y = Pos.Bottom (_menuBar!),
Width = Dim.Auto (),
Height = Dim.Fill (Dim.Func (v => v!.Frame.Height, _statusBar)),
AllowsMarking = false,
CanFocus = true,
Title = "_Categories",
BorderStyle = LineStyle.Rounded,
SuperViewRendersLineCanvas = true,
Source = new ListWrapper<string> (CachedCategories)
};
categoryList.OpenSelectedItem += (s, a) => { _scenarioList!.SetFocus (); };
categoryList.SelectedItemChanged += CategoryView_SelectedChanged;
// This enables the scrollbar by causing lazy instantiation to happen
categoryList.VerticalScrollBar.AutoShow = true;
return categoryList;
}
private void CategoryView_SelectedChanged (object? sender, ListViewItemEventArgs? e)
{
if (e is null or { Item: null })
{
return;
}
string item = CachedCategories! [e.Item.Value];
ObservableCollection<Scenario> newScenarioList;
if (e.Item == 0)
{
// First category is "All"
newScenarioList = CachedScenarios!;
}
else
{
newScenarioList = new (CachedScenarios!.Where (s => s.GetCategories ().Contains (item)).ToList ());
}
_scenarioList.Table = new EnumerableTableSource<Scenario> (
newScenarioList,
new ()
{
{ "Name", s => s.GetName () }, { "Description", s => s.GetDescription () }
}
);
}
#endregion Category List
#region StatusBar
private readonly StatusBar? _statusBar;
[ConfigurationProperty (Scope = typeof (AppSettingsScope), OmitClassName = true)]
[JsonPropertyName ("UICatalog.StatusBar")]
public static bool ShowStatusBar { get; set; } = true;
private Shortcut? _shQuit;
private Shortcut? _shVersion;
private CheckBox? _force16ColorsShortcutCb;
private StatusBar CreateStatusBar ()
{
StatusBar statusBar = new ()
{
Visible = ShowStatusBar,
AlignmentModes = AlignmentModes.IgnoreFirstOrLast,
CanFocus = false
};
// ReSharper disable All
statusBar.Height = Dim.Auto (
DimAutoStyle.Auto,
minimumContentDim: Dim.Func (_ => statusBar.Visible ? 1 : 0),
maximumContentDim: Dim.Func (_ => statusBar.Visible ? 1 : 0));
// ReSharper restore All
_shQuit = new ()
{
CanFocus = false,
Title = "Quit",
Key = Application.QuitKey
};
_shVersion = new ()
{
Title = "Version Info",
CanFocus = false
};
var statusBarShortcut = new Shortcut
{
Key = Key.F10,
Title = "Show/Hide Status Bar",
CanFocus = false
};
statusBarShortcut.Accepting += (sender, args) =>
{
statusBar.Visible = !_statusBar!.Visible;
args.Handled = true;
};
_force16ColorsShortcutCb = new ()
{
Title = "16 color mode",
CheckedState = Application.Driver!.Force16Colors ? CheckState.Checked : CheckState.UnChecked,
CanFocus = true
};
Shortcut force16ColorsShortcut = new ()
{
CanFocus = false,
CommandView = _force16ColorsShortcutCb,
HelpText = "",
BindKeyToApplication = true,
Key = Key.F7
};
force16ColorsShortcut.Accepting += (sender, args) =>
{
Application.Driver.Force16Colors = !Application.Driver.Force16Colors;
_force16ColorsMenuItemCb!.CheckedState = Application.Driver.Force16Colors ? CheckState.Checked : CheckState.UnChecked;
SetNeedsDraw ();
args.Handled = true;
};
statusBar.Add (
_shQuit,
statusBarShortcut,
force16ColorsShortcut,
_shVersion
);
if (UICatalog.Options.DontEnableConfigurationManagement)
{
statusBar.AddShortcutAt (statusBar.SubViews.ToList ().IndexOf (_shVersion), new Shortcut () { Title = "CM is Disabled" });
}
return statusBar;
}
#endregion StatusBar
#region Configuration Manager
/// <summary>
/// Called when CM has applied changes.
/// </summary>
private void ConfigApplied ()
{
UpdateThemesMenu ();
SchemeName = CachedRunnableScheme;
if (_shQuit is { })
{
_shQuit.Key = Application.QuitKey;
}
if (_statusBar is { })
{
_statusBar.Visible = ShowStatusBar;
}
_disableMouseCb!.CheckedState = Application.IsMouseDisabled ? CheckState.Checked : CheckState.UnChecked;
_force16ColorsShortcutCb!.CheckedState = Application.Driver!.Force16Colors ? CheckState.Checked : CheckState.UnChecked;
Application.TopRunnableView?.SetNeedsDraw ();
}
private void ConfigAppliedHandler (object? sender, ConfigurationManagerEventArgs? a) { ConfigApplied (); }
#endregion Configuration Manager
/// <summary>
/// Gets the message displayed in the About Box. `public` so it can be used from Unit tests.
/// </summary>
/// <returns></returns>
public static string GetAboutBoxMessage ()
{
// NOTE: Do not use multiline verbatim strings here.
// WSL gets all confused.
StringBuilder msg = new ();
msg.AppendLine ("UI Catalog: A comprehensive sample library and test app for");
msg.AppendLine ();
msg.AppendLine (
"""
_______ _ _ _____ _
|__ __| (_) | | / ____| (_)
| | ___ _ __ _ __ ___ _ _ __ __ _| || | __ _ _ _
| |/ _ \ '__| '_ ` _ \| | '_ \ / _` | || | |_ | | | | |
| | __/ | | | | | | | | | | | (_| | || |__| | |_| | |
|_|\___|_| |_| |_| |_|_|_| |_|\__,_|_(_)_____|\__,_|_|
""");
msg.AppendLine ();
msg.AppendLine ("v2 - Pre-Alpha");
msg.AppendLine ();
msg.AppendLine ("https://github.com/gui-cs/Terminal.Gui");
return msg.ToString ();
}
public static void OpenUrl (string url)
{
if (RuntimeInformation.IsOSPlatform (OSPlatform.Windows))
{
url = url.Replace ("&", "^&");
Process.Start (new ProcessStartInfo ("cmd", $"/c start {url}") { CreateNoWindow = true });
}
else if (RuntimeInformation.IsOSPlatform (OSPlatform.Linux))
{
using var process = new Process
{
StartInfo = new ()
{
FileName = "xdg-open",
Arguments = url,
RedirectStandardError = true,
RedirectStandardOutput = true,
CreateNoWindow = true,
UseShellExecute = false
}
};
process.Start ();
}
else if (RuntimeInformation.IsOSPlatform (OSPlatform.OSX))
{
Process.Start ("open", url);
}
}
}