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