Merge from trunk.
[bpt/emacs.git] / src / minibuf.c
CommitLineData
f927c5ae 1/* Minibuffer input and completion.
c11136ec 2
73b0cd50 3Copyright (C) 1985-1986, 1993-2011 Free Software Foundation, Inc.
f927c5ae
JB
4
5This file is part of GNU Emacs.
6
9ec0b715 7GNU Emacs is free software: you can redistribute it and/or modify
f927c5ae 8it under the terms of the GNU General Public License as published by
9ec0b715
GM
9the Free Software Foundation, either version 3 of the License, or
10(at your option) any later version.
f927c5ae
JB
11
12GNU Emacs is distributed in the hope that it will be useful,
13but WITHOUT ANY WARRANTY; without even the implied warranty of
14MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15GNU General Public License for more details.
16
17You should have received a copy of the GNU General Public License
9ec0b715 18along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
f927c5ae
JB
19
20
18160b98 21#include <config.h>
590bd467 22#include <errno.h>
3f708f4c 23#include <stdio.h>
d7306fe6 24#include <setjmp.h>
af52c32d 25
f927c5ae
JB
26#include "lisp.h"
27#include "commands.h"
28#include "buffer.h"
29#include "dispextern.h"
2538fae4 30#include "keyboard.h"
ff11dfa1 31#include "frame.h"
f927c5ae
JB
32#include "window.h"
33#include "syntax.h"
0c21eeeb 34#include "intervals.h"
8feddab4 35#include "keymap.h"
fa971ac3 36#include "termhooks.h"
f927c5ae 37
f927c5ae 38/* List of buffers for use as minibuffers.
4d04c1f1
KH
39 The first element of the list is used for the outermost minibuffer
40 invocation, the next element is used for a recursive minibuffer
41 invocation, etc. The list is extended at the end as deeper
42 minibuffer recursions are encountered. */
279cf52c 43
f927c5ae
JB
44Lisp_Object Vminibuffer_list;
45
620c53a6 46/* Data to remember during recursive minibuffer invocations. */
279cf52c 47
1717ede2 48static Lisp_Object minibuf_save_list;
f927c5ae
JB
49
50/* Depth in minibuffer invocations. */
279cf52c 51
f927c5ae
JB
52int minibuf_level;
53
77aa8edf 54/* The maximum length of a minibuffer history. */
279cf52c 55
955cbe7b 56static Lisp_Object Qhistory_length;
179a4ca7 57
620c53a6 58/* Fread_minibuffer leaves the input here as a string. */
279cf52c 59
f927c5ae
JB
60Lisp_Object last_minibuf_string;
61
955cbe7b 62static Lisp_Object Qminibuffer_history, Qbuffer_name_history;
770970cb 63
955cbe7b 64static Lisp_Object Qread_file_name_internal;
719b4a40 65
177aecf9 66/* Normal hooks for entry to and exit from minibuffer. */
5c781212 67
955cbe7b
PE
68static Lisp_Object Qminibuffer_setup_hook;
69static Lisp_Object Qminibuffer_exit_hook;
eebbfb01 70
9fa5c213 71Lisp_Object Qcompletion_ignore_case;
955cbe7b
PE
72static Lisp_Object Qminibuffer_completion_table;
73static Lisp_Object Qminibuffer_completion_predicate;
74static Lisp_Object Qminibuffer_completion_confirm;
955cbe7b 75static Lisp_Object Quser_variable_p;
5744fa7c 76
955cbe7b 77static Lisp_Object Qminibuffer_default;
5744fa7c 78
955cbe7b 79static Lisp_Object Qcurrent_input_method, Qactivate_input_method;
cee54539 80
955cbe7b 81static Lisp_Object Qcase_fold_search;
6b61353c 82
955cbe7b 83static Lisp_Object Qread_expression_history;
627fb581 84
e9588e2e
PE
85/* Prompt to display in front of the mini-buffer contents. */
86
87static Lisp_Object minibuf_prompt;
88
89/* Width of current mini-buffer prompt. Only set after display_line
90 of the line that contains the prompt. */
91
7831777b 92static EMACS_INT minibuf_prompt_width;
e9588e2e 93
f927c5ae 94\f
89fdc4a0
KH
95/* Put minibuf on currently selected frame's minibuffer.
96 We do this whenever the user starts a new minibuffer
97 or when a minibuffer exits. */
98
1717ede2 99static void
971de7fb 100choose_minibuf_frame (void)
89fdc4a0 101{
a4aafc54
GM
102 if (FRAMEP (selected_frame)
103 && FRAME_LIVE_P (XFRAME (selected_frame))
104 && !EQ (minibuf_window, XFRAME (selected_frame)->minibuffer_window))
89fdc4a0 105 {
a4aafc54
GM
106 struct frame *sf = XFRAME (selected_frame);
107 Lisp_Object buffer;
9ab4a725 108
89fdc4a0
KH
109 /* I don't think that any frames may validly have a null minibuffer
110 window anymore. */
a4aafc54 111 if (NILP (sf->minibuffer_window))
89fdc4a0
KH
112 abort ();
113
a4aafc54
GM
114 /* Under X, we come here with minibuf_window being the
115 minibuffer window of the unused termcap window created in
116 init_window_once. That window doesn't have a buffer. */
117 buffer = XWINDOW (minibuf_window)->buffer;
118 if (BUFFERP (buffer))
cbbfe056 119 Fset_window_buffer (sf->minibuffer_window, buffer, Qnil);
a4aafc54 120 minibuf_window = sf->minibuffer_window;
89fdc4a0 121 }
914860c2
RS
122
123 /* Make sure no other frame has a minibuffer as its selected window,
124 because the text would not be displayed in it, and that would be
07d402c8
RS
125 confusing. Only allow the selected frame to do this,
126 and that only if the minibuffer is active. */
914860c2
RS
127 {
128 Lisp_Object tail, frame;
129
130 FOR_EACH_FRAME (tail, frame)
07d402c8 131 if (MINI_WINDOW_P (XWINDOW (FRAME_SELECTED_WINDOW (XFRAME (frame))))
a4aafc54 132 && !(EQ (frame, selected_frame)
07d402c8 133 && minibuf_level > 0))
c8938ab6 134 Fset_frame_selected_window (frame, Fframe_first_window (frame), Qnil);
914860c2 135 }
89fdc4a0 136}
68313ed8 137
5716756e 138static Lisp_Object
971de7fb 139choose_minibuf_frame_1 (Lisp_Object ignore)
0c94f256
RS
140{
141 choose_minibuf_frame ();
142 return Qnil;
143}
144
727e958e
MR
145DEFUN ("active-minibuffer-window", Factive_minibuffer_window,
146 Sactive_minibuffer_window, 0, 0, 0,
147 doc: /* Return the currently active minibuffer window, or nil if none. */)
148 (void)
149{
150 return minibuf_level ? minibuf_window : Qnil;
151}
152
68313ed8
RS
153DEFUN ("set-minibuffer-window", Fset_minibuffer_window,
154 Sset_minibuffer_window, 1, 1, 0,
af52c32d 155 doc: /* Specify which minibuffer window to use for the minibuffer.
6b61353c 156This affects where the minibuffer is displayed if you put text in it
af52c32d 157without invoking the usual minibuffer commands. */)
5842a27b 158 (Lisp_Object window)
68313ed8 159{
b7826503 160 CHECK_WINDOW (window);
68313ed8
RS
161 if (! MINI_WINDOW_P (XWINDOW (window)))
162 error ("Window is not a minibuffer window");
163
164 minibuf_window = window;
165
166 return window;
167}
168
89fdc4a0 169\f
fd6fa53f 170/* Actual minibuffer invocation. */
f927c5ae 171
f57e2426
J
172static Lisp_Object read_minibuf_unwind (Lisp_Object);
173static Lisp_Object run_exit_minibuf_hook (Lisp_Object);
174static Lisp_Object read_minibuf (Lisp_Object, Lisp_Object,
175 Lisp_Object, Lisp_Object,
176 int, Lisp_Object,
177 Lisp_Object, Lisp_Object,
178 int, int);
179static Lisp_Object read_minibuf_noninteractive (Lisp_Object, Lisp_Object,
180 Lisp_Object, Lisp_Object,
181 int, Lisp_Object,
182 Lisp_Object, Lisp_Object,
183 int, int);
184static Lisp_Object string_to_object (Lisp_Object, Lisp_Object);
edfef199
GM
185
186
187/* Read a Lisp object from VAL and return it. If VAL is an empty
188 string, and DEFALT is a string, read from DEFALT instead of VAL. */
189
190static Lisp_Object
971de7fb 191string_to_object (Lisp_Object val, Lisp_Object defalt)
edfef199
GM
192{
193 struct gcpro gcpro1, gcpro2;
194 Lisp_Object expr_and_pos;
da43f021 195 EMACS_INT pos;
9ab4a725 196
edfef199 197 GCPRO2 (val, defalt);
9ab4a725 198
fb30dfd2
JL
199 if (STRINGP (val) && SCHARS (val) == 0)
200 {
201 if (STRINGP (defalt))
202 val = defalt;
203 else if (CONSP (defalt) && STRINGP (XCAR (defalt)))
204 val = XCAR (defalt);
205 }
9ab4a725 206
edfef199
GM
207 expr_and_pos = Fread_from_string (val, Qnil, Qnil);
208 pos = XINT (Fcdr (expr_and_pos));
d5db4077 209 if (pos != SCHARS (val))
edfef199
GM
210 {
211 /* Ignore trailing whitespace; any other trailing junk
212 is an error. */
da43f021 213 EMACS_INT i;
edfef199 214 pos = string_char_to_byte (val, pos);
d5db4077 215 for (i = pos; i < SBYTES (val); i++)
edfef199 216 {
d5db4077 217 int c = SREF (val, i);
edfef199
GM
218 if (c != ' ' && c != '\t' && c != '\n')
219 error ("Trailing garbage following expression");
220 }
221 }
9ab4a725 222
edfef199
GM
223 val = Fcar (expr_and_pos);
224 RETURN_UNGCPRO (val);
225}
226
227
228/* Like read_minibuf but reading from stdin. This function is called
229 from read_minibuf to do the job if noninteractive. */
230
231static Lisp_Object
d5a3eaaf
AS
232read_minibuf_noninteractive (Lisp_Object map, Lisp_Object initial,
233 Lisp_Object prompt, Lisp_Object backup_n,
234 int expflag,
235 Lisp_Object histvar, Lisp_Object histpos,
236 Lisp_Object defalt,
237 int allow_props, int inherit_input_method)
edfef199 238{
90532f02 239 ptrdiff_t size, len;
590bd467 240 char *line;
edfef199 241 Lisp_Object val;
590bd467 242 int c;
edfef199 243
d5db4077 244 fprintf (stdout, "%s", SDATA (prompt));
edfef199
GM
245 fflush (stdout);
246
6bbd7a29 247 val = Qnil;
edfef199
GM
248 size = 100;
249 len = 0;
90532f02 250 line = (char *) xmalloc (size);
590bd467
PE
251
252 while ((c = getchar ()) != '\n')
edfef199 253 {
590bd467
PE
254 if (c < 0)
255 {
256 if (errno != EINTR)
257 break;
258 }
259 else
260 {
261 if (len == size)
262 {
263 if (STRING_BYTES_BOUND / 2 < size)
ea8a7d00
PE
264 {
265 xfree (line);
266 memory_full (SIZE_MAX);
267 }
590bd467
PE
268 size *= 2;
269 line = (char *) xrealloc (line, size);
270 }
271 line[len++] = c;
272 }
edfef199
GM
273 }
274
590bd467 275 if (len)
edfef199 276 {
590bd467 277 val = make_string (line, len);
edfef199
GM
278 xfree (line);
279 }
280 else
281 {
282 xfree (line);
283 error ("Error reading from stdin");
284 }
9ab4a725 285
fd6fa53f 286 /* If Lisp form desired instead of string, parse it. */
edfef199 287 if (expflag)
fb30dfd2 288 val = string_to_object (val, CONSP (defalt) ? XCAR (defalt) : defalt);
9ab4a725 289
edfef199
GM
290 return val;
291}
1011edb5 292\f
873ef78e 293DEFUN ("minibufferp", Fminibufferp,
6d1b1d7b
JPW
294 Sminibufferp, 0, 1, 0,
295 doc: /* Return t if BUFFER is a minibuffer.
6b61353c
KH
296No argument or nil as argument means use current buffer as BUFFER.
297BUFFER can be a buffer or a buffer name. */)
5842a27b 298 (Lisp_Object buffer)
873ef78e
RS
299{
300 Lisp_Object tem;
301
6d1b1d7b
JPW
302 if (NILP (buffer))
303 buffer = Fcurrent_buffer ();
304 else if (STRINGP (buffer))
305 buffer = Fget_buffer (buffer);
306 else
307 CHECK_BUFFER (buffer);
308
309 tem = Fmemq (buffer, Vminibuffer_list);
873ef78e
RS
310 return ! NILP (tem) ? Qt : Qnil;
311}
312
a346ec72
MB
313DEFUN ("minibuffer-prompt-end", Fminibuffer_prompt_end,
314 Sminibuffer_prompt_end, 0, 0, 0,
af52c32d 315 doc: /* Return the buffer position of the end of the minibuffer prompt.
eb7c9b64 316Return (point-min) if current buffer is not a minibuffer. */)
5842a27b 317 (void)
a346ec72
MB
318{
319 /* This function is written to be most efficient when there's a prompt. */
873ef78e
RS
320 Lisp_Object beg, end, tem;
321 beg = make_number (BEGV);
322
323 tem = Fmemq (Fcurrent_buffer (), Vminibuffer_list);
324 if (NILP (tem))
325 return beg;
326
327 end = Ffield_end (beg, Qnil, Qnil);
9ab4a725 328
a346ec72 329 if (XINT (end) == ZV && NILP (Fget_char_property (beg, Qfield, Qnil)))
b056f36d 330 return beg;
a346ec72
MB
331 else
332 return end;
333}
334
335DEFUN ("minibuffer-contents", Fminibuffer_contents,
336 Sminibuffer_contents, 0, 0, 0,
029a305c 337 doc: /* Return the user input in a minibuffer as a string.
6cc62df0 338If the current buffer is not a minibuffer, return its entire contents. */)
5842a27b 339 (void)
a346ec72 340{
413d18e7 341 EMACS_INT prompt_end = XINT (Fminibuffer_prompt_end ());
a346ec72
MB
342 return make_buffer_string (prompt_end, ZV, 1);
343}
344
345DEFUN ("minibuffer-contents-no-properties", Fminibuffer_contents_no_properties,
346 Sminibuffer_contents_no_properties, 0, 0, 0,
029a305c 347 doc: /* Return the user input in a minibuffer as a string, without text-properties.
6cc62df0 348If the current buffer is not a minibuffer, return its entire contents. */)
5842a27b 349 (void)
a346ec72 350{
413d18e7 351 EMACS_INT prompt_end = XINT (Fminibuffer_prompt_end ());
a346ec72
MB
352 return make_buffer_string (prompt_end, ZV, 0);
353}
354
b5e1e449
JL
355DEFUN ("minibuffer-completion-contents", Fminibuffer_completion_contents,
356 Sminibuffer_completion_contents, 0, 0, 0,
357 doc: /* Return the user input in a minibuffer before point as a string.
358That is what completion commands operate on.
6cc62df0 359If the current buffer is not a minibuffer, return its entire contents. */)
5842a27b 360 (void)
b5e1e449 361{
413d18e7 362 EMACS_INT prompt_end = XINT (Fminibuffer_prompt_end ());
b5e1e449
JL
363 if (PT < prompt_end)
364 error ("Cannot do completion in the prompt");
365 return make_buffer_string (prompt_end, PT, 1);
366}
367
1011edb5 368\f
6b61353c
KH
369/* Read from the minibuffer using keymap MAP and initial contents INITIAL,
370 putting point minus BACKUP_N bytes from the end of INITIAL,
770970cb 371 prompting with PROMPT (a string), using history list HISTVAR
6b61353c
KH
372 with initial position HISTPOS. INITIAL should be a string or a
373 cons of a string and an integer. BACKUP_N should be <= 0, or
374 Qnil, which is equivalent to 0. If INITIAL is a cons, BACKUP_N is
375 ignored and replaced with an integer that puts point at one-indexed
376 position N in INITIAL, where N is the CDR of INITIAL, or at the
377 beginning of INITIAL if N <= 0.
770970cb
RS
378
379 Normally return the result as a string (the text that was read),
3ab14176 380 but if EXPFLAG is nonzero, read it and return the object read.
b278606c
BF
381 If HISTVAR is given, save the value read on that history only if it doesn't
382 match the front of that history list exactly. The value is pushed onto
e5d4686b 383 the list as the string that was read.
770970cb 384
4f9f637a 385 DEFALT specifies the default value for the sake of history commands.
c3421833 386
cee54539
KH
387 If ALLOW_PROPS is nonzero, we do not throw away text properties.
388
6b61353c 389 if INHERIT_INPUT_METHOD is nonzero, the minibuffer inherits the
cee54539 390 current input method. */
e5d4686b
RS
391
392static Lisp_Object
d5a3eaaf
AS
393read_minibuf (Lisp_Object map, Lisp_Object initial, Lisp_Object prompt,
394 Lisp_Object backup_n, int expflag,
395 Lisp_Object histvar, Lisp_Object histpos, Lisp_Object defalt,
396 int allow_props, int inherit_input_method)
f927c5ae 397{
00a34088 398 Lisp_Object val;
aed13378 399 int count = SPECPDL_INDEX ();
cee54539
KH
400 Lisp_Object mini_frame, ambient_dir, minibuffer, input_method;
401 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5;
c75000c7 402 Lisp_Object enable_multibyte;
6b61353c 403 int pos = INTEGERP (backup_n) ? XINT (backup_n) : 0;
4f9f637a
RS
404 /* String to add to the history. */
405 Lisp_Object histstring;
406
b20de1cd
RS
407 Lisp_Object empty_minibuf;
408 Lisp_Object dummy, frame;
409
e5d4686b
RS
410 specbind (Qminibuffer_default, defalt);
411
ef72eaff
KS
412 /* If Vminibuffer_completing_file_name is `lambda' on entry, it was t
413 in previous recursive minibuffer, but was not set explicitly
414 to t for this invocation, so set it to nil in this minibuffer.
415 Save the old value now, before we change it. */
416 specbind (intern ("minibuffer-completing-file-name"), Vminibuffer_completing_file_name);
417 if (EQ (Vminibuffer_completing_file_name, Qlambda))
418 Vminibuffer_completing_file_name = Qnil;
419
d148e14d 420#ifdef HAVE_WINDOW_SYSTEM
526a058f
GM
421 if (display_hourglass_p)
422 cancel_hourglass ();
e5baa1a7 423#endif
718d3251 424
6b61353c
KH
425 if (!NILP (initial))
426 {
427 if (CONSP (initial))
428 {
429 backup_n = Fcdr (initial);
430 initial = Fcar (initial);
431 CHECK_STRING (initial);
432 if (!NILP (backup_n))
433 {
434 CHECK_NUMBER (backup_n);
435 /* Convert to distance from end of input. */
436 if (XINT (backup_n) < 1)
437 /* A number too small means the beginning of the string. */
438 pos = - SCHARS (initial);
439 else
440 pos = XINT (backup_n) - 1 - SCHARS (initial);
441 }
442 }
443 else
444 CHECK_STRING (initial);
445 }
00a34088 446 val = Qnil;
4b4deea2 447 ambient_dir = BVAR (current_buffer, directory);
cee54539 448 input_method = Qnil;
c75000c7 449 enable_multibyte = Qnil;
57ceaa8a 450
00a34088
RS
451 /* Don't need to protect PROMPT, HISTVAR, and HISTPOS because we
452 store them away before we can GC. Don't need to protect
453 BACKUP_N because we use the value only if it is an integer. */
cee54539 454 GCPRO5 (map, initial, val, ambient_dir, input_method);
f927c5ae 455
7510b296 456 if (!STRINGP (prompt))
a2665596 457 prompt = empty_unibyte_string;
f927c5ae 458
f927c5ae 459 if (!enable_recursive_minibuffers
be15a518
RS
460 && minibuf_level > 0)
461 {
462 if (EQ (selected_window, minibuf_window))
463 error ("Command attempted to use minibuffer while in minibuffer");
464 else
465 /* If we're in another window, cancel the minibuffer that's active. */
466 Fthrow (Qexit,
467 build_string ("Command attempted to use minibuffer while in minibuffer"));
468 }
f927c5ae 469
a9051c88
DN
470 if ((noninteractive
471 /* In case we are running as a daemon, only do this before
472 detaching from the terminal. */
473 || (IS_DAEMON && (daemon_pipe[1] >= 0)))
474 && NILP (Vexecuting_kbd_macro))
c28b847b 475 {
6b61353c
KH
476 val = read_minibuf_noninteractive (map, initial, prompt,
477 make_number (pos),
c28b847b
GM
478 expflag, histvar, histpos, defalt,
479 allow_props, inherit_input_method);
f9b9ccef 480 UNGCPRO;
c28b847b
GM
481 return unbind_to (count, val);
482 }
edfef199 483
748dc60a 484 /* Choose the minibuffer window and frame, and take action on them. */
f927c5ae 485
c5b6b680
RS
486 choose_minibuf_frame ();
487
0c94f256
RS
488 record_unwind_protect (choose_minibuf_frame_1, Qnil);
489
f927c5ae 490 record_unwind_protect (Fset_window_configuration,
b2b2c677
JB
491 Fcurrent_window_configuration (Qnil));
492
ff11dfa1
JB
493 /* If the minibuffer window is on a different frame, save that
494 frame's configuration too. */
75f00e72 495 mini_frame = WINDOW_FRAME (XWINDOW (minibuf_window));
a4aafc54 496 if (!EQ (mini_frame, selected_frame))
5061d9c3
RS
497 record_unwind_protect (Fset_window_configuration,
498 Fcurrent_window_configuration (mini_frame));
5563e8e8
KH
499
500 /* If the minibuffer is on an iconified or invisible frame,
501 make it visible now. */
502 Fmake_frame_visible (mini_frame);
503
6a9ee000
RS
504 if (minibuffer_auto_raise)
505 Fraise_frame (mini_frame);
f927c5ae 506
b3e6f69c 507 temporarily_switch_to_single_kboard (XFRAME (mini_frame));
256c9c3a 508
748dc60a
RS
509 /* We have to do this after saving the window configuration
510 since that is what restores the current buffer. */
511
512 /* Arrange to restore a number of minibuffer-related variables.
513 We could bind each variable separately, but that would use lots of
514 specpdl slots. */
515 minibuf_save_list
516 = Fcons (Voverriding_local_map,
3372a51b 517 Fcons (minibuf_window,
ef72eaff 518 minibuf_save_list));
748dc60a
RS
519 minibuf_save_list
520 = Fcons (minibuf_prompt,
521 Fcons (make_number (minibuf_prompt_width),
522 Fcons (Vhelp_form,
523 Fcons (Vcurrent_prefix_arg,
524 Fcons (Vminibuffer_history_position,
525 Fcons (Vminibuffer_history_variable,
526 minibuf_save_list))))));
527
528 record_unwind_protect (read_minibuf_unwind, Qnil);
529 minibuf_level++;
7292839d
SM
530 /* We are exiting the minibuffer one way or the other, so run the hook.
531 It should be run before unwinding the minibuf settings. Do it
532 separately from read_minibuf_unwind because we need to make sure that
533 read_minibuf_unwind is fully executed even if exit-minibuffer-hook
534 signals an error. --Stef */
535 record_unwind_protect (run_exit_minibuf_hook, Qnil);
748dc60a
RS
536
537 /* Now that we can restore all those variables, start changing them. */
538
1e3f16d5 539 minibuf_prompt_width = 0;
748dc60a
RS
540 minibuf_prompt = Fcopy_sequence (prompt);
541 Vminibuffer_history_position = histpos;
542 Vminibuffer_history_variable = histvar;
543 Vhelp_form = Vminibuffer_help_form;
ef72eaff
KS
544 /* If this minibuffer is reading a file name, that doesn't mean
545 recursive ones are. But we cannot set it to nil, because
546 completion code still need to know the minibuffer is completing a
547 file name. So use `lambda' as intermediate value meaning
548 "t" in this minibuffer, but "nil" in next minibuffer. */
549 if (!NILP (Vminibuffer_completing_file_name))
550 Vminibuffer_completing_file_name = Qlambda;
748dc60a 551
cee54539 552 if (inherit_input_method)
c75000c7 553 {
fd771ceb 554 /* `current-input-method' is buffer local. So, remember it in
c75000c7
RS
555 INPUT_METHOD before changing the current buffer. */
556 input_method = Fsymbol_value (Qcurrent_input_method);
4b4deea2 557 enable_multibyte = BVAR (current_buffer, enable_multibyte_characters);
c75000c7 558 }
cee54539 559
748dc60a
RS
560 /* Switch to the minibuffer. */
561
4f69d8f6
RS
562 minibuffer = get_minibuffer (minibuf_level);
563 Fset_buffer (minibuffer);
64a3a3c0 564
1d69c502
RS
565 /* If appropriate, copy enable-multibyte-characters into the minibuffer. */
566 if (inherit_input_method)
4b4deea2 567 BVAR (current_buffer, enable_multibyte_characters) = enable_multibyte;
1d69c502 568
64a3a3c0
JB
569 /* The current buffer's default directory is usually the right thing
570 for our minibuffer here. However, if you're typing a command at
571 a minibuffer-only frame when minibuf_level is zero, then buf IS
572 the current_buffer, so reset_buffer leaves buf's default
573 directory unchanged. This is a bummer when you've just started
574 up Emacs and buf's default directory is Qnil. Here's a hack; can
575 you think of something better to do? Find another buffer with a
576 better directory, and use that one instead. */
748dc60a 577 if (STRINGP (ambient_dir))
4b4deea2 578 BVAR (current_buffer, directory) = ambient_dir;
64a3a3c0
JB
579 else
580 {
581 Lisp_Object buf_list;
582
583 for (buf_list = Vbuffer_alist;
584 CONSP (buf_list);
7539e11f 585 buf_list = XCDR (buf_list))
64a3a3c0 586 {
1e62748e 587 Lisp_Object other_buf;
64a3a3c0 588
7539e11f 589 other_buf = XCDR (XCAR (buf_list));
4b4deea2 590 if (STRINGP (BVAR (XBUFFER (other_buf), directory)))
64a3a3c0 591 {
4b4deea2 592 BVAR (current_buffer, directory) = BVAR (XBUFFER (other_buf), directory);
64a3a3c0
JB
593 break;
594 }
595 }
596 }
597
a4aafc54
GM
598 if (!EQ (mini_frame, selected_frame))
599 Fredirect_frame_focus (selected_frame, mini_frame);
43bad991 600
f927c5ae 601 Vminibuf_scroll_window = selected_window;
6122844a 602 if (minibuf_level == 1 || !EQ (minibuf_window, selected_window))
5705966b 603 minibuf_selected_window = selected_window;
b20de1cd
RS
604
605 /* Empty out the minibuffers of all frames other than the one
606 where we are going to display one now.
607 Set them to point to ` *Minibuf-0*', which is always empty. */
620c53a6 608 empty_minibuf = get_minibuffer (0);
b20de1cd
RS
609
610 FOR_EACH_FRAME (dummy, frame)
611 {
612 Lisp_Object root_window = Fframe_root_window (frame);
613 Lisp_Object mini_window = XWINDOW (root_window)->next;
614
dd95745a
RS
615 if (! NILP (mini_window) && ! EQ (mini_window, minibuf_window)
616 && !NILP (Fwindow_minibuffer_p (mini_window)))
b20de1cd
RS
617 Fset_window_buffer (mini_window, empty_minibuf, Qnil);
618 }
619
620 /* Display this minibuffer in the proper window. */
cbbfe056 621 Fset_window_buffer (minibuf_window, Fcurrent_buffer (), Qnil);
f1321dc3 622 Fselect_window (minibuf_window, Qnil);
5a866662 623 XSETFASTINT (XWINDOW (minibuf_window)->hscroll, 0);
f927c5ae 624
748dc60a
RS
625 Fmake_local_variable (Qprint_escape_newlines);
626 print_escape_newlines = 1;
627
628 /* Erase the buffer. */
59115a22 629 {
331379bf 630 int count1 = SPECPDL_INDEX ();
59115a22 631 specbind (Qinhibit_read_only, Qt);
a41edd99 632 specbind (Qinhibit_modification_hooks, Qt);
59115a22 633 Ferase_buffer ();
d9d7b298 634
4b4deea2 635 if (!NILP (BVAR (current_buffer, enable_multibyte_characters))
d9d7b298
SM
636 && ! STRING_MULTIBYTE (minibuf_prompt))
637 minibuf_prompt = Fstring_make_multibyte (minibuf_prompt);
6cc62df0 638
d9d7b298
SM
639 /* Insert the prompt, record where it ends. */
640 Finsert (1, &minibuf_prompt);
641 if (PT > BEG)
642 {
643 Fput_text_property (make_number (BEG), make_number (PT),
644 Qfront_sticky, Qt, Qnil);
645 Fput_text_property (make_number (BEG), make_number (PT),
646 Qrear_nonsticky, Qt, Qnil);
647 Fput_text_property (make_number (BEG), make_number (PT),
648 Qfield, Qt, Qnil);
649 Fadd_text_properties (make_number (BEG), make_number (PT),
650 Vminibuffer_prompt_properties, Qnil);
651 }
59115a22
RS
652 unbind_to (count1, Qnil);
653 }
654
7831777b 655 minibuf_prompt_width = current_column ();
9ab4a725 656
748dc60a 657 /* Put in the initial input. */
56a98455 658 if (!NILP (initial))
f927c5ae
JB
659 {
660 Finsert (1, &initial);
6b61353c 661 Fforward_char (make_number (pos));
f927c5ae
JB
662 }
663
39e98b38 664 clear_message (1, 1);
4b4deea2 665 BVAR (current_buffer, keymap) = map;
f927c5ae 666
cee54539 667 /* Turn on an input method stored in INPUT_METHOD if any. */
6801b300 668 if (STRINGP (input_method) && !NILP (Ffboundp (Qactivate_input_method)))
cee54539
KH
669 call1 (Qactivate_input_method, input_method);
670
dee091a3 671 Frun_hooks (1, &Qminibuffer_setup_hook);
5c781212 672
4e6b7204 673 /* Don't allow the user to undo past this point. */
4b4deea2 674 BVAR (current_buffer, undo_list) = Qnil;
4e6b7204 675
f927c5ae
JB
676 recursive_edit_1 ();
677
678 /* If cursor is on the minibuffer line,
679 show the user we have exited by putting it in column 0. */
279cf52c 680 if (XWINDOW (minibuf_window)->cursor.vpos >= 0
f927c5ae
JB
681 && !noninteractive)
682 {
279cf52c
GM
683 XWINDOW (minibuf_window)->cursor.hpos = 0;
684 XWINDOW (minibuf_window)->cursor.x = 0;
685 XWINDOW (minibuf_window)->must_be_updated_p = 1;
a4aafc54 686 update_frame (XFRAME (selected_frame), 1, 1);
fa971ac3
KL
687 {
688 struct frame *f = XFRAME (XWINDOW (minibuf_window)->frame);
689 struct redisplay_interface *rif = FRAME_RIF (f);
690 if (rif && rif->flush_display)
691 rif->flush_display (f);
692 }
f927c5ae
JB
693 }
694
c3421833 695 /* Make minibuffer contents into a string. */
4f69d8f6 696 Fset_buffer (minibuffer);
be95a9b6 697 if (allow_props)
a346ec72 698 val = Fminibuffer_contents ();
be95a9b6 699 else
a346ec72 700 val = Fminibuffer_contents_no_properties ();
770970cb 701
b278606c 702 /* VAL is the string of minibuffer text. */
7019cca7 703
b278606c
BF
704 last_minibuf_string = val;
705
4f9f637a 706 /* Choose the string to add to the history. */
b35cd215 707 if (SCHARS (val) != 0)
4f9f637a
RS
708 histstring = val;
709 else if (STRINGP (defalt))
710 histstring = defalt;
fb30dfd2
JL
711 else if (CONSP (defalt) && STRINGP (XCAR (defalt)))
712 histstring = XCAR (defalt);
4f9f637a
RS
713 else
714 histstring = Qnil;
715
716 /* Add the value to the appropriate history list, if any. */
179a4ca7
JL
717 if (!NILP (Vhistory_add_new_input)
718 && SYMBOLP (Vminibuffer_history_variable)
4f9f637a 719 && !NILP (histstring))
3ab14176
KH
720 {
721 /* If the caller wanted to save the value read on a history list,
722 then do so if the value is not already the front of the list. */
723 Lisp_Object histval;
c6d65724
RS
724
725 /* If variable is unbound, make it nil. */
c6d65724 726
8c2dccbf
SM
727 histval = find_symbol_value (Vminibuffer_history_variable);
728 if (EQ (histval, Qunbound))
729 Fset (Vminibuffer_history_variable, Qnil);
3ab14176
KH
730
731 /* The value of the history variable must be a cons or nil. Other
732 values are unacceptable. We silently ignore these values. */
4f9f637a 733
3ab14176 734 if (NILP (histval)
9f6131cf 735 || (CONSP (histval)
4f9f637a 736 /* Don't duplicate the most recent entry in the history. */
b35cd215 737 && (NILP (Fequal (histstring, Fcar (histval))))))
77aa8edf
RS
738 {
739 Lisp_Object length;
740
0da4d471 741 if (history_delete_duplicates) Fdelete (histstring, histval);
4f9f637a 742 histval = Fcons (histstring, histval);
77aa8edf
RS
743 Fset (Vminibuffer_history_variable, histval);
744
745 /* Truncate if requested. */
746 length = Fget (Vminibuffer_history_variable, Qhistory_length);
747 if (NILP (length)) length = Vhistory_length;
e5d4686b
RS
748 if (INTEGERP (length))
749 {
750 if (XINT (length) <= 0)
751 Fset (Vminibuffer_history_variable, Qnil);
752 else
753 {
754 Lisp_Object temp;
755
756 temp = Fnthcdr (Fsub1 (length), histval);
757 if (CONSP (temp)) Fsetcdr (temp, Qnil);
758 }
759 }
77aa8edf 760 }
9f6131cf
RS
761 }
762
fd6fa53f 763 /* If Lisp form desired instead of string, parse it. */
9f6131cf 764 if (expflag)
edfef199 765 val = string_to_object (val, defalt);
3ab14176 766
00a34088
RS
767 /* The appropriate frame will get selected
768 in set-window-configuration. */
f9b9ccef
SM
769 UNGCPRO;
770 return unbind_to (count, val);
f927c5ae
JB
771}
772
773/* Return a buffer to be used as the minibuffer at depth `depth'.
774 depth = 0 is the lowest allowed argument, and that is the value
fd6fa53f 775 used for nonrecursive minibuffer invocations. */
f927c5ae
JB
776
777Lisp_Object
971de7fb 778get_minibuffer (int depth)
f927c5ae
JB
779{
780 Lisp_Object tail, num, buf;
9f6c23bc 781 char name[24];
f927c5ae 782
5a866662 783 XSETFASTINT (num, depth);
f927c5ae 784 tail = Fnthcdr (num, Vminibuffer_list);
56a98455 785 if (NILP (tail))
f927c5ae
JB
786 {
787 tail = Fcons (Qnil, Qnil);
788 Vminibuffer_list = nconc2 (Vminibuffer_list, tail);
789 }
790 buf = Fcar (tail);
4b4deea2 791 if (NILP (buf) || NILP (BVAR (XBUFFER (buf), name)))
f927c5ae
JB
792 {
793 sprintf (name, " *Minibuf-%d*", depth);
794 buf = Fget_buffer_create (build_string (name));
5d6533f1
JB
795
796 /* Although the buffer's name starts with a space, undo should be
797 enabled in it. */
798 Fbuffer_enable_undo (buf);
799
f3fbd155 800 XSETCAR (tail, buf);
f927c5ae
JB
801 }
802 else
5956f71d 803 {
aed13378 804 int count = SPECPDL_INDEX ();
7f856567
SM
805 /* `reset_buffer' blindly sets the list of overlays to NULL, so we
806 have to empty the list, otherwise we end up with overlays that
807 think they belong to this buffer while the buffer doesn't know about
808 them any more. */
599ca9c2
SM
809 delete_all_overlays (XBUFFER (buf));
810 reset_buffer (XBUFFER (buf));
6b3faad8
RS
811 record_unwind_protect (Fset_buffer, Fcurrent_buffer ());
812 Fset_buffer (buf);
fd6fa53f
SM
813 if (!NILP (Ffboundp (intern ("minibuffer-inactive-mode"))))
814 call0 (intern ("minibuffer-inactive-mode"));
815 else
816 Fkill_all_local_variables ();
6b3faad8 817 unbind_to (count, Qnil);
5956f71d 818 }
64a3a3c0 819
f927c5ae
JB
820 return buf;
821}
822
7292839d 823static Lisp_Object
971de7fb 824run_exit_minibuf_hook (Lisp_Object data)
7292839d 825{
dee091a3 826 safe_run_hooks (Qminibuffer_exit_hook);
7292839d
SM
827 return Qnil;
828}
829
279cf52c 830/* This function is called on exiting minibuffer, whether normally or
fd6fa53f 831 not, and it restores the current window, buffer, etc. */
f927c5ae 832
9d815fd9 833static Lisp_Object
971de7fb 834read_minibuf_unwind (Lisp_Object data)
f927c5ae 835{
c24e1160 836 Lisp_Object old_deactivate_mark;
59115a22 837 Lisp_Object window;
c24e1160 838
f927c5ae 839 /* If this was a recursive minibuffer,
59115a22 840 tie the minibuffer window back to the outer level minibuffer buffer. */
f927c5ae 841 minibuf_level--;
f927c5ae 842
59115a22 843 window = minibuf_window;
279cf52c
GM
844 /* To keep things predictable, in case it matters, let's be in the
845 minibuffer when we reset the relevant variables. */
59115a22
RS
846 Fset_buffer (XWINDOW (window)->buffer);
847
848 /* Restore prompt, etc, from outer minibuffer level. */
4d04c1f1
KH
849 minibuf_prompt = Fcar (minibuf_save_list);
850 minibuf_save_list = Fcdr (minibuf_save_list);
851 minibuf_prompt_width = XFASTINT (Fcar (minibuf_save_list));
852 minibuf_save_list = Fcdr (minibuf_save_list);
853 Vhelp_form = Fcar (minibuf_save_list);
854 minibuf_save_list = Fcdr (minibuf_save_list);
ee9e37ab 855 Vcurrent_prefix_arg = Fcar (minibuf_save_list);
4d04c1f1
KH
856 minibuf_save_list = Fcdr (minibuf_save_list);
857 Vminibuffer_history_position = Fcar (minibuf_save_list);
858 minibuf_save_list = Fcdr (minibuf_save_list);
859 Vminibuffer_history_variable = Fcar (minibuf_save_list);
860 minibuf_save_list = Fcdr (minibuf_save_list);
30e13e56 861 Voverriding_local_map = Fcar (minibuf_save_list);
c5b6b680 862 minibuf_save_list = Fcdr (minibuf_save_list);
914860c2
RS
863#if 0
864 temp = Fcar (minibuf_save_list);
865 if (FRAME_LIVE_P (XFRAME (WINDOW_FRAME (XWINDOW (temp)))))
866 minibuf_window = temp;
867#endif
30e13e56 868 minibuf_save_list = Fcdr (minibuf_save_list);
59115a22
RS
869
870 /* Erase the minibuffer we were using at this level. */
871 {
aed13378 872 int count = SPECPDL_INDEX ();
59115a22
RS
873 /* Prevent error in erase-buffer. */
874 specbind (Qinhibit_read_only, Qt);
bd819d14 875 specbind (Qinhibit_modification_hooks, Qt);
59115a22
RS
876 old_deactivate_mark = Vdeactivate_mark;
877 Ferase_buffer ();
878 Vdeactivate_mark = old_deactivate_mark;
879 unbind_to (count, Qnil);
880 }
881
544e358d
GM
882 /* When we get to the outmost level, make sure we resize the
883 mini-window back to its normal size. */
884 if (minibuf_level == 0)
1e3f16d5 885 resize_mini_window (XWINDOW (window), 0);
544e358d 886
59115a22
RS
887 /* Make sure minibuffer window is erased, not ignored. */
888 windows_or_buffers_changed++;
889 XSETFASTINT (XWINDOW (window)->last_modified, 0);
193e4518 890 XSETFASTINT (XWINDOW (window)->last_overlay_modified, 0);
fd6fa53f
SM
891
892 /* In case the previous minibuffer displayed in this miniwindow is
893 dead, we may keep displaying this buffer (tho it's inactive), so reset it,
894 to make sure we don't leave around bindings and stuff which only
895 made sense during the read_minibuf invocation. */
896 call0 (intern ("minibuffer-inactive-mode"));
9d815fd9 897 return Qnil;
f927c5ae
JB
898}
899\f
b9d721de 900
a7ca3326 901DEFUN ("read-from-minibuffer", Fread_from_minibuffer,
16a97296 902 Sread_from_minibuffer, 1, 7, 0,
af52c32d 903 doc: /* Read a string from the minibuffer, prompting with string PROMPT.
6b61353c
KH
904The optional second arg INITIAL-CONTENTS is an obsolete alternative to
905 DEFAULT-VALUE. It normally should be nil in new code, except when
906 HIST is a cons. It is discussed in more detail below.
a1f17501
PJ
907Third arg KEYMAP is a keymap to use whilst reading;
908 if omitted or nil, the default is `minibuffer-local-map'.
fd771ceb 909If fourth arg READ is non-nil, then interpret the result as a Lisp object
a1f17501
PJ
910 and return that object:
911 in other words, do `(car (read-from-string INPUT-STRING))'
6b61353c
KH
912Fifth arg HIST, if non-nil, specifies a history list and optionally
913 the initial position in the list. It can be a symbol, which is the
914 history list variable to use, or it can be a cons cell
915 (HISTVAR . HISTPOS). In that case, HISTVAR is the history list variable
916 to use, and HISTPOS is the initial position for use by the minibuffer
917 history commands. For consistency, you should also specify that
918 element of the history as the value of INITIAL-CONTENTS. Positions
919 are counted starting from 1 at the beginning of the list.
2e3148e2
JL
920Sixth arg DEFAULT-VALUE is the default value or the list of default values.
921 If non-nil, it is available for history commands, and as the value
922 (or the first element of the list of default values) to return
923 if the user enters the empty string. But, unless READ is non-nil,
924 `read-from-minibuffer' does NOT return DEFAULT-VALUE if the user enters
925 empty input! It returns the empty string.
a1f17501 926Seventh arg INHERIT-INPUT-METHOD, if non-nil, means the minibuffer inherits
029a305c 927 the current input method and the setting of `enable-multibyte-characters'.
a1f17501
PJ
928If the variable `minibuffer-allow-text-properties' is non-nil,
929 then the string which is returned includes whatever text properties
6b61353c
KH
930 were present in the minibuffer. Otherwise the value has no text properties.
931
932The remainder of this documentation string describes the
933INITIAL-CONTENTS argument in more detail. It is only relevant when
934studying existing code, or when HIST is a cons. If non-nil,
935INITIAL-CONTENTS is a string to be inserted into the minibuffer before
936reading input. Normally, point is put at the end of that string.
937However, if INITIAL-CONTENTS is \(STRING . POSITION), the initial
938input is STRING, but point is placed at _one-indexed_ position
939POSITION in the minibuffer. Any integer value less than or equal to
940one puts point at the beginning of the string. *Note* that this
941behavior differs from the way such arguments are used in `completing-read'
942and some related functions, which use zero-indexing for POSITION. */)
5842a27b 943 (Lisp_Object prompt, Lisp_Object initial_contents, Lisp_Object keymap, Lisp_Object read, Lisp_Object hist, Lisp_Object default_value, Lisp_Object inherit_input_method)
f927c5ae 944{
6b61353c 945 Lisp_Object histvar, histpos, val;
1d8d92f4
RS
946 struct gcpro gcpro1;
947
b7826503 948 CHECK_STRING (prompt);
56a98455 949 if (NILP (keymap))
f927c5ae
JB
950 keymap = Vminibuffer_local_map;
951 else
02067692 952 keymap = get_keymap (keymap, 1, 0);
770970cb 953
7510b296 954 if (SYMBOLP (hist))
770970cb
RS
955 {
956 histvar = hist;
957 histpos = Qnil;
958 }
959 else
960 {
961 histvar = Fcar_safe (hist);
962 histpos = Fcdr_safe (hist);
963 }
964 if (NILP (histvar))
965 histvar = Qminibuffer_history;
966 if (NILP (histpos))
5a866662 967 XSETFASTINT (histpos, 0);
770970cb 968
1d8d92f4 969 GCPRO1 (default_value);
e5d4686b 970 val = read_minibuf (keymap, initial_contents, prompt,
6b61353c 971 Qnil, !NILP (read),
c3421833 972 histvar, histpos, default_value,
cee54539 973 minibuffer_allow_text_properties,
b35cd215 974 !NILP (inherit_input_method));
1d8d92f4 975 UNGCPRO;
e5d4686b 976 return val;
f927c5ae
JB
977}
978
a7ca3326 979DEFUN ("read-minibuffer", Fread_minibuffer, Sread_minibuffer, 1, 2, 0,
6b61353c 980 doc: /* Return a Lisp object read using the minibuffer, unevaluated.
a1f17501 981Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS
6b61353c 982is a string to insert in the minibuffer before reading.
e298936f
JB
983\(INITIAL-CONTENTS can also be a cons of a string and an integer.
984Such arguments are used as in `read-from-minibuffer'.) */)
5842a27b 985 (Lisp_Object prompt, Lisp_Object initial_contents)
f927c5ae 986{
b7826503 987 CHECK_STRING (prompt);
770970cb 988 return read_minibuf (Vminibuffer_local_map, initial_contents,
e5d4686b 989 prompt, Qnil, 1, Qminibuffer_history,
b35cd215 990 make_number (0), Qnil, 0, 0);
f927c5ae
JB
991}
992
a7ca3326 993DEFUN ("eval-minibuffer", Feval_minibuffer, Seval_minibuffer, 1, 2, 0,
af52c32d 994 doc: /* Return value of Lisp expression read using the minibuffer.
a1f17501 995Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS
6b61353c 996is a string to insert in the minibuffer before reading.
e298936f
JB
997\(INITIAL-CONTENTS can also be a cons of a string and an integer.
998Such arguments are used as in `read-from-minibuffer'.) */)
5842a27b 999 (Lisp_Object prompt, Lisp_Object initial_contents)
f927c5ae 1000{
627fb581
RS
1001 return Feval (read_minibuf (Vread_expression_map, initial_contents,
1002 prompt, Qnil, 1, Qread_expression_history,
a0ee6f27
SM
1003 make_number (0), Qnil, 0, 0),
1004 Qnil);
f927c5ae
JB
1005}
1006
fd6fa53f 1007/* Functions that use the minibuffer to read various things. */
f927c5ae 1008
a7ca3326 1009DEFUN ("read-string", Fread_string, Sread_string, 1, 5, 0,
af52c32d 1010 doc: /* Read a string from the minibuffer, prompting with string PROMPT.
a1f17501 1011If non-nil, second arg INITIAL-INPUT is a string to insert before reading.
6b61353c
KH
1012 This argument has been superseded by DEFAULT-VALUE and should normally
1013 be nil in new code. It behaves as in `read-from-minibuffer'. See the
1014 documentation string of that function for details.
a1f17501
PJ
1015The third arg HISTORY, if non-nil, specifies a history list
1016 and optionally the initial position in the list.
1017See `read-from-minibuffer' for details of HISTORY argument.
2e3148e2
JL
1018Fourth arg DEFAULT-VALUE is the default value or the list of default values.
1019 If non-nil, it is used for history commands, and as the value (or the first
1020 element of the list of default values) to return if the user enters the
1021 empty string.
a1f17501 1022Fifth arg INHERIT-INPUT-METHOD, if non-nil, means the minibuffer inherits
029a305c 1023 the current input method and the setting of `enable-multibyte-characters'. */)
5842a27b 1024 (Lisp_Object prompt, Lisp_Object initial_input, Lisp_Object history, Lisp_Object default_value, Lisp_Object inherit_input_method)
f927c5ae 1025{
b9a86585
RS
1026 Lisp_Object val;
1027 val = Fread_from_minibuffer (prompt, initial_input, Qnil,
1028 Qnil, history, default_value,
b35cd215 1029 inherit_input_method);
d5db4077 1030 if (STRINGP (val) && SCHARS (val) == 0 && ! NILP (default_value))
fb30dfd2 1031 val = CONSP (default_value) ? XCAR (default_value) : default_value;
b9a86585 1032 return val;
f927c5ae
JB
1033}
1034
cee54539 1035DEFUN ("read-no-blanks-input", Fread_no_blanks_input, Sread_no_blanks_input, 1, 3, 0,
af52c32d 1036 doc: /* Read a string from the terminal, not allowing blanks.
6b61353c
KH
1037Prompt with PROMPT. Whitespace terminates the input. If INITIAL is
1038non-nil, it should be a string, which is used as initial input, with
1039point positioned at the end, so that SPACE will accept the input.
1040\(Actually, INITIAL can also be a cons of a string and an integer.
1041Such values are treated as in `read-from-minibuffer', but are normally
1042not useful in this function.)
a1f17501 1043Third arg INHERIT-INPUT-METHOD, if non-nil, means the minibuffer inherits
6b61353c 1044the current input method and the setting of`enable-multibyte-characters'. */)
5842a27b 1045 (Lisp_Object prompt, Lisp_Object initial, Lisp_Object inherit_input_method)
f927c5ae 1046{
b7826503 1047 CHECK_STRING (prompt);
c923ccc9 1048 return read_minibuf (Vminibuffer_local_ns_map, initial, prompt, Qnil,
cee54539 1049 0, Qminibuffer_history, make_number (0), Qnil, 0,
b35cd215 1050 !NILP (inherit_input_method));
f927c5ae
JB
1051}
1052
e5d4686b 1053DEFUN ("read-command", Fread_command, Sread_command, 1, 2, 0,
af52c32d 1054 doc: /* Read the name of a command and return as a symbol.
2e3148e2
JL
1055Prompt with PROMPT. By default, return DEFAULT-VALUE or its first element
1056if it is a list. */)
5842a27b 1057 (Lisp_Object prompt, Lisp_Object default_value)
f927c5ae 1058{
7c8d9931
RS
1059 Lisp_Object name, default_string;
1060
1061 if (NILP (default_value))
1062 default_string = Qnil;
1063 else if (SYMBOLP (default_value))
caa4733e 1064 default_string = SYMBOL_NAME (default_value);
7c8d9931
RS
1065 else
1066 default_string = default_value;
9ab4a725 1067
7c8d9931
RS
1068 name = Fcompleting_read (prompt, Vobarray, Qcommandp, Qt,
1069 Qnil, Qnil, default_string, Qnil);
1070 if (NILP (name))
1071 return name;
1072 return Fintern (name, Qnil);
f927c5ae
JB
1073}
1074
1075#ifdef NOTDEF
1076DEFUN ("read-function", Fread_function, Sread_function, 1, 1, 0,
af52c32d 1077 doc: /* One arg PROMPT, a string. Read the name of a function and return as a symbol.
fd771ceb 1078Prompt with PROMPT. */)
5842a27b 1079 (Lisp_Object prompt)
f927c5ae 1080{
cee54539 1081 return Fintern (Fcompleting_read (prompt, Vobarray, Qfboundp, Qt, Qnil, Qnil, Qnil, Qnil),
f927c5ae
JB
1082 Qnil);
1083}
1084#endif /* NOTDEF */
1085
a7ca3326 1086DEFUN ("read-variable", Fread_variable, Sread_variable, 1, 2, 0,
af52c32d 1087 doc: /* Read the name of a user variable and return it as a symbol.
2e3148e2
JL
1088Prompt with PROMPT. By default, return DEFAULT-VALUE or its first element
1089if it is a list.
316f9bfc 1090A user variable is one for which `user-variable-p' returns non-nil. */)
5842a27b 1091 (Lisp_Object prompt, Lisp_Object default_value)
f927c5ae 1092{
7c8d9931
RS
1093 Lisp_Object name, default_string;
1094
1095 if (NILP (default_value))
1096 default_string = Qnil;
1097 else if (SYMBOLP (default_value))
caa4733e 1098 default_string = SYMBOL_NAME (default_value);
7c8d9931
RS
1099 else
1100 default_string = default_value;
9ab4a725 1101
7c8d9931
RS
1102 name = Fcompleting_read (prompt, Vobarray,
1103 Quser_variable_p, Qt,
1104 Qnil, Qnil, default_string, Qnil);
1105 if (NILP (name))
1106 return name;
1107 return Fintern (name, Qnil);
f927c5ae
JB
1108}
1109
a7ca3326 1110DEFUN ("read-buffer", Fread_buffer, Sread_buffer, 1, 3, 0,
fd771ceb
PJ
1111 doc: /* Read the name of a buffer and return as a string.
1112Prompt with PROMPT.
a1f17501 1113Optional second arg DEF is value to return if user enters an empty line.
2e3148e2 1114 If DEF is a list of default values, return its first element.
5fedada7
CY
1115Optional third arg REQUIRE-MATCH determines whether non-existing
1116 buffer names are allowed. It has the same meaning as the
a2a0d36b 1117 REQUIRE-MATCH argument of `completing-read'.
33df281c
CY
1118The argument PROMPT should be a string ending with a colon and a space.
1119If `read-buffer-completion-ignore-case' is non-nil, completion ignores
1120case while reading the buffer name.
1121If `read-buffer-function' is non-nil, this works by calling it as a
1122function, instead of the usual behavior. */)
5842a27b 1123 (Lisp_Object prompt, Lisp_Object def, Lisp_Object require_match)
f927c5ae 1124{
33df281c 1125 Lisp_Object args[4], result;
637de37e 1126 char *s;
ad39faca 1127 ptrdiff_t len;
33df281c 1128 int count = SPECPDL_INDEX ();
9ab4a725 1129
7510b296 1130 if (BUFFERP (def))
4b4deea2 1131 def = BVAR (XBUFFER (def), name);
eebbfb01 1132
33df281c
CY
1133 specbind (Qcompletion_ignore_case,
1134 read_buffer_completion_ignore_case ? Qt : Qnil);
1135
eebbfb01
KH
1136 if (NILP (Vread_buffer_function))
1137 {
1138 if (!NILP (def))
1139 {
97c3e4cc
RF
1140 /* A default value was provided: we must change PROMPT,
1141 editing the default value in before the colon. To achieve
1142 this, we replace PROMPT with a substring that doesn't
1143 contain the terminal space and colon (if present). They
1144 are then added back using Fformat. */
1145
1146 if (STRINGP (prompt))
1147 {
637de37e 1148 s = SSDATA (prompt);
ad39faca 1149 len = SBYTES (prompt);
97c3e4cc
RF
1150 if (len >= 2 && s[len - 2] == ':' && s[len - 1] == ' ')
1151 len = len - 2;
1152 else if (len >= 1 && (s[len - 1] == ':' || s[len - 1] == ' '))
1153 len--;
1154
1155 prompt = make_specified_string (s, -1, len,
1156 STRING_MULTIBYTE (prompt));
1157 }
1158
1159 args[0] = build_string ("%s (default %s): ");
eebbfb01 1160 args[1] = prompt;
fb30dfd2 1161 args[2] = CONSP (def) ? XCAR (def) : def;
eebbfb01
KH
1162 prompt = Fformat (3, args);
1163 }
1164
33df281c 1165 result = Fcompleting_read (prompt, intern ("internal-complete-buffer"),
620c53a6
SM
1166 Qnil, require_match, Qnil,
1167 Qbuffer_name_history, def, Qnil);
eebbfb01
KH
1168 }
1169 else
f927c5ae 1170 {
eebbfb01 1171 args[0] = Vread_buffer_function;
f927c5ae
JB
1172 args[1] = prompt;
1173 args[2] = def;
eebbfb01 1174 args[3] = require_match;
fd6fa53f 1175 result = Ffuncall (4, args);
f927c5ae 1176 }
33df281c 1177 return unbind_to (count, result);
f927c5ae
JB
1178}
1179\f
ec067ec7 1180static Lisp_Object
971de7fb 1181minibuf_conform_representation (Lisp_Object string, Lisp_Object basis)
ec067ec7
RS
1182{
1183 if (STRING_MULTIBYTE (string) == STRING_MULTIBYTE (basis))
1184 return string;
1185
1186 if (STRING_MULTIBYTE (string))
1187 return Fstring_make_unibyte (string);
1188 else
1189 return Fstring_make_multibyte (string);
1190}
1191
f927c5ae 1192DEFUN ("try-completion", Ftry_completion, Stry_completion, 2, 3, 0,
a284cdbb
RS
1193 doc: /* Return common substring of all completions of STRING in COLLECTION.
1194Test each possible completion specified by COLLECTION
1195to see if it begins with STRING. The possible completions may be
3809648a
KS
1196strings or symbols. Symbols are converted to strings before testing,
1197see `symbol-name'.
a284cdbb
RS
1198All that match STRING are compared together; the longest initial sequence
1199common to all these matches is the return value.
1200If there is no match at all, the return value is nil.
1201For a unique match which is exact, the return value is t.
1202
1203If COLLECTION is an alist, the keys (cars of elements) are the
1204possible completions. If an element is not a cons cell, then the
1205element itself is the possible completion.
1206If COLLECTION is a hash-table, all the keys that are strings or symbols
1207are the possible completions.
1208If COLLECTION is an obarray, the names of all symbols in the obarray
1209are the possible completions.
1210
1211COLLECTION can also be a function to do the completion itself.
a1f17501
PJ
1212It receives three arguments: the values STRING, PREDICATE and nil.
1213Whatever it returns becomes the value of `try-completion'.
1214
1215If optional third argument PREDICATE is non-nil,
1216it is used to test each possible match.
1217The match is a candidate only if PREDICATE returns non-nil.
1218The argument given to PREDICATE is the alist element
a284cdbb 1219or the symbol from the obarray. If COLLECTION is a hash-table,
85cd4372 1220predicate is called with two arguments: the key and the value.
a1f17501 1221Additionally to this predicate, `completion-regexp-list'
af52c32d 1222is used to further constrain the set of candidates. */)
5842a27b 1223 (Lisp_Object string, Lisp_Object collection, Lisp_Object predicate)
f927c5ae
JB
1224{
1225 Lisp_Object bestmatch, tail, elt, eltstring;
af2b7cd5 1226 /* Size in bytes of BESTMATCH. */
6bbd7a29 1227 int bestmatchsize = 0;
af2b7cd5 1228 /* These are in bytes, too. */
f927c5ae 1229 int compare, matchsize;
f6d4c7a4
RS
1230 enum { function_table, list_table, obarray_table, hash_table}
1231 type = (HASH_TABLE_P (collection) ? hash_table
1232 : VECTORP (collection) ? obarray_table
1233 : ((NILP (collection)
1234 || (CONSP (collection)
1235 && (!SYMBOLP (XCAR (collection))
1236 || NILP (XCAR (collection)))))
1237 ? list_table : function_table));
0de4bb68 1238 EMACS_INT idx = 0, obsize = 0;
f927c5ae 1239 int matchcount = 0;
acd81db9 1240 int bindcount = -1;
f927c5ae
JB
1241 Lisp_Object bucket, zero, end, tem;
1242 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
1243
b7826503 1244 CHECK_STRING (string);
f6d4c7a4 1245 if (type == function_table)
a284cdbb 1246 return call3 (collection, string, predicate, Qnil);
f927c5ae 1247
6bbd7a29 1248 bestmatch = bucket = Qnil;
c8ae863b 1249 zero = make_number (0);
f927c5ae 1250
a284cdbb
RS
1251 /* If COLLECTION is not a list, set TAIL just for gc pro. */
1252 tail = collection;
f6d4c7a4 1253 if (type == obarray_table)
f927c5ae 1254 {
a284cdbb 1255 collection = check_obarray (collection);
77b37c05 1256 obsize = ASIZE (collection);
62137a95 1257 bucket = XVECTOR (collection)->contents[idx];
f927c5ae
JB
1258 }
1259
1260 while (1)
1261 {
fd6fa53f
SM
1262 /* Get the next element of the alist, obarray, or hash-table. */
1263 /* Exit the loop if the elements are all used up. */
f927c5ae 1264 /* elt gets the alist element or symbol.
fd6fa53f 1265 eltstring gets the name to check as a completion. */
f927c5ae 1266
f6d4c7a4 1267 if (type == list_table)
f927c5ae 1268 {
695deb18 1269 if (!CONSP (tail))
f927c5ae 1270 break;
695deb18
SM
1271 elt = XCAR (tail);
1272 eltstring = CONSP (elt) ? XCAR (elt) : elt;
1273 tail = XCDR (tail);
f927c5ae 1274 }
f6d4c7a4 1275 else if (type == obarray_table)
f927c5ae 1276 {
c8ae863b 1277 if (!EQ (bucket, zero))
f927c5ae 1278 {
9b6b374a
JB
1279 if (!SYMBOLP (bucket))
1280 error ("Bad data in guts of obarray");
f927c5ae 1281 elt = bucket;
3809648a 1282 eltstring = elt;
f927c5ae
JB
1283 if (XSYMBOL (bucket)->next)
1284 XSETSYMBOL (bucket, XSYMBOL (bucket)->next);
1285 else
5a866662 1286 XSETFASTINT (bucket, 0);
f927c5ae 1287 }
62137a95 1288 else if (++idx >= obsize)
f927c5ae
JB
1289 break;
1290 else
1291 {
62137a95 1292 bucket = XVECTOR (collection)->contents[idx];
f927c5ae
JB
1293 continue;
1294 }
1295 }
f6d4c7a4 1296 else /* if (type == hash_table) */
85cd4372 1297 {
62137a95
PE
1298 while (idx < HASH_TABLE_SIZE (XHASH_TABLE (collection))
1299 && NILP (HASH_HASH (XHASH_TABLE (collection), idx)))
1300 idx++;
1301 if (idx >= HASH_TABLE_SIZE (XHASH_TABLE (collection)))
85cd4372
SM
1302 break;
1303 else
62137a95 1304 elt = eltstring = HASH_KEY (XHASH_TABLE (collection), idx++);
85cd4372 1305 }
f927c5ae 1306
fd6fa53f 1307 /* Is this element a possible completion? */
f927c5ae 1308
3809648a
KS
1309 if (SYMBOLP (eltstring))
1310 eltstring = Fsymbol_name (eltstring);
1311
7510b296 1312 if (STRINGP (eltstring)
d5db4077 1313 && SCHARS (string) <= SCHARS (eltstring)
c8ae863b 1314 && (tem = Fcompare_strings (eltstring, zero,
d5db4077 1315 make_number (SCHARS (string)),
c8ae863b 1316 string, zero, Qnil,
6b61353c 1317 completion_ignore_case ? Qt : Qnil),
69f4ef20 1318 EQ (Qt, tem)))
f927c5ae 1319 {
fd6fa53f 1320 /* Yes. */
42006772 1321 Lisp_Object regexps;
42006772
RS
1322
1323 /* Ignore this element if it fails to match all the regexps. */
6b61353c 1324 {
6b61353c
KH
1325 for (regexps = Vcompletion_regexp_list; CONSP (regexps);
1326 regexps = XCDR (regexps))
1327 {
acd81db9
DK
1328 if (bindcount < 0) {
1329 bindcount = SPECPDL_INDEX ();
1330 specbind (Qcase_fold_search,
1331 completion_ignore_case ? Qt : Qnil);
77443789 1332 }
6b61353c
KH
1333 tem = Fstring_match (XCAR (regexps), eltstring, zero);
1334 if (NILP (tem))
1335 break;
1336 }
6b61353c
KH
1337 if (CONSP (regexps))
1338 continue;
1339 }
42006772 1340
f927c5ae 1341 /* Ignore this element if there is a predicate
fd6fa53f 1342 and the predicate doesn't like it. */
f927c5ae 1343
7efd36fc 1344 if (!NILP (predicate))
f927c5ae 1345 {
7efd36fc 1346 if (EQ (predicate, Qcommandp))
c837f4f9 1347 tem = Fcommandp (elt, Qnil);
f927c5ae
JB
1348 else
1349 {
f6d4c7a4
RS
1350 if (bindcount >= 0)
1351 {
1352 unbind_to (bindcount, Qnil);
1353 bindcount = -1;
1354 }
f927c5ae 1355 GCPRO4 (tail, string, eltstring, bestmatch);
f6d4c7a4
RS
1356 tem = (type == hash_table
1357 ? call2 (predicate, elt,
1358 HASH_VALUE (XHASH_TABLE (collection),
62137a95 1359 idx - 1))
f6d4c7a4 1360 : call1 (predicate, elt));
f927c5ae
JB
1361 UNGCPRO;
1362 }
56a98455 1363 if (NILP (tem)) continue;
f927c5ae
JB
1364 }
1365
1366 /* Update computation of how much all possible completions match */
1367
56a98455 1368 if (NILP (bestmatch))
af2b7cd5 1369 {
85cd4372 1370 matchcount = 1;
af2b7cd5 1371 bestmatch = eltstring;
d5db4077 1372 bestmatchsize = SCHARS (eltstring);
af2b7cd5 1373 }
f927c5ae
JB
1374 else
1375 {
d5db4077 1376 compare = min (bestmatchsize, SCHARS (eltstring));
c8ae863b 1377 tem = Fcompare_strings (bestmatch, zero,
69f4ef20 1378 make_number (compare),
c8ae863b 1379 eltstring, zero,
69f4ef20
RS
1380 make_number (compare),
1381 completion_ignore_case ? Qt : Qnil);
1382 if (EQ (tem, Qt))
1383 matchsize = compare;
1384 else if (XINT (tem) < 0)
1385 matchsize = - XINT (tem) - 1;
1386 else
1387 matchsize = XINT (tem) - 1;
1388
52b14ac0
JB
1389 if (completion_ignore_case)
1390 {
1391 /* If this is an exact match except for case,
1392 use it as the best match rather than one that is not an
1393 exact match. This way, we get the case pattern
1394 of the actual match. */
d5db4077
KR
1395 if ((matchsize == SCHARS (eltstring)
1396 && matchsize < SCHARS (bestmatch))
52b14ac0
JB
1397 ||
1398 /* If there is more than one exact match ignoring case,
1399 and one of them is exact including case,
1400 prefer that one. */
1401 /* If there is no exact match ignoring case,
1402 prefer a match that does not change the case
1403 of the input. */
d5db4077 1404 ((matchsize == SCHARS (eltstring))
52b14ac0 1405 ==
d5db4077 1406 (matchsize == SCHARS (bestmatch))
c8ae863b 1407 && (tem = Fcompare_strings (eltstring, zero,
d5db4077 1408 make_number (SCHARS (string)),
c8ae863b 1409 string, zero,
69f4ef20
RS
1410 Qnil,
1411 Qnil),
1412 EQ (Qt, tem))
c8ae863b 1413 && (tem = Fcompare_strings (bestmatch, zero,
d5db4077 1414 make_number (SCHARS (string)),
c8ae863b 1415 string, zero,
69f4ef20
RS
1416 Qnil,
1417 Qnil),
1418 ! EQ (Qt, tem))))
52b14ac0
JB
1419 bestmatch = eltstring;
1420 }
d5db4077 1421 if (bestmatchsize != SCHARS (eltstring)
85cd4372
SM
1422 || bestmatchsize != matchsize)
1423 /* Don't count the same string multiple times. */
1424 matchcount++;
52b14ac0 1425 bestmatchsize = matchsize;
d5db4077 1426 if (matchsize <= SCHARS (string)
78893e05
CY
1427 /* If completion-ignore-case is non-nil, don't
1428 short-circuit because we want to find the best
1429 possible match *including* case differences. */
1430 && !completion_ignore_case
695deb18
SM
1431 && matchcount > 1)
1432 /* No need to look any further. */
1433 break;
f927c5ae
JB
1434 }
1435 }
1436 }
1437
acd81db9
DK
1438 if (bindcount >= 0) {
1439 unbind_to (bindcount, Qnil);
1440 bindcount = -1;
1441 }
1442
56a98455 1443 if (NILP (bestmatch))
fd6fa53f 1444 return Qnil; /* No completions found. */
52b14ac0
JB
1445 /* If we are ignoring case, and there is no exact match,
1446 and no additional text was supplied,
1447 don't change the case of what the user typed. */
d5db4077
KR
1448 if (completion_ignore_case && bestmatchsize == SCHARS (string)
1449 && SCHARS (bestmatch) > bestmatchsize)
ec067ec7 1450 return minibuf_conform_representation (string, bestmatch);
52b14ac0
JB
1451
1452 /* Return t if the supplied string is an exact match (counting case);
1453 it does not require any change to be made. */
928b5acc 1454 if (matchcount == 1 && !NILP (Fequal (bestmatch, string)))
f927c5ae
JB
1455 return Qt;
1456
5a866662 1457 XSETFASTINT (zero, 0); /* Else extract the part in which */
fd6fa53f 1458 XSETFASTINT (end, bestmatchsize); /* all completions agree. */
f927c5ae
JB
1459 return Fsubstring (bestmatch, zero, end);
1460}
f927c5ae 1461\f
89a255dc 1462DEFUN ("all-completions", Fall_completions, Sall_completions, 2, 4, 0,
a284cdbb
RS
1463 doc: /* Search for partial matches to STRING in COLLECTION.
1464Test each of the possible completions specified by COLLECTION
1465to see if it begins with STRING. The possible completions may be
3809648a
KS
1466strings or symbols. Symbols are converted to strings before testing,
1467see `symbol-name'.
a284cdbb 1468The value is a list of all the possible completions that match STRING.
a1f17501 1469
a284cdbb
RS
1470If COLLECTION is an alist, the keys (cars of elements) are the
1471possible completions. If an element is not a cons cell, then the
1472element itself is the possible completion.
1473If COLLECTION is a hash-table, all the keys that are strings or symbols
1474are the possible completions.
1475If COLLECTION is an obarray, the names of all symbols in the obarray
1476are the possible completions.
a1f17501 1477
a284cdbb 1478COLLECTION can also be a function to do the completion itself.
a1f17501
PJ
1479It receives three arguments: the values STRING, PREDICATE and t.
1480Whatever it returns becomes the value of `all-completions'.
1481
1482If optional third argument PREDICATE is non-nil,
1483it is used to test each possible match.
1484The match is a candidate only if PREDICATE returns non-nil.
1485The argument given to PREDICATE is the alist element
a284cdbb 1486or the symbol from the obarray. If COLLECTION is a hash-table,
85cd4372 1487predicate is called with two arguments: the key and the value.
a1f17501
PJ
1488Additionally to this predicate, `completion-regexp-list'
1489is used to further constrain the set of candidates.
1490
782a943e 1491An obsolete optional fourth argument HIDE-SPACES is still accepted for
057bce6f 1492backward compatibility. If non-nil, strings in COLLECTION that start
4fcc3d32 1493with a space are ignored unless STRING itself starts with a space. */)
5842a27b 1494 (Lisp_Object string, Lisp_Object collection, Lisp_Object predicate, Lisp_Object hide_spaces)
f927c5ae
JB
1495{
1496 Lisp_Object tail, elt, eltstring;
1497 Lisp_Object allmatches;
a284cdbb
RS
1498 int type = HASH_TABLE_P (collection) ? 3
1499 : VECTORP (collection) ? 2
1500 : NILP (collection) || (CONSP (collection)
1501 && (!SYMBOLP (XCAR (collection))
1502 || NILP (XCAR (collection))));
0de4bb68 1503 EMACS_INT idx = 0, obsize = 0;
acd81db9 1504 int bindcount = -1;
c8ae863b 1505 Lisp_Object bucket, tem, zero;
f927c5ae
JB
1506 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
1507
b7826503 1508 CHECK_STRING (string);
85cd4372 1509 if (type == 0)
a284cdbb 1510 return call3 (collection, string, predicate, Qt);
6bbd7a29 1511 allmatches = bucket = Qnil;
c8ae863b 1512 zero = make_number (0);
f927c5ae 1513
a284cdbb
RS
1514 /* If COLLECTION is not a list, set TAIL just for gc pro. */
1515 tail = collection;
85cd4372 1516 if (type == 2)
f927c5ae 1517 {
373bf2b7 1518 collection = check_obarray (collection);
77b37c05 1519 obsize = ASIZE (collection);
62137a95 1520 bucket = XVECTOR (collection)->contents[idx];
f927c5ae
JB
1521 }
1522
1523 while (1)
1524 {
fd6fa53f
SM
1525 /* Get the next element of the alist, obarray, or hash-table. */
1526 /* Exit the loop if the elements are all used up. */
f927c5ae 1527 /* elt gets the alist element or symbol.
fd6fa53f 1528 eltstring gets the name to check as a completion. */
f927c5ae 1529
85cd4372 1530 if (type == 1)
f927c5ae 1531 {
695deb18 1532 if (!CONSP (tail))
f927c5ae 1533 break;
695deb18
SM
1534 elt = XCAR (tail);
1535 eltstring = CONSP (elt) ? XCAR (elt) : elt;
1536 tail = XCDR (tail);
f927c5ae 1537 }
85cd4372 1538 else if (type == 2)
f927c5ae 1539 {
373bf2b7 1540 if (!EQ (bucket, zero))
f927c5ae 1541 {
373bf2b7
AS
1542 if (!SYMBOLP (bucket))
1543 error ("Bad data in guts of obarray");
f927c5ae 1544 elt = bucket;
3809648a 1545 eltstring = elt;
f927c5ae
JB
1546 if (XSYMBOL (bucket)->next)
1547 XSETSYMBOL (bucket, XSYMBOL (bucket)->next);
1548 else
5a866662 1549 XSETFASTINT (bucket, 0);
f927c5ae 1550 }
62137a95 1551 else if (++idx >= obsize)
f927c5ae
JB
1552 break;
1553 else
1554 {
62137a95 1555 bucket = XVECTOR (collection)->contents[idx];
f927c5ae
JB
1556 continue;
1557 }
1558 }
85cd4372
SM
1559 else /* if (type == 3) */
1560 {
62137a95
PE
1561 while (idx < HASH_TABLE_SIZE (XHASH_TABLE (collection))
1562 && NILP (HASH_HASH (XHASH_TABLE (collection), idx)))
1563 idx++;
1564 if (idx >= HASH_TABLE_SIZE (XHASH_TABLE (collection)))
85cd4372
SM
1565 break;
1566 else
62137a95 1567 elt = eltstring = HASH_KEY (XHASH_TABLE (collection), idx++);
85cd4372 1568 }
f927c5ae 1569
fd6fa53f 1570 /* Is this element a possible completion? */
f927c5ae 1571
3809648a
KS
1572 if (SYMBOLP (eltstring))
1573 eltstring = Fsymbol_name (eltstring);
1574
7510b296 1575 if (STRINGP (eltstring)
d5db4077 1576 && SCHARS (string) <= SCHARS (eltstring)
89a255dc 1577 /* If HIDE_SPACES, reject alternatives that start with space
2cbaf886 1578 unless the input starts with space. */
11e3c684
CY
1579 && (NILP (hide_spaces)
1580 || (SBYTES (string) > 0
1581 && SREF (string, 0) == ' ')
1582 || SREF (eltstring, 0) != ' ')
c8ae863b 1583 && (tem = Fcompare_strings (eltstring, zero,
d5db4077 1584 make_number (SCHARS (string)),
c8ae863b 1585 string, zero,
d5db4077 1586 make_number (SCHARS (string)),
69f4ef20
RS
1587 completion_ignore_case ? Qt : Qnil),
1588 EQ (Qt, tem)))
f927c5ae 1589 {
fd6fa53f 1590 /* Yes. */
42006772 1591 Lisp_Object regexps;
42006772
RS
1592
1593 /* Ignore this element if it fails to match all the regexps. */
6b61353c 1594 {
6b61353c
KH
1595 for (regexps = Vcompletion_regexp_list; CONSP (regexps);
1596 regexps = XCDR (regexps))
1597 {
acd81db9
DK
1598 if (bindcount < 0) {
1599 bindcount = SPECPDL_INDEX ();
1600 specbind (Qcase_fold_search,
1601 completion_ignore_case ? Qt : Qnil);
77443789 1602 }
6b61353c
KH
1603 tem = Fstring_match (XCAR (regexps), eltstring, zero);
1604 if (NILP (tem))
1605 break;
1606 }
6b61353c
KH
1607 if (CONSP (regexps))
1608 continue;
1609 }
42006772 1610
f927c5ae 1611 /* Ignore this element if there is a predicate
fd6fa53f 1612 and the predicate doesn't like it. */
f927c5ae 1613
7efd36fc 1614 if (!NILP (predicate))
f927c5ae 1615 {
7efd36fc 1616 if (EQ (predicate, Qcommandp))
c837f4f9 1617 tem = Fcommandp (elt, Qnil);
f927c5ae
JB
1618 else
1619 {
acd81db9
DK
1620 if (bindcount >= 0) {
1621 unbind_to (bindcount, Qnil);
1622 bindcount = -1;
1623 }
f927c5ae 1624 GCPRO4 (tail, eltstring, allmatches, string);
85cd4372
SM
1625 tem = type == 3
1626 ? call2 (predicate, elt,
62137a95 1627 HASH_VALUE (XHASH_TABLE (collection), idx - 1))
85cd4372 1628 : call1 (predicate, elt);
f927c5ae
JB
1629 UNGCPRO;
1630 }
56a98455 1631 if (NILP (tem)) continue;
f927c5ae 1632 }
fd6fa53f 1633 /* Ok => put it on the list. */
f927c5ae
JB
1634 allmatches = Fcons (eltstring, allmatches);
1635 }
1636 }
1637
acd81db9
DK
1638 if (bindcount >= 0) {
1639 unbind_to (bindcount, Qnil);
1640 bindcount = -1;
1641 }
1642
f927c5ae
JB
1643 return Fnreverse (allmatches);
1644}
1645\f
a7ca3326 1646DEFUN ("completing-read", Fcompleting_read, Scompleting_read, 2, 8, 0,
af52c32d 1647 doc: /* Read a string in the minibuffer, with completion.
a1f17501 1648PROMPT is a string to prompt with; normally it ends in a colon and a space.
a284cdbb
RS
1649COLLECTION can be a list of strings, an alist, an obarray or a hash table.
1650COLLECTION can also be a function to do the completion itself.
1651PREDICATE limits completion to a subset of COLLECTION.
a1f17501 1652See `try-completion' and `all-completions' for more details
a284cdbb 1653 on completion, COLLECTION, and PREDICATE.
a1f17501 1654
4d02fc25
SM
1655REQUIRE-MATCH can take the following values:
1656- t means that the user is not allowed to exit unless
1657 the input is (or completes to) an element of COLLECTION or is null.
1658- nil means that the user can exit with any input.
b47d0e56
CY
1659- `confirm' means that the user can exit with any input, but she needs
1660 to confirm her choice if the input is not an element of COLLECTION.
1661- `confirm-after-completion' means that the user can exit with any
1662 input, but she needs to confirm her choice if she called
1663 `minibuffer-complete' right before `minibuffer-complete-and-exit'
1664 and the input is not an element of COLLECTION.
4d02fc25
SM
1665- anything else behaves like t except that typing RET does not exit if it
1666 does non-null completion.
1667
2e3148e2
JL
1668If the input is null, `completing-read' returns DEF, or the first element
1669of the list of default values, or an empty string if DEF is nil,
1670regardless of the value of REQUIRE-MATCH.
6b61353c
KH
1671
1672If INITIAL-INPUT is non-nil, insert it in the minibuffer initially,
1673 with point positioned at the end.
1674 If it is (STRING . POSITION), the initial input is STRING, but point
1675 is placed at _zero-indexed_ position POSITION in STRING. (*Note*
1676 that this is different from `read-from-minibuffer' and related
1677 functions, which use one-indexing for POSITION.) This feature is
1678 deprecated--it is best to pass nil for INITIAL-INPUT and supply the
1679 default value DEF instead. The user can yank the default value into
1680 the minibuffer easily using \\[next-history-element].
1681
1682HIST, if non-nil, specifies a history list and optionally the initial
1683 position in the list. It can be a symbol, which is the history list
1684 variable to use, or it can be a cons cell (HISTVAR . HISTPOS). In
1685 that case, HISTVAR is the history list variable to use, and HISTPOS
1686 is the initial position (the position in the list used by the
1687 minibuffer history commands). For consistency, you should also
1688 specify that element of the history as the value of
1fb101f3 1689 INITIAL-INPUT. (This is the only case in which you should use
6b61353c
KH
1690 INITIAL-INPUT instead of DEF.) Positions are counted starting from
1691 1 at the beginning of the list. The variable `history-length'
1692 controls the maximum length of a history list.
38668f81 1693
2e3148e2 1694DEF, if non-nil, is the default value or the list of default values.
a1f17501
PJ
1695
1696If INHERIT-INPUT-METHOD is non-nil, the minibuffer inherits
029a305c 1697 the current input method and the setting of `enable-multibyte-characters'.
a1f17501
PJ
1698
1699Completion ignores case if the ambient value of
3ec03f7e
LL
1700 `completion-ignore-case' is non-nil.
1701
1702See also `completing-read-function'. */)
1703 (Lisp_Object prompt, Lisp_Object collection, Lisp_Object predicate, Lisp_Object require_match, Lisp_Object initial_input, Lisp_Object hist, Lisp_Object def, Lisp_Object inherit_input_method)
1704{
1705 Lisp_Object args[9];
4e323265 1706 args[0] = Fsymbol_value (intern ("completing-read-function"));
3ec03f7e
LL
1707 args[1] = prompt;
1708 args[2] = collection;
1709 args[3] = predicate;
1710 args[4] = require_match;
1711 args[5] = initial_input;
1712 args[6] = hist;
1713 args[7] = def;
1714 args[8] = inherit_input_method;
1715 return Ffuncall (9, args);
1716}
f927c5ae 1717\f
971de7fb 1718Lisp_Object Fassoc_string (register Lisp_Object key, Lisp_Object list, Lisp_Object case_fold);
5d2ca7ae
RS
1719
1720/* Test whether TXT is an exact completion. */
695deb18
SM
1721DEFUN ("test-completion", Ftest_completion, Stest_completion, 2, 3, 0,
1722 doc: /* Return non-nil if STRING is a valid completion.
1723Takes the same arguments as `all-completions' and `try-completion'.
a284cdbb 1724If COLLECTION is a function, it is called with three arguments:
695deb18 1725the values STRING, PREDICATE and `lambda'. */)
5842a27b 1726 (Lisp_Object string, Lisp_Object collection, Lisp_Object predicate)
5d2ca7ae 1727{
6b61353c 1728 Lisp_Object regexps, tail, tem = Qnil;
d3411f89 1729 ptrdiff_t i = 0;
5d2ca7ae 1730
695deb18
SM
1731 CHECK_STRING (string);
1732
a284cdbb
RS
1733 if ((CONSP (collection)
1734 && (!SYMBOLP (XCAR (collection)) || NILP (XCAR (collection))))
1735 || NILP (collection))
695deb18 1736 {
a284cdbb 1737 tem = Fassoc_string (string, collection, completion_ignore_case ? Qt : Qnil);
9f4a578d 1738 if (NILP (tem))
695deb18
SM
1739 return Qnil;
1740 }
a284cdbb 1741 else if (VECTORP (collection))
5d2ca7ae 1742 {
695deb18 1743 /* Bypass intern-soft as that loses for nil. */
a284cdbb 1744 tem = oblookup (collection,
42a5b22f 1745 SSDATA (string),
d5db4077
KR
1746 SCHARS (string),
1747 SBYTES (string));
44472c88 1748 if (!SYMBOLP (tem))
9404446f 1749 {
695deb18
SM
1750 if (STRING_MULTIBYTE (string))
1751 string = Fstring_make_unibyte (string);
9404446f 1752 else
695deb18 1753 string = Fstring_make_multibyte (string);
9404446f 1754
a284cdbb 1755 tem = oblookup (collection,
42a5b22f 1756 SSDATA (string),
d5db4077
KR
1757 SCHARS (string),
1758 SBYTES (string));
9404446f 1759 }
6b61353c
KH
1760
1761 if (completion_ignore_case && !SYMBOLP (tem))
1762 {
77b37c05 1763 for (i = ASIZE (collection) - 1; i >= 0; i--)
6b61353c 1764 {
a284cdbb 1765 tail = XVECTOR (collection)->contents[i];
6b61353c
KH
1766 if (SYMBOLP (tail))
1767 while (1)
1768 {
fd6fa53f 1769 if (EQ (Fcompare_strings (string, make_number (0), Qnil,
6b61353c 1770 Fsymbol_name (tail),
fd6fa53f 1771 make_number (0) , Qnil, Qt),
6b61353c
KH
1772 Qt))
1773 {
1774 tem = tail;
1775 break;
1776 }
1777 if (XSYMBOL (tail)->next == 0)
1778 break;
1779 XSETSYMBOL (tail, XSYMBOL (tail)->next);
1780 }
1781 }
1782 }
1783
1784 if (!SYMBOLP (tem))
1785 return Qnil;
5d2ca7ae 1786 }
a284cdbb 1787 else if (HASH_TABLE_P (collection))
85cd4372 1788 {
a284cdbb 1789 struct Lisp_Hash_Table *h = XHASH_TABLE (collection);
6b61353c 1790 i = hash_lookup (h, string, NULL);
85cd4372 1791 if (i >= 0)
6b61353c 1792 tem = HASH_KEY (h, i);
85cd4372 1793 else
6b61353c 1794 for (i = 0; i < HASH_TABLE_SIZE (h); ++i)
fd6fa53f
SM
1795 if (!NILP (HASH_HASH (h, i))
1796 && EQ (Fcompare_strings (string, make_number (0), Qnil,
1797 HASH_KEY (h, i), make_number (0) , Qnil,
1798 completion_ignore_case ? Qt : Qnil),
1799 Qt))
6b61353c
KH
1800 {
1801 tem = HASH_KEY (h, i);
1802 break;
1803 }
1804 if (!STRINGP (tem))
85cd4372
SM
1805 return Qnil;
1806 }
5d2ca7ae 1807 else
a284cdbb 1808 return call3 (collection, string, predicate, Qlambda);
695deb18
SM
1809
1810 /* Reject this element if it fails to match all the regexps. */
77443789
AS
1811 if (CONSP (Vcompletion_regexp_list))
1812 {
1813 int count = SPECPDL_INDEX ();
1814 specbind (Qcase_fold_search, completion_ignore_case ? Qt : Qnil);
1815 for (regexps = Vcompletion_regexp_list; CONSP (regexps);
1816 regexps = XCDR (regexps))
1817 {
1818 if (NILP (Fstring_match (XCAR (regexps),
1819 SYMBOLP (tem) ? string : tem,
1820 Qnil)))
1821 return unbind_to (count, Qnil);
1822 }
1823 unbind_to (count, Qnil);
1824 }
695deb18
SM
1825
1826 /* Finally, check the predicate. */
1827 if (!NILP (predicate))
6b61353c 1828 {
a284cdbb
RS
1829 return HASH_TABLE_P (collection)
1830 ? call2 (predicate, tem, HASH_VALUE (XHASH_TABLE (collection), i))
6b61353c
KH
1831 : call1 (predicate, tem);
1832 }
695deb18
SM
1833 else
1834 return Qt;
5d2ca7ae 1835}
f927c5ae 1836
4b66faf3 1837static Lisp_Object Qmetadata;
620c53a6
SM
1838extern Lisp_Object Qbuffer;
1839
655ea21c
JD
1840DEFUN ("internal-complete-buffer", Finternal_complete_buffer, Sinternal_complete_buffer, 3, 3, 0,
1841 doc: /* Perform completion on buffer names.
1842If the argument FLAG is nil, invoke `try-completion', if it's t, invoke
1843`all-completions', otherwise invoke `test-completion'.
1844
ba5524f4 1845The arguments STRING and PREDICATE are as in `try-completion',
fd6fa53f 1846`all-completions', and `test-completion'. */)
5842a27b 1847 (Lisp_Object string, Lisp_Object predicate, Lisp_Object flag)
655ea21c
JD
1848{
1849 if (NILP (flag))
1850 return Ftry_completion (string, Vbuffer_alist, predicate);
1851 else if (EQ (flag, Qt))
8c2dccbf 1852 {
73913e2e 1853 Lisp_Object res = Fall_completions (string, Vbuffer_alist, predicate, Qnil);
8c2dccbf
SM
1854 if (SCHARS (string) > 0)
1855 return res;
1856 else
1857 { /* Strip out internal buffers. */
1858 Lisp_Object bufs = res;
1859 /* First, look for a non-internal buffer in `res'. */
1860 while (CONSP (bufs) && SREF (XCAR (bufs), 0) == ' ')
1861 bufs = XCDR (bufs);
1862 if (NILP (bufs))
1863 /* All bufs in `res' are internal, so don't trip them out. */
1864 return res;
1865 res = bufs;
1866 while (CONSP (XCDR (bufs)))
1867 if (SREF (XCAR (XCDR (bufs)), 0) == ' ')
1868 XSETCDR (bufs, XCDR (XCDR (bufs)));
1869 else
1870 bufs = XCDR (bufs);
1871 return res;
1872 }
1873 }
620c53a6 1874 else if (EQ (flag, Qlambda))
655ea21c 1875 return Ftest_completion (string, Vbuffer_alist, predicate);
620c53a6
SM
1876 else if (EQ (flag, Qmetadata))
1877 return Fcons (Qmetadata, Fcons (Fcons (Qcategory, Qbuffer), Qnil));
1878 else
1879 return Qnil;
655ea21c
JD
1880}
1881
52b14ac0
JB
1882/* Like assoc but assumes KEY is a string, and ignores case if appropriate. */
1883
a7ca3326 1884DEFUN ("assoc-string", Fassoc_string, Sassoc_string, 2, 3, 0,
d3fc66fb 1885 doc: /* Like `assoc' but specifically for strings (and symbols).
c6a82c18
CY
1886
1887This returns the first element of LIST whose car matches the string or
1888symbol KEY, or nil if no match exists. When performing the
1889comparison, symbols are first converted to strings, and unibyte
1890strings to multibyte. If the optional arg CASE-FOLD is non-nil, case
1891is ignored.
1892
1893Unlike `assoc', KEY can also match an entry in LIST consisting of a
1894single string, rather than a cons cell whose car is a string. */)
5842a27b 1895 (register Lisp_Object key, Lisp_Object list, Lisp_Object case_fold)
52b14ac0
JB
1896{
1897 register Lisp_Object tail;
1898
d3fc66fb
KS
1899 if (SYMBOLP (key))
1900 key = Fsymbol_name (key);
1901
99784d63 1902 for (tail = list; CONSP (tail); tail = XCDR (tail))
52b14ac0
JB
1903 {
1904 register Lisp_Object elt, tem, thiscar;
99784d63 1905 elt = XCAR (tail);
695deb18 1906 thiscar = CONSP (elt) ? XCAR (elt) : elt;
1954495f
KS
1907 if (SYMBOLP (thiscar))
1908 thiscar = Fsymbol_name (thiscar);
1909 else if (!STRINGP (thiscar))
52b14ac0 1910 continue;
9404446f
RS
1911 tem = Fcompare_strings (thiscar, make_number (0), Qnil,
1912 key, make_number (0), Qnil,
695deb18 1913 case_fold);
9404446f
RS
1914 if (EQ (tem, Qt))
1915 return elt;
52b14ac0
JB
1916 QUIT;
1917 }
1918 return Qnil;
1919}
f927c5ae 1920
e4c97a67 1921\f
f927c5ae 1922DEFUN ("minibuffer-depth", Fminibuffer_depth, Sminibuffer_depth, 0, 0, 0,
af52c32d 1923 doc: /* Return current depth of activations of minibuffer, a nonnegative integer. */)
5842a27b 1924 (void)
f927c5ae
JB
1925{
1926 return make_number (minibuf_level);
1927}
1928
37e9a934 1929DEFUN ("minibuffer-prompt", Fminibuffer_prompt, Sminibuffer_prompt, 0, 0, 0,
af52c32d
MB
1930 doc: /* Return the prompt string of the currently-active minibuffer.
1931If no minibuffer is active, return nil. */)
5842a27b 1932 (void)
37e9a934 1933{
4d04c1f1 1934 return Fcopy_sequence (minibuf_prompt);
37e9a934
KH
1935}
1936
f927c5ae 1937\f
9d815fd9 1938void
971de7fb 1939init_minibuf_once (void)
f927c5ae
JB
1940{
1941 Vminibuffer_list = Qnil;
1942 staticpro (&Vminibuffer_list);
1943}
1944
9d815fd9 1945void
971de7fb 1946syms_of_minibuf (void)
f927c5ae
JB
1947{
1948 minibuf_level = 0;
4d04c1f1
KH
1949 minibuf_prompt = Qnil;
1950 staticpro (&minibuf_prompt);
1951
1952 minibuf_save_list = Qnil;
1953 staticpro (&minibuf_save_list);
f927c5ae 1954
620c53a6
SM
1955 DEFSYM (Qcompletion_ignore_case, "completion-ignore-case");
1956 DEFSYM (Qread_file_name_internal, "read-file-name-internal");
1957 DEFSYM (Qminibuffer_default, "minibuffer-default");
e5d4686b
RS
1958 Fset (Qminibuffer_default, Qnil);
1959
620c53a6
SM
1960 DEFSYM (Qminibuffer_completion_table, "minibuffer-completion-table");
1961 DEFSYM (Qminibuffer_completion_confirm, "minibuffer-completion-confirm");
1962 DEFSYM (Qminibuffer_completion_predicate, "minibuffer-completion-predicate");
f927c5ae
JB
1963
1964 staticpro (&last_minibuf_string);
1965 last_minibuf_string = Qnil;
1966
620c53a6
SM
1967 DEFSYM (Quser_variable_p, "user-variable-p");
1968 DEFSYM (Qminibuffer_history, "minibuffer-history");
1969 DEFSYM (Qbuffer_name_history, "buffer-name-history");
33d0a17f 1970 Fset (Qbuffer_name_history, Qnil);
406e55df 1971
620c53a6
SM
1972 DEFSYM (Qminibuffer_setup_hook, "minibuffer-setup-hook");
1973 DEFSYM (Qminibuffer_exit_hook, "minibuffer-exit-hook");
1974 DEFSYM (Qhistory_length, "history-length");
1975 DEFSYM (Qcurrent_input_method, "current-input-method");
1976 DEFSYM (Qactivate_input_method, "activate-input-method");
1977 DEFSYM (Qcase_fold_search, "case-fold-search");
1978 DEFSYM (Qmetadata, "metadata");
6b61353c 1979
c11136ec
GM
1980 DEFVAR_LISP ("read-expression-history", Vread_expression_history,
1981 doc: /* A history list for arguments that are Lisp expressions to evaluate.
1982For example, `eval-expression' uses this. */);
1983 Vread_expression_history = Qnil;
1984
620c53a6 1985 DEFSYM (Qread_expression_history, "read-expression-history");
627fb581 1986
29208e82 1987 DEFVAR_LISP ("read-buffer-function", Vread_buffer_function,
b4f588fa
JB
1988 doc: /* If this is non-nil, `read-buffer' does its work by calling this function.
1989The function is called with the arguments passed to `read-buffer'. */);
eebbfb01
KH
1990 Vread_buffer_function = Qnil;
1991
33df281c 1992 DEFVAR_BOOL ("read-buffer-completion-ignore-case",
29208e82 1993 read_buffer_completion_ignore_case,
33df281c
CY
1994 doc: /* *Non-nil means completion ignores case when reading a buffer name. */);
1995 read_buffer_completion_ignore_case = 0;
1996
29208e82 1997 DEFVAR_LISP ("minibuffer-setup-hook", Vminibuffer_setup_hook,
af52c32d 1998 doc: /* Normal hook run just after entry to minibuffer. */);
5c781212
RS
1999 Vminibuffer_setup_hook = Qnil;
2000
29208e82 2001 DEFVAR_LISP ("minibuffer-exit-hook", Vminibuffer_exit_hook,
af52c32d 2002 doc: /* Normal hook run just after exit from minibuffer. */);
177aecf9
KH
2003 Vminibuffer_exit_hook = Qnil;
2004
29208e82 2005 DEFVAR_LISP ("history-length", Vhistory_length,
af52c32d 2006 doc: /* *Maximum length for history lists before truncation takes place.
a1f17501 2007A number means that length; t means infinite. Truncation takes place
f4b46bb9 2008just after a new element is inserted. Setting the `history-length'
a1f17501 2009property of a history variable overrides this default. */);
77aa8edf
RS
2010 XSETFASTINT (Vhistory_length, 30);
2011
29208e82 2012 DEFVAR_BOOL ("history-delete-duplicates", history_delete_duplicates,
0da4d471
JL
2013 doc: /* *Non-nil means to delete duplicates in history.
2014If set to t when adding a new history element, all previous identical
179a4ca7 2015elements are deleted from the history list. */);
0da4d471
JL
2016 history_delete_duplicates = 0;
2017
29208e82 2018 DEFVAR_LISP ("history-add-new-input", Vhistory_add_new_input,
179a4ca7
JL
2019 doc: /* *Non-nil means to add new elements in history.
2020If set to nil, minibuffer reading functions don't add new elements to the
2021history list, so it is possible to do this afterwards by calling
2022`add-to-history' explicitly. */);
2023 Vhistory_add_new_input = Qt;
2024
29208e82 2025 DEFVAR_BOOL ("completion-ignore-case", completion_ignore_case,
75028673 2026 doc: /* Non-nil means don't consider case significant in completion.
f562df03
CY
2027For file-name completion, `read-file-name-completion-ignore-case'
2028controls the behavior, rather than this variable.
2029For buffer name completion, `read-buffer-completion-ignore-case'
d9a03ad2 2030controls the behavior, rather than this variable. */);
f927c5ae
JB
2031 completion_ignore_case = 0;
2032
29208e82 2033 DEFVAR_BOOL ("enable-recursive-minibuffers", enable_recursive_minibuffers,
af52c32d 2034 doc: /* *Non-nil means to allow minibuffer commands while in the minibuffer.
a1f17501 2035This variable makes a difference whenever the minibuffer window is active. */);
f927c5ae
JB
2036 enable_recursive_minibuffers = 0;
2037
29208e82 2038 DEFVAR_LISP ("minibuffer-completion-table", Vminibuffer_completion_table,
af52c32d 2039 doc: /* Alist or obarray used for completion in the minibuffer.
6b61353c
KH
2040This becomes the ALIST argument to `try-completion' and `all-completions'.
2041The value can also be a list of strings or a hash table.
a1f17501
PJ
2042
2043The value may alternatively be a function, which is given three arguments:
2044 STRING, the current buffer contents;
2045 PREDICATE, the predicate for filtering possible matches;
2046 CODE, which says what kind of things to do.
b2ef9714
JB
2047CODE can be nil, t or `lambda':
2048 nil -- return the best completion of STRING, or nil if there is none.
2049 t -- return a list of all possible completions of STRING.
2050 lambda -- return t if STRING is a valid completion as it stands. */);
f927c5ae
JB
2051 Vminibuffer_completion_table = Qnil;
2052
29208e82 2053 DEFVAR_LISP ("minibuffer-completion-predicate", Vminibuffer_completion_predicate,
af52c32d 2054 doc: /* Within call to `completing-read', this holds the PREDICATE argument. */);
f927c5ae
JB
2055 Vminibuffer_completion_predicate = Qnil;
2056
29208e82 2057 DEFVAR_LISP ("minibuffer-completion-confirm", Vminibuffer_completion_confirm,
b47d0e56
CY
2058 doc: /* Whether to demand confirmation of completion before exiting minibuffer.
2059If nil, confirmation is not required.
2060If the value is `confirm', the user may exit with an input that is not
2061 a valid completion alternative, but Emacs asks for confirmation.
2062If the value is `confirm-after-completion', the user may exit with an
2063 input that is not a valid completion alternative, but Emacs asks for
1b79e224
CY
2064 confirmation if the user submitted the input right after any of the
2065 completion commands listed in `minibuffer-confirm-exit-commands'. */);
f927c5ae
JB
2066 Vminibuffer_completion_confirm = Qnil;
2067
ccf330a6 2068 DEFVAR_LISP ("minibuffer-completing-file-name",
29208e82 2069 Vminibuffer_completing_file_name,
6ddfc113 2070 doc: /* Non-nil means completing file names. */);
ccf330a6
RS
2071 Vminibuffer_completing_file_name = Qnil;
2072
29208e82 2073 DEFVAR_LISP ("minibuffer-help-form", Vminibuffer_help_form,
af52c32d 2074 doc: /* Value that `help-form' takes on inside the minibuffer. */);
f927c5ae
JB
2075 Vminibuffer_help_form = Qnil;
2076
29208e82 2077 DEFVAR_LISP ("minibuffer-history-variable", Vminibuffer_history_variable,
af52c32d 2078 doc: /* History list symbol to add minibuffer values to.
a1f17501
PJ
2079Each string of minibuffer input, as it appears on exit from the minibuffer,
2080is added with
2081 (set minibuffer-history-variable
2082 (cons STRING (symbol-value minibuffer-history-variable))) */);
5a866662 2083 XSETFASTINT (Vminibuffer_history_variable, 0);
770970cb 2084
29208e82 2085 DEFVAR_LISP ("minibuffer-history-position", Vminibuffer_history_position,
af52c32d 2086 doc: /* Current position of redoing in the history list. */);
770970cb
RS
2087 Vminibuffer_history_position = Qnil;
2088
29208e82 2089 DEFVAR_BOOL ("minibuffer-auto-raise", minibuffer_auto_raise,
af52c32d 2090 doc: /* *Non-nil means entering the minibuffer raises the minibuffer's frame.
a1f17501 2091Some uses of the echo area also raise that frame (since they use it too). */);
6a9ee000
RS
2092 minibuffer_auto_raise = 0;
2093
29208e82 2094 DEFVAR_LISP ("completion-regexp-list", Vcompletion_regexp_list,
6b61353c
KH
2095 doc: /* List of regexps that should restrict possible completions.
2096The basic completion functions only consider a completion acceptable
2097if it matches all regular expressions in this list, with
2098`case-fold-search' bound to the value of `completion-ignore-case'.
2099See Info node `(elisp)Basic Completion', for a description of these
2100functions. */);
42006772
RS
2101 Vcompletion_regexp_list = Qnil;
2102
c3421833 2103 DEFVAR_BOOL ("minibuffer-allow-text-properties",
29208e82 2104 minibuffer_allow_text_properties,
af52c32d 2105 doc: /* Non-nil means `read-from-minibuffer' should not discard text properties.
a1f17501
PJ
2106This also affects `read-string', but it does not affect `read-minibuffer',
2107`read-no-blanks-input', or any of the functions that do minibuffer input
2108with completion; they always discard text properties. */);
c3421833
RS
2109 minibuffer_allow_text_properties = 0;
2110
29208e82 2111 DEFVAR_LISP ("minibuffer-prompt-properties", Vminibuffer_prompt_properties,
af52c32d 2112 doc: /* Text properties that are added to minibuffer prompts.
a1f17501
PJ
2113These are in addition to the basic `field' property, and stickiness
2114properties. */);
cc64f5c9
MB
2115 /* We use `intern' here instead of Qread_only to avoid
2116 initialization-order problems. */
2117 Vminibuffer_prompt_properties
d67b4f80 2118 = Fcons (intern_c_string ("read-only"), Fcons (Qt, Qnil));
cc64f5c9 2119
29208e82 2120 DEFVAR_LISP ("read-expression-map", Vread_expression_map,
627fb581
RS
2121 doc: /* Minibuffer keymap used for reading Lisp expressions. */);
2122 Vread_expression_map = Qnil;
2123
727e958e 2124 defsubr (&Sactive_minibuffer_window);
68313ed8 2125 defsubr (&Sset_minibuffer_window);
f927c5ae
JB
2126 defsubr (&Sread_from_minibuffer);
2127 defsubr (&Seval_minibuffer);
2128 defsubr (&Sread_minibuffer);
2129 defsubr (&Sread_string);
2130 defsubr (&Sread_command);
2131 defsubr (&Sread_variable);
ff137f16 2132 defsubr (&Sinternal_complete_buffer);
f927c5ae
JB
2133 defsubr (&Sread_buffer);
2134 defsubr (&Sread_no_blanks_input);
2135 defsubr (&Sminibuffer_depth);
37e9a934 2136 defsubr (&Sminibuffer_prompt);
f927c5ae 2137
873ef78e 2138 defsubr (&Sminibufferp);
a346ec72
MB
2139 defsubr (&Sminibuffer_prompt_end);
2140 defsubr (&Sminibuffer_contents);
2141 defsubr (&Sminibuffer_contents_no_properties);
b5e1e449 2142 defsubr (&Sminibuffer_completion_contents);
a346ec72 2143
f927c5ae
JB
2144 defsubr (&Stry_completion);
2145 defsubr (&Sall_completions);
695deb18
SM
2146 defsubr (&Stest_completion);
2147 defsubr (&Sassoc_string);
f927c5ae 2148 defsubr (&Scompleting_read);
f927c5ae 2149}