commands.texi 102 KB
Newer Older
Richard M. Stallman's avatar
Richard M. Stallman committed
1 2
@c -*-texinfo-*-
@c This is part of the GNU Emacs Lisp Reference Manual.
Gerd Moellmann's avatar
Gerd Moellmann committed
3 4
@c Copyright (C) 1990, 1991, 1992, 1993, 1994, 1995, 1998, 1999
@c   Free Software Foundation, Inc. 
Richard M. Stallman's avatar
Richard M. Stallman committed
5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21
@c See the file elisp.texi for copying conditions.
@setfilename ../info/commands
@node Command Loop, Keymaps, Minibuffers, Top
@chapter Command Loop
@cindex editor command loop
@cindex command loop

  When you run Emacs, it enters the @dfn{editor command loop} almost
immediately.  This loop reads key sequences, executes their definitions,
and displays the results.  In this chapter, we describe how these things
are done, and the subroutines that allow Lisp programs to do them.  

@menu
* Command Overview::    How the command loop reads commands.
* Defining Commands::   Specifying how a function should read arguments.
* Interactive Call::    Calling a command, so that it will read arguments.
* Command Loop Info::   Variables set by the command loop for you to examine.
22
* Adjusting Point::     Adjustment of point after a command.
Richard M. Stallman's avatar
Richard M. Stallman committed
23 24
* Input Events::	What input looks like when you read it.
* Reading Input::       How to read input events from the keyboard or mouse.
25
* Special Events::      Events processed immediately and individually.
Richard M. Stallman's avatar
Richard M. Stallman committed
26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44
* Waiting::             Waiting for user input or elapsed time.
* Quitting::            How @kbd{C-g} works.  How to catch or defer quitting.
* Prefix Command Arguments::    How the commands to set prefix args work.
* Recursive Editing::   Entering a recursive edit,
                          and why you usually shouldn't.
* Disabling Commands::  How the command loop handles disabled commands.
* Command History::     How the command history is set up, and how accessed.
* Keyboard Macros::     How keyboard macros are implemented.
@end menu

@node Command Overview
@section Command Loop Overview

  The first thing the command loop must do is read a key sequence, which
is a sequence of events that translates into a command.  It does this by
calling the function @code{read-key-sequence}.  Your Lisp code can also
call this function (@pxref{Key Sequence Input}).  Lisp programs can also
do input at a lower level with @code{read-event} (@pxref{Reading One
Event}) or discard pending input with @code{discard-input}
45
(@pxref{Event Input Misc}).
Richard M. Stallman's avatar
Richard M. Stallman committed
46 47 48 49 50

  The key sequence is translated into a command through the currently
active keymaps.  @xref{Key Lookup}, for information on how this is done.
The result should be a keyboard macro or an interactively callable
function.  If the key is @kbd{M-x}, then it reads the name of another
51
command, which it then calls.  This is done by the command
Richard M. Stallman's avatar
Richard M. Stallman committed
52 53
@code{execute-extended-command} (@pxref{Interactive Call}).

54 55 56 57 58 59 60 61 62 63 64
  To execute a command requires first reading the arguments for it.
This is done by calling @code{command-execute} (@pxref{Interactive
Call}).  For commands written in Lisp, the @code{interactive}
specification says how to read the arguments.  This may use the prefix
argument (@pxref{Prefix Command Arguments}) or may read with prompting
in the minibuffer (@pxref{Minibuffers}).  For example, the command
@code{find-file} has an @code{interactive} specification which says to
read a file name using the minibuffer.  The command's function body does
not use the minibuffer; if you call this command from Lisp code as a
function, you must supply the file name string as an ordinary Lisp
function argument.
Richard M. Stallman's avatar
Richard M. Stallman committed
65 66 67 68 69

  If the command is a string or vector (i.e., a keyboard macro) then
@code{execute-kbd-macro} is used to execute it.  You can call this
function yourself (@pxref{Keyboard Macros}).

70 71
  To terminate the execution of a running command, type @kbd{C-g}.  This
character causes @dfn{quitting} (@pxref{Quitting}).
Richard M. Stallman's avatar
Richard M. Stallman committed
72 73

@defvar pre-command-hook
74 75 76
The editor command loop runs this normal hook before each command.  At
that time, @code{this-command} contains the command that is about to
run, and @code{last-command} describes the previous command.
77
@xref{Hooks}.
Richard M. Stallman's avatar
Richard M. Stallman committed
78 79 80
@end defvar

@defvar post-command-hook
81 82 83 84
The editor command loop runs this normal hook after each command
(including commands terminated prematurely by quitting or by errors),
and also when the command loop is first entered.  At that time,
@code{this-command} describes the command that just ran, and
85
@code{last-command} describes the command before that.  @xref{Hooks}.
Richard M. Stallman's avatar
Richard M. Stallman committed
86 87
@end defvar

88
  Quitting is suppressed while running @code{pre-command-hook} and
Karl Heuer's avatar
Karl Heuer committed
89
@code{post-command-hook}.  If an error happens while executing one of
90 91
these hooks, it terminates execution of the hook, and clears the hook
variable to @code{nil} so as to prevent an infinite loop of errors.
92

Richard M. Stallman's avatar
Richard M. Stallman committed
93 94 95 96 97 98 99 100
@node Defining Commands
@section Defining Commands
@cindex defining commands
@cindex commands, defining
@cindex functions, making them interactive
@cindex interactive function

  A Lisp function becomes a command when its body contains, at top
101
level, a form that calls the special form @code{interactive}.  This
Richard M. Stallman's avatar
Richard M. Stallman committed
102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123
form does nothing when actually executed, but its presence serves as a
flag to indicate that interactive calling is permitted.  Its argument
controls the reading of arguments for an interactive call.

@menu
* Using Interactive::     General rules for @code{interactive}.
* Interactive Codes::     The standard letter-codes for reading arguments
                             in various ways.
* Interactive Examples::  Examples of how to read interactive arguments.
@end menu

@node Using Interactive
@subsection Using @code{interactive}

  This section describes how to write the @code{interactive} form that
makes a Lisp function an interactively-callable command.

@defspec interactive arg-descriptor
@cindex argument descriptors
This special form declares that the function in which it appears is a
command, and that it may therefore be called interactively (via
@kbd{M-x} or by entering a key sequence bound to it).  The argument
124 125
@var{arg-descriptor} declares how to compute the arguments to the
command when the command is called interactively.
Richard M. Stallman's avatar
Richard M. Stallman committed
126 127

A command may be called from Lisp programs like any other function, but
128 129
then the caller supplies the arguments and @var{arg-descriptor} has no
effect.
Richard M. Stallman's avatar
Richard M. Stallman committed
130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153

The @code{interactive} form has its effect because the command loop
(actually, its subroutine @code{call-interactively}) scans through the
function definition looking for it, before calling the function.  Once
the function is called, all its body forms including the
@code{interactive} form are executed, but at this time
@code{interactive} simply returns @code{nil} without even evaluating its
argument.
@end defspec

There are three possibilities for the argument @var{arg-descriptor}:

@itemize @bullet
@item
It may be omitted or @code{nil}; then the command is called with no
arguments.  This leads quickly to an error if the command requires one
or more arguments.

@item
It may be a Lisp expression that is not a string; then it should be a
form that is evaluated to get a list of arguments to pass to the
command.
@cindex argument evaluation form

