(mail-font-lock-keywords): Match multiline In-Reply-To and X-*.
[emacs.git] / src / minibuf.c
bloba8b97cf4695cc43b8865d9ca2eabe6a0fce55440
1 /* Minibuffer input and completion.
2 Copyright (C) 1985, 1986, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
3 2000, 2001 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>
26 #include "lisp.h"
27 #include "commands.h"
28 #include "buffer.h"
29 #include "charset.h"
30 #include "dispextern.h"
31 #include "keyboard.h"
32 #include "frame.h"
33 #include "window.h"
34 #include "syntax.h"
35 #include "intervals.h"
36 #include "keymap.h"
38 extern int quit_char;
40 /* List of buffers for use as minibuffers.
41 The first element of the list is used for the outermost minibuffer
42 invocation, the next element is used for a recursive minibuffer
43 invocation, etc. The list is extended at the end as deeper
44 minibuffer recursions are encountered. */
46 Lisp_Object Vminibuffer_list;
48 /* Data to remember during recursive minibuffer invocations */
50 Lisp_Object minibuf_save_list;
52 /* Depth in minibuffer invocations. */
54 int minibuf_level;
56 /* Nonzero means display completion help for invalid input. */
58 Lisp_Object Vcompletion_auto_help;
60 /* The maximum length of a minibuffer history. */
62 Lisp_Object Qhistory_length, Vhistory_length;
64 /* Fread_minibuffer leaves the input here as a string. */
66 Lisp_Object last_minibuf_string;
68 /* Nonzero means let functions called when within a minibuffer
69 invoke recursive minibuffers (to read arguments, or whatever) */
71 int enable_recursive_minibuffers;
73 /* Nonzero means don't ignore text properties
74 in Fread_from_minibuffer. */
76 int minibuffer_allow_text_properties;
78 /* help-form is bound to this while in the minibuffer. */
80 Lisp_Object Vminibuffer_help_form;
82 /* Variable which is the history list to add minibuffer values to. */
84 Lisp_Object Vminibuffer_history_variable;
86 /* Current position in the history list (adjusted by M-n and M-p). */
88 Lisp_Object Vminibuffer_history_position;
90 /* Text properties that are added to minibuffer prompts.
91 These are in addition to the basic `field' property, and stickiness
92 properties. */
94 Lisp_Object Vminibuffer_prompt_properties;
96 Lisp_Object Qminibuffer_history, Qbuffer_name_history;
98 Lisp_Object Qread_file_name_internal;
100 /* Normal hooks for entry to and exit from minibuffer. */
102 Lisp_Object Qminibuffer_setup_hook, Vminibuffer_setup_hook;
103 Lisp_Object Qminibuffer_exit_hook, Vminibuffer_exit_hook;
105 /* Function to call to read a buffer name. */
106 Lisp_Object Vread_buffer_function;
108 /* Nonzero means completion ignores case. */
110 int completion_ignore_case;
112 /* List of regexps that should restrict possible completions. */
114 Lisp_Object Vcompletion_regexp_list;
116 /* Nonzero means raise the minibuffer frame when the minibuffer
117 is entered. */
119 int minibuffer_auto_raise;
121 /* If last completion attempt reported "Complete but not unique"
122 then this is the string completed then; otherwise this is nil. */
124 static Lisp_Object last_exact_completion;
126 extern Lisp_Object Voverriding_local_map;
128 Lisp_Object Quser_variable_p;
130 Lisp_Object Qminibuffer_default;
132 Lisp_Object Qcurrent_input_method, Qactivate_input_method;
134 extern Lisp_Object Qmouse_face;
136 extern Lisp_Object Qfield;
138 /* Put minibuf on currently selected frame's minibuffer.
139 We do this whenever the user starts a new minibuffer
140 or when a minibuffer exits. */
142 void
143 choose_minibuf_frame ()
145 if (FRAMEP (selected_frame)
146 && FRAME_LIVE_P (XFRAME (selected_frame))
147 && !EQ (minibuf_window, XFRAME (selected_frame)->minibuffer_window))
149 struct frame *sf = XFRAME (selected_frame);
150 Lisp_Object buffer;
152 /* I don't think that any frames may validly have a null minibuffer
153 window anymore. */
154 if (NILP (sf->minibuffer_window))
155 abort ();
157 /* Under X, we come here with minibuf_window being the
158 minibuffer window of the unused termcap window created in
159 init_window_once. That window doesn't have a buffer. */
160 buffer = XWINDOW (minibuf_window)->buffer;
161 if (BUFFERP (buffer))
162 Fset_window_buffer (sf->minibuffer_window, buffer);
163 minibuf_window = sf->minibuffer_window;
166 /* Make sure no other frame has a minibuffer as its selected window,
167 because the text would not be displayed in it, and that would be
168 confusing. Only allow the selected frame to do this,
169 and that only if the minibuffer is active. */
171 Lisp_Object tail, frame;
173 FOR_EACH_FRAME (tail, frame)
174 if (MINI_WINDOW_P (XWINDOW (FRAME_SELECTED_WINDOW (XFRAME (frame))))
175 && !(EQ (frame, selected_frame)
176 && minibuf_level > 0))
177 Fset_frame_selected_window (frame, Fframe_first_window (frame));
181 Lisp_Object
182 choose_minibuf_frame_1 (ignore)
183 Lisp_Object ignore;
185 choose_minibuf_frame ();
186 return Qnil;
189 DEFUN ("set-minibuffer-window", Fset_minibuffer_window,
190 Sset_minibuffer_window, 1, 1, 0,
191 doc: /* Specify which minibuffer window to use for the minibuffer.
192 This effects where the minibuffer is displayed if you put text in it
193 without invoking the usual minibuffer commands. */)
194 (window)
195 Lisp_Object window;
197 CHECK_WINDOW (window);
198 if (! MINI_WINDOW_P (XWINDOW (window)))
199 error ("Window is not a minibuffer window");
201 minibuf_window = window;
203 return window;
207 /* Actual minibuffer invocation. */
209 static Lisp_Object read_minibuf_unwind P_ ((Lisp_Object));
210 static Lisp_Object read_minibuf P_ ((Lisp_Object, Lisp_Object,
211 Lisp_Object, Lisp_Object,
212 int, Lisp_Object,
213 Lisp_Object, Lisp_Object,
214 int, int));
215 static Lisp_Object read_minibuf_noninteractive P_ ((Lisp_Object, Lisp_Object,
216 Lisp_Object, Lisp_Object,
217 int, Lisp_Object,
218 Lisp_Object, Lisp_Object,
219 int, int));
220 static Lisp_Object string_to_object P_ ((Lisp_Object, Lisp_Object));
223 /* Read a Lisp object from VAL and return it. If VAL is an empty
224 string, and DEFALT is a string, read from DEFALT instead of VAL. */
226 static Lisp_Object
227 string_to_object (val, defalt)
228 Lisp_Object val, defalt;
230 struct gcpro gcpro1, gcpro2;
231 Lisp_Object expr_and_pos;
232 int pos;
234 GCPRO2 (val, defalt);
236 if (STRINGP (val) && SCHARS (val) == 0
237 && STRINGP (defalt))
238 val = defalt;
240 expr_and_pos = Fread_from_string (val, Qnil, Qnil);
241 pos = XINT (Fcdr (expr_and_pos));
242 if (pos != SCHARS (val))
244 /* Ignore trailing whitespace; any other trailing junk
245 is an error. */
246 int i;
247 pos = string_char_to_byte (val, pos);
248 for (i = pos; i < SBYTES (val); i++)
250 int c = SREF (val, i);
251 if (c != ' ' && c != '\t' && c != '\n')
252 error ("Trailing garbage following expression");
256 val = Fcar (expr_and_pos);
257 RETURN_UNGCPRO (val);
261 /* Like read_minibuf but reading from stdin. This function is called
262 from read_minibuf to do the job if noninteractive. */
264 static Lisp_Object
265 read_minibuf_noninteractive (map, initial, prompt, backup_n, expflag,
266 histvar, histpos, defalt, allow_props,
267 inherit_input_method)
268 Lisp_Object map;
269 Lisp_Object initial;
270 Lisp_Object prompt;
271 Lisp_Object backup_n;
272 int expflag;
273 Lisp_Object histvar;
274 Lisp_Object histpos;
275 Lisp_Object defalt;
276 int allow_props;
277 int inherit_input_method;
279 int size, len;
280 char *line, *s;
281 Lisp_Object val;
283 fprintf (stdout, "%s", SDATA (prompt));
284 fflush (stdout);
286 val = Qnil;
287 size = 100;
288 len = 0;
289 line = (char *) xmalloc (size * sizeof *line);
290 while ((s = fgets (line + len, size - len, stdin)) != NULL
291 && (len = strlen (line),
292 len == size - 1 && line[len - 1] != '\n'))
294 size *= 2;
295 line = (char *) xrealloc (line, size);
298 if (s)
300 len = strlen (line);
302 if (len > 0 && line[len - 1] == '\n')
303 line[--len] = '\0';
305 val = build_string (line);
306 xfree (line);
308 else
310 xfree (line);
311 error ("Error reading from stdin");
314 /* If Lisp form desired instead of string, parse it. */
315 if (expflag)
316 val = string_to_object (val, defalt);
318 return val;
321 DEFUN ("minibufferp", Fminibufferp,
322 Sminibufferp, 0, 1, 0,
323 doc: /* Return t if BUFFER is a minibuffer.
324 No argument or nil as argument means use current buffer as BUFFER.*/)
325 (buffer)
326 Lisp_Object buffer;
328 Lisp_Object tem;
330 if (NILP (buffer))
331 buffer = Fcurrent_buffer ();
332 else if (STRINGP (buffer))
333 buffer = Fget_buffer (buffer);
334 else
335 CHECK_BUFFER (buffer);
337 tem = Fmemq (buffer, Vminibuffer_list);
338 return ! NILP (tem) ? Qt : Qnil;
341 DEFUN ("minibuffer-prompt-end", Fminibuffer_prompt_end,
342 Sminibuffer_prompt_end, 0, 0, 0,
343 doc: /* Return the buffer position of the end of the minibuffer prompt.
344 Return (point-min) if current buffer is not a mini-buffer. */)
347 /* This function is written to be most efficient when there's a prompt. */
348 Lisp_Object beg, end, tem;
349 beg = make_number (BEGV);
351 tem = Fmemq (Fcurrent_buffer (), Vminibuffer_list);
352 if (NILP (tem))
353 return beg;
355 end = Ffield_end (beg, Qnil, Qnil);
357 if (XINT (end) == ZV && NILP (Fget_char_property (beg, Qfield, Qnil)))
358 return beg;
359 else
360 return end;
363 DEFUN ("minibuffer-contents", Fminibuffer_contents,
364 Sminibuffer_contents, 0, 0, 0,
365 doc: /* Return the user input in a minibuffer as a string.
366 The current buffer must be a minibuffer. */)
369 int prompt_end = XINT (Fminibuffer_prompt_end ());
370 return make_buffer_string (prompt_end, ZV, 1);
373 DEFUN ("minibuffer-contents-no-properties", Fminibuffer_contents_no_properties,
374 Sminibuffer_contents_no_properties, 0, 0, 0,
375 doc: /* Return the user input in a minibuffer as a string, without text-properties.
376 The current buffer must be a minibuffer. */)
379 int prompt_end = XINT (Fminibuffer_prompt_end ());
380 return make_buffer_string (prompt_end, ZV, 0);
383 DEFUN ("delete-minibuffer-contents", Fdelete_minibuffer_contents,
384 Sdelete_minibuffer_contents, 0, 0, 0,
385 doc: /* Delete all user input in a minibuffer.
386 The current buffer must be a minibuffer. */)
389 int prompt_end = XINT (Fminibuffer_prompt_end ());
390 if (prompt_end < ZV)
391 del_range (prompt_end, ZV);
392 return Qnil;
395 /* Get the text in the minibuffer before point.
396 That is what completion commands operate on. */
398 Lisp_Object
399 minibuffer_completion_contents ()
401 int prompt_end = XINT (Fminibuffer_prompt_end ());
402 return make_buffer_string (prompt_end, PT, 1);
405 /* Read from the minibuffer using keymap MAP, initial contents INITIAL
406 (a string), putting point minus BACKUP_N bytes from the end of INITIAL,
407 prompting with PROMPT (a string), using history list HISTVAR
408 with initial position HISTPOS. (BACKUP_N should be <= 0.)
410 Normally return the result as a string (the text that was read),
411 but if EXPFLAG is nonzero, read it and return the object read.
412 If HISTVAR is given, save the value read on that history only if it doesn't
413 match the front of that history list exactly. The value is pushed onto
414 the list as the string that was read.
416 DEFALT specifies te default value for the sake of history commands.
418 If ALLOW_PROPS is nonzero, we do not throw away text properties.
420 if INHERIT_INPUT_METHOD is nonzeor, the minibuffer inherit the
421 current input method. */
423 static Lisp_Object
424 read_minibuf (map, initial, prompt, backup_n, expflag,
425 histvar, histpos, defalt, allow_props, inherit_input_method)
426 Lisp_Object map;
427 Lisp_Object initial;
428 Lisp_Object prompt;
429 Lisp_Object backup_n;
430 int expflag;
431 Lisp_Object histvar;
432 Lisp_Object histpos;
433 Lisp_Object defalt;
434 int allow_props;
435 int inherit_input_method;
437 Lisp_Object val;
438 int count = SPECPDL_INDEX ();
439 Lisp_Object mini_frame, ambient_dir, minibuffer, input_method;
440 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5;
441 Lisp_Object enable_multibyte;
442 extern Lisp_Object Qfront_sticky;
443 extern Lisp_Object Qrear_nonsticky;
445 specbind (Qminibuffer_default, defalt);
447 single_kboard_state ();
448 #ifdef HAVE_X_WINDOWS
449 if (display_hourglass_p)
450 cancel_hourglass ();
451 #endif
453 val = Qnil;
454 ambient_dir = current_buffer->directory;
455 input_method = Qnil;
456 enable_multibyte = Qnil;
458 /* Don't need to protect PROMPT, HISTVAR, and HISTPOS because we
459 store them away before we can GC. Don't need to protect
460 BACKUP_N because we use the value only if it is an integer. */
461 GCPRO5 (map, initial, val, ambient_dir, input_method);
463 if (!STRINGP (prompt))
464 prompt = empty_string;
466 if (!enable_recursive_minibuffers
467 && minibuf_level > 0)
469 if (EQ (selected_window, minibuf_window))
470 error ("Command attempted to use minibuffer while in minibuffer");
471 else
472 /* If we're in another window, cancel the minibuffer that's active. */
473 Fthrow (Qexit,
474 build_string ("Command attempted to use minibuffer while in minibuffer"));
477 if (noninteractive)
479 val = read_minibuf_noninteractive (map, initial, prompt, backup_n,
480 expflag, histvar, histpos, defalt,
481 allow_props, inherit_input_method);
482 return unbind_to (count, val);
485 /* Choose the minibuffer window and frame, and take action on them. */
487 choose_minibuf_frame ();
489 record_unwind_protect (choose_minibuf_frame_1, Qnil);
491 record_unwind_protect (Fset_window_configuration,
492 Fcurrent_window_configuration (Qnil));
494 /* If the minibuffer window is on a different frame, save that
495 frame's configuration too. */
496 mini_frame = WINDOW_FRAME (XWINDOW (minibuf_window));
497 if (!EQ (mini_frame, selected_frame))
498 record_unwind_protect (Fset_window_configuration,
499 Fcurrent_window_configuration (mini_frame));
501 /* If the minibuffer is on an iconified or invisible frame,
502 make it visible now. */
503 Fmake_frame_visible (mini_frame);
505 if (minibuffer_auto_raise)
506 Fraise_frame (mini_frame);
508 /* We have to do this after saving the window configuration
509 since that is what restores the current buffer. */
511 /* Arrange to restore a number of minibuffer-related variables.
512 We could bind each variable separately, but that would use lots of
513 specpdl slots. */
514 minibuf_save_list
515 = Fcons (Voverriding_local_map,
516 Fcons (minibuf_window, minibuf_save_list));
517 minibuf_save_list
518 = Fcons (minibuf_prompt,
519 Fcons (make_number (minibuf_prompt_width),
520 Fcons (Vhelp_form,
521 Fcons (Vcurrent_prefix_arg,
522 Fcons (Vminibuffer_history_position,
523 Fcons (Vminibuffer_history_variable,
524 minibuf_save_list))))));
526 record_unwind_protect (read_minibuf_unwind, Qnil);
527 minibuf_level++;
529 /* Now that we can restore all those variables, start changing them. */
531 minibuf_prompt_width = 0;
532 minibuf_prompt = Fcopy_sequence (prompt);
533 Vminibuffer_history_position = histpos;
534 Vminibuffer_history_variable = histvar;
535 Vhelp_form = Vminibuffer_help_form;
537 if (inherit_input_method)
539 /* `current-input-method' is buffer local. So, remember it in
540 INPUT_METHOD before changing the current buffer. */
541 input_method = Fsymbol_value (Qcurrent_input_method);
542 enable_multibyte = current_buffer->enable_multibyte_characters;
545 /* Switch to the minibuffer. */
547 minibuffer = get_minibuffer (minibuf_level);
548 Fset_buffer (minibuffer);
550 /* The current buffer's default directory is usually the right thing
551 for our minibuffer here. However, if you're typing a command at
552 a minibuffer-only frame when minibuf_level is zero, then buf IS
553 the current_buffer, so reset_buffer leaves buf's default
554 directory unchanged. This is a bummer when you've just started
555 up Emacs and buf's default directory is Qnil. Here's a hack; can
556 you think of something better to do? Find another buffer with a
557 better directory, and use that one instead. */
558 if (STRINGP (ambient_dir))
559 current_buffer->directory = ambient_dir;
560 else
562 Lisp_Object buf_list;
564 for (buf_list = Vbuffer_alist;
565 CONSP (buf_list);
566 buf_list = XCDR (buf_list))
568 Lisp_Object other_buf;
570 other_buf = XCDR (XCAR (buf_list));
571 if (STRINGP (XBUFFER (other_buf)->directory))
573 current_buffer->directory = XBUFFER (other_buf)->directory;
574 break;
579 if (!EQ (mini_frame, selected_frame))
580 Fredirect_frame_focus (selected_frame, mini_frame);
582 Vminibuf_scroll_window = selected_window;
583 if (minibuf_level == 1 || !EQ (minibuf_window, selected_window))
584 minibuf_selected_window = selected_window;
585 Fset_window_buffer (minibuf_window, Fcurrent_buffer ());
586 Fselect_window (minibuf_window);
587 XSETFASTINT (XWINDOW (minibuf_window)->hscroll, 0);
589 Fmake_local_variable (Qprint_escape_newlines);
590 print_escape_newlines = 1;
592 /* Erase the buffer. */
594 int count1 = SPECPDL_INDEX ();
595 specbind (Qinhibit_read_only, Qt);
596 specbind (Qinhibit_modification_hooks, Qt);
597 Ferase_buffer ();
598 unbind_to (count1, Qnil);
601 if (!NILP (current_buffer->enable_multibyte_characters)
602 && ! STRING_MULTIBYTE (minibuf_prompt))
603 minibuf_prompt = Fstring_make_multibyte (minibuf_prompt);
605 /* Insert the prompt, record where it ends. */
606 Finsert (1, &minibuf_prompt);
607 if (PT > BEG)
609 Fput_text_property (make_number (BEG), make_number (PT),
610 Qfront_sticky, Qt, Qnil);
611 Fput_text_property (make_number (BEG), make_number (PT),
612 Qrear_nonsticky, Qt, Qnil);
613 Fput_text_property (make_number (BEG), make_number (PT),
614 Qfield, Qt, Qnil);
615 Fadd_text_properties (make_number (BEG), make_number (PT),
616 Vminibuffer_prompt_properties, Qnil);
619 minibuf_prompt_width = (int) current_column (); /* iftc */
621 /* If appropriate, copy enable-multibyte-characters into the minibuffer. */
622 if (inherit_input_method)
623 current_buffer->enable_multibyte_characters = enable_multibyte;
625 /* Put in the initial input. */
626 if (!NILP (initial))
628 Finsert (1, &initial);
629 if (INTEGERP (backup_n))
630 Fforward_char (backup_n);
633 clear_message (1, 1);
634 current_buffer->keymap = map;
636 /* Turn on an input method stored in INPUT_METHOD if any. */
637 if (STRINGP (input_method) && !NILP (Ffboundp (Qactivate_input_method)))
638 call1 (Qactivate_input_method, input_method);
640 /* Run our hook, but not if it is empty.
641 (run-hooks would do nothing if it is empty,
642 but it's important to save time here in the usual case.) */
643 if (!NILP (Vminibuffer_setup_hook) && !EQ (Vminibuffer_setup_hook, Qunbound)
644 && !NILP (Vrun_hooks))
645 call1 (Vrun_hooks, Qminibuffer_setup_hook);
647 /* Don't allow the user to undo past this point. */
648 current_buffer->undo_list = Qnil;
650 recursive_edit_1 ();
652 /* If cursor is on the minibuffer line,
653 show the user we have exited by putting it in column 0. */
654 if (XWINDOW (minibuf_window)->cursor.vpos >= 0
655 && !noninteractive)
657 XWINDOW (minibuf_window)->cursor.hpos = 0;
658 XWINDOW (minibuf_window)->cursor.x = 0;
659 XWINDOW (minibuf_window)->must_be_updated_p = 1;
660 update_frame (XFRAME (selected_frame), 1, 1);
661 if (rif && rif->flush_display)
662 rif->flush_display (XFRAME (XWINDOW (minibuf_window)->frame));
665 /* Make minibuffer contents into a string. */
666 Fset_buffer (minibuffer);
667 if (allow_props)
668 val = Fminibuffer_contents ();
669 else
670 val = Fminibuffer_contents_no_properties ();
672 /* VAL is the string of minibuffer text. */
674 last_minibuf_string = val;
676 /* Add the value to the appropriate history list unless it is empty. */
677 if (SCHARS (val) != 0
678 && SYMBOLP (Vminibuffer_history_variable))
680 /* If the caller wanted to save the value read on a history list,
681 then do so if the value is not already the front of the list. */
682 Lisp_Object histval;
684 /* If variable is unbound, make it nil. */
685 if (EQ (SYMBOL_VALUE (Vminibuffer_history_variable), Qunbound))
686 Fset (Vminibuffer_history_variable, Qnil);
688 histval = Fsymbol_value (Vminibuffer_history_variable);
690 /* The value of the history variable must be a cons or nil. Other
691 values are unacceptable. We silently ignore these values. */
692 if (NILP (histval)
693 || (CONSP (histval)
694 && NILP (Fequal (last_minibuf_string, Fcar (histval)))))
696 Lisp_Object length;
698 histval = Fcons (last_minibuf_string, histval);
699 Fset (Vminibuffer_history_variable, histval);
701 /* Truncate if requested. */
702 length = Fget (Vminibuffer_history_variable, Qhistory_length);
703 if (NILP (length)) length = Vhistory_length;
704 if (INTEGERP (length))
706 if (XINT (length) <= 0)
707 Fset (Vminibuffer_history_variable, Qnil);
708 else
710 Lisp_Object temp;
712 temp = Fnthcdr (Fsub1 (length), histval);
713 if (CONSP (temp)) Fsetcdr (temp, Qnil);
719 /* If Lisp form desired instead of string, parse it. */
720 if (expflag)
721 val = string_to_object (val, defalt);
723 /* The appropriate frame will get selected
724 in set-window-configuration. */
725 RETURN_UNGCPRO (unbind_to (count, val));
728 /* Return a buffer to be used as the minibuffer at depth `depth'.
729 depth = 0 is the lowest allowed argument, and that is the value
730 used for nonrecursive minibuffer invocations */
732 Lisp_Object
733 get_minibuffer (depth)
734 int depth;
736 Lisp_Object tail, num, buf;
737 char name[24];
738 extern Lisp_Object nconc2 ();
740 XSETFASTINT (num, depth);
741 tail = Fnthcdr (num, Vminibuffer_list);
742 if (NILP (tail))
744 tail = Fcons (Qnil, Qnil);
745 Vminibuffer_list = nconc2 (Vminibuffer_list, tail);
747 buf = Fcar (tail);
748 if (NILP (buf) || NILP (XBUFFER (buf)->name))
750 sprintf (name, " *Minibuf-%d*", depth);
751 buf = Fget_buffer_create (build_string (name));
753 /* Although the buffer's name starts with a space, undo should be
754 enabled in it. */
755 Fbuffer_enable_undo (buf);
757 XSETCAR (tail, buf);
759 else
761 int count = SPECPDL_INDEX ();
763 reset_buffer (XBUFFER (buf));
764 record_unwind_protect (Fset_buffer, Fcurrent_buffer ());
765 Fset_buffer (buf);
766 Fkill_all_local_variables ();
767 unbind_to (count, Qnil);
770 return buf;
773 /* This function is called on exiting minibuffer, whether normally or
774 not, and it restores the current window, buffer, etc. */
776 static Lisp_Object
777 read_minibuf_unwind (data)
778 Lisp_Object data;
780 Lisp_Object old_deactivate_mark;
781 Lisp_Object window;
783 /* We are exiting the minibuffer one way or the other,
784 so run the hook. */
785 if (!NILP (Vminibuffer_exit_hook) && !EQ (Vminibuffer_exit_hook, Qunbound)
786 && !NILP (Vrun_hooks))
787 safe_run_hooks (Qminibuffer_exit_hook);
789 /* If this was a recursive minibuffer,
790 tie the minibuffer window back to the outer level minibuffer buffer. */
791 minibuf_level--;
793 window = minibuf_window;
794 /* To keep things predictable, in case it matters, let's be in the
795 minibuffer when we reset the relevant variables. */
796 Fset_buffer (XWINDOW (window)->buffer);
798 /* Restore prompt, etc, from outer minibuffer level. */
799 minibuf_prompt = Fcar (minibuf_save_list);
800 minibuf_save_list = Fcdr (minibuf_save_list);
801 minibuf_prompt_width = XFASTINT (Fcar (minibuf_save_list));
802 minibuf_save_list = Fcdr (minibuf_save_list);
803 Vhelp_form = Fcar (minibuf_save_list);
804 minibuf_save_list = Fcdr (minibuf_save_list);
805 Vcurrent_prefix_arg = Fcar (minibuf_save_list);
806 minibuf_save_list = Fcdr (minibuf_save_list);
807 Vminibuffer_history_position = Fcar (minibuf_save_list);
808 minibuf_save_list = Fcdr (minibuf_save_list);
809 Vminibuffer_history_variable = Fcar (minibuf_save_list);
810 minibuf_save_list = Fcdr (minibuf_save_list);
811 Voverriding_local_map = Fcar (minibuf_save_list);
812 minibuf_save_list = Fcdr (minibuf_save_list);
813 #if 0
814 temp = Fcar (minibuf_save_list);
815 if (FRAME_LIVE_P (XFRAME (WINDOW_FRAME (XWINDOW (temp)))))
816 minibuf_window = temp;
817 #endif
818 minibuf_save_list = Fcdr (minibuf_save_list);
820 /* Erase the minibuffer we were using at this level. */
822 int count = SPECPDL_INDEX ();
823 /* Prevent error in erase-buffer. */
824 specbind (Qinhibit_read_only, Qt);
825 specbind (Qinhibit_modification_hooks, Qt);
826 old_deactivate_mark = Vdeactivate_mark;
827 Ferase_buffer ();
828 Vdeactivate_mark = old_deactivate_mark;
829 unbind_to (count, Qnil);
832 /* When we get to the outmost level, make sure we resize the
833 mini-window back to its normal size. */
834 if (minibuf_level == 0)
835 resize_mini_window (XWINDOW (window), 0);
837 /* Make sure minibuffer window is erased, not ignored. */
838 windows_or_buffers_changed++;
839 XSETFASTINT (XWINDOW (window)->last_modified, 0);
840 XSETFASTINT (XWINDOW (window)->last_overlay_modified, 0);
841 return Qnil;
845 DEFUN ("read-from-minibuffer", Fread_from_minibuffer, Sread_from_minibuffer, 1, 7, 0,
846 doc: /* Read a string from the minibuffer, prompting with string PROMPT.
847 If optional second arg INITIAL-CONTENTS is non-nil, it is a string
848 to be inserted into the minibuffer before reading input.
849 If INITIAL-CONTENTS is (STRING . POSITION), the initial input
850 is STRING, but point is placed at position POSITION in the minibuffer.
851 Third arg KEYMAP is a keymap to use whilst reading;
852 if omitted or nil, the default is `minibuffer-local-map'.
853 If fourth arg READ is non-nil, then interpret the result as a Lisp object
854 and return that object:
855 in other words, do `(car (read-from-string INPUT-STRING))'
856 Fifth arg HIST, if non-nil, specifies a history list
857 and optionally the initial position in the list.
858 It can be a symbol, which is the history list variable to use,
859 or it can be a cons cell (HISTVAR . HISTPOS).
860 In that case, HISTVAR is the history list variable to use,
861 and HISTPOS is the initial position (the position in the list
862 which INITIAL-CONTENTS corresponds to).
863 Positions are counted starting from 1 at the beginning of the list.
864 Sixth arg DEFAULT-VALUE is the default value. If non-nil, it is available
865 for history commands; but `read-from-minibuffer' does NOT return DEFAULT-VALUE
866 if the user enters empty input! It returns the empty string.
867 Seventh arg INHERIT-INPUT-METHOD, if non-nil, means the minibuffer inherits
868 the current input method and the setting of `enable-multibyte-characters'.
869 If the variable `minibuffer-allow-text-properties' is non-nil,
870 then the string which is returned includes whatever text properties
871 were present in the minibuffer. Otherwise the value has no text properties. */)
872 (prompt, initial_contents, keymap, read, hist, default_value, inherit_input_method)
873 Lisp_Object prompt, initial_contents, keymap, read, hist, default_value;
874 Lisp_Object inherit_input_method;
876 int pos = 0;
877 Lisp_Object histvar, histpos, position, val;
878 struct gcpro gcpro1;
880 position = Qnil;
882 CHECK_STRING (prompt);
883 if (!NILP (initial_contents))
885 if (CONSP (initial_contents))
887 position = Fcdr (initial_contents);
888 initial_contents = Fcar (initial_contents);
890 CHECK_STRING (initial_contents);
891 if (!NILP (position))
893 CHECK_NUMBER (position);
894 /* Convert to distance from end of input. */
895 if (XINT (position) < 1)
896 /* A number too small means the beginning of the string. */
897 pos = - SCHARS (initial_contents);
898 else
899 pos = XINT (position) - 1 - SCHARS (initial_contents);
903 if (NILP (keymap))
904 keymap = Vminibuffer_local_map;
905 else
906 keymap = get_keymap (keymap, 1, 0);
908 if (SYMBOLP (hist))
910 histvar = hist;
911 histpos = Qnil;
913 else
915 histvar = Fcar_safe (hist);
916 histpos = Fcdr_safe (hist);
918 if (NILP (histvar))
919 histvar = Qminibuffer_history;
920 if (NILP (histpos))
921 XSETFASTINT (histpos, 0);
923 GCPRO1 (default_value);
924 val = read_minibuf (keymap, initial_contents, prompt,
925 make_number (pos), !NILP (read),
926 histvar, histpos, default_value,
927 minibuffer_allow_text_properties,
928 !NILP (inherit_input_method));
929 UNGCPRO;
930 return val;
933 DEFUN ("read-minibuffer", Fread_minibuffer, Sread_minibuffer, 1, 2, 0,
934 doc: /* Return a Lisp object read using the minibuffer.
935 Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS
936 is a string to insert in the minibuffer before reading. */)
937 (prompt, initial_contents)
938 Lisp_Object prompt, initial_contents;
940 CHECK_STRING (prompt);
941 if (!NILP (initial_contents))
942 CHECK_STRING (initial_contents);
943 return read_minibuf (Vminibuffer_local_map, initial_contents,
944 prompt, Qnil, 1, Qminibuffer_history,
945 make_number (0), Qnil, 0, 0);
948 DEFUN ("eval-minibuffer", Feval_minibuffer, Seval_minibuffer, 1, 2, 0,
949 doc: /* Return value of Lisp expression read using the minibuffer.
950 Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS
951 is a string to insert in the minibuffer before reading. */)
952 (prompt, initial_contents)
953 Lisp_Object prompt, initial_contents;
955 return Feval (Fread_minibuffer (prompt, initial_contents));
958 /* Functions that use the minibuffer to read various things. */
960 DEFUN ("read-string", Fread_string, Sread_string, 1, 5, 0,
961 doc: /* Read a string from the minibuffer, prompting with string PROMPT.
962 If non-nil, second arg INITIAL-INPUT is a string to insert before reading.
963 The third arg HISTORY, if non-nil, specifies a history list
964 and optionally the initial position in the list.
965 See `read-from-minibuffer' for details of HISTORY argument.
966 Fourth arg DEFAULT-VALUE is the default value. If non-nil, it is used
967 for history commands, and as the value to return if the user enters
968 the empty string.
969 Fifth arg INHERIT-INPUT-METHOD, if non-nil, means the minibuffer inherits
970 the current input method and the setting of `enable-multibyte-characters'. */)
971 (prompt, initial_input, history, default_value, inherit_input_method)
972 Lisp_Object prompt, initial_input, history, default_value;
973 Lisp_Object inherit_input_method;
975 Lisp_Object val;
976 val = Fread_from_minibuffer (prompt, initial_input, Qnil,
977 Qnil, history, default_value,
978 inherit_input_method);
979 if (STRINGP (val) && SCHARS (val) == 0 && ! NILP (default_value))
980 val = default_value;
981 return val;
984 DEFUN ("read-no-blanks-input", Fread_no_blanks_input, Sread_no_blanks_input, 1, 3, 0,
985 doc: /* Read a string from the terminal, not allowing blanks.
986 Prompt with PROMPT, and provide INITIAL as an initial value of the input string.
987 Third arg INHERIT-INPUT-METHOD, if non-nil, means the minibuffer inherits
988 the current input method and the setting of `enable-multibyte-characters'. */)
989 (prompt, initial, inherit_input_method)
990 Lisp_Object prompt, initial, inherit_input_method;
992 CHECK_STRING (prompt);
993 if (! NILP (initial))
994 CHECK_STRING (initial);
996 return read_minibuf (Vminibuffer_local_ns_map, initial, prompt, Qnil,
997 0, Qminibuffer_history, make_number (0), Qnil, 0,
998 !NILP (inherit_input_method));
1001 DEFUN ("read-command", Fread_command, Sread_command, 1, 2, 0,
1002 doc: /* Read the name of a command and return as a symbol.
1003 Prompt with PROMPT. By default, return DEFAULT-VALUE. */)
1004 (prompt, default_value)
1005 Lisp_Object prompt, default_value;
1007 Lisp_Object name, default_string;
1009 if (NILP (default_value))
1010 default_string = Qnil;
1011 else if (SYMBOLP (default_value))
1012 default_string = SYMBOL_NAME (default_value);
1013 else
1014 default_string = default_value;
1016 name = Fcompleting_read (prompt, Vobarray, Qcommandp, Qt,
1017 Qnil, Qnil, default_string, Qnil);
1018 if (NILP (name))
1019 return name;
1020 return Fintern (name, Qnil);
1023 #ifdef NOTDEF
1024 DEFUN ("read-function", Fread_function, Sread_function, 1, 1, 0,
1025 doc: /* One arg PROMPT, a string. Read the name of a function and return as a symbol.
1026 Prompt with PROMPT. */)
1027 (prompt)
1028 Lisp_Object prompt;
1030 return Fintern (Fcompleting_read (prompt, Vobarray, Qfboundp, Qt, Qnil, Qnil, Qnil, Qnil),
1031 Qnil);
1033 #endif /* NOTDEF */
1035 DEFUN ("read-variable", Fread_variable, Sread_variable, 1, 2, 0,
1036 doc: /* Read the name of a user variable and return it as a symbol.
1037 Prompt with PROMPT. By default, return DEFAULT-VALUE.
1038 A user variable is one whose documentation starts with a `*' character. */)
1039 (prompt, default_value)
1040 Lisp_Object prompt, default_value;
1042 Lisp_Object name, default_string;
1044 if (NILP (default_value))
1045 default_string = Qnil;
1046 else if (SYMBOLP (default_value))
1047 default_string = SYMBOL_NAME (default_value);
1048 else
1049 default_string = default_value;
1051 name = Fcompleting_read (prompt, Vobarray,
1052 Quser_variable_p, Qt,
1053 Qnil, Qnil, default_string, Qnil);
1054 if (NILP (name))
1055 return name;
1056 return Fintern (name, Qnil);
1059 DEFUN ("read-buffer", Fread_buffer, Sread_buffer, 1, 3, 0,
1060 doc: /* Read the name of a buffer and return as a string.
1061 Prompt with PROMPT.
1062 Optional second arg DEF is value to return if user enters an empty line.
1063 If optional third arg REQUIRE-MATCH is non-nil,
1064 only existing buffer names are allowed. */)
1065 (prompt, def, require_match)
1066 Lisp_Object prompt, def, require_match;
1068 Lisp_Object args[4];
1070 if (BUFFERP (def))
1071 def = XBUFFER (def)->name;
1073 if (NILP (Vread_buffer_function))
1075 if (!NILP (def))
1077 args[0] = build_string ("%s(default %s) ");
1078 args[1] = prompt;
1079 args[2] = def;
1080 prompt = Fformat (3, args);
1083 return Fcompleting_read (prompt, Vbuffer_alist, Qnil,
1084 require_match, Qnil, Qbuffer_name_history,
1085 def, Qnil);
1087 else
1089 args[0] = Vread_buffer_function;
1090 args[1] = prompt;
1091 args[2] = def;
1092 args[3] = require_match;
1093 return Ffuncall(4, args);
1097 static Lisp_Object
1098 minibuf_conform_representation (string, basis)
1099 Lisp_Object string, basis;
1101 if (STRING_MULTIBYTE (string) == STRING_MULTIBYTE (basis))
1102 return string;
1104 if (STRING_MULTIBYTE (string))
1105 return Fstring_make_unibyte (string);
1106 else
1107 return Fstring_make_multibyte (string);
1110 DEFUN ("try-completion", Ftry_completion, Stry_completion, 2, 3, 0,
1111 doc: /* Return common substring of all completions of STRING in ALIST.
1112 Each car of each element of ALIST is tested to see if it begins with STRING.
1113 All that match are compared together; the longest initial sequence
1114 common to all matches is returned as a string.
1115 If there is no match at all, nil is returned.
1116 For a unique match which is exact, t is returned.
1118 If ALIST is a hash-table, all the string keys are the possible matches.
1119 If ALIST is an obarray, the names of all symbols in the obarray
1120 are the possible matches.
1122 ALIST can also be a function to do the completion itself.
1123 It receives three arguments: the values STRING, PREDICATE and nil.
1124 Whatever it returns becomes the value of `try-completion'.
1126 If optional third argument PREDICATE is non-nil,
1127 it is used to test each possible match.
1128 The match is a candidate only if PREDICATE returns non-nil.
1129 The argument given to PREDICATE is the alist element
1130 or the symbol from the obarray. If ALIST is a hash-table,
1131 predicate is called with two arguments: the key and the value.
1132 Additionally to this predicate, `completion-regexp-list'
1133 is used to further constrain the set of candidates. */)
1134 (string, alist, predicate)
1135 Lisp_Object string, alist, predicate;
1137 Lisp_Object bestmatch, tail, elt, eltstring;
1138 /* Size in bytes of BESTMATCH. */
1139 int bestmatchsize = 0;
1140 /* These are in bytes, too. */
1141 int compare, matchsize;
1142 int type = HASH_TABLE_P (alist) ? 3
1143 : VECTORP (alist) ? 2
1144 : NILP (alist) || (CONSP (alist)
1145 && (!SYMBOLP (XCAR (alist))
1146 || NILP (XCAR (alist))));
1147 int index = 0, obsize = 0;
1148 int matchcount = 0;
1149 Lisp_Object bucket, zero, end, tem;
1150 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
1152 CHECK_STRING (string);
1153 if (type == 0)
1154 return call3 (alist, string, predicate, Qnil);
1156 bestmatch = bucket = Qnil;
1158 /* If ALIST is not a list, set TAIL just for gc pro. */
1159 tail = alist;
1160 if (type == 2)
1162 obsize = XVECTOR (alist)->size;
1163 bucket = XVECTOR (alist)->contents[index];
1166 while (1)
1168 /* Get the next element of the alist, obarray, or hash-table. */
1169 /* Exit the loop if the elements are all used up. */
1170 /* elt gets the alist element or symbol.
1171 eltstring gets the name to check as a completion. */
1173 if (type == 1)
1175 if (!CONSP (tail))
1176 break;
1177 elt = XCAR (tail);
1178 eltstring = CONSP (elt) ? XCAR (elt) : elt;
1179 tail = XCDR (tail);
1181 else if (type == 2)
1183 if (XFASTINT (bucket) != 0)
1185 elt = bucket;
1186 eltstring = Fsymbol_name (elt);
1187 if (XSYMBOL (bucket)->next)
1188 XSETSYMBOL (bucket, XSYMBOL (bucket)->next);
1189 else
1190 XSETFASTINT (bucket, 0);
1192 else if (++index >= obsize)
1193 break;
1194 else
1196 bucket = XVECTOR (alist)->contents[index];
1197 continue;
1200 else /* if (type == 3) */
1202 while (index < HASH_TABLE_SIZE (XHASH_TABLE (alist))
1203 && NILP (HASH_HASH (XHASH_TABLE (alist), index)))
1204 index++;
1205 if (index >= HASH_TABLE_SIZE (XHASH_TABLE (alist)))
1206 break;
1207 else
1208 elt = eltstring = HASH_KEY (XHASH_TABLE (alist), index++);
1211 /* Is this element a possible completion? */
1213 if (STRINGP (eltstring)
1214 && SCHARS (string) <= SCHARS (eltstring)
1215 && (tem = Fcompare_strings (eltstring, make_number (0),
1216 make_number (SCHARS (string)),
1217 string, make_number (0), Qnil,
1218 completion_ignore_case ?Qt : Qnil),
1219 EQ (Qt, tem)))
1221 /* Yes. */
1222 Lisp_Object regexps;
1223 Lisp_Object zero;
1224 XSETFASTINT (zero, 0);
1226 /* Ignore this element if it fails to match all the regexps. */
1227 for (regexps = Vcompletion_regexp_list; CONSP (regexps);
1228 regexps = XCDR (regexps))
1230 tem = Fstring_match (XCAR (regexps), eltstring, zero);
1231 if (NILP (tem))
1232 break;
1234 if (CONSP (regexps))
1235 continue;
1237 /* Ignore this element if there is a predicate
1238 and the predicate doesn't like it. */
1240 if (!NILP (predicate))
1242 if (EQ (predicate, Qcommandp))
1243 tem = Fcommandp (elt, Qnil);
1244 else
1246 GCPRO4 (tail, string, eltstring, bestmatch);
1247 tem = type == 3
1248 ? call2 (predicate, elt,
1249 HASH_VALUE (XHASH_TABLE (alist), index - 1))
1250 : call1 (predicate, elt);
1251 UNGCPRO;
1253 if (NILP (tem)) continue;
1256 /* Update computation of how much all possible completions match */
1258 if (NILP (bestmatch))
1260 matchcount = 1;
1261 bestmatch = eltstring;
1262 bestmatchsize = SCHARS (eltstring);
1264 else
1266 compare = min (bestmatchsize, SCHARS (eltstring));
1267 tem = Fcompare_strings (bestmatch, make_number (0),
1268 make_number (compare),
1269 eltstring, make_number (0),
1270 make_number (compare),
1271 completion_ignore_case ? Qt : Qnil);
1272 if (EQ (tem, Qt))
1273 matchsize = compare;
1274 else if (XINT (tem) < 0)
1275 matchsize = - XINT (tem) - 1;
1276 else
1277 matchsize = XINT (tem) - 1;
1279 if (matchsize < 0)
1280 /* When can this happen ? -stef */
1281 matchsize = compare;
1282 if (completion_ignore_case)
1284 /* If this is an exact match except for case,
1285 use it as the best match rather than one that is not an
1286 exact match. This way, we get the case pattern
1287 of the actual match. */
1288 if ((matchsize == SCHARS (eltstring)
1289 && matchsize < SCHARS (bestmatch))
1291 /* If there is more than one exact match ignoring case,
1292 and one of them is exact including case,
1293 prefer that one. */
1294 /* If there is no exact match ignoring case,
1295 prefer a match that does not change the case
1296 of the input. */
1297 ((matchsize == SCHARS (eltstring))
1299 (matchsize == SCHARS (bestmatch))
1300 && (tem = Fcompare_strings (eltstring, make_number (0),
1301 make_number (SCHARS (string)),
1302 string, make_number (0),
1303 Qnil,
1304 Qnil),
1305 EQ (Qt, tem))
1306 && (tem = Fcompare_strings (bestmatch, make_number (0),
1307 make_number (SCHARS (string)),
1308 string, make_number (0),
1309 Qnil,
1310 Qnil),
1311 ! EQ (Qt, tem))))
1312 bestmatch = eltstring;
1314 if (bestmatchsize != SCHARS (eltstring)
1315 || bestmatchsize != matchsize)
1316 /* Don't count the same string multiple times. */
1317 matchcount++;
1318 bestmatchsize = matchsize;
1319 if (matchsize <= SCHARS (string)
1320 && matchcount > 1)
1321 /* No need to look any further. */
1322 break;
1327 if (NILP (bestmatch))
1328 return Qnil; /* No completions found */
1329 /* If we are ignoring case, and there is no exact match,
1330 and no additional text was supplied,
1331 don't change the case of what the user typed. */
1332 if (completion_ignore_case && bestmatchsize == SCHARS (string)
1333 && SCHARS (bestmatch) > bestmatchsize)
1334 return minibuf_conform_representation (string, bestmatch);
1336 /* Return t if the supplied string is an exact match (counting case);
1337 it does not require any change to be made. */
1338 if (matchcount == 1 && bestmatchsize == SCHARS (string)
1339 && (tem = Fcompare_strings (bestmatch, make_number (0),
1340 make_number (bestmatchsize),
1341 string, make_number (0),
1342 make_number (bestmatchsize),
1343 Qnil),
1344 EQ (Qt, tem)))
1345 return Qt;
1347 XSETFASTINT (zero, 0); /* Else extract the part in which */
1348 XSETFASTINT (end, bestmatchsize); /* all completions agree */
1349 return Fsubstring (bestmatch, zero, end);
1352 DEFUN ("all-completions", Fall_completions, Sall_completions, 2, 4, 0,
1353 doc: /* Search for partial matches to STRING in ALIST.
1354 Each car of each element of ALIST is tested to see if it begins with STRING.
1355 The value is a list of all the strings from ALIST that match.
1357 If ALIST is a hash-table, all the string keys are the possible matches.
1358 If ALIST is an obarray, the names of all symbols in the obarray
1359 are the possible matches.
1361 ALIST can also be a function to do the completion itself.
1362 It receives three arguments: the values STRING, PREDICATE and t.
1363 Whatever it returns becomes the value of `all-completions'.
1365 If optional third argument PREDICATE is non-nil,
1366 it is used to test each possible match.
1367 The match is a candidate only if PREDICATE returns non-nil.
1368 The argument given to PREDICATE is the alist element
1369 or the symbol from the obarray. If ALIST is a hash-table,
1370 predicate is called with two arguments: the key and the value.
1371 Additionally to this predicate, `completion-regexp-list'
1372 is used to further constrain the set of candidates.
1374 If the optional fourth argument HIDE-SPACES is non-nil,
1375 strings in ALIST that start with a space
1376 are ignored unless STRING itself starts with a space. */)
1377 (string, alist, predicate, hide_spaces)
1378 Lisp_Object string, alist, predicate, hide_spaces;
1380 Lisp_Object tail, elt, eltstring;
1381 Lisp_Object allmatches;
1382 int type = HASH_TABLE_P (alist) ? 3
1383 : VECTORP (alist) ? 2
1384 : NILP (alist) || (CONSP (alist)
1385 && (!SYMBOLP (XCAR (alist))
1386 || NILP (XCAR (alist))));
1387 int index = 0, obsize = 0;
1388 Lisp_Object bucket, tem;
1389 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
1391 CHECK_STRING (string);
1392 if (type == 0)
1393 return call3 (alist, string, predicate, Qt);
1394 allmatches = bucket = Qnil;
1396 /* If ALIST is not a list, set TAIL just for gc pro. */
1397 tail = alist;
1398 if (type == 2)
1400 obsize = XVECTOR (alist)->size;
1401 bucket = XVECTOR (alist)->contents[index];
1404 while (1)
1406 /* Get the next element of the alist, obarray, or hash-table. */
1407 /* Exit the loop if the elements are all used up. */
1408 /* elt gets the alist element or symbol.
1409 eltstring gets the name to check as a completion. */
1411 if (type == 1)
1413 if (!CONSP (tail))
1414 break;
1415 elt = XCAR (tail);
1416 eltstring = CONSP (elt) ? XCAR (elt) : elt;
1417 tail = XCDR (tail);
1419 else if (type == 2)
1421 if (XFASTINT (bucket) != 0)
1423 elt = bucket;
1424 eltstring = Fsymbol_name (elt);
1425 if (XSYMBOL (bucket)->next)
1426 XSETSYMBOL (bucket, XSYMBOL (bucket)->next);
1427 else
1428 XSETFASTINT (bucket, 0);
1430 else if (++index >= obsize)
1431 break;
1432 else
1434 bucket = XVECTOR (alist)->contents[index];
1435 continue;
1438 else /* if (type == 3) */
1440 while (index < HASH_TABLE_SIZE (XHASH_TABLE (alist))
1441 && NILP (HASH_HASH (XHASH_TABLE (alist), index)))
1442 index++;
1443 if (index >= HASH_TABLE_SIZE (XHASH_TABLE (alist)))
1444 break;
1445 else
1446 elt = eltstring = HASH_KEY (XHASH_TABLE (alist), index++);
1449 /* Is this element a possible completion? */
1451 if (STRINGP (eltstring)
1452 && SCHARS (string) <= SCHARS (eltstring)
1453 /* If HIDE_SPACES, reject alternatives that start with space
1454 unless the input starts with space. */
1455 && ((SBYTES (string) > 0
1456 && SREF (string, 0) == ' ')
1457 || SREF (eltstring, 0) != ' '
1458 || NILP (hide_spaces))
1459 && (tem = Fcompare_strings (eltstring, make_number (0),
1460 make_number (SCHARS (string)),
1461 string, make_number (0),
1462 make_number (SCHARS (string)),
1463 completion_ignore_case ? Qt : Qnil),
1464 EQ (Qt, tem)))
1466 /* Yes. */
1467 Lisp_Object regexps;
1468 Lisp_Object zero;
1469 XSETFASTINT (zero, 0);
1471 /* Ignore this element if it fails to match all the regexps. */
1472 for (regexps = Vcompletion_regexp_list; CONSP (regexps);
1473 regexps = XCDR (regexps))
1475 tem = Fstring_match (XCAR (regexps), eltstring, zero);
1476 if (NILP (tem))
1477 break;
1479 if (CONSP (regexps))
1480 continue;
1482 /* Ignore this element if there is a predicate
1483 and the predicate doesn't like it. */
1485 if (!NILP (predicate))
1487 if (EQ (predicate, Qcommandp))
1488 tem = Fcommandp (elt, Qnil);
1489 else
1491 GCPRO4 (tail, eltstring, allmatches, string);
1492 tem = type == 3
1493 ? call2 (predicate, elt,
1494 HASH_VALUE (XHASH_TABLE (alist), index - 1))
1495 : call1 (predicate, elt);
1496 UNGCPRO;
1498 if (NILP (tem)) continue;
1500 /* Ok => put it on the list. */
1501 allmatches = Fcons (eltstring, allmatches);
1505 return Fnreverse (allmatches);
1508 Lisp_Object Vminibuffer_completion_table, Qminibuffer_completion_table;
1509 Lisp_Object Vminibuffer_completion_predicate, Qminibuffer_completion_predicate;
1510 Lisp_Object Vminibuffer_completion_confirm, Qminibuffer_completion_confirm;
1511 Lisp_Object Vminibuffer_completing_file_name;
1513 DEFUN ("completing-read", Fcompleting_read, Scompleting_read, 2, 8, 0,
1514 doc: /* Read a string in the minibuffer, with completion.
1515 PROMPT is a string to prompt with; normally it ends in a colon and a space.
1516 TABLE is an alist whose elements' cars are strings, or an obarray.
1517 TABLE can also be a function to do the completion itself.
1518 PREDICATE limits completion to a subset of TABLE.
1519 See `try-completion' and `all-completions' for more details
1520 on completion, TABLE, and PREDICATE.
1522 If REQUIRE-MATCH is non-nil, the user is not allowed to exit unless
1523 the input is (or completes to) an element of TABLE or is null.
1524 If it is also not t, typing RET does not exit if it does non-null completion.
1525 If the input is null, `completing-read' returns an empty string,
1526 regardless of the value of REQUIRE-MATCH.
1528 If INITIAL-INPUT is non-nil, insert it in the minibuffer initially.
1529 If it is (STRING . POSITION), the initial input
1530 is STRING, but point is placed POSITION characters into the string.
1531 This feature is deprecated--it is best to pass nil for INITIAL-INPUT
1532 and supply the default value DEF instead. The user can yank the
1533 default value into the minibuffer easily using \\[next-history-element].
1535 HIST, if non-nil, specifies a history list
1536 and optionally the initial position in the list.
1537 It can be a symbol, which is the history list variable to use,
1538 or it can be a cons cell (HISTVAR . HISTPOS).
1539 In that case, HISTVAR is the history list variable to use,
1540 and HISTPOS is the initial position (the position in the list
1541 which INITIAL-INPUT corresponds to).
1542 Positions are counted starting from 1 at the beginning of the list.
1543 The variable `history-length' controls the maximum length of a
1544 history list.
1546 DEF, if non-nil, is the default value.
1548 If INHERIT-INPUT-METHOD is non-nil, the minibuffer inherits
1549 the current input method and the setting of `enable-multibyte-characters'.
1551 Completion ignores case if the ambient value of
1552 `completion-ignore-case' is non-nil. */)
1553 (prompt, table, predicate, require_match, initial_input, hist, def, inherit_input_method)
1554 Lisp_Object prompt, table, predicate, require_match, initial_input;
1555 Lisp_Object hist, def, inherit_input_method;
1557 Lisp_Object val, histvar, histpos, position;
1558 Lisp_Object init;
1559 int pos = 0;
1560 int count = SPECPDL_INDEX ();
1561 struct gcpro gcpro1;
1563 init = initial_input;
1564 GCPRO1 (def);
1566 specbind (Qminibuffer_completion_table, table);
1567 specbind (Qminibuffer_completion_predicate, predicate);
1568 specbind (Qminibuffer_completion_confirm,
1569 EQ (require_match, Qt) ? Qnil : require_match);
1570 last_exact_completion = Qnil;
1572 position = Qnil;
1573 if (!NILP (init))
1575 if (CONSP (init))
1577 position = Fcdr (init);
1578 init = Fcar (init);
1580 CHECK_STRING (init);
1581 if (!NILP (position))
1583 CHECK_NUMBER (position);
1584 /* Convert to distance from end of input. */
1585 pos = XINT (position) - SCHARS (init);
1589 if (SYMBOLP (hist))
1591 histvar = hist;
1592 histpos = Qnil;
1594 else
1596 histvar = Fcar_safe (hist);
1597 histpos = Fcdr_safe (hist);
1599 if (NILP (histvar))
1600 histvar = Qminibuffer_history;
1601 if (NILP (histpos))
1602 XSETFASTINT (histpos, 0);
1604 val = read_minibuf (NILP (require_match)
1605 ? Vminibuffer_local_completion_map
1606 : Vminibuffer_local_must_match_map,
1607 init, prompt, make_number (pos), 0,
1608 histvar, histpos, def, 0,
1609 !NILP (inherit_input_method));
1611 if (STRINGP (val) && SCHARS (val) == 0 && ! NILP (def))
1612 val = def;
1614 RETURN_UNGCPRO (unbind_to (count, val));
1617 Lisp_Object Fminibuffer_completion_help ();
1618 Lisp_Object Fassoc_string ();
1620 /* Test whether TXT is an exact completion. */
1621 DEFUN ("test-completion", Ftest_completion, Stest_completion, 2, 3, 0,
1622 doc: /* Return non-nil if STRING is a valid completion.
1623 Takes the same arguments as `all-completions' and `try-completion'.
1624 If ALIST is a function, it is called with three arguments:
1625 the values STRING, PREDICATE and `lambda'. */)
1626 (string, alist, predicate)
1627 Lisp_Object string, alist, predicate;
1629 Lisp_Object regexps, tem = Qnil;
1630 int i = 0;
1632 CHECK_STRING (string);
1634 if ((CONSP (alist) && (!SYMBOLP (XCAR (alist)) || NILP (XCAR (alist))))
1635 || NILP (alist))
1637 tem = Fassoc_string (string, alist, completion_ignore_case ? Qt : Qnil);
1638 if NILP (tem)
1639 return Qnil;
1641 else if (VECTORP (alist))
1643 /* Bypass intern-soft as that loses for nil. */
1644 tem = oblookup (alist,
1645 SDATA (string),
1646 SCHARS (string),
1647 SBYTES (string));
1648 if (!SYMBOLP (tem))
1650 if (STRING_MULTIBYTE (string))
1651 string = Fstring_make_unibyte (string);
1652 else
1653 string = Fstring_make_multibyte (string);
1655 tem = oblookup (Vminibuffer_completion_table,
1656 SDATA (string),
1657 SCHARS (string),
1658 SBYTES (string));
1659 if (!SYMBOLP (tem))
1660 return Qnil;
1663 else if (HASH_TABLE_P (alist))
1665 i = hash_lookup (XHASH_TABLE (alist), string, NULL);
1666 if (i >= 0)
1667 tem = HASH_KEY (XHASH_TABLE (alist), i);
1668 else
1669 return Qnil;
1671 else
1672 return call3 (alist, string, predicate, Qlambda);
1674 /* Reject this element if it fails to match all the regexps. */
1675 for (regexps = Vcompletion_regexp_list; CONSP (regexps);
1676 regexps = XCDR (regexps))
1678 if (NILP (Fstring_match (XCAR (regexps),
1679 SYMBOLP (tem) ? string : tem,
1680 Qnil)))
1681 return Qnil;
1684 /* Finally, check the predicate. */
1685 if (!NILP (predicate))
1686 return HASH_TABLE_P (alist)
1687 ? call2 (predicate, tem, HASH_VALUE (XHASH_TABLE (alist), i))
1688 : call1 (predicate, tem);
1689 else
1690 return Qt;
1693 /* returns:
1694 * 0 no possible completion
1695 * 1 was already an exact and unique completion
1696 * 3 was already an exact completion
1697 * 4 completed to an exact completion
1698 * 5 some completion happened
1699 * 6 no completion happened
1702 do_completion ()
1704 Lisp_Object completion, string, tem;
1705 int completedp;
1706 Lisp_Object last;
1707 struct gcpro gcpro1, gcpro2;
1709 completion = Ftry_completion (minibuffer_completion_contents (),
1710 Vminibuffer_completion_table,
1711 Vminibuffer_completion_predicate);
1712 last = last_exact_completion;
1713 last_exact_completion = Qnil;
1715 GCPRO2 (completion, last);
1717 if (NILP (completion))
1719 bitch_at_user ();
1720 temp_echo_area_glyphs (" [No match]");
1721 UNGCPRO;
1722 return 0;
1725 if (EQ (completion, Qt)) /* exact and unique match */
1727 UNGCPRO;
1728 return 1;
1731 string = minibuffer_completion_contents ();
1733 /* COMPLETEDP should be true if some completion was done, which
1734 doesn't include simply changing the case of the entered string.
1735 However, for appearance, the string is rewritten if the case
1736 changes. */
1737 tem = Fcompare_strings (completion, Qnil, Qnil, string, Qnil, Qnil, Qt);
1738 completedp = !EQ (tem, Qt);
1740 tem = Fcompare_strings (completion, Qnil, Qnil, string, Qnil, Qnil, Qnil);
1741 if (!EQ (tem, Qt))
1742 /* Rewrite the user's input. */
1744 int prompt_end = XINT (Fminibuffer_prompt_end ());
1745 /* Some completion happened */
1747 if (! NILP (Vminibuffer_completing_file_name)
1748 && SREF (completion, SBYTES (completion) - 1) == '/'
1749 && PT < ZV
1750 && FETCH_CHAR (PT_BYTE) == '/')
1752 del_range (prompt_end, PT + 1);
1754 else
1755 del_range (prompt_end, PT);
1757 Finsert (1, &completion);
1759 if (! completedp)
1760 /* The case of the string changed, but that's all. We're not
1761 sure whether this is a unique completion or not, so try again
1762 using the real case (this shouldn't recurse again, because
1763 the next time try-completion will return either `t' or the
1764 exact string). */
1766 UNGCPRO;
1767 return do_completion ();
1771 /* It did find a match. Do we match some possibility exactly now? */
1772 tem = Ftest_completion (Fminibuffer_contents (),
1773 Vminibuffer_completion_table,
1774 Vminibuffer_completion_predicate);
1775 if (NILP (tem))
1777 /* not an exact match */
1778 UNGCPRO;
1779 if (completedp)
1780 return 5;
1781 else if (!NILP (Vcompletion_auto_help))
1782 Fminibuffer_completion_help ();
1783 else
1784 temp_echo_area_glyphs (" [Next char not unique]");
1785 return 6;
1787 else if (completedp)
1789 UNGCPRO;
1790 return 4;
1792 /* If the last exact completion and this one were the same,
1793 it means we've already given a "Complete but not unique"
1794 message and the user's hit TAB again, so now we give him help. */
1795 last_exact_completion = completion;
1796 if (!NILP (last))
1798 tem = minibuffer_completion_contents ();
1799 if (!NILP (Fequal (tem, last)))
1800 Fminibuffer_completion_help ();
1802 UNGCPRO;
1803 return 3;
1806 /* Like assoc but assumes KEY is a string, and ignores case if appropriate. */
1808 DEFUN ("assoc-string", Fassoc_string, Sassoc_string, 2, 3, 0,
1809 doc: /* Like `assoc' but specifically for strings.
1810 Unibyte strings are converted to multibyte for comparison.
1811 And case is ignored if CASE-FOLD is non-nil.
1812 As opposed to `assoc', it will also match an entry consisting of a single
1813 string rather than a cons cell whose car is a string. */)
1814 (key, list, case_fold)
1815 register Lisp_Object key;
1816 Lisp_Object list, case_fold;
1818 register Lisp_Object tail;
1820 for (tail = list; !NILP (tail); tail = Fcdr (tail))
1822 register Lisp_Object elt, tem, thiscar;
1823 elt = Fcar (tail);
1824 thiscar = CONSP (elt) ? XCAR (elt) : elt;
1825 if (!STRINGP (thiscar))
1826 continue;
1827 tem = Fcompare_strings (thiscar, make_number (0), Qnil,
1828 key, make_number (0), Qnil,
1829 case_fold);
1830 if (EQ (tem, Qt))
1831 return elt;
1832 QUIT;
1834 return Qnil;
1837 DEFUN ("minibuffer-complete", Fminibuffer_complete, Sminibuffer_complete, 0, 0, "",
1838 doc: /* Complete the minibuffer contents as far as possible.
1839 Return nil if there is no valid completion, else t.
1840 If no characters can be completed, display a list of possible completions.
1841 If you repeat this command after it displayed such a list,
1842 scroll the window of possible completions. */)
1845 register int i;
1846 Lisp_Object window, tem;
1848 /* If the previous command was not this,
1849 mark the completion buffer obsolete. */
1850 if (! EQ (current_kboard->Vlast_command, Vthis_command))
1851 Vminibuf_scroll_window = Qnil;
1853 window = Vminibuf_scroll_window;
1854 /* If there's a fresh completion window with a live buffer,
1855 and this command is repeated, scroll that window. */
1856 if (! NILP (window) && ! NILP (XWINDOW (window)->buffer)
1857 && !NILP (XBUFFER (XWINDOW (window)->buffer)->name))
1859 struct buffer *obuf = current_buffer;
1861 Fset_buffer (XWINDOW (window)->buffer);
1862 tem = Fpos_visible_in_window_p (make_number (ZV), window, Qnil);
1863 if (! NILP (tem))
1864 /* If end is in view, scroll up to the beginning. */
1865 Fset_window_start (window, make_number (BEGV), Qnil);
1866 else
1867 /* Else scroll down one screen. */
1868 Fscroll_other_window (Qnil);
1870 set_buffer_internal (obuf);
1871 return Qnil;
1874 i = do_completion ();
1875 switch (i)
1877 case 0:
1878 return Qnil;
1880 case 1:
1881 if (PT != ZV)
1882 Fgoto_char (make_number (ZV));
1883 temp_echo_area_glyphs (" [Sole completion]");
1884 break;
1886 case 3:
1887 if (PT != ZV)
1888 Fgoto_char (make_number (ZV));
1889 temp_echo_area_glyphs (" [Complete, but not unique]");
1890 break;
1893 return Qt;
1896 /* Subroutines of Fminibuffer_complete_and_exit. */
1898 /* This one is called by internal_condition_case to do the real work. */
1900 Lisp_Object
1901 complete_and_exit_1 ()
1903 return make_number (do_completion ());
1906 /* This one is called by internal_condition_case if an error happens.
1907 Pretend the current value is an exact match. */
1909 Lisp_Object
1910 complete_and_exit_2 (ignore)
1911 Lisp_Object ignore;
1913 return make_number (1);
1916 DEFUN ("minibuffer-complete-and-exit", Fminibuffer_complete_and_exit,
1917 Sminibuffer_complete_and_exit, 0, 0, "",
1918 doc: /* If the minibuffer contents is a valid completion then exit.
1919 Otherwise try to complete it. If completion leads to a valid completion,
1920 a repetition of this command will exit. */)
1923 register int i;
1924 Lisp_Object val;
1926 /* Allow user to specify null string */
1927 if (XINT (Fminibuffer_prompt_end ()) == ZV)
1928 goto exit;
1930 if (!NILP (Ftest_completion (Fminibuffer_contents (),
1931 Vminibuffer_completion_table,
1932 Vminibuffer_completion_predicate)))
1933 goto exit;
1935 /* Call do_completion, but ignore errors. */
1936 SET_PT (ZV);
1937 val = internal_condition_case (complete_and_exit_1, Qerror,
1938 complete_and_exit_2);
1940 i = XFASTINT (val);
1941 switch (i)
1943 case 1:
1944 case 3:
1945 goto exit;
1947 case 4:
1948 if (!NILP (Vminibuffer_completion_confirm))
1950 temp_echo_area_glyphs (" [Confirm]");
1951 return Qnil;
1953 else
1954 goto exit;
1956 default:
1957 return Qnil;
1959 exit:
1960 return Fthrow (Qexit, Qnil);
1961 /* NOTREACHED */
1964 DEFUN ("minibuffer-complete-word", Fminibuffer_complete_word, Sminibuffer_complete_word,
1965 0, 0, "",
1966 doc: /* Complete the minibuffer contents at most a single word.
1967 After one word is completed as much as possible, a space or hyphen
1968 is added, provided that matches some possible completion.
1969 Return nil if there is no valid completion, else t. */)
1972 Lisp_Object completion, tem, tem1;
1973 register int i, i_byte;
1974 register const unsigned char *completion_string;
1975 struct gcpro gcpro1, gcpro2;
1976 int prompt_end_charpos = XINT (Fminibuffer_prompt_end ());
1978 /* We keep calling Fbuffer_string rather than arrange for GC to
1979 hold onto a pointer to one of the strings thus made. */
1981 completion = Ftry_completion (minibuffer_completion_contents (),
1982 Vminibuffer_completion_table,
1983 Vminibuffer_completion_predicate);
1984 if (NILP (completion))
1986 bitch_at_user ();
1987 temp_echo_area_glyphs (" [No match]");
1988 return Qnil;
1990 if (EQ (completion, Qt))
1991 return Qnil;
1993 #if 0 /* How the below code used to look, for reference. */
1994 tem = Fminibuffer_contents ();
1995 b = SDATA (tem);
1996 i = ZV - 1 - SCHARS (completion);
1997 p = SDATA (completion);
1998 if (i > 0 ||
1999 0 <= scmp (b, p, ZV - 1))
2001 i = 1;
2002 /* Set buffer to longest match of buffer tail and completion head. */
2003 while (0 <= scmp (b + i, p, ZV - 1 - i))
2004 i++;
2005 del_range (1, i + 1);
2006 SET_PT (ZV);
2008 #else /* Rewritten code */
2010 int buffer_nchars, completion_nchars;
2012 CHECK_STRING (completion);
2013 tem = minibuffer_completion_contents ();
2014 GCPRO2 (completion, tem);
2015 /* If reading a file name,
2016 expand any $ENVVAR refs in the buffer and in TEM. */
2017 if (! NILP (Vminibuffer_completing_file_name))
2019 Lisp_Object substituted;
2020 substituted = Fsubstitute_in_file_name (tem);
2021 if (! EQ (substituted, tem))
2023 tem = substituted;
2024 del_range (prompt_end_charpos, PT);
2025 Finsert (1, &tem);
2028 buffer_nchars = SCHARS (tem); /* # chars in what we completed. */
2029 completion_nchars = SCHARS (completion);
2030 i = buffer_nchars - completion_nchars;
2031 if (i > 0
2033 (tem1 = Fcompare_strings (tem, make_number (0),
2034 make_number (buffer_nchars),
2035 completion, make_number (0),
2036 make_number (buffer_nchars),
2037 completion_ignore_case ? Qt : Qnil),
2038 ! EQ (tem1, Qt)))
2040 int start_pos;
2042 /* Make buffer (before point) contain the longest match
2043 of TEM's tail and COMPLETION's head. */
2044 if (i <= 0) i = 1;
2045 start_pos= i;
2046 buffer_nchars -= i;
2047 while (i > 0)
2049 tem1 = Fcompare_strings (tem, make_number (start_pos), Qnil,
2050 completion, make_number (0),
2051 make_number (buffer_nchars),
2052 completion_ignore_case ? Qt : Qnil);
2053 start_pos++;
2054 if (EQ (tem1, Qt))
2055 break;
2056 i++;
2057 buffer_nchars--;
2059 del_range (1, i + 1);
2061 UNGCPRO;
2063 #endif /* Rewritten code */
2066 int prompt_end_bytepos;
2067 prompt_end_bytepos = CHAR_TO_BYTE (prompt_end_charpos);
2068 i = PT - prompt_end_charpos;
2069 i_byte = PT_BYTE - prompt_end_bytepos;
2072 /* If completion finds next char not unique,
2073 consider adding a space or a hyphen. */
2074 if (i == SCHARS (completion))
2076 GCPRO1 (completion);
2077 tem = Ftry_completion (concat2 (minibuffer_completion_contents (),
2078 build_string (" ")),
2079 Vminibuffer_completion_table,
2080 Vminibuffer_completion_predicate);
2081 UNGCPRO;
2083 if (STRINGP (tem))
2084 completion = tem;
2085 else
2087 GCPRO1 (completion);
2088 tem =
2089 Ftry_completion (concat2 (minibuffer_completion_contents (),
2090 build_string ("-")),
2091 Vminibuffer_completion_table,
2092 Vminibuffer_completion_predicate);
2093 UNGCPRO;
2095 if (STRINGP (tem))
2096 completion = tem;
2100 /* Now find first word-break in the stuff found by completion.
2101 i gets index in string of where to stop completing. */
2103 int len, c;
2104 int bytes = SBYTES (completion);
2105 completion_string = SDATA (completion);
2106 for (; i_byte < SBYTES (completion); i_byte += len, i++)
2108 c = STRING_CHAR_AND_LENGTH (completion_string + i_byte,
2109 bytes - i_byte,
2110 len);
2111 if (SYNTAX (c) != Sword)
2113 i_byte += len;
2114 i++;
2115 break;
2120 /* If got no characters, print help for user. */
2122 if (i == PT - prompt_end_charpos)
2124 if (!NILP (Vcompletion_auto_help))
2125 Fminibuffer_completion_help ();
2126 return Qnil;
2129 /* Otherwise insert in minibuffer the chars we got */
2131 if (! NILP (Vminibuffer_completing_file_name)
2132 && SREF (completion, SBYTES (completion) - 1) == '/'
2133 && PT < ZV
2134 && FETCH_CHAR (PT_BYTE) == '/')
2136 del_range (prompt_end_charpos, PT + 1);
2138 else
2139 del_range (prompt_end_charpos, PT);
2141 insert_from_string (completion, 0, 0, i, i_byte, 1);
2142 return Qt;
2145 DEFUN ("display-completion-list", Fdisplay_completion_list, Sdisplay_completion_list,
2146 1, 1, 0,
2147 doc: /* Display the list of completions, COMPLETIONS, using `standard-output'.
2148 Each element may be just a symbol or string
2149 or may be a list of two strings to be printed as if concatenated.
2150 `standard-output' must be a buffer.
2151 The actual completion alternatives, as inserted, are given `mouse-face'
2152 properties of `highlight'.
2153 At the end, this runs the normal hook `completion-setup-hook'.
2154 It can find the completion buffer in `standard-output'. */)
2155 (completions)
2156 Lisp_Object completions;
2158 Lisp_Object tail, elt;
2159 register int i;
2160 int column = 0;
2161 struct gcpro gcpro1, gcpro2;
2162 struct buffer *old = current_buffer;
2163 int first = 1;
2165 /* Note that (when it matters) every variable
2166 points to a non-string that is pointed to by COMPLETIONS,
2167 except for ELT. ELT can be pointing to a string
2168 when terpri or Findent_to calls a change hook. */
2169 elt = Qnil;
2170 GCPRO2 (completions, elt);
2172 if (BUFFERP (Vstandard_output))
2173 set_buffer_internal (XBUFFER (Vstandard_output));
2175 if (NILP (completions))
2176 write_string ("There are no possible completions of what you have typed.",
2177 -1);
2178 else
2180 write_string ("Possible completions are:", -1);
2181 for (tail = completions, i = 0; !NILP (tail); tail = Fcdr (tail), i++)
2183 Lisp_Object tem, string;
2184 int length;
2185 Lisp_Object startpos, endpos;
2187 startpos = Qnil;
2189 elt = Fcar (tail);
2190 /* Compute the length of this element. */
2191 if (CONSP (elt))
2193 tem = XCAR (elt);
2194 CHECK_STRING (tem);
2195 length = SCHARS (tem);
2197 tem = Fcar (XCDR (elt));
2198 CHECK_STRING (tem);
2199 length += SCHARS (tem);
2201 else
2203 CHECK_STRING (elt);
2204 length = SCHARS (elt);
2207 /* This does a bad job for narrower than usual windows.
2208 Sadly, the window it will appear in is not known
2209 until after the text has been made. */
2211 if (BUFFERP (Vstandard_output))
2212 XSETINT (startpos, BUF_PT (XBUFFER (Vstandard_output)));
2214 /* If the previous completion was very wide,
2215 or we have two on this line already,
2216 don't put another on the same line. */
2217 if (column > 33 || first
2218 /* If this is really wide, don't put it second on a line. */
2219 || (column > 0 && length > 45))
2221 Fterpri (Qnil);
2222 column = 0;
2224 /* Otherwise advance to column 35. */
2225 else
2227 if (BUFFERP (Vstandard_output))
2229 tem = Findent_to (make_number (35), make_number (2));
2231 column = XINT (tem);
2233 else
2237 write_string (" ", -1);
2238 column++;
2240 while (column < 35);
2244 if (BUFFERP (Vstandard_output))
2246 XSETINT (endpos, BUF_PT (XBUFFER (Vstandard_output)));
2247 Fset_text_properties (startpos, endpos,
2248 Qnil, Vstandard_output);
2251 /* Output this element.
2252 If necessary, convert it to unibyte or to multibyte first. */
2253 if (CONSP (elt))
2254 string = Fcar (elt);
2255 else
2256 string = elt;
2257 if (NILP (current_buffer->enable_multibyte_characters)
2258 && STRING_MULTIBYTE (string))
2259 string = Fstring_make_unibyte (string);
2260 else if (!NILP (current_buffer->enable_multibyte_characters)
2261 && !STRING_MULTIBYTE (string))
2262 string = Fstring_make_multibyte (string);
2264 if (BUFFERP (Vstandard_output))
2266 XSETINT (startpos, BUF_PT (XBUFFER (Vstandard_output)));
2268 Fprinc (string, Qnil);
2270 XSETINT (endpos, BUF_PT (XBUFFER (Vstandard_output)));
2272 Fput_text_property (startpos, endpos,
2273 Qmouse_face, intern ("highlight"),
2274 Vstandard_output);
2276 else
2278 Fprinc (string, Qnil);
2281 /* Output the annotation for this element. */
2282 if (CONSP (elt))
2284 if (BUFFERP (Vstandard_output))
2286 XSETINT (startpos, BUF_PT (XBUFFER (Vstandard_output)));
2288 Fprinc (Fcar (Fcdr (elt)), Qnil);
2290 XSETINT (endpos, BUF_PT (XBUFFER (Vstandard_output)));
2292 Fset_text_properties (startpos, endpos, Qnil,
2293 Vstandard_output);
2295 else
2297 Fprinc (Fcar (Fcdr (elt)), Qnil);
2302 /* Update COLUMN for what we have output. */
2303 column += length;
2305 /* If output is to a buffer, recompute COLUMN in a way
2306 that takes account of character widths. */
2307 if (BUFFERP (Vstandard_output))
2309 tem = Fcurrent_column ();
2310 column = XINT (tem);
2313 first = 0;
2317 UNGCPRO;
2319 if (BUFFERP (Vstandard_output))
2320 set_buffer_internal (old);
2322 if (!NILP (Vrun_hooks))
2323 call1 (Vrun_hooks, intern ("completion-setup-hook"));
2325 return Qnil;
2328 DEFUN ("minibuffer-completion-help", Fminibuffer_completion_help, Sminibuffer_completion_help,
2329 0, 0, "",
2330 doc: /* Display a list of possible completions of the current minibuffer contents. */)
2333 Lisp_Object completions;
2335 message ("Making completion list...");
2336 completions = Fall_completions (minibuffer_completion_contents (),
2337 Vminibuffer_completion_table,
2338 Vminibuffer_completion_predicate,
2339 Qt);
2340 clear_message (1, 0);
2342 if (NILP (completions))
2344 bitch_at_user ();
2345 temp_echo_area_glyphs (" [No completions]");
2347 else
2348 internal_with_output_to_temp_buffer ("*Completions*",
2349 Fdisplay_completion_list,
2350 Fsort (completions, Qstring_lessp));
2351 return Qnil;
2354 DEFUN ("self-insert-and-exit", Fself_insert_and_exit, Sself_insert_and_exit, 0, 0, "",
2355 doc: /* Terminate minibuffer input. */)
2358 if (INTEGERP (last_command_char))
2359 internal_self_insert (XINT (last_command_char), 0);
2360 else
2361 bitch_at_user ();
2363 return Fthrow (Qexit, Qnil);
2366 DEFUN ("exit-minibuffer", Fexit_minibuffer, Sexit_minibuffer, 0, 0, "",
2367 doc: /* Terminate this minibuffer argument. */)
2370 return Fthrow (Qexit, Qnil);
2373 DEFUN ("minibuffer-depth", Fminibuffer_depth, Sminibuffer_depth, 0, 0, 0,
2374 doc: /* Return current depth of activations of minibuffer, a nonnegative integer. */)
2377 return make_number (minibuf_level);
2380 DEFUN ("minibuffer-prompt", Fminibuffer_prompt, Sminibuffer_prompt, 0, 0, 0,
2381 doc: /* Return the prompt string of the currently-active minibuffer.
2382 If no minibuffer is active, return nil. */)
2385 return Fcopy_sequence (minibuf_prompt);
2389 /* Temporarily display the string M at the end of the current
2390 minibuffer contents. This is used to display things like
2391 "[No Match]" when the user requests a completion for a prefix
2392 that has no possible completions, and other quick, unobtrusive
2393 messages. */
2395 void
2396 temp_echo_area_glyphs (m)
2397 const char *m;
2399 int osize = ZV;
2400 int osize_byte = ZV_BYTE;
2401 int opoint = PT;
2402 int opoint_byte = PT_BYTE;
2403 Lisp_Object oinhibit;
2404 oinhibit = Vinhibit_quit;
2406 /* Clear out any old echo-area message to make way for our new thing. */
2407 message (0);
2409 SET_PT_BOTH (osize, osize_byte);
2410 insert_string (m);
2411 SET_PT_BOTH (opoint, opoint_byte);
2412 Vinhibit_quit = Qt;
2413 Fsit_for (make_number (2), Qnil, Qnil);
2414 del_range_both (osize, osize_byte, ZV, ZV_BYTE, 1);
2415 SET_PT_BOTH (opoint, opoint_byte);
2416 if (!NILP (Vquit_flag))
2418 Vquit_flag = Qnil;
2419 Vunread_command_events = Fcons (make_number (quit_char), Qnil);
2421 Vinhibit_quit = oinhibit;
2424 DEFUN ("minibuffer-message", Fminibuffer_message, Sminibuffer_message,
2425 1, 1, 0,
2426 doc: /* Temporarily display STRING at the end of the minibuffer.
2427 The text is displayed for two seconds,
2428 or until the next input event arrives, whichever comes first. */)
2429 (string)
2430 Lisp_Object string;
2432 temp_echo_area_glyphs (SDATA (string));
2433 return Qnil;
2436 void
2437 init_minibuf_once ()
2439 Vminibuffer_list = Qnil;
2440 staticpro (&Vminibuffer_list);
2443 void
2444 syms_of_minibuf ()
2446 minibuf_level = 0;
2447 minibuf_prompt = Qnil;
2448 staticpro (&minibuf_prompt);
2450 minibuf_save_list = Qnil;
2451 staticpro (&minibuf_save_list);
2453 Qread_file_name_internal = intern ("read-file-name-internal");
2454 staticpro (&Qread_file_name_internal);
2456 Qminibuffer_default = intern ("minibuffer-default");
2457 staticpro (&Qminibuffer_default);
2458 Fset (Qminibuffer_default, Qnil);
2460 Qminibuffer_completion_table = intern ("minibuffer-completion-table");
2461 staticpro (&Qminibuffer_completion_table);
2463 Qminibuffer_completion_confirm = intern ("minibuffer-completion-confirm");
2464 staticpro (&Qminibuffer_completion_confirm);
2466 Qminibuffer_completion_predicate = intern ("minibuffer-completion-predicate");
2467 staticpro (&Qminibuffer_completion_predicate);
2469 staticpro (&last_exact_completion);
2470 last_exact_completion = Qnil;
2472 staticpro (&last_minibuf_string);
2473 last_minibuf_string = Qnil;
2475 Quser_variable_p = intern ("user-variable-p");
2476 staticpro (&Quser_variable_p);
2478 Qminibuffer_history = intern ("minibuffer-history");
2479 staticpro (&Qminibuffer_history);
2481 Qbuffer_name_history = intern ("buffer-name-history");
2482 staticpro (&Qbuffer_name_history);
2483 Fset (Qbuffer_name_history, Qnil);
2485 Qminibuffer_setup_hook = intern ("minibuffer-setup-hook");
2486 staticpro (&Qminibuffer_setup_hook);
2488 Qminibuffer_exit_hook = intern ("minibuffer-exit-hook");
2489 staticpro (&Qminibuffer_exit_hook);
2491 Qhistory_length = intern ("history-length");
2492 staticpro (&Qhistory_length);
2494 Qcurrent_input_method = intern ("current-input-method");
2495 staticpro (&Qcurrent_input_method);
2497 Qactivate_input_method = intern ("activate-input-method");
2498 staticpro (&Qactivate_input_method);
2500 DEFVAR_LISP ("read-buffer-function", &Vread_buffer_function,
2501 doc: /* If this is non-nil, `read-buffer' does its work by calling this function. */);
2502 Vread_buffer_function = Qnil;
2504 DEFVAR_LISP ("minibuffer-setup-hook", &Vminibuffer_setup_hook,
2505 doc: /* Normal hook run just after entry to minibuffer. */);
2506 Vminibuffer_setup_hook = Qnil;
2508 DEFVAR_LISP ("minibuffer-exit-hook", &Vminibuffer_exit_hook,
2509 doc: /* Normal hook run just after exit from minibuffer. */);
2510 Vminibuffer_exit_hook = Qnil;
2512 DEFVAR_LISP ("history-length", &Vhistory_length,
2513 doc: /* *Maximum length for history lists before truncation takes place.
2514 A number means that length; t means infinite. Truncation takes place
2515 just after a new element is inserted. Setting the history-length
2516 property of a history variable overrides this default. */);
2517 XSETFASTINT (Vhistory_length, 30);
2519 DEFVAR_LISP ("completion-auto-help", &Vcompletion_auto_help,
2520 doc: /* *Non-nil means automatically provide help for invalid completion input. */);
2521 Vcompletion_auto_help = Qt;
2523 DEFVAR_BOOL ("completion-ignore-case", &completion_ignore_case,
2524 doc: /* Non-nil means don't consider case significant in completion. */);
2525 completion_ignore_case = 0;
2527 DEFVAR_BOOL ("enable-recursive-minibuffers", &enable_recursive_minibuffers,
2528 doc: /* *Non-nil means to allow minibuffer commands while in the minibuffer.
2529 This variable makes a difference whenever the minibuffer window is active. */);
2530 enable_recursive_minibuffers = 0;
2532 DEFVAR_LISP ("minibuffer-completion-table", &Vminibuffer_completion_table,
2533 doc: /* Alist or obarray used for completion in the minibuffer.
2534 This becomes the ALIST argument to `try-completion' and `all-completion'.
2536 The value may alternatively be a function, which is given three arguments:
2537 STRING, the current buffer contents;
2538 PREDICATE, the predicate for filtering possible matches;
2539 CODE, which says what kind of things to do.
2540 CODE can be nil, t or `lambda'.
2541 nil means to return the best completion of STRING, or nil if there is none.
2542 t means to return a list of all possible completions of STRING.
2543 `lambda' means to return t if STRING is a valid completion as it stands. */);
2544 Vminibuffer_completion_table = Qnil;
2546 DEFVAR_LISP ("minibuffer-completion-predicate", &Vminibuffer_completion_predicate,
2547 doc: /* Within call to `completing-read', this holds the PREDICATE argument. */);
2548 Vminibuffer_completion_predicate = Qnil;
2550 DEFVAR_LISP ("minibuffer-completion-confirm", &Vminibuffer_completion_confirm,
2551 doc: /* Non-nil means to demand confirmation of completion before exiting minibuffer. */);
2552 Vminibuffer_completion_confirm = Qnil;
2554 DEFVAR_LISP ("minibuffer-completing-file-name",
2555 &Vminibuffer_completing_file_name,
2556 doc: /* Non-nil means completing file names. */);
2557 Vminibuffer_completing_file_name = Qnil;
2559 DEFVAR_LISP ("minibuffer-help-form", &Vminibuffer_help_form,
2560 doc: /* Value that `help-form' takes on inside the minibuffer. */);
2561 Vminibuffer_help_form = Qnil;
2563 DEFVAR_LISP ("minibuffer-history-variable", &Vminibuffer_history_variable,
2564 doc: /* History list symbol to add minibuffer values to.
2565 Each string of minibuffer input, as it appears on exit from the minibuffer,
2566 is added with
2567 (set minibuffer-history-variable
2568 (cons STRING (symbol-value minibuffer-history-variable))) */);
2569 XSETFASTINT (Vminibuffer_history_variable, 0);
2571 DEFVAR_LISP ("minibuffer-history-position", &Vminibuffer_history_position,
2572 doc: /* Current position of redoing in the history list. */);
2573 Vminibuffer_history_position = Qnil;
2575 DEFVAR_BOOL ("minibuffer-auto-raise", &minibuffer_auto_raise,
2576 doc: /* *Non-nil means entering the minibuffer raises the minibuffer's frame.
2577 Some uses of the echo area also raise that frame (since they use it too). */);
2578 minibuffer_auto_raise = 0;
2580 DEFVAR_LISP ("completion-regexp-list", &Vcompletion_regexp_list,
2581 doc: /* List of regexps that should restrict possible completions. */);
2582 Vcompletion_regexp_list = Qnil;
2584 DEFVAR_BOOL ("minibuffer-allow-text-properties",
2585 &minibuffer_allow_text_properties,
2586 doc: /* Non-nil means `read-from-minibuffer' should not discard text properties.
2587 This also affects `read-string', but it does not affect `read-minibuffer',
2588 `read-no-blanks-input', or any of the functions that do minibuffer input
2589 with completion; they always discard text properties. */);
2590 minibuffer_allow_text_properties = 0;
2592 DEFVAR_LISP ("minibuffer-prompt-properties", &Vminibuffer_prompt_properties,
2593 doc: /* Text properties that are added to minibuffer prompts.
2594 These are in addition to the basic `field' property, and stickiness
2595 properties. */);
2596 /* We use `intern' here instead of Qread_only to avoid
2597 initialization-order problems. */
2598 Vminibuffer_prompt_properties
2599 = Fcons (intern ("read-only"), Fcons (Qt, Qnil));
2601 defsubr (&Sset_minibuffer_window);
2602 defsubr (&Sread_from_minibuffer);
2603 defsubr (&Seval_minibuffer);
2604 defsubr (&Sread_minibuffer);
2605 defsubr (&Sread_string);
2606 defsubr (&Sread_command);
2607 defsubr (&Sread_variable);
2608 defsubr (&Sread_buffer);
2609 defsubr (&Sread_no_blanks_input);
2610 defsubr (&Sminibuffer_depth);
2611 defsubr (&Sminibuffer_prompt);
2613 defsubr (&Sminibufferp);
2614 defsubr (&Sminibuffer_prompt_end);
2615 defsubr (&Sminibuffer_contents);
2616 defsubr (&Sminibuffer_contents_no_properties);
2617 defsubr (&Sdelete_minibuffer_contents);
2619 defsubr (&Stry_completion);
2620 defsubr (&Sall_completions);
2621 defsubr (&Stest_completion);
2622 defsubr (&Sassoc_string);
2623 defsubr (&Scompleting_read);
2624 defsubr (&Sminibuffer_complete);
2625 defsubr (&Sminibuffer_complete_word);
2626 defsubr (&Sminibuffer_complete_and_exit);
2627 defsubr (&Sdisplay_completion_list);
2628 defsubr (&Sminibuffer_completion_help);
2630 defsubr (&Sself_insert_and_exit);
2631 defsubr (&Sexit_minibuffer);
2633 defsubr (&Sminibuffer_message);
2636 void
2637 keys_of_minibuf ()
2639 initial_define_key (Vminibuffer_local_map, Ctl ('g'),
2640 "abort-recursive-edit");
2641 initial_define_key (Vminibuffer_local_map, Ctl ('m'),
2642 "exit-minibuffer");
2643 initial_define_key (Vminibuffer_local_map, Ctl ('j'),
2644 "exit-minibuffer");
2646 initial_define_key (Vminibuffer_local_ns_map, ' ',
2647 "exit-minibuffer");
2648 initial_define_key (Vminibuffer_local_ns_map, '\t',
2649 "exit-minibuffer");
2650 initial_define_key (Vminibuffer_local_ns_map, '?',
2651 "self-insert-and-exit");
2653 initial_define_key (Vminibuffer_local_completion_map, '\t',
2654 "minibuffer-complete");
2655 initial_define_key (Vminibuffer_local_completion_map, ' ',
2656 "minibuffer-complete-word");
2657 initial_define_key (Vminibuffer_local_completion_map, '?',
2658 "minibuffer-completion-help");
2660 initial_define_key (Vminibuffer_local_must_match_map, Ctl ('m'),
2661 "minibuffer-complete-and-exit");
2662 initial_define_key (Vminibuffer_local_must_match_map, Ctl ('j'),
2663 "minibuffer-complete-and-exit");