annotate lispref/commands.texi @ 82565:2f0ad88114c2

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