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