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