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