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