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