bug#55393: describe-keymap: suggest symbol at point

bug#55393: describe-keymap: suggest symbol at point

[Visuwesh]

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

Tags: patch

describe-keymap differs from other describe-* commands in that it does
not suggest the symbol at point which always annoyed me.  This patch
makes describe-keymap consider the symbol at point first.

[ I hope it is okay to use if-let family of macros in these files now?  ]


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-describe-keymap-Suggest-symbol-at-point.patch --]
[-- Type: text/patch, Size: 2351 bytes --]

From 84dbe9924269c2c5e2fb73aadc82536e48e81820 Mon Sep 17 00:00:00 2001
From: Visuwesh <visuweshm@gmail.com>
Date: Fri, 13 May 2022 09:20:18 +0530
Subject: [PATCH] describe-keymap: Suggest symbol at point

* lisp/help-fns.el (help-fns--most-relevant-active-keymap): Suggest
the symbol at point if it is a keymap.
* etc/NEWS: Announce the change.
---
 etc/NEWS         |  5 +++++
 lisp/help-fns.el | 17 +++++++++++------
 2 files changed, 16 insertions(+), 6 deletions(-)

diff --git a/etc/NEWS b/etc/NEWS
index 273fa77640..251ebc46ce 100644
--- a/etc/NEWS
+++ b/etc/NEWS
@@ -363,6 +363,11 @@ These will take you (respectively) to the next and previous "page".
 This will take you to the Emacs Lisp manual entry for the item
 displayed, if any.
 
+---
+*** 'describe-keymap' now considers the symbol at point.
+'describe-keymap' suggests the symbol at point as the default
+candidate if it is a keymap.
+
 ** Outline Mode
 
 *** Support for customizing the default visibility state of headings.
diff --git a/lisp/help-fns.el b/lisp/help-fns.el
index 80d7d5cb02..3836cc7367 100644
--- a/lisp/help-fns.el
+++ b/lisp/help-fns.el
@@ -1779,16 +1779,21 @@ help-fns--most-relevant-active-keymap
 The heuristic to determine which keymap is most likely to be
 relevant to a user follows this order:
 
-1. 'keymap' text property at point
-2. 'local-map' text property at point
-3. the `current-local-map'
+1. symbol at point
+2. 'keymap' text property at point
+3. 'local-map' text property at point
+4. the `current-local-map'
 
 This is used to set the default value for the interactive prompt
 in `describe-keymap'.  See also `Searching the Active Keymaps'."
