*** empty log message ***
[emacs.git] / src / minibuf.c
blobd17e9238a1cc1c887d076a8be22914eafcc83646
1 /* Minibuffer input and completion.
2 Copyright (C) 1985, 1986, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000,
3 2001, 2002, 2003, 2004, 2005,
4 2006 Free Software Foundation, Inc.
6 This file is part of GNU Emacs.
8 GNU Emacs is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 2, or (at your option)
11 any later version.
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs; see the file COPYING. If not, write to
20 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
21 Boston, MA 02110-1301, USA. */
24 #include <config.h>
25 #include <stdio.h>
27 #include "lisp.h"
28 #include "commands.h"
29 #include "buffer.h"
30 #include "charset.h"
31 #include "dispextern.h"
32 #include "keyboard.h"
33 #include "frame.h"
34 #include "window.h"
35 #include "syntax.h"
36 #include "intervals.h"
37 #include "keymap.h"
39 extern int quit_char;
41 /* List of buffers for use as minibuffers.
42 The first element of the list is used for the outermost minibuffer
43 invocation, the next element is used for a recursive minibuffer
44 invocation, etc. The list is extended at the end as deeper
45 minibuffer recursions are encountered. */
47 Lisp_Object Vminibuffer_list;
49 /* Data to remember during recursive minibuffer invocations */
51 Lisp_Object minibuf_save_list;
53 /* Depth in minibuffer invocations. */
55 int minibuf_level;
57 /* Nonzero means display completion help for invalid input. */
59 Lisp_Object Vcompletion_auto_help;
61 /* The maximum length of a minibuffer history. */
63 Lisp_Object Qhistory_length, Vhistory_length;
65 /* No duplicates in history. */
67 int history_delete_duplicates;
69 /* Non-nil means add new input to history. */
71 Lisp_Object Vhistory_add_new_input;
73 /* Fread_minibuffer leaves the input here as a string. */
75 Lisp_Object last_minibuf_string;
77 /* Nonzero means let functions called when within a minibuffer
78 invoke recursive minibuffers (to read arguments, or whatever) */
80 int enable_recursive_minibuffers;
82 /* Nonzero means don't ignore text properties
83 in Fread_from_minibuffer. */
85 int minibuffer_allow_text_properties;
87 /* help-form is bound to this while in the minibuffer. */
89 Lisp_Object Vminibuffer_help_form;
91 /* Variable which is the history list to add minibuffer values to. */
93 Lisp_Object Vminibuffer_history_variable;
95 /* Current position in the history list (adjusted by M-n and M-p). */
97 Lisp_Object Vminibuffer_history_position;
99 /* Text properties that are added to minibuffer prompts.
100 These are in addition to the basic `field' property, and stickiness
101 properties. */
103 Lisp_Object Vminibuffer_prompt_properties;
105 Lisp_Object Qminibuffer_history, Qbuffer_name_history;
107 Lisp_Object Qread_file_name_internal;
109 /* Normal hooks for entry to and exit from minibuffer. */
111 Lisp_Object Qminibuffer_setup_hook, Vminibuffer_setup_hook;
112 Lisp_Object Qminibuffer_exit_hook, Vminibuffer_exit_hook;
114 /* Function to call to read a buffer name. */
115 Lisp_Object Vread_buffer_function;
117 /* Nonzero means completion ignores case. */
119 int completion_ignore_case;
121 /* List of regexps that should restrict possible completions. */
123 Lisp_Object Vcompletion_regexp_list;
125 /* Nonzero means raise the minibuffer frame when the minibuffer
126 is entered. */
128 int minibuffer_auto_raise;
130 /* If last completion attempt reported "Complete but not unique"
131 then this is the string completed then; otherwise this is nil. */
133 static Lisp_Object last_exact_completion;
135 /* Keymap for reading expressions. */
136 Lisp_Object Vread_expression_map;
138 Lisp_Object Quser_variable_p;
140 Lisp_Object Qminibuffer_default;
142 Lisp_Object Qcurrent_input_method, Qactivate_input_method;
144 Lisp_Object Qcase_fold_search;
146 Lisp_Object Qread_expression_history;
148 extern Lisp_Object Voverriding_local_map;
150 extern Lisp_Object Qmouse_face;
152 extern Lisp_Object Qfield;
154 /* Put minibuf on currently selected frame's minibuffer.
155 We do this whenever the user starts a new minibuffer
156 or when a minibuffer exits. */
158 void
159 choose_minibuf_frame ()
161 if (FRAMEP (selected_frame)
162 && FRAME_LIVE_P (XFRAME (selected_frame))
163 && !EQ (minibuf_window, XFRAME (selected_frame)->minibuffer_window))
165 struct frame *sf = XFRAME (selected_frame);
166 Lisp_Object buffer;
168 /* I don't think that any frames may validly have a null minibuffer
169 window anymore. */
170 if (NILP (sf->minibuffer_window))
171 abort ();
173 /* Under X, we come here with minibuf_window being the
174 minibuffer window of the unused termcap window created in
175 init_window_once. That window doesn't have a buffer. */
176 buffer = XWINDOW (minibuf_window)->buffer;
177 if (BUFFERP (buffer))
178 Fset_window_buffer (sf->minibuffer_window, buffer, Qnil);
179 minibuf_window = sf->minibuffer_window;
182 /* Make sure no other frame has a minibuffer as its selected window,
183 because the text would not be displayed in it, and that would be
184 confusing. Only allow the selected frame to do this,
185 and that only if the minibuffer is active. */
187 Lisp_Object tail, frame;
189 FOR_EACH_FRAME (tail, frame)
190 if (MINI_WINDOW_P (XWINDOW (FRAME_SELECTED_WINDOW (XFRAME (frame))))
191 && !(EQ (frame, selected_frame)
192 && minibuf_level > 0))
193 Fset_frame_selected_window (frame, Fframe_first_window (frame));
197 Lisp_Object
198 choose_minibuf_frame_1 (ignore)
199 Lisp_Object ignore;
201 choose_minibuf_frame ();
202 return Qnil;
205 DEFUN ("set-minibuffer-window", Fset_minibuffer_window,
206 Sset_minibuffer_window, 1, 1, 0,
207 doc: /* Specify which minibuffer window to use for the minibuffer.
208 This affects where the minibuffer is displayed if you put text in it
209 without invoking the usual minibuffer commands. */)
210 (window)
211 Lisp_Object window;
213 CHECK_WINDOW (window);
214 if (! MINI_WINDOW_P (XWINDOW (window)))
215 error ("Window is not a minibuffer window");
217 minibuf_window = window;
219 return window;
223 /* Actual minibuffer invocation. */
225 static Lisp_Object read_minibuf_unwind P_ ((Lisp_Object));
226 static Lisp_Object run_exit_minibuf_hook P_ ((Lisp_Object));
227 static Lisp_Object read_minibuf P_ ((Lisp_Object, Lisp_Object,
228 Lisp_Object, Lisp_Object,
229 int, Lisp_Object,
230 Lisp_Object, Lisp_Object,
231 int, int));
232 static Lisp_Object read_minibuf_noninteractive P_ ((Lisp_Object, Lisp_Object,
233 Lisp_Object, Lisp_Object,
234 int, Lisp_Object,
235 Lisp_Object, Lisp_Object,
236 int, int));
237 static Lisp_Object string_to_object P_ ((Lisp_Object, Lisp_Object));
240 /* Read a Lisp object from VAL and return it. If VAL is an empty
241 string, and DEFALT is a string, read from DEFALT instead of VAL. */
243 static Lisp_Object
244 string_to_object (val, defalt)
245 Lisp_Object val, defalt;
247 struct gcpro gcpro1, gcpro2;
248 Lisp_Object expr_and_pos;
249 int pos;
251 GCPRO2 (val, defalt);
253 if (STRINGP (val) && SCHARS (val) == 0
254 && STRINGP (defalt))
255 val = defalt;
257 expr_and_pos = Fread_from_string (val, Qnil, Qnil);
258 pos = XINT (Fcdr (expr_and_pos));
259 if (pos != SCHARS (val))
261 /* Ignore trailing whitespace; any other trailing junk
262 is an error. */
263 int i;
264 pos = string_char_to_byte (val, pos);
265 for (i = pos; i < SBYTES (val); i++)
267 int c = SREF (val, i);
268 if (c != ' ' && c != '\t' && c != '\n')
269 error ("Trailing garbage following expression");
273 val = Fcar (expr_and_pos);
274 RETURN_UNGCPRO (val);
278 /* Like read_minibuf but reading from stdin. This function is called
279 from read_minibuf to do the job if noninteractive. */
281 static Lisp_Object
282 read_minibuf_noninteractive (map, initial, prompt, backup_n, expflag,
283 histvar, histpos, defalt, allow_props,
284 inherit_input_method)
285 Lisp_Object map;
286 Lisp_Object initial;
287 Lisp_Object prompt;
288 Lisp_Object backup_n;
289 int expflag;
290 Lisp_Object histvar;
291 Lisp_Object histpos;
292 Lisp_Object defalt;
293 int allow_props;
294 int inherit_input_method;
296 int size, len;
297 char *line, *s;
298 Lisp_Object val;
300 fprintf (stdout, "%s", SDATA (prompt));
301 fflush (stdout);
303 val = Qnil;
304 size = 100;
305 len = 0;
306 line = (char *) xmalloc (size * sizeof *line);
307 while ((s = fgets (line + len, size - len, stdin)) != NULL
308 && (len = strlen (line),
309 len == size - 1 && line[len - 1] != '\n'))
311 size *= 2;
312 line = (char *) xrealloc (line, size);
315 if (s)
317 len = strlen (line);
319 if (len > 0 && line[len - 1] == '\n')
320 line[--len] = '\0';
322 val = build_string (line);
323 xfree (line);
325 else
327 xfree (line);
328 error ("Error reading from stdin");
331 /* If Lisp form desired instead of string, parse it. */
332 if (expflag)
333 val = string_to_object (val, defalt);
335 return val;
338 DEFUN ("minibufferp", Fminibufferp,
339 Sminibufferp, 0, 1, 0,
340 doc: /* Return t if BUFFER is a minibuffer.
341 No argument or nil as argument means use current buffer as BUFFER.
342 BUFFER can be a buffer or a buffer name. */)
343 (buffer)
344 Lisp_Object buffer;
346 Lisp_Object tem;
348 if (NILP (buffer))
349 buffer = Fcurrent_buffer ();
350 else if (STRINGP (buffer))
351 buffer = Fget_buffer (buffer);
352 else
353 CHECK_BUFFER (buffer);
355 tem = Fmemq (buffer, Vminibuffer_list);
356 return ! NILP (tem) ? Qt : Qnil;
359 DEFUN ("minibuffer-prompt-end", Fminibuffer_prompt_end,
360 Sminibuffer_prompt_end, 0, 0, 0,
361 doc: /* Return the buffer position of the end of the minibuffer prompt.
362 Return (point-min) if current buffer is not a minibuffer. */)
365 /* This function is written to be most efficient when there's a prompt. */
366 Lisp_Object beg, end, tem;
367 beg = make_number (BEGV);
369 tem = Fmemq (Fcurrent_buffer (), Vminibuffer_list);
370 if (NILP (tem))
371 return beg;
373 end = Ffield_end (beg, Qnil, Qnil);
375 if (XINT (end) == ZV && NILP (Fget_char_property (beg, Qfield, Qnil)))
376 return beg;
377 else
378 return end;
381 DEFUN ("minibuffer-contents", Fminibuffer_contents,
382 Sminibuffer_contents, 0, 0, 0,
383 doc: /* Return the user input in a minibuffer as a string.
384 The current buffer must be a minibuffer. */)
387 int prompt_end = XINT (Fminibuffer_prompt_end ());
388 return make_buffer_string (prompt_end, ZV, 1);
391 DEFUN ("minibuffer-contents-no-properties", Fminibuffer_contents_no_properties,
392 Sminibuffer_contents_no_properties, 0, 0, 0,
393 doc: /* Return the user input in a minibuffer as a string, without text-properties.
394 The current buffer must be a minibuffer. */)
397 int prompt_end = XINT (Fminibuffer_prompt_end ());
398 return make_buffer_string (prompt_end, ZV, 0);
401 DEFUN ("minibuffer-completion-contents", Fminibuffer_completion_contents,
402 Sminibuffer_completion_contents, 0, 0, 0,
403 doc: /* Return the user input in a minibuffer before point as a string.
404 That is what completion commands operate on.
405 The current buffer must be a minibuffer. */)
408 int prompt_end = XINT (Fminibuffer_prompt_end ());
409 if (PT < prompt_end)
410 error ("Cannot do completion in the prompt");
411 return make_buffer_string (prompt_end, PT, 1);
414 DEFUN ("delete-minibuffer-contents", Fdelete_minibuffer_contents,
415 Sdelete_minibuffer_contents, 0, 0, 0,
416 doc: /* Delete all user input in a minibuffer.
417 The current buffer must be a minibuffer. */)
420 int prompt_end = XINT (Fminibuffer_prompt_end ());
421 if (prompt_end < ZV)
422 del_range (prompt_end, ZV);
423 return Qnil;
427 /* Read from the minibuffer using keymap MAP and initial contents INITIAL,
428 putting point minus BACKUP_N bytes from the end of INITIAL,
429 prompting with PROMPT (a string), using history list HISTVAR
430 with initial position HISTPOS. INITIAL should be a string or a
431 cons of a string and an integer. BACKUP_N should be <= 0, or
432 Qnil, which is equivalent to 0. If INITIAL is a cons, BACKUP_N is
433 ignored and replaced with an integer that puts point at one-indexed
434 position N in INITIAL, where N is the CDR of INITIAL, or at the
435 beginning of INITIAL if N <= 0.
437 Normally return the result as a string (the text that was read),
438 but if EXPFLAG is nonzero, read it and return the object read.
439 If HISTVAR is given, save the value read on that history only if it doesn't
440 match the front of that history list exactly. The value is pushed onto
441 the list as the string that was read.
443 DEFALT specifies the default value for the sake of history commands.
445 If ALLOW_PROPS is nonzero, we do not throw away text properties.
447 if INHERIT_INPUT_METHOD is nonzero, the minibuffer inherits the
448 current input method. */
450 static Lisp_Object
451 read_minibuf (map, initial, prompt, backup_n, expflag,
452 histvar, histpos, defalt, allow_props, inherit_input_method)
453 Lisp_Object map;
454 Lisp_Object initial;
455 Lisp_Object prompt;
456 Lisp_Object backup_n;
457 int expflag;
458 Lisp_Object histvar;
459 Lisp_Object histpos;
460 Lisp_Object defalt;
461 int allow_props;
462 int inherit_input_method;
464 Lisp_Object val;
465 int count = SPECPDL_INDEX ();
466 Lisp_Object mini_frame, ambient_dir, minibuffer, input_method;
467 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5;
468 Lisp_Object enable_multibyte;
469 int pos = INTEGERP (backup_n) ? XINT (backup_n) : 0;
471 /* String to add to the history. */
472 Lisp_Object histstring;
474 Lisp_Object empty_minibuf;
475 Lisp_Object dummy, frame;
477 extern Lisp_Object Qfront_sticky;
478 extern Lisp_Object Qrear_nonsticky;
480 specbind (Qminibuffer_default, defalt);
482 single_kboard_state ();
483 #ifdef HAVE_X_WINDOWS
484 if (display_hourglass_p)
485 cancel_hourglass ();
486 #endif
488 if (!NILP (initial))
490 if (CONSP (initial))
492 backup_n = Fcdr (initial);
493 initial = Fcar (initial);
494 CHECK_STRING (initial);
495 if (!NILP (backup_n))
497 CHECK_NUMBER (backup_n);
498 /* Convert to distance from end of input. */
499 if (XINT (backup_n) < 1)
500 /* A number too small means the beginning of the string. */
501 pos = - SCHARS (initial);
502 else
503 pos = XINT (backup_n) - 1 - SCHARS (initial);
506 else
507 CHECK_STRING (initial);
509 val = Qnil;
510 ambient_dir = current_buffer->directory;
511 input_method = Qnil;
512 enable_multibyte = Qnil;
514 /* Don't need to protect PROMPT, HISTVAR, and HISTPOS because we
515 store them away before we can GC. Don't need to protect
516 BACKUP_N because we use the value only if it is an integer. */
517 GCPRO5 (map, initial, val, ambient_dir, input_method);
519 if (!STRINGP (prompt))
520 prompt = empty_string;
522 if (!enable_recursive_minibuffers
523 && minibuf_level > 0)
525 if (EQ (selected_window, minibuf_window))
526 error ("Command attempted to use minibuffer while in minibuffer");
527 else
528 /* If we're in another window, cancel the minibuffer that's active. */
529 Fthrow (Qexit,
530 build_string ("Command attempted to use minibuffer while in minibuffer"));
533 if (noninteractive && NILP (Vexecuting_kbd_macro))
535 val = read_minibuf_noninteractive (map, initial, prompt,
536 make_number (pos),
537 expflag, histvar, histpos, defalt,
538 allow_props, inherit_input_method);
539 UNGCPRO;
540 return unbind_to (count, val);
543 /* Choose the minibuffer window and frame, and take action on them. */
545 choose_minibuf_frame ();
547 record_unwind_protect (choose_minibuf_frame_1, Qnil);
549 record_unwind_protect (Fset_window_configuration,
550 Fcurrent_window_configuration (Qnil));
552 /* If the minibuffer window is on a different frame, save that
553 frame's configuration too. */
554 mini_frame = WINDOW_FRAME (XWINDOW (minibuf_window));
555 if (!EQ (mini_frame, selected_frame))
556 record_unwind_protect (Fset_window_configuration,
557 Fcurrent_window_configuration (mini_frame));
559 /* If the minibuffer is on an iconified or invisible frame,
560 make it visible now. */
561 Fmake_frame_visible (mini_frame);
563 if (minibuffer_auto_raise)
564 Fraise_frame (mini_frame);
566 /* We have to do this after saving the window configuration
567 since that is what restores the current buffer. */
569 /* Arrange to restore a number of minibuffer-related variables.
570 We could bind each variable separately, but that would use lots of
571 specpdl slots. */
572 minibuf_save_list
573 = Fcons (Voverriding_local_map,
574 Fcons (minibuf_window, minibuf_save_list));
575 minibuf_save_list
576 = Fcons (minibuf_prompt,
577 Fcons (make_number (minibuf_prompt_width),
578 Fcons (Vhelp_form,
579 Fcons (Vcurrent_prefix_arg,
580 Fcons (Vminibuffer_history_position,
581 Fcons (Vminibuffer_history_variable,
582 minibuf_save_list))))));
584 record_unwind_protect (read_minibuf_unwind, Qnil);
585 minibuf_level++;
586 /* We are exiting the minibuffer one way or the other, so run the hook.
587 It should be run before unwinding the minibuf settings. Do it
588 separately from read_minibuf_unwind because we need to make sure that
589 read_minibuf_unwind is fully executed even if exit-minibuffer-hook
590 signals an error. --Stef */
591 record_unwind_protect (run_exit_minibuf_hook, Qnil);
593 /* Now that we can restore all those variables, start changing them. */
595 minibuf_prompt_width = 0;
596 minibuf_prompt = Fcopy_sequence (prompt);
597 Vminibuffer_history_position = histpos;
598 Vminibuffer_history_variable = histvar;
599 Vhelp_form = Vminibuffer_help_form;
601 if (inherit_input_method)
603 /* `current-input-method' is buffer local. So, remember it in
604 INPUT_METHOD before changing the current buffer. */
605 input_method = Fsymbol_value (Qcurrent_input_method);
606 enable_multibyte = current_buffer->enable_multibyte_characters;
609 /* Switch to the minibuffer. */
611 minibuffer = get_minibuffer (minibuf_level);
612 Fset_buffer (minibuffer);
614 /* If appropriate, copy enable-multibyte-characters into the minibuffer. */
615 if (inherit_input_method)
616 current_buffer->enable_multibyte_characters = enable_multibyte;
618 /* The current buffer's default directory is usually the right thing
619 for our minibuffer here. However, if you're typing a command at
620 a minibuffer-only frame when minibuf_level is zero, then buf IS
621 the current_buffer, so reset_buffer leaves buf's default
622 directory unchanged. This is a bummer when you've just started
623 up Emacs and buf's default directory is Qnil. Here's a hack; can
624 you think of something better to do? Find another buffer with a
625 better directory, and use that one instead. */
626 if (STRINGP (ambient_dir))
627 current_buffer->directory = ambient_dir;
628 else
630 Lisp_Object buf_list;
632 for (buf_list = Vbuffer_alist;
633 CONSP (buf_list);
634 buf_list = XCDR (buf_list))
636 Lisp_Object other_buf;
638 other_buf = XCDR (XCAR (buf_list));
639 if (STRINGP (XBUFFER (other_buf)->directory))
641 current_buffer->directory = XBUFFER (other_buf)->directory;
642 break;
647 if (!EQ (mini_frame, selected_frame))
648 Fredirect_frame_focus (selected_frame, mini_frame);
650 Vminibuf_scroll_window = selected_window;
651 if (minibuf_level == 1 || !EQ (minibuf_window, selected_window))
652 minibuf_selected_window = selected_window;
654 /* Empty out the minibuffers of all frames other than the one
655 where we are going to display one now.
656 Set them to point to ` *Minibuf-0*', which is always empty. */
657 empty_minibuf = Fget_buffer (build_string (" *Minibuf-0*"));
659 FOR_EACH_FRAME (dummy, frame)
661 Lisp_Object root_window = Fframe_root_window (frame);
662 Lisp_Object mini_window = XWINDOW (root_window)->next;
664 if (! NILP (mini_window) && ! EQ (mini_window, minibuf_window)
665 && !NILP (Fwindow_minibuffer_p (mini_window)))
666 Fset_window_buffer (mini_window, empty_minibuf, Qnil);
669 /* Display this minibuffer in the proper window. */
670 Fset_window_buffer (minibuf_window, Fcurrent_buffer (), Qnil);
671 Fselect_window (minibuf_window, Qnil);
672 XSETFASTINT (XWINDOW (minibuf_window)->hscroll, 0);
674 Fmake_local_variable (Qprint_escape_newlines);
675 print_escape_newlines = 1;
677 /* Erase the buffer. */
679 int count1 = SPECPDL_INDEX ();
680 specbind (Qinhibit_read_only, Qt);
681 specbind (Qinhibit_modification_hooks, Qt);
682 Ferase_buffer ();
683 unbind_to (count1, Qnil);
686 if (!NILP (current_buffer->enable_multibyte_characters)
687 && ! STRING_MULTIBYTE (minibuf_prompt))
688 minibuf_prompt = Fstring_make_multibyte (minibuf_prompt);
690 /* Insert the prompt, record where it ends. */
691 Finsert (1, &minibuf_prompt);
692 if (PT > BEG)
694 Fput_text_property (make_number (BEG), make_number (PT),
695 Qfront_sticky, Qt, Qnil);
696 Fput_text_property (make_number (BEG), make_number (PT),
697 Qrear_nonsticky, Qt, Qnil);
698 Fput_text_property (make_number (BEG), make_number (PT),
699 Qfield, Qt, Qnil);
700 Fadd_text_properties (make_number (BEG), make_number (PT),
701 Vminibuffer_prompt_properties, Qnil);
704 minibuf_prompt_width = (int) current_column (); /* iftc */
706 /* Put in the initial input. */
707 if (!NILP (initial))
709 Finsert (1, &initial);
710 Fforward_char (make_number (pos));
713 clear_message (1, 1);
714 current_buffer->keymap = map;
716 /* Turn on an input method stored in INPUT_METHOD if any. */
717 if (STRINGP (input_method) && !NILP (Ffboundp (Qactivate_input_method)))
718 call1 (Qactivate_input_method, input_method);
720 /* Run our hook, but not if it is empty.
721 (run-hooks would do nothing if it is empty,
722 but it's important to save time here in the usual case.) */
723 if (!NILP (Vminibuffer_setup_hook) && !EQ (Vminibuffer_setup_hook, Qunbound)
724 && !NILP (Vrun_hooks))
725 call1 (Vrun_hooks, Qminibuffer_setup_hook);
727 /* Don't allow the user to undo past this point. */
728 current_buffer->undo_list = Qnil;
730 recursive_edit_1 ();
732 /* If cursor is on the minibuffer line,
733 show the user we have exited by putting it in column 0. */
734 if (XWINDOW (minibuf_window)->cursor.vpos >= 0
735 && !noninteractive)
737 XWINDOW (minibuf_window)->cursor.hpos = 0;
738 XWINDOW (minibuf_window)->cursor.x = 0;
739 XWINDOW (minibuf_window)->must_be_updated_p = 1;
740 update_frame (XFRAME (selected_frame), 1, 1);
741 if (rif && rif->flush_display)
742 rif->flush_display (XFRAME (XWINDOW (minibuf_window)->frame));
745 /* Make minibuffer contents into a string. */
746 Fset_buffer (minibuffer);
747 if (allow_props)
748 val = Fminibuffer_contents ();
749 else
750 val = Fminibuffer_contents_no_properties ();
752 /* VAL is the string of minibuffer text. */
754 last_minibuf_string = val;
756 /* Choose the string to add to the history. */
757 if (SCHARS (val) != 0)
758 histstring = val;
759 else if (STRINGP (defalt))
760 histstring = defalt;
761 else
762 histstring = Qnil;
764 /* Add the value to the appropriate history list, if any. */
765 if (!NILP (Vhistory_add_new_input)
766 && SYMBOLP (Vminibuffer_history_variable)
767 && !NILP (histstring))
769 /* If the caller wanted to save the value read on a history list,
770 then do so if the value is not already the front of the list. */
771 Lisp_Object histval;
773 /* If variable is unbound, make it nil. */
774 if (EQ (SYMBOL_VALUE (Vminibuffer_history_variable), Qunbound))
775 Fset (Vminibuffer_history_variable, Qnil);
777 histval = Fsymbol_value (Vminibuffer_history_variable);
779 /* The value of the history variable must be a cons or nil. Other
780 values are unacceptable. We silently ignore these values. */
782 if (NILP (histval)
783 || (CONSP (histval)
784 /* Don't duplicate the most recent entry in the history. */
785 && (NILP (Fequal (histstring, Fcar (histval))))))
787 Lisp_Object length;
789 if (history_delete_duplicates) Fdelete (histstring, histval);
790 histval = Fcons (histstring, histval);
791 Fset (Vminibuffer_history_variable, histval);
793 /* Truncate if requested. */
794 length = Fget (Vminibuffer_history_variable, Qhistory_length);
795 if (NILP (length)) length = Vhistory_length;
796 if (INTEGERP (length))
798 if (XINT (length) <= 0)
799 Fset (Vminibuffer_history_variable, Qnil);
800 else
802 Lisp_Object temp;
804 temp = Fnthcdr (Fsub1 (length), histval);
805 if (CONSP (temp)) Fsetcdr (temp, Qnil);
811 /* If Lisp form desired instead of string, parse it. */
812 if (expflag)
813 val = string_to_object (val, defalt);
815 /* The appropriate frame will get selected
816 in set-window-configuration. */
817 UNGCPRO;
818 return unbind_to (count, val);
821 /* Return a buffer to be used as the minibuffer at depth `depth'.
822 depth = 0 is the lowest allowed argument, and that is the value
823 used for nonrecursive minibuffer invocations */
825 Lisp_Object
826 get_minibuffer (depth)
827 int depth;
829 Lisp_Object tail, num, buf;
830 char name[24];
831 extern Lisp_Object nconc2 ();
833 XSETFASTINT (num, depth);
834 tail = Fnthcdr (num, Vminibuffer_list);
835 if (NILP (tail))
837 tail = Fcons (Qnil, Qnil);
838 Vminibuffer_list = nconc2 (Vminibuffer_list, tail);
840 buf = Fcar (tail);
841 if (NILP (buf) || NILP (XBUFFER (buf)->name))
843 sprintf (name, " *Minibuf-%d*", depth);
844 buf = Fget_buffer_create (build_string (name));
846 /* Although the buffer's name starts with a space, undo should be
847 enabled in it. */
848 Fbuffer_enable_undo (buf);
850 XSETCAR (tail, buf);
852 else
854 int count = SPECPDL_INDEX ();
855 /* `reset_buffer' blindly sets the list of overlays to NULL, so we
856 have to empty the list, otherwise we end up with overlays that
857 think they belong to this buffer while the buffer doesn't know about
858 them any more. */
859 delete_all_overlays (XBUFFER (buf));
860 reset_buffer (XBUFFER (buf));
861 record_unwind_protect (Fset_buffer, Fcurrent_buffer ());
862 Fset_buffer (buf);
863 Fkill_all_local_variables ();
864 unbind_to (count, Qnil);
867 return buf;
870 static Lisp_Object
871 run_exit_minibuf_hook (data)
872 Lisp_Object data;
874 if (!NILP (Vminibuffer_exit_hook) && !EQ (Vminibuffer_exit_hook, Qunbound)
875 && !NILP (Vrun_hooks))
876 safe_run_hooks (Qminibuffer_exit_hook);
878 return Qnil;
881 /* This function is called on exiting minibuffer, whether normally or
882 not, and it restores the current window, buffer, etc. */
884 static Lisp_Object
885 read_minibuf_unwind (data)
886 Lisp_Object data;
888 Lisp_Object old_deactivate_mark;
889 Lisp_Object window;
891 /* If this was a recursive minibuffer,
892 tie the minibuffer window back to the outer level minibuffer buffer. */
893 minibuf_level--;
895 window = minibuf_window;
896 /* To keep things predictable, in case it matters, let's be in the
897 minibuffer when we reset the relevant variables. */
898 Fset_buffer (XWINDOW (window)->buffer);
900 /* Restore prompt, etc, from outer minibuffer level. */
901 minibuf_prompt = Fcar (minibuf_save_list);
902 minibuf_save_list = Fcdr (minibuf_save_list);
903 minibuf_prompt_width = XFASTINT (Fcar (minibuf_save_list));
904 minibuf_save_list = Fcdr (minibuf_save_list);
905 Vhelp_form = Fcar (minibuf_save_list);
906 minibuf_save_list = Fcdr (minibuf_save_list);
907 Vcurrent_prefix_arg = Fcar (minibuf_save_list);
908 minibuf_save_list = Fcdr (minibuf_save_list);
909 Vminibuffer_history_position = Fcar (minibuf_save_list);
910 minibuf_save_list = Fcdr (minibuf_save_list);
911 Vminibuffer_history_variable = Fcar (minibuf_save_list);
912 minibuf_save_list = Fcdr (minibuf_save_list);
913 Voverriding_local_map = Fcar (minibuf_save_list);
914 minibuf_save_list = Fcdr (minibuf_save_list);
915 #if 0
916 temp = Fcar (minibuf_save_list);
917 if (FRAME_LIVE_P (XFRAME (WINDOW_FRAME (XWINDOW (temp)))))
918 minibuf_window = temp;
919 #endif
920 minibuf_save_list = Fcdr (minibuf_save_list);
922 /* Erase the minibuffer we were using at this level. */
924 int count = SPECPDL_INDEX ();
925 /* Prevent error in erase-buffer. */
926 specbind (Qinhibit_read_only, Qt);
927 specbind (Qinhibit_modification_hooks, Qt);
928 old_deactivate_mark = Vdeactivate_mark;
929 Ferase_buffer ();
930 Vdeactivate_mark = old_deactivate_mark;
931 unbind_to (count, Qnil);
934 /* When we get to the outmost level, make sure we resize the
935 mini-window back to its normal size. */
936 if (minibuf_level == 0)
937 resize_mini_window (XWINDOW (window), 0);
939 /* Make sure minibuffer window is erased, not ignored. */
940 windows_or_buffers_changed++;
941 XSETFASTINT (XWINDOW (window)->last_modified, 0);
942 XSETFASTINT (XWINDOW (window)->last_overlay_modified, 0);
943 return Qnil;
947 DEFUN ("read-from-minibuffer", Fread_from_minibuffer, Sread_from_minibuffer, 1, 7, 0,
948 doc: /* Read a string from the minibuffer, prompting with string PROMPT.
949 The optional second arg INITIAL-CONTENTS is an obsolete alternative to
950 DEFAULT-VALUE. It normally should be nil in new code, except when
951 HIST is a cons. It is discussed in more detail below.
952 Third arg KEYMAP is a keymap to use whilst reading;
953 if omitted or nil, the default is `minibuffer-local-map'.
954 If fourth arg READ is non-nil, then interpret the result as a Lisp object
955 and return that object:
956 in other words, do `(car (read-from-string INPUT-STRING))'
957 Fifth arg HIST, if non-nil, specifies a history list and optionally
958 the initial position in the list. It can be a symbol, which is the
959 history list variable to use, or it can be a cons cell
960 (HISTVAR . HISTPOS). In that case, HISTVAR is the history list variable
961 to use, and HISTPOS is the initial position for use by the minibuffer
962 history commands. For consistency, you should also specify that
963 element of the history as the value of INITIAL-CONTENTS. Positions
964 are counted starting from 1 at the beginning of the list.
965 Sixth arg DEFAULT-VALUE is the default value. If non-nil, it is available
966 for history commands; but, unless READ is non-nil, `read-from-minibuffer'
967 does NOT return DEFAULT-VALUE if the user enters empty input! It returns
968 the empty string.
969 Seventh arg INHERIT-INPUT-METHOD, if non-nil, means the minibuffer inherits
970 the current input method and the setting of `enable-multibyte-characters'.
971 If the variable `minibuffer-allow-text-properties' is non-nil,
972 then the string which is returned includes whatever text properties
973 were present in the minibuffer. Otherwise the value has no text properties.
975 The remainder of this documentation string describes the
976 INITIAL-CONTENTS argument in more detail. It is only relevant when
977 studying existing code, or when HIST is a cons. If non-nil,
978 INITIAL-CONTENTS is a string to be inserted into the minibuffer before
979 reading input. Normally, point is put at the end of that string.
980 However, if INITIAL-CONTENTS is \(STRING . POSITION), the initial
981 input is STRING, but point is placed at _one-indexed_ position
982 POSITION in the minibuffer. Any integer value less than or equal to
983 one puts point at the beginning of the string. *Note* that this
984 behavior differs from the way such arguments are used in `completing-read'
985 and some related functions, which use zero-indexing for POSITION. */)
986 (prompt, initial_contents, keymap, read, hist, default_value, inherit_input_method)
987 Lisp_Object prompt, initial_contents, keymap, read, hist, default_value;
988 Lisp_Object inherit_input_method;
990 Lisp_Object histvar, histpos, val;
991 struct gcpro gcpro1;
993 CHECK_STRING (prompt);
994 if (NILP (keymap))
995 keymap = Vminibuffer_local_map;
996 else
997 keymap = get_keymap (keymap, 1, 0);
999 if (SYMBOLP (hist))
1001 histvar = hist;
1002 histpos = Qnil;
1004 else
1006 histvar = Fcar_safe (hist);
1007 histpos = Fcdr_safe (hist);
1009 if (NILP (histvar))
1010 histvar = Qminibuffer_history;
1011 if (NILP (histpos))
1012 XSETFASTINT (histpos, 0);
1014 GCPRO1 (default_value);
1015 val = read_minibuf (keymap, initial_contents, prompt,
1016 Qnil, !NILP (read),
1017 histvar, histpos, default_value,
1018 minibuffer_allow_text_properties,
1019 !NILP (inherit_input_method));
1020 UNGCPRO;
1021 return val;
1024 DEFUN ("read-minibuffer", Fread_minibuffer, Sread_minibuffer, 1, 2, 0,
1025 doc: /* Return a Lisp object read using the minibuffer, unevaluated.
1026 Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS
1027 is a string to insert in the minibuffer before reading.
1028 \(INITIAL-CONTENTS can also be a cons of a string and an integer. Such
1029 arguments are used as in `read-from-minibuffer'.) */)
1030 (prompt, initial_contents)
1031 Lisp_Object prompt, initial_contents;
1033 CHECK_STRING (prompt);
1034 return read_minibuf (Vminibuffer_local_map, initial_contents,
1035 prompt, Qnil, 1, Qminibuffer_history,
1036 make_number (0), Qnil, 0, 0);
1039 DEFUN ("eval-minibuffer", Feval_minibuffer, Seval_minibuffer, 1, 2, 0,
1040 doc: /* Return value of Lisp expression read using the minibuffer.
1041 Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS
1042 is a string to insert in the minibuffer before reading.
1043 \(INITIAL-CONTENTS can also be a cons of a string and an integer. Such
1044 arguments are used as in `read-from-minibuffer'.) */)
1045 (prompt, initial_contents)
1046 Lisp_Object prompt, initial_contents;
1048 return Feval (read_minibuf (Vread_expression_map, initial_contents,
1049 prompt, Qnil, 1, Qread_expression_history,
1050 make_number (0), Qnil, 0, 0));
1053 /* Functions that use the minibuffer to read various things. */
1055 DEFUN ("read-string", Fread_string, Sread_string, 1, 5, 0,
1056 doc: /* Read a string from the minibuffer, prompting with string PROMPT.
1057 If non-nil, second arg INITIAL-INPUT is a string to insert before reading.
1058 This argument has been superseded by DEFAULT-VALUE and should normally
1059 be nil in new code. It behaves as in `read-from-minibuffer'. See the
1060 documentation string of that function for details.
1061 The third arg HISTORY, if non-nil, specifies a history list
1062 and optionally the initial position in the list.
1063 See `read-from-minibuffer' for details of HISTORY argument.
1064 Fourth arg DEFAULT-VALUE is the default value. If non-nil, it is used
1065 for history commands, and as the value to return if the user enters
1066 the empty string.
1067 Fifth arg INHERIT-INPUT-METHOD, if non-nil, means the minibuffer inherits
1068 the current input method and the setting of `enable-multibyte-characters'. */)
1069 (prompt, initial_input, history, default_value, inherit_input_method)
1070 Lisp_Object prompt, initial_input, history, default_value;
1071 Lisp_Object inherit_input_method;
1073 Lisp_Object val;
1074 val = Fread_from_minibuffer (prompt, initial_input, Qnil,
1075 Qnil, history, default_value,
1076 inherit_input_method);
1077 if (STRINGP (val) && SCHARS (val) == 0 && ! NILP (default_value))
1078 val = default_value;
1079 return val;
1082 DEFUN ("read-no-blanks-input", Fread_no_blanks_input, Sread_no_blanks_input, 1, 3, 0,
1083 doc: /* Read a string from the terminal, not allowing blanks.
1084 Prompt with PROMPT. Whitespace terminates the input. If INITIAL is
1085 non-nil, it should be a string, which is used as initial input, with
1086 point positioned at the end, so that SPACE will accept the input.
1087 \(Actually, INITIAL can also be a cons of a string and an integer.
1088 Such values are treated as in `read-from-minibuffer', but are normally
1089 not useful in this function.)
1090 Third arg INHERIT-INPUT-METHOD, if non-nil, means the minibuffer inherits
1091 the current input method and the setting of`enable-multibyte-characters'. */)
1092 (prompt, initial, inherit_input_method)
1093 Lisp_Object prompt, initial, inherit_input_method;
1095 CHECK_STRING (prompt);
1096 return read_minibuf (Vminibuffer_local_ns_map, initial, prompt, Qnil,
1097 0, Qminibuffer_history, make_number (0), Qnil, 0,
1098 !NILP (inherit_input_method));
1101 DEFUN ("read-command", Fread_command, Sread_command, 1, 2, 0,
1102 doc: /* Read the name of a command and return as a symbol.
1103 Prompt with PROMPT. By default, return DEFAULT-VALUE. */)
1104 (prompt, default_value)
1105 Lisp_Object prompt, default_value;
1107 Lisp_Object name, default_string;
1109 if (NILP (default_value))
1110 default_string = Qnil;
1111 else if (SYMBOLP (default_value))
1112 default_string = SYMBOL_NAME (default_value);
1113 else
1114 default_string = default_value;
1116 name = Fcompleting_read (prompt, Vobarray, Qcommandp, Qt,
1117 Qnil, Qnil, default_string, Qnil);
1118 if (NILP (name))
1119 return name;
1120 return Fintern (name, Qnil);
1123 #ifdef NOTDEF
1124 DEFUN ("read-function", Fread_function, Sread_function, 1, 1, 0,
1125 doc: /* One arg PROMPT, a string. Read the name of a function and return as a symbol.
1126 Prompt with PROMPT. */)
1127 (prompt)
1128 Lisp_Object prompt;
1130 return Fintern (Fcompleting_read (prompt, Vobarray, Qfboundp, Qt, Qnil, Qnil, Qnil, Qnil),
1131 Qnil);
1133 #endif /* NOTDEF */
1135 DEFUN ("read-variable", Fread_variable, Sread_variable, 1, 2, 0,
1136 doc: /* Read the name of a user variable and return it as a symbol.
1137 Prompt with PROMPT. By default, return DEFAULT-VALUE.
1138 A user variable is one for which `user-variable-p' returns non-nil. */)
1139 (prompt, default_value)
1140 Lisp_Object prompt, default_value;
1142 Lisp_Object name, default_string;
1144 if (NILP (default_value))
1145 default_string = Qnil;
1146 else if (SYMBOLP (default_value))
1147 default_string = SYMBOL_NAME (default_value);
1148 else
1149 default_string = default_value;
1151 name = Fcompleting_read (prompt, Vobarray,
1152 Quser_variable_p, Qt,
1153 Qnil, Qnil, default_string, Qnil);
1154 if (NILP (name))
1155 return name;
1156 return Fintern (name, Qnil);
1159 DEFUN ("read-buffer", Fread_buffer, Sread_buffer, 1, 3, 0,
1160 doc: /* Read the name of a buffer and return as a string.
1161 Prompt with PROMPT.
1162 Optional second arg DEF is value to return if user enters an empty line.
1163 If optional third arg REQUIRE-MATCH is non-nil,
1164 only existing buffer names are allowed.
1165 The argument PROMPT should be a string ending with a colon and a space. */)
1166 (prompt, def, require_match)
1167 Lisp_Object prompt, def, require_match;
1169 Lisp_Object args[4];
1170 unsigned char *s;
1171 int len;
1173 if (BUFFERP (def))
1174 def = XBUFFER (def)->name;
1176 if (NILP (Vread_buffer_function))
1178 if (!NILP (def))
1180 /* A default value was provided: we must change PROMPT,
1181 editing the default value in before the colon. To achieve
1182 this, we replace PROMPT with a substring that doesn't
1183 contain the terminal space and colon (if present). They
1184 are then added back using Fformat. */
1186 if (STRINGP (prompt))
1188 s = SDATA (prompt);
1189 len = strlen (s);
1190 if (len >= 2 && s[len - 2] == ':' && s[len - 1] == ' ')
1191 len = len - 2;
1192 else if (len >= 1 && (s[len - 1] == ':' || s[len - 1] == ' '))
1193 len--;
1195 prompt = make_specified_string (s, -1, len,
1196 STRING_MULTIBYTE (prompt));
1199 args[0] = build_string ("%s (default %s): ");
1200 args[1] = prompt;
1201 args[2] = def;
1202 prompt = Fformat (3, args);
1205 return Fcompleting_read (prompt, intern ("internal-complete-buffer"),
1206 Qnil, require_match, Qnil, Qbuffer_name_history,
1207 def, Qnil);
1209 else
1211 args[0] = Vread_buffer_function;
1212 args[1] = prompt;
1213 args[2] = def;
1214 args[3] = require_match;
1215 return Ffuncall(4, args);
1219 static Lisp_Object
1220 minibuf_conform_representation (string, basis)
1221 Lisp_Object string, basis;
1223 if (STRING_MULTIBYTE (string) == STRING_MULTIBYTE (basis))
1224 return string;
1226 if (STRING_MULTIBYTE (string))
1227 return Fstring_make_unibyte (string);
1228 else
1229 return Fstring_make_multibyte (string);
1232 DEFUN ("try-completion", Ftry_completion, Stry_completion, 2, 3, 0,
1233 doc: /* Return common substring of all completions of STRING in ALIST.
1234 Each car of each element of ALIST (or each element if it is not a cons cell)
1235 is tested to see if it begins with STRING. The possible matches may be
1236 strings or symbols. Symbols are converted to strings before testing,
1237 see `symbol-name'.
1238 All that match are compared together; the longest initial sequence
1239 common to all matches is returned as a string.
1240 If there is no match at all, nil is returned.
1241 For a unique match which is exact, t is returned.
1243 If ALIST is a hash-table, all the string and symbol keys are the
1244 possible matches.
1245 If ALIST is an obarray, the names of all symbols in the obarray
1246 are the possible matches.
1248 ALIST can also be a function to do the completion itself.
1249 It receives three arguments: the values STRING, PREDICATE and nil.
1250 Whatever it returns becomes the value of `try-completion'.
1252 If optional third argument PREDICATE is non-nil,
1253 it is used to test each possible match.
1254 The match is a candidate only if PREDICATE returns non-nil.
1255 The argument given to PREDICATE is the alist element
1256 or the symbol from the obarray. If ALIST is a hash-table,
1257 predicate is called with two arguments: the key and the value.
1258 Additionally to this predicate, `completion-regexp-list'
1259 is used to further constrain the set of candidates. */)
1260 (string, alist, predicate)
1261 Lisp_Object string, alist, predicate;
1263 Lisp_Object bestmatch, tail, elt, eltstring;
1264 /* Size in bytes of BESTMATCH. */
1265 int bestmatchsize = 0;
1266 /* These are in bytes, too. */
1267 int compare, matchsize;
1268 int type = (HASH_TABLE_P (alist) ? 3
1269 : VECTORP (alist) ? 2
1270 : NILP (alist) || (CONSP (alist)
1271 && (!SYMBOLP (XCAR (alist))
1272 || NILP (XCAR (alist)))));
1273 int index = 0, obsize = 0;
1274 int matchcount = 0;
1275 int bindcount = -1;
1276 Lisp_Object bucket, zero, end, tem;
1277 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
1279 CHECK_STRING (string);
1280 if (type == 0)
1281 return call3 (alist, string, predicate, Qnil);
1283 bestmatch = bucket = Qnil;
1284 zero = make_number (0);
1286 /* If ALIST is not a list, set TAIL just for gc pro. */
1287 tail = alist;
1288 if (type == 2)
1290 obsize = XVECTOR (alist)->size;
1291 bucket = XVECTOR (alist)->contents[index];
1294 while (1)
1296 /* Get the next element of the alist, obarray, or hash-table. */
1297 /* Exit the loop if the elements are all used up. */
1298 /* elt gets the alist element or symbol.
1299 eltstring gets the name to check as a completion. */
1301 if (type == 1)
1303 if (!CONSP (tail))
1304 break;
1305 elt = XCAR (tail);
1306 eltstring = CONSP (elt) ? XCAR (elt) : elt;
1307 tail = XCDR (tail);
1309 else if (type == 2)
1311 if (!EQ (bucket, zero))
1313 elt = bucket;
1314 eltstring = elt;
1315 if (XSYMBOL (bucket)->next)
1316 XSETSYMBOL (bucket, XSYMBOL (bucket)->next);
1317 else
1318 XSETFASTINT (bucket, 0);
1320 else if (++index >= obsize)
1321 break;
1322 else
1324 bucket = XVECTOR (alist)->contents[index];
1325 continue;
1328 else /* if (type == 3) */
1330 while (index < HASH_TABLE_SIZE (XHASH_TABLE (alist))
1331 && NILP (HASH_HASH (XHASH_TABLE (alist), index)))
1332 index++;
1333 if (index >= HASH_TABLE_SIZE (XHASH_TABLE (alist)))
1334 break;
1335 else
1336 elt = eltstring = HASH_KEY (XHASH_TABLE (alist), index++);
1339 /* Is this element a possible completion? */
1341 if (SYMBOLP (eltstring))
1342 eltstring = Fsymbol_name (eltstring);
1344 if (STRINGP (eltstring)
1345 && SCHARS (string) <= SCHARS (eltstring)
1346 && (tem = Fcompare_strings (eltstring, zero,
1347 make_number (SCHARS (string)),
1348 string, zero, Qnil,
1349 completion_ignore_case ? Qt : Qnil),
1350 EQ (Qt, tem)))
1352 /* Yes. */
1353 Lisp_Object regexps;
1355 /* Ignore this element if it fails to match all the regexps. */
1357 for (regexps = Vcompletion_regexp_list; CONSP (regexps);
1358 regexps = XCDR (regexps))
1360 if (bindcount < 0) {
1361 bindcount = SPECPDL_INDEX ();
1362 specbind (Qcase_fold_search,
1363 completion_ignore_case ? Qt : Qnil);
1365 tem = Fstring_match (XCAR (regexps), eltstring, zero);
1366 if (NILP (tem))
1367 break;
1369 if (CONSP (regexps))
1370 continue;
1373 /* Ignore this element if there is a predicate
1374 and the predicate doesn't like it. */
1376 if (!NILP (predicate))
1378 if (EQ (predicate, Qcommandp))
1379 tem = Fcommandp (elt, Qnil);
1380 else
1382 if (bindcount >= 0) {
1383 unbind_to (bindcount, Qnil);
1384 bindcount = -1;
1386 GCPRO4 (tail, string, eltstring, bestmatch);
1387 tem = type == 3
1388 ? call2 (predicate, elt,
1389 HASH_VALUE (XHASH_TABLE (alist), index - 1))
1390 : call1 (predicate, elt);
1391 UNGCPRO;
1393 if (NILP (tem)) continue;
1396 /* Update computation of how much all possible completions match */
1398 if (NILP (bestmatch))
1400 matchcount = 1;
1401 bestmatch = eltstring;
1402 bestmatchsize = SCHARS (eltstring);
1404 else
1406 compare = min (bestmatchsize, SCHARS (eltstring));
1407 tem = Fcompare_strings (bestmatch, zero,
1408 make_number (compare),
1409 eltstring, zero,
1410 make_number (compare),
1411 completion_ignore_case ? Qt : Qnil);
1412 if (EQ (tem, Qt))
1413 matchsize = compare;
1414 else if (XINT (tem) < 0)
1415 matchsize = - XINT (tem) - 1;
1416 else
1417 matchsize = XINT (tem) - 1;
1419 if (matchsize < 0)
1420 /* When can this happen ? -stef */
1421 matchsize = compare;
1422 if (completion_ignore_case)
1424 /* If this is an exact match except for case,
1425 use it as the best match rather than one that is not an
1426 exact match. This way, we get the case pattern
1427 of the actual match. */
1428 if ((matchsize == SCHARS (eltstring)
1429 && matchsize < SCHARS (bestmatch))
1431 /* If there is more than one exact match ignoring case,
1432 and one of them is exact including case,
1433 prefer that one. */
1434 /* If there is no exact match ignoring case,
1435 prefer a match that does not change the case
1436 of the input. */
1437 ((matchsize == SCHARS (eltstring))
1439 (matchsize == SCHARS (bestmatch))
1440 && (tem = Fcompare_strings (eltstring, zero,
1441 make_number (SCHARS (string)),
1442 string, zero,
1443 Qnil,
1444 Qnil),
1445 EQ (Qt, tem))
1446 && (tem = Fcompare_strings (bestmatch, zero,
1447 make_number (SCHARS (string)),
1448 string, zero,
1449 Qnil,
1450 Qnil),
1451 ! EQ (Qt, tem))))
1452 bestmatch = eltstring;
1454 if (bestmatchsize != SCHARS (eltstring)
1455 || bestmatchsize != matchsize)
1456 /* Don't count the same string multiple times. */
1457 matchcount++;
1458 bestmatchsize = matchsize;
1459 if (matchsize <= SCHARS (string)
1460 && matchcount > 1)
1461 /* No need to look any further. */
1462 break;
1467 if (bindcount >= 0) {
1468 unbind_to (bindcount, Qnil);
1469 bindcount = -1;
1472 if (NILP (bestmatch))
1473 return Qnil; /* No completions found */
1474 /* If we are ignoring case, and there is no exact match,
1475 and no additional text was supplied,
1476 don't change the case of what the user typed. */
1477 if (completion_ignore_case && bestmatchsize == SCHARS (string)
1478 && SCHARS (bestmatch) > bestmatchsize)
1479 return minibuf_conform_representation (string, bestmatch);
1481 /* Return t if the supplied string is an exact match (counting case);
1482 it does not require any change to be made. */
1483 if (matchcount == 1 && bestmatchsize == SCHARS (string)
1484 && (tem = Fcompare_strings (bestmatch, make_number (0),
1485 make_number (bestmatchsize),
1486 string, make_number (0),
1487 make_number (bestmatchsize),
1488 Qnil),
1489 EQ (Qt, tem)))
1490 return Qt;
1492 XSETFASTINT (zero, 0); /* Else extract the part in which */
1493 XSETFASTINT (end, bestmatchsize); /* all completions agree */
1494 return Fsubstring (bestmatch, zero, end);
1497 DEFUN ("all-completions", Fall_completions, Sall_completions, 2, 4, 0,
1498 doc: /* Search for partial matches to STRING in ALIST.
1499 Each car of each element of ALIST (or each element if it is not a cons cell)
1500 is tested to see if it begins with STRING. The possible matches may be
1501 strings or symbols. Symbols are converted to strings before testing,
1502 see `symbol-name'.
1503 The value is a list of all the strings from ALIST that match.
1505 If ALIST is a hash-table, all the string and symbol keys are the
1506 possible matches.
1507 If ALIST is an obarray, the names of all symbols in the obarray
1508 are the possible matches.
1510 ALIST can also be a function to do the completion itself.
1511 It receives three arguments: the values STRING, PREDICATE and t.
1512 Whatever it returns becomes the value of `all-completions'.
1514 If optional third argument PREDICATE is non-nil,
1515 it is used to test each possible match.
1516 The match is a candidate only if PREDICATE returns non-nil.
1517 The argument given to PREDICATE is the alist element
1518 or the symbol from the obarray. If ALIST is a hash-table,
1519 predicate is called with two arguments: the key and the value.
1520 Additionally to this predicate, `completion-regexp-list'
1521 is used to further constrain the set of candidates.
1523 If the optional fourth argument HIDE-SPACES is non-nil,
1524 strings in ALIST that start with a space
1525 are ignored unless STRING itself starts with a space. */)
1526 (string, alist, predicate, hide_spaces)
1527 Lisp_Object string, alist, predicate, hide_spaces;
1529 Lisp_Object tail, elt, eltstring;
1530 Lisp_Object allmatches;
1531 int type = HASH_TABLE_P (alist) ? 3
1532 : VECTORP (alist) ? 2
1533 : NILP (alist) || (CONSP (alist)
1534 && (!SYMBOLP (XCAR (alist))
1535 || NILP (XCAR (alist))));
1536 int index = 0, obsize = 0;
1537 int bindcount = -1;
1538 Lisp_Object bucket, tem, zero;
1539 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
1541 CHECK_STRING (string);
1542 if (type == 0)
1543 return call3 (alist, string, predicate, Qt);
1544 allmatches = bucket = Qnil;
1545 zero = make_number (0);
1547 /* If ALIST is not a list, set TAIL just for gc pro. */
1548 tail = alist;
1549 if (type == 2)
1551 obsize = XVECTOR (alist)->size;
1552 bucket = XVECTOR (alist)->contents[index];
1555 while (1)
1557 /* Get the next element of the alist, obarray, or hash-table. */
1558 /* Exit the loop if the elements are all used up. */
1559 /* elt gets the alist element or symbol.
1560 eltstring gets the name to check as a completion. */
1562 if (type == 1)
1564 if (!CONSP (tail))
1565 break;
1566 elt = XCAR (tail);
1567 eltstring = CONSP (elt) ? XCAR (elt) : elt;
1568 tail = XCDR (tail);
1570 else if (type == 2)
1572 if (!EQ (bucket, zero))
1574 elt = bucket;
1575 eltstring = elt;
1576 if (XSYMBOL (bucket)->next)
1577 XSETSYMBOL (bucket, XSYMBOL (bucket)->next);
1578 else
1579 XSETFASTINT (bucket, 0);
1581 else if (++index >= obsize)
1582 break;
1583 else
1585 bucket = XVECTOR (alist)->contents[index];
1586 continue;
1589 else /* if (type == 3) */
1591 while (index < HASH_TABLE_SIZE (XHASH_TABLE (alist))
1592 && NILP (HASH_HASH (XHASH_TABLE (alist), index)))
1593 index++;
1594 if (index >= HASH_TABLE_SIZE (XHASH_TABLE (alist)))
1595 break;
1596 else
1597 elt = eltstring = HASH_KEY (XHASH_TABLE (alist), index++);
1600 /* Is this element a possible completion? */
1602 if (SYMBOLP (eltstring))
1603 eltstring = Fsymbol_name (eltstring);
1605 if (STRINGP (eltstring)
1606 && SCHARS (string) <= SCHARS (eltstring)
1607 /* If HIDE_SPACES, reject alternatives that start with space
1608 unless the input starts with space. */
1609 && ((SBYTES (string) > 0
1610 && SREF (string, 0) == ' ')
1611 || SREF (eltstring, 0) != ' '
1612 || NILP (hide_spaces))
1613 && (tem = Fcompare_strings (eltstring, zero,
1614 make_number (SCHARS (string)),
1615 string, zero,
1616 make_number (SCHARS (string)),
1617 completion_ignore_case ? Qt : Qnil),
1618 EQ (Qt, tem)))
1620 /* Yes. */
1621 Lisp_Object regexps;
1622 Lisp_Object zero;
1623 XSETFASTINT (zero, 0);
1625 /* Ignore this element if it fails to match all the regexps. */
1627 for (regexps = Vcompletion_regexp_list; CONSP (regexps);
1628 regexps = XCDR (regexps))
1630 if (bindcount < 0) {
1631 bindcount = SPECPDL_INDEX ();
1632 specbind (Qcase_fold_search,
1633 completion_ignore_case ? Qt : Qnil);
1635 tem = Fstring_match (XCAR (regexps), eltstring, zero);
1636 if (NILP (tem))
1637 break;
1639 if (CONSP (regexps))
1640 continue;
1643 /* Ignore this element if there is a predicate
1644 and the predicate doesn't like it. */
1646 if (!NILP (predicate))
1648 if (EQ (predicate, Qcommandp))
1649 tem = Fcommandp (elt, Qnil);
1650 else
1652 if (bindcount >= 0) {
1653 unbind_to (bindcount, Qnil);
1654 bindcount = -1;
1656 GCPRO4 (tail, eltstring, allmatches, string);
1657 tem = type == 3
1658 ? call2 (predicate, elt,
1659 HASH_VALUE (XHASH_TABLE (alist), index - 1))
1660 : call1 (predicate, elt);
1661 UNGCPRO;
1663 if (NILP (tem)) continue;
1665 /* Ok => put it on the list. */
1666 allmatches = Fcons (eltstring, allmatches);
1670 if (bindcount >= 0) {
1671 unbind_to (bindcount, Qnil);
1672 bindcount = -1;
1675 return Fnreverse (allmatches);
1678 Lisp_Object Vminibuffer_completion_table, Qminibuffer_completion_table;
1679 Lisp_Object Vminibuffer_completion_predicate, Qminibuffer_completion_predicate;
1680 Lisp_Object Vminibuffer_completion_confirm, Qminibuffer_completion_confirm;
1681 Lisp_Object Vminibuffer_completing_file_name;
1683 DEFUN ("completing-read", Fcompleting_read, Scompleting_read, 2, 8, 0,
1684 doc: /* Read a string in the minibuffer, with completion.
1685 PROMPT is a string to prompt with; normally it ends in a colon and a space.
1686 TABLE can be a list of strings, an alist, an obarray or a hash table.
1687 TABLE can also be a function to do the completion itself.
1688 PREDICATE limits completion to a subset of TABLE.
1689 See `try-completion' and `all-completions' for more details
1690 on completion, TABLE, and PREDICATE.
1692 If REQUIRE-MATCH is non-nil, the user is not allowed to exit unless
1693 the input is (or completes to) an element of TABLE or is null.
1694 If it is also not t, typing RET does not exit if it does non-null completion.
1695 If the input is null, `completing-read' returns DEF, or an empty string
1696 if DEF is nil, regardless of the value of REQUIRE-MATCH.
1698 If INITIAL-INPUT is non-nil, insert it in the minibuffer initially,
1699 with point positioned at the end.
1700 If it is (STRING . POSITION), the initial input is STRING, but point
1701 is placed at _zero-indexed_ position POSITION in STRING. (*Note*
1702 that this is different from `read-from-minibuffer' and related
1703 functions, which use one-indexing for POSITION.) This feature is
1704 deprecated--it is best to pass nil for INITIAL-INPUT and supply the
1705 default value DEF instead. The user can yank the default value into
1706 the minibuffer easily using \\[next-history-element].
1708 HIST, if non-nil, specifies a history list and optionally the initial
1709 position in the list. It can be a symbol, which is the history list
1710 variable to use, or it can be a cons cell (HISTVAR . HISTPOS). In
1711 that case, HISTVAR is the history list variable to use, and HISTPOS
1712 is the initial position (the position in the list used by the
1713 minibuffer history commands). For consistency, you should also
1714 specify that element of the history as the value of
1715 INITIAL-INPUT. (This is the only case in which you should use
1716 INITIAL-INPUT instead of DEF.) Positions are counted starting from
1717 1 at the beginning of the list. The variable `history-length'
1718 controls the maximum length of a history list.
1720 DEF, if non-nil, is the default value.
1722 If INHERIT-INPUT-METHOD is non-nil, the minibuffer inherits
1723 the current input method and the setting of `enable-multibyte-characters'.
1725 Completion ignores case if the ambient value of
1726 `completion-ignore-case' is non-nil. */)
1727 (prompt, table, predicate, require_match, initial_input, hist, def, inherit_input_method)
1728 Lisp_Object prompt, table, predicate, require_match, initial_input;
1729 Lisp_Object hist, def, inherit_input_method;
1731 Lisp_Object val, histvar, histpos, position;
1732 Lisp_Object init;
1733 int pos = 0;
1734 int count = SPECPDL_INDEX ();
1735 struct gcpro gcpro1;
1737 init = initial_input;
1738 GCPRO1 (def);
1740 specbind (Qminibuffer_completion_table, table);
1741 specbind (Qminibuffer_completion_predicate, predicate);
1742 specbind (Qminibuffer_completion_confirm,
1743 EQ (require_match, Qt) ? Qnil : require_match);
1744 last_exact_completion = Qnil;
1746 position = Qnil;
1747 if (!NILP (init))
1749 if (CONSP (init))
1751 position = Fcdr (init);
1752 init = Fcar (init);
1754 CHECK_STRING (init);
1755 if (!NILP (position))
1757 CHECK_NUMBER (position);
1758 /* Convert to distance from end of input. */
1759 pos = XINT (position) - SCHARS (init);
1763 if (SYMBOLP (hist))
1765 histvar = hist;
1766 histpos = Qnil;
1768 else
1770 histvar = Fcar_safe (hist);
1771 histpos = Fcdr_safe (hist);
1773 if (NILP (histvar))
1774 histvar = Qminibuffer_history;
1775 if (NILP (histpos))
1776 XSETFASTINT (histpos, 0);
1778 val = read_minibuf (NILP (require_match)
1779 ? (NILP (Vminibuffer_completing_file_name)
1780 ? Vminibuffer_local_completion_map
1781 : Vminibuffer_local_filename_completion_map)
1782 : (NILP (Vminibuffer_completing_file_name)
1783 ? Vminibuffer_local_must_match_map
1784 : Vminibuffer_local_must_match_filename_map),
1785 init, prompt, make_number (pos), 0,
1786 histvar, histpos, def, 0,
1787 !NILP (inherit_input_method));
1789 if (STRINGP (val) && SCHARS (val) == 0 && ! NILP (def))
1790 val = def;
1792 RETURN_UNGCPRO (unbind_to (count, val));
1795 Lisp_Object Fminibuffer_completion_help ();
1796 Lisp_Object Fassoc_string ();
1798 /* Test whether TXT is an exact completion. */
1799 DEFUN ("test-completion", Ftest_completion, Stest_completion, 2, 3, 0,
1800 doc: /* Return non-nil if STRING is a valid completion.
1801 Takes the same arguments as `all-completions' and `try-completion'.
1802 If ALIST is a function, it is called with three arguments:
1803 the values STRING, PREDICATE and `lambda'. */)
1804 (string, alist, predicate)
1805 Lisp_Object string, alist, predicate;
1807 Lisp_Object regexps, tail, tem = Qnil;
1808 int i = 0;
1810 CHECK_STRING (string);
1812 if ((CONSP (alist) && (!SYMBOLP (XCAR (alist)) || NILP (XCAR (alist))))
1813 || NILP (alist))
1815 tem = Fassoc_string (string, alist, completion_ignore_case ? Qt : Qnil);
1816 if (NILP (tem))
1817 return Qnil;
1819 else if (VECTORP (alist))
1821 /* Bypass intern-soft as that loses for nil. */
1822 tem = oblookup (alist,
1823 SDATA (string),
1824 SCHARS (string),
1825 SBYTES (string));
1826 if (!SYMBOLP (tem))
1828 if (STRING_MULTIBYTE (string))
1829 string = Fstring_make_unibyte (string);
1830 else
1831 string = Fstring_make_multibyte (string);
1833 tem = oblookup (alist,
1834 SDATA (string),
1835 SCHARS (string),
1836 SBYTES (string));
1839 if (completion_ignore_case && !SYMBOLP (tem))
1841 for (i = XVECTOR (alist)->size - 1; i >= 0; i--)
1843 tail = XVECTOR (alist)->contents[i];
1844 if (SYMBOLP (tail))
1845 while (1)
1847 if (EQ((Fcompare_strings (string, make_number (0), Qnil,
1848 Fsymbol_name (tail),
1849 make_number (0) , Qnil, Qt)),
1850 Qt))
1852 tem = tail;
1853 break;
1855 if (XSYMBOL (tail)->next == 0)
1856 break;
1857 XSETSYMBOL (tail, XSYMBOL (tail)->next);
1862 if (!SYMBOLP (tem))
1863 return Qnil;
1865 else if (HASH_TABLE_P (alist))
1867 struct Lisp_Hash_Table *h = XHASH_TABLE (alist);
1868 i = hash_lookup (h, string, NULL);
1869 if (i >= 0)
1870 tem = HASH_KEY (h, i);
1871 else
1872 for (i = 0; i < HASH_TABLE_SIZE (h); ++i)
1873 if (!NILP (HASH_HASH (h, i)) &&
1874 EQ (Fcompare_strings (string, make_number (0), Qnil,
1875 HASH_KEY (h, i), make_number (0) , Qnil,
1876 completion_ignore_case ? Qt : Qnil),
1877 Qt))
1879 tem = HASH_KEY (h, i);
1880 break;
1882 if (!STRINGP (tem))
1883 return Qnil;
1885 else
1886 return call3 (alist, string, predicate, Qlambda);
1888 /* Reject this element if it fails to match all the regexps. */
1889 if (CONSP (Vcompletion_regexp_list))
1891 int count = SPECPDL_INDEX ();
1892 specbind (Qcase_fold_search, completion_ignore_case ? Qt : Qnil);
1893 for (regexps = Vcompletion_regexp_list; CONSP (regexps);
1894 regexps = XCDR (regexps))
1896 if (NILP (Fstring_match (XCAR (regexps),
1897 SYMBOLP (tem) ? string : tem,
1898 Qnil)))
1899 return unbind_to (count, Qnil);
1901 unbind_to (count, Qnil);
1904 /* Finally, check the predicate. */
1905 if (!NILP (predicate))
1907 return HASH_TABLE_P (alist)
1908 ? call2 (predicate, tem, HASH_VALUE (XHASH_TABLE (alist), i))
1909 : call1 (predicate, tem);
1911 else
1912 return Qt;
1915 DEFUN ("internal-complete-buffer", Finternal_complete_buffer, Sinternal_complete_buffer, 3, 3, 0,
1916 doc: /* Perform completion on buffer names.
1917 If the argument FLAG is nil, invoke `try-completion', if it's t, invoke
1918 `all-completions', otherwise invoke `test-completion'.
1920 The arguments STRING and PREDICATE are as in `try-completion',
1921 `all-completions', and `test-completion'. */)
1922 (string, predicate, flag)
1923 Lisp_Object string, predicate, flag;
1925 if (NILP (flag))
1926 return Ftry_completion (string, Vbuffer_alist, predicate);
1927 else if (EQ (flag, Qt))
1928 return Fall_completions (string, Vbuffer_alist, predicate, Qt);
1929 else /* assume `lambda' */
1930 return Ftest_completion (string, Vbuffer_alist, predicate);
1933 /* returns:
1934 * 0 no possible completion
1935 * 1 was already an exact and unique completion
1936 * 3 was already an exact completion
1937 * 4 completed to an exact completion
1938 * 5 some completion happened
1939 * 6 no completion happened
1942 do_completion ()
1944 Lisp_Object completion, string, tem;
1945 int completedp;
1946 Lisp_Object last;
1947 struct gcpro gcpro1, gcpro2;
1949 completion = Ftry_completion (Fminibuffer_completion_contents (),
1950 Vminibuffer_completion_table,
1951 Vminibuffer_completion_predicate);
1952 last = last_exact_completion;
1953 last_exact_completion = Qnil;
1955 GCPRO2 (completion, last);
1957 if (NILP (completion))
1959 bitch_at_user ();
1960 temp_echo_area_glyphs (build_string (" [No match]"));
1961 UNGCPRO;
1962 return 0;
1965 if (EQ (completion, Qt)) /* exact and unique match */
1967 UNGCPRO;
1968 return 1;
1971 string = Fminibuffer_completion_contents ();
1973 /* COMPLETEDP should be true if some completion was done, which
1974 doesn't include simply changing the case of the entered string.
1975 However, for appearance, the string is rewritten if the case
1976 changes. */
1977 tem = Fcompare_strings (completion, Qnil, Qnil, string, Qnil, Qnil, Qt);
1978 completedp = !EQ (tem, Qt);
1980 tem = Fcompare_strings (completion, Qnil, Qnil, string, Qnil, Qnil, Qnil);
1981 if (!EQ (tem, Qt))
1982 /* Rewrite the user's input. */
1984 int prompt_end = XINT (Fminibuffer_prompt_end ());
1985 /* Some completion happened */
1987 if (! NILP (Vminibuffer_completing_file_name)
1988 && SREF (completion, SBYTES (completion) - 1) == '/'
1989 && PT < ZV
1990 && FETCH_CHAR (PT_BYTE) == '/')
1992 del_range (prompt_end, PT + 1);
1994 else
1995 del_range (prompt_end, PT);
1997 Finsert (1, &completion);
1999 if (! completedp)
2000 /* The case of the string changed, but that's all. We're not
2001 sure whether this is a unique completion or not, so try again
2002 using the real case (this shouldn't recurse again, because
2003 the next time try-completion will return either `t' or the
2004 exact string). */
2006 UNGCPRO;
2007 return do_completion ();
2011 /* It did find a match. Do we match some possibility exactly now? */
2012 tem = Ftest_completion (Fminibuffer_contents (),
2013 Vminibuffer_completion_table,
2014 Vminibuffer_completion_predicate);
2015 if (NILP (tem))
2017 /* not an exact match */
2018 UNGCPRO;
2019 if (completedp)
2020 return 5;
2021 else if (!NILP (Vcompletion_auto_help))
2022 Fminibuffer_completion_help ();
2023 else
2024 temp_echo_area_glyphs (build_string (" [Next char not unique]"));
2025 return 6;
2027 else if (completedp)
2029 UNGCPRO;
2030 return 4;
2032 /* If the last exact completion and this one were the same,
2033 it means we've already given a "Complete but not unique"
2034 message and the user's hit TAB again, so now we give him help. */
2035 last_exact_completion = completion;
2036 if (!NILP (last))
2038 tem = Fminibuffer_completion_contents ();
2039 if (!NILP (Fequal (tem, last)))
2040 Fminibuffer_completion_help ();
2042 UNGCPRO;
2043 return 3;
2046 /* Like assoc but assumes KEY is a string, and ignores case if appropriate. */
2048 DEFUN ("assoc-string", Fassoc_string, Sassoc_string, 2, 3, 0,
2049 doc: /* Like `assoc' but specifically for strings.
2050 Unibyte strings are converted to multibyte for comparison.
2051 And case is ignored if CASE-FOLD is non-nil.
2052 As opposed to `assoc', it will also match an entry consisting of a single
2053 string rather than a cons cell whose car is a string. */)
2054 (key, list, case_fold)
2055 register Lisp_Object key;
2056 Lisp_Object list, case_fold;
2058 register Lisp_Object tail;
2060 for (tail = list; !NILP (tail); tail = Fcdr (tail))
2062 register Lisp_Object elt, tem, thiscar;
2063 elt = Fcar (tail);
2064 thiscar = CONSP (elt) ? XCAR (elt) : elt;
2065 if (!STRINGP (thiscar))
2066 continue;
2067 tem = Fcompare_strings (thiscar, make_number (0), Qnil,
2068 key, make_number (0), Qnil,
2069 case_fold);
2070 if (EQ (tem, Qt))
2071 return elt;
2072 QUIT;
2074 return Qnil;
2077 DEFUN ("minibuffer-complete", Fminibuffer_complete, Sminibuffer_complete, 0, 0, "",
2078 doc: /* Complete the minibuffer contents as far as possible.
2079 Return nil if there is no valid completion, else t.
2080 If no characters can be completed, display a list of possible completions.
2081 If you repeat this command after it displayed such a list,
2082 scroll the window of possible completions. */)
2085 register int i;
2086 Lisp_Object window, tem;
2088 /* If the previous command was not this,
2089 mark the completion buffer obsolete. */
2090 if (! EQ (current_kboard->Vlast_command, Vthis_command))
2091 Vminibuf_scroll_window = Qnil;
2093 window = Vminibuf_scroll_window;
2094 /* If there's a fresh completion window with a live buffer,
2095 and this command is repeated, scroll that window. */
2096 if (! NILP (window) && ! NILP (XWINDOW (window)->buffer)
2097 && !NILP (XBUFFER (XWINDOW (window)->buffer)->name))
2099 struct buffer *obuf = current_buffer;
2101 Fset_buffer (XWINDOW (window)->buffer);
2102 tem = Fpos_visible_in_window_p (make_number (ZV), window, Qnil);
2103 if (! NILP (tem))
2104 /* If end is in view, scroll up to the beginning. */
2105 Fset_window_start (window, make_number (BEGV), Qnil);
2106 else
2107 /* Else scroll down one screen. */
2108 Fscroll_other_window (Qnil);
2110 set_buffer_internal (obuf);
2111 return Qnil;
2114 i = do_completion ();
2115 switch (i)
2117 case 0:
2118 return Qnil;
2120 case 1:
2121 if (PT != ZV)
2122 Fgoto_char (make_number (ZV));
2123 temp_echo_area_glyphs (build_string (" [Sole completion]"));
2124 break;
2126 case 3:
2127 if (PT != ZV)
2128 Fgoto_char (make_number (ZV));
2129 temp_echo_area_glyphs (build_string (" [Complete, but not unique]"));
2130 break;
2133 return Qt;
2136 /* Subroutines of Fminibuffer_complete_and_exit. */
2138 /* This one is called by internal_condition_case to do the real work. */
2140 Lisp_Object
2141 complete_and_exit_1 ()
2143 return make_number (do_completion ());
2146 /* This one is called by internal_condition_case if an error happens.
2147 Pretend the current value is an exact match. */
2149 Lisp_Object
2150 complete_and_exit_2 (ignore)
2151 Lisp_Object ignore;
2153 return make_number (1);
2156 EXFUN (Fexit_minibuffer, 0) NO_RETURN;
2158 DEFUN ("minibuffer-complete-and-exit", Fminibuffer_complete_and_exit,
2159 Sminibuffer_complete_and_exit, 0, 0, "",
2160 doc: /* If the minibuffer contents is a valid completion then exit.
2161 Otherwise try to complete it. If completion leads to a valid completion,
2162 a repetition of this command will exit. */)
2165 register int i;
2166 Lisp_Object val, tem;
2168 /* Allow user to specify null string */
2169 if (XINT (Fminibuffer_prompt_end ()) == ZV)
2170 goto exit;
2172 val = Fminibuffer_contents ();
2173 tem = Ftest_completion (val,
2174 Vminibuffer_completion_table,
2175 Vminibuffer_completion_predicate);
2176 if (!NILP (tem))
2178 if (completion_ignore_case)
2179 { /* Fixup case of the field, if necessary. */
2180 Lisp_Object compl
2181 = Ftry_completion (val,
2182 Vminibuffer_completion_table,
2183 Vminibuffer_completion_predicate);
2184 if (STRINGP (compl)
2185 /* If it weren't for this piece of paranoia, I'd replace
2186 the whole thing with a call to do_completion. */
2187 && EQ (Flength (val), Flength (compl)))
2189 del_range (XINT (Fminibuffer_prompt_end ()), ZV);
2190 Finsert (1, &compl);
2193 goto exit;
2196 /* Call do_completion, but ignore errors. */
2197 SET_PT (ZV);
2198 val = internal_condition_case (complete_and_exit_1, Qerror,
2199 complete_and_exit_2);
2201 i = XFASTINT (val);
2202 switch (i)
2204 case 1:
2205 case 3:
2206 goto exit;
2208 case 4:
2209 if (!NILP (Vminibuffer_completion_confirm))
2211 temp_echo_area_glyphs (build_string (" [Confirm]"));
2212 return Qnil;
2214 else
2215 goto exit;
2217 default:
2218 return Qnil;
2220 exit:
2221 return Fexit_minibuffer ();
2222 /* NOTREACHED */
2225 DEFUN ("minibuffer-complete-word", Fminibuffer_complete_word, Sminibuffer_complete_word,
2226 0, 0, "",
2227 doc: /* Complete the minibuffer contents at most a single word.
2228 After one word is completed as much as possible, a space or hyphen
2229 is added, provided that matches some possible completion.
2230 Return nil if there is no valid completion, else t. */)
2233 Lisp_Object completion, tem, tem1;
2234 register int i, i_byte;
2235 struct gcpro gcpro1, gcpro2;
2236 int prompt_end_charpos = XINT (Fminibuffer_prompt_end ());
2238 /* We keep calling Fbuffer_string rather than arrange for GC to
2239 hold onto a pointer to one of the strings thus made. */
2241 completion = Ftry_completion (Fminibuffer_completion_contents (),
2242 Vminibuffer_completion_table,
2243 Vminibuffer_completion_predicate);
2244 if (NILP (completion))
2246 bitch_at_user ();
2247 temp_echo_area_glyphs (build_string (" [No match]"));
2248 return Qnil;
2250 if (EQ (completion, Qt))
2251 return Qnil;
2253 #if 0 /* How the below code used to look, for reference. */
2254 tem = Fminibuffer_contents ();
2255 b = SDATA (tem);
2256 i = ZV - 1 - SCHARS (completion);
2257 p = SDATA (completion);
2258 if (i > 0 ||
2259 0 <= scmp (b, p, ZV - 1))
2261 i = 1;
2262 /* Set buffer to longest match of buffer tail and completion head. */
2263 while (0 <= scmp (b + i, p, ZV - 1 - i))
2264 i++;
2265 del_range (1, i + 1);
2266 SET_PT (ZV);
2268 #else /* Rewritten code */
2270 int buffer_nchars, completion_nchars;
2272 CHECK_STRING (completion);
2273 tem = Fminibuffer_completion_contents ();
2274 GCPRO2 (completion, tem);
2275 /* If reading a file name,
2276 expand any $ENVVAR refs in the buffer and in TEM. */
2277 if (! NILP (Vminibuffer_completing_file_name))
2279 Lisp_Object substituted;
2280 substituted = Fsubstitute_in_file_name (tem);
2281 if (! EQ (substituted, tem))
2283 tem = substituted;
2284 del_range (prompt_end_charpos, PT);
2285 Finsert (1, &tem);
2288 buffer_nchars = SCHARS (tem); /* # chars in what we completed. */
2289 completion_nchars = SCHARS (completion);
2290 i = buffer_nchars - completion_nchars;
2291 if (i > 0
2293 (tem1 = Fcompare_strings (tem, make_number (0),
2294 make_number (buffer_nchars),
2295 completion, make_number (0),
2296 make_number (buffer_nchars),
2297 completion_ignore_case ? Qt : Qnil),
2298 ! EQ (tem1, Qt)))
2300 int start_pos;
2302 /* Make buffer (before point) contain the longest match
2303 of TEM's tail and COMPLETION's head. */
2304 if (i <= 0) i = 1;
2305 start_pos= i;
2306 buffer_nchars -= i;
2307 while (i > 0)
2309 tem1 = Fcompare_strings (tem, make_number (start_pos), Qnil,
2310 completion, make_number (0),
2311 make_number (buffer_nchars),
2312 completion_ignore_case ? Qt : Qnil);
2313 start_pos++;
2314 if (EQ (tem1, Qt))
2315 break;
2316 i++;
2317 buffer_nchars--;
2319 del_range (start_pos, start_pos + buffer_nchars);
2321 UNGCPRO;
2323 #endif /* Rewritten code */
2326 int prompt_end_bytepos;
2327 prompt_end_bytepos = CHAR_TO_BYTE (prompt_end_charpos);
2328 i = PT - prompt_end_charpos;
2329 i_byte = PT_BYTE - prompt_end_bytepos;
2332 /* If completion finds next char not unique,
2333 consider adding a space or a hyphen. */
2334 if (i == SCHARS (completion))
2336 GCPRO1 (completion);
2337 tem = Ftry_completion (concat2 (Fminibuffer_completion_contents (),
2338 build_string (" ")),
2339 Vminibuffer_completion_table,
2340 Vminibuffer_completion_predicate);
2341 UNGCPRO;
2343 if (STRINGP (tem))
2344 completion = tem;
2345 else
2347 GCPRO1 (completion);
2348 tem =
2349 Ftry_completion (concat2 (Fminibuffer_completion_contents (),
2350 build_string ("-")),
2351 Vminibuffer_completion_table,
2352 Vminibuffer_completion_predicate);
2353 UNGCPRO;
2355 if (STRINGP (tem))
2356 completion = tem;
2360 /* Now find first word-break in the stuff found by completion.
2361 i gets index in string of where to stop completing. */
2363 int len, c;
2364 int bytes = SBYTES (completion);
2365 register const unsigned char *completion_string = SDATA (completion);
2366 for (; i_byte < SBYTES (completion); i_byte += len, i++)
2368 c = STRING_CHAR_AND_LENGTH (completion_string + i_byte,
2369 bytes - i_byte,
2370 len);
2371 if (SYNTAX (c) != Sword)
2373 i_byte += len;
2374 i++;
2375 break;
2380 /* If got no characters, print help for user. */
2382 if (i == PT - prompt_end_charpos)
2384 if (!NILP (Vcompletion_auto_help))
2385 Fminibuffer_completion_help ();
2386 return Qnil;
2389 /* Otherwise insert in minibuffer the chars we got */
2391 if (! NILP (Vminibuffer_completing_file_name)
2392 && SREF (completion, SBYTES (completion) - 1) == '/'
2393 && PT < ZV
2394 && FETCH_CHAR (PT_BYTE) == '/')
2396 del_range (prompt_end_charpos, PT + 1);
2398 else
2399 del_range (prompt_end_charpos, PT);
2401 insert_from_string (completion, 0, 0, i, i_byte, 1);
2402 return Qt;
2405 DEFUN ("display-completion-list", Fdisplay_completion_list, Sdisplay_completion_list,
2406 1, 2, 0,
2407 doc: /* Display the list of completions, COMPLETIONS, using `standard-output'.
2408 Each element may be just a symbol or string
2409 or may be a list of two strings to be printed as if concatenated.
2410 If it is a list of two strings, the first is the actual completion
2411 alternative, the second serves as annotation.
2412 `standard-output' must be a buffer.
2413 The actual completion alternatives, as inserted, are given `mouse-face'
2414 properties of `highlight'.
2415 At the end, this runs the normal hook `completion-setup-hook'.
2416 It can find the completion buffer in `standard-output'.
2417 The optional second arg COMMON-SUBSTRING is a string.
2418 It is used to put faces, `completions-first-difference' and
2419 `completions-common-part' on the completion buffer. The
2420 `completions-common-part' face is put on the common substring
2421 specified by COMMON-SUBSTRING. If COMMON-SUBSTRING is nil
2422 and the current buffer is not the minibuffer, the faces are not put.
2423 Internally, COMMON-SUBSTRING is bound to `completion-common-substring'
2424 during running `completion-setup-hook'. */)
2425 (completions, common_substring)
2426 Lisp_Object completions;
2427 Lisp_Object common_substring;
2429 Lisp_Object tail, elt;
2430 register int i;
2431 int column = 0;
2432 struct gcpro gcpro1, gcpro2, gcpro3;
2433 struct buffer *old = current_buffer;
2434 int first = 1;
2436 /* Note that (when it matters) every variable
2437 points to a non-string that is pointed to by COMPLETIONS,
2438 except for ELT. ELT can be pointing to a string
2439 when terpri or Findent_to calls a change hook. */
2440 elt = Qnil;
2441 GCPRO3 (completions, elt, common_substring);
2443 if (BUFFERP (Vstandard_output))
2444 set_buffer_internal (XBUFFER (Vstandard_output));
2446 if (NILP (completions))
2447 write_string ("There are no possible completions of what you have typed.",
2448 -1);
2449 else
2451 write_string ("Possible completions are:", -1);
2452 for (tail = completions, i = 0; CONSP (tail); tail = XCDR (tail), i++)
2454 Lisp_Object tem, string;
2455 int length;
2456 Lisp_Object startpos, endpos;
2458 startpos = Qnil;
2460 elt = XCAR (tail);
2461 if (SYMBOLP (elt))
2462 elt = SYMBOL_NAME (elt);
2463 /* Compute the length of this element. */
2464 if (CONSP (elt))
2466 tem = XCAR (elt);
2467 CHECK_STRING (tem);
2468 length = SCHARS (tem);
2470 tem = Fcar (XCDR (elt));
2471 CHECK_STRING (tem);
2472 length += SCHARS (tem);
2474 else
2476 CHECK_STRING (elt);
2477 length = SCHARS (elt);
2480 /* This does a bad job for narrower than usual windows.
2481 Sadly, the window it will appear in is not known
2482 until after the text has been made. */
2484 if (BUFFERP (Vstandard_output))
2485 XSETINT (startpos, BUF_PT (XBUFFER (Vstandard_output)));
2487 /* If the previous completion was very wide,
2488 or we have two on this line already,
2489 don't put another on the same line. */
2490 if (column > 33 || first
2491 /* If this is really wide, don't put it second on a line. */
2492 || (column > 0 && length > 45))
2494 Fterpri (Qnil);
2495 column = 0;
2497 /* Otherwise advance to column 35. */
2498 else
2500 if (BUFFERP (Vstandard_output))
2502 tem = Findent_to (make_number (35), make_number (2));
2504 column = XINT (tem);
2506 else
2510 write_string (" ", -1);
2511 column++;
2513 while (column < 35);
2517 if (BUFFERP (Vstandard_output))
2519 XSETINT (endpos, BUF_PT (XBUFFER (Vstandard_output)));
2520 Fset_text_properties (startpos, endpos,
2521 Qnil, Vstandard_output);
2524 /* Output this element.
2525 If necessary, convert it to unibyte or to multibyte first. */
2526 if (CONSP (elt))
2527 string = Fcar (elt);
2528 else
2529 string = elt;
2530 if (NILP (current_buffer->enable_multibyte_characters)
2531 && STRING_MULTIBYTE (string))
2532 string = Fstring_make_unibyte (string);
2533 else if (!NILP (current_buffer->enable_multibyte_characters)
2534 && !STRING_MULTIBYTE (string))
2535 string = Fstring_make_multibyte (string);
2537 if (BUFFERP (Vstandard_output))
2539 XSETINT (startpos, BUF_PT (XBUFFER (Vstandard_output)));
2541 Fprinc (string, Qnil);
2543 XSETINT (endpos, BUF_PT (XBUFFER (Vstandard_output)));
2545 Fput_text_property (startpos, endpos,
2546 Qmouse_face, intern ("highlight"),
2547 Vstandard_output);
2549 else
2551 Fprinc (string, Qnil);
2554 /* Output the annotation for this element. */
2555 if (CONSP (elt))
2557 if (BUFFERP (Vstandard_output))
2559 XSETINT (startpos, BUF_PT (XBUFFER (Vstandard_output)));
2561 Fprinc (Fcar (Fcdr (elt)), Qnil);
2563 XSETINT (endpos, BUF_PT (XBUFFER (Vstandard_output)));
2565 Fset_text_properties (startpos, endpos, Qnil,
2566 Vstandard_output);
2568 else
2570 Fprinc (Fcar (Fcdr (elt)), Qnil);
2575 /* Update COLUMN for what we have output. */
2576 column += length;
2578 /* If output is to a buffer, recompute COLUMN in a way
2579 that takes account of character widths. */
2580 if (BUFFERP (Vstandard_output))
2582 tem = Fcurrent_column ();
2583 column = XINT (tem);
2586 first = 0;
2590 if (BUFFERP (Vstandard_output))
2591 set_buffer_internal (old);
2593 if (!NILP (Vrun_hooks))
2595 int count1 = SPECPDL_INDEX ();
2597 specbind (intern ("completion-common-substring"), common_substring);
2598 call1 (Vrun_hooks, intern ("completion-setup-hook"));
2600 unbind_to (count1, Qnil);
2603 UNGCPRO;
2605 return Qnil;
2609 static Lisp_Object
2610 display_completion_list_1 (list)
2611 Lisp_Object list;
2613 return Fdisplay_completion_list (list, Qnil);
2616 DEFUN ("minibuffer-completion-help", Fminibuffer_completion_help, Sminibuffer_completion_help,
2617 0, 0, "",
2618 doc: /* Display a list of possible completions of the current minibuffer contents. */)
2621 Lisp_Object completions;
2623 message ("Making completion list...");
2624 completions = Fall_completions (Fminibuffer_completion_contents (),
2625 Vminibuffer_completion_table,
2626 Vminibuffer_completion_predicate,
2627 Qt);
2628 clear_message (1, 0);
2630 if (NILP (completions))
2632 bitch_at_user ();
2633 temp_echo_area_glyphs (build_string (" [No completions]"));
2635 else
2637 /* Sort and remove duplicates. */
2638 Lisp_Object tmp = completions = Fsort (completions, Qstring_lessp);
2639 while (CONSP (tmp))
2641 if (CONSP (XCDR (tmp))
2642 && !NILP (Fequal (XCAR (tmp), XCAR (XCDR (tmp)))))
2643 XSETCDR (tmp, XCDR (XCDR (tmp)));
2644 else
2645 tmp = XCDR (tmp);
2647 internal_with_output_to_temp_buffer ("*Completions*",
2648 display_completion_list_1,
2649 completions);
2651 return Qnil;
2654 DEFUN ("self-insert-and-exit", Fself_insert_and_exit, Sself_insert_and_exit, 0, 0, "",
2655 doc: /* Terminate minibuffer input. */)
2658 if (INTEGERP (last_command_char))
2659 internal_self_insert (XINT (last_command_char), 0);
2660 else
2661 bitch_at_user ();
2663 return Fexit_minibuffer ();
2666 DEFUN ("exit-minibuffer", Fexit_minibuffer, Sexit_minibuffer, 0, 0, "",
2667 doc: /* Terminate this minibuffer argument. */)
2670 /* If the command that uses this has made modifications in the minibuffer,
2671 we don't want them to cause deactivation of the mark in the original
2672 buffer.
2673 A better solution would be to make deactivate-mark buffer-local
2674 (or to turn it into a list of buffers, ...), but in the mean time,
2675 this should do the trick in most cases. */
2676 Vdeactivate_mark = Qnil;
2677 Fthrow (Qexit, Qnil);
2680 DEFUN ("minibuffer-depth", Fminibuffer_depth, Sminibuffer_depth, 0, 0, 0,
2681 doc: /* Return current depth of activations of minibuffer, a nonnegative integer. */)
2684 return make_number (minibuf_level);
2687 DEFUN ("minibuffer-prompt", Fminibuffer_prompt, Sminibuffer_prompt, 0, 0, 0,
2688 doc: /* Return the prompt string of the currently-active minibuffer.
2689 If no minibuffer is active, return nil. */)
2692 return Fcopy_sequence (minibuf_prompt);
2696 /* Temporarily display STRING at the end of the current
2697 minibuffer contents. This is used to display things like
2698 "[No Match]" when the user requests a completion for a prefix
2699 that has no possible completions, and other quick, unobtrusive
2700 messages. */
2702 extern Lisp_Object Vminibuffer_message_timeout;
2704 void
2705 temp_echo_area_glyphs (string)
2706 Lisp_Object string;
2708 int osize = ZV;
2709 int osize_byte = ZV_BYTE;
2710 int opoint = PT;
2711 int opoint_byte = PT_BYTE;
2712 Lisp_Object oinhibit;
2713 oinhibit = Vinhibit_quit;
2715 /* Clear out any old echo-area message to make way for our new thing. */
2716 message (0);
2718 SET_PT_BOTH (osize, osize_byte);
2719 insert_from_string (string, 0, 0, SCHARS (string), SBYTES (string), 0);
2720 SET_PT_BOTH (opoint, opoint_byte);
2721 Vinhibit_quit = Qt;
2723 if (NUMBERP (Vminibuffer_message_timeout))
2724 sit_for (Vminibuffer_message_timeout, 0, 2);
2725 else
2726 sit_for (Qt, 0, 2);
2728 del_range_both (osize, osize_byte, ZV, ZV_BYTE, 1);
2729 SET_PT_BOTH (opoint, opoint_byte);
2730 if (!NILP (Vquit_flag))
2732 Vquit_flag = Qnil;
2733 Vunread_command_events = Fcons (make_number (quit_char), Qnil);
2735 Vinhibit_quit = oinhibit;
2738 DEFUN ("minibuffer-message", Fminibuffer_message, Sminibuffer_message,
2739 1, 1, 0,
2740 doc: /* Temporarily display STRING at the end of the minibuffer.
2741 The text is displayed for a period controlled by `minibuffer-message-timeout',
2742 or until the next input event arrives, whichever comes first. */)
2743 (string)
2744 Lisp_Object string;
2746 CHECK_STRING (string);
2747 temp_echo_area_glyphs (string);
2748 return Qnil;
2751 void
2752 init_minibuf_once ()
2754 Vminibuffer_list = Qnil;
2755 staticpro (&Vminibuffer_list);
2758 void
2759 syms_of_minibuf ()
2761 minibuf_level = 0;
2762 minibuf_prompt = Qnil;
2763 staticpro (&minibuf_prompt);
2765 minibuf_save_list = Qnil;
2766 staticpro (&minibuf_save_list);
2768 Qread_file_name_internal = intern ("read-file-name-internal");
2769 staticpro (&Qread_file_name_internal);
2771 Qminibuffer_default = intern ("minibuffer-default");
2772 staticpro (&Qminibuffer_default);
2773 Fset (Qminibuffer_default, Qnil);
2775 Qminibuffer_completion_table = intern ("minibuffer-completion-table");
2776 staticpro (&Qminibuffer_completion_table);
2778 Qminibuffer_completion_confirm = intern ("minibuffer-completion-confirm");
2779 staticpro (&Qminibuffer_completion_confirm);
2781 Qminibuffer_completion_predicate = intern ("minibuffer-completion-predicate");
2782 staticpro (&Qminibuffer_completion_predicate);
2784 staticpro (&last_exact_completion);
2785 last_exact_completion = Qnil;
2787 staticpro (&last_minibuf_string);
2788 last_minibuf_string = Qnil;
2790 Quser_variable_p = intern ("user-variable-p");
2791 staticpro (&Quser_variable_p);
2793 Qminibuffer_history = intern ("minibuffer-history");
2794 staticpro (&Qminibuffer_history);
2796 Qbuffer_name_history = intern ("buffer-name-history");
2797 staticpro (&Qbuffer_name_history);
2798 Fset (Qbuffer_name_history, Qnil);
2800 Qminibuffer_setup_hook = intern ("minibuffer-setup-hook");
2801 staticpro (&Qminibuffer_setup_hook);
2803 Qminibuffer_exit_hook = intern ("minibuffer-exit-hook");
2804 staticpro (&Qminibuffer_exit_hook);
2806 Qhistory_length = intern ("history-length");
2807 staticpro (&Qhistory_length);
2809 Qcurrent_input_method = intern ("current-input-method");
2810 staticpro (&Qcurrent_input_method);
2812 Qactivate_input_method = intern ("activate-input-method");
2813 staticpro (&Qactivate_input_method);
2815 Qcase_fold_search = intern ("case-fold-search");
2816 staticpro (&Qcase_fold_search);
2818 Qread_expression_history = intern ("read-expression-history");
2819 staticpro (&Qread_expression_history);
2821 DEFVAR_LISP ("read-buffer-function", &Vread_buffer_function,
2822 doc: /* If this is non-nil, `read-buffer' does its work by calling this function. */);
2823 Vread_buffer_function = Qnil;
2825 DEFVAR_LISP ("minibuffer-setup-hook", &Vminibuffer_setup_hook,
2826 doc: /* Normal hook run just after entry to minibuffer. */);
2827 Vminibuffer_setup_hook = Qnil;
2829 DEFVAR_LISP ("minibuffer-exit-hook", &Vminibuffer_exit_hook,
2830 doc: /* Normal hook run just after exit from minibuffer. */);
2831 Vminibuffer_exit_hook = Qnil;
2833 DEFVAR_LISP ("history-length", &Vhistory_length,
2834 doc: /* *Maximum length for history lists before truncation takes place.
2835 A number means that length; t means infinite. Truncation takes place
2836 just after a new element is inserted. Setting the `history-length'
2837 property of a history variable overrides this default. */);
2838 XSETFASTINT (Vhistory_length, 30);
2840 DEFVAR_BOOL ("history-delete-duplicates", &history_delete_duplicates,
2841 doc: /* *Non-nil means to delete duplicates in history.
2842 If set to t when adding a new history element, all previous identical
2843 elements are deleted from the history list. */);
2844 history_delete_duplicates = 0;
2846 DEFVAR_LISP ("history-add-new-input", &Vhistory_add_new_input,
2847 doc: /* *Non-nil means to add new elements in history.
2848 If set to nil, minibuffer reading functions don't add new elements to the
2849 history list, so it is possible to do this afterwards by calling
2850 `add-to-history' explicitly. */);
2851 Vhistory_add_new_input = Qt;
2853 DEFVAR_LISP ("completion-auto-help", &Vcompletion_auto_help,
2854 doc: /* *Non-nil means automatically provide help for invalid completion input.
2855 Under Partial Completion mode, a non-nil, non-t value has a special meaning;
2856 see the doc string of `partial-completion-mode' for more details. */);
2857 Vcompletion_auto_help = Qt;
2859 DEFVAR_BOOL ("completion-ignore-case", &completion_ignore_case,
2860 doc: /* Non-nil means don't consider case significant in completion.
2862 For file-name completion, the variable `read-file-name-completion-ignore-case'
2863 controls the behavior, rather than this variable. */);
2864 completion_ignore_case = 0;
2866 DEFVAR_BOOL ("enable-recursive-minibuffers", &enable_recursive_minibuffers,
2867 doc: /* *Non-nil means to allow minibuffer commands while in the minibuffer.
2868 This variable makes a difference whenever the minibuffer window is active. */);
2869 enable_recursive_minibuffers = 0;
2871 DEFVAR_LISP ("minibuffer-completion-table", &Vminibuffer_completion_table,
2872 doc: /* Alist or obarray used for completion in the minibuffer.
2873 This becomes the ALIST argument to `try-completion' and `all-completions'.
2874 The value can also be a list of strings or a hash table.
2876 The value may alternatively be a function, which is given three arguments:
2877 STRING, the current buffer contents;
2878 PREDICATE, the predicate for filtering possible matches;
2879 CODE, which says what kind of things to do.
2880 CODE can be nil, t or `lambda'.
2881 nil means to return the best completion of STRING, or nil if there is none.
2882 t means to return a list of all possible completions of STRING.
2883 `lambda' means to return t if STRING is a valid completion as it stands. */);
2884 Vminibuffer_completion_table = Qnil;
2886 DEFVAR_LISP ("minibuffer-completion-predicate", &Vminibuffer_completion_predicate,
2887 doc: /* Within call to `completing-read', this holds the PREDICATE argument. */);
2888 Vminibuffer_completion_predicate = Qnil;
2890 DEFVAR_LISP ("minibuffer-completion-confirm", &Vminibuffer_completion_confirm,
2891 doc: /* Non-nil means to demand confirmation of completion before exiting minibuffer. */);
2892 Vminibuffer_completion_confirm = Qnil;
2894 DEFVAR_LISP ("minibuffer-completing-file-name",
2895 &Vminibuffer_completing_file_name,
2896 doc: /* Non-nil means completing file names. */);
2897 Vminibuffer_completing_file_name = Qnil;
2899 DEFVAR_LISP ("minibuffer-help-form", &Vminibuffer_help_form,
2900 doc: /* Value that `help-form' takes on inside the minibuffer. */);
2901 Vminibuffer_help_form = Qnil;
2903 DEFVAR_LISP ("minibuffer-history-variable", &Vminibuffer_history_variable,
2904 doc: /* History list symbol to add minibuffer values to.
2905 Each string of minibuffer input, as it appears on exit from the minibuffer,
2906 is added with
2907 (set minibuffer-history-variable
2908 (cons STRING (symbol-value minibuffer-history-variable))) */);
2909 XSETFASTINT (Vminibuffer_history_variable, 0);
2911 DEFVAR_LISP ("minibuffer-history-position", &Vminibuffer_history_position,
2912 doc: /* Current position of redoing in the history list. */);
2913 Vminibuffer_history_position = Qnil;
2915 DEFVAR_BOOL ("minibuffer-auto-raise", &minibuffer_auto_raise,
2916 doc: /* *Non-nil means entering the minibuffer raises the minibuffer's frame.
2917 Some uses of the echo area also raise that frame (since they use it too). */);
2918 minibuffer_auto_raise = 0;
2920 DEFVAR_LISP ("completion-regexp-list", &Vcompletion_regexp_list,
2921 doc: /* List of regexps that should restrict possible completions.
2922 The basic completion functions only consider a completion acceptable
2923 if it matches all regular expressions in this list, with
2924 `case-fold-search' bound to the value of `completion-ignore-case'.
2925 See Info node `(elisp)Basic Completion', for a description of these
2926 functions. */);
2927 Vcompletion_regexp_list = Qnil;
2929 DEFVAR_BOOL ("minibuffer-allow-text-properties",
2930 &minibuffer_allow_text_properties,
2931 doc: /* Non-nil means `read-from-minibuffer' should not discard text properties.
2932 This also affects `read-string', but it does not affect `read-minibuffer',
2933 `read-no-blanks-input', or any of the functions that do minibuffer input
2934 with completion; they always discard text properties. */);
2935 minibuffer_allow_text_properties = 0;
2937 DEFVAR_LISP ("minibuffer-prompt-properties", &Vminibuffer_prompt_properties,
2938 doc: /* Text properties that are added to minibuffer prompts.
2939 These are in addition to the basic `field' property, and stickiness
2940 properties. */);
2941 /* We use `intern' here instead of Qread_only to avoid
2942 initialization-order problems. */
2943 Vminibuffer_prompt_properties
2944 = Fcons (intern ("read-only"), Fcons (Qt, Qnil));
2946 DEFVAR_LISP ("read-expression-map", &Vread_expression_map,
2947 doc: /* Minibuffer keymap used for reading Lisp expressions. */);
2948 Vread_expression_map = Qnil;
2950 defsubr (&Sset_minibuffer_window);
2951 defsubr (&Sread_from_minibuffer);
2952 defsubr (&Seval_minibuffer);
2953 defsubr (&Sread_minibuffer);
2954 defsubr (&Sread_string);
2955 defsubr (&Sread_command);
2956 defsubr (&Sread_variable);
2957 defsubr (&Sinternal_complete_buffer);
2958 defsubr (&Sread_buffer);
2959 defsubr (&Sread_no_blanks_input);
2960 defsubr (&Sminibuffer_depth);
2961 defsubr (&Sminibuffer_prompt);
2963 defsubr (&Sminibufferp);
2964 defsubr (&Sminibuffer_prompt_end);
2965 defsubr (&Sminibuffer_contents);
2966 defsubr (&Sminibuffer_contents_no_properties);
2967 defsubr (&Sminibuffer_completion_contents);
2968 defsubr (&Sdelete_minibuffer_contents);
2970 defsubr (&Stry_completion);
2971 defsubr (&Sall_completions);
2972 defsubr (&Stest_completion);
2973 defsubr (&Sassoc_string);
2974 defsubr (&Scompleting_read);
2975 defsubr (&Sminibuffer_complete);
2976 defsubr (&Sminibuffer_complete_word);
2977 defsubr (&Sminibuffer_complete_and_exit);
2978 defsubr (&Sdisplay_completion_list);
2979 defsubr (&Sminibuffer_completion_help);
2981 defsubr (&Sself_insert_and_exit);
2982 defsubr (&Sexit_minibuffer);
2984 defsubr (&Sminibuffer_message);
2987 void
2988 keys_of_minibuf ()
2990 initial_define_key (Vminibuffer_local_map, Ctl ('g'),
2991 "abort-recursive-edit");
2992 initial_define_key (Vminibuffer_local_map, Ctl ('m'),
2993 "exit-minibuffer");
2994 initial_define_key (Vminibuffer_local_map, Ctl ('j'),
2995 "exit-minibuffer");
2997 initial_define_key (Vminibuffer_local_ns_map, ' ',
2998 "exit-minibuffer");
2999 initial_define_key (Vminibuffer_local_ns_map, '\t',
3000 "exit-minibuffer");
3001 initial_define_key (Vminibuffer_local_ns_map, '?',
3002 "self-insert-and-exit");
3004 initial_define_key (Vminibuffer_local_completion_map, '\t',
3005 "minibuffer-complete");
3006 initial_define_key (Vminibuffer_local_completion_map, ' ',
3007 "minibuffer-complete-word");
3008 initial_define_key (Vminibuffer_local_completion_map, '?',
3009 "minibuffer-completion-help");
3011 Fdefine_key (Vminibuffer_local_filename_completion_map,
3012 build_string (" "), Qnil);
3014 initial_define_key (Vminibuffer_local_must_match_map, Ctl ('m'),
3015 "minibuffer-complete-and-exit");
3016 initial_define_key (Vminibuffer_local_must_match_map, Ctl ('j'),
3017 "minibuffer-complete-and-exit");
3019 Fdefine_key (Vminibuffer_local_must_match_filename_map,
3020 build_string (" "), Qnil);
3023 /* arch-tag: 8f69b601-fba3-484c-a6dd-ceaee54a7a73
3024 (do not change this comment) */