Files
Terminal.Gui/Examples/UICatalog/Scenarios/CharacterMap/CharacterMap.cs
BDisp 00aaefb962 Fixes #3951. Adds View dependency to DimFunc and PosFunc (#4210)
* Fixes #4208. MainLoopSyncContext doesn't work with the v2 drivers

* Fixes #3951. Add DimFuncWithView with a View dependency

* Revert to iteration which will handle the necessary processes

* Revert "Revert to iteration which will handle the necessary processes"

This reverts commit 50015ac6da.

* Layout and draw before position cursor

* Add optional View parameter and property to the DimFunc and PosFunc

* Trying fix unit test error

* Revert layout changes

* Fixes #4216. Legacy drivers aren't refreshing the screen correctly on view drag

* Add assertion proving NeedsLayout is always false before call OnSubViewsLaidOut

* Fix unit test error

* Increasing time to abort

* Revert "Increasing time to abort"

This reverts commit d7306e72f3.

* Trying fix integration tests

* Still trying fix integrations unit tests

* Revert comment

* Layout is performed during the iteration

* Using Dim.Func with status bar view

* Still trying fix integrations tests by locking _subviews

* Still trying fix integrations tests by locking _subviews

* Add internal SnapshotSubviews method

* Remove lock from SnapshotSubviews method

* Using SnapshotSubviews method in the DrawSubViews method

* Remove lock from SnapshotSubviews method

* Using SnapshotSubviews method in the DrawSubViews method

* Using SnapshotSubviews

* Prevent new app if the previous wasn't yet finished

* Replace SnapshotSubviews method with ViewCollectionHelpers class

* Lock entire GuiTestContext constructor

* Using Snapshot in the ordered field

* Fixes #4221 Extra modifiers f1 to f4 in v2net (#4220)

* Assume we are running in a terminal that supports true color by default unless user explicitly forces 16

* Add support for extra modifiers for F1 to F4 keys

* Revert "Assume we are running in a terminal that supports true color by default unless user explicitly forces 16"

This reverts commit 4cc2530de0.

* Cleanup

* Update comments

* Code cleanup

---------

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

* Move ViewCollectionHelpers class to a separate file

* Remove Border.Layout call in the DoDrawAdornmentsSubViews method.

* Remove adornments layout call within the draw

---------

Co-authored-by: Tig <tig@users.noreply.github.com>
Co-authored-by: Thomas Nind <31306100+tznind@users.noreply.github.com>
2025-09-01 10:40:10 -06:00

357 lines
12 KiB
C#

