Mercurial > emacs
annotate lispref/minibuf.texi @ 11322:518a5db7f4f0
(ALL_CFLAGS): Add -I${srcdir}/../src.
author | Richard M. Stallman <rms@gnu.org> |
---|---|
date | Sun, 09 Apr 1995 04:58:29 +0000 |
parents | 6093207b85e8 |
children | 73dc8205d259 |
rev | line source |
---|---|
6555 | 1 @c -*-texinfo-*- |
2 @c This is part of the GNU Emacs Lisp Reference Manual. | |
3 @c Copyright (C) 1990, 1991, 1992, 1993, 1994 Free Software Foundation, Inc. | |
4 @c See the file elisp.texi for copying conditions. | |
5 @setfilename ../info/minibuf | |
7337
cd57cd335fff
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7221
diff
changeset
|
6 @node Minibuffers, Command Loop, Read and Print, Top |
6555 | 7 @chapter Minibuffers |
8 @cindex arguments, reading | |
9 @cindex complex arguments | |
10 @cindex minibuffer | |
11 | |
12 A @dfn{minibuffer} is a special buffer that Emacs commands use to read | |
13 arguments more complicated than the single numeric prefix argument. | |
14 These arguments include file names, buffer names, and command names (as | |
15 in @kbd{M-x}). The minibuffer is displayed on the bottom line of the | |
16 screen, in the same place as the echo area, but only while it is in | |
17 use for reading an argument. | |
18 | |
19 @menu | |
20 * Intro to Minibuffers:: Basic information about minibuffers. | |
21 * Text from Minibuffer:: How to read a straight text string. | |
22 * Object from Minibuffer:: How to read a Lisp object or expression. | |
23 * Minibuffer History:: Recording previous minibuffer inputs | |
24 so the user can reuse them. | |
25 * Completion:: How to invoke and customize completion. | |
26 * Yes-or-No Queries:: Asking a question with a simple answer. | |
27 * Multiple Queries:: Asking a series of similar questions. | |
28 * Minibuffer Misc:: Various customization hooks and variables. | |
29 @end menu | |
30 | |
31 @node Intro to Minibuffers | |
32 @section Introduction to Minibuffers | |
33 | |
34 In most ways, a minibuffer is a normal Emacs buffer. Most operations | |
35 @emph{within} a buffer, such as editing commands, work normally in a | |
36 minibuffer. However, many operations for managing buffers do not apply | |
37 to minibuffers. The name of a minibuffer always has the form @w{@samp{ | |
38 *Minibuf-@var{number}}}, and it cannot be changed. Minibuffers are | |
39 displayed only in special windows used only for minibuffers; these | |
40 windows always appear at the bottom of a frame. (Sometime frames have | |
41 no minibuffer window, and sometimes a special kind of frame contains | |
42 nothing but a minibuffer window; see @ref{Minibuffers and Frames}.) | |
43 | |
7221
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
44 The minibuffer's window is normally a single line. You can resize it |
6555 | 45 temporarily with the window sizing commands; it reverts to its normal |
46 size when the minibuffer is exited. You can resize it permanently by | |
47 using the window sizing commands in the frame's other window, when the | |
48 minibuffer is not active. If the frame contains just a minibuffer, you | |
49 can change the minibuffer's size by changing the frame's size. | |
50 | |
51 If a command uses a minibuffer while there is an active minibuffer, | |
52 this is called a @dfn{recursive minibuffer}. The first minibuffer is | |
53 named @w{@samp{ *Minibuf-0*}}. Recursive minibuffers are named by | |
54 incrementing the number at the end of the name. (The names begin with a | |
55 space so that they won't show up in normal buffer lists.) Of several | |
56 recursive minibuffers, the innermost (or most recently entered) is the | |
57 active minibuffer. We usually call this ``the'' minibuffer. You can | |
58 permit or forbid recursive minibuffers by setting the variable | |
59 @code{enable-recursive-minibuffers} or by putting properties of that | |
60 name on command symbols (@pxref{Minibuffer Misc}). | |
61 | |
62 Like other buffers, a minibuffer may use any of several local keymaps | |
63 (@pxref{Keymaps}); these contain various exit commands and in some cases | |
64 completion commands. @xref{Completion}. | |
65 | |
66 @itemize @bullet | |
67 @item | |
68 @code{minibuffer-local-map} is for ordinary input (no completion). | |
69 | |
70 @item | |
71 @code{minibuffer-local-ns-map} is similar, except that @key{SPC} exits | |
72 just like @key{RET}. This is used mainly for Mocklisp compatibility. | |
73 | |
74 @item | |
75 @code{minibuffer-local-completion-map} is for permissive completion. | |
76 | |
77 @item | |
78 @code{minibuffer-local-must-match-map} is for strict completion and | |
79 for cautious completion. | |
80 @end itemize | |
81 | |
82 @node Text from Minibuffer | |
83 @section Reading Text Strings with the Minibuffer | |
84 | |
7221
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
85 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
|
86 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
|
87 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
|
88 either one. |
6555 | 89 |
90 @defun read-from-minibuffer prompt-string &optional initial-contents keymap read hist | |
91 This function is the most general way to get input through the | |
92 minibuffer. By default, it accepts arbitrary text and returns it as a | |
93 string; however, if @var{read} is non-@code{nil}, then it uses | |
94 @code{read} to convert the text into a Lisp object (@pxref{Input | |
95 Functions}). | |
96 | |
97 The first thing this function does is to activate a minibuffer and | |
98 display it with @var{prompt-string} as the prompt. This value must be a | |
99 string. | |
100 | |
101 Then, if @var{initial-contents} is a string, @code{read-from-minibuffer} | |
102 inserts it into the minibuffer, leaving point at the end. The | |
103 minibuffer appears with this text as its contents. | |
104 | |
105 @c Emacs 19 feature | |
106 The value of @var{initial-contents} may also be a cons cell of the form | |
107 @code{(@var{string} . @var{position})}. This means to insert | |
108 @var{string} in the minibuffer but put point @var{position} characters | |
109 from the beginning, rather than at the end. | |
110 | |
111 If @var{keymap} is non-@code{nil}, that keymap is the local keymap to | |
112 use in the minibuffer. If @var{keymap} is omitted or @code{nil}, the | |
113 value of @code{minibuffer-local-map} is used as the keymap. Specifying | |
114 a keymap is the most important way to customize the minibuffer for | |
115 various applications such as completion. | |
116 | |
117 The argument @var{hist} specifies which history list variable to use | |
118 for saving the input and for history commands used in the minibuffer. | |
119 It defaults to @code{minibuffer-history}. @xref{Minibuffer History}. | |
120 | |
121 When the user types a command to exit the minibuffer, | |
122 @code{read-from-minibuffer} uses the text in the minibuffer to produce | |
123 its return value. Normally it simply makes a string containing that | |
124 text. However, if @var{read} is non-@code{nil}, | |
125 @code{read-from-minibuffer} reads the text and returns the resulting | |
126 Lisp object, unevaluated. (@xref{Input Functions}, for information | |
127 about reading.) | |
128 @end defun | |
129 | |
130 @defun read-string prompt &optional initial | |
131 This function reads a string from the minibuffer and returns it. The | |
132 arguments @var{prompt} and @var{initial} are used as in | |
133 @code{read-from-minibuffer}. The keymap used is | |
134 @code{minibuffer-local-map}. | |
135 | |
136 This is a simplified interface to the | |
137 @code{read-from-minibuffer} function: | |
138 | |
139 @smallexample | |
140 @group | |
141 (read-string @var{prompt} @var{initial}) | |
142 @equiv{} | |
7221
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
143 (read-from-minibuffer @var{prompt} @var{initial} nil nil nil) |
6555 | 144 @end group |
145 @end smallexample | |
146 @end defun | |
147 | |
148 @defvar minibuffer-local-map | |
149 This is the default local keymap for reading from the minibuffer. By | |
150 default, it makes the following bindings: | |
151 | |
152 @table @asis | |
153 @item @key{LFD} | |
154 @code{exit-minibuffer} | |
155 | |
156 @item @key{RET} | |
157 @code{exit-minibuffer} | |
158 | |
159 @item @kbd{C-g} | |
160 @code{abort-recursive-edit} | |
161 | |
162 @item @kbd{M-n} | |
163 @code{next-history-element} | |
164 | |
165 @item @kbd{M-p} | |
166 @code{previous-history-element} | |
167 | |
168 @item @kbd{M-r} | |
169 @code{next-matching-history-element} | |
170 | |
171 @item @kbd{M-s} | |
172 @code{previous-matching-history-element} | |
173 @end table | |
174 @end defvar | |
175 | |
176 @c In version 18, initial is required | |
177 @c Emacs 19 feature | |
178 @defun read-no-blanks-input prompt &optional initial | |
179 This function reads a string from the minibuffer, but does not allow | |
180 whitespace characters as part of the input: instead, those characters | |
181 terminate the input. The arguments @var{prompt} and @var{initial} are | |
182 used as in @code{read-from-minibuffer}. | |
183 | |
184 This is a simplified interface to the @code{read-from-minibuffer} | |
185 function, and passes the value of the @code{minibuffer-local-ns-map} | |
186 keymap as the @var{keymap} argument for that function. Since the keymap | |
187 @code{minibuffer-local-ns-map} does not rebind @kbd{C-q}, it @emph{is} | |
188 possible to put a space into the string, by quoting it. | |
189 | |
190 @smallexample | |
191 @group | |
192 (read-no-blanks-input @var{prompt} @var{initial}) | |
193 @equiv{} | |
194 (read-from-minibuffer @var{prompt} @var{initial} minibuffer-local-ns-map) | |
195 @end group | |
196 @end smallexample | |
197 @end defun | |
198 | |
199 @defvar minibuffer-local-ns-map | |
200 This built-in variable is the keymap used as the minibuffer local keymap | |
201 in the function @code{read-no-blanks-input}. By default, it makes the | |
202 following bindings: | |
203 | |
204 @table @asis | |
205 @item @key{LFD} | |
206 @code{exit-minibuffer} | |
207 | |
208 @item @key{SPC} | |
209 @cindex @key{SPC} in minibuffer | |
210 @code{exit-minibuffer} | |
211 | |
212 @item @key{TAB} | |
213 @cindex @key{TAB} in minibuffer | |
214 @code{exit-minibuffer} | |
215 | |
216 @item @key{RET} | |
217 @code{exit-minibuffer} | |
218 | |
219 @item @kbd{C-g} | |
220 @code{abort-recursive-edit} | |
221 | |
222 @item @kbd{?} | |
223 @cindex @kbd{?} in minibuffer | |
224 @code{self-insert-and-exit} | |
225 | |
7221
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
226 @item @kbd{M-n} |
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
227 @code{next-history-element} |
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
228 |
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
229 @item @kbd{M-p} |
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
230 @code{previous-history-element} |
6555 | 231 |
232 @item @kbd{M-r} | |
233 @code{next-matching-history-element} | |
234 | |
235 @item @kbd{M-s} | |
236 @code{previous-matching-history-element} | |
237 @end table | |
238 @end defvar | |
239 | |
240 @node Object from Minibuffer | |
241 @section Reading Lisp Objects with the Minibuffer | |
242 | |
243 This section describes functions for reading Lisp objects with the | |
244 minibuffer. | |
245 | |
246 @defun read-minibuffer prompt &optional initial | |
7221
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
247 This function reads a Lisp object in the minibuffer and returns it, |
6555 | 248 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
|
249 used as in @code{read-from-minibuffer}. |
6555 | 250 |
7221
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
251 This is a simplified interface to the |
6555 | 252 @code{read-from-minibuffer} function: |
253 | |
254 @smallexample | |
255 @group | |
256 (read-minibuffer @var{prompt} @var{initial}) | |
257 @equiv{} | |
258 (read-from-minibuffer @var{prompt} @var{initial} nil t) | |
259 @end group | |
260 @end smallexample | |
261 | |
262 Here is an example in which we supply the string @code{"(testing)"} as | |
263 initial input: | |
264 | |
265 @smallexample | |
266 @group | |
267 (read-minibuffer | |
268 "Enter an expression: " (format "%s" '(testing))) | |
269 | |
270 ;; @r{Here is how the minibuffer is displayed:} | |
271 @end group | |
272 | |
273 @group | |
274 ---------- Buffer: Minibuffer ---------- | |
275 Enter an expression: (testing)@point{} | |
276 ---------- Buffer: Minibuffer ---------- | |
277 @end group | |
278 @end smallexample | |
279 | |
280 @noindent | |
281 The user can type @key{RET} immediately to use the initial input as a | |
282 default, or can edit the input. | |
283 @end defun | |
284 | |
285 @defun eval-minibuffer prompt &optional initial | |
7221
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
286 This function reads a Lisp expression in the minibuffer, evaluates it, |
6555 | 287 then returns the result. The arguments @var{prompt} and @var{initial} |
288 are used as in @code{read-from-minibuffer}. | |
289 | |
7221
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
290 This function simply evaluates the result of a call to |
6555 | 291 @code{read-minibuffer}: |
292 | |
293 @smallexample | |
294 @group | |
295 (eval-minibuffer @var{prompt} @var{initial}) | |
296 @equiv{} | |
297 (eval (read-minibuffer @var{prompt} @var{initial})) | |
298 @end group | |
299 @end smallexample | |
300 @end defun | |
301 | |
302 @defun edit-and-eval-command prompt form | |
7221
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
303 This function reads a Lisp expression in the minibuffer, and then |
6555 | 304 evaluates it. The difference between this command and |
305 @code{eval-minibuffer} is that here the initial @var{form} is not | |
306 optional and it is treated as a Lisp object to be converted to printed | |
307 representation rather than as a string of text. It is printed with | |
308 @code{prin1}, so if it is a string, double-quote characters (@samp{"}) | |
309 appear in the initial text. @xref{Output Functions}. | |
310 | |
7221
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
311 The first thing @code{edit-and-eval-command} does is to activate the |
6555 | 312 minibuffer with @var{prompt} as the prompt. Then it inserts the printed |
313 representation of @var{form} in the minibuffer, and lets the user edit. | |
314 When the user exits the minibuffer, the edited text is read with | |
315 @code{read} and then evaluated. The resulting value becomes the value | |
316 of @code{edit-and-eval-command}. | |
317 | |
7221
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
318 In the following example, we offer the user an expression with initial |
6555 | 319 text which is a valid form already: |
320 | |
321 @smallexample | |
322 @group | |
323 (edit-and-eval-command "Please edit: " '(forward-word 1)) | |
324 | |
7221
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
325 ;; @r{After evaluation of the preceding expression,} |
6555 | 326 ;; @r{the following appears in the minibuffer:} |
327 @end group | |
328 | |
329 @group | |
330 ---------- Buffer: Minibuffer ---------- | |
331 Please edit: (forward-word 1)@point{} | |
332 ---------- Buffer: Minibuffer ---------- | |
333 @end group | |
334 @end smallexample | |
335 | |
336 @noindent | |
337 Typing @key{RET} right away would exit the minibuffer and evaluate the | |
338 expression, thus moving point forward one word. | |
339 @code{edit-and-eval-command} returns @code{nil} in this example. | |
340 @end defun | |
341 | |
342 @node Minibuffer History | |
343 @section Minibuffer History | |
344 @cindex minibuffer history | |
345 @cindex history list | |
346 | |
347 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
|
348 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
|
349 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
|
350 (previous inputs), most recent first. |
6555 | 351 |
352 There are many separate history lists, used for different kinds of | |
353 inputs. It's the Lisp programmer's job to specify the right history | |
354 list for each use of the minibuffer. | |
355 | |
356 The basic minibuffer input functions @code{read-from-minibuffer} and | |
357 @code{completing-read} both accept an optional argument named @var{hist} | |
358 which is how you specify the history list. Here are the possible | |
359 values: | |
360 | |
361 @table @asis | |
362 @item @var{variable} | |
363 Use @var{variable} (a symbol) as the history list. | |
364 | |
365 @item (@var{variable} . @var{startpos}) | |
366 Use @var{variable} (a symbol) as the history list, and assume that the | |
367 initial history position is @var{startpos} (an integer, counting from | |
368 zero which specifies the most recent element of the history). | |
369 | |
370 If you specify @var{startpos}, then you should also specify that element | |
371 of the history as the initial minibuffer contents, for consistency. | |
372 @end table | |
373 | |
374 If you don't specify @var{hist}, then the default history list | |
375 @code{minibuffer-history} is used. For other standard history lists, | |
376 see below. You can also create your own history list variable; just | |
377 initialize it to @code{nil} before the first use. | |
378 | |
379 Both @code{read-from-minibuffer} and @code{completing-read} add new | |
380 elements to the history list automatically, and provide commands to | |
381 allow the user to reuse items on the list. The only thing your program | |
382 needs to do to use a history list is to initialize it and to pass its | |
383 name to the input functions when you wish. But it is safe to modify the | |
384 list by hand when the minibuffer input functions are not using it. | |
385 | |
386 @defvar minibuffer-history | |
387 The default history list for minibuffer history input. | |
388 @end defvar | |
389 | |
390 @defvar query-replace-history | |
391 A history list for arguments to @code{query-replace} (and similar | |
392 arguments to other commands). | |
393 @end defvar | |
394 | |
395 @defvar file-name-history | |
396 A history list for file name arguments. | |
397 @end defvar | |
398 | |
399 @defvar regexp-history | |
400 A history list for regular expression arguments. | |
401 @end defvar | |
402 | |
403 @defvar extended-command-history | |
404 A history list for arguments that are names of extended commands. | |
405 @end defvar | |
406 | |
407 @defvar shell-command-history | |
408 A history list for arguments that are shell commands. | |
409 @end defvar | |
410 | |
411 @defvar read-expression-history | |
412 A history list for arguments that are Lisp expressions to evaluate. | |
413 @end defvar | |
414 | |
415 @node Completion | |
416 @section Completion | |
417 @cindex completion | |
418 | |
419 @dfn{Completion} is a feature that fills in the rest of a name | |
420 starting from an abbreviation for it. Completion works by comparing the | |
421 user's input against a list of valid names and determining how much of | |
422 the name is determined uniquely by what the user has typed. For | |
423 example, when you type @kbd{C-x b} (@code{switch-to-buffer}) and then | |
424 type the first few letters of the name of the buffer to which you wish | |
425 to switch, and then type @key{TAB} (@code{minibuffer-complete}), Emacs | |
426 extends the name as far as it can. | |
427 | |
428 Standard Emacs commands offer completion for names of symbols, files, | |
429 buffers, and processes; with the functions in this section, you can | |
430 implement completion for other kinds of names. | |
431 | |
432 The @code{try-completion} function is the basic primitive for | |
433 completion: it returns the longest determined completion of a given | |
434 initial string, with a given set of strings to match against. | |
435 | |
436 The function @code{completing-read} provides a higher-level interface | |
437 for completion. A call to @code{completing-read} specifies how to | |
438 determine the list of valid names. The function then activates the | |
439 minibuffer with a local keymap that binds a few keys to commands useful | |
440 for completion. Other functions provide convenient simple interfaces | |
441 for reading certain kinds of names with completion. | |
442 | |
443 @menu | |
444 * Basic Completion:: Low-level functions for completing strings. | |
445 (These are too low level to use the minibuffer.) | |
446 * Minibuffer Completion:: Invoking the minibuffer with completion. | |
447 * Completion Commands:: Minibuffer commands that do completion. | |
448 * High-Level Completion:: Convenient special cases of completion | |
449 (reading buffer name, file name, etc.) | |
450 * Reading File Names:: Using completion to read file names. | |
451 * Programmed Completion:: Finding the completions for a given file name. | |
452 @end menu | |
453 | |
454 @node Basic Completion | |
455 @subsection Basic Completion Functions | |
456 | |
7221
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
457 The two functions @code{try-completion} and @code{all-completions} |
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
458 have nothing in themselves to do with minibuffers. We describe them in |
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
459 this chapter so as to keep them near the higher-level completion |
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
460 features that do use the minibuffer. |
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
461 |
6555 | 462 @defun try-completion string collection &optional predicate |
463 This function returns the longest common substring of all possible | |
464 completions of @var{string} in @var{collection}. The value of | |
7221
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
465 @var{collection} must be an alist, an obarray, or a function that |
6555 | 466 implements a virtual set of strings (see below). |
467 | |
468 Completion compares @var{string} against each of the permissible | |
469 completions specified by @var{collection}; if the beginning of the | |
470 permissible completion equals @var{string}, it matches. If no permissible | |
471 completions match, @code{try-completion} returns @code{nil}. If only | |
472 one permissible completion matches, and the match is exact, then | |
473 @code{try-completion} returns @code{t}. Otherwise, the value is the | |
474 longest initial sequence common to all the permissible completions that | |
475 match. | |
476 | |
477 If @var{collection} is an alist (@pxref{Association Lists}), the | |
478 @sc{car}s of the alist elements form the set of permissible completions. | |
479 | |
480 @cindex obarray in completion | |
481 If @var{collection} is an obarray (@pxref{Creating Symbols}), the names | |
482 of all symbols in the obarray form the set of permissible completions. The | |
483 global variable @code{obarray} holds an obarray containing the names of | |
484 all interned Lisp symbols. | |
485 | |
486 Note that the only valid way to make a new obarray is to create it | |
487 empty and then add symbols to it one by one using @code{intern}. | |
488 Also, you cannot intern a given symbol in more than one obarray. | |
489 | |
490 If the argument @var{predicate} is non-@code{nil}, then it must be a | |
491 function of one argument. It is used to test each possible match, and | |
492 the match is accepted only if @var{predicate} returns non-@code{nil}. | |
493 The argument given to @var{predicate} is either a cons cell from the alist | |
494 (the @sc{car} of which is a string) or else it is a symbol (@emph{not} a | |
495 symbol name) from the obarray. | |
496 | |
7221
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
497 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
|
498 the function is solely responsible for performing completion; |
6555 | 499 @code{try-completion} returns whatever this function returns. The |
500 function is called with three arguments: @var{string}, @var{predicate} | |
501 and @code{nil}. (The reason for the third argument is so that the same | |
502 function can be used in @code{all-completions} and do the appropriate | |
503 thing in either case.) @xref{Programmed Completion}. | |
504 | |
505 In the first of the following examples, the string @samp{foo} is | |
506 matched by three of the alist @sc{car}s. All of the matches begin with | |
507 the characters @samp{fooba}, so that is the result. In the second | |
508 example, there is only one possible match, and it is exact, so the value | |
509 is @code{t}. | |
510 | |
511 @smallexample | |
512 @group | |
513 (try-completion | |
514 "foo" | |
515 '(("foobar1" 1) ("barfoo" 2) ("foobaz" 3) ("foobar2" 4))) | |
516 @result{} "fooba" | |
517 @end group | |
518 | |
519 @group | |
520 (try-completion "foo" '(("barfoo" 2) ("foo" 3))) | |
521 @result{} t | |
522 @end group | |
523 @end smallexample | |
524 | |
525 In the following example, numerous symbols begin with the characters | |
526 @samp{forw}, and all of them begin with the word @samp{forward}. In | |
527 most of the symbols, this is followed with a @samp{-}, but not in all, | |
528 so no more than @samp{forward} can be completed. | |
529 | |
530 @smallexample | |
531 @group | |
532 (try-completion "forw" obarray) | |
533 @result{} "forward" | |
534 @end group | |
535 @end smallexample | |
536 | |
537 Finally, in the following example, only two of the three possible | |
538 matches pass the predicate @code{test} (the string @samp{foobaz} is | |
539 too short). Both of those begin with the string @samp{foobar}. | |
540 | |
541 @smallexample | |
542 @group | |
543 (defun test (s) | |
544 (> (length (car s)) 6)) | |
545 @result{} test | |
546 @end group | |
547 @group | |
548 (try-completion | |
549 "foo" | |
550 '(("foobar1" 1) ("barfoo" 2) ("foobaz" 3) ("foobar2" 4)) | |
7221
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
551 'test) |
6555 | 552 @result{} "foobar" |
553 @end group | |
554 @end smallexample | |
555 @end defun | |
556 | |
557 @defun all-completions string collection &optional predicate | |
558 This function returns a list of all possible completions of | |
559 @var{string}. The parameters to this function are the same as to | |
560 @code{try-completion}. | |
561 | |
562 If @var{collection} is a function, it is called with three arguments: | |
563 @var{string}, @var{predicate} and @code{t}; then @code{all-completions} | |
564 returns whatever the function returns. @xref{Programmed Completion}. | |
565 | |
566 Here is an example, using the function @code{test} shown in the | |
567 example for @code{try-completion}: | |
568 | |
569 @smallexample | |
570 @group | |
571 (defun test (s) | |
572 (> (length (car s)) 6)) | |
573 @result{} test | |
574 @end group | |
575 | |
576 @group | |
577 (all-completions | |
578 "foo" | |
579 '(("foobar1" 1) ("barfoo" 2) ("foobaz" 3) ("foobar2" 4)) | |
7221
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
580 'test) |
6555 | 581 @result{} ("foobar1" "foobar2") |
582 @end group | |
583 @end smallexample | |
584 @end defun | |
585 | |
586 @defvar completion-ignore-case | |
587 If the value of this variable is | |
588 non-@code{nil}, Emacs does not consider case significant in completion. | |
589 @end defvar | |
590 | |
591 @node Minibuffer Completion | |
592 @subsection Completion and the Minibuffer | |
593 | |
594 This section describes the basic interface for reading from the | |
595 minibuffer with completion. | |
596 | |
597 @defun completing-read prompt collection &optional predicate require-match initial hist | |
598 This function reads a string in the minibuffer, assisting the user by | |
599 providing completion. It activates the minibuffer with prompt | |
600 @var{prompt}, which must be a string. If @var{initial} is | |
601 non-@code{nil}, @code{completing-read} inserts it into the minibuffer as | |
602 part of the input. Then it allows the user to edit the input, providing | |
603 several commands to attempt completion. | |
604 | |
605 The actual completion is done by passing @var{collection} and | |
606 @var{predicate} to the function @code{try-completion}. This happens in | |
607 certain commands bound in the local keymaps used for completion. | |
608 | |
609 If @var{require-match} is @code{t}, the usual minibuffer exit commands | |
610 won't exit unless the input completes to an element of @var{collection}. | |
611 If @var{require-match} is neither @code{nil} nor @code{t}, then the exit | |
612 commands won't exit unless the input typed is itself an element of | |
7221
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
613 @var{collection}. If @var{require-match} is @code{nil}, the exit |
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
614 commands work regardless of the input in the minibuffer. |
6555 | 615 |
8753 | 616 The user can exit with null input by typing @key{RET} with an empty |
617 minibuffer. Then @code{completing-read} returns @code{nil}. This is | |
618 how the user requests whatever default the command uses for the value | |
619 being read. The user can return using @key{RET} in this way regardless | |
620 of the value of @var{require-match}. | |
621 | |
6555 | 622 The function @code{completing-read} works by calling |
623 @code{read-minibuffer}. It uses @code{minibuffer-local-completion-map} | |
624 as the keymap if @var{require-match} is @code{nil}, and uses | |
625 @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
|
626 non-@code{nil}. @xref{Completion Commands}. |
6555 | 627 |
628 The argument @var{hist} specifies which history list variable to use for | |
629 saving the input and for minibuffer history commands. It defaults to | |
630 @code{minibuffer-history}. @xref{Minibuffer History}. | |
631 | |
632 Completion ignores case when comparing the input against the possible | |
633 matches, if the built-in variable @code{completion-ignore-case} is | |
634 non-@code{nil}. @xref{Basic Completion}. | |
635 | |
636 Here's an example of using @code{completing-read}: | |
637 | |
638 @smallexample | |
639 @group | |
640 (completing-read | |
641 "Complete a foo: " | |
642 '(("foobar1" 1) ("barfoo" 2) ("foobaz" 3) ("foobar2" 4)) | |
643 nil t "fo") | |
644 @end group | |
645 | |
646 @group | |
7221
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
647 ;; @r{After evaluation of the preceding expression,} |
6555 | 648 ;; @r{the following appears in the minibuffer:} |
649 | |
650 ---------- Buffer: Minibuffer ---------- | |
651 Complete a foo: fo@point{} | |
652 ---------- Buffer: Minibuffer ---------- | |
653 @end group | |
654 @end smallexample | |
655 | |
656 @noindent | |
657 If the user then types @kbd{@key{DEL} @key{DEL} b @key{RET}}, | |
658 @code{completing-read} returns @code{barfoo}. | |
659 | |
660 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
|
661 information to the commands that actually do completion. These |
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
662 variables are @code{minibuffer-completion-table}, |
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
663 @code{minibuffer-completion-predicate} and |
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
664 @code{minibuffer-completion-confirm}. For more information about them, |
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
665 see @ref{Completion Commands}. |
6555 | 666 @end defun |
667 | |
668 @node Completion Commands | |
669 @subsection Minibuffer Commands That Do Completion | |
670 | |
671 This section describes the keymaps, commands and user options used in | |
672 the minibuffer to do completion. | |
673 | |
674 @defvar minibuffer-local-completion-map | |
7221
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
675 @code{completing-read} uses this value as the local keymap when an |
6555 | 676 exact match of one of the completions is not required. By default, this |
677 keymap makes the following bindings: | |
678 | |
679 @table @asis | |
680 @item @kbd{?} | |
681 @code{minibuffer-completion-help} | |
682 | |
683 @item @key{SPC} | |
684 @code{minibuffer-complete-word} | |
685 | |
686 @item @key{TAB} | |
687 @code{minibuffer-complete} | |
688 @end table | |
689 | |
690 @noindent | |
7221
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
691 with other characters bound as in @code{minibuffer-local-map} |
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
692 (@pxref{Text from Minibuffer}). |
6555 | 693 @end defvar |
694 | |
695 @defvar minibuffer-local-must-match-map | |
696 @code{completing-read} uses this value as the local keymap when an | |
697 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
|
698 are bound to @code{exit-minibuffer}, the command that exits the |
6555 | 699 minibuffer unconditionally. By default, this keymap makes the following |
700 bindings: | |
701 | |
702 @table @asis | |
703 @item @kbd{?} | |
704 @code{minibuffer-completion-help} | |
705 | |
706 @item @key{SPC} | |
707 @code{minibuffer-complete-word} | |
708 | |
709 @item @key{TAB} | |
710 @code{minibuffer-complete} | |
711 | |
712 @item @key{LFD} | |
713 @code{minibuffer-complete-and-exit} | |
714 | |
715 @item @key{RET} | |
716 @code{minibuffer-complete-and-exit} | |
717 @end table | |
718 | |
719 @noindent | |
720 with other characters bound as in @code{minibuffer-local-map}. | |
721 @end defvar | |
722 | |
723 @defvar minibuffer-completion-table | |
724 The value of this variable is the alist or obarray used for completion | |
725 in the minibuffer. This is the global variable that contains what | |
726 @code{completing-read} passes to @code{try-completion}. It is used by | |
727 minibuffer completion commands such as @code{minibuffer-complete-word}. | |
728 @end defvar | |
729 | |
730 @defvar minibuffer-completion-predicate | |
731 This variable's value is the predicate that @code{completing-read} | |
732 passes to @code{try-completion}. The variable is also used by the other | |
733 minibuffer completion functions. | |
734 @end defvar | |
735 | |
736 @deffn Command minibuffer-complete-word | |
737 This function completes the minibuffer contents by at most a single | |
738 word. Even if the minibuffer contents have only one completion, | |
739 @code{minibuffer-complete-word} does not add any characters beyond the | |
740 first character that is not a word constituent. @xref{Syntax Tables}. | |
741 @end deffn | |
742 | |
743 @deffn Command minibuffer-complete | |
744 This function completes the minibuffer contents as far as possible. | |
745 @end deffn | |
746 | |
747 @deffn Command minibuffer-complete-and-exit | |
748 This function completes the minibuffer contents, and exits if | |
749 confirmation is not required, i.e., if | |
750 @code{minibuffer-completion-confirm} is non-@code{nil}. If confirmation | |
7221
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
751 @emph{is} required, it is given by repeating this command |
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
752 immediately---the command is programmed to work without confirmation |
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
753 when run twice in succession. |
6555 | 754 @end deffn |
755 | |
756 @defvar minibuffer-completion-confirm | |
757 When the value of this variable is non-@code{nil}, Emacs asks for | |
758 confirmation of a completion before exiting the minibuffer. The | |
759 function @code{minibuffer-complete-and-exit} checks the value of this | |
760 variable before it exits. | |
761 @end defvar | |
762 | |
763 @deffn Command minibuffer-completion-help | |
764 This function creates a list of the possible completions of the | |
765 current minibuffer contents. It works by calling @code{all-completions} | |
766 using the value of the variable @code{minibuffer-completion-table} as | |
767 the @var{collection} argument, and the value of | |
768 @code{minibuffer-completion-predicate} as the @var{predicate} argument. | |
769 The list of completions is displayed as text in a buffer named | |
770 @samp{*Completions*}. | |
771 @end deffn | |
772 | |
773 @defun display-completion-list completions | |
774 This function displays @var{completions} to the stream in | |
7337
cd57cd335fff
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7221
diff
changeset
|
775 @code{standard-output}, usually a buffer. (@xref{Read and Print}, for more |
6555 | 776 information about streams.) The argument @var{completions} is normally |
777 a list of completions just returned by @code{all-completions}, but it | |
778 does not have to be. Each element may be a symbol or a string, either | |
779 of which is simply printed, or a list of two strings, which is printed | |
780 as if the strings were concatenated. | |
781 | |
782 This function is called by @code{minibuffer-completion-help}. The | |
783 most common way to use it is together with | |
784 @code{with-output-to-temp-buffer}, like this: | |
785 | |
786 @example | |
787 (with-output-to-temp-buffer "*Completions*" | |
788 (display-completion-list | |
789 (all-completions (buffer-string) my-alist))) | |
790 @end example | |
791 @end defun | |
792 | |
793 @defopt completion-auto-help | |
794 If this variable is non-@code{nil}, the completion commands | |
795 automatically display a list of possible completions whenever nothing | |
796 can be completed because the next character is not uniquely determined. | |
797 @end defopt | |
798 | |
799 @node High-Level Completion | |
800 @subsection High-Level Completion Functions | |
801 | |
802 This section describes the higher-level convenient functions for | |
803 reading certain sorts of names with completion. | |
804 | |
805 @defun read-buffer prompt &optional default existing | |
806 This function reads the name of a buffer and returns it as a string. | |
807 The argument @var{default} is the default name to use, the value to | |
808 return if the user exits with an empty minibuffer. If non-@code{nil}, | |
809 it should be a string or a buffer. It is mentioned in the prompt, but | |
810 is not inserted in the minibuffer as initial input. | |
811 | |
812 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
|
813 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
|
814 do not exit if the text is not valid, and @key{RET} does completion to |
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
815 attempt to find a valid name. (However, @var{default} is not checked |
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
816 for validity; it is returned, whatever it is, if the user exits with the |
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
817 minibuffer empty.) |
6555 | 818 |
819 In the following example, the user enters @samp{minibuffer.t}, and | |
820 then types @key{RET}. The argument @var{existing} is @code{t}, and the | |
821 only buffer name starting with the given input is | |
822 @samp{minibuffer.texi}, so that name is the value. | |
823 | |
824 @example | |
825 (read-buffer "Buffer name? " "foo" t) | |
826 @group | |
7221
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
827 ;; @r{After evaluation of the preceding expression,} |
6555 | 828 ;; @r{the following prompt appears,} |
829 ;; @r{with an empty minibuffer:} | |
830 @end group | |
831 | |
832 @group | |
833 ---------- Buffer: Minibuffer ---------- | |
834 Buffer name? (default foo) @point{} | |
835 ---------- Buffer: Minibuffer ---------- | |
836 @end group | |
837 | |
838 @group | |
839 ;; @r{The user types @kbd{minibuffer.t @key{RET}}.} | |
840 @result{} "minibuffer.texi" | |
841 @end group | |
842 @end example | |
843 @end defun | |
844 | |
845 @defun read-command prompt | |
846 This function reads the name of a command and returns it as a Lisp | |
847 symbol. The argument @var{prompt} is used as in | |
848 @code{read-from-minibuffer}. Recall that a command is anything for | |
849 which @code{commandp} returns @code{t}, and a command name is a symbol | |
850 for which @code{commandp} returns @code{t}. @xref{Interactive Call}. | |
851 | |
852 @example | |
853 (read-command "Command name? ") | |
854 | |
855 @group | |
7221
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
856 ;; @r{After evaluation of the preceding expression,} |
6555 | 857 ;; @r{the following prompt appears with an empty minibuffer:} |
858 @end group | |
859 | |
860 @group | |
861 ---------- Buffer: Minibuffer ---------- | |
862 Command name? | |
863 ---------- Buffer: Minibuffer ---------- | |
864 @end group | |
865 @end example | |
866 | |
867 @noindent | |
868 If the user types @kbd{forward-c @key{RET}}, then this function returns | |
869 @code{forward-char}. | |
870 | |
871 The @code{read-command} function is a simplified interface to the | |
872 function @code{completing-read}. It uses the variable @code{obarray} so | |
873 as to complete in the set of extant Lisp symbols, and it uses the | |
874 @code{commandp} predicate so as to accept only command names: | |
875 | |
876 @cindex @code{commandp} example | |
877 @example | |
878 @group | |
879 (read-command @var{prompt}) | |
880 @equiv{} | |
881 (intern (completing-read @var{prompt} obarray | |
882 'commandp t nil)) | |
883 @end group | |
884 @end example | |
885 @end defun | |
886 | |
887 @defun read-variable prompt | |
888 This function reads the name of a user variable and returns it as a | |
889 symbol. | |
890 | |
891 @example | |
892 @group | |
893 (read-variable "Variable name? ") | |
894 | |
7221
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
895 ;; @r{After evaluation of the preceding expression,} |
6555 | 896 ;; @r{the following prompt appears,} |
897 ;; @r{with an empty minibuffer:} | |
898 @end group | |
899 | |
900 @group | |
901 ---------- Buffer: Minibuffer ---------- | |
902 Variable name? @point{} | |
903 ---------- Buffer: Minibuffer ---------- | |
904 @end group | |
905 @end example | |
906 | |
907 @noindent | |
908 If the user then types @kbd{fill-p @key{RET}}, @code{read-variable} | |
909 returns @code{fill-prefix}. | |
910 | |
911 This function is similar to @code{read-command}, but uses the | |
912 predicate @code{user-variable-p} instead of @code{commandp}: | |
913 | |
914 @cindex @code{user-variable-p} example | |
915 @example | |
916 @group | |
917 (read-variable @var{prompt}) | |
918 @equiv{} | |
919 (intern | |
920 (completing-read @var{prompt} obarray | |
921 'user-variable-p t nil)) | |
922 @end group | |
923 @end example | |
924 @end defun | |
925 | |
926 @node Reading File Names | |
927 @subsection Reading File Names | |
928 | |
929 Here is another high-level completion function, designed for reading a | |
930 file name. It provides special features including automatic insertion | |
931 of the default directory. | |
932 | |
933 @defun read-file-name prompt &optional directory default existing initial | |
934 This function reads a file name in the minibuffer, prompting with | |
935 @var{prompt} and providing completion. If @var{default} is | |
936 non-@code{nil}, then the function returns @var{default} if the user just | |
7221
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
937 types @key{RET}. @var{default} is not checked for validity; it is |
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
938 returned, whatever it is, if the user exits with the minibuffer empty. |
6555 | 939 |
7221
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
940 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
|
941 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
|
942 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
|
943 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
|
944 @key{RET} also requires confirmation after completion. If |
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
945 @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
|
946 acceptable. |
6555 | 947 |
948 The argument @var{directory} specifies the directory to use for | |
7221
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
949 completion of relative file names. If @code{insert-default-directory} |
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
950 is non-@code{nil}, @var{directory} is also inserted in the minibuffer as |
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
951 initial input. It defaults to the current buffer's value of |
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
952 @code{default-directory}. |
6555 | 953 |
954 @c Emacs 19 feature | |
955 If you specify @var{initial}, that is an initial file name to insert in | |
7221
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
956 the buffer (after with @var{directory}, if that is inserted). In this |
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
957 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
|
958 @var{initial} is @code{nil}---don't insert any file name. To see what |
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
959 @var{initial} does, try the command @kbd{C-x C-v}. |
6555 | 960 |
961 Here is an example: | |
962 | |
963 @example | |
964 @group | |
965 (read-file-name "The file is ") | |
966 | |
7221
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
967 ;; @r{After evaluation of the preceding expression,} |
6555 | 968 ;; @r{the following appears in the minibuffer:} |
969 @end group | |
970 | |
971 @group | |
972 ---------- Buffer: Minibuffer ---------- | |
973 The file is /gp/gnu/elisp/@point{} | |
974 ---------- Buffer: Minibuffer ---------- | |
975 @end group | |
976 @end example | |
977 | |
978 @noindent | |
979 Typing @kbd{manual @key{TAB}} results in the following: | |
980 | |
981 @example | |
982 @group | |
983 ---------- Buffer: Minibuffer ---------- | |
984 The file is /gp/gnu/elisp/manual.texi@point{} | |
985 ---------- Buffer: Minibuffer ---------- | |
986 @end group | |
987 @end example | |
988 | |
989 @c Wordy to avoid overfull hbox in smallbook mode. | |
990 @noindent | |
991 If the user types @key{RET}, @code{read-file-name} returns the file name | |
992 as the string @code{"/gp/gnu/elisp/manual.texi"}. | |
993 @end defun | |
994 | |
995 @defopt insert-default-directory | |
996 This variable is used by @code{read-file-name}. Its value controls | |
997 whether @code{read-file-name} starts by placing the name of the default | |
998 directory in the minibuffer, plus the initial file name if any. If the | |
999 value of this variable is @code{nil}, then @code{read-file-name} does | |
1000 not place any initial input in the minibuffer. In that case, the | |
1001 default directory is still used for completion of relative file names, | |
1002 but is not displayed. | |
1003 | |
1004 For example: | |
1005 | |
1006 @example | |
1007 @group | |
1008 ;; @r{Here the minibuffer starts out with the default directory.} | |
1009 (let ((insert-default-directory t)) | |
1010 (read-file-name "The file is ")) | |
1011 @end group | |
1012 | |
1013 @group | |
1014 ---------- Buffer: Minibuffer ---------- | |
1015 The file is ~lewis/manual/@point{} | |
1016 ---------- Buffer: Minibuffer ---------- | |
1017 @end group | |
1018 | |
1019 @group | |
1020 ;; @r{Here the minibuffer is empty and only the prompt} | |
1021 ;; @r{appears on its line.} | |
1022 (let ((insert-default-directory nil)) | |
1023 (read-file-name "The file is ")) | |
1024 @end group | |
1025 | |
1026 @group | |
1027 ---------- Buffer: Minibuffer ---------- | |
1028 The file is @point{} | |
1029 ---------- Buffer: Minibuffer ---------- | |
1030 @end group | |
1031 @end example | |
1032 @end defopt | |
1033 | |
1034 @node Programmed Completion | |
1035 @subsection Programmed Completion | |
1036 @cindex programmed completion | |
1037 | |
1038 Sometimes it is not possible to create an alist or an obarray | |
1039 containing all the intended possible completions. In such a case, you | |
1040 can supply your own function to compute the completion of a given string. | |
1041 This is called @dfn{programmed completion}. | |
1042 | |
1043 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
|
1044 @var{collection} argument to @code{completing-read}. The function |
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
1045 @code{completing-read} arranges to pass your completion function along |
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
1046 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
|
1047 your function do all the work. |
6555 | 1048 |
1049 The completion function should accept three arguments: | |
1050 | |
1051 @itemize @bullet | |
1052 @item | |
1053 The string to be completed. | |
1054 | |
1055 @item | |
1056 The predicate function to filter possible matches, or @code{nil} if | |
1057 none. Your function should call the predicate for each possible match, | |
1058 and ignore the possible match if the predicate returns @code{nil}. | |
1059 | |
1060 @item | |
1061 A flag specifying the type of operation. | |
1062 @end itemize | |
1063 | |
1064 There are three flag values for three operations: | |
1065 | |
1066 @itemize @bullet | |
1067 @item | |
1068 @code{nil} specifies @code{try-completion}. The completion function | |
1069 should return the completion of the specified string, or @code{t} if the | |
1070 string is an exact match already, or @code{nil} if the string matches no | |
1071 possibility. | |
1072 | |
1073 @item | |
1074 @code{t} specifies @code{all-completions}. The completion function | |
1075 should return a list of all possible completions of the specified | |
1076 string. | |
1077 | |
1078 @item | |
1079 @code{lambda} specifies a test for an exact match. The completion | |
1080 function should return @code{t} if the specified string is an exact | |
1081 match for some possibility; @code{nil} otherwise. | |
1082 @end itemize | |
1083 | |
1084 It would be consistent and clean for completion functions to allow | |
7221
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
1085 lambda expressions (lists tha are functions) as well as function |
6555 | 1086 symbols as @var{collection}, but this is impossible. Lists as |
1087 completion tables are already assigned another meaning---as alists. It | |
1088 would be unreliable to fail to handle an alist normally because it is | |
1089 also a possible function. So you must arrange for any function you wish | |
1090 to use for completion to be encapsulated in a symbol. | |
1091 | |
1092 Emacs uses programmed completion when completing file names. | |
1093 @xref{File Name Completion}. | |
1094 | |
1095 @node Yes-or-No Queries | |
1096 @section Yes-or-No Queries | |
1097 @cindex asking the user questions | |
1098 @cindex querying the user | |
1099 @cindex yes-or-no questions | |
1100 | |
1101 This section describes functions used to ask the user a yes-or-no | |
1102 question. The function @code{y-or-n-p} can be answered with a single | |
1103 character; it is useful for questions where an inadvertent wrong answer | |
1104 will not have serious consequences. @code{yes-or-no-p} is suitable for | |
1105 more momentous questions, since it requires three or four characters to | |
1106 answer. | |
1107 | |
7337
cd57cd335fff
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7221
diff
changeset
|
1108 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
|
1109 using the mouse---more precisely, if @code{last-nonmenu-event} |
cd57cd335fff
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7221
diff
changeset
|
1110 (@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
|
1111 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
|
1112 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
|
1113 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
|
1114 the call. |
cd57cd335fff
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7221
diff
changeset
|
1115 |
6555 | 1116 Strictly speaking, @code{yes-or-no-p} uses the minibuffer and |
1117 @code{y-or-n-p} does not; but it seems best to describe them together. | |
1118 | |
1119 @defun y-or-n-p prompt | |
7221
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
1120 This function asks the user a question, expecting input in the echo |
6555 | 1121 area. It returns @code{t} if the user types @kbd{y}, @code{nil} if the |
1122 user types @kbd{n}. This function also accepts @key{SPC} to mean yes | |
1123 and @key{DEL} to mean no. It accepts @kbd{C-]} to mean ``quit'', like | |
1124 @kbd{C-g}, because the question might look like a minibuffer and for | |
1125 that reason the user might try to use @kbd{C-]} to get out. The answer | |
1126 is a single character, with no @key{RET} needed to terminate it. Upper | |
1127 and lower case are equivalent. | |
1128 | |
7221
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
1129 ``Asking the question'' means printing @var{prompt} in the echo area, |
6555 | 1130 followed by the string @w{@samp{(y or n) }}. If the input is not one of |
1131 the expected answers (@kbd{y}, @kbd{n}, @kbd{@key{SPC}}, | |
1132 @kbd{@key{DEL}}, or something that quits), the function responds | |
1133 @samp{Please answer y or n.}, and repeats the request. | |
1134 | |
7221
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
1135 This function does not actually use the minibuffer, since it does not |
6555 | 1136 allow editing of the answer. It actually uses the echo area (@pxref{The |
1137 Echo Area}), which uses the same screen space as the minibuffer. The | |
1138 cursor moves to the echo area while the question is being asked. | |
1139 | |
7221
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
1140 The answers and their meanings, even @samp{y} and @samp{n}, are not |
6555 | 1141 hardwired. The keymap @code{query-replace-map} specifies them. |
1142 @xref{Search and Replace}. | |
1143 | |
7221
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
1144 In the following example, the user first types @kbd{q}, which is |
6555 | 1145 invalid. At the next prompt the user types @kbd{y}. |
1146 | |
1147 @smallexample | |
1148 @group | |
1149 (y-or-n-p "Do you need a lift? ") | |
1150 | |
7221
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
1151 ;; @r{After evaluation of the preceding expression,} |
6555 | 1152 ;; @r{the following prompt appears in the echo area:} |
1153 @end group | |
1154 | |
1155 @group | |
1156 ---------- Echo area ---------- | |
1157 Do you need a lift? (y or n) | |
1158 ---------- Echo area ---------- | |
1159 @end group | |
1160 | |
1161 ;; @r{If the user then types @kbd{q}, the following appears:} | |
1162 | |
1163 @group | |
1164 ---------- Echo area ---------- | |
1165 Please answer y or n. Do you need a lift? (y or n) | |
1166 ---------- Echo area ---------- | |
1167 @end group | |
1168 | |
1169 ;; @r{When the user types a valid answer,} | |
1170 ;; @r{it is displayed after the question:} | |
1171 | |
1172 @group | |
1173 ---------- Echo area ---------- | |
1174 Do you need a lift? (y or n) y | |
1175 ---------- Echo area ---------- | |
1176 @end group | |
1177 @end smallexample | |
1178 | |
1179 @noindent | |
1180 We show successive lines of echo area messages, but only one actually | |
1181 appears on the screen at a time. | |
1182 @end defun | |
1183 | |
1184 @defun yes-or-no-p prompt | |
7221
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
1185 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
|
1186 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
|
1187 @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
|
1188 finalize the response. Upper and lower case are equivalent. |
6555 | 1189 |
7221
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
1190 @code{yes-or-no-p} starts by displaying @var{prompt} in the echo area, |
6555 | 1191 followed by @w{@samp{(yes or no) }}. The user must type one of the |
1192 expected responses; otherwise, the function responds @samp{Please answer | |
1193 yes or no.}, waits about two seconds and repeats the request. | |
1194 | |
7221
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
1195 @code{yes-or-no-p} requires more work from the user than |
6555 | 1196 @code{y-or-n-p} and is appropriate for more crucial decisions. |
1197 | |
1198 Here is an example: | |
1199 | |
1200 @smallexample | |
1201 @group | |
1202 (yes-or-no-p "Do you really want to remove everything? ") | |
1203 | |
7221
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
1204 ;; @r{After evaluation of the preceding expression,} |
6555 | 1205 ;; @r{the following prompt appears,} |
1206 ;; @r{with an empty minibuffer:} | |
1207 @end group | |
1208 | |
1209 @group | |
1210 ---------- Buffer: minibuffer ---------- | |
1211 Do you really want to remove everything? (yes or no) | |
1212 ---------- Buffer: minibuffer ---------- | |
1213 @end group | |
1214 @end smallexample | |
1215 | |
1216 @noindent | |
1217 If the user first types @kbd{y @key{RET}}, which is invalid because this | |
1218 function demands the entire word @samp{yes}, it responds by displaying | |
1219 these prompts, with a brief pause between them: | |
1220 | |
1221 @smallexample | |
1222 @group | |
1223 ---------- Buffer: minibuffer ---------- | |
1224 Please answer yes or no. | |
1225 Do you really want to remove everything? (yes or no) | |
1226 ---------- Buffer: minibuffer ---------- | |
1227 @end group | |
1228 @end smallexample | |
1229 @end defun | |
1230 | |
1231 @node Multiple Queries | |
1232 @section Asking Multiple Y-or-N Questions | |
1233 | |
7221
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
1234 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
|
1235 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
|
1236 @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
|
1237 asking each question individually. This gives the user certain |
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
1238 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
|
1239 once. |
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
1240 |
6555 | 1241 @defun map-y-or-n-p prompter actor list &optional help action-alist |
1242 This function, new in Emacs 19, asks the user a series of questions, | |
1243 reading a single-character answer in the echo area for each one. | |
1244 | |
1245 The value of @var{list} specifies the objects to ask questions about. | |
1246 It should be either a list of objects or a generator function. If it is | |
1247 a function, it should expect no arguments, and should return either the | |
1248 next object to ask about, or @code{nil} meaning stop asking questions. | |
1249 | |
1250 The argument @var{prompter} specifies how to ask each question. If | |
1251 @var{prompter} is a string, the question text is computed like this: | |
1252 | |
1253 @example | |
1254 (format @var{prompter} @var{object}) | |
1255 @end example | |
1256 | |
1257 @noindent | |
1258 where @var{object} is the next object to ask about (as obtained from | |
1259 @var{list}). | |
1260 | |
1261 If not a string, @var{prompter} should be a function of one argument | |
1262 (the next object to ask about) and should return the question text. | |
1263 | |
1264 The argument @var{actor} says how to act on the answers that the user | |
1265 gives. It should be a function of one argument, and it is called with | |
1266 each object that the user says yes for. Its argument is always an | |
1267 object obtained from @var{list}. | |
1268 | |
1269 If the argument @var{help} is given, it should be a list of this form: | |
1270 | |
1271 @example | |
1272 (@var{singular} @var{plural} @var{action}) | |
1273 @end example | |
1274 | |
1275 @noindent | |
1276 where @var{singular} is a string containing a singular noun that | |
1277 describes the objects conceptually being acted on, @var{plural} is the | |
1278 corresponding plural noun, and @var{action} is a transitive verb | |
1279 describing what @var{actor} does. | |
1280 | |
1281 If you don't specify @var{help}, the default is @code{("object" | |
1282 "objects" "act on")}. | |
1283 | |
1284 Each time a question is asked, the user may enter @kbd{y}, @kbd{Y}, or | |
1285 @key{SPC} to act on that object; @kbd{n}, @kbd{N}, or @key{DEL} to skip | |
1286 that object; @kbd{!} to act on all following objects; @key{ESC} or | |
1287 @kbd{q} to exit (skip all following objects); @kbd{.} (period) to act on | |
1288 the current object and then exit; or @kbd{C-h} to get help. These are | |
1289 the same answers that @code{query-replace} accepts. The keymap | |
1290 @code{query-replace-map} defines their meaning for @code{map-y-or-n-p} | |
1291 as well as for @code{query-replace}; see @ref{Search and Replace}. | |
1292 | |
1293 You can use @var{action-alist} to specify additional possible answers | |
1294 and what they mean. It is an alist of elements of the form | |
1295 @code{(@var{char} @var{function} @var{help})}, each of which defines one | |
1296 additional answer. In this element, @var{char} is a character (the | |
1297 answer); @var{function} is a function of one argument (an object from | |
1298 @var{list}); @var{help} is a string. | |
1299 | |
1300 When the user responds with @var{char}, @code{map-y-or-n-p} calls | |
1301 @var{function}. If it returns non-@code{nil}, the object is considered | |
1302 ``acted upon'', and @code{map-y-or-n-p} advances to the next object in | |
1303 @var{list}. If it returns @code{nil}, the prompt is repeated for the | |
1304 same object. | |
1305 | |
7337
cd57cd335fff
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7221
diff
changeset
|
1306 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
|
1307 mouse---more precisely, if @code{last-nonmenu-event} (@pxref{Command |
cd57cd335fff
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7221
diff
changeset
|
1308 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
|
1309 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
|
1310 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
|
1311 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
|
1312 value around the call. |
cd57cd335fff
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7221
diff
changeset
|
1313 |
6555 | 1314 The return value of @code{map-y-or-n-p} is the number of objects acted on. |
1315 @end defun | |
1316 | |
1317 @node Minibuffer Misc | |
1318 @comment node-name, next, previous, up | |
1319 @section Minibuffer Miscellany | |
1320 | |
1321 This section describes some basic functions and variables related to | |
1322 minibuffers. | |
1323 | |
1324 @deffn Command exit-minibuffer | |
1325 This command exits the active minibuffer. It is normally bound to | |
1326 keys in minibuffer local keymaps. | |
1327 @end deffn | |
1328 | |
1329 @deffn Command self-insert-and-exit | |
1330 This command exits the active minibuffer after inserting the last | |
1331 character typed on the keyboard (found in @code{last-command-char}; | |
1332 @pxref{Command Loop Info}). | |
1333 @end deffn | |
1334 | |
1335 @deffn Command previous-history-element n | |
1336 This command replaces the minibuffer contents with the value of the | |
1337 @var{n}th previous (older) history element. | |
1338 @end deffn | |
1339 | |
1340 @deffn Command next-history-element n | |
1341 This command replaces the minibuffer contents with the value of the | |
1342 @var{n}th more recent history element. | |
1343 @end deffn | |
1344 | |
1345 @deffn Command previous-matching-history-element pattern | |
1346 This command replaces the minibuffer contents with the value of the | |
7221
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
1347 previous (older) history element that matches @var{pattern} (a regular |
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
1348 expression). |
6555 | 1349 @end deffn |
1350 | |
1351 @deffn Command next-matching-history-element pattern | |
7221
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
1352 This command replaces the minibuffer contents with the value of the next |
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
1353 (newer) history element that matches @var{pattern} (a regular |
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
1354 expression). |
6555 | 1355 @end deffn |
1356 | |
1357 @defvar minibuffer-setup-hook | |
1358 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
|
1359 @xref{Hooks}. |
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
1360 @end defvar |
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
1361 |
8529
464f7abd0b26
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7337
diff
changeset
|
1362 @defvar minibuffer-exit-hook |
7221
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
1363 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
|
1364 @xref{Hooks}. |
6555 | 1365 @end defvar |
1366 | |
1367 @defvar minibuffer-help-form | |
1368 The current value of this variable is used to rebind @code{help-form} | |
1369 locally inside the minibuffer (@pxref{Help Functions}). | |
1370 @end defvar | |
1371 | |
1372 @defun minibuffer-window &optional frame | |
1373 This function returns the window that is used for the minibuffer. In | |
1374 Emacs 18, there is one and only one minibuffer window; this window | |
1375 always exists and cannot be deleted. In Emacs 19, each frame can have | |
1376 its own minibuffer, and this function returns the minibuffer window used | |
1377 for frame @var{frame} (which defaults to the currently selected frame). | |
1378 @end defun | |
1379 | |
1380 @c Emacs 19 feature | |
1381 @defun window-minibuffer-p window | |
1382 This function returns non-@code{nil} if @var{window} is a minibuffer window. | |
1383 @end defun | |
1384 | |
1385 It is not correct to determine whether a given window is a minibuffer by | |
1386 comparing it with the result of @code{(minibuffer-window)}, because | |
1387 there can be more than one minibuffer window if there is more than one | |
1388 frame. | |
1389 | |
1390 @defun minibuffer-window-active-p window | |
1391 This function returns non-@code{nil} if @var{window}, assumed to be | |
1392 a minibuffer window, is currently active. | |
1393 @end defun | |
1394 | |
1395 @defvar minibuffer-scroll-window | |
1396 If the value of this variable is non-@code{nil}, it should be a window | |
1397 object. When the function @code{scroll-other-window} is called in the | |
1398 minibuffer, it scrolls this window. | |
1399 @end defvar | |
1400 | |
1401 Finally, some functions and variables deal with recursive minibuffers | |
1402 (@pxref{Recursive Editing}): | |
1403 | |
1404 @defun minibuffer-depth | |
1405 This function returns the current depth of activations of the | |
1406 minibuffer, a nonnegative integer. If no minibuffers are active, it | |
1407 returns zero. | |
1408 @end defun | |
1409 | |
7221
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
1410 @defun minibuffer-prompt |
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
1411 This function returns the prompt string of the currently active |
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
1412 minibuffer. If no minibuffer is active, it returns @code{nil}. |
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
1413 @end defun |
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
1414 |
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
1415 @defun minibuffer-prompt-width |
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
1416 This function returns the display width of the prompt string of the |
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
1417 currently active minibuffer. If no minibuffer is active, it returns 0. |
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
1418 @end defun |
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
1419 |
6555 | 1420 @defopt enable-recursive-minibuffers |
1421 If this variable is non-@code{nil}, you can invoke commands (such as | |
7221
a2c7acc3be9c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
1422 @code{find-file}) that use minibuffers even while in the minibuffer |
6555 | 1423 window. Such invocation produces a recursive editing level for a new |
1424 minibuffer. The outer-level minibuffer is invisible while you are | |
1425 editing the inner one. | |
1426 | |
1427 This variable only affects invoking the minibuffer while the | |
1428 minibuffer window is selected. If you switch windows while in the | |
1429 minibuffer, you can always invoke minibuffer commands while some other | |
1430 window is selected. | |
1431 @end defopt | |
1432 | |
1433 @c Emacs 19 feature | |
1434 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
|
1435 that is non-@code{nil}, then the command can use the minibuffer to read |
6555 | 1436 arguments even if it is invoked from the minibuffer. The minibuffer |
1437 command @code{next-matching-history-element} (normally bound to | |
1438 @kbd{M-s} in the minibuffer) uses this feature. |