* textmodes/picture.el (picture-mouse-set-point): New command.
[emacs.git] / src / minibuf.c
blobbb391d44d7cc700465c525d4dac727fe855aad75
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 DEF, if non-nil, is the default value.
1545 If INHERIT-INPUT-METHOD is non-nil, the minibuffer inherits
1546 the current input method and the setting of `enable-multibyte-characters'.
1548 Completion ignores case if the ambient value of
1549 `completion-ignore-case' is non-nil. */)
1550 (prompt, table, predicate, require_match, initial_input, hist, def, inherit_input_method)
1551 Lisp_Object prompt, table, predicate, require_match, initial_input;
1552 Lisp_Object hist, def, inherit_input_method;
1554 Lisp_Object val, histvar, histpos, position;
1555 Lisp_Object init;
1556 int pos = 0;
1557 int count = SPECPDL_INDEX ();
1558 struct gcpro gcpro1;
1560 init = initial_input;
1561 GCPRO1 (def);
1563 specbind (Qminibuffer_completion_table, table);
1564 specbind (Qminibuffer_completion_predicate, predicate);
1565 specbind (Qminibuffer_completion_confirm,
1566 EQ (require_match, Qt) ? Qnil : require_match);
1567 last_exact_completion = Qnil;
1569 position = Qnil;
1570 if (!NILP (init))
1572 if (CONSP (init))
1574 position = Fcdr (init);
1575 init = Fcar (init);
1577 CHECK_STRING (init);
1578 if (!NILP (position))
1580 CHECK_NUMBER (position);
1581 /* Convert to distance from end of input. */
1582 pos = XINT (position) - SCHARS (init);
1586 if (SYMBOLP (hist))
1588 histvar = hist;
1589 histpos = Qnil;
1591 else
1593 histvar = Fcar_safe (hist);
1594 histpos = Fcdr_safe (hist);
1596 if (NILP (histvar))
1597 histvar = Qminibuffer_history;
1598 if (NILP (histpos))
1599 XSETFASTINT (histpos, 0);
1601 val = read_minibuf (NILP (require_match)
1602 ? Vminibuffer_local_completion_map
1603 : Vminibuffer_local_must_match_map,
1604 init, prompt, make_number (pos), 0,
1605 histvar, histpos, def, 0,
1606 !NILP (inherit_input_method));
1608 if (STRINGP (val) && SCHARS (val) == 0 && ! NILP (def))
1609 val = def;
1611 RETURN_UNGCPRO (unbind_to (count, val));
1614 Lisp_Object Fminibuffer_completion_help ();
1615 Lisp_Object Fassoc_string ();
1617 /* Test whether TXT is an exact completion. */
1618 DEFUN ("test-completion", Ftest_completion, Stest_completion, 2, 3, 0,
1619 doc: /* Return non-nil if STRING is a valid completion.
1620 Takes the same arguments as `all-completions' and `try-completion'.
1621 If ALIST is a function, it is called with three arguments:
1622 the values STRING, PREDICATE and `lambda'. */)
1623 (string, alist, predicate)
1624 Lisp_Object string, alist, predicate;
1626 Lisp_Object regexps, tem = Qnil;
1627 int i = 0;
1629 CHECK_STRING (string);
1631 if ((CONSP (alist) && (!SYMBOLP (XCAR (alist)) || NILP (XCAR (alist))))
1632 || NILP (alist))
1634 tem = Fassoc_string (string, alist, completion_ignore_case ? Qt : Qnil);
1635 if NILP (tem)
1636 return Qnil;
1638 else if (VECTORP (alist))
1640 /* Bypass intern-soft as that loses for nil. */
1641 tem = oblookup (alist,
1642 SDATA (string),
1643 SCHARS (string),
1644 SBYTES (string));
1645 if (!SYMBOLP (tem))
1647 if (STRING_MULTIBYTE (string))
1648 string = Fstring_make_unibyte (string);
1649 else
1650 string = Fstring_make_multibyte (string);
1652 tem = oblookup (Vminibuffer_completion_table,
1653 SDATA (string),
1654 SCHARS (string),
1655 SBYTES (string));
1656 if (!SYMBOLP (tem))
1657 return Qnil;
1660 else if (HASH_TABLE_P (alist))
1662 i = hash_lookup (XHASH_TABLE (alist), string, NULL);
1663 if (i >= 0)
1664 tem = HASH_KEY (XHASH_TABLE (alist), i);
1665 else
1666 return Qnil;
1668 else
1669 return call3 (alist, string, predicate, Qlambda);
1671 /* Reject this element if it fails to match all the regexps. */
1672 for (regexps = Vcompletion_regexp_list; CONSP (regexps);
1673 regexps = XCDR (regexps))
1675 if (NILP (Fstring_match (XCAR (regexps),
1676 SYMBOLP (tem) ? string : tem,
1677 Qnil)))
1678 return Qnil;
1681 /* Finally, check the predicate. */
1682 if (!NILP (predicate))
1683 return HASH_TABLE_P (alist)
1684 ? call2 (predicate, tem, HASH_VALUE (XHASH_TABLE (alist), i))
1685 : call1 (predicate, tem);
1686 else
1687 return Qt;
1690 /* returns:
1691 * 0 no possible completion
1692 * 1 was already an exact and unique completion
1693 * 3 was already an exact completion
1694 * 4 completed to an exact completion
1695 * 5 some completion happened
1696 * 6 no completion happened
1699 do_completion ()
1701 Lisp_Object completion, string, tem;
1702 int completedp;
1703 Lisp_Object last;
1704 struct gcpro gcpro1, gcpro2;
1706 completion = Ftry_completion (minibuffer_completion_contents (),
1707 Vminibuffer_completion_table,
1708 Vminibuffer_completion_predicate);
1709 last = last_exact_completion;
1710 last_exact_completion = Qnil;
1712 GCPRO2 (completion, last);
1714 if (NILP (completion))
1716 bitch_at_user ();
1717 temp_echo_area_glyphs (" [No match]");
1718 UNGCPRO;
1719 return 0;
1722 if (EQ (completion, Qt)) /* exact and unique match */
1724 UNGCPRO;
1725 return 1;
1728 string = minibuffer_completion_contents ();
1730 /* COMPLETEDP should be true if some completion was done, which
1731 doesn't include simply changing the case of the entered string.
1732 However, for appearance, the string is rewritten if the case
1733 changes. */
1734 tem = Fcompare_strings (completion, Qnil, Qnil, string, Qnil, Qnil, Qt);
1735 completedp = !EQ (tem, Qt);
1737 tem = Fcompare_strings (completion, Qnil, Qnil, string, Qnil, Qnil, Qnil);
1738 if (!EQ (tem, Qt))
1739 /* Rewrite the user's input. */
1741 int prompt_end = XINT (Fminibuffer_prompt_end ());
1742 /* Some completion happened */
1744 if (! NILP (Vminibuffer_completing_file_name)
1745 && SREF (completion, SBYTES (completion) - 1) == '/'
1746 && PT < ZV
1747 && FETCH_CHAR (PT_BYTE) == '/')
1749 del_range (prompt_end, PT + 1);
1751 else
1752 del_range (prompt_end, PT);
1754 Finsert (1, &completion);
1756 if (! completedp)
1757 /* The case of the string changed, but that's all. We're not
1758 sure whether this is a unique completion or not, so try again
1759 using the real case (this shouldn't recurse again, because
1760 the next time try-completion will return either `t' or the
1761 exact string). */
1763 UNGCPRO;
1764 return do_completion ();
1768 /* It did find a match. Do we match some possibility exactly now? */
1769 tem = Ftest_completion (Fminibuffer_contents (),
1770 Vminibuffer_completion_table,
1771 Vminibuffer_completion_predicate);
1772 if (NILP (tem))
1774 /* not an exact match */
1775 UNGCPRO;
1776 if (completedp)
1777 return 5;
1778 else if (!NILP (Vcompletion_auto_help))
1779 Fminibuffer_completion_help ();
1780 else
1781 temp_echo_area_glyphs (" [Next char not unique]");
1782 return 6;
1784 else if (completedp)
1786 UNGCPRO;
1787 return 4;
1789 /* If the last exact completion and this one were the same,
1790 it means we've already given a "Complete but not unique"
1791 message and the user's hit TAB again, so now we give him help. */
1792 last_exact_completion = completion;
1793 if (!NILP (last))
1795 tem = minibuffer_completion_contents ();
1796 if (!NILP (Fequal (tem, last)))
1797 Fminibuffer_completion_help ();
1799 UNGCPRO;
1800 return 3;
1803 /* Like assoc but assumes KEY is a string, and ignores case if appropriate. */
1805 DEFUN ("assoc-string", Fassoc_string, Sassoc_string, 2, 3, 0,
1806 doc: /* Like `assoc' but specifically for strings.
1807 Unibyte strings are converted to multibyte for comparison.
1808 And case is ignored if CASE-FOLD is non-nil.
1809 As opposed to `assoc', it will also match an entry consisting of a single
1810 string rather than a cons cell whose car is a string. */)
1811 (key, list, case_fold)
1812 register Lisp_Object key;
1813 Lisp_Object list, case_fold;
1815 register Lisp_Object tail;
1817 for (tail = list; !NILP (tail); tail = Fcdr (tail))
1819 register Lisp_Object elt, tem, thiscar;
1820 elt = Fcar (tail);
1821 thiscar = CONSP (elt) ? XCAR (elt) : elt;
1822 if (!STRINGP (thiscar))
1823 continue;
1824 tem = Fcompare_strings (thiscar, make_number (0), Qnil,
1825 key, make_number (0), Qnil,
1826 case_fold);
1827 if (EQ (tem, Qt))
1828 return elt;
1829 QUIT;
1831 return Qnil;
1834 DEFUN ("minibuffer-complete", Fminibuffer_complete, Sminibuffer_complete, 0, 0, "",
1835 doc: /* Complete the minibuffer contents as far as possible.
1836 Return nil if there is no valid completion, else t.
1837 If no characters can be completed, display a list of possible completions.
1838 If you repeat this command after it displayed such a list,
1839 scroll the window of possible completions. */)
1842 register int i;
1843 Lisp_Object window, tem;
1845 /* If the previous command was not this,
1846 mark the completion buffer obsolete. */
1847 if (! EQ (current_kboard->Vlast_command, Vthis_command))
1848 Vminibuf_scroll_window = Qnil;
1850 window = Vminibuf_scroll_window;
1851 /* If there's a fresh completion window with a live buffer,
1852 and this command is repeated, scroll that window. */
1853 if (! NILP (window) && ! NILP (XWINDOW (window)->buffer)
1854 && !NILP (XBUFFER (XWINDOW (window)->buffer)->name))
1856 struct buffer *obuf = current_buffer;
1858 Fset_buffer (XWINDOW (window)->buffer);
1859 tem = Fpos_visible_in_window_p (make_number (ZV), window, Qnil);
1860 if (! NILP (tem))
1861 /* If end is in view, scroll up to the beginning. */
1862 Fset_window_start (window, make_number (BEGV), Qnil);
1863 else
1864 /* Else scroll down one screen. */
1865 Fscroll_other_window (Qnil);
1867 set_buffer_internal (obuf);
1868 return Qnil;
1871 i = do_completion ();
1872 switch (i)
1874 case 0:
1875 return Qnil;
1877 case 1:
1878 if (PT != ZV)
1879 Fgoto_char (make_number (ZV));
1880 temp_echo_area_glyphs (" [Sole completion]");
1881 break;
1883 case 3:
1884 if (PT != ZV)
1885 Fgoto_char (make_number (ZV));
1886 temp_echo_area_glyphs (" [Complete, but not unique]");
1887 break;
1890 return Qt;
1893 /* Subroutines of Fminibuffer_complete_and_exit. */
1895 /* This one is called by internal_condition_case to do the real work. */
1897 Lisp_Object
1898 complete_and_exit_1 ()
1900 return make_number (do_completion ());
1903 /* This one is called by internal_condition_case if an error happens.
1904 Pretend the current value is an exact match. */
1906 Lisp_Object
1907 complete_and_exit_2 (ignore)
1908 Lisp_Object ignore;
1910 return make_number (1);
1913 DEFUN ("minibuffer-complete-and-exit", Fminibuffer_complete_and_exit,
1914 Sminibuffer_complete_and_exit, 0, 0, "",
1915 doc: /* If the minibuffer contents is a valid completion then exit.
1916 Otherwise try to complete it. If completion leads to a valid completion,
1917 a repetition of this command will exit. */)
1920 register int i;
1921 Lisp_Object val;
1923 /* Allow user to specify null string */
1924 if (XINT (Fminibuffer_prompt_end ()) == ZV)
1925 goto exit;
1927 if (!NILP (Ftest_completion (Fminibuffer_contents (),
1928 Vminibuffer_completion_table,
1929 Vminibuffer_completion_predicate)))
1930 goto exit;
1932 /* Call do_completion, but ignore errors. */
1933 SET_PT (ZV);
1934 val = internal_condition_case (complete_and_exit_1, Qerror,
1935 complete_and_exit_2);
1937 i = XFASTINT (val);
1938 switch (i)
1940 case 1:
1941 case 3:
1942 goto exit;
1944 case 4:
1945 if (!NILP (Vminibuffer_completion_confirm))
1947 temp_echo_area_glyphs (" [Confirm]");
1948 return Qnil;
1950 else
1951 goto exit;
1953 default:
1954 return Qnil;
1956 exit:
1957 return Fthrow (Qexit, Qnil);
1958 /* NOTREACHED */
1961 DEFUN ("minibuffer-complete-word", Fminibuffer_complete_word, Sminibuffer_complete_word,
1962 0, 0, "",
1963 doc: /* Complete the minibuffer contents at most a single word.
1964 After one word is completed as much as possible, a space or hyphen
1965 is added, provided that matches some possible completion.
1966 Return nil if there is no valid completion, else t. */)
1969 Lisp_Object completion, tem, tem1;
1970 register int i, i_byte;
1971 register const unsigned char *completion_string;
1972 struct gcpro gcpro1, gcpro2;
1973 int prompt_end_charpos = XINT (Fminibuffer_prompt_end ());
1975 /* We keep calling Fbuffer_string rather than arrange for GC to
1976 hold onto a pointer to one of the strings thus made. */
1978 completion = Ftry_completion (minibuffer_completion_contents (),
1979 Vminibuffer_completion_table,
1980 Vminibuffer_completion_predicate);
1981 if (NILP (completion))
1983 bitch_at_user ();
1984 temp_echo_area_glyphs (" [No match]");
1985 return Qnil;
1987 if (EQ (completion, Qt))
1988 return Qnil;
1990 #if 0 /* How the below code used to look, for reference. */
1991 tem = Fminibuffer_contents ();
1992 b = SDATA (tem);
1993 i = ZV - 1 - SCHARS (completion);
1994 p = SDATA (completion);
1995 if (i > 0 ||
1996 0 <= scmp (b, p, ZV - 1))
1998 i = 1;
1999 /* Set buffer to longest match of buffer tail and completion head. */
2000 while (0 <= scmp (b + i, p, ZV - 1 - i))
2001 i++;
2002 del_range (1, i + 1);
2003 SET_PT (ZV);
2005 #else /* Rewritten code */
2007 int buffer_nchars, completion_nchars;
2009 CHECK_STRING (completion);
2010 tem = minibuffer_completion_contents ();
2011 GCPRO2 (completion, tem);
2012 /* If reading a file name,
2013 expand any $ENVVAR refs in the buffer and in TEM. */
2014 if (! NILP (Vminibuffer_completing_file_name))
2016 Lisp_Object substituted;
2017 substituted = Fsubstitute_in_file_name (tem);
2018 if (! EQ (substituted, tem))
2020 tem = substituted;
2021 del_range (prompt_end_charpos, PT);
2022 Finsert (1, &tem);
2025 buffer_nchars = SCHARS (tem); /* # chars in what we completed. */
2026 completion_nchars = SCHARS (completion);
2027 i = buffer_nchars - completion_nchars;
2028 if (i > 0
2030 (tem1 = Fcompare_strings (tem, make_number (0),
2031 make_number (buffer_nchars),
2032 completion, make_number (0),
2033 make_number (buffer_nchars),
2034 completion_ignore_case ? Qt : Qnil),
2035 ! EQ (tem1, Qt)))
2037 int start_pos;
2039 /* Make buffer (before point) contain the longest match
2040 of TEM's tail and COMPLETION's head. */
2041 if (i <= 0) i = 1;
2042 start_pos= i;
2043 buffer_nchars -= i;
2044 while (i > 0)
2046 tem1 = Fcompare_strings (tem, make_number (start_pos), Qnil,
2047 completion, make_number (0),
2048 make_number (buffer_nchars),
2049 completion_ignore_case ? Qt : Qnil);
2050 start_pos++;
2051 if (EQ (tem1, Qt))
2052 break;
2053 i++;
2054 buffer_nchars--;
2056 del_range (1, i + 1);
2058 UNGCPRO;
2060 #endif /* Rewritten code */
2063 int prompt_end_bytepos;
2064 prompt_end_bytepos = CHAR_TO_BYTE (prompt_end_charpos);
2065 i = PT - prompt_end_charpos;
2066 i_byte = PT_BYTE - prompt_end_bytepos;
2069 /* If completion finds next char not unique,
2070 consider adding a space or a hyphen. */
2071 if (i == SCHARS (completion))
2073 GCPRO1 (completion);
2074 tem = Ftry_completion (concat2 (minibuffer_completion_contents (),
2075 build_string (" ")),
2076 Vminibuffer_completion_table,
2077 Vminibuffer_completion_predicate);
2078 UNGCPRO;
2080 if (STRINGP (tem))
2081 completion = tem;
2082 else
2084 GCPRO1 (completion);
2085 tem =
2086 Ftry_completion (concat2 (minibuffer_completion_contents (),
2087 build_string ("-")),
2088 Vminibuffer_completion_table,
2089 Vminibuffer_completion_predicate);
2090 UNGCPRO;
2092 if (STRINGP (tem))
2093 completion = tem;
2097 /* Now find first word-break in the stuff found by completion.
2098 i gets index in string of where to stop completing. */
2100 int len, c;
2101 int bytes = SBYTES (completion);
2102 completion_string = SDATA (completion);
2103 for (; i_byte < SBYTES (completion); i_byte += len, i++)
2105 c = STRING_CHAR_AND_LENGTH (completion_string + i_byte,
2106 bytes - i_byte,
2107 len);
2108 if (SYNTAX (c) != Sword)
2110 i_byte += len;
2111 i++;
2112 break;
2117 /* If got no characters, print help for user. */
2119 if (i == PT - prompt_end_charpos)
2121 if (!NILP (Vcompletion_auto_help))
2122 Fminibuffer_completion_help ();
2123 return Qnil;
2126 /* Otherwise insert in minibuffer the chars we got */
2128 if (! NILP (Vminibuffer_completing_file_name)
2129 && SREF (completion, SBYTES (completion) - 1) == '/'
2130 && PT < ZV
2131 && FETCH_CHAR (PT_BYTE) == '/')
2133 del_range (prompt_end_charpos, PT + 1);
2135 else
2136 del_range (prompt_end_charpos, PT);
2138 insert_from_string (completion, 0, 0, i, i_byte, 1);
2139 return Qt;
2142 DEFUN ("display-completion-list", Fdisplay_completion_list, Sdisplay_completion_list,
2143 1, 1, 0,
2144 doc: /* Display the list of completions, COMPLETIONS, using `standard-output'.
2145 Each element may be just a symbol or string
2146 or may be a list of two strings to be printed as if concatenated.
2147 `standard-output' must be a buffer.
2148 The actual completion alternatives, as inserted, are given `mouse-face'
2149 properties of `highlight'.
2150 At the end, this runs the normal hook `completion-setup-hook'.
2151 It can find the completion buffer in `standard-output'. */)
2152 (completions)
2153 Lisp_Object completions;
2155 Lisp_Object tail, elt;
2156 register int i;
2157 int column = 0;
2158 struct gcpro gcpro1, gcpro2;
2159 struct buffer *old = current_buffer;
2160 int first = 1;
2162 /* Note that (when it matters) every variable
2163 points to a non-string that is pointed to by COMPLETIONS,
2164 except for ELT. ELT can be pointing to a string
2165 when terpri or Findent_to calls a change hook. */
2166 elt = Qnil;
2167 GCPRO2 (completions, elt);
2169 if (BUFFERP (Vstandard_output))
2170 set_buffer_internal (XBUFFER (Vstandard_output));
2172 if (NILP (completions))
2173 write_string ("There are no possible completions of what you have typed.",
2174 -1);
2175 else
2177 write_string ("Possible completions are:", -1);
2178 for (tail = completions, i = 0; !NILP (tail); tail = Fcdr (tail), i++)
2180 Lisp_Object tem, string;
2181 int length;
2182 Lisp_Object startpos, endpos;
2184 startpos = Qnil;
2186 elt = Fcar (tail);
2187 /* Compute the length of this element. */
2188 if (CONSP (elt))
2190 tem = XCAR (elt);
2191 CHECK_STRING (tem);
2192 length = SCHARS (tem);
2194 tem = Fcar (XCDR (elt));
2195 CHECK_STRING (tem);
2196 length += SCHARS (tem);
2198 else
2200 CHECK_STRING (elt);
2201 length = SCHARS (elt);
2204 /* This does a bad job for narrower than usual windows.
2205 Sadly, the window it will appear in is not known
2206 until after the text has been made. */
2208 if (BUFFERP (Vstandard_output))
2209 XSETINT (startpos, BUF_PT (XBUFFER (Vstandard_output)));
2211 /* If the previous completion was very wide,
2212 or we have two on this line already,
2213 don't put another on the same line. */
2214 if (column > 33 || first
2215 /* If this is really wide, don't put it second on a line. */
2216 || (column > 0 && length > 45))
2218 Fterpri (Qnil);
2219 column = 0;
2221 /* Otherwise advance to column 35. */
2222 else
2224 if (BUFFERP (Vstandard_output))
2226 tem = Findent_to (make_number (35), make_number (2));
2228 column = XINT (tem);
2230 else
2234 write_string (" ", -1);
2235 column++;
2237 while (column < 35);
2241 if (BUFFERP (Vstandard_output))
2243 XSETINT (endpos, BUF_PT (XBUFFER (Vstandard_output)));
2244 Fset_text_properties (startpos, endpos,
2245 Qnil, Vstandard_output);
2248 /* Output this element.
2249 If necessary, convert it to unibyte or to multibyte first. */
2250 if (CONSP (elt))
2251 string = Fcar (elt);
2252 else
2253 string = elt;
2254 if (NILP (current_buffer->enable_multibyte_characters)
2255 && STRING_MULTIBYTE (string))
2256 string = Fstring_make_unibyte (string);
2257 else if (!NILP (current_buffer->enable_multibyte_characters)
2258 && !STRING_MULTIBYTE (string))
2259 string = Fstring_make_multibyte (string);
2261 if (BUFFERP (Vstandard_output))
2263 XSETINT (startpos, BUF_PT (XBUFFER (Vstandard_output)));
2265 Fprinc (string, Qnil);
2267 XSETINT (endpos, BUF_PT (XBUFFER (Vstandard_output)));
2269 Fput_text_property (startpos, endpos,
2270 Qmouse_face, intern ("highlight"),
2271 Vstandard_output);
2273 else
2275 Fprinc (string, Qnil);
2278 /* Output the annotation for this element. */
2279 if (CONSP (elt))
2281 if (BUFFERP (Vstandard_output))
2283 XSETINT (startpos, BUF_PT (XBUFFER (Vstandard_output)));
2285 Fprinc (Fcar (Fcdr (elt)), Qnil);
2287 XSETINT (endpos, BUF_PT (XBUFFER (Vstandard_output)));
2289 Fset_text_properties (startpos, endpos, Qnil,
2290 Vstandard_output);
2292 else
2294 Fprinc (Fcar (Fcdr (elt)), Qnil);
2299 /* Update COLUMN for what we have output. */
2300 column += length;
2302 /* If output is to a buffer, recompute COLUMN in a way
2303 that takes account of character widths. */
2304 if (BUFFERP (Vstandard_output))
2306 tem = Fcurrent_column ();
2307 column = XINT (tem);
2310 first = 0;
2314 UNGCPRO;
2316 if (BUFFERP (Vstandard_output))
2317 set_buffer_internal (old);
2319 if (!NILP (Vrun_hooks))
2320 call1 (Vrun_hooks, intern ("completion-setup-hook"));
2322 return Qnil;
2325 DEFUN ("minibuffer-completion-help", Fminibuffer_completion_help, Sminibuffer_completion_help,
2326 0, 0, "",
2327 doc: /* Display a list of possible completions of the current minibuffer contents. */)
2330 Lisp_Object completions;
2332 message ("Making completion list...");
2333 completions = Fall_completions (minibuffer_completion_contents (),
2334 Vminibuffer_completion_table,
2335 Vminibuffer_completion_predicate,
2336 Qt);
2337 clear_message (1, 0);
2339 if (NILP (completions))
2341 bitch_at_user ();
2342 temp_echo_area_glyphs (" [No completions]");
2344 else
2345 internal_with_output_to_temp_buffer ("*Completions*",
2346 Fdisplay_completion_list,
2347 Fsort (completions, Qstring_lessp));
2348 return Qnil;
2351 DEFUN ("self-insert-and-exit", Fself_insert_and_exit, Sself_insert_and_exit, 0, 0, "",
2352 doc: /* Terminate minibuffer input. */)
2355 if (INTEGERP (last_command_char))
2356 internal_self_insert (XINT (last_command_char), 0);
2357 else
2358 bitch_at_user ();
2360 return Fthrow (Qexit, Qnil);
2363 DEFUN ("exit-minibuffer", Fexit_minibuffer, Sexit_minibuffer, 0, 0, "",
2364 doc: /* Terminate this minibuffer argument. */)
2367 return Fthrow (Qexit, Qnil);
2370 DEFUN ("minibuffer-depth", Fminibuffer_depth, Sminibuffer_depth, 0, 0, 0,
2371 doc: /* Return current depth of activations of minibuffer, a nonnegative integer. */)
2374 return make_number (minibuf_level);
2377 DEFUN ("minibuffer-prompt", Fminibuffer_prompt, Sminibuffer_prompt, 0, 0, 0,
2378 doc: /* Return the prompt string of the currently-active minibuffer.
2379 If no minibuffer is active, return nil. */)
2382 return Fcopy_sequence (minibuf_prompt);
2386 /* Temporarily display the string M at the end of the current
2387 minibuffer contents. This is used to display things like
2388 "[No Match]" when the user requests a completion for a prefix
2389 that has no possible completions, and other quick, unobtrusive
2390 messages. */
2392 void
2393 temp_echo_area_glyphs (m)
2394 const char *m;
2396 int osize = ZV;
2397 int osize_byte = ZV_BYTE;
2398 int opoint = PT;
2399 int opoint_byte = PT_BYTE;
2400 Lisp_Object oinhibit;
2401 oinhibit = Vinhibit_quit;
2403 /* Clear out any old echo-area message to make way for our new thing. */
2404 message (0);
2406 SET_PT_BOTH (osize, osize_byte);
2407 insert_string (m);
2408 SET_PT_BOTH (opoint, opoint_byte);
2409 Vinhibit_quit = Qt;
2410 Fsit_for (make_number (2), Qnil, Qnil);
2411 del_range_both (osize, osize_byte, ZV, ZV_BYTE, 1);
2412 SET_PT_BOTH (opoint, opoint_byte);
2413 if (!NILP (Vquit_flag))
2415 Vquit_flag = Qnil;
2416 Vunread_command_events = Fcons (make_number (quit_char), Qnil);
2418 Vinhibit_quit = oinhibit;
2421 DEFUN ("minibuffer-message", Fminibuffer_message, Sminibuffer_message,
2422 1, 1, 0,
2423 doc: /* Temporarily display STRING at the end of the minibuffer.
2424 The text is displayed for two seconds,
2425 or until the next input event arrives, whichever comes first. */)
2426 (string)
2427 Lisp_Object string;
2429 temp_echo_area_glyphs (SDATA (string));
2430 return Qnil;
2433 void
2434 init_minibuf_once ()
2436 Vminibuffer_list = Qnil;
2437 staticpro (&Vminibuffer_list);
2440 void
2441 syms_of_minibuf ()
2443 minibuf_level = 0;
2444 minibuf_prompt = Qnil;
2445 staticpro (&minibuf_prompt);
2447 minibuf_save_list = Qnil;
2448 staticpro (&minibuf_save_list);
2450 Qread_file_name_internal = intern ("read-file-name-internal");
2451 staticpro (&Qread_file_name_internal);
2453 Qminibuffer_default = intern ("minibuffer-default");
2454 staticpro (&Qminibuffer_default);
2455 Fset (Qminibuffer_default, Qnil);
2457 Qminibuffer_completion_table = intern ("minibuffer-completion-table");
2458 staticpro (&Qminibuffer_completion_table);
2460 Qminibuffer_completion_confirm = intern ("minibuffer-completion-confirm");
2461 staticpro (&Qminibuffer_completion_confirm);
2463 Qminibuffer_completion_predicate = intern ("minibuffer-completion-predicate");
2464 staticpro (&Qminibuffer_completion_predicate);
2466 staticpro (&last_exact_completion);
2467 last_exact_completion = Qnil;
2469 staticpro (&last_minibuf_string);
2470 last_minibuf_string = Qnil;
2472 Quser_variable_p = intern ("user-variable-p");
2473 staticpro (&Quser_variable_p);
2475 Qminibuffer_history = intern ("minibuffer-history");
2476 staticpro (&Qminibuffer_history);
2478 Qbuffer_name_history = intern ("buffer-name-history");
2479 staticpro (&Qbuffer_name_history);
2480 Fset (Qbuffer_name_history, Qnil);
2482 Qminibuffer_setup_hook = intern ("minibuffer-setup-hook");
2483 staticpro (&Qminibuffer_setup_hook);
2485 Qminibuffer_exit_hook = intern ("minibuffer-exit-hook");
2486 staticpro (&Qminibuffer_exit_hook);
2488 Qhistory_length = intern ("history-length");
2489 staticpro (&Qhistory_length);
2491 Qcurrent_input_method = intern ("current-input-method");
2492 staticpro (&Qcurrent_input_method);
2494 Qactivate_input_method = intern ("activate-input-method");
2495 staticpro (&Qactivate_input_method);
2497 DEFVAR_LISP ("read-buffer-function", &Vread_buffer_function,
2498 doc: /* If this is non-nil, `read-buffer' does its work by calling this function. */);
2499 Vread_buffer_function = Qnil;
2501 DEFVAR_LISP ("minibuffer-setup-hook", &Vminibuffer_setup_hook,
2502 doc: /* Normal hook run just after entry to minibuffer. */);
2503 Vminibuffer_setup_hook = Qnil;
2505 DEFVAR_LISP ("minibuffer-exit-hook", &Vminibuffer_exit_hook,
2506 doc: /* Normal hook run just after exit from minibuffer. */);
2507 Vminibuffer_exit_hook = Qnil;
2509 DEFVAR_LISP ("history-length", &Vhistory_length,
2510 doc: /* *Maximum length for history lists before truncation takes place.
2511 A number means that length; t means infinite. Truncation takes place
2512 just after a new element is inserted. Setting the history-length
2513 property of a history variable overrides this default. */);
2514 XSETFASTINT (Vhistory_length, 30);
2516 DEFVAR_LISP ("completion-auto-help", &Vcompletion_auto_help,
2517 doc: /* *Non-nil means automatically provide help for invalid completion input. */);
2518 Vcompletion_auto_help = Qt;
2520 DEFVAR_BOOL ("completion-ignore-case", &completion_ignore_case,
2521 doc: /* Non-nil means don't consider case significant in completion. */);
2522 completion_ignore_case = 0;
2524 DEFVAR_BOOL ("enable-recursive-minibuffers", &enable_recursive_minibuffers,
2525 doc: /* *Non-nil means to allow minibuffer commands while in the minibuffer.
2526 This variable makes a difference whenever the minibuffer window is active. */);
2527 enable_recursive_minibuffers = 0;
2529 DEFVAR_LISP ("minibuffer-completion-table", &Vminibuffer_completion_table,
2530 doc: /* Alist or obarray used for completion in the minibuffer.
2531 This becomes the ALIST argument to `try-completion' and `all-completion'.
2533 The value may alternatively be a function, which is given three arguments:
2534 STRING, the current buffer contents;
2535 PREDICATE, the predicate for filtering possible matches;
2536 CODE, which says what kind of things to do.
2537 CODE can be nil, t or `lambda'.
2538 nil means to return the best completion of STRING, or nil if there is none.
2539 t means to return a list of all possible completions of STRING.
2540 `lambda' means to return t if STRING is a valid completion as it stands. */);
2541 Vminibuffer_completion_table = Qnil;
2543 DEFVAR_LISP ("minibuffer-completion-predicate", &Vminibuffer_completion_predicate,
2544 doc: /* Within call to `completing-read', this holds the PREDICATE argument. */);
2545 Vminibuffer_completion_predicate = Qnil;
2547 DEFVAR_LISP ("minibuffer-completion-confirm", &Vminibuffer_completion_confirm,
2548 doc: /* Non-nil means to demand confirmation of completion before exiting minibuffer. */);
2549 Vminibuffer_completion_confirm = Qnil;
2551 DEFVAR_LISP ("minibuffer-completing-file-name",
2552 &Vminibuffer_completing_file_name,
2553 doc: /* Non-nil means completing file names. */);
2554 Vminibuffer_completing_file_name = Qnil;
2556 DEFVAR_LISP ("minibuffer-help-form", &Vminibuffer_help_form,
2557 doc: /* Value that `help-form' takes on inside the minibuffer. */);
2558 Vminibuffer_help_form = Qnil;
2560 DEFVAR_LISP ("minibuffer-history-variable", &Vminibuffer_history_variable,
2561 doc: /* History list symbol to add minibuffer values to.
2562 Each string of minibuffer input, as it appears on exit from the minibuffer,
2563 is added with
2564 (set minibuffer-history-variable
2565 (cons STRING (symbol-value minibuffer-history-variable))) */);
2566 XSETFASTINT (Vminibuffer_history_variable, 0);
2568 DEFVAR_LISP ("minibuffer-history-position", &Vminibuffer_history_position,
2569 doc: /* Current position of redoing in the history list. */);
2570 Vminibuffer_history_position = Qnil;
2572 DEFVAR_BOOL ("minibuffer-auto-raise", &minibuffer_auto_raise,
2573 doc: /* *Non-nil means entering the minibuffer raises the minibuffer's frame.
2574 Some uses of the echo area also raise that frame (since they use it too). */);
2575 minibuffer_auto_raise = 0;
2577 DEFVAR_LISP ("completion-regexp-list", &Vcompletion_regexp_list,
2578 doc: /* List of regexps that should restrict possible completions. */);
2579 Vcompletion_regexp_list = Qnil;
2581 DEFVAR_BOOL ("minibuffer-allow-text-properties",
2582 &minibuffer_allow_text_properties,
2583 doc: /* Non-nil means `read-from-minibuffer' should not discard text properties.
2584 This also affects `read-string', but it does not affect `read-minibuffer',
2585 `read-no-blanks-input', or any of the functions that do minibuffer input
2586 with completion; they always discard text properties. */);
2587 minibuffer_allow_text_properties = 0;
2589 DEFVAR_LISP ("minibuffer-prompt-properties", &Vminibuffer_prompt_properties,
2590 doc: /* Text properties that are added to minibuffer prompts.
2591 These are in addition to the basic `field' property, and stickiness
2592 properties. */);
2593 /* We use `intern' here instead of Qread_only to avoid
2594 initialization-order problems. */
2595 Vminibuffer_prompt_properties
2596 = Fcons (intern ("read-only"), Fcons (Qt, Qnil));
2598 defsubr (&Sset_minibuffer_window);
2599 defsubr (&Sread_from_minibuffer);
2600 defsubr (&Seval_minibuffer);
2601 defsubr (&Sread_minibuffer);
2602 defsubr (&Sread_string);
2603 defsubr (&Sread_command);
2604 defsubr (&Sread_variable);
2605 defsubr (&Sread_buffer);
2606 defsubr (&Sread_no_blanks_input);
2607 defsubr (&Sminibuffer_depth);
2608 defsubr (&Sminibuffer_prompt);
2610 defsubr (&Sminibufferp);
2611 defsubr (&Sminibuffer_prompt_end);
2612 defsubr (&Sminibuffer_contents);
2613 defsubr (&Sminibuffer_contents_no_properties);
2614 defsubr (&Sdelete_minibuffer_contents);
2616 defsubr (&Stry_completion);
2617 defsubr (&Sall_completions);
2618 defsubr (&Stest_completion);
2619 defsubr (&Sassoc_string);
2620 defsubr (&Scompleting_read);
2621 defsubr (&Sminibuffer_complete);
2622 defsubr (&Sminibuffer_complete_word);
2623 defsubr (&Sminibuffer_complete_and_exit);
2624 defsubr (&Sdisplay_completion_list);
2625 defsubr (&Sminibuffer_completion_help);
2627 defsubr (&Sself_insert_and_exit);
2628 defsubr (&Sexit_minibuffer);
2630 defsubr (&Sminibuffer_message);
2633 void
2634 keys_of_minibuf ()
2636 initial_define_key (Vminibuffer_local_map, Ctl ('g'),
2637 "abort-recursive-edit");
2638 initial_define_key (Vminibuffer_local_map, Ctl ('m'),
2639 "exit-minibuffer");
2640 initial_define_key (Vminibuffer_local_map, Ctl ('j'),
2641 "exit-minibuffer");
2643 initial_define_key (Vminibuffer_local_ns_map, ' ',
2644 "exit-minibuffer");
2645 initial_define_key (Vminibuffer_local_ns_map, '\t',
2646 "exit-minibuffer");
2647 initial_define_key (Vminibuffer_local_ns_map, '?',
2648 "self-insert-and-exit");
2650 initial_define_key (Vminibuffer_local_completion_map, '\t',
2651 "minibuffer-complete");
2652 initial_define_key (Vminibuffer_local_completion_map, ' ',
2653 "minibuffer-complete-word");
2654 initial_define_key (Vminibuffer_local_completion_map, '?',
2655 "minibuffer-completion-help");
2657 initial_define_key (Vminibuffer_local_must_match_map, Ctl ('m'),
2658 "minibuffer-complete-and-exit");
2659 initial_define_key (Vminibuffer_local_must_match_map, Ctl ('j'),
2660 "minibuffer-complete-and-exit");