* tramp.texi (Top, Configuration): Insert section `Predefined
[emacs.git] / src / minibuf.c
blobb69a16eff425b93308e986a78950e40796a661a3
1 /* Minibuffer input and completion.
3 Copyright (C) 1985-1986, 1993-2013 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
21 #include <config.h>
22 #include <errno.h>
23 #include <stdio.h>
25 #include "lisp.h"
26 #include "commands.h"
27 #include "character.h"
28 #include "buffer.h"
29 #include "dispextern.h"
30 #include "keyboard.h"
31 #include "frame.h"
32 #include "window.h"
33 #include "syntax.h"
34 #include "intervals.h"
35 #include "keymap.h"
36 #include "termhooks.h"
38 /* List of buffers for use as minibuffers.
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. */
44 Lisp_Object Vminibuffer_list;
46 /* Data to remember during recursive minibuffer invocations. */
48 static Lisp_Object minibuf_save_list;
50 /* Depth in minibuffer invocations. */
52 EMACS_INT minibuf_level;
54 /* The maximum length of a minibuffer history. */
56 static Lisp_Object Qhistory_length;
58 /* Fread_minibuffer leaves the input here as a string. */
60 Lisp_Object last_minibuf_string;
62 static Lisp_Object Qminibuffer_history, Qbuffer_name_history;
64 static Lisp_Object Qread_file_name_internal;
66 /* Normal hooks for entry to and exit from minibuffer. */
68 static Lisp_Object Qminibuffer_setup_hook;
69 static Lisp_Object Qminibuffer_exit_hook;
71 Lisp_Object Qcompletion_ignore_case;
72 static Lisp_Object Qminibuffer_completion_table;
73 static Lisp_Object Qminibuffer_completion_predicate;
74 static Lisp_Object Qminibuffer_completion_confirm;
75 static Lisp_Object Qcustom_variable_p;
77 static Lisp_Object Qminibuffer_default;
79 static Lisp_Object Qcurrent_input_method, Qactivate_input_method;
81 static Lisp_Object Qcase_fold_search;
83 static Lisp_Object Qread_expression_history;
85 /* Prompt to display in front of the mini-buffer contents. */
87 static Lisp_Object minibuf_prompt;
89 /* Width of current mini-buffer prompt. Only set after display_line
90 of the line that contains the prompt. */
92 static ptrdiff_t minibuf_prompt_width;
95 /* Put minibuf on currently selected frame's minibuffer.
96 We do this whenever the user starts a new minibuffer
97 or when a minibuffer exits. */
99 static void
100 choose_minibuf_frame (void)
102 if (FRAMEP (selected_frame)
103 && FRAME_LIVE_P (XFRAME (selected_frame))
104 && !EQ (minibuf_window, XFRAME (selected_frame)->minibuffer_window))
106 struct frame *sf = XFRAME (selected_frame);
107 Lisp_Object buffer;
109 /* I don't think that any frames may validly have a null minibuffer
110 window anymore. */
111 if (NILP (sf->minibuffer_window))
112 emacs_abort ();
114 /* Under X, we come here with minibuf_window being the
115 minibuffer window of the unused termcap window created in
116 init_window_once. That window doesn't have a buffer. */
117 buffer = XWINDOW (minibuf_window)->contents;
118 if (BUFFERP (buffer))
119 /* Use set_window_buffer instead of Fset_window_buffer (see
120 discussion of bug#11984, bug#12025, bug#12026). */
121 set_window_buffer (sf->minibuffer_window, buffer, 0, 0);
122 minibuf_window = sf->minibuffer_window;
125 /* Make sure no other frame has a minibuffer as its selected window,
126 because the text would not be displayed in it, and that would be
127 confusing. Only allow the selected frame to do this,
128 and that only if the minibuffer is active. */
130 Lisp_Object tail, frame;
132 FOR_EACH_FRAME (tail, frame)
133 if (MINI_WINDOW_P (XWINDOW (FRAME_SELECTED_WINDOW (XFRAME (frame))))
134 && !(EQ (frame, selected_frame)
135 && minibuf_level > 0))
136 Fset_frame_selected_window (frame, Fframe_first_window (frame), Qnil);
140 static Lisp_Object
141 choose_minibuf_frame_1 (Lisp_Object ignore)
143 choose_minibuf_frame ();
144 return Qnil;
147 DEFUN ("active-minibuffer-window", Factive_minibuffer_window,
148 Sactive_minibuffer_window, 0, 0, 0,
149 doc: /* Return the currently active minibuffer window, or nil if none. */)
150 (void)
152 return minibuf_level ? minibuf_window : Qnil;
155 DEFUN ("set-minibuffer-window", Fset_minibuffer_window,
156 Sset_minibuffer_window, 1, 1, 0,
157 doc: /* Specify which minibuffer window to use for the minibuffer.
158 This affects where the minibuffer is displayed if you put text in it
159 without invoking the usual minibuffer commands. */)
160 (Lisp_Object window)
162 CHECK_WINDOW (window);
163 if (! MINI_WINDOW_P (XWINDOW (window)))
164 error ("Window is not a minibuffer window");
166 minibuf_window = window;
168 return window;
172 /* Actual minibuffer invocation. */
174 static Lisp_Object read_minibuf_unwind (Lisp_Object);
175 static Lisp_Object run_exit_minibuf_hook (Lisp_Object);
178 /* Read a Lisp object from VAL and return it. If VAL is an empty
179 string, and DEFALT is a string, read from DEFALT instead of VAL. */
181 static Lisp_Object
182 string_to_object (Lisp_Object val, Lisp_Object defalt)
184 struct gcpro gcpro1, gcpro2;
185 Lisp_Object expr_and_pos;
186 ptrdiff_t pos;
188 GCPRO2 (val, defalt);
190 if (STRINGP (val) && SCHARS (val) == 0)
192 if (STRINGP (defalt))
193 val = defalt;
194 else if (CONSP (defalt) && STRINGP (XCAR (defalt)))
195 val = XCAR (defalt);
198 expr_and_pos = Fread_from_string (val, Qnil, Qnil);
199 pos = XINT (Fcdr (expr_and_pos));
200 if (pos != SCHARS (val))
202 /* Ignore trailing whitespace; any other trailing junk
203 is an error. */
204 ptrdiff_t i;
205 pos = string_char_to_byte (val, pos);
206 for (i = pos; i < SBYTES (val); i++)
208 int c = SREF (val, i);
209 if (c != ' ' && c != '\t' && c != '\n')
210 error ("Trailing garbage following expression");
214 val = Fcar (expr_and_pos);
215 RETURN_UNGCPRO (val);
219 /* Like read_minibuf but reading from stdin. This function is called
220 from read_minibuf to do the job if noninteractive. */
222 static Lisp_Object
223 read_minibuf_noninteractive (Lisp_Object map, Lisp_Object initial,
224 Lisp_Object prompt, Lisp_Object backup_n,
225 bool expflag,
226 Lisp_Object histvar, Lisp_Object histpos,
227 Lisp_Object defalt,
228 bool allow_props, bool inherit_input_method)
230 ptrdiff_t size, len;
231 char *line;
232 Lisp_Object val;
233 int c;
235 fprintf (stdout, "%s", SDATA (prompt));
236 fflush (stdout);
238 val = Qnil;
239 size = 100;
240 len = 0;
241 line = xmalloc (size);
243 while ((c = getchar ()) != '\n')
245 if (c == EOF)
247 if (errno != EINTR)
248 break;
250 else
252 if (len == size)
254 if (STRING_BYTES_BOUND / 2 < size)
255 memory_full (SIZE_MAX);
256 size *= 2;
257 line = xrealloc (line, size);
259 line[len++] = c;
263 if (len || c == '\n')
265 val = make_string (line, len);
266 xfree (line);
268 else
270 xfree (line);
271 error ("Error reading from stdin");
274 /* If Lisp form desired instead of string, parse it. */
275 if (expflag)
276 val = string_to_object (val, CONSP (defalt) ? XCAR (defalt) : defalt);
278 return val;
281 DEFUN ("minibufferp", Fminibufferp,
282 Sminibufferp, 0, 1, 0,
283 doc: /* Return t if BUFFER is a minibuffer.
284 No argument or nil as argument means use current buffer as BUFFER.
285 BUFFER can be a buffer or a buffer name. */)
286 (Lisp_Object buffer)
288 Lisp_Object tem;
290 if (NILP (buffer))
291 buffer = Fcurrent_buffer ();
292 else if (STRINGP (buffer))
293 buffer = Fget_buffer (buffer);
294 else
295 CHECK_BUFFER (buffer);
297 tem = Fmemq (buffer, Vminibuffer_list);
298 return ! NILP (tem) ? Qt : Qnil;
301 DEFUN ("minibuffer-prompt-end", Fminibuffer_prompt_end,
302 Sminibuffer_prompt_end, 0, 0, 0,
303 doc: /* Return the buffer position of the end of the minibuffer prompt.
304 Return (point-min) if current buffer is not a minibuffer. */)
305 (void)
307 /* This function is written to be most efficient when there's a prompt. */
308 Lisp_Object beg, end, tem;
309 beg = make_number (BEGV);
311 tem = Fmemq (Fcurrent_buffer (), Vminibuffer_list);
312 if (NILP (tem))
313 return beg;
315 end = Ffield_end (beg, Qnil, Qnil);
317 if (XINT (end) == ZV && NILP (Fget_char_property (beg, Qfield, Qnil)))
318 return beg;
319 else
320 return end;
323 DEFUN ("minibuffer-contents", Fminibuffer_contents,
324 Sminibuffer_contents, 0, 0, 0,
325 doc: /* Return the user input in a minibuffer as a string.
326 If the current buffer is not a minibuffer, return its entire contents. */)
327 (void)
329 ptrdiff_t prompt_end = XINT (Fminibuffer_prompt_end ());
330 return make_buffer_string (prompt_end, ZV, 1);
333 DEFUN ("minibuffer-contents-no-properties", Fminibuffer_contents_no_properties,
334 Sminibuffer_contents_no_properties, 0, 0, 0,
335 doc: /* Return the user input in a minibuffer as a string, without text-properties.
336 If the current buffer is not a minibuffer, return its entire contents. */)
337 (void)
339 ptrdiff_t prompt_end = XINT (Fminibuffer_prompt_end ());
340 return make_buffer_string (prompt_end, ZV, 0);
343 DEFUN ("minibuffer-completion-contents", Fminibuffer_completion_contents,
344 Sminibuffer_completion_contents, 0, 0, 0,
345 doc: /* Return the user input in a minibuffer before point as a string.
346 That is what completion commands operate on.
347 If the current buffer is not a minibuffer, return its entire contents. */)
348 (void)
350 ptrdiff_t prompt_end = XINT (Fminibuffer_prompt_end ());
351 if (PT < prompt_end)
352 error ("Cannot do completion in the prompt");
353 return make_buffer_string (prompt_end, PT, 1);
357 /* Read from the minibuffer using keymap MAP and initial contents INITIAL,
358 putting point minus BACKUP_N bytes from the end of INITIAL,
359 prompting with PROMPT (a string), using history list HISTVAR
360 with initial position HISTPOS. INITIAL should be a string or a
361 cons of a string and an integer. BACKUP_N should be <= 0, or
362 Qnil, which is equivalent to 0. If INITIAL is a cons, BACKUP_N is
363 ignored and replaced with an integer that puts point at one-indexed
364 position N in INITIAL, where N is the CDR of INITIAL, or at the
365 beginning of INITIAL if N <= 0.
367 Normally return the result as a string (the text that was read),
368 but if EXPFLAG, read it and return the object read.
369 If HISTVAR is given, save the value read on that history only if it doesn't
370 match the front of that history list exactly. The value is pushed onto
371 the list as the string that was read.
373 DEFALT specifies the default value for the sake of history commands.
375 If ALLOW_PROPS, do not throw away text properties.
377 if INHERIT_INPUT_METHOD, the minibuffer inherits the
378 current input method. */
380 static Lisp_Object
381 read_minibuf (Lisp_Object map, Lisp_Object initial, Lisp_Object prompt,
382 bool expflag,
383 Lisp_Object histvar, Lisp_Object histpos, Lisp_Object defalt,
384 bool allow_props, bool inherit_input_method)
386 Lisp_Object val;
387 ptrdiff_t count = SPECPDL_INDEX ();
388 Lisp_Object mini_frame, ambient_dir, minibuffer, input_method;
389 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5;
390 Lisp_Object enable_multibyte;
391 EMACS_INT pos = 0;
392 /* String to add to the history. */
393 Lisp_Object histstring;
395 Lisp_Object empty_minibuf;
396 Lisp_Object dummy, frame;
398 specbind (Qminibuffer_default, defalt);
399 specbind (intern ("inhibit-read-only"), Qnil);
401 /* If Vminibuffer_completing_file_name is `lambda' on entry, it was t
402 in previous recursive minibuffer, but was not set explicitly
403 to t for this invocation, so set it to nil in this minibuffer.
404 Save the old value now, before we change it. */
405 specbind (intern ("minibuffer-completing-file-name"), Vminibuffer_completing_file_name);
406 if (EQ (Vminibuffer_completing_file_name, Qlambda))
407 Vminibuffer_completing_file_name = Qnil;
409 #ifdef HAVE_WINDOW_SYSTEM
410 if (display_hourglass_p)
411 cancel_hourglass ();
412 #endif
414 if (!NILP (initial))
416 if (CONSP (initial))
418 Lisp_Object backup_n = XCDR (initial);
419 initial = XCAR (initial);
420 CHECK_STRING (initial);
421 if (!NILP (backup_n))
423 CHECK_NUMBER (backup_n);
424 /* Convert to distance from end of input. */
425 if (XINT (backup_n) < 1)
426 /* A number too small means the beginning of the string. */
427 pos = - SCHARS (initial);
428 else
429 pos = XINT (backup_n) - 1 - SCHARS (initial);
432 else
433 CHECK_STRING (initial);
435 val = Qnil;
436 ambient_dir = BVAR (current_buffer, directory);
437 input_method = Qnil;
438 enable_multibyte = Qnil;
440 /* Don't need to protect PROMPT, HISTVAR, and HISTPOS because we
441 store them away before we can GC. Don't need to protect
442 BACKUP_N because we use the value only if it is an integer. */
443 GCPRO5 (map, initial, val, ambient_dir, input_method);
445 if (!STRINGP (prompt))
446 prompt = empty_unibyte_string;
448 if (!enable_recursive_minibuffers
449 && minibuf_level > 0)
451 if (EQ (selected_window, minibuf_window))
452 error ("Command attempted to use minibuffer while in minibuffer");
453 else
454 /* If we're in another window, cancel the minibuffer that's active. */
455 Fthrow (Qexit,
456 build_string ("Command attempted to use minibuffer while in minibuffer"));
459 if ((noninteractive
460 /* In case we are running as a daemon, only do this before
461 detaching from the terminal. */
462 || (IS_DAEMON && (daemon_pipe[1] >= 0)))
463 && NILP (Vexecuting_kbd_macro))
465 val = read_minibuf_noninteractive (map, initial, prompt,
466 make_number (pos),
467 expflag, histvar, histpos, defalt,
468 allow_props, inherit_input_method);
469 UNGCPRO;
470 return unbind_to (count, val);
473 /* Choose the minibuffer window and frame, and take action on them. */
475 /* Prepare for restoring the current buffer since choose_minibuf_frame
476 calling Fset_frame_selected_window may change it (Bug#12766). */
477 record_unwind_protect (Fset_buffer, Fcurrent_buffer ());
479 choose_minibuf_frame ();
481 record_unwind_protect (choose_minibuf_frame_1, Qnil);
483 record_unwind_protect (Fset_window_configuration,
484 Fcurrent_window_configuration (Qnil));
486 /* If the minibuffer window is on a different frame, save that
487 frame's configuration too. */
488 mini_frame = WINDOW_FRAME (XWINDOW (minibuf_window));
489 if (!EQ (mini_frame, selected_frame))
490 record_unwind_protect (Fset_window_configuration,
491 Fcurrent_window_configuration (mini_frame));
493 /* If the minibuffer is on an iconified or invisible frame,
494 make it visible now. */
495 Fmake_frame_visible (mini_frame);
497 if (minibuffer_auto_raise)
498 Fraise_frame (mini_frame);
500 temporarily_switch_to_single_kboard (XFRAME (mini_frame));
502 /* We have to do this after saving the window configuration
503 since that is what restores the current buffer. */
505 /* Arrange to restore a number of minibuffer-related variables.
506 We could bind each variable separately, but that would use lots of
507 specpdl slots. */
508 minibuf_save_list
509 = Fcons (Voverriding_local_map,
510 Fcons (minibuf_window,
511 minibuf_save_list));
512 minibuf_save_list
513 = Fcons (minibuf_prompt,
514 Fcons (make_number (minibuf_prompt_width),
515 Fcons (Vhelp_form,
516 Fcons (Vcurrent_prefix_arg,
517 Fcons (Vminibuffer_history_position,
518 Fcons (Vminibuffer_history_variable,
519 minibuf_save_list))))));
521 record_unwind_protect (read_minibuf_unwind, Qnil);
522 minibuf_level++;
523 /* We are exiting the minibuffer one way or the other, so run the hook.
524 It should be run before unwinding the minibuf settings. Do it
525 separately from read_minibuf_unwind because we need to make sure that
526 read_minibuf_unwind is fully executed even if exit-minibuffer-hook
527 signals an error. --Stef */
528 record_unwind_protect (run_exit_minibuf_hook, Qnil);
530 /* Now that we can restore all those variables, start changing them. */
532 minibuf_prompt_width = 0;
533 minibuf_prompt = Fcopy_sequence (prompt);
534 Vminibuffer_history_position = histpos;
535 Vminibuffer_history_variable = histvar;
536 Vhelp_form = Vminibuffer_help_form;
537 /* If this minibuffer is reading a file name, that doesn't mean
538 recursive ones are. But we cannot set it to nil, because
539 completion code still need to know the minibuffer is completing a
540 file name. So use `lambda' as intermediate value meaning
541 "t" in this minibuffer, but "nil" in next minibuffer. */
542 if (!NILP (Vminibuffer_completing_file_name))
543 Vminibuffer_completing_file_name = Qlambda;
545 if (inherit_input_method)
547 /* `current-input-method' is buffer local. So, remember it in
548 INPUT_METHOD before changing the current buffer. */
549 input_method = Fsymbol_value (Qcurrent_input_method);
550 enable_multibyte = BVAR (current_buffer, enable_multibyte_characters);
553 /* Switch to the minibuffer. */
555 minibuffer = get_minibuffer (minibuf_level);
556 Fset_buffer (minibuffer);
558 /* Defeat (setq-default truncate-lines t), since truncated lines do
559 not work correctly in minibuffers. (Bug#5715, etc) */
560 bset_truncate_lines (current_buffer, Qnil);
562 /* If appropriate, copy enable-multibyte-characters into the minibuffer. */
563 if (inherit_input_method)
564 bset_enable_multibyte_characters (current_buffer, enable_multibyte);
566 /* The current buffer's default directory is usually the right thing
567 for our minibuffer here. However, if you're typing a command at
568 a minibuffer-only frame when minibuf_level is zero, then buf IS
569 the current_buffer, so reset_buffer leaves buf's default
570 directory unchanged. This is a bummer when you've just started
571 up Emacs and buf's default directory is Qnil. Here's a hack; can
572 you think of something better to do? Find another buffer with a
573 better directory, and use that one instead. */
574 if (STRINGP (ambient_dir))
575 bset_directory (current_buffer, ambient_dir);
576 else
578 Lisp_Object buf_list;
580 for (buf_list = Vbuffer_alist;
581 CONSP (buf_list);
582 buf_list = XCDR (buf_list))
584 Lisp_Object other_buf;
586 other_buf = XCDR (XCAR (buf_list));
587 if (STRINGP (BVAR (XBUFFER (other_buf), directory)))
589 bset_directory (current_buffer,
590 BVAR (XBUFFER (other_buf), directory));
591 break;
596 if (!EQ (mini_frame, selected_frame))
597 Fredirect_frame_focus (selected_frame, mini_frame);
599 Vminibuf_scroll_window = selected_window;
600 if (minibuf_level == 1 || !EQ (minibuf_window, selected_window))
601 minibuf_selected_window = selected_window;
603 /* Empty out the minibuffers of all frames other than the one
604 where we are going to display one now.
605 Set them to point to ` *Minibuf-0*', which is always empty. */
606 empty_minibuf = get_minibuffer (0);
608 FOR_EACH_FRAME (dummy, frame)
610 Lisp_Object root_window = Fframe_root_window (frame);
611 Lisp_Object mini_window = XWINDOW (root_window)->next;
613 if (! NILP (mini_window) && ! EQ (mini_window, minibuf_window)
614 && !NILP (Fwindow_minibuffer_p (mini_window)))
615 /* Use set_window_buffer instead of Fset_window_buffer (see
616 discussion of bug#11984, bug#12025, bug#12026). */
617 set_window_buffer (mini_window, empty_minibuf, 0, 0);
620 /* Display this minibuffer in the proper window. */
621 /* Use set_window_buffer instead of Fset_window_buffer (see
622 discussion of bug#11984, bug#12025, bug#12026). */
623 set_window_buffer (minibuf_window, Fcurrent_buffer (), 0, 0);
624 Fselect_window (minibuf_window, Qnil);
625 XWINDOW (minibuf_window)->hscroll = 0;
627 Fmake_local_variable (Qprint_escape_newlines);
628 print_escape_newlines = 1;
630 /* Erase the buffer. */
632 ptrdiff_t count1 = SPECPDL_INDEX ();
633 specbind (Qinhibit_read_only, Qt);
634 specbind (Qinhibit_modification_hooks, Qt);
635 Ferase_buffer ();
637 if (!NILP (BVAR (current_buffer, enable_multibyte_characters))
638 && ! STRING_MULTIBYTE (minibuf_prompt))
639 minibuf_prompt = Fstring_make_multibyte (minibuf_prompt);
641 /* Insert the prompt, record where it ends. */
642 Finsert (1, &minibuf_prompt);
643 if (PT > BEG)
645 Fput_text_property (make_number (BEG), make_number (PT),
646 Qfront_sticky, Qt, Qnil);
647 Fput_text_property (make_number (BEG), make_number (PT),
648 Qrear_nonsticky, Qt, Qnil);
649 Fput_text_property (make_number (BEG), make_number (PT),
650 Qfield, Qt, Qnil);
651 Fadd_text_properties (make_number (BEG), make_number (PT),
652 Vminibuffer_prompt_properties, Qnil);
654 unbind_to (count1, Qnil);
657 minibuf_prompt_width = current_column ();
659 /* Put in the initial input. */
660 if (!NILP (initial))
662 Finsert (1, &initial);
663 Fforward_char (make_number (pos));
666 clear_message (1, 1);
667 bset_keymap (current_buffer, map);
669 /* Turn on an input method stored in INPUT_METHOD if any. */
670 if (STRINGP (input_method) && !NILP (Ffboundp (Qactivate_input_method)))
671 call1 (Qactivate_input_method, input_method);
673 Frun_hooks (1, &Qminibuffer_setup_hook);
675 /* Don't allow the user to undo past this point. */
676 bset_undo_list (current_buffer, Qnil);
678 recursive_edit_1 ();
680 /* If cursor is on the minibuffer line,
681 show the user we have exited by putting it in column 0. */
682 if (XWINDOW (minibuf_window)->cursor.vpos >= 0
683 && !noninteractive)
685 XWINDOW (minibuf_window)->cursor.hpos = 0;
686 XWINDOW (minibuf_window)->cursor.x = 0;
687 XWINDOW (minibuf_window)->must_be_updated_p = 1;
688 update_frame (XFRAME (selected_frame), 1, 1);
690 struct frame *f = XFRAME (XWINDOW (minibuf_window)->frame);
691 struct redisplay_interface *rif = FRAME_RIF (f);
692 if (rif && rif->flush_display)
693 rif->flush_display (f);
697 /* Make minibuffer contents into a string. */
698 Fset_buffer (minibuffer);
699 if (allow_props)
700 val = Fminibuffer_contents ();
701 else
702 val = Fminibuffer_contents_no_properties ();
704 /* VAL is the string of minibuffer text. */
706 last_minibuf_string = val;
708 /* Choose the string to add to the history. */
709 if (SCHARS (val) != 0)
710 histstring = val;
711 else if (STRINGP (defalt))
712 histstring = defalt;
713 else if (CONSP (defalt) && STRINGP (XCAR (defalt)))
714 histstring = XCAR (defalt);
715 else
716 histstring = Qnil;
718 /* Add the value to the appropriate history list, if any. */
719 if (!NILP (Vhistory_add_new_input)
720 && SYMBOLP (Vminibuffer_history_variable)
721 && !NILP (histstring))
723 /* If the caller wanted to save the value read on a history list,
724 then do so if the value is not already the front of the list. */
725 Lisp_Object histval;
727 /* If variable is unbound, make it nil. */
729 histval = find_symbol_value (Vminibuffer_history_variable);
730 if (EQ (histval, Qunbound))
731 Fset (Vminibuffer_history_variable, Qnil);
733 /* The value of the history variable must be a cons or nil. Other
734 values are unacceptable. We silently ignore these values. */
736 if (NILP (histval)
737 || (CONSP (histval)
738 /* Don't duplicate the most recent entry in the history. */
739 && (NILP (Fequal (histstring, Fcar (histval))))))
741 Lisp_Object length;
743 if (history_delete_duplicates) Fdelete (histstring, histval);
744 histval = Fcons (histstring, histval);
745 Fset (Vminibuffer_history_variable, histval);
747 /* Truncate if requested. */
748 length = Fget (Vminibuffer_history_variable, Qhistory_length);
749 if (NILP (length)) length = Vhistory_length;
750 if (INTEGERP (length))
752 if (XINT (length) <= 0)
753 Fset (Vminibuffer_history_variable, Qnil);
754 else
756 Lisp_Object temp;
758 temp = Fnthcdr (Fsub1 (length), histval);
759 if (CONSP (temp)) Fsetcdr (temp, Qnil);
765 /* If Lisp form desired instead of string, parse it. */
766 if (expflag)
767 val = string_to_object (val, defalt);
769 /* The appropriate frame will get selected
770 in set-window-configuration. */
771 UNGCPRO;
772 return unbind_to (count, val);
775 /* Return a buffer to be used as the minibuffer at depth `depth'.
776 depth = 0 is the lowest allowed argument, and that is the value
777 used for nonrecursive minibuffer invocations. */
779 Lisp_Object
780 get_minibuffer (EMACS_INT depth)
782 Lisp_Object tail, num, buf;
783 char name[sizeof " *Minibuf-*" + INT_STRLEN_BOUND (EMACS_INT)];
785 XSETFASTINT (num, depth);
786 tail = Fnthcdr (num, Vminibuffer_list);
787 if (NILP (tail))
789 tail = Fcons (Qnil, Qnil);
790 Vminibuffer_list = nconc2 (Vminibuffer_list, tail);
792 buf = Fcar (tail);
793 if (NILP (buf) || !BUFFER_LIVE_P (XBUFFER (buf)))
795 buf = Fget_buffer_create
796 (make_formatted_string (name, " *Minibuf-%"pI"d*", depth));
798 /* Although the buffer's name starts with a space, undo should be
799 enabled in it. */
800 Fbuffer_enable_undo (buf);
802 XSETCAR (tail, buf);
804 else
806 ptrdiff_t count = SPECPDL_INDEX ();
807 /* We have to empty both overlay lists. Otherwise we end
808 up with overlays that think they belong to this buffer
809 while the buffer doesn't know about them any more. */
810 delete_all_overlays (XBUFFER (buf));
811 reset_buffer (XBUFFER (buf));
812 record_unwind_current_buffer ();
813 Fset_buffer (buf);
814 if (!NILP (Ffboundp (intern ("minibuffer-inactive-mode"))))
815 call0 (intern ("minibuffer-inactive-mode"));
816 else
817 Fkill_all_local_variables ();
818 unbind_to (count, Qnil);
821 return buf;
824 static Lisp_Object
825 run_exit_minibuf_hook (Lisp_Object data)
827 safe_run_hooks (Qminibuffer_exit_hook);
828 return Qnil;
831 /* This function is called on exiting minibuffer, whether normally or
832 not, and it restores the current window, buffer, etc. */
834 static Lisp_Object
835 read_minibuf_unwind (Lisp_Object data)
837 Lisp_Object old_deactivate_mark;
838 Lisp_Object window;
840 /* If this was a recursive minibuffer,
841 tie the minibuffer window back to the outer level minibuffer buffer. */
842 minibuf_level--;
844 window = minibuf_window;
845 /* To keep things predictable, in case it matters, let's be in the
846 minibuffer when we reset the relevant variables. */
847 Fset_buffer (XWINDOW (window)->contents);
849 /* Restore prompt, etc, from outer minibuffer level. */
850 minibuf_prompt = Fcar (minibuf_save_list);
851 minibuf_save_list = Fcdr (minibuf_save_list);
852 minibuf_prompt_width = XFASTINT (Fcar (minibuf_save_list));
853 minibuf_save_list = Fcdr (minibuf_save_list);
854 Vhelp_form = Fcar (minibuf_save_list);
855 minibuf_save_list = Fcdr (minibuf_save_list);
856 Vcurrent_prefix_arg = Fcar (minibuf_save_list);
857 minibuf_save_list = Fcdr (minibuf_save_list);
858 Vminibuffer_history_position = Fcar (minibuf_save_list);
859 minibuf_save_list = Fcdr (minibuf_save_list);
860 Vminibuffer_history_variable = Fcar (minibuf_save_list);
861 minibuf_save_list = Fcdr (minibuf_save_list);
862 Voverriding_local_map = Fcar (minibuf_save_list);
863 minibuf_save_list = Fcdr (minibuf_save_list);
864 #if 0
865 temp = Fcar (minibuf_save_list);
866 if (FRAME_LIVE_P (XFRAME (WINDOW_FRAME (XWINDOW (temp)))))
867 minibuf_window = temp;
868 #endif
869 minibuf_save_list = Fcdr (minibuf_save_list);
871 /* Erase the minibuffer we were using at this level. */
873 ptrdiff_t count = SPECPDL_INDEX ();
874 /* Prevent error in erase-buffer. */
875 specbind (Qinhibit_read_only, Qt);
876 specbind (Qinhibit_modification_hooks, Qt);
877 old_deactivate_mark = Vdeactivate_mark;
878 Ferase_buffer ();
879 Vdeactivate_mark = old_deactivate_mark;
880 unbind_to (count, Qnil);
883 /* When we get to the outmost level, make sure we resize the
884 mini-window back to its normal size. */
885 if (minibuf_level == 0)
886 resize_mini_window (XWINDOW (window), 0);
888 /* Make sure minibuffer window is erased, not ignored. */
889 windows_or_buffers_changed++;
890 XWINDOW (window)->last_modified = 0;
891 XWINDOW (window)->last_overlay_modified = 0;
893 /* In case the previous minibuffer displayed in this miniwindow is
894 dead, we may keep displaying this buffer (tho it's inactive), so reset it,
895 to make sure we don't leave around bindings and stuff which only
896 made sense during the read_minibuf invocation. */
897 call0 (intern ("minibuffer-inactive-mode"));
898 return Qnil;
902 DEFUN ("read-from-minibuffer", Fread_from_minibuffer,
903 Sread_from_minibuffer, 1, 7, 0,
904 doc: /* Read a string from the minibuffer, prompting with string PROMPT.
905 The optional second arg INITIAL-CONTENTS is an obsolete alternative to
906 DEFAULT-VALUE. It normally should be nil in new code, except when
907 HIST is a cons. It is discussed in more detail below.
909 Third arg KEYMAP is a keymap to use whilst reading;
910 if omitted or nil, the default is `minibuffer-local-map'.
912 If fourth arg READ is non-nil, interpret the result as a Lisp object
913 and return that object:
914 in other words, do `(car (read-from-string INPUT-STRING))'
916 Fifth arg HIST, if non-nil, specifies a history list and optionally
917 the initial position in the list. It can be a symbol, which is the
918 history list variable to use, or a cons cell (HISTVAR . HISTPOS).
919 In that case, HISTVAR is the history list variable to use, and
920 HISTPOS is the initial position for use by the minibuffer history
921 commands. For consistency, you should also specify that element of
922 the history as the value of INITIAL-CONTENTS. Positions are counted
923 starting from 1 at the beginning of the list.
925 Sixth arg DEFAULT-VALUE, if non-nil, should be a string, which is used
926 as the default to `read' if READ is non-nil and the user enters
927 empty input. But if READ is nil, this function does _not_ return
928 DEFAULT-VALUE for empty input! Instead, it returns the empty string.
930 Whatever the value of READ, DEFAULT-VALUE is made available via the
931 minibuffer history commands. DEFAULT-VALUE can also be a list of
932 strings, in which case all the strings are available in the history,
933 and the first string is the default to `read' if READ is non-nil.
935 Seventh arg INHERIT-INPUT-METHOD, if non-nil, means the minibuffer inherits
936 the current input method and the setting of `enable-multibyte-characters'.
938 If the variable `minibuffer-allow-text-properties' is non-nil,
939 then the string which is returned includes whatever text properties
940 were present in the minibuffer. Otherwise the value has no text properties.
942 The remainder of this documentation string describes the
943 INITIAL-CONTENTS argument in more detail. It is only relevant when
944 studying existing code, or when HIST is a cons. If non-nil,
945 INITIAL-CONTENTS is a string to be inserted into the minibuffer before
946 reading input. Normally, point is put at the end of that string.
947 However, if INITIAL-CONTENTS is \(STRING . POSITION), the initial
948 input is STRING, but point is placed at _one-indexed_ position
949 POSITION in the minibuffer. Any integer value less than or equal to
950 one puts point at the beginning of the string. *Note* that this
951 behavior differs from the way such arguments are used in `completing-read'
952 and some related functions, which use zero-indexing for POSITION. */)
953 (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)
955 Lisp_Object histvar, histpos, val;
956 struct gcpro gcpro1;
958 CHECK_STRING (prompt);
959 if (NILP (keymap))
960 keymap = Vminibuffer_local_map;
961 else
962 keymap = get_keymap (keymap, 1, 0);
964 if (SYMBOLP (hist))
966 histvar = hist;
967 histpos = Qnil;
969 else
971 histvar = Fcar_safe (hist);
972 histpos = Fcdr_safe (hist);
974 if (NILP (histvar))
975 histvar = Qminibuffer_history;
976 if (NILP (histpos))
977 XSETFASTINT (histpos, 0);
979 GCPRO1 (default_value);
980 val = read_minibuf (keymap, initial_contents, prompt,
981 !NILP (read),
982 histvar, histpos, default_value,
983 minibuffer_allow_text_properties,
984 !NILP (inherit_input_method));
985 UNGCPRO;
986 return val;
989 /* Functions that use the minibuffer to read various things. */
991 DEFUN ("read-string", Fread_string, Sread_string, 1, 5, 0,
992 doc: /* Read a string from the minibuffer, prompting with string PROMPT.
993 If non-nil, second arg INITIAL-INPUT is a string to insert before reading.
994 This argument has been superseded by DEFAULT-VALUE and should normally
995 be nil in new code. It behaves as in `read-from-minibuffer'. See the
996 documentation string of that function for details.
997 The third arg HISTORY, if non-nil, specifies a history list
998 and optionally the initial position in the list.
999 See `read-from-minibuffer' for details of HISTORY argument.
1000 Fourth arg DEFAULT-VALUE is the default value or the list of default values.
1001 If non-nil, it is used for history commands, and as the value (or the first
1002 element of the list of default values) to return if the user enters the
1003 empty string.
1004 Fifth arg INHERIT-INPUT-METHOD, if non-nil, means the minibuffer inherits
1005 the current input method and the setting of `enable-multibyte-characters'. */)
1006 (Lisp_Object prompt, Lisp_Object initial_input, Lisp_Object history, Lisp_Object default_value, Lisp_Object inherit_input_method)
1008 Lisp_Object val;
1009 ptrdiff_t count = SPECPDL_INDEX ();
1011 /* Just in case we're in a recursive minibuffer, make it clear that the
1012 previous minibuffer's completion table does not apply to the new
1013 minibuffer.
1014 FIXME: `minibuffer-completion-table' should be buffer-local instead. */
1015 specbind (Qminibuffer_completion_table, Qnil);
1017 val = Fread_from_minibuffer (prompt, initial_input, Qnil,
1018 Qnil, history, default_value,
1019 inherit_input_method);
1020 if (STRINGP (val) && SCHARS (val) == 0 && ! NILP (default_value))
1021 val = CONSP (default_value) ? XCAR (default_value) : default_value;
1022 return unbind_to (count, val);
1025 DEFUN ("read-no-blanks-input", Fread_no_blanks_input, Sread_no_blanks_input, 1, 3, 0,
1026 doc: /* Read a string from the terminal, not allowing blanks.
1027 Prompt with PROMPT. Whitespace terminates the input. If INITIAL is
1028 non-nil, it should be a string, which is used as initial input, with
1029 point positioned at the end, so that SPACE will accept the input.
1030 \(Actually, INITIAL can also be a cons of a string and an integer.
1031 Such values are treated as in `read-from-minibuffer', but are normally
1032 not useful in this function.)
1033 Third arg INHERIT-INPUT-METHOD, if non-nil, means the minibuffer inherits
1034 the current input method and the setting of`enable-multibyte-characters'. */)
1035 (Lisp_Object prompt, Lisp_Object initial, Lisp_Object inherit_input_method)
1037 CHECK_STRING (prompt);
1038 return read_minibuf (Vminibuffer_local_ns_map, initial, prompt,
1039 0, Qminibuffer_history, make_number (0), Qnil, 0,
1040 !NILP (inherit_input_method));
1043 DEFUN ("read-command", Fread_command, Sread_command, 1, 2, 0,
1044 doc: /* Read the name of a command and return as a symbol.
1045 Prompt with PROMPT. By default, return DEFAULT-VALUE or its first element
1046 if it is a list. */)
1047 (Lisp_Object prompt, Lisp_Object default_value)
1049 Lisp_Object name, default_string;
1051 if (NILP (default_value))
1052 default_string = Qnil;
1053 else if (SYMBOLP (default_value))
1054 default_string = SYMBOL_NAME (default_value);
1055 else
1056 default_string = default_value;
1058 name = Fcompleting_read (prompt, Vobarray, Qcommandp, Qt,
1059 Qnil, Qnil, default_string, Qnil);
1060 if (NILP (name))
1061 return name;
1062 return Fintern (name, Qnil);
1065 #ifdef NOTDEF
1066 DEFUN ("read-function", Fread_function, Sread_function, 1, 1, 0,
1067 doc: /* One arg PROMPT, a string. Read the name of a function and return as a symbol.
1068 Prompt with PROMPT. */)
1069 (Lisp_Object prompt)
1071 return Fintern (Fcompleting_read (prompt, Vobarray, Qfboundp, Qt, Qnil, Qnil, Qnil, Qnil),
1072 Qnil);
1074 #endif /* NOTDEF */
1076 DEFUN ("read-variable", Fread_variable, Sread_variable, 1, 2, 0,
1077 doc: /* Read the name of a user option and return it as a symbol.
1078 Prompt with PROMPT. By default, return DEFAULT-VALUE or its first element
1079 if it is a list.
1080 A user option, or customizable variable, is one for which
1081 `custom-variable-p' returns non-nil. */)
1082 (Lisp_Object prompt, Lisp_Object default_value)
1084 Lisp_Object name, default_string;
1086 if (NILP (default_value))
1087 default_string = Qnil;
1088 else if (SYMBOLP (default_value))
1089 default_string = SYMBOL_NAME (default_value);
1090 else
1091 default_string = default_value;
1093 name = Fcompleting_read (prompt, Vobarray,
1094 Qcustom_variable_p, Qt,
1095 Qnil, Qnil, default_string, Qnil);
1096 if (NILP (name))
1097 return name;
1098 return Fintern (name, Qnil);
1101 DEFUN ("read-buffer", Fread_buffer, Sread_buffer, 1, 3, 0,
1102 doc: /* Read the name of a buffer and return as a string.
1103 Prompt with PROMPT.
1104 Optional second arg DEF is value to return if user enters an empty line.
1105 If DEF is a list of default values, return its first element.
1106 Optional third arg REQUIRE-MATCH determines whether non-existing
1107 buffer names are allowed. It has the same meaning as the
1108 REQUIRE-MATCH argument of `completing-read'.
1109 The argument PROMPT should be a string ending with a colon and a space.
1110 If `read-buffer-completion-ignore-case' is non-nil, completion ignores
1111 case while reading the buffer name.
1112 If `read-buffer-function' is non-nil, this works by calling it as a
1113 function, instead of the usual behavior. */)
1114 (Lisp_Object prompt, Lisp_Object def, Lisp_Object require_match)
1116 Lisp_Object args[4], result;
1117 char *s;
1118 ptrdiff_t len;
1119 ptrdiff_t count = SPECPDL_INDEX ();
1121 if (BUFFERP (def))
1122 def = BVAR (XBUFFER (def), name);
1124 specbind (Qcompletion_ignore_case,
1125 read_buffer_completion_ignore_case ? Qt : Qnil);
1127 if (NILP (Vread_buffer_function))
1129 if (!NILP (def))
1131 /* A default value was provided: we must change PROMPT,
1132 editing the default value in before the colon. To achieve
1133 this, we replace PROMPT with a substring that doesn't
1134 contain the terminal space and colon (if present). They
1135 are then added back using Fformat. */
1137 if (STRINGP (prompt))
1139 s = SSDATA (prompt);
1140 len = SBYTES (prompt);
1141 if (len >= 2 && s[len - 2] == ':' && s[len - 1] == ' ')
1142 len = len - 2;
1143 else if (len >= 1 && (s[len - 1] == ':' || s[len - 1] == ' '))
1144 len--;
1146 prompt = make_specified_string (s, -1, len,
1147 STRING_MULTIBYTE (prompt));
1150 args[0] = build_string ("%s (default %s): ");
1151 args[1] = prompt;
1152 args[2] = CONSP (def) ? XCAR (def) : def;
1153 prompt = Fformat (3, args);
1156 result = Fcompleting_read (prompt, intern ("internal-complete-buffer"),
1157 Qnil, require_match, Qnil,
1158 Qbuffer_name_history, def, Qnil);
1160 else
1162 args[0] = Vread_buffer_function;
1163 args[1] = prompt;
1164 args[2] = def;
1165 args[3] = require_match;
1166 result = Ffuncall (4, args);
1168 return unbind_to (count, result);
1171 static Lisp_Object
1172 minibuf_conform_representation (Lisp_Object string, Lisp_Object basis)
1174 if (STRING_MULTIBYTE (string) == STRING_MULTIBYTE (basis))
1175 return string;
1177 if (STRING_MULTIBYTE (string))
1178 return Fstring_make_unibyte (string);
1179 else
1180 return Fstring_make_multibyte (string);
1183 DEFUN ("try-completion", Ftry_completion, Stry_completion, 2, 3, 0,
1184 doc: /* Return common substring of all completions of STRING in COLLECTION.
1185 Test each possible completion specified by COLLECTION
1186 to see if it begins with STRING. The possible completions may be
1187 strings or symbols. Symbols are converted to strings before testing,
1188 see `symbol-name'.
1189 All that match STRING are compared together; the longest initial sequence
1190 common to all these matches is the return value.
1191 If there is no match at all, the return value is nil.
1192 For a unique match which is exact, the return value is t.
1194 If COLLECTION is an alist, the keys (cars of elements) are the
1195 possible completions. If an element is not a cons cell, then the
1196 element itself is the possible completion.
1197 If COLLECTION is a hash-table, all the keys that are strings or symbols
1198 are the possible completions.
1199 If COLLECTION is an obarray, the names of all symbols in the obarray
1200 are the possible completions.
1202 COLLECTION can also be a function to do the completion itself.
1203 It receives three arguments: the values STRING, PREDICATE and nil.
1204 Whatever it returns becomes the value of `try-completion'.
1206 If optional third argument PREDICATE is non-nil,
1207 it is used to test each possible match.
1208 The match is a candidate only if PREDICATE returns non-nil.
1209 The argument given to PREDICATE is the alist element
1210 or the symbol from the obarray. If COLLECTION is a hash-table,
1211 predicate is called with two arguments: the key and the value.
1212 Additionally to this predicate, `completion-regexp-list'
1213 is used to further constrain the set of candidates. */)
1214 (Lisp_Object string, Lisp_Object collection, Lisp_Object predicate)
1216 Lisp_Object bestmatch, tail, elt, eltstring;
1217 /* Size in bytes of BESTMATCH. */
1218 ptrdiff_t bestmatchsize = 0;
1219 /* These are in bytes, too. */
1220 ptrdiff_t compare, matchsize;
1221 enum { function_table, list_table, obarray_table, hash_table}
1222 type = (HASH_TABLE_P (collection) ? hash_table
1223 : VECTORP (collection) ? obarray_table
1224 : ((NILP (collection)
1225 || (CONSP (collection)
1226 && (!SYMBOLP (XCAR (collection))
1227 || NILP (XCAR (collection)))))
1228 ? list_table : function_table));
1229 ptrdiff_t idx = 0, obsize = 0;
1230 int matchcount = 0;
1231 ptrdiff_t bindcount = -1;
1232 Lisp_Object bucket, zero, end, tem;
1233 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
1235 CHECK_STRING (string);
1236 if (type == function_table)
1237 return call3 (collection, string, predicate, Qnil);
1239 bestmatch = bucket = Qnil;
1240 zero = make_number (0);
1242 /* If COLLECTION is not a list, set TAIL just for gc pro. */
1243 tail = collection;
1244 if (type == obarray_table)
1246 collection = check_obarray (collection);
1247 obsize = ASIZE (collection);
1248 bucket = AREF (collection, idx);
1251 while (1)
1253 /* Get the next element of the alist, obarray, or hash-table. */
1254 /* Exit the loop if the elements are all used up. */
1255 /* elt gets the alist element or symbol.
1256 eltstring gets the name to check as a completion. */
1258 if (type == list_table)
1260 if (!CONSP (tail))
1261 break;
1262 elt = XCAR (tail);
1263 eltstring = CONSP (elt) ? XCAR (elt) : elt;
1264 tail = XCDR (tail);
1266 else if (type == obarray_table)
1268 if (!EQ (bucket, zero))
1270 if (!SYMBOLP (bucket))
1271 error ("Bad data in guts of obarray");
1272 elt = bucket;
1273 eltstring = elt;
1274 if (XSYMBOL (bucket)->next)
1275 XSETSYMBOL (bucket, XSYMBOL (bucket)->next);
1276 else
1277 XSETFASTINT (bucket, 0);
1279 else if (++idx >= obsize)
1280 break;
1281 else
1283 bucket = AREF (collection, idx);
1284 continue;
1287 else /* if (type == hash_table) */
1289 while (idx < HASH_TABLE_SIZE (XHASH_TABLE (collection))
1290 && NILP (HASH_HASH (XHASH_TABLE (collection), idx)))
1291 idx++;
1292 if (idx >= HASH_TABLE_SIZE (XHASH_TABLE (collection)))
1293 break;
1294 else
1295 elt = eltstring = HASH_KEY (XHASH_TABLE (collection), idx++);
1298 /* Is this element a possible completion? */
1300 if (SYMBOLP (eltstring))
1301 eltstring = Fsymbol_name (eltstring);
1303 if (STRINGP (eltstring)
1304 && SCHARS (string) <= SCHARS (eltstring)
1305 && (tem = Fcompare_strings (eltstring, zero,
1306 make_number (SCHARS (string)),
1307 string, zero, Qnil,
1308 completion_ignore_case ? Qt : Qnil),
1309 EQ (Qt, tem)))
1311 /* Yes. */
1312 Lisp_Object regexps;
1314 /* Ignore this element if it fails to match all the regexps. */
1316 for (regexps = Vcompletion_regexp_list; CONSP (regexps);
1317 regexps = XCDR (regexps))
1319 if (bindcount < 0) {
1320 bindcount = SPECPDL_INDEX ();
1321 specbind (Qcase_fold_search,
1322 completion_ignore_case ? Qt : Qnil);
1324 tem = Fstring_match (XCAR (regexps), eltstring, zero);
1325 if (NILP (tem))
1326 break;
1328 if (CONSP (regexps))
1329 continue;
1332 /* Ignore this element if there is a predicate
1333 and the predicate doesn't like it. */
1335 if (!NILP (predicate))
1337 if (EQ (predicate, Qcommandp))
1338 tem = Fcommandp (elt, Qnil);
1339 else
1341 if (bindcount >= 0)
1343 unbind_to (bindcount, Qnil);
1344 bindcount = -1;
1346 GCPRO4 (tail, string, eltstring, bestmatch);
1347 tem = (type == hash_table
1348 ? call2 (predicate, elt,
1349 HASH_VALUE (XHASH_TABLE (collection),
1350 idx - 1))
1351 : call1 (predicate, elt));
1352 UNGCPRO;
1354 if (NILP (tem)) continue;
1357 /* Update computation of how much all possible completions match */
1359 if (NILP (bestmatch))
1361 matchcount = 1;
1362 bestmatch = eltstring;
1363 bestmatchsize = SCHARS (eltstring);
1365 else
1367 compare = min (bestmatchsize, SCHARS (eltstring));
1368 tem = Fcompare_strings (bestmatch, zero,
1369 make_number (compare),
1370 eltstring, zero,
1371 make_number (compare),
1372 completion_ignore_case ? Qt : Qnil);
1373 matchsize = EQ (tem, Qt) ? compare : eabs (XINT (tem)) - 1;
1375 if (completion_ignore_case)
1377 /* If this is an exact match except for case,
1378 use it as the best match rather than one that is not an
1379 exact match. This way, we get the case pattern
1380 of the actual match. */
1381 if ((matchsize == SCHARS (eltstring)
1382 && matchsize < SCHARS (bestmatch))
1384 /* If there is more than one exact match ignoring case,
1385 and one of them is exact including case,
1386 prefer that one. */
1387 /* If there is no exact match ignoring case,
1388 prefer a match that does not change the case
1389 of the input. */
1390 ((matchsize == SCHARS (eltstring))
1392 (matchsize == SCHARS (bestmatch))
1393 && (tem = Fcompare_strings (eltstring, zero,
1394 make_number (SCHARS (string)),
1395 string, zero,
1396 Qnil,
1397 Qnil),
1398 EQ (Qt, tem))
1399 && (tem = Fcompare_strings (bestmatch, zero,
1400 make_number (SCHARS (string)),
1401 string, zero,
1402 Qnil,
1403 Qnil),
1404 ! EQ (Qt, tem))))
1405 bestmatch = eltstring;
1407 if (bestmatchsize != SCHARS (eltstring)
1408 || bestmatchsize != matchsize)
1409 /* Don't count the same string multiple times. */
1410 matchcount += matchcount <= 1;
1411 bestmatchsize = matchsize;
1412 if (matchsize <= SCHARS (string)
1413 /* If completion-ignore-case is non-nil, don't
1414 short-circuit because we want to find the best
1415 possible match *including* case differences. */
1416 && !completion_ignore_case
1417 && matchcount > 1)
1418 /* No need to look any further. */
1419 break;
1424 if (bindcount >= 0) {
1425 unbind_to (bindcount, Qnil);
1426 bindcount = -1;
1429 if (NILP (bestmatch))
1430 return Qnil; /* No completions found. */
1431 /* If we are ignoring case, and there is no exact match,
1432 and no additional text was supplied,
1433 don't change the case of what the user typed. */
1434 if (completion_ignore_case && bestmatchsize == SCHARS (string)
1435 && SCHARS (bestmatch) > bestmatchsize)
1436 return minibuf_conform_representation (string, bestmatch);
1438 /* Return t if the supplied string is an exact match (counting case);
1439 it does not require any change to be made. */
1440 if (matchcount == 1 && !NILP (Fequal (bestmatch, string)))
1441 return Qt;
1443 XSETFASTINT (zero, 0); /* Else extract the part in which */
1444 XSETFASTINT (end, bestmatchsize); /* all completions agree. */
1445 return Fsubstring (bestmatch, zero, end);
1448 DEFUN ("all-completions", Fall_completions, Sall_completions, 2, 4, 0,
1449 doc: /* Search for partial matches to STRING in COLLECTION.
1450 Test each of the possible completions specified by COLLECTION
1451 to see if it begins with STRING. The possible completions may be
1452 strings or symbols. Symbols are converted to strings before testing,
1453 see `symbol-name'.
1454 The value is a list of all the possible completions that match STRING.
1456 If COLLECTION is an alist, the keys (cars of elements) are the
1457 possible completions. If an element is not a cons cell, then the
1458 element itself is the possible completion.
1459 If COLLECTION is a hash-table, all the keys that are strings or symbols
1460 are the possible completions.
1461 If COLLECTION is an obarray, the names of all symbols in the obarray
1462 are the possible completions.
1464 COLLECTION can also be a function to do the completion itself.
1465 It receives three arguments: the values STRING, PREDICATE and t.
1466 Whatever it returns becomes the value of `all-completions'.
1468 If optional third argument PREDICATE is non-nil,
1469 it is used to test each possible match.
1470 The match is a candidate only if PREDICATE returns non-nil.
1471 The argument given to PREDICATE is the alist element
1472 or the symbol from the obarray. If COLLECTION is a hash-table,
1473 predicate is called with two arguments: the key and the value.
1474 Additionally to this predicate, `completion-regexp-list'
1475 is used to further constrain the set of candidates.
1477 An obsolete optional fourth argument HIDE-SPACES is still accepted for
1478 backward compatibility. If non-nil, strings in COLLECTION that start
1479 with a space are ignored unless STRING itself starts with a space. */)
1480 (Lisp_Object string, Lisp_Object collection, Lisp_Object predicate, Lisp_Object hide_spaces)
1482 Lisp_Object tail, elt, eltstring;
1483 Lisp_Object allmatches;
1484 int type = HASH_TABLE_P (collection) ? 3
1485 : VECTORP (collection) ? 2
1486 : NILP (collection) || (CONSP (collection)
1487 && (!SYMBOLP (XCAR (collection))
1488 || NILP (XCAR (collection))));
1489 ptrdiff_t idx = 0, obsize = 0;
1490 ptrdiff_t bindcount = -1;
1491 Lisp_Object bucket, tem, zero;
1492 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
1494 CHECK_STRING (string);
1495 if (type == 0)
1496 return call3 (collection, string, predicate, Qt);
1497 allmatches = bucket = Qnil;
1498 zero = make_number (0);
1500 /* If COLLECTION is not a list, set TAIL just for gc pro. */
1501 tail = collection;
1502 if (type == 2)
1504 collection = check_obarray (collection);
1505 obsize = ASIZE (collection);
1506 bucket = AREF (collection, idx);
1509 while (1)
1511 /* Get the next element of the alist, obarray, or hash-table. */
1512 /* Exit the loop if the elements are all used up. */
1513 /* elt gets the alist element or symbol.
1514 eltstring gets the name to check as a completion. */
1516 if (type == 1)
1518 if (!CONSP (tail))
1519 break;
1520 elt = XCAR (tail);
1521 eltstring = CONSP (elt) ? XCAR (elt) : elt;
1522 tail = XCDR (tail);
1524 else if (type == 2)
1526 if (!EQ (bucket, zero))
1528 if (!SYMBOLP (bucket))
1529 error ("Bad data in guts of obarray");
1530 elt = bucket;
1531 eltstring = elt;
1532 if (XSYMBOL (bucket)->next)
1533 XSETSYMBOL (bucket, XSYMBOL (bucket)->next);
1534 else
1535 XSETFASTINT (bucket, 0);
1537 else if (++idx >= obsize)
1538 break;
1539 else
1541 bucket = AREF (collection, idx);
1542 continue;
1545 else /* if (type == 3) */
1547 while (idx < HASH_TABLE_SIZE (XHASH_TABLE (collection))
1548 && NILP (HASH_HASH (XHASH_TABLE (collection), idx)))
1549 idx++;
1550 if (idx >= HASH_TABLE_SIZE (XHASH_TABLE (collection)))
1551 break;
1552 else
1553 elt = eltstring = HASH_KEY (XHASH_TABLE (collection), idx++);
1556 /* Is this element a possible completion? */
1558 if (SYMBOLP (eltstring))
1559 eltstring = Fsymbol_name (eltstring);
1561 if (STRINGP (eltstring)
1562 && SCHARS (string) <= SCHARS (eltstring)
1563 /* If HIDE_SPACES, reject alternatives that start with space
1564 unless the input starts with space. */
1565 && (NILP (hide_spaces)
1566 || (SBYTES (string) > 0
1567 && SREF (string, 0) == ' ')
1568 || SREF (eltstring, 0) != ' ')
1569 && (tem = Fcompare_strings (eltstring, zero,
1570 make_number (SCHARS (string)),
1571 string, zero,
1572 make_number (SCHARS (string)),
1573 completion_ignore_case ? Qt : Qnil),
1574 EQ (Qt, tem)))
1576 /* Yes. */
1577 Lisp_Object regexps;
1579 /* Ignore this element if it fails to match all the regexps. */
1581 for (regexps = Vcompletion_regexp_list; CONSP (regexps);
1582 regexps = XCDR (regexps))
1584 if (bindcount < 0) {
1585 bindcount = SPECPDL_INDEX ();
1586 specbind (Qcase_fold_search,
1587 completion_ignore_case ? Qt : Qnil);
1589 tem = Fstring_match (XCAR (regexps), eltstring, zero);
1590 if (NILP (tem))
1591 break;
1593 if (CONSP (regexps))
1594 continue;
1597 /* Ignore this element if there is a predicate
1598 and the predicate doesn't like it. */
1600 if (!NILP (predicate))
1602 if (EQ (predicate, Qcommandp))
1603 tem = Fcommandp (elt, Qnil);
1604 else
1606 if (bindcount >= 0) {
1607 unbind_to (bindcount, Qnil);
1608 bindcount = -1;
1610 GCPRO4 (tail, eltstring, allmatches, string);
1611 tem = type == 3
1612 ? call2 (predicate, elt,
1613 HASH_VALUE (XHASH_TABLE (collection), idx - 1))
1614 : call1 (predicate, elt);
1615 UNGCPRO;
1617 if (NILP (tem)) continue;
1619 /* Ok => put it on the list. */
1620 allmatches = Fcons (eltstring, allmatches);
1624 if (bindcount >= 0) {
1625 unbind_to (bindcount, Qnil);
1626 bindcount = -1;
1629 return Fnreverse (allmatches);
1632 DEFUN ("completing-read", Fcompleting_read, Scompleting_read, 2, 8, 0,
1633 doc: /* Read a string in the minibuffer, with completion.
1634 PROMPT is a string to prompt with; normally it ends in a colon and a space.
1635 COLLECTION can be a list of strings, an alist, an obarray or a hash table.
1636 COLLECTION can also be a function to do the completion itself.
1637 PREDICATE limits completion to a subset of COLLECTION.
1638 See `try-completion' and `all-completions' for more details
1639 on completion, COLLECTION, and PREDICATE.
1641 REQUIRE-MATCH can take the following values:
1642 - t means that the user is not allowed to exit unless
1643 the input is (or completes to) an element of COLLECTION or is null.
1644 - nil means that the user can exit with any input.
1645 - `confirm' means that the user can exit with any input, but she needs
1646 to confirm her choice if the input is not an element of COLLECTION.
1647 - `confirm-after-completion' means that the user can exit with any
1648 input, but she needs to confirm her choice if she called
1649 `minibuffer-complete' right before `minibuffer-complete-and-exit'
1650 and the input is not an element of COLLECTION.
1651 - anything else behaves like t except that typing RET does not exit if it
1652 does non-null completion.
1654 If the input is null, `completing-read' returns DEF, or the first element
1655 of the list of default values, or an empty string if DEF is nil,
1656 regardless of the value of REQUIRE-MATCH.
1658 If INITIAL-INPUT is non-nil, insert it in the minibuffer initially,
1659 with point positioned at the end.
1660 If it is (STRING . POSITION), the initial input is STRING, but point
1661 is placed at _zero-indexed_ position POSITION in STRING. (*Note*
1662 that this is different from `read-from-minibuffer' and related
1663 functions, which use one-indexing for POSITION.) This feature is
1664 deprecated--it is best to pass nil for INITIAL-INPUT and supply the
1665 default value DEF instead. The user can yank the default value into
1666 the minibuffer easily using \\<minibuffer-local-map>\\[next-history-element].
1668 HIST, if non-nil, specifies a history list and optionally the initial
1669 position in the list. It can be a symbol, which is the history list
1670 variable to use, or it can be a cons cell (HISTVAR . HISTPOS). In
1671 that case, HISTVAR is the history list variable to use, and HISTPOS
1672 is the initial position (the position in the list used by the
1673 minibuffer history commands). For consistency, you should also
1674 specify that element of the history as the value of
1675 INITIAL-INPUT. (This is the only case in which you should use
1676 INITIAL-INPUT instead of DEF.) Positions are counted starting from
1677 1 at the beginning of the list. The variable `history-length'
1678 controls the maximum length of a history list.
1680 DEF, if non-nil, is the default value or the list of default values.
1682 If INHERIT-INPUT-METHOD is non-nil, the minibuffer inherits
1683 the current input method and the setting of `enable-multibyte-characters'.
1685 Completion ignores case if the ambient value of
1686 `completion-ignore-case' is non-nil.
1688 See also `completing-read-function'. */)
1689 (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)
1691 Lisp_Object args[9];
1692 args[0] = Fsymbol_value (intern ("completing-read-function"));
1693 args[1] = prompt;
1694 args[2] = collection;
1695 args[3] = predicate;
1696 args[4] = require_match;
1697 args[5] = initial_input;
1698 args[6] = hist;
1699 args[7] = def;
1700 args[8] = inherit_input_method;
1701 return Ffuncall (9, args);
1704 /* Test whether TXT is an exact completion. */
1705 DEFUN ("test-completion", Ftest_completion, Stest_completion, 2, 3, 0,
1706 doc: /* Return non-nil if STRING is a valid completion.
1707 Takes the same arguments as `all-completions' and `try-completion'.
1708 If COLLECTION is a function, it is called with three arguments:
1709 the values STRING, PREDICATE and `lambda'. */)
1710 (Lisp_Object string, Lisp_Object collection, Lisp_Object predicate)
1712 Lisp_Object regexps, tail, tem = Qnil;
1713 ptrdiff_t i = 0;
1715 CHECK_STRING (string);
1717 if ((CONSP (collection)
1718 && (!SYMBOLP (XCAR (collection)) || NILP (XCAR (collection))))
1719 || NILP (collection))
1721 tem = Fassoc_string (string, collection, completion_ignore_case ? Qt : Qnil);
1722 if (NILP (tem))
1723 return Qnil;
1725 else if (VECTORP (collection))
1727 /* Bypass intern-soft as that loses for nil. */
1728 tem = oblookup (collection,
1729 SSDATA (string),
1730 SCHARS (string),
1731 SBYTES (string));
1732 if (!SYMBOLP (tem))
1734 if (STRING_MULTIBYTE (string))
1735 string = Fstring_make_unibyte (string);
1736 else
1737 string = Fstring_make_multibyte (string);
1739 tem = oblookup (collection,
1740 SSDATA (string),
1741 SCHARS (string),
1742 SBYTES (string));
1745 if (completion_ignore_case && !SYMBOLP (tem))
1747 for (i = ASIZE (collection) - 1; i >= 0; i--)
1749 tail = AREF (collection, i);
1750 if (SYMBOLP (tail))
1751 while (1)
1753 if (EQ (Fcompare_strings (string, make_number (0), Qnil,
1754 Fsymbol_name (tail),
1755 make_number (0) , Qnil, Qt),
1756 Qt))
1758 tem = tail;
1759 break;
1761 if (XSYMBOL (tail)->next == 0)
1762 break;
1763 XSETSYMBOL (tail, XSYMBOL (tail)->next);
1768 if (!SYMBOLP (tem))
1769 return Qnil;
1771 else if (HASH_TABLE_P (collection))
1773 struct Lisp_Hash_Table *h = XHASH_TABLE (collection);
1774 Lisp_Object key = Qnil;
1775 i = hash_lookup (h, string, NULL);
1776 if (i >= 0)
1777 tem = HASH_KEY (h, i);
1778 else
1779 for (i = 0; i < HASH_TABLE_SIZE (h); ++i)
1780 if (!NILP (HASH_HASH (h, i))
1781 && (key = HASH_KEY (h, i),
1782 SYMBOLP (key) ? key = Fsymbol_name (key) : key,
1783 STRINGP (key))
1784 && EQ (Fcompare_strings (string, make_number (0), Qnil,
1785 key, make_number (0) , Qnil,
1786 completion_ignore_case ? Qt : Qnil),
1787 Qt))
1789 tem = key;
1790 break;
1792 if (!STRINGP (tem))
1793 return Qnil;
1795 else
1796 return call3 (collection, string, predicate, Qlambda);
1798 /* Reject this element if it fails to match all the regexps. */
1799 if (CONSP (Vcompletion_regexp_list))
1801 ptrdiff_t count = SPECPDL_INDEX ();
1802 specbind (Qcase_fold_search, completion_ignore_case ? Qt : Qnil);
1803 for (regexps = Vcompletion_regexp_list; CONSP (regexps);
1804 regexps = XCDR (regexps))
1806 if (NILP (Fstring_match (XCAR (regexps),
1807 SYMBOLP (tem) ? string : tem,
1808 Qnil)))
1809 return unbind_to (count, Qnil);
1811 unbind_to (count, Qnil);
1814 /* Finally, check the predicate. */
1815 if (!NILP (predicate))
1817 return HASH_TABLE_P (collection)
1818 ? call2 (predicate, tem, HASH_VALUE (XHASH_TABLE (collection), i))
1819 : call1 (predicate, tem);
1821 else
1822 return Qt;
1825 static Lisp_Object Qmetadata;
1827 DEFUN ("internal-complete-buffer", Finternal_complete_buffer, Sinternal_complete_buffer, 3, 3, 0,
1828 doc: /* Perform completion on buffer names.
1829 STRING and PREDICATE have the same meanings as in `try-completion',
1830 `all-completions', and `test-completion'.
1832 If FLAG is nil, invoke `try-completion'; if it is t, invoke
1833 `all-completions'; otherwise invoke `test-completion'. */)
1834 (Lisp_Object string, Lisp_Object predicate, Lisp_Object flag)
1836 if (NILP (flag))
1837 return Ftry_completion (string, Vbuffer_alist, predicate);
1838 else if (EQ (flag, Qt))
1840 Lisp_Object res = Fall_completions (string, Vbuffer_alist, predicate, Qnil);
1841 if (SCHARS (string) > 0)
1842 return res;
1843 else
1844 { /* Strip out internal buffers. */
1845 Lisp_Object bufs = res;
1846 /* First, look for a non-internal buffer in `res'. */
1847 while (CONSP (bufs) && SREF (XCAR (bufs), 0) == ' ')
1848 bufs = XCDR (bufs);
1849 if (NILP (bufs))
1850 return (EQ (Flength (res), Flength (Vbuffer_alist))
1851 /* If all bufs are internal don't strip them out. */
1852 ? res : bufs);
1853 res = bufs;
1854 while (CONSP (XCDR (bufs)))
1855 if (SREF (XCAR (XCDR (bufs)), 0) == ' ')
1856 XSETCDR (bufs, XCDR (XCDR (bufs)));
1857 else
1858 bufs = XCDR (bufs);
1859 return res;
1862 else if (EQ (flag, Qlambda))
1863 return Ftest_completion (string, Vbuffer_alist, predicate);
1864 else if (EQ (flag, Qmetadata))
1865 return Fcons (Qmetadata, Fcons (Fcons (Qcategory, Qbuffer), Qnil));
1866 else
1867 return Qnil;
1870 /* Like assoc but assumes KEY is a string, and ignores case if appropriate. */
1872 DEFUN ("assoc-string", Fassoc_string, Sassoc_string, 2, 3, 0,
1873 doc: /* Like `assoc' but specifically for strings (and symbols).
1875 This returns the first element of LIST whose car matches the string or
1876 symbol KEY, or nil if no match exists. When performing the
1877 comparison, symbols are first converted to strings, and unibyte
1878 strings to multibyte. If the optional arg CASE-FOLD is non-nil, case
1879 is ignored.
1881 Unlike `assoc', KEY can also match an entry in LIST consisting of a
1882 single string, rather than a cons cell whose car is a string. */)
1883 (register Lisp_Object key, Lisp_Object list, Lisp_Object case_fold)
1885 register Lisp_Object tail;
1887 if (SYMBOLP (key))
1888 key = Fsymbol_name (key);
1890 for (tail = list; CONSP (tail); tail = XCDR (tail))
1892 register Lisp_Object elt, tem, thiscar;
1893 elt = XCAR (tail);
1894 thiscar = CONSP (elt) ? XCAR (elt) : elt;
1895 if (SYMBOLP (thiscar))
1896 thiscar = Fsymbol_name (thiscar);
1897 else if (!STRINGP (thiscar))
1898 continue;
1899 tem = Fcompare_strings (thiscar, make_number (0), Qnil,
1900 key, make_number (0), Qnil,
1901 case_fold);
1902 if (EQ (tem, Qt))
1903 return elt;
1904 QUIT;
1906 return Qnil;
1910 DEFUN ("minibuffer-depth", Fminibuffer_depth, Sminibuffer_depth, 0, 0, 0,
1911 doc: /* Return current depth of activations of minibuffer, a nonnegative integer. */)
1912 (void)
1914 return make_number (minibuf_level);
1917 DEFUN ("minibuffer-prompt", Fminibuffer_prompt, Sminibuffer_prompt, 0, 0, 0,
1918 doc: /* Return the prompt string of the currently-active minibuffer.
1919 If no minibuffer is active, return nil. */)
1920 (void)
1922 return Fcopy_sequence (minibuf_prompt);
1926 void
1927 init_minibuf_once (void)
1929 Vminibuffer_list = Qnil;
1930 staticpro (&Vminibuffer_list);
1933 void
1934 syms_of_minibuf (void)
1936 minibuf_level = 0;
1937 minibuf_prompt = Qnil;
1938 staticpro (&minibuf_prompt);
1940 minibuf_save_list = Qnil;
1941 staticpro (&minibuf_save_list);
1943 DEFSYM (Qcompletion_ignore_case, "completion-ignore-case");
1944 DEFSYM (Qread_file_name_internal, "read-file-name-internal");
1945 DEFSYM (Qminibuffer_default, "minibuffer-default");
1946 Fset (Qminibuffer_default, Qnil);
1948 DEFSYM (Qminibuffer_completion_table, "minibuffer-completion-table");
1949 DEFSYM (Qminibuffer_completion_confirm, "minibuffer-completion-confirm");
1950 DEFSYM (Qminibuffer_completion_predicate, "minibuffer-completion-predicate");
1952 staticpro (&last_minibuf_string);
1953 last_minibuf_string = Qnil;
1955 DEFSYM (Qminibuffer_history, "minibuffer-history");
1956 DEFSYM (Qbuffer_name_history, "buffer-name-history");
1957 Fset (Qbuffer_name_history, Qnil);
1959 DEFSYM (Qcustom_variable_p, "custom-variable-p");
1960 DEFSYM (Qminibuffer_setup_hook, "minibuffer-setup-hook");
1961 DEFSYM (Qminibuffer_exit_hook, "minibuffer-exit-hook");
1962 DEFSYM (Qhistory_length, "history-length");
1963 DEFSYM (Qcurrent_input_method, "current-input-method");
1964 DEFSYM (Qactivate_input_method, "activate-input-method");
1965 DEFSYM (Qcase_fold_search, "case-fold-search");
1966 DEFSYM (Qmetadata, "metadata");
1968 DEFVAR_LISP ("read-expression-history", Vread_expression_history,
1969 doc: /* A history list for arguments that are Lisp expressions to evaluate.
1970 For example, `eval-expression' uses this. */);
1971 Vread_expression_history = Qnil;
1973 DEFSYM (Qread_expression_history, "read-expression-history");
1975 DEFVAR_LISP ("read-buffer-function", Vread_buffer_function,
1976 doc: /* If this is non-nil, `read-buffer' does its work by calling this function.
1977 The function is called with the arguments passed to `read-buffer'. */);
1978 Vread_buffer_function = Qnil;
1980 DEFVAR_BOOL ("read-buffer-completion-ignore-case",
1981 read_buffer_completion_ignore_case,
1982 doc: /* Non-nil means completion ignores case when reading a buffer name. */);
1983 read_buffer_completion_ignore_case = 0;
1985 DEFVAR_LISP ("minibuffer-setup-hook", Vminibuffer_setup_hook,
1986 doc: /* Normal hook run just after entry to minibuffer. */);
1987 Vminibuffer_setup_hook = Qnil;
1989 DEFVAR_LISP ("minibuffer-exit-hook", Vminibuffer_exit_hook,
1990 doc: /* Normal hook run just after exit from minibuffer. */);
1991 Vminibuffer_exit_hook = Qnil;
1993 DEFVAR_LISP ("history-length", Vhistory_length,
1994 doc: /* Maximum length of history lists before truncation takes place.
1995 A number means truncate to that length; truncation deletes old
1996 elements, and is done just after inserting a new element.
1997 A value of t means no truncation.
1999 This variable only affects history lists that don't specify their own
2000 maximum lengths. Setting the `history-length' property of a history
2001 variable overrides this default. */);
2002 XSETFASTINT (Vhistory_length, 30);
2004 DEFVAR_BOOL ("history-delete-duplicates", history_delete_duplicates,
2005 doc: /* Non-nil means to delete duplicates in history.
2006 If set to t when adding a new history element, all previous identical
2007 elements are deleted from the history list. */);
2008 history_delete_duplicates = 0;
2010 DEFVAR_LISP ("history-add-new-input", Vhistory_add_new_input,
2011 doc: /* Non-nil means to add new elements in history.
2012 If set to nil, minibuffer reading functions don't add new elements to the
2013 history list, so it is possible to do this afterwards by calling
2014 `add-to-history' explicitly. */);
2015 Vhistory_add_new_input = Qt;
2017 DEFVAR_BOOL ("completion-ignore-case", completion_ignore_case,
2018 doc: /* Non-nil means don't consider case significant in completion.
2019 For file-name completion, `read-file-name-completion-ignore-case'
2020 controls the behavior, rather than this variable.
2021 For buffer name completion, `read-buffer-completion-ignore-case'
2022 controls the behavior, rather than this variable. */);
2023 completion_ignore_case = 0;
2025 DEFVAR_BOOL ("enable-recursive-minibuffers", enable_recursive_minibuffers,
2026 doc: /* Non-nil means to allow minibuffer commands while in the minibuffer.
2027 This variable makes a difference whenever the minibuffer window is active. */);
2028 enable_recursive_minibuffers = 0;
2030 DEFVAR_LISP ("minibuffer-completion-table", Vminibuffer_completion_table,
2031 doc: /* Alist or obarray used for completion in the minibuffer.
2032 This becomes the ALIST argument to `try-completion' and `all-completions'.
2033 The value can also be a list of strings or a hash table.
2035 The value may alternatively be a function, which is given three arguments:
2036 STRING, the current buffer contents;
2037 PREDICATE, the predicate for filtering possible matches;
2038 CODE, which says what kind of things to do.
2039 CODE can be nil, t or `lambda':
2040 nil -- return the best completion of STRING, or nil if there is none.
2041 t -- return a list of all possible completions of STRING.
2042 lambda -- return t if STRING is a valid completion as it stands. */);
2043 Vminibuffer_completion_table = Qnil;
2045 DEFVAR_LISP ("minibuffer-completion-predicate", Vminibuffer_completion_predicate,
2046 doc: /* Within call to `completing-read', this holds the PREDICATE argument. */);
2047 Vminibuffer_completion_predicate = Qnil;
2049 DEFVAR_LISP ("minibuffer-completion-confirm", Vminibuffer_completion_confirm,
2050 doc: /* Whether to demand confirmation of completion before exiting minibuffer.
2051 If nil, confirmation is not required.
2052 If the value is `confirm', the user may exit with an input that is not
2053 a valid completion alternative, but Emacs asks for confirmation.
2054 If the value is `confirm-after-completion', the user may exit with an
2055 input that is not a valid completion alternative, but Emacs asks for
2056 confirmation if the user submitted the input right after any of the
2057 completion commands listed in `minibuffer-confirm-exit-commands'. */);
2058 Vminibuffer_completion_confirm = Qnil;
2060 DEFVAR_LISP ("minibuffer-completing-file-name",
2061 Vminibuffer_completing_file_name,
2062 doc: /* Non-nil means completing file names. */);
2063 Vminibuffer_completing_file_name = Qnil;
2065 DEFVAR_LISP ("minibuffer-help-form", Vminibuffer_help_form,
2066 doc: /* Value that `help-form' takes on inside the minibuffer. */);
2067 Vminibuffer_help_form = Qnil;
2069 DEFVAR_LISP ("minibuffer-history-variable", Vminibuffer_history_variable,
2070 doc: /* History list symbol to add minibuffer values to.
2071 Each string of minibuffer input, as it appears on exit from the minibuffer,
2072 is added with
2073 (set minibuffer-history-variable
2074 (cons STRING (symbol-value minibuffer-history-variable))) */);
2075 XSETFASTINT (Vminibuffer_history_variable, 0);
2077 DEFVAR_LISP ("minibuffer-history-position", Vminibuffer_history_position,
2078 doc: /* Current position of redoing in the history list. */);
2079 Vminibuffer_history_position = Qnil;
2081 DEFVAR_BOOL ("minibuffer-auto-raise", minibuffer_auto_raise,
2082 doc: /* Non-nil means entering the minibuffer raises the minibuffer's frame.
2083 Some uses of the echo area also raise that frame (since they use it too). */);
2084 minibuffer_auto_raise = 0;
2086 DEFVAR_LISP ("completion-regexp-list", Vcompletion_regexp_list,
2087 doc: /* List of regexps that should restrict possible completions.
2088 The basic completion functions only consider a completion acceptable
2089 if it matches all regular expressions in this list, with
2090 `case-fold-search' bound to the value of `completion-ignore-case'.
2091 See Info node `(elisp)Basic Completion', for a description of these
2092 functions. */);
2093 Vcompletion_regexp_list = Qnil;
2095 DEFVAR_BOOL ("minibuffer-allow-text-properties",
2096 minibuffer_allow_text_properties,
2097 doc: /* Non-nil means `read-from-minibuffer' should not discard text properties.
2098 This also affects `read-string', but it does not affect `read-minibuffer',
2099 `read-no-blanks-input', or any of the functions that do minibuffer input
2100 with completion; they always discard text properties. */);
2101 minibuffer_allow_text_properties = 0;
2103 DEFVAR_LISP ("minibuffer-prompt-properties", Vminibuffer_prompt_properties,
2104 doc: /* Text properties that are added to minibuffer prompts.
2105 These are in addition to the basic `field' property, and stickiness
2106 properties. */);
2107 /* We use `intern' here instead of Qread_only to avoid
2108 initialization-order problems. */
2109 Vminibuffer_prompt_properties
2110 = Fcons (intern_c_string ("read-only"), Fcons (Qt, Qnil));
2112 defsubr (&Sactive_minibuffer_window);
2113 defsubr (&Sset_minibuffer_window);
2114 defsubr (&Sread_from_minibuffer);
2115 defsubr (&Sread_string);
2116 defsubr (&Sread_command);
2117 defsubr (&Sread_variable);
2118 defsubr (&Sinternal_complete_buffer);
2119 defsubr (&Sread_buffer);
2120 defsubr (&Sread_no_blanks_input);
2121 defsubr (&Sminibuffer_depth);
2122 defsubr (&Sminibuffer_prompt);
2124 defsubr (&Sminibufferp);
2125 defsubr (&Sminibuffer_prompt_end);
2126 defsubr (&Sminibuffer_contents);
2127 defsubr (&Sminibuffer_contents_no_properties);
2128 defsubr (&Sminibuffer_completion_contents);
2130 defsubr (&Stry_completion);
2131 defsubr (&Sall_completions);
2132 defsubr (&Stest_completion);
2133 defsubr (&Sassoc_string);
2134 defsubr (&Scompleting_read);