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