diff options
author | Basil L. Contovounesios <contovob@tcd.ie> | 2019-04-21 23:02:01 +0100 |
---|---|---|
committer | Basil L. Contovounesios <contovob@tcd.ie> | 2019-05-07 18:00:20 +0100 |
commit | c972da907d494b6d5efd423aa3b5d0b23f7b7801 (patch) | |
tree | fd5dd346e8e31e029bf3c8686f28c60e6dadf4c4 /doc/lispref/os.texi | |
parent | e10d08df7edbb2e9e90169d19c3361099802fad6 (diff) | |
download | emacs-c972da907d494b6d5efd423aa3b5d0b23f7b7801.tar.gz |
Clarify what constitutes an event (bug#35238)
* doc/lispref/commands.texi (Input Events): Specify that events are
non-nil and remove vestiges of bug#10190.
* doc/lispref/os.texi (Recording Input): Document optional argument
of recent-keys.
* lisp/subr.el (eventp): Check that the car of conses is non-nil.
* etc/NEWS: Announce it as an incompatible change.
* src/keyboard.c (Frecent_keys): Clarify that returned "events" are
not real events.
Diffstat (limited to 'doc/lispref/os.texi')
-rw-r--r-- | doc/lispref/os.texi | 7 |
1 files changed, 6 insertions, 1 deletions
diff --git a/doc/lispref/os.texi b/doc/lispref/os.texi index 59cd5a8fe8a..fef954eb7a3 100644 --- a/doc/lispref/os.texi +++ b/doc/lispref/os.texi @@ -2197,7 +2197,7 @@ is the character Emacs currently uses for quitting, usually @kbd{C-g}. @subsection Recording Input @cindex recording input -@defun recent-keys +@defun recent-keys &optional include-cmds This function returns a vector containing the last 300 input events from the keyboard or mouse. All input events are included, whether or not they were used as parts of key sequences. Thus, you always get the last @@ -2205,6 +2205,11 @@ they were used as parts of key sequences. Thus, you always get the last (These are excluded because they are less interesting for debugging; it should be enough to see the events that invoked the macros.) +If @var{include-cmds} is non-@code{nil}, complete key sequences in the +result vector are interleaved with pseudo-events of the form +@code{(nil . @var{COMMAND})}, where @var{COMMAND} is the binding of +the key sequence (@pxref{Command Overview}). + A call to @code{clear-this-command-keys} (@pxref{Command Loop Info}) causes this function to return an empty vector immediately afterward. @end defun |