Expose window-tree functions in Elisp.
[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
620c53a6 46/* Data to remember during recursive minibuffer invocations. */
279cf52c 47
1717ede2 48static Lisp_Object minibuf_save_list;
f927c5ae
JB
49
50/* Depth in minibuffer invocations. */
279cf52c 51
f927c5ae
JB
52int minibuf_level;
53
77aa8edf 54/* The maximum length of a minibuffer history. */
279cf52c 55
955cbe7b 56static Lisp_Object Qhistory_length;
179a4ca7 57
620c53a6 58/* Fread_minibuffer leaves the input here as a string. */
279cf52c 59
f927c5ae
JB
60Lisp_Object last_minibuf_string;
61
955cbe7b 62static Lisp_Object Qminibuffer_history, Qbuffer_name_history;
770970cb 63
955cbe7b 64static Lisp_Object Qread_file_name_internal;
719b4a40 65
177aecf9 66/* Normal hooks for entry to and exit from minibuffer. */
5c781212 67
955cbe7b
PE
68static Lisp_Object Qminibuffer_setup_hook;
69static Lisp_Object Qminibuffer_exit_hook;
eebbfb01 70
9fa5c213 71Lisp_Object Qcompletion_ignore_case;
955cbe7b
PE
72static Lisp_Object Qminibuffer_completion_table;
73static Lisp_Object Qminibuffer_completion_predicate;
74static Lisp_Object Qminibuffer_completion_confirm;
75static Lisp_Object Qcompleting_read_default;
76static Lisp_Object Quser_variable_p;
5744fa7c 77
955cbe7b 78static Lisp_Object Qminibuffer_default;
5744fa7c 79
955cbe7b 80static Lisp_Object Qcurrent_input_method, Qactivate_input_method;
cee54539 81
955cbe7b 82static Lisp_Object Qcase_fold_search;
6b61353c 83
955cbe7b 84static Lisp_Object Qread_expression_history;
627fb581 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
1717ede2 100static void
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
fd6fa53f 163/* Actual minibuffer invocation. */
f927c5ae 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 247 if ((size_t) -1 / 2 < size)
531b0165 248 memory_full (SIZE_MAX);
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
fd6fa53f 269 /* If Lisp form desired instead of string, parse it. */
edfef199 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. */
620c53a6 591 empty_minibuf = get_minibuffer (0);
b20de1cd
RS
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
fd6fa53f 746 /* If Lisp form desired instead of string, parse it. */
9f6131cf 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
fd6fa53f 758 used for nonrecursive minibuffer invocations. */
f927c5ae
JB
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);
fd6fa53f
SM
796 if (!NILP (Ffboundp (intern ("minibuffer-inactive-mode"))))
797 call0 (intern ("minibuffer-inactive-mode"));
798 else
799 Fkill_all_local_variables ();
6b3faad8 800 unbind_to (count, Qnil);
5956f71d 801 }
64a3a3c0 802
f927c5ae
JB
803 return buf;
804}
805
7292839d 806static Lisp_Object
971de7fb 807run_exit_minibuf_hook (Lisp_Object data)
7292839d 808{
dee091a3 809 safe_run_hooks (Qminibuffer_exit_hook);
7292839d
SM
810 return Qnil;
811}
812
279cf52c 813/* This function is called on exiting minibuffer, whether normally or
fd6fa53f 814 not, and it restores the current window, buffer, etc. */
f927c5ae 815
9d815fd9 816static Lisp_Object
971de7fb 817read_minibuf_unwind (Lisp_Object data)
f927c5ae 818{
c24e1160 819 Lisp_Object old_deactivate_mark;
59115a22 820 Lisp_Object window;
c24e1160 821
f927c5ae 822 /* If this was a recursive minibuffer,
59115a22 823 tie the minibuffer window back to the outer level minibuffer buffer. */
f927c5ae 824 minibuf_level--;
f927c5ae 825
59115a22 826 window = minibuf_window;
279cf52c
GM
827 /* To keep things predictable, in case it matters, let's be in the
828 minibuffer when we reset the relevant variables. */
59115a22
RS
829 Fset_buffer (XWINDOW (window)->buffer);
830
831 /* Restore prompt, etc, from outer minibuffer level. */
4d04c1f1
KH
832 minibuf_prompt = Fcar (minibuf_save_list);
833 minibuf_save_list = Fcdr (minibuf_save_list);
834 minibuf_prompt_width = XFASTINT (Fcar (minibuf_save_list));
835 minibuf_save_list = Fcdr (minibuf_save_list);
836 Vhelp_form = Fcar (minibuf_save_list);
837 minibuf_save_list = Fcdr (minibuf_save_list);
ee9e37ab 838 Vcurrent_prefix_arg = Fcar (minibuf_save_list);
4d04c1f1
KH
839 minibuf_save_list = Fcdr (minibuf_save_list);
840 Vminibuffer_history_position = Fcar (minibuf_save_list);
841 minibuf_save_list = Fcdr (minibuf_save_list);
842 Vminibuffer_history_variable = Fcar (minibuf_save_list);
843 minibuf_save_list = Fcdr (minibuf_save_list);
30e13e56 844 Voverriding_local_map = Fcar (minibuf_save_list);
c5b6b680 845 minibuf_save_list = Fcdr (minibuf_save_list);
914860c2
RS
846#if 0
847 temp = Fcar (minibuf_save_list);
848 if (FRAME_LIVE_P (XFRAME (WINDOW_FRAME (XWINDOW (temp)))))
849 minibuf_window = temp;
850#endif
30e13e56 851 minibuf_save_list = Fcdr (minibuf_save_list);
59115a22
RS
852
853 /* Erase the minibuffer we were using at this level. */
854 {
aed13378 855 int count = SPECPDL_INDEX ();
59115a22
RS
856 /* Prevent error in erase-buffer. */
857 specbind (Qinhibit_read_only, Qt);
bd819d14 858 specbind (Qinhibit_modification_hooks, Qt);
59115a22
RS
859 old_deactivate_mark = Vdeactivate_mark;
860 Ferase_buffer ();
861 Vdeactivate_mark = old_deactivate_mark;
862 unbind_to (count, Qnil);
863 }
864
544e358d
GM
865 /* When we get to the outmost level, make sure we resize the
866 mini-window back to its normal size. */
867 if (minibuf_level == 0)
1e3f16d5 868 resize_mini_window (XWINDOW (window), 0);
544e358d 869
59115a22
RS
870 /* Make sure minibuffer window is erased, not ignored. */
871 windows_or_buffers_changed++;
872 XSETFASTINT (XWINDOW (window)->last_modified, 0);
193e4518 873 XSETFASTINT (XWINDOW (window)->last_overlay_modified, 0);
fd6fa53f
SM
874
875 /* In case the previous minibuffer displayed in this miniwindow is
876 dead, we may keep displaying this buffer (tho it's inactive), so reset it,
877 to make sure we don't leave around bindings and stuff which only
878 made sense during the read_minibuf invocation. */
879 call0 (intern ("minibuffer-inactive-mode"));
9d815fd9 880 return Qnil;
f927c5ae
JB
881}
882\f
b9d721de 883
a7ca3326 884DEFUN ("read-from-minibuffer", Fread_from_minibuffer,
16a97296 885 Sread_from_minibuffer, 1, 7, 0,
af52c32d 886 doc: /* Read a string from the minibuffer, prompting with string PROMPT.
6b61353c
KH
887The optional second arg INITIAL-CONTENTS is an obsolete alternative to
888 DEFAULT-VALUE. It normally should be nil in new code, except when
889 HIST is a cons. It is discussed in more detail below.
a1f17501
PJ
890Third arg KEYMAP is a keymap to use whilst reading;
891 if omitted or nil, the default is `minibuffer-local-map'.
fd771ceb 892If fourth arg READ is non-nil, then interpret the result as a Lisp object
a1f17501
PJ
893 and return that object:
894 in other words, do `(car (read-from-string INPUT-STRING))'
6b61353c
KH
895Fifth arg HIST, if non-nil, specifies a history list and optionally
896 the initial position in the list. It can be a symbol, which is the
897 history list variable to use, or it can be a cons cell
898 (HISTVAR . HISTPOS). In that case, HISTVAR is the history list variable
899 to use, and HISTPOS is the initial position for use by the minibuffer
900 history commands. For consistency, you should also specify that
901 element of the history as the value of INITIAL-CONTENTS. Positions
902 are counted starting from 1 at the beginning of the list.
2e3148e2
JL
903Sixth arg DEFAULT-VALUE is the default value or the list of default values.
904 If non-nil, it is available for history commands, and as the value
905 (or the first element of the list of default values) to return
906 if the user enters the empty string. But, unless READ is non-nil,
907 `read-from-minibuffer' does NOT return DEFAULT-VALUE if the user enters
908 empty input! It returns the empty string.
a1f17501 909Seventh arg INHERIT-INPUT-METHOD, if non-nil, means the minibuffer inherits
029a305c 910 the current input method and the setting of `enable-multibyte-characters'.
a1f17501
PJ
911If the variable `minibuffer-allow-text-properties' is non-nil,
912 then the string which is returned includes whatever text properties
6b61353c
KH
913 were present in the minibuffer. Otherwise the value has no text properties.
914
915The remainder of this documentation string describes the
916INITIAL-CONTENTS argument in more detail. It is only relevant when
917studying existing code, or when HIST is a cons. If non-nil,
918INITIAL-CONTENTS is a string to be inserted into the minibuffer before
919reading input. Normally, point is put at the end of that string.
920However, if INITIAL-CONTENTS is \(STRING . POSITION), the initial
921input is STRING, but point is placed at _one-indexed_ position
922POSITION in the minibuffer. Any integer value less than or equal to
923one puts point at the beginning of the string. *Note* that this
924behavior differs from the way such arguments are used in `completing-read'
925and some related functions, which use zero-indexing for POSITION. */)
5842a27b 926 (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 927{
6b61353c 928 Lisp_Object histvar, histpos, val;
1d8d92f4
RS
929 struct gcpro gcpro1;
930
b7826503 931 CHECK_STRING (prompt);
56a98455 932 if (NILP (keymap))
f927c5ae
JB
933 keymap = Vminibuffer_local_map;
934 else
02067692 935 keymap = get_keymap (keymap, 1, 0);
770970cb 936
7510b296 937 if (SYMBOLP (hist))
770970cb
RS
938 {
939 histvar = hist;
940 histpos = Qnil;
941 }
942 else
943 {
944 histvar = Fcar_safe (hist);
945 histpos = Fcdr_safe (hist);
946 }
947 if (NILP (histvar))
948 histvar = Qminibuffer_history;
949 if (NILP (histpos))
5a866662 950 XSETFASTINT (histpos, 0);
770970cb 951
1d8d92f4 952 GCPRO1 (default_value);
e5d4686b 953 val = read_minibuf (keymap, initial_contents, prompt,
6b61353c 954 Qnil, !NILP (read),
c3421833 955 histvar, histpos, default_value,
cee54539 956 minibuffer_allow_text_properties,
b35cd215 957 !NILP (inherit_input_method));
1d8d92f4 958 UNGCPRO;
e5d4686b 959 return val;
f927c5ae
JB
960}
961
a7ca3326 962DEFUN ("read-minibuffer", Fread_minibuffer, Sread_minibuffer, 1, 2, 0,
6b61353c 963 doc: /* Return a Lisp object read using the minibuffer, unevaluated.
a1f17501 964Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS
6b61353c 965is a string to insert in the minibuffer before reading.
e298936f
JB
966\(INITIAL-CONTENTS can also be a cons of a string and an integer.
967Such arguments are used as in `read-from-minibuffer'.) */)
5842a27b 968 (Lisp_Object prompt, Lisp_Object initial_contents)
f927c5ae 969{
b7826503 970 CHECK_STRING (prompt);
770970cb 971 return read_minibuf (Vminibuffer_local_map, initial_contents,
e5d4686b 972 prompt, Qnil, 1, Qminibuffer_history,
b35cd215 973 make_number (0), Qnil, 0, 0);
f927c5ae
JB
974}
975
a7ca3326 976DEFUN ("eval-minibuffer", Feval_minibuffer, Seval_minibuffer, 1, 2, 0,
af52c32d 977 doc: /* Return value of Lisp expression read using the minibuffer.
a1f17501 978Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS
6b61353c 979is a string to insert in the minibuffer before reading.
e298936f
JB
980\(INITIAL-CONTENTS can also be a cons of a string and an integer.
981Such arguments are used as in `read-from-minibuffer'.) */)
5842a27b 982 (Lisp_Object prompt, Lisp_Object initial_contents)
f927c5ae 983{
627fb581
RS
984 return Feval (read_minibuf (Vread_expression_map, initial_contents,
985 prompt, Qnil, 1, Qread_expression_history,
a0ee6f27
SM
986 make_number (0), Qnil, 0, 0),
987 Qnil);
f927c5ae
JB
988}
989
fd6fa53f 990/* Functions that use the minibuffer to read various things. */
f927c5ae 991
a7ca3326 992DEFUN ("read-string", Fread_string, Sread_string, 1, 5, 0,
af52c32d 993 doc: /* Read a string from the minibuffer, prompting with string PROMPT.
a1f17501 994If non-nil, second arg INITIAL-INPUT is a string to insert before reading.
6b61353c
KH
995 This argument has been superseded by DEFAULT-VALUE and should normally
996 be nil in new code. It behaves as in `read-from-minibuffer'. See the
997 documentation string of that function for details.
a1f17501
PJ
998The third arg HISTORY, if non-nil, specifies a history list
999 and optionally the initial position in the list.
1000See `read-from-minibuffer' for details of HISTORY argument.
2e3148e2
JL
1001Fourth arg DEFAULT-VALUE is the default value or the list of default values.
1002 If non-nil, it is used for history commands, and as the value (or the first
1003 element of the list of default values) to return if the user enters the
1004 empty string.
a1f17501 1005Fifth arg INHERIT-INPUT-METHOD, if non-nil, means the minibuffer inherits
029a305c 1006 the current input method and the setting of `enable-multibyte-characters'. */)
5842a27b 1007 (Lisp_Object prompt, Lisp_Object initial_input, Lisp_Object history, Lisp_Object default_value, Lisp_Object inherit_input_method)
f927c5ae 1008{
b9a86585
RS
1009 Lisp_Object val;
1010 val = Fread_from_minibuffer (prompt, initial_input, Qnil,
1011 Qnil, history, default_value,
b35cd215 1012 inherit_input_method);
d5db4077 1013 if (STRINGP (val) && SCHARS (val) == 0 && ! NILP (default_value))
fb30dfd2 1014 val = CONSP (default_value) ? XCAR (default_value) : default_value;
b9a86585 1015 return val;
f927c5ae
JB
1016}
1017
cee54539 1018DEFUN ("read-no-blanks-input", Fread_no_blanks_input, Sread_no_blanks_input, 1, 3, 0,
af52c32d 1019 doc: /* Read a string from the terminal, not allowing blanks.
6b61353c
KH
1020Prompt with PROMPT. Whitespace terminates the input. If INITIAL is
1021non-nil, it should be a string, which is used as initial input, with
1022point positioned at the end, so that SPACE will accept the input.
1023\(Actually, INITIAL can also be a cons of a string and an integer.
1024Such values are treated as in `read-from-minibuffer', but are normally
1025not useful in this function.)
a1f17501 1026Third arg INHERIT-INPUT-METHOD, if non-nil, means the minibuffer inherits
6b61353c 1027the current input method and the setting of`enable-multibyte-characters'. */)
5842a27b 1028 (Lisp_Object prompt, Lisp_Object initial, Lisp_Object inherit_input_method)
f927c5ae 1029{
b7826503 1030 CHECK_STRING (prompt);
c923ccc9 1031 return read_minibuf (Vminibuffer_local_ns_map, initial, prompt, Qnil,
cee54539 1032 0, Qminibuffer_history, make_number (0), Qnil, 0,
b35cd215 1033 !NILP (inherit_input_method));
f927c5ae
JB
1034}
1035
e5d4686b 1036DEFUN ("read-command", Fread_command, Sread_command, 1, 2, 0,
af52c32d 1037 doc: /* Read the name of a command and return as a symbol.
2e3148e2
JL
1038Prompt with PROMPT. By default, return DEFAULT-VALUE or its first element
1039if it is a list. */)
5842a27b 1040 (Lisp_Object prompt, Lisp_Object default_value)
f927c5ae 1041{
7c8d9931
RS
1042 Lisp_Object name, default_string;
1043
1044 if (NILP (default_value))
1045 default_string = Qnil;
1046 else if (SYMBOLP (default_value))
caa4733e 1047 default_string = SYMBOL_NAME (default_value);
7c8d9931
RS
1048 else
1049 default_string = default_value;
9ab4a725 1050
7c8d9931
RS
1051 name = Fcompleting_read (prompt, Vobarray, Qcommandp, Qt,
1052 Qnil, Qnil, default_string, Qnil);
1053 if (NILP (name))
1054 return name;
1055 return Fintern (name, Qnil);
f927c5ae
JB
1056}
1057
1058#ifdef NOTDEF
1059DEFUN ("read-function", Fread_function, Sread_function, 1, 1, 0,
af52c32d 1060 doc: /* One arg PROMPT, a string. Read the name of a function and return as a symbol.
fd771ceb 1061Prompt with PROMPT. */)
5842a27b 1062 (Lisp_Object prompt)
f927c5ae 1063{
cee54539 1064 return Fintern (Fcompleting_read (prompt, Vobarray, Qfboundp, Qt, Qnil, Qnil, Qnil, Qnil),
f927c5ae
JB
1065 Qnil);
1066}
1067#endif /* NOTDEF */
1068
a7ca3326 1069DEFUN ("read-variable", Fread_variable, Sread_variable, 1, 2, 0,
af52c32d 1070 doc: /* Read the name of a user variable and return it as a symbol.
2e3148e2
JL
1071Prompt with PROMPT. By default, return DEFAULT-VALUE or its first element
1072if it is a list.
316f9bfc 1073A user variable is one for which `user-variable-p' returns non-nil. */)
5842a27b 1074 (Lisp_Object prompt, Lisp_Object default_value)
f927c5ae 1075{
7c8d9931
RS
1076 Lisp_Object name, default_string;
1077
1078 if (NILP (default_value))
1079 default_string = Qnil;
1080 else if (SYMBOLP (default_value))
caa4733e 1081 default_string = SYMBOL_NAME (default_value);
7c8d9931
RS
1082 else
1083 default_string = default_value;
9ab4a725 1084
7c8d9931
RS
1085 name = Fcompleting_read (prompt, Vobarray,
1086 Quser_variable_p, Qt,
1087 Qnil, Qnil, default_string, Qnil);
1088 if (NILP (name))
1089 return name;
1090 return Fintern (name, Qnil);
f927c5ae
JB
1091}
1092
a7ca3326 1093DEFUN ("read-buffer", Fread_buffer, Sread_buffer, 1, 3, 0,
fd771ceb
PJ
1094 doc: /* Read the name of a buffer and return as a string.
1095Prompt with PROMPT.
a1f17501 1096Optional second arg DEF is value to return if user enters an empty line.
2e3148e2 1097 If DEF is a list of default values, return its first element.
5fedada7
CY
1098Optional third arg REQUIRE-MATCH determines whether non-existing
1099 buffer names are allowed. It has the same meaning as the
a2a0d36b 1100 REQUIRE-MATCH argument of `completing-read'.
33df281c
CY
1101The argument PROMPT should be a string ending with a colon and a space.
1102If `read-buffer-completion-ignore-case' is non-nil, completion ignores
1103case while reading the buffer name.
1104If `read-buffer-function' is non-nil, this works by calling it as a
1105function, instead of the usual behavior. */)
5842a27b 1106 (Lisp_Object prompt, Lisp_Object def, Lisp_Object require_match)
f927c5ae 1107{
33df281c 1108 Lisp_Object args[4], result;
637de37e 1109 char *s;
97c3e4cc 1110 int len;
33df281c 1111 int count = SPECPDL_INDEX ();
9ab4a725 1112
7510b296 1113 if (BUFFERP (def))
4b4deea2 1114 def = BVAR (XBUFFER (def), name);
eebbfb01 1115
33df281c
CY
1116 specbind (Qcompletion_ignore_case,
1117 read_buffer_completion_ignore_case ? Qt : Qnil);
1118
eebbfb01
KH
1119 if (NILP (Vread_buffer_function))
1120 {
1121 if (!NILP (def))
1122 {
97c3e4cc
RF
1123 /* A default value was provided: we must change PROMPT,
1124 editing the default value in before the colon. To achieve
1125 this, we replace PROMPT with a substring that doesn't
1126 contain the terminal space and colon (if present). They
1127 are then added back using Fformat. */
1128
1129 if (STRINGP (prompt))
1130 {
637de37e 1131 s = SSDATA (prompt);
97c3e4cc
RF
1132 len = strlen (s);
1133 if (len >= 2 && s[len - 2] == ':' && s[len - 1] == ' ')
1134 len = len - 2;
1135 else if (len >= 1 && (s[len - 1] == ':' || s[len - 1] == ' '))
1136 len--;
1137
1138 prompt = make_specified_string (s, -1, len,
1139 STRING_MULTIBYTE (prompt));
1140 }
1141
1142 args[0] = build_string ("%s (default %s): ");
eebbfb01 1143 args[1] = prompt;
fb30dfd2 1144 args[2] = CONSP (def) ? XCAR (def) : def;
eebbfb01
KH
1145 prompt = Fformat (3, args);
1146 }
1147
33df281c 1148 result = Fcompleting_read (prompt, intern ("internal-complete-buffer"),
620c53a6
SM
1149 Qnil, require_match, Qnil,
1150 Qbuffer_name_history, def, Qnil);
eebbfb01
KH
1151 }
1152 else
f927c5ae 1153 {
eebbfb01 1154 args[0] = Vread_buffer_function;
f927c5ae
JB
1155 args[1] = prompt;
1156 args[2] = def;
eebbfb01 1157 args[3] = require_match;
fd6fa53f 1158 result = Ffuncall (4, args);
f927c5ae 1159 }
33df281c 1160 return unbind_to (count, result);
f927c5ae
JB
1161}
1162\f
ec067ec7 1163static Lisp_Object
971de7fb 1164minibuf_conform_representation (Lisp_Object string, Lisp_Object basis)
ec067ec7
RS
1165{
1166 if (STRING_MULTIBYTE (string) == STRING_MULTIBYTE (basis))
1167 return string;
1168
1169 if (STRING_MULTIBYTE (string))
1170 return Fstring_make_unibyte (string);
1171 else
1172 return Fstring_make_multibyte (string);
1173}
1174
f927c5ae 1175DEFUN ("try-completion", Ftry_completion, Stry_completion, 2, 3, 0,
a284cdbb
RS
1176 doc: /* Return common substring of all completions of STRING in COLLECTION.
1177Test each possible completion specified by COLLECTION
1178to see if it begins with STRING. The possible completions may be
3809648a
KS
1179strings or symbols. Symbols are converted to strings before testing,
1180see `symbol-name'.
a284cdbb
RS
1181All that match STRING are compared together; the longest initial sequence
1182common to all these matches is the return value.
1183If there is no match at all, the return value is nil.
1184For a unique match which is exact, the return value is t.
1185
1186If COLLECTION is an alist, the keys (cars of elements) are the
1187possible completions. If an element is not a cons cell, then the
1188element itself is the possible completion.
1189If COLLECTION is a hash-table, all the keys that are strings or symbols
1190are the possible completions.
1191If COLLECTION is an obarray, the names of all symbols in the obarray
1192are the possible completions.
1193
1194COLLECTION can also be a function to do the completion itself.
a1f17501
PJ
1195It receives three arguments: the values STRING, PREDICATE and nil.
1196Whatever it returns becomes the value of `try-completion'.
1197
1198If optional third argument PREDICATE is non-nil,
1199it is used to test each possible match.
1200The match is a candidate only if PREDICATE returns non-nil.
1201The argument given to PREDICATE is the alist element
a284cdbb 1202or the symbol from the obarray. If COLLECTION is a hash-table,
85cd4372 1203predicate is called with two arguments: the key and the value.
a1f17501 1204Additionally to this predicate, `completion-regexp-list'
af52c32d 1205is used to further constrain the set of candidates. */)
5842a27b 1206 (Lisp_Object string, Lisp_Object collection, Lisp_Object predicate)
f927c5ae
JB
1207{
1208 Lisp_Object bestmatch, tail, elt, eltstring;
af2b7cd5 1209 /* Size in bytes of BESTMATCH. */
6bbd7a29 1210 int bestmatchsize = 0;
af2b7cd5 1211 /* These are in bytes, too. */
f927c5ae 1212 int compare, matchsize;
f6d4c7a4
RS
1213 enum { function_table, list_table, obarray_table, hash_table}
1214 type = (HASH_TABLE_P (collection) ? hash_table
1215 : VECTORP (collection) ? obarray_table
1216 : ((NILP (collection)
1217 || (CONSP (collection)
1218 && (!SYMBOLP (XCAR (collection))
1219 || NILP (XCAR (collection)))))
1220 ? list_table : function_table));
0de4bb68 1221 EMACS_INT idx = 0, obsize = 0;
f927c5ae 1222 int matchcount = 0;
acd81db9 1223 int bindcount = -1;
f927c5ae
JB
1224 Lisp_Object bucket, zero, end, tem;
1225 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
1226
b7826503 1227 CHECK_STRING (string);
f6d4c7a4 1228 if (type == function_table)
a284cdbb 1229 return call3 (collection, string, predicate, Qnil);
f927c5ae 1230
6bbd7a29 1231 bestmatch = bucket = Qnil;
c8ae863b 1232 zero = make_number (0);
f927c5ae 1233
a284cdbb
RS
1234 /* If COLLECTION is not a list, set TAIL just for gc pro. */
1235 tail = collection;
f6d4c7a4 1236 if (type == obarray_table)
f927c5ae 1237 {
a284cdbb 1238 collection = check_obarray (collection);
77b37c05 1239 obsize = ASIZE (collection);
62137a95 1240 bucket = XVECTOR (collection)->contents[idx];
f927c5ae
JB
1241 }
1242
1243 while (1)
1244 {
fd6fa53f
SM
1245 /* Get the next element of the alist, obarray, or hash-table. */
1246 /* Exit the loop if the elements are all used up. */
f927c5ae 1247 /* elt gets the alist element or symbol.
fd6fa53f 1248 eltstring gets the name to check as a completion. */
f927c5ae 1249
f6d4c7a4 1250 if (type == list_table)
f927c5ae 1251 {
695deb18 1252 if (!CONSP (tail))
f927c5ae 1253 break;
695deb18
SM
1254 elt = XCAR (tail);
1255 eltstring = CONSP (elt) ? XCAR (elt) : elt;
1256 tail = XCDR (tail);
f927c5ae 1257 }
f6d4c7a4 1258 else if (type == obarray_table)
f927c5ae 1259 {
c8ae863b 1260 if (!EQ (bucket, zero))
f927c5ae 1261 {
9b6b374a
JB
1262 if (!SYMBOLP (bucket))
1263 error ("Bad data in guts of obarray");
f927c5ae 1264 elt = bucket;
3809648a 1265 eltstring = elt;
f927c5ae
JB
1266 if (XSYMBOL (bucket)->next)
1267 XSETSYMBOL (bucket, XSYMBOL (bucket)->next);
1268 else
5a866662 1269 XSETFASTINT (bucket, 0);
f927c5ae 1270 }
62137a95 1271 else if (++idx >= obsize)
f927c5ae
JB
1272 break;
1273 else
1274 {
62137a95 1275 bucket = XVECTOR (collection)->contents[idx];
f927c5ae
JB
1276 continue;
1277 }
1278 }
f6d4c7a4 1279 else /* if (type == hash_table) */
85cd4372 1280 {
62137a95
PE
1281 while (idx < HASH_TABLE_SIZE (XHASH_TABLE (collection))
1282 && NILP (HASH_HASH (XHASH_TABLE (collection), idx)))
1283 idx++;
1284 if (idx >= HASH_TABLE_SIZE (XHASH_TABLE (collection)))
85cd4372
SM
1285 break;
1286 else
62137a95 1287 elt = eltstring = HASH_KEY (XHASH_TABLE (collection), idx++);
85cd4372 1288 }
f927c5ae 1289
fd6fa53f 1290 /* Is this element a possible completion? */
f927c5ae 1291
3809648a
KS
1292 if (SYMBOLP (eltstring))
1293 eltstring = Fsymbol_name (eltstring);
1294
7510b296 1295 if (STRINGP (eltstring)
d5db4077 1296 && SCHARS (string) <= SCHARS (eltstring)
c8ae863b 1297 && (tem = Fcompare_strings (eltstring, zero,
d5db4077 1298 make_number (SCHARS (string)),
c8ae863b 1299 string, zero, Qnil,
6b61353c 1300 completion_ignore_case ? Qt : Qnil),
69f4ef20 1301 EQ (Qt, tem)))
f927c5ae 1302 {
fd6fa53f 1303 /* Yes. */
42006772 1304 Lisp_Object regexps;
42006772
RS
1305
1306 /* Ignore this element if it fails to match all the regexps. */
6b61353c 1307 {
6b61353c
KH
1308 for (regexps = Vcompletion_regexp_list; CONSP (regexps);
1309 regexps = XCDR (regexps))
1310 {
acd81db9
DK
1311 if (bindcount < 0) {
1312 bindcount = SPECPDL_INDEX ();
1313 specbind (Qcase_fold_search,
1314 completion_ignore_case ? Qt : Qnil);
77443789 1315 }
6b61353c
KH
1316 tem = Fstring_match (XCAR (regexps), eltstring, zero);
1317 if (NILP (tem))
1318 break;
1319 }
6b61353c
KH
1320 if (CONSP (regexps))
1321 continue;
1322 }
42006772 1323
f927c5ae 1324 /* Ignore this element if there is a predicate
fd6fa53f 1325 and the predicate doesn't like it. */
f927c5ae 1326
7efd36fc 1327 if (!NILP (predicate))
f927c5ae 1328 {
7efd36fc 1329 if (EQ (predicate, Qcommandp))
c837f4f9 1330 tem = Fcommandp (elt, Qnil);
f927c5ae
JB
1331 else
1332 {
f6d4c7a4
RS
1333 if (bindcount >= 0)
1334 {
1335 unbind_to (bindcount, Qnil);
1336 bindcount = -1;
1337 }
f927c5ae 1338 GCPRO4 (tail, string, eltstring, bestmatch);
f6d4c7a4
RS
1339 tem = (type == hash_table
1340 ? call2 (predicate, elt,
1341 HASH_VALUE (XHASH_TABLE (collection),
62137a95 1342 idx - 1))
f6d4c7a4 1343 : call1 (predicate, elt));
f927c5ae
JB
1344 UNGCPRO;
1345 }
56a98455 1346 if (NILP (tem)) continue;
f927c5ae
JB
1347 }
1348
1349 /* Update computation of how much all possible completions match */
1350
56a98455 1351 if (NILP (bestmatch))
af2b7cd5 1352 {
85cd4372 1353 matchcount = 1;
af2b7cd5 1354 bestmatch = eltstring;
d5db4077 1355 bestmatchsize = SCHARS (eltstring);
af2b7cd5 1356 }
f927c5ae
JB
1357 else
1358 {
d5db4077 1359 compare = min (bestmatchsize, SCHARS (eltstring));
c8ae863b 1360 tem = Fcompare_strings (bestmatch, zero,
69f4ef20 1361 make_number (compare),
c8ae863b 1362 eltstring, zero,
69f4ef20
RS
1363 make_number (compare),
1364 completion_ignore_case ? Qt : Qnil);
1365 if (EQ (tem, Qt))
1366 matchsize = compare;
1367 else if (XINT (tem) < 0)
1368 matchsize = - XINT (tem) - 1;
1369 else
1370 matchsize = XINT (tem) - 1;
1371
52b14ac0
JB
1372 if (completion_ignore_case)
1373 {
1374 /* If this is an exact match except for case,
1375 use it as the best match rather than one that is not an
1376 exact match. This way, we get the case pattern
1377 of the actual match. */
d5db4077
KR
1378 if ((matchsize == SCHARS (eltstring)
1379 && matchsize < SCHARS (bestmatch))
52b14ac0
JB
1380 ||
1381 /* If there is more than one exact match ignoring case,
1382 and one of them is exact including case,
1383 prefer that one. */
1384 /* If there is no exact match ignoring case,
1385 prefer a match that does not change the case
1386 of the input. */
d5db4077 1387 ((matchsize == SCHARS (eltstring))
52b14ac0 1388 ==
d5db4077 1389 (matchsize == SCHARS (bestmatch))
c8ae863b 1390 && (tem = Fcompare_strings (eltstring, zero,
d5db4077 1391 make_number (SCHARS (string)),
c8ae863b 1392 string, zero,
69f4ef20
RS
1393 Qnil,
1394 Qnil),
1395 EQ (Qt, tem))
c8ae863b 1396 && (tem = Fcompare_strings (bestmatch, zero,
d5db4077 1397 make_number (SCHARS (string)),
c8ae863b 1398 string, zero,
69f4ef20
RS
1399 Qnil,
1400 Qnil),
1401 ! EQ (Qt, tem))))
52b14ac0
JB
1402 bestmatch = eltstring;
1403 }
d5db4077 1404 if (bestmatchsize != SCHARS (eltstring)
85cd4372
SM
1405 || bestmatchsize != matchsize)
1406 /* Don't count the same string multiple times. */
1407 matchcount++;
52b14ac0 1408 bestmatchsize = matchsize;
d5db4077 1409 if (matchsize <= SCHARS (string)
78893e05
CY
1410 /* If completion-ignore-case is non-nil, don't
1411 short-circuit because we want to find the best
1412 possible match *including* case differences. */
1413 && !completion_ignore_case
695deb18
SM
1414 && matchcount > 1)
1415 /* No need to look any further. */
1416 break;
f927c5ae
JB
1417 }
1418 }
1419 }
1420
acd81db9
DK
1421 if (bindcount >= 0) {
1422 unbind_to (bindcount, Qnil);
1423 bindcount = -1;
1424 }
1425
56a98455 1426 if (NILP (bestmatch))
fd6fa53f 1427 return Qnil; /* No completions found. */
52b14ac0
JB
1428 /* If we are ignoring case, and there is no exact match,
1429 and no additional text was supplied,
1430 don't change the case of what the user typed. */
d5db4077
KR
1431 if (completion_ignore_case && bestmatchsize == SCHARS (string)
1432 && SCHARS (bestmatch) > bestmatchsize)
ec067ec7 1433 return minibuf_conform_representation (string, bestmatch);
52b14ac0
JB
1434
1435 /* Return t if the supplied string is an exact match (counting case);
1436 it does not require any change to be made. */
928b5acc 1437 if (matchcount == 1 && !NILP (Fequal (bestmatch, string)))
f927c5ae
JB
1438 return Qt;
1439
5a866662 1440 XSETFASTINT (zero, 0); /* Else extract the part in which */
fd6fa53f 1441 XSETFASTINT (end, bestmatchsize); /* all completions agree. */
f927c5ae
JB
1442 return Fsubstring (bestmatch, zero, end);
1443}
f927c5ae 1444\f
89a255dc 1445DEFUN ("all-completions", Fall_completions, Sall_completions, 2, 4, 0,
a284cdbb
RS
1446 doc: /* Search for partial matches to STRING in COLLECTION.
1447Test each of the possible completions specified by COLLECTION
1448to see if it begins with STRING. The possible completions may be
3809648a
KS
1449strings or symbols. Symbols are converted to strings before testing,
1450see `symbol-name'.
a284cdbb 1451The value is a list of all the possible completions that match STRING.
a1f17501 1452
a284cdbb
RS
1453If COLLECTION is an alist, the keys (cars of elements) are the
1454possible completions. If an element is not a cons cell, then the
1455element itself is the possible completion.
1456If COLLECTION is a hash-table, all the keys that are strings or symbols
1457are the possible completions.
1458If COLLECTION is an obarray, the names of all symbols in the obarray
1459are the possible completions.
a1f17501 1460
a284cdbb 1461COLLECTION can also be a function to do the completion itself.
a1f17501
PJ
1462It receives three arguments: the values STRING, PREDICATE and t.
1463Whatever it returns becomes the value of `all-completions'.
1464
1465If optional third argument PREDICATE is non-nil,
1466it is used to test each possible match.
1467The match is a candidate only if PREDICATE returns non-nil.
1468The argument given to PREDICATE is the alist element
a284cdbb 1469or the symbol from the obarray. If COLLECTION is a hash-table,
85cd4372 1470predicate is called with two arguments: the key and the value.
a1f17501
PJ
1471Additionally to this predicate, `completion-regexp-list'
1472is used to further constrain the set of candidates.
1473
782a943e 1474An obsolete optional fourth argument HIDE-SPACES is still accepted for
057bce6f 1475backward compatibility. If non-nil, strings in COLLECTION that start
4fcc3d32 1476with a space are ignored unless STRING itself starts with a space. */)
5842a27b 1477 (Lisp_Object string, Lisp_Object collection, Lisp_Object predicate, Lisp_Object hide_spaces)
f927c5ae
JB
1478{
1479 Lisp_Object tail, elt, eltstring;
1480 Lisp_Object allmatches;
a284cdbb
RS
1481 int type = HASH_TABLE_P (collection) ? 3
1482 : VECTORP (collection) ? 2
1483 : NILP (collection) || (CONSP (collection)
1484 && (!SYMBOLP (XCAR (collection))
1485 || NILP (XCAR (collection))));
0de4bb68 1486 EMACS_INT idx = 0, obsize = 0;
acd81db9 1487 int bindcount = -1;
c8ae863b 1488 Lisp_Object bucket, tem, zero;
f927c5ae
JB
1489 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
1490
b7826503 1491 CHECK_STRING (string);
85cd4372 1492 if (type == 0)
a284cdbb 1493 return call3 (collection, string, predicate, Qt);
6bbd7a29 1494 allmatches = bucket = Qnil;
c8ae863b 1495 zero = make_number (0);
f927c5ae 1496
a284cdbb
RS
1497 /* If COLLECTION is not a list, set TAIL just for gc pro. */
1498 tail = collection;
85cd4372 1499 if (type == 2)
f927c5ae 1500 {
373bf2b7 1501 collection = check_obarray (collection);
77b37c05 1502 obsize = ASIZE (collection);
62137a95 1503 bucket = XVECTOR (collection)->contents[idx];
f927c5ae
JB
1504 }
1505
1506 while (1)
1507 {
fd6fa53f
SM
1508 /* Get the next element of the alist, obarray, or hash-table. */
1509 /* Exit the loop if the elements are all used up. */
f927c5ae 1510 /* elt gets the alist element or symbol.
fd6fa53f 1511 eltstring gets the name to check as a completion. */
f927c5ae 1512
85cd4372 1513 if (type == 1)
f927c5ae 1514 {
695deb18 1515 if (!CONSP (tail))
f927c5ae 1516 break;
695deb18
SM
1517 elt = XCAR (tail);
1518 eltstring = CONSP (elt) ? XCAR (elt) : elt;
1519 tail = XCDR (tail);
f927c5ae 1520 }
85cd4372 1521 else if (type == 2)
f927c5ae 1522 {
373bf2b7 1523 if (!EQ (bucket, zero))
f927c5ae 1524 {
373bf2b7
AS
1525 if (!SYMBOLP (bucket))
1526 error ("Bad data in guts of obarray");
f927c5ae 1527 elt = bucket;
3809648a 1528 eltstring = elt;
f927c5ae
JB
1529 if (XSYMBOL (bucket)->next)
1530 XSETSYMBOL (bucket, XSYMBOL (bucket)->next);
1531 else
5a866662 1532 XSETFASTINT (bucket, 0);
f927c5ae 1533 }
62137a95 1534 else if (++idx >= obsize)
f927c5ae
JB
1535 break;
1536 else
1537 {
62137a95 1538 bucket = XVECTOR (collection)->contents[idx];
f927c5ae
JB
1539 continue;
1540 }
1541 }
85cd4372
SM
1542 else /* if (type == 3) */
1543 {
62137a95
PE
1544 while (idx < HASH_TABLE_SIZE (XHASH_TABLE (collection))
1545 && NILP (HASH_HASH (XHASH_TABLE (collection), idx)))
1546 idx++;
1547 if (idx >= HASH_TABLE_SIZE (XHASH_TABLE (collection)))
85cd4372
SM
1548 break;
1549 else
62137a95 1550 elt = eltstring = HASH_KEY (XHASH_TABLE (collection), idx++);
85cd4372 1551 }
f927c5ae 1552
fd6fa53f 1553 /* Is this element a possible completion? */
f927c5ae 1554
3809648a
KS
1555 if (SYMBOLP (eltstring))
1556 eltstring = Fsymbol_name (eltstring);
1557
7510b296 1558 if (STRINGP (eltstring)
d5db4077 1559 && SCHARS (string) <= SCHARS (eltstring)
89a255dc 1560 /* If HIDE_SPACES, reject alternatives that start with space
2cbaf886 1561 unless the input starts with space. */
11e3c684
CY
1562 && (NILP (hide_spaces)
1563 || (SBYTES (string) > 0
1564 && SREF (string, 0) == ' ')
1565 || SREF (eltstring, 0) != ' ')
c8ae863b 1566 && (tem = Fcompare_strings (eltstring, zero,
d5db4077 1567 make_number (SCHARS (string)),
c8ae863b 1568 string, zero,
d5db4077 1569 make_number (SCHARS (string)),
69f4ef20
RS
1570 completion_ignore_case ? Qt : Qnil),
1571 EQ (Qt, tem)))
f927c5ae 1572 {
fd6fa53f 1573 /* Yes. */
42006772 1574 Lisp_Object regexps;
42006772
RS
1575
1576 /* Ignore this element if it fails to match all the regexps. */
6b61353c 1577 {
6b61353c
KH
1578 for (regexps = Vcompletion_regexp_list; CONSP (regexps);
1579 regexps = XCDR (regexps))
1580 {
acd81db9
DK
1581 if (bindcount < 0) {
1582 bindcount = SPECPDL_INDEX ();
1583 specbind (Qcase_fold_search,
1584 completion_ignore_case ? Qt : Qnil);
77443789 1585 }
6b61353c
KH
1586 tem = Fstring_match (XCAR (regexps), eltstring, zero);
1587 if (NILP (tem))
1588 break;
1589 }
6b61353c
KH
1590 if (CONSP (regexps))
1591 continue;
1592 }
42006772 1593
f927c5ae 1594 /* Ignore this element if there is a predicate
fd6fa53f 1595 and the predicate doesn't like it. */
f927c5ae 1596
7efd36fc 1597 if (!NILP (predicate))
f927c5ae 1598 {
7efd36fc 1599 if (EQ (predicate, Qcommandp))
c837f4f9 1600 tem = Fcommandp (elt, Qnil);
f927c5ae
JB
1601 else
1602 {
acd81db9
DK
1603 if (bindcount >= 0) {
1604 unbind_to (bindcount, Qnil);
1605 bindcount = -1;
1606 }
f927c5ae 1607 GCPRO4 (tail, eltstring, allmatches, string);
85cd4372
SM
1608 tem = type == 3
1609 ? call2 (predicate, elt,
62137a95 1610 HASH_VALUE (XHASH_TABLE (collection), idx - 1))
85cd4372 1611 : call1 (predicate, elt);
f927c5ae
JB
1612 UNGCPRO;
1613 }
56a98455 1614 if (NILP (tem)) continue;
f927c5ae 1615 }
fd6fa53f 1616 /* Ok => put it on the list. */
f927c5ae
JB
1617 allmatches = Fcons (eltstring, allmatches);
1618 }
1619 }
1620
acd81db9
DK
1621 if (bindcount >= 0) {
1622 unbind_to (bindcount, Qnil);
1623 bindcount = -1;
1624 }
1625
f927c5ae
JB
1626 return Fnreverse (allmatches);
1627}
1628\f
a7ca3326 1629DEFUN ("completing-read", Fcompleting_read, Scompleting_read, 2, 8, 0,
af52c32d 1630 doc: /* Read a string in the minibuffer, with completion.
a1f17501 1631PROMPT is a string to prompt with; normally it ends in a colon and a space.
a284cdbb
RS
1632COLLECTION can be a list of strings, an alist, an obarray or a hash table.
1633COLLECTION can also be a function to do the completion itself.
1634PREDICATE limits completion to a subset of COLLECTION.
a1f17501 1635See `try-completion' and `all-completions' for more details
a284cdbb 1636 on completion, COLLECTION, and PREDICATE.
a1f17501 1637
4d02fc25
SM
1638REQUIRE-MATCH can take the following values:
1639- t means that the user is not allowed to exit unless
1640 the input is (or completes to) an element of COLLECTION or is null.
1641- nil means that the user can exit with any input.
b47d0e56
CY
1642- `confirm' means that the user can exit with any input, but she needs
1643 to confirm her choice if the input is not an element of COLLECTION.
1644- `confirm-after-completion' means that the user can exit with any
1645 input, but she needs to confirm her choice if she called
1646 `minibuffer-complete' right before `minibuffer-complete-and-exit'
1647 and the input is not an element of COLLECTION.
4d02fc25
SM
1648- anything else behaves like t except that typing RET does not exit if it
1649 does non-null completion.
1650
2e3148e2
JL
1651If the input is null, `completing-read' returns DEF, or the first element
1652of the list of default values, or an empty string if DEF is nil,
1653regardless of the value of REQUIRE-MATCH.
6b61353c
KH
1654
1655If INITIAL-INPUT is non-nil, insert it in the minibuffer initially,
1656 with point positioned at the end.
1657 If it is (STRING . POSITION), the initial input is STRING, but point
1658 is placed at _zero-indexed_ position POSITION in STRING. (*Note*
1659 that this is different from `read-from-minibuffer' and related
1660 functions, which use one-indexing for POSITION.) This feature is
1661 deprecated--it is best to pass nil for INITIAL-INPUT and supply the
1662 default value DEF instead. The user can yank the default value into
1663 the minibuffer easily using \\[next-history-element].
1664
1665HIST, if non-nil, specifies a history list and optionally the initial
1666 position in the list. It can be a symbol, which is the history list
1667 variable to use, or it can be a cons cell (HISTVAR . HISTPOS). In
1668 that case, HISTVAR is the history list variable to use, and HISTPOS
1669 is the initial position (the position in the list used by the
1670 minibuffer history commands). For consistency, you should also
1671 specify that element of the history as the value of
1fb101f3 1672 INITIAL-INPUT. (This is the only case in which you should use
6b61353c
KH
1673 INITIAL-INPUT instead of DEF.) Positions are counted starting from
1674 1 at the beginning of the list. The variable `history-length'
1675 controls the maximum length of a history list.
38668f81 1676
2e3148e2 1677DEF, if non-nil, is the default value or the list of default values.
a1f17501
PJ
1678
1679If INHERIT-INPUT-METHOD is non-nil, the minibuffer inherits
029a305c 1680 the current input method and the setting of `enable-multibyte-characters'.
a1f17501
PJ
1681
1682Completion ignores case if the ambient value of
3ec03f7e
LL
1683 `completion-ignore-case' is non-nil.
1684
1685See also `completing-read-function'. */)
1686 (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)
1687{
1688 Lisp_Object args[9];
1689 args[0] = Vcompleting_read_function;
1690 args[1] = prompt;
1691 args[2] = collection;
1692 args[3] = predicate;
1693 args[4] = require_match;
1694 args[5] = initial_input;
1695 args[6] = hist;
1696 args[7] = def;
1697 args[8] = inherit_input_method;
1698 return Ffuncall (9, args);
1699}
1700
1701DEFUN ("completing-read-default", Fcompleting_read_default, Scompleting_read_default, 2, 8, 0,
1702 doc: /* Default method for reading from the minibuffer with completion.
1703See `completing-read' for the meaning of the arguments. */)
5842a27b 1704 (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 1705{
770970cb 1706 Lisp_Object val, histvar, histpos, position;
d43f85c2 1707 Lisp_Object init;
770970cb 1708 int pos = 0;
aed13378 1709 int count = SPECPDL_INDEX ();
0c8ee1a2
RS
1710 struct gcpro gcpro1;
1711
d43f85c2 1712 init = initial_input;
0c8ee1a2
RS
1713 GCPRO1 (def);
1714
a284cdbb 1715 specbind (Qminibuffer_completion_table, collection);
7efd36fc 1716 specbind (Qminibuffer_completion_predicate, predicate);
f927c5ae 1717 specbind (Qminibuffer_completion_confirm,
695deb18 1718 EQ (require_match, Qt) ? Qnil : require_match);
770970cb
RS
1719
1720 position = Qnil;
1721 if (!NILP (init))
1722 {
7510b296 1723 if (CONSP (init))
770970cb
RS
1724 {
1725 position = Fcdr (init);
1726 init = Fcar (init);
1727 }
b7826503 1728 CHECK_STRING (init);
770970cb
RS
1729 if (!NILP (position))
1730 {
b7826503 1731 CHECK_NUMBER (position);
770970cb 1732 /* Convert to distance from end of input. */
d5db4077 1733 pos = XINT (position) - SCHARS (init);
770970cb
RS
1734 }
1735 }
1736
7510b296 1737 if (SYMBOLP (hist))
770970cb
RS
1738 {
1739 histvar = hist;
1740 histpos = Qnil;
1741 }
1742 else
1743 {
1744 histvar = Fcar_safe (hist);
1745 histpos = Fcdr_safe (hist);
1746 }
1747 if (NILP (histvar))
1748 histvar = Qminibuffer_history;
1749 if (NILP (histpos))
5a866662 1750 XSETFASTINT (histpos, 0);
770970cb 1751
56a98455 1752 val = read_minibuf (NILP (require_match)
bb0bdf70 1753 ? (NILP (Vminibuffer_completing_file_name)
ef72eaff 1754 || EQ (Vminibuffer_completing_file_name, Qlambda)
bb0bdf70
EZ
1755 ? Vminibuffer_local_completion_map
1756 : Vminibuffer_local_filename_completion_map)
1757 : (NILP (Vminibuffer_completing_file_name)
ef72eaff 1758 || EQ (Vminibuffer_completing_file_name, Qlambda)
bb0bdf70 1759 ? Vminibuffer_local_must_match_map
8ba31f36 1760 : Vminibuffer_local_filename_must_match_map),
85b5fe07 1761 init, prompt, make_number (pos), 0,
cee54539 1762 histvar, histpos, def, 0,
b35cd215 1763 !NILP (inherit_input_method));
b9a86585 1764
d5db4077 1765 if (STRINGP (val) && SCHARS (val) == 0 && ! NILP (def))
fb30dfd2 1766 val = CONSP (def) ? XCAR (def) : def;
b9a86585 1767
0c8ee1a2 1768 RETURN_UNGCPRO (unbind_to (count, val));
f927c5ae
JB
1769}
1770\f
971de7fb 1771Lisp_Object Fassoc_string (register Lisp_Object key, Lisp_Object list, Lisp_Object case_fold);
5d2ca7ae
RS
1772
1773/* Test whether TXT is an exact completion. */
695deb18
SM
1774DEFUN ("test-completion", Ftest_completion, Stest_completion, 2, 3, 0,
1775 doc: /* Return non-nil if STRING is a valid completion.
1776Takes the same arguments as `all-completions' and `try-completion'.
a284cdbb 1777If COLLECTION is a function, it is called with three arguments:
695deb18 1778the values STRING, PREDICATE and `lambda'. */)
5842a27b 1779 (Lisp_Object string, Lisp_Object collection, Lisp_Object predicate)
5d2ca7ae 1780{
6b61353c 1781 Lisp_Object regexps, tail, tem = Qnil;
0de4bb68 1782 EMACS_INT i = 0;
5d2ca7ae 1783
695deb18
SM
1784 CHECK_STRING (string);
1785
a284cdbb
RS
1786 if ((CONSP (collection)
1787 && (!SYMBOLP (XCAR (collection)) || NILP (XCAR (collection))))
1788 || NILP (collection))
695deb18 1789 {
a284cdbb 1790 tem = Fassoc_string (string, collection, completion_ignore_case ? Qt : Qnil);
9f4a578d 1791 if (NILP (tem))
695deb18
SM
1792 return Qnil;
1793 }
a284cdbb 1794 else if (VECTORP (collection))
5d2ca7ae 1795 {
695deb18 1796 /* Bypass intern-soft as that loses for nil. */
a284cdbb 1797 tem = oblookup (collection,
42a5b22f 1798 SSDATA (string),
d5db4077
KR
1799 SCHARS (string),
1800 SBYTES (string));
44472c88 1801 if (!SYMBOLP (tem))
9404446f 1802 {
695deb18
SM
1803 if (STRING_MULTIBYTE (string))
1804 string = Fstring_make_unibyte (string);
9404446f 1805 else
695deb18 1806 string = Fstring_make_multibyte (string);
9404446f 1807
a284cdbb 1808 tem = oblookup (collection,
42a5b22f 1809 SSDATA (string),
d5db4077
KR
1810 SCHARS (string),
1811 SBYTES (string));
9404446f 1812 }
6b61353c
KH
1813
1814 if (completion_ignore_case && !SYMBOLP (tem))
1815 {
77b37c05 1816 for (i = ASIZE (collection) - 1; i >= 0; i--)
6b61353c 1817 {
a284cdbb 1818 tail = XVECTOR (collection)->contents[i];
6b61353c
KH
1819 if (SYMBOLP (tail))
1820 while (1)
1821 {
fd6fa53f 1822 if (EQ (Fcompare_strings (string, make_number (0), Qnil,
6b61353c 1823 Fsymbol_name (tail),
fd6fa53f 1824 make_number (0) , Qnil, Qt),
6b61353c
KH
1825 Qt))
1826 {
1827 tem = tail;
1828 break;
1829 }
1830 if (XSYMBOL (tail)->next == 0)
1831 break;
1832 XSETSYMBOL (tail, XSYMBOL (tail)->next);
1833 }
1834 }
1835 }
1836
1837 if (!SYMBOLP (tem))
1838 return Qnil;
5d2ca7ae 1839 }
a284cdbb 1840 else if (HASH_TABLE_P (collection))
85cd4372 1841 {
a284cdbb 1842 struct Lisp_Hash_Table *h = XHASH_TABLE (collection);
6b61353c 1843 i = hash_lookup (h, string, NULL);
85cd4372 1844 if (i >= 0)
6b61353c 1845 tem = HASH_KEY (h, i);
85cd4372 1846 else
6b61353c 1847 for (i = 0; i < HASH_TABLE_SIZE (h); ++i)
fd6fa53f
SM
1848 if (!NILP (HASH_HASH (h, i))
1849 && EQ (Fcompare_strings (string, make_number (0), Qnil,
1850 HASH_KEY (h, i), make_number (0) , Qnil,
1851 completion_ignore_case ? Qt : Qnil),
1852 Qt))
6b61353c
KH
1853 {
1854 tem = HASH_KEY (h, i);
1855 break;
1856 }
1857 if (!STRINGP (tem))
85cd4372
SM
1858 return Qnil;
1859 }
5d2ca7ae 1860 else
a284cdbb 1861 return call3 (collection, string, predicate, Qlambda);
695deb18
SM
1862
1863 /* Reject this element if it fails to match all the regexps. */
77443789
AS
1864 if (CONSP (Vcompletion_regexp_list))
1865 {
1866 int count = SPECPDL_INDEX ();
1867 specbind (Qcase_fold_search, completion_ignore_case ? Qt : Qnil);
1868 for (regexps = Vcompletion_regexp_list; CONSP (regexps);
1869 regexps = XCDR (regexps))
1870 {
1871 if (NILP (Fstring_match (XCAR (regexps),
1872 SYMBOLP (tem) ? string : tem,
1873 Qnil)))
1874 return unbind_to (count, Qnil);
1875 }
1876 unbind_to (count, Qnil);
1877 }
695deb18
SM
1878
1879 /* Finally, check the predicate. */
1880 if (!NILP (predicate))
6b61353c 1881 {
a284cdbb
RS
1882 return HASH_TABLE_P (collection)
1883 ? call2 (predicate, tem, HASH_VALUE (XHASH_TABLE (collection), i))
6b61353c
KH
1884 : call1 (predicate, tem);
1885 }
695deb18
SM
1886 else
1887 return Qt;
5d2ca7ae 1888}
f927c5ae 1889
620c53a6
SM
1890Lisp_Object Qmetadata;
1891extern Lisp_Object Qbuffer;
1892
655ea21c
JD
1893DEFUN ("internal-complete-buffer", Finternal_complete_buffer, Sinternal_complete_buffer, 3, 3, 0,
1894 doc: /* Perform completion on buffer names.
1895If the argument FLAG is nil, invoke `try-completion', if it's t, invoke
1896`all-completions', otherwise invoke `test-completion'.
1897
ba5524f4 1898The arguments STRING and PREDICATE are as in `try-completion',
fd6fa53f 1899`all-completions', and `test-completion'. */)
5842a27b 1900 (Lisp_Object string, Lisp_Object predicate, Lisp_Object flag)
655ea21c
JD
1901{
1902 if (NILP (flag))
1903 return Ftry_completion (string, Vbuffer_alist, predicate);
1904 else if (EQ (flag, Qt))
8c2dccbf 1905 {
73913e2e 1906 Lisp_Object res = Fall_completions (string, Vbuffer_alist, predicate, Qnil);
8c2dccbf
SM
1907 if (SCHARS (string) > 0)
1908 return res;
1909 else
1910 { /* Strip out internal buffers. */
1911 Lisp_Object bufs = res;
1912 /* First, look for a non-internal buffer in `res'. */
1913 while (CONSP (bufs) && SREF (XCAR (bufs), 0) == ' ')
1914 bufs = XCDR (bufs);
1915 if (NILP (bufs))
1916 /* All bufs in `res' are internal, so don't trip them out. */
1917 return res;
1918 res = bufs;
1919 while (CONSP (XCDR (bufs)))
1920 if (SREF (XCAR (XCDR (bufs)), 0) == ' ')
1921 XSETCDR (bufs, XCDR (XCDR (bufs)));
1922 else
1923 bufs = XCDR (bufs);
1924 return res;
1925 }
1926 }
620c53a6 1927 else if (EQ (flag, Qlambda))
655ea21c 1928 return Ftest_completion (string, Vbuffer_alist, predicate);
620c53a6
SM
1929 else if (EQ (flag, Qmetadata))
1930 return Fcons (Qmetadata, Fcons (Fcons (Qcategory, Qbuffer), Qnil));
1931 else
1932 return Qnil;
655ea21c
JD
1933}
1934
52b14ac0
JB
1935/* Like assoc but assumes KEY is a string, and ignores case if appropriate. */
1936
a7ca3326 1937DEFUN ("assoc-string", Fassoc_string, Sassoc_string, 2, 3, 0,
d3fc66fb 1938 doc: /* Like `assoc' but specifically for strings (and symbols).
c6a82c18
CY
1939
1940This returns the first element of LIST whose car matches the string or
1941symbol KEY, or nil if no match exists. When performing the
1942comparison, symbols are first converted to strings, and unibyte
1943strings to multibyte. If the optional arg CASE-FOLD is non-nil, case
1944is ignored.
1945
1946Unlike `assoc', KEY can also match an entry in LIST consisting of a
1947single string, rather than a cons cell whose car is a string. */)
5842a27b 1948 (register Lisp_Object key, Lisp_Object list, Lisp_Object case_fold)
52b14ac0
JB
1949{
1950 register Lisp_Object tail;
1951
d3fc66fb
KS
1952 if (SYMBOLP (key))
1953 key = Fsymbol_name (key);
1954
99784d63 1955 for (tail = list; CONSP (tail); tail = XCDR (tail))
52b14ac0
JB
1956 {
1957 register Lisp_Object elt, tem, thiscar;
99784d63 1958 elt = XCAR (tail);
695deb18 1959 thiscar = CONSP (elt) ? XCAR (elt) : elt;
1954495f
KS
1960 if (SYMBOLP (thiscar))
1961 thiscar = Fsymbol_name (thiscar);
1962 else if (!STRINGP (thiscar))
52b14ac0 1963 continue;
9404446f
RS
1964 tem = Fcompare_strings (thiscar, make_number (0), Qnil,
1965 key, make_number (0), Qnil,
695deb18 1966 case_fold);
9404446f
RS
1967 if (EQ (tem, Qt))
1968 return elt;
52b14ac0
JB
1969 QUIT;
1970 }
1971 return Qnil;
1972}
f927c5ae 1973
e4c97a67 1974\f
f927c5ae 1975DEFUN ("minibuffer-depth", Fminibuffer_depth, Sminibuffer_depth, 0, 0, 0,
af52c32d 1976 doc: /* Return current depth of activations of minibuffer, a nonnegative integer. */)
5842a27b 1977 (void)
f927c5ae
JB
1978{
1979 return make_number (minibuf_level);
1980}
1981
37e9a934 1982DEFUN ("minibuffer-prompt", Fminibuffer_prompt, Sminibuffer_prompt, 0, 0, 0,
af52c32d
MB
1983 doc: /* Return the prompt string of the currently-active minibuffer.
1984If no minibuffer is active, return nil. */)
5842a27b 1985 (void)
37e9a934 1986{
4d04c1f1 1987 return Fcopy_sequence (minibuf_prompt);
37e9a934
KH
1988}
1989
f927c5ae 1990\f
9d815fd9 1991void
971de7fb 1992init_minibuf_once (void)
f927c5ae
JB
1993{
1994 Vminibuffer_list = Qnil;
1995 staticpro (&Vminibuffer_list);
1996}
1997
9d815fd9 1998void
971de7fb 1999syms_of_minibuf (void)
f927c5ae
JB
2000{
2001 minibuf_level = 0;
4d04c1f1
KH
2002 minibuf_prompt = Qnil;
2003 staticpro (&minibuf_prompt);
2004
2005 minibuf_save_list = Qnil;
2006 staticpro (&minibuf_save_list);
f927c5ae 2007
620c53a6
SM
2008 DEFSYM (Qcompleting_read_default, "completing-read-default");
2009 DEFSYM (Qcompletion_ignore_case, "completion-ignore-case");
2010 DEFSYM (Qread_file_name_internal, "read-file-name-internal");
2011 DEFSYM (Qminibuffer_default, "minibuffer-default");
e5d4686b
RS
2012 Fset (Qminibuffer_default, Qnil);
2013
620c53a6
SM
2014 DEFSYM (Qminibuffer_completion_table, "minibuffer-completion-table");
2015 DEFSYM (Qminibuffer_completion_confirm, "minibuffer-completion-confirm");
2016 DEFSYM (Qminibuffer_completion_predicate, "minibuffer-completion-predicate");
f927c5ae
JB
2017
2018 staticpro (&last_minibuf_string);
2019 last_minibuf_string = Qnil;
2020
620c53a6
SM
2021 DEFSYM (Quser_variable_p, "user-variable-p");
2022 DEFSYM (Qminibuffer_history, "minibuffer-history");
2023 DEFSYM (Qbuffer_name_history, "buffer-name-history");
33d0a17f 2024 Fset (Qbuffer_name_history, Qnil);
406e55df 2025
620c53a6
SM
2026 DEFSYM (Qminibuffer_setup_hook, "minibuffer-setup-hook");
2027 DEFSYM (Qminibuffer_exit_hook, "minibuffer-exit-hook");
2028 DEFSYM (Qhistory_length, "history-length");
2029 DEFSYM (Qcurrent_input_method, "current-input-method");
2030 DEFSYM (Qactivate_input_method, "activate-input-method");
2031 DEFSYM (Qcase_fold_search, "case-fold-search");
2032 DEFSYM (Qmetadata, "metadata");
6b61353c 2033
c11136ec
GM
2034 DEFVAR_LISP ("read-expression-history", Vread_expression_history,
2035 doc: /* A history list for arguments that are Lisp expressions to evaluate.
2036For example, `eval-expression' uses this. */);
2037 Vread_expression_history = Qnil;
2038
620c53a6 2039 DEFSYM (Qread_expression_history, "read-expression-history");
627fb581 2040
29208e82 2041 DEFVAR_LISP ("read-buffer-function", Vread_buffer_function,
b4f588fa
JB
2042 doc: /* If this is non-nil, `read-buffer' does its work by calling this function.
2043The function is called with the arguments passed to `read-buffer'. */);
eebbfb01
KH
2044 Vread_buffer_function = Qnil;
2045
33df281c 2046 DEFVAR_BOOL ("read-buffer-completion-ignore-case",
29208e82 2047 read_buffer_completion_ignore_case,
33df281c
CY
2048 doc: /* *Non-nil means completion ignores case when reading a buffer name. */);
2049 read_buffer_completion_ignore_case = 0;
2050
29208e82 2051 DEFVAR_LISP ("minibuffer-setup-hook", Vminibuffer_setup_hook,
af52c32d 2052 doc: /* Normal hook run just after entry to minibuffer. */);
5c781212
RS
2053 Vminibuffer_setup_hook = Qnil;
2054
29208e82 2055 DEFVAR_LISP ("minibuffer-exit-hook", Vminibuffer_exit_hook,
af52c32d 2056 doc: /* Normal hook run just after exit from minibuffer. */);
177aecf9
KH
2057 Vminibuffer_exit_hook = Qnil;
2058
29208e82 2059 DEFVAR_LISP ("history-length", Vhistory_length,
af52c32d 2060 doc: /* *Maximum length for history lists before truncation takes place.
a1f17501 2061A number means that length; t means infinite. Truncation takes place
f4b46bb9 2062just after a new element is inserted. Setting the `history-length'
a1f17501 2063property of a history variable overrides this default. */);
77aa8edf
RS
2064 XSETFASTINT (Vhistory_length, 30);
2065
29208e82 2066 DEFVAR_BOOL ("history-delete-duplicates", history_delete_duplicates,
0da4d471
JL
2067 doc: /* *Non-nil means to delete duplicates in history.
2068If set to t when adding a new history element, all previous identical
179a4ca7 2069elements are deleted from the history list. */);
0da4d471
JL
2070 history_delete_duplicates = 0;
2071
29208e82 2072 DEFVAR_LISP ("history-add-new-input", Vhistory_add_new_input,
179a4ca7
JL
2073 doc: /* *Non-nil means to add new elements in history.
2074If set to nil, minibuffer reading functions don't add new elements to the
2075history list, so it is possible to do this afterwards by calling
2076`add-to-history' explicitly. */);
2077 Vhistory_add_new_input = Qt;
2078
29208e82 2079 DEFVAR_BOOL ("completion-ignore-case", completion_ignore_case,
75028673 2080 doc: /* Non-nil means don't consider case significant in completion.
f562df03
CY
2081For file-name completion, `read-file-name-completion-ignore-case'
2082controls the behavior, rather than this variable.
2083For buffer name completion, `read-buffer-completion-ignore-case'
d9a03ad2 2084controls the behavior, rather than this variable. */);
f927c5ae
JB
2085 completion_ignore_case = 0;
2086
29208e82 2087 DEFVAR_BOOL ("enable-recursive-minibuffers", enable_recursive_minibuffers,
af52c32d 2088 doc: /* *Non-nil means to allow minibuffer commands while in the minibuffer.
a1f17501 2089This variable makes a difference whenever the minibuffer window is active. */);
f927c5ae
JB
2090 enable_recursive_minibuffers = 0;
2091
29208e82 2092 DEFVAR_LISP ("minibuffer-completion-table", Vminibuffer_completion_table,
af52c32d 2093 doc: /* Alist or obarray used for completion in the minibuffer.
6b61353c
KH
2094This becomes the ALIST argument to `try-completion' and `all-completions'.
2095The value can also be a list of strings or a hash table.
a1f17501
PJ
2096
2097The value may alternatively be a function, which is given three arguments:
2098 STRING, the current buffer contents;
2099 PREDICATE, the predicate for filtering possible matches;
2100 CODE, which says what kind of things to do.
b2ef9714
JB
2101CODE can be nil, t or `lambda':
2102 nil -- return the best completion of STRING, or nil if there is none.
2103 t -- return a list of all possible completions of STRING.
2104 lambda -- return t if STRING is a valid completion as it stands. */);
f927c5ae
JB
2105 Vminibuffer_completion_table = Qnil;
2106
29208e82 2107 DEFVAR_LISP ("minibuffer-completion-predicate", Vminibuffer_completion_predicate,
af52c32d 2108 doc: /* Within call to `completing-read', this holds the PREDICATE argument. */);
f927c5ae
JB
2109 Vminibuffer_completion_predicate = Qnil;
2110
29208e82 2111 DEFVAR_LISP ("minibuffer-completion-confirm", Vminibuffer_completion_confirm,
b47d0e56
CY
2112 doc: /* Whether to demand confirmation of completion before exiting minibuffer.
2113If nil, confirmation is not required.
2114If the value is `confirm', the user may exit with an input that is not
2115 a valid completion alternative, but Emacs asks for confirmation.
2116If the value is `confirm-after-completion', the user may exit with an
2117 input that is not a valid completion alternative, but Emacs asks for
1b79e224
CY
2118 confirmation if the user submitted the input right after any of the
2119 completion commands listed in `minibuffer-confirm-exit-commands'. */);
f927c5ae
JB
2120 Vminibuffer_completion_confirm = Qnil;
2121
ccf330a6 2122 DEFVAR_LISP ("minibuffer-completing-file-name",
29208e82 2123 Vminibuffer_completing_file_name,
6ddfc113 2124 doc: /* Non-nil means completing file names. */);
ccf330a6
RS
2125 Vminibuffer_completing_file_name = Qnil;
2126
3ec03f7e 2127 DEFVAR_LISP ("completing-read-function",
45b6f6d5 2128 Vcompleting_read_function,
3ec03f7e
LL
2129 doc: /* The function called by `completing-read' to do the work.
2130It should accept the same arguments as `completing-read'. */);
2131 Vcompleting_read_function = Qcompleting_read_default;
2132
29208e82 2133 DEFVAR_LISP ("minibuffer-help-form", Vminibuffer_help_form,
af52c32d 2134 doc: /* Value that `help-form' takes on inside the minibuffer. */);
f927c5ae
JB
2135 Vminibuffer_help_form = Qnil;
2136
29208e82 2137 DEFVAR_LISP ("minibuffer-history-variable", Vminibuffer_history_variable,
af52c32d 2138 doc: /* History list symbol to add minibuffer values to.
a1f17501
PJ
2139Each string of minibuffer input, as it appears on exit from the minibuffer,
2140is added with
2141 (set minibuffer-history-variable
2142 (cons STRING (symbol-value minibuffer-history-variable))) */);
5a866662 2143 XSETFASTINT (Vminibuffer_history_variable, 0);
770970cb 2144
29208e82 2145 DEFVAR_LISP ("minibuffer-history-position", Vminibuffer_history_position,
af52c32d 2146 doc: /* Current position of redoing in the history list. */);
770970cb
RS
2147 Vminibuffer_history_position = Qnil;
2148
29208e82 2149 DEFVAR_BOOL ("minibuffer-auto-raise", minibuffer_auto_raise,
af52c32d 2150 doc: /* *Non-nil means entering the minibuffer raises the minibuffer's frame.
a1f17501 2151Some uses of the echo area also raise that frame (since they use it too). */);
6a9ee000
RS
2152 minibuffer_auto_raise = 0;
2153
29208e82 2154 DEFVAR_LISP ("completion-regexp-list", Vcompletion_regexp_list,
6b61353c
KH
2155 doc: /* List of regexps that should restrict possible completions.
2156The basic completion functions only consider a completion acceptable
2157if it matches all regular expressions in this list, with
2158`case-fold-search' bound to the value of `completion-ignore-case'.
2159See Info node `(elisp)Basic Completion', for a description of these
2160functions. */);
42006772
RS
2161 Vcompletion_regexp_list = Qnil;
2162
c3421833 2163 DEFVAR_BOOL ("minibuffer-allow-text-properties",
29208e82 2164 minibuffer_allow_text_properties,
af52c32d 2165 doc: /* Non-nil means `read-from-minibuffer' should not discard text properties.
a1f17501
PJ
2166This also affects `read-string', but it does not affect `read-minibuffer',
2167`read-no-blanks-input', or any of the functions that do minibuffer input
2168with completion; they always discard text properties. */);
c3421833
RS
2169 minibuffer_allow_text_properties = 0;
2170
29208e82 2171 DEFVAR_LISP ("minibuffer-prompt-properties", Vminibuffer_prompt_properties,
af52c32d 2172 doc: /* Text properties that are added to minibuffer prompts.
a1f17501
PJ
2173These are in addition to the basic `field' property, and stickiness
2174properties. */);
cc64f5c9
MB
2175 /* We use `intern' here instead of Qread_only to avoid
2176 initialization-order problems. */
2177 Vminibuffer_prompt_properties
d67b4f80 2178 = Fcons (intern_c_string ("read-only"), Fcons (Qt, Qnil));
cc64f5c9 2179
29208e82 2180 DEFVAR_LISP ("read-expression-map", Vread_expression_map,
627fb581
RS
2181 doc: /* Minibuffer keymap used for reading Lisp expressions. */);
2182 Vread_expression_map = Qnil;
2183
68313ed8 2184 defsubr (&Sset_minibuffer_window);
f927c5ae
JB
2185 defsubr (&Sread_from_minibuffer);
2186 defsubr (&Seval_minibuffer);
2187 defsubr (&Sread_minibuffer);
2188 defsubr (&Sread_string);
2189 defsubr (&Sread_command);
2190 defsubr (&Sread_variable);
ff137f16 2191 defsubr (&Sinternal_complete_buffer);
f927c5ae
JB
2192 defsubr (&Sread_buffer);
2193 defsubr (&Sread_no_blanks_input);
2194 defsubr (&Sminibuffer_depth);
37e9a934 2195 defsubr (&Sminibuffer_prompt);
f927c5ae 2196
873ef78e 2197 defsubr (&Sminibufferp);
a346ec72
MB
2198 defsubr (&Sminibuffer_prompt_end);
2199 defsubr (&Sminibuffer_contents);
2200 defsubr (&Sminibuffer_contents_no_properties);
b5e1e449 2201 defsubr (&Sminibuffer_completion_contents);
a346ec72 2202
f927c5ae
JB
2203 defsubr (&Stry_completion);
2204 defsubr (&Sall_completions);
695deb18
SM
2205 defsubr (&Stest_completion);
2206 defsubr (&Sassoc_string);
f927c5ae 2207 defsubr (&Scompleting_read);
3ec03f7e 2208 defsubr (&Scompleting_read_default);
f927c5ae 2209}