bug#71648: 30.0.50; Allow which-key to report on translation bindings

bug#71648: 30.0.50; Allow which-key to report on translation bindings

[Robert Pluim]

`which-key-mode' currently only looks at keymaps, not translation
keymaps such as `key-translation-map' and `function-key-map'. In order
to aid discoverability, perhaps it should do the following

(maybe with a user option)

@@ -1942,8 +1949,10 @@ which-key--get-keymap-bindings
 
 (defun which-key--get-current-bindings (&optional prefix filter)
   "Generate a list of current active bindings."
-  (let (bindings)
-    (dolist (map (current-active-maps t) bindings)
+  (let (bindings
+        (maps (nconc (current-active-maps t)
+                     (list key-translation-map function-key-map))))
+    (dolist (map maps bindings)
       (when (cdr map)
         (setq bindings
               (which-key--get-keymap-bindings

Robert
-- 

bug#71648: 30.0.50; Allow which-key to report on translation bindings

[Eli Zaretskii]

> From: Robert Pluim <rpluim@gmail.com>
> Date: Wed, 19 Jun 2024 14:04:35 +0200
> 
> `which-key-mode' currently only looks at keymaps, not translation
> keymaps such as `key-translation-map' and `function-key-map'. In order
> to aid discoverability, perhaps it should do the following
> 
> (maybe with a user option)
> 
> @@ -1942,8 +1949,10 @@ which-key--get-keymap-bindings
>  
>  (defun which-key--get-current-bindings (&optional prefix filter)
>    "Generate a list of current active bindings."
> -  (let (bindings)
> -    (dolist (map (current-active-maps t) bindings)
> +  (let (bindings
> +        (maps (nconc (current-active-maps t)
> +                     (list key-translation-map function-key-map))))
> +    (dolist (map maps bindings)
>        (when (cdr map)
>          (setq bindings
>                (which-key--get-keymap-bindings
> 

Let's have the relevant people on-board of this discussion.

bug#71648: 30.0.50; Allow which-key to report on translation bindings

[Justin Burkett]

The purpose of which-key was to show the commands that are available
following an incomplete key sequence. If I understand correctly, these
maps don't hold commands and anyway would be processed before
which-key "sees" the current incomplete key sequence.

If I understand correctly, if "C-d x" translates to "C-c x" then
which-key I believe would see the sequence "C-c x" and find the
bindings following that sequence. I'm not sure how or why we would
want to display the information that "C-d x" translates to "C-c x".

Justin

On Wed, Jun 19, 2024 at 9:12 AM Eli Zaretskii <eliz@gnu.org> wrote:
>
> > From: Robert Pluim <rpluim@gmail.com>
> > Date: Wed, 19 Jun 2024 14:04:35 +0200
> >
> > `which-key-mode' currently only looks at keymaps, not translation
> > keymaps such as `key-translation-map' and `function-key-map'. In order
> > to aid discoverability, perhaps it should do the following
> >
> > (maybe with a user option)
> >
> > @@ -1942,8 +1949,10 @@ which-key--get-keymap-bindings
> >
> >  (defun which-key--get-current-bindings (&optional prefix filter)
> >    "Generate a list of current active bindings."
> > -  (let (bindings)
> > -    (dolist (map (current-active-maps t) bindings)
> > +  (let (bindings
> > +        (maps (nconc (current-active-maps t)
> > +                     (list key-translation-map function-key-map))))
> > +    (dolist (map maps bindings)
> >        (when (cdr map)
> >          (setq bindings
> >                (which-key--get-keymap-bindings
> >
>
> Let's have the relevant people on-board of this discussion.

bug#71648: 30.0.50; Allow which-key to report on translation bindings

[Robert Pluim]

>>>>> On Wed, 19 Jun 2024 11:09:36 -0400, Justin Burkett <justin@burkett.cc> said:

    Justin> The purpose of which-key was to show the commands that are available
    Justin> following an incomplete key sequence. If I understand correctly, these
    Justin> maps don't hold commands and anyway would be processed before
    Justin> which-key "sees" the current incomplete key sequence.

They donʼt hold commands in the sense of defuns, but instead they
produce characters, which to Emacs is pretty much the same thing, and
looking up keys in them inside which-keys produces the same type of
display.

    Justin> If I understand correctly, if "C-d x" translates to "C-c x" then
    Justin> which-key I believe would see the sequence "C-c x" and find the
    Justin> bindings following that sequence. I'm not sure how or why we would
    Justin> want to display the information that "C-d x" translates to "C-c x".

These maps donʼt translate sequences to sequences, they translate
sequences to characters:

'C-x 8 * E' -> €
'C-x 8 * L' -> £
etc

so with my patch, typing 'C-x 8 *' show the entries for 'E' and 'L'
(and more besides)

Robert
-- 

bug#71648: 30.0.50; Allow which-key to report on translation bindings

[Eli Zaretskii]

> From: Justin Burkett <justin@burkett.cc>
> Date: Wed, 19 Jun 2024 11:09:36 -0400
> Cc: Robert Pluim <rpluim@gmail.com>, Jeremy Bryant <jb@jeremybryant.net>, 71648@debbugs.gnu.org
> 
> The purpose of which-key was to show the commands that are available
> following an incomplete key sequence. If I understand correctly, these
> maps don't hold commands and anyway would be processed before
> which-key "sees" the current incomplete key sequence.

Everything in Emacs is a command.  The specific sequences Robert was
talking about eventually insert characters, but they are still a
sequence of key events.  So I'm not sure I understand how you
distinguish between them and what fundamental differences do you see.
Would you like to elaborate on how and why do you perceive these to be
different?

> If I understand correctly, if "C-d x" translates to "C-c x" then
> which-key I believe would see the sequence "C-c x" and find the
> bindings following that sequence. I'm not sure how or why we would
> want to display the information that "C-d x" translates to "C-c x".

I don't think this case is the most important or the most interesting.

bug#71648: 30.0.50; Allow which-key to report on translation bindings

[Justin Burkett]

On Wed, Jun 19, 2024 at 11:16 AM Robert Pluim <rpluim@gmail.com> wrote:
>
> >>>>> On Wed, 19 Jun 2024 11:09:36 -0400, Justin Burkett <justin@burkett.cc> said:
>
>     Justin> The purpose of which-key was to show the commands that are available
>     Justin> following an incomplete key sequence. If I understand correctly, these
>     Justin> maps don't hold commands and anyway would be processed before
>     Justin> which-key "sees" the current incomplete key sequence.
>
> They donʼt hold commands in the sense of defuns, but instead they
> produce characters, which to Emacs is pretty much the same thing, and
> looking up keys in them inside which-keys produces the same type of
> display.
>
>     Justin> If I understand correctly, if "C-d x" translates to "C-c x" then
>     Justin> which-key I believe would see the sequence "C-c x" and find the
>     Justin> bindings following that sequence. I'm not sure how or why we would
>     Justin> want to display the information that "C-d x" translates to "C-c x".
>
> These maps donʼt translate sequences to sequences, they translate
> sequences to characters:
>
> 'C-x 8 * E' -> €
> 'C-x 8 * L' -> £
> etc
>
> so with my patch, typing 'C-x 8 *' show the entries for 'E' and 'L'
> (and more besides)

Ah, so I didn't understand how these are used. Those are good
additions to which-key.

>
> Robert
> --

bug#71648: 30.0.50; Allow which-key to report on translation bindings

[Justin Burkett]

On Wed, Jun 19, 2024 at 11:34 AM Eli Zaretskii <eliz@gnu.org> wrote:
>
> > From: Justin Burkett <justin@burkett.cc>
> > Date: Wed, 19 Jun 2024 11:09:36 -0400
> > Cc: Robert Pluim <rpluim@gmail.com>, Jeremy Bryant <jb@jeremybryant.net>, 71648@debbugs.gnu.org
> >
> > The purpose of which-key was to show the commands that are available
> > following an incomplete key sequence. If I understand correctly, these
> > maps don't hold commands and anyway would be processed before
> > which-key "sees" the current incomplete key sequence.
>
> Everything in Emacs is a command.  The specific sequences Robert was
> talking about eventually insert characters, but they are still a
> sequence of key events.  So I'm not sure I understand how you
> distinguish between them and what fundamental differences do you see.
> Would you like to elaborate on how and why do you perceive these to be
> different?
>
> > If I understand correctly, if "C-d x" translates to "C-c x" then
> > which-key I believe would see the sequence "C-c x" and find the
> > bindings following that sequence. I'm not sure how or why we would
> > want to display the information that "C-d x" translates to "C-c x".
>
> I don't think this case is the most important or the most interesting.

The purpose of the example was to show my (mis)understanding of how
these maps work. I was under the impression from the info manual that
translation keymaps map key sequences to other key sequences which are
then mapped to "commands" (which might be just text to insert).
Quoting the info manual:

"When the ‘read-key-sequence’ function reads a key sequence (*note Key
Sequence Input::), it uses “translation keymaps” to translate certain
event sequences into others.  The translation keymaps are
‘input-decode-map’, ‘local-function-key-map’, and ‘key-translation-map’
(in order of priority).

   Translation keymaps have the same structure as other keymaps, but are
used differently: they specify translations to make while reading key
sequences, rather than bindings for complete key sequences.  As each key
sequence is read, it is checked against each translation keymap.  If one
of the translation keymaps binds K to a vector V, then whenever K
appears as a sub-sequence _anywhere_ in a key sequence, that
sub-sequence is replaced with the events in V."

This reads to me like translation keymaps don't yield "commands" they
act at an intermediate level.

In any event, Robert's example was helpful, and I think that
information would be useful to include in which-key.

bug#71648: 30.0.50; Allow which-key to report on translation bindings

[Jeremy Bryant via Bug reports for GNU Emacs, the Swiss army knife of text editors]

Robert Pluim <rpluim@gmail.com> writes:

>>>>>> On Wed, 19 Jun 2024 11:09:36 -0400, Justin Burkett <justin@burkett.cc> said:
>
>     Justin> The purpose of which-key was to show the commands that are available
>     Justin> following an incomplete key sequence. If I understand correctly, these
>     Justin> maps don't hold commands and anyway would be processed before
>     Justin> which-key "sees" the current incomplete key sequence.
>
> They donʼt hold commands in the sense of defuns, but instead they
> produce characters, which to Emacs is pretty much the same thing, and
> looking up keys in them inside which-keys produces the same type of
> display.
>
>     Justin> If I understand correctly, if "C-d x" translates to "C-c x" then
>     Justin> which-key I believe would see the sequence "C-c x" and find the
>     Justin> bindings following that sequence. I'm not sure how or why we would
>     Justin> want to display the information that "C-d x" translates to "C-c x".
>
> These maps donʼt translate sequences to sequences, they translate
> sequences to characters:
>
> 'C-x 8 * E' -> €
> 'C-x 8 * L' -> £
> etc
>
> so with my patch, typing 'C-x 8 *' show the entries for 'E' and 'L'
> (and more besides)
>
> Robert

This is a useful patch and would enhance which-key 

bug#71648: 30.0.50; Allow which-key to report on translation bindings

[Robert Pluim]

>>>>> On Wed, 19 Jun 2024 11:48:01 -0400, Justin Burkett <justin@burkett.cc> said:

    Justin> In any event, Robert's example was helpful, and I think that
    Justin> information would be useful to include in which-key.

By default, or with a custom option? If the latter, it could be a list
of 'extra' keymaps for `which-key' to consult.

Robert
-- 

bug#71648: 30.0.50; Allow which-key to report on translation bindings

[Justin Burkett]

On Thu, Jun 20, 2024 at 4:27 AM Robert Pluim <rpluim@gmail.com> wrote:
>
> >>>>> On Wed, 19 Jun 2024 11:48:01 -0400, Justin Burkett <justin@burkett.cc> said:
>
>     Justin> In any event, Robert's example was helpful, and I think that
>     Justin> information would be useful to include in which-key.
>
> By default, or with a custom option? If the latter, it could be a list
> of 'extra' keymaps for `which-key' to consult.

I can see an argument for either. My only concern with the option
would be explaining what the option does in plain language.

>
> Robert
> --

bug#71648: 30.0.50; Allow which-key to report on translation bindings

[Robert Pluim]

>>>>> On Thu, 20 Jun 2024 10:20:36 -0400, Justin Burkett <justin@burkett.cc> said:

    Justin> On Thu, Jun 20, 2024 at 4:27 AM Robert Pluim <rpluim@gmail.com> wrote:
    >> 
    >> >>>>> On Wed, 19 Jun 2024 11:48:01 -0400, Justin Burkett <justin@burkett.cc> said:
    >> 
    Justin> In any event, Robert's example was helpful, and I think that
    Justin> information would be useful to include in which-key.
    >> 
    >> By default, or with a custom option? If the latter, it could be a list
    >> of 'extra' keymaps for `which-key' to consult.

    Justin> I can see an argument for either. My only concern with the option
    Justin> would be explaining what the option does in plain language.

Wordsmithing is easy ;-)

(defcustom which-key-extra-keymaps nil
  "List of extra keymaps to show bindings from.
This allows you to add personal keymaps for `which-key' to check.  A
preset value is available to enable looking in `key-translation-map',
which contains the \\='C-x 8' bindings for entering common characters."
  :type '(choice (list :tag "Translation map" (const key-translation-map))
                 (repeat :tag "Custom" symbol))
  :version "30.1")

Robert
-- 

bug#71648: 30.0.50; Allow which-key to report on translation bindings

[Justin Burkett]

On Thu, Jun 20, 2024 at 10:56 AM Robert Pluim <rpluim@gmail.com> wrote:
>
> >>>>> On Thu, 20 Jun 2024 10:20:36 -0400, Justin Burkett <justin@burkett.cc> said:
>
>     Justin> On Thu, Jun 20, 2024 at 4:27 AM Robert Pluim <rpluim@gmail.com> wrote:
>     >>
>     >> >>>>> On Wed, 19 Jun 2024 11:48:01 -0400, Justin Burkett <justin@burkett.cc> said:
>     >>
>     Justin> In any event, Robert's example was helpful, and I think that
>     Justin> information would be useful to include in which-key.
>     >>
>     >> By default, or with a custom option? If the latter, it could be a list
>     >> of 'extra' keymaps for `which-key' to consult.
>
>     Justin> I can see an argument for either. My only concern with the option
>     Justin> would be explaining what the option does in plain language.
>
> Wordsmithing is easy ;-)
>
> (defcustom which-key-extra-keymaps nil
>   "List of extra keymaps to show bindings from.
> This allows you to add personal keymaps for `which-key' to check.  A
> preset value is available to enable looking in `key-translation-map',
> which contains the \\='C-x 8' bindings for entering common characters."
>   :type '(choice (list :tag "Translation map" (const key-translation-map))
>                  (repeat :tag "Custom" symbol))
>   :version "30.1")
>

That seems reasonable enough. How about doing both? Add the option and
use key-translation-map for the default value.

> Robert
> --

bug#71648: 30.0.50; Allow which-key to report on translation bindings

[Robert Pluim]

[-- Attachment #1: Type: text/plain, Size: 444 bytes --]

>>>>> On Thu, 20 Jun 2024 11:40:57 -0400, Justin Burkett <justin@burkett.cc> said:

    Justin> That seems reasonable enough. How about doing both? Add the option and
    Justin> use key-translation-map for the default value.

Patch against emacs-30 attached. Since which-key is new in emacs-30,
Iʼm assuming a NEWS entry is not required for this specific change.

Eli, let me know if it should go to master instead.

Robert
-- 


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-Show-entries-from-key-translation-map-in-which-key-m.patch --]
[-- Type: text/x-diff, Size: 1889 bytes --]

From d6dd58a0c75affb9ff18b4974ca5f4cd56eb2604 Mon Sep 17 00:00:00 2001
From: Robert Pluim <rpluim@gmail.com>
Date: Mon, 24 Jun 2024 15:09:00 +0200
Subject: [PATCH] Show entries from key-translation-map in which-key mode
To: emacs-devel@gnu.org

* lisp/which-key.el (which-key-extra-keymaps): New user option.
(which-key--get-current-bindings): Consult it.

(Bug#71648)
---
 lisp/which-key.el | 15 +++++++++++++--
 1 file changed, 13 insertions(+), 2 deletions(-)

diff --git a/lisp/which-key.el b/lisp/which-key.el
index 91007ce4ada..a5075b3ba69 100644
--- a/lisp/which-key.el
+++ b/lisp/which-key.el
@@ -233,6 +233,15 @@ which-key-show-docstrings
           (const :tag "Replace command name with docstring" docstring-only))
   :package-version "1.0" :version "30.1")
 
+(defcustom which-key-extra-keymaps '(key-translation-map)
+  "List of extra keymaps to show entries from.
+The default is to check `key-translation-map', which contains the
+\\='C-x 8' bindings for entering common characters."
+  :type '(choice (list :tag "Translation map" (const key-translation-map))
+                 (const :tag "None" nil)
+                 (repeat :tag "Custom" symbol))
+  :package-version "1.0" :version "30.1")
+
 (defcustom which-key-highlighted-command-list '()
   "Rules used to highlight certain commands.
 If the element is a string, assume it is a regexp pattern for
@@ -1942,8 +1951,10 @@ which-key--get-keymap-bindings
 
 (defun which-key--get-current-bindings (&optional prefix filter)
   "Generate a list of current active bindings."
-  (let (bindings)
-    (dolist (map (current-active-maps t) bindings)
+  (let (bindings
+        (maps (nconc (current-active-maps t)
+                     (mapcar #'symbol-value which-key-extra-keymaps))))
+    (dolist (map maps bindings)
       (when (cdr map)
         (setq bindings
               (which-key--get-keymap-bindings
-- 
2.39.2

bug#71648: 30.0.50; Allow which-key to report on translation bindings

[Eli Zaretskii]

> From: Robert Pluim <rpluim@gmail.com>
> Cc: 71648@debbugs.gnu.org,  Eli Zaretskii <eliz@gnu.org>,  jb@jeremybryant.net
> Date: Mon, 24 Jun 2024 15:14:34 +0200
> 
> Patch against emacs-30 attached. Since which-key is new in emacs-30,
> Iʼm assuming a NEWS entry is not required for this specific change.
> 
> Eli, let me know if it should go to master instead.

This is okay for emacs-30, thanks.

bug#71648: 30.0.50; Allow which-key to report on translation bindings

[Robert Pluim]

tags 71648 fixed
close 71648 30.1
quit

>>>>> On Mon, 24 Jun 2024 16:30:30 +0300, Eli Zaretskii <eliz@gnu.org> said:

    >> From: Robert Pluim <rpluim@gmail.com>
    >> Cc: 71648@debbugs.gnu.org,  Eli Zaretskii <eliz@gnu.org>,  jb@jeremybryant.net
    >> Date: Mon, 24 Jun 2024 15:14:34 +0200
    >> 
    >> Patch against emacs-30 attached. Since which-key is new in emacs-30,
    >> Iʼm assuming a NEWS entry is not required for this specific change.
    >> 
    >> Eli, let me know if it should go to master instead.

    Eli> This is okay for emacs-30, thanks.

Thanks,

Closing.
Committed as 7e8a97ac788

Robert
--