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