Custom key maps #328

trevarj · 2021-05-24T18:36:50Z

Actions can now be overridden with custom keys

Implementation and usage are fairly straight forward if you look at the config.yaml

I won't really be using this, so I tried to make it very simple. Maybe if someone who uses custom key maps has other ideas, then I will add to this. For example, binding a command to a key combo, or adding more combos (ctrl_shift_x), etc...

Closes #328

Actions can now be overridden with custom keys

trevarj

A lot of the diff in crates/libtiny_tui/src/input_area/mod.rs is just moving code around

trevarj · 2021-05-24T18:39:35Z

crates/libtiny_tui/src/key_map.rs

+
+#[derive(Debug, Copy, Clone, Deserialize, PartialEq)]
+#[serde(rename_all = "snake_case")]
+pub(crate) enum KeyAction {


A KeyAction is dropped in any where a hardcoded Key combo was (except in a few areas where it makes no sense, like up arrow for scrolling back in history.

trevarj · 2021-05-24T18:46:36Z

crates/term_input/src/lib.rs

    [8] => Key::Backspace,
    [127] => Key::Backspace,
    [1] => Key::Ctrl('a'),
+    [2] => Key::Ctrl('b'),


Added more supported keys. Did not verify them all, but a few I did verify with showkey -a.
If more keys/combos are useful I can add them too

eoli3n · 2021-05-25T07:58:24Z

Note to myself

Sandbox
https://gist.github.com/eoli3n/93111f23dbb1233f2f00f460663f99e2

Install

pacman -S rust vim --noconfirm
su - user
git clone https://github.com/trevarj/tiny.git
cd tiny
git checkout custom-keymap
cargo install --path crates/tiny

Generate config file template

~/.cargo/bin/tiny

Add to the end of config file

key_map:
  ### Defaults ###
  ctrl_c: exit
  ctrl_x: run_editor

  alt_&: 
      tab_goto: 1
  alt_é: 
      tab_goto: 2
  alt_": 
      tab_goto: 3
  alt_': 
      tab_goto: 4
  alt_(: 
      tab_goto: 5
  alt_-: 
      tab_goto: 6
  alt_è: 
      tab_goto: 7
  alt__: 
      tab_goto: 8
  alt_ç: 
      tab_goto: 9
  alt_à: 
      tab_goto: 0
  alt_right:  tab_next
  alt_left:   tab_prev

  shift_up:   messages_scroll_up
  shift_down: messages_scroll_down
  #ctrl_u:     input_delete_to_start
  ctrl_d:     exit
  pgup:       messages_page_up
  pgdown:     messages_page_down
  home:       input_move_curs_start
  end:        input_move_curs_end

  left:       input_move_curs_left
  right:      input_move_curs_right
  ctrl_a:     input_move_curs_start
  ctrl_e:     input_move_curs_end
  ctrl_left:  input_move_word_left
  ctrl_right: input_move_word_right
  ctrl_k:     input_delete_to_end
  ctrl_w:     input_delete_prev_word
  backspace:  input_delete_prev_char
  del:        input_delete_next_char
  tab:        input_auto_complete

I use AZERTY keyboard.
All keymaps are not working because of the following error

Can't parse TUI config: Message("invalid value: string \"é\", expected single keys: backspace, del, end, esc, home, pgdown, pgup, tab, up, down, left right, [a-z], [0-9]modifiers with arrow key or single characters:  alt, shift, ctrl", 
Some(Pos { marker: Marker { index: 3023, line: 150, col: 2 }, path: "key_map" }))

eoli3n · 2021-05-25T08:00:44Z

input_delete_to_start function doesn't exist, would you create it please ?
It's default ctrl+u in terminal

edit: WIP on #300

Added 'disabled' action to disable key

eoli3n · 2021-05-26T07:21:10Z

Everything is working well with my AZERTY keyboard and my mapping.
Good work, thanks for this @trevarj !

osa1

Thanks @trevarj !

One concern here is, as far as I can see, we allow keys that we don't support. For example, C-h cannot be supported but we allow ctrl_h. As a user I would absolutely hate it if I would have to manually debug unsupported keys by making changes in my config, /reload, try again...

Maybe we could add a function in term_input to return a list of all supported keys, and then have a validation step after parsing to check that the keys user specified are supported.

We should also have a documentation somewhere (perhaps a GitHub wiki page) for the actions, and what they do.

crates/libtiny_tui/src/config.rs

trevarj · 2021-05-30T20:03:15Z

We should also have a documentation somewhere (perhaps a GitHub wiki page) for the actions, and what they do.

@osa1 Let's enable the wiki and I can write some docs on this and also migrate some stuff from the README over to it for more organization

Maybe we could add a function in term_input to return a list of all supported keys

Pushing a commit to address this

osa1

Thanks @trevarj , this is really great. This is requested so many times, it will be great to finally have it. Left a few inline comments.

crates/libtiny_tui/src/key_map.rs

crates/tiny/config.yml

crates/libtiny_tui/src/key_map.rs

crates/term_input_macros/src/lib.rs

trevarj · 2021-06-21T20:19:51Z

@osa1 thanks for the review. I addressed all the above comments except for the "Disable" key action

Fully removed size_hints
used given #fn_name identifier for macro generated is_valid_key check
moved term_input specific logic to non macro-generated function
removed extra whitespace

crates/libtiny_tui/src/input_area/mod.rs

osa1 · 2021-07-02T05:58:30Z

crates/term_input_macros/src/lib.rs

+        .map(|r| &r.value.0)
+        .collect::<HashSet<_>>()
+        .into_iter();
+    let fn_name = format_ident!("{}_is_valid_key", fn_name);


Didn't know about this macro, nice 👍

osa1 · 2021-07-02T06:09:07Z

I created a Wiki page to list supported key actions and key sequences: https://github.com/osa1/tiny/wiki/Configuring-key-bindings

- Added prev/next entry KeyAction (previously Up and Down arrow) - Added KeyAction::Cancel as a default binding for the Key::Esc - Added KeyAction::Input(char), so individual character keys can be remapped

crates/tiny/config.yml

osa1 · 2021-07-02T09:01:51Z

crates/libtiny_tui/src/messaging.rs

-    pub(crate) fn keypressed(&mut self, key: Key) -> WidgetRet {
-        match key {
-            Key::Ctrl('c') => {
+    pub(crate) fn keypressed(&mut self, key_action: Option<KeyAction>) -> WidgetRet {


This function does not handle None case (returns KeyIgnored), I think if we make the argument KeyAction instead of Option<KeyAction> it becomes clear to the caller that this does not handle when a key is not mapped to an action.

If we do that then we decide what to do when a key is not mapped in the code where we try to map the key to an action. It's much nicer, I don't need to follow the value in the code base to find out where the None case is handled and how.

Could you implement that? Should be a few lines of change in TUI::keypressed.

If no KeyAction is found in the current keymap we check to see if the key is a regular character or alt+char to map it to the respective actions

osa1 · 2021-07-02T12:45:51Z

Thanks @trevarj !

097115 · 2021-07-04T05:02:01Z

@trevarj

Great work, thanks! But we can't map the functional keys (F1...F12...) right now, am I correct?

trevarj · 2021-07-04T06:05:37Z

@097115 right, those keys aren't captured correctly by Tiny and aren't supported yet. I can look into it and see what it would take to add them.

097115 · 2021-07-04T06:08:09Z

@trevarj Would be great, thanks once again!

097115 · 2021-07-04T06:15:35Z

@trevarj

Sorry to disturb you, but a bit of issue: ShiftLeft and ShiftRight keys aren't defined in crates/term_input/src/lib.rs, probably something like this should be added at line 105:

[27, 91, 49, 59, 50, 68] => Key::ShiftLeft
[27, 91, 49, 59, 50, 67] => Key::ShiftRight

trevarj · 2021-07-04T06:32:49Z

@097115 thanks. I will add these

Custom key maps

cbc120a

Actions can now be overridden with custom keys

trevarj mentioned this pull request May 24, 2021

user config keybinds #167

Open

trevarj commented May 24, 2021

View reviewed changes

Fixed key parsing

ec6e8be

Added 'disabled' action to disable key

osa1 reviewed May 30, 2021

View reviewed changes

crates/libtiny_tui/src/config.rs Outdated Show resolved Hide resolved

eoli3n mentioned this pull request May 30, 2021

input_delete_to_start #332

Closed

trevarj force-pushed the custom-keymap branch from c84f7cf to 050d2ae Compare May 31, 2021 06:23

Added function to check if configured key is valid

0c0160d

trevarj force-pushed the custom-keymap branch from 050d2ae to 0c0160d Compare May 31, 2021 06:29

osa1 reviewed Jun 21, 2021

View reviewed changes

PR feedback changes

1a1120d

osa1 reviewed Jul 2, 2021

View reviewed changes

crates/libtiny_tui/src/input_area/mod.rs Outdated Show resolved Hide resolved

osa1 reviewed Jul 2, 2021

View reviewed changes

PR feedback changes

bd60336

- Added prev/next entry KeyAction (previously Up and Down arrow) - Added KeyAction::Cancel as a default binding for the Key::Esc - Added KeyAction::Input(char), so individual character keys can be remapped

osa1 reviewed Jul 2, 2021

View reviewed changes

crates/tiny/config.yml Outdated Show resolved Hide resolved

Added newline to example config.yml

66e862c

osa1 reviewed Jul 2, 2021

View reviewed changes

Changed Option<KeyAction> to KeyAction

66271dd

If no KeyAction is found in the current keymap we check to see if the key is a regular character or alt+char to map it to the respective actions

osa1 merged commit f860b49 into osa1:master Jul 2, 2021

trevarj deleted the custom-keymap branch July 2, 2021 12:53

osa1 added a commit that referenced this pull request Jul 2, 2021

Update CHANGELOG and README for #328

0670fa9

trevarj mentioned this pull request Jul 4, 2021

Function-keys (F1-F12) support #338

Closed

Custom key maps #328

Custom key maps #328

Uh oh!

Conversation

trevarj commented May 24, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

trevarj left a comment

Choose a reason for hiding this comment

Uh oh!

trevarj May 24, 2021

Choose a reason for hiding this comment

Uh oh!

trevarj May 24, 2021

Choose a reason for hiding this comment

Uh oh!

eoli3n commented May 25, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Note to myself

Uh oh!

eoli3n commented May 25, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

eoli3n commented May 26, 2021

Uh oh!

osa1 left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

trevarj commented May 30, 2021

Uh oh!

osa1 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

trevarj commented Jun 21, 2021

Uh oh!

Uh oh!

osa1 Jul 2, 2021

Choose a reason for hiding this comment

Uh oh!

osa1 commented Jul 2, 2021

Uh oh!

Uh oh!

osa1 Jul 2, 2021

Choose a reason for hiding this comment

Uh oh!

trevarj Jul 2, 2021

Choose a reason for hiding this comment

Uh oh!

osa1 commented Jul 2, 2021

Uh oh!

097115 commented Jul 4, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

trevarj commented Jul 4, 2021

Uh oh!

097115 commented Jul 4, 2021

Uh oh!

097115 commented Jul 4, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

trevarj commented Jul 4, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

trevarj commented May 24, 2021 •

edited

Loading

eoli3n commented May 25, 2021 •

edited

Loading

eoli3n commented May 25, 2021 •

edited

Loading

osa1 left a comment •

edited

Loading

097115 commented Jul 4, 2021 •

edited

Loading

097115 commented Jul 4, 2021 •

edited

Loading