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