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