#nullable enable namespace Terminal.Gui; public static partial class Application // Keyboard handling { private static Key _nextTabGroupKey = Key.F6; // Resources/config.json overrrides private static Key _nextTabKey = Key.Tab; // Resources/config.json overrrides private static Key _prevTabGroupKey = Key.F6.WithShift; // Resources/config.json overrrides private static Key _prevTabKey = Key.Tab.WithShift; // Resources/config.json overrrides private static Key _quitKey = Key.Esc; // Resources/config.json overrrides private static Key _arrangeKey = Key.F5.WithCtrl; // Resources/config.json overrrides static Application () { AddApplicationKeyBindings (); } /// Gets the key bindings for this view. public static KeyBindings KeyBindings { get; internal set; } = new (); /// /// Event fired when the user presses a key. Fired by . /// /// Set to to indicate the key was handled and to prevent /// additional processing. /// /// /// /// All drivers support firing the event. Some drivers (Curses) do not support firing the /// and events. /// Fired after and before . /// public static event EventHandler? KeyDown; /// /// Event fired when the user releases a key. Fired by . /// /// Set to to indicate the key was handled and to prevent /// additional processing. /// /// /// /// All drivers support firing the event. Some drivers (Curses) do not support firing the /// and events. /// Fired after . /// public static event EventHandler? KeyUp; /// Alternative key to navigate forwards through views. Ctrl+Tab is the primary key. [SerializableConfigurationProperty (Scope = typeof (SettingsScope))] public static Key NextTabGroupKey { get => _nextTabGroupKey; set { if (_nextTabGroupKey != value) { ReplaceKey (_nextTabGroupKey, value); _nextTabGroupKey = value; } } } /// Alternative key to navigate forwards through views. Ctrl+Tab is the primary key. [SerializableConfigurationProperty (Scope = typeof (SettingsScope))] public static Key NextTabKey { get => _nextTabKey; set { if (_nextTabKey != value) { ReplaceKey (_nextTabKey, value); _nextTabKey = value; } } } /// /// Called by the when the user presses a key. Fires the event /// then calls on all top level views. Called after and /// before . /// /// Can be used to simulate key press events. /// /// if the key was handled. public static bool OnKeyDown (Key keyEvent) { //if (!IsInitialized) //{ // return true; //} KeyDown?.Invoke (null, keyEvent); if (keyEvent.Handled) { return true; } if (Top is null) { foreach (Toplevel topLevel in TopLevels.ToList ()) { if (topLevel.NewKeyDownEvent (keyEvent)) { return true; } if (topLevel.Modal) { break; } } } else { if (Top.NewKeyDownEvent (keyEvent)) { return true; } } // Invoke any Application-scoped KeyBindings. // The first view that handles the key will stop the loop. foreach (KeyValuePair binding in KeyBindings.Bindings.Where (b => b.Key == keyEvent.KeyCode)) { if (binding.Value.BoundView is { }) { bool? handled = binding.Value.BoundView?.InvokeCommands (binding.Value.Commands, binding.Key, binding.Value); if (handled != null && (bool)handled) { return true; } } else { if (!KeyBindings.TryGet (keyEvent, KeyBindingScope.Application, out KeyBinding appBinding)) { continue; } bool? toReturn = null; foreach (Command command in appBinding.Commands) { toReturn = InvokeCommand (command, keyEvent, appBinding); } return toReturn ?? true; } } return false; } /// /// INTENRAL method to invoke one of the commands in /// /// /// /// /// /// private static bool? InvokeCommand (Command command, Key keyEvent, KeyBinding appBinding) { if (!CommandImplementations!.ContainsKey (command)) { throw new NotSupportedException ( @$"A KeyBinding was set up for the command {command} ({keyEvent}) but that command is not supported by Application." ); } if (CommandImplementations.TryGetValue (command, out Func? implementation)) { var context = new CommandContext (command, keyEvent, appBinding); // Create the context here return implementation (context); } return false; } /// /// Called by the when the user releases a key. Fires the event /// then calls on all top level views. Called after . /// /// Can be used to simulate key press events. /// /// if the key was handled. public static bool OnKeyUp (Key a) { if (!IsInitialized) { return true; } KeyUp?.Invoke (null, a); if (a.Handled) { return true; } foreach (Toplevel topLevel in TopLevels.ToList ()) { if (topLevel.NewKeyUpEvent (a)) { return true; } if (topLevel.Modal) { break; } } return false; } /// Alternative key to navigate backwards through views. Shift+Ctrl+Tab is the primary key. [SerializableConfigurationProperty (Scope = typeof (SettingsScope))] public static Key PrevTabGroupKey { get => _prevTabGroupKey; set { if (_prevTabGroupKey != value) { ReplaceKey (_prevTabGroupKey, value); _prevTabGroupKey = value; } } } /// Alternative key to navigate backwards through views. Shift+Ctrl+Tab is the primary key. [SerializableConfigurationProperty (Scope = typeof (SettingsScope))] public static Key PrevTabKey { get => _prevTabKey; set { if (_prevTabKey != value) { ReplaceKey (_prevTabKey, value); _prevTabKey = value; } } } /// Gets or sets the key to quit the application. [SerializableConfigurationProperty (Scope = typeof (SettingsScope))] public static Key QuitKey { get => _quitKey; set { if (_quitKey != value) { ReplaceKey (_quitKey, value); _quitKey = value; } } } /// Gets or sets the key to activate arranging views using the keyboard. [SerializableConfigurationProperty (Scope = typeof (SettingsScope))] public static Key ArrangeKey { get => _arrangeKey; set { if (_arrangeKey != value) { ReplaceKey (_arrangeKey, value); _arrangeKey = value; } } } internal static void AddApplicationKeyBindings () { CommandImplementations = new (); // Things this view knows how to do AddCommand ( Command.Quit, static () => { RequestStop (); return true; } ); AddCommand ( Command.Suspend, static () => { Driver?.Suspend (); return true; } ); AddCommand ( Command.NextTabStop, static () => Navigation?.AdvanceFocus (NavigationDirection.Forward, TabBehavior.TabStop)); AddCommand ( Command.PreviousTabStop, static () => Navigation?.AdvanceFocus (NavigationDirection.Backward, TabBehavior.TabStop)); AddCommand ( Command.NextTabGroup, static () => Navigation?.AdvanceFocus (NavigationDirection.Forward, TabBehavior.TabGroup)); AddCommand ( Command.PreviousTabGroup, static () => Navigation?.AdvanceFocus (NavigationDirection.Backward, TabBehavior.TabGroup)); AddCommand ( Command.Refresh, static () => { Refresh (); return true; } ); AddCommand ( Command.Edit, static () => { View? viewToArrange = Navigation?.GetFocused (); // Go up the superview hierarchy and find the first that is not ViewArrangement.Fixed while (viewToArrange is { SuperView: { }, Arrangement: ViewArrangement.Fixed }) { viewToArrange = viewToArrange.SuperView; } if (viewToArrange is { }) { return viewToArrange.Border?.EnterArrangeMode (ViewArrangement.Fixed); } return false; }); KeyBindings.Clear (); // Resources/config.json overrrides 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); KeyBindings.Add (NextTabGroupKey, KeyBindingScope.Application, Command.NextTabGroup); KeyBindings.Add (PrevTabGroupKey, KeyBindingScope.Application, Command.PreviousTabGroup); KeyBindings.Add (ArrangeKey, KeyBindingScope.Application, Command.Edit); // TODO: Refresh Key should be configurable KeyBindings.Add (Key.F5, KeyBindingScope.Application, Command.Refresh); // TODO: Suspend Key should be configurable if (Environment.OSVersion.Platform == PlatformID.Unix) { KeyBindings.Add (Key.Z.WithCtrl, KeyBindingScope.Application, Command.Suspend); } } /// /// Gets the list of Views that have key bindings. /// /// /// This is an internal method used by the class to add Application key bindings. /// /// The list of Views that have Application-scoped key bindings. internal static List 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 (); } /// /// /// Sets the function that will be invoked for a . /// /// /// If AddCommand has already been called for will /// replace the old one. /// /// /// /// /// This version of AddCommand is for commands that do not require a . /// /// /// The command. /// The function. private static void AddCommand (Command command, Func f) { CommandImplementations! [command] = ctx => f (); } /// /// Commands for Application. /// private static Dictionary>? CommandImplementations { get; set; } private static void ReplaceKey (Key oldKey, Key newKey) { if (KeyBindings.Bindings.Count == 0) { return; } if (newKey == Key.Empty) { KeyBindings.Remove (oldKey); } else { KeyBindings.ReplaceKey (oldKey, newKey); } } }