-  (help-fns-find-keymap-name (or (get-char-property (point) 'keymap)
-                         (if (get-text-property (point) 'local-map)
+  (if-let ((sym (symbol-at-point))
+           (sym (when sym (intern-soft sym)))
+           (keymapp (ignore-errors (symbol-value sym))))
+      sym
+    (help-fns-find-keymap-name (or (get-char-property (point) 'keymap)
+                           (if (get-text-property (point) 'local-map)
                              (get-char-property (point) 'local-map)
-                           (current-local-map)))))
+                           (current-local-map))))))
 
 (defvar keymap-name-history nil
   "History for input to `describe-keymap'.")
-- 
2.33.1


[-- Attachment #3: Type: text/plain, Size: 533 bytes --]



In GNU Emacs 29.0.50 (build 1, x86_64-pc-linux-gnu, X toolkit, cairo version 1.16.0, Xaw scroll bars)
Repository revision: ca3858563c7ba8ee3caa82fbd2b7c386ea60c0d3
Repository branch: master
Windowing system distributor 'The X.Org Foundation', version 11.0.12013000
System Description: NixOS 21.11 (Porcupine)

Configured using:
 'configure
 --prefix=/nix/store/iqqk7iqfwmfc6r78xg2knyq7hww2mhs4-emacs-git-20220225.0
 --disable-build-details --with-modules --with-x-toolkit=lucid
 --with-xft --with-cairo --with-native-compilation'

bug#55393: describe-keymap: suggest symbol at point

[Visuwesh]

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

[வெள்ளி மே 13, 2022] Visuwesh wrote:

> Tags: patch
>
> describe-keymap differs from other describe-* commands in that it does
> not suggest the symbol at point which always annoyed me.  This patch
> makes describe-keymap consider the symbol at point first.
>
> [ I hope it is okay to use if-let family of macros in these files now?  ]
>
>
>
>
> In GNU Emacs 29.0.50 (build 1, x86_64-pc-linux-gnu, X toolkit, cairo version 1.16.0, Xaw scroll bars)
> Repository revision: ca3858563c7ba8ee3caa82fbd2b7c386ea60c0d3
> Repository branch: master
> Windowing system distributor 'The X.Org Foundation', version 11.0.12013000
> System Description: NixOS 21.11 (Porcupine)
>
> Configured using:
>  'configure
>  --prefix=/nix/store/iqqk7iqfwmfc6r78xg2knyq7hww2mhs4-emacs-git-20220225.0
>  --disable-build-details --with-modules --with-x-toolkit=lucid
>  --with-xft --with-cairo --with-native-compilation'

Turns out I did not git pull master properly so that patch was against
an old master.  Updated patch attached here,


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-describe-keyap-Suggest-symbol-at-point.patch --]
[-- Type: text/x-patch, Size: 2324 bytes --]

From 1911ea3d4963bc945953886fb625db6c838f19cb Mon Sep 17 00:00:00 2001
From: Visuwesh <visuweshm@gmail.com>
Date: Fri, 13 May 2022 10:52:09 +0530
Subject: [PATCH] describe-keyap: Suggest symbol at point

* lisp/help-fns.el (help-fns--most-relevant-active-keymap): Suggest
the symbol at point if it is a keymap.
* etc/NEWS: Announce the change.
---
 etc/NEWS         |  5 +++++
 lisp/help-fns.el | 19 ++++++++++++-------
 2 files changed, 17 insertions(+), 7 deletions(-)

diff --git a/etc/NEWS b/etc/NEWS
index e09834c..54647b8 100644
--- a/etc/NEWS
+++ b/etc/NEWS
@@ -562,6 +562,11 @@ minor modes are listed after the major mode.
 The apropos commands will now select the apropos window if
 'help-window-select' is non-nil.
 
+---
+*** 'describe-keymap' now considers the symbol at point
+'describe-keymap' suggests the symbol at point as the default candidate
+if it is a keymap.
+
 ** Outline Mode
 
 +++
diff --git a/lisp/help-fns.el b/lisp/help-fns.el
index 927a4f0..2636ba9 100644
--- a/lisp/help-fns.el
+++ b/lisp/help-fns.el
@@ -1884,16 +1884,21 @@ variable with value KEYMAP."
 The heuristic to determine which keymap is most likely to be
 relevant to a user follows this order:
 
-1. 'keymap' text property at point
-2. 'local-map' text property at point
-3. the `current-local-map'
+1. symbol at point
+2. 'keymap' text property at point
+3. 'local-map' text property at point
+4. the `current-local-map'
 
 This is used to set the default value for the interactive prompt
 in `describe-keymap'.  See also `Searching the Active Keymaps'."
-  (help-fns-find-keymap-name (or (get-char-property (point) 'keymap)
-                         (if (get-text-property (point) 'local-map)
-                             (get-char-property (point) 'local-map)
-                           (current-local-map)))))
+  (if-let ((sym (symbol-at-point))
+           (sym (when sym (intern-soft sym)))
+           (keymapp (ignore-errors (symbol-value sym))))
+      sym
+    (help-fns-find-keymap-name (or (get-char-property (point) 'keymap)
+                           (if (get-text-property (point) 'local-map)
+                               (get-char-property (point) 'local-map)
+                             (current-local-map))))))
 
 (defvar keymap-name-history nil
   "History for input to `describe-keymap'.")
-- 
2.33.1

bug#55393: describe-keymap: suggest symbol at point

[Eli Zaretskii]

> From: Visuwesh <visuweshm@gmail.com>
> Date: Fri, 13 May 2022 09:35:25 +0530
> 
> describe-keymap differs from other describe-* commands in that it does
> not suggest the symbol at point which always annoyed me.  This patch
> makes describe-keymap consider the symbol at point first.
> 
> [ I hope it is okay to use if-let family of macros in these files now?  ]

Yes, but I think a cleaner solution would be to do this kind of stuff
in the 'interactive' form of describe-keymap, instead of this
subroutine.  The DWIM-ish operation of describe-SOMETHING commands is
better done there, because it doesn't really belong to non-interactive
invocations.

Thanks.

bug#55393: describe-keymap: suggest symbol at point

[Visuwesh]

[வெள்ளி மே 13, 2022] Eli Zaretskii wrote:

>> From: Visuwesh <visuweshm@gmail.com>
>> Date: Fri, 13 May 2022 09:35:25 +0530
>> 
>> describe-keymap differs from other describe-* commands in that it does
>> not suggest the symbol at point which always annoyed me.  This patch
>> makes describe-keymap consider the symbol at point first.
>> 
>> [ I hope it is okay to use if-let family of macros in these files now?  ]
>
> Yes, but I think a cleaner solution would be to do this kind of stuff
> in the 'interactive' form of describe-keymap, instead of this
> subroutine.  The DWIM-ish operation of describe-SOMETHING commands is
> better done there, because it doesn't really belong to non-interactive
> invocations.
>
> Thanks.

The 'interactive' form of describe-keymap uses this function.  I don't
see this function being used anywhere else either.

bug#55393: describe-keymap: suggest symbol at point

[Eli Zaretskii]

> From: Visuwesh <visuweshm@gmail.com>
> Cc: 55393@debbugs.gnu.org
> Date: Fri, 13 May 2022 12:05:42 +0530
> 
> > Yes, but I think a cleaner solution would be to do this kind of stuff
> > in the 'interactive' form of describe-keymap, instead of this
> > subroutine.  The DWIM-ish operation of describe-SOMETHING commands is
> > better done there, because it doesn't really belong to non-interactive
> > invocations.
> >
> > Thanks.
> 
> The 'interactive' form of describe-keymap uses this function.  I don't
> see this function being used anywhere else either.

Nothing prevents future reuse of the subroutine in another place.  I
would prefer to have this code directly in the interactive form, to be
more future-proof.  And note that the if-let form's result is not used
in any way in the rest of the code of that function, which also speaks
volumes of its being an independent issue.

bug#55393: describe-keymap: suggest symbol at point

[Visuwesh]

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

[வெள்ளி மே 13, 2022] Eli Zaretskii wrote:

>> From: Visuwesh <visuweshm@gmail.com>
>> Cc: 55393@debbugs.gnu.org
>> Date: Fri, 13 May 2022 12:05:42 +0530
>> 
>> > Yes, but I think a cleaner solution would be to do this kind of stuff
>> > in the 'interactive' form of describe-keymap, instead of this
>> > subroutine.  The DWIM-ish operation of describe-SOMETHING commands is
>> > better done there, because it doesn't really belong to non-interactive
>> > invocations.
>> >
>> > Thanks.
>> 
>> The 'interactive' form of describe-keymap uses this function.  I don't
>> see this function being used anywhere else either.
>
> Nothing prevents future reuse of the subroutine in another place.  I
> would prefer to have this code directly in the interactive form, to be
> more future-proof.  And note that the if-let form's result is not used
> in any way in the rest of the code of that function, which also speaks
> volumes of its being an independent issue.

Now done, please check.


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-describe-keymap-Suggest-symbol-at-point.patch --]
[-- Type: text/x-patch, Size: 1537 bytes --]

From 596a0f21791cf9d1ffc87e9e142ff81f853c0513 Mon Sep 17 00:00:00 2001
From: Visuwesh <visuweshm@gmail.com>
Date: Fri, 13 May 2022 13:09:55 +0530
Subject: [PATCH] describe-keymap: Suggest symbol at point

* lisp/help-fns.el (describe-keymap): Suggest symbol at point if it is
a keymap.
* etc/NEWS: Announce the change.
---
 etc/NEWS         | 5 +++++
 lisp/help-fns.el | 5 ++++-
 2 files changed, 9 insertions(+), 1 deletion(-)

diff --git a/etc/NEWS b/etc/NEWS
index e09834c..1cbc9cd 100644
--- a/etc/NEWS
+++ b/etc/NEWS
@@ -562,6 +562,11 @@ minor modes are listed after the major mode.
 The apropos commands will now select the apropos window if
 'help-window-select' is non-nil.
 
+---
+*** 'describe-keymap' now considers the symbol at point.
+'describe-keymap' suggests the symbol at point as the default
+candidate if it is a keymap.
+
 ** Outline Mode
 
 +++
diff --git a/lisp/help-fns.el b/lisp/help-fns.el
index 927a4f0..807498f 100644
--- a/lisp/help-fns.el
+++ b/lisp/help-fns.el
@@ -1904,7 +1904,10 @@ in `describe-keymap'.  See also `Searching the Active Keymaps'."
 When called interactively, prompt for a variable that has a
 keymap value."
   (interactive
-   (let* ((km (help-fns--most-relevant-active-keymap))
+   (let* ((sym (symbol-at-point))
+          (km (or (and (keymapp (ignore-errors (symbol-value sym)))
+                       sym)
+                  (help-fns--most-relevant-active-keymap)))
           (val (completing-read
                 (format-prompt "Keymap" km)
                 obarray
-- 
2.33.1

bug#55393: describe-keymap: suggest symbol at point

[Eli Zaretskii]

> From: Visuwesh <visuweshm@gmail.com>
> Cc: 55393@debbugs.gnu.org
> Date: Fri, 13 May 2022 13:12:26 +0530
> 
> >> The 'interactive' form of describe-keymap uses this function.  I don't
> >> see this function being used anywhere else either.
> >
> > Nothing prevents future reuse of the subroutine in another place.  I
> > would prefer to have this code directly in the interactive form, to be
> > more future-proof.  And note that the if-let form's result is not used
> > in any way in the rest of the code of that function, which also speaks
> > volumes of its being an independent issue.
> 
> Now done, please check.

LGTM, thanks.

A minor nit:

> --- a/etc/NEWS
> +++ b/etc/NEWS
> @@ -562,6 +562,11 @@ minor modes are listed after the major mode.
>  The apropos commands will now select the apropos window if
>  'help-window-select' is non-nil.
>  
> +---
> +*** 'describe-keymap' now considers the symbol at point.
> +'describe-keymap' suggests the symbol at point as the default
> +candidate if it is a keymap.

That "it" is ambiguous, since it could allude to more than one entity
mentioned before it.  I suggest to change the order, so that "if it is
a keymap" directly follows "symbol at point".

Let's wait for a day or two to let others time to comment on this.

bug#55393: describe-keymap: suggest symbol at point

[Visuwesh]

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

[வெள்ளி மே 13, 2022] Eli Zaretskii wrote:

>> From: Visuwesh <visuweshm@gmail.com>
>> Cc: 55393@debbugs.gnu.org
>> Date: Fri, 13 May 2022 13:12:26 +0530
>> 
>> >> The 'interactive' form of describe-keymap uses this function.  I don't
>> >> see this function being used anywhere else either.
>> >
>> > Nothing prevents future reuse of the subroutine in another place.  I
>> > would prefer to have this code directly in the interactive form, to be
>> > more future-proof.  And note that the if-let form's result is not used
>> > in any way in the rest of the code of that function, which also speaks
>> > volumes of its being an independent issue.
>> 
>> Now done, please check.
>
> LGTM, thanks.
>
> A minor nit:
>
>> --- a/etc/NEWS
>> +++ b/etc/NEWS
>> @@ -562,6 +562,11 @@ minor modes are listed after the major mode.
>>  The apropos commands will now select the apropos window if
>>  'help-window-select' is non-nil.
>>  
>> +---
>> +*** 'describe-keymap' now considers the symbol at point.
>> +'describe-keymap' suggests the symbol at point as the default
>> +candidate if it is a keymap.
>
> That "it" is ambiguous, since it could allude to more than one entity
> mentioned before it.  I suggest to change the order, so that "if it is
> a keymap" directly follows "symbol at point".
>

I changed the text to,

    *** 'describe-keymap' now considers the symbol at point.
    If the symbol at point is a keymap, 'describe-keymap' suggests it as
    the default candidate.

Updated patch below,


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-describe-keymap-Suggest-symbol-at-point.patch --]
[-- Type: text/x-patch, Size: 1538 bytes --]

From 891efcc198e7cd308e8ee34fefee121439c46dff Mon Sep 17 00:00:00 2001
From: Visuwesh <visuweshm@gmail.com>
Date: Fri, 13 May 2022 13:09:55 +0530
Subject: [PATCH] describe-keymap: Suggest symbol at point

* lisp/help-fns.el (describe-keymap): Suggest symbol at point if it is
a keymap.
* etc/NEWS: Announce the change.
---
 etc/NEWS         | 5 +++++
 lisp/help-fns.el | 5 ++++-
 2 files changed, 9 insertions(+), 1 deletion(-)

diff --git a/etc/NEWS b/etc/NEWS
index e09834c..d50a852 100644
--- a/etc/NEWS
+++ b/etc/NEWS
@@ -562,6 +562,11 @@ minor modes are listed after the major mode.
 The apropos commands will now select the apropos window if
 'help-window-select' is non-nil.
 
+---
+*** 'describe-keymap' now considers the symbol at point.
+If the symbol at point is a keymap, 'describe-keymap' suggests it as
+the default candidate.
+
 ** Outline Mode
 
 +++
diff --git a/lisp/help-fns.el b/lisp/help-fns.el
index 927a4f0..807498f 100644
--- a/lisp/help-fns.el
+++ b/lisp/help-fns.el
@@ -1904,7 +1904,10 @@ in `describe-keymap'.  See also `Searching the Active Keymaps'."
 When called interactively, prompt for a variable that has a
 keymap value."
   (interactive
-   (let* ((km (help-fns--most-relevant-active-keymap))
+   (let* ((sym (symbol-at-point))
+          (km (or (and (keymapp (ignore-errors (symbol-value sym)))
+                       sym)
+                  (help-fns--most-relevant-active-keymap)))
           (val (completing-read
                 (format-prompt "Keymap" km)
                 obarray
-- 
2.33.1


[-- Attachment #3: Type: text/plain, Size: 77 bytes --]


> Let's wait for a day or two to let others time to comment on this.

Sure!

bug#55393: describe-keymap: suggest symbol at point

[Eli Zaretskii]

> From: Visuwesh <visuweshm@gmail.com>
> Cc: 55393@debbugs.gnu.org
> Date: Fri, 13 May 2022 18:17:11 +0530
> 
> I changed the text to,
> 
>     *** 'describe-keymap' now considers the symbol at point.
>     If the symbol at point is a keymap, 'describe-keymap' suggests it as
>     the default candidate.

Perfect, thanks.

> > Let's wait for a day or two to let others time to comment on this.
> 
> Sure!

No further comments, so I've now installed this on the master branch.

One nit for the future: please always mention the bug number, when
it's known, in the commit log message.  (I added it for you this
time.)

And with that, I'm closing the bug.  Thanks  for working on this.

bug#55393: describe-keymap: suggest symbol at point

[Visuwesh]

[ஞாயிறு மே 15, 2022] Eli Zaretskii wrote:

>> From: Visuwesh <visuweshm@gmail.com>
>> Cc: 55393@debbugs.gnu.org
>> Date: Fri, 13 May 2022 18:17:11 +0530
>> 
>> I changed the text to,
>> 
>>     *** 'describe-keymap' now considers the symbol at point.
>>     If the symbol at point is a keymap, 'describe-keymap' suggests it as
>>     the default candidate.
>
> Perfect, thanks.
>
>> > Let's wait for a day or two to let others time to comment on this.
>> 
>> Sure!
>
> No further comments, so I've now installed this on the master branch.
>
> One nit for the future: please always mention the bug number, when
> it's known, in the commit log message.  (I added it for you this
> time.)
>

Sorry, I keep forgetting about this.  I will make sure to remember 
next time.
[ BTW, there's no way to know what the bug number will be when I first
  do M-x submit-emacs-patch, is there?  ]

> And with that, I'm closing the bug.  Thanks  for working on this.

bug#55393: describe-keymap: suggest symbol at point

[Eli Zaretskii]

> From: Visuwesh <visuweshm@gmail.com>
> Cc: eliz@gnu.org
> Date: Sun, 15 May 2022 11:18:08 +0530
> 
> [ஞாயிறு மே 15, 2022] Eli Zaretskii wrote:
> 
> > One nit for the future: please always mention the bug number, when
> > it's known, in the commit log message.  (I added it for you this
> > time.)
> >
> 
> Sorry, I keep forgetting about this.  I will make sure to remember 
> next time.
> [ BTW, there's no way to know what the bug number will be when I first
>   do M-x submit-emacs-patch, is there?  ]

No, there isn't.  (Some people first report the problem, and then post
the patch in a separate message, once they receive the response from
the bug tracker with the bug number, for this very reason.)  So for
the first submission you cannot put the number there.  However, for
the other submissions you can add it.