From: Mattias Engdegård Date: Tue, 29 Dec 2020 15:55:06 +0000 (+0100) Subject: Pretty-print keys without <> around modifiers (bug#45536) X-Git-Tag: emacs-28.0.90~4370 X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=7f16f177270e8e69cb8b78fb502caae3653a32cf;p=emacs.git Pretty-print keys without <> around modifiers (bug#45536) Be consistent when pretty-printing keys: put modifiers outside <>, thus the more logical C-M- instead of . * src/keymap.c (Fsingle_key_description): Skip modifier prefix before adding <>. * doc/lispref/help.texi (Describing Characters): Update example. * doc/lispref/debugging.texi (Backtraces): * doc/lispref/minibuf.texi (Text from Minibuffer): Use @kbd instead of @key. * etc/NEWS: Announce the change. * test/src/keymap-tests.el (keymap--key-description): * test/lisp/subr-tests.el (subr--kbd): New tests. --- diff --git a/doc/lispref/debugging.texi b/doc/lispref/debugging.texi index 1e779ac7054..8e4b0ebfe96 100644 --- a/doc/lispref/debugging.texi +++ b/doc/lispref/debugging.texi @@ -424,7 +424,7 @@ move to it and type @key{RET}, to visit the source code. You can also type @key{RET} while point is on any name of a function or variable which is not underlined, to see help information for that symbol in a help buffer, if any exists. The @code{xref-find-definitions} command, -bound to @key{M-.}, can also be used on any identifier in a backtrace +bound to @kbd{M-.}, can also be used on any identifier in a backtrace (@pxref{Looking Up Identifiers,,,emacs, The GNU Emacs Manual}). In backtraces, the tails of long lists and the ends of long strings, diff --git a/doc/lispref/help.texi b/doc/lispref/help.texi index 2fd05b73917..298bec5230c 100644 --- a/doc/lispref/help.texi +++ b/doc/lispref/help.texi @@ -545,7 +545,7 @@ brackets. @end group @group (single-key-description 'C-mouse-1) - @result{} "" + @result{} "C-" @end group @group (single-key-description 'C-mouse-1 t) diff --git a/doc/lispref/minibuf.texi b/doc/lispref/minibuf.texi index 81139b9e746..f0036f0ccfc 100644 --- a/doc/lispref/minibuf.texi +++ b/doc/lispref/minibuf.texi @@ -348,7 +348,7 @@ default, it makes the following bindings: @item @key{RET} @code{exit-minibuffer} -@item @key{M-<} +@item @kbd{M-<} @code{minibuffer-beginning-of-buffer} @item @kbd{C-g} diff --git a/etc/NEWS b/etc/NEWS index ef1c4b39a6f..d1cc422e9f7 100644 --- a/etc/NEWS +++ b/etc/NEWS @@ -218,6 +218,13 @@ and other "slow scrolling" situations. It is hoped it behaves better than 'fast-but-imprecise-scrolling' and 'jit-lock-defer-time'. It is not enabled by default. ++++ +** Modifiers now go outside angle brackets in pretty-printed key bindings. +For example, with Control and Meta modifiers is now shown as +C-M- instead of . Either variant can be used as +input; functions such as 'kbd' and 'read-kbd-macro' accept both styles +as equivalent (they have done so for a long time). + * Editing Changes in Emacs 28.1 diff --git a/src/keymap.c b/src/keymap.c index 37270f5782b..3d1993869bc 100644 --- a/src/keymap.c +++ b/src/keymap.c @@ -2188,11 +2188,21 @@ See `text-char-description' for describing character codes. */) { if (NILP (no_angles)) { - Lisp_Object result; - char *buffer = SAFE_ALLOCA (sizeof "<>" - + SBYTES (SYMBOL_NAME (key))); - esprintf (buffer, "<%s>", SDATA (SYMBOL_NAME (key))); - result = build_string (buffer); + Lisp_Object namestr = SYMBOL_NAME (key); + const char *sym = SSDATA (namestr); + ptrdiff_t len = SBYTES (namestr); + /* Find the extent of the modifier prefix, like "C-M-". */ + int i = 0; + while (i < len - 3 && sym[i + 1] == '-' && strchr ("CMSsHA", sym[i])) + i += 2; + /* First I bytes of SYM are modifiers; put <> around the rest. */ + char *buffer = SAFE_ALLOCA (len + 3); + memcpy (buffer, sym, i); + buffer[i] = '<'; + memcpy (buffer + i + 1, sym + i, len - i); + buffer [len + 1] = '>'; + buffer [len + 2] = '\0'; + Lisp_Object result = build_string (buffer); SAFE_FREE (); return result; } diff --git a/test/lisp/subr-tests.el b/test/lisp/subr-tests.el index 2f5b38d05d9..8d19a268773 100644 --- a/test/lisp/subr-tests.el +++ b/test/lisp/subr-tests.el @@ -630,5 +630,13 @@ See https://debbugs.gnu.org/cgi/bugreport.cgi?bug=19350." (should (>= (length (apropos-internal "^help" #'commandp)) 15)) (should-not (apropos-internal "^next-line$" #'keymapp))) +(ert-deftest subr--kbd () + ;; Check that kbd handles both new and old style key descriptions + ;; (bug#45536). + (should (equal (kbd "s-") [s-return])) + (should (equal (kbd "") [s-return])) + (should (equal (kbd "C-M-") [C-M-return])) + (should (equal (kbd "") [C-M-return]))) + (provide 'subr-tests) ;;; subr-tests.el ends here diff --git a/test/src/keymap-tests.el b/test/src/keymap-tests.el index 74fb3c892db..d4f5fc3f190 100644 --- a/test/src/keymap-tests.el +++ b/test/src/keymap-tests.el @@ -248,6 +248,18 @@ g .. h foo 0 .. 3 foo "))))) +(ert-deftest keymap--key-description () + (should (equal (key-description [right] [?\C-x]) + "C-x ")) + (should (equal (key-description [M-H-right] [?\C-x]) + "C-x M-H-")) + (should (equal (single-key-description 'home) + "")) + (should (equal (single-key-description 'home t) + "home")) + (should (equal (single-key-description 'C-s-home) + "C-s-"))) + (provide 'keymap-tests) ;;; keymap-tests.el ends here