* doc/man/emacsclient.1: Tiny markup fix
[emacs.git] / src / minibuf.c
blob3042b13b7d652cf52c55421303aa5a5f31def582
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;
387 Lisp_Object histval;
389 Lisp_Object empty_minibuf;
390 Lisp_Object dummy, frame;
392 specbind (Qminibuffer_default, defalt);
393 specbind (intern ("inhibit-read-only"), Qnil);
395 /* If Vminibuffer_completing_file_name is `lambda' on entry, it was t
396 in previous recursive minibuffer, but was not set explicitly
397 to t for this invocation, so set it to nil in this minibuffer.
398 Save the old value now, before we change it. */
399 specbind (intern ("minibuffer-completing-file-name"),
400 Vminibuffer_completing_file_name);
401 if (EQ (Vminibuffer_completing_file_name, Qlambda))
402 Vminibuffer_completing_file_name = Qnil;
404 #ifdef HAVE_WINDOW_SYSTEM
405 if (display_hourglass_p)
406 cancel_hourglass ();
407 #endif
409 if (!NILP (initial))
411 if (CONSP (initial))
413 Lisp_Object backup_n = XCDR (initial);
414 initial = XCAR (initial);
415 CHECK_STRING (initial);
416 if (!NILP (backup_n))
418 CHECK_NUMBER (backup_n);
419 /* Convert to distance from end of input. */
420 if (XINT (backup_n) < 1)
421 /* A number too small means the beginning of the string. */
422 pos = - SCHARS (initial);
423 else
424 pos = XINT (backup_n) - 1 - SCHARS (initial);
427 else
428 CHECK_STRING (initial);
430 val = Qnil;
431 ambient_dir = BVAR (current_buffer, directory);
432 input_method = Qnil;
433 enable_multibyte = Qnil;
435 /* Don't need to protect PROMPT, HISTVAR, and HISTPOS because we
436 store them away before we can GC. Don't need to protect
437 BACKUP_N because we use the value only if it is an integer. */
438 GCPRO5 (map, initial, val, ambient_dir, input_method);
440 if (!STRINGP (prompt))
441 prompt = empty_unibyte_string;
443 if (!enable_recursive_minibuffers
444 && minibuf_level > 0)
446 if (EQ (selected_window, minibuf_window))
447 error ("Command attempted to use minibuffer while in minibuffer");
448 else
449 /* If we're in another window, cancel the minibuffer that's active. */
450 Fthrow (Qexit,
451 build_string ("Command attempted to use minibuffer while in minibuffer"));
454 if ((noninteractive
455 /* In case we are running as a daemon, only do this before
456 detaching from the terminal. */
457 || (IS_DAEMON && (daemon_pipe[1] >= 0)))
458 && NILP (Vexecuting_kbd_macro))
460 val = read_minibuf_noninteractive (map, initial, prompt,
461 make_number (pos),
462 expflag, histvar, histpos, defalt,
463 allow_props, inherit_input_method);
464 UNGCPRO;
465 return unbind_to (count, val);
468 /* Choose the minibuffer window and frame, and take action on them. */
470 /* Prepare for restoring the current buffer since choose_minibuf_frame
471 calling Fset_frame_selected_window may change it (Bug#12766). */
472 record_unwind_protect (restore_buffer, Fcurrent_buffer ());
474 choose_minibuf_frame ();
476 record_unwind_protect_void (choose_minibuf_frame);
478 record_unwind_protect (restore_window_configuration,
479 Fcurrent_window_configuration (Qnil));
481 /* If the minibuffer window is on a different frame, save that
482 frame's configuration too. */
483 mini_frame = WINDOW_FRAME (XWINDOW (minibuf_window));
484 if (!EQ (mini_frame, selected_frame))
485 record_unwind_protect (restore_window_configuration,
486 Fcurrent_window_configuration (mini_frame));
488 /* If the minibuffer is on an iconified or invisible frame,
489 make it visible now. */
490 Fmake_frame_visible (mini_frame);
492 if (minibuffer_auto_raise)
493 Fraise_frame (mini_frame);
495 temporarily_switch_to_single_kboard (XFRAME (mini_frame));
497 /* We have to do this after saving the window configuration
498 since that is what restores the current buffer. */
500 /* Arrange to restore a number of minibuffer-related variables.
501 We could bind each variable separately, but that would use lots of
502 specpdl slots. */
503 minibuf_save_list
504 = Fcons (Voverriding_local_map,
505 Fcons (minibuf_window,
506 minibuf_save_list));
507 minibuf_save_list
508 = Fcons (minibuf_prompt,
509 Fcons (make_number (minibuf_prompt_width),
510 Fcons (Vhelp_form,
511 Fcons (Vcurrent_prefix_arg,
512 Fcons (Vminibuffer_history_position,
513 Fcons (Vminibuffer_history_variable,
514 minibuf_save_list))))));
516 record_unwind_protect_void (read_minibuf_unwind);
517 minibuf_level++;
518 /* We are exiting the minibuffer one way or the other, so run the hook.
519 It should be run before unwinding the minibuf settings. Do it
520 separately from read_minibuf_unwind because we need to make sure that
521 read_minibuf_unwind is fully executed even if exit-minibuffer-hook
522 signals an error. --Stef */
523 record_unwind_protect_void (run_exit_minibuf_hook);
525 /* Now that we can restore all those variables, start changing them. */
527 minibuf_prompt_width = 0;
528 minibuf_prompt = Fcopy_sequence (prompt);
529 Vminibuffer_history_position = histpos;
530 Vminibuffer_history_variable = histvar;
531 Vhelp_form = Vminibuffer_help_form;
532 /* If this minibuffer is reading a file name, that doesn't mean
533 recursive ones are. But we cannot set it to nil, because
534 completion code still need to know the minibuffer is completing a
535 file name. So use `lambda' as intermediate value meaning
536 "t" in this minibuffer, but "nil" in next minibuffer. */
537 if (!NILP (Vminibuffer_completing_file_name))
538 Vminibuffer_completing_file_name = Qlambda;
540 /* If variable is unbound, make it nil. */
541 histval = find_symbol_value (Vminibuffer_history_variable);
542 if (EQ (histval, Qunbound))
544 Fset (Vminibuffer_history_variable, Qnil);
545 histval = Qnil;
548 if (inherit_input_method)
550 /* `current-input-method' is buffer local. So, remember it in
551 INPUT_METHOD before changing the current buffer. */
552 input_method = Fsymbol_value (Qcurrent_input_method);
553 enable_multibyte = BVAR (current_buffer, enable_multibyte_characters);
556 /* Switch to the minibuffer. */
558 minibuffer = get_minibuffer (minibuf_level);
559 Fset_buffer (minibuffer);
561 /* Defeat (setq-default truncate-lines t), since truncated lines do
562 not work correctly in minibuffers. (Bug#5715, etc) */
563 bset_truncate_lines (current_buffer, Qnil);
565 /* If appropriate, copy enable-multibyte-characters into the minibuffer. */
566 if (inherit_input_method)
567 bset_enable_multibyte_characters (current_buffer, enable_multibyte);
569 /* The current buffer's default directory is usually the right thing
570 for our minibuffer here. However, if you're typing a command at
571 a minibuffer-only frame when minibuf_level is zero, then buf IS
572 the current_buffer, so reset_buffer leaves buf's default
573 directory unchanged. This is a bummer when you've just started
574 up Emacs and buf's default directory is Qnil. Here's a hack; can
575 you think of something better to do? Find another buffer with a
576 better directory, and use that one instead. */
577 if (STRINGP (ambient_dir))
578 bset_directory (current_buffer, ambient_dir);
579 else
581 Lisp_Object tail, buf;
583 FOR_EACH_LIVE_BUFFER (tail, buf)
584 if (STRINGP (BVAR (XBUFFER (buf), directory)))
586 bset_directory (current_buffer,
587 BVAR (XBUFFER (buf), directory));
588 break;
592 if (!EQ (mini_frame, selected_frame))
593 Fredirect_frame_focus (selected_frame, mini_frame);
595 Vminibuf_scroll_window = selected_window;
596 if (minibuf_level == 1 || !EQ (minibuf_window, selected_window))
597 minibuf_selected_window = selected_window;
599 /* Empty out the minibuffers of all frames other than the one
600 where we are going to display one now.
601 Set them to point to ` *Minibuf-0*', which is always empty. */
602 empty_minibuf = get_minibuffer (0);
604 FOR_EACH_FRAME (dummy, frame)
606 Lisp_Object root_window = Fframe_root_window (frame);
607 Lisp_Object mini_window = XWINDOW (root_window)->next;
609 if (! NILP (mini_window) && ! EQ (mini_window, minibuf_window)
610 && !NILP (Fwindow_minibuffer_p (mini_window)))
611 /* Use set_window_buffer instead of Fset_window_buffer (see
612 discussion of bug#11984, bug#12025, bug#12026). */
613 set_window_buffer (mini_window, empty_minibuf, 0, 0);
616 /* Display this minibuffer in the proper window. */
617 /* Use set_window_buffer instead of Fset_window_buffer (see
618 discussion of bug#11984, bug#12025, bug#12026). */
619 set_window_buffer (minibuf_window, Fcurrent_buffer (), 0, 0);
620 Fselect_window (minibuf_window, Qnil);
621 XWINDOW (minibuf_window)->hscroll = 0;
623 Fmake_local_variable (Qprint_escape_newlines);
624 print_escape_newlines = 1;
626 /* Erase the buffer. */
628 ptrdiff_t count1 = SPECPDL_INDEX ();
629 specbind (Qinhibit_read_only, Qt);
630 specbind (Qinhibit_modification_hooks, Qt);
631 Ferase_buffer ();
633 if (!NILP (BVAR (current_buffer, enable_multibyte_characters))
634 && ! STRING_MULTIBYTE (minibuf_prompt))
635 minibuf_prompt = Fstring_make_multibyte (minibuf_prompt);
637 /* Insert the prompt, record where it ends. */
638 Finsert (1, &minibuf_prompt);
639 if (PT > BEG)
641 Fput_text_property (make_number (BEG), make_number (PT),
642 Qfront_sticky, Qt, Qnil);
643 Fput_text_property (make_number (BEG), make_number (PT),
644 Qrear_nonsticky, Qt, Qnil);
645 Fput_text_property (make_number (BEG), make_number (PT),
646 Qfield, Qt, Qnil);
647 Fadd_text_properties (make_number (BEG), make_number (PT),
648 Vminibuffer_prompt_properties, Qnil);
650 unbind_to (count1, Qnil);
653 minibuf_prompt_width = current_column ();
655 /* Put in the initial input. */
656 if (!NILP (initial))
658 Finsert (1, &initial);
659 Fforward_char (make_number (pos));
662 clear_message (1, 1);
663 bset_keymap (current_buffer, map);
665 /* Turn on an input method stored in INPUT_METHOD if any. */
666 if (STRINGP (input_method) && !NILP (Ffboundp (Qactivate_input_method)))
667 call1 (Qactivate_input_method, input_method);
669 Frun_hooks (1, &Qminibuffer_setup_hook);
671 /* Don't allow the user to undo past this point. */
672 bset_undo_list (current_buffer, Qnil);
674 recursive_edit_1 ();
676 /* If cursor is on the minibuffer line,
677 show the user we have exited by putting it in column 0. */
678 if (XWINDOW (minibuf_window)->cursor.vpos >= 0
679 && !noninteractive)
681 XWINDOW (minibuf_window)->cursor.hpos = 0;
682 XWINDOW (minibuf_window)->cursor.x = 0;
683 XWINDOW (minibuf_window)->must_be_updated_p = 1;
684 update_frame (XFRAME (selected_frame), 1, 1);
685 flush_frame (XFRAME (XWINDOW (minibuf_window)->frame));
688 /* Make minibuffer contents into a string. */
689 Fset_buffer (minibuffer);
690 if (allow_props)
691 val = Fminibuffer_contents ();
692 else
693 val = Fminibuffer_contents_no_properties ();
695 /* VAL is the string of minibuffer text. */
697 last_minibuf_string = val;
699 /* Choose the string to add to the history. */
700 if (SCHARS (val) != 0)
701 histstring = val;
702 else if (STRINGP (defalt))
703 histstring = defalt;
704 else if (CONSP (defalt) && STRINGP (XCAR (defalt)))
705 histstring = XCAR (defalt);
706 else
707 histstring = Qnil;
709 /* Add the value to the appropriate history list, if any. */
710 if (!NILP (Vhistory_add_new_input)
711 && SYMBOLP (Vminibuffer_history_variable)
712 && !NILP (histstring))
714 /* If the caller wanted to save the value read on a history list,
715 then do so if the value is not already the front of the list. */
717 /* The value of the history variable must be a cons or nil. Other
718 values are unacceptable. We silently ignore these values. */
720 if (NILP (histval)
721 || (CONSP (histval)
722 /* Don't duplicate the most recent entry in the history. */
723 && (NILP (Fequal (histstring, Fcar (histval))))))
725 Lisp_Object length;
727 if (history_delete_duplicates) Fdelete (histstring, histval);
728 histval = Fcons (histstring, histval);
729 Fset (Vminibuffer_history_variable, histval);
731 /* Truncate if requested. */
732 length = Fget (Vminibuffer_history_variable, Qhistory_length);
733 if (NILP (length)) length = Vhistory_length;
734 if (INTEGERP (length))
736 if (XINT (length) <= 0)
737 Fset (Vminibuffer_history_variable, Qnil);
738 else
740 Lisp_Object temp;
742 temp = Fnthcdr (Fsub1 (length), histval);
743 if (CONSP (temp)) Fsetcdr (temp, Qnil);
749 /* If Lisp form desired instead of string, parse it. */
750 if (expflag)
751 val = string_to_object (val, defalt);
753 /* The appropriate frame will get selected
754 in set-window-configuration. */
755 UNGCPRO;
756 return unbind_to (count, val);
759 /* Return a buffer to be used as the minibuffer at depth `depth'.
760 depth = 0 is the lowest allowed argument, and that is the value
761 used for nonrecursive minibuffer invocations. */
763 Lisp_Object
764 get_minibuffer (EMACS_INT depth)
766 Lisp_Object tail, num, buf;
767 char name[sizeof " *Minibuf-*" + INT_STRLEN_BOUND (EMACS_INT)];
769 XSETFASTINT (num, depth);
770 tail = Fnthcdr (num, Vminibuffer_list);
771 if (NILP (tail))
773 tail = list1 (Qnil);
774 Vminibuffer_list = nconc2 (Vminibuffer_list, tail);
776 buf = Fcar (tail);
777 if (NILP (buf) || !BUFFER_LIVE_P (XBUFFER (buf)))
779 buf = Fget_buffer_create
780 (make_formatted_string (name, " *Minibuf-%"pI"d*", depth));
782 /* Although the buffer's name starts with a space, undo should be
783 enabled in it. */
784 Fbuffer_enable_undo (buf);
786 XSETCAR (tail, buf);
788 else
790 ptrdiff_t count = SPECPDL_INDEX ();
791 /* We have to empty both overlay lists. Otherwise we end
792 up with overlays that think they belong to this buffer
793 while the buffer doesn't know about them any more. */
794 delete_all_overlays (XBUFFER (buf));
795 reset_buffer (XBUFFER (buf));
796 record_unwind_current_buffer ();
797 Fset_buffer (buf);
798 if (!NILP (Ffboundp (intern ("minibuffer-inactive-mode"))))
799 call0 (intern ("minibuffer-inactive-mode"));
800 else
801 Fkill_all_local_variables ();
802 unbind_to (count, Qnil);
805 return buf;
808 static void
809 run_exit_minibuf_hook (void)
811 safe_run_hooks (Qminibuffer_exit_hook);
814 /* This function is called on exiting minibuffer, whether normally or
815 not, and it restores the current window, buffer, etc. */
817 static void
818 read_minibuf_unwind (void)
820 Lisp_Object old_deactivate_mark;
821 Lisp_Object window;
823 /* If this was a recursive minibuffer,
824 tie the minibuffer window back to the outer level minibuffer buffer. */
825 minibuf_level--;
827 window = minibuf_window;
828 /* To keep things predictable, in case it matters, let's be in the
829 minibuffer when we reset the relevant variables. */
830 Fset_buffer (XWINDOW (window)->contents);
832 /* Restore prompt, etc, from outer minibuffer level. */
833 minibuf_prompt = Fcar (minibuf_save_list);
834 minibuf_save_list = Fcdr (minibuf_save_list);
835 minibuf_prompt_width = XFASTINT (Fcar (minibuf_save_list));
836 minibuf_save_list = Fcdr (minibuf_save_list);
837 Vhelp_form = Fcar (minibuf_save_list);
838 minibuf_save_list = Fcdr (minibuf_save_list);
839 Vcurrent_prefix_arg = Fcar (minibuf_save_list);
840 minibuf_save_list = Fcdr (minibuf_save_list);
841 Vminibuffer_history_position = Fcar (minibuf_save_list);
842 minibuf_save_list = Fcdr (minibuf_save_list);
843 Vminibuffer_history_variable = Fcar (minibuf_save_list);
844 minibuf_save_list = Fcdr (minibuf_save_list);
845 Voverriding_local_map = Fcar (minibuf_save_list);
846 minibuf_save_list = Fcdr (minibuf_save_list);
847 #if 0
848 temp = Fcar (minibuf_save_list);
849 if (FRAME_LIVE_P (XFRAME (WINDOW_FRAME (XWINDOW (temp)))))
850 minibuf_window = temp;
851 #endif
852 minibuf_save_list = Fcdr (minibuf_save_list);
854 /* Erase the minibuffer we were using at this level. */
856 ptrdiff_t count = SPECPDL_INDEX ();
857 /* Prevent error in erase-buffer. */
858 specbind (Qinhibit_read_only, Qt);
859 specbind (Qinhibit_modification_hooks, Qt);
860 old_deactivate_mark = Vdeactivate_mark;
861 Ferase_buffer ();
862 Vdeactivate_mark = old_deactivate_mark;
863 unbind_to (count, Qnil);
866 /* When we get to the outmost level, make sure we resize the
867 mini-window back to its normal size. */
868 if (minibuf_level == 0)
869 resize_mini_window (XWINDOW (window), 0);
871 /* In case the previous minibuffer displayed in this miniwindow is
872 dead, we may keep displaying this buffer (tho it's inactive), so reset it,
873 to make sure we don't leave around bindings and stuff which only
874 made sense during the read_minibuf invocation. */
875 call0 (intern ("minibuffer-inactive-mode"));
879 DEFUN ("read-from-minibuffer", Fread_from_minibuffer,
880 Sread_from_minibuffer, 1, 7, 0,
881 doc: /* Read a string from the minibuffer, prompting with string PROMPT.
882 The optional second arg INITIAL-CONTENTS is an obsolete alternative to
883 DEFAULT-VALUE. It normally should be nil in new code, except when
884 HIST is a cons. It is discussed in more detail below.
886 Third arg KEYMAP is a keymap to use whilst reading;
887 if omitted or nil, the default is `minibuffer-local-map'.
889 If fourth arg READ is non-nil, interpret the result as a Lisp object
890 and return that object:
891 in other words, do `(car (read-from-string INPUT-STRING))'
893 Fifth arg HIST, if non-nil, specifies a history list and optionally
894 the initial position in the list. It can be a symbol, which is the
895 history list variable to use, or a cons cell (HISTVAR . HISTPOS).
896 In that case, HISTVAR is the history list variable to use, and
897 HISTPOS is the initial position for use by the minibuffer history
898 commands. For consistency, you should also specify that element of
899 the history as the value of INITIAL-CONTENTS. Positions are counted
900 starting from 1 at the beginning of the list.
902 Sixth arg DEFAULT-VALUE, if non-nil, should be a string, which is used
903 as the default to `read' if READ is non-nil and the user enters
904 empty input. But if READ is nil, this function does _not_ return
905 DEFAULT-VALUE for empty input! Instead, it returns the empty string.
907 Whatever the value of READ, DEFAULT-VALUE is made available via the
908 minibuffer history commands. DEFAULT-VALUE can also be a list of
909 strings, in which case all the strings are available in the history,
910 and the first string is the default to `read' if READ is non-nil.
912 Seventh arg INHERIT-INPUT-METHOD, if non-nil, means the minibuffer inherits
913 the current input method and the setting of `enable-multibyte-characters'.
915 If the variable `minibuffer-allow-text-properties' is non-nil,
916 then the string which is returned includes whatever text properties
917 were present in the minibuffer. Otherwise the value has no text properties.
919 The remainder of this documentation string describes the
920 INITIAL-CONTENTS argument in more detail. It is only relevant when
921 studying existing code, or when HIST is a cons. If non-nil,
922 INITIAL-CONTENTS is a string to be inserted into the minibuffer before
923 reading input. Normally, point is put at the end of that string.
924 However, if INITIAL-CONTENTS is \(STRING . POSITION), the initial
925 input is STRING, but point is placed at _one-indexed_ position
926 POSITION in the minibuffer. Any integer value less than or equal to
927 one puts point at the beginning of the string. *Note* that this
928 behavior differs from the way such arguments are used in `completing-read'
929 and some related functions, which use zero-indexing for POSITION. */)
930 (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)
932 Lisp_Object histvar, histpos, val;
933 struct gcpro gcpro1;
935 CHECK_STRING (prompt);
936 if (NILP (keymap))
937 keymap = Vminibuffer_local_map;
938 else
939 keymap = get_keymap (keymap, 1, 0);
941 if (SYMBOLP (hist))
943 histvar = hist;
944 histpos = Qnil;
946 else
948 histvar = Fcar_safe (hist);
949 histpos = Fcdr_safe (hist);
951 if (NILP (histvar))
952 histvar = Qminibuffer_history;
953 if (NILP (histpos))
954 XSETFASTINT (histpos, 0);
956 GCPRO1 (default_value);
957 val = read_minibuf (keymap, initial_contents, prompt,
958 !NILP (read),
959 histvar, histpos, default_value,
960 minibuffer_allow_text_properties,
961 !NILP (inherit_input_method));
962 UNGCPRO;
963 return val;
966 /* Functions that use the minibuffer to read various things. */
968 DEFUN ("read-string", Fread_string, Sread_string, 1, 5, 0,
969 doc: /* Read a string from the minibuffer, prompting with string PROMPT.
970 If non-nil, second arg INITIAL-INPUT is a string to insert before reading.
971 This argument has been superseded by DEFAULT-VALUE and should normally be nil
972 in new code. It behaves as INITIAL-CONTENTS in `read-from-minibuffer' (which
973 see).
974 The third arg HISTORY, if non-nil, specifies a history list
975 and optionally the initial position in the list.
976 See `read-from-minibuffer' for details of HISTORY argument.
977 Fourth arg DEFAULT-VALUE is the default value or the list of default values.
978 If non-nil, it is used for history commands, and as the value (or the first
979 element of the list of default values) to return if the user enters the
980 empty string.
981 Fifth arg INHERIT-INPUT-METHOD, if non-nil, means the minibuffer inherits
982 the current input method and the setting of `enable-multibyte-characters'. */)
983 (Lisp_Object prompt, Lisp_Object initial_input, Lisp_Object history, Lisp_Object default_value, Lisp_Object inherit_input_method)
985 Lisp_Object val;
986 ptrdiff_t count = SPECPDL_INDEX ();
988 /* Just in case we're in a recursive minibuffer, make it clear that the
989 previous minibuffer's completion table does not apply to the new
990 minibuffer.
991 FIXME: `minibuffer-completion-table' should be buffer-local instead. */
992 specbind (Qminibuffer_completion_table, Qnil);
994 val = Fread_from_minibuffer (prompt, initial_input, Qnil,
995 Qnil, history, default_value,
996 inherit_input_method);
997 if (STRINGP (val) && SCHARS (val) == 0 && ! NILP (default_value))
998 val = CONSP (default_value) ? XCAR (default_value) : default_value;
999 return unbind_to (count, val);
1002 DEFUN ("read-no-blanks-input", Fread_no_blanks_input, Sread_no_blanks_input, 1, 3, 0,
1003 doc: /* Read a string from the terminal, not allowing blanks.
1004 Prompt with PROMPT. Whitespace terminates the input. If INITIAL is
1005 non-nil, it should be a string, which is used as initial input, with
1006 point positioned at the end, so that SPACE will accept the input.
1007 \(Actually, INITIAL can also be a cons of a string and an integer.
1008 Such values are treated as in `read-from-minibuffer', but are normally
1009 not useful in this function.)
1010 Third arg INHERIT-INPUT-METHOD, if non-nil, means the minibuffer inherits
1011 the current input method and the setting of`enable-multibyte-characters'. */)
1012 (Lisp_Object prompt, Lisp_Object initial, Lisp_Object inherit_input_method)
1014 CHECK_STRING (prompt);
1015 return read_minibuf (Vminibuffer_local_ns_map, initial, prompt,
1016 0, Qminibuffer_history, make_number (0), Qnil, 0,
1017 !NILP (inherit_input_method));
1020 DEFUN ("read-command", Fread_command, Sread_command, 1, 2, 0,
1021 doc: /* Read the name of a command and return as a symbol.
1022 Prompt with PROMPT. By default, return DEFAULT-VALUE or its first element
1023 if it is a list. */)
1024 (Lisp_Object prompt, Lisp_Object default_value)
1026 Lisp_Object name, default_string;
1028 if (NILP (default_value))
1029 default_string = Qnil;
1030 else if (SYMBOLP (default_value))
1031 default_string = SYMBOL_NAME (default_value);
1032 else
1033 default_string = default_value;
1035 name = Fcompleting_read (prompt, Vobarray, Qcommandp, Qt,
1036 Qnil, Qnil, default_string, Qnil);
1037 if (NILP (name))
1038 return name;
1039 return Fintern (name, Qnil);
1042 #ifdef NOTDEF
1043 DEFUN ("read-function", Fread_function, Sread_function, 1, 1, 0,
1044 doc: /* One arg PROMPT, a string. Read the name of a function and return as a symbol.
1045 Prompt with PROMPT. */)
1046 (Lisp_Object prompt)
1048 return Fintern (Fcompleting_read (prompt, Vobarray, Qfboundp, Qt, Qnil, Qnil, Qnil, Qnil),
1049 Qnil);
1051 #endif /* NOTDEF */
1053 DEFUN ("read-variable", Fread_variable, Sread_variable, 1, 2, 0,
1054 doc: /* Read the name of a user option and return it as a symbol.
1055 Prompt with PROMPT. By default, return DEFAULT-VALUE or its first element
1056 if it is a list.
1057 A user option, or customizable variable, is one for which
1058 `custom-variable-p' returns non-nil. */)
1059 (Lisp_Object prompt, Lisp_Object default_value)
1061 Lisp_Object name, default_string;
1063 if (NILP (default_value))
1064 default_string = Qnil;
1065 else if (SYMBOLP (default_value))
1066 default_string = SYMBOL_NAME (default_value);
1067 else
1068 default_string = default_value;
1070 name = Fcompleting_read (prompt, Vobarray,
1071 Qcustom_variable_p, Qt,
1072 Qnil, Qnil, default_string, Qnil);
1073 if (NILP (name))
1074 return name;
1075 return Fintern (name, Qnil);
1078 DEFUN ("read-buffer", Fread_buffer, Sread_buffer, 1, 3, 0,
1079 doc: /* Read the name of a buffer and return as a string.
1080 Prompt with PROMPT.
1081 Optional second arg DEF is value to return if user enters an empty line.
1082 If DEF is a list of default values, return its first element.
1083 Optional third arg REQUIRE-MATCH determines whether non-existing
1084 buffer names are allowed. It has the same meaning as the
1085 REQUIRE-MATCH argument of `completing-read'.
1086 The argument PROMPT should be a string ending with a colon and a space.
1087 If `read-buffer-completion-ignore-case' is non-nil, completion ignores
1088 case while reading the buffer name.
1089 If `read-buffer-function' is non-nil, this works by calling it as a
1090 function, instead of the usual behavior. */)
1091 (Lisp_Object prompt, Lisp_Object def, Lisp_Object require_match)
1093 Lisp_Object args[4], result;
1094 char *s;
1095 ptrdiff_t len;
1096 ptrdiff_t count = SPECPDL_INDEX ();
1098 if (BUFFERP (def))
1099 def = BVAR (XBUFFER (def), name);
1101 specbind (Qcompletion_ignore_case,
1102 read_buffer_completion_ignore_case ? Qt : Qnil);
1104 if (NILP (Vread_buffer_function))
1106 if (!NILP (def))
1108 /* A default value was provided: we must change PROMPT,
1109 editing the default value in before the colon. To achieve
1110 this, we replace PROMPT with a substring that doesn't
1111 contain the terminal space and colon (if present). They
1112 are then added back using Fformat. */
1114 if (STRINGP (prompt))
1116 s = SSDATA (prompt);
1117 len = SBYTES (prompt);
1118 if (len >= 2 && s[len - 2] == ':' && s[len - 1] == ' ')
1119 len = len - 2;
1120 else if (len >= 1 && (s[len - 1] == ':' || s[len - 1] == ' '))
1121 len--;
1123 prompt = make_specified_string (s, -1, len,
1124 STRING_MULTIBYTE (prompt));
1127 args[0] = build_string ("%s (default %s): ");
1128 args[1] = prompt;
1129 args[2] = CONSP (def) ? XCAR (def) : def;
1130 prompt = Fformat (3, args);
1133 result = Fcompleting_read (prompt, intern ("internal-complete-buffer"),
1134 Qnil, require_match, Qnil,
1135 Qbuffer_name_history, def, Qnil);
1137 else
1139 args[0] = Vread_buffer_function;
1140 args[1] = prompt;
1141 args[2] = def;
1142 args[3] = require_match;
1143 result = Ffuncall (4, args);
1145 return unbind_to (count, result);
1148 static Lisp_Object
1149 minibuf_conform_representation (Lisp_Object string, Lisp_Object basis)
1151 if (STRING_MULTIBYTE (string) == STRING_MULTIBYTE (basis))
1152 return string;
1154 if (STRING_MULTIBYTE (string))
1155 return Fstring_make_unibyte (string);
1156 else
1157 return Fstring_make_multibyte (string);
1160 DEFUN ("try-completion", Ftry_completion, Stry_completion, 2, 3, 0,
1161 doc: /* Return common substring of all completions of STRING in COLLECTION.
1162 Test each possible completion specified by COLLECTION
1163 to see if it begins with STRING. The possible completions may be
1164 strings or symbols. Symbols are converted to strings before testing,
1165 see `symbol-name'.
1166 All that match STRING are compared together; the longest initial sequence
1167 common to all these matches is the return value.
1168 If there is no match at all, the return value is nil.
1169 For a unique match which is exact, the return value is t.
1171 If COLLECTION is an alist, the keys (cars of elements) are the
1172 possible completions. If an element is not a cons cell, then the
1173 element itself is the possible completion.
1174 If COLLECTION is a hash-table, all the keys that are strings or symbols
1175 are the possible completions.
1176 If COLLECTION is an obarray, the names of all symbols in the obarray
1177 are the possible completions.
1179 COLLECTION can also be a function to do the completion itself.
1180 It receives three arguments: the values STRING, PREDICATE and nil.
1181 Whatever it returns becomes the value of `try-completion'.
1183 If optional third argument PREDICATE is non-nil,
1184 it is used to test each possible match.
1185 The match is a candidate only if PREDICATE returns non-nil.
1186 The argument given to PREDICATE is the alist element
1187 or the symbol from the obarray. If COLLECTION is a hash-table,
1188 predicate is called with two arguments: the key and the value.
1189 Additionally to this predicate, `completion-regexp-list'
1190 is used to further constrain the set of candidates. */)
1191 (Lisp_Object string, Lisp_Object collection, Lisp_Object predicate)
1193 Lisp_Object bestmatch, tail, elt, eltstring;
1194 /* Size in bytes of BESTMATCH. */
1195 ptrdiff_t bestmatchsize = 0;
1196 /* These are in bytes, too. */
1197 ptrdiff_t compare, matchsize;
1198 enum { function_table, list_table, obarray_table, hash_table}
1199 type = (HASH_TABLE_P (collection) ? hash_table
1200 : VECTORP (collection) ? obarray_table
1201 : ((NILP (collection)
1202 || (CONSP (collection) && !FUNCTIONP (collection)))
1203 ? list_table : function_table));
1204 ptrdiff_t idx = 0, obsize = 0;
1205 int matchcount = 0;
1206 ptrdiff_t bindcount = -1;
1207 Lisp_Object bucket, zero, end, tem;
1208 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
1210 CHECK_STRING (string);
1211 if (type == function_table)
1212 return call3 (collection, string, predicate, Qnil);
1214 bestmatch = bucket = Qnil;
1215 zero = make_number (0);
1217 /* If COLLECTION is not a list, set TAIL just for gc pro. */
1218 tail = collection;
1219 if (type == obarray_table)
1221 collection = check_obarray (collection);
1222 obsize = ASIZE (collection);
1223 bucket = AREF (collection, idx);
1226 while (1)
1228 /* Get the next element of the alist, obarray, or hash-table. */
1229 /* Exit the loop if the elements are all used up. */
1230 /* elt gets the alist element or symbol.
1231 eltstring gets the name to check as a completion. */
1233 if (type == list_table)
1235 if (!CONSP (tail))
1236 break;
1237 elt = XCAR (tail);
1238 eltstring = CONSP (elt) ? XCAR (elt) : elt;
1239 tail = XCDR (tail);
1241 else if (type == obarray_table)
1243 if (!EQ (bucket, zero))
1245 if (!SYMBOLP (bucket))
1246 error ("Bad data in guts of obarray");
1247 elt = bucket;
1248 eltstring = elt;
1249 if (XSYMBOL (bucket)->next)
1250 XSETSYMBOL (bucket, XSYMBOL (bucket)->next);
1251 else
1252 XSETFASTINT (bucket, 0);
1254 else if (++idx >= obsize)
1255 break;
1256 else
1258 bucket = AREF (collection, idx);
1259 continue;
1262 else /* if (type == hash_table) */
1264 while (idx < HASH_TABLE_SIZE (XHASH_TABLE (collection))
1265 && NILP (HASH_HASH (XHASH_TABLE (collection), idx)))
1266 idx++;
1267 if (idx >= HASH_TABLE_SIZE (XHASH_TABLE (collection)))
1268 break;
1269 else
1270 elt = eltstring = HASH_KEY (XHASH_TABLE (collection), idx++);
1273 /* Is this element a possible completion? */
1275 if (SYMBOLP (eltstring))
1276 eltstring = Fsymbol_name (eltstring);
1278 if (STRINGP (eltstring)
1279 && SCHARS (string) <= SCHARS (eltstring)
1280 && (tem = Fcompare_strings (eltstring, zero,
1281 make_number (SCHARS (string)),
1282 string, zero, Qnil,
1283 completion_ignore_case ? Qt : Qnil),
1284 EQ (Qt, tem)))
1286 /* Yes. */
1287 Lisp_Object regexps;
1289 /* Ignore this element if it fails to match all the regexps. */
1291 for (regexps = Vcompletion_regexp_list; CONSP (regexps);
1292 regexps = XCDR (regexps))
1294 if (bindcount < 0) {
1295 bindcount = SPECPDL_INDEX ();
1296 specbind (Qcase_fold_search,
1297 completion_ignore_case ? Qt : Qnil);
1299 tem = Fstring_match (XCAR (regexps), eltstring, zero);
1300 if (NILP (tem))
1301 break;
1303 if (CONSP (regexps))
1304 continue;
1307 /* Ignore this element if there is a predicate
1308 and the predicate doesn't like it. */
1310 if (!NILP (predicate))
1312 if (EQ (predicate, Qcommandp))
1313 tem = Fcommandp (elt, Qnil);
1314 else
1316 if (bindcount >= 0)
1318 unbind_to (bindcount, Qnil);
1319 bindcount = -1;
1321 GCPRO4 (tail, string, eltstring, bestmatch);
1322 tem = (type == hash_table
1323 ? call2 (predicate, elt,
1324 HASH_VALUE (XHASH_TABLE (collection),
1325 idx - 1))
1326 : call1 (predicate, elt));
1327 UNGCPRO;
1329 if (NILP (tem)) continue;
1332 /* Update computation of how much all possible completions match */
1334 if (NILP (bestmatch))
1336 matchcount = 1;
1337 bestmatch = eltstring;
1338 bestmatchsize = SCHARS (eltstring);
1340 else
1342 compare = min (bestmatchsize, SCHARS (eltstring));
1343 tem = Fcompare_strings (bestmatch, zero,
1344 make_number (compare),
1345 eltstring, zero,
1346 make_number (compare),
1347 completion_ignore_case ? Qt : Qnil);
1348 matchsize = EQ (tem, Qt) ? compare : eabs (XINT (tem)) - 1;
1350 if (completion_ignore_case)
1352 /* If this is an exact match except for case,
1353 use it as the best match rather than one that is not an
1354 exact match. This way, we get the case pattern
1355 of the actual match. */
1356 if ((matchsize == SCHARS (eltstring)
1357 && matchsize < SCHARS (bestmatch))
1359 /* If there is more than one exact match ignoring case,
1360 and one of them is exact including case,
1361 prefer that one. */
1362 /* If there is no exact match ignoring case,
1363 prefer a match that does not change the case
1364 of the input. */
1365 ((matchsize == SCHARS (eltstring))
1367 (matchsize == SCHARS (bestmatch))
1368 && (tem = Fcompare_strings (eltstring, zero,
1369 make_number (SCHARS (string)),
1370 string, zero,
1371 Qnil,
1372 Qnil),
1373 EQ (Qt, tem))
1374 && (tem = Fcompare_strings (bestmatch, zero,
1375 make_number (SCHARS (string)),
1376 string, zero,
1377 Qnil,
1378 Qnil),
1379 ! EQ (Qt, tem))))
1380 bestmatch = eltstring;
1382 if (bestmatchsize != SCHARS (eltstring)
1383 || bestmatchsize != matchsize)
1384 /* Don't count the same string multiple times. */
1385 matchcount += matchcount <= 1;
1386 bestmatchsize = matchsize;
1387 if (matchsize <= SCHARS (string)
1388 /* If completion-ignore-case is non-nil, don't
1389 short-circuit because we want to find the best
1390 possible match *including* case differences. */
1391 && !completion_ignore_case
1392 && matchcount > 1)
1393 /* No need to look any further. */
1394 break;
1399 if (bindcount >= 0) {
1400 unbind_to (bindcount, Qnil);
1401 bindcount = -1;
1404 if (NILP (bestmatch))
1405 return Qnil; /* No completions found. */
1406 /* If we are ignoring case, and there is no exact match,
1407 and no additional text was supplied,
1408 don't change the case of what the user typed. */
1409 if (completion_ignore_case && bestmatchsize == SCHARS (string)
1410 && SCHARS (bestmatch) > bestmatchsize)
1411 return minibuf_conform_representation (string, bestmatch);
1413 /* Return t if the supplied string is an exact match (counting case);
1414 it does not require any change to be made. */
1415 if (matchcount == 1 && !NILP (Fequal (bestmatch, string)))
1416 return Qt;
1418 XSETFASTINT (zero, 0); /* Else extract the part in which */
1419 XSETFASTINT (end, bestmatchsize); /* all completions agree. */
1420 return Fsubstring (bestmatch, zero, end);
1423 DEFUN ("all-completions", Fall_completions, Sall_completions, 2, 4, 0,
1424 doc: /* Search for partial matches to STRING in COLLECTION.
1425 Test each of the possible completions specified by COLLECTION
1426 to see if it begins with STRING. The possible completions may be
1427 strings or symbols. Symbols are converted to strings before testing,
1428 see `symbol-name'.
1429 The value is a list of all the possible completions that match STRING.
1431 If COLLECTION is an alist, the keys (cars of elements) are the
1432 possible completions. If an element is not a cons cell, then the
1433 element itself is the possible completion.
1434 If COLLECTION is a hash-table, all the keys that are strings or symbols
1435 are the possible completions.
1436 If COLLECTION is an obarray, the names of all symbols in the obarray
1437 are the possible completions.
1439 COLLECTION can also be a function to do the completion itself.
1440 It receives three arguments: the values STRING, PREDICATE and t.
1441 Whatever it returns becomes the value of `all-completions'.
1443 If optional third argument PREDICATE is non-nil,
1444 it is used to test each possible match.
1445 The match is a candidate only if PREDICATE returns non-nil.
1446 The argument given to PREDICATE is the alist element
1447 or the symbol from the obarray. If COLLECTION is a hash-table,
1448 predicate is called with two arguments: the key and the value.
1449 Additionally to this predicate, `completion-regexp-list'
1450 is used to further constrain the set of candidates.
1452 An obsolete optional fourth argument HIDE-SPACES is still accepted for
1453 backward compatibility. If non-nil, strings in COLLECTION that start
1454 with a space are ignored unless STRING itself starts with a space. */)
1455 (Lisp_Object string, Lisp_Object collection, Lisp_Object predicate, Lisp_Object hide_spaces)
1457 Lisp_Object tail, elt, eltstring;
1458 Lisp_Object allmatches;
1459 int type = HASH_TABLE_P (collection) ? 3
1460 : VECTORP (collection) ? 2
1461 : NILP (collection) || (CONSP (collection) && !FUNCTIONP (collection));
1462 ptrdiff_t idx = 0, obsize = 0;
1463 ptrdiff_t bindcount = -1;
1464 Lisp_Object bucket, tem, zero;
1465 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
1467 CHECK_STRING (string);
1468 if (type == 0)
1469 return call3 (collection, string, predicate, Qt);
1470 allmatches = bucket = Qnil;
1471 zero = make_number (0);
1473 /* If COLLECTION is not a list, set TAIL just for gc pro. */
1474 tail = collection;
1475 if (type == 2)
1477 collection = check_obarray (collection);
1478 obsize = ASIZE (collection);
1479 bucket = AREF (collection, idx);
1482 while (1)
1484 /* Get the next element of the alist, obarray, or hash-table. */
1485 /* Exit the loop if the elements are all used up. */
1486 /* elt gets the alist element or symbol.
1487 eltstring gets the name to check as a completion. */
1489 if (type == 1)
1491 if (!CONSP (tail))
1492 break;
1493 elt = XCAR (tail);
1494 eltstring = CONSP (elt) ? XCAR (elt) : elt;
1495 tail = XCDR (tail);
1497 else if (type == 2)
1499 if (!EQ (bucket, zero))
1501 if (!SYMBOLP (bucket))
1502 error ("Bad data in guts of obarray");
1503 elt = bucket;
1504 eltstring = elt;
1505 if (XSYMBOL (bucket)->next)
1506 XSETSYMBOL (bucket, XSYMBOL (bucket)->next);
1507 else
1508 XSETFASTINT (bucket, 0);
1510 else if (++idx >= obsize)
1511 break;
1512 else
1514 bucket = AREF (collection, idx);
1515 continue;
1518 else /* if (type == 3) */
1520 while (idx < HASH_TABLE_SIZE (XHASH_TABLE (collection))
1521 && NILP (HASH_HASH (XHASH_TABLE (collection), idx)))
1522 idx++;
1523 if (idx >= HASH_TABLE_SIZE (XHASH_TABLE (collection)))
1524 break;
1525 else
1526 elt = eltstring = HASH_KEY (XHASH_TABLE (collection), idx++);
1529 /* Is this element a possible completion? */
1531 if (SYMBOLP (eltstring))
1532 eltstring = Fsymbol_name (eltstring);
1534 if (STRINGP (eltstring)
1535 && SCHARS (string) <= SCHARS (eltstring)
1536 /* If HIDE_SPACES, reject alternatives that start with space
1537 unless the input starts with space. */
1538 && (NILP (hide_spaces)
1539 || (SBYTES (string) > 0
1540 && SREF (string, 0) == ' ')
1541 || SREF (eltstring, 0) != ' ')
1542 && (tem = Fcompare_strings (eltstring, zero,
1543 make_number (SCHARS (string)),
1544 string, zero,
1545 make_number (SCHARS (string)),
1546 completion_ignore_case ? Qt : Qnil),
1547 EQ (Qt, tem)))
1549 /* Yes. */
1550 Lisp_Object regexps;
1552 /* Ignore this element if it fails to match all the regexps. */
1554 for (regexps = Vcompletion_regexp_list; CONSP (regexps);
1555 regexps = XCDR (regexps))
1557 if (bindcount < 0) {
1558 bindcount = SPECPDL_INDEX ();
1559 specbind (Qcase_fold_search,
1560 completion_ignore_case ? Qt : Qnil);
1562 tem = Fstring_match (XCAR (regexps), eltstring, zero);
1563 if (NILP (tem))
1564 break;
1566 if (CONSP (regexps))
1567 continue;
1570 /* Ignore this element if there is a predicate
1571 and the predicate doesn't like it. */
1573 if (!NILP (predicate))
1575 if (EQ (predicate, Qcommandp))
1576 tem = Fcommandp (elt, Qnil);
1577 else
1579 if (bindcount >= 0) {
1580 unbind_to (bindcount, Qnil);
1581 bindcount = -1;
1583 GCPRO4 (tail, eltstring, allmatches, string);
1584 tem = type == 3
1585 ? call2 (predicate, elt,
1586 HASH_VALUE (XHASH_TABLE (collection), idx - 1))
1587 : call1 (predicate, elt);
1588 UNGCPRO;
1590 if (NILP (tem)) continue;
1592 /* Ok => put it on the list. */
1593 allmatches = Fcons (eltstring, allmatches);
1597 if (bindcount >= 0) {
1598 unbind_to (bindcount, Qnil);
1599 bindcount = -1;
1602 return Fnreverse (allmatches);
1605 DEFUN ("completing-read", Fcompleting_read, Scompleting_read, 2, 8, 0,
1606 doc: /* Read a string in the minibuffer, with completion.
1607 PROMPT is a string to prompt with; normally it ends in a colon and a space.
1608 COLLECTION can be a list of strings, an alist, an obarray or a hash table.
1609 COLLECTION can also be a function to do the completion itself.
1610 PREDICATE limits completion to a subset of COLLECTION.
1611 See `try-completion' and `all-completions' for more details
1612 on completion, COLLECTION, and PREDICATE.
1614 REQUIRE-MATCH can take the following values:
1615 - t means that the user is not allowed to exit unless
1616 the input is (or completes to) an element of COLLECTION or is null.
1617 - nil means that the user can exit with any input.
1618 - `confirm' means that the user can exit with any input, but she needs
1619 to confirm her choice if the input is not an element of COLLECTION.
1620 - `confirm-after-completion' means that the user can exit with any
1621 input, but she needs to confirm her choice if she called
1622 `minibuffer-complete' right before `minibuffer-complete-and-exit'
1623 and the input is not an element of COLLECTION.
1624 - anything else behaves like t except that typing RET does not exit if it
1625 does non-null completion.
1627 If the input is null, `completing-read' returns DEF, or the first element
1628 of the list of default values, or an empty string if DEF is nil,
1629 regardless of the value of REQUIRE-MATCH.
1631 If INITIAL-INPUT is non-nil, insert it in the minibuffer initially,
1632 with point positioned at the end.
1633 If it is (STRING . POSITION), the initial input is STRING, but point
1634 is placed at _zero-indexed_ position POSITION in STRING. (*Note*
1635 that this is different from `read-from-minibuffer' and related
1636 functions, which use one-indexing for POSITION.) This feature is
1637 deprecated--it is best to pass nil for INITIAL-INPUT and supply the
1638 default value DEF instead. The user can yank the default value into
1639 the minibuffer easily using \\<minibuffer-local-map>\\[next-history-element].
1641 HIST, if non-nil, specifies a history list and optionally the initial
1642 position in the list. It can be a symbol, which is the history list
1643 variable to use, or it can be a cons cell (HISTVAR . HISTPOS). In
1644 that case, HISTVAR is the history list variable to use, and HISTPOS
1645 is the initial position (the position in the list used by the
1646 minibuffer history commands). For consistency, you should also
1647 specify that element of the history as the value of
1648 INITIAL-INPUT. (This is the only case in which you should use
1649 INITIAL-INPUT instead of DEF.) Positions are counted starting from
1650 1 at the beginning of the list. The variable `history-length'
1651 controls the maximum length of a history list.
1653 DEF, if non-nil, is the default value or the list of default values.
1655 If INHERIT-INPUT-METHOD is non-nil, the minibuffer inherits
1656 the current input method and the setting of `enable-multibyte-characters'.
1658 Completion ignores case if the ambient value of
1659 `completion-ignore-case' is non-nil.
1661 See also `completing-read-function'. */)
1662 (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)
1664 Lisp_Object args[9];
1665 args[0] = Fsymbol_value (intern ("completing-read-function"));
1666 args[1] = prompt;
1667 args[2] = collection;
1668 args[3] = predicate;
1669 args[4] = require_match;
1670 args[5] = initial_input;
1671 args[6] = hist;
1672 args[7] = def;
1673 args[8] = inherit_input_method;
1674 return Ffuncall (9, args);
1677 /* Test whether TXT is an exact completion. */
1678 DEFUN ("test-completion", Ftest_completion, Stest_completion, 2, 3, 0,
1679 doc: /* Return non-nil if STRING is a valid completion.
1680 Takes the same arguments as `all-completions' and `try-completion'.
1681 If COLLECTION is a function, it is called with three arguments:
1682 the values STRING, PREDICATE and `lambda'. */)
1683 (Lisp_Object string, Lisp_Object collection, Lisp_Object predicate)
1685 Lisp_Object regexps, tail, tem = Qnil;
1686 ptrdiff_t i = 0;
1688 CHECK_STRING (string);
1690 if (NILP (collection) || (CONSP (collection) && !FUNCTIONP (collection)))
1692 tem = Fassoc_string (string, collection, completion_ignore_case ? Qt : Qnil);
1693 if (NILP (tem))
1694 return Qnil;
1696 else if (VECTORP (collection))
1698 /* Bypass intern-soft as that loses for nil. */
1699 tem = oblookup (collection,
1700 SSDATA (string),
1701 SCHARS (string),
1702 SBYTES (string));
1703 if (!SYMBOLP (tem))
1705 if (STRING_MULTIBYTE (string))
1706 string = Fstring_make_unibyte (string);
1707 else
1708 string = Fstring_make_multibyte (string);
1710 tem = oblookup (collection,
1711 SSDATA (string),
1712 SCHARS (string),
1713 SBYTES (string));
1716 if (completion_ignore_case && !SYMBOLP (tem))
1718 for (i = ASIZE (collection) - 1; i >= 0; i--)
1720 tail = AREF (collection, i);
1721 if (SYMBOLP (tail))
1722 while (1)
1724 if (EQ (Fcompare_strings (string, make_number (0), Qnil,
1725 Fsymbol_name (tail),
1726 make_number (0) , Qnil, Qt),
1727 Qt))
1729 tem = tail;
1730 break;
1732 if (XSYMBOL (tail)->next == 0)
1733 break;
1734 XSETSYMBOL (tail, XSYMBOL (tail)->next);
1739 if (!SYMBOLP (tem))
1740 return Qnil;
1742 else if (HASH_TABLE_P (collection))
1744 struct Lisp_Hash_Table *h = XHASH_TABLE (collection);
1745 Lisp_Object key = Qnil;
1746 i = hash_lookup (h, string, NULL);
1747 if (i >= 0)
1748 tem = HASH_KEY (h, i);
1749 else
1750 for (i = 0; i < HASH_TABLE_SIZE (h); ++i)
1751 if (!NILP (HASH_HASH (h, i))
1752 && (key = HASH_KEY (h, i),
1753 SYMBOLP (key) ? key = Fsymbol_name (key) : key,
1754 STRINGP (key))
1755 && EQ (Fcompare_strings (string, make_number (0), Qnil,
1756 key, make_number (0) , Qnil,
1757 completion_ignore_case ? Qt : Qnil),
1758 Qt))
1760 tem = key;
1761 break;
1763 if (!STRINGP (tem))
1764 return Qnil;
1766 else
1767 return call3 (collection, string, predicate, Qlambda);
1769 /* Reject this element if it fails to match all the regexps. */
1770 if (CONSP (Vcompletion_regexp_list))
1772 ptrdiff_t count = SPECPDL_INDEX ();
1773 specbind (Qcase_fold_search, completion_ignore_case ? Qt : Qnil);
1774 for (regexps = Vcompletion_regexp_list; CONSP (regexps);
1775 regexps = XCDR (regexps))
1777 if (NILP (Fstring_match (XCAR (regexps),
1778 SYMBOLP (tem) ? string : tem,
1779 Qnil)))
1780 return unbind_to (count, Qnil);
1782 unbind_to (count, Qnil);
1785 /* Finally, check the predicate. */
1786 if (!NILP (predicate))
1788 return HASH_TABLE_P (collection)
1789 ? call2 (predicate, tem, HASH_VALUE (XHASH_TABLE (collection), i))
1790 : call1 (predicate, tem);
1792 else
1793 return Qt;
1796 static Lisp_Object Qmetadata;
1798 DEFUN ("internal-complete-buffer", Finternal_complete_buffer, Sinternal_complete_buffer, 3, 3, 0,
1799 doc: /* Perform completion on buffer names.
1800 STRING and PREDICATE have the same meanings as in `try-completion',
1801 `all-completions', and `test-completion'.
1803 If FLAG is nil, invoke `try-completion'; if it is t, invoke
1804 `all-completions'; otherwise invoke `test-completion'. */)
1805 (Lisp_Object string, Lisp_Object predicate, Lisp_Object flag)
1807 if (NILP (flag))
1808 return Ftry_completion (string, Vbuffer_alist, predicate);
1809 else if (EQ (flag, Qt))
1811 Lisp_Object res = Fall_completions (string, Vbuffer_alist, predicate, Qnil);
1812 if (SCHARS (string) > 0)
1813 return res;
1814 else
1815 { /* Strip out internal buffers. */
1816 Lisp_Object bufs = res;
1817 /* First, look for a non-internal buffer in `res'. */
1818 while (CONSP (bufs) && SREF (XCAR (bufs), 0) == ' ')
1819 bufs = XCDR (bufs);
1820 if (NILP (bufs))
1821 return (EQ (Flength (res), Flength (Vbuffer_alist))
1822 /* If all bufs are internal don't strip them out. */
1823 ? res : bufs);
1824 res = bufs;
1825 while (CONSP (XCDR (bufs)))
1826 if (SREF (XCAR (XCDR (bufs)), 0) == ' ')
1827 XSETCDR (bufs, XCDR (XCDR (bufs)));
1828 else
1829 bufs = XCDR (bufs);
1830 return res;
1833 else if (EQ (flag, Qlambda))
1834 return Ftest_completion (string, Vbuffer_alist, predicate);
1835 else if (EQ (flag, Qmetadata))
1836 return list2 (Qmetadata, Fcons (Qcategory, Qbuffer));
1837 else
1838 return Qnil;
1841 /* Like assoc but assumes KEY is a string, and ignores case if appropriate. */
1843 DEFUN ("assoc-string", Fassoc_string, Sassoc_string, 2, 3, 0,
1844 doc: /* Like `assoc' but specifically for strings (and symbols).
1846 This returns the first element of LIST whose car matches the string or
1847 symbol KEY, or nil if no match exists. When performing the
1848 comparison, symbols are first converted to strings, and unibyte
1849 strings to multibyte. If the optional arg CASE-FOLD is non-nil, case
1850 is ignored.
1852 Unlike `assoc', KEY can also match an entry in LIST consisting of a
1853 single string, rather than a cons cell whose car is a string. */)
1854 (register Lisp_Object key, Lisp_Object list, Lisp_Object case_fold)
1856 register Lisp_Object tail;
1858 if (SYMBOLP (key))
1859 key = Fsymbol_name (key);
1861 for (tail = list; CONSP (tail); tail = XCDR (tail))
1863 register Lisp_Object elt, tem, thiscar;
1864 elt = XCAR (tail);
1865 thiscar = CONSP (elt) ? XCAR (elt) : elt;
1866 if (SYMBOLP (thiscar))
1867 thiscar = Fsymbol_name (thiscar);
1868 else if (!STRINGP (thiscar))
1869 continue;
1870 tem = Fcompare_strings (thiscar, make_number (0), Qnil,
1871 key, make_number (0), Qnil,
1872 case_fold);
1873 if (EQ (tem, Qt))
1874 return elt;
1875 QUIT;
1877 return Qnil;
1881 DEFUN ("minibuffer-depth", Fminibuffer_depth, Sminibuffer_depth, 0, 0, 0,
1882 doc: /* Return current depth of activations of minibuffer, a nonnegative integer. */)
1883 (void)
1885 return make_number (minibuf_level);
1888 DEFUN ("minibuffer-prompt", Fminibuffer_prompt, Sminibuffer_prompt, 0, 0, 0,
1889 doc: /* Return the prompt string of the currently-active minibuffer.
1890 If no minibuffer is active, return nil. */)
1891 (void)
1893 return Fcopy_sequence (minibuf_prompt);
1897 void
1898 init_minibuf_once (void)
1900 Vminibuffer_list = Qnil;
1901 staticpro (&Vminibuffer_list);
1904 void
1905 syms_of_minibuf (void)
1907 minibuf_level = 0;
1908 minibuf_prompt = Qnil;
1909 staticpro (&minibuf_prompt);
1911 minibuf_save_list = Qnil;
1912 staticpro (&minibuf_save_list);
1914 DEFSYM (Qcompletion_ignore_case, "completion-ignore-case");
1915 DEFSYM (Qread_file_name_internal, "read-file-name-internal");
1916 DEFSYM (Qminibuffer_default, "minibuffer-default");
1917 Fset (Qminibuffer_default, Qnil);
1919 DEFSYM (Qminibuffer_completion_table, "minibuffer-completion-table");
1920 DEFSYM (Qminibuffer_completion_confirm, "minibuffer-completion-confirm");
1921 DEFSYM (Qminibuffer_completion_predicate, "minibuffer-completion-predicate");
1923 staticpro (&last_minibuf_string);
1924 last_minibuf_string = Qnil;
1926 DEFSYM (Qminibuffer_history, "minibuffer-history");
1927 DEFSYM (Qbuffer_name_history, "buffer-name-history");
1928 Fset (Qbuffer_name_history, Qnil);
1930 DEFSYM (Qcustom_variable_p, "custom-variable-p");
1931 DEFSYM (Qminibuffer_setup_hook, "minibuffer-setup-hook");
1932 DEFSYM (Qminibuffer_exit_hook, "minibuffer-exit-hook");
1933 DEFSYM (Qhistory_length, "history-length");
1934 DEFSYM (Qcurrent_input_method, "current-input-method");
1935 DEFSYM (Qactivate_input_method, "activate-input-method");
1936 DEFSYM (Qcase_fold_search, "case-fold-search");
1937 DEFSYM (Qmetadata, "metadata");
1939 DEFVAR_LISP ("read-expression-history", Vread_expression_history,
1940 doc: /* A history list for arguments that are Lisp expressions to evaluate.
1941 For example, `eval-expression' uses this. */);
1942 Vread_expression_history = Qnil;
1944 DEFSYM (Qread_expression_history, "read-expression-history");
1946 DEFVAR_LISP ("read-buffer-function", Vread_buffer_function,
1947 doc: /* If this is non-nil, `read-buffer' does its work by calling this function.
1948 The function is called with the arguments passed to `read-buffer'. */);
1949 Vread_buffer_function = Qnil;
1951 DEFVAR_BOOL ("read-buffer-completion-ignore-case",
1952 read_buffer_completion_ignore_case,
1953 doc: /* Non-nil means completion ignores case when reading a buffer name. */);
1954 read_buffer_completion_ignore_case = 0;
1956 DEFVAR_LISP ("minibuffer-setup-hook", Vminibuffer_setup_hook,
1957 doc: /* Normal hook run just after entry to minibuffer. */);
1958 Vminibuffer_setup_hook = Qnil;
1960 DEFVAR_LISP ("minibuffer-exit-hook", Vminibuffer_exit_hook,
1961 doc: /* Normal hook run just after exit from minibuffer. */);
1962 Vminibuffer_exit_hook = Qnil;
1964 DEFVAR_LISP ("history-length", Vhistory_length,
1965 doc: /* Maximum length of history lists before truncation takes place.
1966 A number means truncate to that length; truncation deletes old
1967 elements, and is done just after inserting a new element.
1968 A value of t means no truncation.
1970 This variable only affects history lists that don't specify their own
1971 maximum lengths. Setting the `history-length' property of a history
1972 variable overrides this default. */);
1973 XSETFASTINT (Vhistory_length, 100);
1975 DEFVAR_BOOL ("history-delete-duplicates", history_delete_duplicates,
1976 doc: /* Non-nil means to delete duplicates in history.
1977 If set to t when adding a new history element, all previous identical
1978 elements are deleted from the history list. */);
1979 history_delete_duplicates = 0;
1981 DEFVAR_LISP ("history-add-new-input", Vhistory_add_new_input,
1982 doc: /* Non-nil means to add new elements in history.
1983 If set to nil, minibuffer reading functions don't add new elements to the
1984 history list, so it is possible to do this afterwards by calling
1985 `add-to-history' explicitly. */);
1986 Vhistory_add_new_input = Qt;
1988 DEFVAR_BOOL ("completion-ignore-case", completion_ignore_case,
1989 doc: /* Non-nil means don't consider case significant in completion.
1990 For file-name completion, `read-file-name-completion-ignore-case'
1991 controls the behavior, rather than this variable.
1992 For buffer name completion, `read-buffer-completion-ignore-case'
1993 controls the behavior, rather than this variable. */);
1994 completion_ignore_case = 0;
1996 DEFVAR_BOOL ("enable-recursive-minibuffers", enable_recursive_minibuffers,
1997 doc: /* Non-nil means to allow minibuffer commands while in the minibuffer.
1998 This variable makes a difference whenever the minibuffer window is active. */);
1999 enable_recursive_minibuffers = 0;
2001 DEFVAR_LISP ("minibuffer-completion-table", Vminibuffer_completion_table,
2002 doc: /* Alist or obarray used for completion in the minibuffer.
2003 This becomes the ALIST argument to `try-completion' and `all-completions'.
2004 The value can also be a list of strings or a hash table.
2006 The value may alternatively be a function, which is given three arguments:
2007 STRING, the current buffer contents;
2008 PREDICATE, the predicate for filtering possible matches;
2009 CODE, which says what kind of things to do.
2010 CODE can be nil, t or `lambda':
2011 nil -- return the best completion of STRING, or nil if there is none.
2012 t -- return a list of all possible completions of STRING.
2013 lambda -- return t if STRING is a valid completion as it stands. */);
2014 Vminibuffer_completion_table = Qnil;
2016 DEFVAR_LISP ("minibuffer-completion-predicate", Vminibuffer_completion_predicate,
2017 doc: /* Within call to `completing-read', this holds the PREDICATE argument. */);
2018 Vminibuffer_completion_predicate = Qnil;
2020 DEFVAR_LISP ("minibuffer-completion-confirm", Vminibuffer_completion_confirm,
2021 doc: /* Whether to demand confirmation of completion before exiting minibuffer.
2022 If nil, confirmation is not required.
2023 If the value is `confirm', the user may exit with an input that is not
2024 a valid completion alternative, but Emacs asks for confirmation.
2025 If the value is `confirm-after-completion', the user may exit with an
2026 input that is not a valid completion alternative, but Emacs asks for
2027 confirmation if the user submitted the input right after any of the
2028 completion commands listed in `minibuffer-confirm-exit-commands'. */);
2029 Vminibuffer_completion_confirm = Qnil;
2031 DEFVAR_LISP ("minibuffer-completing-file-name",
2032 Vminibuffer_completing_file_name,
2033 doc: /* Non-nil means completing file names. */);
2034 Vminibuffer_completing_file_name = Qnil;
2036 DEFVAR_LISP ("minibuffer-help-form", Vminibuffer_help_form,
2037 doc: /* Value that `help-form' takes on inside the minibuffer. */);
2038 Vminibuffer_help_form = Qnil;
2040 DEFVAR_LISP ("minibuffer-history-variable", Vminibuffer_history_variable,
2041 doc: /* History list symbol to add minibuffer values to.
2042 Each string of minibuffer input, as it appears on exit from the minibuffer,
2043 is added with
2044 (set minibuffer-history-variable
2045 (cons STRING (symbol-value minibuffer-history-variable))) */);
2046 XSETFASTINT (Vminibuffer_history_variable, 0);
2048 DEFVAR_LISP ("minibuffer-history-position", Vminibuffer_history_position,
2049 doc: /* Current position of redoing in the history list. */);
2050 Vminibuffer_history_position = Qnil;
2052 DEFVAR_BOOL ("minibuffer-auto-raise", minibuffer_auto_raise,
2053 doc: /* Non-nil means entering the minibuffer raises the minibuffer's frame.
2054 Some uses of the echo area also raise that frame (since they use it too). */);
2055 minibuffer_auto_raise = 0;
2057 DEFVAR_LISP ("completion-regexp-list", Vcompletion_regexp_list,
2058 doc: /* List of regexps that should restrict possible completions.
2059 The basic completion functions only consider a completion acceptable
2060 if it matches all regular expressions in this list, with
2061 `case-fold-search' bound to the value of `completion-ignore-case'.
2062 See Info node `(elisp)Basic Completion', for a description of these
2063 functions. */);
2064 Vcompletion_regexp_list = Qnil;
2066 DEFVAR_BOOL ("minibuffer-allow-text-properties",
2067 minibuffer_allow_text_properties,
2068 doc: /* Non-nil means `read-from-minibuffer' should not discard text properties.
2069 This also affects `read-string', but it does not affect `read-minibuffer',
2070 `read-no-blanks-input', or any of the functions that do minibuffer input
2071 with completion; they always discard text properties. */);
2072 minibuffer_allow_text_properties = 0;
2074 DEFVAR_LISP ("minibuffer-prompt-properties", Vminibuffer_prompt_properties,
2075 doc: /* Text properties that are added to minibuffer prompts.
2076 These are in addition to the basic `field' property, and stickiness
2077 properties. */);
2078 /* We use `intern' here instead of Qread_only to avoid
2079 initialization-order problems. */
2080 Vminibuffer_prompt_properties = list2 (intern_c_string ("read-only"), Qt);
2082 defsubr (&Sactive_minibuffer_window);
2083 defsubr (&Sset_minibuffer_window);
2084 defsubr (&Sread_from_minibuffer);
2085 defsubr (&Sread_string);
2086 defsubr (&Sread_command);
2087 defsubr (&Sread_variable);
2088 defsubr (&Sinternal_complete_buffer);
2089 defsubr (&Sread_buffer);
2090 defsubr (&Sread_no_blanks_input);
2091 defsubr (&Sminibuffer_depth);
2092 defsubr (&Sminibuffer_prompt);
2094 defsubr (&Sminibufferp);
2095 defsubr (&Sminibuffer_prompt_end);
2096 defsubr (&Sminibuffer_contents);
2097 defsubr (&Sminibuffer_contents_no_properties);
2098 defsubr (&Sminibuffer_completion_contents);
2100 defsubr (&Stry_completion);
2101 defsubr (&Sall_completions);
2102 defsubr (&Stest_completion);
2103 defsubr (&Sassoc_string);
2104 defsubr (&Scompleting_read);