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