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