154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178
If this expression reads keyboard input (this includes using the
minibuffer), keep in mind that the integer value of point or the mark
before reading input may be incorrect after reading input.  This is
because the current buffer may be receiving subprocess output;
if subprocess output arrives while the command is waiting for input,
it could relocate point and the mark.

Here's an example of what @emph{not} to do:

@smallexample
(interactive
 (list (region-beginning) (region-end)
       (read-string "Foo: " nil 'my-history)))
@end smallexample

@noindent
Here's how to avoid the problem, by examining point and the mark only
after reading the keyboard input:

@smallexample
(interactive
 (let ((string (read-string "Foo: " nil 'my-history)))
   (list (region-beginning) (region-end) string)))
@end smallexample

Richard M. Stallman's avatar
Richard M. Stallman committed
179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201
@item
@cindex argument prompt
It may be a string; then its contents should consist of a code character
followed by a prompt (which some code characters use and some ignore).
The prompt ends either with the end of the string or with a newline.
Here is a simple example:

@smallexample
(interactive "bFrobnicate buffer: ")
@end smallexample

@noindent
The code letter @samp{b} says to read the name of an existing buffer,
with completion.  The buffer name is the sole argument passed to the
command.  The rest of the string is a prompt.

If there is a newline character in the string, it terminates the prompt.
If the string does not end there, then the rest of the string should
contain another code character and prompt, specifying another argument.
You can specify any number of arguments in this way.

@c Emacs 19 feature
The prompt string can use @samp{%} to include previous argument values
202 203 204 205
(starting with the first argument) in the prompt.  This is done using
@code{format} (@pxref{Formatting Strings}).  For example, here is how
you could read the name of an existing buffer followed by a new name to
give to that buffer:
Richard M. Stallman's avatar
Richard M. Stallman committed
206 207 208 209 210 211 212 213

@smallexample
@group
(interactive "bBuffer to rename: \nsRename buffer %s to: ")
@end group
@end smallexample

@cindex @samp{*} in interactive
214
@cindex read-only buffers in interactive
Richard M. Stallman's avatar
Richard M. Stallman committed
215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263
If the first character in the string is @samp{*}, then an error is
signaled if the buffer is read-only.

@cindex @samp{@@} in interactive
@c Emacs 19 feature
If the first character in the string is @samp{@@}, and if the key
sequence used to invoke the command includes any mouse events, then
the window associated with the first of those events is selected
before the command is run.

You can use @samp{*} and @samp{@@} together; the order does not matter.
Actual reading of arguments is controlled by the rest of the prompt
string (starting with the first character that is not @samp{*} or
@samp{@@}).
@end itemize

@node Interactive Codes
@comment  node-name,  next,  previous,  up
@subsection Code Characters for @code{interactive}
@cindex interactive code description
@cindex description for interactive codes
@cindex codes, interactive, description of
@cindex characters for interactive codes

  The code character descriptions below contain a number of key words,
defined here as follows:

@table @b
@item Completion
@cindex interactive completion
Provide completion.  @key{TAB}, @key{SPC}, and @key{RET} perform name
completion because the argument is read using @code{completing-read}
(@pxref{Completion}).  @kbd{?} displays a list of possible completions.

@item Existing
Require the name of an existing object.  An invalid name is not
accepted; the commands to exit the minibuffer do not exit if the current
input is not valid.

@item Default
@cindex default argument string
A default value of some sort is used if the user enters no text in the
minibuffer.  The default depends on the code character.

@item No I/O
This code letter computes an argument without reading any input.
Therefore, it does not use a prompt string, and any prompt string you
supply is ignored.

264 265 266
Even though the code letter doesn't use a prompt string, you must follow
it with a newline if it is not the last code character in the string.

Richard M. Stallman's avatar
Richard M. Stallman committed
267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288
@item Prompt
A prompt immediately follows the code character.  The prompt ends either
with the end of the string or with a newline.

@item Special
This code character is meaningful only at the beginning of the
interactive string, and it does not look for a prompt or a newline.
It is a single, isolated character.
@end table

@cindex reading interactive arguments
  Here are the code character descriptions for use with @code{interactive}:

@table @samp
@item *
Signal an error if the current buffer is read-only.  Special.

@item @@
Select the window mentioned in the first mouse event in the key
sequence that invoked this command.  Special.

@item a
289
A function name (i.e., a symbol satisfying @code{fboundp}).  Existing,
Richard M. Stallman's avatar
Richard M. Stallman committed
290 291 292 293 294 295 296 297 298 299
Completion, Prompt.

@item b
The name of an existing buffer.  By default, uses the name of the
current buffer (@pxref{Buffers}).  Existing, Completion, Default,
Prompt.

@item B
A buffer name.  The buffer need not exist.  By default, uses the name of
a recently used buffer other than the current buffer.  Completion,
300
Default, Prompt.
Richard M. Stallman's avatar
Richard M. Stallman committed
301 302 303 304 305 306 307 308 309 310

@item c
A character.  The cursor does not move into the echo area.  Prompt.

@item C
A command name (i.e., a symbol satisfying @code{commandp}).  Existing,
Completion, Prompt.

@item d
@cindex position argument
311
The position of point, as an integer (@pxref{Point}).  No I/O.
Richard M. Stallman's avatar
Richard M. Stallman committed
312 313 314 315 316 317 318 319

@item D
A directory name.  The default is the current default directory of the
current buffer, @code{default-directory} (@pxref{System Environment}).
Existing, Completion, Default, Prompt.

@item e
The first or next mouse event in the key sequence that invoked the command.
320
More precisely, @samp{e} gets events that are lists, so you can look at
Richard M. Stallman's avatar
Richard M. Stallman committed
321 322 323
the data in the lists.  @xref{Input Events}.  No I/O.

You can use @samp{e} more than once in a single command's interactive
324
specification.  If the key sequence that invoked the command has
325
@var{n} events that are lists, the @var{n}th @samp{e} provides the
326
@var{n}th such event.  Events that are not lists, such as function keys
327
and @sc{ascii} characters, do not count where @samp{e} is concerned.
Richard M. Stallman's avatar
Richard M. Stallman committed
328 329 330 331 332 333 334 335 336

@item f
A file name of an existing file (@pxref{File Names}).  The default
directory is @code{default-directory}.  Existing, Completion, Default,
Prompt.

@item F
A file name.  The file need not exist.  Completion, Default, Prompt.

337 338 339 340
@item i
An irrelevant argument.  This code always supplies @code{nil} as
the argument's value.  No I/O.

Richard M. Stallman's avatar
Richard M. Stallman committed
341 342 343 344 345 346 347 348 349
@item k
A key sequence (@pxref{Keymap Terminology}).  This keeps reading events
until a command (or undefined command) is found in the current key
maps.  The key sequence argument is represented as a string or vector.
The cursor does not move into the echo area.  Prompt.

This kind of input is used by commands such as @code{describe-key} and
@code{global-set-key}.

Karl Heuer's avatar
Karl Heuer committed
350 351 352 353 354 355
@item K
A key sequence, whose definition you intend to change.  This works like
@samp{k}, except that it suppresses, for the last input event in the key
sequence, the conversions that are normally used (when necessary) to
convert an undefined key into a defined one.

Richard M. Stallman's avatar
Richard M. Stallman committed
356 357
@item m
@cindex marker argument
358
The position of the mark, as an integer.  No I/O.
Richard M. Stallman's avatar
Richard M. Stallman committed
359

360 361 362 363 364
@item M
Arbitrary text, read in the minibuffer using the current buffer's input
method, and returned as a string (@pxref{Input Methods,,, emacs, The GNU
Emacs Manual}).  Prompt.

Richard M. Stallman's avatar
Richard M. Stallman committed
365 366 367 368 369 370 371
@item n
A number read with the minibuffer.  If the input is not a number, the
user is asked to try again.  The prefix argument, if any, is not used.
Prompt.

@item N
@cindex raw prefix argument usage
372 373
The numeric prefix argument; but if there is no prefix argument, read a
number as with @kbd{n}.  Requires a number.  @xref{Prefix Command
374
Arguments}.  Prompt.
Richard M. Stallman's avatar
Richard M. Stallman committed
375 376 377 378

@item p
@cindex numeric prefix argument usage
The numeric prefix argument.  (Note that this @samp{p} is lower case.)
379
No I/O.
Richard M. Stallman's avatar
Richard M. Stallman committed
380 381

@item P
382 383
The raw prefix argument.  (Note that this @samp{P} is upper case.)  No
I/O.
Richard M. Stallman's avatar
Richard M. Stallman committed
384 385 386 387 388 389 390 391 392 393

@item r
@cindex region argument
Point and the mark, as two numeric arguments, smallest first.  This is
the only code letter that specifies two successive arguments rather than
one.  No I/O.

@item s
Arbitrary text, read in the minibuffer and returned as a string
(@pxref{Text from Minibuffer}).  Terminate the input with either
394
@kbd{C-j} or @key{RET}.  (@kbd{C-q} may be used to include either of
Richard M. Stallman's avatar
Richard M. Stallman committed
395 396 397 398 399 400 401 402 403 404 405 406 407 408
these characters in the input.)  Prompt.

@item S
An interned symbol whose name is read in the minibuffer.  Any whitespace
character terminates the input.  (Use @kbd{C-q} to include whitespace in
the string.)  Other characters that normally terminate a symbol (e.g.,
parentheses and brackets) do not do so here.  Prompt.

@item v
A variable declared to be a user option (i.e., satisfying the predicate
@code{user-variable-p}).  @xref{High-Level Completion}.  Existing,
Completion, Prompt.

@item x
409
A Lisp object, specified with its read syntax, terminated with a
410
@kbd{C-j} or @key{RET}.  The object is not evaluated.  @xref{Object from
Richard M. Stallman's avatar
Richard M. Stallman committed
411 412 413 414 415 416
Minibuffer}.  Prompt.

@item X
@cindex evaluated expression argument
A Lisp form is read as with @kbd{x}, but then evaluated so that its
value becomes the argument for the command.  Prompt.
417 418 419 420 421 422 423 424 425 426

@item z
A coding system name (a symbol).  If the user enters null input, the
argument value is @code{nil}.  @xref{Coding Systems}.  Completion,
Existing, Prompt.

@item Z
A coding system name (a symbol)---but only if this command has a prefix
argument.  With no prefix argument, @samp{Z} provides @code{nil} as the
argument value.  Completion, Existing, Prompt.
Richard M. Stallman's avatar
Richard M. Stallman committed
427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483
@end table

@node Interactive Examples
@comment  node-name,  next,  previous,  up
@subsection Examples of Using @code{interactive}
@cindex examples of using @code{interactive}
@cindex @code{interactive}, examples of using 

  Here are some examples of @code{interactive}:

@example
@group
(defun foo1 ()              ; @r{@code{foo1} takes no arguments,}
    (interactive)           ;   @r{just moves forward two words.}
    (forward-word 2))
     @result{} foo1
@end group

@group
(defun foo2 (n)             ; @r{@code{foo2} takes one argument,}
    (interactive "p")       ;   @r{which is the numeric prefix.}
    (forward-word (* 2 n)))
     @result{} foo2
@end group

@group
(defun foo3 (n)             ; @r{@code{foo3} takes one argument,}
    (interactive "nCount:") ;   @r{which is read with the Minibuffer.}
    (forward-word (* 2 n)))
     @result{} foo3
@end group

@group
(defun three-b (b1 b2 b3)
  "Select three existing buffers.
Put them into three windows, selecting the last one."
@end group
    (interactive "bBuffer1:\nbBuffer2:\nbBuffer3:")
    (delete-other-windows)
    (split-window (selected-window) 8)
    (switch-to-buffer b1)
    (other-window 1)
    (split-window (selected-window) 8)
    (switch-to-buffer b2)
    (other-window 1)
    (switch-to-buffer b3))
     @result{} three-b
@group
(three-b "*scratch*" "declarations.texi" "*mail*")
     @result{} nil
@end group
@end example

@node Interactive Call
@section Interactive Call
@cindex interactive call

484 485 486 487 488
  After the command loop has translated a key sequence into a command it
invokes that command using the function @code{command-execute}.  If the
command is a function, @code{command-execute} calls
@code{call-interactively}, which reads the arguments and calls the
command.  You can also call these functions yourself.
Richard M. Stallman's avatar
Richard M. Stallman committed
489 490 491 492 493 494 495

@defun commandp object
Returns @code{t} if @var{object} is suitable for calling interactively;
that is, if @var{object} is a command.  Otherwise, returns @code{nil}.  

The interactively callable objects include strings and vectors (treated
as keyboard macros), lambda expressions that contain a top-level call to
Karl Heuer's avatar
Karl Heuer committed
496
@code{interactive}, byte-code function objects made from such lambda
497 498 499
expressions, autoload objects that are declared as interactive
(non-@code{nil} fourth argument to @code{autoload}), and some of the
primitive functions.
Richard M. Stallman's avatar
Richard M. Stallman committed
500

501
A symbol satisfies @code{commandp} if its function definition satisfies
Richard M. Stallman's avatar
Richard M. Stallman committed
502 503 504 505 506 507 508 509 510
@code{commandp}.

Keys and keymaps are not commands.  Rather, they are used to look up
commands (@pxref{Keymaps}).

See @code{documentation} in @ref{Accessing Documentation}, for a
realistic example of using @code{commandp}.
@end defun

511
@defun call-interactively command &optional record-flag keys
Richard M. Stallman's avatar
Richard M. Stallman committed
512 513
This function calls the interactively callable function @var{command},
reading arguments according to its interactive calling specifications.
514 515 516 517
An error is signaled if @var{command} is not a function or if it cannot
be called interactively (i.e., is not a command).  Note that keyboard
macros (strings and vectors) are not accepted, even though they are
considered commands, because they are not functions.
Richard M. Stallman's avatar
Richard M. Stallman committed
518 519 520 521 522 523

@cindex record command history
If @var{record-flag} is non-@code{nil}, then this command and its
arguments are unconditionally added to the list @code{command-history}.
Otherwise, the command is added only if it uses the minibuffer to read
an argument.  @xref{Command History}.
524 525

The argument @var{keys}, if given, specifies the sequence of events to
526
supply if the command inquires which events were used to invoke it.
Richard M. Stallman's avatar
Richard M. Stallman committed
527 528
@end defun

Gerd Moellmann's avatar
Gerd Moellmann committed
529
@defun command-execute command &optional record-flag keys special
Richard M. Stallman's avatar
Richard M. Stallman committed
530
@cindex keyboard macro execution
531 532 533
This function executes @var{command}.  The argument @var{command} must
satisfy the @code{commandp} predicate; i.e., it must be an interactively
callable function or a keyboard macro.
Richard M. Stallman's avatar
Richard M. Stallman committed
534 535 536 537 538 539 540 541 542 543

A string or vector as @var{command} is executed with
@code{execute-kbd-macro}.  A function is passed to
@code{call-interactively}, along with the optional @var{record-flag}.

A symbol is handled by using its function definition in its place.  A
symbol with an @code{autoload} definition counts as a command if it was
declared to stand for an interactively callable function.  Such a
definition is handled by loading the specified library and then
rechecking the definition of the symbol.
544 545

The argument @var{keys}, if given, specifies the sequence of events to
546
supply if the command inquires which events were used to invoke it.
Gerd Moellmann's avatar
Gerd Moellmann committed
547 548 549 550

The argument @var{special}, if given, means to ignore the prefix
argument and not clear it.  This is used for executing special events
(@pxref{Special Events}).
Richard M. Stallman's avatar
Richard M. Stallman committed
551 552 553 554 555 556 557 558 559 560
@end defun

@deffn Command execute-extended-command prefix-argument
@cindex read command name
This function reads a command name from the minibuffer using
@code{completing-read} (@pxref{Completion}).  Then it uses
@code{command-execute} to call the specified command.  Whatever that
command returns becomes the value of @code{execute-extended-command}.

@cindex execute with prefix argument
561 562 563
If the command asks for a prefix argument, it receives the value
@var{prefix-argument}.  If @code{execute-extended-command} is called
interactively, the current raw prefix argument is used for
Richard M. Stallman's avatar
Richard M. Stallman committed
564 565 566 567 568 569 570 571 572 573 574 575 576 577 578
@var{prefix-argument}, and thus passed on to whatever command is run.

@c !!! Should this be @kindex?
@cindex @kbd{M-x}
@code{execute-extended-command} is the normal definition of @kbd{M-x},
so it uses the string @w{@samp{M-x }} as a prompt.  (It would be better
to take the prompt from the events used to invoke
@code{execute-extended-command}, but that is painful to implement.)  A
description of the value of the prefix argument, if any, also becomes
part of the prompt.

@example
@group
(execute-extended-command 1)
---------- Buffer: Minibuffer ----------
579
1 M-x forward-word RET
Richard M. Stallman's avatar
Richard M. Stallman committed
580 581 582 583 584 585 586
---------- Buffer: Minibuffer ----------
     @result{} t
@end group
@end example
@end deffn

@defun interactive-p
587 588 589 590 591 592 593
This function returns @code{t} if the containing function (the one whose
code includes the call to @code{interactive-p}) was called
interactively, with the function @code{call-interactively}.  (It makes
no difference whether @code{call-interactively} was called from Lisp or
directly from the editor command loop.)  If the containing function was
called by Lisp evaluation (or with @code{apply} or @code{funcall}), then
it was not called interactively.
594
@end defun
Richard M. Stallman's avatar
Richard M. Stallman committed
595

596
  The most common use of @code{interactive-p} is for deciding whether to
Richard M. Stallman's avatar
Richard M. Stallman committed
597 598 599 600 601
print an informative message.  As a special exception,
@code{interactive-p} returns @code{nil} whenever a keyboard macro is
being run.  This is to suppress the informative messages and speed
execution of the macro.

602
  For example:
Richard M. Stallman's avatar
Richard M. Stallman committed
603 604 605 606 607

@example
@group
(defun foo ()
  (interactive)
608 609
  (when (interactive-p)
    (message "foo")))
Richard M. Stallman's avatar
Richard M. Stallman committed
610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634
     @result{} foo
@end group

@group
(defun bar ()
  (interactive)
  (setq foobar (list (foo) (interactive-p))))
     @result{} bar
@end group

@group
;; @r{Type @kbd{M-x foo}.}
     @print{} foo
@end group

@group
;; @r{Type @kbd{M-x bar}.}
;; @r{This does not print anything.}
@end group

@group
foobar
     @result{} (nil t)
@end group
@end example
635 636 637 638 639 640 641 642 643 644 645 646 647 648

  The other way to do this sort of job is to make the command take an
argument @code{print-message} which should be non-@code{nil} in an
interactive call, and use the @code{interactive} spec to make sure it is
non-@code{nil}.  Here's how:

@example
(defun foo (&optional print-message)
  (interactive "p")
  (when print-message
    (message "foo")))
@end example

  The numeric prefix argument, provided by @samp{p}, is never @code{nil}.
Richard M. Stallman's avatar
Richard M. Stallman committed
649 650 651 652 653 654 655 656 657 658 659 660 661

@node Command Loop Info
@comment  node-name,  next,  previous,  up
@section Information from the Command Loop

The editor command loop sets several Lisp variables to keep status
records for itself and for commands that are run.  

@defvar last-command
This variable records the name of the previous command executed by the
command loop (the one before the current command).  Normally the value
is a symbol with a function definition, but this is not guaranteed.

662
The value is copied from @code{this-command} when a command returns to
663 664
the command loop, except when the command has specified a prefix
argument for the following command.
Karl Heuer's avatar
Karl Heuer committed
665 666 667

This variable is always local to the current terminal and cannot be
buffer-local.  @xref{Multiple Displays}.
Richard M. Stallman's avatar
Richard M. Stallman committed
668 669
@end defvar

670 671 672 673 674
@defvar real-last-command
This variable is set up by Emacs just like @code{last-command},
but never altered by Lisp programs.
@end defvar

Richard M. Stallman's avatar
Richard M. Stallman committed
675 676 677 678 679 680
@defvar this-command
@cindex current command
This variable records the name of the command now being executed by
the editor command loop.  Like @code{last-command}, it is normally a symbol
with a function definition.

681 682
The command loop sets this variable just before running a command, and
copies its value into @code{last-command} when the command finishes
683
(unless the command specified a prefix argument for the following
684
command).
Richard M. Stallman's avatar
Richard M. Stallman committed
685 686

@cindex kill command repetition
687
Some commands set this variable during their execution, as a flag for
Karl Heuer's avatar
Karl Heuer committed
688
whatever command runs next.  In particular, the functions for killing text
689 690 691
set @code{this-command} to @code{kill-region} so that any kill commands
immediately following will know to append the killed text to the
previous kill.
Richard M. Stallman's avatar
Richard M. Stallman committed
692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708
@end defvar

If you do not want a particular command to be recognized as the previous
command in the case where it got an error, you must code that command to
prevent this.  One way is to set @code{this-command} to @code{t} at the
beginning of the command, and set @code{this-command} back to its proper
value at the end, like this:

@example
(defun foo (args@dots{})
  (interactive @dots{})
  (let ((old-this-command this-command))
    (setq this-command t)
    @r{@dots{}do the work@dots{}}
    (setq this-command old-this-command)))
@end example

709 710 711 712 713
@noindent
We do not bind @code{this-command} with @code{let} because that would
restore the old value in case of error---a feature of @code{let} which
in this case does precisely what we want to avoid.

Richard M. Stallman's avatar
Richard M. Stallman committed
714 715 716 717 718 719 720 721 722
@defun this-command-keys
This function returns a string or vector containing the key sequence
that invoked the present command, plus any previous commands that
generated the prefix argument for this command.  The value is a string
if all those events were characters.  @xref{Input Events}.

@example
@group
(this-command-keys)
723
;; @r{Now use @kbd{C-u C-x C-e} to evaluate that.}
Richard M. Stallman's avatar
Richard M. Stallman committed
724 725 726 727 728
     @result{} "^U^X^E"
@end group
@end example
@end defun

729
@defun this-command-keys-vector
730 731 732
Like @code{this-command-keys}, except that it always returns the events
in a vector, so you don't need to deal with the complexities of storing
input events in a string (@pxref{Strings of Events}).
733 734
@end defun

735 736 737 738 739 740 741 742
@tindex clear-this-command-keys
@defun clear-this-command-keys
This function empties out the table of events for
@code{this-command-keys} to return.  This is useful after reading a
password, to prevent the password from echoing inadvertently as part of
the next command in certain cases.
@end defun

Richard M. Stallman's avatar
Richard M. Stallman committed
743
@defvar last-nonmenu-event
744 745
This variable holds the last input event read as part of a key sequence,
not counting events resulting from mouse menus.
Richard M. Stallman's avatar
Richard M. Stallman committed
746

747
One use of this variable is for telling @code{x-popup-menu} where to pop
748 749
up a menu.  It is also used internally by @code{y-or-n-p}
(@pxref{Yes-or-No Queries}).
Richard M. Stallman's avatar
Richard M. Stallman committed
750 751 752 753 754 755 756 757 758 759 760
@end defvar

@defvar last-command-event
@defvarx last-command-char
This variable is set to the last input event that was read by the
command loop as part of a command.  The principal use of this variable
is in @code{self-insert-command}, which uses it to decide which
character to insert.

@example
@group
761
last-command-event
762
;; @r{Now use @kbd{C-u C-x C-e} to evaluate that.}
Richard M. Stallman's avatar
Richard M. Stallman committed
763 764 765 766 767
     @result{} 5
@end group
@end example

@noindent
768
The value is 5 because that is the @sc{ascii} code for @kbd{C-e}.
Richard M. Stallman's avatar
Richard M. Stallman committed
769 770 771 772 773 774 775 776 777 778 779 780 781 782

The alias @code{last-command-char} exists for compatibility with
Emacs version 18.
@end defvar

@c Emacs 19 feature
@defvar last-event-frame
This variable records which frame the last input event was directed to.
Usually this is the frame that was selected when the event was
generated, but if that frame has redirected input focus to another
frame, the value is the frame to which the event was redirected.
@xref{Input Focus}.
@end defvar

783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811
@node Adjusting Point
@section Adjusting Point After Commands

  It is not easy to display a value of point in the middle of a sequence
of text that has the @code{display} or @code{composition} property.  So
after a command finishes and returns to the command loop, if point is
within such a sequence, the command loop normally moves point to the
edge of the sequence.

  A command can inhibit this feature by setting the variable
@code{disable-point-adjustment}:

@defvar disable-point-adjustment
@tindex disable-point-adjustment
If this variable is non-@code{nil} when a command returns to the command
loop, then the command loop does not check for text properties such as
@code{display} and @code{composition}, and does not move point out of
sequences that have these properties.

The command loop sets this variable to @code{nil} before each command,
so if a command sets it, the effect applies only to that command.
@end defvar

@defvar global-disable-point-adjustment
@tindex global-disable-point-adjustment
If you set this variable to a non-@code{nil} value, the feature of
moving point out of these sequences is completely turned off.
@end defvar

Richard M. Stallman's avatar
Richard M. Stallman committed
812 813 814 815 816 817 818 819 820 821 822
@node Input Events
@section Input Events
@cindex events
@cindex input events

The Emacs command loop reads a sequence of @dfn{input events} that
represent keyboard or mouse activity.  The events for keyboard activity
are characters or symbols; mouse events are always lists.  This section
describes the representation and meaning of input events in detail.

@defun eventp object
823 824 825 826 827 828 829 830 831
This function returns non-@code{nil} if @var{object} is an input event
or event type.

Note that any symbol might be used as an event or an event type.
@code{eventp} cannot distinguish whether a symbol is intended by Lisp
code to be used as an event.  Instead, it distinguishes whether the
symbol has actually been used in an event that has been read as input in
the current Emacs session.  If a symbol has not yet been so used,
@code{eventp} returns @code{nil}.
Richard M. Stallman's avatar
Richard M. Stallman committed
832 833 834 835 836
@end defun

@menu
* Keyboard Events::		Ordinary characters--keys with symbols on them.
* Function Keys::		Function keys--keys with names, not symbols.
837
* Mouse Events::                Overview of mouse events.
Richard M. Stallman's avatar
Richard M. Stallman committed
838 839 840 841 842 843
* Click Events::		Pushing and releasing a mouse button.
* Drag Events::			Moving the mouse before releasing the button.
* Button-Down Events::		A button was pushed and not yet released.
* Repeat Events::               Double and triple click (or drag, or down).
* Motion Events::		Just moving the mouse, not pushing a button.
* Focus Events::		Moving the mouse between frames.
Karl Heuer's avatar
Karl Heuer committed
844
* Misc Events::                 Other events window systems can generate.
Richard M. Stallman's avatar
Richard M. Stallman committed
845 846 847 848 849 850 851 852 853 854 855 856 857
* Event Examples::		Examples of the lists for mouse events.
* Classifying Events::		Finding the modifier keys in an event symbol.
				Event types.
* Accessing Events::		Functions to extract info from events.
* Strings of Events::           Special considerations for putting
				  keyboard character events in a string.
@end menu

@node Keyboard Events
@subsection Keyboard Events

There are two kinds of input you can get from the keyboard: ordinary
keys, and function keys.  Ordinary keys correspond to characters; the
858 859 860
events they generate are represented in Lisp as characters.  The event
type of a character event is the character itself (an integer); see
@ref{Classifying Events}.
Richard M. Stallman's avatar
Richard M. Stallman committed
861 862 863 864

@cindex modifier bits (of input character)
@cindex basic code (of input character)
An input character event consists of a @dfn{basic code} between 0 and
865
524287, plus any or all of these @dfn{modifier bits}:
Richard M. Stallman's avatar
Richard M. Stallman committed
866 867 868

@table @asis
@item meta
Karl Heuer's avatar
Karl Heuer committed
869
The
870
@tex
871
@math{2^{27}}
872
@end tex
Gerd Moellmann's avatar
Gerd Moellmann committed
873
@ifnottex
Karl Heuer's avatar
Karl Heuer committed
874
2**27
Gerd Moellmann's avatar
Gerd Moellmann committed
875
@end ifnottex
Karl Heuer's avatar
Karl Heuer committed
876
bit in the character code indicates a character
Richard M. Stallman's avatar
Richard M. Stallman committed
877 878 879
typed with the meta key held down.

@item control
Karl Heuer's avatar
Karl Heuer committed
880
The
881
@tex
882
@math{2^{26}}
883
@end tex
Gerd Moellmann's avatar
Gerd Moellmann committed
884
@ifnottex
Karl Heuer's avatar
Karl Heuer committed
885
2**26
Gerd Moellmann's avatar
Gerd Moellmann committed
886
@end ifnottex
887
bit in the character code indicates a non-@sc{ascii}
Richard M. Stallman's avatar
Richard M. Stallman committed
888 889
control character.

890
@sc{ascii} control characters such as @kbd{C-a} have special basic
Richard M. Stallman's avatar
Richard M. Stallman committed
891 892 893
codes of their own, so Emacs needs no special bit to indicate them.
Thus, the code for @kbd{C-a} is just 1.

894
But if you type a control combination not in @sc{ascii}, such as
Richard M. Stallman's avatar
Richard M. Stallman committed
895
@kbd{%} with the control key, the numeric value you get is the code
Karl Heuer's avatar
Karl Heuer committed
896
for @kbd{%} plus
897
@tex
898
@math{2^{26}}
899
@end tex
Gerd Moellmann's avatar
Gerd Moellmann committed
900
@ifnottex
Karl Heuer's avatar
Karl Heuer committed
901
2**26
Gerd Moellmann's avatar
Gerd Moellmann committed
902
@end ifnottex
903
(assuming the terminal supports non-@sc{ascii}
Richard M. Stallman's avatar
Richard M. Stallman committed
904 905 906
control characters).

@item shift
Karl Heuer's avatar
Karl Heuer committed
907
The
908
@tex
909
@math{2^{25}}
910
@end tex
Gerd Moellmann's avatar
Gerd Moellmann committed
911
@ifnottex
Karl Heuer's avatar
Karl Heuer committed
912
2**25
Gerd Moellmann's avatar
Gerd Moellmann committed
913
@end ifnottex
914
bit in the character code indicates an @sc{ascii} control
Richard M. Stallman's avatar
Richard M. Stallman committed
915 916
character typed with the shift key held down.

917 918 919
For letters, the basic code itself indicates upper versus lower case;
for digits and punctuation, the shift key selects an entirely different
character with a different basic code.  In order to keep within the
920
@sc{ascii} character set whenever possible, Emacs avoids using the
921
@tex
922
@math{2^{25}}
923
@end tex
Gerd Moellmann's avatar
Gerd Moellmann committed
924
@ifnottex
Karl Heuer's avatar
Karl Heuer committed
925
2**25
Gerd Moellmann's avatar
Gerd Moellmann committed
926
@end ifnottex
Karl Heuer's avatar
Karl Heuer committed
927
bit for those characters.
Richard M. Stallman's avatar
Richard M. Stallman committed
928

929
However, @sc{ascii} provides no way to distinguish @kbd{C-A} from
Karl Heuer's avatar
Karl Heuer committed
930
@kbd{C-a}, so Emacs uses the
931
@tex
932
@math{2^{25}}
933
@end tex
Gerd Moellmann's avatar
Gerd Moellmann committed
934
@ifnottex
Karl Heuer's avatar
Karl Heuer committed
935
2**25
Gerd Moellmann's avatar
Gerd Moellmann committed
936
@end ifnottex
Karl Heuer's avatar
Karl Heuer committed
937
bit in @kbd{C-A} and not in
Richard M. Stallman's avatar
Richard M. Stallman committed
938 939 940
@kbd{C-a}.

@item hyper
Karl Heuer's avatar
Karl Heuer committed
941
The
942
@tex
943
@math{2^{24}}
944
@end tex
Gerd Moellmann's avatar
Gerd Moellmann committed
945
@ifnottex
Karl Heuer's avatar
Karl Heuer committed
946
2**24
Gerd Moellmann's avatar
Gerd Moellmann committed
947
@end ifnottex
Karl Heuer's avatar
Karl Heuer committed
948
bit in the character code indicates a character
Richard M. Stallman's avatar
Richard M. Stallman committed
949 950 951
typed with the hyper key held down.

@item super
Karl Heuer's avatar
Karl Heuer committed
952
The
953
@tex
954
@math{2^{23}}
955
@end tex
Gerd Moellmann's avatar
Gerd Moellmann committed
956
@ifnottex
Karl Heuer's avatar
Karl Heuer committed
957
2**23
Gerd Moellmann's avatar
Gerd Moellmann committed
958
@end ifnottex
Karl Heuer's avatar
Karl Heuer committed
959
bit in the character code indicates a character
Richard M. Stallman's avatar
Richard M. Stallman committed
960 961 962
typed with the super key held down.

@item alt
Karl Heuer's avatar
Karl Heuer committed
963
The
964
@tex
965
@math{2^{22}}
966
@end tex
Gerd Moellmann's avatar
Gerd Moellmann committed
967
@ifnottex
Karl Heuer's avatar
Karl Heuer committed
968
2**22
Gerd Moellmann's avatar
Gerd Moellmann committed
969
@end ifnottex
Karl Heuer's avatar
Karl Heuer committed
970
bit in the character code indicates a character typed with
Richard M. Stallman's avatar
Richard M. Stallman committed
971 972 973 974
the alt key held down.  (On some terminals, the key labeled @key{ALT}
is actually the meta key.)
@end table

Karl Heuer's avatar
Karl Heuer committed
975 976 977 978 979 980 981 982 983
  It is best to avoid mentioning specific bit numbers in your program.
To test the modifier bits of a character, use the function
@code{event-modifiers} (@pxref{Classifying Events}).  When making key
bindings, you can use the read syntax for characters with modifier bits
(@samp{\C-}, @samp{\M-}, and so on).  For making key bindings with
@code{define-key}, you can use lists such as @code{(control hyper ?x)} to
specify the characters (@pxref{Changing Key Bindings}).  The function
@code{event-convert-list} converts such a list into an event type
(@pxref{Classifying Events}).
Richard M. Stallman's avatar
Richard M. Stallman committed
984 985 986 987 988

@node Function Keys
@subsection Function Keys

@cindex function keys
989
Most keyboards also have @dfn{function keys}---keys that have names or
990 991
symbols that are not characters.  Function keys are represented in Emacs
Lisp as symbols; the symbol's name is the function key's label, in lower
992 993
case.  For example, pressing a key labeled @key{F1} places the symbol
@code{f1} in the input stream.
Richard M. Stallman's avatar
Richard M. Stallman committed
994

995 996
The event type of a function key event is the event symbol itself.
@xref{Classifying Events}.
Richard M. Stallman's avatar
Richard M. Stallman committed
997

998
Here are a few special cases in the symbol-naming convention for
Richard M. Stallman's avatar
Richard M. Stallman committed
999 1000 1001 1002
function keys:

@table @asis
@item @code{backspace}, @code{tab}, @code{newline}, @code{return}, @code{delete}
1003
These keys correspond to common @sc{ascii} control characters that have
Richard M. Stallman's avatar
Richard M. Stallman committed
1004 1005
special keys on most keyboards.

1006
In @sc{ascii}, @kbd{C-i} and @key{TAB} are the same character.  If the
1007 1008 1009
terminal can distinguish between them, Emacs conveys the distinction to
Lisp programs by representing the former as the integer 9, and the
latter as the symbol @code{tab}.
Richard M. Stallman's avatar
Richard M. Stallman committed
1010 1011

Most of the time, it's not useful to distinguish the two.  So normally
Richard M. Stallman's avatar
Richard M. Stallman committed
1012 1013 1014 1015 1016
@code{function-key-map} (@pxref{Translating Input}) is set up to map
@code{tab} into 9.  Thus, a key binding for character code 9 (the
character @kbd{C-i}) also applies to @code{tab}.  Likewise for the other
symbols in this group.  The function @code{read-char} likewise converts
these events into characters.
Richard M. Stallman's avatar
Richard M. Stallman committed
1017

1018
In @sc{ascii}, @key{BS} is really @kbd{C-h}.  But @code{backspace}
Richard M. Stallman's avatar
Richard M. Stallman committed
1019 1020 1021
converts into the character code 127 (@key{DEL}), not into code 8
(@key{BS}).  This is what most users prefer.

1022 1023
@item @code{left}, @code{up}, @code{right}, @code{down}
Cursor arrow keys
Richard M. Stallman's avatar
Richard M. Stallman committed
1024 1025 1026 1027 1028 1029
@item @code{kp-add}, @code{kp-decimal}, @code{kp-divide}, @dots{}
Keypad keys (to the right of the regular keyboard).
@item @code{kp-0}, @code{kp-1}, @dots{}
Keypad keys with digits.
@item @code{kp-f1}, @code{kp-f2}, @code{kp-f3}, @code{kp-f4}
Keypad PF keys.
1030
@item @code{kp-home}, @code{kp-left}, @code{kp-up}, @code{kp-right}, @code{kp-down}
1031 1032
Keypad arrow keys.  Emacs normally translates these into the
corresponding non-keypad keys @code{home}, @code{left}, @dots{}
1033 1034 1035
@item @code{kp-prior}, @code{kp-next}, @code{kp-end}, @code{kp-begin}, @code{kp-insert}, @code{kp-delete}
Additional keypad duplicates of keys ordinarily found elsewhere.  Emacs
normally translates these into the like-named non-keypad keys.
Richard M. Stallman's avatar
Richard M. Stallman committed
1036 1037
@end table

1038 1039 1040
You can use the modifier keys @key{ALT}, @key{CTRL}, @key{HYPER},
@key{META}, @key{SHIFT}, and @key{SUPER} with function keys.  The way to
represent them is with prefixes in the symbol name:
Richard M. Stallman's avatar
Richard M. Stallman committed
1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057

@table @samp
@item A-
The alt modifier.
@item C-
The control modifier.
@item H-
The hyper modifier.
@item M-
The meta modifier.
@item S-
The shift modifier.
@item s-
The super modifier.
@end table

Thus, the symbol for the key @key{F3} with @key{META} held down is
Richard M. Stallman's avatar
Richard M. Stallman committed
1058
@code{M-f3}.  When you use more than one prefix, we recommend you
1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082
write them in alphabetical order; but the order does not matter in
arguments to the key-binding lookup and modification functions.

@node Mouse Events
@subsection Mouse Events

Emacs supports four kinds of mouse events: click events, drag events,
button-down events, and motion events.  All mouse events are represented
as lists.  The @sc{car} of the list is the event type; this says which
mouse button was involved, and which modifier keys were used with it.
The event type can also distinguish double or triple button presses
(@pxref{Repeat Events}).  The rest of the list elements give position
and time information.

For key lookup, only the event type matters: two events of the same type
necessarily run the same command.  The command can access the full
values of these events using the @samp{e} interactive code.
@xref{Interactive Codes}.

A key sequence that starts with a mouse event is read using the keymaps
of the buffer in the window that the mouse was in, not the current
buffer.  This does not imply that clicking in a window selects that
window or its buffer---that is entirely under the control of the command
binding of the key sequence.
Richard M. Stallman's avatar
Richard M. Stallman committed
1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094

@node Click Events
@subsection Click Events
@cindex click event
@cindex mouse click event

When the user presses a mouse button and releases it at the same
location, that generates a @dfn{click} event.  Mouse click events have
this form:

@example
(@var{event-type}
1095
 (@var{window} @var{buffer-pos} (@var{x} . @var{y}) @var{timestamp})
Richard M. Stallman's avatar
Richard M. Stallman committed
1096 1097 1098 1099 1100
 @var{click-count})
@end example

Here is what the elements normally mean:

1101 1102
@table @asis
@item @var{event-type}
Richard M. Stallman's avatar
Richard M. Stallman committed
1103 1104
This is a symbol that indicates which mouse button was used.  It is
one of the symbols @code{mouse-1}, @code{mouse-2}, @dots{}, where the
1105
buttons are numbered left to right.
Richard M. Stallman's avatar
Richard M. Stallman committed
1106 1107 1108 1109 1110 1111 1112 1113 1114 1115

You can also use prefixes @samp{A-}, @samp{C-}, @samp{H-}, @samp{M-},
@samp{S-} and @samp{s-} for modifiers alt, control, hyper, meta, shift
and super, just as you would with function keys.

This symbol also serves as the event type of the event.  Key bindings
describe events by their types; thus, if there is a key binding for
@code{mouse-1}, that binding would apply to all events whose
@var{event-type} is @code{mouse-1}.

1116
@item @var{window}
Richard M. Stallman's avatar
Richard M. Stallman committed
1117 1118
This is the window in which the click occurred.

1119
@item @var{x}, @var{y}
1120 1121
These are the pixel-denominated coordinates of the click, relative to
the top left corner of @var{window}, which is @code{(0 . 0)}.
Richard M. Stallman's avatar
Richard M. Stallman committed
1122

1123
@item @var{buffer-pos}
Richard M. Stallman's avatar
Richard M. Stallman committed
1124 1125
This is the buffer position of the character clicked on.

1126
@item @var{timestamp}
Richard M. Stallman's avatar
Richard M. Stallman committed
1127 1128 1129 1130
This is the time at which the event occurred, in milliseconds.  (Since
this value wraps around the entire range of Emacs Lisp integers in about
five hours, it is useful only for relating the times of nearby events.)

1131
@item @var{click-count}
Richard M. Stallman's avatar
Richard M. Stallman committed
1132 1133 1134 1135
This is the number of rapid repeated presses so far of the same mouse
button.  @xref{Repeat Events}.
@end table

1136 1137 1138
The meanings of @var{buffer-pos}, @var{x} and @var{y} are somewhat
different when the event location is in a special part of the screen,
such as the mode line or a scroll bar.
Richard M. Stallman's avatar
Richard M. Stallman committed
1139 1140 1141 1142 1143 1144 1145 1146 1147 1148

If the location is in a scroll bar, then @var{buffer-pos} is the symbol
@code{vertical-scroll-bar} or @code{horizontal-scroll-bar}, and the pair
@code{(@var{x} . @var{y})} is replaced with a pair @code{(@var{portion}
. @var{whole})}, where @var{portion} is the distance of the click from
the top or left end of the scroll bar, and @var{whole} is the length of
the entire scroll bar.

If the position is on a mode line or the vertical line separating
@var{window} from its neighbor to the right, then @var{buffer-pos} is
Gerd Moellmann's avatar
Gerd Moellmann committed
1149 1150 1151 1152
the symbol @code{mode-line}, @code{header-line}, or
@code{vertical-line}.  For the mode line, @var{y} does not have
meaningful data.  For the vertical line, @var{x} does not have
meaningful data.
Richard M. Stallman's avatar
Richard M. Stallman committed
1153

1154 1155 1156 1157
In one special case, @var{buffer-pos} is a list containing a symbol (one
of the symbols listed above) instead of just the symbol.  This happens
after the imaginary prefix keys for the event are inserted into the
input stream.  @xref{Key Sequence Input}.
Richard M. Stallman's avatar
Richard M. Stallman committed
1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172

@node Drag Events
@subsection Drag Events
@cindex drag event
@cindex mouse drag event

With Emacs, you can have a drag event without even changing your
clothes.  A @dfn{drag event} happens every time the user presses a mouse
button and then moves the mouse to a different character position before
releasing the button.  Like all mouse events, drag events are
represented in Lisp as lists.  The lists record both the starting mouse
position and the final position, like this:

@example
(@var{event-type}
1173 1174
 (@var{window1} @var{buffer-pos1} (@var{x1} . @var{y1}) @var{timestamp1})
 (@var{window2} @var{buffer-pos2} (@var{x2} . @var{y2}) @var{timestamp2})
Richard M. Stallman's avatar
Richard M. Stallman committed
1175 1176 1177 1178
 @var{click-count})
@end example

For a drag event, the name of the symbol @var{event-type} contains the
1179 1180 1181 1182 1183 1184 1185
prefix @samp{drag-}.  For example, dragging the mouse with button 2 held
down generates a @code{drag-mouse-2} event.  The second and third
elements of the event give the starting and ending position of the drag.
Aside from that, the data have the same meanings as in a click event
(@pxref{Click Events}).  You can access the second element of any mouse
event in the same way, with no need to distinguish drag events from
others.
Richard M. Stallman's avatar
Richard M. Stallman committed
1186 1187 1188 1189

The @samp{drag-} prefix follows the modifier key prefixes such as
@samp{C-} and @samp{M-}.

1190
If @code{read-key-sequence} receives a drag event that has no key
Richard M. Stallman's avatar
Richard M. Stallman committed
1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205
binding, and the corresponding click event does have a binding, it
changes the drag event into a click event at the drag's starting
position.  This means that you don't have to distinguish between click
and drag events unless you want to.

@node Button-Down Events
@subsection Button-Down Events
@cindex button-down event

Click and drag events happen when the user releases a mouse button.
They cannot happen earlier, because there is no way to distinguish a
click from a drag until the button is released.

If you want to take action as soon as a button is pressed, you need to
handle @dfn{button-down} events.@footnote{Button-down is the
1206
conservative antithesis of drag.}  These occur as soon as a button is
1207
pressed.  They are represented by lists that look exactly like click
1208 1209
events (@pxref{Click Events}), except that the @var{event-type} symbol
name contains the prefix @samp{down-}.  The @samp{down-} prefix follows
Richard M. Stallman's avatar
Richard M. Stallman committed
1210 1211
modifier key prefixes such as @samp{C-} and @samp{M-}.

1212 1213 1214 1215 1216 1217 1218
The function @code{read-key-sequence} ignores any button-down events
that don't have command bindings; therefore, the Emacs command loop
ignores them too.  This means that you need not worry about defining
button-down events unless you want them to do something.  The usual
reason to define a button-down event is so that you can track mouse
motion (by reading motion events) until the button is released.
@xref{Motion Events}.
Richard M. Stallman's avatar
Richard M. Stallman committed
1219 1220 1221 1222 1223 1224

@node Repeat Events
@subsection Repeat Events
@cindex repeat events
@cindex double-click events
@cindex triple-click events
1225
@cindex mouse events, repeated
Richard M. Stallman's avatar
Richard M. Stallman committed
1226 1227

If you press the same mouse button more than once in quick succession
1228 1229
without moving the mouse, Emacs generates special @dfn{repeat} mouse
events for the second and subsequent presses.
Richard M. Stallman's avatar
Richard M. Stallman committed
1230 1231 1232 1233 1234 1235 1236

The most common repeat events are @dfn{double-click} events.  Emacs
generates a double-click event when you click a button twice; the event
happens when you release the button (as is normal for all click
events).

The event type of a double-click event contains the prefix
1237
@samp{double-}.  Thus, a double click on the second mouse button with
Richard M. Stallman's avatar
Richard M. Stallman committed
1238 1239 1240 1241 1242 1243 1244
@key{meta} held down comes to the Lisp program as
@code{M-double-mouse-2}.  If a double-click event has no binding, the
binding of the corresponding ordinary click event is used to execute
it.  Thus, you need not pay attention to the double click feature 
unless you really want to.

When the user performs a double click, Emacs generates first an ordinary
1245 1246
click event, and then a double-click event.  Therefore, you must design
the command binding of the double click event to assume that the
Richard M. Stallman's avatar
Richard M. Stallman committed
1247 1248 1249
single-click command has already run.  It must produce the desired
results of a double click, starting from the results of a single click.

1250 1251 1252
This is convenient, if the meaning of a double click somehow ``builds
on'' the meaning of a single click---which is recommended user interface
design practice for double clicks.
Richard M. Stallman's avatar
Richard M. Stallman committed
1253 1254 1255 1256 1257 1258

If you click a button, then press it down again and start moving the
mouse with the button held down, then you get a @dfn{double-drag} event
when you ultimately release the button.  Its event type contains
@samp{double-drag} instead of just @samp{drag}.  If a double-drag event
has no binding, Emacs looks for an alternate binding as if the event
1259
were an ordinary drag.
Richard M. Stallman's avatar
Richard M. Stallman committed
1260 1261

Before the double-click or double-drag event, Emacs generates a
1262 1263
@dfn{double-down} event when the user presses the button down for the
second time.  Its event type contains @samp{double-down} instead of just
Richard M. Stallman's avatar
Richard M. Stallman committed
1264 1265
@samp{down}.  If a double-down event has no binding, Emacs looks for an
alternate binding as if the event were an ordinary button-down event.
1266 1267
If it finds no binding that way either, the double-down event is
ignored.
Richard M. Stallman's avatar
Richard M. Stallman committed
1268 1269

To summarize, when you click a button and then press it again right
1270 1271 1272
away, Emacs generates a down event and a click event for the first
click, a double-down event when you press the button again, and finally
either a double-click or a double-drag event.
Richard M. Stallman's avatar
Richard M. Stallman committed
1273 1274 1275 1276 1277 1278 1279 1280

If you click a button twice and then press it again, all in quick
succession, Emacs generates a @dfn{triple-down} event, followed by
either a @dfn{triple-click} or a @dfn{triple-drag}.  The event types of
these events contain @samp{triple} instead of @samp{double}.  If any
triple event has no binding, Emacs uses the binding that it would use
for the corresponding double event.

1281 1282 1283 1284 1285
If you click a button three or more times and then press it again, the
events for the presses beyond the third are all triple events.  Emacs
does not have separate event types for quadruple, quintuple, etc.@:
events.  However, you can look at the event list to find out precisely
how many times the button was pressed.
Richard M. Stallman's avatar
Richard M. Stallman committed
1286 1287 1288 1289 1290 1291 1292 1293 1294

@defun event-click-count event
This function returns the number of consecutive button presses that led
up to @var{event}.  If @var{event} is a double-down, double-click or
double-drag event, the value is 2.  If @var{event} is a triple event,
the value is 3 or greater.  If @var{event} is an ordinary mouse event
(not a repeat event), the value is 1.
@end defun

1295
@defvar double-click-fuzz
1296
To generate repeat events, successive mouse button presses must be at
1297 1298 1299 1300 1301 1302 1303 1304
approximately the same screen position.  The value of
@code{double-click-fuzz} specifies the maximum number of pixels the
mouse may be moved between two successive clicks to make a
double-click.
@end defvar

@defvar double-click-time
To generate repeat events, the number of milliseconds between
1305
successive button presses must be less than the value of
Richard M. Stallman's avatar
Richard M. Stallman committed
1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321
@code{double-click-time}.  Setting @code{double-click-time} to
@code{nil} disables multi-click detection entirely.  Setting it to
@code{t} removes the time limit; Emacs then detects multi-clicks by
position only.
@end defvar

@node Motion Events
@subsection Motion Events
@cindex motion event
@cindex mouse motion events

Emacs sometimes generates @dfn{mouse motion} events to describe motion
of the mouse without any button activity.  Mouse motion events are
represented by lists that look like this:

@example
1322
(mouse-movement (@var{window} @var{buffer-pos} (@var{x} . @var{y}) @var{timestamp}))