Update copyright year to 2014 by running admin/update-copyright.
[emacs.git] / src / minibuf.c
blob13503beb630a524238f003986359d683d776b6d3
1 /* Minibuffer input and completion.
3 Copyright (C) 1985-1986, 1993-2014 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);
675 flush_frame (XFRAME (XWINDOW (minibuf_window)->frame));
678 /* Make minibuffer contents into a string. */
679 Fset_buffer (minibuffer);
680 if (allow_props)
681 val = Fminibuffer_contents ();
682 else
683 val = Fminibuffer_contents_no_properties ();
685 /* VAL is the string of minibuffer text. */
687 last_minibuf_string = val;
689 /* Choose the string to add to the history. */
690 if (SCHARS (val) != 0)
691 histstring = val;
692 else if (STRINGP (defalt))
693 histstring = defalt;
694 else if (CONSP (defalt) && STRINGP (XCAR (defalt)))
695 histstring = XCAR (defalt);
696 else
697 histstring = Qnil;
699 /* Add the value to the appropriate history list, if any. */
700 if (!NILP (Vhistory_add_new_input)
701 && SYMBOLP (Vminibuffer_history_variable)
702 && !NILP (histstring))
704 /* If the caller wanted to save the value read on a history list,
705 then do so if the value is not already the front of the list. */
706 Lisp_Object histval;
708 /* If variable is unbound, make it nil. */
710 histval = find_symbol_value (Vminibuffer_history_variable);
711 if (EQ (histval, Qunbound))
712 Fset (Vminibuffer_history_variable, Qnil);
714 /* The value of the history variable must be a cons or nil. Other
715 values are unacceptable. We silently ignore these values. */
717 if (NILP (histval)
718 || (CONSP (histval)
719 /* Don't duplicate the most recent entry in the history. */
720 && (NILP (Fequal (histstring, Fcar (histval))))))
722 Lisp_Object length;
724 if (history_delete_duplicates) Fdelete (histstring, histval);
725 histval = Fcons (histstring, histval);
726 Fset (Vminibuffer_history_variable, histval);
728 /* Truncate if requested. */
729 length = Fget (Vminibuffer_history_variable, Qhistory_length);
730 if (NILP (length)) length = Vhistory_length;
731 if (INTEGERP (length))
733 if (XINT (length) <= 0)
734 Fset (Vminibuffer_history_variable, Qnil);
735 else
737 Lisp_Object temp;
739 temp = Fnthcdr (Fsub1 (length), histval);
740 if (CONSP (temp)) Fsetcdr (temp, Qnil);
746 /* If Lisp form desired instead of string, parse it. */
747 if (expflag)
748 val = string_to_object (val, defalt);
750 /* The appropriate frame will get selected
751 in set-window-configuration. */
752 UNGCPRO;
753 return unbind_to (count, val);
756 /* Return a buffer to be used as the minibuffer at depth `depth'.
757 depth = 0 is the lowest allowed argument, and that is the value
758 used for nonrecursive minibuffer invocations. */
760 Lisp_Object
761 get_minibuffer (EMACS_INT depth)
763 Lisp_Object tail, num, buf;
764 char name[sizeof " *Minibuf-*" + INT_STRLEN_BOUND (EMACS_INT)];
766 XSETFASTINT (num, depth);
767 tail = Fnthcdr (num, Vminibuffer_list);
768 if (NILP (tail))
770 tail = list1 (Qnil);
771 Vminibuffer_list = nconc2 (Vminibuffer_list, tail);
773 buf = Fcar (tail);
774 if (NILP (buf) || !BUFFER_LIVE_P (XBUFFER (buf)))
776 buf = Fget_buffer_create
777 (make_formatted_string (name, " *Minibuf-%"pI"d*", depth));
779 /* Although the buffer's name starts with a space, undo should be
780 enabled in it. */
781 Fbuffer_enable_undo (buf);
783 XSETCAR (tail, buf);
785 else
787 ptrdiff_t count = SPECPDL_INDEX ();
788 /* We have to empty both overlay lists. Otherwise we end
789 up with overlays that think they belong to this buffer
790 while the buffer doesn't know about them any more. */
791 delete_all_overlays (XBUFFER (buf));
792 reset_buffer (XBUFFER (buf));
793 record_unwind_current_buffer ();
794 Fset_buffer (buf);
795 if (!NILP (Ffboundp (intern ("minibuffer-inactive-mode"))))
796 call0 (intern ("minibuffer-inactive-mode"));
797 else
798 Fkill_all_local_variables ();
799 unbind_to (count, Qnil);
802 return buf;
805 static void
806 run_exit_minibuf_hook (void)
808 safe_run_hooks (Qminibuffer_exit_hook);
811 /* This function is called on exiting minibuffer, whether normally or
812 not, and it restores the current window, buffer, etc. */
814 static void
815 read_minibuf_unwind (void)
817 Lisp_Object old_deactivate_mark;
818 Lisp_Object window;
820 /* If this was a recursive minibuffer,
821 tie the minibuffer window back to the outer level minibuffer buffer. */
822 minibuf_level--;
824 window = minibuf_window;
825 /* To keep things predictable, in case it matters, let's be in the
826 minibuffer when we reset the relevant variables. */
827 Fset_buffer (XWINDOW (window)->contents);
829 /* Restore prompt, etc, from outer minibuffer level. */
830 minibuf_prompt = Fcar (minibuf_save_list);
831 minibuf_save_list = Fcdr (minibuf_save_list);
832 minibuf_prompt_width = XFASTINT (Fcar (minibuf_save_list));
833 minibuf_save_list = Fcdr (minibuf_save_list);
834 Vhelp_form = Fcar (minibuf_save_list);
835 minibuf_save_list = Fcdr (minibuf_save_list);
836 Vcurrent_prefix_arg = Fcar (minibuf_save_list);
837 minibuf_save_list = Fcdr (minibuf_save_list);
838 Vminibuffer_history_position = Fcar (minibuf_save_list);
839 minibuf_save_list = Fcdr (minibuf_save_list);
840 Vminibuffer_history_variable = Fcar (minibuf_save_list);
841 minibuf_save_list = Fcdr (minibuf_save_list);
842 Voverriding_local_map = Fcar (minibuf_save_list);
843 minibuf_save_list = Fcdr (minibuf_save_list);
844 #if 0
845 temp = Fcar (minibuf_save_list);
846 if (FRAME_LIVE_P (XFRAME (WINDOW_FRAME (XWINDOW (temp)))))
847 minibuf_window = temp;
848 #endif
849 minibuf_save_list = Fcdr (minibuf_save_list);
851 /* Erase the minibuffer we were using at this level. */
853 ptrdiff_t count = SPECPDL_INDEX ();
854 /* Prevent error in erase-buffer. */
855 specbind (Qinhibit_read_only, Qt);
856 specbind (Qinhibit_modification_hooks, Qt);
857 old_deactivate_mark = Vdeactivate_mark;
858 Ferase_buffer ();
859 Vdeactivate_mark = old_deactivate_mark;
860 unbind_to (count, Qnil);
863 /* When we get to the outmost level, make sure we resize the
864 mini-window back to its normal size. */
865 if (minibuf_level == 0)
866 resize_mini_window (XWINDOW (window), 0);
868 /* In case the previous minibuffer displayed in this miniwindow is
869 dead, we may keep displaying this buffer (tho it's inactive), so reset it,
870 to make sure we don't leave around bindings and stuff which only
871 made sense during the read_minibuf invocation. */
872 call0 (intern ("minibuffer-inactive-mode"));
876 DEFUN ("read-from-minibuffer", Fread_from_minibuffer,
877 Sread_from_minibuffer, 1, 7, 0,
878 doc: /* Read a string from the minibuffer, prompting with string PROMPT.
879 The optional second arg INITIAL-CONTENTS is an obsolete alternative to
880 DEFAULT-VALUE. It normally should be nil in new code, except when
881 HIST is a cons. It is discussed in more detail below.
883 Third arg KEYMAP is a keymap to use whilst reading;
884 if omitted or nil, the default is `minibuffer-local-map'.
886 If fourth arg READ is non-nil, interpret the result as a Lisp object
887 and return that object:
888 in other words, do `(car (read-from-string INPUT-STRING))'
890 Fifth arg HIST, if non-nil, specifies a history list and optionally
891 the initial position in the list. It can be a symbol, which is the
892 history list variable to use, or a cons cell (HISTVAR . HISTPOS).
893 In that case, HISTVAR is the history list variable to use, and
894 HISTPOS is the initial position for use by the minibuffer history
895 commands. For consistency, you should also specify that element of
896 the history as the value of INITIAL-CONTENTS. Positions are counted
897 starting from 1 at the beginning of the list.
899 Sixth arg DEFAULT-VALUE, if non-nil, should be a string, which is used
900 as the default to `read' if READ is non-nil and the user enters
901 empty input. But if READ is nil, this function does _not_ return
902 DEFAULT-VALUE for empty input! Instead, it returns the empty string.
904 Whatever the value of READ, DEFAULT-VALUE is made available via the
905 minibuffer history commands. DEFAULT-VALUE can also be a list of
906 strings, in which case all the strings are available in the history,
907 and the first string is the default to `read' if READ is non-nil.
909 Seventh arg INHERIT-INPUT-METHOD, if non-nil, means the minibuffer inherits
910 the current input method and the setting of `enable-multibyte-characters'.
912 If the variable `minibuffer-allow-text-properties' is non-nil,
913 then the string which is returned includes whatever text properties
914 were present in the minibuffer. Otherwise the value has no text properties.
916 The remainder of this documentation string describes the
917 INITIAL-CONTENTS argument in more detail. It is only relevant when
918 studying existing code, or when HIST is a cons. If non-nil,
919 INITIAL-CONTENTS is a string to be inserted into the minibuffer before
920 reading input. Normally, point is put at the end of that string.
921 However, if INITIAL-CONTENTS is \(STRING . POSITION), the initial
922 input is STRING, but point is placed at _one-indexed_ position
923 POSITION in the minibuffer. Any integer value less than or equal to
924 one puts point at the beginning of the string. *Note* that this
925 behavior differs from the way such arguments are used in `completing-read'
926 and some related functions, which use zero-indexing for POSITION. */)
927 (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)
929 Lisp_Object histvar, histpos, val;
930 struct gcpro gcpro1;
932 CHECK_STRING (prompt);
933 if (NILP (keymap))
934 keymap = Vminibuffer_local_map;
935 else
936 keymap = get_keymap (keymap, 1, 0);
938 if (SYMBOLP (hist))
940 histvar = hist;
941 histpos = Qnil;
943 else
945 histvar = Fcar_safe (hist);
946 histpos = Fcdr_safe (hist);
948 if (NILP (histvar))
949 histvar = Qminibuffer_history;
950 if (NILP (histpos))
951 XSETFASTINT (histpos, 0);
953 GCPRO1 (default_value);
954 val = read_minibuf (keymap, initial_contents, prompt,
955 !NILP (read),
956 histvar, histpos, default_value,
957 minibuffer_allow_text_properties,
958 !NILP (inherit_input_method));
959 UNGCPRO;
960 return val;
963 /* Functions that use the minibuffer to read various things. */
965 DEFUN ("read-string", Fread_string, Sread_string, 1, 5, 0,
966 doc: /* Read a string from the minibuffer, prompting with string PROMPT.
967 If non-nil, second arg INITIAL-INPUT is a string to insert before reading.
968 This argument has been superseded by DEFAULT-VALUE and should normally
969 be nil in new code. It behaves as in `read-from-minibuffer'. See the
970 documentation string of that function for details.
971 The third arg HISTORY, if non-nil, specifies a history list
972 and optionally the initial position in the list.
973 See `read-from-minibuffer' for details of HISTORY argument.
974 Fourth arg DEFAULT-VALUE is the default value or the list of default values.
975 If non-nil, it is used for history commands, and as the value (or the first
976 element of the list of default values) to return if the user enters the
977 empty string.
978 Fifth arg INHERIT-INPUT-METHOD, if non-nil, means the minibuffer inherits
979 the current input method and the setting of `enable-multibyte-characters'. */)
980 (Lisp_Object prompt, Lisp_Object initial_input, Lisp_Object history, Lisp_Object default_value, Lisp_Object inherit_input_method)
982 Lisp_Object val;
983 ptrdiff_t count = SPECPDL_INDEX ();
985 /* Just in case we're in a recursive minibuffer, make it clear that the
986 previous minibuffer's completion table does not apply to the new
987 minibuffer.
988 FIXME: `minibuffer-completion-table' should be buffer-local instead. */
989 specbind (Qminibuffer_completion_table, Qnil);
991 val = Fread_from_minibuffer (prompt, initial_input, Qnil,
992 Qnil, history, default_value,
993 inherit_input_method);
994 if (STRINGP (val) && SCHARS (val) == 0 && ! NILP (default_value))
995 val = CONSP (default_value) ? XCAR (default_value) : default_value;
996 return unbind_to (count, val);
999 DEFUN ("read-no-blanks-input", Fread_no_blanks_input, Sread_no_blanks_input, 1, 3, 0,
1000 doc: /* Read a string from the terminal, not allowing blanks.
1001 Prompt with PROMPT. Whitespace terminates the input. If INITIAL is
1002 non-nil, it should be a string, which is used as initial input, with
1003 point positioned at the end, so that SPACE will accept the input.
1004 \(Actually, INITIAL can also be a cons of a string and an integer.
1005 Such values are treated as in `read-from-minibuffer', but are normally
1006 not useful in this function.)
1007 Third arg INHERIT-INPUT-METHOD, if non-nil, means the minibuffer inherits
1008 the current input method and the setting of`enable-multibyte-characters'. */)
1009 (Lisp_Object prompt, Lisp_Object initial, Lisp_Object inherit_input_method)
1011 CHECK_STRING (prompt);
1012 return read_minibuf (Vminibuffer_local_ns_map, initial, prompt,
1013 0, Qminibuffer_history, make_number (0), Qnil, 0,
1014 !NILP (inherit_input_method));
1017 DEFUN ("read-command", Fread_command, Sread_command, 1, 2, 0,
1018 doc: /* Read the name of a command and return as a symbol.
1019 Prompt with PROMPT. By default, return DEFAULT-VALUE or its first element
1020 if it is a list. */)
1021 (Lisp_Object prompt, Lisp_Object default_value)
1023 Lisp_Object name, default_string;
1025 if (NILP (default_value))
1026 default_string = Qnil;
1027 else if (SYMBOLP (default_value))
1028 default_string = SYMBOL_NAME (default_value);
1029 else
1030 default_string = default_value;
1032 name = Fcompleting_read (prompt, Vobarray, Qcommandp, Qt,
1033 Qnil, Qnil, default_string, Qnil);
1034 if (NILP (name))
1035 return name;
1036 return Fintern (name, Qnil);
1039 #ifdef NOTDEF
1040 DEFUN ("read-function", Fread_function, Sread_function, 1, 1, 0,
1041 doc: /* One arg PROMPT, a string. Read the name of a function and return as a symbol.
1042 Prompt with PROMPT. */)
1043 (Lisp_Object prompt)
1045 return Fintern (Fcompleting_read (prompt, Vobarray, Qfboundp, Qt, Qnil, Qnil, Qnil, Qnil),
1046 Qnil);
1048 #endif /* NOTDEF */
1050 DEFUN ("read-variable", Fread_variable, Sread_variable, 1, 2, 0,
1051 doc: /* Read the name of a user option and return it as a symbol.
1052 Prompt with PROMPT. By default, return DEFAULT-VALUE or its first element
1053 if it is a list.
1054 A user option, or customizable variable, is one for which
1055 `custom-variable-p' returns non-nil. */)
1056 (Lisp_Object prompt, Lisp_Object default_value)
1058 Lisp_Object name, default_string;
1060 if (NILP (default_value))
1061 default_string = Qnil;
1062 else if (SYMBOLP (default_value))
1063 default_string = SYMBOL_NAME (default_value);
1064 else
1065 default_string = default_value;
1067 name = Fcompleting_read (prompt, Vobarray,
1068 Qcustom_variable_p, Qt,
1069 Qnil, Qnil, default_string, Qnil);
1070 if (NILP (name))
1071 return name;
1072 return Fintern (name, Qnil);
1075 DEFUN ("read-buffer", Fread_buffer, Sread_buffer, 1, 3, 0,
1076 doc: /* Read the name of a buffer and return as a string.
1077 Prompt with PROMPT.
1078 Optional second arg DEF is value to return if user enters an empty line.
1079 If DEF is a list of default values, return its first element.
1080 Optional third arg REQUIRE-MATCH determines whether non-existing
1081 buffer names are allowed. It has the same meaning as the
1082 REQUIRE-MATCH argument of `completing-read'.
1083 The argument PROMPT should be a string ending with a colon and a space.
1084 If `read-buffer-completion-ignore-case' is non-nil, completion ignores
1085 case while reading the buffer name.
1086 If `read-buffer-function' is non-nil, this works by calling it as a
1087 function, instead of the usual behavior. */)
1088 (Lisp_Object prompt, Lisp_Object def, Lisp_Object require_match)
1090 Lisp_Object args[4], result;
1091 char *s;
1092 ptrdiff_t len;
1093 ptrdiff_t count = SPECPDL_INDEX ();
1095 if (BUFFERP (def))
1096 def = BVAR (XBUFFER (def), name);
1098 specbind (Qcompletion_ignore_case,
1099 read_buffer_completion_ignore_case ? Qt : Qnil);
1101 if (NILP (Vread_buffer_function))
1103 if (!NILP (def))
1105 /* A default value was provided: we must change PROMPT,
1106 editing the default value in before the colon. To achieve
1107 this, we replace PROMPT with a substring that doesn't
1108 contain the terminal space and colon (if present). They
1109 are then added back using Fformat. */
1111 if (STRINGP (prompt))
1113 s = SSDATA (prompt);
1114 len = SBYTES (prompt);
1115 if (len >= 2 && s[len - 2] == ':' && s[len - 1] == ' ')
1116 len = len - 2;
1117 else if (len >= 1 && (s[len - 1] == ':' || s[len - 1] == ' '))
1118 len--;
1120 prompt = make_specified_string (s, -1, len,
1121 STRING_MULTIBYTE (prompt));
1124 args[0] = build_string ("%s (default %s): ");
1125 args[1] = prompt;
1126 args[2] = CONSP (def) ? XCAR (def) : def;
1127 prompt = Fformat (3, args);
1130 result = Fcompleting_read (prompt, intern ("internal-complete-buffer"),
1131 Qnil, require_match, Qnil,
1132 Qbuffer_name_history, def, Qnil);
1134 else
1136 args[0] = Vread_buffer_function;
1137 args[1] = prompt;
1138 args[2] = def;
1139 args[3] = require_match;
1140 result = Ffuncall (4, args);
1142 return unbind_to (count, result);
1145 static Lisp_Object
1146 minibuf_conform_representation (Lisp_Object string, Lisp_Object basis)
1148 if (STRING_MULTIBYTE (string) == STRING_MULTIBYTE (basis))
1149 return string;
1151 if (STRING_MULTIBYTE (string))
1152 return Fstring_make_unibyte (string);
1153 else
1154 return Fstring_make_multibyte (string);
1157 DEFUN ("try-completion", Ftry_completion, Stry_completion, 2, 3, 0,
1158 doc: /* Return common substring of all completions of STRING in COLLECTION.
1159 Test each possible completion specified by COLLECTION
1160 to see if it begins with STRING. The possible completions may be
1161 strings or symbols. Symbols are converted to strings before testing,
1162 see `symbol-name'.
1163 All that match STRING are compared together; the longest initial sequence
1164 common to all these matches is the return value.
1165 If there is no match at all, the return value is nil.
1166 For a unique match which is exact, the return value is t.
1168 If COLLECTION is an alist, the keys (cars of elements) are the
1169 possible completions. If an element is not a cons cell, then the
1170 element itself is the possible completion.
1171 If COLLECTION is a hash-table, all the keys that are strings or symbols
1172 are the possible completions.
1173 If COLLECTION is an obarray, the names of all symbols in the obarray
1174 are the possible completions.
1176 COLLECTION can also be a function to do the completion itself.
1177 It receives three arguments: the values STRING, PREDICATE and nil.
1178 Whatever it returns becomes the value of `try-completion'.
1180 If optional third argument PREDICATE is non-nil,
1181 it is used to test each possible match.
1182 The match is a candidate only if PREDICATE returns non-nil.
1183 The argument given to PREDICATE is the alist element
1184 or the symbol from the obarray. If COLLECTION is a hash-table,
1185 predicate is called with two arguments: the key and the value.
1186 Additionally to this predicate, `completion-regexp-list'
1187 is used to further constrain the set of candidates. */)
1188 (Lisp_Object string, Lisp_Object collection, Lisp_Object predicate)
1190 Lisp_Object bestmatch, tail, elt, eltstring;
1191 /* Size in bytes of BESTMATCH. */
1192 ptrdiff_t bestmatchsize = 0;
1193 /* These are in bytes, too. */
1194 ptrdiff_t compare, matchsize;
1195 enum { function_table, list_table, obarray_table, hash_table}
1196 type = (HASH_TABLE_P (collection) ? hash_table
1197 : VECTORP (collection) ? obarray_table
1198 : ((NILP (collection)
1199 || (CONSP (collection) && !FUNCTIONP (collection)))
1200 ? list_table : function_table));
1201 ptrdiff_t idx = 0, obsize = 0;
1202 int matchcount = 0;
1203 ptrdiff_t bindcount = -1;
1204 Lisp_Object bucket, zero, end, tem;
1205 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
1207 CHECK_STRING (string);
1208 if (type == function_table)
1209 return call3 (collection, string, predicate, Qnil);
1211 bestmatch = bucket = Qnil;
1212 zero = make_number (0);
1214 /* If COLLECTION is not a list, set TAIL just for gc pro. */
1215 tail = collection;
1216 if (type == obarray_table)
1218 collection = check_obarray (collection);
1219 obsize = ASIZE (collection);
1220 bucket = AREF (collection, idx);
1223 while (1)
1225 /* Get the next element of the alist, obarray, or hash-table. */
1226 /* Exit the loop if the elements are all used up. */
1227 /* elt gets the alist element or symbol.
1228 eltstring gets the name to check as a completion. */
1230 if (type == list_table)
1232 if (!CONSP (tail))
1233 break;
1234 elt = XCAR (tail);
1235 eltstring = CONSP (elt) ? XCAR (elt) : elt;
1236 tail = XCDR (tail);
1238 else if (type == obarray_table)
1240 if (!EQ (bucket, zero))
1242 if (!SYMBOLP (bucket))
1243 error ("Bad data in guts of obarray");
1244 elt = bucket;
1245 eltstring = elt;
1246 if (XSYMBOL (bucket)->next)
1247 XSETSYMBOL (bucket, XSYMBOL (bucket)->next);
1248 else
1249 XSETFASTINT (bucket, 0);
1251 else if (++idx >= obsize)
1252 break;
1253 else
1255 bucket = AREF (collection, idx);
1256 continue;
1259 else /* if (type == hash_table) */
1261 while (idx < HASH_TABLE_SIZE (XHASH_TABLE (collection))
1262 && NILP (HASH_HASH (XHASH_TABLE (collection), idx)))
1263 idx++;
1264 if (idx >= HASH_TABLE_SIZE (XHASH_TABLE (collection)))
1265 break;
1266 else
1267 elt = eltstring = HASH_KEY (XHASH_TABLE (collection), idx++);
1270 /* Is this element a possible completion? */
1272 if (SYMBOLP (eltstring))
1273 eltstring = Fsymbol_name (eltstring);
1275 if (STRINGP (eltstring)
1276 && SCHARS (string) <= SCHARS (eltstring)
1277 && (tem = Fcompare_strings (eltstring, zero,
1278 make_number (SCHARS (string)),
1279 string, zero, Qnil,
1280 completion_ignore_case ? Qt : Qnil),
1281 EQ (Qt, tem)))
1283 /* Yes. */
1284 Lisp_Object regexps;
1286 /* Ignore this element if it fails to match all the regexps. */
1288 for (regexps = Vcompletion_regexp_list; CONSP (regexps);
1289 regexps = XCDR (regexps))
1291 if (bindcount < 0) {
1292 bindcount = SPECPDL_INDEX ();
1293 specbind (Qcase_fold_search,
1294 completion_ignore_case ? Qt : Qnil);
1296 tem = Fstring_match (XCAR (regexps), eltstring, zero);
1297 if (NILP (tem))
1298 break;
1300 if (CONSP (regexps))
1301 continue;
1304 /* Ignore this element if there is a predicate
1305 and the predicate doesn't like it. */
1307 if (!NILP (predicate))
1309 if (EQ (predicate, Qcommandp))
1310 tem = Fcommandp (elt, Qnil);
1311 else
1313 if (bindcount >= 0)
1315 unbind_to (bindcount, Qnil);
1316 bindcount = -1;
1318 GCPRO4 (tail, string, eltstring, bestmatch);
1319 tem = (type == hash_table
1320 ? call2 (predicate, elt,
1321 HASH_VALUE (XHASH_TABLE (collection),
1322 idx - 1))
1323 : call1 (predicate, elt));
1324 UNGCPRO;
1326 if (NILP (tem)) continue;
1329 /* Update computation of how much all possible completions match */
1331 if (NILP (bestmatch))
1333 matchcount = 1;
1334 bestmatch = eltstring;
1335 bestmatchsize = SCHARS (eltstring);
1337 else
1339 compare = min (bestmatchsize, SCHARS (eltstring));
1340 tem = Fcompare_strings (bestmatch, zero,
1341 make_number (compare),
1342 eltstring, zero,
1343 make_number (compare),
1344 completion_ignore_case ? Qt : Qnil);
1345 matchsize = EQ (tem, Qt) ? compare : eabs (XINT (tem)) - 1;
1347 if (completion_ignore_case)
1349 /* If this is an exact match except for case,
1350 use it as the best match rather than one that is not an
1351 exact match. This way, we get the case pattern
1352 of the actual match. */
1353 if ((matchsize == SCHARS (eltstring)
1354 && matchsize < SCHARS (bestmatch))
1356 /* If there is more than one exact match ignoring case,
1357 and one of them is exact including case,
1358 prefer that one. */
1359 /* If there is no exact match ignoring case,
1360 prefer a match that does not change the case
1361 of the input. */
1362 ((matchsize == SCHARS (eltstring))
1364 (matchsize == SCHARS (bestmatch))
1365 && (tem = Fcompare_strings (eltstring, zero,
1366 make_number (SCHARS (string)),
1367 string, zero,
1368 Qnil,
1369 Qnil),
1370 EQ (Qt, tem))
1371 && (tem = Fcompare_strings (bestmatch, zero,
1372 make_number (SCHARS (string)),
1373 string, zero,
1374 Qnil,
1375 Qnil),
1376 ! EQ (Qt, tem))))
1377 bestmatch = eltstring;
1379 if (bestmatchsize != SCHARS (eltstring)
1380 || bestmatchsize != matchsize)
1381 /* Don't count the same string multiple times. */
1382 matchcount += matchcount <= 1;
1383 bestmatchsize = matchsize;
1384 if (matchsize <= SCHARS (string)
1385 /* If completion-ignore-case is non-nil, don't
1386 short-circuit because we want to find the best
1387 possible match *including* case differences. */
1388 && !completion_ignore_case
1389 && matchcount > 1)
1390 /* No need to look any further. */
1391 break;
1396 if (bindcount >= 0) {
1397 unbind_to (bindcount, Qnil);
1398 bindcount = -1;
1401 if (NILP (bestmatch))
1402 return Qnil; /* No completions found. */
1403 /* If we are ignoring case, and there is no exact match,
1404 and no additional text was supplied,
1405 don't change the case of what the user typed. */
1406 if (completion_ignore_case && bestmatchsize == SCHARS (string)
1407 && SCHARS (bestmatch) > bestmatchsize)
1408 return minibuf_conform_representation (string, bestmatch);
1410 /* Return t if the supplied string is an exact match (counting case);
1411 it does not require any change to be made. */
1412 if (matchcount == 1 && !NILP (Fequal (bestmatch, string)))
1413 return Qt;
1415 XSETFASTINT (zero, 0); /* Else extract the part in which */
1416 XSETFASTINT (end, bestmatchsize); /* all completions agree. */
1417 return Fsubstring (bestmatch, zero, end);
1420 DEFUN ("all-completions", Fall_completions, Sall_completions, 2, 4, 0,
1421 doc: /* Search for partial matches to STRING in COLLECTION.
1422 Test each of the possible completions specified by COLLECTION
1423 to see if it begins with STRING. The possible completions may be
1424 strings or symbols. Symbols are converted to strings before testing,
1425 see `symbol-name'.
1426 The value is a list of all the possible completions that match STRING.
1428 If COLLECTION is an alist, the keys (cars of elements) are the
1429 possible completions. If an element is not a cons cell, then the
1430 element itself is the possible completion.
1431 If COLLECTION is a hash-table, all the keys that are strings or symbols
1432 are the possible completions.
1433 If COLLECTION is an obarray, the names of all symbols in the obarray
1434 are the possible completions.
1436 COLLECTION can also be a function to do the completion itself.
1437 It receives three arguments: the values STRING, PREDICATE and t.
1438 Whatever it returns becomes the value of `all-completions'.
1440 If optional third argument PREDICATE is non-nil,
1441 it is used to test each possible match.
1442 The match is a candidate only if PREDICATE returns non-nil.
1443 The argument given to PREDICATE is the alist element
1444 or the symbol from the obarray. If COLLECTION is a hash-table,
1445 predicate is called with two arguments: the key and the value.
1446 Additionally to this predicate, `completion-regexp-list'
1447 is used to further constrain the set of candidates.
1449 An obsolete optional fourth argument HIDE-SPACES is still accepted for
1450 backward compatibility. If non-nil, strings in COLLECTION that start
1451 with a space are ignored unless STRING itself starts with a space. */)
1452 (Lisp_Object string, Lisp_Object collection, Lisp_Object predicate, Lisp_Object hide_spaces)
1454 Lisp_Object tail, elt, eltstring;
1455 Lisp_Object allmatches;
1456 int type = HASH_TABLE_P (collection) ? 3
1457 : VECTORP (collection) ? 2
1458 : NILP (collection) || (CONSP (collection) && !FUNCTIONP (collection));
1459 ptrdiff_t idx = 0, obsize = 0;
1460 ptrdiff_t bindcount = -1;
1461 Lisp_Object bucket, tem, zero;
1462 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
1464 CHECK_STRING (string);
1465 if (type == 0)
1466 return call3 (collection, string, predicate, Qt);
1467 allmatches = bucket = Qnil;
1468 zero = make_number (0);
1470 /* If COLLECTION is not a list, set TAIL just for gc pro. */
1471 tail = collection;
1472 if (type == 2)
1474 collection = check_obarray (collection);
1475 obsize = ASIZE (collection);
1476 bucket = AREF (collection, idx);
1479 while (1)
1481 /* Get the next element of the alist, obarray, or hash-table. */
1482 /* Exit the loop if the elements are all used up. */
1483 /* elt gets the alist element or symbol.
1484 eltstring gets the name to check as a completion. */
1486 if (type == 1)
1488 if (!CONSP (tail))
1489 break;
1490 elt = XCAR (tail);
1491 eltstring = CONSP (elt) ? XCAR (elt) : elt;
1492 tail = XCDR (tail);
1494 else if (type == 2)
1496 if (!EQ (bucket, zero))
1498 if (!SYMBOLP (bucket))
1499 error ("Bad data in guts of obarray");
1500 elt = bucket;
1501 eltstring = elt;
1502 if (XSYMBOL (bucket)->next)
1503 XSETSYMBOL (bucket, XSYMBOL (bucket)->next);
1504 else
1505 XSETFASTINT (bucket, 0);
1507 else if (++idx >= obsize)
1508 break;
1509 else
1511 bucket = AREF (collection, idx);
1512 continue;
1515 else /* if (type == 3) */
1517 while (idx < HASH_TABLE_SIZE (XHASH_TABLE (collection))
1518 && NILP (HASH_HASH (XHASH_TABLE (collection), idx)))
1519 idx++;
1520 if (idx >= HASH_TABLE_SIZE (XHASH_TABLE (collection)))
1521 break;
1522 else
1523 elt = eltstring = HASH_KEY (XHASH_TABLE (collection), idx++);
1526 /* Is this element a possible completion? */
1528 if (SYMBOLP (eltstring))
1529 eltstring = Fsymbol_name (eltstring);
1531 if (STRINGP (eltstring)
1532 && SCHARS (string) <= SCHARS (eltstring)
1533 /* If HIDE_SPACES, reject alternatives that start with space
1534 unless the input starts with space. */
1535 && (NILP (hide_spaces)
1536 || (SBYTES (string) > 0
1537 && SREF (string, 0) == ' ')
1538 || SREF (eltstring, 0) != ' ')
1539 && (tem = Fcompare_strings (eltstring, zero,
1540 make_number (SCHARS (string)),
1541 string, zero,
1542 make_number (SCHARS (string)),
1543 completion_ignore_case ? Qt : Qnil),
1544 EQ (Qt, tem)))
1546 /* Yes. */
1547 Lisp_Object regexps;
1549 /* Ignore this element if it fails to match all the regexps. */
1551 for (regexps = Vcompletion_regexp_list; CONSP (regexps);
1552 regexps = XCDR (regexps))
1554 if (bindcount < 0) {
1555 bindcount = SPECPDL_INDEX ();
1556 specbind (Qcase_fold_search,
1557 completion_ignore_case ? Qt : Qnil);
1559 tem = Fstring_match (XCAR (regexps), eltstring, zero);
1560 if (NILP (tem))
1561 break;
1563 if (CONSP (regexps))
1564 continue;
1567 /* Ignore this element if there is a predicate
1568 and the predicate doesn't like it. */
1570 if (!NILP (predicate))
1572 if (EQ (predicate, Qcommandp))
1573 tem = Fcommandp (elt, Qnil);
1574 else
1576 if (bindcount >= 0) {
1577 unbind_to (bindcount, Qnil);
1578 bindcount = -1;
1580 GCPRO4 (tail, eltstring, allmatches, string);
1581 tem = type == 3
1582 ? call2 (predicate, elt,
1583 HASH_VALUE (XHASH_TABLE (collection), idx - 1))
1584 : call1 (predicate, elt);
1585 UNGCPRO;
1587 if (NILP (tem)) continue;
1589 /* Ok => put it on the list. */
1590 allmatches = Fcons (eltstring, allmatches);
1594 if (bindcount >= 0) {
1595 unbind_to (bindcount, Qnil);
1596 bindcount = -1;
1599 return Fnreverse (allmatches);
1602 DEFUN ("completing-read", Fcompleting_read, Scompleting_read, 2, 8, 0,
1603 doc: /* Read a string in the minibuffer, with completion.
1604 PROMPT is a string to prompt with; normally it ends in a colon and a space.
1605 COLLECTION can be a list of strings, an alist, an obarray or a hash table.
1606 COLLECTION can also be a function to do the completion itself.
1607 PREDICATE limits completion to a subset of COLLECTION.
1608 See `try-completion' and `all-completions' for more details
1609 on completion, COLLECTION, and PREDICATE.
1611 REQUIRE-MATCH can take the following values:
1612 - t means that the user is not allowed to exit unless
1613 the input is (or completes to) an element of COLLECTION or is null.
1614 - nil means that the user can exit with any input.
1615 - `confirm' means that the user can exit with any input, but she needs
1616 to confirm her choice if the input is not an element of COLLECTION.
1617 - `confirm-after-completion' means that the user can exit with any
1618 input, but she needs to confirm her choice if she called
1619 `minibuffer-complete' right before `minibuffer-complete-and-exit'
1620 and the input is not an element of COLLECTION.
1621 - anything else behaves like t except that typing RET does not exit if it
1622 does non-null completion.
1624 If the input is null, `completing-read' returns DEF, or the first element
1625 of the list of default values, or an empty string if DEF is nil,
1626 regardless of the value of REQUIRE-MATCH.
1628 If INITIAL-INPUT is non-nil, insert it in the minibuffer initially,
1629 with point positioned at the end.
1630 If it is (STRING . POSITION), the initial input is STRING, but point
1631 is placed at _zero-indexed_ position POSITION in STRING. (*Note*
1632 that this is different from `read-from-minibuffer' and related
1633 functions, which use one-indexing for POSITION.) This feature is
1634 deprecated--it is best to pass nil for INITIAL-INPUT and supply the
1635 default value DEF instead. The user can yank the default value into
1636 the minibuffer easily using \\<minibuffer-local-map>\\[next-history-element].
1638 HIST, if non-nil, specifies a history list and optionally the initial
1639 position in the list. It can be a symbol, which is the history list
1640 variable to use, or it can be a cons cell (HISTVAR . HISTPOS). In
1641 that case, HISTVAR is the history list variable to use, and HISTPOS
1642 is the initial position (the position in the list used by the
1643 minibuffer history commands). For consistency, you should also
1644 specify that element of the history as the value of
1645 INITIAL-INPUT. (This is the only case in which you should use
1646 INITIAL-INPUT instead of DEF.) Positions are counted starting from
1647 1 at the beginning of the list. The variable `history-length'
1648 controls the maximum length of a history list.
1650 DEF, if non-nil, is the default value or the list of default values.
1652 If INHERIT-INPUT-METHOD is non-nil, the minibuffer inherits
1653 the current input method and the setting of `enable-multibyte-characters'.
1655 Completion ignores case if the ambient value of
1656 `completion-ignore-case' is non-nil.
1658 See also `completing-read-function'. */)
1659 (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)
1661 Lisp_Object args[9];
1662 args[0] = Fsymbol_value (intern ("completing-read-function"));
1663 args[1] = prompt;
1664 args[2] = collection;
1665 args[3] = predicate;
1666 args[4] = require_match;
1667 args[5] = initial_input;
1668 args[6] = hist;
1669 args[7] = def;
1670 args[8] = inherit_input_method;
1671 return Ffuncall (9, args);
1674 /* Test whether TXT is an exact completion. */
1675 DEFUN ("test-completion", Ftest_completion, Stest_completion, 2, 3, 0,
1676 doc: /* Return non-nil if STRING is a valid completion.
1677 Takes the same arguments as `all-completions' and `try-completion'.
1678 If COLLECTION is a function, it is called with three arguments:
1679 the values STRING, PREDICATE and `lambda'. */)
1680 (Lisp_Object string, Lisp_Object collection, Lisp_Object predicate)
1682 Lisp_Object regexps, tail, tem = Qnil;
1683 ptrdiff_t i = 0;
1685 CHECK_STRING (string);
1687 if (NILP (collection) || (CONSP (collection) && !FUNCTIONP (collection)))
1689 tem = Fassoc_string (string, collection, completion_ignore_case ? Qt : Qnil);
1690 if (NILP (tem))
1691 return Qnil;
1693 else if (VECTORP (collection))
1695 /* Bypass intern-soft as that loses for nil. */
1696 tem = oblookup (collection,
1697 SSDATA (string),
1698 SCHARS (string),
1699 SBYTES (string));
1700 if (!SYMBOLP (tem))
1702 if (STRING_MULTIBYTE (string))
1703 string = Fstring_make_unibyte (string);
1704 else
1705 string = Fstring_make_multibyte (string);
1707 tem = oblookup (collection,
1708 SSDATA (string),
1709 SCHARS (string),
1710 SBYTES (string));
1713 if (completion_ignore_case && !SYMBOLP (tem))
1715 for (i = ASIZE (collection) - 1; i >= 0; i--)
1717 tail = AREF (collection, i);
1718 if (SYMBOLP (tail))
1719 while (1)
1721 if (EQ (Fcompare_strings (string, make_number (0), Qnil,
1722 Fsymbol_name (tail),
1723 make_number (0) , Qnil, Qt),
1724 Qt))
1726 tem = tail;
1727 break;
1729 if (XSYMBOL (tail)->next == 0)
1730 break;
1731 XSETSYMBOL (tail, XSYMBOL (tail)->next);
1736 if (!SYMBOLP (tem))
1737 return Qnil;
1739 else if (HASH_TABLE_P (collection))
1741 struct Lisp_Hash_Table *h = XHASH_TABLE (collection);
1742 Lisp_Object key = Qnil;
1743 i = hash_lookup (h, string, NULL);
1744 if (i >= 0)
1745 tem = HASH_KEY (h, i);
1746 else
1747 for (i = 0; i < HASH_TABLE_SIZE (h); ++i)
1748 if (!NILP (HASH_HASH (h, i))
1749 && (key = HASH_KEY (h, i),
1750 SYMBOLP (key) ? key = Fsymbol_name (key) : key,
1751 STRINGP (key))
1752 && EQ (Fcompare_strings (string, make_number (0), Qnil,
1753 key, make_number (0) , Qnil,
1754 completion_ignore_case ? Qt : Qnil),
1755 Qt))
1757 tem = key;
1758 break;
1760 if (!STRINGP (tem))
1761 return Qnil;
1763 else
1764 return call3 (collection, string, predicate, Qlambda);
1766 /* Reject this element if it fails to match all the regexps. */
1767 if (CONSP (Vcompletion_regexp_list))
1769 ptrdiff_t count = SPECPDL_INDEX ();
1770 specbind (Qcase_fold_search, completion_ignore_case ? Qt : Qnil);
1771 for (regexps = Vcompletion_regexp_list; CONSP (regexps);
1772 regexps = XCDR (regexps))
1774 if (NILP (Fstring_match (XCAR (regexps),
1775 SYMBOLP (tem) ? string : tem,
1776 Qnil)))
1777 return unbind_to (count, Qnil);
1779 unbind_to (count, Qnil);
1782 /* Finally, check the predicate. */
1783 if (!NILP (predicate))
1785 return HASH_TABLE_P (collection)
1786 ? call2 (predicate, tem, HASH_VALUE (XHASH_TABLE (collection), i))
1787 : call1 (predicate, tem);
1789 else
1790 return Qt;
1793 static Lisp_Object Qmetadata;
1795 DEFUN ("internal-complete-buffer", Finternal_complete_buffer, Sinternal_complete_buffer, 3, 3, 0,
1796 doc: /* Perform completion on buffer names.
1797 STRING and PREDICATE have the same meanings as in `try-completion',
1798 `all-completions', and `test-completion'.
1800 If FLAG is nil, invoke `try-completion'; if it is t, invoke
1801 `all-completions'; otherwise invoke `test-completion'. */)
1802 (Lisp_Object string, Lisp_Object predicate, Lisp_Object flag)
1804 if (NILP (flag))
1805 return Ftry_completion (string, Vbuffer_alist, predicate);
1806 else if (EQ (flag, Qt))
1808 Lisp_Object res = Fall_completions (string, Vbuffer_alist, predicate, Qnil);
1809 if (SCHARS (string) > 0)
1810 return res;
1811 else
1812 { /* Strip out internal buffers. */
1813 Lisp_Object bufs = res;
1814 /* First, look for a non-internal buffer in `res'. */
1815 while (CONSP (bufs) && SREF (XCAR (bufs), 0) == ' ')
1816 bufs = XCDR (bufs);
1817 if (NILP (bufs))
1818 return (EQ (Flength (res), Flength (Vbuffer_alist))
1819 /* If all bufs are internal don't strip them out. */
1820 ? res : bufs);
1821 res = bufs;
1822 while (CONSP (XCDR (bufs)))
1823 if (SREF (XCAR (XCDR (bufs)), 0) == ' ')
1824 XSETCDR (bufs, XCDR (XCDR (bufs)));
1825 else
1826 bufs = XCDR (bufs);
1827 return res;
1830 else if (EQ (flag, Qlambda))
1831 return Ftest_completion (string, Vbuffer_alist, predicate);
1832 else if (EQ (flag, Qmetadata))
1833 return list2 (Qmetadata, Fcons (Qcategory, Qbuffer));
1834 else
1835 return Qnil;
1838 /* Like assoc but assumes KEY is a string, and ignores case if appropriate. */
1840 DEFUN ("assoc-string", Fassoc_string, Sassoc_string, 2, 3, 0,
1841 doc: /* Like `assoc' but specifically for strings (and symbols).
1843 This returns the first element of LIST whose car matches the string or
1844 symbol KEY, or nil if no match exists. When performing the
1845 comparison, symbols are first converted to strings, and unibyte
1846 strings to multibyte. If the optional arg CASE-FOLD is non-nil, case
1847 is ignored.
1849 Unlike `assoc', KEY can also match an entry in LIST consisting of a
1850 single string, rather than a cons cell whose car is a string. */)
1851 (register Lisp_Object key, Lisp_Object list, Lisp_Object case_fold)
1853 register Lisp_Object tail;
1855 if (SYMBOLP (key))
1856 key = Fsymbol_name (key);
1858 for (tail = list; CONSP (tail); tail = XCDR (tail))
1860 register Lisp_Object elt, tem, thiscar;
1861 elt = XCAR (tail);
1862 thiscar = CONSP (elt) ? XCAR (elt) : elt;
1863 if (SYMBOLP (thiscar))
1864 thiscar = Fsymbol_name (thiscar);
1865 else if (!STRINGP (thiscar))
1866 continue;
1867 tem = Fcompare_strings (thiscar, make_number (0), Qnil,
1868 key, make_number (0), Qnil,
1869 case_fold);
1870 if (EQ (tem, Qt))
1871 return elt;
1872 QUIT;
1874 return Qnil;
1878 DEFUN ("minibuffer-depth", Fminibuffer_depth, Sminibuffer_depth, 0, 0, 0,
1879 doc: /* Return current depth of activations of minibuffer, a nonnegative integer. */)
1880 (void)
1882 return make_number (minibuf_level);
1885 DEFUN ("minibuffer-prompt", Fminibuffer_prompt, Sminibuffer_prompt, 0, 0, 0,
1886 doc: /* Return the prompt string of the currently-active minibuffer.
1887 If no minibuffer is active, return nil. */)
1888 (void)
1890 return Fcopy_sequence (minibuf_prompt);
1894 void
1895 init_minibuf_once (void)
1897 Vminibuffer_list = Qnil;
1898 staticpro (&Vminibuffer_list);
1901 void
1902 syms_of_minibuf (void)
1904 minibuf_level = 0;
1905 minibuf_prompt = Qnil;
1906 staticpro (&minibuf_prompt);
1908 minibuf_save_list = Qnil;
1909 staticpro (&minibuf_save_list);
1911 DEFSYM (Qcompletion_ignore_case, "completion-ignore-case");
1912 DEFSYM (Qread_file_name_internal, "read-file-name-internal");
1913 DEFSYM (Qminibuffer_default, "minibuffer-default");
1914 Fset (Qminibuffer_default, Qnil);
1916 DEFSYM (Qminibuffer_completion_table, "minibuffer-completion-table");
1917 DEFSYM (Qminibuffer_completion_confirm, "minibuffer-completion-confirm");
1918 DEFSYM (Qminibuffer_completion_predicate, "minibuffer-completion-predicate");
1920 staticpro (&last_minibuf_string);
1921 last_minibuf_string = Qnil;
1923 DEFSYM (Qminibuffer_history, "minibuffer-history");
1924 DEFSYM (Qbuffer_name_history, "buffer-name-history");
1925 Fset (Qbuffer_name_history, Qnil);
1927 DEFSYM (Qcustom_variable_p, "custom-variable-p");
1928 DEFSYM (Qminibuffer_setup_hook, "minibuffer-setup-hook");
1929 DEFSYM (Qminibuffer_exit_hook, "minibuffer-exit-hook");
1930 DEFSYM (Qhistory_length, "history-length");
1931 DEFSYM (Qcurrent_input_method, "current-input-method");
1932 DEFSYM (Qactivate_input_method, "activate-input-method");
1933 DEFSYM (Qcase_fold_search, "case-fold-search");
1934 DEFSYM (Qmetadata, "metadata");
1936 DEFVAR_LISP ("read-expression-history", Vread_expression_history,
1937 doc: /* A history list for arguments that are Lisp expressions to evaluate.
1938 For example, `eval-expression' uses this. */);
1939 Vread_expression_history = Qnil;
1941 DEFSYM (Qread_expression_history, "read-expression-history");
1943 DEFVAR_LISP ("read-buffer-function", Vread_buffer_function,
1944 doc: /* If this is non-nil, `read-buffer' does its work by calling this function.
1945 The function is called with the arguments passed to `read-buffer'. */);
1946 Vread_buffer_function = Qnil;
1948 DEFVAR_BOOL ("read-buffer-completion-ignore-case",
1949 read_buffer_completion_ignore_case,
1950 doc: /* Non-nil means completion ignores case when reading a buffer name. */);
1951 read_buffer_completion_ignore_case = 0;
1953 DEFVAR_LISP ("minibuffer-setup-hook", Vminibuffer_setup_hook,
1954 doc: /* Normal hook run just after entry to minibuffer. */);
1955 Vminibuffer_setup_hook = Qnil;
1957 DEFVAR_LISP ("minibuffer-exit-hook", Vminibuffer_exit_hook,
1958 doc: /* Normal hook run just after exit from minibuffer. */);
1959 Vminibuffer_exit_hook = Qnil;
1961 DEFVAR_LISP ("history-length", Vhistory_length,
1962 doc: /* Maximum length of history lists before truncation takes place.
1963 A number means truncate to that length; truncation deletes old
1964 elements, and is done just after inserting a new element.
1965 A value of t means no truncation.
1967 This variable only affects history lists that don't specify their own
1968 maximum lengths. Setting the `history-length' property of a history
1969 variable overrides this default. */);
1970 XSETFASTINT (Vhistory_length, 30);
1972 DEFVAR_BOOL ("history-delete-duplicates", history_delete_duplicates,
1973 doc: /* Non-nil means to delete duplicates in history.
1974 If set to t when adding a new history element, all previous identical
1975 elements are deleted from the history list. */);
1976 history_delete_duplicates = 0;
1978 DEFVAR_LISP ("history-add-new-input", Vhistory_add_new_input,
1979 doc: /* Non-nil means to add new elements in history.
1980 If set to nil, minibuffer reading functions don't add new elements to the
1981 history list, so it is possible to do this afterwards by calling
1982 `add-to-history' explicitly. */);
1983 Vhistory_add_new_input = Qt;
1985 DEFVAR_BOOL ("completion-ignore-case", completion_ignore_case,
1986 doc: /* Non-nil means don't consider case significant in completion.
1987 For file-name completion, `read-file-name-completion-ignore-case'
1988 controls the behavior, rather than this variable.
1989 For buffer name completion, `read-buffer-completion-ignore-case'
1990 controls the behavior, rather than this variable. */);
1991 completion_ignore_case = 0;
1993 DEFVAR_BOOL ("enable-recursive-minibuffers", enable_recursive_minibuffers,
1994 doc: /* Non-nil means to allow minibuffer commands while in the minibuffer.
1995 This variable makes a difference whenever the minibuffer window is active. */);
1996 enable_recursive_minibuffers = 0;
1998 DEFVAR_LISP ("minibuffer-completion-table", Vminibuffer_completion_table,
1999 doc: /* Alist or obarray used for completion in the minibuffer.
2000 This becomes the ALIST argument to `try-completion' and `all-completions'.
2001 The value can also be a list of strings or a hash table.
2003 The value may alternatively be a function, which is given three arguments:
2004 STRING, the current buffer contents;
2005 PREDICATE, the predicate for filtering possible matches;
2006 CODE, which says what kind of things to do.
2007 CODE can be nil, t or `lambda':
2008 nil -- return the best completion of STRING, or nil if there is none.
2009 t -- return a list of all possible completions of STRING.
2010 lambda -- return t if STRING is a valid completion as it stands. */);
2011 Vminibuffer_completion_table = Qnil;
2013 DEFVAR_LISP ("minibuffer-completion-predicate", Vminibuffer_completion_predicate,
2014 doc: /* Within call to `completing-read', this holds the PREDICATE argument. */);
2015 Vminibuffer_completion_predicate = Qnil;
2017 DEFVAR_LISP ("minibuffer-completion-confirm", Vminibuffer_completion_confirm,
2018 doc: /* Whether to demand confirmation of completion before exiting minibuffer.
2019 If nil, confirmation is not required.
2020 If the value is `confirm', the user may exit with an input that is not
2021 a valid completion alternative, but Emacs asks for confirmation.
2022 If the value is `confirm-after-completion', the user may exit with an
2023 input that is not a valid completion alternative, but Emacs asks for
2024 confirmation if the user submitted the input right after any of the
2025 completion commands listed in `minibuffer-confirm-exit-commands'. */);
2026 Vminibuffer_completion_confirm = Qnil;
2028 DEFVAR_LISP ("minibuffer-completing-file-name",
2029 Vminibuffer_completing_file_name,
2030 doc: /* Non-nil means completing file names. */);
2031 Vminibuffer_completing_file_name = Qnil;
2033 DEFVAR_LISP ("minibuffer-help-form", Vminibuffer_help_form,
2034 doc: /* Value that `help-form' takes on inside the minibuffer. */);
2035 Vminibuffer_help_form = Qnil;
2037 DEFVAR_LISP ("minibuffer-history-variable", Vminibuffer_history_variable,
2038 doc: /* History list symbol to add minibuffer values to.
2039 Each string of minibuffer input, as it appears on exit from the minibuffer,
2040 is added with
2041 (set minibuffer-history-variable
2042 (cons STRING (symbol-value minibuffer-history-variable))) */);
2043 XSETFASTINT (Vminibuffer_history_variable, 0);
2045 DEFVAR_LISP ("minibuffer-history-position", Vminibuffer_history_position,
2046 doc: /* Current position of redoing in the history list. */);
2047 Vminibuffer_history_position = Qnil;
2049 DEFVAR_BOOL ("minibuffer-auto-raise", minibuffer_auto_raise,
2050 doc: /* Non-nil means entering the minibuffer raises the minibuffer's frame.
2051 Some uses of the echo area also raise that frame (since they use it too). */);
2052 minibuffer_auto_raise = 0;
2054 DEFVAR_LISP ("completion-regexp-list", Vcompletion_regexp_list,
2055 doc: /* List of regexps that should restrict possible completions.
2056 The basic completion functions only consider a completion acceptable
2057 if it matches all regular expressions in this list, with
2058 `case-fold-search' bound to the value of `completion-ignore-case'.
2059 See Info node `(elisp)Basic Completion', for a description of these
2060 functions. */);
2061 Vcompletion_regexp_list = Qnil;
2063 DEFVAR_BOOL ("minibuffer-allow-text-properties",
2064 minibuffer_allow_text_properties,
2065 doc: /* Non-nil means `read-from-minibuffer' should not discard text properties.
2066 This also affects `read-string', but it does not affect `read-minibuffer',
2067 `read-no-blanks-input', or any of the functions that do minibuffer input
2068 with completion; they always discard text properties. */);
2069 minibuffer_allow_text_properties = 0;
2071 DEFVAR_LISP ("minibuffer-prompt-properties", Vminibuffer_prompt_properties,
2072 doc: /* Text properties that are added to minibuffer prompts.
2073 These are in addition to the basic `field' property, and stickiness
2074 properties. */);
2075 /* We use `intern' here instead of Qread_only to avoid
2076 initialization-order problems. */
2077 Vminibuffer_prompt_properties = list2 (intern_c_string ("read-only"), Qt);
2079 defsubr (&Sactive_minibuffer_window);
2080 defsubr (&Sset_minibuffer_window);
2081 defsubr (&Sread_from_minibuffer);
2082 defsubr (&Sread_string);
2083 defsubr (&Sread_command);
2084 defsubr (&Sread_variable);
2085 defsubr (&Sinternal_complete_buffer);
2086 defsubr (&Sread_buffer);
2087 defsubr (&Sread_no_blanks_input);
2088 defsubr (&Sminibuffer_depth);
2089 defsubr (&Sminibuffer_prompt);
2091 defsubr (&Sminibufferp);
2092 defsubr (&Sminibuffer_prompt_end);
2093 defsubr (&Sminibuffer_contents);
2094 defsubr (&Sminibuffer_contents_no_properties);
2095 defsubr (&Sminibuffer_completion_contents);
2097 defsubr (&Stry_completion);
2098 defsubr (&Sall_completions);
2099 defsubr (&Stest_completion);
2100 defsubr (&Sassoc_string);
2101 defsubr (&Scompleting_read);