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