procyberian/emacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Allow substitute-command-keys to include menus in \{...} output

Browse source 
* doc/lispref/help.texi (Keys in Documentation): Document it.
* lisp/help.el (substitute-command-keys): Add an argument to
include menus in the \{...-map} output (bug#24236).
This commit is contained in:
Lars Ingebrigtsen 2022-05-13 15:54:16 +02:00
parent 2ec9f025d2
commit ebfec5c119
2 changed files with 16 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
doc/lispref/help.texi
View file

@ -390,7 +390,7 @@ quotes. You can customize it freely according to your personal
preference.
@end defopt
@defun substitute-command-keys string &optional no-face
@defun substitute-command-keys string &optional no-face include-menus
@vindex help-key-binding@r{ (face)}
This function scans @var{string} for the above special sequences and
replaces them by what they stand for, returning the result as a string.
@ -440,6 +440,9 @@ RET minibuffer-complete-and-exit
C-g abort-recursive-edit
"
The keymap description will normally exclude menu items, but it
@var{include-menus} is non-@code{nil}, include them.
@group
(substitute-command-keys
"To abort a recursive edit from the minibuffer, type \

20
lisp/help.el
View file

@ -1090,7 +1090,7 @@ strings done by `substitute-command-keys'."
:version "29.1"
:group 'help)
(defun substitute-command-keys (string &optional no-face)
(defun substitute-command-keys (string &optional no-face include-menus)
"Substitute key descriptions for command names in STRING.
Each substring of the form \\\\=[COMMAND] is replaced by either a
keystroke sequence that invokes COMMAND, or \"M-x COMMAND\" if COMMAND
@ -1100,11 +1100,13 @@ unless the optional argument NO-FACE is non-nil.
Each substring of the form \\\\=`KEYBINDING' will be replaced by
KEYBINDING and use the `help-key-binding' face.
Each substring of the form \\\\={MAPVAR} is replaced by a summary of
the value of MAPVAR as a keymap. This summary is similar to the one
produced by ‘describe-bindings’. The summary ends in two newlines
(used by the helper function ‘help-make-xrefs’ to find the end of the
summary).
Each substring of the form \\\\={MAPVAR} is replaced by a summary
of the value of MAPVAR as a keymap. This summary is similar to
the one produced by ‘describe-bindings’. This will normally
exclude menu bindings, but if the optional INCLUDE-MENUS argument
is non-nil, also include menu bindings. The summary ends in two
newlines (used by the helper function ‘help-make-xrefs’ to find
the end of the summary).
Each substring of the form \\\\=<MAPVAR> specifies the use of MAPVAR
as the keymap for future \\\\=[COMMAND] substrings.
@ -1253,9 +1255,11 @@ Otherwise, return a new string."
(t
;; Get the list of active keymaps that precede this one.
;; If this one's not active, get nil.
(let ((earlier-maps (cdr (memq this-keymap (reverse active-maps)))))
(let ((earlier-maps
(cdr (memq this-keymap (reverse active-maps)))))
(describe-map-tree this-keymap t (nreverse earlier-maps)
nil nil t nil nil t))))))))
nil nil (not include-menus)
nil nil t))))))))
;; 2. Handle quotes.
((and (eq (text-quoting-style) 'curve)
(or (and (= (following-char) ?\`)