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