(profile, make-docfile, hexl): Depend on config.h.
[emacs.git] / src / minibuf.c
blob740f73cbd4e9986ef1a9f826cb7cfc9373b5d462
1 /* Minibuffer input and completion.
2 Copyright (C) 1985, 1986, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000
3 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2, or (at your option)
10 any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs; see the file COPYING. If not, write to
19 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20 Boston, MA 02111-1307, USA. */
23 #include <config.h>
24 #include <stdio.h>
25 #include "lisp.h"
26 #include "commands.h"
27 #include "buffer.h"
28 #include "charset.h"
29 #include "dispextern.h"
30 #include "keyboard.h"
31 #include "frame.h"
32 #include "window.h"
33 #include "syntax.h"
35 #define min(a, b) ((a) < (b) ? (a) : (b))
37 extern int quit_char;
39 /* List of buffers for use as minibuffers.
40 The first element of the list is used for the outermost minibuffer
41 invocation, the next element is used for a recursive minibuffer
42 invocation, etc. The list is extended at the end as deeper
43 minibuffer recursions are encountered. */
45 Lisp_Object Vminibuffer_list;
47 /* Data to remember during recursive minibuffer invocations */
49 Lisp_Object minibuf_save_list;
51 /* Depth in minibuffer invocations. */
53 int minibuf_level;
55 /* Nonzero means display completion help for invalid input. */
57 Lisp_Object Vcompletion_auto_help;
59 /* The maximum length of a minibuffer history. */
61 Lisp_Object Qhistory_length, Vhistory_length;
63 /* Fread_minibuffer leaves the input here as a string. */
65 Lisp_Object last_minibuf_string;
67 /* Nonzero means let functions called when within a minibuffer
68 invoke recursive minibuffers (to read arguments, or whatever) */
70 int enable_recursive_minibuffers;
72 /* Nonzero means don't ignore text properties
73 in Fread_from_minibuffer. */
75 int minibuffer_allow_text_properties;
77 /* help-form is bound to this while in the minibuffer. */
79 Lisp_Object Vminibuffer_help_form;
81 /* Variable which is the history list to add minibuffer values to. */
83 Lisp_Object Vminibuffer_history_variable;
85 /* Current position in the history list (adjusted by M-n and M-p). */
87 Lisp_Object Vminibuffer_history_position;
89 Lisp_Object Qminibuffer_history, Qbuffer_name_history;
91 Lisp_Object Qread_file_name_internal;
93 /* Normal hooks for entry to and exit from minibuffer. */
95 Lisp_Object Qminibuffer_setup_hook, Vminibuffer_setup_hook;
96 Lisp_Object Qminibuffer_exit_hook, Vminibuffer_exit_hook;
98 /* Function to call to read a buffer name. */
99 Lisp_Object Vread_buffer_function;
101 /* Nonzero means completion ignores case. */
103 int completion_ignore_case;
105 /* List of regexps that should restrict possible completions. */
107 Lisp_Object Vcompletion_regexp_list;
109 /* Nonzero means raise the minibuffer frame when the minibuffer
110 is entered. */
112 int minibuffer_auto_raise;
114 /* If last completion attempt reported "Complete but not unique"
115 then this is the string completed then; otherwise this is nil. */
117 static Lisp_Object last_exact_completion;
119 /* Non-nil means it is the window for C-M-v to scroll
120 when the minibuffer is selected. */
122 extern Lisp_Object Vminibuf_scroll_window;
124 extern Lisp_Object Voverriding_local_map;
126 Lisp_Object Quser_variable_p;
128 Lisp_Object Qminibuffer_default;
130 Lisp_Object Qcurrent_input_method, Qactivate_input_method;
132 extern Lisp_Object Qmouse_face;
134 extern Lisp_Object Qfield;
136 /* Put minibuf on currently selected frame's minibuffer.
137 We do this whenever the user starts a new minibuffer
138 or when a minibuffer exits. */
140 void
141 choose_minibuf_frame ()
143 if (FRAMEP (selected_frame)
144 && FRAME_LIVE_P (XFRAME (selected_frame))
145 && !EQ (minibuf_window, XFRAME (selected_frame)->minibuffer_window))
147 struct frame *sf = XFRAME (selected_frame);
148 Lisp_Object buffer;
150 /* I don't think that any frames may validly have a null minibuffer
151 window anymore. */
152 if (NILP (sf->minibuffer_window))
153 abort ();
155 /* Under X, we come here with minibuf_window being the
156 minibuffer window of the unused termcap window created in
157 init_window_once. That window doesn't have a buffer. */
158 buffer = XWINDOW (minibuf_window)->buffer;
159 if (BUFFERP (buffer))
160 Fset_window_buffer (sf->minibuffer_window, buffer);
161 minibuf_window = sf->minibuffer_window;
164 /* Make sure no other frame has a minibuffer as its selected window,
165 because the text would not be displayed in it, and that would be
166 confusing. Only allow the selected frame to do this,
167 and that only if the minibuffer is active. */
169 Lisp_Object tail, frame;
171 FOR_EACH_FRAME (tail, frame)
172 if (MINI_WINDOW_P (XWINDOW (FRAME_SELECTED_WINDOW (XFRAME (frame))))
173 && !(EQ (frame, selected_frame)
174 && minibuf_level > 0))
175 Fset_frame_selected_window (frame, Fframe_first_window (frame));
179 Lisp_Object
180 choose_minibuf_frame_1 (ignore)
181 Lisp_Object ignore;
183 choose_minibuf_frame ();
184 return Qnil;
187 DEFUN ("set-minibuffer-window", Fset_minibuffer_window,
188 Sset_minibuffer_window, 1, 1, 0,
189 "Specify which minibuffer window to use for the minibuffer.\n\
190 This effects where the minibuffer is displayed if you put text in it\n\
191 without invoking the usual minibuffer commands.")
192 (window)
193 Lisp_Object window;
195 CHECK_WINDOW (window, 1);
196 if (! MINI_WINDOW_P (XWINDOW (window)))
197 error ("Window is not a minibuffer window");
199 minibuf_window = window;
201 return window;
205 /* Actual minibuffer invocation. */
207 static Lisp_Object read_minibuf_unwind P_ ((Lisp_Object));
208 static Lisp_Object read_minibuf P_ ((Lisp_Object, Lisp_Object,
209 Lisp_Object, Lisp_Object,
210 int, Lisp_Object,
211 Lisp_Object, Lisp_Object,
212 int, int));
213 static Lisp_Object read_minibuf_noninteractive P_ ((Lisp_Object, Lisp_Object,
214 Lisp_Object, Lisp_Object,
215 int, Lisp_Object,
216 Lisp_Object, Lisp_Object,
217 int, int));
218 static Lisp_Object string_to_object P_ ((Lisp_Object, Lisp_Object));
221 /* Read a Lisp object from VAL and return it. If VAL is an empty
222 string, and DEFALT is a string, read from DEFALT instead of VAL. */
224 static Lisp_Object
225 string_to_object (val, defalt)
226 Lisp_Object val, defalt;
228 struct gcpro gcpro1, gcpro2;
229 Lisp_Object expr_and_pos;
230 int pos;
232 GCPRO2 (val, defalt);
234 if (STRINGP (val) && XSTRING (val)->size == 0
235 && STRINGP (defalt))
236 val = defalt;
238 expr_and_pos = Fread_from_string (val, Qnil, Qnil);
239 pos = XINT (Fcdr (expr_and_pos));
240 if (pos != XSTRING (val)->size)
242 /* Ignore trailing whitespace; any other trailing junk
243 is an error. */
244 int i;
245 pos = string_char_to_byte (val, pos);
246 for (i = pos; i < STRING_BYTES (XSTRING (val)); i++)
248 int c = XSTRING (val)->data[i];
249 if (c != ' ' && c != '\t' && c != '\n')
250 error ("Trailing garbage following expression");
254 val = Fcar (expr_and_pos);
255 RETURN_UNGCPRO (val);
259 /* Like read_minibuf but reading from stdin. This function is called
260 from read_minibuf to do the job if noninteractive. */
262 static Lisp_Object
263 read_minibuf_noninteractive (map, initial, prompt, backup_n, expflag,
264 histvar, histpos, defalt, allow_props,
265 inherit_input_method)
266 Lisp_Object map;
267 Lisp_Object initial;
268 Lisp_Object prompt;
269 Lisp_Object backup_n;
270 int expflag;
271 Lisp_Object histvar;
272 Lisp_Object histpos;
273 Lisp_Object defalt;
274 int allow_props;
275 int inherit_input_method;
277 int size, len;
278 char *line, *s;
279 Lisp_Object val;
281 fprintf (stdout, "%s", XSTRING (prompt)->data);
282 fflush (stdout);
284 size = 100;
285 len = 0;
286 line = (char *) xmalloc (size * sizeof *line);
287 while ((s = fgets (line + len, size - len, stdin)) != NULL
288 && (len = strlen (line),
289 len == size - 1 && line[len - 1] != '\n'))
291 size *= 2;
292 line = (char *) xrealloc (line, size);
295 if (s)
297 len = strlen (line);
299 if (len > 0 && line[len - 1] == '\n')
300 line[--len] = '\0';
302 val = build_string (line);
303 xfree (line);
305 else
307 xfree (line);
308 error ("Error reading from stdin");
311 /* If Lisp form desired instead of string, parse it. */
312 if (expflag)
313 val = string_to_object (val, defalt);
315 return val;
319 /* Read from the minibuffer using keymap MAP, initial contents INITIAL
320 (a string), putting point minus BACKUP_N bytes from the end of INITIAL,
321 prompting with PROMPT (a string), using history list HISTVAR
322 with initial position HISTPOS. (BACKUP_N should be <= 0.)
324 Normally return the result as a string (the text that was read),
325 but if EXPFLAG is nonzero, read it and return the object read.
326 If HISTVAR is given, save the value read on that history only if it doesn't
327 match the front of that history list exactly. The value is pushed onto
328 the list as the string that was read.
330 DEFALT specifies te default value for the sake of history commands.
332 If ALLOW_PROPS is nonzero, we do not throw away text properties.
334 if INHERIT_INPUT_METHOD is nonzeor, the minibuffer inherit the
335 current input method. */
337 static Lisp_Object
338 read_minibuf (map, initial, prompt, backup_n, expflag,
339 histvar, histpos, defalt, allow_props, inherit_input_method)
340 Lisp_Object map;
341 Lisp_Object initial;
342 Lisp_Object prompt;
343 Lisp_Object backup_n;
344 int expflag;
345 Lisp_Object histvar;
346 Lisp_Object histpos;
347 Lisp_Object defalt;
348 int allow_props;
349 int inherit_input_method;
351 Lisp_Object val;
352 int count = specpdl_ptr - specpdl;
353 Lisp_Object mini_frame, ambient_dir, minibuffer, input_method;
354 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5;
355 Lisp_Object enable_multibyte;
356 extern Lisp_Object Qread_only, Qfront_sticky;
357 extern Lisp_Object Qrear_nonsticky;
359 specbind (Qminibuffer_default, defalt);
361 single_kboard_state ();
362 #ifdef HAVE_X_WINDOWS
363 if (display_busy_cursor_p)
364 cancel_busy_cursor ();
365 #endif
367 val = Qnil;
368 ambient_dir = current_buffer->directory;
369 input_method = Qnil;
370 enable_multibyte = Qnil;
372 /* Don't need to protect PROMPT, HISTVAR, and HISTPOS because we
373 store them away before we can GC. Don't need to protect
374 BACKUP_N because we use the value only if it is an integer. */
375 GCPRO5 (map, initial, val, ambient_dir, input_method);
377 if (!STRINGP (prompt))
378 prompt = build_string ("");
380 if (!enable_recursive_minibuffers
381 && minibuf_level > 0)
383 if (EQ (selected_window, minibuf_window))
384 error ("Command attempted to use minibuffer while in minibuffer");
385 else
386 /* If we're in another window, cancel the minibuffer that's active. */
387 Fthrow (Qexit,
388 build_string ("Command attempted to use minibuffer while in minibuffer"));
391 if (noninteractive)
392 return read_minibuf_noninteractive (map, initial, prompt, backup_n,
393 expflag, histvar, histpos, defalt,
394 allow_props, inherit_input_method);
396 /* Choose the minibuffer window and frame, and take action on them. */
398 choose_minibuf_frame ();
400 record_unwind_protect (choose_minibuf_frame_1, Qnil);
402 record_unwind_protect (Fset_window_configuration,
403 Fcurrent_window_configuration (Qnil));
405 /* If the minibuffer window is on a different frame, save that
406 frame's configuration too. */
407 mini_frame = WINDOW_FRAME (XWINDOW (minibuf_window));
408 if (!EQ (mini_frame, selected_frame))
409 record_unwind_protect (Fset_window_configuration,
410 Fcurrent_window_configuration (mini_frame));
412 /* If the minibuffer is on an iconified or invisible frame,
413 make it visible now. */
414 Fmake_frame_visible (mini_frame);
416 if (minibuffer_auto_raise)
417 Fraise_frame (mini_frame);
419 /* We have to do this after saving the window configuration
420 since that is what restores the current buffer. */
422 /* Arrange to restore a number of minibuffer-related variables.
423 We could bind each variable separately, but that would use lots of
424 specpdl slots. */
425 minibuf_save_list
426 = Fcons (Voverriding_local_map,
427 Fcons (minibuf_window, minibuf_save_list));
428 minibuf_save_list
429 = Fcons (minibuf_prompt,
430 Fcons (make_number (minibuf_prompt_width),
431 Fcons (Vhelp_form,
432 Fcons (Vcurrent_prefix_arg,
433 Fcons (Vminibuffer_history_position,
434 Fcons (Vminibuffer_history_variable,
435 minibuf_save_list))))));
437 record_unwind_protect (read_minibuf_unwind, Qnil);
438 minibuf_level++;
440 /* Now that we can restore all those variables, start changing them. */
442 minibuf_prompt_width = 0;
443 minibuf_prompt = Fcopy_sequence (prompt);
444 Vminibuffer_history_position = histpos;
445 Vminibuffer_history_variable = histvar;
446 Vhelp_form = Vminibuffer_help_form;
448 if (inherit_input_method)
450 /* `current-input-method' is buffer local. So, remeber it in
451 INPUT_METHOD before changing the current buffer. */
452 input_method = Fsymbol_value (Qcurrent_input_method);
453 enable_multibyte = current_buffer->enable_multibyte_characters;
456 /* Switch to the minibuffer. */
458 minibuffer = get_minibuffer (minibuf_level);
459 Fset_buffer (minibuffer);
461 /* The current buffer's default directory is usually the right thing
462 for our minibuffer here. However, if you're typing a command at
463 a minibuffer-only frame when minibuf_level is zero, then buf IS
464 the current_buffer, so reset_buffer leaves buf's default
465 directory unchanged. This is a bummer when you've just started
466 up Emacs and buf's default directory is Qnil. Here's a hack; can
467 you think of something better to do? Find another buffer with a
468 better directory, and use that one instead. */
469 if (STRINGP (ambient_dir))
470 current_buffer->directory = ambient_dir;
471 else
473 Lisp_Object buf_list;
475 for (buf_list = Vbuffer_alist;
476 CONSP (buf_list);
477 buf_list = XCDR (buf_list))
479 Lisp_Object other_buf;
481 other_buf = XCDR (XCAR (buf_list));
482 if (STRINGP (XBUFFER (other_buf)->directory))
484 current_buffer->directory = XBUFFER (other_buf)->directory;
485 break;
490 if (!EQ (mini_frame, selected_frame))
491 Fredirect_frame_focus (selected_frame, mini_frame);
493 Vminibuf_scroll_window = selected_window;
494 Fset_window_buffer (minibuf_window, Fcurrent_buffer ());
495 Fselect_window (minibuf_window);
496 XSETFASTINT (XWINDOW (minibuf_window)->hscroll, 0);
498 Fmake_local_variable (Qprint_escape_newlines);
499 print_escape_newlines = 1;
501 /* Erase the buffer. */
503 int count1 = specpdl_ptr - specpdl;
504 specbind (Qinhibit_read_only, Qt);
505 Ferase_buffer ();
506 unbind_to (count1, Qnil);
509 if (!NILP (current_buffer->enable_multibyte_characters)
510 && ! STRING_MULTIBYTE (minibuf_prompt))
511 minibuf_prompt = Fstring_make_multibyte (minibuf_prompt);
513 /* Insert the prompt, record where it ends. */
514 Finsert (1, &minibuf_prompt);
515 if (PT > BEG)
517 Fput_text_property (make_number (BEG), make_number (PT),
518 Qfront_sticky, Qt, Qnil);
519 Fput_text_property (make_number (BEG), make_number (PT),
520 Qrear_nonsticky, Qt, Qnil);
521 Fput_text_property (make_number (BEG), make_number (PT),
522 Qfield, Qt, Qnil);
523 Fput_text_property (make_number (BEG), make_number (PT),
524 Qread_only, Qt, Qnil);
527 minibuf_prompt_width = current_column ();
529 /* If appropriate, copy enable-multibyte-characters into the minibuffer. */
530 if (inherit_input_method)
531 current_buffer->enable_multibyte_characters = enable_multibyte;
533 /* Put in the initial input. */
534 if (!NILP (initial))
536 Finsert (1, &initial);
537 if (INTEGERP (backup_n))
538 Fforward_char (backup_n);
541 clear_message (1, 1);
542 current_buffer->keymap = map;
544 /* Turn on an input method stored in INPUT_METHOD if any. */
545 if (STRINGP (input_method) && !NILP (Ffboundp (Qactivate_input_method)))
546 call1 (Qactivate_input_method, input_method);
548 /* Run our hook, but not if it is empty.
549 (run-hooks would do nothing if it is empty,
550 but it's important to save time here in the usual case). */
551 if (!NILP (Vminibuffer_setup_hook) && !EQ (Vminibuffer_setup_hook, Qunbound)
552 && !NILP (Vrun_hooks))
553 call1 (Vrun_hooks, Qminibuffer_setup_hook);
555 recursive_edit_1 ();
557 /* If cursor is on the minibuffer line,
558 show the user we have exited by putting it in column 0. */
559 if (XWINDOW (minibuf_window)->cursor.vpos >= 0
560 && !noninteractive)
562 XWINDOW (minibuf_window)->cursor.hpos = 0;
563 XWINDOW (minibuf_window)->cursor.x = 0;
564 XWINDOW (minibuf_window)->must_be_updated_p = 1;
565 update_frame (XFRAME (selected_frame), 1, 1);
566 if (rif && rif->flush_display)
567 rif->flush_display (XFRAME (XWINDOW (minibuf_window)->frame));
570 /* Make minibuffer contents into a string. */
571 Fset_buffer (minibuffer);
572 if (allow_props)
573 val = Ffield_string (make_number (ZV));
574 else
575 val = Ffield_string_no_properties (make_number (ZV));
577 /* VAL is the string of minibuffer text. */
579 last_minibuf_string = val;
581 /* Add the value to the appropriate history list unless it is empty. */
582 if (XSTRING (val)->size != 0
583 && SYMBOLP (Vminibuffer_history_variable))
585 /* If the caller wanted to save the value read on a history list,
586 then do so if the value is not already the front of the list. */
587 Lisp_Object histval;
589 /* If variable is unbound, make it nil. */
590 if (EQ (XSYMBOL (Vminibuffer_history_variable)->value, Qunbound))
591 Fset (Vminibuffer_history_variable, Qnil);
593 histval = Fsymbol_value (Vminibuffer_history_variable);
595 /* The value of the history variable must be a cons or nil. Other
596 values are unacceptable. We silently ignore these values. */
597 if (NILP (histval)
598 || (CONSP (histval)
599 && NILP (Fequal (last_minibuf_string, Fcar (histval)))))
601 Lisp_Object length;
603 histval = Fcons (last_minibuf_string, histval);
604 Fset (Vminibuffer_history_variable, histval);
606 /* Truncate if requested. */
607 length = Fget (Vminibuffer_history_variable, Qhistory_length);
608 if (NILP (length)) length = Vhistory_length;
609 if (INTEGERP (length))
611 if (XINT (length) <= 0)
612 Fset (Vminibuffer_history_variable, Qnil);
613 else
615 Lisp_Object temp;
617 temp = Fnthcdr (Fsub1 (length), histval);
618 if (CONSP (temp)) Fsetcdr (temp, Qnil);
624 /* If Lisp form desired instead of string, parse it. */
625 if (expflag)
626 val = string_to_object (val, defalt);
628 /* The appropriate frame will get selected
629 in set-window-configuration. */
630 RETURN_UNGCPRO (unbind_to (count, val));
633 /* Return a buffer to be used as the minibuffer at depth `depth'.
634 depth = 0 is the lowest allowed argument, and that is the value
635 used for nonrecursive minibuffer invocations */
637 Lisp_Object
638 get_minibuffer (depth)
639 int depth;
641 Lisp_Object tail, num, buf;
642 char name[24];
643 extern Lisp_Object nconc2 ();
645 XSETFASTINT (num, depth);
646 tail = Fnthcdr (num, Vminibuffer_list);
647 if (NILP (tail))
649 tail = Fcons (Qnil, Qnil);
650 Vminibuffer_list = nconc2 (Vminibuffer_list, tail);
652 buf = Fcar (tail);
653 if (NILP (buf) || NILP (XBUFFER (buf)->name))
655 sprintf (name, " *Minibuf-%d*", depth);
656 buf = Fget_buffer_create (build_string (name));
658 /* Although the buffer's name starts with a space, undo should be
659 enabled in it. */
660 Fbuffer_enable_undo (buf);
662 XCAR (tail) = buf;
664 else
666 int count = specpdl_ptr - specpdl;
668 reset_buffer (XBUFFER (buf));
669 record_unwind_protect (Fset_buffer, Fcurrent_buffer ());
670 Fset_buffer (buf);
671 Fkill_all_local_variables ();
672 unbind_to (count, Qnil);
675 return buf;
678 /* This function is called on exiting minibuffer, whether normally or
679 not, and it restores the current window, buffer, etc. */
681 static Lisp_Object
682 read_minibuf_unwind (data)
683 Lisp_Object data;
685 Lisp_Object old_deactivate_mark;
686 Lisp_Object window;
688 /* We are exiting the minibuffer one way or the other,
689 so run the hook. */
690 if (!NILP (Vminibuffer_exit_hook) && !EQ (Vminibuffer_exit_hook, Qunbound)
691 && !NILP (Vrun_hooks))
692 safe_run_hooks (Qminibuffer_exit_hook);
694 /* If this was a recursive minibuffer,
695 tie the minibuffer window back to the outer level minibuffer buffer. */
696 minibuf_level--;
698 window = minibuf_window;
699 /* To keep things predictable, in case it matters, let's be in the
700 minibuffer when we reset the relevant variables. */
701 Fset_buffer (XWINDOW (window)->buffer);
703 /* Restore prompt, etc, from outer minibuffer level. */
704 minibuf_prompt = Fcar (minibuf_save_list);
705 minibuf_save_list = Fcdr (minibuf_save_list);
706 minibuf_prompt_width = XFASTINT (Fcar (minibuf_save_list));
707 minibuf_save_list = Fcdr (minibuf_save_list);
708 Vhelp_form = Fcar (minibuf_save_list);
709 minibuf_save_list = Fcdr (minibuf_save_list);
710 Vcurrent_prefix_arg = Fcar (minibuf_save_list);
711 minibuf_save_list = Fcdr (minibuf_save_list);
712 Vminibuffer_history_position = Fcar (minibuf_save_list);
713 minibuf_save_list = Fcdr (minibuf_save_list);
714 Vminibuffer_history_variable = Fcar (minibuf_save_list);
715 minibuf_save_list = Fcdr (minibuf_save_list);
716 Voverriding_local_map = Fcar (minibuf_save_list);
717 minibuf_save_list = Fcdr (minibuf_save_list);
718 #if 0
719 temp = Fcar (minibuf_save_list);
720 if (FRAME_LIVE_P (XFRAME (WINDOW_FRAME (XWINDOW (temp)))))
721 minibuf_window = temp;
722 #endif
723 minibuf_save_list = Fcdr (minibuf_save_list);
725 /* Erase the minibuffer we were using at this level. */
727 int count = specpdl_ptr - specpdl;
728 /* Prevent error in erase-buffer. */
729 specbind (Qinhibit_read_only, Qt);
730 old_deactivate_mark = Vdeactivate_mark;
731 Ferase_buffer ();
732 Vdeactivate_mark = old_deactivate_mark;
733 unbind_to (count, Qnil);
736 /* When we get to the outmost level, make sure we resize the
737 mini-window back to its normal size. */
738 if (minibuf_level == 0)
739 resize_mini_window (XWINDOW (window), 0);
741 /* Make sure minibuffer window is erased, not ignored. */
742 windows_or_buffers_changed++;
743 XSETFASTINT (XWINDOW (window)->last_modified, 0);
744 XSETFASTINT (XWINDOW (window)->last_overlay_modified, 0);
745 return Qnil;
749 /* This comment supplies the doc string for read-from-minibuffer,
750 for make-docfile to see. We cannot put this in the real DEFUN
751 due to limits in the Unix cpp.
753 DEFUN ("read-from-minibuffer", Fread_from_minibuffer, Sread_from_minibuffer, 1, 7, 0,
754 "Read a string from the minibuffer, prompting with string PROMPT.\n\
755 If optional second arg INITIAL-CONTENTS is non-nil, it is a string\n\
756 to be inserted into the minibuffer before reading input.\n\
757 If INITIAL-CONTENTS is (STRING . POSITION), the initial input\n\
758 is STRING, but point is placed at position POSITION in the minibuffer.\n\
759 Third arg KEYMAP is a keymap to use whilst reading;\n\
760 if omitted or nil, the default is `minibuffer-local-map'.\n\
761 If fourth arg READ is non-nil, then interpret the result as a lisp object\n\
762 and return that object:\n\
763 in other words, do `(car (read-from-string INPUT-STRING))'\n\
764 Fifth arg HIST, if non-nil, specifies a history list\n\
765 and optionally the initial position in the list.\n\
766 It can be a symbol, which is the history list variable to use,\n\
767 or it can be a cons cell (HISTVAR . HISTPOS).\n\
768 In that case, HISTVAR is the history list variable to use,\n\
769 and HISTPOS is the initial position (the position in the list\n\
770 which INITIAL-CONTENTS corresponds to).\n\
771 Positions are counted starting from 1 at the beginning of the list.\n\
772 Sixth arg DEFAULT-VALUE is the default value. If non-nil, it is available\n\
773 for history commands; but `read-from-minibuffer' does NOT return DEFAULT-VALUE\n\
774 if the user enters empty input! It returns the empty string.\n\
775 Seventh arg INHERIT-INPUT-METHOD, if non-nil, means the minibuffer inherits\n\
776 the current input method and the setting of enable-multibyte-characters.\n\
777 If the variable `minibuffer-allow-text-properties' is non-nil,\n\
778 then the string which is returned includes whatever text properties\n\
779 were present in the minibuffer. Otherwise the value has no text properties.")
780 (prompt, initial_contents, keymap, read, hist, default_value, inherit_input_method)
783 DEFUN ("read-from-minibuffer", Fread_from_minibuffer, Sread_from_minibuffer, 1, 7, 0,
784 0 /* See immediately above */)
785 (prompt, initial_contents, keymap, read, hist, default_value, inherit_input_method)
786 Lisp_Object prompt, initial_contents, keymap, read, hist, default_value;
787 Lisp_Object inherit_input_method;
789 int pos = 0;
790 Lisp_Object histvar, histpos, position, val;
791 struct gcpro gcpro1;
793 position = Qnil;
795 CHECK_STRING (prompt, 0);
796 if (!NILP (initial_contents))
798 if (CONSP (initial_contents))
800 position = Fcdr (initial_contents);
801 initial_contents = Fcar (initial_contents);
803 CHECK_STRING (initial_contents, 1);
804 if (!NILP (position))
806 CHECK_NUMBER (position, 0);
807 /* Convert to distance from end of input. */
808 if (XINT (position) < 1)
809 /* A number too small means the beginning of the string. */
810 pos = - XSTRING (initial_contents)->size;
811 else
812 pos = XINT (position) - 1 - XSTRING (initial_contents)->size;
816 if (NILP (keymap))
817 keymap = Vminibuffer_local_map;
818 else
819 keymap = get_keymap (keymap);
821 if (SYMBOLP (hist))
823 histvar = hist;
824 histpos = Qnil;
826 else
828 histvar = Fcar_safe (hist);
829 histpos = Fcdr_safe (hist);
831 if (NILP (histvar))
832 histvar = Qminibuffer_history;
833 if (NILP (histpos))
834 XSETFASTINT (histpos, 0);
836 GCPRO1 (default_value);
837 val = read_minibuf (keymap, initial_contents, prompt,
838 make_number (pos), !NILP (read),
839 histvar, histpos, default_value,
840 minibuffer_allow_text_properties,
841 !NILP (inherit_input_method));
842 UNGCPRO;
843 return val;
846 DEFUN ("read-minibuffer", Fread_minibuffer, Sread_minibuffer, 1, 2, 0,
847 "Return a Lisp object read using the minibuffer.\n\
848 Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS\n\
849 is a string to insert in the minibuffer before reading.")
850 (prompt, initial_contents)
851 Lisp_Object prompt, initial_contents;
853 CHECK_STRING (prompt, 0);
854 if (!NILP (initial_contents))
855 CHECK_STRING (initial_contents, 1);
856 return read_minibuf (Vminibuffer_local_map, initial_contents,
857 prompt, Qnil, 1, Qminibuffer_history,
858 make_number (0), Qnil, 0, 0);
861 DEFUN ("eval-minibuffer", Feval_minibuffer, Seval_minibuffer, 1, 2, 0,
862 "Return value of Lisp expression read using the minibuffer.\n\
863 Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS\n\
864 is a string to insert in the minibuffer before reading.")
865 (prompt, initial_contents)
866 Lisp_Object prompt, initial_contents;
868 return Feval (Fread_minibuffer (prompt, initial_contents));
871 /* Functions that use the minibuffer to read various things. */
873 DEFUN ("read-string", Fread_string, Sread_string, 1, 5, 0,
874 "Read a string from the minibuffer, prompting with string PROMPT.\n\
875 If non-nil, second arg INITIAL-INPUT is a string to insert before reading.\n\
876 The third arg HISTORY, if non-nil, specifies a history list\n\
877 and optionally the initial position in the list.\n\
878 See `read-from-minibuffer' for details of HISTORY argument.\n\
879 Fourth arg DEFAULT-VALUE is the default value. If non-nil, it is used\n\
880 for history commands, and as the value to return if the user enters\n\
881 the empty string.\n\
882 Fifth arg INHERIT-INPUT-METHOD, if non-nil, means the minibuffer inherits\n\
883 the current input method and the setting of enable-multibyte-characters.")
884 (prompt, initial_input, history, default_value, inherit_input_method)
885 Lisp_Object prompt, initial_input, history, default_value;
886 Lisp_Object inherit_input_method;
888 Lisp_Object val;
889 val = Fread_from_minibuffer (prompt, initial_input, Qnil,
890 Qnil, history, default_value,
891 inherit_input_method);
892 if (STRINGP (val) && XSTRING (val)->size == 0 && ! NILP (default_value))
893 val = default_value;
894 return val;
897 DEFUN ("read-no-blanks-input", Fread_no_blanks_input, Sread_no_blanks_input, 1, 3, 0,
898 "Read a string from the terminal, not allowing blanks.\n\
899 Prompt with PROMPT, and provide INITIAL as an initial value of the input string.\n\
900 Third arg INHERIT-INPUT-METHOD, if non-nil, means the minibuffer inherits\n\
901 the current input method and the setting of enable-multibyte-characters.")
902 (prompt, initial, inherit_input_method)
903 Lisp_Object prompt, initial, inherit_input_method;
905 CHECK_STRING (prompt, 0);
906 if (! NILP (initial))
907 CHECK_STRING (initial, 1);
909 return read_minibuf (Vminibuffer_local_ns_map, initial, prompt, Qnil,
910 0, Qminibuffer_history, make_number (0), Qnil, 0,
911 !NILP (inherit_input_method));
914 DEFUN ("read-command", Fread_command, Sread_command, 1, 2, 0,
915 "Read the name of a command and return as a symbol.\n\
916 Prompts with PROMPT. By default, return DEFAULT-VALUE.")
917 (prompt, default_value)
918 Lisp_Object prompt, default_value;
920 Lisp_Object name, default_string;
922 if (NILP (default_value))
923 default_string = Qnil;
924 else if (SYMBOLP (default_value))
925 XSETSTRING (default_string, XSYMBOL (default_value)->name);
926 else
927 default_string = default_value;
929 name = Fcompleting_read (prompt, Vobarray, Qcommandp, Qt,
930 Qnil, Qnil, default_string, Qnil);
931 if (NILP (name))
932 return name;
933 return Fintern (name, Qnil);
936 #ifdef NOTDEF
937 DEFUN ("read-function", Fread_function, Sread_function, 1, 1, 0,
938 "One arg PROMPT, a string. Read the name of a function and return as a symbol.\n\
939 Prompts with PROMPT.")
940 (prompt)
941 Lisp_Object prompt;
943 return Fintern (Fcompleting_read (prompt, Vobarray, Qfboundp, Qt, Qnil, Qnil, Qnil, Qnil),
944 Qnil);
946 #endif /* NOTDEF */
948 DEFUN ("read-variable", Fread_variable, Sread_variable, 1, 2, 0,
949 "Read the name of a user variable and return it as a symbol.\n\
950 Prompts with PROMPT. By default, return DEFAULT-VALUE.\n\
951 A user variable is one whose documentation starts with a `*' character.")
952 (prompt, default_value)
953 Lisp_Object prompt, default_value;
955 Lisp_Object name, default_string;
957 if (NILP (default_value))
958 default_string = Qnil;
959 else if (SYMBOLP (default_value))
960 XSETSTRING (default_string, XSYMBOL (default_value)->name);
961 else
962 default_string = default_value;
964 name = Fcompleting_read (prompt, Vobarray,
965 Quser_variable_p, Qt,
966 Qnil, Qnil, default_string, Qnil);
967 if (NILP (name))
968 return name;
969 return Fintern (name, Qnil);
972 DEFUN ("read-buffer", Fread_buffer, Sread_buffer, 1, 3, 0,
973 "One arg PROMPT, a string. Read the name of a buffer and return as a string.\n\
974 Prompts with PROMPT.\n\
975 Optional second arg DEF is value to return if user enters an empty line.\n\
976 If optional third arg REQUIRE-MATCH is non-nil, only existing buffer names are allowed.")
977 (prompt, def, require_match)
978 Lisp_Object prompt, def, require_match;
980 Lisp_Object args[4];
982 if (BUFFERP (def))
983 def = XBUFFER (def)->name;
985 if (NILP (Vread_buffer_function))
987 if (!NILP (def))
989 args[0] = build_string ("%s(default %s) ");
990 args[1] = prompt;
991 args[2] = def;
992 prompt = Fformat (3, args);
995 return Fcompleting_read (prompt, Vbuffer_alist, Qnil,
996 require_match, Qnil, Qbuffer_name_history,
997 def, Qnil);
999 else
1001 args[0] = Vread_buffer_function;
1002 args[1] = prompt;
1003 args[2] = def;
1004 args[3] = require_match;
1005 return Ffuncall(4, args);
1009 static Lisp_Object
1010 minibuf_conform_representation (string, basis)
1011 Lisp_Object string, basis;
1013 if (STRING_MULTIBYTE (string) == STRING_MULTIBYTE (basis))
1014 return string;
1016 if (STRING_MULTIBYTE (string))
1017 return Fstring_make_unibyte (string);
1018 else
1019 return Fstring_make_multibyte (string);
1022 DEFUN ("try-completion", Ftry_completion, Stry_completion, 2, 3, 0,
1023 "Return common substring of all completions of STRING in ALIST.\n\
1024 Each car of each element of ALIST is tested to see if it begins with STRING.\n\
1025 All that match are compared together; the longest initial sequence\n\
1026 common to all matches is returned as a string.\n\
1027 If there is no match at all, nil is returned.\n\
1028 For a unique match which is exact, t is returned.\n\
1030 ALIST can be an obarray instead of an alist.\n\
1031 Then the print names of all symbols in the obarray are the possible matches.\n\
1033 ALIST can also be a function to do the completion itself.\n\
1034 It receives three arguments: the values STRING, PREDICATE and nil.\n\
1035 Whatever it returns becomes the value of `try-completion'.\n\
1037 If optional third argument PREDICATE is non-nil,\n\
1038 it is used to test each possible match.\n\
1039 The match is a candidate only if PREDICATE returns non-nil.\n\
1040 The argument given to PREDICATE is the alist element\n\
1041 or the symbol from the obarray.\n\
1042 Additionally to this predicate, `completion-regexp-list'\n\
1043 is used to further constrain the set of candidates.")
1044 (string, alist, predicate)
1045 Lisp_Object string, alist, predicate;
1047 Lisp_Object bestmatch, tail, elt, eltstring;
1048 /* Size in bytes of BESTMATCH. */
1049 int bestmatchsize;
1050 /* These are in bytes, too. */
1051 int compare, matchsize;
1052 int list = CONSP (alist) || NILP (alist);
1053 int index, obsize;
1054 int matchcount = 0;
1055 Lisp_Object bucket, zero, end, tem;
1056 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
1058 CHECK_STRING (string, 0);
1059 if (!list && !VECTORP (alist))
1060 return call3 (alist, string, predicate, Qnil);
1062 bestmatch = Qnil;
1064 /* If ALIST is not a list, set TAIL just for gc pro. */
1065 tail = alist;
1066 if (! list)
1068 index = 0;
1069 obsize = XVECTOR (alist)->size;
1070 bucket = XVECTOR (alist)->contents[index];
1073 while (1)
1075 /* Get the next element of the alist or obarray. */
1076 /* Exit the loop if the elements are all used up. */
1077 /* elt gets the alist element or symbol.
1078 eltstring gets the name to check as a completion. */
1080 if (list)
1082 if (NILP (tail))
1083 break;
1084 elt = Fcar (tail);
1085 eltstring = Fcar (elt);
1086 tail = Fcdr (tail);
1088 else
1090 if (XFASTINT (bucket) != 0)
1092 elt = bucket;
1093 eltstring = Fsymbol_name (elt);
1094 if (XSYMBOL (bucket)->next)
1095 XSETSYMBOL (bucket, XSYMBOL (bucket)->next);
1096 else
1097 XSETFASTINT (bucket, 0);
1099 else if (++index >= obsize)
1100 break;
1101 else
1103 bucket = XVECTOR (alist)->contents[index];
1104 continue;
1108 /* Is this element a possible completion? */
1110 if (STRINGP (eltstring)
1111 && XSTRING (string)->size <= XSTRING (eltstring)->size
1112 && (tem = Fcompare_strings (eltstring, make_number (0),
1113 make_number (XSTRING (string)->size),
1114 string, make_number (0), Qnil,
1115 completion_ignore_case ?Qt : Qnil),
1116 EQ (Qt, tem)))
1118 /* Yes. */
1119 Lisp_Object regexps;
1120 Lisp_Object zero;
1121 XSETFASTINT (zero, 0);
1123 /* Ignore this element if it fails to match all the regexps. */
1124 for (regexps = Vcompletion_regexp_list; CONSP (regexps);
1125 regexps = XCDR (regexps))
1127 tem = Fstring_match (XCAR (regexps), eltstring, zero);
1128 if (NILP (tem))
1129 break;
1131 if (CONSP (regexps))
1132 continue;
1134 /* Ignore this element if there is a predicate
1135 and the predicate doesn't like it. */
1137 if (!NILP (predicate))
1139 if (EQ (predicate, Qcommandp))
1140 tem = Fcommandp (elt);
1141 else
1143 GCPRO4 (tail, string, eltstring, bestmatch);
1144 tem = call1 (predicate, elt);
1145 UNGCPRO;
1147 if (NILP (tem)) continue;
1150 /* Update computation of how much all possible completions match */
1152 matchcount++;
1153 if (NILP (bestmatch))
1155 bestmatch = eltstring;
1156 bestmatchsize = XSTRING (eltstring)->size;
1158 else
1160 compare = min (bestmatchsize, XSTRING (eltstring)->size);
1161 tem = Fcompare_strings (bestmatch, make_number (0),
1162 make_number (compare),
1163 eltstring, make_number (0),
1164 make_number (compare),
1165 completion_ignore_case ? Qt : Qnil);
1166 if (EQ (tem, Qt))
1167 matchsize = compare;
1168 else if (XINT (tem) < 0)
1169 matchsize = - XINT (tem) - 1;
1170 else
1171 matchsize = XINT (tem) - 1;
1173 if (matchsize < 0)
1174 matchsize = compare;
1175 if (completion_ignore_case)
1177 /* If this is an exact match except for case,
1178 use it as the best match rather than one that is not an
1179 exact match. This way, we get the case pattern
1180 of the actual match. */
1181 if ((matchsize == XSTRING (eltstring)->size
1182 && matchsize < XSTRING (bestmatch)->size)
1184 /* If there is more than one exact match ignoring case,
1185 and one of them is exact including case,
1186 prefer that one. */
1187 /* If there is no exact match ignoring case,
1188 prefer a match that does not change the case
1189 of the input. */
1190 ((matchsize == XSTRING (eltstring)->size)
1192 (matchsize == XSTRING (bestmatch)->size)
1193 && (tem = Fcompare_strings (eltstring, make_number (0),
1194 make_number (XSTRING (string)->size),
1195 string, make_number (0),
1196 Qnil,
1197 Qnil),
1198 EQ (Qt, tem))
1199 && (tem = Fcompare_strings (bestmatch, make_number (0),
1200 make_number (XSTRING (string)->size),
1201 string, make_number (0),
1202 Qnil,
1203 Qnil),
1204 ! EQ (Qt, tem))))
1205 bestmatch = eltstring;
1207 bestmatchsize = matchsize;
1212 if (NILP (bestmatch))
1213 return Qnil; /* No completions found */
1214 /* If we are ignoring case, and there is no exact match,
1215 and no additional text was supplied,
1216 don't change the case of what the user typed. */
1217 if (completion_ignore_case && bestmatchsize == XSTRING (string)->size
1218 && XSTRING (bestmatch)->size > bestmatchsize)
1219 return minibuf_conform_representation (string, bestmatch);
1221 /* Return t if the supplied string is an exact match (counting case);
1222 it does not require any change to be made. */
1223 if (matchcount == 1 && bestmatchsize == XSTRING (string)->size
1224 && (tem = Fcompare_strings (bestmatch, make_number (0),
1225 make_number (bestmatchsize),
1226 string, make_number (0),
1227 make_number (bestmatchsize),
1228 Qnil),
1229 EQ (Qt, tem)))
1230 return Qt;
1232 XSETFASTINT (zero, 0); /* Else extract the part in which */
1233 XSETFASTINT (end, bestmatchsize); /* all completions agree */
1234 return Fsubstring (bestmatch, zero, end);
1237 /* Compare exactly LEN chars of strings at S1 and S2,
1238 ignoring case if appropriate.
1239 Return -1 if strings match,
1240 else number of chars that match at the beginning. */
1243 scmp (s1, s2, len)
1244 register unsigned char *s1, *s2;
1245 int len;
1247 register int l = len;
1249 if (completion_ignore_case)
1251 while (l && DOWNCASE (*s1++) == DOWNCASE (*s2++))
1252 l--;
1254 else
1256 while (l && *s1++ == *s2++)
1257 l--;
1259 if (l == 0)
1260 return -1;
1261 else
1263 int match = len - l;
1265 /* Now *--S1 is the unmatching byte. If it is in the middle of
1266 multi-byte form, we must say that the multi-byte character
1267 there doesn't match. */
1268 while (match && *--s1 >= 0xA0) match--;
1269 return match;
1273 DEFUN ("all-completions", Fall_completions, Sall_completions, 2, 4, 0,
1274 "Search for partial matches to STRING in ALIST.\n\
1275 Each car of each element of ALIST is tested to see if it begins with STRING.\n\
1276 The value is a list of all the strings from ALIST that match.\n\
1278 ALIST can be an obarray instead of an alist.\n\
1279 Then the print names of all symbols in the obarray are the possible matches.\n\
1281 ALIST can also be a function to do the completion itself.\n\
1282 It receives three arguments: the values STRING, PREDICATE and t.\n\
1283 Whatever it returns becomes the value of `all-completions'.\n\
1285 If optional third argument PREDICATE is non-nil,\n\
1286 it is used to test each possible match.\n\
1287 The match is a candidate only if PREDICATE returns non-nil.\n\
1288 The argument given to PREDICATE is the alist element\n\
1289 or the symbol from the obarray.\n\
1290 Additionally to this predicate, `completion-regexp-list'\n\
1291 is used to further constrain the set of candidates.\n\
1293 If the optional fourth argument HIDE-SPACES is non-nil,\n\
1294 strings in ALIST that start with a space\n\
1295 are ignored unless STRING itself starts with a space.")
1296 (string, alist, predicate, hide_spaces)
1297 Lisp_Object string, alist, predicate, hide_spaces;
1299 Lisp_Object tail, elt, eltstring;
1300 Lisp_Object allmatches;
1301 int list = CONSP (alist) || NILP (alist);
1302 int index, obsize;
1303 Lisp_Object bucket, tem;
1304 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
1306 CHECK_STRING (string, 0);
1307 if (!list && !VECTORP (alist))
1309 return call3 (alist, string, predicate, Qt);
1311 allmatches = Qnil;
1313 /* If ALIST is not a list, set TAIL just for gc pro. */
1314 tail = alist;
1315 if (! list)
1317 index = 0;
1318 obsize = XVECTOR (alist)->size;
1319 bucket = XVECTOR (alist)->contents[index];
1322 while (1)
1324 /* Get the next element of the alist or obarray. */
1325 /* Exit the loop if the elements are all used up. */
1326 /* elt gets the alist element or symbol.
1327 eltstring gets the name to check as a completion. */
1329 if (list)
1331 if (NILP (tail))
1332 break;
1333 elt = Fcar (tail);
1334 eltstring = Fcar (elt);
1335 tail = Fcdr (tail);
1337 else
1339 if (XFASTINT (bucket) != 0)
1341 elt = bucket;
1342 eltstring = Fsymbol_name (elt);
1343 if (XSYMBOL (bucket)->next)
1344 XSETSYMBOL (bucket, XSYMBOL (bucket)->next);
1345 else
1346 XSETFASTINT (bucket, 0);
1348 else if (++index >= obsize)
1349 break;
1350 else
1352 bucket = XVECTOR (alist)->contents[index];
1353 continue;
1357 /* Is this element a possible completion? */
1359 if (STRINGP (eltstring)
1360 && XSTRING (string)->size <= XSTRING (eltstring)->size
1361 /* If HIDE_SPACES, reject alternatives that start with space
1362 unless the input starts with space. */
1363 && ((STRING_BYTES (XSTRING (string)) > 0
1364 && XSTRING (string)->data[0] == ' ')
1365 || XSTRING (eltstring)->data[0] != ' '
1366 || NILP (hide_spaces))
1367 && (tem = Fcompare_strings (eltstring, make_number (0),
1368 make_number (XSTRING (string)->size),
1369 string, make_number (0),
1370 make_number (XSTRING (string)->size),
1371 completion_ignore_case ? Qt : Qnil),
1372 EQ (Qt, tem)))
1374 /* Yes. */
1375 Lisp_Object regexps;
1376 Lisp_Object zero;
1377 XSETFASTINT (zero, 0);
1379 /* Ignore this element if it fails to match all the regexps. */
1380 for (regexps = Vcompletion_regexp_list; CONSP (regexps);
1381 regexps = XCDR (regexps))
1383 tem = Fstring_match (XCAR (regexps), eltstring, zero);
1384 if (NILP (tem))
1385 break;
1387 if (CONSP (regexps))
1388 continue;
1390 /* Ignore this element if there is a predicate
1391 and the predicate doesn't like it. */
1393 if (!NILP (predicate))
1395 if (EQ (predicate, Qcommandp))
1396 tem = Fcommandp (elt);
1397 else
1399 GCPRO4 (tail, eltstring, allmatches, string);
1400 tem = call1 (predicate, elt);
1401 UNGCPRO;
1403 if (NILP (tem)) continue;
1405 /* Ok => put it on the list. */
1406 allmatches = Fcons (eltstring, allmatches);
1410 return Fnreverse (allmatches);
1413 Lisp_Object Vminibuffer_completion_table, Qminibuffer_completion_table;
1414 Lisp_Object Vminibuffer_completion_predicate, Qminibuffer_completion_predicate;
1415 Lisp_Object Vminibuffer_completion_confirm, Qminibuffer_completion_confirm;
1416 Lisp_Object Vminibuffer_completing_file_name;
1418 /* This comment supplies the doc string for completing-read,
1419 for make-docfile to see. We cannot put this in the real DEFUN
1420 due to limits in the Unix cpp.
1422 DEFUN ("completing-read", Fcompleting_read, Scompleting_read, 2, 8, 0,
1423 "Read a string in the minibuffer, with completion.\n\
1424 PROMPT is a string to prompt with; normally it ends in a colon and a space.\n\
1425 TABLE is an alist whose elements' cars are strings, or an obarray.\n\
1426 TABLE can also be a function to do the completion itself.\n\
1427 PREDICATE limits completion to a subset of TABLE.\n\
1428 See `try-completion' and `all-completions' for more details\n\
1429 on completion, TABLE, and PREDICATE.\n\
1431 If REQUIRE-MATCH is non-nil, the user is not allowed to exit unless\n\
1432 the input is (or completes to) an element of TABLE or is null.\n\
1433 If it is also not t, Return does not exit if it does non-null completion.\n\
1434 If the input is null, `completing-read' returns an empty string,\n\
1435 regardless of the value of REQUIRE-MATCH.\n\
1437 If INITIAL-INPUT is non-nil, insert it in the minibuffer initially.\n\
1438 If it is (STRING . POSITION), the initial input\n\
1439 is STRING, but point is placed POSITION characters into the string.\n\
1440 HIST, if non-nil, specifies a history list\n\
1441 and optionally the initial position in the list.\n\
1442 It can be a symbol, which is the history list variable to use,\n\
1443 or it can be a cons cell (HISTVAR . HISTPOS).\n\
1444 In that case, HISTVAR is the history list variable to use,\n\
1445 and HISTPOS is the initial position (the position in the list\n\
1446 which INITIAL-INPUT corresponds to).\n\
1447 Positions are counted starting from 1 at the beginning of the list.\n\
1448 DEF, if non-nil, is the default value.\n\
1450 If INHERIT-INPUT-METHOD is non-nil, the minibuffer inherits\n\
1451 the current input method and the setting of enable-multibyte-characters.\n\
1453 Completion ignores case if the ambient value of\n\
1454 `completion-ignore-case' is non-nil."
1456 DEFUN ("completing-read", Fcompleting_read, Scompleting_read, 2, 8, 0,
1457 0 /* See immediately above */)
1458 (prompt, table, predicate, require_match, initial_input, hist, def, inherit_input_method)
1459 Lisp_Object prompt, table, predicate, require_match, initial_input;
1460 Lisp_Object hist, def, inherit_input_method;
1462 Lisp_Object val, histvar, histpos, position;
1463 Lisp_Object init;
1464 int pos = 0;
1465 int count = specpdl_ptr - specpdl;
1466 struct gcpro gcpro1;
1468 init = initial_input;
1469 GCPRO1 (def);
1471 specbind (Qminibuffer_completion_table, table);
1472 specbind (Qminibuffer_completion_predicate, predicate);
1473 specbind (Qminibuffer_completion_confirm,
1474 EQ (require_match, Qt) ? Qnil : Qt);
1475 last_exact_completion = Qnil;
1477 position = Qnil;
1478 if (!NILP (init))
1480 if (CONSP (init))
1482 position = Fcdr (init);
1483 init = Fcar (init);
1485 CHECK_STRING (init, 0);
1486 if (!NILP (position))
1488 CHECK_NUMBER (position, 0);
1489 /* Convert to distance from end of input. */
1490 pos = XINT (position) - XSTRING (init)->size;
1494 if (SYMBOLP (hist))
1496 histvar = hist;
1497 histpos = Qnil;
1499 else
1501 histvar = Fcar_safe (hist);
1502 histpos = Fcdr_safe (hist);
1504 if (NILP (histvar))
1505 histvar = Qminibuffer_history;
1506 if (NILP (histpos))
1507 XSETFASTINT (histpos, 0);
1509 val = read_minibuf (NILP (require_match)
1510 ? Vminibuffer_local_completion_map
1511 : Vminibuffer_local_must_match_map,
1512 init, prompt, make_number (pos), 0,
1513 histvar, histpos, def, 0,
1514 !NILP (inherit_input_method));
1516 if (STRINGP (val) && XSTRING (val)->size == 0 && ! NILP (def))
1517 val = def;
1519 RETURN_UNGCPRO (unbind_to (count, val));
1522 Lisp_Object Fminibuffer_completion_help ();
1523 Lisp_Object assoc_for_completion ();
1525 /* Test whether TXT is an exact completion. */
1526 Lisp_Object
1527 test_completion (txt)
1528 Lisp_Object txt;
1530 Lisp_Object tem;
1532 if (CONSP (Vminibuffer_completion_table)
1533 || NILP (Vminibuffer_completion_table))
1534 return assoc_for_completion (txt, Vminibuffer_completion_table);
1535 else if (VECTORP (Vminibuffer_completion_table))
1537 /* Bypass intern-soft as that loses for nil */
1538 tem = oblookup (Vminibuffer_completion_table,
1539 XSTRING (txt)->data,
1540 XSTRING (txt)->size,
1541 STRING_BYTES (XSTRING (txt)));
1542 if (!SYMBOLP (tem))
1544 if (STRING_MULTIBYTE (txt))
1545 txt = Fstring_make_unibyte (txt);
1546 else
1547 txt = Fstring_make_multibyte (txt);
1549 tem = oblookup (Vminibuffer_completion_table,
1550 XSTRING (txt)->data,
1551 XSTRING (txt)->size,
1552 STRING_BYTES (XSTRING (txt)));
1553 if (!SYMBOLP (tem))
1554 return Qnil;
1556 if (!NILP (Vminibuffer_completion_predicate))
1557 return call1 (Vminibuffer_completion_predicate, tem);
1558 else
1559 return Qt;
1561 else
1562 return call3 (Vminibuffer_completion_table, txt,
1563 Vminibuffer_completion_predicate, Qlambda);
1566 /* returns:
1567 * 0 no possible completion
1568 * 1 was already an exact and unique completion
1569 * 3 was already an exact completion
1570 * 4 completed to an exact completion
1571 * 5 some completion happened
1572 * 6 no completion happened
1575 do_completion ()
1577 Lisp_Object completion, string, tem;
1578 int completedp;
1579 Lisp_Object last;
1580 struct gcpro gcpro1, gcpro2;
1582 completion = Ftry_completion (Ffield_string (make_number (ZV)),
1583 Vminibuffer_completion_table,
1584 Vminibuffer_completion_predicate);
1585 last = last_exact_completion;
1586 last_exact_completion = Qnil;
1588 GCPRO2 (completion, last);
1590 if (NILP (completion))
1592 bitch_at_user ();
1593 temp_echo_area_glyphs (" [No match]");
1594 UNGCPRO;
1595 return 0;
1598 if (EQ (completion, Qt)) /* exact and unique match */
1600 UNGCPRO;
1601 return 1;
1604 string = Ffield_string (make_number (ZV));
1606 /* COMPLETEDP should be true if some completion was done, which
1607 doesn't include simply changing the case of the entered string.
1608 However, for appearance, the string is rewritten if the case
1609 changes. */
1610 tem = Fcompare_strings (completion, Qnil, Qnil, string, Qnil, Qnil, Qt);
1611 completedp = !EQ (tem, Qt);
1613 tem = Fcompare_strings (completion, Qnil, Qnil, string, Qnil, Qnil, Qnil);
1614 if (!EQ (tem, Qt))
1615 /* Rewrite the user's input. */
1617 Fdelete_field (make_number (ZV)); /* Some completion happened */
1618 Finsert (1, &completion);
1620 if (! completedp)
1621 /* The case of the string changed, but that's all. We're not
1622 sure whether this is a unique completion or not, so try again
1623 using the real case (this shouldn't recurse again, because
1624 the next time try-completion will return either `t' or the
1625 exact string). */
1627 UNGCPRO;
1628 return do_completion ();
1632 /* It did find a match. Do we match some possibility exactly now? */
1633 tem = test_completion (Ffield_string (make_number (ZV)));
1634 if (NILP (tem))
1636 /* not an exact match */
1637 UNGCPRO;
1638 if (completedp)
1639 return 5;
1640 else if (!NILP (Vcompletion_auto_help))
1641 Fminibuffer_completion_help ();
1642 else
1643 temp_echo_area_glyphs (" [Next char not unique]");
1644 return 6;
1646 else if (completedp)
1648 UNGCPRO;
1649 return 4;
1651 /* If the last exact completion and this one were the same,
1652 it means we've already given a "Complete but not unique"
1653 message and the user's hit TAB again, so now we give him help. */
1654 last_exact_completion = completion;
1655 if (!NILP (last))
1657 tem = Ffield_string (make_number (ZV));
1658 if (!NILP (Fequal (tem, last)))
1659 Fminibuffer_completion_help ();
1661 UNGCPRO;
1662 return 3;
1665 /* Like assoc but assumes KEY is a string, and ignores case if appropriate. */
1667 Lisp_Object
1668 assoc_for_completion (key, list)
1669 register Lisp_Object key;
1670 Lisp_Object list;
1672 register Lisp_Object tail;
1674 for (tail = list; !NILP (tail); tail = Fcdr (tail))
1676 register Lisp_Object elt, tem, thiscar;
1677 elt = Fcar (tail);
1678 if (!CONSP (elt)) continue;
1679 thiscar = Fcar (elt);
1680 if (!STRINGP (thiscar))
1681 continue;
1682 tem = Fcompare_strings (thiscar, make_number (0), Qnil,
1683 key, make_number (0), Qnil,
1684 completion_ignore_case ? Qt : Qnil);
1685 if (EQ (tem, Qt))
1686 return elt;
1687 QUIT;
1689 return Qnil;
1692 DEFUN ("minibuffer-complete", Fminibuffer_complete, Sminibuffer_complete, 0, 0, "",
1693 "Complete the minibuffer contents as far as possible.\n\
1694 Return nil if there is no valid completion, else t.\n\
1695 If no characters can be completed, display a list of possible completions.\n\
1696 If you repeat this command after it displayed such a list,\n\
1697 scroll the window of possible completions.")
1700 register int i;
1701 Lisp_Object window, tem;
1703 /* If the previous command was not this,
1704 mark the completion buffer obsolete. */
1705 if (! EQ (current_kboard->Vlast_command, Vthis_command))
1706 Vminibuf_scroll_window = Qnil;
1708 window = Vminibuf_scroll_window;
1709 /* If there's a fresh completion window with a live buffer,
1710 and this command is repeated, scroll that window. */
1711 if (! NILP (window) && ! NILP (XWINDOW (window)->buffer)
1712 && !NILP (XBUFFER (XWINDOW (window)->buffer)->name))
1714 struct buffer *obuf = current_buffer;
1716 Fset_buffer (XWINDOW (window)->buffer);
1717 tem = Fpos_visible_in_window_p (make_number (ZV), window);
1718 if (! NILP (tem))
1719 /* If end is in view, scroll up to the beginning. */
1720 Fset_window_start (window, make_number (BEGV), Qnil);
1721 else
1722 /* Else scroll down one screen. */
1723 Fscroll_other_window (Qnil);
1725 set_buffer_internal (obuf);
1726 return Qnil;
1729 i = do_completion ();
1730 switch (i)
1732 case 0:
1733 return Qnil;
1735 case 1:
1736 if (PT != ZV)
1737 Fgoto_char (make_number (ZV));
1738 temp_echo_area_glyphs (" [Sole completion]");
1739 break;
1741 case 3:
1742 if (PT != ZV)
1743 Fgoto_char (make_number (ZV));
1744 temp_echo_area_glyphs (" [Complete, but not unique]");
1745 break;
1748 return Qt;
1751 /* Subroutines of Fminibuffer_complete_and_exit. */
1753 /* This one is called by internal_condition_case to do the real work. */
1755 Lisp_Object
1756 complete_and_exit_1 ()
1758 return make_number (do_completion ());
1761 /* This one is called by internal_condition_case if an error happens.
1762 Pretend the current value is an exact match. */
1764 Lisp_Object
1765 complete_and_exit_2 (ignore)
1766 Lisp_Object ignore;
1768 return make_number (1);
1771 DEFUN ("minibuffer-complete-and-exit", Fminibuffer_complete_and_exit,
1772 Sminibuffer_complete_and_exit, 0, 0, "",
1773 "If the minibuffer contents is a valid completion then exit.\n\
1774 Otherwise try to complete it. If completion leads to a valid completion,\n\
1775 a repetition of this command will exit.")
1778 register int i;
1779 Lisp_Object val;
1781 /* Allow user to specify null string */
1782 if (XINT (Ffield_beginning (make_number (ZV), Qnil)) == ZV)
1783 goto exit;
1785 if (!NILP (test_completion (Ffield_string (make_number (ZV)))))
1786 goto exit;
1788 /* Call do_completion, but ignore errors. */
1789 val = internal_condition_case (complete_and_exit_1, Qerror,
1790 complete_and_exit_2);
1792 i = XFASTINT (val);
1793 switch (i)
1795 case 1:
1796 case 3:
1797 goto exit;
1799 case 4:
1800 if (!NILP (Vminibuffer_completion_confirm))
1802 temp_echo_area_glyphs (" [Confirm]");
1803 return Qnil;
1805 else
1806 goto exit;
1808 default:
1809 return Qnil;
1811 exit:
1812 Fthrow (Qexit, Qnil);
1813 /* NOTREACHED */
1816 DEFUN ("minibuffer-complete-word", Fminibuffer_complete_word, Sminibuffer_complete_word,
1817 0, 0, "",
1818 "Complete the minibuffer contents at most a single word.\n\
1819 After one word is completed as much as possible, a space or hyphen\n\
1820 is added, provided that matches some possible completion.\n\
1821 Return nil if there is no valid completion, else t.")
1824 Lisp_Object completion, tem, tem1;
1825 register int i, i_byte;
1826 register unsigned char *completion_string;
1827 struct gcpro gcpro1, gcpro2;
1828 int prompt_end_charpos;
1830 /* We keep calling Fbuffer_string rather than arrange for GC to
1831 hold onto a pointer to one of the strings thus made. */
1833 completion = Ftry_completion (Ffield_string (make_number (ZV)),
1834 Vminibuffer_completion_table,
1835 Vminibuffer_completion_predicate);
1836 if (NILP (completion))
1838 bitch_at_user ();
1839 temp_echo_area_glyphs (" [No match]");
1840 return Qnil;
1842 if (EQ (completion, Qt))
1843 return Qnil;
1845 #if 0 /* How the below code used to look, for reference. */
1846 tem = Ffield_string (make_number (ZV));
1847 b = XSTRING (tem)->data;
1848 i = ZV - 1 - XSTRING (completion)->size;
1849 p = XSTRING (completion)->data;
1850 if (i > 0 ||
1851 0 <= scmp (b, p, ZV - 1))
1853 i = 1;
1854 /* Set buffer to longest match of buffer tail and completion head. */
1855 while (0 <= scmp (b + i, p, ZV - 1 - i))
1856 i++;
1857 del_range (1, i + 1);
1858 SET_PT (ZV);
1860 #else /* Rewritten code */
1862 int buffer_nchars, completion_nchars;
1864 CHECK_STRING (completion, 0);
1865 tem = Ffield_string (make_number (ZV));
1866 GCPRO2 (completion, tem);
1867 /* If reading a file name,
1868 expand any $ENVVAR refs in the buffer and in TEM. */
1869 if (! NILP (Vminibuffer_completing_file_name))
1871 Lisp_Object substituted;
1872 substituted = Fsubstitute_in_file_name (tem);
1873 if (! EQ (substituted, tem))
1875 tem = substituted;
1876 Fdelete_field (make_number (ZV));
1877 insert_from_string (tem, 0, 0, XSTRING (tem)->size,
1878 STRING_BYTES (XSTRING (tem)), 0);
1881 buffer_nchars = XSTRING (tem)->size; /* ie ZV - BEGV */
1882 completion_nchars = XSTRING (completion)->size;
1883 i = buffer_nchars - completion_nchars;
1884 if (i > 0
1886 (tem1 = Fcompare_strings (tem, make_number (0),
1887 make_number (buffer_nchars),
1888 completion, make_number (0),
1889 make_number (buffer_nchars),
1890 completion_ignore_case ? Qt : Qnil),
1891 ! EQ (tem1, Qt)))
1893 int start_pos;
1895 /* Set buffer to longest match of buffer tail and completion head. */
1896 if (i <= 0) i = 1;
1897 start_pos= i;
1898 buffer_nchars -= i;
1899 while (i > 0)
1901 tem1 = Fcompare_strings (tem, make_number (start_pos), Qnil,
1902 completion, make_number (0),
1903 make_number (buffer_nchars),
1904 completion_ignore_case ? Qt : Qnil);
1905 start_pos++;
1906 if (EQ (tem1, Qt))
1907 break;
1908 i++;
1909 buffer_nchars--;
1911 del_range (1, i + 1);
1912 SET_PT_BOTH (ZV, ZV_BYTE);
1914 UNGCPRO;
1916 #endif /* Rewritten code */
1918 prompt_end_charpos = XINT (Ffield_beginning (make_number (ZV), Qnil));
1921 int prompt_end_bytepos;
1922 prompt_end_bytepos = CHAR_TO_BYTE (prompt_end_charpos);
1923 i = ZV - prompt_end_charpos;
1924 i_byte = ZV_BYTE - prompt_end_bytepos;
1927 /* If completion finds next char not unique,
1928 consider adding a space or a hyphen. */
1929 if (i == XSTRING (completion)->size)
1931 GCPRO1 (completion);
1932 tem = Ftry_completion (concat2 (Ffield_string (make_number (ZV)), build_string (" ")),
1933 Vminibuffer_completion_table,
1934 Vminibuffer_completion_predicate);
1935 UNGCPRO;
1937 if (STRINGP (tem))
1938 completion = tem;
1939 else
1941 GCPRO1 (completion);
1942 tem =
1943 Ftry_completion (concat2 (Ffield_string (make_number (ZV)), build_string ("-")),
1944 Vminibuffer_completion_table,
1945 Vminibuffer_completion_predicate);
1946 UNGCPRO;
1948 if (STRINGP (tem))
1949 completion = tem;
1953 /* Now find first word-break in the stuff found by completion.
1954 i gets index in string of where to stop completing. */
1956 int len, c;
1957 int bytes = STRING_BYTES (XSTRING (completion));
1958 completion_string = XSTRING (completion)->data;
1959 for (; i_byte < STRING_BYTES (XSTRING (completion)); i_byte += len, i++)
1961 c = STRING_CHAR_AND_LENGTH (completion_string + i_byte,
1962 bytes - i_byte,
1963 len);
1964 if (SYNTAX (c) != Sword)
1966 i_byte += len;
1967 i++;
1968 break;
1973 /* If got no characters, print help for user. */
1975 if (i == ZV - prompt_end_charpos)
1977 if (!NILP (Vcompletion_auto_help))
1978 Fminibuffer_completion_help ();
1979 return Qnil;
1982 /* Otherwise insert in minibuffer the chars we got */
1984 Fdelete_field (make_number (ZV));
1985 insert_from_string (completion, 0, 0, i, i_byte, 1);
1986 return Qt;
1989 DEFUN ("display-completion-list", Fdisplay_completion_list, Sdisplay_completion_list,
1990 1, 1, 0,
1991 "Display the list of completions, COMPLETIONS, using `standard-output'.\n\
1992 Each element may be just a symbol or string\n\
1993 or may be a list of two strings to be printed as if concatenated.\n\
1994 `standard-output' must be a buffer.\n\
1995 The actual completion alternatives, as inserted, are given `mouse-face'\n\
1996 properties of `highlight'.\n\
1997 At the end, this runs the normal hook `completion-setup-hook'.\n\
1998 It can find the completion buffer in `standard-output'.")
1999 (completions)
2000 Lisp_Object completions;
2002 Lisp_Object tail, elt;
2003 register int i;
2004 int column = 0;
2005 struct gcpro gcpro1, gcpro2;
2006 struct buffer *old = current_buffer;
2007 int first = 1;
2009 /* Note that (when it matters) every variable
2010 points to a non-string that is pointed to by COMPLETIONS,
2011 except for ELT. ELT can be pointing to a string
2012 when terpri or Findent_to calls a change hook. */
2013 elt = Qnil;
2014 GCPRO2 (completions, elt);
2016 if (BUFFERP (Vstandard_output))
2017 set_buffer_internal (XBUFFER (Vstandard_output));
2019 if (NILP (completions))
2020 write_string ("There are no possible completions of what you have typed.",
2021 -1);
2022 else
2024 write_string ("Possible completions are:", -1);
2025 for (tail = completions, i = 0; !NILP (tail); tail = Fcdr (tail), i++)
2027 Lisp_Object tem, string;
2028 int length;
2029 Lisp_Object startpos, endpos;
2031 elt = Fcar (tail);
2032 /* Compute the length of this element. */
2033 if (CONSP (elt))
2035 tem = XCAR (elt);
2036 CHECK_STRING (tem, 0);
2037 length = XSTRING (tem)->size;
2039 tem = Fcar (XCDR (elt));
2040 CHECK_STRING (tem, 0);
2041 length += XSTRING (tem)->size;
2043 else
2045 CHECK_STRING (elt, 0);
2046 length = XSTRING (elt)->size;
2049 /* This does a bad job for narrower than usual windows.
2050 Sadly, the window it will appear in is not known
2051 until after the text has been made. */
2053 if (BUFFERP (Vstandard_output))
2054 XSETINT (startpos, BUF_PT (XBUFFER (Vstandard_output)));
2056 /* If the previous completion was very wide,
2057 or we have two on this line already,
2058 don't put another on the same line. */
2059 if (column > 33 || first
2060 /* If this is really wide, don't put it second on a line. */
2061 || (column > 0 && length > 45))
2063 Fterpri (Qnil);
2064 column = 0;
2066 /* Otherwise advance to column 35. */
2067 else
2069 if (BUFFERP (Vstandard_output))
2071 tem = Findent_to (make_number (35), make_number (2));
2073 column = XINT (tem);
2075 else
2079 write_string (" ", -1);
2080 column++;
2082 while (column < 35);
2086 if (BUFFERP (Vstandard_output))
2088 XSETINT (endpos, BUF_PT (XBUFFER (Vstandard_output)));
2089 Fset_text_properties (startpos, endpos,
2090 Qnil, Vstandard_output);
2093 /* Output this element.
2094 If necessary, convert it to unibyte or to multibyte first. */
2095 if (CONSP (elt))
2096 string = Fcar (elt);
2097 else
2098 string = elt;
2099 if (NILP (current_buffer->enable_multibyte_characters)
2100 && STRING_MULTIBYTE (string))
2101 string = Fstring_make_unibyte (string);
2102 else if (!NILP (current_buffer->enable_multibyte_characters)
2103 && !STRING_MULTIBYTE (string))
2104 string = Fstring_make_multibyte (string);
2106 if (BUFFERP (Vstandard_output))
2108 XSETINT (startpos, BUF_PT (XBUFFER (Vstandard_output)));
2110 Fprinc (string, Qnil);
2112 XSETINT (endpos, BUF_PT (XBUFFER (Vstandard_output)));
2114 Fput_text_property (startpos, endpos,
2115 Qmouse_face, intern ("highlight"),
2116 Vstandard_output);
2118 else
2120 Fprinc (string, Qnil);
2123 /* Output the annotation for this element. */
2124 if (CONSP (elt))
2126 if (BUFFERP (Vstandard_output))
2128 XSETINT (startpos, BUF_PT (XBUFFER (Vstandard_output)));
2130 Fprinc (Fcar (Fcdr (elt)), Qnil);
2132 XSETINT (endpos, BUF_PT (XBUFFER (Vstandard_output)));
2134 Fset_text_properties (startpos, endpos, Qnil,
2135 Vstandard_output);
2137 else
2139 Fprinc (Fcar (Fcdr (elt)), Qnil);
2144 /* Update COLUMN for what we have output. */
2145 column += length;
2147 /* If output is to a buffer, recompute COLUMN in a way
2148 that takes account of character widths. */
2149 if (BUFFERP (Vstandard_output))
2151 tem = Fcurrent_column ();
2152 column = XINT (tem);
2155 first = 0;
2159 UNGCPRO;
2161 if (BUFFERP (Vstandard_output))
2162 set_buffer_internal (old);
2164 if (!NILP (Vrun_hooks))
2165 call1 (Vrun_hooks, intern ("completion-setup-hook"));
2167 return Qnil;
2170 DEFUN ("minibuffer-completion-help", Fminibuffer_completion_help, Sminibuffer_completion_help,
2171 0, 0, "",
2172 "Display a list of possible completions of the current minibuffer contents.")
2175 Lisp_Object completions;
2177 message ("Making completion list...");
2178 completions = Fall_completions (Ffield_string (make_number (ZV)),
2179 Vminibuffer_completion_table,
2180 Vminibuffer_completion_predicate,
2181 Qt);
2182 clear_message (1, 0);
2184 if (NILP (completions))
2186 bitch_at_user ();
2187 temp_echo_area_glyphs (" [No completions]");
2189 else
2190 internal_with_output_to_temp_buffer ("*Completions*",
2191 Fdisplay_completion_list,
2192 Fsort (completions, Qstring_lessp));
2193 return Qnil;
2196 DEFUN ("self-insert-and-exit", Fself_insert_and_exit, Sself_insert_and_exit, 0, 0, "",
2197 "Terminate minibuffer input.")
2200 if (INTEGERP (last_command_char))
2201 internal_self_insert (XINT (last_command_char), 0);
2202 else
2203 bitch_at_user ();
2205 Fthrow (Qexit, Qnil);
2208 DEFUN ("exit-minibuffer", Fexit_minibuffer, Sexit_minibuffer, 0, 0, "",
2209 "Terminate this minibuffer argument.")
2212 Fthrow (Qexit, Qnil);
2215 DEFUN ("minibuffer-depth", Fminibuffer_depth, Sminibuffer_depth, 0, 0, 0,
2216 "Return current depth of activations of minibuffer, a nonnegative integer.")
2219 return make_number (minibuf_level);
2222 DEFUN ("minibuffer-prompt", Fminibuffer_prompt, Sminibuffer_prompt, 0, 0, 0,
2223 "Return the prompt string of the currently-active minibuffer.\n\
2224 If no minibuffer is active, return nil.")
2227 return Fcopy_sequence (minibuf_prompt);
2231 /* Temporarily display the string M at the end of the current
2232 minibuffer contents. This is used to display things like
2233 "[No Match]" when the user requests a completion for a prefix
2234 that has no possible completions, and other quick, unobtrusive
2235 messages. */
2237 void
2238 temp_echo_area_glyphs (m)
2239 char *m;
2241 int osize = ZV;
2242 int osize_byte = ZV_BYTE;
2243 int opoint = PT;
2244 int opoint_byte = PT_BYTE;
2245 Lisp_Object oinhibit;
2246 oinhibit = Vinhibit_quit;
2248 /* Clear out any old echo-area message to make way for our new thing. */
2249 message (0);
2251 SET_PT_BOTH (osize, osize_byte);
2252 insert_string (m);
2253 SET_PT_BOTH (opoint, opoint_byte);
2254 Vinhibit_quit = Qt;
2255 Fsit_for (make_number (2), Qnil, Qnil);
2256 del_range_both (osize, osize_byte, ZV, ZV_BYTE, 1);
2257 SET_PT_BOTH (opoint, opoint_byte);
2258 if (!NILP (Vquit_flag))
2260 Vquit_flag = Qnil;
2261 Vunread_command_events = Fcons (make_number (quit_char), Qnil);
2263 Vinhibit_quit = oinhibit;
2266 DEFUN ("minibuffer-message", Fminibuffer_message, Sminibuffer_message,
2267 1, 1, 0,
2268 "Temporarily display STRING at the end of the minibuffer.\n\
2269 The text is displayed for two seconds,\n\
2270 or until the next input event arrives, whichever comes first.")
2271 (string)
2272 Lisp_Object string;
2274 temp_echo_area_glyphs (XSTRING (string)->data);
2275 return Qnil;
2278 void
2279 init_minibuf_once ()
2281 Vminibuffer_list = Qnil;
2282 staticpro (&Vminibuffer_list);
2285 void
2286 syms_of_minibuf ()
2288 minibuf_level = 0;
2289 minibuf_prompt = Qnil;
2290 staticpro (&minibuf_prompt);
2292 minibuf_save_list = Qnil;
2293 staticpro (&minibuf_save_list);
2295 Qread_file_name_internal = intern ("read-file-name-internal");
2296 staticpro (&Qread_file_name_internal);
2298 Qminibuffer_default = intern ("minibuffer-default");
2299 staticpro (&Qminibuffer_default);
2300 Fset (Qminibuffer_default, Qnil);
2302 Qminibuffer_completion_table = intern ("minibuffer-completion-table");
2303 staticpro (&Qminibuffer_completion_table);
2305 Qminibuffer_completion_confirm = intern ("minibuffer-completion-confirm");
2306 staticpro (&Qminibuffer_completion_confirm);
2308 Qminibuffer_completion_predicate = intern ("minibuffer-completion-predicate");
2309 staticpro (&Qminibuffer_completion_predicate);
2311 staticpro (&last_exact_completion);
2312 last_exact_completion = Qnil;
2314 staticpro (&last_minibuf_string);
2315 last_minibuf_string = Qnil;
2317 Quser_variable_p = intern ("user-variable-p");
2318 staticpro (&Quser_variable_p);
2320 Qminibuffer_history = intern ("minibuffer-history");
2321 staticpro (&Qminibuffer_history);
2323 Qbuffer_name_history = intern ("buffer-name-history");
2324 staticpro (&Qbuffer_name_history);
2325 Fset (Qbuffer_name_history, Qnil);
2327 Qminibuffer_setup_hook = intern ("minibuffer-setup-hook");
2328 staticpro (&Qminibuffer_setup_hook);
2330 Qminibuffer_exit_hook = intern ("minibuffer-exit-hook");
2331 staticpro (&Qminibuffer_exit_hook);
2333 Qhistory_length = intern ("history-length");
2334 staticpro (&Qhistory_length);
2336 Qcurrent_input_method = intern ("current-input-method");
2337 staticpro (&Qcurrent_input_method);
2339 Qactivate_input_method = intern ("activate-input-method");
2340 staticpro (&Qactivate_input_method);
2342 DEFVAR_LISP ("read-buffer-function", &Vread_buffer_function,
2343 "If this is non-nil, `read-buffer' does its work by calling this function.");
2344 Vread_buffer_function = Qnil;
2346 DEFVAR_LISP ("minibuffer-setup-hook", &Vminibuffer_setup_hook,
2347 "Normal hook run just after entry to minibuffer.");
2348 Vminibuffer_setup_hook = Qnil;
2350 DEFVAR_LISP ("minibuffer-exit-hook", &Vminibuffer_exit_hook,
2351 "Normal hook run just after exit from minibuffer.");
2352 Vminibuffer_exit_hook = Qnil;
2354 DEFVAR_LISP ("history-length", &Vhistory_length,
2355 "*Maximum length for history lists before truncation takes place.\n\
2356 A number means that length; t means infinite. Truncation takes place\n\
2357 just after a new element is inserted. Setting the history-length\n\
2358 property of a history variable overrides this default.");
2359 XSETFASTINT (Vhistory_length, 30);
2361 DEFVAR_LISP ("completion-auto-help", &Vcompletion_auto_help,
2362 "*Non-nil means automatically provide help for invalid completion input.");
2363 Vcompletion_auto_help = Qt;
2365 DEFVAR_BOOL ("completion-ignore-case", &completion_ignore_case,
2366 "Non-nil means don't consider case significant in completion.");
2367 completion_ignore_case = 0;
2369 DEFVAR_BOOL ("enable-recursive-minibuffers", &enable_recursive_minibuffers,
2370 "*Non-nil means to allow minibuffer commands while in the minibuffer.\n\
2371 This variable makes a difference whenever the minibuffer window is active.");
2372 enable_recursive_minibuffers = 0;
2374 DEFVAR_LISP ("minibuffer-completion-table", &Vminibuffer_completion_table,
2375 "Alist or obarray used for completion in the minibuffer.\n\
2376 This becomes the ALIST argument to `try-completion' and `all-completion'.\n\
2378 The value may alternatively be a function, which is given three arguments:\n\
2379 STRING, the current buffer contents;\n\
2380 PREDICATE, the predicate for filtering possible matches;\n\
2381 CODE, which says what kind of things to do.\n\
2382 CODE can be nil, t or `lambda'.\n\
2383 nil means to return the best completion of STRING, or nil if there is none.\n\
2384 t means to return a list of all possible completions of STRING.\n\
2385 `lambda' means to return t if STRING is a valid completion as it stands.");
2386 Vminibuffer_completion_table = Qnil;
2388 DEFVAR_LISP ("minibuffer-completion-predicate", &Vminibuffer_completion_predicate,
2389 "Within call to `completing-read', this holds the PREDICATE argument.");
2390 Vminibuffer_completion_predicate = Qnil;
2392 DEFVAR_LISP ("minibuffer-completion-confirm", &Vminibuffer_completion_confirm,
2393 "Non-nil => demand confirmation of completion before exiting minibuffer.");
2394 Vminibuffer_completion_confirm = Qnil;
2396 DEFVAR_LISP ("minibuffer-completing-file-name",
2397 &Vminibuffer_completing_file_name,
2398 "Non-nil means completing file names.");
2399 Vminibuffer_completing_file_name = Qnil;
2401 DEFVAR_LISP ("minibuffer-help-form", &Vminibuffer_help_form,
2402 "Value that `help-form' takes on inside the minibuffer.");
2403 Vminibuffer_help_form = Qnil;
2405 DEFVAR_LISP ("minibuffer-history-variable", &Vminibuffer_history_variable,
2406 "History list symbol to add minibuffer values to.\n\
2407 Each string of minibuffer input, as it appears on exit from the minibuffer,\n\
2408 is added with\n\
2409 (set minibuffer-history-variable\n\
2410 (cons STRING (symbol-value minibuffer-history-variable)))");
2411 XSETFASTINT (Vminibuffer_history_variable, 0);
2413 DEFVAR_LISP ("minibuffer-history-position", &Vminibuffer_history_position,
2414 "Current position of redoing in the history list.");
2415 Vminibuffer_history_position = Qnil;
2417 DEFVAR_BOOL ("minibuffer-auto-raise", &minibuffer_auto_raise,
2418 "*Non-nil means entering the minibuffer raises the minibuffer's frame.\n\
2419 Some uses of the echo area also raise that frame (since they use it too).");
2420 minibuffer_auto_raise = 0;
2422 DEFVAR_LISP ("completion-regexp-list", &Vcompletion_regexp_list,
2423 "List of regexps that should restrict possible completions.");
2424 Vcompletion_regexp_list = Qnil;
2426 DEFVAR_BOOL ("minibuffer-allow-text-properties",
2427 &minibuffer_allow_text_properties,
2428 "Non-nil means `read-from-minibuffer' should not discard text properties.\n\
2429 This also affects `read-string', but it does not affect `read-minibuffer',\n\
2430 `read-no-blanks-input', or any of the functions that do minibuffer input\n\
2431 with completion; they always discard text properties.");
2432 minibuffer_allow_text_properties = 0;
2434 defsubr (&Sset_minibuffer_window);
2435 defsubr (&Sread_from_minibuffer);
2436 defsubr (&Seval_minibuffer);
2437 defsubr (&Sread_minibuffer);
2438 defsubr (&Sread_string);
2439 defsubr (&Sread_command);
2440 defsubr (&Sread_variable);
2441 defsubr (&Sread_buffer);
2442 defsubr (&Sread_no_blanks_input);
2443 defsubr (&Sminibuffer_depth);
2444 defsubr (&Sminibuffer_prompt);
2446 defsubr (&Stry_completion);
2447 defsubr (&Sall_completions);
2448 defsubr (&Scompleting_read);
2449 defsubr (&Sminibuffer_complete);
2450 defsubr (&Sminibuffer_complete_word);
2451 defsubr (&Sminibuffer_complete_and_exit);
2452 defsubr (&Sdisplay_completion_list);
2453 defsubr (&Sminibuffer_completion_help);
2455 defsubr (&Sself_insert_and_exit);
2456 defsubr (&Sexit_minibuffer);
2458 defsubr (&Sminibuffer_message);
2461 void
2462 keys_of_minibuf ()
2464 initial_define_key (Vminibuffer_local_map, Ctl ('g'),
2465 "abort-recursive-edit");
2466 initial_define_key (Vminibuffer_local_map, Ctl ('m'),
2467 "exit-minibuffer");
2468 initial_define_key (Vminibuffer_local_map, Ctl ('j'),
2469 "exit-minibuffer");
2471 initial_define_key (Vminibuffer_local_ns_map, Ctl ('g'),
2472 "abort-recursive-edit");
2473 initial_define_key (Vminibuffer_local_ns_map, Ctl ('m'),
2474 "exit-minibuffer");
2475 initial_define_key (Vminibuffer_local_ns_map, Ctl ('j'),
2476 "exit-minibuffer");
2478 initial_define_key (Vminibuffer_local_ns_map, ' ',
2479 "exit-minibuffer");
2480 initial_define_key (Vminibuffer_local_ns_map, '\t',
2481 "exit-minibuffer");
2482 initial_define_key (Vminibuffer_local_ns_map, '?',
2483 "self-insert-and-exit");
2485 initial_define_key (Vminibuffer_local_completion_map, Ctl ('g'),
2486 "abort-recursive-edit");
2487 initial_define_key (Vminibuffer_local_completion_map, Ctl ('m'),
2488 "exit-minibuffer");
2489 initial_define_key (Vminibuffer_local_completion_map, Ctl ('j'),
2490 "exit-minibuffer");
2492 initial_define_key (Vminibuffer_local_completion_map, '\t',
2493 "minibuffer-complete");
2494 initial_define_key (Vminibuffer_local_completion_map, ' ',
2495 "minibuffer-complete-word");
2496 initial_define_key (Vminibuffer_local_completion_map, '?',
2497 "minibuffer-completion-help");
2499 initial_define_key (Vminibuffer_local_must_match_map, Ctl ('g'),
2500 "abort-recursive-edit");
2501 initial_define_key (Vminibuffer_local_must_match_map, Ctl ('m'),
2502 "minibuffer-complete-and-exit");
2503 initial_define_key (Vminibuffer_local_must_match_map, Ctl ('j'),
2504 "minibuffer-complete-and-exit");
2505 initial_define_key (Vminibuffer_local_must_match_map, '\t',
2506 "minibuffer-complete");
2507 initial_define_key (Vminibuffer_local_must_match_map, ' ',
2508 "minibuffer-complete-word");
2509 initial_define_key (Vminibuffer_local_must_match_map, '?',
2510 "minibuffer-completion-help");