Merge from gnulib
[emacs.git] / src / minibuf.c
blobd44bb44baee1bdf2eefd12ad4d2ebaf94657a292
1 /* Minibuffer input and completion.
3 Copyright (C) 1985-1986, 1993-2017 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 <http://www.gnu.org/licenses/>. */
21 #include <config.h>
22 #include <errno.h>
23 #include <stdio.h>
25 #include <binary-io.h>
27 #include "lisp.h"
28 #include "character.h"
29 #include "buffer.h"
30 #include "keyboard.h"
31 #include "frame.h"
32 #include "window.h"
33 #include "keymap.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 (SDATA (prompt), 1, SBYTES (prompt), stdout);
213 fflush (stdout);
215 val = Qnil;
216 size = 100;
217 len = 0;
218 line = xmalloc (size);
220 while ((c = getchar ()) != '\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);
328 DEFUN ("minibuffer-completion-contents", Fminibuffer_completion_contents,
329 Sminibuffer_completion_contents, 0, 0, 0,
330 doc: /* Return the user input in a minibuffer before point as a string.
331 That is what completion commands operate on.
332 If the current buffer is not a minibuffer, return its entire contents. */)
333 (void)
335 ptrdiff_t prompt_end = XINT (Fminibuffer_prompt_end ());
336 if (PT < prompt_end)
337 error ("Cannot do completion in the prompt");
338 return make_buffer_string (prompt_end, PT, 1);
342 /* Read from the minibuffer using keymap MAP and initial contents INITIAL,
343 putting point minus BACKUP_N bytes from the end of INITIAL,
344 prompting with PROMPT (a string), using history list HISTVAR
345 with initial position HISTPOS. INITIAL should be a string or a
346 cons of a string and an integer. BACKUP_N should be <= 0, or
347 Qnil, which is equivalent to 0. If INITIAL is a cons, BACKUP_N is
348 ignored and replaced with an integer that puts point at one-indexed
349 position N in INITIAL, where N is the CDR of INITIAL, or at the
350 beginning of INITIAL if N <= 0.
352 Normally return the result as a string (the text that was read),
353 but if EXPFLAG, read it and return the object read.
354 If HISTVAR is given, save the value read on that history only if it doesn't
355 match the front of that history list exactly. The value is pushed onto
356 the list as the string that was read.
358 DEFALT specifies the default value for the sake of history commands.
360 If ALLOW_PROPS, do not throw away text properties.
362 if INHERIT_INPUT_METHOD, the minibuffer inherits the
363 current input method. */
365 static Lisp_Object
366 read_minibuf (Lisp_Object map, Lisp_Object initial, Lisp_Object prompt,
367 bool expflag,
368 Lisp_Object histvar, Lisp_Object histpos, Lisp_Object defalt,
369 bool allow_props, bool inherit_input_method)
371 Lisp_Object val;
372 ptrdiff_t count = SPECPDL_INDEX ();
373 Lisp_Object mini_frame, ambient_dir, minibuffer, input_method;
374 Lisp_Object enable_multibyte;
375 EMACS_INT pos = 0;
376 /* String to add to the history. */
377 Lisp_Object histstring;
378 Lisp_Object histval;
380 Lisp_Object empty_minibuf;
381 Lisp_Object dummy, frame;
383 specbind (Qminibuffer_default, defalt);
384 specbind (Qinhibit_read_only, Qnil);
386 /* If Vminibuffer_completing_file_name is `lambda' on entry, it was t
387 in previous recursive minibuffer, but was not set explicitly
388 to t for this invocation, so set it to nil in this minibuffer.
389 Save the old value now, before we change it. */
390 specbind (intern ("minibuffer-completing-file-name"),
391 Vminibuffer_completing_file_name);
392 if (EQ (Vminibuffer_completing_file_name, Qlambda))
393 Vminibuffer_completing_file_name = Qnil;
395 #ifdef HAVE_WINDOW_SYSTEM
396 if (display_hourglass_p)
397 cancel_hourglass ();
398 #endif
400 if (!NILP (initial))
402 if (CONSP (initial))
404 Lisp_Object backup_n = XCDR (initial);
405 initial = XCAR (initial);
406 CHECK_STRING (initial);
407 if (!NILP (backup_n))
409 CHECK_NUMBER (backup_n);
410 /* Convert to distance from end of input. */
411 if (XINT (backup_n) < 1)
412 /* A number too small means the beginning of the string. */
413 pos = - SCHARS (initial);
414 else
415 pos = XINT (backup_n) - 1 - SCHARS (initial);
418 else
419 CHECK_STRING (initial);
421 val = Qnil;
422 ambient_dir = BVAR (current_buffer, directory);
423 input_method = Qnil;
424 enable_multibyte = Qnil;
426 if (!STRINGP (prompt))
427 prompt = empty_unibyte_string;
429 if (!enable_recursive_minibuffers
430 && minibuf_level > 0)
432 if (EQ (selected_window, minibuf_window))
433 error ("Command attempted to use minibuffer while in minibuffer");
434 else
435 /* If we're in another window, cancel the minibuffer that's active. */
436 Fthrow (Qexit,
437 build_string ("Command attempted to use minibuffer while in minibuffer"));
440 if ((noninteractive
441 /* In case we are running as a daemon, only do this before
442 detaching from the terminal. */
443 || (IS_DAEMON && DAEMON_RUNNING))
444 && NILP (Vexecuting_kbd_macro))
446 val = read_minibuf_noninteractive (map, initial, prompt,
447 make_number (pos),
448 expflag, histvar, histpos, defalt,
449 allow_props, inherit_input_method);
450 return unbind_to (count, val);
453 /* Choose the minibuffer window and frame, and take action on them. */
455 /* Prepare for restoring the current buffer since choose_minibuf_frame
456 calling Fset_frame_selected_window may change it (Bug#12766). */
457 record_unwind_protect (restore_buffer, Fcurrent_buffer ());
459 choose_minibuf_frame ();
461 record_unwind_protect_void (choose_minibuf_frame);
463 record_unwind_protect (restore_window_configuration,
464 Fcurrent_window_configuration (Qnil));
466 /* If the minibuffer window is on a different frame, save that
467 frame's configuration too. */
468 mini_frame = WINDOW_FRAME (XWINDOW (minibuf_window));
469 if (!EQ (mini_frame, selected_frame))
470 record_unwind_protect (restore_window_configuration,
471 Fcurrent_window_configuration (mini_frame));
473 /* If the minibuffer is on an iconified or invisible frame,
474 make it visible now. */
475 Fmake_frame_visible (mini_frame);
477 if (minibuffer_auto_raise)
478 Fraise_frame (mini_frame);
480 temporarily_switch_to_single_kboard (XFRAME (mini_frame));
482 /* We have to do this after saving the window configuration
483 since that is what restores the current buffer. */
485 /* Arrange to restore a number of minibuffer-related variables.
486 We could bind each variable separately, but that would use lots of
487 specpdl slots. */
488 minibuf_save_list
489 = Fcons (Voverriding_local_map,
490 Fcons (minibuf_window,
491 minibuf_save_list));
492 minibuf_save_list
493 = Fcons (minibuf_prompt,
494 Fcons (make_number (minibuf_prompt_width),
495 Fcons (Vhelp_form,
496 Fcons (Vcurrent_prefix_arg,
497 Fcons (Vminibuffer_history_position,
498 Fcons (Vminibuffer_history_variable,
499 minibuf_save_list))))));
501 record_unwind_protect_void (read_minibuf_unwind);
502 minibuf_level++;
503 /* We are exiting the minibuffer one way or the other, so run the hook.
504 It should be run before unwinding the minibuf settings. Do it
505 separately from read_minibuf_unwind because we need to make sure that
506 read_minibuf_unwind is fully executed even if exit-minibuffer-hook
507 signals an error. --Stef */
508 record_unwind_protect_void (run_exit_minibuf_hook);
510 /* Now that we can restore all those variables, start changing them. */
512 minibuf_prompt_width = 0;
513 minibuf_prompt = Fcopy_sequence (prompt);
514 Vminibuffer_history_position = histpos;
515 Vminibuffer_history_variable = histvar;
516 Vhelp_form = Vminibuffer_help_form;
517 /* If this minibuffer is reading a file name, that doesn't mean
518 recursive ones are. But we cannot set it to nil, because
519 completion code still need to know the minibuffer is completing a
520 file name. So use `lambda' as intermediate value meaning
521 "t" in this minibuffer, but "nil" in next minibuffer. */
522 if (!NILP (Vminibuffer_completing_file_name))
523 Vminibuffer_completing_file_name = Qlambda;
525 /* If variable is unbound, make it nil. */
526 histval = find_symbol_value (Vminibuffer_history_variable);
527 if (EQ (histval, Qunbound))
529 Fset (Vminibuffer_history_variable, Qnil);
530 histval = Qnil;
533 if (inherit_input_method)
535 /* `current-input-method' is buffer local. So, remember it in
536 INPUT_METHOD before changing the current buffer. */
537 input_method = Fsymbol_value (Qcurrent_input_method);
538 enable_multibyte = BVAR (current_buffer, enable_multibyte_characters);
541 /* Switch to the minibuffer. */
543 minibuffer = get_minibuffer (minibuf_level);
544 Fset_buffer (minibuffer);
546 /* Defeat (setq-default truncate-lines t), since truncated lines do
547 not work correctly in minibuffers. (Bug#5715, etc) */
548 bset_truncate_lines (current_buffer, Qnil);
550 /* If appropriate, copy enable-multibyte-characters into the minibuffer. */
551 if (inherit_input_method)
552 bset_enable_multibyte_characters (current_buffer, enable_multibyte);
554 /* The current buffer's default directory is usually the right thing
555 for our minibuffer here. However, if you're typing a command at
556 a minibuffer-only frame when minibuf_level is zero, then buf IS
557 the current_buffer, so reset_buffer leaves buf's default
558 directory unchanged. This is a bummer when you've just started
559 up Emacs and buf's default directory is Qnil. Here's a hack; can
560 you think of something better to do? Find another buffer with a
561 better directory, and use that one instead. */
562 if (STRINGP (ambient_dir))
563 bset_directory (current_buffer, ambient_dir);
564 else
566 Lisp_Object tail, buf;
568 FOR_EACH_LIVE_BUFFER (tail, buf)
569 if (STRINGP (BVAR (XBUFFER (buf), directory)))
571 bset_directory (current_buffer,
572 BVAR (XBUFFER (buf), directory));
573 break;
577 if (!EQ (mini_frame, selected_frame))
578 Fredirect_frame_focus (selected_frame, mini_frame);
580 Vminibuf_scroll_window = selected_window;
581 if (minibuf_level == 1 || !EQ (minibuf_window, selected_window))
582 minibuf_selected_window = selected_window;
584 /* Empty out the minibuffers of all frames other than the one
585 where we are going to display one now.
586 Set them to point to ` *Minibuf-0*', which is always empty. */
587 empty_minibuf = get_minibuffer (0);
589 FOR_EACH_FRAME (dummy, frame)
591 Lisp_Object root_window = Fframe_root_window (frame);
592 Lisp_Object mini_window = XWINDOW (root_window)->next;
594 if (! NILP (mini_window) && ! EQ (mini_window, minibuf_window)
595 && !NILP (Fwindow_minibuffer_p (mini_window)))
596 /* Use set_window_buffer instead of Fset_window_buffer (see
597 discussion of bug#11984, bug#12025, bug#12026). */
598 set_window_buffer (mini_window, empty_minibuf, 0, 0);
601 /* Display this minibuffer in the proper window. */
602 /* Use set_window_buffer instead of Fset_window_buffer (see
603 discussion of bug#11984, bug#12025, bug#12026). */
604 set_window_buffer (minibuf_window, Fcurrent_buffer (), 0, 0);
605 Fselect_window (minibuf_window, Qnil);
606 XWINDOW (minibuf_window)->hscroll = 0;
607 XWINDOW (minibuf_window)->suspend_auto_hscroll = 0;
609 Fmake_local_variable (Qprint_escape_newlines);
610 print_escape_newlines = 1;
612 /* Erase the buffer. */
614 ptrdiff_t count1 = SPECPDL_INDEX ();
615 specbind (Qinhibit_read_only, Qt);
616 specbind (Qinhibit_modification_hooks, Qt);
617 Ferase_buffer ();
619 if (!NILP (BVAR (current_buffer, enable_multibyte_characters))
620 && ! STRING_MULTIBYTE (minibuf_prompt))
621 minibuf_prompt = Fstring_make_multibyte (minibuf_prompt);
623 /* Insert the prompt, record where it ends. */
624 Finsert (1, &minibuf_prompt);
625 if (PT > BEG)
627 Fput_text_property (make_number (BEG), make_number (PT),
628 Qfront_sticky, Qt, Qnil);
629 Fput_text_property (make_number (BEG), make_number (PT),
630 Qrear_nonsticky, Qt, Qnil);
631 Fput_text_property (make_number (BEG), make_number (PT),
632 Qfield, Qt, Qnil);
633 if (CONSP (Vminibuffer_prompt_properties))
635 /* We want to apply all properties from
636 `minibuffer-prompt-properties' to the region normally,
637 but if the `face' property is present, add that
638 property to the end of the face properties to avoid
639 overwriting faces. */
640 Lisp_Object list = Vminibuffer_prompt_properties;
641 while (CONSP (list))
643 Lisp_Object key = XCAR (list);
644 list = XCDR (list);
645 if (CONSP (list))
647 Lisp_Object val = XCAR (list);
648 list = XCDR (list);
649 if (EQ (key, Qface))
650 Fadd_face_text_property (make_number (BEG),
651 make_number (PT), val, Qt, Qnil);
652 else
653 Fput_text_property (make_number (BEG), make_number (PT),
654 key, val, Qnil);
659 unbind_to (count1, Qnil);
662 minibuf_prompt_width = current_column ();
664 /* Put in the initial input. */
665 if (!NILP (initial))
667 Finsert (1, &initial);
668 Fforward_char (make_number (pos));
671 clear_message (1, 1);
672 bset_keymap (current_buffer, map);
674 /* Turn on an input method stored in INPUT_METHOD if any. */
675 if (STRINGP (input_method) && !NILP (Ffboundp (Qactivate_input_method)))
676 call1 (Qactivate_input_method, input_method);
678 run_hook (Qminibuffer_setup_hook);
680 /* Don't allow the user to undo past this point. */
681 bset_undo_list (current_buffer, Qnil);
683 recursive_edit_1 ();
685 /* If cursor is on the minibuffer line,
686 show the user we have exited by putting it in column 0. */
687 if (XWINDOW (minibuf_window)->cursor.vpos >= 0
688 && !noninteractive)
690 XWINDOW (minibuf_window)->cursor.hpos = 0;
691 XWINDOW (minibuf_window)->cursor.x = 0;
692 XWINDOW (minibuf_window)->must_be_updated_p = true;
693 update_frame (XFRAME (selected_frame), true, true);
694 flush_frame (XFRAME (XWINDOW (minibuf_window)->frame));
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. */
726 /* The value of the history variable must be a cons or nil. Other
727 values are unacceptable. We silently ignore these values. */
729 if (NILP (histval)
730 || (CONSP (histval)
731 /* Don't duplicate the most recent entry in the history. */
732 && (NILP (Fequal (histstring, Fcar (histval))))))
734 Lisp_Object length;
736 if (history_delete_duplicates) Fdelete (histstring, histval);
737 histval = Fcons (histstring, histval);
738 Fset (Vminibuffer_history_variable, histval);
740 /* Truncate if requested. */
741 length = Fget (Vminibuffer_history_variable, Qhistory_length);
742 if (NILP (length)) length = Vhistory_length;
743 if (INTEGERP (length))
745 if (XINT (length) <= 0)
746 Fset (Vminibuffer_history_variable, Qnil);
747 else
749 Lisp_Object temp;
751 temp = Fnthcdr (Fsub1 (length), histval);
752 if (CONSP (temp)) Fsetcdr (temp, Qnil);
758 /* If Lisp form desired instead of string, parse it. */
759 if (expflag)
760 val = string_to_object (val, defalt);
762 /* The appropriate frame will get selected
763 in set-window-configuration. */
764 return unbind_to (count, val);
767 /* Return a buffer to be used as the minibuffer at depth `depth'.
768 depth = 0 is the lowest allowed argument, and that is the value
769 used for nonrecursive minibuffer invocations. */
771 Lisp_Object
772 get_minibuffer (EMACS_INT depth)
774 Lisp_Object tail = Fnthcdr (make_number (depth), Vminibuffer_list);
775 if (NILP (tail))
777 tail = list1 (Qnil);
778 Vminibuffer_list = nconc2 (Vminibuffer_list, tail);
780 Lisp_Object buf = Fcar (tail);
781 if (NILP (buf) || !BUFFER_LIVE_P (XBUFFER (buf)))
783 static char const name_fmt[] = " *Minibuf-%"pI"d*";
784 char name[sizeof name_fmt + INT_STRLEN_BOUND (EMACS_INT)];
785 AUTO_STRING_WITH_LEN (lname, name, sprintf (name, name_fmt, depth));
786 buf = Fget_buffer_create (lname);
788 /* Although the buffer's name starts with a space, undo should be
789 enabled in it. */
790 Fbuffer_enable_undo (buf);
792 XSETCAR (tail, buf);
794 else
796 ptrdiff_t count = SPECPDL_INDEX ();
797 /* We have to empty both overlay lists. Otherwise we end
798 up with overlays that think they belong to this buffer
799 while the buffer doesn't know about them any more. */
800 delete_all_overlays (XBUFFER (buf));
801 reset_buffer (XBUFFER (buf));
802 record_unwind_current_buffer ();
803 Fset_buffer (buf);
804 if (!NILP (Ffboundp (intern ("minibuffer-inactive-mode"))))
805 call0 (intern ("minibuffer-inactive-mode"));
806 else
807 Fkill_all_local_variables ();
808 unbind_to (count, Qnil);
811 return buf;
814 static void
815 run_exit_minibuf_hook (void)
817 safe_run_hooks (Qminibuffer_exit_hook);
820 /* This function is called on exiting minibuffer, whether normally or
821 not, and it restores the current window, buffer, etc. */
823 static void
824 read_minibuf_unwind (void)
826 Lisp_Object old_deactivate_mark;
827 Lisp_Object window;
829 /* If this was a recursive minibuffer,
830 tie the minibuffer window back to the outer level minibuffer buffer. */
831 minibuf_level--;
833 window = minibuf_window;
834 /* To keep things predictable, in case it matters, let's be in the
835 minibuffer when we reset the relevant variables. */
836 Fset_buffer (XWINDOW (window)->contents);
838 /* Restore prompt, etc, from outer minibuffer level. */
839 minibuf_prompt = Fcar (minibuf_save_list);
840 minibuf_save_list = Fcdr (minibuf_save_list);
841 minibuf_prompt_width = XFASTINT (Fcar (minibuf_save_list));
842 minibuf_save_list = Fcdr (minibuf_save_list);
843 Vhelp_form = Fcar (minibuf_save_list);
844 minibuf_save_list = Fcdr (minibuf_save_list);
845 Vcurrent_prefix_arg = Fcar (minibuf_save_list);
846 minibuf_save_list = Fcdr (minibuf_save_list);
847 Vminibuffer_history_position = Fcar (minibuf_save_list);
848 minibuf_save_list = Fcdr (minibuf_save_list);
849 Vminibuffer_history_variable = Fcar (minibuf_save_list);
850 minibuf_save_list = Fcdr (minibuf_save_list);
851 Voverriding_local_map = Fcar (minibuf_save_list);
852 minibuf_save_list = Fcdr (minibuf_save_list);
853 #if 0
854 temp = Fcar (minibuf_save_list);
855 if (FRAME_LIVE_P (XFRAME (WINDOW_FRAME (XWINDOW (temp)))))
856 minibuf_window = temp;
857 #endif
858 minibuf_save_list = Fcdr (minibuf_save_list);
860 /* Erase the minibuffer we were using at this level. */
862 ptrdiff_t count = SPECPDL_INDEX ();
863 /* Prevent error in erase-buffer. */
864 specbind (Qinhibit_read_only, Qt);
865 specbind (Qinhibit_modification_hooks, Qt);
866 old_deactivate_mark = Vdeactivate_mark;
867 Ferase_buffer ();
868 Vdeactivate_mark = old_deactivate_mark;
869 unbind_to (count, Qnil);
872 /* When we get to the outmost level, make sure we resize the
873 mini-window back to its normal size. */
874 if (minibuf_level == 0)
875 resize_mini_window (XWINDOW (window), 0);
877 /* In case the previous minibuffer displayed in this miniwindow is
878 dead, we may keep displaying this buffer (tho it's inactive), so reset it,
879 to make sure we don't leave around bindings and stuff which only
880 made sense during the read_minibuf invocation. */
881 call0 (intern ("minibuffer-inactive-mode"));
885 DEFUN ("read-from-minibuffer", Fread_from_minibuffer,
886 Sread_from_minibuffer, 1, 7, 0,
887 doc: /* Read a string from the minibuffer, prompting with string PROMPT.
888 The optional second arg INITIAL-CONTENTS is an obsolete alternative to
889 DEFAULT-VALUE. It normally should be nil in new code, except when
890 HIST is a cons. It is discussed in more detail below.
892 Third arg KEYMAP is a keymap to use whilst reading;
893 if omitted or nil, the default is `minibuffer-local-map'.
895 If fourth arg READ is non-nil, interpret the result as a Lisp object
896 and return that object:
897 in other words, do `(car (read-from-string INPUT-STRING))'
899 Fifth arg HIST, if non-nil, specifies a history list and optionally
900 the initial position in the list. It can be a symbol, which is the
901 history list variable to use, or a cons cell (HISTVAR . HISTPOS).
902 In that case, HISTVAR is the history list variable to use, and
903 HISTPOS is the initial position for use by the minibuffer history
904 commands. For consistency, you should also specify that element of
905 the history as the value of INITIAL-CONTENTS. Positions are counted
906 starting from 1 at the beginning of the list.
908 Sixth arg DEFAULT-VALUE, if non-nil, should be a string, which is used
909 as the default to `read' if READ is non-nil and the user enters
910 empty input. But if READ is nil, this function does _not_ return
911 DEFAULT-VALUE for empty input! Instead, it returns the empty string.
913 Whatever the value of READ, DEFAULT-VALUE is made available via the
914 minibuffer history commands. DEFAULT-VALUE can also be a list of
915 strings, in which case all the strings are available in the history,
916 and the first string is the default to `read' if READ is non-nil.
918 Seventh arg INHERIT-INPUT-METHOD, if non-nil, means the minibuffer inherits
919 the current input method and the setting of `enable-multibyte-characters'.
921 If the variable `minibuffer-allow-text-properties' is non-nil,
922 then the string which is returned includes whatever text properties
923 were present in the minibuffer. Otherwise the value has no text properties.
925 The remainder of this documentation string describes the
926 INITIAL-CONTENTS argument in more detail. It is only relevant when
927 studying existing code, or when HIST is a cons. If non-nil,
928 INITIAL-CONTENTS is a string to be inserted into the minibuffer before
929 reading input. Normally, point is put at the end of that string.
930 However, if INITIAL-CONTENTS is (STRING . POSITION), the initial
931 input is STRING, but point is placed at _one-indexed_ position
932 POSITION in the minibuffer. Any integer value less than or equal to
933 one puts point at the beginning of the string. *Note* that this
934 behavior differs from the way such arguments are used in `completing-read'
935 and some related functions, which use zero-indexing for POSITION. */)
936 (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)
938 Lisp_Object histvar, histpos, val;
940 CHECK_STRING (prompt);
941 if (NILP (keymap))
942 keymap = Vminibuffer_local_map;
943 else
944 keymap = get_keymap (keymap, 1, 0);
946 if (SYMBOLP (hist))
948 histvar = hist;
949 histpos = Qnil;
951 else
953 histvar = Fcar_safe (hist);
954 histpos = Fcdr_safe (hist);
956 if (NILP (histvar))
957 histvar = Qminibuffer_history;
958 if (NILP (histpos))
959 XSETFASTINT (histpos, 0);
961 val = read_minibuf (keymap, initial_contents, prompt,
962 !NILP (read),
963 histvar, histpos, default_value,
964 minibuffer_allow_text_properties,
965 !NILP (inherit_input_method));
966 return val;
969 /* Functions that use the minibuffer to read various things. */
971 DEFUN ("read-string", Fread_string, Sread_string, 1, 5, 0,
972 doc: /* Read a string from the minibuffer, prompting with string PROMPT.
973 If non-nil, second arg INITIAL-INPUT is a string to insert before reading.
974 This argument has been superseded by DEFAULT-VALUE and should normally be nil
975 in new code. It behaves as INITIAL-CONTENTS in `read-from-minibuffer' (which
976 see).
977 The third arg HISTORY, if non-nil, specifies a history list
978 and optionally the initial position in the list.
979 See `read-from-minibuffer' for details of HISTORY argument.
980 Fourth arg DEFAULT-VALUE is the default value or the list of default values.
981 If non-nil, it is used for history commands, and as the value (or the first
982 element of the list of default values) to return if the user enters the
983 empty string.
984 Fifth arg INHERIT-INPUT-METHOD, if non-nil, means the minibuffer inherits
985 the current input method and the setting of `enable-multibyte-characters'. */)
986 (Lisp_Object prompt, Lisp_Object initial_input, Lisp_Object history, Lisp_Object default_value, Lisp_Object inherit_input_method)
988 Lisp_Object val;
989 ptrdiff_t count = SPECPDL_INDEX ();
991 /* Just in case we're in a recursive minibuffer, make it clear that the
992 previous minibuffer's completion table does not apply to the new
993 minibuffer.
994 FIXME: `minibuffer-completion-table' should be buffer-local instead. */
995 specbind (Qminibuffer_completion_table, Qnil);
997 val = Fread_from_minibuffer (prompt, initial_input, Qnil,
998 Qnil, history, default_value,
999 inherit_input_method);
1000 if (STRINGP (val) && SCHARS (val) == 0 && ! NILP (default_value))
1001 val = CONSP (default_value) ? XCAR (default_value) : default_value;
1002 return unbind_to (count, val);
1005 DEFUN ("read-no-blanks-input", Fread_no_blanks_input, Sread_no_blanks_input, 1, 3, 0,
1006 doc: /* Read a string from the terminal, not allowing blanks.
1007 Prompt with PROMPT. Whitespace terminates the input. If INITIAL is
1008 non-nil, it should be a string, which is used as initial input, with
1009 point positioned at the end, so that SPACE will accept the input.
1010 \(Actually, INITIAL can also be a cons of a string and an integer.
1011 Such values are treated as in `read-from-minibuffer', but are normally
1012 not useful in this function.)
1013 Third arg INHERIT-INPUT-METHOD, if non-nil, means the minibuffer inherits
1014 the current input method and the setting of`enable-multibyte-characters'. */)
1015 (Lisp_Object prompt, Lisp_Object initial, Lisp_Object inherit_input_method)
1017 CHECK_STRING (prompt);
1018 return read_minibuf (Vminibuffer_local_ns_map, initial, prompt,
1019 0, Qminibuffer_history, make_number (0), Qnil, 0,
1020 !NILP (inherit_input_method));
1023 DEFUN ("read-command", Fread_command, Sread_command, 1, 2, 0,
1024 doc: /* Read the name of a command and return as a symbol.
1025 Prompt with PROMPT. By default, return DEFAULT-VALUE or its first element
1026 if it is a list. */)
1027 (Lisp_Object prompt, Lisp_Object default_value)
1029 Lisp_Object name, default_string;
1031 if (NILP (default_value))
1032 default_string = Qnil;
1033 else if (SYMBOLP (default_value))
1034 default_string = SYMBOL_NAME (default_value);
1035 else
1036 default_string = default_value;
1038 name = Fcompleting_read (prompt, Vobarray, Qcommandp, Qt,
1039 Qnil, Qnil, default_string, Qnil);
1040 if (NILP (name))
1041 return name;
1042 return Fintern (name, Qnil);
1045 #ifdef NOTDEF
1046 DEFUN ("read-function", Fread_function, Sread_function, 1, 1, 0,
1047 doc: /* One arg PROMPT, a string. Read the name of a function and return as a symbol.
1048 Prompt with PROMPT. */)
1049 (Lisp_Object prompt)
1051 return Fintern (Fcompleting_read (prompt, Vobarray, Qfboundp, Qt, Qnil, Qnil, Qnil, Qnil),
1052 Qnil);
1054 #endif /* NOTDEF */
1056 DEFUN ("read-variable", Fread_variable, Sread_variable, 1, 2, 0,
1057 doc: /* Read the name of a user option and return it as a symbol.
1058 Prompt with PROMPT. By default, return DEFAULT-VALUE or its first element
1059 if it is a list.
1060 A user option, or customizable variable, is one for which
1061 `custom-variable-p' returns non-nil. */)
1062 (Lisp_Object prompt, Lisp_Object default_value)
1064 Lisp_Object name, default_string;
1066 if (NILP (default_value))
1067 default_string = Qnil;
1068 else if (SYMBOLP (default_value))
1069 default_string = SYMBOL_NAME (default_value);
1070 else
1071 default_string = default_value;
1073 name = Fcompleting_read (prompt, Vobarray,
1074 Qcustom_variable_p, Qt,
1075 Qnil, Qnil, default_string, Qnil);
1076 if (NILP (name))
1077 return name;
1078 return Fintern (name, Qnil);
1081 DEFUN ("read-buffer", Fread_buffer, Sread_buffer, 1, 4, 0,
1082 doc: /* Read the name of a buffer and return as a string.
1083 Prompt with PROMPT.
1084 Optional second arg DEF is value to return if user enters an empty line.
1085 If DEF is a list of default values, return its first element.
1086 Optional third arg REQUIRE-MATCH determines whether non-existing
1087 buffer names are allowed. It has the same meaning as the
1088 REQUIRE-MATCH argument of `completing-read'.
1089 The argument PROMPT should be a string ending with a colon and a space.
1090 If `read-buffer-completion-ignore-case' is non-nil, completion ignores
1091 case while reading the buffer name.
1092 If `read-buffer-function' is non-nil, this works by calling it as a
1093 function, instead of the usual behavior.
1094 Optional arg PREDICATE if non-nil is a function limiting the buffers that can
1095 be considered. */)
1096 (Lisp_Object prompt, Lisp_Object def, Lisp_Object require_match,
1097 Lisp_Object predicate)
1099 Lisp_Object result;
1100 char *s;
1101 ptrdiff_t len;
1102 ptrdiff_t count = SPECPDL_INDEX ();
1104 if (BUFFERP (def))
1105 def = BVAR (XBUFFER (def), name);
1107 specbind (Qcompletion_ignore_case,
1108 read_buffer_completion_ignore_case ? Qt : Qnil);
1110 if (NILP (Vread_buffer_function))
1112 if (!NILP (def))
1114 /* A default value was provided: we must change PROMPT,
1115 editing the default value in before the colon. To achieve
1116 this, we replace PROMPT with a substring that doesn't
1117 contain the terminal space and colon (if present). They
1118 are then added back using Fformat. */
1120 if (STRINGP (prompt))
1122 s = SSDATA (prompt);
1123 len = SBYTES (prompt);
1124 if (len >= 2 && s[len - 2] == ':' && s[len - 1] == ' ')
1125 len = len - 2;
1126 else if (len >= 1 && (s[len - 1] == ':' || s[len - 1] == ' '))
1127 len--;
1129 prompt = make_specified_string (s, -1, len,
1130 STRING_MULTIBYTE (prompt));
1133 AUTO_STRING (format, "%s (default %s): ");
1134 prompt = CALLN (Fformat, format, prompt,
1135 CONSP (def) ? XCAR (def) : def);
1138 result = Fcompleting_read (prompt, intern ("internal-complete-buffer"),
1139 predicate, require_match, Qnil,
1140 Qbuffer_name_history, def, Qnil);
1142 else
1143 result = (NILP (predicate)
1144 /* Partial backward compatibility for older read_buffer_functions
1145 which don't expect a `predicate' argument. */
1146 ? call3 (Vread_buffer_function, prompt, def, require_match)
1147 : call4 (Vread_buffer_function, prompt, def, require_match,
1148 predicate));
1149 return unbind_to (count, result);
1152 static Lisp_Object
1153 minibuf_conform_representation (Lisp_Object string, Lisp_Object basis)
1155 if (STRING_MULTIBYTE (string) == STRING_MULTIBYTE (basis))
1156 return string;
1158 if (STRING_MULTIBYTE (string))
1159 return Fstring_make_unibyte (string);
1160 else
1161 return Fstring_make_multibyte (string);
1164 DEFUN ("try-completion", Ftry_completion, Stry_completion, 2, 3, 0,
1165 doc: /* Return common substring of all completions of STRING in COLLECTION.
1166 Test each possible completion specified by COLLECTION
1167 to see if it begins with STRING. The possible completions may be
1168 strings or symbols. Symbols are converted to strings before testing,
1169 see `symbol-name'.
1170 All that match STRING are compared together; the longest initial sequence
1171 common to all these matches is the return value.
1172 If there is no match at all, the return value is nil.
1173 For a unique match which is exact, the return value is t.
1175 If COLLECTION is an alist, the keys (cars of elements) are the
1176 possible completions. If an element is not a cons cell, then the
1177 element itself is the possible completion.
1178 If COLLECTION is a hash-table, all the keys that are strings or symbols
1179 are the possible completions.
1180 If COLLECTION is an obarray, the names of all symbols in the obarray
1181 are the possible completions.
1183 COLLECTION can also be a function to do the completion itself.
1184 It receives three arguments: the values STRING, PREDICATE and nil.
1185 Whatever it returns becomes the value of `try-completion'.
1187 If optional third argument PREDICATE is non-nil,
1188 it is used to test each possible match.
1189 The match is a candidate only if PREDICATE returns non-nil.
1190 The argument given to PREDICATE is the alist element
1191 or the symbol from the obarray. If COLLECTION is a hash-table,
1192 predicate is called with two arguments: the key and the value.
1193 Additionally to this predicate, `completion-regexp-list'
1194 is used to further constrain the set of candidates. */)
1195 (Lisp_Object string, Lisp_Object collection, Lisp_Object predicate)
1197 Lisp_Object bestmatch, tail, elt, eltstring;
1198 /* Size in bytes of BESTMATCH. */
1199 ptrdiff_t bestmatchsize = 0;
1200 /* These are in bytes, too. */
1201 ptrdiff_t compare, matchsize;
1202 enum { function_table, list_table, obarray_table, hash_table}
1203 type = (HASH_TABLE_P (collection) ? hash_table
1204 : VECTORP (collection) ? obarray_table
1205 : ((NILP (collection)
1206 || (CONSP (collection) && !FUNCTIONP (collection)))
1207 ? list_table : function_table));
1208 ptrdiff_t idx = 0, obsize = 0;
1209 int matchcount = 0;
1210 ptrdiff_t bindcount = -1;
1211 Lisp_Object bucket, zero, end, tem;
1213 CHECK_STRING (string);
1214 if (type == function_table)
1215 return call3 (collection, string, predicate, Qnil);
1217 bestmatch = bucket = Qnil;
1218 zero = make_number (0);
1220 /* If COLLECTION is not a list, set TAIL just for gc pro. */
1221 tail = collection;
1222 if (type == obarray_table)
1224 collection = check_obarray (collection);
1225 obsize = ASIZE (collection);
1226 bucket = AREF (collection, idx);
1229 while (1)
1231 /* Get the next element of the alist, obarray, or hash-table. */
1232 /* Exit the loop if the elements are all used up. */
1233 /* elt gets the alist element or symbol.
1234 eltstring gets the name to check as a completion. */
1236 if (type == list_table)
1238 if (!CONSP (tail))
1239 break;
1240 elt = XCAR (tail);
1241 eltstring = CONSP (elt) ? XCAR (elt) : elt;
1242 tail = XCDR (tail);
1244 else if (type == obarray_table)
1246 if (!EQ (bucket, zero))
1248 if (!SYMBOLP (bucket))
1249 error ("Bad data in guts of obarray");
1250 elt = bucket;
1251 eltstring = elt;
1252 if (XSYMBOL (bucket)->next)
1253 XSETSYMBOL (bucket, XSYMBOL (bucket)->next);
1254 else
1255 XSETFASTINT (bucket, 0);
1257 else if (++idx >= obsize)
1258 break;
1259 else
1261 bucket = AREF (collection, idx);
1262 continue;
1265 else /* if (type == hash_table) */
1267 while (idx < HASH_TABLE_SIZE (XHASH_TABLE (collection))
1268 && NILP (HASH_HASH (XHASH_TABLE (collection), idx)))
1269 idx++;
1270 if (idx >= HASH_TABLE_SIZE (XHASH_TABLE (collection)))
1271 break;
1272 else
1273 elt = eltstring = HASH_KEY (XHASH_TABLE (collection), idx++);
1276 /* Is this element a possible completion? */
1278 if (SYMBOLP (eltstring))
1279 eltstring = Fsymbol_name (eltstring);
1281 if (STRINGP (eltstring)
1282 && SCHARS (string) <= SCHARS (eltstring)
1283 && (tem = Fcompare_strings (eltstring, zero,
1284 make_number (SCHARS (string)),
1285 string, zero, Qnil,
1286 completion_ignore_case ? Qt : Qnil),
1287 EQ (Qt, tem)))
1289 /* Yes. */
1290 Lisp_Object regexps;
1292 /* Ignore this element if it fails to match all the regexps. */
1294 for (regexps = Vcompletion_regexp_list; CONSP (regexps);
1295 regexps = XCDR (regexps))
1297 if (bindcount < 0) {
1298 bindcount = SPECPDL_INDEX ();
1299 specbind (Qcase_fold_search,
1300 completion_ignore_case ? Qt : Qnil);
1302 tem = Fstring_match (XCAR (regexps), eltstring, zero);
1303 if (NILP (tem))
1304 break;
1306 if (CONSP (regexps))
1307 continue;
1310 /* Ignore this element if there is a predicate
1311 and the predicate doesn't like it. */
1313 if (!NILP (predicate))
1315 if (EQ (predicate, Qcommandp))
1316 tem = Fcommandp (elt, Qnil);
1317 else
1319 if (bindcount >= 0)
1321 unbind_to (bindcount, Qnil);
1322 bindcount = -1;
1324 tem = (type == hash_table
1325 ? call2 (predicate, elt,
1326 HASH_VALUE (XHASH_TABLE (collection),
1327 idx - 1))
1328 : call1 (predicate, elt));
1330 if (NILP (tem)) continue;
1333 /* Update computation of how much all possible completions match */
1335 if (NILP (bestmatch))
1337 matchcount = 1;
1338 bestmatch = eltstring;
1339 bestmatchsize = SCHARS (eltstring);
1341 else
1343 compare = min (bestmatchsize, SCHARS (eltstring));
1344 tem = Fcompare_strings (bestmatch, zero,
1345 make_number (compare),
1346 eltstring, zero,
1347 make_number (compare),
1348 completion_ignore_case ? Qt : Qnil);
1349 matchsize = EQ (tem, Qt) ? compare : eabs (XINT (tem)) - 1;
1351 if (completion_ignore_case)
1353 /* If this is an exact match except for case,
1354 use it as the best match rather than one that is not an
1355 exact match. This way, we get the case pattern
1356 of the actual match. */
1357 if ((matchsize == SCHARS (eltstring)
1358 && matchsize < SCHARS (bestmatch))
1360 /* If there is more than one exact match ignoring case,
1361 and one of them is exact including case,
1362 prefer that one. */
1363 /* If there is no exact match ignoring case,
1364 prefer a match that does not change the case
1365 of the input. */
1366 ((matchsize == SCHARS (eltstring))
1368 (matchsize == SCHARS (bestmatch))
1369 && (tem = Fcompare_strings (eltstring, zero,
1370 make_number (SCHARS (string)),
1371 string, zero,
1372 Qnil,
1373 Qnil),
1374 EQ (Qt, tem))
1375 && (tem = Fcompare_strings (bestmatch, zero,
1376 make_number (SCHARS (string)),
1377 string, zero,
1378 Qnil,
1379 Qnil),
1380 ! EQ (Qt, tem))))
1381 bestmatch = eltstring;
1383 if (bestmatchsize != SCHARS (eltstring)
1384 || bestmatchsize != matchsize)
1385 /* Don't count the same string multiple times. */
1386 matchcount += matchcount <= 1;
1387 bestmatchsize = matchsize;
1388 if (matchsize <= SCHARS (string)
1389 /* If completion-ignore-case is non-nil, don't
1390 short-circuit because we want to find the best
1391 possible match *including* case differences. */
1392 && !completion_ignore_case
1393 && matchcount > 1)
1394 /* No need to look any further. */
1395 break;
1400 if (bindcount >= 0) {
1401 unbind_to (bindcount, Qnil);
1402 bindcount = -1;
1405 if (NILP (bestmatch))
1406 return Qnil; /* No completions found. */
1407 /* If we are ignoring case, and there is no exact match,
1408 and no additional text was supplied,
1409 don't change the case of what the user typed. */
1410 if (completion_ignore_case && bestmatchsize == SCHARS (string)
1411 && SCHARS (bestmatch) > bestmatchsize)
1412 return minibuf_conform_representation (string, bestmatch);
1414 /* Return t if the supplied string is an exact match (counting case);
1415 it does not require any change to be made. */
1416 if (matchcount == 1 && !NILP (Fequal (bestmatch, string)))
1417 return Qt;
1419 XSETFASTINT (zero, 0); /* Else extract the part in which */
1420 XSETFASTINT (end, bestmatchsize); /* all completions agree. */
1421 return Fsubstring (bestmatch, zero, end);
1424 DEFUN ("all-completions", Fall_completions, Sall_completions, 2, 4, 0,
1425 doc: /* Search for partial matches to STRING in COLLECTION.
1426 Test each of the possible completions specified by COLLECTION
1427 to see if it begins with STRING. The possible completions may be
1428 strings or symbols. Symbols are converted to strings before testing,
1429 see `symbol-name'.
1430 The value is a list of all the possible completions that match STRING.
1432 If COLLECTION is an alist, the keys (cars of elements) are the
1433 possible completions. If an element is not a cons cell, then the
1434 element itself is the possible completion.
1435 If COLLECTION is a hash-table, all the keys that are strings or symbols
1436 are the possible completions.
1437 If COLLECTION is an obarray, the names of all symbols in the obarray
1438 are the possible completions.
1440 COLLECTION can also be a function to do the completion itself.
1441 It receives three arguments: the values STRING, PREDICATE and t.
1442 Whatever it returns becomes the value of `all-completions'.
1444 If optional third argument PREDICATE is non-nil,
1445 it is used to test each possible match.
1446 The match is a candidate only if PREDICATE returns non-nil.
1447 The argument given to PREDICATE is the alist element
1448 or the symbol from the obarray. If COLLECTION is a hash-table,
1449 predicate is called with two arguments: the key and the value.
1450 Additionally to this predicate, `completion-regexp-list'
1451 is used to further constrain the set of candidates.
1453 An obsolete optional fourth argument HIDE-SPACES is still accepted for
1454 backward compatibility. If non-nil, strings in COLLECTION that start
1455 with a space are ignored unless STRING itself starts with a space. */)
1456 (Lisp_Object string, Lisp_Object collection, Lisp_Object predicate, Lisp_Object hide_spaces)
1458 Lisp_Object tail, elt, eltstring;
1459 Lisp_Object allmatches;
1460 int type = HASH_TABLE_P (collection) ? 3
1461 : VECTORP (collection) ? 2
1462 : NILP (collection) || (CONSP (collection) && !FUNCTIONP (collection));
1463 ptrdiff_t idx = 0, obsize = 0;
1464 ptrdiff_t bindcount = -1;
1465 Lisp_Object bucket, tem, zero;
1467 CHECK_STRING (string);
1468 if (type == 0)
1469 return call3 (collection, string, predicate, Qt);
1470 allmatches = bucket = Qnil;
1471 zero = make_number (0);
1473 /* If COLLECTION is not a list, set TAIL just for gc pro. */
1474 tail = collection;
1475 if (type == 2)
1477 collection = check_obarray (collection);
1478 obsize = ASIZE (collection);
1479 bucket = AREF (collection, idx);
1482 while (1)
1484 /* Get the next element of the alist, obarray, or hash-table. */
1485 /* Exit the loop if the elements are all used up. */
1486 /* elt gets the alist element or symbol.
1487 eltstring gets the name to check as a completion. */
1489 if (type == 1)
1491 if (!CONSP (tail))
1492 break;
1493 elt = XCAR (tail);
1494 eltstring = CONSP (elt) ? XCAR (elt) : elt;
1495 tail = XCDR (tail);
1497 else if (type == 2)
1499 if (!EQ (bucket, zero))
1501 if (!SYMBOLP (bucket))
1502 error ("Bad data in guts of obarray");
1503 elt = bucket;
1504 eltstring = elt;
1505 if (XSYMBOL (bucket)->next)
1506 XSETSYMBOL (bucket, XSYMBOL (bucket)->next);
1507 else
1508 XSETFASTINT (bucket, 0);
1510 else if (++idx >= obsize)
1511 break;
1512 else
1514 bucket = AREF (collection, idx);
1515 continue;
1518 else /* if (type == 3) */
1520 while (idx < HASH_TABLE_SIZE (XHASH_TABLE (collection))
1521 && NILP (HASH_HASH (XHASH_TABLE (collection), idx)))
1522 idx++;
1523 if (idx >= HASH_TABLE_SIZE (XHASH_TABLE (collection)))
1524 break;
1525 else
1526 elt = eltstring = HASH_KEY (XHASH_TABLE (collection), idx++);
1529 /* Is this element a possible completion? */
1531 if (SYMBOLP (eltstring))
1532 eltstring = Fsymbol_name (eltstring);
1534 if (STRINGP (eltstring)
1535 && SCHARS (string) <= SCHARS (eltstring)
1536 /* If HIDE_SPACES, reject alternatives that start with space
1537 unless the input starts with space. */
1538 && (NILP (hide_spaces)
1539 || (SBYTES (string) > 0
1540 && SREF (string, 0) == ' ')
1541 || SREF (eltstring, 0) != ' ')
1542 && (tem = Fcompare_strings (eltstring, zero,
1543 make_number (SCHARS (string)),
1544 string, zero,
1545 make_number (SCHARS (string)),
1546 completion_ignore_case ? Qt : Qnil),
1547 EQ (Qt, tem)))
1549 /* Yes. */
1550 Lisp_Object regexps;
1552 /* Ignore this element if it fails to match all the regexps. */
1554 for (regexps = Vcompletion_regexp_list; CONSP (regexps);
1555 regexps = XCDR (regexps))
1557 if (bindcount < 0) {
1558 bindcount = SPECPDL_INDEX ();
1559 specbind (Qcase_fold_search,
1560 completion_ignore_case ? Qt : Qnil);
1562 tem = Fstring_match (XCAR (regexps), eltstring, zero);
1563 if (NILP (tem))
1564 break;
1566 if (CONSP (regexps))
1567 continue;
1570 /* Ignore this element if there is a predicate
1571 and the predicate doesn't like it. */
1573 if (!NILP (predicate))
1575 if (EQ (predicate, Qcommandp))
1576 tem = Fcommandp (elt, Qnil);
1577 else
1579 if (bindcount >= 0) {
1580 unbind_to (bindcount, Qnil);
1581 bindcount = -1;
1583 tem = type == 3
1584 ? call2 (predicate, elt,
1585 HASH_VALUE (XHASH_TABLE (collection), idx - 1))
1586 : call1 (predicate, elt);
1588 if (NILP (tem)) continue;
1590 /* Ok => put it on the list. */
1591 allmatches = Fcons (eltstring, allmatches);
1595 if (bindcount >= 0) {
1596 unbind_to (bindcount, Qnil);
1597 bindcount = -1;
1600 return Fnreverse (allmatches);
1603 DEFUN ("completing-read", Fcompleting_read, Scompleting_read, 2, 8, 0,
1604 doc: /* Read a string in the minibuffer, with completion.
1605 PROMPT is a string to prompt with; normally it ends in a colon and a space.
1606 COLLECTION can be a list of strings, an alist, an obarray or a hash table.
1607 COLLECTION can also be a function to do the completion itself.
1608 PREDICATE limits completion to a subset of COLLECTION.
1609 See `try-completion', `all-completions', `test-completion',
1610 and `completion-boundaries', for more details on completion,
1611 COLLECTION, and PREDICATE. See also Info nodes `(elisp)Basic Completion'
1612 for the details about completion, and `(elisp)Programmed Completion' for
1613 expectations from COLLECTION when it's a function.
1615 REQUIRE-MATCH can take the following values:
1616 - t means that the user is not allowed to exit unless
1617 the input is (or completes to) an element of COLLECTION or is null.
1618 - nil means that the user can exit with any input.
1619 - `confirm' means that the user can exit with any input, but she needs
1620 to confirm her choice if the input is not an element of COLLECTION.
1621 - `confirm-after-completion' means that the user can exit with any
1622 input, but she needs to confirm her choice if she called
1623 `minibuffer-complete' right before `minibuffer-complete-and-exit'
1624 and the input is not an element of COLLECTION.
1625 - anything else behaves like t except that typing RET does not exit if it
1626 does non-null completion.
1628 If the input is null, `completing-read' returns DEF, or the first element
1629 of the list of default values, or an empty string if DEF is nil,
1630 regardless of the value of REQUIRE-MATCH.
1632 If INITIAL-INPUT is non-nil, insert it in the minibuffer initially,
1633 with point positioned at the end.
1634 If it is (STRING . POSITION), the initial input is STRING, but point
1635 is placed at _zero-indexed_ position POSITION in STRING. (*Note*
1636 that this is different from `read-from-minibuffer' and related
1637 functions, which use one-indexing for POSITION.) This feature is
1638 deprecated--it is best to pass nil for INITIAL-INPUT and supply the
1639 default value DEF instead. The user can yank the default value into
1640 the minibuffer easily using \\<minibuffer-local-map>\\[next-history-element].
1642 HIST, if non-nil, specifies a history list and optionally the initial
1643 position in the list. It can be a symbol, which is the history list
1644 variable to use, or it can be a cons cell (HISTVAR . HISTPOS). In
1645 that case, HISTVAR is the history list variable to use, and HISTPOS
1646 is the initial position (the position in the list used by the
1647 minibuffer history commands). For consistency, you should also
1648 specify that element of the history as the value of
1649 INITIAL-INPUT. (This is the only case in which you should use
1650 INITIAL-INPUT instead of DEF.) Positions are counted starting from
1651 1 at the beginning of the list. The variable `history-length'
1652 controls the maximum length of a history list.
1654 DEF, if non-nil, is the default value or the list of default values.
1656 If INHERIT-INPUT-METHOD is non-nil, the minibuffer inherits
1657 the current input method and the setting of `enable-multibyte-characters'.
1659 Completion ignores case if the ambient value of
1660 `completion-ignore-case' is non-nil.
1662 See also `completing-read-function'. */)
1663 (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)
1665 return CALLN (Ffuncall,
1666 Fsymbol_value (intern ("completing-read-function")),
1667 prompt, collection, predicate, require_match, initial_input,
1668 hist, def, inherit_input_method);
1671 /* Test whether TXT is an exact completion. */
1672 DEFUN ("test-completion", Ftest_completion, Stest_completion, 2, 3, 0,
1673 doc: /* Return non-nil if STRING is a valid completion.
1674 Takes the same arguments as `all-completions' and `try-completion'.
1675 If COLLECTION is a function, it is called with three arguments:
1676 the values STRING, PREDICATE and `lambda'. */)
1677 (Lisp_Object string, Lisp_Object collection, Lisp_Object predicate)
1679 Lisp_Object regexps, tail, tem = Qnil;
1680 ptrdiff_t i = 0;
1682 CHECK_STRING (string);
1684 if (NILP (collection) || (CONSP (collection) && !FUNCTIONP (collection)))
1686 tem = Fassoc_string (string, collection, completion_ignore_case ? Qt : Qnil);
1687 if (NILP (tem))
1688 return Qnil;
1690 else if (VECTORP (collection))
1692 /* Bypass intern-soft as that loses for nil. */
1693 tem = oblookup (collection,
1694 SSDATA (string),
1695 SCHARS (string),
1696 SBYTES (string));
1697 if (!SYMBOLP (tem))
1699 if (STRING_MULTIBYTE (string))
1700 string = Fstring_make_unibyte (string);
1701 else
1702 string = Fstring_make_multibyte (string);
1704 tem = oblookup (collection,
1705 SSDATA (string),
1706 SCHARS (string),
1707 SBYTES (string));
1710 if (completion_ignore_case && !SYMBOLP (tem))
1712 for (i = ASIZE (collection) - 1; i >= 0; i--)
1714 tail = AREF (collection, i);
1715 if (SYMBOLP (tail))
1716 while (1)
1718 if (EQ (Fcompare_strings (string, make_number (0), Qnil,
1719 Fsymbol_name (tail),
1720 make_number (0) , Qnil, Qt),
1721 Qt))
1723 tem = tail;
1724 break;
1726 if (XSYMBOL (tail)->next == 0)
1727 break;
1728 XSETSYMBOL (tail, XSYMBOL (tail)->next);
1733 if (!SYMBOLP (tem))
1734 return Qnil;
1736 else if (HASH_TABLE_P (collection))
1738 struct Lisp_Hash_Table *h = XHASH_TABLE (collection);
1739 i = hash_lookup (h, string, NULL);
1740 if (i >= 0)
1742 tem = HASH_KEY (h, i);
1743 goto found_matching_key;
1745 else
1746 for (i = 0; i < HASH_TABLE_SIZE (h); ++i)
1748 if (NILP (HASH_HASH (h, i))) continue;
1749 tem = HASH_KEY (h, i);
1750 Lisp_Object strkey = (SYMBOLP (tem) ? Fsymbol_name (tem) : tem);
1751 if (!STRINGP (strkey)) continue;
1752 if (EQ (Fcompare_strings (string, Qnil, Qnil,
1753 strkey, Qnil, Qnil,
1754 completion_ignore_case ? Qt : Qnil),
1755 Qt))
1756 goto found_matching_key;
1758 return Qnil;
1759 found_matching_key: ;
1761 else
1762 return call3 (collection, string, predicate, Qlambda);
1764 /* Reject this element if it fails to match all the regexps. */
1765 if (CONSP (Vcompletion_regexp_list))
1767 ptrdiff_t count = SPECPDL_INDEX ();
1768 specbind (Qcase_fold_search, completion_ignore_case ? Qt : Qnil);
1769 for (regexps = Vcompletion_regexp_list; CONSP (regexps);
1770 regexps = XCDR (regexps))
1772 /* We can test against STRING, because if we got here, then
1773 the element is equivalent to it. */
1774 if (NILP (Fstring_match (XCAR (regexps), string, Qnil)))
1775 return unbind_to (count, Qnil);
1777 unbind_to (count, Qnil);
1780 /* Finally, check the predicate. */
1781 if (!NILP (predicate))
1783 return HASH_TABLE_P (collection)
1784 ? call2 (predicate, tem, HASH_VALUE (XHASH_TABLE (collection), i))
1785 : call1 (predicate, tem);
1787 else
1788 return Qt;
1791 DEFUN ("internal-complete-buffer", Finternal_complete_buffer, Sinternal_complete_buffer, 3, 3, 0,
1792 doc: /* Perform completion on buffer names.
1793 STRING and PREDICATE have the same meanings as in `try-completion',
1794 `all-completions', and `test-completion'.
1796 If FLAG is nil, invoke `try-completion'; if it is t, invoke
1797 `all-completions'; otherwise invoke `test-completion'. */)
1798 (Lisp_Object string, Lisp_Object predicate, Lisp_Object flag)
1800 if (NILP (flag))
1801 return Ftry_completion (string, Vbuffer_alist, predicate);
1802 else if (EQ (flag, Qt))
1804 Lisp_Object res = Fall_completions (string, Vbuffer_alist, predicate, Qnil);
1805 if (SCHARS (string) > 0)
1806 return res;
1807 else
1808 { /* Strip out internal buffers. */
1809 Lisp_Object bufs = res;
1810 /* First, look for a non-internal buffer in `res'. */
1811 while (CONSP (bufs) && SREF (XCAR (bufs), 0) == ' ')
1812 bufs = XCDR (bufs);
1813 if (NILP (bufs))
1814 return (EQ (Flength (res), Flength (Vbuffer_alist))
1815 /* If all bufs are internal don't strip them out. */
1816 ? res : bufs);
1817 res = bufs;
1818 while (CONSP (XCDR (bufs)))
1819 if (SREF (XCAR (XCDR (bufs)), 0) == ' ')
1820 XSETCDR (bufs, XCDR (XCDR (bufs)));
1821 else
1822 bufs = XCDR (bufs);
1823 return res;
1826 else if (EQ (flag, Qlambda))
1827 return Ftest_completion (string, Vbuffer_alist, predicate);
1828 else if (EQ (flag, Qmetadata))
1829 return list2 (Qmetadata, Fcons (Qcategory, Qbuffer));
1830 else
1831 return Qnil;
1834 /* Like assoc but assumes KEY is a string, and ignores case if appropriate. */
1836 DEFUN ("assoc-string", Fassoc_string, Sassoc_string, 2, 3, 0,
1837 doc: /* Like `assoc' but specifically for strings (and symbols).
1839 This returns the first element of LIST whose car matches the string or
1840 symbol KEY, or nil if no match exists. When performing the
1841 comparison, symbols are first converted to strings, and unibyte
1842 strings to multibyte. If the optional arg CASE-FOLD is non-nil, both
1843 KEY and the elements of LIST are upcased for comparison.
1845 Unlike `assoc', KEY can also match an entry in LIST consisting of a
1846 single string, rather than a cons cell whose car is a string. */)
1847 (register Lisp_Object key, Lisp_Object list, Lisp_Object case_fold)
1849 register Lisp_Object tail;
1851 if (SYMBOLP (key))
1852 key = Fsymbol_name (key);
1854 for (tail = list; CONSP (tail); tail = XCDR (tail))
1856 register Lisp_Object elt, tem, thiscar;
1857 elt = XCAR (tail);
1858 thiscar = CONSP (elt) ? XCAR (elt) : elt;
1859 if (SYMBOLP (thiscar))
1860 thiscar = Fsymbol_name (thiscar);
1861 else if (!STRINGP (thiscar))
1862 continue;
1863 tem = Fcompare_strings (thiscar, make_number (0), Qnil,
1864 key, make_number (0), Qnil,
1865 case_fold);
1866 if (EQ (tem, Qt))
1867 return elt;
1868 QUIT;
1870 return Qnil;
1874 DEFUN ("minibuffer-depth", Fminibuffer_depth, Sminibuffer_depth, 0, 0, 0,
1875 doc: /* Return current depth of activations of minibuffer, a nonnegative integer. */)
1876 (void)
1878 return make_number (minibuf_level);
1881 DEFUN ("minibuffer-prompt", Fminibuffer_prompt, Sminibuffer_prompt, 0, 0, 0,
1882 doc: /* Return the prompt string of the currently-active minibuffer.
1883 If no minibuffer is active, return nil. */)
1884 (void)
1886 return Fcopy_sequence (minibuf_prompt);
1890 void
1891 init_minibuf_once (void)
1893 Vminibuffer_list = Qnil;
1894 staticpro (&Vminibuffer_list);
1897 void
1898 syms_of_minibuf (void)
1900 minibuf_level = 0;
1901 minibuf_prompt = Qnil;
1902 staticpro (&minibuf_prompt);
1904 minibuf_save_list = Qnil;
1905 staticpro (&minibuf_save_list);
1907 DEFSYM (Qcompletion_ignore_case, "completion-ignore-case");
1908 DEFSYM (Qminibuffer_default, "minibuffer-default");
1909 Fset (Qminibuffer_default, Qnil);
1911 DEFSYM (Qminibuffer_completion_table, "minibuffer-completion-table");
1913 staticpro (&last_minibuf_string);
1914 last_minibuf_string = Qnil;
1916 DEFSYM (Qminibuffer_history, "minibuffer-history");
1917 DEFSYM (Qbuffer_name_history, "buffer-name-history");
1918 Fset (Qbuffer_name_history, Qnil);
1920 DEFSYM (Qcustom_variable_p, "custom-variable-p");
1922 /* Normal hooks for entry to and exit from minibuffer. */
1923 DEFSYM (Qminibuffer_setup_hook, "minibuffer-setup-hook");
1924 DEFSYM (Qminibuffer_exit_hook, "minibuffer-exit-hook");
1926 /* The maximum length of a minibuffer history. */
1927 DEFSYM (Qhistory_length, "history-length");
1929 DEFSYM (Qcurrent_input_method, "current-input-method");
1930 DEFSYM (Qactivate_input_method, "activate-input-method");
1931 DEFSYM (Qcase_fold_search, "case-fold-search");
1932 DEFSYM (Qmetadata, "metadata");
1934 DEFVAR_LISP ("read-expression-history", Vread_expression_history,
1935 doc: /* A history list for arguments that are Lisp expressions to evaluate.
1936 For example, `eval-expression' uses this. */);
1937 Vread_expression_history = Qnil;
1939 DEFVAR_LISP ("read-buffer-function", Vread_buffer_function,
1940 doc: /* If this is non-nil, `read-buffer' does its work by calling this function.
1941 The function is called with the arguments passed to `read-buffer'. */);
1942 Vread_buffer_function = Qnil;
1944 DEFVAR_BOOL ("read-buffer-completion-ignore-case",
1945 read_buffer_completion_ignore_case,
1946 doc: /* Non-nil means completion ignores case when reading a buffer name. */);
1947 read_buffer_completion_ignore_case = 0;
1949 DEFVAR_LISP ("minibuffer-setup-hook", Vminibuffer_setup_hook,
1950 doc: /* Normal hook run just after entry to minibuffer. */);
1951 Vminibuffer_setup_hook = Qnil;
1953 DEFVAR_LISP ("minibuffer-exit-hook", Vminibuffer_exit_hook,
1954 doc: /* Normal hook run just after exit from minibuffer. */);
1955 Vminibuffer_exit_hook = Qnil;
1957 DEFVAR_LISP ("history-length", Vhistory_length,
1958 doc: /* Maximum length of history lists before truncation takes place.
1959 A number means truncate to that length; truncation deletes old
1960 elements, and is done just after inserting a new element.
1961 A value of t means no truncation.
1963 This variable only affects history lists that don't specify their own
1964 maximum lengths. Setting the `history-length' property of a history
1965 variable overrides this default. */);
1966 XSETFASTINT (Vhistory_length, 100);
1968 DEFVAR_BOOL ("history-delete-duplicates", history_delete_duplicates,
1969 doc: /* Non-nil means to delete duplicates in history.
1970 If set to t when adding a new history element, all previous identical
1971 elements are deleted from the history list. */);
1972 history_delete_duplicates = 0;
1974 DEFVAR_LISP ("history-add-new-input", Vhistory_add_new_input,
1975 doc: /* Non-nil means to add new elements in history.
1976 If set to nil, minibuffer reading functions don't add new elements to the
1977 history list, so it is possible to do this afterwards by calling
1978 `add-to-history' explicitly. */);
1979 Vhistory_add_new_input = Qt;
1981 DEFVAR_BOOL ("completion-ignore-case", completion_ignore_case,
1982 doc: /* Non-nil means don't consider case significant in completion.
1983 For file-name completion, `read-file-name-completion-ignore-case'
1984 controls the behavior, rather than this variable.
1985 For buffer name completion, `read-buffer-completion-ignore-case'
1986 controls the behavior, rather than this variable. */);
1987 completion_ignore_case = 0;
1989 DEFVAR_BOOL ("enable-recursive-minibuffers", enable_recursive_minibuffers,
1990 doc: /* Non-nil means to allow minibuffer commands while in the minibuffer.
1991 This variable makes a difference whenever the minibuffer window is active.
1992 Also see `minibuffer-depth-indicator-mode', which may be handy if this
1993 variable is non-nil. */);
1994 enable_recursive_minibuffers = 0;
1996 DEFVAR_LISP ("minibuffer-completion-table", Vminibuffer_completion_table,
1997 doc: /* Alist or obarray used for completion in the minibuffer.
1998 This becomes the ALIST argument to `try-completion' and `all-completions'.
1999 The value can also be a list of strings or a hash table.
2001 The value may alternatively be a function, which is given three arguments:
2002 STRING, the current buffer contents;
2003 PREDICATE, the predicate for filtering possible matches;
2004 CODE, which says what kind of things to do.
2005 CODE can be nil, t or `lambda':
2006 nil -- return the best completion of STRING, or nil if there is none.
2007 t -- return a list of all possible completions of STRING.
2008 lambda -- return t if STRING is a valid completion as it stands. */);
2009 Vminibuffer_completion_table = Qnil;
2011 DEFVAR_LISP ("minibuffer-completion-predicate", Vminibuffer_completion_predicate,
2012 doc: /* Within call to `completing-read', this holds the PREDICATE argument. */);
2013 Vminibuffer_completion_predicate = Qnil;
2015 DEFVAR_LISP ("minibuffer-completion-confirm", Vminibuffer_completion_confirm,
2016 doc: /* Whether to demand confirmation of completion before exiting minibuffer.
2017 If nil, confirmation is not required.
2018 If the value is `confirm', the user may exit with an input that is not
2019 a valid completion alternative, but Emacs asks for confirmation.
2020 If the value is `confirm-after-completion', the user may exit with an
2021 input that is not a valid completion alternative, but Emacs asks for
2022 confirmation if the user submitted the input right after any of the
2023 completion commands listed in `minibuffer-confirm-exit-commands'. */);
2024 Vminibuffer_completion_confirm = Qnil;
2026 DEFVAR_LISP ("minibuffer-completing-file-name",
2027 Vminibuffer_completing_file_name,
2028 doc: /* Non-nil means completing file names. */);
2029 Vminibuffer_completing_file_name = Qnil;
2031 DEFVAR_LISP ("minibuffer-help-form", Vminibuffer_help_form,
2032 doc: /* Value that `help-form' takes on inside the minibuffer. */);
2033 Vminibuffer_help_form = Qnil;
2035 DEFVAR_LISP ("minibuffer-history-variable", Vminibuffer_history_variable,
2036 doc: /* History list symbol to add minibuffer values to.
2037 Each string of minibuffer input, as it appears on exit from the minibuffer,
2038 is added with
2039 (set minibuffer-history-variable
2040 (cons STRING (symbol-value minibuffer-history-variable))) */);
2041 XSETFASTINT (Vminibuffer_history_variable, 0);
2043 DEFVAR_LISP ("minibuffer-history-position", Vminibuffer_history_position,
2044 doc: /* Current position of redoing in the history list. */);
2045 Vminibuffer_history_position = Qnil;
2047 DEFVAR_BOOL ("minibuffer-auto-raise", minibuffer_auto_raise,
2048 doc: /* Non-nil means entering the minibuffer raises the minibuffer's frame.
2049 Some uses of the echo area also raise that frame (since they use it too). */);
2050 minibuffer_auto_raise = 0;
2052 DEFVAR_LISP ("completion-regexp-list", Vcompletion_regexp_list,
2053 doc: /* List of regexps that should restrict possible completions.
2054 The basic completion functions only consider a completion acceptable
2055 if it matches all regular expressions in this list, with
2056 `case-fold-search' bound to the value of `completion-ignore-case'.
2057 See Info node `(elisp)Basic Completion', for a description of these
2058 functions. */);
2059 Vcompletion_regexp_list = Qnil;
2061 DEFVAR_BOOL ("minibuffer-allow-text-properties",
2062 minibuffer_allow_text_properties,
2063 doc: /* Non-nil means `read-from-minibuffer' should not discard text properties.
2064 This also affects `read-string', but it does not affect `read-minibuffer',
2065 `read-no-blanks-input', or any of the functions that do minibuffer input
2066 with completion; they always discard text properties. */);
2067 minibuffer_allow_text_properties = 0;
2069 DEFVAR_LISP ("minibuffer-prompt-properties", Vminibuffer_prompt_properties,
2070 doc: /* Text properties that are added to minibuffer prompts.
2071 These are in addition to the basic `field' property, and stickiness
2072 properties. */);
2073 Vminibuffer_prompt_properties = list2 (Qread_only, Qt);
2075 DEFVAR_LISP ("read-hide-char", Vread_hide_char,
2076 doc: /* Whether to hide input characters in noninteractive mode.
2077 It must be a character, which will be used to mask the input
2078 characters. This variable should never be set globally. */);
2079 Vread_hide_char = Qnil;
2081 defsubr (&Sactive_minibuffer_window);
2082 defsubr (&Sset_minibuffer_window);
2083 defsubr (&Sread_from_minibuffer);
2084 defsubr (&Sread_string);
2085 defsubr (&Sread_command);
2086 defsubr (&Sread_variable);
2087 defsubr (&Sinternal_complete_buffer);
2088 defsubr (&Sread_buffer);
2089 defsubr (&Sread_no_blanks_input);
2090 defsubr (&Sminibuffer_depth);
2091 defsubr (&Sminibuffer_prompt);
2093 defsubr (&Sminibufferp);
2094 defsubr (&Sminibuffer_prompt_end);
2095 defsubr (&Sminibuffer_contents);
2096 defsubr (&Sminibuffer_contents_no_properties);
2097 defsubr (&Sminibuffer_completion_contents);
2099 defsubr (&Stry_completion);
2100 defsubr (&Sall_completions);
2101 defsubr (&Stest_completion);
2102 defsubr (&Sassoc_string);
2103 defsubr (&Scompleting_read);