annotate lispref/minibuf.texi @ 82974:e88e622cd27a gnus-5_10-pre-merge-yamaoka

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