Mercurial > emacs
annotate lispref/minibuf.texi @ 55031:488c36800dcc
(image_ascent): Remove prototype.
author | Kim F. Storm <storm@cua.dk> |
---|---|
date | Tue, 20 Apr 2004 22:19:43 +0000 |
parents | 1f35da88bdd8 |
children | b1e16cd7f843 |
rev | line source |
---|---|
6555 | 1 @c -*-texinfo-*- |
2 @c This is part of the GNU Emacs Lisp Reference Manual. | |
39531
35c1673ff6ab
(Minibuffer Misc): Add entries for `minibuffer-contents',
Miles Bader <miles@gnu.org>
parents:
38159
diff
changeset
|
3 @c Copyright (C) 1990, 1991, 1992, 1993, 1994, 1995, 1998, 1999, 2001 |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48730
diff
changeset
|
4 @c Free Software Foundation, Inc. |
6555 | 5 @c See the file elisp.texi for copying conditions. |
6 @setfilename ../info/minibuf | |
7337
cd57cd335fff
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7221
diff
changeset
|
7 @node Minibuffers, Command Loop, Read and Print, Top |
6555 | 8 @chapter Minibuffers |
9 @cindex arguments, reading | |
10 @cindex complex arguments | |
11 @cindex minibuffer | |
12 | |
13 A @dfn{minibuffer} is a special buffer that Emacs commands use to read | |
14 arguments more complicated than the single numeric prefix argument. | |
15 These arguments include file names, buffer names, and command names (as | |
16 in @kbd{M-x}). The minibuffer is displayed on the bottom line of the | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
17 frame, in the same place as the echo area, but only while it is in use |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
18 for reading an argument. |
6555 | 19 |
20 @menu | |
21 * Intro to Minibuffers:: Basic information about minibuffers. | |
22 * Text from Minibuffer:: How to read a straight text string. | |
23 * Object from Minibuffer:: How to read a Lisp object or expression. | |
24 * Minibuffer History:: Recording previous minibuffer inputs | |
25 so the user can reuse them. | |
26 * Completion:: How to invoke and customize completion. | |
27 * Yes-or-No Queries:: Asking a question with a simple answer. | |
28 * Multiple Queries:: Asking a series of similar questions. | |
23147 | 29 * Reading a Password:: Reading a password from the terminal. |
6555 | 30 * Minibuffer Misc:: Various customization hooks and variables. |
31 @end menu | |
32 | |
33 @node Intro to Minibuffers | |
34 @section Introduction to Minibuffers | |
35 | |
36 In most ways, a minibuffer is a normal Emacs buffer. Most operations | |
37 @emph{within} a buffer, such as editing commands, work normally in a | |
38 minibuffer. However, many operations for managing buffers do not apply | |
39 to minibuffers. The name of a minibuffer always has the form @w{@samp{ | |
46915 | 40 *Minibuf-@var{number}*}}, and it cannot be changed. Minibuffers are |
6555 | 41 displayed only in special windows used only for minibuffers; these |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
42 windows always appear at the bottom of a frame. (Sometimes frames have |
6555 | 43 no minibuffer window, and sometimes a special kind of frame contains |
44 nothing but a minibuffer window; see @ref{Minibuffers and Frames}.) | |
45 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23147
diff
changeset
|
46 The text in the minibuffer always starts with the @dfn{prompt string}, |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23147
diff
changeset
|
47 the text that was specified by the program that is using the minibuffer |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23147
diff
changeset
|
48 to tell the user what sort of input to type. This text is marked |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
49 read-only so you won't accidentally delete or change it. It is also |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
50 marked as a field (@pxref{Fields}), so that certain motion functions, |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
51 including @code{beginning-of-line}, @code{forward-word}, |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
52 @code{forward-sentence}, and @code{forward-paragraph}, stop at the |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
53 boundary between the prompt and the actual text. (In older Emacs |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
54 versions, the prompt was displayed using a special mechanism and was not |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
55 part of the buffer contents.) |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23147
diff
changeset
|
56 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23147
diff
changeset
|
57 The minibuffer's window is normally a single line; it grows |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23147
diff
changeset
|
58 automatically if necessary if the contents require more space. You can |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23147
diff
changeset
|
59 explicitly resize it temporarily with the window sizing commands; it |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23147
diff
changeset
|
60 reverts to its normal size when the minibuffer is exited. You can |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23147
diff
changeset
|
61 resize it permanently by using the window sizing commands in the frame's |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23147
diff
changeset
|
62 other window, when the minibuffer is not active. If the frame contains |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23147
diff
changeset
|
63 just a minibuffer, you can change the minibuffer's size by changing the |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23147
diff
changeset
|
64 frame's size. |
6555 | 65 |
52485
7fc901c75a7d
(Intro to Minibuffers): Explain that the minibuffer
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
66 Use of the minibuffer reads input events, and that alters the values |
7fc901c75a7d
(Intro to Minibuffers): Explain that the minibuffer
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
67 of variables such as @code{this-command} and @code{last-command} |
7fc901c75a7d
(Intro to Minibuffers): Explain that the minibuffer
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
68 (@pxref{Command Loop Info}). Your program should bind them around the |
7fc901c75a7d
(Intro to Minibuffers): Explain that the minibuffer
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
69 code that uses the minibuffer, if you do not want that to change them. |
7fc901c75a7d
(Intro to Minibuffers): Explain that the minibuffer
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
70 |
6555 | 71 If a command uses a minibuffer while there is an active minibuffer, |
72 this is called a @dfn{recursive minibuffer}. The first minibuffer is | |
73 named @w{@samp{ *Minibuf-0*}}. Recursive minibuffers are named by | |
74 incrementing the number at the end of the name. (The names begin with a | |
75 space so that they won't show up in normal buffer lists.) Of several | |
76 recursive minibuffers, the innermost (or most recently entered) is the | |
77 active minibuffer. We usually call this ``the'' minibuffer. You can | |
78 permit or forbid recursive minibuffers by setting the variable | |
79 @code{enable-recursive-minibuffers} or by putting properties of that | |
80 name on command symbols (@pxref{Minibuffer Misc}). | |
81 | |
82 Like other buffers, a minibuffer may use any of several local keymaps | |
83 (@pxref{Keymaps}); these contain various exit commands and in some cases | |
12098 | 84 completion commands (@pxref{Completion}). |
6555 | 85 |
86 @itemize @bullet | |
87 @item | |
88 @code{minibuffer-local-map} is for ordinary input (no completion). | |
89 | |
90 @item | |
91 @code{minibuffer-local-ns-map} is similar, except that @key{SPC} exits | |
51914
9cd313749c97
(Basic Completion): Add lazy-completion-table.
Richard M. Stallman <rms@gnu.org>
parents:
51703
diff
changeset
|
92 just like @key{RET}. |
6555 | 93 |
94 @item | |
95 @code{minibuffer-local-completion-map} is for permissive completion. | |
96 | |
97 @item | |
98 @code{minibuffer-local-must-match-map} is for strict completion and | |
99 for cautious completion. | |
100 @end itemize | |
101 | |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
102 When Emacs is running in batch mode, any request to read from the |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
103 minibuffer actually reads a line from the standard input descriptor that |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
104 was supplied when Emacs was started. |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
105 |
6555 | 106 @node Text from Minibuffer |
107 @section Reading Text Strings with the Minibuffer | |
108 | |
7221
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
109 Most often, the minibuffer is used to read text as a string. It can |
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
110 also be used to read a Lisp object in textual form. The most basic |
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
111 primitive for minibuffer input is @code{read-from-minibuffer}; it can do |
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
112 either one. |
6555 | 113 |
12098 | 114 In most cases, you should not call minibuffer input functions in the |
115 middle of a Lisp function. Instead, do all minibuffer input as part of | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
116 reading the arguments for a command, in the @code{interactive} |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
117 specification. @xref{Defining Commands}. |
12098 | 118 |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
119 @defun read-from-minibuffer prompt-string &optional initial-contents keymap read hist default inherit-input-method |
6555 | 120 This function is the most general way to get input through the |
121 minibuffer. By default, it accepts arbitrary text and returns it as a | |
122 string; however, if @var{read} is non-@code{nil}, then it uses | |
123 @code{read} to convert the text into a Lisp object (@pxref{Input | |
124 Functions}). | |
125 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
126 The first thing this function does is to activate a minibuffer and |
6555 | 127 display it with @var{prompt-string} as the prompt. This value must be a |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
128 string. Then the user can edit text in the minibuffer. |
6555 | 129 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
130 When the user types a command to exit the minibuffer, |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
131 @code{read-from-minibuffer} constructs the return value from the text in |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
132 the minibuffer. Normally it returns a string containing that text. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
133 However, if @var{read} is non-@code{nil}, @code{read-from-minibuffer} |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
134 reads the text and returns the resulting Lisp object, unevaluated. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
135 (@xref{Input Functions}, for information about reading.) |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
136 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
137 The argument @var{default} specifies a default value to make available |
53801
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
138 through the history commands. It should be a string, or @code{nil}. |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
139 If non-@code{nil}, the user can access it using |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
140 @code{next-history-element}, usually bound in the minibuffer to |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
141 @kbd{M-n}. If @var{read} is non-@code{nil}, then @var{default} is |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
142 also used as the input to @code{read}, if the user enters empty input. |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
143 (If @var{read} is non-@code{nil} and @var{default} is @code{nil}, empty |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
144 input results in an @code{end-of-file} error.) However, in the usual |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
145 case (where @var{read} is @code{nil}), @code{read-from-minibuffer} |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
146 ignores @var{default} when the user enters empty input and returns an |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
147 empty string, @code{""}. In this respect, it is different from all |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
148 the other minibuffer input functions in this chapter. |
6555 | 149 |
150 If @var{keymap} is non-@code{nil}, that keymap is the local keymap to | |
151 use in the minibuffer. If @var{keymap} is omitted or @code{nil}, the | |
152 value of @code{minibuffer-local-map} is used as the keymap. Specifying | |
153 a keymap is the most important way to customize the minibuffer for | |
154 various applications such as completion. | |
155 | |
156 The argument @var{hist} specifies which history list variable to use | |
157 for saving the input and for history commands used in the minibuffer. | |
158 It defaults to @code{minibuffer-history}. @xref{Minibuffer History}. | |
159 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
160 If the variable @code{minibuffer-allow-text-properties} is |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
161 non-@code{nil}, then the string which is returned includes whatever text |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
162 properties were present in the minibuffer. Otherwise all the text |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
163 properties are stripped when the value is returned. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
164 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
165 If the argument @var{inherit-input-method} is non-@code{nil}, then the |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
166 minibuffer inherits the current input method (@pxref{Input Methods}) and |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
167 the setting of @code{enable-multibyte-characters} (@pxref{Text |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
168 Representations}) from whichever buffer was current before entering the |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
169 minibuffer. |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
170 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
171 If @var{initial-contents} is a string, @code{read-from-minibuffer} |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
172 inserts it into the minibuffer, leaving point at the end, before the |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
173 user starts to edit the text. The minibuffer appears with this text as |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
174 its initial contents. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
175 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
176 Alternatively, @var{initial-contents} can be a cons cell of the form |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
177 @code{(@var{string} . @var{position})}. This means to insert |
53801
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
178 @var{string} in the minibuffer but put point at @emph{one-indexed} |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
179 @var{position} in the minibuffer, rather than at the end. Any integer |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
180 value less or equal to one puts point at the beginning of the string. |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
181 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
182 @strong{Usage note:} The @var{initial-contents} argument and the |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
183 @var{default} argument are two alternative features for more or less the |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
184 same job. It does not make sense to use both features in a single call |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
185 to @code{read-from-minibuffer}. In general, we recommend using |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
186 @var{default}, since this permits the user to insert the default value |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
187 when it is wanted, but does not burden the user with deleting it from |
53801
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
188 the minibuffer on other occasions. For an exception to this rule, |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
189 see @ref{Minibuffer History}. |
6555 | 190 @end defun |
191 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
192 @defun read-string prompt &optional initial history default inherit-input-method |
6555 | 193 This function reads a string from the minibuffer and returns it. The |
53801
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
194 arguments @var{prompt}, @var{initial}, @var{history} and |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
195 @var{inherit-input-method} are used as in @code{read-from-minibuffer}. |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
196 The keymap used is @code{minibuffer-local-map}. |
6555 | 197 |
53801
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
198 The optional argument @var{default} is used as in |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
199 @code{read-from-minibuffer}, except that, if non-@code{nil}, it also |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
200 specifies a default value to return if the user enters null input. As |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
201 in @code{read-from-minibuffer} it should be a string, or @code{nil}, |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
202 which is equivalent to an empty string. |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
203 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
204 This function is a simplified interface to the |
6555 | 205 @code{read-from-minibuffer} function: |
206 | |
207 @smallexample | |
208 @group | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
209 (read-string @var{prompt} @var{initial} @var{history} @var{default} @var{inherit}) |
6555 | 210 @equiv{} |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
211 (let ((value |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
212 (read-from-minibuffer @var{prompt} @var{initial} nil nil |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
213 @var{history} @var{default} @var{inherit}))) |
53801
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
214 (if (and (equal value "") @var{default}) |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
215 @var{default} |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
216 value)) |
6555 | 217 @end group |
218 @end smallexample | |
219 @end defun | |
220 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
221 @defvar minibuffer-allow-text-properties |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
222 If this variable is @code{nil}, then @code{read-from-minibuffer} strips |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
223 all text properties from the minibuffer input before returning it. |
53801
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
224 This variable also affects @code{read-string}. However, |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
225 @code{read-no-blanks-input} (see below), as well as |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
226 @code{read-minibuffer} and related functions (@pxref{Object from |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
227 Minibuffer,, Reading Lisp Objects With the Minibuffer}), and all |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
228 functions that do minibuffer input with completion, discard text |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
229 properties unconditionally, regardless of the value of this variable. |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
230 @end defvar |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
231 |
53801
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
232 @anchor{Definition of minibuffer-local-map} |
6555 | 233 @defvar minibuffer-local-map |
234 This is the default local keymap for reading from the minibuffer. By | |
235 default, it makes the following bindings: | |
236 | |
237 @table @asis | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
238 @item @kbd{C-j} |
6555 | 239 @code{exit-minibuffer} |
240 | |
241 @item @key{RET} | |
242 @code{exit-minibuffer} | |
243 | |
244 @item @kbd{C-g} | |
245 @code{abort-recursive-edit} | |
246 | |
247 @item @kbd{M-n} | |
248 @code{next-history-element} | |
249 | |
250 @item @kbd{M-p} | |
251 @code{previous-history-element} | |
252 | |
53801
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
253 @item @kbd{M-s} |
6555 | 254 @code{next-matching-history-element} |
255 | |
53801
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
256 @item @kbd{M-r} |
6555 | 257 @code{previous-matching-history-element} |
258 @end table | |
259 @end defvar | |
260 | |
261 @c In version 18, initial is required | |
262 @c Emacs 19 feature | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
263 @defun read-no-blanks-input prompt &optional initial inherit-input-method |
6555 | 264 This function reads a string from the minibuffer, but does not allow |
265 whitespace characters as part of the input: instead, those characters | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
266 terminate the input. The arguments @var{prompt}, @var{initial}, and |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
267 @var{inherit-input-method} are used as in @code{read-from-minibuffer}. |
6555 | 268 |
269 This is a simplified interface to the @code{read-from-minibuffer} | |
270 function, and passes the value of the @code{minibuffer-local-ns-map} | |
271 keymap as the @var{keymap} argument for that function. Since the keymap | |
272 @code{minibuffer-local-ns-map} does not rebind @kbd{C-q}, it @emph{is} | |
273 possible to put a space into the string, by quoting it. | |
274 | |
53801
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
275 This function discards text properties, regardless of the value of |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
276 @code{minibuffer-allow-text-properties}. |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
277 |
6555 | 278 @smallexample |
279 @group | |
280 (read-no-blanks-input @var{prompt} @var{initial}) | |
281 @equiv{} | |
53801
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
282 (let (minibuffer-allow-text-properties) |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
283 (read-from-minibuffer @var{prompt} @var{initial} minibuffer-local-ns-map)) |
6555 | 284 @end group |
285 @end smallexample | |
286 @end defun | |
287 | |
288 @defvar minibuffer-local-ns-map | |
289 This built-in variable is the keymap used as the minibuffer local keymap | |
290 in the function @code{read-no-blanks-input}. By default, it makes the | |
12098 | 291 following bindings, in addition to those of @code{minibuffer-local-map}: |
6555 | 292 |
293 @table @asis | |
294 @item @key{SPC} | |
295 @cindex @key{SPC} in minibuffer | |
296 @code{exit-minibuffer} | |
297 | |
298 @item @key{TAB} | |
299 @cindex @key{TAB} in minibuffer | |
300 @code{exit-minibuffer} | |
301 | |
302 @item @kbd{?} | |
303 @cindex @kbd{?} in minibuffer | |
304 @code{self-insert-and-exit} | |
305 @end table | |
306 @end defvar | |
307 | |
308 @node Object from Minibuffer | |
309 @section Reading Lisp Objects with the Minibuffer | |
310 | |
311 This section describes functions for reading Lisp objects with the | |
312 minibuffer. | |
313 | |
314 @defun read-minibuffer prompt &optional initial | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
315 This function reads a Lisp object using the minibuffer, and returns it |
6555 | 316 without evaluating it. The arguments @var{prompt} and @var{initial} are |
7221
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
317 used as in @code{read-from-minibuffer}. |
6555 | 318 |
7221
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
319 This is a simplified interface to the |
6555 | 320 @code{read-from-minibuffer} function: |
321 | |
322 @smallexample | |
323 @group | |
324 (read-minibuffer @var{prompt} @var{initial}) | |
325 @equiv{} | |
53801
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
326 (let (minibuffer-allow-text-properties) |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
327 (read-from-minibuffer @var{prompt} @var{initial} nil t)) |
6555 | 328 @end group |
329 @end smallexample | |
330 | |
331 Here is an example in which we supply the string @code{"(testing)"} as | |
332 initial input: | |
333 | |
334 @smallexample | |
335 @group | |
336 (read-minibuffer | |
337 "Enter an expression: " (format "%s" '(testing))) | |
338 | |
339 ;; @r{Here is how the minibuffer is displayed:} | |
340 @end group | |
341 | |
342 @group | |
343 ---------- Buffer: Minibuffer ---------- | |
344 Enter an expression: (testing)@point{} | |
345 ---------- Buffer: Minibuffer ---------- | |
346 @end group | |
347 @end smallexample | |
348 | |
349 @noindent | |
350 The user can type @key{RET} immediately to use the initial input as a | |
351 default, or can edit the input. | |
352 @end defun | |
353 | |
354 @defun eval-minibuffer prompt &optional initial | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
355 This function reads a Lisp expression using the minibuffer, evaluates |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
356 it, then returns the result. The arguments @var{prompt} and |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
357 @var{initial} are used as in @code{read-from-minibuffer}. |
6555 | 358 |
7221
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
359 This function simply evaluates the result of a call to |
6555 | 360 @code{read-minibuffer}: |
361 | |
362 @smallexample | |
363 @group | |
364 (eval-minibuffer @var{prompt} @var{initial}) | |
365 @equiv{} | |
366 (eval (read-minibuffer @var{prompt} @var{initial})) | |
367 @end group | |
368 @end smallexample | |
369 @end defun | |
370 | |
371 @defun edit-and-eval-command prompt form | |
7221
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
372 This function reads a Lisp expression in the minibuffer, and then |
6555 | 373 evaluates it. The difference between this command and |
374 @code{eval-minibuffer} is that here the initial @var{form} is not | |
375 optional and it is treated as a Lisp object to be converted to printed | |
376 representation rather than as a string of text. It is printed with | |
377 @code{prin1}, so if it is a string, double-quote characters (@samp{"}) | |
378 appear in the initial text. @xref{Output Functions}. | |
379 | |
7221
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
380 The first thing @code{edit-and-eval-command} does is to activate the |
6555 | 381 minibuffer with @var{prompt} as the prompt. Then it inserts the printed |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
382 representation of @var{form} in the minibuffer, and lets the user edit it. |
6555 | 383 When the user exits the minibuffer, the edited text is read with |
384 @code{read} and then evaluated. The resulting value becomes the value | |
385 of @code{edit-and-eval-command}. | |
386 | |
7221
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
387 In the following example, we offer the user an expression with initial |
6555 | 388 text which is a valid form already: |
389 | |
390 @smallexample | |
391 @group | |
392 (edit-and-eval-command "Please edit: " '(forward-word 1)) | |
393 | |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48730
diff
changeset
|
394 ;; @r{After evaluation of the preceding expression,} |
6555 | 395 ;; @r{the following appears in the minibuffer:} |
396 @end group | |
397 | |
398 @group | |
399 ---------- Buffer: Minibuffer ---------- | |
400 Please edit: (forward-word 1)@point{} | |
401 ---------- Buffer: Minibuffer ---------- | |
402 @end group | |
403 @end smallexample | |
404 | |
405 @noindent | |
406 Typing @key{RET} right away would exit the minibuffer and evaluate the | |
407 expression, thus moving point forward one word. | |
408 @code{edit-and-eval-command} returns @code{nil} in this example. | |
409 @end defun | |
410 | |
411 @node Minibuffer History | |
412 @section Minibuffer History | |
413 @cindex minibuffer history | |
414 @cindex history list | |
415 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
416 A @dfn{minibuffer history list} records previous minibuffer inputs so |
7221
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
417 the user can reuse them conveniently. A history list is actually a |
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
418 symbol, not a list; it is a variable whose value is a list of strings |
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
419 (previous inputs), most recent first. |
6555 | 420 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
421 There are many separate history lists, used for different kinds of |
6555 | 422 inputs. It's the Lisp programmer's job to specify the right history |
423 list for each use of the minibuffer. | |
424 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
425 The basic minibuffer input functions @code{read-from-minibuffer} and |
6555 | 426 @code{completing-read} both accept an optional argument named @var{hist} |
427 which is how you specify the history list. Here are the possible | |
428 values: | |
429 | |
430 @table @asis | |
431 @item @var{variable} | |
432 Use @var{variable} (a symbol) as the history list. | |
433 | |
434 @item (@var{variable} . @var{startpos}) | |
435 Use @var{variable} (a symbol) as the history list, and assume that the | |
53801
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
436 initial history position is @var{startpos} (a nonnegative integer). |
6555 | 437 |
53801
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
438 Specifying 0 for @var{startpos} is equivalent to just specifying the |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
439 symbol @var{variable}. @code{previous-history-element} will display |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
440 the most recent element of the history list in the minibuffer. If you |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
441 specify a positive @var{startpos}, the minibuffer history functions |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
442 behave as if @code{(elt @var{variable} (1- @var{STARTPOS}))} were the |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
443 history element currently shown in the minibuffer. For consistency, |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
444 you should also specify that element of the history as the initial |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
445 minibuffer contents. |
6555 | 446 @end table |
447 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
448 If you don't specify @var{hist}, then the default history list |
6555 | 449 @code{minibuffer-history} is used. For other standard history lists, |
450 see below. You can also create your own history list variable; just | |
451 initialize it to @code{nil} before the first use. | |
452 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
453 Both @code{read-from-minibuffer} and @code{completing-read} add new |
6555 | 454 elements to the history list automatically, and provide commands to |
455 allow the user to reuse items on the list. The only thing your program | |
456 needs to do to use a history list is to initialize it and to pass its | |
457 name to the input functions when you wish. But it is safe to modify the | |
458 list by hand when the minibuffer input functions are not using it. | |
459 | |
48730
e7f0249cfca8
Document history-length.
Richard M. Stallman <rms@gnu.org>
parents:
46915
diff
changeset
|
460 Emacs functions that add a new element to a history list can also |
e7f0249cfca8
Document history-length.
Richard M. Stallman <rms@gnu.org>
parents:
46915
diff
changeset
|
461 delete old elements if the list gets too long. The variable |
e7f0249cfca8
Document history-length.
Richard M. Stallman <rms@gnu.org>
parents:
46915
diff
changeset
|
462 @code{history-length} specifies the maximum length for most history |
e7f0249cfca8
Document history-length.
Richard M. Stallman <rms@gnu.org>
parents:
46915
diff
changeset
|
463 lists. To specify a different maximum length for a particular history |
e7f0249cfca8
Document history-length.
Richard M. Stallman <rms@gnu.org>
parents:
46915
diff
changeset
|
464 list, put the length in the @code{history-length} property of the |
e7f0249cfca8
Document history-length.
Richard M. Stallman <rms@gnu.org>
parents:
46915
diff
changeset
|
465 history list symbol. |
e7f0249cfca8
Document history-length.
Richard M. Stallman <rms@gnu.org>
parents:
46915
diff
changeset
|
466 |
e7f0249cfca8
Document history-length.
Richard M. Stallman <rms@gnu.org>
parents:
46915
diff
changeset
|
467 @defvar history-length |
e7f0249cfca8
Document history-length.
Richard M. Stallman <rms@gnu.org>
parents:
46915
diff
changeset
|
468 The value of this variable specifies the maximum length for all |
e7f0249cfca8
Document history-length.
Richard M. Stallman <rms@gnu.org>
parents:
46915
diff
changeset
|
469 history lists that don't specify their own maximum lengths. If the |
e7f0249cfca8
Document history-length.
Richard M. Stallman <rms@gnu.org>
parents:
46915
diff
changeset
|
470 value is @code{t}, that means there no maximum (don't delete old |
e7f0249cfca8
Document history-length.
Richard M. Stallman <rms@gnu.org>
parents:
46915
diff
changeset
|
471 elements). |
e7f0249cfca8
Document history-length.
Richard M. Stallman <rms@gnu.org>
parents:
46915
diff
changeset
|
472 @end defvar |
e7f0249cfca8
Document history-length.
Richard M. Stallman <rms@gnu.org>
parents:
46915
diff
changeset
|
473 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
474 Here are some of the standard minibuffer history list variables: |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
475 |
6555 | 476 @defvar minibuffer-history |
477 The default history list for minibuffer history input. | |
478 @end defvar | |
479 | |
480 @defvar query-replace-history | |
481 A history list for arguments to @code{query-replace} (and similar | |
482 arguments to other commands). | |
483 @end defvar | |
484 | |
485 @defvar file-name-history | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
486 A history list for file-name arguments. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
487 @end defvar |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
488 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
489 @defvar buffer-name-history |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
490 A history list for buffer-name arguments. |
6555 | 491 @end defvar |
492 | |
493 @defvar regexp-history | |
494 A history list for regular expression arguments. | |
495 @end defvar | |
496 | |
497 @defvar extended-command-history | |
498 A history list for arguments that are names of extended commands. | |
499 @end defvar | |
500 | |
501 @defvar shell-command-history | |
502 A history list for arguments that are shell commands. | |
503 @end defvar | |
504 | |
505 @defvar read-expression-history | |
506 A history list for arguments that are Lisp expressions to evaluate. | |
507 @end defvar | |
508 | |
509 @node Completion | |
510 @section Completion | |
511 @cindex completion | |
512 | |
513 @dfn{Completion} is a feature that fills in the rest of a name | |
514 starting from an abbreviation for it. Completion works by comparing the | |
515 user's input against a list of valid names and determining how much of | |
516 the name is determined uniquely by what the user has typed. For | |
517 example, when you type @kbd{C-x b} (@code{switch-to-buffer}) and then | |
518 type the first few letters of the name of the buffer to which you wish | |
519 to switch, and then type @key{TAB} (@code{minibuffer-complete}), Emacs | |
520 extends the name as far as it can. | |
521 | |
522 Standard Emacs commands offer completion for names of symbols, files, | |
523 buffers, and processes; with the functions in this section, you can | |
524 implement completion for other kinds of names. | |
525 | |
526 The @code{try-completion} function is the basic primitive for | |
527 completion: it returns the longest determined completion of a given | |
528 initial string, with a given set of strings to match against. | |
529 | |
530 The function @code{completing-read} provides a higher-level interface | |
531 for completion. A call to @code{completing-read} specifies how to | |
532 determine the list of valid names. The function then activates the | |
533 minibuffer with a local keymap that binds a few keys to commands useful | |
534 for completion. Other functions provide convenient simple interfaces | |
535 for reading certain kinds of names with completion. | |
536 | |
537 @menu | |
538 * Basic Completion:: Low-level functions for completing strings. | |
539 (These are too low level to use the minibuffer.) | |
540 * Minibuffer Completion:: Invoking the minibuffer with completion. | |
541 * Completion Commands:: Minibuffer commands that do completion. | |
542 * High-Level Completion:: Convenient special cases of completion | |
543 (reading buffer name, file name, etc.) | |
544 * Reading File Names:: Using completion to read file names. | |
51914
9cd313749c97
(Basic Completion): Add lazy-completion-table.
Richard M. Stallman <rms@gnu.org>
parents:
51703
diff
changeset
|
545 * Programmed Completion:: Writing your own completion-function. |
6555 | 546 @end menu |
547 | |
548 @node Basic Completion | |
549 @subsection Basic Completion Functions | |
550 | |
51989
13ba58726a52
(Basic Completion): Describe test-completion.
Richard M. Stallman <rms@gnu.org>
parents:
51914
diff
changeset
|
551 The functions @code{try-completion}, @code{all-completions} and |
13ba58726a52
(Basic Completion): Describe test-completion.
Richard M. Stallman <rms@gnu.org>
parents:
51914
diff
changeset
|
552 @code{test-completion} have nothing in themselves to do with |
13ba58726a52
(Basic Completion): Describe test-completion.
Richard M. Stallman <rms@gnu.org>
parents:
51914
diff
changeset
|
553 minibuffers. We describe them in this chapter so as to keep them near |
13ba58726a52
(Basic Completion): Describe test-completion.
Richard M. Stallman <rms@gnu.org>
parents:
51914
diff
changeset
|
554 the higher-level completion features that do use the minibuffer. |
7221
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
555 |
6555 | 556 @defun try-completion string collection &optional predicate |
557 This function returns the longest common substring of all possible | |
558 completions of @var{string} in @var{collection}. The value of | |
53801
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
559 @var{collection} must be a list of strings, an alist, an obarray, a |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
560 hash table, or a function that implements a virtual set of strings |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
561 (see below). |
6555 | 562 |
563 Completion compares @var{string} against each of the permissible | |
564 completions specified by @var{collection}; if the beginning of the | |
565 permissible completion equals @var{string}, it matches. If no permissible | |
566 completions match, @code{try-completion} returns @code{nil}. If only | |
567 one permissible completion matches, and the match is exact, then | |
568 @code{try-completion} returns @code{t}. Otherwise, the value is the | |
569 longest initial sequence common to all the permissible completions that | |
570 match. | |
571 | |
572 If @var{collection} is an alist (@pxref{Association Lists}), the | |
53801
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
573 permissible completions are the elements of the alist that are either |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
574 strings or conses whose @sc{car} is a string. Other elements of the |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
575 alist are ignored. (Remember that in Emacs Lisp, the elements of |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
576 alists do not @emph{have} to be conses.) As all elements of the alist |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
577 can be strings, this case actually includes lists of strings, even |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
578 though we usually do not think of such lists as alists. |
6555 | 579 |
580 @cindex obarray in completion | |
581 If @var{collection} is an obarray (@pxref{Creating Symbols}), the names | |
582 of all symbols in the obarray form the set of permissible completions. The | |
583 global variable @code{obarray} holds an obarray containing the names of | |
584 all interned Lisp symbols. | |
585 | |
586 Note that the only valid way to make a new obarray is to create it | |
587 empty and then add symbols to it one by one using @code{intern}. | |
588 Also, you cannot intern a given symbol in more than one obarray. | |
589 | |
53801
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
590 If @var{collection} is a hash table, then the keys that are strings |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
591 are the possible completions. Other keys are ignored. |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
592 |
7221
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
593 You can also use a symbol that is a function as @var{collection}. Then |
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
594 the function is solely responsible for performing completion; |
6555 | 595 @code{try-completion} returns whatever this function returns. The |
596 function is called with three arguments: @var{string}, @var{predicate} | |
597 and @code{nil}. (The reason for the third argument is so that the same | |
598 function can be used in @code{all-completions} and do the appropriate | |
599 thing in either case.) @xref{Programmed Completion}. | |
600 | |
51989
13ba58726a52
(Basic Completion): Describe test-completion.
Richard M. Stallman <rms@gnu.org>
parents:
51914
diff
changeset
|
601 If the argument @var{predicate} is non-@code{nil}, then it must be a |
53801
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
602 function of one argument, unless @var{collection} is a hash table, in |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
603 which case it should be a function of two arguments. It is used to |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
604 test each possible match, and the match is accepted only if |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
605 @var{predicate} returns non-@code{nil}. The argument given to |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
606 @var{predicate} is either a string or a cons cell (the @sc{car} of |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
607 which is a string) from the alist, or a symbol (@emph{not} a symbol |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
608 name) from the obarray. If @var{collection} is a hash table, |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
609 @var{predicate} is called with two arguments, the string key and the |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
610 associated value. |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
611 |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
612 In addition, to be acceptable, a completion must also match all the |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
613 regular expressions in @code{completion-regexp-list}. (Unless |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
614 @var{collection} is a function, in which case that function has to |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
615 handle @code{completion-regexp-list} itself.) |
51989
13ba58726a52
(Basic Completion): Describe test-completion.
Richard M. Stallman <rms@gnu.org>
parents:
51914
diff
changeset
|
616 |
6555 | 617 In the first of the following examples, the string @samp{foo} is |
618 matched by three of the alist @sc{car}s. All of the matches begin with | |
619 the characters @samp{fooba}, so that is the result. In the second | |
620 example, there is only one possible match, and it is exact, so the value | |
621 is @code{t}. | |
622 | |
623 @smallexample | |
624 @group | |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48730
diff
changeset
|
625 (try-completion |
6555 | 626 "foo" |
627 '(("foobar1" 1) ("barfoo" 2) ("foobaz" 3) ("foobar2" 4))) | |
628 @result{} "fooba" | |
629 @end group | |
630 | |
631 @group | |
632 (try-completion "foo" '(("barfoo" 2) ("foo" 3))) | |
633 @result{} t | |
634 @end group | |
635 @end smallexample | |
636 | |
637 In the following example, numerous symbols begin with the characters | |
638 @samp{forw}, and all of them begin with the word @samp{forward}. In | |
639 most of the symbols, this is followed with a @samp{-}, but not in all, | |
640 so no more than @samp{forward} can be completed. | |
641 | |
642 @smallexample | |
643 @group | |
644 (try-completion "forw" obarray) | |
645 @result{} "forward" | |
646 @end group | |
647 @end smallexample | |
648 | |
649 Finally, in the following example, only two of the three possible | |
650 matches pass the predicate @code{test} (the string @samp{foobaz} is | |
651 too short). Both of those begin with the string @samp{foobar}. | |
652 | |
653 @smallexample | |
654 @group | |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48730
diff
changeset
|
655 (defun test (s) |
6555 | 656 (> (length (car s)) 6)) |
657 @result{} test | |
658 @end group | |
659 @group | |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48730
diff
changeset
|
660 (try-completion |
6555 | 661 "foo" |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48730
diff
changeset
|
662 '(("foobar1" 1) ("barfoo" 2) ("foobaz" 3) ("foobar2" 4)) |
7221
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
663 'test) |
6555 | 664 @result{} "foobar" |
665 @end group | |
666 @end smallexample | |
667 @end defun | |
668 | |
12067 | 669 @defun all-completions string collection &optional predicate nospace |
6555 | 670 This function returns a list of all possible completions of |
53801
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
671 @var{string}. The arguments to this function (aside from |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
672 @var{nospace}) are the same as those of @code{try-completion}. Also, |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
673 this function uses @code{completion-regexp-list} in the same way that |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
674 @code{try-completion} does. The optional argument @var{nospace} only |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
675 matters if @var{string} is the empty string. In that case, if |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
676 @var{nospace} is non-@code{nil}, completions that start with a space |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
677 are ignored. |
6555 | 678 |
679 If @var{collection} is a function, it is called with three arguments: | |
680 @var{string}, @var{predicate} and @code{t}; then @code{all-completions} | |
681 returns whatever the function returns. @xref{Programmed Completion}. | |
682 | |
683 Here is an example, using the function @code{test} shown in the | |
684 example for @code{try-completion}: | |
685 | |
686 @smallexample | |
687 @group | |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48730
diff
changeset
|
688 (defun test (s) |
6555 | 689 (> (length (car s)) 6)) |
690 @result{} test | |
691 @end group | |
692 | |
693 @group | |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48730
diff
changeset
|
694 (all-completions |
6555 | 695 "foo" |
696 '(("foobar1" 1) ("barfoo" 2) ("foobaz" 3) ("foobar2" 4)) | |
7221
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
697 'test) |
6555 | 698 @result{} ("foobar1" "foobar2") |
699 @end group | |
700 @end smallexample | |
701 @end defun | |
702 | |
53801
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
703 @anchor{Definition of test-completion} |
51989
13ba58726a52
(Basic Completion): Describe test-completion.
Richard M. Stallman <rms@gnu.org>
parents:
51914
diff
changeset
|
704 @defun test-completion string collection &optional predicate |
13ba58726a52
(Basic Completion): Describe test-completion.
Richard M. Stallman <rms@gnu.org>
parents:
51914
diff
changeset
|
705 This function returns non-@code{nil} if @var{string} is a valid |
13ba58726a52
(Basic Completion): Describe test-completion.
Richard M. Stallman <rms@gnu.org>
parents:
51914
diff
changeset
|
706 completion possibility specified by @var{collection} and |
53801
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
707 @var{predicate}. The arguments are the same as in |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
708 @code{try-completion}. For instance, if @var{collection} is a list of |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
709 strings, this is true if @var{string} appears in the list and |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
710 @var{predicate} is satisfied. |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
711 |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
712 @code{test-completion} uses @code{completion-regexp-list} in the same |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
713 way that @code{try-completion} does. |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
714 |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
715 If @var{predicate} is non-@code{nil} and if @var{collection} contains |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
716 several strings that are equal to each other, as determined by |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
717 @code{compare-strings} according to @code{completion-ignore-case}, |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
718 then @var{predicate} should accept either all or none of them. |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
719 Otherwise, the return value of @code{test-completion} is essentially |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
720 unpredictable. |
51989
13ba58726a52
(Basic Completion): Describe test-completion.
Richard M. Stallman <rms@gnu.org>
parents:
51914
diff
changeset
|
721 |
13ba58726a52
(Basic Completion): Describe test-completion.
Richard M. Stallman <rms@gnu.org>
parents:
51914
diff
changeset
|
722 If @var{collection} is a function, it is called with three arguments, |
13ba58726a52
(Basic Completion): Describe test-completion.
Richard M. Stallman <rms@gnu.org>
parents:
51914
diff
changeset
|
723 the values @var{string}, @var{predicate} and @code{lambda}; whatever |
13ba58726a52
(Basic Completion): Describe test-completion.
Richard M. Stallman <rms@gnu.org>
parents:
51914
diff
changeset
|
724 it returns, @code{test-completion} returns in turn. |
13ba58726a52
(Basic Completion): Describe test-completion.
Richard M. Stallman <rms@gnu.org>
parents:
51914
diff
changeset
|
725 @end defun |
13ba58726a52
(Basic Completion): Describe test-completion.
Richard M. Stallman <rms@gnu.org>
parents:
51914
diff
changeset
|
726 |
6555 | 727 @defvar completion-ignore-case |
51989
13ba58726a52
(Basic Completion): Describe test-completion.
Richard M. Stallman <rms@gnu.org>
parents:
51914
diff
changeset
|
728 If the value of this variable is non-@code{nil}, Emacs does not |
13ba58726a52
(Basic Completion): Describe test-completion.
Richard M. Stallman <rms@gnu.org>
parents:
51914
diff
changeset
|
729 consider case significant in completion. |
6555 | 730 @end defvar |
731 | |
53801
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
732 @defvar completion-regexp-list |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
733 This is a list of regular expressions. The completion functions only |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
734 consider a completion acceptable if it matches all regular expressions |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
735 in this list, with @code{case-fold-search} (@pxref{Searching and Case}) |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
736 bound to the value of @code{completion-ignore-case}. |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
737 @end defvar |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
738 |
51914
9cd313749c97
(Basic Completion): Add lazy-completion-table.
Richard M. Stallman <rms@gnu.org>
parents:
51703
diff
changeset
|
739 @defmac lazy-completion-table var fun &rest args |
9cd313749c97
(Basic Completion): Add lazy-completion-table.
Richard M. Stallman <rms@gnu.org>
parents:
51703
diff
changeset
|
740 This macro provides a way to initialize the variable @var{var} as a |
51989
13ba58726a52
(Basic Completion): Describe test-completion.
Richard M. Stallman <rms@gnu.org>
parents:
51914
diff
changeset
|
741 collection for completion in a lazy way, not computing its actual |
13ba58726a52
(Basic Completion): Describe test-completion.
Richard M. Stallman <rms@gnu.org>
parents:
51914
diff
changeset
|
742 contents until they are first needed. You use this macro to produce a |
13ba58726a52
(Basic Completion): Describe test-completion.
Richard M. Stallman <rms@gnu.org>
parents:
51914
diff
changeset
|
743 value that you store in @var{var}. The actual computation of the |
13ba58726a52
(Basic Completion): Describe test-completion.
Richard M. Stallman <rms@gnu.org>
parents:
51914
diff
changeset
|
744 proper value is done the first time you do completion using @var{var}. |
13ba58726a52
(Basic Completion): Describe test-completion.
Richard M. Stallman <rms@gnu.org>
parents:
51914
diff
changeset
|
745 It is done by calling @var{fun} with the arguments @var{args}. The |
13ba58726a52
(Basic Completion): Describe test-completion.
Richard M. Stallman <rms@gnu.org>
parents:
51914
diff
changeset
|
746 value @var{fun} returns becomes the permanent value of @var{var}. |
13ba58726a52
(Basic Completion): Describe test-completion.
Richard M. Stallman <rms@gnu.org>
parents:
51914
diff
changeset
|
747 |
13ba58726a52
(Basic Completion): Describe test-completion.
Richard M. Stallman <rms@gnu.org>
parents:
51914
diff
changeset
|
748 Here are two examples of use: |
51914
9cd313749c97
(Basic Completion): Add lazy-completion-table.
Richard M. Stallman <rms@gnu.org>
parents:
51703
diff
changeset
|
749 |
9cd313749c97
(Basic Completion): Add lazy-completion-table.
Richard M. Stallman <rms@gnu.org>
parents:
51703
diff
changeset
|
750 @example |
9cd313749c97
(Basic Completion): Add lazy-completion-table.
Richard M. Stallman <rms@gnu.org>
parents:
51703
diff
changeset
|
751 (defvar foo (lazy-completion-table foo make-my-alist 'global)) |
51989
13ba58726a52
(Basic Completion): Describe test-completion.
Richard M. Stallman <rms@gnu.org>
parents:
51914
diff
changeset
|
752 |
51914
9cd313749c97
(Basic Completion): Add lazy-completion-table.
Richard M. Stallman <rms@gnu.org>
parents:
51703
diff
changeset
|
753 (make-local-variable 'bar) |
9cd313749c97
(Basic Completion): Add lazy-completion-table.
Richard M. Stallman <rms@gnu.org>
parents:
51703
diff
changeset
|
754 (setq bar (lazy-completion-table foo make-my-alist 'local) |
9cd313749c97
(Basic Completion): Add lazy-completion-table.
Richard M. Stallman <rms@gnu.org>
parents:
51703
diff
changeset
|
755 @end example |
9cd313749c97
(Basic Completion): Add lazy-completion-table.
Richard M. Stallman <rms@gnu.org>
parents:
51703
diff
changeset
|
756 @end defmac |
9cd313749c97
(Basic Completion): Add lazy-completion-table.
Richard M. Stallman <rms@gnu.org>
parents:
51703
diff
changeset
|
757 |
6555 | 758 @node Minibuffer Completion |
759 @subsection Completion and the Minibuffer | |
760 | |
761 This section describes the basic interface for reading from the | |
762 minibuffer with completion. | |
763 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
764 @defun completing-read prompt collection &optional predicate require-match initial hist default inherit-input-method |
6555 | 765 This function reads a string in the minibuffer, assisting the user by |
766 providing completion. It activates the minibuffer with prompt | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
767 @var{prompt}, which must be a string. |
6555 | 768 |
769 The actual completion is done by passing @var{collection} and | |
53801
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
770 @var{predicate} to the function @code{try-completion}. This happens |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
771 in certain commands bound in the local keymaps used for completion. |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
772 Some of these commands also call @code{test-completion}. Thus, if |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
773 @var{predicate} is non-@code{nil}, it should be compatible with |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
774 @var{collection} and @code{completion-ignore-case}. @xref{Definition |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
775 of test-completion}. |
6555 | 776 |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
777 If @var{require-match} is @code{nil}, the exit commands work regardless |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
778 of the input in the minibuffer. If @var{require-match} is @code{t}, the |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
779 usual minibuffer exit commands won't exit unless the input completes to |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
780 an element of @var{collection}. If @var{require-match} is neither |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
781 @code{nil} nor @code{t}, then the exit commands won't exit unless the |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
782 input already in the buffer matches an element of @var{collection}. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
783 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
784 However, empty input is always permitted, regardless of the value of |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
785 @var{require-match}; in that case, @code{completing-read} returns |
53801
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
786 @var{default}, or @code{""}, if @var{default} is @code{nil}. The |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
787 value of @var{default} (if non-@code{nil}) is also available to the |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
788 user through the history commands. |
6555 | 789 |
53801
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
790 The function @code{completing-read} uses |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
791 @code{minibuffer-local-completion-map} as the keymap if |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
792 @var{require-match} is @code{nil}, and uses |
6555 | 793 @code{minibuffer-local-must-match-map} if @var{require-match} is |
7221
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
794 non-@code{nil}. @xref{Completion Commands}. |
6555 | 795 |
796 The argument @var{hist} specifies which history list variable to use for | |
797 saving the input and for minibuffer history commands. It defaults to | |
798 @code{minibuffer-history}. @xref{Minibuffer History}. | |
799 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
800 If @var{initial} is non-@code{nil}, @code{completing-read} inserts it |
53801
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
801 into the minibuffer as part of the input, with point at the end. Then |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
802 it allows the user to edit the input, providing several commands to |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
803 attempt completion. @var{initial} can also be a cons cell of the form |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
804 @code{(@var{string} . @var{position})}. In that case, point is put at |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
805 @emph{zero-indexed} position @var{position} in @var{string}. Note |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
806 that this is different from @code{read-from-minibuffer} and related |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
807 functions, which use a one-indexed position. In most cases, we |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
808 recommend using @var{default}, and not @var{initial}. |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
809 |
38158
a137fb27df08
Deprecate use of the INITIAL argument for completing-read.
Richard M. Stallman <rms@gnu.org>
parents:
27189
diff
changeset
|
810 @strong{We discourage use of a non-@code{nil} value for |
a137fb27df08
Deprecate use of the INITIAL argument for completing-read.
Richard M. Stallman <rms@gnu.org>
parents:
27189
diff
changeset
|
811 @var{initial}}, because it is an intrusive interface. The history |
38159
4c01e54e2ffd
More of previous change.
Richard M. Stallman <rms@gnu.org>
parents:
38158
diff
changeset
|
812 list feature (which did not exist when we introduced @var{initial}) |
4c01e54e2ffd
More of previous change.
Richard M. Stallman <rms@gnu.org>
parents:
38158
diff
changeset
|
813 offers a far more convenient and general way for the user to get the |
53801
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
814 default and edit it, and it is always available. For an exception to |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
815 this rule, see @ref{Minibuffer History}. |
38158
a137fb27df08
Deprecate use of the INITIAL argument for completing-read.
Richard M. Stallman <rms@gnu.org>
parents:
27189
diff
changeset
|
816 |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
817 If the argument @var{inherit-input-method} is non-@code{nil}, then the |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
818 minibuffer inherits the current input method (@pxref{Input |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
819 Methods}) and the setting of @code{enable-multibyte-characters} |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
820 (@pxref{Text Representations}) from whichever buffer was current before |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
821 entering the minibuffer. |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
822 |
6555 | 823 Completion ignores case when comparing the input against the possible |
824 matches, if the built-in variable @code{completion-ignore-case} is | |
825 non-@code{nil}. @xref{Basic Completion}. | |
826 | |
827 Here's an example of using @code{completing-read}: | |
828 | |
829 @smallexample | |
830 @group | |
831 (completing-read | |
832 "Complete a foo: " | |
833 '(("foobar1" 1) ("barfoo" 2) ("foobaz" 3) ("foobar2" 4)) | |
834 nil t "fo") | |
835 @end group | |
836 | |
837 @group | |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48730
diff
changeset
|
838 ;; @r{After evaluation of the preceding expression,} |
6555 | 839 ;; @r{the following appears in the minibuffer:} |
840 | |
841 ---------- Buffer: Minibuffer ---------- | |
842 Complete a foo: fo@point{} | |
843 ---------- Buffer: Minibuffer ---------- | |
844 @end group | |
845 @end smallexample | |
846 | |
847 @noindent | |
848 If the user then types @kbd{@key{DEL} @key{DEL} b @key{RET}}, | |
849 @code{completing-read} returns @code{barfoo}. | |
850 | |
851 The @code{completing-read} function binds three variables to pass | |
7221
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
852 information to the commands that actually do completion. These |
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
853 variables are @code{minibuffer-completion-table}, |
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
854 @code{minibuffer-completion-predicate} and |
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
855 @code{minibuffer-completion-confirm}. For more information about them, |
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
856 see @ref{Completion Commands}. |
6555 | 857 @end defun |
858 | |
859 @node Completion Commands | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23147
diff
changeset
|
860 @subsection Minibuffer Commands that Do Completion |
6555 | 861 |
53801
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
862 This section describes the keymaps, commands and user options used |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
863 in the minibuffer to do completion. The description refers to the |
53930
5ef587160656
*** empty log message ***
Luc Teirlinck <teirllm@auburn.edu>
parents:
53801
diff
changeset
|
864 situation when Partial Completion mode is disabled (as it is by |
53801
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
865 default). When enabled, this minor mode uses its own alternatives to |
54327
1f35da88bdd8
(Completion Commands): Add xref to Emacs manual for Partial Completion mode.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53930
diff
changeset
|
866 some of the commands described below. @xref{Completion Options,,, |
1f35da88bdd8
(Completion Commands): Add xref to Emacs manual for Partial Completion mode.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53930
diff
changeset
|
867 emacs, The GNU Emacs Manual}, for a short description of Partial |
1f35da88bdd8
(Completion Commands): Add xref to Emacs manual for Partial Completion mode.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53930
diff
changeset
|
868 Completion mode. |
6555 | 869 |
870 @defvar minibuffer-local-completion-map | |
7221
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
871 @code{completing-read} uses this value as the local keymap when an |
6555 | 872 exact match of one of the completions is not required. By default, this |
873 keymap makes the following bindings: | |
874 | |
875 @table @asis | |
876 @item @kbd{?} | |
877 @code{minibuffer-completion-help} | |
878 | |
879 @item @key{SPC} | |
880 @code{minibuffer-complete-word} | |
881 | |
882 @item @key{TAB} | |
883 @code{minibuffer-complete} | |
884 @end table | |
885 | |
886 @noindent | |
7221
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
887 with other characters bound as in @code{minibuffer-local-map} |
53801
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
888 (@pxref{Definition of minibuffer-local-map}). |
6555 | 889 @end defvar |
890 | |
891 @defvar minibuffer-local-must-match-map | |
892 @code{completing-read} uses this value as the local keymap when an | |
893 exact match of one of the completions is required. Therefore, no keys | |
7221
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
894 are bound to @code{exit-minibuffer}, the command that exits the |
6555 | 895 minibuffer unconditionally. By default, this keymap makes the following |
896 bindings: | |
897 | |
898 @table @asis | |
899 @item @kbd{?} | |
900 @code{minibuffer-completion-help} | |
901 | |
902 @item @key{SPC} | |
903 @code{minibuffer-complete-word} | |
904 | |
905 @item @key{TAB} | |
906 @code{minibuffer-complete} | |
907 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
908 @item @kbd{C-j} |
6555 | 909 @code{minibuffer-complete-and-exit} |
910 | |
911 @item @key{RET} | |
912 @code{minibuffer-complete-and-exit} | |
913 @end table | |
914 | |
915 @noindent | |
916 with other characters bound as in @code{minibuffer-local-map}. | |
917 @end defvar | |
918 | |
919 @defvar minibuffer-completion-table | |
53801
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
920 The value of this variable is the collection used for completion in |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
921 the minibuffer. This is the global variable that contains what |
6555 | 922 @code{completing-read} passes to @code{try-completion}. It is used by |
923 minibuffer completion commands such as @code{minibuffer-complete-word}. | |
924 @end defvar | |
925 | |
926 @defvar minibuffer-completion-predicate | |
927 This variable's value is the predicate that @code{completing-read} | |
928 passes to @code{try-completion}. The variable is also used by the other | |
929 minibuffer completion functions. | |
930 @end defvar | |
931 | |
932 @deffn Command minibuffer-complete-word | |
933 This function completes the minibuffer contents by at most a single | |
934 word. Even if the minibuffer contents have only one completion, | |
935 @code{minibuffer-complete-word} does not add any characters beyond the | |
936 first character that is not a word constituent. @xref{Syntax Tables}. | |
937 @end deffn | |
938 | |
939 @deffn Command minibuffer-complete | |
940 This function completes the minibuffer contents as far as possible. | |
941 @end deffn | |
942 | |
943 @deffn Command minibuffer-complete-and-exit | |
944 This function completes the minibuffer contents, and exits if | |
945 confirmation is not required, i.e., if | |
13319
ce09d77f76a6
Minor fix in minibuffer-complete-and-exit.
Richard M. Stallman <rms@gnu.org>
parents:
12226
diff
changeset
|
946 @code{minibuffer-completion-confirm} is @code{nil}. If confirmation |
7221
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
947 @emph{is} required, it is given by repeating this command |
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
948 immediately---the command is programmed to work without confirmation |
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
949 when run twice in succession. |
6555 | 950 @end deffn |
951 | |
952 @defvar minibuffer-completion-confirm | |
953 When the value of this variable is non-@code{nil}, Emacs asks for | |
954 confirmation of a completion before exiting the minibuffer. The | |
955 function @code{minibuffer-complete-and-exit} checks the value of this | |
956 variable before it exits. | |
957 @end defvar | |
958 | |
959 @deffn Command minibuffer-completion-help | |
960 This function creates a list of the possible completions of the | |
961 current minibuffer contents. It works by calling @code{all-completions} | |
962 using the value of the variable @code{minibuffer-completion-table} as | |
963 the @var{collection} argument, and the value of | |
964 @code{minibuffer-completion-predicate} as the @var{predicate} argument. | |
965 The list of completions is displayed as text in a buffer named | |
966 @samp{*Completions*}. | |
967 @end deffn | |
968 | |
969 @defun display-completion-list completions | |
970 This function displays @var{completions} to the stream in | |
7337
cd57cd335fff
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7221
diff
changeset
|
971 @code{standard-output}, usually a buffer. (@xref{Read and Print}, for more |
6555 | 972 information about streams.) The argument @var{completions} is normally |
973 a list of completions just returned by @code{all-completions}, but it | |
974 does not have to be. Each element may be a symbol or a string, either | |
53801
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
975 of which is simply printed. It can also be a list of two strings, |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
976 which is printed as if the strings were concatenated. The first of |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
977 the two strings is the actual completion, the second string serves as |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
978 annotation. |
6555 | 979 |
980 This function is called by @code{minibuffer-completion-help}. The | |
981 most common way to use it is together with | |
982 @code{with-output-to-temp-buffer}, like this: | |
983 | |
984 @example | |
985 (with-output-to-temp-buffer "*Completions*" | |
986 (display-completion-list | |
987 (all-completions (buffer-string) my-alist))) | |
988 @end example | |
989 @end defun | |
990 | |
991 @defopt completion-auto-help | |
992 If this variable is non-@code{nil}, the completion commands | |
993 automatically display a list of possible completions whenever nothing | |
994 can be completed because the next character is not uniquely determined. | |
995 @end defopt | |
996 | |
997 @node High-Level Completion | |
998 @subsection High-Level Completion Functions | |
999 | |
1000 This section describes the higher-level convenient functions for | |
1001 reading certain sorts of names with completion. | |
1002 | |
12098 | 1003 In most cases, you should not call these functions in the middle of a |
1004 Lisp function. When possible, do all minibuffer input as part of | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1005 reading the arguments for a command, in the @code{interactive} |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1006 specification. @xref{Defining Commands}. |
12098 | 1007 |
6555 | 1008 @defun read-buffer prompt &optional default existing |
1009 This function reads the name of a buffer and returns it as a string. | |
1010 The argument @var{default} is the default name to use, the value to | |
1011 return if the user exits with an empty minibuffer. If non-@code{nil}, | |
1012 it should be a string or a buffer. It is mentioned in the prompt, but | |
1013 is not inserted in the minibuffer as initial input. | |
1014 | |
1015 If @var{existing} is non-@code{nil}, then the name specified must be | |
7221
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
1016 that of an existing buffer. The usual commands to exit the minibuffer |
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
1017 do not exit if the text is not valid, and @key{RET} does completion to |
53801
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
1018 attempt to find a valid name. If @var{existing} is neither @code{nil} |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
1019 nor @code{t}, confirmation is required after completion. (However, |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
1020 @var{default} is not checked for validity; it is returned, whatever it |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
1021 is, if the user exits with the minibuffer empty.) |
6555 | 1022 |
1023 In the following example, the user enters @samp{minibuffer.t}, and | |
1024 then types @key{RET}. The argument @var{existing} is @code{t}, and the | |
1025 only buffer name starting with the given input is | |
1026 @samp{minibuffer.texi}, so that name is the value. | |
1027 | |
1028 @example | |
1029 (read-buffer "Buffer name? " "foo" t) | |
1030 @group | |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48730
diff
changeset
|
1031 ;; @r{After evaluation of the preceding expression,} |
6555 | 1032 ;; @r{the following prompt appears,} |
1033 ;; @r{with an empty minibuffer:} | |
1034 @end group | |
1035 | |
1036 @group | |
1037 ---------- Buffer: Minibuffer ---------- | |
1038 Buffer name? (default foo) @point{} | |
1039 ---------- Buffer: Minibuffer ---------- | |
1040 @end group | |
1041 | |
1042 @group | |
1043 ;; @r{The user types @kbd{minibuffer.t @key{RET}}.} | |
1044 @result{} "minibuffer.texi" | |
1045 @end group | |
1046 @end example | |
1047 @end defun | |
1048 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
1049 @defvar read-buffer-function |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
1050 This variable specifies how to read buffer names. For example, if you |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
1051 set this variable to @code{iswitchb-read-buffer}, all Emacs commands |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
1052 that call @code{read-buffer} to read a buffer name will actually use the |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
1053 @code{iswitchb} package to read it. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
1054 @end defvar |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
1055 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
1056 @defun read-command prompt &optional default |
6555 | 1057 This function reads the name of a command and returns it as a Lisp |
1058 symbol. The argument @var{prompt} is used as in | |
1059 @code{read-from-minibuffer}. Recall that a command is anything for | |
1060 which @code{commandp} returns @code{t}, and a command name is a symbol | |
1061 for which @code{commandp} returns @code{t}. @xref{Interactive Call}. | |
1062 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
1063 The argument @var{default} specifies what to return if the user enters |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1064 null input. It can be a symbol or a string; if it is a string, |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1065 @code{read-command} interns it before returning it. If @var{default} is |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1066 @code{nil}, that means no default has been specified; then if the user |
53801
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
1067 enters null input, the return value is @code{(intern "")}, that is, a |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
1068 symbol whose name is an empty string. |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
1069 |
6555 | 1070 @example |
1071 (read-command "Command name? ") | |
1072 | |
1073 @group | |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48730
diff
changeset
|
1074 ;; @r{After evaluation of the preceding expression,} |
6555 | 1075 ;; @r{the following prompt appears with an empty minibuffer:} |
1076 @end group | |
1077 | |
1078 @group | |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48730
diff
changeset
|
1079 ---------- Buffer: Minibuffer ---------- |
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48730
diff
changeset
|
1080 Command name? |
6555 | 1081 ---------- Buffer: Minibuffer ---------- |
1082 @end group | |
1083 @end example | |
1084 | |
1085 @noindent | |
1086 If the user types @kbd{forward-c @key{RET}}, then this function returns | |
1087 @code{forward-char}. | |
1088 | |
16736
981e116b4ac6
Minor cleanups for overfull hboxes.
Richard M. Stallman <rms@gnu.org>
parents:
16238
diff
changeset
|
1089 The @code{read-command} function is a simplified interface to |
981e116b4ac6
Minor cleanups for overfull hboxes.
Richard M. Stallman <rms@gnu.org>
parents:
16238
diff
changeset
|
1090 @code{completing-read}. It uses the variable @code{obarray} so as to |
981e116b4ac6
Minor cleanups for overfull hboxes.
Richard M. Stallman <rms@gnu.org>
parents:
16238
diff
changeset
|
1091 complete in the set of extant Lisp symbols, and it uses the |
6555 | 1092 @code{commandp} predicate so as to accept only command names: |
1093 | |
1094 @cindex @code{commandp} example | |
1095 @example | |
1096 @group | |
1097 (read-command @var{prompt}) | |
1098 @equiv{} | |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48730
diff
changeset
|
1099 (intern (completing-read @var{prompt} obarray |
6555 | 1100 'commandp t nil)) |
1101 @end group | |
1102 @end example | |
1103 @end defun | |
1104 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
1105 @defun read-variable prompt &optional default |
6555 | 1106 This function reads the name of a user variable and returns it as a |
1107 symbol. | |
1108 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
1109 The argument @var{default} specifies what to return if the user enters |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1110 null input. It can be a symbol or a string; if it is a string, |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1111 @code{read-variable} interns it before returning it. If @var{default} |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1112 is @code{nil}, that means no default has been specified; then if the |
53801
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
1113 user enters null input, the return value is @code{(intern "")}. |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
1114 |
6555 | 1115 @example |
1116 @group | |
1117 (read-variable "Variable name? ") | |
1118 | |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48730
diff
changeset
|
1119 ;; @r{After evaluation of the preceding expression,} |
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48730
diff
changeset
|
1120 ;; @r{the following prompt appears,} |
6555 | 1121 ;; @r{with an empty minibuffer:} |
1122 @end group | |
1123 | |
1124 @group | |
1125 ---------- Buffer: Minibuffer ---------- | |
1126 Variable name? @point{} | |
1127 ---------- Buffer: Minibuffer ---------- | |
1128 @end group | |
1129 @end example | |
1130 | |
1131 @noindent | |
1132 If the user then types @kbd{fill-p @key{RET}}, @code{read-variable} | |
1133 returns @code{fill-prefix}. | |
1134 | |
1135 This function is similar to @code{read-command}, but uses the | |
1136 predicate @code{user-variable-p} instead of @code{commandp}: | |
1137 | |
1138 @cindex @code{user-variable-p} example | |
1139 @example | |
1140 @group | |
1141 (read-variable @var{prompt}) | |
1142 @equiv{} | |
1143 (intern | |
1144 (completing-read @var{prompt} obarray | |
1145 'user-variable-p t nil)) | |
1146 @end group | |
1147 @end example | |
1148 @end defun | |
1149 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1150 See also the functions @code{read-coding-system} and |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
1151 @code{read-non-nil-coding-system}, in @ref{User-Chosen Coding Systems}. |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
1152 |
6555 | 1153 @node Reading File Names |
1154 @subsection Reading File Names | |
1155 | |
1156 Here is another high-level completion function, designed for reading a | |
1157 file name. It provides special features including automatic insertion | |
1158 of the default directory. | |
1159 | |
52146
c78c690c99e8
(Reading File Names): read-file-name has new arg PREDICATE.
Richard M. Stallman <rms@gnu.org>
parents:
51989
diff
changeset
|
1160 @defun read-file-name prompt &optional directory default existing initial predicate |
6555 | 1161 This function reads a file name in the minibuffer, prompting with |
53801
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
1162 @var{prompt} and providing completion. |
6555 | 1163 |
7221
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
1164 If @var{existing} is non-@code{nil}, then the user must specify the name |
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
1165 of an existing file; @key{RET} performs completion to make the name |
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
1166 valid if possible, and then refuses to exit if it is not valid. If the |
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
1167 value of @var{existing} is neither @code{nil} nor @code{t}, then |
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
1168 @key{RET} also requires confirmation after completion. If |
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
1169 @var{existing} is @code{nil}, then the name of a nonexistent file is |
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
1170 acceptable. |
6555 | 1171 |
1172 The argument @var{directory} specifies the directory to use for | |
53801
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
1173 completion of relative file names. It should be an absolute directory |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
1174 name. If @code{insert-default-directory} is non-@code{nil}, |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
1175 @var{directory} is also inserted in the minibuffer as initial input. |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
1176 It defaults to the current buffer's value of @code{default-directory}. |
6555 | 1177 |
1178 @c Emacs 19 feature | |
52626 | 1179 If you specify @var{initial}, that is an initial file name to insert |
1180 in the buffer (after @var{directory}, if that is inserted). In this | |
7221
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
1181 case, point goes at the beginning of @var{initial}. The default for |
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
1182 @var{initial} is @code{nil}---don't insert any file name. To see what |
52626 | 1183 @var{initial} does, try the command @kbd{C-x C-v}. @strong{Please |
1184 note:} we recommend using @var{default} rather than @var{initial} in | |
1185 most cases. | |
6555 | 1186 |
53801
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
1187 If @var{default} is non-@code{nil}, then the function returns |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
1188 @var{default} if the user exits the minibuffer with the same non-empty |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
1189 contents that @code{read-file-name} inserted initially. The initial |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
1190 minibuffer contents are always non-empty if |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
1191 @code{insert-default-directory} is non-@code{nil}, as it is by |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
1192 default. @var{default} is not checked for validity, regardless of the |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
1193 value of @var{existing}. However, if @var{existing} is |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
1194 non-@code{nil}, the initial minibuffer contents should be a valid file |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
1195 (or directory) name. Otherwise @code{read-file-name} attempts |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
1196 completion if the user exits without any editing, and does not return |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
1197 @var{default}. @var{default} is also available through the history |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
1198 commands. |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
1199 |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
1200 If @var{default} is @code{nil}, @code{read-file-name} tries to find a |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
1201 substitute default to use in its place, which it treats in exactly the |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
1202 same way as if it had been specified explicitly. If @var{default} is |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
1203 @code{nil}, but @var{initial} is non-@code{nil}, then the default is |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
1204 the absolute file name obtained from @var{directory} and |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
1205 @var{initial}. If both @var{default} and @var{initial} are @code{nil} |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
1206 and the buffer is visiting a file, @code{read-file-name} uses the |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
1207 absolute file name of that file as default. If the buffer is not |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
1208 visiting a file, then there is no default. In that case, if the user |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
1209 types @key{RET} without any editing, @code{read-file-name} simply |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
1210 returns the pre-inserted contents of the minibuffer. |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
1211 |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
1212 If the user types @key{RET} in an empty minibuffer, this function |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
1213 returns an empty string, regardless of the value of @var{existing}. |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
1214 This is, for instance, how the user can make the current buffer visit |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
1215 no file using @code{M-x set-visited-file-name}. |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
1216 |
52146
c78c690c99e8
(Reading File Names): read-file-name has new arg PREDICATE.
Richard M. Stallman <rms@gnu.org>
parents:
51989
diff
changeset
|
1217 If @var{predicate} is non-@code{nil}, it specifies a function of one |
c78c690c99e8
(Reading File Names): read-file-name has new arg PREDICATE.
Richard M. Stallman <rms@gnu.org>
parents:
51989
diff
changeset
|
1218 argument that decides which file names are acceptable completion |
c78c690c99e8
(Reading File Names): read-file-name has new arg PREDICATE.
Richard M. Stallman <rms@gnu.org>
parents:
51989
diff
changeset
|
1219 possibilities. A file name is an acceptable value if @var{predicate} |
c78c690c99e8
(Reading File Names): read-file-name has new arg PREDICATE.
Richard M. Stallman <rms@gnu.org>
parents:
51989
diff
changeset
|
1220 returns non-@code{nil} for it. |
c78c690c99e8
(Reading File Names): read-file-name has new arg PREDICATE.
Richard M. Stallman <rms@gnu.org>
parents:
51989
diff
changeset
|
1221 |
53801
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
1222 @code{read-file-name} does not automatically expand file names. You |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
1223 must call @code{expand-file-name} yourself if an absolute file name is |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
1224 required. |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
1225 |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48730
diff
changeset
|
1226 Here is an example: |
6555 | 1227 |
1228 @example | |
1229 @group | |
1230 (read-file-name "The file is ") | |
1231 | |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48730
diff
changeset
|
1232 ;; @r{After evaluation of the preceding expression,} |
6555 | 1233 ;; @r{the following appears in the minibuffer:} |
1234 @end group | |
1235 | |
1236 @group | |
1237 ---------- Buffer: Minibuffer ---------- | |
1238 The file is /gp/gnu/elisp/@point{} | |
1239 ---------- Buffer: Minibuffer ---------- | |
1240 @end group | |
1241 @end example | |
1242 | |
1243 @noindent | |
1244 Typing @kbd{manual @key{TAB}} results in the following: | |
1245 | |
1246 @example | |
1247 @group | |
1248 ---------- Buffer: Minibuffer ---------- | |
1249 The file is /gp/gnu/elisp/manual.texi@point{} | |
1250 ---------- Buffer: Minibuffer ---------- | |
1251 @end group | |
1252 @end example | |
1253 | |
1254 @c Wordy to avoid overfull hbox in smallbook mode. | |
1255 @noindent | |
1256 If the user types @key{RET}, @code{read-file-name} returns the file name | |
1257 as the string @code{"/gp/gnu/elisp/manual.texi"}. | |
1258 @end defun | |
1259 | |
52146
c78c690c99e8
(Reading File Names): read-file-name has new arg PREDICATE.
Richard M. Stallman <rms@gnu.org>
parents:
51989
diff
changeset
|
1260 @defun read-directory-name prompt &optional directory default existing initial |
c78c690c99e8
(Reading File Names): read-file-name has new arg PREDICATE.
Richard M. Stallman <rms@gnu.org>
parents:
51989
diff
changeset
|
1261 This function is like @code{read-file-name} but allows only directory |
c78c690c99e8
(Reading File Names): read-file-name has new arg PREDICATE.
Richard M. Stallman <rms@gnu.org>
parents:
51989
diff
changeset
|
1262 names as completion possibilities. |
53801
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
1263 |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
1264 If @var{default} is @code{nil} and @var{initial} is non-@code{nil}, |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
1265 @code{read-directory-name} constructs a substitute default by |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
1266 combining @var{directory} (or the current buffer's default directory |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
1267 if @var{directory} is @code{nil}) and @var{initial}. If both |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
1268 @var{default} and @var{initial} are @code{nil}, this function uses the |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
1269 current buffer's default directory as substitute default, ignoring |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
1270 @var{directory}. |
52146
c78c690c99e8
(Reading File Names): read-file-name has new arg PREDICATE.
Richard M. Stallman <rms@gnu.org>
parents:
51989
diff
changeset
|
1271 @end defun |
c78c690c99e8
(Reading File Names): read-file-name has new arg PREDICATE.
Richard M. Stallman <rms@gnu.org>
parents:
51989
diff
changeset
|
1272 |
6555 | 1273 @defopt insert-default-directory |
53801
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
1274 This variable is used by @code{read-file-name}, and thus, indirectly, |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
1275 by most commands reading file names. (This includes all commands that |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
1276 use the code letters @samp{f} or @samp{F} in their interactive form. |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
1277 @xref{Interactive Codes,, Code Characters for interactive}.) Its |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
1278 value controls whether @code{read-file-name} starts by placing the |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
1279 name of the default directory in the minibuffer, plus the initial file |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
1280 name if any. If the value of this variable is @code{nil}, then |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
1281 @code{read-file-name} does not place any initial input in the |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
1282 minibuffer (unless you specify initial input with the @var{initial} |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
1283 argument). In that case, the default directory is still used for |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
1284 completion of relative file names, but is not displayed. |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
1285 |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
1286 If this variable is @code{nil} and the initial minibuffer contents are |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
1287 empty, the user may have to explicitly fetch the next history element |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
1288 to access a default value. If the variable is non-@code{nil}, the |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
1289 initial minibuffer contents are always non-empty and the user can |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
1290 always request a default value by immediately typing @key{RET} in an |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
1291 unedited minibuffer. (See above.) |
6555 | 1292 |
1293 For example: | |
1294 | |
1295 @example | |
1296 @group | |
1297 ;; @r{Here the minibuffer starts out with the default directory.} | |
1298 (let ((insert-default-directory t)) | |
1299 (read-file-name "The file is ")) | |
1300 @end group | |
1301 | |
1302 @group | |
1303 ---------- Buffer: Minibuffer ---------- | |
1304 The file is ~lewis/manual/@point{} | |
1305 ---------- Buffer: Minibuffer ---------- | |
1306 @end group | |
1307 | |
1308 @group | |
1309 ;; @r{Here the minibuffer is empty and only the prompt} | |
1310 ;; @r{appears on its line.} | |
1311 (let ((insert-default-directory nil)) | |
1312 (read-file-name "The file is ")) | |
1313 @end group | |
1314 | |
1315 @group | |
1316 ---------- Buffer: Minibuffer ---------- | |
1317 The file is @point{} | |
1318 ---------- Buffer: Minibuffer ---------- | |
1319 @end group | |
1320 @end example | |
1321 @end defopt | |
1322 | |
1323 @node Programmed Completion | |
1324 @subsection Programmed Completion | |
1325 @cindex programmed completion | |
1326 | |
1327 Sometimes it is not possible to create an alist or an obarray | |
1328 containing all the intended possible completions. In such a case, you | |
1329 can supply your own function to compute the completion of a given string. | |
1330 This is called @dfn{programmed completion}. | |
1331 | |
1332 To use this feature, pass a symbol with a function definition as the | |
7221
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
1333 @var{collection} argument to @code{completing-read}. The function |
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
1334 @code{completing-read} arranges to pass your completion function along |
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
1335 to @code{try-completion} and @code{all-completions}, which will then let |
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
1336 your function do all the work. |
6555 | 1337 |
1338 The completion function should accept three arguments: | |
1339 | |
1340 @itemize @bullet | |
1341 @item | |
1342 The string to be completed. | |
1343 | |
1344 @item | |
1345 The predicate function to filter possible matches, or @code{nil} if | |
1346 none. Your function should call the predicate for each possible match, | |
1347 and ignore the possible match if the predicate returns @code{nil}. | |
1348 | |
1349 @item | |
1350 A flag specifying the type of operation. | |
1351 @end itemize | |
1352 | |
1353 There are three flag values for three operations: | |
1354 | |
1355 @itemize @bullet | |
1356 @item | |
1357 @code{nil} specifies @code{try-completion}. The completion function | |
1358 should return the completion of the specified string, or @code{t} if the | |
16157
1713fe640e41
Clarify value returned by programmed completion function.
Richard M. Stallman <rms@gnu.org>
parents:
15768
diff
changeset
|
1359 string is a unique and exact match already, or @code{nil} if the string |
1713fe640e41
Clarify value returned by programmed completion function.
Richard M. Stallman <rms@gnu.org>
parents:
15768
diff
changeset
|
1360 matches no possibility. |
1713fe640e41
Clarify value returned by programmed completion function.
Richard M. Stallman <rms@gnu.org>
parents:
15768
diff
changeset
|
1361 |
1713fe640e41
Clarify value returned by programmed completion function.
Richard M. Stallman <rms@gnu.org>
parents:
15768
diff
changeset
|
1362 If the string is an exact match for one possibility, but also matches |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1363 other longer possibilities, the function should return the string, not |
16157
1713fe640e41
Clarify value returned by programmed completion function.
Richard M. Stallman <rms@gnu.org>
parents:
15768
diff
changeset
|
1364 @code{t}. |
6555 | 1365 |
1366 @item | |
1367 @code{t} specifies @code{all-completions}. The completion function | |
1368 should return a list of all possible completions of the specified | |
1369 string. | |
1370 | |
1371 @item | |
51989
13ba58726a52
(Basic Completion): Describe test-completion.
Richard M. Stallman <rms@gnu.org>
parents:
51914
diff
changeset
|
1372 @code{lambda} specifies @code{test-completion}. The completion |
6555 | 1373 function should return @code{t} if the specified string is an exact |
1374 match for some possibility; @code{nil} otherwise. | |
1375 @end itemize | |
1376 | |
1377 It would be consistent and clean for completion functions to allow | |
12098 | 1378 lambda expressions (lists that are functions) as well as function |
6555 | 1379 symbols as @var{collection}, but this is impossible. Lists as |
51989
13ba58726a52
(Basic Completion): Describe test-completion.
Richard M. Stallman <rms@gnu.org>
parents:
51914
diff
changeset
|
1380 completion tables already have other meanings, and it would be |
13ba58726a52
(Basic Completion): Describe test-completion.
Richard M. Stallman <rms@gnu.org>
parents:
51914
diff
changeset
|
1381 unreliable to treat one differently just because it is also a possible |
13ba58726a52
(Basic Completion): Describe test-completion.
Richard M. Stallman <rms@gnu.org>
parents:
51914
diff
changeset
|
1382 function. So you must arrange for any function you wish to use for |
13ba58726a52
(Basic Completion): Describe test-completion.
Richard M. Stallman <rms@gnu.org>
parents:
51914
diff
changeset
|
1383 completion to be encapsulated in a symbol. |
6555 | 1384 |
1385 Emacs uses programmed completion when completing file names. | |
1386 @xref{File Name Completion}. | |
1387 | |
51914
9cd313749c97
(Basic Completion): Add lazy-completion-table.
Richard M. Stallman <rms@gnu.org>
parents:
51703
diff
changeset
|
1388 @defmac dynamic-completion-table function |
9cd313749c97
(Basic Completion): Add lazy-completion-table.
Richard M. Stallman <rms@gnu.org>
parents:
51703
diff
changeset
|
1389 This macro is a convenient way to write a function that can act as |
9cd313749c97
(Basic Completion): Add lazy-completion-table.
Richard M. Stallman <rms@gnu.org>
parents:
51703
diff
changeset
|
1390 programmed completion function. The argument @var{function} should be |
9cd313749c97
(Basic Completion): Add lazy-completion-table.
Richard M. Stallman <rms@gnu.org>
parents:
51703
diff
changeset
|
1391 a function that takes one argument, a string, and returns an alist of |
9cd313749c97
(Basic Completion): Add lazy-completion-table.
Richard M. Stallman <rms@gnu.org>
parents:
51703
diff
changeset
|
1392 possible completions of it. You can think of |
9cd313749c97
(Basic Completion): Add lazy-completion-table.
Richard M. Stallman <rms@gnu.org>
parents:
51703
diff
changeset
|
1393 @code{dynamic-completion-table} as a transducer between that interface |
9cd313749c97
(Basic Completion): Add lazy-completion-table.
Richard M. Stallman <rms@gnu.org>
parents:
51703
diff
changeset
|
1394 and the interface for programmed completion functions. |
9cd313749c97
(Basic Completion): Add lazy-completion-table.
Richard M. Stallman <rms@gnu.org>
parents:
51703
diff
changeset
|
1395 @end defmac |
9cd313749c97
(Basic Completion): Add lazy-completion-table.
Richard M. Stallman <rms@gnu.org>
parents:
51703
diff
changeset
|
1396 |
6555 | 1397 @node Yes-or-No Queries |
1398 @section Yes-or-No Queries | |
1399 @cindex asking the user questions | |
1400 @cindex querying the user | |
1401 @cindex yes-or-no questions | |
1402 | |
1403 This section describes functions used to ask the user a yes-or-no | |
1404 question. The function @code{y-or-n-p} can be answered with a single | |
1405 character; it is useful for questions where an inadvertent wrong answer | |
1406 will not have serious consequences. @code{yes-or-no-p} is suitable for | |
1407 more momentous questions, since it requires three or four characters to | |
1408 answer. | |
1409 | |
7337
cd57cd335fff
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7221
diff
changeset
|
1410 If either of these functions is called in a command that was invoked |
cd57cd335fff
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7221
diff
changeset
|
1411 using the mouse---more precisely, if @code{last-nonmenu-event} |
cd57cd335fff
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7221
diff
changeset
|
1412 (@pxref{Command Loop Info}) is either @code{nil} or a list---then it |
cd57cd335fff
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7221
diff
changeset
|
1413 uses a dialog box or pop-up menu to ask the question. Otherwise, it |
cd57cd335fff
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7221
diff
changeset
|
1414 uses keyboard input. You can force use of the mouse or use of keyboard |
cd57cd335fff
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7221
diff
changeset
|
1415 input by binding @code{last-nonmenu-event} to a suitable value around |
cd57cd335fff
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7221
diff
changeset
|
1416 the call. |
cd57cd335fff
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7221
diff
changeset
|
1417 |
6555 | 1418 Strictly speaking, @code{yes-or-no-p} uses the minibuffer and |
1419 @code{y-or-n-p} does not; but it seems best to describe them together. | |
1420 | |
1421 @defun y-or-n-p prompt | |
7221
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
1422 This function asks the user a question, expecting input in the echo |
6555 | 1423 area. It returns @code{t} if the user types @kbd{y}, @code{nil} if the |
1424 user types @kbd{n}. This function also accepts @key{SPC} to mean yes | |
1425 and @key{DEL} to mean no. It accepts @kbd{C-]} to mean ``quit'', like | |
1426 @kbd{C-g}, because the question might look like a minibuffer and for | |
1427 that reason the user might try to use @kbd{C-]} to get out. The answer | |
1428 is a single character, with no @key{RET} needed to terminate it. Upper | |
1429 and lower case are equivalent. | |
1430 | |
7221
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
1431 ``Asking the question'' means printing @var{prompt} in the echo area, |
6555 | 1432 followed by the string @w{@samp{(y or n) }}. If the input is not one of |
1433 the expected answers (@kbd{y}, @kbd{n}, @kbd{@key{SPC}}, | |
1434 @kbd{@key{DEL}}, or something that quits), the function responds | |
1435 @samp{Please answer y or n.}, and repeats the request. | |
1436 | |
7221
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
1437 This function does not actually use the minibuffer, since it does not |
6555 | 1438 allow editing of the answer. It actually uses the echo area (@pxref{The |
1439 Echo Area}), which uses the same screen space as the minibuffer. The | |
1440 cursor moves to the echo area while the question is being asked. | |
1441 | |
7221
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
1442 The answers and their meanings, even @samp{y} and @samp{n}, are not |
6555 | 1443 hardwired. The keymap @code{query-replace-map} specifies them. |
1444 @xref{Search and Replace}. | |
1445 | |
7221
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
1446 In the following example, the user first types @kbd{q}, which is |
6555 | 1447 invalid. At the next prompt the user types @kbd{y}. |
1448 | |
1449 @smallexample | |
1450 @group | |
1451 (y-or-n-p "Do you need a lift? ") | |
1452 | |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48730
diff
changeset
|
1453 ;; @r{After evaluation of the preceding expression,} |
6555 | 1454 ;; @r{the following prompt appears in the echo area:} |
1455 @end group | |
1456 | |
1457 @group | |
1458 ---------- Echo area ---------- | |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48730
diff
changeset
|
1459 Do you need a lift? (y or n) |
6555 | 1460 ---------- Echo area ---------- |
1461 @end group | |
1462 | |
1463 ;; @r{If the user then types @kbd{q}, the following appears:} | |
1464 | |
1465 @group | |
1466 ---------- Echo area ---------- | |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48730
diff
changeset
|
1467 Please answer y or n. Do you need a lift? (y or n) |
6555 | 1468 ---------- Echo area ---------- |
1469 @end group | |
1470 | |
1471 ;; @r{When the user types a valid answer,} | |
1472 ;; @r{it is displayed after the question:} | |
1473 | |
1474 @group | |
1475 ---------- Echo area ---------- | |
1476 Do you need a lift? (y or n) y | |
1477 ---------- Echo area ---------- | |
1478 @end group | |
1479 @end smallexample | |
1480 | |
1481 @noindent | |
1482 We show successive lines of echo area messages, but only one actually | |
1483 appears on the screen at a time. | |
1484 @end defun | |
1485 | |
15768
b913a75fddee
Add y-or-n-p-with-timeout.
Richard M. Stallman <rms@gnu.org>
parents:
13319
diff
changeset
|
1486 @defun y-or-n-p-with-timeout prompt seconds default-value |
b913a75fddee
Add y-or-n-p-with-timeout.
Richard M. Stallman <rms@gnu.org>
parents:
13319
diff
changeset
|
1487 Like @code{y-or-n-p}, except that if the user fails to answer within |
b913a75fddee
Add y-or-n-p-with-timeout.
Richard M. Stallman <rms@gnu.org>
parents:
13319
diff
changeset
|
1488 @var{seconds} seconds, this function stops waiting and returns |
b913a75fddee
Add y-or-n-p-with-timeout.
Richard M. Stallman <rms@gnu.org>
parents:
13319
diff
changeset
|
1489 @var{default-value}. It works by setting up a timer; see @ref{Timers}. |
b913a75fddee
Add y-or-n-p-with-timeout.
Richard M. Stallman <rms@gnu.org>
parents:
13319
diff
changeset
|
1490 The argument @var{seconds} may be an integer or a floating point number. |
b913a75fddee
Add y-or-n-p-with-timeout.
Richard M. Stallman <rms@gnu.org>
parents:
13319
diff
changeset
|
1491 @end defun |
b913a75fddee
Add y-or-n-p-with-timeout.
Richard M. Stallman <rms@gnu.org>
parents:
13319
diff
changeset
|
1492 |
6555 | 1493 @defun yes-or-no-p prompt |
7221
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
1494 This function asks the user a question, expecting input in the |
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
1495 minibuffer. It returns @code{t} if the user enters @samp{yes}, |
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
1496 @code{nil} if the user types @samp{no}. The user must type @key{RET} to |
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
1497 finalize the response. Upper and lower case are equivalent. |
6555 | 1498 |
7221
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
1499 @code{yes-or-no-p} starts by displaying @var{prompt} in the echo area, |
6555 | 1500 followed by @w{@samp{(yes or no) }}. The user must type one of the |
1501 expected responses; otherwise, the function responds @samp{Please answer | |
1502 yes or no.}, waits about two seconds and repeats the request. | |
1503 | |
7221
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
1504 @code{yes-or-no-p} requires more work from the user than |
6555 | 1505 @code{y-or-n-p} and is appropriate for more crucial decisions. |
1506 | |
1507 Here is an example: | |
1508 | |
1509 @smallexample | |
1510 @group | |
1511 (yes-or-no-p "Do you really want to remove everything? ") | |
1512 | |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48730
diff
changeset
|
1513 ;; @r{After evaluation of the preceding expression,} |
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48730
diff
changeset
|
1514 ;; @r{the following prompt appears,} |
6555 | 1515 ;; @r{with an empty minibuffer:} |
1516 @end group | |
1517 | |
1518 @group | |
1519 ---------- Buffer: minibuffer ---------- | |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48730
diff
changeset
|
1520 Do you really want to remove everything? (yes or no) |
6555 | 1521 ---------- Buffer: minibuffer ---------- |
1522 @end group | |
1523 @end smallexample | |
1524 | |
1525 @noindent | |
1526 If the user first types @kbd{y @key{RET}}, which is invalid because this | |
1527 function demands the entire word @samp{yes}, it responds by displaying | |
1528 these prompts, with a brief pause between them: | |
1529 | |
1530 @smallexample | |
1531 @group | |
1532 ---------- Buffer: minibuffer ---------- | |
1533 Please answer yes or no. | |
1534 Do you really want to remove everything? (yes or no) | |
1535 ---------- Buffer: minibuffer ---------- | |
1536 @end group | |
1537 @end smallexample | |
1538 @end defun | |
1539 | |
1540 @node Multiple Queries | |
1541 @section Asking Multiple Y-or-N Questions | |
1542 | |
7221
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
1543 When you have a series of similar questions to ask, such as ``Do you |
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
1544 want to save this buffer'' for each buffer in turn, you should use |
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
1545 @code{map-y-or-n-p} to ask the collection of questions, rather than |
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
1546 asking each question individually. This gives the user certain |
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
1547 convenient facilities such as the ability to answer the whole series at |
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
1548 once. |
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
1549 |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
1550 @defun map-y-or-n-p prompter actor list &optional help action-alist no-cursor-in-echo-area |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
1551 This function asks the user a series of questions, reading a |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
1552 single-character answer in the echo area for each one. |
6555 | 1553 |
1554 The value of @var{list} specifies the objects to ask questions about. | |
1555 It should be either a list of objects or a generator function. If it is | |
1556 a function, it should expect no arguments, and should return either the | |
1557 next object to ask about, or @code{nil} meaning stop asking questions. | |
1558 | |
1559 The argument @var{prompter} specifies how to ask each question. If | |
1560 @var{prompter} is a string, the question text is computed like this: | |
1561 | |
1562 @example | |
1563 (format @var{prompter} @var{object}) | |
1564 @end example | |
1565 | |
1566 @noindent | |
1567 where @var{object} is the next object to ask about (as obtained from | |
1568 @var{list}). | |
1569 | |
1570 If not a string, @var{prompter} should be a function of one argument | |
12226 | 1571 (the next object to ask about) and should return the question text. If |
1572 the value is a string, that is the question to ask the user. The | |
1573 function can also return @code{t} meaning do act on this object (and | |
1574 don't ask the user), or @code{nil} meaning ignore this object (and don't | |
1575 ask the user). | |
6555 | 1576 |
1577 The argument @var{actor} says how to act on the answers that the user | |
1578 gives. It should be a function of one argument, and it is called with | |
1579 each object that the user says yes for. Its argument is always an | |
1580 object obtained from @var{list}. | |
1581 | |
1582 If the argument @var{help} is given, it should be a list of this form: | |
1583 | |
1584 @example | |
1585 (@var{singular} @var{plural} @var{action}) | |
1586 @end example | |
1587 | |
1588 @noindent | |
1589 where @var{singular} is a string containing a singular noun that | |
1590 describes the objects conceptually being acted on, @var{plural} is the | |
1591 corresponding plural noun, and @var{action} is a transitive verb | |
1592 describing what @var{actor} does. | |
1593 | |
1594 If you don't specify @var{help}, the default is @code{("object" | |
1595 "objects" "act on")}. | |
1596 | |
1597 Each time a question is asked, the user may enter @kbd{y}, @kbd{Y}, or | |
1598 @key{SPC} to act on that object; @kbd{n}, @kbd{N}, or @key{DEL} to skip | |
1599 that object; @kbd{!} to act on all following objects; @key{ESC} or | |
1600 @kbd{q} to exit (skip all following objects); @kbd{.} (period) to act on | |
1601 the current object and then exit; or @kbd{C-h} to get help. These are | |
1602 the same answers that @code{query-replace} accepts. The keymap | |
1603 @code{query-replace-map} defines their meaning for @code{map-y-or-n-p} | |
1604 as well as for @code{query-replace}; see @ref{Search and Replace}. | |
1605 | |
1606 You can use @var{action-alist} to specify additional possible answers | |
1607 and what they mean. It is an alist of elements of the form | |
1608 @code{(@var{char} @var{function} @var{help})}, each of which defines one | |
1609 additional answer. In this element, @var{char} is a character (the | |
1610 answer); @var{function} is a function of one argument (an object from | |
1611 @var{list}); @var{help} is a string. | |
1612 | |
1613 When the user responds with @var{char}, @code{map-y-or-n-p} calls | |
1614 @var{function}. If it returns non-@code{nil}, the object is considered | |
1615 ``acted upon'', and @code{map-y-or-n-p} advances to the next object in | |
1616 @var{list}. If it returns @code{nil}, the prompt is repeated for the | |
1617 same object. | |
1618 | |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
1619 Normally, @code{map-y-or-n-p} binds @code{cursor-in-echo-area} while |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
1620 prompting. But if @var{no-cursor-in-echo-area} is non-@code{nil}, it |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
1621 does not do that. |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
1622 |
7337
cd57cd335fff
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7221
diff
changeset
|
1623 If @code{map-y-or-n-p} is called in a command that was invoked using the |
cd57cd335fff
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7221
diff
changeset
|
1624 mouse---more precisely, if @code{last-nonmenu-event} (@pxref{Command |
cd57cd335fff
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7221
diff
changeset
|
1625 Loop Info}) is either @code{nil} or a list---then it uses a dialog box |
cd57cd335fff
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7221
diff
changeset
|
1626 or pop-up menu to ask the question. In this case, it does not use |
cd57cd335fff
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7221
diff
changeset
|
1627 keyboard input or the echo area. You can force use of the mouse or use |
cd57cd335fff
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7221
diff
changeset
|
1628 of keyboard input by binding @code{last-nonmenu-event} to a suitable |
cd57cd335fff
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7221
diff
changeset
|
1629 value around the call. |
cd57cd335fff
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7221
diff
changeset
|
1630 |
6555 | 1631 The return value of @code{map-y-or-n-p} is the number of objects acted on. |
1632 @end defun | |
1633 | |
23147 | 1634 @node Reading a Password |
1635 @section Reading a Password | |
1636 @cindex passwords, reading | |
1637 | |
1638 To read a password to pass to another program, you can use the | |
1639 function @code{read-passwd}. | |
1640 | |
1641 @defun read-passwd prompt &optional confirm default | |
1642 This function reads a password, prompting with @var{prompt}. It does | |
1643 not echo the password as the user types it; instead, it echoes @samp{.} | |
1644 for each character in the password. | |
1645 | |
1646 The optional argument @var{confirm}, if non-@code{nil}, says to read the | |
1647 password twice and insist it must be the same both times. If it isn't | |
1648 the same, the user has to type it over and over until the last two | |
1649 times match. | |
1650 | |
1651 The optional argument @var{default} specifies the default password to | |
1652 return if the user enters empty input. If @var{default} is @code{nil}, | |
1653 then @code{read-passwd} returns the null string in that case. | |
1654 @end defun | |
1655 | |
6555 | 1656 @node Minibuffer Misc |
1657 @section Minibuffer Miscellany | |
1658 | |
1659 This section describes some basic functions and variables related to | |
1660 minibuffers. | |
1661 | |
1662 @deffn Command exit-minibuffer | |
1663 This command exits the active minibuffer. It is normally bound to | |
1664 keys in minibuffer local keymaps. | |
1665 @end deffn | |
1666 | |
1667 @deffn Command self-insert-and-exit | |
1668 This command exits the active minibuffer after inserting the last | |
1669 character typed on the keyboard (found in @code{last-command-char}; | |
1670 @pxref{Command Loop Info}). | |
1671 @end deffn | |
1672 | |
1673 @deffn Command previous-history-element n | |
1674 This command replaces the minibuffer contents with the value of the | |
1675 @var{n}th previous (older) history element. | |
1676 @end deffn | |
1677 | |
1678 @deffn Command next-history-element n | |
1679 This command replaces the minibuffer contents with the value of the | |
1680 @var{n}th more recent history element. | |
1681 @end deffn | |
1682 | |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
1683 @deffn Command previous-matching-history-element pattern n |
6555 | 1684 This command replaces the minibuffer contents with the value of the |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
1685 @var{n}th previous (older) history element that matches @var{pattern} (a |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
1686 regular expression). |
6555 | 1687 @end deffn |
1688 | |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
1689 @deffn Command next-matching-history-element pattern n |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
1690 This command replaces the minibuffer contents with the value of the |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
1691 @var{n}th next (newer) history element that matches @var{pattern} (a |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
1692 regular expression). |
6555 | 1693 @end deffn |
1694 | |
12098 | 1695 @defun minibuffer-prompt |
1696 This function returns the prompt string of the currently active | |
1697 minibuffer. If no minibuffer is active, it returns @code{nil}. | |
1698 @end defun | |
1699 | |
39531
35c1673ff6ab
(Minibuffer Misc): Add entries for `minibuffer-contents',
Miles Bader <miles@gnu.org>
parents:
38159
diff
changeset
|
1700 @defun minibuffer-prompt-end |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
1701 @tindex minibuffer-prompt-end |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23147
diff
changeset
|
1702 This function, available starting in Emacs 21, returns the current |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23147
diff
changeset
|
1703 position of the end of the minibuffer prompt, if a minibuffer is |
39531
35c1673ff6ab
(Minibuffer Misc): Add entries for `minibuffer-contents',
Miles Bader <miles@gnu.org>
parents:
38159
diff
changeset
|
1704 current. Otherwise, it returns the minimum valid buffer position. |
35c1673ff6ab
(Minibuffer Misc): Add entries for `minibuffer-contents',
Miles Bader <miles@gnu.org>
parents:
38159
diff
changeset
|
1705 @end defun |
35c1673ff6ab
(Minibuffer Misc): Add entries for `minibuffer-contents',
Miles Bader <miles@gnu.org>
parents:
38159
diff
changeset
|
1706 |
35c1673ff6ab
(Minibuffer Misc): Add entries for `minibuffer-contents',
Miles Bader <miles@gnu.org>
parents:
38159
diff
changeset
|
1707 @defun minibuffer-contents |
35c1673ff6ab
(Minibuffer Misc): Add entries for `minibuffer-contents',
Miles Bader <miles@gnu.org>
parents:
38159
diff
changeset
|
1708 @tindex minibuffer-contents |
35c1673ff6ab
(Minibuffer Misc): Add entries for `minibuffer-contents',
Miles Bader <miles@gnu.org>
parents:
38159
diff
changeset
|
1709 This function, available starting in Emacs 21, returns the editable |
35c1673ff6ab
(Minibuffer Misc): Add entries for `minibuffer-contents',
Miles Bader <miles@gnu.org>
parents:
38159
diff
changeset
|
1710 contents of the minibuffer (that is, everything except the prompt) as |
35c1673ff6ab
(Minibuffer Misc): Add entries for `minibuffer-contents',
Miles Bader <miles@gnu.org>
parents:
38159
diff
changeset
|
1711 a string, if a minibuffer is current. Otherwise, it returns the |
35c1673ff6ab
(Minibuffer Misc): Add entries for `minibuffer-contents',
Miles Bader <miles@gnu.org>
parents:
38159
diff
changeset
|
1712 entire contents of the current buffer. |
35c1673ff6ab
(Minibuffer Misc): Add entries for `minibuffer-contents',
Miles Bader <miles@gnu.org>
parents:
38159
diff
changeset
|
1713 @end defun |
35c1673ff6ab
(Minibuffer Misc): Add entries for `minibuffer-contents',
Miles Bader <miles@gnu.org>
parents:
38159
diff
changeset
|
1714 |
35c1673ff6ab
(Minibuffer Misc): Add entries for `minibuffer-contents',
Miles Bader <miles@gnu.org>
parents:
38159
diff
changeset
|
1715 @defun minibuffer-contents-no-properties |
35c1673ff6ab
(Minibuffer Misc): Add entries for `minibuffer-contents',
Miles Bader <miles@gnu.org>
parents:
38159
diff
changeset
|
1716 @tindex minibuffer-contents-no-properties |
35c1673ff6ab
(Minibuffer Misc): Add entries for `minibuffer-contents',
Miles Bader <miles@gnu.org>
parents:
38159
diff
changeset
|
1717 This is like @code{minibuffer-contents}, except that it does not copy text |
35c1673ff6ab
(Minibuffer Misc): Add entries for `minibuffer-contents',
Miles Bader <miles@gnu.org>
parents:
38159
diff
changeset
|
1718 properties, just the characters themselves. @xref{Text Properties}. |
35c1673ff6ab
(Minibuffer Misc): Add entries for `minibuffer-contents',
Miles Bader <miles@gnu.org>
parents:
38159
diff
changeset
|
1719 @end defun |
35c1673ff6ab
(Minibuffer Misc): Add entries for `minibuffer-contents',
Miles Bader <miles@gnu.org>
parents:
38159
diff
changeset
|
1720 |
35c1673ff6ab
(Minibuffer Misc): Add entries for `minibuffer-contents',
Miles Bader <miles@gnu.org>
parents:
38159
diff
changeset
|
1721 @defun delete-minibuffer-contents |
35c1673ff6ab
(Minibuffer Misc): Add entries for `minibuffer-contents',
Miles Bader <miles@gnu.org>
parents:
38159
diff
changeset
|
1722 @tindex delete-minibuffer-contents |
35c1673ff6ab
(Minibuffer Misc): Add entries for `minibuffer-contents',
Miles Bader <miles@gnu.org>
parents:
38159
diff
changeset
|
1723 This function, available starting in Emacs 21, erases the editable |
35c1673ff6ab
(Minibuffer Misc): Add entries for `minibuffer-contents',
Miles Bader <miles@gnu.org>
parents:
38159
diff
changeset
|
1724 contents of the minibuffer (that is, everything except the prompt), if |
35c1673ff6ab
(Minibuffer Misc): Add entries for `minibuffer-contents',
Miles Bader <miles@gnu.org>
parents:
38159
diff
changeset
|
1725 a minibuffer is current. Otherwise, it erases the entire buffer. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23147
diff
changeset
|
1726 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23147
diff
changeset
|
1727 |
44275 | 1728 @defun minibuffer-prompt-width |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23147
diff
changeset
|
1729 This function returns the current display-width of the minibuffer |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23147
diff
changeset
|
1730 prompt, if a minibuffer is current. Otherwise, it returns zero. |
12098 | 1731 @end defun |
1732 | |
6555 | 1733 @defvar minibuffer-setup-hook |
1734 This is a normal hook that is run whenever the minibuffer is entered. | |
7221
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
1735 @xref{Hooks}. |
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
1736 @end defvar |
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
1737 |
8529
464f7abd0b26
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7337
diff
changeset
|
1738 @defvar minibuffer-exit-hook |
7221
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
1739 This is a normal hook that is run whenever the minibuffer is exited. |
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
1740 @xref{Hooks}. |
6555 | 1741 @end defvar |
1742 | |
1743 @defvar minibuffer-help-form | |
1744 The current value of this variable is used to rebind @code{help-form} | |
1745 locally inside the minibuffer (@pxref{Help Functions}). | |
1746 @end defvar | |
1747 | |
53801
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
1748 @defun minibufferp &optional buffer-or-name |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
1749 This function returns non-@code{nil} if @var{buffer-or-name} is a |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
1750 minibuffer. If @var{buffer-or-name} is omitted, it tests the current |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
1751 buffer. |
51989
13ba58726a52
(Basic Completion): Describe test-completion.
Richard M. Stallman <rms@gnu.org>
parents:
51914
diff
changeset
|
1752 @end defun |
13ba58726a52
(Basic Completion): Describe test-completion.
Richard M. Stallman <rms@gnu.org>
parents:
51914
diff
changeset
|
1753 |
12067 | 1754 @defun active-minibuffer-window |
1755 This function returns the currently active minibuffer window, or | |
1756 @code{nil} if none is currently active. | |
1757 @end defun | |
1758 | |
6555 | 1759 @defun minibuffer-window &optional frame |
12067 | 1760 This function returns the minibuffer window used for frame @var{frame}. |
1761 If @var{frame} is @code{nil}, that stands for the current frame. Note | |
1762 that the minibuffer window used by a frame need not be part of that | |
1763 frame---a frame that has no minibuffer of its own necessarily uses some | |
1764 other frame's minibuffer window. | |
6555 | 1765 @end defun |
1766 | |
53429
246f74971d9a
(Minibuffer Misc): Add set-minibuffer-window.
Richard M. Stallman <rms@gnu.org>
parents:
52626
diff
changeset
|
1767 @defun set-minibuffer-window window |
246f74971d9a
(Minibuffer Misc): Add set-minibuffer-window.
Richard M. Stallman <rms@gnu.org>
parents:
52626
diff
changeset
|
1768 This function specifies @var{window} as the minibuffer window to use. |
246f74971d9a
(Minibuffer Misc): Add set-minibuffer-window.
Richard M. Stallman <rms@gnu.org>
parents:
52626
diff
changeset
|
1769 This affects where the minibuffer is displayed if you put text in it |
246f74971d9a
(Minibuffer Misc): Add set-minibuffer-window.
Richard M. Stallman <rms@gnu.org>
parents:
52626
diff
changeset
|
1770 without invoking the usual minibuffer commands. It has no effect on |
246f74971d9a
(Minibuffer Misc): Add set-minibuffer-window.
Richard M. Stallman <rms@gnu.org>
parents:
52626
diff
changeset
|
1771 the usual minibuffer input functions because they all start by |
246f74971d9a
(Minibuffer Misc): Add set-minibuffer-window.
Richard M. Stallman <rms@gnu.org>
parents:
52626
diff
changeset
|
1772 choosing the minibuffer window according to the current frame. |
246f74971d9a
(Minibuffer Misc): Add set-minibuffer-window.
Richard M. Stallman <rms@gnu.org>
parents:
52626
diff
changeset
|
1773 @end defun |
246f74971d9a
(Minibuffer Misc): Add set-minibuffer-window.
Richard M. Stallman <rms@gnu.org>
parents:
52626
diff
changeset
|
1774 |
6555 | 1775 @c Emacs 19 feature |
53801
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
1776 @defun window-minibuffer-p &optional window |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
1777 This function returns non-@code{nil} if @var{window} is a minibuffer |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
1778 window. |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
1779 @var{window} defaults to the selected window. |
6555 | 1780 @end defun |
1781 | |
1782 It is not correct to determine whether a given window is a minibuffer by | |
1783 comparing it with the result of @code{(minibuffer-window)}, because | |
1784 there can be more than one minibuffer window if there is more than one | |
1785 frame. | |
1786 | |
1787 @defun minibuffer-window-active-p window | |
1788 This function returns non-@code{nil} if @var{window}, assumed to be | |
1789 a minibuffer window, is currently active. | |
1790 @end defun | |
1791 | |
1792 @defvar minibuffer-scroll-window | |
1793 If the value of this variable is non-@code{nil}, it should be a window | |
1794 object. When the function @code{scroll-other-window} is called in the | |
1795 minibuffer, it scrolls this window. | |
1796 @end defvar | |
1797 | |
52485
7fc901c75a7d
(Intro to Minibuffers): Explain that the minibuffer
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1798 @defun minibuffer-selected-window |
7fc901c75a7d
(Intro to Minibuffers): Explain that the minibuffer
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1799 This function returns the window which was selected when the |
7fc901c75a7d
(Intro to Minibuffers): Explain that the minibuffer
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1800 minibuffer was entered. If selected window is not a minibuffer |
7fc901c75a7d
(Intro to Minibuffers): Explain that the minibuffer
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1801 window, it returns @code{nil}. |
7fc901c75a7d
(Intro to Minibuffers): Explain that the minibuffer
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1802 @end defun |
7fc901c75a7d
(Intro to Minibuffers): Explain that the minibuffer
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1803 |
6555 | 1804 Finally, some functions and variables deal with recursive minibuffers |
1805 (@pxref{Recursive Editing}): | |
1806 | |
1807 @defun minibuffer-depth | |
1808 This function returns the current depth of activations of the | |
1809 minibuffer, a nonnegative integer. If no minibuffers are active, it | |
1810 returns zero. | |
1811 @end defun | |
1812 | |
1813 @defopt enable-recursive-minibuffers | |
1814 If this variable is non-@code{nil}, you can invoke commands (such as | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1815 @code{find-file}) that use minibuffers even while the minibuffer window |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1816 is active. Such invocation produces a recursive editing level for a new |
6555 | 1817 minibuffer. The outer-level minibuffer is invisible while you are |
1818 editing the inner one. | |
1819 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1820 If this variable is @code{nil}, you cannot invoke minibuffer |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1821 commands when the minibuffer window is active, not even if you switch to |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1822 another window to do it. |
6555 | 1823 @end defopt |
1824 | |
1825 @c Emacs 19 feature | |
1826 If a command name has a property @code{enable-recursive-minibuffers} | |
7221
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
1827 that is non-@code{nil}, then the command can use the minibuffer to read |
53801
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
1828 arguments even if it is invoked from the minibuffer. A command can |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
1829 also achieve this by binding @code{enable-recursive-minibuffers} |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
1830 to @code{t} in the interactive declaration (@pxref{Using Interactive}). |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
1831 The minibuffer command @code{next-matching-history-element} (normally |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
1832 @kbd{M-s} in the minibuffer) does the latter. |
50603
86ea12469954
(Minibuffer Misc): Document fn minibuffer-message.
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
1833 |
53801
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
1834 @defun minibuffer-message string |
50603
86ea12469954
(Minibuffer Misc): Document fn minibuffer-message.
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
1835 This function displays @var{string} temporarily at the end of the |
53801
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
1836 minibuffer text, for two seconds, or until the next input event |
7fda9e6236d5
(Text from Minibuffer): Various corrections and clarifications.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53429
diff
changeset
|
1837 arrives, whichever comes first. |
50603
86ea12469954
(Minibuffer Misc): Document fn minibuffer-message.
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
1838 @end defun |
52401 | 1839 |
1840 @ignore | |
1841 arch-tag: bba7f945-9078-477f-a2ce-18818a6e1218 | |
1842 @end ignore |