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