#nullable enable
using System;
using System.Collections.Generic;
using System.Globalization;
using System.Linq;
using System.Text;
namespace UICatalog.Scenarios;
/// <summary>
/// This Scenario demonstrates building a custom control (a class deriving from View) that: - Provides a
/// "Character Map" application (like Windows' charmap.exe). - Helps test unicode character rendering in Terminal.Gui -
/// Illustrates how to do infinite scrolling
/// </summary>
[ScenarioMetadata ("Character Map", "Unicode viewer. Demos infinite content drawing and scrolling.")]
[ScenarioCategory ("Text and Formatting")]
[ScenarioCategory ("Drawing")]
[ScenarioCategory ("Controls")]
[ScenarioCategory ("Layout")]
[ScenarioCategory ("Scrolling")]
public class CharacterMap : Scenario
{
private Label? _errorLabel;
private TableView? _categoryList;
private CharMap? _charMap;
// Don't create a Window, just return the top-level view
public override void Main ()
{
Application.Init ();
var top = new Window
{
BorderStyle = LineStyle.None
};
_charMap = new ()
{
X = 0,
Y = 1,
Height = Dim.Fill (),
// SchemeName = "Base"
};
top.Add (_charMap);
var jumpLabel = new Label
{
X = Pos.Right (_charMap) + 1,
Y = Pos.Y (_charMap),
HotKeySpecifier = (Rune)'_',
Text = "_Jump To:",
//SchemeName = "Dialog"
};
top.Add (jumpLabel);
var jumpEdit = new TextField
{
X = Pos.Right (jumpLabel) + 1,
Y = Pos.Y (_charMap),
Width = 17,
Caption = "e.g. 01BE3 or ✈",
//SchemeName = "Dialog"
};
top.Add (jumpEdit);
_charMap.SelectedCodePointChanged += (sender, args) =>
{
if (Rune.IsValid (args.Value))
{
jumpEdit.Text = ((Rune)args.Value).ToString ();
}
else
{
jumpEdit.Text = $"U+{args.Value:x5}";
}
};
_errorLabel = new ()
{
X = Pos.Right (jumpEdit) + 1,
Y = Pos.Y (_charMap),
SchemeName = "error",
Text = "err",
Visible = false
};
top.Add (_errorLabel);
jumpEdit.Accepting += JumpEditOnAccept;
_categoryList = new () {
X = Pos.Right (_charMap),
Y = Pos.Bottom (jumpLabel),
Height = Dim.Fill (),
//SchemeName = "Dialog"
};
_categoryList.FullRowSelect = true;
_categoryList.MultiSelect = false;
_categoryList.Style.ShowVerticalCellLines = false;
_categoryList.Style.AlwaysShowHeaders = true;
var isDescending = false;
_categoryList.Table = CreateCategoryTable (0, isDescending);
// if user clicks the mouse in TableView
_categoryList.MouseClick += (s, e) =>
{
_categoryList.ScreenToCell (e.Position, out int? clickedCol);
if (clickedCol != null && e.Flags.HasFlag (MouseFlags.Button1Clicked))
{
EnumerableTableSource<UnicodeRange> table = (EnumerableTableSource<UnicodeRange>)_categoryList.Table;
string prevSelection = table.Data.ElementAt (_categoryList.SelectedRow).Category;
isDescending = !isDescending;
_categoryList.Table = CreateCategoryTable (clickedCol.Value, isDescending);
table = (EnumerableTableSource<UnicodeRange>)_categoryList.Table;
_categoryList.SelectedRow = table.Data
.Select ((item, index) => new { item, index })
.FirstOrDefault (x => x.item.Category == prevSelection)
?.index
?? -1;
}
};
int longestName = UnicodeRange.Ranges.Max (r => r.Category.GetColumns ());
_categoryList.Style.ColumnStyles.Add (
0,
new () { MaxWidth = longestName, MinWidth = longestName, MinAcceptableWidth = longestName }
);
_categoryList.Style.ColumnStyles.Add (1, new () { MaxWidth = 1, MinWidth = 6 });
_categoryList.Style.ColumnStyles.Add (2, new () { MaxWidth = 1, MinWidth = 6 });
_categoryList.Width = _categoryList.Style.ColumnStyles.Sum (c => c.Value.MinWidth) + 4;
_categoryList.SelectedCellChanged += (s, args) =>
{
EnumerableTableSource<UnicodeRange> table = (EnumerableTableSource<UnicodeRange>)_categoryList.Table;
_charMap.StartCodePoint = table.Data.ToArray () [args.NewRow].Start;
jumpEdit.Text = $"U+{_charMap.SelectedCodePoint:x5}";
};
top.Add (_categoryList);
var menu = new MenuBarv2
{
Menus =
[
new (
"_File",
new MenuItemv2 []
{
new (
"_Quit",
$"{Application.QuitKey}",
() => Application.RequestStop ()
)
}
),
new (
"_Options",
new MenuItemv2 [] { CreateMenuShowWidth () }
)
]
};
top.Add (menu);
_charMap.Width = Dim.Fill (Dim.Func (v => v!.Frame.Width, _categoryList));
_charMap.SelectedCodePoint = 0;
_charMap.SetFocus ();
Application.Run (top);
top.Dispose ();
Application.Shutdown ();
return;
void JumpEditOnAccept (object? sender, CommandEventArgs e)
{
if (jumpEdit.Text.Length == 0)
{
return;
}
_errorLabel.Visible = true;
uint result = 0;
if (jumpEdit.Text.Length == 1)
{
result = (uint)jumpEdit.Text.ToRunes () [0].Value;
}
else if (jumpEdit.Text.StartsWith ("U+", StringComparison.OrdinalIgnoreCase) || jumpEdit.Text.StartsWith ("\\u"))
{
try
{
result = uint.Parse (jumpEdit.Text [2..], NumberStyles.HexNumber);
}
catch (FormatException)
{
_errorLabel.Text = "Invalid hex value";
return;
}
}
else if (jumpEdit.Text.StartsWith ("0", StringComparison.OrdinalIgnoreCase) || jumpEdit.Text.StartsWith ("\\u"))
{
try
{
result = uint.Parse (jumpEdit.Text, NumberStyles.HexNumber);
}
catch (FormatException)
{
_errorLabel.Text = "Invalid hex value";
return;
}
}
else
{
try
{
result = uint.Parse (jumpEdit.Text, NumberStyles.Integer);
}
catch (FormatException)
{
_errorLabel.Text = "Invalid value";
return;
}
}
if (result > RuneExtensions.MaxUnicodeCodePoint)
{
_errorLabel.Text = "Beyond maximum codepoint";
return;
}
_errorLabel.Visible = false;
EnumerableTableSource<UnicodeRange> table = (EnumerableTableSource<UnicodeRange>)_categoryList!.Table;
_categoryList.SelectedRow = table.Data
.Select ((item, index) => new { item, index })
.FirstOrDefault (x => x.item.Start <= result && x.item.End >= result)
?.index
?? -1;
_categoryList.EnsureSelectedCellIsVisible ();
// Ensure the typed glyph is selected
_charMap.SelectedCodePoint = (int)result;
_charMap.SetFocus ();
// Cancel the event to prevent ENTER from being handled elsewhere
e.Handled = true;
}
}
private EnumerableTableSource<UnicodeRange> CreateCategoryTable (int sortByColumn, bool descending)
{
Func<UnicodeRange, object> orderBy;
var categorySort = string.Empty;
var startSort = string.Empty;
var endSort = string.Empty;
string sortIndicator = descending ? Glyphs.DownArrow.ToString () : Glyphs.UpArrow.ToString ();
switch (sortByColumn)
{
case 0:
orderBy = r => r.Category;
categorySort = sortIndicator;
break;
case 1:
orderBy = r => r.Start;
startSort = sortIndicator;
break;
case 2:
orderBy = r => r.End;
endSort = sortIndicator;
break;
default:
throw new ArgumentException ("Invalid column number.");
}
IOrderedEnumerable<UnicodeRange> sortedRanges = descending
? UnicodeRange.Ranges.OrderByDescending (orderBy)
: UnicodeRange.Ranges.OrderBy (orderBy);
return new (
sortedRanges,
new ()
{
{ $"Category{categorySort}", s => s.Category },
{ $"Start{startSort}", s => $"{s.Start:x5}" },
{ $"End{endSort}", s => $"{s.End:x5}" }
}
);
}
private MenuItemv2 CreateMenuShowWidth ()
{
CheckBox cb = new ()
{
Title = "_Show Glyph Width",
CheckedState = _charMap!.ShowGlyphWidths ? CheckState.Checked : CheckState.None
};
var item = new MenuItemv2 { CommandView = cb };
item.Action += () =>
{
if (_charMap is { })
{
_charMap.ShowGlyphWidths = cb.CheckedState == CheckState.Checked;
}
};
return item;
}
public override List<Key> GetDemoKeyStrokes ()
{
List<Key> keys = new ();
for (var i = 0; i < 200; i++)
{
keys.Add (Key.CursorDown);
}
// Category table
keys.Add (Key.Tab.WithShift);
// Block elements
keys.Add (Key.B);
keys.Add (Key.L);
keys.Add (Key.Tab);
for (var i = 0; i < 200; i++)
{
keys.Add (Key.CursorLeft);
}
return keys;
}
}