Auto-commit of generated files.
[emacs.git] / src / minibuf.c
blob7403fc6c32d8775af65253ced07f21ff5397c9ff
1 /* Minibuffer input and completion.
3 Copyright (C) 1985-1986, 1993-2013 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
21 #include <config.h>
22 #include <errno.h>
23 #include <stdio.h>
25 #include "lisp.h"
26 #include "commands.h"
27 #include "character.h"
28 #include "buffer.h"
29 #include "dispextern.h"
30 #include "keyboard.h"
31 #include "frame.h"
32 #include "window.h"
33 #include "syntax.h"
34 #include "intervals.h"
35 #include "keymap.h"
36 #include "termhooks.h"
38 /* List of buffers for use as minibuffers.
39 The first element of the list is used for the outermost minibuffer
40 invocation, the next element is used for a recursive minibuffer
41 invocation, etc. The list is extended at the end as deeper
42 minibuffer recursions are encountered. */
44 Lisp_Object Vminibuffer_list;
46 /* Data to remember during recursive minibuffer invocations. */
48 static Lisp_Object minibuf_save_list;
50 /* Depth in minibuffer invocations. */
52 EMACS_INT minibuf_level;
54 /* The maximum length of a minibuffer history. */
56 static Lisp_Object Qhistory_length;
58 /* Fread_minibuffer leaves the input here as a string. */
60 Lisp_Object last_minibuf_string;
62 static Lisp_Object Qminibuffer_history, Qbuffer_name_history;
64 static Lisp_Object Qread_file_name_internal;
66 /* Normal hooks for entry to and exit from minibuffer. */
68 static Lisp_Object Qminibuffer_setup_hook;
69 static Lisp_Object Qminibuffer_exit_hook;
71 Lisp_Object Qcompletion_ignore_case;
72 static Lisp_Object Qminibuffer_completion_table;
73 static Lisp_Object Qminibuffer_completion_predicate;
74 static Lisp_Object Qminibuffer_completion_confirm;
75 static Lisp_Object Qcustom_variable_p;
77 static Lisp_Object Qminibuffer_default;
79 static Lisp_Object Qcurrent_input_method, Qactivate_input_method;
81 static Lisp_Object Qcase_fold_search;
83 static Lisp_Object Qread_expression_history;
85 /* Prompt to display in front of the mini-buffer contents. */
87 static Lisp_Object minibuf_prompt;
89 /* Width of current mini-buffer prompt. Only set after display_line
90 of the line that contains the prompt. */
92 static ptrdiff_t minibuf_prompt_width;
95 /* Put minibuf on currently selected frame's minibuffer.
96 We do this whenever the user starts a new minibuffer
97 or when a minibuffer exits. */
99 static void
100 choose_minibuf_frame (void)
102 if (FRAMEP (selected_frame)
103 && FRAME_LIVE_P (XFRAME (selected_frame))
104 && !EQ (minibuf_window, XFRAME (selected_frame)->minibuffer_window))
106 struct frame *sf = XFRAME (selected_frame);
107 Lisp_Object buffer;
109 /* I don't think that any frames may validly have a null minibuffer
110 window anymore. */
111 if (NILP (sf->minibuffer_window))
112 emacs_abort ();
114 /* Under X, we come here with minibuf_window being the
115 minibuffer window of the unused termcap window created in
116 init_window_once. That window doesn't have a buffer. */
117 buffer = XWINDOW (minibuf_window)->contents;
118 if (BUFFERP (buffer))
119 /* Use set_window_buffer instead of Fset_window_buffer (see
120 discussion of bug#11984, bug#12025, bug#12026). */
121 set_window_buffer (sf->minibuffer_window, buffer, 0, 0);
122 minibuf_window = sf->minibuffer_window;
125 /* Make sure no other frame has a minibuffer as its selected window,
126 because the text would not be displayed in it, and that would be
127 confusing. Only allow the selected frame to do this,
128 and that only if the minibuffer is active. */
130 Lisp_Object tail, frame;
132 FOR_EACH_FRAME (tail, frame)
133 if (MINI_WINDOW_P (XWINDOW (FRAME_SELECTED_WINDOW (XFRAME (frame))))
134 && !(EQ (frame, selected_frame)
135 && minibuf_level > 0))
136 Fset_frame_selected_window (frame, Fframe_first_window (frame), Qnil);
140 DEFUN ("active-minibuffer-window", Factive_minibuffer_window,
141 Sactive_minibuffer_window, 0, 0, 0,
142 doc: /* Return the currently active minibuffer window, or nil if none. */)
143 (void)
145 return minibuf_level ? minibuf_window : Qnil;
148 DEFUN ("set-minibuffer-window", Fset_minibuffer_window,
149 Sset_minibuffer_window, 1, 1, 0,
150 doc: /* Specify which minibuffer window to use for the minibuffer.
151 This affects where the minibuffer is displayed if you put text in it
152 without invoking the usual minibuffer commands. */)
153 (Lisp_Object window)
155 CHECK_WINDOW (window);
156 if (! MINI_WINDOW_P (XWINDOW (window)))
157 error ("Window is not a minibuffer window");
159 minibuf_window = window;
161 return window;
165 /* Actual minibuffer invocation. */
167 static void read_minibuf_unwind (void);
168 static void run_exit_minibuf_hook (void);
171 /* Read a Lisp object from VAL and return it. If VAL is an empty
172 string, and DEFALT is a string, read from DEFALT instead of VAL. */
174 static Lisp_Object
175 string_to_object (Lisp_Object val, Lisp_Object defalt)
177 struct gcpro gcpro1, gcpro2;
178 Lisp_Object expr_and_pos;
179 ptrdiff_t pos;
181 GCPRO2 (val, defalt);
183 if (STRINGP (val) && SCHARS (val) == 0)
185 if (STRINGP (defalt))
186 val = defalt;
187 else if (CONSP (defalt) && STRINGP (XCAR (defalt)))
188 val = XCAR (defalt);
191 expr_and_pos = Fread_from_string (val, Qnil, Qnil);
192 pos = XINT (Fcdr (expr_and_pos));
193 if (pos != SCHARS (val))
195 /* Ignore trailing whitespace; any other trailing junk
196 is an error. */
197 ptrdiff_t i;
198 pos = string_char_to_byte (val, pos);
199 for (i = pos; i < SBYTES (val); i++)
201 int c = SREF (val, i);
202 if (c != ' ' && c != '\t' && c != '\n')
203 error ("Trailing garbage following expression");
207 val = Fcar (expr_and_pos);
208 RETURN_UNGCPRO (val);
212 /* Like read_minibuf but reading from stdin. This function is called
213 from read_minibuf to do the job if noninteractive. */
215 static Lisp_Object
216 read_minibuf_noninteractive (Lisp_Object map, Lisp_Object initial,
217 Lisp_Object prompt, Lisp_Object backup_n,
218 bool expflag,
219 Lisp_Object histvar, Lisp_Object histpos,
220 Lisp_Object defalt,
221 bool allow_props, bool inherit_input_method)
223 ptrdiff_t size, len;
224 char *line;
225 Lisp_Object val;
226 int c;
228 fprintf (stdout, "%s", SDATA (prompt));
229 fflush (stdout);
231 val = Qnil;
232 size = 100;
233 len = 0;
234 line = xmalloc (size);
236 while ((c = getchar ()) != '\n')
238 if (c == EOF)
240 if (errno != EINTR)
241 break;
243 else
245 if (len == size)
247 if (STRING_BYTES_BOUND / 2 < size)
248 memory_full (SIZE_MAX);
249 size *= 2;
250 line = xrealloc (line, size);
252 line[len++] = c;
256 if (len || c == '\n')
258 val = make_string (line, len);
259 xfree (line);
261 else
263 xfree (line);
264 error ("Error reading from stdin");
267 /* If Lisp form desired instead of string, parse it. */
268 if (expflag)
269 val = string_to_object (val, CONSP (defalt) ? XCAR (defalt) : defalt);
271 return val;
274 DEFUN ("minibufferp", Fminibufferp,
275 Sminibufferp, 0, 1, 0,
276 doc: /* Return t if BUFFER is a minibuffer.
277 No argument or nil as argument means use current buffer as BUFFER.
278 BUFFER can be a buffer or a buffer name. */)
279 (Lisp_Object buffer)
281 Lisp_Object tem;
283 if (NILP (buffer))
284 buffer = Fcurrent_buffer ();
285 else if (STRINGP (buffer))
286 buffer = Fget_buffer (buffer);
287 else
288 CHECK_BUFFER (buffer);
290 tem = Fmemq (buffer, Vminibuffer_list);
291 return ! NILP (tem) ? Qt : Qnil;
294 DEFUN ("minibuffer-prompt-end", Fminibuffer_prompt_end,
295 Sminibuffer_prompt_end, 0, 0, 0,
296 doc: /* Return the buffer position of the end of the minibuffer prompt.
297 Return (point-min) if current buffer is not a minibuffer. */)
298 (void)
300 /* This function is written to be most efficient when there's a prompt. */
301 Lisp_Object beg, end, tem;
302 beg = make_number (BEGV);
304 tem = Fmemq (Fcurrent_buffer (), Vminibuffer_list);
305 if (NILP (tem))
306 return beg;
308 end = Ffield_end (beg, Qnil, Qnil);
310 if (XINT (end) == ZV && NILP (Fget_char_property (beg, Qfield, Qnil)))
311 return beg;
312 else
313 return end;
316 DEFUN ("minibuffer-contents", Fminibuffer_contents,
317 Sminibuffer_contents, 0, 0, 0,
318 doc: /* Return the user input in a minibuffer as a string.
319 If the current buffer is not a minibuffer, return its entire contents. */)
320 (void)
322 ptrdiff_t prompt_end = XINT (Fminibuffer_prompt_end ());
323 return make_buffer_string (prompt_end, ZV, 1);
326 DEFUN ("minibuffer-contents-no-properties", Fminibuffer_contents_no_properties,
327 Sminibuffer_contents_no_properties, 0, 0, 0,
328 doc: /* Return the user input in a minibuffer as a string, without text-properties.
329 If the current buffer is not a minibuffer, return its entire contents. */)
330 (void)
332 ptrdiff_t prompt_end = XINT (Fminibuffer_prompt_end ());
333 return make_buffer_string (prompt_end, ZV, 0);
336 DEFUN ("minibuffer-completion-contents", Fminibuffer_completion_contents,
337 Sminibuffer_completion_contents, 0, 0, 0,
338 doc: /* Return the user input in a minibuffer before point as a string.
339 That is what completion commands operate on.
340 If the current buffer is not a minibuffer, return its entire contents. */)
341 (void)
343 ptrdiff_t prompt_end = XINT (Fminibuffer_prompt_end ());
344 if (PT < prompt_end)
345 error ("Cannot do completion in the prompt");
346 return make_buffer_string (prompt_end, PT, 1);
350 /* Read from the minibuffer using keymap MAP and initial contents INITIAL,
351 putting point minus BACKUP_N bytes from the end of INITIAL,
352 prompting with PROMPT (a string), using history list HISTVAR
353 with initial position HISTPOS. INITIAL should be a string or a
354 cons of a string and an integer. BACKUP_N should be <= 0, or
355 Qnil, which is equivalent to 0. If INITIAL is a cons, BACKUP_N is
356 ignored and replaced with an integer that puts point at one-indexed
357 position N in INITIAL, where N is the CDR of INITIAL, or at the
358 beginning of INITIAL if N <= 0.
360 Normally return the result as a string (the text that was read),
361 but if EXPFLAG, read it and return the object read.
362 If HISTVAR is given, save the value read on that history only if it doesn't
363 match the front of that history list exactly. The value is pushed onto
364 the list as the string that was read.
366 DEFALT specifies the default value for the sake of history commands.
368 If ALLOW_PROPS, do not throw away text properties.
370 if INHERIT_INPUT_METHOD, the minibuffer inherits the
371 current input method. */
373 static Lisp_Object
374 read_minibuf (Lisp_Object map, Lisp_Object initial, Lisp_Object prompt,
375 bool expflag,
376 Lisp_Object histvar, Lisp_Object histpos, Lisp_Object defalt,
377 bool allow_props, bool inherit_input_method)
379 Lisp_Object val;
380 ptrdiff_t count = SPECPDL_INDEX ();
381 Lisp_Object mini_frame, ambient_dir, minibuffer, input_method;
382 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5;
383 Lisp_Object enable_multibyte;
384 EMACS_INT pos = 0;
385 /* String to add to the history. */
386 Lisp_Object histstring;
388 Lisp_Object empty_minibuf;
389 Lisp_Object dummy, frame;
391 specbind (Qminibuffer_default, defalt);
392 specbind (intern ("inhibit-read-only"), Qnil);
394 /* If Vminibuffer_completing_file_name is `lambda' on entry, it was t
395 in previous recursive minibuffer, but was not set explicitly
396 to t for this invocation, so set it to nil in this minibuffer.
397 Save the old value now, before we change it. */
398 specbind (intern ("minibuffer-completing-file-name"), Vminibuffer_completing_file_name);
399 if (EQ (Vminibuffer_completing_file_name, Qlambda))
400 Vminibuffer_completing_file_name = Qnil;
402 #ifdef HAVE_WINDOW_SYSTEM
403 if (display_hourglass_p)
404 cancel_hourglass ();
405 #endif
407 if (!NILP (initial))
409 if (CONSP (initial))
411 Lisp_Object backup_n = XCDR (initial);
412 initial = XCAR (initial);
413 CHECK_STRING (initial);
414 if (!NILP (backup_n))
416 CHECK_NUMBER (backup_n);
417 /* Convert to distance from end of input. */
418 if (XINT (backup_n) < 1)
419 /* A number too small means the beginning of the string. */
420 pos = - SCHARS (initial);
421 else
422 pos = XINT (backup_n) - 1 - SCHARS (initial);
425 else
426 CHECK_STRING (initial);
428 val = Qnil;
429 ambient_dir = BVAR (current_buffer, directory);
430 input_method = Qnil;
431 enable_multibyte = Qnil;
433 /* Don't need to protect PROMPT, HISTVAR, and HISTPOS because we
434 store them away before we can GC. Don't need to protect
435 BACKUP_N because we use the value only if it is an integer. */
436 GCPRO5 (map, initial, val, ambient_dir, input_method);
438 if (!STRINGP (prompt))
439 prompt = empty_unibyte_string;
441 if (!enable_recursive_minibuffers
442 && minibuf_level > 0)
444 if (EQ (selected_window, minibuf_window))
445 error ("Command attempted to use minibuffer while in minibuffer");
446 else
447 /* If we're in another window, cancel the minibuffer that's active. */
448 Fthrow (Qexit,
449 build_string ("Command attempted to use minibuffer while in minibuffer"));
452 if ((noninteractive
453 /* In case we are running as a daemon, only do this before
454 detaching from the terminal. */
455 || (IS_DAEMON && (daemon_pipe[1] >= 0)))
456 && NILP (Vexecuting_kbd_macro))
458 val = read_minibuf_noninteractive (map, initial, prompt,
459 make_number (pos),
460 expflag, histvar, histpos, defalt,
461 allow_props, inherit_input_method);
462 UNGCPRO;
463 return unbind_to (count, val);
466 /* Choose the minibuffer window and frame, and take action on them. */
468 /* Prepare for restoring the current buffer since choose_minibuf_frame
469 calling Fset_frame_selected_window may change it (Bug#12766). */
470 record_unwind_protect (restore_buffer, Fcurrent_buffer ());
472 choose_minibuf_frame ();
474 record_unwind_protect_void (choose_minibuf_frame);
476 record_unwind_protect (restore_window_configuration,
477 Fcurrent_window_configuration (Qnil));
479 /* If the minibuffer window is on a different frame, save that
480 frame's configuration too. */
481 mini_frame = WINDOW_FRAME (XWINDOW (minibuf_window));
482 if (!EQ (mini_frame, selected_frame))
483 record_unwind_protect (restore_window_configuration,
484 Fcurrent_window_configuration (mini_frame));
486 /* If the minibuffer is on an iconified or invisible frame,
487 make it visible now. */
488 Fmake_frame_visible (mini_frame);
490 if (minibuffer_auto_raise)
491 Fraise_frame (mini_frame);
493 temporarily_switch_to_single_kboard (XFRAME (mini_frame));
495 /* We have to do this after saving the window configuration
496 since that is what restores the current buffer. */
498 /* Arrange to restore a number of minibuffer-related variables.
499 We could bind each variable separately, but that would use lots of
500 specpdl slots. */
501 minibuf_save_list
502 = Fcons (Voverriding_local_map,
503 Fcons (minibuf_window,
504 minibuf_save_list));
505 minibuf_save_list
506 = Fcons (minibuf_prompt,
507 Fcons (make_number (minibuf_prompt_width),
508 Fcons (Vhelp_form,
509 Fcons (Vcurrent_prefix_arg,
510 Fcons (Vminibuffer_history_position,
511 Fcons (Vminibuffer_history_variable,
512 minibuf_save_list))))));
514 record_unwind_protect_void (read_minibuf_unwind);
515 minibuf_level++;
516 /* We are exiting the minibuffer one way or the other, so run the hook.
517 It should be run before unwinding the minibuf settings. Do it
518 separately from read_minibuf_unwind because we need to make sure that
519 read_minibuf_unwind is fully executed even if exit-minibuffer-hook
520 signals an error. --Stef */
521 record_unwind_protect_void (run_exit_minibuf_hook);
523 /* Now that we can restore all those variables, start changing them. */
525 minibuf_prompt_width = 0;
526 minibuf_prompt = Fcopy_sequence (prompt);
527 Vminibuffer_history_position = histpos;
528 Vminibuffer_history_variable = histvar;
529 Vhelp_form = Vminibuffer_help_form;
530 /* If this minibuffer is reading a file name, that doesn't mean
531 recursive ones are. But we cannot set it to nil, because
532 completion code still need to know the minibuffer is completing a
533 file name. So use `lambda' as intermediate value meaning
534 "t" in this minibuffer, but "nil" in next minibuffer. */
535 if (!NILP (Vminibuffer_completing_file_name))
536 Vminibuffer_completing_file_name = Qlambda;
538 if (inherit_input_method)
540 /* `current-input-method' is buffer local. So, remember it in
541 INPUT_METHOD before changing the current buffer. */
542 input_method = Fsymbol_value (Qcurrent_input_method);
543 enable_multibyte = BVAR (current_buffer, enable_multibyte_characters);
546 /* Switch to the minibuffer. */
548 minibuffer = get_minibuffer (minibuf_level);
549 Fset_buffer (minibuffer);
551 /* Defeat (setq-default truncate-lines t), since truncated lines do
552 not work correctly in minibuffers. (Bug#5715, etc) */
553 bset_truncate_lines (current_buffer, Qnil);
555 /* If appropriate, copy enable-multibyte-characters into the minibuffer. */
556 if (inherit_input_method)
557 bset_enable_multibyte_characters (current_buffer, enable_multibyte);
559 /* The current buffer's default directory is usually the right thing
560 for our minibuffer here. However, if you're typing a command at
561 a minibuffer-only frame when minibuf_level is zero, then buf IS
562 the current_buffer, so reset_buffer leaves buf's default
563 directory unchanged. This is a bummer when you've just started
564 up Emacs and buf's default directory is Qnil. Here's a hack; can
565 you think of something better to do? Find another buffer with a
566 better directory, and use that one instead. */
567 if (STRINGP (ambient_dir))
568 bset_directory (current_buffer, ambient_dir);
569 else
571 Lisp_Object tail, buf;
573 FOR_EACH_LIVE_BUFFER (tail, buf)
574 if (STRINGP (BVAR (XBUFFER (buf), directory)))
576 bset_directory (current_buffer,
577 BVAR (XBUFFER (buf), directory));
578 break;
582 if (!EQ (mini_frame, selected_frame))
583 Fredirect_frame_focus (selected_frame, mini_frame);
585 Vminibuf_scroll_window = selected_window;
586 if (minibuf_level == 1 || !EQ (minibuf_window, selected_window))
587 minibuf_selected_window = selected_window;
589 /* Empty out the minibuffers of all frames other than the one
590 where we are going to display one now.
591 Set them to point to ` *Minibuf-0*', which is always empty. */
592 empty_minibuf = get_minibuffer (0);
594 FOR_EACH_FRAME (dummy, frame)
596 Lisp_Object root_window = Fframe_root_window (frame);
597 Lisp_Object mini_window = XWINDOW (root_window)->next;
599 if (! NILP (mini_window) && ! EQ (mini_window, minibuf_window)
600 && !NILP (Fwindow_minibuffer_p (mini_window)))
601 /* Use set_window_buffer instead of Fset_window_buffer (see
602 discussion of bug#11984, bug#12025, bug#12026). */
603 set_window_buffer (mini_window, empty_minibuf, 0, 0);
606 /* Display this minibuffer in the proper window. */
607 /* Use set_window_buffer instead of Fset_window_buffer (see
608 discussion of bug#11984, bug#12025, bug#12026). */
609 set_window_buffer (minibuf_window, Fcurrent_buffer (), 0, 0);
610 Fselect_window (minibuf_window, Qnil);
611 XWINDOW (minibuf_window)->hscroll = 0;
613 Fmake_local_variable (Qprint_escape_newlines);
614 print_escape_newlines = 1;
616 /* Erase the buffer. */
618 ptrdiff_t count1 = SPECPDL_INDEX ();
619 specbind (Qinhibit_read_only, Qt);
620 specbind (Qinhibit_modification_hooks, Qt);
621 Ferase_buffer ();
623 if (!NILP (BVAR (current_buffer, enable_multibyte_characters))
624 && ! STRING_MULTIBYTE (minibuf_prompt))
625 minibuf_prompt = Fstring_make_multibyte (minibuf_prompt);
627 /* Insert the prompt, record where it ends. */
628 Finsert (1, &minibuf_prompt);
629 if (PT > BEG)
631 Fput_text_property (make_number (BEG), make_number (PT),
632 Qfront_sticky, Qt, Qnil);
633 Fput_text_property (make_number (BEG), make_number (PT),
634 Qrear_nonsticky, Qt, Qnil);
635 Fput_text_property (make_number (BEG), make_number (PT),
636 Qfield, Qt, Qnil);
637 Fadd_text_properties (make_number (BEG), make_number (PT),
638 Vminibuffer_prompt_properties, Qnil);
640 unbind_to (count1, Qnil);
643 minibuf_prompt_width = current_column ();
645 /* Put in the initial input. */
646 if (!NILP (initial))
648 Finsert (1, &initial);
649 Fforward_char (make_number (pos));
652 clear_message (1, 1);
653 bset_keymap (current_buffer, map);
655 /* Turn on an input method stored in INPUT_METHOD if any. */
656 if (STRINGP (input_method) && !NILP (Ffboundp (Qactivate_input_method)))
657 call1 (Qactivate_input_method, input_method);
659 Frun_hooks (1, &Qminibuffer_setup_hook);
661 /* Don't allow the user to undo past this point. */
662 bset_undo_list (current_buffer, Qnil);
664 recursive_edit_1 ();
666 /* If cursor is on the minibuffer line,
667 show the user we have exited by putting it in column 0. */
668 if (XWINDOW (minibuf_window)->cursor.vpos >= 0
669 && !noninteractive)
671 XWINDOW (minibuf_window)->cursor.hpos = 0;
672 XWINDOW (minibuf_window)->cursor.x = 0;
673 XWINDOW (minibuf_window)->must_be_updated_p = 1;
674 update_frame (XFRAME (selected_frame), 1, 1);
676 struct frame *f = XFRAME (XWINDOW (minibuf_window)->frame);
677 struct redisplay_interface *rif = FRAME_RIF (f);
678 if (rif && rif->flush_display)
679 rif->flush_display (f);
683 /* Make minibuffer contents into a string. */
684 Fset_buffer (minibuffer);
685 if (allow_props)
686 val = Fminibuffer_contents ();
687 else
688 val = Fminibuffer_contents_no_properties ();
690 /* VAL is the string of minibuffer text. */
692 last_minibuf_string = val;
694 /* Choose the string to add to the history. */
695 if (SCHARS (val) != 0)
696 histstring = val;
697 else if (STRINGP (defalt))
698 histstring = defalt;
699 else if (CONSP (defalt) && STRINGP (XCAR (defalt)))
700 histstring = XCAR (defalt);
701 else
702 histstring = Qnil;
704 /* Add the value to the appropriate history list, if any. */
705 if (!NILP (Vhistory_add_new_input)
706 && SYMBOLP (Vminibuffer_history_variable)
707 && !NILP (histstring))
709 /* If the caller wanted to save the value read on a history list,
710 then do so if the value is not already the front of the list. */
711 Lisp_Object histval;
713 /* If variable is unbound, make it nil. */
715 histval = find_symbol_value (Vminibuffer_history_variable);
716 if (EQ (histval, Qunbound))
717 Fset (Vminibuffer_history_variable, Qnil);
719 /* The value of the history variable must be a cons or nil. Other
720 values are unacceptable. We silently ignore these values. */
722 if (NILP (histval)
723 || (CONSP (histval)
724 /* Don't duplicate the most recent entry in the history. */
725 && (NILP (Fequal (histstring, Fcar (histval))))))
727 Lisp_Object length;
729 if (history_delete_duplicates) Fdelete (histstring, histval);
730 histval = Fcons (histstring, histval);
731 Fset (Vminibuffer_history_variable, histval);
733 /* Truncate if requested. */
734 length = Fget (Vminibuffer_history_variable, Qhistory_length);
735 if (NILP (length)) length = Vhistory_length;
736 if (INTEGERP (length))
738 if (XINT (length) <= 0)
739 Fset (Vminibuffer_history_variable, Qnil);
740 else
742 Lisp_Object temp;
744 temp = Fnthcdr (Fsub1 (length), histval);
745 if (CONSP (temp)) Fsetcdr (temp, Qnil);
751 /* If Lisp form desired instead of string, parse it. */
752 if (expflag)
753 val = string_to_object (val, defalt);
755 /* The appropriate frame will get selected
756 in set-window-configuration. */
757 UNGCPRO;
758 return unbind_to (count, val);
761 /* Return a buffer to be used as the minibuffer at depth `depth'.
762 depth = 0 is the lowest allowed argument, and that is the value
763 used for nonrecursive minibuffer invocations. */
765 Lisp_Object
766 get_minibuffer (EMACS_INT depth)
768 Lisp_Object tail, num, buf;
769 char name[sizeof " *Minibuf-*" + INT_STRLEN_BOUND (EMACS_INT)];
771 XSETFASTINT (num, depth);
772 tail = Fnthcdr (num, Vminibuffer_list);
773 if (NILP (tail))
775 tail = list1 (Qnil);
776 Vminibuffer_list = nconc2 (Vminibuffer_list, tail);
778 buf = Fcar (tail);
779 if (NILP (buf) || !BUFFER_LIVE_P (XBUFFER (buf)))
781 buf = Fget_buffer_create
782 (make_formatted_string (name, " *Minibuf-%"pI"d*", depth));
784 /* Although the buffer's name starts with a space, undo should be
785 enabled in it. */
786 Fbuffer_enable_undo (buf);
788 XSETCAR (tail, buf);
790 else
792 ptrdiff_t count = SPECPDL_INDEX ();
793 /* We have to empty both overlay lists. Otherwise we end
794 up with overlays that think they belong to this buffer
795 while the buffer doesn't know about them any more. */
796 delete_all_overlays (XBUFFER (buf));
797 reset_buffer (XBUFFER (buf));
798 record_unwind_current_buffer ();
799 Fset_buffer (buf);
800 if (!NILP (Ffboundp (intern ("minibuffer-inactive-mode"))))
801 call0 (intern ("minibuffer-inactive-mode"));
802 else
803 Fkill_all_local_variables ();
804 unbind_to (count, Qnil);
807 return buf;
810 static void
811 run_exit_minibuf_hook (void)
813 safe_run_hooks (Qminibuffer_exit_hook);
816 /* This function is called on exiting minibuffer, whether normally or
817 not, and it restores the current window, buffer, etc. */
819 static void
820 read_minibuf_unwind (void)
822 Lisp_Object old_deactivate_mark;
823 Lisp_Object window;
825 /* If this was a recursive minibuffer,
826 tie the minibuffer window back to the outer level minibuffer buffer. */
827 minibuf_level--;
829 window = minibuf_window;
830 /* To keep things predictable, in case it matters, let's be in the
831 minibuffer when we reset the relevant variables. */
832 Fset_buffer (XWINDOW (window)->contents);
834 /* Restore prompt, etc, from outer minibuffer level. */
835 minibuf_prompt = Fcar (minibuf_save_list);
836 minibuf_save_list = Fcdr (minibuf_save_list);
837 minibuf_prompt_width = XFASTINT (Fcar (minibuf_save_list));
838 minibuf_save_list = Fcdr (minibuf_save_list);
839 Vhelp_form = Fcar (minibuf_save_list);
840 minibuf_save_list = Fcdr (minibuf_save_list);
841 Vcurrent_prefix_arg = Fcar (minibuf_save_list);
842 minibuf_save_list = Fcdr (minibuf_save_list);
843 Vminibuffer_history_position = Fcar (minibuf_save_list);
844 minibuf_save_list = Fcdr (minibuf_save_list);
845 Vminibuffer_history_variable = Fcar (minibuf_save_list);
846 minibuf_save_list = Fcdr (minibuf_save_list);
847 Voverriding_local_map = Fcar (minibuf_save_list);
848 minibuf_save_list = Fcdr (minibuf_save_list);
849 #if 0
850 temp = Fcar (minibuf_save_list);
851 if (FRAME_LIVE_P (XFRAME (WINDOW_FRAME (XWINDOW (temp)))))
852 minibuf_window = temp;
853 #endif
854 minibuf_save_list = Fcdr (minibuf_save_list);
856 /* Erase the minibuffer we were using at this level. */
858 ptrdiff_t count = SPECPDL_INDEX ();
859 /* Prevent error in erase-buffer. */
860 specbind (Qinhibit_read_only, Qt);
861 specbind (Qinhibit_modification_hooks, Qt);
862 old_deactivate_mark = Vdeactivate_mark;
863 Ferase_buffer ();
864 Vdeactivate_mark = old_deactivate_mark;
865 unbind_to (count, Qnil);
868 /* When we get to the outmost level, make sure we resize the
869 mini-window back to its normal size. */
870 if (minibuf_level == 0)
871 resize_mini_window (XWINDOW (window), 0);
873 /* Enforce full redisplay. FIXME: make it more selective. */
874 windows_or_buffers_changed++;
876 /* In case the previous minibuffer displayed in this miniwindow is
877 dead, we may keep displaying this buffer (tho it's inactive), so reset it,
878 to make sure we don't leave around bindings and stuff which only
879 made sense during the read_minibuf invocation. */
880 call0 (intern ("minibuffer-inactive-mode"));
884 DEFUN ("read-from-minibuffer", Fread_from_minibuffer,
885 Sread_from_minibuffer, 1, 7, 0,
886 doc: /* Read a string from the minibuffer, prompting with string PROMPT.
887 The optional second arg INITIAL-CONTENTS is an obsolete alternative to
888 DEFAULT-VALUE. It normally should be nil in new code, except when
889 HIST is a cons. It is discussed in more detail below.
891 Third arg KEYMAP is a keymap to use whilst reading;
892 if omitted or nil, the default is `minibuffer-local-map'.
894 If fourth arg READ is non-nil, interpret the result as a Lisp object
895 and return that object:
896 in other words, do `(car (read-from-string INPUT-STRING))'
898 Fifth arg HIST, if non-nil, specifies a history list and optionally
899 the initial position in the list. It can be a symbol, which is the
900 history list variable to use, or a cons cell (HISTVAR . HISTPOS).
901 In that case, HISTVAR is the history list variable to use, and
902 HISTPOS is the initial position for use by the minibuffer history
903 commands. For consistency, you should also specify that element of
904 the history as the value of INITIAL-CONTENTS. Positions are counted
905 starting from 1 at the beginning of the list.
907 Sixth arg DEFAULT-VALUE, if non-nil, should be a string, which is used
908 as the default to `read' if READ is non-nil and the user enters
909 empty input. But if READ is nil, this function does _not_ return
910 DEFAULT-VALUE for empty input! Instead, it returns the empty string.
912 Whatever the value of READ, DEFAULT-VALUE is made available via the
913 minibuffer history commands. DEFAULT-VALUE can also be a list of
914 strings, in which case all the strings are available in the history,
915 and the first string is the default to `read' if READ is non-nil.
917 Seventh arg INHERIT-INPUT-METHOD, if non-nil, means the minibuffer inherits
918 the current input method and the setting of `enable-multibyte-characters'.
920 If the variable `minibuffer-allow-text-properties' is non-nil,
921 then the string which is returned includes whatever text properties
922 were present in the minibuffer. Otherwise the value has no text properties.
924 The remainder of this documentation string describes the
925 INITIAL-CONTENTS argument in more detail. It is only relevant when
926 studying existing code, or when HIST is a cons. If non-nil,
927 INITIAL-CONTENTS is a string to be inserted into the minibuffer before
928 reading input. Normally, point is put at the end of that string.
929 However, if INITIAL-CONTENTS is \(STRING . POSITION), the initial
930 input is STRING, but point is placed at _one-indexed_ position
931 POSITION in the minibuffer. Any integer value less than or equal to
932 one puts point at the beginning of the string. *Note* that this
933 behavior differs from the way such arguments are used in `completing-read'
934 and some related functions, which use zero-indexing for POSITION. */)
935 (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)
937 Lisp_Object histvar, histpos, val;
938 struct gcpro gcpro1;
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 GCPRO1 (default_value);
962 val = read_minibuf (keymap, initial_contents, prompt,
963 !NILP (read),
964 histvar, histpos, default_value,
965 minibuffer_allow_text_properties,
966 !NILP (inherit_input_method));
967 UNGCPRO;
968 return val;
971 /* Functions that use the minibuffer to read various things. */
973 DEFUN ("read-string", Fread_string, Sread_string, 1, 5, 0,
974 doc: /* Read a string from the minibuffer, prompting with string PROMPT.
975 If non-nil, second arg INITIAL-INPUT is a string to insert before reading.
976 This argument has been superseded by DEFAULT-VALUE and should normally
977 be nil in new code. It behaves as in `read-from-minibuffer'. See the
978 documentation string of that function for details.
979 The third arg HISTORY, if non-nil, specifies a history list
980 and optionally the initial position in the list.
981 See `read-from-minibuffer' for details of HISTORY argument.
982 Fourth arg DEFAULT-VALUE is the default value or the list of default values.
983 If non-nil, it is used for history commands, and as the value (or the first
984 element of the list of default values) to return if the user enters the
985 empty string.
986 Fifth arg INHERIT-INPUT-METHOD, if non-nil, means the minibuffer inherits
987 the current input method and the setting of `enable-multibyte-characters'. */)
988 (Lisp_Object prompt, Lisp_Object initial_input, Lisp_Object history, Lisp_Object default_value, Lisp_Object inherit_input_method)
990 Lisp_Object val;
991 ptrdiff_t count = SPECPDL_INDEX ();
993 /* Just in case we're in a recursive minibuffer, make it clear that the
994 previous minibuffer's completion table does not apply to the new
995 minibuffer.
996 FIXME: `minibuffer-completion-table' should be buffer-local instead. */
997 specbind (Qminibuffer_completion_table, Qnil);
999 val = Fread_from_minibuffer (prompt, initial_input, Qnil,
1000 Qnil, history, default_value,
1001 inherit_input_method);
1002 if (STRINGP (val) && SCHARS (val) == 0 && ! NILP (default_value))
1003 val = CONSP (default_value) ? XCAR (default_value) : default_value;
1004 return unbind_to (count, val);
1007 DEFUN ("read-no-blanks-input", Fread_no_blanks_input, Sread_no_blanks_input, 1, 3, 0,
1008 doc: /* Read a string from the terminal, not allowing blanks.
1009 Prompt with PROMPT. Whitespace terminates the input. If INITIAL is
1010 non-nil, it should be a string, which is used as initial input, with
1011 point positioned at the end, so that SPACE will accept the input.
1012 \(Actually, INITIAL can also be a cons of a string and an integer.
1013 Such values are treated as in `read-from-minibuffer', but are normally
1014 not useful in this function.)
1015 Third arg INHERIT-INPUT-METHOD, if non-nil, means the minibuffer inherits
1016 the current input method and the setting of`enable-multibyte-characters'. */)
1017 (Lisp_Object prompt, Lisp_Object initial, Lisp_Object inherit_input_method)
1019 CHECK_STRING (prompt);
1020 return read_minibuf (Vminibuffer_local_ns_map, initial, prompt,
1021 0, Qminibuffer_history, make_number (0), Qnil, 0,
1022 !NILP (inherit_input_method));
1025 DEFUN ("read-command", Fread_command, Sread_command, 1, 2, 0,
1026 doc: /* Read the name of a command and return as a symbol.
1027 Prompt with PROMPT. By default, return DEFAULT-VALUE or its first element
1028 if it is a list. */)
1029 (Lisp_Object prompt, Lisp_Object default_value)
1031 Lisp_Object name, default_string;
1033 if (NILP (default_value))
1034 default_string = Qnil;
1035 else if (SYMBOLP (default_value))
1036 default_string = SYMBOL_NAME (default_value);
1037 else
1038 default_string = default_value;
1040 name = Fcompleting_read (prompt, Vobarray, Qcommandp, Qt,
1041 Qnil, Qnil, default_string, Qnil);
1042 if (NILP (name))
1043 return name;
1044 return Fintern (name, Qnil);
1047 #ifdef NOTDEF
1048 DEFUN ("read-function", Fread_function, Sread_function, 1, 1, 0,
1049 doc: /* One arg PROMPT, a string. Read the name of a function and return as a symbol.
1050 Prompt with PROMPT. */)
1051 (Lisp_Object prompt)
1053 return Fintern (Fcompleting_read (prompt, Vobarray, Qfboundp, Qt, Qnil, Qnil, Qnil, Qnil),
1054 Qnil);
1056 #endif /* NOTDEF */
1058 DEFUN ("read-variable", Fread_variable, Sread_variable, 1, 2, 0,
1059 doc: /* Read the name of a user option and return it as a symbol.
1060 Prompt with PROMPT. By default, return DEFAULT-VALUE or its first element
1061 if it is a list.
1062 A user option, or customizable variable, is one for which
1063 `custom-variable-p' returns non-nil. */)
1064 (Lisp_Object prompt, Lisp_Object default_value)
1066 Lisp_Object name, default_string;
1068 if (NILP (default_value))
1069 default_string = Qnil;
1070 else if (SYMBOLP (default_value))
1071 default_string = SYMBOL_NAME (default_value);
1072 else
1073 default_string = default_value;
1075 name = Fcompleting_read (prompt, Vobarray,
1076 Qcustom_variable_p, Qt,
1077 Qnil, Qnil, default_string, Qnil);
1078 if (NILP (name))
1079 return name;
1080 return Fintern (name, Qnil);
1083 DEFUN ("read-buffer", Fread_buffer, Sread_buffer, 1, 3, 0,
1084 doc: /* Read the name of a buffer and return as a string.
1085 Prompt with PROMPT.
1086 Optional second arg DEF is value to return if user enters an empty line.
1087 If DEF is a list of default values, return its first element.
1088 Optional third arg REQUIRE-MATCH determines whether non-existing
1089 buffer names are allowed. It has the same meaning as the
1090 REQUIRE-MATCH argument of `completing-read'.
1091 The argument PROMPT should be a string ending with a colon and a space.
1092 If `read-buffer-completion-ignore-case' is non-nil, completion ignores
1093 case while reading the buffer name.
1094 If `read-buffer-function' is non-nil, this works by calling it as a
1095 function, instead of the usual behavior. */)
1096 (Lisp_Object prompt, Lisp_Object def, Lisp_Object require_match)
1098 Lisp_Object args[4], result;
1099 char *s;
1100 ptrdiff_t len;
1101 ptrdiff_t count = SPECPDL_INDEX ();
1103 if (BUFFERP (def))
1104 def = BVAR (XBUFFER (def), name);
1106 specbind (Qcompletion_ignore_case,
1107 read_buffer_completion_ignore_case ? Qt : Qnil);
1109 if (NILP (Vread_buffer_function))
1111 if (!NILP (def))
1113 /* A default value was provided: we must change PROMPT,
1114 editing the default value in before the colon. To achieve
1115 this, we replace PROMPT with a substring that doesn't
1116 contain the terminal space and colon (if present). They
1117 are then added back using Fformat. */
1119 if (STRINGP (prompt))
1121 s = SSDATA (prompt);
1122 len = SBYTES (prompt);
1123 if (len >= 2 && s[len - 2] == ':' && s[len - 1] == ' ')
1124 len = len - 2;
1125 else if (len >= 1 && (s[len - 1] == ':' || s[len - 1] == ' '))
1126 len--;
1128 prompt = make_specified_string (s, -1, len,
1129 STRING_MULTIBYTE (prompt));
1132 args[0] = build_string ("%s (default %s): ");
1133 args[1] = prompt;
1134 args[2] = CONSP (def) ? XCAR (def) : def;
1135 prompt = Fformat (3, args);
1138 result = Fcompleting_read (prompt, intern ("internal-complete-buffer"),
1139 Qnil, require_match, Qnil,
1140 Qbuffer_name_history, def, Qnil);
1142 else
1144 args[0] = Vread_buffer_function;
1145 args[1] = prompt;
1146 args[2] = def;
1147 args[3] = require_match;
1148 result = Ffuncall (4, args);
1150 return unbind_to (count, result);
1153 static Lisp_Object
1154 minibuf_conform_representation (Lisp_Object string, Lisp_Object basis)
1156 if (STRING_MULTIBYTE (string) == STRING_MULTIBYTE (basis))
1157 return string;
1159 if (STRING_MULTIBYTE (string))
1160 return Fstring_make_unibyte (string);
1161 else
1162 return Fstring_make_multibyte (string);
1165 DEFUN ("try-completion", Ftry_completion, Stry_completion, 2, 3, 0,
1166 doc: /* Return common substring of all completions of STRING in COLLECTION.
1167 Test each possible completion specified by COLLECTION
1168 to see if it begins with STRING. The possible completions may be
1169 strings or symbols. Symbols are converted to strings before testing,
1170 see `symbol-name'.
1171 All that match STRING are compared together; the longest initial sequence
1172 common to all these matches is the return value.
1173 If there is no match at all, the return value is nil.
1174 For a unique match which is exact, the return value is t.
1176 If COLLECTION is an alist, the keys (cars of elements) are the
1177 possible completions. If an element is not a cons cell, then the
1178 element itself is the possible completion.
1179 If COLLECTION is a hash-table, all the keys that are strings or symbols
1180 are the possible completions.
1181 If COLLECTION is an obarray, the names of all symbols in the obarray
1182 are the possible completions.
1184 COLLECTION can also be a function to do the completion itself.
1185 It receives three arguments: the values STRING, PREDICATE and nil.
1186 Whatever it returns becomes the value of `try-completion'.
1188 If optional third argument PREDICATE is non-nil,
1189 it is used to test each possible match.
1190 The match is a candidate only if PREDICATE returns non-nil.
1191 The argument given to PREDICATE is the alist element
1192 or the symbol from the obarray. If COLLECTION is a hash-table,
1193 predicate is called with two arguments: the key and the value.
1194 Additionally to this predicate, `completion-regexp-list'
1195 is used to further constrain the set of candidates. */)
1196 (Lisp_Object string, Lisp_Object collection, Lisp_Object predicate)
1198 Lisp_Object bestmatch, tail, elt, eltstring;
1199 /* Size in bytes of BESTMATCH. */
1200 ptrdiff_t bestmatchsize = 0;
1201 /* These are in bytes, too. */
1202 ptrdiff_t compare, matchsize;
1203 enum { function_table, list_table, obarray_table, hash_table}
1204 type = (HASH_TABLE_P (collection) ? hash_table
1205 : VECTORP (collection) ? obarray_table
1206 : ((NILP (collection)
1207 || (CONSP (collection)
1208 && (!SYMBOLP (XCAR (collection))
1209 || NILP (XCAR (collection)))))
1210 ? list_table : function_table));
1211 ptrdiff_t idx = 0, obsize = 0;
1212 int matchcount = 0;
1213 ptrdiff_t bindcount = -1;
1214 Lisp_Object bucket, zero, end, tem;
1215 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
1217 CHECK_STRING (string);
1218 if (type == function_table)
1219 return call3 (collection, string, predicate, Qnil);
1221 bestmatch = bucket = Qnil;
1222 zero = make_number (0);
1224 /* If COLLECTION is not a list, set TAIL just for gc pro. */
1225 tail = collection;
1226 if (type == obarray_table)
1228 collection = check_obarray (collection);
1229 obsize = ASIZE (collection);
1230 bucket = AREF (collection, idx);
1233 while (1)
1235 /* Get the next element of the alist, obarray, or hash-table. */
1236 /* Exit the loop if the elements are all used up. */
1237 /* elt gets the alist element or symbol.
1238 eltstring gets the name to check as a completion. */
1240 if (type == list_table)
1242 if (!CONSP (tail))
1243 break;
1244 elt = XCAR (tail);
1245 eltstring = CONSP (elt) ? XCAR (elt) : elt;
1246 tail = XCDR (tail);
1248 else if (type == obarray_table)
1250 if (!EQ (bucket, zero))
1252 if (!SYMBOLP (bucket))
1253 error ("Bad data in guts of obarray");
1254 elt = bucket;
1255 eltstring = elt;
1256 if (XSYMBOL (bucket)->next)
1257 XSETSYMBOL (bucket, XSYMBOL (bucket)->next);
1258 else
1259 XSETFASTINT (bucket, 0);
1261 else if (++idx >= obsize)
1262 break;
1263 else
1265 bucket = AREF (collection, idx);
1266 continue;
1269 else /* if (type == hash_table) */
1271 while (idx < HASH_TABLE_SIZE (XHASH_TABLE (collection))
1272 && NILP (HASH_HASH (XHASH_TABLE (collection), idx)))
1273 idx++;
1274 if (idx >= HASH_TABLE_SIZE (XHASH_TABLE (collection)))
1275 break;
1276 else
1277 elt = eltstring = HASH_KEY (XHASH_TABLE (collection), idx++);
1280 /* Is this element a possible completion? */
1282 if (SYMBOLP (eltstring))
1283 eltstring = Fsymbol_name (eltstring);
1285 if (STRINGP (eltstring)
1286 && SCHARS (string) <= SCHARS (eltstring)
1287 && (tem = Fcompare_strings (eltstring, zero,
1288 make_number (SCHARS (string)),
1289 string, zero, Qnil,
1290 completion_ignore_case ? Qt : Qnil),
1291 EQ (Qt, tem)))
1293 /* Yes. */
1294 Lisp_Object regexps;
1296 /* Ignore this element if it fails to match all the regexps. */
1298 for (regexps = Vcompletion_regexp_list; CONSP (regexps);
1299 regexps = XCDR (regexps))
1301 if (bindcount < 0) {
1302 bindcount = SPECPDL_INDEX ();
1303 specbind (Qcase_fold_search,
1304 completion_ignore_case ? Qt : Qnil);
1306 tem = Fstring_match (XCAR (regexps), eltstring, zero);
1307 if (NILP (tem))
1308 break;
1310 if (CONSP (regexps))
1311 continue;
1314 /* Ignore this element if there is a predicate
1315 and the predicate doesn't like it. */
1317 if (!NILP (predicate))
1319 if (EQ (predicate, Qcommandp))
1320 tem = Fcommandp (elt, Qnil);
1321 else
1323 if (bindcount >= 0)
1325 unbind_to (bindcount, Qnil);
1326 bindcount = -1;
1328 GCPRO4 (tail, string, eltstring, bestmatch);
1329 tem = (type == hash_table
1330 ? call2 (predicate, elt,
1331 HASH_VALUE (XHASH_TABLE (collection),
1332 idx - 1))
1333 : call1 (predicate, elt));
1334 UNGCPRO;
1336 if (NILP (tem)) continue;
1339 /* Update computation of how much all possible completions match */
1341 if (NILP (bestmatch))
1343 matchcount = 1;
1344 bestmatch = eltstring;
1345 bestmatchsize = SCHARS (eltstring);
1347 else
1349 compare = min (bestmatchsize, SCHARS (eltstring));
1350 tem = Fcompare_strings (bestmatch, zero,
1351 make_number (compare),
1352 eltstring, zero,
1353 make_number (compare),
1354 completion_ignore_case ? Qt : Qnil);
1355 matchsize = EQ (tem, Qt) ? compare : eabs (XINT (tem)) - 1;
1357 if (completion_ignore_case)
1359 /* If this is an exact match except for case,
1360 use it as the best match rather than one that is not an
1361 exact match. This way, we get the case pattern
1362 of the actual match. */
1363 if ((matchsize == SCHARS (eltstring)
1364 && matchsize < SCHARS (bestmatch))
1366 /* If there is more than one exact match ignoring case,
1367 and one of them is exact including case,
1368 prefer that one. */
1369 /* If there is no exact match ignoring case,
1370 prefer a match that does not change the case
1371 of the input. */
1372 ((matchsize == SCHARS (eltstring))
1374 (matchsize == SCHARS (bestmatch))
1375 && (tem = Fcompare_strings (eltstring, zero,
1376 make_number (SCHARS (string)),
1377 string, zero,
1378 Qnil,
1379 Qnil),
1380 EQ (Qt, tem))
1381 && (tem = Fcompare_strings (bestmatch, zero,
1382 make_number (SCHARS (string)),
1383 string, zero,
1384 Qnil,
1385 Qnil),
1386 ! EQ (Qt, tem))))
1387 bestmatch = eltstring;
1389 if (bestmatchsize != SCHARS (eltstring)
1390 || bestmatchsize != matchsize)
1391 /* Don't count the same string multiple times. */
1392 matchcount += matchcount <= 1;
1393 bestmatchsize = matchsize;
1394 if (matchsize <= SCHARS (string)
1395 /* If completion-ignore-case is non-nil, don't
1396 short-circuit because we want to find the best
1397 possible match *including* case differences. */
1398 && !completion_ignore_case
1399 && matchcount > 1)
1400 /* No need to look any further. */
1401 break;
1406 if (bindcount >= 0) {
1407 unbind_to (bindcount, Qnil);
1408 bindcount = -1;
1411 if (NILP (bestmatch))
1412 return Qnil; /* No completions found. */
1413 /* If we are ignoring case, and there is no exact match,
1414 and no additional text was supplied,
1415 don't change the case of what the user typed. */
1416 if (completion_ignore_case && bestmatchsize == SCHARS (string)
1417 && SCHARS (bestmatch) > bestmatchsize)
1418 return minibuf_conform_representation (string, bestmatch);
1420 /* Return t if the supplied string is an exact match (counting case);
1421 it does not require any change to be made. */
1422 if (matchcount == 1 && !NILP (Fequal (bestmatch, string)))
1423 return Qt;
1425 XSETFASTINT (zero, 0); /* Else extract the part in which */
1426 XSETFASTINT (end, bestmatchsize); /* all completions agree. */
1427 return Fsubstring (bestmatch, zero, end);
1430 DEFUN ("all-completions", Fall_completions, Sall_completions, 2, 4, 0,
1431 doc: /* Search for partial matches to STRING in COLLECTION.
1432 Test each of the possible completions specified by COLLECTION
1433 to see if it begins with STRING. The possible completions may be
1434 strings or symbols. Symbols are converted to strings before testing,
1435 see `symbol-name'.
1436 The value is a list of all the possible completions that match STRING.
1438 If COLLECTION is an alist, the keys (cars of elements) are the
1439 possible completions. If an element is not a cons cell, then the
1440 element itself is the possible completion.
1441 If COLLECTION is a hash-table, all the keys that are strings or symbols
1442 are the possible completions.
1443 If COLLECTION is an obarray, the names of all symbols in the obarray
1444 are the possible completions.
1446 COLLECTION can also be a function to do the completion itself.
1447 It receives three arguments: the values STRING, PREDICATE and t.
1448 Whatever it returns becomes the value of `all-completions'.
1450 If optional third argument PREDICATE is non-nil,
1451 it is used to test each possible match.
1452 The match is a candidate only if PREDICATE returns non-nil.
1453 The argument given to PREDICATE is the alist element
1454 or the symbol from the obarray. If COLLECTION is a hash-table,
1455 predicate is called with two arguments: the key and the value.
1456 Additionally to this predicate, `completion-regexp-list'
1457 is used to further constrain the set of candidates.
1459 An obsolete optional fourth argument HIDE-SPACES is still accepted for
1460 backward compatibility. If non-nil, strings in COLLECTION that start
1461 with a space are ignored unless STRING itself starts with a space. */)
1462 (Lisp_Object string, Lisp_Object collection, Lisp_Object predicate, Lisp_Object hide_spaces)
1464 Lisp_Object tail, elt, eltstring;
1465 Lisp_Object allmatches;
1466 int type = HASH_TABLE_P (collection) ? 3
1467 : VECTORP (collection) ? 2
1468 : NILP (collection) || (CONSP (collection)
1469 && (!SYMBOLP (XCAR (collection))
1470 || NILP (XCAR (collection))));
1471 ptrdiff_t idx = 0, obsize = 0;
1472 ptrdiff_t bindcount = -1;
1473 Lisp_Object bucket, tem, zero;
1474 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
1476 CHECK_STRING (string);
1477 if (type == 0)
1478 return call3 (collection, string, predicate, Qt);
1479 allmatches = bucket = Qnil;
1480 zero = make_number (0);
1482 /* If COLLECTION is not a list, set TAIL just for gc pro. */
1483 tail = collection;
1484 if (type == 2)
1486 collection = check_obarray (collection);
1487 obsize = ASIZE (collection);
1488 bucket = AREF (collection, idx);
1491 while (1)
1493 /* Get the next element of the alist, obarray, or hash-table. */
1494 /* Exit the loop if the elements are all used up. */
1495 /* elt gets the alist element or symbol.
1496 eltstring gets the name to check as a completion. */
1498 if (type == 1)
1500 if (!CONSP (tail))
1501 break;
1502 elt = XCAR (tail);
1503 eltstring = CONSP (elt) ? XCAR (elt) : elt;
1504 tail = XCDR (tail);
1506 else if (type == 2)
1508 if (!EQ (bucket, zero))
1510 if (!SYMBOLP (bucket))
1511 error ("Bad data in guts of obarray");
1512 elt = bucket;
1513 eltstring = elt;
1514 if (XSYMBOL (bucket)->next)
1515 XSETSYMBOL (bucket, XSYMBOL (bucket)->next);
1516 else
1517 XSETFASTINT (bucket, 0);
1519 else if (++idx >= obsize)
1520 break;
1521 else
1523 bucket = AREF (collection, idx);
1524 continue;
1527 else /* if (type == 3) */
1529 while (idx < HASH_TABLE_SIZE (XHASH_TABLE (collection))
1530 && NILP (HASH_HASH (XHASH_TABLE (collection), idx)))
1531 idx++;
1532 if (idx >= HASH_TABLE_SIZE (XHASH_TABLE (collection)))
1533 break;
1534 else
1535 elt = eltstring = HASH_KEY (XHASH_TABLE (collection), idx++);
1538 /* Is this element a possible completion? */
1540 if (SYMBOLP (eltstring))
1541 eltstring = Fsymbol_name (eltstring);
1543 if (STRINGP (eltstring)
1544 && SCHARS (string) <= SCHARS (eltstring)
1545 /* If HIDE_SPACES, reject alternatives that start with space
1546 unless the input starts with space. */
1547 && (NILP (hide_spaces)
1548 || (SBYTES (string) > 0
1549 && SREF (string, 0) == ' ')
1550 || SREF (eltstring, 0) != ' ')
1551 && (tem = Fcompare_strings (eltstring, zero,
1552 make_number (SCHARS (string)),
1553 string, zero,
1554 make_number (SCHARS (string)),
1555 completion_ignore_case ? Qt : Qnil),
1556 EQ (Qt, tem)))
1558 /* Yes. */
1559 Lisp_Object regexps;
1561 /* Ignore this element if it fails to match all the regexps. */
1563 for (regexps = Vcompletion_regexp_list; CONSP (regexps);
1564 regexps = XCDR (regexps))
1566 if (bindcount < 0) {
1567 bindcount = SPECPDL_INDEX ();
1568 specbind (Qcase_fold_search,
1569 completion_ignore_case ? Qt : Qnil);
1571 tem = Fstring_match (XCAR (regexps), eltstring, zero);
1572 if (NILP (tem))
1573 break;
1575 if (CONSP (regexps))
1576 continue;
1579 /* Ignore this element if there is a predicate
1580 and the predicate doesn't like it. */
1582 if (!NILP (predicate))
1584 if (EQ (predicate, Qcommandp))
1585 tem = Fcommandp (elt, Qnil);
1586 else
1588 if (bindcount >= 0) {
1589 unbind_to (bindcount, Qnil);
1590 bindcount = -1;
1592 GCPRO4 (tail, eltstring, allmatches, string);
1593 tem = type == 3
1594 ? call2 (predicate, elt,
1595 HASH_VALUE (XHASH_TABLE (collection), idx - 1))
1596 : call1 (predicate, elt);
1597 UNGCPRO;
1599 if (NILP (tem)) continue;
1601 /* Ok => put it on the list. */
1602 allmatches = Fcons (eltstring, allmatches);
1606 if (bindcount >= 0) {
1607 unbind_to (bindcount, Qnil);
1608 bindcount = -1;
1611 return Fnreverse (allmatches);
1614 DEFUN ("completing-read", Fcompleting_read, Scompleting_read, 2, 8, 0,
1615 doc: /* Read a string in the minibuffer, with completion.
1616 PROMPT is a string to prompt with; normally it ends in a colon and a space.
1617 COLLECTION can be a list of strings, an alist, an obarray or a hash table.
1618 COLLECTION can also be a function to do the completion itself.
1619 PREDICATE limits completion to a subset of COLLECTION.
1620 See `try-completion' and `all-completions' for more details
1621 on completion, COLLECTION, and PREDICATE.
1623 REQUIRE-MATCH can take the following values:
1624 - t means that the user is not allowed to exit unless
1625 the input is (or completes to) an element of COLLECTION or is null.
1626 - nil means that the user can exit with any input.
1627 - `confirm' means that the user can exit with any input, but she needs
1628 to confirm her choice if the input is not an element of COLLECTION.
1629 - `confirm-after-completion' means that the user can exit with any
1630 input, but she needs to confirm her choice if she called
1631 `minibuffer-complete' right before `minibuffer-complete-and-exit'
1632 and the input is not an element of COLLECTION.
1633 - anything else behaves like t except that typing RET does not exit if it
1634 does non-null completion.
1636 If the input is null, `completing-read' returns DEF, or the first element
1637 of the list of default values, or an empty string if DEF is nil,
1638 regardless of the value of REQUIRE-MATCH.
1640 If INITIAL-INPUT is non-nil, insert it in the minibuffer initially,
1641 with point positioned at the end.
1642 If it is (STRING . POSITION), the initial input is STRING, but point
1643 is placed at _zero-indexed_ position POSITION in STRING. (*Note*
1644 that this is different from `read-from-minibuffer' and related
1645 functions, which use one-indexing for POSITION.) This feature is
1646 deprecated--it is best to pass nil for INITIAL-INPUT and supply the
1647 default value DEF instead. The user can yank the default value into
1648 the minibuffer easily using \\<minibuffer-local-map>\\[next-history-element].
1650 HIST, if non-nil, specifies a history list and optionally the initial
1651 position in the list. It can be a symbol, which is the history list
1652 variable to use, or it can be a cons cell (HISTVAR . HISTPOS). In
1653 that case, HISTVAR is the history list variable to use, and HISTPOS
1654 is the initial position (the position in the list used by the
1655 minibuffer history commands). For consistency, you should also
1656 specify that element of the history as the value of
1657 INITIAL-INPUT. (This is the only case in which you should use
1658 INITIAL-INPUT instead of DEF.) Positions are counted starting from
1659 1 at the beginning of the list. The variable `history-length'
1660 controls the maximum length of a history list.
1662 DEF, if non-nil, is the default value or the list of default values.
1664 If INHERIT-INPUT-METHOD is non-nil, the minibuffer inherits
1665 the current input method and the setting of `enable-multibyte-characters'.
1667 Completion ignores case if the ambient value of
1668 `completion-ignore-case' is non-nil.
1670 See also `completing-read-function'. */)
1671 (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)
1673 Lisp_Object args[9];
1674 args[0] = Fsymbol_value (intern ("completing-read-function"));
1675 args[1] = prompt;
1676 args[2] = collection;
1677 args[3] = predicate;
1678 args[4] = require_match;
1679 args[5] = initial_input;
1680 args[6] = hist;
1681 args[7] = def;
1682 args[8] = inherit_input_method;
1683 return Ffuncall (9, args);
1686 /* Test whether TXT is an exact completion. */
1687 DEFUN ("test-completion", Ftest_completion, Stest_completion, 2, 3, 0,
1688 doc: /* Return non-nil if STRING is a valid completion.
1689 Takes the same arguments as `all-completions' and `try-completion'.
1690 If COLLECTION is a function, it is called with three arguments:
1691 the values STRING, PREDICATE and `lambda'. */)
1692 (Lisp_Object string, Lisp_Object collection, Lisp_Object predicate)
1694 Lisp_Object regexps, tail, tem = Qnil;
1695 ptrdiff_t i = 0;
1697 CHECK_STRING (string);
1699 if ((CONSP (collection)
1700 && (!SYMBOLP (XCAR (collection)) || NILP (XCAR (collection))))
1701 || NILP (collection))
1703 tem = Fassoc_string (string, collection, completion_ignore_case ? Qt : Qnil);
1704 if (NILP (tem))
1705 return Qnil;
1707 else if (VECTORP (collection))
1709 /* Bypass intern-soft as that loses for nil. */
1710 tem = oblookup (collection,
1711 SSDATA (string),
1712 SCHARS (string),
1713 SBYTES (string));
1714 if (!SYMBOLP (tem))
1716 if (STRING_MULTIBYTE (string))
1717 string = Fstring_make_unibyte (string);
1718 else
1719 string = Fstring_make_multibyte (string);
1721 tem = oblookup (collection,
1722 SSDATA (string),
1723 SCHARS (string),
1724 SBYTES (string));
1727 if (completion_ignore_case && !SYMBOLP (tem))
1729 for (i = ASIZE (collection) - 1; i >= 0; i--)
1731 tail = AREF (collection, i);
1732 if (SYMBOLP (tail))
1733 while (1)
1735 if (EQ (Fcompare_strings (string, make_number (0), Qnil,
1736 Fsymbol_name (tail),
1737 make_number (0) , Qnil, Qt),
1738 Qt))
1740 tem = tail;
1741 break;
1743 if (XSYMBOL (tail)->next == 0)
1744 break;
1745 XSETSYMBOL (tail, XSYMBOL (tail)->next);
1750 if (!SYMBOLP (tem))
1751 return Qnil;
1753 else if (HASH_TABLE_P (collection))
1755 struct Lisp_Hash_Table *h = XHASH_TABLE (collection);
1756 Lisp_Object key = Qnil;
1757 i = hash_lookup (h, string, NULL);
1758 if (i >= 0)
1759 tem = HASH_KEY (h, i);
1760 else
1761 for (i = 0; i < HASH_TABLE_SIZE (h); ++i)
1762 if (!NILP (HASH_HASH (h, i))
1763 && (key = HASH_KEY (h, i),
1764 SYMBOLP (key) ? key = Fsymbol_name (key) : key,
1765 STRINGP (key))
1766 && EQ (Fcompare_strings (string, make_number (0), Qnil,
1767 key, make_number (0) , Qnil,
1768 completion_ignore_case ? Qt : Qnil),
1769 Qt))
1771 tem = key;
1772 break;
1774 if (!STRINGP (tem))
1775 return Qnil;
1777 else
1778 return call3 (collection, string, predicate, Qlambda);
1780 /* Reject this element if it fails to match all the regexps. */
1781 if (CONSP (Vcompletion_regexp_list))
1783 ptrdiff_t count = SPECPDL_INDEX ();
1784 specbind (Qcase_fold_search, completion_ignore_case ? Qt : Qnil);
1785 for (regexps = Vcompletion_regexp_list; CONSP (regexps);
1786 regexps = XCDR (regexps))
1788 if (NILP (Fstring_match (XCAR (regexps),
1789 SYMBOLP (tem) ? string : tem,
1790 Qnil)))
1791 return unbind_to (count, Qnil);
1793 unbind_to (count, Qnil);
1796 /* Finally, check the predicate. */
1797 if (!NILP (predicate))
1799 return HASH_TABLE_P (collection)
1800 ? call2 (predicate, tem, HASH_VALUE (XHASH_TABLE (collection), i))
1801 : call1 (predicate, tem);
1803 else
1804 return Qt;
1807 static Lisp_Object Qmetadata;
1809 DEFUN ("internal-complete-buffer", Finternal_complete_buffer, Sinternal_complete_buffer, 3, 3, 0,
1810 doc: /* Perform completion on buffer names.
1811 STRING and PREDICATE have the same meanings as in `try-completion',
1812 `all-completions', and `test-completion'.
1814 If FLAG is nil, invoke `try-completion'; if it is t, invoke
1815 `all-completions'; otherwise invoke `test-completion'. */)
1816 (Lisp_Object string, Lisp_Object predicate, Lisp_Object flag)
1818 if (NILP (flag))
1819 return Ftry_completion (string, Vbuffer_alist, predicate);
1820 else if (EQ (flag, Qt))
1822 Lisp_Object res = Fall_completions (string, Vbuffer_alist, predicate, Qnil);
1823 if (SCHARS (string) > 0)
1824 return res;
1825 else
1826 { /* Strip out internal buffers. */
1827 Lisp_Object bufs = res;
1828 /* First, look for a non-internal buffer in `res'. */
1829 while (CONSP (bufs) && SREF (XCAR (bufs), 0) == ' ')
1830 bufs = XCDR (bufs);
1831 if (NILP (bufs))
1832 return (EQ (Flength (res), Flength (Vbuffer_alist))
1833 /* If all bufs are internal don't strip them out. */
1834 ? res : bufs);
1835 res = bufs;
1836 while (CONSP (XCDR (bufs)))
1837 if (SREF (XCAR (XCDR (bufs)), 0) == ' ')
1838 XSETCDR (bufs, XCDR (XCDR (bufs)));
1839 else
1840 bufs = XCDR (bufs);
1841 return res;
1844 else if (EQ (flag, Qlambda))
1845 return Ftest_completion (string, Vbuffer_alist, predicate);
1846 else if (EQ (flag, Qmetadata))
1847 return list2 (Qmetadata, Fcons (Qcategory, Qbuffer));
1848 else
1849 return Qnil;
1852 /* Like assoc but assumes KEY is a string, and ignores case if appropriate. */
1854 DEFUN ("assoc-string", Fassoc_string, Sassoc_string, 2, 3, 0,
1855 doc: /* Like `assoc' but specifically for strings (and symbols).
1857 This returns the first element of LIST whose car matches the string or
1858 symbol KEY, or nil if no match exists. When performing the
1859 comparison, symbols are first converted to strings, and unibyte
1860 strings to multibyte. If the optional arg CASE-FOLD is non-nil, case
1861 is ignored.
1863 Unlike `assoc', KEY can also match an entry in LIST consisting of a
1864 single string, rather than a cons cell whose car is a string. */)
1865 (register Lisp_Object key, Lisp_Object list, Lisp_Object case_fold)
1867 register Lisp_Object tail;
1869 if (SYMBOLP (key))
1870 key = Fsymbol_name (key);
1872 for (tail = list; CONSP (tail); tail = XCDR (tail))
1874 register Lisp_Object elt, tem, thiscar;
1875 elt = XCAR (tail);
1876 thiscar = CONSP (elt) ? XCAR (elt) : elt;
1877 if (SYMBOLP (thiscar))
1878 thiscar = Fsymbol_name (thiscar);
1879 else if (!STRINGP (thiscar))
1880 continue;
1881 tem = Fcompare_strings (thiscar, make_number (0), Qnil,
1882 key, make_number (0), Qnil,
1883 case_fold);
1884 if (EQ (tem, Qt))
1885 return elt;
1886 QUIT;
1888 return Qnil;
1892 DEFUN ("minibuffer-depth", Fminibuffer_depth, Sminibuffer_depth, 0, 0, 0,
1893 doc: /* Return current depth of activations of minibuffer, a nonnegative integer. */)
1894 (void)
1896 return make_number (minibuf_level);
1899 DEFUN ("minibuffer-prompt", Fminibuffer_prompt, Sminibuffer_prompt, 0, 0, 0,
1900 doc: /* Return the prompt string of the currently-active minibuffer.
1901 If no minibuffer is active, return nil. */)
1902 (void)
1904 return Fcopy_sequence (minibuf_prompt);
1908 void
1909 init_minibuf_once (void)
1911 Vminibuffer_list = Qnil;
1912 staticpro (&Vminibuffer_list);
1915 void
1916 syms_of_minibuf (void)
1918 minibuf_level = 0;
1919 minibuf_prompt = Qnil;
1920 staticpro (&minibuf_prompt);
1922 minibuf_save_list = Qnil;
1923 staticpro (&minibuf_save_list);
1925 DEFSYM (Qcompletion_ignore_case, "completion-ignore-case");
1926 DEFSYM (Qread_file_name_internal, "read-file-name-internal");
1927 DEFSYM (Qminibuffer_default, "minibuffer-default");
1928 Fset (Qminibuffer_default, Qnil);
1930 DEFSYM (Qminibuffer_completion_table, "minibuffer-completion-table");
1931 DEFSYM (Qminibuffer_completion_confirm, "minibuffer-completion-confirm");
1932 DEFSYM (Qminibuffer_completion_predicate, "minibuffer-completion-predicate");
1934 staticpro (&last_minibuf_string);
1935 last_minibuf_string = Qnil;
1937 DEFSYM (Qminibuffer_history, "minibuffer-history");
1938 DEFSYM (Qbuffer_name_history, "buffer-name-history");
1939 Fset (Qbuffer_name_history, Qnil);
1941 DEFSYM (Qcustom_variable_p, "custom-variable-p");
1942 DEFSYM (Qminibuffer_setup_hook, "minibuffer-setup-hook");
1943 DEFSYM (Qminibuffer_exit_hook, "minibuffer-exit-hook");
1944 DEFSYM (Qhistory_length, "history-length");
1945 DEFSYM (Qcurrent_input_method, "current-input-method");
1946 DEFSYM (Qactivate_input_method, "activate-input-method");
1947 DEFSYM (Qcase_fold_search, "case-fold-search");
1948 DEFSYM (Qmetadata, "metadata");
1950 DEFVAR_LISP ("read-expression-history", Vread_expression_history,
1951 doc: /* A history list for arguments that are Lisp expressions to evaluate.
1952 For example, `eval-expression' uses this. */);
1953 Vread_expression_history = Qnil;
1955 DEFSYM (Qread_expression_history, "read-expression-history");
1957 DEFVAR_LISP ("read-buffer-function", Vread_buffer_function,
1958 doc: /* If this is non-nil, `read-buffer' does its work by calling this function.
1959 The function is called with the arguments passed to `read-buffer'. */);
1960 Vread_buffer_function = Qnil;
1962 DEFVAR_BOOL ("read-buffer-completion-ignore-case",
1963 read_buffer_completion_ignore_case,
1964 doc: /* Non-nil means completion ignores case when reading a buffer name. */);
1965 read_buffer_completion_ignore_case = 0;
1967 DEFVAR_LISP ("minibuffer-setup-hook", Vminibuffer_setup_hook,
1968 doc: /* Normal hook run just after entry to minibuffer. */);
1969 Vminibuffer_setup_hook = Qnil;
1971 DEFVAR_LISP ("minibuffer-exit-hook", Vminibuffer_exit_hook,
1972 doc: /* Normal hook run just after exit from minibuffer. */);
1973 Vminibuffer_exit_hook = Qnil;
1975 DEFVAR_LISP ("history-length", Vhistory_length,
1976 doc: /* Maximum length of history lists before truncation takes place.
1977 A number means truncate to that length; truncation deletes old
1978 elements, and is done just after inserting a new element.
1979 A value of t means no truncation.
1981 This variable only affects history lists that don't specify their own
1982 maximum lengths. Setting the `history-length' property of a history
1983 variable overrides this default. */);
1984 XSETFASTINT (Vhistory_length, 30);
1986 DEFVAR_BOOL ("history-delete-duplicates", history_delete_duplicates,
1987 doc: /* Non-nil means to delete duplicates in history.
1988 If set to t when adding a new history element, all previous identical
1989 elements are deleted from the history list. */);
1990 history_delete_duplicates = 0;
1992 DEFVAR_LISP ("history-add-new-input", Vhistory_add_new_input,
1993 doc: /* Non-nil means to add new elements in history.
1994 If set to nil, minibuffer reading functions don't add new elements to the
1995 history list, so it is possible to do this afterwards by calling
1996 `add-to-history' explicitly. */);
1997 Vhistory_add_new_input = Qt;
1999 DEFVAR_BOOL ("completion-ignore-case", completion_ignore_case,
2000 doc: /* Non-nil means don't consider case significant in completion.
2001 For file-name completion, `read-file-name-completion-ignore-case'
2002 controls the behavior, rather than this variable.
2003 For buffer name completion, `read-buffer-completion-ignore-case'
2004 controls the behavior, rather than this variable. */);
2005 completion_ignore_case = 0;
2007 DEFVAR_BOOL ("enable-recursive-minibuffers", enable_recursive_minibuffers,
2008 doc: /* Non-nil means to allow minibuffer commands while in the minibuffer.
2009 This variable makes a difference whenever the minibuffer window is active. */);
2010 enable_recursive_minibuffers = 0;
2012 DEFVAR_LISP ("minibuffer-completion-table", Vminibuffer_completion_table,
2013 doc: /* Alist or obarray used for completion in the minibuffer.
2014 This becomes the ALIST argument to `try-completion' and `all-completions'.
2015 The value can also be a list of strings or a hash table.
2017 The value may alternatively be a function, which is given three arguments:
2018 STRING, the current buffer contents;
2019 PREDICATE, the predicate for filtering possible matches;
2020 CODE, which says what kind of things to do.
2021 CODE can be nil, t or `lambda':
2022 nil -- return the best completion of STRING, or nil if there is none.
2023 t -- return a list of all possible completions of STRING.
2024 lambda -- return t if STRING is a valid completion as it stands. */);
2025 Vminibuffer_completion_table = Qnil;
2027 DEFVAR_LISP ("minibuffer-completion-predicate", Vminibuffer_completion_predicate,
2028 doc: /* Within call to `completing-read', this holds the PREDICATE argument. */);
2029 Vminibuffer_completion_predicate = Qnil;
2031 DEFVAR_LISP ("minibuffer-completion-confirm", Vminibuffer_completion_confirm,
2032 doc: /* Whether to demand confirmation of completion before exiting minibuffer.
2033 If nil, confirmation is not required.
2034 If the value is `confirm', the user may exit with an input that is not
2035 a valid completion alternative, but Emacs asks for confirmation.
2036 If the value is `confirm-after-completion', the user may exit with an
2037 input that is not a valid completion alternative, but Emacs asks for
2038 confirmation if the user submitted the input right after any of the
2039 completion commands listed in `minibuffer-confirm-exit-commands'. */);
2040 Vminibuffer_completion_confirm = Qnil;
2042 DEFVAR_LISP ("minibuffer-completing-file-name",
2043 Vminibuffer_completing_file_name,
2044 doc: /* Non-nil means completing file names. */);
2045 Vminibuffer_completing_file_name = Qnil;
2047 DEFVAR_LISP ("minibuffer-help-form", Vminibuffer_help_form,
2048 doc: /* Value that `help-form' takes on inside the minibuffer. */);
2049 Vminibuffer_help_form = Qnil;
2051 DEFVAR_LISP ("minibuffer-history-variable", Vminibuffer_history_variable,
2052 doc: /* History list symbol to add minibuffer values to.
2053 Each string of minibuffer input, as it appears on exit from the minibuffer,
2054 is added with
2055 (set minibuffer-history-variable
2056 (cons STRING (symbol-value minibuffer-history-variable))) */);
2057 XSETFASTINT (Vminibuffer_history_variable, 0);
2059 DEFVAR_LISP ("minibuffer-history-position", Vminibuffer_history_position,
2060 doc: /* Current position of redoing in the history list. */);
2061 Vminibuffer_history_position = Qnil;
2063 DEFVAR_BOOL ("minibuffer-auto-raise", minibuffer_auto_raise,
2064 doc: /* Non-nil means entering the minibuffer raises the minibuffer's frame.
2065 Some uses of the echo area also raise that frame (since they use it too). */);
2066 minibuffer_auto_raise = 0;
2068 DEFVAR_LISP ("completion-regexp-list", Vcompletion_regexp_list,
2069 doc: /* List of regexps that should restrict possible completions.
2070 The basic completion functions only consider a completion acceptable
2071 if it matches all regular expressions in this list, with
2072 `case-fold-search' bound to the value of `completion-ignore-case'.
2073 See Info node `(elisp)Basic Completion', for a description of these
2074 functions. */);
2075 Vcompletion_regexp_list = Qnil;
2077 DEFVAR_BOOL ("minibuffer-allow-text-properties",
2078 minibuffer_allow_text_properties,
2079 doc: /* Non-nil means `read-from-minibuffer' should not discard text properties.
2080 This also affects `read-string', but it does not affect `read-minibuffer',
2081 `read-no-blanks-input', or any of the functions that do minibuffer input
2082 with completion; they always discard text properties. */);
2083 minibuffer_allow_text_properties = 0;
2085 DEFVAR_LISP ("minibuffer-prompt-properties", Vminibuffer_prompt_properties,
2086 doc: /* Text properties that are added to minibuffer prompts.
2087 These are in addition to the basic `field' property, and stickiness
2088 properties. */);
2089 /* We use `intern' here instead of Qread_only to avoid
2090 initialization-order problems. */
2091 Vminibuffer_prompt_properties = list2 (intern_c_string ("read-only"), Qt);
2093 defsubr (&Sactive_minibuffer_window);
2094 defsubr (&Sset_minibuffer_window);
2095 defsubr (&Sread_from_minibuffer);
2096 defsubr (&Sread_string);
2097 defsubr (&Sread_command);
2098 defsubr (&Sread_variable);
2099 defsubr (&Sinternal_complete_buffer);
2100 defsubr (&Sread_buffer);
2101 defsubr (&Sread_no_blanks_input);
2102 defsubr (&Sminibuffer_depth);
2103 defsubr (&Sminibuffer_prompt);
2105 defsubr (&Sminibufferp);
2106 defsubr (&Sminibuffer_prompt_end);
2107 defsubr (&Sminibuffer_contents);
2108 defsubr (&Sminibuffer_contents_no_properties);
2109 defsubr (&Sminibuffer_completion_contents);
2111 defsubr (&Stry_completion);
2112 defsubr (&Sall_completions);
2113 defsubr (&Stest_completion);
2114 defsubr (&Sassoc_string);
2115 defsubr (&Scompleting_read);