Commit | Line | Data |
---|---|---|
8db970a4 RS |
1 | @c -*-texinfo-*- |
2 | @c This is part of the GNU Emacs Lisp Reference Manual. | |
5504e99c | 3 | @c Copyright (C) 1990, 1991, 1992, 1993, 1994, 1995, 1998, 1999, 2004 |
177c0ea7 | 4 | @c Free Software Foundation, Inc. |
8db970a4 RS |
5 | @c See the file elisp.texi for copying conditions. |
6 | @setfilename ../info/commands | |
7 | @node Command Loop, Keymaps, Minibuffers, Top | |
8 | @chapter Command Loop | |
9 | @cindex editor command loop | |
10 | @cindex command loop | |
11 | ||
12 | When you run Emacs, it enters the @dfn{editor command loop} almost | |
13 | immediately. This loop reads key sequences, executes their definitions, | |
14 | and displays the results. In this chapter, we describe how these things | |
177c0ea7 | 15 | are done, and the subroutines that allow Lisp programs to do them. |
8db970a4 RS |
16 | |
17 | @menu | |
18 | * Command Overview:: How the command loop reads commands. | |
19 | * Defining Commands:: Specifying how a function should read arguments. | |
20 | * Interactive Call:: Calling a command, so that it will read arguments. | |
21 | * Command Loop Info:: Variables set by the command loop for you to examine. | |
2468d0c0 | 22 | * Adjusting Point:: Adjustment of point after a command. |
8db970a4 RS |
23 | * Input Events:: What input looks like when you read it. |
24 | * Reading Input:: How to read input events from the keyboard or mouse. | |
f9f59935 | 25 | * Special Events:: Events processed immediately and individually. |
8db970a4 RS |
26 | * Waiting:: Waiting for user input or elapsed time. |
27 | * Quitting:: How @kbd{C-g} works. How to catch or defer quitting. | |
28 | * Prefix Command Arguments:: How the commands to set prefix args work. | |
29 | * Recursive Editing:: Entering a recursive edit, | |
30 | and why you usually shouldn't. | |
31 | * Disabling Commands:: How the command loop handles disabled commands. | |
32 | * Command History:: How the command history is set up, and how accessed. | |
33 | * Keyboard Macros:: How keyboard macros are implemented. | |
34 | @end menu | |
35 | ||
36 | @node Command Overview | |
37 | @section Command Loop Overview | |
38 | ||
39 | The first thing the command loop must do is read a key sequence, which | |
40 | is a sequence of events that translates into a command. It does this by | |
41 | calling the function @code{read-key-sequence}. Your Lisp code can also | |
42 | call this function (@pxref{Key Sequence Input}). Lisp programs can also | |
43 | do input at a lower level with @code{read-event} (@pxref{Reading One | |
44 | Event}) or discard pending input with @code{discard-input} | |
f142f62a | 45 | (@pxref{Event Input Misc}). |
8db970a4 RS |
46 | |
47 | The key sequence is translated into a command through the currently | |
48 | active keymaps. @xref{Key Lookup}, for information on how this is done. | |
49 | The result should be a keyboard macro or an interactively callable | |
50 | function. If the key is @kbd{M-x}, then it reads the name of another | |
f142f62a | 51 | command, which it then calls. This is done by the command |
8db970a4 RS |
52 | @code{execute-extended-command} (@pxref{Interactive Call}). |
53 | ||
f142f62a RS |
54 | To execute a command requires first reading the arguments for it. |
55 | This is done by calling @code{command-execute} (@pxref{Interactive | |
56 | Call}). For commands written in Lisp, the @code{interactive} | |
57 | specification says how to read the arguments. This may use the prefix | |
58 | argument (@pxref{Prefix Command Arguments}) or may read with prompting | |
59 | in the minibuffer (@pxref{Minibuffers}). For example, the command | |
60 | @code{find-file} has an @code{interactive} specification which says to | |
61 | read a file name using the minibuffer. The command's function body does | |
62 | not use the minibuffer; if you call this command from Lisp code as a | |
63 | function, you must supply the file name string as an ordinary Lisp | |
64 | function argument. | |
8db970a4 RS |
65 | |
66 | If the command is a string or vector (i.e., a keyboard macro) then | |
67 | @code{execute-kbd-macro} is used to execute it. You can call this | |
68 | function yourself (@pxref{Keyboard Macros}). | |
69 | ||
f142f62a RS |
70 | To terminate the execution of a running command, type @kbd{C-g}. This |
71 | character causes @dfn{quitting} (@pxref{Quitting}). | |
8db970a4 RS |
72 | |
73 | @defvar pre-command-hook | |
f142f62a RS |
74 | The editor command loop runs this normal hook before each command. At |
75 | that time, @code{this-command} contains the command that is about to | |
76 | run, and @code{last-command} describes the previous command. | |
ecbfc7e9 | 77 | @xref{Command Loop Info}. |
8db970a4 RS |
78 | @end defvar |
79 | ||
80 | @defvar post-command-hook | |
f142f62a RS |
81 | The editor command loop runs this normal hook after each command |
82 | (including commands terminated prematurely by quitting or by errors), | |
83 | and also when the command loop is first entered. At that time, | |
ecbfc7e9 RS |
84 | @code{this-command} refers to the command that just ran, and |
85 | @code{last-command} refers to the command before that. | |
8db970a4 RS |
86 | @end defvar |
87 | ||
b22f3a19 | 88 | Quitting is suppressed while running @code{pre-command-hook} and |
bfe721d1 | 89 | @code{post-command-hook}. If an error happens while executing one of |
f9f59935 RS |
90 | these hooks, it terminates execution of the hook, and clears the hook |
91 | variable to @code{nil} so as to prevent an infinite loop of errors. | |
b22f3a19 | 92 | |
14bd0b09 RS |
93 | A request coming into the Emacs server (@pxref{Emacs Server,,, |
94 | emacs, The GNU Emacs Manual}) runs these two hooks just as a keyboard | |
95 | command does. | |
96 | ||
8db970a4 RS |
97 | @node Defining Commands |
98 | @section Defining Commands | |
99 | @cindex defining commands | |
100 | @cindex commands, defining | |
101 | @cindex functions, making them interactive | |
102 | @cindex interactive function | |
103 | ||
104 | A Lisp function becomes a command when its body contains, at top | |
b22f3a19 | 105 | level, a form that calls the special form @code{interactive}. This |
8db970a4 RS |
106 | form does nothing when actually executed, but its presence serves as a |
107 | flag to indicate that interactive calling is permitted. Its argument | |
108 | controls the reading of arguments for an interactive call. | |
109 | ||
110 | @menu | |
111 | * Using Interactive:: General rules for @code{interactive}. | |
112 | * Interactive Codes:: The standard letter-codes for reading arguments | |
113 | in various ways. | |
114 | * Interactive Examples:: Examples of how to read interactive arguments. | |
115 | @end menu | |
116 | ||
117 | @node Using Interactive | |
118 | @subsection Using @code{interactive} | |
119 | ||
120 | This section describes how to write the @code{interactive} form that | |
2842de30 | 121 | makes a Lisp function an interactively-callable command, and how to |
5504e99c | 122 | examine a command's @code{interactive} form. |
8db970a4 RS |
123 | |
124 | @defspec interactive arg-descriptor | |
125 | @cindex argument descriptors | |
126 | This special form declares that the function in which it appears is a | |
127 | command, and that it may therefore be called interactively (via | |
128 | @kbd{M-x} or by entering a key sequence bound to it). The argument | |
f142f62a RS |
129 | @var{arg-descriptor} declares how to compute the arguments to the |
130 | command when the command is called interactively. | |
8db970a4 RS |
131 | |
132 | A command may be called from Lisp programs like any other function, but | |
f142f62a RS |
133 | then the caller supplies the arguments and @var{arg-descriptor} has no |
134 | effect. | |
8db970a4 RS |
135 | |
136 | The @code{interactive} form has its effect because the command loop | |
137 | (actually, its subroutine @code{call-interactively}) scans through the | |
138 | function definition looking for it, before calling the function. Once | |
139 | the function is called, all its body forms including the | |
140 | @code{interactive} form are executed, but at this time | |
141 | @code{interactive} simply returns @code{nil} without even evaluating its | |
142 | argument. | |
143 | @end defspec | |
144 | ||
145 | There are three possibilities for the argument @var{arg-descriptor}: | |
146 | ||
147 | @itemize @bullet | |
148 | @item | |
149 | It may be omitted or @code{nil}; then the command is called with no | |
150 | arguments. This leads quickly to an error if the command requires one | |
151 | or more arguments. | |
152 | ||
153 | @item | |
154 | It may be a Lisp expression that is not a string; then it should be a | |
155 | form that is evaluated to get a list of arguments to pass to the | |
156 | command. | |
157 | @cindex argument evaluation form | |
158 | ||
3a2485be RS |
159 | If this expression reads keyboard input (this includes using the |
160 | minibuffer), keep in mind that the integer value of point or the mark | |
161 | before reading input may be incorrect after reading input. This is | |
162 | because the current buffer may be receiving subprocess output; | |
163 | if subprocess output arrives while the command is waiting for input, | |
164 | it could relocate point and the mark. | |
165 | ||
166 | Here's an example of what @emph{not} to do: | |
167 | ||
168 | @smallexample | |
169 | (interactive | |
170 | (list (region-beginning) (region-end) | |
171 | (read-string "Foo: " nil 'my-history))) | |
172 | @end smallexample | |
173 | ||
174 | @noindent | |
175 | Here's how to avoid the problem, by examining point and the mark only | |
176 | after reading the keyboard input: | |
177 | ||
178 | @smallexample | |
179 | (interactive | |
180 | (let ((string (read-string "Foo: " nil 'my-history))) | |
181 | (list (region-beginning) (region-end) string))) | |
182 | @end smallexample | |
183 | ||
8db970a4 RS |
184 | @item |
185 | @cindex argument prompt | |
186 | It may be a string; then its contents should consist of a code character | |
187 | followed by a prompt (which some code characters use and some ignore). | |
188 | The prompt ends either with the end of the string or with a newline. | |
189 | Here is a simple example: | |
190 | ||
191 | @smallexample | |
192 | (interactive "bFrobnicate buffer: ") | |
193 | @end smallexample | |
194 | ||
195 | @noindent | |
196 | The code letter @samp{b} says to read the name of an existing buffer, | |
197 | with completion. The buffer name is the sole argument passed to the | |
198 | command. The rest of the string is a prompt. | |
199 | ||
200 | If there is a newline character in the string, it terminates the prompt. | |
201 | If the string does not end there, then the rest of the string should | |
202 | contain another code character and prompt, specifying another argument. | |
203 | You can specify any number of arguments in this way. | |
204 | ||
205 | @c Emacs 19 feature | |
206 | The prompt string can use @samp{%} to include previous argument values | |
b22f3a19 RS |
207 | (starting with the first argument) in the prompt. This is done using |
208 | @code{format} (@pxref{Formatting Strings}). For example, here is how | |
209 | you could read the name of an existing buffer followed by a new name to | |
210 | give to that buffer: | |
8db970a4 RS |
211 | |
212 | @smallexample | |
213 | @group | |
214 | (interactive "bBuffer to rename: \nsRename buffer %s to: ") | |
215 | @end group | |
216 | @end smallexample | |
217 | ||
caae20c7 | 218 | @cindex @samp{*} in @code{interactive} |
f142f62a | 219 | @cindex read-only buffers in interactive |
8db970a4 RS |
220 | If the first character in the string is @samp{*}, then an error is |
221 | signaled if the buffer is read-only. | |
222 | ||
caae20c7 | 223 | @cindex @samp{@@} in @code{interactive} |
8db970a4 RS |
224 | @c Emacs 19 feature |
225 | If the first character in the string is @samp{@@}, and if the key | |
226 | sequence used to invoke the command includes any mouse events, then | |
227 | the window associated with the first of those events is selected | |
228 | before the command is run. | |
229 | ||
230 | You can use @samp{*} and @samp{@@} together; the order does not matter. | |
231 | Actual reading of arguments is controlled by the rest of the prompt | |
232 | string (starting with the first character that is not @samp{*} or | |
233 | @samp{@@}). | |
234 | @end itemize | |
235 | ||
caae20c7 | 236 | @cindex examining the @code{interactive} form |
2842de30 | 237 | @defun interactive-form function |
5504e99c LT |
238 | This function returns the @code{interactive} form of @var{function}. |
239 | If @var{function} is an interactively callable function | |
240 | (@pxref{Interactive Call}), the value is the command's | |
241 | @code{interactive} form @code{(interactive @var{spec})}, which | |
242 | specifies how to compute its arguments. Otherwise, the value is | |
243 | @code{nil}. If @var{function} is a symbol, its function definition is | |
244 | used. | |
2842de30 EZ |
245 | @end defun |
246 | ||
8db970a4 RS |
247 | @node Interactive Codes |
248 | @comment node-name, next, previous, up | |
249 | @subsection Code Characters for @code{interactive} | |
250 | @cindex interactive code description | |
251 | @cindex description for interactive codes | |
252 | @cindex codes, interactive, description of | |
253 | @cindex characters for interactive codes | |
254 | ||
255 | The code character descriptions below contain a number of key words, | |
256 | defined here as follows: | |
257 | ||
258 | @table @b | |
259 | @item Completion | |
260 | @cindex interactive completion | |
261 | Provide completion. @key{TAB}, @key{SPC}, and @key{RET} perform name | |
262 | completion because the argument is read using @code{completing-read} | |
263 | (@pxref{Completion}). @kbd{?} displays a list of possible completions. | |
264 | ||
265 | @item Existing | |
266 | Require the name of an existing object. An invalid name is not | |
267 | accepted; the commands to exit the minibuffer do not exit if the current | |
268 | input is not valid. | |
269 | ||
270 | @item Default | |
271 | @cindex default argument string | |
272 | A default value of some sort is used if the user enters no text in the | |
273 | minibuffer. The default depends on the code character. | |
274 | ||
275 | @item No I/O | |
276 | This code letter computes an argument without reading any input. | |
277 | Therefore, it does not use a prompt string, and any prompt string you | |
278 | supply is ignored. | |
279 | ||
f142f62a RS |
280 | Even though the code letter doesn't use a prompt string, you must follow |
281 | it with a newline if it is not the last code character in the string. | |
282 | ||
8db970a4 RS |
283 | @item Prompt |
284 | A prompt immediately follows the code character. The prompt ends either | |
285 | with the end of the string or with a newline. | |
286 | ||
287 | @item Special | |
288 | This code character is meaningful only at the beginning of the | |
289 | interactive string, and it does not look for a prompt or a newline. | |
290 | It is a single, isolated character. | |
291 | @end table | |
292 | ||
293 | @cindex reading interactive arguments | |
294 | Here are the code character descriptions for use with @code{interactive}: | |
295 | ||
296 | @table @samp | |
297 | @item * | |
298 | Signal an error if the current buffer is read-only. Special. | |
299 | ||
300 | @item @@ | |
301 | Select the window mentioned in the first mouse event in the key | |
302 | sequence that invoked this command. Special. | |
303 | ||
304 | @item a | |
b22f3a19 | 305 | A function name (i.e., a symbol satisfying @code{fboundp}). Existing, |
8db970a4 RS |
306 | Completion, Prompt. |
307 | ||
308 | @item b | |
309 | The name of an existing buffer. By default, uses the name of the | |
310 | current buffer (@pxref{Buffers}). Existing, Completion, Default, | |
311 | Prompt. | |
312 | ||
313 | @item B | |
314 | A buffer name. The buffer need not exist. By default, uses the name of | |
315 | a recently used buffer other than the current buffer. Completion, | |
b22f3a19 | 316 | Default, Prompt. |
8db970a4 RS |
317 | |
318 | @item c | |
319 | A character. The cursor does not move into the echo area. Prompt. | |
320 | ||
321 | @item C | |
322 | A command name (i.e., a symbol satisfying @code{commandp}). Existing, | |
323 | Completion, Prompt. | |
324 | ||
325 | @item d | |
326 | @cindex position argument | |
f142f62a | 327 | The position of point, as an integer (@pxref{Point}). No I/O. |
8db970a4 RS |
328 | |
329 | @item D | |
330 | A directory name. The default is the current default directory of the | |
e35e07df | 331 | current buffer, @code{default-directory} (@pxref{File Name Expansion}). |
8db970a4 RS |
332 | Existing, Completion, Default, Prompt. |
333 | ||
334 | @item e | |
335 | The first or next mouse event in the key sequence that invoked the command. | |
b22f3a19 | 336 | More precisely, @samp{e} gets events that are lists, so you can look at |
8db970a4 RS |
337 | the data in the lists. @xref{Input Events}. No I/O. |
338 | ||
339 | You can use @samp{e} more than once in a single command's interactive | |
b22f3a19 | 340 | specification. If the key sequence that invoked the command has |
f142f62a | 341 | @var{n} events that are lists, the @var{n}th @samp{e} provides the |
b22f3a19 | 342 | @var{n}th such event. Events that are not lists, such as function keys |
ad800164 | 343 | and @acronym{ASCII} characters, do not count where @samp{e} is concerned. |
8db970a4 | 344 | |
8db970a4 RS |
345 | @item f |
346 | A file name of an existing file (@pxref{File Names}). The default | |
347 | directory is @code{default-directory}. Existing, Completion, Default, | |
348 | Prompt. | |
349 | ||
350 | @item F | |
351 | A file name. The file need not exist. Completion, Default, Prompt. | |
352 | ||
9644814c RS |
353 | @item G |
354 | A file name. The file need not exist. If the user enters just a | |
355 | directory name, then the value is just that directory name, with no | |
356 | file name within the directory added. Completion, Default, Prompt. | |
357 | ||
a9f0a989 RS |
358 | @item i |
359 | An irrelevant argument. This code always supplies @code{nil} as | |
360 | the argument's value. No I/O. | |
361 | ||
8db970a4 RS |
362 | @item k |
363 | A key sequence (@pxref{Keymap Terminology}). This keeps reading events | |
364 | until a command (or undefined command) is found in the current key | |
365 | maps. The key sequence argument is represented as a string or vector. | |
366 | The cursor does not move into the echo area. Prompt. | |
367 | ||
3baa952d KS |
368 | If the key sequence is a down-event, the following up-event is discarded, |
369 | but can be read via the @code{U} code character. | |
370 | ||
8db970a4 RS |
371 | This kind of input is used by commands such as @code{describe-key} and |
372 | @code{global-set-key}. | |
373 | ||
22697dac KH |
374 | @item K |
375 | A key sequence, whose definition you intend to change. This works like | |
376 | @samp{k}, except that it suppresses, for the last input event in the key | |
377 | sequence, the conversions that are normally used (when necessary) to | |
378 | convert an undefined key into a defined one. | |
379 | ||
8db970a4 RS |
380 | @item m |
381 | @cindex marker argument | |
f142f62a | 382 | The position of the mark, as an integer. No I/O. |
8db970a4 | 383 | |
f9f59935 RS |
384 | @item M |
385 | Arbitrary text, read in the minibuffer using the current buffer's input | |
386 | method, and returned as a string (@pxref{Input Methods,,, emacs, The GNU | |
387 | Emacs Manual}). Prompt. | |
388 | ||
8db970a4 | 389 | @item n |
dff3f9e1 RS |
390 | A number, read with the minibuffer. If the input is not a number, the |
391 | user has to try again. @samp{n} never uses the prefix argument. | |
8db970a4 RS |
392 | Prompt. |
393 | ||
394 | @item N | |
dff3f9e1 RS |
395 | The numeric prefix argument; but if there is no prefix argument, read |
396 | a number as with @kbd{n}. The value is always a number. @xref{Prefix | |
397 | Command Arguments}. Prompt. | |
8db970a4 RS |
398 | |
399 | @item p | |
400 | @cindex numeric prefix argument usage | |
401 | The numeric prefix argument. (Note that this @samp{p} is lower case.) | |
b22f3a19 | 402 | No I/O. |
8db970a4 RS |
403 | |
404 | @item P | |
dff3f9e1 | 405 | @cindex raw prefix argument usage |
b22f3a19 RS |
406 | The raw prefix argument. (Note that this @samp{P} is upper case.) No |
407 | I/O. | |
8db970a4 RS |
408 | |
409 | @item r | |
410 | @cindex region argument | |
411 | Point and the mark, as two numeric arguments, smallest first. This is | |
412 | the only code letter that specifies two successive arguments rather than | |
413 | one. No I/O. | |
414 | ||
415 | @item s | |
416 | Arbitrary text, read in the minibuffer and returned as a string | |
417 | (@pxref{Text from Minibuffer}). Terminate the input with either | |
969fe9b5 | 418 | @kbd{C-j} or @key{RET}. (@kbd{C-q} may be used to include either of |
8db970a4 RS |
419 | these characters in the input.) Prompt. |
420 | ||
421 | @item S | |
422 | An interned symbol whose name is read in the minibuffer. Any whitespace | |
423 | character terminates the input. (Use @kbd{C-q} to include whitespace in | |
424 | the string.) Other characters that normally terminate a symbol (e.g., | |
425 | parentheses and brackets) do not do so here. Prompt. | |
426 | ||
3baa952d | 427 | @item U |
f9597b5b | 428 | A key sequence or @code{nil}. May be used after a @code{k} or @code{K} |
3baa952d KS |
429 | argument to get the up-event that was discarded in case the key |
430 | sequence read for that argument was a down-event. No I/O. | |
431 | ||
8db970a4 | 432 | @item v |
5504e99c LT |
433 | A variable declared to be a user option (i.e., satisfying the |
434 | predicate @code{user-variable-p}). This reads the variable using | |
435 | @code{read-variable}. @xref{Definition of read-variable}. Existing, | |
8db970a4 RS |
436 | Completion, Prompt. |
437 | ||
438 | @item x | |
b22f3a19 | 439 | A Lisp object, specified with its read syntax, terminated with a |
969fe9b5 | 440 | @kbd{C-j} or @key{RET}. The object is not evaluated. @xref{Object from |
8db970a4 RS |
441 | Minibuffer}. Prompt. |
442 | ||
443 | @item X | |
444 | @cindex evaluated expression argument | |
445 | A Lisp form is read as with @kbd{x}, but then evaluated so that its | |
446 | value becomes the argument for the command. Prompt. | |
a9f0a989 RS |
447 | |
448 | @item z | |
449 | A coding system name (a symbol). If the user enters null input, the | |
450 | argument value is @code{nil}. @xref{Coding Systems}. Completion, | |
451 | Existing, Prompt. | |
452 | ||
453 | @item Z | |
454 | A coding system name (a symbol)---but only if this command has a prefix | |
455 | argument. With no prefix argument, @samp{Z} provides @code{nil} as the | |
456 | argument value. Completion, Existing, Prompt. | |
8db970a4 RS |
457 | @end table |
458 | ||
459 | @node Interactive Examples | |
460 | @comment node-name, next, previous, up | |
461 | @subsection Examples of Using @code{interactive} | |
462 | @cindex examples of using @code{interactive} | |
177c0ea7 | 463 | @cindex @code{interactive}, examples of using |
8db970a4 RS |
464 | |
465 | Here are some examples of @code{interactive}: | |
466 | ||
467 | @example | |
468 | @group | |
469 | (defun foo1 () ; @r{@code{foo1} takes no arguments,} | |
470 | (interactive) ; @r{just moves forward two words.} | |
471 | (forward-word 2)) | |
472 | @result{} foo1 | |
473 | @end group | |
474 | ||
475 | @group | |
476 | (defun foo2 (n) ; @r{@code{foo2} takes one argument,} | |
477 | (interactive "p") ; @r{which is the numeric prefix.} | |
478 | (forward-word (* 2 n))) | |
479 | @result{} foo2 | |
480 | @end group | |
481 | ||
482 | @group | |
483 | (defun foo3 (n) ; @r{@code{foo3} takes one argument,} | |
484 | (interactive "nCount:") ; @r{which is read with the Minibuffer.} | |
485 | (forward-word (* 2 n))) | |
486 | @result{} foo3 | |
487 | @end group | |
488 | ||
489 | @group | |
490 | (defun three-b (b1 b2 b3) | |
491 | "Select three existing buffers. | |
492 | Put them into three windows, selecting the last one." | |
493 | @end group | |
494 | (interactive "bBuffer1:\nbBuffer2:\nbBuffer3:") | |
495 | (delete-other-windows) | |
496 | (split-window (selected-window) 8) | |
497 | (switch-to-buffer b1) | |
498 | (other-window 1) | |
499 | (split-window (selected-window) 8) | |
500 | (switch-to-buffer b2) | |
501 | (other-window 1) | |
502 | (switch-to-buffer b3)) | |
503 | @result{} three-b | |
504 | @group | |
505 | (three-b "*scratch*" "declarations.texi" "*mail*") | |
506 | @result{} nil | |
507 | @end group | |
508 | @end example | |
509 | ||
510 | @node Interactive Call | |
511 | @section Interactive Call | |
512 | @cindex interactive call | |
513 | ||
f9f59935 RS |
514 | After the command loop has translated a key sequence into a command it |
515 | invokes that command using the function @code{command-execute}. If the | |
516 | command is a function, @code{command-execute} calls | |
517 | @code{call-interactively}, which reads the arguments and calls the | |
518 | command. You can also call these functions yourself. | |
8db970a4 | 519 | |
041b0e7b | 520 | @defun commandp object &optional for-call-interactively |
8db970a4 | 521 | Returns @code{t} if @var{object} is suitable for calling interactively; |
177c0ea7 | 522 | that is, if @var{object} is a command. Otherwise, returns @code{nil}. |
8db970a4 RS |
523 | |
524 | The interactively callable objects include strings and vectors (treated | |
525 | as keyboard macros), lambda expressions that contain a top-level call to | |
bfe721d1 | 526 | @code{interactive}, byte-code function objects made from such lambda |
f142f62a RS |
527 | expressions, autoload objects that are declared as interactive |
528 | (non-@code{nil} fourth argument to @code{autoload}), and some of the | |
529 | primitive functions. | |
8db970a4 | 530 | |
041b0e7b RS |
531 | A symbol satisfies @code{commandp} if its function definition |
532 | satisfies @code{commandp}. Keys and keymaps are not commands. | |
533 | Rather, they are used to look up commands (@pxref{Keymaps}). | |
8db970a4 | 534 | |
041b0e7b RS |
535 | If @var{for-call-interactively} is non-@code{nil}, then |
536 | @code{commandp} returns @code{t} only for objects that | |
537 | @code{call-interactively} could call---thus, not for keyboard macros. | |
8db970a4 RS |
538 | |
539 | See @code{documentation} in @ref{Accessing Documentation}, for a | |
540 | realistic example of using @code{commandp}. | |
541 | @end defun | |
542 | ||
f9f59935 | 543 | @defun call-interactively command &optional record-flag keys |
8db970a4 RS |
544 | This function calls the interactively callable function @var{command}, |
545 | reading arguments according to its interactive calling specifications. | |
5504e99c LT |
546 | It returns whatever @var{command} returns. An error is signaled if |
547 | @var{command} is not a function or if it cannot be called | |
548 | interactively (i.e., is not a command). Note that keyboard macros | |
549 | (strings and vectors) are not accepted, even though they are | |
550 | considered commands, because they are not functions. If @var{command} | |
551 | is a symbol, then @code{call-interactively} uses its function definition. | |
8db970a4 RS |
552 | |
553 | @cindex record command history | |
554 | If @var{record-flag} is non-@code{nil}, then this command and its | |
555 | arguments are unconditionally added to the list @code{command-history}. | |
556 | Otherwise, the command is added only if it uses the minibuffer to read | |
557 | an argument. @xref{Command History}. | |
f9f59935 RS |
558 | |
559 | The argument @var{keys}, if given, specifies the sequence of events to | |
969fe9b5 | 560 | supply if the command inquires which events were used to invoke it. |
5504e99c LT |
561 | If @var{keys} is omitted or @code{nil}, the return value of |
562 | @code{this-command-keys} is used. @xref{Definition of this-command-keys}. | |
8db970a4 RS |
563 | @end defun |
564 | ||
79ddc9c9 | 565 | @defun command-execute command &optional record-flag keys special |
8db970a4 | 566 | @cindex keyboard macro execution |
f9f59935 RS |
567 | This function executes @var{command}. The argument @var{command} must |
568 | satisfy the @code{commandp} predicate; i.e., it must be an interactively | |
569 | callable function or a keyboard macro. | |
8db970a4 RS |
570 | |
571 | A string or vector as @var{command} is executed with | |
572 | @code{execute-kbd-macro}. A function is passed to | |
5504e99c LT |
573 | @code{call-interactively}, along with the optional @var{record-flag} |
574 | and @var{keys}. | |
8db970a4 RS |
575 | |
576 | A symbol is handled by using its function definition in its place. A | |
577 | symbol with an @code{autoload} definition counts as a command if it was | |
578 | declared to stand for an interactively callable function. Such a | |
579 | definition is handled by loading the specified library and then | |
580 | rechecking the definition of the symbol. | |
f9f59935 | 581 | |
79ddc9c9 GM |
582 | The argument @var{special}, if given, means to ignore the prefix |
583 | argument and not clear it. This is used for executing special events | |
584 | (@pxref{Special Events}). | |
8db970a4 RS |
585 | @end defun |
586 | ||
587 | @deffn Command execute-extended-command prefix-argument | |
588 | @cindex read command name | |
589 | This function reads a command name from the minibuffer using | |
590 | @code{completing-read} (@pxref{Completion}). Then it uses | |
591 | @code{command-execute} to call the specified command. Whatever that | |
592 | command returns becomes the value of @code{execute-extended-command}. | |
593 | ||
594 | @cindex execute with prefix argument | |
f142f62a RS |
595 | If the command asks for a prefix argument, it receives the value |
596 | @var{prefix-argument}. If @code{execute-extended-command} is called | |
597 | interactively, the current raw prefix argument is used for | |
8db970a4 RS |
598 | @var{prefix-argument}, and thus passed on to whatever command is run. |
599 | ||
600 | @c !!! Should this be @kindex? | |
601 | @cindex @kbd{M-x} | |
602 | @code{execute-extended-command} is the normal definition of @kbd{M-x}, | |
603 | so it uses the string @w{@samp{M-x }} as a prompt. (It would be better | |
604 | to take the prompt from the events used to invoke | |
605 | @code{execute-extended-command}, but that is painful to implement.) A | |
606 | description of the value of the prefix argument, if any, also becomes | |
607 | part of the prompt. | |
608 | ||
609 | @example | |
610 | @group | |
611 | (execute-extended-command 1) | |
612 | ---------- Buffer: Minibuffer ---------- | |
b22f3a19 | 613 | 1 M-x forward-word RET |
8db970a4 RS |
614 | ---------- Buffer: Minibuffer ---------- |
615 | @result{} t | |
616 | @end group | |
617 | @end example | |
618 | @end deffn | |
619 | ||
620 | @defun interactive-p | |
dff3f9e1 RS |
621 | This function returns @code{t} if the containing function (the one |
622 | whose code includes the call to @code{interactive-p}) was called in | |
623 | direct response to user input. This means that it was called with the | |
624 | function @code{call-interactively}, and that a keyboard macro is | |
9d0d1070 | 625 | not running, and that Emacs is not running in batch mode. |
dff3f9e1 RS |
626 | |
627 | If the containing function was called by Lisp evaluation (or with | |
628 | @code{apply} or @code{funcall}), then it was not called interactively. | |
969fe9b5 | 629 | @end defun |
8db970a4 | 630 | |
dff3f9e1 RS |
631 | The most common use of @code{interactive-p} is for deciding whether |
632 | to give the user additional visual feedback (such as by printing an | |
633 | informative message). For example: | |
8db970a4 RS |
634 | |
635 | @example | |
636 | @group | |
dff3f9e1 | 637 | ;; @r{Here's the usual way to use @code{interactive-p}.} |
8db970a4 RS |
638 | (defun foo () |
639 | (interactive) | |
969fe9b5 RS |
640 | (when (interactive-p) |
641 | (message "foo"))) | |
8db970a4 RS |
642 | @result{} foo |
643 | @end group | |
644 | ||
645 | @group | |
dff3f9e1 | 646 | ;; @r{This function is just to illustrate the behavior.} |
8db970a4 RS |
647 | (defun bar () |
648 | (interactive) | |
649 | (setq foobar (list (foo) (interactive-p)))) | |
650 | @result{} bar | |
651 | @end group | |
652 | ||
653 | @group | |
654 | ;; @r{Type @kbd{M-x foo}.} | |
655 | @print{} foo | |
656 | @end group | |
657 | ||
658 | @group | |
659 | ;; @r{Type @kbd{M-x bar}.} | |
dff3f9e1 | 660 | ;; @r{This does not display a message.} |
8db970a4 RS |
661 | @end group |
662 | ||
663 | @group | |
664 | foobar | |
665 | @result{} (nil t) | |
666 | @end group | |
667 | @end example | |
969fe9b5 | 668 | |
dff3f9e1 RS |
669 | If you want to test @emph{only} whether the function was called |
670 | using @code{call-interactively}, add an optional argument | |
671 | @code{print-message} which should be non-@code{nil} in an interactive | |
672 | call, and use the @code{interactive} spec to make sure it is | |
673 | non-@code{nil}. Here's an example: | |
969fe9b5 RS |
674 | |
675 | @example | |
676 | (defun foo (&optional print-message) | |
677 | (interactive "p") | |
678 | (when print-message | |
679 | (message "foo"))) | |
680 | @end example | |
681 | ||
8e5f9510 | 682 | @noindent |
dff3f9e1 RS |
683 | Defined in this way, the function does display the message when called |
684 | from a keyboard macro. We use @code{"p"} because the numeric prefix | |
685 | argument is never @code{nil}. | |
8db970a4 | 686 | |
9d0d1070 RS |
687 | @defun called-interactively-p |
688 | This function returns @code{t} when the calling function was called | |
689 | using @code{call-interactively}. | |
690 | ||
691 | When possible, instead of using this function, you should use the | |
692 | method in the example above; that method makes it possible for a | |
693 | caller to ``pretend'' that the function was called interactively. | |
694 | @end defun | |
695 | ||
8db970a4 RS |
696 | @node Command Loop Info |
697 | @comment node-name, next, previous, up | |
698 | @section Information from the Command Loop | |
699 | ||
700 | The editor command loop sets several Lisp variables to keep status | |
177c0ea7 | 701 | records for itself and for commands that are run. |
8db970a4 RS |
702 | |
703 | @defvar last-command | |
704 | This variable records the name of the previous command executed by the | |
705 | command loop (the one before the current command). Normally the value | |
706 | is a symbol with a function definition, but this is not guaranteed. | |
707 | ||
f142f62a | 708 | The value is copied from @code{this-command} when a command returns to |
f9f59935 RS |
709 | the command loop, except when the command has specified a prefix |
710 | argument for the following command. | |
bfe721d1 KH |
711 | |
712 | This variable is always local to the current terminal and cannot be | |
713 | buffer-local. @xref{Multiple Displays}. | |
8db970a4 RS |
714 | @end defvar |
715 | ||
03c6b7f6 RS |
716 | @defvar real-last-command |
717 | This variable is set up by Emacs just like @code{last-command}, | |
718 | but never altered by Lisp programs. | |
719 | @end defvar | |
720 | ||
8db970a4 RS |
721 | @defvar this-command |
722 | @cindex current command | |
723 | This variable records the name of the command now being executed by | |
724 | the editor command loop. Like @code{last-command}, it is normally a symbol | |
725 | with a function definition. | |
726 | ||
f142f62a RS |
727 | The command loop sets this variable just before running a command, and |
728 | copies its value into @code{last-command} when the command finishes | |
f9f59935 | 729 | (unless the command specified a prefix argument for the following |
f142f62a | 730 | command). |
8db970a4 RS |
731 | |
732 | @cindex kill command repetition | |
f142f62a | 733 | Some commands set this variable during their execution, as a flag for |
bfe721d1 | 734 | whatever command runs next. In particular, the functions for killing text |
f142f62a RS |
735 | set @code{this-command} to @code{kill-region} so that any kill commands |
736 | immediately following will know to append the killed text to the | |
737 | previous kill. | |
8db970a4 RS |
738 | @end defvar |
739 | ||
740 | If you do not want a particular command to be recognized as the previous | |
741 | command in the case where it got an error, you must code that command to | |
742 | prevent this. One way is to set @code{this-command} to @code{t} at the | |
743 | beginning of the command, and set @code{this-command} back to its proper | |
744 | value at the end, like this: | |
745 | ||
746 | @example | |
747 | (defun foo (args@dots{}) | |
748 | (interactive @dots{}) | |
749 | (let ((old-this-command this-command)) | |
750 | (setq this-command t) | |
751 | @r{@dots{}do the work@dots{}} | |
752 | (setq this-command old-this-command))) | |
753 | @end example | |
754 | ||
f9f59935 RS |
755 | @noindent |
756 | We do not bind @code{this-command} with @code{let} because that would | |
757 | restore the old value in case of error---a feature of @code{let} which | |
758 | in this case does precisely what we want to avoid. | |
759 | ||
041b0e7b RS |
760 | @defvar this-original-command |
761 | This has the same value as @code{this-command} except when command | |
762 | remapping occurs (@pxref{Remapping Commands}). In that case, | |
763 | @code{this-command} gives the command actually run (the result of | |
764 | remapping), and @code{this-original-command} gives the command that | |
765 | was specified to run but remapped into another command. | |
766 | @end defvar | |
767 | ||
8db970a4 | 768 | @defun this-command-keys |
5504e99c | 769 | @anchor{Definition of this-command-keys} |
8db970a4 RS |
770 | This function returns a string or vector containing the key sequence |
771 | that invoked the present command, plus any previous commands that | |
5504e99c LT |
772 | generated the prefix argument for this command. However, if the |
773 | command has called @code{read-key-sequence}, it returns the last read | |
de700726 LT |
774 | key sequence. @xref{Key Sequence Input}. The value is a string if |
775 | all events in the sequence were characters that fit in a string. | |
776 | @xref{Input Events}. | |
8db970a4 RS |
777 | |
778 | @example | |
779 | @group | |
780 | (this-command-keys) | |
b22f3a19 | 781 | ;; @r{Now use @kbd{C-u C-x C-e} to evaluate that.} |
8db970a4 RS |
782 | @result{} "^U^X^E" |
783 | @end group | |
784 | @end example | |
785 | @end defun | |
786 | ||
969fe9b5 | 787 | @defun this-command-keys-vector |
2468d0c0 DL |
788 | Like @code{this-command-keys}, except that it always returns the events |
789 | in a vector, so you don't need to deal with the complexities of storing | |
790 | input events in a string (@pxref{Strings of Events}). | |
969fe9b5 RS |
791 | @end defun |
792 | ||
b6954afd | 793 | @tindex clear-this-command-keys |
5504e99c | 794 | @defun clear-this-command-keys &optional keep-record |
b6954afd | 795 | This function empties out the table of events for |
5504e99c LT |
796 | @code{this-command-keys} to return. Unless @var{keep-record} is |
797 | non-@code{nil}, it also empties the records that the function | |
798 | @code{recent-keys} (@pxref{Recording Input}) will subsequently return. | |
799 | This is useful after reading a password, to prevent the password from | |
800 | echoing inadvertently as part of the next command in certain cases. | |
b6954afd RS |
801 | @end defun |
802 | ||
8db970a4 | 803 | @defvar last-nonmenu-event |
969fe9b5 RS |
804 | This variable holds the last input event read as part of a key sequence, |
805 | not counting events resulting from mouse menus. | |
8db970a4 | 806 | |
f9f59935 | 807 | One use of this variable is for telling @code{x-popup-menu} where to pop |
969fe9b5 RS |
808 | up a menu. It is also used internally by @code{y-or-n-p} |
809 | (@pxref{Yes-or-No Queries}). | |
8db970a4 RS |
810 | @end defvar |
811 | ||
812 | @defvar last-command-event | |
813 | @defvarx last-command-char | |
814 | This variable is set to the last input event that was read by the | |
815 | command loop as part of a command. The principal use of this variable | |
816 | is in @code{self-insert-command}, which uses it to decide which | |
817 | character to insert. | |
818 | ||
819 | @example | |
820 | @group | |
f142f62a | 821 | last-command-event |
b22f3a19 | 822 | ;; @r{Now use @kbd{C-u C-x C-e} to evaluate that.} |
8db970a4 RS |
823 | @result{} 5 |
824 | @end group | |
825 | @end example | |
826 | ||
827 | @noindent | |
ad800164 | 828 | The value is 5 because that is the @acronym{ASCII} code for @kbd{C-e}. |
8db970a4 RS |
829 | |
830 | The alias @code{last-command-char} exists for compatibility with | |
831 | Emacs version 18. | |
832 | @end defvar | |
833 | ||
834 | @c Emacs 19 feature | |
835 | @defvar last-event-frame | |
836 | This variable records which frame the last input event was directed to. | |
837 | Usually this is the frame that was selected when the event was | |
838 | generated, but if that frame has redirected input focus to another | |
839 | frame, the value is the frame to which the event was redirected. | |
840 | @xref{Input Focus}. | |
5504e99c LT |
841 | |
842 | If the last event came from a keyboard macro, the value is @code{macro}. | |
8db970a4 RS |
843 | @end defvar |
844 | ||
2468d0c0 DL |
845 | @node Adjusting Point |
846 | @section Adjusting Point After Commands | |
847 | ||
ecbfc7e9 RS |
848 | It is not easy to display a value of point in the middle of a |
849 | sequence of text that has the @code{display}, @code{composition} or | |
850 | @code{intangible} property, or is invisible. Therefore, after a | |
851 | command finishes and returns to the command loop, if point is within | |
852 | such a sequence, the command loop normally moves point to the edge of | |
853 | the sequence. | |
2468d0c0 DL |
854 | |
855 | A command can inhibit this feature by setting the variable | |
856 | @code{disable-point-adjustment}: | |
857 | ||
858 | @defvar disable-point-adjustment | |
859 | @tindex disable-point-adjustment | |
ecbfc7e9 RS |
860 | If this variable is non-@code{nil} when a command returns to the |
861 | command loop, then the command loop does not check for those text | |
862 | properties, and does not move point out of sequences that have them. | |
2468d0c0 DL |
863 | |
864 | The command loop sets this variable to @code{nil} before each command, | |
865 | so if a command sets it, the effect applies only to that command. | |
866 | @end defvar | |
867 | ||
868 | @defvar global-disable-point-adjustment | |
869 | @tindex global-disable-point-adjustment | |
870 | If you set this variable to a non-@code{nil} value, the feature of | |
871 | moving point out of these sequences is completely turned off. | |
872 | @end defvar | |
873 | ||
8db970a4 RS |
874 | @node Input Events |
875 | @section Input Events | |
876 | @cindex events | |
877 | @cindex input events | |
878 | ||
879 | The Emacs command loop reads a sequence of @dfn{input events} that | |
880 | represent keyboard or mouse activity. The events for keyboard activity | |
881 | are characters or symbols; mouse events are always lists. This section | |
882 | describes the representation and meaning of input events in detail. | |
883 | ||
8db970a4 | 884 | @defun eventp object |
a9f0a989 RS |
885 | This function returns non-@code{nil} if @var{object} is an input event |
886 | or event type. | |
887 | ||
888 | Note that any symbol might be used as an event or an event type. | |
889 | @code{eventp} cannot distinguish whether a symbol is intended by Lisp | |
890 | code to be used as an event. Instead, it distinguishes whether the | |
891 | symbol has actually been used in an event that has been read as input in | |
892 | the current Emacs session. If a symbol has not yet been so used, | |
893 | @code{eventp} returns @code{nil}. | |
8db970a4 RS |
894 | @end defun |
895 | ||
896 | @menu | |
897 | * Keyboard Events:: Ordinary characters--keys with symbols on them. | |
898 | * Function Keys:: Function keys--keys with names, not symbols. | |
f142f62a | 899 | * Mouse Events:: Overview of mouse events. |
8db970a4 RS |
900 | * Click Events:: Pushing and releasing a mouse button. |
901 | * Drag Events:: Moving the mouse before releasing the button. | |
902 | * Button-Down Events:: A button was pushed and not yet released. | |
903 | * Repeat Events:: Double and triple click (or drag, or down). | |
904 | * Motion Events:: Just moving the mouse, not pushing a button. | |
905 | * Focus Events:: Moving the mouse between frames. | |
7790d5cd | 906 | * Misc Events:: Other events the system can generate. |
8db970a4 RS |
907 | * Event Examples:: Examples of the lists for mouse events. |
908 | * Classifying Events:: Finding the modifier keys in an event symbol. | |
909 | Event types. | |
910 | * Accessing Events:: Functions to extract info from events. | |
911 | * Strings of Events:: Special considerations for putting | |
912 | keyboard character events in a string. | |
913 | @end menu | |
914 | ||
915 | @node Keyboard Events | |
916 | @subsection Keyboard Events | |
917 | ||
918 | There are two kinds of input you can get from the keyboard: ordinary | |
919 | keys, and function keys. Ordinary keys correspond to characters; the | |
969fe9b5 RS |
920 | events they generate are represented in Lisp as characters. The event |
921 | type of a character event is the character itself (an integer); see | |
922 | @ref{Classifying Events}. | |
8db970a4 RS |
923 | |
924 | @cindex modifier bits (of input character) | |
925 | @cindex basic code (of input character) | |
926 | An input character event consists of a @dfn{basic code} between 0 and | |
f9f59935 | 927 | 524287, plus any or all of these @dfn{modifier bits}: |
8db970a4 RS |
928 | |
929 | @table @asis | |
930 | @item meta | |
bfe721d1 | 931 | The |
969fe9b5 | 932 | @tex |
8241495d | 933 | @math{2^{27}} |
969fe9b5 | 934 | @end tex |
37680279 | 935 | @ifnottex |
bfe721d1 | 936 | 2**27 |
37680279 | 937 | @end ifnottex |
bfe721d1 | 938 | bit in the character code indicates a character |
8db970a4 RS |
939 | typed with the meta key held down. |
940 | ||
941 | @item control | |
bfe721d1 | 942 | The |
969fe9b5 | 943 | @tex |
8241495d | 944 | @math{2^{26}} |
969fe9b5 | 945 | @end tex |
37680279 | 946 | @ifnottex |
bfe721d1 | 947 | 2**26 |
37680279 | 948 | @end ifnottex |
ad800164 | 949 | bit in the character code indicates a non-@acronym{ASCII} |
8db970a4 RS |
950 | control character. |
951 | ||
8241495d | 952 | @sc{ascii} control characters such as @kbd{C-a} have special basic |
8db970a4 RS |
953 | codes of their own, so Emacs needs no special bit to indicate them. |
954 | Thus, the code for @kbd{C-a} is just 1. | |
955 | ||
ad800164 | 956 | But if you type a control combination not in @acronym{ASCII}, such as |
8db970a4 | 957 | @kbd{%} with the control key, the numeric value you get is the code |
bfe721d1 | 958 | for @kbd{%} plus |
969fe9b5 | 959 | @tex |
8241495d | 960 | @math{2^{26}} |
969fe9b5 | 961 | @end tex |
37680279 | 962 | @ifnottex |
bfe721d1 | 963 | 2**26 |
37680279 | 964 | @end ifnottex |
ad800164 | 965 | (assuming the terminal supports non-@acronym{ASCII} |
8db970a4 RS |
966 | control characters). |
967 | ||
968 | @item shift | |
bfe721d1 | 969 | The |
969fe9b5 | 970 | @tex |
8241495d | 971 | @math{2^{25}} |
969fe9b5 | 972 | @end tex |
37680279 | 973 | @ifnottex |
bfe721d1 | 974 | 2**25 |
37680279 | 975 | @end ifnottex |
ad800164 | 976 | bit in the character code indicates an @acronym{ASCII} control |
8db970a4 RS |
977 | character typed with the shift key held down. |
978 | ||
f9f59935 RS |
979 | For letters, the basic code itself indicates upper versus lower case; |
980 | for digits and punctuation, the shift key selects an entirely different | |
981 | character with a different basic code. In order to keep within the | |
ad800164 | 982 | @acronym{ASCII} character set whenever possible, Emacs avoids using the |
969fe9b5 | 983 | @tex |
8241495d | 984 | @math{2^{25}} |
969fe9b5 | 985 | @end tex |
37680279 | 986 | @ifnottex |
bfe721d1 | 987 | 2**25 |
37680279 | 988 | @end ifnottex |
bfe721d1 | 989 | bit for those characters. |
8db970a4 | 990 | |
ad800164 | 991 | However, @acronym{ASCII} provides no way to distinguish @kbd{C-A} from |
bfe721d1 | 992 | @kbd{C-a}, so Emacs uses the |
969fe9b5 | 993 | @tex |
8241495d | 994 | @math{2^{25}} |
969fe9b5 | 995 | @end tex |
37680279 | 996 | @ifnottex |
bfe721d1 | 997 | 2**25 |
37680279 | 998 | @end ifnottex |
bfe721d1 | 999 | bit in @kbd{C-A} and not in |
8db970a4 RS |
1000 | @kbd{C-a}. |
1001 | ||
1002 | @item hyper | |
bfe721d1 | 1003 | The |
969fe9b5 | 1004 | @tex |
8241495d | 1005 | @math{2^{24}} |
969fe9b5 | 1006 | @end tex |
37680279 | 1007 | @ifnottex |
bfe721d1 | 1008 | 2**24 |
37680279 | 1009 | @end ifnottex |
bfe721d1 | 1010 | bit in the character code indicates a character |
8db970a4 RS |
1011 | typed with the hyper key held down. |
1012 | ||
1013 | @item super | |
bfe721d1 | 1014 | The |
969fe9b5 | 1015 | @tex |
8241495d | 1016 | @math{2^{23}} |
969fe9b5 | 1017 | @end tex |
37680279 | 1018 | @ifnottex |
bfe721d1 | 1019 | 2**23 |
37680279 | 1020 | @end ifnottex |
bfe721d1 | 1021 | bit in the character code indicates a character |
8db970a4 RS |
1022 | typed with the super key held down. |
1023 | ||
1024 | @item alt | |
bfe721d1 | 1025 | The |
969fe9b5 | 1026 | @tex |
8241495d | 1027 | @math{2^{22}} |
969fe9b5 | 1028 | @end tex |
37680279 | 1029 | @ifnottex |
bfe721d1 | 1030 | 2**22 |
37680279 | 1031 | @end ifnottex |
bfe721d1 | 1032 | bit in the character code indicates a character typed with |
8db970a4 RS |
1033 | the alt key held down. (On some terminals, the key labeled @key{ALT} |
1034 | is actually the meta key.) | |
1035 | @end table | |
1036 | ||
bfe721d1 KH |
1037 | It is best to avoid mentioning specific bit numbers in your program. |
1038 | To test the modifier bits of a character, use the function | |
1039 | @code{event-modifiers} (@pxref{Classifying Events}). When making key | |
1040 | bindings, you can use the read syntax for characters with modifier bits | |
1041 | (@samp{\C-}, @samp{\M-}, and so on). For making key bindings with | |
1042 | @code{define-key}, you can use lists such as @code{(control hyper ?x)} to | |
1043 | specify the characters (@pxref{Changing Key Bindings}). The function | |
1044 | @code{event-convert-list} converts such a list into an event type | |
1045 | (@pxref{Classifying Events}). | |
8db970a4 RS |
1046 | |
1047 | @node Function Keys | |
1048 | @subsection Function Keys | |
1049 | ||
1050 | @cindex function keys | |
b22f3a19 | 1051 | Most keyboards also have @dfn{function keys}---keys that have names or |
f9f59935 RS |
1052 | symbols that are not characters. Function keys are represented in Emacs |
1053 | Lisp as symbols; the symbol's name is the function key's label, in lower | |
f142f62a RS |
1054 | case. For example, pressing a key labeled @key{F1} places the symbol |
1055 | @code{f1} in the input stream. | |
8db970a4 | 1056 | |
f142f62a RS |
1057 | The event type of a function key event is the event symbol itself. |
1058 | @xref{Classifying Events}. | |
8db970a4 | 1059 | |
b22f3a19 | 1060 | Here are a few special cases in the symbol-naming convention for |
8db970a4 RS |
1061 | function keys: |
1062 | ||
1063 | @table @asis | |
1064 | @item @code{backspace}, @code{tab}, @code{newline}, @code{return}, @code{delete} | |
ad800164 | 1065 | These keys correspond to common @acronym{ASCII} control characters that have |
8db970a4 RS |
1066 | special keys on most keyboards. |
1067 | ||
ad800164 | 1068 | In @acronym{ASCII}, @kbd{C-i} and @key{TAB} are the same character. If the |
f142f62a RS |
1069 | terminal can distinguish between them, Emacs conveys the distinction to |
1070 | Lisp programs by representing the former as the integer 9, and the | |
1071 | latter as the symbol @code{tab}. | |
8db970a4 RS |
1072 | |
1073 | Most of the time, it's not useful to distinguish the two. So normally | |
4324b7ab RS |
1074 | @code{function-key-map} (@pxref{Translating Input}) is set up to map |
1075 | @code{tab} into 9. Thus, a key binding for character code 9 (the | |
1076 | character @kbd{C-i}) also applies to @code{tab}. Likewise for the other | |
1077 | symbols in this group. The function @code{read-char} likewise converts | |
1078 | these events into characters. | |
8db970a4 | 1079 | |
ad800164 | 1080 | In @acronym{ASCII}, @key{BS} is really @kbd{C-h}. But @code{backspace} |
8db970a4 RS |
1081 | converts into the character code 127 (@key{DEL}), not into code 8 |
1082 | (@key{BS}). This is what most users prefer. | |
1083 | ||
b22f3a19 RS |
1084 | @item @code{left}, @code{up}, @code{right}, @code{down} |
1085 | Cursor arrow keys | |
8db970a4 RS |
1086 | @item @code{kp-add}, @code{kp-decimal}, @code{kp-divide}, @dots{} |
1087 | Keypad keys (to the right of the regular keyboard). | |
1088 | @item @code{kp-0}, @code{kp-1}, @dots{} | |
1089 | Keypad keys with digits. | |
1090 | @item @code{kp-f1}, @code{kp-f2}, @code{kp-f3}, @code{kp-f4} | |
1091 | Keypad PF keys. | |
b22f3a19 | 1092 | @item @code{kp-home}, @code{kp-left}, @code{kp-up}, @code{kp-right}, @code{kp-down} |
f9f59935 RS |
1093 | Keypad arrow keys. Emacs normally translates these into the |
1094 | corresponding non-keypad keys @code{home}, @code{left}, @dots{} | |
b22f3a19 RS |
1095 | @item @code{kp-prior}, @code{kp-next}, @code{kp-end}, @code{kp-begin}, @code{kp-insert}, @code{kp-delete} |
1096 | Additional keypad duplicates of keys ordinarily found elsewhere. Emacs | |
1097 | normally translates these into the like-named non-keypad keys. | |
8db970a4 RS |
1098 | @end table |
1099 | ||
b22f3a19 RS |
1100 | You can use the modifier keys @key{ALT}, @key{CTRL}, @key{HYPER}, |
1101 | @key{META}, @key{SHIFT}, and @key{SUPER} with function keys. The way to | |
1102 | represent them is with prefixes in the symbol name: | |
8db970a4 RS |
1103 | |
1104 | @table @samp | |
1105 | @item A- | |
1106 | The alt modifier. | |
1107 | @item C- | |
1108 | The control modifier. | |
1109 | @item H- | |
1110 | The hyper modifier. | |
1111 | @item M- | |
1112 | The meta modifier. | |
1113 | @item S- | |
1114 | The shift modifier. | |
1115 | @item s- | |
1116 | The super modifier. | |
1117 | @end table | |
1118 | ||
1119 | Thus, the symbol for the key @key{F3} with @key{META} held down is | |
8609b2e2 | 1120 | @code{M-f3}. When you use more than one prefix, we recommend you |
f142f62a RS |
1121 | write them in alphabetical order; but the order does not matter in |
1122 | arguments to the key-binding lookup and modification functions. | |
1123 | ||
1124 | @node Mouse Events | |
1125 | @subsection Mouse Events | |
1126 | ||
1127 | Emacs supports four kinds of mouse events: click events, drag events, | |
1128 | button-down events, and motion events. All mouse events are represented | |
4bdcd3ef | 1129 | as lists. The @sc{car} of the list is the event type; this says which |
f142f62a RS |
1130 | mouse button was involved, and which modifier keys were used with it. |
1131 | The event type can also distinguish double or triple button presses | |
1132 | (@pxref{Repeat Events}). The rest of the list elements give position | |
1133 | and time information. | |
1134 | ||
1135 | For key lookup, only the event type matters: two events of the same type | |
1136 | necessarily run the same command. The command can access the full | |
1137 | values of these events using the @samp{e} interactive code. | |
1138 | @xref{Interactive Codes}. | |
1139 | ||
1140 | A key sequence that starts with a mouse event is read using the keymaps | |
1141 | of the buffer in the window that the mouse was in, not the current | |
1142 | buffer. This does not imply that clicking in a window selects that | |
1143 | window or its buffer---that is entirely under the control of the command | |
1144 | binding of the key sequence. | |
8db970a4 RS |
1145 | |
1146 | @node Click Events | |
1147 | @subsection Click Events | |
1148 | @cindex click event | |
1149 | @cindex mouse click event | |
1150 | ||
1151 | When the user presses a mouse button and releases it at the same | |
c5cb5297 KS |
1152 | location, that generates a @dfn{click} event. All mouse click event |
1153 | share the same format: | |
8db970a4 RS |
1154 | |
1155 | @example | |
c5cb5297 | 1156 | (@var{event-type} @var{position} @var{click-count}) |
b19f34c7 GM |
1157 | @end example |
1158 | ||
f142f62a RS |
1159 | @table @asis |
1160 | @item @var{event-type} | |
8db970a4 RS |
1161 | This is a symbol that indicates which mouse button was used. It is |
1162 | one of the symbols @code{mouse-1}, @code{mouse-2}, @dots{}, where the | |
f142f62a | 1163 | buttons are numbered left to right. |
8db970a4 RS |
1164 | |
1165 | You can also use prefixes @samp{A-}, @samp{C-}, @samp{H-}, @samp{M-}, | |
1166 | @samp{S-} and @samp{s-} for modifiers alt, control, hyper, meta, shift | |
1167 | and super, just as you would with function keys. | |
1168 | ||
1169 | This symbol also serves as the event type of the event. Key bindings | |
1170 | describe events by their types; thus, if there is a key binding for | |
1171 | @code{mouse-1}, that binding would apply to all events whose | |
1172 | @var{event-type} is @code{mouse-1}. | |
1173 | ||
c5cb5297 KS |
1174 | @item @var{position} |
1175 | This is the position where the mouse click occurred. The actual | |
1176 | format of @var{position} depends on what part of a window was clicked | |
1177 | on. The various formats are described below. | |
1178 | ||
1179 | @item @var{click-count} | |
1180 | This is the number of rapid repeated presses so far of the same mouse | |
1181 | button. @xref{Repeat Events}. | |
1182 | @end table | |
1183 | ||
1184 | For mouse click events in the text area, mode line, header line, or in | |
1185 | the marginal areas, @var{position} has this form: | |
1186 | ||
1187 | @example | |
f51f93f6 | 1188 | (@var{window} @var{pos-or-area} (@var{x} . @var{y}) @var{timestamp} |
5504e99c | 1189 | @var{object} @var{text-pos} (@var{col} . @var{row}) |
08988329 | 1190 | @var{image} (@var{dx} . @var{dy}) (@var{width} . @var{height})) |
c5cb5297 KS |
1191 | @end example |
1192 | ||
1193 | @table @asis | |
f142f62a | 1194 | @item @var{window} |
8db970a4 RS |
1195 | This is the window in which the click occurred. |
1196 | ||
c5cb5297 KS |
1197 | @item @var{pos-or-area} |
1198 | This is the buffer position of the character clicked on in the text | |
1199 | area, or if clicked outside the text area, it is the window area in | |
1200 | which the click occurred. It is one of the symbols @code{mode-line}, | |
1201 | @code{header-line}, @code{vertical-line}, @code{left-margin}, | |
1202 | @code{right-margin}, @code{left-fringe}, or @code{right-fringe}. | |
1203 | ||
f142f62a | 1204 | @item @var{x}, @var{y} |
b22f3a19 | 1205 | These are the pixel-denominated coordinates of the click, relative to |
07734718 | 1206 | the top left corner of @var{window}, which is @code{(0 . 0)}. |
c5cb5297 KS |
1207 | For the mode or header line, @var{y} does not have meaningful data. |
1208 | For the vertical line, @var{x} does not have meaningful data. | |
8db970a4 | 1209 | |
f142f62a | 1210 | @item @var{timestamp} |
c5cb5297 KS |
1211 | This is the time at which the event occurred, in milliseconds. |
1212 | ||
1213 | @item @var{object} | |
f51f93f6 | 1214 | This is the object on which the click occurred. It is either |
08988329 KS |
1215 | @code{nil} if there is no string property, or it has the form |
1216 | (@var{string} . @var{string-pos}) when there is a string-type text | |
1217 | property at the click position. | |
b19f34c7 GM |
1218 | |
1219 | @item @var{string} | |
1220 | This is the string on which the click occurred, including any | |
07734718 | 1221 | properties. |
b19f34c7 GM |
1222 | |
1223 | @item @var{string-pos} | |
1224 | This is the position in the string on which the click occurred, | |
1225 | relevant if properties at the click need to be looked up. | |
8db970a4 | 1226 | |
c5cb5297 KS |
1227 | @item @var{text-pos} |
1228 | For clicks on a marginal area or on a fringe, this is the buffer | |
1229 | position of the first visible character in the corresponding line in | |
1230 | the window. For other events, it is the current buffer position in | |
1231 | the window. | |
1232 | ||
1233 | @item @var{col}, @var{row} | |
1234 | These are the actual coordinates of the glyph under the @var{x}, | |
1235 | @var{y} position, possibly padded with default character width | |
1236 | glyphs if @var{x} is beyond the last glyph on the line. | |
f51f93f6 | 1237 | |
08988329 KS |
1238 | @item @var{image} |
1239 | This is the image object on which the click occurred. It is either | |
1240 | @code{nil} if there is no image at the position clicked on, or it is | |
1241 | an image object as returned by @code{find-image} if click was in an image. | |
1242 | ||
f51f93f6 KS |
1243 | @item @var{dx}, @var{dy} |
1244 | These are the pixel-denominated coordinates of the click, relative to | |
1245 | the top left corner of @var{object}, which is @code{(0 . 0)}. If | |
1246 | @var{object} is @code{nil}, the coordinates are relative to the top | |
1247 | left corner of the character glyph clicked on. | |
8db970a4 RS |
1248 | @end table |
1249 | ||
c5cb5297 KS |
1250 | For mouse clicks on a scroll-bar, @var{position} has this form: |
1251 | ||
1252 | @example | |
1253 | (@var{window} @var{area} (@var{portion} . @var{whole}) @var{timestamp} @var{part}) | |
1254 | @end example | |
1255 | ||
1256 | @table @asis | |
1257 | @item @var{window} | |
1258 | This is the window whose scroll-bar was clicked on. | |
1259 | ||
1260 | @item @var{area} | |
1261 | This is the scroll bar where the click occurred. It is one of the | |
1262 | symbols @code{vertical-scroll-bar} or @code{horizontal-scroll-bar}. | |
1263 | ||
1264 | @item @var{portion} | |
1265 | This is the distance of the click from the top or left end of | |
1266 | the scroll bar. | |
1267 | ||
1268 | @item @var{whole} | |
1269 | This is the length of the entire scroll bar. | |
1270 | ||
1271 | @item @var{timestamp} | |
1272 | This is the time at which the event occurred, in milliseconds. | |
1273 | ||
1274 | @item @var{part} | |
1275 | This is the part of the scroll-bar which was clicked on. It is one | |
1276 | of the symbols @code{above-handle}, @code{handle}, @code{below-handle}, | |
1277 | @code{up}, @code{down}, @code{top}, @code{bottom}, and @code{end-scroll}. | |
1278 | @end table | |
8db970a4 | 1279 | |
b22f3a19 RS |
1280 | In one special case, @var{buffer-pos} is a list containing a symbol (one |
1281 | of the symbols listed above) instead of just the symbol. This happens | |
1282 | after the imaginary prefix keys for the event are inserted into the | |
1283 | input stream. @xref{Key Sequence Input}. | |
8db970a4 RS |
1284 | |
1285 | @node Drag Events | |
1286 | @subsection Drag Events | |
1287 | @cindex drag event | |
1288 | @cindex mouse drag event | |
1289 | ||
1290 | With Emacs, you can have a drag event without even changing your | |
1291 | clothes. A @dfn{drag event} happens every time the user presses a mouse | |
1292 | button and then moves the mouse to a different character position before | |
1293 | releasing the button. Like all mouse events, drag events are | |
1294 | represented in Lisp as lists. The lists record both the starting mouse | |
1295 | position and the final position, like this: | |
1296 | ||
1297 | @example | |
1298 | (@var{event-type} | |
f142f62a RS |
1299 | (@var{window1} @var{buffer-pos1} (@var{x1} . @var{y1}) @var{timestamp1}) |
1300 | (@var{window2} @var{buffer-pos2} (@var{x2} . @var{y2}) @var{timestamp2}) | |
8db970a4 RS |
1301 | @var{click-count}) |
1302 | @end example | |
1303 | ||
1304 | For a drag event, the name of the symbol @var{event-type} contains the | |
f9f59935 RS |
1305 | prefix @samp{drag-}. For example, dragging the mouse with button 2 held |
1306 | down generates a @code{drag-mouse-2} event. The second and third | |
1307 | elements of the event give the starting and ending position of the drag. | |
1308 | Aside from that, the data have the same meanings as in a click event | |
1309 | (@pxref{Click Events}). You can access the second element of any mouse | |
1310 | event in the same way, with no need to distinguish drag events from | |
1311 | others. | |
8db970a4 RS |
1312 | |
1313 | The @samp{drag-} prefix follows the modifier key prefixes such as | |
1314 | @samp{C-} and @samp{M-}. | |
1315 | ||
b22f3a19 | 1316 | If @code{read-key-sequence} receives a drag event that has no key |
8db970a4 RS |
1317 | binding, and the corresponding click event does have a binding, it |
1318 | changes the drag event into a click event at the drag's starting | |
1319 | position. This means that you don't have to distinguish between click | |
1320 | and drag events unless you want to. | |
1321 | ||
1322 | @node Button-Down Events | |
1323 | @subsection Button-Down Events | |
1324 | @cindex button-down event | |
1325 | ||
1326 | Click and drag events happen when the user releases a mouse button. | |
1327 | They cannot happen earlier, because there is no way to distinguish a | |
1328 | click from a drag until the button is released. | |
1329 | ||
1330 | If you want to take action as soon as a button is pressed, you need to | |
1331 | handle @dfn{button-down} events.@footnote{Button-down is the | |
f142f62a | 1332 | conservative antithesis of drag.} These occur as soon as a button is |
b22f3a19 | 1333 | pressed. They are represented by lists that look exactly like click |
f142f62a RS |
1334 | events (@pxref{Click Events}), except that the @var{event-type} symbol |
1335 | name contains the prefix @samp{down-}. The @samp{down-} prefix follows | |
8db970a4 RS |
1336 | modifier key prefixes such as @samp{C-} and @samp{M-}. |
1337 | ||
969fe9b5 RS |
1338 | The function @code{read-key-sequence} ignores any button-down events |
1339 | that don't have command bindings; therefore, the Emacs command loop | |
1340 | ignores them too. This means that you need not worry about defining | |
1341 | button-down events unless you want them to do something. The usual | |
1342 | reason to define a button-down event is so that you can track mouse | |
1343 | motion (by reading motion events) until the button is released. | |
1344 | @xref{Motion Events}. | |
8db970a4 RS |
1345 | |
1346 | @node Repeat Events | |
1347 | @subsection Repeat Events | |
1348 | @cindex repeat events | |
1349 | @cindex double-click events | |
1350 | @cindex triple-click events | |
2468d0c0 | 1351 | @cindex mouse events, repeated |
8db970a4 RS |
1352 | |
1353 | If you press the same mouse button more than once in quick succession | |
f142f62a RS |
1354 | without moving the mouse, Emacs generates special @dfn{repeat} mouse |
1355 | events for the second and subsequent presses. | |
8db970a4 RS |
1356 | |
1357 | The most common repeat events are @dfn{double-click} events. Emacs | |
1358 | generates a double-click event when you click a button twice; the event | |
1359 | happens when you release the button (as is normal for all click | |
1360 | events). | |
1361 | ||
1362 | The event type of a double-click event contains the prefix | |
f142f62a | 1363 | @samp{double-}. Thus, a double click on the second mouse button with |
8db970a4 RS |
1364 | @key{meta} held down comes to the Lisp program as |
1365 | @code{M-double-mouse-2}. If a double-click event has no binding, the | |
1366 | binding of the corresponding ordinary click event is used to execute | |
177c0ea7 | 1367 | it. Thus, you need not pay attention to the double click feature |
8db970a4 RS |
1368 | unless you really want to. |
1369 | ||
1370 | When the user performs a double click, Emacs generates first an ordinary | |
f142f62a RS |
1371 | click event, and then a double-click event. Therefore, you must design |
1372 | the command binding of the double click event to assume that the | |
8db970a4 RS |
1373 | single-click command has already run. It must produce the desired |
1374 | results of a double click, starting from the results of a single click. | |
1375 | ||
f142f62a RS |
1376 | This is convenient, if the meaning of a double click somehow ``builds |
1377 | on'' the meaning of a single click---which is recommended user interface | |
1378 | design practice for double clicks. | |
8db970a4 RS |
1379 | |
1380 | If you click a button, then press it down again and start moving the | |
1381 | mouse with the button held down, then you get a @dfn{double-drag} event | |
1382 | when you ultimately release the button. Its event type contains | |
1383 | @samp{double-drag} instead of just @samp{drag}. If a double-drag event | |
1384 | has no binding, Emacs looks for an alternate binding as if the event | |
b22f3a19 | 1385 | were an ordinary drag. |
8db970a4 RS |
1386 | |
1387 | Before the double-click or double-drag event, Emacs generates a | |
f142f62a RS |
1388 | @dfn{double-down} event when the user presses the button down for the |
1389 | second time. Its event type contains @samp{double-down} instead of just | |
8db970a4 RS |
1390 | @samp{down}. If a double-down event has no binding, Emacs looks for an |
1391 | alternate binding as if the event were an ordinary button-down event. | |
f142f62a RS |
1392 | If it finds no binding that way either, the double-down event is |
1393 | ignored. | |
8db970a4 RS |
1394 | |
1395 | To summarize, when you click a button and then press it again right | |
b22f3a19 RS |
1396 | away, Emacs generates a down event and a click event for the first |
1397 | click, a double-down event when you press the button again, and finally | |
1398 | either a double-click or a double-drag event. | |
8db970a4 RS |
1399 | |
1400 | If you click a button twice and then press it again, all in quick | |
1401 | succession, Emacs generates a @dfn{triple-down} event, followed by | |
1402 | either a @dfn{triple-click} or a @dfn{triple-drag}. The event types of | |
1403 | these events contain @samp{triple} instead of @samp{double}. If any | |
1404 | triple event has no binding, Emacs uses the binding that it would use | |
1405 | for the corresponding double event. | |
1406 | ||
f142f62a RS |
1407 | If you click a button three or more times and then press it again, the |
1408 | events for the presses beyond the third are all triple events. Emacs | |
1409 | does not have separate event types for quadruple, quintuple, etc.@: | |
1410 | events. However, you can look at the event list to find out precisely | |
1411 | how many times the button was pressed. | |
8db970a4 RS |
1412 | |
1413 | @defun event-click-count event | |
1414 | This function returns the number of consecutive button presses that led | |
1415 | up to @var{event}. If @var{event} is a double-down, double-click or | |
1416 | double-drag event, the value is 2. If @var{event} is a triple event, | |
1417 | the value is 3 or greater. If @var{event} is an ordinary mouse event | |
1418 | (not a repeat event), the value is 1. | |
1419 | @end defun | |
1420 | ||
5504e99c | 1421 | @defopt double-click-fuzz |
f142f62a | 1422 | To generate repeat events, successive mouse button presses must be at |
99af9d83 GM |
1423 | approximately the same screen position. The value of |
1424 | @code{double-click-fuzz} specifies the maximum number of pixels the | |
5504e99c LT |
1425 | mouse may be moved (horizontally or vertically) between two successive |
1426 | clicks to make a double-click. | |
99af9d83 | 1427 | |
5504e99c LT |
1428 | This variable is also the threshold for motion of the mouse to count |
1429 | as a drag. | |
1430 | @end defopt | |
1431 | ||
1432 | @defopt double-click-time | |
99af9d83 | 1433 | To generate repeat events, the number of milliseconds between |
f142f62a | 1434 | successive button presses must be less than the value of |
8db970a4 RS |
1435 | @code{double-click-time}. Setting @code{double-click-time} to |
1436 | @code{nil} disables multi-click detection entirely. Setting it to | |
1437 | @code{t} removes the time limit; Emacs then detects multi-clicks by | |
1438 | position only. | |
5504e99c | 1439 | @end defopt |
8db970a4 RS |
1440 | |
1441 | @node Motion Events | |
1442 | @subsection Motion Events | |
1443 | @cindex motion event | |
1444 | @cindex mouse motion events | |
1445 | ||
1446 | Emacs sometimes generates @dfn{mouse motion} events to describe motion | |
1447 | of the mouse without any button activity. Mouse motion events are | |
1448 | represented by lists that look like this: | |
1449 | ||
1450 | @example | |
969fe9b5 | 1451 | (mouse-movement (@var{window} @var{buffer-pos} (@var{x} . @var{y}) @var{timestamp})) |
8db970a4 RS |
1452 | @end example |
1453 | ||
1454 | The second element of the list describes the current position of the | |
1455 | mouse, just as in a click event (@pxref{Click Events}). | |
1456 | ||
1457 | The special form @code{track-mouse} enables generation of motion events | |
1458 | within its body. Outside of @code{track-mouse} forms, Emacs does not | |
1459 | generate events for mere motion of the mouse, and these events do not | |
969fe9b5 | 1460 | appear. @xref{Mouse Tracking}. |
8db970a4 RS |
1461 | |
1462 | @node Focus Events | |
1463 | @subsection Focus Events | |
1464 | @cindex focus event | |
1465 | ||
1466 | Window systems provide general ways for the user to control which window | |
1467 | gets keyboard input. This choice of window is called the @dfn{focus}. | |
1468 | When the user does something to switch between Emacs frames, that | |
1469 | generates a @dfn{focus event}. The normal definition of a focus event, | |
1470 | in the global keymap, is to select a new frame within Emacs, as the user | |
1471 | would expect. @xref{Input Focus}. | |
1472 | ||
1473 | Focus events are represented in Lisp as lists that look like this: | |
1474 | ||
1475 | @example | |
1476 | (switch-frame @var{new-frame}) | |
1477 | @end example | |
1478 | ||
1479 | @noindent | |
1480 | where @var{new-frame} is the frame switched to. | |
1481 | ||
b22f3a19 RS |
1482 | Most X window managers are set up so that just moving the mouse into a |
1483 | window is enough to set the focus there. Emacs appears to do this, | |
1484 | because it changes the cursor to solid in the new frame. However, there | |
1485 | is no need for the Lisp program to know about the focus change until | |
1486 | some other kind of input arrives. So Emacs generates a focus event only | |
1487 | when the user actually types a keyboard key or presses a mouse button in | |
1488 | the new frame; just moving the mouse between frames does not generate a | |
1489 | focus event. | |
8db970a4 RS |
1490 | |
1491 | A focus event in the middle of a key sequence would garble the | |
1492 | sequence. So Emacs never generates a focus event in the middle of a key | |
1493 | sequence. If the user changes focus in the middle of a key | |
1494 | sequence---that is, after a prefix key---then Emacs reorders the events | |
1495 | so that the focus event comes either before or after the multi-event key | |
1496 | sequence, and not within it. | |
1497 | ||
22697dac | 1498 | @node Misc Events |
7790d5cd | 1499 | @subsection Miscellaneous System Events |
22697dac | 1500 | |
7790d5cd | 1501 | A few other event types represent occurrences within the system. |
22697dac KH |
1502 | |
1503 | @table @code | |
1504 | @cindex @code{delete-frame} event | |
1505 | @item (delete-frame (@var{frame})) | |
1506 | This kind of event indicates that the user gave the window manager | |
1507 | a command to delete a particular window, which happens to be an Emacs frame. | |
1508 | ||
1509 | The standard definition of the @code{delete-frame} event is to delete @var{frame}. | |
1510 | ||
1511 | @cindex @code{iconify-frame} event | |
1512 | @item (iconify-frame (@var{frame})) | |
1513 | This kind of event indicates that the user iconified @var{frame} using | |
d473987a RS |
1514 | the window manager. Its standard definition is @code{ignore}; since the |
1515 | frame has already been iconified, Emacs has no work to do. The purpose | |
1516 | of this event type is so that you can keep track of such events if you | |
1517 | want to. | |
22697dac | 1518 | |
1774d17e RS |
1519 | @cindex @code{make-frame-visible} event |
1520 | @item (make-frame-visible (@var{frame})) | |
22697dac KH |
1521 | This kind of event indicates that the user deiconified @var{frame} using |
1522 | the window manager. Its standard definition is @code{ignore}; since the | |
d473987a | 1523 | frame has already been made visible, Emacs has no work to do. |
a9f0a989 | 1524 | |
d2fab890 JR |
1525 | @cindex @code{wheel-up} event |
1526 | @cindex @code{wheel-down} event | |
1527 | @item (wheel-up @var{position}) | |
1528 | @item (wheel-down @var{position}) | |
dff3f9e1 RS |
1529 | These kinds of event are generated by moving a mouse wheel. Their |
1530 | usual meaning is a kind of scroll or zoom. | |
a9f0a989 RS |
1531 | |
1532 | The element @var{position} is a list describing the position of the | |
1533 | event, in the same format as used in a mouse-click event. | |
1534 | ||
dff3f9e1 RS |
1535 | This kind of event is generated only on some kinds of systems. On some |
1536 | systems, @code{mouse-4} and @code{mouse-5} are used instead. For | |
1537 | portable code, use the variables @code{mouse-wheel-up-event} and | |
1538 | @code{mouse-wheel-down-event} defined in @file{mwheel.el} to determine | |
1539 | what event types to expect for the mouse wheel. | |
a9f0a989 RS |
1540 | |
1541 | @cindex @code{drag-n-drop} event | |
1542 | @item (drag-n-drop @var{position} @var{files}) | |
1543 | This kind of event is generated when a group of files is | |
1544 | selected in an application outside of Emacs, and then dragged and | |
1545 | dropped onto an Emacs frame. | |
1546 | ||
1547 | The element @var{position} is a list describing the position of the | |
1548 | event, in the same format as used in a mouse-click event, and | |
1549 | @var{files} is the list of file names that were dragged and dropped. | |
1550 | The usual way to handle this event is by visiting these files. | |
1551 | ||
1552 | This kind of event is generated, at present, only on some kinds of | |
1553 | systems. | |
7790d5cd | 1554 | |
16bbbfd8 EZ |
1555 | @cindex @code{help-echo} event |
1556 | @item help-echo | |
1557 | This kind of event is generated when a mouse pointer moves onto a | |
1558 | portion of buffer text which has a @code{help-echo} text property. | |
1559 | The generated event has this form: | |
1560 | ||
1561 | @example | |
f75fbf43 | 1562 | (help-echo @var{frame} @var{help} @var{window} @var{object} @var{pos}) |
16bbbfd8 EZ |
1563 | @end example |
1564 | ||
1565 | @noindent | |
1566 | The precise meaning of the event parameters and the way these | |
1567 | parameters are used to display the help-echo text are described in | |
1568 | @ref{Text help-echo}. | |
1569 | ||
7790d5cd RS |
1570 | @cindex @code{usr1-signal} event |
1571 | @cindex @code{usr2-signal} event | |
1572 | @item usr1-signal | |
1573 | @itemx usr2-signal | |
1574 | These events are generated when the Emacs process receives the signals | |
1575 | @code{SIGUSR1} and @code{SIGUSR2}. They contain no additional data | |
1576 | because signals do not carry additional information. | |
22697dac KH |
1577 | @end table |
1578 | ||
bfe721d1 KH |
1579 | If one of these events arrives in the middle of a key sequence---that |
1580 | is, after a prefix key---then Emacs reorders the events so that this | |
1581 | event comes either before or after the multi-event key sequence, not | |
1582 | within it. | |
1583 | ||
8db970a4 RS |
1584 | @node Event Examples |
1585 | @subsection Event Examples | |
1586 | ||
1587 | If the user presses and releases the left mouse button over the same | |
1588 | location, that generates a sequence of events like this: | |
1589 | ||
1590 | @smallexample | |
1591 | (down-mouse-1 (#<window 18 on NEWS> 2613 (0 . 38) -864320)) | |
1592 | (mouse-1 (#<window 18 on NEWS> 2613 (0 . 38) -864180)) | |
1593 | @end smallexample | |
1594 | ||
f142f62a | 1595 | While holding the control key down, the user might hold down the |
8db970a4 RS |
1596 | second mouse button, and drag the mouse from one line to the next. |
1597 | That produces two events, as shown here: | |
1598 | ||
1599 | @smallexample | |
1600 | (C-down-mouse-2 (#<window 18 on NEWS> 3440 (0 . 27) -731219)) | |
1601 | (C-drag-mouse-2 (#<window 18 on NEWS> 3440 (0 . 27) -731219) | |
1602 | (#<window 18 on NEWS> 3510 (0 . 28) -729648)) | |
1603 | @end smallexample | |
1604 | ||
f142f62a | 1605 | While holding down the meta and shift keys, the user might press the |
8db970a4 | 1606 | second mouse button on the window's mode line, and then drag the mouse |
f142f62a | 1607 | into another window. That produces a pair of events like these: |
8db970a4 RS |
1608 | |
1609 | @smallexample | |
1610 | (M-S-down-mouse-2 (#<window 18 on NEWS> mode-line (33 . 31) -457844)) | |
1611 | (M-S-drag-mouse-2 (#<window 18 on NEWS> mode-line (33 . 31) -457844) | |
1612 | (#<window 20 on carlton-sanskrit.tex> 161 (33 . 3) | |
1613 | -453816)) | |
1614 | @end smallexample | |
1615 | ||
1616 | @node Classifying Events | |
1617 | @subsection Classifying Events | |
1618 | @cindex event type | |
1619 | ||
b22f3a19 RS |
1620 | Every event has an @dfn{event type}, which classifies the event for |
1621 | key binding purposes. For a keyboard event, the event type equals the | |
1622 | event value; thus, the event type for a character is the character, and | |
1623 | the event type for a function key symbol is the symbol itself. For | |
4bdcd3ef | 1624 | events that are lists, the event type is the symbol in the @sc{car} of |
b22f3a19 | 1625 | the list. Thus, the event type is always a symbol or a character. |
8db970a4 RS |
1626 | |
1627 | Two events of the same type are equivalent where key bindings are | |
1628 | concerned; thus, they always run the same command. That does not | |
1629 | necessarily mean they do the same things, however, as some commands look | |
1630 | at the whole event to decide what to do. For example, some commands use | |
f142f62a | 1631 | the location of a mouse event to decide where in the buffer to act. |
8db970a4 RS |
1632 | |
1633 | Sometimes broader classifications of events are useful. For example, | |
1634 | you might want to ask whether an event involved the @key{META} key, | |
1635 | regardless of which other key or mouse button was used. | |
1636 | ||
1637 | The functions @code{event-modifiers} and @code{event-basic-type} are | |
1638 | provided to get such information conveniently. | |
1639 | ||
1640 | @defun event-modifiers event | |
f142f62a RS |
1641 | This function returns a list of the modifiers that @var{event} has. The |
1642 | modifiers are symbols; they include @code{shift}, @code{control}, | |
8db970a4 | 1643 | @code{meta}, @code{alt}, @code{hyper} and @code{super}. In addition, |
f142f62a | 1644 | the modifiers list of a mouse event symbol always contains one of |
5504e99c LT |
1645 | @code{click}, @code{drag}, and @code{down}. For double or triple |
1646 | events, it also contains @code{double} or @code{triple}. | |
f142f62a | 1647 | |
5504e99c LT |
1648 | The argument @var{event} may be an entire event object, or just an |
1649 | event type. If @var{event} is a symbol that has never been used in an | |
1650 | event that has been read as input in the current Emacs session, then | |
1651 | @code{event-modifiers} can return @code{nil}, even when @var{event} | |
1652 | actually has modifiers. | |
f142f62a RS |
1653 | |
1654 | Here are some examples: | |
8db970a4 RS |
1655 | |
1656 | @example | |
1657 | (event-modifiers ?a) | |
1658 | @result{} nil | |
5504e99c LT |
1659 | (event-modifiers ?A) |
1660 | @result{} (shift) | |
8db970a4 RS |
1661 | (event-modifiers ?\C-a) |
1662 | @result{} (control) | |
1663 | (event-modifiers ?\C-%) | |
1664 | @result{} (control) | |
1665 | (event-modifiers ?\C-\S-a) | |
1666 | @result{} (control shift) | |
1667 | (event-modifiers 'f5) | |
1668 | @result{} nil | |
1669 | (event-modifiers 's-f5) | |
1670 | @result{} (super) | |
1671 | (event-modifiers 'M-S-f5) | |
1672 | @result{} (meta shift) | |
1673 | (event-modifiers 'mouse-1) | |
1674 | @result{} (click) | |
1675 | (event-modifiers 'down-mouse-1) | |
1676 | @result{} (down) | |
1677 | @end example | |
1678 | ||
1679 | The modifiers list for a click event explicitly contains @code{click}, | |
1680 | but the event symbol name itself does not contain @samp{click}. | |
1681 | @end defun | |
1682 | ||
1683 | @defun event-basic-type event | |
1684 | This function returns the key or mouse button that @var{event} | |
5504e99c LT |
1685 | describes, with all modifiers removed. The @var{event} argument is as |
1686 | in @code{event-modifiers}. For example: | |
8db970a4 RS |
1687 | |
1688 | @example | |
1689 | (event-basic-type ?a) | |
1690 | @result{} 97 | |
1691 | (event-basic-type ?A) | |
1692 | @result{} 97 | |
1693 | (event-basic-type ?\C-a) | |
1694 | @result{} 97 | |
1695 | (event-basic-type ?\C-\S-a) | |
1696 | @result{} 97 | |
1697 | (event-basic-type 'f5) | |
1698 | @result{} f5 | |
1699 | (event-basic-type 's-f5) | |
1700 | @result{} f5 | |
1701 | (event-basic-type 'M-S-f5) | |
1702 | @result{} f5 | |
1703 | (event-basic-type 'down-mouse-1) | |
1704 | @result{} mouse-1 | |
1705 | @end example | |
1706 | @end defun | |
1707 | ||
1708 | @defun mouse-movement-p object | |
1709 | This function returns non-@code{nil} if @var{object} is a mouse movement | |
1710 | event. | |
1711 | @end defun | |
1712 | ||
bfe721d1 KH |
1713 | @defun event-convert-list list |
1714 | This function converts a list of modifier names and a basic event type | |
5504e99c LT |
1715 | to an event type which specifies all of them. The basic event type |
1716 | must be the last element of the list. For example, | |
bfe721d1 KH |
1717 | |
1718 | @example | |
1719 | (event-convert-list '(control ?a)) | |
1720 | @result{} 1 | |
1721 | (event-convert-list '(control meta ?a)) | |
1722 | @result{} -134217727 | |
1723 | (event-convert-list '(control super f1)) | |
1724 | @result{} C-s-f1 | |
1725 | @end example | |
1726 | @end defun | |
1727 | ||
8db970a4 RS |
1728 | @node Accessing Events |
1729 | @subsection Accessing Events | |
2468d0c0 DL |
1730 | @cindex mouse events, accessing the data |
1731 | @cindex accessing data of mouse events | |
8db970a4 RS |
1732 | |
1733 | This section describes convenient functions for accessing the data in | |
f142f62a | 1734 | a mouse button or motion event. |
8db970a4 | 1735 | |
f142f62a | 1736 | These two functions return the starting or ending position of a |
969fe9b5 | 1737 | mouse-button event, as a list of this form: |
8db970a4 | 1738 | |
f142f62a | 1739 | @example |
f51f93f6 | 1740 | (@var{window} @var{pos-or-area} (@var{x} . @var{y}) @var{timestamp} |
08988329 KS |
1741 | @var{object} @var{text-pos} (@var{col} . @var{row}) |
1742 | @var{image} (@var{dx} . @var{dy}) (@var{width} . @var{height})) | |
f142f62a | 1743 | @end example |
8db970a4 RS |
1744 | |
1745 | @defun event-start event | |
1746 | This returns the starting position of @var{event}. | |
1747 | ||
1748 | If @var{event} is a click or button-down event, this returns the | |
1749 | location of the event. If @var{event} is a drag event, this returns the | |
1750 | drag's starting position. | |
1751 | @end defun | |
1752 | ||
1753 | @defun event-end event | |
1754 | This returns the ending position of @var{event}. | |
1755 | ||
1756 | If @var{event} is a drag event, this returns the position where the user | |
1757 | released the mouse button. If @var{event} is a click or button-down | |
1758 | event, the value is actually the starting position, which is the only | |
1759 | position such events have. | |
1760 | @end defun | |
1761 | ||
2468d0c0 | 1762 | @cindex mouse position list, accessing |
6e41ce9c | 1763 | These functions take a position list as described above, and |
969fe9b5 | 1764 | return various parts of it. |
8db970a4 RS |
1765 | |
1766 | @defun posn-window position | |
1767 | Return the window that @var{position} is in. | |
1768 | @end defun | |
1769 | ||
c5cb5297 | 1770 | @defun posn-area position |
f51f93f6 | 1771 | Return the window area recorded in @var{position}. It returns @code{nil} |
c5cb5297 KS |
1772 | when the event occurred in the text area of the window; otherwise, it |
1773 | is a symbol identifying the area in which the the event occurred. | |
1774 | @end defun | |
1775 | ||
8db970a4 | 1776 | @defun posn-point position |
c5cb5297 KS |
1777 | Return the buffer position in @var{position}. When the event occurred |
1778 | in the text area of the window, in a marginal area, or on a fringe, | |
1779 | this is an integer specifying a buffer position. Otherwise, the value | |
1780 | is undefined. | |
1781 | @end defun | |
1782 | ||
8db970a4 | 1783 | @defun posn-x-y position |
6e41ce9c RS |
1784 | Return the pixel-based x and y coordinates in @var{position}, as a |
1785 | cons cell @code{(@var{x} . @var{y})}. These coordinates are relative | |
1786 | to the window given by @code{posn-window}. | |
1787 | ||
1788 | This example shows how to convert these window-relative coordinates | |
1789 | into frame-relative coordinates: | |
1790 | ||
1791 | @example | |
1792 | (defun frame-relative-coordinates (position) | |
1793 | "Return frame-relative coordinates from POSITION." | |
1794 | (let* ((x-y (posn-x-y position)) | |
1795 | (window (posn-window position)) | |
1796 | (edges (window-inside-pixel-edges window))) | |
1797 | (cons (+ (car x-y) (car edges)) | |
1798 | (+ (cdr x-y) (cadr edges))))) | |
1799 | @end example | |
8db970a4 RS |
1800 | @end defun |
1801 | ||
1802 | @defun posn-col-row position | |
6e41ce9c RS |
1803 | Return the row and column (in units of the frame's default character |
1804 | height and width) of @var{position}, as a cons cell @code{(@var{col} . | |
1805 | @var{row})}. These are computed from the @var{x} and @var{y} values | |
1806 | actually found in @var{position}. | |
c5cb5297 KS |
1807 | @end defun |
1808 | ||
1809 | @defun posn-actual-col-row position | |
1810 | Return the actual row and column in @var{position}, as a cons cell | |
1811 | @code{(@var{col} . @var{row})}. The values are the actual row number | |
6e41ce9c RS |
1812 | in the window, and the actual character number in that row. It returns |
1813 | @code{nil} if @var{position} does not include actual positions values. | |
1814 | You can use @code{posn-col-row} to get approximate values. | |
8db970a4 RS |
1815 | @end defun |
1816 | ||
08988329 KS |
1817 | @defun posn-string position |
1818 | Return the string object in @var{position}, either @code{nil}, or a | |
1819 | cons cell @code{(@var{string} . @var{string-pos})}. | |
1820 | @end defun | |
1821 | ||
1822 | @defun posn-image position | |
1823 | Return the image object in @var{position}, either @code{nil}, or an | |
1824 | image @code{(image ...)}. | |
1825 | @end defun | |
1826 | ||
f51f93f6 | 1827 | @defun posn-object position |
08988329 KS |
1828 | Return the image or string object in @var{position}, either |
1829 | @code{nil}, an image @code{(image ...)}, or a cons cell | |
1830 | @code{(@var{string} . @var{string-pos})}. | |
f51f93f6 KS |
1831 | @end defun |
1832 | ||
1833 | @defun posn-object-x-y position | |
1834 | Return the pixel-based x and y coordinates relative to the upper left | |
08988329 KS |
1835 | corner of the object in @var{position} as a cons cell @code{(@var{dx} |
1836 | . @var{dy})}. If the @var{position} is a buffer position, return the | |
1837 | relative position in the character at that position. | |
1838 | @end defun | |
1839 | ||
1840 | @defun posn-object-width-height position | |
1841 | Return the pixel width and height of the object in @var{position} as a | |
1842 | cons cell @code{(@var{width} . @var{height})}. If the @var{position} | |
1843 | is a buffer position, return the size of the character at that position. | |
f51f93f6 KS |
1844 | @end defun |
1845 | ||
2468d0c0 DL |
1846 | @cindex mouse event, timestamp |
1847 | @cindex timestamp of a mouse event | |
5504e99c | 1848 | @defun posn-timestamp position |
f51f93f6 KS |
1849 | Return the timestamp in @var{position}. This is the time at which the |
1850 | event occurred, in milliseconds. | |
6e41ce9c RS |
1851 | @end defun |
1852 | ||
1853 | These functions compute a position list given particular buffer | |
1854 | position or screen position. You can access the data in this position | |
1855 | list with the functions described above. | |
1856 | ||
1857 | @defun posn-at-point &optional pos window | |
1858 | This function returns a position list for position @var{pos} in | |
1859 | @var{window}. @var{pos} defaults to point in @var{window}; | |
1860 | @var{window} defaults to the selected window. | |
1861 | ||
1862 | @code{posn-at-point} returns @code{nil} if @var{pos} is not visible in | |
1863 | @var{window}. | |
1864 | @end defun | |
1865 | ||
cfa284c4 | 1866 | @defun posn-at-x-y x y &optional frame-or-window whole |
6e41ce9c RS |
1867 | This function returns position information corresponding to pixel |
1868 | coordinates @var{x} and @var{y} in a specified frame or window, | |
1869 | @var{frame-or-window}, which defaults to the selected window. | |
1870 | The coordinates @var{x} and @var{y} are relative to the | |
1871 | frame or window used. | |
cfa284c4 KS |
1872 | If @var{whole} is @code{nil}, the coordinates are relative |
1873 | to the window text area, otherwise they are relative to | |
1874 | the entire window area including scroll bars, margins and fringes. | |
8db970a4 RS |
1875 | @end defun |
1876 | ||
969fe9b5 RS |
1877 | These functions are useful for decoding scroll bar events. |
1878 | ||
b22f3a19 RS |
1879 | @defun scroll-bar-event-ratio event |
1880 | This function returns the fractional vertical position of a scroll bar | |
1881 | event within the scroll bar. The value is a cons cell | |
1882 | @code{(@var{portion} . @var{whole})} containing two integers whose ratio | |
1883 | is the fractional position. | |
1884 | @end defun | |
1885 | ||
8db970a4 | 1886 | @defun scroll-bar-scale ratio total |
b22f3a19 RS |
1887 | This function multiplies (in effect) @var{ratio} by @var{total}, |
1888 | rounding the result to an integer. The argument @var{ratio} is not a | |
1889 | number, but rather a pair @code{(@var{num} . @var{denom})}---typically a | |
1890 | value returned by @code{scroll-bar-event-ratio}. | |
8db970a4 | 1891 | |
f142f62a RS |
1892 | This function is handy for scaling a position on a scroll bar into a |
1893 | buffer position. Here's how to do that: | |
8db970a4 RS |
1894 | |
1895 | @example | |
1896 | (+ (point-min) | |
1897 | (scroll-bar-scale | |
b22f3a19 | 1898 | (posn-x-y (event-start event)) |
8db970a4 RS |
1899 | (- (point-max) (point-min)))) |
1900 | @end example | |
b22f3a19 | 1901 | |
1911e6e5 | 1902 | Recall that scroll bar events have two integers forming a ratio, in place |
b22f3a19 | 1903 | of a pair of x and y coordinates. |
8db970a4 RS |
1904 | @end defun |
1905 | ||
1906 | @node Strings of Events | |
1907 | @subsection Putting Keyboard Events in Strings | |
2468d0c0 DL |
1908 | @cindex keyboard events in strings |
1909 | @cindex strings with keyboard events | |
8db970a4 RS |
1910 | |
1911 | In most of the places where strings are used, we conceptualize the | |
1912 | string as containing text characters---the same kind of characters found | |
b22f3a19 | 1913 | in buffers or files. Occasionally Lisp programs use strings that |
8db970a4 | 1914 | conceptually contain keyboard characters; for example, they may be key |
969fe9b5 RS |
1915 | sequences or keyboard macro definitions. However, storing keyboard |
1916 | characters in a string is a complex matter, for reasons of historical | |
1917 | compatibility, and it is not always possible. | |
1918 | ||
1919 | We recommend that new programs avoid dealing with these complexities | |
1920 | by not storing keyboard events in strings. Here is how to do that: | |
1921 | ||
1922 | @itemize @bullet | |
1923 | @item | |
1924 | Use vectors instead of strings for key sequences, when you plan to use | |
a9f0a989 | 1925 | them for anything other than as arguments to @code{lookup-key} and |
969fe9b5 RS |
1926 | @code{define-key}. For example, you can use |
1927 | @code{read-key-sequence-vector} instead of @code{read-key-sequence}, and | |
1928 | @code{this-command-keys-vector} instead of @code{this-command-keys}. | |
1929 | ||
1930 | @item | |
1931 | Use vectors to write key sequence constants containing meta characters, | |
1932 | even when passing them directly to @code{define-key}. | |
1933 | ||
1934 | @item | |
1935 | When you have to look at the contents of a key sequence that might be a | |
1936 | string, use @code{listify-key-sequence} (@pxref{Event Input Misc}) | |
1937 | first, to convert it to a list. | |
1938 | @end itemize | |
8db970a4 | 1939 | |
969fe9b5 RS |
1940 | The complexities stem from the modifier bits that keyboard input |
1941 | characters can include. Aside from the Meta modifier, none of these | |
1942 | modifier bits can be included in a string, and the Meta modifier is | |
1943 | allowed only in special cases. | |
1944 | ||
1945 | The earliest GNU Emacs versions represented meta characters as codes | |
1946 | in the range of 128 to 255. At that time, the basic character codes | |
1947 | ranged from 0 to 127, so all keyboard character codes did fit in a | |
1948 | string. Many Lisp programs used @samp{\M-} in string constants to stand | |
1949 | for meta characters, especially in arguments to @code{define-key} and | |
1950 | similar functions, and key sequences and sequences of events were always | |
1951 | represented as strings. | |
1952 | ||
1953 | When we added support for larger basic character codes beyond 127, and | |
1954 | additional modifier bits, we had to change the representation of meta | |
1955 | characters. Now the flag that represents the Meta modifier in a | |
1956 | character is | |
1957 | @tex | |
8241495d | 1958 | @math{2^{27}} |
969fe9b5 | 1959 | @end tex |
37680279 | 1960 | @ifnottex |
bfe721d1 | 1961 | 2**27 |
37680279 | 1962 | @end ifnottex |
969fe9b5 | 1963 | and such numbers cannot be included in a string. |
8db970a4 | 1964 | |
969fe9b5 RS |
1965 | To support programs with @samp{\M-} in string constants, there are |
1966 | special rules for including certain meta characters in a string. | |
1911e6e5 RS |
1967 | Here are the rules for interpreting a string as a sequence of input |
1968 | characters: | |
8db970a4 RS |
1969 | |
1970 | @itemize @bullet | |
1971 | @item | |
f142f62a RS |
1972 | If the keyboard character value is in the range of 0 to 127, it can go |
1973 | in the string unchanged. | |
8db970a4 RS |
1974 | |
1975 | @item | |
bfe721d1 | 1976 | The meta variants of those characters, with codes in the range of |
969fe9b5 | 1977 | @tex |
8241495d | 1978 | @math{2^{27}} |
969fe9b5 | 1979 | @end tex |
37680279 | 1980 | @ifnottex |
bfe721d1 | 1981 | 2**27 |
37680279 | 1982 | @end ifnottex |
bfe721d1 | 1983 | to |
969fe9b5 | 1984 | @tex |
8241495d | 1985 | @math{2^{27} + 127}, |
969fe9b5 | 1986 | @end tex |
37680279 | 1987 | @ifnottex |
bfe721d1 | 1988 | 2**27+127, |
37680279 | 1989 | @end ifnottex |
bfe721d1 KH |
1990 | can also go in the string, but you must change their |
1991 | numeric values. You must set the | |
969fe9b5 | 1992 | @tex |
8241495d | 1993 | @math{2^{7}} |
969fe9b5 | 1994 | @end tex |
37680279 | 1995 | @ifnottex |
bfe721d1 | 1996 | 2**7 |
37680279 | 1997 | @end ifnottex |
bfe721d1 | 1998 | bit instead of the |
969fe9b5 | 1999 | @tex |
8241495d | 2000 | @math{2^{27}} |
969fe9b5 | 2001 | @end tex |
37680279 | 2002 | @ifnottex |
bfe721d1 | 2003 | 2**27 |
37680279 | 2004 | @end ifnottex |
969fe9b5 RS |
2005 | bit, resulting in a value between 128 and 255. Only a unibyte string |
2006 | can include these codes. | |
2007 | ||
2008 | @item | |
ad800164 | 2009 | Non-@acronym{ASCII} characters above 256 can be included in a multibyte string. |
8db970a4 RS |
2010 | |
2011 | @item | |
2012 | Other keyboard character events cannot fit in a string. This includes | |
2013 | keyboard events in the range of 128 to 255. | |
2014 | @end itemize | |
2015 | ||
f9f59935 RS |
2016 | Functions such as @code{read-key-sequence} that construct strings of |
2017 | keyboard input characters follow these rules: they construct vectors | |
f142f62a | 2018 | instead of strings, when the events won't fit in a string. |
8db970a4 RS |
2019 | |
2020 | When you use the read syntax @samp{\M-} in a string, it produces a | |
2021 | code in the range of 128 to 255---the same code that you get if you | |
2022 | modify the corresponding keyboard event to put it in the string. Thus, | |
2023 | meta events in strings work consistently regardless of how they get into | |
2024 | the strings. | |
2025 | ||
969fe9b5 RS |
2026 | However, most programs would do well to avoid these issues by |
2027 | following the recommendations at the beginning of this section. | |
f142f62a | 2028 | |
8db970a4 RS |
2029 | @node Reading Input |
2030 | @section Reading Input | |
2031 | ||
969fe9b5 | 2032 | The editor command loop reads key sequences using the function |
8db970a4 | 2033 | @code{read-key-sequence}, which uses @code{read-event}. These and other |
969fe9b5 RS |
2034 | functions for event input are also available for use in Lisp programs. |
2035 | See also @code{momentary-string-display} in @ref{Temporary Displays}, | |
2036 | and @code{sit-for} in @ref{Waiting}. @xref{Terminal Input}, for | |
2037 | functions and variables for controlling terminal input modes and | |
4324b7ab RS |
2038 | debugging terminal input. @xref{Translating Input}, for features you |
2039 | can use for translating or modifying input events while reading them. | |
8db970a4 RS |
2040 | |
2041 | For higher-level input facilities, see @ref{Minibuffers}. | |
2042 | ||
2043 | @menu | |
2044 | * Key Sequence Input:: How to read one key sequence. | |
2045 | * Reading One Event:: How to read just one event. | |
b6954afd | 2046 | * Invoking the Input Method:: How reading an event uses the input method. |
8db970a4 | 2047 | * Quoted Character Input:: Asking the user to specify a character. |
f142f62a | 2048 | * Event Input Misc:: How to reread or throw away input events. |
8db970a4 RS |
2049 | @end menu |
2050 | ||
2051 | @node Key Sequence Input | |
2052 | @subsection Key Sequence Input | |
2053 | @cindex key sequence input | |
2054 | ||
2055 | The command loop reads input a key sequence at a time, by calling | |
2056 | @code{read-key-sequence}. Lisp programs can also call this function; | |
2057 | for example, @code{describe-key} uses it to read the key to describe. | |
2058 | ||
ecbfc7e9 | 2059 | @defun read-key-sequence prompt &optional continue-echo dont-downcase-last switch-frame-ok command-loop |
8db970a4 RS |
2060 | @cindex key sequence |
2061 | This function reads a key sequence and returns it as a string or | |
f9f59935 | 2062 | vector. It keeps reading events until it has accumulated a complete key |
8db970a4 | 2063 | sequence; that is, enough to specify a non-prefix command using the |
5504e99c LT |
2064 | currently active keymaps. (Remember that a key sequence that starts |
2065 | with a mouse event is read using the keymaps of the buffer in the | |
2066 | window that the mouse was in, not the current buffer.) | |
8db970a4 RS |
2067 | |
2068 | If the events are all characters and all can fit in a string, then | |
2069 | @code{read-key-sequence} returns a string (@pxref{Strings of Events}). | |
2070 | Otherwise, it returns a vector, since a vector can hold all kinds of | |
2071 | events---characters, symbols, and lists. The elements of the string or | |
2072 | vector are the events in the key sequence. | |
2073 | ||
ecbfc7e9 RS |
2074 | The argument @var{prompt} is either a string to be displayed in the |
2075 | echo area as a prompt, or @code{nil}, meaning not to display a prompt. | |
2076 | The argument @var{continue-echo}, if non-@code{nil}, means to echo | |
2077 | this key as a continuation of the previous key. | |
2078 | ||
2079 | Normally any upper case event is converted to lower case if the | |
2080 | original event is undefined and the lower case equivalent is defined. | |
2081 | The argument @var{dont-downcase-last}, if non-@code{nil}, means do not | |
2082 | convert the last event to lower case. This is appropriate for reading | |
2083 | a key sequence to be defined. | |
2084 | ||
2085 | The argument @var{switch-frame-ok}, if non-@code{nil}, means that this | |
2086 | function should process a @code{switch-frame} event if the user | |
2087 | switches frames before typing anything. If the user switches frames | |
2088 | in the middle of a key sequence, or at the start of the sequence but | |
2089 | @var{switch-frame-ok} is @code{nil}, then the event will be put off | |
2090 | until after the current key sequence. | |
2091 | ||
2092 | The argument @var{command-loop}, if non-@code{nil}, means that this | |
2093 | key sequence is being read by something that will read commands one | |
2094 | after another. It should be @code{nil} if the caller will read just | |
2095 | one key sequence. | |
8db970a4 RS |
2096 | |
2097 | In the example below, the prompt @samp{?} is displayed in the echo area, | |
2098 | and the user types @kbd{C-x C-f}. | |
2099 | ||
2100 | @example | |
2101 | (read-key-sequence "?") | |
2102 | ||
2103 | @group | |
2104 | ---------- Echo Area ---------- | |
2105 | ?@kbd{C-x C-f} | |
2106 | ---------- Echo Area ---------- | |
2107 | ||
2108 | @result{} "^X^F" | |
2109 | @end group | |
2110 | @end example | |
969fe9b5 RS |
2111 | |
2112 | The function @code{read-key-sequence} suppresses quitting: @kbd{C-g} | |
2113 | typed while reading with this function works like any other character, | |
2114 | and does not set @code{quit-flag}. @xref{Quitting}. | |
2115 | @end defun | |
2116 | ||
ecbfc7e9 | 2117 | @defun read-key-sequence-vector prompt &optional continue-echo dont-downcase-last switch-frame-ok command-loop |
969fe9b5 RS |
2118 | This is like @code{read-key-sequence} except that it always |
2119 | returns the key sequence as a vector, never as a string. | |
2120 | @xref{Strings of Events}. | |
8db970a4 RS |
2121 | @end defun |
2122 | ||
8db970a4 RS |
2123 | @cindex upper case key sequence |
2124 | @cindex downcasing in @code{lookup-key} | |
b071e512 RS |
2125 | If an input character is upper-case (or has the shift modifier) and |
2126 | has no key binding, but its lower-case equivalent has one, then | |
2127 | @code{read-key-sequence} converts the character to lower case. Note | |
2128 | that @code{lookup-key} does not perform case conversion in this way. | |
8db970a4 RS |
2129 | |
2130 | The function @code{read-key-sequence} also transforms some mouse events. | |
2131 | It converts unbound drag events into click events, and discards unbound | |
bfe721d1 KH |
2132 | button-down events entirely. It also reshuffles focus events and |
2133 | miscellaneous window events so that they never appear in a key sequence | |
2134 | with any other events. | |
8db970a4 | 2135 | |
2468d0c0 DL |
2136 | @cindex @code{header-line} prefix key |
2137 | @cindex @code{mode-line} prefix key | |
2138 | @cindex @code{vertical-line} prefix key | |
2139 | @cindex @code{horizontal-scroll-bar} prefix key | |
2140 | @cindex @code{vertical-scroll-bar} prefix key | |
2141 | @cindex @code{menu-bar} prefix key | |
2142 | @cindex mouse events, in special parts of frame | |
8db970a4 | 2143 | When mouse events occur in special parts of a window, such as a mode |
f142f62a RS |
2144 | line or a scroll bar, the event type shows nothing special---it is the |
2145 | same symbol that would normally represent that combination of mouse | |
f9f59935 RS |
2146 | button and modifier keys. The information about the window part is kept |
2147 | elsewhere in the event---in the coordinates. But | |
f142f62a | 2148 | @code{read-key-sequence} translates this information into imaginary |
080a57ba | 2149 | ``prefix keys'', all of which are symbols: @code{header-line}, |
2468d0c0 DL |
2150 | @code{horizontal-scroll-bar}, @code{menu-bar}, @code{mode-line}, |
2151 | @code{vertical-line}, and @code{vertical-scroll-bar}. You can define | |
2152 | meanings for mouse clicks in special window parts by defining key | |
2153 | sequences using these imaginary prefix keys. | |
f142f62a | 2154 | |
8db970a4 | 2155 | For example, if you call @code{read-key-sequence} and then click the |
bfe721d1 | 2156 | mouse on the window's mode line, you get two events, like this: |
8db970a4 | 2157 | |
f142f62a | 2158 | @example |
8db970a4 RS |
2159 | (read-key-sequence "Click on the mode line: ") |
2160 | @result{} [mode-line | |
f142f62a RS |
2161 | (mouse-1 |
2162 | (#<window 6 on NEWS> mode-line | |
2163 | (40 . 63) 5959987))] | |
2164 | @end example | |
8db970a4 | 2165 | |
f9f59935 RS |
2166 | @defvar num-input-keys |
2167 | @c Emacs 19 feature | |
2168 | This variable's value is the number of key sequences processed so far in | |
2169 | this Emacs session. This includes key sequences read from the terminal | |
2170 | and key sequences read from keyboard macros being executed. | |
2171 | @end defvar | |
2172 | ||
f9f59935 RS |
2173 | @defvar num-nonmacro-input-events |
2174 | This variable holds the total number of input events received so far | |
2175 | from the terminal---not counting those generated by keyboard macros. | |
2176 | @end defvar | |
2177 | ||
8db970a4 RS |
2178 | @node Reading One Event |
2179 | @subsection Reading One Event | |
2468d0c0 DL |
2180 | @cindex reading a single event |
2181 | @cindex event, reading only one | |
8db970a4 | 2182 | |
b22f3a19 | 2183 | The lowest level functions for command input are those that read a |
8db970a4 RS |
2184 | single event. |
2185 | ||
5504e99c LT |
2186 | None of the three functions below suppresses quitting. |
2187 | ||
b6954afd | 2188 | @defun read-event &optional prompt inherit-input-method |
8db970a4 RS |
2189 | This function reads and returns the next event of command input, waiting |
2190 | if necessary until an event is available. Events can come directly from | |
2191 | the user or from a keyboard macro. | |
2192 | ||
b6954afd RS |
2193 | If the optional argument @var{prompt} is non-@code{nil}, it should be a |
2194 | string to display in the echo area as a prompt. Otherwise, | |
2195 | @code{read-event} does not display any message to indicate it is waiting | |
2196 | for input; instead, it prompts by echoing: it displays descriptions of | |
2197 | the events that led to or were read by the current command. @xref{The | |
2198 | Echo Area}. | |
8db970a4 | 2199 | |
b6954afd RS |
2200 | If @var{inherit-input-method} is non-@code{nil}, then the current input |
2201 | method (if any) is employed to make it possible to enter a | |
ad800164 | 2202 | non-@acronym{ASCII} character. Otherwise, input method handling is disabled |
b6954afd | 2203 | for reading this event. |
2eb4136f | 2204 | |
8db970a4 RS |
2205 | If @code{cursor-in-echo-area} is non-@code{nil}, then @code{read-event} |
2206 | moves the cursor temporarily to the echo area, to the end of any message | |
2207 | displayed there. Otherwise @code{read-event} does not move the cursor. | |
8db970a4 | 2208 | |
5504e99c LT |
2209 | If @code{read-event} gets an event that is defined as a help character, |
2210 | then in some cases @code{read-event} processes the event directly without | |
a9f0a989 RS |
2211 | returning. @xref{Help Functions}. Certain other events, called |
2212 | @dfn{special events}, are also processed directly within | |
2213 | @code{read-event} (@pxref{Special Events}). | |
2214 | ||
8db970a4 RS |
2215 | Here is what happens if you call @code{read-event} and then press the |
2216 | right-arrow function key: | |
2217 | ||
2218 | @example | |
2219 | @group | |
2220 | (read-event) | |
2221 | @result{} right | |
2222 | @end group | |
2223 | @end example | |
f142f62a | 2224 | @end defun |
8db970a4 | 2225 | |
b6954afd RS |
2226 | @defun read-char &optional prompt inherit-input-method |
2227 | This function reads and returns a character of command input. If the | |
2228 | user generates an event which is not a character (i.e. a mouse click or | |
2229 | function key event), @code{read-char} signals an error. The arguments | |
2230 | work as in @code{read-event}. | |
8db970a4 | 2231 | |
ad800164 | 2232 | In the first example, the user types the character @kbd{1} (@acronym{ASCII} |
f142f62a RS |
2233 | code 49). The second example shows a keyboard macro definition that |
2234 | calls @code{read-char} from the minibuffer using @code{eval-expression}. | |
2235 | @code{read-char} reads the keyboard macro's very next character, which | |
2236 | is @kbd{1}. Then @code{eval-expression} displays its return value in | |
2237 | the echo area. | |
8db970a4 RS |
2238 | |
2239 | @example | |
2240 | @group | |
2241 | (read-char) | |
2242 | @result{} 49 | |
2243 | @end group | |
2244 | ||
2245 | @group | |
bfe721d1 | 2246 | ;; @r{We assume here you use @kbd{M-:} to evaluate this.} |
8db970a4 | 2247 | (symbol-function 'foo) |
bfe721d1 | 2248 | @result{} "^[:(read-char)^M1" |
8db970a4 RS |
2249 | @end group |
2250 | @group | |
f142f62a | 2251 | (execute-kbd-macro 'foo) |
8db970a4 RS |
2252 | @print{} 49 |
2253 | @result{} nil | |
2254 | @end group | |
2255 | @end example | |
2256 | @end defun | |
2257 | ||
b6954afd RS |
2258 | @defun read-char-exclusive &optional prompt inherit-input-method |
2259 | This function reads and returns a character of command input. If the | |
2260 | user generates an event which is not a character, | |
2261 | @code{read-char-exclusive} ignores it and reads another event, until it | |
2262 | gets a character. The arguments work as in @code{read-event}. | |
2263 | @end defun | |
2264 | ||
2265 | @node Invoking the Input Method | |
2266 | @subsection Invoking the Input Method | |
2267 | ||
2268 | The event-reading functions invoke the current input method, if any | |
2269 | (@pxref{Input Methods}). If the value of @code{input-method-function} | |
2270 | is non-@code{nil}, it should be a function; when @code{read-event} reads | |
2271 | a printing character (including @key{SPC}) with no modifier bits, it | |
2272 | calls that function, passing the character as an argument. | |
39d6d9bd RS |
2273 | |
2274 | @defvar input-method-function | |
2275 | If this is non-@code{nil}, its value specifies the current input method | |
2276 | function. | |
2eb4136f | 2277 | |
6142d1d0 | 2278 | @strong{Warning:} don't bind this variable with @code{let}. It is often |
2eb4136f RS |
2279 | buffer-local, and if you bind it around reading input (which is exactly |
2280 | when you @emph{would} bind it), switching buffers asynchronously while | |
2281 | Emacs is waiting will cause the value to be restored in the wrong | |
2282 | buffer. | |
39d6d9bd RS |
2283 | @end defvar |
2284 | ||
2285 | The input method function should return a list of events which should | |
2286 | be used as input. (If the list is @code{nil}, that means there is no | |
2287 | input, so @code{read-event} waits for another event.) These events are | |
2468d0c0 DL |
2288 | processed before the events in @code{unread-command-events} |
2289 | (@pxref{Event Input Misc}). Events | |
39d6d9bd RS |
2290 | returned by the input method function are not passed to the input method |
2291 | function again, even if they are printing characters with no modifier | |
2292 | bits. | |
2293 | ||
2294 | If the input method function calls @code{read-event} or | |
2295 | @code{read-key-sequence}, it should bind @code{input-method-function} to | |
2296 | @code{nil} first, to prevent recursion. | |
2297 | ||
2298 | The input method function is not called when reading the second and | |
b6954afd RS |
2299 | subsequent events of a key sequence. Thus, these characters are not |
2300 | subject to input method processing. The input method function should | |
2301 | test the values of @code{overriding-local-map} and | |
2302 | @code{overriding-terminal-local-map}; if either of these variables is | |
2303 | non-@code{nil}, the input method should put its argument into a list and | |
2304 | return that list with no further processing. | |
39d6d9bd | 2305 | |
8db970a4 RS |
2306 | @node Quoted Character Input |
2307 | @subsection Quoted Character Input | |
2308 | @cindex quoted character input | |
2309 | ||
b22f3a19 RS |
2310 | You can use the function @code{read-quoted-char} to ask the user to |
2311 | specify a character, and allow the user to specify a control or meta | |
2312 | character conveniently, either literally or as an octal character code. | |
2313 | The command @code{quoted-insert} uses this function. | |
8db970a4 RS |
2314 | |
2315 | @defun read-quoted-char &optional prompt | |
2316 | @cindex octal character input | |
2317 | @cindex control characters, reading | |
2318 | @cindex nonprinting characters, reading | |
2319 | This function is like @code{read-char}, except that if the first | |
969fe9b5 RS |
2320 | character read is an octal digit (0-7), it reads any number of octal |
2321 | digits (but stopping if a non-octal digit is found), and returns the | |
5504e99c LT |
2322 | character represented by that numeric character code. If the |
2323 | character that terminates the sequence of octal digits is @key{RET}, | |
2324 | it is discarded. Any other terminating character is used as input | |
2325 | after this function returns. | |
8db970a4 RS |
2326 | |
2327 | Quitting is suppressed when the first character is read, so that the | |
2328 | user can enter a @kbd{C-g}. @xref{Quitting}. | |
2329 | ||
2330 | If @var{prompt} is supplied, it specifies a string for prompting the | |
f142f62a | 2331 | user. The prompt string is always displayed in the echo area, followed |
8db970a4 RS |
2332 | by a single @samp{-}. |
2333 | ||
2334 | In the following example, the user types in the octal number 177 (which | |
2335 | is 127 in decimal). | |
2336 | ||
2337 | @example | |
2338 | (read-quoted-char "What character") | |
2339 | ||
2340 | @group | |
2341 | ---------- Echo Area ---------- | |
5504e99c | 2342 | What character @kbd{1 7 7}- |
8db970a4 RS |
2343 | ---------- Echo Area ---------- |
2344 | ||
2345 | @result{} 127 | |
2346 | @end group | |
2347 | @end example | |
2348 | @end defun | |
2349 | ||
b22f3a19 | 2350 | @need 2000 |
f142f62a RS |
2351 | @node Event Input Misc |
2352 | @subsection Miscellaneous Event Input Features | |
2353 | ||
2354 | This section describes how to ``peek ahead'' at events without using | |
2355 | them up, how to check for pending input, and how to discard pending | |
1911e6e5 RS |
2356 | input. See also the function @code{read-passwd} (@pxref{Reading a |
2357 | Password}). | |
8db970a4 RS |
2358 | |
2359 | @defvar unread-command-events | |
2360 | @cindex next input | |
2361 | @cindex peeking at input | |
2362 | This variable holds a list of events waiting to be read as command | |
f142f62a RS |
2363 | input. The events are used in the order they appear in the list, and |
2364 | removed one by one as they are used. | |
8db970a4 | 2365 | |
f9f59935 | 2366 | The variable is needed because in some cases a function reads an event |
f142f62a RS |
2367 | and then decides not to use it. Storing the event in this variable |
2368 | causes it to be processed normally, by the command loop or by the | |
2369 | functions to read command input. | |
8db970a4 RS |
2370 | |
2371 | @cindex prefix argument unreading | |
2372 | For example, the function that implements numeric prefix arguments reads | |
2373 | any number of digits. When it finds a non-digit event, it must unread | |
2374 | the event so that it can be read normally by the command loop. | |
177c0ea7 | 2375 | Likewise, incremental search uses this feature to unread events with no |
f142f62a RS |
2376 | special meaning in a search, because these events should exit the search |
2377 | and then execute normally. | |
2378 | ||
b22f3a19 RS |
2379 | The reliable and easy way to extract events from a key sequence so as to |
2380 | put them in @code{unread-command-events} is to use | |
f142f62a | 2381 | @code{listify-key-sequence} (@pxref{Strings of Events}). |
f9f59935 RS |
2382 | |
2383 | Normally you add events to the front of this list, so that the events | |
2384 | most recently unread will be reread first. | |
8db970a4 RS |
2385 | @end defvar |
2386 | ||
969fe9b5 RS |
2387 | @defun listify-key-sequence key |
2388 | This function converts the string or vector @var{key} to a list of | |
2389 | individual events, which you can put in @code{unread-command-events}. | |
2390 | @end defun | |
2391 | ||
8db970a4 RS |
2392 | @defvar unread-command-char |
2393 | This variable holds a character to be read as command input. | |
2394 | A value of -1 means ``empty''. | |
2395 | ||
f142f62a | 2396 | This variable is mostly obsolete now that you can use |
8db970a4 RS |
2397 | @code{unread-command-events} instead; it exists only to support programs |
2398 | written for Emacs versions 18 and earlier. | |
2399 | @end defvar | |
2400 | ||
8db970a4 RS |
2401 | @defun input-pending-p |
2402 | @cindex waiting for command key input | |
2403 | This function determines whether any command input is currently | |
2404 | available to be read. It returns immediately, with value @code{t} if | |
f142f62a RS |
2405 | there is available input, @code{nil} otherwise. On rare occasions it |
2406 | may return @code{t} when no input is available. | |
8db970a4 RS |
2407 | @end defun |
2408 | ||
2409 | @defvar last-input-event | |
969fe9b5 | 2410 | @defvarx last-input-char |
f142f62a | 2411 | This variable records the last terminal input event read, whether |
8db970a4 RS |
2412 | as part of a command or explicitly by a Lisp program. |
2413 | ||
f142f62a | 2414 | In the example below, the Lisp program reads the character @kbd{1}, |
ad800164 | 2415 | @acronym{ASCII} code 49. It becomes the value of @code{last-input-event}, |
bfe721d1 KH |
2416 | while @kbd{C-e} (we assume @kbd{C-x C-e} command is used to evaluate |
2417 | this expression) remains the value of @code{last-command-event}. | |
8db970a4 RS |
2418 | |
2419 | @example | |
2420 | @group | |
2421 | (progn (print (read-char)) | |
f142f62a RS |
2422 | (print last-command-event) |
2423 | last-input-event) | |
8db970a4 RS |
2424 | @print{} 49 |
2425 | @print{} 5 | |
2426 | @result{} 49 | |
2427 | @end group | |
2428 | @end example | |
2429 | ||
2430 | The alias @code{last-input-char} exists for compatibility with | |
2431 | Emacs version 18. | |
2432 | @end defvar | |
2433 | ||
a5034239 RS |
2434 | @defmac while-no-input body... |
2435 | This construct runs the @var{body} forms and returns the value | |
2436 | of the last one---but only if no input arrives. If any input | |
2437 | arrives during the execution of the @var{body} forms, it aborts | |
2438 | them (working much like a quit), and the @code{while-no-input} | |
2439 | form returns @code{nil}. | |
2440 | ||
2441 | If a part of @var{body} binds @code{inhibit-quit} to non-@code{nil}, | |
2442 | arrival of input during those parts won't cause an abort until | |
2443 | the end of that part. | |
2444 | @end defmac | |
2445 | ||
8db970a4 RS |
2446 | @defun discard-input |
2447 | @cindex flush input | |
2448 | @cindex discard input | |
2449 | @cindex terminate keyboard macro | |
2450 | This function discards the contents of the terminal input buffer and | |
2451 | cancels any keyboard macro that might be in the process of definition. | |
2452 | It returns @code{nil}. | |
2453 | ||
2454 | In the following example, the user may type a number of characters right | |
2455 | after starting the evaluation of the form. After the @code{sleep-for} | |
177c0ea7 | 2456 | finishes sleeping, @code{discard-input} discards any characters typed |
f142f62a | 2457 | during the sleep. |
8db970a4 RS |
2458 | |
2459 | @example | |
2460 | (progn (sleep-for 2) | |
f142f62a | 2461 | (discard-input)) |
8db970a4 RS |
2462 | @result{} nil |
2463 | @end example | |
2464 | @end defun | |
2465 | ||
f9f59935 RS |
2466 | @node Special Events |
2467 | @section Special Events | |
2468 | ||
2469 | @cindex special events | |
2470 | Special events are handled at a very low level---as soon as they are | |
2471 | read. The @code{read-event} function processes these events itself, and | |
5504e99c LT |
2472 | never returns them. Instead, it keeps waiting for the first event |
2473 | that is not special and returns that one. | |
f9f59935 RS |
2474 | |
2475 | Events that are handled in this way do not echo, they are never grouped | |
2476 | into key sequences, and they never appear in the value of | |
2477 | @code{last-command-event} or @code{(this-command-keys)}. They do not | |
2478 | discard a numeric argument, they cannot be unread with | |
2479 | @code{unread-command-events}, they may not appear in a keyboard macro, | |
2480 | and they are not recorded in a keyboard macro while you are defining | |
2481 | one. | |
2482 | ||
2483 | These events do, however, appear in @code{last-input-event} immediately | |
2484 | after they are read, and this is the way for the event's definition to | |
2485 | find the actual event. | |
2486 | ||
2487 | The events types @code{iconify-frame}, @code{make-frame-visible} and | |
2488 | @code{delete-frame} are normally handled in this way. The keymap which | |
2489 | defines how to handle special events---and which events are special---is | |
2490 | in the variable @code{special-event-map} (@pxref{Active Keymaps}). | |
2491 | ||
8db970a4 RS |
2492 | @node Waiting |
2493 | @section Waiting for Elapsed Time or Input | |
2494 | @cindex pausing | |
2495 | @cindex waiting | |
2496 | ||
f142f62a RS |
2497 | The wait functions are designed to wait for a certain amount of time |
2498 | to pass or until there is input. For example, you may wish to pause in | |
2499 | the middle of a computation to allow the user time to view the display. | |
2500 | @code{sit-for} pauses and updates the screen, and returns immediately if | |
2501 | input comes in, while @code{sleep-for} pauses without updating the | |
2502 | screen. | |
8db970a4 | 2503 | |
14bd0b09 | 2504 | @defun sit-for seconds &optional nodisp |
8db970a4 RS |
2505 | This function performs redisplay (provided there is no pending input |
2506 | from the user), then waits @var{seconds} seconds, or until input is | |
f142f62a | 2507 | available. The value is @code{t} if @code{sit-for} waited the full |
177c0ea7 | 2508 | time with no input arriving (see @code{input-pending-p} in @ref{Event |
f142f62a | 2509 | Input Misc}). Otherwise, the value is @code{nil}. |
8db970a4 | 2510 | |
bfe721d1 KH |
2511 | The argument @var{seconds} need not be an integer. If it is a floating |
2512 | point number, @code{sit-for} waits for a fractional number of seconds. | |
2513 | Some systems support only a whole number of seconds; on these systems, | |
2514 | @var{seconds} is rounded down. | |
2515 | ||
8241495d RS |
2516 | The expression @code{(sit-for 0)} is a convenient way to request a |
2517 | redisplay, without any delay. @xref{Forcing Redisplay}. | |
8db970a4 RS |
2518 | |
2519 | If @var{nodisp} is non-@code{nil}, then @code{sit-for} does not | |
2520 | redisplay, but it still returns as soon as input is available (or when | |
2521 | the timeout elapses). | |
2522 | ||
22697dac KH |
2523 | Iconifying or deiconifying a frame makes @code{sit-for} return, because |
2524 | that generates an event. @xref{Misc Events}. | |
2525 | ||
8db970a4 RS |
2526 | The usual purpose of @code{sit-for} is to give the user time to read |
2527 | text that you display. | |
14bd0b09 RS |
2528 | |
2529 | It is also possible to call @code{sit-for} with three arguments, | |
2530 | as @code{(sit-for @var{seconds} @var{millisec} @var{nodisp})}, | |
2531 | but that is considered obsolete. | |
8db970a4 RS |
2532 | @end defun |
2533 | ||
2534 | @defun sleep-for seconds &optional millisec | |
2535 | This function simply pauses for @var{seconds} seconds without updating | |
2536 | the display. It pays no attention to available input. It returns | |
2537 | @code{nil}. | |
2538 | ||
bfe721d1 KH |
2539 | The argument @var{seconds} need not be an integer. If it is a floating |
2540 | point number, @code{sleep-for} waits for a fractional number of seconds. | |
2541 | Some systems support only a whole number of seconds; on these systems, | |
2542 | @var{seconds} is rounded down. | |
2543 | ||
8db970a4 RS |
2544 | The optional argument @var{millisec} specifies an additional waiting |
2545 | period measured in milliseconds. This adds to the period specified by | |
bfe721d1 KH |
2546 | @var{seconds}. If the system doesn't support waiting fractions of a |
2547 | second, you get an error if you specify nonzero @var{millisec}. | |
8db970a4 RS |
2548 | |
2549 | Use @code{sleep-for} when you wish to guarantee a delay. | |
2550 | @end defun | |
2551 | ||
2552 | @xref{Time of Day}, for functions to get the current time. | |
2553 | ||
2554 | @node Quitting | |
2555 | @section Quitting | |
2556 | @cindex @kbd{C-g} | |
2557 | @cindex quitting | |
34c0b12e | 2558 | @cindex interrupt Lisp functions |
8db970a4 | 2559 | |
b22f3a19 RS |
2560 | Typing @kbd{C-g} while a Lisp function is running causes Emacs to |
2561 | @dfn{quit} whatever it is doing. This means that control returns to the | |
2562 | innermost active command loop. | |
8db970a4 RS |
2563 | |
2564 | Typing @kbd{C-g} while the command loop is waiting for keyboard input | |
2565 | does not cause a quit; it acts as an ordinary input character. In the | |
2566 | simplest case, you cannot tell the difference, because @kbd{C-g} | |
2567 | normally runs the command @code{keyboard-quit}, whose effect is to quit. | |
969fe9b5 RS |
2568 | However, when @kbd{C-g} follows a prefix key, they combine to form an |
2569 | undefined key. The effect is to cancel the prefix key as well as any | |
2570 | prefix argument. | |
8db970a4 RS |
2571 | |
2572 | In the minibuffer, @kbd{C-g} has a different definition: it aborts out | |
2573 | of the minibuffer. This means, in effect, that it exits the minibuffer | |
2574 | and then quits. (Simply quitting would return to the command loop | |
2575 | @emph{within} the minibuffer.) The reason why @kbd{C-g} does not quit | |
2576 | directly when the command reader is reading input is so that its meaning | |
2577 | can be redefined in the minibuffer in this way. @kbd{C-g} following a | |
2578 | prefix key is not redefined in the minibuffer, and it has its normal | |
2579 | effect of canceling the prefix key and prefix argument. This too | |
f142f62a | 2580 | would not be possible if @kbd{C-g} always quit directly. |
8db970a4 | 2581 | |
b22f3a19 | 2582 | When @kbd{C-g} does directly quit, it does so by setting the variable |
f142f62a RS |
2583 | @code{quit-flag} to @code{t}. Emacs checks this variable at appropriate |
2584 | times and quits if it is not @code{nil}. Setting @code{quit-flag} | |
8db970a4 RS |
2585 | non-@code{nil} in any way thus causes a quit. |
2586 | ||
f142f62a | 2587 | At the level of C code, quitting cannot happen just anywhere; only at the |
b22f3a19 | 2588 | special places that check @code{quit-flag}. The reason for this is |
8db970a4 | 2589 | that quitting at other places might leave an inconsistency in Emacs's |
177c0ea7 | 2590 | internal state. Because quitting is delayed until a safe place, quitting |
8db970a4 RS |
2591 | cannot make Emacs crash. |
2592 | ||
2593 | Certain functions such as @code{read-key-sequence} or | |
2594 | @code{read-quoted-char} prevent quitting entirely even though they wait | |
2595 | for input. Instead of quitting, @kbd{C-g} serves as the requested | |
2596 | input. In the case of @code{read-key-sequence}, this serves to bring | |
2597 | about the special behavior of @kbd{C-g} in the command loop. In the | |
2598 | case of @code{read-quoted-char}, this is so that @kbd{C-q} can be used | |
177c0ea7 | 2599 | to quote a @kbd{C-g}. |
8db970a4 | 2600 | |
34c0b12e | 2601 | @cindex prevent quitting |
8db970a4 RS |
2602 | You can prevent quitting for a portion of a Lisp function by binding |
2603 | the variable @code{inhibit-quit} to a non-@code{nil} value. Then, | |
2604 | although @kbd{C-g} still sets @code{quit-flag} to @code{t} as usual, the | |
2605 | usual result of this---a quit---is prevented. Eventually, | |
2606 | @code{inhibit-quit} will become @code{nil} again, such as when its | |
2607 | binding is unwound at the end of a @code{let} form. At that time, if | |
2608 | @code{quit-flag} is still non-@code{nil}, the requested quit happens | |
b22f3a19 RS |
2609 | immediately. This behavior is ideal when you wish to make sure that |
2610 | quitting does not happen within a ``critical section'' of the program. | |
8db970a4 RS |
2611 | |
2612 | @cindex @code{read-quoted-char} quitting | |
2613 | In some functions (such as @code{read-quoted-char}), @kbd{C-g} is | |
b22f3a19 | 2614 | handled in a special way that does not involve quitting. This is done |
f142f62a | 2615 | by reading the input with @code{inhibit-quit} bound to @code{t}, and |
8db970a4 RS |
2616 | setting @code{quit-flag} to @code{nil} before @code{inhibit-quit} |
2617 | becomes @code{nil} again. This excerpt from the definition of | |
2618 | @code{read-quoted-char} shows how this is done; it also shows that | |
2619 | normal quitting is permitted after the first character of input. | |
2620 | ||
2621 | @example | |
2622 | (defun read-quoted-char (&optional prompt) | |
2623 | "@dots{}@var{documentation}@dots{}" | |
969fe9b5 RS |
2624 | (let ((message-log-max nil) done (first t) (code 0) char) |
2625 | (while (not done) | |
2626 | (let ((inhibit-quit first) | |
2627 | @dots{}) | |
2628 | (and prompt (message "%s-" prompt)) | |
2629 | (setq char (read-event)) | |
2630 | (if inhibit-quit (setq quit-flag nil))) | |
2631 | @r{@dots{}set the variable @code{code}@dots{}}) | |
2632 | code)) | |
8db970a4 RS |
2633 | @end example |
2634 | ||
2635 | @defvar quit-flag | |
f142f62a RS |
2636 | If this variable is non-@code{nil}, then Emacs quits immediately, unless |
2637 | @code{inhibit-quit} is non-@code{nil}. Typing @kbd{C-g} ordinarily sets | |
8db970a4 RS |
2638 | @code{quit-flag} non-@code{nil}, regardless of @code{inhibit-quit}. |
2639 | @end defvar | |
2640 | ||
2641 | @defvar inhibit-quit | |
2642 | This variable determines whether Emacs should quit when @code{quit-flag} | |
2643 | is set to a value other than @code{nil}. If @code{inhibit-quit} is | |
2644 | non-@code{nil}, then @code{quit-flag} has no special effect. | |
2645 | @end defvar | |
2646 | ||
5504e99c LT |
2647 | @defmac with-local-quit forms@dots{} |
2648 | This macro executes @var{forms} in sequence, but allows quitting, at | |
2649 | least locally, within @var{body} even if @code{inhibit-quit} was | |
2650 | non-@code{nil} outside this construct. It returns the value of the | |
eab463f6 RS |
2651 | last form in @var{forms}, unless exited by quitting, in which case |
2652 | it returns @code{nil}. | |
5504e99c LT |
2653 | |
2654 | If @code{inhibit-quit} is @code{nil} on entry to @code{with-local-quit}, | |
2655 | it only executes the @var{forms}, and setting @code{quit-flag} causes | |
2656 | a normal quit. However, if @code{inhibit-quit} is non-@code{nil} so | |
2657 | that ordinary quitting is delayed, a non-@code{nil} @code{quit-flag} | |
2658 | triggers a special kind of local quit. This ends the execution of | |
2659 | @var{forms} and exits the @code{with-local-quit} form with | |
2660 | @code{quit-flag} still non-@code{nil}, so that another (ordinary) quit | |
2661 | will happen as soon as that is allowed. If @code{quit-flag} is | |
2662 | already non-@code{nil} at the beginning of @var{forms}, the local quit | |
2663 | happens immediately and they don't execute at all. | |
2664 | ||
2665 | This macro is mainly useful in functions that can be called from | |
2666 | timers, @code{pre-command-hook}, @code{post-command-hook} and other | |
2667 | places where @code{inhibit-quit} is normally bound to @code{t}. | |
2668 | @end defmac | |
2669 | ||
8db970a4 RS |
2670 | @deffn Command keyboard-quit |
2671 | This function signals the @code{quit} condition with @code{(signal 'quit | |
2672 | nil)}. This is the same thing that quitting does. (See @code{signal} | |
2673 | in @ref{Errors}.) | |
2674 | @end deffn | |
2675 | ||
2676 | You can specify a character other than @kbd{C-g} to use for quitting. | |
2677 | See the function @code{set-input-mode} in @ref{Terminal Input}. | |
177c0ea7 | 2678 | |
8db970a4 RS |
2679 | @node Prefix Command Arguments |
2680 | @section Prefix Command Arguments | |
2681 | @cindex prefix argument | |
2682 | @cindex raw prefix argument | |
2683 | @cindex numeric prefix argument | |
2684 | ||
2685 | Most Emacs commands can use a @dfn{prefix argument}, a number | |
2686 | specified before the command itself. (Don't confuse prefix arguments | |
b22f3a19 RS |
2687 | with prefix keys.) The prefix argument is at all times represented by a |
2688 | value, which may be @code{nil}, meaning there is currently no prefix | |
2689 | argument. Each command may use the prefix argument or ignore it. | |
8db970a4 RS |
2690 | |
2691 | There are two representations of the prefix argument: @dfn{raw} and | |
2692 | @dfn{numeric}. The editor command loop uses the raw representation | |
2693 | internally, and so do the Lisp variables that store the information, but | |
2694 | commands can request either representation. | |
2695 | ||
2696 | Here are the possible values of a raw prefix argument: | |
2697 | ||
2698 | @itemize @bullet | |
2699 | @item | |
2700 | @code{nil}, meaning there is no prefix argument. Its numeric value is | |
2701 | 1, but numerous commands make a distinction between @code{nil} and the | |
2702 | integer 1. | |
2703 | ||
2704 | @item | |
2705 | An integer, which stands for itself. | |
2706 | ||
2707 | @item | |
2708 | A list of one element, which is an integer. This form of prefix | |
2709 | argument results from one or a succession of @kbd{C-u}'s with no | |
2710 | digits. The numeric value is the integer in the list, but some | |
2711 | commands make a distinction between such a list and an integer alone. | |
2712 | ||
2713 | @item | |
2714 | The symbol @code{-}. This indicates that @kbd{M--} or @kbd{C-u -} was | |
2715 | typed, without following digits. The equivalent numeric value is | |
2716 | @minus{}1, but some commands make a distinction between the integer | |
2717 | @minus{}1 and the symbol @code{-}. | |
2718 | @end itemize | |
2719 | ||
f142f62a RS |
2720 | We illustrate these possibilities by calling the following function with |
2721 | various prefixes: | |
8db970a4 RS |
2722 | |
2723 | @example | |
2724 | @group | |
2725 | (defun display-prefix (arg) | |
2726 | "Display the value of the raw prefix arg." | |
2727 | (interactive "P") | |
2728 | (message "%s" arg)) | |
2729 | @end group | |
2730 | @end example | |
2731 | ||
2732 | @noindent | |
2733 | Here are the results of calling @code{display-prefix} with various | |
2734 | raw prefix arguments: | |
2735 | ||
2736 | @example | |
2737 | M-x display-prefix @print{} nil | |
2738 | ||
2739 | C-u M-x display-prefix @print{} (4) | |
2740 | ||
2741 | C-u C-u M-x display-prefix @print{} (16) | |
2742 | ||
2743 | C-u 3 M-x display-prefix @print{} 3 | |
2744 | ||
2745 | M-3 M-x display-prefix @print{} 3 ; @r{(Same as @code{C-u 3}.)} | |
2746 | ||
177c0ea7 | 2747 | C-u - M-x display-prefix @print{} - |
8db970a4 | 2748 | |
f142f62a | 2749 | M-- M-x display-prefix @print{} - ; @r{(Same as @code{C-u -}.)} |
8db970a4 | 2750 | |
177c0ea7 | 2751 | C-u - 7 M-x display-prefix @print{} -7 |
8db970a4 | 2752 | |
f142f62a | 2753 | M-- 7 M-x display-prefix @print{} -7 ; @r{(Same as @code{C-u -7}.)} |
8db970a4 RS |
2754 | @end example |
2755 | ||
2756 | Emacs uses two variables to store the prefix argument: | |
2757 | @code{prefix-arg} and @code{current-prefix-arg}. Commands such as | |
2758 | @code{universal-argument} that set up prefix arguments for other | |
2759 | commands store them in @code{prefix-arg}. In contrast, | |
2760 | @code{current-prefix-arg} conveys the prefix argument to the current | |
2761 | command, so setting it has no effect on the prefix arguments for future | |
2762 | commands. | |
2763 | ||
2764 | Normally, commands specify which representation to use for the prefix | |
2765 | argument, either numeric or raw, in the @code{interactive} declaration. | |
b22f3a19 | 2766 | (@xref{Using Interactive}.) Alternatively, functions may look at the |
8db970a4 RS |
2767 | value of the prefix argument directly in the variable |
2768 | @code{current-prefix-arg}, but this is less clean. | |
2769 | ||
f142f62a RS |
2770 | @defun prefix-numeric-value arg |
2771 | This function returns the numeric meaning of a valid raw prefix argument | |
2772 | value, @var{arg}. The argument may be a symbol, a number, or a list. | |
b22f3a19 RS |
2773 | If it is @code{nil}, the value 1 is returned; if it is @code{-}, the |
2774 | value @minus{}1 is returned; if it is a number, that number is returned; | |
4bdcd3ef | 2775 | if it is a list, the @sc{car} of that list (which should be a number) is |
b22f3a19 | 2776 | returned. |
f142f62a RS |
2777 | @end defun |
2778 | ||
2779 | @defvar current-prefix-arg | |
2780 | This variable holds the raw prefix argument for the @emph{current} | |
9e2b495b RS |
2781 | command. Commands may examine it directly, but the usual method for |
2782 | accessing it is with @code{(interactive "P")}. | |
f142f62a RS |
2783 | @end defvar |
2784 | ||
2785 | @defvar prefix-arg | |
2786 | The value of this variable is the raw prefix argument for the | |
f9f59935 RS |
2787 | @emph{next} editing command. Commands such as @code{universal-argument} |
2788 | that specify prefix arguments for the following command work by setting | |
2789 | this variable. | |
03c6b7f6 RS |
2790 | @end defvar |
2791 | ||
03c6b7f6 RS |
2792 | @defvar last-prefix-arg |
2793 | The raw prefix argument value used by the previous command. | |
f142f62a RS |
2794 | @end defvar |
2795 | ||
f9f59935 RS |
2796 | The following commands exist to set up prefix arguments for the |
2797 | following command. Do not call them for any other reason. | |
8db970a4 RS |
2798 | |
2799 | @deffn Command universal-argument | |
2800 | This command reads input and specifies a prefix argument for the | |
2801 | following command. Don't call this command yourself unless you know | |
2802 | what you are doing. | |
2803 | @end deffn | |
2804 | ||
2805 | @deffn Command digit-argument arg | |
2806 | This command adds to the prefix argument for the following command. The | |
2807 | argument @var{arg} is the raw prefix argument as it was before this | |
2808 | command; it is used to compute the updated prefix argument. Don't call | |
2809 | this command yourself unless you know what you are doing. | |
2810 | @end deffn | |
2811 | ||
2812 | @deffn Command negative-argument arg | |
2813 | This command adds to the numeric argument for the next command. The | |
2814 | argument @var{arg} is the raw prefix argument as it was before this | |
2815 | command; its value is negated to form the new prefix argument. Don't | |
2816 | call this command yourself unless you know what you are doing. | |
2817 | @end deffn | |
2818 | ||
8db970a4 RS |
2819 | @node Recursive Editing |
2820 | @section Recursive Editing | |
2821 | @cindex recursive command loop | |
2822 | @cindex recursive editing level | |
2823 | @cindex command loop, recursive | |
2824 | ||
f142f62a RS |
2825 | The Emacs command loop is entered automatically when Emacs starts up. |
2826 | This top-level invocation of the command loop never exits; it keeps | |
2827 | running as long as Emacs does. Lisp programs can also invoke the | |
2828 | command loop. Since this makes more than one activation of the command | |
2829 | loop, we call it @dfn{recursive editing}. A recursive editing level has | |
2830 | the effect of suspending whatever command invoked it and permitting the | |
2831 | user to do arbitrary editing before resuming that command. | |
8db970a4 RS |
2832 | |
2833 | The commands available during recursive editing are the same ones | |
2834 | available in the top-level editing loop and defined in the keymaps. | |
2835 | Only a few special commands exit the recursive editing level; the others | |
f142f62a RS |
2836 | return to the recursive editing level when they finish. (The special |
2837 | commands for exiting are always available, but they do nothing when | |
2838 | recursive editing is not in progress.) | |
8db970a4 RS |
2839 | |
2840 | All command loops, including recursive ones, set up all-purpose error | |
2841 | handlers so that an error in a command run from the command loop will | |
2842 | not exit the loop. | |
2843 | ||
2844 | @cindex minibuffer input | |
2845 | Minibuffer input is a special kind of recursive editing. It has a few | |
2846 | special wrinkles, such as enabling display of the minibuffer and the | |
2847 | minibuffer window, but fewer than you might suppose. Certain keys | |
2848 | behave differently in the minibuffer, but that is only because of the | |
2849 | minibuffer's local map; if you switch windows, you get the usual Emacs | |
2850 | commands. | |
2851 | ||
2852 | @cindex @code{throw} example | |
2853 | @kindex exit | |
2854 | @cindex exit recursive editing | |
2855 | @cindex aborting | |
2856 | To invoke a recursive editing level, call the function | |
2857 | @code{recursive-edit}. This function contains the command loop; it also | |
2858 | contains a call to @code{catch} with tag @code{exit}, which makes it | |
2859 | possible to exit the recursive editing level by throwing to @code{exit} | |
2860 | (@pxref{Catch and Throw}). If you throw a value other than @code{t}, | |
2861 | then @code{recursive-edit} returns normally to the function that called | |
2862 | it. The command @kbd{C-M-c} (@code{exit-recursive-edit}) does this. | |
2863 | Throwing a @code{t} value causes @code{recursive-edit} to quit, so that | |
2864 | control returns to the command loop one level up. This is called | |
2865 | @dfn{aborting}, and is done by @kbd{C-]} (@code{abort-recursive-edit}). | |
2866 | ||
2867 | Most applications should not use recursive editing, except as part of | |
2868 | using the minibuffer. Usually it is more convenient for the user if you | |
2869 | change the major mode of the current buffer temporarily to a special | |
b22f3a19 RS |
2870 | major mode, which should have a command to go back to the previous mode. |
2871 | (The @kbd{e} command in Rmail uses this technique.) Or, if you wish to | |
2872 | give the user different text to edit ``recursively'', create and select | |
2873 | a new buffer in a special mode. In this mode, define a command to | |
2874 | complete the processing and go back to the previous buffer. (The | |
2875 | @kbd{m} command in Rmail does this.) | |
8db970a4 RS |
2876 | |
2877 | Recursive edits are useful in debugging. You can insert a call to | |
2878 | @code{debug} into a function definition as a sort of breakpoint, so that | |
2879 | you can look around when the function gets there. @code{debug} invokes | |
2880 | a recursive edit but also provides the other features of the debugger. | |
2881 | ||
2882 | Recursive editing levels are also used when you type @kbd{C-r} in | |
2883 | @code{query-replace} or use @kbd{C-x q} (@code{kbd-macro-query}). | |
2884 | ||
2885 | @defun recursive-edit | |
2886 | @cindex suspend evaluation | |
2887 | This function invokes the editor command loop. It is called | |
2888 | automatically by the initialization of Emacs, to let the user begin | |
2889 | editing. When called from a Lisp program, it enters a recursive editing | |
2890 | level. | |
2891 | ||
2892 | In the following example, the function @code{simple-rec} first | |
2893 | advances point one word, then enters a recursive edit, printing out a | |
2894 | message in the echo area. The user can then do any editing desired, and | |
2895 | then type @kbd{C-M-c} to exit and continue executing @code{simple-rec}. | |
2896 | ||
2897 | @example | |
2898 | (defun simple-rec () | |
2899 | (forward-word 1) | |
f142f62a | 2900 | (message "Recursive edit in progress") |
8db970a4 RS |
2901 | (recursive-edit) |
2902 | (forward-word 1)) | |
2903 | @result{} simple-rec | |
2904 | (simple-rec) | |
2905 | @result{} nil | |
2906 | @end example | |
2907 | @end defun | |
2908 | ||
2909 | @deffn Command exit-recursive-edit | |
2910 | This function exits from the innermost recursive edit (including | |
2911 | minibuffer input). Its definition is effectively @code{(throw 'exit | |
177c0ea7 | 2912 | nil)}. |
8db970a4 RS |
2913 | @end deffn |
2914 | ||
2915 | @deffn Command abort-recursive-edit | |
2916 | This function aborts the command that requested the innermost recursive | |
177c0ea7 | 2917 | edit (including minibuffer input), by signaling @code{quit} |
8db970a4 RS |
2918 | after exiting the recursive edit. Its definition is effectively |
2919 | @code{(throw 'exit t)}. @xref{Quitting}. | |
2920 | @end deffn | |
2921 | ||
2922 | @deffn Command top-level | |
2923 | This function exits all recursive editing levels; it does not return a | |
2924 | value, as it jumps completely out of any computation directly back to | |
2925 | the main command loop. | |
2926 | @end deffn | |
2927 | ||
2928 | @defun recursion-depth | |
2929 | This function returns the current depth of recursive edits. When no | |
2930 | recursive edit is active, it returns 0. | |
2931 | @end defun | |
2932 | ||
2933 | @node Disabling Commands | |
2934 | @section Disabling Commands | |
2935 | @cindex disabled command | |
2936 | ||
2937 | @dfn{Disabling a command} marks the command as requiring user | |
2938 | confirmation before it can be executed. Disabling is used for commands | |
2939 | which might be confusing to beginning users, to prevent them from using | |
2940 | the commands by accident. | |
2941 | ||
2942 | @kindex disabled | |
2943 | The low-level mechanism for disabling a command is to put a | |
2944 | non-@code{nil} @code{disabled} property on the Lisp symbol for the | |
2945 | command. These properties are normally set up by the user's | |
a40d4712 | 2946 | init file (@pxref{Init File}) with Lisp expressions such as this: |
8db970a4 RS |
2947 | |
2948 | @example | |
2949 | (put 'upcase-region 'disabled t) | |
2950 | @end example | |
2951 | ||
2952 | @noindent | |
a40d4712 PR |
2953 | For a few commands, these properties are present by default (you can |
2954 | remove them in your init file if you wish). | |
8db970a4 | 2955 | |
f142f62a RS |
2956 | If the value of the @code{disabled} property is a string, the message |
2957 | saying the command is disabled includes that string. For example: | |
8db970a4 RS |
2958 | |
2959 | @example | |
2960 | (put 'delete-region 'disabled | |
2961 | "Text deleted this way cannot be yanked back!\n") | |
2962 | @end example | |
2963 | ||
2964 | @xref{Disabling,,, emacs, The GNU Emacs Manual}, for the details on | |
2965 | what happens when a disabled command is invoked interactively. | |
2966 | Disabling a command has no effect on calling it as a function from Lisp | |
2967 | programs. | |
2968 | ||
2969 | @deffn Command enable-command command | |
5504e99c LT |
2970 | Allow @var{command} (a symbol) to be executed without special |
2971 | confirmation from now on, and alter the user's init file (@pxref{Init | |
a40d4712 | 2972 | File}) so that this will apply to future sessions. |
8db970a4 RS |
2973 | @end deffn |
2974 | ||
2975 | @deffn Command disable-command command | |
f142f62a | 2976 | Require special confirmation to execute @var{command} from now on, and |
5504e99c | 2977 | alter the user's init file so that this will apply to future sessions. |
8db970a4 RS |
2978 | @end deffn |
2979 | ||
de700726 LT |
2980 | @defvar disabled-command-function |
2981 | The value of this variable should be a function. When the user | |
2982 | invokes a disabled command interactively, this function is called | |
2983 | instead of the disabled command. It can use @code{this-command-keys} | |
2984 | to determine what the user typed to run the command, and thus find the | |
2985 | command itself. | |
8db970a4 | 2986 | |
de700726 LT |
2987 | The value may also be @code{nil}. Then all commands work normally, |
2988 | even disabled ones. | |
2989 | ||
2990 | By default, the value is a function that asks the user whether to | |
2991 | proceed. | |
8db970a4 RS |
2992 | @end defvar |
2993 | ||
2994 | @node Command History | |
2995 | @section Command History | |
2996 | @cindex command history | |
2997 | @cindex complex command | |
2998 | @cindex history of commands | |
2999 | ||
3000 | The command loop keeps a history of the complex commands that have | |
3001 | been executed, to make it convenient to repeat these commands. A | |
3002 | @dfn{complex command} is one for which the interactive argument reading | |
3003 | uses the minibuffer. This includes any @kbd{M-x} command, any | |
bfe721d1 | 3004 | @kbd{M-:} command, and any command whose @code{interactive} |
8db970a4 RS |
3005 | specification reads an argument from the minibuffer. Explicit use of |
3006 | the minibuffer during the execution of the command itself does not cause | |
3007 | the command to be considered complex. | |
3008 | ||
3009 | @defvar command-history | |
3010 | This variable's value is a list of recent complex commands, each | |
3011 | represented as a form to evaluate. It continues to accumulate all | |
a9f0a989 | 3012 | complex commands for the duration of the editing session, but when it |
b18531e5 RS |
3013 | reaches the maximum size (@pxref{Minibuffer History}), the oldest |
3014 | elements are deleted as new ones are added. | |
8db970a4 RS |
3015 | |
3016 | @example | |
3017 | @group | |
3018 | command-history | |
3019 | @result{} ((switch-to-buffer "chistory.texi") | |
3020 | (describe-key "^X^[") | |
3021 | (visit-tags-table "~/emacs/src/") | |
3022 | (find-tag "repeat-complex-command")) | |
3023 | @end group | |
3024 | @end example | |
3025 | @end defvar | |
3026 | ||
3027 | This history list is actually a special case of minibuffer history | |
3028 | (@pxref{Minibuffer History}), with one special twist: the elements are | |
3029 | expressions rather than strings. | |
3030 | ||
3031 | There are a number of commands devoted to the editing and recall of | |
3032 | previous commands. The commands @code{repeat-complex-command}, and | |
3033 | @code{list-command-history} are described in the user manual | |
3034 | (@pxref{Repetition,,, emacs, The GNU Emacs Manual}). Within the | |
f9f59935 | 3035 | minibuffer, the usual minibuffer history commands are available. |
8db970a4 RS |
3036 | |
3037 | @node Keyboard Macros | |
3038 | @section Keyboard Macros | |
3039 | @cindex keyboard macros | |
3040 | ||
3041 | A @dfn{keyboard macro} is a canned sequence of input events that can | |
f142f62a RS |
3042 | be considered a command and made the definition of a key. The Lisp |
3043 | representation of a keyboard macro is a string or vector containing the | |
3044 | events. Don't confuse keyboard macros with Lisp macros | |
3045 | (@pxref{Macros}). | |
8db970a4 | 3046 | |
5504e99c | 3047 | @defun execute-kbd-macro kbdmacro &optional count loopfunc |
f9f59935 RS |
3048 | This function executes @var{kbdmacro} as a sequence of events. If |
3049 | @var{kbdmacro} is a string or vector, then the events in it are executed | |
8db970a4 RS |
3050 | exactly as if they had been input by the user. The sequence is |
3051 | @emph{not} expected to be a single key sequence; normally a keyboard | |
3052 | macro definition consists of several key sequences concatenated. | |
3053 | ||
f9f59935 RS |
3054 | If @var{kbdmacro} is a symbol, then its function definition is used in |
3055 | place of @var{kbdmacro}. If that is another symbol, this process repeats. | |
8db970a4 RS |
3056 | Eventually the result should be a string or vector. If the result is |
3057 | not a symbol, string, or vector, an error is signaled. | |
3058 | ||
f9f59935 RS |
3059 | The argument @var{count} is a repeat count; @var{kbdmacro} is executed that |
3060 | many times. If @var{count} is omitted or @code{nil}, @var{kbdmacro} is | |
3061 | executed once. If it is 0, @var{kbdmacro} is executed over and over until it | |
177c0ea7 | 3062 | encounters an error or a failing search. |
f9f59935 | 3063 | |
5504e99c LT |
3064 | If @var{loopfunc} is non-@code{nil}, it is a function that is called, |
3065 | without arguments, prior to each iteration of the macro. If | |
3066 | @var{loopfunc} returns @code{nil}, then this stops execution of the macro. | |
3067 | ||
f9f59935 | 3068 | @xref{Reading One Event}, for an example of using @code{execute-kbd-macro}. |
8db970a4 RS |
3069 | @end defun |
3070 | ||
5504e99c | 3071 | @defvar executing-kbd-macro |
8db970a4 RS |
3072 | This variable contains the string or vector that defines the keyboard |
3073 | macro that is currently executing. It is @code{nil} if no macro is | |
f9f59935 | 3074 | currently executing. A command can test this variable so as to behave |
f142f62a RS |
3075 | differently when run from an executing macro. Do not set this variable |
3076 | yourself. | |
8db970a4 RS |
3077 | @end defvar |
3078 | ||
3079 | @defvar defining-kbd-macro | |
5504e99c LT |
3080 | This variable is non-@code{nil} if and only if a keyboard macro is |
3081 | being defined. A command can test this variable so as to behave | |
f9597b5b LT |
3082 | differently while a macro is being defined. The value is |
3083 | @code{append} while appending to the definition of an existing macro. | |
3084 | The commands @code{start-kbd-macro}, @code{kmacro-start-macro} and | |
3085 | @code{end-kbd-macro} set this variable---do not set it yourself. | |
22697dac | 3086 | |
bfe721d1 KH |
3087 | The variable is always local to the current terminal and cannot be |
3088 | buffer-local. @xref{Multiple Displays}. | |
3089 | @end defvar | |
3090 | ||
3091 | @defvar last-kbd-macro | |
3092 | This variable is the definition of the most recently defined keyboard | |
3093 | macro. Its value is a string or vector, or @code{nil}. | |
3094 | ||
3095 | The variable is always local to the current terminal and cannot be | |
22697dac | 3096 | buffer-local. @xref{Multiple Displays}. |
8db970a4 RS |
3097 | @end defvar |
3098 | ||
2842de30 EZ |
3099 | @defvar kbd-macro-termination-hook |
3100 | This normal hook (@pxref{Standard Hooks}) is run when a keyboard | |
3101 | macro terminates, regardless of what caused it to terminate (reaching | |
3102 | the macro end or an error which ended the macro prematurely). | |
3103 | @end defvar | |
ab5796a9 MB |
3104 | |
3105 | @ignore | |
3106 | arch-tag: e34944ad-7d5c-4980-be00-36a5fe54d4b1 | |
3107 | @end ignore |