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)
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. */
30 #include "dispextern.h"
35 #include "intervals.h"
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. */
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
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
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. */
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
);
152 /* I don't think that any frames may validly have a null minibuffer
154 if (NILP (sf
->minibuffer_window
))
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
));
182 choose_minibuf_frame_1 (ignore
)
185 choose_minibuf_frame ();
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. */)
197 CHECK_WINDOW (window
);
198 if (! MINI_WINDOW_P (XWINDOW (window
)))
199 error ("Window is not a minibuffer window");
201 minibuf_window
= 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
,
213 Lisp_Object
, Lisp_Object
,
215 static Lisp_Object read_minibuf_noninteractive
P_ ((Lisp_Object
, Lisp_Object
,
216 Lisp_Object
, Lisp_Object
,
218 Lisp_Object
, Lisp_Object
,
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. */
227 string_to_object (val
, defalt
)
228 Lisp_Object val
, defalt
;
230 struct gcpro gcpro1
, gcpro2
;
231 Lisp_Object expr_and_pos
;
234 GCPRO2 (val
, defalt
);
236 if (STRINGP (val
) && SCHARS (val
) == 0
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
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. */
265 read_minibuf_noninteractive (map
, initial
, prompt
, backup_n
, expflag
,
266 histvar
, histpos
, defalt
, allow_props
,
267 inherit_input_method
)
271 Lisp_Object backup_n
;
277 int inherit_input_method
;
283 fprintf (stdout
, "%s", SDATA (prompt
));
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'))
295 line
= (char *) xrealloc (line
, size
);
302 if (len
> 0 && line
[len
- 1] == '\n')
305 val
= build_string (line
);
311 error ("Error reading from stdin");
314 /* If Lisp form desired instead of string, parse it. */
316 val
= string_to_object (val
, defalt
);
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.*/)
331 buffer
= Fcurrent_buffer ();
332 else if (STRINGP (buffer
))
333 buffer
= Fget_buffer (buffer
);
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
);
355 end
= Ffield_end (beg
, Qnil
, Qnil
);
357 if (XINT (end
) == ZV
&& NILP (Fget_char_property (beg
, Qfield
, Qnil
)))
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 ());
391 del_range (prompt_end
, ZV
);
395 /* Get the text in the minibuffer before point.
396 That is what completion commands operate on. */
399 minibuffer_completion_contents ()
401 int prompt_end
= XINT (Fminibuffer_prompt_end ());
403 error ("Cannot do completion in the prompt");
404 return make_buffer_string (prompt_end
, PT
, 1);
407 /* Read from the minibuffer using keymap MAP, initial contents INITIAL
408 (a string), putting point minus BACKUP_N bytes from the end of INITIAL,
409 prompting with PROMPT (a string), using history list HISTVAR
410 with initial position HISTPOS. (BACKUP_N should be <= 0.)
412 Normally return the result as a string (the text that was read),
413 but if EXPFLAG is nonzero, read it and return the object read.
414 If HISTVAR is given, save the value read on that history only if it doesn't
415 match the front of that history list exactly. The value is pushed onto
416 the list as the string that was read.
418 DEFALT specifies te default value for the sake of history commands.
420 If ALLOW_PROPS is nonzero, we do not throw away text properties.
422 if INHERIT_INPUT_METHOD is nonzeor, the minibuffer inherit the
423 current input method. */
426 read_minibuf (map
, initial
, prompt
, backup_n
, expflag
,
427 histvar
, histpos
, defalt
, allow_props
, inherit_input_method
)
431 Lisp_Object backup_n
;
437 int inherit_input_method
;
440 int count
= SPECPDL_INDEX ();
441 Lisp_Object mini_frame
, ambient_dir
, minibuffer
, input_method
;
442 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
443 Lisp_Object enable_multibyte
;
444 extern Lisp_Object Qfront_sticky
;
445 extern Lisp_Object Qrear_nonsticky
;
447 specbind (Qminibuffer_default
, defalt
);
449 single_kboard_state ();
450 #ifdef HAVE_X_WINDOWS
451 if (display_hourglass_p
)
456 ambient_dir
= current_buffer
->directory
;
458 enable_multibyte
= Qnil
;
460 /* Don't need to protect PROMPT, HISTVAR, and HISTPOS because we
461 store them away before we can GC. Don't need to protect
462 BACKUP_N because we use the value only if it is an integer. */
463 GCPRO5 (map
, initial
, val
, ambient_dir
, input_method
);
465 if (!STRINGP (prompt
))
466 prompt
= empty_string
;
468 if (!enable_recursive_minibuffers
469 && minibuf_level
> 0)
471 if (EQ (selected_window
, minibuf_window
))
472 error ("Command attempted to use minibuffer while in minibuffer");
474 /* If we're in another window, cancel the minibuffer that's active. */
476 build_string ("Command attempted to use minibuffer while in minibuffer"));
481 val
= read_minibuf_noninteractive (map
, initial
, prompt
, backup_n
,
482 expflag
, histvar
, histpos
, defalt
,
483 allow_props
, inherit_input_method
);
484 return unbind_to (count
, val
);
487 /* Choose the minibuffer window and frame, and take action on them. */
489 choose_minibuf_frame ();
491 record_unwind_protect (choose_minibuf_frame_1
, Qnil
);
493 record_unwind_protect (Fset_window_configuration
,
494 Fcurrent_window_configuration (Qnil
));
496 /* If the minibuffer window is on a different frame, save that
497 frame's configuration too. */
498 mini_frame
= WINDOW_FRAME (XWINDOW (minibuf_window
));
499 if (!EQ (mini_frame
, selected_frame
))
500 record_unwind_protect (Fset_window_configuration
,
501 Fcurrent_window_configuration (mini_frame
));
503 /* If the minibuffer is on an iconified or invisible frame,
504 make it visible now. */
505 Fmake_frame_visible (mini_frame
);
507 if (minibuffer_auto_raise
)
508 Fraise_frame (mini_frame
);
510 /* We have to do this after saving the window configuration
511 since that is what restores the current buffer. */
513 /* Arrange to restore a number of minibuffer-related variables.
514 We could bind each variable separately, but that would use lots of
517 = Fcons (Voverriding_local_map
,
518 Fcons (minibuf_window
, minibuf_save_list
));
520 = Fcons (minibuf_prompt
,
521 Fcons (make_number (minibuf_prompt_width
),
523 Fcons (Vcurrent_prefix_arg
,
524 Fcons (Vminibuffer_history_position
,
525 Fcons (Vminibuffer_history_variable
,
526 minibuf_save_list
))))));
528 record_unwind_protect (read_minibuf_unwind
, Qnil
);
531 /* Now that we can restore all those variables, start changing them. */
533 minibuf_prompt_width
= 0;
534 minibuf_prompt
= Fcopy_sequence (prompt
);
535 Vminibuffer_history_position
= histpos
;
536 Vminibuffer_history_variable
= histvar
;
537 Vhelp_form
= Vminibuffer_help_form
;
539 if (inherit_input_method
)
541 /* `current-input-method' is buffer local. So, remember it in
542 INPUT_METHOD before changing the current buffer. */
543 input_method
= Fsymbol_value (Qcurrent_input_method
);
544 enable_multibyte
= current_buffer
->enable_multibyte_characters
;
547 /* Switch to the minibuffer. */
549 minibuffer
= get_minibuffer (minibuf_level
);
550 Fset_buffer (minibuffer
);
552 /* The current buffer's default directory is usually the right thing
553 for our minibuffer here. However, if you're typing a command at
554 a minibuffer-only frame when minibuf_level is zero, then buf IS
555 the current_buffer, so reset_buffer leaves buf's default
556 directory unchanged. This is a bummer when you've just started
557 up Emacs and buf's default directory is Qnil. Here's a hack; can
558 you think of something better to do? Find another buffer with a
559 better directory, and use that one instead. */
560 if (STRINGP (ambient_dir
))
561 current_buffer
->directory
= ambient_dir
;
564 Lisp_Object buf_list
;
566 for (buf_list
= Vbuffer_alist
;
568 buf_list
= XCDR (buf_list
))
570 Lisp_Object other_buf
;
572 other_buf
= XCDR (XCAR (buf_list
));
573 if (STRINGP (XBUFFER (other_buf
)->directory
))
575 current_buffer
->directory
= XBUFFER (other_buf
)->directory
;
581 if (!EQ (mini_frame
, selected_frame
))
582 Fredirect_frame_focus (selected_frame
, mini_frame
);
584 Vminibuf_scroll_window
= selected_window
;
585 if (minibuf_level
== 1 || !EQ (minibuf_window
, selected_window
))
586 minibuf_selected_window
= selected_window
;
587 Fset_window_buffer (minibuf_window
, Fcurrent_buffer ());
588 Fselect_window (minibuf_window
);
589 XSETFASTINT (XWINDOW (minibuf_window
)->hscroll
, 0);
591 Fmake_local_variable (Qprint_escape_newlines
);
592 print_escape_newlines
= 1;
594 /* Erase the buffer. */
596 int count1
= SPECPDL_INDEX ();
597 specbind (Qinhibit_read_only
, Qt
);
598 specbind (Qinhibit_modification_hooks
, Qt
);
600 unbind_to (count1
, Qnil
);
603 if (!NILP (current_buffer
->enable_multibyte_characters
)
604 && ! STRING_MULTIBYTE (minibuf_prompt
))
605 minibuf_prompt
= Fstring_make_multibyte (minibuf_prompt
);
607 /* Insert the prompt, record where it ends. */
608 Finsert (1, &minibuf_prompt
);
611 Fput_text_property (make_number (BEG
), make_number (PT
),
612 Qfront_sticky
, Qt
, Qnil
);
613 Fput_text_property (make_number (BEG
), make_number (PT
),
614 Qrear_nonsticky
, Qt
, Qnil
);
615 Fput_text_property (make_number (BEG
), make_number (PT
),
617 Fadd_text_properties (make_number (BEG
), make_number (PT
),
618 Vminibuffer_prompt_properties
, Qnil
);
621 minibuf_prompt_width
= (int) current_column (); /* iftc */
623 /* If appropriate, copy enable-multibyte-characters into the minibuffer. */
624 if (inherit_input_method
)
625 current_buffer
->enable_multibyte_characters
= enable_multibyte
;
627 /* Put in the initial input. */
630 Finsert (1, &initial
);
631 if (INTEGERP (backup_n
))
632 Fforward_char (backup_n
);
635 clear_message (1, 1);
636 current_buffer
->keymap
= map
;
638 /* Turn on an input method stored in INPUT_METHOD if any. */
639 if (STRINGP (input_method
) && !NILP (Ffboundp (Qactivate_input_method
)))
640 call1 (Qactivate_input_method
, input_method
);
642 /* Run our hook, but not if it is empty.
643 (run-hooks would do nothing if it is empty,
644 but it's important to save time here in the usual case.) */
645 if (!NILP (Vminibuffer_setup_hook
) && !EQ (Vminibuffer_setup_hook
, Qunbound
)
646 && !NILP (Vrun_hooks
))
647 call1 (Vrun_hooks
, Qminibuffer_setup_hook
);
649 /* Don't allow the user to undo past this point. */
650 current_buffer
->undo_list
= Qnil
;
654 /* If cursor is on the minibuffer line,
655 show the user we have exited by putting it in column 0. */
656 if (XWINDOW (minibuf_window
)->cursor
.vpos
>= 0
659 XWINDOW (minibuf_window
)->cursor
.hpos
= 0;
660 XWINDOW (minibuf_window
)->cursor
.x
= 0;
661 XWINDOW (minibuf_window
)->must_be_updated_p
= 1;
662 update_frame (XFRAME (selected_frame
), 1, 1);
663 if (rif
&& rif
->flush_display
)
664 rif
->flush_display (XFRAME (XWINDOW (minibuf_window
)->frame
));
667 /* Make minibuffer contents into a string. */
668 Fset_buffer (minibuffer
);
670 val
= Fminibuffer_contents ();
672 val
= Fminibuffer_contents_no_properties ();
674 /* VAL is the string of minibuffer text. */
676 last_minibuf_string
= val
;
678 /* Add the value to the appropriate history list unless it is empty. */
679 if (SCHARS (val
) != 0
680 && SYMBOLP (Vminibuffer_history_variable
))
682 /* If the caller wanted to save the value read on a history list,
683 then do so if the value is not already the front of the list. */
686 /* If variable is unbound, make it nil. */
687 if (EQ (SYMBOL_VALUE (Vminibuffer_history_variable
), Qunbound
))
688 Fset (Vminibuffer_history_variable
, Qnil
);
690 histval
= Fsymbol_value (Vminibuffer_history_variable
);
692 /* The value of the history variable must be a cons or nil. Other
693 values are unacceptable. We silently ignore these values. */
696 && NILP (Fequal (last_minibuf_string
, Fcar (histval
)))))
700 histval
= Fcons (last_minibuf_string
, histval
);
701 Fset (Vminibuffer_history_variable
, histval
);
703 /* Truncate if requested. */
704 length
= Fget (Vminibuffer_history_variable
, Qhistory_length
);
705 if (NILP (length
)) length
= Vhistory_length
;
706 if (INTEGERP (length
))
708 if (XINT (length
) <= 0)
709 Fset (Vminibuffer_history_variable
, Qnil
);
714 temp
= Fnthcdr (Fsub1 (length
), histval
);
715 if (CONSP (temp
)) Fsetcdr (temp
, Qnil
);
721 /* If Lisp form desired instead of string, parse it. */
723 val
= string_to_object (val
, defalt
);
725 /* The appropriate frame will get selected
726 in set-window-configuration. */
727 RETURN_UNGCPRO (unbind_to (count
, val
));
730 /* Return a buffer to be used as the minibuffer at depth `depth'.
731 depth = 0 is the lowest allowed argument, and that is the value
732 used for nonrecursive minibuffer invocations */
735 get_minibuffer (depth
)
738 Lisp_Object tail
, num
, buf
;
740 extern Lisp_Object
nconc2 ();
742 XSETFASTINT (num
, depth
);
743 tail
= Fnthcdr (num
, Vminibuffer_list
);
746 tail
= Fcons (Qnil
, Qnil
);
747 Vminibuffer_list
= nconc2 (Vminibuffer_list
, tail
);
750 if (NILP (buf
) || NILP (XBUFFER (buf
)->name
))
752 sprintf (name
, " *Minibuf-%d*", depth
);
753 buf
= Fget_buffer_create (build_string (name
));
755 /* Although the buffer's name starts with a space, undo should be
757 Fbuffer_enable_undo (buf
);
763 int count
= SPECPDL_INDEX ();
765 reset_buffer (XBUFFER (buf
));
766 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
768 Fkill_all_local_variables ();
769 unbind_to (count
, Qnil
);
775 /* This function is called on exiting minibuffer, whether normally or
776 not, and it restores the current window, buffer, etc. */
779 read_minibuf_unwind (data
)
782 Lisp_Object old_deactivate_mark
;
785 /* We are exiting the minibuffer one way or the other,
787 if (!NILP (Vminibuffer_exit_hook
) && !EQ (Vminibuffer_exit_hook
, Qunbound
)
788 && !NILP (Vrun_hooks
))
789 safe_run_hooks (Qminibuffer_exit_hook
);
791 /* If this was a recursive minibuffer,
792 tie the minibuffer window back to the outer level minibuffer buffer. */
795 window
= minibuf_window
;
796 /* To keep things predictable, in case it matters, let's be in the
797 minibuffer when we reset the relevant variables. */
798 Fset_buffer (XWINDOW (window
)->buffer
);
800 /* Restore prompt, etc, from outer minibuffer level. */
801 minibuf_prompt
= Fcar (minibuf_save_list
);
802 minibuf_save_list
= Fcdr (minibuf_save_list
);
803 minibuf_prompt_width
= XFASTINT (Fcar (minibuf_save_list
));
804 minibuf_save_list
= Fcdr (minibuf_save_list
);
805 Vhelp_form
= Fcar (minibuf_save_list
);
806 minibuf_save_list
= Fcdr (minibuf_save_list
);
807 Vcurrent_prefix_arg
= Fcar (minibuf_save_list
);
808 minibuf_save_list
= Fcdr (minibuf_save_list
);
809 Vminibuffer_history_position
= Fcar (minibuf_save_list
);
810 minibuf_save_list
= Fcdr (minibuf_save_list
);
811 Vminibuffer_history_variable
= Fcar (minibuf_save_list
);
812 minibuf_save_list
= Fcdr (minibuf_save_list
);
813 Voverriding_local_map
= Fcar (minibuf_save_list
);
814 minibuf_save_list
= Fcdr (minibuf_save_list
);
816 temp
= Fcar (minibuf_save_list
);
817 if (FRAME_LIVE_P (XFRAME (WINDOW_FRAME (XWINDOW (temp
)))))
818 minibuf_window
= temp
;
820 minibuf_save_list
= Fcdr (minibuf_save_list
);
822 /* Erase the minibuffer we were using at this level. */
824 int count
= SPECPDL_INDEX ();
825 /* Prevent error in erase-buffer. */
826 specbind (Qinhibit_read_only
, Qt
);
827 specbind (Qinhibit_modification_hooks
, Qt
);
828 old_deactivate_mark
= Vdeactivate_mark
;
830 Vdeactivate_mark
= old_deactivate_mark
;
831 unbind_to (count
, Qnil
);
834 /* When we get to the outmost level, make sure we resize the
835 mini-window back to its normal size. */
836 if (minibuf_level
== 0)
837 resize_mini_window (XWINDOW (window
), 0);
839 /* Make sure minibuffer window is erased, not ignored. */
840 windows_or_buffers_changed
++;
841 XSETFASTINT (XWINDOW (window
)->last_modified
, 0);
842 XSETFASTINT (XWINDOW (window
)->last_overlay_modified
, 0);
847 DEFUN ("read-from-minibuffer", Fread_from_minibuffer
, Sread_from_minibuffer
, 1, 7, 0,
848 doc
: /* Read a string from the minibuffer, prompting with string PROMPT.
849 If optional second arg INITIAL-CONTENTS is non-nil, it is a string
850 to be inserted into the minibuffer before reading input.
851 If INITIAL-CONTENTS is (STRING . POSITION), the initial input
852 is STRING, but point is placed at position POSITION in the minibuffer.
853 Third arg KEYMAP is a keymap to use whilst reading;
854 if omitted or nil, the default is `minibuffer-local-map'.
855 If fourth arg READ is non-nil, then interpret the result as a Lisp object
856 and return that object:
857 in other words, do `(car (read-from-string INPUT-STRING))'
858 Fifth arg HIST, if non-nil, specifies a history list
859 and optionally the initial position in the list.
860 It can be a symbol, which is the history list variable to use,
861 or it can be a cons cell (HISTVAR . HISTPOS).
862 In that case, HISTVAR is the history list variable to use,
863 and HISTPOS is the initial position (the position in the list
864 which INITIAL-CONTENTS corresponds to).
865 Positions are counted starting from 1 at the beginning of the list.
866 Sixth arg DEFAULT-VALUE is the default value. If non-nil, it is available
867 for history commands; but `read-from-minibuffer' does NOT return DEFAULT-VALUE
868 if the user enters empty input! It returns the empty string.
869 Seventh arg INHERIT-INPUT-METHOD, if non-nil, means the minibuffer inherits
870 the current input method and the setting of `enable-multibyte-characters'.
871 If the variable `minibuffer-allow-text-properties' is non-nil,
872 then the string which is returned includes whatever text properties
873 were present in the minibuffer. Otherwise the value has no text properties. */)
874 (prompt
, initial_contents
, keymap
, read
, hist
, default_value
, inherit_input_method
)
875 Lisp_Object prompt
, initial_contents
, keymap
, read
, hist
, default_value
;
876 Lisp_Object inherit_input_method
;
879 Lisp_Object histvar
, histpos
, position
, val
;
884 CHECK_STRING (prompt
);
885 if (!NILP (initial_contents
))
887 if (CONSP (initial_contents
))
889 position
= Fcdr (initial_contents
);
890 initial_contents
= Fcar (initial_contents
);
892 CHECK_STRING (initial_contents
);
893 if (!NILP (position
))
895 CHECK_NUMBER (position
);
896 /* Convert to distance from end of input. */
897 if (XINT (position
) < 1)
898 /* A number too small means the beginning of the string. */
899 pos
= - SCHARS (initial_contents
);
901 pos
= XINT (position
) - 1 - SCHARS (initial_contents
);
906 keymap
= Vminibuffer_local_map
;
908 keymap
= get_keymap (keymap
, 1, 0);
917 histvar
= Fcar_safe (hist
);
918 histpos
= Fcdr_safe (hist
);
921 histvar
= Qminibuffer_history
;
923 XSETFASTINT (histpos
, 0);
925 GCPRO1 (default_value
);
926 val
= read_minibuf (keymap
, initial_contents
, prompt
,
927 make_number (pos
), !NILP (read
),
928 histvar
, histpos
, default_value
,
929 minibuffer_allow_text_properties
,
930 !NILP (inherit_input_method
));
935 DEFUN ("read-minibuffer", Fread_minibuffer
, Sread_minibuffer
, 1, 2, 0,
936 doc
: /* Return a Lisp object read using the minibuffer.
937 Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS
938 is a string to insert in the minibuffer before reading. */)
939 (prompt
, initial_contents
)
940 Lisp_Object prompt
, initial_contents
;
942 CHECK_STRING (prompt
);
943 if (!NILP (initial_contents
))
944 CHECK_STRING (initial_contents
);
945 return read_minibuf (Vminibuffer_local_map
, initial_contents
,
946 prompt
, Qnil
, 1, Qminibuffer_history
,
947 make_number (0), Qnil
, 0, 0);
950 DEFUN ("eval-minibuffer", Feval_minibuffer
, Seval_minibuffer
, 1, 2, 0,
951 doc
: /* Return value of Lisp expression read using the minibuffer.
952 Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS
953 is a string to insert in the minibuffer before reading. */)
954 (prompt
, initial_contents
)
955 Lisp_Object prompt
, initial_contents
;
957 return Feval (Fread_minibuffer (prompt
, initial_contents
));
960 /* Functions that use the minibuffer to read various things. */
962 DEFUN ("read-string", Fread_string
, Sread_string
, 1, 5, 0,
963 doc
: /* Read a string from the minibuffer, prompting with string PROMPT.
964 If non-nil, second arg INITIAL-INPUT is a string to insert before reading.
965 The third arg HISTORY, if non-nil, specifies a history list
966 and optionally the initial position in the list.
967 See `read-from-minibuffer' for details of HISTORY argument.
968 Fourth arg DEFAULT-VALUE is the default value. If non-nil, it is used
969 for history commands, and as the value to return if the user enters
971 Fifth arg INHERIT-INPUT-METHOD, if non-nil, means the minibuffer inherits
972 the current input method and the setting of `enable-multibyte-characters'. */)
973 (prompt
, initial_input
, history
, default_value
, inherit_input_method
)
974 Lisp_Object prompt
, initial_input
, history
, default_value
;
975 Lisp_Object inherit_input_method
;
978 val
= Fread_from_minibuffer (prompt
, initial_input
, Qnil
,
979 Qnil
, history
, default_value
,
980 inherit_input_method
);
981 if (STRINGP (val
) && SCHARS (val
) == 0 && ! NILP (default_value
))
986 DEFUN ("read-no-blanks-input", Fread_no_blanks_input
, Sread_no_blanks_input
, 1, 3, 0,
987 doc
: /* Read a string from the terminal, not allowing blanks.
988 Prompt with PROMPT, and provide INITIAL as an initial value of the input string.
989 Third arg INHERIT-INPUT-METHOD, if non-nil, means the minibuffer inherits
990 the current input method and the setting of `enable-multibyte-characters'. */)
991 (prompt
, initial
, inherit_input_method
)
992 Lisp_Object prompt
, initial
, inherit_input_method
;
994 CHECK_STRING (prompt
);
995 if (! NILP (initial
))
996 CHECK_STRING (initial
);
998 return read_minibuf (Vminibuffer_local_ns_map
, initial
, prompt
, Qnil
,
999 0, Qminibuffer_history
, make_number (0), Qnil
, 0,
1000 !NILP (inherit_input_method
));
1003 DEFUN ("read-command", Fread_command
, Sread_command
, 1, 2, 0,
1004 doc
: /* Read the name of a command and return as a symbol.
1005 Prompt with PROMPT. By default, return DEFAULT-VALUE. */)
1006 (prompt
, default_value
)
1007 Lisp_Object prompt
, default_value
;
1009 Lisp_Object name
, default_string
;
1011 if (NILP (default_value
))
1012 default_string
= Qnil
;
1013 else if (SYMBOLP (default_value
))
1014 default_string
= SYMBOL_NAME (default_value
);
1016 default_string
= default_value
;
1018 name
= Fcompleting_read (prompt
, Vobarray
, Qcommandp
, Qt
,
1019 Qnil
, Qnil
, default_string
, Qnil
);
1022 return Fintern (name
, Qnil
);
1026 DEFUN ("read-function", Fread_function
, Sread_function
, 1, 1, 0,
1027 doc
: /* One arg PROMPT, a string. Read the name of a function and return as a symbol.
1028 Prompt with PROMPT. */)
1032 return Fintern (Fcompleting_read (prompt
, Vobarray
, Qfboundp
, Qt
, Qnil
, Qnil
, Qnil
, Qnil
),
1037 DEFUN ("read-variable", Fread_variable
, Sread_variable
, 1, 2, 0,
1038 doc
: /* Read the name of a user variable and return it as a symbol.
1039 Prompt with PROMPT. By default, return DEFAULT-VALUE.
1040 A user variable is one for which `user-variable-p' returns non-nil. */)
1041 (prompt
, default_value
)
1042 Lisp_Object prompt
, default_value
;
1044 Lisp_Object name
, default_string
;
1046 if (NILP (default_value
))
1047 default_string
= Qnil
;
1048 else if (SYMBOLP (default_value
))
1049 default_string
= SYMBOL_NAME (default_value
);
1051 default_string
= default_value
;
1053 name
= Fcompleting_read (prompt
, Vobarray
,
1054 Quser_variable_p
, Qt
,
1055 Qnil
, Qnil
, default_string
, Qnil
);
1058 return Fintern (name
, Qnil
);
1061 DEFUN ("read-buffer", Fread_buffer
, Sread_buffer
, 1, 3, 0,
1062 doc
: /* Read the name of a buffer and return as a string.
1064 Optional second arg DEF is value to return if user enters an empty line.
1065 If optional third arg REQUIRE-MATCH is non-nil,
1066 only existing buffer names are allowed. */)
1067 (prompt
, def
, require_match
)
1068 Lisp_Object prompt
, def
, require_match
;
1070 Lisp_Object args
[4];
1073 def
= XBUFFER (def
)->name
;
1075 if (NILP (Vread_buffer_function
))
1079 args
[0] = build_string ("%s(default %s) ");
1082 prompt
= Fformat (3, args
);
1085 return Fcompleting_read (prompt
, Vbuffer_alist
, Qnil
,
1086 require_match
, Qnil
, Qbuffer_name_history
,
1091 args
[0] = Vread_buffer_function
;
1094 args
[3] = require_match
;
1095 return Ffuncall(4, args
);
1100 minibuf_conform_representation (string
, basis
)
1101 Lisp_Object string
, basis
;
1103 if (STRING_MULTIBYTE (string
) == STRING_MULTIBYTE (basis
))
1106 if (STRING_MULTIBYTE (string
))
1107 return Fstring_make_unibyte (string
);
1109 return Fstring_make_multibyte (string
);
1112 DEFUN ("try-completion", Ftry_completion
, Stry_completion
, 2, 3, 0,
1113 doc
: /* Return common substring of all completions of STRING in ALIST.
1114 Each car of each element of ALIST is tested to see if it begins with STRING.
1115 All that match are compared together; the longest initial sequence
1116 common to all matches is returned as a string.
1117 If there is no match at all, nil is returned.
1118 For a unique match which is exact, t is returned.
1120 If ALIST is a hash-table, all the string keys are the possible matches.
1121 If ALIST is an obarray, the names of all symbols in the obarray
1122 are the possible matches.
1124 ALIST can also be a function to do the completion itself.
1125 It receives three arguments: the values STRING, PREDICATE and nil.
1126 Whatever it returns becomes the value of `try-completion'.
1128 If optional third argument PREDICATE is non-nil,
1129 it is used to test each possible match.
1130 The match is a candidate only if PREDICATE returns non-nil.
1131 The argument given to PREDICATE is the alist element
1132 or the symbol from the obarray. If ALIST is a hash-table,
1133 predicate is called with two arguments: the key and the value.
1134 Additionally to this predicate, `completion-regexp-list'
1135 is used to further constrain the set of candidates. */)
1136 (string
, alist
, predicate
)
1137 Lisp_Object string
, alist
, predicate
;
1139 Lisp_Object bestmatch
, tail
, elt
, eltstring
;
1140 /* Size in bytes of BESTMATCH. */
1141 int bestmatchsize
= 0;
1142 /* These are in bytes, too. */
1143 int compare
, matchsize
;
1144 int type
= HASH_TABLE_P (alist
) ? 3
1145 : VECTORP (alist
) ? 2
1146 : NILP (alist
) || (CONSP (alist
)
1147 && (!SYMBOLP (XCAR (alist
))
1148 || NILP (XCAR (alist
))));
1149 int index
= 0, obsize
= 0;
1151 Lisp_Object bucket
, zero
, end
, tem
;
1152 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
1154 CHECK_STRING (string
);
1156 return call3 (alist
, string
, predicate
, Qnil
);
1158 bestmatch
= bucket
= Qnil
;
1160 /* If ALIST is not a list, set TAIL just for gc pro. */
1164 obsize
= XVECTOR (alist
)->size
;
1165 bucket
= XVECTOR (alist
)->contents
[index
];
1170 /* Get the next element of the alist, obarray, or hash-table. */
1171 /* Exit the loop if the elements are all used up. */
1172 /* elt gets the alist element or symbol.
1173 eltstring gets the name to check as a completion. */
1180 eltstring
= CONSP (elt
) ? XCAR (elt
) : elt
;
1185 if (XFASTINT (bucket
) != 0)
1188 eltstring
= Fsymbol_name (elt
);
1189 if (XSYMBOL (bucket
)->next
)
1190 XSETSYMBOL (bucket
, XSYMBOL (bucket
)->next
);
1192 XSETFASTINT (bucket
, 0);
1194 else if (++index
>= obsize
)
1198 bucket
= XVECTOR (alist
)->contents
[index
];
1202 else /* if (type == 3) */
1204 while (index
< HASH_TABLE_SIZE (XHASH_TABLE (alist
))
1205 && NILP (HASH_HASH (XHASH_TABLE (alist
), index
)))
1207 if (index
>= HASH_TABLE_SIZE (XHASH_TABLE (alist
)))
1210 elt
= eltstring
= HASH_KEY (XHASH_TABLE (alist
), index
++);
1213 /* Is this element a possible completion? */
1215 if (STRINGP (eltstring
)
1216 && SCHARS (string
) <= SCHARS (eltstring
)
1217 && (tem
= Fcompare_strings (eltstring
, make_number (0),
1218 make_number (SCHARS (string
)),
1219 string
, make_number (0), Qnil
,
1220 completion_ignore_case
?Qt
: Qnil
),
1224 Lisp_Object regexps
;
1226 XSETFASTINT (zero
, 0);
1228 /* Ignore this element if it fails to match all the regexps. */
1229 for (regexps
= Vcompletion_regexp_list
; CONSP (regexps
);
1230 regexps
= XCDR (regexps
))
1232 tem
= Fstring_match (XCAR (regexps
), eltstring
, zero
);
1236 if (CONSP (regexps
))
1239 /* Ignore this element if there is a predicate
1240 and the predicate doesn't like it. */
1242 if (!NILP (predicate
))
1244 if (EQ (predicate
, Qcommandp
))
1245 tem
= Fcommandp (elt
, Qnil
);
1248 GCPRO4 (tail
, string
, eltstring
, bestmatch
);
1250 ? call2 (predicate
, elt
,
1251 HASH_VALUE (XHASH_TABLE (alist
), index
- 1))
1252 : call1 (predicate
, elt
);
1255 if (NILP (tem
)) continue;
1258 /* Update computation of how much all possible completions match */
1260 if (NILP (bestmatch
))
1263 bestmatch
= eltstring
;
1264 bestmatchsize
= SCHARS (eltstring
);
1268 compare
= min (bestmatchsize
, SCHARS (eltstring
));
1269 tem
= Fcompare_strings (bestmatch
, make_number (0),
1270 make_number (compare
),
1271 eltstring
, make_number (0),
1272 make_number (compare
),
1273 completion_ignore_case
? Qt
: Qnil
);
1275 matchsize
= compare
;
1276 else if (XINT (tem
) < 0)
1277 matchsize
= - XINT (tem
) - 1;
1279 matchsize
= XINT (tem
) - 1;
1282 /* When can this happen ? -stef */
1283 matchsize
= compare
;
1284 if (completion_ignore_case
)
1286 /* If this is an exact match except for case,
1287 use it as the best match rather than one that is not an
1288 exact match. This way, we get the case pattern
1289 of the actual match. */
1290 if ((matchsize
== SCHARS (eltstring
)
1291 && matchsize
< SCHARS (bestmatch
))
1293 /* If there is more than one exact match ignoring case,
1294 and one of them is exact including case,
1296 /* If there is no exact match ignoring case,
1297 prefer a match that does not change the case
1299 ((matchsize
== SCHARS (eltstring
))
1301 (matchsize
== SCHARS (bestmatch
))
1302 && (tem
= Fcompare_strings (eltstring
, make_number (0),
1303 make_number (SCHARS (string
)),
1304 string
, make_number (0),
1308 && (tem
= Fcompare_strings (bestmatch
, make_number (0),
1309 make_number (SCHARS (string
)),
1310 string
, make_number (0),
1314 bestmatch
= eltstring
;
1316 if (bestmatchsize
!= SCHARS (eltstring
)
1317 || bestmatchsize
!= matchsize
)
1318 /* Don't count the same string multiple times. */
1320 bestmatchsize
= matchsize
;
1321 if (matchsize
<= SCHARS (string
)
1323 /* No need to look any further. */
1329 if (NILP (bestmatch
))
1330 return Qnil
; /* No completions found */
1331 /* If we are ignoring case, and there is no exact match,
1332 and no additional text was supplied,
1333 don't change the case of what the user typed. */
1334 if (completion_ignore_case
&& bestmatchsize
== SCHARS (string
)
1335 && SCHARS (bestmatch
) > bestmatchsize
)
1336 return minibuf_conform_representation (string
, bestmatch
);
1338 /* Return t if the supplied string is an exact match (counting case);
1339 it does not require any change to be made. */
1340 if (matchcount
== 1 && bestmatchsize
== SCHARS (string
)
1341 && (tem
= Fcompare_strings (bestmatch
, make_number (0),
1342 make_number (bestmatchsize
),
1343 string
, make_number (0),
1344 make_number (bestmatchsize
),
1349 XSETFASTINT (zero
, 0); /* Else extract the part in which */
1350 XSETFASTINT (end
, bestmatchsize
); /* all completions agree */
1351 return Fsubstring (bestmatch
, zero
, end
);
1354 DEFUN ("all-completions", Fall_completions
, Sall_completions
, 2, 4, 0,
1355 doc
: /* Search for partial matches to STRING in ALIST.
1356 Each car of each element of ALIST is tested to see if it begins with STRING.
1357 The value is a list of all the strings from ALIST that match.
1359 If ALIST is a hash-table, all the string keys are the possible matches.
1360 If ALIST is an obarray, the names of all symbols in the obarray
1361 are the possible matches.
1363 ALIST can also be a function to do the completion itself.
1364 It receives three arguments: the values STRING, PREDICATE and t.
1365 Whatever it returns becomes the value of `all-completions'.
1367 If optional third argument PREDICATE is non-nil,
1368 it is used to test each possible match.
1369 The match is a candidate only if PREDICATE returns non-nil.
1370 The argument given to PREDICATE is the alist element
1371 or the symbol from the obarray. If ALIST is a hash-table,
1372 predicate is called with two arguments: the key and the value.
1373 Additionally to this predicate, `completion-regexp-list'
1374 is used to further constrain the set of candidates.
1376 If the optional fourth argument HIDE-SPACES is non-nil,
1377 strings in ALIST that start with a space
1378 are ignored unless STRING itself starts with a space. */)
1379 (string
, alist
, predicate
, hide_spaces
)
1380 Lisp_Object string
, alist
, predicate
, hide_spaces
;
1382 Lisp_Object tail
, elt
, eltstring
;
1383 Lisp_Object allmatches
;
1384 int type
= HASH_TABLE_P (alist
) ? 3
1385 : VECTORP (alist
) ? 2
1386 : NILP (alist
) || (CONSP (alist
)
1387 && (!SYMBOLP (XCAR (alist
))
1388 || NILP (XCAR (alist
))));
1389 int index
= 0, obsize
= 0;
1390 Lisp_Object bucket
, tem
;
1391 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
1393 CHECK_STRING (string
);
1395 return call3 (alist
, string
, predicate
, Qt
);
1396 allmatches
= bucket
= Qnil
;
1398 /* If ALIST is not a list, set TAIL just for gc pro. */
1402 obsize
= XVECTOR (alist
)->size
;
1403 bucket
= XVECTOR (alist
)->contents
[index
];
1408 /* Get the next element of the alist, obarray, or hash-table. */
1409 /* Exit the loop if the elements are all used up. */
1410 /* elt gets the alist element or symbol.
1411 eltstring gets the name to check as a completion. */
1418 eltstring
= CONSP (elt
) ? XCAR (elt
) : elt
;
1423 if (XFASTINT (bucket
) != 0)
1426 eltstring
= Fsymbol_name (elt
);
1427 if (XSYMBOL (bucket
)->next
)
1428 XSETSYMBOL (bucket
, XSYMBOL (bucket
)->next
);
1430 XSETFASTINT (bucket
, 0);
1432 else if (++index
>= obsize
)
1436 bucket
= XVECTOR (alist
)->contents
[index
];
1440 else /* if (type == 3) */
1442 while (index
< HASH_TABLE_SIZE (XHASH_TABLE (alist
))
1443 && NILP (HASH_HASH (XHASH_TABLE (alist
), index
)))
1445 if (index
>= HASH_TABLE_SIZE (XHASH_TABLE (alist
)))
1448 elt
= eltstring
= HASH_KEY (XHASH_TABLE (alist
), index
++);
1451 /* Is this element a possible completion? */
1453 if (STRINGP (eltstring
)
1454 && SCHARS (string
) <= SCHARS (eltstring
)
1455 /* If HIDE_SPACES, reject alternatives that start with space
1456 unless the input starts with space. */
1457 && ((SBYTES (string
) > 0
1458 && SREF (string
, 0) == ' ')
1459 || SREF (eltstring
, 0) != ' '
1460 || NILP (hide_spaces
))
1461 && (tem
= Fcompare_strings (eltstring
, make_number (0),
1462 make_number (SCHARS (string
)),
1463 string
, make_number (0),
1464 make_number (SCHARS (string
)),
1465 completion_ignore_case
? Qt
: Qnil
),
1469 Lisp_Object regexps
;
1471 XSETFASTINT (zero
, 0);
1473 /* Ignore this element if it fails to match all the regexps. */
1474 for (regexps
= Vcompletion_regexp_list
; CONSP (regexps
);
1475 regexps
= XCDR (regexps
))
1477 tem
= Fstring_match (XCAR (regexps
), eltstring
, zero
);
1481 if (CONSP (regexps
))
1484 /* Ignore this element if there is a predicate
1485 and the predicate doesn't like it. */
1487 if (!NILP (predicate
))
1489 if (EQ (predicate
, Qcommandp
))
1490 tem
= Fcommandp (elt
, Qnil
);
1493 GCPRO4 (tail
, eltstring
, allmatches
, string
);
1495 ? call2 (predicate
, elt
,
1496 HASH_VALUE (XHASH_TABLE (alist
), index
- 1))
1497 : call1 (predicate
, elt
);
1500 if (NILP (tem
)) continue;
1502 /* Ok => put it on the list. */
1503 allmatches
= Fcons (eltstring
, allmatches
);
1507 return Fnreverse (allmatches
);
1510 Lisp_Object Vminibuffer_completion_table
, Qminibuffer_completion_table
;
1511 Lisp_Object Vminibuffer_completion_predicate
, Qminibuffer_completion_predicate
;
1512 Lisp_Object Vminibuffer_completion_confirm
, Qminibuffer_completion_confirm
;
1513 Lisp_Object Vminibuffer_completing_file_name
;
1515 DEFUN ("completing-read", Fcompleting_read
, Scompleting_read
, 2, 8, 0,
1516 doc
: /* Read a string in the minibuffer, with completion.
1517 PROMPT is a string to prompt with; normally it ends in a colon and a space.
1518 TABLE is an alist whose elements' cars are strings, or an obarray.
1519 TABLE can also be a function to do the completion itself.
1520 PREDICATE limits completion to a subset of TABLE.
1521 See `try-completion' and `all-completions' for more details
1522 on completion, TABLE, and PREDICATE.
1524 If REQUIRE-MATCH is non-nil, the user is not allowed to exit unless
1525 the input is (or completes to) an element of TABLE or is null.
1526 If it is also not t, typing RET does not exit if it does non-null completion.
1527 If the input is null, `completing-read' returns an empty string,
1528 regardless of the value of REQUIRE-MATCH.
1530 If INITIAL-INPUT is non-nil, insert it in the minibuffer initially.
1531 If it is (STRING . POSITION), the initial input
1532 is STRING, but point is placed POSITION characters into the string.
1533 This feature is deprecated--it is best to pass nil for INITIAL-INPUT
1534 and supply the default value DEF instead. The user can yank the
1535 default value into the minibuffer easily using \\[next-history-element].
1537 HIST, if non-nil, specifies a history list
1538 and optionally the initial position in the list.
1539 It can be a symbol, which is the history list variable to use,
1540 or it can be a cons cell (HISTVAR . HISTPOS).
1541 In that case, HISTVAR is the history list variable to use,
1542 and HISTPOS is the initial position (the position in the list
1543 which INITIAL-INPUT corresponds to).
1544 Positions are counted starting from 1 at the beginning of the list.
1545 The variable `history-length' controls the maximum length of a
1548 DEF, if non-nil, is the default value.
1550 If INHERIT-INPUT-METHOD is non-nil, the minibuffer inherits
1551 the current input method and the setting of `enable-multibyte-characters'.
1553 Completion ignores case if the ambient value of
1554 `completion-ignore-case' is non-nil. */)
1555 (prompt
, table
, predicate
, require_match
, initial_input
, hist
, def
, inherit_input_method
)
1556 Lisp_Object prompt
, table
, predicate
, require_match
, initial_input
;
1557 Lisp_Object hist
, def
, inherit_input_method
;
1559 Lisp_Object val
, histvar
, histpos
, position
;
1562 int count
= SPECPDL_INDEX ();
1563 struct gcpro gcpro1
;
1565 init
= initial_input
;
1568 specbind (Qminibuffer_completion_table
, table
);
1569 specbind (Qminibuffer_completion_predicate
, predicate
);
1570 specbind (Qminibuffer_completion_confirm
,
1571 EQ (require_match
, Qt
) ? Qnil
: require_match
);
1572 last_exact_completion
= Qnil
;
1579 position
= Fcdr (init
);
1582 CHECK_STRING (init
);
1583 if (!NILP (position
))
1585 CHECK_NUMBER (position
);
1586 /* Convert to distance from end of input. */
1587 pos
= XINT (position
) - SCHARS (init
);
1598 histvar
= Fcar_safe (hist
);
1599 histpos
= Fcdr_safe (hist
);
1602 histvar
= Qminibuffer_history
;
1604 XSETFASTINT (histpos
, 0);
1606 val
= read_minibuf (NILP (require_match
)
1607 ? Vminibuffer_local_completion_map
1608 : Vminibuffer_local_must_match_map
,
1609 init
, prompt
, make_number (pos
), 0,
1610 histvar
, histpos
, def
, 0,
1611 !NILP (inherit_input_method
));
1613 if (STRINGP (val
) && SCHARS (val
) == 0 && ! NILP (def
))
1616 RETURN_UNGCPRO (unbind_to (count
, val
));
1619 Lisp_Object
Fminibuffer_completion_help ();
1620 Lisp_Object
Fassoc_string ();
1622 /* Test whether TXT is an exact completion. */
1623 DEFUN ("test-completion", Ftest_completion
, Stest_completion
, 2, 3, 0,
1624 doc
: /* Return non-nil if STRING is a valid completion.
1625 Takes the same arguments as `all-completions' and `try-completion'.
1626 If ALIST is a function, it is called with three arguments:
1627 the values STRING, PREDICATE and `lambda'. */)
1628 (string
, alist
, predicate
)
1629 Lisp_Object string
, alist
, predicate
;
1631 Lisp_Object regexps
, tem
= Qnil
;
1634 CHECK_STRING (string
);
1636 if ((CONSP (alist
) && (!SYMBOLP (XCAR (alist
)) || NILP (XCAR (alist
))))
1639 tem
= Fassoc_string (string
, alist
, completion_ignore_case
? Qt
: Qnil
);
1643 else if (VECTORP (alist
))
1645 /* Bypass intern-soft as that loses for nil. */
1646 tem
= oblookup (alist
,
1652 if (STRING_MULTIBYTE (string
))
1653 string
= Fstring_make_unibyte (string
);
1655 string
= Fstring_make_multibyte (string
);
1657 tem
= oblookup (Vminibuffer_completion_table
,
1665 else if (HASH_TABLE_P (alist
))
1667 i
= hash_lookup (XHASH_TABLE (alist
), string
, NULL
);
1669 tem
= HASH_KEY (XHASH_TABLE (alist
), i
);
1674 return call3 (alist
, string
, predicate
, Qlambda
);
1676 /* Reject this element if it fails to match all the regexps. */
1677 for (regexps
= Vcompletion_regexp_list
; CONSP (regexps
);
1678 regexps
= XCDR (regexps
))
1680 if (NILP (Fstring_match (XCAR (regexps
),
1681 SYMBOLP (tem
) ? string
: tem
,
1686 /* Finally, check the predicate. */
1687 if (!NILP (predicate
))
1688 return HASH_TABLE_P (alist
)
1689 ? call2 (predicate
, tem
, HASH_VALUE (XHASH_TABLE (alist
), i
))
1690 : call1 (predicate
, tem
);
1696 * 0 no possible completion
1697 * 1 was already an exact and unique completion
1698 * 3 was already an exact completion
1699 * 4 completed to an exact completion
1700 * 5 some completion happened
1701 * 6 no completion happened
1706 Lisp_Object completion
, string
, tem
;
1709 struct gcpro gcpro1
, gcpro2
;
1711 completion
= Ftry_completion (minibuffer_completion_contents (),
1712 Vminibuffer_completion_table
,
1713 Vminibuffer_completion_predicate
);
1714 last
= last_exact_completion
;
1715 last_exact_completion
= Qnil
;
1717 GCPRO2 (completion
, last
);
1719 if (NILP (completion
))
1722 temp_echo_area_glyphs (" [No match]");
1727 if (EQ (completion
, Qt
)) /* exact and unique match */
1733 string
= minibuffer_completion_contents ();
1735 /* COMPLETEDP should be true if some completion was done, which
1736 doesn't include simply changing the case of the entered string.
1737 However, for appearance, the string is rewritten if the case
1739 tem
= Fcompare_strings (completion
, Qnil
, Qnil
, string
, Qnil
, Qnil
, Qt
);
1740 completedp
= !EQ (tem
, Qt
);
1742 tem
= Fcompare_strings (completion
, Qnil
, Qnil
, string
, Qnil
, Qnil
, Qnil
);
1744 /* Rewrite the user's input. */
1746 int prompt_end
= XINT (Fminibuffer_prompt_end ());
1747 /* Some completion happened */
1749 if (! NILP (Vminibuffer_completing_file_name
)
1750 && SREF (completion
, SBYTES (completion
) - 1) == '/'
1752 && FETCH_CHAR (PT_BYTE
) == '/')
1754 del_range (prompt_end
, PT
+ 1);
1757 del_range (prompt_end
, PT
);
1759 Finsert (1, &completion
);
1762 /* The case of the string changed, but that's all. We're not
1763 sure whether this is a unique completion or not, so try again
1764 using the real case (this shouldn't recurse again, because
1765 the next time try-completion will return either `t' or the
1769 return do_completion ();
1773 /* It did find a match. Do we match some possibility exactly now? */
1774 tem
= Ftest_completion (Fminibuffer_contents (),
1775 Vminibuffer_completion_table
,
1776 Vminibuffer_completion_predicate
);
1779 /* not an exact match */
1783 else if (!NILP (Vcompletion_auto_help
))
1784 Fminibuffer_completion_help ();
1786 temp_echo_area_glyphs (" [Next char not unique]");
1789 else if (completedp
)
1794 /* If the last exact completion and this one were the same,
1795 it means we've already given a "Complete but not unique"
1796 message and the user's hit TAB again, so now we give him help. */
1797 last_exact_completion
= completion
;
1800 tem
= minibuffer_completion_contents ();
1801 if (!NILP (Fequal (tem
, last
)))
1802 Fminibuffer_completion_help ();
1808 /* Like assoc but assumes KEY is a string, and ignores case if appropriate. */
1810 DEFUN ("assoc-string", Fassoc_string
, Sassoc_string
, 2, 3, 0,
1811 doc
: /* Like `assoc' but specifically for strings.
1812 Unibyte strings are converted to multibyte for comparison.
1813 And case is ignored if CASE-FOLD is non-nil.
1814 As opposed to `assoc', it will also match an entry consisting of a single
1815 string rather than a cons cell whose car is a string. */)
1816 (key
, list
, case_fold
)
1817 register Lisp_Object key
;
1818 Lisp_Object list
, case_fold
;
1820 register Lisp_Object tail
;
1822 for (tail
= list
; !NILP (tail
); tail
= Fcdr (tail
))
1824 register Lisp_Object elt
, tem
, thiscar
;
1826 thiscar
= CONSP (elt
) ? XCAR (elt
) : elt
;
1827 if (!STRINGP (thiscar
))
1829 tem
= Fcompare_strings (thiscar
, make_number (0), Qnil
,
1830 key
, make_number (0), Qnil
,
1839 DEFUN ("minibuffer-complete", Fminibuffer_complete
, Sminibuffer_complete
, 0, 0, "",
1840 doc
: /* Complete the minibuffer contents as far as possible.
1841 Return nil if there is no valid completion, else t.
1842 If no characters can be completed, display a list of possible completions.
1843 If you repeat this command after it displayed such a list,
1844 scroll the window of possible completions. */)
1848 Lisp_Object window
, tem
;
1850 /* If the previous command was not this,
1851 mark the completion buffer obsolete. */
1852 if (! EQ (current_kboard
->Vlast_command
, Vthis_command
))
1853 Vminibuf_scroll_window
= Qnil
;
1855 window
= Vminibuf_scroll_window
;
1856 /* If there's a fresh completion window with a live buffer,
1857 and this command is repeated, scroll that window. */
1858 if (! NILP (window
) && ! NILP (XWINDOW (window
)->buffer
)
1859 && !NILP (XBUFFER (XWINDOW (window
)->buffer
)->name
))
1861 struct buffer
*obuf
= current_buffer
;
1863 Fset_buffer (XWINDOW (window
)->buffer
);
1864 tem
= Fpos_visible_in_window_p (make_number (ZV
), window
, Qnil
);
1866 /* If end is in view, scroll up to the beginning. */
1867 Fset_window_start (window
, make_number (BEGV
), Qnil
);
1869 /* Else scroll down one screen. */
1870 Fscroll_other_window (Qnil
);
1872 set_buffer_internal (obuf
);
1876 i
= do_completion ();
1884 Fgoto_char (make_number (ZV
));
1885 temp_echo_area_glyphs (" [Sole completion]");
1890 Fgoto_char (make_number (ZV
));
1891 temp_echo_area_glyphs (" [Complete, but not unique]");
1898 /* Subroutines of Fminibuffer_complete_and_exit. */
1900 /* This one is called by internal_condition_case to do the real work. */
1903 complete_and_exit_1 ()
1905 return make_number (do_completion ());
1908 /* This one is called by internal_condition_case if an error happens.
1909 Pretend the current value is an exact match. */
1912 complete_and_exit_2 (ignore
)
1915 return make_number (1);
1918 DEFUN ("minibuffer-complete-and-exit", Fminibuffer_complete_and_exit
,
1919 Sminibuffer_complete_and_exit
, 0, 0, "",
1920 doc
: /* If the minibuffer contents is a valid completion then exit.
1921 Otherwise try to complete it. If completion leads to a valid completion,
1922 a repetition of this command will exit. */)
1928 /* Allow user to specify null string */
1929 if (XINT (Fminibuffer_prompt_end ()) == ZV
)
1932 if (!NILP (Ftest_completion (Fminibuffer_contents (),
1933 Vminibuffer_completion_table
,
1934 Vminibuffer_completion_predicate
)))
1937 /* Call do_completion, but ignore errors. */
1939 val
= internal_condition_case (complete_and_exit_1
, Qerror
,
1940 complete_and_exit_2
);
1950 if (!NILP (Vminibuffer_completion_confirm
))
1952 temp_echo_area_glyphs (" [Confirm]");
1962 return Fthrow (Qexit
, Qnil
);
1966 DEFUN ("minibuffer-complete-word", Fminibuffer_complete_word
, Sminibuffer_complete_word
,
1968 doc
: /* Complete the minibuffer contents at most a single word.
1969 After one word is completed as much as possible, a space or hyphen
1970 is added, provided that matches some possible completion.
1971 Return nil if there is no valid completion, else t. */)
1974 Lisp_Object completion
, tem
, tem1
;
1975 register int i
, i_byte
;
1976 register const unsigned char *completion_string
;
1977 struct gcpro gcpro1
, gcpro2
;
1978 int prompt_end_charpos
= XINT (Fminibuffer_prompt_end ());
1980 /* We keep calling Fbuffer_string rather than arrange for GC to
1981 hold onto a pointer to one of the strings thus made. */
1983 completion
= Ftry_completion (minibuffer_completion_contents (),
1984 Vminibuffer_completion_table
,
1985 Vminibuffer_completion_predicate
);
1986 if (NILP (completion
))
1989 temp_echo_area_glyphs (" [No match]");
1992 if (EQ (completion
, Qt
))
1995 #if 0 /* How the below code used to look, for reference. */
1996 tem
= Fminibuffer_contents ();
1998 i
= ZV
- 1 - SCHARS (completion
);
1999 p
= SDATA (completion
);
2001 0 <= scmp (b
, p
, ZV
- 1))
2004 /* Set buffer to longest match of buffer tail and completion head. */
2005 while (0 <= scmp (b
+ i
, p
, ZV
- 1 - i
))
2007 del_range (1, i
+ 1);
2010 #else /* Rewritten code */
2012 int buffer_nchars
, completion_nchars
;
2014 CHECK_STRING (completion
);
2015 tem
= minibuffer_completion_contents ();
2016 GCPRO2 (completion
, tem
);
2017 /* If reading a file name,
2018 expand any $ENVVAR refs in the buffer and in TEM. */
2019 if (! NILP (Vminibuffer_completing_file_name
))
2021 Lisp_Object substituted
;
2022 substituted
= Fsubstitute_in_file_name (tem
);
2023 if (! EQ (substituted
, tem
))
2026 del_range (prompt_end_charpos
, PT
);
2030 buffer_nchars
= SCHARS (tem
); /* # chars in what we completed. */
2031 completion_nchars
= SCHARS (completion
);
2032 i
= buffer_nchars
- completion_nchars
;
2035 (tem1
= Fcompare_strings (tem
, make_number (0),
2036 make_number (buffer_nchars
),
2037 completion
, make_number (0),
2038 make_number (buffer_nchars
),
2039 completion_ignore_case
? Qt
: Qnil
),
2044 /* Make buffer (before point) contain the longest match
2045 of TEM's tail and COMPLETION's head. */
2051 tem1
= Fcompare_strings (tem
, make_number (start_pos
), Qnil
,
2052 completion
, make_number (0),
2053 make_number (buffer_nchars
),
2054 completion_ignore_case
? Qt
: Qnil
);
2061 del_range (1, i
+ 1);
2065 #endif /* Rewritten code */
2068 int prompt_end_bytepos
;
2069 prompt_end_bytepos
= CHAR_TO_BYTE (prompt_end_charpos
);
2070 i
= PT
- prompt_end_charpos
;
2071 i_byte
= PT_BYTE
- prompt_end_bytepos
;
2074 /* If completion finds next char not unique,
2075 consider adding a space or a hyphen. */
2076 if (i
== SCHARS (completion
))
2078 GCPRO1 (completion
);
2079 tem
= Ftry_completion (concat2 (minibuffer_completion_contents (),
2080 build_string (" ")),
2081 Vminibuffer_completion_table
,
2082 Vminibuffer_completion_predicate
);
2089 GCPRO1 (completion
);
2091 Ftry_completion (concat2 (minibuffer_completion_contents (),
2092 build_string ("-")),
2093 Vminibuffer_completion_table
,
2094 Vminibuffer_completion_predicate
);
2102 /* Now find first word-break in the stuff found by completion.
2103 i gets index in string of where to stop completing. */
2106 int bytes
= SBYTES (completion
);
2107 completion_string
= SDATA (completion
);
2108 for (; i_byte
< SBYTES (completion
); i_byte
+= len
, i
++)
2110 c
= STRING_CHAR_AND_LENGTH (completion_string
+ i_byte
,
2113 if (SYNTAX (c
) != Sword
)
2122 /* If got no characters, print help for user. */
2124 if (i
== PT
- prompt_end_charpos
)
2126 if (!NILP (Vcompletion_auto_help
))
2127 Fminibuffer_completion_help ();
2131 /* Otherwise insert in minibuffer the chars we got */
2133 if (! NILP (Vminibuffer_completing_file_name
)
2134 && SREF (completion
, SBYTES (completion
) - 1) == '/'
2136 && FETCH_CHAR (PT_BYTE
) == '/')
2138 del_range (prompt_end_charpos
, PT
+ 1);
2141 del_range (prompt_end_charpos
, PT
);
2143 insert_from_string (completion
, 0, 0, i
, i_byte
, 1);
2147 DEFUN ("display-completion-list", Fdisplay_completion_list
, Sdisplay_completion_list
,
2149 doc
: /* Display the list of completions, COMPLETIONS, using `standard-output'.
2150 Each element may be just a symbol or string
2151 or may be a list of two strings to be printed as if concatenated.
2152 `standard-output' must be a buffer.
2153 The actual completion alternatives, as inserted, are given `mouse-face'
2154 properties of `highlight'.
2155 At the end, this runs the normal hook `completion-setup-hook'.
2156 It can find the completion buffer in `standard-output'. */)
2158 Lisp_Object completions
;
2160 Lisp_Object tail
, elt
;
2163 struct gcpro gcpro1
, gcpro2
;
2164 struct buffer
*old
= current_buffer
;
2167 /* Note that (when it matters) every variable
2168 points to a non-string that is pointed to by COMPLETIONS,
2169 except for ELT. ELT can be pointing to a string
2170 when terpri or Findent_to calls a change hook. */
2172 GCPRO2 (completions
, elt
);
2174 if (BUFFERP (Vstandard_output
))
2175 set_buffer_internal (XBUFFER (Vstandard_output
));
2177 if (NILP (completions
))
2178 write_string ("There are no possible completions of what you have typed.",
2182 write_string ("Possible completions are:", -1);
2183 for (tail
= completions
, i
= 0; !NILP (tail
); tail
= Fcdr (tail
), i
++)
2185 Lisp_Object tem
, string
;
2187 Lisp_Object startpos
, endpos
;
2192 /* Compute the length of this element. */
2197 length
= SCHARS (tem
);
2199 tem
= Fcar (XCDR (elt
));
2201 length
+= SCHARS (tem
);
2206 length
= SCHARS (elt
);
2209 /* This does a bad job for narrower than usual windows.
2210 Sadly, the window it will appear in is not known
2211 until after the text has been made. */
2213 if (BUFFERP (Vstandard_output
))
2214 XSETINT (startpos
, BUF_PT (XBUFFER (Vstandard_output
)));
2216 /* If the previous completion was very wide,
2217 or we have two on this line already,
2218 don't put another on the same line. */
2219 if (column
> 33 || first
2220 /* If this is really wide, don't put it second on a line. */
2221 || (column
> 0 && length
> 45))
2226 /* Otherwise advance to column 35. */
2229 if (BUFFERP (Vstandard_output
))
2231 tem
= Findent_to (make_number (35), make_number (2));
2233 column
= XINT (tem
);
2239 write_string (" ", -1);
2242 while (column
< 35);
2246 if (BUFFERP (Vstandard_output
))
2248 XSETINT (endpos
, BUF_PT (XBUFFER (Vstandard_output
)));
2249 Fset_text_properties (startpos
, endpos
,
2250 Qnil
, Vstandard_output
);
2253 /* Output this element.
2254 If necessary, convert it to unibyte or to multibyte first. */
2256 string
= Fcar (elt
);
2259 if (NILP (current_buffer
->enable_multibyte_characters
)
2260 && STRING_MULTIBYTE (string
))
2261 string
= Fstring_make_unibyte (string
);
2262 else if (!NILP (current_buffer
->enable_multibyte_characters
)
2263 && !STRING_MULTIBYTE (string
))
2264 string
= Fstring_make_multibyte (string
);
2266 if (BUFFERP (Vstandard_output
))
2268 XSETINT (startpos
, BUF_PT (XBUFFER (Vstandard_output
)));
2270 Fprinc (string
, Qnil
);
2272 XSETINT (endpos
, BUF_PT (XBUFFER (Vstandard_output
)));
2274 Fput_text_property (startpos
, endpos
,
2275 Qmouse_face
, intern ("highlight"),
2280 Fprinc (string
, Qnil
);
2283 /* Output the annotation for this element. */
2286 if (BUFFERP (Vstandard_output
))
2288 XSETINT (startpos
, BUF_PT (XBUFFER (Vstandard_output
)));
2290 Fprinc (Fcar (Fcdr (elt
)), Qnil
);
2292 XSETINT (endpos
, BUF_PT (XBUFFER (Vstandard_output
)));
2294 Fset_text_properties (startpos
, endpos
, Qnil
,
2299 Fprinc (Fcar (Fcdr (elt
)), Qnil
);
2304 /* Update COLUMN for what we have output. */
2307 /* If output is to a buffer, recompute COLUMN in a way
2308 that takes account of character widths. */
2309 if (BUFFERP (Vstandard_output
))
2311 tem
= Fcurrent_column ();
2312 column
= XINT (tem
);
2321 if (BUFFERP (Vstandard_output
))
2322 set_buffer_internal (old
);
2324 if (!NILP (Vrun_hooks
))
2325 call1 (Vrun_hooks
, intern ("completion-setup-hook"));
2330 DEFUN ("minibuffer-completion-help", Fminibuffer_completion_help
, Sminibuffer_completion_help
,
2332 doc
: /* Display a list of possible completions of the current minibuffer contents. */)
2335 Lisp_Object completions
;
2337 message ("Making completion list...");
2338 completions
= Fall_completions (minibuffer_completion_contents (),
2339 Vminibuffer_completion_table
,
2340 Vminibuffer_completion_predicate
,
2342 clear_message (1, 0);
2344 if (NILP (completions
))
2347 temp_echo_area_glyphs (" [No completions]");
2350 internal_with_output_to_temp_buffer ("*Completions*",
2351 Fdisplay_completion_list
,
2352 Fsort (completions
, Qstring_lessp
));
2356 DEFUN ("self-insert-and-exit", Fself_insert_and_exit
, Sself_insert_and_exit
, 0, 0, "",
2357 doc
: /* Terminate minibuffer input. */)
2360 if (INTEGERP (last_command_char
))
2361 internal_self_insert (XINT (last_command_char
), 0);
2365 return Fthrow (Qexit
, Qnil
);
2368 DEFUN ("exit-minibuffer", Fexit_minibuffer
, Sexit_minibuffer
, 0, 0, "",
2369 doc
: /* Terminate this minibuffer argument. */)
2372 return Fthrow (Qexit
, Qnil
);
2375 DEFUN ("minibuffer-depth", Fminibuffer_depth
, Sminibuffer_depth
, 0, 0, 0,
2376 doc
: /* Return current depth of activations of minibuffer, a nonnegative integer. */)
2379 return make_number (minibuf_level
);
2382 DEFUN ("minibuffer-prompt", Fminibuffer_prompt
, Sminibuffer_prompt
, 0, 0, 0,
2383 doc
: /* Return the prompt string of the currently-active minibuffer.
2384 If no minibuffer is active, return nil. */)
2387 return Fcopy_sequence (minibuf_prompt
);
2391 /* Temporarily display the string M at the end of the current
2392 minibuffer contents. This is used to display things like
2393 "[No Match]" when the user requests a completion for a prefix
2394 that has no possible completions, and other quick, unobtrusive
2398 temp_echo_area_glyphs (m
)
2402 int osize_byte
= ZV_BYTE
;
2404 int opoint_byte
= PT_BYTE
;
2405 Lisp_Object oinhibit
;
2406 oinhibit
= Vinhibit_quit
;
2408 /* Clear out any old echo-area message to make way for our new thing. */
2411 SET_PT_BOTH (osize
, osize_byte
);
2413 SET_PT_BOTH (opoint
, opoint_byte
);
2415 Fsit_for (make_number (2), Qnil
, Qnil
);
2416 del_range_both (osize
, osize_byte
, ZV
, ZV_BYTE
, 1);
2417 SET_PT_BOTH (opoint
, opoint_byte
);
2418 if (!NILP (Vquit_flag
))
2421 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
2423 Vinhibit_quit
= oinhibit
;
2426 DEFUN ("minibuffer-message", Fminibuffer_message
, Sminibuffer_message
,
2428 doc
: /* Temporarily display STRING at the end of the minibuffer.
2429 The text is displayed for two seconds,
2430 or until the next input event arrives, whichever comes first. */)
2434 temp_echo_area_glyphs (SDATA (string
));
2439 init_minibuf_once ()
2441 Vminibuffer_list
= Qnil
;
2442 staticpro (&Vminibuffer_list
);
2449 minibuf_prompt
= Qnil
;
2450 staticpro (&minibuf_prompt
);
2452 minibuf_save_list
= Qnil
;
2453 staticpro (&minibuf_save_list
);
2455 Qread_file_name_internal
= intern ("read-file-name-internal");
2456 staticpro (&Qread_file_name_internal
);
2458 Qminibuffer_default
= intern ("minibuffer-default");
2459 staticpro (&Qminibuffer_default
);
2460 Fset (Qminibuffer_default
, Qnil
);
2462 Qminibuffer_completion_table
= intern ("minibuffer-completion-table");
2463 staticpro (&Qminibuffer_completion_table
);
2465 Qminibuffer_completion_confirm
= intern ("minibuffer-completion-confirm");
2466 staticpro (&Qminibuffer_completion_confirm
);
2468 Qminibuffer_completion_predicate
= intern ("minibuffer-completion-predicate");
2469 staticpro (&Qminibuffer_completion_predicate
);
2471 staticpro (&last_exact_completion
);
2472 last_exact_completion
= Qnil
;
2474 staticpro (&last_minibuf_string
);
2475 last_minibuf_string
= Qnil
;
2477 Quser_variable_p
= intern ("user-variable-p");
2478 staticpro (&Quser_variable_p
);
2480 Qminibuffer_history
= intern ("minibuffer-history");
2481 staticpro (&Qminibuffer_history
);
2483 Qbuffer_name_history
= intern ("buffer-name-history");
2484 staticpro (&Qbuffer_name_history
);
2485 Fset (Qbuffer_name_history
, Qnil
);
2487 Qminibuffer_setup_hook
= intern ("minibuffer-setup-hook");
2488 staticpro (&Qminibuffer_setup_hook
);
2490 Qminibuffer_exit_hook
= intern ("minibuffer-exit-hook");
2491 staticpro (&Qminibuffer_exit_hook
);
2493 Qhistory_length
= intern ("history-length");
2494 staticpro (&Qhistory_length
);
2496 Qcurrent_input_method
= intern ("current-input-method");
2497 staticpro (&Qcurrent_input_method
);
2499 Qactivate_input_method
= intern ("activate-input-method");
2500 staticpro (&Qactivate_input_method
);
2502 DEFVAR_LISP ("read-buffer-function", &Vread_buffer_function
,
2503 doc
: /* If this is non-nil, `read-buffer' does its work by calling this function. */);
2504 Vread_buffer_function
= Qnil
;
2506 DEFVAR_LISP ("minibuffer-setup-hook", &Vminibuffer_setup_hook
,
2507 doc
: /* Normal hook run just after entry to minibuffer. */);
2508 Vminibuffer_setup_hook
= Qnil
;
2510 DEFVAR_LISP ("minibuffer-exit-hook", &Vminibuffer_exit_hook
,
2511 doc
: /* Normal hook run just after exit from minibuffer. */);
2512 Vminibuffer_exit_hook
= Qnil
;
2514 DEFVAR_LISP ("history-length", &Vhistory_length
,
2515 doc
: /* *Maximum length for history lists before truncation takes place.
2516 A number means that length; t means infinite. Truncation takes place
2517 just after a new element is inserted. Setting the history-length
2518 property of a history variable overrides this default. */);
2519 XSETFASTINT (Vhistory_length
, 30);
2521 DEFVAR_LISP ("completion-auto-help", &Vcompletion_auto_help
,
2522 doc
: /* *Non-nil means automatically provide help for invalid completion input. */);
2523 Vcompletion_auto_help
= Qt
;
2525 DEFVAR_BOOL ("completion-ignore-case", &completion_ignore_case
,
2526 doc
: /* Non-nil means don't consider case significant in completion. */);
2527 completion_ignore_case
= 0;
2529 DEFVAR_BOOL ("enable-recursive-minibuffers", &enable_recursive_minibuffers
,
2530 doc
: /* *Non-nil means to allow minibuffer commands while in the minibuffer.
2531 This variable makes a difference whenever the minibuffer window is active. */);
2532 enable_recursive_minibuffers
= 0;
2534 DEFVAR_LISP ("minibuffer-completion-table", &Vminibuffer_completion_table
,
2535 doc
: /* Alist or obarray used for completion in the minibuffer.
2536 This becomes the ALIST argument to `try-completion' and `all-completion'.
2538 The value may alternatively be a function, which is given three arguments:
2539 STRING, the current buffer contents;
2540 PREDICATE, the predicate for filtering possible matches;
2541 CODE, which says what kind of things to do.
2542 CODE can be nil, t or `lambda'.
2543 nil means to return the best completion of STRING, or nil if there is none.
2544 t means to return a list of all possible completions of STRING.
2545 `lambda' means to return t if STRING is a valid completion as it stands. */);
2546 Vminibuffer_completion_table
= Qnil
;
2548 DEFVAR_LISP ("minibuffer-completion-predicate", &Vminibuffer_completion_predicate
,
2549 doc
: /* Within call to `completing-read', this holds the PREDICATE argument. */);
2550 Vminibuffer_completion_predicate
= Qnil
;
2552 DEFVAR_LISP ("minibuffer-completion-confirm", &Vminibuffer_completion_confirm
,
2553 doc
: /* Non-nil means to demand confirmation of completion before exiting minibuffer. */);
2554 Vminibuffer_completion_confirm
= Qnil
;
2556 DEFVAR_LISP ("minibuffer-completing-file-name",
2557 &Vminibuffer_completing_file_name
,
2558 doc
: /* Non-nil means completing file names. */);
2559 Vminibuffer_completing_file_name
= Qnil
;
2561 DEFVAR_LISP ("minibuffer-help-form", &Vminibuffer_help_form
,
2562 doc
: /* Value that `help-form' takes on inside the minibuffer. */);
2563 Vminibuffer_help_form
= Qnil
;
2565 DEFVAR_LISP ("minibuffer-history-variable", &Vminibuffer_history_variable
,
2566 doc
: /* History list symbol to add minibuffer values to.
2567 Each string of minibuffer input, as it appears on exit from the minibuffer,
2569 (set minibuffer-history-variable
2570 (cons STRING (symbol-value minibuffer-history-variable))) */);
2571 XSETFASTINT (Vminibuffer_history_variable
, 0);
2573 DEFVAR_LISP ("minibuffer-history-position", &Vminibuffer_history_position
,
2574 doc
: /* Current position of redoing in the history list. */);
2575 Vminibuffer_history_position
= Qnil
;
2577 DEFVAR_BOOL ("minibuffer-auto-raise", &minibuffer_auto_raise
,
2578 doc
: /* *Non-nil means entering the minibuffer raises the minibuffer's frame.
2579 Some uses of the echo area also raise that frame (since they use it too). */);
2580 minibuffer_auto_raise
= 0;
2582 DEFVAR_LISP ("completion-regexp-list", &Vcompletion_regexp_list
,
2583 doc
: /* List of regexps that should restrict possible completions. */);
2584 Vcompletion_regexp_list
= Qnil
;
2586 DEFVAR_BOOL ("minibuffer-allow-text-properties",
2587 &minibuffer_allow_text_properties
,
2588 doc
: /* Non-nil means `read-from-minibuffer' should not discard text properties.
2589 This also affects `read-string', but it does not affect `read-minibuffer',
2590 `read-no-blanks-input', or any of the functions that do minibuffer input
2591 with completion; they always discard text properties. */);
2592 minibuffer_allow_text_properties
= 0;
2594 DEFVAR_LISP ("minibuffer-prompt-properties", &Vminibuffer_prompt_properties
,
2595 doc
: /* Text properties that are added to minibuffer prompts.
2596 These are in addition to the basic `field' property, and stickiness
2598 /* We use `intern' here instead of Qread_only to avoid
2599 initialization-order problems. */
2600 Vminibuffer_prompt_properties
2601 = Fcons (intern ("read-only"), Fcons (Qt
, Qnil
));
2603 defsubr (&Sset_minibuffer_window
);
2604 defsubr (&Sread_from_minibuffer
);
2605 defsubr (&Seval_minibuffer
);
2606 defsubr (&Sread_minibuffer
);
2607 defsubr (&Sread_string
);
2608 defsubr (&Sread_command
);
2609 defsubr (&Sread_variable
);
2610 defsubr (&Sread_buffer
);
2611 defsubr (&Sread_no_blanks_input
);
2612 defsubr (&Sminibuffer_depth
);
2613 defsubr (&Sminibuffer_prompt
);
2615 defsubr (&Sminibufferp
);
2616 defsubr (&Sminibuffer_prompt_end
);
2617 defsubr (&Sminibuffer_contents
);
2618 defsubr (&Sminibuffer_contents_no_properties
);
2619 defsubr (&Sdelete_minibuffer_contents
);
2621 defsubr (&Stry_completion
);
2622 defsubr (&Sall_completions
);
2623 defsubr (&Stest_completion
);
2624 defsubr (&Sassoc_string
);
2625 defsubr (&Scompleting_read
);
2626 defsubr (&Sminibuffer_complete
);
2627 defsubr (&Sminibuffer_complete_word
);
2628 defsubr (&Sminibuffer_complete_and_exit
);
2629 defsubr (&Sdisplay_completion_list
);
2630 defsubr (&Sminibuffer_completion_help
);
2632 defsubr (&Sself_insert_and_exit
);
2633 defsubr (&Sexit_minibuffer
);
2635 defsubr (&Sminibuffer_message
);
2641 initial_define_key (Vminibuffer_local_map
, Ctl ('g'),
2642 "abort-recursive-edit");
2643 initial_define_key (Vminibuffer_local_map
, Ctl ('m'),
2645 initial_define_key (Vminibuffer_local_map
, Ctl ('j'),
2648 initial_define_key (Vminibuffer_local_ns_map
, ' ',
2650 initial_define_key (Vminibuffer_local_ns_map
, '\t',
2652 initial_define_key (Vminibuffer_local_ns_map
, '?',
2653 "self-insert-and-exit");
2655 initial_define_key (Vminibuffer_local_completion_map
, '\t',
2656 "minibuffer-complete");
2657 initial_define_key (Vminibuffer_local_completion_map
, ' ',
2658 "minibuffer-complete-word");
2659 initial_define_key (Vminibuffer_local_completion_map
, '?',
2660 "minibuffer-completion-help");
2662 initial_define_key (Vminibuffer_local_must_match_map
, Ctl ('m'),
2663 "minibuffer-complete-and-exit");
2664 initial_define_key (Vminibuffer_local_must_match_map
, Ctl ('j'),
2665 "minibuffer-complete-and-exit");