Add an undo command to url-cookie-mode
[emacs.git] / src / minibuf.c
blob5cb6919a0f5e782e115781bd59249ba69cfc2c88
1 /* Minibuffer input and completion.
3 Copyright (C) 1985-1986, 1993-2018 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 (at
10 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 <https://www.gnu.org/licenses/>. */
21 #include <config.h>
22 #include <errno.h>
24 #include <binary-io.h>
26 #include "lisp.h"
27 #include "character.h"
28 #include "buffer.h"
29 #include "keyboard.h"
30 #include "frame.h"
31 #include "window.h"
32 #include "keymap.h"
33 #include "sysstdio.h"
34 #include "systty.h"
36 /* List of buffers for use as minibuffers.
37 The first element of the list is used for the outermost minibuffer
38 invocation, the next element is used for a recursive minibuffer
39 invocation, etc. The list is extended at the end as deeper
40 minibuffer recursions are encountered. */
42 Lisp_Object Vminibuffer_list;
44 /* Data to remember during recursive minibuffer invocations. */
46 static Lisp_Object minibuf_save_list;
48 /* Depth in minibuffer invocations. */
50 EMACS_INT minibuf_level;
52 /* Fread_minibuffer leaves the input here as a string. */
54 Lisp_Object last_minibuf_string;
56 /* Prompt to display in front of the mini-buffer contents. */
58 static Lisp_Object minibuf_prompt;
60 /* Width of current mini-buffer prompt. Only set after display_line
61 of the line that contains the prompt. */
63 static ptrdiff_t minibuf_prompt_width;
66 /* Put minibuf on currently selected frame's minibuffer.
67 We do this whenever the user starts a new minibuffer
68 or when a minibuffer exits. */
70 static void
71 choose_minibuf_frame (void)
73 if (FRAMEP (selected_frame)
74 && FRAME_LIVE_P (XFRAME (selected_frame))
75 && !EQ (minibuf_window, XFRAME (selected_frame)->minibuffer_window))
77 struct frame *sf = XFRAME (selected_frame);
78 Lisp_Object buffer;
80 /* I don't think that any frames may validly have a null minibuffer
81 window anymore. */
82 if (NILP (sf->minibuffer_window))
83 emacs_abort ();
85 /* Under X, we come here with minibuf_window being the
86 minibuffer window of the unused termcap window created in
87 init_window_once. That window doesn't have a buffer. */
88 buffer = XWINDOW (minibuf_window)->contents;
89 if (BUFFERP (buffer))
90 /* Use set_window_buffer instead of Fset_window_buffer (see
91 discussion of bug#11984, bug#12025, bug#12026). */
92 set_window_buffer (sf->minibuffer_window, buffer, 0, 0);
93 minibuf_window = sf->minibuffer_window;
96 /* Make sure no other frame has a minibuffer as its selected window,
97 because the text would not be displayed in it, and that would be
98 confusing. Only allow the selected frame to do this,
99 and that only if the minibuffer is active. */
101 Lisp_Object tail, frame;
103 FOR_EACH_FRAME (tail, frame)
104 if (MINI_WINDOW_P (XWINDOW (FRAME_SELECTED_WINDOW (XFRAME (frame))))
105 && !(EQ (frame, selected_frame)
106 && minibuf_level > 0))
107 Fset_frame_selected_window (frame, Fframe_first_window (frame), Qnil);
111 DEFUN ("active-minibuffer-window", Factive_minibuffer_window,
112 Sactive_minibuffer_window, 0, 0, 0,
113 doc: /* Return the currently active minibuffer window, or nil if none. */)
114 (void)
116 return minibuf_level ? minibuf_window : Qnil;
119 DEFUN ("set-minibuffer-window", Fset_minibuffer_window,
120 Sset_minibuffer_window, 1, 1, 0,
121 doc: /* Specify which minibuffer window to use for the minibuffer.
122 This affects where the minibuffer is displayed if you put text in it
123 without invoking the usual minibuffer commands. */)
124 (Lisp_Object window)
126 CHECK_WINDOW (window);
127 if (! MINI_WINDOW_P (XWINDOW (window)))
128 error ("Window is not a minibuffer window");
130 minibuf_window = window;
132 return window;
136 /* Actual minibuffer invocation. */
138 static void read_minibuf_unwind (void);
139 static void run_exit_minibuf_hook (void);
142 /* Read a Lisp object from VAL and return it. If VAL is an empty
143 string, and DEFALT is a string, read from DEFALT instead of VAL. */
145 static Lisp_Object
146 string_to_object (Lisp_Object val, Lisp_Object defalt)
148 Lisp_Object expr_and_pos;
149 ptrdiff_t pos;
151 if (STRINGP (val) && SCHARS (val) == 0)
153 if (STRINGP (defalt))
154 val = defalt;
155 else if (CONSP (defalt) && STRINGP (XCAR (defalt)))
156 val = XCAR (defalt);
159 expr_and_pos = Fread_from_string (val, Qnil, Qnil);
160 pos = XINT (Fcdr (expr_and_pos));
161 if (pos != SCHARS (val))
163 /* Ignore trailing whitespace; any other trailing junk
164 is an error. */
165 ptrdiff_t i;
166 pos = string_char_to_byte (val, pos);
167 for (i = pos; i < SBYTES (val); i++)
169 int c = SREF (val, i);
170 if (c != ' ' && c != '\t' && c != '\n')
171 error ("Trailing garbage following expression");
175 val = Fcar (expr_and_pos);
176 return val;
180 /* Like read_minibuf but reading from stdin. This function is called
181 from read_minibuf to do the job if noninteractive. */
183 static Lisp_Object
184 read_minibuf_noninteractive (Lisp_Object map, Lisp_Object initial,
185 Lisp_Object prompt, Lisp_Object backup_n,
186 bool expflag,
187 Lisp_Object histvar, Lisp_Object histpos,
188 Lisp_Object defalt,
189 bool allow_props, bool inherit_input_method)
191 ptrdiff_t size, len;
192 char *line;
193 Lisp_Object val;
194 int c;
195 unsigned char hide_char = 0;
196 struct emacs_tty etty;
197 bool etty_valid UNINIT;
199 /* Check, whether we need to suppress echoing. */
200 if (CHARACTERP (Vread_hide_char))
201 hide_char = XFASTINT (Vread_hide_char);
203 /* Manipulate tty. */
204 if (hide_char)
206 etty_valid = emacs_get_tty (STDIN_FILENO, &etty) == 0;
207 if (etty_valid)
208 set_binary_mode (STDIN_FILENO, O_BINARY);
209 suppress_echo_on_tty (STDIN_FILENO);
212 fwrite_unlocked (SDATA (prompt), 1, SBYTES (prompt), stdout);
213 fflush_unlocked (stdout);
215 val = Qnil;
216 size = 100;
217 len = 0;
218 line = xmalloc (size);
220 while ((c = getchar_unlocked ()) != '\n' && c != '\r')
222 if (c == EOF)
224 if (errno != EINTR)
225 break;
227 else
229 if (hide_char)
230 fprintf (stdout, "%c", hide_char);
231 if (len == size)
232 line = xpalloc (line, &size, 1, -1, sizeof *line);
233 line[len++] = c;
237 /* Reset tty. */
238 if (hide_char)
240 fprintf (stdout, "\n");
241 if (etty_valid)
243 emacs_set_tty (STDIN_FILENO, &etty, 0);
244 set_binary_mode (STDIN_FILENO, O_TEXT);
248 if (len || c == '\n' || c == '\r')
250 val = make_string (line, len);
251 xfree (line);
253 else
255 xfree (line);
256 error ("Error reading from stdin");
259 /* If Lisp form desired instead of string, parse it. */
260 if (expflag)
261 val = string_to_object (val, CONSP (defalt) ? XCAR (defalt) : defalt);
263 return val;
266 DEFUN ("minibufferp", Fminibufferp,
267 Sminibufferp, 0, 1, 0,
268 doc: /* Return t if BUFFER is a minibuffer.
269 No argument or nil as argument means use current buffer as BUFFER.
270 BUFFER can be a buffer or a buffer name. */)
271 (Lisp_Object buffer)
273 Lisp_Object tem;
275 if (NILP (buffer))
276 buffer = Fcurrent_buffer ();
277 else if (STRINGP (buffer))
278 buffer = Fget_buffer (buffer);
279 else
280 CHECK_BUFFER (buffer);
282 tem = Fmemq (buffer, Vminibuffer_list);
283 return ! NILP (tem) ? Qt : Qnil;
286 DEFUN ("minibuffer-prompt-end", Fminibuffer_prompt_end,
287 Sminibuffer_prompt_end, 0, 0, 0,
288 doc: /* Return the buffer position of the end of the minibuffer prompt.
289 Return (point-min) if current buffer is not a minibuffer. */)
290 (void)
292 /* This function is written to be most efficient when there's a prompt. */
293 Lisp_Object beg, end, tem;
294 beg = make_number (BEGV);
296 tem = Fmemq (Fcurrent_buffer (), Vminibuffer_list);
297 if (NILP (tem))
298 return beg;
300 end = Ffield_end (beg, Qnil, Qnil);
302 if (XINT (end) == ZV && NILP (Fget_char_property (beg, Qfield, Qnil)))
303 return beg;
304 else
305 return end;
308 DEFUN ("minibuffer-contents", Fminibuffer_contents,
309 Sminibuffer_contents, 0, 0, 0,
310 doc: /* Return the user input in a minibuffer as a string.
311 If the current buffer is not a minibuffer, return its entire contents. */)
312 (void)
314 ptrdiff_t prompt_end = XINT (Fminibuffer_prompt_end ());
315 return make_buffer_string (prompt_end, ZV, 1);
318 DEFUN ("minibuffer-contents-no-properties", Fminibuffer_contents_no_properties,
319 Sminibuffer_contents_no_properties, 0, 0, 0,
320 doc: /* Return the user input in a minibuffer as a string, without text-properties.
321 If the current buffer is not a minibuffer, return its entire contents. */)
322 (void)
324 ptrdiff_t prompt_end = XINT (Fminibuffer_prompt_end ());
325 return make_buffer_string (prompt_end, ZV, 0);
329 /* Read from the minibuffer using keymap MAP and initial contents INITIAL,
330 putting point minus BACKUP_N bytes from the end of INITIAL,
331 prompting with PROMPT (a string), using history list HISTVAR
332 with initial position HISTPOS. INITIAL should be a string or a
333 cons of a string and an integer. BACKUP_N should be <= 0, or
334 Qnil, which is equivalent to 0. If INITIAL is a cons, BACKUP_N is
335 ignored and replaced with an integer that puts point at one-indexed
336 position N in INITIAL, where N is the CDR of INITIAL, or at the
337 beginning of INITIAL if N <= 0.
339 Normally return the result as a string (the text that was read),
340 but if EXPFLAG, read it and return the object read.
341 If HISTVAR is given, save the value read on that history only if it doesn't
342 match the front of that history list exactly. The value is pushed onto
343 the list as the string that was read.
345 DEFALT specifies the default value for the sake of history commands.
347 If ALLOW_PROPS, do not throw away text properties.
349 if INHERIT_INPUT_METHOD, the minibuffer inherits the
350 current input method. */
352 static Lisp_Object
353 read_minibuf (Lisp_Object map, Lisp_Object initial, Lisp_Object prompt,
354 bool expflag,
355 Lisp_Object histvar, Lisp_Object histpos, Lisp_Object defalt,
356 bool allow_props, bool inherit_input_method)
358 Lisp_Object val;
359 ptrdiff_t count = SPECPDL_INDEX ();
360 Lisp_Object mini_frame, ambient_dir, minibuffer, input_method;
361 Lisp_Object enable_multibyte;
362 EMACS_INT pos = 0;
363 /* String to add to the history. */
364 Lisp_Object histstring;
365 Lisp_Object histval;
367 Lisp_Object empty_minibuf;
368 Lisp_Object dummy, frame;
370 specbind (Qminibuffer_default, defalt);
371 specbind (Qinhibit_read_only, Qnil);
373 /* If Vminibuffer_completing_file_name is `lambda' on entry, it was t
374 in previous recursive minibuffer, but was not set explicitly
375 to t for this invocation, so set it to nil in this minibuffer.
376 Save the old value now, before we change it. */
377 specbind (intern ("minibuffer-completing-file-name"),
378 Vminibuffer_completing_file_name);
379 if (EQ (Vminibuffer_completing_file_name, Qlambda))
380 Vminibuffer_completing_file_name = Qnil;
382 #ifdef HAVE_WINDOW_SYSTEM
383 if (display_hourglass_p)
384 cancel_hourglass ();
385 #endif
387 if (!NILP (initial))
389 if (CONSP (initial))
391 Lisp_Object backup_n = XCDR (initial);
392 initial = XCAR (initial);
393 CHECK_STRING (initial);
394 if (!NILP (backup_n))
396 CHECK_NUMBER (backup_n);
397 /* Convert to distance from end of input. */
398 if (XINT (backup_n) < 1)
399 /* A number too small means the beginning of the string. */
400 pos = - SCHARS (initial);
401 else
402 pos = XINT (backup_n) - 1 - SCHARS (initial);
405 else
406 CHECK_STRING (initial);
408 val = Qnil;
409 ambient_dir = BVAR (current_buffer, directory);
410 input_method = Qnil;
411 enable_multibyte = Qnil;
413 if (!STRINGP (prompt))
414 prompt = empty_unibyte_string;
416 if (!enable_recursive_minibuffers
417 && minibuf_level > 0)
419 if (EQ (selected_window, minibuf_window))
420 error ("Command attempted to use minibuffer while in minibuffer");
421 else
422 /* If we're in another window, cancel the minibuffer that's active. */
423 Fthrow (Qexit,
424 build_string ("Command attempted to use minibuffer while in minibuffer"));
427 if ((noninteractive
428 /* In case we are running as a daemon, only do this before
429 detaching from the terminal. */
430 || (IS_DAEMON && DAEMON_RUNNING))
431 && NILP (Vexecuting_kbd_macro))
433 val = read_minibuf_noninteractive (map, initial, prompt,
434 make_number (pos),
435 expflag, histvar, histpos, defalt,
436 allow_props, inherit_input_method);
437 return unbind_to (count, val);
440 /* Choose the minibuffer window and frame, and take action on them. */
442 /* Prepare for restoring the current buffer since choose_minibuf_frame
443 calling Fset_frame_selected_window may change it (Bug#12766). */
444 record_unwind_protect (restore_buffer, Fcurrent_buffer ());
446 choose_minibuf_frame ();
448 record_unwind_protect_void (choose_minibuf_frame);
450 record_unwind_protect (restore_window_configuration,
451 Fcurrent_window_configuration (Qnil));
453 /* If the minibuffer window is on a different frame, save that
454 frame's configuration too. */
455 mini_frame = WINDOW_FRAME (XWINDOW (minibuf_window));
456 if (!EQ (mini_frame, selected_frame))
457 record_unwind_protect (restore_window_configuration,
458 Fcurrent_window_configuration (mini_frame));
460 /* If the minibuffer is on an iconified or invisible frame,
461 make it visible now. */
462 Fmake_frame_visible (mini_frame);
464 if (minibuffer_auto_raise)
465 Fraise_frame (mini_frame);
467 temporarily_switch_to_single_kboard (XFRAME (mini_frame));
469 /* We have to do this after saving the window configuration
470 since that is what restores the current buffer. */
472 /* Arrange to restore a number of minibuffer-related variables.
473 We could bind each variable separately, but that would use lots of
474 specpdl slots. */
475 minibuf_save_list
476 = Fcons (Voverriding_local_map,
477 Fcons (minibuf_window,
478 minibuf_save_list));
479 minibuf_save_list
480 = Fcons (minibuf_prompt,
481 Fcons (make_number (minibuf_prompt_width),
482 Fcons (Vhelp_form,
483 Fcons (Vcurrent_prefix_arg,
484 Fcons (Vminibuffer_history_position,
485 Fcons (Vminibuffer_history_variable,
486 minibuf_save_list))))));
487 minibuf_save_list
488 = Fcons (Fthis_command_keys_vector (), minibuf_save_list);
490 record_unwind_protect_void (read_minibuf_unwind);
491 minibuf_level++;
492 /* We are exiting the minibuffer one way or the other, so run the hook.
493 It should be run before unwinding the minibuf settings. Do it
494 separately from read_minibuf_unwind because we need to make sure that
495 read_minibuf_unwind is fully executed even if exit-minibuffer-hook
496 signals an error. --Stef */
497 record_unwind_protect_void (run_exit_minibuf_hook);
499 /* Now that we can restore all those variables, start changing them. */
501 minibuf_prompt_width = 0;
502 minibuf_prompt = Fcopy_sequence (prompt);
503 Vminibuffer_history_position = histpos;
504 Vminibuffer_history_variable = histvar;
505 Vhelp_form = Vminibuffer_help_form;
506 /* If this minibuffer is reading a file name, that doesn't mean
507 recursive ones are. But we cannot set it to nil, because
508 completion code still need to know the minibuffer is completing a
509 file name. So use `lambda' as intermediate value meaning
510 "t" in this minibuffer, but "nil" in next minibuffer. */
511 if (!NILP (Vminibuffer_completing_file_name))
512 Vminibuffer_completing_file_name = Qlambda;
514 /* If variable is unbound, make it nil. */
515 histval = find_symbol_value (Vminibuffer_history_variable);
516 if (EQ (histval, Qunbound))
518 Fset (Vminibuffer_history_variable, Qnil);
519 histval = Qnil;
522 if (inherit_input_method)
524 /* `current-input-method' is buffer local. So, remember it in
525 INPUT_METHOD before changing the current buffer. */
526 input_method = Fsymbol_value (Qcurrent_input_method);
527 enable_multibyte = BVAR (current_buffer, enable_multibyte_characters);
530 /* Switch to the minibuffer. */
532 minibuffer = get_minibuffer (minibuf_level);
533 Fset_buffer (minibuffer);
535 /* Defeat (setq-default truncate-lines t), since truncated lines do
536 not work correctly in minibuffers. (Bug#5715, etc) */
537 bset_truncate_lines (current_buffer, Qnil);
539 /* If appropriate, copy enable-multibyte-characters into the minibuffer. */
540 if (inherit_input_method)
541 bset_enable_multibyte_characters (current_buffer, enable_multibyte);
543 /* The current buffer's default directory is usually the right thing
544 for our minibuffer here. However, if you're typing a command at
545 a minibuffer-only frame when minibuf_level is zero, then buf IS
546 the current_buffer, so reset_buffer leaves buf's default
547 directory unchanged. This is a bummer when you've just started
548 up Emacs and buf's default directory is Qnil. Here's a hack; can
549 you think of something better to do? Find another buffer with a
550 better directory, and use that one instead. */
551 if (STRINGP (ambient_dir))
552 bset_directory (current_buffer, ambient_dir);
553 else
555 Lisp_Object tail, buf;
557 FOR_EACH_LIVE_BUFFER (tail, buf)
558 if (STRINGP (BVAR (XBUFFER (buf), directory)))
560 bset_directory (current_buffer,
561 BVAR (XBUFFER (buf), directory));
562 break;
566 if (!EQ (mini_frame, selected_frame))
567 Fredirect_frame_focus (selected_frame, mini_frame);
569 Vminibuf_scroll_window = selected_window;
570 if (minibuf_level == 1 || !EQ (minibuf_window, selected_window))
571 minibuf_selected_window = selected_window;
573 /* Empty out the minibuffers of all frames other than the one
574 where we are going to display one now.
575 Set them to point to ` *Minibuf-0*', which is always empty. */
576 empty_minibuf = get_minibuffer (0);
578 FOR_EACH_FRAME (dummy, frame)
580 Lisp_Object root_window = Fframe_root_window (frame);
581 Lisp_Object mini_window = XWINDOW (root_window)->next;
583 if (! NILP (mini_window) && ! EQ (mini_window, minibuf_window)
584 && !NILP (Fwindow_minibuffer_p (mini_window)))
585 /* Use set_window_buffer instead of Fset_window_buffer (see
586 discussion of bug#11984, bug#12025, bug#12026). */
587 set_window_buffer (mini_window, empty_minibuf, 0, 0);
590 /* Display this minibuffer in the proper window. */
591 /* Use set_window_buffer instead of Fset_window_buffer (see
592 discussion of bug#11984, bug#12025, bug#12026). */
593 set_window_buffer (minibuf_window, Fcurrent_buffer (), 0, 0);
594 Fselect_window (minibuf_window, Qnil);
595 XWINDOW (minibuf_window)->hscroll = 0;
596 XWINDOW (minibuf_window)->suspend_auto_hscroll = 0;
598 Fmake_local_variable (Qprint_escape_newlines);
599 print_escape_newlines = 1;
601 /* Erase the buffer. */
603 ptrdiff_t count1 = SPECPDL_INDEX ();
604 specbind (Qinhibit_read_only, Qt);
605 specbind (Qinhibit_modification_hooks, Qt);
606 Ferase_buffer ();
608 if (!NILP (BVAR (current_buffer, enable_multibyte_characters))
609 && ! STRING_MULTIBYTE (minibuf_prompt))
610 minibuf_prompt = Fstring_make_multibyte (minibuf_prompt);
612 /* Insert the prompt, record where it ends. */
613 Finsert (1, &minibuf_prompt);
614 if (PT > BEG)
616 Fput_text_property (make_number (BEG), make_number (PT),
617 Qfront_sticky, Qt, Qnil);
618 Fput_text_property (make_number (BEG), make_number (PT),
619 Qrear_nonsticky, Qt, Qnil);
620 Fput_text_property (make_number (BEG), make_number (PT),
621 Qfield, Qt, Qnil);
622 if (CONSP (Vminibuffer_prompt_properties))
624 /* We want to apply all properties from
625 `minibuffer-prompt-properties' to the region normally,
626 but if the `face' property is present, add that
627 property to the end of the face properties to avoid
628 overwriting faces. */
629 Lisp_Object list = Vminibuffer_prompt_properties;
630 while (CONSP (list))
632 Lisp_Object key = XCAR (list);
633 list = XCDR (list);
634 if (CONSP (list))
636 Lisp_Object val = XCAR (list);
637 list = XCDR (list);
638 if (EQ (key, Qface))
639 Fadd_face_text_property (make_number (BEG),
640 make_number (PT), val, Qt, Qnil);
641 else
642 Fput_text_property (make_number (BEG), make_number (PT),
643 key, val, Qnil);
648 unbind_to (count1, Qnil);
651 minibuf_prompt_width = current_column ();
653 /* Put in the initial input. */
654 if (!NILP (initial))
656 Finsert (1, &initial);
657 Fforward_char (make_number (pos));
660 clear_message (1, 1);
661 bset_keymap (current_buffer, map);
663 /* Turn on an input method stored in INPUT_METHOD if any. */
664 if (STRINGP (input_method) && !NILP (Ffboundp (Qactivate_input_method)))
665 call1 (Qactivate_input_method, input_method);
667 run_hook (Qminibuffer_setup_hook);
669 /* Don't allow the user to undo past this point. */
670 bset_undo_list (current_buffer, Qnil);
672 recursive_edit_1 ();
674 /* If cursor is on the minibuffer line,
675 show the user we have exited by putting it in column 0. */
676 if (XWINDOW (minibuf_window)->cursor.vpos >= 0
677 && !noninteractive)
679 XWINDOW (minibuf_window)->cursor.hpos = 0;
680 XWINDOW (minibuf_window)->cursor.x = 0;
681 XWINDOW (minibuf_window)->must_be_updated_p = true;
682 update_frame (XFRAME (selected_frame), true, true);
683 flush_frame (XFRAME (XWINDOW (minibuf_window)->frame));
686 /* Make minibuffer contents into a string. */
687 Fset_buffer (minibuffer);
688 if (allow_props)
689 val = Fminibuffer_contents ();
690 else
691 val = Fminibuffer_contents_no_properties ();
693 /* VAL is the string of minibuffer text. */
695 last_minibuf_string = val;
697 /* Choose the string to add to the history. */
698 if (SCHARS (val) != 0)
699 histstring = val;
700 else if (STRINGP (defalt))
701 histstring = defalt;
702 else if (CONSP (defalt) && STRINGP (XCAR (defalt)))
703 histstring = XCAR (defalt);
704 else
705 histstring = Qnil;
707 /* Add the value to the appropriate history list, if any. */
708 if (!NILP (Vhistory_add_new_input)
709 && SYMBOLP (Vminibuffer_history_variable)
710 && !NILP (histstring))
712 /* If the caller wanted to save the value read on a history list,
713 then do so if the value is not already the front of the list. */
715 /* The value of the history variable must be a cons or nil. Other
716 values are unacceptable. We silently ignore these values. */
718 if (NILP (histval)
719 || (CONSP (histval)
720 /* Don't duplicate the most recent entry in the history. */
721 && (NILP (Fequal (histstring, Fcar (histval))))))
723 Lisp_Object length;
725 if (history_delete_duplicates) Fdelete (histstring, histval);
726 histval = Fcons (histstring, histval);
727 Fset (Vminibuffer_history_variable, histval);
729 /* Truncate if requested. */
730 length = Fget (Vminibuffer_history_variable, Qhistory_length);
731 if (NILP (length)) length = Vhistory_length;
732 if (INTEGERP (length))
734 if (XINT (length) <= 0)
735 Fset (Vminibuffer_history_variable, Qnil);
736 else
738 Lisp_Object temp;
740 temp = Fnthcdr (Fsub1 (length), histval);
741 if (CONSP (temp)) Fsetcdr (temp, Qnil);
747 /* If Lisp form desired instead of string, parse it. */
748 if (expflag)
749 val = string_to_object (val, defalt);
751 /* The appropriate frame will get selected
752 in set-window-configuration. */
753 return unbind_to (count, val);
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. */
760 Lisp_Object
761 get_minibuffer (EMACS_INT depth)
763 Lisp_Object tail = Fnthcdr (make_number (depth), Vminibuffer_list);
764 if (NILP (tail))
766 tail = list1 (Qnil);
767 Vminibuffer_list = nconc2 (Vminibuffer_list, tail);
769 Lisp_Object buf = Fcar (tail);
770 if (NILP (buf) || !BUFFER_LIVE_P (XBUFFER (buf)))
772 static char const name_fmt[] = " *Minibuf-%"pI"d*";
773 char name[sizeof name_fmt + INT_STRLEN_BOUND (EMACS_INT)];
774 AUTO_STRING_WITH_LEN (lname, name, sprintf (name, name_fmt, depth));
775 buf = Fget_buffer_create (lname);
777 /* Although the buffer's name starts with a space, undo should be
778 enabled in it. */
779 Fbuffer_enable_undo (buf);
781 XSETCAR (tail, buf);
783 else
785 ptrdiff_t count = SPECPDL_INDEX ();
786 /* We have to empty both overlay lists. Otherwise we end
787 up with overlays that think they belong to this buffer
788 while the buffer doesn't know about them any more. */
789 delete_all_overlays (XBUFFER (buf));
790 reset_buffer (XBUFFER (buf));
791 record_unwind_current_buffer ();
792 Fset_buffer (buf);
793 if (!NILP (Ffboundp (intern ("minibuffer-inactive-mode"))))
794 call0 (intern ("minibuffer-inactive-mode"));
795 else
796 Fkill_all_local_variables ();
797 unbind_to (count, Qnil);
800 return buf;
803 static void
804 run_exit_minibuf_hook (void)
806 safe_run_hooks (Qminibuffer_exit_hook);
809 /* This function is called on exiting minibuffer, whether normally or
810 not, and it restores the current window, buffer, etc. */
812 static void
813 read_minibuf_unwind (void)
815 Lisp_Object old_deactivate_mark;
816 Lisp_Object window;
818 /* If this was a recursive minibuffer,
819 tie the minibuffer window back to the outer level minibuffer buffer. */
820 minibuf_level--;
822 window = minibuf_window;
823 /* To keep things predictable, in case it matters, let's be in the
824 minibuffer when we reset the relevant variables. */
825 Fset_buffer (XWINDOW (window)->contents);
827 /* Restore prompt, etc, from outer minibuffer level. */
828 Lisp_Object key_vec = Fcar (minibuf_save_list);
829 eassert (VECTORP (key_vec));
830 this_command_key_count = XFASTINT (Flength (key_vec));
831 this_command_keys = key_vec;
832 minibuf_save_list = Fcdr (minibuf_save_list);
833 minibuf_prompt = Fcar (minibuf_save_list);
834 minibuf_save_list = Fcdr (minibuf_save_list);
835 minibuf_prompt_width = XFASTINT (Fcar (minibuf_save_list));
836 minibuf_save_list = Fcdr (minibuf_save_list);
837 Vhelp_form = Fcar (minibuf_save_list);
838 minibuf_save_list = Fcdr (minibuf_save_list);
839 Vcurrent_prefix_arg = Fcar (minibuf_save_list);
840 minibuf_save_list = Fcdr (minibuf_save_list);
841 Vminibuffer_history_position = Fcar (minibuf_save_list);
842 minibuf_save_list = Fcdr (minibuf_save_list);
843 Vminibuffer_history_variable = Fcar (minibuf_save_list);
844 minibuf_save_list = Fcdr (minibuf_save_list);
845 Voverriding_local_map = Fcar (minibuf_save_list);
846 minibuf_save_list = Fcdr (minibuf_save_list);
847 #if 0
848 temp = Fcar (minibuf_save_list);
849 if (FRAME_LIVE_P (XFRAME (WINDOW_FRAME (XWINDOW (temp)))))
850 minibuf_window = temp;
851 #endif
852 minibuf_save_list = Fcdr (minibuf_save_list);
854 /* Erase the minibuffer we were using at this level. */
856 ptrdiff_t count = SPECPDL_INDEX ();
857 /* Prevent error in erase-buffer. */
858 specbind (Qinhibit_read_only, Qt);
859 specbind (Qinhibit_modification_hooks, Qt);
860 old_deactivate_mark = Vdeactivate_mark;
861 Ferase_buffer ();
862 Vdeactivate_mark = old_deactivate_mark;
863 unbind_to (count, Qnil);
866 /* When we get to the outmost level, make sure we resize the
867 mini-window back to its normal size. */
868 if (minibuf_level == 0)
869 resize_mini_window (XWINDOW (window), 0);
871 /* Deal with frames that should be removed when exiting the
872 minibuffer. */
874 Lisp_Object frames, frame1, val;
875 struct frame *f1;
877 FOR_EACH_FRAME (frames, frame1)
879 f1 = XFRAME (frame1);
881 if ((FRAME_PARENT_FRAME (f1)
882 || !NILP (get_frame_param (f1, Qdelete_before)))
883 && !NILP (val = (get_frame_param (f1, Qminibuffer_exit))))
885 if (EQ (val, Qiconify_frame))
886 Ficonify_frame (frame1);
887 else if (EQ (val, Qdelete_frame))
888 Fdelete_frame (frame1, Qnil);
889 else
890 Fmake_frame_invisible (frame1, Qnil);
895 /* In case the previous minibuffer displayed in this miniwindow is
896 dead, we may keep displaying this buffer (tho it's inactive), so reset it,
897 to make sure we don't leave around bindings and stuff which only
898 made sense during the read_minibuf invocation. */
899 call0 (intern ("minibuffer-inactive-mode"));
903 DEFUN ("read-from-minibuffer", Fread_from_minibuffer,
904 Sread_from_minibuffer, 1, 7, 0,
905 doc: /* Read a string from the minibuffer, prompting with string PROMPT.
906 The optional second arg INITIAL-CONTENTS is an obsolete alternative to
907 DEFAULT-VALUE. It normally should be nil in new code, except when
908 HIST is a cons. It is discussed in more detail below.
910 Third arg KEYMAP is a keymap to use whilst reading;
911 if omitted or nil, the default is `minibuffer-local-map'.
913 If fourth arg READ is non-nil, interpret the result as a Lisp object
914 and return that object:
915 in other words, do `(car (read-from-string INPUT-STRING))'
917 Fifth arg HIST, if non-nil, specifies a history list and optionally
918 the initial position in the list. It can be a symbol, which is the
919 history list variable to use, or a cons cell (HISTVAR . HISTPOS).
920 In that case, HISTVAR is the history list variable to use, and
921 HISTPOS is the initial position for use by the minibuffer history
922 commands. For consistency, you should also specify that element of
923 the history as the value of INITIAL-CONTENTS. Positions are counted
924 starting from 1 at the beginning of the list.
926 Sixth arg DEFAULT-VALUE, if non-nil, should be a string, which is used
927 as the default to `read' if READ is non-nil and the user enters
928 empty input. But if READ is nil, this function does _not_ return
929 DEFAULT-VALUE for empty input! Instead, it returns the empty string.
931 Whatever the value of READ, DEFAULT-VALUE is made available via the
932 minibuffer history commands. DEFAULT-VALUE can also be a list of
933 strings, in which case all the strings are available in the history,
934 and the first string is the default to `read' if READ is non-nil.
936 Seventh arg INHERIT-INPUT-METHOD, if non-nil, means the minibuffer inherits
937 the current input method and the setting of `enable-multibyte-characters'.
939 If the variable `minibuffer-allow-text-properties' is non-nil,
940 then the string which is returned includes whatever text properties
941 were present in the minibuffer. Otherwise the value has no text properties.
943 The remainder of this documentation string describes the
944 INITIAL-CONTENTS argument in more detail. It is only relevant when
945 studying existing code, or when HIST is a cons. If non-nil,
946 INITIAL-CONTENTS is a string to be inserted into the minibuffer before
947 reading input. Normally, point is put at the end of that string.
948 However, if INITIAL-CONTENTS is (STRING . POSITION), the initial
949 input is STRING, but point is placed at _one-indexed_ position
950 POSITION in the minibuffer. Any integer value less than or equal to
951 one puts point at the beginning of the string. *Note* that this
952 behavior differs from the way such arguments are used in `completing-read'
953 and some related functions, which use zero-indexing for POSITION. */)
954 (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)
956 Lisp_Object histvar, histpos, val;
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 val = read_minibuf (keymap, initial_contents, prompt,
980 !NILP (read),
981 histvar, histpos, default_value,
982 minibuffer_allow_text_properties,
983 !NILP (inherit_input_method));
984 return val;
987 /* Functions that use the minibuffer to read various things. */
989 DEFUN ("read-string", Fread_string, Sread_string, 1, 5, 0,
990 doc: /* Read a string from the minibuffer, prompting with string PROMPT.
991 If non-nil, second arg INITIAL-INPUT is a string to insert before reading.
992 This argument has been superseded by DEFAULT-VALUE and should normally be nil
993 in new code. It behaves as INITIAL-CONTENTS in `read-from-minibuffer' (which
994 see).
995 The third arg HISTORY, if non-nil, specifies a history list
996 and optionally the initial position in the list.
997 See `read-from-minibuffer' for details of HISTORY argument.
998 Fourth arg DEFAULT-VALUE is the default value or the list of default values.
999 If non-nil, it is used for history commands, and as the value (or the first
1000 element of the list of default values) to return if the user enters the
1001 empty string.
1002 Fifth arg INHERIT-INPUT-METHOD, if non-nil, means the minibuffer inherits
1003 the current input method and the setting of `enable-multibyte-characters'. */)
1004 (Lisp_Object prompt, Lisp_Object initial_input, Lisp_Object history, Lisp_Object default_value, Lisp_Object inherit_input_method)
1006 Lisp_Object val;
1007 ptrdiff_t count = SPECPDL_INDEX ();
1009 /* Just in case we're in a recursive minibuffer, make it clear that the
1010 previous minibuffer's completion table does not apply to the new
1011 minibuffer.
1012 FIXME: `minibuffer-completion-table' should be buffer-local instead. */
1013 specbind (Qminibuffer_completion_table, Qnil);
1015 val = Fread_from_minibuffer (prompt, initial_input, Qnil,
1016 Qnil, history, default_value,
1017 inherit_input_method);
1018 if (STRINGP (val) && SCHARS (val) == 0 && ! NILP (default_value))
1019 val = CONSP (default_value) ? XCAR (default_value) : default_value;
1020 return unbind_to (count, val);
1023 DEFUN ("read-no-blanks-input", Fread_no_blanks_input, Sread_no_blanks_input, 1, 3, 0,
1024 doc: /* Read a string from the terminal, not allowing blanks.
1025 Prompt with PROMPT. Whitespace terminates the input. If INITIAL is
1026 non-nil, it should be a string, which is used as initial input, with
1027 point positioned at the end, so that SPACE will accept the input.
1028 \(Actually, INITIAL can also be a cons of a string and an integer.
1029 Such values are treated as in `read-from-minibuffer', but are normally
1030 not useful in this function.)
1031 Third arg INHERIT-INPUT-METHOD, if non-nil, means the minibuffer inherits
1032 the current input method and the setting of`enable-multibyte-characters'. */)
1033 (Lisp_Object prompt, Lisp_Object initial, Lisp_Object inherit_input_method)
1035 CHECK_STRING (prompt);
1036 return read_minibuf (Vminibuffer_local_ns_map, initial, prompt,
1037 0, Qminibuffer_history, make_number (0), Qnil, 0,
1038 !NILP (inherit_input_method));
1041 DEFUN ("read-command", Fread_command, Sread_command, 1, 2, 0,
1042 doc: /* Read the name of a command and return as a symbol.
1043 Prompt with PROMPT. By default, return DEFAULT-VALUE or its first element
1044 if it is a list. */)
1045 (Lisp_Object prompt, Lisp_Object default_value)
1047 Lisp_Object name, default_string;
1049 if (NILP (default_value))
1050 default_string = Qnil;
1051 else if (SYMBOLP (default_value))
1052 default_string = SYMBOL_NAME (default_value);
1053 else
1054 default_string = default_value;
1056 name = Fcompleting_read (prompt, Vobarray, Qcommandp, Qt,
1057 Qnil, Qnil, default_string, Qnil);
1058 if (NILP (name))
1059 return name;
1060 return Fintern (name, Qnil);
1063 #ifdef NOTDEF
1064 DEFUN ("read-function", Fread_function, Sread_function, 1, 1, 0,
1065 doc: /* One arg PROMPT, a string. Read the name of a function and return as a symbol.
1066 Prompt with PROMPT. */)
1067 (Lisp_Object prompt)
1069 return Fintern (Fcompleting_read (prompt, Vobarray, Qfboundp, Qt, Qnil, Qnil, Qnil, Qnil),
1070 Qnil);
1072 #endif /* NOTDEF */
1074 DEFUN ("read-variable", Fread_variable, Sread_variable, 1, 2, 0,
1075 doc: /* Read the name of a user option and return it as a symbol.
1076 Prompt with PROMPT. By default, return DEFAULT-VALUE or its first element
1077 if it is a list.
1078 A user option, or customizable variable, is one for which
1079 `custom-variable-p' returns non-nil. */)
1080 (Lisp_Object prompt, Lisp_Object default_value)
1082 Lisp_Object name, default_string;
1084 if (NILP (default_value))
1085 default_string = Qnil;
1086 else if (SYMBOLP (default_value))
1087 default_string = SYMBOL_NAME (default_value);
1088 else
1089 default_string = default_value;
1091 name = Fcompleting_read (prompt, Vobarray,
1092 Qcustom_variable_p, Qt,
1093 Qnil, Qcustom_variable_history,
1094 default_string, Qnil);
1095 if (NILP (name))
1096 return name;
1097 return Fintern (name, Qnil);
1100 DEFUN ("read-buffer", Fread_buffer, Sread_buffer, 1, 4, 0,
1101 doc: /* Read the name of a buffer and return as a string.
1102 Prompt with PROMPT.
1103 Optional second arg DEF is value to return if user enters an empty line.
1104 If DEF is a list of default values, return its first element.
1105 Optional third arg REQUIRE-MATCH determines whether non-existing
1106 buffer names are allowed. It has the same meaning as the
1107 REQUIRE-MATCH argument of `completing-read'.
1108 The argument PROMPT should be a string ending with a colon and a space.
1109 If `read-buffer-completion-ignore-case' is non-nil, completion ignores
1110 case while reading the buffer name.
1111 If `read-buffer-function' is non-nil, this works by calling it as a
1112 function, instead of the usual behavior.
1113 Optional arg PREDICATE if non-nil is a function limiting the buffers that can
1114 be considered. */)
1115 (Lisp_Object prompt, Lisp_Object def, Lisp_Object require_match,
1116 Lisp_Object predicate)
1118 Lisp_Object result;
1119 char *s;
1120 ptrdiff_t len;
1121 ptrdiff_t count = SPECPDL_INDEX ();
1123 if (BUFFERP (def))
1124 def = BVAR (XBUFFER (def), name);
1126 specbind (Qcompletion_ignore_case,
1127 read_buffer_completion_ignore_case ? Qt : Qnil);
1129 if (NILP (Vread_buffer_function))
1131 if (!NILP (def))
1133 /* A default value was provided: we must change PROMPT,
1134 editing the default value in before the colon. To achieve
1135 this, we replace PROMPT with a substring that doesn't
1136 contain the terminal space and colon (if present). They
1137 are then added back using Fformat. */
1139 if (STRINGP (prompt))
1141 s = SSDATA (prompt);
1142 len = SBYTES (prompt);
1143 if (len >= 2 && s[len - 2] == ':' && s[len - 1] == ' ')
1144 len = len - 2;
1145 else if (len >= 1 && (s[len - 1] == ':' || s[len - 1] == ' '))
1146 len--;
1148 prompt = make_specified_string (s, -1, len,
1149 STRING_MULTIBYTE (prompt));
1152 AUTO_STRING (format, "%s (default %s): ");
1153 prompt = CALLN (Fformat, format, prompt,
1154 CONSP (def) ? XCAR (def) : def);
1157 result = Fcompleting_read (prompt, intern ("internal-complete-buffer"),
1158 predicate, require_match, Qnil,
1159 Qbuffer_name_history, def, Qnil);
1161 else
1162 result = (NILP (predicate)
1163 /* Partial backward compatibility for older read_buffer_functions
1164 which don't expect a `predicate' argument. */
1165 ? call3 (Vread_buffer_function, prompt, def, require_match)
1166 : call4 (Vread_buffer_function, prompt, def, require_match,
1167 predicate));
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) && !FUNCTIONP (collection)))
1226 ? list_table : function_table));
1227 ptrdiff_t idx = 0, obsize = 0;
1228 int matchcount = 0;
1229 ptrdiff_t bindcount = -1;
1230 Lisp_Object bucket, zero, end, tem;
1232 CHECK_STRING (string);
1233 if (type == function_table)
1234 return call3 (collection, string, predicate, Qnil);
1236 bestmatch = bucket = Qnil;
1237 zero = make_number (0);
1239 /* If COLLECTION is not a list, set TAIL just for gc pro. */
1240 tail = collection;
1241 if (type == obarray_table)
1243 collection = check_obarray (collection);
1244 obsize = ASIZE (collection);
1245 bucket = AREF (collection, idx);
1248 while (1)
1250 /* Get the next element of the alist, obarray, or hash-table. */
1251 /* Exit the loop if the elements are all used up. */
1252 /* elt gets the alist element or symbol.
1253 eltstring gets the name to check as a completion. */
1255 if (type == list_table)
1257 if (!CONSP (tail))
1258 break;
1259 elt = XCAR (tail);
1260 eltstring = CONSP (elt) ? XCAR (elt) : elt;
1261 tail = XCDR (tail);
1263 else if (type == obarray_table)
1265 if (!EQ (bucket, zero))
1267 if (!SYMBOLP (bucket))
1268 error ("Bad data in guts of obarray");
1269 elt = bucket;
1270 eltstring = elt;
1271 if (XSYMBOL (bucket)->u.s.next)
1272 XSETSYMBOL (bucket, XSYMBOL (bucket)->u.s.next);
1273 else
1274 XSETFASTINT (bucket, 0);
1276 else if (++idx >= obsize)
1277 break;
1278 else
1280 bucket = AREF (collection, idx);
1281 continue;
1284 else /* if (type == hash_table) */
1286 while (idx < HASH_TABLE_SIZE (XHASH_TABLE (collection))
1287 && NILP (HASH_HASH (XHASH_TABLE (collection), idx)))
1288 idx++;
1289 if (idx >= HASH_TABLE_SIZE (XHASH_TABLE (collection)))
1290 break;
1291 else
1292 elt = eltstring = HASH_KEY (XHASH_TABLE (collection), idx++);
1295 /* Is this element a possible completion? */
1297 if (SYMBOLP (eltstring))
1298 eltstring = Fsymbol_name (eltstring);
1300 if (STRINGP (eltstring)
1301 && SCHARS (string) <= SCHARS (eltstring)
1302 && (tem = Fcompare_strings (eltstring, zero,
1303 make_number (SCHARS (string)),
1304 string, zero, Qnil,
1305 completion_ignore_case ? Qt : Qnil),
1306 EQ (Qt, tem)))
1308 /* Yes. */
1309 Lisp_Object regexps;
1311 /* Ignore this element if it fails to match all the regexps. */
1313 for (regexps = Vcompletion_regexp_list; CONSP (regexps);
1314 regexps = XCDR (regexps))
1316 if (bindcount < 0) {
1317 bindcount = SPECPDL_INDEX ();
1318 specbind (Qcase_fold_search,
1319 completion_ignore_case ? Qt : Qnil);
1321 tem = Fstring_match (XCAR (regexps), eltstring, zero);
1322 if (NILP (tem))
1323 break;
1325 if (CONSP (regexps))
1326 continue;
1329 /* Ignore this element if there is a predicate
1330 and the predicate doesn't like it. */
1332 if (!NILP (predicate))
1334 if (EQ (predicate, Qcommandp))
1335 tem = Fcommandp (elt, Qnil);
1336 else
1338 if (bindcount >= 0)
1340 unbind_to (bindcount, Qnil);
1341 bindcount = -1;
1343 tem = (type == hash_table
1344 ? call2 (predicate, elt,
1345 HASH_VALUE (XHASH_TABLE (collection),
1346 idx - 1))
1347 : call1 (predicate, elt));
1349 if (NILP (tem)) continue;
1352 /* Update computation of how much all possible completions match */
1354 if (NILP (bestmatch))
1356 matchcount = 1;
1357 bestmatch = eltstring;
1358 bestmatchsize = SCHARS (eltstring);
1360 else
1362 compare = min (bestmatchsize, SCHARS (eltstring));
1363 tem = Fcompare_strings (bestmatch, zero,
1364 make_number (compare),
1365 eltstring, zero,
1366 make_number (compare),
1367 completion_ignore_case ? Qt : Qnil);
1368 matchsize = EQ (tem, Qt) ? compare : eabs (XINT (tem)) - 1;
1370 if (completion_ignore_case)
1372 /* If this is an exact match except for case,
1373 use it as the best match rather than one that is not an
1374 exact match. This way, we get the case pattern
1375 of the actual match. */
1376 if ((matchsize == SCHARS (eltstring)
1377 && matchsize < SCHARS (bestmatch))
1379 /* If there is more than one exact match ignoring case,
1380 and one of them is exact including case,
1381 prefer that one. */
1382 /* If there is no exact match ignoring case,
1383 prefer a match that does not change the case
1384 of the input. */
1385 ((matchsize == SCHARS (eltstring))
1387 (matchsize == SCHARS (bestmatch))
1388 && (tem = Fcompare_strings (eltstring, zero,
1389 make_number (SCHARS (string)),
1390 string, zero,
1391 Qnil,
1392 Qnil),
1393 EQ (Qt, tem))
1394 && (tem = Fcompare_strings (bestmatch, zero,
1395 make_number (SCHARS (string)),
1396 string, zero,
1397 Qnil,
1398 Qnil),
1399 ! EQ (Qt, tem))))
1400 bestmatch = eltstring;
1402 if (bestmatchsize != SCHARS (eltstring)
1403 || bestmatchsize != matchsize)
1404 /* Don't count the same string multiple times. */
1405 matchcount += matchcount <= 1;
1406 bestmatchsize = matchsize;
1407 if (matchsize <= SCHARS (string)
1408 /* If completion-ignore-case is non-nil, don't
1409 short-circuit because we want to find the best
1410 possible match *including* case differences. */
1411 && !completion_ignore_case
1412 && matchcount > 1)
1413 /* No need to look any further. */
1414 break;
1419 if (bindcount >= 0) {
1420 unbind_to (bindcount, Qnil);
1421 bindcount = -1;
1424 if (NILP (bestmatch))
1425 return Qnil; /* No completions found. */
1426 /* If we are ignoring case, and there is no exact match,
1427 and no additional text was supplied,
1428 don't change the case of what the user typed. */
1429 if (completion_ignore_case && bestmatchsize == SCHARS (string)
1430 && SCHARS (bestmatch) > bestmatchsize)
1431 return minibuf_conform_representation (string, bestmatch);
1433 /* Return t if the supplied string is an exact match (counting case);
1434 it does not require any change to be made. */
1435 if (matchcount == 1 && !NILP (Fequal (bestmatch, string)))
1436 return Qt;
1438 XSETFASTINT (zero, 0); /* Else extract the part in which */
1439 XSETFASTINT (end, bestmatchsize); /* all completions agree. */
1440 return Fsubstring (bestmatch, zero, end);
1443 DEFUN ("all-completions", Fall_completions, Sall_completions, 2, 4, 0,
1444 doc: /* Search for partial matches to STRING in COLLECTION.
1445 Test each of the possible completions specified by COLLECTION
1446 to see if it begins with STRING. The possible completions may be
1447 strings or symbols. Symbols are converted to strings before testing,
1448 see `symbol-name'.
1449 The value is a list of all the possible completions that match STRING.
1451 If COLLECTION is an alist, the keys (cars of elements) are the
1452 possible completions. If an element is not a cons cell, then the
1453 element itself is the possible completion.
1454 If COLLECTION is a hash-table, all the keys that are strings or symbols
1455 are the possible completions.
1456 If COLLECTION is an obarray, the names of all symbols in the obarray
1457 are the possible completions.
1459 COLLECTION can also be a function to do the completion itself.
1460 It receives three arguments: the values STRING, PREDICATE and t.
1461 Whatever it returns becomes the value of `all-completions'.
1463 If optional third argument PREDICATE is non-nil,
1464 it is used to test each possible match.
1465 The match is a candidate only if PREDICATE returns non-nil.
1466 The argument given to PREDICATE is the alist element
1467 or the symbol from the obarray. If COLLECTION is a hash-table,
1468 predicate is called with two arguments: the key and the value.
1469 Additionally to this predicate, `completion-regexp-list'
1470 is used to further constrain the set of candidates.
1472 An obsolete optional fourth argument HIDE-SPACES is still accepted for
1473 backward compatibility. If non-nil, strings in COLLECTION that start
1474 with a space are ignored unless STRING itself starts with a space. */)
1475 (Lisp_Object string, Lisp_Object collection, Lisp_Object predicate, Lisp_Object hide_spaces)
1477 Lisp_Object tail, elt, eltstring;
1478 Lisp_Object allmatches;
1479 int type = HASH_TABLE_P (collection) ? 3
1480 : VECTORP (collection) ? 2
1481 : NILP (collection) || (CONSP (collection) && !FUNCTIONP (collection));
1482 ptrdiff_t idx = 0, obsize = 0;
1483 ptrdiff_t bindcount = -1;
1484 Lisp_Object bucket, tem, zero;
1486 CHECK_STRING (string);
1487 if (type == 0)
1488 return call3 (collection, string, predicate, Qt);
1489 allmatches = bucket = Qnil;
1490 zero = make_number (0);
1492 /* If COLLECTION is not a list, set TAIL just for gc pro. */
1493 tail = collection;
1494 if (type == 2)
1496 collection = check_obarray (collection);
1497 obsize = ASIZE (collection);
1498 bucket = AREF (collection, idx);
1501 while (1)
1503 /* Get the next element of the alist, obarray, or hash-table. */
1504 /* Exit the loop if the elements are all used up. */
1505 /* elt gets the alist element or symbol.
1506 eltstring gets the name to check as a completion. */
1508 if (type == 1)
1510 if (!CONSP (tail))
1511 break;
1512 elt = XCAR (tail);
1513 eltstring = CONSP (elt) ? XCAR (elt) : elt;
1514 tail = XCDR (tail);
1516 else if (type == 2)
1518 if (!EQ (bucket, zero))
1520 if (!SYMBOLP (bucket))
1521 error ("Bad data in guts of obarray");
1522 elt = bucket;
1523 eltstring = elt;
1524 if (XSYMBOL (bucket)->u.s.next)
1525 XSETSYMBOL (bucket, XSYMBOL (bucket)->u.s.next);
1526 else
1527 XSETFASTINT (bucket, 0);
1529 else if (++idx >= obsize)
1530 break;
1531 else
1533 bucket = AREF (collection, idx);
1534 continue;
1537 else /* if (type == 3) */
1539 while (idx < HASH_TABLE_SIZE (XHASH_TABLE (collection))
1540 && NILP (HASH_HASH (XHASH_TABLE (collection), idx)))
1541 idx++;
1542 if (idx >= HASH_TABLE_SIZE (XHASH_TABLE (collection)))
1543 break;
1544 else
1545 elt = eltstring = HASH_KEY (XHASH_TABLE (collection), idx++);
1548 /* Is this element a possible completion? */
1550 if (SYMBOLP (eltstring))
1551 eltstring = Fsymbol_name (eltstring);
1553 if (STRINGP (eltstring)
1554 && SCHARS (string) <= SCHARS (eltstring)
1555 /* If HIDE_SPACES, reject alternatives that start with space
1556 unless the input starts with space. */
1557 && (NILP (hide_spaces)
1558 || (SBYTES (string) > 0
1559 && SREF (string, 0) == ' ')
1560 || SREF (eltstring, 0) != ' ')
1561 && (tem = Fcompare_strings (eltstring, zero,
1562 make_number (SCHARS (string)),
1563 string, zero,
1564 make_number (SCHARS (string)),
1565 completion_ignore_case ? Qt : Qnil),
1566 EQ (Qt, tem)))
1568 /* Yes. */
1569 Lisp_Object regexps;
1571 /* Ignore this element if it fails to match all the regexps. */
1573 for (regexps = Vcompletion_regexp_list; CONSP (regexps);
1574 regexps = XCDR (regexps))
1576 if (bindcount < 0) {
1577 bindcount = SPECPDL_INDEX ();
1578 specbind (Qcase_fold_search,
1579 completion_ignore_case ? Qt : Qnil);
1581 tem = Fstring_match (XCAR (regexps), eltstring, zero);
1582 if (NILP (tem))
1583 break;
1585 if (CONSP (regexps))
1586 continue;
1589 /* Ignore this element if there is a predicate
1590 and the predicate doesn't like it. */
1592 if (!NILP (predicate))
1594 if (EQ (predicate, Qcommandp))
1595 tem = Fcommandp (elt, Qnil);
1596 else
1598 if (bindcount >= 0) {
1599 unbind_to (bindcount, Qnil);
1600 bindcount = -1;
1602 tem = type == 3
1603 ? call2 (predicate, elt,
1604 HASH_VALUE (XHASH_TABLE (collection), idx - 1))
1605 : call1 (predicate, elt);
1607 if (NILP (tem)) continue;
1609 /* Ok => put it on the list. */
1610 allmatches = Fcons (eltstring, allmatches);
1614 if (bindcount >= 0) {
1615 unbind_to (bindcount, Qnil);
1616 bindcount = -1;
1619 return Fnreverse (allmatches);
1622 DEFUN ("completing-read", Fcompleting_read, Scompleting_read, 2, 8, 0,
1623 doc: /* Read a string in the minibuffer, with completion.
1624 PROMPT is a string to prompt with; normally it ends in a colon and a space.
1625 COLLECTION can be a list of strings, an alist, an obarray or a hash table.
1626 COLLECTION can also be a function to do the completion itself.
1627 PREDICATE limits completion to a subset of COLLECTION.
1628 See `try-completion', `all-completions', `test-completion',
1629 and `completion-boundaries', for more details on completion,
1630 COLLECTION, and PREDICATE. See also Info node `(elisp)Basic Completion'
1631 for the details about completion, and Info node `(elisp)Programmed
1632 Completion' for expectations from COLLECTION when it's a function.
1634 REQUIRE-MATCH can take the following values:
1635 - t means that the user is not allowed to exit unless the input is (or
1636 completes to) an element of COLLECTION or is null.
1637 - nil means that the user can exit with any input.
1638 - `confirm' means that the user can exit with any input, but she needs
1639 to confirm her choice if the input is not an element of COLLECTION.
1640 - `confirm-after-completion' means that the user can exit with any
1641 input, but she needs to confirm her choice if she called
1642 `minibuffer-complete' right before `minibuffer-complete-and-exit'
1643 and the input is not an element of COLLECTION.
1644 - anything else behaves like t except that typing RET does not exit if it
1645 does non-null completion.
1647 If the input is null, `completing-read' returns DEF, or the first
1648 element of the list of default values, or an empty string if DEF is
1649 nil, regardless of the value of REQUIRE-MATCH.
1651 If INITIAL-INPUT is non-nil, insert it in the minibuffer initially,
1652 with point positioned at the end. If it is (STRING . POSITION), the
1653 initial input is STRING, but point is placed at _zero-indexed_
1654 position POSITION in STRING. (*Note* that this is different from
1655 `read-from-minibuffer' and related functions, which use one-indexing
1656 for POSITION.) This feature is deprecated--it is best to pass nil
1657 for INITIAL-INPUT and supply the default value DEF instead. The
1658 user can yank the default value into the minibuffer easily using
1659 \\<minibuffer-local-map>\\[next-history-element].
1661 HIST, if non-nil, specifies a history list and optionally the initial
1662 position in the list. It can be a symbol, which is the history list
1663 variable to use, or it can be a cons cell (HISTVAR . HISTPOS). In
1664 that case, HISTVAR is the history list variable to use, and HISTPOS
1665 is the initial position (the position in the list used by the
1666 minibuffer history commands). For consistency, you should also
1667 specify that element of the history as the value of INITIAL-INPUT.
1668 (This is the only case in which you should use INITIAL-INPUT instead
1669 of DEF.) Positions are counted starting from 1 at the beginning of
1670 the list. The variable `history-length' controls the maximum length
1671 of a history list.
1673 DEF, if non-nil, is the default value or the list of default values.
1675 If INHERIT-INPUT-METHOD is non-nil, the minibuffer inherits the
1676 current input method and the setting of `enable-multibyte-characters'.
1678 Completion ignores case if the ambient value of
1679 `completion-ignore-case' is non-nil.
1681 See also `completing-read-function'. */)
1682 (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)
1684 return CALLN (Ffuncall,
1685 Fsymbol_value (intern ("completing-read-function")),
1686 prompt, collection, predicate, require_match, initial_input,
1687 hist, def, inherit_input_method);
1690 /* Test whether TXT is an exact completion. */
1691 DEFUN ("test-completion", Ftest_completion, Stest_completion, 2, 3, 0,
1692 doc: /* Return non-nil if STRING is a valid completion.
1693 Takes the same arguments as `all-completions' and `try-completion'.
1694 If COLLECTION is a function, it is called with three arguments:
1695 the values STRING, PREDICATE and `lambda'. */)
1696 (Lisp_Object string, Lisp_Object collection, Lisp_Object predicate)
1698 Lisp_Object regexps, tail, tem = Qnil;
1699 ptrdiff_t i = 0;
1701 CHECK_STRING (string);
1703 if (NILP (collection) || (CONSP (collection) && !FUNCTIONP (collection)))
1705 tem = Fassoc_string (string, collection, completion_ignore_case ? Qt : Qnil);
1706 if (NILP (tem))
1707 return Qnil;
1709 else if (VECTORP (collection))
1711 /* Bypass intern-soft as that loses for nil. */
1712 tem = oblookup (collection,
1713 SSDATA (string),
1714 SCHARS (string),
1715 SBYTES (string));
1716 if (!SYMBOLP (tem))
1718 if (STRING_MULTIBYTE (string))
1719 string = Fstring_make_unibyte (string);
1720 else
1721 string = Fstring_make_multibyte (string);
1723 tem = oblookup (collection,
1724 SSDATA (string),
1725 SCHARS (string),
1726 SBYTES (string));
1729 if (completion_ignore_case && !SYMBOLP (tem))
1731 for (i = ASIZE (collection) - 1; i >= 0; i--)
1733 tail = AREF (collection, i);
1734 if (SYMBOLP (tail))
1735 while (1)
1737 if (EQ (Fcompare_strings (string, make_number (0), Qnil,
1738 Fsymbol_name (tail),
1739 make_number (0) , Qnil, Qt),
1740 Qt))
1742 tem = tail;
1743 break;
1745 if (XSYMBOL (tail)->u.s.next == 0)
1746 break;
1747 XSETSYMBOL (tail, XSYMBOL (tail)->u.s.next);
1752 if (!SYMBOLP (tem))
1753 return Qnil;
1755 else if (HASH_TABLE_P (collection))
1757 struct Lisp_Hash_Table *h = XHASH_TABLE (collection);
1758 i = hash_lookup (h, string, NULL);
1759 if (i >= 0)
1761 tem = HASH_KEY (h, i);
1762 goto found_matching_key;
1764 else
1765 for (i = 0; i < HASH_TABLE_SIZE (h); ++i)
1767 if (NILP (HASH_HASH (h, i))) continue;
1768 tem = HASH_KEY (h, i);
1769 Lisp_Object strkey = (SYMBOLP (tem) ? Fsymbol_name (tem) : tem);
1770 if (!STRINGP (strkey)) continue;
1771 if (EQ (Fcompare_strings (string, Qnil, Qnil,
1772 strkey, Qnil, Qnil,
1773 completion_ignore_case ? Qt : Qnil),
1774 Qt))
1775 goto found_matching_key;
1777 return Qnil;
1778 found_matching_key: ;
1780 else
1781 return call3 (collection, string, predicate, Qlambda);
1783 /* Reject this element if it fails to match all the regexps. */
1784 if (CONSP (Vcompletion_regexp_list))
1786 ptrdiff_t count = SPECPDL_INDEX ();
1787 specbind (Qcase_fold_search, completion_ignore_case ? Qt : Qnil);
1788 for (regexps = Vcompletion_regexp_list; CONSP (regexps);
1789 regexps = XCDR (regexps))
1791 /* We can test against STRING, because if we got here, then
1792 the element is equivalent to it. */
1793 if (NILP (Fstring_match (XCAR (regexps), string, Qnil)))
1794 return unbind_to (count, Qnil);
1796 unbind_to (count, Qnil);
1799 /* Finally, check the predicate. */
1800 if (!NILP (predicate))
1802 return HASH_TABLE_P (collection)
1803 ? call2 (predicate, tem, HASH_VALUE (XHASH_TABLE (collection), i))
1804 : call1 (predicate, tem);
1806 else
1807 return Qt;
1810 DEFUN ("internal-complete-buffer", Finternal_complete_buffer, Sinternal_complete_buffer, 3, 3, 0,
1811 doc: /* Perform completion on buffer names.
1812 STRING and PREDICATE have the same meanings as in `try-completion',
1813 `all-completions', and `test-completion'.
1815 If FLAG is nil, invoke `try-completion'; if it is t, invoke
1816 `all-completions'; otherwise invoke `test-completion'. */)
1817 (Lisp_Object string, Lisp_Object predicate, Lisp_Object flag)
1819 if (NILP (flag))
1820 return Ftry_completion (string, Vbuffer_alist, predicate);
1821 else if (EQ (flag, Qt))
1823 Lisp_Object res = Fall_completions (string, Vbuffer_alist, predicate, Qnil);
1824 if (SCHARS (string) > 0)
1825 return res;
1826 else
1827 { /* Strip out internal buffers. */
1828 Lisp_Object bufs = res;
1829 /* First, look for a non-internal buffer in `res'. */
1830 while (CONSP (bufs) && SREF (XCAR (bufs), 0) == ' ')
1831 bufs = XCDR (bufs);
1832 if (NILP (bufs))
1833 return (EQ (Flength (res), Flength (Vbuffer_alist))
1834 /* If all bufs are internal don't strip them out. */
1835 ? res : bufs);
1836 res = bufs;
1837 while (CONSP (XCDR (bufs)))
1838 if (SREF (XCAR (XCDR (bufs)), 0) == ' ')
1839 XSETCDR (bufs, XCDR (XCDR (bufs)));
1840 else
1841 bufs = XCDR (bufs);
1842 return res;
1845 else if (EQ (flag, Qlambda))
1846 return Ftest_completion (string, Vbuffer_alist, predicate);
1847 else if (EQ (flag, Qmetadata))
1848 return list2 (Qmetadata, Fcons (Qcategory, Qbuffer));
1849 else
1850 return Qnil;
1853 /* Like assoc but assumes KEY is a string, and ignores case if appropriate. */
1855 DEFUN ("assoc-string", Fassoc_string, Sassoc_string, 2, 3, 0,
1856 doc: /* Like `assoc' but specifically for strings (and symbols).
1858 This returns the first element of LIST whose car matches the string or
1859 symbol KEY, or nil if no match exists. When performing the
1860 comparison, symbols are first converted to strings, and unibyte
1861 strings to multibyte. If the optional arg CASE-FOLD is non-nil, both
1862 KEY and the elements of LIST are upcased for comparison.
1864 Unlike `assoc', KEY can also match an entry in LIST consisting of a
1865 single string, rather than a cons cell whose car is a string. */)
1866 (register Lisp_Object key, Lisp_Object list, Lisp_Object case_fold)
1868 register Lisp_Object tail;
1870 if (SYMBOLP (key))
1871 key = Fsymbol_name (key);
1873 for (tail = list; CONSP (tail); tail = XCDR (tail))
1875 register Lisp_Object elt, tem, thiscar;
1876 elt = XCAR (tail);
1877 thiscar = CONSP (elt) ? XCAR (elt) : elt;
1878 if (SYMBOLP (thiscar))
1879 thiscar = Fsymbol_name (thiscar);
1880 else if (!STRINGP (thiscar))
1881 continue;
1882 tem = Fcompare_strings (thiscar, make_number (0), Qnil,
1883 key, make_number (0), Qnil,
1884 case_fold);
1885 if (EQ (tem, Qt))
1886 return elt;
1887 maybe_quit ();
1889 return Qnil;
1893 DEFUN ("minibuffer-depth", Fminibuffer_depth, Sminibuffer_depth, 0, 0, 0,
1894 doc: /* Return current depth of activations of minibuffer, a nonnegative integer. */)
1895 (void)
1897 return make_number (minibuf_level);
1900 DEFUN ("minibuffer-prompt", Fminibuffer_prompt, Sminibuffer_prompt, 0, 0, 0,
1901 doc: /* Return the prompt string of the currently-active minibuffer.
1902 If no minibuffer is active, return nil. */)
1903 (void)
1905 return Fcopy_sequence (minibuf_prompt);
1909 void
1910 init_minibuf_once (void)
1912 Vminibuffer_list = Qnil;
1913 staticpro (&Vminibuffer_list);
1916 void
1917 syms_of_minibuf (void)
1919 minibuf_level = 0;
1920 minibuf_prompt = Qnil;
1921 staticpro (&minibuf_prompt);
1923 minibuf_save_list = Qnil;
1924 staticpro (&minibuf_save_list);
1926 DEFSYM (Qcompletion_ignore_case, "completion-ignore-case");
1927 DEFSYM (Qminibuffer_default, "minibuffer-default");
1928 Fset (Qminibuffer_default, Qnil);
1930 DEFSYM (Qminibuffer_completion_table, "minibuffer-completion-table");
1932 staticpro (&last_minibuf_string);
1933 last_minibuf_string = Qnil;
1935 DEFSYM (Qcustom_variable_history, "custom-variable-history");
1936 Fset (Qcustom_variable_history, Qnil);
1938 DEFSYM (Qminibuffer_history, "minibuffer-history");
1939 DEFSYM (Qbuffer_name_history, "buffer-name-history");
1940 Fset (Qbuffer_name_history, Qnil);
1942 DEFSYM (Qcustom_variable_p, "custom-variable-p");
1944 /* Normal hooks for entry to and exit from minibuffer. */
1945 DEFSYM (Qminibuffer_setup_hook, "minibuffer-setup-hook");
1946 DEFSYM (Qminibuffer_exit_hook, "minibuffer-exit-hook");
1948 /* The maximum length of a minibuffer history. */
1949 DEFSYM (Qhistory_length, "history-length");
1951 DEFSYM (Qcurrent_input_method, "current-input-method");
1952 DEFSYM (Qactivate_input_method, "activate-input-method");
1953 DEFSYM (Qcase_fold_search, "case-fold-search");
1954 DEFSYM (Qmetadata, "metadata");
1955 /* A frame parameter. */
1956 DEFSYM (Qminibuffer_exit, "minibuffer-exit");
1958 DEFVAR_LISP ("read-expression-history", Vread_expression_history,
1959 doc: /* A history list for arguments that are Lisp expressions to evaluate.
1960 For example, `eval-expression' uses this. */);
1961 Vread_expression_history = Qnil;
1963 DEFVAR_LISP ("read-buffer-function", Vread_buffer_function,
1964 doc: /* If this is non-nil, `read-buffer' does its work by calling this function.
1965 The function is called with the arguments passed to `read-buffer'. */);
1966 Vread_buffer_function = Qnil;
1968 DEFVAR_BOOL ("read-buffer-completion-ignore-case",
1969 read_buffer_completion_ignore_case,
1970 doc: /* Non-nil means completion ignores case when reading a buffer name. */);
1971 read_buffer_completion_ignore_case = 0;
1973 DEFVAR_LISP ("minibuffer-setup-hook", Vminibuffer_setup_hook,
1974 doc: /* Normal hook run just after entry to minibuffer. */);
1975 Vminibuffer_setup_hook = Qnil;
1977 DEFVAR_LISP ("minibuffer-exit-hook", Vminibuffer_exit_hook,
1978 doc: /* Normal hook run just after exit from minibuffer. */);
1979 Vminibuffer_exit_hook = Qnil;
1981 DEFVAR_LISP ("history-length", Vhistory_length,
1982 doc: /* Maximum length of history lists before truncation takes place.
1983 A number means truncate to that length; truncation deletes old
1984 elements, and is done just after inserting a new element.
1985 A value of t means no truncation.
1987 This variable only affects history lists that don't specify their own
1988 maximum lengths. Setting the `history-length' property of a history
1989 variable overrides this default. */);
1990 XSETFASTINT (Vhistory_length, 100);
1992 DEFVAR_BOOL ("history-delete-duplicates", history_delete_duplicates,
1993 doc: /* Non-nil means to delete duplicates in history.
1994 If set to t when adding a new history element, all previous identical
1995 elements are deleted from the history list. */);
1996 history_delete_duplicates = 0;
1998 DEFVAR_LISP ("history-add-new-input", Vhistory_add_new_input,
1999 doc: /* Non-nil means to add new elements in history.
2000 If set to nil, minibuffer reading functions don't add new elements to the
2001 history list, so it is possible to do this afterwards by calling
2002 `add-to-history' explicitly. */);
2003 Vhistory_add_new_input = Qt;
2005 DEFVAR_BOOL ("completion-ignore-case", completion_ignore_case,
2006 doc: /* Non-nil means don't consider case significant in completion.
2007 For file-name completion, `read-file-name-completion-ignore-case'
2008 controls the behavior, rather than this variable.
2009 For buffer name completion, `read-buffer-completion-ignore-case'
2010 controls the behavior, rather than this variable. */);
2011 completion_ignore_case = 0;
2013 DEFVAR_BOOL ("enable-recursive-minibuffers", enable_recursive_minibuffers,
2014 doc: /* Non-nil means to allow minibuffer commands while in the minibuffer.
2015 This variable makes a difference whenever the minibuffer window is active.
2016 Also see `minibuffer-depth-indicate-mode', which may be handy if this
2017 variable is non-nil. */);
2018 enable_recursive_minibuffers = 0;
2020 DEFVAR_LISP ("minibuffer-completion-table", Vminibuffer_completion_table,
2021 doc: /* Alist or obarray used for completion in the minibuffer.
2022 This becomes the ALIST argument to `try-completion' and `all-completions'.
2023 The value can also be a list of strings or a hash table.
2025 The value may alternatively be a function, which is given three arguments:
2026 STRING, the current buffer contents;
2027 PREDICATE, the predicate for filtering possible matches;
2028 CODE, which says what kind of things to do.
2029 CODE can be nil, t or `lambda':
2030 nil -- return the best completion of STRING, or nil if there is none.
2031 t -- return a list of all possible completions of STRING.
2032 lambda -- return t if STRING is a valid completion as it stands. */);
2033 Vminibuffer_completion_table = Qnil;
2035 DEFVAR_LISP ("minibuffer-completion-predicate", Vminibuffer_completion_predicate,
2036 doc: /* Within call to `completing-read', this holds the PREDICATE argument. */);
2037 Vminibuffer_completion_predicate = Qnil;
2039 DEFVAR_LISP ("minibuffer-completion-confirm", Vminibuffer_completion_confirm,
2040 doc: /* Whether to demand confirmation of completion before exiting minibuffer.
2041 If nil, confirmation is not required.
2042 If the value is `confirm', the user may exit with an input that is not
2043 a valid completion alternative, but Emacs asks for confirmation.
2044 If the value is `confirm-after-completion', the user may exit with an
2045 input that is not a valid completion alternative, but Emacs asks for
2046 confirmation if the user submitted the input right after any of the
2047 completion commands listed in `minibuffer-confirm-exit-commands'. */);
2048 Vminibuffer_completion_confirm = Qnil;
2050 DEFVAR_LISP ("minibuffer-completing-file-name",
2051 Vminibuffer_completing_file_name,
2052 doc: /* Non-nil means completing file names. */);
2053 Vminibuffer_completing_file_name = Qnil;
2055 DEFVAR_LISP ("minibuffer-help-form", Vminibuffer_help_form,
2056 doc: /* Value that `help-form' takes on inside the minibuffer. */);
2057 Vminibuffer_help_form = Qnil;
2059 DEFVAR_LISP ("minibuffer-history-variable", Vminibuffer_history_variable,
2060 doc: /* History list symbol to add minibuffer values to.
2061 Each string of minibuffer input, as it appears on exit from the minibuffer,
2062 is added with
2063 (set minibuffer-history-variable
2064 (cons STRING (symbol-value minibuffer-history-variable))) */);
2065 XSETFASTINT (Vminibuffer_history_variable, 0);
2067 DEFVAR_LISP ("minibuffer-history-position", Vminibuffer_history_position,
2068 doc: /* Current position of redoing in the history list. */);
2069 Vminibuffer_history_position = Qnil;
2071 DEFVAR_BOOL ("minibuffer-auto-raise", minibuffer_auto_raise,
2072 doc: /* Non-nil means entering the minibuffer raises the minibuffer's frame.
2073 Some uses of the echo area also raise that frame (since they use it too). */);
2074 minibuffer_auto_raise = 0;
2076 DEFVAR_LISP ("completion-regexp-list", Vcompletion_regexp_list,
2077 doc: /* List of regexps that should restrict possible completions.
2078 The basic completion functions only consider a completion acceptable
2079 if it matches all regular expressions in this list, with
2080 `case-fold-search' bound to the value of `completion-ignore-case'.
2081 See Info node `(elisp)Basic Completion', for a description of these
2082 functions. */);
2083 Vcompletion_regexp_list = Qnil;
2085 DEFVAR_BOOL ("minibuffer-allow-text-properties",
2086 minibuffer_allow_text_properties,
2087 doc: /* Non-nil means `read-from-minibuffer' should not discard text properties.
2088 This also affects `read-string', but it does not affect `read-minibuffer',
2089 `read-no-blanks-input', or any of the functions that do minibuffer input
2090 with completion; they always discard text properties. */);
2091 minibuffer_allow_text_properties = 0;
2093 DEFVAR_LISP ("minibuffer-prompt-properties", Vminibuffer_prompt_properties,
2094 doc: /* Text properties that are added to minibuffer prompts.
2095 These are in addition to the basic `field' property, and stickiness
2096 properties. */);
2097 Vminibuffer_prompt_properties = list2 (Qread_only, Qt);
2099 DEFVAR_LISP ("read-hide-char", Vread_hide_char,
2100 doc: /* Whether to hide input characters in noninteractive mode.
2101 It must be a character, which will be used to mask the input
2102 characters. This variable should never be set globally. */);
2103 Vread_hide_char = Qnil;
2105 defsubr (&Sactive_minibuffer_window);
2106 defsubr (&Sset_minibuffer_window);
2107 defsubr (&Sread_from_minibuffer);
2108 defsubr (&Sread_string);
2109 defsubr (&Sread_command);
2110 defsubr (&Sread_variable);
2111 defsubr (&Sinternal_complete_buffer);
2112 defsubr (&Sread_buffer);
2113 defsubr (&Sread_no_blanks_input);
2114 defsubr (&Sminibuffer_depth);
2115 defsubr (&Sminibuffer_prompt);
2117 defsubr (&Sminibufferp);
2118 defsubr (&Sminibuffer_prompt_end);
2119 defsubr (&Sminibuffer_contents);
2120 defsubr (&Sminibuffer_contents_no_properties);
2122 defsubr (&Stry_completion);
2123 defsubr (&Sall_completions);
2124 defsubr (&Stest_completion);
2125 defsubr (&Sassoc_string);
2126 defsubr (&Scompleting_read);