Skip to content

Commit

Permalink
Merge branch 'v2_develop' into v2_release after closing #3880
Browse files Browse the repository at this point in the history
  • Loading branch information
@tig
tig committed Dec 10, 2024
2 parents 3a6d66f + 7676f89 commit 9f950be
Show file tree
Hide file tree
Showing 162 changed files with 5,971 additions and 3,283 deletions.
28 changes: 22 additions & 6 deletions Terminal.Gui/Application/Application.Initialization.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ internal static void InternalInit (
}
}

AddApplicationKeyBindings ();
AddKeyBindings ();

// Start the process of configuration management.
// Note that we end up calling LoadConfigurationFromAllSources
Expand Down Expand Up @@ -150,6 +150,7 @@ internal static void InternalInit (
try
{
MainLoop = Driver!.Init ();
SubscribeDriverEvents ();
}
catch (InvalidOperationException ex)
{
Expand All @@ -163,11 +164,6 @@ internal static void InternalInit (
);
}

Driver.SizeChanged += Driver_SizeChanged;
Driver.KeyDown += Driver_KeyDown;
Driver.KeyUp += Driver_KeyUp;
Driver.MouseEvent += Driver_MouseEvent;

SynchronizationContext.SetSynchronizationContext (new MainLoopSyncContext ());

SupportedCultures = GetSupportedCultures ();
Expand All @@ -176,6 +172,26 @@ internal static void InternalInit (
InitializedChanged?.Invoke (null, new (init));
}

internal static void SubscribeDriverEvents ()
{
ArgumentNullException.ThrowIfNull (Driver);

Driver.SizeChanged += Driver_SizeChanged;
Driver.KeyDown += Driver_KeyDown;
Driver.KeyUp += Driver_KeyUp;
Driver.MouseEvent += Driver_MouseEvent;
}

internal static void UnsubscribeDriverEvents ()
{
ArgumentNullException.ThrowIfNull (Driver);

Driver.SizeChanged -= Driver_SizeChanged;
Driver.KeyDown -= Driver_KeyDown;
Driver.KeyUp -= Driver_KeyUp;
Driver.MouseEvent -= Driver_MouseEvent;
}

private static void Driver_SizeChanged (object? sender, SizeChangedEventArgs e) { OnSizeChanging (e); }
private static void Driver_KeyDown (object? sender, Key e) { RaiseKeyDownEvent (e); }
private static void Driver_KeyUp (object? sender, Key e) { RaiseKeyUpEvent (e); }
Expand Down
119 changes: 39 additions & 80 deletions Terminal.Gui/Application/Application.Keyboard.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -45,16 +45,17 @@ public static bool RaiseKeyDownEvent (Key key)

// Invoke any Application-scoped KeyBindings.
// The first view that handles the key will stop the loop.
foreach (KeyValuePair<Key, KeyBinding> binding in KeyBindings.Bindings.Where (b => b.Key == key.KeyCode))
// foreach (KeyValuePair<Key, KeyBinding> binding in KeyBindings.GetBindings (key))
if (KeyBindings.TryGet (key, out KeyBinding binding))
{
if (binding.Value.BoundView is { })
if (binding.Target is { })
{
if (!binding.Value.BoundView.Enabled)
if (!binding.Target.Enabled)
{
return false;
}

bool? handled = binding.Value.BoundView?.InvokeCommands (binding.Value.Commands, binding.Key, binding.Value);
bool? handled = binding.Target?.InvokeCommands (binding.Commands, binding);

if (handled != null && (bool)handled)
{
Expand All @@ -63,16 +64,17 @@ public static bool RaiseKeyDownEvent (Key key)
}
else
{
if (!KeyBindings.TryGet (key, KeyBindingScope.Application, out KeyBinding appBinding))
// BUGBUG: this seems unneeded.
if (!KeyBindings.TryGet (key, out KeyBinding keybinding))
{
continue;
return false;
}

bool? toReturn = null;

foreach (Command command in appBinding.Commands)
foreach (Command command in keybinding.Commands)
{
toReturn = InvokeCommand (command, key, appBinding);
toReturn = InvokeCommand (command, key, keybinding);
}

return toReturn ?? true;
Expand All @@ -81,18 +83,18 @@ public static bool RaiseKeyDownEvent (Key key)

return false;

static bool? InvokeCommand (Command command, Key key, KeyBinding appBinding)
static bool? InvokeCommand (Command command, Key key, KeyBinding binding)
{
if (!CommandImplementations!.ContainsKey (command))
if (!_commandImplementations!.ContainsKey (command))
{
throw new NotSupportedException (
@$"A KeyBinding was set up for the command {command} ({key}) but that command is not supported by Application."
);
}

if (CommandImplementations.TryGetValue (command, out View.CommandImplementation? implementation))
if (_commandImplementations.TryGetValue (command, out View.CommandImplementation? implementation))
{
var context = new CommandContext (command, key, appBinding); // Create the context here
CommandContext<KeyBinding> context = new (command, binding); // Create the context here

return implementation (context);
}
Expand All @@ -116,7 +118,8 @@ public static bool RaiseKeyDownEvent (Key key)
public static event EventHandler<Key>? KeyDown;

/// <summary>
/// Called when the user releases a key (by the <see cref="IConsoleDriver"/>). Raises the cancelable <see cref="KeyUp"/>
/// Called when the user releases a key (by the <see cref="IConsoleDriver"/>). Raises the cancelable
/// <see cref="KeyUp"/>
/// event
/// then calls <see cref="View.NewKeyUpEvent"/> on all top level views. Called after <see cref="RaiseKeyDownEvent"/>.
/// </summary>
Expand Down Expand Up @@ -155,14 +158,14 @@ public static bool RaiseKeyUpEvent (Key key)

#region Application-scoped KeyBindings

static Application () { AddApplicationKeyBindings (); }
static Application () { AddKeyBindings (); }

/// <summary>Gets the Application-scoped key bindings.</summary>
public static KeyBindings KeyBindings { get; internal set; } = new ();
public static KeyBindings KeyBindings { get; internal set; } = new (null);

internal static void AddApplicationKeyBindings ()
internal static void AddKeyBindings ()
{
CommandImplementations = new ();
_commandImplementations.Clear ();

// Things this view knows how to do
AddCommand (
Expand Down Expand Up @@ -231,83 +234,40 @@ internal static void AddApplicationKeyBindings ()
return false;
});

KeyBindings.Clear ();

// Resources/config.json overrides
QuitKey = Key.Esc;
NextTabKey = Key.Tab;
PrevTabKey = Key.Tab.WithShift;
NextTabGroupKey = Key.F6;
PrevTabGroupKey = Key.F6.WithShift;
QuitKey = Key.Esc;
ArrangeKey = Key.F5.WithCtrl;

KeyBindings.Add (QuitKey, KeyBindingScope.Application, Command.Quit);

KeyBindings.Add (Key.CursorRight, KeyBindingScope.Application, Command.NextTabStop);
KeyBindings.Add (Key.CursorDown, KeyBindingScope.Application, Command.NextTabStop);
KeyBindings.Add (Key.CursorLeft, KeyBindingScope.Application, Command.PreviousTabStop);
KeyBindings.Add (Key.CursorUp, KeyBindingScope.Application, Command.PreviousTabStop);
KeyBindings.Add (NextTabKey, KeyBindingScope.Application, Command.NextTabStop);
KeyBindings.Add (PrevTabKey, KeyBindingScope.Application, Command.PreviousTabStop);
// Need to clear after setting the above to ensure actually clear
// because set_QuitKey etc.. may call Add
KeyBindings.Clear ();

KeyBindings.Add (NextTabGroupKey, KeyBindingScope.Application, Command.NextTabGroup);
KeyBindings.Add (PrevTabGroupKey, KeyBindingScope.Application, Command.PreviousTabGroup);
KeyBindings.Add (QuitKey, Command.Quit);
KeyBindings.Add (NextTabKey, Command.NextTabStop);
KeyBindings.Add (PrevTabKey, Command.PreviousTabStop);
KeyBindings.Add (NextTabGroupKey, Command.NextTabGroup);
KeyBindings.Add (PrevTabGroupKey, Command.PreviousTabGroup);
KeyBindings.Add (ArrangeKey, Command.Edit);

KeyBindings.Add (ArrangeKey, KeyBindingScope.Application, Command.Edit);
KeyBindings.Add (Key.CursorRight, Command.NextTabStop);
KeyBindings.Add (Key.CursorDown, Command.NextTabStop);
KeyBindings.Add (Key.CursorLeft, Command.PreviousTabStop);
KeyBindings.Add (Key.CursorUp, Command.PreviousTabStop);

// TODO: Refresh Key should be configurable
KeyBindings.Add (Key.F5, KeyBindingScope.Application, Command.Refresh);
KeyBindings.Add (Key.F5, Command.Refresh);

// TODO: Suspend Key should be configurable
if (Environment.OSVersion.Platform == PlatformID.Unix)
{
KeyBindings.Add (Key.Z.WithCtrl, KeyBindingScope.Application, Command.Suspend);
}
}

/// <summary>
/// Gets the list of Views that have <see cref="KeyBindingScope.Application"/> key bindings.
/// </summary>
/// <remarks>
/// This is an internal method used by the <see cref="View"/> class to add Application key bindings.
/// </remarks>
/// <returns>The list of Views that have Application-scoped key bindings.</returns>
internal static List<KeyBinding> GetViewKeyBindings ()
{
// Get the list of views that do not have Application-scoped key bindings
return KeyBindings.Bindings
.Where (kv => kv.Value.Scope != KeyBindingScope.Application)
.Select (kv => kv.Value)
.Distinct ()
.ToList ();
}

private static void ReplaceKey (Key oldKey, Key newKey)
{
if (KeyBindings.Bindings.Count == 0)
{
return;
}

if (newKey == Key.Empty)
{
KeyBindings.Remove (oldKey);
}
else
{
if (KeyBindings.TryGet(oldKey, out KeyBinding binding))
{
KeyBindings.Remove (oldKey);
KeyBindings.Add (newKey, binding);
}
else
{
KeyBindings.Add (newKey, binding);
}
KeyBindings.Add (Key.Z.WithCtrl, Command.Suspend);
}
}


#endregion Application-scoped KeyBindings

/// <summary>
Expand All @@ -321,16 +281,15 @@ private static void ReplaceKey (Key oldKey, Key newKey)
/// </summary>
/// <remarks>
/// <para>
/// This version of AddCommand is for commands that do not require a <see cref="CommandContext"/>.
/// This version of AddCommand is for commands that do not require a <see cref="ICommandContext"/>.
/// </para>
/// </remarks>
/// <param name="command">The command.</param>
/// <param name="f">The function.</param>
private static void AddCommand (Command command, Func<bool?> f) { CommandImplementations! [command] = ctx => f (); }
private static void AddCommand (Command command, Func<bool?> f) { _commandImplementations! [command] = ctx => f (); }

/// <summary>
/// Commands for Application.
/// </summary>
private static Dictionary<Command, View.CommandImplementation>? CommandImplementations { get; set; }

private static readonly Dictionary<Command, View.CommandImplementation> _commandImplementations = new ();
}
2 changes: 1 addition & 1 deletion Terminal.Gui/Application/Application.Mouse.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -184,7 +184,7 @@ internal static void RaiseMouseEvent (MouseEventArgs mouseEvent)
}

// Create a view-relative mouse event to send to the view that is under the mouse.
MouseEventArgs? viewMouseEvent;
MouseEventArgs viewMouseEvent;

if (deepestViewUnderMouse is Adornment adornment)
{
Expand Down
10 changes: 5 additions & 5 deletions Terminal.Gui/Application/Application.Navigation.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ public static Key NextTabGroupKey
{
if (_nextTabGroupKey != value)
{
ReplaceKey (_nextTabGroupKey, value);
KeyBindings.Replace (_nextTabGroupKey, value);
_nextTabGroupKey = value;
}
}
Expand All @@ -37,7 +37,7 @@ public static Key NextTabKey
{
if (_nextTabKey != value)
{
ReplaceKey (_nextTabKey, value);
KeyBindings.Replace (_nextTabKey, value);
_nextTabKey = value;
}
}
Expand Down Expand Up @@ -66,7 +66,7 @@ public static Key PrevTabGroupKey
{
if (_prevTabGroupKey != value)
{
ReplaceKey (_prevTabGroupKey, value);
KeyBindings.Replace (_prevTabGroupKey, value);
_prevTabGroupKey = value;
}
}
Expand All @@ -78,10 +78,10 @@ public static Key PrevTabKey
{
get => _prevTabKey;
set
{
{
if (_prevTabKey != value)
{
ReplaceKey (_prevTabKey, value);
KeyBindings.Replace (_prevTabKey, value);
_prevTabKey = value;
}
}
Expand Down
4 changes: 2 additions & 2 deletions Terminal.Gui/Application/Application.Run.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ public static Key QuitKey
{
if (_quitKey != value)
{
ReplaceKey (_quitKey, value);
KeyBindings.Replace (_quitKey, value);
_quitKey = value;
}
}
Expand All @@ -37,7 +37,7 @@ public static Key ArrangeKey
{
if (_arrangeKey != value)
{
ReplaceKey (_arrangeKey, value);
KeyBindings.Replace (_arrangeKey, value);
_arrangeKey = value;
}
}
Expand Down
8 changes: 3 additions & 5 deletions Terminal.Gui/Application/Application.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -177,10 +177,7 @@ internal static void ResetState (bool ignoreDisposed = false)
// Driver stuff
if (Driver is { })
{
Driver.SizeChanged -= Driver_SizeChanged;
Driver.KeyDown -= Driver_KeyDown;
Driver.KeyUp -= Driver_KeyUp;
Driver.MouseEvent -= Driver_MouseEvent;
UnsubscribeDriverEvents ();
Driver?.End ();
Driver = null;
}
Expand Down Expand Up @@ -217,7 +214,8 @@ internal static void ResetState (bool ignoreDisposed = false)

ClearScreenNextIteration = false;

AddApplicationKeyBindings ();
KeyBindings.Clear ();
AddKeyBindings ();

// Reset synchronization context to allow the user to run async/await,
// as the main loop has been ended, the synchronization context from
Expand Down
7 changes: 7 additions & 0 deletions Terminal.Gui/Application/MainLoop.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -268,6 +268,8 @@ internal void RunIteration ()
}
}

RunAnsiScheduler ();

MainLoopDriver?.Iteration ();

bool runIdle;
Expand All @@ -283,6 +285,11 @@ internal void RunIteration ()
}
}

private void RunAnsiScheduler ()
{
Application.Driver?.GetRequestScheduler ().RunSchedule ();
}

/// <summary>Stops the main loop driver and calls <see cref="IMainLoopDriver.Wakeup"/>. Used only for unit tests.</summary>
internal void Stop ()
{
Expand Down
Loading

0 comments on commit 9f950be

Please sign in to comment.