GNU bug report logs - #69893
29.2; Valid key "<TAB>" not accepted by `keymap-global-set'

Previous Next

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 69893 in the body.
You can then email your comments to 69893 AT debbugs.gnu.org in the normal way.

Toggle the display of automated, internal messages from the tracker.

Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):

From: tpeplt <tpeplt <at> gmail.com>
To: bug-gnu-emacs <at> gnu.org
Subject: 29.2; Valid key "<TAB>" not accepted by `keymap-global-set'
Date: Mon, 18 Mar 2024 17:14:16 -0400

Recipe for reproducing this problem:

1. Start Emacs at a shell prompt using "emacs -Q".

2. Evaluate the following expressions in the *scratch* buffer.

The following keys evaluate as valid (as expected):

(key-valid-p "TAB")
(key-valid-p "<TAB>")
(key-valid-p "<tab>")

The following key evaluates as invalid (as expected):

(key-valid-p "tab")

3. So, the following expressions should evaluate to
‘indent-for-tab-command’:

(keymap-global-set "<tab>" 'indent-for-tab-command)
(keymap-global-set "TAB" 'indent-for-tab-command)
(keymap-global-set "<TAB>" 'indent-for-tab-command)

The first two expressions evaluate as expected, but when the third
expression is evaluated, then the following message is reported:

keymap-global-set: To bind the key TAB, use [?\t], not [TAB]

Because (key-valid-p "<TAB>") evaluates to t, that error message appears
to be invalid.

4. Also, the following expressions all evaluate to nil:

(key-valid-p "[?\t]")
(key-valid-p "[?\\t]")

(key-valid-p "?\t")
(key-valid-p "?\\t")

(key-valid-p "<?\t>")
(key-valid-p "<?\\t>")

So the error message appears to direct a user to change the key string
to an invalid key.

--

Message #8 received at 69893 <at> debbugs.gnu.org (full text, mbox):

From: Eli Zaretskii <eliz <at> gnu.org>
To: tpeplt <tpeplt <at> gmail.com>,
 Stefan Monnier <monnier <at> iro.umontreal.ca>
Cc: 69893 <at> debbugs.gnu.org
Subject: Re: bug#69893: 29.2;
 Valid key "<TAB>" not accepted by `keymap-global-set'
Date: Thu, 21 Mar 2024 14:36:10 +0200

> From: tpeplt <tpeplt <at> gmail.com>
> Date: Mon, 18 Mar 2024 17:14:16 -0400
> 
> Recipe for reproducing this problem:
> 
> 1. Start Emacs at a shell prompt using "emacs -Q".
> 
> 2. Evaluate the following expressions in the *scratch* buffer.
> 
> The following keys evaluate as valid (as expected):
> 
> (key-valid-p "TAB")
> (key-valid-p "<TAB>")
> (key-valid-p "<tab>")
> 
> The following key evaluates as invalid (as expected):
> 
> (key-valid-p "tab")
> 
> 3. So, the following expressions should evaluate to
> ‘indent-for-tab-command’:
> 
> (keymap-global-set "<tab>" 'indent-for-tab-command)
> (keymap-global-set "TAB" 'indent-for-tab-command)
> (keymap-global-set "<TAB>" 'indent-for-tab-command)
> 
> The first two expressions evaluate as expected, but when the third
> expression is evaluated, then the following message is reported:
> 
> keymap-global-set: To bind the key TAB, use [?\t], not [TAB]
> 
> Because (key-valid-p "<TAB>") evaluates to t, that error message appears
> to be invalid.
> 
> 4. Also, the following expressions all evaluate to nil:
> 
> (key-valid-p "[?\t]")
> (key-valid-p "[?\\t]")
> 
> (key-valid-p "?\t")
> (key-valid-p "?\\t")
> 
> (key-valid-p "<?\t>")
> (key-valid-p "<?\\t>")
> 
> So the error message appears to direct a user to change the key string
> to an invalid key.

Stefan, is the below the right fix for this?

If not, why does key-parse omit TAB from the list of specially-handled
keys?

diff --git a/lisp/keymap.el b/lisp/keymap.el
index d2544e3..b2b475c 100644
--- a/lisp/keymap.el
+++ b/lisp/keymap.el
@@ -260,7 +260,7 @@ key-parse
                         (setq word (concat (match-string 1 word)
                                            (match-string 3 word)))
                         (not (string-match
-                              "\\<\\(NUL\\|RET\\|LFD\\|ESC\\|SPC\\|DEL\\)$"
+                              "\\<\\(NUL\\|RET\\|LFD\\|TAB\\|ESC\\|SPC\\|DEL\\)$"
                               word))))
                  (setq key (list (intern word))))
                 ((or (equal word "REM") (string-match "^;;" word))

Message #11 received at 69893 <at> debbugs.gnu.org (full text, mbox):

From: Stefan Monnier <monnier <at> iro.umontreal.ca>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: 69893 <at> debbugs.gnu.org, tpeplt <tpeplt <at> gmail.com>
Subject: Re: bug#69893: 29.2; Valid key "<TAB>" not accepted by
 `keymap-global-set'
Date: Thu, 21 Mar 2024 15:46:08 -0400

> Stefan, is the below the right fix for this?

Looks correct to me.
That code dates back to

    commit 629d4dcd2a184da6a0b246d31f152a84327db51a
    Author: Richard M. Stallman <rms <at> gnu.org>
    Date:   Tue Sep 21 03:44:04 1993 +0000
    
        Total rewrite by Gillespie.

and I suspect it was just an oversight.


        Stefan

Message #16 received at 69893-done <at> debbugs.gnu.org (full text, mbox):

From: Eli Zaretskii <eliz <at> gnu.org>
To: Stefan Monnier <monnier <at> iro.umontreal.ca>
Cc: 69893-done <at> debbugs.gnu.org, tpeplt <at> gmail.com
Subject: Re: bug#69893: 29.2; Valid key "<TAB>" not accepted by
 `keymap-global-set'
Date: Thu, 21 Mar 2024 22:13:52 +0200

> From: Stefan Monnier <monnier <at> iro.umontreal.ca>
> Cc: tpeplt <tpeplt <at> gmail.com>,  69893 <at> debbugs.gnu.org
> Date: Thu, 21 Mar 2024 15:46:08 -0400
> 
> > Stefan, is the below the right fix for this?
> 
> Looks correct to me.
> That code dates back to
> 
>     commit 629d4dcd2a184da6a0b246d31f152a84327db51a
>     Author: Richard M. Stallman <rms <at> gnu.org>
>     Date:   Tue Sep 21 03:44:04 1993 +0000
>     
>         Total rewrite by Gillespie.
> 
> and I suspect it was just an oversight.

Thanks, installed on the emacs-29 branch, and closing the bug.

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.